@house-rules/notifications 0.0.0-stage → 0.1.1

package/dist/facade.d.ts

@@ -0,0 +1,452 @@
+import { Effect, Layer, Schema } from "effect";
+import { NotificationInputInvalid } from "./notification/notification.js";
+import { NotificationsOptions } from "./notification/options.js";
+import { NotificationStore } from "./storage.js";
+declare const Notifications_base: import("effect/Context").ServiceClass<Notifications, "notifications", {
+    notify: (input: {
+        readonly recipients: readonly {
+            readonly kind: string;
+            readonly id: string;
+        }[];
+        readonly category: string;
+        readonly title: string;
+        readonly body: string;
+        readonly data: Schema.Json;
+    }) => Effect.Effect<{
+        notifications: {
+            readonly id: string;
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+            readonly category: string;
+            readonly title: string;
+            readonly body: string;
+            readonly data: Schema.Json;
+            readonly createdAt: number;
+            readonly readAt: number | null;
+        }[];
+        events: {
+            kind: "NotificationCreated";
+            notificationId: string;
+            recipient: import("./notification/notification.js").Recipient;
+            channels: import("./notification/notification.js").Channel[];
+        }[];
+    }, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    listMine: (actor: {
+        readonly id: string & import("effect/Brand").Brand<"ActorId">;
+    }, page?: {
+        readonly size?: number;
+        readonly cursor?: {
+            readonly createdAt: number;
+            readonly id: string;
+        };
+    } | undefined) => Effect.Effect<{
+        notifications: {
+            readonly id: string;
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+            readonly category: string;
+            readonly title: string;
+            readonly body: string;
+            readonly data: Schema.Json;
+            readonly createdAt: number;
+            readonly readAt: number | null;
+        }[];
+        next: {
+            createdAt: number;
+            id: string;
+        };
+    } | {
+        next?: never;
+        notifications: {
+            readonly id: string;
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+            readonly category: string;
+            readonly title: string;
+            readonly body: string;
+            readonly data: Schema.Json;
+            readonly createdAt: number;
+            readonly readAt: number | null;
+        }[];
+    }, NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    unreadCount: (actor: import("@house-rules/domain").Actor) => Effect.Effect<number, import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    markRead: (actor: {
+        readonly id: string & import("effect/Brand").Brand<"ActorId">;
+    }, notificationId: string) => Effect.Effect<{
+        readonly notifications: readonly {
+            readonly id: string;
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+            readonly category: string;
+            readonly title: string;
+            readonly body: string;
+            readonly data: Schema.Json;
+            readonly createdAt: number;
+            readonly readAt: number | null;
+        }[];
+        readonly events: readonly {
+            readonly kind: "NotificationRead";
+            readonly notificationId: string;
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+        }[];
+    }, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    markAllRead: (actor: {
+        readonly id: string & import("effect/Brand").Brand<"ActorId">;
+    }) => Effect.Effect<{
+        readonly notifications: readonly {
+            readonly id: string;
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+            readonly category: string;
+            readonly title: string;
+            readonly body: string;
+            readonly data: Schema.Json;
+            readonly createdAt: number;
+            readonly readAt: number | null;
+        }[];
+        readonly events: readonly {
+            readonly kind: "NotificationRead";
+            readonly notificationId: string;
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+        }[];
+    }, import("@house-rules/domain").NoOpenUnit | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    getMyPreferences: (actor: {
+        readonly id: string & import("effect/Brand").Brand<"ActorId">;
+    }) => Effect.Effect<{
+        preferences: {
+            category: string;
+            channel: "email" | "inapp" | "push";
+            mode: "daily" | "hourly" | "immediate" | "off";
+        }[];
+        quietHours: {
+            readonly start: string;
+            readonly end: string;
+        } | null;
+        timeZone: string | null;
+    }, import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    setMyPreference: (actor: {
+        readonly id: string & import("effect/Brand").Brand<"ActorId">;
+    }, preference: {
+        readonly category: string;
+        readonly channel: "email" | "inapp" | "push";
+        readonly mode: "daily" | "hourly" | "immediate" | "off";
+    }) => Effect.Effect<undefined, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    setMyQuietHours: (actor: {
+        readonly id: string & import("effect/Brand").Brand<"ActorId">;
+    }, hours: {
+        readonly start: string;
+        readonly end: string;
+    } | null) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    setMyTimeZone: (actor: {
+        readonly id: string & import("effect/Brand").Brand<"ActorId">;
+    }, timeZone: string | null) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    dueDeliveries: () => Effect.Effect<{
+        readonly recipient: {
+            readonly kind: string;
+            readonly id: string;
+        };
+        readonly channel: "email" | "inapp" | "push";
+        readonly mode: "daily" | "hourly" | "immediate";
+        readonly deliveries: readonly {
+            readonly delivery: {
+                readonly id: string;
+                readonly notificationId: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+                readonly channel: "email" | "inapp" | "push";
+                readonly mode: "daily" | "hourly" | "immediate";
+                readonly state: "cancelled" | "failed" | "held" | "pending" | "sent";
+                readonly dueAt: number;
+                readonly retryAt: number | null;
+                readonly sentAt: number | null;
+                readonly attempts: number;
+                readonly lastError: string | null;
+            };
+            readonly notification: {
+                readonly id: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+                readonly category: string;
+                readonly title: string;
+                readonly body: string;
+                readonly data: Schema.Json;
+                readonly createdAt: number;
+                readonly readAt: number | null;
+            };
+        }[];
+    }[], import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    markSent: (deliveryIds: readonly string[]) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    markFailed: (deliveryId: string, error: string) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    erase: (recipient: {
+        readonly kind: string;
+        readonly id: string;
+    }) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+}> & {
+    readonly id: "notifications";
+} & {
+    readonly make: (options: {
+        readonly recipientKind: string;
+        readonly channels: readonly ("email" | "inapp" | "push")[];
+        readonly categories: readonly {
+            readonly name: string;
+            readonly defaultChannels: readonly ("email" | "inapp" | "push")[];
+            readonly mandatory: boolean;
+        }[];
+        readonly dailyDigestTime?: string;
+        readonly maxPageSize: number;
+        readonly maxDueBatch?: number;
+        readonly maxAttempts?: number;
+        readonly retryBaseMs?: number;
+        readonly retryCapMs?: number;
+    }) => Effect.Effect<{
+        notify: (input: {
+            readonly recipients: readonly {
+                readonly kind: string;
+                readonly id: string;
+            }[];
+            readonly category: string;
+            readonly title: string;
+            readonly body: string;
+            readonly data: Schema.Json;
+        }) => Effect.Effect<{
+            notifications: {
+                readonly id: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+                readonly category: string;
+                readonly title: string;
+                readonly body: string;
+                readonly data: Schema.Json;
+                readonly createdAt: number;
+                readonly readAt: number | null;
+            }[];
+            events: {
+                kind: "NotificationCreated";
+                notificationId: string;
+                recipient: import("./notification/notification.js").Recipient;
+                channels: import("./notification/notification.js").Channel[];
+            }[];
+        }, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        listMine: (actor: {
+            readonly id: string & import("effect/Brand").Brand<"ActorId">;
+        }, page?: {
+            readonly size?: number;
+            readonly cursor?: {
+                readonly createdAt: number;
+                readonly id: string;
+            };
+        } | undefined) => Effect.Effect<{
+            notifications: {
+                readonly id: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+                readonly category: string;
+                readonly title: string;
+                readonly body: string;
+                readonly data: Schema.Json;
+                readonly createdAt: number;
+                readonly readAt: number | null;
+            }[];
+            next: {
+                createdAt: number;
+                id: string;
+            };
+        } | {
+            next?: never;
+            notifications: {
+                readonly id: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+                readonly category: string;
+                readonly title: string;
+                readonly body: string;
+                readonly data: Schema.Json;
+                readonly createdAt: number;
+                readonly readAt: number | null;
+            }[];
+        }, NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        unreadCount: (actor: import("@house-rules/domain").Actor) => Effect.Effect<number, import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        markRead: (actor: {
+            readonly id: string & import("effect/Brand").Brand<"ActorId">;
+        }, notificationId: string) => Effect.Effect<{
+            readonly notifications: readonly {
+                readonly id: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+                readonly category: string;
+                readonly title: string;
+                readonly body: string;
+                readonly data: Schema.Json;
+                readonly createdAt: number;
+                readonly readAt: number | null;
+            }[];
+            readonly events: readonly {
+                readonly kind: "NotificationRead";
+                readonly notificationId: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+            }[];
+        }, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        markAllRead: (actor: {
+            readonly id: string & import("effect/Brand").Brand<"ActorId">;
+        }) => Effect.Effect<{
+            readonly notifications: readonly {
+                readonly id: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+                readonly category: string;
+                readonly title: string;
+                readonly body: string;
+                readonly data: Schema.Json;
+                readonly createdAt: number;
+                readonly readAt: number | null;
+            }[];
+            readonly events: readonly {
+                readonly kind: "NotificationRead";
+                readonly notificationId: string;
+                readonly recipient: {
+                    readonly kind: string;
+                    readonly id: string;
+                };
+            }[];
+        }, import("@house-rules/domain").NoOpenUnit | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        getMyPreferences: (actor: {
+            readonly id: string & import("effect/Brand").Brand<"ActorId">;
+        }) => Effect.Effect<{
+            preferences: {
+                category: string;
+                channel: "email" | "inapp" | "push";
+                mode: "daily" | "hourly" | "immediate" | "off";
+            }[];
+            quietHours: {
+                readonly start: string;
+                readonly end: string;
+            } | null;
+            timeZone: string | null;
+        }, import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        setMyPreference: (actor: {
+            readonly id: string & import("effect/Brand").Brand<"ActorId">;
+        }, preference: {
+            readonly category: string;
+            readonly channel: "email" | "inapp" | "push";
+            readonly mode: "daily" | "hourly" | "immediate" | "off";
+        }) => Effect.Effect<undefined, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        setMyQuietHours: (actor: {
+            readonly id: string & import("effect/Brand").Brand<"ActorId">;
+        }, hours: {
+            readonly start: string;
+            readonly end: string;
+        } | null) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        setMyTimeZone: (actor: {
+            readonly id: string & import("effect/Brand").Brand<"ActorId">;
+        }, timeZone: string | null) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        dueDeliveries: () => Effect.Effect<{
+            readonly recipient: {
+                readonly kind: string;
+                readonly id: string;
+            };
+            readonly channel: "email" | "inapp" | "push";
+            readonly mode: "daily" | "hourly" | "immediate";
+            readonly deliveries: readonly {
+                readonly delivery: {
+                    readonly id: string;
+                    readonly notificationId: string;
+                    readonly recipient: {
+                        readonly kind: string;
+                        readonly id: string;
+                    };
+                    readonly channel: "email" | "inapp" | "push";
+                    readonly mode: "daily" | "hourly" | "immediate";
+                    readonly state: "cancelled" | "failed" | "held" | "pending" | "sent";
+                    readonly dueAt: number;
+                    readonly retryAt: number | null;
+                    readonly sentAt: number | null;
+                    readonly attempts: number;
+                    readonly lastError: string | null;
+                };
+                readonly notification: {
+                    readonly id: string;
+                    readonly recipient: {
+                        readonly kind: string;
+                        readonly id: string;
+                    };
+                    readonly category: string;
+                    readonly title: string;
+                    readonly body: string;
+                    readonly data: Schema.Json;
+                    readonly createdAt: number;
+                    readonly readAt: number | null;
+                };
+            }[];
+        }[], import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        markSent: (deliveryIds: readonly string[]) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        markFailed: (deliveryId: string, error: string) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+        erase: (recipient: {
+            readonly kind: string;
+            readonly id: string;
+        }) => Effect.Effect<void, import("@house-rules/domain").NoOpenUnit | NotificationInputInvalid | import("./notification/notification.js").NotificationStoreUnavailable, never>;
+    }, NotificationInputInvalid, NotificationStore>;
+    readonly layer: (options: {
+        readonly recipientKind: string;
+        readonly channels: readonly ("email" | "inapp" | "push")[];
+        readonly categories: readonly {
+            readonly name: string;
+            readonly defaultChannels: readonly ("email" | "inapp" | "push")[];
+            readonly mandatory: boolean;
+        }[];
+        readonly dailyDigestTime?: string;
+        readonly maxPageSize: number;
+        readonly maxDueBatch?: number;
+        readonly maxAttempts?: number;
+        readonly retryBaseMs?: number;
+        readonly retryCapMs?: number;
+    }) => import("@house-rules/domain").ModuleLayer<Notifications, NotificationInputInvalid, NotificationStore>;
+};
+export declare class Notifications extends Notifications_base {
+    static readonly presets: {
+        readonly default: {
+            readonly channels: readonly ["inapp", "push", "email"];
+            readonly dailyDigestTime: "08:00";
+            readonly maxPageSize: 100;
+            readonly maxDueBatch: 100;
+            readonly maxAttempts: 5;
+            readonly retryBaseMs: 1000;
+            readonly retryCapMs: 3600000;
+        };
+    };
+    static readonly layerMemory: (options: NotificationsOptions) => Layer.Layer<Notifications, NotificationInputInvalid, never>;
+    static readonly layerPostgres: (options: NotificationsOptions) => Layer.Layer<Notifications, NotificationInputInvalid, import("effect/sql/SqlClient").SqlClient>;
+}
+export {};

