@kmlckj/licos-platform-sdk 0.2.0 → 0.4.0

package/README.md

@@ -5,6 +5,8 @@ LICOS 平台对象存储 SDK，兼容前端和后端调用。
 ## 后端模式
 
 - `baseUrl` / `token` / `userId` / `projectId` 不传时，会回退读取 `LICOS_*` 环境变量
+- 后端默认读取 `LICOS_ORCHESTRATOR_API_BASE_URL`
+- 这些存储接口实际挂在调度器 `/api/v1/storage/*` 和 `/api/v1/public/storage/*`
 - `uploadUser` / `uploadProject` 支持直接传本地文件路径
 - `download(url, outputPath)` 会把文件写到本地路径
 
@@ -20,6 +22,7 @@ await download(uploaded.download_url, '/tmp/report-downloaded.pdf');
 - 默认走同源相对地址；也可以显式传 `baseUrl`
 - 上传支持 `File` / `Blob` / `ArrayBuffer` / TypedArray / `{ data, fileName, contentType }`
 - `download(url)` 返回 `Blob`
+- TypeScript 前端可显式导入浏览器入口 `@kmlckj/licos-platform-sdk/browser`，拿到浏览器专用类型
 
 ```js
 import { uploadUser, download } from '@kmlckj/licos-platform-sdk';
@@ -30,3 +33,13 @@ const uploaded = await uploadUser(fileInput.files[0], {
 
 const blob = await download(uploaded.download_url);
 ```
+
+```ts
+import { uploadUser, download } from '@kmlckj/licos-platform-sdk/browser';
+
+const uploaded = await uploadUser(fileInput.files![0], {
+  token: userJwt,
+});
+
+const blob = await download(uploaded.download_url);
+```

package/package.json

@@ -1,18 +1,33 @@
 {
   "name": "@kmlckj/licos-platform-sdk",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "LICOS platform SDK for storage upload, download, and preview in browser and Node runtimes",
   "author": "kmlckj",
   "type": "module",
   "main": "./src/index.js",
   "browser": "./src/browser.js",
   "types": "./src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "browser": [
+        "src/browser.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
+      "browser": {
+        "types": "./src/browser.d.ts",
+        "default": "./src/browser.js"
+      },
       "types": "./src/index.d.ts",
-      "browser": "./src/browser.js",
       "import": "./src/index.js",
       "default": "./src/index.js"
+    },
+    "./browser": {
+      "types": "./src/browser.d.ts",
+      "import": "./src/browser.js",
+      "default": "./src/browser.js"
     }
   },
   "files": [

package/src/browser.d.ts

@@ -0,0 +1,82 @@
+export interface UploadResult {
+  bucket: string;
+  object_key: string;
+  file_name: string;
+  content_type: string;
+  size_bytes: number;
+  preview_url: string;
+  download_url: string;
+}
+
+export interface BlobLike {
+  arrayBuffer(): Promise<ArrayBuffer>;
+  readonly size?: number;
+  readonly type?: string;
+  readonly name?: string;
+}
+
+export interface UploadBinaryDescriptor {
+  data?: ArrayBuffer | ArrayBufferView | BlobLike;
+  file?: ArrayBuffer | ArrayBufferView | BlobLike;
+  fileName?: string;
+  contentType?: string;
+}
+
+export type UploadSource =
+  | ArrayBuffer
+  | ArrayBufferView
+  | BlobLike
+  | UploadBinaryDescriptor;
+
+export interface StorageClientOptions {
+  baseUrl?: string;
+  token?: string;
+  userId?: string;
+  projectId?: string;
+  fetch?: typeof fetch;
+  headers?: HeadersInit;
+  credentials?: RequestCredentials;
+}
+
+export interface UploadProjectOptions extends StorageClientOptions {
+  userId?: string;
+  projectId?: string;
+}
+
+export class PlatformSdkError extends Error {
+  status?: number;
+  code?: number;
+  details?: unknown;
+}
+
+export class ConfigurationError extends PlatformSdkError {}
+export class ApiError extends PlatformSdkError {}
+
+export class StorageClient {
+  constructor(options?: StorageClientOptions);
+  previewUrl(bucket: string, objectKey: string): string;
+  downloadUrl(bucket: string, objectKey: string): string;
+  uploadUser(file: UploadSource): Promise<UploadResult>;
+  uploadProject(file: UploadSource, options?: UploadProjectOptions): Promise<UploadResult>;
+  download(url: string): Promise<Blob>;
+}
+
+export function previewUrl(
+  bucket: string,
+  objectKey: string,
+  options?: StorageClientOptions,
+): string;
+export function downloadUrl(
+  bucket: string,
+  objectKey: string,
+  options?: StorageClientOptions,
+): string;
+export function uploadUser(
+  file: UploadSource,
+  options?: StorageClientOptions,
+): Promise<UploadResult>;
+export function uploadProject(
+  file: UploadSource,
+  options?: UploadProjectOptions,
+): Promise<UploadResult>;
+export function download(url: string, options?: StorageClientOptions): Promise<Blob>;

package/src/shared.js

@@ -36,7 +36,7 @@ export function normalizeBaseUrl(baseUrl) {
     return baseUrl.replace(/\/+$/, '');
   }
 
-  const envBaseUrl = readEnv('LICOS_API_BASE_URL');
+  const envBaseUrl = readEnv('LICOS_ORCHESTRATOR_API_BASE_URL');
   if (envBaseUrl) {
     return envBaseUrl.replace(/\/+$/, '');
   }
@@ -45,7 +45,9 @@ export function normalizeBaseUrl(baseUrl) {
     return '';
   }
 
-  throw new ConfigurationError('Missing required environment variable: LICOS_API_BASE_URL');
+  throw new ConfigurationError(
+    'Missing required environment variable: LICOS_ORCHESTRATOR_API_BASE_URL',
+  );
 }
 
 export function resolveUserId(userId) {