@novu/api 2.6.6 → 3.11.2

package/types/enums.d.ts

@@ -1,12 +1,9 @@
-declare const __brand: unique symbol;
-export type Unrecognized<T> = T & {
-    [__brand]: "unrecognized";
-};
-export declare function catchUnrecognizedEnum<T>(value: T): Unrecognized<T>;
-type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-export type ClosedEnum<T> = T[keyof T];
-export type OpenEnum<T> = Prettify<T[keyof T]> | Unrecognized<T[keyof T] extends number ? number : string>;
-export {};
+import * as z from "zod/v3";
+import { Unrecognized } from "./unrecognized.js";
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> = T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> = T[keyof T] | Unrecognized<T[keyof T] extends number ? number : string>;
+export declare function inboundSchema<T extends Record<string, string>>(enumObj: T): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown>;
+export declare function inboundSchemaInt<T extends Record<string, number | string>>(enumObj: T): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown>;
+export declare function outboundSchema<T extends Record<string, string>>(_: T): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>>;
+export declare function outboundSchemaInt<T extends Record<string, number | string>>(_: T): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>>;
 //# sourceMappingURL=enums.d.ts.map

package/types/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../src/types/enums.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,OAAO,EAAE,OAAO,MAAM,CAAC;AACrC,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,CAAC,OAAO,CAAC,EAAE,cAAc,CAAA;CAAE,CAAC;AAEhE,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAElE;AAED,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AACjD,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AACvC,MAAM,MAAM,QAAQ,CAAC,CAAC,IAClB,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GACpB,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../src/types/enums.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAgB,MAAM,mBAAmB,CAAC;AAE/D,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,IACxE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AACb,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,IACpE,CAAC,CAAC,MAAM,CAAC,CAAC,GACV,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC;AAE9D,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5D,OAAO,EAAE,CAAC,GACT,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAM/C;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EACxE,OAAO,EAAE,CAAC,GACT,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAO/C;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7D,CAAC,EAAE,CAAC,GACH,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAE9C;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EACzE,CAAC,EAAE,CAAC,GACH,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAE9C"}

package/types/enums.js

@@ -2,9 +2,65 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.catchUnrecognizedEnum = catchUnrecognizedEnum;
-function catchUnrecognizedEnum(value) {
-    return value;
+exports.inboundSchema = inboundSchema;
+exports.inboundSchemaInt = inboundSchemaInt;
+exports.outboundSchema = outboundSchema;
+exports.outboundSchemaInt = outboundSchemaInt;
+const z = __importStar(require("zod/v3"));
+const unrecognized_js_1 = require("./unrecognized.js");
+function inboundSchema(enumObj) {
+    const options = Object.values(enumObj);
+    return z.union([
+        ...options.map(x => z.literal(x)),
+        z.string().transform(x => (0, unrecognized_js_1.unrecognized)(x)),
+    ]);
+}
+function inboundSchemaInt(enumObj) {
+    // For numeric enums, Object.values returns both numbers and string keys
+    const options = Object.values(enumObj).filter(v => typeof v === "number");
+    return z.union([
+        ...options.map(x => z.literal(x)),
+        z.number().int().transform(x => (0, unrecognized_js_1.unrecognized)(x)),
+    ]);
+}
+function outboundSchema(_) {
+    return z.string();
+}
+function outboundSchemaInt(_) {
+    return z.number().int();
 }
 //# sourceMappingURL=enums.js.map

package/types/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../src/types/enums.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAKH,sDAEC;AAFD,SAAgB,qBAAqB,CAAI,KAAQ;IAC/C,OAAO,KAAwB,CAAC;AAClC,CAAC"}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../src/types/enums.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWH,sCAQC;AAED,4CASC;AAED,wCAIC;AAED,8CAIC;AAxCD,0CAA4B;AAC5B,uDAA+D;AAQ/D,SAAgB,aAAa,CAC3B,OAAU;IAEV,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,CAAC,CAAC,KAAK,CAAC;QACb,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,8BAAY,EAAC,CAAC,CAAC,CAAC;KACpC,CAAC,CAAC;AACZ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,OAAU;IAEV,wEAAwE;IACxE,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC1E,OAAO,CAAC,CAAC,KAAK,CAAC;QACb,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,8BAAY,EAAC,CAAC,CAAC,CAAC;KAC1C,CAAC,CAAC;AACZ,CAAC;AAED,SAAgB,cAAc,CAC5B,CAAI;IAEJ,OAAO,CAAC,CAAC,MAAM,EAAS,CAAC;AAC3B,CAAC;AAED,SAAgB,iBAAiB,CAC/B,CAAI;IAEJ,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAS,CAAC;AACjC,CAAC"}

