@velven/cli 0.5.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.6.0
+
+- `--type` and velven.json's `type` and `how_made` are gone: Velven no longer asks what kind of project it is, and the
+  page no longer shows a prompt. This version refuses them with a sentence; remove them from velven.json. A new space
+  needs only `title` and `devices`. Velven ignores both keys from older versions.
+
 ## 0.5.1
 
 - `velven create credits` names the free allowance as this week's: Velven's builder now refills it weekly, from Monday

package/README.md

@@ -20,19 +20,18 @@ and neither is a `velven.json` in any folder below, whatever its letter case.
 ```json
 {
   "title": "Star Hop",
-  "type": "game",
   "devices": ["desktop", "mobile"],
   "description": "Hop between stars before the light runs out.",
   "engine": "three.js"
 }
 ```
 
-Three fields are required: `title`, `type` (`game`, `world`, `tool` or `wonder`) and `devices` (`desktop`, `mobile`,
-`vr`). If one is missing and you're in a terminal, `velven publish` asks for it and saves your answer in `velven.json`.
-Anywhere else, it stops and lists each missing field.
+Two fields are required: `title` and `devices` (`desktop`, `mobile`, `vr`). If one is missing and you're in a
+terminal, `velven publish` asks for it and saves your answer in `velven.json`. Anywhere else, it stops and lists each
+missing field. Since 0.6.0, a `velven.json` that still has `type` or `how_made` is refused with exit 2
+(`invalid_config`): Velven no longer uses them, so remove them and publish again.
 
-The optional fields are `description`, `engine`, `ai_tools`, `models`, `how_made` and `source_url`, plus these for
-hosting:
+The optional fields are `description`, `engine`, `ai_tools`, `models` and `source_url`, plus these for hosting:
 
 | Key | What it does |
 | --- | --- |
@@ -139,8 +138,8 @@ with exit 6 if it has one of these in it.
   live. A refused version prints the reason. A version Velven couldn't judge prints what Velven saw, and a start hint
   usually fixes it. Either way, you can ask for a review from the printed link. The exception is a program or a miner,
   which is never served: remove the file and publish again.
-- `--title`, `--type`, `--devices desktop,mobile`, `--description` and `--engine` override `velven.json` for this run
-  only.
+- `--title`, `--devices desktop,mobile`, `--description` and `--engine` override `velven.json` for this run only.
+  `--type` is refused with exit 2: Velven no longer asks what kind of project it is.
 - `--yes` never asks for missing fields. It fails and lists them instead.
 - `--json` prints one JSON object, for scripts and agents. It also works on `whoami` and `versions`.
 

package/dist/velven.js

@@ -23,7 +23,7 @@ class CliError extends Error {
   }
 }
 // package.json
-var version = "0.5.1";
+var version = "0.6.0";
 
 // src/version.ts
 var VERSION = version;
@@ -3155,7 +3155,6 @@ function mediaProblem(kind, path, size2, bytes, missing = "is not among the file
 // src/project.ts
 import { readdir, readFile as readFile4, writeFile as writeFile3 } from "node:fs/promises";
 import { join as join3, win32 } from "node:path";
-var SPACE_TYPES = ["game", "world", "tool", "wonder"];
 var DEVICES = ["desktop", "mobile", "vr"];
 var PROJECT_FILE = "velven.json";
 var isProjectName = (name) => name.toLowerCase() === PROJECT_FILE;
@@ -3188,6 +3187,15 @@ async function readProject(dir) {
   }
   return { path, exists: true, data };
 }
