ESM

.changeset/cool-donkeys-jam.md

@@ -0,0 +1,9 @@
+---
+"alcaeus": major
+---
+
+Convert to ESM-only. Other changes include:
+
+1. `isomorphic-fetch` and `isomorhpic-form-data` are removed as dependencies. They should be loaded by consumer s if necessary
+2. Removed `./web` and `./node` modules. Instead, consumers must use `alcaeus/Factory.js` module with an appropriate RDF/JS environment
+3. Extracted packages `alcaeus-model` and `alcaeus-core`

.changeset/pre.json

@@ -0,0 +1,10 @@
+{
+ "mode": "pre",
+ "tag": "esm",
+ "initialVersions": {
+ "alcaeus": "2.3.3",
+ "alcaeus-core": "0.0.0",
+ "alcaeus-model": "0.0.0"
+ },
+ "changesets": []
+}

.changeset/proud-islands-rush.md

@@ -0,0 +1,6 @@
+---
+"alcaeus-model": major
+"alcaeus-core": major
+---
+
+First release. Code extracted from `alceaus` v2

.editorconfig

@@ -3,7 +3,7 @@ indent_style = space
 indent_size = 2
 
 [*.ts]
-indent_size = 4
+indent_size = 2
 
 [*.conf*.js]
-indent_size = 4
+indent_size = 2

.eslintrc.json

@@ -2,50 +2,20 @@
  "extends": [
  "@tpluscode"
  ],
- "parserOptions": {
- "project": "./tsconfig.eslint.json",
- "extraFileExtensions": [".mjs"]
- },
  "env": {
- "browser": true,
- "jest/globals": true
+ "mocha": true
  },
- "plugins": [
- "jest"
- ],
  "rules": {
- "@typescript-eslint/indent": ["error", 4],
- "import/no-extraneous-dependencies": ["error", {"devDependencies": ["tests/**"]}]
+ "@typescript-eslint/no-explicit-any": "off"
  },
  "overrides": [
  {
- "extends": [
- "eslint:recommended",
- "plugin:import/errors",
- "plugin:import/warnings"
+ "files": [
+ "**/test/**"
  ],
- "files": ["**/*.mjs"],
- "rules": {
- "no-void": "off",
- "no-func-assign": "off",
- "prefer-const": "off",
- "@typescript-eslint/no-empty-function": "off"
- },
- "settings": {
- "import/extensions": [
- ".js",
- ".mjs"
- ]
- }
- },
- {
- "files": ["tests/**/*.ts"],
  "rules": {
- "@typescript-eslint/no-object-literal-type-assertion": "off",
- "no-prototype-builtins": "off",
- "@typescript-eslint/no-namespace": "off",
- "@typescript-eslint/no-non-null-assertion": "off",
- "@typescript-eslint/explicit-function-return-type": "off"
+ "no-unused-expressions": "off",
+ "import/no-extraneous-dependencies": "off"
  }
  }
  ]

.github/workflows/release.yml

@@ -11,22 +11,22 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Checkout Repo
- uses: actions/checkout@master
+ uses: actions/checkout@v4
  with:
  # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
  fetch-depth: 0
 
  - name: Setup Node.js
- uses: actions/setup-node@v2.1.2
+ uses: actions/setup-node@v4
  with:
- node-version: 14
+ node-version: 18
 
  - name: Install Dependencies
  run: yarn
 
  - name: Create Release Pull Request or Publish to npm
  id: changesets
- uses: changesets/action@master
+ uses: changesets/action@v1
  with:
  # This expects you to have a script called release which does a build for your packages and calls changeset publish
  publish: yarn release

.github/workflows/test.yml

@@ -6,34 +6,33 @@ jobs:
  test:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/checkout@v4
+ - uses: actions/setup-node@v4
  with:
- node-version: '14'
- - run: yarn
- - run: yarn test
+ node-version: '18'
+ - run: npm ci
+ - run: npm test
  - name: Codecov
- uses: codecov/codecov-action@v1.0.5
+ uses: codecov/codecov-action@v3
  with:
  token: ${{ secrets.CODECOV_TOKEN }}
 
  build:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/checkout@v4
+ - uses: actions/setup-node@v4
  with:
- node-version: '14'
- - run: yarn
- - run: yarn build
- - run: yarn eslint . --ext .mjs --fix --quiet
+ node-version: '18'
+ - run: npm ci
+ - run: npx wsrun -c build --noEmit
 
  lint:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/checkout@v4
+ - uses: actions/setup-node@v4
  with:
- node-version: '14'
- - run: yarn
+ node-version: '18'
+ - run: npm ci
  - run: yarn lint

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged
+cp packages/alcaeus/README.md README.md
+git add README.md

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Tomasz Pluskiewicz
+Copyright (c) 2024 Tomasz Pluskiewicz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -12,22 +12,27 @@ Alcaeus is the birth name of Heracles. The demigod who defeated Hydra.
 Use npm or yarn:
 
 ``` bash
-npm i -S alcaeus
+npm i alcaeus
 ```
 
 ## Requirements
 
-| Environment | Version | Notes |
-| -- | -- | -- |
-| node.js | 12+ | v12 requires `--experimental-modules` flag |
-| TypeScript | 3.8+ | |
+Alcaues `v3` is implemented only as ES Modules. It will work in recent versions on node and modern browsers.
 
 ## Usage
 
-``` js
-import { Hydra } from 'alcaeus/web' // (or 'alcaeus/node')
+Since `v3` Alcaeus is configured using an RDF/JS Environment factory. This decouples the library from any specific RDF/JS implementation.
 
-const { response, representation } = await Hydra.loadResource('http://example.com/resource');
+It is recommended to use the implementation provided by `@zazuko/env` which allows to easily reuse extend existing environments.
+
+```js
+import create from 'alcaeus'
+import Environment from '@zazuko/env/Environment.js'
+import rdf from '@zazuko/env'
+
+const env = new Environment(create(), { parent: rdf })
+
+const { response, representation } = await env.hydra.loadResource('http://example.com/resource');
 const rootResource = representation.root;
 
 // contains supported classes, operations, etc.
@@ -36,12 +41,7 @@ const apiDocs = Hydra.apiDocumentations[0];
 const id = rootResource.id; 
 ```
 
-To learn more head to http://alcaeus.hydra.how.
-
-### More examples (outdated)
-
-* [Introduction to heracles](http://t-code.pl/blog/2016/04/introducing-heracles/)
-* [Working with jsonld.js](http://t-code.pl/blog/2016/04/heracles-compacting-resources/)
+To learn more, head to http://alcaeus.hydra.how.
 
 ## License