@panneau/protocol 5.0.0-alpha.4 → 5.0.0-alpha.5

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 (66) hide show
  1. package/dist/conformance/index.d.ts.map +1 -1
  2. package/dist/conformance/index.js +121 -1
  3. package/dist/conformance/index.js.map +1 -1
  4. package/dist/constants.d.ts +2 -2
  5. package/dist/constants.d.ts.map +1 -1
  6. package/dist/constants.js +3 -1
  7. package/dist/constants.js.map +1 -1
  8. package/dist/index.js +5 -2
  9. package/dist/libraries.d.ts +16 -0
  10. package/dist/libraries.d.ts.map +1 -0
  11. package/dist/libraries.js +15 -0
  12. package/dist/libraries.js.map +1 -0
  13. package/dist/lint.d.ts +2 -2
  14. package/dist/lint.d.ts.map +1 -1
  15. package/dist/lint.js +15 -9
  16. package/dist/lint.js.map +1 -1
  17. package/dist/mock/example.d.ts.map +1 -1
  18. package/dist/mock/example.js +8 -0
  19. package/dist/mock/example.js.map +1 -1
  20. package/dist/mock/index.d.ts +9 -1
  21. package/dist/mock/index.d.ts.map +1 -1
  22. package/dist/mock/index.js +119 -13
  23. package/dist/mock/index.js.map +1 -1
  24. package/dist/openapi.d.ts.map +1 -1
  25. package/dist/openapi.js +37 -7
  26. package/dist/openapi.js.map +1 -1
  27. package/dist/rules.d.ts.map +1 -1
  28. package/dist/rules.js +17 -0
  29. package/dist/rules.js.map +1 -1
  30. package/dist/runtime/index.d.ts +3 -0
  31. package/dist/runtime/index.d.ts.map +1 -1
  32. package/dist/runtime/index.js +4 -1
  33. package/dist/schemas/action.d.ts +17 -1
  34. package/dist/schemas/action.d.ts.map +1 -1
  35. package/dist/schemas/api.d.ts +87 -0
  36. package/dist/schemas/api.d.ts.map +1 -1
  37. package/dist/schemas/api.js +28 -9
  38. package/dist/schemas/api.js.map +1 -1
  39. package/dist/schemas/definition.d.ts +38 -2
  40. package/dist/schemas/definition.d.ts.map +1 -1
  41. package/dist/schemas/definition.js +2 -1
  42. package/dist/schemas/definition.js.map +1 -1
  43. package/dist/schemas/field.d.ts +24 -1
  44. package/dist/schemas/field.d.ts.map +1 -1
  45. package/dist/schemas/field.js +22 -4
  46. package/dist/schemas/field.js.map +1 -1
  47. package/dist/schemas/index.d.ts +201 -6
  48. package/dist/schemas/index.d.ts.map +1 -1
  49. package/dist/schemas/index.js +4 -2
  50. package/dist/schemas/index.js.map +1 -1
  51. package/dist/schemas/resource.d.ts +36 -2
  52. package/dist/schemas/resource.d.ts.map +1 -1
  53. package/dist/schemas/resource.js +3 -1
  54. package/dist/schemas/resource.js.map +1 -1
  55. package/dist/search.d.ts +51 -0
  56. package/dist/search.d.ts.map +1 -0
  57. package/dist/search.js +53 -0
  58. package/dist/search.js.map +1 -0
  59. package/dist/transforms.d.ts +17 -0
  60. package/dist/transforms.d.ts.map +1 -0
  61. package/dist/transforms.js +34 -0
  62. package/dist/transforms.js.map +1 -0
  63. package/package.json +1 -1
  64. package/schema/boot.schema.json +80 -1
  65. package/schema/definition.schema.json +80 -1
  66. package/schema/openapi.json +342 -13
package/dist/schemas/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { z } from 'zod';
2
+ import { MediaTransform } from './api';
2
3
  import { Condition } from './common';
3
4
  import { MenuItem } from './definition';
4
5
  import { BlockType, Field } from './field';
@@ -78,6 +79,13 @@ export declare const namedSchemas: {
78
79
  field: z.ZodString;
79
80
  }, z.core.$loose>]>;
80
81
  message: z.ZodOptional<z.ZodString>;
82
+ }, z.core.$loose>, z.ZodObject<{
83
+ rule: z.ZodLiteral<"crop">;
84
+ value: z.ZodObject<{
85
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
86
+ required: z.ZodOptional<z.ZodBoolean>;
87
+ }, z.core.$loose>;
88
+ message: z.ZodOptional<z.ZodString>;
81
89
  }, z.core.$loose>, z.ZodObject<{
82
90
  rule: z.ZodString;
83
91
  message: z.ZodOptional<z.ZodString>;
@@ -141,6 +149,13 @@ export declare const namedSchemas: {
141
149
  field: z.ZodString;
142
150
  }, z.core.$loose>]>;
143
151
  message: z.ZodOptional<z.ZodString>;
152
+ }, z.core.$loose>, z.ZodObject<{
153
+ rule: z.ZodLiteral<"crop">;
154
+ value: z.ZodObject<{
155
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
156
+ required: z.ZodOptional<z.ZodBoolean>;
157
+ }, z.core.$loose>;
158
+ message: z.ZodOptional<z.ZodString>;
144
159
  }, z.core.$loose>, z.ZodObject<{
145
160
  rule: z.ZodString;
146
161
  message: z.ZodOptional<z.ZodString>;
@@ -161,9 +176,18 @@ export declare const namedSchemas: {
161
176
  disabled: z.ZodOptional<z.ZodBoolean>;
162
177
  }, z.core.$loose>>>;
163
178
  multiple: z.ZodOptional<z.ZodBoolean>;
164
- resource: z.ZodOptional<z.ZodString>;
179
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
165
180
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
181
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
182
+ rotate: z.ZodOptional<z.ZodBoolean>;
183
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
184
+ transformBase: z.ZodOptional<z.ZodEnum<{
185
+ media: "media";
186
+ original: "original";
187
+ choose: "choose";
188
+ }>>;
166
189
  from: z.ZodOptional<z.ZodString>;
190
+ check: z.ZodOptional<z.ZodBoolean>;
167
191
  display: z.ZodOptional<z.ZodString>;
168
192
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
169
193
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -352,6 +376,13 @@ export declare const namedSchemas: {
352
376
  field: z.ZodString;
353
377
  }, z.core.$loose>]>;
