@prismatic-io/spectral 10.5.0 → 10.5.2

package/dist/types/TriggerPayload.d.ts

@@ -1,23 +1,27 @@
 import { InstanceAttributes, CustomerAttributes, UserAttributes, IntegrationAttributes, FlowAttributes } from ".";
 /** Represents a Trigger Payload, which is data passed into a Trigger to invoke an Integration execution. */
 export interface TriggerPayload {
+    /** The headers sent in the webhook request. */
     headers: {
         [key: string]: string;
     };
+    /** The search parameters included in the URL of the webhook request. */
     queryParameters: {
         [key: string]: string;
     };
+    /** The unparsed body of the webhook request. */
     rawBody: {
         data: unknown;
         contentType?: string;
     };
+    /** The parsed body of the webhook request. */
     body: {
         data: unknown;
         contentType?: string;
     };
-    /** Extended path information from the webhook trigger */
+    /** Extended path information from the webhook trigger. */
     pathFragment: string;
-    /** The webhook URLs assigned to this integration's flows upon instance deploy */
+    /** The webhook URLs assigned to this integration's flows upon instance deploy. */
     webhookUrls: {
         [key: string]: string;
     };

package/dist/types/TriggerResult.d.ts

@@ -4,15 +4,15 @@ import { HttpResponse } from "./HttpResponse";
 export interface TriggerBaseResult<TPayload extends TriggerPayload> {
     /** The payload in the request that invoked the Integration, which is returned as a result for later use. */
     payload: TPayload;
-    /** Optional HTTP response to the request that invoked the integration. */
+    /** HTTP response to the request that invoked the integration. */
     response?: HttpResponse;
-    /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions. */
     instanceState?: Record<string, unknown>;
-    /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions. */
     crossFlowState?: Record<string, unknown>;
-    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
+    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution. */
     executionState?: Record<string, unknown>;
-    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions. */
     integrationState?: Record<string, unknown>;
     /** A field populated by the Prismatic platform which indicates whether the trigger failed with an error during execution. */
     failed?: boolean;
@@ -26,5 +26,5 @@ export interface TriggerBranchingResult<TPayload extends TriggerPayload> extends
     /** Name of the Branch to take. */
     branch: string;
 }
-/** Required return type of all trigger perform functions */
+/** Required return type of all trigger perform functions. */
 export type TriggerResult<AllowsBranching extends boolean | undefined, TPayload extends TriggerPayload> = (AllowsBranching extends true ? TriggerBranchingResult<TPayload> : TriggerBaseResult<TPayload>) | undefined;

package/dist/types/UserAttributes.d.ts

@@ -1,7 +1,17 @@
-/** Contains attributes of the User for whom a User Level Configuration is being used. */
+/**
+ * Contains attributes of the User whose user-level configuration is being used. See
+ * https://prismatic.io/docs/integrations/config-wizard/user-level-configuration/
+ */
 export interface UserAttributes {
+    /** Programmatic ID of the user whose user-level configuration is being used. */
     id: string;
+    /** The email address (or embedded ID) of the user whose user-level configuration is being used. */
     email: string;
+    /** The name of the user whose user-level configuration is being used. */
     name: string;
+    /**
+     * The external ID you assign to the user whose user-level configuration is being used. See
+     * https://prismatic.io/docs/embed/authenticate-users/#create-and-sign-a-jwt
+     */
     externalId: string;
 }

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.0",
+  "version": "10.5.2",
   "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"
   }
 }