@kitware/vtk.js 25.8.5 → 25.8.7

package/Common/Core/ClassHierarchy.js

@@ -1,4 +1,3 @@
-import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
 import _classCallCheck from '@babel/runtime/helpers/classCallCheck';
 import _createClass from '@babel/runtime/helpers/createClass';
 import _get from '@babel/runtime/helpers/get';
@@ -11,6 +10,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
+/* eslint-disable prefer-rest-params */
 var ClassHierarchy = /*#__PURE__*/function (_Array) {
   _inherits(ClassHierarchy, _Array);
 
@@ -25,18 +25,18 @@ var ClassHierarchy = /*#__PURE__*/function (_Array) {
   _createClass(ClassHierarchy, [{
     key: "push",
     value: function push() {
-      var _this = this,
-          _get2;
+      var _get2;
 
-      for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-        args[_key] = arguments[_key];
+      // using a for loop because a filter would trigger the garbage collector
+      var newArgs = [];
+
+      for (var i = 0; i < arguments.length; i++) {
+        if (!this.includes(arguments[i])) {
+          newArgs.push(arguments[i]);
+        }
       }
 
-      // no perf issue since args.length should be small
-      var newArgs = args.filter(function (arg) {
-        return !_this.includes(arg);
-      });
-      return (_get2 = _get(_getPrototypeOf(ClassHierarchy.prototype), "push", this)).call.apply(_get2, [this].concat(_toConsumableArray(newArgs)));
+      return (_get2 = _get(_getPrototypeOf(ClassHierarchy.prototype), "push", this)).call.apply(_get2, [this].concat(newArgs));
     }
   }]);
 

package/Rendering/Core/Prop3D.js

@@ -1,7 +1,7 @@
 import { mat4, quat } from 'gl-matrix';
 import macro from '../../macros.js';
 import vtkBoundingBox from '../../Common/DataModel/BoundingBox.js';
-import { B as degreesFromRadians, r as radiansFromDegrees } from '../../Common/Core/Math/index.js';
+import { B as degreesFromRadians, r as radiansFromDegrees, a as areMatricesEqual } from '../../Common/Core/Math/index.js';
 import vtkProp from './Prop.js';
 
 // vtkProp3D methods
@@ -83,8 +83,13 @@ function vtkProp3D(publicAPI, model) {
   };
 
   publicAPI.setUserMatrix = function (matrix) {
+    if (areMatricesEqual(model.userMatrix, matrix)) {
+      return false;
+    }
+
     mat4.copy(model.userMatrix, matrix);
     publicAPI.modified();
+    return true;
   };
 
   publicAPI.getMatrix = function () {

package/Widgets/Representations/WidgetRepresentation.js

@@ -1,4 +1,5 @@
 import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
+import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import macro from '../../macros.js';
 import vtkProp from '../../Rendering/Core/Prop.js';
 import { s as subtract, d as dot } from '../../Common/Core/Math/index.js';
@@ -6,6 +7,9 @@ import { Behavior } from './WidgetRepresentation/Constants.js';
 import { RenderingTypes } from '../Core/WidgetManager/Constants.js';
 import { CATEGORIES } from '../../Rendering/Core/Mapper/CoincidentTopologyHelper.js';
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var vtkErrorMacro = macro.vtkErrorMacro,
     vtkWarningMacro = macro.vtkWarningMacro; // ----------------------------------------------------------------------------
 
@@ -80,7 +84,10 @@ function connectPipeline(pipeline) {
 
 function vtkWidgetRepresentation(publicAPI, model) {
   // Set our className
-  model.classHierarchy.push('vtkWidgetRepresentation'); // Internal cache
+  model.classHierarchy.push('vtkWidgetRepresentation');
+
+  var superclass = _objectSpread({}, publicAPI); // Internal cache
+
 
   var cache = {
     mtimes: {},
@@ -210,10 +217,13 @@ function vtkWidgetRepresentation(publicAPI, model) {
   };
 
   publicAPI.setCoincidentTopologyParameters = function (parameters) {
-    model.coincidentTopologyParameters = parameters;
-    publicAPI.getActors().forEach(function (actor) {
-      applyCoincidentTopologyParametersToMapper(actor.getMapper(), model.coincidentTopologyParameters);
-    });
+    var modified = superclass.setCoincidentTopologyParameters(parameters);
+
+    if (modified) {
+      publicAPI.getActors().forEach(function (actor) {
+        applyCoincidentTopologyParametersToMapper(actor.getMapper(), model.coincidentTopologyParameters);
+      });
+    }
   };
 
   publicAPI.getPixelWorldHeightAtCoord = function (worldCoord) {
@@ -279,8 +289,14 @@ function extend(publicAPI, model) {
 
   vtkProp.extend(publicAPI, model, initialValues);
   macro.algo(publicAPI, model, 1, 1);
-  macro.get(publicAPI, model, ['labels', 'coincidentTopologyParameters']);
-  macro.set(publicAPI, model, ['displayScaleParams']);
+  macro.get(publicAPI, model, ['labels']);
+  macro.set(publicAPI, model, [{
+    type: 'object',
+    name: 'displayScaleParams'
+  }, {
+    type: 'object',
+    name: 'coincidentTopologyParameters'
+  }]);
   macro.setGet(publicAPI, model, ['scaleInPixels']); // Object specific methods
 
   vtkWidgetRepresentation(publicAPI, model);

package/Widgets/SVG/SVGLandmarkRepresentation.js

@@ -152,7 +152,19 @@ function defaultValues(initialValues) {
 function extend(publicAPI, model) {
   var initialValues = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   vtkSVGRepresentation.extend(publicAPI, model, defaultValues(initialValues));
-  macro.setGet(publicAPI, model, ['circleProps', 'fontProperties', 'strokeFontProperties', 'textProps']); // Object specific methods
+  macro.setGet(publicAPI, model, [{
+    type: 'object',
+    name: 'circleProps'
+  }, {
+    type: 'object',
+    name: 'fontProperties'
+  }, {
+    type: 'object',
+    name: 'strokeFontProperties'
+  }, {
+    type: 'object',
+    name: 'textProps'
+  }]); // Object specific methods
 
   vtkSVGLandmarkRepresentation(publicAPI, model);
 } // ----------------------------------------------------------------------------

package/_vendor/available-typed-arrays/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/call-bind/callBound.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/call-bind/callBound.js';

package/_vendor/call-bind/index.js_commonjs-module.js

@@ -0,0 +1,3 @@
+var callBind = {exports: {}};
+
+export { callBind as c };

package/_vendor/call-bind/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/call-bind/index.js';

package/_vendor/deep-equal/node_modules/isarray/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/define-properties/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/define-properties/index.js';

package/_vendor/es-abstract/helpers/getOwnPropertyDescriptor.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/es-get-iterator/index.js_commonjs-module.js

@@ -0,0 +1,3 @@
+var esGetIterator = {exports: {}};
+
+export { esGetIterator as e };

package/_vendor/es-get-iterator/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/es-get-iterator/index.js';

package/_vendor/es-get-iterator/node_modules/isarray/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/foreach/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/function-bind/implementation.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/function-bind/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/get-intrinsic/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/get-intrinsic/index.js';

package/_vendor/has/src/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../../vendor/has/src/index.js';

package/_vendor/has-bigints/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/has-bigints/index.js';

package/_vendor/has-symbols/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/has-symbols/shams.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/has-tostringtag/shams.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/is-arguments/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-arguments/index.js';

package/_vendor/is-bigint/index.js_commonjs-module.js

@@ -0,0 +1,3 @@
+var isBigint = {exports: {}};
+
+export { isBigint as i };

package/_vendor/is-bigint/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-bigint/index.js';

package/_vendor/is-boolean-object/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-boolean-object/index.js';

package/_vendor/is-date-object/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/is-map/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-map/index.js';

package/_vendor/is-number-object/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-number-object/index.js';

package/_vendor/is-regex/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-regex/index.js';

package/_vendor/is-set/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-set/index.js';

package/_vendor/is-string/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-string/index.js';

package/_vendor/is-symbol/index.js_commonjs-module.js

@@ -0,0 +1,3 @@
+var isSymbol = {exports: {}};
+
+export { isSymbol as i };

package/_vendor/is-symbol/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-symbol/index.js';

package/_vendor/is-typed-array/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-typed-array/index.js';

package/_vendor/is-weakmap/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-weakmap/index.js';

package/_vendor/is-weakset/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/is-weakset/index.js';

package/_vendor/object-inspect/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/object-is/implementation.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/object-is/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/object-is/index.js';

package/_vendor/object-is/polyfill.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/object-is/shim.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/define-properties/index.js';

package/_vendor/object-keys/implementation.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/object-keys/implementation.js';

package/_vendor/object-keys/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/object-keys/index.js';

package/_vendor/object-keys/isArguments.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/object.assign/implementation.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/object.assign/implementation.js';

package/_vendor/object.assign/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/object.assign/index.js';

package/_vendor/object.assign/polyfill.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/object.assign/implementation.js';

package/_vendor/object.assign/shim.js_commonjs-proxy.js

@@ -0,0 +1,2 @@
+import '../../vendor/define-properties/index.js';
+import '../../vendor/object.assign/implementation.js';

package/_vendor/regexp.prototype.flags/implementation.js_commonjs-proxy.js

@@ -0,0 +1 @@
+

package/_vendor/regexp.prototype.flags/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/regexp.prototype.flags/index.js';

package/_vendor/regexp.prototype.flags/polyfill.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/define-properties/index.js';

package/_vendor/regexp.prototype.flags/shim.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/define-properties/index.js';

package/_vendor/side-channel/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/side-channel/index.js';

package/_vendor/which-boxed-primitive/index.js_commonjs-proxy.js

@@ -0,0 +1,5 @@
+import '../../vendor/is-string/index.js';
+import '../../vendor/is-number-object/index.js';
+import '../../vendor/is-boolean-object/index.js';
+import '../../vendor/is-symbol/index.js';
+import '../../vendor/is-bigint/index.js';

package/_vendor/which-collection/index.js_commonjs-proxy.js

@@ -0,0 +1,4 @@
+import '../../vendor/is-map/index.js';
+import '../../vendor/is-set/index.js';
+import '../../vendor/is-weakmap/index.js';
+import '../../vendor/is-weakset/index.js';

package/_vendor/which-typed-array/index.js_commonjs-proxy.js

@@ -0,0 +1 @@
+import '../../vendor/which-typed-array/index.js';

package/_virtual/_node-resolve_empty.js_commonjs-proxy.js

@@ -0,0 +1,6 @@
+import { _ as _nodeResolve_empty } from './node-resolve_empty.js';
+import { g as getAugmentedNamespace } from './commonjsHelpers.js';
+
+var require$$0 = /*@__PURE__*/getAugmentedNamespace(_nodeResolve_empty);
+
+export { require$$0 as r };

package/_virtual/commonjsHelpers.js

@@ -0,0 +1,18 @@
+var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
+
+function getAugmentedNamespace(n) {
+	if (n.__esModule) return n;
+	var a = Object.defineProperty({}, '__esModule', {value: true});
+	Object.keys(n).forEach(function (k) {
+		var d = Object.getOwnPropertyDescriptor(n, k);
+		Object.defineProperty(a, k, d.get ? d : {
+			enumerable: true,
+			get: function () {
+				return n[k];
+			}
+		});
+	});
+	return a;
+}
+
+export { commonjsGlobal as c, getAugmentedNamespace as g };

package/_virtual/node-resolve_empty.js

@@ -0,0 +1,8 @@
+var _nodeResolve_empty = {};
+
+var _nodeResolve_empty$1 = /*#__PURE__*/Object.freeze({
+	__proto__: null,
+	'default': _nodeResolve_empty
+});
+
+export { _nodeResolve_empty$1 as _ };

package/_virtual/polyfill-node.global.js

@@ -0,0 +1,5 @@
+var global$1 = (typeof global !== "undefined" ? global :
+  typeof self !== "undefined" ? self :
+  typeof window !== "undefined" ? window : {});
+
+export { global$1 as g };

package/_virtual/polyfill-node.process.js

@@ -0,0 +1,225 @@
+import { g as global } from './polyfill-node.global.js';
+
+// shim for using process in browser
+// based off https://github.com/defunctzombie/node-process/blob/master/browser.js
+
+function defaultSetTimout() {
+    throw new Error('setTimeout has not been defined');
+}
+function defaultClearTimeout () {
+    throw new Error('clearTimeout has not been defined');
+}
+var cachedSetTimeout = defaultSetTimout;
+var cachedClearTimeout = defaultClearTimeout;
+if (typeof global.setTimeout === 'function') {
+    cachedSetTimeout = setTimeout;
+}
+if (typeof global.clearTimeout === 'function') {
+    cachedClearTimeout = clearTimeout;
+}
+
+function runTimeout(fun) {
+    if (cachedSetTimeout === setTimeout) {
+        //normal enviroments in sane situations
+        return setTimeout(fun, 0);
+    }
+    // if setTimeout wasn't available but was latter defined
+    if ((cachedSetTimeout === defaultSetTimout || !cachedSetTimeout) && setTimeout) {
+        cachedSetTimeout = setTimeout;
+        return setTimeout(fun, 0);
+    }
+    try {
+        // when when somebody has screwed with setTimeout but no I.E. maddness
+        return cachedSetTimeout(fun, 0);
+    } catch(e){
+        try {
+            // When we are in I.E. but the script has been evaled so I.E. doesn't trust the global object when called normally
+            return cachedSetTimeout.call(null, fun, 0);
+        } catch(e){
+            // same as above but when it's a version of I.E. that must have the global object for 'this', hopfully our context correct otherwise it will throw a global error
+            return cachedSetTimeout.call(this, fun, 0);
+        }
+    }
+
+
+}
+function runClearTimeout(marker) {
+    if (cachedClearTimeout === clearTimeout) {
+        //normal enviroments in sane situations
+        return clearTimeout(marker);
+    }
+    // if clearTimeout wasn't available but was latter defined
+    if ((cachedClearTimeout === defaultClearTimeout || !cachedClearTimeout) && clearTimeout) {
+        cachedClearTimeout = clearTimeout;
+        return clearTimeout(marker);
+    }
+    try {
+        // when when somebody has screwed with setTimeout but no I.E. maddness
+        return cachedClearTimeout(marker);
+    } catch (e){
+        try {
+            // When we are in I.E. but the script has been evaled so I.E. doesn't  trust the global object when called normally
+            return cachedClearTimeout.call(null, marker);
+        } catch (e){
+            // same as above but when it's a version of I.E. that must have the global object for 'this', hopfully our context correct otherwise it will throw a global error.
+            // Some versions of I.E. have different rules for clearTimeout vs setTimeout
+            return cachedClearTimeout.call(this, marker);
+        }
+    }
+
+
+
+}
+var queue = [];
+var draining = false;
+var currentQueue;
+var queueIndex = -1;
+
+function cleanUpNextTick() {
+    if (!draining || !currentQueue) {
+        return;
+    }
+    draining = false;
+    if (currentQueue.length) {
+        queue = currentQueue.concat(queue);
+    } else {
+        queueIndex = -1;
+    }
+    if (queue.length) {
+        drainQueue();
+    }
+}
+
+function drainQueue() {
+    if (draining) {
+        return;
+    }
+    var timeout = runTimeout(cleanUpNextTick);
+    draining = true;
+
+    var len = queue.length;
+    while(len) {
+        currentQueue = queue;
+        queue = [];
+        while (++queueIndex < len) {
+            if (currentQueue) {
+                currentQueue[queueIndex].run();
+            }
+        }
+        queueIndex = -1;
+        len = queue.length;
+    }
+    currentQueue = null;
+    draining = false;
+    runClearTimeout(timeout);
+}
+function nextTick(fun) {
+    var args = new Array(arguments.length - 1);
+    if (arguments.length > 1) {
+        for (var i = 1; i < arguments.length; i++) {
+            args[i - 1] = arguments[i];
+        }
+    }
+    queue.push(new Item(fun, args));
+    if (queue.length === 1 && !draining) {
+        runTimeout(drainQueue);
+    }
+}
+// v8 likes predictible objects
+function Item(fun, array) {
+    this.fun = fun;
+    this.array = array;
+}
+Item.prototype.run = function () {
+    this.fun.apply(null, this.array);
+};
+var title = 'browser';
+var platform = 'browser';
+var browser = true;
+var env = {};
+var argv = [];
+var version = ''; // empty string to avoid regexp issues
+var versions = {};
+var release = {};
+var config = {};
+
+function noop() {}
+
+var on = noop;
+var addListener = noop;
+var once = noop;
+var off = noop;
+var removeListener = noop;
+var removeAllListeners = noop;
+var emit = noop;
+
+function binding(name) {
+    throw new Error('process.binding is not supported');
+}
+
+function cwd () { return '/' }
+function chdir (dir) {
+    throw new Error('process.chdir is not supported');
+}function umask() { return 0; }
+
+// from https://github.com/kumavis/browser-process-hrtime/blob/master/index.js
+var performance = global.performance || {};
+var performanceNow =
+  performance.now        ||
+  performance.mozNow     ||
+  performance.msNow      ||
+  performance.oNow       ||
+  performance.webkitNow  ||
+  function(){ return (new Date()).getTime() };
+
+// generate timestamp or delta
+// see http://nodejs.org/api/process.html#process_process_hrtime
+function hrtime(previousTimestamp){
+  var clocktime = performanceNow.call(performance)*1e-3;
+  var seconds = Math.floor(clocktime);
+  var nanoseconds = Math.floor((clocktime%1)*1e9);
+  if (previousTimestamp) {
+    seconds = seconds - previousTimestamp[0];
+    nanoseconds = nanoseconds - previousTimestamp[1];
+    if (nanoseconds<0) {
+      seconds--;
+      nanoseconds += 1e9;
+    }
+  }
+  return [seconds,nanoseconds]
+}
+
+var startTime = new Date();
+function uptime() {
+  var currentTime = new Date();
+  var dif = currentTime - startTime;
+  return dif / 1000;
+}
+
+var browser$1 = {
+  nextTick: nextTick,
+  title: title,
+  browser: browser,
+  env: env,
+  argv: argv,
+  version: version,
+  versions: versions,
+  on: on,
+  addListener: addListener,
+  once: once,
+  off: off,
+  removeListener: removeListener,
+  removeAllListeners: removeAllListeners,
+  emit: emit,
+  binding: binding,
+  cwd: cwd,
+  chdir: chdir,
+  umask: umask,
+  hrtime: hrtime,
+  platform: platform,
+  release: release,
+  config: config,
+  uptime: uptime
+};
+
+export { browser$1 as b };

package/macros.d.ts

@@ -172,17 +172,19 @@ export function get(publicAPI: object, model: object, fieldNames: Array<string>)
  * @param publicAPI object on which public methods get attached to
  * @param model object on which protected fields are stored
  * @param fieldNames list of fields available in model that we want to expose as set{FieldName} methods on the publicAPI
+ * * Can be a string (the name of the field to expose) or an object (e.g. {type:enum, name: {FieldName}, enum: FieldEnum}).
  */
-export function set(publicAPI: object, model: object, fields: Array<string>): void;
+export function set(publicAPI: object, model: object, fields: Array<string|object>): void;
 
 /**
  * Add setter+getter methods to the provided publicAPI
  *
  * @param publicAPI object on which public methods get attached to
  * @param model object on which protected fields are stored
- * @param fieldNames list of fields available in model that we want to expose as set{FieldName}+get{FieldName} methods on the publicAPI
+ * @param fieldNames list of fields available in model that we want to expose as set{FieldName}+get{FieldName} methods on the publicAPI.
+ * Can be a string (the name of the field to expose) or an object (e.g. {type:enum, name: {FieldName}, enum: FieldEnum}).
  */
-export function setGet(publicAPI: object, model: object, fields: Array<string>): void;
+export function setGet(publicAPI: object, model: object, fields: Array<string|object>): void;
 
 /**
  * Add getter methods to the provided publicAPI for arrays.