@glassly/create-miniapp 0.1.0-dev.2 → 0.1.0-dev.3

package/README.md

@@ -1,7 +1,7 @@
 # @glassly/create-miniapp
 
 Scaffold a new [Glassly](https://github.com/tetramo-labs/glassly)
-miniapp project — the `bun create` starter for apps that run on Glassly
+miniapp project. This is the `bun create` starter for apps that run on Glassly
 smart glasses.
 
 ## Usage
@@ -13,8 +13,41 @@ bun install
 bun run dev
 ```
 
-> **Bun-only.** The scaffolder and the generated project's tooling run under
-> [Bun](https://bun.sh) — use `bun` / `bunx`, not `npx`.
+> The scaffolder and the generated project's tooling run under
+> [Bun](https://bun.sh) only. Use `bun` and `bunx`, not `npx`.
+
+### `--prefix`
+
+Every miniapp lives under its developer org's reverse-DNS package prefix (set
+when you create the org in the Developer Console, for example `com.example`).
+The scaffolder asks for it and writes `<prefix>.<project_name>` into
+`miniapp.json` as the `packageName`, with dashes in the project name turned into
+underscores so the name is valid. The Store rejects releases outside your org's
+prefix, so use the real one. Pass `--prefix` to skip the prompt:
+
+```sh
+bunx @glassly/create-miniapp my-app --prefix=com.example
+```
+
+### `--type`
+
+The scaffolder asks what kind of glasses the miniapp targets, which decides the
+`hardwareRequirements` it writes into `miniapp.json`. Pass `--type` to skip the
+prompt:
+
+| Value | Glasses | `hardwareRequirements` |
+| --- | --- | --- |
+| `display` | Even Realities G1/G2, Vuzix Z100 | `DISPLAY` + `MICROPHONE`, both `REQUIRED` |
+| `camera` | Mentra Live | `CAMERA` + `MICROPHONE`, both `REQUIRED` |
+
+```sh
+bunx @glassly/create-miniapp my-app --type=display
+```
+
+Use the `--flag=value` form for both flags; a space-separated `--type value` is
+not parsed.
+Requirements are only a starting point — edit `miniapp.json` directly, or with
+`glassly-miniapp hardware add`, as the miniapp grows.
 
 The generated project comes wired with
 [`@glassly/miniapp`](https://www.npmjs.com/package/@glassly/miniapp) (the SDK
@@ -25,8 +58,8 @@ SDK versions this scaffolder shipped with, so a generated project installs
 on any release channel.
 
 To publish a finished miniapp to the Glassly Miniapp Store, see
-[`@glassly/cli`](https://www.npmjs.com/package/@glassly/cli) (`glassly login` /
-`glassly publish`).
+[`@glassly/cli`](https://www.npmjs.com/package/@glassly/cli), specifically `glassly login` and
+`glassly publish`.
 
 ## Part of Glassly
 

package/bin/index.ts

@@ -9,8 +9,15 @@ type GlassesType = "display" | "camera"
 interface CliFlags {
   projectName?: string
   type?: GlassesType
+  prefix?: string
 }
 
+// Package names are reverse-DNS: letters, digits, underscores, each segment
+// starting with a letter. The Store rejects anything else, and every miniapp
+// must sit under the developer org's package prefix.
+const PACKAGE_SEGMENT = /^[a-z][a-z0-9_]*$/
+const PACKAGE_PREFIX = /^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)+$/
+
 function parseArgs(argv: string[]): CliFlags {
   const flags: CliFlags = {}
   for (const arg of argv) {
@@ -22,6 +29,8 @@ function parseArgs(argv: string[]): CliFlags {
         console.error(`Invalid --type value: "${value}". Expected "display" or "camera".`)
         process.exit(1)
       }
+    } else if (arg.startsWith("--prefix=")) {
+      flags.prefix = arg.slice("--prefix=".length)
     } else if (!arg.startsWith("-") && !flags.projectName) {
       flags.projectName = arg
     }
@@ -36,17 +45,32 @@ function toKebabCase(str: string): string {
     .toLowerCase()
 }
 
+function toPackageSegment(str: string): string {
+  return toKebabCase(str).replace(/-+/g, "_")
+}
+
 function validateProjectName(name: string): string | undefined {
   if (!name.trim()) return "Project name is required"
   if (!/^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.test(name)) {
     return "Use letters, numbers, dashes, underscores, or spaces (cannot start with a symbol)"
   }
+  if (!PACKAGE_SEGMENT.test(toPackageSegment(name))) {
+    return "Project name must start with a letter"
+  }
   if (fs.existsSync(path.resolve(process.cwd(), name))) {
     return `Directory "${name}" already exists`
   }
   return undefined
 }
 
+function validatePrefix(prefix: string): string | undefined {
+  if (!prefix.trim()) return "Package prefix is required"
+  if (!PACKAGE_PREFIX.test(prefix)) {
+    return "Use reverse-DNS form like com.example: lowercase letters, digits, underscores, at least two segments"
+  }
+  return undefined
+}
+
 function bailIfCancelled<T>(value: T | symbol): T {
   if (isCancel(value)) {
     cancel("Cancelled.")
@@ -76,6 +100,23 @@ if (projectName) {
   )
 }
 
+let prefix = flags.prefix
+if (prefix) {
+  const err = validatePrefix(prefix)
+  if (err) {
+    cancel(err)
+    process.exit(1)
+  }
+} else {
+  prefix = bailIfCancelled(
+    await text({
+      message: "Package prefix? (your developer org's prefix from the Developer Console)",
+      placeholder: "com.example",
+      validate: validatePrefix,
+    }),
+  )
+}
+
 let glassesType = flags.type
 if (!glassesType) {
   glassesType = bailIfCancelled(
@@ -100,8 +141,7 @@ if (!glassesType) {
 const targetDir = path.resolve(process.cwd(), projectName)
 const templateDir = path.resolve(import.meta.dirname, "..", "template")
 
-const kebabName = toKebabCase(projectName)
-const packageName = `com.glassly.${kebabName}`
+const packageName = `${prefix}.${toPackageSegment(projectName)}`
 const hardwareRequirements =
   glassesType === "camera"
     ? [
@@ -147,4 +187,4 @@ copyDir(templateDir, targetDir)
 
 note(`cd ${projectName}\nbun install\nbun dev`, "Next steps")
 
-outro(`Created miniapp in ./${projectName}`)
+outro(`Created ${packageName} in ./${projectName}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glassly/create-miniapp",
-  "version": "0.1.0-dev.2",
+  "version": "0.1.0-dev.3",
   "description": "Scaffold a new Glassly miniapp project",
   "type": "module",
   "publishConfig": {

package/template/README.md

@@ -26,11 +26,17 @@ The layers do not share memory. Exchange serializable data through the typed
 ## Commands
 
 ```bash
-bun run dev      # live, temporary; keep the computer and CLI running
-bun run release  # persistent local install that runs without the computer
-bun run build    # build both layers into dist/
+bun run dev        # live, temporary; keep the computer and CLI running
+bun run release    # persistent local install that runs without the computer
+bun run build      # build both layers into dist/
+bun run pack       # production-build, validate the manifest, zip to build/<pkg>-<version>.zip
+bun run typecheck  # tsc --noEmit, no bundle emitted
 ```
 
+`pack` is the distributable artifact on its own: `release` builds and packs for
+you, so reach for `pack` when you want the zip without serving it. `typecheck`
+is types only — the unsupported-API checks live in `build`.
+
 The Glassly App keeps one dev entry per manifest package name, so you can scan and
 test multiple dev miniapps side by side. It also caches each entry's name and
 icon. Rescanning the same package updates that entry. Use `bun run release` when

package/template/miniapp.json

@@ -6,8 +6,8 @@
   "description": "A Glassly miniapp",
   "icon": "icon.png",
   "type": "standard",
-  "sdkVersion": "0.3.0",
-  "minHostVersion": "1.42.0",
+  "sdkVersion": "0.3.1",
+  "minHostVersion": "0.3.1",
   "entry": {
     "background": "background/index.js",
     "ui": "ui/index.html"

package/template/package.json

@@ -9,7 +9,7 @@
     "pack": "glassly-miniapp pack"
   },
   "dependencies": {
-    "@glassly/miniapp": "0.1.0-dev.62",
+    "@glassly/miniapp": "0.3.1-dev.509",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },

package/template/src/background/index.ts

@@ -31,7 +31,7 @@ registerMiniapp<Channels>(async (session) => {
         type: "text",
         id: "hello",
         box: {x: 0, y: 0, w: d?.width ?? 576, h: d?.height ?? 288},
-        text: "Hello from GlasslyJS",
+        text: "Hello from JSRuntime",
       },
     ])
   })