@everysk/apps-sdk 0.1.0 → 0.3.0-beta-20261016180126

package/dist/api/file.d.ts

@@ -1,6 +1,15 @@
-import { type AxiosInstance } from "axios";
+import type { AxiosInstance } from "axios";
 import type { EveryskFile, FileListResponse } from "../types/file.d.ts";
-import type { DeleteEntityDefaultResponse, QueryObject } from "../types/entityQuery.d.ts";
+import type { DeletedEntity, QueryObject } from "../types/entityQuery.d.ts";
+export type GetFileParams = {
+    /**
+     * `false` leaves `data` out (`null`): sent as `with_data=false`, which the API reads as the
+     * projection `-data` (everysk/client `EveryskAPIEngine_V2._get_entity_by_id`). The content
+     * comes as base64, a third larger than the file. The file hooks leave it out by default;
+     * this function, which mirrors the API, includes it.
+     */
+    withData?: boolean;
+};
 /**
  * getFile
  *
@@ -9,11 +18,13 @@ import type { DeleteEntityDefaultResponse, QueryObject } from "../types/entityQu
  * @param {AxiosInstance} api - Axios instance.
  * @param {string} id - EveryskFile identifier.
  * @param {string} workspace - Workspace the file belongs to.
+ * @param {GetFileParams} [options] - Whether to include the content.
+ * @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.
  * @returns {Promise<EveryskFile>} The fetched file.
  *
  * @throws {Error} If the request fails.
  */
-export declare const getFile: (api: AxiosInstance, id: string, workspace: string) => Promise<EveryskFile>;
+export declare const getFile: (api: AxiosInstance, id: string, workspace: string, { withData }?: GetFileParams, signal?: AbortSignal) => Promise<EveryskFile>;
 /**
  * listFiles
  *
@@ -24,20 +35,24 @@ export declare const getFile: (api: AxiosInstance, id: string, workspace: string
  *
  * @param {AxiosInstance} api - Axios instance.
  * @param {QueryObject} query - Query object built via `buildQueryObject`.
- * @returns {Promise<EveryskFile[]>} List of files. Returns an empty array if none found.
+ * @param {AbortSignal} [signal] - Aborts the request itself; the list hooks pass the query's own.
+ * @returns {Promise<FileListResponse>} Paginated list of files.
  *
+ * @throws {Error} If the query has no workspace filter.
  * @throws {Error} If the request fails.
  */
-export declare const listFiles: (api: AxiosInstance, query: QueryObject) => Promise<FileListResponse>;
+export declare const listFiles: (api: AxiosInstance, query: QueryObject, signal?: AbortSignal) => Promise<FileListResponse>;
 /**
  * createFile
  *
  * Creates a new file.
  *
  * @param {AxiosInstance} api - Axios instance.
- * @param {Partial<EveryskFile>} data - EveryskFile payload.
+ * @param {Partial<EveryskFile>} data - EveryskFile payload. Its `data` is the content as raw
+ *   base64, as `fileToBase64` returns it from a `File`.
  * @returns {Promise<EveryskFile>} The created file.
  *
+ * @throws {Error} If `workspace` is missing, or `data` is a data URL rather than raw base64.
  * @throws {Error} If the request fails.
  */
 export declare const createFile: (api: AxiosInstance, data: Partial<EveryskFile>) => Promise<EveryskFile>;
@@ -48,9 +63,11 @@ export declare const createFile: (api: AxiosInstance, data: Partial<EveryskFile>
  *
  * @param {AxiosInstance} api - Axios instance.
  * @param {string} id - EveryskFile identifier.
- * @param {Partial<EveryskFile>} data - Fields to update.
+ * @param {Partial<EveryskFile>} data - Fields to update. A new `data` is the content as raw
+ *   base64, as `fileToBase64` returns it from a `File`.
  * @returns {Promise<EveryskFile>} The updated file.
  *
+ * @throws {Error} If `workspace` is missing, or `data` is a data URL rather than raw base64.
  * @throws {Error} If the request fails.
  */
 export declare const updateFile: (api: AxiosInstance, id: string, data: Partial<EveryskFile>) => Promise<EveryskFile>;
@@ -62,9 +79,9 @@ export declare const updateFile: (api: AxiosInstance, id: string, data: Partial<
  * @param {AxiosInstance} api - Axios instance.
  * @param {string} id - EveryskFile identifier.
  * @param {string} workspace - Workspace the file belongs to.
- * @returns {Promise<DeleteEntityDefaultResponse[]>} List of deleted entity records.
+ * @returns {Promise<DeletedEntity>} The deletion record: id, name and `deleted`.
  *
  * @throws {Error} If the request fails.
  */
-export declare const deleteFile: (api: AxiosInstance, id: string, workspace: string) => Promise<DeleteEntityDefaultResponse[]>;
+export declare const deleteFile: (api: AxiosInstance, id: string, workspace: string) => Promise<DeletedEntity>;
 //# sourceMappingURL=file.d.ts.map

package/dist/api/file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../src/api/file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,aAAa,EAAsB,MAAM,OAAO,CAAC;AAG7E,OAAO,KAAK,EAAsB,WAAW,EAAE,gBAAgB,EAAsB,MAAM,cAAc,CAAC;AAC1G,OAAO,KAAK,EAAE,2BAA2B,EAAoB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAItG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,OAAO,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,WAAW,CAiBpG,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,GAAU,KAAK,aAAa,EAAE,OAAO,WAAW,KAAG,OAAO,CAAC,gBAAgB,CAwBhG,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAU,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,KAAG,OAAO,CAAC,WAAW,CAmBpG,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,KAAG,OAAO,CAAC,WAAW,CAmBhH,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,2BAA2B,EAAE,CAiBzH,CAAC"}
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../src/api/file.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,KAAK,EACR,aAAa,EAGb,WAAW,EACd,MAAM,qBAAqB,CAAC;AAS7B,MAAM,MAAM,aAAa,GAAG;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO,GAChB,KAAK,aAAa,EAClB,IAAI,MAAM,EACV,WAAW,MAAM,EACjB,eAAc,aAAkB,EAChC,SAAS,WAAW,KACrB,OAAO,CAAC,WAAW,CASrB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,SAAS,GAClB,KAAK,aAAa,EAClB,OAAO,WAAW,EAClB,SAAS,WAAW,KACrB,OAAO,CAAC,gBAAgB,CAO1B,CAAC;AAeF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GACnB,KAAK,aAAa,EAClB,MAAM,OAAO,CAAC,WAAW,CAAC,KAC3B,OAAO,CAAC,WAAW,CASrB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,GACnB,KAAK,aAAa,EAClB,IAAI,MAAM,EACV,MAAM,OAAO,CAAC,WAAW,CAAC,KAC3B,OAAO,CAAC,WAAW,CASrB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GACnB,KAAK,aAAa,EAClB,IAAI,MAAM,EACV,WAAW,MAAM,KAClB,OAAO,CAAC,aAAa,CAQvB,CAAC"}

package/dist/api/file.js

@@ -1,4 +1,4 @@
-import { isAxiosError } from "axios";
+import { listParams, request, requireWorkspace } from "./request.js";
 //#region src/api/file.ts
 var baseUrl = "files";
 /**
@@ -9,19 +9,22 @@ var baseUrl = "files";
 * @param {AxiosInstance} api - Axios instance.
 * @param {string} id - EveryskFile identifier.
 * @param {string} workspace - Workspace the file belongs to.
+* @param {GetFileParams} [options] - Whether to include the content.
+* @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.
 * @returns {Promise<EveryskFile>} The fetched file.
 *
 * @throws {Error} If the request fails.
 */
-var getFile = async (api, id, workspace) => {
-	const params = { workspace };
-	try {
-		return (await api.get(`${baseUrl}/${id}`, { params })).data.file;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while fetching file");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while fetching file");
-	}
+var getFile = async (api, id, workspace, { withData } = {}, signal) => {
+	requireWorkspace(workspace, "fetch a file");
+	const params = {
+		workspace,
+		...withData === false && { with_data: false }
+	};
+	return (await request(() => api.get(`${baseUrl}/${id}`, {
+		params,
+		signal
+	}), "Error fetching file")).file;
 };
 /**
 * listFiles
@@ -33,25 +36,26 @@ var getFile = async (api, id, workspace) => {
 *
 * @param {AxiosInstance} api - Axios instance.
 * @param {QueryObject} query - Query object built via `buildQueryObject`.
-* @returns {Promise<EveryskFile[]>} List of files. Returns an empty array if none found.
+* @param {AbortSignal} [signal] - Aborts the request itself; the list hooks pass the query's own.
+* @returns {Promise<FileListResponse>} Paginated list of files.
 *
+* @throws {Error} If the query has no workspace filter.
 * @throws {Error} If the request fails.
 */
-var listFiles = async (api, query) => {
-	const workspaceFilter = query.filters.find((filter) => filter[0] === "workspace");
-	const workspace = workspaceFilter?.[workspaceFilter.length - 1];
-	if (!workspace) throw new Error("Workspace filter is required to list files");
-	const params = {
-		workspace,
-		...query ? { query: JSON.stringify(query) } : {}
-	};
-	try {
-		return (await api.get(baseUrl, { params })).data;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while fetching files");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while fetching files");
-	}
+var listFiles = async (api, query, signal) => {
+	const params = listParams(query, "list files");
+	return request(() => api.get(baseUrl, {
+		params,
+		signal
+	}), "Error listing files");
+};
+/**
+* Refuses content sent as a data URL. The API stores `data` as given, so the
+* `data:<type>;base64,` prefix `FileReader` puts in front would become part of the file, which
+* then comes out corrupt with no error anywhere.
+*/
+var requireRawBase64 = ({ data }) => {
+	if (data?.startsWith("data:")) throw new Error("A file's data must be raw base64, without the data: prefix: read it with fileToBase64");
 };
 /**
 * createFile
@@ -59,21 +63,17 @@ var listFiles = async (api, query) => {
 * Creates a new file.
 *
 * @param {AxiosInstance} api - Axios instance.
-* @param {Partial<EveryskFile>} data - EveryskFile payload.
+* @param {Partial<EveryskFile>} data - EveryskFile payload. Its `data` is the content as raw
+*   base64, as `fileToBase64` returns it from a `File`.
 * @returns {Promise<EveryskFile>} The created file.
 *
+* @throws {Error} If `workspace` is missing, or `data` is a data URL rather than raw base64.
 * @throws {Error} If the request fails.
 */
 var createFile = async (api, data) => {
-	const { workspace } = data;
-	if (!workspace) throw new Error("Workspace filter is required to create a file");
-	try {
-		return (await api.post(baseUrl, data)).data.file;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while creating file");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while creating file");
-	}
+	requireWorkspace(data.workspace, "create a file");
+	requireRawBase64(data);
+	return (await request(() => api.post(baseUrl, data), "Error creating file")).file;
 };
 /**
 * updateFile
@@ -82,21 +82,17 @@ var createFile = async (api, data) => {
 *
 * @param {AxiosInstance} api - Axios instance.
 * @param {string} id - EveryskFile identifier.
-* @param {Partial<EveryskFile>} data - Fields to update.
+* @param {Partial<EveryskFile>} data - Fields to update. A new `data` is the content as raw
+*   base64, as `fileToBase64` returns it from a `File`.
 * @returns {Promise<EveryskFile>} The updated file.
 *
+* @throws {Error} If `workspace` is missing, or `data` is a data URL rather than raw base64.
 * @throws {Error} If the request fails.
 */
 var updateFile = async (api, id, data) => {
-	const { workspace } = data;
-	if (!workspace) throw new Error("Workspace filter is required to update a file");
-	try {
-		return (await api.put(`${baseUrl}/${id}`, data)).data.file;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while updating file");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while updating file");
-	}
+	requireWorkspace(data.workspace, "update a file");
+	requireRawBase64(data);
+	return (await request(() => api.put(`${baseUrl}/${id}`, data), "Error updating file")).file;
 };
 /**
 * deleteFile
@@ -106,19 +102,13 @@ var updateFile = async (api, id, data) => {
 * @param {AxiosInstance} api - Axios instance.
 * @param {string} id - EveryskFile identifier.
 * @param {string} workspace - Workspace the file belongs to.
-* @returns {Promise<DeleteEntityDefaultResponse[]>} List of deleted entity records.
+* @returns {Promise<DeletedEntity>} The deletion record: id, name and `deleted`.
 *
 * @throws {Error} If the request fails.
 */
 var deleteFile = async (api, id, workspace) => {
-	const params = { workspace };
-	try {
-		return (await api.delete(`${baseUrl}/${id}`, { params })).data.files;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while deleting file");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while deleting file");
-	}
+	requireWorkspace(workspace, "delete a file");
+	return (await request(() => api.delete(`${baseUrl}/${id}`, { params: { workspace } }), "Error deleting file")).file;
 };
 //#endregion
 export { createFile, deleteFile, getFile, listFiles, updateFile };

