@neta-art/cohub-cli 4.0.0 → 6.0.0

package/dist/commands/{works.js → apps.js}

@@ -2,11 +2,11 @@ import { HttpError } from "@neta-art/cohub";
 import { createClient } from "../client.js";
 import { error, handleHttp, json as outJson, jsonRequested, ok, table } from "../output.js";
 import { resolveSpace } from "../space.js";
-import { downloadWork } from "../work-download.js";
-import { getWorkByRef, parseWorkRef } from "../work-ref.js";
-import { registerWorkCommerce } from "./work-commerce.js";
-const WORK_STATUSES = ["published", "disabled"];
-const WORK_VISIBILITIES = ["public", "space"];
+import { downloadApp } from "../app-download.js";
+import { getAppByRef, parseAppRef } from "../app-ref.js";
+import { registerAppCommerce } from "./app-commerce.js";
+const APP_STATUSES = ["published", "disabled"];
+const APP_VISIBILITIES = ["public", "space"];
 const collectOption = (value, previous = []) => [...previous, value];
 function parseChoice(value, name, choices) {
     if (choices.includes(value))
@@ -62,13 +62,13 @@ function resolveStatus(opts) {
     const values = [opts.status, opts.disabled ? "disabled" : undefined].filter(Boolean);
     if (values.length > 1)
         return error("Conflicting status", "Use only one of --status or --disabled");
-    return values[0] ? parseChoice(values[0], "status", WORK_STATUSES) : "published";
+    return values[0] ? parseChoice(values[0], "status", APP_STATUSES) : "published";
 }
 function resolveVisibility(value) {
-    return value ? parseChoice(value, "visibility", WORK_VISIBILITIES) : undefined;
+    return value ? parseChoice(value, "visibility", APP_VISIBILITIES) : undefined;
 }
-function printWork(work) {
-    table([work], [
+function printApp(app) {
+    table([app], [
         { key: "id", label: "ID" },
         { key: "slug", label: "Slug" },
         { key: "status", label: "Status" },
@@ -79,7 +79,7 @@ function printWork(work) {
         { key: "publishedAt", label: "Published" },
     ]);
 }
-function printWorkUrls(result) {
+function printAppUrls(result) {
     const lines = [
         result.publicUrl ? `Public URL: ${result.publicUrl}` : null,
         result.content?.url ? `Content URL: ${result.content.url}` : null,
@@ -96,7 +96,7 @@ function promotionUrl(publicUrl, promotion) {
         url.searchParams.set(key, value);
     return url.toString();
 }
-function printWorkStats(stats) {
+function printAppStats(stats) {
     table([stats.summary], [
         { key: "totalViews", label: "Total" },
         { key: "views24h", label: "24h" },
@@ -111,19 +111,19 @@ function printWorkStats(stats) {
         ]);
     }
 }
-export async function getWorkStatsByRef(client, work) {
-    const ref = parseWorkRef(work);
+export async function getAppStatsByRef(client, app) {
+    const ref = parseAppRef(app);
     if ("id" in ref)
-        return client.works.getStats(ref.id);
-    const detail = await getWorkByRef(client, work);
-    return client.works.getStats(detail.work.id);
+        return client.apps.getStats(ref.id);
+    const detail = await getAppByRef(client, app);
+    return client.apps.getStats(detail.app.id);
 }
 async function confirmDelete(opts) {
     if (opts.yes)
         return;
     if (!process.stdin.isTTY || !process.stdout.isTTY)
-        return error("Confirmation required", "Pass --yes to delete the work.");
-    process.stdout.write("Deleting a work also removes its versions and viewer grants. Continue? [y/N] ");
+        return error("Confirmation required", "Pass --yes to delete the app.");
+    process.stdout.write("Deleting an app also removes its versions and viewer grants. Continue? [y/N] ");
     const chunks = [];
     for await (const chunk of process.stdin) {
         chunks.push(chunk);
@@ -133,34 +133,43 @@ async function confirmDelete(opts) {
     if (answer !== "y" && answer !== "yes")
         return error("Cancelled");
 }
-async function publishWorkVersion(id, opts) {
+async function publishAppVersion(id, opts) {
     const client = createClient();
     try {
-        const result = await client.works.publishVersion(id);
+        const result = await client.apps.publishVersion(id);
         if (jsonRequested(opts))
             return outJson(result);
-        ok(`Work version updated: v${result.version.version}`);
-        printWork(result.work);
+        ok(`App version updated: v${result.version.version}`);
+        printApp(result.app);
     }
     catch (e) {
         handleHttp(e);
     }
 }
-export function registerWorks(program) {
-    const worksCmd = program.command("works").description("Work management");
-    worksCmd
+export function registerApps(program) {
+    const appsCmd = program
+        .command("apps")
+        .description("App management")
+        // Legacy spelling; hidden from help but still typed by existing scripts.
+        .alias("works")
+        .hook("preAction", () => {
+        if (process.argv.slice(2).includes("works")) {
+            ok("Deprecated: `cohub works` is now `cohub apps`.");
+        }
+    });
+    appsCmd
         .command("ls")
         .alias("list")
-        .description("List works in the target space")
+        .description("List apps in the target space")
         .option("--json", "Output as JSON")
         .action(async (opts) => {
-        const spaceId = resolveSpace(worksCmd);
+        const spaceId = resolveSpace(appsCmd);
         const client = createClient();
         try {
-            const result = await client.works.listBySpace(spaceId);
+            const result = await client.apps.listBySpace(spaceId);
             if (jsonRequested(opts))
                 return outJson(result);
-            table(result.works, [
+            table(result.apps, [
                 { key: "id", label: "ID" },
                 { key: "slug", label: "Slug" },
                 { key: "status", label: "Status" },
@@ -175,49 +184,49 @@ export function registerWorks(program) {
             handleHttp(e);
         }
     });
-    worksCmd
-        .command("get <work>")
-        .description("Show work details by id, URL, mention URI, or username/space/work")
+    appsCmd
+        .command("get <app>")
+        .description("Show app details by id, URL, mention URI, or username/space/app")
         .option("--json", "Output as JSON")
-        .action(async (work, opts) => {
+        .action(async (app, opts) => {
         const client = createClient();
         try {
-            const result = await getWorkByRef(client, work);
+            const result = await getAppByRef(client, app);
             if (jsonRequested(opts))
                 return outJson(result);
-            printWork(result.work);
-            printWorkUrls(result);
+            printApp(result.app);
+            printAppUrls(result);
         }
         catch (e) {
             handleHttp(e);
         }
     });
-    worksCmd
-        .command("stats <work>")
-        .description("Show view statistics by id, URL, mention URI, or username/space/work")
+    appsCmd
+        .command("stats <app>")
+        .description("Show view statistics by id, URL, mention URI, or username/space/app")
         .option("--json", "Output as JSON")
-        .action(async (work, opts) => {
+        .action(async (app, opts) => {
         const client = createClient();
         try {
-            const result = await getWorkStatsByRef(client, work);
+            const result = await getAppStatsByRef(client, app);
             if (jsonRequested(opts))
                 return outJson(result);
-            printWorkStats(result);
+            printAppStats(result);
         }
         catch (e) {
             handleHttp(e);
         }
     });
-    worksCmd
-        .command("download <work>")
-        .description("Download a published file or directory Work")
+    appsCmd
+        .command("download <app>")
+        .description("Download a published file or directory app")
         .option("-o, --output <path>", "Output file or directory")
         .option("--json", "Output as JSON")
-        .action(async (work, opts) => {
+        .action(async (app, opts) => {
         const client = createClient();
         try {
-            const detail = await getWorkByRef(client, work);
-            const result = await downloadWork(detail, opts.output);
+            const detail = await getAppByRef(client, app);
+            const result = await downloadApp(detail, opts.output);
             if (jsonRequested(opts))
                 return outJson(result);
             ok(`Downloaded ${result.files} file${result.files === 1 ? "" : "s"} to ${result.output}`);
@@ -226,43 +235,43 @@ export function registerWorks(program) {
             handleHttp(e);
         }
     });
-    worksCmd
-        .command("resolve <workSlug>")
-        .description("Resolve a published work by owner and space slug")
+    appsCmd
+        .command("resolve <appSlug>")
+        .description("Resolve a published app by owner and space slug")
         .option("--owner <username>", "Owner username")
         .option("--space-slug <slug>", "Space slug")
         .option("--json", "Output as JSON")
-        .action(async (workSlug, opts) => {
+        .action(async (appSlug, opts) => {
         if (!opts.owner?.trim())
             return error("Missing owner username", "Pass --owner <username>.");
         if (!opts.spaceSlug?.trim())
             return error("Missing space slug", "Pass --space-slug <slug>.");
         const client = createClient();
         try {
-            const result = await client.works.getBySlug(opts.owner.trim(), opts.spaceSlug.trim(), workSlug);
+            const result = await client.apps.getBySlug(opts.owner.trim(), opts.spaceSlug.trim(), appSlug);
             if (jsonRequested(opts))
                 return outJson(result);
-            printWork(result.work);
-            printWorkUrls(result);
+            printApp(result.app);
+            printAppUrls(result);
         }
         catch (e) {
             handleHttp(e);
         }
     });
-    worksCmd
+    appsCmd
         .command("publish <slug>")
-        .description("Create or publish a work in the target space")
+        .description("Create or publish an app in the target space")
         .option("--file <path>", "Publish a file (HTML page, board, or any other file)")
         .option("--dir <path>", "Publish a directory site")
         .option("--port <port>", "Publish a public sandbox port")
         .option("--disabled", "Create as disabled")
-        .option("--status <status>", "Work status: published, disabled")
-        .option("--visibility <visibility>", "Work visibility: public, space")
-        .option("--work-scope <scope>", "Scope granted to the work runtime (space.view, session.view, file.view, taskrun.view)", collectOption, [])
+        .option("--status <status>", "App status: published, disabled")
+        .option("--visibility <visibility>", "App visibility: public, space")
+        .option("--app-scope <scope>", "Scope granted to the app runtime (space.view, session.view, file.view, taskrun.view)", collectOption, [])
         .option("--viewer-scope <scope>", "Scope viewers may request (taskrun.view, session.prompt.readonly, session.prompt.fullaccess, generation.create, user.space.list, user.session.list, user.usage.read)", collectOption, [])
-        .option("--meta <json>", "Work metadata as a JSON object")
-        .option("--hide-cohub-bar", "Hide the Cohub footer bar on the public work page")
-        .option("--show-cohub-bar", "Show the Cohub footer bar on the public work page")
+        .option("--meta <json>", "App metadata as a JSON object")
+        .option("--hide-cohub-bar", "Hide the Cohub footer bar on the public app page")
+        .option("--show-cohub-bar", "Show the Cohub footer bar on the public app page")
         .option("--json", "Output as JSON")
         .action(async (slug, opts) => {
         if (opts.hideCohubBar && opts.showCohubBar)
@@ -270,7 +279,7 @@ export function registerWorks(program) {
         const target = resolveTarget(opts);
         if (!target)
             return error("Missing target", "Use one of --file, --dir, or --port.");
-        const spaceId = resolveSpace(worksCmd);
+        const spaceId = resolveSpace(appsCmd);
         const client = createClient();
         const status = resolveStatus(opts);
         const meta = withCohubBarMeta({
@@ -285,72 +294,72 @@ export function registerWorks(program) {
             visibility: resolveVisibility(opts.visibility),
             targetType: target.targetType,
             targetRef: target.targetRef,
-            workScopes: opts.workScope,
+            appScopes: opts.appScope,
             allowedViewerScopes: opts.viewerScope,
             meta,
         };
         try {
-            const result = await client.works.create(input);
+            const result = await client.apps.create(input);
             if (jsonRequested(opts))
                 return outJson(result);
-            ok(`Work published: ${result.work.id}`);
-            printWork(result.work);
+            ok(`App published: ${result.app.id}`);
+            printApp(result.app);
         }
         catch (e) {
             if (!(e instanceof HttpError) || e.status !== 409)
                 handleHttp(e);
             try {
-                const { works } = await client.works.listBySpace(spaceId);
-                const existingWork = works.find((work) => work.slug === slug);
-                if (!existingWork)
+                const { apps } = await client.apps.listBySpace(spaceId);
+                const existingApp = apps.find((app) => app.slug === slug);
+                if (!existingApp)
                     return handleHttp(e);
-                const { work } = await client.works.update(existingWork.id, {
-                    status: status === "published" && existingWork.status !== "published" ? existingWork.status : status,
+                const { app } = await client.apps.update(existingApp.id, {
+                    status: status === "published" && existingApp.status !== "published" ? existingApp.status : status,
                     visibility: resolveVisibility(opts.visibility),
                     targetType: target.targetType,
                     targetRef: target.targetRef,
-                    workScopes: opts.workScope,
+                    appScopes: opts.appScope,
                     allowedViewerScopes: opts.viewerScope,
                     meta,
                 });
                 const publishedVersion = status === "published"
-                    ? await client.works.publishVersion(work.id)
+                    ? await client.apps.publishVersion(app.id)
                     : null;
-                const result = publishedVersion ?? { work };
+                const result = publishedVersion ?? { app };
                 if (jsonRequested(opts))
                     return outJson(result);
-                ok(status === "published" && publishedVersion ? `Work version updated: v${publishedVersion.version.version}` : `Work updated: ${work.id}`);
-                printWork(result.work);
+                ok(status === "published" && publishedVersion ? `App version updated: v${publishedVersion.version.version}` : `App updated: ${app.id}`);
+                printApp(result.app);
             }
             catch (fallbackError) {
                 handleHttp(fallbackError);
             }
         }
     });
-    worksCmd
+    appsCmd
         .command("update <id>")
-        .description("Update work settings")
-        .option("--slug <slug>", "New work slug")
+        .description("Update app settings")
+        .option("--slug <slug>", "New app slug")
         .option("--file <path>", "Use a file target (HTML page, board, or any other file)")
         .option("--dir <path>", "Use a directory site target")
         .option("--port <port>", "Use a public sandbox port target")
         .option("--disabled", "Set status to disabled")
-        .option("--status <status>", "Work status: published, disabled")
-        .option("--visibility <visibility>", "Work visibility: public, space")
-        .option("--work-scope <scope>", "Scope granted to the work runtime (space.view, session.view, file.view, taskrun.view)", collectOption, [])
+        .option("--status <status>", "App status: published, disabled")
+        .option("--visibility <visibility>", "App visibility: public, space")
+        .option("--app-scope <scope>", "Scope granted to the app runtime (space.view, session.view, file.view, taskrun.view)", collectOption, [])
         .option("--viewer-scope <scope>", "Scope viewers may request (taskrun.view, session.prompt.readonly, session.prompt.fullaccess, generation.create, user.space.list, user.session.list, user.usage.read)", collectOption, [])
-        .option("--clear-work-scopes", "Clear work runtime scopes")
+        .option("--clear-app-scopes", "Clear app runtime scopes")
         .option("--clear-viewer-scopes", "Clear viewer-requestable scopes")
-        .option("--meta <json>", "Work metadata as a JSON object")
-        .option("--hide-cohub-bar", "Hide the Cohub footer bar on the public work page")
-        .option("--show-cohub-bar", "Show the Cohub footer bar on the public work page")
+        .option("--meta <json>", "App metadata as a JSON object")
+        .option("--hide-cohub-bar", "Hide the Cohub footer bar on the public app page")
+        .option("--show-cohub-bar", "Show the Cohub footer bar on the public app page")
         .option("--json", "Output as JSON")
         .action(async (id, opts) => {
         if (opts.hideCohubBar && opts.showCohubBar)
             return error("Conflicting Cohub bar options", "Use either --hide-cohub-bar or --show-cohub-bar.");
         const target = resolveTarget(opts);
-        if (opts.clearWorkScopes && opts.workScope?.length)
-            return error("Conflicting work scopes", "Use either --work-scope or --clear-work-scopes.");
+        if (opts.clearAppScopes && opts.appScope?.length)
+            return error("Conflicting app scopes", "Use either --app-scope or --clear-app-scopes.");
         if (opts.clearViewerScopes && opts.viewerScope?.length)
             return error("Conflicting viewer scopes", "Use either --viewer-scope or --clear-viewer-scopes.");
         const hasMetaUpdate = opts.meta !== undefined || opts.hideCohubBar || opts.showCohubBar;
@@ -360,7 +369,7 @@ export function registerWorks(program) {
             let baseMeta = opts.meta !== undefined ? parseJsonObject(opts.meta, "meta") ?? null : undefined;
             if (baseMeta === undefined && (opts.hideCohubBar || opts.showCohubBar)) {
                 try {
-                    baseMeta = (await client.works.get(id)).work.meta;
+                    baseMeta = (await client.apps.get(id)).app.meta;
                 }
                 catch (e) {
                     handleHttp(e);
@@ -373,52 +382,52 @@ export function registerWorks(program) {
             });
         }
         const nextStatus = opts.status || opts.disabled ? resolveStatus(opts) : undefined;
-        const currentWork = nextStatus === "published" ? (await client.works.get(id)).work : null;
+        const currentApp = nextStatus === "published" ? (await client.apps.get(id)).app : null;
         const input = compactObject({
             slug: opts.slug,
-            status: nextStatus === "published" && currentWork?.status !== "published" ? currentWork?.status : nextStatus,
+            status: nextStatus === "published" && currentApp?.status !== "published" ? currentApp?.status : nextStatus,
             visibility: resolveVisibility(opts.visibility),
             targetType: target?.targetType,
             targetRef: target?.targetRef,
-            workScopes: opts.clearWorkScopes ? [] : opts.workScope?.length ? opts.workScope : undefined,
+            appScopes: opts.clearAppScopes ? [] : opts.appScope?.length ? opts.appScope : undefined,
             allowedViewerScopes: opts.clearViewerScopes ? [] : opts.viewerScope?.length ? opts.viewerScope : undefined,
             meta,
         });
         if (Object.keys(input).length === 0)
-            return error("Nothing to update", "Pass --slug, --file, --dir, --port, --status, --visibility, --work-scope, --viewer-scope, --clear-work-scopes, --clear-viewer-scopes, --meta, --hide-cohub-bar, or --show-cohub-bar.");
+            return error("Nothing to update", "Pass --slug, --file, --dir, --port, --status, --visibility, --app-scope, --viewer-scope, --clear-app-scopes, --clear-viewer-scopes, --meta, --hide-cohub-bar, or --show-cohub-bar.");
         try {
-            const updated = await client.works.update(id, input);
-            const publishedVersion = nextStatus === "published" && currentWork?.status !== "published"
-                ? await client.works.publishVersion(updated.work.id)
+            const updated = await client.apps.update(id, input);
+            const publishedVersion = nextStatus === "published" && currentApp?.status !== "published"
+                ? await client.apps.publishVersion(updated.app.id)
                 : null;
-            const result = publishedVersion ?? updated;
+            const result = publishedVersion ?? { app: updated.app };
             if (jsonRequested(opts))
                 return outJson(result);
-            ok(publishedVersion ? `Work published: v${publishedVersion.version.version}` : "Work updated");
-            printWork(result.work);
+            ok(publishedVersion ? `App published: v${publishedVersion.version.version}` : "App updated");
+            printApp(result.app);
         }
         catch (e) {
             handleHttp(e);
         }
     });
-    worksCmd
+    appsCmd
         .command("publish-version <id>")
-        .description("Publish or update the current work version")
+        .description("Publish or update the current app version")
         .option("--json", "Output as JSON")
-        .action(publishWorkVersion);
-    worksCmd
+        .action(publishAppVersion);
+    appsCmd
         .command("release <id>", { hidden: true })
         .description("Deprecated alias for publish-version")
         .option("--json", "Output as JSON")
-        .action(publishWorkVersion);
-    worksCmd
+        .action(publishAppVersion);
+    appsCmd
         .command("versions <id>")
-        .description("List work versions")
+        .description("List app versions")
         .option("--json", "Output as JSON")
         .action(async (id, opts) => {
         const client = createClient();
         try {
-            const result = await client.works.listVersions(id);
+            const result = await client.apps.listVersions(id);
             if (jsonRequested(opts))
                 return outJson(result);
             table(result.versions, [
@@ -433,17 +442,17 @@ export function registerWorks(program) {
             handleHttp(e);
         }
     });
-    const promotionsCmd = worksCmd.command("promotions").description("Work promotion links and analytics");
+    const promotionsCmd = appsCmd.command("promotions").description("App promotion links and analytics");
     promotionsCmd
-        .command("list <work>")
+        .command("list <app>")
         .alias("ls")
         .description("List promotion links")
         .option("--json", "Output as JSON")
-        .action(async (workRef, opts) => {
+        .action(async (appRef, opts) => {
         const client = createClient();
         try {
-            const detail = await getWorkByRef(client, workRef);
-            const result = await client.works.listPromotions(detail.work.id);
+            const detail = await getAppByRef(client, appRef);
+            const result = await client.apps.listPromotions(detail.app.id);
             const promotions = result.promotions.map((promotion) => ({
                 ...promotion,
                 url: promotionUrl(detail.publicUrl, promotion),
@@ -462,7 +471,7 @@ export function registerWorks(program) {
         }
     });
     promotionsCmd
-        .command("create <work>")
+        .command("create <app>")
         .description("Create an immutable promotion link")
         .requiredOption("--name <name>", "Promotion name")
         .option("--provider <provider>", "Promotion provider", "generic")
@@ -473,10 +482,10 @@ export function registerWorks(program) {
         .option("--utm-term <value>", "UTM term")
         .option("--utm-content <value>", "UTM content")
         .option("--json", "Output as JSON")
-        .action(async (workRef, opts) => {
+        .action(async (appRef, opts) => {
         const client = createClient();
         try {
-            const detail = await getWorkByRef(client, workRef);
+            const detail = await getAppByRef(client, appRef);
             const parameters = Object.fromEntries(Object.entries({
                 utm_id: opts.utmId,
                 utm_source: opts.utmSource,
@@ -485,7 +494,7 @@ export function registerWorks(program) {
                 utm_term: opts.utmTerm,
                 utm_content: opts.utmContent,
             }).filter((entry) => typeof entry[1] === "string"));
-            const result = await client.works.createPromotion(detail.work.id, {
+            const result = await client.apps.createPromotion(detail.app.id, {
                 name: opts.name,
                 provider: opts.provider,
                 parameters,
@@ -506,14 +515,14 @@ export function registerWorks(program) {
         }
     });
     promotionsCmd
-        .command("stats <work> <promotionId>")
+        .command("stats <app> <promotionId>")
         .description("Show promotion analytics")
         .option("--json", "Output as JSON")
-        .action(async (workRef, promotionId, opts) => {
+        .action(async (appRef, promotionId, opts) => {
         const client = createClient();
         try {
-            const detail = await getWorkByRef(client, workRef);
-            const result = await client.works.getPromotionStats(detail.work.id, promotionId);
+            const detail = await getAppByRef(client, appRef);
+            const result = await client.apps.getPromotionStats(detail.app.id, promotionId);
             if (jsonRequested(opts))
                 return outJson(result);
             table([{
@@ -538,18 +547,18 @@ export function registerWorks(program) {
             handleHttp(e);
         }
     });
-    registerWorkCommerce(worksCmd);
-    worksCmd
+    registerAppCommerce(appsCmd);
+    appsCmd
         .command("rm <id>")
         .alias("delete")
-        .description("Delete a work")
+        .description("Delete an app")
         .option("-y, --yes", "Confirm deletion")
         .action(async (id, opts) => {
         await confirmDelete(opts);
         const client = createClient();
         try {
-            await client.works.delete(id);
-            ok("Work deleted");
+            await client.apps.delete(id);
+            ok("App deleted");
         }
         catch (e) {
             handleHttp(e);

package/dist/commands/board-domain.js

@@ -1,8 +1,10 @@
 import { registerBoardAnimationCommands } from "./boards/animation.js";
 import { registerBoardAppearanceCommands } from "./boards/appearance.js";
+import { registerBoardExampleCommands } from "./boards/examples.js";
 import { registerBoardItemCommands } from "./boards/items.js";
 import { registerBoardNodeCommands } from "./boards/nodes.js";
 export function registerBoardDomainCommands(boards) {
+    registerBoardExampleCommands(boards);
     registerBoardAppearanceCommands(boards);
     registerBoardNodeCommands(boards);
     registerBoardItemCommands(boards);