@trayio/cdk-cli 5.11.0 → 5.13.0-unstable

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @trayio/cdk-cli
 $ tray-cdk COMMAND
 running command...
 $ tray-cdk (--version|-v)
-@trayio/cdk-cli/5.11.0 linux-x64 node-v18.20.8
+@trayio/cdk-cli/5.13.0-unstable linux-x64 node-v18.20.8
 $ tray-cdk --help [COMMAND]
 USAGE
   $ tray-cdk COMMAND
@@ -32,6 +32,7 @@ USAGE
 <!-- commands -->
 * [`tray-cdk .`](#tray-cdk-)
 * [`tray-cdk autocomplete [SHELL]`](#tray-cdk-autocomplete-shell)
+* [`tray-cdk connector add-dynamic-output-schema OPERATIONNAME`](#tray-cdk-connector-add-dynamic-output-schema-operationname)
 * [`tray-cdk connector add-operation [OPERATIONNAME] [OPERATIONTYPE]`](#tray-cdk-connector-add-operation-operationname-operationtype)
 * [`tray-cdk connector build`](#tray-cdk-connector-build)
 * [`tray-cdk connector import [OPENAPISPEC] [CONNECTORNAME]`](#tray-cdk-connector-import-openapispec-connectorname)
@@ -96,6 +97,26 @@ EXAMPLES
 
 _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.5/src/commands/autocomplete/index.ts)_
 
+## `tray-cdk connector add-dynamic-output-schema OPERATIONNAME`
+
+Add a dynamic output schema operation for an existing operation
+
+```
+USAGE
+  $ tray-cdk connector add-dynamic-output-schema OPERATIONNAME
+
+ARGUMENTS
+  OPERATIONNAME  Name of the parent operation to add dynamic output schema for
+
+DESCRIPTION
+  Add a dynamic output schema operation for an existing operation
+
+EXAMPLES
+  $ tray-cdk connector add-dynamic-output-schema get_posts
+
+  $ tray-cdk connector add-dynamic-output-schema fetch_user_data
+```
+
 ## `tray-cdk connector add-operation [OPERATIONNAME] [OPERATIONTYPE]`
 
 Add an operation to connector project

package/dist/commands/connector/add-dynamic-output-schema.d.ts

@@ -0,0 +1,11 @@
+import { Command } from '@oclif/core';
+export default class AddDynamicOutputSchema extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        operationName: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+    private findSrcDirectory;
+}
+//# sourceMappingURL=add-dynamic-output-schema.d.ts.map

package/dist/commands/connector/add-dynamic-output-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-dynamic-output-schema.d.ts","sourceRoot":"","sources":["../../../src/commands/connector/add-dynamic-output-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAQ,MAAM,aAAa,CAAC;AAS5C,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,OAAO;IAC1D,MAAM,CAAC,WAAW,SACiD;IAEnE,MAAM,CAAC,QAAQ,WAGb;IAEF,MAAM,CAAC,IAAI;;MAOT;IAEI,GAAG;IA+PT,OAAO,CAAC,gBAAgB;CAOxB"}

package/dist/commands/connector/add-dynamic-output-schema.js

@@ -0,0 +1,243 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const fse = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const StringExtensions_1 = require("@trayio/commons/string/StringExtensions");
+const colorizeString_1 = require("@trayio/cdk-cli-commons/utils/colorizeString");
+class AddDynamicOutputSchema extends core_1.Command {
+    static description = 'Add a dynamic output schema operation for an existing operation';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> get_posts',
+        '<%= config.bin %> <%= command.id %> fetch_user_data',
+    ];
+    static args = {
+        operationName: core_1.Args.string({
+            name: 'operationName',
+            required: true,
+            description: 'Name of the parent operation to add dynamic output schema for',
+        }),
+    };
+    async run() {
+        const { args } = await this.parse(AddDynamicOutputSchema);
+        const { operationName } = args;
+        const currentDirectory = process.cwd();
+        const srcDir = this.findSrcDirectory(currentDirectory);
+        // Validate parent operation exists
+        const parentOperationPath = path.join(srcDir, operationName);
+        if (!fse.existsSync(parentOperationPath)) {
+            this.error((0, colorizeString_1.error)(`Operation '${operationName}' not found in src/ directory.\nMake sure you're in the connector root or src/ directory.`));
+        }
+        const parentOperationJsonPath = path.join(parentOperationPath, 'operation.json');
+        if (!fse.existsSync(parentOperationJsonPath)) {
+            this.error((0, colorizeString_1.error)(`Operation '${operationName}' exists but missing operation.json file.`));
+        }
+        this.log(`Checking for operation '${operationName}'... ✓`);
+        // Check if dynamic output schema operation already exists
+        const outputSchemaOpName = `${operationName}_output_schema`;
+        const outputSchemaOpPath = path.join(srcDir, outputSchemaOpName);
+        if (fse.existsSync(outputSchemaOpPath)) {
+            this.error((0, colorizeString_1.error)(`Dynamic output schema operation '${outputSchemaOpName}' already exists!`));
+        }
+        // Read parent operation.json
+        const parentOperationJson = await fse.readJson(parentOperationJsonPath);
+        // Get connector name to construct auth file name (matches add-operation pattern)
+        const connectorJsonPath = path.join(path.dirname(srcDir), 'connector.json');
+        let connectorNamePascalCase = 'MyConnector';
+        let authFileName = 'Authentication';
+        let authType = 'NoAuth';
+        try {
+            const connectorJson = await fse.readJson(connectorJsonPath);
+            connectorNamePascalCase = StringExtensions_1.StringExtensions.pascalCase(connectorJson.name);
+            // Check for {ConnectorName}Auth.ts pattern (standard pattern)
+            const standardAuthFile = `${connectorNamePascalCase}Auth.ts`;
+            const standardAuthPath = path.join(srcDir, standardAuthFile);
+            if (fse.existsSync(standardAuthPath)) {
+                authFileName = standardAuthFile.replace('.ts', '');
+                authType = `${connectorNamePascalCase}Auth`;
+            }
+            else {
+                // Fall back to other common patterns
+                const authFiles = ['Authentication.ts', 'Auth.ts'];
+                const foundAuthFile = authFiles.find((file) => {
+                    const authPath = path.join(srcDir, file);
+                    return fse.existsSync(authPath);
+                });
+                if (foundAuthFile) {
+                    authFileName = foundAuthFile.replace('.ts', '');
+                    // Try to read and extract auth type name
+                    const authContent = await fse.readFile(path.join(srcDir, foundAuthFile), 'utf-8');
+                    const typeMatch = authContent.match(/export\s+type\s+(\w+)/);
+                    if (typeMatch) {
+                        [, authType] = typeMatch;
+                    }
+                }
+            }
+        }
+        catch (e) {
+            // If we can't read connector.json, use defaults
+            this.warn('Could not read connector.json, using default auth type. Auth import may need manual adjustment.');
+        }
+        this.log(`Creating dynamic output schema operation '${outputSchemaOpName}'...`);
+        // Create operation folder
+        await fse.ensureDir(outputSchemaOpPath);
+        this.log('  ✓ Created operation folder');
+        // Generate names
+        const parentOpNamePascalCase = StringExtensions_1.StringExtensions.pascalCase(operationName);
+        const outputSchemaOpNamePascalCase = StringExtensions_1.StringExtensions.pascalCase(outputSchemaOpName);
+        const parentOpNameCamelCase = operationName
+            .split('_')
+            .map((word, i) => i === 0 ? word : word.charAt(0).toUpperCase() + word.slice(1))
+            .join('');
+        const outputSchemaOpNameCamelCase = outputSchemaOpName
+            .split('_')
+            .map((word, i) => i === 0 ? word : word.charAt(0).toUpperCase() + word.slice(1))
+            .join('');
+        // 1. Generate operation.json
+        const operationJson = {
+            name: outputSchemaOpName,
+            title: `${StringExtensions_1.StringExtensions.titleCase(operationName)} Output Schema`,
+            description: `Dynamic output schema generator for ${operationName} (private operation)`,
+            isPrivate: true,
+        };
+        await fse.writeJson(path.join(outputSchemaOpPath, 'operation.json'), operationJson, { spaces: 2 });
+        this.log('  ✓ Generated operation.json');
+        // 2. Generate input.ts (re-export from parent)
+        const inputTsContent = `export type { ${parentOpNamePascalCase}Input as ${outputSchemaOpNamePascalCase}Input } from '../${operationName}/input';
+`;
+        await fse.writeFile(path.join(outputSchemaOpPath, 'input.ts'), inputTsContent);
+        this.log('  ✓ Generated input.ts');
+        // 3. Generate output.ts
+        const outputTsContent = `import { DynamicOutput } from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+
+export type ${outputSchemaOpNamePascalCase}Output = DynamicOutput;
+`;
+        await fse.writeFile(path.join(outputSchemaOpPath, 'output.ts'), outputTsContent);
+        this.log('  ✓ Generated output.ts');
+        // 4. Generate handler.ts from template
+        const handlerTsContent = `import { OperationHandlerSetup } from '@trayio/cdk-dsl/connector/operation/OperationHandlerSetup';
+import {
+	OperationHandlerResult,
+	DynamicOutput,
+} from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+import { JsonSchemaIntrospector } from '@trayio/commons/schema/JsonSchemaIntrospector';
+import { ${parentOpNamePascalCase}Input } from '../${operationName}/input';
+import { ${authType} } from '../${authFileName}';
+import { ${parentOpNameCamelCase}Handler } from '../${operationName}/handler';
+
+/**
+ * Dynamic output schema handler for ${operationName}
+ * 
+ * This handler generates a JSON Schema by introspecting actual API responses.
+ * Customize the data-fetching logic below for your specific use case.
+ */
+export const ${outputSchemaOpNameCamelCase}Handler =
+	OperationHandlerSetup.configureDynamicOutputHandler<
+		${authType},
+		${parentOpNamePascalCase}Input
+	>((handler) =>
+		handler.usingComposite(async (ctx, input, invoke) => {
+			try {
+				// TODO: Customize this logic for your use case
+				
+				// Option 1: Invoke the main operation (ONLY for read-only GET operations!)
+				const result = await invoke(${parentOpNameCamelCase}Handler)(input);
+				
+				// Option 2: Call a metadata/schema endpoint instead
+				// const result = await invoke(getSchemaMetadataHandler)(input);
+				
+				// Option 3: Compute schema without API calls
+				// const schema = computeSchemaBasedOnInput(input);
+				// return OperationHandlerResult.success<DynamicOutput>({ output_schema: schema });
+				
+				if (result.isFailure) {
+					// Return generic fallback schema on error
+					return OperationHandlerResult.success<DynamicOutput>({
+						output_schema: {
+							type: 'object',
+							additionalProperties: true,
+							description: 'Generic schema - operation failed',
+						},
+					});
+				}
+
+				// Use the standard JsonSchemaIntrospector utility to convert response to JSON Schema
+				const schema = JsonSchemaIntrospector.introspectToJsonSchema(
+					result.value,
+					{
+						maxDepth: 10,
+						includeExamples: false,
+						strictRequired: true,
+					}
+				);
+
+				return OperationHandlerResult.success<DynamicOutput>({
+					output_schema: schema,
+				});
+			} catch (error) {
+				// Fallback on any error
+				return OperationHandlerResult.success<DynamicOutput>({
+					output_schema: {
+						type: 'object',
+						additionalProperties: true,
+						description: 'Fallback schema due to error',
+					},
+				});
+			}
+		})
+	);
+`;
+        await fse.writeFile(path.join(outputSchemaOpPath, 'handler.ts'), handlerTsContent);
+        this.log('  ✓ Generated handler.ts (with JsonSchemaIntrospector template)');
+        // 5. Update parent operation.json with isDynamicOutput: true
+        const updatedParentJson = {
+            ...parentOperationJson,
+            isDynamicOutput: true,
+        };
+        await fse.writeJson(parentOperationJsonPath, updatedParentJson, {
+            spaces: 2,
+        });
+        this.log(`  ✓ Updated parent operation.json with isDynamicOutput: true`);
+        // Success message with next steps
+        this.log('');
+        this.log((0, colorizeString_1.success)(`Success! Created dynamic output schema operation: ${outputSchemaOpName}`));
+        this.log('');
+        this.log('Next steps:');
+        this.log(`  1. Edit src/${outputSchemaOpName}/handler.ts`);
+        this.log('  2. Customize the data fetching logic for your use case');
+        this.log('  3. Run "tray-cdk connector build" to build the connector');
+        this.log('');
+        this.log('Note: Dynamic output is only safe for read-only GET operations!');
+    }
+    findSrcDirectory(currentDirectory) {
+        const { base } = path.parse(currentDirectory);
+        if (base === 'src') {
+            return currentDirectory;
+        }
+        return path.join(currentDirectory, 'src');
+    }
+}
+exports.default = AddDynamicOutputSchema;

package/oclif.manifest.json

@@ -17,6 +17,37 @@
         "index.js"
       ]
     },
+    "connector:add-dynamic-output-schema": {
+      "aliases": [],
+      "args": {
+        "operationName": {
+          "description": "Name of the parent operation to add dynamic output schema for",
+          "name": "operationName",
+          "required": true
+        }
+      },
+      "description": "Add a dynamic output schema operation for an existing operation",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> get_posts",
+        "<%= config.bin %> <%= command.id %> fetch_user_data"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "connector:add-dynamic-output-schema",
+      "pluginAlias": "@trayio/cdk-cli",
+      "pluginName": "@trayio/cdk-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "connector",
+        "add-dynamic-output-schema.js"
+      ]
+    },
     "connector:add-operation": {
       "aliases": [],
       "args": {
@@ -684,5 +715,5 @@
       ]
     }
   },
