@everysk/apps-sdk 0.1.0-beta.0

package/dist/api/portfolio.js

@@ -0,0 +1,125 @@
+import { isAxiosError } from "axios";
+//#region src/api/portfolio.ts
+var baseUrl = "portfolios";
+/**
+* getPortfolio
+*
+* Fetches a single portfolio by ID.
+*
+* @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.
+*
+* @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");
+	}
+};
+/**
+* listPortfolios
+*
+* Fetches a list of portfolios using a query object (filters, order, pagination, etc.).
+*
+* @param {AxiosInstance} api - Axios instance.
+* @param {QueryObject} query - Query object built via `buildQueryObject`.
+* @returns {Promise<PortfolioListResponse>} List of portfolios.
+*
+* @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");
+	}
+};
+/**
+* createPortfolio
+*
+* Creates a new portfolio.
+*
+* @param {AxiosInstance} api - Axios instance.
+* @param {Partial<Portfolio>} data - Portfolio payload.
+* @returns {Promise<Portfolio>} The created portfolio.
+*
+* @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");
+	}
+};
+/**
+* updatePortfolio
+*
+* Updates an existing portfolio by ID.
+*
+* @param {AxiosInstance} api - Axios instance.
+* @param {string} id - Portfolio identifier.
+* @param {Partial<Portfolio>} data - Fields to update.
+* @returns {Promise<Portfolio>} The updated portfolio.
+*
+* @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");
+	}
+};
+/**
+* deletePortfolio
+*
+* Deletes a portfolio by ID.
+*
+* @param {AxiosInstance} api - Axios instance.
+* @param {string} id - Portfolio identifier.
+* @param {string} workspace - Workspace the portfolio belongs to.
+* @returns {Promise<Portfolio>} The deleted portfolio.
+*
+* @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");
+	}
+};
+//#endregion
+export { createPortfolio, deletePortfolio, getPortfolio, listPortfolios, updatePortfolio };
+
+//# sourceMappingURL=portfolio.js.map

package/dist/api/portfolio.js.map

@@ -0,0 +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"}

package/dist/api/profile.d.ts

@@ -0,0 +1,40 @@
+import { type AxiosInstance } from "axios";
+import type { Profile } from "../types/profile.d.ts";
+/**
+ * DEV_PROFILE — the profile served while running the dev server.
+ *
+ * `GET /api/profile` only works in production: it resolves the user from the session, and in dev
+ * the Vite proxy authenticates with OAuth2 client credentials (a machine token, no logged user),
+ * so the endpoint has no session to read and the request fails. This stands in for it and covers
+ * every field the API returns, so a screen renders with realistic values in dev.
+ *
+ * The values are deliberately obvious placeholders — see `docs/development.md`.
+ */
+export declare const DEV_PROFILE: Profile;
+/**
+ * getProfile
+ *
+ * Fetches the profile of the logged user. The endpoint takes no parameters — the API resolves the
+ * user from the session — so an app always gets whoever is using it.
+ *
+ * When `fallback` is given it is returned as-is and the network is never touched. That is how an
+ * app serves `DEV_PROFILE` while running the dev server, where the endpoint cannot resolve.
+ *
+ * The template decided this itself with `if (import.meta.env.DEV) return DEV_PROFILE`. That
+ * cannot live in a published package: Vite replaces `import.meta.env.DEV` with a literal at the
+ * build of whoever compiles the file, so the branch would freeze to whatever the SDK's own build
+ * was and stop tracking the consuming app entirely. Which environment counts as "dev" is the
+ * app's question, so the app answers it:
+ *
+ * ```ts
+ * useFetchProfile({ fallback: import.meta.env.DEV ? DEV_PROFILE : undefined });
+ * ```
+ *
+ * @param {AxiosInstance} api - Axios instance.
+ * @param {Profile} [fallback] - Returned instead of calling the API, when present.
+ * @returns {Promise<Profile>} The logged user's profile.
+ *
+ * @throws {Error} If the request fails.
+ */
+export declare const getProfile: (api: AxiosInstance, fallback?: Profile) => Promise<Profile>;
+//# sourceMappingURL=profile.d.ts.map

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

@@ -0,0 +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"}

package/dist/api/profile.js

