doc-detective-common 4.0.0-beta.0-dev.4 → 4.0.0-beta.0-dev.5

package/src/schemas/build/type_v3.schema.json

@@ -1,131 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "typeKeys",
-  "description": "Type keys. To type special keys, begin and end the string with `$` and use the special key's keyword. For example, to type the Escape key, enter `$ESCAPE$`.",
-  "anyOf": [
-    {
-      "$ref": "#/components/schemas/keys"
-    },
-    {
-      "$ref": "#/components/schemas/object"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "keys": {
-        "title": "Type keys (simple)",
-        "description": "Sequence of keys to enter.",
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "array",
-            "items": {
-              "anyOf": [
-                {
-                  "type": "string"
-                }
-              ]
-            }
-          }
-        ]
-      },
-      "object": {
-        "title": "Type keys (detailed)",
-        "type": "object",
-        "properties": {
-          "keys": {
-            "$ref": "#/components/schemas/keys"
-          },
-          "inputDelay": {
-            "type": "number",
-            "description": "Delay in milliseconds between each key press during a recording",
-            "default": 100
-          },
-          "selector": {
-            "type": "string",
-            "description": "Selector for the element to type into. If not specified, the typing occurs in the active element."
-          },
-          "elementText": {
-            "type": "string",
-            "description": "Display text of the element to type into. If combined with other element finding fields, the element must match all specified criteria."
-          },
-          "elementId": {
-            "type": "string",
-            "description": "ID attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax."
-          },
-          "elementTestId": {
-            "type": "string",
-            "description": "data-testid attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax."
-          },
-          "elementClass": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              }
-            ],
-            "description": "Class or array of classes that the element must have. Each class supports exact match or regex pattern using /pattern/ syntax. Element must have all specified classes."
-          },
-          "elementAttribute": {
-            "type": "object",
-            "description": "Object of attribute key-value pairs that the element must have. Values can be strings (supporting /pattern/ regex), numbers, or booleans. Boolean true matches attribute presence, false matches absence.",
-            "additionalProperties": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "number"
-                },
-                {
-                  "type": "boolean"
-                }
-              ]
-            }
-          },
-          "elementAria": {
-            "type": "string",
-            "description": "Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax."
-          }
-        },
-        "required": [
-          "keys"
-        ],
-        "additionalProperties": false
-      }
-    }
-  },
-  "examples": [
-    "kittens",
-    [
-      "$ENTER$"
-    ],
-    [
-      "kittens",
-      "$ENTER$"
-    ],
-    {
-      "keys": "kittens"
-    },
-    {
-      "keys": [
-        "$ENTER$"
-      ]
-    },
-    {
-      "keys": [
-        "kittens",
-        "$ENTER$"
-      ],
-      "inputDelay": 500
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/type_v3.schema.json"
-}

package/src/schemas/build/wait_v2.schema.json

@@ -1,42 +0,0 @@
-{
-  "title": "wait",
-  "type": "object",
-  "description": "Pause before performing the next action.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "wait",
-      "description": "The action to perform."
-    },
-    "duration": {
-      "type": "number",
-      "description": "Milliseconds to wait.",
-      "default": 5000
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": [
-    "action"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "wait"
-    },
-    {
-      "action": "wait",
-      "duration": 5000
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/wait_v2.schema.json"
-}

package/src/schemas/build/wait_v3.schema.json

@@ -1,37 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "wait",
-  "description": "Pause (in milliseconds) before performing the next action.",
-  "default": 5000,
-  "anyOf": [
-    {
-      "type": "number",
-      "title": "Wait (simple)"
-    },
-    {
-      "$ref": "#/components/schemas/string"
-    },
-    {
-      "type": "boolean",
-      "title": "Wait (boolean)"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "title": "Wait (environment variable)",
-        "type": "string",
-        "pattern": "^\\$[A-Za-z0-9_]+$",
-        "transform": [
-          "trim"
-        ]
-      }
-    }
-  },
-  "examples": [
-    5000,
-    "$WAIT_DURATION",
-    true
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/wait_v3.schema.json"
-}

