@decaf-ts/ui-decorators 0.17.1 → 0.17.3

package/lib/types/ui/interfaces/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./IDecafModal.d.mts";
+export * from "./IDecafToast.d.mts";
+export * from "./IDecafSpinner.d.mts";
+export * from "./IDecafRouter.d.mts";

package/lib/types/ui/types.d.cts

@@ -9,6 +9,10 @@
 import { OperationKeys } from "@decaf-ts/db-decorators";
 import { ElementSizes, UIKeys, UIMediaBreakPoints } from "./constants.d.cts";
 import { DecafEventHandler } from "./DecafEventHandler.d.cts";
+import { DecafComponent } from "./DecafComponent.d.cts";
+import { Model } from "@decaf-ts/decorator-validation";
+import { RenderingEngine } from "./Rendering.d.cts";
+import { CrudOperations } from "@decaf-ts/db-decorators";
 /**
  * @description Interface for defining a UI field or component
  * @summary Represents a renderable UI element with properties and children
@@ -167,6 +171,7 @@ export type UIClassMetadata = UILayoutMetadata | UIModelMetadata | UIHandlerMeta
 export type UILayoutCol = number | typeof ElementSizes.half | typeof ElementSizes.full | typeof ElementSizes.auto | typeof ElementSizes.expand;
 export type UIListItemPosition = "title" | "description" | "info" | "subinfo";
 export type UIFunctionLike = (...args: any[]) => any | Promise<any>;
+export type UIEventHandler = (instance: DecafComponent<Model>, renderEngine: RenderingEngine, ...args: any[]) => any | Promise<any>;
 export type UIEventName = keyof Pick<DecafEventHandler, "render" | "initialize" | "handleClick" | "refresh">;
 export type UIEventProperty = Record<string, UIFunctionLike>;
 export type UIHandlerMetadata = {
@@ -183,4 +188,93 @@ export type UILayoutPropMetadata = {
         row: number | string[];
     };
 };
+/**
+ * @description Dismissal role returned by toast actions.
+ * @summary Represents the role reported when a toast is closed, including the
+ * default cancel role, custom roles, or an undefined result when no role is set.
+ *
+ * @typedef {('cancel' | string | undefined)} DecafToastRole
+ * @memberOf module:ui-decorators
+ */
+export type DecafToastRole = "cancel" | string | undefined;
 export type UIMediaBreakPointsType = UIMediaBreakPoints.SMALL | UIMediaBreakPoints.MEDIUM | UIMediaBreakPoints.LARGE | UIMediaBreakPoints.XLARGE;
+export type DecafSpinnerOptions = {
+    cssClass?: string;
+    duration?: number;
+    message?: string;
+    [key: string]: any;
+};
+export interface DecafModalOptions<T extends DecafComponent<Model>> {
+    component: T;
+    componentProps?: Partial<keyof DecafComponent<Model>> & Record<string, unknown>;
+    [key: string]: unknown;
+}
+export type DecafToastOptions = {
+    message: string;
+    duration: 3000;
+    position: "top" | "bottom" | "middle";
+    color?: string;
+    [key: string]: any;
+};
+/**
+ * @description Interfaces for UI form components
+ * @summary Defines interfaces for form fields with CRUD operations
+ * This module contains interfaces that extend basic field properties with
+ * CRUD operation information for form generation.
+ * @module ui/interfaces
+ * @memberOf module:ui-decorators
+ */
+/**
+ * @description Form field interface with CRUD operation information
+ * @summary Extends basic field properties with a specific CRUD operation
+ * This interface represents a form field that is associated with a specific
+ * CRUD operation (Create, Read, Update, Delete). It combines all the standard
+ * field properties with an operation property.
+ *
+ * @interface CrudFormField
+ * @extends FieldProperties
+ * @memberOf module:ui-decorators
+ *
+ * @property {CrudOperations} operation - The CRUD operation associated with this field
+ */
+export interface CrudFormField extends FieldProperties {
+    /**
+     * @description The CRUD operation associated with this field
+     * @summary Specifies which operation (Create, Read, Update, Delete) this field is for
+     */
+    operation: CrudOperations;
+}
+/**
+ * @description Interface for defining a page/step in a multi-step form or wizard
+ * @summary Provides metadata for individual pages in stepped model forms
+ * This interface represents a single page or step in a multi-step form workflow.
+ * It allows defining optional title and description metadata for each page,
+ * which can be used to display step indicators, progress bars, or navigation labels.
+ * Used in conjunction with the @uisteppedmodel decorator.
+ *
+ * @interface IPagedComponentProperties
+ * @memberOf module:ui-decorators
+ *
+ * @property {string} [title] - Optional title for the page/step (e.g., "Personal Information")
+ * @property {string} [description] - Optional description providing additional context for the page
+ *
+ * @example
+ * // Define pages for a multi-step wizard
+ * const wizardPages: IPagedComponentProperties[] = [
+ *   { title: 'Personal Info', description: 'Enter your basic details' },
+ *   { title: 'Contact', description: 'Provide your contact information' },
+ *   { title: 'Review', description: 'Review and confirm your information' }
+ * ];
+ *
+ * @uisteppedmodel('div', wizardPages, true)
+ * class RegistrationWizard extends Model {
+ *   // Properties with @uipageprop decorators
+ * }
+ */
+export interface IPagedComponentProperties {
+    title?: string;
+    description?: string;
+    pages?: number | IPagedComponentProperties[];
+    rows?: number | string[];
+    cols?: number | string[];
+}

