@prismatic-io/spectral 5.2.1 → 5.3.0

package/dist/index.js

@@ -14,12 +14,31 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testing = exports.util = exports.oauth2Connection = exports.connection = exports.input = exports.trigger = exports.action = exports.component = void 0;
-const convertInput = (key, input) => (Object.assign(Object.assign({}, input), { key }));
+/**
+ * Both component author-facing types and server types that
+ * the Prismatic API expects are imported here.
+ */
+const types_1 = require("./types");
+const convertInput = (key, _a) => {
+    var { default: defaultValue, type } = _a, rest = __rest(_a, ["default", "type"]);
+    return (Object.assign(Object.assign({}, rest), { type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], key }));
+};
 /**
  * This is a helper function for component() to convert an
  * action defined in TypeScript into an action object that

package/dist/types/InputFieldType.d.ts

@@ -12,3 +12,4 @@ export declare type InputFieldTypeMap = {
     conditional: ConditionalExpression;
     connection: Connection;
 };
+export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;

package/dist/types/InputFieldType.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputFieldDefaultMap = void 0;
+exports.InputFieldDefaultMap = {
+    string: "",
+    data: "",
+    text: "",
+    password: "",
+    boolean: "false",
+    code: "",
+    conditional: undefined,
+    connection: undefined,
+};

package/dist/types/Inputs.d.ts

@@ -1,10 +1,12 @@
-import { InputFieldType } from ".";
+import { InputFieldDefaultMap, InputFieldType } from ".";
 export declare type Inputs = Record<string, InputFieldDefinition>;
 export declare type ConnectionInput = DefaultInputFieldDefinition & {
     shown?: boolean;
 };
 export declare type InputFieldDefinition = DefaultInputFieldDefinition | CodeInputFieldDefinition | ConditionalInputField | ConnectionInputField;
 interface BaseInputFieldDefinition {
+    /** Data type the InputField will collect. */
+    type: InputFieldType;
     /** Interface label of the InputField. */
     label: string;
     /** Collection type of the InputField */
@@ -12,7 +14,7 @@ interface BaseInputFieldDefinition {
     /** Text to show as the InputField placeholder. */
     placeholder?: string;
     /** Default value for this field. */
-    default?: string;
+    default?: typeof InputFieldDefaultMap[this["type"]];
     /** Additional text to give guidance to the user configuring the InputField. */
     comments?: string;
     /** Example valid input for this InputField. */

package/dist/types/server-types.d.ts

@@ -6,7 +6,7 @@
  */
 /// <reference types="node" />
 /** Import shared types from types/ */
-import { OAuth2Type } from ".";
+import { OAuth2Type, InputFieldType, InputFieldDefaultMap } from ".";
 import { ActionContext } from "./ActionPerformFunction";
 import { ActionDisplayDefinition, ComponentDisplayDefinition } from "./DisplayDefinition";
 import { InputFieldChoice, InputFieldCollection } from "./Inputs";
@@ -146,7 +146,7 @@ interface DefaultInputField {
     /** Text to show as the InputField placeholder. */
     placeholder?: string;
     /** Default value for this field. */
-    default?: string;
+    default?: typeof InputFieldDefaultMap[this["type"]];
     /** Additional text to give guidance to the user configuring the InputField. */
     comments?: string;
     /** Example valid input for this InputField. */
@@ -160,8 +160,6 @@ interface CodeInputField extends DefaultInputField {
     type: "code";
     language?: string;
 }
-/** InputField type enumeration. */
-export declare type InputFieldType = "string" | "text" | "password" | "boolean" | "code" | "data" | "conditional" | "connection";
 /** Binary data payload */
 export interface DataPayload {
     /** Raw binary data as a Buffer */

package/package.json

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