@ankhorage/contracts 7.8.0 → 7.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +1 -1
- package/dist/cli/index.d.ts +6 -1
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js.map +1 -1
- package/package.json +1 -1
- package/src/cli/index.ts +6 -1
- package/src/cli.test.ts +20 -0
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
# CONTRACTS
|
|
5
5
|
|
|
6
|
-
         
|
|
7
7
|
|
|
8
8
|
Serializable app, action, theme, auth, and secret-store contracts for Ankhorage.
|
|
9
9
|
|
package/dist/cli/index.d.ts
CHANGED
|
@@ -2,7 +2,12 @@ export type AnkhCommandCategory = string;
|
|
|
2
2
|
export type AnkhProviderReference = `./${string}`;
|
|
3
3
|
export type AnkhCapabilityId = `${string}.${string}`;
|
|
4
4
|
export interface AnkhCommandDescriptor {
|
|
5
|
-
|
|
5
|
+
/**
|
|
6
|
+
* Command path relative to the provider category.
|
|
7
|
+
*
|
|
8
|
+
* An empty path declares the command at the category root.
|
|
9
|
+
*/
|
|
10
|
+
readonly path: readonly string[];
|
|
6
11
|
readonly summary: string;
|
|
7
12
|
readonly capability: AnkhCapabilityId;
|
|
8
13
|
readonly aliases?: readonly string[];
|
package/dist/cli/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC,MAAM,MAAM,qBAAqB,GAAG,KAAK,MAAM,EAAE,CAAC;AAElD,MAAM,MAAM,gBAAgB,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAErD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,SAAS,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC,MAAM,MAAM,qBAAqB,GAAG,KAAK,MAAM,EAAE,CAAC;AAElD,MAAM,MAAM,gBAAgB,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAErD,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;IACtC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnD,QAAQ,CAAC,QAAQ,EAAE,SAAS,qBAAqB,EAAE,CAAC;CACrD;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IACvC,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAChD,QAAQ,CAAC,YAAY,EAAE,SAAS,gBAAgB,EAAE,CAAC;CACpD"}
|
package/dist/cli/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"","sourcesContent":["export type AnkhCommandCategory = string;\n\nexport type AnkhProviderReference = `./${string}`;\n\nexport type AnkhCapabilityId = `${string}.${string}`;\n\nexport interface AnkhCommandDescriptor {\n readonly path: readonly
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"","sourcesContent":["export type AnkhCommandCategory = string;\n\nexport type AnkhProviderReference = `./${string}`;\n\nexport type AnkhCapabilityId = `${string}.${string}`;\n\nexport interface AnkhCommandDescriptor {\n /**\n * Command path relative to the provider category.\n *\n * An empty path declares the command at the category root.\n */\n readonly path: readonly string[];\n readonly summary: string;\n readonly capability: AnkhCapabilityId;\n readonly aliases?: readonly string[];\n readonly examples?: readonly string[];\n}\n\nexport interface AnkhCommandProviderManifest {\n readonly id: string;\n readonly category: AnkhCommandCategory;\n readonly version: string;\n readonly capabilities: readonly AnkhCapabilityId[];\n readonly commands: readonly AnkhCommandDescriptor[];\n}\n\nexport interface AnkhPackageMetadata {\n readonly category: AnkhCommandCategory;\n readonly provider: AnkhProviderReference | null;\n readonly capabilities: readonly AnkhCapabilityId[];\n}\n"]}
|
package/package.json
CHANGED
package/src/cli/index.ts
CHANGED
|
@@ -5,7 +5,12 @@ export type AnkhProviderReference = `./${string}`;
|
|
|
5
5
|
export type AnkhCapabilityId = `${string}.${string}`;
|
|
6
6
|
|
|
7
7
|
export interface AnkhCommandDescriptor {
|
|
8
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Command path relative to the provider category.
|
|
10
|
+
*
|
|
11
|
+
* An empty path declares the command at the category root.
|
|
12
|
+
*/
|
|
13
|
+
readonly path: readonly string[];
|
|
9
14
|
readonly summary: string;
|
|
10
15
|
readonly capability: AnkhCapabilityId;
|
|
11
16
|
readonly aliases?: readonly string[];
|
package/src/cli.test.ts
CHANGED
|
@@ -38,6 +38,26 @@ describe('cli contracts', () => {
|
|
|
38
38
|
expect(manifest.commands[0].path).toEqual(['up']);
|
|
39
39
|
});
|
|
40
40
|
|
|
41
|
+
it('accepts an empty path as a category-root command', () => {
|
|
42
|
+
const deployCommand = {
|
|
43
|
+
path: [],
|
|
44
|
+
summary: 'Deploy the authored release',
|
|
45
|
+
capability: 'deploy.release',
|
|
46
|
+
examples: ['ankh deploy'],
|
|
47
|
+
} as const satisfies AnkhCommandDescriptor;
|
|
48
|
+
|
|
49
|
+
const manifest = {
|
|
50
|
+
id: '@ankhorage/deploy',
|
|
51
|
+
category: 'deploy',
|
|
52
|
+
version: '1.0.0',
|
|
53
|
+
capabilities: ['deploy.release'],
|
|
54
|
+
commands: [deployCommand],
|
|
55
|
+
} as const satisfies AnkhCommandProviderManifest;
|
|
56
|
+
|
|
57
|
+
expect(manifest.commands[0].path).toEqual([]);
|
|
58
|
+
expect(JSON.parse(JSON.stringify(manifest))).toEqual(manifest);
|
|
59
|
+
});
|
|
60
|
+
|
|
41
61
|
it('accepts metadata-only packages without a provider module', () => {
|
|
42
62
|
const packageMetadata = {
|
|
43
63
|
category: 'contracts',
|