@byamoah/studio-core 0.0.0-stage → 0.1.0-next.1

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# @byamoah/studio-core
+
+## 0.1.0-next.1
+
+### Minor Changes
+
+- 1253d94: Renew active development connections automatically and expire abandoned leases after inactivity. Add shared long-held editor updates and connector job waits to reduce repeated metadata, session and device requests. Make `studio connect` discover project configuration, check the running app, manage an HTTPS preview tunnel, open the private workspace and clean up owned processes on exit, with actionable startup errors.
+- ecdd3db: Add an optional persistence interface to the connection relay so deployment adapters can restore active sessions after a process restart. The default Node relay remains in memory. In-flight connector jobs are not persisted.
+
+### Patch Changes
+
+- @byamoah/studio-state@0.1.0-next.1
+
+## 0.1.0-beta.0
+
+Initial public prerelease.
+
+- Studio CLI for discovery, watch mode, contract checks, delivery validation and reviewed migrations.
+- Generated field contracts, collection templates and TypeScript declarations.
+- Babel and Vite instrumentation with browser and native inspection primitives.
+- Outbound hosted connections and a standalone local development agent.
+- Node server adapters for content delivery, revision storage and development relays.
+- Apache-2.0 license and package integration documentation.
+
+### Dependencies
+
+- Depends on `@byamoah/studio-state@0.1.0-beta.0`.

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,430 @@
-# Temporary Holding Version
+# @byamoah/studio-core
 
