@enbox/create-dapp 0.0.0-stage → 0.0.1

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 2025 Liran Cohen
+
+   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,41 @@
-# Temporary Holding Version
+# @enbox/create-dapp
 
-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.
+Create a minimal Enbox React app with a wallet connection, a profile card,
+and a removable private-data demo.
+
+Requires Node.js 22.12.0 or newer. Create an app with either command:
+
+```sh
+npm create @enbox/dapp@latest my-app
+# or
+npx @enbox/create-dapp@latest my-app
+```
+
+Then run:
+
+```sh
+cd my-app
+npm ci
+npm run dev
+```
+
+The generator copies its bundled template into a new or empty directory. It
+does not install packages, run Git, or make network requests. It refuses
+nonempty destinations and symbolic-link targets; there is no force option.
+Use `.` for an empty current directory. Omitting the directory prompts in an
+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, and the bundled lockfile is updated to match. The ID identifies
+the app to the wallet and defines its private demo protocol 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.
+
+From this repository, run the CLI and its tests without publishing:
+
+```sh
+node packages/create-dapp/bin/create-dapp.mjs /tmp/my-enbox-app
+node --test packages/create-dapp/tests/*.test.mjs
+```

package/bin/create-dapp.mjs

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+
+import fs from 'node:fs';
+import { basename, dirname, join, resolve } from 'node:path';
+import { createInterface } from 'node:readline/promises';
+import { fileURLToPath } from 'node:url';
+import { parseArgs } from 'node:util';
+
+const packageRoot = fileURLToPath(new URL('../', import.meta.url));
+const manifest = JSON.parse(fs.readFileSync(join(packageRoot, 'package.json'), 'utf8'));
+const excluded = new Set([
+  'node_modules', 'dist', 'build', '.git', '.artifacts', '.vite', '.cache',
+  'coverage', 'test-results', 'playwright-report', '.DS_Store',
+]);
+
+const usage = `Create a minimal Enbox React application.
+
+Usage:
+  npm create @enbox/dapp@latest [directory]
+  npx @enbox/create-dapp@latest [directory]
+
+Options:
+  -h, --help     Show this help
+  -v, --version  Show the generator version
+
+The destination must be empty. No dependencies are installed and no Git
+repository is created. Use "." to create an app in the current empty directory.
+`;
+
+function assertEmptyDestination(destination) {
+  const stat = fs.lstatSync(destination, { throwIfNoEntry: false });
+  if (stat === undefined) return;
+  if (stat.isSymbolicLink()) throw new Error('The destination must not be a symbolic link.');
+  if (!stat.isDirectory()) throw new Error('The destination must be a directory.');
+  if (fs.readdirSync(destination).length !== 0) throw new Error('The destination directory is not empty.');
+}
+
+function readTemplate(directory, prefix = '', files = new Map()) {
+  for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
+    if (excluded.has(entry.name) || entry.name.endsWith('.tsbuildinfo')) continue;
+    const source = join(directory, entry.name);
+    const name = prefix === '' && entry.name === '_gitignore' ? '.gitignore' : entry.name;
+    const relative = join(prefix, name);
+    if (entry.isDirectory()) readTemplate(source, relative, files);
+    else if (entry.isFile()) {
+      if (files.has(relative)) throw new Error(`Duplicate template file: ${relative}`);
+      files.set(relative, fs.readFileSync(source));
+    } else throw new Error(`Unsupported template entry: ${relative}`);
+  }
+  return files;
+}
+
+function customizeJson(files, path, update) {
+  try {
+    const contents = files.get(path);
+    if (contents === undefined) throw new Error('file is missing');
+    const value = JSON.parse(contents.toString('utf8'));
+    if (value === null || typeof value !== 'object' || Array.isArray(value)) throw new Error('expected a JSON object');
+    update(value);
+    files.set(path, Buffer.from(`${JSON.stringify(value, null, 2)}\n`));
+  } catch (cause) {
+    throw new Error(`Invalid starter template ${path}: ${cause.message}`, { cause });
+  }
+}
+
+function packageName(name) {
+  return name.normalize('NFKD').toLowerCase().replace(/[\u0300-\u036f]/g, '')
+    .replace(/[^a-z0-9-]+/g, '-').replace(/^-+|-+$/g, '').slice(0, 214).replace(/-+$/g, '') || 'enbox-dapp';
+}
+
+function createProject(destination) {
+  assertEmptyDestination(destination);
+  const files = readTemplate(join(packageRoot, 'template'));
+  const displayName = basename(destination);
+  const name = packageName(displayName);
+  customizeJson(files, 'package.json', (value) => { value.name = name; });
+  customizeJson(files, join('src', 'app.json'), (value) => {
+    value.id = name;
+    value.name = displayName;
+  });
+  customizeJson(files, 'package-lock.json', (value) => {
+    if (value.packages?.[''] === undefined) throw new Error('root package metadata is missing');
+    value.name = name;
+    value.packages[''].name = name;
+  });
+
+  const createdFiles = [];
+  const createdDirectories = [];
+  const ensureDirectory = (directory) => {
+    try {
+      fs.mkdirSync(directory);
+      createdDirectories.push(directory);
+    } catch (cause) {
+      if (cause.code === 'ENOENT') {
+        ensureDirectory(dirname(directory));
+        ensureDirectory(directory);
+      } else if (cause.code !== 'EEXIST' || !fs.lstatSync(directory).isDirectory()) throw cause;
+    }
+  };
+  try {
+    ensureDirectory(destination);
+    assertEmptyDestination(destination);
+    for (const [relative, contents] of files) {
+      const target = join(destination, relative);
+      ensureDirectory(dirname(target));
+      const descriptor = fs.openSync(target, 'wx');
+      createdFiles.push(target);
+      try { fs.writeFileSync(descriptor, contents); }
+      finally { fs.closeSync(descriptor); }
+    }
+  } catch (cause) {
+    // Remove only entries created by this invocation; keep preexisting directories.
+    for (const file of createdFiles.reverse()) {
+      try { fs.unlinkSync(file); } catch {}
+    }
+    for (const directory of createdDirectories.reverse()) {
+      try { fs.rmdirSync(directory); } catch {}
+    }
+    throw new Error(`Could not create the app: ${cause.message}`, { cause });
+  }
+}
+
+function quoteDirectory(directory) {
+  return process.platform === 'win32'
+    ? `'${directory.replaceAll("'", "''")}'`
+    : `'${directory.replaceAll("'", "'\\''")}'`;
+}
+
+async function main() {
+  const { values, positionals } = parseArgs({
+    options: { help: { type: 'boolean', short: 'h' }, version: { type: 'boolean', short: 'v' } },
+    allowPositionals: true,
+  });
+  if (values.help) { console.log(usage); return; }
+  if (values.version) { console.log(manifest.version); return; }
+  if (positionals.length > 1) throw new Error('Provide one target directory. Run with --help for usage.');
+  let directory = positionals[0];
+  if (directory === undefined) {
+    if (!process.stdin.isTTY || !process.stdout.isTTY) {
+      throw new Error('Provide a target directory. Run with --help for usage.');
+    }
+    const prompt = createInterface({ input: process.stdin, output: process.stdout });
+    try { directory = await prompt.question('Project directory: '); }
+    finally { prompt.close(); }
+  }
+  if (directory.trim() === '' || /[\u0000-\u001f\u007f]/.test(directory)) {
+    throw new Error('Provide a nonempty target directory without control characters.');
+  }
+  const destination = resolve(directory);
+  createProject(destination);
+  const changeDirectory = process.platform === 'win32' ? 'Set-Location -LiteralPath' : 'cd';
+  console.log(`Created ${basename(destination)}.\n\n${process.platform === 'win32' ? 'In PowerShell' : 'Next'}:\n  ${changeDirectory} ${quoteDirectory(destination)}\n  npm ci\n  npm run dev`);
+}
+
+main().catch((cause) => {
+  console.error(`create-dapp: ${cause.message}`);
+  process.exitCode = 1;
+});

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@enbox/create-dapp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Create a minimal Enbox React application",
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/enboxorg/enbox-react.git",
+    "directory": "packages/create-dapp"
+  },
+  "bin": {
+    "create-dapp": "bin/create-dapp.mjs"
+  },
+  "files": [
+    "bin",
+    "template/src",
+    "template/index.html",
+    "template/package.json",
+    "template/package-lock.json",
+    "template/tsconfig.json",
+    "template/vite.config.ts",
+    "template/README.md",
+    "template/_gitignore",
+    "template/.npmrc",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "test": "node --test tests/*.test.mjs"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  }
+}

