@prismatic-io/spectral 10.5.1 → 10.5.3

package/dist/serverTypes/convertComponent.d.ts

@@ -1,8 +1,16 @@
-import { InputFieldDefinition, ComponentDefinition, ConnectionDefinition, TriggerDefinition, ComponentHooks, ConfigVarResultCollection, OnPremConnectionInput, TriggerPayload, ConnectionTemplateInputField } from "../types";
+import { InputFieldDefinition, ComponentDefinition, ConnectionDefinition, TriggerDefinition, ComponentHooks, ConfigVarResultCollection, OnPremConnectionInput, TriggerPayload, ConnectionTemplateInputField, ConnectionInput } from "../types";
 import { Component as ServerComponent, Connection as ServerConnection, Trigger as ServerTrigger, Input as ServerInput } from ".";
 import { PollingTriggerDefinition } from "../types/PollingTriggerDefinition";
 export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition | OnPremConnectionInput) => ServerInput;
-export declare const convertTemplateInput: (key: string, { templateValue, label, ...rest }: ConnectionTemplateInputField) => ServerInput;
+export declare const _isValidTemplateValue: (template: string, inputs: {
+    [key: string]: ConnectionInput | ConnectionTemplateInputField;
+}) => {
+    isValid: boolean;
+    error?: string;
+};
+export declare const convertTemplateInput: (key: string, { templateValue, label, ...rest }: ConnectionTemplateInputField, inputs: {
+    [key: string]: ConnectionInput | ConnectionTemplateInputField;
+}) => ServerInput;
 export declare const convertTrigger: (triggerKey: string, trigger: TriggerDefinition<any> | PollingTriggerDefinition<any, ConfigVarResultCollection, TriggerPayload, boolean, any, any>, hooks?: ComponentHooks) => ServerTrigger;
 export declare const convertConnection: ({ inputs, ...connection }: ConnectionDefinition) => ServerConnection;
 export declare const convertComponent: <TPublic extends boolean, TKey extends string>({ connections, actions, triggers, dataSources, hooks, ...definition }: ComponentDefinition<TPublic, TKey>) => ServerComponent;

package/dist/serverTypes/convertComponent.js

@@ -14,7 +14,7 @@ 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.convertInput = void 0;
+exports.convertComponent = exports.convertConnection = exports.convertTrigger = exports.convertTemplateInput = exports._isValidTemplateValue = exports.convertInput = void 0;
 const types_1 = require("../types");
 const perform_1 = require("./perform");
 const omit_1 = __importDefault(require("lodash/omit"));
@@ -31,8 +31,42 @@ const convertInput = (key, _a) => {
         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 });
 };
 exports.convertInput = convertInput;
