doc-detective-common 3.0.4-dev.2 → 3.0.4

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

@@ -1,11 +1,17 @@
-name: Run tests
+name: Test (& Publish)
 
 on:
   push:
     branches:
       - main
   pull_request:
-    types: [opened, reopened, synchronize]
+    types:
+      - opened
+      - reopened
+      - synchronize
+  release:
+    types:
+      - published
   workflow_dispatch:
 
 jobs:
@@ -13,7 +19,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: 
+        os:
           - ubuntu-latest
           - windows-latest
           - macos-latest
@@ -21,11 +27,55 @@ jobs:
           - 18
           - 20
           - 22
- 
+          - 24
+
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
           node-version: ${{ matrix.node }}
       - run: npm ci
-      - run: npm test
+      - run: npm run build  # Automatically run tests because of the `postbuild` script in package.json
+
+  publish-npm:
+    # if: github.event_name == 'release' && github.event.action == 'published'
+    name: Publish to NPM
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+          registry-url: https://registry.npmjs.org/
+      - run: echo "NODE_AUTH_TOKEN is set"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}
+      - run: npm whoami
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}
+
+  update-docs:
+    name: Update documentation
+    needs: publish-npm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get package version
+        run: echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_ENV
+
+      - name: Trigger GitHub Action in doc-detective.github.io
+        run: |
+          curl -XPOST -H "Authorization: token ${{ secrets.DOCS_PERSONAL_ACCESS_TOKEN }}" \
+               -H "Accept: application/vnd.github.everest-preview+json" \
+               "https://api.github.com/repos/doc-detective/doc-detective.github.io/dispatches" \
+               -d '{"event_type": "update-common-package-event", "client_payload": {"version": "${{ env.VERSION }}"} }'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "3.0.4-dev.2",
+  "version": "3.0.4",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
@@ -21,7 +21,7 @@
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
     "chai": "^5.2.0",
-    "mocha": "^11.2.2",
+    "mocha": "^11.4.0",
     "sinon": "^20.0.0"
   },
   "dependencies": {

package/src/schemas/dereferenceSchemas.js

@@ -67,30 +67,49 @@ async function dereferenceSchemas() {
   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));
+    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
   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));
+    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
   const schemas = {};

package/src/schemas/output_schemas/config_v3.schema.json

@@ -5324,7 +5324,7 @@
     "environment": {
       "type": "object",
       "description": "Environment information for the system running Doc Detective.",
-      "readmeOnly": true,
+      "readOnly": true,
       "additionalProperties": false,
       "required": [
         "platform"
@@ -5361,7 +5361,7 @@
       "environment": {
         "type": "object",
         "description": "Environment information for the system running Doc Detective.",
-        "readmeOnly": true,
+        "readOnly": true,
         "additionalProperties": false,
         "required": [
           "platform"

package/src/schemas/output_schemas/resolvedTests_v3.schema.json

@@ -4,7 +4,7 @@
   "description": "A collection of resolved tests ready to be performed.",
   "type": "object",
   "dynamicDefaults": {
-    "reportId": "uuid"
+    "resolvedTestsId": "uuid"
   },
   "properties": {
     "resolvedTestsId": {
@@ -5337,7 +5337,7 @@
         "environment": {
           "type": "object",
           "description": "Environment information for the system running Doc Detective.",
-          "readmeOnly": true,
+          "readOnly": true,
           "additionalProperties": false,
           "required": [
             "platform"
@@ -5374,7 +5374,7 @@
           "environment": {
             "type": "object",
             "description": "Environment information for the system running Doc Detective.",
-            "readmeOnly": true,
+            "readOnly": true,
             "additionalProperties": false,
             "required": [
               "platform"

package/src/schemas/schemas.json

@@ -5582,7 +5582,7 @@
       "environment": {
         "type": "object",
         "description": "Environment information for the system running Doc Detective.",
-        "readmeOnly": true,
+        "readOnly": true,
         "additionalProperties": false,
         "required": [
           "platform"
@@ -5619,7 +5619,7 @@
         "environment": {
           "type": "object",
           "description": "Environment information for the system running Doc Detective.",
-          "readmeOnly": true,
+          "readOnly": true,
           "additionalProperties": false,
           "required": [
             "platform"
@@ -12339,7 +12339,7 @@
     "description": "A collection of resolved tests ready to be performed.",
     "type": "object",
     "dynamicDefaults": {
-      "reportId": "uuid"
+      "resolvedTestsId": "uuid"
     },
     "properties": {
       "resolvedTestsId": {
@@ -17672,7 +17672,7 @@
           "environment": {
             "type": "object",
             "description": "Environment information for the system running Doc Detective.",
-            "readmeOnly": true,
+            "readOnly": true,
             "additionalProperties": false,
             "required": [
               "platform"
@@ -17709,7 +17709,7 @@
             "environment": {
               "type": "object",
               "description": "Environment information for the system running Doc Detective.",
-              "readmeOnly": true,
+              "readOnly": true,
               "additionalProperties": false,
               "required": [
                 "platform"

package/src/schemas/src_schemas/config_v3.schema.json

@@ -217,7 +217,7 @@
       "environment": {
         "type": "object",
         "description": "Environment information for the system running Doc Detective.",
-        "readmeOnly": true,
+        "readOnly": true,
         "additionalProperties": false,
         "required": ["platform"],
         "properties": {

package/src/schemas/src_schemas/resolvedTests_v3.schema.json

@@ -4,7 +4,7 @@
   "description": "A collection of resolved tests ready to be performed.",
   "type": "object",
   "dynamicDefaults": {
-    "reportId": "uuid"
+    "resolvedTestsId": "uuid"
   },
   "properties": {
     "resolvedTestsId": {

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

@@ -1,62 +0,0 @@
-# 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: Publish NPM package
-
-on: 
-  release:
-    types: [created]
-  workflow_dispatch:
-
-jobs:
-  test:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: 
-          - ubuntu-latest
-          - windows-latest
-          - macos-latest
-        node:
-          - 18
-          - 20
-          - 22
-    
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-      - run: npm ci      
-      - run: npm test
-
-  publish-npm:
-    name: Publish to NPM
-    needs: test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
-
-  update-docs:
-    name: Update documentation
-    needs: publish-npm
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      
-      - name: Get package version
-        run: echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_ENV
-        
-      - name: Trigger GitHub Action in doc-detective.github.io
-        run: |
-          curl -XPOST -H "Authorization: token ${{ secrets.DOCS_PERSONAL_ACCESS_TOKEN }}" \
-               -H "Accept: application/vnd.github.everest-preview+json" \
-               "https://api.github.com/repos/doc-detective/doc-detective.github.io/dispatches" \
-               -d '{"event_type": "update-common-package-event", "client_payload": {"version": "${{ env.VERSION }}"} }'