@jxsuite/schema 5.0.0 → 5.1.0

package/defs/field-schema.schema.ts

@@ -62,10 +62,12 @@ export const relationshipRefSchema = {
  * ones every per-project entry document unions extension shapes on top of.
  *
  * These mirror `resolvePathEntries` in the compiler's pages-discovery exactly (specs/
- * site-architecture.md §4.3): an explicit value list, a JSON data-file reference, and the legacy
- * bare array of parameter objects. Anything else is dispatched by discriminator key to an
- * extension's `resolvePaths` capability, so extension shapes reach the union through the entry
- * document rather than from here.
+ * site-architecture.md §4.3): an explicit value list, a JSON data-file reference, a paged list, and
+ * the legacy bare array of parameter objects. Anything else is dispatched by discriminator key to
+ * an extension's `resolvePaths` capability, so extension shapes reach the union through the entry
+ * document rather than from here. The paged list is expanded by `expandDynamicRoutes` itself rather
+ * than `resolvePathEntries`, because it reads the page's own state; its `each` holds another source
+ * of this union (or an extension's), checked when the route expands.
  *
  * Each shape is CLOSED (`additionalProperties: false`). `$paths` is a build-time instruction with a
  * fully specified grammar and no forward-compatible extension points of its own — a stray or
@@ -103,6 +105,37 @@ export const documentPathsCoreMembers = [
     required: ["$ref"],
     type: "object",
   },
+  {
+    additionalProperties: false,
+    description:
+      "Paged list: one route per `pageSize` items of an entry of this page's own state, which must " +
+      "resolve to an array at build time. The page number fills the route's one parameter that " +
+      "`each` does not.",
+    properties: {
+      each: {
+        description:
+          "Another `$paths` source for the route's other parameter: the list is paged once per " +
+          "value of it, as a paged archive per tag is.",
+        type: ["object", "array"],
+      },
+      pageSize: { description: "Items on each page.", minimum: 1, type: "integer" },
+      paginate: {
+        additionalProperties: false,
+        description: "The state entry to page.",
+        properties: {
+          $ref: {
+            description: "A pointer to an entry of this page's state: `#/state/<key>`.",
+            pattern: "^#/state/[^/]+$",
+            type: "string",
+          },
+        },
+        required: ["$ref"],
+        type: "object",
+      },
+    },
+    required: ["paginate", "pageSize"],
+    type: "object",
+  },
   {
     description:
       "Legacy explicit form: an array of ready-made parameter objects, used as-is with no " +

package/package.json

@@ -61,7 +61,7 @@
     "upgrade": "bun update --latest && bun install"
   },
   "type": "module",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "devDependencies": {
     "json-schema-to-ts": "^3.1.1"
   }

package/schema.json

@@ -28351,6 +28351,44 @@
           ],
           "type": "object"
         },
+        {
+          "additionalProperties": false,
+          "description": "Paged list: one route per `pageSize` items of an entry of this page's own state, which must resolve to an array at build time. The page number fills the route's one parameter that `each` does not.",
+          "properties": {
+            "each": {
+              "description": "Another `$paths` source for the route's other parameter: the list is paged once per value of it, as a paged archive per tag is.",
+              "type": [
+                "object",
+                "array"
+              ]
+            },
+            "pageSize": {
+              "description": "Items on each page.",
+              "minimum": 1,
+              "type": "integer"
+            },
+            "paginate": {
+              "additionalProperties": false,
+              "description": "The state entry to page.",
+              "properties": {
+                "$ref": {
+                  "description": "A pointer to an entry of this page's state: `#/state/<key>`.",
+                  "pattern": "^#/state/[^/]+$",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "$ref"
+              ],
+              "type": "object"
+            }
+          },
+          "required": [
+            "paginate",
+            "pageSize"
+          ],
+          "type": "object"
+        },
         {
           "description": "Legacy explicit form: an array of ready-made parameter objects, used as-is with no expansion. Prefer one of the source shapes above.",
           "items": {

package/schemas/document.paths.schema.json

@@ -38,6 +38,36 @@
       "required": ["$ref"],
       "type": "object"
     },
+    {
+      "additionalProperties": false,
+      "description": "Paged list: one route per `pageSize` items of an entry of this page's own state, which must resolve to an array at build time. The page number fills the route's one parameter that `each` does not.",
+      "properties": {
+        "each": {
+          "description": "Another `$paths` source for the route's other parameter: the list is paged once per value of it, as a paged archive per tag is.",
+          "type": ["object", "array"]
+        },
+        "pageSize": {
+          "description": "Items on each page.",
+          "minimum": 1,
+          "type": "integer"
+        },
+        "paginate": {
+          "additionalProperties": false,
+          "description": "The state entry to page.",
+          "properties": {
+            "$ref": {
+              "description": "A pointer to an entry of this page's state: `#/state/<key>`.",
+              "pattern": "^#/state/[^/]+$",
+              "type": "string"
+            }
+          },
+          "required": ["$ref"],
+          "type": "object"
+        }
+      },
+      "required": ["paginate", "pageSize"],
+      "type": "object"
+    },
     {
       "description": "Legacy explicit form: an array of ready-made parameter objects, used as-is with no expansion. Prefer one of the source shapes above.",
       "items": {

package/types.ts

@@ -793,14 +793,16 @@ export interface ProjectConfig {
 export type JxAttributeValue = Bindable<string | number | boolean>;
 
 /**
- * A dynamic-route path source (spec §4.3): explicit values, data-file ref, a legacy array of param
- * objects, or an extension-discriminated source (an object carrying a `resolvePaths` discriminator
- * key registered by an enabled extension, e.g. the parser's `contentType` — the extension owns the
- * narrow shape).
+ * A dynamic-route path source (spec §4.3): explicit values, data-file ref, a paged list of an entry
+ * of the page's own state (with `each` naming the source of a second parameter), a legacy array of
+ * param objects, or an extension-discriminated source (an object carrying a `resolvePaths`
+ * discriminator key registered by an enabled extension, e.g. the parser's `contentType` — the
+ * extension owns the narrow shape).
  */
 export type JxPathsDef =
   | { values: JsonValue[]; param?: string }
   | { $ref: string; param?: string; field?: string }
+  | { paginate: { $ref: string }; pageSize: number; each?: JsonValue }
   | { param?: string; field?: string; [discriminator: string]: JsonValue | undefined }
   | Record<string, JsonValue>[];