pgflow 0.0.12 → 0.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgflow",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "type": "module",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -30,5 +30,8 @@
   "publishConfig": {
     "access": "public",
     "directory": "."
-  }
+  },
+  "files": [
+    "dist"
+  ]
 }

package/CHANGELOG.md

@@ -1,13 +0,0 @@
-# pgflow
-
-## 0.0.12
-
-### Patch Changes
-
-- 445d494: Fix the release pipeline
-
-## 0.0.11
-
-### Patch Changes
-
-- 81e19d2: Pre-alpha release of CLI tool

package/eslint.config.cjs

@@ -1,3 +0,0 @@
-const baseConfig = require('../../eslint.config.cjs');
-
-module.exports = [...baseConfig];

package/project.json

@@ -1,40 +0,0 @@
-{
-  "name": "cli",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "{projectRoot}/src",
-  "projectType": "library",
-  "tags": [],
-  "// targets": "to see all targets run: nx show project cli --web",
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "options": {
-        "main": "{projectRoot}/src/index.ts",
-        "tsConfig": "{projectRoot}/tsconfig.lib.json",
-        "outputPath": "{projectRoot}/dist",
-        "assets": [
-          {
-            "input": "pkgs/core/supabase/migrations",
-            "glob": "*.sql",
-            "output": "migrations"
-          }
-        ]
-      }
-    },
-    "serve": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "tsx src/index.ts",
-        "cwd": "{projectRoot}"
-      }
-    },
-    "test": {
-      "executor": "@nx/vite:test",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "passWithNoTests": true,
-        "reportsDirectory": "{workspaceRoot}/coverage/{projectRoot}"
-      }
-    }
-  }
-}

package/src/commands/install/copy-migrations.ts

@@ -1,101 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { log, confirm, note } from '@clack/prompts';
-import chalk from 'chalk';
-
-// Get the directory name in ES modules
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-// Path to the pgflow migrations
-const sourcePath = path.resolve(__dirname, '../../../migrations');
-
-export async function copyMigrations({
-  supabasePath,
-}: {
-  supabasePath: string;
-}): Promise<boolean> {
-  const migrationsPath = path.join(supabasePath, 'migrations');
-
-  if (!fs.existsSync(migrationsPath)) {
-    fs.mkdirSync(migrationsPath);
-  }
-
-  // Check if pgflow migrations directory exists
-  if (!fs.existsSync(sourcePath)) {
-    log.error(`Source migrations directory not found at ${sourcePath}`);
-    log.info(
-      "This might happen if you're running from source instead of the built package."
-    );
-    log.info('Try building the package first with: nx build cli');
-    return false;
-  }
-
-  const files = fs.readdirSync(sourcePath);
-  const filesToCopy: string[] = [];
-  const skippedFiles: string[] = [];
-
-  // Determine which files need to be copied
-  for (const file of files) {
-    const destination = path.join(migrationsPath, file);
-
-    if (fs.existsSync(destination)) {
-      skippedFiles.push(file);
-    } else {
-      filesToCopy.push(file);
-    }
-  }
-
-  // If no files to copy, show message and return false (no changes made)
-  if (filesToCopy.length === 0) {
-    log.info('No new migrations to copy - all migrations are already in place');
-    return false;
-  }
-
-  // Prepare summary message with colored output
-  const summaryParts = [];
-
-  if (filesToCopy.length > 0) {
-    summaryParts.push(`${chalk.green('Files to be copied:')}
-${filesToCopy.map((file) => `${chalk.green('+')} ${file}`).join('\n')}`);
-  }
-
-  if (skippedFiles.length > 0) {
-    summaryParts.push(`${chalk.yellow('Files to be skipped (already exist):')}
-${skippedFiles.map((file) => `${chalk.yellow('=')} ${file}`).join('\n')}`);
-  }
-
-  // Show summary and ask for confirmation
-  note(summaryParts.join('\n\n'), 'Migration Summary');
-
-  const shouldContinue = await confirm({
-    message: `Do you want to proceed with copying ${
-      filesToCopy.length
-    } migration file${filesToCopy.length !== 1 ? 's' : ''}?`,
-  });
-
-  if (!shouldContinue) {
-    log.info('Migration copy cancelled');
-    return false;
-  }
-
-  log.info(`Copying migrations`);
-
-  // Copy the files
-  for (const file of filesToCopy) {
-    const source = path.join(sourcePath, file);
-    const destination = path.join(migrationsPath, file);
-
-    fs.copyFileSync(source, destination);
-    log.step(`Copied ${file}`);
-  }
-
-  log.success(
-    `Successfully copied ${filesToCopy.length} migration file${
-      filesToCopy.length !== 1 ? 's' : ''
-    }`
-  );
-
-  return true; // Return true to indicate migrations were copied
-}

package/src/commands/install/index.ts