@@ -0,0 +1,71 @@
+import { isAxiosError } from "axios";
+//#region src/api/profile.ts
+var baseUrl = "profile";
+/**
+* DEV_PROFILE — the profile served while running the dev server.
+*
+* `GET /api/profile` only works in production: it resolves the user from the session, and in dev
+* the Vite proxy authenticates with OAuth2 client credentials (a machine token, no logged user),
+* so the endpoint has no session to read and the request fails. This stands in for it and covers
+* every field the API returns, so a screen renders with realistic values in dev.
+*
+* The values are deliberately obvious placeholders — see `docs/development.md`.
+*/
+var DEV_PROFILE = {
+	email: "dev@everysk.com",
+	user_type: "USER",
+	region: "BR",
+	company_name: "Everysk (dev)",
+	first_name: "Dev",
+	last_name: "User",
+	phone: "+55 11 0000-0000",
+	address: "Dev address, 0",
+	billing_email: "dev@everysk.com",
+	time_zone: "America/Sao_Paulo",
+	company_logo: "",
+	user_role: "ADMIN",
+	skin_theme: "light",
+	account_deletion_requested: false,
+	asset: "",
+	owner: true,
+	auto_refresh: false
+};
+/**
+* getProfile
+*
+* Fetches the profile of the logged user. The endpoint takes no parameters — the API resolves the
+* user from the session — so an app always gets whoever is using it.
+*
+* When `fallback` is given it is returned as-is and the network is never touched. That is how an
+* app serves `DEV_PROFILE` while running the dev server, where the endpoint cannot resolve.
+*
+* The template decided this itself with `if (import.meta.env.DEV) return DEV_PROFILE`. That
+* cannot live in a published package: Vite replaces `import.meta.env.DEV` with a literal at the
+* build of whoever compiles the file, so the branch would freeze to whatever the SDK's own build
+* was and stop tracking the consuming app entirely. Which environment counts as "dev" is the
+* app's question, so the app answers it:
+*
+* ```ts
+* useFetchProfile({ fallback: import.meta.env.DEV ? DEV_PROFILE : undefined });
+* ```
+*
+* @param {AxiosInstance} api - Axios instance.
+* @param {Profile} [fallback] - Returned instead of calling the API, when present.
+* @returns {Promise<Profile>} The logged user's profile.
+*
+* @throws {Error} If the request fails.
+*/
+var getProfile = async (api, fallback) => {
+	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");
+	}
+};
+//#endregion
+export { DEV_PROFILE, getProfile };
+
+//# sourceMappingURL=profile.js.map

package/dist/api/profile.js.map

@@ -0,0 +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"}

package/dist/api/websocketsConfig.d.ts

@@ -0,0 +1,13 @@
+import { type AxiosInstance } from "axios";
+import type { WebsocketsConfig } from "../contexts/webSocketContext/types.d.ts";
+/**
+ * getWebsocketsConfig
+ *
+ * Fetches the Socket.IO connection config for the current user/app.
+ *
+ * @param {AxiosInstance} api - Axios instance (from `useAxios`).
+ * @returns {Promise<WebsocketsConfig>} Connection URL, channel id, and session uid.
+ * @throws {Error} If the request fails.
+ */
+export declare const getWebsocketsConfig: (api: AxiosInstance) => Promise<WebsocketsConfig>;
+//# sourceMappingURL=websocketsConfig.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocketsConfig.d.ts","sourceRoot":"","sources":["../../src/api/websocketsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,aAAa,EAAsB,MAAM,OAAO,CAAC;AAG7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAI1E;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,GAAU,KAAK,aAAa,KAAG,OAAO,CAAC,gBAAgB,CAetF,CAAC"}

package/dist/api/websocketsConfig.js

@@ -0,0 +1,25 @@
+import { isAxiosError } from "axios";
+//#region src/api/websocketsConfig.ts
+var baseUrl = "websockets_config";
+/**
+* getWebsocketsConfig
+*
+* Fetches the Socket.IO connection config for the current user/app.
+*
+* @param {AxiosInstance} api - Axios instance (from `useAxios`).
+* @returns {Promise<WebsocketsConfig>} Connection URL, channel id, and session uid.
+* @throws {Error} If the request fails.
+*/
+var getWebsocketsConfig = async (api) => {
+	try {
+		return (await api.get(baseUrl)).data;
+	} catch (error) {
+		if (isAxiosError(error)) throw new Error(error.message || "Error fetching websockets config");
+		if (error instanceof Error) throw error;
+		throw new Error("Error fetching websockets config");
+	}
+};
+//#endregion
+export { getWebsocketsConfig };
+
+//# sourceMappingURL=websocketsConfig.js.map

