@ministerjs/auth 1.0.0

package/README.md

@@ -0,0 +1,121 @@
+# @ministerjs/auth
+
+Classe para gerenciar autenticação de usuários em aplicações Vue.
+
+## Instalação
+
+```bash
+pnpm add @ministerjs/auth
+```
+
+## Importação
+
+```ts
+import { Auth } from "@ministerjs/auth/Auth";
+
+```
+
+## Exemplo de Uso
+
+```ts
+import { Auth } from "@ministerjs/auth/Auth";
+
+const auth = new Auth({
+  fetch: window.fetch.bind(window),
+  mapUser: (user) => {
+    // Transformar ou filtrar dados do usuário antes de salvar
+    return {
+      ...user,
+      fullName: `${user.firstName} ${user.lastName}`,
+    };
+  },
+  routes: {
+    login: "/api/login",
+    checkIn: "/api/checkin",
+    logout: "/api/logout",
+  },
+  afterLogout: () => {
+    // Ações após fazer logout
+    console.log("Usuário deslogado!");
+  },
+  afterCheckIn: (result) => {
+    // Ações após verificação do estado de login
+    console.log("CheckIn foi bem-sucedido?", result);
+  },
+});
+```
+
+### Atributos Importantes
+
+- **`auth.user`**: contém os dados do usuário autenticado (ou `null` se não autenticado).
+- **`auth.on`**: booleano que indica se o usuário está logado (`true`/`false`).
+- **`auth.loading`**: booleano que indica se há uma operação de login, checkIn ou logout em andamento.
+- **`auth.checkedIn`**: booleano que indica se o `checkIn()` já foi executado.
+
+### Métodos
+
+#### `login(payload: Record<string, any>)`
+
+- Faz a chamada de login para a rota configurada em `routes.login`.
+- Ao receber resposta:
+  - Define `auth.on` como `true`.
+  - Armazena o usuário em `auth.user`.
+  - Define `auth.loading` como `false`.
+
+**Exemplo**:
+```ts
+await auth.login({ username: "john", password: "1234" });
+console.log(auth.user.value); // Dados do usuário logado
+```
+
+#### `checkIn()`
+
+- Verifica se o usuário já está autenticado (ex.: mantém a sessão em abas novas).
+- Atualiza `auth.user` e `auth.on` conforme o resultado.
+- Chama o callback `afterCheckIn(true|false)` dependendo do sucesso ou falha na verificação.
+- Atualiza `auth.checkedIn` para `true` quando finaliza.
+
+**Exemplo**:
+```ts
+await auth.checkIn();
+console.log(auth.on.value);         // true ou false
+console.log(auth.checkedIn.value);  // true
+```
+
+#### `logout()`
+
+- Faz a chamada de logout para a rota configurada em `routes.logout`.
+- Define `auth.on` como `false`, limpa `auth.user` e chama `afterLogout()` após concluir.
+
+**Exemplo**:
+```ts
+await auth.logout();
+console.log(auth.on.value); // false
+console.log(auth.user.value); // null
+```
+
+### Opções do Construtor
+
+- **`fetch: Fetch`**  
+  Instância de Fetch responsável pelas requisições HTTP.
+
+- **`mapUser?: (user: User) => User`**  
+  Callback para ajustar dados do usuário antes de armazenar em `auth.user`.
+
+- **`routes?: { login?: string; checkIn?: string; logout?: string; }`**  
+  Rotas customizadas para as operações de login, checkIn e logout.
+
+- **`afterLogout?: () => void | Promise<void>`**  
+  Executado logo após o logout.
+
+- **`afterCheckIn?: (result: boolean) => void | Promise<void>`**  
+  Executado após a tentativa de checkIn, recebendo `true` ou `false` como resultado.
+
+  
+## Rotas do Backend
+
+Para que a classe Auth funcione corretamente, o backend deve expor as rotas (por padrão: `/api/login`, `/api/checkin`, `/api/logout`). 
+
+- **Login**: recebe as credenciais no corpo da requisição, valida e retorna `{ message, data }`.
+- **CheckIn**: verifica a sessão e retorna `{ message, data }` se o usuário estiver autenticado, ou algum erro/status caso não esteja.
+- **Logout**: invalida a sessão/tokens e retorna `{ message }`.

package/dist/Auth.d.mts

