dceky 1.0.0-beta-profile.1

package/.eslintrc.json

@@ -0,0 +1,58 @@
+{
+  "extends": "airbnb",
+  "env": {
+    "browser": true,
+    "node": true
+  },
+  "rules": {
+    "arrow-body-style": [
+      "warn",
+      "always"
+    ],
+    "arrow-parens": [ "warn", "always" ],
+    "comma-dangle": [ "error", {
+      "arrays": "always-multiline",
+      "objects": "always-multiline",
+      "imports": "always-multiline",
+      "exports": "always-multiline",
+      "functions": "never"
+      }
+    ],
+    "consistent-return": "off",
+    "id-length": "off",
+    "max-len": [ "error",
+      {
+        "code": 80,
+        "ignoreStrings": true,
+        "ignoreTemplateLiterals": true,
+        "ignoreUrls": true
+      }
+    ],
+    "newline-per-chained-call": [
+      "error",
+      {
+        "ignoreChainWithDepth": 2
+      }
+    ],
+    "no-plusplus": [ "warn", { "allowForLoopAfterthoughts": true }],
+    "prefer-template": "off",
+    "prefer-destructuring": [ "error",
+      {
+        "VariableDeclarator": {
+         "array": false,
+         "object": true
+        },
+        "AssignmentExpression": {
+          "array": false,
+          "object": true
+        }
+      },
+      {
+        "enforceForRenamedProperties": false
+      }
+    ],
+    "radix": "off",
+    "no-underscore-dangle": "off",
+    "max-params": [ "warn", { "max": 3 } ]
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Harvard Edtech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# dceky
+
+Cypress toolkit for Harvard DCE

package/docs/GlobalsAndProfiles.md

@@ -0,0 +1,23 @@
+# Globals and Profiles Configuration
+
+### Configuration Setup
+
+The configuration setup involves the following steps:
+
+1. Split each globals/profiles map into two: `basic` values and `dependsOn` values.
+2. Merge all `basic` values into a running env object (in order so last ones processed are the highest priority).
+3. Go through each `dependsOn` value, look up the value it depends on in the running env object.
+4. Add `dependsOn` values into the running env object (in order so last ones processed are the highest priority).
+5. Wrap the env object into a config.
+
+### Assumptions
+
+* `dependsOn` values must depend on a basic `value`, not on another `dependsOn` value.
+
+### DependsOn Value
+
+The `dependsOn` value is an object that has the following structure:
+
+* `dependsOn`: the key of the `basic` value that we are depending on
+* `value`: the value that we are depending on (can be a string, number, boolean, etc.)
+* `default`: the default value if the `dependsOn` value is not found

package/lib/genConfiguration.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generate Cypress configuration based on global credentials,
+ * variables, resources, and profiles
+ * @author Yuen Ler Chow
+ * ...
+ */
+declare const genConfiguration: () => {};
+export default genConfiguration;

package/lib/genConfiguration.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Generate Cypress configuration based on global credentials,
+ * variables, resources, and profiles
+ * @author Yuen Ler Chow
+ * ...
+ */
+var genConfiguration = function () {
+    return {};
+};
+exports.default = genConfiguration;
+//# sourceMappingURL=genConfiguration.js.map

package/lib/genConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genConfiguration.js","sourceRoot":"","sources":["../src/genConfiguration.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,IAAM,gBAAgB,GAAG;IACvB,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import init from './init';
+import genConfiguration from './genConfiguration';
+export { genConfiguration, init, };

package/lib/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = exports.genConfiguration = void 0;
+var init_1 = __importDefault(require("./init"));
+exports.init = init_1.default;
+var genConfiguration_1 = __importDefault(require("./genConfiguration"));
+exports.genConfiguration = genConfiguration_1.default;
+// Automatically initialize upon importing the library
+(0, init_1.default)();
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,gDAA0B;AASxB,eATK,cAAI,CASL;AARN,wEAAkD;AAOhD,2BAPK,0BAAgB,CAOL;AALlB,sDAAsD;AACtD,IAAA,cAAI,GAAE,CAAC"}

package/lib/init.d.ts

@@ -0,0 +1,13 @@
+declare global {
+    namespace Cypress {
+        interface Chainable {
+            /**
+             * Custom command to click an element by selector
+             * @example cy.clickSomething('.my-button')
+             */
+            clickSomething(selector: string): Chainable<Element>;
+        }
+    }
+}
+declare const init: () => void;
+export default init;

package/lib/init.js

@@ -0,0 +1,10 @@
+"use strict";
+/// <reference types="cypress" />
+Object.defineProperty(exports, "__esModule", { value: true });
+var init = function () {
+    Cypress.Commands.add('clickSomething', function (selector) {
+        cy.get(selector).click();
+    });
+};
+exports.default = init;
+//# sourceMappingURL=init.js.map

package/lib/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";AAAA,iCAAiC;;AAejC,IAAM,IAAI,GAAG;IACX,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,EAAE,UAAC,QAAgB;QACtD,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,kBAAe,IAAI,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "dceky",
+  "version": "1.0.0-beta-profile.1",
+  "description": "Cypress toolkit for Harvard DCE",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "tsc --project ./tsconfig.json",
+    "cypress": "npx cypress open",
+    "cy:open:stage": "cross-env CYPRESS_PROFILE=stage npx cypress open",
+    "cy:open:prod": "cross-env CYPRESS_PROFILE=prod npx cypress open",
+    "cy:run:stage": "cross-env CYPRESS_PROFILE=stage npx cypress run",
+    "cy:run:prod": "cross-env CYPRESS_PROFILE=prod npx cypress run",
+    "launch-cypress": "npx tsx ./profileChooser/chooseProfile.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harvard-edtech/dceky"
+  },
+  "keywords": [
+    "Harvard",
+    "DCE",
+    "Cypress"
+  ],
+  "author": "Gabe Abrams <gabeabrams@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/harvard-edtech/dceky/issues"
+  },
+  "homepage": "https://github.com/harvard-edtech/dceky#readme",
+  "dependencies": {
+    "deepmerge": "4.3.1",
+    "clear": "^0.1.0",
+    "prompt-sync": "^4.2.0"
+  },
+  "devDependencies": {
+    "@types/deepmerge": "2.1.0",
+    "@types/node": "^24.6.1",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "cypress": "14.5.4",
+    "@types/clear": "^0.1.4",
+    "@types/node": "^22.7.0",
+    "@types/prompt-sync": "^4.2.3",
+    "typescript": "^5.9.3"
+  }
+}

