@catladder/cli 0.0.0-next-e9e5af68 → 0.0.0-next-aea5d3ad

package/dist/pipeline/src/types/gitlab-ci-yml.js

@@ -1,10 +1,8 @@
 "use strict";
-
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
  * and run json-schema-to-typescript to regenerate this file.
  */
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=gitlab-ci-yml.js.map

package/dist/pipeline/src/types/gitlab-types.d.ts

@@ -6,11 +6,11 @@ export type { GitlabJobCache };
 export type GitlabRule = Exclude<Exclude<Rules, null>[number], string | string[]>;
 export type GitlabEnvironment = Omit<Exclude<JobTemplate["environment"], undefined | string>, "deployment_tier">;
 export interface GitlabJobDef extends Pick<JobTemplate, "after_script" | "allow_failure" | "artifacts" | "before_script" | "coverage" | "dependencies" | "environment" | "except" | "hooks" | "image" | "interruptible" | "needs" | "only" | "parallel" | "release" | "resource_group" | "retry" | "rules" | "script" | "services" | "stage" | "tags" | "trigger" | "variables"> {
-  stage: JobTemplate["stage"];
-  rules?: GitlabRule[];
-  cache?: GitlabJobCache | GitlabJobCache[];
-  artifacts?: Artifacts;
-  tags?: string[];
+    stage: JobTemplate["stage"];
+    rules?: GitlabRule[];
+    cache?: GitlabJobCache | GitlabJobCache[];
+    artifacts?: Artifacts;
+    tags?: string[];
 }
 /**
  * this is not precicily the type of a gitlab-pipeline
@@ -18,13 +18,13 @@ export interface GitlabJobDef extends Pick<JobTemplate, "after_script" | "allow_
  * Problem is, that this type cannot be represented properly with typescript, see https://github.com/microsoft/TypeScript/issues/17867
  */
 export interface GitlabPipeline extends Pick<JobTemplate, "variables"> {
-  image: string;
-  workflow?: {
-    rules: GitlabRule[];
-    name?: string;
-    variables?: Record<string, string>;
-  };
-  stages: string[];
-  jobs: Record<string, GitlabJobWithContext>;
-  before_script?: string[];
-}
+    image: string;
+    workflow?: {
+        rules: GitlabRule[];
+        name?: string;
+        variables?: Record<string, string>;
+    };
+    stages: string[];
+    jobs: Record<string, GitlabJobWithContext>;
+    before_script?: string[];
+}

package/dist/pipeline/src/types/gitlab-types.js

@@ -1,5 +1,3 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=gitlab-types.js.map

package/dist/pipeline/src/types/hooks.d.ts

@@ -1,35 +1,35 @@
 export type BaseHookContext = {
-  /**
-   * the filename of the file
-   */
-  filename: string;
-  /**
-   * the path of the file
-   */
-  path: string;
-  /**
-   * the extension of the file
-   */
-  extension: string;
+    /**
+     * the filename of the file
+     */
+    filename: string;
+    /**
+     * the path of the file
+     */
+    path: string;
+    /**
+     * the extension of the file
+     */
+    extension: string;
 };
 export type YamlHookContext = BaseHookContext & {
-  data: any;
+    data: any;
 };
 export type FileHookContext = BaseHookContext & {
-  /**
-   * the content of the file
-   */
-  content: string;
+    /**
+     * the content of the file
+     */
+    content: string;
 };
 type MaybePromise<T> = T | Promise<T>;
 export type Hooks = {
-  /**
-   * transform the file before it is written. If undefined is returned, the file is not modified
-   */
-  transformFileBeforeWrite?: (fileHookContext: FileHookContext) => MaybePromise<string | undefined>;
-  /**
-   * transform the yaml before it is written. If undefined is returned, the yaml is not modified
-   */
-  transformYamlBeforeWrite?: (fileHookContext: YamlHookContext) => MaybePromise<any | undefined>;
+    /**
+     * transform the file before it is written. If undefined is returned, the file is not modified
+     */
+    transformFileBeforeWrite?: (fileHookContext: FileHookContext) => MaybePromise<string | undefined>;
+    /**
+     * transform the yaml before it is written. If undefined is returned, the yaml is not modified
+     */
+    transformYamlBeforeWrite?: (fileHookContext: YamlHookContext) => MaybePromise<any | undefined>;
 };
