@interweave/interweave - npm Package Compare versions

Comparing version 0.0.15 to 0.0.16

dist/index.d.ts

@@ -1,6 +0,6 @@
-import { type Schema, type KeyConfiguration, type Request, type Error, type SchemaKeys, type Permissions, type PermissionValue, type Users, type DataSource } from "./interfaces";
+import { type Schema, type KeyConfiguration, type Request, type Error, type SchemaKeys, type Permissions, type PermissionValue, type Users, type DataSource, type Parameter } from "./interfaces";
 import { validate, type ExternalValidateOptions as ValidateOptions, type ErrorsReturnObject } from "./validate";
 import { validateSchema } from "./validateSchema";
 import { buildInterface } from "./sync";
-export { type Schema, type KeyConfiguration, type Request, type Error, type SchemaKeys, type Permissions, type PermissionValue, type Users, type DataSource, type ValidateOptions, type ErrorsReturnObject, };
+export { type Schema, type KeyConfiguration, type Request, type Error, type SchemaKeys, type Permissions, type PermissionValue, type Users, type DataSource, type Parameter, type ValidateOptions, type ErrorsReturnObject, };
 export { buildInterface, validate, validateSchema };

dist/interfaces.d.ts

@@ -207,51 +207,50 @@ export interface Error {
          */
-        [key: string]: {
-            schema: {
-                type: "string" | "number" | "boolean";
-                is_optional?: boolean;
-                is_array?: boolean;
-                enum?: string[] | number[];
-                default_value?: any;
-            };
-            interface?: {
-                form?: {
-                    /**
-                     * User-friendly name for the key
-                     * Will render on the form and the table's column
-                     */
-                    label?: string;
-                    /**
-                     * Placeholder text to render on the element
-                     */
-                    placeholder?: string;
-                    /**
-                     * Whether to hide this element from the interface
-                     * Hiding the element in the form will skip its validation client-side
-                     * Useful for fields that get set server-side like `id`
-                     */
-                    hidden?: boolean;
-                    /**
-                     * Whether a user can interact with this element or not
-                     */
-                    disabled?: boolean;
-                };
-            };
-            options?: {
-                /**
-                 * The source of the data
-                 */
-                data: DataSource;
-                /**
-                 * The unique identifier per entry
-                 * Useful if the data is an array of objects
-                 */
-                value_path?: string;
-                /**
-                 * The label to display in a dropdown
-                 * Useful if the data is an array of objects
-                 */
-                label_path?: string;
-            };
+        [key: string]: Parameter;
+    };
+}
+export interface Parameter {
+    schema: {
+        type: "string" | "number" | "boolean";
+        is_optional?: boolean;
+        is_array?: boolean;
+        enum?: string[] | number[];
+        default_value?: any;
+    };
+    interface?: {
+        form?: {
+            /**
+             * User-friendly name for the key
+             * Will render on the form and the table's column
+             */
+            label?: string;
+            /**
+             * Placeholder text to render on the element
+             */
+            placeholder?: string;
+            /**
+             * Text that will render near the input to provide context.
+             */
+            description?: string;
+            /**
+             * Whether a user can interact with this element or not
+             */
+            disabled?: boolean;
         };
     };
+    options?: {
+        /**
+         * The source of the data
+         */
+        data: DataSource;
+        /**
+         * The unique identifier per entry
+         * Useful if the data is an array of objects
+         */
+        value_path?: string;
+        /**
+         * The label to display in a dropdown
+         * Useful if the data is an array of objects
+         */
+        label_path?: string;
+    };
 }
@@ -258,0 +257,0 @@ export interface SchemaKeys {

package.json

 {
 	"name": "@interweave/interweave",
-	"version": "0.0.15",
+	"version": "0.0.16",
 	"description": "",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/index.ts

@@ -11,2 +11,3 @@ import {
 	type DataSource,
+	type Parameter,
 } from "./interfaces";
@@ -32,2 +33,3 @@ import {
 	type DataSource,
+	type Parameter,
 	// From validate()
@@ -34,0 +36,0 @@ type ValidateOptions,

src/interfaces.ts

@@ -229,53 +229,53 @@ export interface Error {
 		 */
-		[key: string]: {
-			schema: {
-				type: "string" | "number" | "boolean";
-				is_optional?: boolean;
-				is_array?: boolean;
-				enum?: string[] | number[];
-				default_value?: any;
-			};
+		[key: string]: Parameter;
+	};
+}
 
-			interface?: {
-				form?: {
-					/**
-					 * User-friendly name for the key
-					 * Will render on the form and the table's column
-					 */
-					label?: string;
-					/**
-					 * Placeholder text to render on the element
-					 */
-					placeholder?: string;
-					/**
-					 * Whether to hide this element from the interface
-					 * Hiding the element in the form will skip its validation client-side
-					 * Useful for fields that get set server-side like `id`
-					 */
-					hidden?: boolean;
-					/**
-					 * Whether a user can interact with this element or not
-					 */
-					disabled?: boolean;
-				};
-			};
+export interface Parameter {
+	schema: {
+		type: "string" | "number" | "boolean";
+		is_optional?: boolean;
+		is_array?: boolean;
+		enum?: string[] | number[];
+		default_value?: any;
+	};
 
-			options?: {
-				/**
-				 * The source of the data
-				 */
-				data: DataSource;
-				/**
-				 * The unique identifier per entry
-				 * Useful if the data is an array of objects
-				 */
-				value_path?: string;
-				/**
-				 * The label to display in a dropdown
-				 * Useful if the data is an array of objects
-				 */
-				label_path?: string;
-			};
+	interface?: {
+		form?: {
+			/**
+			 * User-friendly name for the key
+			 * Will render on the form and the table's column
+			 */
+			label?: string;
+			/**
+			 * Placeholder text to render on the element
+			 */
+			placeholder?: string;
+			/**
+			 * Text that will render near the input to provide context.
+			 */
+			description?: string;
+			/**
+			 * Whether a user can interact with this element or not
+			 */
+			disabled?: boolean;
 		};
 	};
+
+	options?: {
+		/**
+		 * The source of the data
+		 */
+		data: DataSource;
+		/**
+		 * The unique identifier per entry
+		 * Useful if the data is an array of objects
+		 */
+		value_path?: string;
+		/**
+		 * The label to display in a dropdown
+		 * Useful if the data is an array of objects
+		 */
+		label_path?: string;
+	};
 }
@@ -282,0 +282,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

92269

decreased by-0.63%

No dependency changes