@skopon-cool/form-sdk 0.1.0

package/dist/submit/buildCurlStatement.d.ts

@@ -0,0 +1,2 @@
+export declare function buildCurlStatement(payload: unknown, callbackUrl?: string | null): string;
+//# sourceMappingURL=buildCurlStatement.d.ts.map

package/dist/submit/buildCurlStatement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildCurlStatement.d.ts","sourceRoot":"","sources":["../../src/submit/buildCurlStatement.ts"],"names":[],"mappings":"AAIA,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAQxF"}

package/dist/submit/intersectPayloadWithForm.d.ts

@@ -0,0 +1,17 @@
+import type { FormBlock, FormSchema } from '../types/index';
+/** payload 单个字段的元数据约定（见 docs/ask/ payload.json） */
+export interface AskUserPayloadField {
+    用途描述?: string;
+    字段类型?: string;
+    字段格式?: string;
+    字段枚举?: string;
+    [key: string]: unknown;
+}
+export type AskUserPayload = Record<string, AskUserPayloadField | unknown>;
+export interface PayloadFormIntersection {
+    matchedBlocks: FormBlock[];
+    remainderPayload: AskUserPayload;
+}
+export declare function getPayloadKeys(payload: unknown): string[];
+export declare function intersectPayloadWithForm(payload: unknown, formDefinition: FormSchema | undefined): PayloadFormIntersection;
+//# sourceMappingURL=intersectPayloadWithForm.d.ts.map

package/dist/submit/intersectPayloadWithForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intersectPayloadWithForm.d.ts","sourceRoot":"","sources":["../../src/submit/intersectPayloadWithForm.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAG3D,mDAAmD;AACnD,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,CAAA;AAE1E,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,SAAS,EAAE,CAAA;IAC1B,gBAAgB,EAAE,cAAc,CAAA;CACjC;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,CAGzD;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,UAAU,GAAG,SAAS,GACrC,uBAAuB,CA0BzB"}

package/dist/submit/submitFormJson.d.ts

@@ -0,0 +1,12 @@
+export interface SubmitFormJsonOptions {
+    fetch?: typeof fetch;
+    headers?: Record<string, string>;
+}
+export interface SubmitFormJsonResult {
+    ok: boolean;
+    status: number;
+    body?: unknown;
+}
+export declare function submitFormJson(callbackUrl: string, payload: unknown, options?: SubmitFormJsonOptions): Promise<SubmitFormJsonResult>;
+export declare function copyTextToClipboard(text: string): Promise<void>;
+//# sourceMappingURL=submitFormJson.d.ts.map

package/dist/submit/submitFormJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"submitFormJson.d.ts","sourceRoot":"","sources":["../../src/submit/submitFormJson.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,OAAO,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,OAAO,CAAA;CACf;AAED,wBAAsB,cAAc,CAClC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,oBAAoB,CAAC,CA8B/B;AAED,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAErE"}

package/dist/types/index.d.ts

