@brandtg/flapjack 0.2.0 → 1.0.0

package/dist/migrate.d.ts

@@ -4,21 +4,16 @@
 export interface MigrationOptions {
     /** PostgreSQL connection URL (e.g., "postgresql://user:pass@localhost/dbname") */
     databaseUrl: string;
-    /** Name of the migrations tracking table (default: 'pgmigrations') */
-    migrationsTable?: string;
-    /** Schema name to create tables in (optional) */
-    schema?: string;
 }
 /**
  * Run Flapjack database migrations.
  *
  * This function applies all pending migrations to create or update the
- * flapjack_feature_flag table in your PostgreSQL database.
+ * flapjack.feature_flag table in your PostgreSQL database. All tables,
+ * including the migrations tracking table, are created in the flapjack schema.
  *
  * @param options - Migration configuration options
  * @param options.databaseUrl - PostgreSQL connection URL
- * @param options.migrationsTable - Name of the migrations tracking table (default: 'pgmigrations')
- * @param options.schema - Schema name to create tables in (optional)
  * @returns Promise that resolves when migrations are complete
  *
  * @throws Will throw an error if the database connection fails or migrations cannot be applied
@@ -27,22 +22,9 @@ export interface MigrationOptions {
  * ```typescript
  * import { runMigrations } from "@brandtg/flapjack";
  *
- * // Basic usage
  * await runMigrations({
  *   databaseUrl: process.env.DATABASE_URL,
  * });
- *
- * // With custom migrations table
- * await runMigrations({
- *   databaseUrl: process.env.DATABASE_URL,
- *   migrationsTable: "my_migrations",
- * });
- *
- * // With custom schema
- * await runMigrations({
- *   databaseUrl: process.env.DATABASE_URL,
- *   schema: "feature_flags",
- * });
  * ```
  */
 export declare function runMigrations(options: MigrationOptions): Promise<void>;