package/dist/api/file.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.js","names":[],"sources":["../../src/api/file.ts"],"sourcesContent":["import { isAxiosError, type AxiosInstance, type AxiosResponse } from \"axios\";\n\nimport type { AnyRecord } from \"@/types/anyRecord\";\nimport type { DeleteFileResponse, EveryskFile, FileListResponse, FileSingleResponse } from \"@/types/file\";\nimport type { DeleteEntityDefaultResponse, FilterExpression, QueryObject } from \"@/types/entityQuery\";\n\nconst baseUrl = \"files\";\n\n/**\n * getFile\n *\n * Fetches a single file by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - EveryskFile identifier.\n * @param {string} workspace - Workspace the file belongs to.\n * @returns {Promise<EveryskFile>} The fetched file.\n *\n * @throws {Error} If the request fails.\n */\nexport const getFile = async (api: AxiosInstance, id: string, workspace: string): Promise<EveryskFile> => {\n  const params: AnyRecord = { workspace };\n\n  try {\n    const response: AxiosResponse<FileSingleResponse> = await api.get(`${baseUrl}/${id}`, { params });\n    return response.data.file;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n     throw new Error(error.message || \"Error while fetching file\");\n    }\n\n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while fetching file\");\n  }\n};\n\n/**\n * listFiles\n *\n * Fetches a list of files using a query object (filters, order, pagination, etc.).\n *\n * Note: `workspace` is extracted from the query filters and sent as a separate\n * query param alongside the serialized query object.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {QueryObject} query - Query object built via `buildQueryObject`.\n * @returns {Promise<EveryskFile[]>} List of files. Returns an empty array if none found.\n *\n * @throws {Error} If the request fails.\n */\nexport const listFiles = async (api: AxiosInstance, query: QueryObject): Promise<FileListResponse> => {\n  const workspaceFilter = query.filters.find((filter: FilterExpression) => filter[0] === \"workspace\");\n  const workspace = workspaceFilter?.[workspaceFilter.length - 1];\n  \n  if (!workspace) throw new Error(\"Workspace filter is required to list files\");\n\n  const params: AnyRecord = {\n    workspace,\n    ...(query ? { query: JSON.stringify(query) } : {}),\n  };\n\n  try {\n    const response: AxiosResponse<FileListResponse> = await api.get(baseUrl, { params });\n    return response.data;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n      throw new Error(error.message || \"Error while fetching files\");\n    } \n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while fetching files\");\n  }\n};\n\n/**\n * createFile\n *\n * Creates a new file.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {Partial<EveryskFile>} data - EveryskFile payload.\n * @returns {Promise<EveryskFile>} The created file.\n *\n * @throws {Error} If the request fails.\n */\nexport const createFile = async (api: AxiosInstance, data: Partial<EveryskFile>): Promise<EveryskFile> => {\n\n  const { workspace } = data;\n  if (!workspace) throw new Error(\"Workspace filter is required to create a file\");\n\n  try {\n    const response: AxiosResponse<FileSingleResponse> = await api.post(baseUrl, data);\n    return response.data.file;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n      throw new Error(error.message || \"Error while creating file\");\n    }\n\n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while creating file\");\n  }\n};\n\n/**\n * updateFile\n *\n * Updates an existing file by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - EveryskFile identifier.\n * @param {Partial<EveryskFile>} data - Fields to update.\n * @returns {Promise<EveryskFile>} The updated file.\n *\n * @throws {Error} If the request fails.\n */\nexport const updateFile = async (api: AxiosInstance, id: string, data: Partial<EveryskFile>): Promise<EveryskFile> => {\n\n    const { workspace } = data;\n    if (!workspace) throw new Error(\"Workspace filter is required to update a file\");\n\n    try {\n        const response: AxiosResponse<FileSingleResponse> = await api.put(`${baseUrl}/${id}`, data);\n        return response.data.file;\n    } catch (error: unknown) {\n        if (isAxiosError<AnyRecord>(error)) {\n            throw new Error(error.message || \"Error while updating file\");\n        }\n\n        if (error instanceof Error) {\n            throw error;\n        }\n\n        throw new Error(\"Error while updating file\");\n    }\n};\n\n/**\n * deleteFile\n *\n * Deletes a file by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - EveryskFile identifier.\n * @param {string} workspace - Workspace the file belongs to.\n * @returns {Promise<DeleteEntityDefaultResponse[]>} List of deleted entity records.\n *\n * @throws {Error} If the request fails.\n */\nexport const deleteFile = async (api: AxiosInstance, id: string, workspace: string): Promise<DeleteEntityDefaultResponse[]> => {\n  const params: AnyRecord = { workspace };\n\n  try {\n    const response: AxiosResponse<DeleteFileResponse> = await api.delete(`${baseUrl}/${id}`, { params });\n    return response.data.files;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n      throw new Error(error.message || \"Error while deleting file\");\n    }\n\n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while deleting file\");\n  }\n};"],"mappings":";;AAMA,IAAM,UAAU;;;;;;;;;;;;;AAchB,IAAa,UAAU,OAAO,KAAoB,IAAY,cAA4C;CACxG,MAAM,SAAoB,EAAE,UAAU;CAEtC,IAAI;EAEF,QAAO,MADmD,IAAI,IAAI,GAAG,QAAQ,GAAG,MAAM,EAAE,OAAO,CAAC,EAAA,CAChF,KAAK;CACvB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAChC,MAAM,IAAI,MAAM,MAAM,WAAW,2BAA2B;EAG7D,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,2BAA2B;CAC7C;AACF;;;;;;;;;;;;;;;AAgBA,IAAa,YAAY,OAAO,KAAoB,UAAkD;CACpG,MAAM,kBAAkB,MAAM,QAAQ,MAAM,WAA6B,OAAO,OAAO,WAAW;CAClG,MAAM,YAAY,kBAAkB,gBAAgB,SAAS;CAE7D,IAAI,CAAC,WAAW,MAAM,IAAI,MAAM,4CAA4C;CAE5E,MAAM,SAAoB;EACxB;EACA,GAAI,QAAQ,EAAE,OAAO,KAAK,UAAU,KAAK,EAAE,IAAI,CAAC;CAClD;CAEA,IAAI;EAEF,QAAO,MADiD,IAAI,IAAI,SAAS,EAAE,OAAO,CAAC,EAAA,CACnE;CAClB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAC/B,MAAM,IAAI,MAAM,MAAM,WAAW,4BAA4B;EAE/D,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,4BAA4B;CAC9C;AACF;;;;;;;;;;;;AAaA,IAAa,aAAa,OAAO,KAAoB,SAAqD;CAExG,MAAM,EAAE,cAAc;CACtB,IAAI,CAAC,WAAW,MAAM,IAAI,MAAM,+CAA+C;CAE/E,IAAI;EAEF,QAAO,MADmD,IAAI,KAAK,SAAS,IAAI,EAAA,CAChE,KAAK;CACvB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAC/B,MAAM,IAAI,MAAM,MAAM,WAAW,2BAA2B;EAG9D,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,2BAA2B;CAC7C;AACF;;;;;;;;;;;;;AAcA,IAAa,aAAa,OAAO,KAAoB,IAAY,SAAqD;CAElH,MAAM,EAAE,cAAc;CACtB,IAAI,CAAC,WAAW,MAAM,IAAI,MAAM,+CAA+C;CAE/E,IAAI;EAEA,QAAO,MADmD,IAAI,IAAI,GAAG,QAAQ,GAAG,MAAM,IAAI,EAAA,CAC1E,KAAK;CACzB,SAAS,OAAgB;EACrB,IAAI,aAAwB,KAAK,GAC7B,MAAM,IAAI,MAAM,MAAM,WAAW,2BAA2B;EAGhE,IAAI,iBAAiB,OACjB,MAAM;EAGV,MAAM,IAAI,MAAM,2BAA2B;CAC/C;AACJ;;;;;;;;;;;;;AAcA,IAAa,aAAa,OAAO,KAAoB,IAAY,cAA8D;CAC7H,MAAM,SAAoB,EAAE,UAAU;CAEtC,IAAI;EAEF,QAAO,MADmD,IAAI,OAAO,GAAG,QAAQ,GAAG,MAAM,EAAE,OAAO,CAAC,EAAA,CACnF,KAAK;CACvB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAC/B,MAAM,IAAI,MAAM,MAAM,WAAW,2BAA2B;EAG9D,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,2BAA2B;CAC7C;AACF"}
+{"version":3,"file":"file.js","names":[],"sources":["../../src/api/file.ts"],"sourcesContent":["import type { AxiosInstance } from \"axios\";\n\nimport type { EveryskFile, FileListResponse } from \"@/types/file\";\nimport type {\n    DeletedEntity,\n    DeleteEntityResponse,\n    EntitySingleResponse,\n    QueryObject,\n} from \"@/types/entityQuery\";\nimport { listParams, request, requireWorkspace } from \"./request\";\n\nconst baseUrl = \"files\";\n\n/** The endpoint's envelopes, private: every function here returns the entity itself. */\ntype FileSingleResponse = EntitySingleResponse<\"file\", EveryskFile>;\ntype DeleteFileResponse = DeleteEntityResponse<\"file\">;\n\nexport type GetFileParams = {\n    /**\n     * `false` leaves `data` out (`null`): sent as `with_data=false`, which the API reads as the\n     * projection `-data` (everysk/client `EveryskAPIEngine_V2._get_entity_by_id`). The content\n     * comes as base64, a third larger than the file. The file hooks leave it out by default;\n     * this function, which mirrors the API, includes it.\n     */\n    withData?: boolean;\n};\n\n/**\n * getFile\n *\n * Fetches a single file by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - EveryskFile identifier.\n * @param {string} workspace - Workspace the file belongs to.\n * @param {GetFileParams} [options] - Whether to include the content.\n * @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.\n * @returns {Promise<EveryskFile>} The fetched file.\n *\n * @throws {Error} If the request fails.\n */\nexport const getFile = async (\n    api: AxiosInstance,\n    id: string,\n    workspace: string,\n    { withData }: GetFileParams = {},\n    signal?: AbortSignal,\n): Promise<EveryskFile> => {\n    requireWorkspace(workspace, \"fetch a file\");\n\n    const params = { workspace, ...(withData === false && { with_data: false }) };\n    const body = await request(\n        () => api.get<FileSingleResponse>(`${baseUrl}/${id}`, { params, signal }),\n        \"Error fetching file\",\n    );\n    return body.file;\n};\n\n/**\n * listFiles\n *\n * Fetches a list of files using a query object (filters, order, pagination, etc.).\n *\n * Note: `workspace` is extracted from the query filters and sent as a separate\n * query param alongside the serialized query object.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {QueryObject} query - Query object built via `buildQueryObject`.\n * @param {AbortSignal} [signal] - Aborts the request itself; the list hooks pass the query's own.\n * @returns {Promise<FileListResponse>} Paginated list of files.\n *\n * @throws {Error} If the query has no workspace filter.\n * @throws {Error} If the request fails.\n */\nexport const listFiles = async (\n    api: AxiosInstance,\n    query: QueryObject,\n    signal?: AbortSignal,\n): Promise<FileListResponse> => {\n    const params = listParams(query, \"list files\");\n\n    return request(\n        () => api.get<FileListResponse>(baseUrl, { params, signal }),\n        \"Error listing files\",\n    );\n};\n\n/**\n * Refuses content sent as a data URL. The API stores `data` as given, so the\n * `data:<type>;base64,` prefix `FileReader` puts in front would become part of the file, which\n * then comes out corrupt with no error anywhere.\n */\nconst requireRawBase64 = ({ data }: Partial<EveryskFile>) => {\n    if (data?.startsWith(\"data:\")) {\n        throw new Error(\n            \"A file's data must be raw base64, without the data: prefix: read it with fileToBase64\",\n        );\n    }\n};\n\n/**\n * createFile\n *\n * Creates a new file.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {Partial<EveryskFile>} data - EveryskFile payload. Its `data` is the content as raw\n *   base64, as `fileToBase64` returns it from a `File`.\n * @returns {Promise<EveryskFile>} The created file.\n *\n * @throws {Error} If `workspace` is missing, or `data` is a data URL rather than raw base64.\n * @throws {Error} If the request fails.\n */\nexport const createFile = async (\n    api: AxiosInstance,\n    data: Partial<EveryskFile>,\n): Promise<EveryskFile> => {\n    requireWorkspace(data.workspace, \"create a file\");\n    requireRawBase64(data);\n\n    const body = await request(\n        () => api.post<FileSingleResponse>(baseUrl, data),\n        \"Error creating file\",\n    );\n    return body.file;\n};\n\n/**\n * updateFile\n *\n * Updates an existing file by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - EveryskFile identifier.\n * @param {Partial<EveryskFile>} data - Fields to update. A new `data` is the content as raw\n *   base64, as `fileToBase64` returns it from a `File`.\n * @returns {Promise<EveryskFile>} The updated file.\n *\n * @throws {Error} If `workspace` is missing, or `data` is a data URL rather than raw base64.\n * @throws {Error} If the request fails.\n */\nexport const updateFile = async (\n    api: AxiosInstance,\n    id: string,\n    data: Partial<EveryskFile>,\n): Promise<EveryskFile> => {\n    requireWorkspace(data.workspace, \"update a file\");\n    requireRawBase64(data);\n\n    const body = await request(\n        () => api.put<FileSingleResponse>(`${baseUrl}/${id}`, data),\n        \"Error updating file\",\n    );\n    return body.file;\n};\n\n/**\n * deleteFile\n *\n * Deletes a file by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - EveryskFile identifier.\n * @param {string} workspace - Workspace the file belongs to.\n * @returns {Promise<DeletedEntity>} The deletion record: id, name and `deleted`.\n *\n * @throws {Error} If the request fails.\n */\nexport const deleteFile = async (\n    api: AxiosInstance,\n    id: string,\n    workspace: string,\n): Promise<DeletedEntity> => {\n    requireWorkspace(workspace, \"delete a file\");\n\n    const body = await request(\n        () => api.delete<DeleteFileResponse>(`${baseUrl}/${id}`, { params: { workspace } }),\n        \"Error deleting file\",\n    );\n    return body.file;\n};\n"],"mappings":";;AAWA,IAAM,UAAU;;;;;;;;;;;;;;;AA8BhB,IAAa,UAAU,OACnB,KACA,IACA,WACA,EAAE,aAA4B,CAAC,GAC/B,WACuB;CACvB,iBAAiB,WAAW,cAAc;CAE1C,MAAM,SAAS;EAAE;EAAW,GAAI,aAAa,SAAS,EAAE,WAAW,MAAM;CAAG;CAK5E,QAAO,MAJY,cACT,IAAI,IAAwB,GAAG,QAAQ,GAAG,MAAM;EAAE;EAAQ;CAAO,CAAC,GACxE,qBACJ,EAAA,CACY;AAChB;;;;;;;;;;;;;;;;;AAkBA,IAAa,YAAY,OACrB,KACA,OACA,WAC4B;CAC5B,MAAM,SAAS,WAAW,OAAO,YAAY;CAE7C,OAAO,cACG,IAAI,IAAsB,SAAS;EAAE;EAAQ;CAAO,CAAC,GAC3D,qBACJ;AACJ;;;;;;AAOA,IAAM,oBAAoB,EAAE,WAAiC;CACzD,IAAI,MAAM,WAAW,OAAO,GACxB,MAAM,IAAI,MACN,uFACJ;AAER;;;;;;;;;;;;;;AAeA,IAAa,aAAa,OACtB,KACA,SACuB;CACvB,iBAAiB,KAAK,WAAW,eAAe;CAChD,iBAAiB,IAAI;CAMrB,QAAO,MAJY,cACT,IAAI,KAAyB,SAAS,IAAI,GAChD,qBACJ,EAAA,CACY;AAChB;;;;;;;;;;;;;;;AAgBA,IAAa,aAAa,OACtB,KACA,IACA,SACuB;CACvB,iBAAiB,KAAK,WAAW,eAAe;CAChD,iBAAiB,IAAI;CAMrB,QAAO,MAJY,cACT,IAAI,IAAwB,GAAG,QAAQ,GAAG,MAAM,IAAI,GAC1D,qBACJ,EAAA,CACY;AAChB;;;;;;;;;;;;;AAcA,IAAa,aAAa,OACtB,KACA,IACA,cACyB;CACzB,iBAAiB,WAAW,eAAe;CAM3C,QAAO,MAJY,cACT,IAAI,OAA2B,GAAG,QAAQ,GAAG,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,GAClF,qBACJ,EAAA,CACY;AAChB"}