354
378
  message: z.ZodOptional<z.ZodString>;
379
+ }, z.core.$loose>, z.ZodObject<{
380
+ rule: z.ZodLiteral<"crop">;
381
+ value: z.ZodObject<{
382
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
383
+ required: z.ZodOptional<z.ZodBoolean>;
384
+ }, z.core.$loose>;
385
+ message: z.ZodOptional<z.ZodString>;
355
386
  }, z.core.$loose>, z.ZodObject<{
356
387
  rule: z.ZodString;
357
388
  message: z.ZodOptional<z.ZodString>;
@@ -372,9 +403,18 @@ export declare const namedSchemas: {
372
403
  disabled: z.ZodOptional<z.ZodBoolean>;
373
404
  }, z.core.$loose>>>;
374
405
  multiple: z.ZodOptional<z.ZodBoolean>;
375
- resource: z.ZodOptional<z.ZodString>;
406
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
376
407
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
408
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
409
+ rotate: z.ZodOptional<z.ZodBoolean>;
410
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
411
+ transformBase: z.ZodOptional<z.ZodEnum<{
412
+ media: "media";
413
+ original: "original";
414
+ choose: "choose";
415
+ }>>;
377
416
  from: z.ZodOptional<z.ZodString>;
417
+ check: z.ZodOptional<z.ZodBoolean>;
378
418
  display: z.ZodOptional<z.ZodString>;
379
419
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
380
420
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -431,6 +471,8 @@ export declare const namedSchemas: {
431
471
  description: z.ZodOptional<z.ZodString>;
432
472
  icon: z.ZodOptional<z.ZodString>;
433
473
  itemTitle: z.ZodOptional<z.ZodString>;
474
+ itemSubtitle: z.ZodOptional<z.ZodString>;
475
+ itemImage: z.ZodOptional<z.ZodString>;
434
476
  fields: z.ZodArray<z.ZodObject<{
435
477
  name: z.ZodString;
436
478
  type: z.ZodString;
@@ -484,6 +526,13 @@ export declare const namedSchemas: {
484
526
  field: z.ZodString;
485
527
  }, z.core.$loose>]>;
486
528
  message: z.ZodOptional<z.ZodString>;
529
+ }, z.core.$loose>, z.ZodObject<{
530
+ rule: z.ZodLiteral<"crop">;
531
+ value: z.ZodObject<{
532
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
533
+ required: z.ZodOptional<z.ZodBoolean>;
534
+ }, z.core.$loose>;
535
+ message: z.ZodOptional<z.ZodString>;
487
536
  }, z.core.$loose>, z.ZodObject<{
488
537
  rule: z.ZodString;
489
538
  message: z.ZodOptional<z.ZodString>;
@@ -504,9 +553,18 @@ export declare const namedSchemas: {
504
553
  disabled: z.ZodOptional<z.ZodBoolean>;
505
554
  }, z.core.$loose>>>;
506
555
  multiple: z.ZodOptional<z.ZodBoolean>;
507
- resource: z.ZodOptional<z.ZodString>;
556
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
508
557
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
558
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
559
+ rotate: z.ZodOptional<z.ZodBoolean>;
560
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
561
+ transformBase: z.ZodOptional<z.ZodEnum<{
562
+ media: "media";
563
+ original: "original";
564
+ choose: "choose";
565
+ }>>;
509
566
  from: z.ZodOptional<z.ZodString>;
567
+ check: z.ZodOptional<z.ZodBoolean>;
510
568
  display: z.ZodOptional<z.ZodString>;
511
569
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
512
570
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -653,6 +711,13 @@ export declare const namedSchemas: {
653
711
  field: z.ZodString;
654
712
  }, z.core.$loose>]>;
655
713
  message: z.ZodOptional<z.ZodString>;
714
+ }, z.core.$loose>, z.ZodObject<{
715
+ rule: z.ZodLiteral<"crop">;
716
+ value: z.ZodObject<{
717
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
718
+ required: z.ZodOptional<z.ZodBoolean>;
719
+ }, z.core.$loose>;
720
+ message: z.ZodOptional<z.ZodString>;
656
721
  }, z.core.$loose>, z.ZodObject<{
657
722
  rule: z.ZodString;
658
723
  message: z.ZodOptional<z.ZodString>;
@@ -673,9 +738,18 @@ export declare const namedSchemas: {
673
738
  disabled: z.ZodOptional<z.ZodBoolean>;
674
739
  }, z.core.$loose>>>;
675
740
  multiple: z.ZodOptional<z.ZodBoolean>;
676
- resource: z.ZodOptional<z.ZodString>;
741
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
677
742
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
743
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
744
+ rotate: z.ZodOptional<z.ZodBoolean>;
745
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
746
+ transformBase: z.ZodOptional<z.ZodEnum<{
747
+ media: "media";
748
+ original: "original";
749
+ choose: "choose";
750
+ }>>;
678
751
  from: z.ZodOptional<z.ZodString>;
752
+ check: z.ZodOptional<z.ZodBoolean>;
679
753
  display: z.ZodOptional<z.ZodString>;
680
754
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
681
755
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -737,6 +811,7 @@ export declare const namedSchemas: {
737
811
  email: z.ZodOptional<z.ZodString>;
738
812
  avatarUrl: z.ZodOptional<z.ZodString>;
739
813
  abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
814
+ resource: z.ZodOptional<z.ZodString>;
740
815
  }, z.core.$loose>;
741
816
  AuthProvider: z.ZodObject<{
742
817
  id: z.ZodString;
@@ -981,6 +1056,8 @@ export declare const namedSchemas: {
981
1056
  description: z.ZodOptional<z.ZodString>;
982
1057
  icon: z.ZodOptional<z.ZodString>;
983
1058
  itemTitle: z.ZodOptional<z.ZodString>;
1059
+ itemSubtitle: z.ZodOptional<z.ZodString>;
1060
+ itemImage: z.ZodOptional<z.ZodString>;
984
1061
  fields: z.ZodArray<z.ZodObject<{
985
1062
  name: z.ZodString;
986
1063
  type: z.ZodString;
@@ -1034,6 +1111,13 @@ export declare const namedSchemas: {
1034
1111
  field: z.ZodString;
1035
1112
  }, z.core.$loose>]>;
1036
1113
  message: z.ZodOptional<z.ZodString>;
1114
+ }, z.core.$loose>, z.ZodObject<{
1115
+ rule: z.ZodLiteral<"crop">;
1116
+ value: z.ZodObject<{
1117
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
1118
+ required: z.ZodOptional<z.ZodBoolean>;
1119
+ }, z.core.$loose>;
1120
+ message: z.ZodOptional<z.ZodString>;
1037
1121
  }, z.core.$loose>, z.ZodObject<{
1038
1122
  rule: z.ZodString;
1039
1123
  message: z.ZodOptional<z.ZodString>;
@@ -1054,9 +1138,18 @@ export declare const namedSchemas: {
1054
1138
  disabled: z.ZodOptional<z.ZodBoolean>;
1055
1139
  }, z.core.$loose>>>;
1056
1140
  multiple: z.ZodOptional<z.ZodBoolean>;
1057
- resource: z.ZodOptional<z.ZodString>;
1141
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
1058
1142
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
1143
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
1144
+ rotate: z.ZodOptional<z.ZodBoolean>;
1145
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
1146
+ transformBase: z.ZodOptional<z.ZodEnum<{
1147
+ media: "media";
1148
+ original: "original";
1149
+ choose: "choose";
1150
+ }>>;
1059
1151
  from: z.ZodOptional<z.ZodString>;
1152
+ check: z.ZodOptional<z.ZodBoolean>;
1060
1153
  display: z.ZodOptional<z.ZodString>;
1061
1154
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
1062
1155
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -1203,6 +1296,13 @@ export declare const namedSchemas: {
1203
1296
  field: z.ZodString;
1204
1297
  }, z.core.$loose>]>;
1205
1298
  message: z.ZodOptional<z.ZodString>;
1299
+ }, z.core.$loose>, z.ZodObject<{
1300
+ rule: z.ZodLiteral<"crop">;
1301
+ value: z.ZodObject<{
1302
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
1303
+ required: z.ZodOptional<z.ZodBoolean>;
1304
+ }, z.core.$loose>;
1305
+ message: z.ZodOptional<z.ZodString>;
1206
1306
  }, z.core.$loose>, z.ZodObject<{
1207
1307
  rule: z.ZodString;
1208
1308
  message: z.ZodOptional<z.ZodString>;
@@ -1223,9 +1323,18 @@ export declare const namedSchemas: {
1223
1323
  disabled: z.ZodOptional<z.ZodBoolean>;
1224
1324
  }, z.core.$loose>>>;
1225
1325
  multiple: z.ZodOptional<z.ZodBoolean>;
1226
- resource: z.ZodOptional<z.ZodString>;
1326
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
1227
1327
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
1328
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
1329
+ rotate: z.ZodOptional<z.ZodBoolean>;
1330
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
1331
+ transformBase: z.ZodOptional<z.ZodEnum<{
1332
+ media: "media";
1333
+ original: "original";
1334
+ choose: "choose";
1335
+ }>>;
1228
1336
  from: z.ZodOptional<z.ZodString>;
1337
+ check: z.ZodOptional<z.ZodBoolean>;
1229
1338
  display: z.ZodOptional<z.ZodString>;
1230
1339
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
1231
1340
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -1403,6 +1512,7 @@ export declare const namedSchemas: {
1403
1512
  email: z.ZodOptional<z.ZodString>;
1404
1513
  avatarUrl: z.ZodOptional<z.ZodString>;
1405
1514
  abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
1515
+ resource: z.ZodOptional<z.ZodString>;
1406
1516
  }, z.core.$loose>>>;
1407
1517
  }, z.core.$loose>;
1408
1518
  Item: z.ZodObject<{
@@ -1623,6 +1733,11 @@ export declare const namedSchemas: {
1623
1733
  x: z.ZodNumber;
1624
1734
  y: z.ZodNumber;
1625
1735
  }, z.core.$loose>>;
1736
+ base: z.ZodOptional<z.ZodEnum<{
1737
+ media: "media";
1738
+ original: "original";
1739
+ }>>;
1740
+ baseTransform: z.ZodOptional<typeof MediaTransform>;
1626
1741
  }, z.core.$loose>;
1627
1742
  StoredFile: z.ZodObject<{
1628
1743
  name: z.ZodString;
@@ -1668,6 +1783,19 @@ export declare const namedSchemas: {
1668
1783
  headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
1669
1784
  upload: z.ZodOptional<z.ZodString>;
1670
1785
  }, z.core.$loose>;
1786
+ FieldCheckRequest: z.ZodObject<{
1787
+ value: z.ZodString;
1788
+ locale: z.ZodOptional<z.ZodString>;
1789
+ id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1790
+ values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1791
+ }, z.core.$loose>;
1792
+ FieldCheckResponse: z.ZodObject<{
1793
+ available: z.ZodBoolean;
1794
+ suggestion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1795
+ prefix: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1796
+ url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1797
+ disabled: z.ZodOptional<z.ZodBoolean>;
1798
+ }, z.core.$loose>;
1671
1799
  MediaInfo: z.ZodObject<{
1672
1800
  type: z.ZodString;
1673
1801
  mime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1689,6 +1817,26 @@ export declare const namedSchemas: {
1689
1817
  ready: "ready";
1690
1818
  }>>;
1691
1819
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1820
+ transform: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1821
+ crop: z.ZodOptional<z.ZodObject<{
1822
+ x: z.ZodNumber;
1823
+ y: z.ZodNumber;
1824
+ width: z.ZodNumber;
1825
+ height: z.ZodNumber;
1826
+ }, z.core.$loose>>;
1827
+ rotate: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<90>, z.ZodLiteral<180>, z.ZodLiteral<270>]>>;
1828
+ flipX: z.ZodOptional<z.ZodBoolean>;
1829
+ flipY: z.ZodOptional<z.ZodBoolean>;
1830
+ focalPoint: z.ZodOptional<z.ZodObject<{
1831
+ x: z.ZodNumber;
1832
+ y: z.ZodNumber;
1833
+ }, z.core.$loose>>;
1834
+ base: z.ZodOptional<z.ZodEnum<{
1835
+ media: "media";
1836
+ original: "original";
1837
+ }>>;
1838
+ baseTransform: z.ZodOptional<typeof MediaTransform>;
1839
+ }, z.core.$loose>>>;
1692
1840
  }, z.core.$loose>;
