@skopon-cool/form-sdk 0.1.1 → 0.1.3

package/src/submit/buildCurlStatement.ts

@@ -11,3 +11,52 @@ export function buildCurlStatement(payload: unknown, callbackUrl?: string | null
     `  -d '${escapeSingleQuotes(body)}'`,
   ].join('\n')
 }
+
+function formatJsonBodyLine(key: string, value: unknown, trailingComma: boolean): string {
+  return `  ${JSON.stringify(key)}: ${JSON.stringify(value)}${trailingComma ? ',' : ''}`
+}
+
+/** 构建含行注释的 JSON body：extra 段标注「额外字段（未在卡片展示）」 */
+export function buildAskUserCurlBodyJson(
+  cardValues: Record<string, unknown>,
+  extraValues: Record<string, unknown>,
+): string {
+  const lines: string[] = ['{']
+  const cardEntries = Object.entries(cardValues)
+  const extraEntries = Object.entries(extraValues)
+
+  cardEntries.forEach(([key, value], index) => {
+    const hasMore = index < cardEntries.length - 1 || extraEntries.length > 0
+    lines.push(formatJsonBodyLine(key, value, hasMore))
+  })
+
+  if (extraEntries.length > 0) {
+    lines.push('  // 额外字段（未在卡片展示）')
+    extraEntries.forEach(([key, value], index) => {
+      lines.push(formatJsonBodyLine(key, value, index < extraEntries.length - 1))
+    })
+  }
+
+  lines.push('}')
+  return lines.join('\n')
+}
+
+export interface BuildAskUserCurlStatementOptions {
+  cardValues: Record<string, unknown>
+  extraValues?: Record<string, unknown>
+  callbackUrl?: string | null
+}
+
+export function buildAskUserCurlStatement({
+  cardValues,
+  extraValues = {},
+  callbackUrl,
+}: BuildAskUserCurlStatementOptions): string {
+  const url = (callbackUrl ?? '').trim() || '<callback_url>'
+  const body = buildAskUserCurlBodyJson(cardValues, extraValues)
+  return [
+    `curl -X POST '${url}' \\`,
+    `  -H 'Content-Type: application/json' \\`,
+    `  -d '${escapeSingleQuotes(body)}'`,
+  ].join('\n')
+}

package/src/submit/intersectPayloadBlocksWithForm.ts

