@khanglvm/outline-cli 0.1.5 → 0.1.6

package/scripts/release.mjs

@@ -1,353 +0,0 @@
-#!/usr/bin/env node
-
-import fs from "node:fs";
-import fsp from "node:fs/promises";
-import path from "node:path";
-import { spawnSync } from "node:child_process";
-import { fileURLToPath } from "node:url";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const repoRoot = path.resolve(__dirname, "..");
-
-function usage() {
-  process.stdout.write(
-    [
-      "Usage:",
-      "  node ./scripts/release.mjs [--bump <patch|minor|major|prepatch|preminor|premajor|prerelease> | --version <x.y.z>]",
-      "                             [--tag <dist-tag>] [--otp <code>] [--access <public|restricted>]",
-      "                             [--no-publish] [--no-push] [--skip-check] [--skip-test] [--allow-dirty]",
-      "",
-      "Examples:",
-      "  npm run release -- --bump patch",
-      "  npm run release -- --version 0.2.0",
-      "  npm run release -- --bump minor --tag next --no-publish --no-push",
-      "",
-    ].join("\n")
-  );
-}
-
-function parseArgs(argv) {
-  let sawBump = false;
-  let sawVersion = false;
-  function requireValue(flag, index) {
-    const value = argv[index + 1];
-    if (!value || value.startsWith("--")) {
-      throw new Error(`Missing value for ${flag}`);
-    }
-    return value;
-  }
-  const opts = {
-    bump: "patch",
-    version: null,
-    tag: "latest",
-    otp: null,
-    access: "public",
-    publish: true,
-    push: true,
-    skipCheck: false,
-    skipTest: false,
-    allowDirty: false,
-    changelogPath: path.join(repoRoot, "CHANGELOG.md"),
-  };
-
-  for (let i = 0; i < argv.length; i += 1) {
-    const arg = argv[i];
-    if (arg === "--help" || arg === "-h") {
-      opts.help = true;
-      continue;
-    }
-    if (arg === "--bump") {
-      opts.bump = requireValue("--bump", i);
-      sawBump = true;
-      i += 1;
-      continue;
-    }
-    if (arg === "--version") {
-      opts.version = requireValue("--version", i);
-      sawVersion = true;
-      i += 1;
-      continue;
-    }
-    if (arg === "--tag") {
-      opts.tag = requireValue("--tag", i);
-      i += 1;
-      continue;
-    }
-    if (arg === "--otp") {
-      opts.otp = requireValue("--otp", i);
-      i += 1;
-      continue;
-    }
-    if (arg === "--access") {
-      opts.access = requireValue("--access", i);
-      i += 1;
-      continue;
-    }
-    if (arg === "--changelog") {
-      opts.changelogPath = path.resolve(repoRoot, requireValue("--changelog", i));
-      i += 1;
-      continue;
-    }
-    if (arg === "--no-publish") {
-      opts.publish = false;
-      continue;
-    }
-    if (arg === "--no-push") {
-      opts.push = false;
-      continue;
-    }
-    if (arg === "--skip-check") {
-      opts.skipCheck = true;
-      continue;
-    }
-    if (arg === "--skip-test") {
-      opts.skipTest = true;
-      continue;
-    }
-    if (arg === "--allow-dirty") {
-      opts.allowDirty = true;
-      continue;
-    }
-    throw new Error(`Unknown argument: ${arg}`);
-  }
-
-  if (sawVersion && sawBump) {
-    throw new Error("Use either --version or --bump, not both.");
-  }
-
-  if (!opts.version && !opts.bump) {
-    throw new Error("Missing version strategy. Provide --version <x.y.z> or --bump <type>.");
-  }
-
-  const validBumps = new Set(["patch", "minor", "major", "prepatch", "preminor", "premajor", "prerelease"]);
-  if (!opts.version && !validBumps.has(opts.bump)) {
-    throw new Error(`Invalid --bump value: ${opts.bump}`);
-  }
-
-  return opts;
-}
-
-function loadDotEnvFileIfPresent(filePath) {
-  if (!fs.existsSync(filePath)) {
-    return;
-  }
-  const raw = fs.readFileSync(filePath, "utf8");
-  for (const line of raw.split(/\r?\n/)) {
-    const trimmed = line.trim();
-    if (!trimmed || trimmed.startsWith("#")) {
-      continue;
-    }
-    const i = trimmed.indexOf("=");
-    if (i <= 0) {
-      continue;
-    }
-    const key = trimmed.slice(0, i).trim();
-    let value = trimmed.slice(i + 1).trim();
-    if (
-      (value.startsWith('"') && value.endsWith('"')) ||
-      (value.startsWith("'") && value.endsWith("'"))
-    ) {
-      value = value.slice(1, -1);
-    }
-    if (process.env[key] == null) {
-      process.env[key] = value;
-    }
-  }
-}
-
-function run(cmd, args, options = {}) {
-  const capture = options.capture === true;
-  const display = `$ ${cmd} ${args.join(" ")}`;
-  process.stdout.write(`${display}\n`);
-  const res = spawnSync(cmd, args, {
-    cwd: repoRoot,
-    encoding: "utf8",
-    stdio: capture ? ["ignore", "pipe", "pipe"] : "inherit",
-    env: { ...process.env, ...(options.env || {}) },
-  });
-  if (res.status !== 0) {
-    const extra = capture ? `\n${(res.stdout || "").trim()}\n${(res.stderr || "").trim()}` : "";
-    throw new Error(`Command failed (${res.status}): ${display}${extra}`);
-  }
-  return capture ? (res.stdout || "").trim() : "";
-}
-
-function readJson(filePath) {
-  return JSON.parse(fs.readFileSync(filePath, "utf8"));
-}
-
-function currentDateIso() {
-  const now = new Date();
-  const yyyy = String(now.getUTCFullYear());
-  const mm = String(now.getUTCMonth() + 1).padStart(2, "0");
-  const dd = String(now.getUTCDate()).padStart(2, "0");
-  return `${yyyy}-${mm}-${dd}`;
-}
-
-function getLatestSemverTag() {
-  const tags = run("git", ["tag", "--list", "v*.*.*", "--sort=-version:refname"], { capture: true })
-    .split(/\r?\n/)
-    .map((line) => line.trim())
-    .filter(Boolean);
-  return tags[0] || null;
-}
-
-function listCommitSubjectsSince(tag) {
-  const range = tag ? `${tag}..HEAD` : "HEAD";
-  const out = run("git", ["log", range, "--pretty=format:%s (%h)"], { capture: true });
-  const rows = out
-    .split(/\r?\n/)
-    .map((line) => line.trim())
-    .filter(Boolean);
-  return rows.length > 0 ? rows : ["Maintenance release."];
-}
-
-async function updateChangelog({ changelogPath, nextVersion, previousTag }) {
-  let content = "";
-  if (fs.existsSync(changelogPath)) {
-    content = await fsp.readFile(changelogPath, "utf8");
-  } else {
-    content = "# Changelog\n\n";
-  }
-
-  if (!content.startsWith("# Changelog")) {
-    content = `# Changelog\n\n${content.trimStart()}`;
-  }
-
-  const existingHeading = new RegExp(`^##\\s+${nextVersion}\\s+-\\s+`, "m");
-  if (existingHeading.test(content)) {
-    throw new Error(`CHANGELOG already has an entry for ${nextVersion}`);
-  }
-
-  const commits = listCommitSubjectsSince(previousTag);
-  const scopeLine = previousTag ? `- Changes since \`${previousTag}\`.` : "- Initial tagged release notes.";
-  const commitLines = commits.map((line) => `- ${line}`).join("\n");
-  const entry = `## ${nextVersion} - ${currentDateIso()}\n\n${scopeLine}\n${commitLines}\n`;
-
-  const header = "# Changelog";
-  const body = content.slice(header.length).trimStart();
-  const next = `${header}\n\n${entry}\n${body}`.replace(/\n{3,}/g, "\n\n");
-  await fsp.writeFile(changelogPath, `${next.trimEnd()}\n`, "utf8");
-}
-
-function ensureBuildKey() {
-  loadDotEnvFileIfPresent(path.join(repoRoot, ".env.local"));
-  const key = process.env.OUTLINE_ENTRY_BUILD_KEY;
-  if (!key || String(key).trim().length < 24) {
-    throw new Error(
-      "OUTLINE_ENTRY_BUILD_KEY is required for release integrity binding. Set it in environment or .env.local."
-    );
-  }
-}
-
-function ensureGitClean(allowDirty) {
-  if (allowDirty) {
-    return;
-  }
-  const dirty = run("git", ["status", "--porcelain"], { capture: true });
-  if (dirty.trim()) {
-    throw new Error("Git working tree is not clean. Commit/stash changes or pass --allow-dirty.");
-  }
-}
-
-function ensureTagDoesNotExist(tagName) {
-  const out = run("git", ["tag", "--list", tagName], { capture: true });
-  if (out.trim() === tagName) {
-    throw new Error(`Git tag already exists: ${tagName}`);
-  }
-}
-
-function bumpVersion(opts) {
-  const arg = opts.version || opts.bump;
-  const out = run("npm", ["version", arg, "--no-git-tag-version"], { capture: true });
-  const newVersion = out.trim().replace(/^v/, "");
-  if (!newVersion) {
-    throw new Error("Unable to resolve next version from npm version output.");
-  }
-  return newVersion;
-}
-
-function publishPackage(opts) {
-  const args = ["publish", "--access", opts.access];
-  if (opts.tag && opts.tag !== "latest") {
-    args.push("--tag", opts.tag);
-  }
-  if (opts.otp) {
-    args.push("--otp", opts.otp);
-  }
-  run("npm", args);
-}
-
-async function main() {
-  const opts = parseArgs(process.argv.slice(2));
-  if (opts.help) {
-    usage();
-    return;
-  }
-
-  ensureBuildKey();
-  ensureGitClean(opts.allowDirty);
-
-  const packageJsonPath = path.join(repoRoot, "package.json");
-  const beforePkg = readJson(packageJsonPath);
-  const previousTag = getLatestSemverTag();
-
-  const branch = run("git", ["rev-parse", "--abbrev-ref", "HEAD"], { capture: true });
-  if (!branch || branch === "HEAD") {
-    throw new Error("Detached HEAD is not supported for release. Check out a branch.");
-  }
-
-  const nextVersion = bumpVersion(opts);
-  const releaseTag = `v${nextVersion}`;
-  ensureTagDoesNotExist(releaseTag);
-  await updateChangelog({
-    changelogPath: opts.changelogPath,
-    nextVersion,
-    previousTag,
-  });
-
-  run("npm", ["run", "integrity:refresh"]);
-  if (!opts.skipCheck) {
-    run("npm", ["run", "check"]);
-  }
-  if (!opts.skipTest) {
-    run("npm", ["test"]);
-  }
-  run("npm", ["pack", "--dry-run"]);
-
-  run("git", ["add", "-A"]);
-  run("git", ["commit", "-m", `chore(release): v${nextVersion}`]);
-  run("git", ["tag", "-a", releaseTag, "-m", releaseTag]);
-
-  if (opts.publish) {
-    publishPackage(opts);
-  }
-
-  if (opts.push) {
-    run("git", ["push", "origin", branch]);
-    run("git", ["push", "origin", releaseTag]);
-  }
-
-  const afterPkg = readJson(packageJsonPath);
-  process.stdout.write(
-    `${JSON.stringify(
-      {
-        ok: true,
-        package: beforePkg.name,
-        previousVersion: beforePkg.version,
-        nextVersion: afterPkg.version,
-        releaseTag,
-        published: opts.publish,
-        pushed: opts.push,
-        branch,
-      },
-      null,
-      2
-    )}\n`
-  );
-}
-
-main().catch((err) => {
-  process.stderr.write(`${err?.stack || err}\n`);
-  process.exit(1);
-});

