@sw-tsdk/plugin-connector 3.13.1 → 3.13.2-next.3dfd44a

package/lib/transformers/connector-generator.d.ts

@@ -1,15 +1,117 @@
 import { AppTasks, ConnectorMigrationConfig, TransformationResult } from '../types/migrator-types';
+/** Application info from export (applicationInfo.json); used to resolve record field types. */
+export interface ApplicationInfo {
+    name?: string;
+    fields?: ApplicationField[];
+}
+export interface ApplicationField {
+    id?: string;
+    key?: string;
+    name?: string;
+    fieldType?: string;
+    selectionType?: string;
+    controlType?: string;
+    inputType?: string;
+}
 export declare class ConnectorGenerator {
-    static initializeForkedPlugin(transformedExport: TransformationResult, fromDirectory: string, toDirectory: string): Promise<void>;
+    private static readonly ACTION_DESCRIPTION_MAX_LENGTH;
+    private static truncateActionDescription;
+    /**
+     * For inputs with Type "record", resolve ValueType from applicationInfo.fields (field id = input.Value).
+     * Call after transform() so action YAML and temp_inputs get correct types.
+     */
+    static patchRecordInputTypes(transformationResult: TransformationResult, applicationInfo: ApplicationInfo | null): void;
+    /**
+     * For outputs that map to date fields (by Value = field id in applicationInfo), compute which keys need
+     * conversion to ISO8601 and the timetype/format for each. Sets transformationResult.outputDateConversions.
+     * Uses the application denoted by each output block's ApplicationId (same level as Mappings) when present,
+     * otherwise the current application (taskApplicationId).
+     * - DataFormat "Standard" -> no conversion.
+     * - DataFormat "Unix EPOCH" -> timetype = UnixEpochUnit (seconds or milliseconds).
+     * - DataFormat "custom" -> timetype = customDataFormat.
+     * - Otherwise -> timetype = DataFormat (treat as custom format string).
+     */
+    static patchOutputDateConversions(transformationResult: TransformationResult, applicationInfoMap: Record<string, ApplicationInfo> | null, currentApplicationId: string | undefined): void;
+    /**
+     * Initializes a forked plugin (copy base code, requirements, asset).
+     * Returns the set of runner-excluded package names that were skipped (e.g. ssdeep) so runner.sh can be updated.
+     */
+    static initializeForkedPlugin(transformedExport: TransformationResult, fromDirectory: string, toDirectory: string): Promise<Set<string>>;
     static generateLogo(toDirectory: string): Promise<void>;
     static generateBaseStructure(toDirectory: string): Promise<void>;
     static generateRunnerOverride(toDirectory: string): Promise<void>;
     static generateAction(transformedExport: TransformationResult, toDirectory: string): Promise<void>;
     private static generateAsset;
+    /**
+     * Adds asset parameters from task input mappings to a separate input asset file.
+     * Creates input_asset.yaml to avoid overwriting existing asset.yaml from forked plugins.
+     */
+    static addAssetParameters(toDirectory: string, assetParameters: {
+        Key: string;
+        Type: string;
+        Example?: any;
+        SubValue?: string;
+    }[], applicationName?: string): Promise<void>;
     private static extractZip;
-    static generateRequirements(fromDirectory: string, toDirectory: string, packageName: string): Promise<void>;
+    static addExtractedImportsToRequirements(toDirectory: string, taskImports: Set<string>): Promise<void>;
+    /**
+     * Appends forked plugin dependencies to requirements.txt.
+     * Returns the set of package names that were excluded but need runner.sh (e.g. ssdeep).
+     */
+    static generateRequirements(fromDirectory: string, toDirectory: string, packageName: string): Promise<Set<string>>;
+    /**
+     * Resolves version conflicts by taking the highest version requirement.
+     * Handles common cases like ==, >=, <=, >, < constraints.
+     */
+    private static resolveVersionConflict;
+    /**
+     * Compares two version arrays (e.g., [2, 5, 0] vs [2, 4, 1]).
+     * Returns: positive if v1 > v2, negative if v1 < v2, 0 if equal.
+     */
+    private static compareVersions;
+    /**
+     * Deduplicates requirements.txt and resolves version conflicts.
+     * When multiple versions of the same package are specified, keeps the highest version.
+     */
+    static deduplicateRequirements(toDirectory: string): Promise<void>;
+    /**
+     * Creates compile.sh in the connector root if swimbundle_utils was found in requirements.
+     * This handles the special case where swimbundle_utils needs to be installed separately.
+     */
+    static generateCompileScript(toDirectory: string): Promise<void>;
+    /**
+     * Creates runner.sh in the connector root with apt/pip installs for optional system deps:
+     * - wkhtmltopdf when connector uses sw_swimlane_email
+     * - ssdeep (apt + pip install --user) when needsSsdeep (e.g. from task imports; ssdeep is excluded from requirements.txt)
+     */
+    static generateRunnerScript(toDirectory: string, usesSwimlaneEmail: boolean, needsSsdeep: boolean): Promise<void>;
     private static createBaseCode;
+    /**
+     * Patch sw_swimlane_email __init__.py execute() to use system wkhtmltoimage and Config instead of pkg_resources/chmod.
+     * Matches the block after "def execute(self):" containing:
+     *   f = pkg_resources.resource_filename(__name__, "__packages/wkhtmltoimage")  # ...
+     *   c = Config(f)
+     *   st = os.stat(f)
+     *   os.chmod(f, st.st_mode | stat.S_IEXEC)  # ...
+     */
+    private static patchSwimlaneEmailInit;
+    private static copyDirectoryRecursive;
     private static getBaseCodePath;
+    /**
+     * Build Python snippet to rebuild inputs from YAML-defined keys (empty per type) then merge asset then inputs.
+     * Only includes keys where the task InputMapping has an associated Type and Value.
+     * Placeholder # INPUTS_MERGE_HERE in templates is replaced with this.
+     * @param includeAttachmentBlock - when true (script_override only), include attachment conversion and dict handling; when false (plugin_override), only temp_inputs merge.
+     */
+    private static defaultPyValue;
+    private static buildInputsMergeSnippet;
+    private static readonly INPUTS_MERGE_PLACEHOLDER;
+    private static readonly OUTPUT_DATE_CONVERSIONS_PLACEHOLDER;
+    private static readonly TASK_EXECUTE_REQUEST_CALL;
+    private static readonly TASK_EXECUTE_WEBHOOK_CALL;
+    private static replaceTaskExecuteRequestCall;
+    /** Build Python dict literal for OUTPUT_DATE_CONVERSIONS (key -> timetype/format). */
+    private static buildOutputDateConversionsDict;
     private static getActionContentFork;
     private static getActionContentScript;
     static generateActionConfig(transformationResult: TransformationResult, toDirectory: string): Promise<boolean>;