@knocklabs/node 0.5.1 → 0.6.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.6.0
+
+### Major Changes
+
+- Add Vercel Edge runtime compatibility
+
+### Breaking Changes
+
+- `Knock.signUserToken` is now asynchronous and returns `Promise<string>` instead of `string`
+
 ## v0.4.18
 
-* Introduce "Idempotency-Key" header for workflow triggers
+- Introduce "Idempotency-Key" header for workflow triggers

package/README.md

@@ -1,6 +1,6 @@
 # Knock Node.js library
 
-Knock API access for applications written in server-side Javascript.
+Knock API access for applications written in server-side Javascript. This package is compatible with the Vercel Edge runtime.
 
 ## Documentation
 
@@ -148,7 +148,7 @@ const { Knock } = require("@knocklabs/node");
 // When signing user tokens, you do not need to instantiate a Knock client.
 
 // jhammond is the user id for which to sign this token
-const token = Knock.signUserToken("jhammond", {
+const token = await Knock.signUserToken("jhammond", {
   // The signing key from the Knock Dashboard in base-64 or PEM-encoded format.
   // If not provided, the key will be read from the KNOCK_SIGNING_KEY environment variable.
   signingKey: "S25vY2sga25vY2sh...",

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.5.1",
+    "version": "0.6.0",
     "description": "Library for interacting with the Knock API",
     "homepage": "https://github.com/knocklabs/knock-node",
     "author": "@knocklabs",
@@ -32,19 +32,16 @@
     },
     "devDependencies": {
         "@types/jest": "26.0.23",
-        "@types/jsonwebtoken": "^9.0.1",
         "@types/node": "^15.0.1",
         "@types/pluralize": "0.0.29",
-        "axios-mock-adapter": "^1.22.0",
         "jest": "26.6.3",
         "prettier": "2.2.1",
         "supertest": "6.1.3",
         "ts-jest": "26.5.5",
         "tslint": "6.1.3",
-        "typescript": "4.2.4"
+        "typescript": "^5.3.3"
     },
     "dependencies": {
-        "axios": "1.6",
-        "jsonwebtoken": "^9.0.0"
+        "jose": "^5.2.0"
     }
 }

package/dist/src/common/fetchClient.d.ts

@@ -0,0 +1,28 @@
+export interface FetchClientConfig {
+    baseURL?: string;
+    headers?: Record<string, string>;
+}
+export interface FetchRequestConfig<D = any> {
+    params?: Record<string, string>;
+    headers?: Record<string, string>;
+    body?: D;
+}
+export interface FetchResponse<T = any> extends Response {
+    data: T;
+}
+export declare class FetchResponseError extends Error {
+    readonly response: FetchResponse;
+    constructor(response: FetchResponse);
+}
+export default class FetchClient {
+    config: FetchClientConfig;
+    constructor(config?: FetchClientConfig);
+    get(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
+    post(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
+    put(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
+    delete(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
+    private request;
+    private buildUrl;
+    private prepareRequestBody;
+    private getResponseData;
+}

package/dist/src/common/fetchClient.js

@@ -0,0 +1,103 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchResponseError = void 0;
+class FetchResponseError extends Error {
+    constructor(response) {
+        super();
+        this.response = response;
+    }
+}
+exports.FetchResponseError = FetchResponseError;
+const defaultConfig = {
+    baseURL: "",
+    headers: {},
+};
+class FetchClient {
+    constructor(config) {
+        this.config = Object.assign(Object.assign({}, defaultConfig), config);
+    }
+    get(path, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request("GET", path, config);
+        });
+    }
+    post(path, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request("POST", path, config);
+        });
+    }
+    put(path, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request("PUT", path, config);
+        });
+    }
+    delete(path, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request("DELETE", path, config);
+        });
+    }
+    request(method, path, config = {}) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.buildUrl(path, config.params);
+            const headers = Object.assign(Object.assign({}, this.config.headers), ((_a = config.headers) !== null && _a !== void 0 ? _a : {}));
+            const response = yield fetch(url, {
+                method,
+                headers,
+                body: config.body ? this.prepareRequestBody(config.body) : undefined,
+            });
+            const data = yield this.getResponseData(response);
+            // Assign data to the response as other methods of returning the response
+            // like return { ...response, data } drop the response methods
+            const fetchResponse = Object.assign(response, {
+                data,
+            });
+            if (!response.ok) {
+                throw new FetchResponseError(fetchResponse);
+            }
+            return fetchResponse;
+        });
+    }
+    buildUrl(path, params) {
+        const url = new URL(this.config.baseURL + path);
+        if (params) {
+            Object.entries(params).forEach(([key, value]) => url.searchParams.append(key, value));
+        }
+        return url;
+    }
+    prepareRequestBody(data) {
+        if (typeof data === "string" || data instanceof FormData) {
+            return data;
+        }
+        return JSON.stringify(data);
+    }
+    getResponseData(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!response.body) {
+                return undefined;
+            }
+            let data;
+            const contentType = response.headers.get("content-type");
+            if (contentType && contentType.includes("application/json")) {
+                data = yield response.json();
+            }
+            else if (contentType && contentType.includes("text")) {
+                data = yield response.text();
+            }
+            else {
+                data = yield response.blob();
+            }
+            return data;
+        });
+    }
+}
+exports.default = FetchClient;

