@findatruck/aggregator-client 1.1.0

package/dist/index.cjs

@@ -0,0 +1,160 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AggregatorClient: () => AggregatorClient,
+  AggregatorClientError: () => AggregatorClientError,
+  NewLoginRequestSchema: () => import_shared_schemas2.NewLoginRequestSchema,
+  NewLoginResponseFailureSchema: () => import_shared_schemas2.NewLoginResponseFailureSchema,
+  NewLoginResponseSchema: () => import_shared_schemas2.NewLoginResponseSchema,
+  NewLoginResponseSuccessSchema: () => import_shared_schemas2.NewLoginResponseSuccessSchema,
+  ValidatePasswordRequestSchema: () => import_shared_schemas2.ValidatePasswordRequestSchema,
+  ValidatePasswordResponseSchema: () => import_shared_schemas2.ValidatePasswordResponseSchema,
+  endpoints: () => endpoints
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/endpoints.ts
+var import_shared_schemas = require("@findatruck/shared-schemas");
+var endpoints = {
+  newLogin: {
+    path: "/provider-account/new-login",
+    method: "POST",
+    requestSchema: import_shared_schemas.NewLoginRequestSchema,
+    responseSchema: import_shared_schemas.NewLoginResponseSchema
+  },
+  validatePassword: {
+    path: "/provider-account/validate-password",
+    method: "POST",
+    requestSchema: import_shared_schemas.ValidatePasswordRequestSchema,
+    responseSchema: import_shared_schemas.ValidatePasswordResponseSchema
+  }
+};
+
+// src/types.ts
+var AggregatorClientError = class extends Error {
+  constructor(message, endpoint, status, responseBody) {
+    super(message);
+    this.endpoint = endpoint;
+    this.status = status;
+    this.responseBody = responseBody;
+    this.name = "AggregatorClientError";
+  }
+};
+
+// src/client.ts
+var AggregatorClient = class {
+  constructor(config) {
+    this.baseUrl = config.baseUrl.replace(/\/$/, "");
+    this.workerSecret = config.workerSecret;
+  }
+  /**
+   * Initiates a new login for a provider account.
+   * This triggers the aggregator to scrape the provider and sync driver data.
+   */
+  async newLogin(request) {
+    const endpoint = endpoints.newLogin;
+    const parseResult = endpoint.requestSchema.safeParse(request);
+    if (!parseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid request: ${parseResult.error.message}`,
+        endpoint.path
+      );
+    }
+    const response = await this.makeRequest(endpoint.path, endpoint.method, request);
+    const responseParseResult = endpoint.responseSchema.safeParse(response);
+    if (!responseParseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid response from aggregator: ${responseParseResult.error.message}`,
+        endpoint.path,
+        void 0,
+        response
+      );
+    }
+    return responseParseResult.data;
+  }
+  /**
+   * Validates a password for an existing provider account.
+   * Returns whether the password is valid and the associated driver IDs.
+   */
+  async validatePassword(request) {
+    const endpoint = endpoints.validatePassword;
+    const parseResult = endpoint.requestSchema.safeParse(request);
+    if (!parseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid request: ${parseResult.error.message}`,
+        endpoint.path
+      );
+    }
+    const response = await this.makeRequest(endpoint.path, endpoint.method, request);
+    const responseParseResult = endpoint.responseSchema.safeParse(response);
+    if (!responseParseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid response from aggregator: ${responseParseResult.error.message}`,
+        endpoint.path,
+        void 0,
+        response
+      );
+    }
+    return responseParseResult.data;
+  }
+  async makeRequest(path, method, body) {
+    const url = `${this.baseUrl}${path}`;
+    const response = await fetch(url, {
+      method,
+      headers: {
+        "Content-Type": "application/json",
+        "Authorization": `Bearer ${this.workerSecret}`
+      },
+      body: JSON.stringify(body)
+    });
+    if (!response.ok) {
+      let responseBody;
+      try {
+        responseBody = await response.json();
+      } catch {
+        responseBody = await response.text();
+      }
+      throw new AggregatorClientError(
+        `Request to ${path} failed with status ${response.status}`,
+        path,
+        response.status,
+        responseBody
+      );
+    }
+    return response.json();
+  }
+};
+
+// src/index.ts
+var import_shared_schemas2 = require("@findatruck/shared-schemas");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AggregatorClient,
+  AggregatorClientError,
+  NewLoginRequestSchema,
+  NewLoginResponseFailureSchema,
+  NewLoginResponseSchema,
+  NewLoginResponseSuccessSchema,
+  ValidatePasswordRequestSchema,
+  ValidatePasswordResponseSchema,
+  endpoints
+});