package/dist/migrate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrate.d.ts","sourceRoot":"","sources":["../src/migrate.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB5E"}
+{"version":3,"file":"migrate.d.ts","sourceRoot":"","sources":["../src/migrate.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAiB5E"}

package/dist/migrate.js

@@ -7,12 +7,11 @@ const __dirname = path.dirname(__filename);
  * Run Flapjack database migrations.
  *
  * This function applies all pending migrations to create or update the
- * flapjack_feature_flag table in your PostgreSQL database.
+ * flapjack.feature_flag table in your PostgreSQL database. All tables,
+ * including the migrations tracking table, are created in the flapjack schema.
  *
  * @param options - Migration configuration options
  * @param options.databaseUrl - PostgreSQL connection URL
- * @param options.migrationsTable - Name of the migrations tracking table (default: 'pgmigrations')
- * @param options.schema - Schema name to create tables in (optional)
  * @returns Promise that resolves when migrations are complete
  *
  * @throws Will throw an error if the database connection fails or migrations cannot be applied
@@ -21,34 +20,22 @@ const __dirname = path.dirname(__filename);
  * ```typescript
  * import { runMigrations } from "@brandtg/flapjack";
  *
- * // Basic usage
  * await runMigrations({
  *   databaseUrl: process.env.DATABASE_URL,
  * });
- *
- * // With custom migrations table
- * await runMigrations({
- *   databaseUrl: process.env.DATABASE_URL,
- *   migrationsTable: "my_migrations",
- * });
- *
- * // With custom schema
- * await runMigrations({
- *   databaseUrl: process.env.DATABASE_URL,
- *   schema: "feature_flags",
- * });
  * ```
  */
 export async function runMigrations(options) {
-    const { databaseUrl, migrationsTable = "pgmigrations", schema } = options;
+    const { databaseUrl } = options;
     // Path to migrations directory (relative to dist in production)
     const migrationsDir = path.resolve(__dirname, "../migrations");
     const migrationConfig = {
         databaseUrl,
         dir: migrationsDir,
         direction: "up",
-        migrationsTable,
-        ...(schema && { schema }),
+        schema: "flapjack",
+        migrationsTable: "pgmigrations",
+        createSchema: true,
         verbose: false,
     };
     await runner(migrationConfig);

package/dist/model.js

@@ -1,5 +1,5 @@
 import MurmurHash3 from "imurmurhash";
-const TABLE = "flapjack_feature_flag";
+const TABLE = "flapjack.feature_flag";
 const COLUMNS = [
     "id",
     "name",
@@ -406,8 +406,8 @@ export class FeatureFlagModel {
         return false;
     }
 }
-const GROUP_TABLE = "flapjack_feature_flag_group";
-const GROUP_MEMBER_TABLE = "flapjack_feature_flag_group_member";
+const GROUP_TABLE = "flapjack.feature_flag_group";
+const GROUP_MEMBER_TABLE = "flapjack.feature_flag_group_member";
 const GROUP_COLUMNS = ["id", "name", "note", "created", "modified"];
 function mapGroupRow(row) {
     return {

package/migrations/1759720355601_create-feature-flag.js

@@ -9,30 +9,37 @@ export const shorthands = undefined;
  * @returns {Promise<void> | void}
  */
 export const up = (pgm) => {
-  // Create the flapjack_feature_flag table
-  pgm.createTable("flapjack_feature_flag", {
-    id: "id",
-    name: { type: "text", notNull: true, unique: true },
-    everyone: { type: "boolean" },
-    percent: {
-      type: "numeric(3,1)",
-      check: "percent >= 0 AND percent <= 99.9",
+  // Create the feature_flag table (schema created by node-pg-migrate)
+  pgm.createTable(
+    { schema: "flapjack", name: "feature_flag" },
+    {
+      id: "id",
+      name: { type: "text", notNull: true, unique: true },
+      everyone: { type: "boolean" },
+      percent: {
+        type: "numeric(3,1)",
+        check: "percent >= 0 AND percent <= 99.9",
+      },
+      roles: { type: "text[]", default: pgm.func("'{}'::text[]") },
+      groups: { type: "text[]", default: pgm.func("'{}'::text[]") },
+      users: { type: "text[]", default: pgm.func("'{}'::text[]") },
+      note: { type: "text" },
+      created: {
+        type: "timestamptz",
+        notNull: true,
+        default: pgm.func("now()"),
+      },
+      modified: {
+        type: "timestamptz",
+        notNull: true,
+        default: pgm.func("now()"),
+      },
     },
-    roles: { type: "text[]", default: pgm.func("'{}'::text[]") },
-    groups: { type: "text[]", default: pgm.func("'{}'::text[]") },
-    users: { type: "text[]", default: pgm.func("'{}'::text[]") },
-    note: { type: "text" },
-    created: { type: "timestamptz", notNull: true, default: pgm.func("now()") },
-    modified: {
-      type: "timestamptz",
-      notNull: true,
-      default: pgm.func("now()"),
-    },
-  });
+  );
 
   // Create a trigger to update the modified timestamp on row update
   pgm.sql(`
-    CREATE OR REPLACE FUNCTION flapjack_set_modified_timestamp()
+    CREATE OR REPLACE FUNCTION flapjack.set_modified_timestamp()
     RETURNS trigger AS $$
     BEGIN
     NEW.modified = now();
@@ -41,12 +48,12 @@ export const up = (pgm) => {
     $$ LANGUAGE plpgsql;
   `);
 
-  // Attach the trigger to the flapjack_feature_flag table
+  // Attach the trigger to the feature_flag table
   pgm.sql(`
-    CREATE TRIGGER flapjack_feature_flag_set_modified
-    BEFORE UPDATE ON flapjack_feature_flag
+    CREATE TRIGGER feature_flag_set_modified
+    BEFORE UPDATE ON flapjack.feature_flag
     FOR EACH ROW
-    EXECUTE FUNCTION flapjack_set_modified_timestamp();
+    EXECUTE FUNCTION flapjack.set_modified_timestamp();
   `);
 };
 
@@ -57,9 +64,9 @@ export const up = (pgm) => {
  */
 export const down = (pgm) => {
   pgm.sql(`
-    DROP TRIGGER IF EXISTS flapjack_feature_flag_set_modified 
-    ON flapjack_feature_flag;
+    DROP TRIGGER IF EXISTS feature_flag_set_modified 
+    ON flapjack.feature_flag;
   `);
-  pgm.sql(`DROP FUNCTION IF EXISTS flapjack_set_modified_timestamp;`);
-  pgm.dropTable("flapjack_feature_flag");
+  pgm.sql(`DROP FUNCTION IF EXISTS flapjack.set_modified_timestamp;`);
+  pgm.dropTable({ schema: "flapjack", name: "feature_flag" });
 };

package/migrations/1760502793520_add-feature-flag-expires.js

@@ -9,9 +9,12 @@ export const shorthands = undefined;
  * @returns {Promise<void> | void}
  */
 export const up = (pgm) => {
-  pgm.addColumn("flapjack_feature_flag", {
-    expires: { type: "timestamptz" },
-  });
+  pgm.addColumn(
+    { schema: "flapjack", name: "feature_flag" },
+    {
+      expires: { type: "timestamptz" },
+    },
+  );
 };
 
 /**
@@ -20,5 +23,5 @@ export const up = (pgm) => {
  * @returns {Promise<void> | void}
  */
 export const down = (pgm) => {
-  pgm.dropColumn("flapjack_feature_flag", "expires");
+  pgm.dropColumn({ schema: "flapjack", name: "feature_flag" }, "expires");
 };

package/migrations/1764560643657_add-feature-flag-groups.js

@@ -9,40 +9,54 @@ export const shorthands = undefined;
  * @returns {Promise<void> | void}
  */
 export const up = (pgm) => {
-  // Create the flapjack_feature_flag_group table
-  pgm.createTable("flapjack_feature_flag_group", {
-    id: "id",
-    name: { type: "text", notNull: true, unique: true },
-    note: { type: "text" },
-    created: { type: "timestamptz", notNull: true, default: pgm.func("now()") },
-    modified: {
-      type: "timestamptz",
-      notNull: true,
-      default: pgm.func("now()"),
+  // Create the feature_flag_group table
+  pgm.createTable(
+    { schema: "flapjack", name: "feature_flag_group" },
+    {
+      id: "id",
+      name: { type: "text", notNull: true, unique: true },
+      note: { type: "text" },
+      created: {
+        type: "timestamptz",
+        notNull: true,
+        default: pgm.func("now()"),
+      },
+      modified: {
+        type: "timestamptz",
+        notNull: true,
+        default: pgm.func("now()"),
+      },
     },
-  });
+  );
 
-  // Create the flapjack_feature_flag_group_member relation table
-  pgm.createTable("flapjack_feature_flag_group_member", {
-    id: "id",
-    group_id: {
-      type: "integer",
-      notNull: true,
-      references: "flapjack_feature_flag_group",
-      onDelete: "CASCADE",
-    },
-    feature_flag_id: {
-      type: "integer",
-      notNull: true,
-      references: "flapjack_feature_flag",
-      onDelete: "CASCADE",
+  // Create the feature_flag_group_member relation table
+  pgm.createTable(
+    { schema: "flapjack", name: "feature_flag_group_member" },
+    {
+      id: "id",
+      group_id: {
+        type: "integer",
+        notNull: true,
+        references: { schema: "flapjack", name: "feature_flag_group" },
+        onDelete: "CASCADE",
+      },
+      feature_flag_id: {
+        type: "integer",
+        notNull: true,
+        references: { schema: "flapjack", name: "feature_flag" },
+        onDelete: "CASCADE",
+      },
+      created: {
+        type: "timestamptz",
+        notNull: true,
+        default: pgm.func("now()"),
+      },
     },
-    created: { type: "timestamptz", notNull: true, default: pgm.func("now()") },
-  });
+  );
 
   // Add unique constraint on group_id and feature_flag_id
   pgm.addConstraint(
-    "flapjack_feature_flag_group_member",
+    { schema: "flapjack", name: "feature_flag_group_member" },
     "unique_group_feature_flag",
     {
       unique: ["group_id", "feature_flag_id"],
@@ -50,15 +64,21 @@ export const up = (pgm) => {
   );
 
   // Create indexes for efficient lookups
-  pgm.createIndex("flapjack_feature_flag_group_member", "group_id");
-  pgm.createIndex("flapjack_feature_flag_group_member", "feature_flag_id");
+  pgm.createIndex(
+    { schema: "flapjack", name: "feature_flag_group_member" },
+    "group_id",
+  );
+  pgm.createIndex(
+    { schema: "flapjack", name: "feature_flag_group_member" },
+    "feature_flag_id",
+  );
 
   // Attach the modified timestamp trigger to the group table
   pgm.sql(`
-    CREATE TRIGGER flapjack_feature_flag_group_set_modified
-    BEFORE UPDATE ON flapjack_feature_flag_group
+    CREATE TRIGGER feature_flag_group_set_modified
+    BEFORE UPDATE ON flapjack.feature_flag_group
     FOR EACH ROW
-    EXECUTE FUNCTION flapjack_set_modified_timestamp();
+    EXECUTE FUNCTION flapjack.set_modified_timestamp();
   `);
 };
 
@@ -69,9 +89,9 @@ export const up = (pgm) => {
  */
 export const down = (pgm) => {
   pgm.sql(`
-    DROP TRIGGER IF EXISTS flapjack_feature_flag_group_set_modified 
-    ON flapjack_feature_flag_group;
+    DROP TRIGGER IF EXISTS feature_flag_group_set_modified 
+    ON flapjack.feature_flag_group;
   `);
-  pgm.dropTable("flapjack_feature_flag_group_member");
-  pgm.dropTable("flapjack_feature_flag_group");
+  pgm.dropTable({ schema: "flapjack", name: "feature_flag_group_member" });
+  pgm.dropTable({ schema: "flapjack", name: "feature_flag_group" });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brandtg/flapjack",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "A simple feature flags library with PostgreSQL integration",
   "type": "module",
   "main": "./dist/index.js",