@globisnv/cypress-core 0.0.1

package/package.json

@@ -0,0 +1,58 @@
+{
+    "name": "@globisnv/cypress-core",
+    "version": "0.0.1",
+    "description": "Core building blocks for Globis Cypress E2E tests",
+    "type": "module",
+    "publishConfig": {
+        "access": "public"
+    },
+    "globisOnline": {
+        "minVersion": "11.0.2"
+    },
+    "exports": {
+        ".": "./dist/index.js",
+        "./register": "./dist/register.js",
+        "./config": "./dist/config.js",
+        "./tsHelper": "./dist/tsHelper.js",
+        "./types": "./dist/types.js",
+        "./blueprints/*": "./dist/blueprints/*.js",
+        "./apiMethods/*": "./dist/apiMethods/*.js",
+        "./commands/*": "./dist/commands/*.js"
+    },
+    "types": "./dist/index.d.ts",
+    "bin": {
+        "create-globis-customer-repo": "bin/create-customer-repo.mjs"
+    },
+    "files": [
+        "dist",
+        "scripts",
+        "bin",
+        "template",
+        "biome.json"
+    ],
+    "scripts": {
+        "build": "tsc -p tsconfig.build.json",
+        "build:watch": "tsc -p tsconfig.build.json --watch --preserveWatchOutput",
+        "lint": "biome check .",
+        "lint:fix": "biome check . --write",
+        "typescript": "tsc --noEmit --skipLibCheck"
+    },
+    "peerDependencies": {
+        "cypress": "^15.19.0",
+        "cypress-real-events": "^1.15.0"
+    },
+    "dependencies": {
+        "@aws-crypto/sha256-js": "^5.2.0",
+        "@aws-sdk/credential-provider-imds": "^3.374.0",
+        "@aws-sdk/signature-v4": "^3.374.0",
+        "snappyjs": "^0.7.0",
+        "uuid": "^14.0.1"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "^2.5.7",
+        "@types/node": "^26.1.2",
+        "cypress": "^15.19.0",
+        "cypress-real-events": "^1.15.0",
+        "typescript": "^7.0.2"
+    }
+}

package/scripts/check-unnecessary-waiting.mjs

