@knocklabs/node 1.7.0 → 1.9.0

package/src/internal/qs/utils.ts

@@ -1,10 +1,13 @@
 import { RFC1738 } from './formats';
 import type { DefaultEncoder, Format } from './types';
+import { isArray } from '../utils/values';
 
-const has = Object.prototype.hasOwnProperty;
-const is_array = Array.isArray;
+export let has = (obj: object, key: PropertyKey): boolean => (
+  (has = (Object as any).hasOwn ?? Function.prototype.call.bind(Object.prototype.hasOwnProperty)),
+  has(obj, key)
+);
 
-const hex_table = (() => {
+const hex_table = /* @__PURE__ */ (() => {
   const array = [];
   for (let i = 0; i < 256; ++i) {
     array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
@@ -20,7 +23,7 @@ function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; pro
 
     const obj = item.obj[item.prop];
 
-    if (is_array(obj)) {
+    if (isArray(obj)) {
       const compacted: unknown[] = [];
 
       for (let j = 0; j < obj.length; ++j) {
@@ -56,13 +59,10 @@ export function merge(
   }
 
   if (typeof source !== 'object') {
-    if (is_array(target)) {
+    if (isArray(target)) {
       target.push(source);
     } else if (target && typeof target === 'object') {
-      if (
-        (options && (options.plainObjects || options.allowPrototypes)) ||
-        !has.call(Object.prototype, source)
-      ) {
+      if ((options && (options.plainObjects || options.allowPrototypes)) || !has(Object.prototype, source)) {
         target[source] = true;
       }
     } else {
@@ -77,14 +77,14 @@ export function merge(
   }
 
   let mergeTarget = target;
-  if (is_array(target) && !is_array(source)) {
+  if (isArray(target) && !isArray(source)) {
     // @ts-ignore
     mergeTarget = array_to_object(target, options);
   }
 
-  if (is_array(target) && is_array(source)) {
+  if (isArray(target) && isArray(source)) {
     source.forEach(function (item, i) {
-      if (has.call(target, i)) {
+      if (has(target, i)) {
         const targetItem = target[i];
         if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
           target[i] = merge(targetItem, item, options);
@@ -101,7 +101,7 @@ export function merge(
   return Object.keys(source).reduce(function (acc, key) {
     const value = source[key];
 
-    if (has.call(acc, key)) {
+    if (has(acc, key)) {
       acc[key] = merge(acc[key], value, options);
     } else {
       acc[key] = value;
@@ -254,7 +254,7 @@ export function combine(a: any, b: any) {
 }
 
 export function maybe_map<T>(val: T[], fn: (v: T) => T) {
-  if (is_array(val)) {
+  if (isArray(val)) {
     const mapped = [];
     for (let i = 0; i < val.length; i += 1) {
       mapped.push(fn(val[i]!));

package/src/internal/uploads.ts

@@ -90,7 +90,7 @@ export const multipartFormRequestOptions = async (
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
 
-const supportsFormDataMap = new WeakMap<Fetch, Promise<boolean>>();
+const supportsFormDataMap = /** @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
 
 /**
  * node-fetch doesn't support the global FormData object in recent node versions. Instead of sending
@@ -138,7 +138,7 @@ export const createForm = async <T = Record<string, unknown>>(
 
 // We check for Blob not File because Bun.File doesn't inherit from File,
 // but they both inherit from Blob and have a `name` property at runtime.
-const isNamedBlob = (value: object) => value instanceof Blob && 'name' in value;
+const isNamedBlob = (value: unknown) => value instanceof Blob && 'name' in value;
 
 const isUploadable = (value: unknown) =>
   typeof value === 'object' &&

package/src/internal/utils/log.ts

@@ -58,7 +58,7 @@ const noopLogger = {
   debug: noop,
 };
 
-let cachedLoggers = new WeakMap<Logger, [LogLevel, Logger]>();
+let cachedLoggers = /** @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
 export function loggerFor(client: Knock): Logger {
   const logger = client.logger;

package/src/internal/utils/path.ts

@@ -60,4 +60,4 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
 /**
  * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
  */
-export const path = createPathTagFunction(encodeURIPath);
+export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/values.ts

@@ -9,6 +9,9 @@ export const isAbsoluteURL = (url: string): boolean => {
   return startsWithSchemeRegexp.test(url);
 };
 
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
 /** Returns an object if the given value isn't an object, otherwise returns as-is */
 export function maybeObj(x: unknown): object {
   if (typeof x !== 'object') {

package/src/lib/tokenSigner.ts

@@ -2,7 +2,7 @@
  * Token signing functionality for Knock authentication
  */
 
-import * as crypto from 'crypto';
+import type { JWTPayload, JWTHeaderParameters } from 'jose';
 import type { TokenEntity, TokenGrant, TokenGrantOptions } from './userTokens';
 
 // Default hostname for Knock API
@@ -65,38 +65,20 @@ function prepareTokenEntityUri(entity: TokenEntity): string {
 }
 
 /**
- * Create and sign a JWT using Node.js crypto
+ * Create and sign a JWT using jose
  */
-function createJWT(header: object, payload: object, privateKey: string): string {
-  // Base64Url encode the header
-  const headerBase64 = Buffer.from(JSON.stringify(header))
-    .toString('base64')
-    .replace(/=/g, '')
-    .replace(/\+/g, '-')
-    .replace(/\//g, '_');
-
-  // Base64Url encode the payload
-  const payloadBase64 = Buffer.from(JSON.stringify(payload))
-    .toString('base64')
-    .replace(/=/g, '')
-    .replace(/\+/g, '-')
-    .replace(/\//g, '_');
-
-  // Create the content to sign
-  const signatureContent = `${headerBase64}.${payloadBase64}`;
-
-  // Sign the content
-  const signer = crypto.createSign('RSA-SHA256');
-  signer.update(signatureContent);
-
-  const signature = signer
-    .sign(privateKey, 'base64')
-    .replace(/=/g, '')
-    .replace(/\+/g, '-')
-    .replace(/\//g, '_');
-
-  // Combine to create the JWT
-  return `${signatureContent}.${signature}`;
+async function createJWT(
+  header: JWTHeaderParameters,
+  payload: JWTPayload,
+  privateKey: string,
+): Promise<string> {
+  const { SignJWT, importPKCS8 } = await import('jose');
+  const key = await importPKCS8(privateKey, 'RS256');
+
+  const jwt = new SignJWT(payload);
+  jwt.setProtectedHeader(header);
+
+  return jwt.sign(key);
 }
 
 /**
@@ -144,27 +126,22 @@ export function buildUserTokenGrant(entity: TokenEntity, grants: TokenGrantOptio
  */
 export async function signUserToken(userId: string, options?: SignUserTokenOptions): Promise<string> {
   const signingKey = prepareSigningKey(options?.signingKey);
-
   // JWT NumericDates specified in seconds
   const currentTime = Math.floor(Date.now() / 1000);
-
   // Default to 1 hour from now
   const expireInSeconds = options?.expiresInSeconds ?? 60 * 60;
 
-  // Create JWT header
-  const header = {
+  const header: JWTHeaderParameters = {
     alg: 'RS256',
     typ: 'JWT',
   };
 
-  // Create JWT payload
-  const payload = {
+  const payload: JWTPayload = {
     sub: userId,
     grants: maybePrepareUserTokenGrants(options?.grants),
     iat: currentTime,
     exp: currentTime + expireInSeconds,
   };
 
-  // Create and sign the JWT
   return createJWT(header, payload, signingKey);
 }

package/src/resources/objects/bulk.ts

@@ -154,6 +154,8 @@ export namespace BulkSetParams {
 
     /**
      * Inline set preferences for a recipient, where the key is the preference set id.
+     * Preferences that are set inline will be merged into any existing preferences
+     * rather than replacing them.
      */
     preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
 

package/src/resources/objects/objects.ts

@@ -439,6 +439,8 @@ export interface InlineObjectRequest {
 
   /**
    * Inline set preferences for a recipient, where the key is the preference set id.
+   * Preferences that are set inline will be merged into any existing preferences
+   * rather than replacing them.
    */
   preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
 
@@ -686,6 +688,8 @@ export interface ObjectSetParams {
 
   /**
    * Inline set preferences for a recipient, where the key is the preference set id.
+   * Preferences that are set inline will be merged into any existing preferences
+   * rather than replacing them.
    */
   preferences?: PreferencesAPI.InlinePreferenceSetRequest;
 

package/src/resources/providers/slack.ts

@@ -171,12 +171,13 @@ export namespace SlackListChannelsParams {
     cursor?: string;
 
     /**
-     * Set to true to exclude archived channels from the list.
+     * Set to true to exclude archived channels from the list. Defaults to `true` when
+     * not explicitly provided.
      */
     exclude_archived?: boolean;
 
     /**
-     * The maximum number of channels to return.
+     * The maximum number of channels to return. Defaults to 200.
      */
     limit?: number;
 
@@ -187,7 +188,8 @@ export namespace SlackListChannelsParams {
 
     /**
      * Mix and match channel types by providing a comma-separated list of any
-     * combination of public_channel, private_channel, mpim, im.
+     * combination of public_channel, private_channel, mpim, im. Defaults to
+     * `"public_channel,private_channel"`.
      */
     types?: string;
   }

package/src/resources/recipients/preferences.ts

@@ -8,6 +8,8 @@ export class Preferences extends APIResource {}
 
 /**
  * Inline set preferences for a recipient, where the key is the preference set id.
+ * Preferences that are set inline will be merged into any existing preferences
+ * rather than replacing them.
  */
 export type InlinePreferenceSetRequest = Record<string, PreferenceSetRequest>;
 

package/src/resources/tenants/tenants.ts

@@ -177,6 +177,8 @@ export interface TenantRequest {
 
   /**
    * Inline set preferences for a recipient, where the key is the preference set id.
+   * Preferences that are set inline will be merged into any existing preferences
+   * rather than replacing them.
    */
   preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
 

package/src/resources/users/bulk.ts

@@ -9,8 +9,7 @@ import { RequestOptions } from '../../internal/request-options';
 
 export class Bulk extends APIResource {
   /**
-   * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
-   * delete and returns a bulk operation that can be queried for progress.
+   * Permanently deletes up to 1,000 users at a time.
    *
    * @example
    * ```ts
@@ -25,8 +24,8 @@ export class Bulk extends APIResource {
 
   /**
    * Identifies multiple users in a single operation. Allows creating or updating up
-   * to 100 users in a single batch with various properties, preferences, and channel
-   * data.
+   * to 1,000 users in a single batch with various properties, preferences, and
+   * channel data.
    *
    * @example
    * ```ts
@@ -47,9 +46,11 @@ export class Bulk extends APIResource {
   }
 
   /**
-   * Sets preferences for multiple users in a single operation. Supports either
-   * setting the same preferences for multiple users or specific preferences for each
-   * user.
+   * Bulk sets the preferences for up to 1,000 users at a time. The preference
+   * set `:id` can be either `default` or a `tenant.id`. Learn more
+   * about [per-tenant preferences](/preferences/tenant-preferences). Note that this
+   * is a destructive operation and will replace any existing users' preferences with
+   * the preferences sent.
    *
    * @example
    * ```ts

package/src/resources/users/users.ts

@@ -389,6 +389,8 @@ export interface IdentifyUserRequest {
 
   /**
    * Inline set preferences for a recipient, where the key is the preference set id.
+   * Preferences that are set inline will be merged into any existing preferences
+   * rather than replacing them.
    */
   preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
 
@@ -453,6 +455,8 @@ export interface InlineIdentifyUserRequest {
 
   /**
    * Inline set preferences for a recipient, where the key is the preference set id.
+   * Preferences that are set inline will be merged into any existing preferences
+   * rather than replacing them.
    */
   preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
 
@@ -579,6 +583,8 @@ export interface UserUpdateParams {
 
   /**
    * Inline set preferences for a recipient, where the key is the preference set id.
+   * Preferences that are set inline will be merged into any existing preferences
+   * rather than replacing them.
    */
   preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.7.0'; // x-release-please-version
+export const VERSION = '1.9.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.7.0";
+export declare const VERSION = "1.9.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.7.0";
+export declare const VERSION = "1.9.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.7.0'; // x-release-please-version
+exports.VERSION = '1.9.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.7.0'; // x-release-please-version
+export const VERSION = '1.9.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map