@geekity/cms 0.31.0 → 0.32.0

package/dist/export/export-job.d.ts

@@ -0,0 +1,21 @@
+import type { JobDefinition } from '../jobs/types.ts';
+import type { Clock } from '../util/clock.ts';
+import type { NotCarried, SiteExportSource } from './site-export.ts';
+/** No password and no secret: `jobs.json` is exported. */
+export type SiteExportPayload = {
+    readonly withCredentials: boolean;
+};
+export type SiteExportResult = {
+    readonly file: string;
+    readonly files: number;
+    readonly bytes: number;
+    readonly credentials: boolean;
+    readonly credentialsLeftOut: readonly string[];
+    readonly undeclared: readonly string[];
+    readonly notCarried: readonly NotCarried[];
+    readonly deliveries: number;
+};
+export declare const SITE_EXPORT_JOB: import("../jobs/types.ts").JobName<SiteExportPayload, SiteExportResult>;
+export declare function sizeLabel(bytes: number): string;
+export declare function siteExportJob(source: SiteExportSource, now: Clock): JobDefinition<SiteExportPayload, SiteExportResult>;
+//# sourceMappingURL=export-job.d.ts.map

package/dist/export/export-job.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-job.d.ts","sourceRoot":"","sources":["../../src/export/export-job.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAS9C,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,0DAA0D;AAC1D,MAAM,MAAM,iBAAiB,GAAG;IAAE,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/C,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,SAAS,UAAU,EAAE,CAAC;IAC3C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,eAAO,MAAM,eAAe,yEAAqE,CAAC;AAIlG,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ/C;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,gBAAgB,EACxB,GAAG,EAAE,KAAK,GACT,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CA2CpD"}

package/dist/export/export-job.js

@@ -0,0 +1,63 @@
+import { mkdir } from 'node:fs/promises';
+import { EXPORTS, dataFolder, dataPath } from '../files/data-files.js';
+import { jobName } from '../jobs/types.js';
+import { isRecord } from '../util/guards.js';
+import { keepOnlyExport } from '../files/export-archives.js';
+import { SITE_EXPORT_JOB_NAME, exportFileName, planSiteExport, writeSiteExport, } from './site-export.js';
+export const SITE_EXPORT_JOB = jobName(SITE_EXPORT_JOB_NAME);
+const PROGRESS_STEPS = 100;
+export function sizeLabel(bytes) {
+    if (bytes < 1000)
+        return `${String(bytes)} bytes`;
+    let value = bytes;
+    for (const unit of ['KB', 'MB', 'GB']) {
+        value /= 1000;
+        if (value < 1000)
+            return `${String(Number(value.toFixed(1)))} ${unit}`;
+    }
+    return `${String(Number((value / 1000).toFixed(1)))} TB`;
+}
+export function siteExportJob(source, now) {
+    const { dataDir, baseUrl } = source.config;
+    return {
+        name: SITE_EXPORT_JOB.name,
+        parse(payload) {
+            const withCredentials = isRecord(payload) ? payload['withCredentials'] : undefined;
+            if (typeof withCredentials !== 'boolean') {
+                throw new Error('A site export job needs withCredentials, true or false.');
+            }
+            return { withCredentials };
+        },
+        async run({ withCredentials }, context) {
+            await mkdir(dataFolder(dataDir, EXPORTS), { recursive: true });
+            const plan = await planSiteExport(source, { withCredentials, withContent: true });
+            const started = now();
+            const file = exportFileName(baseUrl, started);
+            const step = Math.max(1, Math.floor(plan.files.length / PROGRESS_STEPS));
+            const manifest = await writeSiteExport(plan, {
+                out: dataPath(dataDir, EXPORTS, file),
+                now: started,
+                signal: context.signal,
+                progress: (progress) => progress.files % step === 0 || progress.files === progress.totalFiles
+                    ? context.progress({
+                        done: progress.files,
+                        total: progress.totalFiles,
+                        note: `${sizeLabel(progress.bytes)} of ${sizeLabel(progress.totalBytes)}.`,
+                    })
+                    : undefined,
+            });
+            await keepOnlyExport(dataDir, file);
+            return {
+                file,
+                files: manifest.files.length,
+                bytes: manifest.files.reduce((total, each) => total + each.size, 0),
+                credentials: manifest.credentials,
+                credentialsLeftOut: manifest.credentialsLeftOut,
+                undeclared: manifest.undeclared,
+                notCarried: manifest.notCarried,
+                deliveries: manifest.pending.deliveries,
+            };
+        },
+    };
+}
+//# sourceMappingURL=export-job.js.map

