@knocklabs/node 0.6.1 → 0.6.3

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.1",
+    "version": "0.6.3",
     "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/common/interfaces.d.ts

@@ -1,3 +1,4 @@
+import { TokenGrant } from "./userTokens";
 export interface KnockOptions {
     host?: string;
 }
@@ -57,6 +58,11 @@ export interface SignUserTokenOptions {
     signingKey?: string;
     /** The expiration time of the token in seconds. Defaults to 1 hour. */
     expiresInSeconds?: number;
+    /**
+     * A list of token grants to pass along with this token. The grants here provide permissions to
+     * the requested entities for the user
+     */
+    grants?: TokenGrant[];
 }
 export interface MethodOptions {
     idempotencyKey?: string;

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

@@ -0,0 +1,26 @@
+export declare enum Grants {
+    SlackChannelsRead = "slack_channels/read",
+    ChannelDataRead = "channel_data/read",
+    ChannelDataWrite = "channel_data/write"
+}
+export type TokenGrantOptions = Grants[];
+export type TokenEntity = TenantTokenEntity | UserTokenEntity | ObjectTokenEntity;
+export interface TenantTokenEntity {
+    type: "tenant";
+    id: string;
+    collection?: never;
+}
+export interface ObjectTokenEntity {
+    type: "object";
+    id: string;
+    collection: string;
+}
+export interface UserTokenEntity {
+    type: "user";
+    id: string;
+    collection?: never;
+}
+export type TokenGrant = {
+    entity: string;
+    grants: Partial<Record<Grants, []>>;
+};

package/dist/src/common/userTokens.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Grants = void 0;
+var Grants;
+(function (Grants) {
+    Grants["SlackChannelsRead"] = "slack_channels/read";
+    Grants["ChannelDataRead"] = "channel_data/read";
+    Grants["ChannelDataWrite"] = "channel_data/write";
+})(Grants || (exports.Grants = Grants = {}));

package/dist/src/knock.d.ts

@@ -7,6 +7,7 @@ import { Objects } from "./resources/objects";
 import { Messages } from "./resources/messages";
 import { Tenants } from "./resources/tenants";
 import { FetchResponse } from "./common/fetchClient";
+import { TokenEntity, TokenGrant, TokenGrantOptions } from "./common/userTokens";
 declare class Knock {
     readonly key?: string | undefined;
     readonly options: KnockOptions;
@@ -29,6 +30,15 @@ declare class Knock {
      * @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): Promise<string>;
+    /**
+     * Helper function to build user token grants to pass to the `signUserToken` method.
+     *
+     * @param entity {TokenEntity} The type of entity to build a grant for
+     * @param grants {TokenGrantOptions} A list of grants to give to the entity for the user
+     *
+     * @returns {TokenGrant} A single token grant that can be passed to the signUserToken function
+     */
+    static buildUserTokenGrant(entity: TokenEntity, grants: TokenGrantOptions): TokenGrant;
     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>;
@@ -36,4 +46,5 @@ declare class Knock {
     handleErrorResponse(path: string, error: any): void;
     emitWarning(warning: string): void;
 }
+export declare function maybePrepareUserTokenGrants(grants: TokenGrant[] | undefined): Record<string, TokenGrant["grants"]> | undefined;
 export { Knock };

package/dist/src/knock.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Knock = void 0;
+exports.Knock = exports.maybePrepareUserTokenGrants = void 0;
 const jose_1 = require("jose");
 const package_json_1 = require("../package.json");
 const exceptions_1 = require("./common/exceptions");
@@ -78,6 +78,7 @@ class Knock {
             const keyLike = yield (0, jose_1.importPKCS8)(signingKey, "RS256");
             return yield new jose_1.SignJWT({
                 sub: userId,
+                grants: maybePrepareUserTokenGrants(options === null || options === void 0 ? void 0 : options.grants),
                 iat: currentTime,
                 exp: currentTime + expireInSeconds,
             })
@@ -85,6 +86,20 @@ class Knock {
                 .sign(keyLike);
         });
     }
+    /**
+     * Helper function to build user token grants to pass to the `signUserToken` method.
+     *
+     * @param entity {TokenEntity} The type of entity to build a grant for
+     * @param grants {TokenGrantOptions} A list of grants to give to the entity for the user
+     *
+     * @returns {TokenGrant} A single token grant that can be passed to the signUserToken function
+     */
+    static buildUserTokenGrant(entity, grants) {
+        return {
+            entity: prepareTokenEntityUri(entity),
+            grants: grants.reduce((acc, grant) => (Object.assign(Object.assign({}, acc), { [grant]: [] })), {}),
+        };
+    }
     post(path, entity, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -192,3 +207,29 @@ function prepareSigningKey(key) {
         return Buffer.from(maybeSigningKey, "base64").toString("utf-8");
     throw new exceptions_1.NoSigningKeyProvidedException();
 }
+function prepareTokenEntityUri(entity) {
+    switch (entity.type) {
+        case "user":
+            return `${DEFAULT_HOSTNAME}/v1/users/${entity.id}`;
+        case "tenant":
+            return `${DEFAULT_HOSTNAME}/v1/objects/$tenants/${entity.id}`;
+        case "object":
+            return `${DEFAULT_HOSTNAME}/v1/objects/${entity.collection}/${entity.id}`;
+    }
+}
+function maybePrepareUserTokenGrants(grants) {
+    if (!grants)
+        return undefined;
+    // Given a list of token grants, flattens them into a single object
+    // like: { "entity": { "slack_channels/read": [] } }
+    return grants.reduce((acc, grant) => {
+        if (acc[grant.entity]) {
+            const currentGrants = acc[grant.entity];
+            return Object.assign(Object.assign({}, acc), { [grant.entity]: Object.assign(Object.assign({}, currentGrants), grant.grants) });
+        }
+        else {
+            return Object.assign(Object.assign({}, acc), { [grant.entity]: grant.grants });
+        }
+    }, {});
+}
+exports.maybePrepareUserTokenGrants = maybePrepareUserTokenGrants;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -24,24 +24,22 @@
   "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"
   }
-}
+}