nuxt-openapi-hyperfetch 0.3.8-beta → 1.0.0

package/dist/generators/connectors/runtime/useCreateConnector.js

@@ -0,0 +1,156 @@
+// @ts-nocheck - This file runs in user's Nuxt project with different TypeScript config
+/**
+ * useCreateConnector — Runtime connector for POST endpoints.
+ *
+ * Uses $fetch directly (no useAsyncData) so:
+ * - execute() always fires a real network request, no SSR cache interference
+ * - Can be called multiple times (create multiple items)
+ * - Validates with Zod before sending
+ *
+ * Copied to the user's project alongside the generated connectors.
+ */
+import { ref, computed } from 'vue';
+import { mergeZodErrors } from './zod-error-merger.js';
+import { getGlobalBaseUrl, mergeCallbacks } from '../composables/shared/runtime/apiHelpers.js';
+/**
+ * @param url     The endpoint URL string. e.g. '/pet'
+ * @param options Configuration: schema, fields, method, baseURL, callbacks, etc.
+ */
+export function useCreateConnector(url, options = {}) {
+    const { schema: baseSchema, schemaOverride, fields = [], method = 'POST', baseURL: baseURLOpt, errorConfig = {}, onRequest: onRequestOpt, onSuccess: onSuccessOpt, onError: onErrorOpt, onFinish: onFinishOpt, autoClose = true, autoReset = false, skipGlobalCallbacks, } = options;
+    const baseURL = baseURLOpt || getGlobalBaseUrl();
+    if (!baseURL) {
+        console.warn('[useCreateConnector] No baseURL configured. Set runtimeConfig.public.apiBaseUrl in nuxt.config.ts or pass baseURL in options.');
+    }
+    // Resolve active schema: schemaOverride(base) / schemaOverride / base / none
+    const schema = schemaOverride
+        ? typeof schemaOverride === 'function'
+            ? schemaOverride(baseSchema)
+            : schemaOverride
+        : baseSchema;
+    if (schemaOverride && !schema) {
+        console.warn('[useCreateConnector] schemaOverride resolved to undefined — validation will be skipped. Check your schemaOverride function returns a valid Zod schema.');
+    }
+    // ── Form state ─────────────────────────────────────────────────────────────
+    const model = ref({});
+    const errors = ref({});
+    const loading = ref(false);
+    const error = ref(null);
+    const submitted = ref(false);
+    // Callbacks — developer-assignable (can also be passed as options)
+    // Both the connector-level option and the per-operation registration are called.
+    let _localOnSuccess = null;
+    let _localOnError = null;
+    // ── UI state ───────────────────────────────────────────────────────────────
+    const isOpen = ref(false);
+    const ui = {
+        isOpen,
+        open() {
+            isOpen.value = true;
+        },
+        close() {
+            isOpen.value = false;
+        },
+    };
+    // ── Derived ────────────────────────────────────────────────────────────────
+    const isValid = computed(() => {
+        if (!schema)
+            return true;
+        return schema.safeParse(model.value).success;
+    });
+    const hasErrors = computed(() => Object.keys(errors.value).length > 0);
+    // ── Actions ────────────────────────────────────────────────────────────────
+    function setValues(data) {
+        model.value = { ...model.value, ...data };
+    }
+    function setField(key, value) {
+        model.value = { ...model.value, [key]: value };
+    }
+    function reset() {
+        model.value = {};
+        errors.value = {};
+        error.value = null;
+        submitted.value = false;
+    }
+    /**
+     * Validate with Zod (if schema provided) then POST via $fetch.
+     * @param data Optional payload override. Falls back to model.value.
+     * @returns The response data, or undefined if validation failed.
+     */
+    async function execute(data) {
+        submitted.value = true;
+        const payload = data ?? model.value;
+        // 1. Zod validation
+        if (schema) {
+            const result = schema.safeParse(payload);
+            if (!result.success) {
+                errors.value = mergeZodErrors(result.error.flatten().fieldErrors, errorConfig);
+                console.error('[useCreateConnector] Validation failed — request was not sent.', errors.value);
+                return undefined;
+            }
+            errors.value = {};
+        }
+        // 2. $fetch POST
+        loading.value = true;
+        error.value = null;
+        // Merge global + local callbacks (onRequest modifications, rule-based suppression)
+        const merged = mergeCallbacks(url, method, {
+            onRequest: onRequestOpt,
+            onSuccess: onSuccessOpt,
+            onError: onErrorOpt,
+            onFinish: onFinishOpt,
+        }, skipGlobalCallbacks);
+        // onRequest hook — collects header/body/query modifications from global rules and local option
+        const requestMods = await merged.onRequest({ url, method, body: payload });
+        try {
+            const result = await $fetch(url, {
+                method,
+                body: requestMods?.body ?? payload,
+                ...(requestMods?.headers ? { headers: requestMods.headers } : {}),
+                ...(requestMods?.query ? { query: requestMods.query } : {}),
+                ...(baseURL ? { baseURL } : {}),
+            });
+            await merged.onSuccess(result, { operation: 'create' });
+            _localOnSuccess?.(result);
+            if (autoClose)
+                ui.close();
+            if (autoReset)
+                reset();
+            await merged.onFinish({ url, method, data: result, success: true });
+            return result;
+        }
+        catch (err) {
+            error.value = err;
+            await merged.onError(err, { operation: 'create' });
+            _localOnError?.(err);
+            await merged.onFinish({ url, method, error: err, success: false });
+            throw err;
+        }
+        finally {
+            loading.value = false;
+        }
+    }
+    // ── Return ─────────────────────────────────────────────────────────────────
+    return {
+        // Form state
+        model,
+        errors,
+        loading,
+        error,
+        submitted,
+        isValid,
+        hasErrors,
+        fields: computed(() => fields),
+        // Actions
+        execute,
+        refresh: execute,
+        reset,
+        setValues,
+        setField,
+        // Callbacks
+        onSuccess: (fn) => { _localOnSuccess = fn; },
+        onError: (fn) => { _localOnError = fn; },
+        // UI
+        ui,
+    };
+}

