@avsbhq/vue 1.0.2 → 1.1.1

package/dist/chunk-4XBADQFO.js

@@ -0,0 +1,21 @@
+// src/context.ts
+import { inject } from "vue";
+var AvsbInjectionKey = /* @__PURE__ */ Symbol("avsb-injection-key");
+function useAvsbContext() {
+  const value = inject(AvsbInjectionKey);
+  if (value === void 0) {
+    throw new Error(
+      `[avsb] composables must be used inside <AvsbProvider> or app.use(AvsbPlugin). Wrap your component tree with <AvsbProvider sdk-key="sdk_production_..." :context="{ kind: 'user', key: userId }">, or install the plugin with app.use(AvsbPlugin, { sdkKey: 'sdk_production_...' }).`
+    );
+  }
+  return value;
+}
+function hasAvsbContext() {
+  return inject(AvsbInjectionKey, null) !== null;
+}
+
+export {
+  AvsbInjectionKey,
+  useAvsbContext,
+  hasAvsbContext
+};

package/dist/chunk-FUADAPSW.js

@@ -0,0 +1,140 @@
+import {
+  AvsbInjectionKey,
+  hasAvsbContext
+} from "./chunk-4XBADQFO.js";
+
+// src/AvsbProvider.ts
+import { defineComponent, onUnmounted, provide } from "vue";
+import { isDevEnvironment } from "@avsbhq/browser";
+import { consoleLogger } from "@avsbhq/core";
+
+// src/internal/providerState.ts
+import { ref, shallowRef } from "vue";
+var UNEXPLAINED_FAILURE = "[avsb] the SDK could not load a datafile and nothing was cached or bootstrapped, so every flag is returning the default you passed. Check the SDK key on app.avsb.cloud under Environments in the project sidebar.";
+function createProviderState(client) {
+  const status = ref(client.isReady() ? "ready" : "loading");
+  const error = shallowRef(void 0);
+  const degraded = ref(false);
+  let stopped = false;
+  const applyInitResult = (result) => {
+    if (stopped) return;
+    if (result.success) {
+      status.value = "ready";
+      degraded.value = result.degraded === true;
+      error.value = result.error;
+      return;
+    }
+    status.value = "error";
+    error.value = result.error ?? new Error(UNEXPLAINED_FAILURE);
+  };
+  const settled = client.getInitResult();
+  if (settled) {
+    applyInitResult(settled);
+  } else {
+    void client.onReady().then(applyInitResult);
+  }
+  const offError = client.on("error", (e) => {
+    if (stopped) return;
+    error.value = e;
+    if (client.isReady()) {
+      degraded.value = true;
+      return;
+    }
+    status.value = "error";
+  });
+  const offReady = client.on("ready", applyInitResult);
+  return {
+    status,
+    error,
+    degraded,
+    stop: () => {
+      stopped = true;
+      offError();
+      offReady();
+    }
+  };
+}
+
+// src/internal/resolveClient.ts
+import { AvsbClient } from "@avsbhq/browser";
+var MISUSE_MESSAGE = `[avsb] <AvsbProvider> needs either an sdk-key (Mode A) or a client (Mode B). Mode A: <AvsbProvider sdk-key="sdk_production_..." :context="{ kind: 'user', key: userId }">. Mode B: <AvsbProvider :client="myClient">. The key for each environment is on app.avsb.cloud under Environments in the project sidebar.`;
+function resolveClient(props) {
+  const injected = props.client;
+  if (injected !== void 0 && injected !== null) {
+    return { client: injected, owned: false };
+  }
+  const { sdkKey, context, bootstrap, options } = props;
+  if (typeof sdkKey !== "string" || sdkKey.length === 0) {
+    throw new Error(MISUSE_MESSAGE);
+  }
+  const clientOptions = {
+    ...options ?? {},
+    sdkKey,
+    ...context !== void 0 ? { context } : {},
+    ...bootstrap !== void 0 ? { bootstrap } : {}
+  };
+  return { client: new AvsbClient(clientOptions), owned: true };
+}
+
+// src/AvsbProvider.ts
+var NESTED_PROVIDER_WARNING = "[avsb] <AvsbProvider> is nested inside another <AvsbProvider>. The inner one shadows the outer for everything below it, so two clients are now running, each with its own visitor id and its own event queue. Mount one provider at the root of the app unless you meant to isolate a subtree.";
+var AvsbProvider = defineComponent({
+  name: "AvsbProvider",
+  props: {
+    /** Mode B: a client you built and own. */
+    client: {
+      type: Object,
+      default: void 0
+    },
+    /** Mode A: the environment's SDK key. */
+    sdkKey: {
+      type: String,
+      default: void 0
+    },
+    /** Mode A: evaluation context. Omit for an anonymous visitor. */
+    context: {
+      type: Object,
+      default: void 0
+    },
+    /** Mode A: a datafile fetched on the server, for a real first paint. */
+    bootstrap: {
+      type: Object,
+      default: void 0
+    },
+    /** Mode A: everything else AvsbClient accepts. */
+    options: {
+      type: Object,
+      default: void 0
+    }
+  },
+  setup(props, { slots }) {
+    if (hasAvsbContext() && isDevEnvironment()) {
+      consoleLogger("warn").warn(NESTED_PROVIDER_WARNING);
+    }
+    const { client, owned } = resolveClient(props);
+    const state = createProviderState(client);
+    provide(AvsbInjectionKey, {
+      client,
+      get status() {
+        return state.status.value;
+      },
+      get error() {
+        return state.error.value;
+      },
+      get degraded() {
+        return state.degraded.value;
+      }
+    });
+    onUnmounted(() => {
+      state.stop();
+      if (owned) void client.close();
+    });
+    return () => slots.default?.();
+  }
+});
+
+export {
+  createProviderState,
+  resolveClient,
+  AvsbProvider
+};

