@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
@@ -0,0 +1 @@
1
+ {"version":3,"file":"theme.js","names":[],"sources":["../../src/schemas/theme.ts"],"sourcesContent":["import { z } from 'zod';\n\n/** Names of tones, palette colors, components and variants: they become CSS class names. */\nconst Name = z.string().regex(/^[a-z0-9-]+$/);\n\nexport const ThemeTokens = z\n .record(z.string().regex(/^[a-zA-Z0-9_-]+$/), z.string().regex(/^[^{};<]*$/))\n .meta({\n description:\n 'CSS variables without the leading `--`, and their values: `{ \"panneau-color-accent\": \"#05f\" }`. Values cannot contain `{`, `}`, `;` or `<`.',\n });\n\nexport const ToneValues = z.looseObject({\n text: z.string().meta({ description: 'Text and icons on surfaces.' }),\n subtle: z.string().meta({ description: 'Background of the subtle appearance.' }),\n border: z.string().meta({ description: 'Border of the subtle appearance.' }),\n outline: z.string().meta({ description: 'Border of the outline appearance.' }),\n solid: z.string().meta({ description: 'Background of the solid appearance.' }),\n solidHover: z.string().meta({ description: 'Background of the solid appearance on hover.' }),\n solidText: z.string().meta({ description: 'Text on the solid appearance.' }),\n});\n\nexport const ToneInput = z\n .union([\n z.string().meta({ description: 'One color, from which Panneau derives the others.' }),\n ToneValues.extend({ dark: ToneValues.partial().optional() }),\n ])\n .meta({ description: 'A tone: one color, or every value with dark scheme overrides.' });\n\nexport const ThemeFontFace = z\n .looseObject({\n family: z.string().regex(/^[^{}<;\"\\\\]+$/),\n src: z\n .string()\n .regex(/^[^{}<]+$/)\n .meta({\n description: \"The `src` descriptor: `url(/fonts/geist.woff2) format('woff2')`.\",\n }),\n weight: z\n .string()\n .regex(/^[^{}<;]*$/)\n .optional(),\n style: z\n .string()\n .regex(/^[^{}<;]*$/)\n .optional(),\n display: z.enum(['auto', 'block', 'swap', 'fallback', 'optional']).optional(),\n unicodeRange: z\n .string()\n .regex(/^[^{}<;]*$/)\n .optional(),\n })\n .meta({ description: 'A font face, written as an `@font-face` rule.' });\n\nexport const ThemeFontStylesheet = z\n .looseObject({ stylesheet: z.string().min(1) })\n .meta({ description: 'A hosted stylesheet that declares font faces.' });\n\nexport const ThemeFont = z.union([ThemeFontFace, ThemeFontStylesheet]);\n\nconst themeShape = {\n label: z.string().optional(),\n tokens: ThemeTokens.meta({\n description:\n 'Tokens of the light scheme, or of both schemes when `dark` does not set them.',\n }),\n dark: ThemeTokens.optional().meta({ description: 'Tokens that change in the dark scheme.' }),\n palette: z\n .record(Name, z.string().regex(/^[^{};<]*$/))\n .optional()\n .meta({\n description:\n 'Raw colors, written as `--panneau-palette-<name>`: tokens and tones use them with `var(--panneau-palette-<name>)`.',\n }),\n tones: z.record(Name, ToneInput).optional().meta({\n description: 'Tones added or redefined by the theme, applied by `panneau-tone-<name>`.',\n }),\n components: z\n .record(Name, z.looseObject({ variants: z.record(Name, ThemeTokens).optional() }))\n .optional()\n .meta({\n description:\n 'Named variants of components: tokens applied by `panneau-<component>-variant-<name>`.',\n }),\n densities: z\n .looseObject({\n compact: ThemeTokens.optional(),\n comfortable: ThemeTokens.optional(),\n touch: ThemeTokens.optional(),\n })\n .optional()\n .meta({\n description:\n 'Tokens of each density (`panneau-control-height`…), which change with the density of the root.',\n }),\n fonts: z.array(ThemeFont).optional().meta({\n description: 'Font faces and font stylesheets, added to the page once.',\n }),\n};\n\nexport const Theme = z\n .looseObject(themeShape)\n .meta({ description: 'A theme of `@panneau/ui`, as plain data (decision 0024).' });\n\nexport const DefinitionTheme = z\n .looseObject({\n ...themeShape,\n tokens: themeShape.tokens.optional(),\n colorScheme: z.enum(['light', 'dark', 'auto']).optional(),\n density: z.enum(['compact', 'comfortable', 'touch', 'auto']).optional(),\n extends: z\n .union([z.string(), z.array(z.string())])\n .optional()\n .meta({\n description:\n 'Themes registered by plugins, by id, that this theme builds on, in order: its own values override theirs.',\n }),\n })\n .meta({ description: 'The theme of the admin: a theme, built on themes of plugins.' });\n\nexport type ThemeTokens = z.infer<typeof ThemeTokens>;\nexport type ToneValues = z.infer<typeof ToneValues>;\nexport type ToneInput = z.infer<typeof ToneInput>;\nexport type Theme = z.infer<typeof Theme>;\nexport type DefinitionTheme = z.infer<typeof DefinitionTheme>;\nexport type ThemeFontFace = z.infer<typeof ThemeFontFace>;\nexport type ThemeFontStylesheet = z.infer<typeof ThemeFontStylesheet>;\nexport type ThemeFont = z.infer<typeof ThemeFont>;\n"],"mappings":";;;AAGA,IAAM,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,cAAc;AAE5C,IAAa,cAAc,EACtB,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,kBAAkB,GAAG,EAAE,OAAO,CAAC,CAAC,MAAM,YAAY,CAAC,CAAC,CAC5E,KAAK,EACF,aACI,kJACR,CAAC;AAEL,IAAa,aAAa,EAAE,YAAY;CACpC,MAAM,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,8BAA8B,CAAC;CACpE,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,uCAAuC,CAAC;CAC/E,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,mCAAmC,CAAC;CAC3E,SAAS,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,oCAAoC,CAAC;CAC7E,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,sCAAsC,CAAC;CAC7E,YAAY,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,+CAA+C,CAAC;CAC3F,WAAW,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,gCAAgC,CAAC;AAC/E,CAAC;AAED,IAAa,YAAY,EACpB,MAAM,CACH,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,oDAAoD,CAAC,GACpF,WAAW,OAAO,EAAE,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,EAAE,CAAC,CAC/D,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,gEAAgE,CAAC;AAE1F,IAAa,gBAAgB,EACxB,YAAY;CACT,QAAQ,EAAE,OAAO,CAAC,CAAC,MAAM,eAAe;CACxC,KAAK,EACA,OAAO,CAAC,CACR,MAAM,WAAW,CAAC,CAClB,KAAK,EACF,aAAa,mEACjB,CAAC;CACL,QAAQ,EACH,OAAO,CAAC,CACR,MAAM,YAAY,CAAC,CACnB,SAAS;CACd,OAAO,EACF,OAAO,CAAC,CACR,MAAM,YAAY,CAAC,CACnB,SAAS;CACd,SAAS,EAAE,KAAK;EAAC;EAAQ;EAAS;EAAQ;EAAY;CAAU,CAAC,CAAC,CAAC,SAAS;CAC5E,cAAc,EACT,OAAO,CAAC,CACR,MAAM,YAAY,CAAC,CACnB,SAAS;AAClB,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,gDAAgD,CAAC;AAE1E,IAAa,sBAAsB,EAC9B,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAC9C,KAAK,EAAE,aAAa,gDAAgD,CAAC;AAE1E,IAAa,YAAY,EAAE,MAAM,CAAC,eAAe,mBAAmB,CAAC;AAErE,IAAM,aAAa;CACf,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,QAAQ,YAAY,KAAK,EACrB,aACI,gFACR,CAAC;CACD,MAAM,YAAY,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,yCAAyC,CAAC;CAC3F,SAAS,EACJ,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC,MAAM,YAAY,CAAC,CAAC,CAC5C,SAAS,CAAC,CACV,KAAK,EACF,aACI,qHACR,CAAC;CACL,OAAO,EAAE,OAAO,MAAM,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAC7C,aAAa,2EACjB,CAAC;CACD,YAAY,EACP,OAAO,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,MAAM,WAAW,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CACjF,SAAS,CAAC,CACV,KAAK,EACF,aACI,wFACR,CAAC;CACL,WAAW,EACN,YAAY;EACT,SAAS,YAAY,SAAS;EAC9B,aAAa,YAAY,SAAS;EAClC,OAAO,YAAY,SAAS;CAChC,CAAC,CAAC,CACD,SAAS,CAAC,CACV,KAAK,EACF,aACI,iGACR,CAAC;CACL,OAAO,EAAE,MAAM,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EACtC,aAAa,2DACjB,CAAC;AACL;AAEA,IAAa,QAAQ,EAChB,YAAY,UAAU,CAAC,CACvB,KAAK,EAAE,aAAa,2DAA2D,CAAC;AAErF,IAAa,kBAAkB,EAC1B,YAAY;CACT,GAAG;CACH,QAAQ,WAAW,OAAO,SAAS;CACnC,aAAa,EAAE,KAAK;EAAC;EAAS;EAAQ;CAAM,CAAC,CAAC,CAAC,SAAS;CACxD,SAAS,EAAE,KAAK;EAAC;EAAW;EAAe;EAAS;CAAM,CAAC,CAAC,CAAC,SAAS;CACtE,SAAS,EACJ,MAAM,CAAC,EAAE,OAAO,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CACxC,SAAS,CAAC,CACV,KAAK,EACF,aACI,4GACR,CAAC;AACT,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,+DAA+D,CAAC"}
@@ -0,0 +1,51 @@
1
+ /** Shortest search, in characters once trimmed: shorter is a `422`. */
2
+ export declare const SEARCH_MIN_LENGTH = 2;
3
+ /** Longest search, in characters. */
4
+ export declare const SEARCH_MAX_LENGTH = 255;
5
+ /** Items per resource without a `limit`. */
6
+ export declare const SEARCH_DEFAULT_LIMIT = 5;
7
+ /** Highest `limit`, and most items of a response, every resource together. */
8
+ export declare const SEARCH_MAX_LIMIT = 20;
9
+ /** What the global search reads of a resource. */
10
+ export interface SearchableResource {
11
+ id: string;
12
+ features?: {
13
+ search?: boolean | undefined;
14
+ } | undefined;
15
+ list?: {
16
+ search?: boolean | undefined;
17
+ } | undefined;
18
+ }
19
+ /** Query of the global search (`GET /search`). */
20
+ export interface SearchQuery {
21
+ q: string;
22
+ /** Items per resource, from 1 to 20. Defaults to 5. */
23
+ limit?: number;
24
+ /** Ids of the searchable resources to search. Defaults to every one. */
25
+ resources?: readonly string[];
26
+ }
27
+ /**
28
+ * Whether a resource is in the global search: its `features.search`, or, without it, whether its
29
+ * list has a search (`list.search`), so one setting serves both (decision 0029).
30
+ */
31
+ export declare function isSearchableResource(resource: Omit<SearchableResource, 'id'>): boolean;
32
+ /** Serializes a search query: `q=été&limit=20&resources=pages,articles`. */
33
+ export declare function toSearchQueryParams(query: SearchQuery): URLSearchParams;
34
+ /** A search query as a backend reads it: valid, or the messages of its invalid parameters. */
35
+ export type ReadSearchQueryResult = {
36
+ query: Required<SearchQuery>;
37
+ errors?: undefined;
38
+ } | {
39
+ query?: undefined;
40
+ errors: Record<string, string[]>;
41
+ };
42
+ /**
43
+ * Reads the query string of `GET /search`: the reference of how a backend validates it. `q` is
44
+ * trimmed and needs 2 characters; `limit` is an integer from 1 to 20; `resources` lists searchable
45
+ * resources of the definition. Invalid parameters are a `422`, with `errors` keyed by parameter.
46
+ * Without `resources`, every searchable resource is searched, in the order of the definition.
47
+ */
48
+ export declare function readSearchQuery(params: URLSearchParams, definition: {
49
+ resources: readonly SearchableResource[];
50
+ }): ReadSearchQueryResult;
51
+ //# sourceMappingURL=search.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,eAAO,MAAM,iBAAiB,IAAI,CAAC;AACnC,qCAAqC;AACrC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,4CAA4C;AAC5C,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,8EAA8E;AAC9E,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC,kDAAkD;AAClD,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;IACxD,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;CACvD;AAED,kDAAkD;AAClD,MAAM,WAAW,WAAW;IACxB,CAAC,EAAE,MAAM,CAAC;IACV,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,GAAG,OAAO,CAEtF;AAED,4EAA4E;AAC5E,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,GAAG,eAAe,CASvE;AAED,8FAA8F;AAC9F,MAAM,MAAM,qBAAqB,GAC3B;IAAE,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,GACpD;IAAE,KAAK,CAAC,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC;AAE9D;;;;;GAKG;AACH,wBAAgB,eAAe,CAC3B,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE;IAAE,SAAS,EAAE,SAAS,kBAAkB,EAAE,CAAA;CAAE,GACzD,qBAAqB,CAyCvB"}
package/dist/search.js ADDED
@@ -0,0 +1,53 @@
1
+ //#region src/search.ts
2
+ /** Shortest search, in characters once trimmed: shorter is a `422`. */
3
+ var SEARCH_MIN_LENGTH = 2;
4
+ /** Longest search, in characters. */
5
+ var SEARCH_MAX_LENGTH = 255;
6
+ /** Items per resource without a `limit`. */
7
+ var SEARCH_DEFAULT_LIMIT = 5;
8
+ /** Highest `limit`, and most items of a response, every resource together. */
9
+ var SEARCH_MAX_LIMIT = 20;
10
+ /**
11
+ * Whether a resource is in the global search: its `features.search`, or, without it, whether its
12
+ * list has a search (`list.search`), so one setting serves both (decision 0029).
13
+ */
14
+ function isSearchableResource(resource) {
15
+ return resource.features?.search ?? resource.list?.search ?? false;
16
+ }
17
+ /** Serializes a search query: `q=été&limit=20&resources=pages,articles`. */
18
+ function toSearchQueryParams(query) {
19
+ const params = new URLSearchParams({ q: query.q });
20
+ if (query.limit !== void 0) params.set("limit", String(query.limit));
21
+ if (query.resources !== void 0 && query.resources.length > 0) params.set("resources", query.resources.join(","));
22
+ return params;
23
+ }
24
+ /**
25
+ * Reads the query string of `GET /search`: the reference of how a backend validates it. `q` is
26
+ * trimmed and needs 2 characters; `limit` is an integer from 1 to 20; `resources` lists searchable
27
+ * resources of the definition. Invalid parameters are a `422`, with `errors` keyed by parameter.
28
+ * Without `resources`, every searchable resource is searched, in the order of the definition.
29
+ */
30
+ function readSearchQuery(params, definition) {
31
+ const errors = {};
32
+ const q = (params.get("q") ?? "").trim();
33
+ if (q.length < 2) errors.q = [`The search must have at least 2 characters.`];
34
+ else if (q.length > 255) errors.q = [`The search must have at most 255 characters.`];
35
+ const rawLimit = params.get("limit");
36
+ const limit = rawLimit === null ? 5 : Number(rawLimit);
37
+ if (rawLimit !== null && (!/^\d+$/.test(rawLimit) || limit < 1 || limit > 20)) errors.limit = [`The limit must be an integer from 1 to 20.`];
38
+ const searchable = definition.resources.filter(isSearchableResource).map((resource) => resource.id);
39
+ const rawResources = params.get("resources");
40
+ const asked = rawResources === null ? searchable : rawResources.split(",").map((id) => id.trim()).filter((id) => id !== "");
41
+ const unknown = asked.filter((id) => !searchable.includes(id));
42
+ if (rawResources !== null && (asked.length === 0 || unknown.length > 0)) errors.resources = [unknown.length > 0 ? `These resources are not searchable: ${unknown.join(", ")}.` : "List at least one resource."];
43
+ if (Object.keys(errors).length > 0) return { errors };
44
+ return { query: {
45
+ q,
46
+ limit,
47
+ resources: searchable.filter((id) => asked.includes(id))
48
+ } };
49
+ }
50
+ //#endregion
51
+ export { SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, isSearchableResource, readSearchQuery, toSearchQueryParams };
52
+
53
+ //# sourceMappingURL=search.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search.js","names":[],"sources":["../src/search.ts"],"sourcesContent":["/** Shortest search, in characters once trimmed: shorter is a `422`. */\nexport const SEARCH_MIN_LENGTH = 2;\n/** Longest search, in characters. */\nexport const SEARCH_MAX_LENGTH = 255;\n/** Items per resource without a `limit`. */\nexport const SEARCH_DEFAULT_LIMIT = 5;\n/** Highest `limit`, and most items of a response, every resource together. */\nexport const SEARCH_MAX_LIMIT = 20;\n\n/** What the global search reads of a resource. */\nexport interface SearchableResource {\n id: string;\n features?: { search?: boolean | undefined } | undefined;\n list?: { search?: boolean | undefined } | undefined;\n}\n\n/** Query of the global search (`GET /search`). */\nexport interface SearchQuery {\n q: string;\n /** Items per resource, from 1 to 20. Defaults to 5. */\n limit?: number;\n /** Ids of the searchable resources to search. Defaults to every one. */\n resources?: readonly string[];\n}\n\n/**\n * Whether a resource is in the global search: its `features.search`, or, without it, whether its\n * list has a search (`list.search`), so one setting serves both (decision 0029).\n */\nexport function isSearchableResource(resource: Omit<SearchableResource, 'id'>): boolean {\n return resource.features?.search ?? resource.list?.search ?? false;\n}\n\n/** Serializes a search query: `q=été&limit=20&resources=pages,articles`. */\nexport function toSearchQueryParams(query: SearchQuery): URLSearchParams {\n const params = new URLSearchParams({ q: query.q });\n if (query.limit !== undefined) {\n params.set('limit', String(query.limit));\n }\n if (query.resources !== undefined && query.resources.length > 0) {\n params.set('resources', query.resources.join(','));\n }\n return params;\n}\n\n/** A search query as a backend reads it: valid, or the messages of its invalid parameters. */\nexport type ReadSearchQueryResult =\n | { query: Required<SearchQuery>; errors?: undefined }\n | { query?: undefined; errors: Record<string, string[]> };\n\n/**\n * Reads the query string of `GET /search`: the reference of how a backend validates it. `q` is\n * trimmed and needs 2 characters; `limit` is an integer from 1 to 20; `resources` lists searchable\n * resources of the definition. Invalid parameters are a `422`, with `errors` keyed by parameter.\n * Without `resources`, every searchable resource is searched, in the order of the definition.\n */\nexport function readSearchQuery(\n params: URLSearchParams,\n definition: { resources: readonly SearchableResource[] },\n): ReadSearchQueryResult {\n const errors: Record<string, string[]> = {};\n const q = (params.get('q') ?? '').trim();\n if (q.length < SEARCH_MIN_LENGTH) {\n errors.q = [`The search must have at least ${SEARCH_MIN_LENGTH} characters.`];\n } else if (q.length > SEARCH_MAX_LENGTH) {\n errors.q = [`The search must have at most ${SEARCH_MAX_LENGTH} characters.`];\n }\n\n const rawLimit = params.get('limit');\n const limit = rawLimit === null ? SEARCH_DEFAULT_LIMIT : Number(rawLimit);\n if (rawLimit !== null && (!/^\\d+$/.test(rawLimit) || limit < 1 || limit > SEARCH_MAX_LIMIT)) {\n errors.limit = [`The limit must be an integer from 1 to ${SEARCH_MAX_LIMIT}.`];\n }\n\n const searchable = definition.resources\n .filter(isSearchableResource)\n .map((resource) => resource.id);\n const rawResources = params.get('resources');\n const asked =\n rawResources === null\n ? searchable\n : rawResources\n .split(',')\n .map((id) => id.trim())\n .filter((id) => id !== '');\n const unknown = asked.filter((id) => !searchable.includes(id));\n if (rawResources !== null && (asked.length === 0 || unknown.length > 0)) {\n errors.resources = [\n unknown.length > 0\n ? `These resources are not searchable: ${unknown.join(', ')}.`\n : 'List at least one resource.',\n ];\n }\n\n if (Object.keys(errors).length > 0) {\n return { errors };\n }\n // The order of the definition, without duplicates\n const resources = searchable.filter((id) => asked.includes(id));\n return { query: { q, limit, resources } };\n}\n"],"mappings":";;AACA,IAAa,oBAAoB;;AAEjC,IAAa,oBAAoB;;AAEjC,IAAa,uBAAuB;;AAEpC,IAAa,mBAAmB;;;;;AAsBhC,SAAgB,qBAAqB,UAAmD;CACpF,OAAO,SAAS,UAAU,UAAU,SAAS,MAAM,UAAU;AACjE;;AAGA,SAAgB,oBAAoB,OAAqC;CACrE,MAAM,SAAS,IAAI,gBAAgB,EAAE,GAAG,MAAM,EAAE,CAAC;CACjD,IAAI,MAAM,UAAU,KAAA,GAChB,OAAO,IAAI,SAAS,OAAO,MAAM,KAAK,CAAC;CAE3C,IAAI,MAAM,cAAc,KAAA,KAAa,MAAM,UAAU,SAAS,GAC1D,OAAO,IAAI,aAAa,MAAM,UAAU,KAAK,GAAG,CAAC;CAErD,OAAO;AACX;;;;;;;AAaA,SAAgB,gBACZ,QACA,YACqB;CACrB,MAAM,SAAmC,CAAC;CAC1C,MAAM,KAAK,OAAO,IAAI,GAAG,KAAK,GAAA,CAAI,KAAK;CACvC,IAAI,EAAE,SAAA,GACF,OAAO,IAAI,CAAC,6CAAgE;MACzE,IAAI,EAAE,SAAA,KACT,OAAO,IAAI,CAAC,8CAA+D;CAG/E,MAAM,WAAW,OAAO,IAAI,OAAO;CACnC,MAAM,QAAQ,aAAa,OAAA,IAA8B,OAAO,QAAQ;CACxE,IAAI,aAAa,SAAS,CAAC,QAAQ,KAAK,QAAQ,KAAK,QAAQ,KAAK,QAAA,KAC9D,OAAO,QAAQ,CAAC,4CAA6D;CAGjF,MAAM,aAAa,WAAW,UACzB,OAAO,oBAAoB,CAAC,CAC5B,KAAK,aAAa,SAAS,EAAE;CAClC,MAAM,eAAe,OAAO,IAAI,WAAW;CAC3C,MAAM,QACF,iBAAiB,OACX,aACA,aACK,MAAM,GAAG,CAAC,CACV,KAAK,OAAO,GAAG,KAAK,CAAC,CAAC,CACtB,QAAQ,OAAO,OAAO,EAAE;CACvC,MAAM,UAAU,MAAM,QAAQ,OAAO,CAAC,WAAW,SAAS,EAAE,CAAC;CAC7D,IAAI,iBAAiB,SAAS,MAAM,WAAW,KAAK,QAAQ,SAAS,IACjE,OAAO,YAAY,CACf,QAAQ,SAAS,IACX,uCAAuC,QAAQ,KAAK,IAAI,EAAE,KAC1D,6BACV;CAGJ,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC,SAAS,GAC7B,OAAO,EAAE,OAAO;CAIpB,OAAO,EAAE,OAAO;EAAE;EAAG;EAAO,WADV,WAAW,QAAQ,OAAO,MAAM,SAAS,EAAE,CACjC;CAAU,EAAE;AAC5C"}
@@ -0,0 +1,11 @@
1
+ import type { Theme } from './schemas/theme.js';
2
+ /** A theme to merge: `tokens` can be left out, as in the theme of a definition. */
3
+ export type PartialTheme = Partial<Theme>;
4
+ /**
5
+ * Merges themes, in order: each one overrides the tokens, palette colors, tones and variants of
6
+ * those before it. A token a theme sets in `tokens` but not in `dark` applies to both schemes, so it
7
+ * also replaces the dark value of earlier themes. Variants merge token by token; tones are replaced
8
+ * whole; densities merge token by token; fonts add up. The label is the last one set. `defineTheme()` of `@panneau/ui` merges the same way.
9
+ */
10
+ export declare function mergeThemes(...themes: readonly PartialTheme[]): Theme;
11
+ //# sourceMappingURL=themes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"themes.d.ts","sourceRoot":"","sources":["../src/themes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE7C,mFAAmF;AACnF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;AAmE1C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,MAAM,EAAE,SAAS,YAAY,EAAE,GAAG,KAAK,CAgCrE"}
package/dist/themes.js ADDED
@@ -0,0 +1,80 @@
1
+ //#region src/themes.ts
2
+ function mergeRecords(first, second) {
3
+ return first === void 0 && second === void 0 ? void 0 : {
4
+ ...first,
5
+ ...second
6
+ };
7
+ }
8
+ function mergeComponents(first, second) {
9
+ const components = mergeRecords(first, second);
10
+ if (components === void 0) return;
11
+ return Object.fromEntries(Object.keys(components).map((component) => {
12
+ const before = first?.[component];
13
+ const after = second?.[component];
14
+ const variants = mergeRecords(before?.variants, after?.variants);
15
+ return [component, {
16
+ ...before,
17
+ ...after,
18
+ ...variants !== void 0 && { variants: Object.fromEntries(Object.keys(variants).map((name) => [name, {
19
+ ...before?.variants?.[name],
20
+ ...after?.variants?.[name]
21
+ }])) }
22
+ }];
23
+ }));
24
+ }
25
+ var DENSITIES = [
26
+ "compact",
27
+ "comfortable",
28
+ "touch"
29
+ ];
30
+ function mergeDensities(first, second) {
31
+ if (first === void 0 && second === void 0) return;
32
+ const densities = {
33
+ ...first,
34
+ ...second
35
+ };
36
+ DENSITIES.forEach((density) => {
37
+ if (first?.[density] !== void 0 && second?.[density] !== void 0) densities[density] = {
38
+ ...first[density],
39
+ ...second[density]
40
+ };
41
+ });
42
+ return densities;
43
+ }
44
+ function mergeFonts(first, second) {
45
+ if (first === void 0 && second === void 0) return;
46
+ const fonts = [...first ?? [], ...second ?? []];
47
+ return fonts.filter((font, index) => fonts.findIndex((other) => JSON.stringify(other) === JSON.stringify(font)) === index);
48
+ }
49
+ /**
50
+ * Merges themes, in order: each one overrides the tokens, palette colors, tones and variants of
51
+ * those before it. A token a theme sets in `tokens` but not in `dark` applies to both schemes, so it
52
+ * also replaces the dark value of earlier themes. Variants merge token by token; tones are replaced
53
+ * whole; densities merge token by token; fonts add up. The label is the last one set. `defineTheme()` of `@panneau/ui` merges the same way.
54
+ */
55
+ function mergeThemes(...themes) {
56
+ return themes.reduce((merged, theme) => {
57
+ const tokens = theme.tokens ?? {};
58
+ const dark = mergeRecords(merged.dark !== void 0 ? Object.fromEntries(Object.entries(merged.dark).filter(([name]) => !Object.hasOwn(tokens, name))) : void 0, theme.dark);
59
+ const result = {
60
+ ...merged,
61
+ ...theme,
62
+ label: theme.label ?? merged.label,
63
+ tokens: {
64
+ ...merged.tokens,
65
+ ...tokens
66
+ },
67
+ dark: dark !== void 0 && Object.keys(dark).length > 0 ? dark : void 0,
68
+ palette: mergeRecords(merged.palette, theme.palette),
69
+ tones: mergeRecords(merged.tones, theme.tones),
70
+ components: mergeComponents(merged.components, theme.components),
71
+ densities: mergeDensities(merged.densities, theme.densities),
72
+ fonts: mergeFonts(merged.fonts, theme.fonts)
73
+ };
74
+ return Object.fromEntries(Object.entries(result).filter(([, value]) => value !== void 0));
75
+ }, { tokens: {} });
76
+ }
77
+ //#endregion
78
+ export { mergeThemes };
79
+
80
+ //# sourceMappingURL=themes.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"themes.js","names":[],"sources":["../src/themes.ts"],"sourcesContent":["import type { Theme } from './schemas/theme';\n\n/** A theme to merge: `tokens` can be left out, as in the theme of a definition. */\nexport type PartialTheme = Partial<Theme>;\n\nfunction mergeRecords<T>(\n first: Record<string, T> | undefined,\n second: Record<string, T> | undefined,\n): Record<string, T> | undefined {\n return first === undefined && second === undefined ? undefined : { ...first, ...second };\n}\n\nfunction mergeComponents(\n first: Theme['components'],\n second: Theme['components'],\n): Theme['components'] {\n const components = mergeRecords(first, second);\n if (components === undefined) {\n return undefined;\n }\n return Object.fromEntries(\n Object.keys(components).map((component) => {\n const before = first?.[component];\n const after = second?.[component];\n const variants = mergeRecords(before?.variants, after?.variants);\n return [\n component,\n {\n ...before,\n ...after,\n ...(variants !== undefined && {\n variants: Object.fromEntries(\n Object.keys(variants).map((name) => [\n name,\n { ...before?.variants?.[name], ...after?.variants?.[name] },\n ]),\n ),\n }),\n },\n ];\n }),\n );\n}\n\nconst DENSITIES = ['compact', 'comfortable', 'touch'] as const;\n\nfunction mergeDensities(first: Theme['densities'], second: Theme['densities']): Theme['densities'] {\n if (first === undefined && second === undefined) {\n return undefined;\n }\n const densities = { ...first, ...second };\n DENSITIES.forEach((density) => {\n if (first?.[density] !== undefined && second?.[density] !== undefined) {\n densities[density] = { ...first[density], ...second[density] };\n }\n });\n return densities;\n}\n\nfunction mergeFonts(first: Theme['fonts'], second: Theme['fonts']): Theme['fonts'] {\n if (first === undefined && second === undefined) {\n return undefined;\n }\n const fonts = [...(first ?? []), ...(second ?? [])];\n return fonts.filter(\n (font, index) =>\n fonts.findIndex((other) => JSON.stringify(other) === JSON.stringify(font)) === index,\n );\n}\n\n/**\n * Merges themes, in order: each one overrides the tokens, palette colors, tones and variants of\n * those before it. A token a theme sets in `tokens` but not in `dark` applies to both schemes, so it\n * also replaces the dark value of earlier themes. Variants merge token by token; tones are replaced\n * whole; densities merge token by token; fonts add up. The label is the last one set. `defineTheme()` of `@panneau/ui` merges the same way.\n */\nexport function mergeThemes(...themes: readonly PartialTheme[]): Theme {\n return themes.reduce<Theme>(\n (merged, theme) => {\n const tokens = theme.tokens ?? {};\n const dark = mergeRecords(\n merged.dark !== undefined\n ? Object.fromEntries(\n Object.entries(merged.dark).filter(\n ([name]) => !Object.hasOwn(tokens, name),\n ),\n )\n : undefined,\n theme.dark,\n );\n const result: Theme = {\n ...merged,\n ...theme,\n label: theme.label ?? merged.label,\n tokens: { ...merged.tokens, ...tokens },\n dark: dark !== undefined && Object.keys(dark).length > 0 ? dark : undefined,\n palette: mergeRecords(merged.palette, theme.palette),\n tones: mergeRecords(merged.tones, theme.tones),\n components: mergeComponents(merged.components, theme.components),\n densities: mergeDensities(merged.densities, theme.densities),\n fonts: mergeFonts(merged.fonts, theme.fonts),\n };\n return Object.fromEntries(\n Object.entries(result).filter(([, value]) => value !== undefined),\n ) as Theme;\n },\n { tokens: {} },\n );\n}\n"],"mappings":";AAKA,SAAS,aACL,OACA,QAC6B;CAC7B,OAAO,UAAU,KAAA,KAAa,WAAW,KAAA,IAAY,KAAA,IAAY;EAAE,GAAG;EAAO,GAAG;CAAO;AAC3F;AAEA,SAAS,gBACL,OACA,QACmB;CACnB,MAAM,aAAa,aAAa,OAAO,MAAM;CAC7C,IAAI,eAAe,KAAA,GACf;CAEJ,OAAO,OAAO,YACV,OAAO,KAAK,UAAU,CAAC,CAAC,KAAK,cAAc;EACvC,MAAM,SAAS,QAAQ;EACvB,MAAM,QAAQ,SAAS;EACvB,MAAM,WAAW,aAAa,QAAQ,UAAU,OAAO,QAAQ;EAC/D,OAAO,CACH,WACA;GACI,GAAG;GACH,GAAG;GACH,GAAI,aAAa,KAAA,KAAa,EAC1B,UAAU,OAAO,YACb,OAAO,KAAK,QAAQ,CAAC,CAAC,KAAK,SAAS,CAChC,MACA;IAAE,GAAG,QAAQ,WAAW;IAAO,GAAG,OAAO,WAAW;GAAM,CAC9D,CAAC,CACL,EACJ;EACJ,CACJ;CACJ,CAAC,CACL;AACJ;AAEA,IAAM,YAAY;CAAC;CAAW;CAAe;AAAO;AAEpD,SAAS,eAAe,OAA2B,QAAgD;CAC/F,IAAI,UAAU,KAAA,KAAa,WAAW,KAAA,GAClC;CAEJ,MAAM,YAAY;EAAE,GAAG;EAAO,GAAG;CAAO;CACxC,UAAU,SAAS,YAAY;EAC3B,IAAI,QAAQ,aAAa,KAAA,KAAa,SAAS,aAAa,KAAA,GACxD,UAAU,WAAW;GAAE,GAAG,MAAM;GAAU,GAAG,OAAO;EAAS;CAErE,CAAC;CACD,OAAO;AACX;AAEA,SAAS,WAAW,OAAuB,QAAwC;CAC/E,IAAI,UAAU,KAAA,KAAa,WAAW,KAAA,GAClC;CAEJ,MAAM,QAAQ,CAAC,GAAI,SAAS,CAAC,GAAI,GAAI,UAAU,CAAC,CAAE;CAClD,OAAO,MAAM,QACR,MAAM,UACH,MAAM,WAAW,UAAU,KAAK,UAAU,KAAK,MAAM,KAAK,UAAU,IAAI,CAAC,MAAM,KACvF;AACJ;;;;;;;AAQA,SAAgB,YAAY,GAAG,QAAwC;CACnE,OAAO,OAAO,QACT,QAAQ,UAAU;EACf,MAAM,SAAS,MAAM,UAAU,CAAC;EAChC,MAAM,OAAO,aACT,OAAO,SAAS,KAAA,IACV,OAAO,YACH,OAAO,QAAQ,OAAO,IAAI,CAAC,CAAC,QACvB,CAAC,UAAU,CAAC,OAAO,OAAO,QAAQ,IAAI,CAC3C,CACJ,IACA,KAAA,GACN,MAAM,IACV;EACA,MAAM,SAAgB;GAClB,GAAG;GACH,GAAG;GACH,OAAO,MAAM,SAAS,OAAO;GAC7B,QAAQ;IAAE,GAAG,OAAO;IAAQ,GAAG;GAAO;GACtC,MAAM,SAAS,KAAA,KAAa,OAAO,KAAK,IAAI,CAAC,CAAC,SAAS,IAAI,OAAO,KAAA;GAClE,SAAS,aAAa,OAAO,SAAS,MAAM,OAAO;GACnD,OAAO,aAAa,OAAO,OAAO,MAAM,KAAK;GAC7C,YAAY,gBAAgB,OAAO,YAAY,MAAM,UAAU;GAC/D,WAAW,eAAe,OAAO,WAAW,MAAM,SAAS;GAC3D,OAAO,WAAW,OAAO,OAAO,MAAM,KAAK;EAC/C;EACA,OAAO,OAAO,YACV,OAAO,QAAQ,MAAM,CAAC,CAAC,QAAQ,GAAG,WAAW,UAAU,KAAA,CAAS,CACpE;CACJ,GACA,EAAE,QAAQ,CAAC,EAAE,CACjB;AACJ"}
@@ -0,0 +1,17 @@
1
+ import type { MediaTransform } from './schemas/api.js';
2
+ /** The ratio of `width:height` (`16:9` gives 1.777…), or null when it isn't one. */
3
+ export declare function parseRatio(ratio: string): number | null;
4
+ /**
5
+ * Whether a size has a ratio (decision 0031): its height is within one pixel of its width divided
6
+ * by the ratio, since crops are in whole pixels.
7
+ */
8
+ export declare function matchesRatio(width: number, height: number, ratio: number | string): boolean;
9
+ /**
10
+ * The size of the crop of a transform as it is rendered: a quarter turn swaps its width and its
11
+ * height. Null without a crop.
12
+ */
13
+ export declare function renderedCropSize(transform: Pick<MediaTransform, 'crop' | 'rotate'>): {
14
+ width: number;
15
+ height: number;
16
+ } | null;
17
+ //# sourceMappingURL=transforms.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transforms.d.ts","sourceRoot":"","sources":["../src/transforms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGpD,oFAAoF;AACpF,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAGvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAG3F;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,QAAQ,CAAC,GACnD;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAQ1C"}
@@ -0,0 +1,34 @@
1
+ import { isRecord } from "./values.js";
2
+ //#region src/transforms.ts
3
+ /** The ratio of `width:height` (`16:9` gives 1.777…), or null when it isn't one. */
4
+ function parseRatio(ratio) {
5
+ const match = /^([1-9][0-9]*):([1-9][0-9]*)$/.exec(ratio);
6
+ return match === null ? null : Number(match[1]) / Number(match[2]);
7
+ }
8
+ /**
9
+ * Whether a size has a ratio (decision 0031): its height is within one pixel of its width divided
10
+ * by the ratio, since crops are in whole pixels.
11
+ */
12
+ function matchesRatio(width, height, ratio) {
13
+ const value = typeof ratio === "number" ? ratio : parseRatio(ratio);
14
+ return value !== null && value > 0 && Math.abs(width / value - height) <= 1;
15
+ }
16
+ /**
17
+ * The size of the crop of a transform as it is rendered: a quarter turn swaps its width and its
18
+ * height. Null without a crop.
19
+ */
20
+ function renderedCropSize(transform) {
21
+ const crop = transform.crop;
22
+ if (!isRecord(crop) || typeof crop.width !== "number" || typeof crop.height !== "number") return null;
23
+ return transform.rotate === 90 || transform.rotate === 270 ? {
24
+ width: crop.height,
25
+ height: crop.width
26
+ } : {
27
+ width: crop.width,
28
+ height: crop.height
29
+ };
30
+ }
31
+ //#endregion
32
+ export { matchesRatio, parseRatio, renderedCropSize };
33
+
34
+ //# sourceMappingURL=transforms.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transforms.js","names":[],"sources":["../src/transforms.ts"],"sourcesContent":["import type { MediaTransform } from './schemas/api';\nimport { isRecord } from './values';\n\n/** The ratio of `width:height` (`16:9` gives 1.777…), or null when it isn't one. */\nexport function parseRatio(ratio: string): number | null {\n const match = /^([1-9][0-9]*):([1-9][0-9]*)$/.exec(ratio);\n return match === null ? null : Number(match[1]) / Number(match[2]);\n}\n\n/**\n * Whether a size has a ratio (decision 0031): its height is within one pixel of its width divided\n * by the ratio, since crops are in whole pixels.\n */\nexport function matchesRatio(width: number, height: number, ratio: number | string): boolean {\n const value = typeof ratio === 'number' ? ratio : parseRatio(ratio);\n return value !== null && value > 0 && Math.abs(width / value - height) <= 1;\n}\n\n/**\n * The size of the crop of a transform as it is rendered: a quarter turn swaps its width and its\n * height. Null without a crop.\n */\nexport function renderedCropSize(\n transform: Pick<MediaTransform, 'crop' | 'rotate'>,\n): { width: number; height: number } | null {\n const crop = transform.crop;\n if (!isRecord(crop) || typeof crop.width !== 'number' || typeof crop.height !== 'number') {\n return null;\n }\n return transform.rotate === 90 || transform.rotate === 270\n ? { width: crop.height, height: crop.width }\n : { width: crop.width, height: crop.height };\n}\n"],"mappings":";;;AAIA,SAAgB,WAAW,OAA8B;CACrD,MAAM,QAAQ,gCAAgC,KAAK,KAAK;CACxD,OAAO,UAAU,OAAO,OAAO,OAAO,MAAM,EAAE,IAAI,OAAO,MAAM,EAAE;AACrE;;;;;AAMA,SAAgB,aAAa,OAAe,QAAgB,OAAiC;CACzF,MAAM,QAAQ,OAAO,UAAU,WAAW,QAAQ,WAAW,KAAK;CAClE,OAAO,UAAU,QAAQ,QAAQ,KAAK,KAAK,IAAI,QAAQ,QAAQ,MAAM,KAAK;AAC9E;;;;;AAMA,SAAgB,iBACZ,WACwC;CACxC,MAAM,OAAO,UAAU;CACvB,IAAI,CAAC,SAAS,IAAI,KAAK,OAAO,KAAK,UAAU,YAAY,OAAO,KAAK,WAAW,UAC5E,OAAO;CAEX,OAAO,UAAU,WAAW,MAAM,UAAU,WAAW,MACjD;EAAE,OAAO,KAAK;EAAQ,QAAQ,KAAK;CAAM,IACzC;EAAE,OAAO,KAAK;EAAO,QAAQ,KAAK;CAAO;AACnD"}
@@ -1,7 +1,6 @@
1
1
  import type { z } from 'zod';
