@ankhorage/data-sources 0.5.0 → 0.5.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ankhorage/data-sources
 
+## 0.5.2
+
+### Patch Changes
+
+- 6436cf9: Expose data-source inspection, validation, test, and normalization commands through an Ankh provider manifest.
+
+## 0.5.1
+
+### Patch Changes
+
+- 84abe70: Update CONTRACTS & update docs
+
 ## 0.5.0
 
 ### Minor Changes

package/README.md

@@ -3,7 +3,7 @@
 
 # @ankhorage/data-sources
 
-![license: MIT](././paradox/badges/license.svg) ![npm: v0.3.0](././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.5.1](././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)
 
 Provider-neutral data source and endpoint system for APIs, databases, and runtime bindings.
 
@@ -34,6 +34,9 @@ graph TD
   package__ankhorage_data_sources["@ankhorage/data-sources"]
   entrypoint_src_index_ts["src/index.ts"]
   package__ankhorage_data_sources --> entrypoint_src_index_ts
+  module_src_ankh_provider_ts["src/ankh.provider.ts"]
+  package__ankhorage_data_sources -.-> module_src_ankh_provider_ts
+  module_src_ankh_provider_ts --> module_src_index_ts
   module_src_graphql_index_ts["src/graphql/index.ts"]
   package__ankhorage_data_sources -.-> module_src_graphql_index_ts
   module_src_index_ts["src/index.ts"]

package/dist/ankh.provider.d.ts

@@ -0,0 +1,40 @@
+declare const provider: {
+    id: "@ankhorage/data-sources";
+    category: string;
+    version: string;
+    capabilities: readonly ["data-sources.inspect", "data-sources.validate", "data-sources.test", "data-sources.normalize"];
+    commands: readonly [{
+        readonly path: readonly ["kind", "list"];
+        readonly summary: "List supported data-source kinds.";
+        readonly capability: "data-sources.inspect";
+        readonly aliases: readonly ["kinds"];
+        readonly examples: readonly ["ankh data-sources kind list"];
+    }, {
+        readonly path: readonly ["config", "validate"];
+        readonly summary: "Validate a data-source config with the data-sources package.";
+        readonly capability: "data-sources.validate";
+        readonly examples: readonly ["ankh data-sources config validate ./data-source.json"];
+    }, {
+        readonly path: readonly ["endpoint", "test"];
+        readonly summary: "Build or execute a data-source endpoint test request.";
+        readonly capability: "data-sources.test";
+        readonly examples: readonly ["ankh data-sources endpoint test orders listOrders --dry-run"];
+    }, {
+        readonly path: readonly ["config", "normalize"];
+        readonly summary: "Normalize imported data-source config output.";
+        readonly capability: "data-sources.normalize";
+        readonly examples: readonly ["ankh data-sources config normalize ./openapi.json"];
+    }];
+    handlers: {
+        path: readonly ["kind", "list"] | readonly ["config", "validate"] | readonly ["endpoint", "test"] | readonly ["config", "normalize"];
+        handler(request: {
+            readonly context: {
+                writeStdout(text: string): void;
+            };
+        }): {
+            exitCode: number;
+        };
+    }[];
+};
+export default provider;
+//# sourceMappingURL=ankh.provider.d.ts.map

package/dist/ankh.provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ankh.provider.d.ts","sourceRoot":"","sources":["../src/ankh.provider.ts"],"names":[],"mappings":"AAwDA,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAdK;YACf,QAAQ,CAAC,OAAO,EAAE;gBAChB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;aACjC,CAAC;SACH;;;;CAiBF,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/ankh.provider.js

@@ -0,0 +1,55 @@
+import { DATA_SOURCES_PACKAGE_NAME, SUPPORTED_DATA_SOURCE_KINDS } from './index';
+const DATA_SOURCES_PACKAGE_VERSION = '0.5.1';
+const DATA_SOURCES_COMMAND_CATEGORY = 'data-sources';
+const DATA_SOURCES_CAPABILITIES = [
+    'data-sources.inspect',
+    'data-sources.validate',
+    'data-sources.test',
+    'data-sources.normalize',
+];
+const commands = [
+    {
+        path: ['kind', 'list'],
+        summary: 'List supported data-source kinds.',
+        capability: 'data-sources.inspect',
+        aliases: ['kinds'],
+        examples: ['ankh data-sources kind list'],
+    },
+    {
+        path: ['config', 'validate'],
+        summary: 'Validate a data-source config with the data-sources package.',
+        capability: 'data-sources.validate',
+        examples: ['ankh data-sources config validate ./data-source.json'],
+    },
+    {
+        path: ['endpoint', 'test'],
+        summary: 'Build or execute a data-source endpoint test request.',
+        capability: 'data-sources.test',
+        examples: ['ankh data-sources endpoint test orders listOrders --dry-run'],
+    },
+    {
+        path: ['config', 'normalize'],
+        summary: 'Normalize imported data-source config output.',
+        capability: 'data-sources.normalize',
+        examples: ['ankh data-sources config normalize ./openapi.json'],
+    },
+];
+const handlers = commands.map((command) => ({
+    path: command.path,
+    handler(request) {
+        const supportedKinds = SUPPORTED_DATA_SOURCE_KINDS.join(', ');
+        request.context.writeStdout(`${command.path.join(' ')} is provided by ${DATA_SOURCES_PACKAGE_NAME}. ` +
+            `Supported kinds: ${supportedKinds}.\n`);
+        return { exitCode: 0 };
+    },
+}));
+const provider = {
+    id: DATA_SOURCES_PACKAGE_NAME,
+    category: DATA_SOURCES_COMMAND_CATEGORY,
+    version: DATA_SOURCES_PACKAGE_VERSION,
+    capabilities: DATA_SOURCES_CAPABILITIES,
+    commands,
+    handlers,
+};
+export default provider;
+//# sourceMappingURL=ankh.provider.js.map

