@nestwork/chevron 1.0.0

package/dist/utils/chevron-process-state.d.ts

@@ -0,0 +1,8 @@
+import { ChevronModuleOptions } from '../interfaces';
+export declare function resetRegisteredGateNamesForTesting(): void;
+export declare function isGateShutdownComplete(name: string | symbol): boolean;
+export declare function markGateShutdownComplete(name: string | symbol): void;
+export declare function releaseRegisteredGateName(name: string | symbol): void;
+export declare function assertGateNameNotExplicitDefault(options: Pick<ChevronModuleOptions, 'name'>): void;
+export declare function assertGateNameAvailable(name: string | symbol): void;
+//# sourceMappingURL=chevron-process-state.d.ts.map

package/dist/utils/chevron-process-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chevron-process-state.d.ts","sourceRoot":"","sources":["../../src/utils/chevron-process-state.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAKrD,wBAAgB,kCAAkC,IAAI,IAAI,CAGzD;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAErE;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEpE;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAErE;AAED,wBAAgB,gCAAgC,CAAC,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG,IAAI,CAIlG;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CASnE"}

package/dist/utils/chevron-process-state.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetRegisteredGateNamesForTesting = resetRegisteredGateNamesForTesting;
+exports.isGateShutdownComplete = isGateShutdownComplete;
+exports.markGateShutdownComplete = markGateShutdownComplete;
+exports.releaseRegisteredGateName = releaseRegisteredGateName;
+exports.assertGateNameNotExplicitDefault = assertGateNameNotExplicitDefault;
+exports.assertGateNameAvailable = assertGateNameAvailable;
+const chevron_constants_1 = require("../chevron.constants");
+const registeredGateNames = new Set();
+const shutdownCompletedGateNames = new Set();
+function resetRegisteredGateNamesForTesting() {
+    registeredGateNames.clear();
+    shutdownCompletedGateNames.clear();
+}
+function isGateShutdownComplete(name) {
+    return shutdownCompletedGateNames.has(String(name));
+}
+function markGateShutdownComplete(name) {
+    shutdownCompletedGateNames.add(String(name));
+}
+function releaseRegisteredGateName(name) {
+    registeredGateNames.delete(String(name));
+}
+function assertGateNameNotExplicitDefault(options) {
+    if (options.name === chevron_constants_1.DEFAULT_CHEVRON_NAME) {
+        throw new Error('Omit "name" for the default gate instead of using name: "default".');
+    }
+}
+function assertGateNameAvailable(name) {
+    const key = String(name);
+    if (registeredGateNames.has(key)) {
+        throw new Error(`Chevron "${key}" is already registered.`);
+    }
+    registeredGateNames.add(key);
+    shutdownCompletedGateNames.delete(key);
+}
+//# sourceMappingURL=chevron-process-state.js.map

package/dist/utils/chevron-process-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chevron-process-state.js","sourceRoot":"","sources":["../../src/utils/chevron-process-state.ts"],"names":[],"mappings":";;AAMA,gFAGC;AAED,wDAEC;AAED,4DAEC;AAED,8DAEC;AAED,4EAIC;AAED,0DASC;AAtCD,4DAA4D;AAG5D,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;AAC9C,MAAM,0BAA0B,GAAG,IAAI,GAAG,EAAU,CAAC;AAErD,SAAgB,kCAAkC;IAC9C,mBAAmB,CAAC,KAAK,EAAE,CAAC;IAC5B,0BAA0B,CAAC,KAAK,EAAE,CAAC;AACvC,CAAC;AAED,SAAgB,sBAAsB,CAAC,IAAqB;IACxD,OAAO,0BAA0B,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAgB,wBAAwB,CAAC,IAAqB;IAC1D,0BAA0B,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AACjD,CAAC;AAED,SAAgB,yBAAyB,CAAC,IAAqB;IAC3D,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,SAAgB,gCAAgC,CAAC,OAA2C;IACxF,IAAI,OAAO,CAAC,IAAI,KAAK,wCAAoB,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IAC1F,CAAC;AACL,CAAC;AAED,SAAgB,uBAAuB,CAAC,IAAqB;IACzD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAEzB,IAAI,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,0BAA0B,CAAC,CAAC;IAC/D,CAAC;IAED,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,0BAA0B,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC3C,CAAC"}

package/dist/utils/chevron.utils.d.ts

