@vrplatform/hyperline-client 1.0.24 → 1.0.26

package/src/client.ts

@@ -25,6 +25,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 +36,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 +73,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 +104,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 +154,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 +271,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(
@@ -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,6 +47,10 @@ 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';
@@ -51,6 +71,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/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/calculateMrr.ts

@@ -0,0 +1,206 @@
+import {
+  GL_HYPERLINE_DEFAULT_DEV_PLAN_ID,
+  GL_HYPERLINE_DEFAULT_MIN_AMOUNT,
+  GL_HYPERLINE_DEFAULT_PLAN_ID,
+  HYPERLINE_DEFAULT_DEV_PLAN_ID,
+  HYPERLINE_DEFAULT_MIN_AMOUNT,
+  HYPERLINE_DEFAULT_PLAN_ID,
+} from '../const';
+import { useHyperlineByToken } from '../hooks';
+
+export async function calculateMrr(
+  subscriptionId: string,
+  estimated = false,
+  _activeListings?: number,
+  hyperline: {
+    getSubscription(
+      id: string,
+      liveBilling?: boolean
+    ): Promise<{
+      customer_id: string;
+      plan_id: string | null;
+      products?: unknown[];
+      coupons?: (
+        | {
+            type: 'amount';
+            repeat: 'once' | 'forever' | 'custom';
+            discount_amount: number;
+          }
+        | {
+            type: 'percent';
+            repeat: 'once' | 'forever' | 'custom';
+            discount_percent: number;
+          }
+      )[];
+      phases?: {
+        type: 'setup' | 'trial' | 'standard';
+        status: 'pending' | 'active' | 'finished';
+        products: {
+          min_amount?: number | null;
+          max_amount?: number | null;
+          prices: (
+            | {
+                type: 'volume';
+                amount: number;
+                from: number;
+                to: number | null;
+                unit_count: number;
+              }
+            | {
+                type:
+                  | 'bps'
+                  | 'bulk'
+                  | 'bundle'
+                  | 'fee'
+                  | 'flat_fee'
+                  | 'packaged';
+              }
+          )[];
+        }[];
+      }[];
+      live_billing?: { total_amount: number };
+    } | null>;
+    getInvoicesByCustomerId(id: string): Promise<{
+      data: {
+        emitted_at: string;
+        total_amount: number;
+      }[];
+    } | null>;
+  } = useHyperlineByToken(process.env.HYPERLINE_TOKEN!),
+  includeLiveBilling = false
+) {
+  const _subscription = await hyperline.getSubscription(
+    subscriptionId,
+    includeLiveBilling
+  );
+  if (!_subscription) throw new Error('Subscription not found');
+
+  const { products, phases, ...subscription } = _subscription;
+
+  let mrr = 0;
+  const activeListings = _activeListings || 0;
+  const phase = phases?.filter((x) =>
+    estimated
+      ? x.type === 'standard'
+      : (x.type === 'trial' && x.status === 'active') || x.type === 'standard'
+  )?.[0];
+  const product = phase?.products?.[0];
+  const type = product?.prices?.[0].type;
+  if (type === 'volume') {
+    const volumePrices: Array<{
+      amount: number;
+      from: number;
+      to: number | null;
+      unit_count: number;
+    }> = [];
+
+    product?.prices?.forEach((price) => {
+      if (
+        price.type !== 'volume' ||
+        !('amount' in price) ||
+        !('from' in price) ||
+        !('to' in price) ||
+        !('unit_count' in price)
+      )
+        return;
+
+      volumePrices.push({
+        amount: price.amount,
+        from: price.from,
+        to: price.to,
+        unit_count: price.unit_count,
+      });
+    });
+    volumePrices.sort((a, b) => a.from - b.from);
+
+    mrr =
+      volumePrices.reduce((acc, price) => {
+        const listings =
+          price.to && activeListings >= price.to
+            ? price.to - price.from
+            : activeListings >= price.from
+              ? activeListings - price.from
+              : 0;
+
+        acc += (price.amount / 100) * (listings / price.unit_count);
+
+        return acc;
+      }, 0) || 0;
+
+    const firstTier = volumePrices[0];
+    const secondTier = volumePrices[1];
+    const product_min_amount =
+      product &&
+      'min_amount' in product &&
+      typeof product.min_amount === 'number'
+        ? product.min_amount
+        : null;
+    const product_max_amount =
+      product &&
+      'max_amount' in product &&
+      typeof product.max_amount === 'number'
+        ? product.max_amount
+        : null;
+    const inferred_min_amount =
+      firstTier &&
+      secondTier &&
+      firstTier.from === 0 &&
+      firstTier.to != null &&
+      secondTier.from === firstTier.to &&
+      firstTier.amount === secondTier.amount &&
+      firstTier.unit_count === secondTier.unit_count
+        ? firstTier.amount *
+          ((firstTier.to - firstTier.from) / firstTier.unit_count)
+        : 0;
+    const plan_min_amount = [
+      GL_HYPERLINE_DEFAULT_PLAN_ID,
+      GL_HYPERLINE_DEFAULT_DEV_PLAN_ID,
+    ].includes(subscription.plan_id!)
+      ? GL_HYPERLINE_DEFAULT_MIN_AMOUNT
+      : [HYPERLINE_DEFAULT_PLAN_ID, HYPERLINE_DEFAULT_DEV_PLAN_ID].includes(
+            subscription.plan_id!
+          )
+        ? HYPERLINE_DEFAULT_MIN_AMOUNT
+        : 0;
+
+    const min_amount =
+      ((product_min_amount || plan_min_amount || inferred_min_amount) ?? 0) /
+      100;
+    mrr = Math.max(mrr, min_amount);
+
+    const max_amount = ((product_max_amount || 0) ?? 0) / 100;
+    mrr = max_amount > 0 ? Math.min(mrr, max_amount) : mrr;
+
+    // apply discounts (only these who repeat forever if estimated is true)
+    (subscription.coupons || [])
+      .filter((coupon) => (estimated ? coupon.repeat === 'forever' : true))
+      .forEach((x) => {
+        if ('discount_amount' in x && x.discount_amount)
+          mrr -= x.discount_amount / 100;
+        else if ('discount_percent' in x && x.discount_percent)
+          mrr -= (x.discount_percent / 100) * mrr;
+      });
+  } else if (type === 'bps') {
+    const { data } = subscription?.customer_id
+      ? (await hyperline.getInvoicesByCustomerId(subscription.customer_id)) || {
+          data: [],
+        }
+      : { data: [] };
+
+    // sort invoices by date
+    const invoices = data
+      ?.sort((a, b) => a.emitted_at.localeCompare(b.emitted_at))
+      .reverse();
+
+    // get the last invoice
+    mrr = (invoices[0]?.total_amount || 0) / 100;
+  }
+
+  return {
+    mrr,
+    mrrAlt:
+      subscription.live_billing?.total_amount == null
+        ? null
+        : subscription.live_billing.total_amount / 100,
+  };
+}

package/src/utils/index.ts

@@ -1,2 +1,3 @@
 export * from './arrayBufferToBase64';
+export * from './calculateMrr';
 export * from './getMrrDiffReasons';