@h-ai/api-contract 0.1.0-alpha.15

package/dist/storage/index.d.ts

@@ -0,0 +1,322 @@
+import * as _orpc_contract from '@orpc/contract';
+import * as zod_v4_core from 'zod/v4/core';
+import * as zod from 'zod';
+import { z } from 'zod';
+
+/**
+ * @h-ai/api-contract — Storage 领域 contract
+ *
+ * 定义文件存储相关 API 的接口边界：预签名 URL 生成与文件管理。
+ * 所有接口均需 Bearer Token 认证（由 `@h-ai/serv` 的 feature 层强制）。
+ * @module storage-contract
+ */
+/** Storage 领域 oRPC contract。 */
+declare const storageContract: {
+    presignedUrls: {
+        createDownload: _orpc_contract.ContractProcedureBuilderWithInputOutput<zod.ZodObject<{
+            key: zod.ZodString;
+            expiresIn: zod.ZodOptional<zod.ZodNumber>;
+        }, zod_v4_core.$strip>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+            success: zod.ZodLiteral<true>;
+            data: zod.ZodObject<{
+                url: zod.ZodString;
+                key: zod.ZodString;
+                expiresAt: zod.ZodOptional<zod.ZodCoercedDate<unknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>, zod.ZodObject<{
+            success: zod.ZodLiteral<false>;
+            error: zod.ZodObject<{
+                code: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNumber]>;
+                message: zod.ZodString;
+                httpStatus: zod.ZodOptional<zod.ZodNumber>;
+                system: zod.ZodOptional<zod.ZodString>;
+                module: zod.ZodOptional<zod.ZodString>;
+                cause: zod.ZodOptional<zod.ZodUnknown>;
+                suggestion: zod.ZodOptional<zod.ZodString>;
+                ext: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>], "success">, Record<never, never>, Record<never, never>>;
+        createUpload: _orpc_contract.ContractProcedureBuilderWithInputOutput<zod.ZodObject<{
+            key: zod.ZodString;
+            contentType: zod.ZodOptional<zod.ZodString>;
+            contentLength: zod.ZodOptional<zod.ZodNumber>;
+            expiresIn: zod.ZodOptional<zod.ZodNumber>;
+        }, zod_v4_core.$strip>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+            success: zod.ZodLiteral<true>;
+            data: zod.ZodObject<{
+                url: zod.ZodString;
+                key: zod.ZodString;
+                expiresAt: zod.ZodOptional<zod.ZodCoercedDate<unknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>, zod.ZodObject<{
+            success: zod.ZodLiteral<false>;
+            error: zod.ZodObject<{
+                code: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNumber]>;
+                message: zod.ZodString;
+                httpStatus: zod.ZodOptional<zod.ZodNumber>;
+                system: zod.ZodOptional<zod.ZodString>;
+                module: zod.ZodOptional<zod.ZodString>;
+                cause: zod.ZodOptional<zod.ZodUnknown>;
+                suggestion: zod.ZodOptional<zod.ZodString>;
+                ext: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>], "success">, Record<never, never>, Record<never, never>>;
+    };
+    files: {
+        list: _orpc_contract.ContractProcedureBuilderWithInputOutput<zod.ZodObject<{
+            prefix: zod.ZodOptional<zod.ZodString>;
+            maxKeys: zod.ZodOptional<zod.ZodCoercedNumber<unknown>>;
+            continuationToken: zod.ZodOptional<zod.ZodString>;
+            delimiter: zod.ZodOptional<zod.ZodString>;
+        }, zod_v4_core.$strip>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+            success: zod.ZodLiteral<true>;
+            data: zod.ZodObject<{
+                files: zod.ZodArray<zod.ZodObject<{
+                    key: zod.ZodString;
+                    size: zod.ZodNumber;
+                    contentType: zod.ZodString;
+                    lastModified: zod.ZodCoercedDate<unknown>;
+                    etag: zod.ZodOptional<zod.ZodString>;
+                    metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+                }, zod_v4_core.$strip>>;
+                commonPrefixes: zod.ZodArray<zod.ZodString>;
+                nextContinuationToken: zod.ZodOptional<zod.ZodString>;
+                isTruncated: zod.ZodBoolean;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>, zod.ZodObject<{
+            success: zod.ZodLiteral<false>;
+            error: zod.ZodObject<{
+                code: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNumber]>;
+                message: zod.ZodString;
+                httpStatus: zod.ZodOptional<zod.ZodNumber>;
+                system: zod.ZodOptional<zod.ZodString>;
+                module: zod.ZodOptional<zod.ZodString>;
+                cause: zod.ZodOptional<zod.ZodUnknown>;
+                suggestion: zod.ZodOptional<zod.ZodString>;
+                ext: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>], "success">, Record<never, never>, Record<never, never>>;
+        getMetadata: _orpc_contract.ContractProcedureBuilderWithInputOutput<zod.ZodObject<{
+            key: zod.ZodString;
+        }, zod_v4_core.$strip>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+            success: zod.ZodLiteral<true>;
+            data: zod.ZodObject<{
+                key: zod.ZodString;
+                size: zod.ZodNumber;
+                contentType: zod.ZodString;
+                lastModified: zod.ZodCoercedDate<unknown>;
+                etag: zod.ZodOptional<zod.ZodString>;
+                metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>, zod.ZodObject<{
+            success: zod.ZodLiteral<false>;
+            error: zod.ZodObject<{
+                code: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNumber]>;
+                message: zod.ZodString;
+                httpStatus: zod.ZodOptional<zod.ZodNumber>;
+                system: zod.ZodOptional<zod.ZodString>;
+                module: zod.ZodOptional<zod.ZodString>;
+                cause: zod.ZodOptional<zod.ZodUnknown>;
+                suggestion: zod.ZodOptional<zod.ZodString>;
+                ext: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>], "success">, Record<never, never>, Record<never, never>>;
+        delete: _orpc_contract.ContractProcedureBuilderWithInputOutput<zod.ZodObject<{
+            key: zod.ZodString;
+        }, zod_v4_core.$strip>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+            success: zod.ZodLiteral<true>;
+            data: zod.ZodVoid;
+        }, zod_v4_core.$strip>, zod.ZodObject<{
+            success: zod.ZodLiteral<false>;
+            error: zod.ZodObject<{
+                code: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNumber]>;
+                message: zod.ZodString;
+                httpStatus: zod.ZodOptional<zod.ZodNumber>;
+                system: zod.ZodOptional<zod.ZodString>;
+                module: zod.ZodOptional<zod.ZodString>;
+                cause: zod.ZodOptional<zod.ZodUnknown>;
+                suggestion: zod.ZodOptional<zod.ZodString>;
+                ext: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>], "success">, Record<never, never>, Record<never, never>>;
+        deleteMany: _orpc_contract.ContractProcedureBuilderWithInputOutput<zod.ZodObject<{
+            keys: zod.ZodArray<zod.ZodString>;
+        }, zod_v4_core.$strip>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+            success: zod.ZodLiteral<true>;
+            data: zod.ZodVoid;
+        }, zod_v4_core.$strip>, zod.ZodObject<{
+            success: zod.ZodLiteral<false>;
+            error: zod.ZodObject<{
+                code: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNumber]>;
+                message: zod.ZodString;
+                httpStatus: zod.ZodOptional<zod.ZodNumber>;
+                system: zod.ZodOptional<zod.ZodString>;
+                module: zod.ZodOptional<zod.ZodString>;
+                cause: zod.ZodOptional<zod.ZodUnknown>;
+                suggestion: zod.ZodOptional<zod.ZodString>;
+                ext: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+            }, zod_v4_core.$strip>;
+        }, zod_v4_core.$strip>], "success">, Record<never, never>, Record<never, never>>;
+    };
+};
+type StorageContract = typeof storageContract;
+
+/**
+ * @h-ai/api-contract — Storage 领域 Schema
+ *
+ * 包含文件元数据、预签名 URL、文件列表与删除相关的 input/output Zod Schema。
+ * 所有 Output Schema 均用 `haiResultSchema()` 封装。
+ * @module storage-schemas
+ */
+
+/** 文件元数据 Schema。 */
+declare const StorageFileMetadataSchema: z.ZodObject<{
+    key: z.ZodString;
+    size: z.ZodNumber;
+    contentType: z.ZodString;
+    lastModified: z.ZodCoercedDate<unknown>;
+    etag: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+/** 获取下载签名 URL 入参 Schema。 */
+declare const StoragePresignDownloadInputSchema: z.ZodObject<{
+    key: z.ZodString;
+    expiresIn: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/** 获取上传签名 URL 入参 Schema。 */
+declare const StoragePresignUploadInputSchema: z.ZodObject<{
+    key: z.ZodString;
+    contentType: z.ZodOptional<z.ZodString>;
+    contentLength: z.ZodOptional<z.ZodNumber>;
+    expiresIn: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/** 签名 URL 业务数据 Schema。 */
+declare const StoragePresignedUrlSchema: z.ZodObject<{
+    url: z.ZodString;
+    key: z.ZodString;
+    expiresAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+}, z.core.$strip>;
+/** 文件列表查询入参 Schema。 */
+declare const StorageListFilesInputSchema: z.ZodObject<{
+    prefix: z.ZodOptional<z.ZodString>;
+    maxKeys: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+    continuationToken: z.ZodOptional<z.ZodString>;
+    delimiter: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** 文件列表业务数据 Schema。 */
+declare const StorageListFilesDataSchema: z.ZodObject<{
+    files: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        size: z.ZodNumber;
+        contentType: z.ZodString;
+        lastModified: z.ZodCoercedDate<unknown>;
+        etag: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>;
+    commonPrefixes: z.ZodArray<z.ZodString>;
+    nextContinuationToken: z.ZodOptional<z.ZodString>;
+    isTruncated: z.ZodBoolean;
+}, z.core.$strip>;
+/** 单文件操作入参 Schema。 */
+declare const StorageFileKeyInputSchema: z.ZodObject<{
+    key: z.ZodString;
+}, z.core.$strip>;
+/** 批量删除文件入参 Schema。 */
+declare const StorageDeleteFilesInputSchema: z.ZodObject<{
+    keys: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+declare const StoragePresignedUrlOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    success: z.ZodLiteral<true>;
+    data: z.ZodObject<{
+        url: z.ZodString;
+        key: z.ZodString;
+        expiresAt: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    success: z.ZodLiteral<false>;
+    error: z.ZodObject<{
+        code: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        message: z.ZodString;
+        httpStatus: z.ZodOptional<z.ZodNumber>;
+        system: z.ZodOptional<z.ZodString>;
+        module: z.ZodOptional<z.ZodString>;
+        cause: z.ZodOptional<z.ZodUnknown>;
+        suggestion: z.ZodOptional<z.ZodString>;
+        ext: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "success">;
+declare const StorageFileMetadataOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    success: z.ZodLiteral<true>;
+    data: z.ZodObject<{
+        key: z.ZodString;
+        size: z.ZodNumber;
+        contentType: z.ZodString;
+        lastModified: z.ZodCoercedDate<unknown>;
+        etag: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    success: z.ZodLiteral<false>;
+    error: z.ZodObject<{
+        code: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        message: z.ZodString;
+        httpStatus: z.ZodOptional<z.ZodNumber>;
+        system: z.ZodOptional<z.ZodString>;
+        module: z.ZodOptional<z.ZodString>;
+        cause: z.ZodOptional<z.ZodUnknown>;
+        suggestion: z.ZodOptional<z.ZodString>;
+        ext: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "success">;
+declare const StorageListFilesOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    success: z.ZodLiteral<true>;
+    data: z.ZodObject<{
+        files: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            size: z.ZodNumber;
+            contentType: z.ZodString;
+            lastModified: z.ZodCoercedDate<unknown>;
+            etag: z.ZodOptional<z.ZodString>;
+            metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>;
+        commonPrefixes: z.ZodArray<z.ZodString>;
+        nextContinuationToken: z.ZodOptional<z.ZodString>;
+        isTruncated: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    success: z.ZodLiteral<false>;
+    error: z.ZodObject<{
+        code: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        message: z.ZodString;
+        httpStatus: z.ZodOptional<z.ZodNumber>;
+        system: z.ZodOptional<z.ZodString>;
+        module: z.ZodOptional<z.ZodString>;
+        cause: z.ZodOptional<z.ZodUnknown>;
+        suggestion: z.ZodOptional<z.ZodString>;
+        ext: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "success">;
+declare const StorageVoidOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    success: z.ZodLiteral<true>;
+    data: z.ZodVoid;
+}, z.core.$strip>, z.ZodObject<{
+    success: z.ZodLiteral<false>;
+    error: z.ZodObject<{
+        code: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        message: z.ZodString;
+        httpStatus: z.ZodOptional<z.ZodNumber>;
+        system: z.ZodOptional<z.ZodString>;
+        module: z.ZodOptional<z.ZodString>;
+        cause: z.ZodOptional<z.ZodUnknown>;
+        suggestion: z.ZodOptional<z.ZodString>;
+        ext: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "success">;
+type StoragePresignDownloadInput = z.infer<typeof StoragePresignDownloadInputSchema>;
+type StoragePresignUploadInput = z.infer<typeof StoragePresignUploadInputSchema>;
+type StoragePresignedUrlOutput = z.infer<typeof StoragePresignedUrlOutputSchema>;
+type StorageListFilesInput = z.infer<typeof StorageListFilesInputSchema>;
+type StorageFileKeyInput = z.infer<typeof StorageFileKeyInputSchema>;
+type StorageDeleteFilesInput = z.infer<typeof StorageDeleteFilesInputSchema>;
+
+export { type StorageContract, type StorageDeleteFilesInput, StorageDeleteFilesInputSchema, type StorageFileKeyInput, StorageFileKeyInputSchema, StorageFileMetadataOutputSchema, StorageFileMetadataSchema, StorageListFilesDataSchema, type StorageListFilesInput, StorageListFilesInputSchema, StorageListFilesOutputSchema, type StoragePresignDownloadInput, StoragePresignDownloadInputSchema, type StoragePresignUploadInput, StoragePresignUploadInputSchema, type StoragePresignedUrlOutput, StoragePresignedUrlOutputSchema, StoragePresignedUrlSchema, StorageVoidOutputSchema, storageContract };

package/dist/storage/index.js

@@ -0,0 +1,4 @@
+export { StorageDeleteFilesInputSchema, StorageFileKeyInputSchema, StorageFileMetadataOutputSchema, StorageFileMetadataSchema, StorageListFilesDataSchema, StorageListFilesInputSchema, StorageListFilesOutputSchema, StoragePresignDownloadInputSchema, StoragePresignUploadInputSchema, StoragePresignedUrlOutputSchema, StoragePresignedUrlSchema, StorageVoidOutputSchema, storageContract } from '../chunk-DKBPLQMI.js';
+import '../chunk-3GZQUVY3.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@h-ai/api-contract",
+  "type": "module",
+  "version": "0.1.0-alpha.15",
+  "description": "Hai Framework public API contracts powered by oRPC and Zod.",
+  "license": "Apache-2.0",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./iam": {
+      "types": "./dist/iam/index.d.ts",
+      "import": "./dist/iam/index.js"
+    },
+    "./storage": {
+      "types": "./dist/storage/index.d.ts",
+      "import": "./dist/storage/index.js"
+    },
+    "./ai": {
+      "types": "./dist/ai/index.d.ts",
+      "import": "./dist/ai/index.js"
+    },
+    "./payment": {
+      "types": "./dist/payment/index.d.ts",
+      "import": "./dist/payment/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@orpc/contract": "^1.14.3",
+    "zod": "^4.3.6",
+    "@h-ai/core": "0.1.0-alpha.15"
+  },
+  "devDependencies": {
+    "@types/node": "^25.1.0",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.5",
+    "typescript": "^6.0.2",
+    "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "clean": "rimraf dist .turbo"
+  }
+}