regressify 1.0.0

package/.engine_scripts/test-schema.json

@@ -0,0 +1,629 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$ref": "#/definitions/TestSuite",
+  "definitions": {
+    "TestSuite": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "useCssOverride": {
+          "type": "boolean"
+        },
+        "urlReplacements": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/UrlReplacements"
+          }
+        },
+        "cssOverridePath": {
+          "type": "string"
+        },
+        "hideSelectors": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "removeSelectors": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "viewportNames": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "scenarios": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TesScenario"
+          }
+        },
+        "debug": {
+          "type": "boolean"
+        },
+        "asyncCaptureLimit": {
+          "type": "number"
+        },
+        "asyncCompareLimit": {
+          "type": "number"
+        },
+        "browser": {
+          "type": "string",
+          "oneOf": [
+            {
+              "enum": [
+                "chromium",
+                "firefox",
+                "webkit"
+              ]
+            }
+          ]
+        },
+        "misMatchThreshold": {
+          "type": "number"
+        },
+        "postInteractionWait": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "scenarios"
+      ],
+      "title": "TestSuite"
+    },
+    "TesScenario": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "url": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "delay": {
+          "type": "number"
+        },
+        "useCssOverride": {
+          "type": "boolean"
+        },
+        "cssOverridePath": {
+          "type": "string"
+        },
+        "cookiePath": {
+          "type": "string"
+        },
+        "jsOnReadyPath": {
+          "type": "string"
+        },
+        "hideSelectors": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "removeSelectors": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "clickSelector": {
+          "type": "string"
+        },
+        "viewportNames": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "id": {
+          "type": "string"
+        },
+        "needs": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "noScrollTop": {
+          "type": "boolean"
+        },
+        "actions": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {
+                "$ref": "#/definitions/CheckAction"
+              },
+              {
+                "$ref": "#/definitions/ClickAction"
+              },
+              {
+                "$ref": "#/definitions/HideAction"
+              },
+              {
+                "$ref": "#/definitions/HoverAction"
+              },
+              {
+                "$ref": "#/definitions/InputAction"
+              },
+              {
+                "$ref": "#/definitions/InputFileAction"
+              },
+              {
+                "$ref": "#/definitions/PressAction"
+              },
+              {
+                "$ref": "#/definitions/RemoveAction"
+              },
+              {
+                "$ref": "#/definitions/ScrollAction"
+              },
+              {
+                "$ref": "#/definitions/SelectByLabelAction"
+              },
+              {
+                "$ref": "#/definitions/SelectByValueAction"
+              },
+              {
+                "$ref": "#/definitions/UncheckAction"
+              },
+              {
+                "$ref": "#/definitions/WaitAction"
+              }
+            ]
+          },
+          "title": "Actions",
+          "description": "Documentation: https://tuyen.blog/optimizely-cms/testing/create-action/"
+        },
+        "misMatchThreshold": {
+          "type": "number"
+        },
+        "postInteractionWait": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "url"
+      ],
+      "title": "URL"
+    },
+    "UrlReplacements": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "ref": {
+          "type": "string",
+          "format": "uri",
+          "qt-uri-protocols": [
+            "https"
+          ]
+        },
+        "test": {
+          "type": "string",
+          "format": "uri",
+          "qt-uri-protocols": [
+            "https"
+          ]
+        }
+      },
+      "required": [
+        "ref",
+        "test"
+      ],
+      "title": "URL Replacements"
+    },
+    "CheckAction": {
+      "type": "object",
+      "description": "Documentation: https://tuyen.blog/optimizely-cms/testing/create-action/#spoiler--check",
+      "additionalProperties": false,
+      "properties": {
+        "check": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      }
+    },
+    "ClickAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "click": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      }
+    },
+    "HideAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "hide": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "hide"
+      ]
+    },
+    "HoverAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "hover": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "hover"
+      ]
+    },
+    "InputAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "input": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        },
+        "append": {
+          "type": "boolean"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "input",
+        "value"
+      ]
+    },
+    "InputFileAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "input": {
+          "type": "string"
+        },
+        "file": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "useFileChooser": {
+          "type": "boolean"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "input",
+        "file"
+      ]
+    },
+    "PressAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "press": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "press",
+        "key"
+      ]
+    },
+    "RemoveAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "remove": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "remove"
+      ]
+    },
+    "ScrollAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "scroll": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "scroll"
+      ]
+    },
+    "SelectByValueAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "select": {
+          "type": "string"
+        },
+        "value": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "select",
+        "value"
+      ]
+    },
+    "SelectByLabelAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "select": {
+          "type": "string"
+        },
+        "label": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "select",
+        "label"
+      ]
+    },
+    "UncheckAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "uncheck": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      }
+    },
+    "WaitAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "wait": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            }
+          ]
+        },
+        "url": {
+          "type": "string"
+        },
+        "frame": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "wait"
+      ]
+    }
+  }
+}

package/.eslintrc.cjs

@@ -0,0 +1,23 @@
+module.exports = {
+  env: { browser: true, es2020: true },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:react-hooks/recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': 'warn',
+    '@typescript-eslint/member-delimiter-style': [
+      'error',
+      {
+        multiline: {
+          delimiter: 'semi',
+          requireLast: true,
+        },
+        singleline: {
+          delimiter: 'semi',
+          requireLast: false,
+        },
+      },
+    ],
+  },
+};

package/.github/workflows/deploy.yml

@@ -0,0 +1,37 @@
+name: Regression test Deploy
+
+on:
+  push:
+    branches:
+      - release
+    paths:
+      - src/**
+      - .engine_scripts/**
+
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.nvmrc

@@ -0,0 +1 @@
+v18

package/.prettierignore

@@ -0,0 +1,2 @@
+/public
+/.backstop

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "proseWrap": "never",
+  "printWidth": 150,
+  "singleQuote": true
+}

package/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  trailingComma: 'es5',
+  tabWidth: 2,
+  proseWrap: 'never',
+  printWidth: 150,
+  singleQuote: true,
+  semi: true
+}