@hazeljs/feature-toggle 0.2.0-alpha.6

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,144 @@
+# @hazeljs/feature-toggle
+
+**Feature flags with one decorator. Protect routes or branch in code.**
+
+In-memory flags, optional env seeding, and `@FeatureToggle('name')` on controllers or methods. When the flag is off, the route returns 403. No external SDK — just core.
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/feature-toggle.svg)](https://www.npmjs.com/package/@hazeljs/feature-toggle)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/feature-toggle)](https://www.npmjs.com/package/@hazeljs/feature-toggle)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- **Decorator-first** – `@FeatureToggle('name')` on a controller or method; no manual guards
+- **In-memory** – Simple flag store; optional seed from `initialFlags` or env prefix
+- **Env integration** – Use `envPrefix` (e.g. `FEATURE_`) to load flags from environment variables
+- **Programmatic API** – Inject `FeatureToggleService` and call `isEnabled()`, `set()`, `get()`
+- **TypeScript** – Full type support, no extra dependencies beyond `@hazeljs/core`
+
+## Installation
+
+```bash
+npm install @hazeljs/feature-toggle
+```
+
+## Quick Start
+
+### 1. Register the module
+
+```typescript
+import { HazelModule } from '@hazeljs/core';
+import { FeatureToggleModule } from '@hazeljs/feature-toggle';
+
+@HazelModule({
+  imports: [
+    FeatureToggleModule.forRoot({
+      initialFlags: { newCheckout: true },
+      envPrefix: 'FEATURE_', // FEATURE_X from env → flag "x"
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### 2. Protect routes with the decorator
+
+```typescript
+import { Controller, Get } from '@hazeljs/core';
+import { FeatureToggle } from '@hazeljs/feature-toggle';
+
+@Controller('checkout')
+export class CheckoutController {
+  @Get('new')
+  @FeatureToggle('newCheckout')
+  getNewCheckout() {
+    return { flow: 'new' };
+  }
+
+  @Get('legacy')
+  getLegacyCheckout() {
+    return { flow: 'legacy' };
+  }
+}
+
+// Or require the flag for the whole controller:
+@Controller('beta')
+@FeatureToggle('betaApi')
+export class BetaController {
+  @Get()
+  index() {
+    return { message: 'Beta API' };
+  }
+}
+```
+
+### 3. Use in services (programmatic)
+
+```typescript
+import { Service } from '@hazeljs/core';
+import { FeatureToggleService } from '@hazeljs/feature-toggle';
+
+@Service()
+export class OrderService {
+  constructor(private readonly featureToggle: FeatureToggleService) {}
+
+  createOrder(data: OrderData) {
+    if (this.featureToggle.isEnabled('newCheckout')) {
+      return this.createWithNewFlow(data);
+    }
+    return this.createWithLegacyFlow(data);
+  }
+}
+```
+
+## API
+
+### FeatureToggleModule
+
+- **`FeatureToggleModule.forRoot(options?)`**  
+  Registers the module. Options:
+  - `initialFlags?: Record<string, boolean>` – Flags to set on load
+  - `envPrefix?: string` – Env var prefix (e.g. `FEATURE_`); vars like `FEATURE_NEW_UI` become flag `newUi`. Values `true`, `1`, `yes` (case-insensitive) → `true`.
+
+### FeatureToggleService
+
+- **`isEnabled(name: string): boolean`** – Returns whether the flag is on (default `false` if unset).
+- **`get(name: string): boolean | undefined`** – Raw value; `undefined` if not set.
+- **`set(name: string, value: boolean): void`** – Set or override a flag at runtime (in-memory).
+
+### Decorator
+
+- **`@FeatureToggle(featureName: string)`** – Method or class decorator. Applies a guard so that when the flag is disabled, the request is rejected (403) and the handler is not run.
+
+## Environment variables
+
+With `envPrefix: 'FEATURE_'`:
+
+```env
+FEATURE_NEW_CHECKOUT=true
+FEATURE_BETA_API=0
+FEATURE_NEW_UI=yes
+```
+
+Flag names are derived in camelCase: `FEATURE_NEW_CHECKOUT` → `newCheckout`.
+
+## Testing
+
+```bash
+npm test
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0 © [HazelJS](https://hazeljs.com)
+
+## Links
+
+- [Documentation](https://hazeljs.com/docs/packages/feature-toggle)
+- [GitHub](https://github.com/hazel-js/hazeljs)
+- [Issues](https://github.com/hazel-js/hazeljs/issues)
+- [Discord](https://discord.com/channels/1448263814238965833/1448263814859456575)

package/dist/__tests__/feature-toggle.decorator.test.d.ts

@@ -0,0 +1,2 @@
+import 'reflect-metadata';
+//# sourceMappingURL=feature-toggle.decorator.test.d.ts.map

package/dist/__tests__/feature-toggle.decorator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-toggle.decorator.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/feature-toggle.decorator.test.ts"],"names":[],"mappings":"AACA,OAAO,kBAAkB,CAAC"}

package/dist/__tests__/feature-toggle.decorator.test.js

@@ -0,0 +1,92 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/// <reference types="jest" />
+require("reflect-metadata");
+const feature_toggle_guard_1 = require("../feature-toggle.guard");
+const feature_toggle_decorator_1 = require("../feature-toggle.decorator");
+const feature_toggle_service_1 = require("../feature-toggle.service");
+jest.mock('@hazeljs/core', () => {
+    const actual = jest.requireActual('@hazeljs/core');
+    return {
+        ...actual,
+        Service: () => () => undefined,
+        UseGuards: (...guards) => {
+            return (target, propertyKey, descriptor) => {
+                if (propertyKey !== undefined && descriptor !== undefined) {
+                    const existing = Reflect.getMetadata('hazel:guards', target, propertyKey) || [];
+                    Reflect.defineMetadata('hazel:guards', [...existing, ...guards], target, propertyKey);
+                    return descriptor;
+                }
+                const existing = Reflect.getMetadata('hazel:guards', target) || [];
+                Reflect.defineMetadata('hazel:guards', [...existing, ...guards], target);
+            };
+        },
+    };
+});
+describe('createFeatureToggleGuard', () => {
+    beforeEach(() => {
+        feature_toggle_service_1.FeatureToggleService.setOptions({});
+    });
+    it('returns a class that allows access when feature is enabled', () => {
+        const GuardClass = (0, feature_toggle_guard_1.createFeatureToggleGuard)('testFlag');
+        const service = new feature_toggle_service_1.FeatureToggleService();
+        service.set('testFlag', true);
+        const guard = new GuardClass(service);
+        expect(guard.canActivate({})).toBe(true);
+    });
+    it('returns a class that denies access when feature is disabled', () => {
+        const GuardClass = (0, feature_toggle_guard_1.createFeatureToggleGuard)('testFlag');
+        const service = new feature_toggle_service_1.FeatureToggleService();
+        service.set('testFlag', false);
+        const guard = new GuardClass(service);
+        expect(guard.canActivate({})).toBe(false);
+    });
+    it('returns the same guard class for the same feature name (caching)', () => {
+        const A = (0, feature_toggle_guard_1.createFeatureToggleGuard)('same');
+        const B = (0, feature_toggle_guard_1.createFeatureToggleGuard)('same');
+        expect(A).toBe(B);
+    });
+    it('returns different guard classes for different feature names', () => {
+        const A = (0, feature_toggle_guard_1.createFeatureToggleGuard)('one');
+        const B = (0, feature_toggle_guard_1.createFeatureToggleGuard)('two');
+        expect(A).not.toBe(B);
+    });
+});
+describe('FeatureToggle decorator', () => {
+    it('applies guard metadata on method', () => {
+        class TestController {
+            handler() { }
+        }
+        __decorate([
+            (0, feature_toggle_decorator_1.FeatureToggle)('myFeature'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "handler", null);
+        const guards = Reflect.getMetadata('hazel:guards', TestController.prototype, 'handler');
+        expect(guards).toBeDefined();
+        expect(Array.isArray(guards)).toBe(true);
+        expect(guards.length).toBe(1);
+    });
+    it('applies guard metadata on class', () => {
+        let TestController = class TestController {
+            handler() { }
+        };
+        TestController = __decorate([
+            (0, feature_toggle_decorator_1.FeatureToggle)('classFeature')
+        ], TestController);
+        const guards = Reflect.getMetadata('hazel:guards', TestController);
+        expect(guards).toBeDefined();
+        expect(Array.isArray(guards)).toBe(true);
+        expect(guards.length).toBe(1);
+    });
+});

package/dist/__tests__/feature-toggle.service.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=feature-toggle.service.test.d.ts.map

package/dist/__tests__/feature-toggle.service.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-toggle.service.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/feature-toggle.service.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/feature-toggle.service.test.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/// <reference types="jest" />
+const feature_toggle_service_1 = require("../feature-toggle.service");
+const feature_toggle_module_1 = require("../feature-toggle.module");
+jest.mock('@hazeljs/core', () => ({
+    Service: () => () => undefined,
+    HazelModule: () => () => undefined,
+}));
+describe('FeatureToggleService', () => {
+    beforeEach(() => {
+        feature_toggle_service_1.FeatureToggleService.setOptions({});
+    });
+    describe('isEnabled', () => {
+        it('returns false for unset flag', () => {
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            expect(svc.isEnabled('missing')).toBe(false);
+        });
+        it('returns true when flag is set to true', () => {
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            svc.set('onFlag', true);
+            expect(svc.isEnabled('onFlag')).toBe(true);
+        });
+        it('returns false when flag is set to false', () => {
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            svc.set('offFlag', false);
+            expect(svc.isEnabled('offFlag')).toBe(false);
+        });
+    });
+    describe('get', () => {
+        it('returns undefined for unset flag', () => {
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            expect(svc.get('missing')).toBeUndefined();
+        });
+        it('returns value when flag is set', () => {
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            svc.set('a', true);
+            svc.set('b', false);
+            expect(svc.get('a')).toBe(true);
+            expect(svc.get('b')).toBe(false);
+        });
+    });
+    describe('set', () => {
+        it('sets and overwrites flag', () => {
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            svc.set('x', true);
+            expect(svc.get('x')).toBe(true);
+            svc.set('x', false);
+            expect(svc.get('x')).toBe(false);
+        });
+    });
+    describe('initialFlags', () => {
+        it('loads initial flags from options', () => {
+            feature_toggle_service_1.FeatureToggleService.setOptions({
+                initialFlags: { foo: true, bar: false },
+            });
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            expect(svc.isEnabled('foo')).toBe(true);
+            expect(svc.isEnabled('bar')).toBe(false);
+        });
+    });
+    describe('envPrefix', () => {
+        it('loads flags from env when envPrefix is set', () => {
+            const orig = process.env.FEATURE_TEST_A;
+            const origB = process.env.FEATURE_TEST_B;
+            process.env.FEATURE_TEST_A = 'true';
+            process.env.FEATURE_TEST_B = '0';
+            feature_toggle_service_1.FeatureToggleService.setOptions({ envPrefix: 'FEATURE_' });
+            const svc = new feature_toggle_service_1.FeatureToggleService();
+            // FEATURE_TEST_A -> testA (camelCase), FEATURE_TEST_B -> testB
+            expect(svc.isEnabled('testA')).toBe(true);
+            expect(svc.isEnabled('testB')).toBe(false);
+            if (orig !== undefined)
+                process.env.FEATURE_TEST_A = orig;
+            else
+                delete process.env.FEATURE_TEST_A;
+            if (origB !== undefined)
+                process.env.FEATURE_TEST_B = origB;
+            else
+                delete process.env.FEATURE_TEST_B;
+        });
+    });
+});
+describe('FeatureToggleModule', () => {
+    it('forRoot accepts options and returns module', () => {
+        const mod = feature_toggle_module_1.FeatureToggleModule.forRoot({
+            initialFlags: { x: true },
+        });
+        expect(mod).toBe(feature_toggle_module_1.FeatureToggleModule);
+    });
+    it('forRoot with no args returns module', () => {
+        const mod = feature_toggle_module_1.FeatureToggleModule.forRoot();
+        expect(mod).toBe(feature_toggle_module_1.FeatureToggleModule);
+    });
+});

package/dist/feature-toggle.decorator.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Protects a controller or route handler with a feature flag. When the flag is
+ * disabled, requests receive 403 without executing the handler.
+ *
+ * @param featureName - The feature flag name (must be enabled for access).
+ * @example
+ * @FeatureToggle('newCheckout')
+ * @Get('new')
+ * getNewCheckout() { ... }
+ *
+ * @FeatureToggle('betaApi')
+ * @Controller('beta')
+ * export class BetaController { ... }
+ */
+export declare function FeatureToggle(featureName: string): MethodDecorator & ClassDecorator;
+//# sourceMappingURL=feature-toggle.decorator.d.ts.map

package/dist/feature-toggle.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-toggle.decorator.d.ts","sourceRoot":"","sources":["../src/feature-toggle.decorator.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,eAAe,GAAG,cAAc,CAGnF"}

package/dist/feature-toggle.decorator.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureToggle = FeatureToggle;
+const core_1 = require("@hazeljs/core");
+const feature_toggle_guard_1 = require("./feature-toggle.guard");
+/**
+ * Protects a controller or route handler with a feature flag. When the flag is
+ * disabled, requests receive 403 without executing the handler.
+ *
+ * @param featureName - The feature flag name (must be enabled for access).
+ * @example
+ * @FeatureToggle('newCheckout')
+ * @Get('new')
+ * getNewCheckout() { ... }
+ *
+ * @FeatureToggle('betaApi')
+ * @Controller('beta')
+ * export class BetaController { ... }
+ */
+function FeatureToggle(featureName) {
+    const GuardClass = (0, feature_toggle_guard_1.createFeatureToggleGuard)(featureName);
+    return (0, core_1.UseGuards)(GuardClass);
+}

package/dist/feature-toggle.guard.d.ts

@@ -0,0 +1,7 @@
+import { type CanActivate, type Type } from '@hazeljs/core';
+/**
+ * Creates an injectable guard class that allows access only when the given
+ * feature flag is enabled. Used internally by @FeatureToggle().
+ */
+export declare function createFeatureToggleGuard(featureName: string): Type<CanActivate>;
+//# sourceMappingURL=feature-toggle.guard.d.ts.map

package/dist/feature-toggle.guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-toggle.guard.d.ts","sourceRoot":"","sources":["../src/feature-toggle.guard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,WAAW,EAAyB,KAAK,IAAI,EAAE,MAAM,eAAe,CAAC;AAK/F;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,CAsB/E"}

package/dist/feature-toggle.guard.js

@@ -0,0 +1,43 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFeatureToggleGuard = createFeatureToggleGuard;
+const core_1 = require("@hazeljs/core");
+const feature_toggle_service_1 = require("./feature-toggle.service");
+const guardCache = new Map();
+/**
+ * Creates an injectable guard class that allows access only when the given
+ * feature flag is enabled. Used internally by @FeatureToggle().
+ */
+function createFeatureToggleGuard(featureName) {
+    let GuardClass = guardCache.get(featureName);
+    if (GuardClass) {
+        return GuardClass;
+    }
+    let FeatureToggleGuardImpl = class FeatureToggleGuardImpl {
+        constructor(featureToggle) {
+            this.featureToggle = featureToggle;
+        }
+        canActivate(_context) {
+            return this.featureToggle.isEnabled(featureName);
+        }
+    };
+    FeatureToggleGuardImpl = __decorate([
+        (0, core_1.Injectable)(),
+        __metadata("design:paramtypes", [feature_toggle_service_1.FeatureToggleService])
+    ], FeatureToggleGuardImpl);
+    // Ensure the container resolves FeatureToggleService for the first constructor param
+    // (design:paramtypes may not be reliable for dynamically created classes)
+    Reflect.defineMetadata('hazel:inject', [feature_toggle_service_1.FeatureToggleService], FeatureToggleGuardImpl);
+    GuardClass = FeatureToggleGuardImpl;
+    guardCache.set(featureName, GuardClass);
+    return GuardClass;
+}

package/dist/feature-toggle.module.d.ts

@@ -0,0 +1,9 @@
+import type { FeatureToggleModuleOptions } from './feature-toggle.types';
+export type { FeatureToggleModuleOptions } from './feature-toggle.types';
+export declare class FeatureToggleModule {
+    /**
+     * Register FeatureToggleModule with optional options.
+     */
+    static forRoot(options?: FeatureToggleModuleOptions): typeof FeatureToggleModule;
+}
+//# sourceMappingURL=feature-toggle.module.d.ts.map

package/dist/feature-toggle.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-toggle.module.d.ts","sourceRoot":"","sources":["../src/feature-toggle.module.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEzE,YAAY,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEzE,qBAIa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,mBAAmB;CAMjF"}

package/dist/feature-toggle.module.js

@@ -0,0 +1,30 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var FeatureToggleModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureToggleModule = void 0;
+const core_1 = require("@hazeljs/core");
+const feature_toggle_service_1 = require("./feature-toggle.service");
+let FeatureToggleModule = FeatureToggleModule_1 = class FeatureToggleModule {
+    /**
+     * Register FeatureToggleModule with optional options.
+     */
+    static forRoot(options) {
+        if (options) {
+            feature_toggle_service_1.FeatureToggleService.setOptions(options);
+        }
+        return FeatureToggleModule_1;
+    }
+};
+exports.FeatureToggleModule = FeatureToggleModule;
+exports.FeatureToggleModule = FeatureToggleModule = FeatureToggleModule_1 = __decorate([
+    (0, core_1.HazelModule)({
+        providers: [feature_toggle_service_1.FeatureToggleService],
+        exports: [feature_toggle_service_1.FeatureToggleService],
+    })
+], FeatureToggleModule);

package/dist/feature-toggle.service.d.ts

@@ -0,0 +1,27 @@
+import { FeatureToggleModuleOptions } from './feature-toggle.types';
+export declare class FeatureToggleService {
+    private static options;
+    private readonly flags;
+    constructor();
+    /**
+     * Set module options (called by FeatureToggleModule.forRoot).
+     */
+    static setOptions(options: FeatureToggleModuleOptions): void;
+    private load;
+    private envKeyToFlagName;
+    private parseBool;
+    /**
+     * Returns true if the feature is enabled, false otherwise.
+     * Unset flags are treated as disabled.
+     */
+    isEnabled(name: string): boolean;
+    /**
+     * Get the raw value for a flag (undefined if not set).
+     */
+    get(name: string): boolean | undefined;
+    /**
+     * Set or override a flag at runtime (in-memory only).
+     */
+    set(name: string, value: boolean): void;
+}
+//# sourceMappingURL=feature-toggle.service.d.ts.map

package/dist/feature-toggle.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-toggle.service.d.ts","sourceRoot":"","sources":["../src/feature-toggle.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEpE,qBACa,oBAAoB;IAC/B,OAAO,CAAC,MAAM,CAAC,OAAO,CAAkC;IACxD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8B;;IAMpD;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI;IAI5D,OAAO,CAAC,IAAI;IAqBZ,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,SAAS;IAKjB;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIhC;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAItC;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;CAGxC"}

package/dist/feature-toggle.service.js

@@ -0,0 +1,81 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var FeatureToggleService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureToggleService = void 0;
+const core_1 = require("@hazeljs/core");
+let FeatureToggleService = FeatureToggleService_1 = class FeatureToggleService {
+    constructor() {
+        this.flags = new Map();
+        this.load();
+    }
+    /**
+     * Set module options (called by FeatureToggleModule.forRoot).
+     */
+    static setOptions(options) {
+        FeatureToggleService_1.options = options ?? {};
+    }
+    load() {
+        const opts = FeatureToggleService_1.options;
+        if (opts.initialFlags) {
+            for (const [name, value] of Object.entries(opts.initialFlags)) {
+                this.flags.set(name, value);
+            }
+        }
+        if (opts.envPrefix) {
+            const prefix = opts.envPrefix.toUpperCase();
+            for (const [key, raw] of Object.entries(process.env)) {
+                if (key.startsWith(prefix) && raw !== undefined) {
+                    const name = this.envKeyToFlagName(key.slice(prefix.length));
+                    const value = this.parseBool(raw);
+                    this.flags.set(name, value);
+                }
+            }
+        }
+    }
+    envKeyToFlagName(envKey) {
+        // FEATURE_NEW_CHECKOUT -> newCheckout
+        return envKey
+            .toLowerCase()
+            .split('_')
+            .map((part, i) => (i === 0 ? part : part.charAt(0).toUpperCase() + part.slice(1)))
+            .join('');
+    }
+    parseBool(value) {
+        const v = value.toLowerCase();
+        return v === 'true' || v === '1' || v === 'yes';
+    }
+    /**
+     * Returns true if the feature is enabled, false otherwise.
+     * Unset flags are treated as disabled.
+     */
+    isEnabled(name) {
+        return this.flags.get(name) ?? false;
+    }
+    /**
+     * Get the raw value for a flag (undefined if not set).
+     */
+    get(name) {
+        return this.flags.has(name) ? this.flags.get(name) : undefined;
+    }
+    /**
+     * Set or override a flag at runtime (in-memory only).
+     */
+    set(name, value) {
+        this.flags.set(name, value);
+    }
+};
+exports.FeatureToggleService = FeatureToggleService;
+FeatureToggleService.options = {};
+exports.FeatureToggleService = FeatureToggleService = FeatureToggleService_1 = __decorate([
+    (0, core_1.Service)(),
+    __metadata("design:paramtypes", [])
+], FeatureToggleService);

package/dist/feature-toggle.types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Options for FeatureToggleModule.forRoot()
+ */
+export interface FeatureToggleModuleOptions {
+    /**
+     * Initial flag values to set on module load.
+     */
+    initialFlags?: Record<string, boolean>;
+    /**
+     * Environment variable prefix. When set, any env var like PREFIX_NAME
+     * (e.g. FEATURE_NEW_UI) is read and stored as flag "newUi" (camelCase).
+     * Values: 'true', '1', 'yes' (case-insensitive) => true; others => false.
+     */
+    envPrefix?: string;
+}
+//# sourceMappingURL=feature-toggle.types.d.ts.map

package/dist/feature-toggle.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-toggle.types.d.ts","sourceRoot":"","sources":["../src/feature-toggle.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/feature-toggle.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @hazeljs/feature-toggle - Feature toggle module for HazelJS
+ */
+export { FeatureToggleModule, type FeatureToggleModuleOptions } from './feature-toggle.module';
+export { FeatureToggleService } from './feature-toggle.service';
+export { FeatureToggle } from './feature-toggle.decorator';
+export { createFeatureToggleGuard } from './feature-toggle.guard';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,KAAK,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAC/F,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * @hazeljs/feature-toggle - Feature toggle module for HazelJS
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFeatureToggleGuard = exports.FeatureToggle = exports.FeatureToggleService = exports.FeatureToggleModule = void 0;
+var feature_toggle_module_1 = require("./feature-toggle.module");
+Object.defineProperty(exports, "FeatureToggleModule", { enumerable: true, get: function () { return feature_toggle_module_1.FeatureToggleModule; } });
+var feature_toggle_service_1 = require("./feature-toggle.service");
+Object.defineProperty(exports, "FeatureToggleService", { enumerable: true, get: function () { return feature_toggle_service_1.FeatureToggleService; } });
+var feature_toggle_decorator_1 = require("./feature-toggle.decorator");
+Object.defineProperty(exports, "FeatureToggle", { enumerable: true, get: function () { return feature_toggle_decorator_1.FeatureToggle; } });
+var feature_toggle_guard_1 = require("./feature-toggle.guard");
+Object.defineProperty(exports, "createFeatureToggleGuard", { enumerable: true, get: function () { return feature_toggle_guard_1.createFeatureToggleGuard; } });

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hazeljs/feature-toggle",
+  "version": "0.2.0-alpha.6",
+  "description": "Feature toggle module for HazelJS framework",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest --coverage --passWithNoTests",
+    "lint": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "clean": "rm -rf dist"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.17.50",
+    "@typescript-eslint/eslint-plugin": "^8.18.2",
+    "@typescript-eslint/parser": "^8.18.2",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hazel-js/hazeljs.git",
+    "directory": "packages/feature-toggle"
+  },
+  "keywords": [
+    "hazeljs",
+    "feature-toggle",
+    "feature-flag",
+    "flags"
+  ],
+  "author": "Muhammad Arslan <muhammad.arslan@hazeljs.com>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/hazeljs/hazel-js/issues"
+  },
+  "homepage": "https://hazeljs.com",
+  "peerDependencies": {
+    "@hazeljs/core": ">=0.2.0-beta.0"
+  },
+  "gitHead": "7d4d24452da000b3b74ed841c90d7718dbb7669f"
+}