@@ -0,0 +1,119 @@
+#!/usr/bin/env node
+// Standalone replacement for the biome-plugins/no-unnecessary-waiting.grit plugin.
+//
+// Biome's GritQL plugins (2.5.7) have no suppression mechanism - a
+// register_diagnostic() call either fires or it doesn't, with no per-line
+// ignore comment support (confirmed: `biome lint --suppress` writes nothing
+// for plugin-sourced diagnostics). Blocking on cy.wait(<number>) while still
+// allowing a documented exception needs code that can check for a preceding
+// comment itself, so this is a plain AST walk instead of a Grit plugin.
+//
+// Flags cy.wait(<number literal>[, options]) unless the line directly above
+// the call has a `// biome-ignore plugin: <reason>` comment.
+
+import path from 'node:path';
+import * as ts from 'typescript/unstable/ast';
+import { API } from 'typescript/unstable/sync';
+
+const ROOT = process.cwd(); // invoking repo's root, not this script's install location
+const TSCONFIG = 'tsconfig.json';
+const IGNORE_COMMENT = /^\s*\/\/\s*biome-ignore\s+plugin:/;
+
+function walkAll(node, visit) {
+    visit(node);
+    node.forEachChild((child) => walkAll(child, visit));
+}
+
+function isIgnored(sourceFile, node) {
+    const line = sourceFile.getLineAndCharacterOfPosition(node.getStart()).line;
+    if (line === 0) return false;
+    const lineStarts = sourceFile.getLineStarts();
+    const prevLineText = sourceFile.text.slice(lineStarts[line - 1], lineStarts[line]);
+    return IGNORE_COMMENT.test(prevLineText);
+}
+
+// A cy.wait(x) call is just as arbitrary when x is a const/default-param alias for a
+// numeric literal (e.g. `const serverTimeout = 5000`) as when it's inlined. Resolve by
+// walking up to the nearest enclosing block/function and looking for a declaration of
+// that name among its statements/parameters - not a file-wide name search, since two
+// unrelated functions can each declare their own same-named local (e.g. `pollInterval`).
+function resolveNumericAlias(identifier) {
+    const name = identifier.text;
+    for (let scope = identifier.parent; scope; scope = scope.parent) {
+        if (ts.isFunctionLikeDeclaration(scope)) {
+            for (const param of scope.parameters) {
+                if (ts.isIdentifier(param.name) && param.name.text === name && param.initializer && ts.isNumericLiteral(param.initializer)) {
+                    return param.initializer.text;
+                }
+            }
+        }
+        if (ts.isBlock(scope) || ts.isSourceFile(scope)) {
+            const statements = scope.statements;
+            for (const statement of statements) {
+                if (!ts.isVariableStatement(statement)) continue;
+                for (const decl of statement.declarationList.declarations) {
+                    if (ts.isIdentifier(decl.name) && decl.name.text === name && decl.initializer && ts.isNumericLiteral(decl.initializer)) {
+                        return decl.initializer.text;
+                    }
+                }
+            }
+        }
+    }
+    return undefined;
+}
+
+function checkSourceFile(sourceFile) {
+    const violations = [];
+    walkAll(sourceFile, (node) => {
+        if (!ts.isCallExpression(node)) return;
+        const callee = node.expression;
+        if (!ts.isPropertyAccessExpression(callee) || !ts.isIdentifier(callee.expression) || callee.expression.text !== 'cy') return;
+        if (callee.name.text !== 'wait') return;
+
+        const msArg = node.arguments[0];
+        if (!msArg) return;
+        const isDirectLiteral = ts.isNumericLiteral(msArg);
+        const isNumericAlias = ts.isIdentifier(msArg) && resolveNumericAlias(msArg) !== undefined;
+        if (!isDirectLiteral && !isNumericAlias) return;
+        if (isIgnored(sourceFile, node)) return;
+
+        violations.push({
+            file: sourceFile.fileName,
+            line: sourceFile.getLineAndCharacterOfPosition(node.getStart()).line + 1
+        });
+    });
+    return violations;
+}
+
+function main() {
+    const api = new API({ cwd: ROOT });
+    try {
+        const snapshot = api.updateSnapshot({ openProjects: [TSCONFIG] });
+        const project = snapshot.getProject(TSCONFIG);
+
+        const cypressRoot = path.join(ROOT, 'cypress') + path.sep;
+        const fileNames = project.rootFiles.filter((f) => f.startsWith(cypressRoot) && f.endsWith('.ts') && !f.endsWith('.d.ts'));
+
+        const allViolations = [];
+        for (const fileName of fileNames) {
+            const sourceFile = project.program.getSourceFile(fileName);
+            if (!sourceFile) continue;
+            allViolations.push(...checkSourceFile(sourceFile));
+        }
+
+        for (const v of allViolations) {
+            console.log(
+                `${path.relative(ROOT, v.file)}:${v.line} Avoid arbitrary cy.wait(ms); prefer cy.intercept()/should() polling instead. (add "// biome-ignore plugin: <reason>" above the line if intentional)`
+            );
+        }
+
+        if (allViolations.length > 0) {
+            console.log(`\n${allViolations.length} unguarded cy.wait(ms) call(s) found.`);
+            process.exit(1);
+        }
+    } finally {
+        api.close();
+    }
+}
+
+main();

package/template/CODEOWNERS

@@ -0,0 +1,20 @@
+#No blanket rule here on purpose — the customer owns and merges their own specs,
+#blueprints, and command files without Globis review. Only the config/workflow
+#surface below needs a Globis reviewer.
+
+#These rules protect the packages
+package.json @robrecht-vanmelckebeke @DVersavel @pascal-jacob @stinobook
+package-lock.json @robrecht-vanmelckebeke @DVersavel @pascal-jacob @stinobook
+
+#These rules protect the github actions
+/.github/ @robrecht-vanmelckebeke @DVersavel @pascal-jacob @stinobook
+
+#This rule protects the config file
+cypress.config.ts @robrecht-vanmelckebeke @DVersavel @pascal-jacob @stinobook
+tsconfig.json @robrecht-vanmelckebeke @DVersavel @pascal-jacob @stinobook
+
+#This rule protects the linter rules
+biome.json @robrecht-vanmelckebeke @DVersavel @pascal-jacob @stinobook
+
+#This rule protects the support entrypoint (wires in the core package + testFailed hooks)
+/cypress/support/ @robrecht-vanmelckebeke @DVersavel @pascal-jacob @stinobook

package/template/biome.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://biomejs.dev/schemas/2.5.7/schema.json",
+    "extends": ["./node_modules/@globisnv/cypress-core/biome.json"],
+    "files": {
+        "includes": ["!cypress/screenshots", "!cypress/videos", "!cypress/downloads", "!cypress/reports", "!cypress.env*.json"]
+    }
+}

package/template/cypress/e2e/__CUSTOMER__/template.cy.ts.example

