@skopon-cool/form-sdk 0.4.6 → 0.4.7

package/dist/submit/intersectPayloadBlocksWithForm.d.ts

@@ -25,8 +25,10 @@ export declare function intersectPayloadBlocksWithForm(payloadDef: PayloadBlocks
 export declare function extractExtraBlockValues(extraBlocks: FormBlock[]): Record<string, unknown>;
 /** payload 是否含至少一个具 name 的 input 块（可用于卡片 fallback） */
 export declare function payloadHasInputBlocks(payloadDef: PayloadBlocksDefinition): boolean;
-/** 交集为空时 fallback：payload 中可上屏的 blocks（layout + input） */
+/** 交集为空时 fallback：payload 中可上屏的 blocks（layout + 非 hidden input） */
 export declare function getPayloadRenderableBlocks(payloadDef: PayloadBlocksDefinition): FormBlock[];
-/** payload 中所有 input 块 field name（fallback 提交用） */
+/** payload 中所有 input 块 field name（fallback 提交用，含 hidden） */
 export declare function getPayloadInputFieldNames(payloadDef: PayloadBlocksDefinition): string[];
+/** payload 中 hidden text 的默认提交值（fallback 不上屏时仍需写入 answer） */
+export declare function getPayloadHiddenBlockValues(payloadDef: PayloadBlocksDefinition): Record<string, unknown>;
 //# sourceMappingURL=intersectPayloadBlocksWithForm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"intersectPayloadBlocksWithForm.d.ts","sourceRoot":"","sources":["../../src/submit/intersectPayloadBlocksWithForm.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAG3D,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,UAAU,EAAE,OAAO,GAAG,aAAa,GAAG,QAAQ,CAAC,GAAG;IAC3F;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,SAAS,EAAE,CAAA;IAC1B,WAAW,EAAE,SAAS,EAAE,CAAA;IACxB,0DAA0D;IAC1D,YAAY,EAAE,SAAS,EAAE,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;CACpB;AAuED,uEAAuE;AACvE,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,uBAAuB,GAAG,IAAI,CAmBvF;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,uBAAuB,EACnC,cAAc,EAAE,UAAU,GAAG,SAAS,GACrC,yBAAyB,CA+B3B;AA+BD,2CAA2C;AAC3C,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CASzF;AAED,sDAAsD;AACtD,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,uBAAuB,GAAG,OAAO,CAIlF;AAED,0DAA0D;AAC1D,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,EAAE,CAK3F;AAED,mDAAmD;AACnD,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,uBAAuB,GAAG,MAAM,EAAE,CAIvF"}
+{"version":3,"file":"intersectPayloadBlocksWithForm.d.ts","sourceRoot":"","sources":["../../src/submit/intersectPayloadBlocksWithForm.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAG3D,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,UAAU,EAAE,OAAO,GAAG,aAAa,GAAG,QAAQ,CAAC,GAAG;IAC3F;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,SAAS,EAAE,CAAA;IAC1B,WAAW,EAAE,SAAS,EAAE,CAAA;IACxB,0DAA0D;IAC1D,YAAY,EAAE,SAAS,EAAE,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;CACpB;AA8ED,uEAAuE;AACvE,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,uBAAuB,GAAG,IAAI,CAmBvF;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,uBAAuB,EACnC,cAAc,EAAE,UAAU,GAAG,SAAS,GACrC,yBAAyB,CA+B3B;AA+BD,2CAA2C;AAC3C,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CASzF;AAED,sDAAsD;AACtD,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,uBAAuB,GAAG,OAAO,CAIlF;AAED,mEAAmE;AACnE,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,EAAE,CAO3F;AAED,4DAA4D;AAC5D,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,uBAAuB,GAAG,MAAM,EAAE,CAIvF;AAED,6DAA6D;AAC7D,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,uBAAuB,GAClC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CASzB"}

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.4.6",
+  "version": "0.4.7",
   "description": "Skopon form rendering SDK (A2UI + form_definition) with submit helpers",
   "type": "module",
   "sideEffects": [

package/src/adapter/a2uiAdapter.test.ts

@@ -88,6 +88,31 @@ describe('a2uiAdapter blocks <-> surface', () => {
     expect(imgNode?.mediaSize).toBe('large')
   })
 
+  it('blocksToA2ui omits hidden text controls but keeps dataModel defaults', () => {
+    const doc = blocksToA2ui(
+      {
+        title: '',
+        description: '',
+        blocks: [
+          { id: 'b-title', type: 'text', name: 'title', label: '标题', defaultValue: 'shown' },
+          {
+            id: 'b-hint',
+            type: 'text',
+            name: 'agent_hint',
+            label: '提示',
+            defaultValue: 'secret',
+            hidden: true,
+          },
+        ],
+      },
+      { includeHeader: false },
+    )
+    expect(doc.components.some((c) => c.id === 'b-hint')).toBe(false)
+    expect(doc.components.some((c) => c.id === 'b-title')).toBe(true)
+    expect(doc.dataModel?.agent_hint).toBe('secret')
+    expect(doc.dataModel?.title).toBe('shown')
+  })
+
   it('blocksToA2ui preserves select vs multiselect picker types', () => {
     const doc = blocksToA2ui(
       {

package/src/adapter/a2uiAdapter.ts

@@ -147,6 +147,20 @@ function blockToComponent(block: FormBlock): {
       return { node: { id, component: 'Text', text: label, variant: 'body' } }
 
     case 'text':
+      // 隐藏 text：不生成可见控件，仍写入 dataModel 默认值供提交
+      if (block.hidden) {
+        return name
+          ? { node: null, dataKey: name, dataValue: defaultValueForBlock(block) }
+          : { node: null }
+      }
+      return withData({
+        id,
+        component: 'TextField',
+        label,
+        variant: 'shortText',
+        ...(block.placeholder ? { placeholder: block.placeholder } : {}),
+        value: { path },
+      })
     case 'tel':
     case 'url':
       return withData({
@@ -312,10 +326,11 @@ export function blocksToA2ui(
 
   for (const block of definition.blocks ?? []) {
     const { node, dataKey, dataValue } = blockToComponent(block)
+    // hidden 等无节点块仍可写入 dataModel，保证「不展示仍提交」
+    if (dataKey) dataModel[dataKey] = dataValue
     if (!node) continue
     components.push(node)
     childIds.push(node.id)
-    if (dataKey) dataModel[dataKey] = dataValue
   }
 
   components.unshift({ id: ROOT_ID, component: 'Column', children: childIds })

package/src/components/AskUserFormCard.tsx

@@ -13,7 +13,7 @@ import {
 } from '../submit/buildAnswerAgentBody'
 import {
   extractExtraBlockValues,
-  getPayloadInputFieldNames,
+  getPayloadHiddenBlockValues,
   getPayloadRenderableBlocks,
   intersectPayloadBlocksWithForm,
   parsePayloadBlocksJson,
@@ -195,18 +195,29 @@ function AskUserFormCardBody({
     return []
   }, [intersection, usePayloadFallback, payloadDef])
 
-  const extraValues = useMemo(
-    () => (usePayloadFallback ? {} : extractExtraBlockValues(intersection?.extraBlocks ?? [])),
-    [usePayloadFallback, intersection],
+  const extraValues = useMemo(() => {
+    if (usePayloadFallback && payloadDef) {
+      // fallback：hidden 不上屏，提交仍带默认值
+      return getPayloadHiddenBlockValues(payloadDef)
+    }
+    const fromExtra = extractExtraBlockValues(intersection?.extraBlocks ?? [])
+    // 交集命中但 surface 可能为空（仅 hidden）时，兜底写入默认值
+    const fromHiddenMatched = extractExtraBlockValues(
+      (intersection?.matchedBlocks ?? []).filter(
+        (block) => block.type === 'text' && block.hidden === true,
+      ),
+    )
+    return { ...fromHiddenMatched, ...fromExtra }
+  }, [usePayloadFallback, payloadDef, intersection])
+
+  const fieldNames = useMemo(
+    () =>
+      renderBlocks
+        .filter((block) => block.name?.trim())
+        .map((block) => block.name!.trim()),
+    [renderBlocks],
   )
 
-  const fieldNames = useMemo(() => {
-    if (usePayloadFallback && payloadDef) return getPayloadInputFieldNames(payloadDef)
-    return renderBlocks
-      .filter((block) => block.name?.trim())
-      .map((block) => block.name!.trim())
-  }, [usePayloadFallback, payloadDef, renderBlocks])
-
   const surfaceTitle = intersection?.title ?? payloadDef?.title ?? ''
   const surfaceDescription = intersection?.description ?? payloadDef?.description ?? ''
 
@@ -313,12 +324,13 @@ function AskUserFormCardBody({
     setSubmitting(true)
     try {
       const cardValues = rendererRef.current?.getValues(fieldNames) ?? {}
-      const validationError = validateFormSubmitValues(renderBlocks, cardValues)
+      // extra/hidden 后合并：getValues 对未上屏字段可能为 undefined，不能覆盖默认值
+      const answer = { ...cardValues, ...extraValues }
+      const validationError = validateFormSubmitValues(renderBlocks, answer)
       if (validationError) {
         onNotifyRef.current?.('error', validationError.message)
         return
       }
-      const answer = { ...cardValues, ...extraValues }
 
       if (submitMode === 'post') {
         const url = (callbackUrl ?? '').trim()

package/src/index.ts

@@ -65,6 +65,7 @@ export {
 } from './submit/buildCurlStatement'
 export {
   extractExtraBlockValues,
+  getPayloadHiddenBlockValues,
   getPayloadInputFieldNames,
   getPayloadRenderableBlocks,
   intersectPayloadBlocksWithForm,

package/src/submit/intersectPayloadBlocksWithForm.ts

@@ -21,6 +21,10 @@ export interface PayloadBlocksIntersection {
 
 const FORM_ANCHORED_KEYS = new Set(['type', 'name', 'id'])
 
+function isHiddenTextBlock(block: FormBlock): boolean {
+  return block.type === 'text' && block.hidden === true
+}
+
 function normalizePayloadBlock(block: FormBlock): FormBlock {
   return normalizeFormDefinition({
     title: '',
@@ -50,7 +54,10 @@ function buildRenderBlocks(
     const name = payloadBlock.name?.trim()
     if (!name) continue
     const matched = matchedByName.get(name)
-    if (matched) renderBlocks.push(matched)
+    if (!matched) continue
+    // hidden text 不上屏；提交值由 AskUser 从 matchedBlocks 提取
+    if (isHiddenTextBlock(matched)) continue
+    renderBlocks.push(matched)
   }
   return renderBlocks
 }
@@ -198,17 +205,33 @@ export function payloadHasInputBlocks(payloadDef: PayloadBlocksDefinition): bool
   )
 }
 
-/** 交集为空时 fallback：payload 中可上屏的 blocks（layout + input） */
+/** 交集为空时 fallback：payload 中可上屏的 blocks（layout + 非 hidden 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())
+    if (!isInputBlockType(block.type) || !block.name?.trim()) return false
+    // hidden text 不上屏；提交值由 getPayloadHiddenBlockValues / dataModel 补齐
+    return !isHiddenTextBlock(block)
   })
 }
 
-/** payload 中所有 input 块 field name（fallback 提交用） */
+/** payload 中所有 input 块 field name（fallback 提交用，含 hidden） */
 export function getPayloadInputFieldNames(payloadDef: PayloadBlocksDefinition): string[] {
   return payloadDef.blocks
     .filter((block) => isInputBlockType(block.type) && block.name?.trim())
     .map((block) => block.name!.trim())
 }
+
+/** payload 中 hidden text 的默认提交值（fallback 不上屏时仍需写入 answer） */
+export function getPayloadHiddenBlockValues(
+  payloadDef: PayloadBlocksDefinition,
+): Record<string, unknown> {
+  const values: Record<string, unknown> = {}
+  for (const block of payloadDef.blocks) {
+    if (!isHiddenTextBlock(block)) continue
+    const name = block.name?.trim()
+    if (!name) continue
+    values[name] = blockValueFromDefault(block)
+  }
+  return values
+}

package/src/submit/submit.test.ts

@@ -11,6 +11,7 @@ import {
 import { buildAnswerAgentBody, validateAnswerAgentBody } from '../submit/buildAnswerAgentBody'
 import {
   extractExtraBlockValues,
+  getPayloadHiddenBlockValues,
   getPayloadInputFieldNames,
   getPayloadRenderableBlocks,
   intersectPayloadBlocksWithForm,
@@ -427,6 +428,59 @@ describe('payload fallback helpers', () => {
     expect(blocks.map((b) => b.id)).toEqual(['title', 'q1'])
   })
 
+  it('excludes hidden text from renderable blocks but keeps submit defaults', () => {
+    const withHidden = parsePayloadBlocksJson({
+      title: '',
+      blocks: [
+        { id: 'title', type: 'heading', label: '问卷调查' },
+        { id: 'q1', type: 'radio', name: 'occupation', label: '职业', options: [] },
+        {
+          id: 'hint',
+          type: 'text',
+          name: 'agent_hint',
+          label: '提示',
+          defaultValue: 'keep-me',
+          hidden: true,
+        },
+      ],
+    })!
+    expect(getPayloadRenderableBlocks(withHidden).map((b) => b.id)).toEqual(['title', 'q1'])
+    expect(getPayloadHiddenBlockValues(withHidden)).toEqual({ agent_hint: 'keep-me' })
+    expect(getPayloadInputFieldNames(withHidden)).toEqual(['occupation', 'agent_hint'])
+  })
+
+  it('omits matched hidden text from renderBlocks', () => {
+    const formWithHint: FormSchema = {
+      title: 'Form',
+      description: '',
+      blocks: [
+        { id: '1', type: 'text', name: 'video_title', label: 'Title' },
+        { id: '2', type: 'text', name: 'agent_hint', label: 'Hint', hidden: true },
+      ],
+      jsonSchema: {},
+    }
+    const payload = parsePayloadBlocksJson({
+      title: 'Ask',
+      blocks: [
+        { id: 'p1', type: 'text', name: 'video_title', label: '视频标题' },
+        {
+          id: 'p2',
+          type: 'text',
+          name: 'agent_hint',
+          label: '提示',
+          defaultValue: 'hint',
+          hidden: true,
+        },
+      ],
+    })!
+    const result = intersectPayloadBlocksWithForm(payload, formWithHint)
+    expect(result.matchedBlocks.map((b) => b.name)).toEqual(['video_title', 'agent_hint'])
+    expect(result.renderBlocks.map((b) => b.name)).toEqual(['video_title'])
+    expect(extractExtraBlockValues(result.matchedBlocks.filter((b) => b.hidden))).toEqual({
+      agent_hint: 'hint',
+    })
+  })
+
   it('returns input field names for submit', () => {
     expect(getPayloadInputFieldNames(surveyPayload)).toEqual(['occupation'])
   })