Improved library

.github/workflows/ci.yml

@@ -22,7 +22,6 @@ jobs:
     strategy:
       matrix:
         node-version: 
-          - 18.x
           - 20.x
           - 22.x
 

.gitignore

@@ -1,8 +1,11 @@
 node_modules
-lib
+dist
+coverage
 
 ### VisualStudioCode Patch ###
 # Ignore all local history of files
 .history
+.idea
+.vscode
 
-src/versionInfo.ts
+src/versionInfo.ts

README.md

@@ -1,7 +1,113 @@
 # solid-logic
-Core business logic of SolidOS
 
-# Adendum
+<img src="https://raw.githubusercontent.com/solid/community-server/main/templates/images/solid.svg" alt="[Solid logo]" height="150" align="right"/>
+
+[![MIT license](https://img.shields.io/github/license/solidos/solidos)](https://github.com/solidos/solidos/blob/main/LICENSE.md)
+
+
+Core business logic of SolidOS which can be used for any webapp as well.
+
+
+# Usage
+
+## Install via npm
+
+```sh
+npm install solid-logic
+```
+
+### Import in your project (ESM/TypeScript)
+
+```js
+import { someFunction } from 'solid-logic';
+```
+
+## Use directly in a browser
+
+There are a few differences to mention:
+* the UMD bundles come in 2 flavours, with rdflib bundled together and without;
+* the ESM bundles do not contain rdflib, so it must be imported separately.
+
+## Files
+- For browser UMD, bundled with rdflib: `dist/solid-logic.js` (global `window.SolidLogic`)
+- For browser UMD, without rdflib: `dist/solid-logic.external.js` (global `window.SolidLogic`)
+- For browser ESM, without rdflib: `dist/solid-logic.esm.external.js` (import as module)
+- UMD have also chunked files.
+- both version also containe minified versions.
+
+
+### UMD bundle (global variable)
+
+```html
+<!-- Load dependencies first -->
+<script src="https://unpkg.com/rdflib/dist/rdflib.min.js"></script>
+<!-- or -->
+<!-- script src="https://cdn.jsdelivr.net/npm/rdflib/dist/rdflib.min.js"></script -->
+<!-- Load solid-logic UMD bundle -->
+<script src="https://unpkg.com/solid-logic/dist/solid-logic.min.js"></script>
+<!-- or -->
+<!-- script src="https://cdn.jsdelivr.net/npm/solid-logic/dist/solid-logic.min.js"></script -->
+<!-- or -->
+<!-- script src="dist/solid-logic.js"></script -->
+<script>
+	// Access via global variable
+	const logic = window.SolidLogic;
+	// Example usage
+	// logic.someFunction(...)
+</script>
+```
+
+
+### ESM bundle (import as module)
+
+```html
+<script type="module">
+	import * as $rdf from 'https://esm.sh/rdflib'
+	import { someFunction } from 'https://esm.sh/solid-logic'
+
+	// Example usage
+	// someFunction(...)
+</script>
+```
+
+or 
+
+### ESM bundle with import map (bare specifiers)
+
+```html
+<script type="importmap">
+{
+	"imports": {
+		"rdflib": "https://esm.sh/rdflib",
+		"solid-logic": "https://esm.sh/solid-logic"
+	}
+}
+</script>
+<script type="module">
+    import * as $rdf from 'rdflib'
+	import { someFunction } from 'solid-logic'
+
+	// Example usage
+	// someFunction(...)
+</script>
+```
+
+# How to develop
+
+Check the scripts in the `package.json` for build, watch, lint and test.
+
+# Used stack
+
+* TypeScript + Babel
+* Jest
+* ESLint
+* Webpack
+
+# How to release
+
+Change version and push directly to main. This will trigger the npm release latest script in CI.
+
+# History
 
 Solid-logic was a move to separate business logic from UI functionality so that people using different UI frameworks could use logic code. 
 

babel.config.js

@@ -0,0 +1,6 @@
+export default {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript'
+  ]
+}

eslint.config.js

@@ -1,29 +1,49 @@
-const {
-    defineConfig,
-} = require("eslint/config");
+import tsParser from '@typescript-eslint/parser'
+import tseslintPlugin from '@typescript-eslint/eslint-plugin'
+import importPlugin from 'eslint-plugin-import'
 
-const tsParser = require("@typescript-eslint/parser");
-const typescriptEslint = require("@typescript-eslint/eslint-plugin");
-const js = require("@eslint/js");
-
-const {
-    FlatCompat,
-} = require("@eslint/eslintrc");
-
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
-
-module.exports = defineConfig([{
+export default [
+  {
+    ignores: [
+      'dist/**',
+      'node_modules/**',
+      'coverage/**'
+    ],
+  },
+  {
+    files: ['src/**/*.js', 'src/**/*.ts', 'src/**/*.cjs', 'src/**/*.mjs'],
     languageOptions: {
-        parser: tsParser,
+      parser: tsParser,
+      parserOptions: {
+        project: ['./tsconfig.json'],
+        sourceType: 'module',
+      },
     },
-
     plugins: {
-        "@typescript-eslint": typescriptEslint,
+      '@typescript-eslint': tseslintPlugin,
+      import: importPlugin,
     },
-
-    extends: compat.extends("eslint:recommended", "plugin:@typescript-eslint/recommended"),
-}]);
+    rules: {
+      semi: ['error', 'never'],
+      quotes: ['error', 'single'],
+      'no-unused-vars': 'off', // handled by TS
+      '@typescript-eslint/no-unused-vars': ['warn'],
+      '@typescript-eslint/no-explicit-any': 'warn',
+    },
+  },
+  {
+    files: ['test/**/*.js', 'test/**/*.ts'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: ['./tsconfig.test.json'],
+      },
+    },
+    rules: {
+      semi: ['error', 'never'],
+      quotes: ['error', 'single'],
+      'no-console': 'off', // Allow console in tests
+      'no-undef': 'off', // Tests may define globals
+    }
+  }
+]

jest.config.js

@@ -1,10 +1,17 @@
-module.exports = {
-  verbose: true,
+/** @type {import('jest').Config} */
+export default {
+  // verbose: true, // Uncomment for detailed test output
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
   testEnvironment: 'jsdom',
   testEnvironmentOptions: {
-      customExportConditions: ['node']
+    customExportConditions: ['node'],
   },
-  setupFilesAfterEnv: [
-    './test/helpers/setup.ts'
-  ]
-}
+  testPathIgnorePatterns: ['/node_modules/', '/dist/'],
+  transform: {
+    '^.+\\.[tj]sx?$': ['babel-jest', { configFile: './babel.config.js' }],
+  },
+  setupFilesAfterEnv: ['./test/helpers/setup.ts'],
+  testMatch: ['**/__tests__/**/*.ts?(x)', '**/?(*.)+(spec|test).ts?(x)'],
+  roots: ['<rootDir>/src', '<rootDir>/test'],
+}