@hubspot/app-connect-sdk 1.0.0-alpha.4 → 1.0.0-alpha.7

package/dist/server/api-client-core/pagination.js

@@ -0,0 +1,103 @@
+//#region src/server/api-client-core/pagination.ts
+/**
+* Helpers for automatically traversing HubSpot's cursor-based paginated
+* endpoints. Each method wraps an {@link Operation} that returns a
+* {@link PaginatedResponse} and follows the `paging.next.after` cursor
+* until all pages have been fetched.
+*/
+const pagination = {
+	/**
+	* Collects every item across all pages into a single array.
+	*
+	* Repeatedly sends the given operation, advancing the `after` cursor
+	* each time, until there are no more pages or the optional `limit` is
+	* reached. Returns a {@link SyntheticOperation} that resolves to the
+	* full array.
+	*
+	* @typeParam TOutput - The paginated response type returned by the API.
+	* @param operation - A paginated API operation to iterate over.
+	* @param options - Optional settings.
+	* @param options.limit - Maximum number of items to collect. Pagination
+	*   stops as soon as this count is reached.
+	* @returns A synthetic operation that resolves to an array of all collected items.
+	*
+	* @example
+	* ```ts
+	* const allContacts = await client.send(
+	*   pagination.getAll(crmContacts.basic.getContacts()),
+	* );
+	* ```
+	*/
+	getAll(operation, options) {
+		return {
+			_kind: "synthetic",
+			async run(ctx) {
+				const items = [];
+				const limit = options?.limit;
+				let after;
+				do {
+					const op = {
+						...operation,
+						queryParams: {
+							...operation.queryParams,
+							after
+						}
+					};
+					const page = await ctx.client.send(op);
+					const results = page.results;
+					if (limit !== void 0 && items.length + results.length >= limit) {
+						items.push(...results.slice(0, limit - items.length));
+						break;
+					}
+					items.push(...results);
+					after = page.paging?.next?.after;
+				} while (after);
+				return items;
+			}
+		};
+	},
+	/**
+	* Streams items page-by-page via an async generator, yielding each item
+	* as it arrives rather than buffering the entire result set in memory.
+	*
+	* Useful for very large datasets where holding all items in memory is
+	* impractical.
+	*
+	* @typeParam TOutput - The paginated response type returned by the API.
+	* @param operation - A paginated API operation to iterate over.
+	* @returns A synthetic streaming operation that yields items one at a time.
+	*
+	* @example
+	* ```ts
+	* for await (const contact of client.send(
+	*   pagination.getAllStream(crmContacts.basic.getContacts()),
+	* )) {
+	*   console.log(contact.id);
+	* }
+	* ```
+	*/
+	getAllStream(operation) {
+		return {
+			_kind: "syntheticStreaming",
+			async *run(ctx) {
+				let after;
+				do {
+					const op = {
+						...operation,
+						queryParams: {
+							...operation.queryParams,
+							after
+						}
+					};
+					const page = await ctx.client.send(op);
+					yield* page.results;
+					after = page.paging?.next?.after;
+				} while (after);
+			}
+		};
+	}
+};
+//#endregion
+export { pagination };
+
+//# sourceMappingURL=pagination.js.map