package/dist/api/portfolio.d.ts

@@ -1,6 +1,6 @@
-import { type AxiosInstance } from "axios";
-import type { QueryObject } from "../types/entityQuery.d.ts";
-import type { Portfolio, PortfolioListResponse, PortfolioSingleResponse } from "../types/portfolio.d.ts";
+import type { AxiosInstance } from "axios";
+import type { DeletedEntity, QueryObject } from "../types/entityQuery.d.ts";
+import type { Portfolio, PortfolioListResponse } from "../types/portfolio.d.ts";
 /**
  * getPortfolio
  *
@@ -9,11 +9,12 @@ import type { Portfolio, PortfolioListResponse, PortfolioSingleResponse } from "
  * @param {AxiosInstance} api - Axios instance.
  * @param {string} id - Portfolio identifier.
  * @param {string} workspace - Workspace the portfolio belongs to.
- * @returns {Promise<PortfolioSingleResponse>} The fetched portfolio response.
+ * @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.
+ * @returns {Promise<Portfolio>} The fetched portfolio.
  *
  * @throws {Error} If the request fails.
  */
-export declare const getPortfolio: (api: AxiosInstance, id: string, workspace: string) => Promise<PortfolioSingleResponse>;
+export declare const getPortfolio: (api: AxiosInstance, id: string, workspace: string, signal?: AbortSignal) => Promise<Portfolio>;
 /**
  * listPortfolios
  *
@@ -21,11 +22,13 @@ export declare const getPortfolio: (api: AxiosInstance, id: string, workspace: s
  *
  * @param {AxiosInstance} api - Axios instance.
  * @param {QueryObject} query - Query object built via `buildQueryObject`.
+ * @param {AbortSignal} [signal] - Aborts the request itself; the list hooks pass the query's own.
  * @returns {Promise<PortfolioListResponse>} List of portfolios.
  *
+ * @throws {Error} If the query has no workspace filter.
  * @throws {Error} If the request fails.
  */
