anzar 1.2.8 → 1.2.10

package/README.md

@@ -2,61 +2,61 @@
 
 ## 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
-    ```
+
+**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 title="vite.config.js" linenums="1"
+```javascript 
 import yaml from "@rollup/plugin-yaml";
 
 export default {
   plugins: [yaml()],
 };
 ```
-```bash title="Shell Command"
+```bash 
 $ npm install -D @rollup/plugin-yaml
 ```
 
 in your main entry file (`main.ts` for example), import Anzar and create your auth instance
 
-```typescript title="main.ts" hl_lines="6" linenums="1"
+```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 = Anzar(anzarConfig);
+const anzar = new Anzar(anzarConfig);
 ```
 
-!!! danger
-    Only extend these functionality if you are using **JWT** authentication
+⚠️ **Note** 
+    Choose your token storage adapter
+
+```typescript 
+import { LocalStorage } from "anzar/adapters";
 
-    :warning: Implement a secure Storage solution
-    ```typescript linenums="1"
-    import { SessionTokens } from "anzar.types";
-    const anzar = Anzar(anzarConfig, {
-      getToken: () => "AccessToken",
-      getRefreshToken: () => "RefreshToken",
-      onTokenRefresh(tokens) =>  //store tokens.access, tokens.refresh,
-      ...
-    });
-    ```
+const anzar = new Anzar(anzarConfig, {
+    storage: new LocalStorage(),
+});
+```
 
 ## Basic Usage
 Anzar provides authentication support for email and password.
-!!! Notes
-    Other methods of authentication will be implemented later
+
+📝 **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.
@@ -64,20 +64,14 @@ To sign up a user you need to call the method register with the user's informati
 try {
     const response = await anzar.Auth.register({ username, email, password });
     const data: AuthResponse = response.data;
-    if (data.tokens) {
-        // Store securely the `access`,`refresh` tokens
-    }
 } catch (e) {
     const message = e.response?.data?.message ?? "An unknown error occurred";
     console.log(message);
 }
 ```
-See [`AuthResponse`](../reference#authresponse) for the full type definition.
-
-!!! notes "Notes"
-    By default, the users are automatically signed in after they successfully sign up.
 
-    Disabling this behavior will be implemented later
+📝 **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.
@@ -85,9 +79,6 @@ To sign in a user you need to call the method login.
 try {
     const response = await anzar.Auth.login({ email, password });
     const data: AuthResponse = response.data;
-    if (data.tokens) {
-        // Store securely the `access`,`refresh` tokens
-    }
 } 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-CQKHFbrb.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-CQKHFbrb.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-CQKHFbrb.d.cts

@@ -0,0 +1,25 @@
+/**
+ * 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 SessionTokens {
+    'access': string;
+    'refresh': 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-CQKHFbrb.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 SessionTokens {
+    'access': string;
+    'refresh': 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
+};