@xpack/xpm-lib 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2026 Liviu Ionescu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,223 @@
+[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack/xpm-lib-ts)](https://github.com/xpack/xpm-lib-ts/blob/mater/package.json)
+[![license](https://img.shields.io/github/license/xpack/xpm-lib-ts.svg)](https://github.com/xpack/xpm-lib-ts/blob/xpack/LICENSE)
+[![npm (scoped)](https://img.shields.io/npm/v/@xpack/xpm-lib.svg)](https://www.npmjs.com/package/@xpack/xpm-lib/)
+
+# A Node.js CommonJS/ES6 module with the Liquid substitutions code used by xpm & relatives
+
+This project provides a **TypeScript** Node.js **CommonJS**/**ES6** module
+with the code used to perform the Liquid substitutions when parsing
+the xpm `package.json` file.
+
+Note: Compatibility with legacy CommonJS is required until VS Code extensions
+will be updated to import ES6 modules.
+
+The project is open-source and hosted on GitHub as
+[xpack/xpm-lib-ts](https://github.com/xpack/xpm-lib-ts.git).
+
+## Maintainer & developer info
+
+This page documents how to use this module in an user application.
+For maintainer information, see the separate
+[README-MAINTAINER](https://github.com/xpack/xpm-lib-ts/blob/master/README-MAINTAINER.md)
+page.
+
+## Prerequisites
+
+A recent [Node.js](https://nodejs.org) (>=16.0.0), since the TypeScript code
+is compiled into ECMAScript 2020 code, and the tests use ES6 modules.
+
+## Install
+
+The module is available as
+[`@xpack/xpm-lib-ts`](https://www.npmjs.com/package/@xpack/xpm-lib-ts)
+from the public [`npmjs`](https://www.npmjs.com) repository;
+it can be added as a dependency to any TypeScript or JavaScript
+project with `npm install`:
+
+```console
+npm install --save @xpack/xpm-libs@latest
+```
+
+The module does not provide any executables, and generally there are no
+reasons to install it globally.
+
+## User info
+
+This section is intended for those who want to use this module in their
+own projects.
+
+The `@xpack/xpm-lib` module can be imported into both TypeScript
+and JavaScript Node.js code.
+
+In TypeScript and ECMAScript modules, use `import`:
+
+```typescript
+import { XpmLiquid } from '@xpack/xpm-lib'
+```
+
+In JavaScript with CommonJS, use `require()`:
+
+```javascript
+const { XpmLiquid } = require('@xpack/xpm-lib')
+```
+
+To use the `XpmLiquid` class, create an instance of the engine, provide the
+`package.json` object, possibly the name of the configuration, and
+call `performSubstitutions()`:
+
+```js
+const xpmLiquid = new XpmLiquid(log)
+const xpmLiquidMap = xpmLiquid.prepareMap(packageJson, 'Debug')
+
+const str = await xpmLiquid.performSubstitutions(
+      '{{ "build" | path_join: configuration.name | to_filename }}',
+      xpmLiquidMap)
+```
+
+### Available variables
+
+The entire project `package.json` is available as the `package` variable:
+
+- `package`
+
+All user defined properties (project and configuration) are grouped
+below the `properties` variable:
+
+- `properties`
+
+If the substitution refers to a certain build configuration, the configuration
+name and the entire configuration content are available separately below
+the `configuration` variable. Configuration properties are added to the
+`properties` variables, possibly overriding project properties.
+
+- `configuration.name`
+- `configuration.*`
+
+Variables based on the Node.js process
+[environment](https://nodejs.org/dist/latest-v18.x/docs/api/process.html#process_process_env):
+
+- `env`
+
+Variables based on the Node.js
+[os](https://nodejs.org/dist/latest-v16.x/docs/api/os.html) definitions:
+
+- `os.EOL`
+- `os.arch` (like 'arm', 'arm64', 'ia32', 'x64')
+- `os.constants`
+- `os.cpus`
+- `os.endianness`
+- `os.homedir`
+- `os.hostname`
+- `os.platform` (like 'darwin', 'linux', 'win32')
+- `os.release`
+- `os.tmpdir`
+- `os.type`
+- `os.version` (available since Node 12)
+
+Variables based on the Node.js
+[path](https://nodejs.org/dist/latest-v16.x/docs/api/path.html) definitions:
+
+- `path.delimiter` (`;` for Windows, `:` for POSIX)
+- `path.sep` (`\` on Windows, `/` on POSIX)
+- `path.win32.delimiter` (`;`)
+- `path.win32.sep` (`\`)
+- `path.posix.delimiter` (`:`)
+- `path.posix.sep` (`/`)
+
+Examples:
+
+- `"buildFolderRelativePath": "build{{ path.sep }}{{ configuration.name | to_filename }}"`
+
+### Custom filters
+
+Filters based on Node.js
+[path](https://nodejs.org/dist/latest-v16.x/docs/api/path.html) functions:
+
+- `path_basename`
+- `path_dirname`
+- `path_normalize`
+- `path_join`
+- `path_relative`
+- `path_posix_basename`
+- `path_posix_dirname`
+- `path_posix_normalize`
+- `path_posix_join`
+- `path_posix_relative`
+- `path_win32_basename`
+- `path_win32_dirname`
+- `path_win32_normalize`
+- `path_win32_join`
+- `path_win32_relative`
+
+Filters based on Node.js
+[utils](https://nodejs.org/dist/latest-v16.x/docs/api/util.html) functions:
+
+- `util_format`
+
+Custom filter to convert generic names to names accepted
+as file names (letters, digits, dash):
+
+- `to_filename`
+- `to_posix_filename`
+- `to_win32_filename`
+
+Examples:
+
+- `"buildFolderRelativePath": "{{ "build" | path_join: configuration.name | to_filename | downcase }"`
+
+### Lenient if's
+
+The undefined variables in tests do not trigger `undefined variable` messages
+and allow to use defaults, like:
+
+```
+{{ env.OPTIMIZATION | default: '-O2' }}
+```
+
+### Reference
+
+For more details on the available class definitions, including all methods,
+accessors, properties, etc,
+please see the TypeDoc
+[reference pages](https://xpack.github.io/xpm-lib-ts/).
+
+## Known problems
+
+- none
+
+## Status
+
+The `@xpack/xpm-lib-ts` module is fully functional and stable.
+
+The main clients for this module is the `xpm` CLI application and the
+[VS Code xPack C/C++ Managed Build](https://github.com/xpack/vscode-xpack-extension-ts/)
+extension.
+
+## Tests
+
+The module is tested
+with 100% coverage and CI tested on every push via GitHub
+[Actions](https://github.com/xpack/xpm-lib-ts/actions).
+
+## Compatibility notices
+
+According to [semver](https://semver.org) rules:
+
+> Major version X (X.y.z | X > 0) MUST be incremented if any
+backwards incompatible changes are introduced to the public API.
+
+### v3.0.0
+
+The API was greatly extended to use XpmPackage & XpmLiquid*.
+The project was renamed xpm-lib and updated to ESM only.
+
+### v2.0.0
+
+The project was updated to dual ESM & CJS.
+
+## License
+
+The original content is released under the
+[MIT License](https://opensource.org/license/mit),
+with all rights reserved to
+[Liviu Ionescu](https://github.com/ilg-ul).

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+export * from './lib/functions/chmod-recursive.js';
+export * from './lib/functions/perform-substitutions.js';
+export * from './lib/functions/utils.js';
+export * from './lib/errors.js';
+export * from './lib/init-template-base.js';
+export * from './lib/liquid-actions.js';
+export * from './lib/liquid-build-configurations.js';
+export * from './lib/liquid-drop.js';
+export * from './lib/liquid-engine.js';
+export * from './lib/liquid-package.js';
+export * from './lib/package.js';
+export * from './lib/policies.js';
+export * from './lib/substitutions-variables.js';
+export * from './lib/types.js';
+export * from 'liquidjs';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgBA,cAAc,oCAAoC,CAAA;AAClD,cAAc,0CAA0C,CAAA;AACxD,cAAc,0BAA0B,CAAA;AAExC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,sCAAsC,CAAA;AACpD,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA;AACjC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gBAAgB,CAAA;AAE9B,cAAc,UAAU,CAAA"}

package/dist/index.js

@@ -0,0 +1,30 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/license/mit.
+ */
+/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
+// ----------------------------------------------------------------------------
+// Re-export all library definitions.
+export * from './lib/functions/chmod-recursive.js';
+export * from './lib/functions/perform-substitutions.js';
+export * from './lib/functions/utils.js';
+export * from './lib/errors.js';
+export * from './lib/init-template-base.js';
+export * from './lib/liquid-actions.js';
+export * from './lib/liquid-build-configurations.js';
+export * from './lib/liquid-drop.js';
+export * from './lib/liquid-engine.js';
+export * from './lib/liquid-package.js';
+export * from './lib/package.js';
+export * from './lib/policies.js';
+export * from './lib/substitutions-variables.js';
+export * from './lib/types.js';
+export * from 'liquidjs';
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,6DAA6D;AAE7D,+EAA+E;AAE/E,qCAAqC;AACrC,cAAc,oCAAoC,CAAA;AAClD,cAAc,0CAA0C,CAAA;AACxD,cAAc,0BAA0B,CAAA;AAExC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,sCAAsC,CAAA;AACpD,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA;AACjC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gBAAgB,CAAA;AAE9B,cAAc,UAAU,CAAA;AAExB,+EAA+E"}

package/dist/lib/chmod-recursive.d.ts

@@ -0,0 +1,7 @@
+import { Logger } from '@xpack/logger';
+export declare function chmodRecursive({ inputPath, readOnly, log, }: {
+    inputPath: string;
+    readOnly: boolean;
+    log: Logger;
+}): Promise<void>;
+//# sourceMappingURL=chmod-recursive.d.ts.map

package/dist/lib/chmod-recursive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chmod-recursive.d.ts","sourceRoot":"","sources":["../../src/lib/chmod-recursive.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAItC,wBAAsB,cAAc,CAAC,EACnC,SAAS,EACT,QAAQ,EACR,GAAG,GACJ,EAAE;IACD,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC,IAAI,CAAC,CAoEhB"}

package/dist/lib/chmod-recursive.js

@@ -0,0 +1,81 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2017-2025 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/license/mit.
+ */
+/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
+// ----------------------------------------------------------------------------
+// https://nodejs.org/docs/latest/api/
+import assert from 'node:assert';
+import * as fs from 'node:fs/promises';
+import path from 'node:path';
+// ----------------------------------------------------------------------------
+export async function chmodRecursive({ inputPath, readOnly, log, }) {
+    assert(inputPath, 'mandatory inputPath');
+    assert(log, 'mandatory log');
+    const stat = await fs.lstat(inputPath);
+    // log.trace(util.inspect(stat))
+    if (stat.isSymbolicLink()) {
+        // Since it is not possible to change the modes of links (lchmod
+        // was deprecated and worked on macOS anyway), don't bother
+        // with them.
+        return;
+    }
+    // The order is important, process the folder before
+    // changing it to RO.
+    if (readOnly && stat.isDirectory()) {
+        log.trace(inputPath);
+        const dirents = await fs.readdir(inputPath, {
+            withFileTypes: true,
+        });
+        for (const dirent of dirents) {
+            await chmodRecursive({
+                inputPath: path.resolve(inputPath, dirent.name),
+                readOnly,
+                log,
+            });
+        }
+    }
+    const mode = stat.mode;
+    // For RO, remove all W bits, for RW add only user.
+    const newMode = readOnly
+        ? mode &
+            ~(fs.constants.S_IWUSR | fs.constants.S_IWGRP | fs.constants.S_IWOTH)
+        : mode | fs.constants.S_IWUSR;
+    // log.trace(
+    //  `set ${inputPath} from ${mode.toString(8)} to ${newMode.toString(8)}`)
+    await fs.chmod(inputPath, newMode);
+    const actualStat = await fs.stat(inputPath);
+    // log.trace(`actual ${inputPath} is ${actualStat.mode.toString(8)}`)
+    if (readOnly) {
+        if ((actualStat.mode & fs.constants.S_IWUSR) !== 0) {
+            log.warn(`${inputPath} not set to RO`);
+        }
+    }
+    else {
+        if ((actualStat.mode & fs.constants.S_IWUSR) === 0) {
+            log.warn(`${inputPath} not set to RW`);
+        }
+    }
+    // If RW, process the folder after changing it to RW.
+    if (!readOnly && stat.isDirectory()) {
+        log.trace(inputPath);
+        const dirents = await fs.readdir(inputPath, {
+            withFileTypes: true,
+        });
+        for (const dirent of dirents) {
+            await chmodRecursive({
+                inputPath: path.resolve(inputPath, dirent.name),
+                readOnly,
+                log,
+            });
+        }
+    }
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=chmod-recursive.js.map

package/dist/lib/chmod-recursive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chmod-recursive.js","sourceRoot":"","sources":["../../src/lib/chmod-recursive.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,6DAA6D;AAE7D,+EAA+E;AAE/E,sCAAsC;AACtC,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,IAAI,MAAM,WAAW,CAAA;AAI5B,+EAA+E;AAE/E,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,SAAS,EACT,QAAQ,EACR,GAAG,GAKJ;IACC,MAAM,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;IACxC,MAAM,CAAC,GAAG,EAAE,eAAe,CAAC,CAAA;IAE5B,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IACtC,gCAAgC;IAEhC,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;QAC1B,gEAAgE;QAChE,2DAA2D;QAC3D,aAAa;QACb,OAAM;IACR,CAAC;IAED,oDAAoD;IACpD,qBAAqB;IACrB,IAAI,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACnC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACpB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE;YAC1C,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;QACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,cAAc,CAAC;gBACnB,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/C,QAAQ;gBACR,GAAG;aACJ,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;IACtB,mDAAmD;IACnD,MAAM,OAAO,GAAG,QAAQ;QACtB,CAAC,CAAC,IAAI;YACJ,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC;QACvE,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAA;IAE/B,aAAa;IACb,0EAA0E;IAC1E,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAElC,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC3C,qEAAqE;IAErE,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,gBAAgB,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,gBAAgB,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;IAED,qDAAqD;IACrD,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACpC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACpB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE;YAC1C,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;QACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,cAAc,CAAC;gBACnB,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/C,QAAQ;gBACR,GAAG;aACJ,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,+EAA+E"}

package/dist/lib/errors.d.ts

@@ -0,0 +1,11 @@
+export declare class XpmError extends Error {
+}
+export declare class XpmPrerequisitesError extends Error {
+}
+export declare class XpmInputError extends Error {
+}
+export declare class XpmSyntaxError extends Error {
+}
+export declare class XpmOutputError extends Error {
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/lib/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAgBA,qBAAa,QAAS,SAAQ,KAAK;CAAG;AAEtC,qBAAa,qBAAsB,SAAQ,KAAK;CAAG;AAEnD,qBAAa,aAAc,SAAQ,KAAK;CAAG;AAE3C,qBAAa,cAAe,SAAQ,KAAK;CAAG;AAE5C,qBAAa,cAAe,SAAQ,KAAK;CAAG"}

package/dist/lib/errors.js

@@ -0,0 +1,26 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/license/mit.
+ */
+/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
+// ----------------------------------------------------------------------------
+// Application errors
+export class XpmError extends Error {
+}
+export class XpmPrerequisitesError extends Error {
+}
+export class XpmInputError extends Error {
+}
+export class XpmSyntaxError extends Error {
+}
+export class XpmOutputError extends Error {
+}
+// Other errors:  Child.
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=errors.js.map

package/dist/lib/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,6DAA6D;AAE7D,+EAA+E;AAE/E,qBAAqB;AACrB,MAAM,OAAO,QAAS,SAAQ,KAAK;CAAG;AAEtC,MAAM,OAAO,qBAAsB,SAAQ,KAAK;CAAG;AAEnD,MAAM,OAAO,aAAc,SAAQ,KAAK;CAAG;AAE3C,MAAM,OAAO,cAAe,SAAQ,KAAK;CAAG;AAE5C,MAAM,OAAO,cAAe,SAAQ,KAAK;CAAG;AAE5C,wBAAwB;AAExB,+EAA+E"}

package/dist/lib/functions/chmod-recursive.d.ts

@@ -0,0 +1,7 @@
+import { Logger } from '@xpack/logger';
+export declare function chmodRecursive({ inputPath, readOnly, log, }: {
+    inputPath: string;
+    readOnly: boolean;
+    log: Logger;
+}): Promise<void>;
+//# sourceMappingURL=chmod-recursive.d.ts.map

package/dist/lib/functions/chmod-recursive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chmod-recursive.d.ts","sourceRoot":"","sources":["../../../src/lib/functions/chmod-recursive.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAItC,wBAAsB,cAAc,CAAC,EACnC,SAAS,EACT,QAAQ,EACR,GAAG,GACJ,EAAE;IACD,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC,IAAI,CAAC,CAoEhB"}

package/dist/lib/functions/chmod-recursive.js

@@ -0,0 +1,81 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2017-2026 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/license/mit.
+ */
+/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
+// ----------------------------------------------------------------------------
+// https://nodejs.org/docs/latest/api/
+import assert from 'node:assert';
+import * as fs from 'node:fs/promises';
+import path from 'node:path';
+// ----------------------------------------------------------------------------
+export async function chmodRecursive({ inputPath, readOnly, log, }) {
+    assert(inputPath, 'mandatory inputPath');
+    assert(log, 'mandatory log');
+    const stat = await fs.lstat(inputPath);
+    // log.trace(util.inspect(stat))
+    if (stat.isSymbolicLink()) {
+        // Since it is not possible to change the modes of links (lchmod
+        // was deprecated and worked on macOS anyway), don't bother
+        // with them.
+        return;
+    }
+    // The order is important, process the folder before
+    // changing it to RO.
+    if (readOnly && stat.isDirectory()) {
+        log.trace(inputPath);
+        const dirents = await fs.readdir(inputPath, {
+            withFileTypes: true,
+        });
+        for (const dirent of dirents) {
+            await chmodRecursive({
+                inputPath: path.resolve(inputPath, dirent.name),
+                readOnly,
+                log,
+            });
+        }
+    }
+    const mode = stat.mode;
+    // For RO, remove all W bits, for RW add only user.
+    const newMode = readOnly
+        ? mode &
+            ~(fs.constants.S_IWUSR | fs.constants.S_IWGRP | fs.constants.S_IWOTH)
+        : mode | fs.constants.S_IWUSR;
+    // log.trace(
+    //  `set ${inputPath} from ${mode.toString(8)} to ${newMode.toString(8)}`)
+    await fs.chmod(inputPath, newMode);
+    const actualStat = await fs.stat(inputPath);
+    // log.trace(`actual ${inputPath} is ${actualStat.mode.toString(8)}`)
+    if (readOnly) {
+        if ((actualStat.mode & fs.constants.S_IWUSR) !== 0) {
+            log.warn(`${inputPath} not set to RO`);
+        }
+    }
+    else {
+        if ((actualStat.mode & fs.constants.S_IWUSR) === 0) {
+            log.warn(`${inputPath} not set to RW`);
+        }
+    }
+    // If RW, process the folder after changing it to RW.
+    if (!readOnly && stat.isDirectory()) {
+        log.trace(inputPath);
+        const dirents = await fs.readdir(inputPath, {
+            withFileTypes: true,
+        });
+        for (const dirent of dirents) {
+            await chmodRecursive({
+                inputPath: path.resolve(inputPath, dirent.name),
+                readOnly,
+                log,
+            });
+        }
+    }
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=chmod-recursive.js.map

package/dist/lib/functions/chmod-recursive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chmod-recursive.js","sourceRoot":"","sources":["../../../src/lib/functions/chmod-recursive.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,6DAA6D;AAE7D,+EAA+E;AAE/E,sCAAsC;AACtC,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,IAAI,MAAM,WAAW,CAAA;AAI5B,+EAA+E;AAE/E,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,SAAS,EACT,QAAQ,EACR,GAAG,GAKJ;IACC,MAAM,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;IACxC,MAAM,CAAC,GAAG,EAAE,eAAe,CAAC,CAAA;IAE5B,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IACtC,gCAAgC;IAEhC,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;QAC1B,gEAAgE;QAChE,2DAA2D;QAC3D,aAAa;QACb,OAAM;IACR,CAAC;IAED,oDAAoD;IACpD,qBAAqB;IACrB,IAAI,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACnC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACpB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE;YAC1C,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;QACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,cAAc,CAAC;gBACnB,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/C,QAAQ;gBACR,GAAG;aACJ,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;IACtB,mDAAmD;IACnD,MAAM,OAAO,GAAG,QAAQ;QACtB,CAAC,CAAC,IAAI;YACJ,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC;QACvE,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAA;IAE/B,aAAa;IACb,0EAA0E;IAC1E,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAElC,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC3C,qEAAqE;IAErE,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,gBAAgB,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,gBAAgB,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;IAED,qDAAqD;IACrD,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACpC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACpB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE;YAC1C,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;QACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,cAAc,CAAC;gBACnB,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC/C,QAAQ;gBACR,GAAG;aACJ,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,+EAA+E"}

package/dist/lib/functions/perform-substitutions.d.ts

@@ -0,0 +1,20 @@
+import { Logger } from '@xpack/logger';
+import { XpmLiquidEngine } from '../liquid-engine.js';
+import { XpmLiquidSubstitutionsVariables } from '../substitutions-variables.js';
+/**
+ * Perform substitution on the input string.
+ * Repeat until no more Liquid variables or tags are identified.
+ *
+ * @param input - The input string, possibly with substitutions.
+ * @param map - The substitution map.
+ * @returns The substituted string.
+ *
+ * @throws Liquid exceptions
+ */
+export declare function performSubstitutions({ log, engine, input, substitutionsVariables, }: {
+    log: Logger;
+    engine: XpmLiquidEngine;
+    input: string;
+    substitutionsVariables: XpmLiquidSubstitutionsVariables;
+}): Promise<string>;
+//# sourceMappingURL=perform-substitutions.d.ts.map

package/dist/lib/functions/perform-substitutions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perform-substitutions.d.ts","sourceRoot":"","sources":["../../../src/lib/functions/perform-substitutions.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEtC,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAAE,+BAA+B,EAAE,MAAM,+BAA+B,CAAA;AAG/E;;;;;;;;;GASG;AAEH,wBAAsB,oBAAoB,CAAC,EACzC,GAAG,EACH,MAAM,EACN,KAAK,EACL,sBAAsB,GACvB,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,sBAAsB,EAAE,+BAA+B,CAAA;CACxD,GAAG,OAAO,CAAC,MAAM,CAAC,CAkElB"}

package/dist/lib/functions/perform-substitutions.js

@@ -0,0 +1,85 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/license/mit.
+ */
+/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
+// ----------------------------------------------------------------------------
+import assert from 'node:assert';
+import { Context } from 'liquidjs';
+import { XpmLiquidPropertiesDrop } from '../liquid-drop.js';
+// ----------------------------------------------------------------------------
+/**
+ * Perform substitution on the input string.
+ * Repeat until no more Liquid variables or tags are identified.
+ *
+ * @param input - The input string, possibly with substitutions.
+ * @param map - The substitution map.
+ * @returns The substituted string.
+ *
+ * @throws Liquid exceptions
+ */
+export async function performSubstitutions({ log, engine, input, substitutionsVariables, }) {
+    assert(substitutionsVariables);
+    if (input.trim() === '') {
+        // Spare it the trouble for empty strings.
+        return input;
+    }
+    let context;
+    // Wrap properties into a liquid drop (a mechanism to process
+    // substitutions immediately).
+    if (Object.keys(substitutionsVariables.properties).length > 0) {
+        context = new Context({
+            ...substitutionsVariables,
+            properties: new XpmLiquidPropertiesDrop({
+                log,
+                engine,
+                properties: substitutionsVariables.properties,
+            }),
+        });
+    }
+    else {
+        context = new Context(substitutionsVariables);
+    }
+    log.trace(`performSubstitutions('${input}')`);
+    let current = input;
+    let substituted = current;
+    let count = 0;
+    // Iterate until all substitutions are done.
+    while (current.includes('{{') || current.includes('{%')) {
+        ++count;
+        // May throw.
+        try {
+            substituted = (await engine.parseAndRender(current, context));
+            /* c8 ignore start */ /* istanbul ignore next */
+            if (substituted === current) {
+                // If nothing changed, we're done.
+                // This test is just a safety net, normally should not get there.
+                log.warn(`performSubstitutions() ${String(count)} => |`, substituted, '| did not change');
+                break;
+            } /* c8 ignore stop */
+        }
+        catch (ex) {
+            if (ex instanceof Error) {
+                // log.error(ex)
+                log.error(ex.message);
+            }
+            else {
+                log.error(new Error(String(ex)));
+            }
+            // Return the current (unsubstituted) value.
+            substituted = current;
+            break;
+        }
+        log.trace(`performSubstitutions() ${String(count)} => |`, substituted, '|');
+        current = substituted;
+    }
+    return substituted;
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=perform-substitutions.js.map

package/dist/lib/functions/perform-substitutions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perform-substitutions.js","sourceRoot":"","sources":["../../../src/lib/functions/perform-substitutions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,6DAA6D;AAE7D,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAKlC,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA;AAG3D,+EAA+E;AAC/E;;;;;;;;;GASG;AAEH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,EACzC,GAAG,EACH,MAAM,EACN,KAAK,EACL,sBAAsB,GAMvB;IACC,MAAM,CAAC,sBAAsB,CAAC,CAAA;IAE9B,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACxB,0CAA0C;QAC1C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,CAAA;IACX,6DAA6D;IAC7D,8BAA8B;IAC9B,IAAI,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9D,OAAO,GAAG,IAAI,OAAO,CAAC;YACpB,GAAG,sBAAsB;YACzB,UAAU,EAAE,IAAI,uBAAuB,CAAC;gBACtC,GAAG;gBACH,MAAM;gBACN,UAAU,EAAE,sBAAsB,CAAC,UAAU;aAC9C,CAAC;SACH,CAAC,CAAA;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC/C,CAAC;IAED,GAAG,CAAC,KAAK,CAAC,yBAAyB,KAAK,IAAI,CAAC,CAAA;IAE7C,IAAI,OAAO,GAAW,KAAK,CAAA;IAC3B,IAAI,WAAW,GAAW,OAAO,CAAA;IACjC,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,4CAA4C;IAC5C,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACxD,EAAE,KAAK,CAAA;QACP,aAAa;QACb,IAAI,CAAC;YACH,WAAW,GAAG,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAW,CAAA;YAEvE,qBAAqB,CAAC,0BAA0B;YAChD,IAAI,WAAW,KAAK,OAAO,EAAE,CAAC;gBAC5B,kCAAkC;gBAClC,iEAAiE;gBACjE,GAAG,CAAC,IAAI,CACN,0BAA0B,MAAM,CAAC,KAAK,CAAC,OAAO,EAC9C,WAAW,EACX,kBAAkB,CACnB,CAAA;gBAED,MAAK;YACP,CAAC,CAAC,oBAAoB;QACxB,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,IAAI,EAAE,YAAY,KAAK,EAAE,CAAC;gBACxB,gBAAgB;gBAChB,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;YACvB,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YAClC,CAAC;YACD,4CAA4C;YAC5C,WAAW,GAAG,OAAO,CAAA;YACrB,MAAK;QACP,CAAC;QAED,GAAG,CAAC,KAAK,CAAC,0BAA0B,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,CAAA;QAC3E,OAAO,GAAG,WAAW,CAAA;IACvB,CAAC;IAED,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,+EAA+E"}