@knocklabs/node 0.6.4 → 0.6.6

package/README.md

@@ -136,6 +136,38 @@ await knockClient.users.setChannelData("jhammond", KNOCK_APNS_CHANNEL_ID, {
 await knockClient.users.getChannelData("jhammond", KNOCK_APNS_CHANNEL_ID);
 ```
 
+### Slack
+
+```javascript
+const { Knock } = require("@knocklabs/node");
+const knockClient = new Knock("sk_12345");
+
+const tenantId = "tenant-123";
+const knockSlackChannelId = "7c1e0042-5ef2-411a-a43b-e541acb139ed";
+// An optional object containing the query options passed to Slack: 
+// https://api.slack.com/methods/conversations.list#arg_cursor
+const queryOptions = {
+  cursor: null,
+  limit: 200,
+  exclude_archived: true,
+  team_id: null,
+  types: "public_channel",
+};
+
+
+// Retrieve a list of Slack channels
+const channelsInput = { tenant: tenantId, knockChannelId: knockSlackChannelId, queryOptions };
+await knockClient.slack.getChannels(channelsInput);
+
+// Check Slack connection
+const authInput = { tenant: tenantId, knockChannelId: knockSlackChannelId }
+await knockClient.slack.authCheck(authInput)
+
+// Revoke access token
+const revokeInput = { tenant: tenantId, knockChannelId: knockSlackChannelId }
+await knockClient.slack.revokeAccessToken(revokeInput)
+```
+
 ### Signing JWTs
 
 When using [enhanced security mode](https://docs.knock.app/client-integration/authenticating-users) (recommended in production), you will need to sign JWTs server-side to authenticate your users.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.6.4",
+    "version": "0.6.6",
     "description": "Library for interacting with the Knock API",
     "homepage": "https://github.com/knocklabs/knock-node",
     "author": "@knocklabs",
@@ -41,5 +41,8 @@
     },
     "dependencies": {
         "jose": "^5.2.0"
+    },
+    "engines": {
+        "node": ">=17.5.0"
     }
 }

package/dist/src/common/fetchClient.js

@@ -69,18 +69,30 @@ class FetchClient {
     }
     buildUrl(path, params) {
         const url = new URL(this.config.baseURL + path);
-        if (params) {
-            Object.entries(params).forEach(([key, value]) => {
+        function appendParams(key, value, parentKey) {
+            const fullKey = parentKey ? `${parentKey}[${key}]` : key;
+            if (typeof value === "object" &&
+                value !== null &&
+                !(value instanceof Date) &&
+                !(value instanceof Array)) {
+                // If value is an object, recurse
+                Object.entries(value).forEach(([nestedKey, nestedValue]) => {
+                    appendParams(nestedKey, nestedValue, fullKey);
+                });
+            }
+            else if (Array.isArray(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);
-                }
+                value.forEach((val) => url.searchParams.append(`${fullKey}[]`, val));
+            }
+            else {
+                // For primitive values, simply append them
+                url.searchParams.append(fullKey, value);
+            }
+        }
+        if (params) {
+            Object.entries(params).forEach(([key, value]) => {
+                appendParams(key, value);
             });
         }
         return url;

package/dist/src/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./resources/workflows/interfaces";
 export * from "./resources/users/interfaces";
 export * from "./resources/preferences/interfaces";
+export * from "./resources/slack/interfaces";
 export * from "./common/interfaces";
 export { Knock } from "./knock";

package/dist/src/index.js

@@ -18,6 +18,7 @@ exports.Knock = void 0;
 __exportStar(require("./resources/workflows/interfaces"), exports);
 __exportStar(require("./resources/users/interfaces"), exports);
 __exportStar(require("./resources/preferences/interfaces"), exports);
+__exportStar(require("./resources/slack/interfaces"), exports);
 __exportStar(require("./common/interfaces"), exports);
 var knock_1 = require("./knock");
 Object.defineProperty(exports, "Knock", { enumerable: true, get: function () { return knock_1.Knock; } });

package/dist/src/knock.d.ts

@@ -8,6 +8,7 @@ import { Messages } from "./resources/messages";
 import { Tenants } from "./resources/tenants";
 import { FetchResponse } from "./common/fetchClient";
 import { TokenEntity, TokenGrant, TokenGrantOptions } from "./common/userTokens";
+import { Slack } from "./resources/slack";
 declare class Knock {
     readonly key?: string | undefined;
     readonly options: KnockOptions;
@@ -19,6 +20,7 @@ declare class Knock {
     readonly objects: Objects;
     readonly messages: Messages;
     readonly tenants: Tenants;
+    readonly slack: Slack;
     constructor(key?: string | undefined, options?: KnockOptions);
     notify(workflowKey: string, properties: TriggerWorkflowProperties, options?: MethodOptions): Promise<import("./resources/workflows/interfaces").WorkflowRun>;
     /**

package/dist/src/knock.js

@@ -23,6 +23,7 @@ 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 slack_1 = require("./resources/slack");
 const DEFAULT_HOSTNAME = "https://api.knock.app";
 class Knock {
     constructor(key, options = {}) {
@@ -35,6 +36,7 @@ class Knock {
         this.objects = new objects_1.Objects(this);
         this.messages = new messages_1.Messages(this);
         this.tenants = new tenants_1.Tenants(this);
+        this.slack = new slack_1.Slack(this);
         if (!key) {
             this.key = process.env.KNOCK_API_KEY;
             if (!this.key) {

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

@@ -0,0 +1,9 @@
+import { Knock } from "../../knock";
+import { AuthCheckInput, GetSlackChannelsInput, PaginatedSlackChannelResponse, RevokeAccessTokenInput } from "./interfaces";
+export declare class Slack {
+    readonly knock: Knock;
+    constructor(knock: Knock);
+    getChannels(input: GetSlackChannelsInput): Promise<PaginatedSlackChannelResponse>;
+    authCheck({ tenant, knockChannelId }: AuthCheckInput): Promise<any>;
+    revokeAccessToken({ tenant, knockChannelId }: RevokeAccessTokenInput): Promise<any>;
+}

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

@@ -0,0 +1,75 @@
+"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.Slack = void 0;
+const TENANT_COLLECTION = "$tenants";
+function removeNullKeys(obj) {
+    Object.keys(obj).forEach((key) => {
+        if (obj[key] === null) {
+            delete obj[key];
+        }
+    });
+    return obj;
+}
+class Slack {
+    constructor(knock) {
+        this.knock = knock;
+    }
+    getChannels(input) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { knockChannelId, tenant } = input;
+            const queryOptions = input.queryOptions || {};
+            const params = {
+                access_token_object: {
+                    object_id: tenant,
+                    collection: TENANT_COLLECTION,
+                },
+                channel_id: knockChannelId,
+                query_options: removeNullKeys({
+                    cursor: queryOptions.cursor || null,
+                    limit: queryOptions.limit || null,
+                    exclude_archived: queryOptions.excludeArchived || null,
+                    team_id: queryOptions.teamId || null,
+                    types: queryOptions.types || null,
+                }),
+            };
+            const { data } = yield this.knock.get(`/v1/providers/slack/${knockChannelId}/channels`, params);
+            return data;
+        });
+    }
+    authCheck({ tenant, knockChannelId }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                access_token_object: {
+                    object_id: tenant,
+                    collection: TENANT_COLLECTION,
+                },
+                channel_id: knockChannelId,
+            };
+            const { data } = yield this.knock.get(`/v1/providers/slack/${knockChannelId}/auth_check`, params);
+            return data;
+        });
+    }
+    revokeAccessToken({ tenant, knockChannelId }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                access_token_object: {
+                    object_id: tenant,
+                    collection: TENANT_COLLECTION,
+                },
+                channel_id: knockChannelId,
+            };
+            const { data } = yield this.knock.get(`/v1/providers/slack/${knockChannelId}/revoke_access`, params);
+            return data;
+        });
+    }
+}
+exports.Slack = Slack;

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

@@ -0,0 +1,30 @@
+export type GetSlackChannelsInput = {
+    tenant: string;
+    knockChannelId: string;
+    queryOptions?: {
+        limit?: number;
+        cursor?: string;
+        excludeArchived?: boolean;
+        teamId?: string;
+        types?: string;
+    };
+};
+export type SlackChannel = {
+    name: string;
+    id: string;
+    is_private: boolean;
+    is_im: boolean;
+    context_team_id: boolean;
+};
+export type PaginatedSlackChannelResponse = {
+    slack_channels: SlackChannel[];
+    next_cursor: string;
+};
+export type AuthCheckInput = {
+    tenant: string;
+    knockChannelId: string;
+};
+export type RevokeAccessTokenInput = {
+    tenant: string;
+    knockChannelId: string;
+};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.6.4",
+  "version": "0.6.6",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -41,5 +41,8 @@
   },
   "dependencies": {
     "jose": "^5.2.0"
+  },
+  "engines": {
+    "node": ">=17.5.0"
   }
-}
+}