@pgpmjs/core 7.28.0 → 7.30.0

package/core/template-scaffold.d.ts

@@ -103,5 +103,37 @@ export type TemplateRepoFlavor = keyof typeof TEMPLATE_REPOS;
 export declare const DEFAULT_TEMPLATE_REPO: "https://github.com/constructive-io/pgpm-boilerplates.git";
 export declare const DEFAULT_TEMPLATE_TTL_MS: number;
 export declare const DEFAULT_TEMPLATE_TOOL_NAME = "pgpm";
+export interface TemplateSourceInfo {
+    repo: string;
+    branch?: string;
+    remoteSha?: string;
+    refreshed: boolean;
+    offline: boolean;
+    local: boolean;
+}
+export interface RefreshTemplateCacheOptions {
+    templateRepo?: string;
+    branch?: string;
+    toolName?: string;
+    cacheBaseDir?: string;
+    cwd?: string;
+    force?: boolean;
+}
+/**
+ * Clear the per-process refresh memo. Primarily useful for tests and callers
+ * that begin a new init run in the same process.
+ */
+export declare function _resetTemplateRefreshMemo(): void;
+/**
+ * Check the remote template revision and clear a stale local clone.
+ *
+ * Set PGPM_TEMPLATE_OFFLINE to skip `git ls-remote`, which is useful for tests
+ * and environments that must not make network requests.
+ */
+export declare function refreshTemplateCache(options?: RefreshTemplateCacheOptions): TemplateSourceInfo;
+export declare function describeTemplateSource(info: TemplateSourceInfo, opts?: {
+    toolName?: string;
+    cacheBaseDir?: string;
+}): string;
 export declare function inspectTemplate(options: InspectTemplateOptions): InspectTemplateResult;
 export declare function scaffoldTemplate(options: ScaffoldTemplateOptions): Promise<ScaffoldTemplateResult>;

package/core/template-scaffold.js

@@ -4,8 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_TEMPLATE_TOOL_NAME = exports.DEFAULT_TEMPLATE_TTL_MS = exports.DEFAULT_TEMPLATE_REPO = exports.TEMPLATE_REPOS = exports.SkillInstaller = void 0;
+exports._resetTemplateRefreshMemo = _resetTemplateRefreshMemo;
+exports.refreshTemplateCache = refreshTemplateCache;
+exports.describeTemplateSource = describeTemplateSource;
 exports.inspectTemplate = inspectTemplate;
 exports.scaffoldTemplate = scaffoldTemplate;
+const child_process_1 = require("child_process");
+const fs_1 = __importDefault(require("fs"));
 const genomic_1 = require("genomic");
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
@@ -35,6 +40,150 @@ function resolveCacheBaseDir(cacheBaseDir) {
     }
     return undefined;
 }