@@ -0,0 +1,17 @@
+import { Inject, Type } from '@nestjs/common';
+import { ChevronService } from '../chevron.service';
+import { ChevronModuleAsyncOptions, ChevronModuleOptions, ChevronStorageRegistration } from '../interfaces';
+export declare function getChevronName(options: Pick<ChevronModuleOptions, 'name'>): string | symbol;
+export declare function resolveIsGlobal(options: Pick<ChevronModuleOptions, 'name' | 'isGlobal'>): boolean;
+export declare function resolveAsyncRegistrationChevronName(asyncOptions: ChevronModuleAsyncOptions): string | symbol;
+export declare function getChevronToken(name?: string | symbol): string | Type<ChevronService>;
+export declare function getChevronStorageToken(name?: string | symbol): symbol;
+export declare function getChevronRegistryToken(name?: string | symbol): symbol;
+export type ResolvedChevronModuleOptions = ChevronModuleOptions & {
+    storage: ChevronStorageRegistration;
+};
+export declare function withDefaultChevronOptions(options?: Partial<ChevronModuleOptions>): ResolvedChevronModuleOptions;
+export declare function mergeAsyncChevronOptions(asyncOptions: ChevronModuleAsyncOptions, resolvedOptions: Partial<ChevronModuleOptions>): ResolvedChevronModuleOptions;
+export declare function finalizeAsyncChevronOptions(asyncOptions: ChevronModuleAsyncOptions, resolvedOptions: Partial<ChevronModuleOptions>): ResolvedChevronModuleOptions;
+export declare const InjectChevron: (name?: string | symbol) => ReturnType<typeof Inject>;
+//# sourceMappingURL=chevron.utils.d.ts.map

package/dist/utils/chevron.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chevron.utils.d.ts","sourceRoot":"","sources":["../../src/utils/chevron.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAEH,yBAAyB,EACzB,oBAAoB,EACpB,0BAA0B,EAC7B,MAAM,eAAe,CAAC;AAEvB,wBAAgB,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG,MAAM,GAAG,MAAM,CAE3F;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,GAAG,UAAU,CAAC,GAAG,OAAO,CAMjG;AAED,wBAAgB,mCAAmC,CAAC,YAAY,EAAE,yBAAyB,GAAG,MAAM,GAAG,MAAM,CAE5G;AAED,wBAAgB,eAAe,CAAC,IAAI,GAAE,MAAM,GAAG,MAA6B,GAAG,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAM3G;AAED,wBAAgB,sBAAsB,CAAC,IAAI,GAAE,MAAM,GAAG,MAA6B,GAAG,MAAM,CAE3F;AAED,wBAAgB,uBAAuB,CAAC,IAAI,GAAE,MAAM,GAAG,MAA6B,GAAG,MAAM,CAE5F;AAED,MAAM,MAAM,4BAA4B,GAAG,oBAAoB,GAAG;IAC9D,OAAO,EAAE,0BAA0B,CAAC;CACvC,CAAC;AAEF,wBAAgB,yBAAyB,CAAC,OAAO,GAAE,OAAO,CAAC,oBAAoB,CAAM,GAAG,4BAA4B,CAOnH;AAED,wBAAgB,wBAAwB,CACpC,YAAY,EAAE,yBAAyB,EACvC,eAAe,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAC/C,4BAA4B,CAY9B;AAED,wBAAgB,2BAA2B,CACvC,YAAY,EAAE,yBAAyB,EACvC,eAAe,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAC/C,4BAA4B,CAwB9B;AAED,eAAO,MAAM,aAAa,GAAI,OAAM,MAAM,GAAG,MAA6B,KAAG,UAAU,CAAC,OAAO,MAAM,CACpE,CAAC"}