@@ -0,0 +1,51 @@
+import { Ref } from 'vue';
+
+type Methods = "get" | "post" | "put" | "patch" | "delete";
+
+interface FetchOptions<T> {
+  method?: Methods | Uppercase<Methods>;
+  body?: RequestInit["body"];
+  query?: Record<string, any>;
+  transform?: (data: any) => T;
+}
+
+interface FetchResponse<T> {
+  ok: boolean;
+  json(): Promise<T>;
+}
+
+type Fetch = <T>(
+  url: string,
+  options?: FetchOptions<T>,
+) => Promise<FetchResponse<T>>;
+
+interface Options<User extends Record<string, any>> {
+    fetch: Fetch;
+    mapUser?: (user: User) => User;
+    routes?: {
+        signUp?: string;
+        login?: string;
+        checkIn?: string;
+        logout?: string;
+    };
+    afterLogout: () => void | Promise<void>;
+    afterCheckIn: (result: boolean) => void | Promise<void>;
+}
+declare class Auth<User extends Record<string, any>> {
+    user: Ref<Partial<User> | null>;
+    on: Ref<boolean, boolean>;
+    loading: Ref<boolean, boolean>;
+    checkedIn: Ref<boolean, boolean>;
+    private fetch;
+    private mapUser;
+    private afterLogout;
+    private afterCheckIn;
+    private routes;
+    constructor({ fetch, mapUser, routes, afterLogout, afterCheckIn, }: Options<User>);
+    login(payload: Record<string, any>): Promise<void>;
+    checkIn(): Promise<void>;
+    logout(): Promise<void>;
+    private setUser;
+}
+
+export { Auth, type Fetch, type FetchOptions, type FetchResponse };

package/dist/Auth.d.ts

@@ -0,0 +1,51 @@
+import { Ref } from 'vue';
+
+type Methods = "get" | "post" | "put" | "patch" | "delete";
+
+interface FetchOptions<T> {
+  method?: Methods | Uppercase<Methods>;
+  body?: RequestInit["body"];
+  query?: Record<string, any>;
+  transform?: (data: any) => T;
+}
+
+interface FetchResponse<T> {
+  ok: boolean;
+  json(): Promise<T>;
+}
+
+type Fetch = <T>(
+  url: string,
+  options?: FetchOptions<T>,
+) => Promise<FetchResponse<T>>;
+
+interface Options<User extends Record<string, any>> {
+    fetch: Fetch;
+    mapUser?: (user: User) => User;
+    routes?: {
+        signUp?: string;
+        login?: string;
+        checkIn?: string;
+        logout?: string;
+    };
+    afterLogout: () => void | Promise<void>;
+    afterCheckIn: (result: boolean) => void | Promise<void>;
+}
+declare class Auth<User extends Record<string, any>> {
+    user: Ref<Partial<User> | null>;
+    on: Ref<boolean, boolean>;
+    loading: Ref<boolean, boolean>;
+    checkedIn: Ref<boolean, boolean>;
+    private fetch;
+    private mapUser;
+    private afterLogout;
+    private afterCheckIn;
+    private routes;
+    constructor({ fetch, mapUser, routes, afterLogout, afterCheckIn, }: Options<User>);
+    login(payload: Record<string, any>): Promise<void>;
+    checkIn(): Promise<void>;
+    logout(): Promise<void>;
+    private setUser;
+}
+
+export { Auth, type Fetch, type FetchOptions, type FetchResponse };

package/dist/Auth.js

