@hubspot/app-connect-sdk 1.0.0-alpha.1

package/src/browser/types.ts

@@ -0,0 +1,83 @@
+/**
+ * Runtime configuration for an `AppConnectController`. The browser
+ * controller uses these URLs to talk to the SDK's server-side OAuth
+ * routes; both halves must agree on the same value.
+ */
+export interface AppConnectBrowserConfig {
+  /**
+   * Path prefix the server mounts the SDK's hubspot-connect routes on
+   * (no trailing slash).
+   *
+   * @example '/functions/v1/hubspot-connect'
+   */
+  hubSpotConnectBaseUrl: string;
+}
+
+/**
+ * Public lifecycle of an `AppConnectController`. Every state in the
+ * UI maps to one of these values:
+ *
+ * - `initializing`: the controller hasn't finished `start()` yet.
+ * - `disconnected`: no active session, ready to call `connectToHubSpot`.
+ * - `connecting`: a connect flow is in flight (the browser is about
+ *   to redirect to HubSpot).
+ * - `connected`: a refresh-token cookie is present and the access
+ *   token is being refreshed in the background.
+ * - `disconnecting`: a `disconnectFromHubSpot()` call is in flight.
+ */
+export type AppConnectStatus =
+  | 'initializing'
+  | 'disconnecting'
+  | 'disconnected'
+  | 'connecting'
+  | 'connected';
+
+/**
+ * Snapshot returned by `controller.getSnapshot()` and consumed by the
+ * `useHubSpotAppConnect` React hook.
+ */
+export interface AppConnectState {
+  /** Current lifecycle status, see {@link AppConnectStatus}. */
+  status: AppConnectStatus;
+  /** Last error message that occurred, or `null` if no error. */
+  error: string | null;
+  /**
+   * Begins the OAuth connect flow. On success the browser redirects
+   * to HubSpot's authorize endpoint; the promise resolves before the
+   * redirect.
+   */
+  connectToHubSpot: () => Promise<void>;
+  /**
+   * Logs the user out by calling the SDK's `auth/logout` route and
+   * clearing the local session-storage timer.
+   */
+  disconnectFromHubSpot: () => Promise<void>;
+}
+
+/**
+ * Imperative controller returned by `createAppConnectController`. The
+ * `subscribe`/`getSnapshot`/`getServerSnapshot` triple is shaped to
+ * plug directly into React's `useSyncExternalStore`.
+ */
+export interface AppConnectController {
+  /**
+   * Subscribes to state changes. Returns an unsubscribe function.
+   */
+  subscribe: (onChange: () => void) => () => void;
+  /**
+   * Returns the current `AppConnectState` snapshot. The result is
+   * referentially stable between updates — useful for React.
+   */
+  getSnapshot: () => AppConnectState;
+  /**
+   * Returns an SSR-safe snapshot used by `useSyncExternalStore`
+   * during server rendering. Always reports `initializing`.
+   */
+  getServerSnapshot: () => AppConnectState;
+  /**
+   * Starts the controller. Idempotent — calling it more than once is
+   * a no-op. The React component does this automatically; non-React
+   * callers must invoke it once before reading state.
+   */
+  start: () => void;
+}

package/src/server/api-client-core/apis/account/account-info-types.generated.ts

