pgpm 0.2.18 → 0.3.0

package/esm/commands/init/workspace.js

@@ -1,8 +1,5 @@
-import { sluggify } from '@launchql/core';
+import { DEFAULT_TEMPLATE_REPO, DEFAULT_TEMPLATE_TOOL_NAME, scaffoldTemplate, sluggify } from '@launchql/core';
 import { Logger } from '@launchql/logger';
-// @ts-ignore - TypeScript module resolution issue with @launchql/templatizer
-import { loadTemplates, workspaceTemplate, writeRenderedTemplates } from '@launchql/templatizer';
-import { mkdirSync } from 'fs';
 import path from 'path';
 const log = new Logger('workspace-init');
 export default async function runWorkspaceSetup(argv, prompter) {
@@ -11,36 +8,35 @@ export default async function runWorkspaceSetup(argv, prompter) {
             name: 'name',
             message: 'Enter workspace name',
             required: true,
-            type: 'text',
+            type: 'text'
         }
     ];
     const answers = await prompter.prompt(argv, workspaceQuestions);
-    const { cwd } = argv;
+    const { cwd = process.cwd() } = argv;
     const targetPath = path.join(cwd, sluggify(answers.name));
-    mkdirSync(targetPath, { recursive: true });
-    log.success(`Created workspace directory: ${targetPath}`);
-    // Determine template source
-    let templates = workspaceTemplate;
-    if (argv.repo) {
-        const source = {
-            type: 'github',
-            path: argv.repo,
-            branch: argv.fromBranch
-        };
-        log.info(`Loading templates from GitHub repository: ${argv.repo}`);
-        const compiledTemplates = loadTemplates(source, 'workspace');
-        templates = compiledTemplates.map((t) => t.render);
-    }
-    else if (argv.templatePath) {
-        const source = {
-            type: 'local',
-            path: argv.templatePath
-        };
-        log.info(`Loading templates from local path: ${argv.templatePath}`);
-        const compiledTemplates = loadTemplates(source, 'workspace');
-        templates = compiledTemplates.map((t) => t.render);
-    }
-    writeRenderedTemplates(templates, targetPath, { ...argv, ...answers });
+    // Prevent double-echoed keystrokes by closing our prompter before template prompts.
+    prompter.close();
+    const templateRepo = argv.repo ?? DEFAULT_TEMPLATE_REPO;
+    const templatePath = argv.templatePath ?? 'workspace';
+    const scaffoldResult = await scaffoldTemplate({
+        type: 'workspace',
+        outputDir: targetPath,
+        templateRepo,
+        branch: argv.fromBranch,
+        templatePath,
+        answers: {
+            ...argv,
+            ...answers,
+            workspaceName: answers.name
+        },
+        toolName: DEFAULT_TEMPLATE_TOOL_NAME,
+        noTty: Boolean(argv.noTty || argv['no-tty'] || process.env.CI === 'true'),
+        cwd
+    });
+    const cacheMessage = scaffoldResult.cacheUsed
+        ? `Using cached templates from ${scaffoldResult.templateDir}`
+        : `Fetched templates into ${scaffoldResult.templateDir}`;
+    log.success(cacheMessage);
     log.success('Workspace templates rendered.');
     return { ...argv, ...answers, cwd: targetPath };
 }

package/esm/commands/update.js