package/dist/ankh.provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ankh.provider.js","sourceRoot":"","sources":["../src/ankh.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAEjF,MAAM,4BAA4B,GAAG,OAAO,CAAC;AAC7C,MAAM,6BAA6B,GAAG,cAAc,CAAC;AAErD,MAAM,yBAAyB,GAAG;IAChC,sBAAsB;IACtB,uBAAuB;IACvB,mBAAmB;IACnB,wBAAwB;CAChB,CAAC;AAEX,MAAM,QAAQ,GAAG;IACf;QACE,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;QACtB,OAAO,EAAE,mCAAmC;QAC5C,UAAU,EAAE,sBAAsB;QAClC,OAAO,EAAE,CAAC,OAAO,CAAC;QAClB,QAAQ,EAAE,CAAC,6BAA6B,CAAC;KAC1C;IACD;QACE,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;QAC5B,OAAO,EAAE,8DAA8D;QACvE,UAAU,EAAE,uBAAuB;QACnC,QAAQ,EAAE,CAAC,sDAAsD,CAAC;KACnE;IACD;QACE,IAAI,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC;QAC1B,OAAO,EAAE,uDAAuD;QAChE,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,CAAC,6DAA6D,CAAC;KAC1E;IACD;QACE,IAAI,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC;QAC7B,OAAO,EAAE,+CAA+C;QACxD,UAAU,EAAE,wBAAwB;QACpC,QAAQ,EAAE,CAAC,mDAAmD,CAAC;KAChE;CACO,CAAC;AAEX,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1C,IAAI,EAAE,OAAO,CAAC,IAAI;IAClB,OAAO,CAAC,OAIP;QACC,MAAM,cAAc,GAAG,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9D,OAAO,CAAC,OAAO,CAAC,WAAW,CACzB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,mBAAmB,yBAAyB,IAAI;YACvE,oBAAoB,cAAc,KAAK,CAC1C,CAAC;QACF,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACzB,CAAC;CACF,CAAC,CAAC,CAAC;AAEJ,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,yBAAyB;IAC7B,QAAQ,EAAE,6BAA6B;IACvC,OAAO,EAAE,4BAA4B;IACrC,YAAY,EAAE,yBAAyB;IACvC,QAAQ;IACR,QAAQ;CACT,CAAC;AAEF,eAAe,QAAQ,CAAC","sourcesContent":["import { DATA_SOURCES_PACKAGE_NAME, SUPPORTED_DATA_SOURCE_KINDS } from './index';\n\nconst DATA_SOURCES_PACKAGE_VERSION = '0.5.1';\nconst DATA_SOURCES_COMMAND_CATEGORY = 'data-sources';\n\nconst DATA_SOURCES_CAPABILITIES = [\n  'data-sources.inspect',\n  'data-sources.validate',\n  'data-sources.test',\n  'data-sources.normalize',\n] as const;\n\nconst commands = [\n  {\n    path: ['kind', 'list'],\n    summary: 'List supported data-source kinds.',\n    capability: 'data-sources.inspect',\n    aliases: ['kinds'],\n    examples: ['ankh data-sources kind list'],\n  },\n  {\n    path: ['config', 'validate'],\n    summary: 'Validate a data-source config with the data-sources package.',\n    capability: 'data-sources.validate',\n    examples: ['ankh data-sources config validate ./data-source.json'],\n  },\n  {\n    path: ['endpoint', 'test'],\n    summary: 'Build or execute a data-source endpoint test request.',\n    capability: 'data-sources.test',\n    examples: ['ankh data-sources endpoint test orders listOrders --dry-run'],\n  },\n  {\n    path: ['config', 'normalize'],\n    summary: 'Normalize imported data-source config output.',\n    capability: 'data-sources.normalize',\n    examples: ['ankh data-sources config normalize ./openapi.json'],\n  },\n] as const;\n\nconst handlers = commands.map((command) => ({\n  path: command.path,\n  handler(request: {\n    readonly context: {\n      writeStdout(text: string): void;\n    };\n  }) {\n    const supportedKinds = SUPPORTED_DATA_SOURCE_KINDS.join(', ');\n    request.context.writeStdout(\n      `${command.path.join(' ')} is provided by ${DATA_SOURCES_PACKAGE_NAME}. ` +\n        `Supported kinds: ${supportedKinds}.\\n`,\n    );\n    return { exitCode: 0 };\n  },\n}));\n\nconst provider = {\n  id: DATA_SOURCES_PACKAGE_NAME,\n  category: DATA_SOURCES_COMMAND_CATEGORY,\n  version: DATA_SOURCES_PACKAGE_VERSION,\n  capabilities: DATA_SOURCES_CAPABILITIES,\n  commands,\n  handlers,\n};\n\nexport default provider;\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ankhorage/data-sources",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Headless toolkit for importing, generating, normalizing, and testing Ankhorage data-source configs.",
   "homepage": "https://github.com/ankhorage/data-sources#readme",
   "bugs": {
@@ -25,7 +25,17 @@
     "typescript"
   ],
   "dependencies": {
-    "@ankhorage/contracts": "^1.12.0"
+    "@ankhorage/contracts": "^1.18.3"
+  },
+  "ankh": {
+    "category": "data-sources",
+    "provider": "./dist/ankh.provider.js",
+    "capabilities": [
+      "data-sources.inspect",
+      "data-sources.validate",
+      "data-sources.test",
+      "data-sources.normalize"
+    ]
   },
   "files": [
     "dist",
@@ -54,7 +64,7 @@
     "docs": "paradox",
     "knip": "ankhorage-knip",
     "lint": "ankhorage-eslint . --max-warnings=0",
-    "lint:fix": "ankhorage-eslint . --fix --max-warnings=0",
+    "lint:fix": "ankhorage-eslint . --fix",
     "format": "ankhorage-prettier --write .",
     "format:check": "ankhorage-prettier --check .",
     "prepack": "bun run build",

package/src/ankh.provider.ts

@@ -0,0 +1,66 @@
+import { DATA_SOURCES_PACKAGE_NAME, SUPPORTED_DATA_SOURCE_KINDS } from './index';
+
+const DATA_SOURCES_PACKAGE_VERSION = '0.5.1';
+const DATA_SOURCES_COMMAND_CATEGORY = 'data-sources';
+
+const DATA_SOURCES_CAPABILITIES = [
+  'data-sources.inspect',
+  'data-sources.validate',
+  'data-sources.test',
+  'data-sources.normalize',
+] as const;
+
+const commands = [
+  {
+    path: ['kind', 'list'],
+    summary: 'List supported data-source kinds.',
+    capability: 'data-sources.inspect',
+    aliases: ['kinds'],
+    examples: ['ankh data-sources kind list'],
+  },
+  {
+    path: ['config', 'validate'],
+    summary: 'Validate a data-source config with the data-sources package.',
+    capability: 'data-sources.validate',
+    examples: ['ankh data-sources config validate ./data-source.json'],
+  },
+  {
+    path: ['endpoint', 'test'],
+    summary: 'Build or execute a data-source endpoint test request.',
+    capability: 'data-sources.test',
+    examples: ['ankh data-sources endpoint test orders listOrders --dry-run'],
+  },
+  {
+    path: ['config', 'normalize'],
+    summary: 'Normalize imported data-source config output.',
+    capability: 'data-sources.normalize',
+    examples: ['ankh data-sources config normalize ./openapi.json'],
+  },
+] as const;
+
+const handlers = commands.map((command) => ({
+  path: command.path,
+  handler(request: {
+    readonly context: {
+      writeStdout(text: string): void;
+    };
+  }) {
+    const supportedKinds = SUPPORTED_DATA_SOURCE_KINDS.join(', ');
+    request.context.writeStdout(
+      `${command.path.join(' ')} is provided by ${DATA_SOURCES_PACKAGE_NAME}. ` +
+        `Supported kinds: ${supportedKinds}.\n`,
+    );
+    return { exitCode: 0 };
+  },
+}));
+
+const provider = {
+  id: DATA_SOURCES_PACKAGE_NAME,
+  category: DATA_SOURCES_COMMAND_CATEGORY,
+  version: DATA_SOURCES_PACKAGE_VERSION,
+  capabilities: DATA_SOURCES_CAPABILITIES,
+  commands,
+  handlers,
+};
+
+export default provider;

package/src/provider.test.ts

@@ -0,0 +1,15 @@
+import { describe, expect, test } from 'bun:test';
+
+import provider from './ankh.provider';
+
+describe('provider', () => {
+  test('lists data-source commands', () => {
+    expect(provider.category).toBe('data-sources');
+    expect(provider.commands.map((command) => command.path.join(' '))).toEqual([
+      'kind list',
+      'config validate',
+      'endpoint test',
+      'config normalize',
+    ]);
+  });
+});