@hotcodepush/node 0.2.0 → 0.2.1

package/README.md

@@ -37,6 +37,19 @@ Uploads stream their body, a `Blob` or a `ReadableStream` with its `contentLengt
 Creating calls send an `Idempotency-Key` and are retried. Pass `idempotencyKey` to reuse one across your own retries.
 A failed request throws a `HotCodePushError` with the API's `code`, `message`, `details` and the HTTP `status`.
 
+`request` sends one request to any path of the API, for an endpoint newer than this client or for the status and the headers of an answer. It returns the `Response` with its body already received:
+
+```ts
+const response = await hotCodePush.request({
+  method: 'GET',
+  path: '/v1/organizations?limit=1',
+});
+console.log(response.status, response.headers.get('Content-Type'));
+const organizations = await response.json();
+```
+
+The path starts with a slash and carries its own query string, and a `body` is sent as JSON. A `POST` or a `PATCH` sent this way carries no `Idempotency-Key` and is not retried.
+
 ## Documentation
 
 See [hotcodepush.com/docs/api/node](https://hotcodepush.com/docs/api/node) for this client and [hotcodepush.com/docs](https://hotcodepush.com/docs) for HotCodePush.

package/dist/index.d.mts

@@ -17921,10 +17921,12 @@ declare class HttpClient {
   private readonly timeoutMs;
   constructor(options: HttpClientOptions);
   fetchBlob(options: FetchJsonOptions): Promise<Blob>;
+  fetchBufferedResponse(options: FetchJsonOptions): Promise<Response>;
   fetchCreatingPost<T>(options: FetchCreatingPostOptions): Promise<T>;
   fetchJson<T>(options: FetchJsonOptions): Promise<T>;
   fetchStatus(options: FetchJsonOptions): Promise<void>;
   fetchUpload<T>(options: FetchUploadOptions): Promise<T>;
+  private fetchOkResponse;
   private fetchResponse;
   private resolveRequestInit;
   private resolveRouteUrl;
@@ -19251,6 +19253,14 @@ declare class UsersResource {
 //#endregion
 //#region src/client.d.ts
 type HotCodePushOptions = HttpClientOptions;
+interface RequestOptions {
+  /** The body, an object or an array, sent as JSON. A `GET` takes none. */
+  body?: unknown;
+  /** A `DELETE`, a `GET` and a `PUT` are retried, a `PATCH` and a `POST` are sent once and carry no `Idempotency-Key`. */
+  method: FetchJsonOptions['method'];
+  /** The path below the base URL with its query string, starting with a slash, such as `/v1/apps?limit=10`. */
+  path: string;
+}
 /**
  * The client for the HotCodePush REST API.
  * Resources mirror the API paths, so `/v1/apps/{appId}/channels` is `apps.channels`.
@@ -19264,7 +19274,14 @@ export declare class HotCodePush {
   readonly organizations: OrganizationsResource;
   readonly qrCodes: QrCodesResource;
   readonly users: UsersResource;
+  private readonly httpClient;
   constructor(options?: HotCodePushOptions);
+  /**
+   * Sends one request to a path of the API, for what no resource method covers.
+   * Returns the response with its status, its headers and its body already received.
+   * Throws a `HotCodePushError` on a status outside 2xx.
+   */
+  request({ body, method, path }: RequestOptions): Promise<Response>;
 }
 //#endregion
 //#region src/errors.d.ts
@@ -19293,4 +19310,4 @@ export declare const PART_SIZE_BYTES: number;
  */
 export declare const SINGLE_UPLOAD_LIMIT_BYTES: number;
 //#endregion
-export type { AcceptInvitationOptions, App, AppFile, AppUsageMonth, AppsResource, Audience, AuditLog, AuditLogsResource, BinariesResource, Binary, BlobUploadBody, Bundle, BundleDelta, BundleDeltasResource, BundleFile, BundleFilesResource, BundlePackResource, BundlePackUpload, BundlePackUploadPartsResource, BundlePackUploadsResource, BundlesResource, CancelSubscriptionOptions, Channel, ChannelAudienceResource, ChannelQrCodeResource, ChannelReleasesResource, ChannelsResource, Checkout, CheckoutsResource, CompleteBundleOptions, CompleteBundlePackUploadOptions, CompleteFileUploadOptions, Count, CountAppsOptions, CountAuditLogsOptions, CountBinariesOptions, CountBundleDeltasOptions, CountBundleFilesOptions, CountBundlesOptions, CountChannelsOptions, CountDeviceEventsOptions, CountDevicesOptions, CountInvitationsOptions, CountMembersOptions, CountNotificationsOptions, CountReleasesOptions, CountSigningKeysOptions, CountTelemetryExportDeliveriesOptions, CountUsageAppsOptions, CountWebhookDeliveriesOptions, CountWebhooksOptions, CreateAppOptions, CreateBinaryOptions, CreateBundleOptions, CreateBundlePackUploadOptions, CreateChannelOptions, CreateCheckoutOptions, CreateCustomerPortalSessionOptions, CreateFileUploadOptions, CreateInvitationOptions, CreateOrganizationOptions, CreateReleaseOptions, CreateRollbackOptions, CreateSigningKeyOptions, CreateSsoProviderVerificationOptions, CreateUserPasswordOptions, CreateWebhookOptions, CreatedWebhook, CustomerPortalSession, CustomerPortalSessionsResource, DeleteAppOptions, DeleteBundleOptions, DeleteBundlePackUploadOptions, DeleteChannelOptions, DeleteDeviceOptions, DeleteFileUploadOptions, DeleteInvitationOptions, DeleteManyChannelsOptions, DeleteManyDevicesOptions, DeleteManyInvitationsOptions, DeleteManyMembersOptions, DeleteManySessionsOptions, DeleteManyTokensOptions, DeleteMemberOptions, DeleteOrganizationOptions, DeleteSigningKeyOptions, DeleteSsoProviderOptions, DeleteTelemetryExportOptions, DeleteUserOptions, DeleteWebhookOptions, Device, DeviceEventsResource, DevicesResource, DownloadAuditLogsCsvOptions, DownloadUsageAppsCsvOptions, FileUpload, FileUploadPartsResource, FileUploadsResource, FilesResource, FleetStatistics, GetAppOptions, GetAudienceOptions, GetBinaryOptions, GetBundleOptions, GetChannelOptions, GetChannelQrCodeOptions, GetDeviceOptions, GetFleetStatisticsOptions, GetLimitsOptions, GetMemberOptions, GetOrganizationOptions, GetQrCodeOptions, GetReleaseAudienceOptions, GetReleaseOptions, GetSsoProviderOptions, GetTelemetryExportOptions, GetUpdateStatisticsOptions, GetUsageOptions, GetUsageStatisticsOptions, GetUserOptions, GetWebhookOptions, HealthResource, HotCodePushErrorCode, HotCodePushOptions, IdempotencyOptions, Invitation, InvitationRow, InvitationsResource, Limits, LimitsResource, ListAppsOptions, ListAuditLogsOptions, ListBinariesOptions, ListBundleDeltasOptions, ListBundleFilesOptions, ListBundlesOptions, ListCallerInvitationsOptions, ListChannelsOptions, ListDeviceEventsOptions, ListDevicesOptions, ListInvitationsOptions, ListMembersOptions, ListNotificationPreferencesOptions, ListNotificationsOptions, ListOrganizationsOptions, ListReleasesOptions, ListSigningKeysOptions, ListTelemetryExportDeliveriesOptions, ListUsageAppsOptions, ListWebhookDeliveriesOptions, ListWebhooksOptions, Member, MemberRow, MembersResource, Notification, NotificationPreference, NotificationPreferencesResource, NotificationRow, NotificationsResource, Organization, OrganizationAppsResource, OrganizationInvitationsResource, OrganizationsResource, PauseChannelOptions, PauseReleaseOptions, QrCodesResource, RedeliverTelemetryExportDeliveryOptions, RedeliverWebhookDeliveryOptions, Release, ReleaseAudience, ReleaseAudienceResource, ReleaseDeviceEvent, ReleaseRow, ReleasesResource, ResumeChannelOptions, ResumeReleaseOptions, RevokeChannelReleasesOptions, RevokeReleaseOptions, RollbacksResource, SetSsoProviderOptions, SetTelemetryExportOptions, SigningKey, SigningKeysResource, SsoProvider, SsoProviderResource, SsoProviderVerificationsResource, StatisticsFleetResource, StatisticsResource, StatisticsUpdatesResource, StatisticsUsageResource, StreamUploadBody, SubscriptionResource, TelemetryExport, TelemetryExportDeliveriesResource, TelemetryExportDelivery, TelemetryExportResource, TestTelemetryExportOptions, TestWebhookOptions, TransferAppOptions, UncancelSubscriptionOptions, UpdateAppOptions, UpdateChannelOptions, UpdateManyNotificationsOptions, UpdateMemberOptions, UpdateNotificationOptions, UpdateNotificationPreferenceOptions, UpdateOrganizationOptions, UpdateReleaseOptions, UpdateStatistics, UpdateTelemetryExportOptions, UpdateWebhookOptions, UploadBody, UploadBundlePackOptions, UploadBundlePackPartOptions, UploadFileOptions, UploadPartOptions, UploadedBundlePack, UploadedPart, Usage, UsageAppsResource, UsageResource, UsageStatistics, User, UserPasswordResource, UserSessionsResource, UserTokensResource, UsersResource, Webhook, WebhookDeliveriesResource, WebhookDelivery, WebhooksResource };
+export type { AcceptInvitationOptions, App, AppFile, AppUsageMonth, AppsResource, Audience, AuditLog, AuditLogsResource, BinariesResource, Binary, BlobUploadBody, Bundle, BundleDelta, BundleDeltasResource, BundleFile, BundleFilesResource, BundlePackResource, BundlePackUpload, BundlePackUploadPartsResource, BundlePackUploadsResource, BundlesResource, CancelSubscriptionOptions, Channel, ChannelAudienceResource, ChannelQrCodeResource, ChannelReleasesResource, ChannelsResource, Checkout, CheckoutsResource, CompleteBundleOptions, CompleteBundlePackUploadOptions, CompleteFileUploadOptions, Count, CountAppsOptions, CountAuditLogsOptions, CountBinariesOptions, CountBundleDeltasOptions, CountBundleFilesOptions, CountBundlesOptions, CountChannelsOptions, CountDeviceEventsOptions, CountDevicesOptions, CountInvitationsOptions, CountMembersOptions, CountNotificationsOptions, CountReleasesOptions, CountSigningKeysOptions, CountTelemetryExportDeliveriesOptions, CountUsageAppsOptions, CountWebhookDeliveriesOptions, CountWebhooksOptions, CreateAppOptions, CreateBinaryOptions, CreateBundleOptions, CreateBundlePackUploadOptions, CreateChannelOptions, CreateCheckoutOptions, CreateCustomerPortalSessionOptions, CreateFileUploadOptions, CreateInvitationOptions, CreateOrganizationOptions, CreateReleaseOptions, CreateRollbackOptions, CreateSigningKeyOptions, CreateSsoProviderVerificationOptions, CreateUserPasswordOptions, CreateWebhookOptions, CreatedWebhook, CustomerPortalSession, CustomerPortalSessionsResource, DeleteAppOptions, DeleteBundleOptions, DeleteBundlePackUploadOptions, DeleteChannelOptions, DeleteDeviceOptions, DeleteFileUploadOptions, DeleteInvitationOptions, DeleteManyChannelsOptions, DeleteManyDevicesOptions, DeleteManyInvitationsOptions, DeleteManyMembersOptions, DeleteManySessionsOptions, DeleteManyTokensOptions, DeleteMemberOptions, DeleteOrganizationOptions, DeleteSigningKeyOptions, DeleteSsoProviderOptions, DeleteTelemetryExportOptions, DeleteUserOptions, DeleteWebhookOptions, Device, DeviceEventsResource, DevicesResource, DownloadAuditLogsCsvOptions, DownloadUsageAppsCsvOptions, FileUpload, FileUploadPartsResource, FileUploadsResource, FilesResource, FleetStatistics, GetAppOptions, GetAudienceOptions, GetBinaryOptions, GetBundleOptions, GetChannelOptions, GetChannelQrCodeOptions, GetDeviceOptions, GetFleetStatisticsOptions, GetLimitsOptions, GetMemberOptions, GetOrganizationOptions, GetQrCodeOptions, GetReleaseAudienceOptions, GetReleaseOptions, GetSsoProviderOptions, GetTelemetryExportOptions, GetUpdateStatisticsOptions, GetUsageOptions, GetUsageStatisticsOptions, GetUserOptions, GetWebhookOptions, HealthResource, HotCodePushErrorCode, HotCodePushOptions, IdempotencyOptions, Invitation, InvitationRow, InvitationsResource, Limits, LimitsResource, ListAppsOptions, ListAuditLogsOptions, ListBinariesOptions, ListBundleDeltasOptions, ListBundleFilesOptions, ListBundlesOptions, ListCallerInvitationsOptions, ListChannelsOptions, ListDeviceEventsOptions, ListDevicesOptions, ListInvitationsOptions, ListMembersOptions, ListNotificationPreferencesOptions, ListNotificationsOptions, ListOrganizationsOptions, ListReleasesOptions, ListSigningKeysOptions, ListTelemetryExportDeliveriesOptions, ListUsageAppsOptions, ListWebhookDeliveriesOptions, ListWebhooksOptions, Member, MemberRow, MembersResource, Notification, NotificationPreference, NotificationPreferencesResource, NotificationRow, NotificationsResource, Organization, OrganizationAppsResource, OrganizationInvitationsResource, OrganizationsResource, PauseChannelOptions, PauseReleaseOptions, QrCodesResource, RedeliverTelemetryExportDeliveryOptions, RedeliverWebhookDeliveryOptions, Release, ReleaseAudience, ReleaseAudienceResource, ReleaseDeviceEvent, ReleaseRow, ReleasesResource, RequestOptions, ResumeChannelOptions, ResumeReleaseOptions, RevokeChannelReleasesOptions, RevokeReleaseOptions, RollbacksResource, SetSsoProviderOptions, SetTelemetryExportOptions, SigningKey, SigningKeysResource, SsoProvider, SsoProviderResource, SsoProviderVerificationsResource, StatisticsFleetResource, StatisticsResource, StatisticsUpdatesResource, StatisticsUsageResource, StreamUploadBody, SubscriptionResource, TelemetryExport, TelemetryExportDeliveriesResource, TelemetryExportDelivery, TelemetryExportResource, TestTelemetryExportOptions, TestWebhookOptions, TransferAppOptions, UncancelSubscriptionOptions, UpdateAppOptions, UpdateChannelOptions, UpdateManyNotificationsOptions, UpdateMemberOptions, UpdateNotificationOptions, UpdateNotificationPreferenceOptions, UpdateOrganizationOptions, UpdateReleaseOptions, UpdateStatistics, UpdateTelemetryExportOptions, UpdateWebhookOptions, UploadBody, UploadBundlePackOptions, UploadBundlePackPartOptions, UploadFileOptions, UploadPartOptions, UploadedBundlePack, UploadedPart, Usage, UsageAppsResource, UsageResource, UsageStatistics, User, UserPasswordResource, UserSessionsResource, UserTokensResource, UsersResource, Webhook, WebhookDeliveriesResource, WebhookDelivery, WebhooksResource };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "0.2.0";
+var version = "0.2.1";
 //#endregion
 //#region src/errors.ts
 /**
@@ -64,9 +64,16 @@ var HttpClient = class {
 		this.timeoutMs = options.timeout ?? JSON_TIMEOUT_MS;
 	}
 	async fetchBlob(options) {
-		const response = await this.fetchResponse(options);
-		await assertResponseOk(response);
-		return response.blob();
+		return (await this.fetchOkResponse(options)).blob();
+	}
+	async fetchBufferedResponse(options) {
+		const response = await this.fetchOkResponse(options);
+		const body = response.body === null ? null : await response.arrayBuffer();
+		return new Response(body, {
+			headers: response.headers,
+			status: response.status,
+			statusText: response.statusText
+		});
 	}
 	async fetchCreatingPost(options) {
 		return this.fetchJson({
@@ -81,9 +88,7 @@ var HttpClient = class {
 		return parseResponseBody(await this.fetchResponse(options));
 	}
 	async fetchStatus(options) {
-		const response = await this.fetchResponse(options);
-		await assertResponseOk(response);
-		await response.body?.cancel();
+		await (await this.fetchOkResponse(options)).body?.cancel();
 	}
 	async fetchUpload(options) {
 		const fetchWithTimeout = withTimeout(fetch, { timeoutMs: UPLOAD_TIMEOUT_MS });
@@ -100,6 +105,11 @@ var HttpClient = class {
 			method: "PUT"
 		}));
 	}
+	async fetchOkResponse(options) {
+		const response = await this.fetchResponse(options);
+		await assertResponseOk(response);
+		return response;
+	}
 	async fetchResponse(options) {
 		const fetchWithTimeout = withTimeout(fetch, { timeoutMs: this.timeoutMs });
 		return (options.isRetryable ?? IDEMPOTENT_METHODS.has(options.method) ? withRetry(fetchWithTimeout) : fetchWithTimeout)(this.resolveUrl(options), this.resolveRequestInit(options));
@@ -123,7 +133,10 @@ var HttpClient = class {
 		};
 	}
 	resolveRouteUrl(path) {
-		return new URL(this.baseUrl + path);
+		if (!path.startsWith("/")) throw new Error(`The path ${path} does not start with a slash.`);
+		const url = new URL(this.baseUrl + path);
+		if (!url.href.startsWith(new URL(`${this.baseUrl}/`).href)) throw new Error(`The path ${path} leaves the base URL.`);
+		return url;
 	}
 	resolveUrl(options) {
 		const url = this.resolveRouteUrl(options.path);
@@ -2400,16 +2413,29 @@ var HotCodePush = class {
 	organizations;
 	qrCodes;
 	users;
+	httpClient;
 	constructor(options = {}) {
-		const httpClient = new HttpClient(options);
-		this.apps = new AppsResource(httpClient);
-		this.health = new HealthResource(httpClient);
-		this.invitations = new InvitationsResource(httpClient);
-		this.notificationPreferences = new NotificationPreferencesResource(httpClient);
-		this.notifications = new NotificationsResource(httpClient);
-		this.organizations = new OrganizationsResource(httpClient);
-		this.qrCodes = new QrCodesResource(httpClient);
-		this.users = new UsersResource(httpClient);
+		this.httpClient = new HttpClient(options);
+		this.apps = new AppsResource(this.httpClient);
+		this.health = new HealthResource(this.httpClient);
+		this.invitations = new InvitationsResource(this.httpClient);
+		this.notificationPreferences = new NotificationPreferencesResource(this.httpClient);
+		this.notifications = new NotificationsResource(this.httpClient);
+		this.organizations = new OrganizationsResource(this.httpClient);
+		this.qrCodes = new QrCodesResource(this.httpClient);
+		this.users = new UsersResource(this.httpClient);
+	}
+	/**
+	* Sends one request to a path of the API, for what no resource method covers.
+	* Returns the response with its status, its headers and its body already received.
+	* Throws a `HotCodePushError` on a status outside 2xx.
+	*/
+	request({ body, method, path }) {
+		return this.httpClient.fetchBufferedResponse({
+			body,
+			method,
+			path
+		});
 	}
 };
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hotcodepush/node",
   "description": "The typed Node client for the HotCodePush REST API",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "private": false,
   "keywords": [
     "hotcodepush",