1693
1841
  MediaItem: z.ZodObject<{
1694
1842
  id: z.ZodString;
@@ -1715,10 +1863,31 @@ export declare const namedSchemas: {
1715
1863
  ready: "ready";
1716
1864
  }>>;
1717
1865
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1866
+ transform: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1867
+ crop: z.ZodOptional<z.ZodObject<{
1868
+ x: z.ZodNumber;
1869
+ y: z.ZodNumber;
1870
+ width: z.ZodNumber;
1871
+ height: z.ZodNumber;
1872
+ }, z.core.$loose>>;
1873
+ rotate: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<90>, z.ZodLiteral<180>, z.ZodLiteral<270>]>>;
1874
+ flipX: z.ZodOptional<z.ZodBoolean>;
1875
+ flipY: z.ZodOptional<z.ZodBoolean>;
1876
+ focalPoint: z.ZodOptional<z.ZodObject<{
1877
+ x: z.ZodNumber;
1878
+ y: z.ZodNumber;
1879
+ }, z.core.$loose>>;
1880
+ base: z.ZodOptional<z.ZodEnum<{
1881
+ media: "media";
1882
+ original: "original";
1883
+ }>>;
1884
+ baseTransform: z.ZodOptional<typeof MediaTransform>;
1885
+ }, z.core.$loose>>>;
1718
1886
  }, z.core.$loose>;
