@panneau/protocol 5.0.0-alpha.0 → 5.0.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/README.md +13 -8
  2. package/dist/conditions.d.ts +1 -1
  3. package/dist/conformance/index.d.ts.map +1 -1
  4. package/dist/conformance/index.js +310 -4
  5. package/dist/conformance/index.js.map +1 -1
  6. package/dist/constants.d.ts +44 -0
  7. package/dist/constants.d.ts.map +1 -0
  8. package/dist/constants.js +128 -0
  9. package/dist/constants.js.map +1 -0
  10. package/dist/index.d.ts +4 -9
  11. package/dist/index.d.ts.map +1 -1
  12. package/dist/index.js +22 -15
  13. package/dist/libraries.d.ts +16 -0
  14. package/dist/libraries.d.ts.map +1 -0
  15. package/dist/libraries.js +15 -0
  16. package/dist/libraries.js.map +1 -0
  17. package/dist/lint.d.ts +4 -3
  18. package/dist/lint.d.ts.map +1 -1
  19. package/dist/lint.js +34 -2
  20. package/dist/lint.js.map +1 -1
  21. package/dist/mock/example.d.ts +3 -2
  22. package/dist/mock/example.d.ts.map +1 -1
  23. package/dist/mock/example.js +223 -138
  24. package/dist/mock/example.js.map +1 -1
  25. package/dist/mock/index.d.ts +19 -5
  26. package/dist/mock/index.d.ts.map +1 -1
  27. package/dist/mock/index.js +383 -19
  28. package/dist/mock/index.js.map +1 -1
  29. package/dist/openapi.d.ts +2 -0
  30. package/dist/openapi.d.ts.map +1 -1
  31. package/dist/openapi.js +113 -109
  32. package/dist/openapi.js.map +1 -1
  33. package/dist/problem.d.ts +7 -0
  34. package/dist/problem.d.ts.map +1 -0
  35. package/dist/problem.js +22 -0
  36. package/dist/problem.js.map +1 -0
  37. package/dist/query.d.ts +40 -2
  38. package/dist/query.d.ts.map +1 -1
  39. package/dist/query.js +47 -6
  40. package/dist/query.js.map +1 -1
  41. package/dist/rules.d.ts +6 -3
  42. package/dist/rules.d.ts.map +1 -1
  43. package/dist/rules.js +51 -9
  44. package/dist/rules.js.map +1 -1
  45. package/dist/runtime/index.d.ts +14 -0
  46. package/dist/runtime/index.d.ts.map +1 -0
  47. package/dist/runtime/index.js +13 -0
  48. package/dist/schemas/action.d.ts +69 -13
  49. package/dist/schemas/action.d.ts.map +1 -1
  50. package/dist/schemas/action.js +21 -14
  51. package/dist/schemas/action.js.map +1 -1
  52. package/dist/schemas/api.d.ts +224 -39
  53. package/dist/schemas/api.d.ts.map +1 -1
  54. package/dist/schemas/api.js +125 -31
  55. package/dist/schemas/api.js.map +1 -1
  56. package/dist/schemas/boot.d.ts +24 -6
  57. package/dist/schemas/boot.d.ts.map +1 -1
  58. package/dist/schemas/boot.js +3 -7
  59. package/dist/schemas/boot.js.map +1 -1
  60. package/dist/schemas/common.d.ts +1 -0
  61. package/dist/schemas/common.d.ts.map +1 -1
  62. package/dist/schemas/common.js +2 -1
  63. package/dist/schemas/common.js.map +1 -1
  64. package/dist/schemas/definition.d.ts +222 -20
  65. package/dist/schemas/definition.d.ts.map +1 -1
  66. package/dist/schemas/definition.js +16 -11
  67. package/dist/schemas/definition.js.map +1 -1
  68. package/dist/schemas/field.d.ts +162 -8
  69. package/dist/schemas/field.d.ts.map +1 -1
  70. package/dist/schemas/field.js +69 -49
  71. package/dist/schemas/field.js.map +1 -1
  72. package/dist/schemas/index.d.ts +955 -63
  73. package/dist/schemas/index.d.ts.map +1 -1
  74. package/dist/schemas/index.js +41 -12
  75. package/dist/schemas/index.js.map +1 -1
  76. package/dist/schemas/jsonRules.d.ts +83 -0
  77. package/dist/schemas/jsonRules.d.ts.map +1 -0
  78. package/dist/schemas/jsonRules.js +46 -0
  79. package/dist/schemas/jsonRules.js.map +1 -0
  80. package/dist/schemas/layout.d.ts +1 -4
  81. package/dist/schemas/layout.d.ts.map +1 -1
  82. package/dist/schemas/layout.js +1 -13
  83. package/dist/schemas/layout.js.map +1 -1
  84. package/dist/schemas/list.d.ts +6 -3
  85. package/dist/schemas/list.d.ts.map +1 -1
  86. package/dist/schemas/list.js +3 -9
  87. package/dist/schemas/list.js.map +1 -1
  88. package/dist/schemas/resource.d.ts +144 -14
  89. package/dist/schemas/resource.d.ts.map +1 -1
  90. package/dist/schemas/resource.js +6 -1
  91. package/dist/schemas/resource.js.map +1 -1
  92. package/dist/schemas/theme.d.ts +179 -0
  93. package/dist/schemas/theme.d.ts.map +1 -0
  94. package/dist/schemas/theme.js +66 -0
  95. package/dist/schemas/theme.js.map +1 -0
  96. package/dist/search.d.ts +51 -0
  97. package/dist/search.d.ts.map +1 -0
  98. package/dist/search.js +53 -0
  99. package/dist/search.js.map +1 -0
  100. package/dist/themes.d.ts +11 -0
  101. package/dist/themes.d.ts.map +1 -0
  102. package/dist/themes.js +80 -0
  103. package/dist/themes.js.map +1 -0
  104. package/dist/transforms.d.ts +17 -0
  105. package/dist/transforms.d.ts.map +1 -0
  106. package/dist/transforms.js +34 -0
  107. package/dist/transforms.js.map +1 -0
  108. package/dist/validate.d.ts +4 -6
  109. package/dist/validate.d.ts.map +1 -1
  110. package/dist/validate.js +24 -9
  111. package/dist/validate.js.map +1 -1
  112. package/dist/values.d.ts +5 -1
  113. package/dist/values.d.ts.map +1 -1
  114. package/dist/values.js +16 -2
  115. package/dist/values.js.map +1 -1
  116. package/package.json +12 -3
  117. package/schema/boot.schema.json +580 -16
  118. package/schema/definition.schema.json +577 -16
  119. package/schema/openapi.json +1818 -543
  120. package/schema/theme.schema.json +234 -0