package/dist/server/api-client-core/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","names":[],"sources":["../../../src/server/api-client-core/pagination.ts"],"sourcesContent":["import type {\n  Operation,\n  PaginatedItem,\n  PaginatedResponse,\n  SyntheticOperation,\n  SyntheticStreamingOperation,\n} from './types.ts';\n\n/**\n * Helpers for automatically traversing HubSpot's cursor-based paginated\n * endpoints. Each method wraps an {@link Operation} that returns a\n * {@link PaginatedResponse} and follows the `paging.next.after` cursor\n * until all pages have been fetched.\n */\nexport const pagination = {\n  /**\n   * Collects every item across all pages into a single array.\n   *\n   * Repeatedly sends the given operation, advancing the `after` cursor\n   * each time, until there are no more pages or the optional `limit` is\n   * reached. Returns a {@link SyntheticOperation} that resolves to the\n   * full array.\n   *\n   * @typeParam TOutput - The paginated response type returned by the API.\n   * @param operation - A paginated API operation to iterate over.\n   * @param options - Optional settings.\n   * @param options.limit - Maximum number of items to collect. Pagination\n   *   stops as soon as this count is reached.\n   * @returns A synthetic operation that resolves to an array of all collected items.\n   *\n   * @example\n   * ```ts\n   * const allContacts = await client.send(\n   *   pagination.getAll(crmContacts.basic.getContacts()),\n   * );\n   * ```\n   */\n  getAll<TOutput extends PaginatedResponse>(\n    operation: Operation<TOutput>,\n    options?: { limit?: number }\n  ): SyntheticOperation<PaginatedItem<TOutput>[]> {\n    return {\n      _kind: 'synthetic',\n      async run(ctx) {\n        const items: PaginatedItem<TOutput>[] = [];\n        const limit = options?.limit;\n        let after: string | undefined;\n        do {\n          const op = {\n            ...operation,\n            queryParams: { ...operation.queryParams, after },\n          };\n          const page = (await ctx.client.send(op)) as TOutput;\n          const results = page.results as PaginatedItem<TOutput>[];\n          if (limit !== undefined && items.length + results.length >= limit) {\n            items.push(...results.slice(0, limit - items.length));\n            break;\n          }\n          items.push(...results);\n          after = page.paging?.next?.after;\n        } while (after);\n        return items;\n      },\n    };\n  },\n\n  /**\n   * Streams items page-by-page via an async generator, yielding each item\n   * as it arrives rather than buffering the entire result set in memory.\n   *\n   * Useful for very large datasets where holding all items in memory is\n   * impractical.\n   *\n   * @typeParam TOutput - The paginated response type returned by the API.\n   * @param operation - A paginated API operation to iterate over.\n   * @returns A synthetic streaming operation that yields items one at a time.\n   *\n   * @example\n   * ```ts\n   * for await (const contact of client.send(\n   *   pagination.getAllStream(crmContacts.basic.getContacts()),\n   * )) {\n   *   console.log(contact.id);\n   * }\n   * ```\n   */\n  getAllStream<TOutput extends PaginatedResponse>(\n    operation: Operation<TOutput>\n  ): SyntheticStreamingOperation<PaginatedItem<TOutput>> {\n    return {\n      _kind: 'syntheticStreaming',\n      async *run(ctx) {\n        let after: string | undefined;\n        do {\n          const op = {\n            ...operation,\n            queryParams: { ...operation.queryParams, after },\n          };\n          const page = (await ctx.client.send(op)) as TOutput;\n          yield* page.results as PaginatedItem<TOutput>[];\n          after = page.paging?.next?.after;\n        } while (after);\n      },\n    };\n  },\n};\n"],"mappings":";;;;;;;AAcA,MAAa,aAAa;;;;;;;;;;;;;;;;;;;;;;;CAuBxB,OACE,WACA,SAC8C;EAC9C,OAAO;GACL,OAAO;GACP,MAAM,IAAI,KAAK;IACb,MAAM,QAAkC,EAAE;IAC1C,MAAM,QAAQ,SAAS;IACvB,IAAI;IACJ,GAAG;KACD,MAAM,KAAK;MACT,GAAG;MACH,aAAa;OAAE,GAAG,UAAU;OAAa;OAAO;MACjD;KACD,MAAM,OAAQ,MAAM,IAAI,OAAO,KAAK,GAAG;KACvC,MAAM,UAAU,KAAK;KACrB,IAAI,UAAU,KAAA,KAAa,MAAM,SAAS,QAAQ,UAAU,OAAO;MACjE,MAAM,KAAK,GAAG,QAAQ,MAAM,GAAG,QAAQ,MAAM,OAAO,CAAC;MACrD;;KAEF,MAAM,KAAK,GAAG,QAAQ;KACtB,QAAQ,KAAK,QAAQ,MAAM;aACpB;IACT,OAAO;;GAEV;;;;;;;;;;;;;;;;;;;;;;CAuBH,aACE,WACqD;EACrD,OAAO;GACL,OAAO;GACP,OAAO,IAAI,KAAK;IACd,IAAI;IACJ,GAAG;KACD,MAAM,KAAK;MACT,GAAG;MACH,aAAa;OAAE,GAAG,UAAU;OAAa;OAAO;MACjD;KACD,MAAM,OAAQ,MAAM,IAAI,OAAO,KAAK,GAAG;KACvC,OAAO,KAAK;KACZ,QAAQ,KAAK,QAAQ,MAAM;aACpB;;GAEZ;;CAEJ"}

