@codixus/server 0.1.6 → 0.1.8

package/dist/index.d.cts

@@ -265,6 +265,37 @@ interface RestOptions {
     allowWrite?: (req: AuthenticatedRequest, doc: Record<string, unknown>, patch: Record<string, unknown>) => HookResult;
 }
 
+type PushEventSource = "client" | "server" | "system";
+type PushEventDoc = {
+    _id: string;
+    deviceId: string;
+    name: string;
+    properties?: Record<string, unknown>;
+    source: PushEventSource;
+    occurredAt: Date;
+    createdAt: Date;
+    idempotencyKey?: string;
+    journeyEnrollments?: Array<{
+        journeyId: string;
+        revision: number;
+    }>;
+    enrollmentStatus?: "pending" | "complete";
+};
+type PushEventTrackInput = {
+    deviceId: string;
+    name: string;
+    properties?: Record<string, unknown>;
+    source?: PushEventSource;
+    occurredAt?: Date;
+    idempotencyKey?: string;
+    usersCollection?: string;
+};
+type PushEventTrackResult = {
+    created: boolean;
+    eventId?: string;
+    ignored?: "USER_NOT_FOUND";
+};
+
 type PushMessage = {
     token: string;
     title: string;
@@ -274,6 +305,7 @@ type PushMessage = {
     badge?: number;
     sound?: string;
     channelId?: string;
+    imageUrl?: string;
 };
 type PushTicket = {
     token: string;
@@ -286,6 +318,7 @@ type PushReceipt = {
     ticketId: string;
     status: "ok" | "error";
     errorCode?: string;
+    errorMessage?: string;
 };
 interface PushTransport {
     readonly name: string;
@@ -298,6 +331,11 @@ type PushSendInput = {
     body: string;
     data?: Record<string, unknown>;
     idempotencyKey?: string;
+    imageUrl?: string;
+    journeyId?: string;
+    journeyRevision?: number;
+    journeyStepId?: string;
+    isTest?: boolean;
 };
 type PushSendToInput = {
     filter: Record<string, unknown>;
@@ -305,6 +343,15 @@ type PushSendToInput = {
     body: string;
     data?: Record<string, unknown>;
     idempotencyKey?: string;
+    imageUrl?: string;
+};
+type PushSendResult = {
+    deviceId: string;
+    token?: string;
+    deliveryId?: string;
+    status: "submitted" | "failed" | "skipped";
+    errorCode?: string;
+    errorMessage?: string;
 };
 type PushDeviceDoc = {
     _id: string;
@@ -330,15 +377,142 @@ type PushDeliveryDoc = {
     title: string;
     body: string;
     data?: Record<string, unknown>;
-    status: "submitted" | "failed" | "opened";
+    imageUrl?: string;
+    status: "sending" | "submitted" | "failed" | "opened";
     ticketId?: string;
     errorCode?: string;
+    errorMessage?: string;
     idempotencyKey: string;
     createdAt: Date;
     openedAt?: Date;
     receiptedAt?: Date;
+    updatedAt?: Date;
+    journeyId?: string;
+    journeyRevision?: number;
+    journeyStepId?: string;
+    isTest?: boolean;
 };
 
+declare class PushService {
+    private transport;
+    private devicesCol;
+    private deliveriesCol;
+    constructor(db: Db, transport: PushTransport);
+    send(input: PushSendInput): Promise<PushSendResult[]>;
+    sendTo(input: PushSendToInput): Promise<PushSendResult[]>;
+    pollReceipts(): Promise<void>;
+    find(filter: Record<string, unknown>): Promise<PushDeviceDoc[]>;
+}
+
+type PushJourneyAudience = {
+    operator: "has_event" | "not_has_event";
+    eventName: string;
+};
+type PushJourneyStep = {
+    id: string;
+    offsetSeconds: number;
+    title: string;
+    body: string;
+    imageUrl?: string;
+    data?: Record<string, unknown>;
+};
+type PushJourneyDefinition = {
+    entryEvent: string;
+    audience?: PushJourneyAudience;
+    steps: PushJourneyStep[];
+};
+type PushJourneyStatus = "draft" | "live" | "paused";
+type PushJourneyDoc = {
+    _id: string;
+    name: string;
+    status: PushJourneyStatus;
+    draft: PushJourneyDefinition;
+    revisionCounter: number;
+    liveRevision?: number;
+    liveEntryEvent?: string;
+    liveSince?: Date;
+    publishedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type PushJourneyRevisionDoc = {
+    _id: string;
+    journeyId: string;
+    revision: number;
+    name: string;
+    definition: PushJourneyDefinition;
+    publishedAt: Date;
+};
+type PushJourneyRunStatus = "active" | "paused" | "completed" | "exited" | "failed";
+type PushJourneyRunDoc = {
+    _id: string;
+    journeyId: string;
+    revision: number;
+    eventId: string;
+    deviceId: string;
+    eventOccurredAt: Date;
+    status: PushJourneyRunStatus;
+    nextStepIndex: number;
+    nextRunAt: Date;
+    attempts: number;
+    lockedUntil?: Date;
+    lockToken?: string;
+    lastError?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    completedAt?: Date;
+};
+
+declare class JourneyError extends Error {
+    readonly code: "NOT_FOUND" | "INVALID_STATE" | "INVALID_INPUT";
+    constructor(code: "NOT_FOUND" | "INVALID_STATE" | "INVALID_INPUT", message: string);
+}
+declare class JourneyService {
+    private readonly push;
+    private readonly journeys;
+    private readonly revisions;
+    private readonly runs;
+    private readonly events;
+    constructor(db: Db, push: PushService);
+    ensureIndexes(): Promise<void>;
+    create(input: {
+        name: string;
+        definition: PushJourneyDefinition;
+    }): Promise<PushJourneyDoc>;
+    list(): Promise<PushJourneyDoc[]>;
+    get(id: string): Promise<PushJourneyDoc | null>;
+    updateDraft(id: string, input: {
+        name?: string;
+        definition?: PushJourneyDefinition;
+    }): Promise<PushJourneyDoc>;
+    publish(id: string): Promise<PushJourneyDoc>;
+    pause(id: string): Promise<PushJourneyDoc>;
+    resume(id: string): Promise<PushJourneyDoc>;
+    enrollEvent(event: PushEventDoc): Promise<void>;
+    resolveEnrollments(eventName: string): Promise<Array<{
+        journeyId: string;
+        revision: number;
+    }>>;
+    processDue(options?: {
+        now?: Date;
+        limit?: number;
+        leaseMs?: number;
+    }): Promise<{
+        processed: number;
+    }>;
+    testSend(input: {
+        journeyId: string;
+        deviceId: string;
+        stepId: string;
+    }): Promise<PushSendResult[]>;
+    private processLockedRun;
+    private matchesAudience;
+    private retryRun;
+    private failRun;
+    private requireJourney;
+}
+declare function validateJourneyDefinition(input: PushJourneyDefinition): PushJourneyDefinition;
+
 interface CodixusServerConfig {
     mongoUri: string;
     jwtSecret: string;
@@ -350,6 +524,9 @@ interface CodixusServerConfig {
     push?: {
         transport: PushTransport;
     };
+    events?: {
+        usersCollection?: string;
+    };
     admin?: {
         token: string;
     };
@@ -391,10 +568,26 @@ declare class CodixusServer {
     };
     push?: {
         router: () => Router;
-        send: (input: PushSendInput) => Promise<void>;
-        sendTo: (input: PushSendToInput) => Promise<void>;
+        send: (input: PushSendInput) => Promise<PushSendResult[]>;
+        sendTo: (input: PushSendToInput) => Promise<PushSendResult[]>;
         pollReceipts: () => Promise<void>;
         find: (filter: Record<string, unknown>) => Promise<PushDeviceDoc[]>;
+        journeys: {
+            create: JourneyService["create"];
+            list: JourneyService["list"];
+            get: JourneyService["get"];
+            updateDraft: JourneyService["updateDraft"];
+            publish: JourneyService["publish"];
+            pause: JourneyService["pause"];
+            resume: JourneyService["resume"];
+            testSend: JourneyService["testSend"];
+            processDue: JourneyService["processDue"];
+        };
+    };
+    events: {
+        router: () => Router;
+        track: (input: PushEventTrackInput) => Promise<PushEventTrackResult>;
+        find: (filter: Record<string, unknown>) => Promise<PushEventDoc[]>;
     };
     admin?: {
         router: () => Router;
@@ -423,6 +616,11 @@ declare function validate<T extends z.ZodType>(schema: T): (req: Request, res: R
 declare function createExpoTransport(opts?: {
     accessToken?: string;
     fetchImpl?: typeof fetch;
+    sleepImpl?: (delayMs: number) => Promise<void>;
+    baseRetryDelayMs?: number;
+    maxAttempts?: number;
+    requestTimeoutMs?: number;
+    maxRetryDelayMs?: number;
 }): PushTransport;
 
-export { type AuthRouterConfig, type AuthenticatedRequest, CodixusServer, type CodixusServerConfig, type GuardOptions, Model, type ModelDefinition, type ModelType, type PushDeliveryDoc, type PushDeviceDoc, type PushMessage, type PushReceipt, type PushSendInput, type PushSendToInput, type PushTicket, type PushTransport, Query, type RateLimitConfig, RestErrorCode, type RestOptions, type SigningConfig, SubCollection, createExpoTransport, model, validate };
+export { type AuthRouterConfig, type AuthenticatedRequest, CodixusServer, type CodixusServerConfig, type GuardOptions, JourneyError, Model, type ModelDefinition, type ModelType, type PushDeliveryDoc, type PushDeviceDoc, type PushEventDoc, type PushEventSource, type PushEventTrackInput, type PushEventTrackResult, type PushJourneyAudience, type PushJourneyDefinition, type PushJourneyDoc, type PushJourneyRevisionDoc, type PushJourneyRunDoc, type PushJourneyRunStatus, type PushJourneyStatus, type PushJourneyStep, type PushMessage, type PushReceipt, type PushSendInput, type PushSendResult, type PushSendToInput, type PushTicket, type PushTransport, Query, type RateLimitConfig, RestErrorCode, type RestOptions, type SigningConfig, SubCollection, createExpoTransport, model, validate, validateJourneyDefinition };

package/dist/index.d.ts

@@ -265,6 +265,37 @@ interface RestOptions {
     allowWrite?: (req: AuthenticatedRequest, doc: Record<string, unknown>, patch: Record<string, unknown>) => HookResult;
 }
 
+type PushEventSource = "client" | "server" | "system";
+type PushEventDoc = {
+    _id: string;
+    deviceId: string;
+    name: string;
+    properties?: Record<string, unknown>;
+    source: PushEventSource;
+    occurredAt: Date;
+    createdAt: Date;
+    idempotencyKey?: string;
+    journeyEnrollments?: Array<{
+        journeyId: string;
+        revision: number;
+    }>;
+    enrollmentStatus?: "pending" | "complete";
+};
+type PushEventTrackInput = {
+    deviceId: string;
+    name: string;
+    properties?: Record<string, unknown>;
+    source?: PushEventSource;
+    occurredAt?: Date;
+    idempotencyKey?: string;
+    usersCollection?: string;
+};
+type PushEventTrackResult = {
+    created: boolean;
+    eventId?: string;
+    ignored?: "USER_NOT_FOUND";
+};
+
 type PushMessage = {
     token: string;
     title: string;
@@ -274,6 +305,7 @@ type PushMessage = {
     badge?: number;
     sound?: string;
     channelId?: string;
+    imageUrl?: string;
 };
 type PushTicket = {
     token: string;
@@ -286,6 +318,7 @@ type PushReceipt = {
     ticketId: string;
     status: "ok" | "error";
     errorCode?: string;
+    errorMessage?: string;
 };
 interface PushTransport {
     readonly name: string;
@@ -298,6 +331,11 @@ type PushSendInput = {
     body: string;
     data?: Record<string, unknown>;
     idempotencyKey?: string;
+    imageUrl?: string;
+    journeyId?: string;
+    journeyRevision?: number;
+    journeyStepId?: string;
+    isTest?: boolean;
 };
 type PushSendToInput = {
     filter: Record<string, unknown>;
@@ -305,6 +343,15 @@ type PushSendToInput = {
     body: string;
     data?: Record<string, unknown>;
     idempotencyKey?: string;
+    imageUrl?: string;
+};
+type PushSendResult = {
+    deviceId: string;
+    token?: string;
+    deliveryId?: string;
+    status: "submitted" | "failed" | "skipped";
+    errorCode?: string;
+    errorMessage?: string;
 };
 type PushDeviceDoc = {
     _id: string;
@@ -330,15 +377,142 @@ type PushDeliveryDoc = {
     title: string;
     body: string;
     data?: Record<string, unknown>;
-    status: "submitted" | "failed" | "opened";
+    imageUrl?: string;
+    status: "sending" | "submitted" | "failed" | "opened";
     ticketId?: string;
     errorCode?: string;
+    errorMessage?: string;
     idempotencyKey: string;
     createdAt: Date;
     openedAt?: Date;
     receiptedAt?: Date;
+    updatedAt?: Date;
+    journeyId?: string;
+    journeyRevision?: number;
+    journeyStepId?: string;
+    isTest?: boolean;
 };
 
+declare class PushService {
+    private transport;
+    private devicesCol;
+    private deliveriesCol;
+    constructor(db: Db, transport: PushTransport);
+    send(input: PushSendInput): Promise<PushSendResult[]>;
+    sendTo(input: PushSendToInput): Promise<PushSendResult[]>;
+    pollReceipts(): Promise<void>;
+    find(filter: Record<string, unknown>): Promise<PushDeviceDoc[]>;
+}
+
+type PushJourneyAudience = {
+    operator: "has_event" | "not_has_event";
+    eventName: string;
+};
+type PushJourneyStep = {
+    id: string;
+    offsetSeconds: number;
+    title: string;
+    body: string;
+    imageUrl?: string;
+    data?: Record<string, unknown>;
+};
+type PushJourneyDefinition = {
+    entryEvent: string;
+    audience?: PushJourneyAudience;
+    steps: PushJourneyStep[];
+};
+type PushJourneyStatus = "draft" | "live" | "paused";
+type PushJourneyDoc = {
+    _id: string;
+    name: string;
+    status: PushJourneyStatus;
+    draft: PushJourneyDefinition;
+    revisionCounter: number;
+    liveRevision?: number;
+    liveEntryEvent?: string;
+    liveSince?: Date;
+    publishedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type PushJourneyRevisionDoc = {
+    _id: string;
+    journeyId: string;
+    revision: number;
+    name: string;
+    definition: PushJourneyDefinition;
+    publishedAt: Date;
+};
+type PushJourneyRunStatus = "active" | "paused" | "completed" | "exited" | "failed";
+type PushJourneyRunDoc = {
+    _id: string;
+    journeyId: string;
+    revision: number;
+    eventId: string;
+    deviceId: string;
+    eventOccurredAt: Date;
+    status: PushJourneyRunStatus;
+    nextStepIndex: number;
+    nextRunAt: Date;
+    attempts: number;
+    lockedUntil?: Date;
+    lockToken?: string;
+    lastError?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    completedAt?: Date;
+};
+
+declare class JourneyError extends Error {
+    readonly code: "NOT_FOUND" | "INVALID_STATE" | "INVALID_INPUT";
+    constructor(code: "NOT_FOUND" | "INVALID_STATE" | "INVALID_INPUT", message: string);
+}
+declare class JourneyService {
+    private readonly push;
+    private readonly journeys;
+    private readonly revisions;
+    private readonly runs;
+    private readonly events;
+    constructor(db: Db, push: PushService);
+    ensureIndexes(): Promise<void>;
+    create(input: {
+        name: string;
+        definition: PushJourneyDefinition;
+    }): Promise<PushJourneyDoc>;
+    list(): Promise<PushJourneyDoc[]>;
+    get(id: string): Promise<PushJourneyDoc | null>;
+    updateDraft(id: string, input: {
+        name?: string;
+        definition?: PushJourneyDefinition;
+    }): Promise<PushJourneyDoc>;
+    publish(id: string): Promise<PushJourneyDoc>;
+    pause(id: string): Promise<PushJourneyDoc>;
+    resume(id: string): Promise<PushJourneyDoc>;
+    enrollEvent(event: PushEventDoc): Promise<void>;
+    resolveEnrollments(eventName: string): Promise<Array<{
+        journeyId: string;
+        revision: number;
+    }>>;
+    processDue(options?: {
+        now?: Date;
+        limit?: number;
+        leaseMs?: number;
+    }): Promise<{
+        processed: number;
+    }>;
+    testSend(input: {
+        journeyId: string;
+        deviceId: string;
+        stepId: string;
+    }): Promise<PushSendResult[]>;
+    private processLockedRun;
+    private matchesAudience;
+    private retryRun;
+    private failRun;
+    private requireJourney;
+}
+declare function validateJourneyDefinition(input: PushJourneyDefinition): PushJourneyDefinition;
+
 interface CodixusServerConfig {
     mongoUri: string;
     jwtSecret: string;
@@ -350,6 +524,9 @@ interface CodixusServerConfig {
     push?: {
         transport: PushTransport;
     };
+    events?: {
+        usersCollection?: string;
+    };
     admin?: {
         token: string;
     };
@@ -391,10 +568,26 @@ declare class CodixusServer {
     };
     push?: {
         router: () => Router;
-        send: (input: PushSendInput) => Promise<void>;
-        sendTo: (input: PushSendToInput) => Promise<void>;
+        send: (input: PushSendInput) => Promise<PushSendResult[]>;
+        sendTo: (input: PushSendToInput) => Promise<PushSendResult[]>;
         pollReceipts: () => Promise<void>;
         find: (filter: Record<string, unknown>) => Promise<PushDeviceDoc[]>;
+        journeys: {
+            create: JourneyService["create"];
+            list: JourneyService["list"];
+            get: JourneyService["get"];
+            updateDraft: JourneyService["updateDraft"];
+            publish: JourneyService["publish"];
+            pause: JourneyService["pause"];
+            resume: JourneyService["resume"];
+            testSend: JourneyService["testSend"];
+            processDue: JourneyService["processDue"];
+        };
+    };
+    events: {
+        router: () => Router;
+        track: (input: PushEventTrackInput) => Promise<PushEventTrackResult>;
+        find: (filter: Record<string, unknown>) => Promise<PushEventDoc[]>;
     };
     admin?: {
         router: () => Router;
@@ -423,6 +616,11 @@ declare function validate<T extends z.ZodType>(schema: T): (req: Request, res: R
 declare function createExpoTransport(opts?: {
     accessToken?: string;
     fetchImpl?: typeof fetch;
+    sleepImpl?: (delayMs: number) => Promise<void>;
+    baseRetryDelayMs?: number;
+    maxAttempts?: number;
+    requestTimeoutMs?: number;
+    maxRetryDelayMs?: number;
 }): PushTransport;
 
-export { type AuthRouterConfig, type AuthenticatedRequest, CodixusServer, type CodixusServerConfig, type GuardOptions, Model, type ModelDefinition, type ModelType, type PushDeliveryDoc, type PushDeviceDoc, type PushMessage, type PushReceipt, type PushSendInput, type PushSendToInput, type PushTicket, type PushTransport, Query, type RateLimitConfig, RestErrorCode, type RestOptions, type SigningConfig, SubCollection, createExpoTransport, model, validate };
+export { type AuthRouterConfig, type AuthenticatedRequest, CodixusServer, type CodixusServerConfig, type GuardOptions, JourneyError, Model, type ModelDefinition, type ModelType, type PushDeliveryDoc, type PushDeviceDoc, type PushEventDoc, type PushEventSource, type PushEventTrackInput, type PushEventTrackResult, type PushJourneyAudience, type PushJourneyDefinition, type PushJourneyDoc, type PushJourneyRevisionDoc, type PushJourneyRunDoc, type PushJourneyRunStatus, type PushJourneyStatus, type PushJourneyStep, type PushMessage, type PushReceipt, type PushSendInput, type PushSendResult, type PushSendToInput, type PushTicket, type PushTransport, Query, type RateLimitConfig, RestErrorCode, type RestOptions, type SigningConfig, SubCollection, createExpoTransport, model, validate, validateJourneyDefinition };