@richardmcquiston01/dashboard-widgets-toolkit 0.5.0 → 0.7.0

package/dist/index.cjs

@@ -252,6 +252,16 @@ function resolveDetailOptions(definition) {
     mode: options.mode ?? "client"
   };
 }
+function resolveTableControls(definition) {
+  const setting = definition.tableControls;
+  if (setting === void 0 || setting === false) return void 0;
+  const options = setting === true ? {} : setting;
+  const resolved = {
+    search: options.search ?? true,
+    sort: options.sort ?? true
+  };
+  return resolved.search || resolved.sort ? resolved : void 0;
+}
 function defaultDetailQuery(pageSize = DEFAULT_DETAIL_PAGE_SIZE) {
   return { page: 1, pageSize };
 }
@@ -526,17 +536,19 @@ function validateDetailData(data, subject = "Detail data") {
   }
   return ok(data);
 }
+function tableDetailData(data) {
+  return {
+    columns: data.columns.map((column, index) => ({
+      key: `c${index}`,
+      label: column.label,
+      ...column.numeric === void 0 ? {} : { numeric: column.numeric }
+    })),
+    rows: data.rows
+  };
+}
 function deriveDetailData(data, locale) {
   if (data.kind === "TABLE") {
-    if (data.footer !== void 0) return void 0;
-    return {
-      columns: data.columns.map((column, index) => ({
-        key: `c${index}`,
-        label: column.label,
-        ...column.numeric === void 0 ? {} : { numeric: column.numeric }
-      })),
-      rows: data.rows
-    };
+    return data.footer === void 0 ? tableDetailData(data) : void 0;
   }
   if (data.kind === "BAR_LIST") {
     return {
@@ -814,6 +826,14 @@ function optionalNumber(record, field, path, problems) {
     requireNumber(record, field, path, problems);
   }
 }
+function optionalSortValue(record, path, problems) {
+  const value = record["value"];
+  if (value !== void 0 && typeof value !== "string" && !(typeof value === "number" && Number.isFinite(value))) {
+    problems.push(
+      `${path}.value must be a string or a finite number, got ${describeType2(value)}.`
+    );
+  }
+}
 function optionalBoolean(record, field, path, problems) {
   const value = record[field];
   if (value !== void 0 && typeof value !== "boolean") {
@@ -917,6 +937,7 @@ function checkPayloadFields(kind, data, problems) {
           }
           eachRecord(row, rowPath, problems, (cell, cellPath) => {
             requireString(cell, "text", cellPath, problems);
+            optionalSortValue(cell, cellPath, problems);
             optionalUrl(
               cell,
               "href",
@@ -1021,6 +1042,24 @@ function checkDetailOption(detail, problems) {
     requireOneOf(detail, "mode", DETAIL_MODES, "detail", problems);
   }
 }
+function checkTableControlsOption(controls, kind, problems) {
+  if (controls === void 0 || controls === false) return;
+  if (typeof controls !== "boolean" && !isRecord(controls)) {
+    problems.push(
+      `tableControls must be true, false or an options object, got ${describeType2(controls)}.`
+    );
+    return;
+  }
+  if (isRecord(controls)) {
+    optionalBoolean(controls, "search", "tableControls", problems);
+    optionalBoolean(controls, "sort", "tableControls", problems);
+  }
+  if (typeof kind === "string" && kind !== "TABLE") {
+    problems.push(
+      `tableControls only applies to TABLE widgets, but kind is "${kind}".`
+    );
+  }
+}
 function formatProblems(prefix, problems) {
   const shown = problems.slice(0, MAX_REPORTED_PROBLEMS);
   const more = problems.length - shown.length;
@@ -1093,6 +1132,7 @@ function validateWidgetDefinition(value) {
     );
   }
   checkDetailOption(value["detail"], problems);
+  checkTableControlsOption(value["tableControls"], value["kind"], problems);
   if (value["fill"] !== void 0) {
     requireOneOf(value, "fill", WIDGET_FILLS, "", problems);
   }
@@ -1440,6 +1480,7 @@ exports.pruneLayout = pruneLayout;
 exports.queryRows = queryRows;
 exports.resolveDetailOptions = resolveDetailOptions;
 exports.resolvePayload = resolvePayload;
+exports.resolveTableControls = resolveTableControls;
 exports.resolveWidget = resolveWidget;
 exports.resolveWidgets = resolveWidgets;
 exports.restoreWidget = restoreWidget;
@@ -1448,6 +1489,7 @@ exports.serializeLayout = serializeLayout;
 exports.shareOf = shareOf;
 exports.showWidget = showWidget;
 exports.sortDefinitions = sortDefinitions;
+exports.tableDetailData = tableDetailData;
 exports.toggleHidden = toggleHidden;
 exports.toggleMinimized = toggleMinimized;
 exports.upgradeLegacyWidgetData = upgradeLegacyWidgetData;