Merge pull request #4 from xtr-dev/dev

Bump version to 0.0.6
This commit is contained in:
Bas
2025-09-28 22:14:53 +02:00
committed by GitHub
2 changed files with 38 additions and 37 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "@xtr-dev/payload-feature-flags",
"version": "0.0.5",
"version": "0.0.6",
"description": "Feature flags plugin for Payload CMS - manage feature toggles, A/B tests, and gradual rollouts",
"license": "MIT",
"type": "module",

View File

@@ -1,4 +1,5 @@
import { Payload } from 'payload'
import { cache } from "react"
export interface FeatureFlag {
name: string
@@ -33,7 +34,7 @@ function getCollectionSlug(payload: Payload): string {
/**
* Get a specific feature flag by name (for use in React Server Components)
*/
export async function getFeatureFlag(flagName: string, payload?: Payload): Promise<FeatureFlag | null> {
export const getFeatureFlag = cache(async (flagName: string, payload?: Payload): Promise<FeatureFlag | null> => {
try {
// If no payload provided, return null as these hooks should be used within Payload context
if (!payload) {
@@ -70,20 +71,20 @@ export async function getFeatureFlag(flagName: string, payload?: Payload): Promi
console.error(`Failed to fetch feature flag ${flagName}:`, error)
return null
}
}
})
/**
* Check if a feature flag is enabled (for use in React Server Components)
*/
export async function isFeatureEnabled(flagName: string, payload?: Payload): Promise<boolean> {
export const isFeatureEnabled = cache(async (flagName: string, payload?: Payload): Promise<boolean> => {
const flag = await getFeatureFlag(flagName, payload)
return flag?.enabled ?? false
}
})
/**
* Get all active feature flags (for use in React Server Components)
*/
export async function getAllFeatureFlags(payload?: Payload): Promise<Record<string, FeatureFlag>> {
export const getAllFeatureFlags = cache(async (payload?: Payload): Promise<Record<string, FeatureFlag>> => {
try {
// If no payload provided, return empty object as these hooks should be used within Payload context
if (!payload) {
@@ -120,16 +121,16 @@ export async function getAllFeatureFlags(payload?: Payload): Promise<Record<stri
console.error('Failed to fetch feature flags:', error)
return {}
}
}
})
/**
* Check if a user is in a feature rollout (for use in React Server Components)
*/
export async function isUserInRollout(
export const isUserInRollout = cache(async (
flagName: string,
userId: string,
payload?: Payload
): Promise<boolean> {
): Promise<boolean> => {
const flag = await getFeatureFlag(flagName, payload)
if (!flag?.enabled) {
@@ -146,16 +147,16 @@ export async function isUserInRollout(
}, 0)
return (Math.abs(hash) % 100) < flag.rolloutPercentage
}
})
/**
* Get the variant for a user in an A/B test (for use in React Server Components)
*/
export async function getUserVariant(
export const getUserVariant = cache(async (
flagName: string,
userId: string,
payload?: Payload
): Promise<string | null> {
): Promise<string | null> => {
const flag = await getFeatureFlag(flagName, payload)
if (!flag?.enabled || !flag.variants || flag.variants.length === 0) {
@@ -178,12 +179,12 @@ export async function getUserVariant(
}
return flag.variants[0]?.name || null
}
})
/**
* Get feature flags by tags (for use in React Server Components)
*/
export async function getFeatureFlagsByTag(tag: string, payload?: Payload): Promise<FeatureFlag[]> {
export const getFeatureFlagsByTag = cache(async (tag: string, payload?: Payload): Promise<FeatureFlag[]> => {
try {
// If no payload provided, return empty array as these hooks should be used within Payload context
if (!payload) {
@@ -214,4 +215,4 @@ export async function getFeatureFlagsByTag(tag: string, payload?: Payload): Prom
console.error(`Failed to fetch feature flags with tag ${tag}:`, error)
return []
}
}
})