build-raptor 0.131.0 → 0.133.0

package/dist/deps/build-raptor-core/engine.js

@@ -0,0 +1,285 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Engine = void 0;
+const build_failed_error_1 = require("build-failed-error");
+const child_process_1 = __importDefault(require("child_process"));
+const core_types_1 = require("core-types");
+const fs = __importStar(require("fs"));
+const fse = __importStar(require("fs-extra"));
+const ignore_1 = __importDefault(require("ignore"));
+const misc_1 = require("misc");
+const path = __importStar(require("path"));
+const task_name_1 = require("task-name");
+const fingerprint_ledger_1 = require("./fingerprint-ledger");
+const fingerprinter_1 = require("./fingerprinter");
+const model_1 = require("./model");
+const planner_1 = require("./planner");
+const purger_1 = require("./purger");
+const task_executor_1 = require("./task-executor");
+const task_tracker_1 = require("./task-tracker");
+class Engine {
+    /**
+     *
+     * @param logger
+     * @param rootDir
+     * @param repoProtocol
+     * @param taskStore
+     * @param taskOutputDir
+     * @param command the task kind to run. An empty string means "all tasks".
+     * @param units the units whose tasks are to be run. An empty array means "all units".
+     * @param goals list of output locations. The tasks that produce these outputs will be added to "tasks to run".
+     * @param eventPublisher
+     * @param steps
+     * @param options
+     */
+    constructor(logger, rootDir, repoProtocol, taskStore, taskOutputDir, selector, eventPublisher, steps, options) {
+        this.logger = logger;
+        this.rootDir = rootDir;
+        this.repoProtocol = repoProtocol;
+        this.taskStore = taskStore;
+        this.taskOutputDir = taskOutputDir;
+        this.selector = selector;
+        this.eventPublisher = eventPublisher;
+        this.steps = steps;
+        const userDirAbsolute = path.isAbsolute(options.userDir)
+            ? options.userDir
+            : this.rootDir.resolve((0, core_types_1.PathInRepo)(options.userDir));
+        const userDir = this.rootDir.unresolve(userDirAbsolute);
+        this.options = {
+            checkGitIgnore: options.checkGitIgnore ?? true,
+            concurrency: options.concurrency,
+            buildRaptorDir: options.buildRaptorDir,
+            fingerprintLedger: options.fingerprintLedger ?? false,
+            testCaching: options.testCaching ?? true,
+            commitHash: options.commitHash,
+            config: options.config,
+            userDir,
+            toRun: options.toRun ? { args: options.toRun.args, program: userDir.to(options.toRun.program) } : undefined,
+        };
+        this.goals = [...selector.goals, options.toRun?.program].flatMap(g => (g ? [g] : [])).map(g => userDir.to(g));
+        this.logger.info(`this.goals=${JSON.stringify(this.goals)}`);
+        const ledgerFile = path.join(this.options.buildRaptorDir, 'fingerprint-ledger.json');
+        this.eventPublisher.on('taskStore', e => {
+            const step = e.opcode === 'RECORDED'
+                ? 'TASK_STORE_PUT'
+                : e.opcode === 'RESTORED'
+                    ? 'TASK_STORE_GET'
+                    : (0, misc_1.shouldNeverHappen)(e.opcode);
+            const { taskKind, unitId } = (0, task_name_1.TaskName)().undo(e.taskName);
+            this.steps.transmit({
+                blobId: e.blobId,
+                taskName: e.taskName,
+                taskKind,
+                unitId,
+                step,
+                fingerprint: e.fingerprint,
+                files: e.files,
+            });
+        });
+        this.eventPublisher.on('testEnded', e => {
+            this.steps.transmit({
+                step: 'TEST_ENDED',
+                taskName: e.taskName,
+                fileName: e.fileName,
+                testPath: e.testPath,
+                verdict: e.verdict,
+                durationMillis: e.durationMillis,
+            });
+        });
+        this.eventPublisher.on('assetPublished', e => {
+            if (!this.tracker) {
+                throw new Error(`tracker is not set`);
+            }
+            const task = this.tracker?.getTask(e.taskName) ?? (0, misc_1.failMe)(`Task not found (task name=${e.taskName})`);
+            const { unitId } = (0, task_name_1.TaskName)().undo(e.taskName);
+            this.steps.transmit({
+                step: 'ASSET_PUBLISHED',
+                labels: [...task.labels],
+                taskName: e.taskName,
+                unitId,
+                fingerprint: task.getFingerprint(),
+                casAddress: e.casAddress,
+                file: e.file,
+            });
+        });
+        this.eventPublisher.on('publicFiles', e => {
+            if (Object.keys(e.publicFiles).length === 0) {
+                return;
+            }
+            this.steps.transmit({
+                step: 'PUBLIC_FILES',
+                taskName: e.taskName,
+                publicFiles: e.publicFiles,
+            });
+        });
+        this.fingerprintLedger = this.options.fingerprintLedger
+            ? new fingerprint_ledger_1.PersistedFingerprintLedger(logger, ledgerFile)
+            : new fingerprint_ledger_1.NopFingerprintLedger();
+        this.purger = new purger_1.Purger(this.logger, this.rootDir);
+    }
+    async run(buildRunId) {
+        this.steps.transmit({ step: 'BUILD_RUN_STARTED', buildRunId, commitHash: this.options.commitHash });
+        fs.writeFileSync(path.join(this.options.buildRaptorDir, 'build-run-id'), buildRunId);
+        await this.fingerprintLedger.updateRun(buildRunId);
+        await this.repoProtocol.initialize(this.rootDir, this.eventPublisher, this.options.config.outDirName, this.options.config.repoProtocol);
+        try {
+            const model = await this.loadModel(buildRunId);
+            const taskList = await this.repoProtocol.getTasks();
+            this.logger.info(`catalog=\n${JSON.stringify(taskList, null, 2)}`);
+            const plan = await new planner_1.Planner(this.logger).computePlan(taskList, model);
+            const startingPoints = plan.apply(this.selector.units, this.goals, this.selector.labels);
+            if (startingPoints.length === 0) {
+                throw new build_failed_error_1.BuildFailedError(`No task that matches the given goals/labels was found`);
+            }
+            this.steps.transmit({ step: 'PLAN_PREPARED', taskNames: plan.tasks().map(at => at.name) });
+            const ret = await this.executePlan(plan, model);
+            this.steps.transmit({ step: 'BUILD_RUN_ENDED' });
+            await Promise.all([this.fingerprintLedger.close(), this.steps.close()]);
+            return ret;
+        }
+        finally {
+            await this.repoProtocol.close();
+        }
+    }
+    async executePlan(plan, model) {
+        this.logger.info(`plan.taskGraph=${plan.taskGraph}`);
+        const taskTracker = new task_tracker_1.TaskTracker(plan);
+        this.tracker = taskTracker;
+        const taskExecutor = new task_executor_1.TaskExecutor(model, taskTracker, this.logger, this.repoProtocol, this.taskStore, this.taskOutputDir, this.eventPublisher, this.fingerprintLedger, this.purger, this.options.testCaching, this.options.config.verbosePrintTasks);
+        const workFunction = async (tn) => {
+            try {
+                const deps = this.options.config.tightFingerprints
+                    ? taskTracker.getTask(tn).taskInfo.deps ?? []
+                    : plan.taskGraph.neighborsOf(tn);
+                await taskExecutor.executeTask(tn, deps);
+                const task = taskTracker.getTask(tn);
+                const rec = task.record;
+                this.steps.transmit({
+                    step: 'TASK_ENDED',
+                    taskName: tn,
+                    executionType: rec.executionType,
+                    verdict: (0, misc_1.switchOn)(rec.verdict, {
+                        UNKNOWN: () => 'UNKNOWN',
+                        CRASH: () => 'CRASH',
+                        FAIL: () => 'FAIL',
+                        OK: () => 'OK',
+                    }),
+                    durationMillis: task.getDurationMillis(),
+                });
+            }
+            catch (e) {
+                const task = taskTracker.getTask(tn);
+                const rec = task.record;
+                this.logger.info(`crashed while running ${tn}`);
+                this.steps.transmit({
+                    step: 'TASK_ENDED',
+                    taskName: tn,
+                    executionType: rec.executionType,
+                    verdict: 'CRASH',
+                    durationMillis: task.getDurationMillis(),
+                });
+                throw e;
+            }
+            finally {
+                taskTracker.changeStatus(tn, 'DONE');
+            }
+        };
+        await plan.taskGraph.execute(this.options.concurrency, workFunction);
+        return taskTracker;
+    }
+    async executeProgram() {
+        if (!this.options.toRun) {
+            this.logger.info(`no program to execute`);
+            return;
+        }
+        this.logger.info(`about to execute ${JSON.stringify(this.options.toRun)}`);
+        const resolved = this.rootDir.resolve(this.options.toRun.program);
+        const cwd = this.rootDir.resolve(this.options.userDir);
+        const spawnResult = child_process_1.default.spawnSync(resolved, this.options.toRun.args, {
+            cwd,
+            stdio: 'inherit',
+            shell: false,
+        });
+        if (spawnResult.error) {
+            throw new build_failed_error_1.BuildFailedError(`could not execute ${this.options.toRun.program}: ${spawnResult.error}`, 'program');
+        }
+        if (spawnResult.status === 0) {
+            return;
+        }
+        throw new build_failed_error_1.BuildFailedError(`execution of ${this.options.toRun.program} exited with status=${spawnResult.status}, signal=${spawnResult.signal}`, 'program');
+    }
+    async loadModel(buildRunId) {
+        const gitIgnorePath = this.rootDir.resolve((0, core_types_1.PathInRepo)('.gitignore'));
+        const ig = (0, ignore_1.default)();
+        if (await fse.pathExists(gitIgnorePath)) {
+            const gitIgnoreContent = await fse.readFile(gitIgnorePath, 'utf8');
+            const lines = gitIgnoreContent.split('\n');
+            this.logger.info(`Found a .gitignore file:\n${JSON.stringify(lines, null, 2)}`);
+            ig.add(lines);
+        }
+        if (this.options.checkGitIgnore) {
+            const d = '.build-raptor';
+            const ignoresBuildRaptorDir = ig.ignores(d);
+            if (!ignoresBuildRaptorDir) {
+                throw new build_failed_error_1.BuildFailedError(`the ${d} directory should be .gitignore-d`);
+            }
+            const outDirName = this.options.config.outDirName;
+            if (outDirName && !ig.ignores(outDirName)) {
+                throw new build_failed_error_1.BuildFailedError(`the out dir (${outDirName}) should be .gitignore-d`);
+            }
+        }
+        const [graph, units] = await Promise.all([this.repoProtocol.getGraph(), this.repoProtocol.getUnits()]);
+        if (graph.isCyclic()) {
+            throw new build_failed_error_1.BuildFailedError(`Cyclic dependency detected in ${graph}`);
+        }
+        this.logger.info(`unit graph=\n${graph}`);
+        const scanner = new misc_1.DirectoryScanner(this.rootDir.resolve(), { predicate: ig.createFilter() });
+        const fingerprinter = new fingerprinter_1.Fingerprinter(scanner, this.logger, this.options.config.fingerprintSeed, async (h, c) => {
+            if (c) {
+                this.fingerprintLedger.updateFile(h, c);
+            }
+            else {
+                this.fingerprintLedger.updateDirectory(h);
+            }
+        });
+        return new model_1.Model(this.rootDir, graph, units, buildRunId, fingerprinter);
+    }
+}
+exports.Engine = Engine;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"engine.js","sourceRoot":"","sources":["../../src/engine.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAAqD;AAErD,kEAAyC;AACzC,2CAAiD;AACjD,uCAAwB;AACxB,8CAA+B;AAC/B,oDAA2B;AAE3B,+BAAiG;AACjG,2CAA4B;AAE5B,yCAAoC;AAMpC,6DAAuF;AACvF,mDAA+C;AAC/C,mCAA+B;AAC/B,uCAAmC;AACnC,qCAAiC;AAEjC,mDAA8C;AAE9C,iDAA4C;AAkC5C,MAAa,MAAM;IAOjB;;;;;;;;;;;;;OAaG;IACH,YACmB,MAAc,EACd,OAAiB,EACjB,YAA0B,EAC1B,SAAoB,EACpB,aAAqB,EACrB,QAAsB,EACtB,cAAiD,EACjD,KAA4B,EAC7C,OAAsB;QARL,WAAM,GAAN,MAAM,CAAQ;QACd,YAAO,GAAP,OAAO,CAAU;QACjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,cAAS,GAAT,SAAS,CAAW;QACpB,kBAAa,GAAb,aAAa,CAAQ;QACrB,aAAQ,GAAR,QAAQ,CAAc;QACtB,mBAAc,GAAd,cAAc,CAAmC;QACjD,UAAK,GAAL,KAAK,CAAuB;QAG7C,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;YACtD,CAAC,CAAC,OAAO,CAAC,OAAO;YACjB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,uBAAU,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG;YACb,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI;YAC9C,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,IAAI,KAAK;YACrD,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,IAAI;YACxC,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO;YACP,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;SAC5G,CAAA;QACD,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7G,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAC5D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,yBAAyB,CAAC,CAAA;QACpF,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;YACtC,MAAM,IAAI,GACR,CAAC,CAAC,MAAM,KAAK,UAAU;gBACrB,CAAC,CAAC,gBAAgB;gBAClB,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU;oBACzB,CAAC,CAAC,gBAAgB;oBAClB,CAAC,CAAC,IAAA,wBAAiB,EAAC,CAAC,CAAC,MAAM,CAAC,CAAA;YACjC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAA,oBAAQ,GAAE,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;YACxD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAClB,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,QAAQ;gBACR,MAAM;gBACN,IAAI;gBACJ,WAAW,EAAE,CAAC,CAAC,WAAW;gBAC1B,KAAK,EAAE,CAAC,CAAC,KAAK;aACf,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;YACtC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAClB,IAAI,EAAE,YAAY;gBAClB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,OAAO,EAAE,CAAC,CAAC,OAAO;gBAClB,cAAc,EAAE,CAAC,CAAC,cAAc;aACjC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE;YAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;YACvC,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAA,aAAM,EAAC,6BAA6B,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAA;YACpG,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,oBAAQ,GAAE,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;YAC9C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAClB,IAAI,EAAE,iBAAiB;gBACvB,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;gBACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,MAAM;gBACN,WAAW,EAAE,IAAI,CAAC,cAAc,EAAE;gBAClC,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,IAAI,EAAE,CAAC,CAAC,IAAI;aACb,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE;YACxC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5C,OAAM;YACR,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAClB,IAAI,EAAE,cAAc;gBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,WAAW,EAAE,CAAC,CAAC,WAAW;aAC3B,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB;YACrD,CAAC,CAAC,IAAI,+CAA0B,CAAC,MAAM,EAAE,UAAU,CAAC;YACpD,CAAC,CAAC,IAAI,yCAAoB,EAAE,CAAA;QAE9B,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IACrD,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,UAAsB;QAC9B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;QACnG,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,UAAU,CAAC,CAAA;QACpF,MAAM,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QAClD,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAChC,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CACjC,CAAA;QACD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;YAE9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAA;YACnD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YAClE,MAAM,IAAI,GAAG,MAAM,IAAI,iBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;YACxE,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YACxF,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,qCAAgB,CAAC,uDAAuD,CAAC,CAAA;YACrF,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAE1F,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC/C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAA;YAChD,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;YACvE,OAAO,GAAG,CAAA;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;QACjC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAmB,EAAE,KAAY;QACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QACpD,MAAM,WAAW,GAAG,IAAI,0BAAW,CAAC,IAAI,CAAC,CAAA;QACzC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAA;QAC1B,MAAM,YAAY,GAAG,IAAI,4BAAY,CACnC,KAAK,EACL,WAAW,EACX,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,CAAC,WAAW,EACxB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CACtC,CAAA;QAED,MAAM,YAAY,GAAG,KAAK,EAAE,EAAY,EAAE,EAAE;YAC1C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB;oBAChD,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE;oBAC7C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;gBAClC,MAAM,YAAY,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;gBACxC,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBACpC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAA;gBACvB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;oBAClB,IAAI,EAAE,YAAY;oBAClB,QAAQ,EAAE,EAAE;oBACZ,aAAa,EAAE,GAAG,CAAC,aAAa;oBAChC,OAAO,EAAE,IAAA,eAAQ,EAAC,GAAG,CAAC,OAAO,EAAE;wBAC7B,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS;wBACxB,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO;wBACpB,IAAI,EAAE,GAAG,EAAE,CAAC,MAAM;wBAClB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI;qBACf,CAAC;oBACF,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE;iBACzC,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBACpC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAA;gBACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAA;gBAC/C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;oBAClB,IAAI,EAAE,YAAY;oBAClB,QAAQ,EAAE,EAAE;oBACZ,aAAa,EAAE,GAAG,CAAC,aAAa;oBAChC,OAAO,EAAE,OAAO;oBAChB,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE;iBACzC,CAAC,CAAA;gBACF,MAAM,CAAC,CAAA;YACT,CAAC;oBAAS,CAAC;gBACT,WAAW,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;YACtC,CAAC;QACH,CAAC,CAAA;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QACpE,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;YACzC,OAAM;QACR,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACjE,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACtD,MAAM,WAAW,GAAG,uBAAa,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE;YAC7E,GAAG;YACH,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,KAAK;SACb,CAAC,CAAA;QACF,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,qCAAgB,CAAC,qBAAqB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,KAAK,WAAW,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC,CAAA;QAChH,CAAC;QAED,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAM;QACR,CAAC;QAED,MAAM,IAAI,qCAAgB,CACxB,gBAAgB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,uBAAuB,WAAW,CAAC,MAAM,YAAY,WAAW,CAAC,MAAM,EAAE,EACnH,SAAS,CACV,CAAA;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,UAAsB;QACpC,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,uBAAU,EAAC,YAAY,CAAC,CAAC,CAAA;QACpE,MAAM,EAAE,GAAG,IAAA,gBAAM,GAAE,CAAA;QACnB,IAAI,MAAM,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YACxC,MAAM,gBAAgB,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;YAClE,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YAC/E,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACf,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAChC,MAAM,CAAC,GAAG,eAAe,CAAA;YACzB,MAAM,qBAAqB,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;YAC3C,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC3B,MAAM,IAAI,qCAAgB,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAA;YACzE,CAAC;YAED,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAA;YACjD,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1C,MAAM,IAAI,qCAAgB,CAAC,gBAAgB,UAAU,0BAA0B,CAAC,CAAA;YAClF,CAAC;QACH,CAAC;QAED,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QACtG,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,qCAAgB,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAA;QACtE,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,KAAK,EAAE,CAAC,CAAA;QACzC,MAAM,OAAO,GAAG,IAAI,uBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;QAC9F,MAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;YAChH,IAAI,CAAC,EAAE,CAAC;gBACN,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YACzC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;YAC3C,CAAC;QACH,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,aAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,aAAa,CAAC,CAAA;IACzE,CAAC;CACF;AA7QD,wBA6QC"}

