@or-sdk/sdk-api 0.28.2 → 0.28.3-beta.4136.0

package/dist/cjs/SdkApi.js

@@ -76,6 +76,21 @@ var SdkApi = (function (_super) {
             });
         });
     };
+    SdkApi.prototype.generateLegacyToken = function () {
+        return __awaiter(this, arguments, void 0, function (params) {
+            if (params === void 0) { params = {}; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.callApiV2({
+                            method: 'POST',
+                            route: '/auth/token/legacy',
+                            data: params,
+                        })];
+                    case 1: return [2, _a.sent()];
+                }
+            });
+        });
+    };
     SdkApi.prototype.normalizeRoute = function (route) {
         if (route.startsWith('/')) {
             return route.substring(1);

package/dist/cjs/SdkApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"SdkApi.js","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAkD;AAElD,yCAA0C;AAG1C;IAA4B,0BAAI;IAE9B,gBAAY,MAAoB;QACtB,IAAA,KAAK,GAAsC,MAAM,MAA5C,EAAE,YAAY,GAAwB,MAAM,aAA9B,EAAE,SAAS,GAAa,MAAM,UAAnB,EAAE,MAAM,GAAK,MAAM,OAAX,CAAY;QAE1D,OAAA,MAAK,YAAC;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,uBAAW;YACvB,SAAS,WAAA;YACT,UAAU,EAAE,MAAM;SACnB,CAAC,SAAC;IACL,CAAC;IAEY,4BAAW,GAAxB,UAA4B,MAAoB;;;;4BACvC,WAAM,IAAI,CAAC,OAAO,CAAI,MAAM,CAAC,EAAA;4BAApC,WAAO,SAA6B,EAAC;;;;KACtC;IAES,+BAAc,GAAxB,UAAyB,KAAa;QAGpC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACH,aAAC;AAAD,CAAC,AA1BD,CAA4B,WAAI,GA0B/B;AA1BY,wBAAM"}
+{"version":3,"file":"SdkApi.js","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAkD;AAElD,yCAA0C;AAO1C;IAA4B,0BAAI;IAE9B,gBAAY,MAAoB;QACtB,IAAA,KAAK,GAAsC,MAAM,MAA5C,EAAE,YAAY,GAAwB,MAAM,aAA9B,EAAE,SAAS,GAAa,MAAM,UAAnB,EAAE,MAAM,GAAK,MAAM,OAAX,CAAY;QAE1D,OAAA,MAAK,YAAC;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,uBAAW;YACvB,SAAS,WAAA;YACT,UAAU,EAAE,MAAM;SACnB,CAAC,SAAC;IACL,CAAC;IAEY,4BAAW,GAAxB,UAA4B,MAAoB;;;;4BACvC,WAAM,IAAI,CAAC,OAAO,CAAI,MAAM,CAAC,EAAA;4BAApC,WAAO,SAA6B,EAAC;;;;KACtC;IAUY,oCAAmB,GAAhC;4DACE,MAAsC;YAAtC,uBAAA,EAAA,WAAsC;;;4BAE/B,WAAM,IAAI,CAAC,SAAS,CAA8B;4BACvD,MAAM,EAAE,MAAM;4BACd,KAAK,EAAE,oBAAoB;4BAC3B,IAAI,EAAE,MAAM;yBACb,CAAC,EAAA;4BAJF,WAAO,SAIL,EAAC;;;;KACJ;IAES,+BAAc,GAAxB,UAAyB,KAAa;QAGpC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACH,aAAC;AAAD,CAAC,AA5CD,CAA4B,WAAI,GA4C/B;AA5CY,wBAAM"}

package/dist/esm/SdkApi.js

@@ -25,6 +25,15 @@ export class SdkApi extends Base {
             return yield this.callApi(params);
         });
     }
