@codewheel/jsonapi-frontend-client 1.0.3 → 1.0.5

package/README.md

@@ -61,6 +61,26 @@ await resolvePath("/about-us", {
 })
 ```
 
+### Caching note (Next.js / SSR)
+
+If you pass `Authorization` (or `Cookie`) headers, this client defaults to `cache: "no-store"` unless you explicitly set `options.init.cache`.
+
+## Static builds (SSG) routes feed (optional)
+
+If you enable the secret-protected routes feed in Drupal (`/jsonapi/routes`), you can fetch a complete build-time list of headless paths by following `links.next`:
+
+```ts
+import { collectRoutes } from "@codewheel/jsonapi-frontend-client"
+
+const baseUrl = process.env.DRUPAL_BASE_URL!
+const secret = process.env.ROUTES_FEED_SECRET!
+
+const routes = await collectRoutes({ baseUrl, secret })
+const paths = routes.map((r) => r.path)
+```
+
+Keep `ROUTES_FEED_SECRET` server-side only (build environment variables). Do not expose it to browsers.
+
 ## Query building (optional)
 
 This client doesn’t require a query builder, but `drupal-jsonapi-params` works well:

package/dist/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAuD,MAAM,gBAAgB,CAAA;AAC1G,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAmBlE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAa5D;AAoBD,wBAAsB,YAAY,CAAC,CAAC,GAAG,eAAe,EACpD,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,GACA,OAAO,CAAC,CAAC,CAAC,CAsCZ;AAED,wBAAsB,SAAS,CAAC,CAAC,GAAG,eAAe,EACjD,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACnD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,GACA,OAAO,CAAC,CAAC,CAAC,CAyCZ"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAuD,MAAM,gBAAgB,CAAA;AAC1G,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAmBlE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAa5D;AAwBD,wBAAsB,YAAY,CAAC,CAAC,GAAG,eAAe,EACpD,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,GACA,OAAO,CAAC,CAAC,CAAC,CAuDZ;AAED,wBAAsB,SAAS,CAAC,CAAC,GAAG,eAAe,EACjD,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACnD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,GACA,OAAO,CAAC,CAAC,CAAC,CAyDZ"}

package/dist/fetch.js

@@ -46,6 +46,9 @@ function buildSafeUrl(input, base, options) {
     }
     return url;
 }
+function hasAuthLikeHeaders(headers) {
+    return headers.has("authorization") || headers.has("cookie");
+}
 export async function fetchJsonApi(jsonapiPath, options) {
     const base = getDrupalBaseUrlFromOptions({ baseUrl: options?.baseUrl, envKey: options?.envKey });
     const fetcher = getFetch(options?.fetch);
@@ -63,15 +66,28 @@ export async function fetchJsonApi(jsonapiPath, options) {
     if (!headers.has("Accept")) {
         headers.set("Accept", "application/vnd.api+json");
     }
-    const res = await fetcher(url.toString(), {
+    const hasExplicitCache = options?.init?.cache !== undefined;
+    const disableCaching = hasAuthLikeHeaders(headers) && !hasExplicitCache;
+    const init = {
         ...options?.init,
         headers,
-        next: {
-            ...(options?.init?.next ?? {}),
-            revalidate: options?.revalidate,
-            tags: Array.from(new Set([...(options?.init?.next?.tags ?? []), ...tags])),
-        },
-    });
+    };
+    if (disableCaching) {
+        init.cache = "no-store";
+        // Avoid mixing Next.js cache options with no-store.
+        delete init.next;
+    }
+    const fetchInit = disableCaching
+        ? init
+        : {
+            ...init,
+            next: {
+                ...(options?.init?.next ?? {}),
+                revalidate: options?.revalidate,
+                tags: Array.from(new Set([...(options?.init?.next?.tags ?? []), ...tags])),
+            },
+        };
+    const res = await fetcher(url.toString(), fetchInit);
     if (!res.ok) {
         throw new Error(`JSON:API fetch failed: ${res.status} ${res.statusText}`);
     }
@@ -99,15 +115,27 @@ export async function fetchView(dataUrl, options) {
     if (!headers.has("Accept")) {
         headers.set("Accept", "application/vnd.api+json");
     }
-    const res = await fetcher(url.toString(), {
+    const hasExplicitCache = options?.init?.cache !== undefined;
+    const disableCaching = hasAuthLikeHeaders(headers) && !hasExplicitCache;
+    const init = {
         ...options?.init,
         headers,
-        next: {
-            ...(options?.init?.next ?? {}),
-            revalidate: options?.revalidate,
-            tags: Array.from(new Set([...(options?.init?.next?.tags ?? []), ...tags])),
-        },
-    });
+    };
+    if (disableCaching) {
+        init.cache = "no-store";
+        delete init.next;
+    }
+    const fetchInit = disableCaching
+        ? init
+        : {
+            ...init,
+            next: {
+                ...(options?.init?.next ?? {}),
+                revalidate: options?.revalidate,
+                tags: Array.from(new Set([...(options?.init?.next?.tags ?? []), ...tags])),
+            },
+        };
+    const res = await fetcher(url.toString(), fetchInit);
     if (!res.ok) {
         throw new Error(`View fetch failed: ${res.status} ${res.statusText}`);
     }

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export { resolvePath } from "./resolve.js";
 export { fetchJsonApi, fetchView } from "./fetch.js";
+export { fetchRoutesPage, iterateRoutes, collectRoutes } from "./routes.js";
 export { getDrupalBaseUrl, resolveFileUrl, getFileUrl, getImageStyleUrl } from "./url.js";
 export { findIncluded, findIncludedByRelationship, findIncludedByRelationshipMultiple, extractImageFromFile, extractMedia, extractMediaField, extractPrimaryImage, extractEmbeddedMediaUuids, parseDrupalMediaTag, } from "./media.js";
-export type { ResolveResponse, JsonApiDocument, JsonApiResource, JsonApiRelationship, JsonApiLinks, NodeAttributes, } from "./types.js";
+export type { ResolveResponse, RoutesFeedItem, RoutesFeedResponse, JsonApiDocument, JsonApiResource, JsonApiRelationship, JsonApiLinks, NodeAttributes, } from "./types.js";
 export type { DrupalImageData, DrupalMediaData } from "./media.js";
 export type { FetchInit, FetchLike } from "./transport.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEpD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEzF,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,kCAAkC,EAClC,oBAAoB,EACpB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AAEnB,YAAY,EACV,eAAe,EACf,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,cAAc,GACf,MAAM,YAAY,CAAA;AAEnB,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAElE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3E,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEzF,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,kCAAkC,EAClC,oBAAoB,EACpB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AAEnB,YAAY,EACV,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,cAAc,GACf,MAAM,YAAY,CAAA;AAEnB,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAElE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/index.js

@@ -1,4 +1,5 @@
 export { resolvePath } from "./resolve.js";
 export { fetchJsonApi, fetchView } from "./fetch.js";
+export { fetchRoutesPage, iterateRoutes, collectRoutes } from "./routes.js";
 export { getDrupalBaseUrl, resolveFileUrl, getFileUrl, getImageStyleUrl } from "./url.js";
 export { findIncluded, findIncludedByRelationship, findIncludedByRelationshipMultiple, extractImageFromFile, extractMedia, extractMediaField, extractPrimaryImage, extractEmbeddedMediaUuids, parseDrupalMediaTag, } from "./media.js";

package/dist/resolve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAuD,MAAM,gBAAgB,CAAA;AAE1G;;GAEG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,GACA,OAAO,CAAC,eAAe,CAAC,CA8B1B"}
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAuD,MAAM,gBAAgB,CAAA;AAE1G;;GAEG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,GACA,OAAO,CAAC,eAAe,CAAC,CA8C1B"}

package/dist/resolve.js

@@ -15,14 +15,26 @@ export async function resolvePath(path, options) {
     if (!headers.has("Accept")) {
         headers.set("Accept", "application/vnd.api+json");
     }
-    const res = await fetcher(url.toString(), {
+    const hasExplicitCache = options?.init?.cache !== undefined;
+    const disableCaching = (headers.has("authorization") || headers.has("cookie")) && !hasExplicitCache;
+    const init = {
         ...options?.init,
         headers,
-        next: {
-            ...(options?.init?.next ?? {}),
-            revalidate: options?.revalidate,
-        },
-    });
+    };
+    if (disableCaching) {
+        init.cache = "no-store";
+        delete init.next;
+    }
+    const fetchInit = disableCaching
+        ? init
+        : {
+            ...init,
+            next: {
+                ...(options?.init?.next ?? {}),
+                revalidate: options?.revalidate,
+            },
+        };
+    const res = await fetcher(url.toString(), fetchInit);
     if (!res.ok) {
         throw new Error(`Resolver failed: ${res.status} ${res.statusText}`);
     }

package/dist/routes.d.ts

@@ -0,0 +1,40 @@
+import { FetchInit, FetchLike } from "./transport.js";
+import type { RoutesFeedItem, RoutesFeedResponse } from "./types.js";
+/**
+ * Fetch a single page from the build-time routes feed (/jsonapi/routes).
+ *
+ * This endpoint is typically protected by X-Routes-Secret. Keep secrets
+ * server-side only.
+ */
+export declare function fetchRoutesPage(options?: {
+    baseUrl?: string;
+    envKey?: string;
+    langcode?: string;
+    /**
+     * Page size (default: 50). This maps to page[limit] for the first request.
+     *
+     * Subsequent pages follow links.next from the server.
+     */
+    limit?: number;
+    /**
+     * Provide a pagination URL (usually links.next from a previous response).
+     * If provided, it takes precedence over limit/langcode and is fetched as-is.
+     */
+    url?: string;
+    /** Routes feed secret (sent as X-Routes-Secret). */
+    secret?: string;
+    fetch?: FetchLike;
+    headers?: HeadersInit;
+    init?: FetchInit;
+}): Promise<RoutesFeedResponse>;
+/**
+ * Iterate all routes by following links.next until it is null.
+ */
+export declare function iterateRoutes(options?: Omit<Parameters<typeof fetchRoutesPage>[0], "url"> & {
+    maxPages?: number;
+}): AsyncGenerator<RoutesFeedItem>;
+/**
+ * Collect all routes into an array (convenience wrapper around iterateRoutes).
+ */
+export declare function collectRoutes(options?: Parameters<typeof iterateRoutes>[0]): Promise<RoutesFeedItem[]>;
+//# sourceMappingURL=routes.d.ts.map

package/dist/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAuD,MAAM,gBAAgB,CAAA;AAC1G,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAqDpE;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,OAAO,GAAE;IACP,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,SAAS,CAAA;CACZ,GACL,OAAO,CAAC,kBAAkB,CAAC,CA8D7B;AAED;;GAEG;AACH,wBAAuB,aAAa,CAClC,OAAO,GAAE,IAAI,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO,GACvF,cAAc,CAAC,cAAc,CAAC,CAiBhC;AAED;;GAEG;AACH,wBAAsB,aAAa,CACjC,OAAO,GAAE,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAM,GAChD,OAAO,CAAC,cAAc,EAAE,CAAC,CAM3B"}

package/dist/routes.js

@@ -0,0 +1,133 @@
+import { getDrupalBaseUrlFromOptions, getFetch, mergeHeaders } from "./transport.js";
+function buildRoutesUrl(input, base) {
+    const baseUrl = new URL(base);
+    const url = new URL(input, baseUrl);
+    if (url.origin !== baseUrl.origin) {
+        throw new Error(`Refusing to fetch a URL from a different origin (${url.origin}) than base (${baseUrl.origin}). ` +
+            "This should not happen for /jsonapi/routes pagination.");
+    }
+    if (url.protocol !== "http:" && url.protocol !== "https:") {
+        throw new Error(`Unsupported URL protocol "${url.protocol}" (expected http/https)`);
+    }
+    return url;
+}
+function normalizeRoutesItem(value) {
+    if (!value || typeof value !== "object")
+        return null;
+    const item = value;
+    const path = item.path;
+    const kind = item.kind;
+    const jsonapi_url = item.jsonapi_url;
+    const data_url = item.data_url;
+    if (typeof path !== "string" || path.trim() === "" || !path.startsWith("/"))
+        return null;
+    if (kind !== "entity" && kind !== "view")
+        return null;
+    if (kind === "entity") {
+        if (typeof jsonapi_url !== "string" || jsonapi_url.trim() === "")
+            return null;
+        if (data_url !== null)
+            return null;
+        return { path, kind, jsonapi_url, data_url: null };
+    }
+    if (kind === "view") {
+        if (typeof data_url !== "string" || data_url.trim() === "")
+            return null;
+        if (jsonapi_url !== null)
+            return null;
+        return { path, kind, jsonapi_url: null, data_url };
+    }
+    return null;
+}
+function getNextLink(links) {
+    if (!links || typeof links !== "object")
+        return null;
+    const next = links.next;
+    return typeof next === "string" && next.trim() !== "" ? next : null;
+}
+/**
+ * Fetch a single page from the build-time routes feed (/jsonapi/routes).
+ *
+ * This endpoint is typically protected by X-Routes-Secret. Keep secrets
+ * server-side only.
+ */
+export async function fetchRoutesPage(options = {}) {
+    const base = getDrupalBaseUrlFromOptions({ baseUrl: options.baseUrl, envKey: options.envKey });
+    const fetcher = getFetch(options.fetch);
+    const url = options.url
+        ? buildRoutesUrl(options.url, base)
+        : (() => {
+            const u = buildRoutesUrl("/jsonapi/routes", base);
+            u.searchParams.set("_format", "json");
+            u.searchParams.set("page[limit]", String(options.limit ?? 50));
+            if (options.langcode) {
+                u.searchParams.set("langcode", options.langcode);
+            }
+            return u;
+        })();
+    const headers = mergeHeaders(options.init?.headers, options.headers);
+    if (!headers.has("Accept")) {
+        headers.set("Accept", "application/vnd.api+json");
+    }
+    if (options.secret && typeof options.secret === "string" && options.secret.trim() !== "") {
+        headers.set("X-Routes-Secret", options.secret.trim());
+    }
+    const init = {
+        ...options.init,
+        headers,
+    };
+    // This endpoint is secret-protected; disable caching by default.
+    if (options.init?.cache === undefined) {
+        init.cache = "no-store";
+        delete init.next;
+    }
+    const res = await fetcher(url.toString(), init);
+    if (!res.ok) {
+        throw new Error(`Routes feed failed: ${res.status} ${res.statusText}`);
+    }
+    const doc = (await res.json());
+    if (!doc || typeof doc !== "object") {
+        throw new Error("Routes feed returned invalid JSON");
+    }
+    const data = doc.data;
+    const rawItems = Array.isArray(data) ? data : [];
+    const items = rawItems.map(normalizeRoutesItem).filter((v) => v !== null);
+    const links = doc.links;
+    const meta = doc.meta;
+    return {
+        data: items,
+        links: {
+            self: typeof links?.self === "string" ? links.self : undefined,
+            next: getNextLink(links),
+        },
+        meta: (meta && typeof meta === "object" ? meta : undefined),
+    };
+}
+/**
+ * Iterate all routes by following links.next until it is null.
+ */
+export async function* iterateRoutes(options = {}) {
+    const maxPages = options.maxPages ?? 10_000;
+    let pageUrl = undefined;
+    for (let i = 0; i < maxPages; i++) {
+        const page = await fetchRoutesPage({ ...options, url: pageUrl });
+        for (const item of page.data) {
+            yield item;
+        }
+        const next = page.links?.next;
+        if (!next)
+            return;
+        pageUrl = next;
+    }
+    throw new Error(`Routes feed exceeded maxPages=${maxPages}; aborting pagination`);
+}
+/**
+ * Collect all routes into an array (convenience wrapper around iterateRoutes).
+ */
+export async function collectRoutes(options = {}) {
+    const items = [];
+    for await (const item of iterateRoutes(options)) {
+        items.push(item);
+    }
+    return items;
+}

package/dist/types.d.ts

@@ -42,6 +42,25 @@ export type ResolveResponse = {
     headless: false;
     drupal_url: null;
 };
+export type RoutesFeedItem = {
+    path: string;
+    kind: "entity";
+    jsonapi_url: string;
+    data_url: null;
+} | {
+    path: string;
+    kind: "view";
+    jsonapi_url: null;
+    data_url: string;
+};
+export interface RoutesFeedResponse {
+    data: RoutesFeedItem[];
+    links?: {
+        self?: string;
+        next?: string | null;
+    };
+    meta?: Record<string, unknown>;
+}
 export interface JsonApiDocument<T = JsonApiResource> {
     data: T | T[];
     included?: JsonApiResource[];

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GACvB;IACE,QAAQ,EAAE,IAAI,CAAA;IACd,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAChD,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,IAAI,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,GACD;IACE,QAAQ,EAAE,IAAI,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,IAAI,CAAA;IACZ,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAChD,WAAW,EAAE,IAAI,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,GACD;IACE,QAAQ,EAAE,KAAK,CAAA;IACf,IAAI,EAAE,IAAI,CAAA;IACV,SAAS,EAAE,IAAI,CAAA;IACf,MAAM,EAAE,IAAI,CAAA;IACZ,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAChD,WAAW,EAAE,IAAI,CAAA;IACjB,QAAQ,EAAE,IAAI,CAAA;IACd,QAAQ,EAAE,KAAK,CAAA;IACf,UAAU,EAAE,IAAI,CAAA;CACjB,CAAA;AAEL,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,eAAe;IAClD,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAA;IACb,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,KAAK,CAAC,EAAE,YAAY,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;IACnD,KAAK,CAAC,EAAE,YAAY,CAAA;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,IAAI,CAAA;IAC1E,KAAK,CAAC,EAAE,YAAY,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACnC,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;QAClB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,SAAS,EAAE,MAAM,CAAA;QACjB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GACvB;IACE,QAAQ,EAAE,IAAI,CAAA;IACd,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAChD,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,IAAI,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,GACD;IACE,QAAQ,EAAE,IAAI,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,IAAI,CAAA;IACZ,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAChD,WAAW,EAAE,IAAI,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,GACD;IACE,QAAQ,EAAE,KAAK,CAAA;IACf,IAAI,EAAE,IAAI,CAAA;IACV,SAAS,EAAE,IAAI,CAAA;IACf,MAAM,EAAE,IAAI,CAAA;IACZ,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAChD,WAAW,EAAE,IAAI,CAAA;IACjB,QAAQ,EAAE,IAAI,CAAA;IACd,QAAQ,EAAE,KAAK,CAAA;IACf,UAAU,EAAE,IAAI,CAAA;CACjB,CAAA;AAEL,MAAM,MAAM,cAAc,GACtB;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,IAAI,CAAA;CACf,GACD;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,IAAI,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAEL,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACrB,CAAA;IACD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,eAAe;IAClD,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAA;IACb,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,KAAK,CAAC,EAAE,YAAY,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;IACnD,KAAK,CAAC,EAAE,YAAY,CAAA;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,IAAI,CAAA;IAC1E,KAAK,CAAC,EAAE,YAAY,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACnC,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;QAClB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,SAAS,EAAE,MAAM,CAAA;QACjB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codewheel/jsonapi-frontend-client",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "TypeScript client helpers for Drupal drupal/jsonapi_frontend",
   "homepage": "https://github.com/code-wheel/jsonapi-frontend-client#readme",
   "repository": {