@viglet/shio-client 2026.2.1 → 2026.3.2

package/LICENSE

@@ -1,201 +1,201 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,11 +1,18 @@
 # @viglet/shio-client
 
-Framework-agnostic TypeScript client for the **Shio CMS Content Delivery API (CDA)**.
+[![npm](https://img.shields.io/npm/v/@viglet/shio-client?logo=npm)](https://www.npmjs.com/package/@viglet/shio-client)
+[![License](https://img.shields.io/npm/l/@viglet/shio-client)](https://github.com/openviglet/shio/blob/HEAD/LICENSE)
+[![Website](https://img.shields.io/badge/shio.viglet.org-0ea5e9?logo=googlechrome&logoColor=white)](https://shio.viglet.org/)
+
+Framework-agnostic **TypeScript client** for the Content Delivery API (CDA) of
+**[Viglet Shio](https://shio.viglet.org/)**, the open source **headless CMS built
+for coding agents**.
 
 - **Zero runtime dependencies** — just `fetch`.
 - Runs in **Node, the browser, edge runtimes, Next.js server components, Astro, Vue, Svelte** and plain scripts.
 - Targets the stable, read-only CDA contract (`/api/v2/cda/**`) — no Java, no legacy console API.
-- This is the **base** SDK; `@viglet/shio-react-sdk` is one consumer of it.
+- This is the **base** SDK; [`@viglet/shio-react-sdk`](https://www.npmjs.com/package/@viglet/shio-react-sdk) is one consumer of it.
+- Pair it with [`@viglet/shio`](https://www.npmjs.com/package/@viglet/shio) — `shio types` generates a `.d.ts` from your live content model, so `post.attrs.*` autocompletes.
 
 ## Install
 
@@ -95,6 +102,20 @@ npm run typecheck  # tsc --noEmit
 npm test           # node:test, no network (injected fetch)
 ```
 
+## Related packages
+
+| Package | For |
+|---|---|
+| [`@viglet/shio`](https://www.npmjs.com/package/@viglet/shio) | The Shio CLI — content as files, type generation, and the MCP bridge for [Claude Code](https://claude.com/claude-code) |
+| [`@viglet/shio-react-sdk`](https://www.npmjs.com/package/@viglet/shio-react-sdk) | React hooks and render components built on this client |
+| [`@viglet/shio-sections`](https://www.npmjs.com/package/@viglet/shio-sections) | The page-section vocabulary |
+| [`@viglet/shio-model`](https://www.npmjs.com/package/@viglet/shio-model) | Author the content model as typed code |
+| [`@viglet/shio-editor-cors`](https://www.npmjs.com/package/@viglet/shio-editor-cors) | Inline visual editing with the Universal Editor |
+| [`@viglet/create-shio-app`](https://www.npmjs.com/package/@viglet/create-shio-app) | Next.js starter generator |
+
 ## License
 
-GPL-3.0
+Apache-2.0 — [Viglet Shio](https://shio.viglet.org/) ·
+[github.com/openviglet/shio](https://github.com/openviglet/shio) ·
+[docs.viglet.org/shio](https://docs.viglet.org/shio/) ·
+part of the [Viglet](https://www.viglet.org) open source family.

package/bin/shio-types.mjs

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+/*
+ * Copyright (C) 2016-2026 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0.
+ *
+ * shio-types — generate a TypeScript `.d.ts` from a Shio instance's post-types
+ * (SH11). Fetches `/api/v2/cda/post-type` and writes typed `Post` interfaces so
+ * page code gets autocomplete on `post.attrs.*`.
+ *
+ *   npx shio-types --url http://localhost:2710 --token <CDA token> --out lib/shio-types.d.ts
+ *
+ * Env fallbacks: SHIO_URL, SHIO_CDA_TOKEN.
+ */
+import { writeFile } from "node:fs/promises";
+import { argv, env, exit, stdout } from "node:process";
+
+import { ShioClient, generateShioTypes } from "../dist/shio-client.js";
+
+const HELP = `shio-types — generate TypeScript types from Shio post-types
+
+Usage:
+  shio-types [options]
+
+Options:
+  --url <baseUrl>       Shio base URL        (env SHIO_URL, default http://localhost:2710)
+  --token <token>       CDA token            (env SHIO_CDA_TOKEN)
+  --out <file>          Output .d.ts path    (default shio-types.d.ts; "-" for stdout)
+  --import-from <mod>   Module to import ShioPost from (default @viglet/shio-client)
+  -h, --help            Show this help
+`;
+
+function parseArgs(args) {
+  const opts = {};
+  for (let i = 0; i < args.length; i++) {
+    const a = args[i];
+    switch (a) {
+      case "-h":
+      case "--help":
+        opts.help = true;
+        break;
+      case "--url":
+        opts.url = args[++i];
+        break;
+      case "--token":
+        opts.token = args[++i];
+        break;
+      case "--out":
+        opts.out = args[++i];
+        break;
+      case "--import-from":
+        opts.importFrom = args[++i];
+        break;
+      default:
+        fail(`Unknown argument: ${a}\n\n${HELP}`);
+    }
+  }
+  return opts;
+}
+
+function fail(message) {
+  process.stderr.write(`${message}\n`);
+  exit(1);
+}
+
+async function main() {
+  const opts = parseArgs(argv.slice(2));
+  if (opts.help) {
+    stdout.write(HELP);
+    return;
+  }
+
+  const baseUrl = opts.url ?? env.SHIO_URL ?? "http://localhost:2710";
+  const apiToken = opts.token ?? env.SHIO_CDA_TOKEN;
+  const out = opts.out ?? "shio-types.d.ts";
+
+  const client = new ShioClient({ baseUrl, apiToken });
+
+  let schemas;
+  try {
+    schemas = await client.getPostTypes();
+  } catch (err) {
+    fail(`shio-types: failed to fetch post-types from ${baseUrl}\n  ${err?.message ?? err}`);
+  }
+
+  const source = generateShioTypes(schemas, {
+    importFrom: opts.importFrom,
+  });
+
+  if (out === "-") {
+    stdout.write(source);
+    return;
+  }
+
+  await writeFile(out, source, "utf8");
+  stdout.write(`shio-types: wrote ${schemas.length} post-type(s) to ${out}\n`);
+}
+
+main().catch((err) => fail(`shio-types: ${err?.stack ?? err}`));

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { ShioClientConfig, ShioListing, ShioPageParams, ShioPath, ShioPost, ShioQueryParams, ShioRequestOptions, ShioSite } from "./types";
+import type { ShioClientConfig, ShioListing, ShioPageParams, ShioPath, ShioPost, ShioPostTypeSchema, ShioQueryParams, ShioRequestOptions, ShioSite } from "./types";
 /**
  * Framework-agnostic client for the Shio Content Delivery API (CDA, SH1).
  *
@@ -33,6 +33,14 @@ export declare class ShioClient {
      * routing (e.g. Next.js `[...slug]`). Returns `null` if unresolved.
      */
     getPostByUrl(siteId: string, url: string, opts?: ShioRequestOptions): Promise<ShioPost | null>;
+    /**
+     * List every post-type's content-model schema — the input to
+     * {@link generateShioTypes}. The schema is global (not site-scoped), so a
+     * per-site token sees every post-type.
+     */
+    getPostTypes(opts?: ShioRequestOptions): Promise<ShioPostTypeSchema[]>;
+    /** Get one post-type's content-model schema by its API name, or `null` if unknown. */
+    getPostType(name: string, opts?: ShioRequestOptions): Promise<ShioPostTypeSchema | null>;
     /** Query published posts by site / folder / post type (always returns a listing). */
     query(params?: ShioQueryParams, opts?: ShioRequestOptions): Promise<ShioListing>;
     private send;

package/dist/codegen.d.ts

@@ -0,0 +1,30 @@
+/**
+ * TypeScript code generation from Shio post-type schemas (SH11).
+ *
+ * Pure and dependency-free: it turns the {@link ShioPostTypeSchema}[] returned by
+ * {@link ShioClient.getPostTypes} into a `.d.ts` source string. The `shio-types`
+ * CLI ({@link file:../bin/shio-types.mjs}) wires the fetch + file write around it;
+ * keeping the transform pure makes it testable without a network or a filesystem.
+ */
+import type { ShioPostTypeSchema } from "./types";
+/** Options for {@link generateShioTypes}. */
+export interface GenerateTypesOptions {
+    /**
+     * The module the generated `Post` interfaces import `ShioPost` from. Defaults
+     * to the published package name; set to a relative path when generating into
+     * the SDK's own source tree.
+     */
+    importFrom?: string;
+    /** Override the file banner comment (e.g. to pin a version). */
+    banner?: string;
+}
+/**
+ * Generate `.d.ts` source declaring one typed `Post` interface per post-type,
+ * plus a `ShioPostTypes` name→type map. Page code then gets autocomplete on
+ * `post.attrs.*`.
+ *
+ * @example
+ * const schemas = await client.getPostTypes();
+ * await writeFile("shio-types.d.ts", generateShioTypes(schemas));
+ */
+export declare function generateShioTypes(schemas: ShioPostTypeSchema[], options?: GenerateTypesOptions): string;

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export { ShioClient, createShioClient } from "./client";
 export { ShioHttpError } from "./errors";
-export type { ShioClientConfig, ShioRequestOptions, ShioSite, ShioFolder, ShioPostSummary, ShioPost, ShioListing, ShioPath, ShioQueryParams, ShioPageParams, } from "./types";
+export { generateShioTypes } from "./codegen";
+export type { GenerateTypesOptions } from "./codegen";
+export type { ShioClientConfig, ShioRequestOptions, ShioSite, ShioFolder, ShioPostSummary, ShioPost, ShioListing, ShioPath, ShioQueryParams, ShioPageParams, ShioFieldSchema, ShioPostTypeSchema, } from "./types";

package/dist/shio-client.js

@@ -1,113 +1,139 @@
-class o extends Error {
-  constructor(e, t, i) {
-    super(`Shio CDA ${e} for ${t}`), this.name = "ShioHttpError", this.status = e, this.url = t, this.body = i, Object.setPrototypeOf(this, o.prototype);
-  }
+//#region src/errors.ts
+var e = class e extends Error {
+	constructor(t, n, r) {
+		super(`Shio CDA ${t} for ${n}`), this.name = "ShioHttpError", this.status = t, this.url = n, this.body = r, Object.setPrototypeOf(this, e.prototype);
+	}
+}, t = "/api/v2/cda", n = class {
+	constructor(e) {
+		if (!e?.baseUrl) throw Error("ShioClient: `baseUrl` is required");
+		this.baseUrl = e.baseUrl.replace(/\/+$/, ""), this.headers = {
+			Accept: "application/json",
+			...e.headers ?? {}
+		}, e.apiToken && (this.headers.Key = e.apiToken);
+		let t = e.fetch ?? globalThis.fetch;
+		if (typeof t != "function") throw Error("ShioClient: no global `fetch` available — pass `fetch` in the config");
+		this.fetchFn = t.bind(globalThis), this.credentials = e.credentials;
+	}
+	getSites(e) {
+		return this.request("/site", e);
+	}
+	getSite(e, t) {
+		return this.requestOrNull(`/site/${i(e)}`, t);
+	}
+	listChildren(e, t, n) {
+		let r = a({
+			page: t?.page,
+			size: t?.size
+		});
+		return this.requestOrNull(`/object/${i(e)}/list${r}`, n);
+	}
+	getPath(e, t) {
+		return this.requestOrNull(`/object/${i(e)}/path`, t);
+	}
+	getPost(e, t) {
+		return this.requestOrNull(`/post/${i(e)}`, t);
+	}
+	getPostByUrl(e, t, n) {
+		let r = a({
+			siteId: e,
+			url: t
+		});
+		return this.requestOrNull(`/post/by-url${r}`, n);
+	}
+	getPostTypes(e) {
+		return this.request("/post-type", e);
+	}
+	getPostType(e, t) {
+		return this.requestOrNull(`/post-type/${i(e)}`, t);
+	}
+	query(e, t) {
+		let n = a({
+			siteId: e?.siteId,
+			folderId: e?.folderId,
+			postType: e?.postType,
+			page: e?.page,
+			size: e?.size
+		});
+		return this.request(`/query${n}`, t);
+	}
+	async send(e, n) {
+		return this.fetchFn(`${this.baseUrl}${t}${e}`, {
+			method: "GET",
+			headers: this.headers,
+			signal: n?.signal,
+			...this.credentials ? { credentials: this.credentials } : {}
+		});
+	}
+	async request(t, n) {
+		let r = await this.send(t, n);
+		if (!r.ok) throw new e(r.status, t, await o(r));
+		return await r.json();
+	}
+	async requestOrNull(t, n) {
+		let r = await this.send(t, n);
+		if (r.status === 404) return null;
+		if (!r.ok) throw new e(r.status, t, await o(r));
+		return await r.json();
+	}
+};
+function r(e) {
+	return new n(e);
 }
-const u = "/api/v2/cda";
-class c {
-  constructor(e) {
-    if (!(e != null && e.baseUrl))
-      throw new Error("ShioClient: `baseUrl` is required");
-    this.baseUrl = e.baseUrl.replace(/\/+$/, ""), this.headers = { Accept: "application/json", ...e.headers ?? {} }, e.apiToken && (this.headers.Key = e.apiToken);
-    const t = e.fetch ?? globalThis.fetch;
-    if (typeof t != "function")
-      throw new Error(
-        "ShioClient: no global `fetch` available — pass `fetch` in the config"
-      );
-    this.fetchFn = t.bind(globalThis), this.credentials = e.credentials;
-  }
-  // --- Sites ---
-  /** List all published sites. */
-  getSites(e) {
-    return this.request("/site", e);
-  }
-  /** Get one site (with its root folder id), or `null` if not found. */
-  getSite(e, t) {
-    return this.requestOrNull(`/site/${n(e)}`, t);
-  }
-  // --- Navigation ---
-  /** List a folder's children (subfolders + published posts), or `null` if the folder is unknown. */
-  listChildren(e, t, i) {
-    const r = h({ page: t == null ? void 0 : t.page, size: t == null ? void 0 : t.size });
-    return this.requestOrNull(
-      `/object/${n(e)}/list${r}`,
-      i
-    );
-  }
-  /** Get the breadcrumb path for a folder or post, or `null` if unknown. */
-  getPath(e, t) {
-    return this.requestOrNull(`/object/${n(e)}/path`, t);
-  }
-  // --- Posts ---
-  /** Get a published post by id (attributes expanded), or `null` if not found / not published. */
-  getPost(e, t) {
-    return this.requestOrNull(`/post/${n(e)}`, t);
-  }
-  /**
-   * Resolve a published post by site + friendly URL — the call behind catch-all
-   * routing (e.g. Next.js `[...slug]`). Returns `null` if unresolved.
-   */
-  getPostByUrl(e, t, i) {
-    const r = h({ siteId: e, url: t });
-    return this.requestOrNull(`/post/by-url${r}`, i);
-  }
-  /** Query published posts by site / folder / post type (always returns a listing). */
-  query(e, t) {
-    const i = h({
-      siteId: e == null ? void 0 : e.siteId,
-      folderId: e == null ? void 0 : e.folderId,
-      postType: e == null ? void 0 : e.postType,
-      page: e == null ? void 0 : e.page,
-      size: e == null ? void 0 : e.size
-    });
-    return this.request(`/query${i}`, t);
-  }
-  // --- internals ---
-  async send(e, t) {
-    return this.fetchFn(`${this.baseUrl}${u}${e}`, {
-      method: "GET",
-      headers: this.headers,
-      signal: t == null ? void 0 : t.signal,
-      ...this.credentials ? { credentials: this.credentials } : {}
-    });
-  }
-  async request(e, t) {
-    const i = await this.send(e, t);
-    if (!i.ok)
-      throw new o(i.status, e, await l(i));
-    return await i.json();
-  }
-  async requestOrNull(e, t) {
-    const i = await this.send(e, t);
-    if (i.status === 404)
-      return null;
-    if (!i.ok)
-      throw new o(i.status, e, await l(i));
-    return await i.json();
-  }
+function i(e) {
+	return encodeURIComponent(e);
 }
-function d(s) {
-  return new c(s);
+function a(e) {
+	let t = new URLSearchParams();
+	for (let [n, r] of Object.entries(e)) r != null && r !== "" && t.append(n, String(r));
+	let n = t.toString();
+	return n ? `?${n}` : "";
 }
-function n(s) {
-  return encodeURIComponent(s);
+async function o(e) {
+	try {
+		return await e.text();
+	} catch {
+		return;
+	}
 }
-function h(s) {
-  const e = new URLSearchParams();
-  for (const [i, r] of Object.entries(s))
-    r != null && r !== "" && e.append(i, String(r));
-  const t = e.toString();
-  return t ? `?${t}` : "";
+//#endregion
+//#region src/codegen.ts
+var s = "@viglet/shio-client", c = "// AUTO-GENERATED by @viglet/shio-client (shio-types). DO NOT EDIT BY HAND.\n// Re-run `shio-types` after changing a post-type.";
+function l(e, t = {}) {
+	let n = t.importFrom ?? s, r = t.banner ?? c, i = [...e].sort((e, t) => e.name.localeCompare(t.name)), a = /* @__PURE__ */ new Map(), o = /* @__PURE__ */ new Set();
+	for (let e of i) {
+		let t = m(e.name) || "PostType", n = t, r = 2;
+		for (; o.has(n);) n = `${t}${r++}`;
+		o.add(n), a.set(e.name, n);
+	}
+	let l = [];
+	for (let e of i) {
+		let t = a.get(e.name), n = f(e.title ?? e.description, 0);
+		l.push(`${n}export interface ${t}Attrs {\n${u(e.fields, 1)}}\n\n/** A \`${e.name}\` post with typed attributes. */\nexport type ${t}Post = ShioPost & {\n  postType: ${JSON.stringify(e.name)};\n  attrs: ${t}Attrs;\n};`);
+	}
+	let d = `/** Maps each post-type's API name to its typed post interface. */
+export interface ShioPostTypes {\n${i.map((e) => `  ${p(e.name)}: ${a.get(e.name)}Post;`).join("\n") || ""}\n}\n\n/** Union of all known post-type API names. */
+export type ShioPostTypeName = keyof ShioPostTypes;`;
+	return `${r}\n\nimport type { ShioPost } from ${JSON.stringify(n)};\n\n` + (l.length ? `${l.join("\n\n")}\n\n` : "") + `${d}\n`;
 }
-async function l(s) {
-  try {
-    return await s.text();
-  } catch {
-    return;
-  }
+function u(e, t) {
+	let n = "  ".repeat(t);
+	return [...e].sort((e, t) => e.ordinal - t.ordinal).map((e) => {
+		let r = f(e.label ?? e.description, t), i = e.required ? "" : "?";
+		return `${r}${n}${p(e.name)}${i}: ${d(e, t)};\n`;
+	}).join("");
 }
-export {
-  c as ShioClient,
-  o as ShioHttpError,
-  d as createShioClient
-};
+function d(e, t) {
+	return e.fields && e.fields.length > 0 ? `Array<{\n${u(e.fields, t + 1)}${"  ".repeat(t)}}>` : e.multiple ? "string[]" : "string";
+}
+function f(e, t) {
+	return !e || !e.trim() ? "" : `${"  ".repeat(t)}/** ${e.trim().replace(/\*\//g, "*\\/")} */\n`;
+}
+function p(e) {
+	return /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(e) ? e : JSON.stringify(e);
+}
+function m(e) {
+	let t = (e ?? "").split(/[^A-Za-z0-9]+/).filter(Boolean).map((e) => e.charAt(0).toUpperCase() + e.slice(1)).join("");
+	return /^[0-9]/.test(t) && (t = `T${t}`), t;
+}
+//#endregion
+export { n as ShioClient, e as ShioHttpError, r as createShioClient, l as generateShioTypes };

package/dist/shio-client.umd.cjs

@@ -1 +1,6 @@
-(function(s,n){typeof exports=="object"&&typeof module<"u"?n(exports):typeof define=="function"&&define.amd?define(["exports"],n):(s=typeof globalThis<"u"?globalThis:s||self,n(s.ShioClient={}))})(this,(function(s){"use strict";class n extends Error{constructor(e,t,i){super(`Shio CDA ${e} for ${t}`),this.name="ShioHttpError",this.status=e,this.url=t,this.body=i,Object.setPrototypeOf(this,n.prototype)}}const d="/api/v2/cda";class u{constructor(e){if(!(e!=null&&e.baseUrl))throw new Error("ShioClient: `baseUrl` is required");this.baseUrl=e.baseUrl.replace(/\/+$/,""),this.headers={Accept:"application/json",...e.headers??{}},e.apiToken&&(this.headers.Key=e.apiToken);const t=e.fetch??globalThis.fetch;if(typeof t!="function")throw new Error("ShioClient: no global `fetch` available — pass `fetch` in the config");this.fetchFn=t.bind(globalThis),this.credentials=e.credentials}getSites(e){return this.request("/site",e)}getSite(e,t){return this.requestOrNull(`/site/${l(e)}`,t)}listChildren(e,t,i){const o=h({page:t==null?void 0:t.page,size:t==null?void 0:t.size});return this.requestOrNull(`/object/${l(e)}/list${o}`,i)}getPath(e,t){return this.requestOrNull(`/object/${l(e)}/path`,t)}getPost(e,t){return this.requestOrNull(`/post/${l(e)}`,t)}getPostByUrl(e,t,i){const o=h({siteId:e,url:t});return this.requestOrNull(`/post/by-url${o}`,i)}query(e,t){const i=h({siteId:e==null?void 0:e.siteId,folderId:e==null?void 0:e.folderId,postType:e==null?void 0:e.postType,page:e==null?void 0:e.page,size:e==null?void 0:e.size});return this.request(`/query${i}`,t)}async send(e,t){return this.fetchFn(`${this.baseUrl}${d}${e}`,{method:"GET",headers:this.headers,signal:t==null?void 0:t.signal,...this.credentials?{credentials:this.credentials}:{}})}async request(e,t){const i=await this.send(e,t);if(!i.ok)throw new n(i.status,e,await c(i));return await i.json()}async requestOrNull(e,t){const i=await this.send(e,t);if(i.status===404)return null;if(!i.ok)throw new n(i.status,e,await c(i));return await i.json()}}function f(r){return new u(r)}function l(r){return encodeURIComponent(r)}function h(r){const e=new URLSearchParams;for(const[i,o]of Object.entries(r))o!=null&&o!==""&&e.append(i,String(o));const t=e.toString();return t?`?${t}`:""}async function c(r){try{return await r.text()}catch{return}}s.ShioClient=u,s.ShioHttpError=n,s.createShioClient=f,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})}));
+(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports):typeof define==`function`&&define.amd?define([`exports`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.ShioClient={}))})(this,function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=class e extends Error{constructor(t,n,r){super(`Shio CDA ${t} for ${n}`),this.name=`ShioHttpError`,this.status=t,this.url=n,this.body=r,Object.setPrototypeOf(this,e.prototype)}},n=`/api/v2/cda`,r=class{constructor(e){if(!e?.baseUrl)throw Error("ShioClient: `baseUrl` is required");this.baseUrl=e.baseUrl.replace(/\/+$/,``),this.headers={Accept:`application/json`,...e.headers??{}},e.apiToken&&(this.headers.Key=e.apiToken);let t=e.fetch??globalThis.fetch;if(typeof t!=`function`)throw Error("ShioClient: no global `fetch` available — pass `fetch` in the config");this.fetchFn=t.bind(globalThis),this.credentials=e.credentials}getSites(e){return this.request(`/site`,e)}getSite(e,t){return this.requestOrNull(`/site/${a(e)}`,t)}listChildren(e,t,n){let r=o({page:t?.page,size:t?.size});return this.requestOrNull(`/object/${a(e)}/list${r}`,n)}getPath(e,t){return this.requestOrNull(`/object/${a(e)}/path`,t)}getPost(e,t){return this.requestOrNull(`/post/${a(e)}`,t)}getPostByUrl(e,t,n){let r=o({siteId:e,url:t});return this.requestOrNull(`/post/by-url${r}`,n)}getPostTypes(e){return this.request(`/post-type`,e)}getPostType(e,t){return this.requestOrNull(`/post-type/${a(e)}`,t)}query(e,t){let n=o({siteId:e?.siteId,folderId:e?.folderId,postType:e?.postType,page:e?.page,size:e?.size});return this.request(`/query${n}`,t)}async send(e,t){return this.fetchFn(`${this.baseUrl}${n}${e}`,{method:`GET`,headers:this.headers,signal:t?.signal,...this.credentials?{credentials:this.credentials}:{}})}async request(e,n){let r=await this.send(e,n);if(!r.ok)throw new t(r.status,e,await s(r));return await r.json()}async requestOrNull(e,n){let r=await this.send(e,n);if(r.status===404)return null;if(!r.ok)throw new t(r.status,e,await s(r));return await r.json()}};function i(e){return new r(e)}function a(e){return encodeURIComponent(e)}function o(e){let t=new URLSearchParams;for(let[n,r]of Object.entries(e))r!=null&&r!==``&&t.append(n,String(r));let n=t.toString();return n?`?${n}`:``}async function s(e){try{return await e.text()}catch{return}}var c=`@viglet/shio-client`,l="// AUTO-GENERATED by @viglet/shio-client (shio-types). DO NOT EDIT BY HAND.\n// Re-run `shio-types` after changing a post-type.";function u(e,t={}){let n=t.importFrom??c,r=t.banner??l,i=[...e].sort((e,t)=>e.name.localeCompare(t.name)),a=new Map,o=new Set;for(let e of i){let t=h(e.name)||`PostType`,n=t,r=2;for(;o.has(n);)n=`${t}${r++}`;o.add(n),a.set(e.name,n)}let s=[];for(let e of i){let t=a.get(e.name),n=p(e.title??e.description,0);s.push(`${n}export interface ${t}Attrs {\n${d(e.fields,1)}}\n\n/** A \`${e.name}\` post with typed attributes. */\nexport type ${t}Post = ShioPost & {\n  postType: ${JSON.stringify(e.name)};\n  attrs: ${t}Attrs;\n};`)}let u=`/** Maps each post-type's API name to its typed post interface. */
+export interface ShioPostTypes {\n${i.map(e=>`  ${m(e.name)}: ${a.get(e.name)}Post;`).join(`
+`)||``}\n}\n\n/** Union of all known post-type API names. */
+export type ShioPostTypeName = keyof ShioPostTypes;`;return`${r}\n\nimport type { ShioPost } from ${JSON.stringify(n)};\n\n`+(s.length?`${s.join(`
+
+`)}\n\n`:``)+`${u}\n`}function d(e,t){let n=`  `.repeat(t);return[...e].sort((e,t)=>e.ordinal-t.ordinal).map(e=>{let r=p(e.label??e.description,t),i=e.required?``:`?`;return`${r}${n}${m(e.name)}${i}: ${f(e,t)};\n`}).join(``)}function f(e,t){return e.fields&&e.fields.length>0?`Array<{\n${d(e.fields,t+1)}${`  `.repeat(t)}}>`:e.multiple?`string[]`:`string`}function p(e,t){return!e||!e.trim()?``:`${`  `.repeat(t)}/** ${e.trim().replace(/\*\//g,`*\\/`)} */\n`}function m(e){return/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(e)?e:JSON.stringify(e)}function h(e){let t=(e??``).split(/[^A-Za-z0-9]+/).filter(Boolean).map(e=>e.charAt(0).toUpperCase()+e.slice(1)).join(``);return/^[0-9]/.test(t)&&(t=`T${t}`),t}e.ShioClient=r,e.ShioHttpError=t,e.createShioClient=i,e.generateShioTypes=u});

package/dist/types.d.ts

@@ -3,6 +3,14 @@
  * `/api/v2/cda/**`). Field names track the backend DTO records
  * (`com.viglet.shio.api.cda.dto`) one-for-one — they are a frozen public
  * contract; do not rename.
+ *
+ * **Optional, not nullable (SH127).** A field the CMS has no value for is *absent*
+ * from the JSON rather than present as `null`, so it is declared `field?: T` here.
+ * These two halves shipped together and had to: the backend omits the null because
+ * `"url": null` costs bytes and tokens to say nothing, and this file declares it
+ * optional because a consumer written against `string | null` would otherwise start
+ * receiving `undefined` from a comparison it believed was exhaustive. Narrow with a
+ * falsy check (`if (post.title)`) rather than `=== null`.
  */
 /** Configuration for {@link ShioClient}. */
 export interface ShioClientConfig {
@@ -35,9 +43,9 @@ export interface ShioRequestOptions {
 export interface ShioSite {
     id: string;
     name: string;
-    description: string | null;
-    url: string | null;
-    rootFolderId: string | null;
+    description?: string;
+    url?: string;
+    rootFolderId?: string;
 }
 /** A folder (listing item / breadcrumb node). */
 export interface ShioFolder {
@@ -48,32 +56,42 @@ export interface ShioFolder {
 /** A post listing item — no heavy attribute payload. */
 export interface ShioPostSummary {
     id: string;
-    title: string | null;
-    summary: string | null;
-    furl: string | null;
-    postType: string | null;
-    date: string | null;
-    modifiedDate: string | null;
+    title?: string;
+    summary?: string;
+    furl?: string;
+    postType?: string;
+    /** BCP-47 locale of this row (SH52), absent on single-language content. */
+    locale?: string;
+    date?: string;
+    modifiedDate?: string;
 }
 /** A full post with its post-type attributes expanded into {@link attrs}. */
 export interface ShioPost {
     id: string;
-    title: string | null;
-    summary: string | null;
-    furl: string | null;
-    postType: string | null;
-    siteId: string | null;
-    folderId: string | null;
+    title?: string;
+    summary?: string;
+    furl?: string;
+    postType?: string;
+    siteId?: string;
+    folderId?: string;
     published: boolean;
-    date: string | null;
-    modifiedDate: string | null;
-    publicationDate: string | null;
+    date?: string;
+    modifiedDate?: string;
+    publicationDate?: string;
+    /** BCP-47 locale of this post (SH52), absent on single-language content. */
+    locale?: string;
+    /**
+     * Every locale this post is translated into, including {@link locale} — the
+     * list a language switcher renders from (SH52). Always present; `[]` on a
+     * post with no translation group.
+     */
+    availableLocales: string[];
     /** Post-type attributes as a JSON object, keyed by attribute name. */
     attrs: Record<string, unknown>;
 }
 /** Folder children: subfolders plus a paged slice of published posts. */
 export interface ShioListing {
-    folderId: string | null;
+    folderId?: string;
     folders: ShioFolder[];
     posts: ShioPostSummary[];
     page: number;
@@ -82,10 +100,46 @@ export interface ShioListing {
 }
 /** Breadcrumb path for a folder or post. */
 export interface ShioPath {
-    site: ShioSite | null;
+    site?: ShioSite;
     /** Ordered root → ... → current. */
     breadcrumb: ShioFolder[];
-    currentFolder: ShioFolder | null;
+    currentFolder?: ShioFolder;
+}
+/**
+ * One field of a post-type's content model (SH11). Recursive: a Relator field
+ * carries its item sub-fields in {@link fields}. Mirrors the backend
+ * `ShCdaSchemaField` record one-for-one.
+ */
+export interface ShioFieldSchema {
+    name: string;
+    label?: string;
+    description?: string;
+    /** The Shio widget name (e.g. `"Text"`, `"Relator"`), or `null`. */
+    widget?: string;
+    required: boolean;
+    /**
+     * The delivered value is an array — a `Check Box` / `Multi Select` value, or a
+     * Relator's item list (in which case {@link fields} is non-empty).
+     */
+    multiple: boolean;
+    isTitle: boolean;
+    isSummary: boolean;
+    ordinal: number;
+    /** Sub-fields, for a Relator; empty for scalar fields. */
+    fields: ShioFieldSchema[];
+}
+/**
+ * A post-type's content model (SH11): its API {@link name} plus the ordered
+ * fields a post of this type exposes under {@link ShioPost.attrs}. Mirrors the
+ * backend `ShCdaPostTypeSchema` record. Feed an array of these to
+ * {@link generateShioTypes} to emit `.d.ts` declarations.
+ */
+export interface ShioPostTypeSchema {
+    name: string;
+    title?: string;
+    namePlural?: string;
+    description?: string;
+    fields: ShioFieldSchema[];
 }
 /** Parameters for {@link ShioClient.query}. */
 export interface ShioQueryParams {

package/package.json

@@ -1,7 +1,16 @@
 {
   "name": "@viglet/shio-client",
-  "version": "2026.2.1",
+  "version": "2026.3.2",
   "description": "Framework-agnostic TypeScript client for the Shio CMS Content Delivery API (CDA). Zero runtime dependencies — works in Node, the browser, edge runtimes, Next.js server components, Astro, Vue, Svelte and plain scripts.",
+  "homepage": "https://shio.viglet.org/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openviglet/shio.git",
+    "directory": "shio-client"
+  },
+  "bugs": {
+    "url": "https://github.com/openviglet/shio/issues"
+  },
   "type": "module",
   "main": "dist/shio-client.umd.cjs",
   "module": "dist/shio-client.js",
@@ -11,27 +20,47 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/shio-client.js",
       "require": "./dist/shio-client.umd.cjs"
-    }
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "shio-types": "bin/shio-types.mjs"
   },
   "files": [
-    "dist"
+    "dist",
+    "bin"
   ],
   "sideEffects": false,
   "devDependencies": {
     "typescript": "^5.8.3",
-    "vite": "^6.3.1"
+    "vite": "^8.2.0"
   },
   "keywords": [
     "shio",
+    "viglet",
     "cms",
-    "headless",
+    "headless-cms",
+    "content-management-system",
+    "agent",
+    "ai",
+    "mcp",
+    "model-context-protocol",
+    "claude-code",
     "cda",
     "content-delivery",
     "typescript",
-    "sdk"
+    "sdk",
+    "api-client",
+    "nextjs",
+    "astro",
+    "edge",
+    "headless"
   ],
-  "author": "Viglet Team",
-  "license": "GPL-3.0",
+  "author": {
+    "name": "Viglet Team",
+    "url": "https://www.viglet.org"
+  },
+  "license": "Apache-2.0",
   "scripts": {
     "dev": "vite build --watch",
     "build": "vite build && tsc --emitDeclarationOnly",