@byamoah/studio-state 0.0.0-stage → 0.1.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @byamoah/studio-state
+
+## 0.1.0-beta.0
+
+Initial public prerelease.
+
+- Typed React context with generated state declarations.
+- Repeatable collections, registered layout blocks, nested slots and stable item identities.
+- Validated content delivery with persistent caching, readiness status and refresh controls.
+- Document validation, collection editing, presets and migration utilities.
+- Apache-2.0 license and package integration documentation.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,3 +1,381 @@
-# Temporary Holding Version
+# @byamoah/studio-state
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Typed, remotely managed content for React and React Native applications. Read editable values through React context, render repeatable components and configurable layouts, and deliver compatible content revisions with persistent caching.
+
+Studio changes data rendered by components already shipped in your application. It does not download new components or execute server-provided JavaScript. Database records, authentication and transactions remain owned by your application.
+
+## Installation
+
+```sh
+npm install @byamoah/studio-state@next @byamoah/studio-core@next
+```
+
+The initial release is a prerelease distributed under `next`. Use matching versions of both packages. React 18 or later is a peer dependency. Use the React instance already supplied by your application. The companion CLI requires Node.js 22.18 or later.
+
+| Import | Purpose |
+| --- | --- |
+| `@byamoah/studio-state/react` | Providers, hooks, repeats, layouts and slots |
+| `@byamoah/studio-state/delivery` | Delivery client, revision validation and development endpoint parsing |
+| `@byamoah/studio-state` | Contract validation, collection operations, presets and migrations |
+
+## First editable screen
+
+Initialize the CLI in the application root:
+
+```sh
+npx --no-install studio init
+```
+
+Set `projectId` and `routesDir` in the created `studio.config.mjs`. For a route-based React Native app, a screen can read editable content directly:
+
+```tsx
+// src/app/index.tsx
+import { Text, View } from "react-native";
+import { useStudioContext } from "@byamoah/studio-state/react";
+
+export default function Home() {
+  const std = useStudioContext();
+
+  return (
+    <View>
+      <Text style={{ color: std.theme.color.heading }}>
+        {std.screens.home.title}
+      </Text>
+    </View>
+  );
+}
+```
+
+Generate the contract, authoring snapshot and TypeScript declarations:
+
+```sh
+npx --no-install studio discover
+npx --no-install studio dev
+```
+
+The second command watches for source changes. Ensure `studio-env.d.ts` is included by the application's TypeScript configuration. Generated declarations augment `StudioState`; do not edit the generated interface or maintain a duplicate list of fields.
+
+The name `std` is a convention. Discovery tracks the imported `useStudioContext` binding. Direct, statically resolvable property access gives discovery the clearest information. A computed property selected only at runtime may require a more explicit supported binding; check diagnostics with `studio check`.
+
+### Provide a document
+
+For a local authoring snapshot, place this provider above the routes:
+
+```tsx
+import type { ReactNode } from "react";
+import { StudioProvider } from "@byamoah/studio-state/react";
+import document from "./.studio/content.snapshot.json";
+import type { StudioContract } from "@byamoah/studio-state";
+import contractJson from "./.studio/state.contract.json";
+
+const contract = contractJson as StudioContract;
+
+export function ContentRoot({ children }: { children: ReactNode }) {
+  return (
+    <StudioProvider value={document} contract={contract}>
+      {children}
+    </StudioProvider>
+  );
+}
+```
+
+Paths above assume this module is at the project root and TypeScript supports JSON imports. Generate the files before importing them. This is a bundled snapshot: it does not subscribe to Studio changes or fetch published updates. Use the delivery client below for that behavior.
+
+Discovery scaffolds supported new values into the authoring document and preserves existing edits. A developer-maintained defaults object is optional. Authoring scaffolds are not automatically production content.
+
+## Deliver content to installed applications
+
+Create one client per endpoint/project configuration and keep its identity stable across renders. The storage interface works with any asynchronous key-value store:
+
+```ts
+// content-client.ts — React Native example
+import AsyncStorage from "@react-native-async-storage/async-storage";
+import { createContentClient } from "@byamoah/studio-state/delivery";
+import { validateStudioState } from "@byamoah/studio-state";
+import type { StudioState } from "@byamoah/studio-state/react";
+import type { StudioContract } from "@byamoah/studio-state";
+import contractJson from "./.studio/state.contract.json";
+
+const contract = contractJson as StudioContract;
+
+export const contentClient = createContentClient<StudioState>({
+  projectId: "my-app",
+  schemaVersion: 1,
+  contractId: contract.contractId,
+  endpoint: "https://content.example.com/studio/content",
+  mode: "production",
+  storage: AsyncStorage,
+  validate: (value) => validateStudioState(value, contract),
+});
+```
+
+Install a storage implementation appropriate to your framework separately; it is not bundled with Studio. In an Expo project, install native storage with `npx expo install @react-native-async-storage/async-storage`. Web applications can implement `getItem` and `setItem` around their own persistent store. The SDK does not read environment variables itself: resolve the endpoint through your framework's public configuration and pass it to `endpoint`.
+
+Mount the delivery provider and gate content-dependent screens:
+
+```tsx
+import type { ReactNode } from "react";
+import { Text } from "react-native";
+import {
+  StudioDeliveryProvider,
+  useStudioStatus,
+} from "@byamoah/studio-state/react";
+import { contentClient } from "./content-client";
+import type { StudioContract } from "@byamoah/studio-state";
+import contractJson from "./.studio/state.contract.json";
+
+const contract = contractJson as StudioContract;
+
+function ContentBoundary({ children }: { children: ReactNode }) {
+  const status = useStudioStatus();
+
+  if (!status.ready) {
+    return <Text>{status.error ? "Content is unavailable. Try again." : "Loading…"}</Text>;
+  }
+
+  return children;
+}
+
+export function ContentRoot({ children }: { children: ReactNode }) {
+  return (
+    <StudioDeliveryProvider client={contentClient} contract={contract}>
+      <ContentBoundary>{children}</ContentBoundary>
+    </StudioDeliveryProvider>
+  );
+}
+```
+
+Replace the loading view with your application's skeleton and retry experience. Keep hooks unconditional. Mount components that dereference content only when `ready` is true; the typed context is not a promise that a first-launch document has already arrived.
+
+### Client options
+
+| Option | Purpose |
+| --- | --- |
+| `projectId`, `schemaVersion` | Stable content identity and schema version |
+| `contractId` | Generated compatibility ID; use it for build-specific delivery |
+| `validate(value)` | Return validation error strings, or an empty array |
+| `storage` | Asynchronous `getItem(key)` and `setItem(key, value)` |
+| `endpoint` | Content API URL; omit for explicitly supplied local content |
+| `mode` | Development or production classification and cache separation |
+| `initialContent` | Optional validated document available before a fetch |
+| `prepare(document, signal)` | Optional media preparation before activation |
+| `timeoutMs` | Request timeout; defaults to 8,000 milliseconds |
+| `maxCharacters` | Maximum envelope text length; defaults to 4,000,000 characters |
+| `fetch` | Optional replacement fetch implementation |
+| `allowHttp` | Explicitly permit HTTP for development |
+
+`defaults` is an older optional fallback alias; prefer `initialContent` in new integrations.
+
+### Delivery lifecycle
+
+1. The client reads and validates cached content.
+2. It requests a compatible revision from the configured endpoint.
+3. It validates identity, schema, contract and document before activation.
+4. If supplied, `prepare(document, signal)` resolves required media before activation.
+5. It activates the accepted document and persists it for later launches.
+
+On a request, validation or preparation failure, previously accepted content remains usable. Without valid cache, `initialContent`, or a successful fetch, `ready` remains false. The application decides what to show. `initialContent` is an explicit optional fallback, not an implicit defaults source.
+
+Caches are separated by project, schema, contract, mode and endpoint. Changing these can intentionally produce a fresh cache. Persisted JSON alone does not guarantee that remote media will be available offline; use `prepare` and an application media cache when required.
+
+### Server response
+
+Serve JSON using this envelope; only `document` depends on your project:
+
+```json
+{
+  "protocolVersion": 1,
+  "projectId": "my-app",
+  "schemaVersion": 1,
+  "contractId": "<generated contractId>",
+  "revision": "release-0001",
+  "publishedAt": "2026-11-08T12:00:00.000Z",
+  "document": {
+    "theme": { "color": { "heading": "#17212B" } },
+    "screens": { "home": { "title": "Welcome back" } }
+  }
+}
+```
+
+The document must satisfy the entire generated contract, including any collections used by the application. The client adds `projectId` and `contractId` query parameters. Your server must select a revision compatible with that installed build. Keep prior compatible releases available when new application versions change the contract. Do not change the contract ID merely to force an incompatible document through validation.
+
+Use HTTPS in production. `allowHttp: true` exists for development endpoints. Configure browser CORS when the content endpoint and web application have different origins. Never put publishing credentials in a client application.
+
+### Status and refresh
+
+```tsx
+import { Button } from "react-native";
+import { useStudioStatus } from "@byamoah/studio-state/react";
+
+export function RefreshContent() {
+  const { refresh, refreshing } = useStudioStatus();
+  return (
+    <Button title={refreshing ? "Refreshing…" : "Refresh content"}
+      disabled={refreshing} onPress={() => void refresh()} />
+  );
+}
+```
+
+| Status | Meaning |
+| --- | --- |
+| `ready` | A usable document is available |
+| `hydrated` | The initial cache read has completed |
+| `refreshing` | A refresh is in progress |
+| `source` | Origin of the current document, such as cache or remote |
+| `revision` | Active revision, or `null` |
+| `error` | Latest delivery error, or `null`; content may still be ready |
+| `phase` | Optional detail: hydrating, fetching, preparing or idle |
+| `channel` | Optional draft/published/unknown classification |
+| `checkedAt` | Optional timestamp of the latest check |
+| `contractId` | Optional active compatibility identifier |
+| `refresh()` | Request another update |
+
+For non-React consumers, the client exposes `getSnapshot`, `subscribe`, `start`, `refresh` and `stop`. `StudioDeliveryProvider` manages subscription and start/stop. `StudioProvider` only supplies the value and status you pass; it does not own network delivery.
+
+### Development pairing
+
+`studioDevelopmentEndpoint(link, development)` parses Studio connection links:
+
+```ts
+import { studioDevelopmentEndpoint } from "@byamoah/studio-state/delivery";
+
+const result = studioDevelopmentEndpoint(incomingLink, isDevelopment);
+// string: validated draft endpoint
+// null: disconnect request
+// undefined: unrelated link or development disabled
+```
+
+Handle both launch links and later link events using your framework. Recreate the client when its selected endpoint changes. Permit a paired endpoint to override the production endpoint only in development. Both channels use the same revision envelope. Pairing, navigation and inspection bridges require integration in the application; the provider alone does not implement them.
+
+## Repeatable components
+
+Bind a collection directly instead of declaring a separate list of paths:
+
+```tsx
+import { Text, View } from "react-native";
+import * as Studio from "@byamoah/studio-state/react";
+
+function Card({ id }: Studio.RepeatItemProps) {
+  const std = Studio.useStudioContext();
+  const card = Studio.useStudioListItem(std.screens.home.cards, id);
+  const testID = Studio.useStudioInstanceId("card");
+  return <View testID={testID}><Text>{card.title}</Text></View>;
+}
+
+export function Cards() {
+  const std = Studio.useStudioContext();
+  return (
+    <View>
+      <Studio.Repeat items={std.screens.home.cards} template={Card} />
+    </View>
+  );
+}
+```
+
+Run discovery after introducing the collection and item fields. Each item has a stable string `id`. The compiler infers templates and item fields from the supported usage. `Repeat` owns iteration and keys: do not wrap it in another `.map()` over the same collection.
+
+`Repeat` is headless. Your `View`, row, grid or scrolling component owns actual layout. `direction="horizontal"` describes editing order; it does not apply a flex style. Pass non-editorial runtime values through `itemProps`. The template receives `id`, `index` and `instanceId` in addition to those props.
+
+Use `useStudioRepeat` when a pager requires separate keyed children. `useStudioCollection(items, { reveal })` and `Repeat`'s `reveal(id)` can register an application scrolling callback so inspection can reveal an off-screen item. Virtualized or hidden content still needs a working reveal implementation.
+
+Duplication creates new owned identities, including registered nested owned collections. External entity references should remain references. Use `useStudioInstanceId(suffix)` for owned attributes such as test or accessibility linkage IDs; do not copy hardcoded unique IDs into templates.
+
+## Layouts and slots
+
+Register component implementations shipped with the application:
+
+```tsx
+import { Text, View } from "react-native";
+import * as Studio from "@byamoah/studio-state/react";
+
+function Heading() {
+  const block = Studio.useStudioBlock("heading");
+  return <Text>{block.title}</Text>;
+}
+
+function Notice() {
+  const block = Studio.useStudioBlock("notice");
+  return <Text>{block.message}</Text>;
+}
+
+const blocks = Studio.defineBlocks({ heading: Heading, notice: Notice });
+
+export function Page() {
+  const std = Studio.useStudioContext();
+  return <View><Studio.Layout items={std.screens.home.sections} blocks={blocks} /></View>;
+}
+```
+
+The generated collection contains stable `id` and `type` properties. Discovery records the registered variants and their fields. Studio can insert, replace, remove and reorder allowed variants. Publishing a new variant requires first shipping its implementation in an application build.
+
+Within a block, expose a nested region using a literal slot name and an allowed registry:
+
+```tsx
+import { Text, View } from "react-native";
+import * as Studio from "@byamoah/studio-state/react";
+
+// blocks is the allowed registry declared above.
+function Panel() {
+  const block = Studio.useStudioBlock("panel");
+  return (
+    <View>
+      <Text>{block.title}</Text>
+      <Studio.Slot name="footer" blocks={blocks} />
+    </View>
+  );
+}
+```
+
+Register `Panel` in the parent layout's block registry. Slots belong to their enclosing block and store their nested content under owned `.slots` collections. The allowed registry controls what can be placed there; arbitrary native views cannot be moved into undeclared regions.
+
+## Contract and document utilities
+
+The root entry point supplies lower-level functions for custom editors and servers:
+
+| Area | Exports |
+| --- | --- |
+| Validation and access | `validateStudioState`, `getStudioValue`, `expandStudioPath`, `studioItemSegment` |
+| List editing | `createStudioItem`, `duplicateStudioItem`, `moveStudioItem`, `removeStudioItem` |
+| Layout editing | `insertStudioBlock`, `studioCollectionDefinition`, `matchesStudioConditions` |
+| Presets | `createStudioPreset`, `insertStudioPreset` |
+| Migration | `compareStudioContracts`, `studioMigrationFieldKey`, `previewStudioMigration` |
+| Explicit fallbacks | `defineStudioDefaults`, `mergeStudioDefaults` |
+| Reveal coordination | `requestStudioItemReveal`, `subscribeStudioReveal` |
+
+Editing functions operate on the supplied document. Clone first when using immutable application state, then validate the candidate before persisting or publishing:
+
+```ts
+import { duplicateStudioItem, validateStudioState } from "@byamoah/studio-state";
+
+const candidate = structuredClone(document);
+const newId = duplicateStudioItem(candidate, "screens.home.cards", selectedId, {
+  position: "after",
+});
+const errors = validateStudioState(candidate, contract);
+if (errors.length) throw new Error(errors.join("\n"));
+// Commit candidate to your editor's state. newId identifies the duplicate.
+```
+
+Presets are scoped to a project and contract. Migration previews return a candidate, changes and errors without mutating their inputs; review and validate the result before activation. Conversions support copy, text, number and boolean. They do not automatically redesign layouts or convert image content into video.
+
+## Troubleshooting
+
+- **New properties have TypeScript errors:** run discovery/watch, include `studio-env.d.ts` in TypeScript, and inspect compiler diagnostics. Restart the TypeScript language service if necessary.
+- **First launch has no document:** supply a reachable compatible endpoint, an explicit initial document, or a loading boundary. Discovery does not publish runtime data.
+- **An update is rejected:** compare project ID, schema version, contract ID and validation errors. Preserve compatibility for older builds.
+- **A duplicate cannot be inspected:** verify stable IDs, compiler instrumentation and application inspection bridge registration. Rendering repeats alone does not establish a device connection.
+- **Styles changed but native code did not:** Studio delivers referenced values and registered layout data. New component code requires a new build or your framework's supported code-update mechanism.
+
+## Further reading
+
+- [CLI and integration package](https://github.com/KBismark/studio/blob/main/packages/core/README.md)
+- [Application integration guide](https://github.com/KBismark/studio/blob/main/docs/GETTING_STARTED.md)
+- [State and composition conventions](https://github.com/KBismark/studio/blob/main/docs/STUDIO_STATE.md)
+
+The package documentation is included in the npm tarball. Repository links require access while the source repository is private.
+
+## License
+
+Copyright 2026 Bismark Yamoah.
+
+Licensed under the [Apache License, Version 2.0](./LICENSE). This license covers this package. Dependencies retain their respective licenses.

package/delivery-contract.d.ts

@@ -0,0 +1,21 @@
+/** Immutable editorial content. Operational/database data has its own APIs. */
+export interface ContentRevision<D = unknown> {
+  protocolVersion: 1;
+  projectId: string;
+  schemaVersion: number;
+  contractId?: string;
+  revision: string;
+  publishedAt: string;
+  document: D;
+}
+export interface ContentContract<D> {
+  projectId: string;
+  schemaVersion: number;
+  contractId?: string;
+  defaults?: D;
+  validate: (value: unknown) => string[];
+}
+export declare function validateRevision<D>(
+  value: unknown,
+  contract: ContentContract<D>,
+): ContentRevision<D>;

package/delivery-contract.js

@@ -0,0 +1,22 @@
+/** Immutable editorial content. Operational/database data has its own APIs. */
+
+export function validateRevision(value, contract) {
+  const r = value;
+  if (
+    !r ||
+    r.protocolVersion !== 1 ||
+    r.projectId !== contract.projectId ||
+    r.schemaVersion !== contract.schemaVersion ||
+    (contract.contractId !== undefined &&
+      r.contractId !== contract.contractId) ||
+    typeof r.revision !== "string" ||
+    !/^[a-zA-Z0-9-]{1,128}$/.test(r.revision) ||
+    typeof r.publishedAt !== "string" ||
+    !Number.isFinite(Date.parse(r.publishedAt))
+  )
+    throw new Error("Incompatible content revision.");
+  const errors = contract.validate(r.document);
+  if (errors.length)
+    throw new Error(`Invalid content: ${errors.slice(0, 3).join(" ")}`);
+  return r;
+}