doc-detective-common 1.2.11 → 1.3.0

package/.devcontainer/devcontainer.json

@@ -1,37 +1,37 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
-{
-  "name": "Ubuntu",
-  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-  "image": "mcr.microsoft.com/devcontainers/base:jammy",
-  "features": {
-    "ghcr.io/devcontainers/features/node:1": {}
-  },
-
-  // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
-
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
-
-  // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "npm i",
-
-  // Configure tool-specific properties.
-  "customizations": {
-    // Configure properties specific to VS Code.
-    "vscode": {
-      // Add the IDs of extensions you want installed when the container is created.
-      "extensions": [
-        "github.copilot",
-        "aaron-bond.better-comments",
-        "esbenp.prettier-vscode",
-        "GitHub.vscode-pull-request-github",
-        "streetsidesoftware.code-spell-checker"
-      ]
-    }
-  }
-
-  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-  // "remoteUser": "root"
-}
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
+{
+  "name": "Ubuntu",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/base:jammy",
+  "features": {
+    "ghcr.io/devcontainers/features/node:1": {}
+  },
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "npm i",
+
+  // Configure tool-specific properties.
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "github.copilot",
+        "aaron-bond.better-comments",
+        "esbenp.prettier-vscode",
+        "GitHub.vscode-pull-request-github",
+        "streetsidesoftware.code-spell-checker"
+      ]
+    }
+  }
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

package/.github/workflows/npm-publish.yml

@@ -1,34 +1,58 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on: 
-  release:
-    types: [created]
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on: 
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [18]
+    
+    steps:
+      - uses: actions/checkout@v3
+      
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Cache node_modules
+        uses: actions/cache@v3
+        with:
+          # Cache key uses the contents of `package-lock.json` to identify unique cache
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-node-
+          path: |
+            node_modules
+      
+      - run: npm ci
+      
+      - run: npm test
+
+  publish-npm:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - name: Cache node_modules
+        uses: actions/cache@v3
+        with:
+          # Cache key uses the contents of `package-lock.json` to identify unique cache
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-node-
+          path: |
+            node_modules
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.github/workflows/npm-test.yml

