@workos-inc/node 7.3.0 → 7.4.0

package/lib/common/exceptions/bad-request.exception.d.ts

@@ -1,6 +1,7 @@
-export declare class BadRequestException extends Error {
-    readonly status: number;
-    readonly name: string;
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class BadRequestException extends Error implements RequestException {
+    readonly status = 400;
+    readonly name = "BadRequestException";
     readonly message: string;
     readonly code?: string;
     readonly errors?: unknown[];

package/lib/common/exceptions/generic-server.exception.d.ts

@@ -1,4 +1,5 @@
-export declare class GenericServerException extends Error {
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class GenericServerException extends Error implements RequestException {
     readonly status: number;
     readonly rawData: unknown;
     readonly requestID: string;

package/lib/common/exceptions/index.d.ts

@@ -3,6 +3,7 @@ export * from './bad-request.exception';
 export * from './no-api-key-provided.exception';
 export * from './not-found.exception';
 export * from './oauth.exception';
+export * from './rate-limit-exceeded.exception';
 export * from './signature-verification.exception';
 export * from './unauthorized.exception';
 export * from './unprocessable-entity.exception';

package/lib/common/exceptions/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./bad-request.exception"), exports);
 __exportStar(require("./no-api-key-provided.exception"), exports);
 __exportStar(require("./not-found.exception"), exports);
 __exportStar(require("./oauth.exception"), exports);
+__exportStar(require("./rate-limit-exceeded.exception"), exports);
 __exportStar(require("./signature-verification.exception"), exports);
 __exportStar(require("./unauthorized.exception"), exports);
 __exportStar(require("./unprocessable-entity.exception"), exports);

package/lib/common/exceptions/no-api-key-provided.exception.d.ts

@@ -1,5 +1,5 @@
 export declare class NoApiKeyProvidedException extends Error {
-    readonly status: number;
-    readonly name: string;
+    readonly status = 500;
+    readonly name = "NoApiKeyProvidedException";
     readonly message: string;
 }

package/lib/common/exceptions/not-found.exception.d.ts

@@ -1,6 +1,7 @@
-export declare class NotFoundException extends Error {
-    readonly status: number;
-    readonly name: string;
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class NotFoundException extends Error implements RequestException {
+    readonly status = 404;
+    readonly name = "NotFoundException";
     readonly message: string;
     readonly code?: string;
     readonly requestID: string;

package/lib/common/exceptions/oauth.exception.d.ts

@@ -1,9 +1,10 @@
-export declare class OauthException extends Error {
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class OauthException extends Error implements RequestException {
     readonly status: number;
     readonly requestID: string;
     readonly error: string | undefined;
     readonly errorDescription: string | undefined;
     readonly rawData: unknown;
-    readonly name: string;
+    readonly name = "OauthException";
     constructor(status: number, requestID: string, error: string | undefined, errorDescription: string | undefined, rawData: unknown);
 }

package/lib/common/exceptions/rate-limit-exceeded.exception.d.ts

@@ -0,0 +1,13 @@
+import { GenericServerException } from './generic-server.exception';
+export declare class RateLimitExceededException extends GenericServerException {
+    /**
+     * The number of seconds to wait before retrying the request.
+     */
+    readonly retryAfter: number | null;
+    readonly name = "RateLimitExceededException";
+    constructor(message: string, requestID: string, 
+    /**
+     * The number of seconds to wait before retrying the request.
+     */
+    retryAfter: number | null);
+}

package/lib/common/exceptions/rate-limit-exceeded.exception.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitExceededException = void 0;
+const generic_server_exception_1 = require("./generic-server.exception");
+// Inheriting from `GenericServerException` in order to maintain backwards
+// compatibility with what 429 errors would have previously been thrown as.
+//
+// TODO: Consider making it the base class for all request errors.
+class RateLimitExceededException extends generic_server_exception_1.GenericServerException {
+    constructor(message, requestID, 
+    /**
+     * The number of seconds to wait before retrying the request.
+     */
+    retryAfter) {
+        super(429, message, {}, requestID);
+        this.retryAfter = retryAfter;
+        this.name = 'RateLimitExceededException';
+    }
+}
+exports.RateLimitExceededException = RateLimitExceededException;

package/lib/common/exceptions/signature-verification.exception.d.ts

@@ -1,4 +1,4 @@
 export declare class SignatureVerificationException extends Error {
-    readonly name: string;
+    readonly name = "SignatureVerificationException";
     constructor(message: string);
 }

package/lib/common/exceptions/unauthorized.exception.d.ts

@@ -1,7 +1,8 @@
-export declare class UnauthorizedException extends Error {
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class UnauthorizedException extends Error implements RequestException {
     readonly requestID: string;
-    readonly status: number;
-    readonly name: string;
+    readonly status = 401;
+    readonly name = "UnauthorizedException";
     readonly message: string;
     constructor(requestID: string);
 }

package/lib/common/exceptions/unprocessable-entity.exception.d.ts

@@ -1,7 +1,8 @@
 import { UnprocessableEntityError } from '../interfaces';
-export declare class UnprocessableEntityException extends Error {
-    readonly status: number;
-    readonly name: string;
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class UnprocessableEntityException extends Error implements RequestException {
+    readonly status = 422;
+    readonly name = "UnprocessableEntityException";
     readonly message: string;
     readonly code?: string;
     readonly requestID: string;

package/lib/common/interfaces/request-exception.interface.d.ts

@@ -0,0 +1,5 @@
+export interface RequestException {
+    readonly status: number;
+    readonly message: string;
+    readonly requestID: string;
+}

package/lib/common/interfaces/request-exception.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/user-management/fixtures/invitation.json

@@ -7,6 +7,7 @@
     "revoked_at": "2023-07-18T02:07:19.911Z",
     "expires_at": "2023-07-18T02:07:19.911Z",
     "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "inviter_user_id": null,
     "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
     "accept_invitation_url": "https://myauthkit.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
     "created_at": "2023-07-18T02:07:19.911Z",

package/lib/user-management/fixtures/list-invitations.json

@@ -10,6 +10,7 @@
             "revoked_at": "2023-07-18T02:07:19.911Z",
             "expires_at": "2023-07-18T02:07:19.911Z",
             "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
+            "inviter_user_id": null,
             "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
             "accept_invitation_url": "https://myauthkit.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
             "created_at": "2023-07-18T02:07:19.911Z",

package/lib/user-management/interfaces/invitation.interface.d.ts

@@ -7,6 +7,7 @@ export interface Invitation {
     revokedAt: string | null;
     expiresAt: string;
     organizationId: string | null;
+    inviterUserId: string | null;
     token: string;
     acceptInvitationUrl: string;
     createdAt: string;
@@ -21,6 +22,7 @@ export interface InvitationEvent {
     revokedAt: string | null;
     expiresAt: string;
     organizationId: string | null;
+    inviterUserId: string | null;
     createdAt: string;
     updatedAt: string;
 }
@@ -33,6 +35,7 @@ export interface InvitationResponse {
     revoked_at: string | null;
     expires_at: string;
     organization_id: string | null;
+    inviter_user_id: string | null;
     token: string;
     accept_invitation_url: string;
     created_at: string;
@@ -47,6 +50,7 @@ export interface InvitationEventResponse {
     revoked_at: string | null;
     expires_at: string;
     organization_id: string | null;
+    inviter_user_id: string | null;
     created_at: string;
     updated_at: string;
 }

package/lib/user-management/serializers/invitation.serializer.js

@@ -10,6 +10,7 @@ const deserializeInvitation = (invitation) => ({
     revokedAt: invitation.revoked_at,
     expiresAt: invitation.expires_at,
     organizationId: invitation.organization_id,
+    inviterUserId: invitation.inviter_user_id,
     token: invitation.token,
     acceptInvitationUrl: invitation.accept_invitation_url,
     createdAt: invitation.created_at,
@@ -25,6 +26,7 @@ const deserializeInvitationEvent = (invitation) => ({
     revokedAt: invitation.revoked_at,
     expiresAt: invitation.expires_at,
     organizationId: invitation.organization_id,
+    inviterUserId: invitation.inviter_user_id,
     createdAt: invitation.created_at,
     updatedAt: invitation.updated_at,
 });

package/lib/workos.js

@@ -24,7 +24,7 @@ const audit_logs_1 = require("./audit-logs/audit-logs");
 const user_management_1 = require("./user-management/user-management");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
 const fetch_client_1 = require("./common/utils/fetch-client");
-const VERSION = '7.3.0';
+const VERSION = '7.4.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -170,6 +170,10 @@ class WorkOS {
                         requestID,
                     });
                 }
+                case 429: {
+                    const retryAfter = headers.get('Retry-After');
+                    throw new exceptions_1.RateLimitExceededException(data.message, requestID, retryAfter ? Number(retryAfter) : null);
+                }
                 default: {
                     if (error || errorDescription) {
                         throw new exceptions_1.OauthException(status, requestID, error, errorDescription, data);

package/lib/workos.spec.js

@@ -17,6 +17,7 @@ const test_utils_1 = require("./common/utils/test-utils");
 const promises_1 = __importDefault(require("fs/promises"));
 const exceptions_1 = require("./common/exceptions");
 const workos_1 = require("./workos");
+const rate_limit_exceeded_exception_1 = require("./common/exceptions/rate-limit-exceeded.exception");
 describe('WorkOS', () => {
     beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     describe('constructor', () => {
@@ -163,6 +164,18 @@ describe('WorkOS', () => {
                 yield expect(workos.post('/path', {})).rejects.toStrictEqual(new exceptions_1.OauthException(400, 'a-request-id', 'error', 'error description', { error: 'error', error_description: 'error description' }));
             }));
         });
+        describe('when the api responses with a 429', () => {
+            it('throws a RateLimitExceededException', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)({
+                    message: 'Too many requests',
+                }, {
+                    status: 429,
+                    headers: { 'X-Request-ID': 'a-request-id', 'Retry-After': '10' },
+                });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.get('/path')).rejects.toStrictEqual(new rate_limit_exceeded_exception_1.RateLimitExceededException('Too many requests', 'a-request-id', 10));
+            }));
+        });
         describe('when the entity is null', () => {
             it('sends a null body', () => __awaiter(void 0, void 0, void 0, function* () {
                 (0, test_utils_1.fetchOnce)();

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.3.0",
+  "version": "7.4.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",