@ziqx/auth 0.0.1

package/README.md

@@ -0,0 +1,106 @@
+# @ziqx/auth
+
+A lightweight authentication SDK for ZIQX platforms. Provides an easy interface to trigger the authentication flow from your frontend.
+
+---
+
+## Installation
+
+```bash
+npm install @ziqx/auth
+```
+
+or
+
+```bash
+yarn add @ziqx/auth
+```
+
+---
+
+## Usage
+
+### Import and Initialize
+
+```typescript
+import { ZAuthClient } from "@ziqx/auth";
+
+const auth = new ZAuthClient({
+  authKey: "YOUR_AUTH_KEY",
+});
+```
+
+### Trigger Login
+
+```typescript
+auth.login(); // Redirects to live auth environment
+```
+
+### Trigger Login in Development Mode
+
+If you're working in a development environment, enable dev mode:
+
+```typescript
+auth.login(true); // Redirects to dev auth environment
+```
+
+---
+
+## API Reference
+
+### Class: `ZAuthClient`
+
+#### Constructor
+
+```typescript
+new ZAuthClient(options: { authKey: string });
+```
+
+| Parameter | Type   | Required | Description                               |
+| --------- | ------ | -------- | ----------------------------------------- |
+| `authKey` | string | ✅ Yes   | Your unique authentication key from ZIQX. |
+
+#### Methods
+
+##### `login(isDev?: boolean): void`
+
+Redirects the user to the ZIQX authentication portal.
+
+| Parameter | Type    | Default | Description                                              |
+| --------- | ------- | ------- | -------------------------------------------------------- |
+| `isDev`   | boolean | `false` | Set `true` to redirect to the dev authentication portal. |
+
+**Example:**
+
+```typescript
+auth.login(); // Redirects to production portal
+auth.login(true); // Redirects to development portal
+```
+
+---
+
+## Example Implementation
+
+```typescript
+import { ZAuthClient } from "@ziqx/auth";
+
+const auth = new ZAuthClient({ authKey: "12345-xyz" });
+
+document.getElementById("loginBtn")?.addEventListener("click", () => {
+  auth.login();
+});
+```
+
+---
+
+## 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.
+
+---
+
+## License
+
+MIT License © 2025 [ZIQX]

package/dist/index.d.mts

@@ -0,0 +1,47 @@
+/**
+ * ZAuthClient - A lightweight authentication client for ZIQX Auth.
+ *
+ * This class helps redirect users to the ZIQX authentication gateway.
+ *
+ * Example:
+ * ```ts
+ * import { ZAuthClient } from "@ziqx/auth";
+ *
+ * const auth = new ZAuthClient({
+ *   authKey: "your-auth-key"
+ * });
+ *
+ * // Redirects user to ZIQX Auth
+ * auth.login();
+ *
+ * // For development mode
+ * auth.login(true);
+ * ```
+ */
+declare class ZAuthClient {
+    private authKey;
+    /**
+     * Creates a new ZAuthClient instance.
+     *
+     * @param options - The configuration options.
+     * @param options.authKey - The authentication key provided by ZIQX.
+     */
+    constructor({ authKey }: {
+        authKey: string;
+    });
+    /**
+     * Redirects the user to the ZIQX authentication page.
+     *
+     * @param isDev - (Optional) Set to `true` to use development mode. Defaults to `false`.
+     *
+     * @example
+     * ```ts
+     * const client = new ZAuthClient({ authKey: "your-auth-key" });
+     * client.login(); // Redirects to production auth page
+     * client.login(true); // Redirects to development auth page
+     * ```
+     */
+    login(isDev?: boolean): void;
+}
+
+export { ZAuthClient };

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * ZAuthClient - A lightweight authentication client for ZIQX Auth.
+ *
+ * This class helps redirect users to the ZIQX authentication gateway.
+ *
+ * Example:
+ * ```ts
+ * import { ZAuthClient } from "@ziqx/auth";
+ *
+ * const auth = new ZAuthClient({
+ *   authKey: "your-auth-key"
+ * });
+ *
+ * // Redirects user to ZIQX Auth
+ * auth.login();
+ *
+ * // For development mode
+ * auth.login(true);
+ * ```
+ */
+declare class ZAuthClient {
+    private authKey;
+    /**
+     * Creates a new ZAuthClient instance.
+     *
+     * @param options - The configuration options.
+     * @param options.authKey - The authentication key provided by ZIQX.
+     */
+    constructor({ authKey }: {
+        authKey: string;
+    });
+    /**
+     * Redirects the user to the ZIQX authentication page.
+     *
+     * @param isDev - (Optional) Set to `true` to use development mode. Defaults to `false`.
+     *
+     * @example
+     * ```ts
+     * const client = new ZAuthClient({ authKey: "your-auth-key" });
+     * client.login(); // Redirects to production auth page
+     * client.login(true); // Redirects to development auth page
+     * ```
+     */
+    login(isDev?: boolean): void;
+}
+
+export { ZAuthClient };

