anzar 1.2.6 → 1.2.8

package/README.md

@@ -0,0 +1,94 @@
+# 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 title="vite.config.js" linenums="1"
+import yaml from "@rollup/plugin-yaml";
+
+export default {
+  plugins: [yaml()],
+};
+```
+```bash title="Shell Command"
+$ 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"
+// 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);
+```
+
+!!! danger
+    Only extend these functionality if you are using **JWT** authentication
+
+    :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,
+      ...
+    });
+    ```
+
+## Basic Usage
+Anzar provides authentication support for email and password.
+!!! Notes
+    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
+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
+
+### Sign In
+To sign in a user you need to call the method login.
+```typescript
+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/index.cjs

@@ -753,7 +753,7 @@ var Configuration = class {
 // src/http/jwt_interceptor.ts
 var JwtInterceptor = class {
   apply(axiosInstance, options) {
-    const REFRESH_URI = "/auth/refreshToken";
+    const REFRESH_URI = "/auth/refresh-token";
     axiosInstance.interceptors.request.use(
       (config) => {
         const accessToken = options?.getToken();
@@ -813,6 +813,7 @@ function Anzar(anzarConfig, options) {
     new JwtInterceptor().apply(axiosInstance, options);
   }
   const generatedAuthApi = new AuthApi(configuration, basePath, axiosInstance);
+  const generatedUserApi = new UsersApi(configuration, basePath, axiosInstance);
   return {
     Auth: {
       login: (body) => generatedAuthApi.login(body),
@@ -826,9 +827,17 @@ function Anzar(anzarConfig, options) {
       },
       ...anzarConfig.auth?.strategy === "Session" /* Session */ && {
         session: () => generatedAuthApi.getSession()
+      },
+      isAuthenticated: async () => {
+        try {
+          const response = await generatedUserApi.findUser();
+          return !!response.data;
+        } catch {
+          return false;
+        }
       }
     },
-    User: new UsersApi(configuration, basePath, axiosInstance),
+    User: generatedUserApi,
     Email: new EmailApi(configuration, basePath, axiosInstance)
   };
 }

package/dist/index.d.cts

@@ -399,6 +399,7 @@ interface SdkOptions {
 
 declare function Anzar(anzarConfig: AnzarConfig, options?: SdkOptions): {
     Auth: {
+        isAuthenticated: () => Promise<boolean>;
         session?: (() => Promise<axios.AxiosResponse<Session, any, {}>>) | undefined;
         login: (body: LoginRequest) => Promise<axios.AxiosResponse<AuthResponse, any, {}>>;
         register: (body: RegisterRequest) => Promise<axios.AxiosResponse<AuthResponse, any, {}>>;

package/dist/index.d.ts

@@ -399,6 +399,7 @@ interface SdkOptions {
 
 declare function Anzar(anzarConfig: AnzarConfig, options?: SdkOptions): {
     Auth: {
+        isAuthenticated: () => Promise<boolean>;
         session?: (() => Promise<axios.AxiosResponse<Session, any, {}>>) | undefined;
         login: (body: LoginRequest) => Promise<axios.AxiosResponse<AuthResponse, any, {}>>;
         register: (body: RegisterRequest) => Promise<axios.AxiosResponse<AuthResponse, any, {}>>;

package/dist/index.js

@@ -719,7 +719,7 @@ var Configuration = class {
 // src/http/jwt_interceptor.ts
 var JwtInterceptor = class {
   apply(axiosInstance, options) {
-    const REFRESH_URI = "/auth/refreshToken";
+    const REFRESH_URI = "/auth/refresh-token";
     axiosInstance.interceptors.request.use(
       (config) => {
         const accessToken = options?.getToken();
@@ -779,6 +779,7 @@ function Anzar(anzarConfig, options) {
     new JwtInterceptor().apply(axiosInstance, options);
   }
   const generatedAuthApi = new AuthApi(configuration, basePath, axiosInstance);
+  const generatedUserApi = new UsersApi(configuration, basePath, axiosInstance);
   return {
     Auth: {
       login: (body) => generatedAuthApi.login(body),
@@ -792,9 +793,17 @@ function Anzar(anzarConfig, options) {
       },
       ...anzarConfig.auth?.strategy === "Session" /* Session */ && {
         session: () => generatedAuthApi.getSession()
+      },
+      isAuthenticated: async () => {
+        try {
+          const response = await generatedUserApi.findUser();
+          return !!response.data;
+        } catch {
+          return false;
+        }
       }
     },
-    User: new UsersApi(configuration, basePath, axiosInstance),
+    User: generatedUserApi,
     Email: new EmailApi(configuration, basePath, axiosInstance)
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "anzar",
-	"version": "1.2.6",
+	"version": "1.2.8",
 	"description": "Anzar SDK",
 	"type": "module",
 	"main": "./dist/index.cjs",