feat: add chart and query service

datadata-team · Mar 14, 2024 · ce9f627 · ce9f627
1 parent 8fefced
commit ce9f627
Show file tree

Hide file tree

Showing 20 changed files with 204 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 node_modules/
 
 dist/
+
+config.json
diff --git a/index.html b/index.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Datadata SDK Javascript</title>
+  </head>
+  <body>
+    <script type="module" src="./src/main.ts"></script>
+  </body>
+</html>
diff --git a/lib/api-key/api-key.ts → lib/api-key/api-key.interface.ts b/lib/api-key/api-key.ts → lib/api-key/api-key.interface.ts
diff --git a/lib/api-key/api-token-payload.ts → lib/api-key/api-token-payload.interface.ts b/lib/api-key/api-token-payload.ts → lib/api-key/api-token-payload.interface.ts
diff --git a/lib/api-key/index.ts b/lib/api-key/index.ts
@@ -1,4 +1,4 @@
-export * from "./api-key";
+export * from "./api-key.interface";
 export * from "./api-key.service";
-export * from "./api-token-payload";
+export * from "./api-token-payload.interface";
 export * from "./crypto";
diff --git a/lib/chart/chart.interface.ts b/lib/chart/chart.interface.ts
@@ -0,0 +1,31 @@
+export interface Chart {
+  id: string;
+  name: string;
+  tags: string[];
+  createdAt: string;
+  updatedAt: string;
+  description?: string;
+  datasetQuery: DatasetQuery;
+  visualizationSettings: any;
+}
+
+export interface DatasetQuery {
+  type: "native";
+  native: {
+    query: string;
+  };
+  dataSourceId: string;
+}
+
+export type GetChartsParams = {
+  tag?: Array<string>;
+  sort?: "name:asc" | "name:desc" | "create_at:asc" | "create_at:desc" | "updated_at:asc" | "updated_at:desc";
+  limit?: number;
+  offset?: number;
+  keyword?: string;
+  archived?: boolean;
+};
+
+export type CreateChartBody = Pick<Chart, "name" | "description" | "datasetQuery" | "visualizationSettings">;
+
+export type UpdateChartBody = Pick<Chart, "name" | "description" | "datasetQuery" | "visualizationSettings">;
diff --git a/lib/chart/chart.service.ts b/lib/chart/chart.service.ts
@@ -0,0 +1,56 @@
+import { BaseService, type PaginatedData } from "../common";
+import type { Chart, CreateChartBody, GetChartsParams, UpdateChartBody } from "./chart.interface";
+
+/**
+ * Chart 相关 Rest API 接口
+ */
+export class ChartService extends BaseService {
+  /**
+   * 分页获取当前用户的 Chart 资源
+   */
+  public getCharts(params?: GetChartsParams, signal?: AbortSignal) {
+    return this.http.get<PaginatedData<Chart>>(`/api/v1/charts`, { params, signal });
+  }
+
+  /**
+   * 创建 Chart 资源
+   */
+  public createChart(body: CreateChartBody) {
+    return this.http.post<Chart>(`/api/v1/charts`, body);
+  }
+
+  /**
+   * 获取指定 Chart 资源
+   */
+  public getChart(id: string, signal?: AbortSignal) {
+    return this.http.get<Chart>(`/api/v1/charts/${id}`, { signal });
+  }
+
+  /**
+   * 更新指定 Chart 资源
+   */
+  public updateChart(id: string, body: UpdateChartBody) {
+    return this.http.put<Chart>(`/api/v1/charts/${id}`, body);
+  }
+
+  /**
+   * 归档指定 Chart 资源
+   */
+  public deleteChart(id: string) {
+    return this.http.delete<void>(`/api/v1/charts/${id}`);
+  }
+
+  /**
+   * 分页获取子用户的 Chart 资源，通过 API-Token 中的 UID 区分子用户
+   */
+  public getSubUserCharts(params?: GetChartsParams, signal?: AbortSignal) {
+    return this.http.get<PaginatedData<Chart>>(`/api/v1/charts/by-uid`, { params, signal });
+  }
+
+  /**
+   * 分页获取指定子用户的 Chart 资源
+   */
+  public getChartsByUID(uid: string, params?: GetChartsParams, signal?: AbortSignal) {
+    return this.http.get<PaginatedData<Chart>>(`/api/v1/charts/uid/${uid}`, { params, signal });
+  }
+}
diff --git a/lib/chart/index.ts b/lib/chart/index.ts
@@ -0,0 +1,2 @@
+export * from "./chart.interface";
+export * from "./chart.service";
diff --git a/lib/common/base-service.ts b/lib/common/base-service.ts
@@ -1,9 +1,19 @@
 import axios, { type AxiosInstance } from "axios";
 
