@mapomodule/core 1.0.0 → 2.0.0-beta.2

package/src/runtime/plugins/00.fetch.ts

@@ -0,0 +1,85 @@
+import { ref, computed } from "vue";
+import {
+  defineNuxtPlugin,
+  navigateTo,
+  useRoute,
+  useRuntimeConfig,
+} from "nuxt/app";
+import { useAuthStore } from "@mapomodule/store/runtime/stores/auth";
+import { useSnackStore } from "@mapomodule/store/runtime/stores/snack";
+import type { MapoCoreRuntimeConfig } from "../types";
+
+/**
+ * Registers the global Mapo fetch client and loading state.
+ *
+ * The plugin provides:
+ * - `$mapoFetch`: a shared `$fetch` instance with centralized request/response hooks.
+ * - `$mapoFetchLoading`: a computed boolean based on a global pending-request counter.
+ *
+ * Error handling behavior:
+ * - `401` (except logout calls): reset auth state and, on client, redirect to login
+ *   with the current route encoded in a `redirect` query parameter.
+ * - `403`: show a global "Permission denied" error snackbar.
+ */
+export default defineNuxtPlugin({
+  name: "mapo-core:fetch",
+  enforce: "pre",
+  setup() {
+    const rc = useRuntimeConfig().public.mapoCore as MapoCoreRuntimeConfig;
+    const logoutUrl = rc.logoutUrl;
+    const loginUrl = rc.loginUrl;
+
+    // Track whether a 401 redirect is already in flight to prevent duplicate redirects.
+    let redirectInFlight = false;
+
+    const handle = (status: number, requestUrl: string) => {
+      if (
+        status === 401 &&
+        !requestUrl.includes(logoutUrl) &&
+        !redirectInFlight
+      ) {
+        redirectInFlight = true;
+        const auth = useAuthStore();
+        auth.reset();
+        if (import.meta.client) {
+          const route = useRoute();
+          navigateTo(
+            `${loginUrl}?redirect=${encodeURIComponent(route.fullPath)}`,
+          );
+        }
+      }
+      if (status === 403) {
+        useSnackStore().show("Permission denied", "error");
+      }
+    };
+
+    // Global loading counter — incremented on every request, decremented once on every
+    // response (success or error) or request error. Exposed as $mapoFetchLoading so any
+    // component can show a spinner without wrapping every fetch call manually.
+    const pending = ref(0);
+    const mapoFetchLoading = computed(() => pending.value > 0);
+
+    const mapoFetch = $fetch.create({
+      onRequest() {
+        pending.value++;
+      },
+      onResponse({ response, request }) {
+        pending.value--;
+        handle(response.status, String(request));
+      },
+      onResponseError({ response, request, error }) {
+        pending.value--;
+        handle(response?.status ?? 0, String(request));
+        return Promise.reject(error);
+      },
+      onRequestError() {
+        // Decrement counter on network errors (no response received).
+        pending.value--;
+      },
+    });
+
+    return {
+      provide: { mapoFetch, mapoFetchLoading },
+    };
+  },
+});

package/src/runtime/plugins/01.init.server.ts

@@ -0,0 +1,62 @@
+import {
+  defineNuxtPlugin,
+  useRuntimeConfig,
+  useCookie,
+  useRequestHeaders,
+  useRequestURL,
+} from "nuxt/app";
+import { setActivePinia } from "pinia";
+import type { Pinia } from "pinia";
+import { useAuthStore } from "@mapomodule/store/runtime/stores/auth";
+import { useSidebarStore } from "@mapomodule/store/runtime/stores/sidebar";
+import type { MapoUser } from "@mapomodule/store/runtime/types";
+import { CoreCookieEnum } from "../types";
+import type { MapoCoreRuntimeConfig } from "../types";
+
+/**
+ * Performs server-side bootstrap of Mapo runtime stores.
+ *
+ * On each SSR request, this plugin:
+ * - Activates the request Pinia instance and initializes auth/sidebar stores.
+ * - Restores sidebar UI state from cookies.
+ * - If the HttpOnly session cookie is present, calls the configured `userInfoApi`
+ *   (forwarding request cookies) to restore the authenticated user in the auth store.
+ *
+ * On session restore failure, it resets auth state and clears the session cookie.
+ */
+export default defineNuxtPlugin({
+  name: "mapo-core:init",
+  async setup(nuxtApp) {
+    const runtimeConfig = useRuntimeConfig().public.mapoCore as
+      | MapoCoreRuntimeConfig
+      | undefined;
+    const userInfoApi = runtimeConfig?.userInfoApi ?? "/api/profiles/me/";
+
+    const pinia = nuxtApp.$pinia as Pinia;
+    setActivePinia(pinia);
+    const authStore = useAuthStore(pinia);
+    const sidebarStore = useSidebarStore(pinia);
+
+    sidebarStore.hydrateFromCookies();
+
+    // The session cookie is HttpOnly — readable on SSR but not on the client.
+    // If present, hydrate the auth store by fetching the user with the
+    // incoming Cookie header forwarded to the proxy middleware.
+    const sessionCookie = useCookie(CoreCookieEnum.Session);
+    if (!sessionCookie.value) return;
+
+    try {
+      const headers = useRequestHeaders(["cookie"]);
+      const url = useRequestURL();
+      const absolute = `${url.protocol}//${url.host}${userInfoApi}`;
+      const user = await (
+        nuxtApp.$mapoFetch as (url: string, opts: object) => Promise<unknown>
+      )(absolute, { method: "GET", headers });
+      authStore.setUser(user as MapoUser);
+    } catch (e) {
+      console.error(`[mapo] Cannot restore session from cookie:\n${e}`);
+      authStore.reset();
+      sessionCookie.value = null;
+    }
+  },
+});