package/lib/types/ui/types.d.mts

@@ -9,6 +9,10 @@
 import { OperationKeys } from "@decaf-ts/db-decorators";
 import { ElementSizes, UIKeys, UIMediaBreakPoints } from "./constants.d.mts";
 import { DecafEventHandler } from "./DecafEventHandler.d.mts";
+import { DecafComponent } from "./DecafComponent.d.mts";
+import { Model } from "@decaf-ts/decorator-validation";
+import { RenderingEngine } from "./Rendering.d.mts";
+import { CrudOperations } from "@decaf-ts/db-decorators";
 /**
  * @description Interface for defining a UI field or component
  * @summary Represents a renderable UI element with properties and children
@@ -167,6 +171,7 @@ export type UIClassMetadata = UILayoutMetadata | UIModelMetadata | UIHandlerMeta
 export type UILayoutCol = number | typeof ElementSizes.half | typeof ElementSizes.full | typeof ElementSizes.auto | typeof ElementSizes.expand;
 export type UIListItemPosition = "title" | "description" | "info" | "subinfo";
 export type UIFunctionLike = (...args: any[]) => any | Promise<any>;
+export type UIEventHandler = (instance: DecafComponent<Model>, renderEngine: RenderingEngine, ...args: any[]) => any | Promise<any>;
 export type UIEventName = keyof Pick<DecafEventHandler, "render" | "initialize" | "handleClick" | "refresh">;
 export type UIEventProperty = Record<string, UIFunctionLike>;
 export type UIHandlerMetadata = {
@@ -183,4 +188,93 @@ export type UILayoutPropMetadata = {
         row: number | string[];
     };
 };
+/**
+ * @description Dismissal role returned by toast actions.
+ * @summary Represents the role reported when a toast is closed, including the
+ * default cancel role, custom roles, or an undefined result when no role is set.
+ *
+ * @typedef {('cancel' | string | undefined)} DecafToastRole
+ * @memberOf module:ui-decorators
+ */
+export type DecafToastRole = "cancel" | string | undefined;
 export type UIMediaBreakPointsType = UIMediaBreakPoints.SMALL | UIMediaBreakPoints.MEDIUM | UIMediaBreakPoints.LARGE | UIMediaBreakPoints.XLARGE;
