@hello-bill/node 1.0.3 → 1.0.4

package/dist/{index-EXetQn1f.d.ts → index-C2MzlH64.d.ts}

@@ -200,6 +200,16 @@ interface WebhookHandlerOptions {
      */
     now?: () => number;
 }
+/**
+ * Thrown by `assertNever` when an event arrives whose `type` is not in the
+ * known union — typically a newer platform event that this SDK version does
+ * not yet handle. The `code` discriminator lets partners identify this class
+ * of error in log aggregation without an `instanceof` check.
+ */
+declare class UnknownWebhookEventError extends Error {
+    readonly code: "webhook.unknown_event_type";
+    constructor(eventType: string);
+}
 /**
  * Creates the framework-agnostic webhook receive handler. Returns a function
  * matching the same `HellobillRequest`/`HellobillResponse` shape used by the
@@ -338,4 +348,4 @@ interface HellobillHandlerSet {
 
 declare function createHellobillHandler(opts: CreateHellobillHandlerOptions): HellobillHandlerSet;
 
-export { type CreateHellobillHandlerOptions as C, type HellobillHandlerSet as H, InMemoryTokenStorage as I, type Logger as L, type TokenStorage as T, type VerifyWebhookOptions as V, type WebhookDedupeStore as W, type HellobillRequest as a, type HellobillResponse as b, InMemoryWebhookDedupeStore as c, TokenManager as d, type TokenManagerOptions as e, type WebhookHandlerContext as f, type WebhookHandlerOptions as g, type WebhookHandlers as h, WebhookVerificationError as i, createHellobillHandler as j, createWebhookHandler as k, verifyWebhookSignature as l, verifyWebhook as v };
+export { type CreateHellobillHandlerOptions as C, type HellobillHandlerSet as H, InMemoryTokenStorage as I, type Logger as L, type TokenStorage as T, UnknownWebhookEventError as U, type VerifyWebhookOptions as V, type WebhookDedupeStore as W, type HellobillRequest as a, type HellobillResponse as b, InMemoryWebhookDedupeStore as c, TokenManager as d, type TokenManagerOptions as e, type WebhookHandlerContext as f, type WebhookHandlerOptions as g, type WebhookHandlers as h, WebhookVerificationError as i, createHellobillHandler as j, createWebhookHandler as k, verifyWebhookSignature as l, verifyWebhook as v };

package/dist/{index-BrfG82zs.d.cts → index-YlknV1_H.d.cts}

@@ -200,6 +200,16 @@ interface WebhookHandlerOptions {
      */
     now?: () => number;
 }
