@voyantjs/notifications-react 0.6.8

package/dist/hooks/use-notification-template-tools.d.ts

@@ -0,0 +1,80 @@
+import type { previewNotificationTemplateSchema, sendNotificationSchema } from "@voyantjs/notifications";
+import type { z } from "zod";
+export type PreviewNotificationTemplateInput = z.input<typeof previewNotificationTemplateSchema>;
+export type SendNotificationInput = z.input<typeof sendNotificationSchema>;
+export declare function useNotificationTemplateTools(): {
+    preview: import("@tanstack/react-query").UseMutationResult<{
+        channel: "email" | "sms";
+        provider: string | null;
+        fromAddress: string | null;
+        subject: string | null;
+        html: string | null;
+        text: string | null;
+    }, Error, {
+        channel: "email" | "sms";
+        provider?: string | null | undefined;
+        subjectTemplate?: string | null | undefined;
+        htmlTemplate?: string | null | undefined;
+        textTemplate?: string | null | undefined;
+        fromAddress?: string | null | undefined;
+        data?: Record<string, unknown> | null | undefined;
+    }, unknown>;
+    testSend: import("@tanstack/react-query").UseMutationResult<{
+        id: string;
+        templateId: string | null;
+        templateSlug: string | null;
+        targetType: "booking_payment_schedule" | "invoice" | "booking" | "booking_guarantee" | "payment_session" | "person" | "organization" | "other";
+        targetId: string | null;
+        personId: string | null;
+        organizationId: string | null;
+        bookingId: string | null;
+        invoiceId: string | null;
+        paymentSessionId: string | null;
+        channel: "email" | "sms";
+        provider: string;
+        providerMessageId: string | null;
+        status: "pending" | "sent" | "failed" | "cancelled";
+        toAddress: string;
+        fromAddress: string | null;
+        subject: string | null;
+        htmlBody: string | null;
+        textBody: string | null;
+        payloadData: Record<string, unknown> | null;
+        metadata: Record<string, unknown> | null;
+        errorMessage: string | null;
+        scheduledFor: string | null;
+        sentAt: string | null;
+        failedAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+    }, Error, {
+        to: string;
+        templateId?: string | null | undefined;
+        templateSlug?: string | null | undefined;
+        channel?: "email" | "sms" | undefined;
+        provider?: string | null | undefined;
+        from?: string | null | undefined;
+        subject?: string | null | undefined;
+        html?: string | null | undefined;
+        text?: string | null | undefined;
+        attachments?: {
+            filename: string;
+            contentBase64?: string | null | undefined;
+            path?: string | null | undefined;
+            contentType?: string | null | undefined;
+            disposition?: "attachment" | "inline" | null | undefined;
+            contentId?: string | null | undefined;
+        }[] | null | undefined;
+        data?: Record<string, unknown> | null | undefined;
+        targetType?: "booking_payment_schedule" | "invoice" | "booking" | "booking_guarantee" | "payment_session" | "person" | "organization" | "other" | undefined;
+        targetId?: string | null | undefined;
+        bookingId?: string | null | undefined;
+        invoiceId?: string | null | undefined;
+        paymentSessionId?: string | null | undefined;
+        personId?: string | null | undefined;
+        organizationId?: string | null | undefined;
+        metadata?: Record<string, unknown> | null | undefined;
+        scheduledFor?: string | null | undefined;
+    }, unknown>;
+};
+//# sourceMappingURL=use-notification-template-tools.d.ts.map

package/dist/hooks/use-notification-template-tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-notification-template-tools.d.ts","sourceRoot":"","sources":["../../src/hooks/use-notification-template-tools.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iCAAiC,EACjC,sBAAsB,EACvB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAS5B,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAChG,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE1E,wBAAgB,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4B3C"}

package/dist/hooks/use-notification-template-tools.js