package/dist/deps/build-raptor-core/examplify-zod.d.ts

@@ -0,0 +1,93 @@
+import { z } from 'zod';
+/**
+ * Generates a formatted example from a Zod schema with default values and descriptions.
+ *
+ * Converts any supported Zod schema into a human-readable example showing the data
+ * structure with defaults. Useful for generating annotated configuration files that
+ * serve as both documentation and a working starting point.
+ *
+ * **Note**: Output is formatted for readability and is not valid JSON (contains
+ * inline comments and trailing commas).
+ *
+ * @example
+ * ```ts
+ * const schema = z.object({
+ *   port: z.number().default(3000).describe('Server port'),
+ *   host: z.string().optional()
+ * })
+ *
+ * console.log(examplifyZod(schema))
+ * // Output:
+ * {
+ *   // Server port
+ *   // port: 3000,
+ *
+ *   // host: "",
+ * }
+ *
+ * console.log(examplifyZod(schema, { comment: false }))
+ * // Output:
+ * {
+ *   // Server port
+ *   port: 3000,
+ *
+ *   // host: "",
+ * }
+ * ```
+ *
+ * @param input - Any Zod schema (object, primitive, array, union, etc.)
+ * @param options - Formatting options (see {@link ExamplifyZodOptions})
+ * @returns A formatted string example matching the schema structure with defaults populated
+ *
+ * @remarks
+ * ### Default Values
+ * - **Primitives**: Use type defaults: `0`, `""`, `false`
+ * - **Arrays**: Always shown as an empty array `[]`
+ * - **Objects**: Empty object `{}`
+ * - **With `.default()`**: Uses the specified default value
+ *
+ * ### Nullable/Optional Handling
+ * These modifiers are unwrapped to show the underlying type's default.
+ *
+ * ⚠️ **Order matters with `.default()`**:
+ * - `.nullable().default(5)` → uses `5`
+ * - `.default(5).nullable()` → uses type default `0` (`.nullable()` wraps after default is set)
+ *
+ * The same applies to `.optional()`.
+ *
+ * ### Unions
+ * Uses the first option's default value unless an explicit `.default()` is provided.
+ *
+ * ### Descriptions
+ * Property descriptions always appear as comments above their properties, regardless
+ * of the `comment` option. Multi-line descriptions are supported.
+ *
+ * ### Unsupported Types
+ * Unrecognized Zod types (enums, literals, records, tuples, intersections, etc.)
+ * are rendered as the string `'unknown'` with a default value of `null`.
+ */
+export declare function examplifyZod(input: z.ZodTypeAny, options?: ExamplifyZodOptions): string;
+/**
+ * Options for controlling the output format of examplifyZod().
+ */
+export interface ExamplifyZodOptions {
+    /**
+     * Whether to comment out property lines with '//' markers.
+     * When false, outputs property lines without comment prefix.
+     * When true, all property lines are commented.
+     * @default true
+     */
+    comment?: boolean;
+    /**
+     * Whether to also comment the outermost object braces.
+     * Only applies when `comment` is true. Useful for embedding in existing JSON.
+     * @default false
+     */
+    commentAlsoOutermostBraces?: boolean;
+    /**
+     * Column position where comment markers ('//' prefix) start.
+     * Controls horizontal alignment of comments.
+     * @default 2
+     */
+    commentIndentation?: number;
+}