@knocklabs/node 0.6.0 → 0.6.2

package/README.md

@@ -154,7 +154,7 @@ const token = await Knock.signUserToken("jhammond", {
   signingKey: "S25vY2sga25vY2sh...",
   // Optional: How long the token should be valid for, in seconds (default 1 hour)
   // For long-lived connections, you will need to refresh the token before it expires.
-  expiresIn: 60 * 60,
+  expiresInSeconds: 60 * 60,
 });
 
 // This token can now be safely passed to your client e.g. in a cookie or API response.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.6.0",
+    "version": "0.6.2",
     "description": "Library for interacting with the Knock API",
     "homepage": "https://github.com/knocklabs/knock-node",
     "author": "@knocklabs",
@@ -24,22 +24,20 @@
     "scripts": {
         "build": "tsc -p tsconfig.json",
         "lint": "tslint -p tsconfig.json -c tslint.json",
-        "test": "jest",
-        "test:watch": "jest --watch",
-        "prettier": "prettier \"src/**/*.{js,ts,tsx}\" --check",
         "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
+        "format:check": "prettier \"src/**/*.{js,ts,tsx}\" --check",
+        "test": "vitest",
+        "coverage": "vitest run --coverage",
         "prepublishOnly": "npm run build"
     },
     "devDependencies": {
-        "@types/jest": "26.0.23",
         "@types/node": "^15.0.1",
         "@types/pluralize": "0.0.29",
-        "jest": "26.6.3",
+        "msw": "^2.1.5",
         "prettier": "2.2.1",
-        "supertest": "6.1.3",
-        "ts-jest": "26.5.5",
         "tslint": "6.1.3",
-        "typescript": "^5.3.3"
+        "typescript": "^5.3.3",
+        "vitest": "^1.2.1"
     },
     "dependencies": {
         "jose": "^5.2.0"

package/dist/src/common/fetchClient.js

@@ -70,7 +70,18 @@ class FetchClient {
     buildUrl(path, params) {
         const url = new URL(this.config.baseURL + path);
         if (params) {
-            Object.entries(params).forEach(([key, value]) => url.searchParams.append(key, value));
+            Object.entries(params).forEach(([key, value]) => {
+                // Send array values as individual values instead of a comma separated list
+                // e.g. key[]=1&key[]=2&key[]=3 instead of key=1,2,3
+                if (Array.isArray(value)) {
+                    for (const val of value) {
+                        url.searchParams.append(`${key}[]`, val);
+                    }
+                }
+                else {
+                    url.searchParams.append(key, value);
+                }
+            });
         }
         return url;
     }

package/dist/src/knock.js

@@ -47,6 +47,8 @@ class Knock {
             headers: {
                 Authorization: `Bearer ${this.key}`,
                 "User-Agent": `knocklabs/node@${package_json_1.version}`,
+                "Content-Type": "application/json",
+                Accept: "application/json",
             },
         });
     }