package/dist/generators/connectors/runtime/useDeleteConnector.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @param idFn    Function that extracts the resource ID from a staged item.
+ *                e.g. (item) => item.petId ?? item.id
+ * @param urlFn   URL string or function that receives an id and returns the URL string.
+ *                e.g. '/pet' (when ID is sent via body) or (id) => `/pet/${id}`
+ * @param options Optional configuration
+ */
+export declare function useDeleteConnector(idFn: any, urlFn: any, options?: {}): {
+    staged: any;
+    hasStaged: any;
+    loading: any;
+    error: any;
+    stage: (item: any) => void;
+    cancel: () => void;
+    execute: (item: any) => Promise<void>;
+    refresh: (item: any) => Promise<void>;
+    onSuccess: (fn: any) => void;
+    onError: (fn: any) => void;
+    ui: {
+        isOpen: any;
+        /**
+         * Stage the item and open the confirmation UI (modal/drawer/etc).
+         */
+        open(item: any): void;
+        /**
+         * Cancel and close the confirmation UI.
+         */
+        close(): void;
+    };
+};

package/dist/generators/connectors/runtime/useDeleteConnector.js

@@ -0,0 +1,143 @@
+// @ts-nocheck - This file runs in user's Nuxt project with different TypeScript config
+/**
+ * useDeleteConnector — Runtime connector for DELETE endpoints.
+ *
+ * Uses $fetch directly (no useAsyncData) so:
+ * - execute() always fires a real network request, no SSR cache interference
+ * - Supports staging pattern (stage → confirm via ui) or direct execution
+ *
+ * Copied to the user's project alongside the generated connectors.
+ */
+import { ref, computed } from 'vue';
+import { getGlobalBaseUrl, mergeCallbacks } from '../composables/shared/runtime/apiHelpers.js';
+/**
+ * @param idFn    Function that extracts the resource ID from a staged item.
+ *                e.g. (item) => item.petId ?? item.id
+ * @param urlFn   URL string or function that receives an id and returns the URL string.
+ *                e.g. '/pet' (when ID is sent via body) or (id) => `/pet/${id}`
+ * @param options Optional configuration
+ */
+export function useDeleteConnector(idFn, urlFn, options = {}) {
+    const resolveUrl = (id) => (typeof urlFn === 'function' ? urlFn(id) : urlFn);
+    const { baseURL: baseURLOpt, onRequest: onRequestOpt, onSuccess: onSuccessOpt, onError: onErrorOpt, onFinish: onFinishOpt, autoClose = true, skipGlobalCallbacks, } = options;
+    const baseURL = baseURLOpt || getGlobalBaseUrl();
+    if (!baseURL) {
+        console.warn('[useDeleteConnector] No baseURL configured. Set runtimeConfig.public.apiBaseUrl in nuxt.config.ts or pass baseURL in options.');
+    }
+    // ── State ──────────────────────────────────────────────────────────────────
+    const staged = ref(null);
+    const loading = ref(false);
+    const error = ref(null);
+    // Callbacks — developer-assignable (can also be passed as options)
+    // Both the connector-level option and the per-operation registration are called.
+    let _localOnSuccess = null;
+    let _localOnError = null;
+    // ── UI state ───────────────────────────────────────────────────────────────
+    const isOpen = ref(false);
+    const ui = {
+        isOpen,
+        /**
+         * Stage the item and open the confirmation UI (modal/drawer/etc).
+         */
+        open(item) {
+            stage(item);
+            isOpen.value = true;
+        },
+        /**
+         * Cancel and close the confirmation UI.
+         */
+        close() {
+            cancel();
+            isOpen.value = false;
+        },
+    };
+    // ── Derived ────────────────────────────────────────────────────────────────
+    const hasStaged = computed(() => staged.value !== null);
+    // ── Actions ────────────────────────────────────────────────────────────────
+    /**
+     * Stage an item for deletion without opening any UI.
+     * Useful when you want to control the UI yourself.
+     */
+    function stage(item) {
+        staged.value = item;
+    }
+    /**
+     * Clear the staged item and reset error state.
+     */
+    function cancel() {
+        staged.value = null;
+        error.value = null;
+    }
+    /**
+     * Execute the DELETE request.
+     * @param item Optional — if provided, uses this item instead of staged.
+     *             Allows direct deletion without staging: await del.execute(row)
+     */
+    async function execute(item) {
+        const target = item ?? staged.value;
+        if (!target) {
+            console.warn('[useDeleteConnector] execute() called with no item and nothing staged — request was not sent. Call stage(item) or pass the item directly to execute(item).');
+            return;
+        }
+        const id = idFn(target);
+        if (id === undefined || id === null) {
+            console.warn('[useDeleteConnector] idFn returned undefined/null — could not resolve resource ID. Request was not sent.', { target });
+            return;
+        }
+        const url = resolveUrl(id);
+        loading.value = true;
+        error.value = null;
+        // Merge global + local callbacks (onRequest modifications, rule-based suppression)
+        const merged = mergeCallbacks(url, 'DELETE', {
+            onRequest: onRequestOpt,
+            onSuccess: onSuccessOpt,
+            onError: onErrorOpt,
+            onFinish: onFinishOpt,
+        }, skipGlobalCallbacks);
+        // onRequest hook — collects header/body/query modifications
+        const requestMods = await merged.onRequest({ url, method: 'DELETE' });
+        try {
+            await $fetch(url, {
+                method: 'DELETE',
+                ...(requestMods?.headers ? { headers: requestMods.headers } : {}),
+                ...(requestMods?.query ? { query: requestMods.query } : {}),
+                ...(baseURL ? { baseURL } : {}),
+            });
+            const deletedItem = target;
+            await merged.onSuccess(deletedItem, { operation: 'delete' });
+            _localOnSuccess?.(deletedItem);
+            cancel();
+            if (autoClose)
+                ui.close();
+            await merged.onFinish({ url, method: 'DELETE', success: true });
+        }
+        catch (err) {
+            error.value = err;
+            await merged.onError(err, { operation: 'delete' });
+            _localOnError?.(err);
+            await merged.onFinish({ url, method: 'DELETE', error: err, success: false });
+            throw err;
+        }
+        finally {
+            loading.value = false;
+        }
+    }
+    // ── Return ─────────────────────────────────────────────────────────────────
+    return {
+        // State
+        staged,
+        hasStaged,
+        loading,
+        error,
+        // Actions
+        stage,
+        cancel,
+        execute,
+        refresh: execute,
+        // Callbacks
+        onSuccess: (fn) => { _localOnSuccess = fn; },
+        onError: (fn) => { _localOnError = fn; },
+        // UI
+        ui,
+    };
+}