package/dist/clientInterface-BMlQ7Uhe.d.cts

@@ -0,0 +1,69 @@
+import { InitResult, FlagDatafile, EvalContext, AvsbFlagKey, Flag, TrackPayload, ClientEventName, ClientEventMap } from '@avsbhq/core';
+import { GetFlagOptions, GetAllFlagsOptions } from '@avsbhq/browser';
+
+/**
+ * The slice of `AvsbClient` (@avsbhq/browser) that @avsbhq/vue depends on.
+ *
+ * This is the store contract documented in the browser SDK's README under
+ * "The store contract, for framework adapters": `subscribe` + `getSnapshot`
+ * for render-safe reads, the typed getters with `{ readOnly: true }` for
+ * render paths, and `isReady()` / `getInitResult()` for a synchronous first
+ * pass. A real `AvsbClient` satisfies this interface structurally, so no cast
+ * is required at the boundary.
+ *
+ * Why an interface at all: composables take the client from the provider's
+ * injected context, so a test (or a Storybook decorator) can inject anything
+ * that speaks this surface. `@avsbhq/vue/testing` ships one that is a real
+ * `AvsbClient` with the network switched off.
+ */
+
+interface VueAvsbClient {
+    /** Resolves when the init attempt settles. Never rejects. */
+    onReady(options?: {
+        timeout?: number;
+    }): Promise<InitResult>;
+    /** True when flags are readable right now (bootstrap, cache, or network). */
+    isReady(): boolean;
+    /** The settled init outcome, or null while the first attempt is in flight. */
+    getInitResult(): InitResult | null;
+    /** Adopt a datafile received out of band (SSR bootstrap). */
+    applyDatafileBootstrap(datafile: FlagDatafile): void;
+    refresh(): Promise<void>;
+    flush(): Promise<void>;
+    close(): Promise<void>;
+    identify(context: EvalContext): void;
+    updateAttributes(partial: Record<string, unknown>, contextKind?: string): void;
+    /**
+     * Queues one `avsb_alias` event and returns. Synchronous: there is nothing
+     * to await, and it does not rewrite assignments already made.
+     */
+    alias(previousContext: EvalContext, newContext: EvalContext): void;
+    getContext(): EvalContext;
+    /** New anonymous identity, overrides cleared. Call on sign-out. */
+    reset(): void;
+    getFlag<T>(flagKey: AvsbFlagKey, defaultValue: T, options?: GetFlagOptions): Flag<T>;
+    getBoolFlag(flagKey: AvsbFlagKey, defaultValue: boolean, options?: GetFlagOptions): Flag<boolean>;
+    getStringFlag(flagKey: AvsbFlagKey, defaultValue: string, options?: GetFlagOptions): Flag<string>;
+    getNumberFlag(flagKey: AvsbFlagKey, defaultValue: number, options?: GetFlagOptions): Flag<number>;
+    getJsonFlag<T>(flagKey: AvsbFlagKey, defaultValue: T, options?: GetFlagOptions): Flag<T>;
+    getAllFlags(options?: GetAllFlagsOptions): Record<string, Flag>;
+    /**
+     * Called when this flag's value changes, and once when the first datafile
+     * is applied. Returns its own unsubscribe function.
+     */
+    subscribe(flagKey: AvsbFlagKey, listener: () => void): () => void;
+    /**
+     * Render-safe read: the SAME frozen object until the value changes, no
+     * exposure, no `evaluation` event.
+     */
+    getSnapshot<T>(flagKey: AvsbFlagKey, defaultValue: T): Flag<T>;
+    track(eventKey: string, payload?: TrackPayload): void;
+    on<E extends ClientEventName>(event: E, cb: ClientEventMap[E]): () => void;
+    setOverrideForUser(flagKey: AvsbFlagKey, contextKey: string, variationKey: string, contextKind?: string): void;
+    setGlobalOverride(flagKey: AvsbFlagKey, variationKey: string): void;
+    clearOverrideForUser(flagKey: AvsbFlagKey, contextKey: string, contextKind?: string): void;
+    clearGlobalOverride(flagKey: AvsbFlagKey): void;
+    clearAllOverrides(): void;
+}
+
+export type { VueAvsbClient as V };

