@palmetto/users-sdk 1.2.0 → 1.3.0

package/dist/__generated__/schema.d.ts

@@ -925,6 +925,11 @@ export interface components {
             /** @enum {string} */
             grant_type: "authorization_code";
             code: string;
+            /**
+             * @deprecated
+             * @description Obtain access tokens without verifying that the user exists
+             */
+            skip_user_verification?: boolean;
         } | {
             /** @enum {string} */
             grant_type: "refresh_token";
@@ -947,6 +952,7 @@ export interface components {
             lastName?: string;
             /** Format: email */
             email?: string;
+            roleIds?: string[];
         };
         /** SignUpToken */
         SignUpTokenDto: {
@@ -2282,6 +2288,15 @@ export interface operations {
                     "application/json": components["schemas"]["BadRequestErrorDto"];
                 };
             };
+            /** @description When the user does not exist for the exchange token */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotFoundErrorDto"];
+                };
+            };
         };
     };
     SignUpsController_findAll: {

package/dist/client.d.ts

@@ -1,6 +1,8 @@
 import { ApiInput, ApiResponse, BaseSdkClient, CreateSdkClientInput, RequestOptions, SdkError } from "@palmetto/base-sdk-client";
 import { ResultOk } from "@palmetto/result";
+import { ErrorResponse } from "openapi-typescript-helpers";
 import { paths } from "./__generated__/schema";
+export type ReExportedErrorResponse<T extends Record<string | number, any>> = ErrorResponse<T>;
 export declare class UsersApiClient extends BaseSdkClient<paths> {
     constructor(input: CreateSdkClientInput);
     me(input: MeInput, opts?: RequestOptions): Promise<ResultOk<MeResponseV2> | SdkError<paths["/api/v2/users/me"]["get"]["responses"]["401"]["content"]["application/json"] | paths["/api/v2/users/me"]["get"]["responses"]["403"]["content"]["application/json"]>>;
@@ -23,7 +25,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
         phoneNumber: string;
         organizationId: string;
         hasPAT: boolean;
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -77,7 +79,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
             totalRecords: number;
             totalPages: number;
         };
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -129,7 +131,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
         phoneNumber: string;
         organizationId: string;
         hasPAT: boolean;
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -181,7 +183,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
         permissions: {
             [key: string]: string[];
         };
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -233,7 +235,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
         permissions: {
             [key: string]: string[];
         };
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -277,7 +279,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
     }, `${string}/${string}`>>>;
     createSignUp(input: CreateSignUpInput, opts?: RequestOptions): Promise<ResultOk<{
         token: string;
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         201: {
             headers: {
                 [name: string]: unknown;
@@ -320,7 +322,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
         lastName?: string;
         email?: string;
         expiresAt: string;
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -358,7 +360,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
             totalRecords: number;
             totalPages: number;
         };
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -403,7 +405,7 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
         lastName?: string;
         email?: string;
         expiresAt: string;
-    }> | SdkError<import("openapi-typescript-helpers").ErrorResponse<{
+    }> | SdkError<ErrorResponse<{
         200: {
             headers: {
                 [name: string]: unknown;
@@ -445,35 +447,87 @@ export declare class UsersApiClient extends BaseSdkClient<paths> {
             };
         };
     }, `${string}/${string}`>>>;
-    getAuthToken({ code }: GetAuthTokenInput, opts?: RequestOptions): Promise<ResultOk<{
-        accessToken: string;
-        idToken: string;
-        refreshToken: string;
-        expiresIn: number;
-    }> | SdkError<{
-        error: "BadRequest";
-        statusCode: 400;
-        message: string;
-        reason: string;
-        validations: {
-            [key: string]: string[];
-        };
-    }>>;
+    getAuthToken({ code, skipUserVerification }: GetAuthTokenInput, opts?: RequestOptions): Promise<ResultOk<GetTokenResponse> | SdkError<ReExportedErrorResponse<paths["/api/auth/token"]["post"]["responses"]>>>;
     refreshToken({ refreshToken }: RefreshTokenInput, opts?: RequestOptions): Promise<ResultOk<{
         accessToken: string;
         idToken: string;
         refreshToken: string;
         expiresIn: number;
-    }> | SdkError<{
-        error: "BadRequest";
-        statusCode: 400;
-        message: string;
-        reason: string;
-        validations: {
-            [key: string]: string[];
+    }> | SdkError<ErrorResponse<{
+        200: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./__generated__/schema").components["schemas"]["TokenResponseDto"];
+            };
         };
-    }>>;
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./__generated__/schema").components["schemas"]["BadRequestErrorDto"];
+            };
+        };
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./__generated__/schema").components["schemas"]["NotFoundErrorDto"];
+            };
+        };
+    }, `${string}/${string}`>>>;
     private getToken;
