@zcomponent/core 1.14.3 → 1.16.0-beta

package/lib/contexts/cookieconsentcontext.d.ts

@@ -1,26 +1,49 @@
 import { ContextManager, Context } from '../context';
 import { Observable } from '../observable';
+/**
+ * Enum representing the overall status of the cookie consent process: 'unknown', 'initializing', 'initialized'.
+ */
 export declare enum Status {
-    "unknown" = "unknown",
-    "initializing" = "initializing",
-    "initialized" = "initialized"
+    'unknown' = "unknown",
+    'initializing' = "initializing",
+    'initialized' = "initialized"
 }
+/**
+ * Enum representing the consent status for different types of cookies: 'unknown', 'granted', 'rejected'.
+ */
 export declare enum ConsentStatus {
-    "unknown" = "unknown",
-    "granted" = "granted",
-    "rejected" = "rejected"
+    'unknown' = "unknown",
+    'granted' = "granted",
+    'rejected' = "rejected"
 }
+/**
+ * Enum representing different types of cookies: 'essential', 'functional', 'performance', 'marketing'.
+ */
 export declare enum CookieType {
-    "essential" = "essential",
-    "functional" = "functional",
-    "performance" = "performance",
-    "marketing" = "marketing"
+    'essential' = "essential",
+    'functional' = "functional",
+    'performance' = "performance",
+    'marketing' = "marketing"
 }
+/**
+ * Defines the structure of a vendor's information including name, description, and privacy policy URL.
+ */
 export interface Vendor {
     name: string;
     description: string;
     privacyPolicyUrl: string;
 }