@@ -1,45 +0,0 @@
-import { type Command } from 'commander';
-import { intro, isCancel, log } from '@clack/prompts';
-import { copyMigrations } from './copy-migrations.js';
-import { updateConfigToml } from './update-config-toml.js';
-import { supabasePathPrompt } from './supabase-path-prompt.js';
-
-export default (program: Command) => {
-  program
-    .command('install')
-    .description('Copies migrations and sets config.toml values')
-    .action(async () => {
-      intro('pgflow - Postgres-native workflows for Supabase');
-
-      const supabasePath = await supabasePathPrompt();
-
-      if (isCancel(supabasePath)) {
-        log.error('Aborting installation');
-        return;
-      }
-
-      const migrationsCopied = await copyMigrations({ supabasePath });
-      const configUpdated = await updateConfigToml({ supabasePath });
-
-      if (migrationsCopied || configUpdated) {
-        log.success('pgflow installation is completed');
-      }
-
-      if (!migrationsCopied && !configUpdated) {
-        log.success(
-          'No changes were made - pgflow is already properly configured.'
-        );
-      }
-
-      // Show specific reminders based on what was actually done
-      if (configUpdated) {
-        log.warn(
-          'Remember to restart Supabase for the configuration changes to take effect!'
-        );
-      }
-
-      if (migrationsCopied) {
-        log.warn('Remember to apply the migrations!');
-      }
-    });
-};

package/src/commands/install/supabase-path-prompt.ts

@@ -1,28 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { text } from '@clack/prompts';
-
-export async function supabasePathPrompt() {
-  return await text({
-    message: 'Enter the path to your supabase/ directory',
-    placeholder: 'supabase/',
-    validate,
-  });
-}
-
-function validate(inputPath: string) {
-  const pathsToTest = [
-    [inputPath, 'is not a valid path'],
-    [path.join(inputPath, 'config.toml'), 'does not contain config.toml'],
-  ];
-
-  // if any of the pathsToTest fail, return the error message
-  for (const [testPath, errorMessage] of pathsToTest) {
-    if (!fs.existsSync(testPath)) {
-      return `${testPath} ${errorMessage}`;
-    }
-  }
-
-  // otherwise, return undefined
-  return undefined;
-}

package/src/commands/install/update-config-toml.ts

@@ -1,130 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { log, confirm, note } from '@clack/prompts';
-import * as TOML from 'toml-patch';
-import chalk from 'chalk';
-
-/**
- * Type definition for the parsed config.toml structure
- */
-type SupabaseConfig = {
-  db?: {
-    pooler?: {
-      enabled?: boolean;
-      pool_mode?: string;
-    };
-  };
-  edge_runtime?: {
-    policy?: string;
-  };
-};
-
-/**
- * Updates the config.toml file with necessary configurations for EdgeWorker
- * while preserving comments and formatting
- *
- * Makes the following changes:
- * 1. Enables the connection pooler
- * 2. Ensures pool_mode is set to "transaction"
- * 3. Changes edge_runtime policy from "oneshot" to "per_worker"
- * 4. Creates a backup of the original config.toml file before making changes
- *
- * @param options.supabasePath - Path to the supabase directory
- * @returns Promise<boolean> - True if changes were made, false otherwise
- */
-export async function updateConfigToml({
-  supabasePath,
-}: {
-  supabasePath: string;
-}): Promise<boolean> {
-  const configPath = path.join(supabasePath, 'config.toml');
-  const backupPath = `${configPath}.backup`;
-
-  try {
-    if (!fs.existsSync(configPath)) {
-      throw new Error(`config.toml not found at ${configPath}`);
-    }
-
-    const configContent = fs.readFileSync(configPath, 'utf8');
-    const config = TOML.parse(configContent) as SupabaseConfig;
-
-    const currentSettings = {
-      poolerEnabled: config.db?.pooler?.enabled ?? false,
-      poolMode: config.db?.pooler?.pool_mode ?? 'none',
-      edgeRuntimePolicy: config.edge_runtime?.policy ?? 'oneshot',
-    };
-
-    const needsChanges =
-      currentSettings.poolerEnabled !== true ||
-      currentSettings.poolMode !== 'transaction' ||
-      currentSettings.edgeRuntimePolicy !== 'per_worker';
-
-    if (!needsChanges) {
-      log.info(
-        `No changes needed in config.toml - all required settings are already configured`
-      );
-      return false;
-    }
-
-    const changes = [];
-
-    if (currentSettings.poolerEnabled !== true) {
-      changes.push(`[db.pooler]
-${chalk.red(`- enabled = ${currentSettings.poolerEnabled}`)}
-${chalk.green('+ enabled = true')}`);
-    }
-
-    if (currentSettings.poolMode !== 'transaction') {
-      changes.push(`[db.pooler]
-${chalk.red(`- pool_mode = "${currentSettings.poolMode}"`)}
-${chalk.green('+ pool_mode = "transaction"')}`);
-    }
-
-    if (currentSettings.edgeRuntimePolicy !== 'per_worker') {
-      changes.push(`[edge_runtime]
-${chalk.red(`- policy = "${currentSettings.edgeRuntimePolicy}"`)}
-${chalk.green('+ policy = "per_worker"')}`);
-    }
-
-    note(changes.join('\n\n'), 'Config Changes');
-
-    const shouldContinue = await confirm({
-      message: `Do you want to proceed with these configuration changes? A backup will be created at ${backupPath}`,
-    });
-
-    if (!shouldContinue) {
-      log.info('Configuration update cancelled');
-      return false;
-    }
-
-    fs.copyFileSync(configPath, backupPath);
-    log.info(`Created backup at ${backupPath}`);
-    log.info(`Updating config.toml`);
-
-    const updatedConfig = { ...config };
-
-    // Ensure required objects exist and set values
-    if (!updatedConfig.db) updatedConfig.db = {};
-    if (!updatedConfig.db.pooler) updatedConfig.db.pooler = {};
-    if (!updatedConfig.edge_runtime) updatedConfig.edge_runtime = {};
-
-    updatedConfig.db.pooler.enabled = true;
-    updatedConfig.db.pooler.pool_mode = 'transaction';
-    updatedConfig.edge_runtime.policy = 'per_worker';
-
-    const updatedContent = TOML.patch(configContent, updatedConfig);
-    fs.writeFileSync(configPath, updatedContent);
-
-    log.success(
-      `Successfully updated ${configPath} (backup created at ${backupPath})`
-    );
-    return true;
-  } catch (error) {
-    log.error(
-      `Failed to update ${configPath}: ${
-        error instanceof Error ? error.message : String(error)
-      }`
-    );
-    throw error;
-  }
-}

