@timothyw/pat-common 1.0.115 → 1.0.117

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

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { Serialized } from '../../utils';
 export declare const notificationEntityTypeSchema: z.ZodEnum<["agenda", "tasks", "habits", "inbox", "agenda_item", "habit", "agenda_defaults", "habits_defaults"]>;
+export declare const notificationStatusSchema: z.ZodEnum<["scheduled", "sent", "failed", "cancelled"]>;
 export declare const notificationTriggerTypeSchema: z.ZodEnum<["time_based", "event_based", "recurring"]>;
 export declare const notificationTriggerSchema: z.ZodObject<{
     type: z.ZodEnum<["time_based", "event_based", "recurring"]>;
@@ -215,6 +216,72 @@ export declare const entitySyncStateSchema: z.ZodObject<{
     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.ZodEnum<["scheduled", "sent", "failed", "cancelled"]>;
+    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, {
+    _id: string & {
+        readonly __brand: "NotificationInstanceId";
+    };
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string & {
+        readonly __brand: "UserId";
+    };
+    status: "scheduled" | "sent" | "failed" | "cancelled";
+    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;
+}, {
+    _id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    userId: string;
+    status: "scheduled" | "sent" | "failed" | "cancelled";
+    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.ZodEnum<["agenda", "tasks", "habits", "inbox", "agenda_item", "habit", "agenda_defaults", "habits_defaults"]>;
     entityId: z.ZodOptional<z.ZodString>;
@@ -349,38 +416,64 @@ export declare const updateNotificationTemplateRequestSchema: z.ZodObject<{
     customized?: boolean | undefined;
 }>;
 export declare const syncNotificationTemplateRequestSchema: z.ZodObject<{
-    entityType: z.ZodEnum<["agenda", "tasks", "habits", "inbox", "agenda_item", "habit", "agenda_defaults", "habits_defaults"]>;
+    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: "agenda" | "inbox" | "habits" | "tasks" | "agenda_item" | "habit" | "agenda_defaults" | "habits_defaults";
+    entityType: string;
     entityId: string;
+    templateTitle: string;
+    templateBody: string;
+    variables?: Record<string, any> | undefined;
 }, {
-    entityType: "agenda" | "inbox" | "habits" | "tasks" | "agenda_item" | "habit" | "agenda_defaults" | "habits_defaults";
+    entityType: string;
     entityId: string;
+    templateTitle: string;
+    templateBody: string;
+    variables?: Record<string, any> | undefined;
 }>;
-export declare const previewNotificationTemplateRequestSchema: z.ZodObject<{
-    templateId: z.ZodEffects<z.ZodString, import("../id-types").NotificationTemplateId, string>;
-    entityData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+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, {
-    templateId: string & {
-        readonly __brand: "NotificationTemplateId";
-    };
-    entityData?: Record<string, any> | undefined;
+    status?: string | undefined;
+    entityId?: string | undefined;
+    templateId?: string | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
 }, {
-    templateId: string;
-    entityData?: Record<string, any> | undefined;
+    status?: string | undefined;
+    entityId?: string | undefined;
+    templateId?: string | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
 }>;
 export type NotificationEntityType = z.infer<typeof notificationEntityTypeSchema>;
 export type NotificationTriggerType = z.infer<typeof notificationTriggerTypeSchema>;
+export type NotificationStatus = z.infer<typeof notificationStatusSchema>;
 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 interface CreateNotificationTemplateResponse {
     template: Serialized<NotificationTemplateData>;
 }
@@ -403,5 +496,13 @@ 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;
 }

package/dist/types/new/notifications-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.previewNotificationTemplateRequestSchema = exports.syncNotificationTemplateRequestSchema = exports.updateNotificationTemplateRequestSchema = exports.createNotificationTemplateRequestSchema = exports.entitySyncStateSchema = exports.createNotificationTemplateSchema = exports.notificationTemplateSchema = exports.notificationContentSchema = exports.notificationTriggerSchema = exports.notificationTriggerTypeSchema = exports.notificationEntityTypeSchema = void 0;
+exports.getNotificationInstancesRequestSchema = exports.previewNotificationTemplateRequestSchema = exports.syncNotificationTemplateRequestSchema = exports.updateNotificationTemplateRequestSchema = exports.createNotificationTemplateRequestSchema = exports.notificationInstanceSchema = exports.entitySyncStateSchema = exports.createNotificationTemplateSchema = exports.notificationTemplateSchema = exports.notificationContentSchema = exports.notificationTriggerSchema = exports.notificationTriggerTypeSchema = exports.notificationStatusSchema = exports.notificationEntityTypeSchema = void 0;
 const zod_1 = require("zod");
 const id_types_1 = require("../id-types");
 exports.notificationEntityTypeSchema = zod_1.z.enum([
@@ -8,6 +8,7 @@ exports.notificationEntityTypeSchema = zod_1.z.enum([
     'agenda_item', 'habit',
     'agenda_defaults', 'habits_defaults'
 ]);
+exports.notificationStatusSchema = zod_1.z.enum(['scheduled', 'sent', 'failed', 'cancelled']);
 exports.notificationTriggerTypeSchema = zod_1.z.enum(['time_based', 'event_based', 'recurring']);
 exports.notificationTriggerSchema = zod_1.z.object({
     type: exports.notificationTriggerTypeSchema,
@@ -46,6 +47,24 @@ exports.entitySyncStateSchema = zod_1.z.object({
     synced: zod_1.z.boolean(),
     updatedAt: zod_1.z.date()
 });
+exports.notificationInstanceSchema = zod_1.z.object({
+    _id: id_types_1.notificationInstanceIdSchema,
+    templateId: id_types_1.notificationTemplateIdSchema,
+    userId: id_types_1.userIdSchema,
+    entityId: zod_1.z.string(),
+    scheduledFor: zod_1.z.date(),
+    status: exports.notificationStatusSchema,
+    sentAt: zod_1.z.date().optional(),
+    content: zod_1.z.object({
+        title: zod_1.z.string(),
+        body: zod_1.z.string(),
+        data: zod_1.z.record(zod_1.z.any()).optional()
+    }),
+    redisId: zod_1.z.string(),
+    error: zod_1.z.string().optional(),
+    createdAt: zod_1.z.date(),
+    updatedAt: zod_1.z.date()
+});
 exports.createNotificationTemplateRequestSchema = zod_1.z.object({
     entityType: exports.notificationEntityTypeSchema,
     entityId: zod_1.z.string().optional(),
@@ -82,10 +101,19 @@ exports.updateNotificationTemplateRequestSchema = zod_1.z.object({
     customized: zod_1.z.boolean().optional()
 });
 exports.syncNotificationTemplateRequestSchema = zod_1.z.object({
-    entityType: exports.notificationEntityTypeSchema,
-    entityId: zod_1.z.string()
+    sync: zod_1.z.boolean()
 });
 exports.previewNotificationTemplateRequestSchema = zod_1.z.object({
-    templateId: id_types_1.notificationTemplateIdSchema,
-    entityData: zod_1.z.record(zod_1.z.any()).optional()
+    templateTitle: zod_1.z.string(),
+    templateBody: zod_1.z.string(),
+    entityType: zod_1.z.string(),
+    entityId: zod_1.z.string(),
+    variables: zod_1.z.record(zod_1.z.any()).optional()
+});
+exports.getNotificationInstancesRequestSchema = zod_1.z.object({
+    status: zod_1.z.string().optional(),
+    templateId: zod_1.z.string().optional(),
+    entityId: zod_1.z.string().optional(),
+    limit: zod_1.z.number().optional(),
+    offset: zod_1.z.number().optional()
 });

package/package.json

@@ -2,7 +2,7 @@
   "name": "@timothyw/pat-common",
   "description": "",
   "author": "Timothy Washburn",
-  "version": "1.0.115",
+  "version": "1.0.117",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/types/new/notifications-types.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { notificationTemplateIdSchema, userIdSchema } from '../id-types';
+import { notificationTemplateIdSchema, notificationInstanceIdSchema, userIdSchema } from '../id-types';
 import { Serialized } from '../../utils';
 
 export const notificationEntityTypeSchema = z.enum([
@@ -8,6 +8,8 @@ export const notificationEntityTypeSchema = z.enum([
     'agenda_defaults', 'habits_defaults'
 ]);
 
+export const notificationStatusSchema = z.enum(['scheduled', 'sent', 'failed', 'cancelled']);
+
 export const notificationTriggerTypeSchema = z.enum(['time_based', 'event_based', 'recurring']);
 
 export const notificationTriggerSchema = z.object({
@@ -52,6 +54,25 @@ export const entitySyncStateSchema = z.object({
     updatedAt: z.date()
 });
 
+export const notificationInstanceSchema = z.object({
+    _id: notificationInstanceIdSchema,
+    templateId: notificationTemplateIdSchema,
+    userId: userIdSchema,
+    entityId: z.string(),
+    scheduledFor: z.date(),
+    status: notificationStatusSchema,
+    sentAt: z.date().optional(),
+    content: z.object({
+        title: z.string(),
+        body: z.string(),
+        data: z.record(z.any()).optional()
+    }),
+    redisId: z.string(),
+    error: z.string().optional(),
+    createdAt: z.date(),
+    updatedAt: z.date()
+});
+
 export const createNotificationTemplateRequestSchema = z.object({
     entityType: notificationEntityTypeSchema,
     entityId: z.string().optional(),
@@ -90,27 +111,40 @@ export const updateNotificationTemplateRequestSchema = z.object({
 });
 
 export const syncNotificationTemplateRequestSchema = z.object({
-    entityType: notificationEntityTypeSchema,
-    entityId: z.string()
+    sync: z.boolean()
 });
 
 export const previewNotificationTemplateRequestSchema = z.object({
-    templateId: notificationTemplateIdSchema,
-    entityData: z.record(z.any()).optional()
+    templateTitle: z.string(),
+    templateBody: z.string(),
+    entityType: z.string(),
+    entityId: z.string(),
+    variables: z.record(z.any()).optional()
+});
+
+export const getNotificationInstancesRequestSchema = z.object({
+    status: z.string().optional(),
+    templateId: z.string().optional(),
+    entityId: z.string().optional(),
+    limit: z.number().optional(),
+    offset: z.number().optional()
 });
 
 export type NotificationEntityType = z.infer<typeof notificationEntityTypeSchema>;
 export type NotificationTriggerType = z.infer<typeof notificationTriggerTypeSchema>;
+export type NotificationStatus = z.infer<typeof notificationStatusSchema>;
 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 interface CreateNotificationTemplateResponse {
     template: Serialized<NotificationTemplateData>;
@@ -140,5 +174,14 @@ 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;
 }