@vrplatform/api 1.3.1-stage.2218 → 1.3.1-stage.2230

package/src/services/analytics/generated/v1.ts

@@ -0,0 +1,360 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/health": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Health endpoint for analytics worker. */
+        get: operations["getHealth"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/events/track": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Track a single analytics event. */
+        post: operations["postV1EventsTrack"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/events/track-batch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Track a batch of analytics events. */
+        post: operations["postV1EventsTrackBatch"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: never;
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getHealth: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Service health */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        ok: boolean;
+                        /** @constant */
+                        service: "analytics";
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
+    postV1EventsTrack: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** Format: uuid */
+                    tenantId: string;
+                    event: string;
+                    packageName: string;
+                    /** Format: uuid */
+                    userId?: string;
+                    anonymousId?: string;
+                    groupId?: string;
+                    /** Format: date-time */
+                    trackedAt?: string;
+                    /** @default {} */
+                    properties?: {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+        responses: {
+            /** @description Tracked event id */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        id: string;
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
+    postV1EventsTrackBatch: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    events: {
+                        /** Format: uuid */
+                        tenantId: string;
+                        event: string;
+                        packageName: string;
+                        /** Format: uuid */
+                        userId?: string;
+                        anonymousId?: string;
+                        groupId?: string;
+                        /** Format: date-time */
+                        trackedAt?: string;
+                        /** @default {} */
+                        properties?: {
+                            [key: string]: unknown;
+                        };
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description Tracked event ids */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        ids: string[];
+                        total: number;
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
+}

package/src/{client.ts → services/api/client.ts}

@@ -4,9 +4,10 @@ import {
   useRetryableFetch,
 } from '@vrplatform/utils';
 import createClient from 'openapi-fetch';
-import { useCache } from './cache';
+import { useCache } from '../../cache';
+import { generateApiKeySec } from '../../sec';
+import { applySentryTraceHeaders } from '../../service-client';
 import type { paths } from './generated/v1';
-import { generateApiKeySec } from './sec';
 import type { ApiClient, ApiClientAuth } from './types';
 
 export function useApiClient({
@@ -14,7 +15,6 @@ export function useApiClient({
   local,
   auth,
   sessionId: sid,
-  // headers: h,
   testing,
   headers: h,
   ...retryableFetchParams
@@ -33,13 +33,12 @@ export function useApiClient({
   const baseUrl =
     (local
       ? `http://localhost:${typeof local === 'number' ? local : 8877}`
-      : base) || 'https://api.vrplatform.app';
+      : base) || 'https://api.edge.vrplatform.app';
 
   const sessionId = sid || crypto.randomUUID();
-  // cache the sec key for 1 minute (its valid for 5 minutes on the API)
   const cache = useCache(
-    async (v: string) =>
-      generateApiKeySec(v, testing?.getOverwriteTimestamp?.()),
+    async (value: string) =>
+      generateApiKeySec(value, testing?.getOverwriteTimestamp?.()),
     60_000
   );
 
@@ -47,7 +46,9 @@ export function useApiClient({
     ...retryableFetchParams,
     onRetry(arg) {
       cache.invalidate();
-      if (retryableFetchParams.onRetry) retryableFetchParams.onRetry(arg);
+      if (retryableFetchParams.onRetry) {
+        retryableFetchParams.onRetry(arg);
+      }
     },
   });
 
@@ -62,38 +63,54 @@ export function useApiClient({
     },
     fetch(req) {
       return retryableFetch(async () => {
-        let clone: any = req.clone() as any;
-        if (testing?.overwriteUri)
+        let clone = new Request(req);
+        if (testing?.overwriteUri) {
           clone = new Request(testing.overwriteUri, clone);
+        }
+
+        const resolvedAuth = (typeof auth === 'function' ? auth() : auth) ?? {};
+
+        if (sessionId) {
+          clone.headers.set('X-Session-Id', sessionId);
+        }
+
+        if (resolvedAuth.sec) {
+          clone.headers.set(
+            'X-Api-Key',
+            `Sec ${await cache.current(resolvedAuth.sec)}`
+          );
+        }
+
+        if (resolvedAuth.apiKey) {
+          clone.headers.set('X-Api-Key', resolvedAuth.apiKey);
+        }
 
-        const a = (typeof auth === 'function' ? auth() : auth) || {};
-        if (sessionId) clone.headers.set('X-Session-Id', sessionId);
-        if (a.sec)
-          clone.headers.set('X-Api-Key', `Sec ${await cache.current(a.sec)}`);
-        if (a.apiKey) clone.headers.set('X-Api-Key', a.apiKey);
-        if (a.tenantId) clone.headers.set('X-Team-Id', a.tenantId);
-        if (a.accessToken)
+        if (resolvedAuth.tenantId) {
+          clone.headers.set('X-Team-Id', resolvedAuth.tenantId);
+        }
+
+        if (resolvedAuth.accessToken) {
           clone.headers.set(
             'Authorization',
-            a.accessToken.startsWith('Bearer ')
-              ? a.accessToken
-              : `Bearer ${a.accessToken}`
+            resolvedAuth.accessToken.startsWith('Bearer ')
+              ? resolvedAuth.accessToken
+              : `Bearer ${resolvedAuth.accessToken}`
           );
+        }
+
         const additionalHeaders = h ? (typeof h === 'function' ? h() : h) : {};
         for (const key in additionalHeaders) {
           clone.headers.set(key, additionalHeaders[key]);
         }
 
-        if (trace['sentry-trace'])
-          clone.headers.set('sentry-trace', trace['sentry-trace']);
-        if (trace.baggage) clone.headers.set('baggage', trace.baggage);
+        applySentryTraceHeaders(clone.headers, trace);
 
         return clone;
       });
     },
   });
 
-  const sessionClient: ApiClient = client as any;
+  const sessionClient = client as ApiClient;
   sessionClient.sessionId = sessionId;
   return sessionClient;
 }

package/src/services/api/error.ts

@@ -0,0 +1,82 @@
+import { hasValue } from '@vrplatform/utils';
+import type { ServiceFetchResponse } from '../../service-client';
+
+type ApiErrorPayload = {
+  code: string;
+  message: string;
+  issues?: {
+    message: string;
+  }[];
+  context?: Record<string, unknown>;
+  stack?: string;
+};
+
+export class ApiClientError extends Error {
+  code: string;
+  issues: {
+    message: string;
+  }[];
+  context: Record<string, unknown>;
+
+  constructor(public error: ApiErrorPayload) {
+    const message =
+      error.message ||
+      [
+        error.code,
+        error.issues
+          ?.map((issue) =>
+            [issue.message, (issue as { path?: string[] }).path?.join('->')]
+              .filter(hasValue)
+              .join(' on ')
+          )
+          .join(', '),
+      ]
+        .filter(hasValue)
+        .join(': ');
+
+    super(message);
+    this.name = 'ApiClientError';
+    this.code = error.code;
+    this.issues = error.issues || [];
+    this.context = error.context || {};
+
+    if (error.stack) {
+      this.stack = error.stack;
+    }
+  }
+}
+
+export function throwIfError<T extends ServiceFetchResponse>(
+  response: T
+): NonNullable<T['data']>;
+export function throwIfError<T extends ServiceFetchResponse>(
+  response: Promise<T>
+): Promise<NonNullable<T['data']>>;
+export function throwIfError<T extends ServiceFetchResponse>(
+  response: Promise<T> | T
+): Promise<NonNullable<T['data']>> | NonNullable<T['data']> {
+  if (response instanceof Promise) {
+    return response.then((resolved) => {
+      if (resolved.response.status === 503) {
+        throw new ApiClientError({
+          code: 'SERVICE_UNAVAILABLE',
+          message: 'Worker resources exceeded.',
+        });
+      }
+
+      const error = resolved.error as ApiErrorPayload | undefined;
+      if (error) {
+        throw new ApiClientError(error);
+      }
+
+      return resolved.data as NonNullable<T['data']>;
+    });
+  }
+
+  const error = response.error as ApiErrorPayload | undefined;
+  if (error) {
+    throw new ApiClientError(error);
+  }
+
+  return response.data as NonNullable<T['data']>;
+}