@prismatic-io/spectral 10.18.5 → 10.18.6-preview.0

package/dist/generators/componentManifest/getInputs.js

@@ -68,6 +68,9 @@ exports.INPUT_TYPE_MAP = {
     timestamp: "string",
     flow: "string",
     template: "string",
+    // TODO: emit a typed record matching the declared children once the
+    // code-native action-calling type generator handles structuredObject.
+    structuredObject: "unknown",
 };
 const getInputValueType = (input) => {
     const inputType = exports.INPUT_TYPE_MAP[input.type];

package/dist/index.d.ts

@@ -5,7 +5,7 @@
  */
 import { convertComponent } from "./serverTypes/convertComponent";
 import { convertIntegration } from "./serverTypes/convertIntegration";
-import { 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 { ActionDefinition, ActionPerformReturn, ComponentDefinition, ComponentManifest, ConfigPage, ConfigVarResultCollection, ConnectionConfigVar, CustomerActivatedConnectionConfigVar, DataSourceConfigVar, DataSourceDefinition, DataSourceType, DefaultConnectionDefinition, 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,27 @@ 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";
+};
 /**
  * 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.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,24 @@ 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;
 /**
  * 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,7 @@
 import { ComponentDefinition, ComponentHooks, ConfigVarResultCollection, ConnectionDefinition, ConnectionInput, ConnectionTemplateInputField, InputFieldDefinition, Inputs, OnPremConnectionInput, TriggerDefinition, TriggerPayload, TriggerResult } from "../types";
 import { PollingTriggerDefinition } from "../types/PollingTriggerDefinition";
 import { 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;
+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

@@ -19,16 +19,22 @@ 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 cleanerFor = (input) => "clean" in input ? input.clean : undefined;
+const convertInput = (key, definition) => {
+    // Cast: union members don't all carry `default`/`collection`/`inputs`;
+    // runtime guards below handle the differences.
+    const _a = definition, { default: defaultValue, type, label, collection, inputs: childInputs } = _a, rest = __rest(_a, ["default", "type", "label", "collection", "inputs"]);
     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))
+        : 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 +79,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]: 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 +90,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]: 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 +110,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]: cleanerFor(value) })), {});
         }
         const combinedCleaners = Object.assign({}, actionInputCleaners, triggerInputCleaners);
         performToUse = (0, perform_1.createPollingPerform)(trigger, {
@@ -124,7 +128,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 +162,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]: 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,7 @@ export interface Input {
     onPremiseControlled?: boolean;
     dataSource?: string;
     shown?: boolean;
+    /** Nested child inputs; populated only when `type === "structuredObject"`. */
+    inputs?: Input[];
 }
 export * from "./asyncContext";

package/dist/types/ActionInputParameters.d.ts

@@ -1,11 +1,26 @@
 import type { ConditionalExpression } from "./conditional-logic";
-import type { Connection, InputCleanFunction, InputFieldCollection, Inputs, KeyValuePair } from "./Inputs";
+import type { Connection, InputCleanFunction, InputFieldCollection, Inputs, KeyValuePair, StructuredObjectInputField } from "./Inputs";
+/** Resolves a single InputFieldDefinition's runtime value type. structuredObject
+ * resolves to `unknown` until the per-field record-type recursion lands. */
+type InputValue<T> = T extends StructuredObjectInputField ? unknown : 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

@@ -83,7 +83,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;
 export type InputCleanFunction<TValue, TResult = TValue> = (value: TValue) => TResult;
 interface BaseInputField {
     /** Name of this field to present in the UI. */
@@ -289,6 +289,17 @@ export type DateTimeInputField = BaseInputField & {
     /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
+/** `InputFieldDefinition` minus `StructuredObjectInputField`; used to cap
+ * structuredObject nesting at one level. */
+export type LeafInputFieldDefinition = Exclude<InputFieldDefinition, StructuredObjectInputField>;
+/** 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>;
+};
 /** 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,5 @@ exports.InputFieldDefaultMap = {
     timestamp: "",
     flow: "",
     template: "",
+    structuredObject: undefined,
 };

package/package.json

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