@terreno/feature-flags 57.0.0 → 57.2.0

package/dist/featureFlagModel.d.ts

@@ -1,22 +1,5 @@
 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[];

package/dist/featureFlagModel.js

@@ -171,9 +171,19 @@ exports.FeatureFlag = mongoose_1.default.model("FeatureFlag", featureFlagSchema)
  *   .start();
  * ```
  */
-exports.featureFlagAdminConfig = {
+var featureFlagAdminConfigValue = {
     displayName: "Feature Flags",
     listFields: ["key", "name", "type", "enabled", "archived", "defaultVariant", "created"],
     model: exports.FeatureFlag,
     routePath: "/feature-flags",
 };
+var warnedLegacyAdminConfigs = new WeakSet();
+exports.featureFlagAdminConfig = new Proxy(featureFlagAdminConfigValue, {
+    get: function (target, property, receiver) {
+        if (!warnedLegacyAdminConfigs.has(target)) {
+            warnedLegacyAdminConfigs.add(target);
+            api_1.logger.warn("[feature-flags] featureFlagAdminConfig is deprecated. Use new FeatureFlagsApp() and register it with TerrenoApp — see docs/how-to/admin-import-prebuilt.md");
+        }
+        return Reflect.get(target, property, receiver);
+    },
+});

package/dist/featureFlagsApp.d.ts

@@ -1,4 +1,4 @@
-import { type TerrenoPlugin } from "@terreno/api";
+import { type AdminContribution, type TerrenoPlugin } from "@terreno/api";
 import type express from "express";
 import type { FeatureFlagsOptions } from "./types";
 /**
@@ -24,5 +24,6 @@ export declare class FeatureFlagsApp implements TerrenoPlugin {
     private segments;
     private mongoProvider?;
     constructor(options?: FeatureFlagsOptions);
+    adminContribution(): AdminContribution;
     register(app: express.Application, openApi?: unknown): void;
 }

package/dist/featureFlagsApp.js

@@ -101,6 +101,24 @@ var FeatureFlagsApp = /** @class */ (function () {
         this.options = options !== null && options !== void 0 ? options : {};
         this.segments = (_a = this.options.segments) !== null && _a !== void 0 ? _a : {};
     }
+    FeatureFlagsApp.prototype.adminContribution = function () {
+        return {
+            homeWidgets: [{ displayName: "Flag Overrides", icon: "flag", id: "feature-flags-overrides" }],
+            models: [
+                {
+                    admin: {
+                        defaultSort: "-created",
+                        displayName: "Feature Flags",
+                        listFields: ["key", "name", "type", "enabled", "archived", "defaultVariant", "created"],
+                        searchFields: ["key", "name"],
+                        sortableFields: ["key", "name", "type", "enabled", "archived", "created"],
+                    },
+                    model: featureFlagModel_1.FeatureFlag,
+                    routePath: "/feature-flags",
+                },
+            ],
+        };
+    };
     FeatureFlagsApp.prototype.register = function (app, openApi) {
         var _this = this;
         var _a, _b, _c, _d;

package/package.json

@@ -5,15 +5,15 @@
   },
   "dependencies": {
     "@openfeature/server-sdk": "^1.22.0",
-    "@terreno/api": "57.0.0",
+    "@terreno/api": "57.2.0",
     "express": "^5.2.1",
     "lodash": "^4.18.1"
   },
   "description": "Feature flags and A/B testing plugin for @terreno/api",
   "devDependencies": {
     "@biomejs/biome": "^2.3.6",
-    "@terreno/test": "57.0.0",
-    "@types/bun": "^1.3.8",
+    "@terreno/test": "57.2.0",
+    "@types/bun": "^1.4.0",
     "@types/express": "^5.0.6",
     "@types/lodash": "^4.17.17",
     "@types/supertest": "^7.2.0",
@@ -49,9 +49,10 @@
     "lint": "biome check ./src",
     "lint:fix": "biome check --write ./src",
     "test": "bun test",
+    "test:agent": "AGENT=1 bun test --only-failures",
     "test:ci": "bun test",
     "test:coverage": "bun run ../scripts/check-coverage.ts"
   },
   "types": "dist/index.d.ts",
-  "version": "57.0.0"
+  "version": "57.2.0"
 }

package/src/featureFlagModel.ts

@@ -4,6 +4,7 @@ import {
   findExactlyOne,
   findOneOrNone,
   isDeletedPlugin,
+  logger,
 } from "@terreno/api";
 import mongoose from "mongoose";
 import type {FeatureFlagDocument, FeatureFlagModel} from "./types";
@@ -193,9 +194,23 @@ export const FeatureFlag = mongoose.model<FeatureFlagDocument, FeatureFlagModel>
  *   .start();
  * ```
  */
