@extrahorizon/javascript-sdk 8.12.1 → 8.13.0-dev-184-9d8c16c

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [8.13.0]
+
+### Fixed
+- The following methods are now correctly typed
+  - `exh.auth.oauth1.consumeSsoToken`
+  - `exh.auth.oauth2.createAuthorization`
+  - `exh.auth.oauth2.getAuthorizations`
+
+### Deprecated
+- The following fields will be removed from responses returned by listing endpoints in a future version:
+  - The `exh.auth.oauth1.find*` methods deprecate the `tokenSecret` field
+  - The `exh.auth.oauth2.find*` methods deprecate the `accessToken` field
+  - The `exh.auth.oauth2.getAuthorizations` method deprecates the `codeChallenge` and  `authorizationCode` fields
+  - The `exh.auth.users.getMfaSetting` method deprecates the TOTP `secret` and recovery codes `codes` fields
+
 ## [8.12.1]
 
 ### Fixed

package/build/index.cjs.js

@@ -5664,7 +5664,7 @@ const templatesV2Service = (httpWithAuth) => {
     };
 };
 
-const version = '8.12.1';
+const version = '8.13.0-dev-184-9d8c16c';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -5634,7 +5634,7 @@ const templatesV2Service = (httpWithAuth) => {
     };
 };
 
-const version = '8.12.1';
+const version = '8.13.0-dev-184-9d8c16c';
 
 /**
  * Create ExtraHorizon client.

package/build/services/auth/oauth1/types.d.ts

@@ -20,7 +20,7 @@ export interface AuthOauth1Service {
      * @throws {ApplicationNotAuthenticatedError}
      * @throws {ResourceUnknownError}
      */
-    consumeSsoToken(ssoToken: string): Promise<OAuth1Token>;
+    consumeSsoToken(ssoToken: string): Promise<ConsumeSSOTokenResponse>;
     /**
      * @deprecated Use `exh.auth.oauth1.tokens.find` instead
      *
@@ -100,12 +100,26 @@ export interface SsoToken {
     creationTimestamp: Date;
     updateTimestamp: Date;
 }
-export interface OAuth1Token {
+export interface ConsumeSSOTokenResponse {
     id: string;
-    userId: string;
     applicationId: string;
+    userId: string;
     token: string;
     tokenSecret: string;
+    updateTimestamp: Date;
+    lastUsedTimestamp: Date;
+    creationTimestamp: Date;
+}
+export interface OAuth1Token {
+    id: string;
+    applicationId: string;
+    userId: string;
+    token: string;
+    /**
+     * @deprecated `tokenSecret` will be removed from responses returned by listing endpoints in a future version.
+     */
+    tokenSecret?: string;
+    updateTimestamp: Date;
     lastUsedTimestamp: Date;
     creationTimestamp: Date;
 }

package/build/services/auth/oauth2/types.d.ts

