@deskwork/cli 0.9.5

package/dist/commands/shortform-start.d.ts

@@ -0,0 +1,33 @@
+/**
+ * deskwork shortform-start — enqueue a shortform draft for editorial
+ * review.
+ *
+ * Mirrors the longform `review-start` flow, but for the per-platform /
+ * per-channel shortform copy that lives in the entry's scrapbook. The
+ * shortform file is the source of truth — the workflow holds version
+ * snapshots that mirror the file's body. The studio's review surface
+ * renders shortform workflows with a small platform/channel header above
+ * the same markdown editor used for longform.
+ *
+ * Usage:
+ *   deskwork shortform-start <project-root> [--site <slug>]
+ *                            --platform <p> [--channel <c>]
+ *                            [--initial-markdown <text>] <slug>
+ *
+ * The `<slug>` positional resolves the calendar entry; `--platform` is
+ * required and must be one of the known Platforms (reddit, youtube,
+ * linkedin, instagram). `--channel` is optional and must be kebab-case
+ * (the same shape as a slug segment). `--initial-markdown` seeds the
+ * file body when scaffolding — leave it off for an empty draft.
+ *
+ * The helper is idempotent: if a non-terminal shortform workflow already
+ * matches `(entryId | site+slug, platform, channel?)`, that workflow is
+ * returned unchanged and the file body is left as-is.
+ *
+ * Emits a JSON result with the workflow id, the studio review URL path
+ * (the operator's running studio is on whatever port they chose — only
+ * the path is emitted), the resolved file path, and the platform /
+ * channel echo so callers can surface them.
+ */
+export declare function run(argv: string[]): Promise<void>;
+//# sourceMappingURL=shortform-start.d.ts.map

package/dist/commands/shortform-start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shortform-start.d.ts","sourceRoot":"","sources":["../../src/commands/shortform-start.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAeH,wBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA6GvD"}

package/dist/commands/shortform-start.js

@@ -0,0 +1,127 @@
+/**
+ * deskwork shortform-start — enqueue a shortform draft for editorial
+ * review.
+ *
+ * Mirrors the longform `review-start` flow, but for the per-platform /
+ * per-channel shortform copy that lives in the entry's scrapbook. The
+ * shortform file is the source of truth — the workflow holds version
+ * snapshots that mirror the file's body. The studio's review surface
+ * renders shortform workflows with a small platform/channel header above
+ * the same markdown editor used for longform.
+ *
+ * Usage:
+ *   deskwork shortform-start <project-root> [--site <slug>]
+ *                            --platform <p> [--channel <c>]
+ *                            [--initial-markdown <text>] <slug>
+ *
+ * The `<slug>` positional resolves the calendar entry; `--platform` is
+ * required and must be one of the known Platforms (reddit, youtube,
+ * linkedin, instagram). `--channel` is optional and must be kebab-case
+ * (the same shape as a slug segment). `--initial-markdown` seeds the
+ * file body when scaffolding — leave it off for an empty draft.
+ *
+ * The helper is idempotent: if a non-terminal shortform workflow already
+ * matches `(entryId | site+slug, platform, channel?)`, that workflow is
+ * returned unchanged and the file body is left as-is.
+ *
+ * Emits a JSON result with the workflow id, the studio review URL path
+ * (the operator's running studio is on whatever port they chose — only
+ * the path is emitted), the resolved file path, and the platform /
+ * channel echo so callers can surface them.
+ */
+import { readConfig } from '@deskwork/core/config';
+import { resolveSite } from '@deskwork/core/paths';
+import { handleStartShortform } from '@deskwork/core/review/handlers';
+import { isPlatform, PLATFORMS } from '@deskwork/core/types';
+import { absolutize, emit, fail, parseArgs } from '@deskwork/core/cli-args';
+export async function run(argv) {
+    const KNOWN_FLAGS = ['site', 'platform', 'channel', 'initial-markdown'];
+    const SLUG_RE = /^[a-z0-9][a-z0-9-]*(\/[a-z0-9][a-z0-9-]*)*$/;
+    const { positional, flags } = parse();
+    if (positional.length < 2) {
+        fail('Usage: deskwork shortform-start <project-root> [--site <slug>] ' +
+            '--platform <p> [--channel <c>] [--initial-markdown <text>] <slug>', 2);
+    }
+    const [rootArg, slug] = positional;
+    const projectRoot = absolutize(rootArg);
+    if (!SLUG_RE.test(slug)) {
+        fail(`invalid slug: ${slug} (must match ${SLUG_RE})`);
+    }
+    const platform = flags.platform;
+    if (platform === undefined) {
+        fail(`--platform is required. Must be one of: ${PLATFORMS.join(', ')}.`, 2);
+    }
+    if (!isPlatform(platform)) {
+        fail(`Invalid --platform "${platform}". Must be one of: ${PLATFORMS.join(', ')}.`);
+    }
+    const channel = flags.channel;
+    const initialMarkdown = flags['initial-markdown'];
+    let config;
+    try {
+        config = readConfig(projectRoot);
+    }
+    catch (err) {
+        fail(err instanceof Error ? err.message : String(err));
+    }
+    let site;
+    try {
+        site = resolveSite(config, flags.site);
+    }
+    catch (err) {
+        fail(err instanceof Error ? err.message : String(err));
+    }
+    const result = handleStartShortform(projectRoot, config, {
+        site,
+        slug,
+        platform,
+        ...(channel !== undefined ? { channel } : {}),
+        ...(initialMarkdown !== undefined ? { initialMarkdown } : {}),
+    });
+    if (result.status !== 200) {
+        fail(errorMessage(result.body));
+    }
+    if (!isSuccessBody(result.body)) {
+        fail('shortform-start: handler returned a malformed response');
+    }
+    const { workflow, existing, filePath } = result.body;
+    emit({
+        workflowId: workflow.id,
+        site: workflow.site,
+        slug: workflow.slug,
+        state: workflow.state,
+        version: workflow.currentVersion,
+        fresh: !existing,
+        platform: workflow.platform,
+        ...(workflow.channel !== undefined ? { channel: workflow.channel } : {}),
+        filePath,
+        reviewUrl: `/dev/editorial-review/${workflow.id}`,
+    });
+    function parse() {
+        try {
+            return parseArgs(argv, KNOWN_FLAGS);
+        }
+        catch (err) {
+            fail(err instanceof Error ? err.message : String(err), 2);
+        }
+    }
+    function isSuccessBody(body) {
+        if (typeof body !== 'object' || body === null)
+            return false;
+        if (!('workflow' in body) || !('filePath' in body))
+            return false;
+        const workflowVal = Reflect.get(body, 'workflow');
+        const filePathVal = Reflect.get(body, 'filePath');
+        return (typeof workflowVal === 'object' &&
+            workflowVal !== null &&
+            typeof filePathVal === 'string');
+    }
+    function errorMessage(body) {
+        if (typeof body === 'object' && body !== null) {
+            const value = Reflect.get(body, 'error');
+            if (typeof value === 'string')
+                return value;
+        }
+        return 'shortform-start: unknown error';
+    }
+}
+//# sourceMappingURL=shortform-start.js.map

