@workos-inc/node 3.0.0-user-management.1 → 3.0.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 (211) hide show
  1. package/lib/audit-logs/audit-logs.js +5 -4
  2. package/lib/audit-logs/audit-logs.spec.js +87 -88
  3. package/lib/audit-logs/interfaces/audit-log-export-options.interface.d.ts +13 -3
  4. package/lib/audit-logs/interfaces/audit-log-export.interface.d.ts +8 -0
  5. package/lib/audit-logs/interfaces/create-audit-log-event-options.interface.d.ts +13 -1
  6. package/lib/audit-logs/serializers/audit-log-export-options.serializer.d.ts +2 -0
  7. package/lib/audit-logs/serializers/audit-log-export-options.serializer.js +14 -0
  8. package/lib/audit-logs/serializers/audit-log-export.serializer.d.ts +2 -0
  9. package/lib/audit-logs/serializers/audit-log-export.serializer.js +12 -0
  10. package/lib/audit-logs/serializers/create-audit-log-event-options.serializer.d.ts +2 -0
  11. package/lib/audit-logs/serializers/create-audit-log-event-options.serializer.js +16 -0
  12. package/lib/audit-logs/serializers/index.d.ts +3 -0
  13. package/lib/audit-logs/serializers/index.js +19 -0
  14. package/lib/audit-trail/audit-trail.d.ts +2 -2
  15. package/lib/common/interfaces/at-least-one-property-of.interface.d.ts +7 -0
  16. package/lib/common/interfaces/event.interface.d.ts +142 -0
  17. package/lib/common/interfaces/index.d.ts +4 -0
  18. package/lib/common/interfaces/index.js +4 -0
  19. package/lib/common/interfaces/list.interface.d.ts +9 -1
  20. package/lib/common/serializers/event.serializer.d.ts +2 -0
  21. package/lib/common/serializers/event.serializer.js +40 -0
  22. package/lib/common/serializers/index.d.ts +2 -0
  23. package/lib/common/serializers/index.js +18 -0
  24. package/lib/common/serializers/list.serializer.d.ts +2 -0
  25. package/lib/common/serializers/list.serializer.js +9 -0
  26. package/lib/common/utils/fetch-and-deserialize.d.ts +3 -0
  27. package/lib/common/utils/fetch-and-deserialize.js +23 -0
  28. package/lib/common/utils/pagination.d.ts +15 -0
  29. package/lib/common/utils/pagination.js +90 -0
  30. package/lib/common/utils/workos-mock-response.d.ts +7 -0
  31. package/lib/common/utils/workos-mock-response.js +11 -0
  32. package/lib/directory-sync/directory-sync.d.ts +8 -12
  33. package/lib/directory-sync/directory-sync.js +9 -15
  34. package/lib/directory-sync/directory-sync.spec.js +132 -20
  35. package/lib/directory-sync/interfaces/directory-group.interface.d.ts +40 -0
  36. package/lib/directory-sync/interfaces/directory-user.interface.d.ts +50 -0
  37. package/lib/directory-sync/interfaces/directory.interface.d.ts +47 -2
  38. package/lib/directory-sync/interfaces/index.d.ts +6 -6
  39. package/lib/directory-sync/interfaces/index.js +20 -0
  40. package/lib/directory-sync/interfaces/list-directories-options.interface.d.ts +1 -1
  41. package/lib/directory-sync/interfaces/{list-users-options.interface.d.ts → list-directory-users-options.interface.d.ts} +1 -1
  42. package/lib/directory-sync/interfaces/list-groups-options.interface.d.ts +1 -1
  43. package/lib/directory-sync/serializers/directory-group.serializer.d.ts +4 -0
  44. package/lib/directory-sync/serializers/directory-group.serializer.js +37 -0
  45. package/lib/directory-sync/serializers/directory-user.serializer.d.ts +4 -0
  46. package/lib/directory-sync/serializers/directory-user.serializer.js +43 -0
  47. package/lib/directory-sync/serializers/directory.serializer.d.ts +5 -0
  48. package/lib/directory-sync/serializers/directory.serializer.js +50 -0
  49. package/lib/directory-sync/serializers/index.d.ts +3 -0
  50. package/lib/directory-sync/serializers/index.js +19 -0
  51. package/lib/directory-sync/utils/get-primary-email.d.ts +2 -2
  52. package/lib/directory-sync/utils/get-primary-email.spec.js +11 -8
  53. package/lib/events/events.d.ts +1 -2
  54. package/lib/events/events.js +2 -1
  55. package/lib/events/events.spec.js +39 -5
  56. package/lib/events/interfaces/index.d.ts +0 -1
  57. package/lib/events/interfaces/index.js +0 -1
  58. package/lib/events/interfaces/list-events-options.interface.d.ts +4 -4
  59. package/lib/index.d.ts +1 -1
  60. package/lib/index.js +1 -1
  61. package/lib/mfa/interfaces/challenge.interface.d.ts +9 -0
  62. package/lib/mfa/interfaces/factor.interface.d.ts +13 -4
  63. package/lib/mfa/interfaces/index.d.ts +9 -0
  64. package/lib/mfa/interfaces/index.js +25 -0
  65. package/lib/mfa/interfaces/sms.interface.d.ts +3 -0
  66. package/lib/mfa/interfaces/totp.interface.d.ts +7 -0
  67. package/lib/mfa/interfaces/verify-challenge-response.d.ts +5 -1
  68. package/lib/mfa/mfa.d.ts +2 -8
  69. package/lib/mfa/mfa.js +5 -4
  70. package/lib/mfa/mfa.spec.js +134 -115
  71. package/lib/mfa/serializers/challenge.serializer.d.ts +2 -0
  72. package/lib/mfa/serializers/challenge.serializer.js +13 -0
  73. package/lib/mfa/serializers/factor.serializer.d.ts +2 -0
  74. package/lib/mfa/serializers/factor.serializer.js +7 -0
  75. package/lib/mfa/serializers/index.d.ts +3 -0
  76. package/lib/{webhooks/interfaces → mfa/serializers}/index.js +3 -4
  77. package/lib/mfa/serializers/sms.serializer.d.ts +2 -0
  78. package/lib/mfa/serializers/sms.serializer.js +7 -0
  79. package/lib/mfa/serializers/totp.serializer.d.ts +2 -0
  80. package/lib/mfa/serializers/totp.serializer.js +11 -0
  81. package/lib/mfa/serializers/verify-response.serializer.d.ts +2 -0
  82. package/lib/mfa/serializers/verify-response.serializer.js +9 -0
  83. package/lib/organizations/interfaces/create-organization-options.interface.d.ts +5 -0
  84. package/lib/organizations/interfaces/organization.interface.d.ts +9 -0
  85. package/lib/organizations/interfaces/update-organization-options.interface.d.ts +5 -0
  86. package/lib/organizations/organizations.d.ts +2 -2
  87. package/lib/organizations/organizations.js +9 -9
  88. package/lib/organizations/organizations.spec.js +9 -3
  89. package/lib/organizations/serializers/create-organization-options.serializer.d.ts +2 -0
  90. package/lib/organizations/serializers/create-organization-options.serializer.js +9 -0
  91. package/lib/organizations/serializers/index.d.ts +3 -0
  92. package/lib/organizations/serializers/index.js +19 -0
  93. package/lib/organizations/serializers/organization.serializer.d.ts +2 -0
  94. package/lib/organizations/serializers/organization.serializer.js +13 -0
  95. package/lib/organizations/serializers/update-organization-options.serializer.d.ts +2 -0
  96. package/lib/organizations/serializers/update-organization-options.serializer.js +9 -0
  97. package/lib/passwordless/interfaces/create-passwordless-session-options.interface.d.ts +8 -0
  98. package/lib/passwordless/interfaces/index.d.ts +3 -3
  99. package/lib/passwordless/interfaces/index.js +17 -0
  100. package/lib/passwordless/interfaces/passwordless-session.interface.d.ts +7 -0
  101. package/lib/passwordless/passwordless.d.ts +1 -3
  102. package/lib/passwordless/passwordless.js +2 -1
  103. package/lib/passwordless/serializers/index.d.ts +0 -0
  104. package/lib/passwordless/serializers/index.js +1 -0
  105. package/lib/passwordless/serializers/passwordless-session.serializer.d.ts +2 -0
  106. package/lib/passwordless/serializers/passwordless-session.serializer.js +11 -0
  107. package/lib/sso/interfaces/connection.interface.d.ts +15 -4
  108. package/lib/sso/interfaces/index.d.ts +2 -0
  109. package/lib/sso/interfaces/index.js +2 -0
  110. package/lib/sso/interfaces/list-connections-options.interface.d.ts +5 -0
  111. package/lib/sso/interfaces/profile-and-token.interface.d.ts +6 -2
  112. package/lib/sso/interfaces/profile.interface.d.ts +14 -0
  113. package/lib/sso/serializers/connection.serializer.d.ts +2 -0
  114. package/lib/sso/serializers/connection.serializer.js +16 -0
  115. package/lib/sso/serializers/index.d.ts +3 -0
  116. package/lib/sso/serializers/index.js +19 -0
  117. package/lib/sso/serializers/profile-and-token.serializer.d.ts +2 -0
  118. package/lib/sso/serializers/profile-and-token.serializer.js +9 -0
  119. package/lib/sso/serializers/profile.serializer.d.ts +2 -0
  120. package/lib/sso/serializers/profile.serializer.js +16 -0
  121. package/lib/sso/sso.d.ts +3 -9
  122. package/lib/sso/sso.js +11 -11
  123. package/lib/sso/sso.spec.js +23 -6
  124. package/lib/users/exceptions/index.d.ts +4 -0
  125. package/lib/users/exceptions/index.js +10 -0
  126. package/lib/users/fixtures/list-users.json +0 -1
  127. package/lib/users/fixtures/session.json +2 -0
  128. package/lib/users/fixtures/user.json +0 -1
  129. package/lib/users/interfaces/add-user-to-organization-options.interface.d.ts +4 -1
  130. package/lib/users/interfaces/authenticate-user-with-magic-auth-options.interface.d.ts +21 -0
  131. package/lib/users/interfaces/authenticate-user-with-password-options.interface.d.ts +14 -1
  132. package/lib/users/interfaces/authenticate-user-with-token-options.interface.d.ts +10 -1
  133. package/lib/users/interfaces/authentication-response.interface.d.ts +7 -3
  134. package/lib/users/interfaces/complete-password-reset-options.interface.d.ts +4 -0
  135. package/lib/users/interfaces/create-email-verification-challenge-options.interface.d.ts +9 -2
  136. package/lib/users/interfaces/create-password-reset-challenge-options.interface.d.ts +9 -1
  137. package/lib/users/interfaces/create-user-options.interface.d.ts +8 -1
  138. package/lib/users/interfaces/index.d.ts +7 -0
  139. package/lib/users/interfaces/index.js +7 -0
  140. package/lib/users/interfaces/magic-auth-challenge.interface.d.ts +3 -0
  141. package/lib/users/interfaces/remove-user-from-organization-options.interface.d.ts +2 -2
  142. package/lib/users/interfaces/revoke-all-sessions-for-user-options.interface.d.ts +3 -0
  143. package/lib/users/interfaces/revoke-session-options.interface.d.ts +7 -0
  144. package/lib/users/interfaces/send-magic-auth-code-options.interface.d.ts +6 -0
  145. package/lib/users/interfaces/send-magic-auth-code-options.interface.js +2 -0
  146. package/lib/users/interfaces/session.interface.d.ts +35 -0
  147. package/lib/users/interfaces/update-user-options.interface.d.ts +14 -0
  148. package/lib/users/interfaces/update-user-options.interface.js +2 -0
  149. package/lib/users/interfaces/update-user-password-options.interface.d.ts +7 -0
  150. package/lib/users/interfaces/update-user-password-options.interface.js +2 -0
  151. package/lib/users/interfaces/user.interface.d.ts +28 -18
  152. package/lib/users/interfaces/verify-session.interface.d.ts +10 -2
  153. package/lib/users/serializers/authenticate-user-with-magic-auth-options.serializer.d.ts +2 -0
  154. package/lib/users/serializers/authenticate-user-with-magic-auth-options.serializer.js +14 -0
  155. package/lib/users/serializers/authenticate-user-with-password-options.serializer.d.ts +2 -0
  156. package/lib/users/serializers/authenticate-user-with-password-options.serializer.js +14 -0
  157. package/lib/users/serializers/authenticate-user-with-token-options.serializer.d.ts +2 -0
  158. package/lib/users/serializers/authenticate-user-with-token-options.serializer.js +11 -0
  159. package/lib/users/serializers/authentication-response.serializer.d.ts +2 -0
  160. package/lib/users/serializers/authentication-response.serializer.js +10 -0
  161. package/lib/users/serializers/complete-password-reset-options.serializer.d.ts +2 -0
  162. package/lib/users/serializers/complete-password-reset-options.serializer.js +8 -0
  163. package/lib/users/serializers/create-email-verification-challenge.serializer.d.ts +2 -0
  164. package/lib/users/serializers/create-email-verification-challenge.serializer.js +9 -0
  165. package/lib/users/serializers/create-password-reset-challenge.serializer.d.ts +3 -0
  166. package/lib/users/serializers/create-password-reset-challenge.serializer.js +14 -0
  167. package/lib/users/serializers/create-user-options.serializer.d.ts +2 -0
  168. package/lib/users/serializers/create-user-options.serializer.js +11 -0
  169. package/lib/users/serializers/index.d.ts +15 -0
  170. package/lib/users/serializers/index.js +31 -0
  171. package/lib/users/serializers/revoke-session-options.serializer.d.ts +2 -0
  172. package/lib/users/serializers/revoke-session-options.serializer.js +14 -0
  173. package/lib/users/serializers/send-magic-auth-code-options.serializer.d.ts +2 -0
  174. package/lib/users/serializers/send-magic-auth-code-options.serializer.js +7 -0
  175. package/lib/users/serializers/session.serializer.d.ts +4 -0
  176. package/lib/users/serializers/session.serializer.js +22 -0
  177. package/lib/users/serializers/update-user-options.serializer.d.ts +2 -0
  178. package/lib/users/serializers/update-user-options.serializer.js +8 -0
  179. package/lib/users/serializers/update-user-password-options.serializer.d.ts +2 -0
  180. package/lib/users/serializers/update-user-password-options.serializer.js +7 -0
  181. package/lib/users/serializers/user.serializer.d.ts +2 -0
  182. package/lib/users/serializers/user.serializer.js +24 -0
  183. package/lib/users/serializers/verify-session.serializer.d.ts +3 -0
  184. package/lib/users/serializers/verify-session.serializer.js +15 -0
  185. package/lib/users/users.d.ts +11 -7
  186. package/lib/users/users.js +54 -30
  187. package/lib/users/users.spec.js +133 -49
  188. package/lib/webhooks/fixtures/webhook.json +67 -1
  189. package/lib/webhooks/webhooks.d.ts +2 -2
  190. package/lib/webhooks/webhooks.js +2 -1
  191. package/lib/webhooks/webhooks.spec.js +8 -6
  192. package/lib/workos.d.ts +5 -4
  193. package/lib/workos.js +4 -1
  194. package/lib/workos.spec.js +11 -1
  195. package/package.json +4 -4
  196. package/lib/directory-sync/interfaces/group.interface.d.ts +0 -10
  197. package/lib/directory-sync/interfaces/user.interface.d.ts +0 -23
  198. package/lib/events/interfaces/event.interface.d.ts +0 -63
  199. package/lib/webhooks/interfaces/index.d.ts +0 -4
  200. package/lib/webhooks/interfaces/webhook-directory-group.interface.d.ts +0 -10
  201. package/lib/webhooks/interfaces/webhook-directory-user.interface.d.ts +0 -5
  202. package/lib/webhooks/interfaces/webhook-directory.interface.d.ts +0 -20
  203. package/lib/webhooks/interfaces/webhook.interface.d.ts +0 -74
  204. /package/lib/{directory-sync/interfaces/group.interface.js → common/interfaces/at-least-one-property-of.interface.js} +0 -0
  205. /package/lib/{events → common}/interfaces/event.interface.js +0 -0
  206. /package/lib/directory-sync/interfaces/{list-users-options.interface.js → directory-group.interface.js} +0 -0
  207. /package/lib/directory-sync/interfaces/{user.interface.js → directory-user.interface.js} +0 -0
  208. /package/lib/{webhooks/interfaces/webhook-directory-group.interface.js → directory-sync/interfaces/list-directory-users-options.interface.js} +0 -0
  209. /package/lib/{webhooks/interfaces/webhook-directory-user.interface.js → users/interfaces/authenticate-user-with-magic-auth-options.interface.js} +0 -0
  210. /package/lib/{webhooks/interfaces/webhook-directory.interface.js → users/interfaces/magic-auth-challenge.interface.js} +0 -0
  211. /package/lib/{webhooks/interfaces/webhook.interface.js → users/interfaces/revoke-all-sessions-for-user-options.interface.js} +0 -0