@@ -0,0 +1,175 @@
+import { normalizeFormDefinition } from '../adapter/formSchema'
+import type { FormBlock, FormSchema } from '../types/index'
+import { isInputBlockType, isLayoutBlockType } from '../types/index'
+
+export type PayloadBlocksDefinition = Pick<FormSchema, 'title' | 'description' | 'blocks'>
+
+export interface PayloadBlocksIntersection {
+  matchedBlocks: FormBlock[]
+  extraBlocks: FormBlock[]
+  /** 按 payload 顺序：layout + matched input（不含 extra input） */
+  renderBlocks: FormBlock[]
+  title: string
+  description: string
+}
+
+function normalizePayloadBlock(block: FormBlock): FormBlock {
+  return normalizeFormDefinition({
+    title: '',
+    description: '',
+    blocks: [block],
+    jsonSchema: {},
+  }).blocks[0]!
+}
+
+function buildRenderBlocks(
+  payloadDef: PayloadBlocksDefinition,
+  matchedBlocks: FormBlock[],
+): FormBlock[] {
+  const matchedByName = new Map<string, FormBlock>()
+  for (const block of matchedBlocks) {
+    const name = block.name?.trim()
+    if (name) matchedByName.set(name, block)
+  }
+
+  const renderBlocks: FormBlock[] = []
+  for (const payloadBlock of payloadDef.blocks) {
+    if (isLayoutBlockType(payloadBlock.type)) {
+      renderBlocks.push(normalizePayloadBlock(payloadBlock))
+      continue
+    }
+    if (!isInputBlockType(payloadBlock.type)) continue
+    const name = payloadBlock.name?.trim()
+    if (!name) continue
+    const matched = matchedByName.get(name)
+    if (matched) renderBlocks.push(matched)
+  }
+  return renderBlocks
+}
+
+/** 交集块以 form 定义为准，仅从 payload 合并运行时 defaultValue。 */
+function mergeBlock(formBlock: FormBlock, payloadBlock: FormBlock): FormBlock {
+  const merged: FormBlock = {
+    ...formBlock,
+    name: formBlock.name?.trim() || payloadBlock.name,
+  }
+  if (payloadBlock.defaultValue !== undefined) {
+    merged.defaultValue = payloadBlock.defaultValue
+  }
+  return normalizeFormDefinition({
+    title: '',
+    description: '',
+    blocks: [merged],
+    jsonSchema: {},
+  }).blocks[0]!
+}
+
+/** 解析 ask_user payload 为 blocksJson 形（title / description / blocks） */
+export function parsePayloadBlocksJson(payload: unknown): PayloadBlocksDefinition | null {
+  if (!payload || typeof payload !== 'object' || Array.isArray(payload)) return null
+  const obj = payload as Record<string, unknown>
+  if (!Array.isArray(obj.blocks)) return null
+  return normalizeFormDefinition({
+    title: typeof obj.title === 'string' ? obj.title : '',
+    description: typeof obj.description === 'string' ? obj.description : '',
+    blocks: obj.blocks as FormBlock[],
+    jsonSchema: {},
+  })
+}
+
+/**
+ * payload.blocks 与 vt_forms 按 input 块 name 取交集用于渲染；
+ * payload 中 form 不存在的块归入 extraBlocks（不渲染，提交时写入 curl）。
+ */
+export function intersectPayloadBlocksWithForm(
+  payloadDef: PayloadBlocksDefinition,
+  formDefinition: FormSchema | undefined,
+): PayloadBlocksIntersection {
+  const formByName = new Map<string, FormBlock>()
+  for (const block of formDefinition?.blocks ?? []) {
+    if (isInputBlockType(block.type) && block.name?.trim()) {
+      formByName.set(block.name.trim(), block)
+    }
+  }
+
+  const matchedBlocks: FormBlock[] = []
+  const extraBlocks: FormBlock[] = []
+
+  for (const payloadBlock of payloadDef.blocks) {
+    if (!isInputBlockType(payloadBlock.type)) continue
+    const name = payloadBlock.name?.trim()
+    if (!name) continue
+    const formBlock = formByName.get(name)
+    if (formBlock) {
+      matchedBlocks.push(mergeBlock(formBlock, payloadBlock))
+    } else {
+      extraBlocks.push(
+        normalizeFormDefinition({
+          title: '',
+          description: '',
+          blocks: [payloadBlock],
+          jsonSchema: {},
+        }).blocks[0]!,
+      )
+    }
+  }
+
+  return {
+    matchedBlocks,
+    extraBlocks,
+    renderBlocks: buildRenderBlocks(payloadDef, matchedBlocks),
+    title: payloadDef.title?.trim() || formDefinition?.title?.trim() || '',
+    description: payloadDef.description?.trim() || formDefinition?.description?.trim() || '',
+  }
+}
+
+function blockValueFromDefault(block: FormBlock): unknown {
+  const { type, defaultValue } = block
+  if (defaultValue !== undefined) {
+    if (type === 'toggle') return defaultValue === true || defaultValue === 'true'
+    if (type === 'multiselect' || type === 'checkbox') {
+      if (Array.isArray(defaultValue)) return defaultValue.map(String)
+      if (typeof defaultValue === 'string' && defaultValue) return [defaultValue]
+      return []
+    }
+    return defaultValue
+  }
+  if (type === 'toggle') return false
+  if (type === 'multiselect' || type === 'checkbox') return []
+  if (type === 'number') return null
+  return ''
+}
+
+/** 从 extraBlocks 提取提交值（优先 defaultValue） */
+export function extractExtraBlockValues(extraBlocks: FormBlock[]): Record<string, unknown> {
+  const values: Record<string, unknown> = {}
+  for (const block of extraBlocks) {
+    if (!isInputBlockType(block.type)) continue
+    const name = block.name?.trim()
+    if (!name) continue
+    values[name] = blockValueFromDefault(block)
+  }
+  return values
+}
+
+/** payload 是否含至少一个具 name 的 input 块（可用于卡片 fallback） */
+export function payloadHasInputBlocks(payloadDef: PayloadBlocksDefinition): boolean {
+  return payloadDef.blocks.some(
+    (block) => isInputBlockType(block.type) && Boolean(block.name?.trim()),
+  )
+}
+
+/** 交集为空时 fallback：payload 中可上屏的 blocks（layout + input） */
+export function getPayloadRenderableBlocks(payloadDef: PayloadBlocksDefinition): FormBlock[] {
+  return payloadDef.blocks.filter((block) => {
+    if (isLayoutBlockType(block.type)) return true
+    return isInputBlockType(block.type) && Boolean(block.name?.trim())
+  })
+}
+
+/** payload 中所有 input 块 field name（fallback 提交用） */
+export function getPayloadInputFieldNames(payloadDef: PayloadBlocksDefinition): string[] {
+  return payloadDef.blocks
+    .filter((block) => isInputBlockType(block.type) && block.name?.trim())
+    .map((block) => block.name!.trim())
+}

