@prismatic-io/spectral 10.18.6 → 10.18.7-preview.2

package/dist/generators/componentManifest/getInputs.js

@@ -3,13 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.INPUT_TYPE_MAP = exports.getInputs = void 0;
 const escapeSpecialCharacters_1 = require("../utils/escapeSpecialCharacters");
 const docBlock_1 = require("./docBlock");
-const getDefaultValue = (value, isCollection) => {
-    if (value === undefined || value === "") {
-        return isCollection ? [] : value;
-    }
-    const stringValue = typeof value === "string" ? value : JSON.stringify(value);
-    return (0, escapeSpecialCharacters_1.escapeSpecialCharacters)(stringValue);
-};
 const getInputs = ({ inputs, docBlock = docBlock_1.DOC_BLOCK_DEFAULT }) => {
     return inputs.reduce((acc, input) => {
         if ((typeof input.shown === "boolean" && input.shown === false) ||
@@ -68,8 +61,23 @@ exports.INPUT_TYPE_MAP = {
     timestamp: "string",
     flow: "string",
     template: "string",
+    structuredObject: {
+        module: "@prismatic-io/spectral/dist/types",
+        type: "StructuredObject",
+    },
+    dynamicObject: {
+        module: "@prismatic-io/spectral/dist/types",
+        type: "DynamicObject",
+    },
 };
 const getInputValueType = (input) => {
+    var _a, _b;
+    if (input.type === "structuredObject") {
+        return structuredObjectTypeString((_a = input.inputs) !== null && _a !== void 0 ? _a : []);
+    }
+    if (input.type === "dynamicObject") {
+        return dynamicObjectTypeString((_b = input.inputs) !== null && _b !== void 0 ? _b : []);
+    }
     const inputType = exports.INPUT_TYPE_MAP[input.type];
     const valueType = input.model
         ? input.model
@@ -94,3 +102,70 @@ const getInputValueType = (input) => {
     }
     return valueType;
 };
+const getDefaultValue = (value, isCollection) => {
+    if (value === undefined || value === "") {
+        return isCollection ? [] : value;
+    }
+    const stringValue = typeof value === "string" ? value : JSON.stringify(value);
+    return (0, escapeSpecialCharacters_1.escapeSpecialCharacters)(stringValue);
+};
+const isValidIdentifier = (key) => /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key);
+const wrapCollection = (valueType, collection) => {
+    if (collection === "valuelist") {
+        return `Array<${valueType}>`;
+    }
+    if (collection === "keyvaluelist") {
+        return `Record<string, ${valueType}> | Array<{key: string, value: ${valueType}}>`;
+    }
+    return valueType;
+};
+const getLeafBaseType = (child) => {
+    var _a;
+    if ((_a = child.model) === null || _a === void 0 ? void 0 : _a.length) {
+        return child.model
+            .map(({ value }) => `\`${value.replaceAll("\r", "\\r").replaceAll("\n", "\\n")}\``)
+            .join(" | ");
+    }
+    const mapped = exports.INPUT_TYPE_MAP[child.type];
+    if (!mapped) {
+        return "unknown";
+    }
+    if (typeof mapped === "string") {
+        return mapped;
+    }
+    return `import("${mapped.module}").${mapped.type}`;
+};
+const getLeafTypeString = (child) => {
+    var _a;
+    if (child.type === "structuredObject") {
+        return structuredObjectTypeString((_a = child.inputs) !== null && _a !== void 0 ? _a : []);
+    }
+    return wrapCollection(getLeafBaseType(child), child.collection);
+};
+const SPECTRAL_TYPES_MODULE = "@prismatic-io/spectral/dist/types";
+const structuredObjectTypeString = (inputs) => {
+    if (!inputs.length) {
+        return `import("${SPECTRAL_TYPES_MODULE}").StructuredObject`;
+    }
+    const fields = inputs
+        .map((child) => {
+        const key = isValidIdentifier(child.key) ? child.key : JSON.stringify(child.key);
+        return `${key}: ${getLeafTypeString(child)}`;
+    })
+        .join("; ");
+    return `{ ${fields} }`;
+};
+const dynamicObjectTypeString = (configurations) => {
+    if (!configurations.length) {
+        return `import("${SPECTRAL_TYPES_MODULE}").DynamicObject`;
+    }
+    return configurations
+        .map((config) => {
+        var _a;
+        const valuesType = ((_a = config.inputs) === null || _a === void 0 ? void 0 : _a.length)
+            ? structuredObjectTypeString(config.inputs)
+            : `import("${SPECTRAL_TYPES_MODULE}").StructuredObject`;
+        return `{ configuration: ${JSON.stringify(config.key)}; values: ${valuesType} }`;
+    })
+        .join(" | ");
+};

package/dist/index.d.ts

@@ -5,7 +5,7 @@
  */
 import { convertComponent } from "./serverTypes/convertComponent";
 import { convertIntegration } from "./serverTypes/convertIntegration";
-import type { ActionDefinition, ActionPerformReturn, ComponentDefinition, ComponentManifest, ConfigPage, ConfigVarResultCollection, ConnectionConfigVar, CustomerActivatedConnectionConfigVar, DataSourceConfigVar, DataSourceDefinition, DataSourceType, DefaultConnectionDefinition, Flow, InputFieldDefinition, Inputs, IntegrationDefinition, OAuth2ConnectionDefinition, OnPremConnectionDefinition, OrganizationActivatedConnectionConfigVar, StandardConfigVar, TriggerDefinition, TriggerPayload, TriggerResult } from "./types";
+import type { ActionDefinition, ActionPerformReturn, ComponentDefinition, ComponentManifest, ConfigPage, ConfigVarResultCollection, ConnectionConfigVar, CustomerActivatedConnectionConfigVar, DataSourceConfigVar, DataSourceDefinition, DataSourceType, DefaultConnectionDefinition, DynamicObjectInputField, Flow, InputFieldDefinition, Inputs, IntegrationDefinition, OAuth2ConnectionDefinition, OnPremConnectionDefinition, OrganizationActivatedConnectionConfigVar, StandardConfigVar, StructuredObjectInputField, TriggerDefinition, TriggerPayload, TriggerResult } from "./types";
 import type { PollingTriggerDefinition } from "./types/PollingTriggerDefinition";
 /**
  * This function creates a code-native integration object that can be
@@ -512,6 +512,69 @@ export declare const dataSource: <TInputs extends Inputs, TConfigVars extends Co
  * });
  */
 export declare const input: <T extends InputFieldDefinition>(definition: T) => T;
+/**
+ * Groups related primitive inputs under a single named container. Children
+ * may not themselves be structuredObject inputs (the type signature enforces
+ * this at compile time).
+ *
+ * @example
+ * import { input, structuredObjectInput } from "@prismatic-io/spectral";
+ *
+ * const name = structuredObjectInput({
+ *   label: "Name",
+ *   inputs: {
+ *     first: input({ type: "string", label: "First Name", required: true }),
+ *     last: input({ type: "string", label: "Last Name", required: true }),
+ *   },
+ * });
+ */
+export declare const structuredObjectInput: <T extends Omit<StructuredObjectInputField, "type"> & {
+    type?: never;
+}>(definition: T) => T & {
+    type: "structuredObject";
+};
+/**
+ * Presents a discriminated set of input configurations; the integration builder
+ * picks a configuration and its inputs become available. Configurations may
+ * contain leaf inputs and structuredObject inputs but not nested dynamicObjects
+ * (the type signature enforces this at compile time).
+ *
+ * @example
+ * import { input, structuredObjectInput, dynamicObjectInput } from "@prismatic-io/spectral";
+ *
+ * const recordData = dynamicObjectInput({
+ *   label: "Record Data",
+ *   required: true,
+ *   configurations: {
+ *     contact: {
+ *       label: "Contact",
+ *       comments: "Create a new contact",
+ *       inputs: {
+ *         name: structuredObjectInput({
+ *           label: "Name",
+ *           inputs: {
+ *             first: input({ type: "string", label: "First Name", required: true }),
+ *             last: input({ type: "string", label: "Last Name", required: true }),
+ *           },
+ *         }),
+ *         email: input({ type: "string", label: "Email", required: true }),
+ *       },
+ *     },
+ *     account: {
+ *       label: "Account",
+ *       comments: "Create a new account",
+ *       inputs: {
+ *         companyName: input({ type: "string", label: "Company Name", required: true }),
+ *       },
+ *     },
+ *   },
+ * });
+ */
+export declare const dynamicObjectInput: <T extends Omit<DynamicObjectInputField, "type"> & {
+    type?: never;
+}>(definition: T) => T & {
+    type: "dynamicObject";
+};
 /**
  * This function creates a connection that can be used by a code-native integration
  * or custom component. Connections define the fields (API keys, tokens, etc.) needed

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.util = exports.testing = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.pollingTrigger = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.organizationActivatedConnection = exports.customerActivatedConnection = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
+exports.util = exports.testing = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.dynamicObjectInput = exports.structuredObjectInput = exports.input = exports.dataSource = exports.pollingTrigger = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.organizationActivatedConnection = exports.customerActivatedConnection = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
 const serverTypes_1 = require("./serverTypes");
 const convertComponent_1 = require("./serverTypes/convertComponent");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
@@ -557,6 +557,63 @@ exports.dataSource = dataSource;
  */
 const input = (definition) => definition;
 exports.input = input;
+/**
+ * Groups related primitive inputs under a single named container. Children
+ * may not themselves be structuredObject inputs (the type signature enforces
+ * this at compile time).
+ *
+ * @example
+ * import { input, structuredObjectInput } from "@prismatic-io/spectral";
+ *
+ * const name = structuredObjectInput({
+ *   label: "Name",
+ *   inputs: {
+ *     first: input({ type: "string", label: "First Name", required: true }),
+ *     last: input({ type: "string", label: "Last Name", required: true }),
+ *   },
+ * });
+ */
+const structuredObjectInput = (definition) => (Object.assign(Object.assign({}, definition), { type: "structuredObject" }));
+exports.structuredObjectInput = structuredObjectInput;
+/**
+ * Presents a discriminated set of input configurations; the integration builder
+ * picks a configuration and its inputs become available. Configurations may
+ * contain leaf inputs and structuredObject inputs but not nested dynamicObjects
+ * (the type signature enforces this at compile time).
+ *
+ * @example
+ * import { input, structuredObjectInput, dynamicObjectInput } from "@prismatic-io/spectral";
+ *
+ * const recordData = dynamicObjectInput({
+ *   label: "Record Data",
+ *   required: true,
+ *   configurations: {
+ *     contact: {
+ *       label: "Contact",
+ *       comments: "Create a new contact",
+ *       inputs: {
+ *         name: structuredObjectInput({
+ *           label: "Name",
+ *           inputs: {
+ *             first: input({ type: "string", label: "First Name", required: true }),
+ *             last: input({ type: "string", label: "Last Name", required: true }),
+ *           },
+ *         }),
+ *         email: input({ type: "string", label: "Email", required: true }),
+ *       },
+ *     },
+ *     account: {
+ *       label: "Account",
+ *       comments: "Create a new account",
+ *       inputs: {
+ *         companyName: input({ type: "string", label: "Company Name", required: true }),
+ *       },
+ *     },
+ *   },
+ * });
+ */
+const dynamicObjectInput = (definition) => (Object.assign(Object.assign({}, definition), { type: "dynamicObject" }));
+exports.dynamicObjectInput = dynamicObjectInput;
 /**
  * This function creates a connection that can be used by a code-native integration
  * or custom component. Connections define the fields (API keys, tokens, etc.) needed

package/dist/serverTypes/convertComponent.d.ts

@@ -1,7 +1,13 @@
 import { type ComponentDefinition, type ComponentHooks, type ConfigVarResultCollection, type ConnectionDefinition, type ConnectionInput, type ConnectionTemplateInputField, type InputFieldDefinition, type Inputs, type OnPremConnectionInput, type TriggerDefinition, type TriggerPayload, type TriggerResult } from "../types";
 import { type PollingTriggerDefinition } from "../types/PollingTriggerDefinition";
 import type { Component as ServerComponent, Connection as ServerConnection, Input as ServerInput, Trigger as ServerTrigger } from ".";
-export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition | OnPremConnectionInput | ConnectionInput) => ServerInput;
+import { type CleanFn } from "./perform";
+/** Auto-generated cleaner for structuredObject/dynamicObject containers.
+ * Recursively delegates to each child's clean function. Developers do not
+ * declare a top-level clean on these containers — the conversion always
+ * supplies one so nested clean functions are applied at runtime. */
+export declare const cleanerFor: (input: InputFieldDefinition) => CleanFn | undefined;
+export declare const convertInput: (key: string, definition: InputFieldDefinition | OnPremConnectionInput | ConnectionInput) => ServerInput;
 export declare const _isValidTemplateValue: (template: string, inputs: {
     [key: string]: ConnectionInput | ConnectionTemplateInputField;
 }) => {

package/dist/serverTypes/convertComponent.js

@@ -14,21 +14,74 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertComponent = exports.convertConnection = exports.convertTrigger = exports.convertTemplateInput = exports._isValidTemplateValue = exports.convertInput = void 0;
+exports.convertComponent = exports.convertConnection = exports.convertTrigger = exports.convertTemplateInput = exports._isValidTemplateValue = exports.convertInput = exports.cleanerFor = void 0;
 const omit_1 = __importDefault(require("lodash/omit"));
 const types_1 = require("../types");
 const PollingTriggerDefinition_1 = require("../types/PollingTriggerDefinition");
 const perform_1 = require("./perform");
-const convertInput = (key, _a) => {
-    var { default: defaultValue, type, label, collection } = _a, rest = __rest(_a, ["default", "type", "label", "collection"]);
+const isPlainObject = (value) => value !== null && typeof value === "object" && !Array.isArray(value);
+/** Auto-generated cleaner for structuredObject/dynamicObject containers.
+ * Recursively delegates to each child's clean function. Developers do not
+ * declare a top-level clean on these containers — the conversion always
+ * supplies one so nested clean functions are applied at runtime. */
+const cleanerFor = (input) => {
+    if (input.type === "structuredObject") {
+        const childCleaners = Object.entries(input.inputs).reduce((acc, [childKey, childDef]) => (Object.assign(Object.assign({}, acc), { [childKey]: (0, exports.cleanerFor)(childDef) })), {});
+        return (value) => {
+            if (!isPlainObject(value)) {
+                return value;
+            }
+            return (0, perform_1.cleanParams)(value, childCleaners);
+        };
+    }
+    if (input.type === "dynamicObject") {
+        const configCleaners = {};
+        for (const [configKey, configDef] of Object.entries(input.configurations)) {
+            configCleaners[configKey] = Object.entries(configDef.inputs).reduce((acc, [childKey, childDef]) => (Object.assign(Object.assign({}, acc), { [childKey]: (0, exports.cleanerFor)(childDef) })), {});
+        }
+        return (value) => {
+            if (!isPlainObject(value)) {
+                return value;
+            }
+            const { configuration, values } = value;
+            if (typeof configuration !== "string") {
+                return value;
+            }
+            const cleaners = configCleaners[configuration];
+            if (!cleaners) {
+                return { configuration, values };
+            }
+            return {
+                configuration,
+                values: isPlainObject(values) ? (0, perform_1.cleanParams)(values, cleaners) : values,
+            };
+        };
+    }
+    return "clean" in input ? input.clean : undefined;
+};
+exports.cleanerFor = cleanerFor;
+const convertInput = (key, definition) => {
+    // Cast: the field union is wider than any single member; runtime guards below handle it.
+    const _a = definition, { default: defaultValue, type, label, collection, inputs: childInputs, configurations } = _a, rest = __rest(_a, ["default", "type", "label", "collection", "inputs", "configurations"]);
     const keyLabel = collection === "keyvaluelist" && typeof label === "object" ? label.key : undefined;
+    const nestedInputs = type === "structuredObject" && childInputs
+        ? Object.entries(childInputs).map(([childKey, childDef]) => (0, exports.convertInput)(childKey, childDef))
+        : type === "dynamicObject" && configurations
+            ? Object.entries(configurations).map(([configKey, configDef]) => ({
+                key: configKey,
+                type: "structuredObject",
+                label: typeof configDef.label === "string" ? configDef.label : configDef.label.value,
+                comments: configDef.comments,
+                inputs: Object.entries(configDef.inputs).map(([childKey, childDef]) => (0, exports.convertInput)(childKey, childDef)),
+            }))
+            : undefined;
     return Object.assign(Object.assign({}, (0, omit_1.default)(rest, [
         "onPremControlled",
         "permissionAndVisibilityType",
         "visibleToOrgDeployer",
         "writeOnly",
     ])), { key,
-        type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel, onPremiseControlled: ("onPremControlled" in rest && rest.onPremControlled) || undefined });
+        type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel, onPremiseControlled: rest.onPremControlled === true ? true : undefined, inputs: nestedInputs });
 };
 exports.convertInput = convertInput;
 const TEMPLATE_VALUE_REGEX = /{{#(\w+)}}/g;
@@ -73,7 +126,7 @@ exports.convertTemplateInput = convertTemplateInput;
 const convertAction = (actionKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, action = __rest(_a, ["inputs", "perform"]);
     const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
-    const inputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
+    const inputCleaners = Object.entries(inputs).reduce((result, [key, value]) => (Object.assign(Object.assign({}, result), { [key]: (0, exports.cleanerFor)(value) })), {});
     return Object.assign(Object.assign({}, action), { key: actionKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
             inputCleaners,
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
@@ -84,17 +137,15 @@ const convertTrigger = (triggerKey, trigger, hooks) => {
     const { onInstanceDeploy, onInstanceDelete } = trigger;
     const webhookLifecycleHandlers = "webhookLifecycleHandlers" in trigger ? trigger.webhookLifecycleHandlers : undefined;
     const inputs = (_a = trigger.inputs) !== null && _a !== void 0 ? _a : {};
-    const isPollingTrigger = (0, PollingTriggerDefinition_1.isPollingTriggerDefinition)(trigger);
     const triggerInputKeys = Object.keys(inputs);
     const convertedTriggerInputs = Object.entries(inputs).map(([key, value]) => {
         return (0, exports.convertInput)(key, value);
     });
-    const triggerInputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
+    const triggerInputCleaners = Object.entries(inputs).reduce((result, [key, value]) => (Object.assign(Object.assign({}, result), { [key]: (0, exports.cleanerFor)(value) })), {});
     let scheduleSupport = "scheduleSupport" in trigger ? trigger.scheduleSupport : "invalid";
     let convertedActionInputs = [];
     let performToUse;
-    if (isPollingTrigger) {
-        // Pull inputs up from the action and make them available on the trigger
+    if ((0, PollingTriggerDefinition_1.isPollingTriggerDefinition)(trigger)) {
         const { pollAction: action } = trigger;
         let actionInputCleaners = {};
         scheduleSupport = "required";
@@ -106,7 +157,7 @@ const convertTrigger = (triggerKey, trigger, hooks) => {
                 accum.push((0, exports.convertInput)(key, value));
                 return accum;
             }, []);
-            actionInputCleaners = Object.entries(action.inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
+            actionInputCleaners = Object.entries(action.inputs).reduce((result, [key, value]) => (Object.assign(Object.assign({}, result), { [key]: (0, exports.cleanerFor)(value) })), {});
         }
         const combinedCleaners = Object.assign({}, actionInputCleaners, triggerInputCleaners);
         performToUse = (0, perform_1.createPollingPerform)(trigger, {
@@ -124,7 +175,7 @@ const convertTrigger = (triggerKey, trigger, hooks) => {
             ? trigger.synchronousResponseSupport
             : scheduleSupport === "invalid"
                 ? "valid"
-                : "invalid" }), (isPollingTrigger ? { isPollingTrigger: true } : {}));
+                : "invalid" }), ((0, PollingTriggerDefinition_1.isPollingTriggerDefinition)(trigger) ? { isPollingTrigger: true } : {}));
     if (onInstanceDeploy) {
         result.onInstanceDeploy = (0, perform_1.createPerform)(onInstanceDeploy, {
             inputCleaners: triggerInputCleaners,
@@ -158,7 +209,7 @@ exports.convertTrigger = convertTrigger;
 const convertDataSource = (dataSourceKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, dataSource = __rest(_a, ["inputs", "perform"]);
     const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
-    const inputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
+    const inputCleaners = Object.entries(inputs).reduce((result, [key, value]) => (Object.assign(Object.assign({}, result), { [key]: (0, exports.cleanerFor)(value) })), {});
     return Object.assign(Object.assign({}, dataSource), { key: dataSourceKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
             inputCleaners,
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,

package/dist/serverTypes/index.d.ts

@@ -262,5 +262,8 @@ export interface Input {
     onPremiseControlled?: boolean;
     dataSource?: string;
     shown?: boolean;
+    /** Nested children. For `structuredObject`, the declared inputs; for
+     * `dynamicObject`, one `structuredObject` per configuration. */
+    inputs?: Input[];
 }
 export * from "./asyncContext";

package/dist/types/ActionInputParameters.d.ts

@@ -1,11 +1,40 @@
 import type { ConditionalExpression } from "./conditional-logic";
-import type { Connection, InputCleanFunction, InputFieldCollection, Inputs, KeyValuePair } from "./Inputs";
+import type { Connection, DynamicObjectInputField, InputCleanFunction, InputFieldCollection, Inputs, KeyValuePair, StructuredObjectInputField } from "./Inputs";
+/** Resolves a single InputFieldDefinition's runtime value type.
+ * - structuredObject: record of declared children's resolved value types.
+ * - dynamicObject: discriminated union keyed by the selected configuration,
+ *   with the configuration's resolved inputs nested under `values` to avoid
+ *   collisions with the `configuration` discriminant key.
+ * The depth caps (`LeafInputFieldDefinition`, `StructuredOrLeafInputFieldDefinition`)
+ * prevent unbounded recursion. */
+type InputValue<T> = T extends StructuredObjectInputField ? {
+    [K in keyof T["inputs"]]: InputValue<T["inputs"][K]>;
+} : T extends DynamicObjectInputField ? {
+    [C in keyof T["configurations"]]: {
+        configuration: C;
+        values: {
+            [K in keyof T["configurations"][C]["inputs"]]: InputValue<T["configurations"][C]["inputs"][K]>;
+        };
+    };
+}[keyof T["configurations"]] : T extends {
+    clean: InputCleanFunction<any>;
+} ? ReturnType<T["clean"]> : T extends {
+    type: "connection";
+    collection?: InputFieldCollection;
+} ? ExtractValue<Connection, T["collection"]> : T extends {
+    type: "conditional";
+    collection?: InputFieldCollection;
+} ? ExtractValue<ConditionalExpression, T["collection"]> : T extends {
+    default?: unknown;
+    collection?: InputFieldCollection;
+} ? ExtractValue<T["default"], T["collection"]> : unknown;
 /**
  * Collection of input parameters.
  * Inputs can be static values, references to config variables, or
  * references to previous steps' outputs.
  */
 export type ActionInputParameters<TInputs extends Inputs> = {
-    [Property in keyof TInputs]: TInputs[Property]["clean"] extends InputCleanFunction<any> ? ReturnType<TInputs[Property]["clean"]> : TInputs[Property]["type"] extends "connection" ? ExtractValue<Connection, TInputs[Property]["collection"]> : TInputs[Property]["type"] extends "conditional" ? ExtractValue<ConditionalExpression, TInputs[Property]["collection"]> : ExtractValue<TInputs[Property]["default"], TInputs[Property]["collection"]>;
+    [Property in keyof TInputs]: InputValue<TInputs[Property]>;
 };
 export type ExtractValue<TType, TCollection extends InputFieldCollection | undefined> = TCollection extends "keyvaluelist" ? KeyValuePair<TType>[] : TCollection extends "valuelist" ? TType[] : TType;
+export {};

package/dist/types/Inputs.d.ts

@@ -63,6 +63,8 @@ export type JSONForm = {
 };
 export type DynamicObjectSelection = string;
 export type DynamicFieldSelection = string;
+export type StructuredObject = Record<string, unknown>;
+export type DynamicObject = Record<string, unknown>;
 /** InputField type enumeration. */
 export type InputFieldType = InputFieldDefinition["type"];
 export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;
@@ -83,7 +85,7 @@ export type OnPremConnectionInput = {
      */
     onPremControlled: true;
 } & ConnectionInput;
-export type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ConnectionTemplateInputField | ObjectSelectionInputField | ObjectFieldMapInputField | JSONFormInputField | DynamicObjectSelectionInputField | DynamicFieldSelectionInputField | DateInputField | DateTimeInputField | FlowInputField;
+export type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ConnectionTemplateInputField | ObjectSelectionInputField | ObjectFieldMapInputField | JSONFormInputField | DynamicObjectSelectionInputField | DynamicFieldSelectionInputField | DateInputField | DateTimeInputField | FlowInputField | StructuredObjectInputField | DynamicObjectInputField;
 export type InputCleanFunction<TValue, TResult = TValue> = (value: TValue) => TResult;
 interface BaseInputField {
     /** Name of this field to present in the UI. */
@@ -289,6 +291,48 @@ export type DateTimeInputField = BaseInputField & {
     /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
+/** `InputFieldDefinition` minus container input types; used to cap
+ * structuredObject nesting at one level and to enforce leaf-only positions. */
+export type LeafInputFieldDefinition = Exclude<InputFieldDefinition, StructuredObjectInputField | DynamicObjectInputField>;
+/** `InputFieldDefinition` minus `DynamicObjectInputField`; used inside a
+ * dynamicObject's `configurations.<key>.inputs` to allow leaves *and*
+ * structuredObject children while still rejecting nested dynamicObjects. */
+export type StructuredOrLeafInputFieldDefinition = Exclude<InputFieldDefinition, DynamicObjectInputField>;
+/** Groups related primitive inputs under a single named container.
+ * Nesting is capped at one level. */
+export type StructuredObjectInputField = Omit<BaseInputField, "dataSource"> & {
+    /** Data type the input will collect. */
+    type: "structuredObject";
+    /** Nested input fields keyed by their local key. */
+    inputs: Record<string, LeafInputFieldDefinition>;
+};
+/** A single configuration within a dynamicObject. Each configuration declares
+ * a labeled set of inputs that become available when this configuration is
+ * selected at runtime. */
+export interface DynamicObjectConfiguration {
+    /** Name of this configuration to present in the UI. */
+    label: {
+        key: string;
+        value: string;
+    } | string;
+    /** Additional text to give guidance to the user when this configuration is selected. */
+    comments?: string;
+    /** Inputs that become available when this configuration is selected. May
+     * include leaf inputs and structuredObject inputs; nested dynamicObjects
+     * are rejected at the type level. */
+    inputs: Record<string, StructuredOrLeafInputFieldDefinition>;
+}
+/** Presents a discriminated set of input groups; the user picks a configuration
+ * at integration-build time and that configuration's inputs become available.
+ * Nesting is capped: configurations may contain structuredObject children
+ * (depth-1) but never another dynamicObject. */
+export type DynamicObjectInputField = Omit<BaseInputField, "dataSource"> & {
+    /** Data type the input will collect. */
+    type: "dynamicObject";
+    /** Available configurations keyed by their local key (used as the
+     * runtime discriminant). */
+    configurations: Record<string, DynamicObjectConfiguration>;
+};
 /** Defines a single Choice option for a InputField. */
 export interface InputFieldChoice {
     /** Label to display for this Choice. */

package/dist/types/Inputs.js

@@ -19,4 +19,6 @@ exports.InputFieldDefaultMap = {
     timestamp: "",
     flow: "",
     template: "",
+    structuredObject: undefined,
+    dynamicObject: undefined,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.18.6",
+  "version": "10.18.7-preview.2",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": [
     "prismatic"