@@ -0,0 +1,40 @@
1
+ export interface DirectoryGroup {
2
+ id: string;
3
+ idpId: string;
4
+ directoryId: string;
5
+ organizationId: string | null;
6
+ name: string;
7
+ createdAt: string;
8
+ updatedAt: string;
9
+ rawAttributes: any;
10
+ }
11
+ export interface DirectoryGroupResponse {
12
+ id: string;
13
+ idp_id: string;
14
+ directory_id: string;
15
+ organization_id: string | null;
16
+ name: string;
17
+ created_at: string;
18
+ updated_at: string;
19
+ raw_attributes: any;
20
+ }
21
+ export interface EventDirectoryGroup<TRawAttributes = any> {
22
+ id: string;
23
+ idpId: string;
24
+ directoryId: string;
25
+ organizationId: string | null;
26
+ name: string;
27
+ createdAt: string;
28
+ updatedAt: string;
29
+ rawAttributes: TRawAttributes;
30
+ }
31
+ export interface EventDirectoryGroupResponse<TRawAttributes = any> {
32
+ id: string;
33
+ idp_id: string;
34
+ directory_id: string;
35
+ organization_id: string | null;
36
+ name: string;
37
+ created_at: string;
38
+ updated_at: string;
39
+ raw_attributes: TRawAttributes;
40
+ }
@@ -0,0 +1,50 @@
1
+ import { DirectoryGroup, DirectoryGroupResponse } from './directory-group.interface';
2
+ export type DefaultCustomAttributes = Record<string, unknown>;
3
+ export interface DirectoryUser<TCustomAttributes extends object = DefaultCustomAttributes, TRawAttributes = any> {
4
+ object: 'directory_user';
5
+ id: string;
6
+ directoryId: string;
7
+ organizationId: string | null;
8
+ rawAttributes: TRawAttributes;
9
+ customAttributes: TCustomAttributes;
10
+ idpId: string;
11
+ firstName: string;
12
+ emails: {
13
+ type: string;
14
+ value: string;
15
+ primary: boolean;
16
+ }[];
17
+ username: string;
18
+ lastName: string;
19
+ jobTitle: string | null;
20
+ state: 'active' | 'inactive' | 'suspended';
21
+ createdAt: string;
22
+ updatedAt: string;
23
+ }
24
+ export interface DirectoryUserResponse<TCustomAttributes extends object = DefaultCustomAttributes, TRawAttributes = any> {
25
+ object: 'directory_user';
26
+ id: string;
27
+ directory_id: string;
28
+ organization_id: string | null;
29
+ raw_attributes: TRawAttributes;
30
+ custom_attributes: TCustomAttributes;
31
+ idp_id: string;
32
+ first_name: string;
33
+ emails: {
34
+ type: string;
35
+ value: string;
36
+ primary: boolean;
37
+ }[];
38
+ username: string;
39
+ last_name: string;
40
+ job_title: string | null;
41
+ state: 'active' | 'inactive' | 'suspended';
42
+ created_at: string;
43
+ updated_at: string;
44
+ }
45
+ export interface DirectoryUserWithGroups<TCustomAttributes extends object = DefaultCustomAttributes> extends DirectoryUser<TCustomAttributes> {
46
+ groups: DirectoryGroup[];
47
+ }
48
+ export interface DirectoryUserWithGroupsResponse<TCustomAttributes extends object = DefaultCustomAttributes> extends DirectoryUserResponse<TCustomAttributes> {
49
+ groups: DirectoryGroupResponse[];
50
+ }
@@ -1,12 +1,57 @@
1
+ export type DirectoryType = 'azure scim v2.0' | 'bamboohr' | 'breathe hr' | 'cezanne hr' | 'cyberark scim v2.0' | 'fourth hr' | 'gsuite directory' | 'generic scim v1.1' | 'generic scim v2.0' | 'gusto' | 'hibob' | 'jump cloud scim v2.0' | 'okta scim v1.1' | 'okta scim v2.0' | 'onelogin scim v2.0' | 'people hr' | 'personio' | 'pingfederate scim v2.0' | 'rippling' | 'rippling scim v2.0' | 'sftp' | 'sftp workday' | 's3' | 'workday';
2
+ export type DirectoryState = 'active' | 'deleting' | 'inactive' | 'invalid_credentials' | 'validating';
3
+ export type DirectoryStateResponse = 'deleting' | 'invalid_credentials' | 'linked' | 'unlinked' | 'validating';
1
4
  export interface Directory {
2
5
  object: 'directory';
3
6
  id: string;
4
7
  domain: string;
8
+ externalKey: string;
9
+ name: string;
10
+ organizationId?: string;
11
+ state: DirectoryState;
12
+ type: DirectoryType;
13
+ createdAt: string;
14
+ updatedAt: string;
15
+ }
16
+ export interface DirectoryResponse {
17
+ object: 'directory';
18
+ id: string;
19
+ domain: string;
20
+ external_key: string;
21
+ name: string;
22
+ organization_id?: string;
23
+ state: DirectoryStateResponse;
24
+ type: DirectoryType;
25
+ created_at: string;
26
+ updated_at: string;
27
+ }
28
+ interface EventDirectoryDomain {
29
+ object: 'organization_domain';
30
+ id: string;
31
+ domain: string;
32
+ }
33
+ export interface EventDirectory {
34
+ object: 'directory';
35
+ id: string;
36
+ externalKey: string;
37
+ type: DirectoryType;
38
+ state: DirectoryState;
39
+ name: string;
40
+ organizationId?: string;
41
+ domains: EventDirectoryDomain[];
42
+ createdAt: string;
43
+ updatedAt: string;
44
+ }
45
+ export interface EventDirectoryResponse {
46
+ object: 'directory';
47
+ id: string;
5
48
  external_key: string;
49
+ type: DirectoryType;
50
+ state: DirectoryState;
6
51
  name: string;
7
52
  organization_id?: string;
8
- state: 'unlinked' | 'linked' | 'invalid_credentials';
9
- type: string;
53
+ domains: EventDirectoryDomain[];
10
54
  created_at: string;
11
55
  updated_at: string;
12
56
  }
