@tbox-dev-js/sdk 0.1.0

package/dist/schema.d.ts

@@ -0,0 +1,104 @@
+/**
+ * @tbox/sdk — ResourceSchema 类型体系
+ *
+ * 用 JSON Schema 风格统一描述所有 API 资源的入参、出参和元信息，
+ * 端侧可据此动态渲染表单、校验参数、生成配置。
+ *
+ * 设计原则：
+ * - 对齐 JSON Schema Draft 7 的 property 描述格式
+ * - 每个 API 操作（Operation）独立描述入参 + 出参 schema
+ * - 所有资源通过 ResourceDefinition 统一注册
+ * - 支持嵌套子资源（如 knowledge.documents）
+ */
+/** Supported JSON Schema types */
+export type SchemaType = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'file';
+/** Single property descriptor — aligned with JSON Schema property format */
+export interface PropertySchema {
+    /** JSON Schema type */
+    type: SchemaType;
+    /** Human-readable description */
+    description: string;
+    /** Whether this field is required */
+    required?: boolean;
+    /** Default value */
+    default?: unknown;
+    /** Allowed values (enum constraint) */
+    enum?: unknown[];
+    /** For array type: schema of each item */
+    items?: PropertySchema | ObjectSchema;
+    /** For object type: nested properties */
+    properties?: Record<string, PropertySchema>;
+    /** Display format hint for UI rendering (e.g. "textarea", "select", "file-upload") */
+    format?: string;
+    /** Example value for documentation */
+    example?: unknown;
+    /** Minimum value (for number/integer) */
+    minimum?: number;
+    /** Maximum value (for number/integer) */
+    maximum?: number;
+    /** Min length (for string/array) */
+    minLength?: number;
+    /** Max length (for string/array) */
+    maxLength?: number;
+    /** Regex pattern (for string) */
+    pattern?: string;
+}
+/** Object schema — a collection of named properties */
+export interface ObjectSchema {
+    type: 'object';
+    description?: string;
+    properties: Record<string, PropertySchema>;
+    required?: string[];
+}
+/** HTTP method */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+/** Content type for request body */
+export type ContentType = 'application/json' | 'multipart/form-data' | 'none';
+/** Complete description of a single API operation */
+export interface OperationSchema {
+    /** Operation identifier (e.g. "list", "retrieve", "create", "update") */
+    operationId: string;
+    /** Human-readable summary */
+    summary: string;
+    /** Detailed description */
+    description?: string;
+    /** HTTP method */
+    method: HttpMethod;
+    /** API path (relative to baseURL) */
+    path: string;
+    /** Request content type */
+    contentType: ContentType;
+    /** Input parameters schema */
+    params: ObjectSchema;
+    /** Response data schema (the unwrapped business data, not the raw envelope) */
+    response: ObjectSchema;
+    /** Tags for grouping/filtering */
+    tags?: string[];
+}
+/** Complete definition of a resource module */
+export interface ResourceDefinition {
+    /** Resource name (e.g. "knowledge", "plugins", "chat") */
+    name: string;
+    /** Human-readable display name */
+    displayName: string;
+    /** Resource description */
+    description: string;
+    /** API operations provided by this resource */
+    operations: OperationSchema[];
+    /** Nested sub-resources (e.g. knowledge.documents) */
+    subResources?: ResourceDefinition[];
+}
+/** Registry that holds all resource definitions */
+export declare class SchemaRegistry {
+    private resources;
+    /** Register a resource definition */
+    register(definition: ResourceDefinition): void;
+    /** Get a resource definition by name */
+    get(name: string): ResourceDefinition | undefined;
+    /** Get all registered resource definitions */
+    list(): ResourceDefinition[];
+    /** Get a specific operation by resource name and operation ID */
+    getOperation(resourceName: string, operationId: string): OperationSchema | undefined;
+    /** Export all schemas as a plain JSON-serializable object */
+    toJSON(): Record<string, ResourceDefinition>;
+}

package/dist/tbox-api.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @tbox/sdk — TboxAPI 入口类
+ *
+ * SDK 的唯一入口，继承 APIClient，通过属性访问子模块。
+ * 内置 SchemaRegistry，自动注册所有资源的 JSON Schema 定义。
+ */
+import { APIClient } from './core';
+import type { ClientOptions } from './core';
+import { Knowledge } from './resources/knowledge/index';
+import { SchemaRegistry } from './schema';
+export declare class TboxAPI extends APIClient {
+    /** Knowledge base management (list, retrieve, documents.create, documents.update). */
+    readonly knowledge: Knowledge;
+    /** Schema registry — JSON Schema definitions for all resources, available for client-side parsing. */
+    readonly schemas: SchemaRegistry;
+    constructor(options: ClientOptions);
+}