@or-sdk/api-tokens 1.0.1-beta.4055.0 → 1.1.1-beta.4112.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.
Files changed (6) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist/types/types.d.ts +13 -6
  3. package/dist/types/types.d.ts.map +1 -1
  4. package/package.json +1 -1
  5. package/src/ApiTokens.ts +1 -1
  6. package/src/types.ts +17 -7
package/CHANGELOG.md ADDED
@@ -0,0 +1,11 @@
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
+
6
+ ## 1.1.0 (2026-03-23)
7
+
8
+
9
+ ### Features
10
+
11
+ * **permissions:** add api token support ([4abbf15](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/4abbf15a567f94ddc8b3d9460693fa4f7ebc3fd2))
package/dist/types/types.d.ts CHANGED
@@ -4,18 +4,24 @@ export type ApiTokensConfig = {
4
4
  apiTokensUrl: string;
5
5
  discoveryUrl?: string;
6
6
  };
7
+ export type ApiTokenStatus = 'ACTIVE' | 'INACTIVE' | 'REVOKED' | 'EXPIRED';
8
+ export type CreatedByEntityType = 'FLOW' | 'USER' | 'SERVICE';
9
+ export type CreatedBy = {
10
+ entityType: CreatedByEntityType;
11
+ entityId: string;
12
+ };
7
13
  export type ApiToken = {
8
14
  id: string;
9
15
  name: string;
10
16
  token: string;
11
17
  role: string;
12
18
  accountId: string;
13
- isActive: boolean;
14
- isRevoked: boolean;
15
- expiresAt?: string;
16
- metadata?: Record<string, unknown>;
19
+ status: ApiTokenStatus;
20
+ expiresAt?: string | null;
21
+ revokedAt?: string | null;
22
+ metadata?: Record<string, unknown> | null;
17
23
  permissions?: string[];
18
- createdBy?: string;
24
+ createdBy?: CreatedBy | null;
19
25
  createdAt: string;
20
26
  updatedAt: string;
21
27
  };
@@ -27,7 +33,7 @@ export type CreateApiTokenDto = {
27
33
  };
28
34
  export type UpdateApiTokenDto = {
29
35
  name?: string;
30
- isActive?: boolean;
36
+ status?: 'ACTIVE' | 'INACTIVE';
31
37
  expiresAt?: string | null;
32
38
  metadata?: Record<string, unknown>;
33
39
  permissions?: string[];
@@ -39,6 +45,7 @@ export type ValidateApiTokenResponse = {
39
45
  expire?: number | null;
40
46
  accountId?: string;
41
47
  role?: string;
48
+ createdBy?: CreatedBy | null;
42
49
  permissions?: string[];
43
50
  };
44
51
  //# sourceMappingURL=types.d.ts.map
package/dist/types/types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,eAAe,GAAG;IAI5B,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,eAAe,GAAG;IAI5B,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;AAE3E,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9D,MAAM,MAAM,SAAS,GAAG;IACtB,UAAU,EAAE,mBAAmB,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC1C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/api-tokens",
3
- "version": "1.0.1-beta.4055.0",
3
+ "version": "1.1.1-beta.4112.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
package/src/ApiTokens.ts CHANGED
@@ -97,7 +97,7 @@ export class ApiTokens extends Base {
97
97
  * @param {string} id - API Token identifier
98
98
  * @param {UpdateApiTokenDto} params - Fields to update
99
99
  * @param {string} [params.name] - Name of the API token
100
- * @param {boolean} [params.isActive] - Whether the token is active
100
+ * @param {'ACTIVE'|'INACTIVE'} [params.status] - New status (use /revoke for REVOKED)
101
101
  * @param {string} [params.expiresAt] - Token expiration date (ISO 8601)
102
102
  * @param {Record<string, unknown>} [params.metadata] - Additional metadata
103
103
  * @param {string[]} [params.permissions] - Replace all linked permissions
package/src/types.ts CHANGED
@@ -12,18 +12,27 @@ export type ApiTokensConfig = {
12
12
  discoveryUrl?: string;
13
13
  };
14
14
 
15
+ export type ApiTokenStatus = 'ACTIVE' | 'INACTIVE' | 'REVOKED' | 'EXPIRED';
16
+
17
+ export type CreatedByEntityType = 'FLOW' | 'USER' | 'SERVICE';
18
+
19
+ export type CreatedBy = {
20
+ entityType: CreatedByEntityType;
21
+ entityId: string;
22
+ };
23
+
15
24
  export type ApiToken = {
16
25
  id: string;
17
26
  name: string;
18
27
  token: string;
19
28
  role: string;
20
29
  accountId: string;
21
- isActive: boolean;
22
- isRevoked: boolean;
23
- expiresAt?: string;
24
- metadata?: Record<string, unknown>;
30
+ status: ApiTokenStatus;
31
+ expiresAt?: string | null;
32
+ revokedAt?: string | null;
33
+ metadata?: Record<string, unknown> | null;
25
34
  permissions?: string[];
26
- createdBy?: string;
35
+ createdBy?: CreatedBy | null;
27
36
  createdAt: string;
28
37
  updatedAt: string;
29
38
  };
@@ -42,8 +51,8 @@ export type CreateApiTokenDto = {
42
51
  export type UpdateApiTokenDto = {
43
52
  /** Name of the API token */
44
53
  name?: string;
45
- /** Whether the token is active */
46
- isActive?: boolean;
54
+ /** Token status — only ACTIVE/INACTIVE may be set; revoke uses dedicated endpoint */
55
+ status?: 'ACTIVE' | 'INACTIVE';
47
56
  /** Token expiration date (ISO 8601) */
48
57
  expiresAt?: string | null;
49
58
  /** Additional metadata */
@@ -59,5 +68,6 @@ export type ValidateApiTokenResponse = {
59
68
  expire?: number | null;
60
69
  accountId?: string;
61
70
  role?: string;
71
+ createdBy?: CreatedBy | null;
62
72
  permissions?: string[];
63
73
  };