package/dist/export/export-job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-job.js","sourceRoot":"","sources":["../../src/export/export-job.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAG3C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAiB1B,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAsC,oBAAoB,CAAC,CAAC;AAElG,MAAM,cAAc,GAAG,GAAG,CAAC;AAE3B,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,IAAI,KAAK,GAAG,IAAI;QAAE,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;IAClD,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;QACtC,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,KAAK,GAAG,IAAI;YAAE,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IACzE,CAAC;IACD,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,MAAwB,EACxB,GAAU;IAEV,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,OAAO;QACL,IAAI,EAAE,eAAe,CAAC,IAAI;QAC1B,KAAK,CAAC,OAAO;YACX,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACnF,IAAI,OAAO,eAAe,KAAK,SAAS,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;YAC7E,CAAC;YACD,OAAO,EAAE,eAAe,EAAE,CAAC;QAC7B,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,EAAE,eAAe,EAAE,EAAE,OAAO;YACpC,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC/D,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,EAAE,eAAe,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;YAClF,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC;YACzE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE;gBAC3C,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC;gBACrC,GAAG,EAAE,OAAO;gBACZ,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,CACrB,QAAQ,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,UAAU;oBACnE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;wBACf,IAAI,EAAE,QAAQ,CAAC,KAAK;wBACpB,KAAK,EAAE,QAAQ,CAAC,UAAU;wBAC1B,IAAI,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG;qBAC3E,CAAC;oBACJ,CAAC,CAAC,SAAS;aAChB,CAAC,CAAC;YACH,MAAM,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACpC,OAAO;gBACL,IAAI;gBACJ,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM;gBAC5B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACnE,WAAW,EAAE,QAAQ,CAAC,WAAW;gBACjC,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;gBAC/C,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,UAAU;aACxC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/export/site-export.d.ts

