@docsxai/plugin 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,32 @@
+# @docsxai/plugin — Claude Code plugin
+
+The first-class invocation surface for the docsxai engine. Install globally:
+
+```
+claude plugin install https://github.com/kalebteccom/docsxai   # (the plugin lives under packages/plugin)
+```
+
+## Commands (deterministic — thin wrappers over the `docsxai` CLI)
+
+| Command                         | What                                                                    |
+| ------------------------------- | ----------------------------------------------------------------------- |
+| `/docsxai:run <project-dir>`    | Re-run flow-files headlessly, refresh `annotations.json` + screenshots. |
+| `/docsxai:render <project-dir>` | Build the interactive viewer.                                           |
+| `/docsxai:push <project-dir>`   | Upload the doc pack to the configured backend.                          |
+| `/docsxai:pull <project-dir>`   | Download the doc pack from the configured backend.                      |
+| `/docsxai:login`                | OAuth login to the backend (CI uses `DOCSX_TOKEN`).                     |
+| `/docsxai:doctor`               | Environment + workspace health-check (✓/✗ + one-line fixes).            |
+
+## Skills (calibration — agent-driven; the host supplies inference)
+
+| Skill       | What                                                                                              |
+| ----------- | ------------------------------------------------------------------------------------------------- |
+| `calibrate` | Drive a calibration end-to-end: discovery → mapping+testing → commit, producing a doc pack.       |
+| `diagnose`  | The explicit failure path — propose a recalibration diff when a deterministic run halts on drift. |
+
+## MCP
+
+The skills shell out to the `docsxai` CLI and use the externally-provided **Claude in Chrome** MCP for
+the discovery stage's live-browser driving. An internal MCP server (engine operations the calibration
+skills call — parse-flow-file, run-flow, apply-ambiguity-resolution, …) is a possible future addition if
+shelling out becomes the bottleneck.

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+/** Absolute path to the plugin root (the directory containing `.claude-plugin/`). */
+export declare const pluginDir: string;
+export interface PluginManifest {
+    name: string;
+    version: string;
+    description: string;
+    author?: {
+        name: string;
+    };
+    homepage?: string;
+}
+/** Read and parse `.claude-plugin/plugin.json`. */
+export declare function readManifest(): Promise<PluginManifest>;
+/** Names of the slash commands the plugin ships (from `commands/*.md`). */
+export declare function listCommands(): Promise<string[]>;
+/** Names of the skills the plugin ships (directories under `skills/` that contain a `SKILL.md`). */
+export declare function listSkills(): Promise<string[]>;
+export interface ValidationIssue {
+    severity: "error" | "warning";
+    where: string;
+    message: string;
+}
+/** Validate the manifest's shape + content. Synchronous; no I/O beyond what the caller already did. */
+export declare function validateManifest(m: unknown): ValidationIssue[];
+/** Validate the whole plugin bundle. Cross-checks command names against the optional `knownCliCommands` list. */
+export declare function validatePluginBundle(opts?: {
+    knownCliCommands?: string[];
+}): Promise<ValidationIssue[]>;

package/dist/index.js

