checkly 5.3.1 → 5.4.0-prerelease-6249ef2

package/dist/util/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Attempts to look up the value for the given secret and throws an error if
+ * no value can be found.
+ *
+ * This basic utility is provided for convenience, but it is by no means best
+ * practice and you are certainly not required to use it. We recommend
+ * integrating your own secrets management instead.
+ */
+export declare function secret(name: string): string;

package/dist/util/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.secret = void 0;
+/**
+ * Attempts to look up the value for the given secret and throws an error if
+ * no value can be found.
+ *
+ * This basic utility is provided for convenience, but it is by no means best
+ * practice and you are certainly not required to use it. We recommend
+ * integrating your own secrets management instead.
+ */
+function secret(name) {
+    const tryEnvs = new Set([
+        `CHECKLY_SECRET_${name}`,
+        `CHECKLY_SECRET_${name.toUpperCase()}`,
+    ]);
+    for (const env of tryEnvs) {
+        const envValue = process.env[env];
+        if (envValue !== undefined) {
+            return envValue;
+        }
+    }
+    const triedString = Array.from(tryEnvs.values()).join(', ');
+    throw new Error(`Missing value for secret '${name}' (tried the following environment variables: ${triedString})`);
+}
+exports.secret = secret;
+//# sourceMappingURL=index.js.map

package/dist/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,MAAM,CAAE,IAAY;IAClC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC;QACtB,kBAAkB,IAAI,EAAE;QACxB,kBAAkB,IAAI,CAAC,WAAW,EAAE,EAAE;KACvC,CAAC,CAAA;IAEF,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACjC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAA;QACjB,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAE3D,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,iDAAiD,WAAW,GAAG,CAAC,CAAA;AACnH,CAAC;AAhBD,wBAgBC"}

package/oclif.manifest.json

@@ -837,7 +837,179 @@
         "env",
         "update.js"
       ]
+    },
+    "import:apply": {
+      "aliases": [],
+      "args": {},
+      "description": "Attach imported resources into your project in a pending state.",
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": false,
+      "hiddenAliases": [],
+      "id": "import:apply",
+      "pluginAlias": "checkly",
+      "pluginName": "checkly",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "coreCommand": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "import",
+        "apply.js"
+      ]
+    },
+    "import:cancel": {
+      "aliases": [],
+      "args": {},
+      "description": "Cancels an ongoing import plan that has not been committed yet.",
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "all": {
+          "description": "Cancel all plans.",
+          "name": "all",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": false,
+      "hiddenAliases": [],
+      "id": "import:cancel",
+      "pluginAlias": "checkly",
+      "pluginName": "checkly",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "coreCommand": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "import",
+        "cancel.js"
+      ]
+    },
+    "import:commit": {
+      "aliases": [],
+      "args": {},
+      "description": "Permanently commit imported resources into your project.",
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": false,
+      "hiddenAliases": [],
+      "id": "import:commit",
+      "pluginAlias": "checkly",
+      "pluginName": "checkly",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "coreCommand": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "import",
+        "commit.js"
+      ]
+    },
+    "import:plan": {
+      "aliases": [],
+      "args": {
+        "resource": {
+          "description": "A specific resource to import.",
+          "name": "resource",
+          "required": false
+        }
+      },
+      "description": "Import existing resources from your Checkly account to your project.\n\nBy default, all resources that can be imported will be imported. However, you\nmay fine-tune the process by including or excluding any combination of\nresources.\n\nThe import process consists of three steps:\n\n1. Creating a plan, which generates the appropriate code for your resources\n2. Applying the plan, which links your resources to the generated code\n3. Committing the plan, which finalizes the import session\n\nCREATING A PLAN\n\nCreating a plan carries no risk as no concrete links to your Checkly resources\nare made at this point. However, if you accidentally deploy the generated code\nbefore applying the plan, you will end up with duplicate resources and will\nnot be able to complete the import session without first deleting the\nduplicates.\n\nFor the curious, you may also preview the generated code with the '--preview'\noption. No plan will be created, allowing you to leisurely inspect the\ngenerated code. However keep in mind that you will need to create a plan to\nactually import any resources, at which point the code will be generated\nagain.\n\nYou may cancel any plan you've created without affecting any of the\nunderlying resources.\n\nAPPLYING A PLAN\n\nApplying a plan links your existing resources to the generated code. You\nshould carefully review the generated code to make sure that it contains the\nresources you expect before applying a plan. After a plan has been applied,\nany deployments of those resources will irreversibly modify the underlying\nCheckly resources. However, as a fail safe against concurrent use, any\ndeployments not including the imported resources will not delete the\nunderlying resources (or the links to the resources). This means that there\nis no need to block deployments while working on an import session.\n\nEven after you've applied a plan, you may still cancel it, which will unlink\nthe underlying resources from your project once more. However, keep in mind\nthat any changes to the resources that you've already deployed cannot be\nundone.\n\nCOMMITTING A PLAN\n\nFinally, committing a plan removes all fail safes and permanently links the\nimported resources to your project. Any resources you remove from your code\nwill result in the underlying resources also getting irrevocably deleted on\nthe next deploy. You should only commit your plan once you are sure that all\nfuture deployments include the imported resources.",
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "root": {
+          "description": "The root folder in which to write generated code files.",
+          "name": "root",
+          "default": "__checks__",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "preview": {
+          "description": "Preview generated code without creating an actual import plan.",
+          "name": "preview",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "debug-import-plan": {
+          "description": "Output the import plan to a file.",
+          "hidden": true,
+          "name": "debug-import-plan",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "debug-import-plan-output-file": {
+          "description": "The file to output the import plan to.",
+          "hidden": true,
+          "name": "debug-import-plan-output-file",
+          "default": "./debug-import-plan.json",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": false,
+      "hiddenAliases": [
+        "import"
+      ],
+      "id": "import:plan",
+      "pluginAlias": "checkly",
+      "pluginName": "checkly",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "coreCommand": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "import",
+        "plan.js"
+      ]
     }
   },
-  "version": "5.3.1"
+  "version": "5.4.0-prerelease-6249ef2"
 }

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "checkly",
-  "version": "5.3.1",
+  "version": "5.4.0-prerelease-6249ef2",
   "description": "Checkly CLI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
-    "./constructs": "./dist/constructs/index.js"
+    "./constructs": "./dist/constructs/index.js",
+    "./loader": "./dist/loader/index.js",
+    "./util": "./dist/util/index.js"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -15,8 +17,8 @@
     "clean": "rimraf ./dist",
     "prepack": "npx oclif manifest",
     "prepare": "npm run clean && tsc --build",
-    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest --selectProjects unit",
-    "test:e2e": "npm run prepare && cross-env NODE_OPTIONS=\"--experimental-vm-modules\" NODE_CONFIG_DIR=./e2e/config jest --selectProjects E2E",
+    "test": "vitest",
+    "test:e2e": "npm run prepare && cross-env NODE_CONFIG_DIR=./e2e/config vitest -c ./vitest.config.e2e.mts",
     "test:e2e:local": "cross-env CHECKLY_BASE_URL=http://localhost:3000  CHECKLY_ENV=local npm run test:e2e",
     "watch": "tsc --watch"
   },
