@kmlckj/licos-platform-sdk 0.5.0 → 0.6.0

package/README.md

@@ -1,47 +1,39 @@
 # @kmlckj/licos-platform-sdk
 
-LICOS 平台对象存储 SDK，兼容前端和后端调用。
+LICOS 平台对象存储预览 / 下载 SDK，兼容前端和后端调用。
 
 ## 后端模式
 
-- `baseUrl` / `token` / `userId` / `projectId` 不传时，会回退读取 `LICOS_*` 环境变量
+- `baseUrl` / `token` 不传时，会回退读取 `LICOS_*` 环境变量
 - 后端默认读取 `LICOS_ORCHESTRATOR_API_BASE_URL`
-- 这些存储接口实际挂在调度器 `/api/v1/storage/*` 和 `/api/v1/public/storage/*`
-- `uploadUser` / `uploadProject` 支持直接传本地文件路径
+- 这些存储接口实际挂在调度器 `/api/v1/public/storage/*`
 - `download(url, outputPath)` 会把文件写到本地路径
-- 上传、预览、下载都要求鉴权；`download(...)` 会自动带上 `token` 或 `LICOS_USER_TOKEN`
+- 预览 / 下载都要求鉴权；`download(...)` 会自动带上 `token` 或 `LICOS_RUNTIME_TOKEN`
 
 ```js
-import { uploadProject, download } from '@kmlckj/licos-platform-sdk';
+import { download, downloadUrl } from '@kmlckj/licos-platform-sdk';
 
-const uploaded = await uploadProject('/tmp/report.pdf');
-await download(uploaded.download_url, '/tmp/report-downloaded.pdf');
+const url = downloadUrl('demo-bucket', 'folder/report.pdf');
+await download(url, '/tmp/report-downloaded.pdf');
 ```
 
 ## 前端模式
 
 - 默认走同源相对地址；也可以显式传 `baseUrl`
