@ankhorage/paradox 0.1.11 → 0.1.13

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.1.13
+
+### Patch Changes
+
+- df28363: Expose docs command surface metadata for Ankh discovery.
+
+## 0.1.12
+
+### Patch Changes
+
+- 088286e: Expose package-level surface metadata.
+
 ## 0.1.11
 
 ### Patch Changes

package/README.md

@@ -3,7 +3,7 @@
 
 # @ankhorage/paradox
 
-![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.11](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
+![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.13](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
 
 Deterministic documentation generator for TypeScript packages.
 

package/dist/docsSurface.d.ts

@@ -0,0 +1,20 @@
+declare const _default: {
+    id: string;
+    category: string;
+    version: string;
+    capabilities: string[];
+    commands: readonly [{
+        readonly path: readonly ["docs"];
+        readonly summary: "Generate package documentation.";
+        readonly capability: "docs.generate";
+    }, {
+        readonly path: readonly ["docs", "write"];
+        readonly summary: "Generate and write package documentation.";
+        readonly capability: "docs.generate";
+    }, {
+        readonly path: readonly ["docs", "check"];
+        readonly summary: "Check package documentation generation.";
+        readonly capability: "docs.check";
+    }];
+};
+export default _default;

package/dist/docsSurface.js

@@ -0,0 +1,26 @@
+const packageName = '@ankhorage/paradox';
+const packageVersion = '0.1.12';
+const commandList = [
+    {
+        path: ['docs'],
+        summary: 'Generate package documentation.',
+        capability: 'docs.generate',
+    },
+    {
+        path: ['docs', 'write'],
+        summary: 'Generate and write package documentation.',
+        capability: 'docs.generate',
+    },
+    {
+        path: ['docs', 'check'],
+        summary: 'Check package documentation generation.',
+        capability: 'docs.check',
+    },
+];
+export default {
+    id: packageName,
+    category: 'docs',
+    version: packageVersion,
+    capabilities: ['docs.generate', 'docs.check'],
+    commands: commandList,
+};

package/dist/packageMetadata.capabilities.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/packageMetadata.capabilities.test.js

@@ -0,0 +1,9 @@
+import { describe, expect, test } from 'bun:test';
+import { packageMetadata } from './packageMetadata.js';
+describe('package surfaces', () => {
+    test('lists four qualified package surfaces', () => {
+        expect(packageMetadata.category).toBe('paradox');
+        expect(packageMetadata.capabilities.length).toBe(4);
+        expect(packageMetadata.capabilities[0]).toBe('paradox.package');
+    });
+});

package/dist/packageMetadata.d.ts

@@ -1,4 +1,4 @@
 export declare const packageMetadata: {
     category: string;
-    capabilities: readonly ["package", "config", "model", "tags"];
+    capabilities: readonly ["paradox.package", "paradox.config", "paradox.model", "paradox.tags"];
 };

package/dist/packageMetadata.js

@@ -1,4 +1,4 @@
 export const packageMetadata = {
     category: 'paradox',
-    capabilities: ['package', 'config', 'model', 'tags'],
+    capabilities: ['paradox.package', 'paradox.config', 'paradox.model', 'paradox.tags'],
 };

package/dist/packageMetadata.test.js

@@ -1,8 +1,8 @@
 import { describe, expect, test } from 'bun:test';
-import { paradoxPackageMetadata } from './index.js';
-describe('package metadata', () => {
-    test('declares Paradox package boundary capabilities', () => {
-        expect(paradoxPackageMetadata.category).toBe('paradox');
-        expect(paradoxPackageMetadata.capabilities).toEqual(['package', 'config', 'model', 'tags']);
+import { packageMetadata } from './packageMetadata.js';
+describe('metadata', () => {
+    test('has a category and surfaces', () => {
+        expect(packageMetadata.category).toBe('paradox');
+        expect(packageMetadata.capabilities.length).toBeGreaterThan(0);
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/paradox",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "Deterministic documentation generator for TypeScript packages.",
   "license": "MIT",
   "publishConfig": {
@@ -41,6 +41,14 @@
   "bin": {
     "paradox": "./dist/cli.js"
   },
+  "ankh": {
+    "category": "docs",
+    "provider": "./dist/docsSurface.js",
+    "capabilities": [
+      "docs.generate",
+      "docs.check"
+    ]
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "changeset": "changeset",