1719
1887
  }, z.core.$loose>;
1720
1888
  MediaReference: z.ZodObject<{
1721
1889
  id: z.ZodString;
1890
+ resource: z.ZodOptional<z.ZodString>;
1722
1891
  label: z.ZodOptional<z.ZodString>;
1723
1892
  media: z.ZodOptional<z.ZodObject<{
1724
1893
  type: z.ZodString;
@@ -1741,6 +1910,26 @@ export declare const namedSchemas: {
1741
1910
  ready: "ready";
1742
1911
  }>>;
1743
1912
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1913
+ transform: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1914
+ crop: z.ZodOptional<z.ZodObject<{
1915
+ x: z.ZodNumber;
1916
+ y: z.ZodNumber;
1917
+ width: z.ZodNumber;
1918
+ height: z.ZodNumber;
1919
+ }, z.core.$loose>>;
1920
+ rotate: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<90>, z.ZodLiteral<180>, z.ZodLiteral<270>]>>;
1921
+ flipX: z.ZodOptional<z.ZodBoolean>;
1922
+ flipY: z.ZodOptional<z.ZodBoolean>;
1923
+ focalPoint: z.ZodOptional<z.ZodObject<{
1924
+ x: z.ZodNumber;
1925
+ y: z.ZodNumber;
1926
+ }, z.core.$loose>>;
1927
+ base: z.ZodOptional<z.ZodEnum<{
1928
+ media: "media";
1929
+ original: "original";
1930
+ }>>;
1931
+ baseTransform: z.ZodOptional<typeof MediaTransform>;
1932
+ }, z.core.$loose>>>;
1744
1933
  }, z.core.$loose>>;
1745
1934
  transform: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1746
1935
  crop: z.ZodOptional<z.ZodObject<{
@@ -1756,6 +1945,11 @@ export declare const namedSchemas: {
1756
1945
  x: z.ZodNumber;
1757
1946
  y: z.ZodNumber;
1758
1947
  }, z.core.$loose>>;
1948
+ base: z.ZodOptional<z.ZodEnum<{
1949
+ media: "media";
1950
+ original: "original";
1951
+ }>>;
1952
+ baseTransform: z.ZodOptional<typeof MediaTransform>;
1759
1953
  }, z.core.$loose>>>;
1760
1954
  }, z.core.$loose>;
1761
1955
  Session: z.ZodObject<{
@@ -1765,6 +1959,7 @@ export declare const namedSchemas: {
1765
1959
  email: z.ZodOptional<z.ZodString>;
1766
1960
  avatarUrl: z.ZodOptional<z.ZodString>;
1767
1961
  abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
1962
+ resource: z.ZodOptional<z.ZodString>;
1768
1963
  }, z.core.$loose>;
1769
1964
  }, z.core.$loose>;
1770
1965
  SearchResponse: z.ZodObject<{
package/dist/schemas/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AA6BxB,OAAO,EAAa,SAAS,EAA8B,MAAM,UAAU,CAAC;AAC5E,OAAO,EAIH,QAAQ,EAKX,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AActC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AAEvB,wGAAwG;AACxG,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2DY,CAAC;AAEtC,0FAA0F;AAC1F,wBAAgB,oBAAoB;QACE,MAAM;kFAG3C"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAcH,cAAc,EAajB,MAAM,OAAO,CAAC;AACf,OAAO,EAAa,SAAS,EAA8B,MAAM,UAAU,CAAC;AAC5E,OAAO,EAIH,QAAQ,EAKX,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AActC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AAEvB,wGAAwG;AACxG,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6DY,CAAC;AAEtC,0FAA0F;AAC1F,wBAAgB,oBAAoB;QACE,MAAM;kFAG3C"}
package/dist/schemas/index.js CHANGED
@@ -6,7 +6,7 @@ import { Column, Filter, ListDefinition } from "./list.js";
6
6
  import { Resource, ResourceFeatures } from "./resource.js";
7
7
  import { DefinitionTheme, Theme, ThemeFont, ThemeFontFace, ThemeFontStylesheet, ThemeTokens, ToneInput, ToneValues } from "./theme.js";
8
8
  import { Auth, AuthProvider, Definition, MenuItem, Page, Uploads, User, Widget } from "./definition.js";
