truckaurbus 0.1.0

package/README.md

@@ -0,0 +1,18 @@
+# truckaurbus (TypeScript)
+
+```
+npm install truckaurbus
+```
+
+```ts
+import { Truckaurbus } from "truckaurbus";
+
+const tab = new Truckaurbus("tab_live_...");
+const { hits } = await tab.variants.search({ q: "12 tyre tipper", price_max: 4_000_000, sort: "price_asc" });
+const sheet = await tab.variants.get(String(hits[0].slug));
+const dealers = await tab.dealers.near("442001", { km: 50, brand: "tata-motors" });
+await tab.leads.create({ kind: "quote", buyer_name: "A Buyer", buyer_phone: "9876543210", vehicle_ref: String(sheet.slug), consent: true });
+console.log(tab.rateLimit);
+```
+
+Works in Node 18+ and the browser (use a server-side key; never ship a key to a browser). Prices carry a `price_kind` (maker, dealer, reported, estimate); say which when you show them. Free-tier keys must attribute the data ("Data by Truckaurbus"). Docs: https://docs.truckaurbus.com/developers/

package/dist/index.d.ts

@@ -0,0 +1,83 @@
+/** Truckaurbus API v1 client. Every method returns the API's JSON. Errors throw TruckaurbusError with the status and detail.
+ *  Free-tier keys must attribute the data ("Data by Truckaurbus") wherever it is shown. */
+export declare class TruckaurbusError extends Error {
+    readonly status: number;
+    readonly detail: string;
+    readonly requestId?: string;
+    constructor(status: number, detail: string, requestId?: string);
+}
+export type SearchFilters = {
+    q?: string;
+    vehicle_class?: string;
+    manufacturer?: string;
+    body_type?: string;
+    fuel?: string;
+    axle_config?: string;
+    gvw_min?: number;
+    gvw_max?: number;
+    price_min?: number;
+    price_max?: number;
+    power_min?: number;
+    sort?: "price_asc" | "price_desc" | "gvw_asc" | "gvw_desc" | "power_desc" | "newest";
+    limit?: number;
+    offset?: number;
+};
+export type LeadInput = {
+    kind: "callback" | "quote" | "finance" | "insurance";
+    buyer_name: string;
+    buyer_phone: string;
+    buyer_pin?: string;
+    vehicle_ref?: string;
+    intent?: "now" | "soon" | "exploring";
+    notes?: string;
+    consent: true;
+};
+type Fetch = typeof fetch;
+export declare class Truckaurbus {
+    readonly baseUrl: string;
+    lastRequestId?: string;
+    rateLimit: Record<string, string>;
+    private readonly fetchImpl;
+    private readonly apiKey;
+    constructor(apiKey: string, options?: {
+        baseUrl?: string;
+        fetch?: Fetch;
+    });
+    readonly variants: {
+        search: (filters?: SearchFilters) => Promise<{
+            hits: Record<string, unknown>[];
+            total: number;
+            facets: Record<string, Record<string, number>>;
+        }>;
+        get: (slug: string) => Promise<Record<string, unknown>>;
+        ratings: (slug: string) => Promise<Record<string, unknown>>;
+    };
+    readonly dealers: {
+        near: (pin: string, options?: {
+            km?: number;
+            kind?: string;
+            brand?: string;
+        }) => Promise<Record<string, unknown>[]>;
+    };
+    readonly pincodes: {
+        get: (pin: string) => Promise<Record<string, unknown>>;
+    };
+    readonly leads: {
+        create: (lead: LeadInput) => Promise<Record<string, unknown>>;
+    };
+    readonly webhooks: {
+        list: () => Promise<Record<string, unknown>[]>;
+        create: (url: string, events: string[]) => Promise<Record<string, unknown>>;
+        delete: (id: number) => Promise<{
+            deleted: boolean;
+        }>;
+    };
+    manufacturers(): Promise<Record<string, unknown>[]>;
+    exportVariantsCsv(): Promise<string>;
+    private headers;
+    private note;
+    private detail;
+    private get;
+    private request;
+}
+export {};

package/dist/index.js

