@codixus/server 0.1.5 → 0.1.6

package/dist/index.d.cts

@@ -265,6 +265,80 @@ interface RestOptions {
     allowWrite?: (req: AuthenticatedRequest, doc: Record<string, unknown>, patch: Record<string, unknown>) => HookResult;
 }
 
+type PushMessage = {
+    token: string;
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    ttl?: number;
+    badge?: number;
+    sound?: string;
+    channelId?: string;
+};
+type PushTicket = {
+    token: string;
+    status: "ok" | "error";
+    ticketId?: string;
+    errorCode?: string;
+    errorMessage?: string;
+};
+type PushReceipt = {
+    ticketId: string;
+    status: "ok" | "error";
+    errorCode?: string;
+};
+interface PushTransport {
+    readonly name: string;
+    send(messages: PushMessage[]): Promise<PushTicket[]>;
+    getReceipts?(ticketIds: string[]): Promise<PushReceipt[]>;
+}
+type PushSendInput = {
+    deviceId: string | string[];
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    idempotencyKey?: string;
+};
+type PushSendToInput = {
+    filter: Record<string, unknown>;
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    idempotencyKey?: string;
+};
+type PushDeviceDoc = {
+    _id: string;
+    deviceId: string;
+    token: string;
+    provider: string;
+    platform: "ios" | "android";
+    locale?: string;
+    timezone?: string;
+    appVersion?: string;
+    permissionStatus?: string;
+    enabled: boolean;
+    lastSeenAt: Date;
+    properties?: Record<string, unknown>;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type PushDeliveryDoc = {
+    _id: string;
+    deviceId: string;
+    token: string;
+    provider: string;
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    status: "submitted" | "failed" | "opened";
+    ticketId?: string;
+    errorCode?: string;
+    idempotencyKey: string;
+    createdAt: Date;
+    openedAt?: Date;
+    receiptedAt?: Date;
+};
+
 interface CodixusServerConfig {
     mongoUri: string;
     jwtSecret: string;
@@ -273,6 +347,12 @@ interface CodixusServerConfig {
     refreshTokenTtl?: string;
     dbName: string;
     appSecret?: string;
+    push?: {
+        transport: PushTransport;
+    };
+    admin?: {
+        token: string;
+    };
 }
 declare class CodixusServer {
     private config;
@@ -309,6 +389,16 @@ declare class CodixusServer {
         transaction: <T>(fn: (session: ClientSession) => Promise<T>) => Promise<T>;
         getDb: () => Db;
     };
+    push?: {
+        router: () => Router;
+        send: (input: PushSendInput) => Promise<void>;
+        sendTo: (input: PushSendToInput) => Promise<void>;
+        pollReceipts: () => Promise<void>;
+        find: (filter: Record<string, unknown>) => Promise<PushDeviceDoc[]>;
+    };
+    admin?: {
+        router: () => Router;
+    };
     constructor(config: CodixusServerConfig);
     connect(): Promise<void>;
     /**
@@ -330,4 +420,9 @@ declare class CodixusServer {
 
 declare function validate<T extends z.ZodType>(schema: T): (req: Request, res: Response, next: NextFunction) => void;
 
-export { type AuthRouterConfig, type AuthenticatedRequest, CodixusServer, type CodixusServerConfig, type GuardOptions, Model, type ModelDefinition, type ModelType, Query, type RateLimitConfig, RestErrorCode, type RestOptions, type SigningConfig, SubCollection, model, validate };
+declare function createExpoTransport(opts?: {
+    accessToken?: string;
+    fetchImpl?: typeof fetch;
+}): 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 };

package/dist/index.d.ts

@@ -265,6 +265,80 @@ interface RestOptions {
     allowWrite?: (req: AuthenticatedRequest, doc: Record<string, unknown>, patch: Record<string, unknown>) => HookResult;
 }
 
+type PushMessage = {
+    token: string;
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    ttl?: number;
+    badge?: number;
+    sound?: string;
+    channelId?: string;
+};
+type PushTicket = {
+    token: string;
+    status: "ok" | "error";
+    ticketId?: string;
+    errorCode?: string;
+    errorMessage?: string;
+};
+type PushReceipt = {
+    ticketId: string;
+    status: "ok" | "error";
+    errorCode?: string;
+};
+interface PushTransport {
+    readonly name: string;
+    send(messages: PushMessage[]): Promise<PushTicket[]>;
+    getReceipts?(ticketIds: string[]): Promise<PushReceipt[]>;
+}
+type PushSendInput = {
+    deviceId: string | string[];
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    idempotencyKey?: string;
+};
+type PushSendToInput = {
+    filter: Record<string, unknown>;
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    idempotencyKey?: string;
+};
+type PushDeviceDoc = {
+    _id: string;
+    deviceId: string;
+    token: string;
+    provider: string;
+    platform: "ios" | "android";
+    locale?: string;
+    timezone?: string;
+    appVersion?: string;
+    permissionStatus?: string;
+    enabled: boolean;
+    lastSeenAt: Date;
+    properties?: Record<string, unknown>;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type PushDeliveryDoc = {
+    _id: string;
+    deviceId: string;
+    token: string;
+    provider: string;
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+    status: "submitted" | "failed" | "opened";
+    ticketId?: string;
+    errorCode?: string;
+    idempotencyKey: string;
+    createdAt: Date;
+    openedAt?: Date;
+    receiptedAt?: Date;
+};
+
 interface CodixusServerConfig {
     mongoUri: string;
     jwtSecret: string;
@@ -273,6 +347,12 @@ interface CodixusServerConfig {
     refreshTokenTtl?: string;
     dbName: string;
     appSecret?: string;
+    push?: {
+        transport: PushTransport;
+    };
+    admin?: {
+        token: string;
+    };
 }
 declare class CodixusServer {
     private config;
@@ -309,6 +389,16 @@ declare class CodixusServer {
         transaction: <T>(fn: (session: ClientSession) => Promise<T>) => Promise<T>;
         getDb: () => Db;
     };
+    push?: {
+        router: () => Router;
+        send: (input: PushSendInput) => Promise<void>;
+        sendTo: (input: PushSendToInput) => Promise<void>;
+        pollReceipts: () => Promise<void>;
+        find: (filter: Record<string, unknown>) => Promise<PushDeviceDoc[]>;
+    };
+    admin?: {
+        router: () => Router;
+    };
     constructor(config: CodixusServerConfig);
     connect(): Promise<void>;
     /**
@@ -330,4 +420,9 @@ declare class CodixusServer {
 
 declare function validate<T extends z.ZodType>(schema: T): (req: Request, res: Response, next: NextFunction) => void;
 
-export { type AuthRouterConfig, type AuthenticatedRequest, CodixusServer, type CodixusServerConfig, type GuardOptions, Model, type ModelDefinition, type ModelType, Query, type RateLimitConfig, RestErrorCode, type RestOptions, type SigningConfig, SubCollection, model, validate };
+declare function createExpoTransport(opts?: {
+    accessToken?: string;
+    fetchImpl?: typeof fetch;
+}): 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 };