@qrvey/widget-configurability 0.0.0-beta.4737 → 0.0.0-beta.4750

package/dist/esm/metadata.mjs

@@ -32,6 +32,84 @@ var __objRest = (source, exclude) => {
 };
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
+// src/constants/structure.constants.ts
+var STRUCTURE_SECTION_NAME_SEPARATOR = ".";
+var STRUCTURE_VIEW_NAME_SEPARATOR = "::";
+var STRUCTURE_RESERVED_WORDS = [
+  "views",
+  "defaults",
+  "subModules"
+];
+var Widget = /* @__PURE__ */ function(Widget2) {
+  Widget2["DASHBOARD"] = "dashboard";
+  Widget2["REPORT"] = "report";
+  Widget2["DOWNLOAD_MANAGER"] = "download-manager";
+  Widget2["DOWNLOAD_MODAL"] = "download-modal";
+  Widget2["CHART_PANEL"] = "chart-panel";
+  Widget2["CHART_GALLERY"] = "chart-gallery";
+  Widget2["CHART_BUILDER"] = "chart-builder";
+  return Widget2;
+}({});
+var WIDGET_SUBMODULE_NAMES = {
+  ["download-modal"]: "downloadModal",
+  ["chart-panel"]: "chartPanel",
+  ["chart-gallery"]: "chartGallery",
+  ["chart-builder"]: "chartBuilder"
+};
+var WIDGET_STRUCTURE_SCOPE_KIND = "qrvey.widget-structure-scope";
+var WIDGET_STRUCTURE_SCOPE_FORMAT = 1;
+var WidgetVersion = /* @__PURE__ */ function(WidgetVersion2) {
+  WidgetVersion2["v1"] = "1.0";
+  WidgetVersion2["latest"] = "latest";
+  return WidgetVersion2;
+}({});
+
+// src/metadata/customization-applicability.ts
+var chainOf = /* @__PURE__ */ __name((key) => key.split(STRUCTURE_SECTION_NAME_SEPARATOR).map((_, index, parts) => parts.slice(0, index + 1).join(STRUCTURE_SECTION_NAME_SEPARATOR)), "chainOf");
+var defaultRole = /* @__PURE__ */ __name((kind) => kind === "item" ? "item" : "group", "defaultRole");
+function resolveApplicability(map, key, view, kind, gate) {
+  var _a, _b, _c, _d;
+  const chain = chainOf(key);
+  let views = gate == null ? void 0 : gate.views;
+  const requires = new Set((_a = gate == null ? void 0 : gate.requires) != null ? _a : []);
+  let underNone = false;
+  chain.forEach((path) => {
+    var _a2;
+    const entry = map[path];
+    if (!entry) return;
+    if (entry.views) {
+      const declared = entry.views;
+      views = views ? views.filter((name) => declared.includes(name)) : [
+        ...declared
+      ];
+    }
+    (_a2 = entry.requires) == null ? void 0 : _a2.forEach((requirement) => requires.add(requirement));
+    if (path !== key && entry.role === "none") underNone = true;
+  });
+  const role = (_c = (_b = map[key]) == null ? void 0 : _b.role) != null ? _c : defaultRole(kind);
+  const applies = role !== "none" && !underNone && ((_d = gate == null ? void 0 : gate.applies) != null ? _d : true) && (view === void 0 || !views || views.includes(view));
+  return __spreadValues(__spreadValues({
+    role,
+    applies,
+    toggleable: applies && (role === "item" || role === "group")
+  }, views && {
+    views
+  }), requires.size && {
+    requires: [
+      ...requires
+    ]
+  });
+}
+__name(resolveApplicability, "resolveApplicability");
+function mergeApplicability(states) {
+  const [first] = states;
+  return __spreadProps(__spreadValues({}, first), {
+    applies: states.some((state) => state.applies),
+    toggleable: states.some((state) => state.toggleable)
+  });
+}
+__name(mergeApplicability, "mergeApplicability");
+
 // src/metadata/labels/chart-panel.defaults.ts
 var CHART_PANEL_DEFAULTS = {
   menuLayout: {
@@ -523,6 +601,326 @@ var CHART_PANEL_LABELS = {
   }
 };
 
+// src/metadata/labels/dashboard.applicability.ts
+var each = /* @__PURE__ */ __name((keys, applicability) => Object.fromEntries(keys.map((key) => [
+  key,
+  applicability
+])), "each");
+var DASHBOARD_APPLICABILITY = __spreadProps(__spreadValues(__spreadValues(__spreadProps(__spreadValues(__spreadValues(__spreadProps(__spreadValues(__spreadProps(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadProps(__spreadValues(__spreadProps(__spreadValues(__spreadProps(__spreadValues(__spreadValues({
+  // The manager bar is not rendered in dummy mode, nor for a single dashboard outside Composer.
+  navBar: {
+    requires: [
+      "environment"
+    ]
+  },
+  "navBar.qBackButton": {
+    views: [
+      "design",
+      "preview",
+      "endUser"
+    ]
+  },
+  // Dashboard list. Card and table fields only show in their mode of the list.
+  "assetList.asset.card": {
+    requires: [
+      "cardView"
+    ]
+  },
+  "assetList.asset.table": {
+    requires: [
+      "tableView"
+    ]
+  },
+  // Nothing reads it: the list has one Duplicate option whose modal asks about the charts.
+  "assetList.asset.optionMenu.qDuplDashAndCharts": {
+    role: "none"
+  }
+}, each([
+  "assetList.asset.optionMenu.qEditDash",
+  "assetList.asset.optionMenu.qUseDash",
+  "assetList.asset.optionMenu.qRenameDash",
+  "assetList.asset.optionMenu.qDuplDash",
+  "assetList.asset.optionMenu.qManageSharing",
+  "controlBarLeft.qCreateDash"
+], {
+  requires: [
+    "permission"
+  ]
+})), each([
+  "controlBarRight.qSwitchView",
+  "controlBarRight.timezone",
+  "controlBarRight.qFilterBy",
+  "controlBarRight.qFilterByTags",
+  "controlBarRight.qSearch"
+], {
+  views: [
+    "list"
+  ]
+})), {
+  "controlBarRight.qSortBy": {
+    views: [
+      "list"
+    ],
+    requires: [
+      "cardView"
+    ]
+  },
+  "controlBarRight.qSelectColumn": {
+    views: [
+      "list"
+    ],
+    requires: [
+      "tableView"
+    ]
+  }
+}), each([
+  "controlBarRight.qPreview",
+  "controlBarRight.qDiscard",
+  "controlBarRight.qPublish",
+  "controlBarRight.qUnpublish",
+  "controlBarRight.qSwitchMode"
+], {
+  views: [
+    "design"
+  ]
+})), {
+  "controlBarRight.qDesign": {
+    views: [
+      "preview"
+    ],
+    requires: [
+      "permission"
+    ]
+  }
+}), each([
+  "controlBarRight.qStatus",
+  "controlBarRight.qDownloadList"
+], {
+  views: [
+    "design",
+    "preview"
+  ]
+})), {
+  // Only after a 401 (expired qv_token), or a go-to-dashboard navigation.
+  qQvTokenExpiredMessage: {
+    requires: [
+      "environment"
+    ]
+  },
+  qGoToDashBackButton: {
+    requires: [
+      "navigation"
+    ]
+  },
+  // Duplicating is a command, and dummy mode refuses commands. The options node only carries defaults nobody reads:
+  // DashboardX reads them from duplicateModal.
+  duplicateModal: {
+    requires: [
+      "environment"
+    ]
+  },
+  "duplicateModal.options": {
+    role: "none"
+  },
+  // Only defaults (drag, resize, remove, changeLayout, unsavedChangesBehavior). Removing it hides no control, it
+  // drops the defaults, which turns off dragging and resizing in design.
+  canvas: {
+    role: "defaults"
+  },
+  "header.qTags": {
+    requires: [
+      "content"
+    ]
+  },
+  // Design menu bar.
+  "menuBar.file.qMnuDuplicateDashAndCharts": {
+    role: "none"
+  },
+  "menuBar.edit.qSelectAllContElem": {
+    role: "none"
+  }
+}), each([
+  "menuBar.file.qMnuCanvasSize",
+  "menuBar.grid.qMnuSnapToGrid",
+  "menuBar.qMnuArrange",
+  "menuBar.insert.qMnuInsertHeader"
+], {
+  requires: [
+    "fixedCanvas"
+  ]
+})), each([
+  "menuBar.file.qManageSharing",
+  "menuBar.file.qCreateDataset",
+  "menuBar.insert.qMnuInsertChart.qMnuNewChartAI"
+], {
+  requires: [
+    "permission"
+  ]
+})), each([
+  "toolBar.qInsertChart",
+  "toolBar.qInsertFilterCtrl",
+  "toolBar.qInsertShape",
+  "toolBar.grid",
+  "toolBar.qResponsiveView",
+  "toolBar.qInsertText",
+  "toolBar.qInsertImage",
+  "toolBar.qInsertButton",
+  "toolBar.qInsertContainer",
+  "toolBar.qThemes"
+], {
+  views: [
+    "design"
+  ]
+})), each([
+  "toolBar.qCanvasSize",
+  "toolBar.qArrange",
+  "toolBar.qAlign"
+], {
+  views: [
+    "design"
+  ],
+  requires: [
+    "fixedCanvas"
+  ]
+})), {
+  "toolBar.grid.qSnapToGrid": {
+    requires: [
+      "fixedCanvas"
+    ]
+  }
+}), each([
+  "toolBar.qRespGridMargins",
+  "toolBar.qRespGridColumns"
+], {
+  views: [
+    "design"
+  ],
+  requires: [
+    "responsiveCanvas"
+  ]
+})), {
+  "toolBar.qResponsiveView.qBreakpoints": {
+    requires: [
+      "responsiveCanvas"
+    ]
+  },
+  "toolBar.qCreateDataset": {
+    views: [
+      "design"
+    ],
+    requires: [
+      "permission"
+    ]
+  },
+  "toolBar.qInsertChart.qNewChartAI": {
+    requires: [
+      "permission"
+    ]
+  },
+  "toolBar.qDownloadDash": {
+    requires: [
+      "permission"
+    ]
+  }
+}), each([
+  "toolBar.qDashVersion",
+  "toolBar.qDiscard",
+  "toolBar.qSave",
+  "toolBar.qSwitchMode",
+  "toolBar.qHideToolBar",
+  "toolBar.qDownloadList",
+  "toolBar.qChangeLayout"
+], {
+  views: [
+    "endUser"
+  ]
+})), each([
+  "toolBar.qGetDashVersion",
+  "toolBar.qSourceDashBanner",
+  "toolBar.qHiddenItems"
+], {
+  views: [
+    "endUser"
+  ],
+  requires: [
+    "personalization"
+  ]
+})), {
+  // The filter settings button needs the canvas in edit mode; view-only filters come from navigation.
+  "filterPanel.qFilterSettings": {
+    views: [
+      "design"
+    ]
+  },
+  "filterPanel.viewOnlyFilterScope": {
+    views: [
+      "preview",
+      "endUser"
+    ],
+    requires: [
+      "navigation"
+    ]
+  }
+}), each([
+  "filterPanel.tabFilterScope",
+  "filterPanel.panelFilterScope"
+], {
+  requires: [
+    "content"
+  ]
+})), each([
+  "downloadModal.qExportVersion",
+  "downloadModal.qSavedVersionWarning"
+], {
+  views: [
+    "endUser"
+  ]
+})), {
+  "downloadModal.qUnsavedVersionWarning": {
+    views: [
+      "endUser"
+    ],
+    requires: [
+      "personalization"
+    ]
+  },
+  // Only an admin editing a schedule reads it, and DashboardX never opens the modal that way.
+  "downloadModal.qSubscribeOwner": {
+    role: "none"
+  },
+  // No reader in DashboardX nor in the qomponents export modal.
+  "downloadModal.qIncludeHeader": {
+    role: "none"
+  },
+  "downloadModal.qSubscribeOrganization": {
+    requires: [
+      "composer"
+    ]
+  },
+  "downloadModal.qIncludeHyperlinks": {
+    requires: [
+      "content"
+    ]
+  },
+  // The chart panel has no charts to render in the list; the gallery always reads its design keys, also in endUser;
+  // nothing reads the chart builder's.
+  "subModules.chartPanel": {
+    views: [
+      "design",
+      "preview",
+      "endUser"
+    ]
+  },
+  "subModules.chartGallery": {
+    views: [
+      "design"
+    ]
+  },
+  "subModules.chartBuilder": {
+    role: "none"
+  }
+});
+
 // src/metadata/labels/dashboard.defaults.ts
 var COLOR = "Color names or hex, e.g. '#000000', 'green', 'GREEN'";
 var IMAGE_URL = "Valid image url";