@@ -0,0 +1,101 @@
+import type { ResolvedConfig } from '../config.ts';
+import type { OtherEntryKind } from '../files/data-files.ts';
+import type { PluginRegistry } from '../plugins/registry.ts';
+import type { SettingsRegistry } from '../settings/types.ts';
+/**
+ * It reads only. Every writer replaces its file by rename, so each file read
+ * through one open handle is a whole file, and its hash is taken from the
+ * bytes the archive holds. SQLite files are never exported.
+ */
+export declare const EXPORT_FORMAT = 1;
+export declare const MANIFEST_NAME = "manifest.json";
+export declare const SITE_EXPORT_JOB_NAME = "site.export";
+export interface SiteExportSource {
+    readonly config: Pick<ResolvedConfig, 'dataDir' | 'contentDir' | 'baseUrl' | 'plugins'>;
+    readonly settings: SettingsRegistry;
+    readonly plugins: PluginRegistry;
+}
+export interface SiteExportOptions {
+    readonly withCredentials: boolean;
+    readonly withContent: boolean;
+}
+export type ExportedClass = 'kept' | 'credential';
+export interface ManifestFile {
+    readonly path: string;
+    readonly class: ExportedClass;
+    readonly size: number;
+    readonly sha256: string;
+}
+export interface ManifestPlugin {
+    readonly name: string;
+    readonly version: string;
+    readonly source: 'folder' | 'config';
+    readonly enabled: boolean;
+}
+export interface ManifestOverride {
+    readonly setting: string;
+    /** `env GEEKITY_…` or `config field`. Never the value. */
+    readonly source: string;
+}
+export interface PendingWork {
+    readonly deliveries: number;
+    readonly jobs: {
+        readonly queued: number;
+        readonly running: number;
+    };
+}
+export type NotCarried = {
+    readonly path: string;
+    readonly why: OtherEntryKind;
+};
+export interface ExportManifest {
+    readonly format: typeof EXPORT_FORMAT;
+    readonly cms: string;
+    readonly exportedAt: string;
+    readonly baseUrl: string;
+    readonly content: boolean;
+    readonly credentials: boolean;
+    readonly devMode: boolean;
+    readonly files: readonly ManifestFile[];
+    readonly undeclared: readonly string[];
+    readonly notCarried: readonly NotCarried[];
+    readonly credentialsLeftOut: readonly string[];
+    readonly plugins: readonly ManifestPlugin[];
+    readonly overrides: readonly ManifestOverride[];
+    readonly pending: PendingWork;
+}
+interface PlannedFile {
+    readonly path: string;
+    readonly absolute: string;
+    readonly class: ExportedClass;
+    readonly rewrite?: (bytes: Buffer) => Buffer;
+}
+export interface ExportPlan {
+    readonly files: readonly PlannedFile[];
+    readonly bytes: number;
+    readonly site: Omit<ExportManifest, 'exportedAt' | 'files'>;
+}
+export interface ExportProgress {
+    readonly files: number;
+    readonly totalFiles: number;
+    readonly bytes: number;
+    readonly totalBytes: number;
+}
+export interface WriteSiteExportOptions {
+    readonly out: string;
+    readonly now: Date;
+    readonly signal?: AbortSignal;
+    readonly progress?: (progress: ExportProgress) => void | Promise<void>;
+}
+export declare function pendingWork(dataDir: string): Promise<PendingWork>;
+export declare function compactTime(now: Date): string;
+export declare function exportFileName(baseUrl: string, now: Date): string;
+export declare function planSiteExport(source: SiteExportSource, options: SiteExportOptions): Promise<ExportPlan>;
+/**
+ * `manifest.json`, which needs the hashes of every file, is written as the
+ * first gzip member and the files follow as the second. gzip readers and tar
+ * take the two members as one stream.
+ */
+export declare function writeSiteExport(plan: ExportPlan, options: WriteSiteExportOptions): Promise<ExportManifest>;
+export {};
+//# sourceMappingURL=site-export.d.ts.map

package/dist/export/site-export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-export.d.ts","sourceRoot":"","sources":["../../src/export/site-export.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAQnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAM7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAG7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAK7D;;;;GAIG;AAEH,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,eAAO,MAAM,aAAa,kBAAkB,CAAC;AAE7C,eAAO,MAAM,oBAAoB,gBAAgB,CAAC;AAElD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC,CAAC;IACxF,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;CAClC;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,YAAY,CAAC;AAElD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CACtE;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,OAAO,aAAa,CAAC;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IACxC,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,SAAS,UAAU,EAAE,CAAC;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/C,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAChD,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;CAC/B;AAED,UAAU,WAAW;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CAC9C;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IACnB,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxE;AAcD,wBAAsB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAWvE;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,IAAI,GAAG,MAAM,CAK7C;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,MAAM,CAEjE;AA4BD,wBAAsB,cAAc,CAClC,MAAM,EAAE,gBAAgB,EACxB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,UAAU,CAAC,CA8ErB;AA2DD;;;;GAIG;AAEH,wBAAsB,eAAe,CACnC,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,cAAc,CAAC,CAkCzB"}

package/dist/export/site-export.js

