@extrahorizon/javascript-sdk 8.13.0-dev-184-9d8c16c → 8.13.0-dev-188-731b41d

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [8.13.0]
 
+### Added
+- Added the `exh.auth.oauth2.refreshTokens.find*` methods to retrieve refresh tokens
+- Added the `exh.auth.oauth2.refreshTokens.remove` method to delete a refresh token
+
 ### Fixed
 - The following methods are now correctly typed
   - `exh.auth.oauth1.consumeSsoToken`

package/build/index.cjs.js

@@ -3410,6 +3410,7 @@ function createTokenService$1(client, httpWithAuth) {
 
 var oauth2 = (client, httpWithAuth) => ({
     tokens: createTokenService(client, httpWithAuth),
+    refreshTokens: createRefreshTokenService(client, httpWithAuth),
     async createAuthorization(data, options) {
         return (await client.post(httpWithAuth, '/oauth2/authorizations', data, options)).data;
     },
@@ -3441,6 +3442,34 @@ function createTokenService(client, httpWithAuth) {
         },
     };
 }
+function createRefreshTokenService(client, httpWithAuth) {
+    async function find(options) {
+        const result = await client.get(httpWithAuth, `/oauth2/refreshTokens${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, options);
+        return result.data;
+    }
+    return {
+        async find(options) {
+            const result = await find(options);
+            return addPagersFn(find, options, result);
+        },
+        async findAll(options) {
+            return await findAllGeneric(find, options);
+        },
+        async findFirst(options) {
+            const result = await find(options);
+            return result.data[0];
+        },
+        async findById(id, options) {
+            const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
+            const result = await find({ ...options, rql: rqlWithId });
+            return result.data[0];
+        },
+        async remove(id, options) {
+            const result = (await client.delete(httpWithAuth, `/oauth2/refreshTokens/${id}`, options));
+            return result.data;
+        },
+    };
+}
 
 var loginAttempts = (oidcClient, httpWithAuth) => {
     async function query(options) {
@@ -5664,7 +5693,7 @@ const templatesV2Service = (httpWithAuth) => {
     };
 };
 
-const version = '8.13.0-dev-184-9d8c16c';
+const version = '8.13.0-dev-188-731b41d';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -3380,6 +3380,7 @@ function createTokenService$1(client, httpWithAuth) {
 
 var oauth2 = (client, httpWithAuth) => ({
     tokens: createTokenService(client, httpWithAuth),
+    refreshTokens: createRefreshTokenService(client, httpWithAuth),
     async createAuthorization(data, options) {
         return (await client.post(httpWithAuth, '/oauth2/authorizations', data, options)).data;
     },
@@ -3411,6 +3412,34 @@ function createTokenService(client, httpWithAuth) {
         },
     };
 }
+function createRefreshTokenService(client, httpWithAuth) {
+    async function find(options) {
+        const result = await client.get(httpWithAuth, `/oauth2/refreshTokens${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, options);
+        return result.data;
+    }
+    return {
+        async find(options) {
+            const result = await find(options);
+            return addPagersFn(find, options, result);
+        },
+        async findAll(options) {
+            return await findAllGeneric(find, options);
+        },
+        async findFirst(options) {
+            const result = await find(options);
+            return result.data[0];
+        },
+        async findById(id, options) {
+            const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
+            const result = await find({ ...options, rql: rqlWithId });
+            return result.data[0];
+        },
+        async remove(id, options) {
+            const result = (await client.delete(httpWithAuth, `/oauth2/refreshTokens/${id}`, options));
+            return result.data;
+        },
+    };
+}
 
 var loginAttempts = (oidcClient, httpWithAuth) => {
     async function query(options) {
@@ -5634,7 +5663,7 @@ const templatesV2Service = (httpWithAuth) => {
     };
 };
 
-const version = '8.13.0-dev-184-9d8c16c';
+const version = '8.13.0-dev-188-731b41d';
 
 /**
  * Create ExtraHorizon client.

package/build/mockType.d.ts

@@ -517,6 +517,13 @@ export declare type MockClientOAuth1<MockFn> = {
                 findAll: MockFn;
                 remove: MockFn;
             };
+            refreshTokens: {
+                find: MockFn;
+                findAll: MockFn;
+                findFirst: MockFn;
+                findById: MockFn;
+                remove: MockFn;
+            };
             createAuthorization: MockFn;
             getAuthorizations: MockFn;
             deleteAuthorization: MockFn;
@@ -1104,6 +1111,13 @@ export declare type MockClientOAuth2<MockFn> = {
                 findAll: MockFn;
                 remove: MockFn;
             };
+            refreshTokens: {
+                find: MockFn;
+                findAll: MockFn;
+                findFirst: MockFn;
+                findById: MockFn;
+                remove: MockFn;
+            };
             createAuthorization: MockFn;
             getAuthorizations: MockFn;
             deleteAuthorization: MockFn;
@@ -1691,6 +1705,13 @@ export declare type MockClientProxy<MockFn> = {
                 findAll: MockFn;
                 remove: MockFn;
             };
+            refreshTokens: {
+                find: MockFn;
+                findAll: MockFn;
+                findFirst: MockFn;
+                findById: MockFn;
+                remove: MockFn;
+            };
             createAuthorization: MockFn;
             getAuthorizations: MockFn;
             deleteAuthorization: MockFn;

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

@@ -1,4 +1,4 @@
-import type { HttpInstance } from '../../../types';
+import { HttpInstance } from '../../../types';
 import { HttpClient } from '../../http-client';
 import type { AuthOauth2Service } from './types';
 declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => AuthOauth2Service;

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

@@ -1,6 +1,7 @@
 import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
 export interface AuthOauth2Service {
     tokens: AuthOauth2TokenService;
+    refreshTokens: OAuth2RefreshTokenService;
     /**
      * Create an OAuth2 authorization
      *
@@ -79,6 +80,68 @@ export interface AuthOauth2TokenService {
      */
     remove(id: string): Promise<AffectedRecords>;
 }
+export interface OAuth2RefreshTokenService {
+    /**
+     * # Get a list of OAuth2 refresh tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param options.rql Add filters to the requested list
+     * @returns PagedResult<OAuth2RefreshToken>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<OAuth2RefreshToken>>;
+    /**
+     * Get a list of OAuth2 refresh tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param options.rql Add filters to the requested list
+     * @returns OAuth2RefreshToken[]
+     */
+    findAll(options?: OptionsWithRql): Promise<OAuth2RefreshToken[]>;
+    /**
+     * Get the first OAuth2 refresh token found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param options.rql Add filters to the requested list
+     * @returns {Promise<OAuth2RefreshToken | undefined>}
+     */
+    findFirst(options?: OptionsWithRql): Promise<OAuth2RefreshToken | undefined>;
+    /**
+     * Get an oAuth2 refresh token by its id
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param id the refresh token id
+     * @param options.rql Add filters to the requested list
+     * @returns {Promise<OAuth2RefreshToken | undefined>}
+     */
+    findById(id: string, options?: OptionsWithRql): Promise<OAuth2RefreshToken | undefined>;
+    /**
+     * Delete an oAuth2 refresh token
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * DELETE_OAUTH2_REFRESH_TOKEN or DELETE_AUTHORIZATIONS | global | Required for this endpoint
+     * Using DELETE_AUTHORIZATIONS for this endpoint is deprecated; use DELETE_OAUTH2_REFRESH_TOKEN instead
+     * @param id the refresh token id
+     * @returns AffectedRecords
+     */
+    remove(id: string, options?: OptionsBase): Promise<AffectedRecords>;
+}
 export interface OAuth2AuthorizationCreation {
     responseType: string;
     clientId: string;
@@ -132,3 +195,11 @@ export interface OAuth2Token {
     updateTimestamp: Date;
     creationTimestamp: Date;
 }
+export interface OAuth2RefreshToken {
+    id: string;
+    applicationId: string;
+    userId: string;
+    expiryTimestamp: Date;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+}

package/build/types/mockType.d.ts

@@ -517,6 +517,13 @@ export declare type MockClientOAuth1<MockFn> = {
                 findAll: MockFn;
                 remove: MockFn;
             };
+            refreshTokens: {
+                find: MockFn;
+                findAll: MockFn;
+                findFirst: MockFn;
+                findById: MockFn;
+                remove: MockFn;
+            };
             createAuthorization: MockFn;
             getAuthorizations: MockFn;
             deleteAuthorization: MockFn;
@@ -1104,6 +1111,13 @@ export declare type MockClientOAuth2<MockFn> = {
                 findAll: MockFn;
                 remove: MockFn;
             };
+            refreshTokens: {
+                find: MockFn;
+                findAll: MockFn;
+                findFirst: MockFn;
+                findById: MockFn;
+                remove: MockFn;
+            };
             createAuthorization: MockFn;
             getAuthorizations: MockFn;
             deleteAuthorization: MockFn;
@@ -1691,6 +1705,13 @@ export declare type MockClientProxy<MockFn> = {
                 findAll: MockFn;
                 remove: MockFn;
             };
+            refreshTokens: {
+                find: MockFn;
+                findAll: MockFn;
+                findFirst: MockFn;
+                findById: MockFn;
+                remove: MockFn;
+            };
             createAuthorization: MockFn;
             getAuthorizations: MockFn;
             deleteAuthorization: MockFn;

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

@@ -1,4 +1,4 @@
-import type { HttpInstance } from '../../../types';
+import { HttpInstance } from '../../../types';
 import { HttpClient } from '../../http-client';
 import type { AuthOauth2Service } from './types';
 declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => AuthOauth2Service;

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

@@ -1,6 +1,7 @@
 import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
 export interface AuthOauth2Service {
     tokens: AuthOauth2TokenService;
+    refreshTokens: OAuth2RefreshTokenService;
     /**
      * Create an OAuth2 authorization
      *
@@ -79,6 +80,68 @@ export interface AuthOauth2TokenService {
      */
     remove(id: string): Promise<AffectedRecords>;
 }
+export interface OAuth2RefreshTokenService {
+    /**
+     * # Get a list of OAuth2 refresh tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param options.rql Add filters to the requested list
+     * @returns PagedResult<OAuth2RefreshToken>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<OAuth2RefreshToken>>;
+    /**
+     * Get a list of OAuth2 refresh tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param options.rql Add filters to the requested list
+     * @returns OAuth2RefreshToken[]
+     */
+    findAll(options?: OptionsWithRql): Promise<OAuth2RefreshToken[]>;
+    /**
+     * Get the first OAuth2 refresh token found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param options.rql Add filters to the requested list
+     * @returns {Promise<OAuth2RefreshToken | undefined>}
+     */
+    findFirst(options?: OptionsWithRql): Promise<OAuth2RefreshToken | undefined>;
+    /**
+     * Get an oAuth2 refresh token by its id
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 refresh tokens for this account
+     * VIEW_OAUTH2_REFRESH_TOKENS or VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 refresh tokens for any account
+     * Using VIEW_AUTHORIZATIONS for this endpoint is deprecated; use VIEW_OAUTH2_REFRESH_TOKENS instead
+     * @param id the refresh token id
+     * @param options.rql Add filters to the requested list
+     * @returns {Promise<OAuth2RefreshToken | undefined>}
+     */
+    findById(id: string, options?: OptionsWithRql): Promise<OAuth2RefreshToken | undefined>;
+    /**
+     * Delete an oAuth2 refresh token
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * DELETE_OAUTH2_REFRESH_TOKEN or DELETE_AUTHORIZATIONS | global | Required for this endpoint
+     * Using DELETE_AUTHORIZATIONS for this endpoint is deprecated; use DELETE_OAUTH2_REFRESH_TOKEN instead
+     * @param id the refresh token id
+     * @returns AffectedRecords
+     */
+    remove(id: string, options?: OptionsBase): Promise<AffectedRecords>;
+}
 export interface OAuth2AuthorizationCreation {
     responseType: string;
     clientId: string;
@@ -132,3 +195,11 @@ export interface OAuth2Token {
     updateTimestamp: Date;
     creationTimestamp: Date;
 }
+export interface OAuth2RefreshToken {
+    id: string;
+    applicationId: string;
+    userId: string;
+    expiryTimestamp: Date;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+}

package/build/types/version.d.ts

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

package/build/version.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.13.0-dev-184-9d8c16c",
+  "version": "8.13.0-dev-188-731b41d",
   "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",