57
+ export {};
@@ -1,6 +1,6 @@
1
- export { Directory } from './directory.interface';
2
- export { Group } from './group.interface';
3
- export { ListDirectoriesOptions } from './list-directories-options.interface';
4
- export { ListGroupsOptions } from './list-groups-options.interface';
5
- export { ListUsersOptions } from './list-users-options.interface';
6
- export { User, UserWithGroups } from './user.interface';
1
+ export * from './directory.interface';
2
+ export * from './directory-group.interface';
3
+ export * from './list-directories-options.interface';
4
+ export * from './list-groups-options.interface';
5
+ export * from './list-directory-users-options.interface';
6
+ export * from './directory-user.interface';
@@ -1,2 +1,22 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
2
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./directory.interface"), exports);
18
+ __exportStar(require("./directory-group.interface"), exports);
19
+ __exportStar(require("./list-directories-options.interface"), exports);
20
+ __exportStar(require("./list-groups-options.interface"), exports);
21
+ __exportStar(require("./list-directory-users-options.interface"), exports);
22
+ __exportStar(require("./directory-user.interface"), exports);
@@ -1,6 +1,6 @@
1
1
  import { PaginationOptions } from '../../common/interfaces/pagination-options.interface';
2
2
  export interface ListDirectoriesOptions extends PaginationOptions {
3
3
  domain?: string;
4
- organization_id?: string;
4
+ organizationId?: string;
5
5
  search?: string;
6
6
  }
