@uniformdev/context-vue 19.35.2 → 19.35.3-alpha.82

package/dist/index.d.mts

@@ -0,0 +1,290 @@
+import * as vue_demi from 'vue-demi';
+import { ConcreteComponent, PropType, App } from 'vue-demi';
+import { PersonalizedVariant, TestVariant, EnrichmentData, Context, Quirks, ScoreVector } from '@uniformdev/context';
+import * as _uniformdev_context_dist_types_012db0cb from '@uniformdev/context/dist/types-012db0cb';
+
+type PersonalizedVariationComponentProps = PersonalizedVariant & {
+    personalizationResult: {
+        variation: PersonalizedVariant;
+        personalizationOccurred: boolean;
+    };
+};
+type PersonalizedVariationComponent = (variation: PersonalizedVariationComponentProps) => ConcreteComponent<any>;
+type PersonalizeComponentProps = {
+    /**
+     * Name of the personalized placement. Should be unique to this placement location and set of variants.
+     * This name is emitted to analytics after personalization executes.
+     */
+    name: string;
+    /** The possible variations of the content to render depending on personalization conditions */
+    variations: PersonalizedVariant[];
+    /** A Vue component to use to render a selected variant. */
+    component: PersonalizedVariationComponent;
+    /** The number of variations to select. Use for personalized lists where the `count` most relevant should be shown. */
+    count?: number;
+};
+declare const Personalize: vue_demi.DefineComponent<{
+    name: {
+        type: PropType<string>;
+        required: true;
+    };
+    variations: {
+        type: PropType<PersonalizedVariant[]>;
+        required: true;
+    };
+    component: {
+        type: PropType<PersonalizedVariationComponent>;
+        required: true;
+    };
+    count: {
+        type: PropType<number | undefined>;
+        default: number;
+    };
+}, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
+    name: {
+        type: PropType<string>;
+        required: true;
+    };
+    variations: {
+        type: PropType<PersonalizedVariant[]>;
+        required: true;
+    };
+    component: {
+        type: PropType<PersonalizedVariationComponent>;
+        required: true;
+    };
+    count: {
+        type: PropType<number | undefined>;
+        default: number;
+    };
+}>>, {
+    count: number | undefined;
+}>;
+
+declare const PersonalizeStandard: vue_demi.DefineComponent<{
+    name: {
+        type: PropType<string>;
+        required: true;
+    };
+    variations: {
+        type: PropType<_uniformdev_context_dist_types_012db0cb.a4[]>;
+        required: true;
+    };
+    component: {
+        type: PropType<PersonalizedVariationComponent>;
+        required: true;
+    };
+    count: {
+        type: PropType<number | undefined>;
+        default: number;
+    };
+}, () => (vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}> | vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}>[][])[], unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
+    name: {
+        type: PropType<string>;
+        required: true;
+    };
+    variations: {
+        type: PropType<_uniformdev_context_dist_types_012db0cb.a4[]>;
+        required: true;
+    };
+    component: {
+        type: PropType<PersonalizedVariationComponent>;
+        required: true;
+    };
+    count: {
+        type: PropType<number | undefined>;
+        default: number;
+    };
+}>>, {
+    count: number | undefined;
+}>;
+
+interface TestComponentProps {
+    /** Name of the test that is running. */
+    name: string;
+    /** Variation list that this test will selected from. */
+    variations: TestVariant[];
+    /** A Vue component to use to render the test variant. */
+    component: ConcreteComponent<TestVariant>;
+}
+declare const Test: vue_demi.DefineComponent<{
+    name: {
+        type: PropType<string>;
+        required: true;
+    };
+    variations: {
+        type: PropType<TestVariant[]>;
+        required: true;
+    };
+    component: {
+        type: PropType<ConcreteComponent<TestVariant>>;
+        required: true;
+    };
+}, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
+    name: {
+        type: PropType<string>;
+        required: true;
+    };
+    variations: {
+        type: PropType<TestVariant[]>;
+        required: true;
+    };
+    component: {
+        type: PropType<ConcreteComponent<TestVariant>>;
+        required: true;
+    };
+}>>, {}>;
+
+/**
+ * Tracks visitor behavior by adding enrichment score when they view content wrapped in this component.
+ * When the Track component is sufficiently in the viewport, it will trigger the enrichment values specified
+ * in `behavior` to the current visitor. If the browser does not support IntersectionObserver, the behavior will
+ * be triggered immediately on page load instead.
+ *
+ * NOTE: this component necessarily renders a wrapping tag to attach the IntersectionObserver to; this can result
+ * in DOM changes when personalization is added. If that's undesirable use TrackSlot instead which tracks
+ * only on page load, but does not render a wrapping tag.
+ */
+declare const Track: vue_demi.DefineComponent<{
+    behavior: {
+        type: PropType<EnrichmentData | EnrichmentData[] | undefined>;
+    };
+    tagName: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+    disableVisibilityTrigger: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+    threshold: {
+        type: PropType<number | number[] | undefined>;
+        default: number;
+    };
+}, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
+    behavior: {
+        type: PropType<EnrichmentData | EnrichmentData[] | undefined>;
+    };
+    tagName: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+    disableVisibilityTrigger: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+    threshold: {
+        type: PropType<number | number[] | undefined>;
+        default: number;
+    };
+}>>, {
+    tagName: string | undefined;
+    disableVisibilityTrigger: boolean | undefined;
+    threshold: number | number[] | undefined;
+}>;
+
+/**
+ * Tracks visitor behavior by adding enrichment score when they are shown a route with this component on it.
+ *
+ * NOTE: if you wish to track on the visitor seeing the content in the browser viewport instead,
+ * use Track instead of TrackFragment.
+ */
+declare const TrackSlot: vue_demi.DefineComponent<{
+    behavior: {
+        type: PropType<EnrichmentData | EnrichmentData[] | undefined>;
+    };
+}, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
+    behavior: {
+        type: PropType<EnrichmentData | EnrichmentData[] | undefined>;
+    };
+}>>, {}>;
+
+type VariantOutputType = 'edge' | 'standard';
+type UniformContextProps = {
+    /** The configured Uniform Context instance to provide */
+    context: Context;
+    /** The output type to emit.
+     * - `standard` - Emits selected variants as HTML suitable for SSR or SSG
+     * - `edge` - Emits all variants suitable for Edge-side personalization selection
+     *
+     * @default standard
+     */
+    outputType?: VariantOutputType;
+    /**
+     * Whether to track a route change to the current URL when this component is rendered.
+     *
+     * @default true
+     */
+    trackRouteOnRender?: boolean;
+};
+declare const uniformContextInjectionKey = "uniformContextInjectionKey";
+declare const provideUniformContext: ({ context, outputType, trackRouteOnRender, vueAppInstance, }: UniformContextProps & {
+    vueAppInstance?: App<Element> | undefined;
+}) => void;
+declare function onRouteChange(context: Context): void;
+declare const useUniformContext: () => UniformContextProps;
+declare function isUsingUniformContext(): boolean;
+
+declare const UniformContextProvider: vue_demi.DefineComponent<{
+    context: {
+        type: PropType<Context>;
+        required: true;
+    };
+    outputType: {
+        type: PropType<VariantOutputType | undefined>;
+        default: string;
+    };
+    trackRouteOnRender: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+}, () => (vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}> | (() => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
+    [key: string]: any;
+}>))[], unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
+    context: {
+        type: PropType<Context>;
+        required: true;
+    };
+    outputType: {
+        type: PropType<VariantOutputType | undefined>;
+        default: string;
+    };
+    trackRouteOnRender: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+}>>, {
+    outputType: VariantOutputType | undefined;
+    trackRouteOnRender: boolean | undefined;
+}>;
+
+declare const provideIsPersonalized: (isPersonalized?: boolean) => void;
+declare const useIsPersonalized: () => boolean;
+
+/**
+ * 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 const useQuirks: () => vue_demi.Ref<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 const useScores: () => vue_demi.Ref<ScoreVector>;
+
+export { Personalize, PersonalizeComponentProps, PersonalizeStandard as PersonalizeEdge, PersonalizedVariationComponent, PersonalizedVariationComponentProps, Test, TestComponentProps, Track, TrackSlot, UniformContextProps, UniformContextProvider, VariantOutputType, isUsingUniformContext, onRouteChange, provideIsPersonalized, provideUniformContext, uniformContextInjectionKey, useIsPersonalized, useQuirks, useScores, useUniformContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context-vue",
-  "version": "19.35.2",
+  "version": "19.35.3-alpha.82+4bc341093",
   "description": "Vue SDK for Uniform Context",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -23,7 +23,7 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/context": "19.35.2",
+    "@uniformdev/context": "19.35.3-alpha.82+4bc341093",
     "cookie-es": "^1.0.0",
     "dequal": "^2.0.2",
     "uuid": "9.0.0",
@@ -59,5 +59,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64d3270175087c87cfaa29a283aa4a7b0a98fd2c"
+  "gitHead": "4bc341093bc946900df2646fe53eca4bcddc693c"
 }