@@ -59,6 +61,9 @@
     "topics": {
       "env": {
         "description": "Manage Checkly environment variables."
+      },
+      "import": {
+        "description": "Import existing resources from your Checkly account to your project."
       }
     },
     "helpClass": "./dist/help/help-extension"
@@ -81,6 +86,7 @@
     "ci-info": "^4.2.0",
     "conf": "^10.2.0",
     "dotenv": "^16.5.0",
+    "execa": "^9.5.3",
     "git-repo-info": "^2.1.1",
     "glob": "^10.4.5",
     "indent-string": "^4.0.0",
@@ -95,6 +101,7 @@
     "prompts": "^2.4.2",
     "proxy-from-env": "^1.1.0",
     "recast": "^0.23.11",
+    "semver": "^7.7.2",
     "tunnel": "^0.0.6",
     "uuid": "^11.1.0"
   },
@@ -102,24 +109,23 @@
     "@playwright/test": "^1.51.1",
     "@types/config": "^3.3.5",
     "@types/glob": "^8.1.0",
-    "@types/jest": "^29.5.14",
     "@types/luxon": "^3.6.2",
     "@types/node": "^22.14.1",
     "@types/prompts": "^2.4.9",
+    "@types/semver": "^7.7.0",
     "@types/tunnel": "^0.0.7",
     "@types/uuid": "^10.0.0",
     "@types/ws": "^8.5.5",
     "config": "^3.3.12",
     "cross-env": "^7.0.3",
-    "jest": "^29.7.0",
     "jiti": "^2.4.2",
     "nanoid": "^3.3.11",
     "oclif": "^4.17.44",
     "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.12.1",
-    "ts-jest": "^29.3.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vitest": "3.1.2"
   },
   "peerDependencies": {
     "jiti": ">=2"
@@ -128,34 +134,5 @@
     "jiti": {
       "optional": true
     }
-  },
-  "jest": {
-    "testTimeout": 30000,
-    "projects": [
-      {
-        "displayName": "unit",
-        "testMatch": [
-          "<rootDir>/src/**/*.spec.ts"
-        ],
-        "preset": "ts-jest",
-        "testEnvironment": "node"
-      },
-      {
-        "displayName": "E2E",
-        "testMatch": [
-          "<rootDir>/e2e/__tests__/**/*.spec.ts"
-        ],
-        "testPathIgnorePatterns": [
-          "/node_modules/",
-          "<rootDir>/e2e/__tests__/fixtures/"
-        ],
-        "preset": "ts-jest",
-        "testEnvironment": "node"
-      }
-    ],
-    "reporters": [
-      "default",
-      "github-actions"
-    ]
   }
 }