@@ -0,0 +1,21 @@
+"use client";
+import { useMutation } from "@tanstack/react-query";
+import { fetchWithValidation } from "../client.js";
+import { useVoyantNotificationsContext } from "../provider.js";
+import { notificationDeliverySingleResponse, notificationTemplatePreviewResponse, } from "../schemas.js";
+export function useNotificationTemplateTools() {
+    const { baseUrl, fetcher } = useVoyantNotificationsContext();
+    const preview = useMutation({
+        mutationFn: async (input) => {
+            const { data } = await fetchWithValidation("/v1/admin/notifications/preview", notificationTemplatePreviewResponse, { baseUrl, fetcher }, { method: "POST", body: JSON.stringify(input) });
+            return data;
+        },
+    });
+    const testSend = useMutation({
+        mutationFn: async (input) => {
+            const { data } = await fetchWithValidation("/v1/admin/notifications/send", notificationDeliverySingleResponse, { baseUrl, fetcher }, { method: "POST", body: JSON.stringify(input) });
+            return data;
+        },
+    });
+    return { preview, testSend };
+}

package/dist/hooks/use-notification-template.d.ts

@@ -0,0 +1,20 @@
+export interface UseNotificationTemplateOptions {
+    enabled?: boolean;
+}
+export declare function useNotificationTemplate(id: string, options?: UseNotificationTemplateOptions): import("@tanstack/react-query").UseQueryResult<{
+    id: string;
+    slug: string;
+    name: string;
+    channel: "email" | "sms";
+    provider: string | null;
+    status: "draft" | "active" | "archived";
+    subjectTemplate: string | null;
+    htmlTemplate: string | null;
+    textTemplate: string | null;
+    fromAddress: string | null;
+    isSystem: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}, Error>;
+//# sourceMappingURL=use-notification-template.d.ts.map

package/dist/hooks/use-notification-template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-notification-template.d.ts","sourceRoot":"","sources":["../../src/hooks/use-notification-template.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,8BAA8B;IAC7C,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC;;;;;;;;;;;;;;;UAO/F"}

package/dist/hooks/use-notification-template.js

@@ -0,0 +1,12 @@
+"use client";
+import { useQuery } from "@tanstack/react-query";
+import { useVoyantNotificationsContext } from "../provider.js";
+import { getNotificationTemplateQueryOptions } from "../query-options.js";
+export function useNotificationTemplate(id, options = {}) {
+    const { baseUrl, fetcher } = useVoyantNotificationsContext();
+    const { enabled = true } = options;
+    return useQuery({
+        ...getNotificationTemplateQueryOptions({ baseUrl, fetcher }, id, options),
+        enabled: enabled && Boolean(id),
+    });
+}

package/dist/hooks/use-notification-templates.d.ts

