Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/vue/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
106 changes: 106 additions & 0 deletions packages/vue/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# @tryabby/vue

Vue 3 (and Nuxt) integration for [Abby](https://tryabby.com) - A/B Testing & Feature Flags.

## Installation

```bash
npm install @tryabby/vue vue
# or
pnpm add @tryabby/vue vue
```

## Setup

Define your Abby configuration:

```typescript
// abby.ts
import { createAbby } from "@tryabby/vue";

export const {
useAbby,
useFeatureFlag,
useRemoteConfig,
getFeatureFlagValue,
getRemoteConfig,
getABTestValue,
AbbyProvider,
AbbyPlugin,
} = createAbby({
projectId: "YOUR_PROJECT_ID",
currentEnvironment: process.env.NODE_ENV === "production" ? "production" : "development",
tests: {
heroTest: {
variants: ["headlineA", "headlineB"],
},
},
flags: ["newDashboard"],
remoteConfig: {
bannerText: "String",
},
});
```

## Usage

### A/B Testing (`useAbby`)

```vue
<script setup lang="ts">
import { useAbby } from "./abby";

const { variant, onAct } = useAbby("heroTest");

const handleClick = () => {
onAct();
};
</script>

<template>
<div>
<h1 v-if="variant === 'headlineA'">Welcome to Version A!</h1>
<h1 v-else>Welcome to Version B!</h1>
<button @click="handleClick">Call to Action</button>
</div>
</template>
```

With lookup objects:

```typescript
const { variant } = useAbby("heroTest", {
headlineA: "Super Header A",
headlineB: "Super Header B",
});
// variant.value is typed as string ("Super Header A" | "Super Header B")
```

### Feature Flags (`useFeatureFlag`)

```vue
<script setup lang="ts">
import { useFeatureFlag } from "./abby";

const isNewDashboard = useFeatureFlag("newDashboard");
</script>

<template>
<NewDashboard v-if="isNewDashboard" />
<OldDashboard v-else />
</template>
```

### Remote Config (`useRemoteConfig`)

```vue
<script setup lang="ts">
import { useRemoteConfig } from "./abby";

const banner = useRemoteConfig("bannerText");
</script>

<template>
<p>{{ banner }}</p>
</template>
```
54 changes: 54 additions & 0 deletions packages/vue/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"name": "@tryabby/vue",
"version": "7.0.1",
"description": "Vue 3 integration for Abby - A/B Testing & Feature Flags",
"main": "dist/index.js",
"files": ["dist"],
"module": "dist/index.mjs",
"types": "dist/index.d.ts",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.js"
}
},
"scripts": {
"build": "tsup src/",
"dev": "pnpm run build --watch",
"test": "vitest"
},
"homepage": "https://docs.tryabby.com",
"keywords": [
"vue",
"vue3",
"nuxt",
"ab-testing",
"feature-flags",
"tryabby",
"remote-config"
],
"author": "",
"license": "ISC",
"devDependencies": {
"@tryabby/devtools": "workspace:*",
"@types/js-cookie": "^3.0.3",
"@vue/test-utils": "^2.4.6",
"jsdom": "^20.0.3",
"msw": "^0.49.1",
"node-fetch": "^3.3.0",
"tsconfig": "workspace:*",
"tsup": "^6.5.0",
"typescript": "5.5.4",
"vite": "5.4.0",
"vitest": "2.0.5",
"vue": "^3.4.38"
},
"peerDependencies": {
"vue": "^3.3.0 || ^3.4.0 || ^3.5.0"
},
"dependencies": {
"@tryabby/core": "workspace:*",
"js-cookie": "^3.0.1"
}
}
76 changes: 76 additions & 0 deletions packages/vue/src/StorageService.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
import {
type IStorageService,
type StorageServiceOptions,
getABStorageKey,
getFFStorageKey,
getRCStorageKey,
} from "@tryabby/core";
import Cookie from "js-cookie";

const DEFAULT_COOKIE_AGE = 365;

class ABStorageService implements IStorageService {
get(projectId: string, testName: string): string | null {
const retrievedValue = Cookie.get(getABStorageKey(projectId, testName));
if (!retrievedValue) return null;

return retrievedValue;
}

set(
projectId: string,
testName: string,
value: string,
options?: StorageServiceOptions
): void {
Cookie.set(getABStorageKey(projectId, testName), value, {
expires: options?.expiresInDays
? options.expiresInDays
: DEFAULT_COOKIE_AGE,
});
}

remove(projectId: string, testName: string): void {
Cookie.remove(getABStorageKey(projectId, testName));
}
}

class FFStorageService implements IStorageService {
get(projectId: string, flagName: string): string | null {
const retrievedValue = Cookie.get(getFFStorageKey(projectId, flagName));
if (!retrievedValue) return null;

return retrievedValue;
}

set(projectId: string, flagName: string, value: string): void {
Cookie.set(getFFStorageKey(projectId, flagName), value, {
expires: DEFAULT_COOKIE_AGE,
});
}

remove(projectId: string, flagName: string): void {
Cookie.remove(getFFStorageKey(projectId, flagName));
}
}

class RCStorageService implements IStorageService {
get(projectId: string, key: string): string | null {
const retrievedValue = Cookie.get(getRCStorageKey(projectId, key));
return retrievedValue ?? null;
}

set(projectId: string, key: string, value: string): void {
Cookie.set(getRCStorageKey(projectId, key), value, {
expires: DEFAULT_COOKIE_AGE,
});
}

remove(projectId: string, key: string): void {
Cookie.remove(getRCStorageKey(projectId, key));
}
}

export const TestStorageService = new ABStorageService();
export const FlagStorageService = new FFStorageService();
export const RemoteConfigStorageService = new RCStorageService();
Loading