@brandtg/flapjack 1.3.0 → 1.5.0

package/migrations/1779210257698_add-feature-flag-subjects.js

@@ -0,0 +1,93 @@
+/**
+ * @type {import('node-pg-migrate').ColumnDefinitions | undefined}
+ */
+export const shorthands = undefined;
+
+/**
+ * @param pgm {import('node-pg-migrate').MigrationBuilder}
+ * @param run {() => void | undefined}
+ * @returns {Promise<void> | void}
+ */
+export const up = (pgm) => {
+  pgm.createTable(
+    { schema: "flapjack", name: "feature_flag_subject" },
+    {
+      id: "id",
+      feature_flag_id: {
+        type: "integer",
+        notNull: true,
+        references: { schema: "flapjack", name: "feature_flag" },
+        onDelete: "CASCADE",
+      },
+      subject: { type: "text", notNull: true },
+      created: {
+        type: "timestamptz",
+        notNull: true,
+        default: pgm.func("now()"),
+      },
+    },
+  );
+
+  pgm.addConstraint(
+    { schema: "flapjack", name: "feature_flag_subject" },
+    "unique_feature_flag_subject",
+    {
+      unique: ["feature_flag_id", "subject"],
+    },
+  );
+
+  pgm.createIndex(
+    { schema: "flapjack", name: "feature_flag_subject" },
+    "feature_flag_id",
+  );
+  pgm.createIndex(
+    { schema: "flapjack", name: "feature_flag_subject" },
+    "subject",
+  );
+
+  pgm.createTable(
+    { schema: "flapjack", name: "feature_flag_group_subject" },
+    {
+      id: "id",
+      feature_flag_group_id: {
+        type: "integer",
+        notNull: true,
+        references: { schema: "flapjack", name: "feature_flag_group" },
+        onDelete: "CASCADE",
+      },
+      subject: { type: "text", notNull: true },
+      created: {
+        type: "timestamptz",
+        notNull: true,
+        default: pgm.func("now()"),
+      },
+    },
+  );
+
+  pgm.addConstraint(
+    { schema: "flapjack", name: "feature_flag_group_subject" },
+    "unique_feature_flag_group_subject",
+    {
+      unique: ["feature_flag_group_id", "subject"],
+    },
+  );
+
+  pgm.createIndex(
+    { schema: "flapjack", name: "feature_flag_group_subject" },
+    "feature_flag_group_id",
+  );
+  pgm.createIndex(
+    { schema: "flapjack", name: "feature_flag_group_subject" },
+    "subject",
+  );
+};
+
+/**
+ * @param pgm {import('node-pg-migrate').MigrationBuilder}
+ * @param run {() => void | undefined}
+ * @returns {Promise<void> | void}
+ */
+export const down = (pgm) => {
+  pgm.dropTable({ schema: "flapjack", name: "feature_flag_group_subject" });
+  pgm.dropTable({ schema: "flapjack", name: "feature_flag_subject" });
+};

package/migrations/1781107651000_add-feature-flag-tags.js

@@ -0,0 +1,38 @@
+/**
+ * @type {import('node-pg-migrate').ColumnDefinitions | undefined}
+ */
+export const shorthands = undefined;
+
+/**
+ * @param pgm {import('node-pg-migrate').MigrationBuilder}
+ * @param run {() => void | undefined}
+ * @returns {Promise<void> | void}
+ */
+export const up = (pgm) => {
+  pgm.addColumn(
+    { schema: "flapjack", name: "feature_flag" },
+    {
+      tags: {
+        type: "text[]",
+        default: pgm.func("'{}'::text[]"),
+      },
+    },
+  );
+
+  // GIN index for efficient lookups by tag (e.g. WHERE $1 = ANY(tags))
+  pgm.createIndex({ schema: "flapjack", name: "feature_flag" }, "tags", {
+    method: "gin",
+  });
+};
+
+/**
+ * @param pgm {import('node-pg-migrate').MigrationBuilder}
+ * @param run {() => void | undefined}
+ * @returns {Promise<void> | void}
+ */
+export const down = (pgm) => {
+  pgm.dropIndex({ schema: "flapjack", name: "feature_flag" }, "tags", {
+    method: "gin",
+  });
+  pgm.dropColumn({ schema: "flapjack", name: "feature_flag" }, "tags");
+};

package/migrations/1781200000000_add-archived.js

@@ -0,0 +1,37 @@
+/**
+ * @type {import('node-pg-migrate').ColumnDefinitions | undefined}
+ */
+export const shorthands = undefined;
+
+/**
+ * @param pgm {import('node-pg-migrate').MigrationBuilder}
+ * @param run {() => void | undefined}
+ * @returns {Promise<void> | void}
+ */
+export const up = (pgm) => {
+  // Add a nullable archived timestamp to the core data models. When set, the
+  // record is considered archived (hidden) but kept for historical/audit
+  // purposes. Archiving is irreversible and the name remains reserved forever
+  // (the existing UNIQUE(name) constraint is intentionally left unchanged).
+  pgm.addColumn(
+    { schema: "flapjack", name: "feature_flag" },
+    { archived: { type: "timestamptz" } },
+  );
+  pgm.addColumn(
+    { schema: "flapjack", name: "feature_flag_group" },
+    { archived: { type: "timestamptz" } },
+  );
+};
+
+/**
+ * @param pgm {import('node-pg-migrate').MigrationBuilder}
+ * @param run {() => void | undefined}
+ * @returns {Promise<void> | void}
+ */
+export const down = (pgm) => {
+  pgm.dropColumn({ schema: "flapjack", name: "feature_flag" }, "archived");
+  pgm.dropColumn(
+    { schema: "flapjack", name: "feature_flag_group" },
+    "archived",
+  );
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brandtg/flapjack",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "A simple feature flags library with PostgreSQL integration",
   "type": "module",
   "main": "./dist/index.js",
@@ -27,7 +27,7 @@
     "clean": "rm -rf dist",
     "dev": "npx tsc --watch",
     "dev:env": "bash bin/dev/env.sh",
-    "dev:migrate": "npx dotenv-cli -e env -- node-pg-migrate up",
+    "dev:migrate": "npx dotenv-cli -e .env -- node-pg-migrate up -s flapjack --create-schema -t pgmigrations",
     "dev:docker:up": "docker compose -f docker-compose.yml up -d",
     "dev:docker:down": "docker compose -f docker-compose.yml down -v",
     "create-migration": "npx node-pg-migrate create --",