package/types/index.d.ts

@@ -1,8 +1,8 @@
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export { catchUnrecognizedEnum } from "./enums.js";
-export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
+export type { ClosedEnum, OpenEnum } from "./enums.js";
 export type { Result } from "./fp.js";
 export type { PageIterator, Paginator } from "./operations.js";
 export { createPageIterator } from "./operations.js";
 export { RFCDate } from "./rfcdate.js";
+export * from "./unrecognized.js";
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACvD,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,cAAc,mBAAmB,CAAC"}

package/types/index.js

@@ -2,15 +2,28 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RFCDate = exports.createPageIterator = exports.catchUnrecognizedEnum = exports.isBlobLike = exports.blobLikeSchema = void 0;
+exports.RFCDate = exports.createPageIterator = exports.isBlobLike = exports.blobLikeSchema = void 0;
 var blobs_js_1 = require("./blobs.js");
 Object.defineProperty(exports, "blobLikeSchema", { enumerable: true, get: function () { return blobs_js_1.blobLikeSchema; } });
 Object.defineProperty(exports, "isBlobLike", { enumerable: true, get: function () { return blobs_js_1.isBlobLike; } });
-var enums_js_1 = require("./enums.js");
-Object.defineProperty(exports, "catchUnrecognizedEnum", { enumerable: true, get: function () { return enums_js_1.catchUnrecognizedEnum; } });
 var operations_js_1 = require("./operations.js");
 Object.defineProperty(exports, "createPageIterator", { enumerable: true, get: function () { return operations_js_1.createPageIterator; } });
 var rfcdate_js_1 = require("./rfcdate.js");
 Object.defineProperty(exports, "RFCDate", { enumerable: true, get: function () { return rfcdate_js_1.RFCDate; } });
+__exportStar(require("./unrecognized.js"), exports);
 //# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,uCAAwD;AAA/C,0GAAA,cAAc,OAAA;AAAE,sGAAA,UAAU,OAAA;AACnC,uCAAmD;AAA1C,iHAAA,qBAAqB,OAAA;AAI9B,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,2CAAuC;AAA9B,qGAAA,OAAO,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAEH,uCAAwD;AAA/C,0GAAA,cAAc,OAAA;AAAE,sGAAA,UAAU,OAAA;AAInC,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,2CAAuC;AAA9B,qGAAA,OAAO,OAAA;AAChB,oDAAkC"}

package/types/unrecognized.d.ts

@@ -0,0 +1,16 @@
+declare const __brand: unique symbol;
+export type Unrecognized<T> = T & {
+    [__brand]: "unrecognized";
+};
+declare function unrecognized<T>(value: T): Unrecognized<T>;
+export declare function startCountingUnrecognized(): {
+    /**
+     * Ends counting and returns the delta.
+     * @param delta - If provided, only this amount is added to the parent counter
+     *   (used for nested unions where we only want to record the winning option's count).
+     *   If not provided, records all counts since start().
+     */
+    end: (delta?: number) => number;
+};
+export { unrecognized };
+//# sourceMappingURL=unrecognized.d.ts.map

package/types/unrecognized.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unrecognized.d.ts","sourceRoot":"","sources":["../src/types/unrecognized.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,OAAO,EAAE,OAAO,MAAM,CAAC;AACrC,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,CAAC,OAAO,CAAC,EAAE,cAAc,CAAA;CAAE,CAAC;AAEhE,iBAAS,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAGlD;AAID,wBAAgB,yBAAyB;IAIrC;;;;;OAKG;kBACW,MAAM;EAQvB;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/types/unrecognized.js