package/src/schemas/dereferenceSchemas.cjs

@@ -1,208 +0,0 @@
-const parser = require("@apidevtools/json-schema-ref-parser");
-const path = require("path");
-const fs = require("fs");
-
-(async () => {
-  await dereferenceSchemas();
-})();
-
-/**
- * Processes JSON schema files by updating reference paths, dereferencing all `$ref` pointers, and generating fully resolved schema outputs.
- *
- * For each schema in the input directory, this function updates reference paths, writes intermediate schemas to a build directory, dereferences all references, removes `$id` properties, and writes the final schemas to an output directory. It also creates a consolidated `schemas.json` file containing all dereferenced schemas keyed by filename.
- *
- * @remark The function assumes all schema files listed exist in the input directory and does not handle missing files or invalid JSON beyond throwing synchronous errors.
- */
-async function dereferenceSchemas() {
-  const inputDir = path.resolve(`${__dirname}/src_schemas`);
-  const buildDir = path.resolve(`${__dirname}/build`);
-  fs.mkdirSync(buildDir, { recursive: true });
-  const outputDir = path.resolve(`${__dirname}/output_schemas`);
-  fs.mkdirSync(outputDir, { recursive: true });
-  const distDir = path.resolve(__dirname, `../../dist/schemas`);
-  fs.mkdirSync(distDir, { recursive: true });
-
-  // List of schema files to process
-  // These files should be present in the input directory
-  const files = [
-    // v3 schemas
-    "checkLink_v3.schema.json",
-    "click_v3.schema.json",
-    "config_v3.schema.json",
-    "context_v3.schema.json",
-    "dragAndDrop_v3.schema.json",
-    "find_v3.schema.json",
-    "goTo_v3.schema.json",
-    "loadCookie_v3.schema.json",
-    "loadVariables_v3.schema.json",
-    "httpRequest_v3.schema.json",
-    "openApi_v3.schema.json",
-    "record_v3.schema.json",
-    "resolvedTests_v3.schema.json",
-    "report_v3.schema.json",
-    "runCode_v3.schema.json",
-    "runShell_v3.schema.json",
-    "saveCookie_v3.schema.json",
-    "screenshot_v3.schema.json",
-    "sourceIntegration_v3.schema.json",
-    "spec_v3.schema.json",
-    "step_v3.schema.json",
-    "stopRecord_v3.schema.json",
-    "test_v3.schema.json",
-    "type_v3.schema.json",
-    "wait_v3.schema.json",
-    // v2 schemas
-    "checkLink_v2.schema.json",
-    "config_v2.schema.json",
-    "context_v2.schema.json",
-    "find_v2.schema.json",
-    "goTo_v2.schema.json",
-    "httpRequest_v2.schema.json",
-    "moveTo_v2.schema.json",
-    "openApi_v2.schema.json",
-    "runShell_v2.schema.json",
-    "runCode_v2.schema.json",
-    "saveScreenshot_v2.schema.json",
-    "setVariables_v2.schema.json",
-    "startRecording_v2.schema.json",
-    "stopRecording_v2.schema.json",
-    "spec_v2.schema.json",
-    "test_v2.schema.json",
-    "typeKeys_v2.schema.json",
-    "wait_v2.schema.json",
-  ];
-
-  // Update schema reference paths
-  console.log("Updating schema reference paths...");
-  for (const file of files) {
-    console.log(`File: ${file}`);
-    const filePath = path.resolve(`${inputDir}/${file}`);
-    const buildFilePath = path.resolve(`${buildDir}/${file}`);
-    try {
-      // Check if file exists
-      if (!fs.existsSync(filePath)) {
-        throw new Error(`File not found: ${filePath}`);
-      }
-      // Load schema
-      let schema = fs.readFileSync(filePath).toString();
-      schema = JSON.parse(schema);
-
-      // Update references to current relative path
-      schema.$id = `${filePath}`;
-      schema = updateRefPaths(schema);
-
-      // Write to build directory
-      fs.writeFileSync(buildFilePath, JSON.stringify(schema, null, 2));
-    } catch (err) {
-      console.error(`Error processing ${file}:`, err);
-    }
-  }
-
-  // Dereference schemas
-  console.log("Dereferencing schemas...");
-  for await (const file of files) {
-    console.log(`Processing file: ${file}`);
-    const filePath = path.resolve(`${buildDir}/${file}`);
-    const outputFilePath = path.resolve(`${outputDir}/${file}`);
-    try {
-      // Check if file exists
-      if (!fs.existsSync(filePath))
-        throw new Error(`File not found: ${filePath}`);
-
-      // Load schema
-      let schema = fs.readFileSync(filePath).toString();
-      schema = JSON.parse(schema);
-
-      // Dereference schema
-      schema = await parser.dereference(schema);
-      // Delete $id attributes
-      schema = deleteDollarIds(schema);
-
-      // Write to file
-      fs.writeFileSync(outputFilePath, JSON.stringify(schema, null, 2));
-    } catch (err) {
-      console.error(`Error processing ${file}:`, err);
-    }
-  }
-  // Build final schemas.json file
-  console.log("Building schemas.json file...");
-  const schemas = {};
-  for (const file of files) {
-    const key = file.replace(".schema.json", "");
-    // Load schema from file
-    const schema = require(`${outputDir}/${file}`);
-    // Load into `schema` object
-    schemas[key] = schema;
-  }
-  fs.writeFileSync(
-    `${__dirname}/schemas.json`,
-    JSON.stringify(schemas, null, 2)
-  );
-
-  // Clean up build dir
-  // fs.rm(buildDir, { recursive: true }, (err) => {
-  //   if (err) throw err;
-  // });
-
-  // Publish v3 schemas to distribution directory
-  const publishedSchemas = files.filter(file => file.includes('_v3.schema.json'));
-
-  console.log("Publishing schemas to dist/schemas directory...");
-  publishedSchemas.forEach((file) => {
-    try {
-      console.log(`Publishing file: ${file}`);
-      const srcPath = path.resolve(`${outputDir}/${file}`);
-      const destPath = path.resolve(`${distDir}/${file}`);
-
-      // Verify source file exists before copying
-      if (!fs.existsSync(srcPath)) {
-        throw new Error(`Source file not found: ${srcPath}`);
-      }
-
-      fs.copyFileSync(srcPath, destPath);
-    } catch (err) {
-      console.error(`Error publishing ${file}:`, err);
-    }
-  });
-}
-
-// Prepend app-root path to referenced relative paths
-function updateRefPaths(schema) {
-  if (schema === null || typeof schema !== "object") return 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
-      const valueFile = value.split("#")[0];
-      // Attribute path in the referenced schema
-      const valueAttribute = value.split("#")[1];
-      const valuePath = path.resolve(`${__dirname}/build/${valueFile}`);
-      schema[key] = valueAttribute !== undefined
-        ? `${valuePath}#${valueAttribute}`
-        : valuePath;
-      // console.log({value, valueFile, valueAttribute, final: schema[key]})
-    }
-  }
-  return schema;
-}
-
-/**
- * Recursively removes all `$id` properties from a JSON schema object.
- *
- * @param {object} schema - The JSON schema object to process.
- * @returns {object} The schema object with all `$id` properties deleted.
- */
-function deleteDollarIds(schema) {
-  if (schema === null || typeof schema !== "object") return schema;
-  for (let [key, value] of Object.entries(schema)) {
-    if (typeof value === "object") {
-      deleteDollarIds(value);
-    }
-    if (key === "$id") {
-      delete schema[key];
-    }
-  }
-  return schema;
-}

package/src/schemas/index.ts

@@ -1,6 +0,0 @@
-import schemasJson from "./schemas.json" with { type: "json" };
-
-export type SchemaKey = keyof typeof schemasJson;
-export type Schema = (typeof schemasJson)[SchemaKey];
-
-export const schemas: typeof schemasJson = schemasJson;