package/profileChooser/chooseProfile.ts

@@ -0,0 +1,35 @@
+// TODO: implement a *synchronous* profile chooser that executes the correct launch command
+
+// Import libs
+import path from 'path';
+import fs from 'fs';
+
+// Import helpers
+import print from './helpers/print';
+import showChooser from './helpers/showChooser';
+
+// Get the project directory
+const pwd = path.join(process.env.PWD || process.env.CWD || __dirname, '../..');
+// NOTE: this is a dependency of the main project, so the actual project
+// directory is up two levels (outside this folder, then outside node_modules)
+console.log('Project directory:', pwd);
+
+// TODO: explore the file tree to figure out which profiles exist
+// (Build a chooser based on what you find)
+// Maybe: /cypress/profiles/[Name].Profile.ts
+
+print.title('Here\'s a title');
+
+console.log('Let us do the thing.');
+print.enterToContinue();
+
+const choice = showChooser({
+  question: 'Choose an option:',
+  options: [
+    { tag: 'A', description: 'First option' },
+    { tag: 'B', description: 'Second option' },
+    { tag: 'C', description: 'Third option' },
+  ],
+});
+
+console.log('You chose:', choice);

package/profileChooser/helpers/print.ts

@@ -0,0 +1,155 @@
+/* eslint-disable no-console */
+
+/**
+ * Get the left buffer for a centered message
+ * @author Gabe Abrams
+ * @param message message to print
+ * @param padding amount of padding to add
+ * @returns number of chars in the buffer
+ */
+const leftBuffer = (message: string, padding: number): number => {
+  return (Math.floor(process.stdout.columns / 2) - padding - Math.ceil(message.length / 2));
+};
+
+/**
+ * Get the right buffer for a centered message
+ * @author Gabe Abrams
+ * @param message message to print
+ * @param padding amount of padding to add
+ * @returns number of chars in the buffer
+ */
+const rightBuffer = (message: string, padding: number): number => {
+  return (Math.ceil(process.stdout.columns / 2) - padding - Math.floor(message.length / 2));
+};
+
+/**
+ * Surround text with a border and spaces
+ * @author Gabe Abrams
+ * @param str text to print
+ * @param border single character to use as a border
+ * @returns text to print
+ */
+const surroundWithBuffer = (str: string, border: string): string => {
+  return (
+    border
+    + ' '.repeat(leftBuffer(str, border.length))
+    + str
+    + ' '.repeat(rightBuffer(str, border.length))
+    + border
+  );
+};
+
+/**
+ * Surround text with a character as the buffer
+ * @author Gabe Abrams
+ * @param str text to print
+ * @param char character to place as the buffer
+ * @returns text to print
+ */
+const surroundWithChars = (str: string, char: string): string => {
+  if (str.length > process.stdout.columns) {
+    return str;
+  }
+  if (str.length === process.stdout.columns - 1) {
+    return char + str;
+  }
+  if (str.length === process.stdout.columns - 2) {
+    return char + str + char;
+  }
+  return (
+    char.repeat(leftBuffer(str, 1))
+    + ' '
+    + str
+    + ' '
+    + char.repeat(rightBuffer(str, 1))
+  );
+};
+
+// Prompt instance
+let cachedPrompt: any;
+
+const print = {
+  /**
+   * Print a title
+   * @author Gabe Abrams
+   * @param str text to print
+   */
+  title: (str: string) => {
+    if (str.length > process.stdout.columns) {
+      return console.log(str);
+    }
+    console.log('\u2554' + '\u2550'.repeat(process.stdout.columns - 2) + '\u2557');
+    console.log(surroundWithBuffer(str, '\u2551'));
+    console.log('\u255A' + '\u2550'.repeat(process.stdout.columns - 2) + '\u255D');
+  },
+  /**
+   * Print a sub title (subheading)
+   * @author Gabe Abrams
+   * @param str text to print
+   */
+  subtitle: (str: string) => {
+    if (str.length > process.stdout.columns) {
+      return console.log(str);
+    }
+    console.log(surroundWithChars(str, '\u257C'));
+  },
+  /**
+   * Print centered text
+   * @author Gabe Abrams
+   * @param str text to print
+   */
+  centered: (str: string) => {
+    const lines = [];
+    let index = 0;
+    while (index < str.length) {
+      lines.push(str.substring(index, Math.min(index + process.stdout.columns, str.length)));
+      index += process.stdout.columns;
+    }
+    lines.forEach((line, lineIndex) => {
+      if (lineIndex !== lines.length - 1) {
+        // No need to center: fills whole line
+        console.log(line);
+      } else {
+        // This line needs to be centered
+        console.log(surroundWithChars(line, ' '));
+      }
+    });
+  },
+  /**
+   * Print a fatal error message
+   * @author Gabe Abrams
+   * @param err error message
+   */
+  fatalError: (err: string) => {
+    console.log('\n');
+    const errLine1 = err.substring(0, process.stdout.columns - 6);
+    const errLine2 = err.substring(process.stdout.columns - 6);
+    console.log('\u2554' + '\u2550'.repeat(3) + '\u2557 ');
+    console.log(`\u2551 ! \u2551 ${errLine1}`);
+    console.log('\u255A' + '\u2550'.repeat(3) + '\u255D ' + errLine2);
+    process.exit(0);
+  },
+  /**
+   * Save a copy of the prompt instance
+   * @author Gabe Abrams
+   * @param promptInstance instance of prompt-sync
+   */
+  savePrompt: (promptInstance: any) => {
+    cachedPrompt = promptInstance;
+  },
+  /**
+   * Ask the user to press enter before continuing
+   * @author Gabe Abrams
+   */
+  enterToContinue: () => {
+    const res = cachedPrompt(
+      surroundWithChars('enter to continue, ctrl+c to quit', '\u257C'),
+      true,
+    );
+    if (res === null) {
+      process.exit(0);
+    }
+  },
+};
+
+export default print;