package/dist/utils/chevron.utils.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectChevron = void 0;
+exports.getChevronName = getChevronName;
+exports.resolveIsGlobal = resolveIsGlobal;
+exports.resolveAsyncRegistrationChevronName = resolveAsyncRegistrationChevronName;
+exports.getChevronToken = getChevronToken;
+exports.getChevronStorageToken = getChevronStorageToken;
+exports.getChevronRegistryToken = getChevronRegistryToken;
+exports.withDefaultChevronOptions = withDefaultChevronOptions;
+exports.mergeAsyncChevronOptions = mergeAsyncChevronOptions;
+exports.finalizeAsyncChevronOptions = finalizeAsyncChevronOptions;
+const common_1 = require("@nestjs/common");
+const chevron_constants_1 = require("../chevron.constants");
+const chevron_service_1 = require("../chevron.service");
+function getChevronName(options) {
+    return options.name ?? chevron_constants_1.DEFAULT_CHEVRON_NAME;
+}
+function resolveIsGlobal(options) {
+    if (options.isGlobal !== undefined) {
+        return options.isGlobal;
+    }
+    return options.name === undefined;
+}
+function resolveAsyncRegistrationChevronName(asyncOptions) {
+    return asyncOptions.name ?? chevron_constants_1.DEFAULT_CHEVRON_NAME;
+}
+function getChevronToken(name = chevron_constants_1.DEFAULT_CHEVRON_NAME) {
+    if (name === chevron_constants_1.DEFAULT_CHEVRON_NAME) {
+        return chevron_service_1.ChevronService;
+    }
+    return `${String(name)}ChevronService`;
+}
+function getChevronStorageToken(name = chevron_constants_1.DEFAULT_CHEVRON_NAME) {
+    return Symbol.for(`ChevronStorage:${String(name)}`);
+}
+function getChevronRegistryToken(name = chevron_constants_1.DEFAULT_CHEVRON_NAME) {
+    return Symbol.for(`ChevronRegistry:${String(name)}`);
+}
+function withDefaultChevronOptions(options = {}) {
+    const defaultStorage = { driver: 'memory' };
+    return {
+        ...options,
+        storage: options.storage ?? defaultStorage,
+    };
+}
+function mergeAsyncChevronOptions(asyncOptions, resolvedOptions) {
+    const merged = { ...resolvedOptions };
+    if (asyncOptions.name !== undefined) {
+        merged.name = asyncOptions.name;
+    }
+    if (asyncOptions.isGlobal !== undefined) {
+        merged.isGlobal = asyncOptions.isGlobal;
+    }
+    return withDefaultChevronOptions(merged);
+}
+function finalizeAsyncChevronOptions(asyncOptions, resolvedOptions) {
+    const merged = mergeAsyncChevronOptions(asyncOptions, resolvedOptions);
+    const registrationName = resolveAsyncRegistrationChevronName(asyncOptions);
+    const effectiveName = getChevronName(merged);
+    if (String(registrationName) !== String(effectiveName)) {
+        throw new Error('Named chevrons require top-level "name" on forRootAsync when the factory returns a custom gate name.');
+    }
+    if (resolvedOptions.isGlobal !== undefined && asyncOptions.isGlobal === undefined) {
+        throw new Error('Chevrons require top-level "isGlobal" on forRootAsync when the factory returns isGlobal.');
+    }
+    if (resolvedOptions.isGlobal !== undefined &&
+        asyncOptions.isGlobal !== undefined &&
+        resolvedOptions.isGlobal !== asyncOptions.isGlobal) {
+        throw new Error('Conflicting "isGlobal" values between forRootAsync options and factory return.');
+    }
+    return merged;
+}
+const InjectChevron = (name = chevron_constants_1.DEFAULT_CHEVRON_NAME) => (0, common_1.Inject)(getChevronToken(name));
+exports.InjectChevron = InjectChevron;
+//# sourceMappingURL=chevron.utils.js.map