package/src/index.ts

@@ -1,76 +0,0 @@
-import { Command } from 'commander';
-import { fileURLToPath } from 'url';
-import { readFileSync } from 'fs';
-import { dirname, join } from 'path';
-import installCommand from './commands/install/index.js';
-
-// Create a function to handle errors
-const errorHandler = (error: unknown) => {
-  console.error(
-    'Error:',
-    error instanceof Error ? error.message : String(error)
-  );
-  process.exit(1);
-};
-
-// Set up process-wide unhandled rejection handler
-process.on('unhandledRejection', errorHandler);
-
-// Function to get version from package.json
-function getVersion(): string {
-  const __filename = fileURLToPath(import.meta.url);
-  const __dirname = dirname(__filename);
-  const packageJsonPath = join(__dirname, '..', 'package.json');
-
-  try {
-    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
-    return packageJson.version || 'unknown';
-  } catch (error) {
-    // Log error but don't display it to the user when showing version
-    console.error('Error reading package.json:', error);
-    return 'unknown';
-  }
-}
-
-const program = new Command();
-program
-  .name('npx pgflow')
-  .description('Command line interface to help you work with pgflow')
-  .version(getVersion())
-  .exitOverride((err) => {
-    // Don't treat version display as an error
-    if (err.code === 'commander.version') {
-      process.exit(0);
-    }
-    throw err;
-  });
-
-installCommand(program);
-
-// Use a promise-aware approach to parse arguments
-async function main() {
-  try {
-    await program.parseAsync(process.argv);
-    // If we get here with no command specified, it's not an error
-    process.exitCode = 0;
-  } catch (err) {
-    // Commander throws a CommanderError when help or version is displayed
-    // We want to exit with code 0 in these cases
-    if (
-      err &&
-      typeof err === 'object' &&
-      'code' in err &&
-      (err.code === 'commander.helpDisplayed' ||
-        err.code === 'commander.help' ||
-        err.code === 'commander.version')
-    ) {
-      process.exitCode = 0;
-    } else {
-      // For other errors, use our error handler
-      errorHandler(err);
-    }
-  }
-}
-
-// Execute and handle any errors
-main();

package/src/types.d.ts

@@ -1 +0,0 @@
-/// <reference types="@commander-js/extra-typings" />

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "files": [],
-  "include": [],
-  "compilerOptions": {
-    "baseUrl": ".",
-    "rootDir": "src",
-    "outDir": "dist",
-    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
-    "types": ["node"]
-  },
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,19 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["src/**/*.ts"],
-  "references": [],
-  "exclude": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx"
-  ]
-}

package/tsconfig.spec.json

@@ -1,33 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./out-tsc/vitest",
-    "types": [
-      "vitest/globals",
-      "vitest/importMeta",
-      "vite/client",
-      "node",
-      "vitest"
-    ]
-  },
-  "include": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx",
-    "src/**/*.d.ts"
-  ],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    }
-  ]
-}

package/vite.config.ts

@@ -1,25 +0,0 @@
-/// <reference types='vitest' />
-import { defineConfig } from 'vite';
-
-export default defineConfig({
-  root: __dirname,
-  cacheDir: '../../node_modules/.vite/pkgs/cli',
-  plugins: [],
-  // Uncomment this if you are using workers.
-  // worker: {
-  //  plugins: [ nxViteTsPaths() ],
-  // },
-  test: {
-    watch: false,
-    globals: true,
-    environment: 'jsdom',
-    include: [
-      '__tests__/**/*.{test,spec,test-d,spec-d}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}',
-    ],
-    reporters: ['default'],
-    coverage: {
-      reportsDirectory: './test-output/vitest/coverage',
-      provider: 'v8',
-    },
-  },
-});