@ops-ai/toggly-fastify 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/dist/index.cjs +7 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +6 -2
- package/dist/index.d.ts +6 -2
- package/dist/index.js +7 -1
- package/dist/index.js.map +1 -1
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -8,6 +8,20 @@ Toggly feature flags Fastify plugin
|
|
|
8
8
|
npm install @ops-ai/toggly-fastify
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
## Compatibility
|
|
12
|
+
|
|
13
|
+
The adapter retains its `fastify` peer range of `^4.0.0 || ^5.0.0` and its
|
|
14
|
+
Node.js package floor of 18. Fastify 4.29.1 is tested with Node 18.20.8.
|
|
15
|
+
Fastify 5 requires Node 20 or newer; Fastify 5.12.4 is tested with Node
|
|
16
|
+
20.19.6. Use a Fastify-5-compatible Node runtime even though the adapter
|
|
17
|
+
itself can run on Node 18.
|
|
18
|
+
|
|
19
|
+
The compatibility harness packs the release artifact, resolves its core
|
|
20
|
+
dependency from npm, type-checks its public declarations, exercises ESM and
|
|
21
|
+
CommonJS exports, and starts real HTTP listeners. To provide exact Node
|
|
22
|
+
binaries in a local matrix, set `TOGGLY_FASTIFY_NODE18` and
|
|
23
|
+
`TOGGLY_FASTIFY_NODE20` before `pnpm test:hosts`.
|
|
24
|
+
|
|
11
25
|
## Documentation
|
|
12
26
|
|
|
13
27
|
- [docs.toggly.io](https://docs.toggly.io)
|
package/dist/index.cjs
CHANGED
|
@@ -114,7 +114,13 @@ var togglyPluginAsync = async (fastify, config) => {
|
|
|
114
114
|
context,
|
|
115
115
|
isFeatureOn: (featureKey) => fastifyClient.isFeatureOn(featureKey, context),
|
|
116
116
|
isFeatureOff: (featureKey) => fastifyClient.isFeatureOff(featureKey, context),
|
|
117
|
-
evaluateFeatureGate: (featureKeys, requirement, negate) => fastifyClient.evaluateFeatureGate(featureKeys, requirement, negate, context)
|
|
117
|
+
evaluateFeatureGate: (featureKeys, requirement, negate) => fastifyClient.evaluateFeatureGate(featureKeys, requirement, negate, context),
|
|
118
|
+
async getVariant(featureKey) {
|
|
119
|
+
return fastifyClient.getVariant(featureKey, context);
|
|
120
|
+
},
|
|
121
|
+
async getVariantValue(featureKey) {
|
|
122
|
+
return fastifyClient.getVariantValue(featureKey, context);
|
|
123
|
+
}
|
|
118
124
|
};
|
|
119
125
|
});
|
|
120
126
|
fastify.addHook("onClose", async () => {
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/plugin.ts"],"sourcesContent":["// Plugin\nexport {\n togglyPlugin,\n featureGate,\n featureRoutes,\n withFeature,\n featuresHandler,\n getFastifyToggly,\n closeFastifyToggly,\n} from './plugin.js'\n\n// Types\nexport type {\n TogglyFastifyConfig,\n TogglyRequestData,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Re-export core types for convenience\nexport type {\n TogglyClient,\n TogglyConfig,\n TogglyServerConfig,\n TogglyState,\n FeatureDefinitions,\n FeatureRequirement,\n EvaluationContext,\n Hook,\n HookMetadata,\n} from '@ops-ai/toggly-node-core'\n\n// Re-export core utilities\nexport {\n createTogglyClient,\n initToggly,\n getToggly,\n useToggly,\n closeToggly,\n createLoggingHook,\n createMemoryCache,\n createFileCache,\n} from '@ops-ai/toggly-node-core'\n","import type {\n FastifyInstance,\n FastifyRequest,\n FastifyReply,\n FastifyPluginAsync,\n} from 'fastify'\n\n// Custom type for preHandler hooks (simpler than Fastify's complex generic type)\ntype PreHandlerHook = (\n request: FastifyRequest,\n reply: FastifyReply\n) => Promise<unknown>\nimport fp from 'fastify-plugin'\nimport {\n createTogglyClient,\n normalizeFeatureKeys,\n fromHttpRequest,\n type TogglyClient,\n type EvaluationContext,\n} from '@ops-ai/toggly-node-core'\nimport type {\n TogglyFastifyConfig,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Module-level client singleton\nlet fastifyClient: TogglyClient | null = null\n\n/**\n * Get the Fastify Toggly client\n */\nexport function getFastifyToggly(): TogglyClient | null {\n return fastifyClient\n}\n\n/**\n * Get identity from request\n */\nasync function extractIdentity(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<string | undefined> {\n // Use custom extractor if provided\n if (config.getIdentity) {\n return config.getIdentity(request)\n }\n\n // Default: check header\n const headerIdentity = request.headers['x-toggly-identity']\n if (typeof headerIdentity === 'string') {\n return headerIdentity\n }\n\n return undefined\n}\n\n/**\n * Get evaluation context from request\n */\nasync function extractContext(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<EvaluationContext> {\n const headers = request.headers as Record<string, string | string[] | undefined>\n const headerRequest = fromHttpRequest(headers).request\n\n // Custom full context: use returned fields, fill missing request from headers\n if (config.getContext) {\n const custom = await config.getContext(request)\n return {\n ...custom,\n // Field-level merge: custom wins; missing keys filled from headers\n request: {\n ...headerRequest,\n ...custom.request,\n },\n }\n }\n\n // Default: identity / groups / claims providers + segment request headers\n const identity = await extractIdentity(request, config)\n const groups = config.getGroups ? await config.getGroups(request) : undefined\n const claims = config.getClaims ? await config.getClaims(request) : undefined\n const fromReq = fromHttpRequest(headers, { identity, groups, claims })\n\n return {\n identity: fromReq.identity,\n groups: fromReq.groups,\n claims: fromReq.claims,\n request: fromReq.request,\n traits: {\n ip: request.ip,\n userAgent: request.headers['user-agent'],\n path: request.url,\n method: request.method,\n },\n }\n}\n\n/**\n * Toggly Fastify plugin\n *\n * This plugin:\n * 1. Initializes the Toggly client\n * 2. Attaches feature flag helpers to the request object\n * 3. Extracts identity and context from the request\n */\nconst togglyPluginAsync: FastifyPluginAsync<TogglyFastifyConfig> = async (\n fastify: FastifyInstance,\n config: TogglyFastifyConfig\n) => {\n // Initialize client\n if (!fastifyClient) {\n fastifyClient = createTogglyClient(config)\n await fastifyClient.init()\n }\n\n // Add hook to attach toggly to request\n fastify.addHook('preHandler', async (request: FastifyRequest) => {\n if (!fastifyClient) {\n throw new Error('Toggly client not initialized')\n }\n\n // Extract context from request\n const context = await extractContext(request, config)\n const identity = context.identity\n\n // Attach Toggly helpers to request\n request.toggly = {\n client: fastifyClient,\n features: fastifyClient.state.features,\n identity,\n context,\n isFeatureOn: (featureKey: string) => fastifyClient!.isFeatureOn(featureKey, context),\n isFeatureOff: (featureKey: string) => fastifyClient!.isFeatureOff(featureKey, context),\n evaluateFeatureGate: (featureKeys, requirement, negate) =>\n fastifyClient!.evaluateFeatureGate(featureKeys, requirement, negate, context),\n }\n })\n\n // Close client when fastify closes\n fastify.addHook('onClose', async () => {\n closeFastifyToggly()\n })\n}\n\n/**\n * Toggly Fastify plugin with proper encapsulation\n */\nexport const togglyPlugin = fp(togglyPluginAsync, {\n name: '@ops-ai/toggly-fastify',\n fastify: '>=4.0.0',\n})\n\n/**\n * Create a feature gate preHandler hook\n *\n * Protects routes by checking if specified features are enabled\n */\nexport function featureGate(options: FeatureGateOptions): PreHandlerHook {\n const {\n featureKey,\n requirement = 'all',\n negate = false,\n onDisabled,\n redirectTo,\n redirectStatus = 302,\n } = options\n\n const featureKeys = normalizeFeatureKeys(featureKey)\n\n return async (request: FastifyRequest, reply: FastifyReply) => {\n if (!request.toggly) {\n throw new Error('Toggly plugin must be registered before using featureGate')\n }\n\n const isEnabled = await request.toggly.evaluateFeatureGate(featureKeys, requirement, negate)\n\n if (isEnabled) {\n return // Continue to handler\n }\n\n // Feature is disabled\n if (redirectTo) {\n return reply.redirect(redirectTo, redirectStatus)\n }\n\n if (onDisabled) {\n await onDisabled(request)\n return\n }\n\n // Default: 404\n return reply.status(404).send({\n error: 'Not Found',\n message: 'The requested resource is not available',\n })\n }\n}\n\n/**\n * Create preHandler that applies feature gates based on route patterns\n */\nexport function featureRoutes(routes: FeatureRouteOptions[]): PreHandlerHook {\n return async (request: FastifyRequest, reply: FastifyReply) => {\n for (const route of routes) {\n // Check if route matches\n const pathMatches =\n typeof route.path === 'string'\n ? request.url === route.path || request.url.startsWith(route.path)\n : route.path.test(request.url)\n\n if (!pathMatches) {\n continue\n }\n\n // Check if method matches\n if (route.methods && !route.methods.includes(request.method.toUpperCase())) {\n continue\n }\n\n // Apply feature gate\n const gate = featureGate(route)\n return gate(request, reply)\n }\n\n // No matching route, continue\n return\n }\n}\n\n/**\n * Create a decorated route handler that checks features\n */\nexport function withFeature(\n featureKey: string | string[],\n options: Omit<FeatureGateOptions, 'featureKey'> = {}\n): PreHandlerHook {\n return featureGate({ featureKey, ...options })\n}\n\n/**\n * Get features route handler\n */\nexport async function featuresHandler(\n request: FastifyRequest,\n reply: FastifyReply\n): Promise<void> {\n if (!request.toggly) {\n return reply.status(500).send({\n error: 'Internal Server Error',\n message: 'Toggly plugin not configured',\n })\n }\n\n return reply.send({\n features: request.toggly.features,\n identity: request.toggly.identity,\n })\n}\n\n/**\n * Close the Fastify Toggly client\n */\nexport function closeFastifyToggly(): void {\n if (fastifyClient) {\n fastifyClient.close()\n fastifyClient = null\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACYA,4BAAe;AACf,8BAMO;AAQP,IAAI,gBAAqC;AAKlC,SAAS,mBAAwC;AACtD,SAAO;AACT;AAKA,eAAe,gBACb,SACA,QAC6B;AAE7B,MAAI,OAAO,aAAa;AACtB,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAGA,QAAM,iBAAiB,QAAQ,QAAQ,mBAAmB;AAC1D,MAAI,OAAO,mBAAmB,UAAU;AACtC,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAKA,eAAe,eACb,SACA,QAC4B;AAC5B,QAAM,UAAU,QAAQ;AACxB,QAAM,oBAAgB,yCAAgB,OAAO,EAAE;AAG/C,MAAI,OAAO,YAAY;AACrB,UAAM,SAAS,MAAM,OAAO,WAAW,OAAO;AAC9C,WAAO;AAAA,MACL,GAAG;AAAA;AAAA,MAEH,SAAS;AAAA,QACP,GAAG;AAAA,QACH,GAAG,OAAO;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAGA,QAAM,WAAW,MAAM,gBAAgB,SAAS,MAAM;AACtD,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,cAAU,yCAAgB,SAAS,EAAE,UAAU,QAAQ,OAAO,CAAC;AAErE,SAAO;AAAA,IACL,UAAU,QAAQ;AAAA,IAClB,QAAQ,QAAQ;AAAA,IAChB,QAAQ,QAAQ;AAAA,IAChB,SAAS,QAAQ;AAAA,IACjB,QAAQ;AAAA,MACN,IAAI,QAAQ;AAAA,MACZ,WAAW,QAAQ,QAAQ,YAAY;AAAA,MACvC,MAAM,QAAQ;AAAA,MACd,QAAQ,QAAQ;AAAA,IAClB;AAAA,EACF;AACF;AAUA,IAAM,oBAA6D,OACjE,SACA,WACG;AAEH,MAAI,CAAC,eAAe;AAClB,wBAAgB,4CAAmB,MAAM;AACzC,UAAM,cAAc,KAAK;AAAA,EAC3B;AAGA,UAAQ,QAAQ,cAAc,OAAO,YAA4B;AAC/D,QAAI,CAAC,eAAe;AAClB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AAGA,UAAM,UAAU,MAAM,eAAe,SAAS,MAAM;AACpD,UAAM,WAAW,QAAQ;AAGzB,YAAQ,SAAS;AAAA,MACf,QAAQ;AAAA,MACR,UAAU,cAAc,MAAM;AAAA,MAC9B;AAAA,MACA;AAAA,MACA,aAAa,CAAC,eAAuB,cAAe,YAAY,YAAY,OAAO;AAAA,MACnF,cAAc,CAAC,eAAuB,cAAe,aAAa,YAAY,OAAO;AAAA,MACrF,qBAAqB,CAAC,aAAa,aAAa,WAC9C,cAAe,oBAAoB,aAAa,aAAa,QAAQ,OAAO;AAAA,IAChF;AAAA,EACF,CAAC;AAGD,UAAQ,QAAQ,WAAW,YAAY;AACrC,uBAAmB;AAAA,EACrB,CAAC;AACH;AAKO,IAAM,mBAAe,sBAAAA,SAAG,mBAAmB;AAAA,EAChD,MAAM;AAAA,EACN,SAAS;AACX,CAAC;AAOM,SAAS,YAAY,SAA6C;AACvE,QAAM;AAAA,IACJ;AAAA,IACA,cAAc;AAAA,IACd,SAAS;AAAA,IACT;AAAA,IACA;AAAA,IACA,iBAAiB;AAAA,EACnB,IAAI;AAEJ,QAAM,kBAAc,8CAAqB,UAAU;AAEnD,SAAO,OAAO,SAAyB,UAAwB;AAC7D,QAAI,CAAC,QAAQ,QAAQ;AACnB,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,UAAM,YAAY,MAAM,QAAQ,OAAO,oBAAoB,aAAa,aAAa,MAAM;AAE3F,QAAI,WAAW;AACb;AAAA,IACF;AAGA,QAAI,YAAY;AACd,aAAO,MAAM,SAAS,YAAY,cAAc;AAAA,IAClD;AAEA,QAAI,YAAY;AACd,YAAM,WAAW,OAAO;AACxB;AAAA,IACF;AAGA,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AACF;AAKO,SAAS,cAAc,QAA+C;AAC3E,SAAO,OAAO,SAAyB,UAAwB;AAC7D,eAAW,SAAS,QAAQ;AAE1B,YAAM,cACJ,OAAO,MAAM,SAAS,WAClB,QAAQ,QAAQ,MAAM,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,IAC/D,MAAM,KAAK,KAAK,QAAQ,GAAG;AAEjC,UAAI,CAAC,aAAa;AAChB;AAAA,MACF;AAGA,UAAI,MAAM,WAAW,CAAC,MAAM,QAAQ,SAAS,QAAQ,OAAO,YAAY,CAAC,GAAG;AAC1E;AAAA,MACF;AAGA,YAAM,OAAO,YAAY,KAAK;AAC9B,aAAO,KAAK,SAAS,KAAK;AAAA,IAC5B;AAGA;AAAA,EACF;AACF;AAKO,SAAS,YACd,YACA,UAAkD,CAAC,GACnC;AAChB,SAAO,YAAY,EAAE,YAAY,GAAG,QAAQ,CAAC;AAC/C;AAKA,eAAsB,gBACpB,SACA,OACe;AACf,MAAI,CAAC,QAAQ,QAAQ;AACnB,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAEA,SAAO,MAAM,KAAK;AAAA,IAChB,UAAU,QAAQ,OAAO;AAAA,IACzB,UAAU,QAAQ,OAAO;AAAA,EAC3B,CAAC;AACH;AAKO,SAAS,qBAA2B;AACzC,MAAI,eAAe;AACjB,kBAAc,MAAM;AACpB,oBAAgB;AAAA,EAClB;AACF;;;AD7OA,IAAAC,2BASO;","names":["fp","import_toggly_node_core"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/plugin.ts"],"sourcesContent":["// Plugin\nexport {\n togglyPlugin,\n featureGate,\n featureRoutes,\n withFeature,\n featuresHandler,\n getFastifyToggly,\n closeFastifyToggly,\n} from './plugin.js'\n\n// Types\nexport type {\n TogglyFastifyConfig,\n TogglyRequestData,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Re-export core types for convenience\nexport type {\n TogglyClient,\n TogglyConfig,\n TogglyServerConfig,\n TogglyState,\n FeatureDefinitions,\n FeatureRequirement,\n EvaluationContext,\n Hook,\n HookMetadata,\n VariantResult,\n} from '@ops-ai/toggly-node-core'\n\n// Re-export core utilities\nexport {\n createTogglyClient,\n initToggly,\n getToggly,\n useToggly,\n closeToggly,\n createLoggingHook,\n createMemoryCache,\n createFileCache,\n} from '@ops-ai/toggly-node-core'\n","import type {\n FastifyInstance,\n FastifyRequest,\n FastifyReply,\n FastifyPluginAsync,\n} from 'fastify'\n\n// Custom type for preHandler hooks (simpler than Fastify's complex generic type)\ntype PreHandlerHook = (\n request: FastifyRequest,\n reply: FastifyReply\n) => Promise<unknown>\nimport fp from 'fastify-plugin'\nimport {\n createTogglyClient,\n normalizeFeatureKeys,\n fromHttpRequest,\n type TogglyClient,\n type EvaluationContext,\n} from '@ops-ai/toggly-node-core'\nimport type {\n TogglyFastifyConfig,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Module-level client singleton\nlet fastifyClient: TogglyClient | null = null\n\n/**\n * Get the Fastify Toggly client\n */\nexport function getFastifyToggly(): TogglyClient | null {\n return fastifyClient\n}\n\n/**\n * Get identity from request\n */\nasync function extractIdentity(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<string | undefined> {\n // Use custom extractor if provided\n if (config.getIdentity) {\n return config.getIdentity(request)\n }\n\n // Default: check header\n const headerIdentity = request.headers['x-toggly-identity']\n if (typeof headerIdentity === 'string') {\n return headerIdentity\n }\n\n return undefined\n}\n\n/**\n * Get evaluation context from request\n */\nasync function extractContext(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<EvaluationContext> {\n const headers = request.headers as Record<string, string | string[] | undefined>\n const headerRequest = fromHttpRequest(headers).request\n\n // Custom full context: use returned fields, fill missing request from headers\n if (config.getContext) {\n const custom = await config.getContext(request)\n return {\n ...custom,\n // Field-level merge: custom wins; missing keys filled from headers\n request: {\n ...headerRequest,\n ...custom.request,\n },\n }\n }\n\n // Default: identity / groups / claims providers + segment request headers\n const identity = await extractIdentity(request, config)\n const groups = config.getGroups ? await config.getGroups(request) : undefined\n const claims = config.getClaims ? await config.getClaims(request) : undefined\n const fromReq = fromHttpRequest(headers, { identity, groups, claims })\n\n return {\n identity: fromReq.identity,\n groups: fromReq.groups,\n claims: fromReq.claims,\n request: fromReq.request,\n traits: {\n ip: request.ip,\n userAgent: request.headers['user-agent'],\n path: request.url,\n method: request.method,\n },\n }\n}\n\n/**\n * Toggly Fastify plugin\n *\n * This plugin:\n * 1. Initializes the Toggly client\n * 2. Attaches feature flag helpers to the request object\n * 3. Extracts identity and context from the request\n */\nconst togglyPluginAsync: FastifyPluginAsync<TogglyFastifyConfig> = async (\n fastify: FastifyInstance,\n config: TogglyFastifyConfig\n) => {\n // Initialize client\n if (!fastifyClient) {\n fastifyClient = createTogglyClient(config)\n await fastifyClient.init()\n }\n\n // Add hook to attach toggly to request\n fastify.addHook('preHandler', async (request: FastifyRequest) => {\n if (!fastifyClient) {\n throw new Error('Toggly client not initialized')\n }\n\n // Extract context from request\n const context = await extractContext(request, config)\n const identity = context.identity\n\n // Attach Toggly helpers to request\n request.toggly = {\n client: fastifyClient,\n features: fastifyClient.state.features,\n identity,\n context,\n isFeatureOn: (featureKey: string) => fastifyClient!.isFeatureOn(featureKey, context),\n isFeatureOff: (featureKey: string) => fastifyClient!.isFeatureOff(featureKey, context),\n evaluateFeatureGate: (featureKeys, requirement, negate) =>\n fastifyClient!.evaluateFeatureGate(featureKeys, requirement, negate, context),\n async getVariant(featureKey: string) {\n return fastifyClient!.getVariant(featureKey, context)\n },\n async getVariantValue(featureKey: string) {\n return fastifyClient!.getVariantValue(featureKey, context)\n },\n }\n })\n\n // Close client when fastify closes\n fastify.addHook('onClose', async () => {\n closeFastifyToggly()\n })\n}\n\n/**\n * Toggly Fastify plugin with proper encapsulation\n */\nexport const togglyPlugin = fp(togglyPluginAsync, {\n name: '@ops-ai/toggly-fastify',\n fastify: '>=4.0.0',\n})\n\n/**\n * Create a feature gate preHandler hook\n *\n * Protects routes by checking if specified features are enabled\n */\nexport function featureGate(options: FeatureGateOptions): PreHandlerHook {\n const {\n featureKey,\n requirement = 'all',\n negate = false,\n onDisabled,\n redirectTo,\n redirectStatus = 302,\n } = options\n\n const featureKeys = normalizeFeatureKeys(featureKey)\n\n return async (request: FastifyRequest, reply: FastifyReply) => {\n if (!request.toggly) {\n throw new Error('Toggly plugin must be registered before using featureGate')\n }\n\n const isEnabled = await request.toggly.evaluateFeatureGate(featureKeys, requirement, negate)\n\n if (isEnabled) {\n return // Continue to handler\n }\n\n // Feature is disabled\n if (redirectTo) {\n return reply.redirect(redirectTo, redirectStatus)\n }\n\n if (onDisabled) {\n await onDisabled(request)\n return\n }\n\n // Default: 404\n return reply.status(404).send({\n error: 'Not Found',\n message: 'The requested resource is not available',\n })\n }\n}\n\n/**\n * Create preHandler that applies feature gates based on route patterns\n */\nexport function featureRoutes(routes: FeatureRouteOptions[]): PreHandlerHook {\n return async (request: FastifyRequest, reply: FastifyReply) => {\n for (const route of routes) {\n // Check if route matches\n const pathMatches =\n typeof route.path === 'string'\n ? request.url === route.path || request.url.startsWith(route.path)\n : route.path.test(request.url)\n\n if (!pathMatches) {\n continue\n }\n\n // Check if method matches\n if (route.methods && !route.methods.includes(request.method.toUpperCase())) {\n continue\n }\n\n // Apply feature gate\n const gate = featureGate(route)\n return gate(request, reply)\n }\n\n // No matching route, continue\n return\n }\n}\n\n/**\n * Create a decorated route handler that checks features\n */\nexport function withFeature(\n featureKey: string | string[],\n options: Omit<FeatureGateOptions, 'featureKey'> = {}\n): PreHandlerHook {\n return featureGate({ featureKey, ...options })\n}\n\n/**\n * Get features route handler\n */\nexport async function featuresHandler(\n request: FastifyRequest,\n reply: FastifyReply\n): Promise<void> {\n if (!request.toggly) {\n return reply.status(500).send({\n error: 'Internal Server Error',\n message: 'Toggly plugin not configured',\n })\n }\n\n return reply.send({\n features: request.toggly.features,\n identity: request.toggly.identity,\n })\n}\n\n/**\n * Close the Fastify Toggly client\n */\nexport function closeFastifyToggly(): void {\n if (fastifyClient) {\n fastifyClient.close()\n fastifyClient = null\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACYA,4BAAe;AACf,8BAMO;AAQP,IAAI,gBAAqC;AAKlC,SAAS,mBAAwC;AACtD,SAAO;AACT;AAKA,eAAe,gBACb,SACA,QAC6B;AAE7B,MAAI,OAAO,aAAa;AACtB,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAGA,QAAM,iBAAiB,QAAQ,QAAQ,mBAAmB;AAC1D,MAAI,OAAO,mBAAmB,UAAU;AACtC,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAKA,eAAe,eACb,SACA,QAC4B;AAC5B,QAAM,UAAU,QAAQ;AACxB,QAAM,oBAAgB,yCAAgB,OAAO,EAAE;AAG/C,MAAI,OAAO,YAAY;AACrB,UAAM,SAAS,MAAM,OAAO,WAAW,OAAO;AAC9C,WAAO;AAAA,MACL,GAAG;AAAA;AAAA,MAEH,SAAS;AAAA,QACP,GAAG;AAAA,QACH,GAAG,OAAO;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAGA,QAAM,WAAW,MAAM,gBAAgB,SAAS,MAAM;AACtD,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,cAAU,yCAAgB,SAAS,EAAE,UAAU,QAAQ,OAAO,CAAC;AAErE,SAAO;AAAA,IACL,UAAU,QAAQ;AAAA,IAClB,QAAQ,QAAQ;AAAA,IAChB,QAAQ,QAAQ;AAAA,IAChB,SAAS,QAAQ;AAAA,IACjB,QAAQ;AAAA,MACN,IAAI,QAAQ;AAAA,MACZ,WAAW,QAAQ,QAAQ,YAAY;AAAA,MACvC,MAAM,QAAQ;AAAA,MACd,QAAQ,QAAQ;AAAA,IAClB;AAAA,EACF;AACF;AAUA,IAAM,oBAA6D,OACjE,SACA,WACG;AAEH,MAAI,CAAC,eAAe;AAClB,wBAAgB,4CAAmB,MAAM;AACzC,UAAM,cAAc,KAAK;AAAA,EAC3B;AAGA,UAAQ,QAAQ,cAAc,OAAO,YAA4B;AAC/D,QAAI,CAAC,eAAe;AAClB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AAGA,UAAM,UAAU,MAAM,eAAe,SAAS,MAAM;AACpD,UAAM,WAAW,QAAQ;AAGzB,YAAQ,SAAS;AAAA,MACf,QAAQ;AAAA,MACR,UAAU,cAAc,MAAM;AAAA,MAC9B;AAAA,MACA;AAAA,MACA,aAAa,CAAC,eAAuB,cAAe,YAAY,YAAY,OAAO;AAAA,MACnF,cAAc,CAAC,eAAuB,cAAe,aAAa,YAAY,OAAO;AAAA,MACrF,qBAAqB,CAAC,aAAa,aAAa,WAC9C,cAAe,oBAAoB,aAAa,aAAa,QAAQ,OAAO;AAAA,MAC9E,MAAM,WAAW,YAAoB;AACnC,eAAO,cAAe,WAAW,YAAY,OAAO;AAAA,MACtD;AAAA,MACA,MAAM,gBAAgB,YAAoB;AACxC,eAAO,cAAe,gBAAgB,YAAY,OAAO;AAAA,MAC3D;AAAA,IACF;AAAA,EACF,CAAC;AAGD,UAAQ,QAAQ,WAAW,YAAY;AACrC,uBAAmB;AAAA,EACrB,CAAC;AACH;AAKO,IAAM,mBAAe,sBAAAA,SAAG,mBAAmB;AAAA,EAChD,MAAM;AAAA,EACN,SAAS;AACX,CAAC;AAOM,SAAS,YAAY,SAA6C;AACvE,QAAM;AAAA,IACJ;AAAA,IACA,cAAc;AAAA,IACd,SAAS;AAAA,IACT;AAAA,IACA;AAAA,IACA,iBAAiB;AAAA,EACnB,IAAI;AAEJ,QAAM,kBAAc,8CAAqB,UAAU;AAEnD,SAAO,OAAO,SAAyB,UAAwB;AAC7D,QAAI,CAAC,QAAQ,QAAQ;AACnB,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,UAAM,YAAY,MAAM,QAAQ,OAAO,oBAAoB,aAAa,aAAa,MAAM;AAE3F,QAAI,WAAW;AACb;AAAA,IACF;AAGA,QAAI,YAAY;AACd,aAAO,MAAM,SAAS,YAAY,cAAc;AAAA,IAClD;AAEA,QAAI,YAAY;AACd,YAAM,WAAW,OAAO;AACxB;AAAA,IACF;AAGA,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AACF;AAKO,SAAS,cAAc,QAA+C;AAC3E,SAAO,OAAO,SAAyB,UAAwB;AAC7D,eAAW,SAAS,QAAQ;AAE1B,YAAM,cACJ,OAAO,MAAM,SAAS,WAClB,QAAQ,QAAQ,MAAM,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,IAC/D,MAAM,KAAK,KAAK,QAAQ,GAAG;AAEjC,UAAI,CAAC,aAAa;AAChB;AAAA,MACF;AAGA,UAAI,MAAM,WAAW,CAAC,MAAM,QAAQ,SAAS,QAAQ,OAAO,YAAY,CAAC,GAAG;AAC1E;AAAA,MACF;AAGA,YAAM,OAAO,YAAY,KAAK;AAC9B,aAAO,KAAK,SAAS,KAAK;AAAA,IAC5B;AAGA;AAAA,EACF;AACF;AAKO,SAAS,YACd,YACA,UAAkD,CAAC,GACnC;AAChB,SAAO,YAAY,EAAE,YAAY,GAAG,QAAQ,CAAC;AAC/C;AAKA,eAAsB,gBACpB,SACA,OACe;AACf,MAAI,CAAC,QAAQ,QAAQ;AACnB,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAEA,SAAO,MAAM,KAAK;AAAA,IAChB,UAAU,QAAQ,OAAO;AAAA,IACzB,UAAU,QAAQ,OAAO;AAAA,EAC3B,CAAC;AACH;AAKO,SAAS,qBAA2B;AACzC,MAAI,eAAe;AACjB,kBAAc,MAAM;AACpB,oBAAgB;AAAA,EAClB;AACF;;;ADlPA,IAAAC,2BASO;","names":["fp","import_toggly_node_core"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FastifyRequest, FastifyReply, FastifyPluginAsync } from 'fastify';
|
|
2
|
-
import { TogglyClient, FeatureDefinitions, EvaluationContext, FeatureRequirement, TogglyServerConfig } from '@ops-ai/toggly-node-core';
|
|
3
|
-
export { EvaluationContext, FeatureDefinitions, FeatureRequirement, Hook, HookMetadata, TogglyClient, TogglyConfig, TogglyServerConfig, TogglyState, closeToggly, createFileCache, createLoggingHook, createMemoryCache, createTogglyClient, getToggly, initToggly, useToggly } from '@ops-ai/toggly-node-core';
|
|
2
|
+
import { TogglyClient, FeatureDefinitions, EvaluationContext, FeatureRequirement, VariantResult, TogglyServerConfig } from '@ops-ai/toggly-node-core';
|
|
3
|
+
export { EvaluationContext, FeatureDefinitions, FeatureRequirement, Hook, HookMetadata, TogglyClient, TogglyConfig, TogglyServerConfig, TogglyState, VariantResult, closeToggly, createFileCache, createLoggingHook, createMemoryCache, createTogglyClient, getToggly, initToggly, useToggly } from '@ops-ai/toggly-node-core';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* Fastify-specific configuration
|
|
@@ -37,6 +37,10 @@ interface TogglyRequestData {
|
|
|
37
37
|
isFeatureOn: (featureKey: string) => Promise<boolean>;
|
|
38
38
|
isFeatureOff: (featureKey: string) => Promise<boolean>;
|
|
39
39
|
evaluateFeatureGate: (featureKeys: string[], requirement?: FeatureRequirement, negate?: boolean) => Promise<boolean>;
|
|
40
|
+
/** Fastify: catalog-local variant via the request-scoped EvaluationContext. */
|
|
41
|
+
getVariant(featureKey: string): Promise<VariantResult | null>;
|
|
42
|
+
/** Fastify: assigned variant configurationValue, or null. */
|
|
43
|
+
getVariantValue(featureKey: string): Promise<unknown>;
|
|
40
44
|
}
|
|
41
45
|
/**
|
|
42
46
|
* Feature gate options for protecting routes
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FastifyRequest, FastifyReply, FastifyPluginAsync } from 'fastify';
|
|
2
|
-
import { TogglyClient, FeatureDefinitions, EvaluationContext, FeatureRequirement, TogglyServerConfig } from '@ops-ai/toggly-node-core';
|
|
3
|
-
export { EvaluationContext, FeatureDefinitions, FeatureRequirement, Hook, HookMetadata, TogglyClient, TogglyConfig, TogglyServerConfig, TogglyState, closeToggly, createFileCache, createLoggingHook, createMemoryCache, createTogglyClient, getToggly, initToggly, useToggly } from '@ops-ai/toggly-node-core';
|
|
2
|
+
import { TogglyClient, FeatureDefinitions, EvaluationContext, FeatureRequirement, VariantResult, TogglyServerConfig } from '@ops-ai/toggly-node-core';
|
|
3
|
+
export { EvaluationContext, FeatureDefinitions, FeatureRequirement, Hook, HookMetadata, TogglyClient, TogglyConfig, TogglyServerConfig, TogglyState, VariantResult, closeToggly, createFileCache, createLoggingHook, createMemoryCache, createTogglyClient, getToggly, initToggly, useToggly } from '@ops-ai/toggly-node-core';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* Fastify-specific configuration
|
|
@@ -37,6 +37,10 @@ interface TogglyRequestData {
|
|
|
37
37
|
isFeatureOn: (featureKey: string) => Promise<boolean>;
|
|
38
38
|
isFeatureOff: (featureKey: string) => Promise<boolean>;
|
|
39
39
|
evaluateFeatureGate: (featureKeys: string[], requirement?: FeatureRequirement, negate?: boolean) => Promise<boolean>;
|
|
40
|
+
/** Fastify: catalog-local variant via the request-scoped EvaluationContext. */
|
|
41
|
+
getVariant(featureKey: string): Promise<VariantResult | null>;
|
|
42
|
+
/** Fastify: assigned variant configurationValue, or null. */
|
|
43
|
+
getVariantValue(featureKey: string): Promise<unknown>;
|
|
40
44
|
}
|
|
41
45
|
/**
|
|
42
46
|
* Feature gate options for protecting routes
|
package/dist/index.js
CHANGED
|
@@ -68,7 +68,13 @@ var togglyPluginAsync = async (fastify, config) => {
|
|
|
68
68
|
context,
|
|
69
69
|
isFeatureOn: (featureKey) => fastifyClient.isFeatureOn(featureKey, context),
|
|
70
70
|
isFeatureOff: (featureKey) => fastifyClient.isFeatureOff(featureKey, context),
|
|
71
|
-
evaluateFeatureGate: (featureKeys, requirement, negate) => fastifyClient.evaluateFeatureGate(featureKeys, requirement, negate, context)
|
|
71
|
+
evaluateFeatureGate: (featureKeys, requirement, negate) => fastifyClient.evaluateFeatureGate(featureKeys, requirement, negate, context),
|
|
72
|
+
async getVariant(featureKey) {
|
|
73
|
+
return fastifyClient.getVariant(featureKey, context);
|
|
74
|
+
},
|
|
75
|
+
async getVariantValue(featureKey) {
|
|
76
|
+
return fastifyClient.getVariantValue(featureKey, context);
|
|
77
|
+
}
|
|
72
78
|
};
|
|
73
79
|
});
|
|
74
80
|
fastify.addHook("onClose", async () => {
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/plugin.ts","../src/index.ts"],"sourcesContent":["import type {\n FastifyInstance,\n FastifyRequest,\n FastifyReply,\n FastifyPluginAsync,\n} from 'fastify'\n\n// Custom type for preHandler hooks (simpler than Fastify's complex generic type)\ntype PreHandlerHook = (\n request: FastifyRequest,\n reply: FastifyReply\n) => Promise<unknown>\nimport fp from 'fastify-plugin'\nimport {\n createTogglyClient,\n normalizeFeatureKeys,\n fromHttpRequest,\n type TogglyClient,\n type EvaluationContext,\n} from '@ops-ai/toggly-node-core'\nimport type {\n TogglyFastifyConfig,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Module-level client singleton\nlet fastifyClient: TogglyClient | null = null\n\n/**\n * Get the Fastify Toggly client\n */\nexport function getFastifyToggly(): TogglyClient | null {\n return fastifyClient\n}\n\n/**\n * Get identity from request\n */\nasync function extractIdentity(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<string | undefined> {\n // Use custom extractor if provided\n if (config.getIdentity) {\n return config.getIdentity(request)\n }\n\n // Default: check header\n const headerIdentity = request.headers['x-toggly-identity']\n if (typeof headerIdentity === 'string') {\n return headerIdentity\n }\n\n return undefined\n}\n\n/**\n * Get evaluation context from request\n */\nasync function extractContext(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<EvaluationContext> {\n const headers = request.headers as Record<string, string | string[] | undefined>\n const headerRequest = fromHttpRequest(headers).request\n\n // Custom full context: use returned fields, fill missing request from headers\n if (config.getContext) {\n const custom = await config.getContext(request)\n return {\n ...custom,\n // Field-level merge: custom wins; missing keys filled from headers\n request: {\n ...headerRequest,\n ...custom.request,\n },\n }\n }\n\n // Default: identity / groups / claims providers + segment request headers\n const identity = await extractIdentity(request, config)\n const groups = config.getGroups ? await config.getGroups(request) : undefined\n const claims = config.getClaims ? await config.getClaims(request) : undefined\n const fromReq = fromHttpRequest(headers, { identity, groups, claims })\n\n return {\n identity: fromReq.identity,\n groups: fromReq.groups,\n claims: fromReq.claims,\n request: fromReq.request,\n traits: {\n ip: request.ip,\n userAgent: request.headers['user-agent'],\n path: request.url,\n method: request.method,\n },\n }\n}\n\n/**\n * Toggly Fastify plugin\n *\n * This plugin:\n * 1. Initializes the Toggly client\n * 2. Attaches feature flag helpers to the request object\n * 3. Extracts identity and context from the request\n */\nconst togglyPluginAsync: FastifyPluginAsync<TogglyFastifyConfig> = async (\n fastify: FastifyInstance,\n config: TogglyFastifyConfig\n) => {\n // Initialize client\n if (!fastifyClient) {\n fastifyClient = createTogglyClient(config)\n await fastifyClient.init()\n }\n\n // Add hook to attach toggly to request\n fastify.addHook('preHandler', async (request: FastifyRequest) => {\n if (!fastifyClient) {\n throw new Error('Toggly client not initialized')\n }\n\n // Extract context from request\n const context = await extractContext(request, config)\n const identity = context.identity\n\n // Attach Toggly helpers to request\n request.toggly = {\n client: fastifyClient,\n features: fastifyClient.state.features,\n identity,\n context,\n isFeatureOn: (featureKey: string) => fastifyClient!.isFeatureOn(featureKey, context),\n isFeatureOff: (featureKey: string) => fastifyClient!.isFeatureOff(featureKey, context),\n evaluateFeatureGate: (featureKeys, requirement, negate) =>\n fastifyClient!.evaluateFeatureGate(featureKeys, requirement, negate, context),\n }\n })\n\n // Close client when fastify closes\n fastify.addHook('onClose', async () => {\n closeFastifyToggly()\n })\n}\n\n/**\n * Toggly Fastify plugin with proper encapsulation\n */\nexport const togglyPlugin = fp(togglyPluginAsync, {\n name: '@ops-ai/toggly-fastify',\n fastify: '>=4.0.0',\n})\n\n/**\n * Create a feature gate preHandler hook\n *\n * Protects routes by checking if specified features are enabled\n */\nexport function featureGate(options: FeatureGateOptions): PreHandlerHook {\n const {\n featureKey,\n requirement = 'all',\n negate = false,\n onDisabled,\n redirectTo,\n redirectStatus = 302,\n } = options\n\n const featureKeys = normalizeFeatureKeys(featureKey)\n\n return async (request: FastifyRequest, reply: FastifyReply) => {\n if (!request.toggly) {\n throw new Error('Toggly plugin must be registered before using featureGate')\n }\n\n const isEnabled = await request.toggly.evaluateFeatureGate(featureKeys, requirement, negate)\n\n if (isEnabled) {\n return // Continue to handler\n }\n\n // Feature is disabled\n if (redirectTo) {\n return reply.redirect(redirectTo, redirectStatus)\n }\n\n if (onDisabled) {\n await onDisabled(request)\n return\n }\n\n // Default: 404\n return reply.status(404).send({\n error: 'Not Found',\n message: 'The requested resource is not available',\n })\n }\n}\n\n/**\n * Create preHandler that applies feature gates based on route patterns\n */\nexport function featureRoutes(routes: FeatureRouteOptions[]): PreHandlerHook {\n return async (request: FastifyRequest, reply: FastifyReply) => {\n for (const route of routes) {\n // Check if route matches\n const pathMatches =\n typeof route.path === 'string'\n ? request.url === route.path || request.url.startsWith(route.path)\n : route.path.test(request.url)\n\n if (!pathMatches) {\n continue\n }\n\n // Check if method matches\n if (route.methods && !route.methods.includes(request.method.toUpperCase())) {\n continue\n }\n\n // Apply feature gate\n const gate = featureGate(route)\n return gate(request, reply)\n }\n\n // No matching route, continue\n return\n }\n}\n\n/**\n * Create a decorated route handler that checks features\n */\nexport function withFeature(\n featureKey: string | string[],\n options: Omit<FeatureGateOptions, 'featureKey'> = {}\n): PreHandlerHook {\n return featureGate({ featureKey, ...options })\n}\n\n/**\n * Get features route handler\n */\nexport async function featuresHandler(\n request: FastifyRequest,\n reply: FastifyReply\n): Promise<void> {\n if (!request.toggly) {\n return reply.status(500).send({\n error: 'Internal Server Error',\n message: 'Toggly plugin not configured',\n })\n }\n\n return reply.send({\n features: request.toggly.features,\n identity: request.toggly.identity,\n })\n}\n\n/**\n * Close the Fastify Toggly client\n */\nexport function closeFastifyToggly(): void {\n if (fastifyClient) {\n fastifyClient.close()\n fastifyClient = null\n }\n}\n","// Plugin\nexport {\n togglyPlugin,\n featureGate,\n featureRoutes,\n withFeature,\n featuresHandler,\n getFastifyToggly,\n closeFastifyToggly,\n} from './plugin.js'\n\n// Types\nexport type {\n TogglyFastifyConfig,\n TogglyRequestData,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Re-export core types for convenience\nexport type {\n TogglyClient,\n TogglyConfig,\n TogglyServerConfig,\n TogglyState,\n FeatureDefinitions,\n FeatureRequirement,\n EvaluationContext,\n Hook,\n HookMetadata,\n} from '@ops-ai/toggly-node-core'\n\n// Re-export core utilities\nexport {\n createTogglyClient,\n initToggly,\n getToggly,\n useToggly,\n closeToggly,\n createLoggingHook,\n createMemoryCache,\n createFileCache,\n} from '@ops-ai/toggly-node-core'\n"],"mappings":";AAYA,OAAO,QAAQ;AACf;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAQP,IAAI,gBAAqC;AAKlC,SAAS,mBAAwC;AACtD,SAAO;AACT;AAKA,eAAe,gBACb,SACA,QAC6B;AAE7B,MAAI,OAAO,aAAa;AACtB,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAGA,QAAM,iBAAiB,QAAQ,QAAQ,mBAAmB;AAC1D,MAAI,OAAO,mBAAmB,UAAU;AACtC,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAKA,eAAe,eACb,SACA,QAC4B;AAC5B,QAAM,UAAU,QAAQ;AACxB,QAAM,gBAAgB,gBAAgB,OAAO,EAAE;AAG/C,MAAI,OAAO,YAAY;AACrB,UAAM,SAAS,MAAM,OAAO,WAAW,OAAO;AAC9C,WAAO;AAAA,MACL,GAAG;AAAA;AAAA,MAEH,SAAS;AAAA,QACP,GAAG;AAAA,QACH,GAAG,OAAO;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAGA,QAAM,WAAW,MAAM,gBAAgB,SAAS,MAAM;AACtD,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,UAAU,gBAAgB,SAAS,EAAE,UAAU,QAAQ,OAAO,CAAC;AAErE,SAAO;AAAA,IACL,UAAU,QAAQ;AAAA,IAClB,QAAQ,QAAQ;AAAA,IAChB,QAAQ,QAAQ;AAAA,IAChB,SAAS,QAAQ;AAAA,IACjB,QAAQ;AAAA,MACN,IAAI,QAAQ;AAAA,MACZ,WAAW,QAAQ,QAAQ,YAAY;AAAA,MACvC,MAAM,QAAQ;AAAA,MACd,QAAQ,QAAQ;AAAA,IAClB;AAAA,EACF;AACF;AAUA,IAAM,oBAA6D,OACjE,SACA,WACG;AAEH,MAAI,CAAC,eAAe;AAClB,oBAAgB,mBAAmB,MAAM;AACzC,UAAM,cAAc,KAAK;AAAA,EAC3B;AAGA,UAAQ,QAAQ,cAAc,OAAO,YAA4B;AAC/D,QAAI,CAAC,eAAe;AAClB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AAGA,UAAM,UAAU,MAAM,eAAe,SAAS,MAAM;AACpD,UAAM,WAAW,QAAQ;AAGzB,YAAQ,SAAS;AAAA,MACf,QAAQ;AAAA,MACR,UAAU,cAAc,MAAM;AAAA,MAC9B;AAAA,MACA;AAAA,MACA,aAAa,CAAC,eAAuB,cAAe,YAAY,YAAY,OAAO;AAAA,MACnF,cAAc,CAAC,eAAuB,cAAe,aAAa,YAAY,OAAO;AAAA,MACrF,qBAAqB,CAAC,aAAa,aAAa,WAC9C,cAAe,oBAAoB,aAAa,aAAa,QAAQ,OAAO;AAAA,IAChF;AAAA,EACF,CAAC;AAGD,UAAQ,QAAQ,WAAW,YAAY;AACrC,uBAAmB;AAAA,EACrB,CAAC;AACH;AAKO,IAAM,eAAe,GAAG,mBAAmB;AAAA,EAChD,MAAM;AAAA,EACN,SAAS;AACX,CAAC;AAOM,SAAS,YAAY,SAA6C;AACvE,QAAM;AAAA,IACJ;AAAA,IACA,cAAc;AAAA,IACd,SAAS;AAAA,IACT;AAAA,IACA;AAAA,IACA,iBAAiB;AAAA,EACnB,IAAI;AAEJ,QAAM,cAAc,qBAAqB,UAAU;AAEnD,SAAO,OAAO,SAAyB,UAAwB;AAC7D,QAAI,CAAC,QAAQ,QAAQ;AACnB,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,UAAM,YAAY,MAAM,QAAQ,OAAO,oBAAoB,aAAa,aAAa,MAAM;AAE3F,QAAI,WAAW;AACb;AAAA,IACF;AAGA,QAAI,YAAY;AACd,aAAO,MAAM,SAAS,YAAY,cAAc;AAAA,IAClD;AAEA,QAAI,YAAY;AACd,YAAM,WAAW,OAAO;AACxB;AAAA,IACF;AAGA,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AACF;AAKO,SAAS,cAAc,QAA+C;AAC3E,SAAO,OAAO,SAAyB,UAAwB;AAC7D,eAAW,SAAS,QAAQ;AAE1B,YAAM,cACJ,OAAO,MAAM,SAAS,WAClB,QAAQ,QAAQ,MAAM,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,IAC/D,MAAM,KAAK,KAAK,QAAQ,GAAG;AAEjC,UAAI,CAAC,aAAa;AAChB;AAAA,MACF;AAGA,UAAI,MAAM,WAAW,CAAC,MAAM,QAAQ,SAAS,QAAQ,OAAO,YAAY,CAAC,GAAG;AAC1E;AAAA,MACF;AAGA,YAAM,OAAO,YAAY,KAAK;AAC9B,aAAO,KAAK,SAAS,KAAK;AAAA,IAC5B;AAGA;AAAA,EACF;AACF;AAKO,SAAS,YACd,YACA,UAAkD,CAAC,GACnC;AAChB,SAAO,YAAY,EAAE,YAAY,GAAG,QAAQ,CAAC;AAC/C;AAKA,eAAsB,gBACpB,SACA,OACe;AACf,MAAI,CAAC,QAAQ,QAAQ;AACnB,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAEA,SAAO,MAAM,KAAK;AAAA,IAChB,UAAU,QAAQ,OAAO;AAAA,IACzB,UAAU,QAAQ,OAAO;AAAA,EAC3B,CAAC;AACH;AAKO,SAAS,qBAA2B;AACzC,MAAI,eAAe;AACjB,kBAAc,MAAM;AACpB,oBAAgB;AAAA,EAClB;AACF;;;AC7OA;AAAA,EACE,sBAAAA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":["createTogglyClient"]}
|
|
1
|
+
{"version":3,"sources":["../src/plugin.ts","../src/index.ts"],"sourcesContent":["import type {\n FastifyInstance,\n FastifyRequest,\n FastifyReply,\n FastifyPluginAsync,\n} from 'fastify'\n\n// Custom type for preHandler hooks (simpler than Fastify's complex generic type)\ntype PreHandlerHook = (\n request: FastifyRequest,\n reply: FastifyReply\n) => Promise<unknown>\nimport fp from 'fastify-plugin'\nimport {\n createTogglyClient,\n normalizeFeatureKeys,\n fromHttpRequest,\n type TogglyClient,\n type EvaluationContext,\n} from '@ops-ai/toggly-node-core'\nimport type {\n TogglyFastifyConfig,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Module-level client singleton\nlet fastifyClient: TogglyClient | null = null\n\n/**\n * Get the Fastify Toggly client\n */\nexport function getFastifyToggly(): TogglyClient | null {\n return fastifyClient\n}\n\n/**\n * Get identity from request\n */\nasync function extractIdentity(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<string | undefined> {\n // Use custom extractor if provided\n if (config.getIdentity) {\n return config.getIdentity(request)\n }\n\n // Default: check header\n const headerIdentity = request.headers['x-toggly-identity']\n if (typeof headerIdentity === 'string') {\n return headerIdentity\n }\n\n return undefined\n}\n\n/**\n * Get evaluation context from request\n */\nasync function extractContext(\n request: FastifyRequest,\n config: TogglyFastifyConfig\n): Promise<EvaluationContext> {\n const headers = request.headers as Record<string, string | string[] | undefined>\n const headerRequest = fromHttpRequest(headers).request\n\n // Custom full context: use returned fields, fill missing request from headers\n if (config.getContext) {\n const custom = await config.getContext(request)\n return {\n ...custom,\n // Field-level merge: custom wins; missing keys filled from headers\n request: {\n ...headerRequest,\n ...custom.request,\n },\n }\n }\n\n // Default: identity / groups / claims providers + segment request headers\n const identity = await extractIdentity(request, config)\n const groups = config.getGroups ? await config.getGroups(request) : undefined\n const claims = config.getClaims ? await config.getClaims(request) : undefined\n const fromReq = fromHttpRequest(headers, { identity, groups, claims })\n\n return {\n identity: fromReq.identity,\n groups: fromReq.groups,\n claims: fromReq.claims,\n request: fromReq.request,\n traits: {\n ip: request.ip,\n userAgent: request.headers['user-agent'],\n path: request.url,\n method: request.method,\n },\n }\n}\n\n/**\n * Toggly Fastify plugin\n *\n * This plugin:\n * 1. Initializes the Toggly client\n * 2. Attaches feature flag helpers to the request object\n * 3. Extracts identity and context from the request\n */\nconst togglyPluginAsync: FastifyPluginAsync<TogglyFastifyConfig> = async (\n fastify: FastifyInstance,\n config: TogglyFastifyConfig\n) => {\n // Initialize client\n if (!fastifyClient) {\n fastifyClient = createTogglyClient(config)\n await fastifyClient.init()\n }\n\n // Add hook to attach toggly to request\n fastify.addHook('preHandler', async (request: FastifyRequest) => {\n if (!fastifyClient) {\n throw new Error('Toggly client not initialized')\n }\n\n // Extract context from request\n const context = await extractContext(request, config)\n const identity = context.identity\n\n // Attach Toggly helpers to request\n request.toggly = {\n client: fastifyClient,\n features: fastifyClient.state.features,\n identity,\n context,\n isFeatureOn: (featureKey: string) => fastifyClient!.isFeatureOn(featureKey, context),\n isFeatureOff: (featureKey: string) => fastifyClient!.isFeatureOff(featureKey, context),\n evaluateFeatureGate: (featureKeys, requirement, negate) =>\n fastifyClient!.evaluateFeatureGate(featureKeys, requirement, negate, context),\n async getVariant(featureKey: string) {\n return fastifyClient!.getVariant(featureKey, context)\n },\n async getVariantValue(featureKey: string) {\n return fastifyClient!.getVariantValue(featureKey, context)\n },\n }\n })\n\n // Close client when fastify closes\n fastify.addHook('onClose', async () => {\n closeFastifyToggly()\n })\n}\n\n/**\n * Toggly Fastify plugin with proper encapsulation\n */\nexport const togglyPlugin = fp(togglyPluginAsync, {\n name: '@ops-ai/toggly-fastify',\n fastify: '>=4.0.0',\n})\n\n/**\n * Create a feature gate preHandler hook\n *\n * Protects routes by checking if specified features are enabled\n */\nexport function featureGate(options: FeatureGateOptions): PreHandlerHook {\n const {\n featureKey,\n requirement = 'all',\n negate = false,\n onDisabled,\n redirectTo,\n redirectStatus = 302,\n } = options\n\n const featureKeys = normalizeFeatureKeys(featureKey)\n\n return async (request: FastifyRequest, reply: FastifyReply) => {\n if (!request.toggly) {\n throw new Error('Toggly plugin must be registered before using featureGate')\n }\n\n const isEnabled = await request.toggly.evaluateFeatureGate(featureKeys, requirement, negate)\n\n if (isEnabled) {\n return // Continue to handler\n }\n\n // Feature is disabled\n if (redirectTo) {\n return reply.redirect(redirectTo, redirectStatus)\n }\n\n if (onDisabled) {\n await onDisabled(request)\n return\n }\n\n // Default: 404\n return reply.status(404).send({\n error: 'Not Found',\n message: 'The requested resource is not available',\n })\n }\n}\n\n/**\n * Create preHandler that applies feature gates based on route patterns\n */\nexport function featureRoutes(routes: FeatureRouteOptions[]): PreHandlerHook {\n return async (request: FastifyRequest, reply: FastifyReply) => {\n for (const route of routes) {\n // Check if route matches\n const pathMatches =\n typeof route.path === 'string'\n ? request.url === route.path || request.url.startsWith(route.path)\n : route.path.test(request.url)\n\n if (!pathMatches) {\n continue\n }\n\n // Check if method matches\n if (route.methods && !route.methods.includes(request.method.toUpperCase())) {\n continue\n }\n\n // Apply feature gate\n const gate = featureGate(route)\n return gate(request, reply)\n }\n\n // No matching route, continue\n return\n }\n}\n\n/**\n * Create a decorated route handler that checks features\n */\nexport function withFeature(\n featureKey: string | string[],\n options: Omit<FeatureGateOptions, 'featureKey'> = {}\n): PreHandlerHook {\n return featureGate({ featureKey, ...options })\n}\n\n/**\n * Get features route handler\n */\nexport async function featuresHandler(\n request: FastifyRequest,\n reply: FastifyReply\n): Promise<void> {\n if (!request.toggly) {\n return reply.status(500).send({\n error: 'Internal Server Error',\n message: 'Toggly plugin not configured',\n })\n }\n\n return reply.send({\n features: request.toggly.features,\n identity: request.toggly.identity,\n })\n}\n\n/**\n * Close the Fastify Toggly client\n */\nexport function closeFastifyToggly(): void {\n if (fastifyClient) {\n fastifyClient.close()\n fastifyClient = null\n }\n}\n","// Plugin\nexport {\n togglyPlugin,\n featureGate,\n featureRoutes,\n withFeature,\n featuresHandler,\n getFastifyToggly,\n closeFastifyToggly,\n} from './plugin.js'\n\n// Types\nexport type {\n TogglyFastifyConfig,\n TogglyRequestData,\n FeatureGateOptions,\n FeatureRouteOptions,\n} from './types.js'\n\n// Re-export core types for convenience\nexport type {\n TogglyClient,\n TogglyConfig,\n TogglyServerConfig,\n TogglyState,\n FeatureDefinitions,\n FeatureRequirement,\n EvaluationContext,\n Hook,\n HookMetadata,\n VariantResult,\n} from '@ops-ai/toggly-node-core'\n\n// Re-export core utilities\nexport {\n createTogglyClient,\n initToggly,\n getToggly,\n useToggly,\n closeToggly,\n createLoggingHook,\n createMemoryCache,\n createFileCache,\n} from '@ops-ai/toggly-node-core'\n"],"mappings":";AAYA,OAAO,QAAQ;AACf;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAQP,IAAI,gBAAqC;AAKlC,SAAS,mBAAwC;AACtD,SAAO;AACT;AAKA,eAAe,gBACb,SACA,QAC6B;AAE7B,MAAI,OAAO,aAAa;AACtB,WAAO,OAAO,YAAY,OAAO;AAAA,EACnC;AAGA,QAAM,iBAAiB,QAAQ,QAAQ,mBAAmB;AAC1D,MAAI,OAAO,mBAAmB,UAAU;AACtC,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAKA,eAAe,eACb,SACA,QAC4B;AAC5B,QAAM,UAAU,QAAQ;AACxB,QAAM,gBAAgB,gBAAgB,OAAO,EAAE;AAG/C,MAAI,OAAO,YAAY;AACrB,UAAM,SAAS,MAAM,OAAO,WAAW,OAAO;AAC9C,WAAO;AAAA,MACL,GAAG;AAAA;AAAA,MAEH,SAAS;AAAA,QACP,GAAG;AAAA,QACH,GAAG,OAAO;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAGA,QAAM,WAAW,MAAM,gBAAgB,SAAS,MAAM;AACtD,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,SAAS,OAAO,YAAY,MAAM,OAAO,UAAU,OAAO,IAAI;AACpE,QAAM,UAAU,gBAAgB,SAAS,EAAE,UAAU,QAAQ,OAAO,CAAC;AAErE,SAAO;AAAA,IACL,UAAU,QAAQ;AAAA,IAClB,QAAQ,QAAQ;AAAA,IAChB,QAAQ,QAAQ;AAAA,IAChB,SAAS,QAAQ;AAAA,IACjB,QAAQ;AAAA,MACN,IAAI,QAAQ;AAAA,MACZ,WAAW,QAAQ,QAAQ,YAAY;AAAA,MACvC,MAAM,QAAQ;AAAA,MACd,QAAQ,QAAQ;AAAA,IAClB;AAAA,EACF;AACF;AAUA,IAAM,oBAA6D,OACjE,SACA,WACG;AAEH,MAAI,CAAC,eAAe;AAClB,oBAAgB,mBAAmB,MAAM;AACzC,UAAM,cAAc,KAAK;AAAA,EAC3B;AAGA,UAAQ,QAAQ,cAAc,OAAO,YAA4B;AAC/D,QAAI,CAAC,eAAe;AAClB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AAGA,UAAM,UAAU,MAAM,eAAe,SAAS,MAAM;AACpD,UAAM,WAAW,QAAQ;AAGzB,YAAQ,SAAS;AAAA,MACf,QAAQ;AAAA,MACR,UAAU,cAAc,MAAM;AAAA,MAC9B;AAAA,MACA;AAAA,MACA,aAAa,CAAC,eAAuB,cAAe,YAAY,YAAY,OAAO;AAAA,MACnF,cAAc,CAAC,eAAuB,cAAe,aAAa,YAAY,OAAO;AAAA,MACrF,qBAAqB,CAAC,aAAa,aAAa,WAC9C,cAAe,oBAAoB,aAAa,aAAa,QAAQ,OAAO;AAAA,MAC9E,MAAM,WAAW,YAAoB;AACnC,eAAO,cAAe,WAAW,YAAY,OAAO;AAAA,MACtD;AAAA,MACA,MAAM,gBAAgB,YAAoB;AACxC,eAAO,cAAe,gBAAgB,YAAY,OAAO;AAAA,MAC3D;AAAA,IACF;AAAA,EACF,CAAC;AAGD,UAAQ,QAAQ,WAAW,YAAY;AACrC,uBAAmB;AAAA,EACrB,CAAC;AACH;AAKO,IAAM,eAAe,GAAG,mBAAmB;AAAA,EAChD,MAAM;AAAA,EACN,SAAS;AACX,CAAC;AAOM,SAAS,YAAY,SAA6C;AACvE,QAAM;AAAA,IACJ;AAAA,IACA,cAAc;AAAA,IACd,SAAS;AAAA,IACT;AAAA,IACA;AAAA,IACA,iBAAiB;AAAA,EACnB,IAAI;AAEJ,QAAM,cAAc,qBAAqB,UAAU;AAEnD,SAAO,OAAO,SAAyB,UAAwB;AAC7D,QAAI,CAAC,QAAQ,QAAQ;AACnB,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,UAAM,YAAY,MAAM,QAAQ,OAAO,oBAAoB,aAAa,aAAa,MAAM;AAE3F,QAAI,WAAW;AACb;AAAA,IACF;AAGA,QAAI,YAAY;AACd,aAAO,MAAM,SAAS,YAAY,cAAc;AAAA,IAClD;AAEA,QAAI,YAAY;AACd,YAAM,WAAW,OAAO;AACxB;AAAA,IACF;AAGA,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AACF;AAKO,SAAS,cAAc,QAA+C;AAC3E,SAAO,OAAO,SAAyB,UAAwB;AAC7D,eAAW,SAAS,QAAQ;AAE1B,YAAM,cACJ,OAAO,MAAM,SAAS,WAClB,QAAQ,QAAQ,MAAM,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,IAC/D,MAAM,KAAK,KAAK,QAAQ,GAAG;AAEjC,UAAI,CAAC,aAAa;AAChB;AAAA,MACF;AAGA,UAAI,MAAM,WAAW,CAAC,MAAM,QAAQ,SAAS,QAAQ,OAAO,YAAY,CAAC,GAAG;AAC1E;AAAA,MACF;AAGA,YAAM,OAAO,YAAY,KAAK;AAC9B,aAAO,KAAK,SAAS,KAAK;AAAA,IAC5B;AAGA;AAAA,EACF;AACF;AAKO,SAAS,YACd,YACA,UAAkD,CAAC,GACnC;AAChB,SAAO,YAAY,EAAE,YAAY,GAAG,QAAQ,CAAC;AAC/C;AAKA,eAAsB,gBACpB,SACA,OACe;AACf,MAAI,CAAC,QAAQ,QAAQ;AACnB,WAAO,MAAM,OAAO,GAAG,EAAE,KAAK;AAAA,MAC5B,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAEA,SAAO,MAAM,KAAK;AAAA,IAChB,UAAU,QAAQ,OAAO;AAAA,IACzB,UAAU,QAAQ,OAAO;AAAA,EAC3B,CAAC;AACH;AAKO,SAAS,qBAA2B;AACzC,MAAI,eAAe;AACjB,kBAAc,MAAM;AACpB,oBAAgB;AAAA,EAClB;AACF;;;AClPA;AAAA,EACE,sBAAAA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":["createTogglyClient"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ops-ai/toggly-fastify",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Toggly feature flags Fastify plugin",
|
|
5
5
|
"main": "./dist/index.cjs",
|
|
6
6
|
"module": "./dist/index.js",
|
|
@@ -52,15 +52,18 @@
|
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
54
|
"fastify-plugin": "^5.0.1",
|
|
55
|
-
"@ops-ai/toggly-node-core": "^0.
|
|
55
|
+
"@ops-ai/toggly-node-core": "^0.11.0"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
|
+
"@eslint/js": "^9.39.2",
|
|
58
59
|
"@types/node": "^22.15.30",
|
|
59
60
|
"@vitest/coverage-v8": "^3.2.4",
|
|
60
61
|
"eslint": "^9.28.0",
|
|
61
62
|
"fastify": "^5.4.0",
|
|
63
|
+
"globals": "^15.15.0",
|
|
62
64
|
"tsup": "^8.5.0",
|
|
63
65
|
"typescript": "^5.8.3",
|
|
66
|
+
"typescript-eslint": "^8.70.0",
|
|
64
67
|
"vitest": "^3.2.4"
|
|
65
68
|
},
|
|
66
69
|
"publishConfig": {
|
|
@@ -70,6 +73,7 @@
|
|
|
70
73
|
"build": "tsup",
|
|
71
74
|
"dev": "tsup --watch",
|
|
72
75
|
"test": "vitest run",
|
|
76
|
+
"test:hosts": "node tests/packed-hosts.mjs",
|
|
73
77
|
"test:watch": "vitest",
|
|
74
78
|
"test:coverage": "vitest run --coverage",
|
|
75
79
|
"lint": "eslint src tests",
|