@@ -88,7 +90,7 @@ class Knock {
             try {
                 return yield this.client.post(path, {
                     params: options.query,
-                    headers: Object.assign({ "Content-Type": "application/json", Accept: "application/json" }, options.headers),
+                    headers: Object.assign({}, options.headers),
                     body: entity,
                 });
             }
@@ -103,6 +105,7 @@ class Knock {
             try {
                 return yield this.client.put(path, {
                     params: options.query,
+                    headers: Object.assign({}, options.headers),
                     body: entity,
                 });
             }
@@ -152,7 +155,12 @@ class Knock {
                     throw new exceptions_1.BadRequestException(code, message, requestID);
                 }
                 case 422: {
-                    const { errors } = data;
+                    // Format errors as an array before passing to exception constructor
+                    const errors = !data.errors
+                        ? []
+                        : Array.isArray(data.errors)
+                            ? data.errors
+                            : [data.errors];
                     throw new exceptions_1.UnprocessableEntityException(errors, requestID);
                 }
                 case 404: {

package/dist/src/resources/tenants/index.d.ts

@@ -1,11 +1,11 @@
 import { CommonMetadata, PaginatedEntriesResponse } from "../../common/interfaces";
 import { Knock } from "../../knock";
-import { Tenant, SetTenant, ListTenantsOptions } from "./interfaces";
+import { Tenant, ListTenantsOptions, SetTenantProperties } from "./interfaces";
 export declare class Tenants {
     readonly knock: Knock;
     constructor(knock: Knock);
     list(filteringOptions?: ListTenantsOptions): Promise<PaginatedEntriesResponse<Tenant>>;
     get<T = CommonMetadata>(id: string): Promise<Tenant<T>>;
-    set<T = CommonMetadata>(id: string, tenantData: SetTenant): Promise<Tenant<T>>;
+    set<T = CommonMetadata>(id: string, tenantData: SetTenantProperties): Promise<Tenant<T>>;
     delete(id: string): Promise<null>;
 }

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

@@ -1,4 +1,4 @@
-import { CommonMetadata, PaginationOptions } from "../../common/interfaces";
+import { CommonMetadata, PaginationOptions, SetChannelDataProperties } from "../../common/interfaces";
 import { SetPreferencesProperties } from "../preferences/interfaces";
 export interface TenantRef {
     id: string;
@@ -20,9 +20,11 @@ export interface Tenant<T = CommonMetadata> {
     created_at?: string;
     updated_at: string;
 }
-export interface SetTenant {
+export interface SetTenantProperties {
     name?: string;
+    channelData?: SetChannelDataProperties;
     settings?: TenantSettings;
+    [key: string]: any;
 }
 export interface ListTenantsOptions extends PaginationOptions {
     tenant_id?: string;

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

@@ -1,13 +1,14 @@
 import { ObjectRef, SetObjectProperties } from "../objects/interfaces";
 import { IdentifyProperties } from "../users/interfaces";
 import { PaginationOptions } from "../../common/interfaces";
+import { SetTenantProperties, TenantRef } from "../tenants/interfaces";
 export interface TriggerWorkflowProperties<T = {
     [key: string]: any;
 }> {
     actor?: Actor | ActorWithUpsert;
     recipients?: (Recipient | RecipientWithUpsert)[];
     cancellationKey?: string;
-    tenant?: string;
+    tenant?: Tenant | TenantWithUpsert;
     data?: T;
 }
 export interface CancelWorkflowProperties {
@@ -44,7 +45,7 @@ export interface CreateSchedulesProps {
     actor?: Recipient | RecipientWithUpsert | null;
     scheduled_at?: string;
     repeats?: ScheduleRepeatProperties[];
-    tenant?: string;
+    tenant?: Tenant | TenantWithUpsert | null;
     data?: {
         [key: string]: any;
     };
@@ -77,9 +78,11 @@ export interface Schedule {
 }
 export type Recipient = string | ObjectRef;
 export type Actor = Recipient;
+export type Tenant = string | TenantRef;
 export interface UserWithUpsert extends IdentifyProperties {
     id: string;
 }
 export type ObjectWithUpsert = ObjectRef & SetObjectProperties;
+export type TenantWithUpsert = TenantRef & SetTenantProperties;
 export type RecipientWithUpsert = UserWithUpsert | ObjectWithUpsert;
 export type ActorWithUpsert = RecipientWithUpsert;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -24,22 +24,20 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "lint": "tslint -p tsconfig.json -c tslint.json",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "prettier": "prettier \"src/**/*.{js,ts,tsx}\" --check",
     "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
+    "format:check": "prettier \"src/**/*.{js,ts,tsx}\" --check",
+    "test": "vitest",
+    "coverage": "vitest run --coverage",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@types/jest": "26.0.23",
     "@types/node": "^15.0.1",
     "@types/pluralize": "0.0.29",
-    "jest": "26.6.3",
+    "msw": "^2.1.5",
     "prettier": "2.2.1",
-    "supertest": "6.1.3",
-    "ts-jest": "26.5.5",
     "tslint": "6.1.3",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vitest": "^1.2.1"
   },
   "dependencies": {
     "jose": "^5.2.0"