Merge pull request #100 from SolidOS/newFace

Improved library

Author: bourgeoa

.babelrc

@@ -8,10 +8,10 @@ permissions:
 on:
   push:
     branches:
-      - "**"
+      - main
   pull_request:
     branches:
-      - "**"  
+      - main
   workflow_dispatch:
 
 jobs:
@@ -22,7 +22,6 @@ jobs:
     strategy:
       matrix:
         node-version: 
-          - 18.x
           - 20.x
           - 22.x
 

.github/workflows/ci.yml

@@ -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

.gitignore

@@ -1,7 +1,134 @@
 # 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 rdflib
+```
+
+> **Important**: `rdflib` is a peer dependency - you must install it separately.
+
+### Import in your project (ESM/TypeScript)
+
+```js
+import { solidLogicSingleton, store, authn } from 'solid-logic';
+
+// Example usage
+console.log('Current user:', authn.currentUser());
+```
+
+## 🌐 Use directly in a browser
+
+Both UMD and ESM bundles externalize rdflib to keep bundle sizes small and avoid version conflicts.
+
+## Available Files
+
+| Format | File | Usage | Global Variable |
+|--------|------|-------|----------------|
+| UMD | `dist/solid-logic.js` | Development | `window.SolidLogic` |
+| UMD | `dist/solid-logic.min.js` | Production | `window.SolidLogic` |
+| ESM | `dist/solid-logic.esm.js` | Development | Import only |
+| ESM | `dist/solid-logic.esm.min.js` | Production | Import only |
+
+### UMD Bundle (Script Tags)
+
+**⚠️ Important**: Load rdflib **before** solid-logic or you'll get `$rdf is not defined` errors.
+
+```html
+<!-- 1. Load rdflib first (creates window.$rdf) -->
+<script src="https://cdn.jsdelivr.net/npm/rdflib/dist/rdflib.min.js"></script>
+
+<!-- 2. Load solid-logic (expects $rdf to exist) -->
+<script src="https://unpkg.com/solid-logic/dist/solid-logic.min.js"></script>
+
+<script>
+	// Access via global variable
+	const { solidLogicSingleton, store, authn } = window.SolidLogic;
+	
+	// Example usage
+	console.log('Store:', store);
+	console.log('Authentication:', authn.currentUser());
+</script>
+```
+
+### ESM Bundle (Native Modules)
+
+```html
+<script type="module">
+	import * as $rdf from 'https://esm.sh/rdflib';
+	import { solidLogicSingleton, store, authn } from 'https://esm.sh/solid-logic';
+
+	// Example usage
+	console.log('Store:', store);
+	console.log('Authentication:', authn.currentUser());
+</script>
+```
+
+### ESM with Import Maps (Recommended)
+
+```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 { solidLogicSingleton, store, authn } from 'solid-logic';
+
+	// Example usage - cleaner imports!
+	console.log('Store:', store);
+	console.log('Authentication:', authn.currentUser());
+</script>
+```
+
+## Common Exports
+
+```js
+import { 
+	solidLogicSingleton,  // Complete singleton instance
+	store,                // RDF store
+	authn,                // Authentication logic
+	authSession,          // Authentication session
+	ACL_LINK,            // ACL constants
+	getSuggestedIssuers,  // Identity provider suggestions
+	createTypeIndexLogic, // Type index functionality
+	// Error classes
+	UnauthorizedError,
+	NotFoundError,
+	FetchError
+} from 'solid-logic';
+```
+
+# 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. 
 

.npmignore

@@ -0,0 +1,10 @@
+export default {
+  presets: [
+    ['@babel/preset-env', {
+      targets: { 
+        browsers: ['> 1%', 'last 3 versions', 'not dead']
+      }
+    }],
+    '@babel/preset-typescript'
+  ]
+}

README.md

@@ -0,0 +1,50 @@
+import tsParser from '@typescript-eslint/parser'
+import importPlugin from 'eslint-plugin-import'
+
+export default [
+  {
+    ignores: [
+      'dist/**',
+      'lib/**',
+      'node_modules/**',
+      'coverage/**'
+    ],
+  },
+  {
+    files: ['src/**/*.ts'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: ['./tsconfig.json'],
+        sourceType: 'module',
+      },
+    },
+    plugins: {
+      import: importPlugin,
+    },
+    rules: {
+      // Style rules (not handled by TypeScript)
+      semi: ['error', 'never'],
+      quotes: ['error', 'single'],
+      
+      // Disable ESLint rules that TypeScript handles better
+      'no-unused-vars': 'off', // TypeScript handles this via noUnusedLocals
+      'no-undef': 'off', // TypeScript handles undefined variables
+    },
+  },
+  {
+    files: ['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
+    }
+  }
+]

babel.config.mjs

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