@vrplatform/api 1.3.1-stage.2286 → 1.3.1-stage.2295

package/build/module/index.d.ts

@@ -1,14 +1,6 @@
-export * from './service-client';
-export type { AnalyticsApiClient } from './services/analytics/client';
-export { AnalyticsApiError, throwIfError as throwIfAnalyticsError, useAnalyticsApiClient, } from './services/analytics/client';
-export type { components as AnalyticsComponents, operations as AnalyticsOperations, paths as AnalyticsPaths, } from './services/analytics/generated/v1';
-export * from './services/api';
-export type { CacheApiClient } from './services/cache/client';
-export { CacheApiError, throwIfError as throwIfCacheError, useCacheApiClient, } from './services/cache/client';
-export type { components as CacheComponents, operations as CacheOperations, paths as CachePaths, } from './services/cache/generated/v1';
-export type { ControlPlaneApiClient, TenantRoutingResponse, } from './services/control-plane/client';
-export { ControlPlaneApiError, throwIfError as throwIfControlPlaneError, useControlPlaneApiClient, } from './services/control-plane/client';
-export type { components as ControlPlaneComponents, operations as ControlPlaneOperations, paths as ControlPlanePaths, } from './services/control-plane/generated/v1';
-export type { IngestApiClient } from './services/ingest/client';
-export { IngestApiError, throwIfError as throwIfIngestError, useIngestApiClient, } from './services/ingest/client';
-export type { components as IngestComponents, operations as IngestOperations, paths as IngestPaths, } from './services/ingest/generated/v1';
+import type { ApiClient } from './types';
+export * from './client';
+export * from './error';
+export type * from './generated/v1';
+export * from './types';
+export type VRPlatformApi = ApiClient;

package/build/module/index.js

@@ -1,7 +1,4 @@
-export * from './service-client';
-export { AnalyticsApiError, throwIfError as throwIfAnalyticsError, useAnalyticsApiClient, } from './services/analytics/client';
-export * from './services/api';
-export { CacheApiError, throwIfError as throwIfCacheError, useCacheApiClient, } from './services/cache/client';
-export { ControlPlaneApiError, throwIfError as throwIfControlPlaneError, useControlPlaneApiClient, } from './services/control-plane/client';
-export { IngestApiError, throwIfError as throwIfIngestError, useIngestApiClient, } from './services/ingest/client';
+export * from './client';
+export * from './error';
+export * from './types';
 //# sourceMappingURL=index.js.map

package/build/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AAGjC,OAAO,EACL,iBAAiB,EACjB,YAAY,IAAI,qBAAqB,EACrC,qBAAqB,GACtB,MAAM,6BAA6B,CAAC;AAMrC,cAAc,gBAAgB,CAAC;AAE/B,OAAO,EACL,aAAa,EACb,YAAY,IAAI,iBAAiB,EACjC,iBAAiB,GAClB,MAAM,yBAAyB,CAAC;AAUjC,OAAO,EACL,oBAAoB,EACpB,YAAY,IAAI,wBAAwB,EACxC,wBAAwB,GACzB,MAAM,iCAAiC,CAAC;AAOzC,OAAO,EACL,cAAc,EACd,YAAY,IAAI,kBAAkB,EAClC,kBAAkB,GACnB,MAAM,0BAA0B,CAAC","sourcesContent":["export * from './service-client';\nexport type { AnalyticsApiClient } from './services/analytics/client';\n\nexport {\n  AnalyticsApiError,\n  throwIfError as throwIfAnalyticsError,\n  useAnalyticsApiClient,\n} from './services/analytics/client';\nexport type {\n  components as AnalyticsComponents,\n  operations as AnalyticsOperations,\n  paths as AnalyticsPaths,\n} from './services/analytics/generated/v1';\nexport * from './services/api';\nexport type { CacheApiClient } from './services/cache/client';\nexport {\n  CacheApiError,\n  throwIfError as throwIfCacheError,\n  useCacheApiClient,\n} from './services/cache/client';\nexport type {\n  components as CacheComponents,\n  operations as CacheOperations,\n  paths as CachePaths,\n} from './services/cache/generated/v1';\nexport type {\n  ControlPlaneApiClient,\n  TenantRoutingResponse,\n} from './services/control-plane/client';\nexport {\n  ControlPlaneApiError,\n  throwIfError as throwIfControlPlaneError,\n  useControlPlaneApiClient,\n} from './services/control-plane/client';\nexport type {\n  components as ControlPlaneComponents,\n  operations as ControlPlaneOperations,\n  paths as ControlPlanePaths,\n} from './services/control-plane/generated/v1';\nexport type { IngestApiClient } from './services/ingest/client';\nexport {\n  IngestApiError,\n  throwIfError as throwIfIngestError,\n  useIngestApiClient,\n} from './services/ingest/client';\nexport type {\n  components as IngestComponents,\n  operations as IngestOperations,\n  paths as IngestPaths,\n} from './services/ingest/generated/v1';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AAExB,cAAc,SAAS,CAAC","sourcesContent":["import type { ApiClient } from './types';\n\nexport * from './client';\nexport * from './error';\nexport type * from './generated/v1';\nexport * from './types';\n\nexport type VRPlatformApi = ApiClient;\n"]}