+/**
+ * Manages the state and information related to cookie consent within a context.
+ * - `status`: Observable representing the overall status of the cookie consent.
+ * - `functionalCookies`: Observable for the consent status of functional cookies.
+ * - `performanceCookies`: Observable for the consent status of performance cookies.
+ * - `marketingCookies`: Observable for the consent status of marketing cookies.
+ * - `showSettings`: Observable for displaying cookie settings.
+ * - `performanceVendors`: Array of registered performance vendors.
+ * - `marketingVendors`: Array of registered marketing vendors.
+ * @zcontext
+ */
 export declare class CookieConsentContext extends Context {
     readonly status: Observable<Status, never>;
     readonly functionalCookies: Observable<ConsentStatus, never>;
@@ -29,15 +52,66 @@ export declare class CookieConsentContext extends Context {
     readonly showSettings: Observable<(() => void) | undefined, never>;
     readonly performanceVendors: Vendor[];
     readonly marketingVendors: Vendor[];
+    /**
+     * Registers a performance vendor.
+     */
     registerPerformanceVendor(v: Vendor): void;
+    /**
+     * Registers a marketing vendor.
+     */
     registerMarketingVendor(v: Vendor): void;
 }
+/**
+ * Retrieves the consent status for functional cookies.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<ConsentStatus>} The observable representing the consent status of functional cookies.
+ */
 export declare function useCookieConsentFunctional(mgr: ContextManager): Observable<ConsentStatus, never>;
+/**
+ * Retrieves the consent status for performance cookies.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<ConsentStatus>} The observable representing the consent status of performance cookies.
+ */
 export declare function useCookieConsentPerformance(mgr: ContextManager): Observable<ConsentStatus, never>;
+/**
+ * Retrieves the consent status for marketing cookies.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<ConsentStatus>} The observable representing the consent status of marketing cookies.
+ */
 export declare function useCookieConsentMarketing(mgr: ContextManager): Observable<ConsentStatus, never>;
+/**
+ * Retrieves the overall cookie consent status.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<Status>} The observable representing the overall cookie consent status.
+ */
 export declare function useCookieConsentStatus(mgr: ContextManager): Observable<Status, never>;
+/**
+ * Registers a performance vendor in the `CookieConsentContext`.
+ * @param {ContextManager} mgr The context manager instance.
+ * @param {Vendor} vendor The performance vendor to register.
+ */
 export declare function registerPerformanceVendor(mgr: ContextManager, vendor: Vendor): void;
+/**
+ * Registers a marketing vendor in the `CookieConsentContext`.
+ * @param {ContextManager} mgr The context manager instance.
+ * @param {Vendor} vendor The marketing vendor to register.
+ */
 export declare function registerMarketingVendor(mgr: ContextManager, vendor: Vendor): void;
+/**
+ * Retrieves the list of registered performance vendors.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Vendor[]} An array of registered performance vendors.
+ */
 export declare function usePerformanceVendors(mgr: ContextManager): Vendor[];
+/**
+ * Retrieves the list of registered marketing vendors.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Vendor[]} An array of registered marketing vendors.
+ */
 export declare function useMarketingVendors(mgr: ContextManager): Vendor[];
+/**
+ * Retrieves the function to show cookie settings from the `CookieConsentContext`.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<(() => void)|undefined>} The observable representing the function to show cookie settings.
+ */
 export declare function useShowCookieSettings(mgr: ContextManager): Observable<(() => void) | undefined, never>;

package/lib/contexts/cookieconsentcontext.js

@@ -1,17 +1,26 @@
 import { Context } from '../context';
 import { Observable } from '../observable';
+/**
+ * Enum representing the overall status of the cookie consent process: 'unknown', 'initializing', 'initialized'.
+ */
 export var Status;
 (function (Status) {
     Status["unknown"] = "unknown";
     Status["initializing"] = "initializing";
     Status["initialized"] = "initialized";
 })(Status || (Status = {}));
+/**
+ * Enum representing the consent status for different types of cookies: 'unknown', 'granted', 'rejected'.
+ */
 export var ConsentStatus;
 (function (ConsentStatus) {
     ConsentStatus["unknown"] = "unknown";
     ConsentStatus["granted"] = "granted";
     ConsentStatus["rejected"] = "rejected";
 })(ConsentStatus || (ConsentStatus = {}));
+/**
+ * Enum representing different types of cookies: 'essential', 'functional', 'performance', 'marketing'.
+ */
 export var CookieType;
 (function (CookieType) {
     CookieType["essential"] = "essential";
@@ -19,6 +28,17 @@ export var CookieType;
     CookieType["performance"] = "performance";
     CookieType["marketing"] = "marketing";
 })(CookieType || (CookieType = {}));
+/**
+ * Manages the state and information related to cookie consent within a context.
+ * - `status`: Observable representing the overall status of the cookie consent.
+ * - `functionalCookies`: Observable for the consent status of functional cookies.
+ * - `performanceCookies`: Observable for the consent status of performance cookies.
+ * - `marketingCookies`: Observable for the consent status of marketing cookies.
+ * - `showSettings`: Observable for displaying cookie settings.
+ * - `performanceVendors`: Array of registered performance vendors.
+ * - `marketingVendors`: Array of registered marketing vendors.
+ * @zcontext
+ */
 export class CookieConsentContext extends Context {
     constructor() {
         super(...arguments);
@@ -30,37 +50,88 @@ export class CookieConsentContext extends Context {
         this.performanceVendors = [];
         this.marketingVendors = [];
     }
+    /**
+     * Registers a performance vendor.
+     */
     registerPerformanceVendor(v) {
         this.performanceVendors.push(v);
     }
+    /**
+     * Registers a marketing vendor.
+     */
     registerMarketingVendor(v) {
         this.marketingVendors.push(v);
     }
 }
+/**
+ * Retrieves the consent status for functional cookies.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<ConsentStatus>} The observable representing the consent status of functional cookies.
+ */
 export function useCookieConsentFunctional(mgr) {
     return mgr.get(CookieConsentContext).functionalCookies;
 }
+/**
+ * Retrieves the consent status for performance cookies.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<ConsentStatus>} The observable representing the consent status of performance cookies.
+ */
 export function useCookieConsentPerformance(mgr) {
     return mgr.get(CookieConsentContext).performanceCookies;
 }
+/**
+ * Retrieves the consent status for marketing cookies.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<ConsentStatus>} The observable representing the consent status of marketing cookies.
+ */
 export function useCookieConsentMarketing(mgr) {
     return mgr.get(CookieConsentContext).marketingCookies;
 }
+/**
+ * Retrieves the overall cookie consent status.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<Status>} The observable representing the overall cookie consent status.
+ */
 export function useCookieConsentStatus(mgr) {
     return mgr.get(CookieConsentContext).status;
 }
+/**
+ * Registers a performance vendor in the `CookieConsentContext`.
+ * @param {ContextManager} mgr The context manager instance.
+ * @param {Vendor} vendor The performance vendor to register.
+ */
 export function registerPerformanceVendor(mgr, vendor) {
     return mgr.get(CookieConsentContext).registerPerformanceVendor(vendor);
 }
+/**
+ * Registers a marketing vendor in the `CookieConsentContext`.
+ * @param {ContextManager} mgr The context manager instance.
+ * @param {Vendor} vendor The marketing vendor to register.
+ */
 export function registerMarketingVendor(mgr, vendor) {
     return mgr.get(CookieConsentContext).registerMarketingVendor(vendor);
 }
+/**
+ * Retrieves the list of registered performance vendors.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Vendor[]} An array of registered performance vendors.
+ */
 export function usePerformanceVendors(mgr) {
     return mgr.get(CookieConsentContext).performanceVendors;
 }
+/**
+ * Retrieves the list of registered marketing vendors.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Vendor[]} An array of registered marketing vendors.
+ */
 export function useMarketingVendors(mgr) {
     return mgr.get(CookieConsentContext).marketingVendors;
 }
+/**
+ * Retrieves the function to show cookie settings from the `CookieConsentContext`.
+ * @param {ContextManager} mgr The context manager instance.
+ * @returns {Observable<(() => void)|undefined>} The observable representing the function to show cookie settings.
+ */
 export function useShowCookieSettings(mgr) {
     return mgr.get(CookieConsentContext).showSettings;
 }

package/lib/contexts/environmentcontext.d.ts

@@ -2,18 +2,53 @@ import { ContextManager, Context } from '../context';
 import { Observable } from '../observable';
 /** @zcontext */
 export declare class EnvironmentContext extends Context {
-    /** @zprop */
+    /**
+     * Observable indicating if the application is in design time.
+     * @zprop
+     **/
     readonly designTime: Observable<boolean, never>;
-    /** @zprop */
+    /**
+     * Observable indicating if the application is in edit time.
+     * @zprop
+     * */
     readonly editTime: Observable<boolean, never>;
-    /** @zprop */
+    /**
+     * Observable indicating if the application is in run time.
+     * @zprop
+     **/
     readonly runTime: Observable<boolean, never>;
-    /** @zprop */
+    /**
+     * Observable indicating if the application is a development build.
+     * @zprop
+     **/
     readonly developmentBuild: Observable<boolean, never>;
-    /** @zprop */
+    /**
+     * Observable indicating if the application is a production build.
+     * @zprop
+     * */
     readonly productionBuild: Observable<boolean, never>;
 }
+/**
+ * Determines if the application is in design time.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if in design time, otherwise false.
+ */
 export declare function isDesignTime(ctx: ContextManager): boolean;
+/**
+ * Determines if the application is in edit time.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if in edit time, otherwise false.
+ */
 export declare function isEditTime(ctx: ContextManager): boolean;
+/**
+ * Determines if the application is a development build.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if it's a development build, otherwise false.
+ */
 export declare function isDevelopmentBuild(ctx: ContextManager): boolean;
+/**
+ * Determines if the application is a production build.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if it's a production build, otherwise false.
+ */
 export declare function isProductionBuild(ctx: ContextManager): boolean;

package/lib/contexts/environmentcontext.js

@@ -4,27 +4,62 @@ import { Observable } from '../observable';
 export class EnvironmentContext extends Context {
     constructor() {
         super(...arguments);
-        /** @zprop */
+        /**
+         * Observable indicating if the application is in design time.
+         * @zprop
+         **/
         this.designTime = new Observable(false);
-        /** @zprop */
+        /**
+         * Observable indicating if the application is in edit time.
+         * @zprop
+         * */
         this.editTime = new Observable(false);
-        /** @zprop */
+        /**
+         * Observable indicating if the application is in run time.
+         * @zprop
+         **/
         this.runTime = new Observable(true);
-        /** @zprop */
+        /**
+         * Observable indicating if the application is a development build.
+         * @zprop
+         **/
         this.developmentBuild = new Observable(typeof process !== 'undefined' && process?.env?.NODE_ENV === 'development');
-        /** @zprop */
+        /**
+         * Observable indicating if the application is a production build.
+         * @zprop
+         * */
         this.productionBuild = new Observable(!this.developmentBuild.value);
     }
 }
+/**
+ * Determines if the application is in design time.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if in design time, otherwise false.
+ */
 export function isDesignTime(ctx) {
     return ctx.get(EnvironmentContext).designTime.value;
 }
+/**
+ * Determines if the application is in edit time.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if in edit time, otherwise false.
+ */
 export function isEditTime(ctx) {
     return ctx.get(EnvironmentContext).editTime.value;
 }
+/**
+ * Determines if the application is a development build.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if it's a development build, otherwise false.
+ */
 export function isDevelopmentBuild(ctx) {
     return ctx.get(EnvironmentContext).developmentBuild.value;
 }
+/**
+ * Determines if the application is a production build.
+ * @param ctx The context manager to query.
+ * @returns {boolean} True if it's a production build, otherwise false.
+ */
 export function isProductionBuild(ctx) {
     return ctx.get(EnvironmentContext).productionBuild.value;
 }

package/lib/contexts/gamepadcontext.d.ts

@@ -1,11 +1,17 @@
 import { Context, ContextManager } from '../context';
 import { Event } from '../event';
+/**
+ * Represents the axes of a gamepad.
+ */
 export declare enum GamepadAxis {
     LeftStickHorizontal = "LeftStickHorizontal",
     LeftStickVertical = "LeftStickVertical",
     RightStickHorizontal = "RightStickHorizontal",
     RightStickVertical = "RightStickVertical"
 }
+/**
+ * Represents the buttons on a gamepad.
+ */
 export declare enum GamepadButton {
     South = "South",
     East = "East",
@@ -25,16 +31,48 @@ export declare enum GamepadButton {
     DRight = "DRight",
     Center = "Center"
 }
+/**
+ * Manages and tracks gamepad connections and states.
+ * @zcontext
+ */
 export declare class GamepadContext extends Context {
     readonly onGamepadsChange: Event<[]>;
     readonly activeGamepads: Set<number>;
     private _registeredGamepads;
+    /**
+     * Creates an instance of GamepadContext.
+     * @param contextManager - The current ContextManager
+     */
     constructor(contextManager: ContextManager);
     private _update;
+    /**
+     * Retrieves a gamepad instance by its index.
+     * @param indx The index of the gamepad.
+     * @returns The gamepad instance or null if not found.
+     */
     getGamepad(indx: number): Gamepad | null;
+    /**
+     * Executes a function on each active gamepad, optionally filtered by index.
+     * @param requestedIndex The index to filter gamepads by, if specified.
+     * @param fn The function to execute on each matching gamepad.
+     */
     forGamepadsMatchingIndex(requestedIndex: number | undefined, fn: (gamepad: Gamepad) => void): void;
+    /**
+     * Registers a gamepad with a specific index.
+     * @param indx The index of the gamepad.
+     * @param gamepad The gamepad to register.
+     */
     registerGamepad(indx: number, gamepad: Gamepad): void;
+    /**
+     * Unregisters a gamepad by its index.
+     * @param indx The index of the gamepad to unregister.
+     */
     unregsiterGamepad(indx: number): void;
     dispose(): never;
 }
+/**
+ * Converts a gamepad axis enum value to its corresponding numeric representation.
+ * @param axis The gamepad axis to translate.
+ * @returns The numeric representation of the gamepad axis.
+ */
 export declare function translateGamepadAxis(axis: GamepadAxis): number;

package/lib/contexts/gamepadcontext.js

@@ -1,6 +1,9 @@
 import { Context } from '../context';
 import { Event } from '../event';
 import { isDesignTime } from './environmentcontext';
+/**
+ * Represents the axes of a gamepad.
+ */
 export var GamepadAxis;
 (function (GamepadAxis) {
     GamepadAxis["LeftStickHorizontal"] = "LeftStickHorizontal";
@@ -8,6 +11,9 @@ export var GamepadAxis;
     GamepadAxis["RightStickHorizontal"] = "RightStickHorizontal";
     GamepadAxis["RightStickVertical"] = "RightStickVertical";
 })(GamepadAxis || (GamepadAxis = {}));
+/**
+ * Represents the buttons on a gamepad.
+ */
 export var GamepadButton;
 (function (GamepadButton) {
     GamepadButton["South"] = "South";
@@ -28,7 +34,15 @@ export var GamepadButton;
     GamepadButton["DRight"] = "DRight";
     GamepadButton["Center"] = "Center";
 })(GamepadButton || (GamepadButton = {}));
+/**
+ * Manages and tracks gamepad connections and states.
+ * @zcontext
+ */
 export class GamepadContext extends Context {
+    /**
+     * Creates an instance of GamepadContext.
+     * @param contextManager - The current ContextManager
+     */
     constructor(contextManager) {
         super(contextManager, {});
         this.onGamepadsChange = new Event();
@@ -56,9 +70,19 @@ export class GamepadContext extends Context {
         }
         this._update();
     }
+    /**
+     * Retrieves a gamepad instance by its index.
+     * @param indx The index of the gamepad.
+     * @returns The gamepad instance or null if not found.
+     */
     getGamepad(indx) {
         return this._registeredGamepads.get(indx) ?? (navigator.getGamepads?.()?.[indx] || null);
     }
+    /**
+     * Executes a function on each active gamepad, optionally filtered by index.
+     * @param requestedIndex The index to filter gamepads by, if specified.
+     * @param fn The function to execute on each matching gamepad.
+     */
     forGamepadsMatchingIndex(requestedIndex, fn) {
         for (const indx of this.activeGamepads) {
             if (requestedIndex !== undefined && indx !== requestedIndex)
@@ -68,12 +92,21 @@ export class GamepadContext extends Context {
                 fn(gamepad);
         }
     }
+    /**
+     * Registers a gamepad with a specific index.
+     * @param indx The index of the gamepad.
+     * @param gamepad The gamepad to register.
+     */
     registerGamepad(indx, gamepad) {
         this._registeredGamepads.set(indx, gamepad);
         if (gamepad !== null)
             this.activeGamepads.add(indx);
         this.onGamepadsChange.emit();
     }
+    /**
+     * Unregisters a gamepad by its index.
+     * @param indx The index of the gamepad to unregister.
+     */
     unregsiterGamepad(indx) {
         this._registeredGamepads.delete(indx);
         this.activeGamepads.delete(indx);
@@ -85,6 +118,11 @@ export class GamepadContext extends Context {
         return super.dispose();
     }
 }
+/**
+ * Converts a gamepad axis enum value to its corresponding numeric representation.
+ * @param axis The gamepad axis to translate.
+ * @returns The numeric representation of the gamepad axis.
+ */
 export function translateGamepadAxis(axis) {
     switch (axis) {
         case GamepadAxis.LeftStickHorizontal:

package/lib/contexts/gesturecontext.d.ts

@@ -1,9 +1,15 @@
 import { Context, ContextManager, Event, Observable } from '../index';
+/**
+ * Defines the modes for interpreting touch gestures.
+ */
 export declare enum GestureMode {
     ScaleOnly = "Scale Only",
     RotateOnly = "Rotate Only",
     ScaleRotate = "Scale Rotate"
 }
+/**
+ * Configuration options for GestureContext construction.
+ */
 interface ConstructionProps {
     /**
      * The HTML element to which touch event listeners are attached.
@@ -11,7 +17,10 @@ interface ConstructionProps {
      */
     element?: HTMLElement;
 }
-/** @zcontext */
+/**
+ * Manages touch gestures for scaling and rotating elements.
+ * @zcontext
+ **/
 export declare class GestureContext extends Context<ConstructionProps> {
     private element;
     private canScale;
@@ -21,26 +30,44 @@ export declare class GestureContext extends Context<ConstructionProps> {
     private initialAngle;
     private oneFingerRotateMode;
     private initialTouchX;
+    /**
+     * Observable representing the current rotation value.
+     */
     rotation: Observable<number, never>;
+    /**
+     * Observable representing the current scale value.
+     */
     scale: Observable<number, never>;
+    /**
+     * Event triggered when rotation occurs.
+     */
     onRotate: Event<[number]>;
+    /**
+     * Event triggered when scaling occurs.
+     */
     onScale: Event<[number]>;
     /**
+     * Observable indicating whether gesture interactions are enabled.
      * Defaults to true.
      */
     enabled: Observable<boolean, never>;
     /**
-     * Defaults to 0.5;
+     * Minimum scale factor. Defaults to 0.5.
      */
     minScale: number;
     /**
-     * Defaults to 2.
+     * Maximum scale factor. Defaults to 2.
      */
     maxScale: number;
     /**
-     * Defaults to 1.
+     * Sensitivity of rotation. Defaults to 1.
      */
     rotationSensitivity: number;
+    /**
+     * Creates an instance of GestureContext.
+     * @param contextManager - The current ContextManager
+     * @param constructorProps - The constructor properties.
+     */
     constructor(contextManager: ContextManager, constructorProps: ConstructionProps);
     private onTouchStart;
     private onTouchMove;

package/lib/contexts/gesturecontext.js

@@ -1,12 +1,23 @@
 import { Context, Event, Observable, useCanvas } from '../index';
+/**
+ * Defines the modes for interpreting touch gestures.
+ */
 export var GestureMode;
 (function (GestureMode) {
     GestureMode["ScaleOnly"] = "Scale Only";
     GestureMode["RotateOnly"] = "Rotate Only";
     GestureMode["ScaleRotate"] = "Scale Rotate";
 })(GestureMode || (GestureMode = {}));
-/** @zcontext */
+/**
+ * Manages touch gestures for scaling and rotating elements.
+ * @zcontext
+ **/
 export class GestureContext extends Context {
+    /**
+     * Creates an instance of GestureContext.
+     * @param contextManager - The current ContextManager
+     * @param constructorProps - The constructor properties.
+     */
     constructor(contextManager, constructorProps) {
         super(contextManager, constructorProps);
         this.canScale = true;
@@ -16,24 +27,37 @@ export class GestureContext extends Context {
         this.initialAngle = null;
         this.oneFingerRotateMode = true;
         this.initialTouchX = null;
+        /**
+         * Observable representing the current rotation value.
+         */
         this.rotation = new Observable(0);
+        /**
+         * Observable representing the current scale value.
+         */
         this.scale = new Observable(0);
+        /**
+         * Event triggered when rotation occurs.
+         */
         this.onRotate = new Event();
+        /**
+         * Event triggered when scaling occurs.
+         */
         this.onScale = new Event();
         /**
+         * Observable indicating whether gesture interactions are enabled.
          * Defaults to true.
          */
         this.enabled = new Observable(true);
         /**
-         * Defaults to 0.5;
+         * Minimum scale factor. Defaults to 0.5.
          */
         this.minScale = 0.5;
         /**
-         * Defaults to 2.
+         * Maximum scale factor. Defaults to 2.
          */
         this.maxScale = 2;
         /**
-         * Defaults to 1.
+         * Sensitivity of rotation. Defaults to 1.
          */
         this.rotationSensitivity = 1;
         this.onTouchStart = (event) => {