@@ -0,0 +1,116 @@
+"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/Auth.ts
+var Auth_exports = {};
+__export(Auth_exports, {
+  Auth: () => Auth
+});
+module.exports = __toCommonJS(Auth_exports);
+var import_vue = require("vue");
+var Auth = class {
+  user = (0, import_vue.ref)(null);
+  on = (0, import_vue.ref)(false);
+  loading = (0, import_vue.ref)(false);
+  checkedIn = (0, import_vue.ref)(false);
+  fetch;
+  mapUser;
+  afterLogout;
+  afterCheckIn;
+  routes = {
+    login: "/api/login",
+    checkIn: "/api/checkin",
+    logout: "/api/logout"
+  };
+  constructor({
+    fetch,
+    mapUser,
+    routes,
+    afterLogout,
+    afterCheckIn
+  }) {
+    this.fetch = fetch;
+    this.mapUser = mapUser ?? ((user) => user);
+    this.afterLogout = afterLogout ?? (() => {
+    });
+    this.afterCheckIn = afterCheckIn ?? (() => {
+    });
+    if (routes) {
+      Object.assign(this.routes, routes);
+    }
+  }
+  async login(payload) {
+    this.loading.value = true;
+    const response = await this.fetch(this.routes.login, {
+      method: "POST",
+      body: JSON.stringify(payload)
+    });
+    this.on.value = true;
+    const { data } = await response.json();
+    this.setUser(data);
+    this.loading.value = false;
+  }
+  async checkIn() {
+    this.loading.value = true;
+    try {
+      const response = await this.fetch(this.routes.checkIn, {
+        method: "POST"
+      });
+      const { data } = await response.json();
+      this.setUser(data);
+      this.on.value = true;
+      this.afterCheckIn(true);
+    } catch {
+      this.afterCheckIn(false);
+    } finally {
+      this.loading.value = false;
+      this.checkedIn.value = true;
+    }
+  }
+  async logout() {
+    this.loading.value = true;
+    try {
+      await this.fetch(this.routes.logout, {
+        method: "POST"
+      });
+      this.on.value = false;
+      this.setUser(null);
+      await this.afterLogout();
+    } finally {
+      this.loading.value = false;
+    }
+  }
+  setUser = (data) => {
+    if (data === null || data === void 0) {
+      this.user.value = null;
+      return;
+    }
+    const parsedData = this.mapUser(data);
+    if (this.user.value === null) {
+      this.user.value = {};
+    }
+    for (const key in parsedData) {
+      this.user.value[key] = parsedData[key];
+    }
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Auth
+});

package/dist/Auth.mjs

@@ -0,0 +1,91 @@
+// src/Auth.ts
+import { ref } from "vue";
+var Auth = class {
+  user = ref(null);
+  on = ref(false);
+  loading = ref(false);
+  checkedIn = ref(false);
+  fetch;
+  mapUser;
+  afterLogout;
+  afterCheckIn;
+  routes = {
+    login: "/api/login",
+    checkIn: "/api/checkin",
+    logout: "/api/logout"
+  };
+  constructor({
+    fetch,
+    mapUser,
+    routes,
+    afterLogout,
+    afterCheckIn
+  }) {
+    this.fetch = fetch;
+    this.mapUser = mapUser ?? ((user) => user);
+    this.afterLogout = afterLogout ?? (() => {
+    });
+    this.afterCheckIn = afterCheckIn ?? (() => {
+    });
+    if (routes) {
+      Object.assign(this.routes, routes);
+    }
+  }
+  async login(payload) {
+    this.loading.value = true;
+    const response = await this.fetch(this.routes.login, {
+      method: "POST",
+      body: JSON.stringify(payload)
+    });
+    this.on.value = true;
+    const { data } = await response.json();
+    this.setUser(data);
+    this.loading.value = false;
+  }
+  async checkIn() {
+    this.loading.value = true;
+    try {
+      const response = await this.fetch(this.routes.checkIn, {
+        method: "POST"
+      });
+      const { data } = await response.json();
+      this.setUser(data);
+      this.on.value = true;
+      this.afterCheckIn(true);
+    } catch {
+      this.afterCheckIn(false);
+    } finally {
+      this.loading.value = false;
+      this.checkedIn.value = true;
+    }
+  }
+  async logout() {
+    this.loading.value = true;
+    try {
+      await this.fetch(this.routes.logout, {
+        method: "POST"
+      });
+      this.on.value = false;
+      this.setUser(null);
+      await this.afterLogout();
+    } finally {
+      this.loading.value = false;
+    }
+  }
+  setUser = (data) => {
+    if (data === null || data === void 0) {
+      this.user.value = null;
+      return;
+    }
+    const parsedData = this.mapUser(data);
+    if (this.user.value === null) {
+      this.user.value = {};
+    }
+    for (const key in parsedData) {
+      this.user.value[key] = parsedData[key];
+    }
+  };
+};
+export {
+  Auth
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@ministerjs/auth",
+  "version": "1.0.0",
+  "license": "UNLICENSED",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/*"
+  ],
+  "exports": {
+    "./Auth": {
+      "types": "./dist/Auth.d.ts",
+      "import": "./dist/Auth.mjs",
+      "require": "./dist/Auth.js"
+    }
+  },
+  "peerDependencies": {
+    "vue": "^3.5.12"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.14.0",
+    "@ministerjs/build": "^2.0.2",
+    "@types/node": "^22.13.5",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "globals": "^15.12.0",
+    "prettier": "3.5.3",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.3",
+    "typescript": "latest",
+    "typescript-eslint": "^8.12.2",
+    "vue": "^3.5.12"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "lint": "eslint ./src --fix",
+    "build": "pnpm lint && tsup",
+    "release": "pnpm publish --no-git-checks"
+  }
+}