128 lines
5.5 KiB
TypeScript
128 lines
5.5 KiB
TypeScript
|
|
import { pgTable, text, boolean, integer, timestamp, index } from 'drizzle-orm/pg-core';
|
||
|
|
|
||
|
|
import { ports } from './ports';
|
||
|
|
import { clients } from './clients';
|
||
|
|
import { interests } from './interests';
|
||
|
|
import { berths } from './berths';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Port-wide brochures (Phase 7 — see plan §3.3 / §4.8).
|
||
|
|
*
|
||
|
|
* Each port can have multiple brochures (e.g. "General", "Investor Pack")
|
||
|
|
* with one marked as `isDefault`. Archived brochures stay queryable for
|
||
|
|
* audit purposes but are hidden from the send-out picker.
|
||
|
|
*/
|
||
|
|
export const brochures = pgTable(
|
||
|
|
'brochures',
|
||
|
|
{
|
||
|
|
id: text('id')
|
||
|
|
.primaryKey()
|
||
|
|
.$defaultFn(() => crypto.randomUUID()),
|
||
|
|
portId: text('port_id')
|
||
|
|
.notNull()
|
||
|
|
.references(() => ports.id, { onDelete: 'cascade' }),
|
||
|
|
label: text('label').notNull(),
|
||
|
|
description: text('description'),
|
||
|
|
isDefault: boolean('is_default').notNull().default(false),
|
||
|
|
archivedAt: timestamp('archived_at', { withTimezone: true }),
|
||
|
|
createdBy: text('created_by').notNull(),
|
||
|
|
createdAt: timestamp('created_at', { withTimezone: true }).notNull().defaultNow(),
|
||
|
|
},
|
||
|
|
(table) => [index('idx_brochures_port').on(table.portId)],
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Versioned brochure files. Identical lifecycle to `berth_pdf_versions`:
|
||
|
|
* each upload creates a new immutable row with a monotonic version number
|
||
|
|
* per brochure. `storageKey` follows the §4.7a renamed convention.
|
||
|
|
*/
|
||
|
|
export const brochureVersions = pgTable(
|
||
|
|
'brochure_versions',
|
||
|
|
{
|
||
|
|
id: text('id')
|
||
|
|
.primaryKey()
|
||
|
|
.$defaultFn(() => crypto.randomUUID()),
|
||
|
|
brochureId: text('brochure_id')
|
||
|
|
.notNull()
|
||
|
|
.references(() => brochures.id, { onDelete: 'cascade' }),
|
||
|
|
versionNumber: integer('version_number').notNull(),
|
||
|
|
/** Object key in the active storage backend (renamed from `s3_key` per §4.7a). */
|
||
|
|
storageKey: text('storage_key').notNull(),
|
||
|
|
fileName: text('file_name').notNull(),
|
||
|
|
fileSizeBytes: integer('file_size_bytes').notNull(),
|
||
|
|
contentSha256: text('content_sha256').notNull(),
|
||
|
|
uploadedBy: text('uploaded_by').notNull(),
|
||
|
|
uploadedAt: timestamp('uploaded_at', { withTimezone: true }).notNull().defaultNow(),
|
||
|
|
/** Cached signed-URL expiry per §11.1 — re-sign only when within 1h of expiry. */
|
||
|
|
downloadUrlExpiresAt: timestamp('download_url_expires_at', { withTimezone: true }),
|
||
|
|
},
|
||
|
|
(table) => [index('idx_brochure_versions_brochure').on(table.brochureId, table.uploadedAt)],
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Send-out audit log for berth PDFs and brochures (Phase 7 — plan §3.3).
|
||
|
|
*
|
||
|
|
* One row per recipient per send. `documentKind` discriminates between
|
||
|
|
* `'berth_pdf'` and `'brochure'`; the corresponding `*_version_id` column
|
||
|
|
* pins the exact version sent.
|
||
|
|
*
|
||
|
|
* `berthPdfVersionId` is intentionally a plain text column (no FK) — the
|
||
|
|
* referenced table `berth_pdf_versions` is owned by Phase 6b. Loose-coupling
|
||
|
|
* keeps the two phases independent (per Phase 7 task brief).
|
||
|
|
*
|
||
|
|
* `failedAt` and `errorReason` capture send failures (SMTP auth, transport
|
||
|
|
* errors). Failed sends are still written so reps can see "I clicked send
|
||
|
|
* but it didn't go" in the timeline (per §14.7).
|
||
|
|
*/
|
||
|
|
export const documentSends = pgTable(
|
||
|
|
'document_sends',
|
||
|
|
{
|
||
|
|
id: text('id')
|
||
|
|
.primaryKey()
|
||
|
|
.$defaultFn(() => crypto.randomUUID()),
|
||
|
|
portId: text('port_id')
|
||
|
|
.notNull()
|
||
|
|
.references(() => ports.id),
|
||
|
|
/** Either client_id or interest_id is set (or both). */
|
||
|
|
clientId: text('client_id').references(() => clients.id),
|
||
|
|
interestId: text('interest_id').references(() => interests.id),
|
||
|
|
recipientEmail: text('recipient_email').notNull(),
|
||
|
|
/** 'berth_pdf' | 'brochure' */
|
||
|
|
documentKind: text('document_kind').notNull(),
|
||
|
|
berthId: text('berth_id').references(() => berths.id),
|
||
|
|
/** Forward FK ref — berth_pdf_versions defined in Phase 6b. Loose-coupled. */
|
||
|
|
berthPdfVersionId: text('berth_pdf_version_id'),
|
||
|
|
brochureId: text('brochure_id').references(() => brochures.id),
|
||
|
|
brochureVersionId: text('brochure_version_id').references(() => brochureVersions.id),
|
||
|
|
/** Exact body used (after merge-field expansion + sanitization). */
|
||
|
|
bodyMarkdown: text('body_markdown'),
|
||
|
|
sentByUserId: text('sent_by_user_id').notNull(),
|
||
|
|
fromAddress: text('from_address').notNull(),
|
||
|
|
sentAt: timestamp('sent_at', { withTimezone: true }).notNull().defaultNow(),
|
||
|
|
/** SMTP provider message-id for deliverability tracking. */
|
||
|
|
messageId: text('message_id'),
|
||
|
|
/** When the initial send had its attachment dropped because the SMTP server
|
||
|
|
* rejected the size (552 etc.) and the system retried with a download
|
||
|
|
* link, this captures the rejection reason for ops visibility. Null when
|
||
|
|
* the original send went through as-is. */
|
||
|
|
fallbackToLinkReason: text('fallback_to_link_reason'),
|
||
|
|
/** Set when the SMTP send transaction itself failed (auth/transport/etc). */
|
||
|
|
failedAt: timestamp('failed_at', { withTimezone: true }),
|
||
|
|
/** Human-readable failure reason; only meaningful when failedAt is non-null. */
|
||
|
|
errorReason: text('error_reason'),
|
||
|
|
},
|
||
|
|
(t) => [
|
||
|
|
index('idx_ds_client').on(t.clientId, t.sentAt),
|
||
|
|
index('idx_ds_interest').on(t.interestId, t.sentAt),
|
||
|
|
index('idx_ds_berth').on(t.berthId, t.sentAt),
|
||
|
|
index('idx_ds_port').on(t.portId, t.sentAt),
|
||
|
|
],
|
||
|
|
);
|
||
|
|
|
||
|
|
export type Brochure = typeof brochures.$inferSelect;
|
||
|
|
export type NewBrochure = typeof brochures.$inferInsert;
|
||
|
|
export type BrochureVersion = typeof brochureVersions.$inferSelect;
|
||
|
|
export type NewBrochureVersion = typeof brochureVersions.$inferInsert;
|
||
|
|
export type DocumentSend = typeof documentSends.$inferSelect;
|
||
|
|
export type NewDocumentSend = typeof documentSends.$inferInsert;
|