@anzar-auth/client 1.3.6

package/README.md

@@ -0,0 +1,89 @@
+# Anzar SDK Documentation
+
+## Install The Typescript SDK
+In a ts project run the following command to install the anzar package.
+
+**npm**
+```bash
+$ npm install anzar
+```
+
+**pnpm**
+```bash
+$ pnpm install anzar
+```
+
+**yarn**
+```bash
+$ yarn add anzar
+```
+
+## Create Anzar Auth Instance
+if you are using `vite` as a bundler, add this to your `vite.config.js`
+```javascript 
+import yaml from "@rollup/plugin-yaml";
+
+export default {
+  plugins: [yaml()],
+};
+```
+```bash 
+$ npm install -D @rollup/plugin-yaml
+```
+
+in your main entry file (`main.ts` for example), import Anzar and create your auth instance
+
+```typescript 
+// Initialize once at application startup
+// The SDK will communicate with your Anzar container at the configured api_url
+import { Anzar } from "anzar";
+import anzarConfig from "anzar.yml";
+
+const anzar = new Anzar(anzarConfig);
+```
+
+⚠️ **Note** 
+    Choose your token storage adapter
+
+```typescript 
+import { LocalStorage } from "anzar/adapters";
+
+const anzar = new Anzar(anzarConfig, {
+    storage: new LocalStorage(),
+});
+```
+
+## Basic Usage
+Anzar provides authentication support for email and password.
+
+📝 **Note:** Other methods of authentication will be implemented later
+
+### Sign Up
+To sign up a user you need to call the method register with the user's information.
+```typescript
+import type { AuthResult } from "anzar/types";
+
+try {
+    const data: AuthResult = await anzar.Auth.register({ username, email, password });
+    console.log(data);
+} catch (e) {
+    const message = e.response?.data?.message ?? "An unknown error occurred";
+    console.log(message);
+}
+```
+
+📝 **Note:** By default, the users are automatically signed in after they successfully sign up.
+             Disabling this behavior will be implemented later
+
+### Sign In
+To sign in a user you need to call the method login.
+```typescript
+import type { AuthResult } from "anzar/types";
+
+try {
+    const data: AuthResult = await anzar.Auth.login({ email, password });
+    console.log(data);
+} catch (e) {
+    const message = e.response?.data?.message ?? "An unknown error occurred";
+    console.log(message);
+}

package/dist/adapters/index.cjs

@@ -0,0 +1,70 @@
+"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/adapters/index.ts
+var adapters_exports = {};
+__export(adapters_exports, {
+  LocalStorage: () => LocalStorage,
+  MemoryStorage: () => MemoryStorage
+});
+module.exports = __toCommonJS(adapters_exports);
+
+// src/adapters/local_storage.ts
+var LocalStorage = class {
+  getToken() {
+    return localStorage.getItem("AccessToken");
+  }
+  getRefreshToken() {
+    return localStorage.getItem("RefreshToken");
+  }
+  onTokenRefresh(tokens) {
+    localStorage.setItem("AccessToken", tokens.access);
+    localStorage.setItem("RefreshToken", tokens.refresh);
+  }
+  onSessionExpired() {
+    localStorage.clear();
+  }
+  onLogout() {
+    localStorage.clear();
+  }
+};
+
+// src/adapters/memory_storage.ts
+var MemoryStorage = class {
+  acessToken = null;
+  refreshToken = null;
+  getToken() {
+    return this.acessToken;
+  }
+  getRefreshToken() {
+    return this.refreshToken;
+  }
+  onTokenRefresh(tokens) {
+    this.acessToken = tokens.access;
+    this.refreshToken = tokens.refresh;
+  }
+  onSessionExpired() {
+    this.acessToken = null;
+    this.refreshToken = null;
+  }
+  onLogout() {
+    this.acessToken = null;
+    this.refreshToken = null;
+  }
+};

package/dist/adapters/index.d.cts

@@ -0,0 +1,21 @@
+import { B as BaseStorage, S as SessionTokens } from '../base_storage-BnHsA4fU.cjs';
+
+declare class LocalStorage implements BaseStorage {
+    getToken(): string | null;
+    getRefreshToken(): string | null;
+    onTokenRefresh(tokens: SessionTokens): void;
+    onSessionExpired?(): void;
+    onLogout?(): void;
+}
+
+declare class MemoryStorage implements BaseStorage {
+    private acessToken;
+    private refreshToken;
+    getToken(): string | null;
+    getRefreshToken(): string | null;
+    onTokenRefresh(tokens: SessionTokens): void;
+    onSessionExpired?(): void;
+    onLogout?(): void;
+}
+
+export { LocalStorage, MemoryStorage };

package/dist/adapters/index.d.ts

@@ -0,0 +1,21 @@
+import { B as BaseStorage, S as SessionTokens } from '../base_storage-BnHsA4fU.js';
+
+declare class LocalStorage implements BaseStorage {
+    getToken(): string | null;
+    getRefreshToken(): string | null;
+    onTokenRefresh(tokens: SessionTokens): void;
+    onSessionExpired?(): void;
+    onLogout?(): void;
+}
+
+declare class MemoryStorage implements BaseStorage {
+    private acessToken;
+    private refreshToken;
+    getToken(): string | null;
+    getRefreshToken(): string | null;
+    onTokenRefresh(tokens: SessionTokens): void;
+    onSessionExpired?(): void;
+    onLogout?(): void;
+}
+
+export { LocalStorage, MemoryStorage };

package/dist/adapters/index.js

@@ -0,0 +1,27 @@
+import {
+  MemoryStorage
+} from "../chunk-5SSEPZKA.js";
+
+// src/adapters/local_storage.ts
+var LocalStorage = class {
+  getToken() {
+    return localStorage.getItem("AccessToken");
+  }
+  getRefreshToken() {
+    return localStorage.getItem("RefreshToken");
+  }
+  onTokenRefresh(tokens) {
+    localStorage.setItem("AccessToken", tokens.access);
+    localStorage.setItem("RefreshToken", tokens.refresh);
+  }
+  onSessionExpired() {
+    localStorage.clear();
+  }
+  onLogout() {
+    localStorage.clear();
+  }
+};
+export {
+  LocalStorage,
+  MemoryStorage
+};

package/dist/base_storage-BnHsA4fU.d.cts

@@ -0,0 +1,30 @@
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * SessionTokens model
+ */
+interface SessionTokens {
+    'access': string;
+    'expires_in': number;
+    'refresh': string;
+    'token_type': string;
+}
+
+interface BaseStorage {
+    getToken(): string | null;
+    getRefreshToken(): string | null;
+    onTokenRefresh(tokens: SessionTokens): void;
+    onSessionExpired?(): void;
+    onLogout?(): void;
+}
+
+export type { BaseStorage as B, SessionTokens as S };

package/dist/base_storage-BnHsA4fU.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * SessionTokens model
+ */
+interface SessionTokens {
+    'access': string;
+    'expires_in': number;
+    'refresh': string;
+    'token_type': string;
+}
+
+interface BaseStorage {
+    getToken(): string | null;
+    getRefreshToken(): string | null;
+    onTokenRefresh(tokens: SessionTokens): void;
+    onSessionExpired?(): void;
+    onLogout?(): void;
+}
+
+export type { BaseStorage as B, SessionTokens as S };

package/dist/chunk-5SSEPZKA.js

@@ -0,0 +1,27 @@
+// src/adapters/memory_storage.ts
+var MemoryStorage = class {
+  acessToken = null;
+  refreshToken = null;
+  getToken() {
+    return this.acessToken;
+  }
+  getRefreshToken() {
+    return this.refreshToken;
+  }
+  onTokenRefresh(tokens) {
+    this.acessToken = tokens.access;
+    this.refreshToken = tokens.refresh;
+  }
+  onSessionExpired() {
+    this.acessToken = null;
+    this.refreshToken = null;
+  }
+  onLogout() {
+    this.acessToken = null;
+    this.refreshToken = null;
+  }
+};
+
+export {
+  MemoryStorage
+};

package/dist/index-BZFSacf5.d.cts

@@ -0,0 +1,63 @@
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+declare const Role: {
+    readonly User: "User";
+    readonly Admin: "Admin";
+};
+type Role = typeof Role[keyof typeof Role];
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface User {
+    '_id'?: string | null;
+    'createdAt': string;
+    'email': string;
+    'role': Role;
+    'username': string;
+    'verified': boolean;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Verification model
+ */
+interface Verification {
+    'link': string;
+    'token': string;
+}
+
+interface AuthResult {
+    user: User;
+    verification?: Verification | null;
+}
+
+export type { AuthResult as A, User as U, Verification as V };

package/dist/index-BZFSacf5.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+declare const Role: {
+    readonly User: "User";
+    readonly Admin: "Admin";
+};
+type Role = typeof Role[keyof typeof Role];
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface User {
+    '_id'?: string | null;
+    'createdAt': string;
+    'email': string;
+    'role': Role;
+    'username': string;
+    'verified': boolean;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Verification model
+ */
+interface Verification {
+    'link': string;
+    'token': string;
+}
+
+interface AuthResult {
+    user: User;
+    verification?: Verification | null;
+}
+
+export type { AuthResult as A, User as U, Verification as V };