@webda/core 4.0.0-beta.2 → 4.0.0-beta.4

package/lib/deployers/deployer.d.ts

@@ -0,0 +1,157 @@
+import { type WorkerLogLevel } from "@webda/workout";
+import type { GitInformation, PackageDescriptor, WebdaPackageDescriptor } from "../application/iconfiguration.js";
+/**
+ * Capability of the services that deploy the application
+ */
+export declare const DEPLOYER_CAPABILITY = "deployer";
+/**
+ * A service that deploys the application: its commands (`deploy`, `package`, ...) run
+ * on the `units` of the selected deployment.
+ *
+ * Deployers are never part of the application services: the CLI adds the units of the
+ * selected deployment (`webda -d <deployment> <command>`) as services only when one of
+ * their commands runs, and never injects a deployer by default.
+ *
+ * Every deployer class declares `implements Deployer` itself, the compiler only reads the
+ * capability from the class own heritage clauses.
+ *
+ * @example
+ * ```typescript
+ * export class MyDeployer extends Service<MyDeployerParameters> implements Deployer {
+ *   @Command("deploy", { description: "Deploy my resources" })
+ *   async deploy() {
+ *     const parameters = resolveDeploymentVariables(this.parameters, getDeploymentVariables(this));
+ *   }
+ * }
+ * ```
+ *
+ * @WebdaCapability deployer
+ */
+export interface Deployer {
+}
+/**
+ * Variables available to the `${...}` templates of a deployer
+ */
+export interface DeploymentVariables {
+    /**
+     * Name of the current deployment, empty if none
+     */
+    deployment: string;
+    /**
+     * The deployer: unit name and service type
+     */
+    deployer: {
+        name: string;
+        type: string;
+    };
+    /**
+     * Parameters of the deployer, before replacement
+     */
+    resources: Record<string, any>;
+    /**
+     * package.json of the application
+     */
+    package: PackageDescriptor;
+    /**
+     * Webda configuration of the package.json, merged with the workspace one
+     */
+    webda: WebdaPackageDescriptor;
+    /**
+     * Git information of the application repository
+     */
+    git: GitInformation;
+    /**
+     * Environment variables, for secrets from the CI
+     */
+    env: Record<string, string | undefined>;
+    /**
+     * Current timestamp
+     */
+    now: number;
+    /**
+     * Additional variables
+     */
+    [key: string]: any;
+}
+/**
+ * The part of a deployer service used by {@link getDeploymentVariables}
+ */
+export interface DeployerInstance {
+    /**
+     * Name of the service, the unit name
+     */
+    getName(): string;
+    /**
+     * Parameters of the service
+     */
+    getParameters?(): any;
+}
+/**
+ * Collect the variables for the templates of a deployer
+ *
+ * @param deployer - the deployer service, for `deployer` and `resources`
+ * @param extra - additional variables, overriding the default ones
+ * @returns the variables
+ */
+export declare function getDeploymentVariables(deployer?: DeployerInstance, extra?: Record<string, any>): DeploymentVariables;
+/**
+ * Replace the `${...}` templates of a deployer parameters
+ *
+ * @param object - the string or object to resolve, not modified
+ * @param variables - the variables from {@link getDeploymentVariables}
+ * @returns a copy with the templates replaced
+ */
+export declare function resolveDeploymentVariables<T>(object: T, variables: DeploymentVariables): T;
+/**
+ * Result of {@link runCommand}
+ */
+export interface CommandResult {
+    /**
+     * Exit code
+     */
+    status: number;
+    /**
+     * Standard output
+     */
+    output: string;
+    /**
+     * Standard error
+     */
+    error: string;
+}
+/**
+ * Options of {@link runCommand}
+ */
+export interface RunCommandOptions {
+    /**
+     * Content to write on the standard input
+     */
+    stdin?: string;
+    /**
+     * Working directory
+     */
+    cwd?: string;
+    /**
+     * Additional environment variables
+     */
+    env?: Record<string, string>;
+    /**
+     * Resolve instead of rejecting when the exit code is not 0
+     */
+    resolveOnError?: boolean;
+    /**
+     * Log level of the standard output
+     *
+     * @default "TRACE"
+     */
+    logLevel?: WorkerLogLevel;
+}
+/**
+ * Run a shell command, logging its output
+ *
+ * @param command - the shell command
+ * @param options - the options
+ * @returns the exit code and outputs, rejects with the same object when the exit code is not 0
+ */
+export declare function runCommand(command: string, options?: RunCommandOptions): Promise<CommandResult>;
+//# sourceMappingURL=deployer.d.ts.map

