dataopen-sdk-nodejs - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

dist/index.d.ts

@@ -5,3 +5,2 @@ export declare class Client {
     url: string | null;
-    env: string | null;
     expiration: string | null;
@@ -12,4 +11,3 @@ private _access_token;
     static OPEN_APIS_PATH: string;
-    constructor(app_id: string, app_secret: string, url?: string | null, env?: string | null, // "dataopen" | "dataopen_staging"
-    expiration?: string | null);
+    constructor(app_id: string, app_secret: string, url?: string | null, expiration?: string | null);
     request(service_url: string, method: string, headers?: Record<string, string>, params?: Record<string, any>, body?: Record<string, any>): Promise<Record<string, any>>;
@@ -16,0 +14,0 @@ handle_token(): Promise<void>;

dist/index.js

@@ -71,6 +71,4 @@ "use strict";
 var Client = exports.Client = /** @class */ (function () {
-    function Client(app_id, app_secret, url, env, // "dataopen" | "dataopen_staging"
-    expiration) {
+    function Client(app_id, app_secret, url, expiration) {
         if (url === void 0) { url = "https://analytics.volcengineapi.com"; }
-        if (env === void 0) { env = "dataopen"; }
         if (expiration === void 0) { expiration = "1800"; }
@@ -80,3 +78,2 @@ this.app_id = app_id;
         this.url = url;
-        this.env = env;
         this.expiration = expiration;
@@ -110,3 +107,3 @@ this._ttl = 0;
                         }
-                        completed_url = this.url + "/" + this.env + Client.OPEN_APIS_PATH + service_url;
+                        completed_url = this.url + service_url;
                         query_url = this._joint_query(completed_url, params);
@@ -150,4 +147,4 @@ fetchOptions = {
                     case 0:
-                        authorization_url = this.env + Client.OPEN_APIS_PATH + "/v1/authorization";
-                        completed_url = this.url + "/" + authorization_url;
+                        authorization_url = Client.OPEN_APIS_PATH + "/v1/authorization";
+                        completed_url = this.url + authorization_url;
                         map = {
@@ -195,4 +192,4 @@ app_id: this.app_id,
     };
-    Client.OPEN_APIS_PATH = "/open-apis";
+    Client.OPEN_APIS_PATH = "/dataopen/open-apis";
     return Client;
 }());

examples/index.js

@@ -18,3 +18,3 @@ import { Client } from "dataopen-sdk-nodejs";
   let res = await client.request(
-    "/xxx/openapi/v1/open/flight-list",
+    "/dataopen/open-apis/xxx/openapi/v1/open/flight-list",
     "GET",
@@ -45,3 +45,3 @@ headers,
   let res = await client.request(
-    `/xxx/openapi/v1/open/flight/version/${version_id}/add-test-user`,
+    `/dataopen/open-apis/xxx/openapi/v1/open/flight/version/${version_id}/add-test-user`,
     "POST",
@@ -48,0 +48,0 @@ headers,

package.json

 {
   "name": "dataopen-sdk-nodejs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
@@ -27,3 +27,3 @@ "main": "./dist/index.js",
   },
-  "readme": "# openapi 使用说明\n\n## Client参数说明\n\n| 字段       | 类型            | 默认值                          | 含义                            |\n|------------|-----------------|---------------------------------|---------------------------------|\n| app_id     | string          | 无                              | 应用的唯一标识符                  |\n| app_secret | string          | 无                              | 用于应用的安全认证的密钥          |\n| url        | string or null  | \"https://analytics.volcengineapi.com\"    | 服务器的URL地址                  |\n| env        | string or null  | \"dataopen\"                      | 环境设置，可选值为 \"dataopen\" 或 \"dataopen_staging\" |\n| expiration | string or null  | \"1800\"                          | 过期时间，单位是秒            |\n\n## client.request参数说明\n\n| 字段         | 类型                       | 默认值    | 含义                                            |\n|--------------|----------------------------|-----------|------------------------------------------------|\n| service_url  | string                     | 无        | 请求的服务 URL 地址                            |\n| method       | string                     | 无        | 请求的 HTTP 方法，例如 \"GET\", \"POST\" 等        |\n| headers      | Record<string, string>     | {}        | 请求头，包含的信息如认证凭据，内容类型等       |\n| params       | Record<string, any> | {}        | URL 参数，用于GET请求                          |\n| body         | Record<string, any>        | {}        | 请求体，通常在POST或PUT请求中包含发送的数据    |\n\n\n## 样例\n\n### 1、Get 方法\n\n```TS\nimport { Client } from \"dataopen-sdk-nodejs\";\n\nlet app_id = \"\";\nlet app_secret = \"\";\nlet url = \"\";\n\nlet client = new Client(app_id, app_secret, url);\n\nlet headers = {};\n\nlet params: Record<string, any> = {\n  app: 46,\n  page_size: 10,\n  page: 1,\n};\n\nlet res = await client.request(\n  \"/xxx/openapi/v1/open/flight-list\",\n  \"GET\",\n  headers,\n  params,\n);\n\nconsole.log(\"Output: \", res);\n```\n\n### 2、Post 方法\n\n```TS\nimport { Client } from \"dataopen-sdk-nodejs\";\n\nlet app_id = \"\";\nlet app_secret = \"\";\nlet url = \"\";\n\nlet client = new Client(app_id, app_secret, url);\n\nlet headers = {};\n\nlet params = {};\n\nlet body: Record<string, any> = {\n  uid_list: [\"1111111110000\"],\n};\n\nlet version_id = 6290880;\n\nlet res = await client.request(\n  `/xxx/openapi/v1/open/flight/version/${version_id}/add-test-user`,\n  \"POST\",\n  headers,\n  params,\n  body\n);\n\nconsole.log(\"Output: \", res);\n```\n"
+  "readme": "# openapi 使用说明\n\n## Client参数说明\n\n| 字段       | 类型            | 默认值                          | 含义                            |\n|------------|-----------------|---------------------------------|---------------------------------|\n| app_id     | string          | 无                              | 应用的唯一标识符                  |\n| app_secret | string          | 无                              | 用于应用的安全认证的密钥          |\n| url        | string or null  | \"https://analytics.volcengineapi.com\"    | 服务器的URL地址                  |\n| expiration | string or null  | \"1800\"                          | 过期时间，单位是秒            |\n\n## client.request参数说明\n\n| 字段         | 类型                       | 默认值    | 含义                                            |\n|--------------|----------------------------|-----------|------------------------------------------------|\n| service_url  | string                     | 无        | 请求的服务 URL 地址                            |\n| method       | string                     | 无        | 请求的 HTTP 方法，例如 \"GET\", \"POST\" 等        |\n| headers      | Record<string, string>     | {}        | 请求头，包含的信息如认证凭据，内容类型等       |\n| params       | Record<string, any> | {}        | URL 参数，用于GET请求                          |\n| body         | Record<string, any>        | {}        | 请求体，通常在POST或PUT请求中包含发送的数据    |\n\n\n## 样例\n\n### 1、Get 方法\n\n```TS\nimport { Client } from \"dataopen-sdk-nodejs\";\n\nlet app_id = \"\";\nlet app_secret = \"\";\nlet url = \"\";\n\nlet client = new Client(app_id, app_secret, url);\n\nlet headers = {};\n\nlet params: Record<string, any> = {\n  app: 46,\n  page_size: 10,\n  page: 1,\n};\n\nlet res = await client.request(\n  \"/dataopen/open-apis/xxx/openapi/v1/open/flight-list\",\n  \"GET\",\n  headers,\n  params,\n);\n\nconsole.log(\"Output: \", res);\n```\n\n### 2、Post 方法\n\n```TS\nimport { Client } from \"dataopen-sdk-nodejs\";\n\nlet app_id = \"\";\nlet app_secret = \"\";\nlet url = \"\";\n\nlet client = new Client(app_id, app_secret, url);\n\nlet headers = {};\n\nlet params = {};\n\nlet body: Record<string, any> = {\n  uid_list: [\"1111111110000\"],\n};\n\nlet version_id = 6290880;\n\nlet res = await client.request(\n  `/dataopen/open-apis/xxx/openapi/v1/open/flight/version/${version_id}/add-test-user`,\n  \"POST\",\n  headers,\n  params,\n  body\n);\n\nconsole.log(\"Output: \", res);\n```\n"
 }

README.md

@@ -10,3 +10,2 @@ # openapi 使用说明
 | url        | string or null  | "https://analytics.volcengineapi.com"    | 服务器的URL地址                  |
-| env        | string or null  | "dataopen"                      | 环境设置，可选值为 "dataopen" 或 "dataopen_staging" |
 | expiration | string or null  | "1800"                          | 过期时间，单位是秒            |
@@ -47,3 +46,3 @@
 let res = await client.request(
-  "/xxx/openapi/v1/open/flight-list",
+  "/dataopen/open-apis/xxx/openapi/v1/open/flight-list",
   "GET",
@@ -79,3 +78,3 @@ headers,
 let res = await client.request(
-  `/xxx/openapi/v1/open/flight/version/${version_id}/add-test-user`,
+  `/dataopen/open-apis/xxx/openapi/v1/open/flight/version/${version_id}/add-test-user`,
   "POST",
@@ -82,0 +81,0 @@ headers,

test/client.test.ts

@@ -38,3 +38,3 @@ import { Client, any } from "../src/index";
     let res = await client.request(
-      "/xxx/openapi/v1/open/flight-list",
+      "/dataopen/open-apis/xxx/openapi/v1/open/flight-list",
       "GET",
@@ -69,3 +69,3 @@ headers,
     let res = await client.request(
-      "/xxx/openapi/v1/open/flight/version/6290880/add-test-user",
+      "/dataopen/open-apis/xxx/openapi/v1/open/flight/version/6290880/add-test-user",
       "POST",
@@ -91,4 +91,3 @@ headers,
       app_secret,
-      "https://analytics.volcengineapi.com",
-      "dataopen_staging"
+      "https://analytics.volcengineapi.com"
     );
@@ -127,4 +126,3 @@
       app_secret,
-      "https://analytics.volcengineapi.com",
-      "dataopen_staging"
+      "https://analytics.volcengineapi.com"
     );
@@ -166,4 +164,3 @@
       app_secret,
-      "https://analytics.volcengineapi.com",
-      "dataopen_staging"
+      "https://analytics.volcengineapi.com"
     );
@@ -170,0 +167,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

131139

decreased by-0.34%

Lines of code

496

decreased by-1.59%

Number of lines in readme file

85

decreased by-1.16%

No dependency changes