@vizzly/dashboard 0.15.0-dev-d8c6020f516c4db05074d3f3e57c59a3eb56308b → 0.15.0-dev-7ff9d1595e60e37497596000c80eee55ff192ba9

package/dist/dashboard.esm.js

@@ -12326,14 +12326,21 @@ var buildViewOnlyQuery = function buildViewOnlyQuery(dataSet) {
   };
 };
 
-// Idempotently add custom fields
+// Idempotently add custom fields, preferring those defined in data sets than persisted
+// on dashboards to allow updating.
 var addCustomFields = function addCustomFields(dataSets, customFields) {
   if (!customFields) return dataSets;
-  dataSets = dataSets.map(removeCustomFields);
   var newDataSets = [].concat(dataSets).map(function (dataSet) {
-    var customFieldsForDataSet = (customFields[dataSet.id] || []).map(upcast);
+    var customFieldsForDataSetFromDashboard = (customFields[dataSet.id] || []).map(upcast);
+    var preferredFieldIds = dataSet.fields.map(function (field) {
+      return field.id;
+    });
+    customFieldsForDataSetFromDashboard = customFieldsForDataSetFromDashboard.filter(function (persistedCustomFieldOnDashboard) {
+      var fieldIdAlreadyUsed = preferredFieldIds.includes(persistedCustomFieldOnDashboard.id);
+      return !fieldIdAlreadyUsed;
+    });
     return _extends({}, dataSet, {
-      fields: [].concat(dataSet.fields, customFieldsForDataSet)
+      fields: [].concat(dataSet.fields, customFieldsForDataSetFromDashboard)
     });
   });
   return [].concat(newDataSets);
@@ -73315,7 +73322,7 @@ var IN_BROWSER = 'in-browser';
  * access tokens used for the identity logic.
  */
 var VizzlyLoader = /*#__PURE__*/function () {
-  function VizzlyLoader(queryEngine, loadAccessTokens, loadDataSetsCallback, options) {
+  function VizzlyLoader(queryEngine, loadAccessTokens, loadDataSetsCallback, extraCustomFields, options) {
     if (options === void 0) {
       options = DEFAULT_OPTIONS$1;
     }
@@ -73324,7 +73331,9 @@ var VizzlyLoader = /*#__PURE__*/function () {
     this.queryEngine = void 0;
     this.loadAccessTokens = void 0;
     this.loadDataSetsCallback = void 0;
+    this.extraCustomFields = void 0;
     this.options = void 0;
+    this.extraCustomFields = extraCustomFields;
     this.queryEngine = queryEngine || IN_BROWSER;
     this.loadAccessTokens = loadAccessTokens;
     this.loadDataSetsCallback = loadDataSetsCallback;
@@ -73431,6 +73440,7 @@ var VizzlyLoader = /*#__PURE__*/function () {
   }();
   _proto.load = /*#__PURE__*/function () {
     var _load = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4() {
+      var _this2 = this;
       var _yield$Promise$all, identityConfig, queryEngineConfig, dataSets, dashboardStorageStrategy;
       return _regeneratorRuntime().wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
@@ -73443,13 +73453,22 @@ var VizzlyLoader = /*#__PURE__*/function () {
             queryEngineConfig = _yield$Promise$all[1];
             dataSets = _yield$Promise$all[2];
             dashboardStorageStrategy = this.getDashboardStorageStrategy(queryEngineConfig);
+            if (this.extraCustomFields) {
+              dataSets = dataSets.map(function (dataSet) {
+                var newFields = _this2.extraCustomFields ? _this2.extraCustomFields(dataSet) : [];
+                console.log('adding fields', newFields);
+                return _extends({}, dataSet, {
+                  fields: [].concat(dataSet.fields, newFields)
+                });
+              });
+            }
             return _context4.abrupt("return", {
               queryEngineConfig: queryEngineConfig,
               dataSets: dataSets,
               identityConfig: identityConfig,
               dashboardStorageStrategy: dashboardStorageStrategy
             });
-          case 8:
+          case 9:
           case "end":
             return _context4.stop();
         }
@@ -75593,17 +75612,21 @@ var VizzlyServices = /*#__PURE__*/function () {
     this.identityConfig = identityConfig;
     this.vizzlyAPIClient = getVizzlyAPIClient(identityConfig, dashboardStorageStrategy, options);
   }
+  var _proto = VizzlyServices.prototype;
+  _proto.getDataSets = function getDataSets() {
+    return this.dataSets;
+  }
 
   /**
    * @param properties
    * @param options
    * @returns Vizzly instance for programmatically managing dashboards.
-   */
+   */;
   VizzlyServices.load =
   /*#__PURE__*/
   function () {
     var _load = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(properties, options) {
-      var queryEngine, dataSetsFn, loadAccessTokens, programmaticDashboard, loader, _yield$loader$load, queryEngineConfig, dataSets, identityConfig, dashboardStorageStrategy, vizzly;
+      var queryEngine, dataSetsFn, loadAccessTokens, programmaticDashboard, extraCustomFields, loader, _yield$loader$load, queryEngineConfig, dataSets, identityConfig, dashboardStorageStrategy, vizzly;
       return _regeneratorRuntime().wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -75611,8 +75634,8 @@ var VizzlyServices = /*#__PURE__*/function () {
               options = DEFAULT_LOADER_OPTIONS;
             }
             logDebug('Starting load process for the services package.');
-            queryEngine = properties.queryEngine, dataSetsFn = properties.dataSets, loadAccessTokens = properties.identity, programmaticDashboard = properties.programmaticDashboard;
-            loader = new VizzlyLoader(queryEngine, loadAccessTokens, dataSetsFn, options);
+            queryEngine = properties.queryEngine, dataSetsFn = properties.dataSets, loadAccessTokens = properties.identity, programmaticDashboard = properties.programmaticDashboard, extraCustomFields = properties.extraCustomFields;
+            loader = new VizzlyLoader(queryEngine, loadAccessTokens, dataSetsFn, extraCustomFields, options);
             _context.next = 6;
             return loader.load();
           case 6:
@@ -75702,7 +75725,6 @@ var VizzlyServices = /*#__PURE__*/function () {
    * Use the dashboard API to create the dashboard, upcast
    * and return the dashboard with the data sets.
    */;
-  var _proto = VizzlyServices.prototype;
   _proto.createDashboard =
   /*#__PURE__*/
   function () {
@@ -78761,7 +78783,8 @@ var useSessionContext = function useSessionContext(params) {
     queryEngine: params.queryEngine,
     identity: params.identityCallback,
     dataSets: params.loadDataSetsCallback,
-    programmaticDashboard: params.programmaticDashboard
+    programmaticDashboard: params.programmaticDashboard,
+    extraCustomFields: params.extraCustomFields
   }, {
     apiHost: params.apiConfig.host,
     developerMode: params.developerMode,
@@ -78892,7 +78915,8 @@ var GlobalProviderContents = function GlobalProviderContents(props) {
     textOverride: textOverride,
     isEditor: props.isEditor,
     developerMode: developerMode,
-    textOverrides: props.textOverrides
+    textOverrides: props.textOverrides,
+    extraCustomFields: props.customFields
   });
   var updateDashboardHash = function updateDashboardHash(dashboard) {
     var definition = toSaveableDefinition(dashboard);

package/dist/services/src/index.d.ts

@@ -20,6 +20,7 @@ import { FilterConfig } from '../../shared-logic/src/AdditionalFilter/types';
 export type { FilterConfig } from '../../shared-logic/src/AdditionalFilter/types';
 export type { ViewConfiguration } from '../../shared-logic/src/ViewConfiguration/types';
 export { VizzlyInstanceNotLoaded } from './errors/VizzlyInstanceNotLoaded';
+import { CustomField } from '../../shared-logic/src/CustomField/types';
 export declare type Options = {
     apiHost: string;
 };
@@ -35,6 +36,7 @@ export declare type VizzlyServicesProperties = {
     identity: identityCallback;
     programmaticDashboard?: programmaticDashboardCallback;
     dataSets?: loadDataSetsCallback;
+    extraCustomFields?: (dataSet: DataSet) => Array<CustomField>;
 };
 declare class VizzlyServices {
     private queryEngineConfig;
@@ -52,6 +54,7 @@ declare class VizzlyServices {
     constructor(identityConfig: IdentityConfig, queryEngineConfig: QueryEngineConfig, dataSets: DataSet[], dashboardStorageStrategy: DashboardStorageStrategy, programmaticDashboard: programmaticDashboardCallback | undefined, options: {
         host: string;
     });
+    getDataSets(): DataSet<DataSet.Field>[];
     /**
      * @param properties
      * @param options

package/dist/shared-ui/src/contexts/DashboardBehaviour/types.d.ts

@@ -17,6 +17,7 @@ import { VariablesCallback } from '../../../../shared-logic/src/Variables/types'
 import { ClickSettingTypes } from '../../hooks/types';
 import { VizzlyComponents } from '../../types';
 import { UseVariableState } from '../Variables/types';
+import { CustomField } from '../../../../shared-logic/src/CustomField/types';
 declare type OverrideDeveloperInfo = {
     overrideKey: string;
     componentProps: any;
@@ -130,6 +131,7 @@ export declare type DashboardBehaviour = {
         hasUnsavedChanges: boolean;
     }) => void;
     updateDashboardHash?: (dashboard: Dashboard) => void;
+    customFields?: (dataSet: DataSet) => Array<CustomField>;
 };
 export declare type TextOverride = (key: string, defaultValue: string, options?: TranslationOptions) => string;
 export declare type FilterLibrary = (data: Component[]) => Component[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vizzly/dashboard",
   "author": "james@vizzly.co",
-  "version": "0.15.0-dev-d8c6020f516c4db05074d3f3e57c59a3eb56308b",
+  "version": "0.15.0-dev-7ff9d1595e60e37497596000c80eee55ff192ba9",
   "source": "src/index.tsx",
   "types": "./dist/dashboard/src/index.d.ts",
   "module": "./dist/dashboard.esm.js",