@@ -0,0 +1,90 @@
+/** Truckaurbus API v1 client. Every method returns the API's JSON. Errors throw TruckaurbusError with the status and detail.
+ *  Free-tier keys must attribute the data ("Data by Truckaurbus") wherever it is shown. */
+export class TruckaurbusError extends Error {
+    status;
+    detail;
+    requestId;
+    constructor(status, detail, requestId) {
+        super(`${status}: ${detail}`);
+        this.status = status;
+        this.detail = detail;
+        this.requestId = requestId;
+    }
+}
+export class Truckaurbus {
+    baseUrl;
+    lastRequestId;
+    rateLimit = {};
+    fetchImpl;
+    apiKey;
+    constructor(apiKey, options = {}) {
+        if (!apiKey)
+            throw new Error("an API key is required (create one on your account page at truckaurbus.com)");
+        this.apiKey = apiKey;
+        this.baseUrl = (options.baseUrl ?? "https://api.truckaurbus.com/v1").replace(/\/+$/, "");
+        this.fetchImpl = options.fetch ?? fetch;
+    }
+    variants = {
+        search: (filters = {}) => this.get("/variants", filters),
+        get: (slug) => this.get(`/variants/${encodeURIComponent(slug)}`),
+        ratings: (slug) => this.get(`/variants/${encodeURIComponent(slug)}/ratings`),
+    };
+    dealers = { near: (pin, options = {}) => this.get("/dealers", { pin, ...options }) };
+    pincodes = { get: (pin) => this.get(`/pincodes/${encodeURIComponent(pin)}`) };
+    leads = {
+        create: (lead) => {
+            if (!lead.consent)
+                throw new Error("consent is required before a lead is recorded");
+            return this.request("POST", "/leads", undefined, { ...lead, wants_finance: lead.kind === "finance", wants_insurance: lead.kind === "insurance", source: "sdk-ts" });
+        },
+    };
+    webhooks = {
+        list: () => this.get("/webhooks"),
+        create: (url, events) => this.request("POST", "/webhooks", undefined, { url, events }),
+        delete: (id) => this.request("DELETE", `/webhooks/${id}`),
+    };
+    manufacturers() {
+        return this.get("/manufacturers");
+    }
+    async exportVariantsCsv() {
+        const res = await this.fetchImpl(`${this.baseUrl}/export/variants.csv`, { headers: this.headers() });
+        this.note(res);
+        if (!res.ok)
+            throw new TruckaurbusError(res.status, await this.detail(res), this.lastRequestId);
+        return res.text();
+    }
+    headers() {
+        return { Authorization: `Bearer ${this.apiKey}`, "User-Agent": "truckaurbus-ts/0.1.0" };
+    }
+    note(res) {
+        this.lastRequestId = res.headers.get("x-request-id") ?? undefined;
+        this.rateLimit = {};
+        res.headers.forEach((v, k) => {
+            if (k.toLowerCase().startsWith("x-ratelimit-"))
+                this.rateLimit[k.toLowerCase().slice("x-ratelimit-".length)] = v;
+        });
+    }
+    async detail(res) {
+        try {
+            const data = (await res.json());
+            return data.detail ?? `${res.status}`;
+        }
+        catch {
+            return `${res.status}`;
+        }
+    }
+    get(path, params) {
+        return this.request("GET", path, params);
+    }
+    async request(method, path, params, body) {
+        const url = new URL(`${this.baseUrl}${path}`);
+        for (const [k, v] of Object.entries(params ?? {}))
+            if (v !== undefined && v !== null && v !== "")
+                url.searchParams.set(k, String(v));
+        const res = await this.fetchImpl(url.toString(), { method, headers: { ...this.headers(), ...(body ? { "content-type": "application/json" } : {}) }, body: body ? JSON.stringify(body) : undefined });
+        this.note(res);
+        if (!res.ok)
+            throw new TruckaurbusError(res.status, await this.detail(res), this.lastRequestId);
+        return (await res.json());
+    }
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "truckaurbus",
+  "version": "0.1.0",
+  "description": "TypeScript client for the Truckaurbus API v1: Indian commercial vehicle specs, prices, ratings, dealers and leads",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "node --experimental-strip-types --test test/*.test.ts",
+    "typecheck": "tsc --noEmit -p .",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.6.0",
+    "@types/node": "^22.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/truckaurbus/truckaurbus-services.git",
+    "directory": "packages/tab-sdk-ts"
+  },
+  "homepage": "https://docs.truckaurbus.com/developers/",
+  "keywords": [
+    "truckaurbus",
+    "commercial vehicles",
+    "india",
+    "trucks",
+    "buses",
+    "api",
+    "sdk"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}