@hotcodepush/node 0.0.1 → 0.2.0

package/dist/index.mjs

@@ -1,10 +1,11 @@
 //#region package.json
-var version = "0.0.0";
+var version = "0.2.0";
 //#endregion
 //#region src/errors.ts
 /**
 * Thrown when the API answers with a status outside 2xx.
 * `code`, `message` and `details` come from the API verbatim.
+* A code newer than this client passes through as a plain string, so `code` is not limited to `HotCodePushErrorCode`.
 * A response without the API error shape becomes `unexpected_response` with the status, and its body is dropped.
 */
 var HotCodePushError = class extends Error {
@@ -30,8 +31,8 @@ function resolveErrorBody(text) {
 		return;
 	}
 }
-function resolveHotCodePushError(status, text) {
-	return new HotCodePushError(resolveErrorBody(text) ?? {
+function resolveHotCodePushError({ responseText, status }) {
+	return new HotCodePushError(resolveErrorBody(responseText) ?? {
 		code: "unexpected_response",
 		message: `Request failed with status ${status}.`
 	}, status);
@@ -85,7 +86,7 @@ var HttpClient = class {
 		await response.body?.cancel();
 	}
 	async fetchUpload(options) {
-		const fetchWithTimeout = withTimeout(fetch, UPLOAD_TIMEOUT_MS);
+		const fetchWithTimeout = withTimeout(fetch, { timeoutMs: UPLOAD_TIMEOUT_MS });
 		const fetchFunction = isBlobUploadBody(options) ? withRetry(fetchWithTimeout) : fetchWithTimeout;
 		const contentLength = isBlobUploadBody(options) ? options.body.size : options.contentLength;
 		return parseResponseBody(await fetchFunction(this.resolveRouteUrl(options.path), {
@@ -100,7 +101,7 @@ var HttpClient = class {
 		}));
 	}
 	async fetchResponse(options) {
-		const fetchWithTimeout = withTimeout(fetch, this.timeoutMs);
+		const fetchWithTimeout = withTimeout(fetch, { timeoutMs: this.timeoutMs });
 		return (options.isRetryable ?? IDEMPOTENT_METHODS.has(options.method) ? withRetry(fetchWithTimeout) : fetchWithTimeout)(this.resolveUrl(options), this.resolveRequestInit(options));
 	}
 	resolveRequestInit(options) {
@@ -126,12 +127,18 @@ var HttpClient = class {
 	}
 	resolveUrl(options) {
 		const url = this.resolveRouteUrl(options.path);
-		for (const [name, value] of Object.entries(options.query ?? {})) for (const queryValue of resolveQueryValues(name, value)) url.searchParams.append(name, queryValue);
+		for (const [name, value] of Object.entries(options.query ?? {})) for (const queryValue of resolveQueryValues({
+			name,
+			value
+		})) url.searchParams.append(name, queryValue);
 		return url;
 	}
 };
 async function assertResponseOk(response) {
-	if (!response.ok) throw resolveHotCodePushError(response.status, await response.text());
+	if (!response.ok) throw resolveHotCodePushError({
+		responseText: await response.text(),
+		status: response.status
+	});
 }
 function isBlobUploadBody(uploadBody) {
 	return uploadBody.body instanceof Blob;
@@ -161,7 +168,7 @@ function resolvePath(template, parameters = {}) {
 		return encodeURIComponent(parameter);
 	});
 }
-function resolveQueryValues(name, value) {
+function resolveQueryValues({ name, value }) {
 	if (value === void 0 || value === "") return [];
 	if (typeof value !== "object") return [String(value)];
 	if (COMMA_LIST_QUERY_NAMES.has(name)) return value.length === 0 ? [] : [value.join(",")];
@@ -194,7 +201,7 @@ function withRetry(fetchFunction) {
 		}
 	};
 }
-function withTimeout(fetchFunction, timeoutMs) {
+function withTimeout(fetchFunction, { timeoutMs }) {
 	return (input, init) => fetchFunction(input, {
 		...init,
 		signal: AbortSignal.timeout(timeoutMs)
@@ -231,9 +238,14 @@ var BinariesResource = class {
 		});
 	}
 	async get(options) {
+		const { appId, binaryId, ...query } = options;
 		return this.httpClient.fetchJson({
 			method: "GET",
-			path: resolvePath("/v1/apps/{appId}/binaries/{binaryId}", options)
+			path: resolvePath("/v1/apps/{appId}/binaries/{binaryId}", {
+				appId,
+				binaryId
+			}),
+			query
 		});
 	}
 	/**
@@ -333,19 +345,14 @@ const SINGLE_UPLOAD_LIMIT_BYTES = 67108864;
 function isBlobAboveSingleUploadLimit(uploadBody) {
 	return uploadBody.body instanceof Blob && uploadBody.body.size > 67108864;
 }
-async function uploadInParts(uploads, pathParameters, blob) {
+async function uploadInParts(uploads, { blob, pathParameters }) {
 	const { uploadId } = await uploads.create(pathParameters);
 	try {
-		const parts = [];
-		for (let start = 0, partNumber = 1; start < blob.size; start += PART_SIZE_BYTES, partNumber += 1) {
-			const uploadedPart = await uploads.parts.upload({
-				...pathParameters,
-				body: blob.slice(start, start + PART_SIZE_BYTES),
-				partNumber,
-				uploadId
-			});
-			parts.push(uploadedPart);
-		}
+		const parts = await uploadEveryPart(uploads, {
+			blob,
+			pathParameters,
+			uploadId
+		});
 		return await uploads.complete({
 			...pathParameters,
 			parts,
@@ -359,6 +366,19 @@ async function uploadInParts(uploads, pathParameters, blob) {
 		throw error;
 	}
 }
+async function uploadEveryPart(uploads, { blob, pathParameters, uploadId }) {
+	const parts = [];
+	for (let start = 0, partNumber = 1; start < blob.size; start += PART_SIZE_BYTES, partNumber += 1) {
+		const uploadedPart = await uploads.parts.upload({
+			...pathParameters,
+			body: blob.slice(start, start + PART_SIZE_BYTES),
+			partNumber,
+			uploadId
+		});
+		parts.push(uploadedPart);
+	}
+	return parts;
+}
 //#endregion
 //#region src/resources/bundle-pack-upload-parts.ts
 var BundlePackUploadPartsResource = class {
@@ -429,7 +449,7 @@ var BundlePackUploadsResource = class {
 	* Aborts a multipart pack upload and discards its parts.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/bundles/{bundleId}/pack/uploads/{uploadId}", options)
 		});
@@ -451,9 +471,12 @@ var BundlePackResource = class {
 	async upload(options) {
 		const { appId, bundleId, ...uploadBody } = options;
 		if (isBlobAboveSingleUploadLimit(uploadBody)) return uploadInParts(this.uploads, {
-			appId,
-			bundleId
-		}, uploadBody.body);
+			blob: uploadBody.body,
+			pathParameters: {
+				appId,
+				bundleId
+			}
+		});
 		return this.httpClient.fetchUpload({
 			...uploadBody,
 			contentType: "application/x-tar",
@@ -517,7 +540,7 @@ var BundlesResource = class {
 	* A bundle that a release serves or a store build embeds is refused.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/bundles/{bundleId}", options)
 		});
@@ -595,6 +618,7 @@ var ChannelReleasesResource = class {
 	}
 	/**
 	* Releases a ready bundle, or what another channel serves, in this channel.
+	* With `fromChannelId`, `platform` picks the newest active release of that channel serving the platform.
 	* The release gets the next number of the channel.
 	*/
 	async create(options) {
@@ -633,8 +657,8 @@ var RollbacksResource = class {
 		this.httpClient = httpClient;
 	}
 	/**
-	* Rolls the channel back to its previous bundle, or to the bundle of `toReleaseId`.
-	* A rollback is a new release.
+	* Rolls the channel back to the release before its newest active one, or before the newest active one serving `platform`.
+	* `toReleaseId` names the target instead. A rollback is a new release.
 	*/
 	async create(options) {
 		const { appId, channelId, idempotencyKey, ...body } = options;
@@ -686,7 +710,7 @@ var ChannelsResource = class {
 	* Deletes a channel at once. The default channel of the app is refused.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/channels/{channelId}", options)
 		});
@@ -697,7 +721,7 @@ var ChannelsResource = class {
 	*/
 	async deleteMany(options) {
 		const { appId, ...query } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/channels", { appId }),
 			query
@@ -818,7 +842,7 @@ var DevicesResource = class {
 	* Deletes a device from the registry, for an erasure request.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/devices/{deviceId}", options)
 		});
@@ -828,7 +852,7 @@ var DevicesResource = class {
 	*/
 	async deleteMany(options) {
 		const { appId, ...query } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/devices", { appId }),
 			query
@@ -929,7 +953,7 @@ var FileUploadsResource = class {
 	* Aborts a multipart file upload and discards its parts.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/files/{sha256}/uploads/{uploadId}", options)
 		});
@@ -952,9 +976,12 @@ var FilesResource = class {
 	async upload(options) {
 		const { appId, sha256, ...uploadBody } = options;
 		if (isBlobAboveSingleUploadLimit(uploadBody)) return uploadInParts(this.uploads, {
-			appId,
-			sha256
-		}, uploadBody.body);
+			blob: uploadBody.body,
+			pathParameters: {
+				appId,
+				sha256
+			}
+		});
 		return this.httpClient.fetchUpload({
 			...uploadBody,
 			contentType: "application/gzip",
@@ -1110,7 +1137,7 @@ var SigningKeysResource = class {
 		});
 	}
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}/signing-keys/{signingKeyId}", options)
 		});
@@ -1135,7 +1162,7 @@ var StatisticsFleetResource = class {
 		this.httpClient = httpClient;
 	}
 	/**
-	* Gets a snapshot of the fleet from the registry, for one channel when `channelId` is set.
+	* Gets a snapshot of the fleet from the registry, for one channel when `channelId` is set and for one binary when `binaryId` is set.
 	*/
 	async get(options) {
 		const { appId, ...query } = options;
@@ -1225,7 +1252,7 @@ var AppsResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/apps/{appId}", options)
 		});
@@ -1406,7 +1433,7 @@ var NotificationsResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async updateMany(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			body: options,
 			method: "PATCH",
 			path: resolvePath("/v1/notifications")
@@ -1544,7 +1571,7 @@ var MembersResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/organizations/{organizationId}/members/{memberId}", options)
 		});
@@ -1556,7 +1583,7 @@ var MembersResource = class {
 	*/
 	async deleteMany(options) {
 		const { organizationId, ...query } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/organizations/{organizationId}/members", { organizationId }),
 			query
@@ -1677,7 +1704,7 @@ var OrganizationInvitationsResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/organizations/{organizationId}/invitations/{invitationId}", options)
 		});
@@ -1688,7 +1715,7 @@ var OrganizationInvitationsResource = class {
 	*/
 	async deleteMany(options) {
 		const { organizationId, ...query } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/organizations/{organizationId}/invitations", { organizationId }),
 			query
@@ -1742,7 +1769,7 @@ var SsoProviderResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/organizations/{organizationId}/sso-provider", options)
 		});
@@ -1788,7 +1815,7 @@ var SubscriptionResource = class {
 	*/
 	async cancel(options) {
 		const { organizationId, ...body } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			body,
 			isRetryable: true,
 			method: "POST",
@@ -1801,7 +1828,7 @@ var SubscriptionResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async uncancel(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			isRetryable: true,
 			method: "POST",
 			path: resolvePath("/v1/organizations/{organizationId}/subscription/uncancel", options)
@@ -1809,6 +1836,124 @@ var SubscriptionResource = class {
 	}
 };
 //#endregion
+//#region src/resources/telemetry-export-deliveries.ts
+/**
+* The delivery log of the telemetry export. Each delivery is kept for 30 days.
+*/
+var TelemetryExportDeliveriesResource = class {
+	httpClient;
+	constructor(httpClient) {
+		this.httpClient = httpClient;
+	}
+	/**
+	* Counts the deliveries of the telemetry export that match the filters.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async count(options) {
+		const { organizationId, ...query } = options;
+		return this.httpClient.fetchJson({
+			method: "GET",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export/deliveries/count", { organizationId }),
+			query
+		});
+	}
+	/**
+	* Lists the deliveries of the telemetry export, newest first.
+	* Filter by `status`, and by `createdSince` and `createdUntil`, both inclusive.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async list(options) {
+		const { organizationId, ...query } = options;
+		return this.httpClient.fetchJson({
+			method: "GET",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export/deliveries", { organizationId }),
+			query
+		});
+	}
+	/**
+	* Sends the record again, once, within the request, and answers the settled delivery with its attempt count carried on.
+	* Each call makes another attempt, so the client never retries the call.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async redeliver(options) {
+		return this.httpClient.fetchJson({
+			method: "POST",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export/deliveries/{deliveryId}/redeliver", options)
+		});
+	}
+};
+//#endregion
+//#region src/resources/telemetry-export.ts
+/**
+* The telemetry export of the organization, for Admins and Owners.
+* Setting, switching, testing and redelivering need a paying plan, and any other plan answers `plan_required`; reading and deleting do not.
+*/
+var TelemetryExportResource = class {
+	httpClient;
+	deliveries;
+	constructor(httpClient) {
+		this.httpClient = httpClient;
+		this.deliveries = new TelemetryExportDeliveriesResource(httpClient);
+	}
+	/**
+	* Removes the telemetry export with its delivery log, on any plan.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async delete(options) {
+		await this.httpClient.fetchStatus({
+			method: "DELETE",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export", options)
+		});
+	}
+	/**
+	* Gets the telemetry export of the organization; an organization without one answers `not_found`.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async get(options) {
+		return this.httpClient.fetchJson({
+			method: "GET",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export", options)
+		});
+	}
+	/**
+	* Sets the OTLP/HTTP base URL, the `headers` that carry the vendor's credentials and the `signals`, replacing the export before.
+	* A URL ending in a signal path answers `url_signal_path`, and a `content-type`, `content-length` or `host` header `header_reserved`.
+	* The export starts enabled.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async set(options) {
+		const { organizationId, ...body } = options;
+		return this.httpClient.fetchJson({
+			body,
+			method: "PUT",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export", { organizationId })
+		});
+	}
+	/**
+	* Sends one delivery per signal within the request, a `telemetry_export.test` log record and the current metrics document, and answers the settled deliveries.
+	* Each call sends again, so the client never retries the call.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async test(options) {
+		return this.httpClient.fetchJson({
+			method: "POST",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export/test", options)
+		});
+	}
+	/**
+	* Switches the telemetry export on or off. `isEnabled: false` stamps `disabledAt`; `isEnabled: true` clears it and resets the count of failed deliveries in a row.
+	* An API token answers `forbidden`; sign in with a session.
+	*/
+	async update(options) {
+		const { organizationId, ...body } = options;
+		return this.httpClient.fetchJson({
+			body,
+			method: "PATCH",
+			path: resolvePath("/v1/organizations/{organizationId}/telemetry-export", { organizationId })
+		});
+	}
+};
+//#endregion
 //#region src/resources/usage-apps.ts
 var UsageAppsResource = class {
 	httpClient;
@@ -1969,7 +2114,7 @@ var WebhooksResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/organizations/{organizationId}/webhooks/{webhookId}", options)
 		});
@@ -2009,7 +2154,7 @@ var WebhooksResource = class {
 	}
 	/**
 	* Changes the name, the URL, the subscribed `events`, the app filter or `isEnabled`. The format and the secret never change.
-	* Enabling a webhook that was disabled after fifty failed deliveries in a row resets that count.
+	* `isEnabled: false` stamps `disabledAt`; `isEnabled: true` clears it and resets the count of failed deliveries in a row.
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async update(options) {
@@ -2037,6 +2182,7 @@ var OrganizationsResource = class {
 	members;
 	ssoProvider;
 	subscription;
+	telemetryExport;
 	usage;
 	webhooks;
 	constructor(httpClient) {
@@ -2050,6 +2196,7 @@ var OrganizationsResource = class {
 		this.members = new MembersResource(httpClient);
 		this.ssoProvider = new SsoProviderResource(httpClient);
 		this.subscription = new SubscriptionResource(httpClient);
+		this.telemetryExport = new TelemetryExportResource(httpClient);
 		this.usage = new UsageResource(httpClient);
 		this.webhooks = new WebhooksResource(httpClient);
 	}
@@ -2080,7 +2227,7 @@ var OrganizationsResource = class {
 	* An API token answers `forbidden`; sign in with a session.
 	*/
 	async delete(options) {
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/organizations/{organizationId}", options)
 		});
@@ -2148,7 +2295,7 @@ var UserPasswordResource = class {
 	*/
 	async create(options) {
 		const { userId, ...body } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			body,
 			method: "POST",
 			path: resolvePath("/v1/users/{userId}/password", { userId })
@@ -2169,7 +2316,7 @@ var UserSessionsResource = class {
 	*/
 	async deleteMany(options) {
 		const { userId, ...query } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/users/{userId}/sessions", { userId }),
 			query
@@ -2190,7 +2337,7 @@ var UserTokensResource = class {
 	*/
 	async deleteMany(options) {
 		const { userId, ...query } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			method: "DELETE",
 			path: resolvePath("/v1/users/{userId}/tokens", { userId }),
 			query
@@ -2218,7 +2365,7 @@ var UsersResource = class {
 	*/
 	async delete(options) {
 		const { userId, ...body } = options;
-		await this.httpClient.fetchJson({
+		await this.httpClient.fetchStatus({
 			body,
 			method: "DELETE",
 			path: resolvePath("/v1/users/{userId}", { userId })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hotcodepush/node",
   "description": "The typed Node client for the HotCodePush REST API",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "private": false,
   "keywords": [
     "hotcodepush",
@@ -47,7 +47,8 @@
     "prepublishOnly": "npm run build",
     "sync-openapi": "node scripts/sync-openapi.ts",
     "test": "vitest run",
-    "typecheck": "npm run generate -- --check && tsc --noEmit"
+    "typecheck": "npm run generate -- --check && tsc --noEmit",
+    "verify": "npm run lint && npm run typecheck && npm test && npm run build"
   },
   "devDependencies": {
     "@eslint/js": "10.0.1",