@keboola/api-client 36.0.0 → 39.0.0

package/dist/businessWorkspaceApiClient-C2WyWN3b.d.ts

@@ -0,0 +1,529 @@
+import { D as MiddlewareFn, c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType } from "./index-KuQ79Mnz.js";
+import { n as ClientInitOptions } from "./types-Ct0YPy2w.js";
+//#region src/clients/businessWorkspaceApi/__generated__/schema.d.ts
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+type paths = {
+  '/health': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description Service is up and the database schema is migrated. */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Health'];
+          };
+        };
+        /** @description Database is unreachable or the `dashboard` table is missing. */
+        503: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['HealthError'];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/dashboards': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** List the caller's dashboards */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description Dashboards ordered by last update */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['DashboardSummary'][];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Storage API unreachable */
+        503: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    /** Create a dashboard */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      /** @description Dashboard to create */
+      requestBody?: {
+        content: {
+          'application/json': components['schemas']['DashboardInput'];
+        };
+      };
+      responses: {
+        /** @description Created dashboard */
+        201: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Dashboard'];
+          };
+        };
+        /** @description Validation failed */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Id already used by a live dashboard */
+        409: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Body exceeds the size limit */
+        413: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Storage API unreachable */
+        503: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/dashboards/{id}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Get a dashboard */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          id: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description Dashboard */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Dashboard'];
+          };
+        };
+        /** @description Validation failed */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Dashboard not found or owned by another user */
+        404: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Storage API unreachable */
+        503: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+      };
+    };
+    /** Replace a dashboard */
+    put: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          id: string;
+        };
+        cookie?: never;
+      };
+      /** @description New dashboard content */
+      requestBody?: {
+        content: {
+          'application/json': components['schemas']['DashboardInput'];
+        };
+      };
+      responses: {
+        /** @description Updated dashboard */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Dashboard'];
+          };
+        };
+        /** @description Validation failed */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Dashboard not found or owned by another user */
+        404: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Body exceeds the size limit */
+        413: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Storage API unreachable */
+        503: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+      };
+    };
+    post?: never;
+    /** Soft-delete a dashboard */
+    delete: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          id: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description Deleted */
+        204: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+        /** @description Validation failed */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Dashboard not found or owned by another user */
+        404: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+        /** @description Storage API unreachable */
+        503: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['ErrorResponse'];
+          };
+        };
+      };
+    };
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    Health: {
+      /** @enum {string} */
+      status: 'ok';
+    };
+    HealthError: {
+      /** @enum {string} */
+      status: 'error';
+      /** @enum {string} */
+      database: 'unreachable';
+    };
+    DashboardSummary: {
+      /** Format: uuid */
+      id: string;
+      ownerUserId: number;
+      primaryProjectId: number;
+      sourceProjectIds: number[];
+      title: string;
+      description: string | null;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+    };
+    ErrorResponse: {
+      error: {
+        /** @enum {string} */
+        type: 'bad_request' | 'unauthorized' | 'not_found' | 'conflict' | 'payload_too_large' | 'offline' | 'internal';
+        message: string;
+      };
+    };
+    Dashboard: {
+      /** Format: uuid */
+      id: string;
+      ownerUserId: number;
+      primaryProjectId: number;
+      sourceProjectIds: number[];
+      title: string;
+      description: string | null;
+      spec: {
+        [key: string]: unknown;
+      };
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+    };
+    DashboardInput: {
+      /**
+       * Format: uuid
+       * @description Client-generated id; ignored on update. When omitted on create, `spec.id` is used (it must then be a UUID), or, when `spec.id` is absent too, a new id is generated and written into spec.id. Reusing the id of your own soft-deleted dashboard restores it.
+       */
+      id?: string;
+      title: string;
+      description?: string | null;
+      /** @description Defaults to the project the request token was verified against. */
+      primaryProjectId?: number;
+      /** @description Defaults to [] on create; left unchanged when omitted on update. */
+      sourceProjectIds?: number[];
+      /** @description Dashboard document compatible with @keboola/dashboard-builder. Its `id`, when present, must equal the dashboard id; its `name` is overwritten with `title`. */
+      spec: {
+        [key: string]: unknown;
+      };
+    };
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+//#endregion
+//#region src/clients/businessWorkspaceApi/types.d.ts
+type DashboardId = OpenapiPathType<paths['/api/dashboards/{id}']['get']>['id'];
+type DashboardInput = OpenapiBodyType<paths['/api/dashboards']['post']>;
+type BusinessWorkspaceDashboard = OpenapiReturnType<paths['/api/dashboards/{id}']['get']>;
+type BusinessWorkspaceDashboardSummary = OpenapiReturnType<paths['/api/dashboards']['get']>[number];
+//#endregion
+//#region src/clients/businessWorkspaceApi/businessWorkspaceApiClient.d.ts
+/**
+ * Client for `business-workspace-api` — per-user, cross-project Business Workspace dashboards.
+ *
+ * - Every dashboard call carries the caller's Storage token; the service scopes rows to the
+ *   verified user.
+ * - `/health` is public: it goes through `publicMiddlewares` (no token-attaching middleware) and
+ *   carries no auth headers.
+ * - A dashboard owned by another user is a 404, never a 403.
+ */
+declare const createBusinessWorkspaceApiClient: ({ baseUrl, middlewares, publicMiddlewares, auth }: ClientInitOptions & {
+  publicMiddlewares?: MiddlewareFn[];
+}) => {
+  healthCheck: (signal?: AbortSignal) => Promise<{
+    status: 'ok';
+  }>;
+  getDashboards: (signal?: AbortSignal) => Promise<{
+    id: string;
+    ownerUserId: number;
+    primaryProjectId: number;
+    sourceProjectIds: number[];
+    title: string;
+    description: string | null;
+    createdAt: string;
+    updatedAt: string;
+  }[]>;
+  getDashboard: (id: DashboardId, signal?: AbortSignal) => Promise<{
+    id: string;
+    ownerUserId: number;
+    primaryProjectId: number;
+    sourceProjectIds: number[];
+    title: string;
+    description: string | null;
+    spec: {
+      [key: string]: unknown;
+    };
+    createdAt: string;
+    updatedAt: string;
+  }>;
+  createDashboard: (input: DashboardInput, signal?: AbortSignal) => Promise<{
+    id: string;
+    ownerUserId: number;
+    primaryProjectId: number;
+    sourceProjectIds: number[];
+    title: string;
+    description: string | null;
+    spec: {
+      [key: string]: unknown;
+    };
+    createdAt: string;
+    updatedAt: string;
+  }>;
+  updateDashboard: (id: DashboardId, input: DashboardInput, signal?: AbortSignal) => Promise<{
+    id: string;
+    ownerUserId: number;
+    primaryProjectId: number;
+    sourceProjectIds: number[];
+    title: string;
+    description: string | null;
+    spec: {
+      [key: string]: unknown;
+    };
+    createdAt: string;
+    updatedAt: string;
+  }>;
+  deleteDashboard: (id: DashboardId, signal?: AbortSignal) => Promise<void>;
+};
+type BusinessWorkspaceApiClient = ReturnType<typeof createBusinessWorkspaceApiClient>;
+//#endregion
+export { DashboardId as a, BusinessWorkspaceDashboardSummary as i, createBusinessWorkspaceApiClient as n, DashboardInput as o, BusinessWorkspaceDashboard as r, BusinessWorkspaceApiClient as t };
+//# sourceMappingURL=businessWorkspaceApiClient-C2WyWN3b.d.ts.map