package/dist/generators/connectors/runtime/useGetAllConnector.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @param factory   A zero-argument function that calls and returns the underlying
+ *                  useAsyncData composable, e.g. () => useAsyncDataGetPets(params)
+ *                  Called once during connector setup (inside setup()).
+ * @param options   Configuration for the connector
+ */
+export declare function useGetAllConnector(factory: any, options?: {}): {
+    items: any;
+    columns: any;
+    loading: any;
+    error: any;
+    pagination: any;
+    goToPage: (page: any) => void;
+    nextPage: () => void;
+    prevPage: () => void;
+    setPerPage: (n: any) => void;
+    selected: any;
+    select: (item: any) => void;
+    deselect: (item: any) => void;
+    toggleSelect: (item: any) => void;
+    clearSelection: () => void;
+    load: (_params: any) => Promise<void>;
+    onSuccess: any;
+    onError: any;
+};

package/dist/generators/connectors/runtime/useGetAllConnector.js

@@ -0,0 +1,127 @@
+// @ts-nocheck - This file runs in user's Nuxt project with different TypeScript config
+/**
+ * useGetAllConnector — Runtime connector for list/collection GET endpoints.
+ *
+ * Wraps a useAsyncData composable (reactive, SSR-compatible, supports pagination).
+ * The factory pattern means the composable is initialized in setup() context.
+ *
+ * Key differences from the old useListConnector:
+ * - items instead of rows
+ * - select/deselect/toggleSelect instead of onRowSelect
+ * - load(params?) instead of refresh()
+ * - No CRUD coordination methods (create/update/remove/_createTrigger etc.)
+ *   — coordination is the component's responsibility via callbacks
+ *
+ * Copied to the user's project alongside the generated connectors.
+ */
+import { ref, computed } from 'vue';
+/**
+ * @param factory   A zero-argument function that calls and returns the underlying
+ *                  useAsyncData composable, e.g. () => useAsyncDataGetPets(params)
+ *                  Called once during connector setup (inside setup()).
+ * @param options   Configuration for the connector
+ */
+export function useGetAllConnector(factory, options = {}) {
+    const { columns = [], columnLabels = {}, columnLabel = null } = options;
+    // ── Execute the underlying composable once (in setup context) ─────────────
+    const composable = factory();
+    // ── Derived state ──────────────────────────────────────────────────────────
+    const items = computed(() => {
+        const data = composable.data?.value;
+        if (!data)
+            return [];
+        // Support both direct arrays and { data: [...] } shapes (paginated APIs)
+        if (Array.isArray(data))
+            return data;
+        if (Array.isArray(data.data))
+            return data.data;
+        return [];
+    });
+    const loading = computed(() => composable.pending?.value ?? false);
+    const error = computed(() => composable.error?.value ?? null);
+    // Pagination — passthrough from the underlying composable when paginated: true
+    const pagination = computed(() => composable.pagination?.value ?? null);
+    function goToPage(page) {
+        composable.pagination?.value?.goToPage?.(page);
+    }
+    function nextPage() {
+        composable.pagination?.value?.nextPage?.();
+    }
+    function prevPage() {
+        composable.pagination?.value?.prevPage?.();
+    }
+    function setPerPage(n) {
+        composable.pagination?.value?.setPerPage?.(n);
+    }
+    // ── Selection ──────────────────────────────────────────────────────────────
+    const selected = ref([]);
+    function select(item) {
+        if (!selected.value.includes(item)) {
+            selected.value = [...selected.value, item];
+        }
+    }
+    function deselect(item) {
+        selected.value = selected.value.filter((r) => r !== item);
+    }
+    function toggleSelect(item) {
+        if (selected.value.includes(item)) {
+            deselect(item);
+        }
+        else {
+            select(item);
+        }
+    }
+    function clearSelection() {
+        selected.value = [];
+    }
+    // ── Callbacks — developer-assignable ──────────────────────────────────────
+    const onSuccess = ref(null);
+    const onError = ref(null);
+    // ── Load / refresh ─────────────────────────────────────────────────────────
+    /**
+     * Reload the list. Equivalent to refresh() on the underlying composable.
+     * @param _params Reserved for future use (reactive params are handled by
+     *                the underlying useAsyncData watch sources).
+     */
+    async function load(_params) {
+        await composable.refresh?.();
+        if (!composable.error?.value) {
+            onSuccess.value?.(items.value);
+        }
+        else {
+            onError.value?.(composable.error.value);
+        }
+    }
+    // ── Column label resolution ────────────────────────────────────────────────
+    const resolvedColumns = computed(() => columns.map((col) => ({
+        ...col,
+        label: columnLabel
+            ? columnLabel(col.key)
+            : (columnLabels[col.key] ?? col.label),
+    })));
+    // ── Return ─────────────────────────────────────────────────────────────────
+    return {
+        // State
+        items,
+        columns: resolvedColumns,
+        loading,
+        error,
+        // Pagination
+        pagination,
+        goToPage,
+        nextPage,
+        prevPage,
+        setPerPage,
+        // Selection
+        selected,
+        select,
+        deselect,
+        toggleSelect,
+        clearSelection,
+        // Actions
+        load,
+        // Callbacks
+        onSuccess,
+        onError,
+    };
+}