-  "version": "5.11.0"
+  "version": "5.13.0-unstable"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-cli",
-  "version": "5.11.0",
+  "version": "5.13.0-unstable",
   "description": "A CLI for connector development",
   "exports": {
     "./*": "./dist/*.js"
@@ -22,13 +22,13 @@
     "@oclif/plugin-version": "2.0.11",
     "@oclif/plugin-warn-if-update-available": "^3.1.4",
     "@oclif/test": "3.1.12",
-    "@trayio/axios": "5.11.0",
-    "@trayio/cdk-build": "5.11.0",
-    "@trayio/cdk-cli-commons": "5.11.0",
-    "@trayio/commons": "5.11.0",
-    "@trayio/generator": "5.11.0",
-    "@trayio/tray-client": "5.11.0",
-    "@trayio/tray-openapi": "5.11.0",
+    "@trayio/axios": "5.13.0-unstable",
+    "@trayio/cdk-build": "5.13.0-unstable",
+    "@trayio/cdk-cli-commons": "5.13.0-unstable",
+    "@trayio/commons": "5.13.0-unstable",
+    "@trayio/generator": "5.13.0-unstable",
+    "@trayio/tray-client": "5.13.0-unstable",
+    "@trayio/tray-openapi": "5.13.0-unstable",
     "chalk": "4.1.2",
     "dotenv": "^16.0.0",
     "inquirer": "8.2.6"
@@ -92,5 +92,6 @@
   "devDependencies": {
     "@types/inquirer": "8.2.6",
     "oclif": "*"
-  }
+  },
+  "stableVersion": "0.0.0"
 }