-export {};
+export {};

package/dist/pipeline/src/types/hooks.js

@@ -1,5 +1,3 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=hooks.js.map

package/dist/pipeline/src/types/index.d.ts

@@ -4,4 +4,4 @@ export * from "./context";
 export * from "./jobDefinition";
 export * from "./pipeline";
 export * from "./jobs";
-export * from "./agent";
+export * from "./agent";

package/dist/pipeline/src/types/index.js

@@ -1,31 +1,24 @@
 "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 __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);
+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 __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
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./config"), exports);
 __exportStar(require("./gitlab-types"), exports);
 __exportStar(require("./context"), exports);
 __exportStar(require("./jobDefinition"), exports);
 __exportStar(require("./pipeline"), exports);
 __exportStar(require("./jobs"), exports);
-__exportStar(require("./agent"), exports);
+__exportStar(require("./agent"), exports);
+//# sourceMappingURL=index.js.map

package/dist/pipeline/src/types/jobDefinition.d.ts

@@ -1,11 +1,11 @@
 import type { CacheConfig } from "../build";
 import type { CatladderJobSpec } from "./jobs";
 export type AppBuildJobDefinition = Partial<Omit<CatladderJobSpec, "artifacts" | "cache">> & {
-  cache?: CacheConfig[];
+    cache?: CacheConfig[];
 };
 export type DockerBuildJobDefinition = AppBuildJobDefinition;
 export type DeployJobDefinition = Pick<CatladderJobSpec, "script" | "variables" | "image" | "artifacts" | "services" | "runnerVariables"> & {
-  cache?: CacheConfig[];
+    cache?: CacheConfig[];
 };
 export type StopJobDefinition = Pick<CatladderJobSpec, "script" | "variables" | "image" | "runnerVariables">;
-export type RollbackJobDefinition = Pick<CatladderJobSpec, "script" | "variables" | "runnerVariables" | "image">;
+export type RollbackJobDefinition = Pick<CatladderJobSpec, "script" | "variables" | "runnerVariables" | "image">;

package/dist/pipeline/src/types/jobDefinition.js

@@ -1,5 +1,3 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=jobDefinition.js.map

package/dist/pipeline/src/types/jobs.d.ts