-export declare const listPortfolios: (api: AxiosInstance, query: QueryObject) => Promise<PortfolioListResponse>;
+export declare const listPortfolios: (api: AxiosInstance, query: QueryObject, signal?: AbortSignal) => Promise<PortfolioListResponse>;
 /**
  * createPortfolio
  *
@@ -59,9 +62,9 @@ export declare const updatePortfolio: (api: AxiosInstance, id: string, data: Par
  * @param {AxiosInstance} api - Axios instance.
  * @param {string} id - Portfolio identifier.
  * @param {string} workspace - Workspace the portfolio belongs to.
- * @returns {Promise<Portfolio>} The deleted portfolio.
+ * @returns {Promise<DeletedEntity>} The deletion record: id, name and `deleted`.
  *
  * @throws {Error} If the request fails.
  */
-export declare const deletePortfolio: (api: AxiosInstance, id: string, workspace: string) => Promise<Portfolio>;
+export declare const deletePortfolio: (api: AxiosInstance, id: string, workspace: string) => Promise<DeletedEntity>;
 //# sourceMappingURL=portfolio.d.ts.map

package/dist/api/portfolio.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"portfolio.d.ts","sourceRoot":"","sources":["../../src/api/portfolio.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,aAAa,EAAsB,MAAM,OAAO,CAAC;AAE7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAInG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,uBAAuB,CAqBrH,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GAAU,KAAK,aAAa,EAAE,OAAO,WAAW,KAAG,OAAO,CAAC,qBAAqB,CA2B1G,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAAU,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,KAAG,OAAO,CAAC,SAAS,CAsBrG,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,KAAG,OAAO,CAAC,SAAS,CAsBjH,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,SAAS,CAsB1G,CAAA"}
+{"version":3,"file":"portfolio.d.ts","sourceRoot":"","sources":["../../src/api/portfolio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,KAAK,EACR,aAAa,EAGb,WAAW,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAS1E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GACrB,KAAK,aAAa,EAClB,IAAI,MAAM,EACV,WAAW,MAAM,EACjB,SAAS,WAAW,KACrB,OAAO,CAAC,SAAS,CASnB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,GACvB,KAAK,aAAa,EAClB,OAAO,WAAW,EAClB,SAAS,WAAW,KACrB,OAAO,CAAC,qBAAqB,CAO/B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GACxB,KAAK,aAAa,EAClB,MAAM,OAAO,CAAC,SAAS,CAAC,KACzB,OAAO,CAAC,SAAS,CAQnB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GACxB,KAAK,aAAa,EAClB,IAAI,MAAM,EACV,MAAM,OAAO,CAAC,SAAS,CAAC,KACzB,OAAO,CAAC,SAAS,CAQnB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GACxB,KAAK,aAAa,EAClB,IAAI,MAAM,EACV,WAAW,MAAM,KAClB,OAAO,CAAC,aAAa,CAQvB,CAAC"}

package/dist/api/portfolio.js

@@ -1,4 +1,4 @@
-import { isAxiosError } from "axios";
+import { listParams, request, requireWorkspace } from "./request.js";
 //#region src/api/portfolio.ts
 var baseUrl = "portfolios";
 /**
@@ -9,20 +9,17 @@ var baseUrl = "portfolios";
 * @param {AxiosInstance} api - Axios instance.
 * @param {string} id - Portfolio identifier.
 * @param {string} workspace - Workspace the portfolio belongs to.
-* @returns {Promise<PortfolioSingleResponse>} The fetched portfolio response.
+* @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.
+* @returns {Promise<Portfolio>} The fetched portfolio.
 *
 * @throws {Error} If the request fails.
 */
-var getPortfolio = async (api, id, workspace) => {
-	const params = { workspace };
-	if (!workspace) throw new Error("Workspace is required to fetch a portfolio");
-	try {
-		return (await api.get(`${baseUrl}/${id}`, { params })).data;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while fetching portfolio");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while fetching portfolio");
-	}
+var getPortfolio = async (api, id, workspace, signal) => {
+	requireWorkspace(workspace, "fetch a portfolio");
+	return (await request(() => api.get(`${baseUrl}/${id}`, {
+		params: { workspace },
+		signal
+	}), "Error fetching portfolio")).portfolio;
 };
 /**
 * listPortfolios
@@ -31,25 +28,18 @@ var getPortfolio = async (api, id, workspace) => {
 *
 * @param {AxiosInstance} api - Axios instance.
 * @param {QueryObject} query - Query object built via `buildQueryObject`.
+* @param {AbortSignal} [signal] - Aborts the request itself; the list hooks pass the query's own.
 * @returns {Promise<PortfolioListResponse>} List of portfolios.
 *
+* @throws {Error} If the query has no workspace filter.
 * @throws {Error} If the request fails.
 */
-var listPortfolios = async (api, query) => {
-	const workspaceFilter = query.filters.find((filter) => filter[0] === "workspace");
-	const workspace = workspaceFilter?.[workspaceFilter.length - 1];
-	if (!workspace) throw new Error("Workspace is required to fetch portfolios");
-	const params = {
-		workspace,
-		...query ? { query: JSON.stringify(query) } : {}
-	};
-	try {
-		return (await api.get(baseUrl, { params })).data;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while fetching portfolios");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while fetching portfolios");
-	}
+var listPortfolios = async (api, query, signal) => {
+	const params = listParams(query, "list portfolios");
+	return request(() => api.get(baseUrl, {
+		params,
+		signal
+	}), "Error listing portfolios");
 };
 /**
 * createPortfolio
@@ -63,15 +53,8 @@ var listPortfolios = async (api, query) => {
 * @throws {Error} If the request fails.
 */
 var createPortfolio = async (api, data) => {
-	const { workspace } = data;
-	if (!workspace) throw new Error("Workspace is required to post a portfolio");
-	try {
-		return (await api.post(baseUrl, data)).data;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while creating portfolio");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while creating portfolio");
-	}
+	requireWorkspace(data.workspace, "create a portfolio");
+	return (await request(() => api.post(baseUrl, data), "Error creating portfolio")).portfolio;
 };
 /**
 * updatePortfolio
@@ -86,15 +69,8 @@ var createPortfolio = async (api, data) => {
 * @throws {Error} If the request fails.
 */
 var updatePortfolio = async (api, id, data) => {
-	const { workspace } = data;
-	if (!workspace) throw new Error("Workspace is required to delete a portfolio");
-	try {
-		return (await api.put(`${baseUrl}/${id}`, data)).data;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while updating portfolio");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while updating portfolio");
-	}
+	requireWorkspace(data.workspace, "update a portfolio");
+	return (await request(() => api.put(`${baseUrl}/${id}`, data), "Error updating portfolio")).portfolio;
 };
 /**
 * deletePortfolio
@@ -104,20 +80,13 @@ var updatePortfolio = async (api, id, data) => {
 * @param {AxiosInstance} api - Axios instance.
 * @param {string} id - Portfolio identifier.
 * @param {string} workspace - Workspace the portfolio belongs to.
-* @returns {Promise<Portfolio>} The deleted portfolio.
+* @returns {Promise<DeletedEntity>} The deletion record: id, name and `deleted`.
 *
 * @throws {Error} If the request fails.
 */
 var deletePortfolio = async (api, id, workspace) => {
-	if (!workspace) throw new Error("Workspace is required to delete a portfolio");
-	const params = { workspace };
-	try {
-		return (await api.delete(`${baseUrl}/${id}`, { params })).data;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while deleting portfolio");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while deleting portfolio");
-	}
+	requireWorkspace(workspace, "delete a portfolio");
+	return (await request(() => api.delete(`${baseUrl}/${id}`, { params: { workspace } }), "Error deleting portfolio")).portfolio;
 };
 //#endregion
 export { createPortfolio, deletePortfolio, getPortfolio, listPortfolios, updatePortfolio };