@@ -0,0 +1,243 @@
+import { createHash, randomBytes } from 'node:crypto';
+import { createReadStream, createWriteStream } from 'node:fs';
+import { open, rename, rm, stat } from 'node:fs/promises';
+import path from 'node:path';
+import { pipeline } from 'node:stream/promises';
+import { createGzip, gzipSync } from 'node:zlib';
+import { CONTENT_SCRATCH_FILES, JOBS, classifyEntries, classifyFiles, dataPath, } from '../files/data-files.js';
+import { TAR_END, tarHeader, tarPadding } from '../files/tar.js';
+import { ownManifest } from '../init.js';
+import { createFileRecords } from '../jobs/file-records.js';
+import { pluginFolderOf, siteDataFiles } from '../plugins/data.js';
+import { readEnabledPlugins } from '../plugins/enabled.js';
+import { DEV_MODE } from '../settings/dev-mode.js';
+import { overridden, sourceLabel } from '../settings/registry.js';
+import { countWaitingMessages } from '../store/queue-database.js';
+import { isNotFound } from '../util/files.js';
+import { isRecord } from '../util/guards.js';
+/**
+ * It reads only. Every writer replaces its file by rename, so each file read
+ * through one open handle is a whole file, and its hash is taken from the
+ * bytes the archive holds. SQLite files are never exported.
+ */
+export const EXPORT_FORMAT = 1;
+export const MANIFEST_NAME = 'manifest.json';
+export const SITE_EXPORT_JOB_NAME = 'site.export';
+function withoutExportJobs(bytes) {
+    let jobs;
+    try {
+        jobs = JSON.parse(bytes.toString('utf8'));
+    }
+    catch {
+        return bytes;
+    }
+    if (!Array.isArray(jobs))
+        return bytes;
+    const kept = jobs.filter((job) => !isRecord(job) || job['name'] !== SITE_EXPORT_JOB_NAME);
+    return kept.length === jobs.length ? bytes : Buffer.from(`${JSON.stringify(kept, null, 2)}\n`);
+}
+export async function pendingWork(dataDir) {
+    const jobs = (await createFileRecords(dataPath(dataDir, JOBS)).list(['queued', 'running'])).filter((job) => job.name !== SITE_EXPORT_JOB_NAME);
+    return {
+        deliveries: countWaitingMessages(dataDir),
+        jobs: {
+            queued: jobs.filter((job) => job.state === 'queued').length,
+            running: jobs.filter((job) => job.state === 'running').length,
+        },
+    };
+}
+export function compactTime(now) {
+    return now
+        .toISOString()
+        .replace(/\.\d+Z$/, 'Z')
+        .replace(/[-:]/g, '');
+}
+export function exportFileName(baseUrl, now) {
+    return `geekity-${new URL(baseUrl).hostname}-${compactTime(now)}.tar.gz`;
+}
+function credentialOwner(relative) {
+    return pluginFolderOf(relative) ?? path.posix.basename(relative, '.json');
+}
+async function overridesOf(settings) {
+    const found = [];
+    for (const ref of settings.list()) {
+        const { source } = await settings.resolve(ref);
+        if (overridden(source)) {
+            found.push({ setting: `${ref.namespace}.${ref.key}`, source: sourceLabel(source) });
+        }
+    }
+    return found;
+}
+function pluginsOf(source) {
+    const enabled = readEnabledPlugins(source.config.contentDir);
+    const fromConfig = new Set(source.config.plugins.map((plugin) => plugin.name));
+    return source.plugins.plugins.map(({ plugin }) => ({
+        name: plugin.name,
+        version: plugin.version,
+        source: fromConfig.has(plugin.name) ? 'config' : 'folder',
+        enabled: enabled.has(plugin.name),
+    }));
+}
+export async function planSiteExport(source, options) {
+    const { contentDir, dataDir, baseUrl } = source.config;
+    const files = [];
+    const undeclared = [];
+    const notCarried = [];
+    const leftOut = new Set();
+    if (options.withContent) {
+        const entries = classifyEntries(contentDir, CONTENT_SCRATCH_FILES);
+        for (const file of entries.files) {
+            if (file.declaration === undefined) {
+                files.push({ path: `content/${file.relative}`, absolute: file.absolute, class: 'kept' });
+            }
+        }
+        for (const other of entries.others) {
+            if (other.declaration === undefined) {
+                notCarried.push({ path: `content/${other.relative}`, why: other.kind });
+            }
+        }
+    }
+    const declarations = siteDataFiles({
+        dataDir,
+        settings: source.settings,
+        plugins: source.plugins,
+    });
+    for (const file of classifyFiles(dataDir, declarations)) {
+        const archived = `data/${file.relative}`;
+        const kind = file.declaration?.dataClass.kind;
+        switch (kind) {
+            case undefined:
+                undeclared.push(archived);
+                break;
+            case 'kept':
+                files.push({
+                    path: archived,
+                    absolute: file.absolute,
+                    class: 'kept',
+                    ...(file.declaration === JOBS ? { rewrite: withoutExportJobs } : {}),
+                });
+                break;
+            case 'credential':
+                if (options.withCredentials) {
+                    files.push({ path: archived, absolute: file.absolute, class: 'credential' });
+                }
+                else if ((await stat(file.absolute)).size > 0) {
+                    leftOut.add(credentialOwner(file.relative));
+                }
+                break;
+            case 'rebuildable':
+            case 'pending':
+            case 'scratch':
+                break;
+            default:
+                kind;
+        }
+    }
+    let bytes = 0;
+    for (const file of files)
+        bytes += (await stat(file.absolute)).size;
+    return {
+        files,
+        bytes,
+        site: {
+            format: EXPORT_FORMAT,
+            cms: ownManifest().version,
+            baseUrl,
+            content: options.withContent,
+            credentials: options.withCredentials,
+            devMode: await source.settings.get(DEV_MODE.on),
+            undeclared,
+            notCarried,
+            credentialsLeftOut: [...leftOut].sort(),
+            plugins: pluginsOf(source),
+            overrides: await overridesOf(source.settings),
+            pending: await pendingWork(dataDir),
+        },
+    };
+}
+async function* tarEntries(plan, recorded, options) {
+    let bytes = 0;
+    for (const [index, file] of plan.files.entries()) {
+        options.signal?.throwIfAborted();
+        const handle = await open(file.absolute, 'r').catch((error) => {
+            if (isNotFound(error))
+                return undefined;
+            throw error;
+        });
+        if (handle !== undefined) {
+            try {
+                const { mode, mtime, size: onDisk } = await handle.stat();
+                const hash = createHash('sha256');
+                let size = onDisk;
+                if (file.rewrite !== undefined) {
+                    const bytes = file.rewrite(await handle.readFile());
+                    size = bytes.length;
+                    yield tarHeader({ name: file.path, mode, size, mtime });
+                    hash.update(bytes);
+                    yield bytes;
+                }
+                else {
+                    yield tarHeader({ name: file.path, mode, size, mtime });
+                    let read = 0;
+                    if (size > 0) {
+                        const stream = handle.createReadStream({ start: 0, end: size - 1, autoClose: false });
+                        for await (const chunk of stream) {
+                            hash.update(chunk);
+                            read += chunk.length;
+                            yield chunk;
+                        }
+                    }
+                    if (read !== size) {
+                        throw new Error(`${file.path} was cut short while it was read. A writer changed it in place; export again.`);
+                    }
+                }
+                yield tarPadding(size);
+                recorded.push({ path: file.path, class: file.class, size, sha256: hash.digest('hex') });
+                bytes += size;
+            }
+            finally {
+                await handle.close();
+            }
+        }
+        await options.progress?.({
+            files: index + 1,
+            totalFiles: plan.files.length,
+            bytes,
+            totalBytes: plan.bytes,
+        });
+    }
+    yield TAR_END;
+}
+/**
+ * `manifest.json`, which needs the hashes of every file, is written as the
+ * first gzip member and the files follow as the second. gzip readers and tar
+ * take the two members as one stream.
+ */
+export async function writeSiteExport(plan, options) {
+    const { now } = options;
+    const stamp = `${String(process.pid)}-${randomBytes(4).toString('hex')}`;
+    const body = `${options.out}.${stamp}.body.tmp`;
+    const whole = `${options.out}.${stamp}.tmp`;
+    const files = [];
+    try {
+        await pipeline(tarEntries(plan, files, options), createGzip(), createWriteStream(body, { mode: 0o600, flags: 'wx' }));
+        const manifest = { ...plan.site, exportedAt: now.toISOString(), files };
+        const text = Buffer.from(`${JSON.stringify(manifest, null, 2)}\n`);
+        const head = gzipSync(Buffer.concat([
+            tarHeader({ name: MANIFEST_NAME, mode: 0o600, size: text.length, mtime: now }),
+            text,
+            tarPadding(text.length),
+        ]));
+        await pipeline(async function* () {
+            yield head;
+            yield* createReadStream(body);
+        }, createWriteStream(whole, { mode: 0o600, flags: 'wx' }));
+        await rename(whole, options.out);
+        return manifest;
+    }
+    finally {
+        await rm(body, { force: true });
+        await rm(whole, { force: true });
+    }
+}
+//# sourceMappingURL=site-export.js.map

