@ziqx/auth 0.0.1 → 0.0.3

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/dist/index.d.mts

@@ -44,4 +44,39 @@ declare class ZAuthClient {
     login(isDev?: boolean): void;
 }
 
-export { ZAuthClient };
+/**
+ * ZAuthTokenService - A simple token validation service for ZIQX Auth.
+ *
+ * This class provides a method to validate authentication tokens issued by ZIQX.
+ *
+ * Example:
+ * ```ts
+ * 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");
+ * }
+ * ```
+ */
+declare class ZAuthTokenService {
+    /**
+     * Validates a given authentication token with the ZIQX Auth API.
+     *
+     * @param token - The authentication token (JWT or similar) to validate.
+     * @returns A Promise that resolves to `true` if the token is valid, otherwise `false`.
+     *
+     * @example
+     * ```ts
+     * const tokenService = new ZAuthTokenService();
+     * const isValid = await tokenService.validate("your-jwt-token");
+     * ```
+     */
+    validate(token: string): Promise<boolean>;
+}
+
+export { ZAuthClient, ZAuthTokenService };

package/dist/index.d.ts

@@ -44,4 +44,39 @@ declare class ZAuthClient {
     login(isDev?: boolean): void;
 }
 
-export { ZAuthClient };
+/**
+ * ZAuthTokenService - A simple token validation service for ZIQX Auth.
+ *
+ * This class provides a method to validate authentication tokens issued by ZIQX.
+ *
+ * Example:
+ * ```ts
+ * 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");
+ * }
+ * ```
+ */
+declare class ZAuthTokenService {
+    /**
+     * Validates a given authentication token with the ZIQX Auth API.
+     *
+     * @param token - The authentication token (JWT or similar) to validate.
+     * @returns A Promise that resolves to `true` if the token is valid, otherwise `false`.
+     *
+     * @example
+     * ```ts
+     * const tokenService = new ZAuthTokenService();
+     * const isValid = await tokenService.validate("your-jwt-token");
+     * ```
+     */
+    validate(token: string): Promise<boolean>;
+}
+
+export { ZAuthClient, ZAuthTokenService };

package/dist/index.js

@@ -20,12 +20,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  ZAuthClient: () => ZAuthClient
+  ZAuthClient: () => ZAuthClient,
+  ZAuthTokenService: () => ZAuthTokenService
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/constants.ts
 var ZAUTH_BASE_URL = "https://ziqx.cc/zauth";
+var VALIDATION_URL = "https://ziqx.cc/api/auth/validate-token";
 
 // src/ZAuthClient.ts
 var ZAuthClient = class {
@@ -60,7 +62,44 @@ var ZAuthClient = class {
     window.location.href = loginUrl;
   }
 };
+
+// src/ZAuthTokenService.ts
+var ZAuthTokenService = class {
+  /**
+   * Validates a given authentication token with the ZIQX Auth API.
+   *
+   * @param token - The authentication token (JWT or similar) to validate.
+   * @returns A Promise that resolves to `true` if the token is valid, otherwise `false`.
+   *
+   * @example
+   * ```ts
+   * const tokenService = new ZAuthTokenService();
+   * const isValid = await tokenService.validate("your-jwt-token");
+   * ```
+   */
+  async validate(token) {
+    if (!token) {
+      throw new Error("ZAuthTokenService: token is required for validation.");
+    }
+    try {
+      const response = await fetch(VALIDATION_URL, {
+        method: "GET",
+        headers: {
+          Authorization: token
+        }
+      });
+      if (response.status !== 200)
+        return false;
+      const data = await response.json();
+      return data.success === true;
+    } catch (error) {
+      console.error("ZAuthTokenService: Validation failed:", error);
+      return false;
+    }
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ZAuthClient
+  ZAuthClient,
+  ZAuthTokenService
 });

package/dist/index.mjs

@@ -1,5 +1,6 @@
 // src/constants.ts
 var ZAUTH_BASE_URL = "https://ziqx.cc/zauth";
+var VALIDATION_URL = "https://ziqx.cc/api/auth/validate-token";
 
 // src/ZAuthClient.ts
 var ZAuthClient = class {
@@ -34,6 +35,43 @@ var ZAuthClient = class {
     window.location.href = loginUrl;
   }
 };
+
+// src/ZAuthTokenService.ts
+var ZAuthTokenService = class {
+  /**
+   * Validates a given authentication token with the ZIQX Auth API.
+   *
+   * @param token - The authentication token (JWT or similar) to validate.
+   * @returns A Promise that resolves to `true` if the token is valid, otherwise `false`.
+   *
+   * @example
+   * ```ts
+   * const tokenService = new ZAuthTokenService();
+   * const isValid = await tokenService.validate("your-jwt-token");
+   * ```
+   */
+  async validate(token) {
+    if (!token) {
+      throw new Error("ZAuthTokenService: token is required for validation.");
+    }
+    try {
+      const response = await fetch(VALIDATION_URL, {
+        method: "GET",
+        headers: {
+          Authorization: token
+        }
+      });
+      if (response.status !== 200)
+        return false;
+      const data = await response.json();
+      return data.success === true;
+    } catch (error) {
+      console.error("ZAuthTokenService: Validation failed:", error);
+      return false;
+    }
+  }
+};
 export {
-  ZAuthClient
+  ZAuthClient,
+  ZAuthTokenService
 };

package/package.json

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