package/dist/api/websocketsConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocketsConfig.js","names":[],"sources":["../../src/api/websocketsConfig.ts"],"sourcesContent":["import { isAxiosError, type AxiosInstance, type AxiosResponse } from \"axios\";\n\nimport type { AnyRecord } from \"@/types/anyRecord\";\nimport type { WebsocketsConfig } from \"@/contexts/webSocketContext/types\";\n\nconst baseUrl = \"websockets_config\";\n\n/**\n * getWebsocketsConfig\n *\n * Fetches the Socket.IO connection config for the current user/app.\n *\n * @param {AxiosInstance} api - Axios instance (from `useAxios`).\n * @returns {Promise<WebsocketsConfig>} Connection URL, channel id, and session uid.\n * @throws {Error} If the request fails.\n */\nexport const getWebsocketsConfig = async (api: AxiosInstance): Promise<WebsocketsConfig> => {\n    try {\n        const response: AxiosResponse<WebsocketsConfig> = await api.get(baseUrl);\n        return response.data;\n    } catch (error: unknown) {\n        if (isAxiosError<AnyRecord>(error)) {\n            throw new Error(error.message || \"Error fetching websockets config\");\n        }\n\n        if (error instanceof Error) {\n            throw error;\n        }\n\n        throw new Error(\"Error fetching websockets config\");\n    }\n};\n"],"mappings":";;AAKA,IAAM,UAAU;;;;;;;;;;AAWhB,IAAa,sBAAsB,OAAO,QAAkD;CACxF,IAAI;EAEA,QAAO,MADiD,IAAI,IAAI,OAAO,EAAA,CACvD;CACpB,SAAS,OAAgB;EACrB,IAAI,aAAwB,KAAK,GAC7B,MAAM,IAAI,MAAM,MAAM,WAAW,kCAAkC;EAGvE,IAAI,iBAAiB,OACjB,MAAM;EAGV,MAAM,IAAI,MAAM,kCAAkC;CACtD;AACJ"}

package/dist/api/workflow.d.ts

