@tmlmobilidade/utils 20260526.2143.45 → 20260527.1749.0

package/dist/http/fetch-data.d.ts

@@ -0,0 +1,23 @@
+import { HttpResponse } from './response.js';
+/**
+ * Fetches data from a URL with configurable HTTP method, body, headers, and options.
+ * @param url - The URL to fetch from
+ * @param method - The HTTP method to use (DELETE, GET, POST, PUT). Defaults to GET.
+ * @param body - Optional request body data
+ * @param headers - Optional request headers
+ * @param options - Optional fetch options (excluding body, headers, method)
+ * @returns Promise resolving to HttpResponse containing data, error and status
+ * @example
+ * ```ts
+ * // GET request
+ * const response = await fetchData<User>('/api/users/123');
+ *
+ * // POST request with body
+ * const response = await fetchData<User>(
+ *   '/api/users',
+ *   'POST',
+ *   { name: 'John', email: 'john@example.com' }
+ * );
+ * ```
+ */
+export declare function fetchData<T>(url: string, method?: 'DELETE' | 'GET' | 'POST' | 'PUT', body?: unknown, headers?: Record<string, string>, options?: Omit<RequestInit, 'body' | 'headers' | 'method'>, retries?: number): Promise<HttpResponse<T>>;

package/dist/http/fetch-data.js

@@ -0,0 +1,77 @@
+/* * */
+import { HttpResponse } from './response.js';
+/**
+ * Fetches data from a URL with configurable HTTP method, body, headers, and options.
+ * @param url - The URL to fetch from
+ * @param method - The HTTP method to use (DELETE, GET, POST, PUT). Defaults to GET.
+ * @param body - Optional request body data
+ * @param headers - Optional request headers
+ * @param options - Optional fetch options (excluding body, headers, method)
+ * @returns Promise resolving to HttpResponse containing data, error and status
+ * @example
+ * ```ts
+ * // GET request
+ * const response = await fetchData<User>('/api/users/123');
+ *
+ * // POST request with body
+ * const response = await fetchData<User>(
+ *   '/api/users',
+ *   'POST',
+ *   { name: 'John', email: 'john@example.com' }
+ * );
+ * ```
+ */
+export async function fetchData(url, method = 'GET', body, headers = {}, options = {}, retries = 3) {
+    let attempt = 0;
+    let lastError;
+    while (attempt <= retries) {
+        try {
+            const response = await fetch(url, {
+                body: body ? JSON.stringify(body) : undefined,
+                credentials: 'include',
+                headers: {
+                    ...(method === 'GET' || method === 'DELETE' || 'Content-Type' in headers
+                        ? {}
+                        : { 'Content-Type': 'application/json' }),
+                    ...headers,
+                },
+                method,
+                ...options,
+            });
+            const data = (await response.json());
+            if (!response.ok || data.error) {
+                // Don't retry for 4xx (client) errors
+                if (response.status >= 400 && response.status < 500) {
+                    return new HttpResponse({
+                        data: null,
+                        error: data.error,
+                        statusCode: response.status,
+                    });
+                }
+                throw new Error(`HTTP ${response.status} - ${data.error ?? 'Unknown error'}`);
+            }
+            return new HttpResponse({
+                data: data.data,
+                error: null,
+                statusCode: response.status,
+            });
+        }
+        catch (error) {
+            lastError = error;
+            attempt++;
+            // Stop retrying if we've reached the limit
+            if (attempt > retries)
+                break;
+            // Wait before retrying (exponential backoff: 0.5s, 1s, 2s, etc.)
+            const delay = 500 * Math.pow(2, attempt - 1);
+            await new Promise(resolve => setTimeout(resolve, delay));
+        }
+    }
+    return new HttpResponse({
+        data: null,
+        error: lastError instanceof Error
+            ? `${lastError.message} - ${lastError.cause ?? ''}`
+            : 'Network error',
+        statusCode: 500,
+    });
+}

package/dist/http/http.d.ts

@@ -0,0 +1,17 @@
+export type WithPagination<T> = T & {
+    pagination: {
+        limit: number;
+        page: number;
+        total: number;
+    };
+};
+/**
+ * Fetches data from a URL using the SWR fetcher function without authentication.
+ * @param url - The URL to fetch from
+ * @returns Promise resolving to the fetched data
+ * @example
+ * ```ts
+ * const data = await standardSwrFetcher('/api/users/123');
+ * ```
+ */
+export declare const standardSwrFetcher: <T>(url: string) => Promise<T>;

package/dist/http/http.js

