@prismatic-io/spectral 7.3.4 → 7.3.6

package/dist/types/DisplayDefinition.d.ts

@@ -8,14 +8,15 @@ interface DisplayDefinition {
     /** Description to display to the user. */
     description: string;
 }
-interface ExtraDisplayDefinitionFields {
+declare type PublicComponentCategory = "Application Connectors" | "Data Platforms" | "Helpers" | "Logic" | "Triggers";
+interface ExtraDisplayDefinitionFields<TPublic extends boolean> {
     /** Path to icon to use for this Component. Path should be relative to the built component source. */
     iconPath: string;
     /** Category of the Component. */
-    category?: string;
+    category?: TPublic extends true ? PublicComponentCategory : string;
 }
 /** Component extensions for display properties. */
-export declare type ComponentDisplayDefinition<T extends boolean> = T extends true ? DisplayDefinition & Required<ExtraDisplayDefinitionFields> : DisplayDefinition & ExtraDisplayDefinitionFields;
+export declare type ComponentDisplayDefinition<TPublic extends boolean> = TPublic extends true ? DisplayDefinition & Required<ExtraDisplayDefinitionFields<TPublic>> : DisplayDefinition & ExtraDisplayDefinitionFields<TPublic>;
 /** Action-specific Display attributes. */
 export interface ActionDisplayDefinition extends DisplayDefinition {
     /** Directions to help guide the user if additional configuration is required for this Action. */

package/dist/types/Inputs.d.ts

@@ -1,4 +1,5 @@
 import { ConditionalExpression } from "./conditional-logic";
+import { JsonSchema, UISchemaElement } from "@jsonforms/core";
 export declare type Element = {
     key: string;
     label?: string;
@@ -22,9 +23,22 @@ export declare type ObjectFieldMap = {
     }[];
 };
 export declare type JSONForm = {
-    schema: Record<string, unknown>;
-    uiSchema: Record<string, unknown>;
-    data: unknown;
+    /**
+     * The data/JSON schema defines the underlying data to
+     * be shown in the UI (objects, properties, and their
+     * types). See https://jsonforms.io/docs
+     */
+    schema: JsonSchema;
+    /**
+     * The UI schema defines how this data is rendered as a
+     * form, e.g. the order of controls, their visibility,
+     * and the layout. See https://jsonforms.io/docs/uischema/
+     */
+    uiSchema: UISchemaElement;
+    /**
+     * Optional default data to use in the inputs of your form
+     */
+    data?: Record<string, unknown>;
 };
 export declare type DynamicObjectSelection = string;
 export declare type DynamicFieldSelection = string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "7.3.4",
+  "version": "7.3.6",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -37,6 +37,7 @@
     "dist/"
   ],
   "dependencies": {
+    "@jsonforms/core": "3.0.0",
     "axios": "0.27.2",
     "axios-retry": "3.2.5",
     "date-fns": "2.28.0",