@knocklabs/node 1.18.0 → 1.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.19.0 (2025-10-01)
4
+
5
+ Full Changelog: [v1.18.0...v1.19.0](https://github.com/knocklabs/knock-node/compare/v1.18.0...v1.19.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([77638d5](https://github.com/knocklabs/knock-node/commit/77638d578e7d53320b6e769d5529220bb3032f42))
10
+ * **api:** api update ([80cd964](https://github.com/knocklabs/knock-node/commit/80cd9646d8bcfaebd9c18fb6c308f4693366d7f0))
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * **KNO-9860:** fix user token signing examples in README ([#136](https://github.com/knocklabs/knock-node/issues/136)) ([e647568](https://github.com/knocklabs/knock-node/commit/e64756843ea9ac4957e3d9a562f8edcf0af57a53))
16
+
17
+
18
+ ### Performance Improvements
19
+
20
+ * faster formatting ([93c8fe7](https://github.com/knocklabs/knock-node/commit/93c8fe7d6ec9be9f1cd70029181f4d3e58e37193))
21
+
22
+
23
+ ### Chores
24
+
25
+ * **internal:** codegen related update ([eee4c5f](https://github.com/knocklabs/knock-node/commit/eee4c5f2399cc92ed164e3e39d04de15225d4699))
26
+ * **internal:** fix incremental formatting in some cases ([d1e199e](https://github.com/knocklabs/knock-node/commit/d1e199e9cc4e51b35adde1a4b4015e70c7044dd6))
27
+ * **internal:** ignore .eslintcache ([8d12e3e](https://github.com/knocklabs/knock-node/commit/8d12e3e558cfba633c8009800c30f92678c77acb))
28
+ * **internal:** remove .eslintcache ([fce85c8](https://github.com/knocklabs/knock-node/commit/fce85c8d4514d331a46d1ae8b03fcdec24b176cc))
29
+ * **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([cf940cd](https://github.com/knocklabs/knock-node/commit/cf940cdc4441f19b125780dc361a0d3ad868204a))
30
+
3
31
  ## 1.18.0 (2025-09-23)
4
32
 
5
33
  Full Changelog: [v1.17.1...v1.18.0](https://github.com/knocklabs/knock-node/compare/v1.17.1...v1.18.0)
package/README.md CHANGED
@@ -246,7 +246,7 @@ The SDK provides functionality to sign authentication tokens for client-side req
246
246
  By default, this SDK uses [`jose`](https://github.com/panva/jose) to sign JWTs. The latest version of `jose` only supports ESM, so if your project is built using CJS, and you're _not_ already running [a version of Node.js that supports loading ES modules using `require`](https://nodejs.org/api/modules.html#loading-ecmascript-modules-using-require), you'll need to take the following additional step to build with a CJS-compatible version of `jose`:
247
247
 
248
248
  - If you're using `npm`, add the `overrides` option to your `package.json` file to install `jose` v5:
249
-
249
+
250
250
  ```json
251
251
  {
252
252
  "dependencies": {
@@ -276,10 +276,10 @@ By default, this SDK uses [`jose`](https://github.com/panva/jose) to sign JWTs.
276
276
  #### Basic Usage
277
277
 
278
278
  ```ts
279
- import Knock from '@knocklabs/node';
279
+ import { signUserToken } from '@knocklabs/node';
280
280
 
281
281
  // Generate a JWT token for a user
282
- const token = await Knock.signUserToken('user-1');
282
+ const token = await signUserToken('user-1');
283
283
  ```
284
284
 
285
285
  #### Advanced Usage with Grants
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knocklabs/node",
3
- "version": "1.18.0",
3
+ "version": "1.19.0",
4
4
  "description": "The official TypeScript library for the Knock API",
5
5
  "author": "Knock <support@knock.app>",
6
6
  "types": "./index.d.ts",
@@ -83,7 +83,7 @@ export interface AudienceListMembersResponse {
83
83
  }
84
84
  export interface AudienceAddMembersParams {
85
85
  /**
86
- * A list of audience members to add.
86
+ * A list of audience members to add. Limited to 1,000 members per request.
87
87
  */
88
88
  members: Array<AudienceAddMembersParams.Member>;
89
89
  }
@@ -83,7 +83,7 @@ export interface AudienceListMembersResponse {
83
83
  }
84
84
  export interface AudienceAddMembersParams {
85
85
  /**
86
- * A list of audience members to add.
86
+ * A list of audience members to add. Limited to 1,000 members per request.
87
87
  */
88
88
  members: Array<AudienceAddMembersParams.Member>;
89
89
  }
@@ -5,7 +5,8 @@ import { APIPromise } from "../../core/api-promise.mjs";
5
5
  import { RequestOptions } from "../../internal/request-options.mjs";
6
6
  export declare class Bulk extends APIResource {
7
7
  /**
8
- * Delete multiple tenants in a single operation. This operation cannot be undone.
8
+ * Delete up to 100 tenants at a time in a single operation. This operation cannot
9
+ * be undone.
9
10
  *
10
11
  * @example
11
12
  * ```ts
@@ -16,7 +17,7 @@ export declare class Bulk extends APIResource {
16
17
  */
17
18
  delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
18
19
  /**
19
- * Set or update up to 1,000 tenants in a single operation.
20
+ * Set or update up to 100 tenants in a single operation.
20
21
  *
21
22
  * @example
22
23
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAKvG;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGhG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAC3F"}
1
+ {"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAKvG;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGhG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAC3F"}
@@ -5,7 +5,8 @@ import { APIPromise } from "../../core/api-promise.js";
5
5
  import { RequestOptions } from "../../internal/request-options.js";
6
6
  export declare class Bulk extends APIResource {
7
7
  /**
8
- * Delete multiple tenants in a single operation. This operation cannot be undone.
8
+ * Delete up to 100 tenants at a time in a single operation. This operation cannot
9
+ * be undone.
9
10
  *
10
11
  * @example
11
12
  * ```ts
@@ -16,7 +17,7 @@ export declare class Bulk extends APIResource {
16
17
  */
17
18
  delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
18
19
  /**
19
- * Set or update up to 1,000 tenants in a single operation.
20
+ * Set or update up to 100 tenants in a single operation.
20
21
  *
21
22
  * @example
22
23
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAKvG;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGhG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAC3F"}
1
+ {"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAKvG;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGhG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAC3F"}
@@ -5,7 +5,8 @@ exports.Bulk = void 0;
5
5
  const resource_1 = require("../../core/resource.js");
6
6
  class Bulk extends resource_1.APIResource {
7
7
  /**
8
- * Delete multiple tenants in a single operation. This operation cannot be undone.
8
+ * Delete up to 100 tenants at a time in a single operation. This operation cannot
9
+ * be undone.
9
10
  *
10
11
  * @example
11
12
  * ```ts
@@ -19,7 +20,7 @@ class Bulk extends resource_1.APIResource {
19
20
  return this._client.post('/v1/tenants/bulk/delete', { query: { tenant_ids }, ...options });
20
21
  }
21
22
  /**
22
- * Set or update up to 1,000 tenants in a single operation.
23
+ * Set or update up to 100 tenants in a single operation.
23
24
  *
24
25
  * @example
25
26
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA7BD,oBA6BC"}
1
+ {"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA9BD,oBA8BC"}
@@ -2,7 +2,8 @@
2
2
  import { APIResource } from "../../core/resource.mjs";
3
3
  export class Bulk extends APIResource {
4
4
  /**
5
- * Delete multiple tenants in a single operation. This operation cannot be undone.
5
+ * Delete up to 100 tenants at a time in a single operation. This operation cannot
6
+ * be undone.
6
7
  *
7
8
  * @example
8
9
  * ```ts
@@ -16,7 +17,7 @@ export class Bulk extends APIResource {
16
17
  return this._client.post('/v1/tenants/bulk/delete', { query: { tenant_ids }, ...options });
17
18
  }
18
19
  /**
19
- * Set or update up to 1,000 tenants in a single operation.
20
+ * Set or update up to 100 tenants in a single operation.
20
21
  *
21
22
  * @example
22
23
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}
1
+ {"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}
@@ -112,7 +112,7 @@ export interface AudienceListMembersResponse {
112
112
 
113
113
  export interface AudienceAddMembersParams {
114
114
  /**
115
- * A list of audience members to add.
115
+ * A list of audience members to add. Limited to 1,000 members per request.
116
116
  */
117
117
  members: Array<AudienceAddMembersParams.Member>;
118
118
  }
@@ -8,7 +8,8 @@ import { RequestOptions } from '../../internal/request-options';
8
8
 
9
9
  export class Bulk extends APIResource {
10
10
  /**
11
- * Delete multiple tenants in a single operation. This operation cannot be undone.
11
+ * Delete up to 100 tenants at a time in a single operation. This operation cannot
12
+ * be undone.
12
13
  *
13
14
  * @example
14
15
  * ```ts
@@ -23,7 +24,7 @@ export class Bulk extends APIResource {
23
24
  }
24
25
 
25
26
  /**
26
- * Set or update up to 1,000 tenants in a single operation.
27
+ * Set or update up to 100 tenants in a single operation.
27
28
  *
28
29
  * @example
29
30
  * ```ts
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.18.0'; // x-release-please-version
1
+ export const VERSION = '1.19.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.18.0";
1
+ export declare const VERSION = "1.19.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.18.0";
1
+ export declare const VERSION = "1.19.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '1.18.0'; // x-release-please-version
4
+ exports.VERSION = '1.19.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '1.18.0'; // x-release-please-version
1
+ export const VERSION = '1.19.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map