package/dist/api/portfolio.js.map

@@ -1 +1 @@
-{"version":3,"file":"portfolio.js","names":[],"sources":["../../src/api/portfolio.ts"],"sourcesContent":["import { isAxiosError, type AxiosInstance, type AxiosResponse } from \"axios\";\n\nimport type { QueryObject } from \"@/types/entityQuery\";\nimport type { AnyRecord } from \"@/types/anyRecord\";\nimport type { FilterExpression } from \"@/types/entityQuery\";\nimport type { Portfolio, PortfolioListResponse, PortfolioSingleResponse } from \"@/types/portfolio\";\n\nconst baseUrl = \"portfolios\";\n\n/**\n * getPortfolio\n *\n * Fetches a single portfolio by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - Portfolio identifier.\n * @param {string} workspace - Workspace the portfolio belongs to.\n * @returns {Promise<PortfolioSingleResponse>} The fetched portfolio response.\n *\n * @throws {Error} If the request fails.\n */\nexport const getPortfolio = async (api: AxiosInstance, id: string, workspace: string): Promise<PortfolioSingleResponse> => {\n  const params: AnyRecord = { workspace };\n\n  if(!workspace){\n    throw new Error(\"Workspace is required to fetch a portfolio\");\n  }\n\n  try {\n    const response: AxiosResponse<PortfolioSingleResponse> = await api.get(`${baseUrl}/${id}`, { params });\n    return response.data;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n     throw new Error(error.message || \"Error while fetching portfolio\");\n    }\n\n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while fetching portfolio\");\n  }\n};\n\n/**\n * listPortfolios\n *\n * Fetches a list of portfolios using a query object (filters, order, pagination, etc.).\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {QueryObject} query - Query object built via `buildQueryObject`.\n * @returns {Promise<PortfolioListResponse>} List of portfolios.\n *\n * @throws {Error} If the request fails.\n */\nexport const listPortfolios = async (api: AxiosInstance, query: QueryObject): Promise<PortfolioListResponse> => {\n    const workspaceFilter = query.filters.find((filter: FilterExpression) => filter[0] === \"workspace\");\n    const workspace = workspaceFilter?.[workspaceFilter.length - 1];\n\n    if (!workspace) {\n      throw new Error(\"Workspace is required to fetch portfolios\");\n    }\n\n    const params: AnyRecord = {\n      workspace,\n      ...(query ? { query: JSON.stringify(query) } : {}),\n    };\n\n    try {\n      const response: AxiosResponse<PortfolioListResponse> = await api.get(baseUrl, { params });\n      return response.data;\n    } catch (error: unknown) {\n      if (isAxiosError<AnyRecord>(error)) {\n        throw new Error(error.message || \"Error while fetching portfolios\");\n      }\n\n      if (error instanceof Error) {\n        throw error;\n      }\n\n      throw new Error(\"Error while fetching portfolios\");\n    }\n}\n\n/**\n * createPortfolio\n *\n * Creates a new portfolio.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {Partial<Portfolio>} data - Portfolio payload.\n * @returns {Promise<Portfolio>} The created portfolio.\n *\n * @throws {Error} If the request fails.\n */\nexport const createPortfolio = async (api: AxiosInstance, data: Partial<Portfolio>): Promise<Portfolio> => {\n\n  const { workspace } = data;\n\n   if (!workspace) {\n    throw new Error(\"Workspace is required to post a portfolio\");\n  }\n\n  try {\n    const response: AxiosResponse<Portfolio> = await api.post(baseUrl, data);\n    return response.data;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n      throw new Error(error.message || \"Error while creating portfolio\");\n    }\n\n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while creating portfolio\");\n  }\n}\n\n/**\n * updatePortfolio\n *\n * Updates an existing portfolio by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - Portfolio identifier.\n * @param {Partial<Portfolio>} data - Fields to update.\n * @returns {Promise<Portfolio>} The updated portfolio.\n *\n * @throws {Error} If the request fails.\n */\nexport const updatePortfolio = async (api: AxiosInstance, id: string, data: Partial<Portfolio>): Promise<Portfolio> => {\n\n  const { workspace } = data;\n  \n  if(!workspace) {\n    throw new Error(\"Workspace is required to delete a portfolio\");\n  }\n\n  try {\n    const response: AxiosResponse<Portfolio> = await api.put(`${baseUrl}/${id}`, data);\n    return response.data;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n      throw new Error(error.message || \"Error while updating portfolio\");\n    }\n\n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while updating portfolio\");\n  }\n}\n\n/**\n * deletePortfolio\n *\n * Deletes a portfolio by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - Portfolio identifier.\n * @param {string} workspace - Workspace the portfolio belongs to.\n * @returns {Promise<Portfolio>} The deleted portfolio.\n *\n * @throws {Error} If the request fails.\n */\nexport const deletePortfolio = async (api: AxiosInstance, id: string, workspace: string): Promise<Portfolio> => {\n  \n  if(!workspace) {\n    throw new Error(\"Workspace is required to delete a portfolio\");\n  }\n  \n  const params: AnyRecord = { workspace };\n\n  try {\n    const response: AxiosResponse<Portfolio> = await api.delete(`${baseUrl}/${id}`, { params });\n    return response.data;\n  } catch (error: unknown) {\n    if (isAxiosError<AnyRecord>(error)) {\n      throw new Error(error.message || \"Error while deleting portfolio\");\n    }\n\n    if (error instanceof Error) {\n      throw error;\n    }\n\n    throw new Error(\"Error while deleting portfolio\");\n  }\n}"],"mappings":";;AAOA,IAAM,UAAU;;;;;;;;;;;;;AAchB,IAAa,eAAe,OAAO,KAAoB,IAAY,cAAwD;CACzH,MAAM,SAAoB,EAAE,UAAU;CAEtC,IAAG,CAAC,WACF,MAAM,IAAI,MAAM,4CAA4C;CAG9D,IAAI;EAEF,QAAO,MADwD,IAAI,IAAI,GAAG,QAAQ,GAAG,MAAM,EAAE,OAAO,CAAC,EAAA,CACrF;CAClB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAChC,MAAM,IAAI,MAAM,MAAM,WAAW,gCAAgC;EAGlE,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,gCAAgC;CAClD;AACF;;;;;;;;;;;;AAaA,IAAa,iBAAiB,OAAO,KAAoB,UAAuD;CAC5G,MAAM,kBAAkB,MAAM,QAAQ,MAAM,WAA6B,OAAO,OAAO,WAAW;CAClG,MAAM,YAAY,kBAAkB,gBAAgB,SAAS;CAE7D,IAAI,CAAC,WACH,MAAM,IAAI,MAAM,2CAA2C;CAG7D,MAAM,SAAoB;EACxB;EACA,GAAI,QAAQ,EAAE,OAAO,KAAK,UAAU,KAAK,EAAE,IAAI,CAAC;CAClD;CAEA,IAAI;EAEF,QAAO,MADsD,IAAI,IAAI,SAAS,EAAE,OAAO,CAAC,EAAA,CACxE;CAClB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAC/B,MAAM,IAAI,MAAM,MAAM,WAAW,iCAAiC;EAGpE,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,iCAAiC;CACnD;AACJ;;;;;;;;;;;;AAaA,IAAa,kBAAkB,OAAO,KAAoB,SAAiD;CAEzG,MAAM,EAAE,cAAc;CAErB,IAAI,CAAC,WACJ,MAAM,IAAI,MAAM,2CAA2C;CAG7D,IAAI;EAEF,QAAO,MAD0C,IAAI,KAAK,SAAS,IAAI,EAAA,CACvD;CAClB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAC/B,MAAM,IAAI,MAAM,MAAM,WAAW,gCAAgC;EAGnE,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,gCAAgC;CAClD;AACF;;;;;;;;;;;;;AAcA,IAAa,kBAAkB,OAAO,KAAoB,IAAY,SAAiD;CAErH,MAAM,EAAE,cAAc;CAEtB,IAAG,CAAC,WACF,MAAM,IAAI,MAAM,6CAA6C;CAG/D,IAAI;EAEF,QAAO,MAD0C,IAAI,IAAI,GAAG,QAAQ,GAAG,MAAM,IAAI,EAAA,CACjE;CAClB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAC/B,MAAM,IAAI,MAAM,MAAM,WAAW,gCAAgC;EAGnE,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,gCAAgC;CAClD;AACF;;;;;;;;;;;;;AAcA,IAAa,kBAAkB,OAAO,KAAoB,IAAY,cAA0C;CAE9G,IAAG,CAAC,WACF,MAAM,IAAI,MAAM,6CAA6C;CAG/D,MAAM,SAAoB,EAAE,UAAU;CAEtC,IAAI;EAEF,QAAO,MAD0C,IAAI,OAAO,GAAG,QAAQ,GAAG,MAAM,EAAE,OAAO,CAAC,EAAA,CAC1E;CAClB,SAAS,OAAgB;EACvB,IAAI,aAAwB,KAAK,GAC/B,MAAM,IAAI,MAAM,MAAM,WAAW,gCAAgC;EAGnE,IAAI,iBAAiB,OACnB,MAAM;EAGR,MAAM,IAAI,MAAM,gCAAgC;CAClD;AACF"}
+{"version":3,"file":"portfolio.js","names":[],"sources":["../../src/api/portfolio.ts"],"sourcesContent":["import type { AxiosInstance } from \"axios\";\n\nimport type {\n    DeletedEntity,\n    DeleteEntityResponse,\n    EntitySingleResponse,\n    QueryObject,\n} from \"@/types/entityQuery\";\nimport type { Portfolio, PortfolioListResponse } from \"@/types/portfolio\";\nimport { listParams, request, requireWorkspace } from \"./request\";\n\nconst baseUrl = \"portfolios\";\n\n/** The endpoint's envelopes, private: every function here returns the entity itself. */\ntype PortfolioSingleResponse = EntitySingleResponse<\"portfolio\", Portfolio>;\ntype DeletePortfolioResponse = DeleteEntityResponse<\"portfolio\">;\n\n/**\n * getPortfolio\n *\n * Fetches a single portfolio by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - Portfolio identifier.\n * @param {string} workspace - Workspace the portfolio belongs to.\n * @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.\n * @returns {Promise<Portfolio>} The fetched portfolio.\n *\n * @throws {Error} If the request fails.\n */\nexport const getPortfolio = async (\n    api: AxiosInstance,\n    id: string,\n    workspace: string,\n    signal?: AbortSignal,\n): Promise<Portfolio> => {\n    requireWorkspace(workspace, \"fetch a portfolio\");\n\n    const body = await request(\n        () =>\n            api.get<PortfolioSingleResponse>(`${baseUrl}/${id}`, { params: { workspace }, signal }),\n        \"Error fetching portfolio\",\n    );\n    return body.portfolio;\n};\n\n/**\n * listPortfolios\n *\n * Fetches a list of portfolios using a query object (filters, order, pagination, etc.).\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {QueryObject} query - Query object built via `buildQueryObject`.\n * @param {AbortSignal} [signal] - Aborts the request itself; the list hooks pass the query's own.\n * @returns {Promise<PortfolioListResponse>} List of portfolios.\n *\n * @throws {Error} If the query has no workspace filter.\n * @throws {Error} If the request fails.\n */\nexport const listPortfolios = async (\n    api: AxiosInstance,\n    query: QueryObject,\n    signal?: AbortSignal,\n): Promise<PortfolioListResponse> => {\n    const params = listParams(query, \"list portfolios\");\n\n    return request(\n        () => api.get<PortfolioListResponse>(baseUrl, { params, signal }),\n        \"Error listing portfolios\",\n    );\n};\n\n/**\n * createPortfolio\n *\n * Creates a new portfolio.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {Partial<Portfolio>} data - Portfolio payload.\n * @returns {Promise<Portfolio>} The created portfolio.\n *\n * @throws {Error} If the request fails.\n */\nexport const createPortfolio = async (\n    api: AxiosInstance,\n    data: Partial<Portfolio>,\n): Promise<Portfolio> => {\n    requireWorkspace(data.workspace, \"create a portfolio\");\n\n    const body = await request(\n        () => api.post<PortfolioSingleResponse>(baseUrl, data),\n        \"Error creating portfolio\",\n    );\n    return body.portfolio;\n};\n\n/**\n * updatePortfolio\n *\n * Updates an existing portfolio by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - Portfolio identifier.\n * @param {Partial<Portfolio>} data - Fields to update.\n * @returns {Promise<Portfolio>} The updated portfolio.\n *\n * @throws {Error} If the request fails.\n */\nexport const updatePortfolio = async (\n    api: AxiosInstance,\n    id: string,\n    data: Partial<Portfolio>,\n): Promise<Portfolio> => {\n    requireWorkspace(data.workspace, \"update a portfolio\");\n\n    const body = await request(\n        () => api.put<PortfolioSingleResponse>(`${baseUrl}/${id}`, data),\n        \"Error updating portfolio\",\n    );\n    return body.portfolio;\n};\n\n/**\n * deletePortfolio\n *\n * Deletes a portfolio by ID.\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {string} id - Portfolio identifier.\n * @param {string} workspace - Workspace the portfolio belongs to.\n * @returns {Promise<DeletedEntity>} The deletion record: id, name and `deleted`.\n *\n * @throws {Error} If the request fails.\n */\nexport const deletePortfolio = async (\n    api: AxiosInstance,\n    id: string,\n    workspace: string,\n): Promise<DeletedEntity> => {\n    requireWorkspace(workspace, \"delete a portfolio\");\n\n    const body = await request(\n        () => api.delete<DeletePortfolioResponse>(`${baseUrl}/${id}`, { params: { workspace } }),\n        \"Error deleting portfolio\",\n    );\n    return body.portfolio;\n};\n"],"mappings":";;AAWA,IAAM,UAAU;;;;;;;;;;;;;;AAmBhB,IAAa,eAAe,OACxB,KACA,IACA,WACA,WACqB;CACrB,iBAAiB,WAAW,mBAAmB;CAO/C,QAAO,MALY,cAEX,IAAI,IAA6B,GAAG,QAAQ,GAAG,MAAM;EAAE,QAAQ,EAAE,UAAU;EAAG;CAAO,CAAC,GAC1F,0BACJ,EAAA,CACY;AAChB;;;;;;;;;;;;;;AAeA,IAAa,iBAAiB,OAC1B,KACA,OACA,WACiC;CACjC,MAAM,SAAS,WAAW,OAAO,iBAAiB;CAElD,OAAO,cACG,IAAI,IAA2B,SAAS;EAAE;EAAQ;CAAO,CAAC,GAChE,0BACJ;AACJ;;;;;;;;;;;;AAaA,IAAa,kBAAkB,OAC3B,KACA,SACqB;CACrB,iBAAiB,KAAK,WAAW,oBAAoB;CAMrD,QAAO,MAJY,cACT,IAAI,KAA8B,SAAS,IAAI,GACrD,0BACJ,EAAA,CACY;AAChB;;;;;;;;;;;;;AAcA,IAAa,kBAAkB,OAC3B,KACA,IACA,SACqB;CACrB,iBAAiB,KAAK,WAAW,oBAAoB;CAMrD,QAAO,MAJY,cACT,IAAI,IAA6B,GAAG,QAAQ,GAAG,MAAM,IAAI,GAC/D,0BACJ,EAAA,CACY;AAChB;;;;;;;;;;;;;AAcA,IAAa,kBAAkB,OAC3B,KACA,IACA,cACyB;CACzB,iBAAiB,WAAW,oBAAoB;CAMhD,QAAO,MAJY,cACT,IAAI,OAAgC,GAAG,QAAQ,GAAG,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,GACvF,0BACJ,EAAA,CACY;AAChB"}

