Migrate js clients (#47)

.github/workflows/js-build.yml

@@ -0,0 +1,35 @@
+name: JS (build)
+
+on:
+  push:
+    paths:
+      - 'visual-js/**'
+      - .github/workflows/js-build.yml
+  pull_request:
+    paths:
+      - 'visual-js/**'
+      - .github/workflows/js-build.yml
+
+defaults:
+  run:
+    working-directory: visual-js
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node 18
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Build with lerna
+        run: |
+          corepack enable
+          yarn install
+          npm run lint --workspaces --if-present
+          npm run build --workspaces --if-present
+          npm run test --workspaces --if-present
+        env:
+          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
+          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}

.github/workflows/js-release.yml

@@ -0,0 +1,37 @@
+name: JS (release)
+
+on:
+  workflow_dispatch: {}
+
+defaults:
+  run:
+    working-directory: visual-js
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node 18
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Setup Git
+        if: ${{ steps.prep.outputs.tag_name == '' }}
+        run: |
+          git config --global user.name "sauce-visual-bot"
+          git config --global user.email "[email protected]"
+      - name: Build
+        run: |
+          corepack enable
+          yarn install
+          npm run build --workspaces --if-present
+      - name: upgrade & publish version(s)
+        ## TODO version and publish commands need to be adjusted when we're confident with the pipeline
+        run: |
+          npx changeset version --snapshot migration
+          npx changeset publish --no-git-tag --snapshot
+      ## TODO enable the git tagging when we're confident with the pipeline
+      ##- name: Push to git
+      ##  run: |
+      ##    git push --follow-tags

visual-js/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

visual-js/.changeset/config.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": true,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "changedFilePatterns": [
+    "visual*/**",
+    "package.json"
+  ]
+}

visual-js/.changeset/mean-horses-yell.md

@@ -0,0 +1,9 @@
+---
+"@saucelabs/nightwatch-sauce-visual-service": patch
+"@saucelabs/visual-storybook": patch
+"@saucelabs/cypress-visual-plugin": patch
+"@saucelabs/wdio-sauce-visual-service": patch
+"@saucelabs/visual": patch
+---
+
+migrate source to github

visual-js/.gitignore

@@ -0,0 +1,11 @@
+node_modules
+.DS_Store
+yarn-error.log
+# https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored (not using zero install yet)
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+

visual-js/.yarnrc.yml

@@ -0,0 +1,7 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
+    spec: '@yarnpkg/plugin-version'
+
+pnpMode: loose

visual-js/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "visual-clients-workspace",
+  "private": true,
+  "workspaces": [
+    "visual",
+    "visual-storybook",
+    "visual-wdio",
+    "visual-cypress",
+    "visual-nightwatch"
+  ],
+  "lint-staged": {
+    "**/*.{js,jsx,ts,tsx}": [
+      "yarn lint"
+    ]
+  },
+  "packageManager": "[email protected]",
+  "dependencies": {
+    "@changesets/cli": "^2.27.1"
+  }
+}

visual-js/tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "./tsconfig.prod.json",
+    "compilerOptions": {
+      "inlineSourceMap": true,
+      "esModuleInterop": true
+    }
+  }

visual-js/tsconfig.prod.json

@@ -0,0 +1,28 @@
+{
+  "extends": "@tsconfig/node18/tsconfig.json",
+
+  "compilerOptions": {
+    "outDir": "./build",
+    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "resolveJsonModule": true,
+    "removeComments": false,
+    "strictFunctionTypes": false,
+    "experimentalDecorators": true,
+    "esModuleInterop": true,
+    "moduleResolution": "Node",
+    "module": "ESNext",
+    "lib": ["dom", "es2021"],
+    "types": ["node"]
+  },
+
+  "exclude": [
+    "../node_modules",
+    "__mocks__",
+    "packages/**/node_modules",
+    "coverage",
+    "examples",
+    "/*.js"
+  ]
+}

visual-js/visual-cypress/.eslintrc.cjs

@@ -0,0 +1,36 @@
+module.exports = {
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.cjs', 'build'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+
+    // Allow unused vars that start with _
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_"
+      }
+    ],
+  },
+};

visual-js/visual-cypress/.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+.work
+build/
+coverage/
+yarn.lock

visual-js/visual-cypress/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

visual-js/visual-cypress/README.md

@@ -0,0 +1,8 @@
+# Sauce Labs Visual for Cypress
+
+This package is Sauce Labs Visual integration for Cypress.<br />
+It comes as both a plugin and commands that will be made available for your tests.
+
+## Installation & Usage
+
+View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/cypress/).

visual-js/visual-cypress/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@saucelabs/cypress-visual-plugin",
+  "version": "0.3.0",
+  "description": "Cypress plugin for Sauce Visual Testing",
+  "main": "build/index.cjs",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "type": "module",
+  "license": "MIT",
+  "files": [
+    "build",
+    "README.md"
+  ],
+  "engines": {
+    "node": "^16.13 || >=18"
+  },
+  "typeScriptVersion": "5.1.6",
+  "keywords": [
+    "cypress",
+    "saucelabs",
+    "visual"
+  ],
+  "exports": {
+    ".": {
+      "require": "./build/index.cjs",
+      "import": "./build/index.js",
+      "types": "./build/index.d.ts"
+    },
+    "./commands": {
+      "require": "./build/commands.cjs",
+      "import": "./build/commands.js",
+      "types": "./build/commands.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "cypress": "^12.0.0 || ^13.0.0"
+  },
+  "dependencies": {
+    "@saucelabs/visual": "0.3.0",
+    "chalk": "^5.3.0",
+    "exponential-backoff": "^3.1.1",
+    "macos-release": "^3.2.0",
+    "node-fetch": "^3.3.1",
+    "tsup": "^7.2.0"
+  },
+  "tsup": {
+    "entry": [
+      "./src/commands.ts",
+      "./src/index.ts"
+    ],
+    "dts": true,
+    "outDir": "./build",
+    "format": [
+      "cjs",
+      "esm"
+    ],
+    "noExternal": [
+      "chalk",
+      "macos-release"
+    ]
+  },
+  "devDependencies": {
+    "@tsconfig/node18": "^2.0.1",
+    "@types/cypress": "^1.1.3",
+    "@types/node": "^20.4.4",
+    "@typescript-eslint/eslint-plugin": "^5.59.1",
+    "@typescript-eslint/parser": "^5.59.1",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^29.5.0",
+    "jest-junit-reporter": "^1.1.0",
+    "prettier": "^2.8.8",
+    "ts-node": "^10.9.1",
+    "tsc-watch": "^6.0.4",
+    "typescript": "^5.1.6"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
+    "test-ignored": "jest --collect-coverage",
+    "watch": "tsc-watch --declaration -p .",
+    "test": "node ./test-cjs.cjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}