package/build/module/tsconfig.esm.tsbuildinfo

@@ -1 +1 @@
-{"version":"7.0.0-dev.20251218.3","root":["../../src/cache.ts","../../src/index.ts","../../src/sec.ts","../../src/service-client.ts","../../src/analytics/client.ts","../../src/analytics/index.ts","../../src/analytics/types.ts","../../src/services/analytics/client.ts","../../src/services/analytics/generated/v1.ts","../../src/services/api/client.ts","../../src/services/api/error.ts","../../src/services/api/index.ts","../../src/services/api/types.ts","../../src/services/api/generated/v1.ts","../../src/services/cache/client.ts","../../src/services/cache/index.ts","../../src/services/cache/generated/v1.ts","../../src/services/control-plane/client.ts","../../src/services/control-plane/index.ts","../../src/services/control-plane/generated/v1.ts","../../src/services/ingest/client.ts","../../src/services/ingest/index.ts","../../src/services/ingest/generated/v1.ts"]}
+{"version":"7.0.0-dev.20251218.3","root":["../../src/cache.ts","../../src/client.ts","../../src/error.ts","../../src/index.ts","../../src/sec.ts","../../src/types.ts","../../src/generated/openapi-fetch.ts","../../src/generated/v1.ts"]}

package/build/module/types.d.ts

@@ -0,0 +1,61 @@
+import type createClient from 'openapi-fetch';
+import type { paths } from './generated/v1';
+export type ApiClientAuth = {
+    apiKey?: string;
+    sec?: string;
+    tenantId?: string;
+    accessToken?: string;
+};
+export type ApiClient = ReturnType<typeof createClient<paths>> & {
+    sessionId: string;
+};
+type ResponseCombinations = {
+    [Path in keyof paths]: {
+        [Method in keyof paths[Path]]: paths[Path][Method] extends never ? never : paths[Path][Method] extends {
+            responses: {
+                200: {
+                    content: {
+                        'application/json': unknown;
+                    };
+                };
+            };
+        } ? `${Method & string}:${Path}` : never;
+    }[keyof paths[Path]];
+}[keyof paths];
+export type ResponseData<T extends ResponseCombinations> = T extends `${infer Method}:${infer Path}` ? Path extends keyof paths ? Method extends keyof paths[Path] ? paths[Path][Method] extends {
+    responses: {
+        200: {
+            content: {
+                'application/json': infer Data;
+            };
+        };
+    };
+} ? Data : never : never : never : never;
+type RequestBodyCombinations = {
+    [Path in keyof paths]: {
+        [Method in keyof paths[Path]]: paths[Path][Method] extends never ? never : ExtractJsonRequestBody<paths[Path][Method]> extends never ? never : `${Method & string}:${Path}`;
+    }[keyof paths[Path]];
+}[keyof paths];
+type ExtractJsonRequestBody<T> = T extends {
+    requestBody?: infer RequestBody;
+} ? RequestBody extends {
+    content: {
+        'application/json': infer Data;
+    };
+} ? Data : never : never;
+export type RequestBody<T extends RequestBodyCombinations> = T extends `${infer Method}:${infer Path}` ? Path extends keyof paths ? Method extends keyof paths[Path] ? ExtractJsonRequestBody<paths[Path][Method]> : never : never : never;
+type RequestParamCombinations = {
+    [Path in keyof paths]: {
+        [Method in keyof paths[Path]]: paths[Path][Method] extends never ? never : paths[Path][Method] extends {
+            parameters: {
+                query?: Record<string, unknown>;
+            };
+        } ? `${Method & string}:${Path}` : never;
+    }[keyof paths[Path]];
+}[keyof paths];
+export type RequestQuery<T extends RequestParamCombinations> = T extends `${infer Method}:${infer Path}` ? Path extends keyof paths ? Method extends keyof paths[Path] ? paths[Path][Method] extends {
+    parameters: {
+        query?: infer Data;
+    };
+} ? Data : never : never : never : never;
+export {};