package/src/runtime/types.nuxt.d.ts

@@ -0,0 +1,18 @@
+import type { $Fetch } from "ofetch";
+
+declare module "nuxt/app" {
+  interface NuxtApp {
+    $mapoFetch: $Fetch;
+  }
+}
+
+declare module "vue-router" {
+  interface RouteMeta {
+    permissions?: { model: string } | string[];
+    roles?: string[];
+    /** Route middleware names applied to this route. Read by useCanAccessRoute for sidebar visibility. */
+    middleware?: string | string[];
+  }
+}
+
+export {};

package/src/runtime/types.ts

@@ -0,0 +1,88 @@
+export enum MultipartPolicyEnum {
+  Auto = "auto",
+  Force = "force",
+  Disable = "disable",
+}
+
+export type MultipartPolicy = `${MultipartPolicyEnum}`;
+
+export enum CoreCookieEnum {
+  Session = "__mapo_session",
+}
+
+export interface ListParams {
+  page?: number;
+  limit?: number;
+  search?: string;
+  ordering?: string;
+  [key: string]: unknown;
+}
+
+export interface PaginatedResponse<T> {
+  results: T[];
+  count: number;
+  next?: string | null;
+  previous?: string | null;
+}
+
+export type ApiResponse<T> = T;
+
+export interface CrudConfig {
+  baseURL?: string;
+  headers?: Record<string, string>;
+  [key: string]: unknown;
+}
+
+export interface CrudOptions {
+  multipart?: MultipartPolicy;
+}
+
+export interface CrudRepository<T> {
+  list(params?: ListParams, config?: CrudConfig): Promise<PaginatedResponse<T>>;
+  detail(id: string | number, config?: CrudConfig): Promise<T>;
+  create(data: Partial<T>, config?: CrudConfig, opts?: CrudOptions): Promise<T>;
+  update(
+    id: string | number,
+    data: Partial<T>,
+    config?: CrudConfig,
+    opts?: CrudOptions,
+  ): Promise<T>;
+  partialUpdate(
+    id: string | number,
+    diff: Partial<T>,
+    config?: CrudConfig,
+    opts?: CrudOptions,
+  ): Promise<T>;
+  delete(id: string | number, config?: CrudConfig): Promise<void>;
+  updateOrCreate(
+    data: Partial<T> & { id?: string | number },
+    config?: CrudConfig,
+    opts?: CrudOptions,
+  ): Promise<T>;
+  updateOrder(
+    startId: string | number,
+    endId: string | number,
+    config?: CrudConfig,
+  ): Promise<void>;
+}
+
+export interface Credentials {
+  username: string;
+  password: string;
+}
+
+export interface AuthToken {
+  token: string;
+  [key: string]: unknown;
+}
+
+/**
+ * Shape of `runtimeConfig.public.mapoCore` as written by the module setup.
+ * All entries are guaranteed by the module `defaults`.
+ */
+export interface MapoCoreRuntimeConfig {
+  authLoginUrl: string;
+  userInfoApi: string;
+  logoutUrl: string;
+  loginUrl: string;
+}

package/src/runtime/utils/useMapoFetch.ts