@@ -0,0 +1,193 @@
+// @docsxai/plugin — the Claude Code plugin (first-class invocation surface).
+//
+// The plugin itself is the markdown/JSON tree alongside this file:
+//   .claude-plugin/plugin.json   — manifest
+//   commands/*.md                — deterministic slash commands (thin wrappers over the `docsxai` CLI)
+//   skills/*/SKILL.md            — calibration skills (agent-driven; the host supplies inference)
+// This module is a small TS surface over that tree, for tooling/tests.
+import { promises as fs } from "node:fs";
+import * as path from "node:path";
+import { fileURLToPath } from "node:url";
+/** Absolute path to the plugin root (the directory containing `.claude-plugin/`). */
+export const pluginDir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
+/** Read and parse `.claude-plugin/plugin.json`. */
+export async function readManifest() {
+    const text = await fs.readFile(path.join(pluginDir, ".claude-plugin", "plugin.json"), "utf8");
+    return JSON.parse(text);
+}
+/** Names of the slash commands the plugin ships (from `commands/*.md`). */
+export async function listCommands() {
+    const entries = await fs.readdir(path.join(pluginDir, "commands")).catch(() => []);
+    return entries
+        .filter((e) => e.endsWith(".md"))
+        .map((e) => e.replace(/\.md$/, ""))
+        .sort();
+}
+/** Names of the skills the plugin ships (directories under `skills/` that contain a `SKILL.md`). */
+export async function listSkills() {
+    const entries = await fs
+        .readdir(path.join(pluginDir, "skills"), { withFileTypes: true })
+        .catch(() => []);
+    const out = [];
+    for (const e of entries) {
+        if (e.isDirectory()) {
+            const has = await fs
+                .access(path.join(pluginDir, "skills", e.name, "SKILL.md"))
+                .then(() => true)
+                .catch(() => false);
+            if (has)
+                out.push(e.name);
+        }
+    }
+    return out.sort();
+}
+/** Validate the manifest's shape + content. Synchronous; no I/O beyond what the caller already did. */
+export function validateManifest(m) {
+    const issues = [];
+    const where = ".claude-plugin/plugin.json";
+    if (typeof m !== "object" || m === null) {
+        return [{ severity: "error", where, message: "manifest must be an object" }];
+    }
+    const o = m;
+    if (typeof o.name !== "string" || o.name.length === 0) {
+        issues.push({ severity: "error", where, message: "missing or empty `name`" });
+    }
+    if (typeof o.version !== "string" || !/^\d+\.\d+\.\d+(?:-[\w.-]+)?$/.test(o.version)) {
+        issues.push({
+            severity: "error",
+            where,
+            message: `\`version\` must be semver (got ${JSON.stringify(o.version)})`,
+        });
+    }
+    if (typeof o.description !== "string" || o.description.length < 20) {
+        issues.push({
+            severity: "warning",
+            where,
+            message: "`description` is missing or under 20 chars",
+        });
+    }
+    if (o.homepage !== undefined) {
+        if (typeof o.homepage !== "string" || !/^https?:\/\//.test(o.homepage)) {
+            issues.push({ severity: "warning", where, message: "`homepage` should be an http(s) URL" });
+        }
+    }
+    if (o.author !== undefined) {
+        if (typeof o.author !== "object" ||
+            o.author === null ||
+            typeof o.author.name !== "string") {
+            issues.push({ severity: "warning", where, message: "`author` should be { name: string }" });
+        }
+    }
+    return issues;
+}
+/** Parse a `.md` file's leading `---` YAML-ish frontmatter into a `key: value` record (no nested parsing). */
+function parseFrontmatter(text) {
+    const m = /^---\n([\s\S]*?)\n---/.exec(text);
+    if (!m)
+        return null;
+    const out = {};
+    for (const line of m[1].split(/\n/)) {
+        const kv = /^(\w+):\s*(.+)$/.exec(line);
+        if (kv)
+            out[kv[1]] = kv[2].trim();
+    }
+    return out;
+}
+/** Validate the whole plugin bundle. Cross-checks command names against the optional `knownCliCommands` list. */
+export async function validatePluginBundle(opts = {}) {
+    const issues = [];
+    // Manifest
+    let manifest;
+    try {
+        manifest = await readManifest();
+    }
+    catch (e) {
+        return [
+            {
+                severity: "error",
+                where: ".claude-plugin/plugin.json",
+                message: `unreadable: ${e.message}`,
+            },
+        ];
+    }
+    issues.push(...validateManifest(manifest));
+    // Commands
+    const cmdNames = await listCommands();
+    if (cmdNames.length === 0) {
+        issues.push({ severity: "warning", where: "commands/", message: "no commands declared" });
+    }
+    const seenCmd = new Set();
+    for (const cmd of cmdNames) {
+        if (seenCmd.has(cmd)) {
+            issues.push({
+                severity: "error",
+                where: `commands/${cmd}.md`,
+                message: "duplicate command name",
+            });
+        }
+        seenCmd.add(cmd);
+        const file = path.join(pluginDir, "commands", `${cmd}.md`);
+        const text = await fs.readFile(file, "utf8");
+        const fm = parseFrontmatter(text);
+        if (!fm) {
+            issues.push({
+                severity: "error",
+                where: `commands/${cmd}.md`,
+                message: "missing YAML frontmatter (`--- … ---`)",
+            });
+            continue;
+        }
+        if (!fm.description || fm.description.length < 5) {
+            issues.push({
+                severity: "error",
+                where: `commands/${cmd}.md`,
+                message: "frontmatter `description:` missing or too short",
+            });
+        }
+        // Body should reference an underlying engine command of the same name (`docsxai <cmd>`).
+        const body = text.slice(text.indexOf("---", 3) + 3);
+        if (!new RegExp(`\\bdocsxai\\s+${cmd}\\b`).test(body)) {
+            issues.push({
+                severity: "warning",
+                where: `commands/${cmd}.md`,
+                message: `body doesn't appear to invoke \`docsxai ${cmd}\` — wrapper may be misaligned with the underlying CLI`,
+            });
+        }
+        if (opts.knownCliCommands && !opts.knownCliCommands.includes(cmd)) {
+            issues.push({
+                severity: "warning",
+                where: `commands/${cmd}.md`,
+                message: `\`docsxai ${cmd}\` isn't in the engine CLI surface (known: ${opts.knownCliCommands.join(", ")})`,
+            });
+        }
+    }
+    // Skills
+    for (const skill of await listSkills()) {
+        const file = path.join(pluginDir, "skills", skill, "SKILL.md");
+        const text = await fs.readFile(file, "utf8");
+        const fm = parseFrontmatter(text);
+        if (!fm) {
+            issues.push({
+                severity: "error",
+                where: `skills/${skill}/SKILL.md`,
+                message: "missing frontmatter",
+            });
+            continue;
+        }
+        if (!fm.name || fm.name.length === 0) {
+            issues.push({
+                severity: "error",
+                where: `skills/${skill}/SKILL.md`,
+                message: "frontmatter `name:` missing",
+            });
+        }
+        if (!fm.description || fm.description.length < 20) {
+            issues.push({
+                severity: "warning",
+                where: `skills/${skill}/SKILL.md`,
+                message: "frontmatter `description:` missing or under 20 chars",
+            });
+        }
+    }
+    return issues;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@docsxai/plugin",
+  "version": "0.2.0",
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "description": "Claude Code plugin — the first-class invocation surface. Calibration skills + deterministic commands + internal MCP registration.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kalebteccom/docsxai.git",
+    "directory": "packages/plugin"
+  },
+  "homepage": "https://github.com/kalebteccom/docsxai#readme",
+  "bugs": "https://github.com/kalebteccom/docsxai/issues",
+  "keywords": [
+    "docsxai",
+    "documentation",
+    "playwright",
+    "claude-code",
+    "agent"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.14.0",
+    "vitest": "^2.0.0"
+  },
+  "author": "Kalebtec <security@kalebtec.com>",
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "node ../../scripts/clean-dist.mjs && tsc -b tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests"
+  }
+}