+/**
+ * Thrown by `assertNever` when an event arrives whose `type` is not in the
+ * known union — typically a newer platform event that this SDK version does
+ * not yet handle. The `code` discriminator lets partners identify this class
+ * of error in log aggregation without an `instanceof` check.
+ */
+declare class UnknownWebhookEventError extends Error {
+    readonly code: "webhook.unknown_event_type";
+    constructor(eventType: string);
+}
 /**
  * Creates the framework-agnostic webhook receive handler. Returns a function
  * matching the same `HellobillRequest`/`HellobillResponse` shape used by the
@@ -338,4 +348,4 @@ interface HellobillHandlerSet {
 
 declare function createHellobillHandler(opts: CreateHellobillHandlerOptions): HellobillHandlerSet;
 
-export { type CreateHellobillHandlerOptions as C, type HellobillHandlerSet as H, InMemoryTokenStorage as I, type Logger as L, type TokenStorage as T, type VerifyWebhookOptions as V, type WebhookDedupeStore as W, type HellobillRequest as a, type HellobillResponse as b, InMemoryWebhookDedupeStore as c, TokenManager as d, type TokenManagerOptions as e, type WebhookHandlerContext as f, type WebhookHandlerOptions as g, type WebhookHandlers as h, WebhookVerificationError as i, createHellobillHandler as j, createWebhookHandler as k, verifyWebhookSignature as l, verifyWebhook as v };
+export { type CreateHellobillHandlerOptions as C, type HellobillHandlerSet as H, InMemoryTokenStorage as I, type Logger as L, type TokenStorage as T, UnknownWebhookEventError as U, type VerifyWebhookOptions as V, type WebhookDedupeStore as W, type HellobillRequest as a, type HellobillResponse as b, InMemoryWebhookDedupeStore as c, TokenManager as d, type TokenManagerOptions as e, type WebhookHandlerContext as f, type WebhookHandlerOptions as g, type WebhookHandlers as h, WebhookVerificationError as i, createHellobillHandler as j, createWebhookHandler as k, verifyWebhookSignature as l, verifyWebhook as v };

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { T as TokenStorage, L as Logger } from './index-BrfG82zs.cjs';
-export { C as CreateHellobillHandlerOptions, H as HellobillHandlerSet, a as HellobillRequest, b as HellobillResponse, I as InMemoryTokenStorage, c as InMemoryWebhookDedupeStore, d as TokenManager, e as TokenManagerOptions, V as VerifyWebhookOptions, W as WebhookDedupeStore, f as WebhookHandlerContext, g as WebhookHandlerOptions, h as WebhookHandlers, i as WebhookVerificationError, j as createHellobillHandler, k as createWebhookHandler, v as verifyWebhook, l as verifyWebhookSignature } from './index-BrfG82zs.cjs';
+import { T as TokenStorage, L as Logger } from './index-YlknV1_H.cjs';
+export { C as CreateHellobillHandlerOptions, H as HellobillHandlerSet, a as HellobillRequest, b as HellobillResponse, I as InMemoryTokenStorage, c as InMemoryWebhookDedupeStore, d as TokenManager, e as TokenManagerOptions, U as UnknownWebhookEventError, V as VerifyWebhookOptions, W as WebhookDedupeStore, f as WebhookHandlerContext, g as WebhookHandlerOptions, h as WebhookHandlers, i as WebhookVerificationError, j as createHellobillHandler, k as createWebhookHandler, v as verifyWebhook, l as verifyWebhookSignature } from './index-YlknV1_H.cjs';
 import { R as RequestId, S as SessionPayload, a as SessionResponse, b as SessionGetResponse, P as ProductsQuery, c as ProductsResponse, d as PropertyDetailResponse, L as LoaListResponse, C as CreateCustomerInput, e as CustomerCreateResponse, f as CustomerId, g as CustomerStatusResponse, B as BankDetailsRequest, h as BankDetailsResponse } from './webhooks-DPpqf7d2.cjs';
 export { A as Address, i as AddressObject, j as AddressesObject, k as ApiVersion, l as AppDeeplinks, m as BankDetailsCollected, n as BankDetailsConsent, o as BankDetailsObject, p as BankDetailsStatus, q as BillType, r as BreakdownCoverProduct, s as BroadbandProduct, t as BuildingStyle, u as BuildingType, v as CacheStatus, w as ClientMode, x as Consent, y as ContextEntry, z as CouncilTaxProduct, D as Customer, E as CustomerType, F as DataCompleteness, G as DiscoveryStatus, H as Email, I as EnergyProduct, J as Environment, K as EpcRating, M as FinalRead, N as FuelType, O as HeatingType, Q as HomeInsuranceProduct, T as IdempotencyKey, U as IsoDate, V as IsoDateTime, W as LoASignature, X as LoaId, Y as LoaRecord, Z as LocationRole, _ as MaskedSortCode, $ as Meters, a0 as MobileProduct, a1 as MoveIn, a2 as MoveObject, a3 as MoveOut, a4 as MoveOutNotificationFailed, a5 as MoveOutNotificationSent, a6 as MoveOutNotifyFlags, a7 as MoveOutReason, a8 as MoveOutStatus, a9 as NearbyPoi, aa as OccupantObject, ab as OccupantType, ac as OnboardingInfo, ad as OverallStatus, ae as Paginated, af as Person, ag as PhoneNumber, ah as Postcode, ai as Product, aj as ProductBase, ak as ProductCategory, al as ProductConfidence, am as ProductId, an as ProductSetup, ao as PropertyDetailObject, ap as PropertyLocation, aq as PropertyObject, ar as PropertyType, as as PropertyTypeCode, at as PropertyTypeSubcode, au as ProvidedFieldPath, av as SESSION_IDEMPOTENCY_TTL_MS, aw as SavingsSummaryResponse, ax as SelectedProduct, ay as SessionAccountCreated, az as SessionAppDeferred, aA as SessionAppInstalled, aB as SessionDetailsConfirmed, aC as SessionEmbedOpened, aD as SessionLoaSigned, aE as SessionProductsSelected, aF as SetupStatus, aG as SetupStatusChanged, aH as SignatureImage, aI as StoredBankDetails, aJ as SubscriptionChanged, aK as SubscriptionStatus, aL as TvLicenceProduct, aM as Url, aN as WaterProduct, aO as WebhookEvent, aP as WebhookEventBase, aQ as WebhookEventId, aR as WebhookEventType } from './webhooks-DPpqf7d2.cjs';
 import { ErrorEnvelope } from './types/index.cjs';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { T as TokenStorage, L as Logger } from './index-EXetQn1f.js';
-export { C as CreateHellobillHandlerOptions, H as HellobillHandlerSet, a as HellobillRequest, b as HellobillResponse, I as InMemoryTokenStorage, c as InMemoryWebhookDedupeStore, d as TokenManager, e as TokenManagerOptions, V as VerifyWebhookOptions, W as WebhookDedupeStore, f as WebhookHandlerContext, g as WebhookHandlerOptions, h as WebhookHandlers, i as WebhookVerificationError, j as createHellobillHandler, k as createWebhookHandler, v as verifyWebhook, l as verifyWebhookSignature } from './index-EXetQn1f.js';
+import { T as TokenStorage, L as Logger } from './index-C2MzlH64.js';
+export { C as CreateHellobillHandlerOptions, H as HellobillHandlerSet, a as HellobillRequest, b as HellobillResponse, I as InMemoryTokenStorage, c as InMemoryWebhookDedupeStore, d as TokenManager, e as TokenManagerOptions, U as UnknownWebhookEventError, V as VerifyWebhookOptions, W as WebhookDedupeStore, f as WebhookHandlerContext, g as WebhookHandlerOptions, h as WebhookHandlers, i as WebhookVerificationError, j as createHellobillHandler, k as createWebhookHandler, v as verifyWebhook, l as verifyWebhookSignature } from './index-C2MzlH64.js';
 import { R as RequestId, S as SessionPayload, a as SessionResponse, b as SessionGetResponse, P as ProductsQuery, c as ProductsResponse, d as PropertyDetailResponse, L as LoaListResponse, C as CreateCustomerInput, e as CustomerCreateResponse, f as CustomerId, g as CustomerStatusResponse, B as BankDetailsRequest, h as BankDetailsResponse } from './webhooks-DPpqf7d2.js';
 export { A as Address, i as AddressObject, j as AddressesObject, k as ApiVersion, l as AppDeeplinks, m as BankDetailsCollected, n as BankDetailsConsent, o as BankDetailsObject, p as BankDetailsStatus, q as BillType, r as BreakdownCoverProduct, s as BroadbandProduct, t as BuildingStyle, u as BuildingType, v as CacheStatus, w as ClientMode, x as Consent, y as ContextEntry, z as CouncilTaxProduct, D as Customer, E as CustomerType, F as DataCompleteness, G as DiscoveryStatus, H as Email, I as EnergyProduct, J as Environment, K as EpcRating, M as FinalRead, N as FuelType, O as HeatingType, Q as HomeInsuranceProduct, T as IdempotencyKey, U as IsoDate, V as IsoDateTime, W as LoASignature, X as LoaId, Y as LoaRecord, Z as LocationRole, _ as MaskedSortCode, $ as Meters, a0 as MobileProduct, a1 as MoveIn, a2 as MoveObject, a3 as MoveOut, a4 as MoveOutNotificationFailed, a5 as MoveOutNotificationSent, a6 as MoveOutNotifyFlags, a7 as MoveOutReason, a8 as MoveOutStatus, a9 as NearbyPoi, aa as OccupantObject, ab as OccupantType, ac as OnboardingInfo, ad as OverallStatus, ae as Paginated, af as Person, ag as PhoneNumber, ah as Postcode, ai as Product, aj as ProductBase, ak as ProductCategory, al as ProductConfidence, am as ProductId, an as ProductSetup, ao as PropertyDetailObject, ap as PropertyLocation, aq as PropertyObject, ar as PropertyType, as as PropertyTypeCode, at as PropertyTypeSubcode, au as ProvidedFieldPath, av as SESSION_IDEMPOTENCY_TTL_MS, aw as SavingsSummaryResponse, ax as SelectedProduct, ay as SessionAccountCreated, az as SessionAppDeferred, aA as SessionAppInstalled, aB as SessionDetailsConfirmed, aC as SessionEmbedOpened, aD as SessionLoaSigned, aE as SessionProductsSelected, aF as SetupStatus, aG as SetupStatusChanged, aH as SignatureImage, aI as StoredBankDetails, aJ as SubscriptionChanged, aK as SubscriptionStatus, aL as TvLicenceProduct, aM as Url, aN as WaterProduct, aO as WebhookEvent, aP as WebhookEventBase, aQ as WebhookEventId, aR as WebhookEventType } from './webhooks-DPpqf7d2.js';
 import { ErrorEnvelope } from './types/index.js';

package/dist/index.js

@@ -432,8 +432,16 @@ var InMemoryWebhookDedupeStore = class {
 };
 
 // src/webhook/handler.ts
+var UnknownWebhookEventError = class extends Error {
+  code = "webhook.unknown_event_type";
+  constructor(eventType) {
+    super(`Unhandled webhook event type: ${eventType}`);
+    this.name = "UnknownWebhookEventError";
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+};
 function assertNever(x) {
-  throw new Error(`Unhandled webhook variant: ${JSON.stringify(x)}`);
+  throw new UnknownWebhookEventError(x.type ?? JSON.stringify(x));
 }
 var noopLogger = {
   debug: () => {
@@ -598,7 +606,10 @@ function createWebhookHandler(opts) {
       safeLogger.error("hellobill.webhook.handler_error", {
         event_id: event.id,
         event_type: event.type,
-        message: err.message
+        message: err.message,
+        // Include the typed error code when present so partners can identify
+        // known error classes (e.g. unknown event type) in log aggregation.
+        ...err != null && typeof err === "object" && "code" in err ? { code: err.code } : {}
       });
     });
   };
@@ -1166,6 +1177,7 @@ exports.HellobillApiError = HellobillApiError;
 exports.InMemoryTokenStorage = InMemoryTokenStorage;
 exports.InMemoryWebhookDedupeStore = InMemoryWebhookDedupeStore;
 exports.TokenManager = TokenManager;
+exports.UnknownWebhookEventError = UnknownWebhookEventError;
 exports.WebhookVerificationError = WebhookVerificationError;
 exports.buildOnboardingInfo = buildOnboardingInfo;
 exports.createHellobillHandler = createHellobillHandler;