@serve.zone/coremail 1.0.0

package/ts/classes.models.ts

@@ -0,0 +1,530 @@
+import * as plugins from './plugins.js';
+import type { ISubmissionPartRecord, TTransferGrantPurpose } from './interfaces.js';
+import {
+  assertCoreMailDesiredSnapshotRecord,
+  assertCoreMailInboundDeliveryRecord,
+  assertCoreMailInboundHandoffRecord,
+  assertCoreMailQuotaCounterRecord,
+  assertCoreMailRecipientHandleRecord,
+  assertCoreMailStateRecord,
+  assertCoreMailSubmissionRecord,
+  assertCoreMailTransferGrantRecord,
+  type ICoreMailDesiredSnapshotRecord,
+  type ICoreMailInboundDeliveryRecord,
+  type ICoreMailInboundHandoffRecord,
+  type ICoreMailQuotaCounterRecord,
+  type ICoreMailRecipientHandleRecord,
+  type ICoreMailStateRecord,
+  type ICoreMailSubmissionRecord,
+  type ICoreMailTransferGrantRecord,
+} from './coremail.persistence.js';
+
+type TCoreMailSha256 = plugins.serveZoneInterfaces.data.TCoreMailSha256;
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailStateRecord,
+  reconcileBy: 'stateId',
+})
+export class CoreMailStateDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailStateDoc,
+  ICoreMailStateRecord
+> implements ICoreMailStateRecord {
+  declare public static exact: plugins.smartdata.TExact<CoreMailStateDoc>;
+  public stateId!: string;
+  public appliedConfigEpoch!: number;
+  public appliedDesiredStateDigest!: TCoreMailSha256;
+  public snapshotId!: string;
+  public updatedAt!: number;
+}
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailDesiredSnapshotRecord,
+  reconcileBy: 'snapshotId',
+})
+export class CoreMailDesiredSnapshotDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailDesiredSnapshotDoc,
+  ICoreMailDesiredSnapshotRecord
+> implements ICoreMailDesiredSnapshotRecord {
+  declare public static exact:
+    plugins.smartdata.TExact<CoreMailDesiredSnapshotDoc>;
+  public snapshotId!: string;
+  public reconciliationId!: string;
+  public expectedAppliedConfigEpoch!: number;
+  public configEpoch!: number;
+  public desiredStateDigest!: TCoreMailSha256;
+  public lengthBytes!: number;
+  public objectKey!: string;
+  public state!: 'staged' | 'active' | 'superseded' | 'failed' | 'retiring';
+  public createdAt!: number;
+  public updatedAt!: number;
+  public activatedAt?: number;
+  public retiringAt?: number;
+  public errorCode?: plugins.serveZoneInterfaces.data.TCoreMailErrorCode;
+}
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailQuotaCounterRecord,
+  reconcileBy: 'counterId',
+})
+export class CoreMailQuotaCounterDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailQuotaCounterDoc,
+  ICoreMailQuotaCounterRecord
+> implements ICoreMailQuotaCounterRecord {
+  declare public static exact: plugins.smartdata.TExact<CoreMailQuotaCounterDoc>;
+  public counterId!: TCoreMailSha256;
+  public tenantId!: string;
+  public serviceId!: string;
+  public bindingId!: string;
+  public bindingRevision!: number;
+  public kind!: ICoreMailQuotaCounterRecord['kind'];
+  public windowStartedAt?: number;
+  public count!: number;
+  public createdAt!: number;
+  public updatedAt!: number;
+}
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailTransferGrantRecord,
+  reconcileBy: 'grantId',
+})
+export class CoreMailTransferGrantDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailTransferGrantDoc,
+  ICoreMailTransferGrantRecord
+> implements ICoreMailTransferGrantRecord {
+  declare public static exact: plugins.smartdata.TExact<CoreMailTransferGrantDoc>;
+  public grantId!: string;
+  public authorityKind!: 'control' | 'gateway' | 'workload';
+  public tenantId!: string;
+  public serviceId!: string;
+  public bindingId!: string;
+  public purpose!: TTransferGrantPurpose;
+  public method!: 'PUT' | 'GET';
+  public path!: string;
+  public bearerSha256!: TCoreMailSha256;
+  public expectedSha256!: TCoreMailSha256;
+  public lengthBytes!: number;
+  public contentType!: string;
+  public objectKey!: string;
+  public state!: 'issued' | 'transferring' | 'consumed' | 'failed' | 'expired';
+  public expiresAt!: number;
+  public createdAt!: number;
+  public consumedAt?: number;
+}
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailSubmissionRecord,
+  reconcileBy: 'submissionId',
+})
+export class CoreMailSubmissionDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailSubmissionDoc,
+  ICoreMailSubmissionRecord
+> implements ICoreMailSubmissionRecord {
+  declare public static exact: plugins.smartdata.TExact<CoreMailSubmissionDoc>;
+  public submissionId!: string;
+  public tenantId!: string;
+  public serviceId!: string;
+  public bindingId!: string;
+  public bindingRevision!: number;
+  public revision!: number;
+  public idempotencyKey!: string;
+  public submissionDigest!: TCoreMailSha256;
+  public state!: plugins.serveZoneInterfaces.data.TCoreMailSubmissionState;
+  public message!: plugins.serveZoneInterfaces.data.ICoreMailOutboundMessageDescriptor;
+  public parts!: ISubmissionPartRecord[];
+  public mimeObjectKey?: string;
+  public mimeSha256?: TCoreMailSha256;
+  public mimeLengthBytes?: number;
+  public mimePublishedAt?: number;
+  public transportMessageId?: string;
+  public transportGrantId?: string;
+  public gatewayStatusUpdatedAt?: number;
+  public attempts!: number;
+  public nextAttemptAt?: number;
+  public workerRetryAt?: number;
+  public retiringAt?: number;
+  public leaseOwnerTaskId?: string;
+  public leaseToken?: string;
+  public leaseExpiresAt?: number;
+  public acceptedAt?: number;
+  public deliveredAt?: number;
+  public terminalAt?: number;
+  public error?: plugins.serveZoneInterfaces.data.ICoreMailErrorData;
+  public createdAt!: number;
+  public updatedAt!: number;
+}
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailInboundDeliveryRecord,
+  reconcileBy: 'deliveryId',
+})
+export class CoreMailInboundDeliveryDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailInboundDeliveryDoc,
+  ICoreMailInboundDeliveryRecord
+> implements ICoreMailInboundDeliveryRecord {
+  declare public static exact:
+    plugins.smartdata.TExact<CoreMailInboundDeliveryDoc>;
+  public deliveryId!: string;
+  public tenantId!: string;
+  public serviceId!: string;
+  public bindingId!: string;
+  public bindingRevision!: number;
+  public revision!: number;
+  public transportDeliveryId!: string;
+  public state!: plugins.serveZoneInterfaces.data.TCoreMailInboundDeliveryState;
+  public envelope!: plugins.serveZoneInterfaces.data.ICoreMailEnvelope;
+  public rawMimeSha256!: TCoreMailSha256;
+  public rawMimeLengthBytes!: number;
+  public rawMimeObjectKey!: string;
+  public messageId?: string;
+  public subject?: string;
+  public receivedAt!: number;
+  public updatedAt!: number;
+  public fetchGrantId?: string;
+  public acknowledgedOutcome?: plugins.serveZoneInterfaces.data.TCoreMailInboundAckOutcome;
+}
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailRecipientHandleRecord,
+  reconcileBy: 'routingHandle',
+})
+export class CoreMailRecipientHandleDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailRecipientHandleDoc,
+  ICoreMailRecipientHandleRecord
+> implements ICoreMailRecipientHandleRecord {
+  declare public static exact:
+    plugins.smartdata.TExact<CoreMailRecipientHandleDoc>;
+  public routingHandle!: string;
+  public tenantId!: string;
+  public serviceId!: string;
+  public bindingId!: string;
+  public bindingRevision!: number;
+  public maxPendingInbound!: number;
+  public recipient!: string;
+  public envelopeDigest!: TCoreMailSha256;
+  public state!: 'issued' | 'consumed' | 'expired';
+  public handoffId?: string;
+  public expiresAt!: number;
+  public createdAt!: number;
+}
+
+@plugins.smartdata.exactPersistence({
+  assertDocument: assertCoreMailInboundHandoffRecord,
+  reconcileBy: 'handoffId',
+})
+export class CoreMailInboundHandoffDoc extends plugins.smartdata.SmartDataDbDoc<
+  CoreMailInboundHandoffDoc,
+  ICoreMailInboundHandoffRecord
+> implements ICoreMailInboundHandoffRecord {
+  declare public static exact:
+    plugins.smartdata.TExact<CoreMailInboundHandoffDoc>;
+  public handoffId!: string;
+  public revision!: number;
+  public transportDeliveryId!: string;
+  public routingHandles!: string[];
+  public message!: plugins.serveZoneInterfaces.data.ICoreMailGatewayMessageDescriptor;
+  public source!: plugins.serveZoneInterfaces.data.IMailConnectionInfo;
+  public state!: 'prepared' | 'uploaded' | 'completed' | 'failed' | 'retiring';
+  public objectKey!: string;
+  public grantId?: string;
+  public deliveryIds!: string[];
+  public createdAt!: number;
+  public updatedAt!: number;
+  public completedAt?: number;
+  public retiringAt?: number;
+}
+
+export interface ICoreMailModels {
+  State: typeof CoreMailStateDoc;
+  DesiredSnapshot: typeof CoreMailDesiredSnapshotDoc;
+  QuotaCounter: typeof CoreMailQuotaCounterDoc;
+  TransferGrant: typeof CoreMailTransferGrantDoc;
+  Submission: typeof CoreMailSubmissionDoc;
+  InboundDelivery: typeof CoreMailInboundDeliveryDoc;
+  RecipientHandle: typeof CoreMailRecipientHandleDoc;
+  InboundHandoff: typeof CoreMailInboundHandoffDoc;
+}
+
+const uniqueIndex = (nameArg: string, fieldArg: string) => ({
+  name: nameArg,
+  key: { [fieldArg]: 1 as const },
+  options: { unique: true },
+});
+
+export const createCoreMailModels = (
+  dbArg: plugins.smartdata.SmartdataDb,
+): ICoreMailModels => {
+  const bind = <
+    TConstructor extends new () =>
+      plugins.smartdata.SmartDataDbDoc<any, any>,
+  >(
+    modelArg: TConstructor,
+    collectionNameArg: string,
+    persistedFieldsArg: Array<keyof InstanceType<TConstructor> & string>,
+    identityFieldArg: keyof InstanceType<TConstructor> & string,
+    indexesArg: plugins.smartdata.ICollectionModelIndex[],
+  ) => plugins.smartdata.defineCollectionModel(
+    modelArg as unknown as new () => InstanceType<TConstructor>,
+    dbArg,
+    {
+      collectionName: collectionNameArg,
+      persistedFields: persistedFieldsArg,
+      identityFields: [identityFieldArg] as never,
+      indexes: [
+        uniqueIndex(`${identityFieldArg}_unique`, identityFieldArg),
+        ...indexesArg,
+      ],
+    },
+  ) as unknown as TConstructor;
+
+  return {
+    State: bind(CoreMailStateDoc, 'CoreMailState', [
+      'stateId',
+      'appliedConfigEpoch',
+      'appliedDesiredStateDigest',
+      'snapshotId',
+      'updatedAt',
+    ], 'stateId', []) as typeof CoreMailStateDoc,
+    DesiredSnapshot: bind(CoreMailDesiredSnapshotDoc, 'CoreMailDesiredSnapshot', [
+      'snapshotId',
+      'reconciliationId',
+      'expectedAppliedConfigEpoch',
+      'configEpoch',
+      'desiredStateDigest',
+      'lengthBytes',
+      'objectKey',
+      'state',
+      'createdAt',
+      'updatedAt',
+      'activatedAt',
+      'retiringAt',
+      'errorCode',
+    ], 'snapshotId', [
+      uniqueIndex('reconciliationId_unique', 'reconciliationId'),
+      {
+        name: 'config_epoch_digest',
+        key: { configEpoch: 1, desiredStateDigest: 1 },
+        options: { unique: true },
+      },
+      {
+        name: 'state_updated',
+        key: { state: 1, updatedAt: 1 },
+      },
+    ]) as typeof CoreMailDesiredSnapshotDoc,
+    QuotaCounter: bind(CoreMailQuotaCounterDoc, 'CoreMailQuotaCounter', [
+      'counterId',
+      'tenantId',
+      'serviceId',
+      'bindingId',
+      'bindingRevision',
+      'kind',
+      'windowStartedAt',
+      'count',
+      'createdAt',
+      'updatedAt',
+    ], 'counterId', [
+      {
+        name: 'authority_kind_unique',
+        key: {
+          tenantId: 1,
+          serviceId: 1,
+          bindingId: 1,
+          bindingRevision: 1,
+          kind: 1,
+        },
+        options: { unique: true },
+      },
+    ]) as typeof CoreMailQuotaCounterDoc,
+    TransferGrant: bind(CoreMailTransferGrantDoc, 'CoreMailTransferGrant', [
+      'grantId',
+      'authorityKind',
+      'tenantId',
+      'serviceId',
+      'bindingId',
+      'purpose',
+      'method',
+      'path',
+      'bearerSha256',
+      'expectedSha256',
+      'lengthBytes',
+      'contentType',
+      'objectKey',
+      'state',
+      'expiresAt',
+      'createdAt',
+      'consumedAt',
+    ], 'grantId', [
+      {
+        name: 'authority_state_expiry',
+        key: {
+          authorityKind: 1,
+          tenantId: 1,
+          serviceId: 1,
+          bindingId: 1,
+          state: 1,
+          expiresAt: 1,
+        },
+      },
+    ]) as typeof CoreMailTransferGrantDoc,
+    Submission: bind(CoreMailSubmissionDoc, 'CoreMailSubmission', [
+      'submissionId',
+      'tenantId',
+      'serviceId',
+      'bindingId',
+      'bindingRevision',
+      'revision',
+      'idempotencyKey',
+      'submissionDigest',
+      'state',
+      'message',
+      'parts',
+      'mimeObjectKey',
+      'mimeSha256',
+      'mimeLengthBytes',
+      'mimePublishedAt',
+      'transportMessageId',
+      'transportGrantId',
+      'gatewayStatusUpdatedAt',
+      'attempts',
+      'nextAttemptAt',
+      'workerRetryAt',
+      'retiringAt',
+      'leaseOwnerTaskId',
+      'leaseToken',
+      'leaseExpiresAt',
+      'acceptedAt',
+      'deliveredAt',
+      'terminalAt',
+      'error',
+      'createdAt',
+      'updatedAt',
+    ], 'submissionId', [
+      {
+        name: 'authority_idempotency_unique',
+        key: {
+          tenantId: 1,
+          serviceId: 1,
+          bindingId: 1,
+          bindingRevision: 1,
+          idempotencyKey: 1,
+        },
+        options: { unique: true },
+      },
+      {
+        name: 'queue_claim',
+        key: { state: 1, workerRetryAt: 1, nextAttemptAt: 1, leaseExpiresAt: 1 },
+        options: { sparse: true },
+      },
+      {
+        name: 'transport_message_unique',
+        key: { transportMessageId: 1 },
+        options: { unique: true, sparse: true },
+      },
+      {
+        name: 'transport_grant_unique',
+        key: { transportGrantId: 1 },
+        options: { unique: true, sparse: true },
+      },
+      {
+        name: 'state_terminal',
+        key: { state: 1, terminalAt: 1 },
+        options: { sparse: true },
+      },
+      {
+        name: 'state_updated',
+        key: { state: 1, updatedAt: 1 },
+      },
+    ]) as typeof CoreMailSubmissionDoc,
+    InboundDelivery: bind(CoreMailInboundDeliveryDoc, 'CoreMailInboundDelivery', [
+      'deliveryId',
+      'tenantId',
+      'serviceId',
+      'bindingId',
+      'bindingRevision',
+      'revision',
+      'transportDeliveryId',
+      'state',
+      'envelope',
+      'rawMimeSha256',
+      'rawMimeLengthBytes',
+      'rawMimeObjectKey',
+      'messageId',
+      'subject',
+      'receivedAt',
+      'updatedAt',
+      'fetchGrantId',
+      'acknowledgedOutcome',
+    ], 'deliveryId', [
+      {
+        name: 'authority_delivery',
+        key: { tenantId: 1, serviceId: 1, bindingId: 1, receivedAt: 1, deliveryId: 1 },
+      },
+      {
+        name: 'transport_binding_unique',
+        key: { transportDeliveryId: 1, bindingId: 1, bindingRevision: 1 },
+        options: { unique: true },
+      },
+      {
+        name: 'state_updated',
+        key: { state: 1, updatedAt: 1 },
+      },
+      {
+        name: 'raw_mime_retention',
+        key: { rawMimeObjectKey: 1, state: 1, updatedAt: 1 },
+      },
+    ]) as typeof CoreMailInboundDeliveryDoc,
+    RecipientHandle: bind(CoreMailRecipientHandleDoc, 'CoreMailRecipientHandle', [
+      'routingHandle',
+      'tenantId',
+      'serviceId',
+      'bindingId',
+      'bindingRevision',
+      'maxPendingInbound',
+      'recipient',
+      'envelopeDigest',
+      'state',
+      'handoffId',
+      'expiresAt',
+      'createdAt',
+    ], 'routingHandle', [
+      {
+        name: 'state_expiry',
+        key: { state: 1, expiresAt: 1 },
+      },
+    ]) as typeof CoreMailRecipientHandleDoc,
+    InboundHandoff: bind(CoreMailInboundHandoffDoc, 'CoreMailInboundHandoff', [
+      'handoffId',
+      'revision',
+      'transportDeliveryId',
+      'routingHandles',
+      'message',
+      'source',
+      'state',
+      'objectKey',
+      'grantId',
+      'deliveryIds',
+      'createdAt',
+      'updatedAt',
+      'completedAt',
+      'retiringAt',
+    ], 'handoffId', [
+      uniqueIndex('transportDeliveryId_unique', 'transportDeliveryId'),
+      {
+        name: 'state_updated',
+        key: { state: 1, updatedAt: 1 },
+      },
+      {
+        name: 'state_completed',
+        key: { state: 1, completedAt: 1 },
+        options: { sparse: true },
+      },
+    ]) as typeof CoreMailInboundHandoffDoc,
+  };
+};
+
+export const prepareCoreMailModelsForTransactions = async (
+  modelsArg: ICoreMailModels,
+): Promise<void> => {
+  await Promise.all(
+    Object.values(modelsArg).map((modelArg) => modelArg.exact.prepare()),
+  );
+};