@player-ui/check-path-plugin-react 0.0.1-next.1

package/dist/index.cjs.js

@@ -0,0 +1,76 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+var checkPathPlugin = require('@player-ui/check-path-plugin');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+
+const CheckPathContext = React__default["default"].createContext({
+  plugin: void 0
+});
+
+function getId(asset) {
+  return typeof asset === "string" ? asset : asset.id;
+}
+function useHasParentContext(asset, query) {
+  const { plugin } = React__default["default"].useContext(CheckPathContext);
+  if (!plugin) {
+    return false;
+  }
+  return plugin.hasParentContext(getId(asset), query);
+}
+function useHasChildContext(asset, query) {
+  const { plugin } = React__default["default"].useContext(CheckPathContext);
+  if (!plugin) {
+    return false;
+  }
+  return plugin.hasChildContext(getId(asset), query);
+}
+function useGetParentProp(asset) {
+  const { plugin } = React__default["default"].useContext(CheckPathContext);
+  if (!plugin) {
+    return void 0;
+  }
+  return plugin.getParentProp(getId(asset));
+}
+function useGetPath(asset, query) {
+  const { plugin } = React__default["default"].useContext(CheckPathContext);
+  if (!plugin) {
+    return void 0;
+  }
+  return plugin.getPath(getId(asset), query);
+}
+function useGetParent(asset, query) {
+  const { plugin } = React__default["default"].useContext(CheckPathContext);
+  if (!plugin) {
+    return void 0;
+  }
+  return plugin.getParent(getId(asset), query);
+}
+
+class CheckPathPlugin extends checkPathPlugin.CheckPathPlugin {
+  constructor() {
+    super(...arguments);
+    this.name = "check-path-web";
+  }
+  applyWeb(wp) {
+    wp.hooks.webComponent.tap(this.name, (Comp) => {
+      return () => /* @__PURE__ */ React__default["default"].createElement(CheckPathContext.Provider, {
+        value: { plugin: this }
+      }, /* @__PURE__ */ React__default["default"].createElement(Comp, null));
+    });
+  }
+}
+
+exports.CheckPathContext = CheckPathContext;
+exports.CheckPathPlugin = CheckPathPlugin;
+exports.useGetParent = useGetParent;
+exports.useGetParentProp = useGetParentProp;
+exports.useGetPath = useGetPath;
+exports.useHasChildContext = useHasChildContext;
+exports.useHasParentContext = useHasParentContext;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import { WebPlayerPlugin, WebPlayer } from '@player-ui/react';
+import { Query, CheckPathPlugin as CheckPathPlugin$1 } from '@player-ui/check-path-plugin';
+import { Asset } from '@player-ui/player';
+import React from 'react';
+
+declare type AssetOrID = Asset | string;
+/** hook to check if the asset has the given parents */
+declare function useHasParentContext(asset: AssetOrID, query: Query | Query[]): boolean;
+/** hook to check if the asset has the given children */
+declare function useHasChildContext(asset: AssetOrID, query: Query | Query[]): boolean;
+/** hook to get the prop of the given asset on the parent */
+declare function useGetParentProp(asset: AssetOrID): string | number | undefined;
+/** hook to get the path of the asset in the view */
+declare function useGetPath(asset: AssetOrID, query?: Query | Query[]): Array<string | number> | undefined;
+/** get the parent of the given asset */
+declare function useGetParent<T extends Asset>(asset: AssetOrID, query?: Query | Query[]): T | undefined;
+
+interface CheckPathContextType {
+    /** The core plugin to talk to */
+    plugin?: CheckPathPlugin$1;
+}
+declare const CheckPathContext: React.Context<CheckPathContextType>;
+
+/**
+ * A plugin for adding the check-path provider to the web-player
+ */
+declare class CheckPathPlugin extends CheckPathPlugin$1 implements WebPlayerPlugin {
+    name: string;
+    applyWeb(wp: WebPlayer): void;
+}
+
+export { AssetOrID, CheckPathContext, CheckPathContextType, CheckPathPlugin, useGetParent, useGetParentProp, useGetPath, useHasChildContext, useHasParentContext };

package/dist/index.esm.js

