@catladder/cli 0.0.0-fix-config-move-not-working-again-bf012644 → 0.0.0-fix-handle-missing-cloud-sql-proxy-command-error-and-show-nice-4dbbecce

package/dist/pipeline/src/deploy/types/googleCloudRun.d.ts

@@ -137,6 +137,10 @@ export type DeployConfigCloudRunJobBase = {
      * command
      */
     command: string | string[];
+    /**
+     * optional, specify args. Those get overwritten by job executions if specified there
+     */
+    args?: string[];
     /**
      * custom image to use. Defaults to the image from the build
      */
@@ -159,6 +163,10 @@ export type DeployConfigCloudRunJobBase = {
      * number of tasks that may run concurrently, defaults to 1
      */
     parallelism?: number;
+    /**
+     * max number of retries of the job. Defaults to 0
+     */
+    maxRetries?: number;
 } & DeployConfigCloudRunWithVolumes & DeployConfigCloudRunNetworkConfig;
 type Minute = string;
 type Hour = string;
@@ -166,24 +174,38 @@ type DayOfMonth = string;
 type DayOfWeek = string;
 type Month = string;
 export type DeployConfigCloudRunJobWithSchedule = DeployConfigCloudRunJobBase & {
+    /**
+     * @deprecated use `execute` instead
+     */
     when: "schedule";
+    /**
+     * @deprecated use `run` instead
+     */
     schedule: `${Minute} ${Hour} ${DayOfMonth} ${Month} ${DayOfWeek}`;
     /**
      * Max number of retries of the cloud scheduler.
      * Note: the task itself is never retried.
      *
      * defaults to 0 (no retries)
+     *
+     *  @deprecated use `run` instead
      */
     maxRetryAttempts?: 0 | 1 | 2 | 3 | 4 | 5;
 };
 export type DeployConfigCloudRunJobNormal = DeployConfigCloudRunJobBase & {
-    when: "manual" | "preDeploy" | "postDeploy" | "preStop" | "postStop";
     /**
      * wait for completion of the job on preDeploy and postDeploy
      *
      * has no effect on preStop and postStop (which always wait for completion)
+     *
+     *
+     * @deprecated use `run` instead
      */
     waitForCompletion?: boolean;
+    /**
+     * @deprecated use `run` instead
+     */
+    when?: "manual" | "preDeploy" | "postDeploy" | "preStop" | "postStop";
 };
 export type DeployConfigCloudRunWithVolumes = {
     /**
@@ -227,6 +249,10 @@ export type DeployConfigCloudRun = {
      * add cloudSql
      */
     cloudSql?: DeployConfigCloudRunCloudSql | false;
+    /**
+     * execute jobs on deploy or execute jobs and http requests on a schedule
+     */
+    execute?: Record<string, DeployConfigCloudRunExecute | null>;
     debug?: boolean;
 } & DeployConfigBase;
 export type DeployConfigCloudRunVolumes = Record<string, DeployConfigCloudRunVolume>;
@@ -236,4 +262,76 @@ export type DeployConfigCloudRunVolume = {
     mountPath: string;
     readonly?: boolean;
 };
+export type DeployConfigCloudRunExecuteJobBase = {
+    /**
+     * set to "job" to run a cloud run job
+     */
+    type: "job";
+    /**
+     * the cloud run job to run
+     */
+    job: string;
+    /**
+     * additional args to pass to the job
+     */
+    args?: string[];
+};
+type WithSchedule = {
+    /**
+     * run the job on a schedule
+     */
+    when: "schedule";
+    /**
+     * the cron schedule. See https://crontab.guru/
+     */
+    schedule: `${Minute} ${Hour} ${DayOfMonth} ${Month} ${DayOfWeek}`;
+    /**
+     * Max number of retries of the cloud scheduler.
+     * Note: the task itself is never retried.
+     *
+     * defaults to 0 (no retries)
+     */
+    maxRetryAttempts?: 0 | 1 | 2 | 3 | 4 | 5;
+};
+export type DeployConfigCloudRunExecuteJobScheduled = DeployConfigCloudRunExecuteJobBase & WithSchedule;
+export type DeployConfigCloudRunExecuteOnDeploy = DeployConfigCloudRunExecuteJobBase & ({
+    /**
+     * run the job before or after the deploy
+     */
+    when: "preDeploy" | "postDeploy";
+    /**
+     * whether to wait for completion of the job
+     */
+    waitForCompletion?: boolean;
+} | {
+    /**
+     * run the job before or after the environment is stopped
+     */
+    when: "preStop" | "postStop";
+});
+export type DeployConfigCloudRunExecuteJob = DeployConfigCloudRunExecuteJobScheduled | DeployConfigCloudRunExecuteOnDeploy;
+export type DeployConfigCloudRunExecuteHttp = {
+    /**
+     * set to "http" to run a http request
+     */
+    type: "http";
+    /**
+     * the url to call
+     */
+    url: string;
+    /**
+     * the http-method to use. Defaults to "POST" (as specified by google cloud scheduler)
+     */
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    /**
+     * the body to send
+     */
+    body?: string;
+    /**
+     * the headers to send
+     */
+    headers?: Record<string, string>;
+} & WithSchedule;
+export type DeployConfigCloudRunExecute = DeployConfigCloudRunExecuteJob | DeployConfigCloudRunExecuteHttp;
+export type DeployConfigCloudRunExecuteWithSchedule = Extract<DeployConfigCloudRunExecute, WithSchedule>;
 export {};

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

@@ -20,3 +20,4 @@ export declare const isOfDeployType: <T extends ("custom" | "kubernetes" | "dock
 }> | Extract<DeployConfigKubernetes, {
     type: T[number];
 }>;
+export declare const getDeployConfigType: (t: DeployConfig | false | null | undefined) => "custom" | "kubernetes" | "dockerTag" | "google-cloudrun";

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

@@ -14,7 +14,7 @@ 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 });
-exports.isOfDeployType = void 0;
+exports.getDeployConfigType = exports.isOfDeployType = void 0;
 __exportStar(require("./custom"), exports);
 __exportStar(require("./googleCloudRun"), exports);
 __exportStar(require("./kubernetes"), exports);
