@zokugun/artifact 0.5.2 → 0.6.0

package/lib/compositors/json.js

@@ -34,12 +34,14 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.json = json;
-const lodash_1 = require("lodash");
-const JSON = __importStar(require("../parsers/json"));
-const JSONC = __importStar(require("../parsers/jsonc"));
-const routes_1 = require("../routes");
-const compose_1 = require("./compose");
-const fork_1 = require("./fork");
+const is_it_type_1 = require("@zokugun/is-it-type");
+const JSON = __importStar(require("../parsers/json.js"));
+const JSONC = __importStar(require("../parsers/jsonc/index.js"));
+const index_js_1 = require("../routes/index.js");
+const apply_transforms_js_1 = require("../utils/apply-transforms.js");
+const flow_js_1 = require("../utils/flow.js");
+const compose_js_1 = require("./compose.js");
+const fork_js_1 = require("./fork.js");
 function tryJson(value) {
     try {
         return JSON.parse(value);
@@ -48,22 +50,22 @@ function tryJson(value) {
         return undefined;
     }
 }
-const merge = (0, compose_1.compose)({
-    $$default: (0, fork_1.fork)([Array.isArray, routes_1.listConcat], [lodash_1.isPlainObject, (...args) => merge(...args)], routes_1.primitive),
+const merge = (0, compose_js_1.compose)({
+    $$default: (0, fork_js_1.fork)([is_it_type_1.isArray, index_js_1.listConcat], [is_it_type_1.isRecord, async (...args) => merge(...args)], index_js_1.primitive),
 });
 function json(...routes) {
-    return ({ current, incoming, filters, ignores }) => {
+    return async ({ current, incoming, filters, ignores, transforms }) => {
         const currentData = current && tryJson(current);
         const incomingData = incoming && tryJson(incoming);
         if ((!current || currentData) && (!incoming || incomingData)) {
-            return (0, lodash_1.flow)(...routes, JSON.stringify)({ current: currentData, incoming: incomingData, filters, ignores });
+            return await (0, flow_js_1.flow)(...routes, (0, apply_transforms_js_1.applyTransforms)(transforms), JSON.stringify)({ current: currentData, incoming: incomingData, filters, ignores, transforms });
         }
         else {
             const { data: currentData, transform: currentTransform } = JSONC.parse(current);
             const { data: incomingData, transform: incomingTransform } = JSONC.parse(incoming);
-            const mergedTransform = merge({ current: currentTransform, incoming: incomingTransform });
+            const mergedTransform = await merge({ current: currentTransform, incoming: incomingTransform });
             const toJSON = (data) => JSONC.stringify(data, mergedTransform);
-            return (0, lodash_1.flow)(...routes, toJSON)({ current: currentData, incoming: incomingData, filters, ignores });
+            return await (0, flow_js_1.flow)(...routes, (0, apply_transforms_js_1.applyTransforms)(transforms), toJSON)({ current: currentData, incoming: incomingData, filters, ignores, transforms });
         }
     };
 }

package/lib/compositors/map-sort.d.ts

@@ -0,0 +1,2 @@
+import { type Route } from '../types/travel.js';
+export declare function mapSort(route: Route<Record<string, unknown>>): Route<Record<string, unknown>>;

package/lib/compositors/map-sort.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapSort = mapSort;
 const { compare } = new Intl.Collator('en');
 function mapSort(route) {
-    return (args) => {
-        const result = route(args);
+    return async (args) => {
+        const result = await route(args);
         const sorted = {};
         const keys = Object.keys(result).sort((a, b) => compare(a, b));
         for (const key of keys) {

package/lib/compositors/rc.d.ts

@@ -0,0 +1,2 @@
+import { type Route } from '../types/travel.js';
+export declare function rc(...routes: Array<Route<Record<string, any>>>): Route<string>;

package/lib/compositors/rc.js

@@ -34,21 +34,24 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rc = rc;
-const lodash_1 = require("lodash");
-const JSON = __importStar(require("../parsers/json"));
-const YAML = __importStar(require("../parsers/yaml"));
-const try_json_1 = require("../utils/try-json");
+const is_it_type_1 = require("@zokugun/is-it-type");
+const lodash_es_1 = require("lodash-es");
+const JSON = __importStar(require("../parsers/json.js"));
+const YAML = __importStar(require("../parsers/yaml.js"));
+const apply_transforms_js_1 = require("../utils/apply-transforms.js");
+const flow_js_1 = require("../utils/flow.js");
+const try_json_js_1 = require("../utils/try-json.js");
 function rc(...routes) {
-    return ({ current, incoming, filters, ignores }) => {
-        const currentData = current && ((0, try_json_1.tryJson)(current) ?? YAML.parse(current));
-        const incomingData = incoming && (0, try_json_1.tryJson)(incoming);
+    return async ({ current, incoming, filters, ignores, transforms }) => {
+        const currentData = current && ((0, try_json_js_1.tryJSON)(current) ?? YAML.parse(current));
+        const incomingData = incoming && (0, try_json_js_1.tryJSON)(incoming);
         if (incomingData) {
-            return (0, lodash_1.flow)(...routes, JSON.stringify)({ current: currentData, incoming: incomingData, filters, ignores });
+            return await (0, flow_js_1.flow)(...routes, (0, apply_transforms_js_1.applyTransforms)(transforms), JSON.stringify)({ current: currentData, incoming: incomingData, filters, ignores });
         }
         else {
             const incomingData = incoming && YAML.parse(incoming);
-            if ((0, lodash_1.isPlainObject)(incomingData) || Array.isArray(incomingData)) {
-                return (0, lodash_1.flow)(...routes, YAML.stringify)({ current: currentData, incoming: incomingData, filters, ignores });
+            if ((0, lodash_es_1.isArray)(incomingData) || (0, is_it_type_1.isRecord)(incomingData)) {
+                return await (0, flow_js_1.flow)(...routes, (0, apply_transforms_js_1.applyTransforms)(transforms), YAML.stringify)({ current: currentData, incoming: incomingData, filters, ignores });
             }
             else {
                 return incoming;

package/lib/compositors/yaml.d.ts

@@ -0,0 +1,2 @@
+import { type Route } from '../types/travel.js';
+export declare function yaml(...routes: Array<Route<Record<string, any>>>): Route<string>;

package/lib/compositors/yaml.js

@@ -34,16 +34,13 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.yaml = yaml;
-const lodash_1 = require("lodash");
-const YAML = __importStar(require("../parsers/yaml"));
-function fromYaml({ current, incoming, filters, ignores }) {
-    return {
-        current: typeof current === 'undefined' ? undefined : YAML.parse(current),
-        incoming: YAML.parse(incoming),
-        filters,
-        ignores,
-    };
-}
+const YAML = __importStar(require("../parsers/yaml.js"));
+const apply_transforms_js_1 = require("../utils/apply-transforms.js");
+const flow_js_1 = require("../utils/flow.js");
 function yaml(...routes) {
-    return (0, lodash_1.flow)(fromYaml, ...routes, YAML.stringify);
+    return async ({ current, incoming, filters, ignores, transforms }) => {
+        const currentData = current === undefined ? undefined : YAML.parse(current);
+        const incomingData = YAML.parse(incoming);
+        return await (0, flow_js_1.flow)(...routes, (0, apply_transforms_js_1.applyTransforms)(transforms), YAML.stringify)({ current: currentData, incoming: incomingData, filters, ignores, transforms });
+    };
 }

package/lib/configs/index.d.ts

@@ -0,0 +1,3 @@
+export * from './install/index.js';
+export * from './package/index.js';
+export * from './uninstall/index.js';

package/lib/configs/index.js

@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./install"), exports);
-__exportStar(require("./package"), exports);
+__exportStar(require("./install/index.js"), exports);
+__exportStar(require("./package/index.js"), exports);
+__exportStar(require("./uninstall/index.js"), exports);

package/lib/configs/install/index.d.ts

@@ -0,0 +1,3 @@
+export { readInstallConfig } from './read-install-config.js';
+export { writeInstallConfig } from './write-install-config.js';
+export { updateInstallConfig } from './update-install-config.js';

package/lib/configs/install/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateInstallConfig = exports.writeInstallConfig = exports.readInstallConfig = void 0;
-var read_install_config_1 = require("./read-install-config");
-Object.defineProperty(exports, "readInstallConfig", { enumerable: true, get: function () { return read_install_config_1.readInstallConfig; } });
-var write_install_config_1 = require("./write-install-config");
-Object.defineProperty(exports, "writeInstallConfig", { enumerable: true, get: function () { return write_install_config_1.writeInstallConfig; } });
-var update_install_config_1 = require("./update-install-config");
-Object.defineProperty(exports, "updateInstallConfig", { enumerable: true, get: function () { return update_install_config_1.updateInstallConfig; } });
+var read_install_config_js_1 = require("./read-install-config.js");
+Object.defineProperty(exports, "readInstallConfig", { enumerable: true, get: function () { return read_install_config_js_1.readInstallConfig; } });
+var write_install_config_js_1 = require("./write-install-config.js");
+Object.defineProperty(exports, "writeInstallConfig", { enumerable: true, get: function () { return write_install_config_js_1.writeInstallConfig; } });
+var update_install_config_js_1 = require("./update-install-config.js");
+Object.defineProperty(exports, "updateInstallConfig", { enumerable: true, get: function () { return update_install_config_js_1.updateInstallConfig; } });

package/lib/configs/install/read-install-config.d.ts

@@ -0,0 +1,6 @@
+import { type AsyncDResult } from '@zokugun/xtry';
+import { type InstallConfig, type InstallConfigStats } from '../../types/config.js';
+export declare function readInstallConfig(targetPath: string): AsyncDResult<{
+    config: InstallConfig;
+    configStats: InstallConfigStats;
+}>;

package/lib/configs/install/read-install-config.js

@@ -5,108 +5,151 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readInstallConfig = readInstallConfig;
 const path_1 = __importDefault(require("path"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
+const async_1 = __importDefault(require("@zokugun/fs-extra-plus/async"));
+const is_it_type_1 = require("@zokugun/is-it-type");
+const xtry_1 = require("@zokugun/xtry");
 const yaml_1 = __importDefault(require("yaml"));
-const places = [
-    {
-        name: '.artifactrc.yml',
-        type: 'yaml',
-    },
-    {
-        name: '.artifactrc.yaml',
-        type: 'yaml',
-    },
-    {
-        name: '.artifactrc.json',
-        type: 'json',
-    },
-    {
-        name: '.artifactrc',
-    },
-];
+const constants_js_1 = require("../utils/constants.js");
+const normalize_file_upsert_js_1 = require("../utils/normalize-file-upsert.js");
 async function readInstallConfig(targetPath) {
     let content;
     let name;
     let type;
-    for (const place of places) {
-        try {
-            content = await fs_extra_1.default.readFile(path_1.default.join(targetPath, place.name), 'utf-8');
-            name = place.name;
-            type = place.type;
-            break;
-        }
-        catch {
+    for (const place of constants_js_1.CONFIG_LOCATIONS) {
+        const result = await async_1.default.readFile(path_1.default.join(targetPath, place.name), 'utf8');
+        if (!result.fails) {
+            content = result.value;
+            ({ name, type } = place);
         }
     }
-    if (!content) {
-        return {
-            config: {
-                artifacts: {},
-                install: {},
-                update: {},
-            },
-            configStats: {
-                name: '.artifactrc.yml',
-                type: 'yaml',
-                finalNewLine: true,
-            },
-        };
+    if (!content || !name) {
+        return normalizeConfig(content, {
+            name: '.artifactrc.yml',
+            type: 'yaml',
+            finalNewLine: true,
+        });
     }
     const finalNewLine = content.endsWith('\n');
-    let data;
     if (type === 'json') {
-        data = JSON.parse(content);
+        return normalizeConfig(JSON.parse(content), {
+            name,
+            type: 'json',
+            finalNewLine,
+        });
     }
     else if (type === 'yaml') {
-        data = yaml_1.default.parse(content);
+        return normalizeConfig(yaml_1.default.parse(content), {
+            name,
+            type: 'yaml',
+            finalNewLine,
+        });
     }
     else {
         try {
-            data = JSON.parse(content);
-            type = 'json';
+            return normalizeConfig(JSON.parse(content), {
+                name,
+                type: 'json',
+                finalNewLine,
+            });
         }
         catch {
-            data = yaml_1.default.parse(content);
-            type = 'yaml';
+            return normalizeConfig(yaml_1.default.parse(content), {
+                name,
+                type: 'yaml',
+                finalNewLine,
+            });
         }
     }
-    if (typeof data.artifacts === 'undefined') {
-        data.artifacts = {};
+}
+function normalizeConfig(data, configStats) {
+    const artifacts = {};
+    let constants = {};
+    const install = {};
+    let update = {};
+    let variables = {};
+    if (!data) {
+        return (0, xtry_1.ok)({
+            config: {
+                artifacts,
+                constants,
+                install,
+                update,
+                variables,
+            },
+            configStats,
+        });
     }
-    if (typeof data.update === 'undefined') {
-        data.update = {};
+    if (!(0, is_it_type_1.isRecord)(data)) {
+        return (0, xtry_1.err)(`Config file ${configStats.name} must export an object.`);
     }
-    if (isOldInstallConfig(data)) {
-        const config = {
-            artifacts: {},
-            install: data.install,
-            update: data.update,
-        };
-        for (const { name, version } of data.artifacts) {
-            config.artifacts[name] = {
-                version,
-            };
+    if ((0, is_it_type_1.isString)(data.$schema)) {
+        const match = constants_js_1.VERSION_INSTALL_REGEX.exec(data.$schema);
+        if (!match) {
+            return (0, xtry_1.err)(`Cannot validate the "$schema" in the project's "${configStats.name}".`);
+        }
+        const version = Number.parseInt(match[2], 10);
+        if (version > constants_js_1.MAX_VERSION) {
+            return (0, xtry_1.err)(`Don't support newer version (v${version}) in the project's "${configStats.name}".`);
         }
-        return {
-            config,
-            configStats: {
-                name: name,
-                type,
-                finalNewLine,
-            },
-        };
     }
-    else {
-        return {
-            config: data,
-            configStats: {
-                name: name,
-                type,
-                finalNewLine,
-            },
-        };
+    if ((0, is_it_type_1.isArray)(data.artifacts)) {
+        for (const artifact of data.artifacts) {
+            if ((0, is_it_type_1.isRecord)(artifact) && (0, is_it_type_1.isString)(artifact.name) && (0, is_it_type_1.isString)(artifact.version)) {
+                const normalized = {
+                    version: artifact.version,
+                };
+                if ((0, is_it_type_1.isString)(artifact.variant)) {
+                    normalized.requires = [artifact.variant];
+                }
+                artifacts[artifact.name] = normalized;
+            }
+        }
     }
-}
-function isOldInstallConfig(config) {
-    return Array.isArray(config.artifacts);
+    else if ((0, is_it_type_1.isRecord)(data.artifacts)) {
+        for (const [key, artifact] of Object.entries(data.artifacts)) {
+            if ((0, is_it_type_1.isRecord)(artifact) && (0, is_it_type_1.isString)(artifact.version)) {
+                const normalized = {
+                    version: artifact.version,
+                };
+                if ((0, is_it_type_1.isArray)(artifact.requires, is_it_type_1.isString)) {
+                    normalized.requires = artifact.requires;
+                }
+                else if ((0, is_it_type_1.isArray)(artifact.provides, is_it_type_1.isString)) {
+                    normalized.requires = artifact.provides;
+                }
+                artifacts[key] = normalized;
+            }
+        }
+    }
+    if ((0, is_it_type_1.isRecord)(data.constants, (_key, value) => (0, is_it_type_1.isString)(value))) {
+        constants = data.constants;
+    }
+    if (data.update === false) {
+        update = false;
+    }
+    else if ((0, is_it_type_1.isRecord)(data.update)) {
+        for (const [key, value] of Object.entries(data.update)) {
+            const normalized = (0, normalize_file_upsert_js_1.normalizeFileUpsert)(value, 'update');
+            if (normalized.fails) {
+                return normalized;
+            }
+            if (update[key]) {
+                return (0, xtry_1.err)(`Conflict with the "${key}" key on "update"1.`);
+            }
+            update[key] = normalized.value;
+        }
+    }
+    if ((0, is_it_type_1.isRecord)(data.variables, (_key, value) => (0, is_it_type_1.isString)(value))) {
+        variables = data.variables;
+    }
+    return (0, xtry_1.ok)({
+        config: {
+            artifacts,
+            constants,
+            install,
+            update,
+            variables,
+        },
+        configStats,
+    });
 }

package/lib/configs/install/update-install-config.d.ts

@@ -0,0 +1,2 @@
+import { type ArtifactResult, type InstallConfig } from '../../types/config.js';
+export declare function updateInstallConfig(config: InstallConfig, { name, version, provides, requires }: ArtifactResult): void;

package/lib/configs/install/write-install-config.d.ts

@@ -0,0 +1,5 @@
+import { type AsyncDResult } from '@zokugun/xtry';
+import { type InstallConfig, type InstallConfigStats } from '../../types/config.js';
+import { type Options } from '../../types/context.js';
+import { type Format } from '../../types/format.js';
+export declare function writeInstallConfig(config: InstallConfig, { name, finalNewLine, type }: InstallConfigStats, formats: Format[], targetPath: string, options: Options): AsyncDResult;

package/lib/configs/install/write-install-config.js

@@ -5,16 +5,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeInstallConfig = writeInstallConfig;
 const path_1 = __importDefault(require("path"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const lodash_1 = require("lodash");
+const cli_utils_1 = require("@zokugun/cli-utils");
+const async_1 = __importDefault(require("@zokugun/fs-extra-plus/async"));
+const xtry_1 = require("@zokugun/xtry");
+const lodash_es_1 = require("lodash-es");
 const yaml_1 = __importDefault(require("yaml"));
-const apply_formatting_1 = require("../../steps/apply-formatting");
-const insert_final_new_line_1 = require("../../steps/insert-final-new-line");
+const apply_formatting_js_1 = require("../../steps/apply-formatting.js");
+const insert_final_new_line_js_1 = require("../../steps/insert-final-new-line.js");
+const constants_js_1 = require("../utils/constants.js");
 async function writeInstallConfig(config, { name, finalNewLine, type }, formats, targetPath, options) {
     const exported = {
+        $schema: `https://raw.githubusercontent.com/zokugun/artifact/v${constants_js_1.VERSION_RELEASE}/schemas/v${constants_js_1.MAX_VERSION}/install.json`,
         artifacts: config.artifacts,
     };
-    if (!(0, lodash_1.isPlainObject)(config.update) || !(0, lodash_1.isEmpty)(config.update)) {
+    if (!(0, lodash_es_1.isPlainObject)(config.update) || !(0, lodash_es_1.isEmpty)(config.update)) {
         exported.update = config.update;
     }
     const file = {
@@ -22,13 +26,17 @@ async function writeInstallConfig(config, { name, finalNewLine, type }, formats,
         data: type === 'yaml' ? yaml_1.default.stringify(exported) : JSON.stringify(exported, null, '\t'),
         finalNewLine,
     };
-    await (0, insert_final_new_line_1.insertFinalNewLine)({ mergedTextFiles: [file] });
-    await (0, apply_formatting_1.applyFormatting)({ mergedTextFiles: [file], formats });
+    await (0, insert_final_new_line_js_1.insertFinalNewLine)({ mergedTextFiles: [file] });
+    await (0, apply_formatting_js_1.applyFormatting)({ mergedTextFiles: [file], formats });
     if (!options.dryRun) {
         const filePath = path_1.default.join(targetPath, name);
-        await fs_extra_1.default.outputFile(filePath, file.data, 'utf-8');
+        const result = await async_1.default.outputFile(filePath, file.data, 'utf8');
+        if (result.fails) {
+            return (0, xtry_1.err)((0, xtry_1.stringifyError)(result.error));
+        }
     }
     if (options.verbose) {
-        console.log(`${name} has been written`);
+        cli_utils_1.logger.debug(`${name} has been written`);
     }
+    return xtry_1.OK;
 }

package/lib/configs/package/index.d.ts

@@ -0,0 +1 @@
+export { readPackageConfig } from './read-package-config.js';

package/lib/configs/package/index.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readPackageConfig = void 0;
-var read_package_config_1 = require("./read-package-config");
-Object.defineProperty(exports, "readPackageConfig", { enumerable: true, get: function () { return read_package_config_1.readPackageConfig; } });
+var read_package_config_js_1 = require("./read-package-config.js");
+Object.defineProperty(exports, "readPackageConfig", { enumerable: true, get: function () { return read_package_config_js_1.readPackageConfig; } });

package/lib/configs/package/read-package-config.d.ts

@@ -0,0 +1,3 @@
+import { type AsyncDResult } from '@zokugun/xtry';
+import { type PackageConfig } from '../../types/config.js';
+export declare function readPackageConfig(targetPath: string): AsyncDResult<PackageConfig>;