2
- import { Problem } from './schemas/api';
3
- import { BootConfig } from './schemas/boot';
4
- import { Definition } from './schemas/definition';
2
+ import { BootConfig } from './schemas/boot.js';
3
+ import { Definition } from './schemas/definition.js';
5
4
  export interface ValidationIssue {
6
5
  /** Dot path of the invalid value (`resources.0.fields.2.type`), empty for the root. */
7
6
  path: string;
@@ -18,7 +17,8 @@ export type ValidationResult<T> = {
18
17
  export declare function validate<T extends z.ZodType>(schema: T, input: unknown): ValidationResult<z.infer<T>>;
19
18
  /**
20
19
  * Validates a definition, as returned by `GET /definition`: against the schema, then the
21
- * references between its parts (see `lintDefinition()`).
20
+ * references between its parts (see `lintDefinition()`), and the settings of field types that
21
+ * the protocol describes (`RichTextSettings`).
22
22
  */
23
23
  export declare function validateDefinition(input: unknown): ValidationResult<Definition>;
24
24
  /**
@@ -26,6 +26,4 @@ export declare function validateDefinition(input: unknown): ValidationResult<Def
26
26
  * references between the parts of its inlined definition, if any.
27
27
  */
28
28
  export declare function validateBootConfig(input: unknown): ValidationResult<BootConfig>;
29
- /** Whether a value is a problem details object (an API error). */
30
- export declare function isProblem(value: unknown): value is Problem;
31
29
  //# sourceMappingURL=validate.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,WAAW,eAAe;IAC5B,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAAE,CAAC;AAE/E,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EACxC,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,OAAO,GACf,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAY9B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAO/E;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAU/E;AAED,kEAAkE;AAClE,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE1D"}
1
+ {"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGlD,MAAM,WAAW,eAAe;IAC5B,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAAE,CAAC;AAE/E,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EACxC,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,OAAO,GACf,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAY9B;AAuBD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAwB/E;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAU/E"}
package/dist/validate.js CHANGED
@@ -1,7 +1,7 @@
1
+ import { lintDefinition } from "./lint.js";
2
+ import { RichTextSettings } from "./schemas/field.js";
1
3
  import { Definition } from "./schemas/definition.js";
2
- import { Problem } from "./schemas/api.js";
3
4
  import { BootConfig } from "./schemas/boot.js";
4
- import { lintDefinition } from "./lint.js";
5
5
  //#region src/validate.ts
6
6
  /** Validates a value against one of the protocol's schemas. */
7
7
  function validate(schema, input) {
@@ -18,14 +18,33 @@ function validate(schema, input) {
18
18
  }))
19
19
  };