package/test/action-gate.unit.test.js

@@ -1,157 +0,0 @@
-import test from "node:test";
-import assert from "node:assert/strict";
-import fs from "node:fs/promises";
-import os from "node:os";
-import path from "node:path";
-
-import { CliError } from "../src/errors.js";
-import {
-  assertPerformAction,
-  consumeDocumentDeleteReadReceipt,
-  getActionGateStorePath,
-  getDocumentDeleteReadReceipt,
-  isLikelyMutatingMethod,
-  issueDocumentDeleteReadReceipt,
-} from "../src/action-gate.js";
-
-test("assertPerformAction blocks when performAction is not true", () => {
-  assert.throws(
-    () =>
-      assertPerformAction({}, {
-        tool: "documents.update",
-        action: "update a document",
-      }),
-    (err) => {
-      assert.ok(err instanceof CliError);
-      assert.equal(err.details?.code, "ACTION_GATED");
-      return true;
-    }
-  );
-
-  assert.doesNotThrow(() =>
-    assertPerformAction({ performAction: true }, {
-      tool: "documents.update",
-      action: "update a document",
-    })
-  );
-});
-
-test("isLikelyMutatingMethod treats import/export paths as mutating", () => {
-  assert.equal(isLikelyMutatingMethod("documents.import"), true);
-  assert.equal(isLikelyMutatingMethod("documents.importFile"), true);
-  assert.equal(isLikelyMutatingMethod("/documents.export"), true);
-  assert.equal(isLikelyMutatingMethod("fileOperations.delete"), true);
-  assert.equal(isLikelyMutatingMethod("fileOperations.info"), false);
-});
-
-test("delete read receipt lifecycle: issue -> validate -> consume", async () => {
-  const previousTmp = process.env.OUTLINE_CLI_TMP_DIR;
-  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "outline-cli-action-gate-"));
-  process.env.OUTLINE_CLI_TMP_DIR = tmpDir;
-
-  try {
-    const issued = await issueDocumentDeleteReadReceipt({
-      profileId: "test-profile",
-      documentId: "doc-123",
-      revision: 7,
-      title: "Doc 123",
-      ttlSeconds: 600,
-    });
-
-    assert.ok(typeof issued.token === "string" && issued.token.length > 0);
-    assert.equal(issued.documentId, "doc-123");
-    assert.equal(issued.revision, 7);
-
-    const storePath = getActionGateStorePath();
-    assert.ok(storePath.startsWith(path.resolve(tmpDir)));
-
-    const fetched = await getDocumentDeleteReadReceipt({
-      token: issued.token,
-      profileId: "test-profile",
-      documentId: "doc-123",
-    });
-    assert.equal(fetched.documentId, "doc-123");
-    assert.equal(fetched.revision, 7);
-
-    await assert.rejects(
-      () =>
-        getDocumentDeleteReadReceipt({
-          token: issued.token,
-          profileId: "test-profile",
-          documentId: "doc-999",
-        }),
-      (err) => {
-        assert.ok(err instanceof CliError);
-        assert.equal(err.details?.code, "DELETE_READ_TOKEN_DOCUMENT_MISMATCH");
-        return true;
-      }
-    );
-
-    const consumed = await consumeDocumentDeleteReadReceipt(issued.token);
-    assert.equal(consumed, true);
-
-    await assert.rejects(
-      () =>
-        getDocumentDeleteReadReceipt({
-          token: issued.token,
-          profileId: "test-profile",
-          documentId: "doc-123",
-        }),
-      (err) => {
-        assert.ok(err instanceof CliError);
-        assert.equal(err.details?.code, "DELETE_READ_TOKEN_INVALID");
-        return true;
-      }
-    );
-  } finally {
-    if (previousTmp == null) {
-      delete process.env.OUTLINE_CLI_TMP_DIR;
-    } else {
-      process.env.OUTLINE_CLI_TMP_DIR = previousTmp;
-    }
-    await fs.rm(tmpDir, { recursive: true, force: true });
-  }
-});
-
-test("delete read receipt only accepts document-scoped token kind", async () => {
-  const previousTmp = process.env.OUTLINE_CLI_TMP_DIR;
-  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "outline-cli-action-gate-kind-"));
-  process.env.OUTLINE_CLI_TMP_DIR = tmpDir;
-
-  try {
-    const issued = await issueDocumentDeleteReadReceipt({
-      profileId: "test-profile",
-      documentId: "doc-123",
-      revision: 7,
-      title: "Doc 123",
-      ttlSeconds: 600,
-    });
-
-    const storePath = getActionGateStorePath();
-    const raw = await fs.readFile(storePath, "utf8");
-    const parsed = JSON.parse(raw);
-    parsed.receipts[issued.token].kind = "webhooks.delete.read";
-    await fs.writeFile(storePath, `${JSON.stringify(parsed, null, 2)}\n`, "utf8");
-
-    await assert.rejects(
-      () =>
-        getDocumentDeleteReadReceipt({
-          token: issued.token,
-          profileId: "test-profile",
-          documentId: "doc-123",
-        }),
-      (err) => {
-        assert.ok(err instanceof CliError);
-        assert.equal(err.details?.code, "DELETE_READ_TOKEN_INVALID");
-        return true;
-      }
-    );
-  } finally {
-    if (previousTmp == null) {
-      delete process.env.OUTLINE_CLI_TMP_DIR;
-    } else {
-      process.env.OUTLINE_CLI_TMP_DIR = previousTmp;
-    }
-    await fs.rm(tmpDir, { recursive: true, force: true });
-  }
-});