package/dist/clientInterface-BMlQ7Uhe.d.ts

@@ -0,0 +1,69 @@
+import { InitResult, FlagDatafile, EvalContext, AvsbFlagKey, Flag, TrackPayload, ClientEventName, ClientEventMap } from '@avsbhq/core';
+import { GetFlagOptions, GetAllFlagsOptions } from '@avsbhq/browser';
+
+/**
+ * The slice of `AvsbClient` (@avsbhq/browser) that @avsbhq/vue depends on.
+ *
+ * This is the store contract documented in the browser SDK's README under
+ * "The store contract, for framework adapters": `subscribe` + `getSnapshot`
+ * for render-safe reads, the typed getters with `{ readOnly: true }` for
+ * render paths, and `isReady()` / `getInitResult()` for a synchronous first
+ * pass. A real `AvsbClient` satisfies this interface structurally, so no cast
+ * is required at the boundary.
+ *
+ * Why an interface at all: composables take the client from the provider's
+ * injected context, so a test (or a Storybook decorator) can inject anything
+ * that speaks this surface. `@avsbhq/vue/testing` ships one that is a real
+ * `AvsbClient` with the network switched off.
+ */
+
+interface VueAvsbClient {
+    /** Resolves when the init attempt settles. Never rejects. */
+    onReady(options?: {
+        timeout?: number;
+    }): Promise<InitResult>;
+    /** True when flags are readable right now (bootstrap, cache, or network). */
+    isReady(): boolean;
+    /** The settled init outcome, or null while the first attempt is in flight. */
+    getInitResult(): InitResult | null;
+    /** Adopt a datafile received out of band (SSR bootstrap). */
+    applyDatafileBootstrap(datafile: FlagDatafile): void;
+    refresh(): Promise<void>;
+    flush(): Promise<void>;
+    close(): Promise<void>;
+    identify(context: EvalContext): void;
+    updateAttributes(partial: Record<string, unknown>, contextKind?: string): void;
+    /**
+     * Queues one `avsb_alias` event and returns. Synchronous: there is nothing
+     * to await, and it does not rewrite assignments already made.
+     */
+    alias(previousContext: EvalContext, newContext: EvalContext): void;
+    getContext(): EvalContext;
+    /** New anonymous identity, overrides cleared. Call on sign-out. */
+    reset(): void;
+    getFlag<T>(flagKey: AvsbFlagKey, defaultValue: T, options?: GetFlagOptions): Flag<T>;
+    getBoolFlag(flagKey: AvsbFlagKey, defaultValue: boolean, options?: GetFlagOptions): Flag<boolean>;
+    getStringFlag(flagKey: AvsbFlagKey, defaultValue: string, options?: GetFlagOptions): Flag<string>;
+    getNumberFlag(flagKey: AvsbFlagKey, defaultValue: number, options?: GetFlagOptions): Flag<number>;
+    getJsonFlag<T>(flagKey: AvsbFlagKey, defaultValue: T, options?: GetFlagOptions): Flag<T>;
+    getAllFlags(options?: GetAllFlagsOptions): Record<string, Flag>;
+    /**
+     * Called when this flag's value changes, and once when the first datafile
+     * is applied. Returns its own unsubscribe function.
+     */
+    subscribe(flagKey: AvsbFlagKey, listener: () => void): () => void;
+    /**
+     * Render-safe read: the SAME frozen object until the value changes, no
+     * exposure, no `evaluation` event.
+     */
+    getSnapshot<T>(flagKey: AvsbFlagKey, defaultValue: T): Flag<T>;
+    track(eventKey: string, payload?: TrackPayload): void;
+    on<E extends ClientEventName>(event: E, cb: ClientEventMap[E]): () => void;
+    setOverrideForUser(flagKey: AvsbFlagKey, contextKey: string, variationKey: string, contextKind?: string): void;
+    setGlobalOverride(flagKey: AvsbFlagKey, variationKey: string): void;
+    clearOverrideForUser(flagKey: AvsbFlagKey, contextKey: string, contextKind?: string): void;
+    clearGlobalOverride(flagKey: AvsbFlagKey): void;
+    clearAllOverrides(): void;
+}
+
+export type { VueAvsbClient as V };