20
20
  }
21
+ /** Checks the settings of the `richtext` fields of a list of fields, nested ones included. */
22
+ function checkFieldSettings(fields, path) {
23
+ return fields.flatMap((field, index) => {
24
+ const fieldPath = `${path}.${String(index)}`;
25
+ return [
26
+ ...field.type === "richtext" && field.settings !== void 0 ? (RichTextSettings.safeParse(field.settings).error?.issues ?? []).map((issue) => ({
27
+ path: [`${fieldPath}.settings`, ...issue.path.map(String)].join("."),
28
+ message: issue.message
29
+ })) : [],
30
+ ...checkFieldSettings(field.fields ?? [], `${fieldPath}.fields`),
31
+ ...(field.types ?? []).flatMap((type, typeIndex) => checkFieldSettings(type.fields, `${fieldPath}.types.${String(typeIndex)}.fields`))
32
+ ];
33
+ });
34
+ }
21
35
  /**
22
36
  * Validates a definition, as returned by `GET /definition`: against the schema, then the
23
- * references between its parts (see `lintDefinition()`).
37
+ * references between its parts (see `lintDefinition()`), and the settings of field types that
38
+ * the protocol describes (`RichTextSettings`).
24
39
  */
25
40
  function validateDefinition(input) {
26
41
  const result = validate(Definition, input);
27
42
  if (!result.success) return result;
28
- const issues = lintDefinition(result.data);
43
+ const issues = [...lintDefinition(result.data), ...result.data.resources.flatMap((resource, index) => [
44
+ ...checkFieldSettings(resource.fields, `resources.${String(index)}.fields`),
45
+ ...(resource.types ?? []).flatMap((type, typeIndex) => checkFieldSettings(type.fields, `resources.${String(index)}.types.${String(typeIndex)}.fields`)),
46
+ ...(resource.actions ?? []).flatMap((action, actionIndex) => checkFieldSettings(action.fields ?? [], `resources.${String(index)}.actions.${String(actionIndex)}.fields`))
47
+ ])];
29
48
  return issues.length > 0 ? {
30
49
  success: false,
31
50
  issues
@@ -47,11 +66,7 @@ function validateBootConfig(input) {
47
66
  issues
48
67
  } : result;
49
68
  }
50
- /** Whether a value is a problem details object (an API error). */
51
- function isProblem(value) {
52
- return Problem.safeParse(value).success;
53
- }
54
69
  //#endregion
55
- export { isProblem, validate, validateBootConfig, validateDefinition };
70
+ export { validate, validateBootConfig, validateDefinition };
56
71
 
57
72
  //# sourceMappingURL=validate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate.js","names":[],"sources":["../src/validate.ts"],"sourcesContent":["import type { z } from 'zod';\n\nimport { lintDefinition } from './lint';\nimport { Problem } from './schemas/api';\nimport { BootConfig } from './schemas/boot';\nimport { Definition } from './schemas/definition';\n\nexport interface ValidationIssue {\n /** Dot path of the invalid value (`resources.0.fields.2.type`), empty for the root. */\n path: string;\n message: string;\n}\n\nexport type ValidationResult<T> =\n { success: true; data: T } | { success: false; issues: ValidationIssue[] };\n\n/** Validates a value against one of the protocol's schemas. */\nexport function validate<T extends z.ZodType>(\n schema: T,\n input: unknown,\n): ValidationResult<z.infer<T>> {\n const result = schema.safeParse(input);\n if (result.success) {\n return { success: true, data: result.data };\n }\n return {\n success: false,\n issues: result.error.issues.map((issue) => ({\n path: issue.path.map(String).join('.'),\n message: issue.message,\n })),\n };\n}\n\n/**\n * Validates a definition, as returned by `GET /definition`: against the schema, then the\n * references between its parts (see `lintDefinition()`).\n */\nexport function validateDefinition(input: unknown): ValidationResult<Definition> {\n const result = validate(Definition, input);\n if (!result.success) {\n return result;\n }\n const issues = lintDefinition(result.data);\n return issues.length > 0 ? { success: false, issues } : result;\n}\n\n/**\n * Validates a boot config, as a server writes it in the page: against the schema, then the\n * references between the parts of its inlined definition, if any.\n */\nexport function validateBootConfig(input: unknown): ValidationResult<BootConfig> {\n const result = validate(BootConfig, input);\n if (!result.success || result.data.definition === undefined) {\n return result;\n }\n const issues = lintDefinition(result.data.definition).map((issue) => ({\n ...issue,\n path: issue.path === '' ? 'definition' : `definition.${issue.path}`,\n }));\n return issues.length > 0 ? { success: false, issues } : result;\n}\n\n/** Whether a value is a problem details object (an API error). */\nexport function isProblem(value: unknown): value is Problem {\n return Problem.safeParse(value).success;\n}\n"],"mappings":";;;;;;AAiBA,SAAgB,SACZ,QACA,OAC4B;CAC5B,MAAM,SAAS,OAAO,UAAU,KAAK;CACrC,IAAI,OAAO,SACP,OAAO;EAAE,SAAS;EAAM,MAAM,OAAO;CAAK;CAE9C,OAAO;EACH,SAAS;EACT,QAAQ,OAAO,MAAM,OAAO,KAAK,WAAW;GACxC,MAAM,MAAM,KAAK,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG;GACrC,SAAS,MAAM;EACnB,EAAE;CACN;AACJ;;;;;AAMA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,SACR,OAAO;CAEX,MAAM,SAAS,eAAe,OAAO,IAAI;CACzC,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D;;;;;AAMA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,WAAW,OAAO,KAAK,eAAe,KAAA,GAC9C,OAAO;CAEX,MAAM,SAAS,eAAe,OAAO,KAAK,UAAU,CAAC,CAAC,KAAK,WAAW;EAClE,GAAG;EACH,MAAM,MAAM,SAAS,KAAK,eAAe,cAAc,MAAM;CACjE,EAAE;CACF,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D;;AAGA,SAAgB,UAAU,OAAkC;CACxD,OAAO,QAAQ,UAAU,KAAK,CAAC,CAAC;AACpC"}
1
+ {"version":3,"file":"validate.js","names":[],"sources":["../src/validate.ts"],"sourcesContent":["import type { z } from 'zod';\n\nimport { lintDefinition } from './lint';\nimport { BootConfig } from './schemas/boot';\nimport { Definition } from './schemas/definition';\nimport { type Field, RichTextSettings } from './schemas/field';\n\nexport interface ValidationIssue {\n /** Dot path of the invalid value (`resources.0.fields.2.type`), empty for the root. */\n path: string;\n message: string;\n}\n\nexport type ValidationResult<T> =\n { success: true; data: T } | { success: false; issues: ValidationIssue[] };\n\n/** Validates a value against one of the protocol's schemas. */\nexport function validate<T extends z.ZodType>(\n schema: T,\n input: unknown,\n): ValidationResult<z.infer<T>> {\n const result = schema.safeParse(input);\n if (result.success) {\n return { success: true, data: result.data };\n }\n return {\n success: false,\n issues: result.error.issues.map((issue) => ({\n path: issue.path.map(String).join('.'),\n message: issue.message,\n })),\n };\n}\n\n/** Checks the settings of the `richtext` fields of a list of fields, nested ones included. */\nfunction checkFieldSettings(fields: readonly Field[], path: string): ValidationIssue[] {\n return fields.flatMap((field, index) => {\n const fieldPath = `${path}.${String(index)}`;\n const own =\n field.type === 'richtext' && field.settings !== undefined\n ? (RichTextSettings.safeParse(field.settings).error?.issues ?? []).map((issue) => ({\n path: [`${fieldPath}.settings`, ...issue.path.map(String)].join('.'),\n message: issue.message,\n }))\n : [];\n return [\n ...own,\n ...checkFieldSettings(field.fields ?? [], `${fieldPath}.fields`),\n ...(field.types ?? []).flatMap((type, typeIndex) =>\n checkFieldSettings(type.fields, `${fieldPath}.types.${String(typeIndex)}.fields`),\n ),\n ];\n });\n}\n\n/**\n * Validates a definition, as returned by `GET /definition`: against the schema, then the\n * references between its parts (see `lintDefinition()`), and the settings of field types that\n * the protocol describes (`RichTextSettings`).\n */\nexport function validateDefinition(input: unknown): ValidationResult<Definition> {\n const result = validate(Definition, input);\n if (!result.success) {\n return result;\n }\n const issues = [\n ...lintDefinition(result.data),\n ...result.data.resources.flatMap((resource, index) => [\n ...checkFieldSettings(resource.fields, `resources.${String(index)}.fields`),\n ...(resource.types ?? []).flatMap((type, typeIndex) =>\n checkFieldSettings(\n type.fields,\n `resources.${String(index)}.types.${String(typeIndex)}.fields`,\n ),\n ),\n ...(resource.actions ?? []).flatMap((action, actionIndex) =>\n checkFieldSettings(\n action.fields ?? [],\n `resources.${String(index)}.actions.${String(actionIndex)}.fields`,\n ),\n ),\n ]),\n ];\n return issues.length > 0 ? { success: false, issues } : result;\n}\n\n/**\n * Validates a boot config, as a server writes it in the page: against the schema, then the\n * references between the parts of its inlined definition, if any.\n */\nexport function validateBootConfig(input: unknown): ValidationResult<BootConfig> {\n const result = validate(BootConfig, input);\n if (!result.success || result.data.definition === undefined) {\n return result;\n }\n const issues = lintDefinition(result.data.definition).map((issue) => ({\n ...issue,\n path: issue.path === '' ? 'definition' : `definition.${issue.path}`,\n }));\n return issues.length > 0 ? { success: false, issues } : result;\n}\n"],"mappings":";;;;;;AAiBA,SAAgB,SACZ,QACA,OAC4B;CAC5B,MAAM,SAAS,OAAO,UAAU,KAAK;CACrC,IAAI,OAAO,SACP,OAAO;EAAE,SAAS;EAAM,MAAM,OAAO;CAAK;CAE9C,OAAO;EACH,SAAS;EACT,QAAQ,OAAO,MAAM,OAAO,KAAK,WAAW;GACxC,MAAM,MAAM,KAAK,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG;GACrC,SAAS,MAAM;EACnB,EAAE;CACN;AACJ;;AAGA,SAAS,mBAAmB,QAA0B,MAAiC;CACnF,OAAO,OAAO,SAAS,OAAO,UAAU;EACpC,MAAM,YAAY,GAAG,KAAK,GAAG,OAAO,KAAK;EAQzC,OAAO;GACH,GAPA,MAAM,SAAS,cAAc,MAAM,aAAa,KAAA,KACzC,iBAAiB,UAAU,MAAM,QAAQ,CAAC,CAAC,OAAO,UAAU,CAAC,EAAA,CAAG,KAAK,WAAW;IAC7E,MAAM,CAAC,GAAG,UAAU,YAAY,GAAG,MAAM,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG;IACnE,SAAS,MAAM;GACnB,EAAE,IACF,CAAC;GAGP,GAAG,mBAAmB,MAAM,UAAU,CAAC,GAAG,GAAG,UAAU,QAAQ;GAC/D,IAAI,MAAM,SAAS,CAAC,EAAA,CAAG,SAAS,MAAM,cAClC,mBAAmB,KAAK,QAAQ,GAAG,UAAU,SAAS,OAAO,SAAS,EAAE,QAAQ,CACpF;EACJ;CACJ,CAAC;AACL;;;;;;AAOA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,SACR,OAAO;CAEX,MAAM,SAAS,CACX,GAAG,eAAe,OAAO,IAAI,GAC7B,GAAG,OAAO,KAAK,UAAU,SAAS,UAAU,UAAU;EAClD,GAAG,mBAAmB,SAAS,QAAQ,aAAa,OAAO,KAAK,EAAE,QAAQ;EAC1E,IAAI,SAAS,SAAS,CAAC,EAAA,CAAG,SAAS,MAAM,cACrC,mBACI,KAAK,QACL,aAAa,OAAO,KAAK,EAAE,SAAS,OAAO,SAAS,EAAE,QAC1D,CACJ;EACA,IAAI,SAAS,WAAW,CAAC,EAAA,CAAG,SAAS,QAAQ,gBACzC,mBACI,OAAO,UAAU,CAAC,GAClB,aAAa,OAAO,KAAK,EAAE,WAAW,OAAO,WAAW,EAAE,QAC9D,CACJ;CACJ,CAAC,CACL;CACA,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D;;;;;AAMA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,WAAW,OAAO,KAAK,eAAe,KAAA,GAC9C,OAAO;CAEX,MAAM,SAAS,eAAe,OAAO,KAAK,UAAU,CAAC,CAAC,KAAK,WAAW;EAClE,GAAG;EACH,MAAM,MAAM,SAAS,KAAK,eAAe,cAAc,MAAM;CACjE,EAAE;CACF,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D"}
package/dist/values.d.ts CHANGED
@@ -1,6 +1,10 @@
1
1
  /** Reads a value at a dot path (`blocks.2.title.fr`). */
2
2
  export declare function getValue(values: unknown, path: string): unknown;
3
- /** Whether a value counts as filled: not null, not an empty or blank string, not an empty array or object. */
3
+ /**
4
+ * Whether a value counts as filled: not null, not an empty or blank string, not an empty array or
5
+ * plain object. A file (`Blob`, `File`, even empty) is filled. Other collections count by their
6
+ * `length` or `size` (an empty `FileList`, `Map` or `Set` isn't filled); other objects are filled.
7
+ */
4
8
  export declare function isFilled(value: unknown): boolean;
5
9
  export declare function isRecord(value: unknown): value is Record<string, unknown>;
6
10
  export declare function isEqual(a: unknown, b: unknown): boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"values.d.ts","sourceRoot":"","sources":["../src/values.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAU/D;AAED,8GAA8G;AAC9G,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAchD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAQvD"}
1
+ {"version":3,"file":"values.d.ts","sourceRoot":"","sources":["../src/values.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAU/D;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAyBhD;AAOD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAQvD"}
package/dist/values.js CHANGED
@@ -7,14 +7,28 @@ function getValue(values, path) {
7
7
  return current[key];
8
8
  }, values);
9
9
  }