+export type BaseServiceOptions = {
+  token: string;
+  baseURL: string;
+};
+
 export class BaseService {
   public http: AxiosInstance;
 
-  constructor() {
-    this.http = axios.create();
+  constructor(public readonly options: BaseServiceOptions) {
+    this.http = axios.create({
+      baseURL: options.baseURL,
+      headers: {
+        "x-datadata-api-token": options.token,
+      },
+    });
   }
 }
diff --git a/lib/common/index.ts b/lib/common/index.ts
@@ -1 +1,2 @@
 export * from "./base-service";
+export * from "./paginated-data.interface";
diff --git a/lib/common/paginated-data.interface.ts b/lib/common/paginated-data.interface.ts
@@ -0,0 +1,4 @@
+export interface PaginatedData<T> {
+  count: number;
+  data: T[];
+}
diff --git a/lib/index.ts b/lib/index.ts
@@ -1,3 +1,7 @@
+export * from "./common";
+
 export * from "./api-key";
+export * from "./chart";
+export * from "./query";
 
 export * from "./services";
diff --git a/lib/query/index.ts b/lib/query/index.ts
@@ -0,0 +1 @@
+export * from "./query.service";
diff --git a/lib/query/query.service.ts b/lib/query/query.service.ts
@@ -0,0 +1,3 @@
+import { BaseService } from "../common";
+
+export class QueryService extends BaseService {}
diff --git a/lib/services.ts b/lib/services.ts
@@ -1,11 +1,15 @@
 import { APIKeyService } from "./api-key";
+import { ChartService } from "./chart";
+import type { BaseServiceOptions } from "./common";
+import { QueryService } from "./query";
 
-export type CreateServicesOptions = {
-  token: string;
-};
+export const BASE_URL_CN = "https://www.datadata.cn";
+export const BASE_URL_GLOBAL = "https://www.datadata.com";
 
-export function createServices(options: CreateServicesOptions) {
+export function createServices(options: BaseServiceOptions) {
   return {
-    apiKey: new APIKeyService(),
+    apiKey: new APIKeyService(options),
+    chart: new ChartService(options),
+    query: new QueryService(options),
   };
 }
diff --git a/package.json b/package.json
@@ -27,6 +27,7 @@
     "vite-plugin-checker": "^0.6.4",
     "vite-plugin-dts": "^3.7.3",
     "vite-plugin-externalize-deps": "^0.8.0",
+    "vite-tsconfig-paths": "^4.3.2",
     "vitest": "^1.3.1"
   },
   "dependencies": {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/main.ts b/src/main.ts
@@ -0,0 +1,13 @@
+import { BASE_URL_CN, createServices } from "@lib";
+import Config from "../config.json";
+
+async function main() {
+  const services = createServices({
+    token: Config.apiToken,
+    baseURL: BASE_URL_CN,
+  });
+
+  console.log(services);
+}
+
+main().catch((err) => console.error(err));
diff --git a/tsconfig.json b/tsconfig.json
@@ -7,9 +7,16 @@
     "declaration": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
     "strict": true,
     "skipLibCheck": true,
-    "verbatimModuleSyntax": true
+    "verbatimModuleSyntax": true,
+    "paths": {
+      "@lib": [
+        "./lib/index.ts"
+      ]
+    }
   },
   "references": [
     {

diff --git a/vite.config.ts b/vite.config.ts
@@ -4,6 +4,7 @@ import { defineConfig } from "vite";
 import checker from "vite-plugin-checker";
 import dts from "vite-plugin-dts";
 import { externalizeDeps } from "vite-plugin-externalize-deps";
+import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
   test: {
@@ -22,5 +23,10 @@ export default defineConfig({
     //   external: ["axios", "crypto-js"],
     // },
   },
-  plugins: [dts({ tsconfigPath: "./tsconfig.lib.json" }), checker({ typescript: true }), externalizeDeps()],
+  plugins: [
+    dts({ tsconfigPath: "./tsconfig.lib.json" }),
+    checker({ typescript: true }),
+    tsconfigPaths(),
+    externalizeDeps(),
+  ],
 });