@novu/api 0.0.1-alpha.28 → 0.0.1-alpha.35

package/README.md

@@ -16,19 +16,23 @@ For more information about the API: [Novu Documentation](https://docs.novu.co)
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Pagination](#pagination)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [Retries](#retries)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
 
-* [SDK Installation](#sdk-installation)
-* [Requirements](#requirements)
-* [SDK Example Usage](#sdk-example-usage)
-* [Available Resources and Operations](#available-resources-and-operations)
-* [Standalone functions](#standalone-functions)
-* [Pagination](#pagination)
-* [Retries](#retries)
-* [Error Handling](#error-handling)
-* [Server Selection](#server-selection)
-* [Custom HTTP Client](#custom-http-client)
-* [Authentication](#authentication)
-* [Debugging](#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -132,10 +136,7 @@ async function run() {
       {
         name: "workflow_identifier",
         to: [
-          {
-            topicKey: "<value>",
-            type: "Topic",
-          },
+          "SUBSCRIBER_ID",
         ],
       },
       {

package/docs/sdks/novu/README.md

@@ -148,10 +148,7 @@ async function run() {
       {
         name: "workflow_identifier",
         to: [
-          {
-            topicKey: "<value>",
-            type: "Topic",
-          },
+          "SUBSCRIBER_ID",
         ],
       },
       {
@@ -209,10 +206,7 @@ async function run() {
       {
         name: "workflow_identifier",
         to: [
-          {
-            topicKey: "<value>",
-            type: "Topic",
-          },
+          "SUBSCRIBER_ID",
         ],
       },
       {

package/hooks/novu-custom-hook.d.ts

@@ -0,0 +1,6 @@
+import { AfterSuccessContext, AfterSuccessHook, BeforeRequestContext, BeforeRequestHook } from "./types";
+export declare class NovuCustomHook implements BeforeRequestHook, AfterSuccessHook {
+    beforeRequest(_hookCtx: BeforeRequestContext, request: Request): Request;
+    afterSuccess(_hookCtx: AfterSuccessContext, response: Response): Promise<Response>;
+}
+//# sourceMappingURL=novu-custom-hook.d.ts.map

package/hooks/novu-custom-hook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"novu-custom-hook.d.ts","sourceRoot":"","sources":["../src/hooks/novu-custom-hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,iBAAiB,EAAC,MAAM,SAAS,CAAC;AAEvG,qBAAa,cACT,YAAY,iBAAiB,EAAE,gBAAgB;IAE/C,aAAa,CAAC,QAAQ,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAclE,YAAY,CAAC,QAAQ,EAAE,mBAAmB,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;CAa3F"}

package/hooks/novu-custom-hook.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NovuCustomHook = void 0;
+class NovuCustomHook {
+    beforeRequest(_hookCtx, request) {
+        const authKey = 'authorization';
+        const hasAuthorization = request.headers.has(authKey);
+        const apiKeyPrefix = 'ApiKey';
+        if (hasAuthorization) {
+            const key = request.headers.get(authKey);
+            if (key && !key.includes(apiKeyPrefix)) {
+                request.headers.set(authKey, `${apiKeyPrefix} ${authKey}`);
+            }
+        }
+        return request;
+    }
+    async afterSuccess(_hookCtx, response) {
+        const jsonResponse = await response.json();
+        if (jsonResponse && Object.keys(jsonResponse).length === 1 && jsonResponse.data) {
+            return new Response(JSON.stringify(jsonResponse.data), {
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers,
+            }); // Return the new Response object
+        }
+        return response;
+    }
+}
+exports.NovuCustomHook = NovuCustomHook;
+//# sourceMappingURL=novu-custom-hook.js.map

package/hooks/novu-custom-hook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"novu-custom-hook.js","sourceRoot":"","sources":["../src/hooks/novu-custom-hook.ts"],"names":[],"mappings":";;;AAEA,MAAa,cAAc;IAGvB,aAAa,CAAC,QAA8B,EAAE,OAAgB;QAC1D,MAAM,OAAO,GAAG,eAAe,CAAC;QAChC,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,YAAY,GAAG,QAAQ,CAAC;QAC9B,IAAI,gBAAgB,EAAE,CAAC;YACnB,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAEzC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;gBACrC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAC,GAAG,YAAY,IAAI,OAAO,EAAE,CAAC,CAAA;YAC7D,CAAC;QACL,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,QAA6B,EAAE,QAAkB;QAChE,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAE3C,IAAI,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC;YAC9E,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;gBACnD,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC5B,CAAC,CAAC,CAAC,iCAAiC;QACzC,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AA9BD,wCA8BC"}

package/hooks/registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registration.d.ts","sourceRoot":"","sources":["../src/hooks/registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AASnC,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,QAIrC"}
+{"version":3,"file":"registration.d.ts","sourceRoot":"","sources":["../src/hooks/registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AASnC,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,QAGrC"}

package/hooks/registration.js

@@ -1,16 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initHooks = void 0;
+const novu_custom_hook_1 = require("./novu-custom-hook");
 /*
  * This file is only ever generated once on the first generation and then is free to be modified.
  * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them
  * in this file or in separate files in the hooks folder.
  */
-// @ts-expect-error remove this line when you add your first hook and hooks is used
 function initHooks(hooks) {
-    // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
-    // with an instance of a hook that implements that specific Hook interface
-    // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+    hooks.registerAfterSuccessHook(new novu_custom_hook_1.NovuCustomHook());
+    hooks.registerBeforeRequestHook(new novu_custom_hook_1.NovuCustomHook());
 }
 exports.initHooks = initHooks;
 //# sourceMappingURL=registration.js.map

package/hooks/registration.js.map

@@ -1 +1 @@
-{"version":3,"file":"registration.js","sourceRoot":"","sources":["../src/hooks/registration.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AAEH,mFAAmF;AACnF,SAAgB,SAAS,CAAC,KAAY;IACpC,gHAAgH;IAChH,0EAA0E;IAC1E,4FAA4F;AAC9F,CAAC;AAJD,8BAIC"}
+{"version":3,"file":"registration.js","sourceRoot":"","sources":["../src/hooks/registration.ts"],"names":[],"mappings":";;;AACA,yDAAkD;AAElD;;;;GAIG;AAEH,SAAgB,SAAS,CAAC,KAAY;IAClC,KAAK,CAAC,wBAAwB,CAAC,IAAI,iCAAc,EAAE,CAAC,CAAA;IACpD,KAAK,CAAC,yBAAyB,CAAC,IAAI,iCAAc,EAAE,CAAC,CAAA;AACzD,CAAC;AAHD,8BAGC"}

package/lib/config.d.ts

@@ -27,8 +27,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "1.0";
-    readonly sdkVersion: "0.0.1-alpha.28";
-    readonly genVersion: "2.463.0";
-    readonly userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.28 2.463.0 1.0 @novu/api";
+    readonly sdkVersion: "0.0.1-alpha.35";
+    readonly genVersion: "2.467.4";
+    readonly userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.35 2.467.4 1.0 @novu/api";
 };
 //# sourceMappingURL=config.d.ts.map

package/lib/config.js

@@ -30,8 +30,8 @@ exports.serverURLFromOptions = serverURLFromOptions;
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1.0",
-    sdkVersion: "0.0.1-alpha.28",
-    genVersion: "2.463.0",
-    userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.28 2.463.0 1.0 @novu/api",
+    sdkVersion: "0.0.1-alpha.35",
+    genVersion: "2.467.4",
+    userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.35 2.467.4 1.0 @novu/api",
 };
 //# sourceMappingURL=config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@novu/api",
-  "version": "0.0.1-alpha.28",
+  "version": "0.0.1-alpha.35",
   "author": "Novu",
   "main": "./index.js",
   "sideEffects": false,

package/src/hooks/novu-custom-hook.ts

@@ -0,0 +1,33 @@
+import {AfterSuccessContext, AfterSuccessHook, BeforeRequestContext, BeforeRequestHook} from "./types";
+
+export class NovuCustomHook
+    implements  BeforeRequestHook, AfterSuccessHook
+{
+    beforeRequest(_hookCtx: BeforeRequestContext, request: Request): Request {
+        const authKey = 'authorization';
+        const hasAuthorization = request.headers.has(authKey);
+        const apiKeyPrefix = 'ApiKey';
+        if (hasAuthorization) {
+            const key = request.headers.get(authKey);
+
+            if (key && !key.includes(apiKeyPrefix)) {
+                request.headers.set(authKey,`${apiKeyPrefix} ${authKey}`)
+            }
+        }
+        return request;
+    }
+
+    async afterSuccess(_hookCtx: AfterSuccessContext, response: Response): Promise<Response> {
+        const jsonResponse = await response.json();
+
+        if (jsonResponse && Object.keys(jsonResponse).length === 1 && jsonResponse.data) {
+            return new Response(JSON.stringify(jsonResponse.data), {
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers,
+            }); // Return the new Response object
+        }
+
+        return response;
+    }
+}

package/src/hooks/registration.ts

@@ -1,4 +1,5 @@
 import { Hooks } from "./types.js";
+import {NovuCustomHook} from "./novu-custom-hook";
 
 /*
  * This file is only ever generated once on the first generation and then is free to be modified.
@@ -6,9 +7,7 @@ import { Hooks } from "./types.js";
  * in this file or in separate files in the hooks folder.
  */
 
-// @ts-expect-error remove this line when you add your first hook and hooks is used
 export function initHooks(hooks: Hooks) {
-  // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
-  // with an instance of a hook that implements that specific Hook interface
-  // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+    hooks.registerAfterSuccessHook(new NovuCustomHook())
+    hooks.registerBeforeRequestHook(new NovuCustomHook())
 }

package/src/lib/config.ts

@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.0.1-alpha.28",
-  genVersion: "2.463.0",
-  userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.28 2.463.0 1.0 @novu/api",
+  sdkVersion: "0.0.1-alpha.35",
+  genVersion: "2.467.4",
+  userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.35 2.467.4 1.0 @novu/api",
 } as const;