package/dist/index.d.cts

@@ -0,0 +1,122 @@
+import { NewLoginRequest, NewLoginResponse, ValidatePasswordRequest, ValidatePasswordResponse } from '@findatruck/shared-schemas';
+export { NewLoginRequest, NewLoginRequestSchema, NewLoginResponse, NewLoginResponseFailure, NewLoginResponseFailureSchema, NewLoginResponseSchema, NewLoginResponseSuccess, NewLoginResponseSuccessSchema, ValidatePasswordRequest, ValidatePasswordRequestSchema, ValidatePasswordResponse, ValidatePasswordResponseSchema } from '@findatruck/shared-schemas';
+import { z } from 'zod';
+
+/**
+ * Configuration for the AggregatorClient
+ */
+interface AggregatorClientConfig {
+    /** Base URL of the aggregator service (e.g., "https://aggregator.example.com") */
+    baseUrl: string;
+    /** Worker secret for authentication */
+    workerSecret: string;
+}
+/**
+ * Error thrown by the AggregatorClient when requests fail
+ */
+declare class AggregatorClientError extends Error {
+    readonly endpoint: string;
+    readonly status?: number | undefined;
+    readonly responseBody?: unknown | undefined;
+    constructor(message: string, endpoint: string, status?: number | undefined, responseBody?: unknown | undefined);
+}
+
+/**
+ * Typed HTTP client for calling Aggregator endpoints from Convex actions.
+ *
+ * @example
+ * ```typescript
+ * const client = new AggregatorClient({
+ *   baseUrl: process.env.AGGREGATOR_URL,
+ *   workerSecret: process.env.WORKER_SECRET,
+ * });
+ *
+ * const result = await client.newLogin({
+ *   providerUrl: 'https://provider.example.com',
+ *   username: 'user@example.com',
+ *   encryptedPassword: '...',
+ *   ownerId: '...',
+ *   externalProviderAccountId: '...',
+ *   convexUpdateUrl: '...',
+ * });
+ * ```
+ */
+declare class AggregatorClient {
+    private readonly baseUrl;
+    private readonly workerSecret;
+    constructor(config: AggregatorClientConfig);
+    /**
+     * Initiates a new login for a provider account.
+     * This triggers the aggregator to scrape the provider and sync driver data.
+     */
+    newLogin(request: NewLoginRequest): Promise<NewLoginResponse>;
+    /**
+     * Validates a password for an existing provider account.
+     * Returns whether the password is valid and the associated driver IDs.
+     */
+    validatePassword(request: ValidatePasswordRequest): Promise<ValidatePasswordResponse>;
+    private makeRequest;
+}
+
+/**
+ * Endpoint definition with path, method, and validation schemas
+ */
+interface EndpointDefinition<TRequest extends z.ZodType, TResponse extends z.ZodType> {
+    path: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    requestSchema: TRequest;
+    responseSchema: TResponse;
+}
+/**
+ * Single source of truth for all Aggregator HTTP endpoints
+ * consumed from Convex.
+ */
+declare const endpoints: {
+    readonly newLogin: {
+        readonly path: "/provider-account/new-login";
+        readonly method: "POST";
+        readonly requestSchema: z.ZodObject<{
+            providerUrl: z.ZodString;
+            username: z.ZodString;
+            encryptedPassword: z.ZodString;
+            ownerId: z.ZodString;
+            externalProviderAccountId: z.ZodString;
+            convexUpdateUrl: z.ZodString;
+        }, z.core.$strip>;
+        readonly responseSchema: z.ZodUnion<readonly [z.ZodObject<{
+            success: z.ZodOptional<z.ZodBoolean>;
+            message: z.ZodString;
+            user: z.ZodObject<{
+                id: z.ZodString;
+                username: z.ZodString;
+                created_at: z.ZodCoercedDate<unknown>;
+                updated_at: z.ZodCoercedDate<unknown>;
+            }, z.core.$strip>;
+            provider: z.ZodObject<{
+                name: z.ZodString;
+                url: z.ZodString;
+            }, z.core.$strip>;
+            driverIds: z.ZodArray<z.ZodString>;
+            organizationId: z.ZodOptional<z.ZodString>;
+            honkUserId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            success: z.ZodOptional<z.ZodBoolean>;
+            error: z.ZodString;
+        }, z.core.$strip>]>;
+    };
+    readonly validatePassword: {
+        readonly path: "/provider-account/validate-password";
+        readonly method: "POST";
+        readonly requestSchema: z.ZodObject<{
+            providerAccountId: z.ZodString;
+            encryptedPassword: z.ZodString;
+        }, z.core.$strip>;
+        readonly responseSchema: z.ZodObject<{
+            isValid: z.ZodBoolean;
+            driverIds: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>;
+    };
+};
+type EndpointName = keyof typeof endpoints;
+
+export { AggregatorClient, type AggregatorClientConfig, AggregatorClientError, type EndpointDefinition, type EndpointName, endpoints };

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+import { NewLoginRequest, NewLoginResponse, ValidatePasswordRequest, ValidatePasswordResponse } from '@findatruck/shared-schemas';
+export { NewLoginRequest, NewLoginRequestSchema, NewLoginResponse, NewLoginResponseFailure, NewLoginResponseFailureSchema, NewLoginResponseSchema, NewLoginResponseSuccess, NewLoginResponseSuccessSchema, ValidatePasswordRequest, ValidatePasswordRequestSchema, ValidatePasswordResponse, ValidatePasswordResponseSchema } from '@findatruck/shared-schemas';
+import { z } from 'zod';
+
+/**
+ * Configuration for the AggregatorClient
+ */
+interface AggregatorClientConfig {
+    /** Base URL of the aggregator service (e.g., "https://aggregator.example.com") */
+    baseUrl: string;
+    /** Worker secret for authentication */
+    workerSecret: string;
+}
+/**
+ * Error thrown by the AggregatorClient when requests fail
+ */
+declare class AggregatorClientError extends Error {
+    readonly endpoint: string;
+    readonly status?: number | undefined;
+    readonly responseBody?: unknown | undefined;
+    constructor(message: string, endpoint: string, status?: number | undefined, responseBody?: unknown | undefined);
+}
+
+/**
+ * Typed HTTP client for calling Aggregator endpoints from Convex actions.
+ *
+ * @example
+ * ```typescript
+ * const client = new AggregatorClient({
+ *   baseUrl: process.env.AGGREGATOR_URL,
+ *   workerSecret: process.env.WORKER_SECRET,
+ * });
+ *
+ * const result = await client.newLogin({
+ *   providerUrl: 'https://provider.example.com',
+ *   username: 'user@example.com',
+ *   encryptedPassword: '...',
+ *   ownerId: '...',
+ *   externalProviderAccountId: '...',
+ *   convexUpdateUrl: '...',
+ * });
+ * ```
+ */
+declare class AggregatorClient {
+    private readonly baseUrl;
+    private readonly workerSecret;
+    constructor(config: AggregatorClientConfig);
+    /**
+     * Initiates a new login for a provider account.
+     * This triggers the aggregator to scrape the provider and sync driver data.
+     */
+    newLogin(request: NewLoginRequest): Promise<NewLoginResponse>;
+    /**
+     * Validates a password for an existing provider account.
+     * Returns whether the password is valid and the associated driver IDs.
+     */
+    validatePassword(request: ValidatePasswordRequest): Promise<ValidatePasswordResponse>;
+    private makeRequest;
+}
+
+/**
+ * Endpoint definition with path, method, and validation schemas
+ */
+interface EndpointDefinition<TRequest extends z.ZodType, TResponse extends z.ZodType> {
+    path: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    requestSchema: TRequest;
+    responseSchema: TResponse;
+}
+/**
+ * Single source of truth for all Aggregator HTTP endpoints
+ * consumed from Convex.
+ */
+declare const endpoints: {
+    readonly newLogin: {
+        readonly path: "/provider-account/new-login";
+        readonly method: "POST";
+        readonly requestSchema: z.ZodObject<{
+            providerUrl: z.ZodString;
+            username: z.ZodString;
+            encryptedPassword: z.ZodString;
+            ownerId: z.ZodString;
+            externalProviderAccountId: z.ZodString;
+            convexUpdateUrl: z.ZodString;
+        }, z.core.$strip>;
+        readonly responseSchema: z.ZodUnion<readonly [z.ZodObject<{
+            success: z.ZodOptional<z.ZodBoolean>;
+            message: z.ZodString;
+            user: z.ZodObject<{
+                id: z.ZodString;
+                username: z.ZodString;
+                created_at: z.ZodCoercedDate<unknown>;
+                updated_at: z.ZodCoercedDate<unknown>;
+            }, z.core.$strip>;
+            provider: z.ZodObject<{
+                name: z.ZodString;
+                url: z.ZodString;
+            }, z.core.$strip>;
+            driverIds: z.ZodArray<z.ZodString>;
+            organizationId: z.ZodOptional<z.ZodString>;
+            honkUserId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            success: z.ZodOptional<z.ZodBoolean>;
+            error: z.ZodString;
+        }, z.core.$strip>]>;
+    };
+    readonly validatePassword: {
+        readonly path: "/provider-account/validate-password";
+        readonly method: "POST";
+        readonly requestSchema: z.ZodObject<{
+            providerAccountId: z.ZodString;
+            encryptedPassword: z.ZodString;
+        }, z.core.$strip>;
+        readonly responseSchema: z.ZodObject<{
+            isValid: z.ZodBoolean;
+            driverIds: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>;
+    };
+};
+type EndpointName = keyof typeof endpoints;
+
+export { AggregatorClient, type AggregatorClientConfig, AggregatorClientError, type EndpointDefinition, type EndpointName, endpoints };

package/dist/index.js

@@ -0,0 +1,137 @@
+// src/endpoints.ts
+import {
+  NewLoginRequestSchema,
+  NewLoginResponseSchema,
+  ValidatePasswordRequestSchema,
+  ValidatePasswordResponseSchema
+} from "@findatruck/shared-schemas";
+var endpoints = {
+  newLogin: {
+    path: "/provider-account/new-login",
+    method: "POST",
+    requestSchema: NewLoginRequestSchema,
+    responseSchema: NewLoginResponseSchema
+  },
+  validatePassword: {
+    path: "/provider-account/validate-password",
+    method: "POST",
+    requestSchema: ValidatePasswordRequestSchema,
+    responseSchema: ValidatePasswordResponseSchema
+  }
+};
+
+// src/types.ts
+var AggregatorClientError = class extends Error {
+  constructor(message, endpoint, status, responseBody) {
+    super(message);
+    this.endpoint = endpoint;
+    this.status = status;
+    this.responseBody = responseBody;
+    this.name = "AggregatorClientError";
+  }
+};
+
+// src/client.ts
+var AggregatorClient = class {
+  constructor(config) {
+    this.baseUrl = config.baseUrl.replace(/\/$/, "");
+    this.workerSecret = config.workerSecret;
+  }
+  /**
+   * Initiates a new login for a provider account.
+   * This triggers the aggregator to scrape the provider and sync driver data.
+   */
+  async newLogin(request) {
+    const endpoint = endpoints.newLogin;
+    const parseResult = endpoint.requestSchema.safeParse(request);
+    if (!parseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid request: ${parseResult.error.message}`,
+        endpoint.path
+      );
+    }
+    const response = await this.makeRequest(endpoint.path, endpoint.method, request);
+    const responseParseResult = endpoint.responseSchema.safeParse(response);
+    if (!responseParseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid response from aggregator: ${responseParseResult.error.message}`,
+        endpoint.path,
+        void 0,
+        response
+      );
+    }
+    return responseParseResult.data;
+  }
+  /**
+   * Validates a password for an existing provider account.
+   * Returns whether the password is valid and the associated driver IDs.
+   */
+  async validatePassword(request) {
+    const endpoint = endpoints.validatePassword;
+    const parseResult = endpoint.requestSchema.safeParse(request);
+    if (!parseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid request: ${parseResult.error.message}`,
+        endpoint.path
+      );
+    }
+    const response = await this.makeRequest(endpoint.path, endpoint.method, request);
+    const responseParseResult = endpoint.responseSchema.safeParse(response);
+    if (!responseParseResult.success) {
+      throw new AggregatorClientError(
+        `Invalid response from aggregator: ${responseParseResult.error.message}`,
+        endpoint.path,
+        void 0,
+        response
+      );
+    }
+    return responseParseResult.data;
+  }
+  async makeRequest(path, method, body) {
+    const url = `${this.baseUrl}${path}`;
+    const response = await fetch(url, {
+      method,
+      headers: {
+        "Content-Type": "application/json",
+        "Authorization": `Bearer ${this.workerSecret}`
+      },
+      body: JSON.stringify(body)
+    });
+    if (!response.ok) {
+      let responseBody;
+      try {
+        responseBody = await response.json();
+      } catch {
+        responseBody = await response.text();
+      }
+      throw new AggregatorClientError(
+        `Request to ${path} failed with status ${response.status}`,
+        path,
+        response.status,
+        responseBody
+      );
+    }
+    return response.json();
+  }
+};
+
+// src/index.ts
+import {
+  NewLoginRequestSchema as NewLoginRequestSchema2,
+  NewLoginResponseSchema as NewLoginResponseSchema2,
+  NewLoginResponseSuccessSchema,
+  NewLoginResponseFailureSchema,
+  ValidatePasswordRequestSchema as ValidatePasswordRequestSchema2,
+  ValidatePasswordResponseSchema as ValidatePasswordResponseSchema2
+} from "@findatruck/shared-schemas";
+export {
+  AggregatorClient,
+  AggregatorClientError,
+  NewLoginRequestSchema2 as NewLoginRequestSchema,
+  NewLoginResponseFailureSchema,
+  NewLoginResponseSchema2 as NewLoginResponseSchema,
+  NewLoginResponseSuccessSchema,
+  ValidatePasswordRequestSchema2 as ValidatePasswordRequestSchema,
+  ValidatePasswordResponseSchema2 as ValidatePasswordResponseSchema,
+  endpoints
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@findatruck/aggregator-client",
+  "version": "1.1.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup src/index.ts --dts --format esm,cjs --out-dir dist --clean",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@findatruck/shared-schemas": "^2.9.0"
+  },
+  "peerDependencies": {
+    "zod": "^4.1.11"
+  },
+  "devDependencies": {
+    "@types/node": "^24.7.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4",
+    "zod": "^4.1.11"
+  }
+}