@@ -3,33 +3,33 @@ import type { CatladderImageRef } from "../runner";
 import type { CacheConfig } from "../build/types";
 import type { Artifacts, GitlabJobCache, GitlabJobDef, GitlabJobImage, GitlabRule } from "./gitlab-types";
 export type CatladderJobCache = GitlabJobCache & {
-  /**
-   * content-key hint carried over from {@link CacheConfig} — consumed
-   * by the github lowering (hashFiles key), stripped by gitlab
-   */
-  keyFiles?: string[];
-  /**
-   * cross-cache hints carried over from {@link CacheConfig} — consumed
-   * by the github lowering (conditional restore), stripped by gitlab
-   */
-  cacheId?: string;
-  redundantOnExactHitOf?: string;
+    /**
+     * content-key hint carried over from {@link CacheConfig} — consumed
+     * by the github lowering (hashFiles key), stripped by gitlab
+     */
+    keyFiles?: string[];
+    /**
+     * cross-cache hints carried over from {@link CacheConfig} — consumed
+     * by the github lowering (conditional restore), stripped by gitlab
+     */
+    cacheId?: string;
+    redundantOnExactHitOf?: string;
 };
 export declare const BASE_STAGES: readonly ["setup", "test", "build", "deploy", "verify", "agents", "rollback", "stop"];
 export type BaseStage = (typeof BASE_STAGES)[number];
 export type CatladderJobNeed = string | {
-  job: string;
-  artifacts: boolean;
-  componentName?: string;
+    job: string;
+    artifacts: boolean;
+    componentName?: string;
 } | {
-  job: string;
-  artifacts: boolean;
-  workspaceName: string;
+    job: string;
+    artifacts: boolean;
+    workspaceName: string;
 } | {
-  job: string;
-  artifacts: boolean;
-  optional?: boolean;
-  global: true;
+    job: string;
+    artifacts: boolean;
+    optional?: boolean;
+    global: true;
 };
 export declare const CAPABILITIES: readonly ["build", "buildArtifacts", "dockerImage", "qualityGate", "deployment"];
 /**
@@ -42,32 +42,32 @@ export type CapabilityName = (typeof CAPABILITIES)[number];
  * a semantic dependency on a capability provided by other jobs
  */
 export type Requirement = {
-  /**
-   * the capability the job requires
-   */
-  capability: CapabilityName;
-  /**
-   * whether the artifacts of the providing jobs are consumed
-   */
-  artifacts?: boolean;
-  /**
-   * where the capability must come from. Defaults to the job's own
-   * component (or workspace for workspace jobs).
-   */
-  from?: {
-    component?: string;
-    workspace?: string;
-  };
-  /**
-   * whether pipeline generation fails when no job provides the
-   * capability.
-   *
-   * Defaults to the value of `artifacts`: consuming artifacts from
-   * nobody is almost always a broken configuration, while a plain
-   * ordering requirement nobody provides simply creates no dependency
-   * (e.g. quality gates don't run on tagged releases).
-   */
-  strict?: boolean;
+    /**
+     * the capability the job requires
+     */
+    capability: CapabilityName;
+    /**
+     * whether the artifacts of the providing jobs are consumed
+     */
+    artifacts?: boolean;
+    /**
+     * where the capability must come from. Defaults to the job's own
+     * component (or workspace for workspace jobs).
+     */
+    from?: {
+        component?: string;
+        workspace?: string;
+    };
+    /**
+     * whether pipeline generation fails when no job provides the
+     * capability.
+     *
+     * Defaults to the value of `artifacts`: consuming artifacts from
+     * nobody is almost always a broken configuration, while a plain
+     * ordering requirement nobody provides simply creates no dependency
+     * (e.g. quality gates don't run on tagged releases).
+     */
+    strict?: boolean;
 };
 /**
  * how a job interacts with a deployment environment.
@@ -75,92 +75,92 @@ export type Requirement = {
  * (gitlab: the job `environment:` config incl. name and url).
  */
 export type CatladderJobEnvironmentConfig = {
-  /**
-   * - start (default): the job creates/deploys the environment
-   * - stop: the job tears the environment down
-   * - access: the job uses the environment without changing it
-   */
-  action?: "start" | "stop" | "access";
-  /**
-   * name of the job (of the same component) that stops this environment
-   */
-  onStop?: string;
-  /**
-   * automatically stop the environment after this duration (e.g. "1 week")
-   */
-  autoStopIn?: string;
+    /**
+     * - start (default): the job creates/deploys the environment
+     * - stop: the job tears the environment down
+     * - access: the job uses the environment without changing it
+     */
+    action?: "start" | "stop" | "access";
+    /**
+     * name of the job (of the same component) that stops this environment
+     */
+    onStop?: string;
+    /**
+     * automatically stop the environment after this duration (e.g. "1 week")
+     */
+    autoStopIn?: string;
 };
 /**
  * the platform-agnostic properties of a job
  */
 export type CatladderJobCore<S = BaseStage> = {
-  /**
-   * the name of the job (without any env or app prefix and suffix)
-   */
-  name: string;
-  /**
-   * envMode sets the behavior of the job regarding multiple envs:
-   * - jobPerEnv: the job runs once per env (default)
-   * - stagePerEnv: the job runs once per env and is organized in its own stage. This mproves usability in gitlab, but works the same as `jobPerEnv`
-   */
-  envMode?: "jobPerEnv" | "stagePerEnv";
-  /**
-   * the stage of the job
-   */
-  stage: S;
-  /**
-   * whether the job starts automatically ("auto") or requires a manual
-   * action ("manual"). Each pipeline type translates this to its own
-   * mechanism (gitlab: `when` + `allow_failure`).
-   *
-   * Prefer this over the gitlab-specific `when`/`allow_failure` fields.
-   */
-  gate?: "auto" | "manual";
-  /**
-   * script to run
-   */
-  script: (string | undefined)[];
-  /**
-   * semantic requirements on capabilities provided by other jobs.
-   * A planner resolves them to concrete job dependencies (`needs`)
-   * once all jobs of the pipeline are known.
-   */
-  requires?: Requirement[];
-  /**
-   * the capabilities this job provides to other jobs.
-   * If not set, it is derived from the stage:
-   * build -> "build", test -> "qualityGate", deploy -> "deployment"
-   */
-  provides?: CapabilityName[];
-  /**
-   * does this require another job (from the same component)?
-   *
-   * You can also require a job from another component if you set `componentName`
-   *
-   */
-  needs?: Array<CatladderJobNeed>;
-  /**
-   * platform-neutral cache declarations. Each pipeline type resolves
-   * them to its own cache mechanism (gitlab: the job `cache:` config).
-   *
-   * Prefer this over the gitlab-shaped `cache` field, which remains as
-   * an escape hatch and takes precedence when set.
-   */
-  caches?: CacheConfig[];
-  /**
-   * declares that this job interacts with a deployment environment
-   */
-  environment?: CatladderJobEnvironmentConfig;
-  /**
-   * variables to pass
-   */
-  variables: UnspecifiedEnvVars | undefined;
-  /**
-   * additional vars only for the runner.
-   * Also if you use services: that require env vars, you need to set them here.
-   *
-   */
-  runnerVariables?: Record<string, string>;
+    /**
+     * the name of the job (without any env or app prefix and suffix)
+     */
+    name: string;
+    /**
+     * envMode sets the behavior of the job regarding multiple envs:
+     * - jobPerEnv: the job runs once per env (default)
+     * - stagePerEnv: the job runs once per env and is organized in its own stage. This mproves usability in gitlab, but works the same as `jobPerEnv`
+     */
+    envMode?: "jobPerEnv" | "stagePerEnv";
+    /**
+     * the stage of the job
+     */
+    stage: S;
+    /**
+     * whether the job starts automatically ("auto") or requires a manual
+     * action ("manual"). Each pipeline type translates this to its own
+     * mechanism (gitlab: `when` + `allow_failure`).
+     *
+     * Prefer this over the gitlab-specific `when`/`allow_failure` fields.
+     */
+    gate?: "auto" | "manual";
+    /**
+     * script to run
+     */
+    script: (string | undefined)[];
+    /**
+     * semantic requirements on capabilities provided by other jobs.
+     * A planner resolves them to concrete job dependencies (`needs`)
+     * once all jobs of the pipeline are known.
+     */
+    requires?: Requirement[];
+    /**
+     * the capabilities this job provides to other jobs.
+     * If not set, it is derived from the stage:
+     * build -> "build", test -> "qualityGate", deploy -> "deployment"
+     */
+    provides?: CapabilityName[];
+    /**
+     * does this require another job (from the same component)?
+     *
+     * You can also require a job from another component if you set `componentName`
+     *
+     */
+    needs?: Array<CatladderJobNeed>;
+    /**
+     * platform-neutral cache declarations. Each pipeline type resolves
+     * them to its own cache mechanism (gitlab: the job `cache:` config).
+     *
+     * Prefer this over the gitlab-shaped `cache` field, which remains as
+     * an escape hatch and takes precedence when set.
+     */
+    caches?: CacheConfig[];
+    /**
+     * declares that this job interacts with a deployment environment
+     */
+    environment?: CatladderJobEnvironmentConfig;
+    /**
+     * variables to pass
+     */
+    variables: UnspecifiedEnvVars | undefined;
+    /**
+     * additional vars only for the runner.
+     * Also if you use services: that require env vars, you need to set them here.
+     *
+     */
+    runnerVariables?: Record<string, string>;
 };
 /**
  * job properties that (still) use GitLab CI shapes or semantics directly.
@@ -169,52 +169,53 @@ export type CatladderJobCore<S = BaseStage> = {
  * or be resolved by a pipeline-type specific renderer.
  */
 export type GitlabJobFields = {
-  /**
-   * cache config, we use here the same shape as gitlab itself
-   */
-  cache?: CatladderJobCache | CatladderJobCache[];
-  /**
-   * job artifacts, we also use gitlab shape here
-   */
-  artifacts?: Artifacts;
-  /**
-   * additional services, mainly used for docker
-   */
-  services?: GitlabJobDef["services"];
-  /**
-   * image to use: a concrete image or a reference to a
-   * catladder-provided job image (resolved by the backend according to
-   * the `jobImages` mode)
-   */
-  image?: GitlabJobImage | CatladderImageRef;
-  /**
-   * whether failures are allowed
-   */
-  allow_failure?: boolean;
-  /** */
-  when?: GitlabRule["when"];
-  rules?: GitlabRule[];
-  /**
-   * How many instances of a job should be run in parallel.
-   * Useful for big test suites that can be split into multiple pipeline jobs.
-   * We use the same shape as GitLab itself.
-   */
-  parallel?: number;
-  /**
-   * tags for the underlying job runner (e.g gitlab)
-   */
-  jobTags?: string[];
-  /**
-   * whether the job is interruptible (default: true)
-   */
-  interruptible?: boolean;
+    /**
+     * cache config, we use here the same shape as gitlab itself
+     */
+    cache?: CatladderJobCache | CatladderJobCache[];
+    /**
+     * job artifacts, we also use gitlab shape here
+     */
+    artifacts?: Artifacts;
+    /**
+     * additional services, mainly used for docker
+     */
+    services?: GitlabJobDef["services"];
+    /**
+     * image to use: a concrete image or a reference to a
+     * catladder-provided job image (resolved by the backend to an image
+     * built in the repository's own registry)
+     */
+    image?: GitlabJobImage | CatladderImageRef;
+    /**
+     * whether failures are allowed
+     */
+    allow_failure?: boolean;
+    /** */
+    when?: GitlabRule["when"];
+    rules?: GitlabRule[];
+    /**
+     * How many instances of a job should be run in parallel.
+     * Useful for big test suites that can be split into multiple pipeline jobs.
+     * We use the same shape as GitLab itself.
+     */
+    parallel?: number;
+    /**
+     * tags for the underlying job runner (e.g gitlab)
+     */
+    jobTags?: string[];
+    /**
+     * whether the job is interruptible (default: true)
+     */
+    interruptible?: boolean;
 };
 /**
  * the plain-data shape of a job. This is what job creators resolve
  * and what users can provide for e.g. `customJobs`.
  */
 export type CatladderJobSpec<S = BaseStage> = CatladderJobCore<S> & GitlabJobFields;
-export interface CatladderJob<S = BaseStage> extends CatladderJobCore<S>, GitlabJobFields {}
+export interface CatladderJob<S = BaseStage> extends CatladderJobCore<S>, GitlabJobFields {
+}
 /**
  * a pipeline job. Subclasses encapsulate how a specific kind of job
  * (build, deploy, ...) is resolved from its context and definition.
@@ -224,6 +225,6 @@ export interface CatladderJob<S = BaseStage> extends CatladderJobCore<S>, Gitlab
  * destructuring an instance behaves exactly like the spec object.
  */
 export declare class CatladderJob<S = BaseStage> {
-  constructor(spec: CatladderJobSpec<S>);
-  static from<Stage>(job: CatladderJobSpec<Stage> | CatladderJob<Stage>): CatladderJob<Stage>;
-}
+    constructor(spec: CatladderJobSpec<S>);
+    static from<Stage>(job: CatladderJobSpec<Stage> | CatladderJob<Stage>): CatladderJob<Stage>;
+}