@vrplatform/hyperline-client 1.0.1 → 1.0.3

package/src/client.ts

@@ -0,0 +1,362 @@
+import { utc } from '@finalytic/utils';
+import type { operations, paths } from './_types.generated';
+import { BillableEvents, CreateBillableEvent } from './types';
+import { arrayBufferToBase64 } from './utils';
+
+export type Logger = { error(message?: any, ...optionalParams: any[]): void };
+
+export class HyperlineAPI {
+  constructor(token: string, logger: Logger = console) {
+    this.headers = {
+      'Content-Type': 'application/json',
+      Authorization: `Bearer ${token}`,
+    };
+    this.logger = logger;
+  }
+
+  private headers: Record<string, string>;
+
+  private logger: Logger;
+
+  private async fetchBasic<T>(
+    path: string,
+    options?: RequestInit,
+    data?: Record<string, any>
+  ): Promise<T | null> {
+    if (data) options = { body: JSON.stringify(data), ...(options || {}) };
+
+    const sandbox = this.headers.Authorization.includes('test')
+      ? 'sandbox.'
+      : '';
+
+    const result = await fetch(`https://${sandbox}${path}`, {
+      method: 'GET',
+      ...options,
+      headers: { ...this.headers, ...options?.headers },
+    });
+
+    if (!result || !result?.ok) {
+      const status = result?.status;
+      const statusText = result?.statusText;
+
+      if (status === 429) {
+        // get difference between rate limit reset and now
+        const rateLimitReset = utc(result?.headers.get('x-ratelimit-reset'));
+        const diff = rateLimitReset.diff(utc(), 'milliseconds');
+
+        // wait until rate limit resets
+        await new Promise((resolve) => setTimeout(resolve, diff));
+
+        return await this.fetchBasic<T>(path, options, data);
+      } else if (status === 404) {
+        return null;
+      } else {
+        const content: any = await result.json();
+        throw new Error(
+          `Hyperline Error ${status} (${statusText}) in ${path} for ${options?.method || 'GET'}: ${content.message}`
+        );
+      }
+    } else if (result.headers.get('content-type')?.includes('application/pdf'))
+      return arrayBufferToBase64(await result.arrayBuffer()) as T;
+
+    return (await result.json()) as T;
+  }
+
+  private async fetch<T>(
+    path: string,
+    options?: RequestInit,
+    data?: Record<string, any>
+  ): Promise<T | null> {
+    return await this.fetchBasic(`api.hyperline.co${path}`, options, data);
+  }
+
+  private async fetchIngest<T>(
+    path: string,
+    options?: RequestInit,
+    data?: Record<string, any>
+  ): Promise<T | null> {
+    return await this.fetchBasic(`ingest.hyperline.co${path}`, options, data);
+  }
+
+  // CUSTOMER
+
+  async getCustomer(id?: string) {
+    if (!id) {
+      this.logger.error('Missing customer ID', { id });
+      throw new Error('Missing customer ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/customers/{id}']['get']['responses'][200]['content']['application/json']
+    >(`/v1/customers/${id}`);
+  }
+
+  async getCustomers(skip = 0, take = 100) {
+    return await this.fetch<
+      paths['/v1/customers']['get']['responses'][200]['content']['application/json']
+    >(`/v1/customers?take=${take}&skip=${skip}`);
+  }
+
+  async getAllCustomers(
+    items: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data'] = []
+  ): Promise<
+    paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']
+  > {
+    const { data } = (await this.getCustomers(items.length)) || { data: [] };
+
+    return data.length
+      ? this.getAllCustomers([...items, ...data])
+      : [...items, ...data];
+  }
+
+  async createCustomer(
+    data: NonNullable<
+      paths['/v1/customers']['post']['requestBody']
+    >['content']['application/json']
+  ) {
+    return await this.fetch<
+      paths['/v1/customers']['post']['responses'][201]['content']['application/json']
+    >(
+      '/v1/customers',
+      { method: 'POST' },
+      { currency: 'USD', timezone: 'Etc/UTC', ...data }
+    );
+  }
+
+  async updateCustomer(
+    id: string,
+    data: NonNullable<
+      paths['/v1/customers/{id}']['put']['requestBody']
+    >['content']['application/json']
+  ) {
+    if (!id) {
+      this.logger.error('Missing customer ID', { id });
+      throw new Error('Missing customer ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/customers/{id}']['put']['responses'][200]['content']['application/json']
+    >(`/v1/customers/${id}`, { method: 'PUT' }, data);
+  }
+
+  async deleteCustomer(id: string) {
+    return await this.fetch<
+      paths['/v1/customers/{id}']['delete']['responses'][204]['content']
+    >(`/v1/customers/${id}`, {
+      method: 'DELETE',
+    });
+  }
+
+  async archiveCustomer(id: string) {
+    return await this.fetch<
+      paths['/v1/customers/{id}/archive']['put']['responses'][200]['content']['application/json']
+    >(`/v1/customers/${id}/archive`, {
+      method: 'PUT',
+    });
+  }
+
+  async unarchiveCustomer(id: string) {
+    if (!id) {
+      this.logger.error('Missing customer ID', { id });
+      throw new Error('Missing customer ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/customers/{id}/unarchive']['put']['responses'][200]['content']['application/json']
+    >(`/v1/customers/${id}/unarchive`, { method: 'PUT' });
+  }
+
+  async getCustomerPortal(id: string) {
+    return await this.fetch<
+      paths['/v1/customers/{id}/portal']['get']['responses'][200]['content']['application/json']
+    >(`/v1/customers/${id}/portal`);
+  }
+
+  // SUBSCRIPTION
+
+  async getSubscription(id: string) {
+    if (!id) {
+      this.logger.error('Missing subscription ID', { id });
+      throw new Error('Missing subscription ID');
+    }
+
+    return await this.fetch<
+      paths['/v2/subscriptions/{id}']['get']['responses'][200]['content']['application/json']
+    >(`/v2/subscriptions/${id}?include_live_billing=true`);
+  }
+
+  async getSubscriptions(
+    skip = 0,
+    take = 100,
+    query: operations['getSubscriptions']['parameters']['query'] = {
+      status: 'all',
+    }
+  ) {
+    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('')}`
+    );
+  }
+
+  async getAllSubscriptions(
+    items: paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data'] = [],
+    query: operations['getSubscriptions']['parameters']['query'] = {}
+  ): Promise<
+    paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data']
+  > {
+    const { data } = (await this.getSubscriptions(
+      items.length,
+      100,
+      query
+    )) || { data: [] };
+
+    return data.length
+      ? this.getAllSubscriptions([...items, ...data], query)
+      : [...items, ...data];
+  }
+
+  async createSubscription(
+    data: NonNullable<
+      paths['/v2/subscriptions']['post']['requestBody']
+    >['content']['application/json']
+  ) {
+    return await this.fetch<
+      paths['/v2/subscriptions']['post']['responses'][201]['content']['application/json']
+    >('/v2/subscriptions', { method: 'POST' }, data);
+  }
+
+  async updateSubscription(
+    id: string,
+    data: NonNullable<
+      paths['/v1/subscriptions/{id}/update']['post']['requestBody']
+    >['content']['application/json']
+  ) {
+    return await this.fetch<
+      paths['/v1/subscriptions/{id}/update']['post']['responses'][201]['content']['application/json']
+    >(`/v1/subscriptions/${id}/update`, { method: 'POST' }, data);
+  }
+
+  async cancelSubscription(
+    id: string,
+    data: NonNullable<
+      paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']
+    >['content']['application/json']
+  ) {
+    return await this.fetch<
+      paths['/v1/subscriptions/{id}/cancel']['post']['responses'][200]['content']['application/json']
+    >(
+      `/v1/subscriptions/${id}/cancel`,
+      {
+        method: 'POST',
+      },
+      data
+    );
+  }
+
+  async reinstateSubscription(id: string) {
+    return await this.fetch<
+      paths['/v1/subscriptions/{id}/reinstate']['post']['responses'][200]['content']['application/json']
+    >(`/v1/subscriptions/${id}/reinstate`, {
+      method: 'POST',
+    });
+  }
+
+  // PLAN
+
+  async getPlan(id: string) {
+    if (!id) {
+      this.logger.error('Missing plan ID', { id });
+      throw new Error('Missing plan ID');
+    }
+
+    return await this.fetch<
+      paths['/v1/plans/{id}']['get']['responses'][200]['content']['application/json']
+    >(`/v1/plans/${id}`);
+  }
+
+  async getPlans(skip = 0, take = 100) {
+    return await this.fetch<
+      paths['/v1/plans']['get']['responses'][200]['content']['application/json']
+    >(`/v1/plans?take=${take}&skip=${skip}`);
+  }
+
+  // INVOICE
+
+  async getInvoice(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}']['get']['responses'][200]['content']['application/json']
+    >(`/v1/invoices/${id}`);
+  }
+
+  async getInvoices(
+    skip = 0,
+    take = 100,
+    query: operations['getInvoices']['parameters']['query'] = { status: 'all' }
+  ) {
+    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('')}`
+    );
+  }
+
+  async getInvoicesByCustomerId(id: string) {
+    return await this.fetch<
+      paths['/v1/invoices']['get']['responses'][200]['content']['application/json']
+    >(`/v1/invoices?customerId__equals=${id}`);
+  }
+
+  async getInvoiceDownload(id: string) {
+    return await this.fetch<string>(
+      // TODO: fix if type != unknown paths['/v1/invoices/{id}/download']['get']['responses'][200]['content']['application/pdf']
+      `/v1/invoices/${id}/download`,
+      {
+        headers: { 'Content-type': 'application/pdf' },
+      }
+    );
+  }
+
+  async getAllInvoices(
+    items: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data'] = []
+  ): Promise<
+    paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']
+  > {
+    const { data } = (await this.getInvoices(items.length)) || { data: [] };
+
+    return data.length
+      ? this.getAllInvoices([...items, ...data])
+      : [...items, ...data];
+  }
+
+  // OTHERS
+
+  async createBillableEvent(data: CreateBillableEvent[]) {
+    if (!data.length) return { events_created: [] };
+
+    return await this.fetchIngest<BillableEvents>(
+      '/v1/events/batch',
+      { method: 'POST' },
+      data
+    );
+  }
+
+  async getComponentToken(data: {
+    customer_id: string;
+  }) {
+    return await this.fetch<
+      paths['/v1/integrations/components/token']['post']['responses'][201]['content']['application/json']
+    >('/v1/integrations/components/token', { method: 'POST' }, data);
+  }
+}

package/src/const.ts

@@ -1,12 +1,236 @@
+import type { currency_enum } from '@finalytic/graphql';
+import type { TrackingEvent } from '@vrplatform/log';
+import { HyperlineEntities } from './types';
+
+// Tenants
 export const VRP_TENANT_ID = '7bfec41f-aa3f-4602-95d2-f7996e4f0e59';
 export const DEMO_TEST_PARTNER_TENANT_ID =
   '0b6a7bd6-56cc-46b5-b2ab-1bd7d1e994fa';
 export const XIMPLIFI_TENANT_ID = 'd6ab2bbe-e0fc-48d9-89a3-c3c05f4e79b5';
 
-// Hyperline
+// Customers
 export const XIMPLIFI_CUSTOMER_ID = 'cus_HDUZawnaJbPa9p';
+
+// Coupons
 export const XIMPLIFI_COUPON_ID = 'cou_MXCaik3r19_Xkn';
 export const ACCOUNTING_PARTNER_COUPON_ID = 'cou_PJQ328MBAD9kxY';
+
+// Plans
 export const HYPERLINE_DEFAULT_PLAN_ID = 'plan_Dyb5P0ICZ6HsIT';
+export const HYPERLINE_DEFAULT_PLAN_NAME = 'All-in-One VRP Subscription';
+
 export const HYPERLINE_PARTNER_PLAN_ID = 'plan_vkYJcCz7z0XD0N';
+export const HYPERLINE_PARTNER_PLAN_NAME = 'VRP Subscription - Partners';
+
 export const DEV_HYPERLINE_DEFAULT_PLAN_ID = 'plan_UTCVXFQnKD0oMS';
+
+export const GL_HYPERLINE_DEFAULT_PLAN_ID = 'plan_JXviWSpU5yuokD';
+export const GL_HYPERLINE_DEFAULT_PLAN_NAME = 'VRTrust Subscription';
+
+export const GL_HYPERLINE_PARTNER_PLAN_ID = 'plan_vyxckdvUi8X_mr';
+export const GL_HYPERLINE_PARTNER_PLAN_NAME = 'VRTrust Subscription - Partners';
+
+export const WEBHOOKS = {
+  'payment_method.created': 'hyperline_payment_method_created',
+  'payment_method.errored': 'hyperline_payment_method_errored',
+  'payment_method.deleted': 'hyperline_payment_method_deleted',
+  'subscription.activated': 'hyperline_subscription_status_changed',
+  'subscription.reactivated': 'hyperline_subscription_status_changed',
+  'subscription.cancelled': 'hyperline_subscription_status_changed',
+  'subscription.cancellation_scheduled':
+    'hyperline_subscription_cancellation_scheduled',
+  // 'subscription.created': 'hyperline_subscription_created',
+  'subscription.errored': 'hyperline_subscription_status_changed',
+  'subscription.paused': 'hyperline_subscription_status_changed',
+  'subscription.voided': 'hyperline_subscription_status_changed',
+  // 'subscription.charged': 'hyperline_subscription_charged',
+  'customer.created': 'hyperline_customer_created',
+  'customer.updated': 'hyperline_customer_updated',
+  'customer.deleted': 'hyperline_customer_deleted',
+} satisfies Record<string, TrackingEvent>;
+
+export const CURRENCY_MAP: Record<
+  currency_enum,
+  HyperlineEntities['Currency'] | undefined
+> = {
+  aed: 'AED',
+  afn: 'AFN',
+  all: 'ALL',
+  amd: 'AMD',
+  ang: 'ANG',
+  aoa: 'AOA',
+  ars: 'ARS',
+  aud: 'AUD',
+  awg: 'AWG',
+  azn: 'AZN',
+  bam: 'BAM',
+  bbd: 'BBD',
+  bdt: 'BDT',
+  bgn: 'BGN',
+  bhd: 'BHD',
+  bif: 'BIF',
+  bmd: 'BMD',
+  bnd: 'BND',
+  bob: 'BOB',
+  bov: 'BOB',
+  brl: 'BRL',
+  bsd: 'BSD',
+  btn: 'BTN',
+  bwp: 'BWP',
+  byn: 'BYR',
+  byr: 'BYR',
+  bzd: 'BZD',
+  cad: 'CAD',
+  cdf: 'CDF',
+  che: 'CHF',
+  chf: 'CHF',
+  chw: 'CHF',
+  clf: 'CLP',
+  clp: 'CLP',
+  cny: 'CNY',
+  cop: 'COP',
+  cou: 'COP',
+  crc: 'CRC',
+  cuc: 'CUP',
+  cup: 'CUP',
+  cve: 'CVE',
+  czk: 'CZK',
+  djf: 'DJF',
+  dkk: 'DKK',
+  dop: 'DOP',
+  dzd: 'DZD',
+  egp: 'EGP',
+  ern: 'ERN',
+  etb: 'ETB',
+  eur: 'EUR',
+  fjd: 'FJD',
+  fkp: 'FKP',
+  gbp: 'GBP',
+  gel: 'GEL',
+  ghs: 'GHS',
+  gip: 'GIP',
+  gmd: 'GMD',
+  gnf: 'GNF',
+  gtq: 'GTQ',
+  gyd: 'GYD',
+  hkd: 'HKD',
+  hnl: 'HNL',
+  hrk: 'HRK',
+  htg: 'HTG',
+  huf: 'HUF',
+  idr: 'IDR',
+  ils: 'ILS',
+  inr: 'INR',
+  iqd: 'IQD',
+  irr: 'IRR',
+  isk: 'ISK',
+  jmd: 'JMD',
+  jod: 'JOD',
+  jpy: 'JPY',
+  kes: 'KES',
+  kgs: 'KGS',
+  khr: 'KHR',
+  kmf: 'KMF',
+  kpw: 'KPW',
+  krw: 'KRW',
+  kwd: 'KWD',
+  kyd: 'KYD',
+  kzt: 'KZT',
+  lak: 'LAK',
+  lbp: 'LBP',
+  lkr: 'LKR',
+  lrd: 'LRD',
+  lsl: 'LSL',
+  ltl: 'EUR',
+  lvl: 'EUR',
+  lyd: 'LYD',
+  mad: 'MAD',
+  mdl: 'MDL',
+  mga: 'MGA',
+  mkd: 'MKD',
+  mmk: 'MMK',
+  mnt: 'MNT',
+  mop: 'MOP',
+  mro: 'MRO',
+  mur: 'MUR',
+  mvr: 'MVR',
+  mwk: 'MWK',
+  mxn: 'MXN',
+  mxv: 'MXN',
+  myr: 'MYR',
+  mzn: 'MZN',
+  nad: 'NAD',
+  ngn: 'NGN',
+  nio: 'NIO',
+  nok: 'NOK',
+  npr: 'NPR',
+  nzd: 'NZD',
+  omr: 'OMR',
+  pab: 'PAB',
+  pen: 'PEN',
+  pgk: 'PGK',
+  php: 'PHP',
+  pkr: 'PKR',
+  pln: 'PLN',
+  pyg: 'PYG',
+  qar: 'QAR',
+  ron: 'RON',
+  rsd: 'RSD',
+  rub: 'RUB',
+  rwf: 'RWF',
+  sar: 'SAR',
+  sbd: 'SBD',
+  scr: 'SCR',
+  sdg: 'SDG',
+  sek: 'SEK',
+  sgd: 'SGD',
+  shp: 'SHP',
+  sll: 'SLL',
+  sos: 'SOS',
+  srd: 'SRD',
+  ssp: 'SSP',
+  std: 'STD',
+  syp: 'SYP',
+  szl: 'SZL',
+  thb: 'THB',
+  tjs: 'TJS',
+  tmt: 'TMT',
+  tnd: 'TND',
+  top: 'TOP',
+  try: 'TRY',
+  ttd: 'TTD',
+  twd: 'TWD',
+  tzs: 'TZS',
+  uah: 'UAH',
+  ugx: 'UGX',
+  usd: 'USD',
+  uyu: 'UYU',
+  uzs: 'UZS',
+  vef: 'VEF',
+  vnd: 'VND',
+  vuv: 'VUV',
+  wst: 'WST',
+  xaf: 'XAF',
+  xpf: 'XPF',
+  yer: 'YER',
+  zar: 'ZAR',
+  zmw: 'ZMW',
+  zwl: 'ZWL',
+  usn: undefined,
+  uss: undefined,
+  uyi: undefined,
+  xag: undefined,
+  xau: undefined,
+  xba: undefined,
+  xbb: undefined,
+  xbc: undefined,
+  xbd: undefined,
+  xcd: undefined,
+  xdr: undefined,
+  xfu: undefined,
+  xof: undefined,
+  xpd: undefined,
+  xpt: undefined,
+  xts: undefined,
+  xxx: undefined,
+};

package/src/hooks.ts

@@ -0,0 +1,24 @@
+import { HyperlineAPI, Logger } from './client';
+
+export function useHyperline(
+  env: {
+    PRODUCTION_HYPERLINE_API_KEY: string;
+    DEV_HYPERLINE_API_KEY: string;
+  },
+  environment: 'production' | 'development',
+  logger?: Logger
+) {
+  const isProduction = environment === 'production';
+
+  const token = isProduction
+    ? env.PRODUCTION_HYPERLINE_API_KEY
+    : env.DEV_HYPERLINE_API_KEY;
+
+  const hyperline = useHyperlineByToken(token, logger);
+
+  return { hyperline, token, isProduction };
+}
+
+export function useHyperlineByToken(token: string, logger: Logger = console) {
+  return new HyperlineAPI(token, logger);
+}