@catladder/cli 0.0.0-next-95928577 → 0.0.0-next-e7541a00

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

@@ -1,9 +1,12 @@
 import type { BuildConfig } from "../build/types";
 import type { DeployConfig } from "../deploy/types";
-import type { CatladderJob } from "./jobs";
+import type { CatladderJobSpec } from "./jobs";
 import type { ComponentContext } from "./context";
 import type { PartialDeep } from "./utils";
 import type { PipelineType, WorkspaceBuildConfig } from "..";
+import type { AgentConfig } from "./agent";
+import type { Hooks } from "./hooks";
+import type { ReleaseConfig } from "./release";
 export declare const ALL_PIPELINE_TRIGGERS: readonly ["mainBranch", "mr", "taggedRelease"];
 export type PipelineTrigger = (typeof ALL_PIPELINE_TRIGGERS)[number];
 /**
@@ -11,170 +14,186 @@ export type PipelineTrigger = (typeof ALL_PIPELINE_TRIGGERS)[number];
  * Each env type has a default env with the same name which is always included
  */
 export declare const ENV_TYPES: {
-    readonly dev: {
-        readonly triggers: readonly ["mainBranch"];
-    };
-    readonly review: {
-        readonly triggers: readonly ["mr"];
-    };
-    readonly stage: {
-        readonly triggers: readonly ["taggedRelease"];
-    };
-    readonly prod: {
-        readonly triggers: readonly ["taggedRelease"];
-    };
-    readonly local: {
-        readonly triggers: readonly [];
-    };
+  readonly dev: {
+    readonly triggers: readonly ["mainBranch"];
+  };
+  readonly review: {
+    readonly triggers: readonly ["mr"];
+  };
+  readonly stage: {
+    readonly triggers: readonly ["taggedRelease"];
+  };
+  readonly prod: {
+    readonly triggers: readonly ["taggedRelease"];
+  };
+  readonly local: {
+    readonly triggers: readonly [];
+  };
 };
 /**
  *
  * @param trigger a trigger
  * @returns array of env types for that trigger. this is also the list of default envs
  */
-export declare const getEnvTypesByTrigger: (trigger: PipelineTrigger) => ("stage" | "local" | "dev" | "review" | "prod")[];
+export declare const getEnvTypesByTrigger: (trigger: PipelineTrigger) => ("dev" | "review" | "stage" | "prod" | "local")[];
 export declare const DEFAULT_ENVS: string[];
-export declare const DEFAULT_ENV_TYPES: ("stage" | "local" | "dev" | "review" | "prod")[];
+export declare const DEFAULT_ENV_TYPES: ("dev" | "review" | "stage" | "prod" | "local")[];
 export type EnvType = keyof typeof ENV_TYPES;
-export declare const isKnowEnvType: (env: string) => env is "stage" | "local" | "dev" | "review" | "prod";
+export declare const isKnowEnvType: (env: string) => env is "dev" | "review" | "stage" | "prod" | "local";
 export type EnvVars = {
-    /**
-     * public env vars (means: they are checked in the repo).
-     *
-     * You can reuse env vars in other vars using ${OTHER_VAR}.
-     * You an reuse other public env vars, or secret env vars
-     *
-     * EXAMPLE: A_VAR: "the other var is ${OTHER_VAR}"
-     *
-     * You can reuse vars from other components in the same project using ${componentName:variableName}
-     * EXAMPLE: A_VAR: "the other var is ${api:OTHER_VAR}"
-     */
-    public?: Record<string, any>;
-    /**
-     * secret env vars. These vars can be managed with catladder/cli
-     */
-    secret?: string[];
+  /**
+   * public env vars (means: they are checked in the repo).
+   *
+   * You can reuse env vars in other vars using ${OTHER_VAR}.
+   * You an reuse other public env vars, or secret env vars
+   *
+   * EXAMPLE: A_VAR: "the other var is ${OTHER_VAR}"
+   *
+   * You can reuse vars from other components in the same project using ${componentName:variableName}
+   * EXAMPLE: A_VAR: "the other var is ${api:OTHER_VAR}"
+   */
+  public?: Record<string, any>;
+  /**
+   * secret env vars. These vars can be managed with catladder/cli
+   */
+  secret?: string[];
 };
 export type DefaultEnvConfig = {
-    /**
-     * how the app is deployed
-     */
-    deploy: DeployConfig | false;
-    /**
-     * how the app is built and its runtime
-     */
-    build: BuildConfig;
-    /**
-     * environment variables
-     */
-    vars?: EnvVars;
+  /**
+   * how the app is deployed
+   */
+  deploy: DeployConfig | false;
+  /**
+   * how the app is built and its runtime
+   */
+  build: BuildConfig | false;
+  /**
+   * environment variables
+   */
+  vars?: EnvVars;
 };
 export type DevLocalEnvConfig = {
-    vars?: EnvVars;
-    port?: number;
+  vars?: EnvVars;
+  /**
+   * port that is used. If not set, 3000 is used.
+   * set false to not set a port at all
+   */
+  port?: number | false;
 };
