@player-ui/data-filter-plugin 0.0.1-next.1

package/dist/index.cjs.js

@@ -0,0 +1,49 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var get = require('dlv');
+var timm = require('timm');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var get__default = /*#__PURE__*/_interopDefaultLegacy(get);
+
+function omitIn(obj, path) {
+  if (typeof path === "string") {
+    return timm.omit(obj, path);
+  }
+  if (path.length === 1) {
+    return timm.omit(obj, path[0]);
+  }
+  const parentPath = [...path];
+  const attr = parentPath.pop();
+  if (!attr) {
+    return obj;
+  }
+  const parentObj = get__default["default"](obj, parentPath);
+  return timm.setIn(obj, parentPath, timm.omit(parentObj, attr));
+}
+class DataFilterPlugin {
+  constructor(options = {}) {
+    this.name = "data-filter";
+    this.options = options;
+  }
+  apply(player) {
+    player.hooks.dataController.tap(this.name, (dataController) => {
+      dataController.hooks.serialize.tap(this.name, (serializedModel) => {
+        var _a;
+        let updatedModel = serializedModel;
+        (_a = this.options.paths) == null ? void 0 : _a.forEach((path) => {
+          const arrPath = Array.isArray(path) ? path : path.split(".");
+          updatedModel = omitIn(updatedModel, arrPath);
+        });
+        return updatedModel;
+      });
+    });
+  }
+}
+
+exports.DataFilterPlugin = DataFilterPlugin;
+exports.omitIn = omitIn;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import { PlayerPlugin, Player } from '@player-ui/player';
+
+interface DataFilterPluginOptions {
+    /** Paths in the model that should be omitted from the serialized result */
+    paths?: Array<string | Array<string>>;
+}
+/**
+ * Similar to timm's omit, but for deeper paths
+ */
+declare function omitIn(obj: Record<string, unknown>, path: string | Array<string>): unknown;
+/**
+ * A plugin to manage constant strings across flows
+ * It allows for runtime extensions/overrides through a `constants` property in the flow
+ */
+declare class DataFilterPlugin implements PlayerPlugin {
+    name: string;
+    private readonly options;
+    constructor(options?: DataFilterPluginOptions);
+    apply(player: Player): void;
+}
+
+export { DataFilterPlugin, DataFilterPluginOptions, omitIn };

package/dist/index.esm.js

@@ -0,0 +1,40 @@
+import get from 'dlv';
+import { omit, setIn } from 'timm';
+
+function omitIn(obj, path) {
+  if (typeof path === "string") {
+    return omit(obj, path);
+  }
+  if (path.length === 1) {
+    return omit(obj, path[0]);
+  }
+  const parentPath = [...path];
+  const attr = parentPath.pop();
+  if (!attr) {
+    return obj;
+  }
+  const parentObj = get(obj, parentPath);
+  return setIn(obj, parentPath, omit(parentObj, attr));
+}
+class DataFilterPlugin {
+  constructor(options = {}) {
+    this.name = "data-filter";
+    this.options = options;
+  }
+  apply(player) {
+    player.hooks.dataController.tap(this.name, (dataController) => {
+      dataController.hooks.serialize.tap(this.name, (serializedModel) => {
+        var _a;
+        let updatedModel = serializedModel;
+        (_a = this.options.paths) == null ? void 0 : _a.forEach((path) => {
+          const arrPath = Array.isArray(path) ? path : path.split(".");
+          updatedModel = omitIn(updatedModel, arrPath);
+        });
+        return updatedModel;
+      });
+    });
+  }
+}
+
+export { DataFilterPlugin, omitIn };
+//# sourceMappingURL=index.esm.js.map

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@player-ui/data-filter-plugin",
+  "version": "0.0.1-next.1",
+  "private": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "peerDependencies": {
+    "@player-ui/binding-grammar": "0.0.1-next.1"
+  },
+  "dependencies": {
+    "timm": "^1.6.2",
+    "dlv": "^1.1.3",
+    "@babel/runtime": "7.15.4"
+  },
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts"
+}

package/src/index.ts

@@ -0,0 +1,64 @@
+import type { Player, PlayerPlugin } from '@player-ui/player';
+import get from 'dlv';
+import { omit, setIn } from 'timm';
+
+export interface DataFilterPluginOptions {
+  /** Paths in the model that should be omitted from the serialized result */
+  paths?: Array<string | Array<string>>;
+}
+
+/**
+ * Similar to timm's omit, but for deeper paths
+ */
+export function omitIn(
+  obj: Record<string, unknown>,
+  path: string | Array<string>
+): unknown {
+  if (typeof path === 'string') {
+    return omit(obj, path);
+  }
+
+  if (path.length === 1) {
+    return omit(obj, path[0]);
+  }
+
+  const parentPath = [...path];
+  const attr = parentPath.pop();
+
+  if (!attr) {
+    return obj;
+  }
+
+  const parentObj = get(obj, parentPath);
+
+  return setIn(obj, parentPath, omit(parentObj, attr));
+}
+
+/**
+ * A plugin to manage constant strings across flows
+ * It allows for runtime extensions/overrides through a `constants` property in the flow
+ */
+export class DataFilterPlugin implements PlayerPlugin {
+  name = 'data-filter';
+
+  private readonly options: DataFilterPluginOptions;
+
+  constructor(options: DataFilterPluginOptions = {}) {
+    this.options = options;
+  }
+
+  apply(player: Player) {
+    player.hooks.dataController.tap(this.name, (dataController) => {
+      dataController.hooks.serialize.tap(this.name, (serializedModel) => {
+        let updatedModel = serializedModel;
+
+        this.options.paths?.forEach((path) => {
+          const arrPath = Array.isArray(path) ? path : path.split('.');
+          updatedModel = omitIn(updatedModel, arrPath);
+        });
+
+        return updatedModel;
+      });
+    });
+  }
+}