@@ -12,7 +12,7 @@ export interface AuthOauth2Service {
      * @throws {CallbackNotValidError}
      * @throws {UnsupportedResponseTypeError}
      */
-    createAuthorization(data: OAuth2AuthorizationCreation, options?: OptionsBase): Promise<OAuth2Authorization>;
+    createAuthorization(data: OAuth2AuthorizationCreation, options?: OptionsBase): Promise<OAuth2AuthorizationCreationResponse>;
     /**
      * Get a list of OAuth2 Authorizations
      *
@@ -82,27 +82,52 @@ export interface AuthOauth2TokenService {
 export interface OAuth2AuthorizationCreation {
     responseType: string;
     clientId: string;
+    redirectUri?: string;
+    state?: string;
+    codeChallengeMethod?: string;
+    codeChallenge?: string;
+}
+export interface OAuth2AuthorizationCreationResponse {
+    id: string;
+    clientId: string;
+    userId: string;
     redirectUri: string;
-    state: string;
-    scope: string;
+    state?: string;
+    codeChallengeMethod?: string;
+    codeChallenge?: string;
+    authorizationCode: string;
+    expiryTimestamp: Date;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
 }
 export interface OAuth2Authorization {
     id: string;
-    userId: string;
     clientId: string;
-    authorizationCode: string;
-    state: string;
-    /** The timestamp when the authorization was last updated */
-    updateTimestamp?: Date;
-    /** The timestamp when the authorization was created */
-    creationTimestamp?: Date;
+    userId: string;
+    redirectUri: string;
+    state?: string;
+    codeChallengeMethod?: string;
+    /**
+     @deprecated `codeChallenge` will be removed from responses returned by listing endpoints in a future version.
+     */
+    codeChallenge?: string;
+    /**
+     * @deprecated `authorizationCode` will be removed from responses returned by listing endpoints in a future version.
+     */
+    authorizationCode?: string;
+    expiryTimestamp: Date;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
 }
 export interface OAuth2Token {
     id: string;
     applicationId: string;
     userId: string;
     refreshTokenId: string;
-    accessToken: string;
+    /**
+     * @deprecated `accessToken` will be removed from responses returned by listing endpoints in a future version.
+     */
+    accessToken?: string;
     expiryTimestamp: Date;
     updateTimestamp: Date;
     creationTimestamp: Date;

package/build/services/auth/users/types.d.ts

@@ -79,7 +79,10 @@ export interface RecoveryCodesMethod {
     tags: string[];
     verified: boolean;
     type: 'recoveryCodes';
-    codes: string[];
+    /**
+     * @deprecated `codes` will be removed from responses returned by listing endpoints in a future version.
+     */
+    codes?: string[];
     updateTimestamp: Date;
     creationTimestamp: Date;
 }
@@ -89,7 +92,10 @@ export interface TotpMethod {
     tags: string[];
     verified: boolean;
     type: 'totp';
-    secret: string;
+    /**
+     * @deprecated `secret` will be removed from responses returned by listing endpoints in a future version.
+     */
+    secret?: string;
     updateTimestamp: Date;
     creationTimestamp: Date;
 }

package/build/types/services/auth/oauth1/types.d.ts

@@ -20,7 +20,7 @@ export interface AuthOauth1Service {
      * @throws {ApplicationNotAuthenticatedError}
      * @throws {ResourceUnknownError}
      */
-    consumeSsoToken(ssoToken: string): Promise<OAuth1Token>;
+    consumeSsoToken(ssoToken: string): Promise<ConsumeSSOTokenResponse>;
     /**
      * @deprecated Use `exh.auth.oauth1.tokens.find` instead
      *
@@ -100,12 +100,26 @@ export interface SsoToken {
     creationTimestamp: Date;
     updateTimestamp: Date;
 }
-export interface OAuth1Token {
+export interface ConsumeSSOTokenResponse {
     id: string;
-    userId: string;
     applicationId: string;
+    userId: string;
     token: string;
     tokenSecret: string;
+    updateTimestamp: Date;
+    lastUsedTimestamp: Date;
+    creationTimestamp: Date;
+}
+export interface OAuth1Token {
+    id: string;
+    applicationId: string;
+    userId: string;
+    token: string;
+    /**
+     * @deprecated `tokenSecret` will be removed from responses returned by listing endpoints in a future version.
+     */
+    tokenSecret?: string;
+    updateTimestamp: Date;
     lastUsedTimestamp: Date;
     creationTimestamp: Date;
 }

package/build/types/services/auth/oauth2/types.d.ts

@@ -12,7 +12,7 @@ export interface AuthOauth2Service {
      * @throws {CallbackNotValidError}
      * @throws {UnsupportedResponseTypeError}
      */
-    createAuthorization(data: OAuth2AuthorizationCreation, options?: OptionsBase): Promise<OAuth2Authorization>;
+    createAuthorization(data: OAuth2AuthorizationCreation, options?: OptionsBase): Promise<OAuth2AuthorizationCreationResponse>;
     /**
      * Get a list of OAuth2 Authorizations
      *
@@ -82,27 +82,52 @@ export interface AuthOauth2TokenService {
 export interface OAuth2AuthorizationCreation {
     responseType: string;
     clientId: string;
+    redirectUri?: string;
+    state?: string;
+    codeChallengeMethod?: string;
+    codeChallenge?: string;
+}
+export interface OAuth2AuthorizationCreationResponse {
+    id: string;
+    clientId: string;
+    userId: string;
     redirectUri: string;
-    state: string;
-    scope: string;
+    state?: string;
+    codeChallengeMethod?: string;
+    codeChallenge?: string;
+    authorizationCode: string;
+    expiryTimestamp: Date;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
 }
 export interface OAuth2Authorization {
     id: string;
-    userId: string;
     clientId: string;
-    authorizationCode: string;
-    state: string;
-    /** The timestamp when the authorization was last updated */
-    updateTimestamp?: Date;
-    /** The timestamp when the authorization was created */
-    creationTimestamp?: Date;
+    userId: string;
+    redirectUri: string;
+    state?: string;
+    codeChallengeMethod?: string;
+    /**
+     @deprecated `codeChallenge` will be removed from responses returned by listing endpoints in a future version.
+     */
+    codeChallenge?: string;
+    /**
+     * @deprecated `authorizationCode` will be removed from responses returned by listing endpoints in a future version.
+     */
+    authorizationCode?: string;
+    expiryTimestamp: Date;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
 }
 export interface OAuth2Token {
     id: string;
     applicationId: string;
     userId: string;
     refreshTokenId: string;
-    accessToken: string;
+    /**
+     * @deprecated `accessToken` will be removed from responses returned by listing endpoints in a future version.
+     */
+    accessToken?: string;
     expiryTimestamp: Date;
     updateTimestamp: Date;
     creationTimestamp: Date;

package/build/types/services/auth/users/types.d.ts

@@ -79,7 +79,10 @@ export interface RecoveryCodesMethod {
     tags: string[];
     verified: boolean;
     type: 'recoveryCodes';
-    codes: string[];
+    /**
+     * @deprecated `codes` will be removed from responses returned by listing endpoints in a future version.
+     */
+    codes?: string[];
     updateTimestamp: Date;
     creationTimestamp: Date;
 }
@@ -89,7 +92,10 @@ export interface TotpMethod {
     tags: string[];
     verified: boolean;
     type: 'totp';
-    secret: string;
+    /**
+     * @deprecated `secret` will be removed from responses returned by listing endpoints in a future version.
+     */
+    secret?: string;
     updateTimestamp: Date;
     creationTimestamp: Date;
 }

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.12.1";
+export declare const version = "8.13.0-dev-184-9d8c16c";

package/build/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.12.1";
+export declare const version = "8.13.0-dev-184-9d8c16c";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.12.1",
+  "version": "8.13.0-dev-184-9d8c16c",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",