@calmlens/sdk 0.10.1 → 0.12.0

package/cjs/CalmLensError-CKwMKV0S.js

@@ -0,0 +1,362 @@
+//#region src/client/CalmLensErrorCodes.ts
+/** Error codes the CalmLens API documents, by name. */
+const API_ERROR_CODES = {
+	MISSING_TOKEN: "auth/missing-token",
+	INVALID_API_KEY: "auth/invalid-api-key",
+	API_KEY_PROJECT_MISMATCH: "auth/project-mismatch",
+	API_KEY_NOT_ACCEPTED: "auth/api-key-not-accepted",
+	FILE_TOO_LARGE: "upload/file-too-large",
+	IMAGE_REQUIRES_MULTIPART_UPLOAD: "upload/image-requires-multipart-upload",
+	MULTIPART_IMAGE_TOO_SMALL: "upload/multipart-image-too-small",
+	MULTIPART_IMAGE_TOO_LARGE: "upload/multipart-image-too-large",
+	IMAGE_EXCEEDED_MAX_DIMENSIONS: "upload/image-exceeded-max-dimensions",
+	UPLOAD_LIMIT_EXCEEDED: "upload/limit-exceeded",
+	INVALID_UPLOAD_MIME_TYPE: "upload/invalid-mime-type",
+	INVALID_EVENT_CURSOR: "events/invalid-cursor",
+	INVALID_UPLOAD_PAYLOAD: "upload/invalid-payload",
+	USE_UPLOAD_PART: "upload/use-upload-part",
+	UPLOAD_NOT_OPEN: "upload/not-open",
+	INVALID_UPLOAD_PART_NUMBER: "upload/invalid-part-number",
+	UPLOAD_MISSING: "upload/missing",
+	UPLOAD_SIZE_MISMATCH: "upload/size-mismatch",
+	INVALID_IDEMPOTENCY_KEY: "idempotency/invalid-key",
+	IDEMPOTENCY_KEY_REUSED: "idempotency/key-reused",
+	IDEMPOTENT_REQUEST_IN_PROGRESS: "idempotency/request-in-progress",
+	ASSET_NOT_FOUND: "asset/not-found",
+	PROJECT_NOT_FOUND: "project/not-found",
+	ASSET_UPDATE_FAILED: "asset/update-failed",
+	ASSET_SAFETY_HELD: "asset/safety-held",
+	ASSET_NOT_RETRYABLE: "asset/not-retryable",
+	ASSET_CONTENT_UNAVAILABLE: "asset/content-unavailable",
+	SUPPORT_TICKET_NOT_FOUND: "support/ticket-not-found",
+	DUPLICATE_EXTERNAL_ID: "asset/duplicate-external-id",
+	FOLDER_NOT_FOUND: "folder/not-found",
+	DUPLICATE_FOLDER_NAME: "folder/duplicate-name",
+	FOLDER_NOT_EMPTY: "folder/not-empty",
+	FOLDER_PARENT_CYCLE: "folder/parent-cycle",
+	LENS_VERSION_CONFLICT: "lens/version-conflict",
+	UPLOAD_PRESET_NOT_FOUND: "upload-preset/not-found",
+	UPLOAD_PRESET_DISABLED: "upload-preset/disabled",
+	UPLOAD_PRESET_TOKEN_REQUIRED: "upload-preset/token-required",
+	UPLOAD_PRESET_CONTENT_TYPE_NOT_ALLOWED: "upload-preset/content-type-not-allowed",
+	UPLOAD_PRESET_TOO_LARGE: "upload-preset/too-large",
+	UPLOAD_PRESET_DAILY_LIMIT_REACHED: "upload-preset/daily-limit-reached",
+	UPLOAD_PRESET_ORIGIN_NOT_ALLOWED: "upload-preset/origin-not-allowed",
+	UPLOAD_PRESET_FIELD_NOT_ALLOWED: "upload-preset/field-not-allowed",
+	UPLOAD_TOKEN_INVALID: "upload-token/invalid",
+	UPLOAD_TOKEN_EXPIRED: "upload-token/expired",
+	UPLOAD_TOKEN_USED: "upload-token/used"
+};
+/** The HTTP status and default message the API returns with each documented error code. */
+const API_ERROR_DEFINITIONS = {
+	"auth/missing-token": {
+		status: 401,
+		message: "Authentication required. Send your project API key in the X-Api-Key header."
+	},
+	"auth/invalid-api-key": {
+		status: 401,
+		message: "The API key is invalid, revoked or expired. Create a key under Developer → API Keys."
+	},
+	"auth/project-mismatch": {
+		status: 403,
+		message: "This API key belongs to a different project. Use a key created for the project that owns this resource."
+	},
+	"auth/api-key-not-accepted": {
+		status: 403,
+		message: "API keys are only accepted by the public API at /v1."
+	},
+	"upload/file-too-large": {
+		status: 400,
+		message: "File size exceeds limit. Maximum direct image size is 10MB, audio/video size is 50MiB, and other files is 5GB."
+	},
+	"upload/image-requires-multipart-upload": {
+		status: 400,
+		message: "Images of 10MB or more must use a multipart upload."
+	},
+	"upload/multipart-image-too-small": {
+		status: 400,
+		message: "Multipart image uploads must total at least 10MB."
+	},
+	"upload/multipart-image-too-large": {
+		status: 400,
+		message: "Multipart image uploads cannot exceed 20MB."
+	},
+	"upload/image-exceeded-max-dimensions": {
+		status: 400,
+		message: "Image exceeds maximum dimensions. Maximum dimensions are 12,000px."
+	},
+	"upload/limit-exceeded": {
+		status: 403,
+		message: "Upload limit exceeded. You have used all your free uploads. Please upgrade to Plus or Pro for unlimited uploads."
+	},
+	"upload/invalid-mime-type": {
+		status: 400,
+		message: "Upload file type is not supported. Uploads must use a concrete file MIME type that CalmLens can store and process, such as image/png, image/jpeg, application/pdf, or text/plain."
+	},
+	"events/invalid-cursor": {
+		status: 400,
+		message: "The events cursor is invalid. Use the cursor from a previous response, or omit it to start from now."
+	},
+	"upload/invalid-payload": {
+		status: 400,
+		message: "Upload payload is invalid."
+	},
+	"upload/use-upload-part": {
+		status: 409,
+		message: "Use uploadPart for multipart upload parts after the first part"
+	},
+	"upload/not-open": {
+		status: 409,
+		message: "Asset is not accepting additional parts"
+	},
+	"upload/invalid-part-number": {
+		status: 409,
+		message: "Multipart upload part number is invalid."
+	},
+	"upload/missing": {
+		status: 409,
+		message: "Multipart upload state is missing"
+	},
+	"upload/size-mismatch": {
+		status: 400,
+		message: "The uploaded parts do not add up to the totalSizeInBytes declared when the multipart upload started."
+	},
+	"idempotency/invalid-key": {
+		status: 400,
+		message: "The Idempotency-Key header must be 1 to 255 printable ASCII characters, such as a UUID."
+	},
+	"idempotency/key-reused": {
+		status: 409,
+		message: "This Idempotency-Key was already used for a different request. Use a new key for each distinct request."
+	},
+	"idempotency/request-in-progress": {
+		status: 409,
+		message: "A request with this Idempotency-Key is still being processed. Retry after the Retry-After delay to receive its result."
+	},
+	"asset/not-found": {
+		status: 404,
+		message: "Asset not found"
+	},
+	"project/not-found": {
+		status: 404,
+		message: "Project not found"
+	},
+	"asset/update-failed": {
+		status: 500,
+		message: "Failed to update asset"
+	},
+	"asset/safety-held": {
+		status: 423,
+		message: "Asset access is restricted by a safety hold."
+	},
+	"asset/not-retryable": {
+		status: 409,
+		message: "Only assets that failed to process (status error) can be retried."
+	},
+	"asset/content-unavailable": {
+		status: 409,
+		message: "This asset's content is no longer stored, so it can't be processed again. Upload it again instead."
+	},
+	"support/ticket-not-found": {
+		status: 404,
+		message: "Support ticket not found."
+	},
+	"asset/duplicate-external-id": {
+		status: 409,
+		message: "An asset with this externalId already exists in the project."
+	},
+	"folder/not-found": {
+		status: 404,
+		message: "Folder not found"
+	},
+	"folder/duplicate-name": {
+		status: 409,
+		message: "A folder with this name already exists in this location."
+	},
+	"folder/not-empty": {
+		status: 409,
+		message: "Folder must be empty before it can be deleted."
+	},
+	"folder/parent-cycle": {
+		status: 409,
+		message: "A folder cannot be moved inside itself or one of its descendants."
+	},
+	"lens/version-conflict": {
+		status: 409,
+		message: "Lens updates require a version greater than the current version."
+	},
+	"upload-preset/not-found": {
+		status: 404,
+		message: "Upload preset not found. Check the preset ID in the portal."
+	},
+	"upload-preset/disabled": {
+		status: 403,
+		message: "This upload preset is paused. Turn it on in the portal to accept uploads."
+	},
+	"upload-preset/token-required": {
+		status: 401,
+		message: "This upload preset only accepts uploads with an upload token. Sign one on your server with uploadTokens.sign and pass it to the client."
+	},
+	"upload-preset/content-type-not-allowed": {
+		status: 415,
+		message: "This upload preset doesn't accept this file type."
+	},
+	"upload-preset/too-large": {
+		status: 413,
+		message: "This file is larger than the upload preset allows."
+	},
+	"upload-preset/daily-limit-reached": {
+		status: 429,
+		message: "This upload preset has reached its daily upload limit. Try again after midnight UTC, or raise the limit in the portal."
+	},
+	"upload-preset/origin-not-allowed": {
+		status: 403,
+		message: "This site isn't allowed to upload through this upload preset."
+	},
+	"upload-preset/field-not-allowed": {
+		status: 400,
+		message: "This field is set by the upload preset or the upload token and can't be changed by the upload."
+	},
+	"upload-token/invalid": {
+		status: 401,
+		message: "The upload token is invalid. Sign a new one on your server with an active API key for this project."
+	},
+	"upload-token/expired": {
+		status: 401,
+		message: "The upload token has expired. Sign a new one on your server."
+	},
+	"upload-token/used": {
+		status: 409,
+		message: "The upload token has already been used. Each token uploads one asset."
+	}
+};
+//#endregion
+//#region src/client/CalmLensError.ts
+/** Codes for failures the SDK detects itself, before or instead of an API error response. */
+const SDK_ERROR_CODES = {
+	/** The request could not be completed: DNS, TLS, a refused or reset connection, a truncated body. */
+	TRANSPORT_ERROR: "sdk/transport-error",
+	/** The request did not finish within `timeoutMs`. */
+	TIMEOUT: "sdk/timeout",
+	/** The caller's `AbortSignal` cancelled the request. */
+	CANCELLED: "sdk/cancelled",
+	/** A successful response whose body is not the JSON the operation returns. */
+	INVALID_RESPONSE: "sdk/invalid-response",
+	/** An HTTP failure without a CalmLens error body, for example from a proxy. */
+	HTTP_ERROR: "sdk/http-error",
+	/** A response body larger than `maxResponseBytes`. */
+	RESPONSE_TOO_LARGE: "sdk/response-too-large",
+	/** A method argument is missing or invalid, for example an empty asset ID. */
+	INVALID_ARGUMENT: "sdk/invalid-argument",
+	/** The client options are invalid, for example a missing API key. */
+	INVALID_CONFIG: "sdk/invalid-config",
+	/** No `fetch` implementation is available in this runtime. */
+	NO_FETCH: "sdk/no-fetch",
+	/** A webhook delivery whose signature or timestamp did not verify. */
+	INVALID_WEBHOOK_SIGNATURE: "sdk/invalid-webhook-signature",
+	/** A verified webhook delivery whose body is not a webhook event. */
+	INVALID_WEBHOOK_PAYLOAD: "sdk/invalid-webhook-payload"
+};
+/** Every error code the SDK can throw: the documented API codes and the SDK's own `sdk/*` codes. */
+const CALMLENS_ERROR_CODES = {
+	...API_ERROR_CODES,
+	...SDK_ERROR_CODES
+};
+const BRAND = Symbol.for("calmlens.sdk.CalmLensError");
+const RETRYABLE_STATUSES = /* @__PURE__ */ new Set([
+	429,
+	502,
+	503,
+	504
+]);
+const RETRYABLE_CODES = /* @__PURE__ */ new Set([SDK_ERROR_CODES.TRANSPORT_ERROR, API_ERROR_CODES.IDEMPOTENT_REQUEST_IN_PROGRESS]);
+/**
+* Every failure the SDK reports, whether the API returned an error or the request never
+* completed. Branch on `code`; `status`, `requestId`, `headers` and `retryAfter` describe the
+* HTTP response when there was one, and `cause` holds the underlying error.
+*
+* `instanceof CalmLensError` and `CalmLensError.isCalmLensError(value)` both recognise errors
+* from any copy of the SDK, so they work when ESM and CommonJS builds are loaded side by side.
+*/
+var CalmLensError = class CalmLensError extends Error {
+	constructor(code, options = {}) {
+		const id = typeof code === "string" ? code : code.id;
+		const defaultMessage = typeof code === "string" ? void 0 : code.defaultMessage;
+		super(`[calmlens] ${options.message ?? defaultMessage ?? id}`, { cause: options.cause });
+		this.name = "CalmLensError";
+		this.code = id;
+		this.status = options.status;
+		this.details = options.details;
+		this.requestId = options.requestId;
+		this.headers = options.headers;
+		this.retryAfter = options.retryAfter;
+		Object.defineProperty(this, BRAND, { value: true });
+	}
+	/** True for any `CalmLensError`, including one created by another copy or build of the SDK. */
+	static isCalmLensError(value) {
+		return typeof value === "object" && value !== null && value[BRAND] === true;
+	}
+	static [Symbol.hasInstance](value) {
+		return CalmLensError.isCalmLensError(value);
+	}
+	/** The resource does not exist or is not visible to this API key. */
+	isNotFound() {
+		return this.status === 404;
+	}
+	/**
+	* Whether repeating the same request may succeed: transport failures, throttling (429),
+	* gateway errors (502, 503, 504) and idempotent requests still in progress. Only repeat a
+	* create or upload with the same `idempotencyKey`.
+	*/
+	isRetryable() {
+		return RETRYABLE_CODES.has(this.code) || this.status !== void 0 && RETRYABLE_STATUSES.has(this.status);
+	}
+};
+const invalidArgument = (message, details) => new CalmLensError(SDK_ERROR_CODES.INVALID_ARGUMENT, {
+	message,
+	details
+});
+const invalidConfig = (message) => new CalmLensError(SDK_ERROR_CODES.INVALID_CONFIG, { message });
+//#endregion
+Object.defineProperty(exports, "API_ERROR_CODES", {
+	enumerable: true,
+	get: function() {
+		return API_ERROR_CODES;
+	}
+});
+Object.defineProperty(exports, "API_ERROR_DEFINITIONS", {
+	enumerable: true,
+	get: function() {
+		return API_ERROR_DEFINITIONS;
+	}
+});
+Object.defineProperty(exports, "CALMLENS_ERROR_CODES", {
+	enumerable: true,
+	get: function() {
+		return CALMLENS_ERROR_CODES;
+	}
+});
+Object.defineProperty(exports, "CalmLensError", {
+	enumerable: true,
+	get: function() {
+		return CalmLensError;
+	}
+});
+Object.defineProperty(exports, "SDK_ERROR_CODES", {
+	enumerable: true,
+	get: function() {
+		return SDK_ERROR_CODES;
+	}
+});
+Object.defineProperty(exports, "invalidArgument", {
+	enumerable: true,
+	get: function() {
+		return invalidArgument;
+	}
+});
+Object.defineProperty(exports, "invalidConfig", {
+	enumerable: true,
+	get: function() {
+		return invalidConfig;
+	}
+});