package/dist/export/site-export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-export.js","sourceRoot":"","sources":["../../src/export/site-export.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGjD,OAAO,EACL,qBAAqB,EACrB,IAAI,EACJ,eAAe,EACf,aAAa,EACb,QAAQ,GACT,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;GAIG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAE/B,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC;AAE7C,MAAM,CAAC,MAAM,oBAAoB,GAAG,aAAa,CAAC;AAyFlD,SAAS,iBAAiB,CAAC,KAAa;IACtC,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,oBAAoB,CAAC,CAAC;IAC1F,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;AACjG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAe;IAC/C,MAAM,IAAI,GAAG,CACX,MAAM,iBAAiB,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAC7E,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,oBAAoB,CAAC,CAAC;IACrD,OAAO;QACL,UAAU,EAAE,oBAAoB,CAAC,OAAO,CAAC;QACzC,IAAI,EAAE;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,MAAM;YAC3D,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,MAAM;SAC9D;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAS;IACnC,OAAO,GAAG;SACP,WAAW,EAAE;SACb,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAe,EAAE,GAAS;IACvD,OAAO,WAAW,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,IAAI,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC;AAC3E,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB;IACvC,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC5E,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,QAA0B;IACnD,MAAM,KAAK,GAAuB,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAAC,MAAwB;IACzC,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ;QACzD,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;KAClC,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAwB,EACxB,OAA0B;IAE1B,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;IACvD,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,MAAM,UAAU,GAAiB,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAElC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;QACnE,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YAC3F,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACpC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,YAAY,GAAG,aAAa,CAAC;QACjC,OAAO;QACP,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAC,CAAC;IACH,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC;QAC9C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,SAAS;gBACZ,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC1B,MAAM;YACR,KAAK,MAAM;gBACT,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,KAAK,EAAE,MAAM;oBACb,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACrE,CAAC,CAAC;gBACH,MAAM;YACR,KAAK,YAAY;gBACf,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;oBAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;gBAC/E,CAAC;qBAAM,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oBAChD,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC9C,CAAC;gBACD,MAAM;YACR,KAAK,aAAa,CAAC;YACnB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS;gBACZ,MAAM;YACR;gBACE,IAAoB,CAAC;QACzB,CAAC;IACH,CAAC;IAED,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,KAAK,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IAEpE,OAAO;QACL,KAAK;QACL,KAAK;QACL,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa;YACrB,GAAG,EAAE,WAAW,EAAE,CAAC,OAAO;YAC1B,OAAO;YACP,OAAO,EAAE,OAAO,CAAC,WAAW;YAC5B,WAAW,EAAE,OAAO,CAAC,eAAe;YACpC,OAAO,EAAE,MAAM,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/C,UAAU;YACV,UAAU;YACV,kBAAkB,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,EAAE;YACvC,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC;YAC1B,SAAS,EAAE,MAAM,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC7C,OAAO,EAAE,MAAM,WAAW,CAAC,OAAO,CAAC;SACpC;KACF,CAAC;AACJ,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,UAAU,CACxB,IAAgB,EAChB,QAAwB,EACxB,OAA+B;IAE/B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACjD,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACrE,IAAI,UAAU,CAAC,KAAK,CAAC;gBAAE,OAAO,SAAS,CAAC;YACxC,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC;gBACH,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC1D,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,IAAI,GAAG,MAAM,CAAC;gBAClB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACpD,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC;oBACpB,MAAM,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;oBACxD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBACnB,MAAM,KAAK,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,MAAM,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;oBACxD,IAAI,IAAI,GAAG,CAAC,CAAC;oBACb,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;wBACb,MAAM,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;wBACtF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAA+B,EAAE,CAAC;4BAC1D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;4BACnB,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC;4BACrB,MAAM,KAAK,CAAC;wBACd,CAAC;oBACH,CAAC;oBACD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;wBAClB,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,+EAA+E,CAC5F,CAAC;oBACJ,CAAC;gBACH,CAAC;gBACD,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC;gBACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACxF,KAAK,IAAI,IAAI,CAAC;YAChB,CAAC;oBAAS,CAAC;gBACT,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;QACD,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;YACvB,KAAK,EAAE,KAAK,GAAG,CAAC;YAChB,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;YAC7B,KAAK;YACL,UAAU,EAAE,IAAI,CAAC,KAAK;SACvB,CAAC,CAAC;IACL,CAAC;IACD,MAAM,OAAO,CAAC;AAChB,CAAC;AAED;;;;GAIG;AAEH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,IAAgB,EAChB,OAA+B;IAE/B,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,MAAM,KAAK,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;IACzE,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,KAAK,WAAW,CAAC;IAChD,MAAM,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,KAAK,MAAM,CAAC;IAC5C,MAAM,KAAK,GAAmB,EAAE,CAAC;IACjC,IAAI,CAAC;QACH,MAAM,QAAQ,CACZ,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAChC,UAAU,EAAE,EACZ,iBAAiB,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CACtD,CAAC;QACF,MAAM,QAAQ,GAAmB,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,CAAC;QACxF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,QAAQ,CACnB,MAAM,CAAC,MAAM,CAAC;YACZ,SAAS,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;YAC9E,IAAI;YACJ,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;SACxB,CAAC,CACH,CAAC;QACF,MAAM,QAAQ,CACZ,KAAK,SAAS,CAAC;YACb,MAAM,IAAI,CAAC;YACX,KAAK,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,EACD,iBAAiB,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CACvD,CAAC;QACF,MAAM,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,QAAQ,CAAC;IAClB,CAAC;YAAS,CAAC;QACT,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAChC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACnC,CAAC;AACH,CAAC"}