10
- /** Whether a value counts as filled: not null, not an empty or blank string, not an empty array or object. */
10
+ /**
11
+ * Whether a value counts as filled: not null, not an empty or blank string, not an empty array or
12
+ * plain object. A file (`Blob`, `File`, even empty) is filled. Other collections count by their
13
+ * `length` or `size` (an empty `FileList`, `Map` or `Set` isn't filled); other objects are filled.
14
+ */
11
15
  function isFilled(value) {
12
16
  if (value === null || value === void 0) return false;
13
17
  if (typeof value === "string") return value.trim() !== "";
14
18
  if (Array.isArray(value)) return value.length > 0;
15
- if (typeof value === "object") return Object.keys(value).length > 0;
19
+ if (typeof value === "object") {
20
+ if (typeof Blob !== "undefined" && value instanceof Blob) return true;
21
+ if (isPlainObject(value)) return Object.keys(value).length > 0;
22
+ const { length, size } = value;
23
+ if (typeof length === "number") return length > 0;
24
+ return typeof size === "number" ? size > 0 : true;
25
+ }
16
26
  return true;
17
27
  }
28
+ function isPlainObject(value) {
29
+ const prototype = Object.getPrototypeOf(value);
30
+ return prototype === Object.prototype || prototype === null;
31
+ }
18
32
  function isRecord(value) {
19
33
  return value !== null && typeof value === "object" && !Array.isArray(value);
20
34
  }
