@panneau/protocol 5.0.0-alpha.8 → 5.0.0-alpha.9

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 (47) hide show
  1. package/dist/conformance/index.d.ts.map +1 -1
  2. package/dist/conformance/index.js +10 -4
  3. package/dist/conformance/index.js.map +1 -1
  4. package/dist/index.js +3 -3
  5. package/dist/mock/index.d.ts.map +1 -1
  6. package/dist/mock/index.js +14 -0
  7. package/dist/mock/index.js.map +1 -1
  8. package/dist/openapi.d.ts.map +1 -1
  9. package/dist/openapi.js +1 -0
  10. package/dist/openapi.js.map +1 -1
  11. package/dist/query.d.ts +14 -0
  12. package/dist/query.d.ts.map +1 -1
  13. package/dist/query.js +11 -1
  14. package/dist/query.js.map +1 -1
  15. package/dist/runtime/index.d.ts +1 -1
  16. package/dist/runtime/index.d.ts.map +1 -1
  17. package/dist/runtime/index.js +2 -2
  18. package/dist/schemas/action.d.ts +1 -0
  19. package/dist/schemas/action.d.ts.map +1 -1
  20. package/dist/schemas/api.d.ts +14 -2
  21. package/dist/schemas/api.d.ts.map +1 -1
  22. package/dist/schemas/api.js +8 -2
  23. package/dist/schemas/api.js.map +1 -1
  24. package/dist/schemas/common.d.ts +1 -0
  25. package/dist/schemas/common.d.ts.map +1 -1
  26. package/dist/schemas/common.js +2 -1
  27. package/dist/schemas/common.js.map +1 -1
  28. package/dist/schemas/definition.d.ts +9 -0
  29. package/dist/schemas/definition.d.ts.map +1 -1
  30. package/dist/schemas/definition.js +2 -1
  31. package/dist/schemas/definition.js.map +1 -1
  32. package/dist/schemas/field.d.ts +1 -0
  33. package/dist/schemas/field.d.ts.map +1 -1
  34. package/dist/schemas/index.d.ts +38 -2
  35. package/dist/schemas/index.d.ts.map +1 -1
  36. package/dist/schemas/index.js +3 -2
  37. package/dist/schemas/index.js.map +1 -1
  38. package/dist/schemas/list.d.ts +6 -0
  39. package/dist/schemas/list.d.ts.map +1 -1
  40. package/dist/schemas/list.js +1 -0
  41. package/dist/schemas/list.js.map +1 -1
  42. package/dist/schemas/resource.d.ts +7 -0
  43. package/dist/schemas/resource.d.ts.map +1 -1
  44. package/package.json +1 -1
  45. package/schema/boot.schema.json +18 -0
  46. package/schema/definition.schema.json +18 -0
  47. package/schema/openapi.json +91 -1
@@ -79,6 +79,15 @@
79
79
  "minimum": 1
80
80
  }
81
81
  },
82
+ {
83
+ "name": "cursor",
84
+ "in": "query",
85
+ "required": false,
86
+ "description": "Lists whose `pagination` is `cursor`: the `nextCursor` (or `previousCursor`) of a page, instead of `page`.",
87
+ "schema": {
88
+ "type": "string"
89
+ }
90
+ },
82
91
  {
83
92
  "name": "sort",
84
93
  "in": "query",
@@ -1809,6 +1818,11 @@
1809
1818
  },
1810
1819
  "disabled": {
1811
1820
  "type": "boolean"
1821
+ },
1822
+ "tone": {
1823
+ "description": "The tone of the option where it shows as a badge, in lists and details: `neutral` (the default), `accent`, `success`, `warning`, `danger`, `info`, or a tone of the theme.",
1824
+ "type": "string",
1825
+ "pattern": "^[a-z0-9-]+$"
1812
1826
  }
1813
1827
  },
1814
1828
  "required": [
@@ -2527,6 +2541,14 @@
2527
2541
  "maximum": 9007199254740991
2528
2542
  }
2529
2543
  },
2544
+ "pagination": {
2545
+ "description": "`pages` (the default): numbered pages, with a total. `cursor`: the list follows `nextCursor` of each page with the `cursor` parameter, without page numbers, for large lists that the backend can't count (decision 0039).",
2546
+ "type": "string",
2547
+ "enum": [
2548
+ "pages",
2549
+ "cursor"
2550
+ ]
2551
+ },
2530
2552
  "inlineEdit": {
2531
2553
  "description": "Fields editable in the list.",
2532
2554
  "type": "array",
@@ -3001,6 +3023,14 @@
3001
3023
  "type": "string"
3002
3024
  },
3003
3025
  "additionalProperties": {}
3026
+ },
3027
+ "params": {
3028
+ "description": "Names of the path segments after the page: `[\"id\"]` makes `{basePath}/pages/{page}/{id}`. The component gets them as `params`, and route references (`{ \"route\": \"<page>\", \"params\": { \"id\": … } }`) can link to the page. A page with `params` is not in menus.",
3029
+ "type": "array",
3030
+ "items": {
3031
+ "type": "string",
3032
+ "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
3033
+ }
3004
3034
  }
3005
3035
  },
3006
3036
  "required": [
@@ -3674,6 +3704,59 @@
3674
3704
  ],
3675
3705
  "additionalProperties": {}
3676
3706
  },
3707
+ "CursorPagination": {
3708
+ "type": "object",
3709
+ "properties": {
3710
+ "perPage": {
3711
+ "type": "integer",
3712
+ "exclusiveMinimum": 0,
3713
+ "maximum": 9007199254740991
3714
+ },
3715
+ "nextCursor": {
3716
+ "anyOf": [
3717
+ {
3718
+ "type": "string",
3719
+ "minLength": 1
3720
+ },
3721
+ {
3722
+ "type": "null"
3723
+ }
3724
+ ],
3725
+ "description": "The `cursor` of the next page, or `null` on the last page."
3726
+ },
3727
+ "previousCursor": {
3728
+ "description": "The `cursor` of the previous page, or `null` when it is the first page, which has none (and on the first page). Without it, clients go back through the cursors they followed.",
3729
+ "anyOf": [
3730
+ {
3731
+ "type": "string",
3732
+ "minLength": 1
3733
+ },
3734
+ {
3735
+ "type": "null"
3736
+ }
3737
+ ]
3738
+ },
3739
+ "total": {
3740
+ "description": "How many items match, when the backend counts them.",
3741
+ "anyOf": [
3742
+ {
3743
+ "type": "integer",
3744
+ "minimum": 0,
3745
+ "maximum": 9007199254740991
3746
+ },
3747
+ {
3748
+ "type": "null"
3749
+ }
3750
+ ]
3751
+ }
3752
+ },
3753
+ "required": [
3754
+ "perPage",
3755
+ "nextCursor"
3756
+ ],
3757
+ "additionalProperties": {},
3758
+ "description": "The meta of a page of a list whose `pagination` is `cursor`: no page numbers, and no total unless the backend has one."
3759
+ },
3677
3760
  "ItemResponse": {
3678
3761
  "type": "object",
3679
3762
  "properties": {
@@ -3696,7 +3779,14 @@
3696
3779
  }
3697
3780
  },
3698
3781
  "meta": {
3699
- "$ref": "#/components/schemas/Pagination"
3782
+ "anyOf": [
3783
+ {
3784
+ "$ref": "#/components/schemas/Pagination"
3785
+ },
3786
+ {
3787
+ "$ref": "#/components/schemas/CursorPagination"
3788
+ }
3789
+ ]
3700
3790
  }
3701
3791
  },
3702
3792
  "required": [