package/src/submit/submit.test.ts

@@ -1,6 +1,20 @@
+/**
+ * @vitest-environment node
+ */
 import { describe, it, expect, vi } from 'vitest'
-import { buildCurlStatement } from '../submit/buildCurlStatement'
-import { intersectPayloadWithForm } from '../submit/intersectPayloadWithForm'
+import {
+  buildAskUserCurlBodyJson,
+  buildAskUserCurlStatement,
+  buildCurlStatement,
+} from '../submit/buildCurlStatement'
+import {
+  extractExtraBlockValues,
+  getPayloadInputFieldNames,
+  getPayloadRenderableBlocks,
+  intersectPayloadBlocksWithForm,
+  parsePayloadBlocksJson,
+  payloadHasInputBlocks,
+} from '../submit/intersectPayloadBlocksWithForm'
 import { submitFormJson } from '../submit/submitFormJson'
 import type { FormSchema } from '../types/index'
 
@@ -16,9 +30,44 @@ describe('buildCurlStatement', () => {
   })
 })
 
-describe('intersectPayloadWithForm', () => {
+describe('buildAskUserCurlStatement', () => {
+  it('includes extra fields with comment after card values', () => {
+    const body = buildAskUserCurlBodyJson(
+      { video_title: 'hello' },
+      { agent_hint: '请尽快确认' },
+    )
+    expect(body).toContain('"video_title": "hello"')
+    expect(body).toContain('// 额外字段（未在卡片展示）')
+    expect(body).toContain('"agent_hint": "请尽快确认"')
+
+    const curl = buildAskUserCurlStatement({
+      cardValues: { video_title: 'hello' },
+      extraValues: { agent_hint: '请尽快确认' },
+      callbackUrl: 'https://example.com/hook',
+    })
+    expect(curl).toContain('// 额外字段（未在卡片展示）')
+  })
+})
+
+describe('parsePayloadBlocksJson', () => {
+  it('parses blocksJson payload', () => {
+    const parsed = parsePayloadBlocksJson({
+      title: 't',
+      blocks: [{ id: '1', type: 'text', name: 'video_title', label: 'Title' }],
+    })
+    expect(parsed?.blocks).toHaveLength(1)
+    expect(parsed?.blocks[0]?.name).toBe('video_title')
+  })
+
+  it('returns null for non-blocksJson', () => {
+    expect(parsePayloadBlocksJson({ video_title: { type: 'text' } })).toBeNull()
+    expect(parsePayloadBlocksJson(null)).toBeNull()
+  })
+})
+
+describe('intersectPayloadBlocksWithForm', () => {
   const formDef: FormSchema = {
-    title: 't',
+    title: 'Form',
     description: '',
     blocks: [
       { id: '1', type: 'text', name: 'video_title', label: 'Title' },
@@ -27,13 +76,124 @@ describe('intersectPayloadWithForm', () => {
     jsonSchema: {},
   }
 
-  it('matches payload keys to form blocks', () => {
-    const result = intersectPayloadWithForm(
-      { video_title: { type: 'text' }, extra: { type: 'text' } },
-      formDef,
-    )
+  const payloadDef = parsePayloadBlocksJson({
+    title: 'Ask',
+    blocks: [
+      { id: 'p1', type: 'text', name: 'video_title', label: '视频标题' },
+      { id: 'p2', type: 'text', name: 'agent_hint', label: '提示', defaultValue: 'hint' },
+    ],
+  })!
+
+  it('matches payload blocks to form by name', () => {
+    const result = intersectPayloadBlocksWithForm(payloadDef, formDef)
+    expect(result.matchedBlocks.map((b) => b.name)).toEqual(['video_title'])
+    expect(result.extraBlocks.map((b) => b.name)).toEqual(['agent_hint'])
+    expect(result.title).toBe('Ask')
+  })
+
+  it('extracts extra block default values', () => {
+    const result = intersectPayloadBlocksWithForm(payloadDef, formDef)
+    expect(extractExtraBlockValues(result.extraBlocks)).toEqual({ agent_hint: 'hint' })
+  })
+
+  it('keeps form block type and schema when payload type differs', () => {
+    const selectForm: FormSchema = {
+      title: 'Form',
+      description: '',
+      blocks: [
+        {
+          id: '1',
+          type: 'select',
+          name: 'choice',
+          label: 'Form Label',
+          options: [
+            { label: 'A', value: 'a' },
+            { label: 'B', value: 'b' },
+          ],
+        },
+      ],
+      jsonSchema: {},
+    }
+    const mismatchedPayload = parsePayloadBlocksJson({
+      title: 'Ask',
+      blocks: [
+        {
+          id: 'p1',
+          type: 'text',
+          name: 'choice',
+          label: 'Payload Label',
+          defaultValue: 'a',
+        },
+      ],
+    })!
+    const result = intersectPayloadBlocksWithForm(mismatchedPayload, selectForm)
+    expect(result.matchedBlocks).toHaveLength(1)
+    expect(result.matchedBlocks[0]?.type).toBe('select')
+    expect(result.matchedBlocks[0]?.label).toBe('Form Label')
+    expect(result.matchedBlocks[0]?.options).toEqual([
+      { label: 'A', value: 'a' },
+      { label: 'B', value: 'b' },
+    ])
+    expect(result.matchedBlocks[0]?.defaultValue).toBe('a')
+  })
+
+  it('preserves payload layout blocks in renderBlocks on partial intersection', () => {
+    const partialPayload = parsePayloadBlocksJson({
+      title: 'Ask',
+      blocks: [
+        { id: 'h1', type: 'heading', label: '请填写以下信息' },
+        { id: 'p1', type: 'text', name: 'video_title', label: '视频标题' },
+        { id: 'p2', type: 'text', name: 'agent_hint', label: '提示', defaultValue: 'hint' },
+        { id: 'para1', type: 'paragraph', label: '提交后不可修改' },
+      ],
+    })!
+    const result = intersectPayloadBlocksWithForm(partialPayload, formDef)
     expect(result.matchedBlocks.map((b) => b.name)).toEqual(['video_title'])
-    expect(Object.keys(result.remainderPayload)).toEqual(['extra'])
+    expect(result.extraBlocks.map((b) => b.name)).toEqual(['agent_hint'])
+    expect(result.renderBlocks.map((b) => b.type)).toEqual([
+      'heading',
+      'text',
+      'paragraph',
+    ])
+    expect(result.renderBlocks.map((b) => b.label)).toEqual([
+      '请填写以下信息',
+      'Title',
+      '提交后不可修改',
+    ])
+    expect(result.renderBlocks.some((b) => b.type === 'heading' && b.label === '请填写以下信息')).toBe(
+      true,
+    )
+    expect(result.extraBlocks.some((b) => b.type === 'heading')).toBe(false)
+  })
+})
+
+describe('payload fallback helpers', () => {
+  const surveyPayload = parsePayloadBlocksJson({
+    title: '',
+    blocks: [
+      { id: 'title', type: 'heading', label: '问卷调查' },
+      { id: 'q1', type: 'radio', name: 'occupation', label: '职业', options: [] },
+    ],
+  })!
+
+  it('detects input blocks for fallback', () => {
+    expect(payloadHasInputBlocks(surveyPayload)).toBe(true)
+  })
+
+  it('returns layout and input blocks for render', () => {
+    const blocks = getPayloadRenderableBlocks(surveyPayload)
+    expect(blocks.map((b) => b.id)).toEqual(['title', 'q1'])
+  })
+
+  it('returns input field names for submit', () => {
+    expect(getPayloadInputFieldNames(surveyPayload)).toEqual(['occupation'])
+  })
+
+  it('intersection empty when formDef missing but payload still renderable', () => {
+    const result = intersectPayloadBlocksWithForm(surveyPayload, undefined)
+    expect(result.matchedBlocks).toHaveLength(0)
+    expect(payloadHasInputBlocks(surveyPayload)).toBe(true)
+    expect(getPayloadRenderableBlocks(surveyPayload).length).toBeGreaterThan(0)
   })
 })
 

package/src/submit/submitFormJson.ts

@@ -46,5 +46,24 @@ export async function submitFormJson(
 }
 
 export async function copyTextToClipboard(text: string): Promise<void> {
-  await navigator.clipboard.writeText(text)
+  if (typeof navigator !== 'undefined' && navigator.clipboard?.writeText) {
+    await navigator.clipboard.writeText(text)
+    return
+  }
+  if (typeof document === 'undefined') {
+    throw new Error('clipboard unavailable')
+  }
+  const textarea = document.createElement('textarea')
+  textarea.value = text
+  textarea.setAttribute('readonly', '')
+  textarea.style.position = 'fixed'
+  textarea.style.left = '-9999px'
+  document.body.appendChild(textarea)
+  textarea.select()
+  try {
+    const ok = document.execCommand('copy')
+    if (!ok) throw new Error('execCommand copy failed')
+  } finally {
+    document.body.removeChild(textarea)
+  }
 }

package/dist/submit/intersectPayloadWithForm.d.ts

@@ -1,17 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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/src/submit/intersectPayloadWithForm.ts

@@ -1,54 +0,0 @@
-import type { FormBlock, FormSchema } from '../types/index'
-import { isInputBlockType } 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 function getPayloadKeys(payload: unknown): string[] {
-  if (!payload || typeof payload !== 'object' || Array.isArray(payload)) return []
-  return Object.keys(payload as Record<string, unknown>)
-}
-
-export function intersectPayloadWithForm(
-  payload: unknown,
-  formDefinition: FormSchema | undefined,
-): PayloadFormIntersection {
-  const keys = getPayloadKeys(payload)
-  const source = (payload ?? {}) as Record<string, unknown>
-
-  const blocks = formDefinition?.blocks ?? []
-  const inputBlockNames = new Set(
-    blocks
-      .filter((block) => isInputBlockType(block.type) && block.name?.trim())
-      .map((block) => block.name!.trim()),
-  )
-
-  const matchedBlocks = blocks.filter(
-    (block) =>
-      isInputBlockType(block.type) &&
-      block.name?.trim() &&
-      keys.includes(block.name.trim()),
-  )
-
-  const remainderPayload: AskUserPayload = {}
-  for (const key of keys) {
-    if (!inputBlockNames.has(key)) {
-      remainderPayload[key] = source[key]
-    }
-  }
-
-  return { matchedBlocks, remainderPayload }
-}