@@ -0,0 +1,34 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startCountingUnrecognized = startCountingUnrecognized;
+exports.unrecognized = unrecognized;
+function unrecognized(value) {
+    globalCount++;
+    return value;
+}
+let globalCount = 0;
+let refCount = 0;
+function startCountingUnrecognized() {
+    refCount++;
+    const start = globalCount;
+    return {
+        /**
+         * Ends counting and returns the delta.
+         * @param delta - If provided, only this amount is added to the parent counter
+         *   (used for nested unions where we only want to record the winning option's count).
+         *   If not provided, records all counts since start().
+         */
+        end: (delta) => {
+            const count = globalCount - start;
+            // Reset globalCount back to start, then add only the specified delta
+            globalCount = start + (delta ?? count);
+            if (--refCount === 0)
+                globalCount = 0;
+            return count;
+        },
+    };
+}
+//# sourceMappingURL=unrecognized.js.map

package/types/unrecognized.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unrecognized.js","sourceRoot":"","sources":["../src/types/unrecognized.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAYH,8DAkBC;AAEQ,oCAAY;AA3BrB,SAAS,YAAY,CAAI,KAAQ;IAC/B,WAAW,EAAE,CAAC;IACd,OAAO,KAAwB,CAAC;AAClC,CAAC;AAED,IAAI,WAAW,GAAG,CAAC,CAAC;AACpB,IAAI,QAAQ,GAAG,CAAC,CAAC;AACjB,SAAgB,yBAAyB;IACvC,QAAQ,EAAE,CAAC;IACX,MAAM,KAAK,GAAG,WAAW,CAAC;IAC1B,OAAO;QACL;;;;;WAKG;QACH,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;YACtB,MAAM,KAAK,GAAG,WAAW,GAAG,KAAK,CAAC;YAClC,qEAAqE;YACrE,WAAW,GAAG,KAAK,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,CAAC;YACvC,IAAI,EAAE,QAAQ,KAAK,CAAC;gBAAE,WAAW,GAAG,CAAC,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC"}

package/REACT_QUERY.md

