builder-settings-types 0.0.223 → 0.0.227

package/dist/index.d.ts

@@ -1,12 +1,7 @@
-export declare type AddItemConfig<T> = {
+export declare type AddItemConfig<TSettings extends SettingsMap> = {
     buttonLabel?: string;
-    buttonIconSvg?: string;
     keyPrefix: string;
-    createItem: (index: number) => Setting<any, any> | SettingGroup<any>;
-    expandNewItem?: boolean;
-    showDeleteButton?: boolean;
-    deleteButtonLabel?: string;
-    deleteButtonIconSvg?: string;
+    createItem: (index: number) => SettingChild;
 };
 
 declare class AlignSetting_2 extends Setting<AlignValue, AlignSettingProps> {
@@ -35,51 +30,23 @@ export declare interface AnimationSettingProps extends SettingProps<AnimationVal
 
 export declare type AnimationValue = "fade" | "slide" | "zoom" | "bounce" | "pulse" | "none";
 
-export declare function asSettingGroupWithSettings<T extends Record<string, Setting<any, any> | SettingGroup<any>>>(settingGroup: SettingGroup<T>): SettingGroupWithSettings<T>;
+export declare type AnySettingValue = SettingValue | ComplexSettingValue;
+
+export declare function asSettingGroupWithSettings<TSettings extends SettingsMap>(settingGroup: SettingGroup<TSettings>): SettingGroupWithSettings<TSettings>;
 
 export declare class BackgroundSettingSet extends SettingGroup<{
     backgroundImage: UploadSetting;
     opacity: OpacitySetting;
     backgroundColor: ColorWithOpacitySetting;
 }> {
-    /**
-     * Constructs a new BackgroundSettingSet.
-     *
-     * @param props An object that may include default values for each setting and additional
-     *              properties for the UploadSetting via `uploadProps`.
-     *
-     * Example:
-     * {
-     *    backgroundImage: 'https://example.com/myimage.png',
-     *    opacity: 80,
-     *    backgroundColor: "0, 0, 30",
-     *    uploadProps: {
-     *      uploadUrl: 'https://st-admapi.onaim.io/api/File/UploadImage',
-     *      requestMethod: 'POST',
-     *      requestHeaders: {
-     *        accept: 'text/plain',
-     *        Authorization: 'bearer <your-token-here>',
-     *      },
-     *      formFieldName: 'File',
-     *      parseResponse: (data) => data.data.url,
-     *    }
-     * }
-     */
     constructor(props?: {
         backgroundImage?: string;
         opacity?: number;
         backgroundColor?: string;
         uploadProps?: UploadSettingProps;
         collapsed?: boolean;
-        hideCondition?: () => boolean;
     });
-    /**
-     * Override draw() to reorder the child settings and insert an "OR" label between the two sections.
-     */
     draw(): HTMLElement;
-    /**
-     * Helper method to generate CSS based on the current settings.
-     */
     getCssCode(): string;
 }
 
@@ -98,7 +65,6 @@ export declare class BorderSettingSet extends SettingGroup<{
         radius?: number;
         size?: number;
         collapsed?: boolean;
-        hideCondition?: () => boolean;
     });
     /**
      * Optional helper to generate CSS from the current settings.
@@ -180,17 +146,20 @@ export declare interface ColorWithOpacitySettingProps extends SettingProps<strin
     wrapperClassName?: string;
 }
 
-export declare function createSettingGroup<T extends Record<string, Setting<any, any> | SettingGroup<any>>>(groupProps: SettingGroupProps<T>): SettingGroupWithSettings<T>;
+export declare type ComplexSettingValue = SettingValue | Record<string, SettingValue> | Array<SettingValue> | Date;
+
+export declare function createSettingGroup<TSettings extends SettingsMap>(groupProps: SettingGroupProps<TSettings>): SettingGroupWithSettings<TSettings>;
+
+export declare function createTabSettingGroup<TSettings extends SettingsMap = SettingsMap>(groupProps: SettingGroupProps<TSettings>): TabSettingGroup<TSettings>;
 
 export declare type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
 
-export declare type DeleteItemConfig<T> = {
+export declare type DeleteItemConfig = {
     keyPrefix?: string;
     showDeleteButton?: boolean;
     deleteButtonLabel?: string;
-    deleteButtonIconSvg?: string;
 };
 
 export declare class DimensionSetting extends Setting<DimensionValue, DimensionSettingProps> {
@@ -233,9 +202,15 @@ export declare interface DimensionValue {
     height: number;
 }
 
-declare type ExtractSettingGroupValues<T> = T extends SettingGroup<infer S> ? {
-    [K in keyof S]?: S[K] extends Setting<infer V, any> ? V : S[K] extends SettingGroup<any> ? ExtractSettingGroupValues<S[K]> : any;
-} : never;
+export declare type ExtractSettingValue<T> = T extends Setting<infer V, any> ? V : never;
+
+export declare type ExtractSettingValues<TSettings extends SettingsMap> = {
+    readonly [K in keyof TSettings]: TSettings[K] extends Setting<infer V, any> ? V : TSettings[K] extends SettingGroup<infer S> ? ExtractSettingValues<S> : unknown;
+};
+
+export declare type ExtractSettingValuesOptional<TSettings extends SettingsMap> = {
+    [K in keyof TSettings]?: TSettings[K] extends Setting<infer V, any> ? V : TSettings[K] extends SettingGroup<infer S> ? ExtractSettingValuesOptional<S> : unknown;
+};
 
 export declare class GapSetting extends Setting<number, GapSettingsProps> {
     inputType: InputTypes;
@@ -339,10 +314,10 @@ export declare type InferSettingsProps<T> = T extends {
     getValues(): infer R;
 } ? R : never;
 
-declare type InputProps = {
+export declare type InputProps = {
     iconClassName?: string;
     labelClassName?: string;
-    value: any;
+    value: unknown;
     inputType: InputTypes;
     title?: string;
     icon?: string;
@@ -354,11 +329,14 @@ declare type InputProps = {
 
 export declare type InputTypes = "number" | "text" | "select" | "color" | "date" | "button";
 
-export declare function isSetting(value: any): value is Setting<any, any>;
+/** @deprecated Use isSetting from "../../types" instead */
+export declare function isSetting(value: unknown): value is SettingChild;
 
-export declare function isSettingGroup(value: any): value is SettingGroup<any>;
+export declare function isSettingChild(value: unknown): value is SettingChild;
 
-export declare function iterateSettings<T extends Record<string, Setting<any, any> | SettingGroup<any>>>(settings: T, callback: (key: string, setting: Setting<any, any> | SettingGroup<any>) => void): void;
+export declare function isSettingGroup(value: unknown): value is SettingChild;
+
+export declare function iterateSettings<TSettings extends SettingsMap>(settings: TSettings, callback: SettingIteratorCallback<TSettings>): void;
 
 export declare class MarginBottomSetting extends NumberSetting {
     inputType: InputTypes;
@@ -391,12 +369,11 @@ export declare class MarginSettingGroup extends SettingGroup<{
     marginLeft: MarginNumberSetting;
 }> {
     constructor(defaults?: {
-        marginTop?: number | 'auto';
-        marginRight?: number | 'auto';
-        marginBottom?: number | 'auto';
-        marginLeft?: number | 'auto';
+        marginTop?: number | "auto";
+        marginRight?: number | "auto";
+        marginBottom?: number | "auto";
+        marginLeft?: number | "auto";
         collapsed?: boolean;
-        hideCondition?: () => boolean;
     });
     getCssCode(): string;
 }
@@ -409,6 +386,10 @@ export declare class MarginTopSetting extends NumberSetting {
 export declare interface MarginTopSettingsProps extends NumberSettingsProps {
 }
 
+export declare type MobileSettingValues<TSettings extends SettingsMap> = {
+    [K in keyof TSettings]?: TSettings[K] extends Setting<infer V, any> ? V : TSettings[K] extends SettingGroup<infer S> ? MobileSettingValues<S> : unknown;
+};
+
 export declare class MultiLanguageSetting extends Setting<MultiLanguageValue, MultiLanguageSettingsProps> {
     inputType: Record<keyof MultiLanguageValue, "text">;
     private container;
@@ -566,6 +547,8 @@ export declare interface SelectSettingProps<T = any> extends SettingProps<T> {
     placeholder?: string;
 }
 
+export declare type SerializedSettingValues = Record<string, unknown>;
+
 export declare abstract class Setting<T, P extends SettingProps<T>> implements IDrawable, IChangable<T> {
     protected props: P;
     static DefaultUploadUrl: string;
@@ -591,23 +574,28 @@ export declare abstract class Setting<T, P extends SettingProps<T>> implements I
     createIcon(icon: string, className?: string): HTMLSpanElement;
 }
 
-export declare class SettingGroup<T extends Record<string, Setting<any, any> | SettingGroup<any>>> implements IDrawable, IChangable<T> {
+export declare type SettingBlurCallback = () => void;
+
+export declare type SettingChangeCallback<T> = (value: T) => void;
+
+export declare type SettingChanges<TSettings extends SettingsMap> = ExtractSettingValuesOptional<TSettings>;
+
+export declare type SettingChild<T extends AnySettingValue = AnySettingValue> = SettingInstance<T> | SettingGroup<any>;
+
+export declare class SettingGroup<TSettings extends SettingsMap> implements IDrawable, IChangable<ExtractSettingValues<TSettings>> {
     title: string;
-    settings: T;
-    description?: string;
-    icon?: string;
+    settings: TSettings;
     id: string;
-    onChange?: ((value: T) => void) | undefined;
-    onBlur?: () => void;
+    onChange?: SettingChangeCallback<ExtractSettingValues<TSettings>> | undefined;
+    onBlur?: SettingBlurCallback;
     private isCollapsed;
     private isMain;
     private includeGetJson;
     private elementRef;
-    private hideCondition?;
     private static hiddenElements;
     private isHidden;
     private custom;
-    initialValues: Record<string, any>;
+    initialValues: ExtractSettingValues<TSettings>;
     private changeTimeout;
     private isHandlingChange;
     private changeHandlers;
@@ -617,67 +605,64 @@ export declare class SettingGroup<T extends Record<string, Setting<any, any> | S
     private pendingBlurHandler;
     private originalDefaultValues;
     private nestingLevel;
-    private parentNestingLevel;
     private addItemCfg?;
     private deleteItemCfg?;
-    constructor(groupProps: SettingGroupProps<T>);
+    constructor(groupProps: SettingGroupProps<TSettings>);
     private propagateNestingLevel;
     getNestingLevel(): number;
     setNestingLevel(level: number): void;
     private updateNestingStyles;
-    static hide(): void;
-    static show(): void;
-    setOnChange(onChange: (value: T) => void): SettingGroup<T>;
-    setOnBlur(onBlur: () => void): SettingGroup<T>;
-    private setupBlurHandlers;
-    cleanup(): void;
-    clone(): SettingGroupWithSettings<T>;
-    setValue(values: Record<string, any>): void;
-    /** Force UI refresh for all child settings */
     private forceChildUIRefresh;
-    /** Attach change/blur bubbling for a newly added child */
-    private wireChild;
-    addSetting(key: string, setting: Setting<any, any> | SettingGroup<any>): void;
     removeSetting(key: string): void;
+    updateVisibility(): void;
+    clone(): SettingGroupWithSettings<TSettings>;
+    resetDefault(): void;
+    setMobileValues(values: MobileSettingValues<TSettings>): void;
+    getMobileValues(): MobileSettingValues<TSettings>;
+    getMobileValues<K extends keyof TSettings>(childKey: K): unknown;
+    setOnChange(onChange: SettingChangeCallback<ExtractSettingValues<TSettings>>): SettingGroup<TSettings>;
+    cleanup(): void;
+    setValue(values: ExtractSettingValuesOptional<TSettings>): void;
+    private wireChild;
+    addSetting(key: string, setting: SettingChild): void;
     private addDeleteButtonToElement;
     private showDeleteConfirmation;
     private getNextIndexFromPrefix;
-    calculateChanges(oldValues: Record<string, any>, newValues: Record<string, any>): Record<string, any>;
-    hide(): void;
-    show(): void;
-    getValues<K extends keyof T>(childKey?: K): any;
+    calculateChanges(oldValues: ExtractSettingValues<TSettings>, newValues: ExtractSettingValues<TSettings>): Record<string, {
+        from: unknown;
+        to: unknown;
+    }>;
+    getValues(): ExtractSettingValues<TSettings>;
+    getValues<K extends keyof TSettings>(childKey: K): unknown;
     private getValuesForJson;
-    getDefaultValues<K extends keyof T>(childKey?: K): any;
-    getMobileValues<K extends keyof T>(childKey?: K): any;
-    setMobileValues(values: Record<string, any>): void;
-    resetDefault(): void;
+    getDefaultValues(): ExtractSettingValues<TSettings>;
+    getDefaultValues<K extends keyof TSettings>(childKey: K): unknown;
     draw(): HTMLElement;
     collapse(): void;
     expand(): void;
-    updateVisibility(): void;
-    toggle(): void;
     getJson(): string;
     setJson(jsonString: string): void;
 }
 
-export declare type SettingGroupProps<T> = {
-    title: string;
-    settings: T;
+export declare type SettingGroupInstance<TSettings extends SettingsMap = SettingsMap> = SettingGroup<TSettings>;
+
+export declare type SettingGroupProps<TSettings extends SettingsMap> = {
     id?: string;
+    title: string;
+    settings: TSettings;
     collapsed?: boolean;
     main?: boolean;
-    description?: string;
-    icon?: string;
-    hideCondition?: () => boolean;
-    onBlur?: () => void;
     custom?: boolean;
-    parentNestingLevel?: number;
     includeGetJson?: boolean;
-    addItem?: AddItemConfig<T>;
-    deleteItem?: DeleteItemConfig<T>;
+    addItem?: AddItemConfig<TSettings>;
+    deleteItem?: DeleteItemConfig;
 };
 
-export declare type SettingGroupWithSettings<T extends Record<string, Setting<any, any> | SettingGroup<any>>> = SettingGroup<T> & T;
+export declare type SettingGroupWithSettings<TSettings extends SettingsMap> = SettingGroup<TSettings> & TSettings;
+
+export declare type SettingInstance<T extends AnySettingValue = AnySettingValue> = Setting<T, SettingProps<T>>;
+
+export declare type SettingIteratorCallback<TSettings extends SettingsMap> = (key: keyof TSettings, setting: TSettings[typeof key]) => void;
 
 export declare interface SettingProps<T> {
     default?: T;
@@ -690,11 +675,16 @@ export declare interface SettingProps<T> {
     includeGetJson?: boolean;
 }
 
-export declare type SettingsToProps<T> = T extends SettingGroup<infer S> ? {
-    [K in keyof S]?: S[K] extends Setting<infer V, any> ? V : S[K] extends SettingGroup<any> ? ExtractSettingGroupValues<S[K]> : any;
-} : never;
+export declare type SettingsMap = Record<string, Setting<any, any> | SettingGroup<any>>;
+
+export declare type SettingsToProps<T> = T extends {
+    getValues(): infer R;
+} ? R : never;
 
-export declare type SettingsToPropsOptional<T> = DeepPartial<SettingsToProps<T>>;
+/** @deprecated Use DeepPartial from "../../types" instead */
+export declare type SettingsToPropsOptional<T> = DeepPartial<ExtractSettingValues<T extends SettingsMap ? T : never>>;
+
+export declare type SettingValue = string | number | boolean | null | undefined;
 
 export declare class StringSetting extends Setting<string, StringSettingsProps> {
     inputType: InputTypes;
@@ -711,26 +701,11 @@ export declare interface StringSettingsProps extends SettingProps<string> {
     onChange?: (value: string) => void;
 }
 
-export declare type TabGroupProps<T> = {
-    title: string;
-    settings: T;
-    id?: string;
-    collapsed?: boolean;
-    main?: boolean;
-    description?: string;
-    icon?: string;
-    hideCondition?: () => boolean;
-    onBlur?: () => void;
-    custom?: boolean;
-    parentNestingLevel?: number;
-    includeGetJson?: boolean;
-};
-
-declare class TabSettingGroup<T extends TabSettingsGroupGenericType> extends SettingGroup<T> {
+declare class TabSettingGroup<TSettings extends SettingsMap = SettingsMap> extends SettingGroup<TSettings> {
     private activeTabId;
     private tabsContainer?;
     private contentContainers?;
-    constructor(groupProps: TabGroupProps<T>);
+    constructor(groupProps: SettingGroupProps<TSettings>);
     getActiveTabId(): string;
     switchToTab(tabId: string): void;
     private updateTabUI;
@@ -739,7 +714,7 @@ declare class TabSettingGroup<T extends TabSettingsGroupGenericType> extends Set
 export { TabSettingGroup }
 export { TabSettingGroup as TabsSettingGroup }
 
-export declare type TabSettingsGroupGenericType = Record<string, SettingGroup<any>>;
+export declare type TabSettingsGroupGenericType = Record<string, SettingGroup<SettingsMap>>;
 
 export declare class Toggle extends Setting<string, ToggleSettingProps> {
     inputType: InputTypes;
@@ -792,7 +767,7 @@ export declare interface UploadSettingProps extends SettingProps<string> {
     requestMethod?: string;
     requestHeaders?: Record<string, string>;
     formFieldName?: string;
-    parseResponse?: (responseData: any) => string;
+    parseResponse?: (responseData: unknown) => string;
     maxFileSizeMB?: number;
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "builder-settings-types",
   "description": "builder settings",
-  "version": "0.0.223",
+  "version": "0.0.227",
   "type": "module",
   "main": "dist/builder-settings-types.cjs.js",
   "module": "dist/builder-settings-types.es.js",