@vrplatform/hyperline-client 1.0.21 → 1.0.25

package/src/client.ts

@@ -1,6 +1,10 @@
 import { utc } from '@vrplatform/utils';
 import type { operations, paths } from './_types.generated';
-import { BillableEvents, CreateBillableEvent } from './types';
+import {
+  BillableEvents,
+  CreateBillableEvent,
+  HyperlineCreateSubscriptionPayload,
+} from './types';
 import { arrayBufferToBase64 } from './utils';
 
 export type Logger = { error(message?: any, ...optionalParams: any[]): void };
@@ -25,6 +29,7 @@ export class HyperlineAPI {
   ): Promise<T | null> {
     if (data) options = { body: JSON.stringify(data), ...(options || {}) };
 
+    const method = (options?.method || 'GET').toUpperCase();
     const sandbox = this.headers.Authorization.includes('test')
       ? 'sandbox.'
       : '';
@@ -35,9 +40,33 @@ export class HyperlineAPI {
       headers: { ...this.headers, ...options?.headers },
     });
 
-    if (!result || !result?.ok) {
+    if (!result?.ok) {
       const status = result?.status;
       const statusText = result?.statusText;
+      let content: any = null;
+
+      try {
+        const rawBody = await result.text();
+        const trimmedBody = rawBody.trim();
+
+        if (trimmedBody) {
+          try {
+            content = JSON.parse(trimmedBody);
+          } catch (_) {
+            content = rawBody;
+          }
+        }
+      } catch (_) {
+        // ignore
+      }
+
+      const message =
+        (content && typeof content === 'object' && 'message' in content
+          ? (content as any).message
+          : null) ||
+        (typeof content === 'string' ? content : null) ||
+        (content ? JSON.stringify(content) : null) ||
+        'Unknown error';
 
       if (status === 429) {
         // get difference between rate limit reset and now
@@ -48,17 +77,18 @@ export class HyperlineAPI {
         await new Promise((resolve) => setTimeout(resolve, diff));
 
         return await this.fetchBasic<T>(path, options, data);
-      } else if (status === 404) {
+      } else if (status === 404 && method === 'GET') {
         return null;
       } else {
-        const content: any = await result.json();
         throw new Error(
-          `Hyperline Error ${status} (${statusText}) in ${path} for ${options?.method || 'GET'}: ${content.message}`
+          `Hyperline Error ${status} (${statusText}) in ${path} for ${method}: ${message}`
         );
       }
     } else if (result.headers.get('content-type')?.includes('application/pdf'))
       return arrayBufferToBase64(await result.arrayBuffer()) as T;
 
+    if (result.status === 204) return null;
+
     return (await result.json()) as T;
   }
 
@@ -78,6 +108,25 @@ export class HyperlineAPI {
     return await this.fetchBasic(`ingest.hyperline.co${path}`, options, data);
   }
 
+  // INVOICING ENTITY
+
+  async getInvoicingEntities() {
+    return await this.fetch<
+      paths['/v1/invoicing-entities']['get']['responses'][200]['content']['application/json']
+    >('/v1/invoicing-entities');
+  }
+
+  async getInvoicingEntity(id?: string) {
+    if (!id) {
+      this.logger.error('Missing invoicing entity ID', { id });
+      throw new Error('Missing invoicing entity ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/invoicing-entities/{id}']['get']['responses'][200]['content']['application/json']
+    >(`/v1/invoicing-entities/${id}`);
+  }
+
   // CUSTOMER
 
   async getCustomer(id?: string) {
@@ -109,14 +158,18 @@ export class HyperlineAPI {
     take = 100,
     query: operations['getCustomers']['parameters']['query'] = {}
   ) {
+    const queryParams = new URLSearchParams();
+    queryParams.set('take', take.toString());
+    queryParams.set('skip', skip.toString());
+
+    for (const [key, value] of Object.entries(query)) {
+      if (value === undefined || value === null) continue;
+      queryParams.set(key, value.toString());
+    }
+
     return await this.fetch<
       paths['/v1/customers']['get']['responses'][200]['content']['application/json']
-    >(
-      `/v1/customers?take=${take}&skip=${skip}&${Object.entries(query)
-        .filter(([_, value]) => value !== undefined)
-        .map(([key, value]) => `&${key}=${value}`)
-        .join('')}`
-    );
+    >(`/v1/customers?${queryParams.toString()}`);
   }
 
   async getAllCustomers(
@@ -222,14 +275,18 @@ export class HyperlineAPI {
       status: 'all',
     }
   ) {
+    const queryParams = new URLSearchParams();
+    queryParams.set('take', take.toString());
+    queryParams.set('skip', skip.toString());
+
+    for (const [key, value] of Object.entries(query)) {
+      if (value === undefined || value === null) continue;
+      queryParams.set(key, value.toString());
+    }
+
     return await this.fetch<
       paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']
-    >(
-      `/v2/subscriptions?take=${take}&skip=${skip}${Object.entries(query)
-        .filter(([_, value]) => value !== undefined)
-        .map(([key, value]) => `&${key}=${value}`)
-        .join('')}`
-    );
+    >(`/v2/subscriptions?${queryParams.toString()}`);
   }
 
   async getAllSubscriptions(
@@ -249,11 +306,7 @@ export class HyperlineAPI {
       : [...items, ...data];
   }
 
-  async createSubscription(
-    data: NonNullable<
-      paths['/v2/subscriptions']['post']['requestBody']
-    >['content']['application/json']
-  ) {
+  async createSubscription(data: HyperlineCreateSubscriptionPayload) {
     return await this.fetch<
       paths['/v2/subscriptions']['post']['responses'][201]['content']['application/json']
     >('/v2/subscriptions', { method: 'POST' }, data);
@@ -343,14 +396,18 @@ export class HyperlineAPI {
     take = 100,
     query: operations['getInvoices']['parameters']['query'] = { status: 'all' }
   ) {
+    const queryParams = new URLSearchParams();
+    queryParams.set('take', take.toString());
+    queryParams.set('skip', skip.toString());
+
+    for (const [key, value] of Object.entries(query)) {
+      if (value === undefined || value === null) continue;
+      queryParams.set(key, value.toString());
+    }
+
     return await this.fetch<
       paths['/v1/invoices']['get']['responses'][200]['content']['application/json']
-    >(
-      `/v1/invoices?take=${take}&skip=${skip}&${Object.entries(query)
-        .filter(([_, value]) => value !== undefined)
-        .map(([key, value]) => `&${key}=${value}`)
-        .join('')}`
-    );
+    >(`/v1/invoices?${queryParams.toString()}`);
   }
 
   async getInvoicesByCustomerId(
@@ -401,8 +458,46 @@ export class HyperlineAPI {
       : [...items, ...data];
   }
 
+  async voidInvoice(
+    id: string,
+    data: NonNullable<
+      paths['/v1/invoices/{id}/void']['post']['requestBody']
+    >['content']['application/json'] = { send_email: false }
+  ) {
+    if (!id) {
+      this.logger.error('Missing invoice ID', { id });
+      throw new Error('Missing invoice ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/invoices/{id}/void']['post']['responses'][200]['content']['application/json']
+    >(`/v1/invoices/${id}/void`, { method: 'POST' }, data);
+  }
+
+  async deleteInvoice(id: string) {
+    if (!id) {
+      this.logger.error('Missing invoice ID', { id });
+      throw new Error('Missing invoice ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/invoices/{id}']['delete']['responses'][204]['content']
+    >(`/v1/invoices/${id}`, { method: 'DELETE' });
+  }
+
   // OTHERS
 
+  async getCustomerPaymentMethods(customerId: string) {
+    if (!customerId) {
+      this.logger.error('Missing customer ID', { customerId });
+      throw new Error('Missing customer ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/customers/{id}/payment-methods']['get']['responses'][200]['content']['application/json']
+    >(`/v1/customers/${customerId}/payment-methods`);
+  }
+
   async getPaymentMethod(customerId: string, paymentMethodId: string) {
     return await this.fetch<
       paths['/v1/customers/{id}/payment-methods/{paymentMethodId}']['get']['responses'][200]['content']['application/json']

package/src/const.ts

@@ -24,6 +24,22 @@ export const VRTRUST_HALF_PRICE_DEV_COUPON_ID = 'cou_tHLiRdwQ6xGqKA'; // 50% off
 export const VRTRUST_FREE_PRICE_COUPON_ID = 'cou_JGiLite8_nFtnX'; // 100% off
 export const VRTRUST_FREE_PRICE_DEV_COUPON_ID = 'cou_N4GNqSSLEFscto'; // 100% off
 
+export const HYPERLINE_PARTNER_TIER_10_PERCENT_COUPON_ID = 'cou_56kMhdo4fYNs7c';
+export const HYPERLINE_PARTNER_TIER_20_PERCENT_COUPON_ID = 'cou_ExjGVUcu15XKeq';
+export const HYPERLINE_PARTNER_TIER_30_PERCENT_COUPON_ID = 'cou_PJI6mXZHOyoWlx';
+export const HYPERLINE_PARTNER_TIER_40_PERCENT_COUPON_ID = 'cou_gnYic7Uu8zHJX9';
+export const HYPERLINE_PARTNER_TIER_50_PERCENT_COUPON_ID = 'cou_1saVofWCoJsVyz';
+export const HYPERLINE_PARTNER_TIER_60_PERCENT_COUPON_ID = 'cou_tJI9hmHkQXjXOp';
+
+export const HYPERLINE_PARTNER_TIER_COUPON_IDS = {
+  10: HYPERLINE_PARTNER_TIER_10_PERCENT_COUPON_ID,
+  20: HYPERLINE_PARTNER_TIER_20_PERCENT_COUPON_ID,
+  30: HYPERLINE_PARTNER_TIER_30_PERCENT_COUPON_ID,
+  40: HYPERLINE_PARTNER_TIER_40_PERCENT_COUPON_ID,
+  50: HYPERLINE_PARTNER_TIER_50_PERCENT_COUPON_ID,
+  60: HYPERLINE_PARTNER_TIER_60_PERCENT_COUPON_ID,
+} as const;
+
 // Plans
 export const HYPERLINE_DEFAULT_PLAN_ID = 'plan_Dyb5P0ICZ6HsIT';
 export const HYPERLINE_DEFAULT_DEV_PLAN_ID = 'plan_UTCVXFQnKD0oMS';
@@ -31,11 +47,29 @@ export const HYPERLINE_DEFAULT_PLAN_NAME = 'All-in-One VRP Subscription';
 export const HYPERLINE_DEFAULT_PRODUCT_ID = 'itm_9NU7ffT14I4ris';
 export const HYPERLINE_DEFAULT_MIN_AMOUNT = 12500;
 
+export const HYPERLINE_NEW_PRICING_DIRECT_PRODUCT_ID = 'itm_VeR6AJi9OyUQN2';
+export const HYPERLINE_NEW_PRICING_PARTNER_CLIENT_PRODUCT_ID =
+  'itm_wrrT0HuAZ8Tlh1';
+
 export const HYPERLINE_PARTNER_PLAN_ID = 'plan_vkYJcCz7z0XD0N';
 export const HYPERLINE_PARTNER_DEV_PLAN_ID = 'plan_8qtj8T4j0W3oiS';
 export const HYPERLINE_PARTNER_PLAN_NAME = 'VRP Subscription - Partners';
 export const HYPERLINE_PARTNER_PRODUCT_ID = 'itm_AJBM0_jPsrqizl';
 
+export const HYPERLINE_PARTNER_CLIENT_SHADOW_TEMPLATE_ID =
+  'subt_Ny9vQJcTga4LJs';
+export const HYPERLINE_PARTNER_CLIENT_SHADOW_DEV_TEMPLATE_ID =
+  'subt_yQxDuboHpmXNxW';
+export const HYPERLINE_PARTNER_CLIENT_SHADOW_TEMPLATE_CONFIGURATION_ID =
+  'subtc_ELFdZAOA8fHh7o';
+export const HYPERLINE_PARTNER_CLIENT_SHADOW_DEV_TEMPLATE_CONFIGURATION_ID =
+  'subtc_eeflfPiaYWaHSD';
+export const HYPERLINE_PARTNER_CLIENT_SHADOW_PRODUCT_ID = 'itm_7zZNcdWyUf3VWx';
+export const HYPERLINE_PARTNER_CLIENT_SHADOW_DEV_PRODUCT_ID =
+  'itm_WBqFApJRVuVbYx';
+export const HYPERLINE_PARTNER_CLIENT_SHADOW_TEMPLATE_NAME =
+  'VRP Partner Client Shadow Subscription';
+
 export const GL_HYPERLINE_DEFAULT_PLAN_ID = 'plan_JXviWSpU5yuokD';
 export const GL_HYPERLINE_DEFAULT_DEV_PLAN_ID = 'plan_Nnozk8_TfYqTkj';
 export const GL_HYPERLINE_DEFAULT_PLAN_NAME = 'VRTrust Subscription';
@@ -51,6 +85,7 @@ export const WEBHOOKS = {
   'payment_method.created': 'hyperline_payment_method_created',
   'payment_method.errored': 'hyperline_payment_method_errored',
   'payment_method.deleted': 'hyperline_payment_method_deleted',
+  'payment_method.expired': 'hyperline_payment_method_expired',
   'subscription.activated': 'hyperline_subscription_status_changed',
   'subscription.reactivated': 'hyperline_subscription_status_changed',
   'subscription.cancellation_scheduled':

package/src/types.ts

@@ -14,6 +14,61 @@ export type HyperlinePayload<T extends HyperlineWebhook> = {
   data: Record<string, any>;
 };
 
+export type HyperlineCreateSubscriptionPayload = {
+  customer_id: string;
+  invoicing_entity_id?: string | null;
+  activation_strategy?: 'start_date' | 'manually' | 'checkout';
+  starts_at?: string;
+  plan_id?: string;
+  template_id?: string;
+  template_configuration_id?: string;
+  trial?: {
+    end_strategy: 'manual' | 'end_date' | 'duration';
+    starts_at?: string;
+    ends_at?: string;
+    duration?: {
+      period: 'days' | 'weeks' | 'months' | 'years';
+      count: number;
+    };
+  };
+  cancellation_strategy?:
+    | 'refund_prorata'
+    | 'refund_custom'
+    | 'charge_prorata'
+    | 'charge_custom'
+    | 'end_of_period'
+    | 'do_nothing';
+  generate_draft_invoices?: boolean;
+  renew_automatically?: boolean;
+  contract_terms?: {
+    activation_strategy:
+      | 'start_date'
+      | 'immediately'
+      | 'manual'
+      | 'quote_signature'
+      | 'checkout';
+    end_strategy: 'end_date' | 'duration' | 'manual';
+    starts_at?: string;
+    duration?: {
+      period: 'days' | 'weeks' | 'months' | 'years';
+      count: number;
+    };
+    renew_automatically?: boolean;
+    renew_for_duration?: {
+      period: 'days' | 'weeks' | 'months' | 'years';
+      count: number;
+    };
+  };
+  billing_cycle_alignment?: 'calendar_period' | 'anniversary';
+  coupons?: {
+    id: string;
+    repeat: 'once' | 'forever' | 'custom';
+    expires_at?: string;
+    apply_at?: string;
+    product_ids?: string[];
+  }[];
+};
+
 export type BillableEvent = {
   record: {
     id: '202408_cus_w_Q7M9bXcHMKB6';

package/src/utils/arrayBufferToBase64.ts

@@ -1,5 +1,12 @@
 export function arrayBufferToBase64(arrayBuffer: ArrayBuffer) {
+  const binaryChunks: string[] = [];
   const uint8Array = new Uint8Array(arrayBuffer);
-  const binaryString = String.fromCharCode.apply(null, uint8Array as any);
-  return btoa(binaryString);
+
+  // Avoid passing the full PDF as function arguments, which overflows worker stacks on larger files.
+  for (let index = 0; index < uint8Array.length; index += 0x8000)
+    binaryChunks.push(
+      String.fromCharCode(...uint8Array.subarray(index, index + 0x8000))
+    );
+
+  return btoa(binaryChunks.join(''));
 }

package/src/utils/getMrrDiffReasons.ts

@@ -1,5 +1,5 @@
-import { groupBy, utc } from '@vrplatform/utils';
 import { HasuraClient } from '@vrplatform/graphql';
+import { groupBy, utc } from '@vrplatform/utils';
 import { VRP_TENANT_ID, XIMPLIFI_TENANT_ID } from '../const';
 
 function printFinancialNumber(number: number, showPlusMinus = true) {
@@ -45,7 +45,7 @@ export async function getMrrDiffReasons(
         },
       })
       .map((e) => ({
-        tenantId: e.tenant?.id!,
+        tenantId: e.tenant?.id,
         tenantName: e.tenant?.name,
         tenantCreatedAt: e.tenant?.createdAt,
         tenantPlan: e.tenant?.billingPlan,
@@ -109,8 +109,8 @@ export async function getMrrDiffReasons(
         },
       })
       .map((e) => ({
-        tenantId: e.tenant?.id!,
-        billingPartnerId: e.tenant?.calculatedBillingPartnerId!,
+        tenantId: e.tenant?.id,
+        billingPartnerId: e.tenant?.calculatedBillingPartnerId,
         listings: e.props()?.activeListings,
         createdAt: utc(e.createdAt).yyyymmdd(),
       })),
@@ -118,22 +118,25 @@ export async function getMrrDiffReasons(
   messages.push(`Found ${mrrEvents.length} mrr events`);
 
   // join mrr and listings events
-  const trackingEvents = mrrEvents.map((e) => {
-    const filteredEvents = listingsEvents.filter((l) => {
-      const tenantId = [VRP_TENANT_ID, XIMPLIFI_TENANT_ID].includes(
-        l.billingPartnerId!
-      )
-        ? l.tenantId!
-        : l.billingPartnerId!;
+  const trackingEvents = mrrEvents
+    .filter((e) => e.tenantId)
+    .map((e) => {
+      const filteredEvents = listingsEvents.filter((l) => {
+        if (!l.billingPartnerId || !l.tenantId) return false;
+        const tenantId = [VRP_TENANT_ID, XIMPLIFI_TENANT_ID].includes(
+          l.billingPartnerId
+        )
+          ? l.tenantId
+          : l.billingPartnerId;
 
-      return tenantId === e.tenantId && l.createdAt === e.createdAt;
-    });
+        return tenantId === e.tenantId && l.createdAt === e.createdAt;
+      });
 
-    return {
-      ...e,
-      listings: filteredEvents.reduce((acc, l) => acc + (l.listings ?? 0), 0),
-    };
-  });
+      return {
+        ...e,
+        listings: filteredEvents.reduce((acc, l) => acc + (l.listings ?? 0), 0),
+      };
+    });
 
   // get list of tenants
   const tenants: Record<
@@ -155,6 +158,7 @@ export async function getMrrDiffReasons(
     }
   > = {};
   for (const event of trackingEvents) {
+    if (!event.tenantId) continue;
     if (!tenants[event.tenantId]) {
       const partnerTeamsCreatedDiff =
         (event.partnerTeamsCreatedLastDate || 0) -

package/build/main/tsconfig.main.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../../src/_types.generated.ts","../../src/client.ts","../../src/const.ts","../../src/hooks.ts","../../src/index.ts","../../src/types.ts","../../src/utils/arraybuffertobase64.ts","../../src/utils/getmrrdiffreasons.ts","../../src/utils/index.ts"],"version":"5.9.3"}

package/build/module/tsconfig.esm.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../../src/_types.generated.ts","../../src/client.ts","../../src/const.ts","../../src/hooks.ts","../../src/index.ts","../../src/types.ts","../../src/utils/arraybuffertobase64.ts","../../src/utils/getmrrdiffreasons.ts","../../src/utils/index.ts"],"version":"5.9.3"}