package/dist/index.js

@@ -0,0 +1,66 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  ZAuthClient: () => ZAuthClient
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/constants.ts
+var ZAUTH_BASE_URL = "https://ziqx.cc/zauth";
+
+// src/ZAuthClient.ts
+var ZAuthClient = class {
+  authKey;
+  /**
+   * Creates a new ZAuthClient instance.
+   *
+   * @param options - The configuration options.
+   * @param options.authKey - The authentication key provided by ZIQX.
+   */
+  constructor({ authKey }) {
+    if (!authKey) {
+      throw new Error("ZAuthClient: authKey is required.");
+    }
+    this.authKey = authKey;
+  }
+  /**
+   * Redirects the user to the ZIQX authentication page.
+   *
+   * @param isDev - (Optional) Set to `true` to use development mode. Defaults to `false`.
+   *
+   * @example
+   * ```ts
+   * const client = new ZAuthClient({ authKey: "your-auth-key" });
+   * client.login(); // Redirects to production auth page
+   * client.login(true); // Redirects to development auth page
+   * ```
+   */
+  login(isDev = false) {
+    const devQuery = isDev ? "&dev=true" : "";
+    const loginUrl = `${ZAUTH_BASE_URL}?key=${this.authKey}${devQuery}`;
+    window.location.href = loginUrl;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ZAuthClient
+});

package/dist/index.mjs

@@ -0,0 +1,39 @@
+// src/constants.ts
+var ZAUTH_BASE_URL = "https://ziqx.cc/zauth";
+
+// src/ZAuthClient.ts
+var ZAuthClient = class {
+  authKey;
+  /**
+   * Creates a new ZAuthClient instance.
+   *
+   * @param options - The configuration options.
+   * @param options.authKey - The authentication key provided by ZIQX.
+   */
+  constructor({ authKey }) {
+    if (!authKey) {
+      throw new Error("ZAuthClient: authKey is required.");
+    }
+    this.authKey = authKey;
+  }
+  /**
+   * Redirects the user to the ZIQX authentication page.
+   *
+   * @param isDev - (Optional) Set to `true` to use development mode. Defaults to `false`.
+   *
+   * @example
+   * ```ts
+   * const client = new ZAuthClient({ authKey: "your-auth-key" });
+   * client.login(); // Redirects to production auth page
+   * client.login(true); // Redirects to development auth page
+   * ```
+   */
+  login(isDev = false) {
+    const devQuery = isDev ? "&dev=true" : "";
+    const loginUrl = `${ZAUTH_BASE_URL}?key=${this.authKey}${devQuery}`;
+    window.location.href = loginUrl;
+  }
+};
+export {
+  ZAuthClient
+};

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@ziqx/auth",
+  "version": "0.0.1",
+  "description": "SDK for Ziqx Authentication",
+  "main": "./dist/index.ts",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "homepage": "ziqx.cc",
+  "access": "public",
+  "repository": {
+    "url": "https://github.com/ziqx/ziqx-auth-js"
+  },
+  "scripts": {
+    "build": "tsup"
+  },
+  "keywords": [
+    "zauth",
+    "ziqx auth",
+    "ziqx.js"
+  ],
+  "author": "Fathah KA",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5"
+  }
+}