@uniformdev/next-app-router-client 20.7.1-alpha.118

package/LICENSE.txt

@@ -0,0 +1,2 @@
+© 2024 Uniform Systems, Inc. All Rights Reserved.
+See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula

package/dist/index.d.mts

@@ -0,0 +1,129 @@
+import { ManifestV2, CompositionMetadata, TestEvent, ContextState, ContextOptions, CookieTransitionDataStoreOptions, Context, Quirks, ScoreVector } from '@uniformdev/context';
+import * as React from 'react';
+import React__default, { JSX, PropsWithChildren } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ComponentContext, ComponentParameter, PersonalizeProps } from '@uniformdev/next-app-router-shared';
+import { VisibilityParameterValue } from '@uniformdev/canvas';
+import * as _uniformdev_context__ from '@uniformdev/context/*';
+
+type ClientContextComponentProps = {
+    /**
+     * The Uniform project manifest
+     */
+    manifest: ManifestV2;
+    /**
+     * Whether or not to disable the Uniform Context dev tools
+     */
+    disableDevTools: boolean;
+    /**
+     * The default consent value
+     */
+    defaultConsent: boolean;
+    /**
+     * @deprecated
+     * Whether or not to enable the experimental quirk serialization
+     */
+    experimentalQuirkSerialization: boolean;
+    compositionMetadata?: CompositionMetadata;
+};
+type ClientContextComponent = (props: ClientContextComponentProps) => JSX.Element | null;
+
+/**
+ * Transfers test events from RSC to the client-side context.
+ * Uses stringify comparison to avoid duplicate processing when the event
+ * object reference changes but the content remains the same.
+ */
+declare const ClientContextTestTransfer: ({ event }: {
+    event: TestEvent;
+}) => null;
+
+type ClientUniformTextProps = {
+    /**
+     * The name of the  HTML tag to render.
+     * @default "span"
+     */
+    as?: React__default.ElementType;
+    /** The ID of the component. */
+    component: Pick<ComponentContext, '_id'>;
+    /** The ID of the parameter. */
+    parameter: ComponentParameter<string>;
+    /**
+     * When set to true, it adds `whiteSpace: 'pre-wrap'` to the styles of the root element to allow the rendering of line breaks.
+     * @default false
+     */
+    isMultiline?: boolean;
+    /**
+     * Sets the value to show in Canvas editor when the parameter value is empty.
+     * Can be a static string, or a function to generate the placeholder out of parameter info.
+     * @default undefined
+     */
+    placeholder?: string | ((parameter: {
+        id: string;
+    }) => string | undefined);
+    /**
+     * A function to customize the rendering of the parameter value. Useful to format the value before rendering it.
+     * @default "(value) => value"
+     */
+    render?: (value: string | undefined) => React__default.ReactNode;
+} & Omit<React__default.HTMLAttributes<HTMLSpanElement>, 'children' | 'placeholder'>;
+/**
+ * Renders text parameters. Offers inline editing capability out of the box.
+ */
+declare const ClientUniformText: ({ as, component, parameter: providedParameter, isMultiline, placeholder, render, ...props }: ClientUniformTextProps) => react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Transfers context state updates from RSC to the client-side context.
+ * Uses stringify comparison to avoid duplicate processing when the update
+ * object reference changes but the content remains the same.
+ */
+declare const ContextUpdateTransfer: ({ update }: {
+    update: Partial<ContextState>;
+}) => null;
+
+declare const DefaultUniformClientContext: ClientContextComponent;
+
+declare const Personalize: ({ parameters, indexes, slots, context: compositionContext, }: PersonalizeProps) => React.FunctionComponentElement<{
+    children?: React.ReactNode | undefined;
+}>;
+
+declare const UniformScript: () => react_jsx_runtime.JSX.Element;
+
+declare const VisibilityRulesWrapperClient: ({ parameter, initialIsVisible, children, }: PropsWithChildren<{
+    parameter: VisibilityParameterValue;
+    initialIsVisible: boolean | null;
+}>) => react_jsx_runtime.JSX.Element | null;
+
+type CreateUniformContextOptions = Omit<ContextOptions, 'transitionStore'> & {
+    serverCookieValue: string | undefined;
+    cookieAttributes?: CookieTransitionDataStoreOptions['cookieAttributes'];
+    quirkCookieValue?: string;
+    experimental_quirksEnabled?: CookieTransitionDataStoreOptions['experimental_quirksEnabled'];
+};
+
+type CreateClientUniformContextOptions = Omit<CreateUniformContextOptions, 'serverCookieValue'>;
+declare const createClientUniformContext: (options: CreateClientUniformContextOptions) => _uniformdev_context__.Context;
+
+declare const useInitUniformContext: (callback: () => Context, compositionMetadata?: CompositionMetadata) => 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__: Context | undefined;
+    }
+}
+declare const useUniformContext: () => {
+    context: Context | undefined;
+};
+
+export { type ClientContextComponent, type ClientContextComponentProps, ClientContextTestTransfer, ClientUniformText, type ClientUniformTextProps, ContextUpdateTransfer, DefaultUniformClientContext, Personalize, UniformScript, VisibilityRulesWrapperClient, createClientUniformContext, useInitUniformContext, useQuirks, useScores, useUniformContext };

