@nexusts/feature-flag 0.8.2 → 0.8.4
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/dist/index.js +2 -2
- package/dist/index.js.map +3 -3
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -60,7 +60,7 @@ class MemoryFlagBackend {
|
|
|
60
60
|
return def.rollout > 0;
|
|
61
61
|
return hashFloat(`${flagName}:${id}`) < def.rollout;
|
|
62
62
|
}
|
|
63
|
-
return def.enabled
|
|
63
|
+
return def.enabled ?? true;
|
|
64
64
|
}
|
|
65
65
|
}
|
|
66
66
|
|
|
@@ -163,5 +163,5 @@ export {
|
|
|
163
163
|
FeatureFlag
|
|
164
164
|
};
|
|
165
165
|
|
|
166
|
-
//# debugId=
|
|
166
|
+
//# debugId=507CB2EAC4BC20F464756E2164756E21
|
|
167
167
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
"sourcesContent": [
|
|
5
5
|
"/**\n * `FeatureFlagModule` — drop-in feature flags.\n *\n * @Module({\n * imports: [\n * FeatureFlagModule.forRoot({\n * flags: {\n * 'new-dashboard': { enabled: true, rollout: 0.5 },\n * 'beta-api': false,\n * },\n * }),\n * ],\n * })\n * export class AppModule {}\n */\nimport \"reflect-metadata\";\nimport { Module } from \"@nexusts/core\";\nimport { FeatureFlagService } from \"./feature-flag.service.js\";\nimport type { FeatureFlagConfig } from \"./types.js\";\n\n@Module({\n\tproviders: [\n\t\tFeatureFlagService,\n\t\t{ provide: FeatureFlagService.TOKEN, useExisting: FeatureFlagService },\n\t],\n\texports: [FeatureFlagService, FeatureFlagService.TOKEN],\n})\nexport class FeatureFlagModule {\n\tstatic forRoot(config: FeatureFlagConfig = {}) {\n\t\t@Module({\n\t\t\tproviders: [\n\t\t\t\tFeatureFlagService,\n\t\t\t\t{ provide: FeatureFlagService.TOKEN, useExisting: FeatureFlagService },\n\t\t\t\t{ provide: \"FEATURE_FLAG_CONFIG\", useValue: config },\n\t\t\t],\n\t\t\texports: [FeatureFlagService, FeatureFlagService.TOKEN],\n\t\t})\n\t\tclass ConfiguredFeatureFlagModule {}\n\t\tObject.defineProperty(ConfiguredFeatureFlagModule, \"name\", {\n\t\t\tvalue: \"ConfiguredFeatureFlagModule\",\n\t\t});\n\t\treturn ConfiguredFeatureFlagModule;\n\t}\n}\n",
|
|
6
6
|
"/**\n * `FeatureFlagService` — isEnabled / setFlag / getFlag + decorator wiring.\n *\n * const flags = new FeatureFlagService({\n * flags: {\n * 'new-ui': { enabled: true, rollout: 0.5 },\n * 'beta-api': { enabled: false },\n * },\n * });\n *\n * await flags.isEnabled('new-ui', { userId: 'u1' }); // true or false by hash\n */\nimport { Inject, Injectable } from \"@nexusts/core\";\nimport type { FlagContext, FlagDefinition, FeatureFlagBackend, FeatureFlagConfig } from \"./types.js\";\nimport { MemoryFlagBackend } from \"./backends/memory.js\";\nimport { getFlagSpecs } from \"./decorators/feature-flag.decorator.js\";\n\n@Injectable()\nexport class FeatureFlagService {\n\t/** DI token. */\n\tstatic readonly TOKEN = Symbol.for(\"nexus:FeatureFlagService\");\n\n\t#backend: FeatureFlagBackend;\n\n\tconstructor(@Inject(\"FEATURE_FLAG_CONFIG\") config: FeatureFlagConfig = {}) {\n\t\tthis.#backend = new MemoryFlagBackend(config.flags ?? {});\n\t}\n\n\t/** Returns `true` if the flag is enabled for the given context. */\n\tasync isEnabled(flagName: string, context?: FlagContext): Promise<boolean> {\n\t\treturn this.#backend.isEnabled(flagName, context);\n\t}\n\n\t/** Create or update a flag at runtime. */\n\tsetFlag(flagName: string, definition: FlagDefinition | boolean): void {\n\t\tthis.#backend.setFlag(flagName, definition);\n\t}\n\n\t/** Return the raw definition (or `undefined` if unknown). */\n\tgetFlag(flagName: string): FlagDefinition | undefined {\n\t\treturn this.#backend.getFlag(flagName);\n\t}\n\n\t/**\n\t * Wire `@FeatureFlag` decorators onto a controller or service instance.\n\t * Each decorated route handler is wrapped so it returns a 404 JSON\n\t * response when the flag is disabled.\n\t *\n\t * The DI container calls this automatically when FeatureFlagModule is\n\t * imported; you can also call it manually in tests.\n\t */\n\tapplyDecorators(target: any): void {\n\t\tconst specs = getFlagSpecs(target.constructor);\n\t\tfor (const spec of specs) {\n\t\t\tconst original = spec.original;\n\t\t\t(target as any)[spec.propertyKey] = async (c: any, ...rest: any[]) => {\n\t\t\t\tconst ctx = spec.contextFn ? spec.contextFn(c) : undefined;\n\t\t\t\tconst enabled = await this.isEnabled(spec.flagName, ctx);\n\t\t\t\tif (!enabled) {\n\t\t\t\t\tif (spec.onDisabled) return spec.onDisabled(c);\n\t\t\t\t\treturn c.json({ message: \"Feature not available\", code: \"FEATURE_DISABLED\" }, 404);\n\t\t\t\t}\n\t\t\t\treturn original.apply(target, [c, ...rest]);\n\t\t\t};\n\t\t}\n\t}\n}\n",
|
|
7
|
-
"import type { FlagContext, FlagDefinition, FeatureFlagBackend } from \"../types.js\";\n\n/** djb2 hash → deterministic 0-1 float for rollout bucketing. */\nfunction hashFloat(s: string): number {\n\tlet h = 5381;\n\tfor (let i = 0; i < s.length; i++) {\n\t\th = Math.imul(h, 33) ^ s.charCodeAt(i);\n\t}\n\treturn (h >>> 0) / 0xffffffff;\n}\n\n/** In-process feature flag backend — no external dependencies. */\nexport class MemoryFlagBackend implements FeatureFlagBackend {\n\t#flags = new Map<string, FlagDefinition>();\n\n\tconstructor(initial: Record<string, FlagDefinition | boolean> = {}) {\n\t\tfor (const [k, v] of Object.entries(initial)) {\n\t\t\tthis.#flags.set(k, typeof v === \"boolean\" ? { enabled: v } : v);\n\t\t}\n\t}\n\n\tsetFlag(flagName: string, definition: FlagDefinition | boolean): void {\n\t\tthis.#flags.set(\n\t\t\tflagName,\n\t\t\ttypeof definition === \"boolean\" ? { enabled: definition } : definition,\n\t\t);\n\t}\n\n\tgetFlag(flagName: string): FlagDefinition | undefined {\n\t\treturn this.#flags.get(flagName);\n\t}\n\n\tasync isEnabled(flagName: string, context?: FlagContext): Promise<boolean> {\n\t\tconst def = this.#flags.get(flagName);\n\t\tif (!def) return false;\n\n\t\tconst id = context?.userId ?? context?.tenantId ?? context?.key ?? \"\";\n\n\t\t// Denylist has highest priority\n\t\tif (id && def.denylist?.includes(id)) return false;\n\n\t\t// Allowlist always wins after denylist\n\t\tif (id && def.allowlist?.includes(id)) return true;\n\n\t\t// Base enabled gate\n\t\tif (def.enabled === false) return false;\n\n\t\t// Rollout: deterministic hash bucketing\n\t\tif (def.rollout !== undefined && def.rollout < 1) {\n\t\t\tif (!id) return def.rollout > 0;\n\t\t\treturn hashFloat(`${flagName}:${id}`) < def.rollout;\n\t\t}\n\n\t\treturn def.enabled
|
|
7
|
+
"import type { FlagContext, FlagDefinition, FeatureFlagBackend } from \"../types.js\";\n\n/** djb2 hash → deterministic 0-1 float for rollout bucketing. */\nfunction hashFloat(s: string): number {\n\tlet h = 5381;\n\tfor (let i = 0; i < s.length; i++) {\n\t\th = Math.imul(h, 33) ^ s.charCodeAt(i);\n\t}\n\treturn (h >>> 0) / 0xffffffff;\n}\n\n/** In-process feature flag backend — no external dependencies. */\nexport class MemoryFlagBackend implements FeatureFlagBackend {\n\t#flags = new Map<string, FlagDefinition>();\n\n\tconstructor(initial: Record<string, FlagDefinition | boolean> = {}) {\n\t\tfor (const [k, v] of Object.entries(initial)) {\n\t\t\tthis.#flags.set(k, typeof v === \"boolean\" ? { enabled: v } : v);\n\t\t}\n\t}\n\n\tsetFlag(flagName: string, definition: FlagDefinition | boolean): void {\n\t\tthis.#flags.set(\n\t\t\tflagName,\n\t\t\ttypeof definition === \"boolean\" ? { enabled: definition } : definition,\n\t\t);\n\t}\n\n\tgetFlag(flagName: string): FlagDefinition | undefined {\n\t\treturn this.#flags.get(flagName);\n\t}\n\n\tasync isEnabled(flagName: string, context?: FlagContext): Promise<boolean> {\n\t\tconst def = this.#flags.get(flagName);\n\t\tif (!def) return false;\n\n\t\tconst id = context?.userId ?? context?.tenantId ?? context?.key ?? \"\";\n\n\t\t// Denylist has highest priority\n\t\tif (id && def.denylist?.includes(id)) return false;\n\n\t\t// Allowlist always wins after denylist\n\t\tif (id && def.allowlist?.includes(id)) return true;\n\n\t\t// Base enabled gate\n\t\tif (def.enabled === false) return false;\n\n\t\t// Rollout: deterministic hash bucketing\n\t\tif (def.rollout !== undefined && def.rollout < 1) {\n\t\t\tif (!id) return def.rollout > 0;\n\t\t\treturn hashFloat(`${flagName}:${id}`) < def.rollout;\n\t\t}\n\n\t\treturn def.enabled ?? true;\n\t}\n}\n",
|
|
8
8
|
"import \"reflect-metadata\";\nimport type { FlagContext } from \"../types.js\";\n\nconst FLAG_META = Symbol.for(\"nexus:FeatureFlag\");\n\nexport interface FeatureFlagOptions {\n\t/** Extract a `FlagContext` from the Hono `Context` object (first arg of the handler). */\n\tcontextFn?: (c: any) => FlagContext;\n\t/** Custom response when the flag is disabled. Defaults to 404 JSON. */\n\tonDisabled?: (c: any) => Response | Promise<Response>;\n}\n\nexport interface FlagSpec {\n\tpropertyKey: string | symbol;\n\tflagName: string;\n\tcontextFn?: (c: any) => FlagContext;\n\tonDisabled?: (c: any) => Response | Promise<Response>;\n\toriginal: (...args: any[]) => any;\n}\n\n/**\n * Mark a route handler so `FeatureFlagService.applyDecorators()` will gate it.\n *\n * @Get('/')\n * @FeatureFlag('new-dashboard')\n * async index(c: Context) { ... }\n *\n * When the flag is disabled the handler returns a 404 JSON response.\n * Pass `onDisabled` to customise the response, or `contextFn` to extract\n * a `FlagContext` (userId etc.) from the Hono `Context`.\n */\nexport function FeatureFlag(\n\tflagName: string,\n\toptions: FeatureFlagOptions = {},\n): MethodDecorator {\n\treturn (target: any, propertyKey: string | symbol, descriptor: PropertyDescriptor) => {\n\t\tconst specs: FlagSpec[] = Reflect.getMetadata(FLAG_META, target.constructor) ?? [];\n\t\tspecs.push({\n\t\t\tpropertyKey,\n\t\t\tflagName,\n\t\t\tcontextFn: options.contextFn,\n\t\t\tonDisabled: options.onDisabled,\n\t\t\toriginal: descriptor.value,\n\t\t});\n\t\tReflect.defineMetadata(FLAG_META, specs, target.constructor);\n\t};\n}\n\nexport function getFlagSpecs(target: any): FlagSpec[] {\n\treturn Reflect.getMetadata(FLAG_META, target) ?? [];\n}\n"
|
|
9
9
|
],
|
|
10
|
-
"mappings": ";;;;;;;;;;;;;;;;;;AAeA;AACA;;;ACJA;;;ACTA,SAAS,SAAS,CAAC,GAAmB;AAAA,EACrC,IAAI,IAAI;AAAA,EACR,SAAS,IAAI,EAAG,IAAI,EAAE,QAAQ,KAAK;AAAA,IAClC,IAAI,KAAK,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC;AAAA,EACtC;AAAA,EACA,QAAQ,MAAM,KAAK;AAAA;AAAA;AAIb,MAAM,kBAAgD;AAAA,EAC5D,SAAS,IAAI;AAAA,EAEb,WAAW,CAAC,UAAoD,CAAC,GAAG;AAAA,IACnE,YAAY,GAAG,MAAM,OAAO,QAAQ,OAAO,GAAG;AAAA,MAC7C,KAAK,OAAO,IAAI,GAAG,OAAO,MAAM,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC;AAAA,IAC/D;AAAA;AAAA,EAGD,OAAO,CAAC,UAAkB,YAA4C;AAAA,IACrE,KAAK,OAAO,IACX,UACA,OAAO,eAAe,YAAY,EAAE,SAAS,WAAW,IAAI,UAC7D;AAAA;AAAA,EAGD,OAAO,CAAC,UAA8C;AAAA,IACrD,OAAO,KAAK,OAAO,IAAI,QAAQ;AAAA;AAAA,OAG1B,UAAS,CAAC,UAAkB,SAAyC;AAAA,IAC1E,MAAM,MAAM,KAAK,OAAO,IAAI,QAAQ;AAAA,IACpC,IAAI,CAAC;AAAA,MAAK,OAAO;AAAA,IAEjB,MAAM,KAAK,SAAS,UAAU,SAAS,YAAY,SAAS,OAAO;AAAA,IAGnE,IAAI,MAAM,IAAI,UAAU,SAAS,EAAE;AAAA,MAAG,OAAO;AAAA,IAG7C,IAAI,MAAM,IAAI,WAAW,SAAS,EAAE;AAAA,MAAG,OAAO;AAAA,IAG9C,IAAI,IAAI,YAAY;AAAA,MAAO,OAAO;AAAA,IAGlC,IAAI,IAAI,YAAY,aAAa,IAAI,UAAU,GAAG;AAAA,MACjD,IAAI,CAAC;AAAA,QAAI,OAAO,IAAI,UAAU;AAAA,MAC9B,OAAO,UAAU,GAAG,YAAY,IAAI,IAAI,IAAI;AAAA,IAC7C;AAAA,IAEA,OAAO,IAAI,
|
|
11
|
-
"debugId": "
|
|
10
|
+
"mappings": ";;;;;;;;;;;;;;;;;;AAeA;AACA;;;ACJA;;;ACTA,SAAS,SAAS,CAAC,GAAmB;AAAA,EACrC,IAAI,IAAI;AAAA,EACR,SAAS,IAAI,EAAG,IAAI,EAAE,QAAQ,KAAK;AAAA,IAClC,IAAI,KAAK,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC;AAAA,EACtC;AAAA,EACA,QAAQ,MAAM,KAAK;AAAA;AAAA;AAIb,MAAM,kBAAgD;AAAA,EAC5D,SAAS,IAAI;AAAA,EAEb,WAAW,CAAC,UAAoD,CAAC,GAAG;AAAA,IACnE,YAAY,GAAG,MAAM,OAAO,QAAQ,OAAO,GAAG;AAAA,MAC7C,KAAK,OAAO,IAAI,GAAG,OAAO,MAAM,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC;AAAA,IAC/D;AAAA;AAAA,EAGD,OAAO,CAAC,UAAkB,YAA4C;AAAA,IACrE,KAAK,OAAO,IACX,UACA,OAAO,eAAe,YAAY,EAAE,SAAS,WAAW,IAAI,UAC7D;AAAA;AAAA,EAGD,OAAO,CAAC,UAA8C;AAAA,IACrD,OAAO,KAAK,OAAO,IAAI,QAAQ;AAAA;AAAA,OAG1B,UAAS,CAAC,UAAkB,SAAyC;AAAA,IAC1E,MAAM,MAAM,KAAK,OAAO,IAAI,QAAQ;AAAA,IACpC,IAAI,CAAC;AAAA,MAAK,OAAO;AAAA,IAEjB,MAAM,KAAK,SAAS,UAAU,SAAS,YAAY,SAAS,OAAO;AAAA,IAGnE,IAAI,MAAM,IAAI,UAAU,SAAS,EAAE;AAAA,MAAG,OAAO;AAAA,IAG7C,IAAI,MAAM,IAAI,WAAW,SAAS,EAAE;AAAA,MAAG,OAAO;AAAA,IAG9C,IAAI,IAAI,YAAY;AAAA,MAAO,OAAO;AAAA,IAGlC,IAAI,IAAI,YAAY,aAAa,IAAI,UAAU,GAAG;AAAA,MACjD,IAAI,CAAC;AAAA,QAAI,OAAO,IAAI,UAAU;AAAA,MAC9B,OAAO,UAAU,GAAG,YAAY,IAAI,IAAI,IAAI;AAAA,IAC7C;AAAA,IAEA,OAAO,IAAI,WAAW;AAAA;AAExB;;;ACvDA;AAGA,IAAM,YAAY,OAAO,IAAI,mBAAmB;AA4BzC,SAAS,WAAW,CAC1B,UACA,UAA8B,CAAC,GACb;AAAA,EAClB,OAAO,CAAC,QAAa,aAA8B,eAAmC;AAAA,IACrF,MAAM,QAAoB,QAAQ,YAAY,WAAW,OAAO,WAAW,KAAK,CAAC;AAAA,IACjF,MAAM,KAAK;AAAA,MACV;AAAA,MACA;AAAA,MACA,WAAW,QAAQ;AAAA,MACnB,YAAY,QAAQ;AAAA,MACpB,UAAU,WAAW;AAAA,IACtB,CAAC;AAAA,IACD,QAAQ,eAAe,WAAW,OAAO,OAAO,WAAW;AAAA;AAAA;AAItD,SAAS,YAAY,CAAC,QAAyB;AAAA,EACrD,OAAO,QAAQ,YAAY,WAAW,MAAM,KAAK,CAAC;AAAA;;;AF/B5C,MAAM,mBAAmB;AAAA,SAEf,QAAQ,OAAO,IAAI,0BAA0B;AAAA,EAE7D;AAAA,EAEA,WAAW,CAAgC,SAA4B,CAAC,GAAG;AAAA,IAC1E,KAAK,WAAW,IAAI,kBAAkB,OAAO,SAAS,CAAC,CAAC;AAAA;AAAA,OAInD,UAAS,CAAC,UAAkB,SAAyC;AAAA,IAC1E,OAAO,KAAK,SAAS,UAAU,UAAU,OAAO;AAAA;AAAA,EAIjD,OAAO,CAAC,UAAkB,YAA4C;AAAA,IACrE,KAAK,SAAS,QAAQ,UAAU,UAAU;AAAA;AAAA,EAI3C,OAAO,CAAC,UAA8C;AAAA,IACrD,OAAO,KAAK,SAAS,QAAQ,QAAQ;AAAA;AAAA,EAWtC,eAAe,CAAC,QAAmB;AAAA,IAClC,MAAM,QAAQ,aAAa,OAAO,WAAW;AAAA,IAC7C,WAAW,QAAQ,OAAO;AAAA,MACzB,MAAM,WAAW,KAAK;AAAA,MACrB,OAAe,KAAK,eAAe,OAAO,MAAW,SAAgB;AAAA,QACrE,MAAM,MAAM,KAAK,YAAY,KAAK,UAAU,CAAC,IAAI;AAAA,QACjD,MAAM,UAAU,MAAM,KAAK,UAAU,KAAK,UAAU,GAAG;AAAA,QACvD,IAAI,CAAC,SAAS;AAAA,UACb,IAAI,KAAK;AAAA,YAAY,OAAO,KAAK,WAAW,CAAC;AAAA,UAC7C,OAAO,EAAE,KAAK,EAAE,SAAS,yBAAyB,MAAM,mBAAmB,GAAG,GAAG;AAAA,QAClF;AAAA,QACA,OAAO,SAAS,MAAM,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC;AAAA;AAAA,IAE5C;AAAA;AAEF;AAhDa,qBAAN;AAAA,EADN,WAAW;AAAA,EAOE,kCAAO,qBAAqB;AAAA,EANnC;AAAA;AAAA;AAAA,GAAM;;;ADSN,MAAM,kBAAkB;AAAA,SACvB,OAAO,CAAC,SAA4B,CAAC,GAAG;AAAA,IAS9C,MAAM,4BAA4B;AAAA,IAAC;AAAA,IAA7B,8BAAN;AAAA,MARC,OAAO;AAAA,QACP,WAAW;AAAA,UACV;AAAA,UACA,EAAE,SAAS,mBAAmB,OAAO,aAAa,mBAAmB;AAAA,UACrE,EAAE,SAAS,uBAAuB,UAAU,OAAO;AAAA,QACpD;AAAA,QACA,SAAS,CAAC,oBAAoB,mBAAmB,KAAK;AAAA,MACvD,CAAC;AAAA,OACK;AAAA,IACN,OAAO,eAAe,6BAA6B,QAAQ;AAAA,MAC1D,OAAO;AAAA,IACR,CAAC;AAAA,IACD,OAAO;AAAA;AAET;AAhBa,oBAAN;AAAA,EAPN,OAAO;AAAA,IACP,WAAW;AAAA,MACV;AAAA,MACA,EAAE,SAAS,mBAAmB,OAAO,aAAa,mBAAmB;AAAA,IACtE;AAAA,IACA,SAAS,CAAC,oBAAoB,mBAAmB,KAAK;AAAA,EACvD,CAAC;AAAA,GACY;",
|
|
11
|
+
"debugId": "507CB2EAC4BC20F464756E2164756E21",
|
|
12
12
|
"names": []
|
|
13
13
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nexusts/feature-flag",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.4",
|
|
4
4
|
"description": "Feature flags, canary deployments, and A/B testing for NexusTS",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
],
|
|
30
30
|
"license": "MIT",
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@nexusts/core": "^0.8.
|
|
32
|
+
"@nexusts/core": "^0.8.4"
|
|
33
33
|
},
|
|
34
34
|
"repository": {
|
|
35
35
|
"type": "git",
|