package/dist/api/profile.d.ts

@@ -1,4 +1,4 @@
-import { type AxiosInstance } from "axios";
+import type { AxiosInstance } from "axios";
 import type { Profile } from "../types/profile.d.ts";
 /**
  * DEV_PROFILE — the profile served while running the dev server.
@@ -32,9 +32,10 @@ export declare const DEV_PROFILE: Profile;
  *
  * @param {AxiosInstance} api - Axios instance.
  * @param {Profile} [fallback] - Returned instead of calling the API, when present.
+ * @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.
  * @returns {Promise<Profile>} The logged user's profile.
  *
  * @throws {Error} If the request fails.
  */
-export declare const getProfile: (api: AxiosInstance, fallback?: Profile) => Promise<Profile>;
+export declare const getProfile: (api: AxiosInstance, fallback?: Profile, signal?: AbortSignal) => Promise<Profile>;
 //# sourceMappingURL=profile.d.ts.map

package/dist/api/profile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../../src/api/profile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,aAAa,EAAsB,MAAM,OAAO,CAAC;AAG7E,OAAO,KAAK,EAAE,OAAO,EAAmB,MAAM,iBAAiB,CAAC;AAIhE;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,EAAE,OAkBzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,UAAU,GAAU,KAAK,aAAa,EAAE,WAAW,OAAO,KAAG,OAAO,CAAC,OAAO,CAiBxF,CAAC"}
+{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../../src/api/profile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAgB/C;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,EAAE,OAkBzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,UAAU,GACnB,KAAK,aAAa,EAClB,WAAW,OAAO,EAClB,SAAS,WAAW,KACrB,OAAO,CAAC,OAAO,CAQjB,CAAC"}

package/dist/api/profile.js

@@ -1,4 +1,4 @@
-import { isAxiosError } from "axios";
+import { request } from "./request.js";
 //#region src/api/profile.ts
 var baseUrl = "profile";
 /**
@@ -51,19 +51,14 @@ var DEV_PROFILE = {
 *
 * @param {AxiosInstance} api - Axios instance.
 * @param {Profile} [fallback] - Returned instead of calling the API, when present.
+* @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.
 * @returns {Promise<Profile>} The logged user's profile.
 *
 * @throws {Error} If the request fails.
 */
-var getProfile = async (api, fallback) => {
+var getProfile = async (api, fallback, signal) => {
 	if (fallback) return fallback;
-	try {
-		return (await api.get(baseUrl)).data.profile;
-	} catch (error) {
-		if (isAxiosError(error)) throw new Error(error.message || "Error while fetching profile");
-		if (error instanceof Error) throw error;
-		throw new Error("Error while fetching profile");
-	}
+	return (await request(() => api.get(baseUrl, { signal }), "Error fetching profile")).profile;
 };
 //#endregion
 export { DEV_PROFILE, getProfile };

package/dist/api/profile.js.map

@@ -1 +1 @@
-{"version":3,"file":"profile.js","names":[],"sources":["../../src/api/profile.ts"],"sourcesContent":["import { isAxiosError, type AxiosInstance, type AxiosResponse } from \"axios\";\n\nimport type { AnyRecord } from \"@/types/anyRecord\";\nimport type { Profile, ProfileResponse } from \"@/types/profile\";\n\nconst baseUrl = \"profile\";\n\n/**\n * DEV_PROFILE — the profile served while running the dev server.\n *\n * `GET /api/profile` only works in production: it resolves the user from the session, and in dev\n * the Vite proxy authenticates with OAuth2 client credentials (a machine token, no logged user),\n * so the endpoint has no session to read and the request fails. This stands in for it and covers\n * every field the API returns, so a screen renders with realistic values in dev.\n *\n * The values are deliberately obvious placeholders — see `docs/development.md`.\n */\nexport const DEV_PROFILE: Profile = {\n    email: \"dev@everysk.com\",\n    user_type: \"USER\",\n    region: \"BR\",\n    company_name: \"Everysk (dev)\",\n    first_name: \"Dev\",\n    last_name: \"User\",\n    phone: \"+55 11 0000-0000\",\n    address: \"Dev address, 0\",\n    billing_email: \"dev@everysk.com\",\n    time_zone: \"America/Sao_Paulo\",\n    company_logo: \"\",\n    user_role: \"ADMIN\",\n    skin_theme: \"light\",\n    account_deletion_requested: false,\n    asset: \"\",\n    owner: true,\n    auto_refresh: false,\n};\n\n/**\n * getProfile\n *\n * Fetches the profile of the logged user. The endpoint takes no parameters — the API resolves the\n * user from the session — so an app always gets whoever is using it.\n *\n * When `fallback` is given it is returned as-is and the network is never touched. That is how an\n * app serves `DEV_PROFILE` while running the dev server, where the endpoint cannot resolve.\n *\n * The template decided this itself with `if (import.meta.env.DEV) return DEV_PROFILE`. That\n * cannot live in a published package: Vite replaces `import.meta.env.DEV` with a literal at the\n * build of whoever compiles the file, so the branch would freeze to whatever the SDK's own build\n * was and stop tracking the consuming app entirely. Which environment counts as \"dev\" is the\n * app's question, so the app answers it:\n *\n * ```ts\n * useFetchProfile({ fallback: import.meta.env.DEV ? DEV_PROFILE : undefined });\n * ```\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {Profile} [fallback] - Returned instead of calling the API, when present.\n * @returns {Promise<Profile>} The logged user's profile.\n *\n * @throws {Error} If the request fails.\n */\nexport const getProfile = async (api: AxiosInstance, fallback?: Profile): Promise<Profile> => {\n    if (fallback) return fallback;\n\n    try {\n        const response: AxiosResponse<ProfileResponse> = await api.get(baseUrl);\n        return response.data.profile;\n    } catch (error: unknown) {\n        if (isAxiosError<AnyRecord>(error)) {\n            throw new Error(error.message || \"Error while fetching profile\");\n        }\n\n        if (error instanceof Error) {\n            throw error;\n        }\n\n        throw new Error(\"Error while fetching profile\");\n    }\n};\n"],"mappings":";;AAKA,IAAM,UAAU;;;;;;;;;;;AAYhB,IAAa,cAAuB;CAChC,OAAO;CACP,WAAW;CACX,QAAQ;CACR,cAAc;CACd,YAAY;CACZ,WAAW;CACX,OAAO;CACP,SAAS;CACT,eAAe;CACf,WAAW;CACX,cAAc;CACd,WAAW;CACX,YAAY;CACZ,4BAA4B;CAC5B,OAAO;CACP,OAAO;CACP,cAAc;AAClB;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,IAAa,aAAa,OAAO,KAAoB,aAAyC;CAC1F,IAAI,UAAU,OAAO;CAErB,IAAI;EAEA,QAAO,MADgD,IAAI,IAAI,OAAO,EAAA,CACtD,KAAK;CACzB,SAAS,OAAgB;EACrB,IAAI,aAAwB,KAAK,GAC7B,MAAM,IAAI,MAAM,MAAM,WAAW,8BAA8B;EAGnE,IAAI,iBAAiB,OACjB,MAAM;EAGV,MAAM,IAAI,MAAM,8BAA8B;CAClD;AACJ"}
+{"version":3,"file":"profile.js","names":[],"sources":["../../src/api/profile.ts"],"sourcesContent":["import type { AxiosInstance } from \"axios\";\n\nimport type { Profile } from \"@/types/profile\";\nimport { request } from \"./request\";\n\nconst baseUrl = \"profile\";\n\n/**\n * The endpoint's envelope, private: `getProfile` returns the profile itself.\n *\n * It does not follow `EntitySingleResponse`: `/api/profile` is an app-only route rather than an\n * entity, and carries a `status` beside the profile.\n */\ntype ProfileResponse = {\n    status: string;\n    profile: Profile;\n};\n\n/**\n * DEV_PROFILE — the profile served while running the dev server.\n *\n * `GET /api/profile` only works in production: it resolves the user from the session, and in dev\n * the Vite proxy authenticates with OAuth2 client credentials (a machine token, no logged user),\n * so the endpoint has no session to read and the request fails. This stands in for it and covers\n * every field the API returns, so a screen renders with realistic values in dev.\n *\n * The values are deliberately obvious placeholders — see `docs/development.md`.\n */\nexport const DEV_PROFILE: Profile = {\n    email: \"dev@everysk.com\",\n    user_type: \"USER\",\n    region: \"BR\",\n    company_name: \"Everysk (dev)\",\n    first_name: \"Dev\",\n    last_name: \"User\",\n    phone: \"+55 11 0000-0000\",\n    address: \"Dev address, 0\",\n    billing_email: \"dev@everysk.com\",\n    time_zone: \"America/Sao_Paulo\",\n    company_logo: \"\",\n    user_role: \"ADMIN\",\n    skin_theme: \"light\",\n    account_deletion_requested: false,\n    asset: \"\",\n    owner: true,\n    auto_refresh: false,\n};\n\n/**\n * getProfile\n *\n * Fetches the profile of the logged user. The endpoint takes no parameters — the API resolves the\n * user from the session — so an app always gets whoever is using it.\n *\n * When `fallback` is given it is returned as-is and the network is never touched. That is how an\n * app serves `DEV_PROFILE` while running the dev server, where the endpoint cannot resolve.\n *\n * The template decided this itself with `if (import.meta.env.DEV) return DEV_PROFILE`. That\n * cannot live in a published package: Vite replaces `import.meta.env.DEV` with a literal at the\n * build of whoever compiles the file, so the branch would freeze to whatever the SDK's own build\n * was and stop tracking the consuming app entirely. Which environment counts as \"dev\" is the\n * app's question, so the app answers it:\n *\n * ```ts\n * useFetchProfile({ fallback: import.meta.env.DEV ? DEV_PROFILE : undefined });\n * ```\n *\n * @param {AxiosInstance} api - Axios instance.\n * @param {Profile} [fallback] - Returned instead of calling the API, when present.\n * @param {AbortSignal} [signal] - Aborts the request itself; the entity hooks pass the query's own.\n * @returns {Promise<Profile>} The logged user's profile.\n *\n * @throws {Error} If the request fails.\n */\nexport const getProfile = async (\n    api: AxiosInstance,\n    fallback?: Profile,\n    signal?: AbortSignal,\n): Promise<Profile> => {\n    if (fallback) return fallback;\n\n    const body = await request(\n        () => api.get<ProfileResponse>(baseUrl, { signal }),\n        \"Error fetching profile\",\n    );\n    return body.profile;\n};\n"],"mappings":";;AAKA,IAAM,UAAU;;;;;;;;;;;AAuBhB,IAAa,cAAuB;CAChC,OAAO;CACP,WAAW;CACX,QAAQ;CACR,cAAc;CACd,YAAY;CACZ,WAAW;CACX,OAAO;CACP,SAAS;CACT,eAAe;CACf,WAAW;CACX,cAAc;CACd,WAAW;CACX,YAAY;CACZ,4BAA4B;CAC5B,OAAO;CACP,OAAO;CACP,cAAc;AAClB;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,IAAa,aAAa,OACtB,KACA,UACA,WACmB;CACnB,IAAI,UAAU,OAAO;CAMrB,QAAO,MAJY,cACT,IAAI,IAAqB,SAAS,EAAE,OAAO,CAAC,GAClD,wBACJ,EAAA,CACY;AAChB"}