package/template/README.md

@@ -0,0 +1,70 @@
+# Hello, Enbox
+
+A small React app with a wallet connection, a read-only public profile, and one
+private choice saved through Enbox. No application server is required.
+
+## Run it
+
+Use Node 22.12 or newer:
+
+```sh
+npm ci
+npm run dev
+```
+
+Open the local URL and choose **Connect wallet**. Enbox handles wallet selection
+and approval. Once connected, choose an emoji. The displayed choice comes from
+the live record view and is restored when this profile returns.
+
+```sh
+npm run typecheck
+npm run build
+npm run preview
+```
+
+The app owns its service worker. Startup waits until that worker controls the
+page before initializing Enbox. Vite bundles the worker without a separate PWA
+toolchain. Production builds precache the app shell for
+later offline visits; `npm run preview` serves that built app locally. Deploy
+the generated `dist` directory on an HTTPS origin with service worker support.
+
+Direct dependencies use exact versions; `npm ci` installs the committed
+dependency tree. Update the manifest and lockfile together when accepting
+dependency or security fixes.
+
+## Make it yours
+
+`src/app.json` contains the display name used in the page, browser title, and
+wallet approval screen, plus a stable app ID. Changing the display name leaves
+the app ID and demo data namespace intact. `src/application.ts` defines the application manifest
+and wallet configuration. `src/main.tsx` mounts the SDK provider; `src/App.tsx`
+contains the app shell without owning authentication state.
+
+The profile card reads published profile information through `useProfile`.
+Names, images, settlement state, and image URL lifetimes belong to the SDK.
+Missing profiles and unavailable images have local display fallbacks.
+The wallet's profile label is used when a public display name is unavailable;
+the expanded details still show which name is publicly published.
+
+The removable demo lives entirely in `src/demo`:
+
+- `protocol.ts` declares an encrypted singleton record and validates its emoji.
+- `Demo.tsx` reads through `useRecords` and writes absolute choices through
+  `useEnboxMutation` and the typed `records.set` API.
+- `demo.css` styles the demo. Shared app and profile styles live in `src/style.css`.
+
+To replace the demo, register your own typed application protocol in
+`application.ts` in place of `DemoProtocol`. Then delete `src/demo` and remove
+the `Demo` import and component from `App.tsx`. Enbox requires at least one
+application protocol, 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
+`https://example.com/<encoded app ID>/demo/v1`. Replace the URI expression in
+`src/demo/protocol.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.
+
+Public profile information and the encrypted demo choice are separate. Choosing
+an emoji updates this app's private record; it does not edit the public profile.

package/template/_gitignore

@@ -0,0 +1,7 @@
+node_modules/
+dist/
+*.local
+*.tsbuildinfo
+.env
+.env.*
+!.env.example

package/template/index.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="theme-color" content="#f6f8fb" />
+    <meta name="description" content="Your identity, your data, your first Enbox dapp." />
+    <title>Hello, Enbox</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>