package/dist/index.d.ts

@@ -0,0 +1,129 @@
+import { ManifestV2, CompositionMetadata, TestEvent, ContextState, ContextOptions, CookieTransitionDataStoreOptions, Context, Quirks, ScoreVector } from '@uniformdev/context';
+import * as React from 'react';
+import React__default, { JSX, PropsWithChildren } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ComponentContext, ComponentParameter, PersonalizeProps } from '@uniformdev/next-app-router-shared';
+import { VisibilityParameterValue } from '@uniformdev/canvas';
+import * as _uniformdev_context__ from '@uniformdev/context/*';
+
+type ClientContextComponentProps = {
+    /**
+     * The Uniform project manifest
+     */
+    manifest: ManifestV2;
+    /**
+     * Whether or not to disable the Uniform Context dev tools
+     */
+    disableDevTools: boolean;
+    /**
+     * The default consent value
+     */
+    defaultConsent: boolean;
+    /**
+     * @deprecated
+     * Whether or not to enable the experimental quirk serialization
+     */
+    experimentalQuirkSerialization: boolean;
+    compositionMetadata?: CompositionMetadata;
+};
+type ClientContextComponent = (props: ClientContextComponentProps) => JSX.Element | null;
+
+/**
+ * Transfers test events from RSC to the client-side context.
+ * Uses stringify comparison to avoid duplicate processing when the event
+ * object reference changes but the content remains the same.
+ */
+declare const ClientContextTestTransfer: ({ event }: {
+    event: TestEvent;
+}) => null;
+
+type ClientUniformTextProps = {
+    /**
+     * The name of the  HTML tag to render.
+     * @default "span"
+     */
+    as?: React__default.ElementType;
+    /** The ID of the component. */
+    component: Pick<ComponentContext, '_id'>;
+    /** The ID of the parameter. */
+    parameter: ComponentParameter<string>;
+    /**
+     * When set to true, it adds `whiteSpace: 'pre-wrap'` to the styles of the root element to allow the rendering of line breaks.
+     * @default false
+     */
+    isMultiline?: boolean;
+    /**
+     * Sets the value to show in Canvas editor when the parameter value is empty.
+     * Can be a static string, or a function to generate the placeholder out of parameter info.
+     * @default undefined
+     */
+    placeholder?: string | ((parameter: {
+        id: string;
+    }) => string | undefined);
+    /**
+     * A function to customize the rendering of the parameter value. Useful to format the value before rendering it.
+     * @default "(value) => value"
+     */
+    render?: (value: string | undefined) => React__default.ReactNode;
+} & Omit<React__default.HTMLAttributes<HTMLSpanElement>, 'children' | 'placeholder'>;
+/**
+ * Renders text parameters. Offers inline editing capability out of the box.
+ */
+declare const ClientUniformText: ({ as, component, parameter: providedParameter, isMultiline, placeholder, render, ...props }: ClientUniformTextProps) => react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Transfers context state updates from RSC to the client-side context.
+ * Uses stringify comparison to avoid duplicate processing when the update
+ * object reference changes but the content remains the same.
+ */
+declare const ContextUpdateTransfer: ({ update }: {
+    update: Partial<ContextState>;
+}) => null;
+
+declare const DefaultUniformClientContext: ClientContextComponent;
+
+declare const Personalize: ({ parameters, indexes, slots, context: compositionContext, }: PersonalizeProps) => React.FunctionComponentElement<{
+    children?: React.ReactNode | undefined;
+}>;
+
+declare const UniformScript: () => react_jsx_runtime.JSX.Element;
+
+declare const VisibilityRulesWrapperClient: ({ parameter, initialIsVisible, children, }: PropsWithChildren<{
+    parameter: VisibilityParameterValue;
+    initialIsVisible: boolean | null;
+}>) => react_jsx_runtime.JSX.Element | null;
+
+type CreateUniformContextOptions = Omit<ContextOptions, 'transitionStore'> & {
+    serverCookieValue: string | undefined;
+    cookieAttributes?: CookieTransitionDataStoreOptions['cookieAttributes'];
+    quirkCookieValue?: string;
+    experimental_quirksEnabled?: CookieTransitionDataStoreOptions['experimental_quirksEnabled'];
+};
+
+type CreateClientUniformContextOptions = Omit<CreateUniformContextOptions, 'serverCookieValue'>;
+declare const createClientUniformContext: (options: CreateClientUniformContextOptions) => _uniformdev_context__.Context;
+
+declare const useInitUniformContext: (callback: () => Context, compositionMetadata?: CompositionMetadata) => 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__: Context | undefined;
+    }
+}
+declare const useUniformContext: () => {
+    context: Context | undefined;
+};
+
+export { type ClientContextComponent, type ClientContextComponentProps, ClientContextTestTransfer, ClientUniformText, type ClientUniformTextProps, ContextUpdateTransfer, DefaultUniformClientContext, Personalize, UniformScript, VisibilityRulesWrapperClient, createClientUniformContext, useInitUniformContext, useQuirks, useScores, useUniformContext };