@propelauth/node - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

dist/api.d.ts

@@ -1,2 +0,2 @@
-import { Org, User, UserMetadata } from "./user";
+import { ApiKeyFull, ApiKeyNew, ApiKeyResultPage, ApiKeyValidation, Org, OrgApiKeyValidation, PersonalApiKeyValidation, User, UserMetadata } from "./user";
 export declare type TokenVerificationMetadata = {
@@ -6,9 +6,9 @@ verifierKey: string;
 };
-export declare function fetchTokenVerificationMetadata(authUrl: URL, apiKey: string, manualTokenVerificationMetadata?: TokenVerificationMetadata): Promise<TokenVerificationMetadata>;
-export declare function fetchUserMetadataByUserIdWithIdCheck(authUrl: URL, apiKey: string, userId: string, includeOrgs?: boolean): Promise<UserMetadata | null>;
-export declare function fetchUserMetadataByQuery(authUrl: URL, apiKey: string, pathParam: string, query: any): Promise<UserMetadata | null>;
-export declare function fetchBatchUserMetadata(authUrl: URL, apiKey: string, type: string, values: string[], keyFunction: (x: UserMetadata) => string, includeOrgs?: boolean): Promise<{
+export declare function fetchTokenVerificationMetadata(authUrl: URL, integrationApiKey: string, manualTokenVerificationMetadata?: TokenVerificationMetadata): Promise<TokenVerificationMetadata>;
+export declare function fetchUserMetadataByUserIdWithIdCheck(authUrl: URL, integrationApiKey: string, userId: string, includeOrgs?: boolean): Promise<UserMetadata | null>;
+export declare function fetchUserMetadataByQuery(authUrl: URL, integrationApiKey: string, pathParam: string, query: any): Promise<UserMetadata | null>;
+export declare function fetchBatchUserMetadata(authUrl: URL, integrationApiKey: string, type: string, values: string[], keyFunction: (x: UserMetadata) => string, includeOrgs?: boolean): Promise<{
     [key: string]: UserMetadata;
 }>;
-export declare function fetchOrg(authUrl: URL, apiKey: string, orgId: string): Promise<Org | null>;
+export declare function fetchOrg(authUrl: URL, integrationApiKey: string, orgId: string): Promise<Org | null>;
 export declare type OrgQuery = {
@@ -26,3 +26,3 @@ pageSize?: number;
 };
-export declare function fetchOrgByQuery(authUrl: URL, apiKey: string, query: OrgQuery): Promise<OrgQueryResponse>;
+export declare function fetchOrgByQuery(authUrl: URL, integrationApiKey: string, query: OrgQuery): Promise<OrgQueryResponse>;
 export declare type UsersQuery = {
@@ -42,3 +42,3 @@ pageSize?: number;
 };
-export declare function fetchUsersByQuery(authUrl: URL, apiKey: string, query: UsersQuery): Promise<UsersPagedResponse>;
+export declare function fetchUsersByQuery(authUrl: URL, integrationApiKey: string, query: UsersQuery): Promise<UsersPagedResponse>;
 export declare type UsersInOrgQuery = {
@@ -50,3 +50,3 @@ orgId: string;
 };
-export declare function fetchUsersInOrg(authUrl: URL, apiKey: string, query: UsersInOrgQuery): Promise<UsersPagedResponse>;
+export declare function fetchUsersInOrg(authUrl: URL, integrationApiKey: string, query: UsersInOrgQuery): Promise<UsersPagedResponse>;
 export declare type CreateUserRequest = {
@@ -62,3 +62,3 @@ email: string;
 };
-export declare function createUser(authUrl: URL, apiKey: string, createUserRequest: CreateUserRequest): Promise<User>;
+export declare function createUser(authUrl: URL, integrationApiKey: string, createUserRequest: CreateUserRequest): Promise<User>;
 export declare type UpdateUserMetadataRequest = {
@@ -73,7 +73,7 @@ username?: string;
 };
-export declare function updateUserMetadata(authUrl: URL, apiKey: string, userId: string, updateUserMetadataRequest: UpdateUserMetadataRequest): Promise<boolean>;
-export declare function deleteUser(authUrl: URL, apiKey: string, userId: string): Promise<boolean>;
-export declare function disableUser(authUrl: URL, apiKey: string, userId: string): Promise<boolean>;
-export declare function enableUser(authUrl: URL, apiKey: string, userId: string): Promise<boolean>;
-export declare function disableUser2fa(authUrl: URL, apiKey: string, userId: string): Promise<boolean>;
+export declare function updateUserMetadata(authUrl: URL, integrationApiKey: string, userId: string, updateUserMetadataRequest: UpdateUserMetadataRequest): Promise<boolean>;
+export declare function deleteUser(authUrl: URL, integrationApiKey: string, userId: string): Promise<boolean>;
+export declare function disableUser(authUrl: URL, integrationApiKey: string, userId: string): Promise<boolean>;
+export declare function enableUser(authUrl: URL, integrationApiKey: string, userId: string): Promise<boolean>;
+export declare function disableUser2fa(authUrl: URL, integrationApiKey: string, userId: string): Promise<boolean>;
 export declare type UpdateUserEmailRequest = {
@@ -83,3 +83,3 @@ newEmail: string;
 };
-export declare function updateUserEmail(authUrl: URL, apiKey: string, userId: string, updateUserEmail: UpdateUserEmailRequest): Promise<boolean>;
+export declare function updateUserEmail(authUrl: URL, integrationApiKey: string, userId: string, updateUserEmail: UpdateUserEmailRequest): Promise<boolean>;
 export declare type UpdateUserPasswordRequest = {
@@ -89,3 +89,5 @@ password: string;
 };
-export declare function updateUserPassword(authUrl: URL, apiKey: string, userId: string, updateUserPasswordRequest: UpdateUserPasswordRequest): Promise<boolean>;
+export declare function updateUserPassword(authUrl: URL, integrationApiKey: string, userId: string, updateUserPasswordRequest: UpdateUserPasswordRequest): Promise<boolean>;
+export declare function enableUserCanCreateOrgs(authUrl: URL, integrationApiKey: string, userId: string): Promise<boolean>;
+export declare function disableUserCanCreateOrgs(authUrl: URL, integrationApiKey: string, userId: string): Promise<boolean>;
 export declare type CreateMagicLinkRequest = {
@@ -100,3 +102,3 @@ email: string;
 };
-export declare function createMagicLink(authUrl: URL, apiKey: string, createMagicLinkRequest: CreateMagicLinkRequest): Promise<MagicLink>;
+export declare function createMagicLink(authUrl: URL, integrationApiKey: string, createMagicLinkRequest: CreateMagicLinkRequest): Promise<MagicLink>;
 export declare type CreateAccessTokenRequest = {
@@ -109,3 +111,3 @@ userId: string;
 };
-export declare function createAccessToken(authUrl: URL, apiKey: string, createAccessTokenRequest: CreateAccessTokenRequest): Promise<AccessToken>;
+export declare function createAccessToken(authUrl: URL, integrationApiKey: string, createAccessTokenRequest: CreateAccessTokenRequest): Promise<AccessToken>;
 export declare type MigrateUserFromExternalSourceRequest = {
@@ -123,7 +125,7 @@ email: string;
 };
-export declare function migrateUserFromExternalSource(authUrl: URL, apiKey: string, migrateUserFromExternalSourceRequest: MigrateUserFromExternalSourceRequest): Promise<User>;
+export declare function migrateUserFromExternalSource(authUrl: URL, integrationApiKey: string, migrateUserFromExternalSourceRequest: MigrateUserFromExternalSourceRequest): Promise<User>;
 export declare type CreateOrgRequest = {
     name: string;
 };
-export declare function createOrg(authUrl: URL, apiKey: string, createOrgRequest: CreateOrgRequest): Promise<Org>;
+export declare function createOrg(authUrl: URL, integrationApiKey: string, createOrgRequest: CreateOrgRequest): Promise<Org>;
 export declare type AddUserToOrgRequest = {
@@ -134,3 +136,3 @@ userId: string;
 };
-export declare function addUserToOrg(authUrl: URL, apiKey: string, addUserToOrgRequest: AddUserToOrgRequest): Promise<boolean>;
+export declare function addUserToOrg(authUrl: URL, integrationApiKey: string, addUserToOrgRequest: AddUserToOrgRequest): Promise<boolean>;
 export declare type ChangeUserRoleInOrgRequest = {
@@ -141,3 +143,3 @@ userId: string;
 };
-export declare function changeUserRoleInOrg(authUrl: URL, apiKey: string, changeUserRoleInOrgRequest: ChangeUserRoleInOrgRequest): Promise<boolean>;
+export declare function changeUserRoleInOrg(authUrl: URL, integrationApiKey: string, changeUserRoleInOrgRequest: ChangeUserRoleInOrgRequest): Promise<boolean>;
 export declare type RemoveUserFromOrgRequest = {
@@ -147,3 +149,3 @@ userId: string;
 };
-export declare function removeUserFromOrg(authUrl: URL, apiKey: string, removeUserFromOrgRequest: RemoveUserFromOrgRequest): Promise<boolean>;
+export declare function removeUserFromOrg(authUrl: URL, integrationApiKey: string, removeUserFromOrgRequest: RemoveUserFromOrgRequest): Promise<boolean>;
 export declare type UpdateOrgRequest = {
@@ -153,2 +155,3 @@ orgId: string;
     canSetupSaml?: boolean;
+    maxUsers?: number;
     metadata?: {
@@ -158,5 +161,32 @@ [key: string]: any;
 };
-export declare function updateOrg(authUrl: URL, apiKey: string, updateOrgRequest: UpdateOrgRequest): Promise<boolean>;
-export declare function deleteOrg(authUrl: URL, apiKey: string, orgId: string): Promise<boolean>;
-export declare function allowOrgToSetupSamlConnection(authUrl: URL, apiKey: string, orgId: string): Promise<boolean>;
-export declare function disallowOrgToSetupSamlConnection(authUrl: URL, apiKey: string, orgId: string): Promise<boolean>;
+export declare function updateOrg(authUrl: URL, integrationApiKey: string, updateOrgRequest: UpdateOrgRequest): Promise<boolean>;
+export declare function deleteOrg(authUrl: URL, integrationApiKey: string, orgId: string): Promise<boolean>;
+export declare function allowOrgToSetupSamlConnection(authUrl: URL, integrationApiKey: string, orgId: string): Promise<boolean>;
+export declare function disallowOrgToSetupSamlConnection(authUrl: URL, integrationApiKey: string, orgId: string): Promise<boolean>;
+export declare function fetchApiKey(authUrl: URL, integrationApiKey: string, apiKeyId: string): Promise<ApiKeyFull>;
+export declare type ApiKeysQueryRequest = {
+    orgId?: string;
+    userId?: string;
+    userEmail?: string;
+    pageSize?: number;
+    pageNumber?: number;
+};
+export declare function fetchCurrentApiKeys(authUrl: URL, integrationApiKey: string, apiKeyQuery: ApiKeysQueryRequest): Promise<ApiKeyResultPage>;
+export declare function fetchArchivedApiKeys(authUrl: URL, integrationApiKey: string, apiKeyQuery: ApiKeysQueryRequest): Promise<ApiKeyResultPage>;
+export declare type ApiKeysCreateRequest = {
+    orgId?: string;
+    userId?: string;
+    expiresAtSeconds?: number;
+    metadata?: object;
+};
+export declare function createApiKey(authUrl: URL, integrationApiKey: string, apiKeyCreate: ApiKeysCreateRequest): Promise<ApiKeyNew>;
+export declare type ApiKeyUpdateRequest = {
+    expiresAtSeconds?: number;
+    metadata?: string;
+};
+export declare function updateApiKey(authUrl: URL, integrationApiKey: string, apiKeyId: string, apiKeyUpdate: ApiKeyUpdateRequest): Promise<boolean>;
+export declare function deleteApiKey(authUrl: URL, integrationApiKey: string, apiKeyId: string): Promise<boolean>;
+export declare function validatePersonalApiKey(authUrl: URL, integrationApiKey: string, apiKeyToken: string): Promise<PersonalApiKeyValidation>;
+export declare function validateOrgApiKey(authUrl: URL, integrationApiKey: string, apiKeyToken: string): Promise<OrgApiKeyValidation>;
+export declare function validateApiKey(authUrl: URL, integrationApiKey: string, apiKeyToken: string): Promise<ApiKeyValidation>;
+export declare function parseSnakeCaseToCamelCase(response: string): any;

dist/auth.d.ts

@@ -1,3 +0,3 @@
-import { AccessToken, AddUserToOrgRequest, ChangeUserRoleInOrgRequest, CreateAccessTokenRequest, CreateMagicLinkRequest, CreateOrgRequest, CreateUserRequest, MagicLink, MigrateUserFromExternalSourceRequest, OrgQuery, OrgQueryResponse, RemoveUserFromOrgRequest, TokenVerificationMetadata, UpdateOrgRequest, UpdateUserEmailRequest, UpdateUserMetadataRequest, UpdateUserPasswordRequest, UsersInOrgQuery, UsersPagedResponse, UsersQuery } from "./api";
-import { Org, User, UserAndOrgMemberInfo, UserMetadata } from "./user";
+import { AccessToken, AddUserToOrgRequest, ApiKeysCreateRequest, ApiKeysQueryRequest, ApiKeyUpdateRequest, ChangeUserRoleInOrgRequest, CreateAccessTokenRequest, CreateMagicLinkRequest, CreateOrgRequest, CreateUserRequest, MagicLink, MigrateUserFromExternalSourceRequest, OrgQuery, OrgQueryResponse, RemoveUserFromOrgRequest, TokenVerificationMetadata, UpdateOrgRequest, UpdateUserEmailRequest, UpdateUserMetadataRequest, UpdateUserPasswordRequest, UsersInOrgQuery, UsersPagedResponse, UsersQuery } from "./api";
+import { ApiKeyFull, ApiKeyNew, ApiKeyResultPage, ApiKeyValidation, Org, OrgApiKeyValidation, PersonalApiKeyValidation, User, UserAndOrgMemberInfo, UserMetadata } from "./user";
 export declare type BaseAuthOptions = {
@@ -53,2 +53,4 @@ authUrl: string;
     disableUser2fa: (userId: string) => Promise<boolean>;
+    enableUserCanCreateOrgs: (userId: string) => Promise<boolean>;
+    disableUserCanCreateOrgs: (userId: string) => Promise<boolean>;
     createOrg: (createOrgRequest: CreateOrgRequest) => Promise<Org>;
@@ -62,2 +64,11 @@ addUserToOrg: (addUserToOrgRequest: AddUserToOrgRequest) => Promise<boolean>;
     disallowOrgToSetupSamlConnection: (orgId: string) => Promise<boolean>;
+    fetchApiKey: (apiKeyId: string) => Promise<ApiKeyFull>;
+    fetchCurrentApiKeys: (apiKeyQuery: ApiKeysQueryRequest) => Promise<ApiKeyResultPage>;
+    fetchArchivedApiKeys: (apiKeyQuery: ApiKeysQueryRequest) => Promise<ApiKeyResultPage>;
+    createApiKey: (apiKeyCreate: ApiKeysCreateRequest) => Promise<ApiKeyNew>;
+    updateApiKey: (apiKeyId: string, ApiKeyUpdate: ApiKeyUpdateRequest) => Promise<boolean>;
+    deleteApiKey: (apiKeyId: string) => Promise<boolean>;
+    validateApiKey: (apiKeyToken: string) => Promise<ApiKeyValidation>;
+    validatePersonalApiKey: (apiKeyToken: string) => Promise<PersonalApiKeyValidation>;
+    validateOrgApiKey: (apiKeyToken: string) => Promise<OrgApiKeyValidation>;
 };
@@ -64,0 +75,0 @@ export declare type RequiredOrgInfo = {

dist/exceptions.d.ts

@@ -90,1 +90,31 @@ export declare class CreateUserException extends Error {
 }
+export declare class ApiKeyValidateException extends Error {
+    readonly fieldToErrors: {
+        [fieldName: string]: string[];
+    };
+    constructor(message: string);
+}
+export declare class ApiKeyDeleteException extends Error {
+    readonly fieldToErrors: {
+        [fieldName: string]: string[];
+    };
+    constructor(message: string);
+}
+export declare class ApiKeyUpdateException extends Error {
+    readonly fieldToErrors: {
+        [fieldName: string]: string[];
+    };
+    constructor(message: string);
+}
+export declare class ApiKeyCreateException extends Error {
+    readonly fieldToErrors: {
+        [fieldName: string]: string[];
+    };
+    constructor(message: string);
+}
+export declare class ApiKeyFetchException extends Error {
+    readonly fieldToErrors: {
+        [fieldName: string]: string[];
+    };
+    constructor(message: string);
+}

dist/index.d.ts

 export { initBaseAuth, BaseAuthOptions, RequiredOrgInfo as RequriedOrgInfo, handleError, HandleErrorResponse, HandleErrorOptions } from "./auth";
 export { TokenVerificationMetadata, OrgQueryResponse, OrgQuery, UsersQuery, UsersInOrgQuery, UsersPagedResponse, CreateUserRequest, UpdateUserMetadataRequest, UpdateUserEmailRequest, CreateMagicLinkRequest, MagicLink, CreateAccessTokenRequest, AccessToken, } from "./api";
-export { AccessTokenCreationException, AddUserToOrgException, CreateOrgException, CreateUserException, ForbiddenException, MagicLinkCreationException, MigrateUserException, UserNotFoundException, UnauthorizedException, UnexpectedException, UpdateUserEmailException, UpdateUserMetadataException } from "./exceptions";
+export { ApiKeyValidateException, ApiKeyDeleteException, ApiKeyUpdateException, ApiKeyCreateException, ApiKeyFetchException, AccessTokenCreationException, AddUserToOrgException, CreateOrgException, CreateUserException, ForbiddenException, MagicLinkCreationException, MigrateUserException, UserNotFoundException, UnauthorizedException, UnexpectedException, UpdateUserEmailException, UpdateUserMetadataException } from "./exceptions";
 export { User, Org, OrgIdToOrgMemberInfo, OrgMemberInfo, toUser, InternalOrgMemberInfo, UserAndOrgMemberInfo, InternalUser, toOrgIdToOrgMemberInfo, UserMetadata, } from "./user";

dist/user.d.ts

@@ -17,2 +17,3 @@ export declare type User = {
     name: string;
+    maxUsers?: number;
 };
@@ -30,2 +31,3 @@ export declare type UserMetadata = {
     mfaEnabled: boolean;
+    canCreateOrgs: boolean;
     createdAt: number;
@@ -98,1 +100,44 @@ lastActiveAt: number;
 }): OrgIdToOrgMemberInfo | undefined;
+export declare type ApiKeyNew = {
+    apiKeyId: string;
+    apiKeyToken: string;
+};
+export declare type ApiKeyFull = {
+    apiKeyId: string;
+    createdAt: number;
+    expiresAtSeconds: number;
+    metadata: {
+        [key: string]: any;
+    };
+    userId: string;
+    orgId: string;
+};
+export declare type ApiKeyResultPage = {
+    apiKeys: ApiKeyFull[];
+    totalApiKeys: number;
+    currentPage: number;
+    pageSize: number;
+    hasMoreResults: boolean;
+};
+export declare type ApiKeyValidation = {
+    metadata?: {
+        [key: string]: any;
+    };
+    user?: UserMetadata;
+    org?: Org;
+    userInOrg?: OrgMemberInfo;
+};
+export declare type PersonalApiKeyValidation = {
+    metadata?: {
+        [key: string]: any;
+    };
+    user: UserMetadata;
+};
+export declare type OrgApiKeyValidation = {
+    metadata?: {
+        [key: string]: any;
+    };
+    org: Org;
+    user?: UserMetadata;
+    userInOrg?: OrgMemberInfo;
+};

package.json

@@ -7,3 +7,3 @@ {
   },
-  "version": "v2.1.0",
+  "version": "v2.1.1",
   "license": "MIT",
@@ -10,0 +10,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4066944

increased by2.06%

Lines of code

43778

increased by1.5%

No dependency changes