teable-api-sdk 1.0.0-test.1

package/dist/record/schema.d.ts

@@ -0,0 +1,232 @@
+import z from "zod";
+/**
+ * 创建记录请求验证模式
+ */
+export declare const RecordCreateSchema: z.ZodObject<{
+    tableId: z.ZodString;
+    records: z.ZodArray<z.ZodObject<{
+        fields: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        fields: Record<string, any>;
+    }, {
+        fields: Record<string, any>;
+    }>, "many">;
+    fieldKeyType: z.ZodOptional<z.ZodEnum<["name", "id", "dbFieldName"]>>;
+    typecast: z.ZodOptional<z.ZodBoolean>;
+    order: z.ZodOptional<z.ZodObject<{
+        viewId: z.ZodString;
+        anchorId: z.ZodString;
+        position: z.ZodEnum<["before", "after"]>;
+    }, "strip", z.ZodTypeAny, {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    }, {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    tableId: string;
+    records: {
+        fields: Record<string, any>;
+    }[];
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    typecast?: boolean | undefined;
+    order?: {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    } | undefined;
+}, {
+    tableId: string;
+    records: {
+        fields: Record<string, any>;
+    }[];
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    typecast?: boolean | undefined;
+    order?: {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    } | undefined;
+}>;
+/**
+ * 获取记录请求验证模式
+ */
+export declare const RecordGetSchema: z.ZodObject<{
+    tableId: z.ZodString;
+    viewId: z.ZodOptional<z.ZodString>;
+    take: z.ZodOptional<z.ZodNumber>;
+    skip: z.ZodOptional<z.ZodNumber>;
+    fieldKeyType: z.ZodOptional<z.ZodEnum<["name", "id", "dbFieldName"]>>;
+    cellFormat: z.ZodOptional<z.ZodEnum<["json", "text"]>>;
+    projection: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    orderBy: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        order: z.ZodEnum<["asc", "desc"]>;
+    }, "strip", z.ZodTypeAny, {
+        order: "asc" | "desc";
+        field: string;
+    }, {
+        order: "asc" | "desc";
+        field: string;
+    }>, "many">>;
+    filter: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    search: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        field: string;
+    }, {
+        value: string;
+        field: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    tableId: string;
+    filter?: Record<string, any> | undefined;
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    viewId?: string | undefined;
+    take?: number | undefined;
+    skip?: number | undefined;
+    cellFormat?: "json" | "text" | undefined;
+    projection?: string[] | undefined;
+    orderBy?: {
+        order: "asc" | "desc";
+        field: string;
+    }[] | undefined;
+    search?: {
+        value: string;
+        field: string;
+    }[] | undefined;
+}, {
+    tableId: string;
+    filter?: Record<string, any> | undefined;
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    viewId?: string | undefined;
+    take?: number | undefined;
+    skip?: number | undefined;
+    cellFormat?: "json" | "text" | undefined;
+    projection?: string[] | undefined;
+    orderBy?: {
+        order: "asc" | "desc";
+        field: string;
+    }[] | undefined;
+    search?: {
+        value: string;
+        field: string;
+    }[] | undefined;
+}>;
+/**
+ * 获取单个记录请求验证模式
+ */
+export declare const RecordGetByIdSchema: z.ZodObject<{
+    tableId: z.ZodString;
+    recordId: z.ZodString;
+    projection: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    fieldKeyType: z.ZodOptional<z.ZodEnum<["name", "id", "dbFieldName"]>>;
+    cellFormat: z.ZodOptional<z.ZodEnum<["json", "text"]>>;
+}, "strip", z.ZodTypeAny, {
+    tableId: string;
+    recordId: string;
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    cellFormat?: "json" | "text" | undefined;
+    projection?: string[] | undefined;
+}, {
+    tableId: string;
+    recordId: string;
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    cellFormat?: "json" | "text" | undefined;
+    projection?: string[] | undefined;
+}>;
+/**
+ * 更新记录请求验证模式
+ */
+export declare const RecordUpdateSchema: z.ZodObject<{
+    tableId: z.ZodString;
+    recordId: z.ZodString;
+    record: z.ZodObject<{
+        fields: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        fields: Record<string, any>;
+    }, {
+        fields: Record<string, any>;
+    }>;
+    fieldKeyType: z.ZodOptional<z.ZodEnum<["name", "id", "dbFieldName"]>>;
+    typecast: z.ZodOptional<z.ZodBoolean>;
+    order: z.ZodOptional<z.ZodObject<{
+        viewId: z.ZodString;
+        anchorId: z.ZodString;
+        position: z.ZodEnum<["before", "after"]>;
+    }, "strip", z.ZodTypeAny, {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    }, {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    tableId: string;
+    recordId: string;
+    record: {
+        fields: Record<string, any>;
+    };
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    typecast?: boolean | undefined;
+    order?: {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    } | undefined;
+}, {
+    tableId: string;
+    recordId: string;
+    record: {
+        fields: Record<string, any>;
+    };
+    fieldKeyType?: "name" | "id" | "dbFieldName" | undefined;
+    typecast?: boolean | undefined;
+    order?: {
+        viewId: string;
+        anchorId: string;
+        position: "before" | "after";
+    } | undefined;
+}>;
+/**
+ * 删除记录请求验证模式
+ */
+export declare const RecordDeleteSchema: z.ZodObject<{
+    tableId: z.ZodString;
+    recordId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    tableId: string;
+    recordId: string;
+}, {
+    tableId: string;
+    recordId: string;
+}>;
+/**
+ * 上传附件请求验证模式
+ */
+export declare const RecordUploadAttachmentSchema: z.ZodObject<{
+    tableId: z.ZodString;
+    recordId: z.ZodString;
+    fieldId: z.ZodString;
+    file: z.ZodType<File, z.ZodTypeDef, File>;
+    fileUrl: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    tableId: string;
+    recordId: string;
+    fieldId: string;
+    file: File;
+    fileUrl?: string | undefined;
+}, {
+    tableId: string;
+    recordId: string;
+    fieldId: string;
+    file: File;
+    fileUrl?: string | undefined;
+}>;

package/dist/record/types.d.ts

@@ -0,0 +1,262 @@
+import { FieldKeyType, RecordOrder, CellFormat, SortObject, SearchCondition, TableRecord } from "../types";
+export * from "../types";
+/**
+ * 创建记录选项
+ */
+export interface RecordCreateOptions {
+    /** 表 ID */
+    tableId: string;
+    /** 要创建的记录数组 */
+    records: Array<{
+        /** 字段数据，每个字段的值结构根据字段类型而不同 */
+        fields: Record<string, any>;
+    }>;
+    /**
+     * 字段键类型（可选）
+     * @default "name"
+     */
+    fieldKeyType?: FieldKeyType;
+    /**
+     * 是否自动转换字段值类型（可选）
+     * 如果设置为 true，系统会尝试将输入值转换为正确的字段值类型
+     * @default false
+     */
+    typecast?: boolean;
+    /**
+     * 记录排序配置（可选）
+     * 指定新记录在指定视图中的位置
+     */
+    order?: RecordOrder;
+}
+/**
+ * 创建记录响应
+ */
+export interface RecordCreateResponse {
+    /** 创建的记录数组 */
+    records: TableRecord[];
+}
+/**
+ * 获取记录选项
+ */
+export interface RecordGetOptions {
+    /** 表 ID */
+    tableId: string;
+    /**
+     * 视图 ID（可选）
+     * 如果未指定，会按照创建时间来返回记录的顺序，并且返回所有记录和字段
+     */
+    viewId?: string;
+    /**
+     * 获取的记录数量（可选）
+     * @default undefined
+     * @maximum 1000
+     */
+    take?: number;
+    /**
+     * 跳过的记录数量（可选）
+     * 用于分页
+     * @default undefined
+     */
+    skip?: number;
+    /**
+     * 字段键类型（可选）
+     * @default "name"
+     */
+    fieldKeyType?: FieldKeyType;
+    /**
+     * 单元格返回值格式（可选）
+     * @default "json"
+     */
+    cellFormat?: CellFormat;
+    /**
+     * 指定要获取的字段（可选）
+     * 如果不指定，将获取所有可见字段
+     * 参数值取决于 fieldKeyType 设置
+     */
+    projection?: string[];
+    /**
+     * 排序方式（可选）
+     * 排序对象数组
+     */
+    orderBy?: SortObject[];
+    /**
+     * 筛选条件（可选）
+     * 用于筛选结果的复杂查询条件对象
+     */
+    filter?: Record<string, any>;
+    /**
+     * 搜索条件（可选）
+     * 搜索匹配指定字段和值的记录
+     */
+    search?: SearchCondition[];
+}
+/**
+ * 获取记录响应
+ */
+export interface RecordGetResponse {
+    /** 记录数组 */
+    records: TableRecord[];
+    /** 偏移量（用于分页） */
+    offset?: string;
+}
+/**
+ * 获取单个记录选项
+ */
+export interface RecordGetByIdOptions {
+    /** 表 ID */
+    tableId: string;
+    /** 记录 ID */
+    recordId: string;
+    /**
+     * 指定要获取的字段（可选）
+     * 如果不指定，将获取所有可见字段
+     * 参数值取决于 fieldKeyType 设置
+     */
+    projection?: string[];
+    /**
+     * 单元格返回值格式（可选）
+     * @default "json"
+     */
+    cellFormat?: CellFormat;
+    /**
+     * 字段键类型（可选）
+     * @default "name"
+     */
+    fieldKeyType?: FieldKeyType;
+}
+/**
+ * 获取单个记录响应
+ */
+export interface RecordGetByIdResponse {
+    /** 记录 ID */
+    id: string;
+    /** 字段数据 */
+    fields: Record<string, any>;
+    /** 主字段值 */
+    name: string;
+    /** 自增编号 */
+    autoNumber: number;
+    /** 创建时间 */
+    createdTime: string;
+    /** 最后修改时间 */
+    lastModifiedTime: string;
+    /** 创建者 */
+    createdBy: string;
+    /** 最后修改者 */
+    lastModifiedBy: string;
+    /** 权限信息 */
+    permissions: Record<string, any>;
+    /** 是否不可删除 */
+    undeletable: boolean;
+}
+/**
+ * 更新记录选项
+ */
+export interface RecordUpdateOptions {
+    /** 表 ID */
+    tableId: string;
+    /** 记录 ID */
+    recordId: string;
+    /** 记录数据 */
+    record: {
+        /** 字段数据，每个字段的值结构根据字段类型而不同 */
+        fields: Record<string, any>;
+    };
+    /**
+     * 字段键类型（可选）
+     * @default "name"
+     */
+    fieldKeyType?: FieldKeyType;
+    /**
+     * 是否自动转换字段值类型（可选）
+     * 如果设置为 true，系统会尝试将输入值转换为正确的字段值类型
+     * @default false
+     */
+    typecast?: boolean;
+    /**
+     * 记录排序配置（可选）
+     * 指定新记录在指定视图中的位置
+     */
+    order?: RecordOrder;
+}
+/**
+ * 更新记录响应
+ */
+export interface RecordUpdateResponse {
+    /** 记录 ID */
+    id: string;
+    /** 字段数据 */
+    fields: Record<string, any>;
+    /** 主字段值 */
+    name: string;
+    /** 自增编号 */
+    autoNumber: number;
+    /** 创建时间 */
+    createdTime: string;
+    /** 最后修改时间 */
+    lastModifiedTime: string;
+    /** 创建者 */
+    createdBy: string;
+    /** 最后修改者 */
+    lastModifiedBy: string;
+    /** 权限信息 */
+    permissions: Record<string, any>;
+    /** 是否不可删除 */
+    undeletable: boolean;
+}
+/**
+ * 删除记录选项
+ */
+export interface RecordDeleteOptions {
+    /** 表 ID */
+    tableId: string;
+    /** 记录 ID */
+    recordId: string;
+}
+/**
+ * 删除记录响应
+ */
+export interface RecordDeleteResponse {
+    /** 是否删除成功 */
+    success: boolean;
+}
+/**
+ * 上传附件选项
+ */
+export interface RecordUploadAttachmentOptions {
+    /** 表 ID */
+    tableId: string;
+    /** 记录 ID */
+    recordId: string;
+    /** 附件字段 ID */
+    fieldId: string;
+    /** 要上传的文件 */
+    file: File;
+    /** 文件 URL（可选，作为 file 的替代） */
+    fileUrl?: string;
+}
+/**
+ * 上传附件响应
+ */
+export interface RecordUploadAttachmentResponse {
+    /** 记录 ID */
+    id: string;
+    /** 字段数据 */
+    fields: Record<string, any>;
+    /** 主字段值 */
+    name: string;
+    /** 自增编号 */
+    autoNumber: number;
+    /** 创建时间 */
+    createdTime: string;
+    /** 最后修改时间 */
+    lastModifiedTime: string;
+    /** 创建者 */
+    createdBy: string;
+    /** 最后修改者 */
+    lastModifiedBy: string;
+    /** 权限信息 */
+    permissions: Record<string, any>;
+    /** 是否不可删除 */
+    undeletable: boolean;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Teable SDK 配置
+ */
+export interface TeableConfig {
+    /** API 密钥 */
+    apiKey: string;
+    /** Teable 服务器基础 URL */
+    baseUrl: string;
+    /** 数据库 ID（可选） */
+    databaseId?: string;
+    /** 日记表 ID（可选） */
+    diaryTableId?: string;
+}
+/**
+ * 表记录
+ */
+export interface TableRecord {
+    /** 记录 ID */
+    id?: string;
+    /** 字段数据 */
+    fields: Record<string, any>;
+    /** 创建时间 */
+    createdTime?: string;
+    /** 更新时间 */
+    updatedTime?: string;
+}
+/**
+ * 字段键类型
+ * - "name": 使用字段名作为键
+ * - "id": 使用字段 ID 作为键
+ * - "dbFieldName": 使用字段 dbFieldName 作为键
+ */
+export type FieldKeyType = "name" | "id" | "dbFieldName";
+/**
+ * 记录排序位置
+ * - "before": 在锚点记录之前
+ * - "after": 在锚点记录之后
+ */
+export type RecordPosition = "before" | "after";
+/**
+ * 记录排序配置
+ */
+export interface RecordOrder {
+    /** 视图 ID */
+    viewId: string;
+    /** 锚点记录 ID */
+    anchorId: string;
+    /** 相对于锚点记录的位置 */
+    position: RecordPosition;
+}
+/**
+ * 单元格格式
+ * - "json": 返回结构化的 JSON 数据（默认）
+ * - "text": 返回纯文本格式
+ */
+export type CellFormat = "json" | "text";
+/**
+ * 排序对象
+ */
+export interface SortObject {
+    /** 字段名称或 ID（取决于 fieldKeyType） */
+    fieldId: string;
+    /** 排序方向 */
+    order: "asc" | "desc";
+}
+/**
+ * 搜索条件
+ */
+export interface SearchCondition {
+    /** 字段名称或 ID（取决于 fieldKeyType） */
+    field: string;
+    /** 搜索值 */
+    value: string;
+}
+/**
+ * Teable API 响应
+ */
+export interface TeableResponse<T = any> {
+    /** 操作是否成功 */
+    success: boolean;
+    /** 响应数据 */
+    data?: T;
+    /** 错误信息 */
+    error?: string;
+    /** 消息 */
+    message?: string;
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "teable-api-sdk",
+  "version": "1.0.0-test.1",
+  "description": "Teable API SDK - A TypeScript client for Teable API",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "test": "jest",
+    "clean": "rm -rf dist",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "teable",
+    "api",
+    "sdk",
+    "typescript",
+    "database",
+    "spreadsheet"
+  ],
+  "author": "Truraly",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Truraly/teable-api-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Truraly/teable-api-sdk/issues"
+  },
+  "homepage": "https://github.com/Truraly/teable-api-sdk#readme",
+  "peerDependencies": {
+    "axios": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.0",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "@types/jest": "^29.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.0.0",
+    "rollup": "^4.0.0",
+    "ts-jest": "^29.0.0",
+    "tslib": "^2.0.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "zod": "^3.22.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}