@@ -0,0 +1,18 @@
+/* * */
+import { HttpException } from '@tmlmobilidade/consts';
+/**
+ * Fetches data from a URL using the SWR fetcher function without authentication.
+ * @param url - The URL to fetch from
+ * @returns Promise resolving to the fetched data
+ * @example
+ * ```ts
+ * const data = await standardSwrFetcher('/api/users/123');
+ * ```
+ */
+export const standardSwrFetcher = async (url) => {
+    const res = await fetch(url, { credentials: 'omit' });
+    if (!res.ok) {
+        throw new HttpException(res.status, res.statusText);
+    }
+    return res.json();
+};

package/dist/http/index.d.ts

@@ -0,0 +1,5 @@
+export * from './fetch-data.js';
+export * from './http.js';
+export * from './multipart.js';
+export * from './response.js';
+export * from './swr.js';

package/dist/http/index.js

@@ -0,0 +1,5 @@
+export * from './fetch-data.js';
+export * from './http.js';
+export * from './multipart.js';
+export * from './response.js';
+export * from './swr.js';

package/dist/http/multipart.d.ts

@@ -0,0 +1,26 @@
+import { HttpResponse } from './response.js';
+/**
+ * Sends a multipart form data request to a URL.
+ * @param url - The URL to send the request to
+ * @param formData - The FormData object containing the multipart form data
+ * @returns Promise resolving to HttpResponse containing data, error and status
+ * @example
+ * ```ts
+ * const formData = new FormData();
+ * formData.append('file', fileBlob);
+ * formData.append('name', 'profile.jpg');
+ * const response = await multipartFetch('/api/upload', formData);
+ * ```
+ */
+export declare function multipartFetch<T>(url: string, formData: FormData): Promise<HttpResponse<T>>;
+/**
+ * Uploads a file to a URL using multipart form data.
+ * @param url - The URL to send the request to
+ * @param file - The file to upload
+ * @returns Promise resolving to HttpResponse containing data, error and status
+ * @example
+ * ```ts
+ * const response = await uploadFile('/api/upload', file);
+ * ```
+ */
+export declare function uploadFile<T>(url: string, file: File): Promise<HttpResponse<T>>;

package/dist/http/multipart.js

@@ -0,0 +1,59 @@
+/* * */
+import { HttpResponse } from './response.js';
+/**
+ * Sends a multipart form data request to a URL.
+ * @param url - The URL to send the request to
+ * @param formData - The FormData object containing the multipart form data
+ * @returns Promise resolving to HttpResponse containing data, error and status
+ * @example
+ * ```ts
+ * const formData = new FormData();
+ * formData.append('file', fileBlob);
+ * formData.append('name', 'profile.jpg');
+ * const response = await multipartFetch('/api/upload', formData);
+ * ```
+ */
+export async function multipartFetch(url, formData) {
+    try {
+        const response = await fetch(url, {
+            body: formData,
+            credentials: 'include',
+            method: 'POST',
+        });
+        const data = await response.json();
+        if (!response.ok || data.error) {
+            return new HttpResponse({
+                data: null,
+                error: data.error,
+                statusCode: response.status,
+            });
+        }
+        return new HttpResponse({
+            data: data.data,
+            error: null,
+            statusCode: response.status,
+        });
+    }
+    catch (error) {
+        return new HttpResponse({
+            data: null,
+            error: error instanceof Error ? error.message : 'Network error',
+            statusCode: 500,
+        });
+    }
+}
+/**
+ * Uploads a file to a URL using multipart form data.
+ * @param url - The URL to send the request to
+ * @param file - The file to upload
+ * @returns Promise resolving to HttpResponse containing data, error and status
+ * @example
+ * ```ts
+ * const response = await uploadFile('/api/upload', file);
+ * ```
+ */
+export async function uploadFile(url, file) {
+    const formData = new FormData();
+    formData.append('file', file, file.name);
+    return await multipartFetch(url, formData);
+}

package/dist/http/response.d.ts

@@ -0,0 +1,11 @@
+export declare class HttpResponse<T> {
+    readonly data: null | T;
+    readonly error: null | string;
+    readonly isOk?: () => boolean;
+    readonly statusCode: number;
+    constructor({ data, error, statusCode }: {
+        data: null | T;
+        error: null | string;
+        statusCode: number;
+    });
+}

package/dist/http/response.js

@@ -0,0 +1,13 @@
+/* * */
+export class HttpResponse {
+    data;
+    error;
+    isOk;
+    statusCode;
+    constructor({ data, error, statusCode }) {
+        this.data = data;
+        this.error = error;
+        this.statusCode = statusCode;
+        this.isOk = () => statusCode >= 200 && statusCode < 300;
+    }
+}

