@player-ui/types-provider-plugin 0.0.1-next.1

package/dist/index.cjs.js

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class TypesProviderPlugin {
+  constructor(config) {
+    this.name = "TypesProviderPlugin";
+    this.config = config;
+  }
+  apply(player) {
+    player.hooks.schema.tap(this.name, (schema) => {
+      if (this.config.types) {
+        schema.addDataTypes(this.config.types);
+      }
+      if (this.config.formats) {
+        schema.addFormatters(this.config.formats);
+      }
+    });
+    if (this.config.validators) {
+      player.hooks.validationController.tap(this.name, (validationController) => {
+        validationController.hooks.createValidatorRegistry.tap(this.name, (validationRegistry) => {
+          var _a;
+          (_a = this.config.validators) == null ? void 0 : _a.forEach(([name, handler]) => {
+            validationRegistry.register(name, handler);
+          });
+        });
+      });
+    }
+  }
+}
+
+exports.TypesProviderPlugin = TypesProviderPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { PlayerPlugin, Player } from '@player-ui/player';
+import { ValidatorFunction } from '@player-ui/validator';
+import { FormatType } from '@player-ui/schema';
+import { Schema } from '@player-ui/types';
+
+interface TypesConfig {
+    /**
+     * DataTypes to expose to Player instance.
+     * The schema definition in authored content can reference these to get common functionality across types
+     */
+    types?: Array<Schema.DataType<any>>;
+    /**
+     * Custom validators to add to this player instance.
+     * Anything defined here will be available for use in any DataType or view-validation
+     */
+    validators?: Array<[string, ValidatorFunction<any>]>;
+    /** A list of formats (and handler functions) to expose to DataTypes */
+    formats?: Array<FormatType<any, any, any>>;
+}
+/**
+ * The TypesProvider plugin provides an easy way for users to expose custom validators, DataTypes, or formatters to the content
+ */
+declare class TypesProviderPlugin implements PlayerPlugin {
+    name: string;
+    private config;
+    constructor(config: TypesConfig);
+    apply(player: Player): void;
+}
+
+export { TypesConfig, TypesProviderPlugin };

package/dist/index.esm.js

@@ -0,0 +1,29 @@
+class TypesProviderPlugin {
+  constructor(config) {
+    this.name = "TypesProviderPlugin";
+    this.config = config;
+  }
+  apply(player) {
+    player.hooks.schema.tap(this.name, (schema) => {
+      if (this.config.types) {
+        schema.addDataTypes(this.config.types);
+      }
+      if (this.config.formats) {
+        schema.addFormatters(this.config.formats);
+      }
+    });
+    if (this.config.validators) {
+      player.hooks.validationController.tap(this.name, (validationController) => {
+        validationController.hooks.createValidatorRegistry.tap(this.name, (validationRegistry) => {
+          var _a;
+          (_a = this.config.validators) == null ? void 0 : _a.forEach(([name, handler]) => {
+            validationRegistry.register(name, handler);
+          });
+        });
+      });
+    }
+  }
+}
+
+export { TypesProviderPlugin };
+//# sourceMappingURL=index.esm.js.map

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@player-ui/types-provider-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": {
+    "tapable": "1.1.3",
+    "@types/tapable": "^1.0.5",
+    "@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,62 @@
+import type { Player, PlayerPlugin } from '@player-ui/player';
+import type { ValidatorFunction } from '@player-ui/validator';
+import type { FormatType } from '@player-ui/schema';
+import type { Schema } from '@player-ui/types';
+
+export interface TypesConfig {
+  /**
+   * DataTypes to expose to Player instance.
+   * The schema definition in authored content can reference these to get common functionality across types
+   */
+  types?: Array<Schema.DataType<any>>;
+
+  /**
+   * Custom validators to add to this player instance.
+   * Anything defined here will be available for use in any DataType or view-validation
+   */
+  validators?: Array<[string, ValidatorFunction<any>]>;
+
+  /** A list of formats (and handler functions) to expose to DataTypes */
+  formats?: Array<FormatType<any, any, any>>;
+}
+
+/**
+ * The TypesProvider plugin provides an easy way for users to expose custom validators, DataTypes, or formatters to the content
+ */
+export class TypesProviderPlugin implements PlayerPlugin {
+  name = 'TypesProviderPlugin';
+
+  private config: TypesConfig;
+
+  constructor(config: TypesConfig) {
+    this.config = config;
+  }
+
+  apply(player: Player) {
+    player.hooks.schema.tap(this.name, (schema) => {
+      if (this.config.types) {
+        schema.addDataTypes(this.config.types);
+      }
+
+      if (this.config.formats) {
+        schema.addFormatters(this.config.formats);
+      }
+    });
+
+    if (this.config.validators) {
+      player.hooks.validationController.tap(
+        this.name,
+        (validationController) => {
+          validationController.hooks.createValidatorRegistry.tap(
+            this.name,
+            (validationRegistry) => {
+              this.config.validators?.forEach(([name, handler]) => {
+                validationRegistry.register(name, handler);
+              });
+            }
+          );
+        }
+      );
+    }
+  }
+}