Update README, v2.0.0-rc.1

Author: m-mohr

.github/workflows/deploy.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - master
-      - v2
 
 # 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.

.github/workflows/release.yml

@@ -2,25 +2,30 @@ name: Release
 
 on:
   release:
-    types: [published]
+    types:
+      - published
 
 jobs:
   build-and-release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
+          # see https://github.com/npm/cli/issues/6184
+          registry-url: 'https://registry.npmjs.org'
       - 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
+        run: npm publish --provenance --tag latest
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+

README.md

@@ -6,7 +6,7 @@ See the [STAC Validator Comparison](COMPARISON.md) for the features supported by
 
 ## Versions
 
-**Current version:** 2.0.0-beta.18
+**Current version:** 2.0.0-rc.1
 
 | STAC Node Validator Version | Supported STAC Versions |
 | --------------------------- | ----------------------- |
@@ -17,15 +17,22 @@ See the [STAC Validator Comparison](COMPARISON.md) for the features supported by
 
 ## 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 >= 22.1.0.
-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`
@@ -49,136 +56,139 @@ Further options to add to the commands above:
 **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`).
 
-## Browser Usage
+You can also pass a config file via the `--config` option. Simply pass a file path as value.
+Parameters set via CLI will not override the corresponding setting in the config file.
 
-The validator is also available as a browser bundle that can be used directly in web browsers without Node.js.
+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.
 
-### Installation
+### Programmatic
 
-#### CDN (Recommended)
+You can also use the validator programmatically in your JavaScript/NodeJS applications.
 
-```html
-<script src="https://github.com/moregeo-it/stac-node-validator/releases/latest/download/index.js"></script>
+Install it into an existing project:
+
+```bash
+npm install stac-node-validator
 ```
 
-#### Download
+#### For browsers
 
-Download the `index.js` file from the [latest release](https://github.com/moregeo-it/stac-node-validator/releases/latest) and include it in your HTML:
+Then in your code, you can for example do the following:
 
-```html
-<script src="./path/to/index.js"></script>
+```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:');
+}
 ```
 
-### Browser Usage Example
+#### For NodeJS
 
-```html
-<!DOCTYPE html>
-<html>
-<head>
-    <script src="https://github.com/moregeo-it/stac-node-validator/releases/latest/download/index.js"></script>
-</head>
-<body>
-    <script>
-        // Create validator instance
-        const validator = new STACValidator();
-        
-        // Example STAC catalog
-        const stacCatalog = {
-            "stac_version": "1.0.0",
-            "type": "Catalog",
-            "id": "example-catalog",
-            "title": "Example Catalog",
-            "description": "This is an example catalog",
-            "links": [
-                {
-                    "rel": "self",
-                    "href": "./catalog.json"
-                }
-            ]
-        };
-        
-        // Validate the STAC object
-        validator.validate(stacCatalog).then(report => {
-            console.log('Validation result:', report);
-            console.log('Is valid:', report.valid);
-            if (!report.valid) {
-                console.log('Errors:', report.messages);
-            }
-        }).catch(error => {
-            console.error('Validation error:', error);
-        });
-    </script>
-</body>
-</html>
+```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:');
+}
 ```
 
-See [example.html](./example.html) for a complete working example.
+#### Validation Results
 
-### API
-
-The browser version exposes the same API as the Node.js version:
+The `validate` function returns a `Report` object with the following structure:
 
 ```javascript
-// Create validator with options
-const validator = new STACValidator({
-    schemas: 'https://schemas.stacspec.org/v1.0.0', // optional
-    strict: false, // optional
-    // Note: some options like custom loaders may not work in browser
-});
-
-// Validate a STAC object
-validator.validate(stacObject).then(report => {
-    // Handle validation result
-});
+{
+  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
+  },
+  apiList: false		// Whether this is an API collection response
+}
 ```
 
-### Config file
+### Browser
 
-You can also pass a config file via the `--config` option. Simply pass a file path as value.
-Parameters set via CLI will not override the corresponding setting in the config file.
+The validator is also available as a browser bundle for client-side validation.
 
-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.
+#### 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/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`
 
-#### Browser Bundle Development
-
-To work on the browser bundle:
-
-1. `npm run build:dev` - Build the bundle in development mode
-2. `npm run serve` - Start a local server to test the bundle
-3. Open `http://localhost:8080/example.html` in your browser to test the bundle
-4. `npm run build` - Build the production bundle
-
-The browser bundle is built using Webpack and includes polyfills for Node.js modules to ensure compatibility with browsers.
-
-### 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`.
-
-### Release Process
-
-The project uses GitHub Actions for automated releases:
-
-1. **Testing**: All pull requests and pushes to master trigger the test suite across multiple Node.js versions and operating systems.
-2. **Browser Bundle Testing**: The test suite also validates that the browser bundle can be built successfully.
-3. **Release**: When a new tag is pushed (format: `v*`), the release workflow automatically:
-   - Runs all tests
-   - Builds the browser bundle
-   - Creates a GitHub release with the browser bundle as an asset
-   - Publishes the package to npm
+### Browser Bundle
 
-To create a new release:
+To work on the browser bundle build it: `npm run build`
 
-1. Update the version in `package.json`
-2. Create and push a git tag: `git tag v2.0.0-beta.19 && git push origin v2.0.0-beta.19`
-3. The release workflow will automatically handle the rest
+Then you can import it from the `dist` folder.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "stac-node-validator",
-  "version": "2.0.0-beta.18",
+  "version": "2.0.0-rc.1",
   "description": "STAC Validator for NodeJS",
   "author": "Matthias Mohr",
   "license": "Apache-2.0",