@@ -0,0 +1,26 @@
+import type { NotificationTemplatesListFilters } from "../query-keys.js";
+export interface UseNotificationTemplatesOptions extends NotificationTemplatesListFilters {
+    enabled?: boolean;
+}
+export declare function useNotificationTemplates(options?: UseNotificationTemplatesOptions): import("@tanstack/react-query").UseQueryResult<{
+    data: {
+        id: string;
+        slug: string;
+        name: string;
+        channel: "email" | "sms";
+        provider: string | null;
+        status: "draft" | "active" | "archived";
+        subjectTemplate: string | null;
+        htmlTemplate: string | null;
+        textTemplate: string | null;
+        fromAddress: string | null;
+        isSystem: boolean;
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+    total: number;
+    limit: number;
+    offset: number;
+}, Error>;
+//# sourceMappingURL=use-notification-templates.d.ts.map

package/dist/hooks/use-notification-templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-notification-templates.d.ts","sourceRoot":"","sources":["../../src/hooks/use-notification-templates.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,kBAAkB,CAAA;AAGxE,MAAM,WAAW,+BAAgC,SAAQ,gCAAgC;IACvF,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,wBAAgB,wBAAwB,CAAC,OAAO,GAAE,+BAAoC;;;;;;;;;;;;;;;;;;;;UAOrF"}

package/dist/hooks/use-notification-templates.js

@@ -0,0 +1,12 @@
+"use client";
+import { useQuery } from "@tanstack/react-query";
+import { useVoyantNotificationsContext } from "../provider.js";
+import { getNotificationTemplatesQueryOptions } from "../query-options.js";
+export function useNotificationTemplates(options = {}) {
+    const { baseUrl, fetcher } = useVoyantNotificationsContext();
+    const { enabled = true, ...filters } = options;
+    return useQuery({
+        ...getNotificationTemplatesQueryOptions({ baseUrl, fetcher }, filters),
+        enabled,
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { defaultFetcher, fetchWithValidation, VoyantApiError, type VoyantFetcher, } from "./client.js";
+export * from "./hooks/index.js";
+export { useVoyantNotificationsContext, type VoyantNotificationsContextValue, VoyantNotificationsProvider, type VoyantNotificationsProviderProps, } from "./provider.js";
+export { notificationsQueryKeys } from "./query-keys.js";
+export { getNotificationDeliveriesQueryOptions, getNotificationDeliveryQueryOptions, getNotificationReminderRuleQueryOptions, getNotificationReminderRulesQueryOptions, getNotificationReminderRunQueryOptions, getNotificationReminderRunsQueryOptions, getNotificationTemplateQueryOptions, getNotificationTemplatesQueryOptions, } from "./query-options.js";
+export * from "./schemas.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,KAAK,aAAa,GACnB,MAAM,aAAa,CAAA;AACpB,cAAc,kBAAkB,CAAA;AAChC,OAAO,EACL,6BAA6B,EAC7B,KAAK,+BAA+B,EACpC,2BAA2B,EAC3B,KAAK,gCAAgC,GACtC,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,uCAAuC,EACvC,wCAAwC,EACxC,sCAAsC,EACtC,uCAAuC,EACvC,mCAAmC,EACnC,oCAAoC,GACrC,MAAM,oBAAoB,CAAA;AAC3B,cAAc,cAAc,CAAA"}

package/dist/index.js

@@ -0,0 +1,6 @@
+export { defaultFetcher, fetchWithValidation, VoyantApiError, } from "./client.js";
+export * from "./hooks/index.js";
+export { useVoyantNotificationsContext, VoyantNotificationsProvider, } from "./provider.js";
+export { notificationsQueryKeys } from "./query-keys.js";
+export { getNotificationDeliveriesQueryOptions, getNotificationDeliveryQueryOptions, getNotificationReminderRuleQueryOptions, getNotificationReminderRulesQueryOptions, getNotificationReminderRunQueryOptions, getNotificationReminderRunsQueryOptions, getNotificationTemplateQueryOptions, getNotificationTemplatesQueryOptions, } from "./query-options.js";
+export * from "./schemas.js";

package/dist/provider.d.ts

@@ -0,0 +1,2 @@
+export { useVoyantReactContext as useVoyantNotificationsContext, type VoyantReactContextValue as VoyantNotificationsContextValue, VoyantReactProvider as VoyantNotificationsProvider, type VoyantReactProviderProps as VoyantNotificationsProviderProps, } from "@voyantjs/react";
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,IAAI,6BAA6B,EACtD,KAAK,uBAAuB,IAAI,+BAA+B,EAC/D,mBAAmB,IAAI,2BAA2B,EAClD,KAAK,wBAAwB,IAAI,gCAAgC,GAClE,MAAM,iBAAiB,CAAA"}

package/dist/provider.js

@@ -0,0 +1 @@
+export { useVoyantReactContext as useVoyantNotificationsContext, VoyantReactProvider as VoyantNotificationsProvider, } from "@voyantjs/react";

package/dist/query-keys.d.ts

@@ -0,0 +1,63 @@
+export interface NotificationTemplatesListFilters {
+    search?: string | undefined;
+    channel?: "email" | "sms" | undefined;
+    provider?: string | undefined;
+    status?: "draft" | "active" | "archived" | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+}
+export interface NotificationReminderRulesListFilters {
+    search?: string | undefined;
+    targetType?: "booking_payment_schedule" | "invoice" | undefined;
+    channel?: "email" | "sms" | undefined;
+    status?: "draft" | "active" | "archived" | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+}
+export interface NotificationDeliveriesListFilters {
+    channel?: "email" | "sms" | undefined;
+    provider?: string | undefined;
+    status?: "pending" | "sent" | "failed" | "cancelled" | undefined;
+    templateSlug?: string | undefined;
+    targetType?: "booking" | "booking_payment_schedule" | "booking_guarantee" | "invoice" | "payment_session" | "person" | "organization" | "other" | undefined;
+    targetId?: string | undefined;
+    bookingId?: string | undefined;
+    invoiceId?: string | undefined;
+    paymentSessionId?: string | undefined;
+    personId?: string | undefined;
+    organizationId?: string | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+}
+export interface NotificationReminderRunsListFilters {
+    reminderRuleId?: string | undefined;
+    targetType?: "booking_payment_schedule" | "invoice" | undefined;
+    targetId?: string | undefined;
+    scheduleId?: string | undefined;
+    invoiceId?: string | undefined;
+    bookingId?: string | undefined;
+    paymentSessionId?: string | undefined;
+    notificationDeliveryId?: string | undefined;
+    personId?: string | undefined;
+    organizationId?: string | undefined;
+    recipient?: string | undefined;
+    status?: "queued" | "processing" | "sent" | "skipped" | "failed" | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+}
+export declare const notificationsQueryKeys: {
+    all: readonly ["notifications"];
+    templates: () => readonly ["notifications", "templates"];
+    templatesList: (filters: NotificationTemplatesListFilters) => readonly ["notifications", "templates", NotificationTemplatesListFilters];
+    template: (id: string) => readonly ["notifications", "templates", string];
+    deliveries: () => readonly ["notifications", "deliveries"];
+    deliveriesList: (filters: NotificationDeliveriesListFilters) => readonly ["notifications", "deliveries", NotificationDeliveriesListFilters];
+    delivery: (id: string) => readonly ["notifications", "deliveries", string];
+    reminderRules: () => readonly ["notifications", "reminder-rules"];
+    reminderRulesList: (filters: NotificationReminderRulesListFilters) => readonly ["notifications", "reminder-rules", NotificationReminderRulesListFilters];
+    reminderRule: (id: string) => readonly ["notifications", "reminder-rules", string];
+    reminderRuns: () => readonly ["notifications", "reminder-runs"];
+    reminderRunsList: (filters: NotificationReminderRunsListFilters) => readonly ["notifications", "reminder-runs", NotificationReminderRunsListFilters];
+    reminderRun: (id: string) => readonly ["notifications", "reminder-runs", string];
+};
+//# sourceMappingURL=query-keys.d.ts.map

package/dist/query-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-keys.d.ts","sourceRoot":"","sources":["../src/query-keys.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gCAAgC;IAC/C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAA;IACpD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,oCAAoC;IACnD,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,UAAU,CAAC,EAAE,0BAA0B,GAAG,SAAS,GAAG,SAAS,CAAA;IAC/D,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAA;IACrC,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAA;IACpD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,iCAAiC;IAChD,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAA;IAChE,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,UAAU,CAAC,EACP,SAAS,GACT,0BAA0B,GAC1B,mBAAmB,GACnB,SAAS,GACT,iBAAiB,GACjB,QAAQ,GACR,cAAc,GACd,OAAO,GACP,SAAS,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,mCAAmC;IAClD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,UAAU,CAAC,EAAE,0BAA0B,GAAG,SAAS,GAAG,SAAS,CAAA;IAC/D,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,sBAAsB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAA;IAC5E,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,eAAO,MAAM,sBAAsB;;;6BAGR,gCAAgC;mBAE1C,MAAM;;8BAEK,iCAAiC;mBAE5C,MAAM;;iCAEQ,oCAAoC;uBAE9C,MAAM;;gCAEG,mCAAmC;sBAE7C,MAAM;CACzB,CAAA"}

package/dist/query-keys.js

@@ -0,0 +1,15 @@
+export const notificationsQueryKeys = {
+    all: ["notifications"],
+    templates: () => [...notificationsQueryKeys.all, "templates"],
+    templatesList: (filters) => [...notificationsQueryKeys.templates(), filters],
+    template: (id) => [...notificationsQueryKeys.templates(), id],
+    deliveries: () => [...notificationsQueryKeys.all, "deliveries"],
+    deliveriesList: (filters) => [...notificationsQueryKeys.deliveries(), filters],
+    delivery: (id) => [...notificationsQueryKeys.deliveries(), id],
+    reminderRules: () => [...notificationsQueryKeys.all, "reminder-rules"],
+    reminderRulesList: (filters) => [...notificationsQueryKeys.reminderRules(), filters],
+    reminderRule: (id) => [...notificationsQueryKeys.reminderRules(), id],
+    reminderRuns: () => [...notificationsQueryKeys.all, "reminder-runs"],
+    reminderRunsList: (filters) => [...notificationsQueryKeys.reminderRuns(), filters],
+    reminderRun: (id) => [...notificationsQueryKeys.reminderRuns(), id],
+};