package/profileChooser/helpers/prompt.ts

@@ -0,0 +1,23 @@
+import initPrompt from 'prompt-sync';
+import print from './print';
+
+const promptSync = initPrompt();
+
+/**
+ * Ask the user a question
+ * @param title title of the question
+ * @param notRequired true if question is not required
+ * @returns response
+ */
+const prompt = (title: string, notRequired?: boolean): string => {
+  const val = promptSync(title);
+  if (val === null || (!notRequired && !val)) {
+    process.exit(0);
+  }
+  return val;
+};
+
+// Save the prompt for use later
+print.savePrompt(prompt);
+
+export default prompt;

package/profileChooser/helpers/showChooser.ts

@@ -0,0 +1,95 @@
+import clear from 'clear';
+
+// Import shared helpers
+import print from './print';
+import prompt from './prompt';
+
+// Import shared types
+import ChooserOption from '../types/ChooserOption';
+
+/**
+ * Show a chooser between many options
+ * @author Gabe Abrams
+ * @param question the question to ask
+ * @param options list of options to choose from
+ * @param title main title to show above the choices
+ * @param dontClear if true, don't clear the console before
+ * @returns chosen option
+ */
+const showChooser = (
+  opts: {
+    question: string,
+    options: ChooserOption[],
+    title?: string,
+    dontClear?: boolean,
+  },
+): {
+  description: string,
+  tag: string,
+  index: number,
+} => {
+  const {
+    question,
+    options,
+    title,
+    dontClear,
+  } = opts;
+
+  // Print the header
+  if (!dontClear) {
+    clear();
+  }
+  if (title) {
+    print.title(title);
+    console.log('');
+  }
+  print.subtitle(question);
+
+  // Make sure all options have tags
+  let nextNumber = 1;
+  const optionsWithTags = options.map((option) => {
+    // Get/generate a tag
+    let { tag } = option;
+    if (!tag) {
+      tag = String(nextNumber);
+      nextNumber += 1;
+    }
+
+    // Return complete option
+    return {
+      ...option,
+      tag,
+    };
+  });
+
+  // Print options
+  for (let i = 0; i < optionsWithTags.length; i++) {
+    console.log(`${optionsWithTags[i].tag} - ${optionsWithTags[i].description}`);
+  }
+
+  // Ask user to choose
+  const responseTag = prompt('> ').trim();
+
+  // Find the appropriate option
+  for (let i = 0; i < optionsWithTags.length; i++) {
+    if (responseTag.toLowerCase() === optionsWithTags[i].tag.toLowerCase()) {
+      // Found the right option
+      return {
+        ...optionsWithTags[i],
+        index: i,
+      };
+    }
+  }
+
+  // No tag found
+  clear();
+  print.title('Invalid Choice');
+  console.log('');
+  print.enterToContinue();
+  return showChooser({
+    question,
+    options: optionsWithTags,
+  });
+};
+
+export default showChooser;