@@ -0,0 +1,62 @@
+import React from 'react';
+import { CheckPathPlugin as CheckPathPlugin$1 } from '@player-ui/check-path-plugin';
+
+const CheckPathContext = React.createContext({
+  plugin: void 0
+});
+
+function getId(asset) {
+  return typeof asset === "string" ? asset : asset.id;
+}
+function useHasParentContext(asset, query) {
+  const { plugin } = React.useContext(CheckPathContext);
+  if (!plugin) {
+    return false;
+  }
+  return plugin.hasParentContext(getId(asset), query);
+}
+function useHasChildContext(asset, query) {
+  const { plugin } = React.useContext(CheckPathContext);
+  if (!plugin) {
+    return false;
+  }
+  return plugin.hasChildContext(getId(asset), query);
+}
+function useGetParentProp(asset) {
+  const { plugin } = React.useContext(CheckPathContext);
+  if (!plugin) {
+    return void 0;
+  }
+  return plugin.getParentProp(getId(asset));
+}
+function useGetPath(asset, query) {
+  const { plugin } = React.useContext(CheckPathContext);
+  if (!plugin) {
+    return void 0;
+  }
+  return plugin.getPath(getId(asset), query);
+}
+function useGetParent(asset, query) {
+  const { plugin } = React.useContext(CheckPathContext);
+  if (!plugin) {
+    return void 0;
+  }
+  return plugin.getParent(getId(asset), query);
+}
+
+class CheckPathPlugin extends CheckPathPlugin$1 {
+  constructor() {
+    super(...arguments);
+    this.name = "check-path-web";
+  }
+  applyWeb(wp) {
+    wp.hooks.webComponent.tap(this.name, (Comp) => {
+      return () => /* @__PURE__ */ React.createElement(CheckPathContext.Provider, {
+        value: { plugin: this }
+      }, /* @__PURE__ */ React.createElement(Comp, null));
+    });
+  }
+}
+
+export { CheckPathContext, CheckPathPlugin, useGetParent, useGetParentProp, useGetPath, useHasChildContext, useHasParentContext };
+//# sourceMappingURL=index.esm.js.map

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@player-ui/check-path-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/partial-match-registry": "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/context.tsx

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { CheckPathPlugin } from '@player-ui/check-path-plugin';
+
+export interface CheckPathContextType {
+  /** The core plugin to talk to */
+  plugin?: CheckPathPlugin;
+}
+
+export const CheckPathContext = React.createContext<CheckPathContextType>({
+  plugin: undefined,
+});

package/src/hooks.tsx

@@ -0,0 +1,80 @@
+import React from 'react';
+import type { Query } from '@player-ui/check-path-plugin';
+import type { Asset } from '@player-ui/player';
+import { CheckPathContext } from './context';
+
+export type AssetOrID = Asset | string;
+
+/** get the id for an asset */
+function getId(asset: AssetOrID): string {
+  return typeof asset === 'string' ? asset : asset.id;
+}
+
+/** hook to check if the asset has the given parents */
+export function useHasParentContext(
+  asset: AssetOrID,
+  query: Query | Query[]
+): boolean {
+  const { plugin } = React.useContext(CheckPathContext);
+
+  if (!plugin) {
+    return false;
+  }
+
+  return plugin.hasParentContext(getId(asset), query);
+}
+
+/** hook to check if the asset has the given children */
+export function useHasChildContext(
+  asset: AssetOrID,
+  query: Query | Query[]
+): boolean {
+  const { plugin } = React.useContext(CheckPathContext);
+
+  if (!plugin) {
+    return false;
+  }
+
+  return plugin.hasChildContext(getId(asset), query);
+}
+
+/** hook to get the prop of the given asset on the parent */
+export function useGetParentProp(
+  asset: AssetOrID
+): string | number | undefined {
+  const { plugin } = React.useContext(CheckPathContext);
+
+  if (!plugin) {
+    return undefined;
+  }
+
+  return plugin.getParentProp(getId(asset));
+}
+
+/** hook to get the path of the asset in the view */
+export function useGetPath(
+  asset: AssetOrID,
+  query?: Query | Query[]
+): Array<string | number> | undefined {
+  const { plugin } = React.useContext(CheckPathContext);
+
+  if (!plugin) {
+    return undefined;
+  }
+
+  return plugin.getPath(getId(asset), query);
+}
+
+/** get the parent of the given asset */
+export function useGetParent<T extends Asset>(
+  asset: AssetOrID,
+  query?: Query | Query[]
+): T | undefined {
+  const { plugin } = React.useContext(CheckPathContext);
+
+  if (!plugin) {
+    return undefined;
+  }
+
+  return plugin.getParent(getId(asset), query) as T | undefined;
+}

package/src/index.tsx

@@ -0,0 +1,27 @@
+import React from 'react';
+import type { WebPlayer, WebPlayerPlugin } from '@player-ui/react';
+import { CheckPathPlugin as CheckPathCorePlugin } from '@player-ui/check-path-plugin';
+import { CheckPathContext } from './context';
+
+export * from './hooks';
+export * from './context';
+
+/**
+ * A plugin for adding the check-path provider to the web-player
+ */
+export class CheckPathPlugin
+  extends CheckPathCorePlugin
+  implements WebPlayerPlugin
+{
+  name = 'check-path-web';
+
+  applyWeb(wp: WebPlayer) {
+    wp.hooks.webComponent.tap(this.name, (Comp) => {
+      return () => (
+        <CheckPathContext.Provider value={{ plugin: this }}>
+          <Comp />
+        </CheckPathContext.Provider>
+      );
+    });
+  }
+}