@@ -1 +1 @@
1
- {"version":3,"file":"values.js","names":[],"sources":["../src/values.ts"],"sourcesContent":["/** Reads a value at a dot path (`blocks.2.title.fr`). */\nexport function getValue(values: unknown, path: string): unknown {\n if (path === '') {\n return values;\n }\n return path.split('.').reduce<unknown>((current, key) => {\n if (current === null || typeof current !== 'object') {\n return undefined;\n }\n return (current as Record<string, unknown>)[key];\n }, values);\n}\n\n/** Whether a value counts as filled: not null, not an empty or blank string, not an empty array or object. */\nexport function isFilled(value: unknown): boolean {\n if (value === null || value === undefined) {\n return false;\n }\n if (typeof value === 'string') {\n return value.trim() !== '';\n }\n if (Array.isArray(value)) {\n return value.length > 0;\n }\n if (typeof value === 'object') {\n return Object.keys(value).length > 0;\n }\n return true;\n}\n\nexport function isRecord(value: unknown): value is Record<string, unknown> {\n return value !== null && typeof value === 'object' && !Array.isArray(value);\n}\n\nexport function isEqual(a: unknown, b: unknown): boolean {\n if (a === b) {\n return true;\n }\n if (typeof a !== 'object' || typeof b !== 'object' || a === null || b === null) {\n return false;\n }\n return JSON.stringify(a) === JSON.stringify(b);\n}\n"],"mappings":";;AACA,SAAgB,SAAS,QAAiB,MAAuB;CAC7D,IAAI,SAAS,IACT,OAAO;CAEX,OAAO,KAAK,MAAM,GAAG,CAAC,CAAC,QAAiB,SAAS,QAAQ;EACrD,IAAI,YAAY,QAAQ,OAAO,YAAY,UACvC;EAEJ,OAAQ,QAAoC;CAChD,GAAG,MAAM;AACb;;AAGA,SAAgB,SAAS,OAAyB;CAC9C,IAAI,UAAU,QAAQ,UAAU,KAAA,GAC5B,OAAO;CAEX,IAAI,OAAO,UAAU,UACjB,OAAO,MAAM,KAAK,MAAM;CAE5B,IAAI,MAAM,QAAQ,KAAK,GACnB,OAAO,MAAM,SAAS;CAE1B,IAAI,OAAO,UAAU,UACjB,OAAO,OAAO,KAAK,KAAK,CAAC,CAAC,SAAS;CAEvC,OAAO;AACX;AAEA,SAAgB,SAAS,OAAkD;CACvE,OAAO,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK;AAC9E;AAEA,SAAgB,QAAQ,GAAY,GAAqB;CACrD,IAAI,MAAM,GACN,OAAO;CAEX,IAAI,OAAO,MAAM,YAAY,OAAO,MAAM,YAAY,MAAM,QAAQ,MAAM,MACtE,OAAO;CAEX,OAAO,KAAK,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC;AACjD"}
1
+ {"version":3,"file":"values.js","names":[],"sources":["../src/values.ts"],"sourcesContent":["/** Reads a value at a dot path (`blocks.2.title.fr`). */\nexport function getValue(values: unknown, path: string): unknown {\n if (path === '') {\n return values;\n }\n return path.split('.').reduce<unknown>((current, key) => {\n if (current === null || typeof current !== 'object') {\n return undefined;\n }\n return (current as Record<string, unknown>)[key];\n }, values);\n}\n\n/**\n * Whether a value counts as filled: not null, not an empty or blank string, not an empty array or\n * plain object. A file (`Blob`, `File`, even empty) is filled. Other collections count by their\n * `length` or `size` (an empty `FileList`, `Map` or `Set` isn't filled); other objects are filled.\n */\nexport function isFilled(value: unknown): boolean {\n if (value === null || value === undefined) {\n return false;\n }\n if (typeof value === 'string') {\n return value.trim() !== '';\n }\n if (Array.isArray(value)) {\n return value.length > 0;\n }\n if (typeof value === 'object') {\n if (typeof Blob !== 'undefined' && value instanceof Blob) {\n return true;\n }\n // A chosen file has no own keys: only plain objects are empty without them.\n if (isPlainObject(value)) {\n return Object.keys(value).length > 0;\n }\n const { length, size } = value as { length?: unknown; size?: unknown };\n if (typeof length === 'number') {\n return length > 0;\n }\n return typeof size === 'number' ? size > 0 : true;\n }\n return true;\n}\n\nfunction isPlainObject(value: object): boolean {\n const prototype: unknown = Object.getPrototypeOf(value);\n return prototype === Object.prototype || prototype === null;\n}\n\nexport function isRecord(value: unknown): value is Record<string, unknown> {\n return value !== null && typeof value === 'object' && !Array.isArray(value);\n}\n\nexport function isEqual(a: unknown, b: unknown): boolean {\n if (a === b) {\n return true;\n }\n if (typeof a !== 'object' || typeof b !== 'object' || a === null || b === null) {\n return false;\n }\n return JSON.stringify(a) === JSON.stringify(b);\n}\n"],"mappings":";;AACA,SAAgB,SAAS,QAAiB,MAAuB;CAC7D,IAAI,SAAS,IACT,OAAO;CAEX,OAAO,KAAK,MAAM,GAAG,CAAC,CAAC,QAAiB,SAAS,QAAQ;EACrD,IAAI,YAAY,QAAQ,OAAO,YAAY,UACvC;EAEJ,OAAQ,QAAoC;CAChD,GAAG,MAAM;AACb;;;;;;AAOA,SAAgB,SAAS,OAAyB;CAC9C,IAAI,UAAU,QAAQ,UAAU,KAAA,GAC5B,OAAO;CAEX,IAAI,OAAO,UAAU,UACjB,OAAO,MAAM,KAAK,MAAM;CAE5B,IAAI,MAAM,QAAQ,KAAK,GACnB,OAAO,MAAM,SAAS;CAE1B,IAAI,OAAO,UAAU,UAAU;EAC3B,IAAI,OAAO,SAAS,eAAe,iBAAiB,MAChD,OAAO;EAGX,IAAI,cAAc,KAAK,GACnB,OAAO,OAAO,KAAK,KAAK,CAAC,CAAC,SAAS;EAEvC,MAAM,EAAE,QAAQ,SAAS;EACzB,IAAI,OAAO,WAAW,UAClB,OAAO,SAAS;EAEpB,OAAO,OAAO,SAAS,WAAW,OAAO,IAAI;CACjD;CACA,OAAO;AACX;AAEA,SAAS,cAAc,OAAwB;CAC3C,MAAM,YAAqB,OAAO,eAAe,KAAK;CACtD,OAAO,cAAc,OAAO,aAAa,cAAc;AAC3D;AAEA,SAAgB,SAAS,OAAkD;CACvE,OAAO,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK;AAC9E;AAEA,SAAgB,QAAQ,GAAY,GAAqB;CACrD,IAAI,MAAM,GACN,OAAO;CAEX,IAAI,OAAO,MAAM,YAAY,OAAO,MAAM,YAAY,MAAM,QAAQ,MAAM,MACtE,OAAO;CAEX,OAAO,KAAK,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC;AACjD"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@panneau/protocol",
3
- "version": "5.0.0-alpha.0",
3
+ "version": "5.0.0-alpha.10",
4
4
  "description": "The Panneau protocol: definition schema, HTTP API spec and conformance kit",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -16,6 +16,11 @@
16
16
  "types": "./dist/index.d.ts",
17
17
  "default": "./dist/index.js"
18
18
  },
