@eventcatalog/sdk 2.11.0 → 2.12.0

package/dist/cli-docs.d.mts

@@ -0,0 +1,43 @@
+/**
+ * CLI Documentation Registry
+ *
+ * This file contains metadata for all SDK functions that can be called via the CLI.
+ * It is used to generate documentation for the EventCatalog website.
+ *
+ * @module cli-docs
+ */
+interface CLIFunctionArg {
+    name: string;
+    type: 'string' | 'json' | 'boolean' | 'number';
+    required: boolean;
+    description: string;
+}
+interface CLIFunctionExample {
+    description: string;
+    command: string;
+}
+interface CLIFunctionDoc {
+    name: string;
+    description: string;
+    category: string;
+    args: CLIFunctionArg[];
+    examples: CLIFunctionExample[];
+}
+/**
+ * All CLI-callable functions with their documentation
+ */
+declare const cliFunctions: CLIFunctionDoc[];
+/**
+ * Get all unique categories
+ */
+declare function getCategories(): string[];
+/**
+ * Get functions by category
+ */
+declare function getFunctionsByCategory(category: string): CLIFunctionDoc[];
+/**
+ * Get a function by name
+ */
+declare function getFunction(name: string): CLIFunctionDoc | undefined;
+
+export { type CLIFunctionArg, type CLIFunctionDoc, type CLIFunctionExample, cliFunctions, getCategories, getFunction, getFunctionsByCategory };

package/dist/cli-docs.d.ts

@@ -0,0 +1,43 @@
+/**
+ * CLI Documentation Registry
+ *
+ * This file contains metadata for all SDK functions that can be called via the CLI.
+ * It is used to generate documentation for the EventCatalog website.
+ *
+ * @module cli-docs
+ */
+interface CLIFunctionArg {
+    name: string;
+    type: 'string' | 'json' | 'boolean' | 'number';
+    required: boolean;
+    description: string;
+}
+interface CLIFunctionExample {
+    description: string;
+    command: string;
+}
+interface CLIFunctionDoc {
+    name: string;
+    description: string;
+    category: string;
+    args: CLIFunctionArg[];
+    examples: CLIFunctionExample[];
+}
+/**
+ * All CLI-callable functions with their documentation
+ */
+declare const cliFunctions: CLIFunctionDoc[];
+/**
+ * Get all unique categories
+ */
+declare function getCategories(): string[];
+/**
+ * Get functions by category
+ */
+declare function getFunctionsByCategory(category: string): CLIFunctionDoc[];
+/**
+ * Get a function by name
+ */
+declare function getFunction(name: string): CLIFunctionDoc | undefined;
+
+export { type CLIFunctionArg, type CLIFunctionDoc, type CLIFunctionExample, cliFunctions, getCategories, getFunction, getFunctionsByCategory };