@player-ui/beacon-plugin-react 0.0.1-next.1

package/dist/index.cjs.js

@@ -0,0 +1,59 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+var beaconPlugin = require('@player-ui/beacon-plugin');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+const BeaconContext = React__default["default"].createContext({
+  handler: () => void 0
+});
+function useBeacon(initialArgs) {
+  const { handler } = React__default["default"].useContext(BeaconContext);
+  return (options) => {
+    handler(__spreadValues(__spreadValues({}, initialArgs), options != null ? options : {}));
+  };
+}
+class BeaconPlugin extends beaconPlugin.BeaconPlugin {
+  constructor() {
+    super(...arguments);
+    this.name = "beacon-web-plugin";
+  }
+  applyWeb(webPlayer) {
+    const handler = this.beacon.bind(this);
+    webPlayer.hooks.webComponent.tap(this.name, (Comp) => () => /* @__PURE__ */ React__default["default"].createElement(BeaconContext.Provider, {
+      value: { handler }
+    }, /* @__PURE__ */ React__default["default"].createElement(Comp, null)));
+  }
+}
+
+exports.BeaconContext = BeaconContext;
+exports.BeaconPlugin = BeaconPlugin;
+exports.useBeacon = useBeacon;
+Object.keys(beaconPlugin).forEach(function (k) {
+  if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return beaconPlugin[k]; }
+  });
+});
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { WebPlayerPlugin, WebPlayer } from '@player-ui/react';
+import { BeaconArgs, BeaconPlugin as BeaconPlugin$1 } from '@player-ui/beacon-plugin';
+export * from '@player-ui/beacon-plugin';
+
+declare type BeaconHandler = (options: BeaconArgs) => void;
+interface BeaconContextType {
+    /** A callback for when assets beacon data */
+    handler: BeaconHandler;
+}
+declare const BeaconContext: React.Context<BeaconContextType>;
+declare type BeaconCallbackArgs = Omit<BeaconArgs, 'view'>;
+declare type BeaconCallbackFn<T extends Partial<BeaconCallbackArgs>> = (options?: T) => void;
+/** A hook for creating a beacon handler */
+declare function useBeacon<T extends Partial<BeaconCallbackArgs>>(initialArgs: T): BeaconCallbackFn<Omit<BeaconCallbackArgs, keyof T>>;
+/**
+ * A plugin for adding beacon support to a web-player
+ */
+declare class BeaconPlugin extends BeaconPlugin$1 implements WebPlayerPlugin {
+    name: string;
+    applyWeb(webPlayer: WebPlayer): void;
+}
+
+export { BeaconCallbackArgs, BeaconCallbackFn, BeaconContext, BeaconContextType, BeaconHandler, BeaconPlugin, useBeacon };

package/dist/index.esm.js

@@ -0,0 +1,44 @@
+import React from 'react';
+import { BeaconPlugin as BeaconPlugin$1 } from '@player-ui/beacon-plugin';
+export * from '@player-ui/beacon-plugin';
+
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+const BeaconContext = React.createContext({
+  handler: () => void 0
+});
+function useBeacon(initialArgs) {
+  const { handler } = React.useContext(BeaconContext);
+  return (options) => {
+    handler(__spreadValues(__spreadValues({}, initialArgs), options != null ? options : {}));
+  };
+}
+class BeaconPlugin extends BeaconPlugin$1 {
+  constructor() {
+    super(...arguments);
+    this.name = "beacon-web-plugin";
+  }
+  applyWeb(webPlayer) {
+    const handler = this.beacon.bind(this);
+    webPlayer.hooks.webComponent.tap(this.name, (Comp) => () => /* @__PURE__ */ React.createElement(BeaconContext.Provider, {
+      value: { handler }
+    }, /* @__PURE__ */ React.createElement(Comp, null)));
+  }
+}
+
+export { BeaconContext, BeaconPlugin, useBeacon };
+//# sourceMappingURL=index.esm.js.map

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@player-ui/beacon-plugin-react",
+  "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": {
+    "@player-ui/binding-grammar": "0.0.1-next.1",
+    "@babel/runtime": "7.15.4"
+  },
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts"
+}

package/src/index.tsx

@@ -0,0 +1,54 @@
+import React from 'react';
+import type { WebPlayer, WebPlayerPlugin } from '@player-ui/react';
+import type { BeaconArgs } from '@player-ui/beacon-plugin';
+import { BeaconPlugin as BeaconCorePlugin } from '@player-ui/beacon-plugin';
+
+export * from '@player-ui/beacon-plugin';
+
+export type BeaconHandler = (options: BeaconArgs) => void;
+
+export interface BeaconContextType {
+  /** A callback for when assets beacon data */
+  handler: BeaconHandler;
+}
+
+export const BeaconContext = React.createContext<BeaconContextType>({
+  handler: () => undefined,
+});
+
+export type BeaconCallbackArgs = Omit<BeaconArgs, 'view'>;
+
+export type BeaconCallbackFn<T extends Partial<BeaconCallbackArgs>> = (
+  options?: T
+) => void;
+
+/** A hook for creating a beacon handler */
+export function useBeacon<T extends Partial<BeaconCallbackArgs>>(
+  initialArgs: T
+): BeaconCallbackFn<Omit<BeaconCallbackArgs, keyof T>> {
+  const { handler } = React.useContext(BeaconContext);
+
+  return (options?: Omit<BeaconCallbackArgs, keyof T>) => {
+    handler({
+      ...initialArgs,
+      ...(options ?? {}),
+    } as BeaconCallbackArgs);
+  };
+}
+
+/**
+ * A plugin for adding beacon support to a web-player
+ */
+export class BeaconPlugin extends BeaconCorePlugin implements WebPlayerPlugin {
+  name = 'beacon-web-plugin';
+
+  applyWeb(webPlayer: WebPlayer) {
+    const handler = this.beacon.bind(this);
+
+    webPlayer.hooks.webComponent.tap(this.name, (Comp) => () => (
+      <BeaconContext.Provider value={{ handler }}>
+        <Comp />
+      </BeaconContext.Provider>
+    ));
+  }
+}