@@ -1,5 +1,5 @@
1
1
  import { PaginationOptions } from '../../common/interfaces/pagination-options.interface';
2
- export interface ListUsersOptions extends PaginationOptions {
2
+ export interface ListDirectoryUsersOptions extends PaginationOptions {
3
3
  directory?: string;
4
4
  group?: string;
5
5
  }
@@ -1,5 +1,5 @@
1
1
  import { PaginationOptions } from '../../common/interfaces/pagination-options.interface';
2
- export interface ListGroupsOptions extends PaginationOptions {
2
+ export interface ListDirectoryGroupsOptions extends PaginationOptions {
3
3
  directory?: string;
4
4
  user?: string;
5
5
  }
@@ -0,0 +1,4 @@
1
+ import { DirectoryGroup, DirectoryGroupResponse, EventDirectoryGroup, EventDirectoryGroupResponse } from '../interfaces';
2
+ export declare const deserializeDirectoryGroup: (directoryGroup: DirectoryGroupResponse) => DirectoryGroup;
3
+ export declare const deserializeEventDirectoryGroup: (directoryGroup: EventDirectoryGroupResponse) => EventDirectoryGroup;
4
+ export declare const deserializeUpdatedEventDirectoryGroup: (directoryGroup: EventDirectoryGroupResponse & Record<'previous_attributes', any>) => EventDirectoryGroup & Record<'previousAttributes', any>;
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.deserializeUpdatedEventDirectoryGroup = exports.deserializeEventDirectoryGroup = exports.deserializeDirectoryGroup = void 0;
4
+ const deserializeDirectoryGroup = (directoryGroup) => ({
5
+ id: directoryGroup.id,
6
+ idpId: directoryGroup.idp_id,
7
+ directoryId: directoryGroup.directory_id,
8
+ organizationId: directoryGroup.organization_id,
9
+ name: directoryGroup.name,
10
+ createdAt: directoryGroup.created_at,
11
+ updatedAt: directoryGroup.updated_at,
12
+ rawAttributes: directoryGroup.raw_attributes,
13
+ });
14
+ exports.deserializeDirectoryGroup = deserializeDirectoryGroup;
15
+ const deserializeEventDirectoryGroup = (directoryGroup) => ({
16
+ id: directoryGroup.id,
17
+ idpId: directoryGroup.idp_id,
18
+ directoryId: directoryGroup.directory_id,
19
+ organizationId: directoryGroup.organization_id,
20
+ name: directoryGroup.name,
21
+ createdAt: directoryGroup.created_at,
22
+ updatedAt: directoryGroup.updated_at,
23
+ rawAttributes: directoryGroup.raw_attributes,
24
+ });
25
+ exports.deserializeEventDirectoryGroup = deserializeEventDirectoryGroup;
26
+ const deserializeUpdatedEventDirectoryGroup = (directoryGroup) => ({
27
+ id: directoryGroup.id,
28
+ idpId: directoryGroup.idp_id,
29
+ directoryId: directoryGroup.directory_id,
30
+ organizationId: directoryGroup.organization_id,
31
+ name: directoryGroup.name,
32
+ createdAt: directoryGroup.created_at,
33
+ updatedAt: directoryGroup.updated_at,
34
+ rawAttributes: directoryGroup.raw_attributes,
35
+ previousAttributes: directoryGroup.previous_attributes,
36
+ });
37
+ exports.deserializeUpdatedEventDirectoryGroup = deserializeUpdatedEventDirectoryGroup;
@@ -0,0 +1,4 @@
1
+ import { DefaultCustomAttributes, DirectoryUser, DirectoryUserResponse, DirectoryUserWithGroups, DirectoryUserWithGroupsResponse } from '../interfaces';
2
+ export declare const deserializeDirectoryUser: <TCustomAttributes extends object = DefaultCustomAttributes>(directoryUser: DirectoryUserResponse<TCustomAttributes, any> | DirectoryUserWithGroupsResponse<TCustomAttributes>) => DirectoryUser<TCustomAttributes, any>;
3
+ export declare const deserializeDirectoryUserWithGroups: <TCustomAttributes extends object = DefaultCustomAttributes>(directoryUserWithGroups: DirectoryUserWithGroupsResponse<TCustomAttributes>) => DirectoryUserWithGroups<TCustomAttributes>;
4
+ export declare const deserializeUpdatedEventDirectoryUser: (directoryUser: DirectoryUserResponse & Record<'previous_attributes', any>) => DirectoryUser & Record<'previousAttributes', any>;
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.deserializeUpdatedEventDirectoryUser = exports.deserializeDirectoryUserWithGroups = exports.deserializeDirectoryUser = void 0;
4
+ const directory_group_serializer_1 = require("./directory-group.serializer");
5
+ const deserializeDirectoryUser = (directoryUser) => ({
6
+ object: directoryUser.object,
7
+ id: directoryUser.id,
8
+ directoryId: directoryUser.directory_id,
9
+ organizationId: directoryUser.organization_id,
10
+ rawAttributes: directoryUser.raw_attributes,
11
+ customAttributes: directoryUser.custom_attributes,
12
+ idpId: directoryUser.idp_id,
13
+ firstName: directoryUser.first_name,
14
+ emails: directoryUser.emails,
15
+ username: directoryUser.username,
16
+ lastName: directoryUser.last_name,
17
+ jobTitle: directoryUser.job_title,
18
+ state: directoryUser.state,
19
+ createdAt: directoryUser.created_at,
20
+ updatedAt: directoryUser.updated_at,
21
+ });
22
+ exports.deserializeDirectoryUser = deserializeDirectoryUser;
23
+ const deserializeDirectoryUserWithGroups = (directoryUserWithGroups) => (Object.assign(Object.assign({}, (0, exports.deserializeDirectoryUser)(directoryUserWithGroups)), { groups: directoryUserWithGroups.groups.map(directory_group_serializer_1.deserializeDirectoryGroup) }));
24
+ exports.deserializeDirectoryUserWithGroups = deserializeDirectoryUserWithGroups;
25
+ const deserializeUpdatedEventDirectoryUser = (directoryUser) => ({
26
+ object: 'directory_user',
27
+ id: directoryUser.id,
28
+ directoryId: directoryUser.directory_id,
29
+ organizationId: directoryUser.organization_id,
30
+ rawAttributes: directoryUser.raw_attributes,
31
+ customAttributes: directoryUser.custom_attributes,
32
+ idpId: directoryUser.idp_id,
33
+ firstName: directoryUser.first_name,
34
+ emails: directoryUser.emails,
35
+ username: directoryUser.username,
36
+ lastName: directoryUser.last_name,
37
+ jobTitle: directoryUser.job_title,
38
+ state: directoryUser.state,
39
+ createdAt: directoryUser.created_at,
40
+ updatedAt: directoryUser.updated_at,
41
+ previousAttributes: directoryUser.previous_attributes,
42
+ });
43
+ exports.deserializeUpdatedEventDirectoryUser = deserializeUpdatedEventDirectoryUser;
@@ -0,0 +1,5 @@
1
+ import { Directory, DirectoryResponse, DirectoryState, DirectoryStateResponse, EventDirectory, EventDirectoryResponse } from '../interfaces';
2
+ export declare const deserializeDirectory: (directory: DirectoryResponse) => Directory;
3
+ export declare const deserializeDirectoryState: (state: DirectoryStateResponse) => DirectoryState;
4
+ export declare const deserializeEventDirectory: (directory: EventDirectoryResponse) => EventDirectory;
5
+ export declare const deserializeDeletedEventDirectory: (directory: Omit<EventDirectoryResponse, 'domains' | 'external_key'>) => Omit<EventDirectory, 'domains' | 'externalKey'>;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.deserializeDeletedEventDirectory = exports.deserializeEventDirectory = exports.deserializeDirectoryState = exports.deserializeDirectory = void 0;
4
+ const deserializeDirectory = (directory) => ({
5
+ object: directory.object,
6
+ id: directory.id,
7
+ domain: directory.domain,
8
+ externalKey: directory.external_key,
9
+ name: directory.name,
10
+ organizationId: directory.organization_id,
11
+ state: (0, exports.deserializeDirectoryState)(directory.state),
12
+ type: directory.type,
13
+ createdAt: directory.created_at,
14
+ updatedAt: directory.updated_at,
15
+ });
16
+ exports.deserializeDirectory = deserializeDirectory;
17
+ const deserializeDirectoryState = (state) => {
18
+ if (state === 'linked') {
19
+ return 'active';
20
+ }
21
+ if (state === 'unlinked') {
22
+ return 'inactive';
23
+ }
24
+ return state;
25
+ };
26
+ exports.deserializeDirectoryState = deserializeDirectoryState;
27
+ const deserializeEventDirectory = (directory) => ({
28
+ object: directory.object,
29
+ id: directory.id,
30
+ externalKey: directory.external_key,
31
+ type: directory.type,
32
+ state: directory.state,
33
+ name: directory.name,
34
+ organizationId: directory.organization_id,
35
+ domains: directory.domains,
36
+ createdAt: directory.created_at,
37
+ updatedAt: directory.updated_at,
38
+ });
39
+ exports.deserializeEventDirectory = deserializeEventDirectory;
40
+ const deserializeDeletedEventDirectory = (directory) => ({
41
+ object: directory.object,
42
+ id: directory.id,
43
+ type: directory.type,
44
+ state: directory.state,
45
+ name: directory.name,
46
+ organizationId: directory.organization_id,
47
+ createdAt: directory.created_at,
48
+ updatedAt: directory.updated_at,
49
+ });
50
+ exports.deserializeDeletedEventDirectory = deserializeDeletedEventDirectory;
@@ -0,0 +1,3 @@
1
+ export * from './directory-group.serializer';
2
+ export * from './directory-user.serializer';
3
+ export * from './directory.serializer';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./directory-group.serializer"), exports);
18
+ __exportStar(require("./directory-user.serializer"), exports);
19
+ __exportStar(require("./directory.serializer"), exports);
@@ -1,2 +1,2 @@
1
- import { User } from '../interfaces/user.interface';
2
- export declare function getPrimaryEmail(user: User): string | undefined;
1
+ import { DirectoryUser } from '../interfaces/directory-user.interface';
2
+ export declare function getPrimaryEmail(user: DirectoryUser): string | undefined;
@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const get_primary_email_1 = require("./get-primary-email");
4
4
  describe('getPrimaryEmail', () => {
5
5
  const user = {
6
+ object: 'directory_user',
6
7
  id: 'user_123',
7
- custom_attributes: {
8
+ customAttributes: {
8
9
  custom: true,
9
10
  },
10
- directory_id: 'dir_123',
11
- organization_id: 'org_123',
11
+ directoryId: 'dir_123',
12
+ organizationId: 'org_123',
12
13
  emails: [
13
14
  {
14
15
  primary: true,
@@ -16,13 +17,15 @@ describe('getPrimaryEmail', () => {
16
17
  value: 'jonsnow@workos.com',
17
18
  },
18
19
  ],
19
- first_name: 'Jon',
20
- idp_id: 'idp_foo',
21
- last_name: 'Snow',
22
- raw_attributes: {},
20
+ firstName: 'Jon',
21
+ idpId: 'idp_foo',
22
+ lastName: 'Snow',
23
+ rawAttributes: {},
23
24
  state: 'active',
24
25
  username: 'jonsnow',
25
- job_title: 'Knight of the Watch',
26
+ jobTitle: 'Knight of the Watch',
27
+ createdAt: '2021-10-27 15:21:50.640958',
28
+ updatedAt: '2021-12-13 12:15:45.531847',
26
29
  };
27
30
  it(`returns primary email value`, () => {
28
31
  const primaryEmail = (0, get_primary_email_1.getPrimaryEmail)(user);
@@ -1,7 +1,6 @@
1
1
  import { WorkOS } from '../workos';
2
- import { Event } from './interfaces/event.interface';
3
- import { List } from '../common/interfaces/list.interface';
4
2
  import { ListEventOptions } from './interfaces';
3
+ import { Event, List } from '../common/interfaces';
5
4
  export declare class Events {
6
5
  private readonly workos;
7
6
  constructor(workos: WorkOS);
@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.Events = void 0;
13
+ const serializers_1 = require("../common/serializers");
13
14
  class Events {
14
15
  constructor(workos) {
15
16
  this.workos = workos;
@@ -19,7 +20,7 @@ class Events {
19
20
  const { data } = yield this.workos.get(`/events`, {
20
21
  query: options,
21
22
  });
22
- return data;
23
+ return (0, serializers_1.deserializeList)(data, serializers_1.deserializeEvent);
23
24
  });
24
25
  }
25
26
  }
@@ -15,16 +15,42 @@ Object.defineProperty(exports, "__esModule", { value: true });
15
15
  const axios_1 = __importDefault(require("axios"));
16
16
  const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
17
17
  const workos_1 = require("../workos");
18
+ const interfaces_1 = require("../sso/interfaces");
18
19
  const mock = new axios_mock_adapter_1.default(axios_1.default);
19
20
  describe('Event', () => {
20
21
  afterEach(() => mock.resetHistory());
21
22
  const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
23
+ const event = {
24
+ id: 'event_01234ABCD',
25
+ createdAt: '2020-05-06 04:21:48.649164',
26
+ event: 'connection.activated',
27
+ data: {
28
+ object: 'connection',
29
+ id: 'conn_01234ABCD',
30
+ organizationId: 'org_1234',
31
+ name: 'Connection',
32
+ type: interfaces_1.ConnectionType.OktaSAML,
33
+ connectionType: interfaces_1.ConnectionType.OktaSAML,
34
+ state: 'active',
35
+ domains: [],
36
+ createdAt: '2020-05-06 04:21:48.649164',
37
+ updatedAt: '2020-05-06 04:21:48.649164',
38
+ },
39
+ };
22
40
  const eventResponse = {
23
41
  id: 'event_01234ABCD',
24
42
  created_at: '2020-05-06 04:21:48.649164',
25
- event: 'dsync.user.created',
43
+ event: 'connection.activated',
26
44
  data: {
27
- id: 'event_01234ABCD',
45
+ object: 'connection',
46
+ id: 'conn_01234ABCD',
47
+ organization_id: 'org_1234',
48
+ name: 'Connection',
49
+ connection_type: interfaces_1.ConnectionType.OktaSAML,
50
+ state: 'active',
51
+ domains: [],
52
+ created_at: '2020-05-06 04:21:48.649164',
53
+ updated_at: '2020-05-06 04:21:48.649164',
28
54
  },
29
55
  };
30
56
  describe('listEvents', () => {
@@ -35,15 +61,23 @@ describe('Event', () => {
35
61
  };
36
62
  it(`requests Events`, () => __awaiter(void 0, void 0, void 0, function* () {
37
63
  mock.onGet('/events', {}).replyOnce(200, eventsListResponse);
38
- const list = yield workos.events.listEvents({});
39
- expect(list).toEqual(eventsListResponse);
64
+ const subject = yield workos.events.listEvents({});
65
+ expect(subject).toEqual({
66
+ object: 'list',
67
+ data: [event],
68
+ listMetadata: {},
69
+ });
40
70
  }));
41
71
  it(`requests Events with a valid event name`, () => __awaiter(void 0, void 0, void 0, function* () {
42
72
  mock.onGet('/events').replyOnce(200, eventsListResponse);
43
73
  const list = yield workos.events.listEvents({
44
74
  events: ['connection.activated'],
45
75
  });
46
- expect(list).toEqual(eventsListResponse);
76
+ expect(list).toEqual({
77
+ object: 'list',
78
+ data: [event],
79
+ listMetadata: {},
80
+ });
47
81
  }));
48
82
  });
49
83
  });
@@ -1,2 +1 @@
1
1
  export * from './list-events-options.interface';
2
- export * from './event.interface';
@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./list-events-options.interface"), exports);
18
- __exportStar(require("./event.interface"), exports);
@@ -1,8 +1,8 @@
1
- import { EventNames } from './event.interface';
1
+ import { EventName } from '../../common/interfaces';
2
2
  export interface ListEventOptions {
3
- events?: EventNames[];
4
- range_start?: string;
5
- range_end?: string;
3
+ events?: EventName[];
4
+ rangeStart?: string;
5
+ rangeEnd?: string;
6
6
  limit?: number;
7
7
  after?: string;
8
8
  }
package/lib/index.d.ts CHANGED
@@ -10,6 +10,6 @@ export * from './organizations/interfaces';
10
10
  export * from './passwordless/interfaces';
11
11
  export * from './portal/interfaces';
12
12
  export * from './sso/interfaces';
13
- export * from './webhooks/interfaces';
13
+ export * from './users/interfaces';
14
14
  export { WorkOS };
15
15
  export default WorkOS;
package/lib/index.js CHANGED
@@ -28,6 +28,6 @@ __exportStar(require("./organizations/interfaces"), exports);
28
28
  __exportStar(require("./passwordless/interfaces"), exports);
29
29
  __exportStar(require("./portal/interfaces"), exports);
30
30
  __exportStar(require("./sso/interfaces"), exports);
31
- __exportStar(require("./webhooks/interfaces"), exports);
31
+ __exportStar(require("./users/interfaces"), exports);
32
32
  // tslint:disable-next-line:no-default-export
33
33
  exports.default = workos_1.WorkOS;
@@ -1,4 +1,13 @@
1
1
  export interface Challenge {
2
+ object: 'authentication_challenge';
3
+ id: string;
4
+ createdAt: string;
5
+ updatedAt: string;
6
+ expiresAt?: string;
7
+ code: string;
8
+ authenticationFactorId: string;
9
+ }
10
+ export interface ChallengeResponse {
2
11
  object: 'authentication_challenge';
3
12
  id: string;
4
13
  created_at: string;
@@ -1,11 +1,20 @@
1
- import { Sms } from './sms.interface';
2
- import { Totp } from './totp.interface';
1
+ import { Sms, SmsResponse } from './sms.interface';
2
+ import { Totp, TotpResponse } from './totp.interface';
3
3
  export interface Factor {
4
+ object: 'authentication_factor';
5
+ id: string;
6
+ createdAt: string;
7
+ updatedAt: string;
8
+ type: string;
9
+ sms?: Sms;
10
+ totp?: Totp;
11
+ }
12
+ export interface FactorResponse {
4
13
  object: 'authentication_factor';
5
14
  id: string;
6
15
  created_at: string;
7
16
  updated_at: string;
8
17
  type: string;
9
- sms: Sms;
10
- totp: Totp;
18
+ sms?: SmsResponse;
19
+ totp?: TotpResponse;
11
20
  }
@@ -0,0 +1,9 @@
1
+ export * from './challenge-factor-options';
2
+ export * from './challenge.interface';
3
+ export * from './enroll-factor-options';
4
+ export * from './factor.interface';
5
+ export * from './sms.interface';
6
+ export * from './totp.interface';
7
+ export * from './verify-challenge-options';
8
+ export * from './verify-challenge-response';
9
+ export * from './verify-factor-options';