@@ -0,0 +1,76 @@
+/**
+ * A2UI v0.9 协议子集类型（对齐 @a2ui/react basicCatalog + skopon 自定义 catalog）。
+ */
+export type A2uiBinding<T> = T | {
+    path: string;
+};
+export type A2uiComponentName = 'Column' | 'Row' | 'Text' | 'Image' | 'Video' | 'AudioPlayer' | 'TextField' | 'CheckBox' | 'ChoicePicker' | 'DateTimeInput' | 'FileUpload' | 'SkoponMedia' | 'SkoponSelect';
+export interface A2uiComponentNode {
+    id: string;
+    component: A2uiComponentName | string;
+    children?: string[];
+    [prop: string]: unknown;
+}
+export interface A2uiSurfaceDoc {
+    root: string;
+    components: A2uiComponentNode[];
+    dataModel?: Record<string, unknown>;
+    surfaceProperties?: Record<string, unknown> & {
+        styleId?: string | null;
+    };
+}
+export declare const A2UI_PROTOCOL_VERSION: "v0.9";
+export type FormJsonSchema = Record<string, unknown>;
+export type FormBlockType = 'heading' | 'paragraph' | 'text' | 'textarea' | 'email' | 'number' | 'select' | 'multiselect' | 'radio' | 'checkbox' | 'toggle' | 'tel' | 'url' | 'datetime' | 'time' | 'file' | 'image' | 'video' | 'audio';
+export type FormMediaSize = 'huge' | 'large' | 'medium' | 'small' | 'icon';
+export type FormFilePlaceholderIcon = 'video' | 'audio' | 'image' | 'file' | 'spreadsheet' | 'document';
+export declare const FORM_MEDIA_SIZES: FormMediaSize[];
+export interface FormBlockOption {
+    value: string;
+    label: string;
+}
+export interface FormBlock {
+    id: string;
+    type: FormBlockType;
+    name?: string;
+    label?: string;
+    placeholder?: string;
+    help?: string;
+    required?: boolean;
+    options?: FormBlockOption[];
+    mediaUrl?: string;
+    mediaUrls?: string[];
+    mediaSize?: FormMediaSize;
+    fileAcceptTypes?: string[];
+    fileAcceptExtensions?: string[];
+    filePlaceholderIcon?: FormFilePlaceholderIcon;
+    fileMinCount?: number;
+    fileMaxCount?: number;
+    defaultValue?: string | string[] | boolean;
+}
+export interface FormSchema {
+    title?: string;
+    description?: string;
+    blocks: FormBlock[];
+    jsonSchema: FormJsonSchema;
+}
+export declare function isMediaBlockType(type: FormBlockType): boolean;
+export declare function isLayoutBlockType(type: FormBlockType): boolean;
+export declare function isInputBlockType(type: FormBlockType): boolean;
+export interface FormDefinitionPayload {
+    title?: string;
+    description?: string;
+    blocks?: FormBlock[];
+    a2ui?: A2uiSurfaceDoc;
+    json_schema?: FormJsonSchema;
+    jsonSchema?: FormJsonSchema;
+}
+export interface FormDetailResult {
+    formUniqueId: string;
+    formId?: number;
+    disabled: boolean;
+    formDefinition?: FormSchema;
+    a2ui?: A2uiSurfaceDoc;
+}
+export type SubmitMode = 'curl' | 'post';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAEjD,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,KAAK,GACL,MAAM,GACN,OAAO,GACP,OAAO,GACP,aAAa,GACb,WAAW,GACX,UAAU,GACV,cAAc,GACd,eAAe,GACf,YAAY,GACZ,aAAa,GACb,cAAc,CAAA;AAElB,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,iBAAiB,GAAG,MAAM,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,iBAAiB,EAAE,CAAA;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAA;CAC1E;AAED,eAAO,MAAM,qBAAqB,EAAG,MAAe,CAAA;AAEpD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEpD,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,WAAW,GACX,MAAM,GACN,UAAU,GACV,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,aAAa,GACb,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,KAAK,GACL,UAAU,GACV,MAAM,GACN,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,CAAA;AAEX,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAA;AAE1E,MAAM,MAAM,uBAAuB,GAC/B,OAAO,GACP,OAAO,GACP,OAAO,GACP,MAAM,GACN,aAAa,GACb,UAAU,CAAA;AAEd,eAAO,MAAM,gBAAgB,EAAE,aAAa,EAM3C,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,aAAa,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,eAAe,EAAE,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC/B,mBAAmB,CAAC,EAAE,uBAAuB,CAAA;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAA;CAC3C;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,SAAS,EAAE,CAAA;IACnB,UAAU,EAAE,cAAc,CAAA;CAC3B;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAE7D;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAE9D;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAE7D;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAA;IACpB,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,WAAW,CAAC,EAAE,cAAc,CAAA;IAC5B,UAAU,CAAC,EAAE,cAAc,CAAA;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,CAAC,EAAE,UAAU,CAAA;IAC3B,IAAI,CAAC,EAAE,cAAc,CAAA;CACtB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAA"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@skopon-cool/form-sdk",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.1.0",
+  "description": "Skopon form rendering SDK (A2UI + form_definition) with submit helpers",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./styles.css": "./dist/form-sdk.css"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "peerDependencies": {
+    "@ant-design/icons": "^6.0.0",
+    "@a2ui/react": "^0.10.1",
+    "@a2ui/web_core": "^0.10.2",
+    "antd": "^6.4.3",
+    "dayjs": "^1.11.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@ant-design/icons": "^6.2.3",
+    "@a2ui/react": "^0.10.1",
+    "@a2ui/web_core": "^0.10.2",
+    "@types/react": "^19.1.2",
+    "@types/react-dom": "^19.1.2",
+    "@vitejs/plugin-react": "^4.5.2",
+    "antd": "^6.4.3",
+    "dayjs": "^1.11.13",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "typescript": "~5.8.3",
+    "vite": "^6.3.5",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.2.4"
+  }
+}

