dceky 1.1.0 → 1.1.1

package/lib/setup/genE2ELaunchFile.js

@@ -24,7 +24,7 @@ var genE2ELaunchFile = function () {
         '// Auto-generated by dceky - do not edit manually',
         '',
         'import commands from \'dceky\';',
-        'import \'./kyCommandDeclarations.ts\';',
+        'import \'./kyCommandDeclarations\';',
         'import \'../commands\';',
         '',
         '// Make Cypress globally available as "ky"',

package/lib/setup/genE2ELaunchFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"genE2ELaunchFile.js","sourceRoot":"","sources":["../../setup/genE2ELaunchFile.ts"],"names":[],"mappings":";;;;;AAAA,0CAAoB;AACpB,8CAAwB;AACxB,sEAAgD;AAEhD;;;;GAIG;AACH,IAAM,gBAAgB,GAAG;IACvB,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAE3B,sCAAsC;IACtC,IAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAC7D,IAAI,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;IAED,IAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAE9D,wCAAwC;IACxC,IAAM,UAAU,GAAG;QACjB,mDAAmD;QACnD,EAAE;QACF,iCAAiC;QACjC,wCAAwC;QACxC,yBAAyB;QACzB,EAAE;QACF,4CAA4C;QAC5C,kBAAkB;QAClB,uBAAuB;QACvB,GAAG;QACH,wBAAwB;QACxB,EAAE;QACF,aAAa;QACb,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,wCAAwC;IACxC,YAAE,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAEjD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}
+{"version":3,"file":"genE2ELaunchFile.js","sourceRoot":"","sources":["../../setup/genE2ELaunchFile.ts"],"names":[],"mappings":";;;;;AAAA,0CAAoB;AACpB,8CAAwB;AACxB,sEAAgD;AAEhD;;;;GAIG;AACH,IAAM,gBAAgB,GAAG;IACvB,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAE3B,sCAAsC;IACtC,IAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAC7D,IAAI,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;IAED,IAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAE9D,wCAAwC;IACxC,IAAM,UAAU,GAAG;QACjB,mDAAmD;QACnD,EAAE;QACF,iCAAiC;QACjC,qCAAqC;QACrC,yBAAyB;QACzB,EAAE;QACF,4CAA4C;QAC5C,kBAAkB;QAClB,uBAAuB;QACvB,GAAG;QACH,wBAAwB;QACxB,EAAE;QACF,aAAa;QACb,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,wCAAwC;IACxC,YAAE,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAEjD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}

package/lib/setup/genTsConfigFile.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generate the ts.config.json file for Cypress TypeScript support
+ * @author Yuen Ler Chow
+ */
+declare const genTsConfigFile: () => string;
+export default genTsConfigFile;

package/lib/setup/genTsConfigFile.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import libs
+var fs_1 = __importDefault(require("fs"));
+var path_1 = __importDefault(require("path"));
+// Import shared helpers
+var getRootPath_1 = __importDefault(require("./helpers/getRootPath"));
+/**
+ * Generate the ts.config.json file for Cypress TypeScript support
+ * @author Yuen Ler Chow
+ */
+var genTsConfigFile = function () {
+    var root = (0, getRootPath_1.default)();
+    var outputFile = path_1.default.join(root, 'tsconfig.json');
+    if (fs_1.default.existsSync(outputFile)) {
+        return;
+    }
+    var tsConfig = {
+        compilerOptions: {
+            module: 'commonjs',
+            esModuleInterop: true,
+            noImplicitAny: true,
+            noEmitOnError: true,
+            removeComments: false,
+            declaration: true,
+            sourceMap: true,
+            target: 'es6',
+            lib: [
+                'DOM',
+                'ES5',
+            ],
+            types: [
+                'node',
+            ],
+            rootDir: './cypress',
+        },
+        include: [
+            './cypress',
+        ],
+        'ts-node': {
+            files: true,
+        },
+    };
+    fs_1.default.writeFileSync(outputFile, "".concat(JSON.stringify(tsConfig, null, 2), "\n"));
+    return outputFile;
+};
+exports.default = genTsConfigFile;
+//# sourceMappingURL=genTsConfigFile.js.map

package/lib/setup/genTsConfigFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genTsConfigFile.js","sourceRoot":"","sources":["../../setup/genTsConfigFile.ts"],"names":[],"mappings":";;;;;AAAA,cAAc;AACd,0CAAoB;AACpB,8CAAwB;AAExB,wBAAwB;AACxB,sEAAgD;AAEhD;;;GAGG;AACH,IAAM,eAAe,GAAG;IACtB,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAC3B,IAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAEpD,IAAI,YAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IAED,IAAM,QAAQ,GAAG;QACf,eAAe,EAAE;YACf,MAAM,EAAE,UAAU;YAClB,eAAe,EAAE,IAAI;YACrB,aAAa,EAAE,IAAI;YACnB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK;YACrB,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,KAAK;YACb,GAAG,EAAE;gBACH,KAAK;gBACL,KAAK;aACN;YACD,KAAK,EAAE;gBACL,MAAM;aACP;YACD,OAAO,EAAE,WAAW;SACrB;QACD,OAAO,EAAE;YACP,WAAW;SACZ;QACD,SAAS,EAAE;YACT,KAAK,EAAE,IAAI;SACZ;KACF,CAAC;IAEF,YAAE,CAAC,aAAa,CACd,UAAU,EACV,UAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,OAAI,CACzC,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/lib/setup/index.js

@@ -10,6 +10,7 @@ var setupCypressDependencies_1 = __importDefault(require("./setupCypressDependen
 var checkRequiredFiles_1 = __importDefault(require("./checkRequiredFiles"));
 var genE2ELaunchFile_1 = __importDefault(require("./genE2ELaunchFile"));
 var genKyCommandDeclarations_1 = __importDefault(require("./genKyCommandDeclarations"));
+var genTsConfigFile_1 = __importDefault(require("./genTsConfigFile"));
 (0, setupCypressDependencies_1.default)();
 (0, checkRequiredFiles_1.default)();
 (0, genCommandImportFile_1.default)();
@@ -17,4 +18,5 @@ var genKyCommandDeclarations_1 = __importDefault(require("./genKyCommandDeclarat
 (0, addToGitIgnore_1.default)();
 (0, genE2ELaunchFile_1.default)();
 (0, genKyCommandDeclarations_1.default)();
+(0, genTsConfigFile_1.default)();
 //# sourceMappingURL=index.js.map

package/lib/setup/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../setup/index.ts"],"names":[],"mappings":";;;;;AAAA,gFAA0D;AAC1D,gFAA0D;AAC1D,oEAA8C;AAC9C,wFAAkE;AAClE,4EAAsD;AACtD,wEAAkD;AAClD,wFAAkE;AAElE,IAAA,kCAAwB,GAAE,CAAC;AAC3B,IAAA,4BAAkB,GAAE,CAAC;AACrB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,wBAAc,GAAE,CAAC;AACjB,IAAA,0BAAgB,GAAE,CAAC;AACnB,IAAA,kCAAwB,GAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../setup/index.ts"],"names":[],"mappings":";;;;;AAAA,gFAA0D;AAC1D,gFAA0D;AAC1D,oEAA8C;AAC9C,wFAAkE;AAClE,4EAAsD;AACtD,wEAAkD;AAClD,wFAAkE;AAClE,sEAAgD;AAEhD,IAAA,kCAAwB,GAAE,CAAC;AAC3B,IAAA,4BAAkB,GAAE,CAAC;AACrB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,8BAAoB,GAAE,CAAC;AACvB,IAAA,wBAAc,GAAE,CAAC;AACjB,IAAA,0BAAgB,GAAE,CAAC;AACnB,IAAA,kCAAwB,GAAE,CAAC;AAC3B,IAAA,yBAAe,GAAE,CAAC"}

package/lib/src/commands/getCredentialValue.d.ts

@@ -2,9 +2,7 @@ declare global {
     namespace Cypress {
         interface Chainable {
             /**
-             * Alias for cy.env for retrieving a single environment variable
-             * Obtains a credential value from the Cypress env depending on
-             * the provided key.
+             * Get a credential from GlobalCredentials
              * @author Allison Zhang
              * @param key the key of the environment variable to retrieve
              * @return The value of the specified environment variable

package/lib/src/commands/getCredentialValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"getCredentialValue.js","sourceRoot":"","sources":["../../../src/commands/getCredentialValue.ts"],"names":[],"mappings":";AAAA,iCAAiC;;AAyBjC,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,IAAM,kBAAkB,GAAG;IACzB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAClB,oBAAoB,EACpB,UAAC,GAAG;QACF,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,EAAgB;gBAAd,KAAC,GAAI,EAAE,KAAK,SAAA;YACvC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,kBAAe,kBAAkB,CAAC"}
+{"version":3,"file":"getCredentialValue.js","sourceRoot":"","sources":["../../../src/commands/getCredentialValue.ts"],"names":[],"mappings":";AAAA,iCAAiC;;AAuBjC,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,IAAM,kBAAkB,GAAG;IACzB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAClB,oBAAoB,EACpB,UAAC,GAAG;QACF,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,EAAgB;gBAAd,KAAC,GAAI,EAAE,KAAK,SAAA;YACvC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,kBAAe,kBAAkB,CAAC"}

package/lib/src/commands/getProfileValue.d.ts

@@ -2,7 +2,8 @@ declare global {
     namespace Cypress {
         interface Chainable {
             /**
-             * Alias for Cypress.expose
+             * Get a (non-credential) value from the current profile,
+             * GlobalValues, or GlobalResources
              * @author Allison Zhang
              * @param key the key of the environment variable to retrieve
              */

package/lib/src/commands/getProfileValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"getProfileValue.js","sourceRoot":"","sources":["../../../src/commands/getProfileValue.ts"],"names":[],"mappings":";AAAA,iCAAiC;;AAqBjC,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,IAAM,eAAe,GAAG;IACtB,EAAE,CAAC,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;AACtC,CAAC,CAAC;AAEF,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,kBAAe,eAAe,CAAC"}
+{"version":3,"file":"getProfileValue.js","sourceRoot":"","sources":["../../../src/commands/getProfileValue.ts"],"names":[],"mappings":";AAAA,iCAAiC;;AAsBjC,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,IAAM,eAAe,GAAG;IACtB,EAAE,CAAC,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;AACtC,CAAC,CAAC;AAEF,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,kBAAe,eAAe,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dceky",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Cypress toolkit for Harvard DCE",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
@@ -30,7 +30,6 @@
   "dependencies": {
     "@types/clear": "^0.1.4",
     "@types/ejs": "^3.1.5",
-    "@types/node": "^22.7.0",
     "@types/prompt-sync": "^4.2.3",
     "child_process": "^1.0.2",
     "clear": "^0.1.0",
@@ -41,7 +40,7 @@
   },
   "devDependencies": {
     "@types/deepmerge": "2.1.0",
-    "@types/node": "^24.6.1",
+    "@types/node": "^24.12.2",
     "cross-env": "^10.1.0",
     "eslint": "^8.42.0",
     "eslint-config-airbnb": "^19.0.4",

package/setup/genE2ELaunchFile.ts

@@ -23,7 +23,7 @@ const genE2ELaunchFile = (): string => {
     '// Auto-generated by dceky - do not edit manually',
     '',
     'import commands from \'dceky\';',
-    'import \'./kyCommandDeclarations.ts\';',
+    'import \'./kyCommandDeclarations\';',
     'import \'../commands\';',
     '',
     '// Make Cypress globally available as "ky"',

package/setup/genTsConfigFile.ts

@@ -0,0 +1,55 @@
+// Import libs
+import fs from 'fs';
+import path from 'path';
+
+// Import shared helpers
+import getRootPath from './helpers/getRootPath';
+
+/**
+ * Generate the ts.config.json file for Cypress TypeScript support
+ * @author Yuen Ler Chow
+ */
+const genTsConfigFile = () => {
+  const root = getRootPath();
+  const outputFile = path.join(root, 'tsconfig.json');
+
+  if (fs.existsSync(outputFile)) {
+    return;
+  }
+
+  const tsConfig = {
+    compilerOptions: {
+      module: 'commonjs',
+      esModuleInterop: true,
+      noImplicitAny: true,
+      noEmitOnError: true,
+      removeComments: false,
+      declaration: true,
+      sourceMap: true,
+      target: 'es6',
+      lib: [
+        'DOM',
+        'ES5',
+      ],
+      types: [
+        'node',
+      ],
+      rootDir: './cypress',
+    },
+    include: [
+      './cypress',
+    ],
+    'ts-node': {
+      files: true,
+    },
+  };
+
+  fs.writeFileSync(
+    outputFile,
+    `${JSON.stringify(tsConfig, null, 2)}\n`,
+  );
+
+  return outputFile;
+};
+
+export default genTsConfigFile;

package/setup/index.ts

@@ -5,6 +5,7 @@ import setupCypressDependencies from './setupCypressDependencies';
 import checkRequiredFiles from './checkRequiredFiles';
 import genE2ELaunchFile from './genE2ELaunchFile';
 import genKyCommandDeclarations from './genKyCommandDeclarations';
+import genTsConfigFile from './genTsConfigFile';
 
 setupCypressDependencies();
 checkRequiredFiles();
@@ -13,3 +14,4 @@ genDynamicConfigFile();
 addToGitIgnore();
 genE2ELaunchFile();
 genKyCommandDeclarations();
+genTsConfigFile();

package/src/commands/getCredentialValue.ts

@@ -8,9 +8,7 @@ declare global {
   namespace Cypress {
     interface Chainable {
       /**
-       * Alias for cy.env for retrieving a single environment variable
-       * Obtains a credential value from the Cypress env depending on
-       * the provided key.
+       * Get a credential from GlobalCredentials
        * @author Allison Zhang
        * @param key the key of the environment variable to retrieve
        * @return The value of the specified environment variable

package/src/commands/getProfileValue.ts

@@ -8,7 +8,8 @@ declare global {
   namespace Cypress {
     interface Chainable {
       /**
-       * Alias for Cypress.expose
+       * Get a (non-credential) value from the current profile,
+       * GlobalValues, or GlobalResources
        * @author Allison Zhang
        * @param key the key of the environment variable to retrieve
        */