@vizzly/dashboard 0.14.4-dev-bba43aecbb9d5b65a950ef259163441af1041848 → 0.14.4-dev-7cba24e151ef9b87b5980bb4d617335aa42d5fc5

package/dist/dashboard.esm.js

@@ -3675,6 +3675,10 @@ var usedMeasures = function usedMeasures(attrs) {
   if ('yMeasure' in attrs && attrs.yMeasure) {
     usedMeasures = [].concat(usedMeasures, [attrs.yMeasure]);
   }
+  if ('zMeasure' in attrs && attrs.zMeasure) {
+    var newMeasures = Array.isArray(attrs.zMeasure) ? attrs.zMeasure : [attrs.zMeasure];
+    usedMeasures = [].concat(usedMeasures, newMeasures);
+  }
   return usedMeasures;
 };
 var usedDimensions = function usedDimensions(attrs) {
@@ -3693,18 +3697,34 @@ var usedDimensions = function usedDimensions(attrs) {
 var usedFields = function usedFields(attrs) {
   var usedFields = [];
   usedMeasures(attrs).forEach(function (measure) {
-    usedFields = [].concat(usedFields, [measure.field]);
+    usedFields = [].concat(usedFields, [{
+      fieldId: measure.field,
+      "function": measure["function"],
+      dataSetId: attrs.dataSetId
+    }]);
   });
   usedDimensions(attrs).forEach(function (dimension) {
-    usedFields = [].concat(usedFields, [dimension.field]);
+    usedFields = [].concat(usedFields, [{
+      fieldId: dimension.field,
+      "function": dimension["function"],
+      dataSetId: attrs.dataSetId
+    }]);
   });
   if ('order' in attrs && attrs.order) {
     usedFields = [].concat(usedFields, [].concat(attrs.order).map(function (d) {
-      return d.field;
+      return {
+        fieldId: d.field,
+        "function": d["function"],
+        dataSetId: attrs.dataSetId
+      };
     }));
   }
   if ('timeDimension' in attrs && attrs.timeDimension) {
-    usedFields = [].concat(usedFields, [attrs.timeDimension.field]);
+    usedFields = [].concat(usedFields, [{
+      fieldId: attrs.timeDimension.field,
+      "function": attrs.timeDimension.truncate,
+      dataSetId: attrs.dataSetId
+    }]);
   }
   return usedFields;
 };
@@ -3725,7 +3745,9 @@ var validateView = (function (attrs, dataSets, queryEngineConfig) {
   // Check the data set for the view exists
   var dataSet = find(dataSets, attrs.dataSetId);
   if (!dataSet) return [new DataSetNotFound(dataSets, attrs.dataSetId)];
-  var requiredFields = usedFields(attrs);
+  var requiredFields = usedFields(attrs).map(function (field) {
+    return field.fieldId;
+  });
   try {
     requiredFields.forEach(function (requiredField) {
       findField(dataSet, requiredField);
@@ -23080,6 +23102,7 @@ var getDataSetsUsedOnDisplay = function getDataSetsUsedOnDisplay(dashboard) {
       if (!isComponentEmpty(component) && !isComponent(component)) {
         usedDataSetIds = [].concat(usedDataSetIds, [component.attributes.dataSetId]);
       }
+      return;
     });
   });
   return uniq(usedDataSetIds).flatMap(function (dataSetId) {
@@ -23260,6 +23283,83 @@ var checkAndReturnProgrammaticDashboardId = function checkAndReturnProgrammaticD
   }
   return programmaticDashboards[0].id;
 };
+var getFieldUsage = function getFieldUsage(dashboardDefinition, dataSets) {
+  var fieldUsageFields = [];
+
+  // TODO; look through the fields used in custom metrics
+  // and add those to the list of used fields
+
+  // TODO; look through the component library and
+  // add those fields to the list of those used by the dashboard
+  // NOTE; initial plan was to store fields used in the library on the library
+  // field usage, however at this point, we get the component library and the
+  // dashboard manager updates them separately, meaning we'd need to pass through
+  // the field usage individually for the dashboard or the component library, but we
+  // only allow one pass through of used fields at the moment.
+
+  // Add fields from the global filters
+  dashboardDefinition.globalFilters.forEach(function (globalFilter) {
+    globalFilter.appliesToFields.forEach(function (field) {
+      try {
+        var dataSet = find(dataSets, field.dataSetId);
+        if (!dataSet) {
+          logDebug('Did not find data set when finding field usage', field.dataSetId);
+          return;
+        }
+        var fieldInDataSet = findField(dataSet, field.fieldId);
+        fieldUsageFields = [].concat(fieldUsageFields, [{
+          data_set_id: field.dataSetId,
+          field_id: field.fieldId,
+          "function": 'none',
+          name: fieldInDataSet.publicName
+        }]);
+      } catch (e) {
+        if (e instanceof FieldNotFoundInDataSet) {
+          logDebug("Did not find field in data set, assuming custom metric. " + field.fieldId);
+        } else {
+          logError(e);
+        }
+        return;
+      }
+    });
+  });
+
+  // Add fields from the views on the dashboard
+  dashboardDefinition.display.forEach(function (row) {
+    row.components.forEach(function (component) {
+      if (!('attributes' in component)) return;
+      var dataSet = find(dataSets, component.attributes.dataSetId);
+      if (!dataSet) {
+        logDebug('Did not find field in data set, assuming custom metric. ', component.attributes.dataSetId);
+        return;
+      }
+      var fields = usedFields(component.attributes).flatMap(function (usedField) {
+        try {
+          var field = findField(dataSet, usedField.fieldId);
+          return [{
+            data_set_id: usedField.dataSetId,
+            field_id: usedField.fieldId,
+            "function": usedField["function"],
+            name: field.publicName
+          }];
+        } catch (e) {
+          if (e instanceof FieldNotFoundInDataSet) {
+            logDebug("Did not find field in data set, assuming custom metric. " + usedField.fieldId);
+          } else {
+            logError(e);
+          }
+        }
+        return [];
+      });
+      fieldUsageFields = [].concat(fieldUsageFields, fields);
+      return;
+    });
+  });
+  return {
+    lowest_date_granularity_function: null,
+    fields: fieldUsageFields
+  };
+};
 
 // type RawGlobalFilter = Omit<GlobalFilter, 'context'>;
 var Dashboard;
@@ -23294,6 +23394,7 @@ var DashboardLogic = {
   updateWithProgrammaticDashboard: updateWithProgrammaticDashboard,
   addUniqueLibraryComponents: addUniqueLibraryComponents,
   checkAndReturnProgrammaticDashboardId: checkAndReturnProgrammaticDashboardId,
+  getFieldUsage: getFieldUsage,
   colSpanSchema: colSpanSchema,
   saveableDashboardDefinitionSchema: saveableDashboardDefinitionSchema,
   displaySchema: displaySchema,
@@ -26289,7 +26390,9 @@ var filterStyles = /*#__PURE__*/Object.assign(function () {
 /** Returns a key to be used in an useEffect dependency, that changes if there's any change to a field in a data set. */
 var watchDataSetFieldChanges = function watchDataSetFieldChanges(dataSet, queryable) {
   if ('dataSetId' in queryable) {
-    var watchFields = usedFields(queryable);
+    var watchFields = usedFields(queryable).map(function (field) {
+      return field.fieldId;
+    });
 
     // Custom fields are the only ones that can have their definition changed. So
     // we only need to watch them.
@@ -26411,7 +26514,9 @@ var useVariablesInDataSet = function useVariablesInDataSet(dataSet, queryable, v
     setNoOfVariableChanges = _useState3[1];
   useEffect(function () {
     if ('dataSetId' in queryable) {
-      var watchFields = usedFields(queryable);
+      var watchFields = usedFields(queryable).map(function (field) {
+        return field.fieldId;
+      });
       if (variables && variables.changes) {
         Object.keys(variables.changes).forEach(function (variableId) {
           var watchedCustomFields = checkFieldsForVariableInValues(watchFields, dataSet, variableId, findField, function (filterValue) {
@@ -26429,7 +26534,9 @@ var useVariablesInDataSet = function useVariablesInDataSet(dataSet, queryable, v
   }, [JSON.stringify(variables)]);
   useEffect(function () {
     if ('dataSetId' in queryable) {
-      var watchFields = usedFields(queryable);
+      var watchFields = usedFields(queryable).map(function (field) {
+        return field.fieldId;
+      });
       if (variables && variables.variables) {
         watchFields.forEach(function (fieldId) {
           var dataSetField = findField(dataSet, fieldId);
@@ -73152,7 +73259,8 @@ var VizzlyServices = /*#__PURE__*/function () {
               parentDashboardId: params.parentDashboardId,
               permissions: [{
                 scope: 'read_write'
-              }]
+              }],
+              usage_metadata: params.definition ? getFieldUsage(params.definition, this.dataSets) : undefined
             });
           case 5:
             _yield$dashboardManag = _context3.sent;
@@ -73188,7 +73296,8 @@ var VizzlyServices = /*#__PURE__*/function () {
               definition: params.definition,
               deleted: params.deleted,
               abortSignal: params.abortSignal,
-              name: params.name
+              name: params.name,
+              usage_metadata: params.definition ? getFieldUsage(params.definition, this.dataSets) : undefined
             });
           case 5:
             dashboard = _context4.sent;
@@ -73695,7 +73804,9 @@ if (typeof window !== 'undefined' && !window.Vizzly) {
 // @ts-ignore
 var Vizzly$1 =
 // @ts-ignore
-typeof window !== 'undefined' ? window.Vizzly || VizzlyServices : VizzlyServices;
+typeof window !== 'undefined' ?
+// @ts-ignore
+window.Vizzly || VizzlyServices : VizzlyServices;
 
 function pushGlobalLibraryCustomFieldsIntoDashboardFields(preparedDataSets, customFields) {
   [].concat(preparedDataSets).forEach(function (dataset) {

package/dist/shared-logic/src/Component/usedFields.d.ts

@@ -2,5 +2,9 @@ import { QueryAttributes } from '../QueryAttributes/types';
 import { Component } from './types';
 export declare const usedMeasures: (attrs: Partial<Component.Attributes | QueryAttributes>) => QueryAttributes['measure'];
 export declare const usedDimensions: (attrs: Partial<Component.Attributes | QueryAttributes>) => QueryAttributes['dimension'];
-declare const usedFields: (attrs: Partial<Component.Attributes | QueryAttributes>) => string[];
+declare const usedFields: (attrs: Partial<Component.Attributes | QueryAttributes>) => Array<{
+    dataSetId: string;
+    fieldId: string;
+    function: string;
+}>;
 export default usedFields;

package/dist/shared-logic/src/Dashboard/Dashboard.d.ts

@@ -2,6 +2,7 @@ import { Component as ComponentType } from '../Component/types';
 import { DataSet } from '../DataSet/types';
 import { CustomField } from '../CustomField/types';
 import { Dashboard, SaveableDashboardDefinition, ImportableDashboard } from './types';
+import { FieldUsage } from '@vizzly/api-client';
 export * from './saveableDashboardDefinitionSchema';
 export * from './fromRaw';
 export declare const indexOfDataSet: (dashboard: Dashboard, dataSetId: string) => number;
@@ -35,3 +36,4 @@ export declare const VIZZLY_EDITOR_ID = "vizzly_editor";
 export declare function updateWithProgrammaticDashboard(allDashboards: Dashboard[], programmaticDashboards: Dashboard[]): Dashboard[];
 export declare const addUniqueLibraryComponents: (programmaticLibrary: ComponentType[], dashboardLibrary: ComponentType[]) => ComponentType[];
 export declare const checkAndReturnProgrammaticDashboardId: (dashboards: Dashboard[]) => string | undefined;
+export declare const getFieldUsage: (dashboardDefinition: SaveableDashboardDefinition, dataSets: DataSet[]) => FieldUsage;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vizzly/dashboard",
   "author": "james@vizzly.co",
-  "version": "0.14.4-dev-bba43aecbb9d5b65a950ef259163441af1041848",
+  "version": "0.14.4-dev-7cba24e151ef9b87b5980bb4d617335aa42d5fc5",
   "source": "src/index.tsx",
   "types": "./dist/dashboard/src/index.d.ts",
   "module": "./dist/dashboard.esm.js",
@@ -53,7 +53,7 @@
     "@react-hook/window-size": "^3.1.1",
     "@react-spring/web": "9.6.1",
     "@visx/visx": "^3.10.2",
-    "@vizzly/api-client": "0.0.46",
+    "@vizzly/api-client": "0.0.51",
     "@vizzly/joi": "^17.7.0",
     "@vizzly/semantic-layer-public": "0.0.229",
     "@vizzly/sqlbuilder-public": "0.1.33",