@rc-ex/rcsdk 1.2.0 → 1.2.2

package/README.md

@@ -1,6 +1,8 @@
 # RingCentral SDK extension
 
-This extension makes [@ringcentral/sdk](https://www.npmjs.com/package/@ringcentral/sdk) the HTTP engine.
+This extension makes
+[@ringcentral/sdk](https://www.npmjs.com/package/@ringcentral/sdk) the HTTP
+engine.
 
 ## Install
 
@@ -11,9 +13,9 @@ yarn add @rc-ex/rcsdk
 ## Usage
 
 ```ts
-import SDK from '@ringcentral/sdk';
-import RingCentral from '@rc-ex/core';
-import RcSdkExtension from '@rc-ex/rcsdk';
+import SDK from "@ringcentral/sdk";
+import RingCentral from "@rc-ex/core";
+import RcSdkExtension from "@rc-ex/rcsdk";
 
 // @ringcentral/sdk
 const sdk = new SDK({ clientId, clientSecret, server });
@@ -28,19 +30,25 @@ await rc.installExtension(rcSdkExtension);
 const extensionInfo = await rc.restapi().account().extension().get();
 ```
 
-For a working sample, please check this [test case](../../../test/rcsdk-extension.spec.ts).
+For a working sample, please check this
+[test case](../../../test/rcsdk-extension.spec.ts).
 
 ## Known issues
 
-`multipart/form-data` does not work, because `@rc-ex/core` is originally designed for [axios](https://github.com/axios/axios).
-For such cases, please use `@ringcentral/sdk` directly, such as `await sdk.post('/restapi/v1.0/account/~/extension/~/fax', ...);`
+`multipart/form-data` does not work, because `@rc-ex/core` is originally
+designed for [axios](https://github.com/axios/axios). For such cases, please use
+`@ringcentral/sdk` directly, such as
+`await sdk.post('/restapi/v1.0/account/~/extension/~/fax', ...);`
 
-Some extensions don't work with this extension. For example, the Retry Extension and RateLimit Extension because they rely on RestException object which `@ringcentral/sdk` doesn't throw.
+Some extensions don't work with this extension. For example, the Retry Extension
+and RateLimit Extension because they rely on RestException object which
+`@ringcentral/sdk` doesn't throw.
 
 ## Switch between @ringcentral/sdk and axios
 
-[axios][https://github.com/axios/axios] is the default HTTP engine.
-This extension makes `@ringcentral/sdk` as HTTP engine. to switch back to `axios`, just disable this extension:
+[axios][https://github.com/axios/axios] is the default HTTP engine. This
+extension makes `@ringcentral/sdk` as HTTP engine. to switch back to `axios`,
+just disable this extension:
 
 ```ts
 // ringcentral-extensible + rcsdk extension
@@ -56,5 +64,6 @@ rcSdkExtension.disable();
 const extensionInfo2 = await rc.restapi().account().extension().get();
 ```
 
-Please note that by default `@ringcentral/sdk` and `axios` doesn't share tokens. You may need to manage tokens separately.
-Or you can make them share tokens explicitly by getting token from one and setting to the other.
+Please note that by default `@ringcentral/sdk` and `axios` doesn't share tokens.
+You may need to manage tokens separately. Or you can make them share tokens
+explicitly by getting token from one and setting to the other.

package/lib/index.d.ts

@@ -1,6 +1,6 @@
-import type RingCentral from '@rc-ex/core';
-import SdkExtension from '@rc-ex/core/lib/SdkExtension';
-import type SDK from '@ringcentral/sdk';
+import type RingCentral from "@rc-ex/core";
+import SdkExtension from "@rc-ex/core/src/SdkExtension";
+import type SDK from "@ringcentral/sdk";
 export interface RcSdkOptions {
     rcSdk: SDK;
 }

package/lib/index.js

@@ -3,15 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const SdkExtension_1 = __importDefault(require("@rc-ex/core/lib/SdkExtension"));
-const RestException_1 = __importDefault(require("@rc-ex/core/lib/RestException"));
+const SdkExtension_1 = __importDefault(require("@rc-ex/core/src/SdkExtension"));
+const RestException_1 = __importDefault(require("@rc-ex/core/src/RestException"));
 class RcSdkExtension extends SdkExtension_1.default {
     constructor(options) {
         super();
         this.options = options;
     }
     async install(rc) {
-        Object.defineProperty(rc, 'token', {
+        Object.defineProperty(rc, "token", {
             get: async () => this.options.rcSdk.platform().auth().data(),
         });
         const request = rc.request.bind(rc);
@@ -45,7 +45,6 @@ class RcSdkExtension extends SdkExtension_1.default {
             throw new RestException_1.default(response);
         };
     }
-    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-empty-function
     async revoke() { }
 }
 exports.default = RcSdkExtension;

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAEA,gFAAwD;AACxD,kFAA0D;AAO1D,MAAM,cAAe,SAAQ,sBAAY;IAGvC,YAAmB,OAAqB;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,EAAe;QAClC,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,OAAO,EAAE;YACjC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE;SAC7D,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpC,EAAE,CAAC,OAAO,GAAG,KAAK,EAChB,MAAkB,EAClB,QAAgB,EAChB,OAAY,EACZ,WAAgB,EAChB,MAA0B,EAEA,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;YACjE,CAAC;YACD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;gBACtC,MAAM;gBACN,GAAG,EAAE,QAAQ;gBACb,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,WAAW;gBAClB,OAAO,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO;aACzB,CAAC,CAAC;YACH,MAAM,QAAQ,GAAiB;gBAC7B,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE;gBACpB,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,OAAO,EAAE,CAAC,CAAC,OAA4C;gBACvD,MAAM,EAAE;oBACN,MAAM;oBACN,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;oBACjC,GAAG,EAAE,QAAQ;oBACb,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE,WAAW;iBACb;aACT,CAAC;YACF,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;gBACT,OAAO,QAAQ,CAAC;YAClB,CAAC;YACD,MAAM,IAAI,uBAAa,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC;IAED,wFAAwF;IACjF,KAAK,CAAC,MAAM,KAAmB,CAAC;CACxC;AAED,kBAAe,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAMA,gFAAwD;AACxD,kFAA0D;AAO1D,MAAM,cAAe,SAAQ,sBAAY;IAGvC,YAAmB,OAAqB;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,EAAe;QAClC,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,OAAO,EAAE;YACjC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE;SAC7D,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpC,EAAE,CAAC,OAAO,GAAG,KAAK,EAChB,MAAkB,EAClB,QAAgB,EAChB,OAAY,EACZ,WAAgB,EAChB,MAA0B,EACA,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;YACjE,CAAC;YACD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;gBACtC,MAAM;gBACN,GAAG,EAAE,QAAQ;gBACb,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,WAAW;gBAClB,OAAO,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO;aACzB,CAAC,CAAC;YACH,MAAM,QAAQ,GAAiB;gBAC7B,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE;gBACpB,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,OAAO,EAAE,CAAC,CAAC,OAA4C;gBACvD,MAAM,EAAE;oBACN,MAAM;oBACN,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;oBACjC,GAAG,EAAE,QAAQ;oBACb,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE,WAAW;iBACb;aACT,CAAC;YACF,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;gBACT,OAAO,QAAQ,CAAC;YAClB,CAAC;YACD,MAAM,IAAI,uBAAa,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,KAAmB,CAAC;CACxC;AAED,kBAAe,cAAc,CAAC"}

package/lib/index.ts

@@ -0,0 +1,68 @@
+import type RingCentral from "@rc-ex/core";
+import type {
+  RestMethod,
+  RestRequestConfig,
+  RestResponse,
+} from "@rc-ex/core/src/types";
+import SdkExtension from "@rc-ex/core/src/SdkExtension";
+import RestException from "@rc-ex/core/src/RestException";
+import type SDK from "@ringcentral/sdk";
+
+export interface RcSdkOptions {
+  rcSdk: SDK;
+}
+
+class RcSdkExtension extends SdkExtension {
+  public options: RcSdkOptions;
+
+  public constructor(options: RcSdkOptions) {
+    super();
+    this.options = options;
+  }
+
+  public async install(rc: RingCentral) {
+    Object.defineProperty(rc, "token", {
+      get: async () => this.options.rcSdk.platform().auth().data(),
+    });
+    const request = rc.request.bind(rc);
+    rc.request = async <T>(
+      method: RestMethod,
+      endpoint: string,
+      content?: {},
+      queryParams?: {},
+      config?: RestRequestConfig,
+    ): Promise<RestResponse<T>> => {
+      if (!this.enabled) {
+        return request(method, endpoint, content, queryParams, config);
+      }
+      const r = await this.options.rcSdk.send({
+        method,
+        url: endpoint,
+        body: content,
+        query: queryParams,
+        headers: config?.headers,
+      });
+      const response: RestResponse = {
+        data: await r.json(),
+        status: r.status,
+        statusText: r.statusText,
+        headers: r.headers as unknown as Record<string, string>,
+        config: {
+          method,
+          baseURL: r.url.split(endpoint)[0],
+          url: endpoint,
+          data: content,
+          params: queryParams,
+        } as any,
+      };
+      if (r.ok) {
+        return response;
+      }
+      throw new RestException(response);
+    };
+  }
+
+  public async revoke(): Promise<void> {}
+}
+
+export default RcSdkExtension;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@rc-ex/rcsdk",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "@ringcentral/sdk extension for ringcentral-extensible project",
   "author": "Tyler Liu <tyler.liu@ringcentral.com>",
   "homepage": "https://github.com/ringcentral/ringcentral-extensible/tree/master/packages/extensions/rcsdk",
   "license": "MIT",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ringcentral/ringcentral-extensible.git"
@@ -18,8 +18,8 @@
     "access": "public"
   },
   "devDependencies": {
-    "@rc-ex/core": "^1.5.0",
+    "@rc-ex/core": "^1.5.2",
     "@ringcentral/sdk": "^5.0.3"
   },
-  "gitHead": "03fab0f9fc3d924054df16abd6854a5063e19829"
+  "gitHead": "a0e465fd1f5d4b0758e6c3641635d5d2ee6c9a3a"
 }

package/src/index.d.ts

@@ -0,0 +1,13 @@
+import type RingCentral from "@rc-ex/core";
+import SdkExtension from "@rc-ex/core/src/SdkExtension";
+import type SDK from "@ringcentral/sdk";
+export interface RcSdkOptions {
+    rcSdk: SDK;
+}
+declare class RcSdkExtension extends SdkExtension {
+    options: RcSdkOptions;
+    constructor(options: RcSdkOptions);
+    install(rc: RingCentral): Promise<void>;
+    revoke(): Promise<void>;
+}
+export default RcSdkExtension;

package/src/index.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const SdkExtension_1 = __importDefault(require("@rc-ex/core/src/SdkExtension"));
+const RestException_1 = __importDefault(require("@rc-ex/core/src/RestException"));
+class RcSdkExtension extends SdkExtension_1.default {
+    constructor(options) {
+        super();
+        this.options = options;
+    }
+    async install(rc) {
+        Object.defineProperty(rc, "token", {
+            get: async () => this.options.rcSdk.platform().auth().data(),
+        });
+        const request = rc.request.bind(rc);
+        rc.request = async (method, endpoint, content, queryParams, config) => {
+            if (!this.enabled) {
+                return request(method, endpoint, content, queryParams, config);
+            }
+            const r = await this.options.rcSdk.send({
+                method,
+                url: endpoint,
+                body: content,
+                query: queryParams,
+                headers: config === null || config === void 0 ? void 0 : config.headers,
+            });
+            const response = {
+                data: await r.json(),
+                status: r.status,
+                statusText: r.statusText,
+                headers: r.headers,
+                config: {
+                    method,
+                    baseURL: r.url.split(endpoint)[0],
+                    url: endpoint,
+                    data: content,
+                    params: queryParams,
+                },
+            };
+            if (r.ok) {
+                return response;
+            }
+            throw new RestException_1.default(response);
+        };
+    }
+    async revoke() { }
+}
+exports.default = RcSdkExtension;
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAMA,gFAAwD;AACxD,kFAA0D;AAO1D,MAAM,cAAe,SAAQ,sBAAY;IAGvC,YAAmB,OAAqB;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,EAAe;QAClC,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,OAAO,EAAE;YACjC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE;SAC7D,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpC,EAAE,CAAC,OAAO,GAAG,KAAK,EAChB,MAAkB,EAClB,QAAgB,EAChB,OAAY,EACZ,WAAgB,EAChB,MAA0B,EACA,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;YACjE,CAAC;YACD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;gBACtC,MAAM;gBACN,GAAG,EAAE,QAAQ;gBACb,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,WAAW;gBAClB,OAAO,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO;aACzB,CAAC,CAAC;YACH,MAAM,QAAQ,GAAiB;gBAC7B,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE;gBACpB,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,OAAO,EAAE,CAAC,CAAC,OAA4C;gBACvD,MAAM,EAAE;oBACN,MAAM;oBACN,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;oBACjC,GAAG,EAAE,QAAQ;oBACb,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE,WAAW;iBACb;aACT,CAAC;YACF,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;gBACT,OAAO,QAAQ,CAAC;YAClB,CAAC;YACD,MAAM,IAAI,uBAAa,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,KAAmB,CAAC;CACxC;AAED,kBAAe,cAAc,CAAC"}

package/src/index.ts

@@ -1,8 +1,12 @@
-import type RingCentral from '@rc-ex/core';
-import type { RestRequestConfig, RestResponse, RestMethod } from '@rc-ex/core/lib/types';
-import SdkExtension from '@rc-ex/core/lib/SdkExtension';
-import RestException from '@rc-ex/core/lib/RestException';
-import type SDK from '@ringcentral/sdk';
+import type RingCentral from "@rc-ex/core";
+import type {
+  RestMethod,
+  RestRequestConfig,
+  RestResponse,
+} from "@rc-ex/core/src/types";
+import SdkExtension from "@rc-ex/core/src/SdkExtension";
+import RestException from "@rc-ex/core/src/RestException";
+import type SDK from "@ringcentral/sdk";
 
 export interface RcSdkOptions {
   rcSdk: SDK;
@@ -17,7 +21,7 @@ class RcSdkExtension extends SdkExtension {
   }
 
   public async install(rc: RingCentral) {
-    Object.defineProperty(rc, 'token', {
+    Object.defineProperty(rc, "token", {
       get: async () => this.options.rcSdk.platform().auth().data(),
     });
     const request = rc.request.bind(rc);
@@ -27,7 +31,6 @@ class RcSdkExtension extends SdkExtension {
       content?: {},
       queryParams?: {},
       config?: RestRequestConfig,
-      // eslint-disable-next-line max-params
     ): Promise<RestResponse<T>> => {
       if (!this.enabled) {
         return request(method, endpoint, content, queryParams, config);
@@ -59,7 +62,6 @@ class RcSdkExtension extends SdkExtension {
     };
   }
 
-  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-empty-function
   public async revoke(): Promise<void> {}
 }
 

package/tsconfig.json

@@ -1,7 +1,4 @@
 {
   "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "lib"
-  },
   "include": ["src"]
 }