-const convertTemplateInput = (key, _a) => {
+const TEMPLATE_VALUE_REGEX = /{{#(\w+)}}/g;
+const TEMPLATE_VALUE_ERRORS = {
+    NO_SLOTS: "No template slots were found. Declare a template slot with this notation: {{#someInputKey}}",
+    INVALID_KEYS: "Invalid keys were found in the template string. All referenced keys must be non-template inputs declared in the first argument:",
+};
+const _isValidTemplateValue = (template, inputs) => {
+    const matches = [...template.matchAll(TEMPLATE_VALUE_REGEX)];
+    if (matches.length === 0) {
+        return {
+            isValid: false,
+            error: TEMPLATE_VALUE_ERRORS.NO_SLOTS,
+        };
+    }
+    const invalidKeys = [];
+    for (const [_substr, key] of matches) {
+        if (!inputs[key] || inputs[key].type === "template") {
+            invalidKeys.push(key);
+        }
+    }
+    if (invalidKeys.length > 0) {
+        return {
+            isValid: false,
+            error: `${TEMPLATE_VALUE_ERRORS.INVALID_KEYS} ${invalidKeys}`,
+        };
+    }
+    return {
+        isValid: true,
+    };
+};
+exports._isValidTemplateValue = _isValidTemplateValue;
+const convertTemplateInput = (key, _a, inputs) => {
     var { templateValue, label } = _a, rest = __rest(_a, ["templateValue", "label"]);
+    const validation = (0, exports._isValidTemplateValue)(templateValue, inputs);
+    if (!validation.isValid) {
+        throw `Template input "${key}": ${validation.error}`;
+    }
     return Object.assign(Object.assign({}, (0, omit_1.default)(rest, ["permissionAndVisibilityType", "visibleToOrgDeployer", "writeOnly"])), { key, type: "template", default: templateValue !== null && templateValue !== void 0 ? templateValue : "", label: typeof label === "string" ? label : label.value, shown: false });
 };
 exports.convertTemplateInput = convertTemplateInput;
@@ -122,7 +156,7 @@ const convertConnection = (_a) => {
     const { display: { label, icons, description: comments } } = connection, remaining = __rest(connection, ["display"]);
     const convertedInputs = Object.entries(inputs).map(([key, value]) => {
         if ("templateValue" in value) {
-            return (0, exports.convertTemplateInput)(key, value);
+            return (0, exports.convertTemplateInput)(key, value, inputs);
         }
         return (0, exports.convertInput)(key, value);
     });

package/dist/types/ConfigVars.d.ts

@@ -1,4 +1,4 @@
-import { ValidationMode } from "@jsonforms/core";
+import { ValidationMode } from "./jsonforms/ValidationMode";
 import { type DataSourceDefinition, type ConnectionDefinition, type Inputs, type DataSourceType, type Connection, type JSONForm, type ObjectFieldMap, type ObjectSelection, type ConfigVarResultCollection, type Schedule, type CollectionDataSourceType, type DataSourceReference, type ConfigPage, type ConfigPages, type ConfigPageElement, type ComponentRegistryDataSource, type ComponentRegistryConnection, type UserLevelConfigPages, type OrganizationActivatedConnectionConfigVar, type ScopedConfigVarMap } from ".";
 import type { Prettify, UnionToIntersection } from "./utils";
 /** Supported data types for config variables. */

package/dist/types/Inputs.d.ts

@@ -1,5 +1,6 @@
 import { ConditionalExpression } from "./conditional-logic";
-import { JsonSchema, UISchemaElement } from "@jsonforms/core";
+import { JsonSchema } from "./jsonforms/JsonSchema";
+import { UISchemaElement } from "./jsonforms/UISchemaElement";
 /**
  * KeyValuePair input parameter type.
  * This allows users to input multiple keys / values as an input.

package/dist/types/jsonforms/JsonSchema.d.ts

@@ -0,0 +1,231 @@
+export type JsonSchema = JsonSchema4 | JsonSchema7;
+interface JsonSchema4 {
+    $ref?: string;
+    /**
+     * This is important because it tells refs where
+     * the root of the document is located
+     */
+    id?: string;
+    /**
+     * It is recommended that the meta-schema is
+     * included in the root of any JSON Schema
+     */
+    $schema?: string;
+    /**
+     * Title of the schema
+     */
+    title?: string;
+    /**
+     * Schema description
+     */
+    description?: string;
+    /**
+     * Default json for the object represented by
+     * this schema
+     */
+    default?: any;
+    /**
+     * The value must be a multiple of the number
+     * (e.g. 10 is a multiple of 5)
+     */
+    multipleOf?: number;
+    maximum?: number;
+    /**
+     * If true maximum must be > value, >= otherwise
+     */
+    exclusiveMaximum?: boolean;
+    minimum?: number;
+    /**
+     * If true minimum must be < value, <= otherwise
+     */
+    exclusiveMinimum?: boolean;
+    maxLength?: number;
+    minLength?: number;
+    /**
+     * This is a regex string that the value must
+     * conform to
+     */
+    pattern?: string;
+    additionalItems?: boolean | JsonSchema4;
+    items?: JsonSchema4 | JsonSchema4[];
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxProperties?: number;
+    minProperties?: number;
+    required?: string[];
+    additionalProperties?: boolean | JsonSchema4;
+    /**
+     * Holds simple JSON Schema definitions for
+     * referencing from elsewhere.
+     */
+    definitions?: {
+        [key: string]: JsonSchema4;
+    };
+    /**
+     * The keys that can exist on the object with the
+     * json schema that should validate their value
+     */
+    properties?: {
+        [property: string]: JsonSchema4;
+    };
+    /**
+     * The key of this object is a regex for which
+     * properties the schema applies to
+     */
+    patternProperties?: {
+        [pattern: string]: JsonSchema4;
+    };
+    /**
+     * If the key is present as a property then the
+     * string of properties must also be present.
+     * If the value is a JSON Schema then it must
+     * also be valid for the object if the key is
+     * present.
+     */
+    dependencies?: {
+        [key: string]: JsonSchema4 | string[];
+    };
+    /**
+     * Enumerates the values that this schema can be
+     * e.g.
+     * {"type": "string",
+     *  "enum": ["red", "green", "blue"]}
+     */
+    enum?: any[];
+    /**
+     * The basic type of this schema, can be one of
+     * [string, number, object, array, boolean, null]
+     * or an array of the acceptable types
+     */
+    type?: string | string[];
+    allOf?: JsonSchema4[];
+    anyOf?: JsonSchema4[];
+    oneOf?: JsonSchema4[];
+    /**
+     * The entity being validated must not match this schema
+     */
+    not?: JsonSchema4;
+    format?: string;
+    const?: any;
+}
+interface JsonSchema7 {
+    $ref?: string;
+    /**
+     * This is important because it tells refs where
+     * the root of the document is located
+     */
+    $id?: string;
+    /**
+     * It is recommended that the meta-schema is
+     * included in the root of any JSON Schema
+     */
+    $schema?: string;
+    /**
+     * Title of the schema
+     */
+    title?: string;
+    /**
+     * Schema description
+     */
+    description?: string;
+    /**
+     * Default json for the object represented by
+     * this schema
+     */
+    default?: any;
+    /**
+     * The value must be a multiple of the number
+     * (e.g. 10 is a multiple of 5)
+     */
+    multipleOf?: number;
+    maximum?: number;
+    /**
+     * If true maximum must be > value, >= otherwise
+     */
+    exclusiveMaximum?: number;
+    minimum?: number;
+    /**
+     * If true minimum must be < value, <= otherwise
+     */
+    exclusiveMinimum?: number;
+    maxLength?: number;
+    minLength?: number;
+    /**
+     * This is a regex string that the value must
+     * conform to
+     */
+    pattern?: string;
+    additionalItems?: boolean | JsonSchema7;
+    items?: JsonSchema7 | JsonSchema7[];
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxProperties?: number;
+    minProperties?: number;
+    required?: string[];
+    additionalProperties?: boolean | JsonSchema7;
+    /**
+     * Holds simple JSON Schema definitions for
+     * referencing from elsewhere.
+     */
+    definitions?: {
+        [key: string]: JsonSchema7;
+    };
+    /**
+     * The keys that can exist on the object with the
+     * json schema that should validate their value
+     */
+    properties?: {
+        [property: string]: JsonSchema7;
+    };
+    /**
+     * The key of this object is a regex for which
+     * properties the schema applies to
+     */
+    patternProperties?: {
+        [pattern: string]: JsonSchema7;
+    };
+    /**
+     * If the key is present as a property then the
+     * string of properties must also be present.
+     * If the value is a JSON Schema then it must
+     * also be valid for the object if the key is
+     * present.
+     */
+    dependencies?: {
+        [key: string]: JsonSchema7 | string[];
+    };
+    /**
+     * Enumerates the values that this schema can be
+     * e.g.
+     * {"type": "string",
+     *  "enum": ["red", "green", "blue"]}
+     */
+    enum?: any[];
+    /**
+     * The basic type of this schema, can be one of
+     * [string, number, object, array, boolean, null]
+     * or an array of the acceptable types
+     */
+    type?: string | string[];
+    allOf?: JsonSchema7[];
+    anyOf?: JsonSchema7[];
+    oneOf?: JsonSchema7[];
+    /**
+     * The entity being validated must not match this schema
+     */
+    not?: JsonSchema7;
+    format?: string;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    examples?: any[];
+    contains?: JsonSchema7;
+    propertyNames?: JsonSchema7;
+    const?: any;
+    if?: JsonSchema7;
+    then?: JsonSchema7;
+    else?: JsonSchema7;
+    errorMessage?: any;
+}
+export {};

package/dist/types/jsonforms/JsonSchema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/jsonforms/UISchemaElement.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Common base interface for any UI schema element.
+ */
+export interface UISchemaElement {
+    /**
+     * The type of this UI schema element.
+     */
+    type: string;
+    /**
+     * An optional rule.
+     */
+    rule?: Rule;
+    /**
+     * Any additional options.
+     */
+    options?: {
+        [key: string]: any;
+    };
+}
+/**
+ * A rule that may be attached to any UI schema element.
+ */
+interface Rule {
+    /**
+     * The effect of the rule
+     */
+    effect: RuleEffect;
+    /**
+     * The condition of the rule that must evaluate to true in order
+     * to trigger the effect.
+     */
+    condition: Condition;
+}
+/**
+ * The different rule effects.
+ */
+declare enum RuleEffect {
+    /**
+     * Effect that hides the associated element.
+     */
+    HIDE = "HIDE",
+    /**
+     * Effect that shows the associated element.
+     */
+    SHOW = "SHOW",
+    /**
+     * Effect that enables the associated element.
+     */
+    ENABLE = "ENABLE",
+    /**
+     * Effect that disables the associated element.
+     */
+    DISABLE = "DISABLE"
+}
+/**
+ * Represents a condition to be evaluated.
+ */
+interface Condition {
+    /**
+     * The type of condition.
+     */
+    readonly type?: string;
+}
+export {};

package/dist/types/jsonforms/UISchemaElement.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * The different rule effects.
+ */
+var RuleEffect;
+(function (RuleEffect) {
+    /**
+     * Effect that hides the associated element.
+     */
+    RuleEffect["HIDE"] = "HIDE";
+    /**
+     * Effect that shows the associated element.
+     */
+    RuleEffect["SHOW"] = "SHOW";
+    /**
+     * Effect that enables the associated element.
+     */
+    RuleEffect["ENABLE"] = "ENABLE";
+    /**
+     * Effect that disables the associated element.
+     */
+    RuleEffect["DISABLE"] = "DISABLE";
+})(RuleEffect || (RuleEffect = {}));

package/dist/types/jsonforms/ValidationMode.d.ts

@@ -0,0 +1 @@
+export type ValidationMode = "ValidateAndShow" | "ValidateAndHide" | "NoValidation";

package/dist/types/jsonforms/ValidationMode.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.5.1",
+  "version": "10.5.3",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",
@@ -33,12 +33,10 @@
     "format": "yarn run lint-fix && biome format --write .",
     "check-format": "biome format .",
     "check": "yarn run check-format && yarn run lint",
-    "test": "jest",
-    "docs": "rm -f sidebars.{js,jse} && typedoc"
+    "test": "jest"
   },
   "files": ["dist/"],
   "dependencies": {
-    "@jsonforms/core": "3.0.0",
     "axios": "1.8.3",
     "axios-retry": "4.5.0",
     "date-fns": "2.30.0",
@@ -71,9 +69,6 @@
     "fast-check": "2.16.0",
     "jest": "29.7.0",
     "ts-jest": "29.1.2",
-    "typedoc": "0.17.7",
-    "typedoc-plugin-markdown": "2.4.2",
-    "typedoc-plugin-remove-references": "0.0.5",
     "typescript": "5.5.3"
   }
 }