@automate.ax/integration-contracts 0.119.10 → 0.121.0

package/dist/hubspot/api.d.ts

@@ -0,0 +1,41 @@
+import { type Encodable } from "@automate.ax/codec";
+import * as z from "zod";
+export declare const HUBSPOT_VALUE_SCHEMA: z.ZodCustom<Encodable, Encodable>;
+interface HubSpotRequestOptions<TSchema extends z.ZodType> {
+    body?: Encodable;
+    method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
+    query?: Record<string, boolean | number | string | readonly string[] | null | undefined>;
+    responseSchema: TSchema;
+}
+/** Error returned by a rejected HubSpot API request. */
+export declare class HubSpotApiError extends Error {
+    readonly category?: string;
+    readonly correlationId?: string;
+    readonly details: Encodable;
+    readonly retryAfter?: string;
+    readonly status: number;
+    readonly subCategory?: string;
+    /**
+     * Creates an error from one rejected HubSpot response.
+     *
+     * @param status - HTTP response status.
+     * @param details - Codec-safe provider response.
+     * @param retryAfter - Provider retry timing, when present.
+     */
+    constructor(status: number, details: Encodable, retryAfter?: string);
+}
+/**
+ * Creates a minimal authenticated HubSpot REST client.
+ *
+ * @param secret - Stored OAuth or private-app token.
+ */
+export declare function getHubSpotApi(secret: unknown): {
+    /**
+     * Sends one request below HubSpot's API origin.
+     *
+     * @param path - Relative provider API path.
+     * @param options - Method, query, body, and response schema.
+     */
+    request<TSchema extends z.ZodType>(path: string, options: HubSpotRequestOptions<TSchema>): Promise<z.output<TSchema>>;
+};
+export {};

package/dist/hubspot/api.js

@@ -0,0 +1,116 @@
+import { isEncodable } from "@automate.ax/codec";
+import * as z from "zod";
+const HUBSPOT_API_ORIGIN = "https://api.hubapi.com/";
+const HUBSPOT_API_URL = new URL(HUBSPOT_API_ORIGIN);
+const HUBSPOT_SECRET_SCHEMA = z.object({ accessToken: z.string().min(1) });
+const HUBSPOT_ERROR_SCHEMA = z.looseObject({
+    category: z.string().optional(),
+    correlationId: z.string().optional(),
+    message: z.string().optional(),
+    subCategory: z.string().optional(),
+});
+export const HUBSPOT_VALUE_SCHEMA = z.custom(isEncodable, {
+    message: "Expected a codec-safe HubSpot value.",
+});
+/** Error returned by a rejected HubSpot API request. */
+export class HubSpotApiError extends Error {
+    category;
+    correlationId;
+    details;
+    retryAfter;
+    status;
+    subCategory;
+    /**
+     * Creates an error from one rejected HubSpot response.
+     *
+     * @param status - HTTP response status.
+     * @param details - Codec-safe provider response.
+     * @param retryAfter - Provider retry timing, when present.
+     */
+    constructor(status, details, retryAfter) {
+        const providerError = HUBSPOT_ERROR_SCHEMA.safeParse(details);
+        super(providerError.success && providerError.data.message
+            ? `HubSpot API request failed (${status}): ${providerError.data.message}`
+            : `HubSpot API request failed (${status}).`);
+        this.name = "HubSpotApiError";
+        this.category = providerError.success
+            ? providerError.data.category
+            : undefined;
+        this.correlationId = providerError.success
+            ? providerError.data.correlationId
+            : undefined;
+        this.details = details;
+        this.retryAfter = retryAfter;
+        this.status = status;
+        this.subCategory = providerError.success
+            ? providerError.data.subCategory
+            : undefined;
+    }
+}
+/**
+ * Creates a minimal authenticated HubSpot REST client.
+ *
+ * @param secret - Stored OAuth or private-app token.
+ */
+export function getHubSpotApi(secret) {
+    const { accessToken } = HUBSPOT_SECRET_SCHEMA.parse(secret);
+    return {
+        /**
+         * Sends one request below HubSpot's API origin.
+         *
+         * @param path - Relative provider API path.
+         * @param options - Method, query, body, and response schema.
+         */
+        async request(path, options) {
+            const normalizedPath = path.replace(/^\/+/, "");
+            if (!normalizedPath ||
+                normalizedPath.includes("://") ||
+                normalizedPath.includes("\\")) {
+                throw new TypeError("HubSpot API paths must be relative.");
+            }
+            const url = new URL(normalizedPath, HUBSPOT_API_ORIGIN);
+            if (url.origin !== HUBSPOT_API_URL.origin) {
+                throw new TypeError("HubSpot API paths must remain on api.hubapi.com.");
+            }
+            for (const [key, value] of Object.entries(options.query ?? {})) {
+                if (value == null)
+                    continue;
+                url.searchParams.set(key, Array.isArray(value) ? value.join(",") : String(value));
+            }
+            const headers = new Headers({
+                Accept: "application/json",
+                Authorization: `Bearer ${accessToken}`,
+            });
+            if (options.body !== undefined) {
+                headers.set("Content-Type", "application/json");
+            }
+            const response = await fetch(url, {
+                body: options.body === undefined ? undefined : JSON.stringify(options.body),
+                headers,
+                method: options.method ?? "GET",
+            });
+            const text = await response.text();
+            const parsed = text ? parseJson(text) : undefined;
+            if (response.ok && !text)
+                return options.responseSchema.parse(undefined);
+            const encodable = HUBSPOT_VALUE_SCHEMA.safeParse(parsed);
+            if (!response.ok || !encodable.success) {
+                throw new HubSpotApiError(response.status, encodable.success ? encodable.data : { response: text }, response.headers.get("Retry-After") ?? undefined);
+            }
+            return options.responseSchema.parse(parsed);
+        },
+    };
+}
+/**
+ * Parses a response body while preserving non-JSON error text.
+ *
+ * @param value - Raw response body.
+ */
+function parseJson(value) {
+    try {
+        return JSON.parse(value);
+    }
+    catch {
+        return { response: value };
+    }
+}