package/lib/deployers/deployer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployer.d.ts","sourceRoot":"","sources":["../../src/deployers/deployer.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAIlH;;GAEG;AACH,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,MAAM,WAAW,QAAQ;CAAG;AAE5B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,sBAAsB,CAAC;IAC9B;;OAEG;IACH,GAAG,EAAE,cAAc,CAAC;IACpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,IAAI,GAAG,CAAC;CACvB;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,CAAC,EAAE,gBAAgB,EAC3B,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAC9B,mBAAmB,CAgBrB;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,CAAC,CAE1F;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC,CA4BnG"}

package/lib/deployers/deployer.js

@@ -0,0 +1,81 @@
+import { spawn } from "node:child_process";
+import { useLog } from "@webda/workout";
+import { useApplication } from "../application/hooks.js";
+import { replaceVariables } from "../templates/templates.js";
+import { getGitInformation } from "./git.js";
+/**
+ * Capability of the services that deploy the application
+ */
+export const DEPLOYER_CAPABILITY = "deployer";
+/**
+ * Collect the variables for the templates of a deployer
+ *
+ * @param deployer - the deployer service, for `deployer` and `resources`
+ * @param extra - additional variables, overriding the default ones
+ * @returns the variables
+ */
+export function getDeploymentVariables(deployer, extra = {}) {
+    const app = useApplication();
+    const project = app.getProjectInfo();
+    const packageDescription = project?.package ?? {};
+    const name = deployer?.getName() ?? "";
+    return {
+        deployment: app.getCurrentDeployment() ?? "",
+        deployer: { name, type: app.getConfiguration().services?.[name]?.type },
+        resources: deployer?.getParameters?.() ?? {},
+        package: packageDescription,
+        webda: project?.webda ?? {},
+        git: getGitInformation(app.applicationPath ?? process.cwd(), packageDescription.name, packageDescription.version),
+        env: process.env,
+        now: Date.now(),
+        ...extra
+    };
+}
+/**
+ * Replace the `${...}` templates of a deployer parameters
+ *
+ * @param object - the string or object to resolve, not modified
+ * @param variables - the variables from {@link getDeploymentVariables}
+ * @returns a copy with the templates replaced
+ */
+export function resolveDeploymentVariables(object, variables) {
+    return replaceVariables(object, variables);
+}
+/**
+ * Run a shell command, logging its output
+ *
+ * @param command - the shell command
+ * @param options - the options
+ * @returns the exit code and outputs, rejects with the same object when the exit code is not 0
+ */
+export function runCommand(command, options = {}) {
+    const { stdin, cwd, env, resolveOnError = false, logLevel = "TRACE" } = options;
+    useLog("DEBUG", "Command", command, stdin ? `with stdin <<EOF\n${stdin}\nEOF\n` : "");
+    return new Promise((resolve, reject) => {
+        const result = { status: 0, output: "", error: "" };
+        const child = spawn(command, { shell: true, cwd, env: env ? { ...process.env, ...env } : process.env });
+        child.stdout.on("data", data => {
+            useLog(logLevel, data.toString());
+            result.output += data.toString();
+        });
+        child.stderr.on("data", data => {
+            useLog("ERROR", data.toString());
+            result.error += data.toString();
+        });
+        child.on("error", reject);
+        child.on("close", code => {
+            result.status = code ?? 1;
+            if (result.status === 0 || resolveOnError) {
+                resolve(result);
+            }
+            else {
+                reject(result);
+            }
+        });
+        if (stdin !== undefined) {
+            child.stdin.write(stdin);
+        }
+        child.stdin.end();
+    });
+}
+//# sourceMappingURL=deployer.js.map

package/lib/deployers/deployer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployer.js","sourceRoot":"","sources":["../../src/deployers/deployer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAuB,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;AAoF9C;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAA2B,EAC3B,KAAK,GAAwB,EAAE;IAE/B,MAAM,GAAG,GAAG,cAAc,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;IACrC,MAAM,kBAAkB,GAAsB,OAAO,EAAE,OAAO,IAAK,EAAwB,CAAC;IAC5F,MAAM,IAAI,GAAG,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACvC,OAAO;QACL,UAAU,EAAE,GAAG,CAAC,oBAAoB,EAAE,IAAI,EAAE;QAC5C,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE;QACvE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE;QAC5C,OAAO,EAAE,kBAAkB;QAC3B,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;QAC3B,GAAG,EAAE,iBAAiB,CAAC,GAAG,CAAC,eAAe,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC;QACjH,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE;QACf,GAAG,KAAK;KACT,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAI,MAAS,EAAE,SAA8B;IACrF,OAAO,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAC7C,CAAC;AAgDD;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAAe,EAAE,OAAO,GAAsB,EAAE;IACzE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,cAAc,GAAG,KAAK,EAAE,QAAQ,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC;IAChF,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,qBAAqB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACtF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACnE,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QACxG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YAC7B,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAClC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YAC7B,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;YACvB,MAAM,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC,CAAC;YAC1B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,EAAE,CAAC;gBAC1C,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/lib/deployers/git.d.ts