package/src/adapter/a2uiAdapter.test.ts

@@ -0,0 +1,150 @@
+import { describe, it, expect } from 'vitest'
+import type { FormSchema } from '../types/index'
+import { a2uiToBlocks, blocksToA2ui, isA2uiSurfaceEmpty, surfaceDocToMessages } from './a2uiAdapter'
+
+function makeDefinition(): Pick<FormSchema, 'title' | 'description' | 'blocks'> {
+  return {
+    title: '报名表',
+    description: '请填写信息',
+    blocks: [
+      { id: 'b-name', type: 'text', name: 'name', label: '姓名' },
+      { id: 'b-email', type: 'email', name: 'email', label: '邮箱' },
+      { id: 'b-bio', type: 'textarea', name: 'bio', label: '简介' },
+      { id: 'b-age', type: 'number', name: 'age', label: '年龄' },
+      {
+        id: 'b-gender',
+        type: 'radio',
+        name: 'gender',
+        label: '性别',
+        options: [
+          { label: '男', value: 'm' },
+          { label: '女', value: 'f' },
+        ],
+      },
+      {
+        id: 'b-hobby',
+        type: 'checkbox',
+        name: 'hobby',
+        label: '爱好',
+        options: [
+          { label: '阅读', value: 'read' },
+          { label: '运动', value: 'sport' },
+        ],
+      },
+      { id: 'b-sub', type: 'toggle', name: 'subscribe', label: '订阅' },
+      { id: 'b-when', type: 'datetime', name: 'when', label: '时间' },
+      { id: 'b-file', type: 'file', name: 'attach', label: '附件' },
+      { id: 'b-img', type: 'image', label: '示例图', mediaUrls: ['https://x/y.png'], mediaSize: 'large' },
+    ],
+  }
+}
+
+describe('a2uiAdapter blocks <-> surface', () => {
+  it('blocksToA2ui builds a Column root referencing all components', () => {
+    const doc = blocksToA2ui(makeDefinition(), { styleId: 'theme-a' })
+    const root = doc.components.find((c) => c.id === 'root')
+    expect(root?.component).toBe('Column')
+    expect(Array.isArray(root?.children)).toBe(true)
+    // title + desc + 10 blocks
+    expect((root?.children as string[]).length).toBe(12)
+    expect(doc.surfaceProperties?.styleId).toBe('theme-a')
+    // every child id exists in components
+    const ids = new Set(doc.components.map((c) => c.id))
+    for (const childId of root?.children as string[]) {
+      expect(ids.has(childId)).toBe(true)
+    }
+  })
+
+  it('round-trips block types through a2uiToBlocks', () => {
+    const doc = blocksToA2ui(makeDefinition())
+    const back = a2uiToBlocks(doc)
+    expect(back.title).toBe('报名表')
+    expect(back.description).toBe('请填写信息')
+    const byName = (n: string) => back.blocks.find((b) => b.name === n)
+    expect(byName('name')?.type).toBe('text')
+    expect(byName('email')?.type).toBe('email')
+    expect(byName('bio')?.type).toBe('textarea')
+    expect(byName('age')?.type).toBe('number')
+    expect(byName('gender')?.type).toBe('radio')
+    expect(byName('gender')?.options?.length).toBe(2)
+    expect(byName('hobby')?.type).toBe('checkbox')
+    expect(byName('subscribe')?.type).toBe('toggle')
+    expect(byName('when')?.type).toBe('datetime')
+    expect(byName('attach')?.type).toBe('file')
+    const img = back.blocks.find((b) => b.type === 'image')
+    expect(img?.mediaUrls?.[0]).toBe('https://x/y.png')
+    expect(img?.mediaSize).toBe('large')
+  })
+
+  it('blocksToA2ui emits SkoponMedia for image blocks', () => {
+    const doc = blocksToA2ui(makeDefinition(), { includeHeader: false })
+    const imgNode = doc.components.find((c) => c.id === 'b-img')
+    expect(imgNode?.component).toBe('SkoponMedia')
+    expect(imgNode?.mediaType).toBe('image')
+    expect(imgNode?.mediaSize).toBe('large')
+  })
+
+  it('blocksToA2ui preserves select vs multiselect picker types', () => {
+    const doc = blocksToA2ui(
+      {
+        title: '',
+        description: '',
+        blocks: [
+          {
+            id: 'b-city',
+            type: 'select',
+            name: 'city',
+            label: '城市',
+            options: [{ label: '北京', value: 'bj' }],
+          },
+          {
+            id: 'b-tags',
+            type: 'multiselect',
+            name: 'tags',
+            label: '标签',
+            options: [{ label: 'A', value: 'a' }],
+          },
+        ],
+      },
+      { includeHeader: false },
+    )
+    const city = doc.components.find((c) => c.id === 'b-city')
+    const tags = doc.components.find((c) => c.id === 'b-tags')
+    expect(city?.component).toBe('SkoponSelect')
+    expect(city?.mode).toBe('single')
+    expect(tags?.component).toBe('SkoponSelect')
+    expect(tags?.mode).toBe('multiple')
+
+    const back = a2uiToBlocks(doc)
+    expect(back.blocks.find((b) => b.name === 'city')?.type).toBe('select')
+    expect(back.blocks.find((b) => b.name === 'tags')?.type).toBe('multiselect')
+  })
+
+  it('surfaceDocToMessages emits createSurface + updateComponents + updateDataModel', () => {
+    const doc = blocksToA2ui(makeDefinition())
+    const messages = surfaceDocToMessages(doc, { surfaceId: 's1', catalogId: 'c1' })
+    expect(messages[0]).toHaveProperty('createSurface')
+    expect(messages[1]).toHaveProperty('updateComponents')
+    expect(messages.some((m) => 'updateDataModel' in m)).toBe(true)
+  })
+
+  it('isA2uiSurfaceEmpty detects empty root Column', () => {
+    const empty = blocksToA2ui({ title: '', description: '', blocks: [] })
+    expect(isA2uiSurfaceEmpty(empty)).toBe(true)
+    expect(isA2uiSurfaceEmpty(null)).toBe(true)
+    const full = blocksToA2ui(makeDefinition())
+    const root = full.components.find((c) => c.id === 'root')
+    expect(root?.children?.length).toBeGreaterThan(0)
+    expect(isA2uiSurfaceEmpty(full)).toBe(false)
+  })
+
+  it('blocksToA2ui includeHeader:false skips title and description Text nodes', () => {
+    const doc = blocksToA2ui(makeDefinition(), { includeHeader: false })
+    const root = doc.components.find((c) => c.id === 'root')
+    expect(root?.children).not.toContain('__title__')
+    expect(root?.children).not.toContain('__desc__')
+    expect((root?.children as string[]).length).toBe(10)
+    const withHeader = blocksToA2ui(makeDefinition())
+    expect((withHeader.components.find((c) => c.id === 'root')?.children as string[]).length).toBe(12)
+  })
+})