@eventcatalog/sdk 2.12.1 → 2.13.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/package.json +6 -6
- package/dist/cli/index.d.mts +0 -1
- package/dist/cli/index.d.ts +0 -1
- package/dist/cli/index.js +0 -2569
- package/dist/cli/index.js.map +0 -1
- package/dist/cli/index.mjs +0 -2553
- package/dist/cli/index.mjs.map +0 -1
- package/dist/cli-docs.d.mts +0 -43
- package/dist/cli-docs.d.ts +0 -43
- package/dist/cli-docs.js +0 -1614
- package/dist/cli-docs.js.map +0 -1
- package/dist/cli-docs.mjs +0 -1586
- package/dist/cli-docs.mjs.map +0 -1
- package/dist/index.d.mts +0 -1714
- package/dist/index.d.ts +0 -1714
- package/dist/index.js +0 -2434
- package/dist/index.js.map +0 -1
- package/dist/index.mjs +0 -2403
- package/dist/index.mjs.map +0 -1
package/dist/cli-docs.d.mts
DELETED
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* CLI Documentation Registry
|
|
3
|
-
*
|
|
4
|
-
* This file contains metadata for all SDK functions that can be called via the CLI.
|
|
5
|
-
* It is used to generate documentation for the EventCatalog website.
|
|
6
|
-
*
|
|
7
|
-
* @module cli-docs
|
|
8
|
-
*/
|
|
9
|
-
interface CLIFunctionArg {
|
|
10
|
-
name: string;
|
|
11
|
-
type: 'string' | 'json' | 'boolean' | 'number';
|
|
12
|
-
required: boolean;
|
|
13
|
-
description: string;
|
|
14
|
-
}
|
|
15
|
-
interface CLIFunctionExample {
|
|
16
|
-
description: string;
|
|
17
|
-
command: string;
|
|
18
|
-
}
|
|
19
|
-
interface CLIFunctionDoc {
|
|
20
|
-
name: string;
|
|
21
|
-
description: string;
|
|
22
|
-
category: string;
|
|
23
|
-
args: CLIFunctionArg[];
|
|
24
|
-
examples: CLIFunctionExample[];
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* All CLI-callable functions with their documentation
|
|
28
|
-
*/
|
|
29
|
-
declare const cliFunctions: CLIFunctionDoc[];
|
|
30
|
-
/**
|
|
31
|
-
* Get all unique categories
|
|
32
|
-
*/
|
|
33
|
-
declare function getCategories(): string[];
|
|
34
|
-
/**
|
|
35
|
-
* Get functions by category
|
|
36
|
-
*/
|
|
37
|
-
declare function getFunctionsByCategory(category: string): CLIFunctionDoc[];
|
|
38
|
-
/**
|
|
39
|
-
* Get a function by name
|
|
40
|
-
*/
|
|
41
|
-
declare function getFunction(name: string): CLIFunctionDoc | undefined;
|
|
42
|
-
|
|
43
|
-
export { type CLIFunctionArg, type CLIFunctionDoc, type CLIFunctionExample, cliFunctions, getCategories, getFunction, getFunctionsByCategory };
|
package/dist/cli-docs.d.ts
DELETED
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* CLI Documentation Registry
|
|
3
|
-
*
|
|
4
|
-
* This file contains metadata for all SDK functions that can be called via the CLI.
|
|
5
|
-
* It is used to generate documentation for the EventCatalog website.
|
|
6
|
-
*
|
|
7
|
-
* @module cli-docs
|
|
8
|
-
*/
|
|
9
|
-
interface CLIFunctionArg {
|
|
10
|
-
name: string;
|
|
11
|
-
type: 'string' | 'json' | 'boolean' | 'number';
|
|
12
|
-
required: boolean;
|
|
13
|
-
description: string;
|
|
14
|
-
}
|
|
15
|
-
interface CLIFunctionExample {
|
|
16
|
-
description: string;
|
|
17
|
-
command: string;
|
|
18
|
-
}
|
|
19
|
-
interface CLIFunctionDoc {
|
|
20
|
-
name: string;
|
|
21
|
-
description: string;
|
|
22
|
-
category: string;
|
|
23
|
-
args: CLIFunctionArg[];
|
|
24
|
-
examples: CLIFunctionExample[];
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* All CLI-callable functions with their documentation
|
|
28
|
-
*/
|
|
29
|
-
declare const cliFunctions: CLIFunctionDoc[];
|
|
30
|
-
/**
|
|
31
|
-
* Get all unique categories
|
|
32
|
-
*/
|
|
33
|
-
declare function getCategories(): string[];
|
|
34
|
-
/**
|
|
35
|
-
* Get functions by category
|
|
36
|
-
*/
|
|
37
|
-
declare function getFunctionsByCategory(category: string): CLIFunctionDoc[];
|
|
38
|
-
/**
|
|
39
|
-
* Get a function by name
|
|
40
|
-
*/
|
|
41
|
-
declare function getFunction(name: string): CLIFunctionDoc | undefined;
|
|
42
|
-
|
|
43
|
-
export { type CLIFunctionArg, type CLIFunctionDoc, type CLIFunctionExample, cliFunctions, getCategories, getFunction, getFunctionsByCategory };
|