@uniformdev/canvas-next-rsc-client 19.173.2-alpha.8 → 19.175.1-alpha.36

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ManifestV2, TestEvent, ContextOptions } from '@uniformdev/context';
+import { ManifestV2, TestEvent, ContextOptions, Quirks, ScoreVector } from '@uniformdev/context';
 import { PersonalizationEvent } from '@uniformdev/context/*';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { PureContextualEditingComponentWrapperProps } from '@uniformdev/canvas-react/core';
@@ -6,6 +6,7 @@ import * as react from 'react';
 import { PropsWithChildren } from 'react';
 import * as _uniformdev_canvas_next_rsc_shared from '@uniformdev/canvas-next-rsc-shared';
 import { AppDirectoryContextState, PersonalizeProps, ComponentProps, TestProps, AppDirectoryContext } from '@uniformdev/canvas-next-rsc-shared';
+import { VisibilityParameterValue } from '@uniformdev/canvas';
 
 type ClientContextComponentProps = {
     /**
@@ -59,11 +60,27 @@ declare const TestClient: (props: ComponentProps<TestProps>) => react.FunctionCo
 
 declare const UniformScript: () => react_jsx_runtime.JSX.Element;
 
+declare const VisibilityRulesWrapperClient: ({ parameter, children, }: PropsWithChildren<{
+    parameter: VisibilityParameterValue;
+}>) => react_jsx_runtime.JSX.Element | null;
+
 type CreateClientUniformContextOptions = Omit<ContextOptions, 'transitionStore'>;
 declare const createClientUniformContext: (options: CreateClientUniformContextOptions) => _uniformdev_canvas_next_rsc_shared.AppDirectoryContext;
 
 declare const useInitUniformContext: (callback: () => AppDirectoryContext) => void;
 
+/**
+ * Provides reactive access to the Uniform Context's current visitor quirks values
+ * This can be used when you want to read current quirk values directly.
+ */
+declare function useQuirks(): Quirks;
+
+/**
+ * Provides reactive access to the Uniform Context's current visitor scores values.
+ * This can be used when you want to read current score values directly.
+ */
+declare function useScores(): ScoreVector | undefined;
+
 declare global {
     interface Window {
         __UNIFORM_CONTEXT__: AppDirectoryContext | undefined;
@@ -73,4 +90,4 @@ declare const useUniformContext: () => {
     context: AppDirectoryContext | undefined;
 };
 
-export { type ClientContextComponent, type ClientContextComponentProps, ClientContextPersonalizationTransfer, ClientContextTestTransfer, ClientContextUpdate, ClientContextualEditingComponentWrapper, ContextUpdateTransferClient, type CreateClientUniformContextOptions, DefaultUniformClientContext, PersonalizeClient, type PersonalizeClientProps, TestClient, UniformScript, createClientUniformContext, useInitUniformContext, useUniformContext };
+export { type ClientContextComponent, type ClientContextComponentProps, ClientContextPersonalizationTransfer, ClientContextTestTransfer, ClientContextUpdate, ClientContextualEditingComponentWrapper, ContextUpdateTransferClient, type CreateClientUniformContextOptions, DefaultUniformClientContext, PersonalizeClient, type PersonalizeClientProps, TestClient, UniformScript, VisibilityRulesWrapperClient, createClientUniformContext, useInitUniformContext, useQuirks, useScores, useUniformContext };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ManifestV2, TestEvent, ContextOptions } from '@uniformdev/context';
+import { ManifestV2, TestEvent, ContextOptions, Quirks, ScoreVector } from '@uniformdev/context';
 import { PersonalizationEvent } from '@uniformdev/context/*';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { PureContextualEditingComponentWrapperProps } from '@uniformdev/canvas-react/core';
@@ -6,6 +6,7 @@ import * as react from 'react';
 import { PropsWithChildren } from 'react';
 import * as _uniformdev_canvas_next_rsc_shared from '@uniformdev/canvas-next-rsc-shared';
 import { AppDirectoryContextState, PersonalizeProps, ComponentProps, TestProps, AppDirectoryContext } from '@uniformdev/canvas-next-rsc-shared';
+import { VisibilityParameterValue } from '@uniformdev/canvas';
 
 type ClientContextComponentProps = {
     /**
@@ -59,11 +60,27 @@ declare const TestClient: (props: ComponentProps<TestProps>) => react.FunctionCo
 
 declare const UniformScript: () => react_jsx_runtime.JSX.Element;
 
+declare const VisibilityRulesWrapperClient: ({ parameter, children, }: PropsWithChildren<{
+    parameter: VisibilityParameterValue;
+}>) => react_jsx_runtime.JSX.Element | null;
+
 type CreateClientUniformContextOptions = Omit<ContextOptions, 'transitionStore'>;
 declare const createClientUniformContext: (options: CreateClientUniformContextOptions) => _uniformdev_canvas_next_rsc_shared.AppDirectoryContext;
 
 declare const useInitUniformContext: (callback: () => AppDirectoryContext) => void;
 
+/**
+ * Provides reactive access to the Uniform Context's current visitor quirks values
+ * This can be used when you want to read current quirk values directly.
+ */
+declare function useQuirks(): Quirks;
+
+/**
+ * Provides reactive access to the Uniform Context's current visitor scores values.
+ * This can be used when you want to read current score values directly.
+ */
+declare function useScores(): ScoreVector | undefined;
+
 declare global {
     interface Window {
         __UNIFORM_CONTEXT__: AppDirectoryContext | undefined;
@@ -73,4 +90,4 @@ declare const useUniformContext: () => {
     context: AppDirectoryContext | undefined;
 };
 
-export { type ClientContextComponent, type ClientContextComponentProps, ClientContextPersonalizationTransfer, ClientContextTestTransfer, ClientContextUpdate, ClientContextualEditingComponentWrapper, ContextUpdateTransferClient, type CreateClientUniformContextOptions, DefaultUniformClientContext, PersonalizeClient, type PersonalizeClientProps, TestClient, UniformScript, createClientUniformContext, useInitUniformContext, useUniformContext };
+export { type ClientContextComponent, type ClientContextComponentProps, ClientContextPersonalizationTransfer, ClientContextTestTransfer, ClientContextUpdate, ClientContextualEditingComponentWrapper, ContextUpdateTransferClient, type CreateClientUniformContextOptions, DefaultUniformClientContext, PersonalizeClient, type PersonalizeClientProps, TestClient, UniformScript, VisibilityRulesWrapperClient, createClientUniformContext, useInitUniformContext, useQuirks, useScores, useUniformContext };

package/dist/index.esm.js

@@ -1057,6 +1057,78 @@ var UniformScript = () => {
   }, [router]);
   return /* @__PURE__ */ jsx3(Fragment5, {});
 };
+
+// src/components/VisibilityRulesWrapperClient.tsx
+import {
+  createQuirksVisibilityRule,
+  evaluateNodeVisibilityParameter
+} from "@uniformdev/canvas";
+import { useMemo as useMemo3 } from "react";
+
+// src/hooks/useQuirks.ts
+import { useEffect as useEffect9, useState as useState7 } from "react";
+function useQuirks() {
+  var _a;
+  const { context } = useUniformContext();
+  const [quirks, setQuirks] = useState7((_a = context == null ? void 0 : context.quirks) != null ? _a : {});
+  useEffect9(() => {
+    if (!context) {
+      return;
+    }
+    const quirkChangeListener = (updatedQuirks) => {
+      setQuirks(updatedQuirks);
+    };
+    setQuirks(context.quirks);
+    context == null ? void 0 : context.events.on("quirksUpdated", quirkChangeListener);
+    return () => {
+      context == null ? void 0 : context.events.off("quirksUpdated", quirkChangeListener);
+    };
+  }, [context]);
+  return quirks;
+}
+
+// src/components/VisibilityRulesWrapperClient.tsx
+import { Fragment as Fragment6, jsx as jsx4 } from "react/jsx-runtime";
+var VisibilityRulesWrapperClient = ({
+  parameter,
+  children
+}) => {
+  const quirks = useQuirks();
+  const rules = useMemo3(() => {
+    return {
+      ...createQuirksVisibilityRule(quirks)
+    };
+  }, [quirks]);
+  const isVisible = useMemo3(() => {
+    const result = evaluateNodeVisibilityParameter({
+      rules,
+      parameter
+    });
+    return result;
+  }, [parameter, rules]);
+  return isVisible ? /* @__PURE__ */ jsx4(Fragment6, { children }) : null;
+};
+
+// src/hooks/useScores.ts
+import { useEffect as useEffect10, useState as useState8 } from "react";
+function useScores() {
+  const { context } = useUniformContext();
+  const [scores, setScores] = useState8(context == null ? void 0 : context.scores);
+  useEffect10(() => {
+    if (!context) {
+      return;
+    }
+    const scoringChangeListener = (updatedScores) => {
+      setScores(updatedScores);
+    };
+    setScores(context.scores);
+    context.events.on("scoresUpdated", scoringChangeListener);
+    return () => {
+      context.events.off("scoresUpdated", scoringChangeListener);
+    };
+  }, [context]);
+  return scores;
+}
 export {
   ClientContextPersonalizationTransfer,
   ClientContextTestTransfer,
@@ -1067,8 +1139,11 @@ export {
   PersonalizeClient,
   TestClient,
   UniformScript,
+  VisibilityRulesWrapperClient,
   createClientUniformContext,
   useInitUniformContext,
+  useQuirks,
+  useScores,
   useUniformContext
 };
 /*! Bundled license information:

package/dist/index.js

@@ -228,8 +228,11 @@ __export(src_exports, {
   PersonalizeClient: () => PersonalizeClient,
   TestClient: () => TestClient,
   UniformScript: () => UniformScript,
+  VisibilityRulesWrapperClient: () => VisibilityRulesWrapperClient,
   createClientUniformContext: () => createClientUniformContext,
   useInitUniformContext: () => useInitUniformContext,
+  useQuirks: () => useQuirks,
+  useScores: () => useScores,
   useUniformContext: () => useUniformContext
 });
 module.exports = __toCommonJS(src_exports);
@@ -1075,6 +1078,75 @@ var UniformScript = () => {
   }, [router]);
   return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(import_jsx_runtime3.Fragment, {});
 };
+
+// src/components/VisibilityRulesWrapperClient.tsx
+var import_canvas5 = require("@uniformdev/canvas");
+var import_react12 = require("react");
+
+// src/hooks/useQuirks.ts
+var import_react11 = require("react");
+function useQuirks() {
+  var _a;
+  const { context } = useUniformContext();
+  const [quirks, setQuirks] = (0, import_react11.useState)((_a = context == null ? void 0 : context.quirks) != null ? _a : {});
+  (0, import_react11.useEffect)(() => {
+    if (!context) {
+      return;
+    }
+    const quirkChangeListener = (updatedQuirks) => {
+      setQuirks(updatedQuirks);
+    };
+    setQuirks(context.quirks);
+    context == null ? void 0 : context.events.on("quirksUpdated", quirkChangeListener);
+    return () => {
+      context == null ? void 0 : context.events.off("quirksUpdated", quirkChangeListener);
+    };
+  }, [context]);
+  return quirks;
+}
+
+// src/components/VisibilityRulesWrapperClient.tsx
+var import_jsx_runtime4 = require("react/jsx-runtime");
+var VisibilityRulesWrapperClient = ({
+  parameter,
+  children
+}) => {
+  const quirks = useQuirks();
+  const rules = (0, import_react12.useMemo)(() => {
+    return {
+      ...(0, import_canvas5.createQuirksVisibilityRule)(quirks)
+    };
+  }, [quirks]);
+  const isVisible = (0, import_react12.useMemo)(() => {
+    const result = (0, import_canvas5.evaluateNodeVisibilityParameter)({
+      rules,
+      parameter
+    });
+    return result;
+  }, [parameter, rules]);
+  return isVisible ? /* @__PURE__ */ (0, import_jsx_runtime4.jsx)(import_jsx_runtime4.Fragment, { children }) : null;
+};
+
+// src/hooks/useScores.ts
+var import_react13 = require("react");
+function useScores() {
+  const { context } = useUniformContext();
+  const [scores, setScores] = (0, import_react13.useState)(context == null ? void 0 : context.scores);
+  (0, import_react13.useEffect)(() => {
+    if (!context) {
+      return;
+    }
+    const scoringChangeListener = (updatedScores) => {
+      setScores(updatedScores);
+    };
+    setScores(context.scores);
+    context.events.on("scoresUpdated", scoringChangeListener);
+    return () => {
+      context.events.off("scoresUpdated", scoringChangeListener);
+    };
+  }, [context]);
+  return scores;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ClientContextPersonalizationTransfer,
@@ -1086,8 +1158,11 @@ var UniformScript = () => {
   PersonalizeClient,
   TestClient,
   UniformScript,
+  VisibilityRulesWrapperClient,
   createClientUniformContext,
   useInitUniformContext,
+  useQuirks,
+  useScores,
   useUniformContext
 });
 /*! Bundled license information:

package/dist/index.mjs

@@ -1057,6 +1057,78 @@ var UniformScript = () => {
   }, [router]);
   return /* @__PURE__ */ jsx3(Fragment5, {});
 };
+
+// src/components/VisibilityRulesWrapperClient.tsx
+import {
+  createQuirksVisibilityRule,
+  evaluateNodeVisibilityParameter
+} from "@uniformdev/canvas";
+import { useMemo as useMemo3 } from "react";
+
+// src/hooks/useQuirks.ts
+import { useEffect as useEffect9, useState as useState7 } from "react";
+function useQuirks() {
+  var _a;
+  const { context } = useUniformContext();
+  const [quirks, setQuirks] = useState7((_a = context == null ? void 0 : context.quirks) != null ? _a : {});
+  useEffect9(() => {
+    if (!context) {
+      return;
+    }
+    const quirkChangeListener = (updatedQuirks) => {
+      setQuirks(updatedQuirks);
+    };
+    setQuirks(context.quirks);
+    context == null ? void 0 : context.events.on("quirksUpdated", quirkChangeListener);
+    return () => {
+      context == null ? void 0 : context.events.off("quirksUpdated", quirkChangeListener);
+    };
+  }, [context]);
+  return quirks;
+}
+
+// src/components/VisibilityRulesWrapperClient.tsx
+import { Fragment as Fragment6, jsx as jsx4 } from "react/jsx-runtime";
+var VisibilityRulesWrapperClient = ({
+  parameter,
+  children
+}) => {
+  const quirks = useQuirks();
+  const rules = useMemo3(() => {
+    return {
+      ...createQuirksVisibilityRule(quirks)
+    };
+  }, [quirks]);
+  const isVisible = useMemo3(() => {
+    const result = evaluateNodeVisibilityParameter({
+      rules,
+      parameter
+    });
+    return result;
+  }, [parameter, rules]);
+  return isVisible ? /* @__PURE__ */ jsx4(Fragment6, { children }) : null;
+};
+
+// src/hooks/useScores.ts
+import { useEffect as useEffect10, useState as useState8 } from "react";
+function useScores() {
+  const { context } = useUniformContext();
+  const [scores, setScores] = useState8(context == null ? void 0 : context.scores);
+  useEffect10(() => {
+    if (!context) {
+      return;
+    }
+    const scoringChangeListener = (updatedScores) => {
+      setScores(updatedScores);
+    };
+    setScores(context.scores);
+    context.events.on("scoresUpdated", scoringChangeListener);
+    return () => {
+      context.events.off("scoresUpdated", scoringChangeListener);
+    };
+  }, [context]);
+  return scores;
+}
 export {
   ClientContextPersonalizationTransfer,
   ClientContextTestTransfer,
@@ -1067,8 +1139,11 @@ export {
   PersonalizeClient,
   TestClient,
   UniformScript,
+  VisibilityRulesWrapperClient,
   createClientUniformContext,
   useInitUniformContext,
+  useQuirks,
+  useScores,
   useUniformContext
 };
 /*! Bundled license information:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next-rsc-client",
-  "version": "19.173.2-alpha.8+7b0bc70fd5",
+  "version": "19.175.1-alpha.36+4682f8aebe",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
@@ -32,9 +32,9 @@
     "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.173.2-alpha.8+7b0bc70fd5",
-    "@uniformdev/canvas-next-rsc-shared": "^19.173.2-alpha.8+7b0bc70fd5",
-    "@uniformdev/canvas-react": "^19.173.2-alpha.8+7b0bc70fd5"
+    "@uniformdev/canvas": "19.175.1-alpha.36+4682f8aebe",
+    "@uniformdev/canvas-next-rsc-shared": "^19.175.1-alpha.36+4682f8aebe",
+    "@uniformdev/canvas-react": "^19.175.1-alpha.36+4682f8aebe"
   },
   "engines": {
     "node": ">=16.14.0"
@@ -47,5 +47,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7b0bc70fd58912415a860667c266cb339fa8133a"
+  "gitHead": "4682f8aebe6c4e2f22b7f7db182c51ff313d9894"
 }