@@ -2407,38 +2805,6 @@ var DASHBOARD_LABELS = {
   }
 };
 
-// src/constants/structure.constants.ts
-var STRUCTURE_SECTION_NAME_SEPARATOR = ".";
-var STRUCTURE_VIEW_NAME_SEPARATOR = "::";
-var STRUCTURE_RESERVED_WORDS = [
-  "views",
-  "defaults",
-  "subModules"
-];
-var Widget = /* @__PURE__ */ function(Widget2) {
-  Widget2["DASHBOARD"] = "dashboard";
-  Widget2["REPORT"] = "report";
-  Widget2["DOWNLOAD_MANAGER"] = "download-manager";
-  Widget2["DOWNLOAD_MODAL"] = "download-modal";
-  Widget2["CHART_PANEL"] = "chart-panel";
-  Widget2["CHART_GALLERY"] = "chart-gallery";
-  Widget2["CHART_BUILDER"] = "chart-builder";
-  return Widget2;
-}({});
-var WIDGET_SUBMODULE_NAMES = {
-  ["download-modal"]: "downloadModal",
-  ["chart-panel"]: "chartPanel",
-  ["chart-gallery"]: "chartGallery",
-  ["chart-builder"]: "chartBuilder"
-};
-var WIDGET_STRUCTURE_SCOPE_KIND = "qrvey.widget-structure-scope";
-var WIDGET_STRUCTURE_SCOPE_FORMAT = 1;
-var WidgetVersion = /* @__PURE__ */ function(WidgetVersion2) {
-  WidgetVersion2["v1"] = "1.0";
-  WidgetVersion2["latest"] = "latest";
-  return WidgetVersion2;
-}({});
-
 // src/utils/defaults.helpers.ts
 var FONT_SIZES2 = [
   8,
@@ -4230,7 +4596,8 @@ __name(structureFromSubmodule, "structureFromSubmodule");
 var widgetMetadata = {
   [Widget.DASHBOARD]: {
     labels: DASHBOARD_LABELS,
-    defaults: DASHBOARD_DEFAULTS
+    defaults: DASHBOARD_DEFAULTS,
+    applicability: DASHBOARD_APPLICABILITY
   },
   [Widget.CHART_PANEL]: {
     labels: CHART_PANEL_LABELS,
@@ -4305,6 +4672,49 @@ function getCustomizationLabel(widget, key) {
   };
 }
 __name(getCustomizationLabel, "getCustomizationLabel");
+var SUBMODULES_PREFIX = `subModules${STRUCTURE_SECTION_NAME_SEPARATOR}`;
+var applicabilityMapOf = /* @__PURE__ */ __name((widget) => {
+  var _a, _b;
+  return (_b = (_a = widgetMetadata[widget]) == null ? void 0 : _a.applicability) != null ? _b : {};
+}, "applicabilityMapOf");
+var subModuleGate = /* @__PURE__ */ __name((widget, name, view) => resolveApplicability(applicabilityMapOf(widget), `${SUBMODULES_PREFIX}${name}`, view, "subModule"), "subModuleGate");
+function getKeyApplicability(widget, key, view, options = {}) {
+  const { subModule } = options;
+  if (!subModule && key.startsWith(SUBMODULES_PREFIX)) {
+    return subModuleGate(widget, key.slice(SUBMODULES_PREFIX.length), view);
+  }
+  const owner = subModule ? widgetOfSubmodule(subModule) : widget;
+  const structure = structureRootOf(owner, options, subModule);
+  const keys = structureKeysOf(owner, structure.views ? view : void 0, void 0, {
+    structure
+  });
+  const kind = keys.some((other) => other.startsWith(`${key}${STRUCTURE_SECTION_NAME_SEPARATOR}`)) ? "section" : "item";
+  const applicability = resolveApplicability(applicabilityMapOf(owner), key, view, kind, subModule ? subModuleGate(widget, subModule, view) : void 0);
+  return keys.includes(key) ? applicability : __spreadProps(__spreadValues({}, applicability), {
+    applies: false,
+    toggleable: false
+  });
+}
+__name(getKeyApplicability, "getKeyApplicability");
+function withApplicability(host, widget, target, nodes, applicableOnly) {
+  var _a;
+  const views = target.views.length ? target.views : [
+    void 0
+  ];
+  const subModules = (_a = target.subModules) != null ? _a : [];
+  const gates = views.map((view) => subModules.length ? subModuleGate(host, subModules[subModules.length - 1], view) : void 0);
+  const map = applicabilityMapOf(widget);
+  const annotate = /* @__PURE__ */ __name((list) => list.map((node) => {
+    const applicability = mergeApplicability(views.map((view, index) => resolveApplicability(map, node.key, view, node.kind, gates[index])));
+    const children = node.children && annotate(node.children);
+    const annotated = __spreadValues(__spreadValues({}, node), applicability);
+    if (children == null ? void 0 : children.length) annotated.children = children;
+    else delete annotated.children;
+    return annotated;
+  }).filter((node) => !applicableOnly || node.applies), "annotate");
+  return annotate(nodes);
+}
+__name(withApplicability, "withApplicability");
 function getCustomizationTree(widget, target, options = {}) {
   const resolved = resolveTarget(widget, target, options);
   const ordered = [];
@@ -4326,7 +4736,10 @@ function getCustomizationTree(widget, target, options = {}) {
     }, description && {
       description
     }), {
-      kind: "item"
+      kind: "item",
+      role: "item",
+      applies: true,
+      toggleable: true
     });
     nodes.set(key, node);
     if (parts.length === 1) {
@@ -4342,7 +4755,7 @@ function getCustomizationTree(widget, target, options = {}) {
     return node;
   }, "ensure");
   ordered.forEach(ensure);
-  return roots;
+  return withApplicability(widget, resolved.widget, target, roots, !!options.applicableOnly);
 }
 __name(getCustomizationTree, "getCustomizationTree");
 function instanceFor(widget, customization, target, view) {
@@ -4409,9 +4822,9 @@ function lockOf(customization, target, view, key, hiddenParent) {
   };
 }
 __name(lockOf, "lockOf");