@@ -0,0 +1,44 @@
+name: Run tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: 
+         - ubuntu-latest
+         - windows-latest
+         - macos-latest
+        node:
+          - 16
+          - 18
+          - 20
+    
+    steps:
+      - uses: actions/checkout@v3
+      
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Cache node_modules
+        uses: actions/cache@v3
+        with:
+          # Cache key uses the contents of `package-lock.json` to identify unique cache
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-node-
+          path: |
+            node_modules
+      
+      - run: npm ci
+      
+      - run: npm test

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 doc-detective
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 doc-detective
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,81 +1,81 @@
-# Doc Detective Common
-
-![Current version](https://img.shields.io/github/package-json/v/doc-detective/doc-detective-common?color=orange)
-[![NPM Shield](https://img.shields.io/npm/v/doc-detective-common)](https://www.npmjs.com/package/doc-detective-common)
-[![Discord Shield](https://img.shields.io/badge/chat-on%20discord-purple)](https://discord.gg/mSCCRAhH)
-
-Shared resources for Doc Detective projects.
-
-## Install
-
-```bash
-npm i doc-detective-common
-```
-
-## Init
-
-```javascript
-const common = require("doc-detective-common");
-```
-
-## Methods
-
-### `.validate(schemaKey: string, object: object)`
-
-Validate that `object` matches the specified [schema](#.schemas) definition.
-
-Returns an object with the following schema:
-
-```json
-{
-  "valid": boolean,
-  "errors": [
-    {
-      "instancePath": string,
-      "schemaPath": string,
-      "keyword": string,
-      "params": [{Object}],
-      "message": string
-    }
-  ]
-}
-```
-
-#### Usage
-
-```js
-const schemaKey = "runShell_v1";
-const object = {
-  action: "runShell",
-  command: "echo $username",
-};
-console.log(common.validate(schemaKey, object));
-```
-
-## Objects
-
-### `.schemas`
-
-JSON schema definitions for various objects used throughout Doc Detective.
-
-Schema objects are located in the [`/schemas`](https://github.com/doc-detective/doc-detective-common/tree/schema/schemas) directory and made available through the `.schemas` object.
-
-```json
-{
-  "analytics_v1": {Object},
-  "checkLink_v1": {Object},
-  "click_v1": {Object},
-  "find_v1": {Object},
-  "goTo_v1": {Object},
-  "httpRequest_v1": {Object},
-  "matchText_v1": {Object},
-  "moveMouse_v1": {Object},
-  "runShell_v1": {Object},
-  "screenshot_v1": {Object},
-  "scroll_v1": {Object},
-  "startRecording_v1": {Object},
-  "stopRecording_v1": {Object},
-  "type_v1": {Object},
-  "wait_v1": {Object}
-}
-```
+# Doc Detective Common
+
+![Current version](https://img.shields.io/github/package-json/v/doc-detective/doc-detective-common?color=orange)
+[![NPM Shield](https://img.shields.io/npm/v/doc-detective-common)](https://www.npmjs.com/package/doc-detective-common)
+[![Discord Shield](https://img.shields.io/badge/chat-on%20discord-purple)](https://discord.gg/mSCCRAhH)
+
+Shared resources for Doc Detective projects.
+
+## Install
+
+```bash
+npm i doc-detective-common
+```
+
+## Init
+
+```javascript
+const common = require("doc-detective-common");
+```
+
+## Methods
+
+### `.validate(schemaKey: string, object: object)`
+
+Validate that `object` matches the specified [schema](#.schemas) definition.
+
+Returns an object with the following schema:
+
+```json
+{
+  "valid": boolean,
+  "errors": [
+    {
+      "instancePath": string,
+      "schemaPath": string,
+      "keyword": string,
+      "params": [{Object}],
+      "message": string
+    }
+  ]
+}
+```
+
+#### Usage
+
+```js
+const schemaKey = "runShell_v1";
+const object = {
+  action: "runShell",
+  command: "echo $username",
+};
+console.log(common.validate(schemaKey, object));
+```
+
+## Objects
+
+### `.schemas`
+
+JSON schema definitions for various objects used throughout Doc Detective.
+
+Schema objects are located in the [`/schemas`](https://github.com/doc-detective/doc-detective-common/tree/schema/schemas) directory and made available through the `.schemas` object.
+
+```json
+{
+  "analytics_v1": {Object},
+  "checkLink_v1": {Object},
+  "click_v1": {Object},
+  "find_v1": {Object},
+  "goTo_v1": {Object},
+  "httpRequest_v1": {Object},
+  "matchText_v1": {Object},
+  "moveMouse_v1": {Object},
+  "runShell_v1": {Object},
+  "screenshot_v1": {Object},
+  "scroll_v1": {Object},
+  "startRecording_v1": {Object},
+  "stopRecording_v1": {Object},
+  "type_v1": {Object},
+  "wait_v1": {Object}
+}
+```

package/dev/dev.js

@@ -1,3 +1,3 @@
-const { validate, schemas } = require("../src/index");
-
+const { validate, schemas } = require("../src/index");
+
 console.log(validate("find_v2",schemas.find_v2.examples[0]))

package/package.json

@@ -1,33 +1,34 @@
-{
-  "name": "doc-detective-common",
-  "version": "1.2.11",
-  "description": "Shared components for Doc Detective projects.",
-  "main": "src/index.js",
-  "scripts": {
-    "dereferenceSchemas": "node ./src/schemas/dereferenceSchemas.js",
-    "test": "npm run dereferenceSchemas && jest"
-  },
-  "precommit": "test",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/doc-detective/doc-detective-common.git"
-  },
-  "author": "Manny Silva",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/doc-detective/doc-detective-common/issues"
-  },
-  "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
-  "devDependencies": {
-    "jest": "^29.4.1"
-  },
-  "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^10.1.0",
-    "ajv": "^8.12.0",
-    "ajv-errors": "^3.0.0",
-    "ajv-formats": "^2.1.1",
-    "ajv-keywords": "^5.1.0",
-    "pre-commit": "^1.2.2",
-    "uuid": "^9.0.0"
-  }
-}
+{
+  "name": "doc-detective-common",
+  "version": "1.3.0",
+  "description": "Shared components for Doc Detective projects. ",
+  "main": "src/index.js",
+  "scripts": {
+    "dereferenceSchemas": "node ./src/schemas/dereferenceSchemas.js",
+    "test:full": "npm run dereferenceSchemas && jest",
+    "test": "jest"
+  },
+  "precommit": "test:full",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/doc-detective/doc-detective-common.git"
+  },
+  "author": "Manny Silva",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/doc-detective/doc-detective-common/issues"
+  },
+  "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
+  "devDependencies": {
+    "jest": "^29.6.4"
+  },
+  "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^10.1.0",
+    "ajv": "^8.12.0",
+    "ajv-errors": "^3.0.0",
+    "ajv-formats": "^2.1.1",
+    "ajv-keywords": "^5.1.0",
+    "pre-commit": "^1.2.2",
+    "uuid": "^9.0.0"
+  }
+}

package/src/index.js

@@ -1,5 +1,5 @@
-const { schemas } = require("./schemas");
-const { validate } = require("./validate");
-
-exports.schemas = schemas;
+const { schemas } = require("./schemas");
+const { validate } = require("./validate");
+
+exports.schemas = schemas;
 exports.validate = validate;

package/src/schemas/dereferenceSchemas.js

@@ -1,48 +1,100 @@
-const parser = require("@apidevtools/json-schema-ref-parser");
-const path = require("path");
-const fs = require("fs");
-const { exit } = require("process");
-
-(async () => {
-  await dereferenceSchemas();
-})();
-
-/*
- * Walks through all schema in src/src_schema
- * For each schema, dereferences it and writes it to src/schema
- */
-async function dereferenceSchemas() {
-  const inputDir = path.resolve(`${__dirname}/src_schemas`);
-  const outputDir = path.resolve(`${__dirname}/output_schemas`);
-  const files = fs.readdirSync(inputDir);
-  for await (const file of files) {
-    const filePath = path.resolve(`${inputDir}/${file}`);
-    // Load from file
-    let schema = fs.readFileSync(filePath).toString();
-    // Convert to JSON
-    schema = JSON.parse(schema);
-    // Set ID
-    schema.$id = `${filePath}`;
-    // Update references to current relative path
-    schema = updateRefPaths(schema, inputDir);
-    // Dereference schema
-    schema = await parser.dereference(schema);
-    // Delete ID
-    delete schema.$id
-    // Write to file
-    fs.writeFileSync(`${outputDir}/${file}`, JSON.stringify(schema, null, 2));
-  }
-}
-
-// Prepend app-root path to referenced relative paths
-function updateRefPaths(schema) {
-  for (let [key, value] of Object.entries(schema)) {
-    if (typeof value === "object") {
-      updateRefPaths(value);
-    }
-    if (key === "$ref") {
-      schema[key] = path.resolve(`${__dirname}/src_schemas/${value}`);
-    }
-  }
-  return schema;
-}
+const parser = require("@apidevtools/json-schema-ref-parser");
+const path = require("path");
+const fs = require("fs");
+
+(async () => {
+  await dereferenceSchemas();
+})();
+
+/*
+ * Walks through all schema in src/src_schema
+ * For each schema, dereferences it and writes it to src/schema
+ */
+async function dereferenceSchemas() {
+  const inputDir = path.resolve(`${__dirname}/src_schemas`);
+  const buildDir = path.resolve(`${__dirname}/build`);
+  fs.mkdir(buildDir, { recursive: true }, (err) => {
+    if (err) throw err;
+  });
+  const outputDir = path.resolve(`${__dirname}/output_schemas`);
+  var files = [
+    "checkLink_v2.schema.json",
+    "config_v2.schema.json",
+    "context_v2.schema.json",
+    "find_v2.schema.json",
+    "goTo_v2.schema.json",
+    "httpRequest_v2.schema.json",
+    "runShell_v2.schema.json",
+    "saveScreenshot_v2.schema.json",
+    "setVariables_v2.schema.json",
+    "spec_v2.schema.json",
+    "test_v2.schema.json",
+    "typeKeys_v2.schema.json",
+    "wait_v2.schema.json",
+  ];
+  // Update schema reference paths
+  for (const file of files) {
+    // console.log(`File: ${file}`)
+    const filePath = path.resolve(`${inputDir}/${file}`);
+    // Load from file
+    let schema = fs.readFileSync(filePath).toString();
+    // Convert to JSON
+    schema = JSON.parse(schema);
+    // Set ID
+    schema.$id = `${filePath}`;
+    // Update references to current relative path
+    schema = updateRefPaths(schema);
+    // Write to file
+    fs.writeFileSync(`${buildDir}/${file}`, JSON.stringify(schema, null, 2));
+  }
+  // Dereference schemas
+  for await (const file of files) {
+    const filePath = path.resolve(`${buildDir}/${file}`);
+    // Load from file
+    let schema = fs.readFileSync(filePath).toString();
+    // Convert to JSON
+    schema = JSON.parse(schema);
+    // Dereference schema
+    schema = await parser.dereference(schema);
+    // Delete $id attributes
+    schema = deleteDollarIds(schema);
+    // Write to file
+    fs.writeFileSync(`${outputDir}/${file}`, JSON.stringify(schema, null, 2));
+  }
+  // Clean up build dir
+  // fs.rm(buildDir, { recursive: true }, (err) => {
+  //   if (err) throw err;
+  // });
+}
+
+// Prepend app-root path to referenced relative paths
+function updateRefPaths(schema) {
+  for (let [key, value] of Object.entries(schema)) {
+    if (typeof value === "object") {
+      updateRefPaths(value);
+    }
+    if (key === "$ref" && !value.startsWith("#")) {
+      // File name of the referenced schema
+      valueFile = value.split("#")[0];
+      // Attribute path in the referenced schema
+      valueAttribute = value.split("#")[1];
+      valuePath = path.resolve(`${__dirname}/build/${valueFile}`);
+      schema[key] = `${valuePath}#${valueAttribute}`;
+      // console.log({value, valueFile, valueAttribute, final: schema[key]})
+    }
+  }
+  return schema;
+}
+
+// Prepend app-root path to referenced relative paths
+function deleteDollarIds(schema) {
+  for (let [key, value] of Object.entries(schema)) {
+    if (typeof value === "object") {
+      deleteDollarIds(value);
+    }
+    if (key === "$id") {
+      delete schema[key]
+    }
+  }
+  return schema;
+}