@prismatic-io/spectral 7.9.0 → 7.10.0

package/dist/types/ActionInputParameters.d.ts

@@ -1,6 +1,6 @@
 import { Inputs } from ".";
 import { ConditionalExpression } from "./conditional-logic";
-import { InputFieldCollection, InputCleanFunction, Connection } from "./Inputs";
+import { InputFieldCollection, InputCleanFunction, Connection, KeyValuePair } from "./Inputs";
 /**
  * Collection of input parameters.
  * Inputs can be static values, references to config variables, or
@@ -10,16 +10,3 @@ export declare 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"]>;
 };
 export declare type ExtractValue<TType, TCollection extends InputFieldCollection | undefined> = TCollection extends "keyvaluelist" ? KeyValuePair<TType>[] : TCollection extends "valuelist" ? TType[] : TType;
-/**
- * KeyValuePair input parameter type.
- * This allows users to input multiple keys / values as an input.
- * To see an example of how this can be used, see the `tagging` input
- * of the `putObject` action of the AWS S3 component:
- * https://github.com/prismatic-io/examples/blob/main/components/aws-s3/src/actions.ts
- */
-export interface KeyValuePair<V = unknown> {
-    /** Key of the KeyValuePair */
-    key: string;
-    /** Value of the KeyValuePair */
-    value: V;
-}

package/dist/types/Inputs.d.ts

@@ -1,5 +1,18 @@
 import { ConditionalExpression } from "./conditional-logic";
 import { JsonSchema, UISchemaElement } from "@jsonforms/core";
+/**
+ * KeyValuePair input parameter type.
+ * This allows users to input multiple keys / values as an input.
+ * To see an example of how this can be used, see the `tagging` input
+ * of the `putObject` action of the AWS S3 component:
+ * https://github.com/prismatic-io/examples/blob/main/components/aws-s3/src/actions.ts
+ */
+export interface KeyValuePair<V = unknown> {
+    /** Key of the KeyValuePair */
+    key: string;
+    /** Value of the KeyValuePair */
+    value: V;
+}
 export declare type Element = {
     key: string;
     label?: string;
@@ -66,81 +79,76 @@ interface BaseInputField {
     /** Indicate if this InputField is required. */
     required?: boolean;
 }
-export interface StringInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
-    type: "string";
+declare type CollectionOptions<T> = SingleValue<T> | ValueListCollection<T> | KeyValueListCollection<T>;
+interface SingleValue<T> {
     /** Collection type of the InputField */
-    collection?: InputFieldCollection;
+    collection?: undefined;
     /** Default value for this field. */
-    default?: unknown;
+    default?: T;
+}
+interface ValueListCollection<T> {
+    /** Collection type of the InputField */
+    collection: "valuelist";
+    /** Default value for this field. */
+    default?: T[];
+}
+interface KeyValueListCollection<T> {
+    /** Collection type of the InputField */
+    collection: "keyvaluelist";
+    /** Default value for this field. */
+    default?: KeyValuePair<T>[];
+}
+export declare type StringInputField = BaseInputField & CollectionOptions<string> & {
+    /** Data type the InputField will collect. */
+    type: "string";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface DataInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type DataInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "data";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface TextInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type TextInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "text";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface PasswordInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type PasswordInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "password";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface BooleanInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type BooleanInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "boolean";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
+    clean?: InputCleanFunction<unknown>;
+};
 /** Defines attributes of a CodeInputField. */
-export interface CodeInputField extends BaseInputField {
+export declare type CodeInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "code";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Code language for syntax highlighting. For no syntax highlighting, choose "plaintext" */
     language: "css" | "graphql" | "handlebars" | "hcl" | "html" | "javascript" | "json" | "liquid" | "markdown" | "mysql" | "pgsql" | "plaintext" | "sql" | "typescript" | "xml" | "yaml";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
+    clean?: InputCleanFunction<unknown>;
+};
 /** Defines attributes of a ConditionalInputField. */
 export interface ConditionalInputField extends BaseInputField {
     /** Data type the InputField will collect. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "7.9.0",
+  "version": "7.10.0",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"