-function getCustomizationTreeState(widget, customization, target) {
+function getCustomizationTreeState(widget, customization, target, options = {}) {
   var _a;
-  const tree = getCustomizationTree(widget, target);
+  const tree = getCustomizationTree(widget, target, options);
   const embedded = !!((_a = target.subModules) == null ? void 0 : _a.length);
   const instances = target.views.map((view) => ({
     view,
@@ -4613,6 +5026,11 @@ function flatten(widget, tree, scope, defaults) {
       since,
       notes,
       audience: own,
+      role: node.role,
+      applies: node.applies,
+      toggleable: node.toggleable,
+      views: node.views,
+      requires: node.requires,
       defaults: byKey.get(node.key)
     });
     return [
@@ -4623,13 +5041,13 @@ function flatten(widget, tree, scope, defaults) {
   return walk(tree, null, DEFAULT_AUDIENCE);
 }
 __name(flatten, "flatten");
-function subModuleEntry(widget, name, scope) {
+function subModuleEntry(widget, name, view) {
   var _a;
   const key = `subModules${STRUCTURE_SECTION_NAME_SEPARATOR}${name}`;
   const { label, description, since, notes, audience } = (_a = SUBMODULE_LABELS[name]) != null ? _a : getCustomizationLabel(widget, key);
-  return compact({
+  return compact(__spreadValues({
     key,
-    scope,
+    scope: view != null ? view : "",
     parent: null,
     kind: "subModule",
     label,
@@ -4637,7 +5055,7 @@ function subModuleEntry(widget, name, scope) {
     since,
     notes,
     audience: audience != null ? audience : DEFAULT_AUDIENCE
-  });
+  }, getKeyApplicability(widget, key, view)));
 }
 __name(subModuleEntry, "subModuleEntry");
 function getCustomizationDocs(widget, options = {}) {
@@ -4656,7 +5074,9 @@ function getCustomizationDocs(widget, options = {}) {
     };
     const entries = flatten(widget, getCustomizationTree(widget, target, options), scope, hostDefaults);
     Object.keys(asObject(map[`${viewPrefix(view)}subModules`])).filter((name) => !options.subModules || options.subModules.includes(name)).forEach((name) => {
-      entries.push(subModuleEntry(widget, name, scope));
+      const entry = subModuleEntry(widget, name, view);
+      if (options.applicableOnly && !entry.applies) return;
+      entries.push(entry);
       const embedded = findWidgetOfSubmodule(name);
       if (!embedded) return;
       entries.push(...flatten(embedded, getCustomizationTree(widget, __spreadProps(__spreadValues({}, target), {
@@ -4689,6 +5109,6 @@ function getCustomizationDefaultDocs(widget, options = {}) {
 }
 __name(getCustomizationDefaultDocs, "getCustomizationDefaultDocs");
 
-export { getCustomizationDefaultDocs, getCustomizationDocs, getCustomizationLabel, getCustomizationTree, getCustomizationTreeState, structureKeysOf, toggleCustomizationKey, widgetMetadata };
+export { getCustomizationDefaultDocs, getCustomizationDocs, getCustomizationLabel, getCustomizationTree, getCustomizationTreeState, getKeyApplicability, structureKeysOf, toggleCustomizationKey, widgetMetadata };
 //# sourceMappingURL=metadata.mjs.map
 //# sourceMappingURL=metadata.mjs.map