@expo/steps 0.0.7 → 0.0.9

package/dist_esm/BuildConfig.js

@@ -0,0 +1,101 @@
+import assert from 'assert';
+import Joi from 'joi';
+import { BuildConfigError } from './errors/BuildConfigError.js';
+import { BuildPlatform } from './BuildPlatform.js';
+const BuildInputOutputParametersSchema = Joi.array().items(Joi.alternatives().try(Joi.string().required(), Joi.object({
+    name: Joi.string().required(),
+    required: Joi.boolean(),
+}).required()));
+const BuildFunctionCallSchema = Joi.object({
+    id: Joi.string(),
+    inputs: Joi.object().pattern(Joi.string(), Joi.string()),
+    name: Joi.string(),
+    workingDirectory: Joi.string(),
+    shell: Joi.string(),
+}).rename('working_directory', 'workingDirectory');
+const BuildStepConfigSchema = Joi.any()
+    .when(Joi.object().pattern(Joi.string().disallow('run').required(), Joi.object().unknown().required()), {
+    then: Joi.object().pattern(Joi.string().disallow('run').min(1).required(), BuildFunctionCallSchema.required(), { matches: Joi.array().length(1) }),
+})
+    .when(Joi.object({ run: Joi.object().unknown().required() }), {
+    then: Joi.object({
+        run: BuildFunctionCallSchema.keys({
+            outputs: BuildInputOutputParametersSchema,
+            command: Joi.string().required(),
+        }),
+    }),
+})
+    .when(Joi.object({ run: Joi.string().required() }), {
+    then: Joi.object({
+        run: Joi.string().min(1).required(),
+    }),
+})
+    .when(Joi.string(), {
+    then: Joi.string().min(1),
+});
+const BuildFunctionConfigSchema = Joi.object({
+    name: Joi.string(),
+    platforms: Joi.string().allow(...Object.values(BuildPlatform)),
+    inputs: BuildInputOutputParametersSchema,
+    outputs: BuildInputOutputParametersSchema,
+    command: Joi.string().required(),
+    shell: Joi.string(),
+});
+export const BuildConfigSchema = Joi.object({
+    build: Joi.object({
+        name: Joi.string(),
+        steps: Joi.array().items(BuildStepConfigSchema.required()).required(),
+    }).required(),
+    functions: Joi.object().pattern(Joi.string()
+        .pattern(/^[\w-]+$/, 'function names')
+        .min(1)
+        .required()
+        .disallow('run'), BuildFunctionConfigSchema.required()),
+}).required();
+export function isBuildStepCommandRun(step) {
+    return typeof step === 'object' && typeof step.run === 'object';
+}
+export function isBuildStepBareCommandRun(step) {
+    return typeof step === 'object' && typeof step.run === 'string';
+}
+export function isBuildStepFunctionCall(step) {
+    return typeof step === 'object' && !('run' in step);
+}
+export function isBuildStepBareFunctionCall(step) {
+    return typeof step === 'string';
+}
+export function validateBuildConfig(rawConfig, externalFunctionIds) {
+    const { error, value: buildConfig } = BuildConfigSchema.validate(rawConfig, {
+        allowUnknown: false,
+        abortEarly: false,
+    });
+    if (error) {
+        const errorMessage = error.details.map(({ message }) => message).join(', ');
+        throw new BuildConfigError(errorMessage, { cause: error });
+    }
+    validateAllFunctionsExist(buildConfig, externalFunctionIds);
+    return buildConfig;
+}
+function validateAllFunctionsExist(config, externalFunctionIds) {
+    const calledFunctionsSet = new Set();
+    for (const step of config.build.steps) {
+        if (typeof step === 'string') {
+            calledFunctionsSet.add(step);
+        }
+        else if (!('run' in step)) {
+            const keys = Object.keys(step);
+            assert(keys.length === 1, 'There must be at most one function call in the step (enforced by joi).');
+            calledFunctionsSet.add(keys[0]);
+        }
+    }
+    const calledFunctions = Array.from(calledFunctionsSet);
+    const externalFunctionIdsSet = new Set(externalFunctionIds);
+    const nonExistentFunctions = calledFunctions.filter((calledFunction) => {
+        var _a;
+        return (!(calledFunction in ((_a = config.functions) !== null && _a !== void 0 ? _a : {})) && !externalFunctionIdsSet.has(calledFunction));
+    });
+    if (nonExistentFunctions.length > 0) {
+        throw new BuildConfigError(`Calling non-existent functions: ${nonExistentFunctions.map((f) => `"${f}"`).join(', ')}.`);
+    }
+}
+//# sourceMappingURL=BuildConfig.js.map