package/dist/src/common/interfaces.d.ts

@@ -18,15 +18,15 @@ export interface UnprocessableEntityError {
     type: string;
     field: string;
 }
-export declare type ChannelType = "email" | "in_app_feed" | "sms" | "push" | "chat" | "http";
-export declare type CommonMetadata = Record<string, any>;
+export type ChannelType = "email" | "in_app_feed" | "sms" | "push" | "chat" | "http";
+export type CommonMetadata = Record<string, any>;
 export interface ChannelData<T = CommonMetadata> {
     channel_id: string;
     data: T;
 }
 export interface SetChannelDataProperties {
 }
-declare type PageInfo = {
+type PageInfo = {
     before: string;
     after: string;
     page_size: number;

package/dist/src/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/dist/src/knock.d.ts

@@ -1,4 +1,3 @@
-import { AxiosResponse } from "axios";
 import { KnockOptions, PostAndPutOptions, SignUserTokenOptions, MethodOptions } from "./common/interfaces";
 import { Users } from "./resources/users";
 import { Workflows } from "./resources/workflows";
@@ -7,6 +6,7 @@ import { BulkOperations } from "./resources/bulk_operations";
 import { Objects } from "./resources/objects";
 import { Messages } from "./resources/messages";
 import { Tenants } from "./resources/tenants";
+import { FetchResponse } from "./common/fetchClient";
 declare class Knock {
     readonly key?: string | undefined;
     readonly options: KnockOptions;
@@ -26,13 +26,13 @@ declare class Knock {
      *
      * @param userId {string} The ID of the user that needs a token, e.g. the user viewing an in-app feed.
      * @param options Optionally specify the signing key to use (in PEM or base-64 encoded format), and how long the token should be valid for in seconds
-     * @returns {string} A JWT token that can be used to authenticate requests to the Knock API (e.g. by passing into the <KnockFeedProvider /> component)
+     * @returns {Promise<string>} A JWT token that can be used to authenticate requests to the Knock API (e.g. by passing into the <KnockFeedProvider /> component)
      */
-    static signUserToken(userId: string, options?: SignUserTokenOptions): string;
-    post(path: string, entity: any, options?: PostAndPutOptions): Promise<AxiosResponse>;
-    put(path: string, entity: any, options?: PostAndPutOptions): Promise<AxiosResponse>;
-    delete(path: string, entity?: any): Promise<AxiosResponse>;
-    get(path: string, query?: any): Promise<AxiosResponse>;
+    static signUserToken(userId: string, options?: SignUserTokenOptions): Promise<string>;
+    post(path: string, entity: any, options?: PostAndPutOptions): Promise<FetchResponse>;
+    put(path: string, entity: any, options?: PostAndPutOptions): Promise<FetchResponse>;
+    delete(path: string, entity?: any): Promise<FetchResponse>;
+    get(path: string, query?: any): Promise<FetchResponse>;
     handleErrorResponse(path: string, error: any): void;
     emitWarning(warning: string): void;
 }

package/dist/src/knock.js

@@ -13,8 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Knock = void 0;
-const axios_1 = __importDefault(require("axios"));
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const jose_1 = require("jose");
 const package_json_1 = require("../package.json");
 const exceptions_1 = require("./common/exceptions");
 const users_1 = require("./resources/users");
@@ -23,6 +22,7 @@ const bulk_operations_1 = require("./resources/bulk_operations");
 const objects_1 = require("./resources/objects");
 const messages_1 = require("./resources/messages");
 const tenants_1 = require("./resources/tenants");
+const fetchClient_1 = __importDefault(require("./common/fetchClient"));
 const DEFAULT_HOSTNAME = "https://api.knock.app";
 class Knock {
     constructor(key, options = {}) {
@@ -42,7 +42,7 @@ class Knock {
             }
         }
         this.host = options.host || DEFAULT_HOSTNAME;
-        this.client = axios_1.default.create({
+        this.client = new fetchClient_1.default({
             baseURL: this.host,
             headers: {
                 Authorization: `Bearer ${this.key}`,
@@ -62,29 +62,34 @@ class Knock {
      *
      * @param userId {string} The ID of the user that needs a token, e.g. the user viewing an in-app feed.
      * @param options Optionally specify the signing key to use (in PEM or base-64 encoded format), and how long the token should be valid for in seconds
-     * @returns {string} A JWT token that can be used to authenticate requests to the Knock API (e.g. by passing into the <KnockFeedProvider /> component)
+     * @returns {Promise<string>} A JWT token that can be used to authenticate requests to the Knock API (e.g. by passing into the <KnockFeedProvider /> component)
      */
     static signUserToken(userId, options) {
         var _a;
-        const signingKey = prepareSigningKey(options === null || options === void 0 ? void 0 : options.signingKey);
-        // JWT NumericDates specified in seconds:
-        const currentTime = Math.floor(Date.now() / 1000);
-        // Default to 1 hour from now
-        const expireInSeconds = (_a = options === null || options === void 0 ? void 0 : options.expiresInSeconds) !== null && _a !== void 0 ? _a : 60 * 60;
-        return jsonwebtoken_1.default.sign({
-            sub: userId,
-            iat: currentTime,
-            exp: currentTime + expireInSeconds,
-        }, signingKey, {
-            algorithm: "RS256",
+        return __awaiter(this, void 0, void 0, function* () {
+            const signingKey = prepareSigningKey(options === null || options === void 0 ? void 0 : options.signingKey);
+            // JWT NumericDates specified in seconds:
+            const currentTime = Math.floor(Date.now() / 1000);
+            // Default to 1 hour from now
+            const expireInSeconds = (_a = options === null || options === void 0 ? void 0 : options.expiresInSeconds) !== null && _a !== void 0 ? _a : 60 * 60;
+            // Convert string key to a Crypto-API compatible KeyLike
+            const keyLike = yield (0, jose_1.importPKCS8)(signingKey, "RS256");
+            return yield new jose_1.SignJWT({
+                sub: userId,
+                iat: currentTime,
+                exp: currentTime + expireInSeconds,
+            })
+                .setProtectedHeader({ alg: "RS256", typ: "JWT" })
+                .sign(keyLike);
         });
     }
     post(path, entity, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                return yield this.client.post(path, entity, {
+                return yield this.client.post(path, {
                     params: options.query,
-                    headers: options.headers,
+                    headers: Object.assign({ "Content-Type": "application/json", Accept: "application/json" }, options.headers),
+                    body: entity,
                 });
             }
             catch (error) {
@@ -96,8 +101,9 @@ class Knock {
     put(path, entity, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                return yield this.client.put(path, entity, {
+                return yield this.client.put(path, {
                     params: options.query,
+                    body: entity,
                 });
             }
             catch (error) {
@@ -133,9 +139,9 @@ class Knock {
         });
     }
     handleErrorResponse(path, error) {
-        if (axios_1.default.isAxiosError(error) && error.response) {
+        if (error.response) {
             const { status, data, headers } = error.response;
-            const requestID = headers["X-Request-ID"];
+            const requestID = headers.get("X-Request-ID");
             switch (status) {
                 case 401: {
                     const { message, code } = data;

package/dist/src/resources/messages/interfaces.d.ts

@@ -39,10 +39,10 @@ export interface ListMessagesOptions extends PaginationOptions {
 export interface ListMessageActivitiesOptions extends PaginationOptions {
     trigger_data?: Record<string, any>;
 }
-declare type WorkflowSource = {
+type WorkflowSource = {
     version_id: string;
     key: string;
 };
-declare type MessageStatus = "queued" | "sent" | "delivered" | "undelivered" | "not_sent";
-export declare type MessageEngagementStatus = "seen" | "read" | "archived";
+type MessageStatus = "queued" | "sent" | "delivered" | "undelivered" | "not_sent";
+export type MessageEngagementStatus = "seen" | "read" | "archived";
 export {};

package/dist/src/resources/objects/index.js

@@ -142,7 +142,7 @@ class Objects {
     setWorkflowPreferences(collection, objectId, workflowKey, setting, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, helpers_1.buildUpdateParam(setting));
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, (0, helpers_1.buildUpdateParam)(setting));
             return data;
         });
     }
@@ -156,7 +156,7 @@ class Objects {
     setCategoryPreferences(collection, objectId, categoryKey, setting, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/categories/${categoryKey}`, helpers_1.buildUpdateParam(setting));
+            const { data } = yield this.knock.put(`/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}/categories/${categoryKey}`, (0, helpers_1.buildUpdateParam)(setting));
             return data;
         });
     }

package/dist/src/resources/preferences/interfaces.d.ts

@@ -1,11 +1,11 @@
 import { ChannelType, Condition } from "../../common/interfaces";
-export declare type ConditionalPreferenceSettings = {
+export type ConditionalPreferenceSettings = {
     conditions: Condition[];
 };
-export declare type ChannelTypePreferences = {
+export type ChannelTypePreferences = {
     [K in ChannelType]?: boolean | ConditionalPreferenceSettings;
 };
-export declare type WorkflowPreferenceSetting = boolean | {
+export type WorkflowPreferenceSetting = boolean | {
     channel_types: ChannelTypePreferences;
 } | ConditionalPreferenceSettings;
 export interface WorkflowPreferences {

package/dist/src/resources/users/index.js

@@ -143,7 +143,7 @@ class Users {
     setWorkflowPreferences(userId, workflowKey, setting, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, helpers_1.buildUpdateParam(setting));
+            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/workflows/${workflowKey}`, (0, helpers_1.buildUpdateParam)(setting));
             return data;
         });
     }
@@ -157,7 +157,7 @@ class Users {
     setCategoryPreferences(userId, categoryKey, setting, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const preferenceSetId = options.preferenceSet || helpers_1.DEFAULT_PREFERENCE_SET_ID;
-            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/categories/${categoryKey}`, helpers_1.buildUpdateParam(setting));
+            const { data } = yield this.knock.put(`/v1/users/${userId}/preferences/${preferenceSetId}/categories/${categoryKey}`, (0, helpers_1.buildUpdateParam)(setting));
             return data;
         });
     }

package/dist/src/resources/workflows/interfaces.d.ts

@@ -31,7 +31,7 @@ export declare enum RepeatFrequency {
     Daily = "daily",
     Hourly = "hourly"
 }
-export declare type ScheduleRepeatProperties = {
+export type ScheduleRepeatProperties = {
     frequency: RepeatFrequency;
     interval?: number;
     day_of_month?: number;
@@ -75,11 +75,11 @@ export interface Schedule {
     repeats: ScheduleRepeatProperties[];
     __cursor?: string;
 }
-export declare type Recipient = string | ObjectRef;
-export declare type Actor = Recipient;
+export type Recipient = string | ObjectRef;
+export type Actor = Recipient;
 export interface UserWithUpsert extends IdentifyProperties {
     id: string;
 }
-export declare type ObjectWithUpsert = ObjectRef & SetObjectProperties;
-export declare type RecipientWithUpsert = UserWithUpsert | ObjectWithUpsert;
-export declare type ActorWithUpsert = RecipientWithUpsert;
+export type ObjectWithUpsert = ObjectRef & SetObjectProperties;
+export type RecipientWithUpsert = UserWithUpsert | ObjectWithUpsert;
+export type ActorWithUpsert = RecipientWithUpsert;

package/dist/src/resources/workflows/interfaces.js

@@ -10,11 +10,11 @@ var DaysOfWeek;
     DaysOfWeek["Fri"] = "fri";
     DaysOfWeek["Sat"] = "sat";
     DaysOfWeek["Sun"] = "sun";
-})(DaysOfWeek = exports.DaysOfWeek || (exports.DaysOfWeek = {}));
+})(DaysOfWeek || (exports.DaysOfWeek = DaysOfWeek = {}));
 var RepeatFrequency;
 (function (RepeatFrequency) {
     RepeatFrequency["Monthly"] = "monthly";
     RepeatFrequency["Weekly"] = "weekly";
     RepeatFrequency["Daily"] = "daily";
     RepeatFrequency["Hourly"] = "hourly";
-})(RepeatFrequency = exports.RepeatFrequency || (exports.RepeatFrequency = {}));
+})(RepeatFrequency || (exports.RepeatFrequency = RepeatFrequency = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -32,19 +32,16 @@
   },
   "devDependencies": {
     "@types/jest": "26.0.23",
-    "@types/jsonwebtoken": "^9.0.1",
     "@types/node": "^15.0.1",
     "@types/pluralize": "0.0.29",
-    "axios-mock-adapter": "^1.22.0",
     "jest": "26.6.3",
     "prettier": "2.2.1",
     "supertest": "6.1.3",
     "ts-jest": "26.5.5",
     "tslint": "6.1.3",
-    "typescript": "4.2.4"
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "axios": "1.6",
-    "jsonwebtoken": "^9.0.0"
+    "jose": "^5.2.0"
   }
-}
+}