@qrvey/widget-configurability 0.0.0-beta.4657 → 0.0.0-beta.4707

package/dist/types/index.d.ts

@@ -1,47 +1,5 @@
-import { W as WidgetCustomization, C as Condition, a as Widget, b as WidgetVersion, c as ConditionState } from './customization.models-CCSWjfb2.js';
-export { d as ConditionValue, O as Operators, e as WIDGET_STRUCTURE_SCOPE_FORMAT, f as WIDGET_STRUCTURE_SCOPE_KIND, g as WIDGET_SUBMODULE_NAMES, h as WidgetSubModuleCollection } from './customization.models-CCSWjfb2.js';
-
-type SectionValue = number | boolean | string | undefined | SectionValue[] | Record<string, unknown>;
-type SectionDefinition = WidgetStructure | (string | WidgetStructure)[] | undefined | boolean;
-interface WidgetStructure {
-    defaults?: Record<string, SectionValue>;
-    subModules?: Record<string, SectionValue>;
-    [key: string]: SectionDefinition | Record<string, SectionValue> | undefined;
-}
-interface WidgetStructureRoot extends WidgetStructure {
-    views?: Record<string, string[]>;
-}
-interface WidgetConfig {
-    version: string;
-    baseStructure: WidgetStructureRoot;
-    keepInheritance?: Record<string, string>;
-}
-type ValidationFN<T = any> = (value: T) => T | undefined;
-type ValidationMap = Record<string, ValidationFN>;
-type SanitizeFn = (value: string) => string;
-interface StructureEngineOptions {
-    sanitize?: SanitizeFn;
-    viewConditionals?: boolean;
-}
-interface BuildStructureOptions extends StructureEngineOptions {
-    validationMap?: ValidationMap;
-    layers?: WidgetCustomization[];
-}
-interface WidgetItemCondition {
-    effect: 'keep' | 'remove';
-    condition: Condition;
-}
-interface WidgetViewMapItemObj {
-    childMap?: WidgetViewMap;
-    defaults?: Record<string, unknown>;
-    conditions?: WidgetItemCondition[];
-}
-type WidgetViewMapItem = string | boolean | WidgetViewMapItemObj | Record<string, SectionValue>;
-type WidgetViewMap = Record<string, WidgetViewMapItem>;
-interface WidgetConditionMap {
-    condition: Condition;
-    map: WidgetViewMap;
-}
+import { W as Widget, a as WidgetVersion, C as ConditionState, b as WidgetCustomization, c as WidgetViewMap, B as BuildStructureOptions, d as WidgetConfig, V as ValidationMap, S as SanitizeFn, e as WidgetStructureRoot, f as StructureEngineOptions, g as WidgetItemCondition, h as Condition } from './structure.models-BqVB4VLP.js';
+export { i as ConditionValue, O as Operators, j as ValidationFN, k as WIDGET_STRUCTURE_SCOPE_FORMAT, l as WIDGET_STRUCTURE_SCOPE_KIND, m as WIDGET_SUBMODULE_NAMES, n as WidgetConditionMap, o as WidgetStructure, p as WidgetSubModuleCollection, q as WidgetViewMapItem } from './structure.models-BqVB4VLP.js';
 
 interface ScopeOptions {
     widget?: Widget;
@@ -187,6 +145,11 @@ declare function structureFromSubmodule(parent: WidgetStructureInstance, module:
 
 declare const DOWNLOAD_MODAL_V1_KEYS: readonly ["qScheduleOption", "qSubscribeOption", "qSubscribeExternalUsers", "qSubscribeBanner", "qOwnerLabel", "qSubscribeOwner", "qSubscribeOrganization", "qSubscribeMyself", "qSubscribeSpecificPeople", "qIncludeHyperlinks", "qIncludeHeader"];
 type DownloadModalKey = (typeof DOWNLOAD_MODAL_V1_KEYS)[number];
+declare const DOWNLOAD_MODAL_V1_ADVANCED_SETTINGS = "qAdvancedSettings";
+declare const DOWNLOAD_MODAL_V1_ADVANCED_SETTINGS_KEYS: readonly ["qPageSize", "qOrientation"];
+declare const DOWNLOAD_MODAL_V1_SECTIONS: {
+    qAdvancedSettings: ("qPageSize" | "qOrientation")[];
+};
 declare const hostKeepInheritance: (section?: string) => Record<string, string>;
 declare const DOWNLOAD_MODAL_V1_DEFAULTS: {
     subscribeMyself: boolean;
@@ -267,7 +230,7 @@ declare class BaseDashboardV1StructureDto {
     toolBar: (string | Record<string, unknown>)[];
     configPanel: boolean;
     filterPanel: FilterPanelDto;
-    downloadModal: string[];
+    downloadModal: (string | Record<string, unknown>)[];
     subModules: SubModulesDto;
 }
 
@@ -287,4 +250,4 @@ declare namespace dashboard_structure_doc {
   export { dashboard_structure_doc_AssetListDto as AssetListDto, dashboard_structure_doc_BaseDashboardV1StructureDto as BaseDashboardV1StructureDto, dashboard_structure_doc_FilterPanelDto as FilterPanelDto, dashboard_structure_doc_MenuBarDto as MenuBarDto, dashboard_structure_doc_SubModulesDto as SubModulesDto, dashboard_structure_doc_ViewsDto as ViewsDto };
 }
 
-export { type BuildStructureOptions, CUSTOMIZATIONS_API_PATH, Condition, ConditionState, type CustomizationErrorCode, type CustomizationPath, type CustomizationValidationError, type CustomizationValidationResult, DEFAULT_CUSTOMIZATION_ID, DOWNLOAD_MODAL_V1_DEFAULTS, DOWNLOAD_MODAL_V1_KEYS, DOWNLOAD_MODAL_VALIDATOR_MAP, DX_VALIDATOR_MAP, dashboard_structure_doc as DashboardDoc, type DownloadModalKey, type LoadRemoteCustomizationOptions, type RemoteCustomizationDefinition, type RemoteCustomizationError, type RemoteCustomizationResult, type RemoteCustomizationStatus, type SanitizeFn, type ScopeOptions, type StructureEngineOptions, type StructureInput, type ValidateCustomizationOptions, type ValidationFN, type ValidationMap, Widget, type WidgetConditionMap, type WidgetConfig, WidgetCustomization, type WidgetItemCondition, type WidgetStructure, WidgetStructureInstance, type WidgetStructureRoot, type WidgetStructureScope, WidgetVersion, type WidgetViewMap, type WidgetViewMapItem, buildStructure, calculateRootDefaults, calculateViewMap, checkConditions, clearRemoteCustomizationCache, evaluateCondition, extractCustomization, formatCustomizationPath, getWidgetConfig, getWidgetStructure, hostKeepInheritance, isEmptyCustomization, isValidCustomizationId, isWidgetStructureScope, loadRemoteCustomization, remoteCustomizationLayers, scopeToCustomization, structureFrom, structureFromSubmodule, validateBoolean, validateCustomization, validateDefaults };
+export { BuildStructureOptions, CUSTOMIZATIONS_API_PATH, Condition, ConditionState, type CustomizationErrorCode, type CustomizationPath, type CustomizationValidationError, type CustomizationValidationResult, DEFAULT_CUSTOMIZATION_ID, DOWNLOAD_MODAL_V1_ADVANCED_SETTINGS, DOWNLOAD_MODAL_V1_ADVANCED_SETTINGS_KEYS, DOWNLOAD_MODAL_V1_DEFAULTS, DOWNLOAD_MODAL_V1_KEYS, DOWNLOAD_MODAL_V1_SECTIONS, DOWNLOAD_MODAL_VALIDATOR_MAP, DX_VALIDATOR_MAP, dashboard_structure_doc as DashboardDoc, type DownloadModalKey, type LoadRemoteCustomizationOptions, type RemoteCustomizationDefinition, type RemoteCustomizationError, type RemoteCustomizationResult, type RemoteCustomizationStatus, SanitizeFn, type ScopeOptions, StructureEngineOptions, type StructureInput, type ValidateCustomizationOptions, ValidationMap, Widget, WidgetConfig, WidgetCustomization, WidgetItemCondition, WidgetStructureInstance, WidgetStructureRoot, type WidgetStructureScope, WidgetVersion, WidgetViewMap, buildStructure, calculateRootDefaults, calculateViewMap, checkConditions, clearRemoteCustomizationCache, evaluateCondition, extractCustomization, formatCustomizationPath, getWidgetConfig, getWidgetStructure, hostKeepInheritance, isEmptyCustomization, isValidCustomizationId, isWidgetStructureScope, loadRemoteCustomization, remoteCustomizationLayers, scopeToCustomization, structureFrom, structureFromSubmodule, validateBoolean, validateCustomization, validateDefaults };

package/dist/types/metadata.d.ts

@@ -1,14 +1,34 @@
-import { a as Widget, b as WidgetVersion, W as WidgetCustomization } from './customization.models-CCSWjfb2.js';
+import { a as WidgetVersion, d as WidgetConfig, e as WidgetStructureRoot, V as ValidationMap, W as Widget, b as WidgetCustomization } from './structure.models-BqVB4VLP.js';
 
+type CustomizationAudience = 'partner' | 'internal';
 interface CustomizationLabel {
     label: string;
     description?: string;
+    since?: string;
+    notes?: string;
+    audience?: CustomizationAudience;
 }
 type CustomizationLabelMap = Record<string, CustomizationLabel>;
+interface CustomizationDefaultLabel {
+    description?: string;
+    since?: string;
+    notes?: string;
+    audience?: CustomizationAudience;
+    type?: string;
+    values?: readonly (string | number | boolean)[];
+    example?: string;
+}
+type CustomizationDefaultLabelMap = Record<string, CustomizationDefaultLabel>;
 interface CustomizationTarget {
     views: string[];
     subModules?: string[];
 }
+type CustomizationStructureSource = WidgetConfig | WidgetStructureRoot;
+interface CustomizationStructureOptions {
+    version?: WidgetVersion;
+    structure?: CustomizationStructureSource;
+    subModuleStructures?: Record<string, CustomizationStructureSource>;
+}
 interface CustomizationTreeNode {
     key: string;
     id: string;
@@ -27,24 +47,58 @@ interface CustomizationTreeStateNode extends CustomizationTreeNode {
     lockedBy?: CustomizationLock;
     children?: CustomizationTreeStateNode[];
 }
+interface CustomizationDefaultDoc {
+    name: string;
+    type?: string;
+    values?: readonly (string | number | boolean)[];
+    example?: string;
+    description?: string;
+    since?: string;
+    notes?: string;
+    audience: CustomizationAudience;
+}
+interface CustomizationDefaultDocEntry extends CustomizationDefaultDoc {
+    key: string | null;
+}
+interface CustomizationDocEntry {
+    key: string;
+    scope: string;
+    parent: string | null;
+    kind: 'section' | 'item' | 'subModule';
+    label: string;
+    description?: string;
+    since?: string;
+    notes?: string;
+    audience: CustomizationAudience;
+    defaults?: CustomizationDefaultDoc[];
+}
+interface CustomizationDocsOptions extends CustomizationStructureOptions {
+    views?: string[];
+    subModules?: string[];
+    validationMap?: ValidationMap;
+}
 
 declare const widgetMetadata: Partial<Record<Widget, {
     labels: CustomizationLabelMap;
+    defaults?: CustomizationDefaultLabelMap;
 }>>;
 /**
- * Keys of the structure in a view (or at the root), in structure order, without the view prefix.
+ * Keys of the structure in a view (or at the root), in structure order, without the view prefix. Reads the structure the
+ * options pass, under their customization, instead of the one this package ships when they set one.
  */
-declare function structureKeysOf(widget: Widget, view?: string, version?: WidgetVersion): string[];
+declare function structureKeysOf(widget: Widget, view?: string, version?: WidgetVersion, options?: {
+    structure?: CustomizationStructureSource;
+    customization?: WidgetCustomization;
+}): string[];
 /**
  * Label of a key: full path first, then the leaf id; a humanized id when neither exists.
  */
 declare function getCustomizationLabel(widget: Widget, key: string): CustomizationLabel;
 /**
- * The labelled tree of a target: a widget view, or the structure of the embedded widget when subModules is set.
+ * The labelled tree of a target: a widget view, or the structure of the embedded widget when subModules is set. Options
+ * may pass the structures to read (CustomizationStructureOptions).
  */
-declare function getCustomizationTree(widget: Widget, target: CustomizationTarget, options?: {
-    version?: WidgetVersion;
-}): CustomizationTreeNode[];
+declare function getCustomizationTree(widget: Widget, target: CustomizationTarget, options?: CustomizationStructureOptions): CustomizationTreeNode[];
 /**
  * The tree with the visibility of each node for a customization, computed with the real engine. A node whose
  * visibility differs between the target views is 'mixed'; a hidden node a switch cannot bring back is locked.
@@ -56,4 +110,16 @@ declare function getCustomizationTreeState(widget: Widget, customization: Widget
  */
 declare function toggleCustomizationKey(customization: WidgetCustomization | undefined, target: CustomizationTarget, key: string, visible: boolean): WidgetCustomization;
 
-export { type CustomizationLabel, type CustomizationLabelMap, type CustomizationLock, type CustomizationTarget, type CustomizationTreeNode, type CustomizationTreeStateNode, getCustomizationLabel, getCustomizationTree, getCustomizationTreeState, structureKeysOf, toggleCustomizationKey, widgetMetadata };
+/**
+ * The customization keys of a widget as flat doc entries, one per key per scope: each view of the structure, then each
+ * submodule of the view ('design::chartPanel') with the keys its structure resolves to inside the host. Options may pass
+ * the structures to document, so a host can describe the tree it shipped with instead of this package's.
+ */
+declare function getCustomizationDocs(widget: Widget, options?: CustomizationDocsOptions): CustomizationDocEntry[];
+/**
+ * Every documented default of a widget, with the key it belongs to: the defaults no key owns (customStyles,
+ * unsavedChangesBehavior) apply to the whole widget and come with a null key.
+ */
+declare function getCustomizationDefaultDocs(widget: Widget, options?: CustomizationDocsOptions): CustomizationDefaultDocEntry[];
+
+export { type CustomizationAudience, type CustomizationDefaultDoc, type CustomizationDefaultDocEntry, type CustomizationDefaultLabel, type CustomizationDefaultLabelMap, type CustomizationDocEntry, type CustomizationDocsOptions, type CustomizationLabel, type CustomizationLabelMap, type CustomizationLock, type CustomizationStructureOptions, type CustomizationStructureSource, type CustomizationTarget, type CustomizationTreeNode, type CustomizationTreeStateNode, getCustomizationDefaultDocs, getCustomizationDocs, getCustomizationLabel, getCustomizationTree, getCustomizationTreeState, structureKeysOf, toggleCustomizationKey, widgetMetadata };

package/dist/types/structure.models-BqVB4VLP.d.ts

@@ -0,0 +1,89 @@
+declare enum Widget {
+    DASHBOARD = "dashboard",
+    REPORT = "report",
+    DOWNLOAD_MANAGER = "download-manager",
+    DOWNLOAD_MODAL = "download-modal",
+    CHART_PANEL = "chart-panel",
+    CHART_GALLERY = "chart-gallery",
+    CHART_BUILDER = "chart-builder"
+}
+declare const WIDGET_SUBMODULE_NAMES: Partial<Record<Widget, string>>;
+declare const WIDGET_STRUCTURE_SCOPE_KIND = "qrvey.widget-structure-scope";
+declare const WIDGET_STRUCTURE_SCOPE_FORMAT = 1;
+declare enum WidgetVersion {
+    v1 = "1.0",
+    latest = "latest"
+}
+
+declare const allowedOperators: readonly ["=", "!=", ">", ">=", "<", "<=", "startsWith", "endsWith", "contains"];
+type Operators = (typeof allowedOperators)[number];
+type ConditionValue = string | number;
+interface Condition {
+    field: string;
+    operator: Operators;
+    value: ConditionValue;
+}
+type ConditionState = Record<string, ConditionValue>;
+
+interface Verbs {
+    remove?: string[];
+    keep?: string[];
+    reorder?: string[];
+}
+interface CustomizationStructure extends Verbs {
+    defaults?: Record<string, unknown>;
+    subModules?: WidgetSubModuleCollection;
+}
+interface Conditional extends CustomizationStructure {
+    condition: Condition;
+}
+type View = Record<string, WidgetCustomization>;
+type WidgetSubModuleCollection = Record<string, WidgetCustomization>;
+interface WidgetCustomization extends CustomizationStructure {
+    conditional?: Conditional[];
+    views?: View;
+}
+
+type SectionValue = number | boolean | string | undefined | SectionValue[] | Record<string, unknown>;
+type SectionDefinition = WidgetStructure | (string | WidgetStructure)[] | undefined | boolean;
+interface WidgetStructure {
+    defaults?: Record<string, SectionValue>;
+    subModules?: Record<string, SectionValue>;
+    [key: string]: SectionDefinition | Record<string, SectionValue> | undefined;
+}
+interface WidgetStructureRoot extends WidgetStructure {
+    views?: Record<string, string[]>;
+}
+interface WidgetConfig {
+    version: string;
+    baseStructure: WidgetStructureRoot;
+    keepInheritance?: Record<string, string>;
+}
+type ValidationFN<T = any> = (value: T) => T | undefined;
+type ValidationMap = Record<string, ValidationFN>;
+type SanitizeFn = (value: string) => string;
+interface StructureEngineOptions {
+    sanitize?: SanitizeFn;
+    viewConditionals?: boolean;
+}
+interface BuildStructureOptions extends StructureEngineOptions {
+    validationMap?: ValidationMap;
+    layers?: WidgetCustomization[];
+}
+interface WidgetItemCondition {
+    effect: 'keep' | 'remove';
+    condition: Condition;
+}
+interface WidgetViewMapItemObj {
+    childMap?: WidgetViewMap;
+    defaults?: Record<string, unknown>;
+    conditions?: WidgetItemCondition[];
+}
+type WidgetViewMapItem = string | boolean | WidgetViewMapItemObj | Record<string, SectionValue>;
+type WidgetViewMap = Record<string, WidgetViewMapItem>;
+interface WidgetConditionMap {
+    condition: Condition;
+    map: WidgetViewMap;
+}
+
+export { type BuildStructureOptions as B, type ConditionState as C, type Operators as O, type SanitizeFn as S, type ValidationMap as V, Widget as W, WidgetVersion as a, type WidgetCustomization as b, type WidgetViewMap as c, type WidgetConfig as d, type WidgetStructureRoot as e, type StructureEngineOptions as f, type WidgetItemCondition as g, type Condition as h, type ConditionValue as i, type ValidationFN as j, WIDGET_STRUCTURE_SCOPE_FORMAT as k, WIDGET_STRUCTURE_SCOPE_KIND as l, WIDGET_SUBMODULE_NAMES as m, type WidgetConditionMap as n, type WidgetStructure as o, type WidgetSubModuleCollection as p, type WidgetViewMapItem as q };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/widget-configurability",
-  "version": "0.0.0-beta.4657",
+  "version": "0.0.0-beta.4707",
   "types": "dist/types/index.d.ts",
   "main": "dist/cjs/index.js",
   "module": "./dist/esm/index.mjs",

package/dist/types/customization.models-CCSWjfb2.d.ts

@@ -1,47 +0,0 @@
-declare enum Widget {
-    DASHBOARD = "dashboard",
-    REPORT = "report",
-    DOWNLOAD_MANAGER = "download-manager",
-    DOWNLOAD_MODAL = "download-modal",
-    CHART_PANEL = "chart-panel",
-    CHART_GALLERY = "chart-gallery",
-    CHART_BUILDER = "chart-builder"
-}
-declare const WIDGET_SUBMODULE_NAMES: Partial<Record<Widget, string>>;
-declare const WIDGET_STRUCTURE_SCOPE_KIND = "qrvey.widget-structure-scope";
-declare const WIDGET_STRUCTURE_SCOPE_FORMAT = 1;
-declare enum WidgetVersion {
-    v1 = "1.0",
-    latest = "latest"
-}
-
-declare const allowedOperators: readonly ["=", "!=", ">", ">=", "<", "<=", "startsWith", "endsWith", "contains"];
-type Operators = (typeof allowedOperators)[number];
-type ConditionValue = string | number;
-interface Condition {
-    field: string;
-    operator: Operators;
-    value: ConditionValue;
-}
-type ConditionState = Record<string, ConditionValue>;
-
-interface Verbs {
-    remove?: string[];
-    keep?: string[];
-    reorder?: string[];
-}
-interface CustomizationStructure extends Verbs {
-    defaults?: Record<string, unknown>;
-    subModules?: WidgetSubModuleCollection;
-}
-interface Conditional extends CustomizationStructure {
-    condition: Condition;
-}
-type View = Record<string, WidgetCustomization>;
-type WidgetSubModuleCollection = Record<string, WidgetCustomization>;
-interface WidgetCustomization extends CustomizationStructure {
-    conditional?: Conditional[];
-    views?: View;
-}
-
-export { type Condition as C, type Operators as O, type WidgetCustomization as W, Widget as a, WidgetVersion as b, type ConditionState as c, type ConditionValue as d, WIDGET_STRUCTURE_SCOPE_FORMAT as e, WIDGET_STRUCTURE_SCOPE_KIND as f, WIDGET_SUBMODULE_NAMES as g, type WidgetSubModuleCollection as h };