@ziqx/auth 0.0.1 → 0.0.2

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/README.md

@@ -1,6 +1,6 @@
 # @ziqx/auth
 
-A lightweight authentication SDK for ZIQX platforms. Provides an easy interface to trigger the authentication flow from your frontend.
+A lightweight authentication SDK for ZIQX platforms. Provides an easy interface to trigger the authentication flow and validate tokens from your frontend.
 
 ---
 
@@ -46,6 +46,26 @@ auth.login(true); // Redirects to dev auth environment
 
 ---
 
+## Token Validation
+
+You can use the `ZAuthTokenService` class to validate authentication tokens issued by ZIQX.
+
+```typescript
+import { ZAuthTokenService } from "@ziqx/auth";
+
+const tokenService = new ZAuthTokenService();
+
+const isValid = await tokenService.validate("your-jwt-token");
+
+if (isValid) {
+  console.log("Token is valid");
+} else {
+  console.log("Invalid or expired token");
+}
+```
+
+---
+
 ## API Reference
 
 ### Class: `ZAuthClient`
@@ -79,16 +99,50 @@ auth.login(true); // Redirects to development portal
 
 ---
 
+### Class: `ZAuthTokenService`
+
+#### Methods
+
+##### `validate(token: string): Promise<boolean>`
+
+Validates a given authentication token with the ZIQX Auth API.
+
+| Parameter | Type   | Required | Description                                |
+| --------- | ------ | -------- | ------------------------------------------ |
+| `token`   | string | ✅ Yes   | The authentication token (JWT or similar). |
+
+**Example:**
+
+```typescript
+const tokenService = new ZAuthTokenService();
+const isValid = await tokenService.validate("your-jwt-token");
+```
+
+Returns `true` if the token is valid and authorized, otherwise `false`.
+
+---
+
 ## Example Implementation
 
 ```typescript
-import { ZAuthClient } from "@ziqx/auth";
+import { ZAuthClient, ZAuthTokenService } from "@ziqx/auth";
 
 const auth = new ZAuthClient({ authKey: "12345-xyz" });
 
-document.getElementById("loginBtn")?.addEventListener("click", () => {
+// Login
+const loginBtn = document.getElementById("loginBtn");
+loginBtn?.addEventListener("click", () => {
   auth.login();
 });
+
+// Token validation example
+const tokenService = new ZAuthTokenService();
+const token = localStorage.getItem("ziqx_token");
+
+if (token) {
+  const isValid = await tokenService.validate(token);
+  console.log("Token valid:", isValid);
+}
 ```
 
 ---
@@ -96,8 +150,9 @@ document.getElementById("loginBtn")?.addEventListener("click", () => {
 ## Notes
 
 - Make sure your `authKey` is valid and corresponds to your environment.
-- If you’re working on localhost or staging, use `auth.login(true)` to switch to dev mode.
-- This SDK must be used in **client-side code only** — calling `login()` in a Server Component will throw an error.
+- Use `auth.login(true)` in development mode (e.g., on localhost or staging).
+- The `ZAuthTokenService` uses `https://ziqx.cc/api/auth/validate-token` internally.
+- This SDK is for **client-side use** only.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ziqx/auth",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "SDK for Ziqx Authentication",
   "main": "./dist/index.ts",
   "module": "./dist/index.mjs",