dceky 1.4.1 → 1.4.2

package/README.md

@@ -89,6 +89,29 @@ But, developers should run tests using `npm run ky:dev` because each time the te
 
 There are three types of globals: `/cypress/globals/GlobalCredentials` (secure values must go here), `/cypress/globals/GlobalResources` (videos, links, resources), and `/cypress/globals/GlobalValues` (everything else).
 
+### Controlling the Viewport
+
+Each profile can set the viewport that tests run in via two optional variables:
+
+| Variable | Description |
+| --- | --- |
+| `viewport` | A generic alias — `desktop` (a 4k monitor, the default), `macbook`, `ipad`, or `iphone` — or any [Cypress viewport preset](https://docs.cypress.io/api/commands/viewport) such as `iphone-x`, `ipad-2`, or `macbook-16`. Defaults to `desktop`. |
+| `orientation` | `landscape` or `portrait`. Defaults to `landscape`, except `iphone` viewports which default to `portrait`. |
+
+The generic aliases map to specific devices: `iphone` → `iphone-x`, `ipad` → `ipad-2`, `macbook` → `macbook-16`, and `desktop` → a 4k monitor (3840×2160).
+
+Ky applies the viewport automatically before each test.
+
+```ts
+const StageProfile = {
+  baseURL: 'stage.example.harvard.edu',
+  viewport: 'iphone',
+  orientation: 'portrait',
+};
+
+export default StageProfile;
+```
+
 ### Writing Your Own Custom Commands
 
 Custom commands are called using Ky (e.g. `ky.myCustomCommand()`), and you define them in the `commands` folder generated when you first setup Ky.

package/lib/setup/checkRequiredFiles/genEmptyProfileFile.js

@@ -45,6 +45,14 @@ const genEmptyProfileFile = (name) => {
         '  // Static Value Examples:',
         '  // loginSystem: \'HarvardKey\'',
         '',
+        '  // Viewport Example (default: desktop):',
+        '  // Generic aliases: desktop, macbook, ipad, iphone',
+        '  // ...or any Cypress preset (e.g. iphone-x, ipad-2, macbook-16)',
+        '  // viewport: \'desktop\',',
+        '',
+        '  // Orientation Example (default: landscape, or portrait for iphone):',
+        '  // orientation: \'landscape\',',
+        '',
         '  // Dependent Value Example:',
         '  // loginHost: {',
         '  //   dependsOn: \'loginSystem\',',

package/lib/setup/checkRequiredFiles/genEmptyProfileFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"genEmptyProfileFile.js","sourceRoot":"","sources":["../../../setup/checkRequiredFiles/genEmptyProfileFile.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,wBAAwB;AACxB,yEAAiD;AAEjD;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAU,EAAE;IACnD,MAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAE3B,uCAAuC;IACvC,MAAM,gBAAgB,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,CAAC;IAE5D,iBAAiB;IACjB,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,gCAAgC,IAAI,aAAa,CAAC,CAAC;IAE/D,MAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IACxD,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,aAAa,CAAC,CAAC;IAEhE,gCAAgC;IAChC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAChC,uBAAuB;QACvB,YAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,sDAAsD;IACtD,MAAM,YAAY,GAAG,CACnB,gBAAgB;QACd,CAAC,CAAC;YACA,+CAA+C;YAC/C,6CAA6C;YAC7C,EAAE;SACH;QACD,CAAC,CAAC,EAAE,CACP,CAAC;IAEF,sCAAsC;IACtC,MAAM,YAAY,GAAG;QACnB,KAAK;QACL,MAAM,IAAI,UAAU;QACpB,KAAK;QACL,EAAE;QACF,SAAS,IAAI,aAAa;QAC1B,GAAG,YAAY;QACf,6BAA6B;QAC7B,kCAAkC;QAClC,EAAE;QACF,+BAA+B;QAC/B,mBAAmB;QACnB,oCAAoC;QACpC,2CAA2C;QAC3C,sDAAsD;QACtD,SAAS;QACT,EAAE;QACF,4CAA4C;QAC5C,iBAAiB;QACjB,gCAAgC;QAChC,0CAA0C;QAC1C,mEAAmE;QACnE,SAAS;QACT,IAAI;QACJ,EAAE;QACF,kBAAkB,IAAI,UAAU;QAChC,EAAE;KACH,CAAC;IACF,YAAE,CAAC,aAAa,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAE9D,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}
+{"version":3,"file":"genEmptyProfileFile.js","sourceRoot":"","sources":["../../../setup/checkRequiredFiles/genEmptyProfileFile.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,wBAAwB;AACxB,yEAAiD;AAEjD;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAU,EAAE;IACnD,MAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;IAE3B,uCAAuC;IACvC,MAAM,gBAAgB,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,CAAC;IAE5D,iBAAiB;IACjB,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,gCAAgC,IAAI,aAAa,CAAC,CAAC;IAE/D,MAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IACxD,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,aAAa,CAAC,CAAC;IAEhE,gCAAgC;IAChC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAChC,uBAAuB;QACvB,YAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,sDAAsD;IACtD,MAAM,YAAY,GAAG,CACnB,gBAAgB;QACd,CAAC,CAAC;YACA,+CAA+C;YAC/C,6CAA6C;YAC7C,EAAE;SACH;QACD,CAAC,CAAC,EAAE,CACP,CAAC;IAEF,sCAAsC;IACtC,MAAM,YAAY,GAAG;QACnB,KAAK;QACL,MAAM,IAAI,UAAU;QACpB,KAAK;QACL,EAAE;QACF,SAAS,IAAI,aAAa;QAC1B,GAAG,YAAY;QACf,6BAA6B;QAC7B,kCAAkC;QAClC,EAAE;QACF,2CAA2C;QAC3C,sDAAsD;QACtD,mEAAmE;QACnE,6BAA6B;QAC7B,EAAE;QACF,wEAAwE;QACxE,kCAAkC;QAClC,EAAE;QACF,+BAA+B;QAC/B,mBAAmB;QACnB,oCAAoC;QACpC,2CAA2C;QAC3C,sDAAsD;QACtD,SAAS;QACT,EAAE;QACF,4CAA4C;QAC5C,iBAAiB;QACjB,gCAAgC;QAChC,0CAA0C;QAC1C,mEAAmE;QACnE,SAAS;QACT,IAAI;QACJ,EAAE;QACF,kBAAkB,IAAI,UAAU;QAChC,EAAE;KACH,CAAC;IACF,YAAE,CAAC,aAAa,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAE9D,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}

package/lib/src/commands/helpers/resolveViewport.d.ts

@@ -0,0 +1,20 @@
+type ResolvedViewport = ({
+    preset: Cypress.ViewportPreset;
+    orientation: Cypress.ViewportOrientation;
+} | {
+    width: number;
+    height: number;
+});
+/**
+ * Resolve the "viewport" and "orientation" profile variables into arguments
+ * for cy.viewport. Generic aliases (iphone, ipad, macbook, desktop) are mapped
+ * to specific devices, and a sensible default orientation is chosen
+ * @author Yuen Ler Chow
+ * @param rawViewport the "viewport" profile variable (a preset name or generic
+ *   alias). Defaults to "desktop" if not provided
+ * @param rawOrientation the "orientation" profile variable ("landscape" or
+ *   "portrait"). Defaults to "landscape", or "portrait" for iphone viewports
+ * @returns resolved arguments for cy.viewport
+ */
+declare const resolveViewport: (rawViewport?: string, rawOrientation?: string) => ResolvedViewport;
+export default resolveViewport;

package/lib/src/commands/helpers/resolveViewport.js

@@ -0,0 +1,61 @@
+"use strict";
+/// <reference types="cypress" />
+Object.defineProperty(exports, "__esModule", { value: true });
+/*----------------------------------------*/
+/* -------------- Constants ------------- */
+/*----------------------------------------*/
+// Generic viewport aliases that map to a specific Cypress device preset
+const GENERIC_VIEWPORT_ALIASES = {
+    iphone: 'iphone-x',
+    ipad: 'ipad-2',
+    macbook: 'macbook-16',
+};
+// Special "desktop" preset: dimensions of a 4k monitor
+const DESKTOP_VIEWPORT = { width: 3840, height: 2160 };
+// Preset to use when no viewport is specified in the profile
+const DEFAULT_VIEWPORT = 'desktop';
+/*----------------------------------------*/
+/* --------------- Helper --------------- */
+/*----------------------------------------*/
+/**
+ * Resolve the "viewport" and "orientation" profile variables into arguments
+ * for cy.viewport. Generic aliases (iphone, ipad, macbook, desktop) are mapped
+ * to specific devices, and a sensible default orientation is chosen
+ * @author Yuen Ler Chow
+ * @param rawViewport the "viewport" profile variable (a preset name or generic
+ *   alias). Defaults to "desktop" if not provided
+ * @param rawOrientation the "orientation" profile variable ("landscape" or
+ *   "portrait"). Defaults to "landscape", or "portrait" for iphone viewports
+ * @returns resolved arguments for cy.viewport
+ */
+const resolveViewport = (rawViewport, rawOrientation) => {
+    var _a;
+    // Normalize the requested viewport (default to desktop)
+    const requested = (rawViewport !== null && rawViewport !== void 0 ? rawViewport : DEFAULT_VIEWPORT).trim().toLowerCase();
+    // Resolve generic aliases (e.g. "iphone" => "iphone-x")
+    const viewport = ((_a = GENERIC_VIEWPORT_ALIASES[requested]) !== null && _a !== void 0 ? _a : requested);
+    // Determine orientation (default landscape, but portrait for iphones)
+    const isIphone = viewport.startsWith('iphone');
+    const defaultOrientation = (isIphone ? 'portrait' : 'landscape');
+    const orientation = (rawOrientation
+        ? rawOrientation.trim().toLowerCase()
+        : defaultOrientation);
+    // Validate orientation
+    if (orientation !== 'landscape' && orientation !== 'portrait') {
+        throw new Error(`dceky: Invalid "orientation" profile variable "${rawOrientation}". Expected "landscape" or "portrait".`);
+    }
+    // Handle the special "desktop" preset (a 4k monitor)
+    if (viewport === 'desktop') {
+        const { width, height } = DESKTOP_VIEWPORT;
+        // Swap dimensions for portrait
+        return (orientation === 'portrait'
+            ? { width: height, height: width }
+            : { width, height });
+    }
+    return {
+        preset: viewport,
+        orientation: orientation,
+    };
+};
+exports.default = resolveViewport;
+//# sourceMappingURL=resolveViewport.js.map

package/lib/src/commands/helpers/resolveViewport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveViewport.js","sourceRoot":"","sources":["../../../../src/commands/helpers/resolveViewport.ts"],"names":[],"mappings":";AAAA,iCAAiC;;AAEjC,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,wEAAwE;AACxE,MAAM,wBAAwB,GAAgD;IAC5E,MAAM,EAAE,UAAU;IAClB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,YAAY;CACtB,CAAC;AAEF,uDAAuD;AACvD,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAEvD,6DAA6D;AAC7D,MAAM,gBAAgB,GAAG,SAAS,CAAC;AAmBnC,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C;;;;;;;;;;GAUG;AACH,MAAM,eAAe,GAAG,CACtB,WAAoB,EACpB,cAAuB,EACL,EAAE;;IACpB,wDAAwD;IACxD,MAAM,SAAS,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,gBAAgB,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAEzE,wDAAwD;IACxD,MAAM,QAAQ,GAAG,CAAC,MAAA,wBAAwB,CAAC,SAAS,CAAC,mCAAI,SAAS,CAAC,CAAC;IAEpE,sEAAsE;IACtE,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,kBAAkB,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IACjE,MAAM,WAAW,GAAG,CAClB,cAAc;QACZ,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE;QACrC,CAAC,CAAC,kBAAkB,CACvB,CAAC;IAEF,uBAAuB;IACvB,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,KAAK,UAAU,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CACb,kDAAkD,cAAc,wCAAwC,CACzG,CAAC;IACJ,CAAC;IAED,qDAAqD;IACrD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;QAC3C,+BAA+B;QAC/B,OAAO,CACL,WAAW,KAAK,UAAU;YACxB,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE;YAClC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CACtB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,EAAE,QAAkC;QAC1C,WAAW,EAAE,WAA0C;KACxD,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/lib/src/commands/index.js

@@ -38,6 +38,7 @@ const getProfileValue_1 = __importDefault(require("./getProfileValue"));
 const getCredentialValue_1 = __importDefault(require("./getCredentialValue"));
 const getCredentialValues_1 = __importDefault(require("./getCredentialValues"));
 const sendRequest_1 = __importDefault(require("./sendRequest"));
+const setupViewport_1 = __importDefault(require("./setupViewport"));
 /**
  * Initialize custom commands
  * @author Gabe Abrams
@@ -78,6 +79,7 @@ const commands = () => {
     (0, getCredentialValue_1.default)();
     (0, getCredentialValues_1.default)();
     (0, sendRequest_1.default)();
+    (0, setupViewport_1.default)();
 };
 exports.default = commands;
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/index.ts"],"names":[],"mappings":";;;;;AAAA,sBAAsB;AACtB,sFAA8D;AAC9D,sEAA8C;AAC9C,4EAAoD;AACpD,kFAA0D;AAC1D,kFAA0D;AAC1D,sGAA8E;AAC9E,wEAAgD;AAChD,kEAA0C;AAC1C,kEAA0C;AAC1C,8EAAsD;AACtD,oDAA4B;AAC5B,wDAAgC;AAChC,sEAA8C;AAC9C,wEAAgD;AAChD,0DAAkC;AAClC,0EAAkD;AAClD,0DAAkC;AAClC,0EAAkD;AAClD,0EAAkD;AAClD,kEAA0C;AAC1C,sEAA8C;AAC9C,kEAA0C;AAC1C,4DAAoC;AACpC,gDAAwB;AACxB,gEAAwC;AACxC,0DAAkC;AAClC,0DAAkC;AAClC,gFAAwD;AACxD,wGAAgF;AAChF,oFAA4D;AAC5D,wEAAgD;AAChD,8EAAsD;AACtD,gFAAwD;AACxD,gEAAwC;AAExC;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAG,EAAE;IACpB,6BAA6B;IAC7B,IAAA,gCAAsB,GAAE,CAAC;IACzB,IAAA,wBAAc,GAAE,CAAC;IACjB,IAAA,2BAAiB,GAAE,CAAC;IACpB,IAAA,8BAAoB,GAAE,CAAC;IACvB,IAAA,8BAAoB,GAAE,CAAC;IACvB,IAAA,wCAA8B,GAAE,CAAC;IACjC,IAAA,yBAAe,GAAE,CAAC;IAClB,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,4BAAkB,GAAE,CAAC;IACrB,IAAA,eAAK,GAAE,CAAC;IACR,IAAA,iBAAO,GAAE,CAAC;IACV,IAAA,wBAAc,GAAE,CAAC;IACjB,IAAA,yBAAe,GAAE,CAAC;IAClB,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,0BAAgB,GAAE,CAAC;IACnB,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,0BAAgB,GAAE,CAAC;IACnB,IAAA,0BAAgB,GAAE,CAAC;IACnB,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,wBAAc,GAAE,CAAC;IACjB,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,mBAAS,GAAE,CAAC;IACZ,IAAA,aAAG,GAAE,CAAC;IACN,IAAA,qBAAW,GAAE,CAAC;IACd,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,6BAAmB,GAAE,CAAC;IACtB,IAAA,yCAA+B,GAAE,CAAC;IAClC,IAAA,+BAAqB,GAAE,CAAC;IACxB,IAAA,yBAAe,GAAE,CAAC;IAClB,IAAA,4BAAkB,GAAE,CAAC;IACrB,IAAA,6BAAmB,GAAE,CAAC;IACtB,IAAA,qBAAW,GAAE,CAAC;AAChB,CAAC,CAAC;AAEF,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/index.ts"],"names":[],"mappings":";;;;;AAAA,sBAAsB;AACtB,sFAA8D;AAC9D,sEAA8C;AAC9C,4EAAoD;AACpD,kFAA0D;AAC1D,kFAA0D;AAC1D,sGAA8E;AAC9E,wEAAgD;AAChD,kEAA0C;AAC1C,kEAA0C;AAC1C,8EAAsD;AACtD,oDAA4B;AAC5B,wDAAgC;AAChC,sEAA8C;AAC9C,wEAAgD;AAChD,0DAAkC;AAClC,0EAAkD;AAClD,0DAAkC;AAClC,0EAAkD;AAClD,0EAAkD;AAClD,kEAA0C;AAC1C,sEAA8C;AAC9C,kEAA0C;AAC1C,4DAAoC;AACpC,gDAAwB;AACxB,gEAAwC;AACxC,0DAAkC;AAClC,0DAAkC;AAClC,gFAAwD;AACxD,wGAAgF;AAChF,oFAA4D;AAC5D,wEAAgD;AAChD,8EAAsD;AACtD,gFAAwD;AACxD,gEAAwC;AACxC,oEAA4C;AAE5C;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAG,EAAE;IACpB,6BAA6B;IAC7B,IAAA,gCAAsB,GAAE,CAAC;IACzB,IAAA,wBAAc,GAAE,CAAC;IACjB,IAAA,2BAAiB,GAAE,CAAC;IACpB,IAAA,8BAAoB,GAAE,CAAC;IACvB,IAAA,8BAAoB,GAAE,CAAC;IACvB,IAAA,wCAA8B,GAAE,CAAC;IACjC,IAAA,yBAAe,GAAE,CAAC;IAClB,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,4BAAkB,GAAE,CAAC;IACrB,IAAA,eAAK,GAAE,CAAC;IACR,IAAA,iBAAO,GAAE,CAAC;IACV,IAAA,wBAAc,GAAE,CAAC;IACjB,IAAA,yBAAe,GAAE,CAAC;IAClB,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,0BAAgB,GAAE,CAAC;IACnB,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,0BAAgB,GAAE,CAAC;IACnB,IAAA,0BAAgB,GAAE,CAAC;IACnB,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,wBAAc,GAAE,CAAC;IACjB,IAAA,sBAAY,GAAE,CAAC;IACf,IAAA,mBAAS,GAAE,CAAC;IACZ,IAAA,aAAG,GAAE,CAAC;IACN,IAAA,qBAAW,GAAE,CAAC;IACd,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,kBAAQ,GAAE,CAAC;IACX,IAAA,6BAAmB,GAAE,CAAC;IACtB,IAAA,yCAA+B,GAAE,CAAC;IAClC,IAAA,+BAAqB,GAAE,CAAC;IACxB,IAAA,yBAAe,GAAE,CAAC;IAClB,IAAA,4BAAkB,GAAE,CAAC;IACrB,IAAA,6BAAmB,GAAE,CAAC;IACtB,IAAA,qBAAW,GAAE,CAAC;IACd,IAAA,uBAAa,GAAE,CAAC;AAClB,CAAC,CAAC;AAEF,kBAAe,QAAQ,CAAC"}

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

@@ -0,0 +1,7 @@
+/**
+ * Register a global beforeEach hook that sets the Cypress viewport based on the
+ * "viewport" and "orientation" profile variables
+ * @author Yuen Ler Chow
+ */
+declare const setupViewport: () => void;
+export default setupViewport;

package/lib/src/commands/setupViewport.js

@@ -0,0 +1,37 @@
+"use strict";
+/// <reference types="cypress" />
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import helpers
+const resolveViewport_1 = __importDefault(require("./helpers/resolveViewport"));
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+/**
+ * Register a global beforeEach hook that sets the Cypress viewport based on the
+ * "viewport" and "orientation" profile variables
+ * @author Yuen Ler Chow
+ */
+const setupViewport = () => {
+    beforeEach(() => {
+        // Read the viewport settings from the current profile
+        const rawViewport = Cypress.expose('viewport');
+        const rawOrientation = Cypress.expose('orientation');
+        // Resolve the profile variables into cy.viewport arguments
+        const resolved = (0, resolveViewport_1.default)(rawViewport, rawOrientation);
+        // Apply the viewport
+        if ('preset' in resolved) {
+            cy.viewport(resolved.preset, resolved.orientation);
+        }
+        else {
+            cy.viewport(resolved.width, resolved.height);
+        }
+    });
+};
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+exports.default = setupViewport;
+//# sourceMappingURL=setupViewport.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setupViewport.js","sourceRoot":"","sources":["../../../src/commands/setupViewport.ts"],"names":[],"mappings":";AAAA,iCAAiC;;;;;AAEjC,iBAAiB;AACjB,gFAAwD;AAExD,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C;;;;GAIG;AACH,MAAM,aAAa,GAAG,GAAG,EAAE;IACzB,UAAU,CAAC,GAAG,EAAE;QACd,sDAAsD;QACtD,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAuB,CAAC;QACrE,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,aAAa,CAAuB,CAAC;QAE3E,2DAA2D;QAC3D,MAAM,QAAQ,GAAG,IAAA,yBAAe,EAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QAE9D,qBAAqB;QACrB,IAAI,QAAQ,IAAI,QAAQ,EAAE,CAAC;YACzB,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,4CAA4C;AAC5C,4CAA4C;AAC5C,4CAA4C;AAE5C,kBAAe,aAAa,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dceky",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Cypress toolkit for Harvard DCE",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",

package/setup/checkRequiredFiles/genEmptyProfileFile.ts

@@ -50,6 +50,14 @@ const genEmptyProfileFile = (name: string): string => {
     '  // Static Value Examples:',
     '  // loginSystem: \'HarvardKey\'',
     '',
+    '  // Viewport Example (default: desktop):',
+    '  // Generic aliases: desktop, macbook, ipad, iphone',
+    '  // ...or any Cypress preset (e.g. iphone-x, ipad-2, macbook-16)',
+    '  // viewport: \'desktop\',',
+    '',
+    '  // Orientation Example (default: landscape, or portrait for iphone):',
+    '  // orientation: \'landscape\',',
+    '',
     '  // Dependent Value Example:',
     '  // loginHost: {',
     '  //   dependsOn: \'loginSystem\',',

package/src/commands/helpers/resolveViewport.ts

@@ -0,0 +1,95 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* -------------- Constants ------------- */
+/*----------------------------------------*/
+
+// Generic viewport aliases that map to a specific Cypress device preset
+const GENERIC_VIEWPORT_ALIASES: { [alias: string]: Cypress.ViewportPreset } = {
+  iphone: 'iphone-x',
+  ipad: 'ipad-2',
+  macbook: 'macbook-16',
+};
+
+// Special "desktop" preset: dimensions of a 4k monitor
+const DESKTOP_VIEWPORT = { width: 3840, height: 2160 };
+
+// Preset to use when no viewport is specified in the profile
+const DEFAULT_VIEWPORT = 'desktop';
+
+/*----------------------------------------*/
+/* ----------------- Type --------------- */
+/*----------------------------------------*/
+
+type ResolvedViewport = (
+  // A native Cypress device preset...
+  | {
+    preset: Cypress.ViewportPreset,
+    orientation: Cypress.ViewportOrientation,
+  }
+  // ...or explicit dimensions (used for the "desktop" preset)
+  | {
+    width: number,
+    height: number,
+  }
+);
+
+/*----------------------------------------*/
+/* --------------- Helper --------------- */
+/*----------------------------------------*/
+
+/**
+ * Resolve the "viewport" and "orientation" profile variables into arguments
+ * for cy.viewport. Generic aliases (iphone, ipad, macbook, desktop) are mapped
+ * to specific devices, and a sensible default orientation is chosen
+ * @author Yuen Ler Chow
+ * @param rawViewport the "viewport" profile variable (a preset name or generic
+ *   alias). Defaults to "desktop" if not provided
+ * @param rawOrientation the "orientation" profile variable ("landscape" or
+ *   "portrait"). Defaults to "landscape", or "portrait" for iphone viewports
+ * @returns resolved arguments for cy.viewport
+ */
+const resolveViewport = (
+  rawViewport?: string,
+  rawOrientation?: string,
+): ResolvedViewport => {
+  // Normalize the requested viewport (default to desktop)
+  const requested = (rawViewport ?? DEFAULT_VIEWPORT).trim().toLowerCase();
+
+  // Resolve generic aliases (e.g. "iphone" => "iphone-x")
+  const viewport = (GENERIC_VIEWPORT_ALIASES[requested] ?? requested);
+
+  // Determine orientation (default landscape, but portrait for iphones)
+  const isIphone = viewport.startsWith('iphone');
+  const defaultOrientation = (isIphone ? 'portrait' : 'landscape');
+  const orientation = (
+    rawOrientation
+      ? rawOrientation.trim().toLowerCase()
+      : defaultOrientation
+  );
+
+  // Validate orientation
+  if (orientation !== 'landscape' && orientation !== 'portrait') {
+    throw new Error(
+      `dceky: Invalid "orientation" profile variable "${rawOrientation}". Expected "landscape" or "portrait".`,
+    );
+  }
+
+  // Handle the special "desktop" preset (a 4k monitor)
+  if (viewport === 'desktop') {
+    const { width, height } = DESKTOP_VIEWPORT;
+    // Swap dimensions for portrait
+    return (
+      orientation === 'portrait'
+        ? { width: height, height: width }
+        : { width, height }
+    );
+  }
+
+  return {
+    preset: viewport as Cypress.ViewportPreset,
+    orientation: orientation as Cypress.ViewportOrientation,
+  };
+};
+
+export default resolveViewport;

package/src/commands/index.ts

@@ -33,6 +33,7 @@ import getProfileValue from './getProfileValue';
 import getCredentialValue from './getCredentialValue';
 import getCredentialValues from './getCredentialValues';
 import sendRequest from './sendRequest';
+import setupViewport from './setupViewport';
 
 /**
  * Initialize custom commands
@@ -74,6 +75,7 @@ const commands = () => {
   getCredentialValue();
   getCredentialValues();
   sendRequest();
+  setupViewport();
 };
 
 export default commands;

package/src/commands/setupViewport.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+
+// Import helpers
+import resolveViewport from './helpers/resolveViewport';
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+/**
+ * Register a global beforeEach hook that sets the Cypress viewport based on the
+ * "viewport" and "orientation" profile variables
+ * @author Yuen Ler Chow
+ */
+const setupViewport = () => {
+  beforeEach(() => {
+    // Read the viewport settings from the current profile
+    const rawViewport = Cypress.expose('viewport') as string | undefined;
+    const rawOrientation = Cypress.expose('orientation') as string | undefined;
+
+    // Resolve the profile variables into cy.viewport arguments
+    const resolved = resolveViewport(rawViewport, rawOrientation);
+
+    // Apply the viewport
+    if ('preset' in resolved) {
+      cy.viewport(resolved.preset, resolved.orientation);
+    } else {
+      cy.viewport(resolved.width, resolved.height);
+    }
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default setupViewport;