package/dist/http/swr.d.ts

@@ -0,0 +1,28 @@
+export interface SwrFetcherOptions {
+    credentials?: RequestInit['credentials'];
+    url: string;
+}
+/**
+ * Fetches data from a URL using the SWR fetcher function.
+ * @param urlOrOptions The URL to fetch from or the options object.
+ * @returns Promise resolving to the fetched data
+ * @example
+ * ```ts
+ * // Fetch data from a URL
+ * const data = await swrFetcher('/api/users/123');
+ *
+ * // Fetch data from a URL with options
+ * const data = await swrFetcher({ url: '/api/users/123', credentials: 'omit' });
+ * ```
+ */
+export declare function swrFetcher<T>(urlOrOptions: string | SwrFetcherOptions): Promise<T>;
+/**
+ * Fetches data from a URL using the SWR fetcher function.
+ * @param urlOrOptions The URL to fetch from or the options object.
+ * @returns Promise resolving to the fetched data
+ * @deprecated Use `swrFetcher` with an options object instead.
+ * ```ts
+ * const data = await swrFetcher({ url: '/api/users/123', credentials: 'omit' });
+ * ```
+ */
+export declare function unauthenticatedSwrFetcher<T>(url: string): Promise<T>;

package/dist/http/swr.js

@@ -0,0 +1,47 @@
+/* * */
+import { HttpException } from '@tmlmobilidade/consts';
+/**
+ * Fetches data from a URL using the SWR fetcher function.
+ * @param urlOrOptions The URL to fetch from or the options object.
+ * @returns Promise resolving to the fetched data
+ * @example
+ * ```ts
+ * // Fetch data from a URL
+ * const data = await swrFetcher('/api/users/123');
+ *
+ * // Fetch data from a URL with options
+ * const data = await swrFetcher({ url: '/api/users/123', credentials: 'omit' });
+ * ```
+ */
+export async function swrFetcher(urlOrOptions) {
+    //
+    //
+    // Extract the URL either from the string directly
+    // or from the options object
+    const urlValue = typeof urlOrOptions === 'string' ? urlOrOptions : urlOrOptions.url;
+    //
+    // Extract the credentials option from the options object
+    // or use the default value. By default, it uses 'include' credentials.
+    const credentialsValue = typeof urlOrOptions === 'string' ? 'include' : urlOrOptions.credentials ?? 'include';
+    //
+    // Perform the fetch operation
+    const res = await fetch(urlValue, { credentials: credentialsValue });
+    const data = await res.json();
+    if (!res.ok) {
+        throw new HttpException(res.status, data.error ?? 'An error occurred');
+    }
+    return data.data;
+}
+;
+/**
+ * Fetches data from a URL using the SWR fetcher function.
+ * @param urlOrOptions The URL to fetch from or the options object.
+ * @returns Promise resolving to the fetched data
+ * @deprecated Use `swrFetcher` with an options object instead.
+ * ```ts
+ * const data = await swrFetcher({ url: '/api/users/123', credentials: 'omit' });
+ * ```
+ */
+export async function unauthenticatedSwrFetcher(url) {
+    return swrFetcher({ credentials: 'omit', url: url });
+}

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export * from './batching/index.js';
 export * from './caching/index.js';
 export * from './generic/index.js';
 export * from './get-public-trip-id.js';
-export * from './http.js';
+export * from './http/index.js';
 export * from './numbers/index.js';
 export * from './objects/index.js';
 export * from './permissions.js';

package/dist/index.js

@@ -2,7 +2,7 @@ export * from './batching/index.js';
 export * from './caching/index.js';
 export * from './generic/index.js';
 export * from './get-public-trip-id.js';
-export * from './http.js';
+export * from './http/index.js';
 export * from './numbers/index.js';
 export * from './objects/index.js';
 export * from './permissions.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/utils",
-	"version": "20260526.2143.45",
+	"version": "20260527.1749.0",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"

package/dist/http.d.ts