9
- import { ActionItemResult, ActionRequest, ActionResult, ActionRun, ActionRunResponse, Item, ItemResponse, ListResponse, MediaInfo, MediaItem, MediaReference, MediaTransform, Pagination, PreviewResponse, Problem, SearchResponse, Selection, Session, StoredFile, Upload, UploadReference, UploadResponse, UploadSignRequest, UploadSignResponse } from "./api.js";
9
+ import { ActionItemResult, ActionRequest, ActionResult, ActionRun, ActionRunResponse, FieldCheckRequest, FieldCheckResponse, Item, ItemResponse, ListResponse, MediaInfo, MediaItem, MediaReference, MediaTransform, Pagination, PreviewResponse, Problem, SearchResponse, Selection, Session, StoredFile, Upload, UploadReference, UploadResponse, UploadSignRequest, UploadSignResponse } from "./api.js";
10
10
  import { BootConfig } from "./boot.js";
11
11
  import { z } from "zod";
12
12
  //#region src/schemas/index.ts
@@ -64,6 +64,8 @@ var namedSchemas = {
64
64
  UploadResponse,
65
65
  UploadSignRequest,
66
66
  UploadSignResponse,
67
+ FieldCheckRequest,
68
+ FieldCheckResponse,
67
69
  MediaInfo,
68
70
  MediaItem,
69
71
  MediaReference,
@@ -78,6 +80,6 @@ function createSchemaRegistry() {
78
80
  return registry;
79
81
  }
80
82
  //#endregion
81
- export { Abilities, Action, ActionConfirm, ActionItemResult, ActionPlacement, ActionRequest, ActionResult, ActionRun, ActionRunResponse, ActionScope, Auth, AuthProvider, BlockType, BootConfig, Column, Condition, Definition, DefinitionTheme, Field, Filter, Id, Item, ItemResponse, LayoutNode, ListDefinition, ListResponse, MediaInfo, MediaItem, MediaReference, MediaTransform, MenuItem, Option, Page, Pagination, PreviewResponse, Problem, Resource, ResourceFeatures, RouteReference, Rule, SearchResponse, Selection, Session, StoredFile, Theme, ThemeFont, ThemeFontFace, ThemeFontStylesheet, ThemeTokens, ToneInput, ToneValues, Upload, UploadReference, UploadResponse, UploadSignRequest, UploadSignResponse, Uploads, User, Widget, createSchemaRegistry, namedSchemas };
83
+ export { Abilities, Action, ActionConfirm, ActionItemResult, ActionPlacement, ActionRequest, ActionResult, ActionRun, ActionRunResponse, ActionScope, Auth, AuthProvider, BlockType, BootConfig, Column, Condition, Definition, DefinitionTheme, Field, FieldCheckRequest, FieldCheckResponse, Filter, Id, Item, ItemResponse, LayoutNode, ListDefinition, ListResponse, MediaInfo, MediaItem, MediaReference, MediaTransform, MenuItem, Option, Page, Pagination, PreviewResponse, Problem, Resource, ResourceFeatures, RouteReference, Rule, SearchResponse, Selection, Session, StoredFile, Theme, ThemeFont, ThemeFontFace, ThemeFontStylesheet, ThemeTokens, ToneInput, ToneValues, Upload, UploadReference, UploadResponse, UploadSignRequest, UploadSignResponse, Uploads, User, Widget, createSchemaRegistry, namedSchemas };
82
84
 
83
85
  //# sourceMappingURL=index.js.map
package/dist/schemas/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../../src/schemas/index.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { Action, ActionConfirm, ActionPlacement, ActionScope } from './action';\nimport {\n ActionItemResult,\n ActionRequest,\n ActionResult,\n ActionRun,\n ActionRunResponse,\n Item,\n ItemResponse,\n ListResponse,\n MediaInfo,\n MediaItem,\n MediaReference,\n MediaTransform,\n Pagination,\n PreviewResponse,\n Problem,\n SearchResponse,\n Selection,\n Session,\n StoredFile,\n Upload,\n UploadReference,\n UploadResponse,\n UploadSignRequest,\n UploadSignResponse,\n} from './api';\nimport { Abilities, Condition, Id, Option, RouteReference } from './common';\nimport {\n Auth,\n AuthProvider,\n Definition,\n MenuItem,\n Page,\n Uploads,\n User,\n Widget,\n} from './definition';\nimport { BlockType, Field, Rule } from './field';\nimport { LayoutNode } from './layout';\nimport { Column, Filter, ListDefinition } from './list';\nimport { Resource, ResourceFeatures } from './resource';\nimport {\n DefinitionTheme,\n Theme,\n ThemeFont,\n ThemeFontFace,\n ThemeFontStylesheet,\n ThemeTokens,\n ToneInput,\n ToneValues,\n} from './theme';\n\nexport * from './common';\nexport * from './field';\nexport * from './layout';\nexport * from './list';\nexport * from './action';\nexport * from './resource';\nexport * from './theme';\nexport * from './definition';\nexport * from './api';\nexport * from './boot';\n\n/** The named schemas of the protocol, as they appear in the generated JSON Schema and OpenAPI files. */\nexport const namedSchemas = {\n Id,\n Abilities,\n RouteReference,\n Condition,\n Option,\n Rule,\n BlockType,\n Field,\n LayoutNode,\n Column,\n Filter,\n ListDefinition,\n ActionScope,\n ActionPlacement,\n ActionConfirm,\n Action,\n ResourceFeatures,\n Resource,\n User,\n AuthProvider,\n Auth,\n MenuItem,\n Page,\n Widget,\n Uploads,\n ThemeTokens,\n ToneValues,\n ToneInput,\n ThemeFontFace,\n ThemeFontStylesheet,\n ThemeFont,\n Theme,\n DefinitionTheme,\n Definition,\n Item,\n Pagination,\n ItemResponse,\n ListResponse,\n Problem,\n Selection,\n ActionRequest,\n ActionItemResult,\n ActionResult,\n ActionRun,\n ActionRunResponse,\n MediaTransform,\n StoredFile,\n UploadReference,\n Upload,\n UploadResponse,\n UploadSignRequest,\n UploadSignResponse,\n MediaInfo,\n MediaItem,\n MediaReference,\n Session,\n SearchResponse,\n PreviewResponse,\n} satisfies Record<string, z.ZodType>;\n\n/** A registry of the named schemas, used to reference them by name in generated files. */\nexport function createSchemaRegistry() {\n const registry = z.registry<{ id: string }>();\n Object.entries(namedSchemas).forEach(([id, schema]) => registry.add(schema, { id }));\n return registry;\n}\n"],"mappings":";;;;;;;;;;;;;AAmEA,IAAa,eAAe;CACxB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACJ;;AAGA,SAAgB,uBAAuB;CACnC,MAAM,WAAW,EAAE,SAAyB;CAC5C,OAAO,QAAQ,YAAY,CAAC,CAAC,SAAS,CAAC,IAAI,YAAY,SAAS,IAAI,QAAQ,EAAE,GAAG,CAAC,CAAC;CACnF,OAAO;AACX"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../../src/schemas/index.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { Action, ActionConfirm, ActionPlacement, ActionScope } from './action';\nimport {\n ActionItemResult,\n ActionRequest,\n ActionResult,\n ActionRun,\n ActionRunResponse,\n FieldCheckRequest,\n FieldCheckResponse,\n Item,\n ItemResponse,\n ListResponse,\n MediaInfo,\n MediaItem,\n MediaReference,\n MediaTransform,\n Pagination,\n PreviewResponse,\n Problem,\n SearchResponse,\n Selection,\n Session,\n StoredFile,\n Upload,\n UploadReference,\n UploadResponse,\n UploadSignRequest,\n UploadSignResponse,\n} from './api';\nimport { Abilities, Condition, Id, Option, RouteReference } from './common';\nimport {\n Auth,\n AuthProvider,\n Definition,\n MenuItem,\n Page,\n Uploads,\n User,\n Widget,\n} from './definition';\nimport { BlockType, Field, Rule } from './field';\nimport { LayoutNode } from './layout';\nimport { Column, Filter, ListDefinition } from './list';\nimport { Resource, ResourceFeatures } from './resource';\nimport {\n DefinitionTheme,\n Theme,\n ThemeFont,\n ThemeFontFace,\n ThemeFontStylesheet,\n ThemeTokens,\n ToneInput,\n ToneValues,\n} from './theme';\n\nexport * from './common';\nexport * from './field';\nexport * from './layout';\nexport * from './list';\nexport * from './action';\nexport * from './resource';\nexport * from './theme';\nexport * from './definition';\nexport * from './api';\nexport * from './boot';\n\n/** The named schemas of the protocol, as they appear in the generated JSON Schema and OpenAPI files. */\nexport const namedSchemas = {\n Id,\n Abilities,\n RouteReference,\n Condition,\n Option,\n Rule,\n BlockType,\n Field,\n LayoutNode,\n Column,\n Filter,\n ListDefinition,\n ActionScope,\n ActionPlacement,\n ActionConfirm,\n Action,\n ResourceFeatures,\n Resource,\n User,\n AuthProvider,\n Auth,\n MenuItem,\n Page,\n Widget,\n Uploads,\n ThemeTokens,\n ToneValues,\n ToneInput,\n ThemeFontFace,\n ThemeFontStylesheet,\n ThemeFont,\n Theme,\n DefinitionTheme,\n Definition,\n Item,\n Pagination,\n ItemResponse,\n ListResponse,\n Problem,\n Selection,\n ActionRequest,\n ActionItemResult,\n ActionResult,\n ActionRun,\n ActionRunResponse,\n MediaTransform,\n StoredFile,\n UploadReference,\n Upload,\n UploadResponse,\n UploadSignRequest,\n UploadSignResponse,\n FieldCheckRequest,\n FieldCheckResponse,\n MediaInfo,\n MediaItem,\n MediaReference,\n Session,\n SearchResponse,\n PreviewResponse,\n} satisfies Record<string, z.ZodType>;\n\n/** A registry of the named schemas, used to reference them by name in generated files. */\nexport function createSchemaRegistry() {\n const registry = z.registry<{ id: string }>();\n Object.entries(namedSchemas).forEach(([id, schema]) => registry.add(schema, { id }));\n return registry;\n}\n"],"mappings":";;;;;;;;;;;;;AAqEA,IAAa,eAAe;CACxB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACJ;;AAGA,SAAgB,uBAAuB;CACnC,MAAM,WAAW,EAAE,SAAyB;CAC5C,OAAO,QAAQ,YAAY,CAAC,CAAC,SAAS,CAAC,IAAI,YAAY,SAAS,IAAI,QAAQ,EAAE,GAAG,CAAC,CAAC;CACnF,OAAO;AACX"}
package/dist/schemas/resource.d.ts CHANGED
@@ -23,6 +23,8 @@ export declare const Resource: z.ZodObject<{
23
23
  description: z.ZodOptional<z.ZodString>;
24
24
  icon: z.ZodOptional<z.ZodString>;
25
25
  itemTitle: z.ZodOptional<z.ZodString>;
26
+ itemSubtitle: z.ZodOptional<z.ZodString>;
27
+ itemImage: z.ZodOptional<z.ZodString>;
26
28
  fields: z.ZodArray<z.ZodObject<{
27
29
  name: z.ZodString;
28
30
  type: z.ZodString;
@@ -76,6 +78,13 @@ export declare const Resource: z.ZodObject<{
76
78
  field: z.ZodString;
77
79
  }, z.core.$loose>]>;
78
80
  message: z.ZodOptional<z.ZodString>;
81
+ }, z.core.$loose>, z.ZodObject<{
82
+ rule: z.ZodLiteral<"crop">;
83
+ value: z.ZodObject<{
84
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
85
+ required: z.ZodOptional<z.ZodBoolean>;
86
+ }, z.core.$loose>;
87
+ message: z.ZodOptional<z.ZodString>;
79
88
  }, z.core.$loose>, z.ZodObject<{
80
89
  rule: z.ZodString;
81
90
  message: z.ZodOptional<z.ZodString>;
@@ -96,9 +105,18 @@ export declare const Resource: z.ZodObject<{
96
105
  disabled: z.ZodOptional<z.ZodBoolean>;
97
106
  }, z.core.$loose>>>;
98
107
  multiple: z.ZodOptional<z.ZodBoolean>;
99
- resource: z.ZodOptional<z.ZodString>;
108
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
100
109
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
110
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
111
+ rotate: z.ZodOptional<z.ZodBoolean>;
112
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
113
+ transformBase: z.ZodOptional<z.ZodEnum<{
114
+ media: "media";
115
+ original: "original";
116
+ choose: "choose";
117
+ }>>;
101
118
  from: z.ZodOptional<z.ZodString>;
119
+ check: z.ZodOptional<z.ZodBoolean>;
102
120
  display: z.ZodOptional<z.ZodString>;
103
121
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
104
122
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -245,6 +263,13 @@ export declare const Resource: z.ZodObject<{
245
263
  field: z.ZodString;
246
264
  }, z.core.$loose>]>;