@@ -0,0 +1,41 @@
+import { useNuxtApp } from "nuxt/app";
+import type { $Fetch } from "ofetch";
+import type { ComputedRef } from "vue";
+
+export interface UseMapoFetchReturn {
+  /** The auth-aware `$mapoFetch` instance (same one provided by the plugin). */
+  fetch: $Fetch;
+  /**
+   * `true` while at least one `$mapoFetch` request is in flight — globally,
+   * across the entire app. Incremented by the plugin-level `onRequest` hook
+   * and decremented by `onResponse` / `onResponseError`, so it stays accurate
+   * even for raw `useNuxtApp().$mapoFetch` calls outside this composable.
+   */
+  loading: ComputedRef<boolean>;
+}
+
+/**
+ * Returns the global `$mapoFetch` instance together with a centralized
+ * `loading` indicator that tracks **all** in-flight `$mapoFetch` requests,
+ * not just the ones made through this composable.
+ *
+ * @example
+ * ```ts
+ * const { fetch, loading } = useMapoFetch()
+ * await fetch('/api/articles/', { method: 'POST', body: payload })
+ * ```
+ *
+ * ```vue
+ * <UButton :loading="loading" @click="submit">Save</UButton>
+ * ```
+ */
+export function useMapoFetch(): UseMapoFetchReturn {
+  const nuxt = useNuxtApp() as unknown as {
+    $mapoFetch: $Fetch;
+    $mapoFetchLoading: ComputedRef<boolean>;
+  };
+  return {
+    fetch: nuxt.$mapoFetch,
+    loading: nuxt.$mapoFetchLoading,
+  };
+}

package/src/types.ts

@@ -0,0 +1,13 @@
+export interface MapoOptions {
+  authLoginUrl?: string;
+  userInfoApi?: string;
+  logoutUrl?: string;
+  loginUrl?: string;
+}
+
+export const MAPO_DEFAULTS = {
+  authLoginUrl: "/api/auth/login",
+  userInfoApi: "/api/profiles/me/",
+  logoutUrl: "/api/auth/logout",
+  loginUrl: "/login",
+} satisfies Required<MapoOptions>;

package/CHANGELOG.md