@@ -1,354 +0,0 @@
-# React hooks
-
-This SDK provides React hooks and utilies for making queries and mutations that
-can take the pain out of building front-end applications for the web or React
-Native.
-
-They are built as a thin wrapper around [TanStack Query for React v5][rq], a
-powerful, asynchronous state management library. A good understanding of that
-library will be very helpful while using them. In addition to hooks, there are
-several helper functions that can be used for cache management and data fetching
-during server-rendering and in React Server Components.
-
-## Getting started
-
-To get started using React hooks, you will need to inject TanStack query and an
-SDK instance into your application. Typically, this will be done high up in
-your React app at the root or layout component. For example:
-
-```tsx
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-import { NovuCore } from "@novu/api";
-import { NovuProvider } from "@novu/api/react-query";
-
-const queryClient = new QueryClient();
-const novu = new NovuCore({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
-});
-
-// Retries are handled by the underlying SDK.
-queryClient.setQueryDefaults(["@novu/api"], { retry: false });
-queryClient.setMutationDefaults(["@novu/api"], { retry: false });
-
-export function App() {
-  return (
-    <QueryClientProvider client={queryClient}>
-      <NovuProvider client={novu}> 
-        {/* Your app logic starts here */}
-      </NovuProvider>
-    </QueryClientProvider>
-  );
-}
-```
-
-## Queries
-
-Query hooks are the basic building block for fetching data. In addition to
-request data, they take the same options as the [`useQuery` hook][use-query]
-from TanStack Query.
-
-[use-query]: https://tanstack.com/query/v5/docs/framework/react/reference/useQuery
-
-```tsx
-import { useNotificationsList } from "@novu/api/react-query/notificationsList.js";
-
-export function Example() {
-  const { data, error, status } = useNotificationsList({});
-
-  // Render the UI here...
-}
-``` 
-
-### Query timeouts and retries
-
-Since the underlying SDK handles request timeouts and retries, there are a few
-more options provided by the query hooks to control these behaviors.
-
-```tsx
-import { useState } from "react";
-import { useNotificationsList } from "@novu/api/react-query/notificationsList.js";
-
-export function ExampleWithOptions() {
-  const [enabled, setEnabled] = useState(true);
-  const { data, error, status } = useNotificationsList(
-    {},
-    {
-      // TanStack Query options:
-      enabled,
-      staleTime: 60 * 1000, // 1 minute
-      gcTime: 5 * 60 * 1000, // 5 minutes
-
-      // Request options for the underlying API call:
-      timeoutMs: 1000,
-      retryCodes: ["5XX"],
-      retries: {
-        strategy: "backoff",
-        backoff: {
-          initialInterval: 500,
-          maxInterval: 10 * 1000, // 10 seconds
-          exponent: 1.5,
-          maxElapsedTime: 60 * 1000, // 1 minute
-        },
-      },
-    }
-  );
-
-  // Render the UI here...
-}
-```
-
-
-## Mutations
-
-Operations that can have side-effects in this SDK are exposed as mutation hooks.
-These can be integrated into HTML forms to submit data to the API. They also
-take the same options as the [`useMutation` hook][use-mutation] from TanStack
-Query.
-
-[use-mutation]: https://tanstack.com/query/v5/docs/framework/react/reference/useMutation
-
-```tsx
-import { useTriggerMutation } from "@novu/api/react-query/trigger.js";
-
-export function Example() {
-  const { mutate, status } = useTriggerMutation();
-
-  return (
-    <form
-      onSubmit={(e) => {
-        e.preventDefault();
-
-        // Read form data here...
-
-        mutate({
-          workflowId: "workflow_identifier",
-          payload: {
-            "comment_id": "string",
-            "post": {
-              "text": "string",
-            },
-          },
-          overrides: {
-            "fcm": {
-              "data": {
-                "key": "value",
-              },
-            },
-          },
-          to: {
-            subscriberId: "<id>",
-          },
-        });
-      }}
-    >
-      {/* Form fields go here... */} 
-      <button type="submit" disabled={status === "pending"}>Submit</button>
-    </form>
-  );
-}
-``` 
-
-### Mutation timeouts and retries
-
-Since the underlying SDK handles request timeouts and retries, there are a few
-more options provided by the mutation hooks to control these behaviors.
-
-```tsx
-import { useTriggerMutation } from "@novu/api/react-query/trigger.js";
-
-export function ExampleWithOptions() {
-  const { mutate, status } = useTriggerMutation({
-    // TanStack Query options:
-    networkMode: "online",
-    gcTime: 5 * 60 * 1000, // 5 minutes
-
-    // Request options for the underlying API call:
-    timeoutMs: 1000,
-    retryCodes: ["5XX"],
-    retries: {
-      strategy: "backoff",
-      backoff: {
-        initialInterval: 500,
-        maxInterval: 10 * 1000, // 10 seconds
-        exponent: 1.5,
-        maxElapsedTime: 60 * 1000, // 1 minute
-      },
-    },
-  });
-
-  // Render the UI here...
-}
-```
-
-
-## Cache invalidation
-
-In many instances, triggering a mutation hook requires invalidating specific
-query data currently residing in the TanStack Query's cache. Alongside every
-query hook there are two functions that help invalidate cached data:
-
-```tsx
-import { useQueryClient } from "@tanstack/react-query";
-import { invalidateNotificationsList, invalidateAllNotificationsList } from "@novu/api/react-query/notificationsList.js";
-// Replace this with a real mutation
-import { useExampleMutation } from "@novu/api/react-query/example.js";
-
-export function Example() {
-  const { queryClient } = useQueryClient();
-  const { mutate, status } = useExampleMutation();
-
-  return (
-    <form
-      onSubmit={(e) => {
-        e.preventDefault();
-
-        const formData = new FormData(e.target);
-
-        mutate(formData, {
-          onSuccess: () => {
-            // Invalidate a single cache entry:
-            invalidateNotificationsList(queryClient, /* ... arguments ... */);
-            // OR, invalidate all cache entries for the query targets:
-            invalidateAllNotificationsList(queryClient);
-          },
-        });
-      }}
-    >
-      {/* Form fields go here... */} 
-
-      <button type="submit" disabled={status === "pending"}>Submit</button>
-    </form>
-  );
-}
-```
-
-
-## Pagination
-
-Certain queries may have pagination enabled if the underlying API supports it.
-In these cases, additional "infinite" query hooks are exposed to help build
-infinite scrolling and "load more" user interfaces.
-
-> [!NOTE]
->
-> The original query hooks will still be available and if you are building a
-> more explicit pagination UI with page numbers and next/previous buttons then
-> those hooks may be more suitable.
-
-```tsx
-import { useSubscribersListInfinite } from "@novu/api/react-query/subscribersList.js";
-
-export function Example() {
-  const { data, error, status, fetchNextPage, hasNextPage } = useSubscribersListInfinite();
-
-  return (
-    <div>
-      {/* Render pages here... */}
-
-      {hasNextPage ? (
-        <div>
-          <button onClick={() => fetchNextPage()}>Load more</button>
-        </div>
-      ) : null}
-    </div>
-  );
-}
-```
-
-
-## Integration with React Suspense
-
-TanStack Query predates React Suspense and out of the box it does a great job at
-exposing the lifecycle of asynchronous tasks. However, if you are already using
-Suspense in your app, the default hooks will not trigger suspense boundaries.
-This is why the library and, by extension, this SDK also provide equivalent
-hooks that integrate neatly with React Suspense.
-
-```tsx
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-import { ErrorBoundary } from "react-error-boundary";
-
-import { NovuCore } from "@novu/api";
-import { NovuProvider } from "@novu/api/react-query";
-import { useNotificationsListSuspense } from "@novu/api/react-query/notificationsList.js";
-
-const queryClient = new QueryClient();
-const novu = new NovuCore({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
-});
-
-export function App() {
-  return (
-    <QueryClientProvider client={queryClient}>
-      <NovuProvider client={novu}> 
-        <QueryErrorResetBoundary>
-          {({ reset }) => (
-            <ErrorBoundary
-              fallbackRender={({ error, resetErrorBoundary }) => (
-                <div>
-                  There was an error!{' '}
-                  <Button onClick={() => resetErrorBoundary()}>Try again</Button>
-                  <pre>{error.message}</pre>
-                </div>
-              )}
-              onReset={reset}
-            >
-              <React.Suspense fallback={<h1>Loading...</h1>}>
-                <Example />
-              </React.Suspense>
-            </ErrorBoundary>
-          )}
-        </QueryErrorResetBoundary>
-      </NovuProvider>
-    </QueryClientProvider>
-  );
-}
-
-function Example() {
-  const { data } = useNotificationsListSuspense({});
-
-  // Render the UI here...
-}
-```
-
-
-## Server-rendering and React Server Components
-
-Query hooks are also side-loaded with prefetch helper functions. These functions
-can be used to fetch data from the API during server-rendering and in React
-Server Components so that it can be available immediately on page load to any
-components that use the corresponding hooks:
-```tsx
-import {
-  dehydrate,
-  HydrationBoundary,
-  QueryClient,
-} from "@tanstack/react-query";
-import { NovuCore } from "@novu/api";
-import { prefetchNotificationsList } from "@novu/api/react-query/notificationsList.js";
-
-export default async function Page() {
-  const queryClient = new QueryClient();
-  const novu = new NovuCore({
-    security: {
-      secretKey: "YOUR_SECRET_KEY_HERE",
-    },
-  });
-
-  await prefetchNotificationsList(queryClient, novu, {});
-
-  return (
-    // HydrationBoundary is a Client Component, so hydration will happen there.
-    <HydrationBoundary state={dehydrate(queryClient)}>
-      {/* Client components under this point will also have data on page load. */}
-    </HydrationBoundary>
-  );
-}
-```
-
-
-[rq]: https://tanstack.com/query/v5/docs/framework/react/overview