@terreno/feature-flags 0.12.0 → 0.12.2

package/dist/featureFlagModel.d.ts

@@ -1,2 +1,25 @@
 import type { FeatureFlagModel } from "./types";
 export declare const FeatureFlag: FeatureFlagModel;
+/**
+ * Pre-configured admin model config for the FeatureFlag model.
+ *
+ * Pass this directly to `AdminApp({ models: [...] })` so downstream consumers
+ * don't have to manually configure displayName, listFields, and routePath.
+ *
+ * @example
+ * ```typescript
+ * import {featureFlagAdminConfig} from "@terreno/feature-flags";
+ * import {AdminApp} from "@terreno/admin-backend";
+ *
+ * new TerrenoApp({userModel: User})
+ *   .register(new FeatureFlagsApp({segments}))
+ *   .register(new AdminApp({models: [featureFlagAdminConfig]}))
+ *   .start();
+ * ```
+ */
+export declare const featureFlagAdminConfig: {
+    displayName: string;
+    listFields: string[];
+    model: FeatureFlagModel;
+    routePath: string;
+};

package/dist/featureFlagModel.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeatureFlag = void 0;
+exports.featureFlagAdminConfig = exports.FeatureFlag = void 0;
 var api_1 = require("@terreno/api");
 var mongoose_1 = __importDefault(require("mongoose"));
 var featureFlagSchema = new mongoose_1.default.Schema({
@@ -117,3 +117,26 @@ featureFlagSchema.pre("save", function () {
     }
 });
 exports.FeatureFlag = mongoose_1.default.model("FeatureFlag", featureFlagSchema);
+/**
+ * Pre-configured admin model config for the FeatureFlag model.
+ *
+ * Pass this directly to `AdminApp({ models: [...] })` so downstream consumers
+ * don't have to manually configure displayName, listFields, and routePath.
+ *
+ * @example
+ * ```typescript
+ * import {featureFlagAdminConfig} from "@terreno/feature-flags";
+ * import {AdminApp} from "@terreno/admin-backend";
+ *
+ * new TerrenoApp({userModel: User})
+ *   .register(new FeatureFlagsApp({segments}))
+ *   .register(new AdminApp({models: [featureFlagAdminConfig]}))
+ *   .start();
+ * ```
+ */
+exports.featureFlagAdminConfig = {
+    displayName: "Feature Flags",
+    listFields: ["key", "name", "type", "enabled", "archived", "created"],
+    model: exports.FeatureFlag,
+    routePath: "/feature-flags",
+};

package/dist/featureFlagsApp.js

@@ -77,9 +77,9 @@ var FeatureFlagsApp = /** @class */ (function () {
     }
     FeatureFlagsApp.prototype.register = function (app, openApi) {
         var _this = this;
-        var _a;
+        var _a, _b;
         var basePath = (_a = this.options.basePath) !== null && _a !== void 0 ? _a : "/feature-flags";
-        var routerOptions = __assign(__assign({}, (openApi ? { openApi: openApi } : {})), { permissions: {
+        var routerOptions = __assign(__assign({}, (openApi ? { openApi: openApi } : {})), { permissions: (_b = this.options.permissions) !== null && _b !== void 0 ? _b : {
                 create: [api_1.Permissions.IsAdmin],
                 delete: [api_1.Permissions.IsAdmin],
                 list: [api_1.Permissions.IsAdmin],
@@ -109,10 +109,13 @@ var FeatureFlagsApp = /** @class */ (function () {
         }); }));
         // GET /feature-flags/segments — list registered segment names (admin only)
         app.get("".concat(basePath, "/segments"), (0, api_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(_this, void 0, void 0, function () {
-            var user;
+            var user, allowed;
             return __generator(this, function (_a) {
                 user = req.user;
-                if (!(user === null || user === void 0 ? void 0 : user.admin)) {
+                allowed = this.options.segmentsPermission
+                    ? this.options.segmentsPermission(user)
+                    : Boolean(user === null || user === void 0 ? void 0 : user.admin);
+                if (!allowed) {
                     throw new api_1.APIError({ status: 403, title: "Only admins can view segments" });
                 }
                 return [2 /*return*/, res.json({ data: Object.keys(this.segments) })];

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { deterministicHash, evaluateAllFlags, evaluateFlag } from "./evaluate";
-export { FeatureFlag } from "./featureFlagModel";
+export { FeatureFlag, featureFlagAdminConfig } from "./featureFlagModel";
 export { FeatureFlagsApp } from "./featureFlagsApp";
 export type { EvaluationResult, FeatureFlagDocument, FeatureFlagModel, FeatureFlagRule, FeatureFlagsOptions, FeatureFlagType, FeatureFlagVariant, SegmentFunction, } from "./types";

package/dist/index.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeatureFlagsApp = exports.FeatureFlag = exports.evaluateFlag = exports.evaluateAllFlags = exports.deterministicHash = void 0;
+exports.FeatureFlagsApp = exports.featureFlagAdminConfig = exports.FeatureFlag = exports.evaluateFlag = exports.evaluateAllFlags = exports.deterministicHash = void 0;
 var evaluate_1 = require("./evaluate");
 Object.defineProperty(exports, "deterministicHash", { enumerable: true, get: function () { return evaluate_1.deterministicHash; } });
 Object.defineProperty(exports, "evaluateAllFlags", { enumerable: true, get: function () { return evaluate_1.evaluateAllFlags; } });
 Object.defineProperty(exports, "evaluateFlag", { enumerable: true, get: function () { return evaluate_1.evaluateFlag; } });
 var featureFlagModel_1 = require("./featureFlagModel");
 Object.defineProperty(exports, "FeatureFlag", { enumerable: true, get: function () { return featureFlagModel_1.FeatureFlag; } });
+Object.defineProperty(exports, "featureFlagAdminConfig", { enumerable: true, get: function () { return featureFlagModel_1.featureFlagAdminConfig; } });
 var featureFlagsApp_1 = require("./featureFlagsApp");
 Object.defineProperty(exports, "FeatureFlagsApp", { enumerable: true, get: function () { return featureFlagsApp_1.FeatureFlagsApp; } });

package/dist/tests/featureFlagModel.test.js

@@ -340,3 +340,18 @@ var featureFlagModel_1 = require("../featureFlagModel");
         });
     }); });
 });
+(0, bun_test_1.describe)("featureFlagAdminConfig", function () {
+    (0, bun_test_1.it)("has the expected shape for AdminApp registration", function () {
+        (0, bun_test_1.expect)(featureFlagModel_1.featureFlagAdminConfig.model).toBe(featureFlagModel_1.FeatureFlag);
+        (0, bun_test_1.expect)(featureFlagModel_1.featureFlagAdminConfig.routePath).toBe("/feature-flags");
+        (0, bun_test_1.expect)(featureFlagModel_1.featureFlagAdminConfig.displayName).toBe("Feature Flags");
+        (0, bun_test_1.expect)(featureFlagModel_1.featureFlagAdminConfig.listFields).toEqual([
+            "key",
+            "name",
+            "type",
+            "enabled",
+            "archived",
+            "created",
+        ]);
+    });
+});

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { FindExactlyOnePlugin, FindOneOrNonePlugin } from "@terreno/api";
+import type { FindExactlyOnePlugin, FindOneOrNonePlugin, ModelRouterOptions } from "@terreno/api";
 import type mongoose from "mongoose";
 export interface FeatureFlagVariant {
     key: string;
@@ -32,5 +32,18 @@ export type SegmentFunction = (user: unknown) => boolean;
 export interface FeatureFlagsOptions {
     basePath?: string;
     segments?: Record<string, SegmentFunction>;
+    /**
+     * Permission predicates that gate the admin CRUD routes for flags. When
+     * omitted, defaults to requiring `Permissions.IsAdmin` (i.e. `user.admin === true`)
+     * on every method. Provide this when consumers need role-based gating
+     * other than the boolean `admin` flag.
+     */
+    permissions?: ModelRouterOptions<FeatureFlagDocument>["permissions"];
+    /**
+     * Predicate used to gate the `/segments` admin endpoint. Receives the
+     * authenticated user and should return true to allow the request. Defaults
+     * to checking `user.admin === true` when not provided.
+     */
+    segmentsPermission?: (user: unknown) => boolean;
 }
 export type EvaluationResult = Record<string, boolean | string | null>;

package/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/FlourishHealth/terreno/issues"
   },
   "dependencies": {
-    "@terreno/api": "0.12.0",
+    "@terreno/api": "0.12.2",
     "express": "^5.2.1",
     "lodash": "^4.17.23"
   },
@@ -51,5 +51,5 @@
     "test:coverage": "bun run ../scripts/check-coverage.ts"
   },
   "types": "dist/index.d.ts",
-  "version": "0.12.0"
+  "version": "0.12.2"
 }

package/src/featureFlagModel.ts

@@ -136,3 +136,27 @@ export const FeatureFlag = mongoose.model<FeatureFlagDocument, FeatureFlagModel>
   "FeatureFlag",
   featureFlagSchema
 );
+
+/**
+ * Pre-configured admin model config for the FeatureFlag model.
+ *
+ * Pass this directly to `AdminApp({ models: [...] })` so downstream consumers
+ * don't have to manually configure displayName, listFields, and routePath.
+ *
+ * @example
+ * ```typescript
+ * import {featureFlagAdminConfig} from "@terreno/feature-flags";
+ * import {AdminApp} from "@terreno/admin-backend";
+ *
+ * new TerrenoApp({userModel: User})
+ *   .register(new FeatureFlagsApp({segments}))
+ *   .register(new AdminApp({models: [featureFlagAdminConfig]}))
+ *   .start();
+ * ```
+ */
+export const featureFlagAdminConfig = {
+  displayName: "Feature Flags",
+  listFields: ["key", "name", "type", "enabled", "archived", "created"],
+  model: FeatureFlag,
+  routePath: "/feature-flags",
+};

package/src/featureFlagsApp.ts

@@ -45,7 +45,7 @@ export class FeatureFlagsApp implements TerrenoPlugin {
     const basePath = this.options.basePath ?? "/feature-flags";
     const routerOptions: ModelRouterOptions<FeatureFlagDocument> = {
       ...(openApi ? {openApi: openApi as OpenApiMiddleware} : {}),
-      permissions: {
+      permissions: this.options.permissions ?? {
         create: [Permissions.IsAdmin],
         delete: [Permissions.IsAdmin],
         list: [Permissions.IsAdmin],
@@ -83,8 +83,11 @@ export class FeatureFlagsApp implements TerrenoPlugin {
       `${basePath}/segments`,
       authenticateMiddleware(),
       asyncHandler(async (req: express.Request, res: express.Response) => {
-        const user = req.user as {admin?: boolean} | undefined;
-        if (!user?.admin) {
+        const user = req.user;
+        const allowed = this.options.segmentsPermission
+          ? this.options.segmentsPermission(user)
+          : Boolean((user as {admin?: boolean} | undefined)?.admin);
+        if (!allowed) {
           throw new APIError({status: 403, title: "Only admins can view segments"});
         }
 

package/src/index.ts

@@ -1,5 +1,5 @@
 export {deterministicHash, evaluateAllFlags, evaluateFlag} from "./evaluate";
-export {FeatureFlag} from "./featureFlagModel";
+export {FeatureFlag, featureFlagAdminConfig} from "./featureFlagModel";
 export {FeatureFlagsApp} from "./featureFlagsApp";
 export type {
   EvaluationResult,

package/src/tests/featureFlagModel.test.ts

@@ -1,5 +1,5 @@
 import {afterEach, describe, expect, it} from "bun:test";
-import {FeatureFlag} from "../featureFlagModel";
+import {FeatureFlag, featureFlagAdminConfig} from "../featureFlagModel";
 
 describe("FeatureFlag model", () => {
   afterEach(async () => {
@@ -203,3 +203,19 @@ describe("FeatureFlag model", () => {
     expect(maybe).toBeNull();
   });
 });
+
+describe("featureFlagAdminConfig", () => {
+  it("has the expected shape for AdminApp registration", () => {
+    expect(featureFlagAdminConfig.model).toBe(FeatureFlag);
+    expect(featureFlagAdminConfig.routePath).toBe("/feature-flags");
+    expect(featureFlagAdminConfig.displayName).toBe("Feature Flags");
+    expect(featureFlagAdminConfig.listFields).toEqual([
+      "key",
+      "name",
+      "type",
+      "enabled",
+      "archived",
+      "created",
+    ]);
+  });
+});

package/src/types.ts

@@ -1,4 +1,4 @@
-import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "@terreno/api";
+import type {FindExactlyOnePlugin, FindOneOrNonePlugin, ModelRouterOptions} from "@terreno/api";
 import type mongoose from "mongoose";
 
 export interface FeatureFlagVariant {
@@ -41,6 +41,19 @@ export type SegmentFunction = (user: unknown) => boolean;
 export interface FeatureFlagsOptions {
   basePath?: string;
   segments?: Record<string, SegmentFunction>;
+  /**
+   * Permission predicates that gate the admin CRUD routes for flags. When
+   * omitted, defaults to requiring `Permissions.IsAdmin` (i.e. `user.admin === true`)
+   * on every method. Provide this when consumers need role-based gating
+   * other than the boolean `admin` flag.
+   */
+  permissions?: ModelRouterOptions<FeatureFlagDocument>["permissions"];
+  /**
+   * Predicate used to gate the `/segments` admin endpoint. Receives the
+   * authenticated user and should return true to allow the request. Defaults
+   * to checking `user.admin === true` when not provided.
+   */
+  segmentsPermission?: (user: unknown) => boolean;
 }
 
 export type EvaluationResult = Record<string, boolean | string | null>;