package/profileChooser/types/ChooserOption.ts

@@ -0,0 +1,11 @@
+/**
+ * An option that can be put into a chooser
+ * @author Gabe Abrams
+ */
+type ChooserOption = {
+  description: string,
+  tag?: string,
+  index?: number,
+};
+
+export default ChooserOption;

package/src/commands/clickSomething.ts

@@ -0,0 +1,33 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Custom command to click an element by selector
+       * @example cy.clickSomething('.my-button')
+       */
+      clickSomething(selector: string): Chainable<Element>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const clickSomething = () => {
+  Cypress.Commands.add('clickSomething', (selector: string) => {
+    cy.get(selector).click();
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default clickSomething;

package/src/genConfiguration/helpers/resolveDependents.ts

@@ -0,0 +1,47 @@
+ 
+// Import shared types
+import type GlobalsOrProfile from '../types/GlobalsOrProfile';
+import type DependentValue from '../types/DependentValue';
+
+/**
+ * Resolve all dependent values using already-merged basics.
+ * @author Gardenia Liu
+ * @param dependentMaps with dependencies on basics
+ * @param basics entries
+ * @returns env with all dependent values resolved
+ */
+const resolveDependents = (
+  dependentMaps: { [k: string]: DependentValue }[],
+  basics: GlobalsOrProfile,
+): GlobalsOrProfile => {
+  const resolved: GlobalsOrProfile = {};
+
+  // Loop through all of the dependency maps
+  dependentMaps.forEach((depMap) => {
+    // Loop through all entries within dependency map
+    Object.entries(depMap).forEach(([k, depVal]) => {
+      // Get basic selector the value depends on
+      const selector = basics[depVal.dependsOn];
+
+      // Create table of values selector can be
+      const { dependsOn, ...table } = depVal as { [k: string]: unknown };
+
+      // Get the selector's picked value
+      const picked = table[selector];
+
+      if (picked !== undefined) {
+        resolved[k] = picked;
+      } else if ('default' in table) {
+        resolved[k] = table.default;
+      } else {
+        // eslint-disable-next-line max-len
+        console.warn(`[cypress.config] Could not resolve ${k}, dependsOn=${dependsOn}, selector=${String(selector)}`);
+        process.exit(1);
+      }
+    });
+  });
+
+  return resolved;
+};
+
+export default resolveDependents;

package/src/genConfiguration/helpers/splitEnv.ts

@@ -0,0 +1,30 @@
+// Import shared types
+import type GlobalsOrProfile from '../types/GlobalsOrProfile';
+import type DependentValue from '../types/DependentValue';
+import type SplitEnv from '../types/SplitEnv';
+
+/**
+ * Split one map into basic and dependent values
+ * @author Gardenia Liu
+ * @param map to split
+ * @returns split basic and dependent values map
+ */
+const splitEnv = (map: GlobalsOrProfile): SplitEnv => {
+  const basic: GlobalsOrProfile = {};
+  const dependent: { [k: string]: DependentValue } = {};
+
+  Object.entries(map).forEach(([k, v]) => {
+    // If entry has dependsOn relationship, add it to dependent dictionary
+    if (typeof v === 'object' && 'dependsOn' in v) {
+      dependent[k] = v as DependentValue;
+    // Otherwise, add it to basic dictionary
+    } else {
+      basic[k] = v;
+    }
+  });
+
+  // Returns separated basic and dependent values
+  return { basic, dependent };
+};
+
+export default splitEnv;

package/src/genConfiguration/index.ts

@@ -0,0 +1,83 @@
+import path from 'path';
+
+// Import external libraries
+import { defineConfig } from 'cypress';
+import deepmerge from 'deepmerge';
+
+// Import helpers
+import splitEnv from './helpers/splitEnv';
+import resolveDependents from './helpers/resolveDependents';
+
+// Import types
+import type SplitEnv from './types/SplitEnv';
+import type GlobalsOrProfile from './types/GlobalsOrProfile';
+
+// Determine project directory
+const CWD = (process.env.INIT_CWD || process.env.PWD);
+
+/**
+ * Generate Cypress configuration based on global credentials,
+ * variables, resources, and profiles
+ * @author Gardenia Liu
+ * @author Gabe Abrams
+ */
+const genConfiguration = () => {
+  // Define paths
+  const GLOBALS_PATH = path.join(CWD, '/cypress/globals');
+  const PROFILES_PATH = path.join(CWD, '/cypress/profiles');
+  
+  // Import global env var objects
+  const GlobalCredentials: GlobalsOrProfile = require(path.join(GLOBALS_PATH, '/GlobalCredentials'));
+  const GlobalResources: GlobalsOrProfile = require(path.join(GLOBALS_PATH, '/GlobalResources'));
+  const GlobalValues: GlobalsOrProfile = require(path.join(GLOBALS_PATH, '/GlobalValues'));
+
+  // Determine profile file name (default is stage)
+  const profileName = process.env.CYPRESS_PROFILE || 'stage';
+
+  // Load in chosen profile configuration
+  let profileModules: GlobalsOrProfile = {};
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const mod = require(path.join(PROFILES_PATH, `/${profileName}.Profile`));
+    profileModules = (mod?.default ?? mod ?? {}) as GlobalsOrProfile;
+  } catch (e) {
+    console.warn(`[cypress.config] Could not load profile '${profileName}.Profile'`, e);
+    process.exit(1);
+  }
+
+  // NOTE: Order matters (later overrides earlier)
+  const sources: GlobalsOrProfile[] = [GlobalCredentials, GlobalResources, GlobalValues, profileModules];
+
+  // Split all sources into basic and dependent
+  const splits: SplitEnv[] = sources.map(source => splitEnv(source));
+
+  // Extract basic and dependent values from splits
+  const basicValues = splits.map((s) => s.basic);
+  const dependentValues = splits.map((s) => s.dependent);
+
+  // Merge all of the basics
+  const basics: GlobalsOrProfile = deepmerge.all<GlobalsOrProfile>(basicValues);
+
+  // Resolve dependencies
+  const dependents: GlobalsOrProfile = resolveDependents(dependentValues, basics);
+
+  // Add basics, depends, and profileName into the final env
+  const finalEnv: GlobalsOrProfile = { 
+    ...basics,
+    ...dependents,
+    profileName,
+  };
+
+  const baseUrl = finalEnv.baseURL;
+
+  const config = defineConfig({
+    e2e: {
+      baseUrl,
+      env: finalEnv,
+    },
+  });
+
+  return config;
+};
+
+export default genConfiguration;

package/src/genConfiguration/types/DependentValue.ts

@@ -0,0 +1,14 @@
+/**
+ * Value for a dependent entry
+ * @author Gardenia Liu
+ */
+type DependentValue = {
+  dependsOn: string,
+} & {
+  // Environment, global variables, profile values, etc.
+  [k: string]: any,
+  // Default value if the dependsOn value is not found
+  default?: any,
+};
+
+export default DependentValue;

package/src/genConfiguration/types/GlobalsOrProfile.ts

@@ -0,0 +1,12 @@
+/**
+ * Object containing global variables, profile values, etc.
+ * @author Gardenia Liu
+ */
+type GlobalsOrProfile = {
+  // Base URL to prefix all paths with
+  baseURL?: string,
+  // Environment, global variables, profile values, etc.
+  [k: string]: any,
+};
+
+export default GlobalsOrProfile;

package/src/genConfiguration/types/SplitEnv.ts

@@ -0,0 +1,18 @@
+// Import shared types
+import type GlobalsOrProfile from './GlobalsOrProfile';
+import type DependentValue from './DependentValue';
+
+/**
+ * Env type where basic and dependent entries are separated
+ * @author Gardenia Liu
+ */
+type SplitEnv = {
+  // Basic entries
+  basic: GlobalsOrProfile,
+  // Dependent entries
+  dependent: {
+    [k: string]: DependentValue,
+  },
+};
+
+export default SplitEnv;

package/src/index.ts

@@ -0,0 +1,17 @@
+// Import helpers
+import init from './init';
+import genConfiguration from './genConfiguration';
+
+// Import types
+import GlobalsOrProfile from './genConfiguration/types/GlobalsOrProfile';
+
+// Automatically initialize upon importing the library
+init();
+
+export {
+  // Helpers
+  init,
+  genConfiguration,
+  // Types
+  GlobalsOrProfile,
+};

package/src/init.ts

@@ -0,0 +1,13 @@
+// Import all commands
+import clickSomething from './commands/clickSomething';
+
+/**
+ * Initialize custom commands
+ * @author Gabe Abrams
+ */
+const init = () => {
+  // Execute each command adder
+  clickSomething();
+};
+
+export default init;

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "noImplicitAny": true,
+    "noEmitOnError": true,
+    "removeComments": false,
+    "declaration": true,
+    "sourceMap": true,
+    "target": "es5",
+    "lib": ["es5", "es2015.promise", "es2017.object"],
+    "outDir": "./lib"
+  },
+  "include": [
+    "./src"
+  ],
+  "ts-node": {
+    "files": true
+  }
+}