+var RETIRED_KEYS = ["type", "how_made"];
+function refuseRetiredKeys(data) {
+  const found = RETIRED_KEYS.filter((key) => data[key] !== undefined);
+  if (!found.length)
+    return;
+  const named = found.map((key) => `"${key}"`).join(" and ");
+  const sentence = found.length === 1 ? "Remove it and publish again." : "Remove them and publish again.";
+  throw new CliError(`${PROJECT_FILE} has ${named}, which Velven no longer uses. ${sentence}`, EXIT.usage, "invalid_config");
+}
 async function updateProject(project, values) {
   for (const [key, value] of Object.entries(values)) {
     if (value === undefined)
@@ -3206,8 +3214,6 @@ function withFlags(data, flags) {
   const out = { ...data };
   if (flags.title !== undefined)
     out.title = flags.title;
-  if (flags.type !== undefined)
-    out.type = flags.type.trim().toLowerCase();
   if (flags.devices !== undefined)
     out.devices = list2(flags.devices);
   if (flags.description !== undefined)
@@ -3216,7 +3222,7 @@ function withFlags(data, flags) {
     out.engine = flags.engine;
   return out;
 }
-var REQUIRED = ["title", "type", "devices"];
+var REQUIRED = ["title", "devices"];
 function requiredProblem(field, value) {
   if (value === undefined || value === null || value === "" || Array.isArray(value) && value.length === 0)
     return "missing";
@@ -3227,9 +3233,6 @@ function requiredProblem(field, value) {
       return "must be under 80 characters";
     return null;
   }
-  if (field === "type") {
-    return typeof value === "string" && SPACE_TYPES.includes(value) ? null : `must be one of ${SPACE_TYPES.join(", ")}`;
-  }
   if (!Array.isArray(value) || !value.every((d) => typeof d === "string" && DEVICES.includes(d))) {
     return `must be a list from ${DEVICES.join(", ")}, like ["desktop", "mobile"]`;
   }
@@ -3262,7 +3265,6 @@ var OPTIONAL = {
   engine: [isString, 'must be text, like "three.js"'],
   ai_tools: [isStringList, "must be a list of text"],
   models: [isStringList, "must be a list of text"],
-  how_made: [(v) => isString(v) && v.length <= 2000, "must be text, under 2000 characters"],
   source_url: [isString, "must be a web address"],
   entry: [isInsidePath, 'must be a path inside the folder, like "index.html"'],
   thumbnail: [isInsidePath, 'must be a path inside the folder, like "media/thumbnail.jpg"'],
@@ -3293,14 +3295,11 @@ function requiredProblems(data) {
 }
 var QUESTIONS = {
   title: "Title, the name people see on Velven: ",
-  type: `Type (${SPACE_TYPES.join(", ")}): `,
   devices: `Devices it works on, comma separated (${DEVICES.join(", ")}): `
 };
 function parseAnswer(field, answer) {
   if (field === "title")
     return answer.trim();
-  if (field === "type")
-    return answer.trim().toLowerCase();
   return list2(answer);
 }
 async function completeRequired(ctx, project, merged, canAsk) {
@@ -3865,8 +3864,8 @@ var DONE = ["live", "refused", "unjudged", "replaced", "preview"];
 var POLL_MS = 3000;
 var WAIT_LIMIT_MS = 20 * 60 * 1000;
 function listingFields(config) {
-  const fields = { title: config.title, space_type: config.type, devices: config.devices };
-  for (const key of ["description", "engine", "ai_tools", "models", "how_made", "source_url"]) {
+  const fields = { title: config.title, devices: config.devices };
+  for (const key of ["description", "engine", "ai_tools", "models", "source_url"]) {
     if (config[key] !== undefined)
       fields[key] = config[key];
   }
@@ -3925,6 +3924,7 @@ async function publish(ctx, options) {
   const creds = await findToken(ctx, base);
   const guest = !creds;
   const project = await readProject(dir);
+  refuseRetiredKeys(project.data);
   const merged = withFlags(project.data, options);
   const shape = optionalProblems(merged);
   if (shape.length)
@@ -4209,6 +4209,7 @@ async function reset(ctx, options) {
 }
 
 // src/cli.ts
+var TYPE_FLAG_GONE = "--type is no longer an option: Velven no longer asks what kind of project it is. Run the command without it.";
 var HELP = `velven ${VERSION}: publish a folder to Velven.
 
 Usage:
@@ -4220,7 +4221,6 @@ Usage:
                               (not signed in: an unlisted page with a claim token, no --prod)
       --wait                  Wait for the preview link, or with --prod until it is live
       --title <text>          Override velven.json for this run
-      --type <type>           game, world, tool or wonder
       --devices <list>        desktop, mobile, vr (comma separated)
       --description <text>
       --engine <engine>
@@ -4261,18 +4261,21 @@ var COMMANDS = {
       description: "string",
       engine: "string"
     },
-    run: (ctx, p) => publish(ctx, {
-      dir: p.positionals[0],
-      prod: p.flags.prod === true,
-      wait: p.flags.wait === true,
-      yes: p.flags.yes === true,
-      json: p.flags.json === true,
-      title: stringFlag(p, "title"),
-      type: stringFlag(p, "type"),
-      devices: stringFlag(p, "devices"),
-      description: stringFlag(p, "description"),
-      engine: stringFlag(p, "engine")
-    })
+    run: (ctx, p) => {
+      if (p.flags.type !== undefined)
+        throw new CliError(TYPE_FLAG_GONE, EXIT.usage, "usage");
+      return publish(ctx, {
+        dir: p.positionals[0],
+        prod: p.flags.prod === true,
+        wait: p.flags.wait === true,
+        yes: p.flags.yes === true,
+        json: p.flags.json === true,
+        title: stringFlag(p, "title"),
+        devices: stringFlag(p, "devices"),
+        description: stringFlag(p, "description"),
+        engine: stringFlag(p, "engine")
+      });
+    }
   },
   versions: {
     flags: { json: "boolean", space: "string" },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velven/cli",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Publish a folder to Velven, the community marketplace for spaces built with AI: a private preview first, then hosted and live on its own page in seconds.",
   "license": "MIT",
   "homepage": "https://velven.ai/docs",