+    getRoles(input: GetRolesInput, opts?: RequestOptions): Promise<ResultOk<{
+        data: import("./__generated__/schema").components["schemas"]["RoleDto"][];
+    } & {
+        data: unknown[];
+        paging: {
+            limit: number;
+            page: number;
+            pageStart: number;
+            pageEnd: number;
+            totalRecords: number;
+            totalPages: number;
+        };
+    }> | SdkError<ErrorResponse<{
+        200: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    data: import("./__generated__/schema").components["schemas"]["RoleDto"][];
+                } & import("./__generated__/schema").components["schemas"]["PaginatedListDto"];
+            };
+        };
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./__generated__/schema").components["schemas"]["BadRequestErrorDto"];
+            };
+        };
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./__generated__/schema").components["schemas"]["UnauthorizedErrorDto"];
+            };
+        };
+        403: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./__generated__/schema").components["schemas"]["ForbiddenErrorDto"];
+            };
+        };
+    }, `${string}/${string}`>>>;
 }
 export interface MeInput {
     v2Response: true;
@@ -504,8 +558,11 @@ export type GetSignUpInput = ApiInput<paths["/api/sign-ups/{token}"]["get"]>;
 export type GetSignUpResponse = ApiResponse<paths["/api/sign-ups/{token}"]["get"]>;
 export type CreateSignUpUserInput = ApiInput<paths["/api/sign-ups/{token}/user"]["post"]>;
 export type CreateSignUpUserResponse = ApiResponse<paths["/api/sign-ups/{token}/user"]["post"]>;
+export type GetRolesInput = ApiInput<paths["/api/roles"]["get"]>;
+export type GetRolesResponse = ApiResponse<paths["/api/roles"]["get"]>;
 export interface GetAuthTokenInput {
     code: string;
+    skipUserVerification: boolean;
 }
 export interface RefreshTokenInput {
     refreshToken: string;

package/dist/client.js

@@ -23,7 +23,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UsersApiClient = void 0;
 const base_sdk_client_1 = require("@palmetto/base-sdk-client");
 const result_1 = require("@palmetto/result");
-const SDK_VERSION_SLUG = "palmetto-users-sdk/1.2.0";
+const SDK_VERSION_SLUG = "palmetto-users-sdk/1.2.1";
 class UsersApiClient extends base_sdk_client_1.BaseSdkClient {
     constructor(input) {
         super(Object.assign(Object.assign({}, input), { sdkVersion: SDK_VERSION_SLUG }));
@@ -177,8 +177,12 @@ class UsersApiClient extends base_sdk_client_1.BaseSdkClient {
         });
     }
     getAuthToken(_a, opts_1) {
-        return __awaiter(this, arguments, void 0, function* ({ code }, opts) {
-            return this.getToken({ grant_type: "authorization_code", code }, opts);
+        return __awaiter(this, arguments, void 0, function* ({ code, skipUserVerification }, opts) {
+            return this.getToken({
+                grant_type: "authorization_code",
+                code,
+                skip_user_verification: skipUserVerification,
+            }, opts);
         });
     }
     refreshToken(_a, opts_1) {
@@ -206,5 +210,17 @@ class UsersApiClient extends base_sdk_client_1.BaseSdkClient {
             return this.handleErrorResponse(error, response);
         });
     }
+    getRoles(input, opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data, error, response } = yield this.client.GET("/api/roles", {
+                params: { query: input },
+                headers: this.generateHeaders(opts),
+            });
+            if (data) {
+                return (0, result_1.Ok)(data);
+            }
+            return this.handleErrorResponse(error, response);
+        });
+    }
 }
 exports.UsersApiClient = UsersApiClient;