package/build/module/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"src/","sources":["types.ts"],"names":[],"mappings":"","sourcesContent":["import type createClient from 'openapi-fetch';\nimport type { paths } from './generated/v1';\n\nexport type ApiClientAuth = {\n  apiKey?: string;\n  sec?: string;\n  tenantId?: string;\n  accessToken?: string;\n};\nexport type ApiClient = ReturnType<typeof createClient<paths>> & {\n  sessionId: string;\n};\ntype ResponseCombinations = {\n  [Path in keyof paths]: {\n    [Method in keyof paths[Path]]: paths[Path][Method] extends never\n      ? never\n      : paths[Path][Method] extends {\n            responses: {\n              200: { content: { 'application/json': unknown } };\n            };\n          }\n        ? `${Method & string}:${Path}`\n        : never;\n  }[keyof paths[Path]];\n}[keyof paths];\n\nexport type ResponseData<T extends ResponseCombinations> =\n  T extends `${infer Method}:${infer Path}`\n    ? Path extends keyof paths\n      ? Method extends keyof paths[Path]\n        ? paths[Path][Method] extends {\n            responses: {\n              200: { content: { 'application/json': infer Data } };\n            };\n          }\n          ? Data\n          : never\n        : never\n      : never\n    : never;\n\ntype RequestBodyCombinations = {\n  [Path in keyof paths]: {\n    [Method in keyof paths[Path]]: paths[Path][Method] extends never\n      ? never\n      : ExtractJsonRequestBody<paths[Path][Method]> extends never\n        ? never\n        : `${Method & string}:${Path}`;\n  }[keyof paths[Path]];\n}[keyof paths];\n\ntype ExtractJsonRequestBody<T> = T extends {\n  requestBody?: infer RequestBody;\n}\n  ? RequestBody extends {\n      content: { 'application/json': infer Data };\n    }\n    ? Data\n    : never\n  : never;\n\nexport type RequestBody<T extends RequestBodyCombinations> =\n  T extends `${infer Method}:${infer Path}`\n    ? Path extends keyof paths\n      ? Method extends keyof paths[Path]\n        ? ExtractJsonRequestBody<paths[Path][Method]>\n        : never\n      : never\n    : never;\n\ntype RequestParamCombinations = {\n  [Path in keyof paths]: {\n    [Method in keyof paths[Path]]: paths[Path][Method] extends never\n      ? never\n      : paths[Path][Method] extends {\n            parameters: {\n              query?: Record<string, unknown>;\n            };\n          }\n        ? `${Method & string}:${Path}`\n        : never;\n  }[keyof paths[Path]];\n}[keyof paths];\n\nexport type RequestQuery<T extends RequestParamCombinations> =\n  T extends `${infer Method}:${infer Path}`\n    ? Path extends keyof paths\n      ? Method extends keyof paths[Path]\n        ? paths[Path][Method] extends {\n            parameters: {\n              query?: infer Data;\n            };\n          }\n          ? Data\n          : never\n        : never\n      : never\n    : never;\n"]}

package/package.json

@@ -3,43 +3,10 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.3.1-stage.2286",
+  "version": "1.3.1-stage.2295",
   "description": "",
   "main": "build/main/index.js",
   "module": "build/module/index.js",
-  "typings": "build/main/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./build/main/index.d.ts",
-      "require": "./build/main/index.js",
-      "import": "./build/module/index.js"
-    },
-    "./analytics": {
-      "types": "./build/main/analytics/index.d.ts",
-      "require": "./build/main/analytics/index.js",
-      "import": "./build/module/analytics/index.js"
-    },
-    "./api": {
-      "types": "./build/main/services/api/index.d.ts",
-      "require": "./build/main/services/api/index.js",
-      "import": "./build/module/services/api/index.js"
-    },
-    "./cache": {
-      "types": "./build/main/services/cache/index.d.ts",
-      "require": "./build/main/services/cache/index.js",
-      "import": "./build/module/services/cache/index.js"
-    },
-    "./control-plane": {
-      "types": "./build/main/services/control-plane/index.d.ts",
-      "require": "./build/main/services/control-plane/index.js",
-      "import": "./build/module/services/control-plane/index.js"
-    },
-    "./ingest": {
-      "types": "./build/main/services/ingest/index.d.ts",
-      "require": "./build/main/services/ingest/index.js",
-      "import": "./build/module/services/ingest/index.js"
-    }
-  },
   "scripts": {
     "pub": "bun pm version patch --no-git-tag-version && bun run npmpub",
     "npmpub": "bun run build && bunx vrp-publish && bunx vrp-deploy --prefix npmpub",
@@ -51,15 +18,15 @@
     "dev": "NODE_ENV=generator bun --watch ./generate.ts",
     "generate-client": "bun generate:schema && bun generate:client",
     "generate:schema": "NODE_ENV=generator bun ./openapi.ts",
-    "generate:client": "bun ./generate-clients.ts",
+    "generate:client": "bunx --bun openapi-typescript ./openapi.json -o ./src/generated/v1.ts",
     "tsgo": "tsgo --noEmit"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "openapi-fetch": "0.17.0",
-    "openapi-typescript-helpers": "^0.0.15",
-    "openapi-typescript": "^7.13.0"
+    "openapi-fetch": "0.15.0",
+    "openapi-typescript": "^7.10.1",
+    "openapi-typescript-helpers": "^0.0.15"
   },
   "peerDependencies": {
     "@vrplatform/utils": "*",
@@ -74,5 +41,6 @@
     "src",
     "!**/*.spec.*",
     "LICENSE"
-  ]
+  ],
+  "typings": "build/main/index.d.ts"
 }

