Feat/issue 93 runtime compat

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  verify:
+    name: Build & Verify SDK Runtime
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 10.34.1
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 25.9.4
+          cache: 'pnpm'
+
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run Build
+        run: pnpm build
+
+      - name: Run Unit & Compatibility Tests
+        run: pnpm test:run
+
+      - name: Verify Public API Report
+        run: pnpm api-report:ci

CONTRIBUTING.md

@@ -146,3 +146,14 @@ pnpm build        # Build must succeed
 
 - GitHub Issues: preferred for all task discussion
 - Contact: cerealboxx123@gmail.com
+
+---
+
+## Public API Changes
+
+We monitor changes to our public API surface closely to prevent accidental breaking changes.
+
+If you modify exported classes, interfaces, or types:
+1. Run `pnpm api-report` locally to update the API baseline file (`api-report/guildpass-sdk.api.md`).
+2. Commit the updated `guildpass-sdk.api.md` file alongside your code changes.
+3. Your pull request will display a diff of the API changes for maintainer review.

README.md

@@ -38,7 +38,7 @@ GuildPass is a Web3 membership and access-control protocol designed for token-ga
 - **⚡ Pluggable Caching**: Built-in TTL cache with optional custom adapter support (Redis, etc.).
 - **🧩 Modular Architecture**: Clean service-based design for minimal bundle size.
 - **💪 Type Safe**: First-class TypeScript support with comprehensive definitions.
-- **🌐 Universal**: Seamless integration with Node.js, modern browsers, and Edge runtimes.
+- **🌐 Universal**: Seamless integration with Node.js (18+), modern browsers (JSDOM verified), and Edge runtimes (V8/Cloudflare Workers verified). Fully tested in continuous integration across all environments.
 
 ## 📦 Installation
 

api-extractor.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/api-report/",
+    "reportFileName": "guildpass-sdk.api.md"
+  },
+  "docModel": {
+    "enabled": false
+  },
+  "dtsRollup": {
+    "enabled": false
+  },
+  "tsdocMetadata": {
+    "enabled": false
+  },
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      },
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none"
+      }
+    }
+  }
+}