-export const featureFlagAdminConfig = {
+const featureFlagAdminConfigValue = {
   displayName: "Feature Flags",
   listFields: ["key", "name", "type", "enabled", "archived", "defaultVariant", "created"],
   model: FeatureFlag,
   routePath: "/feature-flags",
 };
+
+const warnedLegacyAdminConfigs = new WeakSet<object>();
+
+export const featureFlagAdminConfig = new Proxy(featureFlagAdminConfigValue, {
+  get(target, property, receiver) {
+    if (!warnedLegacyAdminConfigs.has(target)) {
+      warnedLegacyAdminConfigs.add(target);
+      logger.warn(
+        "[feature-flags] featureFlagAdminConfig is deprecated. Use new FeatureFlagsApp() and register it with TerrenoApp — see docs/how-to/admin-import-prebuilt.md"
+      );
+    }
+    return Reflect.get(target, property, receiver);
+  },
+});

package/src/featureFlagsApp.ts

@@ -1,5 +1,6 @@
 import {OpenFeature} from "@openfeature/server-sdk";
 import {
+  type AdminContribution,
   APIError,
   asyncHandler,
   authenticateMiddleware,
@@ -66,6 +67,25 @@ export class FeatureFlagsApp implements TerrenoPlugin {
     this.segments = this.options.segments ?? {};
   }
 
+  adminContribution(): AdminContribution {
+    return {
+      homeWidgets: [{displayName: "Flag Overrides", icon: "flag", id: "feature-flags-overrides"}],
+      models: [
+        {
+          admin: {
+            defaultSort: "-created",
+            displayName: "Feature Flags",
+            listFields: ["key", "name", "type", "enabled", "archived", "defaultVariant", "created"],
+            searchFields: ["key", "name"],
+            sortableFields: ["key", "name", "type", "enabled", "archived", "created"],
+          },
+          model: FeatureFlag as Model<FeatureFlagDocument>,
+          routePath: "/feature-flags",
+        },
+      ],
+    };
+  }
+
   register(app: express.Application, openApi?: unknown): void {
     const basePath = this.options.basePath ?? "/feature-flags";
     const openFeatureDomain = this.options.openFeatureDomain ?? "feature-flags";

package/src/tests/featureFlagsApp.test.ts

@@ -48,6 +48,18 @@ describe("FeatureFlagsApp", () => {
   });
 
   describe("construction", () => {
+    it("contributes FeatureFlag admin metadata and the overrides home widget", () => {
+      const contribution = new FeatureFlagsApp().adminContribution();
+
+      expect(contribution.models).toHaveLength(1);
+      expect(contribution.models?.[0]?.model).toBe(FeatureFlag);
+      expect(contribution.models?.[0]?.routePath).toBe("/feature-flags");
+      expect(contribution.models?.[0]?.admin.displayName).toBe("Feature Flags");
+      expect(contribution.homeWidgets).toEqual([
+        {displayName: "Flag Overrides", icon: "flag", id: "feature-flags-overrides"},
+      ]);
+    });
+
     it("defaults basePath to /feature-flags and segments to an empty object", async () => {
       app = buildApp();
       adminAgent = await authAsUser(app, "admin");