@keboola/api-client 27.0.0 → 31.0.0

package/README.md

@@ -199,7 +199,7 @@ src/
   utils/
     concurrent.ts               # Concurrent task runner with middleware
     series.ts                   # Sequential task runner
-    poll.ts                     # Polling with isDone/isFailed predicates
+    poll/                       # Polling: the loop, the poller, the registry
     delay.ts                    # Abortable delay
     keboolaUID.ts               # Keboola object ID serialization
     generateUUID.ts             # crypto.randomUUID wrapper
@@ -363,27 +363,36 @@ const ordered = await series({
 
 ### poll
 
+A poll **returns** how it ended — `done`, `timedOut`, `exhausted`, `aborted`, `errored` — so nothing is
+thrown at a caller that wants to branch. `unwrap()` is the shortcut for the caller that doesn't: it
+resolves the value or throws.
+
 ```typescript
-import { poll, PollException } from '@keboola/api-client';
+import { poll } from '@keboola/api-client';
+
+// `pollKey` is the poll's identity, in the shape of a TanStack query key. It is handed to `pollFn`
+// the way a `queryFn` gets its key, and dev tools name a running poll from it.
+// `backoff` names the curve by the field it starts from: `interval` for `constant`, `initialInterval`
+// for `linear` and `exponential`. Add `jitter: 'full' | 'equal'` to spread a herd of polls apart.
+const result = await poll({
+  pollKey: ['queue.job', { jobId }] as const,
+  pollFn: ({ pollKey: [, params], signal }) => api.queue.getJob(params.jobId, signal),
+  until: ({ data }) => data.status === 'success' || data.status === 'error',
+  backoff: { type: 'exponential', initialInterval: 1000, factor: 2, maxInterval: 30_000 },
+  maxAttempts: 30,
+  timeout: 5 * 60_000,
+});
 
-const controller = new AbortController();
+if (result.state === 'done') console.log(result.data.status);
 
-try {
-  const { data, callCount } = await poll({
-    pollFn: (signal) => api.queue.getJob(jobId, signal),
-    isDone: (job) => job.status === 'success',
-    isFailed: (job) => job.status === 'error',
-    interval: 2000,
-    maxAttempts: 30,
-    abortSignal: controller.signal,
-  });
-} catch (error) {
-  if (error instanceof PollException) {
-    console.error(error.message, error.result);
-  }
-}
+// Or: resolve the value, throw on anything else. `stop()` ends the poll from outside.
+const task = poll({ pollFn, until });
+const job = await task.unwrap();
 ```
 
+`poller(options)` is the same thing cold — it polls only once `start()` is called, and adds
+`subscribe()` / `debug()` for watching a poll's attempts as they happen.
+
 ### keboolaUID
 
 ```typescript
@@ -448,6 +457,27 @@ MIT. See [LICENSE](./LICENSE).
 
 Internal guide for adding new service clients to this package.
 
+### Method naming conventions
+
+A method's name states what the call does, so a call site can tell whether the work is finished once the promise settles. Clients expose the endpoint methods plus — where the endpoint enqueues a job — a wait-variant suffixed `AndWait`.
+
+| What the call does                               | Name shape | Example                       |
+| ------------------------------------------------ | ---------- | ----------------------------- |
+| returns the finished resource in one request     | bare verb  | `buckets.getBucket()`         |
+| enqueues the work and hands back a `Job` to poll | `*Async`   | `tables.createTableAsync()`   |
+| enqueues the work and polls it to completion     | `*AndWait` | `tables.createTableAndWait()` |
+
+The suffix is a suffix on purpose: a wait-variant shares its sibling's prefix, so the two sort together in autocomplete.
+
+Names that are ruled out, and why:
+
+- **bare verb** for a wait-variant — `buckets.deleteBucket` is a genuinely synchronous endpoint sitting next to `deleteBucketAsync`, so one name shape would mean two different things.
+- **`*Sync`** as the opposite of `*Async` — in JavaScript that promises no yielding (`readFileSync`).
+- **`createTableAsync(input, { wait: true })`** — both branches return `Job`, the same TS type, so nothing discriminates work that is merely enqueued from work that is done.
+- **`*AndPoll`** — names the transport rather than the contract.
+
+[`poll`](#poll) is the shared engine underneath. Storage's wait helpers currently live in the `sdks/storage` layer under bare-verb names; new ones go on the client.
+
 ### Testing conventions
 
 Tests are co-located `*.test.ts` files run by Vitest. There are two complementary ways to fake the network — pick by what the test is about:
@@ -472,6 +502,11 @@ Publish-time export-shape validation stays in `build:check` via `attw` — ortho
 
 ### Adding a New OpenAPI Client
 
+> These are the mechanical steps. The decisions they don't cover — client vs SDK, method naming,
+> what to do when the published spec is wrong, what not to test — are the eight rules in
+> [`AGENTS.md`](./AGENTS.md#eight-rules-for-a-new-client-or-sdk). Read those first; each one is a
+> review round somebody already paid for.
+
 #### Step 1: Register the API in `redocly.yaml`
 
 Add your API specification to the `redocly.yaml` file:
@@ -552,7 +587,7 @@ export * from './yourNewServiceClient';
 
 #### Step 6: Add Type Export to package.json
 
-Add the type export path to `package.json` exports and add the entry to `tsup.config.ts`:
+Add the type export path to `package.json` exports and add the entry to `tsdown.config.ts`:
 
 ```json
 {

package/dist/ManagementClientAuthError-90pvsej0.js

@@ -0,0 +1,15 @@
+import { m as ApiError } from "./createFetchClient-B1h3-p65.js";
+//#region src/errors/ManagementClientAuthError.ts
+var ManagementClientAuthError = class extends ApiError {
+	title;
+	message;
+	constructor(title, message, res) {
+		super(res);
+		this.title = title;
+		this.message = message;
+	}
+};
+//#endregion
+export { ManagementClientAuthError as t };
+
+//# sourceMappingURL=ManagementClientAuthError-90pvsej0.js.map

package/dist/ManagementClientAuthError-90pvsej0.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManagementClientAuthError-90pvsej0.js","names":[],"sources":["../src/errors/ManagementClientAuthError.ts"],"sourcesContent":["import type { ApiResponse } from '../fetchClient/createFetchClient/types';\n\nimport { ApiError } from './ApiError';\n\nexport class ManagementClientAuthError extends ApiError {\n  title: string;\n  message: string;\n  constructor(title: string, message: string, res: ApiResponse) {\n    super(res);\n    this.title = title;\n    this.message = message;\n  }\n}\n"],"mappings":";;AAIA,IAAa,4BAAb,cAA+C,SAAS;CACtD;CACA;CACA,YAAY,OAAe,SAAiB,KAAkB;EAC5D,MAAM,GAAG;EACT,KAAK,QAAQ;EACb,KAAK,UAAU;CACjB;AACF"}

package/dist/ManagementClientAuthError-DFhi5yxe.cjs

@@ -0,0 +1,20 @@
+const require_createFetchClient = require("./createFetchClient-B9Cv0W9f.cjs");
+//#region src/errors/ManagementClientAuthError.ts
+var ManagementClientAuthError = class extends require_createFetchClient.ApiError {
+	title;
+	message;
+	constructor(title, message, res) {
+		super(res);
+		this.title = title;
+		this.message = message;
+	}
+};
+//#endregion
+Object.defineProperty(exports, "ManagementClientAuthError", {
+	enumerable: true,
+	get: function() {
+		return ManagementClientAuthError;
+	}
+});
+
+//# sourceMappingURL=ManagementClientAuthError-DFhi5yxe.cjs.map

package/dist/ManagementClientAuthError-DFhi5yxe.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManagementClientAuthError-DFhi5yxe.cjs","names":["ApiError"],"sources":["../src/errors/ManagementClientAuthError.ts"],"sourcesContent":["import type { ApiResponse } from '../fetchClient/createFetchClient/types';\n\nimport { ApiError } from './ApiError';\n\nexport class ManagementClientAuthError extends ApiError {\n  title: string;\n  message: string;\n  constructor(title: string, message: string, res: ApiResponse) {\n    super(res);\n    this.title = title;\n    this.message = message;\n  }\n}\n"],"mappings":";;AAIA,IAAa,4BAAb,cAA+CA,0BAAAA,SAAS;CACtD;CACA;CACA,YAAY,OAAe,SAAiB,KAAkB;EAC5D,MAAM,GAAG;EACT,KAAK,QAAQ;EACb,KAAK,UAAU;CACjB;AACF"}

package/dist/QueryJobTimeoutError-C7JbNGOM.js

@@ -0,0 +1,38 @@
+//#region src/errors/QueryJobError.ts
+/**
+* A query job that reached the API's terminal `failed` state — the submit/poll round-trip
+* succeeded, the job itself did not. Distinct from {@link ApiError}, which is an HTTP-level failure
+* of the submit/poll/results requests themselves.
+*/
+var QueryJobError = class QueryJobError extends Error {
+	queryJobId;
+	failedStatements;
+	constructor(message, queryJobId, { failedStatements }) {
+		super(message);
+		this.name = "QueryJobError";
+		this.queryJobId = queryJobId;
+		this.failedStatements = failedStatements;
+		Object.setPrototypeOf(this, QueryJobError.prototype);
+	}
+};
+const isQueryJobError = (error) => error instanceof QueryJobError;
+//#endregion
+//#region src/errors/QueryJobTimeoutError.ts
+/**
+* A query job that never reached a terminal state within the caller's `maxWaitTime` — the job may
+* still complete later; this only means `waitForJob`/`executeQuery` gave up watching it.
+*/
+var QueryJobTimeoutError = class QueryJobTimeoutError extends Error {
+	queryJobId;
+	constructor(message, queryJobId) {
+		super(message);
+		this.name = "QueryJobTimeoutError";
+		this.queryJobId = queryJobId;
+		Object.setPrototypeOf(this, QueryJobTimeoutError.prototype);
+	}
+};
+const isQueryJobTimeoutError = (error) => error instanceof QueryJobTimeoutError;
+//#endregion
+export { isQueryJobError as i, isQueryJobTimeoutError as n, QueryJobError as r, QueryJobTimeoutError as t };
+
+//# sourceMappingURL=QueryJobTimeoutError-C7JbNGOM.js.map

package/dist/QueryJobTimeoutError-C7JbNGOM.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryJobTimeoutError-C7JbNGOM.js","names":[],"sources":["../src/errors/QueryJobError.ts","../src/errors/QueryJobTimeoutError.ts"],"sourcesContent":["type FailedStatement = {\n  id: string;\n  error?: string;\n};\n\ntype QueryJobErrorOptions = {\n  failedStatements: FailedStatement[];\n};\n\n/**\n * A query job that reached the API's terminal `failed` state — the submit/poll round-trip\n * succeeded, the job itself did not. Distinct from {@link ApiError}, which is an HTTP-level failure\n * of the submit/poll/results requests themselves.\n */\nexport class QueryJobError extends Error {\n  queryJobId: string;\n  failedStatements: FailedStatement[];\n\n  constructor(message: string, queryJobId: string, { failedStatements }: QueryJobErrorOptions) {\n    super(message);\n    this.name = 'QueryJobError';\n    this.queryJobId = queryJobId;\n    this.failedStatements = failedStatements;\n    Object.setPrototypeOf(this, QueryJobError.prototype);\n  }\n}\n\nexport const isQueryJobError = (error: unknown): error is QueryJobError =>\n  error instanceof QueryJobError;\n","/**\n * A query job that never reached a terminal state within the caller's `maxWaitTime` — the job may\n * still complete later; this only means `waitForJob`/`executeQuery` gave up watching it.\n */\nexport class QueryJobTimeoutError extends Error {\n  queryJobId: string;\n\n  constructor(message: string, queryJobId: string) {\n    super(message);\n    this.name = 'QueryJobTimeoutError';\n    this.queryJobId = queryJobId;\n    Object.setPrototypeOf(this, QueryJobTimeoutError.prototype);\n  }\n}\n\nexport const isQueryJobTimeoutError = (error: unknown): error is QueryJobTimeoutError =>\n  error instanceof QueryJobTimeoutError;\n"],"mappings":";;;;;;AAcA,IAAa,gBAAb,MAAa,sBAAsB,MAAM;CACvC;CACA;CAEA,YAAY,SAAiB,YAAoB,EAAE,oBAA0C;EAC3F,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,aAAa;EAClB,KAAK,mBAAmB;EACxB,OAAO,eAAe,MAAM,cAAc,SAAS;CACrD;AACF;AAEA,MAAa,mBAAmB,UAC9B,iBAAiB;;;;;;;ACxBnB,IAAa,uBAAb,MAAa,6BAA6B,MAAM;CAC9C;CAEA,YAAY,SAAiB,YAAoB;EAC/C,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,aAAa;EAClB,OAAO,eAAe,MAAM,qBAAqB,SAAS;CAC5D;AACF;AAEA,MAAa,0BAA0B,UACrC,iBAAiB"}

package/dist/QueryJobTimeoutError-CVNPdCWX.cjs

@@ -0,0 +1,61 @@
+//#region src/errors/QueryJobError.ts
+/**
+* A query job that reached the API's terminal `failed` state — the submit/poll round-trip
+* succeeded, the job itself did not. Distinct from {@link ApiError}, which is an HTTP-level failure
+* of the submit/poll/results requests themselves.
+*/
+var QueryJobError = class QueryJobError extends Error {
+	queryJobId;
+	failedStatements;
+	constructor(message, queryJobId, { failedStatements }) {
+		super(message);
+		this.name = "QueryJobError";
+		this.queryJobId = queryJobId;
+		this.failedStatements = failedStatements;
+		Object.setPrototypeOf(this, QueryJobError.prototype);
+	}
+};
+const isQueryJobError = (error) => error instanceof QueryJobError;
+//#endregion
+//#region src/errors/QueryJobTimeoutError.ts
+/**
+* A query job that never reached a terminal state within the caller's `maxWaitTime` — the job may
+* still complete later; this only means `waitForJob`/`executeQuery` gave up watching it.
+*/
+var QueryJobTimeoutError = class QueryJobTimeoutError extends Error {
+	queryJobId;
+	constructor(message, queryJobId) {
+		super(message);
+		this.name = "QueryJobTimeoutError";
+		this.queryJobId = queryJobId;
+		Object.setPrototypeOf(this, QueryJobTimeoutError.prototype);
+	}
+};
+const isQueryJobTimeoutError = (error) => error instanceof QueryJobTimeoutError;
+//#endregion
+Object.defineProperty(exports, "QueryJobError", {
+	enumerable: true,
+	get: function() {
+		return QueryJobError;
+	}
+});
+Object.defineProperty(exports, "QueryJobTimeoutError", {
+	enumerable: true,
+	get: function() {
+		return QueryJobTimeoutError;
+	}
+});
+Object.defineProperty(exports, "isQueryJobError", {
+	enumerable: true,
+	get: function() {
+		return isQueryJobError;
+	}
+});
+Object.defineProperty(exports, "isQueryJobTimeoutError", {
+	enumerable: true,
+	get: function() {
+		return isQueryJobTimeoutError;
+	}
+});
+
+//# sourceMappingURL=QueryJobTimeoutError-CVNPdCWX.cjs.map

package/dist/QueryJobTimeoutError-CVNPdCWX.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryJobTimeoutError-CVNPdCWX.cjs","names":[],"sources":["../src/errors/QueryJobError.ts","../src/errors/QueryJobTimeoutError.ts"],"sourcesContent":["type FailedStatement = {\n  id: string;\n  error?: string;\n};\n\ntype QueryJobErrorOptions = {\n  failedStatements: FailedStatement[];\n};\n\n/**\n * A query job that reached the API's terminal `failed` state — the submit/poll round-trip\n * succeeded, the job itself did not. Distinct from {@link ApiError}, which is an HTTP-level failure\n * of the submit/poll/results requests themselves.\n */\nexport class QueryJobError extends Error {\n  queryJobId: string;\n  failedStatements: FailedStatement[];\n\n  constructor(message: string, queryJobId: string, { failedStatements }: QueryJobErrorOptions) {\n    super(message);\n    this.name = 'QueryJobError';\n    this.queryJobId = queryJobId;\n    this.failedStatements = failedStatements;\n    Object.setPrototypeOf(this, QueryJobError.prototype);\n  }\n}\n\nexport const isQueryJobError = (error: unknown): error is QueryJobError =>\n  error instanceof QueryJobError;\n","/**\n * A query job that never reached a terminal state within the caller's `maxWaitTime` — the job may\n * still complete later; this only means `waitForJob`/`executeQuery` gave up watching it.\n */\nexport class QueryJobTimeoutError extends Error {\n  queryJobId: string;\n\n  constructor(message: string, queryJobId: string) {\n    super(message);\n    this.name = 'QueryJobTimeoutError';\n    this.queryJobId = queryJobId;\n    Object.setPrototypeOf(this, QueryJobTimeoutError.prototype);\n  }\n}\n\nexport const isQueryJobTimeoutError = (error: unknown): error is QueryJobTimeoutError =>\n  error instanceof QueryJobTimeoutError;\n"],"mappings":";;;;;;AAcA,IAAa,gBAAb,MAAa,sBAAsB,MAAM;CACvC;CACA;CAEA,YAAY,SAAiB,YAAoB,EAAE,oBAA0C;EAC3F,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,aAAa;EAClB,KAAK,mBAAmB;EACxB,OAAO,eAAe,MAAM,cAAc,SAAS;CACrD;AACF;AAEA,MAAa,mBAAmB,UAC9B,iBAAiB;;;;;;;ACxBnB,IAAa,uBAAb,MAAa,6BAA6B,MAAM;CAC9C;CAEA,YAAY,SAAiB,YAAoB;EAC/C,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,aAAa;EAClB,OAAO,eAAe,MAAM,qBAAqB,SAAS;CAC5D;AACF;AAEA,MAAa,0BAA0B,UACrC,iBAAiB"}

package/dist/SyncActionError-BG0zwchi.cjs

@@ -0,0 +1,35 @@
+//#region src/errors/SyncActionError.ts
+/**
+* A sync action reports failure two ways: a non-2xx response, and a 2xx response whose body carries
+* `status: 'error'` (the component ran, and said no). Both collapse into this class so consumers
+* branch on one thing.
+*/
+var SyncActionError = class SyncActionError extends Error {
+	exceptionId;
+	code;
+	data;
+	constructor(message, { exceptionId, code, data } = {}) {
+		super(message);
+		this.name = "SyncActionError";
+		this.exceptionId = exceptionId;
+		this.code = code;
+		this.data = data;
+		Object.setPrototypeOf(this, SyncActionError.prototype);
+	}
+};
+const isSyncActionError = (error) => error instanceof SyncActionError;
+//#endregion
+Object.defineProperty(exports, "SyncActionError", {
+	enumerable: true,
+	get: function() {
+		return SyncActionError;
+	}
+});
+Object.defineProperty(exports, "isSyncActionError", {
+	enumerable: true,
+	get: function() {
+		return isSyncActionError;
+	}
+});
+
+//# sourceMappingURL=SyncActionError-BG0zwchi.cjs.map

package/dist/SyncActionError-BG0zwchi.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SyncActionError-BG0zwchi.cjs","names":[],"sources":["../src/errors/SyncActionError.ts"],"sourcesContent":["type SyncActionErrorOptions = {\n  exceptionId?: string;\n  code?: number;\n  data?: unknown;\n};\n\n/**\n * A sync action reports failure two ways: a non-2xx response, and a 2xx response whose body carries\n * `status: 'error'` (the component ran, and said no). Both collapse into this class so consumers\n * branch on one thing.\n */\nexport class SyncActionError extends Error {\n  exceptionId?: string;\n  code?: number;\n  data?: unknown;\n\n  constructor(message: string, { exceptionId, code, data }: SyncActionErrorOptions = {}) {\n    super(message);\n    this.name = 'SyncActionError';\n    this.exceptionId = exceptionId;\n    this.code = code;\n    this.data = data;\n    Object.setPrototypeOf(this, SyncActionError.prototype);\n  }\n}\n\nexport const isSyncActionError = (error: unknown): error is SyncActionError =>\n  error instanceof SyncActionError;\n"],"mappings":";;;;;;AAWA,IAAa,kBAAb,MAAa,wBAAwB,MAAM;CACzC;CACA;CACA;CAEA,YAAY,SAAiB,EAAE,aAAa,MAAM,SAAiC,CAAC,GAAG;EACrF,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,cAAc;EACnB,KAAK,OAAO;EACZ,KAAK,OAAO;EACZ,OAAO,eAAe,MAAM,gBAAgB,SAAS;CACvD;AACF;AAEA,MAAa,qBAAqB,UAChC,iBAAiB"}

package/dist/SyncActionError-CoZFsdUk.js

@@ -0,0 +1,24 @@
+//#region src/errors/SyncActionError.ts
+/**
+* A sync action reports failure two ways: a non-2xx response, and a 2xx response whose body carries
+* `status: 'error'` (the component ran, and said no). Both collapse into this class so consumers
+* branch on one thing.
+*/
+var SyncActionError = class SyncActionError extends Error {
+	exceptionId;
+	code;
+	data;
+	constructor(message, { exceptionId, code, data } = {}) {
+		super(message);
+		this.name = "SyncActionError";
+		this.exceptionId = exceptionId;
+		this.code = code;
+		this.data = data;
+		Object.setPrototypeOf(this, SyncActionError.prototype);
+	}
+};
+const isSyncActionError = (error) => error instanceof SyncActionError;
+//#endregion
+export { isSyncActionError as n, SyncActionError as t };
+
+//# sourceMappingURL=SyncActionError-CoZFsdUk.js.map

package/dist/SyncActionError-CoZFsdUk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SyncActionError-CoZFsdUk.js","names":[],"sources":["../src/errors/SyncActionError.ts"],"sourcesContent":["type SyncActionErrorOptions = {\n  exceptionId?: string;\n  code?: number;\n  data?: unknown;\n};\n\n/**\n * A sync action reports failure two ways: a non-2xx response, and a 2xx response whose body carries\n * `status: 'error'` (the component ran, and said no). Both collapse into this class so consumers\n * branch on one thing.\n */\nexport class SyncActionError extends Error {\n  exceptionId?: string;\n  code?: number;\n  data?: unknown;\n\n  constructor(message: string, { exceptionId, code, data }: SyncActionErrorOptions = {}) {\n    super(message);\n    this.name = 'SyncActionError';\n    this.exceptionId = exceptionId;\n    this.code = code;\n    this.data = data;\n    Object.setPrototypeOf(this, SyncActionError.prototype);\n  }\n}\n\nexport const isSyncActionError = (error: unknown): error is SyncActionError =>\n  error instanceof SyncActionError;\n"],"mappings":";;;;;;AAWA,IAAa,kBAAb,MAAa,wBAAwB,MAAM;CACzC;CACA;CACA;CAEA,YAAY,SAAiB,EAAE,aAAa,MAAM,SAAiC,CAAC,GAAG;EACrF,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,cAAc;EACnB,KAAK,OAAO;EACZ,KAAK,OAAO;EACZ,OAAO,eAAe,MAAM,gBAAgB,SAAS;CACvD;AACF;AAEA,MAAa,qBAAqB,UAChC,iBAAiB"}

package/dist/UserError-By_Zckmc.js

@@ -0,0 +1,10 @@
+//#region src/errors/UserError.ts
+var UserError = class extends Error {
+	constructor(message) {
+		super(message);
+	}
+};
+//#endregion
+export { UserError as t };
+
+//# sourceMappingURL=UserError-By_Zckmc.js.map

package/dist/UserError-By_Zckmc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserError-By_Zckmc.js","names":[],"sources":["../src/errors/UserError.ts"],"sourcesContent":["export class UserError extends Error {\n  constructor(message: string) {\n    super(message);\n  }\n}\n"],"mappings":";AAAA,IAAa,YAAb,cAA+B,MAAM;CACnC,YAAY,SAAiB;EAC3B,MAAM,OAAO;CACf;AACF"}

package/dist/UserError-CSGO1qII.cjs

@@ -0,0 +1,15 @@
+//#region src/errors/UserError.ts
+var UserError = class extends Error {
+	constructor(message) {
+		super(message);
+	}
+};
+//#endregion
+Object.defineProperty(exports, "UserError", {
+	enumerable: true,
+	get: function() {
+		return UserError;
+	}
+});
+
+//# sourceMappingURL=UserError-CSGO1qII.cjs.map

package/dist/UserError-CSGO1qII.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserError-CSGO1qII.cjs","names":[],"sources":["../src/errors/UserError.ts"],"sourcesContent":["export class UserError extends Error {\n  constructor(message: string) {\n    super(message);\n  }\n}\n"],"mappings":";AAAA,IAAa,YAAb,cAA+B,MAAM;CACnC,YAAY,SAAiB;EAC3B,MAAM,OAAO;CACf;AACF"}

package/dist/ValidationError-CzPWydEb.js

@@ -0,0 +1,44 @@
+//#region src/errors/ValidationError.ts
+/**
+* A payload the SDK refused to accept — an input a caller assembled wrongly, or a response that did
+* not match the shape the endpoint is documented to return.
+*
+* It exists so a `ZodError` never leaves the package. `ZodError.message` is `JSON.stringify` of its
+* issue list — over a kilobyte for two problems — and a consumer that renders a caught error's
+* message puts that blob in front of a user. `message` here is a single line built for exactly that
+* rendering, while `issues` keeps the structured detail for anyone inspecting the failure rather
+* than displaying it.
+*/
+var ValidationError = class ValidationError extends Error {
+	issues;
+	constructor(message, issues = []) {
+		super(message);
+		this.name = "ValidationError";
+		this.issues = issues;
+		Object.setPrototypeOf(this, ValidationError.prototype);
+	}
+};
+const isValidationError = (error) => error instanceof ValidationError;
+/**
+* One line per issue, prefixed by the field it belongs to. Not `z.prettifyError`, which formats for
+* a terminal — its `✖`/`→` glyphs and newlines survive a log but collapse into one run-on line in
+* HTML, where most of these end up.
+*/
+const formatIssues = (issues) => issues.map((issue) => {
+	const path = issue.path.join(".");
+	return path ? `${path}: ${issue.message}` : issue.message;
+}).join("; ");
+/**
+* Parses with `schema`, converting a `ZodError` into a {@link ValidationError}. Use it instead of a
+* bare `schema.parse()` anywhere the value crosses the package boundary — every client input and
+* every response body.
+*/
+const parseOrThrow = (schema, value) => {
+	const result = schema.safeParse(value);
+	if (result.success) return result.data;
+	throw new ValidationError(formatIssues(result.error.issues), result.error.issues);
+};
+//#endregion
+export { isValidationError as n, parseOrThrow as r, ValidationError as t };
+
+//# sourceMappingURL=ValidationError-CzPWydEb.js.map

package/dist/ValidationError-CzPWydEb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationError-CzPWydEb.js","names":[],"sources":["../src/errors/ValidationError.ts"],"sourcesContent":["import type * as z from 'zod';\n\n/**\n * A payload the SDK refused to accept — an input a caller assembled wrongly, or a response that did\n * not match the shape the endpoint is documented to return.\n *\n * It exists so a `ZodError` never leaves the package. `ZodError.message` is `JSON.stringify` of its\n * issue list — over a kilobyte for two problems — and a consumer that renders a caught error's\n * message puts that blob in front of a user. `message` here is a single line built for exactly that\n * rendering, while `issues` keeps the structured detail for anyone inspecting the failure rather\n * than displaying it.\n */\nexport class ValidationError extends Error {\n  issues: z.core.$ZodIssue[];\n\n  constructor(message: string, issues: z.core.$ZodIssue[] = []) {\n    super(message);\n    this.name = 'ValidationError';\n    this.issues = issues;\n    Object.setPrototypeOf(this, ValidationError.prototype);\n  }\n}\n\nexport const isValidationError = (error: unknown): error is ValidationError =>\n  error instanceof ValidationError;\n\n/**\n * One line per issue, prefixed by the field it belongs to. Not `z.prettifyError`, which formats for\n * a terminal — its `✖`/`→` glyphs and newlines survive a log but collapse into one run-on line in\n * HTML, where most of these end up.\n */\nconst formatIssues = (issues: readonly z.core.$ZodIssue[]) =>\n  issues\n    .map((issue) => {\n      const path = issue.path.join('.');\n\n      // A root-level issue is about the payload as a whole, and its message already says so —\n      // prefixing it with a name for \"the whole thing\" only adds noise.\n      return path ? `${path}: ${issue.message}` : issue.message;\n    })\n    .join('; ');\n\n/**\n * Parses with `schema`, converting a `ZodError` into a {@link ValidationError}. Use it instead of a\n * bare `schema.parse()` anywhere the value crosses the package boundary — every client input and\n * every response body.\n */\nexport const parseOrThrow = <T extends z.ZodType>(schema: T, value: unknown): z.output<T> => {\n  const result = schema.safeParse(value);\n\n  if (result.success) return result.data;\n\n  throw new ValidationError(formatIssues(result.error.issues), result.error.issues);\n};\n"],"mappings":";;;;;;;;;;;AAYA,IAAa,kBAAb,MAAa,wBAAwB,MAAM;CACzC;CAEA,YAAY,SAAiB,SAA6B,CAAC,GAAG;EAC5D,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,OAAO,eAAe,MAAM,gBAAgB,SAAS;CACvD;AACF;AAEA,MAAa,qBAAqB,UAChC,iBAAiB;;;;;;AAOnB,MAAM,gBAAgB,WACpB,OACG,KAAK,UAAU;CACd,MAAM,OAAO,MAAM,KAAK,KAAK,GAAG;CAIhC,OAAO,OAAO,GAAG,KAAK,IAAI,MAAM,YAAY,MAAM;AACpD,CAAC,CAAC,CACD,KAAK,IAAI;;;;;;AAOd,MAAa,gBAAqC,QAAW,UAAgC;CAC3F,MAAM,SAAS,OAAO,UAAU,KAAK;CAErC,IAAI,OAAO,SAAS,OAAO,OAAO;CAElC,MAAM,IAAI,gBAAgB,aAAa,OAAO,MAAM,MAAM,GAAG,OAAO,MAAM,MAAM;AAClF"}

package/dist/ValidationError-h5qvwahi.cjs

@@ -0,0 +1,61 @@
+//#region src/errors/ValidationError.ts
+/**
+* A payload the SDK refused to accept — an input a caller assembled wrongly, or a response that did
+* not match the shape the endpoint is documented to return.
+*
+* It exists so a `ZodError` never leaves the package. `ZodError.message` is `JSON.stringify` of its
+* issue list — over a kilobyte for two problems — and a consumer that renders a caught error's
+* message puts that blob in front of a user. `message` here is a single line built for exactly that
+* rendering, while `issues` keeps the structured detail for anyone inspecting the failure rather
+* than displaying it.
+*/
+var ValidationError = class ValidationError extends Error {
+	issues;
+	constructor(message, issues = []) {
+		super(message);
+		this.name = "ValidationError";
+		this.issues = issues;
+		Object.setPrototypeOf(this, ValidationError.prototype);
+	}
+};
+const isValidationError = (error) => error instanceof ValidationError;
+/**
+* One line per issue, prefixed by the field it belongs to. Not `z.prettifyError`, which formats for
+* a terminal — its `✖`/`→` glyphs and newlines survive a log but collapse into one run-on line in
+* HTML, where most of these end up.
+*/
+const formatIssues = (issues) => issues.map((issue) => {
+	const path = issue.path.join(".");
+	return path ? `${path}: ${issue.message}` : issue.message;
+}).join("; ");
+/**
+* Parses with `schema`, converting a `ZodError` into a {@link ValidationError}. Use it instead of a
+* bare `schema.parse()` anywhere the value crosses the package boundary — every client input and
+* every response body.
+*/
+const parseOrThrow = (schema, value) => {
+	const result = schema.safeParse(value);
+	if (result.success) return result.data;
+	throw new ValidationError(formatIssues(result.error.issues), result.error.issues);
+};
+//#endregion
+Object.defineProperty(exports, "ValidationError", {
+	enumerable: true,
+	get: function() {
+		return ValidationError;
+	}
+});
+Object.defineProperty(exports, "isValidationError", {
+	enumerable: true,
+	get: function() {
+		return isValidationError;
+	}
+});
+Object.defineProperty(exports, "parseOrThrow", {
+	enumerable: true,
+	get: function() {
+		return parseOrThrow;
+	}
+});
+
+//# sourceMappingURL=ValidationError-h5qvwahi.cjs.map

package/dist/ValidationError-h5qvwahi.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationError-h5qvwahi.cjs","names":[],"sources":["../src/errors/ValidationError.ts"],"sourcesContent":["import type * as z from 'zod';\n\n/**\n * A payload the SDK refused to accept — an input a caller assembled wrongly, or a response that did\n * not match the shape the endpoint is documented to return.\n *\n * It exists so a `ZodError` never leaves the package. `ZodError.message` is `JSON.stringify` of its\n * issue list — over a kilobyte for two problems — and a consumer that renders a caught error's\n * message puts that blob in front of a user. `message` here is a single line built for exactly that\n * rendering, while `issues` keeps the structured detail for anyone inspecting the failure rather\n * than displaying it.\n */\nexport class ValidationError extends Error {\n  issues: z.core.$ZodIssue[];\n\n  constructor(message: string, issues: z.core.$ZodIssue[] = []) {\n    super(message);\n    this.name = 'ValidationError';\n    this.issues = issues;\n    Object.setPrototypeOf(this, ValidationError.prototype);\n  }\n}\n\nexport const isValidationError = (error: unknown): error is ValidationError =>\n  error instanceof ValidationError;\n\n/**\n * One line per issue, prefixed by the field it belongs to. Not `z.prettifyError`, which formats for\n * a terminal — its `✖`/`→` glyphs and newlines survive a log but collapse into one run-on line in\n * HTML, where most of these end up.\n */\nconst formatIssues = (issues: readonly z.core.$ZodIssue[]) =>\n  issues\n    .map((issue) => {\n      const path = issue.path.join('.');\n\n      // A root-level issue is about the payload as a whole, and its message already says so —\n      // prefixing it with a name for \"the whole thing\" only adds noise.\n      return path ? `${path}: ${issue.message}` : issue.message;\n    })\n    .join('; ');\n\n/**\n * Parses with `schema`, converting a `ZodError` into a {@link ValidationError}. Use it instead of a\n * bare `schema.parse()` anywhere the value crosses the package boundary — every client input and\n * every response body.\n */\nexport const parseOrThrow = <T extends z.ZodType>(schema: T, value: unknown): z.output<T> => {\n  const result = schema.safeParse(value);\n\n  if (result.success) return result.data;\n\n  throw new ValidationError(formatIssues(result.error.issues), result.error.issues);\n};\n"],"mappings":";;;;;;;;;;;AAYA,IAAa,kBAAb,MAAa,wBAAwB,MAAM;CACzC;CAEA,YAAY,SAAiB,SAA6B,CAAC,GAAG;EAC5D,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,OAAO,eAAe,MAAM,gBAAgB,SAAS;CACvD;AACF;AAEA,MAAa,qBAAqB,UAChC,iBAAiB;;;;;;AAOnB,MAAM,gBAAgB,WACpB,OACG,KAAK,UAAU;CACd,MAAM,OAAO,MAAM,KAAK,KAAK,GAAG;CAIhC,OAAO,OAAO,GAAG,KAAK,IAAI,MAAM,YAAY,MAAM;AACpD,CAAC,CAAC,CACD,KAAK,IAAI;;;;;;AAOd,MAAa,gBAAqC,QAAW,UAAgC;CAC3F,MAAM,SAAS,OAAO,UAAU,KAAK;CAErC,IAAI,OAAO,SAAS,OAAO,OAAO;CAElC,MAAM,IAAI,gBAAgB,aAAa,OAAO,MAAM,MAAM,GAAG,OAAO,MAAM,MAAM;AAClF"}

package/dist/adminRoles-B40yBcmq.js

@@ -0,0 +1,14 @@
+//#region src/constants/adminRoles.ts
+const AdminRole = {
+	Admin: "admin",
+	Share: "share",
+	ProductionManager: "productionManager",
+	Developer: "developer",
+	Reviewer: "reviewer",
+	ReadOnly: "readOnly",
+	Guest: "guest"
+};
+//#endregion
+export { AdminRole as t };
+
+//# sourceMappingURL=adminRoles-B40yBcmq.js.map

package/dist/adminRoles-B40yBcmq.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adminRoles-B40yBcmq.js","names":[],"sources":["../src/constants/adminRoles.ts"],"sourcesContent":["export const AdminRole = {\n  Admin: 'admin',\n  Share: 'share',\n  ProductionManager: 'productionManager',\n  Developer: 'developer',\n  Reviewer: 'reviewer',\n  ReadOnly: 'readOnly',\n  Guest: 'guest',\n} as const;\n\nexport type AdminRole = (typeof AdminRole)[keyof typeof AdminRole];\n"],"mappings":";AAAA,MAAa,YAAY;CACvB,OAAO;CACP,OAAO;CACP,mBAAmB;CACnB,WAAW;CACX,UAAU;CACV,UAAU;CACV,OAAO;AACT"}

package/dist/adminRoles-C696kD_U.d.cts

@@ -0,0 +1,14 @@
+//#region src/constants/adminRoles.d.ts
+declare const AdminRole: {
+  readonly Admin: 'admin';
+  readonly Share: 'share';
+  readonly ProductionManager: 'productionManager';
+  readonly Developer: 'developer';
+  readonly Reviewer: 'reviewer';
+  readonly ReadOnly: 'readOnly';
+  readonly Guest: 'guest';
+};
+type AdminRole = (typeof AdminRole)[keyof typeof AdminRole];
+//#endregion
+export { AdminRole as t };
+//# sourceMappingURL=adminRoles-C696kD_U.d.cts.map

package/dist/adminRoles-C696kD_U.d.ts

@@ -0,0 +1,14 @@
+//#region src/constants/adminRoles.d.ts
+declare const AdminRole: {
+  readonly Admin: 'admin';
+  readonly Share: 'share';
+  readonly ProductionManager: 'productionManager';
+  readonly Developer: 'developer';
+  readonly Reviewer: 'reviewer';
+  readonly ReadOnly: 'readOnly';
+  readonly Guest: 'guest';
+};
+type AdminRole = (typeof AdminRole)[keyof typeof AdminRole];
+//#endregion
+export { AdminRole as t };
+//# sourceMappingURL=adminRoles-C696kD_U.d.ts.map

package/dist/adminRoles-CO7J5qAy.cjs

@@ -0,0 +1,19 @@
+//#region src/constants/adminRoles.ts
+const AdminRole = {
+	Admin: "admin",
+	Share: "share",
+	ProductionManager: "productionManager",
+	Developer: "developer",
+	Reviewer: "reviewer",
+	ReadOnly: "readOnly",
+	Guest: "guest"
+};
+//#endregion
+Object.defineProperty(exports, "AdminRole", {
+	enumerable: true,
+	get: function() {
+		return AdminRole;
+	}
+});
+
+//# sourceMappingURL=adminRoles-CO7J5qAy.cjs.map

package/dist/adminRoles-CO7J5qAy.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"adminRoles-CO7J5qAy.cjs","names":[],"sources":["../src/constants/adminRoles.ts"],"sourcesContent":["export const AdminRole = {\n  Admin: 'admin',\n  Share: 'share',\n  ProductionManager: 'productionManager',\n  Developer: 'developer',\n  Reviewer: 'reviewer',\n  ReadOnly: 'readOnly',\n  Guest: 'guest',\n} as const;\n\nexport type AdminRole = (typeof AdminRole)[keyof typeof AdminRole];\n"],"mappings":";AAAA,MAAa,YAAY;CACvB,OAAO;CACP,OAAO;CACP,mBAAmB;CACnB,WAAW;CACX,UAAU;CACV,UAAU;CACV,OAAO;AACT"}