@avsbhq/vue 1.0.0 → 1.0.1

package/README.md

@@ -12,7 +12,7 @@ Drop an `<AvsbProvider>` at the top of your component tree (or call `app.use(Avs
 npm install @avsbhq/vue
 ```
 
-Vue 3.4 or later is required as a peer dependency. Pinia integration is optional — install `pinia` only if you use `useAvsbStore`.
+Vue 3.4 or later is required as a peer dependency. Pinia integration is optional: install `pinia` only if you use `useAvsbStore`.
 
 ---
 
@@ -53,7 +53,7 @@ const track = useTrack()
 
 Get a client SDK key from your A vs B project's Environments page.
 
-Client SDK keys are safe to embed in browser bundles — store them in your framework's public env variable:
+Client SDK keys are safe to embed in browser bundles. Store them in your framework's public env variable:
 
 ```
 VITE_AVSB_SDK_KEY=sdk-...
@@ -68,7 +68,7 @@ Server SDK keys (used by `@avsbhq/node`) must never be exposed to the browser.
 
 ---
 
-## 4. Identity — identify, updateAttributes, alias, reset
+## 4. Identity (identify, updateAttributes, alias, reset)
 
 ### Provider-level context
 
@@ -92,7 +92,7 @@ function onSignIn(user: User) {
 }
 ```
 
-The function is stable — it will not change reference between renders.
+The function is stable; it will not change reference between renders.
 
 ### useAlias
 
@@ -119,7 +119,7 @@ Call `client.reset()` via `useAvsbClient()` to clear the current identity and re
 
 ## 5. Multi-context
 
-A vs B supports multi-context evaluation — evaluating a flag for both a user and an organisation simultaneously:
+A vs B supports multi-context evaluation: evaluating a flag for both a user and an organisation simultaneously:
 
 ```ts
 identify({
@@ -133,7 +133,7 @@ identify({
 
 ## 6. Reading flags
 
-### useFlag — full Flag object
+### useFlag (full Flag object)
 
 ```ts
 import { useFlag } from '@avsbhq/vue'
@@ -150,7 +150,7 @@ const checkoutFlag = useFlag('new-checkout-flow', false)
 
 A default value is always required. It is returned until the SDK is ready and whenever the flag is not found.
 
-### useFlagValue — raw value shortcut
+### useFlagValue (raw value shortcut)
 
 ```ts
 import { useFlagValue } from '@avsbhq/vue'
@@ -176,14 +176,14 @@ All return `ComputedRef<Flag<T>>`.
 
 ### Reactive flag key
 
-`useFlag` (and `useFlagValue`) accept a `Ref<string>` or `ComputedRef<string>` as the key — the subscription updates automatically when the key changes:
+`useFlag` (and `useFlagValue`) accept a `Ref<string>` or `ComputedRef<string>` as the key, and the subscription updates automatically when the key changes:
 
 ```ts
 const selectedFlag = ref('feature-a')
 const flag = useFlag(selectedFlag, false)
 ```
 
-### useAllFlags — all evaluated flags
+### useAllFlags (all evaluated flags)
 
 ```ts
 import { useAllFlags } from '@avsbhq/vue'
@@ -193,7 +193,7 @@ const flags = useAllFlags()
 // Re-computes on any flagChange event.
 ```
 
-Prefer individual `useFlag` composables in most components — `useAllFlags` triggers on any flag change and is best suited for debug panels.
+Prefer individual `useFlag` composables in most components. `useAllFlags` triggers on any flag change and is best suited for debug panels.
 
 ---
 
@@ -209,7 +209,7 @@ function onClick() {
 }
 ```
 
-The function is defined once in setup — it is safe to use as an event handler without wrapping in a closure.
+The function is defined once in setup, so it is safe to use as an event handler without wrapping in a closure.
 
 ---
 
@@ -260,7 +260,7 @@ const client = new AvsbClient({ sdkKey: '...', bootstrap: serverDatafile })
 ```
 
 ```vue
-<!-- App.vue — client side -->
+<!-- App.vue, client side -->
 <AvsbProvider :sdk-key="sdkKey" :bootstrap="bootstrapDatafile">
   <NuxtPage />
 </AvsbProvider>
@@ -289,7 +289,7 @@ The `AvsbPlugin` (Mode A) proxies `app.unmount` to close the client when the Vue
 
 ## 11. Testing
 
-Inject a mock context directly via `provide` — no need to mount the full provider:
+Inject a mock context directly via `provide`; no need to mount the full provider:
 
 ```ts
 import { defineComponent, h, provide } from 'vue'
@@ -360,4 +360,4 @@ Key differences:
 
 - `useFlag` returns a `Flag<T>` object, not a raw `T`. Access `.value` for the primitive or `.isEnabled()` for a boolean gate. This gives you the evaluation metadata (source, variationKey, reasons) without a second call.
 - All `getFlag` variants require an explicit `defaultValue`. There is no untyped `.variation()`.
-- Multi-context is a first-class concept — no adapter required.
+- Multi-context is a first-class concept, with no adapter required.

package/dist/index.d.cts

@@ -77,7 +77,7 @@ declare const AvsbProvider: vue.DefineComponent<vue.ExtractPropTypes<{
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 /**
- * AvsbPlugin — Vue plugin alternative to mounting <AvsbProvider>.
+ * AvsbPlugin: Vue plugin alternative to mounting <AvsbProvider>.
  *
  * Usage:
  *   // Mode A: SDK creates and owns the client
@@ -107,7 +107,7 @@ interface AvsbContextValue {
 declare const AvsbInjectionKey: InjectionKey<AvsbContextValue>;
 
 /**
- * §5.13 + §5.14 — Subscribe to a single flag.
+ * §5.13 + §5.14: Subscribe to a single flag.
  *
  * Returns `ComputedRef<Flag<T>>` (not raw `T`). The computed re-evaluates
  * only when the value of `flagKey` changes via the subscribe callback.
@@ -120,7 +120,7 @@ declare const AvsbInjectionKey: InjectionKey<AvsbContextValue>;
 declare function useFlag<T>(flagKey: string | Ref<string> | ComputedRef<string>, defaultValue: T): ComputedRef<Flag<T>>;
 
 /**
- * §5.16 — Convenience shortcut that returns the flag's raw value `T`
+ * §5.16: Convenience shortcut that returns the flag's raw value `T`
  * instead of the full `Flag<T>` object.
  *
  * Use `useFlag()` when you need `variationKey`, `source`, `reasons`, or
@@ -130,7 +130,7 @@ declare function useFlag<T>(flagKey: string | Ref<string> | ComputedRef<string>,
 declare function useFlagValue<T>(flagKey: string | Ref<string> | ComputedRef<string>, defaultValue: T): ComputedRef<T>;
 
 /**
- * §5.16 — Typed boolean flag composable.
+ * §5.16: Typed boolean flag composable.
  *
  * Calls `client.getBoolFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -141,7 +141,7 @@ declare function useFlagValue<T>(flagKey: string | Ref<string> | ComputedRef<str
 declare function useBoolFlag(flagKey: string, defaultValue: boolean): ComputedRef<Flag<boolean>>;
 
 /**
- * §5.16 — Typed string flag composable.
+ * §5.16: Typed string flag composable.
  *
  * Calls `client.getStringFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -152,7 +152,7 @@ declare function useBoolFlag(flagKey: string, defaultValue: boolean): ComputedRe
 declare function useStringFlag(flagKey: string, defaultValue: string): ComputedRef<Flag<string>>;
 
 /**
- * §5.16 — Typed number flag composable.
+ * §5.16: Typed number flag composable.
  *
  * Calls `client.getNumberFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -163,7 +163,7 @@ declare function useStringFlag(flagKey: string, defaultValue: string): ComputedR
 declare function useNumberFlag(flagKey: string, defaultValue: number): ComputedRef<Flag<number>>;
 
 /**
- * §5.16 — Typed JSON flag composable.
+ * §5.16: Typed JSON flag composable.
  *
  * Calls `client.getJsonFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -174,7 +174,7 @@ declare function useNumberFlag(flagKey: string, defaultValue: number): ComputedR
 declare function useJsonFlag<T>(flagKey: string, defaultValue: T): ComputedRef<Flag<T>>;
 
 /**
- * §5.16 — Returns `ComputedRef<Record<string, Flag>>` containing all
+ * §5.16: Returns `ComputedRef<Record<string, Flag>>` containing all
  * evaluated flags.
  *
  * Subscribes to the global `'flagChange'` event bus rather than per-flag
@@ -187,7 +187,7 @@ declare function useJsonFlag<T>(flagKey: string, defaultValue: T): ComputedRef<F
 declare function useAllFlags(): ComputedRef<Record<string, Flag>>;
 
 /**
- * §5.15 — Returns `ComputedRef<boolean>` that is `true` once the
+ * §5.15: Returns `ComputedRef<boolean>` that is `true` once the
  * Provider's client is ready.
  *
  * Simple boolean alternative to reading status directly for components
@@ -198,7 +198,7 @@ declare function useFlagReady(): ComputedRef<boolean>;
 /**
  * Returns the underlying `AvsbClient` instance (or `null` while loading).
  *
- * The type is `VueAvsbClient` — the interface declaring the surface this
+ * The type is `VueAvsbClient`, the interface declaring the surface this
  * package uses. Once @avsbhq/browser ships the full reshape, `AvsbClient`
  * satisfies this interface structurally.
  *
@@ -209,7 +209,7 @@ declare function useFlagReady(): ComputedRef<boolean>;
 declare function useAvsbClient(): VueAvsbClient | null;
 
 /**
- * §5.16 — Returns a stable `identify` function.
+ * §5.16: Returns a stable `identify` function.
  *
  * Calling `identify(ctx)` replaces the client's current evaluation context.
  * All subsequent flag evaluations and exposure events use the new context.
@@ -220,7 +220,7 @@ declare function useAvsbClient(): VueAvsbClient | null;
 declare function useIdentify(): (ctx: EvalContext) => void;
 
 /**
- * §5.16 — Returns a stable `alias` function.
+ * §5.16: Returns a stable `alias` function.
  *
  * Calling `alias(prev, next)` records that two contexts represent the
  * same user identity (e.g. anonymous visitor → identified user after
@@ -231,7 +231,7 @@ declare function useIdentify(): (ctx: EvalContext) => void;
 declare function useAlias(): (prev: EvalContext, next: EvalContext) => Promise<void>;
 
 /**
- * §5.16 — Returns a stable `track` function that survives the
+ * §5.16: Returns a stable `track` function that survives the
  * loading → ready transition without changing its reference.
  *
  * The function delegates to `client.track()` via a ref so that callers

package/dist/index.d.ts

@@ -77,7 +77,7 @@ declare const AvsbProvider: vue.DefineComponent<vue.ExtractPropTypes<{
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 /**
- * AvsbPlugin — Vue plugin alternative to mounting <AvsbProvider>.
+ * AvsbPlugin: Vue plugin alternative to mounting <AvsbProvider>.
  *
  * Usage:
  *   // Mode A: SDK creates and owns the client
@@ -107,7 +107,7 @@ interface AvsbContextValue {
 declare const AvsbInjectionKey: InjectionKey<AvsbContextValue>;
 
 /**
- * §5.13 + §5.14 — Subscribe to a single flag.
+ * §5.13 + §5.14: Subscribe to a single flag.
  *
  * Returns `ComputedRef<Flag<T>>` (not raw `T`). The computed re-evaluates
  * only when the value of `flagKey` changes via the subscribe callback.
@@ -120,7 +120,7 @@ declare const AvsbInjectionKey: InjectionKey<AvsbContextValue>;
 declare function useFlag<T>(flagKey: string | Ref<string> | ComputedRef<string>, defaultValue: T): ComputedRef<Flag<T>>;
 
 /**
- * §5.16 — Convenience shortcut that returns the flag's raw value `T`
+ * §5.16: Convenience shortcut that returns the flag's raw value `T`
  * instead of the full `Flag<T>` object.
  *
  * Use `useFlag()` when you need `variationKey`, `source`, `reasons`, or
@@ -130,7 +130,7 @@ declare function useFlag<T>(flagKey: string | Ref<string> | ComputedRef<string>,
 declare function useFlagValue<T>(flagKey: string | Ref<string> | ComputedRef<string>, defaultValue: T): ComputedRef<T>;
 
 /**
- * §5.16 — Typed boolean flag composable.
+ * §5.16: Typed boolean flag composable.
  *
  * Calls `client.getBoolFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -141,7 +141,7 @@ declare function useFlagValue<T>(flagKey: string | Ref<string> | ComputedRef<str
 declare function useBoolFlag(flagKey: string, defaultValue: boolean): ComputedRef<Flag<boolean>>;
 
 /**
- * §5.16 — Typed string flag composable.
+ * §5.16: Typed string flag composable.
  *
  * Calls `client.getStringFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -152,7 +152,7 @@ declare function useBoolFlag(flagKey: string, defaultValue: boolean): ComputedRe
 declare function useStringFlag(flagKey: string, defaultValue: string): ComputedRef<Flag<string>>;
 
 /**
- * §5.16 — Typed number flag composable.
+ * §5.16: Typed number flag composable.
  *
  * Calls `client.getNumberFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -163,7 +163,7 @@ declare function useStringFlag(flagKey: string, defaultValue: string): ComputedR
 declare function useNumberFlag(flagKey: string, defaultValue: number): ComputedRef<Flag<number>>;
 
 /**
- * §5.16 — Typed JSON flag composable.
+ * §5.16: Typed JSON flag composable.
  *
  * Calls `client.getJsonFlag` under the hood, which performs a runtime
  * type check against the datafile's declared flag type and logs a warning
@@ -174,7 +174,7 @@ declare function useNumberFlag(flagKey: string, defaultValue: number): ComputedR
 declare function useJsonFlag<T>(flagKey: string, defaultValue: T): ComputedRef<Flag<T>>;
 
 /**
- * §5.16 — Returns `ComputedRef<Record<string, Flag>>` containing all
+ * §5.16: Returns `ComputedRef<Record<string, Flag>>` containing all
  * evaluated flags.
  *
  * Subscribes to the global `'flagChange'` event bus rather than per-flag
@@ -187,7 +187,7 @@ declare function useJsonFlag<T>(flagKey: string, defaultValue: T): ComputedRef<F
 declare function useAllFlags(): ComputedRef<Record<string, Flag>>;
 
 /**
- * §5.15 — Returns `ComputedRef<boolean>` that is `true` once the
+ * §5.15: Returns `ComputedRef<boolean>` that is `true` once the
  * Provider's client is ready.
  *
  * Simple boolean alternative to reading status directly for components
@@ -198,7 +198,7 @@ declare function useFlagReady(): ComputedRef<boolean>;
 /**
  * Returns the underlying `AvsbClient` instance (or `null` while loading).
  *
- * The type is `VueAvsbClient` — the interface declaring the surface this
+ * The type is `VueAvsbClient`, the interface declaring the surface this
  * package uses. Once @avsbhq/browser ships the full reshape, `AvsbClient`
  * satisfies this interface structurally.
  *
@@ -209,7 +209,7 @@ declare function useFlagReady(): ComputedRef<boolean>;
 declare function useAvsbClient(): VueAvsbClient | null;
 
 /**
- * §5.16 — Returns a stable `identify` function.
+ * §5.16: Returns a stable `identify` function.
  *
  * Calling `identify(ctx)` replaces the client's current evaluation context.
  * All subsequent flag evaluations and exposure events use the new context.
@@ -220,7 +220,7 @@ declare function useAvsbClient(): VueAvsbClient | null;
 declare function useIdentify(): (ctx: EvalContext) => void;
 
 /**
- * §5.16 — Returns a stable `alias` function.
+ * §5.16: Returns a stable `alias` function.
  *
  * Calling `alias(prev, next)` records that two contexts represent the
  * same user identity (e.g. anonymous visitor → identified user after
@@ -231,7 +231,7 @@ declare function useIdentify(): (ctx: EvalContext) => void;
 declare function useAlias(): (prev: EvalContext, next: EvalContext) => Promise<void>;
 
 /**
- * §5.16 — Returns a stable `track` function that survives the
+ * §5.16: Returns a stable `track` function that survives the
  * loading → ready transition without changing its reference.
  *
  * The function delegates to `client.track()` via a ref so that callers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avsbhq/vue",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -27,8 +27,8 @@
     "pinia": { "optional": true }
   },
   "dependencies": {
-    "@avsbhq/core": "1.0.0",
-    "@avsbhq/browser": "1.0.0"
+    "@avsbhq/core": "1.4.0",
+    "@avsbhq/browser": "1.3.0"
   },
   "scripts": {
     "build": "tsup",