package/dist/export/site-import.d.ts

@@ -0,0 +1,75 @@
+import type { DataFileDeclaration } from '../files/data-files.ts';
+import type { SettingsRegistry } from '../settings/types.ts';
+import type { ExportManifest } from './site-export.ts';
+/**
+ * Nothing is made, renamed or removed beside a target, and the target itself
+ * is never renamed or removed, because on Docker each one is a mount point.
+ * Every move stays inside one target, so on one filesystem.
+ */
+export interface ImportTargets {
+    readonly contentDir: string;
+    readonly dataDir: string;
+}
+export interface ArchivedManifest {
+    readonly manifest: ExportManifest;
+    readonly marker: string;
+}
+export type TargetState = 'empty' | 'occupied' | 'unfinished';
+export interface ImportTarget {
+    readonly dir: string;
+    readonly state: TargetState;
+}
+export interface StagedImport {
+    readonly archived: ArchivedManifest;
+    readonly targets: ImportTargets;
+    readonly content: string | undefined;
+    readonly data: string;
+    readonly states: readonly ImportTarget[];
+    readonly skipped: readonly {
+        readonly path: string;
+        readonly why: string;
+    }[];
+    readonly created: readonly string[];
+}
+export declare function parseManifest(text: string): ExportManifest;
+export declare function readSiteManifest(archive: string): Promise<ArchivedManifest>;
+/**
+ * A plugin's own declarations exist only once it is installed, which is after
+ * its data is in place; the export classed those files with the same plugin
+ * version's declarations.
+ */
+export declare function importDeclarations(archived: ArchivedManifest, settings: SettingsRegistry): DataFileDeclaration[];
+export declare function checkImportTargets(archived: ArchivedManifest, targets: ImportTargets, settings: SettingsRegistry): ImportTarget[];
+export declare function discardStaging({ targets, created, }: Pick<StagedImport, 'targets' | 'created'>): Promise<void>;
+export declare function stageSiteImport(options: {
+    readonly archive: string;
+    readonly archived: ArchivedManifest;
+    readonly targets: ImportTargets;
+    readonly settings: SettingsRegistry;
+}): Promise<StagedImport>;
+export declare function placeSiteImport(staged: StagedImport, options: {
+    readonly stamp: string;
+    readonly rename?: (from: string, to: string) => Promise<void>;
+}): Promise<string[]>;
+export declare function finishSiteImport(targets: ImportTargets): Promise<void>;
+export type PluginFailure = {
+    readonly kind: 'not-installed';
+    readonly name: string;
+    readonly version: string;
+    readonly reason: string;
+} | {
+    readonly kind: 'needs-newer-core';
+    readonly name: string;
+    readonly version: string;
+    readonly needs: string;
+    readonly core: string;
+};
+export declare function pluginFailureLine(failure: PluginFailure): string;
+export declare function installArchivedPlugins(manifest: ExportManifest, options: {
+    readonly pluginsDir: string | undefined;
+    readonly registry: string;
+    readonly coreVersion: string;
+}): Promise<PluginFailure[]>;
+export declare function restoreEnabledPlugins(manifest: ExportManifest, contentDir: string): Promise<void>;
+export declare function importNotes(manifest: ExportManifest): string[];
+//# sourceMappingURL=site-import.d.ts.map

