@citruslime/vue-utils 3.0.0-beta.2 → 3.0.0-beta.3

package/dist/main.d.ts

@@ -0,0 +1 @@
+export * from './utils';

package/dist/utils/api/endpoints.d.ts

@@ -0,0 +1,25 @@
+export declare const requestTypes: readonly ["GET", "POST", "PUT", "DELETE"];
+export interface Endpoint {
+    url: string;
+    type: typeof requestTypes[number];
+    headers: () => HeadersInit;
+    hasBody: boolean;
+    options: RequestInit;
+}
+/**
+ * Creates an endpoint object, using the provided values.
+ *
+ * @param url The url fragment for the request.
+ * @param type The type of HTTP request to make.
+ * @param headers The headers this request will use.
+ * @param hasBody Determines whether or not an endpoint should have a body.
+ * @param options The options to pass to the useFetch composable.
+ * @returns The created Endpoint object.
+ */
+export declare function createEndpoint(url: string, type: typeof requestTypes[number], headers?: (() => HeadersInit) | null, hasBody?: boolean | null, options?: RequestInit | null): Endpoint;
+/**
+ * Gets a set of default headers.
+ *
+ * @returns A set of default headers.
+ */
+export declare function getDefaultHeaders(): HeadersInit;

package/dist/utils/api/factory.d.ts

@@ -0,0 +1,20 @@
+import { useFetch } from '@vueuse/core';
+import { type Endpoint } from './endpoints';
+export type ApiRequest<TResponseModel> = ReturnType<typeof useFetch<TResponseModel>>;
+/**
+ * Composable that constructs an API object containing requests defined by the endpoints object.
+ *
+ * @param endpoints The endpoints provided to build with the factory.
+ * @param handleFetchErrorResponse The error handler for the api factory.
+ * @param prefix The prefix to append to the url (defaults to '/api/').
+ * @param handleAfterFetchResponse The optional after fetch response handler for the api factory.
+ * @returns An API object containing request methods.
+ */
+export declare function useApi<TEndpoint extends Record<keyof TEndpoint, Endpoint>>(endpoints: TEndpoint, handleFetchErrorResponse: (context: {
+    data: unknown;
+    response: Response | null;
+    error: unknown;
+}) => void, prefix?: string, handleAfterFetchResponse?: (context: {
+    data: unknown;
+    response: Response;
+}, endPoint: Endpoint) => void): Record<keyof TEndpoint, <TResponseModel>(...values: unknown[]) => ApiRequest<TResponseModel>>;

package/dist/utils/copy.d.ts

@@ -0,0 +1,8 @@
+import type { DeepReadonly } from 'vue';
+/**
+ * Deep copies a provided value.
+ *
+ * @param value The value to copy.
+ * @returns A copy of the object.
+ */
+export declare function copy<T>(value: T | Readonly<T> | DeepReadonly<T>): T;

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api/endpoints';
+export * from './api/factory';
+export * from './copy';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citruslime/vue-utils",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.3",
   "type": "module",
   "author": {
     "name": "Citrus-Lime Ltd",
@@ -36,12 +36,12 @@
     "vue-tsc": "^3.2.5"
   },
   "dependencies": {
-    "@citruslime/utils": "3.0.0-beta.2",
+    "@citruslime/utils": "3.0.0-beta.3",
     "@vueuse/core": "^14.2.1",
     "vue": "^3.5.19"
   },
   "scripts": {
-    "build": "run-p build-only build-types",
+    "build": "run-s build-only build-types",
     "build-only": "vite build",
     "build-types": "vue-tsc -p ./tsconfig.d.json",
     "lint": "eslint . --fix --cache"