Version 2

.github/workflows/deploy.yml

@@ -0,0 +1,41 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - name: Install dependencies
+        run: npm install
+      - name: Build browser bundle
+        run: npm run build
+      - name: Prepare deployment directory
+        run: |
+          mkdir -p deploy/dist
+          cp website/* deploy/
+          cp dist/* deploy/dist/
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: deploy
+          user_name: 'moreGeo CI'
+          user_email: [email protected]
+          cname: check-stac.moregeo.it
+

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm test
+      - name: Build browser bundle
+        run: npm run build
+      - name: Publish to npm
+        run: npm publish --provenance --tag latest
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yaml

@@ -1,34 +1,42 @@
+name: Tests
+
 on:
   push:
     branches:
       - master
   pull_request:
-    types: [opened, synchronize]
+    types:
+      - opened
+      - synchronize
 
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        runner: [
-          'macos-11',
-          'macos-12',
-          'macos-13',
-          'macos-latest',
-          'ubuntu-20.04',
-          'ubuntu-22.04',
-          'ubuntu-latest',
-          'windows-2019',
-          'windows-2022',
-          'windows-latest',
-        ]
-        node: [ '16', '18', '20', '22', 'lts/*' ]
+        runner:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        node:
+          - '20'
+          - '22'
+          - '23'
+          - '24'
+          - 'lts/*'
     runs-on: ${{ matrix.runner }}
     name: ${{ matrix.runner }} runner with Node.js ${{ matrix.node }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - run: npm install
-      - run: npm test
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm test
+      - name: Build browser bundle
+        run: npm run build
+

.gitignore

@@ -14,3 +14,6 @@ Thumbs.db
 .npm
 /node_modules/
 /package-lock.json
+
+# Build artifacts
+/dist/

README.md

@@ -6,26 +6,33 @@ See the [STAC Validator Comparison](COMPARISON.md) for the features supported by
 
 ## Versions
 
-**Current version:** 1.3.2
+**Current version:** 2.0.0-rc.1
 
 | STAC Node Validator Version | Supported STAC Versions |
 | --------------------------- | ----------------------- |
-| 1.1.0 / 1.2.x               | >= 1.0.0-rc.1           |
+| 1.1.0 / 1.2.x / 2.x.x       | >= 1.0.0-rc.1           |
 | 0.4.x / 1.0.x               | >= 1.0.0-beta.2 and < 1.0.0-rc.3 |
 | 0.3.0                       | 1.0.0-beta.2            |
 | 0.2.1                       | 1.0.0-beta.1            |
 
 ## Quick Start
 
-1. Install a recent version of [node and npm](https://nodejs.org)
+Two options:
+
+1. Go to [check-stac.moregeo.it](https://check-stac.moregeo.it) for an online validator.
 2. `npx stac-node-validator /path/to/your/file-or-folder` to temporarily install the library and validate the provided file for folder. See the chapters below for advanced usage options.
 
-## Setup
+## Usage
 
-1. Install [node and npm](https://nodejs.org) - should run with any version >= 16. Older versions may still work, but no guarantee.
-2. `npm install -g stac-node-validator` to install the library permanently
+### CLI
 
-## Usage
+Install a recent version of [node](https://nodejs.org) (>= 22.1.0) and npm.
+
+Then install the CLI on your computer:
+
+```bash
+npm install -g stac-node-validator
+```
 
 - Validate a single file: `stac-node-validator /path/to/your/file.json`
 - Validate multiple files: `stac-node-validator /path/to/your/catalog.json /path/to/your/item.json`
@@ -44,51 +51,144 @@ Further options to add to the commands above:
 - Add `--strict` to enable strict mode in validation for schemas and numbers (as defined by [ajv](https://ajv.js.org/strict-mode.html) for options `strictSchema`, `strictNumbers` and `strictTuples`)
 - To lint local JSON files: `--lint` (add `--verbose` to get a diff with the changes required)
 - To format / pretty-print local JSON files: `--format` (Attention: this will override the source files without warning!)
+- To run custom validation code: `--custom ./path/to/validation.js` - The validation.js needs to contain a class that implements the `BaseValidator` interface. See [custom.example.js](./custom.example.js) for an example.
 
 **Note on API support:** Validating lists of STAC items/collections (i.e. `GET /collections` and `GET /collections/:id/items`) is partially supported.
 It only checks the contained items/collections, but not the other parts of the response (e.g. `links`).
 
-### Config file
-
 You can also pass a config file via the `--config` option. Simply pass a file path as value.
-Parameters set via CLI will override the corresponding setting in the config file.
-Make sure to use the value `false` to override boolean flags that are set to `true` in the config file.
+Parameters set via CLI will not override the corresponding setting in the config file.
 
 The config file uses the same option names as above.
 To specify the files to be validated, add an array with paths.
 The schema map is an object instead of string separated with a `=` character.
 
-**Example:**
-```json
+### Programmatic
+
+You can also use the validator programmatically in your JavaScript/NodeJS applications.
+
+Install it into an existing project:
+
+```bash
+npm install stac-node-validator
+```
+
+#### For browsers
+
+Then in your code, you can for example do the following:
+
+```javascript
+const validate = require('stac-node-validator');
+
+// Add any options, e.g. strict mode
+const config = {
+  strict: true
+};
+
+// Validate a STAC file from a URL
+const result = await validate('https://example.com/catalog.json', config);
+
+// Check if validation passed
+if (result.valid) {
+  console.log('STAC file is valid!');
+} else {
+  console.log('STAC file has errors:');
+}
+```
+
+#### For NodeJS
+
+```javascript
+const validate = require('stac-node-validator');
+const nodeLoader = require('stac-node-validator/src/loader/node');
+
+// Add any options
+const config = {
+  loader: nodeLoader
+};
+
+// Validate a STAC file from a URL
+const result = await validate('https://example.com/catalog.json', config);
+
+// Check if validation passed
+if (result.valid) {
+  console.log('STAC file is valid!');
+} else {
+  console.log('STAC file has errors:');
+}
+```
+
+#### Validation Results
+
+The `validate` function returns a `Report` object with the following structure:
+
+```javascript
 {
-  "files": [
-    "/path/to/your/catalog.json",
-    "/path/to/your/item.json"
-  ],
-  "schemas": "/path/to/stac/folder",
-  "schemaMap": {
-    "https://stac-extensions.github.io/foobar/v1.0.0/schema.json": "./json-schema/schema.json"
+  id: "catalog.json",	// File path or STAC ID
+  type: "Catalog",		// STAC type (Catalog, Collection, Feature)
+  version: "1.0.0",		// STAC version
+  valid: true,			// Overall validation result
+  skipped: false,		// Whether validation was skipped
+  messages: [],			// Info/warning messages
+  children: [],			// Child reports for collections/API responses
+  results: {
+    core: [],			// Core schema validation errors
+    extensions: {},		// Extension validation errors (by schema URL)
+    custom: []			// Custom validation errors
   },
-  "ignoreCerts": false,
-  "verbose": false,
-  "lint": true,
-  "format": false,
-  "strict": true,
-	"all": false
+  apiList: false		// Whether this is an API collection response
 }
 ```
 
-You could now override some options as follows in CLI: `stac-node-validator example.json --config /path/to/config.json --lint false`
+### Browser
+
+The validator is also available as a browser bundle for client-side validation.
+
+#### CDN Usage
+
+```html
+<!-- Include axios for HTTP requests -->
+<script src="https://cdn.jsdelivr.net/npm/axios@1/dist/axios.min.js"></script>
+<!-- Include the STAC validator bundle -->
+<script src="https://cdn.jsdelivr.net/npm/stac-node-validator@2/dist/index.js"></script>
+
+<script>
+// The validator is available as a global 'validate' function
+async function validateSTAC() {
+  const stacData = {
+    "stac_version": "1.0.0",
+    "type": "Catalog",
+    "id": "my-catalog",
+    "description": "A sample catalog",
+    "links": []
+  };
+
+  const result = await validate(stacData);
+
+  if (result.valid) {
+    console.log('STAC is valid!');
+  } else {
+    console.log('Validation errors:', result.results.core);
+  }
+}
+
+validateSTAC();
+</script>
+```
 
-### Development
+## Development
 
-1. `git clone https://github.com/stac-utils/stac-node-validator` to clone the repo
+1. `git clone https://github.com/moregeo-it/stac-node-validator` to clone the repo
 2. `cd stac-node-validator` to switch into the new folder created by git
 3. `npm install` to install dependencies
 4. Run the commands as above, but replace `stac-node-validator` with `node bin/cli.js`, for example `node bin/cli.js /path/to/your/file.json`
 
-### Test
+### Tests
 
 Simply run `npm test` in a working [development environment](#development).
 
-If you want to disable tests for your fork of the repository, simply delete `.github/workflows/test.yaml`.
+### Browser Bundle
+
+To work on the browser bundle build it: `npm run build`
+
+Then you can import it from the `dist` folder.

bin/cli.js

@@ -1,2 +1,3 @@
 #!/usr/bin/env node
-require('../index.js')()
+const runCLI = require('../src/cli.js');
+runCLI();