@@ -0,0 +1,27 @@
+import type { GitInformation } from "../application/iconfiguration.js";
+/**
+ * Compute the snapshot version used when the current commit is not tagged with the package version
+ *
+ * The patch is incremented (or the prerelease dropped) and the build metadata is the date
+ * as `yyyymmddHHMMssl`: `1.2.3` becomes `1.2.4+20261004130507009`
+ *
+ * @param version - the package version
+ * @param date - the snapshot date
+ * @returns the snapshot version, or the version unchanged if it is not semver
+ */
+export declare function nextSnapshotVersion(version: string, date?: Date): string;
+/**
+ * Retrieve the git information of a repository
+ *
+ * The `GIT_INFO` environment variable (base64 JSON of {@link GitInformation}) takes precedence,
+ * useful when building without the repository (containers). The version is the package version
+ * when the current commit has the tag `<packageName>@<version>` or `v<version>`, otherwise a
+ * snapshot version from {@link nextSnapshotVersion}.
+ *
+ * @param cwd - a folder within the repository
+ * @param packageName - the package name, to find the version tag
+ * @param version - the package version
+ * @returns the git information, with `unknown` commit and branch outside of a repository
+ */
+export declare function getGitInformation(cwd: string, packageName?: string, version?: string): GitInformation;
+//# sourceMappingURL=git.d.ts.map

package/lib/deployers/git.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"git.d.ts","sourceRoot":"","sources":["../../src/deployers/git.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAEvE;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,IAAiB,GAAG,MAAM,CAWpF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,GAAE,MAAW,EAAE,OAAO,GAAE,MAAW,GAAG,cAAc,CA4B7G"}

package/lib/deployers/git.js

@@ -0,0 +1,66 @@
+import { execFileSync } from "node:child_process";
+/**
+ * Compute the snapshot version used when the current commit is not tagged with the package version
+ *
+ * The patch is incremented (or the prerelease dropped) and the build metadata is the date
+ * as `yyyymmddHHMMssl`: `1.2.3` becomes `1.2.4+20261004130507009`
+ *
+ * @param version - the package version
+ * @param date - the snapshot date
+ * @returns the snapshot version, or the version unchanged if it is not semver
+ */
+export function nextSnapshotVersion(version, date = new Date()) {
+    const match = /^(\d+)\.(\d+)\.(\d+)(-[^+]+)?/.exec(version ?? "");
+    if (!match) {
+        return version;
+    }
+    const [, major, minor, patch, prerelease] = match;
+    const pad = (value, length = 2) => value.toString().padStart(length, "0");
+    const stamp = `${date.getFullYear()}${pad(date.getMonth() + 1)}${pad(date.getDate())}` +
+        `${pad(date.getHours())}${pad(date.getMinutes())}${pad(date.getSeconds())}${pad(date.getMilliseconds(), 3)}`;
+    return `${major}.${minor}.${prerelease ? patch : parseInt(patch) + 1}+${stamp}`;
+}
+/**
+ * Retrieve the git information of a repository
+ *
+ * The `GIT_INFO` environment variable (base64 JSON of {@link GitInformation}) takes precedence,
+ * useful when building without the repository (containers). The version is the package version
+ * when the current commit has the tag `<packageName>@<version>` or `v<version>`, otherwise a
+ * snapshot version from {@link nextSnapshotVersion}.
+ *
+ * @param cwd - a folder within the repository
+ * @param packageName - the package name, to find the version tag
+ * @param version - the package version
+ * @returns the git information, with `unknown` commit and branch outside of a repository
+ */
+export function getGitInformation(cwd, packageName = "", version = "") {
+    if (process.env.GIT_INFO) {
+        return JSON.parse(Buffer.from(process.env.GIT_INFO, "base64").toString());
+    }
+    const git = (...args) => execFileSync("git", args, { cwd, stdio: "pipe" }).toString().trim();
+    try {
+        const tags = git("tag", "--points-at", "HEAD")
+            .split("\n")
+            .filter(tag => tag !== "");
+        const tag = [`${packageName}@${version}`, `v${version}`].find(candidate => tags.includes(candidate)) ?? "";
+        return {
+            commit: git("rev-parse", "HEAD"),
+            branch: git("rev-parse", "--abbrev-ref", "HEAD"),
+            short: git("rev-parse", "--short", "HEAD"),
+            tag,
+            tags,
+            version: tag ? version : nextSnapshotVersion(version)
+        };
+    }
+    catch {
+        return {
+            commit: "unknown",
+            branch: "unknown",
+            short: "00000000",
+            tag: "",
+            tags: [],
+            version
+        };
+    }
+}
+//# sourceMappingURL=git.js.map