@@ -0,0 +1,116 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace AccountAccountInfo {
+  export namespace Basic {
+    export type GetDailyPrivateAppsUsageOutput =
+      Schemas.CollectionResponseApiUsageNoPaging;
+
+    export type GetOutput = Schemas.PortalInformationResponse;
+  }
+
+  export namespace Schemas {
+    export interface ApiUsage {
+      /**
+       * Indicates when the cache was last updated.
+       */
+      collectedAt: string;
+      /**
+       * How many API calls an account has made for the current day.
+       */
+      currentUsage: number;
+      /**
+       * Status of fetching the information, including if the data came from the cache.
+       */
+      fetchStatus: 'CACHED' | 'FAILURE' | 'NOTFOUND' | 'SUCCESS' | 'TIMEOUT';
+      /**
+       * Name of the limit type.
+       */
+      name: string;
+      /**
+       * Time that the limit will reset.
+       */
+      resetsAt?: string;
+      /**
+       * Limits by which a single integration can consume the HubSpot public APIs.
+       */
+      usageLimit: number;
+    }
+
+    export interface CollectionResponseApiUsageNoPaging {
+      results: Schemas.ApiUsage[];
+    }
+
+    export interface PortalInformationResponse {
+      /**
+       * The type of account, such as APP_DEVELOPER, DEVELOPER_TEST, SANDBOX, or STANDARD.
+       */
+      accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD';
+      additionalCurrencies: string[];
+      /**
+       * The primary currency used by the company.
+       */
+      companyCurrency: string;
+      /**
+       * The location where the account's data is hosted.
+       */
+      dataHostingLocation: string;
+      /**
+       * The unique identifier for the HubSpot account.
+       */
+      portalId: number;
+      /**
+       * The time zone in which the account operates.
+       */
+      timeZone: string;
+      /**
+       * The domain used for accessing the HubSpot user interface.
+       */
+      uiDomain: string;
+      /**
+       * The time zone offset from UTC in hours and minutes.
+       */
+      utcOffset: string;
+      /**
+       * The time zone offset from UTC in milliseconds.
+       */
+      utcOffsetMilliseconds: number;
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { accountAccountInfo } from '@hubspot/api-client-core';
+   * client.send(accountAccountInfo.basic.get(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Retrieve account details
+     * @apiPath /account-info/2026-03/details
+     * @apiMethod GET
+     * @requiredScopes external-settings-access
+     */
+    get: () => Operation<Basic.GetOutput>;
+    /**
+     * Retrieve private app daily API usage
+     * @apiPath /account-info/2026-03/api-usage/daily/private-apps
+     * @apiMethod GET
+     * @requiredScopes external-settings-access
+     */
+    getDailyPrivateAppsUsage: () => Operation<Basic.GetDailyPrivateAppsUsageOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { accountAccountInfo } from '@hubspot/api-client-core';
+   * client.send(accountAccountInfo.basic.get(input));
+   * ```
+   */
+  export interface API {
+    basic: BasicAPI;
+  }
+}

package/src/server/api-client-core/apis/account/account-info.generated.ts

@@ -0,0 +1,14 @@
+import { op } from '../../op.ts';
+import type { AccountAccountInfo } from './account-info-types.generated.ts';
+
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+export * from './account-info-types.generated.ts';
+
+const basic: AccountAccountInfo.BasicAPI = {
+  get: () => op.get('/account-info/2026-03/details'),
+  getDailyPrivateAppsUsage: () =>
+    op.get('/account-info/2026-03/api-usage/daily/private-apps'),
+};
+
+export const accountAccountInfo: AccountAccountInfo.API = { basic: basic };

package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts

@@ -0,0 +1,409 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace AccountAuditLogs {
+  export namespace Basic {
+    export interface ListAuditLogsInput {
+      actingUserId?: number[];
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      fillFinalTimestamp?: boolean;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      occurredAfter?: string;
+      occurredBefore?: string;
+      sort?: string[];
+    }
+
+    export type ListAuditLogsOutput =
+      Schemas.CollectionResponsePublicApiUserActionEventForwardPaging;
+
+    export interface ListLoginActivitiesInput {
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      userId?: number;
+    }
+
+    export type ListLoginActivitiesOutput =
+      Schemas.CollectionResponsePublicLoginAuditForwardPaging;
+
+    export interface ListSecurityActivitiesInput {
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      fromTimestamp?: number;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      toTimestamp?: number;
+      userId?: number;
+    }
+
+    export type ListSecurityActivitiesOutput =
+      Schemas.CollectionResponseHydratedCriticalActionForwardPaging;
+  }
+
+  export namespace Schemas {
+    export interface ActingUser {
+      /**
+       * The email address of the user who performed the action.
+       */
+      userEmail?: string;
+      /**
+       * The user's unique ID.
+       */
+      userId: number;
+    }
+
+    export interface CollectionResponseHydratedCriticalActionForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: Schemas.HydratedCriticalAction[];
+    }
+
+    export interface CollectionResponsePublicApiUserActionEventForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: Schemas.PublicApiUserActionEvent[];
+    }
+
+    export interface CollectionResponsePublicLoginAuditForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: Schemas.PublicLoginAudit[];
+    }
+
+    export interface ForwardPaging {
+      next?: Schemas.NextPage;
+    }
+
+    export interface HydratedCriticalAction {
+      /**
+       * Email address of the user associated with the activity.
+       */
+      actingUser?: string;
+      /**
+       * The approximate country code
+       */
+      countryCode?: string;
+      /**
+       * The time the activity took place.
+       */
+      createdAt: string;
+      /**
+       * The activity's unique ID.
+       */
+      id: string;
+      /**
+       * A link to the URL where the action was taken in the account.
+       */
+      infoUrl?: string;
+      /**
+       * IP address where the activity originated.
+       */
+      ipAddress?: string;
+      /**
+       * The approximate location where the activity took place.
+       */
+      location?: string;
+      /**
+       * The ID of the affected object.
+       */
+      objectId?: string;
+      /**
+       * The approximate region code
+       */
+      regionCode?: string;
+      /**
+       * The type of activity.
+       */
+      type:
+        | 'ACCEPTANCE_TEST'
+        | 'ACCOUNT_ADDED_TO_MULTI_ACCOUNT_ORGANIZATION'
+        | 'ACCOUNT_REMOVED_FROM_MULTI_ACCOUNT_ORGANIZATION'
+        | 'ADD_ADMIN_PERMISSIONS'
+        | 'ADD_ADMIN_USER'
+        | 'ADD_SINGLE_SIGN_ON'
+        | 'ADD_TWO_FACTOR_AUTHENTICATION'
+        | 'ADD_USER'
+        | 'ADD_WEBHOOK_IN_WORKFLOW'
+        | 'ALLOWED_GEOLOCATIONS_DISABLED'
+        | 'ALLOWED_GEOLOCATIONS_ENABLED'
+        | 'ALLOWED_LOGIN_METHODS_DELETE'
+        | 'ALLOWED_LOGIN_METHODS_UPDATE'
+        | 'ATTACHMENT_LOGGING_DISABLED'
+        | 'ATTACHMENT_LOGGING_ENABLED'
+        | 'AUTOMATED_INACTIVE_USER_DEACTIVATION_DISABLED'
+        | 'AUTOMATED_INACTIVE_USER_DEACTIVATION_ENABLED'
+        | 'BOTS_WEBHOOK_POST'
+        | 'BOTS_WEBHOOK_UPDATE'
+        | 'BOTS_WEBHOOK_VIEWED'
+        | 'BULK_EMAIL_DOMAIN_CHANGE'
+        | 'CHANGE_AD_EVENT_CONSENT_SETTING'
+        | 'CHANGE_AD_EVENT_DATA_SHARING_SETTING'
+        | 'CHANGE_PASSWORD'
+        | 'CONTACT_DATA_EXPORT'
+        | 'DATA_ACCESS_REQUEST_SUBMITTED'
+        | 'DATA_BACKUP_CREATED'
+        | 'DATA_BACKUP_DOWNLOADED'
+        | 'DATA_BACKUP_SCHEDULE_CREATED'
+        | 'DATA_BACKUP_SCHEDULE_DELETED'
+        | 'DATA_BACKUP_SCHEDULE_UPDATED'
+        | 'DATA_RESTORE_COMPLETED'
+        | 'DATA_SHARING_CONNECTION_ADDED'
+        | 'DATA_SHARING_CONNECTION_REMOVED'
+        | 'DATASET_SYNC'
+        | 'DEACTIVATE_USER'
+        | 'DOMAIN_BASED_INVITE_CREATED'
+        | 'DOMAIN_BASED_INVITE_REMOVED'
+        | 'DOMAIN_BASED_INVITES_DISABLED'
+        | 'DOMAIN_BASED_INVITES_ENABLED'
+        | 'EMAIL_TRACKING_DISABLED'
+        | 'EMAIL_TRACKING_ENABLED'
+        | 'EXPORT'
+        | 'EXPORT_APPROVAL'
+        | 'EXPORT_DOWNLOAD'
+        | 'EXPORT_USERS'
+        | 'FORM_SUBMISSIONS_EXPORT'
+        | 'GDPR_DELETE'
+        | 'GDPR_TOGGLE_DISABLED'
+        | 'GDPR_TOGGLE_ENABLED'
+        | 'HAPIKEY_CREATE'
+        | 'HAPIKEY_DEACTIVATE'
+        | 'HAPIKEY_VIEW'
+        | 'HUBSPOT_EMPLOYEE_ACCESS_DISABLED'
+        | 'HUBSPOT_EMPLOYEE_ACCESS_ENABLED'
+        | 'IMPERSONATE_USER'
+        | 'IMPORT'
+        | 'INSTALL_INTEGRATION'
+        | 'IP_RESTRICTIONS_DISABLED'
+        | 'IP_RESTRICTIONS_ENABLED'
+        | 'JOINED_PORTAL_VIA_DOMAIN_BASED_INVITE'
+        | 'LEGAL_BASIS_REQUIREMENT_DISABLED'
+        | 'LEGAL_BASIS_REQUIREMENT_ENABLED'
+        | 'MANUAL_PASSWORD_RESET_EMAIL_SEND'
+        | 'MANUAL_REGISTRATION_EMAIL_SEND'
+        | 'MARKETING_CONTACTS_APP_SETTINGS_DISABLED'
+        | 'MARKETING_CONTACTS_APP_SETTINGS_ENABLED'
+        | 'MERGE_REVERT'
+        | 'MODIFY_WEBHOOK_IN_WORKFLOW'
+        | 'MULTI_ACCOUNT_REPORTING_CONNECTION_ADDED'
+        | 'MULTI_ACCOUNT_REPORTING_CONNECTION_REMOVED'
+        | 'MULTI_ACCOUNT_WORKFLOWS_CONNECTION_ADDED'
+        | 'MULTI_ACCOUNT_WORKFLOWS_CONNECTION_REMOVED'
+        | 'NEVER_LOG_FOR_PORTAL_ADDITION'
+        | 'NEVER_LOG_FOR_PORTAL_DELETION'
+        | 'NEVER_LOG_FOR_USER_ADDITION'
+        | 'NEVER_LOG_FOR_USER_DELETION'
+        | 'PASSKEY_ADDED'
+        | 'PASSKEY_DELETED'
+        | 'PAYMENT_ACCOUNT_CREATION'
+        | 'PAYMENT_ACCOUNT_INFO_UPDATE'
+        | 'PAYMENT_BANK_ACCOUNT_CHANGE'
+        | 'PAYMENT_ONBOARDING_LINK_SEND'
+        | 'PERSONAL_ACCESS_KEY_CREATE'
+        | 'PERSONAL_ACCESS_KEY_DEACTIVATE'
+        | 'PERSONAL_ACCESS_KEY_ROTATE'
+        | 'PERSONAL_ACCESS_KEY_VIEW'
+        | 'PRIVATE_APP_ACCESS_TOKEN_CREATE'
+        | 'PRIVATE_APP_ACCESS_TOKEN_DEACTIVATE'
+        | 'PRIVATE_APP_ACCESS_TOKEN_ROTATE'
+        | 'PRIVATE_APP_ACCESS_TOKEN_VIEW'
+        | 'PRIVATE_APP_CLIENT_SECRET_VIEW'
+        | 'PRIVATE_APP_CLIENT_SECRET_WRITE'
+        | 'PRIVATE_APP_SCOPE_GROUPS_UPDATE'
+        | 'PRODUCTION_DEPLOYMENT'
+        | 'PROPERTY_HISTORY_REVISION'
+        | 'PUBLIC_APP_CLIENT_SECRET_VIEW'
+        | 'PUBLIC_APP_CLIENT_SECRET_WRITE'
+        | 'REACTIVATE_USER'
+        | 'REMOVE_ADMIN_PERMISSIONS'
+        | 'REMOVE_ADMIN_USER'
+        | 'REMOVE_SINGLE_SIGN_ON'
+        | 'REMOVE_TWO_FACTOR_AUTHENTICATION'
+        | 'REMOVE_USER'
+        | 'REQUIRE_SINGLE_SIGN_ON'
+        | 'RESTRICTED_LIST_ADDED_TO_CONTENT'
+        | 'SANDBOX_CREATION'
+        | 'SANDBOX_DELETION'
+        | 'SANDBOX_SYNC'
+        | 'SANDBOX_SYNC_TO_PRODUCTION'
+        | 'SECRET_ADDED_TO_SERVERLESS_FUNCTION'
+        | 'SENSITIVE_DATA_DISABLED'
+        | 'SENSITIVE_DATA_ENABLED'
+        | 'SEQUENCE_CLONED'
+        | 'SEQUENCE_CREATED'
+        | 'SEQUENCE_ENROLLMENT_INITIATED'
+        | 'SEQUENCE_ENROLLMENT_STATE_CHANGED'
+        | 'SEQUENCE_MODIFIED'
+        | 'SERVICE_KEY_CREATE'
+        | 'SERVICE_KEY_DEACTIVATE'
+        | 'SERVICE_KEY_PERMISSIONS_UPDATE'
+        | 'SERVICE_KEY_REVEAL'
+        | 'SERVICE_KEY_ROTATE'
+        | 'SMTP_TOKEN_CREATED'
+        | 'SMTP_TOKEN_DELETED'
+        | 'SMTP_TOKEN_PASSWORD_RESET'
+        | 'SMTP_TOKEN_RETRIEVED'
+        | 'TEAM_ADDED'
+        | 'TEAM_DELETED'
+        | 'TEAM_USER_ADDED'
+        | 'TEAM_USER_DELETED'
+        | 'TEMPLATE_MODIFIED'
+        | 'TOUCHLESS_PURCHASE'
+        | 'UNIFIED_RESTORE_UNDO_EXECUTION'
+        | 'UNINSTALL_INTEGRATION'
+        | 'UNREQUIRE_SINGLE_SIGN_ON'
+        | 'WEBHOOK_SETTINGS_UPDATE'
+        | 'WEBHOOK_SUBSCRIPTION_CREATE'
+        | 'WEBHOOK_SUBSCRIPTION_UPDATE';
+      /**
+       * The user's unique ID.
+       */
+      userId: number;
+    }
+
+    /**
+     * Specifies the paging information needed to retrieve the next set of results in a paginated API response
+     */
+    export interface NextPage {
+      /**
+       * A paging cursor token for retrieving subsequent pages.
+       */
+      after: string;
+      /**
+       * A URL that can be used to retrieve the next page results.
+       */
+      link?: string;
+    }
+
+    export interface PublicApiUserActionEvent {
+      actingUser: Schemas.ActingUser;
+      /**
+       * The type of action taken.
+       */
+      action: string;
+      /**
+       * The category of the activity.
+       */
+      category: string;
+      /**
+       * The login activity's unique ID.
+       */
+      id: string;
+      /**
+       * The time that the action occurred at.
+       */
+      occurredAt: string;
+      /**
+       * The subcategory of the activity.
+       */
+      subCategory?: string;
+      /**
+       * The ID of the impacted object.
+       */
+      targetObjectId?: string;
+    }
+
+    export interface PublicLoginAudit {
+      /**
+       * The approximate country code of the login
+       */
+      countryCode?: string;
+      /**
+       * Email address of the user associated with the login.
+       */
+      email?: string;
+      /**
+       * The login activity's unique ID.
+       */
+      id: string;
+      /**
+       * IP address where the activity originated.
+       */
+      ipAddress?: string;
+      /**
+       * The approximate location where the login activity originated.
+       */
+      location?: string;
+      /**
+       * The time the login took place.
+       */
+      loginAt: string;
+      /**
+       * Whether the login was successful or not.
+       */
+      loginSucceeded: boolean;
+      /**
+       * The approximate region code of the login
+       */
+      regionCode?: string;
+      /**
+       * Information about the device used for logging in.
+       */
+      userAgent?: string;
+      /**
+       * The user's unique ID.
+       */
+      userId?: number;
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { accountAuditLogs } from '@hubspot/api-client-core';
+   * client.send(accountAuditLogs.basic.listAuditLogs(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Retrieve audit logs
+     * @apiPath /account-info/2026-03/activity/audit-logs
+     * @apiMethod GET
+     * @requiredScopes user-action-audits-read
+     */
+    listAuditLogs: (
+      input?: Basic.ListAuditLogsInput
+    ) => Operation<Basic.ListAuditLogsOutput>;
+    /**
+     * Retrieve login activity
+     * @apiPath /account-info/2026-03/activity/login
+     * @apiMethod GET
+     * @requiredScopes login-audit-access
+     */
+    listLoginActivities: (
+      input?: Basic.ListLoginActivitiesInput
+    ) => Operation<Basic.ListLoginActivitiesOutput>;
+    /**
+     * Retrieve security history
+     * @apiPath /account-info/2026-03/activity/security
+     * @apiMethod GET
+     * @requiredScopes critical-actions-access
+     */
+    listSecurityActivities: (
+      input?: Basic.ListSecurityActivitiesInput
+    ) => Operation<Basic.ListSecurityActivitiesOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { accountAuditLogs } from '@hubspot/api-client-core';
+   * client.send(accountAuditLogs.basic.listAuditLogs(input));
+   * ```
+   */
+  export interface API {
+    basic: BasicAPI;
+  }
+}

package/src/server/api-client-core/apis/account/audit-logs.generated.ts

@@ -0,0 +1,41 @@
+import { op } from '../../op.ts';
+import type { AccountAuditLogs } from './audit-logs-types.generated.ts';
+
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+export * from './audit-logs-types.generated.ts';
+
+const basic: AccountAuditLogs.BasicAPI = {
+  listAuditLogs: (input) =>
+    op.get('/account-info/2026-03/activity/audit-logs', {
+      queryParams: {
+        actingUserId: input?.actingUserId,
+        after: input?.after,
+        fillFinalTimestamp: input?.fillFinalTimestamp,
+        limit: input?.limit,
+        occurredAfter: input?.occurredAfter,
+        occurredBefore: input?.occurredBefore,
+        sort: input?.sort,
+      },
+    }),
+  listLoginActivities: (input) =>
+    op.get('/account-info/2026-03/activity/login', {
+      queryParams: {
+        after: input?.after,
+        limit: input?.limit,
+        userId: input?.userId,
+      },
+    }),
+  listSecurityActivities: (input) =>
+    op.get('/account-info/2026-03/activity/security', {
+      queryParams: {
+        after: input?.after,
+        fromTimestamp: input?.fromTimestamp,
+        limit: input?.limit,
+        toTimestamp: input?.toTimestamp,
+        userId: input?.userId,
+      },
+    }),
+};
+
+export const accountAuditLogs: AccountAuditLogs.API = { basic: basic };