@@ -0,0 +1,154 @@
+import { type AxiosInstance } from "axios";
+import type { AnyRecord } from "../types/anyRecord.d.ts";
+import type { QueryObject } from "../types/entityQuery.d.ts";
+import type { WorkerExecution, WorkerExecutionListResponse, Workflow, WorkflowExecution, WorkflowExecutionListResponse, WorkflowListResponse } from "../types/workflow.d.ts";
+/**
+ * Runs a workflow asynchronously.
+ *
+ * Starts the workflow in a non-blocking way: the response carries a workflow execution
+ * with a non-terminal status (e.g. "RUNNING"). Use polling to wait for the terminal state.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param id - The unique identifier of the workflow to run.
+ * @param workspace - The workspace in which the workflow will be executed.
+ * @param parameters - Key-value parameters to pass to the workflow.
+ * @returns A promise that resolves with the workflow execution response data.
+ * @throws {Error} If `workspace` is not provided.
+ * @throws {Error} If the request fails.
+ */
+export declare const runWorkflow: (api: AxiosInstance, id: string, workspace: string, parameters: AnyRecord) => Promise<AnyRecord>;
+/**
+ * Run statuses that indicate a workflow execution has reached a terminal state
+ * (i.e. it is no longer running and will not change again).
+ *
+ * Union of the backend's `WORKFLOW_EXECUTION_STATUS_FINISHED` set and the API's documented
+ * terminal `run_status` values (`SUCCEEDED`/`FAILED`/`KILLED`). `KILLED` is included so a
+ * killed execution is detected as terminal instead of polling until timeout.
+ */
+export declare const TERMINAL_RUN_STATUSES: readonly ["CANCELED", "COMPLETED", "SUCCEEDED", "FAILED", "KILLED"];
+export type PollWorkflowExecutionOptions = {
+    /** Delay between status checks, in milliseconds. Defaults to 2000ms. */
+    intervalMs?: number;
+    /** Maximum time to wait for a terminal status before giving up, in milliseconds. Defaults to 5 minutes. */
+    timeoutMs?: number;
+    /** Optional abort signal to cancel polling (e.g. on unmount). */
+    signal?: AbortSignal;
+};
+/**
+ * Polls a workflow execution until it reaches a terminal run status (see {@link TERMINAL_RUN_STATUSES}).
+ *
+ * This is the interim, non-blocking replacement for synchronous (`synchronous: true`) execution:
+ * the workflow is started asynchronously and its status is checked periodically until it completes.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param workflowId - The unique identifier of the workflow.
+ * @param executionId - The unique identifier of the workflow execution to poll.
+ * @param workspace - The workspace in which the workflow execution resides.
+ * @param options - Polling configuration (interval, timeout, abort signal).
+ * @returns A promise that resolves with the terminal {@link WorkflowExecution}.
+ * @throws {Error} If `workspace` is not provided.
+ * @throws {Error} If polling is aborted via `options.signal`.
+ * @throws {Error} If a terminal status is not reached before `options.timeoutMs` elapses.
+ */
+export declare const pollWorkflowExecution: (api: AxiosInstance, workflowId: string, executionId: string, workspace: string, options?: PollWorkflowExecutionOptions) => Promise<WorkflowExecution>;
+/**
+ * The terminal workflow execution together with the output produced by its final (ender) worker.
+ */
+export type WorkflowResult = {
+    /** The terminal workflow execution. */
+    execution: WorkflowExecution;
+    /** The ender worker execution, or `null` if the execution did not reference one. */
+    workerExecution: WorkerExecution | null;
+    /** The output data produced by the ender worker (`workerExecution.result`), or `null`. */
+    result: Record<string, unknown> | null;
+};
+/**
+ * Starts a workflow, polls it to completion, then fetches the output produced by its final worker.
+ *
+ * A workflow execution does not carry the output payload itself — it references the final worker via
+ * `ender_worker_execution_id`, and that worker execution's `result` field holds the actual data.
+ * This helper performs the full flow: start (async) → poll → fetch ender worker → return its `result`.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param id - The unique identifier of the workflow to run.
+ * @param workspace - The workspace in which the workflow will be executed.
+ * @param parameters - Key-value parameters to pass to the workflow.
+ * @param options - Polling configuration (interval, timeout, abort signal).
+ * @returns A promise that resolves with the {@link WorkflowResult} (execution, ender worker execution, and its result).
+ * @throws {Error} If `workspace` is not provided.
+ * @throws {Error} If the workflow execution ends in a "FAILED" run status.
+ * @throws {Error} If polling times out or is aborted.
+ */
+export declare const runWorkflowAndGetResult: (api: AxiosInstance, id: string, workspace: string, parameters: AnyRecord, options?: PollWorkflowExecutionOptions) => Promise<WorkflowResult>;
+/**
+ * Fetches a single workflow by ID.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param id - The unique identifier of the workflow to fetch.
+ * @param workspace - The workspace in which the workflow resides.
+ * @returns A promise that resolves with the {@link Workflow} object.
+ * @throws {Error} If `workspace` is not provided.
+ * @throws {Error} If the request fails.
+ */
+export declare const getWorkflow: (api: AxiosInstance, id: string, workspace: string) => Promise<Workflow>;
+/**
+ * Fetches a paginated list of workflows using the legacy method (workspace as query param).
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param workspace - Current workspace name. Sent as a query param via the legacy method, required by some API configurations.
+ * @param pageSize - Number of items per page.
+ * @param pageToken - Cursor token for the next page.
+ * @returns A promise that resolves with a {@link WorkflowListResponse} containing the matched workflows.
+ * @throws {Error} If the request fails.
+ */
+export declare const listWorkflows: (api: AxiosInstance, workspace?: string, pageSize?: number, pageToken?: string) => Promise<WorkflowListResponse>;
+/**
+ * Fetches a single workflow execution by ID.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param workflowId - The unique identifier of the workflow.
+ * @param executionId - The unique identifier of the workflow execution to fetch.
+ * @param workspace - The workspace in which the workflow execution resides.
+ * @returns A promise that resolves with the {@link WorkflowExecution} object.
+ * @throws {Error} If `workspace` is not provided.
+ * @throws {Error} If the request fails.
+ */
+export declare const getWorkflowExecution: (api: AxiosInstance, workflowId: string, executionId: string, workspace: string) => Promise<WorkflowExecution>;
+/**
+ * Fetches a paginated list of workflow executions matching the given query.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param workflowId - The unique identifier of the workflow whose executions to list.
+ * @param query - Query object containing filters, pagination, and sorting options.
+ *   Must include a `workspace` filter expression.
+ * @returns A promise that resolves with a {@link WorkflowExecutionListResponse} containing the matched executions.
+ * @throws {Error} If the `workspace` filter is not present in `query.filters`.
+ * @throws {Error} If the request fails.
+ */
+export declare const listWorkflowExecutions: (api: AxiosInstance, workflowId: string, query: QueryObject) => Promise<WorkflowExecutionListResponse>;
+/**
+ * Fetches a single worker execution by ID.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param workflowId - The unique identifier of the parent workflow.
+ * @param workerExecutionId - The unique identifier of the worker execution to fetch.
+ * @param workspace - The workspace in which the worker execution resides.
+ * @returns A promise that resolves with the {@link WorkerExecution} object.
+ * @throws {Error} If `workspace` is not provided.
+ * @throws {Error} If the request fails.
+ */
+export declare const getWorkerExecution: (api: AxiosInstance, workflowId: string, workerExecutionId: string, workspace: string) => Promise<WorkerExecution>;
+/**
+ * Fetches a paginated list of worker executions for a given workflow.
+ *
+ * @param api - Axios instance used to make the HTTP request.
+ * @param workflowId - The unique identifier of the parent workflow.
+ * @param workflowExecutionId - The unique identifier of the workflow execution to filter by.
+ * @param query - Query object containing filters, pagination, and sorting options.
+ *   Must include a `workspace` filter expression.
+ * @returns A promise that resolves with a {@link WorkerExecutionListResponse} containing the matched worker executions.
+ * @throws {Error} If the `workspace` filter is not present in `query.filters`.
+ * @throws {Error} If the request fails.
+ */
+export declare const listWorkerExecutions: (api: AxiosInstance, workflowId: string, workflowExecutionId: string, query: QueryObject) => Promise<WorkerExecutionListResponse>;
+//# sourceMappingURL=workflow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../src/api/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,aAAa,EAAsB,MAAM,OAAO,CAAC;AAE7E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,KAAK,EAAoB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,2BAA2B,EAAiC,QAAQ,EAAE,iBAAiB,EAAE,6BAA6B,EAAmC,oBAAoB,EAA0B,MAAM,kBAAkB,CAAC;AAI/P;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,WAAW,MAAM,EAAE,YAAY,SAAS,KAAG,OAAO,CAAC,SAAS,CA2B7H,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,qEAAsE,CAAC;AAOzG,MAAM,MAAM,4BAA4B,GAAG;IACzC,wEAAwE;IACxE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2GAA2G;IAC3G,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iEAAiE;IACjE,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB,GAChC,KAAK,aAAa,EAClB,YAAY,MAAM,EAClB,aAAa,MAAM,EACnB,WAAW,MAAM,EACjB,UAAS,4BAAiC,KACzC,OAAO,CAAC,iBAAiB,CAyB3B,CAAC;AAiDF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,uCAAuC;IACvC,SAAS,EAAE,iBAAiB,CAAC;IAC7B,oFAAoF;IACpF,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC,0FAA0F;IAC1F,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,uBAAuB,GAClC,KAAK,aAAa,EAClB,IAAI,MAAM,EACV,WAAW,MAAM,EACjB,YAAY,SAAS,EACrB,UAAS,4BAAiC,KACzC,OAAO,CAAC,cAAc,CAWxB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,GAAU,KAAK,aAAa,EAAE,IAAI,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,QAAQ,CAoBrG,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GAAU,KAAK,aAAa,EAAE,YAAY,MAAM,EAAE,WAAW,MAAM,EAAE,YAAY,MAAM,KAAG,OAAO,CAAC,oBAAoB,CAqB/I,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAU,KAAK,aAAa,EAAE,YAAY,MAAM,EAAE,aAAa,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,iBAAiB,CAoBpJ,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GAAU,KAAK,aAAa,EAAE,YAAY,MAAM,EAAE,OAAO,WAAW,KAAG,OAAO,CAAC,6BAA6B,CAyB9I,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,GAAU,KAAK,aAAa,EAAE,YAAY,MAAM,EAAE,mBAAmB,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,eAAe,CAoBtJ,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,GAAU,KAAK,aAAa,EAAE,YAAY,MAAM,EAAE,qBAAqB,MAAM,EAAE,OAAO,WAAW,KAAG,OAAO,CAAC,2BAA2B,CA0BvK,CAAC"}