package/lib/deployers/git.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"git.js","sourceRoot":"","sources":["../../src/deployers/git.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlD;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,IAAI,GAAS,IAAI,IAAI,EAAE;IAC1E,MAAM,KAAK,GAAG,+BAA+B,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAClE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC;IAClD,MAAM,GAAG,GAAG,CAAC,KAAa,EAAE,MAAM,GAAW,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1F,MAAM,KAAK,GACT,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE;QACxE,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;IAC/G,OAAO,GAAG,KAAK,IAAI,KAAK,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;AAClF,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,WAAW,GAAW,EAAE,EAAE,OAAO,GAAW,EAAE;IAC3F,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,GAAG,GAAG,CAAC,GAAG,IAAc,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;IACvG,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC;aAC3C,KAAK,CAAC,IAAI,CAAC;aACX,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;QAC7B,MAAM,GAAG,GAAG,CAAC,GAAG,WAAW,IAAI,OAAO,EAAE,EAAE,IAAI,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3G,OAAO;YACL,MAAM,EAAE,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC;YAChC,MAAM,EAAE,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC;YAChD,KAAK,EAAE,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC;YAC1C,GAAG;YACH,IAAI;YACJ,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC;SACtD,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;YACL,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,KAAK,EAAE,UAAU;YACjB,GAAG,EAAE,EAAE;YACP,IAAI,EAAE,EAAE;YACR,OAAO;SACR,CAAC;IACJ,CAAC;AACH,CAAC"}

package/lib/deployers/packager.d.ts

@@ -0,0 +1,85 @@
+import type { Application } from "../application/application.js";
+import type { Configuration } from "../application/iconfiguration.js";
+/**
+ * Path of the configuration within a packaged application
+ */
+export declare const PACKAGED_CONFIGURATION = "webda.config.json";
+/**
+ * Marker file of a packaged application: the CLI loads it from its cached configuration
+ */
+export declare const PACKAGED_MARKER = ".webda/packaged.json";
+/**
+ * A file of the packaged application
+ */
+export interface PackageEntry {
+    /**
+     * Posix path of the file within the package
+     */
+    target: string;
+    /**
+     * Absolute path of the file to copy, symbolic links resolved
+     */
+    source?: string;
+    /**
+     * Content of a generated file, when there is no source
+     */
+    content?: string;
+    /**
+     * File mode of the source
+     */
+    mode?: number;
+}
+/**
+ * Options of {@link packageApplication}
+ */
+export interface PackageOptions {
+    /**
+     * Additional top-level entries of the application to skip
+     */
+    ignores?: string[];
+    /**
+     * Regular expressions on the source path of the files to skip
+     *
+     * @default ["\\.d\\.ts$"]
+     */
+    excludePatterns?: string[];
+    /**
+     * Dependencies to add or remove from the application production dependencies
+     */
+    modules?: {
+        includes?: string[];
+        excludes?: string[];
+    };
+}
+/**
+ * A packaged application
+ */
+export interface ApplicationPackage {
+    /**
+     * Every file of the package, including the generated configuration and marker
+     */
+    files: PackageEntry[];
+    /**
+     * The packaged configuration, also in `files` as {@link PACKAGED_CONFIGURATION}
+     */
+    configuration: Configuration;
+}
+/**
+ * Compute the content of a deployable application: its files, its production dependencies and
+ * its packaged configuration
+ *
+ * The application files are its package.json `files`, or its top-level entries minus the ignored ones.
+ * Production dependencies (`dependencies`, `optionalDependencies` and resolvable `peerDependencies`) are
+ * resolved like Node.js from the real path of each package, so pnpm, npm and workspace layouts work:
+ * they are placed in `node_modules/<name>`, or nested under the requiring package on a version conflict.
+ *
+ * The configuration is the current configuration (with the deployment applied) without the deployment
+ * units, its `cachedModules` imports rewritten to the packaged locations and the git information baked;
+ * with the {@link PACKAGED_MARKER} file, the CLI loads it without scanning the modules.
+ *
+ * @param app - the loaded application
+ * @param options - ignores, excludes and modules
+ * @returns the files and configuration of the package
+ */
+export declare function packageApplication(app: Application, options?: PackageOptions): Promise<ApplicationPackage>;
+//# sourceMappingURL=packager.d.ts.map

package/lib/deployers/packager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packager.d.ts","sourceRoot":"","sources":["../../src/deployers/packager.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAGtE;;GAEG;AACH,eAAO,MAAM,sBAAsB,sBAAsB,CAAC;AAC1D;;GAEG;AACH,eAAO,MAAM,eAAe,yBAAyB,CAAC;AAmBtD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;CAC9B;AAmJD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAuGpH"}