@uniformdev/next-app-router-shared 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,271 @@
+import { ComponentParameter as ComponentParameter$1, VisibilityParameterValue, CANVAS_PERSONALIZATION_PARAM, ComponentInstance } from '@uniformdev/canvas';
+import { PersonalizedVariant, VariationMatchMetadata, PersonalizeOptions, Context, PersonalizationEvent, TestVariant, TestOptions, TestEvent, VariantMatchCriteria } from '@uniformdev/context';
+import { ReactNode } from 'react';
+
+type ComponentContext = {
+    _id: string;
+    _parentId: string | null;
+    slotName: string | undefined;
+    slotIndex: number | undefined;
+};
+
+type ComponentParameter<TValue = unknown> = ComponentParameter$1<TValue> & {
+    parameterId: string;
+    _contextualEditing?: {
+        isEditable: boolean;
+    };
+};
+
+type PageStateComponentFields = {
+    indexes?: number[];
+};
+type PageStateComponent = {
+    _id: string;
+} & PageStateComponentFields;
+type PageState = {
+    /**
+     * The state of the composition
+     */
+    compositionState: number;
+    /**
+     * The route path that was matched
+     */
+    routePath: string;
+    /**
+     * The components in the page state.
+     * NOTE: Key might contain partial component ids so use {@link resolveComponentFromPageState} to resolve data.
+     * @deprecated Use {@link resolveComponentFromPageState} instead.
+     */
+    components: Record<string, PageStateComponentFields>;
+    /**
+     * Whether a rule is true or false.
+     * NOTE: Key is a compressed hash of the rule and cannot be looked up directly from this object.
+     */
+    rules: Record<string, boolean> | undefined;
+    /**
+     * Keys to federate cache IDs on.
+     */
+    keys: Record<string, string> | undefined;
+    /**
+     * Release ID to resolve the route from.
+     */
+    releaseId: string | undefined;
+    /**
+     * Default consent for the current request. Only specified if middleware was passed a value for {@link HandleOptions.defaultConsent}.
+     */
+    defaultConsent: boolean | undefined;
+    /**
+     * While in Canvas Editing mode, this will be set to 'editor'.
+     * While in Canvas Preview mode, this will be set to 'preview'.
+     * While in Published mode, this will be undefined.
+     */
+    previewMode: 'editor' | 'preview' | undefined;
+};
+declare const resolveComponentFromPageState: ({ pageState, componentId: providedComponentId, }: {
+    pageState: PageState;
+    componentId: string;
+}) => PageStateComponentFields;
+declare const getRuleId: (rule: VisibilityParameterValue) => string;
+declare const resolveRuleFromPageState: ({ pageState, rule, }: {
+    pageState: PageState;
+    rule: VisibilityParameterValue;
+}) => boolean | undefined;
+declare const serializeEvaluationResult: ({ payload, encode, }: {
+    payload: PageState;
+    encode?: boolean;
+}) => string;
+declare const deserializeEvaluationResult: ({ input: providedInput, decode, }: {
+    input: string;
+    decode?: boolean;
+}) => PageState;
+
+type CompositionContext = {
+    _id: string;
+    type: string;
+    state: number;
+    isContextualEditing: boolean;
+    /** Matched route from Project Map node. */
+    matchedRoute: string;
+    /** Dynamic inputs for the composition from the route path: path segment and query string parameters. */
+    dynamicInputs: Record<string, string>;
+    pageState: PageState;
+};
+
+type IndexedPersonalizationVariant = PersonalizedVariant<VariationMatchMetadata> & {
+    componentId: string;
+    index: number;
+};
+declare const evaluatePersonalization: ({ personalization, context, compositionContext, }: {
+    personalization: PersonalizeOptions<IndexedPersonalizationVariant>;
+    context: Context;
+    compositionContext: CompositionContext;
+}) => {
+    indexes: number[];
+    componentIds: string[];
+    event: PersonalizationEvent;
+};
+
+type IndexedTestVariant = TestVariant & {
+    componentId: string;
+    index: number;
+};
+declare const evaluateTest: ({ test, context, compositionContext, }: {
+    test: TestOptions<IndexedTestVariant>;
+    context: Context;
+    compositionContext: CompositionContext;
+}) => {
+    index: number | null;
+    componentId: string | null;
+    event: TestEvent | null;
+};
+
+type ExtractPersonalizationVariant = IndexedPersonalizationVariant;
+type ExtractPersonalizationResult = PersonalizeOptions<ExtractPersonalizationVariant>;
+type ExtractTestVariant = IndexedTestVariant;
+type ExtractTestResult = TestOptions<ExtractTestVariant>;
+
+type SlotDefinition = {
+    name: string;
+    items: ({
+        _id: string;
+        [CANVAS_PERSONALIZATION_PARAM]: VariantMatchCriteria | undefined;
+        /**
+         * Only populated for variants of tests or personalizations
+         */
+        variantId: string | undefined;
+        component: ReactNode;
+    } | null)[];
+};
+
+type ComponentProps<TParameters extends Record<string, ComponentParameter> | unknown = Record<string, ComponentParameter>, TSlotNames extends string = string> = {
+    type: string;
+    variant: string | undefined;
+    slots: Record<TSlotNames, SlotDefinition>;
+    parameters: TParameters;
+    component: ComponentContext;
+    context: CompositionContext;
+};
+type PersonalizeProps = ComponentProps<{
+    algorithm?: ComponentParameter<string>;
+    trackingEventName?: ComponentParameter<string>;
+}> & {
+    indexes: number[];
+};
+type TestProps = ComponentProps & {
+    index: number;
+    test: ExtractTestResult;
+};
+
+type CacheMode = {
+    type: RequestInit['cache'];
+    bypassCache?: boolean;
+} | {
+    type: 'revalidate';
+    interval: number;
+    bypassCache?: boolean;
+};
+type ManifestCacheMode = CacheMode;
+type ProjectMapCacheMode = CacheMode;
+type CanvasCacheMode = CacheMode & {
+    disableSWR?: boolean;
+};
+type UniformServerConfig = {
+    /**
+     * Sets the default value of storage consent for new unknown visitors.
+     *
+     * @default false
+     */
+    defaultConsent?: boolean;
+    /**
+     * The path to the playground page.
+     */
+    playgroundPath?: string;
+    /**
+     * Cache mode for manifest data.
+     *
+     */
+    manifestCache?: ManifestCacheMode;
+    /**
+     * Cache mode for canvas data.
+     *
+     */
+    canvasCache?: CanvasCacheMode;
+    /**
+     * Cache mode for project map data.
+     *
+     */
+    projectMapCache?: ProjectMapCacheMode;
+    eTags?: {
+        /**
+         * Generate ETags for published compositions.
+         *
+         * @default false
+         */
+        generateETags?: boolean;
+        /**
+         * Cache control header for pages that have ETags.
+         *
+         * @default 'no-cache, must-revalidate'
+         */
+        cacheControl?: string | null;
+    };
+    /**
+     * Options for Uniform Context
+     */
+    context?: {
+        /**
+         * Disables the Uniform Context dev tools.
+         *
+         * @default false
+         */
+        disableDevTools?: boolean;
+    };
+    /**
+     * 😅
+     */
+    experimental?: {
+        /**
+         * Enables quirk serialization for Uniform Context.
+         *
+         * @default false
+         */
+        quirkSerialization?: boolean;
+        /**
+         * Enables visual editing mode.
+         *
+         * @default false
+         */
+        vercelVisualEditing?: boolean;
+        /**
+         * Enables runtime cache in middleware.
+         *
+         * @default false
+         */
+        middlewareRuntimeCache?: boolean;
+        /**
+         * Requires middlewareRuntimeCache to be enabled. If enabled, the middleware will retain a copy
+         * of the old route data in cache and use it while the new route data is being fetched.
+         *
+         * @default false
+         */
+        disableSwrMiddlewareCache?: boolean;
+    };
+};
+
+declare const extractPersonalizationName: ({ component, }: {
+    component: Pick<ComponentInstance, "parameters">;
+}) => string;
+
+declare const extractTestName: ({ component }: {
+    component: Pick<ComponentInstance, "parameters">;
+}) => string;
+
+type RewriteRequestPathResult = {
+    path: string;
+    keys?: Record<string, string>;
+};
+
+declare const UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME = "ufsc";
+declare const UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME = "ufqc";
+
+export { type CacheMode, type CanvasCacheMode, type ComponentContext, type ComponentParameter, type ComponentProps, type CompositionContext, type ExtractPersonalizationResult, type ExtractPersonalizationVariant, type ExtractTestResult, type ExtractTestVariant, type IndexedPersonalizationVariant, type IndexedTestVariant, type ManifestCacheMode, type PageState, type PageStateComponent, type PageStateComponentFields, type PersonalizeProps, type ProjectMapCacheMode, type RewriteRequestPathResult, type SlotDefinition, type TestProps, UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME, UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME, type UniformServerConfig, deserializeEvaluationResult, evaluatePersonalization, evaluateTest, extractPersonalizationName, extractTestName, getRuleId, resolveComponentFromPageState, resolveRuleFromPageState, serializeEvaluationResult };