package/dist/server/api-client-core/plugins/fetch-transport.js

@@ -0,0 +1,76 @@
+import { isBinaryData } from "../binary-data.js";
+//#region src/server/api-client-core/plugins/fetch-transport.ts
+const BASE_URL = "https://api.hubapi.com";
+function appendRecordToUrlSearchParams(params, record) {
+	for (const [key, value] of Object.entries(record)) {
+		if (value == null) continue;
+		if (Array.isArray(value)) for (const item of value) params.append(key, String(item));
+		else params.append(key, String(value));
+	}
+}
+/**
+* Transport plugin that executes HTTP requests using the Fetch API.
+*
+* This is the terminal middleware in the chain — it builds the actual HTTP
+* request from the operation descriptor and returns a normalized response.
+* It handles path-parameter interpolation, query-string serialization,
+* Bearer-token auth, and content-type negotiation (JSON, form-urlencoded, multipart).
+*/
+function fetchTransportPlugin(options) {
+	return { activate(api) {
+		api.addMiddleware(async (ctx) => {
+			const { operation } = ctx;
+			let url = `${BASE_URL}${operation.path}`;
+			if (operation.pathParams) for (const [key, value] of Object.entries(operation.pathParams)) url = url.replace(`{${key}}`, encodeURIComponent(String(value)));
+			if (operation.queryParams) {
+				const params = new URLSearchParams();
+				appendRecordToUrlSearchParams(params, operation.queryParams);
+				const qs = params.toString();
+				if (qs) url += `?${qs}`;
+			}
+			const headers = {
+				...operation.headers ?? {},
+				Authorization: `Bearer ${options.getAccessToken()}`
+			};
+			const init = {
+				method: operation.method.toUpperCase(),
+				headers
+			};
+			if (operation.contentType === "multipart/form-data" && operation.body) {
+				const formData = new FormData();
+				for (const [key, value] of Object.entries(operation.body)) {
+					if (value == null) continue;
+					if (isBinaryData(value)) formData.append(key, value.source);
+					else formData.append(key, String(value));
+				}
+				init.body = formData;
+			} else if (operation.contentType === "application/x-www-form-urlencoded") {
+				headers["Content-Type"] = "application/x-www-form-urlencoded";
+				if (operation.body) {
+					const params = new URLSearchParams();
+					appendRecordToUrlSearchParams(params, operation.body);
+					const encoded = params.toString();
+					if (encoded) init.body = encoded;
+				}
+			} else {
+				headers["Content-Type"] = "application/json";
+				if (operation.body) init.body = JSON.stringify(operation.body);
+			}
+			const response = await fetch(url, init);
+			const responseHeaders = Object.create(null);
+			response.headers.forEach((value, key) => {
+				responseHeaders[key] = value;
+			});
+			return {
+				status: response.status,
+				statusText: response.statusText,
+				headers: responseHeaders,
+				bodyJson: response.status === 204 ? void 0 : await response.json()
+			};
+		});
+	} };
+}
+//#endregion
+export { fetchTransportPlugin };
+
+//# sourceMappingURL=fetch-transport.js.map