package/dist_esm/BuildConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BuildConfig.js","sourceRoot":"","sources":["../src/BuildConfig.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AA2DnD,MAAM,gCAAgC,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CACxD,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CACpB,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EACvB,GAAG,CAAC,MAAM,CAAC;IACT,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE;CACxB,CAAC,CAAC,QAAQ,EAAE,CACd,CACF,CAAC;AAEF,MAAM,uBAAuB,GAAG,GAAG,CAAC,MAAM,CAAC;IACzC,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC;IACxD,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE;IAClB,gBAAgB,EAAE,GAAG,CAAC,MAAM,EAAE;IAC9B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC,MAAM,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;AAEnD,MAAM,qBAAqB,GAAG,GAAG,CAAC,GAAG,EAAmB;KACrD,IAAI,CACH,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAClB,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EACvC,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAClC,EACD;IACE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CACxB,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAC9C,uBAAuB,CAAC,QAAQ,EAAE,EAClC,EAAE,OAAO,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CACnC;CACF,CACF;KACA,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE;IAC5D,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC;QACf,GAAG,EAAE,uBAAuB,CAAC,IAAI,CAAC;YAChC,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACjC,CAAC;KACH,CAAC;CACH,CAAC;KACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE;IAClD,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC;QACf,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;KACpC,CAAC;CACH,CAAC;KACD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE;IAClB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC1B,CAAC,CAAC;AAEL,MAAM,yBAAyB,GAAG,GAAG,CAAC,MAAM,CAAC;IAC3C,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC9D,MAAM,EAAE,gCAAgC;IACxC,OAAO,EAAE,gCAAgC;IACzC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC,MAAM,CAAc;IACvD,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC;QAChB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE;QAClB,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE;KACtE,CAAC,CAAC,QAAQ,EAAE;IACb,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAC7B,GAAG,CAAC,MAAM,EAAE;SACT,OAAO,CAAC,UAAU,EAAE,gBAAgB,CAAC;SACrC,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,KAAK,CAAC,EAClB,yBAAyB,CAAC,QAAQ,EAAE,CACrC;CACF,CAAC,CAAC,QAAQ,EAAE,CAAC;AAEd,MAAM,UAAU,qBAAqB,CAAC,IAAqB;IACzD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAAqB;IAC7D,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,IAAqB;IAC3D,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,IAAqB;IAErB,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,SAAiB,EAAE,mBAA6B;IAClF,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC,QAAQ,CAAC,SAAS,EAAE;QAC1E,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IACH,IAAI,KAAK,EAAE;QACT,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5E,MAAM,IAAI,gBAAgB,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;KAC5D;IACD,yBAAyB,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAC5D,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAmB,EAAE,mBAA6B;IACnF,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC7C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE;QACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SAC9B;aAAM,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,CACJ,IAAI,CAAC,MAAM,KAAK,CAAC,EACjB,wEAAwE,CACzE,CAAC;YACF,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACjC;KACF;IACD,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACvD,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC5D,MAAM,oBAAoB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE;;QACrE,OAAO,CACL,CAAC,CAAC,cAAc,IAAI,CAAC,MAAA,MAAM,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAC,CAC7F,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;QACnC,MAAM,IAAI,gBAAgB,CACxB,mCAAmC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC3F,CAAC;KACH;AACH,CAAC","sourcesContent":["import assert from 'assert';\n\nimport Joi from 'joi';\n\nimport { BuildConfigError } from './errors/BuildConfigError.js';\nimport { BuildPlatform } from './BuildPlatform.js';\n\nexport interface BuildConfig {\n  build: {\n    name?: string;\n    steps: BuildStepConfig[];\n  };\n  functions?: Record<string, BuildFunctionConfig>;\n}\n\nexport type BuildStepConfig =\n  | BuildStepCommandRun\n  | BuildStepBareCommandRun\n  | BuildStepFunctionCall\n  | BuildStepBareFunctionCall;\n\nexport type BuildStepCommandRun = {\n  run: BuildFunctionCallConfig & {\n    outputs?: BuildStepOutputs;\n    command: string;\n  };\n};\nexport type BuildStepBareCommandRun = { run: string };\nexport type BuildStepFunctionCall = {\n  [functionId: string]: BuildFunctionCallConfig;\n};\nexport type BuildStepBareFunctionCall = string;\n\nexport type BuildFunctionCallConfig = {\n  id?: string;\n  inputs?: BuildStepInputs;\n  name?: string;\n  workingDirectory?: string;\n  shell?: string;\n};\n\nexport type BuildStepInputs = Record<string, string>;\nexport type BuildStepOutputs = BuildInputOutputParameters;\n\nexport interface BuildFunctionConfig {\n  inputs?: BuildFunctionInputs;\n  outputs?: BuildFunctionOutputs;\n  name?: string;\n  platforms?: BuildPlatform[];\n  shell?: string;\n  command: string;\n}\n\nexport type BuildFunctionInputs = BuildInputOutputParameters;\nexport type BuildFunctionOutputs = BuildInputOutputParameters;\n\nexport type BuildInputOutputParameters = (\n  | string\n  | {\n      name: string;\n      required?: boolean;\n    }\n)[];\n\nconst BuildInputOutputParametersSchema = Joi.array().items(\n  Joi.alternatives().try(\n    Joi.string().required(),\n    Joi.object({\n      name: Joi.string().required(),\n      required: Joi.boolean(),\n    }).required()\n  )\n);\n\nconst BuildFunctionCallSchema = Joi.object({\n  id: Joi.string(),\n  inputs: Joi.object().pattern(Joi.string(), Joi.string()),\n  name: Joi.string(),\n  workingDirectory: Joi.string(),\n  shell: Joi.string(),\n}).rename('working_directory', 'workingDirectory');\n\nconst BuildStepConfigSchema = Joi.any<BuildStepConfig>()\n  .when(\n    Joi.object().pattern(\n      Joi.string().disallow('run').required(),\n      Joi.object().unknown().required()\n    ),\n    {\n      then: Joi.object().pattern(\n        Joi.string().disallow('run').min(1).required(),\n        BuildFunctionCallSchema.required(),\n        { matches: Joi.array().length(1) }\n      ),\n    }\n  )\n  .when(Joi.object({ run: Joi.object().unknown().required() }), {\n    then: Joi.object({\n      run: BuildFunctionCallSchema.keys({\n        outputs: BuildInputOutputParametersSchema,\n        command: Joi.string().required(),\n      }),\n    }),\n  })\n  .when(Joi.object({ run: Joi.string().required() }), {\n    then: Joi.object({\n      run: Joi.string().min(1).required(),\n    }),\n  })\n  .when(Joi.string(), {\n    then: Joi.string().min(1),\n  });\n\nconst BuildFunctionConfigSchema = Joi.object({\n  name: Joi.string(),\n  platforms: Joi.string().allow(...Object.values(BuildPlatform)),\n  inputs: BuildInputOutputParametersSchema,\n  outputs: BuildInputOutputParametersSchema,\n  command: Joi.string().required(),\n  shell: Joi.string(),\n});\n\nexport const BuildConfigSchema = Joi.object<BuildConfig>({\n  build: Joi.object({\n    name: Joi.string(),\n    steps: Joi.array().items(BuildStepConfigSchema.required()).required(),\n  }).required(),\n  functions: Joi.object().pattern(\n    Joi.string()\n      .pattern(/^[\\w-]+$/, 'function names')\n      .min(1)\n      .required()\n      .disallow('run'),\n    BuildFunctionConfigSchema.required()\n  ),\n}).required();\n\nexport function isBuildStepCommandRun(step: BuildStepConfig): step is BuildStepCommandRun {\n  return typeof step === 'object' && typeof step.run === 'object';\n}\n\nexport function isBuildStepBareCommandRun(step: BuildStepConfig): step is BuildStepBareCommandRun {\n  return typeof step === 'object' && typeof step.run === 'string';\n}\n\nexport function isBuildStepFunctionCall(step: BuildStepConfig): step is BuildStepFunctionCall {\n  return typeof step === 'object' && !('run' in step);\n}\n\nexport function isBuildStepBareFunctionCall(\n  step: BuildStepConfig\n): step is BuildStepBareFunctionCall {\n  return typeof step === 'string';\n}\n\nexport function validateBuildConfig(rawConfig: object, externalFunctionIds: string[]): BuildConfig {\n  const { error, value: buildConfig } = BuildConfigSchema.validate(rawConfig, {\n    allowUnknown: false,\n    abortEarly: false,\n  });\n  if (error) {\n    const errorMessage = error.details.map(({ message }) => message).join(', ');\n    throw new BuildConfigError(errorMessage, { cause: error });\n  }\n  validateAllFunctionsExist(buildConfig, externalFunctionIds);\n  return buildConfig;\n}\n\nfunction validateAllFunctionsExist(config: BuildConfig, externalFunctionIds: string[]): void {\n  const calledFunctionsSet = new Set<string>();\n  for (const step of config.build.steps) {\n    if (typeof step === 'string') {\n      calledFunctionsSet.add(step);\n    } else if (!('run' in step)) {\n      const keys = Object.keys(step);\n      assert(\n        keys.length === 1,\n        'There must be at most one function call in the step (enforced by joi).'\n      );\n      calledFunctionsSet.add(keys[0]);\n    }\n  }\n  const calledFunctions = Array.from(calledFunctionsSet);\n  const externalFunctionIdsSet = new Set(externalFunctionIds);\n  const nonExistentFunctions = calledFunctions.filter((calledFunction) => {\n    return (\n      !(calledFunction in (config.functions ?? {})) && !externalFunctionIdsSet.has(calledFunction)\n    );\n  });\n  if (nonExistentFunctions.length > 0) {\n    throw new BuildConfigError(\n      `Calling non-existent functions: ${nonExistentFunctions.map((f) => `\"${f}\"`).join(', ')}.`\n    );\n  }\n}\n"]}

package/dist_esm/BuildConfigParser.d.ts

@@ -0,0 +1,24 @@
+import { BuildFunction } from './BuildFunction.js';
+import { BuildStepContext } from './BuildStepContext.js';
+import { BuildWorkflow } from './BuildWorkflow.js';
+export declare class BuildConfigParser {
+    private readonly ctx;
+    private readonly configPath;
+    private readonly externalFunctions?;
+    constructor(ctx: BuildStepContext, { configPath, externalFunctions }: {
+        configPath: string;
+        externalFunctions?: BuildFunction[];
+    });
+    parseAsync(): Promise<BuildWorkflow>;
+    private readRawConfigAsync;
+    private createBuildStepFromConfig;
+    private createBuildFunctionsFromConfig;
+    private createBuildFunctionFromConfig;
+    private createBuildStepInputsFromBuildStepInputsDefinition;
+    private createBuildStepInputProvidersFromBuildFunctionInputs;
+    private createBuildStepOutputsFromDefinition;
+    private createBuildStepOutputProvidersFromBuildFunctionOutputs;
+    private mergeBuildFunctionsWithExternal;
+    private validateExternalFunctions;
+    private getUniqueExternalFunctionIds;
+}

package/dist_esm/BuildConfigParser.js

@@ -0,0 +1,170 @@
+import assert from 'assert';
+import fs from 'fs/promises';
+import { v4 as uuidv4 } from 'uuid';
+import YAML from 'yaml';
+import { isBuildStepBareCommandRun, isBuildStepBareFunctionCall, isBuildStepCommandRun, validateBuildConfig, } from './BuildConfig.js';
+import { BuildFunction } from './BuildFunction.js';
+import { BuildStep } from './BuildStep.js';
+import { BuildStepInput } from './BuildStepInput.js';
+import { BuildStepOutput } from './BuildStepOutput.js';
+import { BuildWorkflow } from './BuildWorkflow.js';
+import { BuildWorkflowValidator } from './BuildWorkflowValidator.js';
+import { BuildStepRuntimeError } from './errors/BuildStepRuntimeError.js';
+import { duplicates } from './utils/expodash/duplicates.js';
+import { uniq } from './utils/expodash/uniq.js';
+export class BuildConfigParser {
+    constructor(ctx, { configPath, externalFunctions }) {
+        this.ctx = ctx;
+        this.validateExternalFunctions(externalFunctions);
+        this.configPath = configPath;
+        this.externalFunctions = externalFunctions;
+    }
+    async parseAsync() {
+        const rawConfig = await this.readRawConfigAsync();
+        const config = validateBuildConfig(rawConfig, this.getUniqueExternalFunctionIds());
+        const configBuildFunctions = this.createBuildFunctionsFromConfig(config.functions);
+        const buildFunctions = this.mergeBuildFunctionsWithExternal(configBuildFunctions, this.externalFunctions);
+        const buildSteps = config.build.steps.map((stepConfig) => this.createBuildStepFromConfig(stepConfig, buildFunctions));
+        const workflow = new BuildWorkflow(this.ctx, { buildSteps, buildFunctions });
+        new BuildWorkflowValidator(workflow).validate();
+        return workflow;
+    }
+    async readRawConfigAsync() {
+        const contents = await fs.readFile(this.configPath, 'utf-8');
+        return YAML.parse(contents);
+    }
+    createBuildStepFromConfig(buildStepConfig, buildFunctions) {
+        if (isBuildStepCommandRun(buildStepConfig)) {
+            const { id, inputs: inputsConfig, outputs: outputsConfig, name, workingDirectory, shell, command, } = buildStepConfig.run;
+            const stepId = id !== null && id !== void 0 ? id : uuidv4();
+            const inputs = inputsConfig &&
+                this.createBuildStepInputsFromBuildStepInputsDefinition(inputsConfig, stepId);
+            const outputs = outputsConfig && this.createBuildStepOutputsFromDefinition(outputsConfig, stepId);
+            return new BuildStep(this.ctx, {
+                id: stepId,
+                inputs,
+                outputs,
+                name,
+                workingDirectory,
+                shell,
+                command,
+            });
+        }
+        else if (isBuildStepBareCommandRun(buildStepConfig)) {
+            const command = buildStepConfig.run;
+            return new BuildStep(this.ctx, {
+                id: uuidv4(),
+                command,
+            });
+        }
+        else if (isBuildStepBareFunctionCall(buildStepConfig)) {
+            const functionId = buildStepConfig;
+            const buildFunction = buildFunctions[functionId];
+            return buildFunction.createBuildStepFromFunctionCall(this.ctx);
+        }
+        else {
+            const keys = Object.keys(buildStepConfig);
+            assert(keys.length === 1, 'There must be at most one function call in the step (enforced by joi).');
+            const functionId = keys[0];
+            const buildFunctionCallConfig = buildStepConfig[functionId];
+            const buildFunction = buildFunctions[functionId];
+            return buildFunction.createBuildStepFromFunctionCall(this.ctx, {
+                id: buildFunctionCallConfig.id,
+                name: buildFunctionCallConfig.name,
+                callInputs: buildFunctionCallConfig.inputs,
+                workingDirectory: buildFunctionCallConfig.workingDirectory,
+                shell: buildFunctionCallConfig.shell,
+            });
+        }
+    }
+    createBuildFunctionsFromConfig(buildFunctionsConfig) {
+        if (!buildFunctionsConfig) {
+            return {};
+        }
+        const result = {};
+        for (const [functionId, buildFunctionConfig] of Object.entries(buildFunctionsConfig)) {
+            const buildFunction = this.createBuildFunctionFromConfig({
+                id: functionId,
+                ...buildFunctionConfig,
+            });
+            result[buildFunction.getFullId()] = buildFunction;
+        }
+        return result;
+    }
+    createBuildFunctionFromConfig({ id, name, inputs: inputsConfig, outputs: outputsConfig, shell, command, }) {
+        const inputProviders = inputsConfig && this.createBuildStepInputProvidersFromBuildFunctionInputs(inputsConfig);
+        const outputProviders = outputsConfig && this.createBuildStepOutputProvidersFromBuildFunctionOutputs(outputsConfig);
+        return new BuildFunction({ id, name, inputProviders, outputProviders, shell, command });
+    }
+    createBuildStepInputsFromBuildStepInputsDefinition(buildStepInputs, stepId) {
+        return Object.entries(buildStepInputs).map(([key, value]) => new BuildStepInput(this.ctx, {
+            id: key,
+            stepId,
+            defaultValue: value,
+            required: true,
+        }));
+    }
+    createBuildStepInputProvidersFromBuildFunctionInputs(buildFunctionInputs) {
+        return buildFunctionInputs.map((entry) => {
+            var _a;
+            return typeof entry === 'string'
+                ? BuildStepInput.createProvider({ id: entry })
+                : BuildStepInput.createProvider({ id: entry.name, required: (_a = entry.required) !== null && _a !== void 0 ? _a : true });
+        });
+    }
+    createBuildStepOutputsFromDefinition(buildStepOutputs, stepId) {
+        return buildStepOutputs.map((entry) => {
+            var _a;
+            return typeof entry === 'string'
+                ? new BuildStepOutput(this.ctx, { id: entry, stepId, required: true })
+                : new BuildStepOutput(this.ctx, {
+                    id: entry.name,
+                    stepId,
+                    required: (_a = entry.required) !== null && _a !== void 0 ? _a : true,
+                });
+        });
+    }
+    createBuildStepOutputProvidersFromBuildFunctionOutputs(buildFunctionOutputs) {
+        return buildFunctionOutputs.map((entry) => {
+            var _a;
+            return typeof entry === 'string'
+                ? BuildStepOutput.createProvider({ id: entry, required: true })
+                : BuildStepOutput.createProvider({ id: entry.name, required: (_a = entry.required) !== null && _a !== void 0 ? _a : true });
+        });
+    }
+    mergeBuildFunctionsWithExternal(configFunctions, externalFunctions) {
+        const result = { ...configFunctions };
+        if (externalFunctions === undefined) {
+            return result;
+        }
+        for (const buildFunction of externalFunctions) {
+            // functions defined in config shadow the external ones
+            const fullId = buildFunction.getFullId();
+            if (!(fullId in result)) {
+                result[fullId] = buildFunction;
+            }
+        }
+        return result;
+    }
+    validateExternalFunctions(externalFunctions) {
+        if (externalFunctions === undefined) {
+            return;
+        }
+        const externalFunctionIds = externalFunctions.map((f) => f.getFullId());
+        const duplicatedExternalFunctionIds = duplicates(externalFunctionIds);
+        if (duplicatedExternalFunctionIds.length === 0) {
+            return;
+        }
+        throw new BuildStepRuntimeError(`Provided external functions with duplicated IDs: ${duplicatedExternalFunctionIds
+            .map((id) => `"${id}"`)
+            .join(', ')}`);
+    }
+    getUniqueExternalFunctionIds() {
+        if (this.externalFunctions === undefined) {
+            return [];
+        }
+        const ids = this.externalFunctions.map((f) => f.getFullId());
+        return uniq(ids);
+    }
+}
+//# sourceMappingURL=BuildConfigParser.js.map

package/dist_esm/BuildConfigParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BuildConfigParser.js","sourceRoot":"","sources":["../src/BuildConfigParser.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,MAAM,aAAa,CAAC;AAE7B,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAQL,yBAAyB,EACzB,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAqB,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,cAAc,EAA0B,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAA2B,MAAM,sBAAsB,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAEhD,MAAM,OAAO,iBAAiB;IAI5B,YACmB,GAAqB,EACtC,EAAE,UAAU,EAAE,iBAAiB,EAA+D;QAD7E,QAAG,GAAH,GAAG,CAAkB;QAGtC,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QAElD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,MAAM,MAAM,GAAG,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,4BAA4B,EAAE,CAAC,CAAC;QACnF,MAAM,oBAAoB,GAAG,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACnF,MAAM,cAAc,GAAG,IAAI,CAAC,+BAA+B,CACzD,oBAAoB,EACpB,IAAI,CAAC,iBAAiB,CACvB,CAAC;QACF,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CACvD,IAAI,CAAC,yBAAyB,CAAC,UAAU,EAAE,cAAc,CAAC,CAC3D,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAC;QAC7E,IAAI,sBAAsB,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,kBAAkB;QAC9B,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAEO,yBAAyB,CAC/B,eAAgC,EAChC,cAAiC;QAEjC,IAAI,qBAAqB,CAAC,eAAe,CAAC,EAAE;YAC1C,MAAM,EACJ,EAAE,EACF,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,aAAa,EACtB,IAAI,EACJ,gBAAgB,EAChB,KAAK,EACL,OAAO,GACR,GAAG,eAAe,CAAC,GAAG,CAAC;YACxB,MAAM,MAAM,GAAG,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,MAAM,EAAE,CAAC;YAC9B,MAAM,MAAM,GACV,YAAY;gBACZ,IAAI,CAAC,kDAAkD,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAChF,MAAM,OAAO,GACX,aAAa,IAAI,IAAI,CAAC,oCAAoC,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YACpF,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC7B,EAAE,EAAE,MAAM;gBACV,MAAM;gBACN,OAAO;gBACP,IAAI;gBACJ,gBAAgB;gBAChB,KAAK;gBACL,OAAO;aACR,CAAC,CAAC;SACJ;aAAM,IAAI,yBAAyB,CAAC,eAAe,CAAC,EAAE;YACrD,MAAM,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC;YACpC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC7B,EAAE,EAAE,MAAM,EAAE;gBACZ,OAAO;aACR,CAAC,CAAC;SACJ;aAAM,IAAI,2BAA2B,CAAC,eAAe,CAAC,EAAE;YACvD,MAAM,UAAU,GAAG,eAAe,CAAC;YACnC,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;YACjD,OAAO,aAAa,CAAC,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAChE;aAAM;YACL,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC1C,MAAM,CACJ,IAAI,CAAC,MAAM,KAAK,CAAC,EACjB,wEAAwE,CACzE,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,uBAAuB,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;YACjD,OAAO,aAAa,CAAC,+BAA+B,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC7D,EAAE,EAAE,uBAAuB,CAAC,EAAE;gBAC9B,IAAI,EAAE,uBAAuB,CAAC,IAAI;gBAClC,UAAU,EAAE,uBAAuB,CAAC,MAAM;gBAC1C,gBAAgB,EAAE,uBAAuB,CAAC,gBAAgB;gBAC1D,KAAK,EAAE,uBAAuB,CAAC,KAAK;aACrC,CAAC,CAAC;SACJ;IACH,CAAC;IAEO,8BAA8B,CACpC,oBAA8C;QAE9C,IAAI,CAAC,oBAAoB,EAAE;YACzB,OAAO,EAAE,CAAC;SACX;QACD,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC,UAAU,EAAE,mBAAmB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE;YACpF,MAAM,aAAa,GAAG,IAAI,CAAC,6BAA6B,CAAC;gBACvD,EAAE,EAAE,UAAU;gBACd,GAAG,mBAAmB;aACvB,CAAC,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,GAAG,aAAa,CAAC;SACnD;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,6BAA6B,CAAC,EACpC,EAAE,EACF,IAAI,EACJ,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,aAAa,EACtB,KAAK,EACL,OAAO,GAC8B;QACrC,MAAM,cAAc,GAClB,YAAY,IAAI,IAAI,CAAC,oDAAoD,CAAC,YAAY,CAAC,CAAC;QAC1F,MAAM,eAAe,GACnB,aAAa,IAAI,IAAI,CAAC,sDAAsD,CAAC,aAAa,CAAC,CAAC;QAC9F,OAAO,IAAI,aAAa,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAEO,kDAAkD,CACxD,eAAgC,EAChC,MAAc;QAEd,OAAO,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,GAAG,CACxC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACf,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE;YAC3B,EAAE,EAAE,GAAG;YACP,MAAM;YACN,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,IAAI;SACf,CAAC,CACL,CAAC;IACJ,CAAC;IAEO,oDAAoD,CAC1D,mBAAwC;QAExC,OAAO,mBAAmB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;YACvC,OAAO,OAAO,KAAK,KAAK,QAAQ;gBAC9B,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;gBAC9C,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAA,KAAK,CAAC,QAAQ,mCAAI,IAAI,EAAE,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,oCAAoC,CAC1C,gBAAkC,EAClC,MAAc;QAEd,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpC,OAAA,OAAO,KAAK,KAAK,QAAQ;gBACvB,CAAC,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBACtE,CAAC,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE;oBAC5B,EAAE,EAAE,KAAK,CAAC,IAAI;oBACd,MAAM;oBACN,QAAQ,EAAE,MAAA,KAAK,CAAC,QAAQ,mCAAI,IAAI;iBACjC,CAAC,CAAA;SAAA,CACP,CAAC;IACJ,CAAC;IAEO,sDAAsD,CAC5D,oBAA0C;QAE1C,OAAO,oBAAoB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;YACxC,OAAA,OAAO,KAAK,KAAK,QAAQ;gBACvB,CAAC,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC/D,CAAC,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAA,KAAK,CAAC,QAAQ,mCAAI,IAAI,EAAE,CAAC,CAAA;SAAA,CACzF,CAAC;IACJ,CAAC;IAEO,+BAA+B,CACrC,eAAkC,EAClC,iBAAmC;QAEnC,MAAM,MAAM,GAAsB,EAAE,GAAG,eAAe,EAAE,CAAC;QACzD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACnC,OAAO,MAAM,CAAC;SACf;QACD,KAAK,MAAM,aAAa,IAAI,iBAAiB,EAAE;YAC7C,uDAAuD;YACvD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE;gBACvB,MAAM,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC;aAChC;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,yBAAyB,CAAC,iBAAmC;QACnE,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACnC,OAAO;SACR;QACD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;QACxE,MAAM,6BAA6B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;QACtE,IAAI,6BAA6B,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9C,OAAO;SACR;QACD,MAAM,IAAI,qBAAqB,CAC7B,oDAAoD,6BAA6B;aAC9E,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;aACtB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,CAAC;IAEO,4BAA4B;QAClC,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE;YACxC,OAAO,EAAE,CAAC;SACX;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;CACF","sourcesContent":["import assert from 'assert';\nimport fs from 'fs/promises';\n\nimport { v4 as uuidv4 } from 'uuid';\nimport YAML from 'yaml';\n\nimport {\n  BuildConfig,\n  BuildFunctionConfig,\n  BuildFunctionInputs,\n  BuildFunctionOutputs,\n  BuildStepConfig,\n  BuildStepInputs,\n  BuildStepOutputs,\n  isBuildStepBareCommandRun,\n  isBuildStepBareFunctionCall,\n  isBuildStepCommandRun,\n  validateBuildConfig,\n} from './BuildConfig.js';\nimport { BuildFunction, BuildFunctionById } from './BuildFunction.js';\nimport { BuildStep } from './BuildStep.js';\nimport { BuildStepContext } from './BuildStepContext.js';\nimport { BuildStepInput, BuildStepInputProvider } from './BuildStepInput.js';\nimport { BuildStepOutput, BuildStepOutputProvider } from './BuildStepOutput.js';\nimport { BuildWorkflow } from './BuildWorkflow.js';\nimport { BuildWorkflowValidator } from './BuildWorkflowValidator.js';\nimport { BuildStepRuntimeError } from './errors/BuildStepRuntimeError.js';\nimport { duplicates } from './utils/expodash/duplicates.js';\nimport { uniq } from './utils/expodash/uniq.js';\n\nexport class BuildConfigParser {\n  private readonly configPath: string;\n  private readonly externalFunctions?: BuildFunction[];\n\n  constructor(\n    private readonly ctx: BuildStepContext,\n    { configPath, externalFunctions }: { configPath: string; externalFunctions?: BuildFunction[] }\n  ) {\n    this.validateExternalFunctions(externalFunctions);\n\n    this.configPath = configPath;\n    this.externalFunctions = externalFunctions;\n  }\n\n  public async parseAsync(): Promise<BuildWorkflow> {\n    const rawConfig = await this.readRawConfigAsync();\n    const config = validateBuildConfig(rawConfig, this.getUniqueExternalFunctionIds());\n    const configBuildFunctions = this.createBuildFunctionsFromConfig(config.functions);\n    const buildFunctions = this.mergeBuildFunctionsWithExternal(\n      configBuildFunctions,\n      this.externalFunctions\n    );\n    const buildSteps = config.build.steps.map((stepConfig) =>\n      this.createBuildStepFromConfig(stepConfig, buildFunctions)\n    );\n    const workflow = new BuildWorkflow(this.ctx, { buildSteps, buildFunctions });\n    new BuildWorkflowValidator(workflow).validate();\n    return workflow;\n  }\n\n  private async readRawConfigAsync(): Promise<any> {\n    const contents = await fs.readFile(this.configPath, 'utf-8');\n    return YAML.parse(contents);\n  }\n\n  private createBuildStepFromConfig(\n    buildStepConfig: BuildStepConfig,\n    buildFunctions: BuildFunctionById\n  ): BuildStep {\n    if (isBuildStepCommandRun(buildStepConfig)) {\n      const {\n        id,\n        inputs: inputsConfig,\n        outputs: outputsConfig,\n        name,\n        workingDirectory,\n        shell,\n        command,\n      } = buildStepConfig.run;\n      const stepId = id ?? uuidv4();\n      const inputs =\n        inputsConfig &&\n        this.createBuildStepInputsFromBuildStepInputsDefinition(inputsConfig, stepId);\n      const outputs =\n        outputsConfig && this.createBuildStepOutputsFromDefinition(outputsConfig, stepId);\n      return new BuildStep(this.ctx, {\n        id: stepId,\n        inputs,\n        outputs,\n        name,\n        workingDirectory,\n        shell,\n        command,\n      });\n    } else if (isBuildStepBareCommandRun(buildStepConfig)) {\n      const command = buildStepConfig.run;\n      return new BuildStep(this.ctx, {\n        id: uuidv4(),\n        command,\n      });\n    } else if (isBuildStepBareFunctionCall(buildStepConfig)) {\n      const functionId = buildStepConfig;\n      const buildFunction = buildFunctions[functionId];\n      return buildFunction.createBuildStepFromFunctionCall(this.ctx);\n    } else {\n      const keys = Object.keys(buildStepConfig);\n      assert(\n        keys.length === 1,\n        'There must be at most one function call in the step (enforced by joi).'\n      );\n      const functionId = keys[0];\n      const buildFunctionCallConfig = buildStepConfig[functionId];\n      const buildFunction = buildFunctions[functionId];\n      return buildFunction.createBuildStepFromFunctionCall(this.ctx, {\n        id: buildFunctionCallConfig.id,\n        name: buildFunctionCallConfig.name,\n        callInputs: buildFunctionCallConfig.inputs,\n        workingDirectory: buildFunctionCallConfig.workingDirectory,\n        shell: buildFunctionCallConfig.shell,\n      });\n    }\n  }\n\n  private createBuildFunctionsFromConfig(\n    buildFunctionsConfig: BuildConfig['functions']\n  ): BuildFunctionById {\n    if (!buildFunctionsConfig) {\n      return {};\n    }\n    const result: BuildFunctionById = {};\n    for (const [functionId, buildFunctionConfig] of Object.entries(buildFunctionsConfig)) {\n      const buildFunction = this.createBuildFunctionFromConfig({\n        id: functionId,\n        ...buildFunctionConfig,\n      });\n      result[buildFunction.getFullId()] = buildFunction;\n    }\n    return result;\n  }\n\n  private createBuildFunctionFromConfig({\n    id,\n    name,\n    inputs: inputsConfig,\n    outputs: outputsConfig,\n    shell,\n    command,\n  }: BuildFunctionConfig & { id: string }): BuildFunction {\n    const inputProviders =\n      inputsConfig && this.createBuildStepInputProvidersFromBuildFunctionInputs(inputsConfig);\n    const outputProviders =\n      outputsConfig && this.createBuildStepOutputProvidersFromBuildFunctionOutputs(outputsConfig);\n    return new BuildFunction({ id, name, inputProviders, outputProviders, shell, command });\n  }\n\n  private createBuildStepInputsFromBuildStepInputsDefinition(\n    buildStepInputs: BuildStepInputs,\n    stepId: string\n  ): BuildStepInput[] {\n    return Object.entries(buildStepInputs).map(\n      ([key, value]) =>\n        new BuildStepInput(this.ctx, {\n          id: key,\n          stepId,\n          defaultValue: value,\n          required: true,\n        })\n    );\n  }\n\n  private createBuildStepInputProvidersFromBuildFunctionInputs(\n    buildFunctionInputs: BuildFunctionInputs\n  ): BuildStepInputProvider[] {\n    return buildFunctionInputs.map((entry) => {\n      return typeof entry === 'string'\n        ? BuildStepInput.createProvider({ id: entry })\n        : BuildStepInput.createProvider({ id: entry.name, required: entry.required ?? true });\n    });\n  }\n\n  private createBuildStepOutputsFromDefinition(\n    buildStepOutputs: BuildStepOutputs,\n    stepId: string\n  ): BuildStepOutput[] {\n    return buildStepOutputs.map((entry) =>\n      typeof entry === 'string'\n        ? new BuildStepOutput(this.ctx, { id: entry, stepId, required: true })\n        : new BuildStepOutput(this.ctx, {\n            id: entry.name,\n            stepId,\n            required: entry.required ?? true,\n          })\n    );\n  }\n\n  private createBuildStepOutputProvidersFromBuildFunctionOutputs(\n    buildFunctionOutputs: BuildFunctionOutputs\n  ): BuildStepOutputProvider[] {\n    return buildFunctionOutputs.map((entry) =>\n      typeof entry === 'string'\n        ? BuildStepOutput.createProvider({ id: entry, required: true })\n        : BuildStepOutput.createProvider({ id: entry.name, required: entry.required ?? true })\n    );\n  }\n\n  private mergeBuildFunctionsWithExternal(\n    configFunctions: BuildFunctionById,\n    externalFunctions?: BuildFunction[]\n  ): BuildFunctionById {\n    const result: BuildFunctionById = { ...configFunctions };\n    if (externalFunctions === undefined) {\n      return result;\n    }\n    for (const buildFunction of externalFunctions) {\n      // functions defined in config shadow the external ones\n      const fullId = buildFunction.getFullId();\n      if (!(fullId in result)) {\n        result[fullId] = buildFunction;\n      }\n    }\n    return result;\n  }\n\n  private validateExternalFunctions(externalFunctions?: BuildFunction[]): void {\n    if (externalFunctions === undefined) {\n      return;\n    }\n    const externalFunctionIds = externalFunctions.map((f) => f.getFullId());\n    const duplicatedExternalFunctionIds = duplicates(externalFunctionIds);\n    if (duplicatedExternalFunctionIds.length === 0) {\n      return;\n    }\n    throw new BuildStepRuntimeError(\n      `Provided external functions with duplicated IDs: ${duplicatedExternalFunctionIds\n        .map((id) => `\"${id}\"`)\n        .join(', ')}`\n    );\n  }\n\n  private getUniqueExternalFunctionIds(): string[] {\n    if (this.externalFunctions === undefined) {\n      return [];\n    }\n    const ids = this.externalFunctions.map((f) => f.getFullId());\n    return uniq(ids);\n  }\n}\n"]}

package/dist_esm/BuildFunction.d.ts

@@ -0,0 +1,37 @@
+import { BuildPlatform } from './BuildPlatform.js';
+import { BuildStep, BuildStepFunction } from './BuildStep.js';
+import { BuildStepContext } from './BuildStepContext.js';
+import { BuildStepInputProvider } from './BuildStepInput.js';
+import { BuildStepOutputProvider } from './BuildStepOutput.js';
+export type BuildFunctionById = Record<string, BuildFunction>;
+export type BuildFunctionCallInputs = Record<string, string>;
+export declare class BuildFunction {
+    readonly namespace?: string;
+    readonly id: string;
+    readonly name?: string;
+    readonly platforms?: BuildPlatform[];
+    readonly inputProviders?: BuildStepInputProvider[];
+    readonly outputProviders?: BuildStepOutputProvider[];
+    readonly command?: string;
+    readonly fn?: BuildStepFunction;
+    readonly shell?: string;
+    constructor({ namespace, id, name, platforms, inputProviders, outputProviders, command, fn, shell, }: {
+        namespace?: string;
+        id: string;
+        name?: string;
+        platforms?: BuildPlatform[];
+        inputProviders?: BuildStepInputProvider[];
+        outputProviders?: BuildStepOutputProvider[];
+        command?: string;
+        fn?: BuildStepFunction;
+        shell?: string;
+    });
+    getFullId(): string;
+    createBuildStepFromFunctionCall(ctx: BuildStepContext, { id, name, callInputs, workingDirectory, shell, }?: {
+        id?: string;
+        name?: string;
+        callInputs?: BuildFunctionCallInputs;
+        workingDirectory?: string;
+        shell?: string;
+    }): BuildStep;
+}

package/dist_esm/BuildFunction.js

@@ -0,0 +1,44 @@
+import assert from 'assert';
+import { v4 as uuidv4 } from 'uuid';
+import { BuildStep } from './BuildStep.js';
+export class BuildFunction {
+    constructor({ namespace, id, name, platforms, inputProviders, outputProviders, command, fn, shell, }) {
+        assert(command !== undefined || fn !== undefined, 'Either command or fn must be defined.');
+        assert(!(command !== undefined && fn !== undefined), 'Command and fn cannot be both set.');
+        this.namespace = namespace;
+        this.id = id;
+        this.name = name;
+        this.platforms = platforms;
+        this.inputProviders = inputProviders;
+        this.outputProviders = outputProviders;
+        this.command = command;
+        this.fn = fn;
+        this.shell = shell;
+    }
+    getFullId() {
+        return this.namespace === undefined ? this.id : `${this.namespace}/${this.id}`;
+    }
+    createBuildStepFromFunctionCall(ctx, { id, name, callInputs = {}, workingDirectory, shell, } = {}) {
+        var _a, _b;
+        const buildStepId = id !== null && id !== void 0 ? id : uuidv4();
+        const inputs = (_a = this.inputProviders) === null || _a === void 0 ? void 0 : _a.map((inputProvider) => {
+            const input = inputProvider(ctx, buildStepId);
+            if (input.id in callInputs) {
+                input.set(callInputs[input.id]);
+            }
+            return input;
+        });
+        const outputs = (_b = this.outputProviders) === null || _b === void 0 ? void 0 : _b.map((outputProvider) => outputProvider(ctx, buildStepId));
+        return new BuildStep(ctx, {
+            id: buildStepId,
+            name: name !== null && name !== void 0 ? name : this.name,
+            command: this.command,
+            fn: this.fn,
+            workingDirectory,
+            inputs,
+            outputs,
+            shell,
+        });
+    }
+}
+//# sourceMappingURL=BuildFunction.js.map

package/dist_esm/BuildFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BuildFunction.js","sourceRoot":"","sources":["../src/BuildFunction.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EAAE,SAAS,EAAqB,MAAM,gBAAgB,CAAC;AAQ9D,MAAM,OAAO,aAAa;IAWxB,YAAY,EACV,SAAS,EACT,EAAE,EACF,IAAI,EACJ,SAAS,EACT,cAAc,EACd,eAAe,EACf,OAAO,EACP,EAAE,EACF,KAAK,GAWN;QACC,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,KAAK,SAAS,EAAE,uCAAuC,CAAC,CAAC;QAC3F,MAAM,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,KAAK,SAAS,CAAC,EAAE,oCAAoC,CAAC,CAAC;QAE3F,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;IACjF,CAAC;IAEM,+BAA+B,CACpC,GAAqB,EACrB,EACE,EAAE,EACF,IAAI,EACJ,UAAU,GAAG,EAAE,EACf,gBAAgB,EAChB,KAAK,MAOH,EAAE;;QAEN,MAAM,WAAW,GAAG,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,MAAM,EAAE,CAAC;QAEnC,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,cAAc,0CAAE,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YAC9C,IAAI,KAAK,CAAC,EAAE,IAAI,UAAU,EAAE;gBAC1B,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;aACjC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC;QAEhG,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE;YACxB,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC,IAAI;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,gBAAgB;YAChB,MAAM;YACN,OAAO;YACP,KAAK;SACN,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import assert from 'assert';\n\nimport { v4 as uuidv4 } from 'uuid';\n\nimport { BuildPlatform } from './BuildPlatform.js';\nimport { BuildStep, BuildStepFunction } from './BuildStep.js';\nimport { BuildStepContext } from './BuildStepContext.js';\nimport { BuildStepInputProvider } from './BuildStepInput.js';\nimport { BuildStepOutputProvider } from './BuildStepOutput.js';\n\nexport type BuildFunctionById = Record<string, BuildFunction>;\nexport type BuildFunctionCallInputs = Record<string, string>;\n\nexport class BuildFunction {\n  public readonly namespace?: string;\n  public readonly id: string;\n  public readonly name?: string;\n  public readonly platforms?: BuildPlatform[];\n  public readonly inputProviders?: BuildStepInputProvider[];\n  public readonly outputProviders?: BuildStepOutputProvider[];\n  public readonly command?: string;\n  public readonly fn?: BuildStepFunction;\n  public readonly shell?: string;\n\n  constructor({\n    namespace,\n    id,\n    name,\n    platforms,\n    inputProviders,\n    outputProviders,\n    command,\n    fn,\n    shell,\n  }: {\n    namespace?: string;\n    id: string;\n    name?: string;\n    platforms?: BuildPlatform[];\n    inputProviders?: BuildStepInputProvider[];\n    outputProviders?: BuildStepOutputProvider[];\n    command?: string;\n    fn?: BuildStepFunction;\n    shell?: string;\n  }) {\n    assert(command !== undefined || fn !== undefined, 'Either command or fn must be defined.');\n    assert(!(command !== undefined && fn !== undefined), 'Command and fn cannot be both set.');\n\n    this.namespace = namespace;\n    this.id = id;\n    this.name = name;\n    this.platforms = platforms;\n    this.inputProviders = inputProviders;\n    this.outputProviders = outputProviders;\n    this.command = command;\n    this.fn = fn;\n    this.shell = shell;\n  }\n\n  public getFullId(): string {\n    return this.namespace === undefined ? this.id : `${this.namespace}/${this.id}`;\n  }\n\n  public createBuildStepFromFunctionCall(\n    ctx: BuildStepContext,\n    {\n      id,\n      name,\n      callInputs = {},\n      workingDirectory,\n      shell,\n    }: {\n      id?: string;\n      name?: string;\n      callInputs?: BuildFunctionCallInputs;\n      workingDirectory?: string;\n      shell?: string;\n    } = {}\n  ): BuildStep {\n    const buildStepId = id ?? uuidv4();\n\n    const inputs = this.inputProviders?.map((inputProvider) => {\n      const input = inputProvider(ctx, buildStepId);\n      if (input.id in callInputs) {\n        input.set(callInputs[input.id]);\n      }\n      return input;\n    });\n    const outputs = this.outputProviders?.map((outputProvider) => outputProvider(ctx, buildStepId));\n\n    return new BuildStep(ctx, {\n      id: buildStepId,\n      name: name ?? this.name,\n      command: this.command,\n      fn: this.fn,\n      workingDirectory,\n      inputs,\n      outputs,\n      shell,\n    });\n  }\n}\n"]}

package/dist_esm/BuildPlatform.d.ts

@@ -0,0 +1,4 @@
+export declare enum BuildPlatform {
+    DARWIN = "darwin",
+    LINUX = "linux"
+}

package/dist_esm/BuildPlatform.js

@@ -0,0 +1,6 @@
+export var BuildPlatform;
+(function (BuildPlatform) {
+    BuildPlatform["DARWIN"] = "darwin";
+    BuildPlatform["LINUX"] = "linux";
+})(BuildPlatform || (BuildPlatform = {}));
+//# sourceMappingURL=BuildPlatform.js.map

package/dist_esm/BuildPlatform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BuildPlatform.js","sourceRoot":"","sources":["../src/BuildPlatform.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB","sourcesContent":["export enum BuildPlatform {\n  DARWIN = 'darwin',\n  LINUX = 'linux',\n}\n"]}

package/dist_esm/BuildStep.d.ts

@@ -0,0 +1,56 @@
+import { BuildStepContext } from './BuildStepContext.js';
+import { BuildStepInput, BuildStepInputById } from './BuildStepInput.js';
+import { BuildStepOutput, BuildStepOutputById } from './BuildStepOutput.js';
+import { BuildStepEnv } from './BuildStepEnv.js';
+export declare enum BuildStepStatus {
+    NEW = "new",
+    IN_PROGRESS = "in-progress",
+    CANCELED = "canceled",
+    FAIL = "fail",
+    WARNING = "warning",
+    SUCCESS = "success"
+}
+export declare enum BuildStepLogMarker {
+    START_STEP = "start-step",
+    END_STEP = "end-step"
+}
+export type BuildStepFunction = (ctx: BuildStepContext, { inputs, outputs, env, }: {
+    inputs: BuildStepInputById;
+    outputs: BuildStepOutputById;
+    env: BuildStepEnv;
+}) => unknown;
+export declare class BuildStep {
+    readonly id: string;
+    readonly name?: string;
+    readonly displayName?: string;
+    readonly inputs?: BuildStepInput[];
+    readonly outputs?: BuildStepOutput[];
+    readonly command?: string;
+    readonly fn?: BuildStepFunction;
+    readonly shell: string;
+    readonly ctx: BuildStepContext;
+    status: BuildStepStatus;
+    private readonly internalId;
+    private readonly inputById;
+    private readonly outputById;
+    private executed;
+    constructor(ctx: BuildStepContext, { id, name, inputs, outputs, command, fn, workingDirectory: maybeWorkingDirectory, shell, }: {
+        id: string;
+        name?: string;
+        inputs?: BuildStepInput[];
+        outputs?: BuildStepOutput[];
+        command?: string;
+        fn?: BuildStepFunction;
+        workingDirectory?: string;
+        shell?: string;
+    });
+    executeAsync(env?: BuildStepEnv): Promise<void>;
+    hasOutputParameter(name: string): boolean;
+    getOutputValueByName(name: string): string | undefined;
+    private executeCommandAsync;
+    private exectuteFnAsync;
+    private interpolateInputsInCommand;
+    private collectAndValidateOutputsAsync;
+    private getScriptEnv;
+    private getStepDisplayName;
+}