package/dist/generators/connectors/runtime/useGetConnector.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @param urlFn   URL string or function that receives an id and returns the URL string.
+ *                e.g. '/pet/me' or (id) => `/pet/${id}`
+ * @param options Optional configuration
+ */
+export declare function useGetConnector(urlFn: any, options?: {}): {
+    data: any;
+    loading: any;
+    error: any;
+    fields: any;
+    load: (id: any) => Promise<any>;
+    clear: () => void;
+    onSuccess: (fn: any) => void;
+    onError: (fn: any) => void;
+};

package/dist/generators/connectors/runtime/useGetConnector.js

@@ -0,0 +1,99 @@
+// @ts-nocheck - This file runs in user's Nuxt project with different TypeScript config
+/**
+ * useGetConnector — Runtime connector for single-item GET endpoints.
+ *
+ * Uses $fetch directly (no useAsyncData) so:
+ * - load(id) is truly imperative and awaitable
+ * - Returns the fetched item from load()
+ * - No SSR key registration, no cache interference
+ *
+ * Copied to the user's project alongside the generated connectors.
+ */
+import { ref, computed } from 'vue';
+import { getGlobalBaseUrl, mergeCallbacks } from '../composables/shared/runtime/apiHelpers.js';
+/**
+ * @param urlFn   URL string or function that receives an id and returns the URL string.
+ *                e.g. '/pet/me' or (id) => `/pet/${id}`
+ * @param options Optional configuration
+ */
+export function useGetConnector(urlFn, options = {}) {
+    const resolveUrl = (id) => (typeof urlFn === 'function' ? urlFn(id) : urlFn);
+    const { fields = [], baseURL: baseURLOpt, onRequest: onRequestOpt, onSuccess: onSuccessOpt, onError: onErrorOpt, skipGlobalCallbacks, } = options;
+    const baseURL = baseURLOpt || getGlobalBaseUrl();
+    if (!baseURL) {
+        console.warn('[useGetConnector] No baseURL configured. Set runtimeConfig.public.apiBaseUrl in nuxt.config.ts or pass baseURL in options.');
+    }
+    // Callbacks — developer-assignable (can also be passed as options)
+    // Both the connector-level option and the per-operation registration are called.
+    let _localOnSuccess = null;
+    let _localOnError = null;
+    // ── State ──────────────────────────────────────────────────────────────────
+    const data = ref(null);
+    const loading = ref(false);
+    const error = ref(null);
+    // ── Actions ────────────────────────────────────────────────────────────────
+    /**
+     * Fetch a single item by ID.
+     * Returns the fetched item so it can be awaited imperatively:
+     *   const pet = await get.load(5)
+     */
+    async function load(id) {
+        if (id === undefined || id === null) {
+            console.warn('[useGetConnector] load() called with undefined/null id — request was not sent.');
+            return;
+        }
+        loading.value = true;
+        error.value = null;
+        // Merge global + local callbacks (onRequest modifications, rule-based suppression)
+        const url = resolveUrl(id);
+        const merged = mergeCallbacks(url, 'GET', {
+            onRequest: onRequestOpt,
+            onSuccess: onSuccessOpt,
+            onError: onErrorOpt,
+        }, skipGlobalCallbacks);
+        // onRequest hook — collects header/query modifications
+        const requestMods = await merged.onRequest({ url, method: 'GET' });
+        try {
+            const result = await $fetch(url, {
+                method: 'GET',
+                ...(requestMods?.headers ? { headers: requestMods.headers } : {}),
+                ...(requestMods?.query ? { query: requestMods.query } : {}),
+                ...(baseURL ? { baseURL } : {}),
+            });
+            data.value = result;
+            await merged.onSuccess(result, { operation: 'get' });
+            _localOnSuccess?.(result);
+            return result;
+        }
+        catch (err) {
+            error.value = err;
+            await merged.onError(err, { operation: 'get' });
+            _localOnError?.(err);
+            throw err;
+        }
+        finally {
+            loading.value = false;
+        }
+    }
+    /**
+     * Clear the current item from state.
+     */
+    function clear() {
+        data.value = null;
+        error.value = null;
+    }
+    // ── Return ─────────────────────────────────────────────────────────────────
+    return {
+        // State
+        data,
+        loading,
+        error,
+        fields: computed(() => fields),
+        // Actions
+        load,
+        clear,
+        // Callbacks
+        onSuccess: (fn) => { _localOnSuccess = fn; },
+        onError: (fn) => { _localOnError = fn; },
+    };
+}

package/dist/generators/connectors/runtime/useUpdateConnector.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @param urlFn   URL string or function that receives an id and returns the URL string.
+ *                e.g. '/pet' (when ID is sent via body) or (id) => `/pet/${id}`
+ * @param options Configuration: schema, fields, method, baseURL, callbacks, etc.
+ */
+export declare function useUpdateConnector(urlFn: any, options?: {}): {
+    model: any;
+    errors: any;
+    loading: any;
+    error: any;
+    submitted: any;
+    isValid: any;
+    hasErrors: any;
+    fields: any;
+    targetId: any;
+    load: (id: any) => Promise<void>;
+    execute: (id: any, data: any) => Promise<any>;
+    refresh: (id: any, data: any) => Promise<any>;
+    reset: () => void;
+    setValues: (data: any) => void;
+    setField: (key: any, value: any) => void;
+    onSuccess: (fn: any) => void;
+    onError: (fn: any) => void;
+    ui: {
+        isOpen: any;
+        /**
+         * Open the update form.
+         * @param item If provided, pre-fills the model immediately (no extra fetch needed).
+         *             Typically pass the row object from the table.
+         */
+        open(item: any): void;
+        close(): void;
+    };
+};