@@ -0,0 +1,67 @@
+import { Logger } from '@launchql/logger';
+import { spawn } from 'child_process';
+import { readAndParsePackageJson } from '../package';
+import { fetchLatestVersion } from '../utils/npm-version';
+import { cliExitWithError } from '../utils/cli-error';
+const log = new Logger('update');
+const updateUsageText = `
+Update Command:
+
+  pgpm update [OPTIONS]
+
+  Install the latest version of pgpm from npm.
+
+Options:
+  --help, -h          Show this help message
+  --package <name>    Override the package name (default: package.json name)
+  --registry <url>    Use a custom npm registry
+  --dry-run           Print the npm command without executing it
+`;
+const runNpmInstall = (pkgName, registry) => {
+    return new Promise((resolve, reject) => {
+        const args = ['install', '-g', pkgName];
+        if (registry) {
+            args.push('--registry', registry);
+        }
+        const child = spawn('npm', args, { stdio: 'inherit' });
+        child.on('error', reject);
+        child.on('exit', (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error(`npm install exited with code ${code}`));
+            }
+        });
+    });
+};
+export default async (argv, _prompter, _options) => {
+    if (argv.help || argv.h) {
+        console.log(updateUsageText);
+        process.exit(0);
+    }
+    const pkgJson = readAndParsePackageJson();
+    const pkgName = argv.package || pkgJson.name || 'pgpm';
+    const registry = argv.registry;
+    const dryRun = Boolean(argv['dry-run']);
+    const npmCommand = `npm install -g ${pkgName}${registry ? ` --registry ${registry}` : ''}`;
+    if (dryRun) {
+        log.info(`[dry-run] ${npmCommand}`);
+        return argv;
+    }
+    log.info(`Running: ${npmCommand}`);
+    try {
+        await runNpmInstall(pkgName, registry);
+        const latest = await fetchLatestVersion(pkgName);
+        if (latest) {
+            log.success(`Successfully updated ${pkgName} to version ${latest}.`);
+        }
+        else {
+            log.success(`npm install completed for ${pkgName}.`);
+        }
+    }
+    catch (error) {
+        await cliExitWithError(error instanceof Error ? error.message : String(error), { package: pkgName, registry });
+    }
+    return argv;
+};

package/esm/commands.js

@@ -2,6 +2,7 @@ import { teardownPgPools } from 'pg-cache';
 import add from './commands/add';
 import adminUsers from './commands/admin-users';
 import analyze from './commands/analyze';
+import cache from './commands/cache';
 import clear from './commands/clear';
 import deploy from './commands/deploy';
 import docker from './commands/docker';
@@ -14,6 +15,7 @@ import kill from './commands/kill';
 import migrate from './commands/migrate';
 import _package from './commands/package';
 import plan from './commands/plan';
+import updateCmd from './commands/update';
 import remove from './commands/remove';
 import renameCmd from './commands/rename';
 import revert from './commands/revert';
@@ -22,6 +24,7 @@ import verify from './commands/verify';
 import { readAndParsePackageJson } from './package';
 import { extractFirst, usageText } from './utils';
 import { cliExitWithError } from './utils/cli-error';
+import { checkForUpdates } from './utils/update-check';
 const withPgTeardown = (fn, skipTeardown = false) => async (...args) => {
     try {
         await fn(...args);
@@ -54,7 +57,9 @@ export const createPgpmCommandMap = (skipPgTeardown = false) => {
         install: pgt(install),
         migrate: pgt(migrate),
         analyze: pgt(analyze),
-        rename: pgt(renameCmd)
+        rename: pgt(renameCmd),
+        cache,
+        update: updateCmd
     };
 };
 export const commands = async (argv, prompter, options) => {
@@ -84,6 +89,15 @@ export const commands = async (argv, prompter, options) => {
         ]);
         command = answer.command;
     }