package/dist/utils/chevron.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chevron.utils.js","sourceRoot":"","sources":["../../src/utils/chevron.utils.ts"],"names":[],"mappings":";;;AAUA,wCAEC;AAED,0CAMC;AAED,kFAEC;AAED,0CAMC;AAED,wDAEC;AAED,0DAEC;AAMD,8DAOC;AAED,4DAeC;AAED,kEA2BC;AAnGD,2CAA8C;AAC9C,4DAA4D;AAC5D,wDAAoD;AAQpD,SAAgB,cAAc,CAAC,OAA2C;IACtE,OAAO,OAAO,CAAC,IAAI,IAAI,wCAAoB,CAAC;AAChD,CAAC;AAED,SAAgB,eAAe,CAAC,OAAwD;IACpF,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,OAAO,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;AACtC,CAAC;AAED,SAAgB,mCAAmC,CAAC,YAAuC;IACvF,OAAO,YAAY,CAAC,IAAI,IAAI,wCAAoB,CAAC;AACrD,CAAC;AAED,SAAgB,eAAe,CAAC,OAAwB,wCAAoB;IACxE,IAAI,IAAI,KAAK,wCAAoB,EAAE,CAAC;QAChC,OAAO,gCAAc,CAAC;IAC1B,CAAC;IAED,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;AAC3C,CAAC;AAED,SAAgB,sBAAsB,CAAC,OAAwB,wCAAoB;IAC/E,OAAO,MAAM,CAAC,GAAG,CAAC,kBAAkB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC;AAED,SAAgB,uBAAuB,CAAC,OAAwB,wCAAoB;IAChF,OAAO,MAAM,CAAC,GAAG,CAAC,mBAAmB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACzD,CAAC;AAMD,SAAgB,yBAAyB,CAAC,UAAyC,EAAE;IACjF,MAAM,cAAc,GAA+B,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAExE,OAAO;QACH,GAAG,OAAO;QACV,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc;KAC7C,CAAC;AACN,CAAC;AAED,SAAgB,wBAAwB,CACpC,YAAuC,EACvC,eAA8C;IAE9C,MAAM,MAAM,GAAkC,EAAE,GAAG,eAAe,EAAE,CAAC;IAErE,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;IACpC,CAAC;IAED,IAAI,YAAY,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACtC,MAAM,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;IAC5C,CAAC;IAED,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED,SAAgB,2BAA2B,CACvC,YAAuC,EACvC,eAA8C;IAE9C,MAAM,MAAM,GAAG,wBAAwB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IACvE,MAAM,gBAAgB,GAAG,mCAAmC,CAAC,YAAY,CAAC,CAAC;IAC3E,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAE7C,IAAI,MAAM,CAAC,gBAAgB,CAAC,KAAK,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACX,sGAAsG,CACzG,CAAC;IACN,CAAC;IAED,IAAI,eAAe,CAAC,QAAQ,KAAK,SAAS,IAAI,YAAY,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChF,MAAM,IAAI,KAAK,CAAC,0FAA0F,CAAC,CAAC;IAChH,CAAC;IAED,IACI,eAAe,CAAC,QAAQ,KAAK,SAAS;QACtC,YAAY,CAAC,QAAQ,KAAK,SAAS;QACnC,eAAe,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ,EACpD,CAAC;QACC,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;IACtG,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAEM,MAAM,aAAa,GAAG,CAAC,OAAwB,wCAAoB,EAA6B,EAAE,CACrG,IAAA,eAAM,EAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AADrB,QAAA,aAAa,iBACQ"}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@nestwork/chevron",
+  "version": "1.0.0",
+  "description": "Lightweight feature-flag module for NestJS with async resolvers, pluggable storage, and named or global gates",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/malyshev/chevron.git"
+  },
+  "keywords": [
+    "nestjs",
+    "nest",
+    "nodejs",
+    "feature",
+    "flags",
+    "feature-flags",
+    "feature-toggles"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.build.json",
+    "build:all": "pnpm run build && pnpm run -r build",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "dev:sample": "pnpm run build && concurrently -n src,sample -c blue,green \"pnpm dev\" \"pnpm --dir sample/000-in-memory-app dev\"",
+    "test": "TZ=UTC jest",
+    "test:all": "pnpm run test && pnpm run -r --if-present test",
+    "lint": "eslint \"src/**/*.ts\" --no-error-on-unmatched-pattern",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix --no-error-on-unmatched-pattern",
+    "check-types": "tsc -p tsconfig.build.json --noEmit",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "format": "prettier --write \"**/*.{ts,tsx,md,json,mjs,yaml,yml}\"",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "pnpm build && changeset publish",
+    "prepare": "husky"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "catalog:",
+    "@nestjs/core": "catalog:"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.0",
+    "@eslint/js": "^10.0.1",
+    "@nestjs/common": "catalog:",
+    "@nestjs/core": "catalog:",
+    "@nestjs/testing": "catalog:",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.0",
+    "concurrently": "^9.2.1",
+    "eslint": "^10.10.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "globals": "^17.12.0",
+    "husky": "^9.1.7",
+    "jest": "^30.2.0",
+    "lint-staged": "^15.5.2",
+    "prettier": "^3.9.6",
+    "reflect-metadata": "catalog:",
+    "rimraf": "^6.0.1",
+    "rxjs": "catalog:",
+    "ts-jest": "^29.4.6",
+    "typescript": "catalog:typescript",
+    "typescript-eslint": "^8.69.0"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "*.{md,json,mjs,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "packageManager": "pnpm@11.25.0",
+  "engines": {
+    "node": ">=20"
+  }
+}