@enbox/create-dapp 0.0.6 → 0.0.8

package/README.md

@@ -33,7 +33,7 @@ interactive terminal; scripts must provide it explicitly.
 The directory's basename becomes the display name in `src/app.json`. Its
 normalized lowercase npm name becomes both the package name and the stable
 `app.json` ID. The ID identifies
-the app to the wallet and defines its private demo protocol namespace. Keep
+the app to the wallet and defines its private demo module namespace. Keep
 the ID when changing the display name so saved data remains in the same
 namespace. Source code is copied unchanged. Run `--help` for usage or
 `--version` for the generator version.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enbox/create-dapp",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Create a minimal Enbox React application",
   "type": "module",
   "license": "Apache-2.0",

package/template/README.md

@@ -55,7 +55,7 @@ src/
     application.ts      # features, wallet identity, and one application owner
     App.tsx             # connection shell and feature composition
   features/tasks/
-    protocol.ts         # typed encrypted records and validation
+    module.ts           # typed encrypted records and validation
     store.ts            # shared observations, commands, and domain defaults
     components/         # task board and its styles
   components/           # reusable UI shared by features
@@ -64,13 +64,13 @@ src/
   sw.ts
 ```
 
-`createApplication` derives the protocol manifest from registered stores and
+`createApplication` derives the module manifest from registered stores and
 constructs the browser connection with the configured wallet identity.
 `getApplication()` keeps one headless runtime for the page lifetime.
 `main.tsx` waits for worker control before passing that runtime to
 `EnboxProvider application={...}`. The provider initializes the borrowed runtime;
 the application owns its page lifetime. Component Fast Refresh is useful for UI
-edits, but replacing a connected runtime or its store/protocol definitions is
+edits, but replacing a connected runtime or its store/module definitions is
 not a supported hot-reload operation. Disconnect before changing those files,
 then reload the page. Apps with document writers, such as Notesd, drain edits
 as part of disconnecting.
@@ -83,7 +83,7 @@ the expanded details still show which name is publicly published.
 
 The replaceable task feature lives in `src/features/tasks`:
 
-- `protocol.ts` declares encrypted `project` and `project/task` records with
+- `module.ts` declares encrypted `project` and `project/task` records with
   payload validators. Tasks store a title and completion state.
 - `store.ts` declares one shared project collection and a task collection scoped
   with `tasks.within(projectContextId)`. Its `activeTasks` observation keeps
@@ -123,13 +123,13 @@ commands remain on canonical `tasks.within(parentContextId)` handles.
 
 To replace the task feature, register your own store in `app/application.ts`,
 delete `src/features/tasks`, and change the feature rendered by `app/App.tsx`.
-Enbox requires at least one application protocol, so keep your replacement
+Enbox requires at least one application module, so keep your replacement
 registered. The profile card, connection shell, and service worker remain the
 base for your app.
 
-The demo's default protocol URI is
+The demo's default module URI is
 `https://example.com/<encoded app ID>/demo/v2`. Replace the URI expression in
-`src/features/tasks/protocol.ts` with a stable URI
+`src/features/tasks/module.ts` with a stable URI
 you control before publishing. This URI identifies saved records and wallet
 grants: changing it creates a different data namespace. Once deployed, keep
 that identifier fixed when changing the app's display name.

package/template/package.json

@@ -10,8 +10,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@enbox/browser": "0.3.86",
-    "@enbox/react": "0.0.11",
+    "@enbox/browser": "0.3.89",
+    "@enbox/react": "0.0.13",
     "react": "19.3.0",
     "react-dom": "19.3.0"
   },

package/template/src/features/tasks/module.ts

@@ -0,0 +1,29 @@
+import { defineModule, recordCodecs } from '@enbox/browser';
+
+import app from '../../app.json' with { type: 'json' };
+
+export type Project = { name: string };
+export type Task = { title: string; completed: boolean };
+
+// Replace this example URI with one you own before publishing your app.
+// Keep it stable after launch: it identifies the app's saved data and grants.
+export const TaskBoardModule = defineModule({
+  definition: {
+    module: `https://example.com/${encodeURIComponent(app.id)}/demo/v2`,
+    published: false,
+    types: {
+      project: { dataFormats: ['application/json'], encryptionRequired: true },
+      task: { dataFormats: ['application/json'], encryptionRequired: true },
+    },
+    structure: { project: { task: {} } },
+  } as const,
+  codecs: {
+    project: recordCodecs.json<Project>({ validator: (value: unknown) =>
+      value !== null && typeof value === 'object' && !Array.isArray(value) && 'name' in value
+      && typeof value.name === 'string' && value.name.trim().length > 0 && value.name.length <= 60 }),
+    task: recordCodecs.json<Task>({ validator: (value: unknown) =>
+      value !== null && typeof value === 'object' && !Array.isArray(value) && 'title' in value && 'completed' in value
+      && typeof value.title === 'string' && value.title.trim().length > 0 && value.title.length <= 120
+      && typeof value.completed === 'boolean' }),
+  },
+});

package/template/src/features/tasks/store.ts

@@ -1,15 +1,15 @@
 import { DateSort, defineStore } from '@enbox/browser';
 
-import { TaskBoardProtocol } from './protocol.js';
+import { TaskBoardModule } from './module.js';
 
-/** Protocol observations and domain defaults are shared with every consumer. */
+/** Module observations and domain defaults are shared with every consumer. */
 export const TaskBoardStore = defineStore({
-  protocols: { board: TaskBoardProtocol },
-  create({ protocols, observe }) {
-    const projects = protocols.board.collection('project', { dateSort: DateSort.CreatedDescending });
-    const tasks = protocols.board.collection('project/task');
+  modules: { board: TaskBoardModule },
+  create({ modules, observe }) {
+    const projects = modules.board.collection('project', { dateSort: DateSort.CreatedDescending });
+    const tasks = modules.board.collection('project/task');
     const activeTasks = observe({ source: (parent: string) => tasks.within(parent) });
-    const taskById = (within: string, recordId: string) => protocols.board.collection('project/task', {
+    const taskById = (within: string, recordId: string) => modules.board.collection('project/task', {
       filter: { recordId }, pagination: { limit: 1 },
     }).within(within);
 

package/template/src/features/tasks/protocol.ts

@@ -1,26 +0,0 @@
-import { defineProtocol, recordCodecs } from '@enbox/browser';
-
-import app from '../../app.json' with { type: 'json' };
-
-export type Project = { name: string };
-export type Task = { title: string; completed: boolean };
-
-// Replace this example URI with one you own before publishing your app.
-// Keep it stable after launch: it identifies the app's saved data and grants.
-export const TaskBoardProtocol = defineProtocol({
-  protocol: `https://example.com/${encodeURIComponent(app.id)}/demo/v2`,
-  published: false,
-  types: {
-    project: { dataFormats: ['application/json'], encryptionRequired: true },
-    task: { dataFormats: ['application/json'], encryptionRequired: true },
-  },
-  structure: { project: { task: {} } },
-} as const, {
-  project: recordCodecs.json<Project>({ validator: (value: unknown) =>
-    value !== null && typeof value === 'object' && !Array.isArray(value) && 'name' in value
-    && typeof value.name === 'string' && value.name.trim().length > 0 && value.name.length <= 60 }),
-  task: recordCodecs.json<Task>({ validator: (value: unknown) =>
-    value !== null && typeof value === 'object' && !Array.isArray(value) && 'title' in value && 'completed' in value
-    && typeof value.title === 'string' && value.title.trim().length > 0 && value.title.length <= 120
-    && typeof value.completed === 'boolean' }),
-});