@or-sdk/authorizer 0.24.14-beta.971.0 → 0.24.14-beta.976.0

package/src/OAuth/types.ts

@@ -10,9 +10,6 @@ export type OAuthConfig = {
   serviceName: string;
   keyValueCollection?: string;
   authKey: string;
-  accountId?: string;
-  eventManagerUrl?: string;
-  providersAccountId?: string;
 };
 
 export type OAuthData = {
@@ -32,8 +29,7 @@ export type OAuthData = {
 
 export type CreateOAuthConfig = {
   /**
-   * Name of OAuth service definition.
-   * If service definition is not found in global library, it will be taken from local library
+   * Name of OAuth service definition. If service definition is not found in global library, it will be taken from local library
    */
   serviceName: string;
 
@@ -59,31 +55,10 @@ export type CreateOAuthConfig = {
    */
   token: Token;
 
-  /*
-   * URL of Discovery API
-   */
   discoveryUrl: string;
-
-  /*
-   * URL of Event manager API
-   */
-  eventManagerUrl?: string;
-
-  /*
-   * Account ID of current account
-   */
-  accountId?: string;
-
-  /*
-   * Account ID of provider account
-   */
-  providersAccountId?: string;
 };
 
-export type CreateOAuthInCollectionConfig = Omit<CreateOAuthConfig, 'discoveryUrl' |
-'serviceName' |
-'token' |
-'keyValueCollection'>;
+export type CreateOAuthInCollectionConfig = Omit<CreateOAuthConfig, 'discoveryUrl' | 'serviceName' | 'token' | 'keyValueCollection'>;
 
 export type CreateOAuthResult = {
   authorizeUrl: string;
@@ -121,16 +96,13 @@ export type OAuthCollectionConfig = {
    */
   token: Token;
   discoveryUrl: string;
-  accountId?: string;
-  serviceName?: string;
+  serviceName: string;
   /**
    * Pass this if your using custom name for key-value collection that differs from serviceName
    */
   keyValueCollection?: string;
 };
 
-export type OAuthCollectionInitConfig = Pick<OAuthCollectionConfig, 'serviceName' | 'keyValueCollection'>;
-
 export type ServiceDefinitionConfig = {
   serviceName: string;
   requestDataType: string;
@@ -144,7 +116,6 @@ export type ServiceDefinitionConfig = {
   scopeType: ScopeType;
   authRequestAdditionalParams: string;
   codeExchangeRequestAdditionalParams: string;
-  // eslint-disable-next-line
   environments?: Record<string, any>;
   authLinkAdditionalParams?: Record<string, string>[];
   displayServiceName?: string;

package/src/Token/TokenAuth.ts

@@ -0,0 +1,102 @@
+import { KeyValueStorage } from '@or-sdk/key-value-storage';
+import { v4 as uuidv4 } from 'uuid';
+
+import { createAuthKey } from './utils/createAuthKey';
+
+import { TokenAuthConfig, TokenAuthData, CreateTokenAuthConfig } from './types';
+
+export class TokenAuth {
+  private readonly authKey: string;
+  private readonly serviceName: string;
+  private readonly keyValueStorage: KeyValueStorage;
+
+  constructor(params: TokenAuthConfig) {
+    const { token, discoveryUrl, authKey, serviceName } = params;
+
+    this.authKey = authKey;
+    this.serviceName = serviceName;
+    this.keyValueStorage = new KeyValueStorage({
+      token,
+      discoveryUrl,
+    });
+  }
+
+  /**
+   * Creates a new auth record in specified collection with the given config.
+   * @returns TokenAuth instance connected to created auth
+   *
+   * ```typescript
+   * const instance = await TokenAuth.create({
+   *   token: 'my-account-token-string',
+   *   discoveryUrl: 'discovery.example.onereach.ai',
+   *   serviceName: '__authorization_service_test_service',
+   *   authName: 'my-auth-name',
+   *   credentials: {
+   *      token: 'secrettoken'
+   *   }
+   * });
+   * ```
+   */
+  static async create(params: CreateTokenAuthConfig): Promise<TokenAuth> {
+    if (!(params.serviceName && params.authName && params.credentials && params.discoveryUrl && params.token)) {
+      throw new Error('Invalid config passed');
+    }
+
+    const { serviceName, authName, credentials, discoveryUrl, token } = params;
+
+    const keyValueStorage = new KeyValueStorage({
+      token,
+      discoveryUrl,
+    });
+
+    const id = uuidv4();
+    const authKey = createAuthKey(id, authName);
+
+    const authData = {
+      ...credentials,
+      auth_name: authName,
+      date_created: new Date().toISOString(),
+    };
+
+    await keyValueStorage.setValueByKey(serviceName, authKey, authData);
+
+    return new TokenAuth({
+      serviceName,
+      authKey,
+      discoveryUrl,
+      token,
+    });
+  }
+
+  /**
+   * Updates credentials
+   */
+  public async update(newCredentials: Record<string, unknown>): Promise<TokenAuthData> {
+    const data = await this.getAuthData();
+
+    const updatedData = {
+      ...data,
+      ...newCredentials,
+    };
+
+    const response = await this.keyValueStorage.setValueByKey(this.serviceName, this.authKey, updatedData);
+
+    const updatedRecord = response.value;
+    return updatedRecord as TokenAuthData;
+  }
+
+  /**
+   * Returns authorization data
+   */
+  public async getAuthData(): Promise<TokenAuthData> {
+    const { value } = await this.keyValueStorage.getValueByKey(this.serviceName, this.authKey);
+    return value as TokenAuthData;
+  }
+
+  /**
+   * Deletes authorization from collection
+   */
+  public async delete(): Promise<void> {
+    await this.keyValueStorage.deleteKey(this.serviceName, this.authKey);
+  }
+}

package/src/Token/TokenCollection.ts

@@ -1,81 +1,62 @@
-import { makeList, List } from '@or-sdk/base';
+import { Token } from '@or-sdk/base';
 import { KeyValueStorage } from '@or-sdk/key-value-storage';
-import { v4 as uuidv4 } from 'uuid';
-import { createAuthKey } from './utils/createAuthKey';
+import { TokenAuth } from './TokenAuth';
 
 import {
   TokenCollectionConfig,
   CreateTokenAuthInCollectionConfig,
-  TokenAuthData,
 } from './types';
 
 export class TokenCollection {
-  private serviceName: string;
+  private readonly serviceName: string;
   private readonly keyValueStorage: KeyValueStorage;
+  private readonly localToken: Token;
+  private readonly localDiscoveryUrl: string;
 
   constructor(params: TokenCollectionConfig) {
-    const { token, discoveryUrl, serviceName, accountId } = params;
+    const { token, discoveryUrl, serviceName } = params;
 
-    this.serviceName = serviceName || '';
+    this.localToken = token;
+    this.localDiscoveryUrl = discoveryUrl;
+    this.serviceName = serviceName;
     this.keyValueStorage = new KeyValueStorage({
       token,
       discoveryUrl,
-      accountId,
     });
   }
 
-
-  /**
-   * Allows to explicitly (re-)set authorization service name
-   */
-  public init(serviceName: string) {
-    if (!serviceName) throw new Error('Servide name is required.');
-
-    this.serviceName = serviceName;
-  }
-
-
   /**
    * Returns array of auth keys from this collection
    */
-  public async listAuthorizations(): Promise<List<string>> {
+  public async listAuthorizations(): Promise<string[]> {
     const { items: records } = await this.keyValueStorage.listKeys(this.serviceName);
 
-    return makeList<string>(records.map((record) => record.key).filter(key => key.includes('::token')));
+    return records.map((record) => record.key);
   }
 
   /**
    * Returns TokenAuth instance for given key
    */
-  public async getAuthorization(key: string): Promise<TokenAuthData> {
-    if (!this.serviceName) throw new Error('Service name is not defined.');
-    if (!key.includes('::token')) throw new Error('The Token authorization key should contain "token" type specifier.');
-
-
-    const record = await this.keyValueStorage.getValueByKey(this.serviceName, encodeURIComponent(key));
+  public async getAuthorization(key: string): Promise<TokenAuth> {
+    const record = await this.keyValueStorage.getValueByKey(this.serviceName, key);
     if (!record.value) {
       throw new Error('Authorization does not exist');
     }
 
-    const authData = record.value as Omit<TokenAuthData, 'key'>;
-
-    if (!authData.auth_name || !authData.date_created) {
-      throw new Error('Authorization is invalid.');
-    }
-
-    return {
-      ...authData,
-      key,
-    } as TokenAuthData;
+    return new TokenAuth({
+      serviceName: this.serviceName,
+      authKey: key,
+      discoveryUrl: this.localDiscoveryUrl,
+      token: this.localToken,
+    });
   }
 
-
   /**
    * Creates a new auth record in current collection with the given config.
    * @returns TokenCollection instance connected to created auth
    *
    * ```typescript
-   * const tokenCollectionData = await tokenCollectionInstance.createAuthorization({
+   * const tokenCollectionInstance = await tokenCollectionInstance.createAuthorization({
    *   authName: 'my-auth-name',
    *   credentials: {
    *      token: 'secrettoken'
@@ -85,64 +66,13 @@ export class TokenCollection {
    */
   public async createAuthorization(
     params: CreateTokenAuthInCollectionConfig
-  ): Promise<TokenAuthData> {
-    const { authName, credentials } = params;
-
-    if (!this.serviceName) throw new Error('Service name is not defined.');
-    if (!authName || !credentials) throw new Error('Invalid authorization parameters passed.');
-
-    const id = uuidv4();
-    const authKey = createAuthKey(id, authName);
-
-    const authData = {
-      ...credentials,
-      auth_name: authName,
-      date_created: new Date().toISOString(),
-    } as Omit<TokenAuthData, 'key'>;
-
-    await this.keyValueStorage.setValueByKey(this.serviceName, encodeURIComponent(authKey), authData);
-
-    return {
-      ...authData,
-      key: authKey,
-    } as TokenAuthData;
-  }
-
-
-  /**
-   * Updates credentials
-   */
-  public async updateAuthorization(
-    tokenAuth: TokenAuthData,
-    newCredentials: Record<string, unknown>
-  ): Promise<TokenAuthData> {
-    if (!this.serviceName) throw new Error('Service name is not defined.');
-    if (!newCredentials) throw new Error('New credentials are empty or invalid');
-    if (!tokenAuth || !tokenAuth.auth_name || !tokenAuth.date_created)
-      throw new Error('Token authorization data is invalid');
-
-    const updatedData = {
-      ...tokenAuth,
-      ...newCredentials,
-      key: undefined,
-    };
-
-    const response = await this.keyValueStorage.setValueByKey(this.serviceName, encodeURIComponent(tokenAuth.key), updatedData);
-
-    const updatedRecord = response.value as Omit<TokenAuthData, 'key'>;
-    return {
-      ...updatedRecord,
-      key: tokenAuth.key,
-    } as TokenAuthData;
-  }
-
-
-  /**
-   * Deletes authorization from collection
-   */
-  public async deleteAuthorization(key: string): Promise<void> {
-    if (!this.serviceName) throw new Error('Service name is not defined.');
-    if (!key) throw new Error('Key is missing or invalid');
-    await this.keyValueStorage.deleteKey(this.serviceName, encodeURIComponent(key));
+  ): Promise<TokenAuth> {
+    return await TokenAuth.create({
+      discoveryUrl: this.localDiscoveryUrl,
+      token: this.localToken,
+      serviceName: this.serviceName,
+      authName: params.authName,
+      credentials: params.credentials,
+    });
   }
 }

package/src/Token/types.ts

@@ -12,7 +12,6 @@ export type TokenAuthConfig = {
 
 export type TokenAuthData = {
   auth_name: string;
-  key: string;
   /**
    * Datetime of auth creation in YYYY-MM-DDTHH:MM:SSZ format
    */
@@ -49,5 +48,4 @@ export type TokenCollectionConfig = {
   token: Token;
   discoveryUrl: string;
   serviceName: string;
-  accountId?: string;
 };

package/src/index.ts

@@ -1,5 +1,10 @@
-export { BasicCollection } from './Basic/index';
-export { TokenCollection } from './Token/index';
-export { OAuth, OAuthCollection } from './OAuth/index';
+export { BasicAuth } from './Basic/BasicAuth';
+export { BasicCollection } from './Basic/BasicCollection';
+
+export { TokenAuth } from './Token/TokenAuth';
+export { TokenCollection } from './Token/TokenCollection';
+
+export { OAuth } from './OAuth/OAuth';
+export { OAuthCollection } from './OAuth/OAuthCollection';
 
 export * from './types';

package/dist/cjs/Basic/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BasicCollection = void 0;
-var BasicCollection_1 = require("./BasicCollection");
-Object.defineProperty(exports, "BasicCollection", { enumerable: true, get: function () { return BasicCollection_1.BasicCollection; } });
-__exportStar(require("./types"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/Basic/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Basic/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qDAAoD;AAA3C,kHAAA,eAAe,OAAA;AAExB,0CAAwB"}

package/dist/cjs/OAuth/index.js

@@ -1,23 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OAuthCollection = exports.OAuth = void 0;
-var OAuth_1 = require("./OAuth");
-Object.defineProperty(exports, "OAuth", { enumerable: true, get: function () { return OAuth_1.OAuth; } });
-var OAuthCollection_1 = require("./OAuthCollection");
-Object.defineProperty(exports, "OAuthCollection", { enumerable: true, get: function () { return OAuthCollection_1.OAuthCollection; } });
-__exportStar(require("./types"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/OAuth/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/OAuth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iCAAgC;AAAvB,8FAAA,KAAK,OAAA;AACd,qDAAoD;AAA3C,kHAAA,eAAe,OAAA;AAExB,0CAAwB"}

package/dist/cjs/Token/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenCollection = void 0;
-var TokenCollection_1 = require("./TokenCollection");
-Object.defineProperty(exports, "TokenCollection", { enumerable: true, get: function () { return TokenCollection_1.TokenCollection; } });
-__exportStar(require("./types"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/Token/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Token/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qDAAoD;AAA3C,kHAAA,eAAe,OAAA;AAExB,0CAAwB"}

package/dist/esm/Basic/index.js

@@ -1,3 +0,0 @@
-export { BasicCollection } from './BasicCollection';
-export * from './types';
-//# sourceMappingURL=index.js.map

package/dist/esm/Basic/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Basic/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,cAAc,SAAS,CAAC"}

package/dist/esm/OAuth/index.js

@@ -1,4 +0,0 @@
-export { OAuth } from './OAuth';
-export { OAuthCollection } from './OAuthCollection';
-export * from './types';
-//# sourceMappingURL=index.js.map

package/dist/esm/OAuth/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/OAuth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,cAAc,SAAS,CAAC"}

package/dist/esm/Token/index.js

@@ -1,3 +0,0 @@
-export { TokenCollection } from './TokenCollection';
-export * from './types';
-//# sourceMappingURL=index.js.map

package/dist/esm/Token/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Token/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,cAAc,SAAS,CAAC"}

package/dist/types/Basic/index.d.ts

@@ -1,3 +0,0 @@
-export { BasicCollection } from './BasicCollection';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/Basic/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Basic/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,cAAc,SAAS,CAAC"}

package/dist/types/OAuth/index.d.ts

@@ -1,4 +0,0 @@
-export { OAuth } from './OAuth';
-export { OAuthCollection } from './OAuthCollection';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/OAuth/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/OAuth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,cAAc,SAAS,CAAC"}

package/dist/types/Token/index.d.ts

@@ -1,3 +0,0 @@
-export { TokenCollection } from './TokenCollection';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/Token/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Token/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,cAAc,SAAS,CAAC"}

package/src/Basic/index.ts

@@ -1,3 +0,0 @@
-export { BasicCollection } from './BasicCollection';
-
-export * from './types';

package/src/OAuth/index.ts

@@ -1,4 +0,0 @@
-export { OAuth } from './OAuth';
-export { OAuthCollection } from './OAuthCollection';
-
-export * from './types';

package/src/Token/index.ts

@@ -1,3 +0,0 @@
-export { TokenCollection } from './TokenCollection';
-
-export * from './types';