+    try {
+        await checkForUpdates({
+            command,
+            pkgVersion: readAndParsePackageJson().version
+        });
+    }
+    catch {
+        // ignore update check failures
+    }
     newArgv = await prompter.prompt(newArgv, [
         {
             type: 'text',

package/esm/index.js

@@ -3,6 +3,7 @@ import { readFileSync } from 'fs';
 import { CLI } from 'inquirerer';
 import { join } from 'path';
 import { commands, createPgpmCommandMap } from './commands';
+export { createInitUsageText } from './commands/init';
 export { createPgpmCommandMap };
 export { default as add } from './commands/add';
 export { default as adminUsers } from './commands/admin-users';

package/esm/utils/display.js

@@ -21,6 +21,8 @@ export const usageText = `
     plan               Generate module deployment plans
     package            Package module for distribution
     export             Export database migrations from existing databases
+    update             Update pgpm to the latest version
+    cache              Manage cached templates (clean)
   
   Database Administration:
     kill               Terminate database connections and optionally drop databases
@@ -50,7 +52,7 @@ export const usageText = `
   
   Examples:
     pgpm deploy --help       Show deploy command options
-    pgpm init --workspace    Initialize new workspace
+    pgpm init workspace      Initialize new workspace
     pgpm install @pgpm/base32  Install a database module
   `;
 export function displayUsage() {

package/esm/utils/index.js

@@ -4,3 +4,6 @@ export * from './display';
 export * from './cli-error';
 export * from './deployed-changes';
 export * from './module-utils';
+export * from './npm-version';
+export * from './update-check';
+export * from './update-config';

package/esm/utils/npm-version.js

@@ -0,0 +1,46 @@
+import { execFile } from 'child_process';
+import semver from 'semver';
+import { promisify } from 'util';
+const execFileAsync = promisify(execFile);
+export async function fetchLatestVersion(pkgName, timeoutMs = 5000) {
+    try {
+        const result = await execFileAsync('npm', ['view', pkgName, 'version', '--json'], {
+            timeout: timeoutMs,
+            windowsHide: true,
+            maxBuffer: 1024 * 1024
+        });
+        const stdout = typeof result === 'string'
+            ? result
+            : result?.stdout ?? '';
+        const parsed = parseVersionOutput(stdout);
+        return parsed ?? null;
+    }
+    catch {
+        return null;
+    }
+}
+const parseVersionOutput = (raw) => {
+    const trimmed = raw.trim();
+    if (!trimmed.length)
+        return null;
+    try {
+        const parsed = JSON.parse(trimmed);
+        if (typeof parsed === 'string')
+            return parsed;
+        if (Array.isArray(parsed) && parsed.length) {
+            return String(parsed[parsed.length - 1]);
+        }
+    }
+    catch {
+        // fall through to plain string parse
+    }
+    return trimmed || null;
+};
+export const compareVersions = (current, latest) => {
+    const currentSemver = semver.coerce(current);
+    const latestSemver = semver.coerce(latest);
+    if (currentSemver && latestSemver) {
+        return semver.compare(currentSemver, latestSemver);
+    }
+    return current.localeCompare(latest);
+};

package/esm/utils/update-check.js

@@ -0,0 +1,57 @@
+import { Logger } from '@launchql/logger';
+import { UPDATE_CHECK_APPSTASH_KEY, UPDATE_CHECK_TTL_MS, UPDATE_PACKAGE_NAME } from '@launchql/types';
+import { readAndParsePackageJson } from '../package';
+import { compareVersions, fetchLatestVersion } from './npm-version';
+import { readUpdateConfig, shouldCheck, writeUpdateConfig } from './update-config';
+const log = new Logger('update-check');
+const shouldSkip = (command) => {
+    if (process.env.PGPM_SKIP_UPDATE_CHECK)
+        return true;
+    if (process.env.CI === 'true')
+        return true;
+    if (command === 'update')
+        return true;
+    return false;
+};
+export async function checkForUpdates(options = {}) {
+    const { pkgName = UPDATE_PACKAGE_NAME, pkgVersion = readAndParsePackageJson().version, command, now = Date.now(), key = UPDATE_CHECK_APPSTASH_KEY, toolName, baseDir } = options;
+    if (shouldSkip(command)) {
+        return null;
+    }
+    try {
+        const existing = await readUpdateConfig({ toolName, baseDir, key });
+        let latestKnownVersion = existing?.latestKnownVersion ?? pkgVersion;
+        const needsCheck = shouldCheck(now, existing?.lastCheckedAt, UPDATE_CHECK_TTL_MS);
+        if (needsCheck) {
+            const fetched = await fetchLatestVersion(pkgName);
+            if (fetched) {
+                latestKnownVersion = fetched;
+            }
+            await writeUpdateConfig({
+                lastCheckedAt: now,
+                latestKnownVersion
+            }, { toolName, baseDir, key });
+        }
+        const comparison = compareVersions(pkgVersion, latestKnownVersion);
+        const isOutdated = comparison < 0;
+        if (isOutdated) {
+            const defaultUpdateCommand = pkgName === UPDATE_PACKAGE_NAME
+                ? 'Run pgpm update to upgrade.'
+                : `Run npm i -g ${pkgName}@latest to upgrade.`;
+            const updateInstruction = options.updateCommand ?? defaultUpdateCommand;
+            log.warn(`A new version of ${pkgName} is available (current ${pkgVersion}, latest ${latestKnownVersion}). ${updateInstruction}`);
+            await writeUpdateConfig({
+                lastCheckedAt: now,
+                latestKnownVersion
+            }, { toolName, baseDir, key });
+        }
+        return {
+            lastCheckedAt: now,
+            latestKnownVersion
+        };
+    }
+    catch (error) {
+        log.debug('Update check skipped due to error:', error);
+        return null;
+    }
+}

package/esm/utils/update-config.js

@@ -0,0 +1,50 @@
+import fs from 'fs';
+import path from 'path';
+import { appstash, resolve as resolveAppstash } from 'appstash';
+import { UPDATE_CHECK_APPSTASH_KEY } from '@launchql/types';
+const defaultToolName = 'pgpm';
+const getConfigPath = (options = {}) => {
+    const toolName = options.toolName ?? defaultToolName;
+    const dirs = appstash(toolName, {
+        ensure: true,
+        baseDir: options.baseDir
+    });
+    const configDir = resolveAppstash(dirs, 'config');
+    if (!fs.existsSync(configDir)) {
+        fs.mkdirSync(configDir, { recursive: true });
+    }
+    const fileName = `${(options.key ?? UPDATE_CHECK_APPSTASH_KEY).replace(/[^a-z0-9-_]/gi, '_')}.json`;
+    return path.join(configDir, fileName);
+};
+export const shouldCheck = (now, lastCheckedAt, ttlMs) => {
+    if (!lastCheckedAt)
+        return true;
+    return now - lastCheckedAt > ttlMs;
+};
+export async function readUpdateConfig(options = {}) {
+    const configPath = getConfigPath(options);
+    if (!fs.existsSync(configPath)) {
+        return null;
+    }
+    try {
+        const contents = await fs.promises.readFile(configPath, 'utf8');
+        const parsed = JSON.parse(contents);
+        return parsed;
+    }
+    catch {
+        // Corrupted config – clear it
+        try {
+            await fs.promises.rm(configPath, { force: true });
+        }
+        catch {
+            // ignore
+        }
+        return null;
+    }
+}
+export async function writeUpdateConfig(config, options = {}) {
+    const configPath = getConfigPath(options);
+    await fs.promises.writeFile(configPath, JSON.stringify(config, null, 2), 'utf8');
+}
+// Exposed for testing to locate the config path for a given namespace/baseDir
+export const resolveUpdateConfigPath = (options = {}) => getConfigPath(options);

package/index.d.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import { CLIOptions } from 'inquirerer';
 import { createPgpmCommandMap } from './commands';
+export { createInitUsageText } from './commands/init';
 export { createPgpmCommandMap };
 export { default as add } from './commands/add';
 export { default as adminUsers } from './commands/admin-users';

package/index.js

@@ -18,12 +18,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.options = exports.verify = exports.tag = exports.revert = exports.renameCmd = exports.remove = exports.plan = exports._package = exports.migrate = exports.kill = exports.install = exports.extension = exports._export = exports.env = exports.docker = exports.deploy = exports.clear = exports.analyze = exports.adminUsers = exports.add = exports.createPgpmCommandMap = void 0;
+exports.options = exports.verify = exports.tag = exports.revert = exports.renameCmd = exports.remove = exports.plan = exports._package = exports.migrate = exports.kill = exports.install = exports.extension = exports._export = exports.env = exports.docker = exports.deploy = exports.clear = exports.analyze = exports.adminUsers = exports.add = exports.createPgpmCommandMap = exports.createInitUsageText = void 0;
 const fs_1 = require("fs");
 const inquirerer_1 = require("inquirerer");
 const path_1 = require("path");
 const commands_1 = require("./commands");
 Object.defineProperty(exports, "createPgpmCommandMap", { enumerable: true, get: function () { return commands_1.createPgpmCommandMap; } });
+var init_1 = require("./commands/init");
+Object.defineProperty(exports, "createInitUsageText", { enumerable: true, get: function () { return init_1.createInitUsageText; } });
 var add_1 = require("./commands/add");
 Object.defineProperty(exports, "add", { enumerable: true, get: function () { return __importDefault(add_1).default; } });
 var admin_users_1 = require("./commands/admin-users");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgpm",
-  "version": "0.2.18",
+  "version": "0.3.0",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "PostgreSQL Package Manager - Database migration and package management CLI",
   "main": "index.js",
@@ -37,6 +37,7 @@
     "@types/minimist": "^1.2.5",
     "@types/node": "^20.12.7",
     "@types/pg": "^8.15.2",
+    "@types/semver": "^7.5.8",
     "@types/shelljs": "^0.8.16",
     "glob": "^13.0.0",
     "makage": "^0.1.8",
@@ -44,16 +45,18 @@
     "ts-node": "^10.9.2"
   },
   "dependencies": {
-    "@launchql/core": "^2.17.7",
-    "@launchql/env": "^2.5.7",
+    "@launchql/core": "^2.17.8",
+    "@launchql/env": "^2.5.8",
     "@launchql/logger": "^1.1.13",
-    "@launchql/templatizer": "^2.5.8",
-    "@launchql/types": "^2.8.7",
+    "@launchql/types": "^2.9.0",
+    "appstash": "^0.2.4",
+    "create-gen-app": "^0.3.1",
     "inquirerer": "^2.1.8",
     "js-yaml": "^4.1.0",
     "minimist": "^1.2.8",
-    "pg-cache": "^1.4.9",
+    "pg-cache": "^1.4.10",
     "pg-env": "^1.1.8",
+    "semver": "^7.6.2",
     "shelljs": "^0.10.0",
     "yanse": "^0.1.5"
   },
@@ -69,5 +72,5 @@
     "pg",
     "pgsql"
   ],
-  "gitHead": "5a0d7c7502624bd42a214f983fd7ab957e1fb3e3"
+  "gitHead": "6a35ff5a2c49e0c4cf1ec9abdd81b62c57d621e9"
 }

package/utils/display.d.ts

@@ -1,3 +1,3 @@
 export declare function displayVersion(): void;
-export declare const usageText = "\n  Usage: pgpm <command> [options]\n  \n  Core Database Operations:\n    add                Add database changes to plans and create SQL files\n    deploy             Deploy database changes and migrations\n    verify             Verify database state and migrations\n    revert             Revert database changes and migrations\n  \n  Project Management:\n    init               Initialize workspace or module\n    extension          Manage module dependencies\n    plan               Generate module deployment plans\n    package            Package module for distribution\n    export             Export database migrations from existing databases\n  \n  Database Administration:\n    kill               Terminate database connections and optionally drop databases\n    install            Install database modules\n    tag                Add tags to changes for versioning\n    clear              Clear database state\n    remove             Remove database changes\n    analyze            Analyze database structure\n    rename             Rename database changes\n    admin-users        Manage admin users\n  \n  Migration Tools:\n    migrate            Migration management subcommands\n      init             Initialize migration tracking\n      status           Show migration status\n      list             List all changes\n      deps             Show change dependencies\n  \n  Global Options:\n    -h, --help         Display this help information\n    -v, --version      Display version information\n    --cwd <directory>  Working directory (default: current directory)\n  \n  Individual Command Help:\n    pgpm <command> --help    Display detailed help for specific command\n    pgpm <command> -h        Display detailed help for specific command\n  \n  Examples:\n    pgpm deploy --help       Show deploy command options\n    pgpm init --workspace    Initialize new workspace\n    pgpm install @pgpm/base32  Install a database module\n  ";
+export declare const usageText = "\n  Usage: pgpm <command> [options]\n  \n  Core Database Operations:\n    add                Add database changes to plans and create SQL files\n    deploy             Deploy database changes and migrations\n    verify             Verify database state and migrations\n    revert             Revert database changes and migrations\n  \n  Project Management:\n    init               Initialize workspace or module\n    extension          Manage module dependencies\n    plan               Generate module deployment plans\n    package            Package module for distribution\n    export             Export database migrations from existing databases\n    update             Update pgpm to the latest version\n    cache              Manage cached templates (clean)\n  \n  Database Administration:\n    kill               Terminate database connections and optionally drop databases\n    install            Install database modules\n    tag                Add tags to changes for versioning\n    clear              Clear database state\n    remove             Remove database changes\n    analyze            Analyze database structure\n    rename             Rename database changes\n    admin-users        Manage admin users\n  \n  Migration Tools:\n    migrate            Migration management subcommands\n      init             Initialize migration tracking\n      status           Show migration status\n      list             List all changes\n      deps             Show change dependencies\n  \n  Global Options:\n    -h, --help         Display this help information\n    -v, --version      Display version information\n    --cwd <directory>  Working directory (default: current directory)\n  \n  Individual Command Help:\n    pgpm <command> --help    Display detailed help for specific command\n    pgpm <command> -h        Display detailed help for specific command\n  \n  Examples:\n    pgpm deploy --help       Show deploy command options\n    pgpm init workspace      Initialize new workspace\n    pgpm install @pgpm/base32  Install a database module\n  ";
 export declare function displayUsage(): void;

package/utils/display.js

@@ -29,6 +29,8 @@ exports.usageText = `
     plan               Generate module deployment plans
     package            Package module for distribution
     export             Export database migrations from existing databases
+    update             Update pgpm to the latest version
+    cache              Manage cached templates (clean)
   
   Database Administration:
     kill               Terminate database connections and optionally drop databases
@@ -58,7 +60,7 @@ exports.usageText = `
   
   Examples:
     pgpm deploy --help       Show deploy command options
-    pgpm init --workspace    Initialize new workspace
+    pgpm init workspace      Initialize new workspace
     pgpm install @pgpm/base32  Install a database module
   `;
 function displayUsage() {

package/utils/index.d.ts

@@ -4,3 +4,6 @@ export * from './display';
 export * from './cli-error';
 export * from './deployed-changes';
 export * from './module-utils';
+export * from './npm-version';
+export * from './update-check';
+export * from './update-config';

package/utils/index.js

@@ -20,3 +20,6 @@ __exportStar(require("./display"), exports);
 __exportStar(require("./cli-error"), exports);
 __exportStar(require("./deployed-changes"), exports);
 __exportStar(require("./module-utils"), exports);
+__exportStar(require("./npm-version"), exports);
+__exportStar(require("./update-check"), exports);
+__exportStar(require("./update-config"), exports);

package/utils/npm-version.d.ts

@@ -0,0 +1,2 @@
+export declare function fetchLatestVersion(pkgName: string, timeoutMs?: number): Promise<string | null>;
+export declare const compareVersions: (current: string, latest: string) => number;

package/utils/npm-version.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareVersions = void 0;
+exports.fetchLatestVersion = fetchLatestVersion;
+const child_process_1 = require("child_process");
+const semver_1 = __importDefault(require("semver"));
+const util_1 = require("util");
+const execFileAsync = (0, util_1.promisify)(child_process_1.execFile);
+async function fetchLatestVersion(pkgName, timeoutMs = 5000) {
+    try {
+        const result = await execFileAsync('npm', ['view', pkgName, 'version', '--json'], {
+            timeout: timeoutMs,
+            windowsHide: true,
+            maxBuffer: 1024 * 1024
+        });
+        const stdout = typeof result === 'string'
+            ? result
+            : result?.stdout ?? '';
+        const parsed = parseVersionOutput(stdout);
+        return parsed ?? null;
+    }
+    catch {
+        return null;
+    }
+}
+const parseVersionOutput = (raw) => {
+    const trimmed = raw.trim();
+    if (!trimmed.length)
+        return null;
+    try {
+        const parsed = JSON.parse(trimmed);
+        if (typeof parsed === 'string')
+            return parsed;
+        if (Array.isArray(parsed) && parsed.length) {
+            return String(parsed[parsed.length - 1]);
+        }
+    }
+    catch {
+        // fall through to plain string parse
+    }
+    return trimmed || null;
+};
+const compareVersions = (current, latest) => {
+    const currentSemver = semver_1.default.coerce(current);
+    const latestSemver = semver_1.default.coerce(latest);
+    if (currentSemver && latestSemver) {
+        return semver_1.default.compare(currentSemver, latestSemver);
+    }
+    return current.localeCompare(latest);
+};
+exports.compareVersions = compareVersions;

package/utils/update-check.d.ts

@@ -0,0 +1,10 @@
+import { UpdateCheckConfig } from '@launchql/types';
+import { UpdateConfigOptions } from './update-config';
+export interface CheckForUpdatesOptions extends UpdateConfigOptions {
+    pkgName?: string;
+    pkgVersion?: string;
+    command?: string;
+    now?: number;
+    updateCommand?: string;
+}
+export declare function checkForUpdates(options?: CheckForUpdatesOptions): Promise<UpdateCheckConfig | null>;

package/utils/update-check.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkForUpdates = checkForUpdates;
+const logger_1 = require("@launchql/logger");
+const types_1 = require("@launchql/types");
+const package_1 = require("../package");
+const npm_version_1 = require("./npm-version");
+const update_config_1 = require("./update-config");
+const log = new logger_1.Logger('update-check');
+const shouldSkip = (command) => {
+    if (process.env.PGPM_SKIP_UPDATE_CHECK)
+        return true;
+    if (process.env.CI === 'true')
+        return true;
+    if (command === 'update')
+        return true;
+    return false;
+};
+async function checkForUpdates(options = {}) {
+    const { pkgName = types_1.UPDATE_PACKAGE_NAME, pkgVersion = (0, package_1.readAndParsePackageJson)().version, command, now = Date.now(), key = types_1.UPDATE_CHECK_APPSTASH_KEY, toolName, baseDir } = options;
+    if (shouldSkip(command)) {
+        return null;
+    }
+    try {
+        const existing = await (0, update_config_1.readUpdateConfig)({ toolName, baseDir, key });
+        let latestKnownVersion = existing?.latestKnownVersion ?? pkgVersion;
+        const needsCheck = (0, update_config_1.shouldCheck)(now, existing?.lastCheckedAt, types_1.UPDATE_CHECK_TTL_MS);
+        if (needsCheck) {
+            const fetched = await (0, npm_version_1.fetchLatestVersion)(pkgName);
+            if (fetched) {
+                latestKnownVersion = fetched;
+            }
+            await (0, update_config_1.writeUpdateConfig)({
+                lastCheckedAt: now,
+                latestKnownVersion
+            }, { toolName, baseDir, key });
+        }
+        const comparison = (0, npm_version_1.compareVersions)(pkgVersion, latestKnownVersion);
+        const isOutdated = comparison < 0;
+        if (isOutdated) {
+            const defaultUpdateCommand = pkgName === types_1.UPDATE_PACKAGE_NAME
+                ? 'Run pgpm update to upgrade.'
+                : `Run npm i -g ${pkgName}@latest to upgrade.`;
+            const updateInstruction = options.updateCommand ?? defaultUpdateCommand;
+            log.warn(`A new version of ${pkgName} is available (current ${pkgVersion}, latest ${latestKnownVersion}). ${updateInstruction}`);
+            await (0, update_config_1.writeUpdateConfig)({
+                lastCheckedAt: now,
+                latestKnownVersion
+            }, { toolName, baseDir, key });
+        }
+        return {
+            lastCheckedAt: now,
+            latestKnownVersion
+        };
+    }
+    catch (error) {
+        log.debug('Update check skipped due to error:', error);
+        return null;
+    }
+}

package/utils/update-config.d.ts

@@ -0,0 +1,10 @@
+import { UpdateCheckConfig } from '@launchql/types';
+export interface UpdateConfigOptions {
+    toolName?: string;
+    baseDir?: string;
+    key?: string;
+}
+export declare const shouldCheck: (now: number, lastCheckedAt: number | undefined, ttlMs: number) => boolean;
+export declare function readUpdateConfig(options?: UpdateConfigOptions): Promise<UpdateCheckConfig | null>;
+export declare function writeUpdateConfig(config: UpdateCheckConfig, options?: UpdateConfigOptions): Promise<void>;
+export declare const resolveUpdateConfigPath: (options?: UpdateConfigOptions) => string;