+type AddOverrideFunction<T> = { [K in keyof T]: T[K] | ((defaultValue: T[K]) => T[K]) | (T[K] extends Record<string, unknown> | undefined ? AddOverrideFunction<T[K]> : never) };
+type EnvConfigWithOverride<E extends EnvType = EnvType> = AddOverrideFunction<EnvConfig<E>>;
 export type EnvConfig<E extends EnvType = EnvType> = {
-    /**
-     * type of the env (stage, prod, review, dev)
-     */
-    type?: E;
-    /**
-     * host that is used. If not set, a "canonical" url is created
-     */
-    host?: string;
+  /**
+   * type of the env (stage, prod, review, dev)
+   */
+  type?: E;
+  /**
+   * host that is used. If not set, a "canonical" url is created
+   */
+  host?: string;
 } & PartialDeep<DefaultEnvConfig>;
 export type EnvConfigWithComponent = EnvConfig<EnvType> & ComponentConfig;
-export type CustomEnv = EnvConfig & {
-    type: EnvType;
+export type CustomEnv = EnvConfigWithOverride & {
+  type: EnvType;
 };
 export type Env<C extends ConfigProps = never> = {
-    /**
-     * local is a special env that is only used in local development
-     */
-    local?: DevLocalEnvConfig;
-    dev?: EnvConfig<"dev"> | false;
-    stage?: EnvConfig<"stage"> | false;
-    review?: EnvConfig<"review"> | false;
-    prod?: EnvConfig<"prod"> | false;
+  /**
+   * local is a special env that is only used in local development
+   */
+  local?: AddOverrideFunction<DevLocalEnvConfig>;
+  dev?: EnvConfigWithOverride<"dev"> | false;
+  stage?: EnvConfigWithOverride<"stage"> | false;
+  review?: EnvConfigWithOverride<"review"> | false;
+  prod?: EnvConfigWithOverride<"prod"> | false;
 } & Record<C["CustomEnvs"], CustomEnv> & Record<string, any>;
 export type ComponentConfig<C extends ConfigProps = never> = {
-    /**
-     * specify environment configurations
-     */
-    env?: Env<C>;
-    /**
-     * the directory of the component (e.g. where the package.json or similar is located). You can set "." if you only have one app.
-     */
-    dir: string;
-    /**
-     * add custom jobs. Can be an array or a function that receives the context and returns an array of jobs.
-     * For convenience, all env vars are injectd as variables
-     *
-     * Please raise an issue on https://git.panter.ch/catladder/catladder
-     * to let us know about why you need to use custom jobs.
-     * This feedback will help us to generalize use cases
-     */
-    customJobs?: CatladderJob[] | ((context: Omit<ComponentContext, "customJobs">) => CatladderJob[]);
-    /**
-     * whether to create a .env
-     *
-     * Be careful, this will overwrite any existing .env file!
-     *
-     * if set to true it will create .env locally and during build.
-     * Be careful: the .env file usually ends up in the build artifacts.
-     * Use this for apps and clients where env does not contain any secrets
-     *
-     *
-     * if set to "local" it will only create .env file locally.
-     * Use this in combination with @dotenvx/dotenvx or node 20 to start apps locally with .env files
-     * During build and runtime, it relies on the env vars set in the environment
-     *
-     * @defaultValue true
-     *
-     */
-    dotEnv?: boolean | "local";
-    /**
-     * whether to create a env.d.ts localy and during build jobs
-     *
-     * @defaultValue true
-     */
-    envDTs?: boolean;
+  /**
+   * specify environment configurations
+   */
+  env?: Env<C>;
+  /**
+   * the directory of the component (e.g. where the package.json or similar is located). You can set "." if you only have one app.
+   */
+  dir: string;
+  /**
+   * add custom jobs. Can be an array or a function that receives the context and returns an array of jobs.
+   * For convenience, all env vars are injectd as variables
+   *
+   * Please raise an issue on https://git.panter.ch/catladder/catladder
+   * to let us know about why you need to use custom jobs.
+   * This feedback will help us to generalize use cases
+   */
+  customJobs?: CatladderJobSpec[] | ((context: Omit<ComponentContext, "customJobs">) => CatladderJobSpec[]);
+  /**
+   * whether to create a .env
+   *
+   * Be careful, this will overwrite any existing .env file!
+   *
+   * if set to true it will create .env locally and during build.
+   * Be careful: the .env file usually ends up in the build artifacts.
+   * Use this for apps and clients where env does not contain any secrets
+   *
+   *
+   * if set to "local" it will only create .env file locally.
+   * Use this in combination with @dotenvx/dotenvx or node 20 to start apps locally with .env files
+   * During build and runtime, it relies on the env vars set in the environment
+   *
+   * @defaultValue true
+   *
+   */
+  dotEnv?: boolean | "local";
+  /**
+   * whether to create a env.d.ts localy and during build jobs
+   *
+   * @defaultValue true
+   */
+  envDTs?: boolean;
 } & DefaultEnvConfig;
 export type ConfigProps = {
-    CustomEnvs: string;
+  CustomEnvs: string;
 };
 export type Config<C extends ConfigProps = never> = {
-    /**
-     * the pipeline type to generate, defaults to gitlab
-     */
-    pipelineType?: PipelineType;
-    /**
-     * name of the customer or group
-     */
-    customerName: string;
-    /**
-     * name of the app / project
-     */
-    appName: string;
-    /**
-     * if a env does not define a host, it will generate a canonical one (e.g. for review, dev and stage).
-     * This prop specifies the domain that is used for these urls.
-     *
-     */
-    domainCanonical?: string;
-    builds?: Record<string, WorkspaceBuildConfig>;
-    /**
-     * components (sub apps)
-     */
-    components: Record<string, ComponentConfig<C>>;
-    /**
-     * additional meta data (only for organisational purposes)
-     */
-    meta?: {
-        labels?: Record<string, string>;
-    };
-    /**
-     * additional vars only for the runner in all jobs.
-     */
-    runnerVariables?: Record<string, string>;
+  /**
+   * the pipeline type to generate, defaults to gitlab
+   */
+  pipelineType?: PipelineType;
+  /**
+   * name of the customer or group
+   */
+  customerName: string;
+  /**
+   * name of the app / project
+   */
+  appName: string;
+  /**
+   * if a env does not define a host, it will generate a canonical one (e.g. for review, dev and stage).
+   * This prop specifies the domain that is used for these urls.
+   *
+   */
+  domainCanonical?: string;
+  agents?: Record<string, AgentConfig>;
+  builds?: Record<string, WorkspaceBuildConfig>;
+  /**
+   * components (sub apps)
+   */
+  components: Record<string, ComponentConfig<C>>;
+  /**
+   * additional meta data (only for organisational purposes)
+   */
+  meta?: {
+    labels?: Record<string, string>;
+  };
+  /**
+   * additional vars only for the runner in all jobs.
+   */
+  runnerVariables?: Record<string, string>;
+  /**
+   * hook into catladder generation
+   */
+  hooks?: Hooks;
+  /**
+   * configure tagged releases
+   */
+  releases?: ReleaseConfig;
 };
+export {};

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

@@ -1,45 +1,41 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.isKnowEnvType = exports.DEFAULT_ENV_TYPES = exports.DEFAULT_ENVS = exports.getEnvTypesByTrigger = exports.ENV_TYPES = exports.ALL_PIPELINE_TRIGGERS = void 0;
-exports.ALL_PIPELINE_TRIGGERS = [
-    "mainBranch",
-    "mr",
-    "taggedRelease",
-];
+exports.ALL_PIPELINE_TRIGGERS = ["mainBranch", "mr", "taggedRelease"];
 /**
  * all env types with their trigger.
  * Each env type has a default env with the same name which is always included
  */
 exports.ENV_TYPES = {
-    dev: {
-        triggers: ["mainBranch"],
-    },
-    review: {
-        triggers: ["mr"],
-    },
-    stage: {
-        triggers: ["taggedRelease"],
-    },
-    prod: {
-        triggers: ["taggedRelease"],
-    },
-    local: {
-        triggers: [],
-    },
+  dev: {
+    triggers: ["mainBranch"]
+  },
+  review: {
+    triggers: ["mr"]
+  },
+  stage: {
+    triggers: ["taggedRelease"]
+  },
+  prod: {
+    triggers: ["taggedRelease"]
+  },
+  local: {
+    triggers: []
+  }
 };
 /**
  *
  * @param trigger a trigger
  * @returns array of env types for that trigger. this is also the list of default envs
  */
-const getEnvTypesByTrigger = (trigger) => Object.entries(exports.ENV_TYPES)
-    .filter(([, e]) => e.triggers.includes(trigger))
-    .map(([e]) => e);
+const getEnvTypesByTrigger = trigger => Object.entries(exports.ENV_TYPES).filter(([, e]) => e.triggers.includes(trigger)).map(([e]) => e);
 exports.getEnvTypesByTrigger = getEnvTypesByTrigger;
 exports.DEFAULT_ENVS = Object.keys(exports.ENV_TYPES);
 exports.DEFAULT_ENV_TYPES = exports.DEFAULT_ENVS;
-const isKnowEnvType = (env) => {
-    return env in exports.ENV_TYPES;
+const isKnowEnvType = env => {
+  return env in exports.ENV_TYPES;
 };
-exports.isKnowEnvType = isKnowEnvType;
-//# sourceMappingURL=config.js.map
+exports.isKnowEnvType = isKnowEnvType;

package/dist/pipeline/src/types/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/config.ts"],"names":[],"mappings":";;;AAQa,QAAA,qBAAqB,GAAG;IACnC,YAAY;IACZ,IAAI;IACJ,eAAe;CACP,CAAC;AAGX;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,GAAG,EAAE;QACH,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,CAAC,IAAI,CAAC;KACjB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,EAAE;KACb;CACO,CAAC;AAEX;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC/D,MAAM,CAAC,OAAO,CAAC,iBAAS,CAAC;KACtB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,QAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7D;KACA,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAY,CAAC,CAAC;AALnB,QAAA,oBAAoB,wBAKD;AAEnB,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAkB,EAAE;IAC3D,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/config.ts"],"names":[],"mappings":";;;AAWa,QAAA,qBAAqB,GAAG;IACnC,YAAY;IACZ,IAAI;IACJ,eAAe;CACP,CAAC;AAGX;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,GAAG,EAAE;QACH,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,CAAC,IAAI,CAAC;KACjB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,EAAE;KACb;CACO,CAAC;AAEX;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC/D,MAAM,CAAC,OAAO,CAAC,iBAAS,CAAC;KACtB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,QAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7D;KACA,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAY,CAAC,CAAC;AALnB,QAAA,oBAAoB,wBAKD;AAEnB,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAkB,EAAE;IAC3D,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB"}