package/test/agent-skills.unit.test.js

@@ -1,144 +0,0 @@
-import test from "node:test";
-import assert from "node:assert/strict";
-
-import { getAgentSkillHelp, getQuickStartAgentHelp, listHelpSections } from "../src/agent-skills.js";
-import { CliError } from "../src/errors.js";
-
-test("listHelpSections exposes ai-skills section", () => {
-  const sections = listHelpSections();
-  assert.ok(Array.isArray(sections));
-  assert.ok(sections.some((section) => section.id === "quick-start-agent"));
-  assert.ok(sections.some((section) => section.id === "ai-skills"));
-});
-
-test("getQuickStartAgentHelp returns summary by default", () => {
-  const payload = getQuickStartAgentHelp();
-
-  assert.equal(payload.section, "quick-start-agent");
-  assert.equal(payload.view, "summary");
-  assert.ok(Array.isArray(payload.steps));
-  assert.ok(payload.steps.length >= 4);
-  assert.ok(
-    payload.steps.some(
-      (row) => Array.isArray(row.commands) && row.commands.includes("outline-cli --version")
-    )
-  );
-  assert.ok(
-    payload.steps.some(
-      (row) =>
-        typeof row.question === "string" &&
-        row.question.toLowerCase().includes("install the outline-cli skill")
-    )
-  );
-  assert.ok(
-    payload.steps.some(
-      (row) =>
-        Array.isArray(row.commandTemplates) &&
-        row.commandTemplates.some(
-          (cmd) => cmd.includes("npx skills add") && cmd.includes("--skill outline-cli -y") && !cmd.includes("--agent")
-        )
-    )
-  );
-  assert.ok(
-    payload.steps.some(
-      (row) =>
-        typeof row.question === "string" &&
-        row.question.toLowerCase().includes("base url")
-    )
-  );
-  assert.equal(payload.nextCommand, "outline-cli tools help quick-start-agent --view full");
-});
-
-test("getQuickStartAgentHelp returns full payload and validates view", () => {
-  const payload = getQuickStartAgentHelp({ view: "full" });
-  assert.equal(payload.section, "quick-start-agent");
-  assert.equal(payload.view, "full");
-  assert.ok(Array.isArray(payload.steps));
-  assert.ok(payload.steps.some((row) => row.command === "outline-cli profile list"));
-  assert.ok(
-    payload.steps.some(
-      (row) =>
-        row.command &&
-        row.command.includes("--auth-type apiKey") &&
-        row.command.includes("--api-key")
-    )
-  );
-  assert.ok(
-    payload.steps.some(
-      (row) =>
-        Array.isArray(row.commandTemplates) &&
-        row.commandTemplates.includes(
-          "npx skills add https://github.com/khanglvm/skills --skill outline-cli -y"
-        ) &&
-        Array.isArray(row.decisionRules) &&
-        row.decisionRules.some((rule) => rule.toLowerCase().includes("explicitly approves"))
-    )
-  );
-  assert.ok(
-    payload.steps.some(
-      (row) =>
-        row.apiKeySettingsUrlTemplate === "<base-url>/settings/api-and-apps" &&
-        Array.isArray(row.apiKeyConfigTemplate) &&
-        row.apiKeyConfigTemplate.length >= 3
-    )
-  );
-  assert.ok(
-    payload.steps.some(
-      (row) =>
-        row.minimumPromptCount >= 10 &&
-        Array.isArray(row.naturalLanguagePrompts) &&
-        row.naturalLanguagePrompts.length >= 10
-    )
-  );
-  assert.ok(Array.isArray(payload.interactionRules));
-
-  assert.throws(
-    () => getQuickStartAgentHelp({ view: "compact" }),
-    (err) => {
-      assert.ok(err instanceof CliError);
-      assert.equal(err.details?.code, "QUICK_START_HELP_INVALID_VIEW");
-      return true;
-    }
-  );
-});
-
-test("getAgentSkillHelp returns summary guidance by default", () => {
-  const payload = getAgentSkillHelp();
-
-  assert.equal(payload.section, "ai-skills");
-  assert.equal(payload.view, "summary");
-  assert.ok(payload.totalSkills >= 10);
-  assert.equal(payload.skills.length, payload.returnedSkills);
-  assert.ok(payload.globalGuidance?.principles?.length >= 1);
-  assert.ok(payload.skills.some((skill) => skill.id === "legacy_wiki_migration"));
-});
-
-test("getAgentSkillHelp filters by scenario and query", () => {
-  const byScenario = getAgentSkillHelp({ scenario: "uc-19" });
-  assert.equal(byScenario.returnedSkills, 1);
-  assert.equal(byScenario.skills[0].id, "oauth_compliance_audit");
-
-  const byQuery = getAgentSkillHelp({ query: "documents.import_file" });
-  assert.ok(byQuery.skills.some((skill) => skill.id === "legacy_wiki_migration"));
-});
-
-test("getAgentSkillHelp returns full skill payload and validates view", () => {
-  const payload = getAgentSkillHelp({
-    skill: "template_pipeline_execution",
-    view: "full",
-  });
-
-  assert.equal(payload.returnedSkills, 1);
-  assert.equal(payload.skills[0].id, "template_pipeline_execution");
-  assert.ok(Array.isArray(payload.skills[0].sequence));
-  assert.ok(payload.skills[0].sequence.some((step) => step.tool === "templates.extract_placeholders"));
-
-  assert.throws(
-    () => getAgentSkillHelp({ view: "compact" }),
-    (err) => {
-      assert.ok(err instanceof CliError);
-      assert.equal(err.details?.code, "AI_HELP_INVALID_VIEW");
-      return true;
-    }
-  );
-});