@@ -1,248 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [1.0.0](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.60...v1.0.0) (2026-07-02)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.49](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.48...v1.0.0-alpha.49) (2023-07-27)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.45](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.44...v1.0.0-alpha.45) (2023-06-10)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.44](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.43...v1.0.0-alpha.44) (2023-06-10)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.43](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.42...v1.0.0-alpha.43) (2023-02-02)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.41](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.40...v1.0.0-alpha.41) (2022-12-20)
-
-
-### Features
-
-* handle all_permissions prop in user ([14d4252](https://github.com/lotrekagency/mapo/commit/14d425215434e29f82093fc96e53b172bf247b8f))
-
-
-
-
-
-# [1.0.0-alpha.40](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.39...v1.0.0-alpha.40) (2022-12-20)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.39](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.38...v1.0.0-alpha.39) (2022-12-03)
-
-
-### Features
-
-* give the option to rewrite form fields components defaults in nuxt.config.js ([c4e76b1](https://github.com/lotrekagency/mapo/commit/c4e76b153b145cc670ef988e9501e1a8fbc0005e))
-
-
-
-
-
-# [1.0.0-alpha.34](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.33...v1.0.0-alpha.34) (2022-11-11)
-
-
-### Features
-
-* default upload in multipart autodiscover ([b153307](https://github.com/lotrekagency/mapo/commit/b15330725a64a0931d2de49929a01e3a7319b382))
-
-
-
-
-
-# [1.0.0-alpha.31](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.30...v1.0.0-alpha.31) (2022-09-14)
-
-
-### Bug Fixes
-
-* **interceptor:** remove token injection for axios requests ([59b2f5c](https://github.com/lotrekagency/mapo/commit/59b2f5cb3dfd0becd78df02f30bc32967643e276))
-* **middleware:** fix auth middleware to correclty redirect based on router base ([1d49cd7](https://github.com/lotrekagency/mapo/commit/1d49cd72e141888ef7aae91ac0ddb13f8d0fce7a))
-
-
-
-
-
-# [1.0.0-alpha.30](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.29...v1.0.0-alpha.30) (2022-09-13)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.27](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.26...v1.0.0-alpha.27) (2022-08-25)
-
-
-### Bug Fixes
-
-* remove unused options plugin ([45004bb](https://github.com/lotrekagency/mapo/commit/45004bb158267c7e2f7795c1d12cf568f9d7ded2))
-
-
-
-
-
-# [1.0.0-alpha.23](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.22...v1.0.0-alpha.23) (2022-05-04)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.22](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.21...v1.0.0-alpha.22) (2022-05-01)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.19](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.18...v1.0.0-alpha.19) (2022-04-06)
-
-
-### Bug Fixes
-
-* fix logout loop ([3177cca](https://github.com/lotrekagency/mapo/commit/3177ccaf4be6151feec379c4241f8784b79d4361))
-
-
-
-
-
-# [1.0.0-alpha.18](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.17...v1.0.0-alpha.18) (2022-04-04)
-
-
-### Bug Fixes
-
-* fix core interceptor syntax ([c546a48](https://github.com/lotrekagency/mapo/commit/c546a48f22bf689d4b679aaab82b2b9ed62f26cc))
-
-
-
-
-
-# [1.0.0-alpha.17](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.16...v1.0.0-alpha.17) (2022-04-03)
-
-
-### Bug Fixes
-
-* various fixes to auth loops ([58cdb58](https://github.com/lotrekagency/mapo/commit/58cdb586e88df8e595876ba4dd4d4cc11865f7e3))
-
-
-
-
-
-# [1.0.0-alpha.16](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.15...v1.0.0-alpha.16) (2022-04-03)
-
-
-### Features
-
-* Added mapo integrations module! 🎉 ([76d2c80](https://github.com/lotrekagency/mapo/commit/76d2c805245b4cf49a33696339da52e4c17f4053))
-* added mapo options to mapo helper ([38dcbf2](https://github.com/lotrekagency/mapo/commit/38dcbf28d286eb02c2a6785a883a14edaa0837b1))
-
-
-### BREAKING CHANGES
-
-* This change removes all the camomilla cms references moving the compatibility layer in a detached package [mapo-integrations-camomilla](https://github.com/lotrekagency/mapo-integrations-camomilla). The guidelines to make mapo work with camomilla will be provided in the package readme.
-
-
-
-
-
-# [1.0.0-alpha.15](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.14...v1.0.0-alpha.15) (2022-03-11)
-
-
-### Features
-
-* **ordering:** added sortablejs to drag and reorder list ([eb8bf21](https://github.com/lotrekagency/mapo/commit/eb8bf21c3178c3ad62db5aa7c06c0562e944dea6))
-
-
-
-
-
-# [1.0.0-alpha.13](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.12...v1.0.0-alpha.13) (2022-03-01)
-
-
-### Features
-
-* added snack message in the requst interceptor ([acf9cd1](https://github.com/lotrekagency/mapo/commit/acf9cd1efbabc13eb99af7f4bfe0dcf096112ec0))
-
-
-
-
-
-# [1.0.0-alpha.10](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.9...v1.0.0-alpha.10) (2022-02-11)
-
-
-### Bug Fixes
-
-* fix crud requests without multipart policy ([5875833](https://github.com/lotrekagency/mapo/commit/5875833209872a2609b653a089fff80c447b14e9))
-
-
-### Features
-
-* **core:** Completely rewritten multipart capabilities, now the crud helper autodiscovers whet to use a multipart request. ([0a6546c](https://github.com/lotrekagency/mapo/commit/0a6546c9adeaf1fcf57a88105101e476b8b786dc))
-
-
-
-
-
-# [1.0.0-alpha.9](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.8...v1.0.0-alpha.9) (2022-02-08)
-
-**Note:** Version bump only for package @mapomodule/core
-
-
-
-
-
-# [1.0.0-alpha.8](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.7...v1.0.0-alpha.8) (2022-01-23)
-
-
-### Bug Fixes
-
-* **auth:** logout user only on 401 ([818f3d5](https://github.com/lotrekagency/mapo/commit/818f3d5ff315635438ac9bc9566a1b2fd2c5cf03))
-* **permission:** fix bad store initialization on ssr ([f075824](https://github.com/lotrekagency/mapo/commit/f075824561d6a71ce07ecbba70e994102abd623b))
-* **permissions:** add route permissions with routename instead on path ([16ff6ee](https://github.com/lotrekagency/mapo/commit/16ff6eee5e3a8ddbf9e7aea1ba05e8a88fb43932))
-
-
-
-
-
-# [1.0.0-alpha.6](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.5...v1.0.0-alpha.6) (2021-12-26)
-
-
-### Features
-
-* **core:** reject promise for crud methods if no endpoint was passed during configuration ([bb8d447](https://github.com/lotrekagency/mapo/commit/bb8d4474efe41af5d7f38dbcd47731133d6ba154))