@terreno/feature-flags 0.12.1 → 0.13.0

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/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/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/FlourishHealth/terreno/issues"
   },
   "dependencies": {
-    "@terreno/api": "0.12.1",
+    "@terreno/api": "0.13.0",
     "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.1"
+  "version": "0.13.0"
 }

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/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",
+    ]);
+  });
+});