package/src/client.ts

@@ -0,0 +1,99 @@
+import * as Sentry from '@sentry/core';
+import {
+  type RetryableFetchParams,
+  useRetryableFetch,
+} from '@vrplatform/utils';
+import createClient from 'openapi-fetch';
+import { useCache } from './cache';
+import type { paths } from './generated/v1';
+import { generateApiKeySec } from './sec';
+import type { ApiClient, ApiClientAuth } from './types';
+
+export function useApiClient({
+  baseUrl: base,
+  local,
+  auth,
+  sessionId: sid,
+  // headers: h,
+  testing,
+  headers: h,
+  ...retryableFetchParams
+}: {
+  attempts?: number;
+  auth?: ApiClientAuth | (() => ApiClientAuth);
+  baseUrl?: string;
+  sessionId?: string;
+  local?: boolean | number;
+  headers?: Record<string, string> | (() => Record<string, string>);
+  testing?: {
+    overwriteUri?: string;
+    getOverwriteTimestamp?: () => number | undefined;
+  };
+} & RetryableFetchParams) {
+  const baseUrl =
+    (local
+      ? `http://localhost:${typeof local === 'number' ? local : 8877}`
+      : base) || 'https://api.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?.()),
+    60_000
+  );
+
+  const retryableFetch = useRetryableFetch({
+    ...retryableFetchParams,
+    onRetry(arg) {
+      cache.invalidate();
+      if (retryableFetchParams.onRetry) retryableFetchParams.onRetry(arg);
+    },
+  });
+
+  const trace = Sentry.getTraceData();
+  const client = createClient<paths>({
+    baseUrl,
+    querySerializer: {
+      array: {
+        explode: false,
+        style: 'form',
+      },
+    },
+    fetch(req) {
+      return retryableFetch(async () => {
+        let clone: any = req.clone() as any;
+        if (testing?.overwriteUri)
+          clone = new Request(testing.overwriteUri, clone);
+
+        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)
+          clone.headers.set(
+            'Authorization',
+            a.accessToken.startsWith('Bearer ')
+              ? a.accessToken
+              : `Bearer ${a.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);
+
+        return clone;
+      });
+    },
+  });
+
+  const sessionClient: ApiClient = client as any;
+  sessionClient.sessionId = sessionId;
+  return sessionClient;
+}

package/src/error.ts

@@ -0,0 +1,71 @@
+import { hasValue } from '@vrplatform/utils';
+import type { FetchResponse } from './generated/openapi-fetch';
+
+type E = {
+  code: string;
+  message: string;
+  issues?: {
+    message: string;
+  }[];
+  context?: any;
+  stack?: any;
+};
+export class ApiClientError extends Error {
+  code: string;
+  issues: {
+    message: string;
+  }[];
+  context: any;
+  constructor(public error: E) {
+    const message =
+      error.message ||
+      [
+        error.code,
+        error.issues
+          ?.map((x) =>
+            [x.message, (x as any).path?.join('->')]
+              .filter(hasValue)
+              .join(' on ')
+          )
+          .join(', '),
+      ]
+        .filter(hasValue)
+        .join(': ');
+    super(message);
+
+    this.code = error.code;
+    this.issues = error.issues || [];
+    this.context = error.context || {};
+    if (error.stack) this.stack = error.stack;
+  }
+}
+export function throwIfError<T extends FetchResponse<any, any, any>>(
+  response: T
+): NonNullable<T['data']>;
+export function throwIfError<T extends FetchResponse<any, any, any>>(
+  response: Promise<T>
+): Promise<NonNullable<T['data']>>;
+export function throwIfError<T extends FetchResponse<any, any, any>>(
+  response: Promise<T> | T
+): Promise<NonNullable<T['data']>> | NonNullable<T['data']> {
+  if (response instanceof Promise) {
+    return response.then((response) => {
+      if (response.response.status === 503) {
+        throw new ApiClientError({
+          code: 'SERVICE_UNAVAILABLE',
+          message: 'Worker resources exceeded.',
+        });
+      }
+
+      const error: E = response.error;
+
+      if (error) throw new ApiClientError(error);
+      return response.data;
+    });
+  }
+
+  const error: E = response.error;
+
+  if (error) throw new ApiClientError(error);
+  return response.data;
+}