19
+ "./runtime": {
20
+ "@panneau/source": "./src/runtime/index.ts",
21
+ "types": "./dist/runtime/index.d.ts",
22
+ "default": "./dist/runtime/index.js"
23
+ },
19
24
  "./mock": {
20
25
  "@panneau/source": "./src/mock/index.ts",
21
26
  "types": "./dist/mock/index.d.ts",
@@ -29,6 +34,7 @@
29
34
  "./definition.schema.json": "./schema/definition.schema.json",
30
35
  "./openapi.json": "./schema/openapi.json",
31
36
  "./boot.schema.json": "./schema/boot.schema.json",
37
+ "./theme.schema.json": "./schema/theme.schema.json",
32
38
  "./package.json": "./package.json"
33
39
  },
34
40
  "files": [
@@ -36,14 +42,17 @@
36
42
  "schema"
37
43
  ],
38
44
  "scripts": {
39
- "build": "vite build && tsc -p tsconfig.build.json && node scripts/generate-schemas.js",
45
+ "build": "vite build && node ../../scripts/declarations.js && node scripts/generate-schemas.js",
40
46
  "typecheck": "tsc --noEmit",
41
- "api": "tsc -p tsconfig.build.json && node ../../scripts/api-report.js"
47
+ "api": "node ../../scripts/declarations.js && node ../../scripts/api-report.js"
42
48
  },
43
49
  "publishConfig": {
44
50
  "access": "public"
45
51
  },
46
52
  "dependencies": {
47
53
  "zod": "^4.6.7"
54
+ },
55
+ "devDependencies": {
56
+ "ajv": "^8.18.0"
48
57
  }
49
58
  }