@@ -1,95 +0,0 @@
-export declare class HttpResponse<T> {
-    readonly data: null | T;
-    readonly error: null | string;
-    readonly isOk?: () => boolean;
-    readonly statusCode: number;
-    constructor({ data, error, statusCode }: {
-        data: null | T;
-        error: null | string;
-        statusCode: number;
-    });
-}
-export type WithPagination<T> = T & {
-    pagination: {
-        limit: number;
-        page: number;
-        total: number;
-    };
-};
-/**
- * Fetches data from a URL with configurable HTTP method, body, headers, and options.
- * @param url - The URL to fetch from
- * @param method - The HTTP method to use (DELETE, GET, POST, PUT). Defaults to GET.
- * @param body - Optional request body data
- * @param headers - Optional request headers
- * @param options - Optional fetch options (excluding body, headers, method)
- * @returns Promise resolving to HttpResponse containing data, error and status
- * @example
- * ```ts
- * // GET request
- * const response = await fetchData<User>('/api/users/123');
- *
- * // POST request with body
- * const response = await fetchData<User>(
- *   '/api/users',
- *   'POST',
- *   { name: 'John', email: 'john@example.com' }
- * );
- * ```
- */
-export declare function fetchData<T>(url: string, method?: 'DELETE' | 'GET' | 'POST' | 'PUT', body?: unknown, headers?: Record<string, string>, options?: Omit<RequestInit, 'body' | 'headers' | 'method'>, retries?: number): Promise<HttpResponse<T>>;
-/**
- * Sends a multipart form data request to a URL.
- * @param url - The URL to send the request to
- * @param formData - The FormData object containing the multipart form data
- * @returns Promise resolving to HttpResponse containing data, error and status
- * @example
- * ```ts
- * const formData = new FormData();
- * formData.append('file', fileBlob);
- * formData.append('name', 'profile.jpg');
- * const response = await multipartFetch('/api/upload', formData);
- * ```
- */
-export declare function multipartFetch<T>(url: string, formData: FormData): Promise<HttpResponse<T>>;
-/**
- * Uploads a file to a URL using multipart form data.
- * @param url - The URL to send the request to
- * @param file - The file to upload
- * @returns Promise resolving to HttpResponse containing data, error and status
- * @example
- * ```ts
- * const response = await uploadFile('/api/upload', file);
- * ```
- */
-export declare function uploadFile<T>(url: string, file: File): Promise<HttpResponse<T>>;
-/**
- * Fetches data from a URL using the SWR fetcher function.
- * @param url - The URL to fetch from
- * @returns Promise resolving to the fetched data
- * @example
- * ```ts
- * const data = await swrFetcher('/api/users/123');
- * ```
- */
-export declare const swrFetcher: <T>(url: string) => Promise<T>;
-/**
- * Fetches data from a URL using the SWR fetcher function.
- * @param url - The URL to fetch from
- * @returns Promise resolving to the fetched data
- * @example
- * ```ts
- * const data = await swrFetcher('/api/users/123');
- * ```
- */
-export declare const unauthenticatedSwrFetcher: <T>(url: string) => Promise<T>;
-/**
- * Fetches data from a URL using the SWR fetcher function without authentication.
- * @param url - The URL to fetch from
- * @returns Promise resolving to the fetched data
- * @example
- * ```ts
- * const data = await standardSwrFetcher('/api/users/123');
- * ```
- */
-export declare const standardSwrFetcher: <T>(url: string) => Promise<T>;

package/dist/http.js

