coalesce-transform-mcp 0.1.0

package/dist/services/pipelines/planning.d.ts

@@ -0,0 +1,543 @@
+import { z } from "zod";
+import type { CoalesceClient } from "../../client.js";
+import { type PipelineNodeTypeFamily, type PipelineNodeTypeSelection, type PipelineTemplateDefaults } from "./node-type-selection.js";
+type PipelineIntent = "sql" | "goal";
+type PipelineStatus = "ready" | "needs_clarification";
+type PipelineNodeType = string;
+type PlannedSelectItemKind = "column" | "expression";
+type PlannedSelectItem = {
+    expression: string;
+    outputName: string | null;
+    sourceNodeAlias: string | null;
+    sourceNodeName: string | null;
+    sourceNodeID: string | null;
+    sourceColumnName: string | null;
+    kind: PlannedSelectItemKind;
+    supported: boolean;
+    reason?: string;
+};
+type PlannedSourceRef = {
+    locationName: string;
+    nodeName: string;
+    alias: string | null;
+    nodeID: string | null;
+};
+export type PlannedPipelineNode = {
+    planNodeID: string;
+    name: string;
+    nodeType: PipelineNodeType;
+    nodeTypeFamily?: PipelineNodeTypeFamily | null;
+    predecessorNodeIDs: string[];
+    predecessorPlanNodeIDs: string[];
+    predecessorNodeNames: string[];
+    description: string | null;
+    sql: string | null;
+    selectItems: PlannedSelectItem[];
+    outputColumnNames: string[];
+    configOverrides: Record<string, unknown>;
+    sourceRefs: PlannedSourceRef[];
+    joinCondition: string | null;
+    location: {
+        locationName?: string;
+        database?: string;
+        schema?: string;
+    };
+    requiresFullSetNode: boolean;
+    templateDefaults?: PipelineTemplateDefaults;
+};
+type PipelinePlan = {
+    version: 1;
+    intent: PipelineIntent;
+    status: PipelineStatus;
+    workspaceID: string;
+    platform: string | null;
+    goal: string | null;
+    sql: string | null;
+    nodes: PlannedPipelineNode[];
+    assumptions: string[];
+    openQuestions: string[];
+    warnings: string[];
+    supportedNodeTypes: PipelineNodeType[];
+    nodeTypeSelection?: PipelineNodeTypeSelection;
+    cteNodeSummary?: CteNodeSummary[];
+    STOP_AND_CONFIRM?: string;
+};
+type CteNodeSummary = {
+    name: string;
+    nodeType: string;
+    pattern: "staging" | "multiSource" | "aggregation";
+    sourceTable: string | null;
+    columnCount: number;
+    transforms: Array<{
+        column: string;
+        expression: string;
+    }>;
+    passthroughColumns: string[];
+    whereFilter: string | null;
+    hasGroupBy: boolean;
+    hasJoin: boolean;
+    dependsOn: string[];
+    /** Structured columns for single-call creation (non-GROUP-BY CTEs) */
+    columnsParam?: Array<{
+        name: string;
+        transform?: string;
+    }>;
+    /** GROUP BY column expressions for single-call aggregation */
+    groupByColumnsParam?: string[];
+    /** Aggregate columns for single-call aggregation */
+    aggregatesParam?: Array<{
+        name: string;
+        function: string;
+        expression: string;
+    }>;
+};
+export declare const PipelinePlanSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    intent: z.ZodEnum<["sql", "goal"]>;
+    status: z.ZodEnum<["ready", "needs_clarification"]>;
+    workspaceID: z.ZodString;
+    platform: z.ZodNullable<z.ZodString>;
+    goal: z.ZodNullable<z.ZodString>;
+    sql: z.ZodNullable<z.ZodString>;
+    nodes: z.ZodArray<z.ZodObject<{
+        planNodeID: z.ZodString;
+        name: z.ZodString;
+        nodeType: z.ZodString;
+        nodeTypeFamily: z.ZodOptional<z.ZodNullable<z.ZodEnum<["stage", "persistent-stage", "view", "work", "dimension", "fact", "hub", "satellite", "link", "unknown"]>>>;
+        predecessorNodeIDs: z.ZodArray<z.ZodString, "many">;
+        predecessorPlanNodeIDs: z.ZodArray<z.ZodString, "many">;
+        predecessorNodeNames: z.ZodArray<z.ZodString, "many">;
+        description: z.ZodNullable<z.ZodString>;
+        sql: z.ZodNullable<z.ZodString>;
+        selectItems: z.ZodArray<z.ZodObject<{
+            expression: z.ZodString;
+            outputName: z.ZodNullable<z.ZodString>;
+            sourceNodeAlias: z.ZodNullable<z.ZodString>;
+            sourceNodeName: z.ZodNullable<z.ZodString>;
+            sourceNodeID: z.ZodNullable<z.ZodString>;
+            sourceColumnName: z.ZodNullable<z.ZodString>;
+            kind: z.ZodEnum<["column", "expression"]>;
+            supported: z.ZodBoolean;
+            reason: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            supported: boolean;
+            expression: string;
+            outputName: string | null;
+            sourceNodeAlias: string | null;
+            sourceNodeName: string | null;
+            sourceNodeID: string | null;
+            sourceColumnName: string | null;
+            kind: "expression" | "column";
+            reason?: string | undefined;
+        }, {
+            supported: boolean;
+            expression: string;
+            outputName: string | null;
+            sourceNodeAlias: string | null;
+            sourceNodeName: string | null;
+            sourceNodeID: string | null;
+            sourceColumnName: string | null;
+            kind: "expression" | "column";
+            reason?: string | undefined;
+        }>, "many">;
+        outputColumnNames: z.ZodArray<z.ZodString, "many">;
+        configOverrides: z.ZodObject<{
+            preSQL: z.ZodOptional<z.ZodString>;
+            postSQL: z.ZodOptional<z.ZodString>;
+            testsEnabled: z.ZodOptional<z.ZodBoolean>;
+            materializationType: z.ZodOptional<z.ZodString>;
+            insertStrategy: z.ZodOptional<z.ZodString>;
+            truncateBefore: z.ZodOptional<z.ZodBoolean>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            preSQL: z.ZodOptional<z.ZodString>;
+            postSQL: z.ZodOptional<z.ZodString>;
+            testsEnabled: z.ZodOptional<z.ZodBoolean>;
+            materializationType: z.ZodOptional<z.ZodString>;
+            insertStrategy: z.ZodOptional<z.ZodString>;
+            truncateBefore: z.ZodOptional<z.ZodBoolean>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            preSQL: z.ZodOptional<z.ZodString>;
+            postSQL: z.ZodOptional<z.ZodString>;
+            testsEnabled: z.ZodOptional<z.ZodBoolean>;
+            materializationType: z.ZodOptional<z.ZodString>;
+            insertStrategy: z.ZodOptional<z.ZodString>;
+            truncateBefore: z.ZodOptional<z.ZodBoolean>;
+        }, z.ZodTypeAny, "passthrough">>;
+        sourceRefs: z.ZodArray<z.ZodObject<{
+            locationName: z.ZodString;
+            nodeName: z.ZodString;
+            alias: z.ZodNullable<z.ZodString>;
+            nodeID: z.ZodNullable<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            locationName: string;
+            nodeID: string | null;
+            alias: string | null;
+            nodeName: string;
+        }, {
+            locationName: string;
+            nodeID: string | null;
+            alias: string | null;
+            nodeName: string;
+        }>, "many">;
+        joinCondition: z.ZodNullable<z.ZodString>;
+        location: z.ZodObject<{
+            locationName: z.ZodOptional<z.ZodString>;
+            database: z.ZodOptional<z.ZodString>;
+            schema: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            database?: string | undefined;
+            schema?: string | undefined;
+            locationName?: string | undefined;
+        }, {
+            database?: string | undefined;
+            schema?: string | undefined;
+            locationName?: string | undefined;
+        }>;
+        requiresFullSetNode: z.ZodBoolean;
+        templateDefaults: z.ZodOptional<z.ZodObject<{
+            inferredTopLevelFields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            inferredConfig: z.ZodObject<{
+                preSQL: z.ZodOptional<z.ZodString>;
+                postSQL: z.ZodOptional<z.ZodString>;
+                testsEnabled: z.ZodOptional<z.ZodBoolean>;
+                materializationType: z.ZodOptional<z.ZodString>;
+                insertStrategy: z.ZodOptional<z.ZodString>;
+                truncateBefore: z.ZodOptional<z.ZodBoolean>;
+            }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                preSQL: z.ZodOptional<z.ZodString>;
+                postSQL: z.ZodOptional<z.ZodString>;
+                testsEnabled: z.ZodOptional<z.ZodBoolean>;
+                materializationType: z.ZodOptional<z.ZodString>;
+                insertStrategy: z.ZodOptional<z.ZodString>;
+                truncateBefore: z.ZodOptional<z.ZodBoolean>;
+            }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                preSQL: z.ZodOptional<z.ZodString>;
+                postSQL: z.ZodOptional<z.ZodString>;
+                testsEnabled: z.ZodOptional<z.ZodBoolean>;
+                materializationType: z.ZodOptional<z.ZodString>;
+                insertStrategy: z.ZodOptional<z.ZodString>;
+                truncateBefore: z.ZodOptional<z.ZodBoolean>;
+            }, z.ZodTypeAny, "passthrough">>;
+        }, "strict", z.ZodTypeAny, {
+            inferredTopLevelFields: Record<string, unknown>;
+            inferredConfig: {
+                materializationType?: string | undefined;
+                insertStrategy?: string | undefined;
+                truncateBefore?: boolean | undefined;
+                preSQL?: string | undefined;
+                postSQL?: string | undefined;
+                testsEnabled?: boolean | undefined;
+            } & {
+                [k: string]: unknown;
+            };
+        }, {
+            inferredTopLevelFields: Record<string, unknown>;
+            inferredConfig: {
+                materializationType?: string | undefined;
+                insertStrategy?: string | undefined;
+                truncateBefore?: boolean | undefined;
+                preSQL?: string | undefined;
+                postSQL?: string | undefined;
+                testsEnabled?: boolean | undefined;
+            } & {
+                [k: string]: unknown;
+            };
+        }>>;
+    }, "strict", z.ZodTypeAny, {
+        description: string | null;
+        name: string;
+        nodeType: string;
+        sql: string | null;
+        predecessorNodeIDs: string[];
+        joinCondition: string | null;
+        planNodeID: string;
+        predecessorPlanNodeIDs: string[];
+        predecessorNodeNames: string[];
+        selectItems: {
+            supported: boolean;
+            expression: string;
+            outputName: string | null;
+            sourceNodeAlias: string | null;
+            sourceNodeName: string | null;
+            sourceNodeID: string | null;
+            sourceColumnName: string | null;
+            kind: "expression" | "column";
+            reason?: string | undefined;
+        }[];
+        outputColumnNames: string[];
+        configOverrides: {
+            materializationType?: string | undefined;
+            insertStrategy?: string | undefined;
+            truncateBefore?: boolean | undefined;
+            preSQL?: string | undefined;
+            postSQL?: string | undefined;
+            testsEnabled?: boolean | undefined;
+        } & {
+            [k: string]: unknown;
+        };
+        sourceRefs: {
+            locationName: string;
+            nodeID: string | null;
+            alias: string | null;
+            nodeName: string;
+        }[];
+        location: {
+            database?: string | undefined;
+            schema?: string | undefined;
+            locationName?: string | undefined;
+        };
+        requiresFullSetNode: boolean;
+        templateDefaults?: {
+            inferredTopLevelFields: Record<string, unknown>;
+            inferredConfig: {
+                materializationType?: string | undefined;
+                insertStrategy?: string | undefined;
+                truncateBefore?: boolean | undefined;
+                preSQL?: string | undefined;
+                postSQL?: string | undefined;
+                testsEnabled?: boolean | undefined;
+            } & {
+                [k: string]: unknown;
+            };
+        } | undefined;
+        nodeTypeFamily?: "unknown" | "link" | "view" | "stage" | "persistent-stage" | "work" | "dimension" | "fact" | "hub" | "satellite" | null | undefined;
+    }, {
+        description: string | null;
+        name: string;
+        nodeType: string;
+        sql: string | null;
+        predecessorNodeIDs: string[];
+        joinCondition: string | null;
+        planNodeID: string;
+        predecessorPlanNodeIDs: string[];
+        predecessorNodeNames: string[];
+        selectItems: {
+            supported: boolean;
+            expression: string;
+            outputName: string | null;
+            sourceNodeAlias: string | null;
+            sourceNodeName: string | null;
+            sourceNodeID: string | null;
+            sourceColumnName: string | null;
+            kind: "expression" | "column";
+            reason?: string | undefined;
+        }[];
+        outputColumnNames: string[];
+        configOverrides: {
+            materializationType?: string | undefined;
+            insertStrategy?: string | undefined;
+            truncateBefore?: boolean | undefined;
+            preSQL?: string | undefined;
+            postSQL?: string | undefined;
+            testsEnabled?: boolean | undefined;
+        } & {
+            [k: string]: unknown;
+        };
+        sourceRefs: {
+            locationName: string;
+            nodeID: string | null;
+            alias: string | null;
+            nodeName: string;
+        }[];
+        location: {
+            database?: string | undefined;
+            schema?: string | undefined;
+            locationName?: string | undefined;
+        };
+        requiresFullSetNode: boolean;
+        templateDefaults?: {
+            inferredTopLevelFields: Record<string, unknown>;
+            inferredConfig: {
+                materializationType?: string | undefined;
+                insertStrategy?: string | undefined;
+                truncateBefore?: boolean | undefined;
+                preSQL?: string | undefined;
+                postSQL?: string | undefined;
+                testsEnabled?: boolean | undefined;
+            } & {
+                [k: string]: unknown;
+            };
+        } | undefined;
+        nodeTypeFamily?: "unknown" | "link" | "view" | "stage" | "persistent-stage" | "work" | "dimension" | "fact" | "hub" | "satellite" | null | undefined;
+    }>, "many">;
+    assumptions: z.ZodArray<z.ZodString, "many">;
+    openQuestions: z.ZodArray<z.ZodString, "many">;
+    warnings: z.ZodArray<z.ZodString, "many">;
+    supportedNodeTypes: z.ZodArray<z.ZodString, "many">;
+    nodeTypeSelection: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    cteNodeSummary: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
+    STOP_AND_CONFIRM: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    status: "ready" | "needs_clarification";
+    workspaceID: string;
+    nodes: {
+        description: string | null;
+        name: string;
+        nodeType: string;
+        sql: string | null;
+        predecessorNodeIDs: string[];
+        joinCondition: string | null;
+        planNodeID: string;
+        predecessorPlanNodeIDs: string[];
+        predecessorNodeNames: string[];
+        selectItems: {
+            supported: boolean;
+            expression: string;
+            outputName: string | null;
+            sourceNodeAlias: string | null;
+            sourceNodeName: string | null;
+            sourceNodeID: string | null;
+            sourceColumnName: string | null;
+            kind: "expression" | "column";
+            reason?: string | undefined;
+        }[];
+        outputColumnNames: string[];
+        configOverrides: {
+            materializationType?: string | undefined;
+            insertStrategy?: string | undefined;
+            truncateBefore?: boolean | undefined;
+            preSQL?: string | undefined;
+            postSQL?: string | undefined;
+            testsEnabled?: boolean | undefined;
+        } & {
+            [k: string]: unknown;
+        };
+        sourceRefs: {
+            locationName: string;
+            nodeID: string | null;
+            alias: string | null;
+            nodeName: string;
+        }[];
+        location: {
+            database?: string | undefined;
+            schema?: string | undefined;
+            locationName?: string | undefined;
+        };
+        requiresFullSetNode: boolean;
+        templateDefaults?: {
+            inferredTopLevelFields: Record<string, unknown>;
+            inferredConfig: {
+                materializationType?: string | undefined;
+                insertStrategy?: string | undefined;
+                truncateBefore?: boolean | undefined;
+                preSQL?: string | undefined;
+                postSQL?: string | undefined;
+                testsEnabled?: boolean | undefined;
+            } & {
+                [k: string]: unknown;
+            };
+        } | undefined;
+        nodeTypeFamily?: "unknown" | "link" | "view" | "stage" | "persistent-stage" | "work" | "dimension" | "fact" | "hub" | "satellite" | null | undefined;
+    }[];
+    warnings: string[];
+    version: 1;
+    intent: "goal" | "sql";
+    platform: string | null;
+    goal: string | null;
+    sql: string | null;
+    assumptions: string[];
+    openQuestions: string[];
+    supportedNodeTypes: string[];
+    cteNodeSummary?: Record<string, unknown>[] | undefined;
+    nodeTypeSelection?: Record<string, unknown> | undefined;
+    STOP_AND_CONFIRM?: string | undefined;
+}, {
+    status: "ready" | "needs_clarification";
+    workspaceID: string;
+    nodes: {
+        description: string | null;
+        name: string;
+        nodeType: string;
+        sql: string | null;
+        predecessorNodeIDs: string[];
+        joinCondition: string | null;
+        planNodeID: string;
+        predecessorPlanNodeIDs: string[];
+        predecessorNodeNames: string[];
+        selectItems: {
+            supported: boolean;
+            expression: string;
+            outputName: string | null;
+            sourceNodeAlias: string | null;
+            sourceNodeName: string | null;
+            sourceNodeID: string | null;
+            sourceColumnName: string | null;
+            kind: "expression" | "column";
+            reason?: string | undefined;
+        }[];
+        outputColumnNames: string[];
+        configOverrides: {
+            materializationType?: string | undefined;
+            insertStrategy?: string | undefined;
+            truncateBefore?: boolean | undefined;
+            preSQL?: string | undefined;
+            postSQL?: string | undefined;
+            testsEnabled?: boolean | undefined;
+        } & {
+            [k: string]: unknown;
+        };
+        sourceRefs: {
+            locationName: string;
+            nodeID: string | null;
+            alias: string | null;
+            nodeName: string;
+        }[];
+        location: {
+            database?: string | undefined;
+            schema?: string | undefined;
+            locationName?: string | undefined;
+        };
+        requiresFullSetNode: boolean;
+        templateDefaults?: {
+            inferredTopLevelFields: Record<string, unknown>;
+            inferredConfig: {
+                materializationType?: string | undefined;
+                insertStrategy?: string | undefined;
+                truncateBefore?: boolean | undefined;
+                preSQL?: string | undefined;
+                postSQL?: string | undefined;
+                testsEnabled?: boolean | undefined;
+            } & {
+                [k: string]: unknown;
+            };
+        } | undefined;
+        nodeTypeFamily?: "unknown" | "link" | "view" | "stage" | "persistent-stage" | "work" | "dimension" | "fact" | "hub" | "satellite" | null | undefined;
+    }[];
+    warnings: string[];
+    version: 1;
+    intent: "goal" | "sql";
+    platform: string | null;
+    goal: string | null;
+    sql: string | null;
+    assumptions: string[];
+    openQuestions: string[];
+    supportedNodeTypes: string[];
+    cteNodeSummary?: Record<string, unknown>[] | undefined;
+    nodeTypeSelection?: Record<string, unknown> | undefined;
+    STOP_AND_CONFIRM?: string | undefined;
+}>;
+export declare const DEFAULT_STAGE_CONFIG: Record<string, unknown>;
+export declare function normalizeSqlIdentifier(identifier: string): string;
+export declare function deepClone<T>(value: T): T;
+export declare function normalizeWhitespace(value: string): string;
+export declare function getColumnNamesFromNode(node: Record<string, unknown>): string[];
+export declare function planPipeline(client: CoalesceClient, params: {
+    workspaceID: string;
+    goal?: string;
+    sql?: string;
+    targetName?: string;
+    targetNodeType?: string;
+    description?: string;
+    configOverrides?: Record<string, unknown>;
+    locationName?: string;
+    database?: string;
+    schema?: string;
+    sourceNodeIDs?: string[];
+    repoPath?: string;
+}): Promise<PipelinePlan>;
+export declare function getNodeColumnArray(node: Record<string, unknown>): Record<string, unknown>[];
+export declare function getColumnSourceNodeIDs(column: Record<string, unknown>): string[];
+export declare function findMatchingBaseColumn(node: Record<string, unknown>, selectItem: PlannedSelectItem): Record<string, unknown> | null;
+export declare function renameSourceMappingEntries(node: Record<string, unknown>, newName: string): Record<string, unknown>;
+export declare function buildStageSourceMappingFromPlan(currentNode: Record<string, unknown>, nodePlan: PlannedPipelineNode): Record<string, unknown>[];
+export {};