247
265
  message: z.ZodOptional<z.ZodString>;
266
+ }, z.core.$loose>, z.ZodObject<{
267
+ rule: z.ZodLiteral<"crop">;
268
+ value: z.ZodObject<{
269
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
270
+ required: z.ZodOptional<z.ZodBoolean>;
271
+ }, z.core.$loose>;
272
+ message: z.ZodOptional<z.ZodString>;
248
273
  }, z.core.$loose>, z.ZodObject<{
249
274
  rule: z.ZodString;
250
275
  message: z.ZodOptional<z.ZodString>;
@@ -265,9 +290,18 @@ export declare const Resource: z.ZodObject<{
265
290
  disabled: z.ZodOptional<z.ZodBoolean>;
266
291
  }, z.core.$loose>>>;
267
292
  multiple: z.ZodOptional<z.ZodBoolean>;
268
- resource: z.ZodOptional<z.ZodString>;
293
+ resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
269
294
  accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
295
+ ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
296
+ rotate: z.ZodOptional<z.ZodBoolean>;
297
+ focalPoint: z.ZodOptional<z.ZodBoolean>;
298
+ transformBase: z.ZodOptional<z.ZodEnum<{
299
+ media: "media";
300
+ original: "original";
301
+ choose: "choose";
302
+ }>>;
270
303
  from: z.ZodOptional<z.ZodString>;
304
+ check: z.ZodOptional<z.ZodBoolean>;
271
305
  display: z.ZodOptional<z.ZodString>;
272
306
  fields: z.ZodOptional<z.ZodArray<typeof Field>>;
273
307
  types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
package/dist/schemas/resource.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../src/schemas/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,eAAO,MAAM,gBAAgB;;;;;;;;;;;iBAmB3B,CAAC;AAEH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA0B6C,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAChD,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC"}
1
+ {"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../src/schemas/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,eAAO,MAAM,gBAAgB;;;;;;;;;;;iBAmB3B,CAAC;AAEH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkC6C,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAChD,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC"}
package/dist/schemas/resource.js CHANGED
@@ -12,7 +12,7 @@ var ResourceFeatures = z.looseObject({
12
12
  mode: z.enum(["component", "iframe"]),
13
13
  component: z.string().optional().meta({ description: "`component`: the plugin preview." })
14
14
  })]).optional(),
