@timothyw/pat-common 1.0.118 → 1.0.120

package/dist/types/notifications-types.d.ts

@@ -0,0 +1,570 @@
+import { z } from 'zod';
+import { Serialized } from '../utils';
+export interface NotificationContext<T = any> {
+    entityId: string;
+    entityType: NotificationEntityType;
+    entityData: T;
+    userId: string;
+    variables: Record<string, any>;
+}
+export declare enum NotificationEntityType {
+    AGENDA = "agenda",
+    TASKS = "tasks",
+    HABITS = "habits",
+    INBOX = "inbox",
+    AGENDA_ITEM = "agenda_item",
+    HABIT = "habit",
+    AGENDA_DEFAULTS = "agenda_defaults",
+    HABITS_DEFAULTS = "habits_defaults",
+    INBOX_PANEL = "inbox_panel"
+}
+export declare const notificationEntityTypeSchema: z.ZodNativeEnum<typeof NotificationEntityType>;
+export declare enum NotificationStatus {
+    SCHEDULED = "scheduled",
+    SENT = "sent",
+    FAILED = "failed",
+    CANCELLED = "cancelled"
+}
+export declare enum NotificationTriggerType {
+    TIME_BASED = "time_based",
+    EVENT_BASED = "event_based",
+    RECURRING = "recurring"
+}
+export declare const notificationStatusSchema: z.ZodNativeEnum<typeof NotificationStatus>;
+export declare const notificationTriggerTypeSchema: z.ZodNativeEnum<typeof NotificationTriggerType>;
+export declare const notificationTriggerSchema: z.ZodObject<{
+    type: z.ZodNativeEnum<typeof NotificationTriggerType>;
+    conditions: z.ZodRecord<z.ZodString, z.ZodAny>;
+    timing: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    type: NotificationTriggerType;
+    conditions: Record<string, any>;
+    timing: Record<string, any>;
+}, {
+    type: NotificationTriggerType;
+    conditions: Record<string, any>;
+    timing: Record<string, any>;
+}>;
+export declare const notificationContentSchema: z.ZodObject<{
+    title: z.ZodString;
+    body: z.ZodString;
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    body: string;
+    variables?: Record<string, string> | undefined;
+}, {
+    title: string;
+    body: string;
+    variables?: Record<string, string> | undefined;
+}>;
+export declare const notificationTemplateSchema: z.ZodObject<{
+    _id: z.ZodEffects<z.ZodString, import("./id-types").NotificationTemplateId, string>;
+    userId: z.ZodEffects<z.ZodString, import("./id-types").UserId, string>;
+    entityType: z.ZodNativeEnum<typeof NotificationEntityType>;
+    entityId: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    trigger: z.ZodObject<{
+        type: z.ZodNativeEnum<typeof NotificationTriggerType>;
+        conditions: z.ZodRecord<z.ZodString, z.ZodAny>;
+        timing: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }>;
+    content: z.ZodObject<{
+        title: z.ZodString;
+        body: z.ZodString;
+        variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }>;
+    active: z.ZodBoolean;
+    inheritedFrom: z.ZodOptional<z.ZodEffects<z.ZodString, import("./id-types").NotificationTemplateId, string>>;
+    customized: z.ZodBoolean;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+}, "strip", z.ZodTypeAny, {
+    _id: string & {
+        readonly __brand: "NotificationTemplateId";
+    };
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string & {
+        readonly __brand: "UserId";
+    };
+    name: string;
+    content: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    };
+    entityType: NotificationEntityType;
+    trigger: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    };
+    active: boolean;
+    customized: boolean;
+    description?: string | undefined;
+    entityId?: string | undefined;
+    inheritedFrom?: import("./id-types").NotificationTemplateId | undefined;
+}, {
+    _id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string;
+    name: string;
+    content: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    };
+    entityType: NotificationEntityType;
+    trigger: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    };
+    active: boolean;
+    customized: boolean;
+    description?: string | undefined;
+    entityId?: string | undefined;
+    inheritedFrom?: string | undefined;
+}>;
+export declare const createNotificationTemplateSchema: z.ZodObject<Omit<{
+    _id: z.ZodEffects<z.ZodString, import("./id-types").NotificationTemplateId, string>;
+    userId: z.ZodEffects<z.ZodString, import("./id-types").UserId, string>;
+    entityType: z.ZodNativeEnum<typeof NotificationEntityType>;
+    entityId: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    trigger: z.ZodObject<{
+        type: z.ZodNativeEnum<typeof NotificationTriggerType>;
+        conditions: z.ZodRecord<z.ZodString, z.ZodAny>;
+        timing: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }>;
+    content: z.ZodObject<{
+        title: z.ZodString;
+        body: z.ZodString;
+        variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }>;
+    active: z.ZodBoolean;
+    inheritedFrom: z.ZodOptional<z.ZodEffects<z.ZodString, import("./id-types").NotificationTemplateId, string>>;
+    customized: z.ZodBoolean;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+}, "_id" | "createdAt" | "updatedAt">, "strip", z.ZodTypeAny, {
+    userId: string & {
+        readonly __brand: "UserId";
+    };
+    name: string;
+    content: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    };
+    entityType: NotificationEntityType;
+    trigger: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    };
+    active: boolean;
+    customized: boolean;
+    description?: string | undefined;
+    entityId?: string | undefined;
+    inheritedFrom?: import("./id-types").NotificationTemplateId | undefined;
+}, {
+    userId: string;
+    name: string;
+    content: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    };
+    entityType: NotificationEntityType;
+    trigger: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    };
+    active: boolean;
+    customized: boolean;
+    description?: string | undefined;
+    entityId?: string | undefined;
+    inheritedFrom?: string | undefined;
+}>;
+export declare const entitySyncStateSchema: z.ZodObject<{
+    userId: z.ZodEffects<z.ZodString, import("./id-types").UserId, string>;
+    entityType: z.ZodNativeEnum<typeof NotificationEntityType>;
+    entityId: z.ZodString;
+    synced: z.ZodBoolean;
+    updatedAt: z.ZodDate;
+}, "strip", z.ZodTypeAny, {
+    updatedAt: Date;
+    userId: string & {
+        readonly __brand: "UserId";
+    };
+    entityType: NotificationEntityType;
+    entityId: string;
+    synced: boolean;
+}, {
+    updatedAt: Date;
+    userId: string;
+    entityType: NotificationEntityType;
+    entityId: string;
+    synced: boolean;
+}>;
+export declare const notificationInstanceSchema: z.ZodObject<{
+    _id: z.ZodEffects<z.ZodString, import("./id-types").NotificationInstanceId, string>;
+    templateId: z.ZodEffects<z.ZodString, import("./id-types").NotificationTemplateId, string>;
+    userId: z.ZodEffects<z.ZodString, import("./id-types").UserId, string>;
+    entityId: z.ZodString;
+    scheduledFor: z.ZodDate;
+    status: z.ZodNativeEnum<typeof NotificationStatus>;
+    sentAt: z.ZodOptional<z.ZodDate>;
+    content: z.ZodObject<{
+        title: z.ZodString;
+        body: z.ZodString;
+        data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        body: string;
+        data?: Record<string, any> | undefined;
+    }, {
+        title: string;
+        body: string;
+        data?: Record<string, any> | undefined;
+    }>;
+    redisId: z.ZodString;
+    error: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+}, "strip", z.ZodTypeAny, {
+    status: NotificationStatus;
+    _id: string & {
+        readonly __brand: "NotificationInstanceId";
+    };
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string & {
+        readonly __brand: "UserId";
+    };
+    content: {
+        title: string;
+        body: string;
+        data?: Record<string, any> | undefined;
+    };
+    entityId: string;
+    templateId: string & {
+        readonly __brand: "NotificationTemplateId";
+    };
+    scheduledFor: Date;
+    redisId: string;
+    sentAt?: Date | undefined;
+    error?: string | undefined;
+}, {
+    status: NotificationStatus;
+    _id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string;
+    content: {
+        title: string;
+        body: string;
+        data?: Record<string, any> | undefined;
+    };
+    entityId: string;
+    templateId: string;
+    scheduledFor: Date;
+    redisId: string;
+    sentAt?: Date | undefined;
+    error?: string | undefined;
+}>;
+export declare const createNotificationTemplateRequestSchema: z.ZodObject<{
+    entityType: z.ZodNativeEnum<typeof NotificationEntityType>;
+    entityId: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    trigger: z.ZodObject<{
+        type: z.ZodNativeEnum<typeof NotificationTriggerType>;
+        conditions: z.ZodRecord<z.ZodString, z.ZodAny>;
+        timing: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }>;
+    content: z.ZodObject<{
+        title: z.ZodString;
+        body: z.ZodString;
+        variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }>;
+    active: z.ZodDefault<z.ZodBoolean>;
+    inheritedFrom: z.ZodOptional<z.ZodString>;
+    customized: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    content: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    };
+    entityType: NotificationEntityType;
+    trigger: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    };
+    active: boolean;
+    customized: boolean;
+    description?: string | undefined;
+    entityId?: string | undefined;
+    inheritedFrom?: string | undefined;
+}, {
+    name: string;
+    content: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    };
+    entityType: NotificationEntityType;
+    trigger: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    };
+    description?: string | undefined;
+    entityId?: string | undefined;
+    active?: boolean | undefined;
+    inheritedFrom?: string | undefined;
+    customized?: boolean | undefined;
+}>;
+export declare const updateNotificationTemplateRequestSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    trigger: z.ZodOptional<z.ZodObject<{
+        type: z.ZodNativeEnum<typeof NotificationTriggerType>;
+        conditions: z.ZodRecord<z.ZodString, z.ZodAny>;
+        timing: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }, {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    }>>;
+    content: z.ZodOptional<z.ZodObject<{
+        title: z.ZodString;
+        body: z.ZodString;
+        variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }, {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    }>>;
+    active: z.ZodOptional<z.ZodBoolean>;
+    customized: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | undefined;
+    description?: string | undefined;
+    content?: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    } | undefined;
+    trigger?: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    } | undefined;
+    active?: boolean | undefined;
+    customized?: boolean | undefined;
+}, {
+    name?: string | undefined;
+    description?: string | undefined;
+    content?: {
+        title: string;
+        body: string;
+        variables?: Record<string, string> | undefined;
+    } | undefined;
+    trigger?: {
+        type: NotificationTriggerType;
+        conditions: Record<string, any>;
+        timing: Record<string, any>;
+    } | undefined;
+    active?: boolean | undefined;
+    customized?: boolean | undefined;
+}>;
+export declare const syncNotificationTemplateRequestSchema: z.ZodObject<{
+    sync: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    sync: boolean;
+}, {
+    sync: boolean;
+}>;
+export declare const previewNotificationTemplateRequestSchema: z.ZodObject<{
+    templateTitle: z.ZodString;
+    templateBody: z.ZodString;
+    entityType: z.ZodString;
+    entityId: z.ZodString;
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    entityType: string;
+    entityId: string;
+    templateTitle: string;
+    templateBody: string;
+    variables?: Record<string, any> | undefined;
+}, {
+    entityType: string;
+    entityId: string;
+    templateTitle: string;
+    templateBody: string;
+    variables?: Record<string, any> | undefined;
+}>;
+export declare const getNotificationInstancesRequestSchema: z.ZodObject<{
+    status: z.ZodOptional<z.ZodString>;
+    templateId: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    status?: string | undefined;
+    entityId?: string | undefined;
+    templateId?: string | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+}, {
+    status?: string | undefined;
+    entityId?: string | undefined;
+    templateId?: string | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+}>;
+export declare const entitySyncRequestSchema: z.ZodObject<{
+    entityType: z.ZodString;
+    entityId: z.ZodString;
+    synced: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    entityType: string;
+    entityId: string;
+    synced: boolean;
+}, {
+    entityType: string;
+    entityId: string;
+    synced: boolean;
+}>;
+export declare const getEntitySyncRequestSchema: z.ZodObject<{
+    entityType: z.ZodString;
+    entityId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    entityType: string;
+    entityId: string;
+}, {
+    entityType: string;
+    entityId: string;
+}>;
+export type NotificationTrigger = z.infer<typeof notificationTriggerSchema>;
+export type NotificationContent = z.infer<typeof notificationContentSchema>;
+export type NotificationTemplateData = z.infer<typeof notificationTemplateSchema>;
+export type CreateNotificationTemplateData = z.infer<typeof createNotificationTemplateSchema>;
+export type EntitySyncState = z.infer<typeof entitySyncStateSchema>;
+export type NotificationInstanceData = z.infer<typeof notificationInstanceSchema>;
+export type CreateNotificationTemplateRequest = z.infer<typeof createNotificationTemplateRequestSchema>;
+export type UpdateNotificationTemplateRequest = z.infer<typeof updateNotificationTemplateRequestSchema>;
+export type SyncNotificationTemplateRequest = z.infer<typeof syncNotificationTemplateRequestSchema>;
+export type PreviewNotificationTemplateRequest = z.infer<typeof previewNotificationTemplateRequestSchema>;
+export type GetNotificationInstancesRequest = z.infer<typeof getNotificationInstancesRequestSchema>;
+export type EntitySyncRequest = z.infer<typeof entitySyncRequestSchema>;
+export type GetEntitySyncRequest = z.infer<typeof getEntitySyncRequestSchema>;
+export interface CreateNotificationTemplateResponse {
+    template: Serialized<NotificationTemplateData>;
+}
+export interface GetNotificationTemplatesResponse {
+    templates: Serialized<NotificationTemplateData>[];
+}
+export interface GetNotificationTemplateResponse {
+    template: Serialized<NotificationTemplateData>;
+}
+export interface UpdateNotificationTemplateResponse {
+    template: Serialized<NotificationTemplateData>;
+}
+export interface DeleteNotificationTemplateResponse {
+}
+export interface SyncNotificationTemplateResponse {
+    synced: boolean;
+}
+export interface PreviewNotificationTemplateResponse {
+    preview: {
+        title: string;
+        body: string;
+        variables: Record<string, any>;
+    };
+    missingVariables: string[];
+}
+export interface GetNotificationInstancesResponse {
+    success: boolean;
+    instances?: Serialized<NotificationInstanceData>[];
+    total?: number;
+    error?: string;
+}
+export interface EntitySyncResponse {
+    success: boolean;
+    synced: boolean;
+    templates?: Serialized<NotificationTemplateData>[];
+    error?: string;
+}
+export interface GetEntitySyncResponse {
+    success: boolean;
+    synced: boolean;
+    hasParentTemplates: boolean;
+    error?: string;
+}