+    generateLegacyToken() {
+        return __awaiter(this, arguments, void 0, function* (params = {}) {
+            return yield this.callApiV2({
+                method: 'POST',
+                route: '/auth/token/legacy',
+                data: params,
+            });
+        });
+    }
     normalizeRoute(route) {
         if (route.startsWith('/')) {
             return route.substring(1);

package/dist/esm/SdkApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"SdkApi.js","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,cAAc,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG1C,MAAM,OAAO,MAAO,SAAQ,IAAI;IAE9B,YAAY,MAAoB;QAC9B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAE1D,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,WAAW;YACvB,SAAS;YACT,UAAU,EAAE,MAAM;SACnB,CAAC,CAAC;IACL,CAAC;IAEY,WAAW,CAAI,MAAoB;;YAC9C,OAAO,MAAM,IAAI,CAAC,OAAO,CAAI,MAAM,CAAC,CAAC;QACvC,CAAC;KAAA;IAES,cAAc,CAAC,KAAa;QAGpC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}
+{"version":3,"file":"SdkApi.js","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,cAAc,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAO1C,MAAM,OAAO,MAAO,SAAQ,IAAI;IAE9B,YAAY,MAAoB;QAC9B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAE1D,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,WAAW;YACvB,SAAS;YACT,UAAU,EAAE,MAAM;SACnB,CAAC,CAAC;IACL,CAAC;IAEY,WAAW,CAAI,MAAoB;;YAC9C,OAAO,MAAM,IAAI,CAAC,OAAO,CAAI,MAAM,CAAC,CAAC;QACvC,CAAC;KAAA;IAUY,mBAAmB;6DAC9B,SAAoC,EAAE;YAEtC,OAAO,MAAM,IAAI,CAAC,SAAS,CAA8B;gBACvD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,oBAAoB;gBAC3B,IAAI,EAAE,MAAM;aACb,CAAC,CAAC;QACL,CAAC;KAAA;IAES,cAAc,CAAC,KAAa;QAGpC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/dist/types/SdkApi.d.ts

@@ -1,8 +1,17 @@
 import { Base, CalApiParams } from '@or-sdk/base';
-import { SdkApiConfig } from './types';
+import { GenerateLegacyTokenParams, GenerateLegacyTokenResponse, SdkApiConfig } from './types';
 export declare class SdkApi extends Base {
     constructor(params: SdkApiConfig);
     makeRequest<T>(params: CalApiParams): Promise<T>;
+    /**
+     * Exchange an API token for a 30-min legacy user token with USER role
+     *
+     * ```typescript
+     * const { token, expire } = await sdkApi.generateLegacyToken();
+     * const { token, expire } = await sdkApi.generateLegacyToken({ userId });
+     * ```
+     */
+    generateLegacyToken(params?: GenerateLegacyTokenParams): Promise<GenerateLegacyTokenResponse>;
     protected normalizeRoute(route: string): string;
 }
 //# sourceMappingURL=SdkApi.d.ts.map

package/dist/types/SdkApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SdkApi.d.ts","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,qBAAa,MAAO,SAAQ,IAAI;gBAElB,MAAM,EAAE,YAAY;IAYnB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7D,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAQhD"}
+{"version":3,"file":"SdkApi.d.ts","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,qBAAa,MAAO,SAAQ,IAAI;gBAElB,MAAM,EAAE,YAAY;IAYnB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7D;;;;;;;OAOG;IACU,mBAAmB,CAC9B,MAAM,GAAE,yBAA8B,GACrC,OAAO,CAAC,2BAA2B,CAAC;IAQvC,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAQhD"}

package/dist/types/types.d.ts

@@ -1,8 +1,37 @@
 import { Token } from '@or-sdk/base';
+export type GenerateLegacyTokenParams = {
+    /**
+     * userId for the generated token – must be an active user with role USER in the api-token's account
+     * Optional when the api-token's `createdBy` user already satisfies that requirement
+     */
+    userId?: string;
+};
+export type GenerateLegacyTokenResponse = {
+    /**
+     * Raw legacy user token
+     */
+    token: string;
+    /**
+     * Unix-ms timestamp when the token expires
+     */
+    expire: number;
+};
 export type SdkApiConfig = {
+    /**
+     * token
+     */
     token: Token;
+    /**
+     * Url of OneReach service discovery api
+     */
     discoveryUrl?: string;
+    /**
+     * Account ID for cross-account requests (super admin only)
+     */
     accountId?: string;
+    /**
+     * Url of OneReach SDK api
+     */
     sdkUrl?: string;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,YAAY,GAAG;IAIzB,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/sdk-api",
-  "version": "0.28.2",
+  "version": "0.28.3-beta.4136.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -26,6 +26,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "475a8aa2633c34c73873ec04ba593e0c56b90135"
+  }
 }

package/src/SdkApi.ts

@@ -1,7 +1,11 @@
 import { Base, CalApiParams } from '@or-sdk/base';
 
 import { SERVICE_KEY } from './constants';
-import { SdkApiConfig } from './types';
+import {
+  GenerateLegacyTokenParams,
+  GenerateLegacyTokenResponse,
+  SdkApiConfig,
+} from './types';
 
 export class SdkApi extends Base {
 
@@ -21,6 +25,24 @@ export class SdkApi extends Base {
     return await this.callApi<T>(params);
   }
 
+  /**
+   * Exchange an API token for a 30-min legacy user token with USER role
+   *
+   * ```typescript
+   * const { token, expire } = await sdkApi.generateLegacyToken();
+   * const { token, expire } = await sdkApi.generateLegacyToken({ userId });
+   * ```
+   */
+  public async generateLegacyToken(
+    params: GenerateLegacyTokenParams = {},
+  ): Promise<GenerateLegacyTokenResponse> {
+    return await this.callApiV2<GenerateLegacyTokenResponse>({
+      method: 'POST',
+      route: '/auth/token/legacy',
+      data: params,
+    });
+  }
+
   protected normalizeRoute(route: string): string {
     // turn off removal of spaces to support key-value-storage
     // since keys can have spaces in them

package/src/types.ts

@@ -1,5 +1,25 @@
 import { Token } from '@or-sdk/base';
 
+export type GenerateLegacyTokenParams = {
+  /**
+   * userId for the generated token – must be an active user with role USER in the api-token's account
+   * Optional when the api-token's `createdBy` user already satisfies that requirement
+   */
+  userId?: string;
+};
+
+export type GenerateLegacyTokenResponse = {
+  /**
+   * Raw legacy user token
+   */
+  token: string;
+
+  /**
+   * Unix-ms timestamp when the token expires
+   */
+  expire: number;
+};
+
 export type SdkApiConfig = {
   /**
    * token