package/dist/export/site-import.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-import.d.ts","sourceRoot":"","sources":["../../src/export/site-import.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAOlE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAK7D,OAAO,KAAK,EACV,cAAc,EAIf,MAAM,kBAAkB,CAAC;AAE1B;;;;GAIG;AAEH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;AAE9D,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,YAAY,EAAE,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC7E,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAsFD,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAkD1D;AAoBD,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAKjF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,gBAAgB,GACzB,mBAAmB,EAAE,CAYvB;AA8CD,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,gBAAgB,GACzB,YAAY,EAAE,CAahB;AA8HD,wBAAsB,cAAc,CAAC,EACnC,OAAO,EACP,OAAO,GACR,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAI3D;AAED,wBAAsB,eAAe,CAAC,OAAO,EAAE;IAC7C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;CACrC,GAAG,OAAO,CAAC,YAAY,CAAC,CAwBxB;AAyBD,wBAAsB,eAAe,CACnC,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE;IACP,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D,GACA,OAAO,CAAC,MAAM,EAAE,CAAC,CA6BnB;AAED,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5E;AAED,MAAM,MAAM,aAAa,GACrB;IACE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;AAEN,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CAQhE;AAED,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,cAAc,EACxB,OAAO,EAAE;IACP,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B,GACA,OAAO,CAAC,aAAa,EAAE,CAAC,CAgC1B;AAED,wBAAsB,qBAAqB,CACzC,QAAQ,EAAE,cAAc,EACxB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAMf;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,EAAE,CAoB9D"}