@@ -23,4 +23,10 @@ const isOfDeployType = (t, ...types) => {
     return t && types.includes(t.type) ? true : false;
 };
 exports.isOfDeployType = isOfDeployType;
+const getDeployConfigType = (t) => {
+    if (!t)
+        return undefined;
+    return t.type;
+};
+exports.getDeployConfigType = getDeployConfigType;
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../pipeline/src/deploy/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAKA,2CAAyB;AACzB,mDAAiC;AACjC,+CAA6B;AAC7B,8CAA4B;AAcrB,MAAM,cAAc,GAAG,CAC5B,CAA0C,EAC1C,GAAG,KAAQ,EACsC,EAAE;IACnD,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AACpD,CAAC,CAAC;AALW,QAAA,cAAc,kBAKzB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../pipeline/src/deploy/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAKA,2CAAyB;AACzB,mDAAiC;AACjC,+CAA6B;AAC7B,8CAA4B;AAcrB,MAAM,cAAc,GAAG,CAC5B,CAA0C,EAC1C,GAAG,KAAQ,EACsC,EAAE;IACnD,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AACpD,CAAC,CAAC;AALW,QAAA,cAAc,kBAKzB;AAEK,MAAM,mBAAmB,GAAG,CACjC,CAA0C,EAC1C,EAAE;IACF,IAAI,CAAC,CAAC;QAAE,OAAO,SAAS,CAAC;IACzB,OAAO,CAAC,CAAC,IAAI,CAAC;AAChB,CAAC,CAAC;AALW,QAAA,mBAAmB,uBAK9B"}

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

@@ -73,6 +73,10 @@ export type DevLocalEnvConfig = {
     vars?: EnvVars;
     port?: number;
 };
+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)
@@ -84,18 +88,18 @@ export type EnvConfig<E extends EnvType = EnvType> = {
     host?: string;
 } & PartialDeep<DefaultEnvConfig>;
 export type EnvConfigWithComponent = EnvConfig<EnvType> & ComponentConfig;
-export type CustomEnv = EnvConfig & {
+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?: 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> = {
     /**
@@ -178,3 +182,4 @@ export type Config<C extends ConfigProps = never> = {
      */
     runnerVariables?: Record<string, string>;
 };
+export {};