@uuv/assistant 1.3.0

package/dist/README.md

@@ -0,0 +1,59 @@
+
+
+
+# @uuv/assistant
+<p align="center">  
+<a href="https://e2e-test-quest.github.io/uuv/">  
+<picture>  
+<img alt="UUV Logo" src="../docs/static/img/uuv.png">  
+</picture>  
+</a>  
+</p>  
+<p align="center">  
+<a href="https://e2e-test-quest.github.io/uuv/"><img src="https://img.shields.io/badge/documentation-black?&style=for-the-badge&logo=github&logoColor=white" alt="documentation"/></a>  
+</p> 
+
+<h3 align="center">  
+Test as final user  
+</h3>  
+
+<p align="center">  
+Make test writing fast, understandable by any human understanding English or French.  
+</p>  
+
+<p align="center">  
+<a href="https://www.npmjs.com/package/@uuv/assistant">  
+<img src="https://img.shields.io/badge/available%20on%20npm-grey?logo=npm" alt="npm"/>  
+</a>  
+<a href="https://www.npmjs.com/package/@uuv/assistant">  
+<img src="https://img.shields.io/badge/using-react-00DCFF?logo=react" alt="npm"/>  
+</a>  
+<a href="https://jestjs.io/fr/">  
+<img src="https://img.shields.io/badge/tested%20with-jest-yellow?logo=jest" alt="jest"/>  
+</a><br />  
+</p>  
+
+## What is UUV wizard?
+
+<p align="center">  
+
+`@uuv` library (User centric Usecases Validator) is an ecosystem that simplifies the writing of End to End tests in a BDD approach and a user-centric way.
+
+With this wizard, we can generate cucumber sentences that will use an execution engine like cypress with [@uuv/cypress](https://www.npmjs.com/package/@uuv/cypress) or playwright with [@uuv/playwright](https://www.npmjs.com/package/@uuv/playwright).
+</p>  
+
+<img src="./public/screenshots.gif" alt="assistant screenshots"/>  
+
+## Installing
+
+<a href="https://e2e-test-quest.github.io/uuv/docs/tools/uuv-assistant"><img src="https://img.shields.io/badge/run%20uuv%20wizard%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for run uuv wizard"/></a>
+
+<a href="https://e2e-test-quest.github.io/uuv/docs/wordings/generated-wording-description/en-generated-wording-description"><img src="https://img.shields.io/badge/sentences%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation containing sentences"/></a>
+
+## License
+
+[<a href="https://www.npmjs.com/package/@uuv/cypress">  
+<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="npm"/>  
+</a>](https://www.apache.org/licenses/LICENSE-2.0)
+
+This project is licensed under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).

package/dist/launcher/conf.json

@@ -0,0 +1,4 @@
+{
+  "reactScript": "/../../build/uuv/static/js/main.e5e49be0.js",
+  "cssFile": "/../../build/uuv/static/css/main.a63bc536.css"
+}

package/dist/launcher/index.d.ts

@@ -0,0 +1 @@
+export * from './uuv-assistant';

package/dist/launcher/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./uuv-assistant"), exports);

package/dist/launcher/uuv-assistant-launcher.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/launcher/uuv-assistant-launcher.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+console.log('UUV Assistant starting...');
+new index_1.UuvAssistant().start().then(() => {
+    console.log('UUV Assistant started');
+});

package/dist/launcher/uuv-assistant.d.ts

@@ -0,0 +1,4 @@
+export declare class UuvAssistant {
+    private initReactDomRootElementFn;
+    start(translatorFn?: (el: HTMLElement) => string): Promise<void>;
+}

package/dist/launcher/uuv-assistant.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UuvAssistant = void 0;
+let translator;
+class UuvAssistant {
+    initReactDomRootElementFn() {
+        return () => {
+            document.addEventListener("DOMContentLoaded", () => {
+                const rootElement = document.createElement("div");
+                const event = translator !== undefined ? new CustomEvent("UUVAssistantReadyToLoad", {
+                    detail: {
+                        translator: translator
+                    }
+                }) : new Event("UUVAssistantReadyToLoad");
+                rootElement.id = "uvv-assistant-root";
+                document.body.appendChild(rootElement);
+                document.dispatchEvent(event);
+            });
+        };
+    }
+    async start(translatorFn) {
+        const { chromium } = require("playwright-chromium");
+        const argv = require("minimist")(process.argv.slice(2));
+        const conf = require("./conf.json");
+        const browser = await chromium.launch({ headless: false });
+        const browserContext = await browser.newContext();
+        const page = await browserContext.newPage();
+        const translatorDeclaration = translatorFn ?
+            `var translator = ${translatorFn.toString()}; console.log('translator'); console.log(translator);` :
+            "var translator = null;";
+        await browserContext.addInitScript({
+            content: translatorDeclaration
+        });
+        await browserContext.addInitScript(this.initReactDomRootElementFn());
+        await browserContext.addInitScript({
+            path: `${__dirname}${conf.reactScript}`
+        });
+        await page.goto(argv.targetUrl);
+        await page.addStyleTag({
+            path: `${__dirname}${conf.cssFile}`
+        });
+    }
+}
+exports.UuvAssistant = UuvAssistant;

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@uuv/assistant",
+  "version": "1.3.0",
+  "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
+  "description": "UUV wizard used to improve the life of testers and developers by generating cucumber phrases from the GUI.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/e2e-test-quest/uuv"
+  },
+  "homepage": "https://e2e-test-quest.github.io/uuv/",
+  "keywords": [
+    "uuv",
+    "UUV",
+    "E2E",
+    "test",
+    "testing",
+    "cypress",
+    "testing-library",
+    "accessibility",
+    "accessibilité",
+    "a11y",
+    "cucumber",
+    "playwright",
+    "gherkin"
+  ],
+  "bin": {
+    "uuv-assistant": "./dist/launcher/uuv-assistant-launcher.js"
+  },
+  "scripts": {
+    "react:start": "react-scripts start",
+    "react:build": "react-scripts build",
+    "react:test": "react-scripts test",
+    "react:eject": "react-scripts eject",
+    "launch": "ts-node launcher/uuv-assistant-launcher.ts",
+    "launch:custom": "ts-node tests/uuv-assistant-custom-launcher.ts",
+    "conf:build": "node compute-conf.js",
+    "package": "npm pack --pack-destination=\"../../dist/packages\"",
+    "copy:sentences": "ts-node copy-sentences.ts",
+    "uuv": "node node_modules/@uuv/playwright/bin/uuv"
+  },
+  "dependencies": {
+    "@cucumber/cucumber": "9.1.0",
+    "antd": "^5.4.6",
+    "playwright-chromium": "1.33.0"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@ant-design/icons": "^5.0.1",
+    "@testing-library/jest-dom": "5.16.5",
+    "@testing-library/react": "12.1.5",
+    "@testing-library/user-event": "14.4.3",
+    "@types/jest": "29.5.1",
+    "@types/jquery": "3.5.16",
+    "@types/node": "16.18.25",
+    "@types/react": "17.0.58",
+    "@types/react-dom": "17.0.20",
+    "@types/styled-components": "5.1.26",
+    "@types/testing-library__jest-dom": "5.14.5",
+    "@typescript-eslint/eslint-plugin": "5.59.1",
+    "@typescript-eslint/parser": "5.59.1",
+    "dom-accessibility-api": "0.5.16",
+    "eslint": "8.39.0",
+    "eslint-plugin-react": "7.32.2",
+    "inspector-dom": "0.1.1",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
+    "minimist": "1.2.8",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "react-scripts": "^5.0.1",
+    "replace-json-property": "1.8.0",
+    "styled-components": "5.3.10",
+    "ts-jest": "29.1.0",
+    "ts-loader": "^9.4.2",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.5",
+    "web-vitals": "3.3.1"
+  },
+  "files": [
+    "dist/launcher/**/*",
+    "build/static/css/**/*.css",
+    "build/static/js/main.*.js",
+    "postinstall.js",
+    "target-config/**/*",
+    "public/en*.json"
+  ]
+}