package/dist/rules.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"rules.js","names":[],"sources":["../src/rules.ts"],"sourcesContent":["import { evaluateCondition } from './conditions';\nimport type { Field, Rule } from './schemas/field';\nimport { PORTABLE_RULES } from './schemas/field';\nimport { getValue, isFilled, isRecord } from './values';\n\n/** A rule that a value doesn't satisfy. */\nexport interface RuleFailure {\n rule: string;\n /** The rule's parameter (`max: 120` gives `120`). */\n value?: unknown;\n /** The message set on the rule, if any. */\n message?: string;\n}\n\nexport interface CheckOptions {\n /**\n * Locales a `required` localized field must be filled in. Without it, one filled locale is\n * enough.\n */\n locales?: string[];\n /** `create` skips `updateOnly` fields; `update` skips `createOnly` fields. */\n mode?: 'create' | 'update';\n /** Only check the fields present in the values (partial updates). */\n partial?: boolean;\n}\n\ninterface Context extends CheckOptions {\n /** The whole form, for `visibleWhen` and date rules that reference other fields. */\n root: Record<string, unknown>;\n failures: Record<string, RuleFailure[]>;\n}\n\nconst EMAIL = /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/;\n\nfunction isKnownRule(rule: Rule): boolean {\n return (PORTABLE_RULES as readonly string[]).includes(rule.rule);\n}\n\nfunction failure(rule: Rule): RuleFailure {\n const result: RuleFailure = { rule: rule.rule };\n if ('value' in rule && rule.value !== undefined) {\n result.value = rule.value;\n }\n if (rule.message !== undefined) {\n result.message = rule.message;\n }\n return result;\n}\n\nfunction sizeOf(value: unknown): number | null {\n if (typeof value === 'number') {\n return value;\n }\n if (typeof value === 'string' || Array.isArray(value)) {\n return value.length;\n }\n return null;\n}\n\nfunction matchesMime(mime: string, patterns: string[]): boolean {\n return patterns.some((pattern) => {\n if (pattern.endsWith('/*')) {\n return mime.startsWith(pattern.slice(0, -1));\n }\n return mime === pattern;\n });\n}\n\nfunction mediaList(value: unknown): Record<string, unknown>[] {\n const list = Array.isArray(value) ? value : [value];\n return list.filter(isRecord);\n}\n\nfunction toTime(value: unknown): number | null {\n if (typeof value !== 'string' && typeof value !== 'number') {\n return null;\n }\n const time = new Date(value).getTime();\n return Number.isNaN(time) ? null : time;\n}\n\n/** Checks one value against a field's rules. Returns the rules that fail. */\nexport function checkRules(\n rules: Rule[],\n value: unknown,\n root: Record<string, unknown> = {},\n): RuleFailure[] {\n const failures: RuleFailure[] = [];\n const filled = isFilled(value);\n rules.filter(isKnownRule).forEach((rule) => {\n if (rule.rule === 'required') {\n if (!filled) {\n failures.push(failure(rule));\n }\n return;\n }\n if (!filled) {\n return;\n }\n let valid = true;\n switch (rule.rule) {\n case 'min':\n case 'max': {\n const size = sizeOf(value);\n const limit = rule.value as number;\n valid = size === null || (rule.rule === 'min' ? size >= limit : size <= limit);\n break;\n }\n case 'pattern':\n valid =\n typeof value !== 'string' ||\n new RegExp(rule.value as string, (rule as { flags?: string }).flags).test(\n value,\n );\n break;\n case 'email':\n valid = typeof value !== 'string' || EMAIL.test(value);\n break;\n case 'url':\n valid = typeof value !== 'string' || URL.canParse(value);\n break;\n case 'in': {\n const allowed = rule.value as unknown[];\n const values = Array.isArray(value) ? value : [value];\n valid = values.every((item) => allowed.includes(item));\n break;\n }\n case 'accept':\n valid = mediaList(value).every(\n (media) =>\n typeof media.mime !== 'string' ||\n matchesMime(media.mime, rule.value as string[]),\n );\n break;\n case 'maxSize':\n valid = mediaList(value).every(\n (media) =>\n typeof media.size !== 'number' || media.size <= (rule.value as number),\n );\n break;\n case 'before':\n case 'after': {\n const bound = rule.value as string | { field: string };\n const boundTime = toTime(\n typeof bound === 'string' ? bound : getValue(root, bound.field),\n );\n const time = toTime(value);\n if (boundTime !== null && time !== null) {\n valid = rule.rule === 'before' ? time < boundTime : time > boundTime;\n }\n break;\n }\n }\n if (!valid) {\n failures.push(failure(rule));\n }\n });\n return failures;\n}\n\nfunction addFailures(context: Context, path: string, failures: RuleFailure[]) {\n if (failures.length > 0) {\n context.failures[path] = [...(context.failures[path] ?? []), ...failures];\n }\n}\n\nfunction checkFieldValue(field: Field, value: unknown, path: string, context: Context) {\n const rules = field.rules ?? [];\n if (field.localized === true) {\n const localized = isRecord(value) ? value : {};\n const required = rules.filter((rule) => rule.rule === 'required');\n const others = rules.filter((rule) => rule.rule !== 'required');\n if (required.length > 0) {\n const locales = context.locales;\n if (locales === undefined || locales.length === 0) {\n if (!Object.values(localized).some(isFilled)) {\n addFailures(context, path, required.map(failure));\n }\n } else {\n locales.forEach((locale) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(required, localized[locale], context.root),\n );\n });\n }\n }\n Object.entries(localized).forEach(([locale, localeValue]) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(others, localeValue, context.root),\n );\n });\n return;\n }\n\n addFailures(context, path, checkRules(rules, value, context.root));\n\n if (field.type === 'group' && field.fields !== undefined && isRecord(value)) {\n checkFields(field.fields, value, `${path}.`, context);\n }\n if (field.type === 'repeater' && Array.isArray(value)) {\n value.forEach((item, index) => {\n if (!isRecord(item)) {\n return;\n }\n const blockFields =\n field.types !== undefined\n ? field.types.find((type) => type.id === item.type)?.fields\n : field.fields;\n if (blockFields !== undefined) {\n checkFields(blockFields, item, `${path}.${index}.`, context);\n }\n });\n }\n}\n\nfunction checkFields(\n fields: Field[],\n values: Record<string, unknown>,\n prefix: string,\n context: Context,\n) {\n fields.forEach((field) => {\n if (field.readOnly === true) {\n return;\n }\n if (context.mode === 'create' && field.updateOnly === true) {\n return;\n }\n if (context.mode === 'update' && field.createOnly === true) {\n return;\n }\n if (field.visibleWhen !== undefined && !evaluateCondition(field.visibleWhen, values)) {\n return;\n }\n if (context.partial === true && prefix === '' && !(field.name in values)) {\n return;\n }\n checkFieldValue(field, values[field.name], `${prefix}${field.name}`, context);\n });\n}\n\n/**\n * Checks form values against the portable rules of their fields. Returns the failures keyed by\n * the dot path of the value (`title.fr`, `blocks.2.image`), the same keys as validation errors.\n * Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.\n */\nexport function checkValues(\n fields: Field[],\n values: Record<string, unknown>,\n options: CheckOptions = {},\n): Record<string, RuleFailure[]> {\n const context: Context = { ...options, root: values, failures: {} };\n checkFields(fields, values, '', context);\n return context.failures;\n}\n"],"mappings":";;;;AAgCA,IAAM,QAAQ;AAEd,SAAS,YAAY,MAAqB;CACtC,OAAQ,eAAqC,SAAS,KAAK,IAAI;AACnE;AAEA,SAAS,QAAQ,MAAyB;CACtC,MAAM,SAAsB,EAAE,MAAM,KAAK,KAAK;CAC9C,IAAI,WAAW,QAAQ,KAAK,UAAU,KAAA,GAClC,OAAO,QAAQ,KAAK;CAExB,IAAI,KAAK,YAAY,KAAA,GACjB,OAAO,UAAU,KAAK;CAE1B,OAAO;AACX;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,UACjB,OAAO;CAEX,IAAI,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,GAChD,OAAO,MAAM;CAEjB,OAAO;AACX;AAEA,SAAS,YAAY,MAAc,UAA6B;CAC5D,OAAO,SAAS,MAAM,YAAY;EAC9B,IAAI,QAAQ,SAAS,IAAI,GACrB,OAAO,KAAK,WAAW,QAAQ,MAAM,GAAG,EAAE,CAAC;EAE/C,OAAO,SAAS;CACpB,CAAC;AACL;AAEA,SAAS,UAAU,OAA2C;CAE1D,QADa,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACtC,OAAO,QAAQ;AAC/B;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO;CAEX,MAAM,OAAO,IAAI,KAAK,KAAK,CAAC,CAAC,QAAQ;CACrC,OAAO,OAAO,MAAM,IAAI,IAAI,OAAO;AACvC;;AAGA,SAAgB,WACZ,OACA,OACA,OAAgC,CAAC,GACpB;CACb,MAAM,WAA0B,CAAC;CACjC,MAAM,SAAS,SAAS,KAAK;CAC7B,MAAM,OAAO,WAAW,CAAC,CAAC,SAAS,SAAS;EACxC,IAAI,KAAK,SAAS,YAAY;GAC1B,IAAI,CAAC,QACD,SAAS,KAAK,QAAQ,IAAI,CAAC;GAE/B;EACJ;EACA,IAAI,CAAC,QACD;EAEJ,IAAI,QAAQ;EACZ,QAAQ,KAAK,MAAb;GACI,KAAK;GACL,KAAK,OAAO;IACR,MAAM,OAAO,OAAO,KAAK;IACzB,MAAM,QAAQ,KAAK;IACnB,QAAQ,SAAS,SAAS,KAAK,SAAS,QAAQ,QAAQ,QAAQ,QAAQ;IACxE;GACJ;GACA,KAAK;IACD,QACI,OAAO,UAAU,YACjB,IAAI,OAAO,KAAK,OAAkB,KAA4B,KAAK,CAAC,CAAC,KACjE,KACJ;IACJ;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,MAAM,KAAK,KAAK;IACrD;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,IAAI,SAAS,KAAK;IACvD;GACJ,KAAK,MAAM;IACP,MAAM,UAAU,KAAK;IAErB,SADe,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACrC,OAAO,SAAS,QAAQ,SAAS,IAAI,CAAC;IACrD;GACJ;GACA,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YACtB,YAAY,MAAM,MAAM,KAAK,KAAiB,CACtD;IACA;GACJ,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YAAY,MAAM,QAAS,KAAK,KAC9D;IACA;GACJ,KAAK;GACL,KAAK,SAAS;IACV,MAAM,QAAQ,KAAK;IACnB,MAAM,YAAY,OACd,OAAO,UAAU,WAAW,QAAQ,SAAS,MAAM,MAAM,KAAK,CAClE;IACA,MAAM,OAAO,OAAO,KAAK;IACzB,IAAI,cAAc,QAAQ,SAAS,MAC/B,QAAQ,KAAK,SAAS,WAAW,OAAO,YAAY,OAAO;IAE/D;GACJ;EACJ;EACA,IAAI,CAAC,OACD,SAAS,KAAK,QAAQ,IAAI,CAAC;CAEnC,CAAC;CACD,OAAO;AACX;AAEA,SAAS,YAAY,SAAkB,MAAc,UAAyB;CAC1E,IAAI,SAAS,SAAS,GAClB,QAAQ,SAAS,QAAQ,CAAC,GAAI,QAAQ,SAAS,SAAS,CAAC,GAAI,GAAG,QAAQ;AAEhF;AAEA,SAAS,gBAAgB,OAAc,OAAgB,MAAc,SAAkB;CACnF,MAAM,QAAQ,MAAM,SAAS,CAAC;CAC9B,IAAI,MAAM,cAAc,MAAM;EAC1B,MAAM,YAAY,SAAS,KAAK,IAAI,QAAQ,CAAC;EAC7C,MAAM,WAAW,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAChE,MAAM,SAAS,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAC9D,IAAI,SAAS,SAAS,GAAG;GACrB,MAAM,UAAU,QAAQ;GACxB,IAAI,YAAY,KAAA,KAAa,QAAQ,WAAW,GACxC;QAAA,CAAC,OAAO,OAAO,SAAS,CAAC,CAAC,KAAK,QAAQ,GACvC,YAAY,SAAS,MAAM,SAAS,IAAI,OAAO,CAAC;GAAA,OAGpD,QAAQ,SAAS,WAAW;IACxB,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,UAAU,UAAU,SAAS,QAAQ,IAAI,CACxD;GACJ,CAAC;EAET;EACA,OAAO,QAAQ,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,iBAAiB;GACzD,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,QAAQ,aAAa,QAAQ,IAAI,CAChD;EACJ,CAAC;EACD;CACJ;CAEA,YAAY,SAAS,MAAM,WAAW,OAAO,OAAO,QAAQ,IAAI,CAAC;CAEjE,IAAI,MAAM,SAAS,WAAW,MAAM,WAAW,KAAA,KAAa,SAAS,KAAK,GACtE,YAAY,MAAM,QAAQ,OAAO,GAAG,KAAK,IAAI,OAAO;CAExD,IAAI,MAAM,SAAS,cAAc,MAAM,QAAQ,KAAK,GAChD,MAAM,SAAS,MAAM,UAAU;EAC3B,IAAI,CAAC,SAAS,IAAI,GACd;EAEJ,MAAM,cACF,MAAM,UAAU,KAAA,IACV,MAAM,MAAM,MAAM,SAAS,KAAK,OAAO,KAAK,IAAI,CAAC,EAAE,SACnD,MAAM;EAChB,IAAI,gBAAgB,KAAA,GAChB,YAAY,aAAa,MAAM,GAAG,KAAK,GAAG,MAAM,IAAI,OAAO;CAEnE,CAAC;AAET;AAEA,SAAS,YACL,QACA,QACA,QACA,SACF;CACE,OAAO,SAAS,UAAU;EACtB,IAAI,MAAM,aAAa,MACnB;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,MAAM,gBAAgB,KAAA,KAAa,CAAC,kBAAkB,MAAM,aAAa,MAAM,GAC/E;EAEJ,IAAI,QAAQ,YAAY,QAAQ,WAAW,MAAM,EAAE,MAAM,QAAQ,SAC7D;EAEJ,gBAAgB,OAAO,OAAO,MAAM,OAAO,GAAG,SAAS,MAAM,QAAQ,OAAO;CAChF,CAAC;AACL;;;;;;AAOA,SAAgB,YACZ,QACA,QACA,UAAwB,CAAC,GACI;CAC7B,MAAM,UAAmB;EAAE,GAAG;EAAS,MAAM;EAAQ,UAAU,CAAC;CAAE;CAClE,YAAY,QAAQ,QAAQ,IAAI,OAAO;CACvC,OAAO,QAAQ;AACnB"}
1
+ {"version":3,"file":"rules.js","names":[],"sources":["../src/rules.ts"],"sourcesContent":["import { evaluateCondition } from './conditions';\nimport { PORTABLE_RULES } from './constants';\nimport type { Field, Rule } from './schemas/field';\nimport { matchesRatio, renderedCropSize } from './transforms';\nimport { getValue, isFilled, isRecord } from './values';\n\n/** A rule that a value doesn't satisfy. */\nexport interface RuleFailure {\n rule: string;\n /** The rule's parameter (`max: 120` gives `120`). */\n value?: unknown;\n /** The message set on the rule, if any. */\n message?: string;\n}\n\nexport interface CheckOptions {\n /**\n * Locales a `required` localized field must be filled in. Without it, one filled locale is\n * enough.\n */\n locales?: string[];\n /** `create` skips `updateOnly` fields; `update` skips `createOnly` fields. */\n mode?: 'create' | 'update';\n /** Only check the fields present in the values (partial updates). */\n partial?: boolean;\n}\n\ninterface Context extends CheckOptions {\n /** The whole form, for `visibleWhen` and date rules that reference other fields. */\n root: Record<string, unknown>;\n failures: Record<string, RuleFailure[]>;\n}\n\nconst EMAIL = /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/;\n\nfunction isKnownRule(rule: Rule): boolean {\n return (PORTABLE_RULES as readonly string[]).includes(rule.rule);\n}\n\n/**\n * Whether a rule applies in a mode: a rule with a `mode` applies only in that mode, and not when the\n * mode isn't known.\n */\nfunction appliesIn(rule: Rule, mode: CheckOptions['mode']): boolean {\n return rule.mode === undefined || rule.mode === mode;\n}\n\nfunction failure(rule: Rule): RuleFailure {\n const result: RuleFailure = { rule: rule.rule };\n if ('value' in rule && rule.value !== undefined) {\n result.value = rule.value;\n }\n if (rule.message !== undefined) {\n result.message = rule.message;\n }\n return result;\n}\n\nfunction sizeOf(value: unknown): number | null {\n if (typeof value === 'number') {\n return value;\n }\n if (typeof value === 'string' || Array.isArray(value)) {\n return value.length;\n }\n return null;\n}\n\nfunction matchesMime(mime: string, patterns: string[]): boolean {\n return patterns.some((pattern) => {\n if (pattern.endsWith('/*')) {\n return mime.startsWith(pattern.slice(0, -1));\n }\n return mime === pattern;\n });\n}\n\n/** The files of a value, with their MIME type and size: stored files, or chosen ones (`File`). */\nfunction mediaList(value: unknown): Record<string, unknown>[] {\n const list = Array.isArray(value) ? value : [value];\n return list\n .filter(isRecord)\n .map((media) =>\n typeof Blob !== 'undefined' && media instanceof Blob\n ? { mime: media.type === '' ? undefined : media.type, size: media.size }\n : media,\n );\n}\n\n/**\n * Whether each image of a value has the crop the `crop` rule asks for (decision 0031): a crop when\n * it is required, and one of the ratios once rendered. An id alone has no crop.\n */\nfunction hasCrop(value: unknown, rule: { ratios?: string[]; required?: boolean }): boolean {\n const entries = Array.isArray(value) ? value : [value];\n return entries.every((entry) => {\n const transform = isRecord(entry) && isRecord(entry.transform) ? entry.transform : {};\n const size = renderedCropSize(transform);\n if (size === null) {\n return rule.required !== true;\n }\n const ratios = rule.ratios ?? [];\n return (\n ratios.length === 0 ||\n ratios.some((ratio) => matchesRatio(size.width, size.height, ratio))\n );\n });\n}\n\nfunction toTime(value: unknown): number | null {\n if (typeof value !== 'string' && typeof value !== 'number') {\n return null;\n }\n const time = new Date(value).getTime();\n return Number.isNaN(time) ? null : time;\n}\n\n/**\n * Checks one value against a field's rules. Returns the rules that fail. Rules limited to a `mode`\n * only apply when it is given.\n */\nexport function checkRules(\n rules: Rule[],\n value: unknown,\n root: Record<string, unknown> = {},\n mode?: CheckOptions['mode'],\n): RuleFailure[] {\n const failures: RuleFailure[] = [];\n const filled = isFilled(value);\n const applying = rules.filter((rule) => isKnownRule(rule) && appliesIn(rule, mode));\n applying.forEach((rule) => {\n if (rule.rule === 'required') {\n if (!filled) {\n failures.push(failure(rule));\n }\n return;\n }\n if (!filled) {\n return;\n }\n let valid = true;\n switch (rule.rule) {\n case 'min':\n case 'max': {\n const size = sizeOf(value);\n const limit = rule.value as number;\n valid = size === null || (rule.rule === 'min' ? size >= limit : size <= limit);\n break;\n }\n case 'pattern':\n valid =\n typeof value !== 'string' ||\n new RegExp(rule.value as string, (rule as { flags?: string }).flags).test(\n value,\n );\n break;\n case 'email':\n valid = typeof value !== 'string' || EMAIL.test(value);\n break;\n case 'url':\n valid = typeof value !== 'string' || URL.canParse(value);\n break;\n case 'json':\n // Text that doesn't parse stays a string in the form: only objects and arrays pass\n valid = isRecord(value) || Array.isArray(value);\n break;\n case 'in': {\n const allowed = rule.value as unknown[];\n const values = Array.isArray(value) ? value : [value];\n valid = values.every((item) => allowed.includes(item));\n break;\n }\n case 'accept':\n valid = mediaList(value).every(\n (media) =>\n typeof media.mime !== 'string' ||\n matchesMime(media.mime, rule.value as string[]),\n );\n break;\n case 'maxSize':\n valid = mediaList(value).every(\n (media) =>\n typeof media.size !== 'number' || media.size <= (rule.value as number),\n );\n break;\n case 'crop':\n valid = !isRecord(rule.value) || hasCrop(value, rule.value);\n break;\n case 'before':\n case 'after': {\n const bound = rule.value as string | { field: string };\n const boundTime = toTime(\n typeof bound === 'string' ? bound : getValue(root, bound.field),\n );\n const time = toTime(value);\n if (boundTime !== null && time !== null) {\n valid = rule.rule === 'before' ? time < boundTime : time > boundTime;\n }\n break;\n }\n }\n if (!valid) {\n failures.push(failure(rule));\n }\n });\n return failures;\n}\n\nfunction addFailures(context: Context, path: string, failures: RuleFailure[]) {\n if (failures.length > 0) {\n context.failures[path] = [...(context.failures[path] ?? []), ...failures];\n }\n}\n\n/**\n * The rules of a field that apply in the mode, with those its type implies: `json` for the `json`\n * type.\n */\nfunction rulesOf(field: Field, mode: CheckOptions['mode']): Rule[] {\n const rules = (field.rules ?? []).filter((rule) => appliesIn(rule, mode));\n return field.type === 'json' && !rules.some((rule) => rule.rule === 'json')\n ? [...rules, { rule: 'json' }]\n : rules;\n}\n\nfunction checkFieldValue(field: Field, value: unknown, path: string, context: Context) {\n const rules = rulesOf(field, context.mode);\n if (field.localized === true) {\n const localized = isRecord(value) ? value : {};\n const required = rules.filter((rule) => rule.rule === 'required');\n const others = rules.filter((rule) => rule.rule !== 'required');\n if (required.length > 0) {\n const locales = context.locales;\n if (locales === undefined || locales.length === 0) {\n if (!Object.values(localized).some(isFilled)) {\n addFailures(context, path, required.map(failure));\n }\n } else {\n locales.forEach((locale) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(required, localized[locale], context.root, context.mode),\n );\n });\n }\n }\n Object.entries(localized).forEach(([locale, localeValue]) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(others, localeValue, context.root, context.mode),\n );\n });\n return;\n }\n\n addFailures(context, path, checkRules(rules, value, context.root, context.mode));\n\n if (field.type === 'group' && field.fields !== undefined && isRecord(value)) {\n checkFields(field.fields, value, `${path}.`, context);\n }\n if (field.type === 'repeater' && Array.isArray(value)) {\n value.forEach((item, index) => {\n if (!isRecord(item)) {\n return;\n }\n const blockFields =\n field.types !== undefined\n ? field.types.find((type) => type.id === item.type)?.fields\n : field.fields;\n if (blockFields !== undefined) {\n checkFields(blockFields, item, `${path}.${index}.`, context);\n }\n });\n }\n}\n\nfunction checkFields(\n fields: Field[],\n values: Record<string, unknown>,\n prefix: string,\n context: Context,\n) {\n fields.forEach((field) => {\n if (field.readOnly === true) {\n return;\n }\n if (context.mode === 'create' && field.updateOnly === true) {\n return;\n }\n if (context.mode === 'update' && field.createOnly === true) {\n return;\n }\n if (field.visibleWhen !== undefined && !evaluateCondition(field.visibleWhen, values)) {\n return;\n }\n if (context.partial === true && prefix === '' && !(field.name in values)) {\n return;\n }\n checkFieldValue(field, values[field.name], `${prefix}${field.name}`, context);\n });\n}\n\n/**\n * Checks form values against the portable rules of their fields. Returns the failures keyed by\n * the dot path of the value (`title.fr`, `blocks.2.image`), the same keys as validation errors.\n * Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.\n */\nexport function checkValues(\n fields: Field[],\n values: Record<string, unknown>,\n options: CheckOptions = {},\n): Record<string, RuleFailure[]> {\n const context: Context = { ...options, root: values, failures: {} };\n checkFields(fields, values, '', context);\n return context.failures;\n}\n"],"mappings":";;;;;AAiCA,IAAM,QAAQ;AAEd,SAAS,YAAY,MAAqB;CACtC,OAAQ,eAAqC,SAAS,KAAK,IAAI;AACnE;;;;;AAMA,SAAS,UAAU,MAAY,MAAqC;CAChE,OAAO,KAAK,SAAS,KAAA,KAAa,KAAK,SAAS;AACpD;AAEA,SAAS,QAAQ,MAAyB;CACtC,MAAM,SAAsB,EAAE,MAAM,KAAK,KAAK;CAC9C,IAAI,WAAW,QAAQ,KAAK,UAAU,KAAA,GAClC,OAAO,QAAQ,KAAK;CAExB,IAAI,KAAK,YAAY,KAAA,GACjB,OAAO,UAAU,KAAK;CAE1B,OAAO;AACX;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,UACjB,OAAO;CAEX,IAAI,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,GAChD,OAAO,MAAM;CAEjB,OAAO;AACX;AAEA,SAAS,YAAY,MAAc,UAA6B;CAC5D,OAAO,SAAS,MAAM,YAAY;EAC9B,IAAI,QAAQ,SAAS,IAAI,GACrB,OAAO,KAAK,WAAW,QAAQ,MAAM,GAAG,EAAE,CAAC;EAE/C,OAAO,SAAS;CACpB,CAAC;AACL;;AAGA,SAAS,UAAU,OAA2C;CAE1D,QADa,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CAE7C,OAAO,QAAQ,CAAC,CAChB,KAAK,UACF,OAAO,SAAS,eAAe,iBAAiB,OAC1C;EAAE,MAAM,MAAM,SAAS,KAAK,KAAA,IAAY,MAAM;EAAM,MAAM,MAAM;CAAK,IACrE,KACV;AACR;;;;;AAMA,SAAS,QAAQ,OAAgB,MAA0D;CAEvF,QADgB,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACtC,OAAO,UAAU;EAC5B,MAAM,YAAY,SAAS,KAAK,KAAK,SAAS,MAAM,SAAS,IAAI,MAAM,YAAY,CAAC;EACpF,MAAM,OAAO,iBAAiB,SAAS;EACvC,IAAI,SAAS,MACT,OAAO,KAAK,aAAa;EAE7B,MAAM,SAAS,KAAK,UAAU,CAAC;EAC/B,OACI,OAAO,WAAW,KAClB,OAAO,MAAM,UAAU,aAAa,KAAK,OAAO,KAAK,QAAQ,KAAK,CAAC;CAE3E,CAAC;AACL;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO;CAEX,MAAM,OAAO,IAAI,KAAK,KAAK,CAAC,CAAC,QAAQ;CACrC,OAAO,OAAO,MAAM,IAAI,IAAI,OAAO;AACvC;;;;;AAMA,SAAgB,WACZ,OACA,OACA,OAAgC,CAAC,GACjC,MACa;CACb,MAAM,WAA0B,CAAC;CACjC,MAAM,SAAS,SAAS,KAAK;CAE7B,MADuB,QAAQ,SAAS,YAAY,IAAI,KAAK,UAAU,MAAM,IAAI,CACjF,CAAA,CAAS,SAAS,SAAS;EACvB,IAAI,KAAK,SAAS,YAAY;GAC1B,IAAI,CAAC,QACD,SAAS,KAAK,QAAQ,IAAI,CAAC;GAE/B;EACJ;EACA,IAAI,CAAC,QACD;EAEJ,IAAI,QAAQ;EACZ,QAAQ,KAAK,MAAb;GACI,KAAK;GACL,KAAK,OAAO;IACR,MAAM,OAAO,OAAO,KAAK;IACzB,MAAM,QAAQ,KAAK;IACnB,QAAQ,SAAS,SAAS,KAAK,SAAS,QAAQ,QAAQ,QAAQ,QAAQ;IACxE;GACJ;GACA,KAAK;IACD,QACI,OAAO,UAAU,YACjB,IAAI,OAAO,KAAK,OAAkB,KAA4B,KAAK,CAAC,CAAC,KACjE,KACJ;IACJ;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,MAAM,KAAK,KAAK;IACrD;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,IAAI,SAAS,KAAK;IACvD;GACJ,KAAK;IAED,QAAQ,SAAS,KAAK,KAAK,MAAM,QAAQ,KAAK;IAC9C;GACJ,KAAK,MAAM;IACP,MAAM,UAAU,KAAK;IAErB,SADe,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACrC,OAAO,SAAS,QAAQ,SAAS,IAAI,CAAC;IACrD;GACJ;GACA,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YACtB,YAAY,MAAM,MAAM,KAAK,KAAiB,CACtD;IACA;GACJ,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YAAY,MAAM,QAAS,KAAK,KAC9D;IACA;GACJ,KAAK;IACD,QAAQ,CAAC,SAAS,KAAK,KAAK,KAAK,QAAQ,OAAO,KAAK,KAAK;IAC1D;GACJ,KAAK;GACL,KAAK,SAAS;IACV,MAAM,QAAQ,KAAK;IACnB,MAAM,YAAY,OACd,OAAO,UAAU,WAAW,QAAQ,SAAS,MAAM,MAAM,KAAK,CAClE;IACA,MAAM,OAAO,OAAO,KAAK;IACzB,IAAI,cAAc,QAAQ,SAAS,MAC/B,QAAQ,KAAK,SAAS,WAAW,OAAO,YAAY,OAAO;IAE/D;GACJ;EACJ;EACA,IAAI,CAAC,OACD,SAAS,KAAK,QAAQ,IAAI,CAAC;CAEnC,CAAC;CACD,OAAO;AACX;AAEA,SAAS,YAAY,SAAkB,MAAc,UAAyB;CAC1E,IAAI,SAAS,SAAS,GAClB,QAAQ,SAAS,QAAQ,CAAC,GAAI,QAAQ,SAAS,SAAS,CAAC,GAAI,GAAG,QAAQ;AAEhF;;;;;AAMA,SAAS,QAAQ,OAAc,MAAoC;CAC/D,MAAM,SAAS,MAAM,SAAS,CAAC,EAAA,CAAG,QAAQ,SAAS,UAAU,MAAM,IAAI,CAAC;CACxE,OAAO,MAAM,SAAS,UAAU,CAAC,MAAM,MAAM,SAAS,KAAK,SAAS,MAAM,IACpE,CAAC,GAAG,OAAO,EAAE,MAAM,OAAO,CAAC,IAC3B;AACV;AAEA,SAAS,gBAAgB,OAAc,OAAgB,MAAc,SAAkB;CACnF,MAAM,QAAQ,QAAQ,OAAO,QAAQ,IAAI;CACzC,IAAI,MAAM,cAAc,MAAM;EAC1B,MAAM,YAAY,SAAS,KAAK,IAAI,QAAQ,CAAC;EAC7C,MAAM,WAAW,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAChE,MAAM,SAAS,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAC9D,IAAI,SAAS,SAAS,GAAG;GACrB,MAAM,UAAU,QAAQ;GACxB,IAAI,YAAY,KAAA,KAAa,QAAQ,WAAW,GACxC;QAAA,CAAC,OAAO,OAAO,SAAS,CAAC,CAAC,KAAK,QAAQ,GACvC,YAAY,SAAS,MAAM,SAAS,IAAI,OAAO,CAAC;GAAA,OAGpD,QAAQ,SAAS,WAAW;IACxB,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,UAAU,UAAU,SAAS,QAAQ,MAAM,QAAQ,IAAI,CACtE;GACJ,CAAC;EAET;EACA,OAAO,QAAQ,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,iBAAiB;GACzD,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,QAAQ,aAAa,QAAQ,MAAM,QAAQ,IAAI,CAC9D;EACJ,CAAC;EACD;CACJ;CAEA,YAAY,SAAS,MAAM,WAAW,OAAO,OAAO,QAAQ,MAAM,QAAQ,IAAI,CAAC;CAE/E,IAAI,MAAM,SAAS,WAAW,MAAM,WAAW,KAAA,KAAa,SAAS,KAAK,GACtE,YAAY,MAAM,QAAQ,OAAO,GAAG,KAAK,IAAI,OAAO;CAExD,IAAI,MAAM,SAAS,cAAc,MAAM,QAAQ,KAAK,GAChD,MAAM,SAAS,MAAM,UAAU;EAC3B,IAAI,CAAC,SAAS,IAAI,GACd;EAEJ,MAAM,cACF,MAAM,UAAU,KAAA,IACV,MAAM,MAAM,MAAM,SAAS,KAAK,OAAO,KAAK,IAAI,CAAC,EAAE,SACnD,MAAM;EAChB,IAAI,gBAAgB,KAAA,GAChB,YAAY,aAAa,MAAM,GAAG,KAAK,GAAG,MAAM,IAAI,OAAO;CAEnE,CAAC;AAET;AAEA,SAAS,YACL,QACA,QACA,QACA,SACF;CACE,OAAO,SAAS,UAAU;EACtB,IAAI,MAAM,aAAa,MACnB;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,MAAM,gBAAgB,KAAA,KAAa,CAAC,kBAAkB,MAAM,aAAa,MAAM,GAC/E;EAEJ,IAAI,QAAQ,YAAY,QAAQ,WAAW,MAAM,EAAE,MAAM,QAAQ,SAC7D;EAEJ,gBAAgB,OAAO,OAAO,MAAM,OAAO,GAAG,SAAS,MAAM,QAAQ,OAAO;CAChF,CAAC;AACL;;;;;;AAOA,SAAgB,YACZ,QACA,QACA,UAAwB,CAAC,GACI;CAC7B,MAAM,UAAmB;EAAE,GAAG;EAAS,MAAM;EAAQ,UAAU,CAAC;CAAE;CAClE,YAAY,QAAQ,QAAQ,IAAI,OAAO;CACvC,OAAO,QAAQ;AACnB"}
@@ -0,0 +1,14 @@
1
+ export { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from '../version.js';
2
+ export * from '../constants.js';
3
+ export { type CheckOptions, type RuleFailure, checkRules, checkValues } from '../rules.js';
4
+ export { evaluateCondition } from '../conditions.js';
5
+ export { getMediaLibraries, type MediaLibrariesDefinition } from '../libraries.js';
6
+ export { matchesRatio, parseRatio, renderedCropSize } from '../transforms.js';
7
+ export { lintDefinition } from '../lint.js';
8
+ export type { ValidationIssue } from '../validate.js';
9
+ export { type FilterRange, type FilterValue, type CursorPageMeta, type ListQuery, isCursorPage, fromSearchParams, isFilterRange, matchesFilterRange, toSearchParams, } from '../query.js';
10
+ export { type ReadSearchQueryResult, type SearchQuery, type SearchableResource, SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, isSearchableResource, readSearchQuery, toSearchQueryParams, } from '../search.js';
11
+ export { getValue, isFilled } from '../values.js';
12
+ export { isProblem } from '../problem.js';
13
+ export { type PartialTheme, mergeThemes } from '../themes.js';
14
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACpE,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,KAAK,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,cAAc,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EACH,KAAK,qBAAqB,EAC1B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,mBAAmB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC"}
@@ -0,0 +1,13 @@
1
+ import { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from "../version.js";
2
+ import { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_ITEM_ACTIONS, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LINK_ACTIONS, BUILT_IN_LIST_LAYOUTS, ITEM_ACTION_ABILITIES, PORTABLE_RULES, RICH_TEXT_STYLE_ELEMENTS, isBuiltInItemAction, isBuiltInLink } from "../constants.js";
3
+ import { getValue, isFilled } from "../values.js";
4
+ import { evaluateCondition } from "../conditions.js";
5
+ import { matchesRatio, parseRatio, renderedCropSize } from "../transforms.js";
6
+ import { checkRules, checkValues } from "../rules.js";
7
+ import { getMediaLibraries } from "../libraries.js";
8
+ import { lintDefinition } from "../lint.js";
9
+ import { fromSearchParams, isCursorPage, isFilterRange, matchesFilterRange, toSearchParams } from "../query.js";
10
+ import { SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, isSearchableResource, readSearchQuery, toSearchQueryParams } from "../search.js";
11
+ import { isProblem } from "../problem.js";
12
+ import { mergeThemes } from "../themes.js";
13
+ export { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_ITEM_ACTIONS, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LINK_ACTIONS, BUILT_IN_LIST_LAYOUTS, ITEM_ACTION_ABILITIES, PORTABLE_RULES, PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION, RICH_TEXT_STYLE_ELEMENTS, SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, checkRules, checkValues, evaluateCondition, fromSearchParams, getMediaLibraries, getValue, isBuiltInItemAction, isBuiltInLink, isCursorPage, isFilled, isFilterRange, isProblem, isSearchableResource, lintDefinition, matchesFilterRange, matchesRatio, mergeThemes, parseRatio, readSearchQuery, renderedCropSize, toSearchParams, toSearchQueryParams };
@@ -1,8 +1,6 @@
1
1
  import { z } from 'zod';
2
- import { Field } from './field';
3
- import { LayoutNode } from './layout';
4
- /** Built-in action ids. */
5
- export declare const BUILT_IN_ACTIONS: readonly ["show", "edit", "duplicate", "delete", "restore", "export", "import"];
2
+ import { Field } from './field.js';
3
+ import { LayoutNode } from './layout.js';
6
4
  export declare const ActionScope: z.ZodEnum<{
7
5
  resource: "resource";
8
6
  item: "item";
@@ -22,12 +20,12 @@ export declare const ActionConfirm: z.ZodUnion<readonly [z.ZodBoolean, z.ZodObje
22
20
  }, z.core.$loose>]>;
23
21
  export declare const Action: z.ZodObject<{
24
22
  id: z.ZodString;
25
- label: z.ZodString;
23
+ label: z.ZodOptional<z.ZodString>;
26
24
  icon: z.ZodOptional<z.ZodString>;
27
25
  kind: z.ZodDefault<z.ZodEnum<{
28
26
  link: "link";
29
- server: "server";
30
27
  client: "client";
28
+ server: "server";
31
29
  }>>;
32
30
  scope: z.ZodArray<z.ZodEnum<{
33
31
  resource: "resource";
@@ -61,6 +59,10 @@ export declare const Action: z.ZodObject<{
61
59
  rules: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
62
60
  rule: z.ZodLiteral<"required">;
63
61
  message: z.ZodOptional<z.ZodString>;
62
+ mode: z.ZodOptional<z.ZodEnum<{
63
+ update: "update";
64
+ create: "create";
65
+ }>>;
64
66
  }, z.core.$loose>, z.ZodObject<{
65
67
  rule: z.ZodEnum<{
66
68
  min: "min";
@@ -68,29 +70,54 @@ export declare const Action: z.ZodObject<{
68
70
  }>;
69
71
  value: z.ZodNumber;
70
72
  message: z.ZodOptional<z.ZodString>;
73
+ mode: z.ZodOptional<z.ZodEnum<{
74
+ update: "update";
75
+ create: "create";
76
+ }>>;
71
77
  }, z.core.$loose>, z.ZodObject<{
72
78
  rule: z.ZodLiteral<"pattern">;
73
79
  value: z.ZodString;
74
80
  flags: z.ZodOptional<z.ZodString>;
75
81
  message: z.ZodOptional<z.ZodString>;
82
+ mode: z.ZodOptional<z.ZodEnum<{
83
+ update: "update";
84
+ create: "create";
85
+ }>>;
76
86
  }, z.core.$loose>, z.ZodObject<{
77
87
  rule: z.ZodEnum<{
78
88
  email: "email";
79
89
  url: "url";
90
+ json: "json";
80
91
  }>;
81
92
  message: z.ZodOptional<z.ZodString>;
93
+ mode: z.ZodOptional<z.ZodEnum<{
94
+ update: "update";
95
+ create: "create";
96
+ }>>;
82
97
  }, z.core.$loose>, z.ZodObject<{
83
98
  rule: z.ZodLiteral<"in">;
84
99
  value: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
85
100
  message: z.ZodOptional<z.ZodString>;
101
+ mode: z.ZodOptional<z.ZodEnum<{
102
+ update: "update";
103
+ create: "create";
104
+ }>>;
86
105
  }, z.core.$loose>, z.ZodObject<{
87
106
  rule: z.ZodLiteral<"accept">;
88
107
  value: z.ZodArray<z.ZodString>;
89
108
  message: z.ZodOptional<z.ZodString>;
109
+ mode: z.ZodOptional<z.ZodEnum<{
110
+ update: "update";
111
+ create: "create";
112
+ }>>;
90
113
  }, z.core.$loose>, z.ZodObject<{
91
114
  rule: z.ZodLiteral<"maxSize">;
92
115
  value: z.ZodNumber;
93
116
  message: z.ZodOptional<z.ZodString>;
117
+ mode: z.ZodOptional<z.ZodEnum<{
118
+ update: "update";
119
+ create: "create";
120
+ }>>;
94
121
  }, z.core.$loose>, z.ZodObject<{
95
122
  rule: z.ZodEnum<{
96
123
  before: "before";
@@ -100,9 +127,28 @@ export declare const Action: z.ZodObject<{
100
127
  field: z.ZodString;
101
128
  }, z.core.$loose>]>;
102
129
  message: z.ZodOptional<z.ZodString>;
130
+ mode: z.ZodOptional<z.ZodEnum<{
131
+ update: "update";
132
+ create: "create";
133
+ }>>;
134
+ }, z.core.$loose>, z.ZodObject<{
135
+ rule: z.ZodLiteral<"crop">;
136
+ value: z.ZodObject<{
137
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
138
+ required: z.ZodOptional<z.ZodBoolean>;
139
+ }, z.core.$loose>;
140
+ message: z.ZodOptional<z.ZodString>;
141
+ mode: z.ZodOptional<z.ZodEnum<{
142
+ update: "update";
143
+ create: "create";
144
+ }>>;
103
145
  }, z.core.$loose>, z.ZodObject<{
104
146
  rule: z.ZodString;
105
147
  message: z.ZodOptional<z.ZodString>;
148
+ mode: z.ZodOptional<z.ZodEnum<{
149
+ update: "update";
150
+ create: "create";
151
+ }>>;
106
152
  }, z.core.$loose>]>>>;
107
153
  visibleWhen: z.ZodOptional<z.ZodObject<{
108
154
  field: z.ZodOptional<z.ZodString>;
@@ -110,22 +156,32 @@ export declare const Action: z.ZodObject<{
110
156
  in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
111
157
  notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
112
158
  filled: z.ZodOptional<z.ZodBoolean>;
113
- all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
114
- any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
159
+ all: z.ZodOptional<z.ZodArray<typeof import("./common.js").Condition>>;
160
+ any: z.ZodOptional<z.ZodArray<typeof import("./common.js").Condition>>;
115
161
  }, z.core.$loose>>;
116
162
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
117
163
  value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
118
164
  label: z.ZodString;
119
165
  description: z.ZodOptional<z.ZodString>;
120
166
  disabled: z.ZodOptional<z.ZodBoolean>;
167
+ tone: z.ZodOptional<z.ZodString>;
121
168
  }, z.core.$loose>>>;
122
169
  multiple: z.ZodOptional<z.ZodBoolean>;
123
- resource: z.ZodOptional<z.ZodString>;
170
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
124
171
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
172
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
173
+ rotate: z.ZodOptional<z.ZodBoolean>;
174
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
175
+ transformBase: z.ZodOptional<z.ZodEnum<{
176
+ media: "media";
177
+ original: "original";
178
+ choose: "choose";
179
+ }>>;
125
180
  from: z.ZodOptional<z.ZodString>;
181
+ check: z.ZodOptional<z.ZodBoolean>;
126
182
  display: z.ZodOptional<z.ZodString>;
127
183
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
128
- types: z.ZodOptional<z.ZodArray<typeof import("./field").BlockType>>;
184
+ types: z.ZodOptional<z.ZodArray<typeof import("./field.js").BlockType>>;
129
185
  settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
130
186
  }, z.core.$loose>>>;
131
187
  layout: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -145,18 +201,18 @@ export declare const Action: z.ZodObject<{
145
201
  in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
146
202
  notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
147
203
  filled: z.ZodOptional<z.ZodBoolean>;
148
- all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
149
- any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
204
+ all: z.ZodOptional<z.ZodArray<typeof import("./common.js").Condition>>;
205
+ any: z.ZodOptional<z.ZodArray<typeof import("./common.js").Condition>>;
150
206
  }, z.core.$loose>>;
151
207
  children: z.ZodOptional<z.ZodArray<typeof LayoutNode>>;
152
208
  }, z.core.$loose>>>;
153
209
  queued: z.ZodOptional<z.ZodBoolean>;
210
+ dryRun: z.ZodOptional<z.ZodBoolean>;
154
211
  url: z.ZodOptional<z.ZodString>;
155
212
  route: z.ZodOptional<z.ZodString>;
156
213
  component: z.ZodOptional<z.ZodString>;
157
214
  abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
158
215
  }, z.core.$loose>;
159
- export type BuiltInAction = (typeof BUILT_IN_ACTIONS)[number];
160
216
  export type ActionScope = z.infer<typeof ActionScope>;
161
217
  export type ActionPlacement = z.infer<typeof ActionPlacement>;
162
218
  export type ActionConfirm = z.infer<typeof ActionConfirm>;
@@ -1 +1 @@
1
- {"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/schemas/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,2BAA2B;AAC3B,eAAO,MAAM,gBAAgB,iFAQnB,CAAC;AAEX,eAAO,MAAM,WAAW;;;;EAA4C,CAAC;AAErE,eAAO,MAAM,eAAe;;;;;EAA6C,CAAC;AAE1E,eAAO,MAAM,aAAa;;;;;mBAWxB,CAAC;AAEH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2CwE,CAAC;AAE5F,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9D,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AACtD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAC1D,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAC5C,qEAAqE;AACrE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC"}
1
+ {"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/schemas/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,eAAO,MAAM,WAAW;;;;EAA4C,CAAC;AAErE,eAAO,MAAM,eAAe;;;;;EAA6C,CAAC;AAE1E,eAAO,MAAM,aAAa;;;;;mBAWxB,CAAC;AAEH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyEb,CAAC;AAEP,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AACtD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAC1D,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAC5C,qEAAqE;AACrE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC"}
@@ -1,18 +1,10 @@
1
+ import { isBuiltInItemAction, isBuiltInLink } from "../constants.js";
1
2
  import { Abilities } from "./common.js";
2
3
  import { Field } from "./field.js";
4
+ import { actionJsonRules } from "./jsonRules.js";
3
5
  import { LayoutNode } from "./layout.js";
4
6
  import { z } from "zod";
5
7
  //#region src/schemas/action.ts
6
- /** Built-in action ids. */
7
- var BUILT_IN_ACTIONS = [
8
- "show",
9
- "edit",
10
- "duplicate",
11
- "delete",
12
- "restore",
13
- "export",
14
- "import"
15
- ];
16
8
  var ActionScope = z.enum([
17
9
  "item",
18
10
  "selection",
@@ -32,7 +24,7 @@ var ActionConfirm = z.union([z.boolean(), z.looseObject({
32
24
  })]);
33
25
  var Action = z.looseObject({
34
26
  id: z.string().min(1),
35
- label: z.string(),
27
+ label: z.string().optional().meta({ description: "Required, except for the built-in item actions (`show`, `edit`, `duplicate`, `delete`), which the client labels in its locale." }),
36
28
  icon: z.string().optional(),
37
29
  kind: z.enum([
38
30
  "server",
@@ -46,12 +38,24 @@ var Action = z.looseObject({
46
38
  fields: z.array(Field).optional().meta({ description: "Parameters, shown in a modal." }),
47
39
  layout: z.array(LayoutNode).optional(),
48
40
  queued: z.boolean().optional().meta({ description: "The action always answers `202` with a run." }),
41
+ dryRun: z.boolean().optional().meta({ description: "The backend answers dry runs of this action (`dryRun` in the request): lists ask it how many items of a query selection will be skipped. Without it, the UI never sends `dryRun`, since a backend that ignores it would run the action." }),
49
42
  url: z.string().optional().meta({ description: "`link`: URL template, with `{id}` for the item." }),
50
43
  route: z.string().optional().meta({ description: "`link`: name of a route in the definition." }),
51
44
  component: z.string().optional().meta({ description: "`client`: the plugin handler." }),
52
45
  abilities: Abilities.optional().meta({ description: "`run`: whether the current user can run the action on the resource." })
53
46
  }).superRefine((action, context) => {
54
- if (action.kind === "link" && action.url === void 0 && action.route === void 0) context.addIssue({
47
+ const builtInLink = isBuiltInLink(action.id);
48
+ if (builtInLink && action.kind !== "link") context.addIssue({
49
+ code: "custom",
50
+ path: ["kind"],
51
+ message: `The id \`${action.id}\` is reserved for the built-in link: its \`kind\` must be \`link\`.`
52
+ });
53
+ if (action.label === void 0 && !isBuiltInItemAction(action.id)) context.addIssue({
54
+ code: "custom",
55
+ path: ["label"],
56
+ message: "An action needs a `label`."
57
+ });
58
+ if (action.kind === "link" && action.url === void 0 && action.route === void 0 && !builtInLink) context.addIssue({
55
59
  code: "custom",
56
60
  message: "A `link` action needs a `url` or a `route`."
57
61
  });
@@ -59,8 +63,11 @@ var Action = z.looseObject({
59
63
  code: "custom",
60
64
  message: "A `client` action needs a `component`."
61
65
  });
62
- }).meta({ description: "An operation on one item, a selection, or the whole resource." });
66
+ }).meta({
67
+ description: "An operation on one item, a selection, or the whole resource.",
68
+ ...actionJsonRules
69
+ });
63
70
  //#endregion
64
- export { Action, ActionConfirm, ActionPlacement, ActionScope, BUILT_IN_ACTIONS };
71
+ export { Action, ActionConfirm, ActionPlacement, ActionScope };
65
72
 
66
73
  //# sourceMappingURL=action.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"action.js","names":[],"sources":["../../src/schemas/action.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { Abilities } from './common';\nimport { Field } from './field';\nimport { LayoutNode } from './layout';\n\n/** Built-in action ids. */\nexport const BUILT_IN_ACTIONS = [\n 'show',\n 'edit',\n 'duplicate',\n 'delete',\n 'restore',\n 'export',\n 'import',\n] as const;\n\nexport const ActionScope = z.enum(['item', 'selection', 'resource']);\n\nexport const ActionPlacement = z.enum(['row', 'toolbar', 'form', 'menu']);\n\nexport const ActionConfirm = z.union([\n z.boolean(),\n z.looseObject({\n title: z.string().optional(),\n message: z\n .string()\n .optional()\n .meta({ description: 'ICU message. `{count}` is the number of items.' }),\n confirmLabel: z.string().optional(),\n cancelLabel: z.string().optional(),\n }),\n]);\n\nexport const Action = z\n .looseObject({\n id: z.string().min(1),\n label: z.string(),\n icon: z.string().optional(),\n kind: z.enum(['server', 'link', 'client']).default('server').meta({\n description:\n '`server` calls the action endpoint; `link` navigates; `client` runs a plugin handler.',\n }),\n scope: z.array(ActionScope).min(1),\n placement: z.array(ActionPlacement).optional(),\n destructive: z.boolean().optional(),\n confirm: ActionConfirm.optional(),\n fields: z.array(Field).optional().meta({ description: 'Parameters, shown in a modal.' }),\n layout: z.array(LayoutNode).optional(),\n queued: z\n .boolean()\n .optional()\n .meta({ description: 'The action always answers `202` with a run.' }),\n url: z\n .string()\n .optional()\n .meta({ description: '`link`: URL template, with `{id}` for the item.' }),\n route: z\n .string()\n .optional()\n .meta({ description: '`link`: name of a route in the definition.' }),\n component: z.string().optional().meta({ description: '`client`: the plugin handler.' }),\n abilities: Abilities.optional().meta({\n description: '`run`: whether the current user can run the action on the resource.',\n }),\n })\n .superRefine((action, context) => {\n if (action.kind === 'link' && action.url === undefined && action.route === undefined) {\n context.addIssue({\n code: 'custom',\n message: 'A `link` action needs a `url` or a `route`.',\n });\n }\n if (action.kind === 'client' && action.component === undefined) {\n context.addIssue({ code: 'custom', message: 'A `client` action needs a `component`.' });\n }\n })\n .meta({ description: 'An operation on one item, a selection, or the whole resource.' });\n\nexport type BuiltInAction = (typeof BUILT_IN_ACTIONS)[number];\nexport type ActionScope = z.infer<typeof ActionScope>;\nexport type ActionPlacement = z.infer<typeof ActionPlacement>;\nexport type ActionConfirm = z.infer<typeof ActionConfirm>;\nexport type Action = z.infer<typeof Action>;\n/** An action as a backend writes it: `kind` defaults to `server`. */\nexport type ActionInput = z.input<typeof Action>;\n"],"mappings":";;;;;;AAOA,IAAa,mBAAmB;CAC5B;CACA;CACA;CACA;CACA;CACA;CACA;AACJ;AAEA,IAAa,cAAc,EAAE,KAAK;CAAC;CAAQ;CAAa;AAAU,CAAC;AAEnE,IAAa,kBAAkB,EAAE,KAAK;CAAC;CAAO;CAAW;CAAQ;AAAM,CAAC;AAExE,IAAa,gBAAgB,EAAE,MAAM,CACjC,EAAE,QAAQ,GACV,EAAE,YAAY;CACV,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,SAAS,EACJ,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,iDAAiD,CAAC;CAC3E,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS;CAClC,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;AACrC,CAAC,CACL,CAAC;AAED,IAAa,SAAS,EACjB,YAAY;CACT,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,OAAO,EAAE,OAAO;CAChB,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,MAAM,EAAE,KAAK;EAAC;EAAU;EAAQ;CAAQ,CAAC,CAAC,CAAC,QAAQ,QAAQ,CAAC,CAAC,KAAK,EAC9D,aACI,wFACR,CAAC;CACD,OAAO,EAAE,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC;CACjC,WAAW,EAAE,MAAM,eAAe,CAAC,CAAC,SAAS;CAC7C,aAAa,EAAE,QAAQ,CAAC,CAAC,SAAS;CAClC,SAAS,cAAc,SAAS;CAChC,QAAQ,EAAE,MAAM,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,gCAAgC,CAAC;CACvF,QAAQ,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CACrC,QAAQ,EACH,QAAQ,CAAC,CACT,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,8CAA8C,CAAC;CACxE,KAAK,EACA,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,kDAAkD,CAAC;CAC5E,OAAO,EACF,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,6CAA6C,CAAC;CACvE,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,gCAAgC,CAAC;CACtF,WAAW,UAAU,SAAS,CAAC,CAAC,KAAK,EACjC,aAAa,sEACjB,CAAC;AACL,CAAC,CAAC,CACD,aAAa,QAAQ,YAAY;CAC9B,IAAI,OAAO,SAAS,UAAU,OAAO,QAAQ,KAAA,KAAa,OAAO,UAAU,KAAA,GACvE,QAAQ,SAAS;EACb,MAAM;EACN,SAAS;CACb,CAAC;CAEL,IAAI,OAAO,SAAS,YAAY,OAAO,cAAc,KAAA,GACjD,QAAQ,SAAS;EAAE,MAAM;EAAU,SAAS;CAAyC,CAAC;AAE9F,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,gEAAgE,CAAC"}
1
+ {"version":3,"file":"action.js","names":[],"sources":["../../src/schemas/action.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { isBuiltInItemAction, isBuiltInLink } from '../constants';\nimport { Abilities } from './common';\nimport { Field } from './field';\nimport { actionJsonRules } from './jsonRules';\nimport { LayoutNode } from './layout';\n\nexport const ActionScope = z.enum(['item', 'selection', 'resource']);\n\nexport const ActionPlacement = z.enum(['row', 'toolbar', 'form', 'menu']);\n\nexport const ActionConfirm = z.union([\n z.boolean(),\n z.looseObject({\n title: z.string().optional(),\n message: z\n .string()\n .optional()\n .meta({ description: 'ICU message. `{count}` is the number of items.' }),\n confirmLabel: z.string().optional(),\n cancelLabel: z.string().optional(),\n }),\n]);\n\nexport const Action = z\n .looseObject({\n id: z.string().min(1),\n label: z.string().optional().meta({\n description:\n 'Required, except for the built-in item actions (`show`, `edit`, `duplicate`, `delete`), which the client labels in its locale.',\n }),\n icon: z.string().optional(),\n kind: z.enum(['server', 'link', 'client']).default('server').meta({\n description:\n '`server` calls the action endpoint; `link` navigates; `client` runs a plugin handler.',\n }),\n scope: z.array(ActionScope).min(1),\n placement: z.array(ActionPlacement).optional(),\n destructive: z.boolean().optional(),\n confirm: ActionConfirm.optional(),\n fields: z.array(Field).optional().meta({ description: 'Parameters, shown in a modal.' }),\n layout: z.array(LayoutNode).optional(),\n queued: z\n .boolean()\n .optional()\n .meta({ description: 'The action always answers `202` with a run.' }),\n dryRun: z.boolean().optional().meta({\n description:\n 'The backend answers dry runs of this action (`dryRun` in the request): lists ask it how many items of a query selection will be skipped. Without it, the UI never sends `dryRun`, since a backend that ignores it would run the action.',\n }),\n url: z\n .string()\n .optional()\n .meta({ description: '`link`: URL template, with `{id}` for the item.' }),\n route: z\n .string()\n .optional()\n .meta({ description: '`link`: name of a route in the definition.' }),\n component: z.string().optional().meta({ description: '`client`: the plugin handler.' }),\n abilities: Abilities.optional().meta({\n description: '`run`: whether the current user can run the action on the resource.',\n }),\n })\n .superRefine((action, context) => {\n const builtInLink = isBuiltInLink(action.id);\n if (builtInLink && action.kind !== 'link') {\n context.addIssue({\n code: 'custom',\n path: ['kind'],\n message: `The id \\`${action.id}\\` is reserved for the built-in link: its \\`kind\\` must be \\`link\\`.`,\n });\n }\n if (action.label === undefined && !isBuiltInItemAction(action.id)) {\n context.addIssue({\n code: 'custom',\n path: ['label'],\n message: 'An action needs a `label`.',\n });\n }\n if (\n action.kind === 'link' &&\n action.url === undefined &&\n action.route === undefined &&\n !builtInLink\n ) {\n context.addIssue({\n code: 'custom',\n message: 'A `link` action needs a `url` or a `route`.',\n });\n }\n if (action.kind === 'client' && action.component === undefined) {\n context.addIssue({ code: 'custom', message: 'A `client` action needs a `component`.' });\n }\n })\n .meta({\n description: 'An operation on one item, a selection, or the whole resource.',\n ...actionJsonRules,\n });\n\nexport type ActionScope = z.infer<typeof ActionScope>;\nexport type ActionPlacement = z.infer<typeof ActionPlacement>;\nexport type ActionConfirm = z.infer<typeof ActionConfirm>;\nexport type Action = z.infer<typeof Action>;\n/** An action as a backend writes it: `kind` defaults to `server`. */\nexport type ActionInput = z.input<typeof Action>;\n"],"mappings":";;;;;;;AAQA,IAAa,cAAc,EAAE,KAAK;CAAC;CAAQ;CAAa;AAAU,CAAC;AAEnE,IAAa,kBAAkB,EAAE,KAAK;CAAC;CAAO;CAAW;CAAQ;AAAM,CAAC;AAExE,IAAa,gBAAgB,EAAE,MAAM,CACjC,EAAE,QAAQ,GACV,EAAE,YAAY;CACV,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,SAAS,EACJ,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,iDAAiD,CAAC;CAC3E,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS;CAClC,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;AACrC,CAAC,CACL,CAAC;AAED,IAAa,SAAS,EACjB,YAAY;CACT,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAC9B,aACI,iIACR,CAAC;CACD,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,MAAM,EAAE,KAAK;EAAC;EAAU;EAAQ;CAAQ,CAAC,CAAC,CAAC,QAAQ,QAAQ,CAAC,CAAC,KAAK,EAC9D,aACI,wFACR,CAAC;CACD,OAAO,EAAE,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC;CACjC,WAAW,EAAE,MAAM,eAAe,CAAC,CAAC,SAAS;CAC7C,aAAa,EAAE,QAAQ,CAAC,CAAC,SAAS;CAClC,SAAS,cAAc,SAAS;CAChC,QAAQ,EAAE,MAAM,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,gCAAgC,CAAC;CACvF,QAAQ,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CACrC,QAAQ,EACH,QAAQ,CAAC,CACT,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,8CAA8C,CAAC;CACxE,QAAQ,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAChC,aACI,0OACR,CAAC;CACD,KAAK,EACA,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,kDAAkD,CAAC;CAC5E,OAAO,EACF,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,6CAA6C,CAAC;CACvE,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,gCAAgC,CAAC;CACtF,WAAW,UAAU,SAAS,CAAC,CAAC,KAAK,EACjC,aAAa,sEACjB,CAAC;AACL,CAAC,CAAC,CACD,aAAa,QAAQ,YAAY;CAC9B,MAAM,cAAc,cAAc,OAAO,EAAE;CAC3C,IAAI,eAAe,OAAO,SAAS,QAC/B,QAAQ,SAAS;EACb,MAAM;EACN,MAAM,CAAC,MAAM;EACb,SAAS,YAAY,OAAO,GAAG;CACnC,CAAC;CAEL,IAAI,OAAO,UAAU,KAAA,KAAa,CAAC,oBAAoB,OAAO,EAAE,GAC5D,QAAQ,SAAS;EACb,MAAM;EACN,MAAM,CAAC,OAAO;EACd,SAAS;CACb,CAAC;CAEL,IACI,OAAO,SAAS,UAChB,OAAO,QAAQ,KAAA,KACf,OAAO,UAAU,KAAA,KACjB,CAAC,aAED,QAAQ,SAAS;EACb,MAAM;EACN,SAAS;CACb,CAAC;CAEL,IAAI,OAAO,SAAS,YAAY,OAAO,cAAc,KAAA,GACjD,QAAQ,SAAS;EAAE,MAAM;EAAU,SAAS;CAAyC,CAAC;AAE9F,CAAC,CAAC,CACD,KAAK;CACF,aAAa;CACb,GAAG;AACP,CAAC"}