package/dist/main.d.ts

@@ -1,3 +1,3 @@
 export * from "./client.js";
-export * from "./scopes.js";
-export { type RequestOptions } from "@palmetto/base-sdk-client";
+export { type RequestOptions, type SdkError } from "@palmetto/base-sdk-client";
+export { type ErrorResponse } from "openapi-typescript-helpers";

package/dist/main.js

@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client.js"), exports);
-__exportStar(require("./scopes.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/users-sdk",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "main": "./dist/main.js",
   "files": [
     "dist/**/*",
@@ -15,8 +15,11 @@
     "tc": "tsc --noEmit",
     "start:dev": "tsc --watch",
     "build": "tsc",
+    "clean": "rm -rf ./dist/",
     "generate": "node ./scripts/generateApiSchema.mjs",
+    "refresh": "yarn generate && yarn build",
     "prepublishOnly": "yarn build",
+    "ci:build": "tsc",
     "ci:lint": "eslint . && prettier --check --loglevel warn ./src",
     "ci:tc": "yarn tc",
     "hook:lint": "eslint --cache --fix",

package/dist/scopes.d.ts

@@ -1,11 +0,0 @@
-export type GrantScope = "@deny" | "@self" | "@org" | "@admin";
-export declare function isGrantScope(value: unknown): value is GrantScope;
-export declare function valueOfScope(scope: GrantScope): number;
-export declare function compareScopes(a: GrantScope, b: GrantScope): -1 | 0 | 1;
-export declare function highestScope(scopes: GrantScope[]): GrantScope;
-export interface LowestScopeOptions {
-    includeDeny: boolean;
-}
-export declare function lowestScope(scopes: GrantScope[], options?: LowestScopeOptions): GrantScope;
-export type ScopeOperator = "eq" | "neq" | "lt" | "lte" | "gt" | "gte";
-export declare function scopeMatch(left: GrantScope, op: ScopeOperator, right: GrantScope): boolean;

package/dist/scopes.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isGrantScope = isGrantScope;
-exports.valueOfScope = valueOfScope;
-exports.compareScopes = compareScopes;
-exports.highestScope = highestScope;
-exports.lowestScope = lowestScope;
-exports.scopeMatch = scopeMatch;
-const scopeOrder = ["@deny", "@self", "@org", "@admin"];
-function isGrantScope(value) {
-    return typeof value === "string" && scopeOrder.includes(value);
-}
-function valueOfScope(scope) {
-    return scopeOrder.indexOf(scope);
-}
-function compareScopes(a, b) {
-    if (a === b) {
-        return 0;
-    }
-    return valueOfScope(a) < valueOfScope(b) ? -1 : 1;
-}
-function highestScope(scopes) {
-    var _a;
-    return (_a = [...scopes].sort(compareScopes)[scopes.length - 1]) !== null && _a !== void 0 ? _a : "@deny";
-}
-function lowestScope(scopes, options) {
-    var _a;
-    const filtered = (options === null || options === void 0 ? void 0 : options.includeDeny)
-        ? [...scopes]
-        : [...scopes].filter((elem) => elem !== "@deny");
-    return (_a = filtered.sort(compareScopes)[0]) !== null && _a !== void 0 ? _a : "@deny";
-}
-function scopeMatch(left, op, right) {
-    const leftValue = valueOfScope(left);
-    const rightValue = valueOfScope(right);
-    switch (op) {
-        case "eq":
-            return leftValue === rightValue;
-        case "neq":
-            return leftValue !== rightValue;
-        case "lt":
-            return leftValue < rightValue;
-        case "lte":
-            return leftValue <= rightValue;
-        case "gt":
-            return leftValue > rightValue;
-        case "gte":
-            return leftValue >= rightValue;
-    }
-}