@vrplatform/hyperline-client 1.0.1 → 1.0.3

package/src/index.ts

@@ -1,446 +1,4 @@
-import { utc } from '@finalytic/utils';
-import type { TrackingEvent } from '@vrplatform/log';
-import type { components, operations, paths } from './_types.generated';
-
-export type HyperlineEntities = components['schemas'];
-export type HyperlineEndpoints = paths;
-
 export * from './const';
-
-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',
-} satisfies Record<string, TrackingEvent>;
-
-export type HyperlineWebhook = keyof typeof webhooks;
-export type HyperlineEvent<T extends HyperlineWebhook> = (typeof webhooks)[T];
-export type HyperlinePayload<T extends HyperlineWebhook> = {
-  event_type: T;
-  data: Record<string, any>;
-};
-
-export type BillableEvent = {
-  record: {
-    id: '202408_cus_w_Q7M9bXcHMKB6';
-    amount: 26;
-  };
-  timestamp: '2024-08-07T07:35:20.307Z';
-  event_type: 'api_call';
-  customer_id: 'cus_w_Q7M9bXcHMKB6';
-};
-export type BillableEvents = {
-  events_created: BillableEvent[];
-};
-export type CreateBillableEvent = {
-  customer_id: string;
-  event_type: 'api_call';
-  timestamp: string;
-  record: {
-    id?: string;
-    durationInMs?: number;
-    isVerified?: true;
-    amount?: number;
-    amountGl?: number;
-    amountNonGl?: number;
-  };
-};
-
-type Logger = { error(message?: any, ...optionalParams: any[]): void };
-
-function arrayBufferToBase64(arrayBuffer: ArrayBuffer) {
-  const uint8Array = new Uint8Array(arrayBuffer);
-  const binaryString = String.fromCharCode.apply(null, uint8Array as any);
-  return btoa(binaryString);
-}
-
-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);
-  }
-}
-
-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);
-}
+export * from './types';
+export * from './client';
+export * from './hooks';

package/src/types.ts

@@ -0,0 +1,43 @@
+import type { components, paths } from './_types.generated';
+import { WEBHOOKS } from './const';
+
+export type HyperlineEntities = components['schemas'];
+
+export type HyperlineEndpoints = paths;
+
+export type HyperlineWebhook = keyof typeof WEBHOOKS;
+
+export type HyperlineEvent<T extends HyperlineWebhook> = (typeof WEBHOOKS)[T];
+
+export type HyperlinePayload<T extends HyperlineWebhook> = {
+  event_type: T;
+  data: Record<string, any>;
+};
+
+export type BillableEvent = {
+  record: {
+    id: '202408_cus_w_Q7M9bXcHMKB6';
+    amount: 26;
+  };
+  timestamp: '2024-08-07T07:35:20.307Z';
+  event_type: 'api_call';
+  customer_id: 'cus_w_Q7M9bXcHMKB6';
+};
+
+export type BillableEvents = {
+  events_created: BillableEvent[];
+};
+
+export type CreateBillableEvent = {
+  customer_id: string;
+  event_type: 'api_call';
+  timestamp: string;
+  record: {
+    id?: string;
+    durationInMs?: number;
+    isVerified?: true;
+    amount?: number;
+    amountGl?: number;
+    amountNonGl?: number;
+  };
+};

package/src/utils.ts

@@ -0,0 +1,5 @@
+export function arrayBufferToBase64(arrayBuffer: ArrayBuffer) {
+  const uint8Array = new Uint8Array(arrayBuffer);
+  const binaryString = String.fromCharCode.apply(null, uint8Array as any);
+  return btoa(binaryString);
+}