package/dist/server/api-client-core/plugins/fetch-transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-transport.js","names":[],"sources":["../../../../src/server/api-client-core/plugins/fetch-transport.ts"],"sourcesContent":["import { isBinaryData } from '../binary-data.ts';\nimport type { Plugin } from '../types.ts';\n\nconst BASE_URL = 'https://api.hubapi.com';\n\nexport interface FetchTransportPluginOptions {\n  getAccessToken: () => string;\n}\n\nfunction appendRecordToUrlSearchParams(\n  params: URLSearchParams,\n  record: Record<string, unknown>\n): void {\n  for (const [key, value] of Object.entries(record)) {\n    if (value == null) continue;\n    if (Array.isArray(value)) {\n      for (const item of value) {\n        params.append(key, String(item as string));\n      }\n    } else {\n      params.append(key, String(value));\n    }\n  }\n}\n\n/**\n * Transport plugin that executes HTTP requests using the Fetch API.\n *\n * This is the terminal middleware in the chain — it builds the actual HTTP\n * request from the operation descriptor and returns a normalized response.\n * It handles path-parameter interpolation, query-string serialization,\n * Bearer-token auth, and content-type negotiation (JSON, form-urlencoded, multipart).\n */\nexport function fetchTransportPlugin(\n  options: FetchTransportPluginOptions\n): Plugin {\n  return {\n    activate(api) {\n      api.addMiddleware(async (ctx) => {\n        const { operation } = ctx;\n\n        // Interpolate path parameters (e.g. \"/contacts/{contactId}\" → \"/contacts/123\")\n        let url = `${BASE_URL}${operation.path}`;\n        if (operation.pathParams) {\n          for (const [key, value] of Object.entries(operation.pathParams)) {\n            url = url.replace(`{${key}}`, encodeURIComponent(String(value)));\n          }\n        }\n\n        // Serialize query parameters, supporting repeated keys for array values\n        if (operation.queryParams) {\n          const params = new URLSearchParams();\n          appendRecordToUrlSearchParams(params, operation.queryParams);\n          const qs = params.toString();\n          if (qs) url += `?${qs}`;\n        }\n\n        const headers: Record<string, string> = {\n          ...(operation.headers ?? {}),\n          Authorization: `Bearer ${options.getAccessToken()}`,\n        };\n\n        const init: RequestInit = {\n          method: operation.method.toUpperCase(),\n          headers,\n        };\n\n        // For file uploads the API expects multipart/form-data; BinaryData\n        // values are appended as Blobs while everything else is stringified.\n        // Form bodies use application/x-www-form-urlencoded. Otherwise JSON.\n        if (operation.contentType === 'multipart/form-data' && operation.body) {\n          const formData = new FormData();\n          for (const [key, value] of Object.entries(\n            operation.body as Record<string, unknown>\n          )) {\n            if (value == null) continue;\n            if (isBinaryData(value)) {\n              formData.append(key, value.source as Blob);\n            } else {\n              formData.append(key, String(value));\n            }\n          }\n          init.body = formData;\n        } else if (\n          operation.contentType === 'application/x-www-form-urlencoded'\n        ) {\n          headers['Content-Type'] = 'application/x-www-form-urlencoded';\n          if (operation.body) {\n            const params = new URLSearchParams();\n            appendRecordToUrlSearchParams(\n              params,\n              operation.body as Record<string, unknown>\n            );\n            const encoded = params.toString();\n            if (encoded) init.body = encoded;\n          }\n        } else {\n          headers['Content-Type'] = 'application/json';\n          if (operation.body) {\n            init.body = JSON.stringify(operation.body);\n          }\n        }\n        const response = await fetch(url, init);\n        const responseHeaders: Record<string, string> = Object.create(null);\n        response.headers.forEach((value, key) => {\n          responseHeaders[key] = value;\n        });\n\n        return {\n          status: response.status,\n          statusText: response.statusText,\n          headers: responseHeaders,\n          // 204 No Content responses have no body to parse\n          bodyJson: response.status === 204 ? undefined : await response.json(),\n        };\n      });\n    },\n  };\n}\n"],"mappings":";;AAGA,MAAM,WAAW;AAMjB,SAAS,8BACP,QACA,QACM;CACN,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,OAAO,EAAE;EACjD,IAAI,SAAS,MAAM;EACnB,IAAI,MAAM,QAAQ,MAAM,EACtB,KAAK,MAAM,QAAQ,OACjB,OAAO,OAAO,KAAK,OAAO,KAAe,CAAC;OAG5C,OAAO,OAAO,KAAK,OAAO,MAAM,CAAC;;;;;;;;;;;AAavC,SAAgB,qBACd,SACQ;CACR,OAAO,EACL,SAAS,KAAK;EACZ,IAAI,cAAc,OAAO,QAAQ;GAC/B,MAAM,EAAE,cAAc;GAGtB,IAAI,MAAM,GAAG,WAAW,UAAU;GAClC,IAAI,UAAU,YACZ,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,UAAU,WAAW,EAC7D,MAAM,IAAI,QAAQ,IAAI,IAAI,IAAI,mBAAmB,OAAO,MAAM,CAAC,CAAC;GAKpE,IAAI,UAAU,aAAa;IACzB,MAAM,SAAS,IAAI,iBAAiB;IACpC,8BAA8B,QAAQ,UAAU,YAAY;IAC5D,MAAM,KAAK,OAAO,UAAU;IAC5B,IAAI,IAAI,OAAO,IAAI;;GAGrB,MAAM,UAAkC;IACtC,GAAI,UAAU,WAAW,EAAE;IAC3B,eAAe,UAAU,QAAQ,gBAAgB;IAClD;GAED,MAAM,OAAoB;IACxB,QAAQ,UAAU,OAAO,aAAa;IACtC;IACD;GAKD,IAAI,UAAU,gBAAgB,yBAAyB,UAAU,MAAM;IACrE,MAAM,WAAW,IAAI,UAAU;IAC/B,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAChC,UAAU,KACX,EAAE;KACD,IAAI,SAAS,MAAM;KACnB,IAAI,aAAa,MAAM,EACrB,SAAS,OAAO,KAAK,MAAM,OAAe;UAE1C,SAAS,OAAO,KAAK,OAAO,MAAM,CAAC;;IAGvC,KAAK,OAAO;UACP,IACL,UAAU,gBAAgB,qCAC1B;IACA,QAAQ,kBAAkB;IAC1B,IAAI,UAAU,MAAM;KAClB,MAAM,SAAS,IAAI,iBAAiB;KACpC,8BACE,QACA,UAAU,KACX;KACD,MAAM,UAAU,OAAO,UAAU;KACjC,IAAI,SAAS,KAAK,OAAO;;UAEtB;IACL,QAAQ,kBAAkB;IAC1B,IAAI,UAAU,MACZ,KAAK,OAAO,KAAK,UAAU,UAAU,KAAK;;GAG9C,MAAM,WAAW,MAAM,MAAM,KAAK,KAAK;GACvC,MAAM,kBAA0C,OAAO,OAAO,KAAK;GACnE,SAAS,QAAQ,SAAS,OAAO,QAAQ;IACvC,gBAAgB,OAAO;KACvB;GAEF,OAAO;IACL,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,SAAS;IAET,UAAU,SAAS,WAAW,MAAM,KAAA,IAAY,MAAM,SAAS,MAAM;IACtE;IACD;IAEL"}

package/dist/server/{types-DEOUH4wE.d.ts → api-client-core/types.d.ts}

@@ -131,5 +131,5 @@ interface CreateHubSpotClientOptions {
   plugins: Plugin[];
 }
 //#endregion
-export { Middleware as a, Operation as c, Plugin as d, PluginAPI as f, SyntheticStreamingOperation as h, HubSpotClient as i, PaginatedItem as l, SyntheticOperationContext as m, CreateHubSpotClientOptions as n, MiddlewareContext as o, SyntheticOperation as p, HubSpotApiResponse as r, Next as s, ApiResponse as t, PaginatedResponse as u };
-//# sourceMappingURL=types-DEOUH4wE.d.ts.map
+export { ApiResponse, CreateHubSpotClientOptions, HubSpotApiResponse, HubSpotClient, Middleware, MiddlewareContext, Next, Operation, PaginatedItem, PaginatedResponse, Plugin, PluginAPI, SyntheticOperation, SyntheticOperationContext, SyntheticStreamingOperation };
+//# sourceMappingURL=types.d.ts.map