@vrplatform/hyperline-client 1.0.9 → 1.0.11

package/src/client.ts

@@ -187,7 +187,7 @@ export class HyperlineAPI {
 
   // SUBSCRIPTION
 
-  async getSubscription(id: string) {
+  async getSubscription(id: string, liveBilling = false) {
     if (!id) {
       this.logger.error('Missing subscription ID', { id });
       throw new Error('Missing subscription ID');
@@ -195,7 +195,9 @@ export class HyperlineAPI {
 
     return await this.fetch<
       paths['/v2/subscriptions/{id}']['get']['responses'][200]['content']['application/json']
-    >(`/v2/subscriptions/${id}?include_live_billing=true`);
+    >(
+      `/v2/subscriptions/${id}?include_live_billing=${liveBilling ? 'true' : 'false'}`
+    );
   }
 
   async getSubscriptions(

package/src/const.ts

@@ -19,6 +19,11 @@ export const XIMPLIFI_DEV_COUPON_ID = 'cou_MGtxHbT8IR1gK9';
 export const ACCOUNTING_PARTNER_COUPON_ID = 'cou_PJQ328MBAD9kxY';
 export const ACCOUNTING_PARTNER_DEV_COUPON_ID = 'cou_y6UfaI2X1m34Qg';
 
+export const VRTRUST_HALF_PRICE_COUPON_ID = 'cou_CTOQqs0SOeSc-e'; // 50% off
+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
+
 // Plans
 export const HYPERLINE_DEFAULT_PLAN_ID = 'plan_Dyb5P0ICZ6HsIT';
 export const HYPERLINE_DEFAULT_DEV_PLAN_ID = 'plan_UTCVXFQnKD0oMS';

package/src/index.ts

@@ -2,3 +2,4 @@ export * from './const';
 export * from './types';
 export * from './client';
 export * from './hooks';
+export * from './utils';

package/src/utils/getMrrDiffReasons.ts

@@ -0,0 +1,305 @@
+import { useHasuraClient } from '@finalytic/graphql';
+import { groupBy, utc } from '@finalytic/utils';
+import {
+  VRP_TENANT_ID,
+  XIMPLIFI_TENANT_ID,
+} from '@vrplatform/hyperline-client';
+
+function printFinancialNumber(number: number, showPlusMinus = true) {
+  return `${showPlusMinus ? (number >= 0 ? '+' : '-') : ''}$${Math.abs(number)
+    .toFixed(2)
+    .toString()
+    .replace(/\B(?=(\d{3})+(?!\d))/g, ',')}`;
+}
+function printPlusMinus(number: number) {
+  return `${number >= 0 ? '+' : '-'}${Math.abs(number)}`;
+}
+
+const hasura = useHasuraClient({
+  secret: process.env.HASURA_GRAPHQL_ADMIN_SECRET,
+});
+
+export async function getMrrDiffReasons(
+  firstDate: string,
+  lastDate: string,
+  client = hasura
+) {
+  const messages: string[] = [];
+  messages.push(
+    `MRR Diff Reasons from ${utc(firstDate).yyyymmdd()} to ${utc(lastDate).yyyymmdd()}`
+  );
+  messages.push('--------------------------------');
+
+  const { mrrEvents, listingsEvents } = await client.query((q) => ({
+    mrrEvents: q
+      .tracking_event({
+        where: {
+          name: { _eq: 'mrr_reported' },
+          _or: [
+            {
+              createdAt: {
+                _gte: utc(firstDate).yyyymmdd(),
+                _lte: utc(firstDate).add(1, 'day').yyyymmdd(),
+              },
+            },
+            {
+              createdAt: {
+                _gte: utc(lastDate).yyyymmdd(),
+                _lte: utc(lastDate).add(1, 'day').yyyymmdd(),
+              },
+            },
+          ],
+        },
+      })
+      .map((e) => ({
+        tenantId: e.tenant?.id!,
+        tenantName: e.tenant?.name,
+        tenantCreatedAt: e.tenant?.createdAt,
+        tenantPlan: e.tenant?.billingPlan,
+        partnerTeamsCreatedFirstDate: e.tenant
+          ?.clients({
+            where: {
+              createdAt: {
+                _lte: utc(firstDate).yyyymmdd(),
+              },
+            },
+          })
+          .map((c) => c.id).length,
+        partnerTeamsCreatedLastDate: e.tenant
+          ?.clients({
+            where: {
+              createdAt: {
+                _lte: utc(lastDate).yyyymmdd(),
+              },
+            },
+          })
+          .map((c) => c.id).length,
+        partnerTeamsCancelledFirstDate: e.tenant
+          ?.clients({
+            where: {
+              cancelledAt: {
+                _lte: utc(firstDate).yyyymmdd(),
+              },
+            },
+          })
+          .map((c) => c.id).length,
+        partnerTeamsCancelledLastDate: e.tenant
+          ?.clients({
+            where: {
+              cancelledAt: {
+                _lte: utc(lastDate).yyyymmdd(),
+              },
+            },
+          })
+          .map((c) => c.id).length,
+        mrr: e.props()?.mrr,
+        createdAt: utc(e.createdAt).yyyymmdd(),
+      })),
+    listingsEvents: q
+      .tracking_event({
+        where: {
+          name: { _eq: 'listings_reported' },
+          _or: [
+            {
+              createdAt: {
+                _gte: utc(firstDate).yyyymmdd(),
+                _lte: utc(firstDate).add(1, 'day').yyyymmdd(),
+              },
+            },
+            {
+              createdAt: {
+                _gte: utc(lastDate).yyyymmdd(),
+                _lte: utc(lastDate).add(1, 'day').yyyymmdd(),
+              },
+            },
+          ],
+        },
+      })
+      .map((e) => ({
+        tenantId: e.tenant?.id!,
+        billingPartnerId: e.tenant?.calculatedBillingPartnerId!,
+        listings: e.props()?.activeListings,
+        createdAt: utc(e.createdAt).yyyymmdd(),
+      })),
+  }));
+  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!;
+
+      return tenantId === e.tenantId && l.createdAt === e.createdAt;
+    });
+
+    return {
+      ...e,
+      listings: filteredEvents.reduce((acc, l) => acc + (l.listings ?? 0), 0),
+    };
+  });
+
+  // get list of tenants
+  const tenants: Record<
+    string,
+    {
+      id: string;
+      name?: string;
+      plan?: string;
+      activePartnerTeamsDiff: number;
+      mrrFirstDate?: number;
+      mrrLastDate?: number;
+      mrrDiff: number;
+      listingsFirstDate?: number;
+      listingsLastDate?: number;
+      listingsDiff: number;
+      createdAt: string;
+      isNew: boolean;
+      hasCancelled?: boolean;
+    }
+  > = {};
+  for (const event of trackingEvents) {
+    if (!tenants[event.tenantId]) {
+      const partnerTeamsCreatedDiff =
+        (event.partnerTeamsCreatedLastDate || 0) -
+        (event.partnerTeamsCreatedFirstDate || 0);
+      const partnerTeamsCancelledDiff =
+        (event.partnerTeamsCancelledLastDate || 0) -
+        (event.partnerTeamsCancelledFirstDate || 0);
+
+      tenants[event.tenantId] = {
+        id: event.tenantId,
+        name: event.tenantName,
+        plan: event.tenantPlan,
+        activePartnerTeamsDiff:
+          partnerTeamsCreatedDiff - partnerTeamsCancelledDiff,
+        mrrFirstDate: undefined,
+        mrrLastDate: undefined,
+        mrrDiff: 0,
+        listingsFirstDate: undefined,
+        listingsLastDate: undefined,
+        listingsDiff: 0,
+        createdAt: utc(event.tenantCreatedAt).yyyymmdd(),
+        isNew: utc(event.tenantCreatedAt).isBetween(
+          utc(firstDate),
+          utc(lastDate)
+        ),
+      };
+    }
+
+    if (event.createdAt === firstDate) {
+      tenants[event.tenantId].mrrFirstDate = event.mrr;
+      tenants[event.tenantId].listingsFirstDate = event.listings;
+    }
+    if (event.createdAt === lastDate) {
+      tenants[event.tenantId].mrrLastDate = event.mrr;
+      tenants[event.tenantId].listingsLastDate = event.listings;
+    }
+  }
+
+  const result = Object.values(tenants)
+    .map(
+      ({
+        mrrFirstDate,
+        mrrLastDate,
+        listingsFirstDate,
+        listingsLastDate,
+        ...t
+      }) => ({
+        ...t,
+        mrrDiff: (mrrLastDate ?? 0) - (mrrFirstDate ?? 0),
+        listingsDiff: (listingsLastDate ?? 0) - (listingsFirstDate ?? 0),
+        hasCancelled: mrrFirstDate !== undefined && mrrLastDate === undefined,
+      })
+    )
+    .filter((t) => t.mrrDiff)
+    .sort((a, b) => b.mrrDiff - a.mrrDiff)
+    .reverse();
+
+  // calculate summ of mrr per day
+  const groupedEvents = groupBy(trackingEvents, (e) => e.createdAt);
+  const summedMrrPerDay = Object.entries(groupedEvents)
+    .map(([date, events]) => {
+      const mrr = events.reduce((acc, e) => acc + (e.mrr ?? 0), 0);
+      const listings = events.reduce((acc, e) => acc + (e.listings ?? 0), 0);
+
+      return {
+        date,
+        mrr,
+        count: events.length,
+        listings,
+      };
+    })
+    .sort((a, b) => utc(b.date).diff(utc(a.date)));
+  messages.push(
+    `MRR sum changed from ${printFinancialNumber(summedMrrPerDay[1].mrr, false)} to ${printFinancialNumber(summedMrrPerDay[0].mrr, false)} (${printFinancialNumber(summedMrrPerDay[0].mrr - summedMrrPerDay[1].mrr)})`
+  );
+  messages.push(
+    `MRR Reports changed from ${summedMrrPerDay[1].count.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')} to ${summedMrrPerDay[0].count.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')} (${printPlusMinus(summedMrrPerDay[0].count - summedMrrPerDay[1].count)})`
+  );
+  messages.push(
+    `Active Listings changed from ${summedMrrPerDay[1].listings.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')} to ${summedMrrPerDay[0].listings.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')} (${printPlusMinus(summedMrrPerDay[0].listings - summedMrrPerDay[1].listings)})`
+  );
+  messages.push(
+    `Active Partner Teams changed by ${printPlusMinus(
+      result.reduce((acc, t) => acc + t.activePartnerTeamsDiff, 0)
+    )}`
+  );
+  messages.push();
+
+  const cancelledTenants = result.filter((t) => t.hasCancelled);
+  const legacyTenants = result.filter(
+    (t) =>
+      t.plan?.includes('Legacy') &&
+      !cancelledTenants.map((t) => t.id).includes(t.id)
+  );
+  const newTenants = result.filter(
+    (t) =>
+      t.isNew &&
+      !cancelledTenants.map((t) => t.id).includes(t.id) &&
+      !legacyTenants.map((t) => t.id).includes(t.id)
+  );
+  const activeListings = result.filter(
+    (t) =>
+      t.listingsDiff &&
+      !newTenants.map((t) => t.id).includes(t.id) &&
+      !cancelledTenants.map((t) => t.id).includes(t.id) &&
+      !legacyTenants.map((t) => t.id).includes(t.id)
+  );
+  const otherTenants = result.filter(
+    (t) =>
+      !newTenants.map((t) => t.id).includes(t.id) &&
+      !cancelledTenants.map((t) => t.id).includes(t.id) &&
+      !legacyTenants.map((t) => t.id).includes(t.id) &&
+      !activeListings.map((t) => t.id).includes(t.id)
+  );
+  const total =
+    newTenants.reduce((acc, t) => acc + t.mrrDiff, 0) +
+    cancelledTenants.reduce((acc, t) => acc + t.mrrDiff, 0) +
+    legacyTenants.reduce((acc, t) => acc + t.mrrDiff, 0) +
+    activeListings.reduce((acc, t) => acc + t.mrrDiff, 0) +
+    otherTenants.reduce((acc, t) => acc + t.mrrDiff, 0);
+  messages.push(
+    `MRR from ${newTenants.length} new tenants: ${printFinancialNumber(newTenants.reduce((acc, t) => acc + t.mrrDiff, 0))}`
+  );
+  messages.push(
+    `MRR from ${cancelledTenants.length} cancelled tenants: ${printFinancialNumber(cancelledTenants.reduce((acc, t) => acc + t.mrrDiff, 0))}`
+  );
+  messages.push(
+    `MRR from ${legacyTenants.length} tenants with Legacy plans: ${printFinancialNumber(legacyTenants.reduce((acc, t) => acc + t.mrrDiff, 0))}`
+  );
+  messages.push(
+    `MRR from ${activeListings.length} tenants with active listings changes: ${printFinancialNumber(activeListings.reduce((acc, t) => acc + t.mrrDiff, 0))}`
+  );
+  messages.push(
+    `MRR from ${otherTenants.length} other tenants: ${printFinancialNumber(
+      otherTenants.reduce((acc, t) => acc + t.mrrDiff, 0)
+    )} (${otherTenants.map((t) => `${t.name} (${printFinancialNumber(t.mrrDiff)})`).join(', ')})`
+  );
+  messages.push(`= ${printFinancialNumber(total)}`);
+
+  return { messages, result };
+}

package/src/utils/index.ts

@@ -0,0 +1 @@
+export * from './getMrrDiffReasons';