+const templateRefreshMemo = new Map();
+/**
+ * Clear the per-process refresh memo. Primarily useful for tests and callers
+ * that begin a new init run in the same process.
+ */
+function _resetTemplateRefreshMemo() {
+    templateRefreshMemo.clear();
+}
+/**
+ * Check the remote template revision and clear a stale local clone.
+ *
+ * Set PGPM_TEMPLATE_OFFLINE to skip `git ls-remote`, which is useful for tests
+ * and environments that must not make network requests.
+ */
+function refreshTemplateCache(options = {}) {
+    const { templateRepo = exports.DEFAULT_TEMPLATE_REPO, branch, toolName = exports.DEFAULT_TEMPLATE_TOOL_NAME, cacheBaseDir, cwd, force = false, } = options;
+    const template = templateRepo.startsWith('.') ||
+        templateRepo.startsWith('/') ||
+        templateRepo.startsWith('~')
+        ? path_1.default.resolve(cwd ?? process.cwd(), templateRepo)
+        : templateRepo;
+    if (templateRepo.startsWith('.') ||
+        templateRepo.startsWith('/') ||
+        templateRepo.startsWith('~')) {
+        return {
+            repo: template,
+            branch,
+            refreshed: false,
+            offline: false,
+            local: true,
+        };
+    }
+    const url = new genomic_1.GitCloner().normalizeUrl(templateRepo);
+    const cm = new genomic_1.CacheManager({
+        toolName,
+        baseDir: resolveCacheBaseDir(cacheBaseDir),
+    });
+    const key = cm.createKey(url, branch);
+    const memoKey = `${key}|${force}`;
+    const memoized = templateRefreshMemo.get(memoKey);
+    if (memoized)
+        return memoized;
+    if (process.env.PGPM_TEMPLATE_OFFLINE) {
+        const info = {
+            repo: url,
+            branch,
+            refreshed: false,
+            offline: true,
+            local: false,
+        };
+        templateRefreshMemo.set(memoKey, info);
+        return info;
+    }
+    let remoteSha;
+    try {
+        const output = (0, child_process_1.execFileSync)('git', ['ls-remote', '--', url, branch ?? 'HEAD'], { stdio: 'pipe', encoding: 'utf-8', timeout: 15_000 });
+        const match = output.match(/\b([0-9a-f]{40})\b/i);
+        if (!match)
+            throw new Error('git ls-remote returned no commit SHA');
+        remoteSha = match[1];
+    }
+    catch {
+        const info = {
+            repo: url,
+            branch,
+            refreshed: false,
+            offline: true,
+            local: false,
+        };
+        templateRefreshMemo.set(memoKey, info);
+        return info;
+    }
+    const refPath = path_1.default.join(cm.getMetadataDir(), `${key}.ref.json`);
+    let previousSha;
+    try {
+        const ref = JSON.parse(fs_1.default.readFileSync(refPath, 'utf8'));
+        previousSha = typeof ref.sha === 'string' ? ref.sha : undefined;
+    }
+    catch {
+        // A missing or malformed sidecar is treated as unknown.
+    }
+    const cachePath = path_1.default.join(cm.getReposDir(), key);
+    const refreshed = force ||
+        previousSha !== remoteSha ||
+        (fs_1.default.existsSync(cachePath) && !previousSha);
+    if (refreshed)
+        cm.clear(key);
+    fs_1.default.mkdirSync(cm.getMetadataDir(), { recursive: true });
+    fs_1.default.writeFileSync(refPath, JSON.stringify({ sha: remoteSha, checkedAt: Date.now() }, null, 2));
+    const info = {
+        repo: url,
+        branch,
+        remoteSha,
+        refreshed,
+        offline: false,
+        local: false,
+    };
+    templateRefreshMemo.set(memoKey, info);
+    return info;
+}
+function formatAge(lastUpdated) {
+    const seconds = Math.max(0, Math.floor((Date.now() - lastUpdated) / 1000));
+    if (seconds < 60)
+        return `${seconds}s`;
+    const minutes = Math.floor(seconds / 60);
+    if (minutes < 60)
+        return `${minutes}m`;
+    const hours = Math.floor(minutes / 60);
+    if (hours < 24)
+        return `${hours}h`;
+    return `${Math.floor(hours / 24)}d`;
+}
+function describeTemplateSource(info, opts = {}) {
+    if (info.local)
+        return `using local template ${info.repo}`;
+    const repoDisplay = info.repo
+        .replace(/^https:\/\/github\.com\//, '')
+        .replace(/\.git$/, '');
+    const label = `${repoDisplay}@${info.branch ?? 'HEAD'}`;
+    const shortSha = info.remoteSha?.slice(0, 7);
+    let fetched;
+    if (info.refreshed) {
+        fetched = 'fetched just now';
+    }
+    else if (info.remoteSha) {
+        const url = new genomic_1.GitCloner().normalizeUrl(info.repo);
+        const cm = new genomic_1.CacheManager({
+            toolName: opts.toolName ?? exports.DEFAULT_TEMPLATE_TOOL_NAME,
+            baseDir: resolveCacheBaseDir(opts.cacheBaseDir),
+        });
+        const key = cm.createKey(url, info.branch);
+        const metadata = cm.getMetadata(key);
+        if (metadata?.lastUpdated)
+            fetched = `fetched ${formatAge(metadata.lastUpdated)} ago`;
+    }
+    const details = [
+        shortSha,
+        fetched,
+    ].filter(Boolean).join(', ');
+    let result = `using ${label}${details ? ` (${details})` : ''}`;
+    if (info.offline)
+        result += ' (offline, using cached copy)';
+    return result;
+}
 function inspectTemplate(options) {
     const { fromPath, templateRepo = exports.DEFAULT_TEMPLATE_REPO, branch, cacheTtlMs = exports.DEFAULT_TEMPLATE_TTL_MS, toolName = exports.DEFAULT_TEMPLATE_TOOL_NAME, cwd, cacheBaseDir, dir, } = options;
     const scaffolder = new genomic_1.TemplateScaffolder({

package/esm/core/template-scaffold.js

@@ -1,4 +1,6 @@
-import { TemplateScaffolder } from 'genomic';
+import { execFileSync } from 'child_process';
+import fs from 'fs';
+import { CacheManager, GitCloner, TemplateScaffolder } from 'genomic';
 import os from 'os';
 import path from 'path';
 export { SkillInstaller } from 'genomic';
@@ -26,6 +28,150 @@ function resolveCacheBaseDir(cacheBaseDir) {
     }
     return undefined;
 }
+const templateRefreshMemo = new Map();
+/**
+ * Clear the per-process refresh memo. Primarily useful for tests and callers
+ * that begin a new init run in the same process.
+ */
+export function _resetTemplateRefreshMemo() {
+    templateRefreshMemo.clear();
+}
+/**
+ * Check the remote template revision and clear a stale local clone.
+ *
+ * Set PGPM_TEMPLATE_OFFLINE to skip `git ls-remote`, which is useful for tests
+ * and environments that must not make network requests.
+ */
+export function refreshTemplateCache(options = {}) {
+    const { templateRepo = DEFAULT_TEMPLATE_REPO, branch, toolName = DEFAULT_TEMPLATE_TOOL_NAME, cacheBaseDir, cwd, force = false, } = options;
+    const template = templateRepo.startsWith('.') ||
+        templateRepo.startsWith('/') ||
+        templateRepo.startsWith('~')
+        ? path.resolve(cwd ?? process.cwd(), templateRepo)
+        : templateRepo;
+    if (templateRepo.startsWith('.') ||
+        templateRepo.startsWith('/') ||
+        templateRepo.startsWith('~')) {
+        return {
+            repo: template,
+            branch,
+            refreshed: false,
+            offline: false,
+            local: true,
+        };
+    }
+    const url = new GitCloner().normalizeUrl(templateRepo);
+    const cm = new CacheManager({
+        toolName,
+        baseDir: resolveCacheBaseDir(cacheBaseDir),
+    });
+    const key = cm.createKey(url, branch);
+    const memoKey = `${key}|${force}`;
+    const memoized = templateRefreshMemo.get(memoKey);
+    if (memoized)
+        return memoized;
+    if (process.env.PGPM_TEMPLATE_OFFLINE) {
+        const info = {
+            repo: url,
+            branch,
+            refreshed: false,
+            offline: true,
+            local: false,
+        };
+        templateRefreshMemo.set(memoKey, info);
+        return info;
+    }
+    let remoteSha;
+    try {
+        const output = execFileSync('git', ['ls-remote', '--', url, branch ?? 'HEAD'], { stdio: 'pipe', encoding: 'utf-8', timeout: 15_000 });
+        const match = output.match(/\b([0-9a-f]{40})\b/i);
+        if (!match)
+            throw new Error('git ls-remote returned no commit SHA');
+        remoteSha = match[1];
+    }
+    catch {
+        const info = {
+            repo: url,
+            branch,
+            refreshed: false,
+            offline: true,
+            local: false,
+        };
+        templateRefreshMemo.set(memoKey, info);
+        return info;
+    }
+    const refPath = path.join(cm.getMetadataDir(), `${key}.ref.json`);
+    let previousSha;
+    try {
+        const ref = JSON.parse(fs.readFileSync(refPath, 'utf8'));
+        previousSha = typeof ref.sha === 'string' ? ref.sha : undefined;
+    }
+    catch {
+        // A missing or malformed sidecar is treated as unknown.
+    }
+    const cachePath = path.join(cm.getReposDir(), key);
+    const refreshed = force ||
+        previousSha !== remoteSha ||
+        (fs.existsSync(cachePath) && !previousSha);
+    if (refreshed)
+        cm.clear(key);
+    fs.mkdirSync(cm.getMetadataDir(), { recursive: true });
+    fs.writeFileSync(refPath, JSON.stringify({ sha: remoteSha, checkedAt: Date.now() }, null, 2));
+    const info = {
+        repo: url,
+        branch,
+        remoteSha,
+        refreshed,
+        offline: false,
+        local: false,
+    };
+    templateRefreshMemo.set(memoKey, info);
+    return info;
+}
+function formatAge(lastUpdated) {
+    const seconds = Math.max(0, Math.floor((Date.now() - lastUpdated) / 1000));
+    if (seconds < 60)
+        return `${seconds}s`;
+    const minutes = Math.floor(seconds / 60);
+    if (minutes < 60)
+        return `${minutes}m`;
+    const hours = Math.floor(minutes / 60);
+    if (hours < 24)
+        return `${hours}h`;
+    return `${Math.floor(hours / 24)}d`;
+}
+export function describeTemplateSource(info, opts = {}) {
+    if (info.local)
+        return `using local template ${info.repo}`;
+    const repoDisplay = info.repo
+        .replace(/^https:\/\/github\.com\//, '')
+        .replace(/\.git$/, '');
+    const label = `${repoDisplay}@${info.branch ?? 'HEAD'}`;
+    const shortSha = info.remoteSha?.slice(0, 7);
+    let fetched;
+    if (info.refreshed) {
+        fetched = 'fetched just now';
+    }
+    else if (info.remoteSha) {
+        const url = new GitCloner().normalizeUrl(info.repo);
+        const cm = new CacheManager({
+            toolName: opts.toolName ?? DEFAULT_TEMPLATE_TOOL_NAME,
+            baseDir: resolveCacheBaseDir(opts.cacheBaseDir),
+        });
+        const key = cm.createKey(url, info.branch);
+        const metadata = cm.getMetadata(key);
+        if (metadata?.lastUpdated)
+            fetched = `fetched ${formatAge(metadata.lastUpdated)} ago`;
+    }
+    const details = [
+        shortSha,
+        fetched,
+    ].filter(Boolean).join(', ');
+    let result = `using ${label}${details ? ` (${details})` : ''}`;
+    if (info.offline)
+        result += ' (offline, using cached copy)';
+    return result;
+}
 export function inspectTemplate(options) {
     const { fromPath, templateRepo = DEFAULT_TEMPLATE_REPO, branch, cacheTtlMs = DEFAULT_TEMPLATE_TTL_MS, toolName = DEFAULT_TEMPLATE_TOOL_NAME, cwd, cacheBaseDir, dir, } = options;
     const scaffolder = new TemplateScaffolder({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/core",
-  "version": "7.28.0",
+  "version": "7.30.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "PGPM Package and Migration Tools",
   "main": "index.js",
@@ -49,27 +49,27 @@
     "makage": "^0.8.0"
   },
   "dependencies": {
-    "@pgpmjs/ast": "^0.14.0",
-    "@pgpmjs/bundle": "^0.17.0",
-    "@pgpmjs/diff": "^0.6.0",
-    "@pgpmjs/env": "^2.44.0",
-    "@pgpmjs/logger": "^2.25.1",
-    "@pgpmjs/server-utils": "^3.28.0",
-    "@pgpmjs/slice": "^0.17.0",
-    "@pgpmjs/transform": "^0.26.0",
-    "@pgpmjs/types": "^2.54.0",
+    "@pgpmjs/ast": "^0.15.0",
+    "@pgpmjs/bundle": "^0.18.0",
+    "@pgpmjs/diff": "^0.7.0",
+    "@pgpmjs/env": "^2.45.0",
+    "@pgpmjs/logger": "^2.26.0",
+    "@pgpmjs/server-utils": "^3.29.0",
+    "@pgpmjs/slice": "^0.18.0",
+    "@pgpmjs/transform": "^0.27.0",
+    "@pgpmjs/types": "^2.55.0",
     "cross-spawn": "^7.0.6",
-    "csv-to-pg": "^4.12.1",
+    "csv-to-pg": "^4.13.0",
     "genomic": "^5.6.6",
     "git-changed": "^0.4.0",
     "glob": "^13.0.6",
     "parse-package-name": "^1.0.0",
     "pg": "^8.21.0",
-    "pg-cache": "^3.28.0",
-    "pg-env": "^1.31.1",
+    "pg-cache": "^3.29.0",
+    "pg-env": "^1.32.0",
     "pgsql-deparser": "^18.3.6",
     "pgsql-parser": "^18.2.6",
     "yanse": "^0.2.2"
   },
-  "gitHead": "399437801c27b070312125f3f0ee821ce16e183e"
+  "gitHead": "79b4264038d5c4da44ac1ed461195a4853f3953c"
 }