-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.
+Discovery, generated types, inspection primitives and development connections for applications using Studio.
+
+The CLI finds supported Studio state references in React and React Native source, generates a compatibility contract and TypeScript declarations, and keeps authoring metadata synchronized with the project. Runtime adapters let an application expose its rendered elements to Studio inspection. An outbound connector links a local project to a hosted Studio platform.
+
+This package is developer tooling and integration infrastructure. It is not the Studio website, a replacement application server, or a mechanism for downloading new native components.
+
+## Installation
+
+Requires Node.js **22.18 or later**. Use the React version already installed by the consuming application.
+
+```sh
+npm install @byamoah/studio-core@next @byamoah/studio-state@next
+```
+
+The initial release is a prerelease distributed under `next`. Use matching versions of both packages. Keep `studio-core` as an application dependency if application code imports its runtime modules; use a development dependency only when it is exclusively a build-time CLI.
+
+Use the installed executable through package scripts or `npx --no-install studio`. This avoids accidentally resolving an unrelated registry package named `studio`.
+
+## Quick start
+
+Run in the application root:
+
+```sh
+npx --no-install studio init
+```
+
+This creates `studio.config.mjs` and `studio-env.d.ts`. It does not create an application provider, install inspection bridges or start the Studio website. Existing configuration is not overwritten.
+
+Configure the project:
+
+```js
+// studio.config.mjs
+import { fileURLToPath } from "node:url";
+
+export default {
+  projectId: "my-app",
+  root: fileURLToPath(new URL("./", import.meta.url)),
+  routesDir: "src/app",
+  generatedDir: ".studio",
+  connection: {
+    name: "My App",
+    channel: "studio:my-app:preview",
+  },
+  state: {
+    authoring: {
+      snapshotFile: new URL(".studio/content.snapshot.json", import.meta.url),
+      draftFile: new URL(".studio/draft.json", import.meta.url),
+    },
+  },
+};
+```
+
+Use a stable project ID and the actual route directory. `src/app` above is a route-based application example. Discovery currently targets supported React/React Native source patterns; support for an arbitrary navigation framework is not implied by installation.
+
+Read editable values in a screen:
+
+```tsx
+import { Text } from "react-native";
+import { useStudioContext } from "@byamoah/studio-state/react";
+
+export default function Home() {
+  const std = useStudioContext();
+  return (
+    <Text style={{ color: std.theme.color.heading }}>
+      {std.screens.home.title}
+    </Text>
+  );
+}
+```
+
+Then generate:
+
+```sh
+npx --no-install studio discover
+```
+
+Ensure `studio-env.d.ts` is included in TypeScript. It references the generated declaration file. Newly introduced fields can be unresolved until generation runs. Do not manually declare every editable field or edit generated types.
+
+Add convenient scripts to your application:
+
+```json
+{
+  "scripts": {
+    "studio": "studio discover",
+    "studio:watch": "studio dev",
+    "studio:check": "studio check"
+  }
+}
+```
+
+Run `npm run studio:watch` while authoring. Mount a state or delivery provider above content-dependent screens; see the companion [state package README](https://github.com/KBismark/studio/blob/main/packages/state/README.md) for complete provider, loading and delivery examples.
+
+## CLI reference
+
+| Command | Behavior |
+| --- | --- |
+| `studio init` | Create initial configuration and type reference files in the current directory |
+| `studio discover` | Discover source bindings and write generated artifacts once |
+| `studio dev` | Generate and continue watching source changes |
+| `studio check` | Generate and exit unsuccessfully when contract diagnostics exist |
+| `studio validate --url URL` | Fetch and validate a delivery envelope against the generated contract |
+| `studio migrate --document FILE` | Apply a reviewed authoring document with backups and validation |
+| `studio connect --studio URL` | Connect the local project to a hosted Studio platform |
+| `studio help` | Print command usage |
+
+`check` writes generated artifacts; it is not a read-only lint command. Discovery does not run your application, launch Metro, publish content or perform TypeScript checking.
+
+### Configuration selection
+
+For discovery, watch, check, validate and migrate, selection is:
+
+1. `--project PATH` or `--config PATH`.
+2. `STUDIO_PROJECT`.
+3. `studio.config.mjs` in the current directory.
+
+A full `studio.project.mjs` can supply discovery/state configuration alongside platform-specific adapters. The CLI reads `project.discovery` when present, otherwise the top-level discovery configuration.
+
+```sh
+npx --no-install studio check --project ./studio.project.mjs
+npx --no-install studio dev --config ./studio.config.mjs
+```
+
+### Generated artifacts
+
+The configured generated directory contains artifacts including:
+
+| Artifact | Purpose |
+| --- | --- |
+| `discovery.json` | Screen, source and element metadata used by inspection/instrumentation |
+| `identity.registry.json` | Persistent source identity registry |
+| `state.contract.json` | Inferred fields, collections, compatibility ID and diagnostics |
+| `studio.generated.d.ts` | Generated declarations referenced by the app |
+| `studio.document.d.ts` | Generated document shape |
+| `content.snapshot.json` | Authoring snapshot when configured at this location |
+| `contract-history/` | Archived contracts and original authoring snapshots when contracts change |
+
+Paths can differ in a full project configuration. Keep the discovery manifest path consistent across the compiler, Babel plugin and application bridge. Do not delete authored draft files casually: they contain edits, rather than disposable compiler output. Back up project content and registry data as part of your development workflow.
+
+## What discovery understands
+
+Editable fields come from supported uses of `useStudioContext`, `useStudioListItem`, repeats and registered blocks. Discovery follows imported bindings; `std` is a readable variable convention, not a globally reserved JavaScript identifier.
+
+Use direct property references in UI expressions and supported style properties. Collection items use stable string IDs. A component alias is resolved where its implementation can be analyzed; an unknown wrapper, ambiguous source or runtime-selected key may not provide enough information for an editable binding. Inspect diagnostics rather than assuming every expression can be inferred.
+
+For a repeatable template:
+
+```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);
+  return <Text>{card.title}</Text>;
+}
+
+export default function Home() {
+  const std = Studio.useStudioContext();
+  return (
+    <View>
+      <Studio.Repeat items={std.screens.home.cards} template={Card} />
+    </View>
+  );
+}
+```
+
+The source reference declares the editable collection. Its schema and creation template are inferred from supported item usage. There is no second manually maintained list of field paths. Run discovery again when adding new fields, variants or slots. Structural updates can instantiate only components already registered and shipped in the application.
+
+## Preview and inspection integration
+
+A running app plus generated metadata does not automatically implement click-to-inspect. Integration has three distinct layers:
+
+1. **Content:** a provider exposes the current validated document. Native draft delivery uses a delivery client; an iframe bridge also needs a setter for validated preview documents.
+2. **Instrumentation:** source elements receive compiler metadata before JSX/source positions are transformed.
+3. **Runtime bridge:** application host adapters register rendered elements, handle navigation and focus, and exchange validated messages with Studio.
+
+Keep inspection and device command processing in development or explicitly opted-in preview builds. Installed production applications can still fetch published content without exposing editor controls.
+
+### Babel instrumentation
+
+Add the exported plugin to the application's existing Babel configuration. Merge it with framework-required presets and plugins:
+
+```js
+const path = require("node:path");
+const projectRoot = __dirname;
+const manifestFile = path.join(projectRoot, ".studio/discovery.json");
+const inspect = process.env.NODE_ENV === "development" ||
+  process.env.STUDIO_PREVIEW === "1";
+
+const studioPlugins = inspect
+  ? [[require.resolve("@byamoah/studio-core/babel"), {
+      projectRoot,
+      manifestFile,
+    }]]
+  : [];
+
+// Include studioPlugins in your framework's Babel plugins before source
+// coordinates are changed. Generate manifestFile before the first build.
+```
+
+This plugin attaches metadata; it does not replace the application's components with inspectable wrappers. Host adapters must consume the metadata and preserve forwarded refs, explicit props and cleanup behavior. Exclude adapter implementation files with `excludeFiles` if needed to avoid instrumenting the adapter itself.
+
+### Vite instrumentation
+
+For an application using Vite, put instrumentation before the framework's JSX transform:
+
+```ts
+import { defineConfig } from "vite";
+import react from "@vitejs/plugin-react";
+import { studioInstrumentation } from "@byamoah/studio-core/vite";
+import { fileURLToPath } from "node:url";
+
+const projectRoot = fileURLToPath(new URL("./", import.meta.url));
+
+export default defineConfig(({ mode }) => ({
+  plugins: [
+    ...(mode === "development" ? [studioInstrumentation({
+      projectRoot,
+      manifestFile: fileURLToPath(new URL(".studio/discovery.json", import.meta.url)),
+    })] : []),
+    react(),
+  ],
+}));
+```
+
+An exported preview can opt into the same instrumentation explicitly. Do not expose inspection in ordinary release builds by accident.
+
+### Runtime adapters
+
+| Export | Responsibility |
+| --- | --- |
+| `/runtime/browser` | Register DOM hosts and create a browser inspector |
+| `/runtime/native` | Register measurable native hosts/scroll containers, pick and focus elements |
+| `/runtime/refs` | Attach and clean up object/callback refs |
+| `/runtime-contract` | Metadata, selection and focus types |
+| `/device-contract` | Device command/status contracts and validation |
+
+Registration returns cleanup functions. Unregister on unmount/ref replacement. For repeats, bind metadata to the actual item instance before registering. Hidden or virtualized content needs route navigation and reveal/scroll callbacks before it can be focused.
+
+The web bridge must check the parent window, trusted Studio origin, channel, session and build identity before accepting commands or documents. The native bridge must process commands for its own device/build, acknowledge them, and report route and delivery status. Mount the native connection bridge outside the content loading boundary so an empty first launch can still connect.
+
+There is not yet a single framework-neutral installation command that generates all of this bridge code. These exports are the supported primitives for that one-time integration.
+
+### Local SDK development with Metro
+
+`/metro` exports `withLocalStudioSDK(config, { packageRoot, appRoot })` for working on a linked local copy of `studio-state` while preserving the application's React instance. `packageRoot` points to the state package directory. Registry-installed applications normally do not need this helper.
+
+`/cache-version` exports `studioCacheVersion(base, buildId)` to associate transformed modules with the discovery build. It accepts a generated 64-character hexadecimal build ID. Restart Metro after changing Babel/Metro configuration; regenerate metadata before the first instrumented run.
+
+## Connect a local project to hosted Studio
+
+Start your app's development server first. For Expo, use a separate terminal:
+
+```sh
+EXPO_PUBLIC_STUDIO_ORIGIN=https://studio.example.com npx expo start --localhost --port 8081
+```
+
+The environment variable configures the application's trusted web bridge origin. Restart Expo after changing it. Providers and inspection bridges still need the one-time integration described above.
+
+Once the app server is running and `STUDIO_CONNECT_TOKEN` is configured, connecting is one command:
+
+```sh
+npx studio connect --studio https://studio.example.com
+```
+
+The CLI finds the nearest `studio.config.mjs` or `studio.project.mjs`, including a parent configuration in a monorepo. Its watcher updates the normal `.studio/discovery.json` manifest (or your explicit native manifest path) alongside the hosted metadata; do not run a second `studio dev` watcher for the same project. It generates metadata, checks the app server, starts an HTTPS development tunnel, establishes the hosted connection and opens your private workspace in the browser. No local Studio website is required. It never launches a simulator unless `--simulator` is explicitly supplied.
+
+The managed tunnel uses Cloudflare's official `cloudflared` tool. A compatible installed binary is reused; otherwise a pinned binary is downloaded once, verified against the official release checksum, and cached outside the project. There is no package-install hook that downloads it. No separate Cloudflare account is required for this temporary tunnel. The tool exposes the running app development server until you stop the command. Use an existing transport with `--preview-url` if you prefer another tunnel provider.
+
+The managed startup flow requires the updated CLI. The initial `0.1.0-beta.0` CLI requires explicit transport URLs; use the updated release or a packed development version for the behavior described here.
+
+### Credentials and app URL
+
+Your Studio host supplies a provisioning token. Set `STUDIO_CONNECT_TOKEN` in the shell, or put it in a private `.env.studio.local` file in the directory where you run the command:
+
+```dotenv
+STUDIO_CONNECT_TOKEN=your-private-host-provisioning-token
+```
+
+Ignore that file in Git. The token is not a public application environment variable. Account-based login is not implemented by this command.
+
+Expo projects default to `http://127.0.0.1:8081/`. For another framework or port, configure the application server once:
+
+```js
+connection: {
+  name: "My App",
+  developmentUrl: "http://localhost:3000/",
+}
+```
+
+The full adapter's `preview.developmentUrl` also works. `--app-url` overrides either setting. The command does not start or stop an app server that you own. Missing configuration, an unreachable app, a failed tunnel and a failed host connection produce terminal errors with a next action. A failed startup cleans up the tunnel and agent. Ctrl+C closes the session, stops the owned tunnel and stops discovery; your app server keeps running.
+
+### Options
+
+| Option/configuration | Purpose |
+| --- | --- |
+| `--project PATH` / `STUDIO_PROJECT` | Override automatic project config lookup |
+| `--app-url URL` | Loopback app server to check and tunnel |
+| `--preview-url URL` | Use and check an existing public HTTPS web preview instead of creating a tunnel |
+| `--native-url URL` | Override the native app launch URL; Expo projects with a managed tunnel get an `exps:` link |
+| `--native-only` | Intentionally skip web-server/tunnel setup and use connected-device mode |
+| `--no-open` | Print the private workspace link without opening a browser |
+| `--local URL` / `STUDIO_LOCAL_ORIGIN` | Reuse an existing local Studio server; supply `--app-url` for its preview or `--preview-url` |
+| `STUDIO_CONNECT_TOKEN` / `--token` | Provisioning credential; prefer the environment variable or private env file |
+| `STUDIO_CLOUDFLARED_BIN` | Use an explicit compatible tunnel binary |
+| `STUDIO_CACHE_DIR` | Override the tool download cache directory |
+| `--simulator` | Explicitly open a connection in an already booted Apple simulator |
+| `STUDIO_SIMULATOR_UDID` | Simulator identifier, defaulting to `booted` |
+| `--allow-http` | Permit an HTTP loopback host/preview for local testing |
+
+For a simulator-only workflow, add `--native-only --simulator` to the connection command. On the same laptop, its launch and content URLs remain loopback addresses. Other-network phones need a working public Expo/native transport and correct app bridge integration; a remote device cannot use laptop-local URLs. An externally supplied `--native-url` remains useful for custom development clients or an independently managed transport.
+
+### Renewal and traffic
+
+The session is a rolling lease, not a fixed development time limit. Authenticated connector activity extends it automatically. A browser tab alone cannot renew it. After an ungraceful disconnect, the session expires after the configured inactivity period, one hour by default. Ctrl+C explicitly revokes it immediately. Restarting a Node host without persistence ends sessions; a host with a session-storage adapter can restore them. Cloudflare's deployment adapter persists lease checkpoints.
+
+Hosted Studio shares a single long-held `/updates` request across metadata, draft and device consumers. The server sends only changed sections (document, metadata or devices), and returns an empty response after up to 20 seconds of inactivity. The connector similarly waits up to ten seconds for jobs instead of requesting empty queues several times per second. Background browser tabs pause their update subscription; interrupted connections retry with backoff. Native telemetry can still cause legitimate updates when devices are active.
+
+Older connectors/hosts keep compatible polling behavior. Upgrade the CLI and platform together to get the shared stream and automatic renewal. Private pairing links grant development access; share them only with intended participants. The connector is not an installed application's permanent production content endpoint. Restart it after changing configuration modules loaded at startup.
+
+## Validate and migrate content
+
+Validate the same envelope used by development and production clients:
+
+```sh
+npx --no-install studio check
+npx --no-install studio validate \
+  --url https://content.example.com/studio/content
+```
+
+Validation adds the generated project and contract identifiers to the request, checks the envelope and document, and runs an application validator when provided by the full project adapter. Use `--allow-http` only for development. Keep older compatible publications available to applications with earlier contracts.
+
+When source changes alter the contract, review a migration before applying it:
+
+```sh
+npx --no-install studio migrate --document ./reviewed-document.json
+```
+
+The file is a complete candidate document, not a mapping specification. The command requires the configured authoring draft path, validates against the target generated contract, backs up existing authoring data, writes the candidate and regenerates. A failure restores the prior authoring files. Applying a migration does not publish it.
+
+## Server integration exports
+
+These Node.js adapters support custom platform and delivery hosts:
+
+| Export | API |
+| --- | --- |
+| `/project` | `defineProject` and the browser project adapter contract |
+| `/publishing` | `createRevisionStore` for filesystem revision persistence |
+| `/delivery-handler` | `deliveryHandler` for compatible reads and authenticated publication |
+| `/server` | `serveStudio` for an already built Studio website |
+| `/connector` | `startConnector` for an outbound connection |
+| `/connector-agent` | `createConnectorAgent` for the standalone project agent |
+| `/connection-relay` | `createConnectionRelay` for hosted development sessions |
+
+For example, mount a filesystem-backed content endpoint in a Node server:
+
+```js
+import { createServer } from "node:http";
+import { readFile } from "node:fs/promises";
+import { validateStudioState } from "@byamoah/studio-state";
+import { createRevisionStore } from "@byamoah/studio-core/publishing";
+import { deliveryHandler } from "@byamoah/studio-core/delivery-handler";
+
+const generated = JSON.parse(await readFile(".studio/state.contract.json", "utf8"));
+const token = process.env.STUDIO_PUBLISH_TOKEN;
+if (!token) throw new Error("Set STUDIO_PUBLISH_TOKEN on the server.");
+
+const contract = {
+  projectId: "my-app",
+  schemaVersion: 1,
+  contractId: generated.contractId,
+  validate: (value) => validateStudioState(value, generated),
+};
+const store = createRevisionStore("./content-data", contract);
+const handle = deliveryHandler({ store, contract, token, origins: [] });
+
+createServer((req, res) => {
+  void handle(req, res).catch(() => {
+    if (!res.headersSent) res.writeHead(500);
+    res.end();
+  });
+}).listen(4173, "127.0.0.1");
+```
+
+The read endpoint is `/v1/projects/my-app/schemas/1/published.json`; clients send their contract identifier. Supply exact browser origins in `origins` when web clients need CORS. Place a production server behind HTTPS, use durable storage, and keep publisher credentials server-side. The filesystem store is intended for a single persistent server; distributed hosting needs storage and concurrency integration appropriate to that environment. These Node adapters are not automatically Cloudflare Worker-compatible merely because the website can be hosted there.
+
+The package contains runtime modules and declarations, but not a prebuilt Studio website. Running `/server` requires a separate platform build and project configuration. Hosted connection provisioning and project publication use separate credentials.
+
+### Optional relay session storage
+
+`createConnectionRelay({ token, sessionStorage })` accepts an optional asynchronous storage adapter:
+
+```js
+const sessionStorage = {
+  async load() { /* return an array of previously saved session records */ return []; },
+  async save(record) { /* durably replace the record identified by record.id */ },
+  async delete(id) { /* durably delete this session */ },
+};
+```
+
+An optional `renew(id, { expires, seen })` method can persist a small lease checkpoint without rewriting a large descriptor. Without it, the relay falls back to `save`. Device-only updates stay transient; restoration clears stale device telemetry and issues a fresh update cursor.
+
+Omitting the adapter preserves in-memory Node behavior. The relay saves resumable session records when creating connections and updating snapshots; it deletes them on revocation and expiration. Restored records rebuild empty job queues. Storage errors reject the operation. In-flight requests and queued responses are not durable and may fail across restarts.
+
+Session records include private capability credentials. Keep storage server-side, preserve records without altering them, and restrict access. The adapter owns its storage format, transactions and retention cleanup. No hosting-provider SDK is required by this interface.
+
+## Troubleshooting
+
+- **`studio` is missing:** install the package in the project and run its local executable. Check the Node version.
+- **New state properties are missing:** run `studio discover`, include the type-reference file, then review diagnostics.
+- **Inspection is empty:** verify the manifest matches transformed source and that host adapters/bridges are mounted. Metadata generation alone does not register rendered views.
+- **Source edits do not change an embedded preview:** a static export must be rebuilt. A live preview must point to the running app development server, not an old export.
+- **Connection works locally but not on a phone:** check bind address, LAN reachability or tunnel URLs. A localhost link is usable only by that machine.
+- **A published revision is rejected:** validate against the exact installed build's contract rather than the newest contract alone.
+
+## Further reading
+
+- [State runtime package](https://github.com/KBismark/studio/blob/main/packages/state/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)
+
+This README ships in the npm package. Repository links require access while the source repository remains 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.