package/dist/commands/shortform-start.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shortform-start.js","sourceRoot":"","sources":["../../src/commands/shortform-start.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAEtE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAQ5E,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,IAAc;IACtC,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,kBAAkB,CAAU,CAAC;IACjF,MAAM,OAAO,GAAG,6CAA6C,CAAC;IAE9D,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;IAEtC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,IAAI,CACF,iEAAiE;YAC/D,mEAAmE,EACrE,CAAC,CACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC;IACnC,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAExC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,iBAAiB,IAAI,gBAAgB,OAAO,GAAG,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CACF,2CAA2C,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAClE,CAAC,CACF,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,IAAI,CACF,uBAAuB,QAAQ,sBAAsB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC7E,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAC9B,MAAM,eAAe,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAElD,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,MAAM,GAAG,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE;QACvD,IAAI;QACJ,IAAI;QACJ,QAAQ;QACR,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,GAAG,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC9D,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;IAErD,IAAI,CAAC;QACH,UAAU,EAAE,QAAQ,CAAC,EAAE;QACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,OAAO,EAAE,QAAQ,CAAC,cAAc;QAChC,KAAK,EAAE,CAAC,QAAQ;QAChB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxE,QAAQ;QACR,SAAS,EAAE,yBAAyB,QAAQ,CAAC,EAAE,EAAE;KAClD,CAAC,CAAC;IAEH,SAAS,KAAK;QACZ,IAAI,CAAC;YACH,OAAO,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED,SAAS,aAAa,CAAC,IAAa;QAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAC5D,IAAI,CAAC,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QACjE,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAClD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAClD,OAAO,CACL,OAAO,WAAW,KAAK,QAAQ;YAC/B,WAAW,KAAK,IAAI;YACpB,OAAO,WAAW,KAAK,QAAQ,CAChC,CAAC;IACJ,CAAC;IAED,SAAS,YAAY,CAAC,IAAa;QACjC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACzC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAC;QAC9C,CAAC;QACD,OAAO,gCAAgC,CAAC;IAC1C,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@deskwork/cli",
+  "version": "0.9.5",
+  "type": "module",
+  "description": "Editorial calendar + review CLI for the deskwork plugin",
+  "homepage": "https://github.com/audiocontrol-org/deskwork#readme",
+  "license": "GPL-3.0-or-later",
+  "author": "audiocontrol-org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/audiocontrol-org/deskwork.git",
+    "directory": "packages/cli"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "bin": {
+    "deskwork": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "prepack": "tsc -b tsconfig.build.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@deskwork/core": "*"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "esbuild": "^0.24.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.7.0",
+    "vitest": "^4.1.2"
+  }
+}