+export type DecafSpinnerOptions = {
+    cssClass?: string;
+    duration?: number;
+    message?: string;
+    [key: string]: any;
+};
+export interface DecafModalOptions<T extends DecafComponent<Model>> {
+    component: T;
+    componentProps?: Partial<keyof DecafComponent<Model>> & Record<string, unknown>;
+    [key: string]: unknown;
+}
+export type DecafToastOptions = {
+    message: string;
+    duration: 3000;
+    position: "top" | "bottom" | "middle";
+    color?: string;
+    [key: string]: any;
+};
+/**
+ * @description Interfaces for UI form components
+ * @summary Defines interfaces for form fields with CRUD operations
+ * This module contains interfaces that extend basic field properties with
+ * CRUD operation information for form generation.
+ * @module ui/interfaces
+ * @memberOf module:ui-decorators
+ */
+/**
+ * @description Form field interface with CRUD operation information
+ * @summary Extends basic field properties with a specific CRUD operation
+ * This interface represents a form field that is associated with a specific
+ * CRUD operation (Create, Read, Update, Delete). It combines all the standard
+ * field properties with an operation property.
+ *
+ * @interface CrudFormField
+ * @extends FieldProperties
+ * @memberOf module:ui-decorators
+ *
+ * @property {CrudOperations} operation - The CRUD operation associated with this field
+ */
+export interface CrudFormField extends FieldProperties {
+    /**
+     * @description The CRUD operation associated with this field
+     * @summary Specifies which operation (Create, Read, Update, Delete) this field is for
+     */
+    operation: CrudOperations;
+}
+/**
+ * @description Interface for defining a page/step in a multi-step form or wizard
+ * @summary Provides metadata for individual pages in stepped model forms
+ * This interface represents a single page or step in a multi-step form workflow.
+ * It allows defining optional title and description metadata for each page,
+ * which can be used to display step indicators, progress bars, or navigation labels.
+ * Used in conjunction with the @uisteppedmodel decorator.
+ *
+ * @interface IPagedComponentProperties
+ * @memberOf module:ui-decorators
+ *
+ * @property {string} [title] - Optional title for the page/step (e.g., "Personal Information")
+ * @property {string} [description] - Optional description providing additional context for the page
+ *
+ * @example
+ * // Define pages for a multi-step wizard
+ * const wizardPages: IPagedComponentProperties[] = [
+ *   { title: 'Personal Info', description: 'Enter your basic details' },
+ *   { title: 'Contact', description: 'Provide your contact information' },
+ *   { title: 'Review', description: 'Review and confirm your information' }
+ * ];
+ *
+ * @uisteppedmodel('div', wizardPages, true)
+ * class RegistrationWizard extends Model {
+ *   // Properties with @uipageprop decorators
+ * }
+ */
+export interface IPagedComponentProperties {
+    title?: string;
+    description?: string;
+    pages?: number | IPagedComponentProperties[];
+    rows?: number | string[];
+    cols?: number | string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/ui-decorators",
-  "version": "0.17.1",
+  "version": "0.17.3",
   "description": "Extension of decorator validation to ui elements to allow for web integration",
   "type": "module",
   "exports": {

package/lib/cjs/ui/interfaces.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=interfaces.js.map
-//# sourceMappingURL=interfaces.js.map

package/lib/cjs/ui/interfaces.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["interfaces.js"],"names":[],"mappings":";;AASA,sCAAsC"}

package/lib/esm/ui/interfaces.js

@@ -1,10 +0,0 @@
-/**
- * @description Interfaces for UI form components
- * @summary Defines interfaces for form fields with CRUD operations
- * This module contains interfaces that extend basic field properties with
- * CRUD operation information for form generation.
- * @module ui/interfaces
- * @memberOf module:ui-decorators
- */
-export {};
-//# sourceMappingURL=interfaces.js.map

package/lib/esm/ui/interfaces.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/ui/interfaces.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/lib/types/ui/interfaces.d.cts

@@ -1,64 +0,0 @@
-/**
- * @description Interfaces for UI form components
- * @summary Defines interfaces for form fields with CRUD operations
- * This module contains interfaces that extend basic field properties with
- * CRUD operation information for form generation.
- * @module ui/interfaces
- * @memberOf module:ui-decorators
- */
-import { FieldProperties } from "./types.d.cts";
-import { CrudOperations } from "@decaf-ts/db-decorators";
-/**
- * @description Form field interface with CRUD operation information
- * @summary Extends basic field properties with a specific CRUD operation
- * This interface represents a form field that is associated with a specific
- * CRUD operation (Create, Read, Update, Delete). It combines all the standard
- * field properties with an operation property.
- *
- * @interface CrudFormField
- * @extends FieldProperties
- * @memberOf module:ui-decorators
- *
- * @property {CrudOperations} operation - The CRUD operation associated with this field
- */
-export interface CrudFormField extends FieldProperties {
-    /**
-     * @description The CRUD operation associated with this field
-     * @summary Specifies which operation (Create, Read, Update, Delete) this field is for
-     */
-    operation: CrudOperations;
-}
-/**
- * @description Interface for defining a page/step in a multi-step form or wizard
- * @summary Provides metadata for individual pages in stepped model forms
- * This interface represents a single page or step in a multi-step form workflow.
- * It allows defining optional title and description metadata for each page,
- * which can be used to display step indicators, progress bars, or navigation labels.
- * Used in conjunction with the @uisteppedmodel decorator.
- *
- * @interface IPagedComponentProperties
- * @memberOf module:ui-decorators
- *
- * @property {string} [title] - Optional title for the page/step (e.g., "Personal Information")
- * @property {string} [description] - Optional description providing additional context for the page
- *
- * @example
- * // Define pages for a multi-step wizard
- * const wizardPages: IPagedComponentProperties[] = [
- *   { title: 'Personal Info', description: 'Enter your basic details' },
- *   { title: 'Contact', description: 'Provide your contact information' },
- *   { title: 'Review', description: 'Review and confirm your information' }
- * ];
- *
- * @uisteppedmodel('div', wizardPages, true)
- * class RegistrationWizard extends Model {
- *   // Properties with @uipageprop decorators
- * }
- */
-export interface IPagedComponentProperties {
-    title?: string;
-    description?: string;
-    pages?: number | IPagedComponentProperties[];
-    rows?: number | string[];
-    cols?: number | string[];
-}

package/lib/types/ui/interfaces.d.mts

@@ -1,64 +0,0 @@
-/**
- * @description Interfaces for UI form components
- * @summary Defines interfaces for form fields with CRUD operations
- * This module contains interfaces that extend basic field properties with
- * CRUD operation information for form generation.
- * @module ui/interfaces
- * @memberOf module:ui-decorators
- */
-import { FieldProperties } from "./types.d.mts";
-import { CrudOperations } from "@decaf-ts/db-decorators";
-/**
- * @description Form field interface with CRUD operation information
- * @summary Extends basic field properties with a specific CRUD operation
- * This interface represents a form field that is associated with a specific
- * CRUD operation (Create, Read, Update, Delete). It combines all the standard
- * field properties with an operation property.
- *
- * @interface CrudFormField
- * @extends FieldProperties
- * @memberOf module:ui-decorators
- *
- * @property {CrudOperations} operation - The CRUD operation associated with this field
- */
-export interface CrudFormField extends FieldProperties {
-    /**
-     * @description The CRUD operation associated with this field
-     * @summary Specifies which operation (Create, Read, Update, Delete) this field is for
-     */
-    operation: CrudOperations;
-}
-/**
- * @description Interface for defining a page/step in a multi-step form or wizard
- * @summary Provides metadata for individual pages in stepped model forms
- * This interface represents a single page or step in a multi-step form workflow.
- * It allows defining optional title and description metadata for each page,
- * which can be used to display step indicators, progress bars, or navigation labels.
- * Used in conjunction with the @uisteppedmodel decorator.
- *
- * @interface IPagedComponentProperties
- * @memberOf module:ui-decorators
- *
- * @property {string} [title] - Optional title for the page/step (e.g., "Personal Information")
- * @property {string} [description] - Optional description providing additional context for the page
- *
- * @example
- * // Define pages for a multi-step wizard
- * const wizardPages: IPagedComponentProperties[] = [
- *   { title: 'Personal Info', description: 'Enter your basic details' },
- *   { title: 'Contact', description: 'Provide your contact information' },
- *   { title: 'Review', description: 'Review and confirm your information' }
- * ];
- *
- * @uisteppedmodel('div', wizardPages, true)
- * class RegistrationWizard extends Model {
- *   // Properties with @uipageprop decorators
- * }
- */
-export interface IPagedComponentProperties {
-    title?: string;
-    description?: string;
-    pages?: number | IPagedComponentProperties[];
-    rows?: number | string[];
-    cols?: number | string[];
-}