package/dist/facade.js

@@ -0,0 +1,28 @@
+import { defineModule } from "@house-rules/domain";
+import { Effect, Layer, Schema } from "effect";
+import { memoryNotificationStore } from "./adapters/memory/notification.js";
+import { postgresNotificationStore } from "./adapters/postgres/notification.js";
+import { NotificationInputInvalid } from "./notification/notification.js";
+import { makeNotifications } from "./notification/notifications.js";
+import { NotificationsOptions } from "./notification/options.js";
+import { NotificationStore } from "./storage.js";
+export class Notifications extends defineModule()("notifications", {
+    make: (options) => Effect.gen(function* () {
+        const settings = yield* Schema.decodeEffect(NotificationsOptions)(options).pipe(Effect.mapError(() => new NotificationInputInvalid({ message: "Invalid notifications options." })));
+        return makeNotifications(yield* NotificationStore, settings);
+    }),
+}) {
+    static presets = {
+        default: {
+            channels: ["inapp", "push", "email"],
+            dailyDigestTime: "08:00",
+            maxPageSize: 100,
+            maxDueBatch: 100,
+            maxAttempts: 5,
+            retryBaseMs: 1000,
+            retryCapMs: 3_600_000,
+        },
+    };
+    static layerMemory = (options) => this.layer(options).pipe(Layer.provide(memoryNotificationStore()));
+    static layerPostgres = (options) => this.layer(options).pipe(Layer.provide(postgresNotificationStore));
+}