package/dist/index.d.ts

@@ -0,0 +1,271 @@
+import { ComponentParameter as ComponentParameter$1, VisibilityParameterValue, CANVAS_PERSONALIZATION_PARAM, ComponentInstance } from '@uniformdev/canvas';
+import { PersonalizedVariant, VariationMatchMetadata, PersonalizeOptions, Context, PersonalizationEvent, TestVariant, TestOptions, TestEvent, VariantMatchCriteria } from '@uniformdev/context';
+import { ReactNode } from 'react';
+
+type ComponentContext = {
+    _id: string;
+    _parentId: string | null;
+    slotName: string | undefined;
+    slotIndex: number | undefined;
+};
+
+type ComponentParameter<TValue = unknown> = ComponentParameter$1<TValue> & {
+    parameterId: string;
+    _contextualEditing?: {
+        isEditable: boolean;
+    };
+};
+
+type PageStateComponentFields = {
+    indexes?: number[];
+};
+type PageStateComponent = {
+    _id: string;
+} & PageStateComponentFields;
+type PageState = {
+    /**
+     * The state of the composition
+     */
+    compositionState: number;
+    /**
+     * The route path that was matched
+     */
+    routePath: string;
+    /**
+     * The components in the page state.
+     * NOTE: Key might contain partial component ids so use {@link resolveComponentFromPageState} to resolve data.
+     * @deprecated Use {@link resolveComponentFromPageState} instead.
+     */
+    components: Record<string, PageStateComponentFields>;
+    /**
+     * Whether a rule is true or false.
+     * NOTE: Key is a compressed hash of the rule and cannot be looked up directly from this object.
+     */
+    rules: Record<string, boolean> | undefined;
+    /**
+     * Keys to federate cache IDs on.
+     */
+    keys: Record<string, string> | undefined;
+    /**
+     * Release ID to resolve the route from.
+     */
+    releaseId: string | undefined;
+    /**
+     * Default consent for the current request. Only specified if middleware was passed a value for {@link HandleOptions.defaultConsent}.
+     */
+    defaultConsent: boolean | undefined;
+    /**
+     * While in Canvas Editing mode, this will be set to 'editor'.
+     * While in Canvas Preview mode, this will be set to 'preview'.
+     * While in Published mode, this will be undefined.
+     */
+    previewMode: 'editor' | 'preview' | undefined;
+};
+declare const resolveComponentFromPageState: ({ pageState, componentId: providedComponentId, }: {
+    pageState: PageState;
+    componentId: string;
+}) => PageStateComponentFields;
+declare const getRuleId: (rule: VisibilityParameterValue) => string;
+declare const resolveRuleFromPageState: ({ pageState, rule, }: {
+    pageState: PageState;
+    rule: VisibilityParameterValue;
+}) => boolean | undefined;
+declare const serializeEvaluationResult: ({ payload, encode, }: {
+    payload: PageState;
+    encode?: boolean;
+}) => string;
+declare const deserializeEvaluationResult: ({ input: providedInput, decode, }: {
+    input: string;
+    decode?: boolean;
+}) => PageState;
+
+type CompositionContext = {
+    _id: string;
+    type: string;
+    state: number;
+    isContextualEditing: boolean;
+    /** Matched route from Project Map node. */
+    matchedRoute: string;
+    /** Dynamic inputs for the composition from the route path: path segment and query string parameters. */
+    dynamicInputs: Record<string, string>;
+    pageState: PageState;
+};
+
+type IndexedPersonalizationVariant = PersonalizedVariant<VariationMatchMetadata> & {
+    componentId: string;
+    index: number;
+};
+declare const evaluatePersonalization: ({ personalization, context, compositionContext, }: {
+    personalization: PersonalizeOptions<IndexedPersonalizationVariant>;
+    context: Context;
+    compositionContext: CompositionContext;
+}) => {
+    indexes: number[];
+    componentIds: string[];
+    event: PersonalizationEvent;
+};
+
+type IndexedTestVariant = TestVariant & {
+    componentId: string;
+    index: number;
+};
+declare const evaluateTest: ({ test, context, compositionContext, }: {
+    test: TestOptions<IndexedTestVariant>;
+    context: Context;
+    compositionContext: CompositionContext;
+}) => {
+    index: number | null;
+    componentId: string | null;
+    event: TestEvent | null;
+};
+
+type ExtractPersonalizationVariant = IndexedPersonalizationVariant;
+type ExtractPersonalizationResult = PersonalizeOptions<ExtractPersonalizationVariant>;
+type ExtractTestVariant = IndexedTestVariant;
+type ExtractTestResult = TestOptions<ExtractTestVariant>;
+
+type SlotDefinition = {
+    name: string;
+    items: ({
+        _id: string;
+        [CANVAS_PERSONALIZATION_PARAM]: VariantMatchCriteria | undefined;
+        /**
+         * Only populated for variants of tests or personalizations
+         */
+        variantId: string | undefined;
+        component: ReactNode;
+    } | null)[];
+};
+
+type ComponentProps<TParameters extends Record<string, ComponentParameter> | unknown = Record<string, ComponentParameter>, TSlotNames extends string = string> = {
+    type: string;
+    variant: string | undefined;
+    slots: Record<TSlotNames, SlotDefinition>;
+    parameters: TParameters;
+    component: ComponentContext;
+    context: CompositionContext;
+};
+type PersonalizeProps = ComponentProps<{
+    algorithm?: ComponentParameter<string>;
+    trackingEventName?: ComponentParameter<string>;
+}> & {
+    indexes: number[];
+};
+type TestProps = ComponentProps & {
+    index: number;
+    test: ExtractTestResult;
+};
+
+type CacheMode = {
+    type: RequestInit['cache'];
+    bypassCache?: boolean;
+} | {
+    type: 'revalidate';
+    interval: number;
+    bypassCache?: boolean;
+};
+type ManifestCacheMode = CacheMode;
+type ProjectMapCacheMode = CacheMode;
+type CanvasCacheMode = CacheMode & {
+    disableSWR?: boolean;
+};
+type UniformServerConfig = {
+    /**
+     * Sets the default value of storage consent for new unknown visitors.
+     *
+     * @default false
+     */
+    defaultConsent?: boolean;
+    /**
+     * The path to the playground page.
+     */
+    playgroundPath?: string;
+    /**
+     * Cache mode for manifest data.
+     *
+     */
+    manifestCache?: ManifestCacheMode;
+    /**
+     * Cache mode for canvas data.
+     *
+     */
+    canvasCache?: CanvasCacheMode;
+    /**
+     * Cache mode for project map data.
+     *
+     */
+    projectMapCache?: ProjectMapCacheMode;
+    eTags?: {
+        /**
+         * Generate ETags for published compositions.
+         *
+         * @default false
+         */
+        generateETags?: boolean;
+        /**
+         * Cache control header for pages that have ETags.
+         *
+         * @default 'no-cache, must-revalidate'
+         */
+        cacheControl?: string | null;
+    };
+    /**
+     * Options for Uniform Context
+     */
+    context?: {
+        /**
+         * Disables the Uniform Context dev tools.
+         *
+         * @default false
+         */
+        disableDevTools?: boolean;
+    };
+    /**
+     * 😅
+     */
+    experimental?: {
+        /**
+         * Enables quirk serialization for Uniform Context.
+         *
+         * @default false
+         */
+        quirkSerialization?: boolean;
+        /**
+         * Enables visual editing mode.
+         *
+         * @default false
+         */
+        vercelVisualEditing?: boolean;
+        /**
+         * Enables runtime cache in middleware.
+         *
+         * @default false
+         */
+        middlewareRuntimeCache?: boolean;
+        /**
+         * Requires middlewareRuntimeCache to be enabled. If enabled, the middleware will retain a copy
+         * of the old route data in cache and use it while the new route data is being fetched.
+         *
+         * @default false
+         */
+        disableSwrMiddlewareCache?: boolean;
+    };
+};
+
+declare const extractPersonalizationName: ({ component, }: {
+    component: Pick<ComponentInstance, "parameters">;
+}) => string;
+
+declare const extractTestName: ({ component }: {
+    component: Pick<ComponentInstance, "parameters">;
+}) => string;
+
+type RewriteRequestPathResult = {
+    path: string;
+    keys?: Record<string, string>;
+};
+
+declare const UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME = "ufsc";
+declare const UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME = "ufqc";
+
+export { type CacheMode, type CanvasCacheMode, type ComponentContext, type ComponentParameter, type ComponentProps, type CompositionContext, type ExtractPersonalizationResult, type ExtractPersonalizationVariant, type ExtractTestResult, type ExtractTestVariant, type IndexedPersonalizationVariant, type IndexedTestVariant, type ManifestCacheMode, type PageState, type PageStateComponent, type PageStateComponentFields, type PersonalizeProps, type ProjectMapCacheMode, type RewriteRequestPathResult, type SlotDefinition, type TestProps, UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME, UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME, type UniformServerConfig, deserializeEvaluationResult, evaluatePersonalization, evaluateTest, extractPersonalizationName, extractTestName, getRuleId, resolveComponentFromPageState, resolveRuleFromPageState, serializeEvaluationResult };