alepha 0.11.3 → 0.11.4

package/api/notifications.d.ts

@@ -1,264 +1 @@
-import * as _alepha_core1 from "alepha";
-import { Alepha, Descriptor, KIND, Static, StaticEncode, TObject } from "alepha";
-import * as _alepha_batch0 from "alepha/batch";
-import { DateTimeProvider } from "alepha/datetime";
-import * as _alepha_logger0 from "alepha/logger";
-import * as _alepha_postgres0 from "alepha/postgres";
-import * as _alepha_queue0 from "alepha/queue";
-import { EmailProvider } from "alepha/email";
-import * as typebox0 from "typebox";
-import * as dayjs0 from "dayjs";
-
-//#region src/controllers/NotificationController.d.ts
-declare class NotificationController {}
-//#endregion
-//#region src/entities/notifications.d.ts
-declare const notifications: _alepha_postgres0.EntityDescriptor<typebox0.TObject<{
-  id: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TString, typeof _alepha_postgres0.PG_PRIMARY_KEY>, typeof _alepha_postgres0.PG_DEFAULT>;
-  version: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TInteger, typeof _alepha_postgres0.PG_VERSION>, typeof _alepha_postgres0.PG_DEFAULT>;
-  createdAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_CREATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-  updatedAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_UPDATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-  type: typebox0.TUnsafe<"email" | "sms">;
-  template: typebox0.TString;
-  category: typebox0.TOptional<typebox0.TString>;
-  critical: typebox0.TOptional<typebox0.TBoolean>;
-  sensitive: typebox0.TOptional<typebox0.TBoolean>;
-  contact: typebox0.TString;
-  variables: typebox0.TOptional<typebox0.TRecord<"^.*$", typebox0.TAny>>;
-  scheduledAt: typebox0.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-  sentAt: typebox0.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-  error: typebox0.TOptional<typebox0.TObject<{
-    at: typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>;
-    name: typebox0.TString;
-    message: typebox0.TString;
-  }>>;
-}>>;
-type NotificationEntity = Static<typeof notifications.schema>;
-//#endregion
-//#region src/providers/SmsProvider.d.ts
-declare abstract class SmsProvider {
-  abstract send(options: SmsSendOptions): Promise<void>;
-}
-interface SmsSendOptions {
-  to: string;
-  message: string;
-}
-//#endregion
-//#region src/services/NotificationSenderService.d.ts
-declare class NotificationSenderService {
-  protected readonly alepha: Alepha;
-  protected readonly log: _alepha_logger0.Logger;
-  protected readonly notificationRepository: _alepha_postgres0.RepositoryDescriptor<typebox0.TObject<{
-    id: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TString, typeof _alepha_postgres0.PG_PRIMARY_KEY>, typeof _alepha_postgres0.PG_DEFAULT>;
-    version: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TInteger, typeof _alepha_postgres0.PG_VERSION>, typeof _alepha_postgres0.PG_DEFAULT>;
-    createdAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_CREATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    updatedAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_UPDATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    type: typebox0.TUnsafe<"email" | "sms">;
-    template: typebox0.TString;
-    category: typebox0.TOptional<typebox0.TString>;
-    critical: typebox0.TOptional<typebox0.TBoolean>;
-    sensitive: typebox0.TOptional<typebox0.TBoolean>;
-    contact: typebox0.TString;
-    variables: typebox0.TOptional<typebox0.TRecord<"^.*$", typebox0.TAny>>;
-    scheduledAt: typebox0.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    sentAt: typebox0.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    error: typebox0.TOptional<typebox0.TObject<{
-      at: typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>;
-      name: typebox0.TString;
-      message: typebox0.TString;
-    }>>;
-  }>>;
-  protected readonly dateTimeProvider: DateTimeProvider;
-  protected readonly emailProvider: EmailProvider;
-  protected readonly smsProvider: SmsProvider;
-  send(notificationId: string | NotificationEntity): Promise<void>;
-  renderSms(notification: NotificationEntity): {
-    to: string;
-    message: string;
-  };
-  renderEmail(notification: NotificationEntity): {
-    to: string;
-    subject: string;
-    body: string;
-  };
-  protected load(notification: NotificationEntity): {
-    template: NotificationDescriptor<typebox0.TObject<typebox0.TProperties>>;
-    variables: Record<string, any>;
-    contact: string;
-  };
-}
-//#endregion
-//#region src/queues/NotificationQueues.d.ts
-declare class NotificationQueues {
-  protected readonly notificationSenderService: NotificationSenderService;
-  readonly processNotification: _alepha_queue0.QueueDescriptor<typebox0.TObject<{
-    notificationId: typebox0.TString;
-  }>>;
-}
-//#endregion
-//#region src/schemas/notificationCreateSchema.d.ts
-declare const notificationCreateSchema: typebox0.TObject<{
-  type: typebox0.TUnsafe<"email" | "sms">;
-  template: typebox0.TString;
-  contact: typebox0.TString;
-  variables: typebox0.TOptional<typebox0.TRecord<"^.*$", typebox0.TAny>>;
-}>;
-type NotificationCreate = Static<typeof notificationCreateSchema>;
-//#endregion
-//#region src/services/NotificationService.d.ts
-declare const envSchema: _alepha_core1.TObject<{
-  NOTIFICATION_IMMEDIATE: _alepha_core1.TOptional<_alepha_core1.TBoolean>;
-}>;
-declare module "alepha" {
-  interface Env extends Partial<Static<typeof envSchema>> {}
-}
-declare class NotificationService {
-  protected readonly alepha: Alepha;
-  protected readonly log: _alepha_logger0.Logger;
-  protected readonly env: {
-    NOTIFICATION_IMMEDIATE?: boolean | undefined;
-  };
-  protected readonly notificationRepository: _alepha_postgres0.RepositoryDescriptor<_alepha_core1.TObject<{
-    id: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TString, typeof _alepha_postgres0.PG_PRIMARY_KEY>, typeof _alepha_postgres0.PG_DEFAULT>;
-    version: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TInteger, typeof _alepha_postgres0.PG_VERSION>, typeof _alepha_postgres0.PG_DEFAULT>;
-    createdAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_CREATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    updatedAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_UPDATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    type: typebox0.TUnsafe<"email" | "sms">;
-    template: typebox0.TString;
-    category: _alepha_core1.TOptional<typebox0.TString>;
-    critical: _alepha_core1.TOptional<_alepha_core1.TBoolean>;
-    sensitive: _alepha_core1.TOptional<_alepha_core1.TBoolean>;
-    contact: typebox0.TString;
-    variables: _alepha_core1.TOptional<typebox0.TRecord<"^.*$", typebox0.TAny>>;
-    scheduledAt: _alepha_core1.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    sentAt: _alepha_core1.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    error: _alepha_core1.TOptional<_alepha_core1.TObject<{
-      at: typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>;
-      name: typebox0.TString;
-      message: typebox0.TString;
-    }>>;
-  }>>;
-  protected readonly dateTimeProvider: DateTimeProvider;
-  protected readonly notificationQueues: NotificationQueues;
-  protected readonly notificationSenderService: NotificationSenderService;
-  readonly notificationBatch: _alepha_batch0.BatchDescriptor<_alepha_core1.TObject<{
-    type: typebox0.TUnsafe<"email" | "sms">;
-    template: typebox0.TString;
-    contact: typebox0.TString;
-    variables: _alepha_core1.TOptional<typebox0.TRecord<"^.*$", typebox0.TAny>>;
-  }>, Promise<void>>;
-  findNotificationById(id: string): Promise<_alepha_postgres0.PgStatic<_alepha_core1.TObject<{
-    id: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TString, typeof _alepha_postgres0.PG_PRIMARY_KEY>, typeof _alepha_postgres0.PG_DEFAULT>;
-    version: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TInteger, typeof _alepha_postgres0.PG_VERSION>, typeof _alepha_postgres0.PG_DEFAULT>;
-    createdAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_CREATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    updatedAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_UPDATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    type: typebox0.TUnsafe<"email" | "sms">;
-    template: typebox0.TString;
-    category: _alepha_core1.TOptional<typebox0.TString>;
-    critical: _alepha_core1.TOptional<_alepha_core1.TBoolean>;
-    sensitive: _alepha_core1.TOptional<_alepha_core1.TBoolean>;
-    contact: typebox0.TString;
-    variables: _alepha_core1.TOptional<typebox0.TRecord<"^.*$", typebox0.TAny>>;
-    scheduledAt: _alepha_core1.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    sentAt: _alepha_core1.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    error: _alepha_core1.TOptional<_alepha_core1.TObject<{
-      at: typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>;
-      name: typebox0.TString;
-      message: typebox0.TString;
-    }>>;
-  }>, _alepha_postgres0.PgRelationMap<_alepha_core1.TObject<{
-    id: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TString, typeof _alepha_postgres0.PG_PRIMARY_KEY>, typeof _alepha_postgres0.PG_DEFAULT>;
-    version: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TInteger, typeof _alepha_postgres0.PG_VERSION>, typeof _alepha_postgres0.PG_DEFAULT>;
-    createdAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_CREATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    updatedAt: _alepha_postgres0.PgAttr<_alepha_postgres0.PgAttr<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>, typeof _alepha_postgres0.PG_UPDATED_AT>, typeof _alepha_postgres0.PG_DEFAULT>;
-    type: typebox0.TUnsafe<"email" | "sms">;
-    template: typebox0.TString;
-    category: _alepha_core1.TOptional<typebox0.TString>;
-    critical: _alepha_core1.TOptional<_alepha_core1.TBoolean>;
-    sensitive: _alepha_core1.TOptional<_alepha_core1.TBoolean>;
-    contact: typebox0.TString;
-    variables: _alepha_core1.TOptional<typebox0.TRecord<"^.*$", typebox0.TAny>>;
-    scheduledAt: _alepha_core1.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    sentAt: _alepha_core1.TOptional<typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>>;
-    error: _alepha_core1.TOptional<_alepha_core1.TObject<{
-      at: typebox0.TCodec<typebox0.TString, dayjs0.Dayjs>;
-      name: typebox0.TString;
-      message: typebox0.TString;
-    }>>;
-  }>>>>;
-  /**
-   * Create a new notification.
-   */
-  createNotification(entry: NotificationCreate, now?: boolean): Promise<void>;
-}
-//#endregion
-//#region src/descriptors/$notification.d.ts
-declare const $notification: {
-  <T extends TObject>(options: NotificationDescriptorOptions<T>): NotificationDescriptor<T>;
-  [KIND]: typeof NotificationDescriptor;
-};
-interface NotificationDescriptorOptions<T extends TObject> extends NotificationMessage<T> {
-  name?: string;
-  description?: string;
-  category?: string;
-  critical?: boolean;
-  sensitive?: boolean;
-  translations?: {
-    [lang: string]: NotificationMessage<T>;
-  };
-  schema: T;
-}
-declare class NotificationDescriptor<T extends TObject> extends Descriptor<NotificationDescriptorOptions<T>> {
-  protected readonly notificationService: NotificationService;
-  get name(): string;
-  push(options: NotificationPushOptions<T>): Promise<void>;
-  configure(options: Partial<NotificationDescriptorOptions<T>>): void;
-}
-interface NotificationPushOptions<T extends TObject> {
-  variables: StaticEncode<T>;
-  contact: string;
-}
-interface NotificationMessage<T extends TObject> {
-  email?: {
-    subject: string;
-    body: string | ((variables: Static<T>) => string);
-  };
-  sms?: {
-    message: string | ((variables: Static<T>) => string);
-  };
-}
-//#endregion
-//#region src/jobs/NotificationJobs.d.ts
-declare class NotificationJobs {}
-//#endregion
-//#region src/providers/MemorySmsProvider.d.ts
-interface SmsRecord {
-  to: string;
-  message: string;
-  sentAt: Date;
-}
-declare class MemorySmsProvider extends SmsProvider {
-  protected records: SmsRecord[];
-  send(options: SmsSendOptions): Promise<void>;
-}
-//#endregion
-//#region src/schemas/notificationContactPreferencesSchema.d.ts
-declare const notificationContactPreferencesSchema: typebox0.TObject<{
-  language: typebox0.TOptional<typebox0.TString>;
-  exclude: typebox0.TArray<typebox0.TString>;
-}>;
-type NotificationContactPreferences = Static<typeof notificationContactPreferencesSchema>;
-//#endregion
-//#region src/index.d.ts
-/**
- * Provides notification management API endpoints for Alepha applications.
- *
- * This module includes notification sending, retrieval, status tracking,
- * and user notification preferences management.
- *
- * @module alepha.api.notifications
- */
-declare const AlephaApiNotifications: _alepha_core1.Service<_alepha_core1.Module<{}>>;
-//#endregion
-export { $notification, AlephaApiNotifications, MemorySmsProvider, NotificationContactPreferences, NotificationController, NotificationCreate, NotificationDescriptor, NotificationDescriptorOptions, NotificationEntity, NotificationJobs, NotificationMessage, NotificationPushOptions, NotificationQueues, NotificationSenderService, NotificationService, SmsProvider, SmsRecord, SmsSendOptions, notificationContactPreferencesSchema, notificationCreateSchema, notifications };
-//# sourceMappingURL=index.d.ts.map
+export * from '@alepha/api-notifications';