15
- search: z.boolean().optional().meta({ description: "Whether the resource is in the global search." })
15
+ search: z.boolean().optional().meta({ description: "Whether the resource is in the global search. Defaults to whether its list has a search (`list.search`)." })
16
16
  });
17
17
  var Resource = z.looseObject({
18
18
  id: z.string().min(1),
@@ -24,6 +24,8 @@ var Resource = z.looseObject({
24
24
  description: z.string().optional(),
25
25
  icon: z.string().optional(),
26
26
  itemTitle: z.string().optional().meta({ description: "The field used as the title of an item, in lists and pickers." }),
27
+ itemSubtitle: z.string().optional().meta({ description: "The field shown under the title of an item, in search results, cards and pickers." }),
28
+ itemImage: z.string().optional().meta({ description: "The field that holds the image of an item (a media or a URL), in search results, cards and pickers." }),
27
29
  fields: z.array(Field),
28
30
  form: z.looseObject({ layout: z.array(LayoutNode).optional() }).optional(),
29
31
  list: ListDefinition.optional(),
package/dist/schemas/resource.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resource.js","names":[],"sources":["../../src/schemas/resource.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { Action } from './action';\nimport { Abilities } from './common';\nimport { BlockType, Field } from './field';\nimport { LayoutNode } from './layout';\nimport { ListDefinition } from './list';\n\nexport const ResourceFeatures = z.looseObject({\n drafts: z.boolean().optional(),\n revisions: z.boolean().optional(),\n preview: z\n .union([\n z.null(),\n z.looseObject({\n mode: z.enum(['component', 'iframe']),\n component: z\n .string()\n .optional()\n .meta({ description: '`component`: the plugin preview.' }),\n }),\n ])\n .optional(),\n search: z\n .boolean()\n .optional()\n .meta({ description: 'Whether the resource is in the global search.' }),\n});\n\nexport const Resource = z\n .looseObject({\n id: z.string().min(1),\n kind: z.string().min(1).optional().meta({\n description:\n \"What the resource is. `media`: a library of media (decision 0026), with a `file` field and a `media` on each item. Without it, an ordinary resource. Clients treat a kind they don't know as an ordinary resource.\",\n }),\n label: z.looseObject({ singular: z.string(), plural: z.string() }),\n description: z.string().optional(),\n icon: z.string().optional(),\n itemTitle: z\n .string()\n .optional()\n .meta({ description: 'The field used as the title of an item, in lists and pickers.' }),\n fields: z.array(Field),\n form: z.looseObject({ layout: z.array(LayoutNode).optional() }).optional(),\n list: ListDefinition.optional(),\n actions: z.array(Action).optional(),\n abilities: Abilities.optional(),\n features: ResourceFeatures.optional(),\n types: z\n .array(BlockType)\n .optional()\n .meta({ description: 'Variants of the resource, each with its own extra fields.' }),\n settings: z.record(z.string(), z.unknown()).optional(),\n })\n .meta({ description: 'A set of items managed in the admin.' });\n\nexport type ResourceFeatures = z.infer<typeof ResourceFeatures>;\nexport type Resource = z.infer<typeof Resource>;\n/** A resource as a backend writes it, before defaults are applied. */\nexport type ResourceInput = z.input<typeof Resource>;\n"],"mappings":";;;;;;;AAQA,IAAa,mBAAmB,EAAE,YAAY;CAC1C,QAAQ,EAAE,QAAQ,CAAC,CAAC,SAAS;CAC7B,WAAW,EAAE,QAAQ,CAAC,CAAC,SAAS;CAChC,SAAS,EACJ,MAAM,CACH,EAAE,KAAK,GACP,EAAE,YAAY;EACV,MAAM,EAAE,KAAK,CAAC,aAAa,QAAQ,CAAC;EACpC,WAAW,EACN,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,mCAAmC,CAAC;CACjE,CAAC,CACL,CAAC,CAAC,CACD,SAAS;CACd,QAAQ,EACH,QAAQ,CAAC,CACT,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,gDAAgD,CAAC;AAC9E,CAAC;AAED,IAAa,WAAW,EACnB,YAAY;CACT,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EACpC,aACI,qNACR,CAAC;CACD,OAAO,EAAE,YAAY;EAAE,UAAU,EAAE,OAAO;EAAG,QAAQ,EAAE,OAAO;CAAE,CAAC;CACjE,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CACjC,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,WAAW,EACN,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,gEAAgE,CAAC;CAC1F,QAAQ,EAAE,MAAM,KAAK;CACrB,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS;CACzE,MAAM,eAAe,SAAS;CAC9B,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,SAAS;CAClC,WAAW,UAAU,SAAS;CAC9B,UAAU,iBAAiB,SAAS;CACpC,OAAO,EACF,MAAM,SAAS,CAAC,CAChB,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,4DAA4D,CAAC;CACtF,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;AACzD,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,uCAAuC,CAAC"}
1
+ {"version":3,"file":"resource.js","names":[],"sources":["../../src/schemas/resource.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { Action } from './action';\nimport { Abilities } from './common';\nimport { BlockType, Field } from './field';\nimport { LayoutNode } from './layout';\nimport { ListDefinition } from './list';\n\nexport const ResourceFeatures = z.looseObject({\n drafts: z.boolean().optional(),\n revisions: z.boolean().optional(),\n preview: z\n .union([\n z.null(),\n z.looseObject({\n mode: z.enum(['component', 'iframe']),\n component: z\n .string()\n .optional()\n .meta({ description: '`component`: the plugin preview.' }),\n }),\n ])\n .optional(),\n search: z.boolean().optional().meta({\n description:\n 'Whether the resource is in the global search. Defaults to whether its list has a search (`list.search`).',\n }),\n});\n\nexport const Resource = z\n .looseObject({\n id: z.string().min(1),\n kind: z.string().min(1).optional().meta({\n description:\n \"What the resource is. `media`: a library of media (decision 0026), with a `file` field and a `media` on each item. Without it, an ordinary resource. Clients treat a kind they don't know as an ordinary resource.\",\n }),\n label: z.looseObject({ singular: z.string(), plural: z.string() }),\n description: z.string().optional(),\n icon: z.string().optional(),\n itemTitle: z\n .string()\n .optional()\n .meta({ description: 'The field used as the title of an item, in lists and pickers.' }),\n itemSubtitle: z.string().optional().meta({\n description:\n 'The field shown under the title of an item, in search results, cards and pickers.',\n }),\n itemImage: z.string().optional().meta({\n description:\n 'The field that holds the image of an item (a media or a URL), in search results, cards and pickers.',\n }),\n fields: z.array(Field),\n form: z.looseObject({ layout: z.array(LayoutNode).optional() }).optional(),\n list: ListDefinition.optional(),\n actions: z.array(Action).optional(),\n abilities: Abilities.optional(),\n features: ResourceFeatures.optional(),\n types: z\n .array(BlockType)\n .optional()\n .meta({ description: 'Variants of the resource, each with its own extra fields.' }),\n settings: z.record(z.string(), z.unknown()).optional(),\n })\n .meta({ description: 'A set of items managed in the admin.' });\n\nexport type ResourceFeatures = z.infer<typeof ResourceFeatures>;\nexport type Resource = z.infer<typeof Resource>;\n/** A resource as a backend writes it, before defaults are applied. */\nexport type ResourceInput = z.input<typeof Resource>;\n"],"mappings":";;;;;;;AAQA,IAAa,mBAAmB,EAAE,YAAY;CAC1C,QAAQ,EAAE,QAAQ,CAAC,CAAC,SAAS;CAC7B,WAAW,EAAE,QAAQ,CAAC,CAAC,SAAS;CAChC,SAAS,EACJ,MAAM,CACH,EAAE,KAAK,GACP,EAAE,YAAY;EACV,MAAM,EAAE,KAAK,CAAC,aAAa,QAAQ,CAAC;EACpC,WAAW,EACN,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,mCAAmC,CAAC;CACjE,CAAC,CACL,CAAC,CAAC,CACD,SAAS;CACd,QAAQ,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAChC,aACI,2GACR,CAAC;AACL,CAAC;AAED,IAAa,WAAW,EACnB,YAAY;CACT,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EACpC,aACI,qNACR,CAAC;CACD,OAAO,EAAE,YAAY;EAAE,UAAU,EAAE,OAAO;EAAG,QAAQ,EAAE,OAAO;CAAE,CAAC;CACjE,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CACjC,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,WAAW,EACN,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,gEAAgE,CAAC;CAC1F,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EACrC,aACI,oFACR,CAAC;CACD,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAClC,aACI,sGACR,CAAC;CACD,QAAQ,EAAE,MAAM,KAAK;CACrB,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS;CACzE,MAAM,eAAe,SAAS;CAC9B,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,SAAS;CAClC,WAAW,UAAU,SAAS;CAC9B,UAAU,iBAAiB,SAAS;CACpC,OAAO,EACF,MAAM,SAAS,CAAC,CAChB,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,4DAA4D,CAAC;CACtF,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;AACzD,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,uCAAuC,CAAC"}
package/dist/search.d.ts ADDED
@@ -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
package/dist/search.d.ts.map ADDED
@@ -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"}