@@ -1,195 +0,0 @@
-import { HttpException } from '@tmlmobilidade/consts';
-export class HttpResponse {
-    data;
-    error;
-    isOk;
-    statusCode;
-    constructor({ data, error, statusCode }) {
-        this.data = data;
-        this.error = error;
-        this.statusCode = statusCode;
-        this.isOk = () => statusCode >= 200 && statusCode < 300;
-    }
-}
-/**
- * Fetches data from a URL with configurable HTTP method, body, headers, and options.
- * @param url - The URL to fetch from
- * @param method - The HTTP method to use (DELETE, GET, POST, PUT). Defaults to GET.
- * @param body - Optional request body data
- * @param headers - Optional request headers
- * @param options - Optional fetch options (excluding body, headers, method)
- * @returns Promise resolving to HttpResponse containing data, error and status
- * @example
- * ```ts
- * // GET request
- * const response = await fetchData<User>('/api/users/123');
- *
- * // POST request with body
- * const response = await fetchData<User>(
- *   '/api/users',
- *   'POST',
- *   { name: 'John', email: 'john@example.com' }
- * );
- * ```
- */
-export async function fetchData(url, method = 'GET', body, headers = {}, options = {}, retries = 3) {
-    let attempt = 0;
-    let lastError;
-    while (attempt <= retries) {
-        try {
-            const response = await fetch(url, {
-                body: body ? JSON.stringify(body) : undefined,
-                credentials: 'include',
-                headers: {
-                    ...(method === 'GET' || method === 'DELETE' || 'Content-Type' in headers
-                        ? {}
-                        : { 'Content-Type': 'application/json' }),
-                    ...headers,
-                },
-                method,
-                ...options,
-            });
-            const data = (await response.json());
-            if (!response.ok || data.error) {
-                // Don't retry for 4xx (client) errors
-                if (response.status >= 400 && response.status < 500) {
-                    return new HttpResponse({
-                        data: null,
-                        error: data.error,
-                        statusCode: response.status,
-                    });
-                }
-                throw new Error(`HTTP ${response.status} - ${data.error ?? 'Unknown error'}`);
-            }
-            return new HttpResponse({
-                data: data.data,
-                error: null,
-                statusCode: response.status,
-            });
-        }
-        catch (error) {
-            lastError = error;
-            attempt++;
-            // Stop retrying if we've reached the limit
-            if (attempt > retries)
-                break;
-            // Wait before retrying (exponential backoff: 0.5s, 1s, 2s, etc.)
-            const delay = 500 * Math.pow(2, attempt - 1);
-            await new Promise(resolve => setTimeout(resolve, delay));
-        }
-    }
-    return new HttpResponse({
-        data: null,
-        error: lastError instanceof Error
-            ? `${lastError.message} - ${lastError.cause ?? ''}`
-            : 'Network error',
-        statusCode: 500,
-    });
-}
-/**
- * Sends a multipart form data request to a URL.
- * @param url - The URL to send the request to
- * @param formData - The FormData object containing the multipart form data
- * @returns Promise resolving to HttpResponse containing data, error and status
- * @example
- * ```ts
- * const formData = new FormData();
- * formData.append('file', fileBlob);
- * formData.append('name', 'profile.jpg');
- * const response = await multipartFetch('/api/upload', formData);
- * ```
- */
-export async function multipartFetch(url, formData) {
-    try {
-        const response = await fetch(url, {
-            body: formData,
-            credentials: 'include',
-            method: 'POST',
-        });
-        const data = await response.json();
-        if (!response.ok || data.error) {
-            return new HttpResponse({
-                data: null,
-                error: data.error,
-                statusCode: response.status,
-            });
-        }
-        return new HttpResponse({
-            data: data.data,
-            error: null,
-            statusCode: response.status,
-        });
-    }
-    catch (error) {
-        return new HttpResponse({
-            data: null,
-            error: error instanceof Error ? error.message : 'Network error',
-            statusCode: 500,
-        });
-    }
-}
-/**
- * Uploads a file to a URL using multipart form data.
- * @param url - The URL to send the request to
- * @param file - The file to upload
- * @returns Promise resolving to HttpResponse containing data, error and status
- * @example
- * ```ts
- * const response = await uploadFile('/api/upload', file);
- * ```
- */
-export async function uploadFile(url, file) {
-    const formData = new FormData();
-    formData.append('file', file, file.name);
-    return await multipartFetch(url, formData);
-}
-/**
- * Fetches data from a URL using the SWR fetcher function.
- * @param url - The URL to fetch from
- * @returns Promise resolving to the fetched data
- * @example
- * ```ts
- * const data = await swrFetcher('/api/users/123');
- * ```
- */
-export const swrFetcher = async (url) => {
-    const res = await fetch(url, { credentials: 'include' });
-    const data = await res.json();
-    if (!res.ok) {
-        throw new HttpException(res.status, data.error ?? 'An error occurred');
-    }
-    return data.data;
-};
-/**
- * Fetches data from a URL using the SWR fetcher function.
- * @param url - The URL to fetch from
- * @returns Promise resolving to the fetched data
- * @example
- * ```ts
- * const data = await swrFetcher('/api/users/123');
- * ```
- */
-export const unauthenticatedSwrFetcher = async (url) => {
-    const res = await fetch(url, { credentials: 'omit' });
-    const data = await res.json();
-    if (!res.ok) {
-        throw new HttpException(res.status, data.error ?? 'An error occurred');
-    }
-    return data.data;
-};
-/**
- * Fetches data from a URL using the SWR fetcher function without authentication.
- * @param url - The URL to fetch from
- * @returns Promise resolving to the fetched data
- * @example
- * ```ts
- * const data = await standardSwrFetcher('/api/users/123');
- * ```
- */
-export const standardSwrFetcher = async (url) => {
-    const res = await fetch(url, { credentials: 'omit' });
-    if (!res.ok) {
-        throw new HttpException(res.status, res.statusText);
-    }
-    return res.json();
-};