@@ -0,0 +1,18 @@
+/**
+ * @author - Your name here
+ */
+
+describe('description of the test case group', () => {
+    beforeEach('Login', () => {
+        cy.GLO_checkUser();
+        cy.GLO_login(); // Optional company name 
+    });
+
+    afterEach('Close dashboard', () => {
+        cy.GLO_closeDashboard();
+    });
+
+    it('description of the specific test case', () => {
+        // Write your code here
+    });
+});

package/template/cypress/support/e2e.ts

@@ -0,0 +1,21 @@
+// ***********************************************************
+// This example support/e2e.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Generic commands, websocketDetector, cypress-real-events, and the
+// testFailed hooks all come from the core package.
+import '@globisnv/cypress-core/register';
+
+// Your own commands go here, colocated with your specs, e.g.:
+// import '../e2e/__CUSTOMER_LOWER__/__CUSTOMER_UPPER___commands';

package/template/cypress/support/record.mjs

@@ -0,0 +1,46 @@
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import * as path from 'node:path';
+import process from 'node:process';
+
+const envFile = path.resolve(process.cwd(), 'cypress.env.json');
+let projectId;
+let recordKey;
+
+try {
+    const envContent = fs.readFileSync(envFile, 'utf-8');
+    const envConfig = JSON.parse(envContent);
+    projectId = envConfig.projectId;
+    recordKey = envConfig.recordKey;
+} catch (error) {
+    console.error(`ERROR: Could not read ${envFile}.`, error);
+}
+
+const spec = process.argv[2];
+
+if (!projectId || !recordKey) {
+    console.error('ERROR: Missing `projectId` or `recordKey` in .env file.');
+    process.exit(1);
+}
+
+if (!spec || spec.startsWith('-')) {
+    console.error('ERROR: No spec file provided! Usage: npm run record <spec-file.cy.ts>');
+    process.exit(1);
+}
+
+const cypressPath = path.resolve(process.cwd(), 'node_modules/.bin/cypress');
+
+// Run Cypress
+const result = spawnSync(cypressPath, ['run', '--browser', 'chrome', '--record', '--key', recordKey, '--config', `projectId=${projectId}`, '--spec', spec], {
+    stdio: 'inherit',
+    shell: true,
+    cwd: process.cwd(),
+    env: process.env
+});
+
+if (result.error) {
+    console.error('ERROR:', result.error);
+    process.exit(1);
+}
+
+process.exit(result.status ?? 1);

package/template/cypress.config.ts

@@ -0,0 +1,3 @@
+import { defineGlobisConfig } from '@globisnv/cypress-core/config';
+
+export default defineGlobisConfig();

package/template/cypress.env.json.example

@@ -0,0 +1,24 @@
+// Copy and rename this file to cypress.env.json
+// Delete these comments
+
+{
+    "loginType": "<default/servoy/okta>",
+    "username": "<enter your username here>",
+    "password": "<enter your password here>",
+    "username2": "<optional - alternate login user, used by tests that switch users>",
+    "password2": "<optional - password for username2>",
+
+    "globisUrl": "<enter your globisUrl here>",
+    "oktaUrl": "<optional - only used when loginType is okta>",
+    "ownerName": "<optional - only used for a local Servoy instance>",
+
+    "api_key": "<optional - only used when a command needs an API key>",
+
+    "projectId": "<Cypress Cloud project id - only needed for `npm run record`>",
+    "recordKey": "<Cypress Cloud record key - only needed for `npm run record`>",
+
+    "extraParams": {
+        "cypressWebsocketLoader": "true",
+        "cypressWebsocketDebug": "false"
+    }
+}

package/template/package.json

@@ -0,0 +1,20 @@
+{
+    "name": "__PACKAGE_NAME__",
+    "dependencies": {
+        "@globisnv/cypress-core": "^__CORE_VERSION__",
+        "cypress-real-events": "^1.15.0",
+        "typescript": "^7.0.2"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "^2.5.7",
+        "@types/node": "^26.1.2",
+        "cypress": "^15.19.0"
+    },
+    "scripts": {
+        "lint": "biome check . && node node_modules/@globisnv/cypress-core/scripts/check-unnecessary-waiting.mjs",
+        "lint:fix": "biome check . --write && node node_modules/@globisnv/cypress-core/scripts/check-unnecessary-waiting.mjs",
+        "typescript": "tsc --noEmit --skipLibCheck",
+        "open": "cypress open --e2e --browser chrome",
+        "record": "node ./cypress/support/record.mjs"
+    }
+}

package/template/tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "lib": ["ES2022", "dom"],
+        "types": ["cypress", "node"],
+        "strict": true,
+        "moduleResolution": "bundler",
+        "esModuleInterop": true
+    },
+    "include": ["**/*.ts", "./node_modules/@globisnv/cypress-core/dist/types.d.ts"]
+}