@monocloud/auth-web-js 0.0.0-canary-20260526103559

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MonoCloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,144 @@
+<div align="center">
+  <a href="https://www.monocloud.com?utm_source=github&utm_medium=auth_js" target="_blank" rel="noopener noreferrer">
+    <picture>
+      <img src="https://raw.githubusercontent.com/monocloud/auth-js/refs/heads/main/packages/web-js/banner.svg" alt="MonoCloud Banner">
+    </picture>
+  </a>
+  <div align="right">
+    <a href="https://www.npmjs.com/package/@monocloud/auth-web-js" target="_blank">
+      <img src="https://img.shields.io/npm/v/@monocloud/auth-web-js" alt="NPM" />
+    </a>
+    <a href="https://opensource.org/licenses/MIT">
+      <img src="https://img.shields.io/:license-MIT-blue.svg?style=flat" alt="License: MIT" />
+    </a>
+    <a href="https://github.com/monocloud/auth-js/actions/workflows/build.yml">
+      <img src="https://github.com/monocloud/auth-js/actions/workflows/build.yml/badge.svg" alt="Build Status" />
+    </a>
+  </div>
+</div>
+
+## Introduction
+
+**MonoCloud Web Authentication SDK – secure authentication for single-page applications and other browser-based JavaScript environments.**
+
+[MonoCloud](https://www.monocloud.com?utm_source=github&utm_medium=auth_js) is a modern, developer-friendly Identity & Access Management platform.
+
+This SDK provides a **browser-side authentication client** for single-page apps (SPAs) and any JavaScript environment running in the browser. It implements **OAuth 2.0 / OpenID Connect** with **PKCE**, handles redirect and popup flows, manages sessions and tokens, and serves as the foundation for higher-level framework SDKs (React, Vue, Angular, Svelte, Astro, etc.).
+
+## 📘 Documentation
+
+- **Documentation:** [https://www.monocloud.com/docs](https://www.monocloud.com/docs?utm_source=github&utm_medium=auth_js)
+- **API Reference:** [https://monocloud.github.io/auth-js](https://monocloud.github.io/auth-js?utm_source=github&utm_medium=auth_js)
+
+## Supported Platforms
+
+- **Modern Browsers** (Chrome, Edge, Firefox, Safari)
+
+## 🚀 Getting Started
+
+### Requirements
+
+- A **MonoCloud Tenant**
+- A **Client** configured as a Single Page Application (SPA)
+- The application's URL registered in **Callback URLs**, **Sign-out URLs** and **Cross Origin URLs**
+
+## 📦 Installation
+
+```bash
+npm install @monocloud/auth-web-js
+```
+
+### Initialization
+
+Create a shared `MonoCloudWebJSClient` instance and reuse it throughout your application.
+
+```typescript
+import { MonoCloudWebJSClient } from '@monocloud/auth-web-js';
+
+export const client = new MonoCloudWebJSClient({
+  tenantDomain: 'https://<your-tenant-domain>',
+  clientId: '<your-client-id>',
+  appUrl: 'http://localhost:3000',
+  callbackPath: '/callback',
+  signOutCallbackPath: '/logout',
+});
+```
+
+### Wire Up the Callback Routes
+
+Call the matching process method from each callback route. The SDK never infers which flow is in progress — wire each handler to the route that owns its redirect URI.
+
+```typescript
+await client.processSignInCallback();
+
+await client.processSignOutCallback();
+```
+
+### Sign In and Sign Out
+
+Start an authentication flow by redirecting the user to MonoCloud, or end the session and return the user to your sign-out callback.
+
+```typescript
+await client.signIn();
+
+await client.signOut();
+```
+
+### Silent Sign In (SSO Restore)
+
+Attempt to restore an authenticated session at app bootstrap without disrupting the user. Uses a hidden iframe with `prompt=none`; resolves to the new session on success, or rejects with a `MonoCloudOPError` (typically `login_required`) when the authorization server cannot satisfy the request without interaction.
+
+```typescript
+import { MonoCloudOPError } from '@monocloud/auth-web-js';
+
+try {
+  const session = await client.signInSilent();
+  console.log('Restored session for:', session.user);
+} catch (error) {
+  if (error instanceof MonoCloudOPError && error.error === 'login_required') {
+    console.log('Not signed in');
+  } else {
+    throw error;
+  }
+}
+```
+
+### Get the Current Session
+
+Retrieve the active session, including the authenticated user's profile and tokens. Returns `null` when no user is signed in.
+
+```typescript
+const session = await client.getSession();
+
+if (session) {
+  console.log(session.user);
+}
+```
+
+## When should I use `auth-web-js`?
+
+Use **`@monocloud/auth-web-js`** if you are building a **browser-based JavaScript application** and want a secure, OIDC-compliant authentication client without tying yourself to a specific UI framework.
+
+This package is a good fit if you:
+
+- Are building a **single-page application (SPA)** in plain JavaScript / TypeScript
+- Are writing a **custom framework integration** on top of MonoCloud
+- Need full control over **PKCE, redirects, popups, silent refresh, and token storage**
+- Want **cross-tab refresh coordination** and pluggable storage out of the box
+
+Higher-level packages build on top of `auth-web-js` and provide framework-specific ergonomics while reusing the same underlying browser implementation.
+
+## 🤝 Contributing & Support
+
+### Issues & Feedback
+
+- Use **GitHub Issues** for bug reports and feature requests.
+- For tenant or account-specific help, contact MonoCloud Support through your dashboard.
+
+### Security
+
+Do **not** report security issues publicly. Please follow the contact instructions at: [https://www.monocloud.com/contact](https://www.monocloud.com/contact?utm_source=github&utm_medium=auth_js)
+
+## 📄 License
+
+Licensed under the **MIT License**. See the included [`LICENSE`](https://github.com/monocloud/auth-js/blob/main/LICENSE) file.