@knocklabs/node 0.6.11 → 0.6.12

package/README.md

@@ -28,7 +28,7 @@ KNOCK_SIGNING_KEY="S25vY2sga25vY2sh..."
 You can also pass the Knock API key in the constructor. The signing key is passed separately to the `signUserToken` method (see below):
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 
 const knockClient = new Knock("sk_12345");
 ```
@@ -38,7 +38,7 @@ const knockClient = new Knock("sk_12345");
 ### Sending notifications (triggering workflows)
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 const knockClient = new Knock("sk_12345");
 
 // The key of the workflow (from Knock dashboard)
@@ -62,7 +62,7 @@ await knockClient.workflows.trigger("dinosaurs-loose", {
 ### Canceling workflows
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 const knockClient = new Knock("sk_12345");
 
 await knockClient.workflows.cancel("dinosaurs-loose", triggerAlert.id, {
@@ -74,7 +74,7 @@ await knockClient.workflows.cancel("dinosaurs-loose", triggerAlert.id, {
 ### Identifying users
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 const knockClient = new Knock("sk_12345");
 
 await knockClient.users.identify("jhammond", {
@@ -86,7 +86,7 @@ await knockClient.users.identify("jhammond", {
 ### Retrieving users
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 const knockClient = new Knock("sk_12345");
 
 await knockClient.users.get("jhammond");
@@ -95,7 +95,7 @@ await knockClient.users.get("jhammond");
 ### Deleting users
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 const knockClient = new Knock("sk_12345");
 
 await knockClient.users.delete("jhammond");
@@ -104,7 +104,7 @@ await knockClient.users.delete("jhammond");
 ### Preferences
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 const knockClient = new Knock("sk_12345");
 
 // Set an entire preference set
@@ -124,7 +124,7 @@ const preferences = await knockClient.users.getPreferences("jhammond");
 ### Getting and setting channel data
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 const knockClient = new Knock("sk_12345");
 
 // Setting channel data for an APNS
@@ -139,12 +139,12 @@ await knockClient.users.getChannelData("jhammond", KNOCK_APNS_CHANNEL_ID);
 ### Slack
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@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: 
+// An optional object containing the query options passed to Slack:
 // https://api.slack.com/methods/conversations.list#arg_cursor
 const queryOptions = {
   cursor: null,
@@ -154,18 +154,21 @@ const queryOptions = {
   types: "public_channel",
 };
 
-
 // Retrieve a list of Slack channels
-const channelsInput = { tenant: tenantId, knockChannelId: knockSlackChannelId, queryOptions };
+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)
+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)
+const revokeInput = { tenant: tenantId, knockChannelId: knockSlackChannelId };
+await knockClient.slack.revokeAccessToken(revokeInput);
 ```
 
 ### Signing JWTs
@@ -175,7 +178,7 @@ When using [enhanced security mode](https://docs.knock.app/client-integration/au
 You will need to generate an environment specific signing key in the Knock dashboard under "API Keys", and then enable enhanced security mode for your environment.
 
 ```javascript
-const { Knock } = require("@knocklabs/node");
+import { Knock } from "@knocklabs/node";
 
 // When signing user tokens, you do not need to instantiate a Knock client.
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.6.11",
+    "version": "0.6.12",
     "description": "Library for interacting with the Knock API",
     "homepage": "https://github.com/knocklabs/knock-node",
     "author": "@knocklabs",

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

@@ -1,7 +1,8 @@
 export declare enum Grants {
     SlackChannelsRead = "slack/channels_read",
     ChannelDataRead = "channel_data/read",
-    ChannelDataWrite = "channel_data/write"
+    ChannelDataWrite = "channel_data/write",
+    UserFeedRead = "user/feed_read"
 }
 export type TokenGrantOptions = Grants[];
 export type TokenEntity = TenantTokenEntity | UserTokenEntity | ObjectTokenEntity;

package/dist/src/common/userTokens.js

@@ -6,4 +6,5 @@ var Grants;
     Grants["SlackChannelsRead"] = "slack/channels_read";
     Grants["ChannelDataRead"] = "channel_data/read";
     Grants["ChannelDataWrite"] = "channel_data/write";
+    Grants["UserFeedRead"] = "user/feed_read";
 })(Grants || (exports.Grants = Grants = {}));

package/dist/src/knock.d.ts

@@ -22,6 +22,11 @@ declare class Knock {
     readonly tenants: Tenants;
     readonly slack: Slack;
     constructor(key?: string | undefined, options?: KnockOptions);
+    /**
+     * Delegate the notify function to the workflows trigger
+     *
+     * @deprecated use workflows.trigger instead.
+     */
     notify(workflowKey: string, properties: TriggerWorkflowProperties, options?: MethodOptions): Promise<import("./resources/workflows/interfaces").WorkflowRun>;
     /**
      * Generate JWT for authenticating client-side requests (e.g. in-app feeds)

package/dist/src/knock.js

@@ -54,7 +54,11 @@ class Knock {
             },
         });
     }
-    // Delegate the notify function to the workflows trigger
+    /**
+     * Delegate the notify function to the workflows trigger
+     *
+     * @deprecated use workflows.trigger instead.
+     */
     notify(workflowKey, properties, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.workflows.trigger(workflowKey, properties, options);

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

@@ -35,6 +35,7 @@ export interface ListMessagesOptions extends PaginationOptions {
     status?: MessageStatus[];
     channel_id?: string;
     trigger_data?: Record<string, any>;
+    workflow_categories?: String[];
 }
 export interface ListMessageActivitiesOptions extends PaginationOptions {
     trigger_data?: Record<string, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.6.11",
+  "version": "0.6.12",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -45,4 +45,4 @@
   "engines": {
     "node": ">=17.5.0"
   }
-}
+}