-- 上传支持 `File` / `Blob` / `ArrayBuffer` / TypedArray / `{ data, fileName, contentType }`
 - `download(url)` 返回 `Blob`
 - TypeScript 前端可显式导入浏览器入口 `@kmlckj/licos-platform-sdk/browser`，拿到浏览器专用类型
 - 预览 / 下载接口同样要求传 `token`
 
 ```js
-import { uploadUser, download } from '@kmlckj/licos-platform-sdk';
+import { download, previewUrl } from '@kmlckj/licos-platform-sdk';
 
-const uploaded = await uploadUser(fileInput.files[0], {
-  token: userJwt,
-});
-
-const blob = await download(uploaded.download_url, { token: userJwt });
+const url = previewUrl('demo-bucket', 'images/demo.png');
+const blob = await download(url, { token: runtimeToken });
 ```
 
 ```ts
-import { uploadUser, download } from '@kmlckj/licos-platform-sdk/browser';
-
-const uploaded = await uploadUser(fileInput.files![0], {
-  token: userJwt,
-});
+import { download, previewUrl } from '@kmlckj/licos-platform-sdk/browser';
 
-const blob = await download(uploaded.download_url, { token: userJwt });
+const url = previewUrl('demo-bucket', 'images/demo.png');
+const blob = await download(url, { token: runtimeToken });
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kmlckj/licos-platform-sdk",
-  "version": "0.5.0",
-  "description": "LICOS platform SDK for storage upload, download, and preview in browser and Node runtimes",
+  "version": "0.6.0",
+  "description": "LICOS platform SDK for storage download and preview in browser and Node runtimes",
   "author": "kmlckj",
   "type": "module",
   "main": "./src/index.js",

package/src/browser.d.ts

@@ -1,48 +1,11 @@
-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;
@@ -56,8 +19,6 @@ 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>;
 }
 
@@ -71,12 +32,4 @@ export function downloadUrl(
   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/browser.js

@@ -6,17 +6,12 @@ import {
   encodeObjectKey,
   encodeStorageSegment,
   normalizeBaseUrl,
-  resolveProjectId,
-  resolveUserId,
-  uploadFile,
 } from './shared.js';
 
 export class StorageClient {
   constructor(options = {}) {
     this.baseUrl = options.baseUrl;
     this.token = options.token;
-    this.userId = options.userId;
-    this.projectId = options.projectId;
     this.fetchImpl = options.fetch ?? fetch;
     this.headers = options.headers;
     this.credentials = options.credentials;
@@ -31,31 +26,6 @@ export class StorageClient {
     return `${this.previewUrl(bucket, objectKey)}?download=1`;
   }
 
-  async uploadUser(file) {
-    const baseUrl = normalizeBaseUrl(this.baseUrl);
-    return uploadFile(this.fetchImpl, `${baseUrl}/api/v1/storage/upload/user`, file, {
-      token: this.token,
-      headers: this.headers,
-      credentials: this.credentials,
-    });
-  }
-
-  async uploadProject(file, options = {}) {
-    const baseUrl = normalizeBaseUrl(this.baseUrl);
-    const userId = resolveUserId(options.userId ?? this.userId);
-    const projectId = resolveProjectId(options.projectId ?? this.projectId);
-    return uploadFile(
-      this.fetchImpl,
-      `${baseUrl}/api/v1/storage/upload/project/${encodeStorageSegment(userId)}/${encodeStorageSegment(projectId)}`,
-      file,
-      {
-        token: this.token,
-        headers: this.headers,
-        credentials: this.credentials,
-      },
-    );
-  }
-
   async download(url, outputPath) {
     if (outputPath !== undefined) {
       throw new ConfigurationError(
@@ -82,14 +52,6 @@ export function downloadUrl(bucket, objectKey, options = {}) {
   return defaultClient(options).downloadUrl(bucket, objectKey);
 }
 
-export async function uploadUser(file, options = {}) {
-  return defaultClient(options).uploadUser(file);
-}
-
-export async function uploadProject(file, options = {}) {
-  return defaultClient(options).uploadProject(file, options);
-}
-
 export async function download(url, outputPathOrOptions, maybeOptions = {}) {
   if (typeof outputPathOrOptions === 'string') {
     throw new ConfigurationError(

package/src/index.d.ts

@@ -1,49 +1,11 @@
-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 =
-  | string
-  | 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;
@@ -57,8 +19,6 @@ 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>;
   download(url: string, outputPath: string): Promise<string>;
 }
@@ -73,14 +33,6 @@ export function downloadUrl(
   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>;
 export function download(
   url: string,

package/src/index.js

@@ -8,20 +8,13 @@ import {
   downloadBlob,
   encodeObjectKey,
   encodeStorageSegment,
-  fileNameFromPath,
-  guessContentType,
   normalizeBaseUrl,
-  resolveProjectId,
-  resolveUserId,
-  uploadFile,
 } from './shared.js';
 
 export class StorageClient {
   constructor(options = {}) {
     this.baseUrl = options.baseUrl;
     this.token = options.token;
-    this.userId = options.userId;
-    this.projectId = options.projectId;
     this.fetchImpl = options.fetch ?? fetch;
     this.headers = options.headers;
     this.credentials = options.credentials;
@@ -36,21 +29,6 @@ export class StorageClient {
     return `${this.previewUrl(bucket, objectKey)}?download=1`;
   }
 
-  async uploadUser(file) {
-    const baseUrl = normalizeBaseUrl(this.baseUrl);
-    return this.#upload(`${baseUrl}/api/v1/storage/upload/user`, file);
-  }
-
-  async uploadProject(file, options = {}) {
-    const baseUrl = normalizeBaseUrl(this.baseUrl);
-    const userId = resolveUserId(options.userId ?? this.userId);
-    const projectId = resolveProjectId(options.projectId ?? this.projectId);
-    return this.#upload(
-      `${baseUrl}/api/v1/storage/upload/project/${encodeStorageSegment(userId)}/${encodeStorageSegment(projectId)}`,
-      file,
-    );
-  }
-
   async download(url, outputPath) {
     const blob = await downloadBlob(this.fetchImpl, url, {
       token: this.token,
@@ -66,28 +44,6 @@ export class StorageClient {
     return outputPath;
   }
 
-  async #upload(url, file) {
-    return uploadFile(
-      this.fetchImpl,
-      url,
-      file,
-      {
-        token: this.token,
-        headers: this.headers,
-        credentials: this.credentials,
-      },
-      async (filePath) => {
-        const fileBuffer = await fs.readFile(filePath);
-        const fileName = fileNameFromPath(filePath);
-        const contentType = guessContentType(fileName);
-        return {
-          fileName,
-          contentType,
-          blob: new Blob([fileBuffer], { type: contentType }),
-        };
-      },
-    );
-  }
 }
 
 function defaultClient(options = {}) {
@@ -102,14 +58,6 @@ export function downloadUrl(bucket, objectKey, options = {}) {
   return defaultClient(options).downloadUrl(bucket, objectKey);
 }
 
-export async function uploadUser(filePath, options = {}) {
-  return defaultClient(options).uploadUser(filePath);
-}
-
-export async function uploadProject(filePath, options = {}) {
-  return defaultClient(options).uploadProject(filePath, options);
-}
-
 export async function download(url, outputPathOrOptions, maybeOptions = {}) {
   if (typeof outputPathOrOptions === 'string') {
     return defaultClient(maybeOptions).download(url, outputPathOrOptions);

package/src/shared.js

@@ -23,14 +23,6 @@ function readEnv(name) {
   return value ? value : undefined;
 }
 
-export function requireEnv(name) {
-  const value = readEnv(name);
-  if (value) {
-    return value;
-  }
-  throw new ConfigurationError(`Missing required environment variable: ${name}`);
-}
-
 export function normalizeBaseUrl(baseUrl) {
   if (typeof baseUrl === 'string') {
     return baseUrl.replace(/\/+$/, '');
@@ -50,14 +42,6 @@ export function normalizeBaseUrl(baseUrl) {
   );
 }
 
-export function resolveUserId(userId) {
-  return userId ?? requireEnv('LICOS_USER_ID');
-}
-
-export function resolveProjectId(projectId) {
-  return projectId ?? requireEnv('LICOS_PROJECT_ID');
-}
-
 export function encodeStorageSegment(value) {
   return encodeURIComponent(value);
 }
@@ -66,112 +50,6 @@ export function encodeObjectKey(value) {
   return value.split('/').map(encodeStorageSegment).join('/');
 }
 
-export function fileNameFromPath(filePath) {
-  const parts = String(filePath).split(/[\\/]/);
-  const fileName = parts[parts.length - 1];
-  return fileName || 'upload.bin';
-}
-
-export function guessContentType(fileName) {
-  const ext = /\.[^./\\]+$/.exec(String(fileName).toLowerCase())?.[0] ?? '';
-  switch (ext) {
-    case '.txt':
-      return 'text/plain';
-    case '.json':
-      return 'application/json';
-    case '.pdf':
-      return 'application/pdf';
-    case '.png':
-      return 'image/png';
-    case '.jpg':
-    case '.jpeg':
-      return 'image/jpeg';
-    case '.gif':
-      return 'image/gif';
-    case '.webp':
-      return 'image/webp';
-    case '.svg':
-      return 'image/svg+xml';
-    case '.md':
-      return 'text/markdown';
-    default:
-      return 'application/octet-stream';
-  }
-}
-
-function isBlobLike(value) {
-  return !!value && typeof value === 'object' && typeof value.arrayBuffer === 'function';
-}
-
-function isBinaryDescriptor(value) {
-  if (!value || typeof value !== 'object' || isBlobLike(value)) {
-    return false;
-  }
-  return 'data' in value || 'file' in value;
-}
-
-function toUint8Array(data) {
-  if (data instanceof Uint8Array) {
-    return data;
-  }
-  if (ArrayBuffer.isView(data)) {
-    return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
-  }
-  return new Uint8Array(data);
-}
-
-async function normalizeBinaryPayload(data, overrides = {}) {
-  if (isBlobLike(data)) {
-    const fileName =
-      overrides.fileName ??
-      (typeof data.name === 'string' && data.name ? data.name : undefined) ??
-      'upload.bin';
-    const contentType =
-      overrides.contentType ??
-      (typeof data.type === 'string' && data.type ? data.type : undefined) ??
-      guessContentType(fileName);
-    return {
-      fileName,
-      contentType,
-      blob: new Blob([await data.arrayBuffer()], { type: contentType }),
-    };
-  }
-
-  if (data instanceof ArrayBuffer || ArrayBuffer.isView(data)) {
-    const fileName = overrides.fileName ?? 'upload.bin';
-    const contentType = overrides.contentType ?? guessContentType(fileName);
-    return {
-      fileName,
-      contentType,
-      blob: new Blob([toUint8Array(data)], { type: contentType }),
-    };
-  }
-
-  throw new ConfigurationError(
-    'Unsupported upload input. Use a file path string, Blob/File, ArrayBuffer, TypedArray, or { data, fileName }.',
-  );
-}
-
-export async function normalizeUploadSource(source, readPathSource) {
-  if (typeof source === 'string') {
-    if (!readPathSource) {
-      throw new ConfigurationError(
-        'Front-end mode does not support filesystem path uploads. Pass File, Blob, ArrayBuffer, TypedArray, or { data, fileName } instead.',
-      );
-    }
-    return readPathSource(source);
-  }
-
-  if (isBinaryDescriptor(source)) {
-    return normalizeBinaryPayload(source.data ?? source.file, {
-      fileName: source.fileName,
-      contentType: source.contentType,
-    });
-  }
-
-  return normalizeBinaryPayload(source);
-}
-
 function headersFromInit(headersInit) {
   return new Headers(headersInit ?? undefined);
 }
@@ -179,12 +57,12 @@ function headersFromInit(headersInit) {
 export function buildRequestHeaders(options = {}, { authenticated = false } = {}) {
   const headers = headersFromInit(options.headers);
   if (authenticated && !headers.has('Authorization')) {
-    const resolvedToken = options.token ?? readEnv('LICOS_USER_TOKEN');
+    const resolvedToken = options.token ?? readEnv('LICOS_RUNTIME_TOKEN');
     if (resolvedToken) {
       headers.set('Authorization', `Bearer ${resolvedToken}`);
     } else if (isNodeRuntime()) {
       throw new ConfigurationError(
-        'Missing authentication token. Pass options.token, provide an Authorization header, or set LICOS_USER_TOKEN.',
+        'Missing authentication token. Pass options.token, provide an Authorization header, or set LICOS_RUNTIME_TOKEN.',
       );
     }
   }
@@ -199,27 +77,6 @@ export function buildRequestInit(options = {}, init = {}) {
   return requestInit;
 }
 
-export async function readJsonEnvelope(response) {
-  let payload;
-  try {
-    payload = await response.json();
-  } catch (error) {
-    throw new ApiError('Platform API returned non-JSON response', {
-      status: response.status,
-      details: error instanceof Error ? error.message : String(error),
-    });
-  }
-
-  if (!response.ok || payload?.code !== 0) {
-    throw new ApiError(payload?.message ?? `Platform API failed: HTTP ${response.status}`, {
-      status: response.status,
-      code: payload?.code,
-      details: payload?.data ?? payload,
-    });
-  }
-  return payload.data;
-}
-
 export async function downloadBlob(fetchImpl, url, options = {}) {
   const response = await fetchImpl(
     url,
@@ -240,19 +97,3 @@ export async function downloadBlob(fetchImpl, url, options = {}) {
     type: response.headers.get('content-type') ?? undefined,
   });
 }
-
-export async function uploadFile(fetchImpl, url, source, options = {}, readPathSource) {
-  const normalized = await normalizeUploadSource(source, readPathSource);
-  const formData = new FormData();
-  formData.append('file', normalized.blob, normalized.fileName);
-
-  const response = await fetchImpl(
-    url,
-    buildRequestInit(options, {
-      method: 'POST',
-      headers: buildRequestHeaders(options, { authenticated: true }),
-      body: formData,
-    }),
-  );
-  return readJsonEnvelope(response);
-}