@iblai/data-layer 1.12.4 → 1.12.6

package/dist/src/features/notifications/custom-api-slice.d.ts

@@ -17,6 +17,23 @@ export declare const notificationsCustomApiSlice: import("@reduxjs/toolkit/query
         notificationType: string;
         allow_notification: boolean;
     }, import("@reduxjs/toolkit/query").BaseQueryFn<import("@data-layer/features/utils").CustomQueryArgs, unknown, import("@data-layer/features/utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, Partial<NotificationTemplateDetail>, "notificationsCustomApiSlice", unknown>;
+    /**
+     * Discards the platform-specific copy of the template and reverts to the
+     * platform default.
+     */
+    resetTemplate: import("@reduxjs/toolkit/query").MutationDefinition<{
+        platformKey: string;
+        notificationType: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<import("@data-layer/features/utils").CustomQueryArgs, unknown, import("@data-layer/features/utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, Partial<NotificationTemplateDetail>, "notificationsCustomApiSlice", unknown>;
+    /** Sends a one-off rendering of the template to `testEmail`. */
+    sendTestTemplateEmail: import("@reduxjs/toolkit/query").MutationDefinition<{
+        platformKey: string;
+        notificationType: string;
+        testEmail: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<import("@data-layer/features/utils").CustomQueryArgs, unknown, import("@data-layer/features/utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, {
+        status?: string;
+        detail?: string;
+    }, "notificationsCustomApiSlice", unknown>;
 }, "notificationsCustomApiSlice", string, typeof import("@reduxjs/toolkit/query").coreModuleName | typeof import("@reduxjs/toolkit/dist/query/react").reactHooksModuleName>;
 export declare const useGetTemplatesQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
@@ -993,4 +1010,378 @@ export declare const useGetTemplatesQuery: <R extends Record<string, any> = impo
         allow_notification: boolean;
     } | undefined;
     reset: () => void;
+}], useResetTemplateMutation: <R extends Record<string, any> = ({
+    requestId?: undefined;
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    data?: undefined;
+    error?: undefined;
+    endpointName?: string;
+    startedTimeStamp?: undefined;
+    fulfilledTimeStamp?: undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    isUninitialized: true;
+    isLoading: false;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+} & Omit<{
+    requestId: string;
+    data?: Partial<NotificationTemplateDetail> | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "data" | "fulfilledTimeStamp"> & Required<Pick<{
+    requestId: string;
+    data?: Partial<NotificationTemplateDetail> | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "data" | "fulfilledTimeStamp">> & {
+    error: undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: true;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+} & {
+    requestId: string;
+    data?: Partial<NotificationTemplateDetail> | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+} & {
+    data?: undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+    isUninitialized: false;
+    isLoading: true;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+} & Omit<{
+    requestId: string;
+    data?: Partial<NotificationTemplateDetail> | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "error"> & Required<Pick<{
+    requestId: string;
+    data?: Partial<NotificationTemplateDetail> | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "error">> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: false;
+    isError: true;
+})>(options?: {
+    selectFromResult?: ((state: ({
+        requestId?: undefined;
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        data?: undefined;
+        error?: undefined;
+        endpointName?: string;
+        startedTimeStamp?: undefined;
+        fulfilledTimeStamp?: undefined;
+    } & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        isUninitialized: true;
+        isLoading: false;
+        isSuccess: false;
+        isError: false;
+    }) | ({
+        status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+    } & Omit<{
+        requestId: string;
+        data?: Partial<NotificationTemplateDetail> | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "data" | "fulfilledTimeStamp"> & Required<Pick<{
+        requestId: string;
+        data?: Partial<NotificationTemplateDetail> | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "data" | "fulfilledTimeStamp">> & {
+        error: undefined;
+    } & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+        isUninitialized: false;
+        isLoading: false;
+        isSuccess: true;
+        isError: false;
+    }) | ({
+        status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+    } & {
+        requestId: string;
+        data?: Partial<NotificationTemplateDetail> | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    } & {
+        data?: undefined;
+    } & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+        isUninitialized: false;
+        isLoading: true;
+        isSuccess: false;
+        isError: false;
+    }) | ({
+        status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+    } & Omit<{
+        requestId: string;
+        data?: Partial<NotificationTemplateDetail> | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "error"> & Required<Pick<{
+        requestId: string;
+        data?: Partial<NotificationTemplateDetail> | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "error">> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+        isUninitialized: false;
+        isLoading: false;
+        isSuccess: false;
+        isError: true;
+    })) => R) | undefined;
+    fixedCacheKey?: string;
+} | undefined) => readonly [(arg: {
+    platformKey: string;
+    notificationType: string;
+}) => import("@reduxjs/toolkit/query").MutationActionCreatorResult<import("@reduxjs/toolkit/query").MutationDefinition<{
+    platformKey: string;
+    notificationType: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<import("@data-layer/features/utils").CustomQueryArgs, unknown, import("@data-layer/features/utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, Partial<NotificationTemplateDetail>, "notificationsCustomApiSlice", unknown>>, import("@reduxjs/toolkit/query").TSHelpersNoInfer<R> & {
+    originalArgs?: {
+        platformKey: string;
+        notificationType: string;
+    } | undefined;
+    reset: () => void;
+}], useSendTestTemplateEmailMutation: <R extends Record<string, any> = ({
+    requestId?: undefined;
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    data?: undefined;
+    error?: undefined;
+    endpointName?: string;
+    startedTimeStamp?: undefined;
+    fulfilledTimeStamp?: undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    isUninitialized: true;
+    isLoading: false;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+} & Omit<{
+    requestId: string;
+    data?: {
+        status?: string;
+        detail?: string;
+    } | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "data" | "fulfilledTimeStamp"> & Required<Pick<{
+    requestId: string;
+    data?: {
+        status?: string;
+        detail?: string;
+    } | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "data" | "fulfilledTimeStamp">> & {
+    error: undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: true;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+} & {
+    requestId: string;
+    data?: {
+        status?: string;
+        detail?: string;
+    } | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+} & {
+    data?: undefined;
+} & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+    isUninitialized: false;
+    isLoading: true;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+} & Omit<{
+    requestId: string;
+    data?: {
+        status?: string;
+        detail?: string;
+    } | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "error"> & Required<Pick<{
+    requestId: string;
+    data?: {
+        status?: string;
+        detail?: string;
+    } | undefined;
+    error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number;
+}, "error">> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: false;
+    isError: true;
+})>(options?: {
+    selectFromResult?: ((state: ({
+        requestId?: undefined;
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        data?: undefined;
+        error?: undefined;
+        endpointName?: string;
+        startedTimeStamp?: undefined;
+        fulfilledTimeStamp?: undefined;
+    } & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        isUninitialized: true;
+        isLoading: false;
+        isSuccess: false;
+        isError: false;
+    }) | ({
+        status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+    } & Omit<{
+        requestId: string;
+        data?: {
+            status?: string;
+            detail?: string;
+        } | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "data" | "fulfilledTimeStamp"> & Required<Pick<{
+        requestId: string;
+        data?: {
+            status?: string;
+            detail?: string;
+        } | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "data" | "fulfilledTimeStamp">> & {
+        error: undefined;
+    } & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
+        isUninitialized: false;
+        isLoading: false;
+        isSuccess: true;
+        isError: false;
+    }) | ({
+        status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+    } & {
+        requestId: string;
+        data?: {
+            status?: string;
+            detail?: string;
+        } | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    } & {
+        data?: undefined;
+    } & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.pending;
+        isUninitialized: false;
+        isLoading: true;
+        isSuccess: false;
+        isError: false;
+    }) | ({
+        status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+    } & Omit<{
+        requestId: string;
+        data?: {
+            status?: string;
+            detail?: string;
+        } | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "error"> & Required<Pick<{
+        requestId: string;
+        data?: {
+            status?: string;
+            detail?: string;
+        } | undefined;
+        error?: import("@data-layer/features/utils").ExtendedFetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+        endpointName: string;
+        startedTimeStamp: number;
+        fulfilledTimeStamp?: number;
+    }, "error">> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+        isUninitialized: false;
+        isLoading: false;
+        isSuccess: false;
+        isError: true;
+    })) => R) | undefined;
+    fixedCacheKey?: string;
+} | undefined) => readonly [(arg: {
+    platformKey: string;
+    notificationType: string;
+    testEmail: string;
+}) => import("@reduxjs/toolkit/query").MutationActionCreatorResult<import("@reduxjs/toolkit/query").MutationDefinition<{
+    platformKey: string;
+    notificationType: string;
+    testEmail: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<import("@data-layer/features/utils").CustomQueryArgs, unknown, import("@data-layer/features/utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, {
+    status?: string;
+    detail?: string;
+}, "notificationsCustomApiSlice", unknown>>, import("@reduxjs/toolkit/query").TSHelpersNoInfer<R> & {
+    originalArgs?: {
+        platformKey: string;
+        notificationType: string;
+        testEmail: string;
+    } | undefined;
+    reset: () => void;
 }];

package/dist/src/features/notifications/types.d.ts

@@ -1,3 +1,73 @@
+/** Notification type of the "User Progress Summary" template. */
+export declare const USER_PROGRESS_SUMMARY_TYPE = "COURSES_PROGRESS_SUMMARY";
+export type NotificationTemplateFrequency = 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'CUSTOM';
+/**
+ * Read-only `{ variable: description }` map returned by the template `GET`.
+ * Render it as the "variables you can insert" helper instead of hardcoding a
+ * list — the API stays authoritative as available variables change.
+ *
+ * Some deployments serialize it as a JSON string, hence the union.
+ */
+export type NotificationTemplateContext = Record<string, string> | string;
+export declare const USER_PROGRESS_DATA_POINTS: readonly ["courses_progressed", "courses_completed", "credentials_earned", "time_spent", "active_days", "mentors_accessed"];
+export type UserProgressDataPoint = (typeof USER_PROGRESS_DATA_POINTS)[number];
+export interface NotificationTemplateUserProgressSchedule {
+    frequency?: NotificationTemplateFrequency;
+    execution_time?: string;
+    timezone?: string;
+    /** Only honored when `frequency` is `CUSTOM`. */
+    custom_interval_days?: number;
+    /** Read-only scheduling telemetry. */
+    last_execution_date?: string | null;
+    next_execution_date?: string | null;
+    execution_history?: unknown[];
+}
+/** Nested read-back shape of the flat `user_progress_*` write fields. */
+export interface NotificationTemplateUserProgressConfig {
+    schedule?: NotificationTemplateUserProgressSchedule;
+    /** Reporting window in days — independent of the send cadence. */
+    lookback_days?: number;
+    enabled_data_points?: UserProgressDataPoint[];
+}
+/**
+ * Flat `user_progress_*` fields. Write these on `PATCH`; read them back nested
+ * under `user_progress_config`.
+ */
+export interface NotificationTemplateUserProgressSettings {
+    user_progress_frequency?: NotificationTemplateFrequency;
+    /** `"HH:MM"`, 24h. */
+    user_progress_execution_time?: string;
+    /** IANA name, e.g. `Europe/London`. */
+    user_progress_timezone?: string;
+    /** 1–365, only honored when the frequency is `CUSTOM`. */
+    user_progress_custom_interval_days?: number;
+    /** 1–365. */
+    user_progress_lookback_days?: number;
+    user_progress_enabled_data_points?: UserProgressDataPoint[];
+}
+/**
+ * Deprecated `courses_progress_*` aliases of the fields above.
+ *
+ * Still what deployed backends actually return (and, on older builds, the only
+ * prefix they accept), so reads must fall back to these and writes mirror onto
+ * them. `user_progress_*` wins when both are sent.
+ */
+export interface NotificationTemplateCoursesProgressSettings {
+    courses_progress_frequency?: NotificationTemplateFrequency;
+    courses_progress_execution_time?: string;
+    courses_progress_timezone?: string;
+    courses_progress_custom_interval_days?: number;
+    courses_progress_lookback_days?: number;
+    courses_progress_enabled_data_points?: UserProgressDataPoint[];
+}
+/**
+ * Free-form template metadata. Returned as an object by current backends and as
+ * a JSON string by older ones; it can carry its own copy of the progress config.
+ */
+export type NotificationTemplateMetadata = string | ({
+    courses_progress_config?: NotificationTemplateUserProgressConfig;
+    user_progress_config?: NotificationTemplateUserProgressConfig;
+} & Record<string, unknown>);
 export interface NotificationTemplatePeriodicSettings {
     periodic_learner_scope?: 'ALL_LEARNERS' | 'ACTIVE_LEARNERS';
     periodic_report_period_days?: number;
@@ -7,7 +77,7 @@ export interface NotificationTemplatePeriodicSettings {
     periodic_timezone?: string;
     periodic_mentors?: NotificationTemplatePeriodicMentor[];
 }
-export interface NotificationTemplate extends NotificationTemplatePeriodicSettings {
+export interface NotificationTemplate extends NotificationTemplatePeriodicSettings, NotificationTemplateUserProgressSettings, NotificationTemplateCoursesProgressSettings {
     id: string;
     type: string;
     name: string;
@@ -21,7 +91,9 @@ export interface NotificationTemplate extends NotificationTemplatePeriodicSettin
     email_html_template: string;
     spas: string;
     allowed_channels: string;
-    available_context: string;
+    available_context: NotificationTemplateContext;
+    /** e.g. `content:course`, `audience:user`, `audience:watcher`. */
+    tags?: string[];
 }
 export interface NotificationSpaDetail {
     id: number;
@@ -44,7 +116,7 @@ export interface NotificationTemplatePeriodicConfig {
     timezone?: string;
     mentors: NotificationTemplatePeriodicMentor[];
 }
-export interface NotificationTemplateDetail extends NotificationTemplatePeriodicSettings {
+export interface NotificationTemplateDetail extends NotificationTemplatePeriodicSettings, NotificationTemplateUserProgressSettings, NotificationTemplateCoursesProgressSettings {
     id: string;
     type: string;
     name: string;
@@ -60,10 +132,29 @@ export interface NotificationTemplateDetail extends NotificationTemplatePeriodic
     is_inherited: boolean;
     is_enabled: boolean;
     source_platform: string;
-    metadata: string;
-    available_context: string;
+    can_customize?: boolean;
+    metadata: NotificationTemplateMetadata;
+    available_context: NotificationTemplateContext;
+    /** e.g. `content:course`, `audience:user`, `audience:watcher`. */
+    tags?: string[];
     created_at: string;
     updated_at: string;
     periodic_config?: NotificationTemplatePeriodicConfig;
     proactive_prompt_message?: string;
+    /** Nested read-back of the flat `user_progress_*` write fields. */
+    user_progress_config?: NotificationTemplateUserProgressConfig;
+    /**
+     * Deprecated alias of `user_progress_config`, and currently the only one
+     * deployed backends populate — read it as a fallback.
+     */
+    courses_progress_config?: NotificationTemplateUserProgressConfig | null;
+    /** `null` until customized — watchers then fall back to `email_subject`. */
+    watcher_email_subject?: string | null;
+    /** `null` until customized — watchers then fall back to `email_html_template`. */
+    watcher_email_html_template?: string | null;
+    /**
+     * Learner context plus `learner_name`. `null` for notification types that
+     * have no watcher variant — hide the watcher editor in that case.
+     */
+    watcher_available_context?: NotificationTemplateContext | null;
 }