@hubspot/ui-extensions 0.11.4 → 0.11.6

package/dist/shared/types/crm.d.ts

@@ -2,20 +2,54 @@ import { ReactNode } from 'react';
 import { TShirtSizes, BaseComponentProps } from './shared.ts';
 /** @ignore */
 export interface CrmDataHighlightProps extends BaseComponentProps {
+    /**
+     * The properties to display, up to four. By default, will display property data from the currently displaying record. To pull data from a specific record, include the `objectTypeId` and `objectId` props.
+     */
     properties: Array<string>;
+    /**
+     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts).
+     */
     objectTypeId?: string;
+    /**
+     * The ID of the CRM record to display property data from.
+     */
     objectId?: number;
 }
 /** @ignore */
 export interface CrmReportProps extends BaseComponentProps {
+    /**
+     * The numeric ID of the single object report, which can be found in the URL when viewing the report in HubSpot.
+     */
     reportId: string;
+    /**
+     * Specifies how the report should be filtered based on its relationship to the currently displaying CRM record:
+     * - `associations`: report will only include data from records associated with the currently displaying record.
+     * - `subject`: report will only include data from the currently displaying record. Will not include data from associated records.
+     * - `unfiltered`: report will display all data regardless of the currently displaying record and its associations.
+     *
+     * @defaultValue `"associations"`
+     */
     use?: 'associations' | 'subject' | 'unfiltered';
 }
 /** @ignore */
 export interface CrmPropertyListProps extends BaseComponentProps {
+    /**
+     * The properties to display, up to 24. By default, will display property data from the currently displaying record. To pull data from a specific record, include the `objectTypeId` and `objectId` props.
+     */
     properties: Array<string>;
+    /**
+     * The layout direction of the table.
+     *
+     * @defaultValue `"column"`
+     */
     direction?: string;
+    /**
+     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts).
+     */
     objectTypeId?: string;
+    /**
+     * The ID of the CRM record to display property data from.
+     */
     objectId?: number;
 }
 /** @ignore */
@@ -101,7 +135,13 @@ interface PercentileMetricItem extends BaseCrmStatisticItem {
 type CrmStatisticItem = BasicMetricItem | PercentileMetricItem;
 /** @ignore */
 export interface CrmStatisticsProps extends BaseComponentProps {
+    /**
+     * The numeric ID of the type of object to fetch statistics about (e.g., `0-1` for contacts).
+     */
     objectTypeId: string;
+    /**
+     * An array of objects that define each statistic to fetch.
+     */
     statistics: Array<CrmStatisticItem>;
 }
 /** @ignore */
@@ -117,9 +157,21 @@ interface Gradient {
 }
 /** @ignore */
 export interface CrmStageTrackerProps extends BaseComponentProps {
+    /**
+     * The ID of the CRM record to display property data from.
+     */
     objectId?: number;
+    /**
+     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts).
+     */
     objectTypeId?: string;
+    /**
+     * The properties to display, up to four. By default, will display property data from the currently displaying record.
+     */
     properties: Array<string>;
+    /**
+     * Whether to display the properties below the progress indicator.
+     */
     showProperties?: boolean;
 }
 /** @ignore */

package/dist/shared/types/http-requests.d.ts

@@ -66,8 +66,8 @@ export interface ServerlessExecutionRequest {
     serverlessFunction: string;
     location: keyof ExtensionPoints;
     objectQuery?: {
-        objectId: number;
-        objectTypeId: string;
+        objectId?: number;
+        objectTypeId?: string;
         objectPropertyNames: string[];
     };
     parameters?: JsonValue;

package/dist/shared/types/shared.d.ts

@@ -38,151 +38,196 @@ export interface TShirtSizes {
 export type AllSizes = TShirtSizes['xs'] | TShirtSizes['sm'] | TShirtSizes['md'] | TShirtSizes['lg'] | TShirtSizes['xl'];
 export type AllDistances = 'flush' | AllSizes;
 export declare const iconNames: {
-    readonly success: "success";
-    readonly remove: "remove";
     readonly add: "add";
+    readonly appointment: "appointment";
+    readonly approvals: "approvals";
+    readonly artificialIntelligence: "artificialIntelligence";
+    readonly artificialIntelligenceEnhanced: "artificialIntelligenceEnhanced";
     readonly attach: "attach";
-    readonly date: "date";
+    readonly bank: "bank";
+    readonly block: "block";
+    readonly book: "knowledgeBase";
+    readonly bulb: "bulb";
+    readonly callTranscript: "callTranscript";
+    readonly calling: "calling";
+    readonly callingHangup: "callingHangup";
+    readonly callingMade: "callingMade";
+    readonly callingMissed: "callingMissed";
+    readonly callingVoicemail: "callingVoicemail";
+    readonly campaigns: "campaigns";
+    readonly cap: "cap";
+    readonly checkCircle: "checkCircle";
+    readonly circleFilled: "circleFilled";
+    readonly circleHollow: "circleHollow";
+    readonly clock: "time";
+    readonly comment: "comments";
+    readonly contact: "contacts";
     readonly copy: "duplicate";
+    readonly crm: "crm";
+    readonly dataSync: "dataSync";
+    readonly date: "date";
+    readonly delay: "delay";
     readonly delete: "delete";
+    readonly description: "description";
+    readonly developerProjects: "developerProjects";
+    readonly documents: "documents";
+    readonly downCarat: "downCarat";
+    readonly download: "download";
     readonly edit: "edit";
+    readonly ellipses: "ellipses";
     readonly email: "email";
+    readonly emailOpen: "emailOpen";
+    readonly emailThreadedReplies: "emailThreadedReplies";
+    readonly enrichment: "enrichment";
+    readonly enroll: "enroll";
     readonly exclamation: "exclamation";
-    readonly question: "question";
-    readonly home: "home";
-    readonly location: "location";
-    readonly upCarat: "upCarat";
-    readonly downCarat: "downCarat";
-    readonly warning: "warning";
-    readonly shoppingCart: "cart";
-    readonly clock: "time";
-    readonly comment: "comments";
-    readonly contact: "contacts";
-    readonly star: "favorite";
-    readonly file: "file";
-    readonly reports: "reports";
-    readonly video: "video";
-    readonly robot: "simpleBot";
-    readonly refresh: "refresh";
+    readonly exclamationCircle: "exclamationCircle";
     readonly faceHappy: "emoji";
+    readonly faceHappyFilled: "emojiFillHappy";
     readonly faceNeutral: "emojiLineNeutral";
+    readonly faceNeutralFilled: "emojiFillNeutral";
     readonly faceSad: "emojiLineSad";
-    readonly upload: "upload";
-    readonly download: "download";
-    readonly left: "left";
-    readonly right: "right";
-    readonly dataSync: "dataSync";
-    readonly imageGallery: "imageGallery";
-    readonly search: "search";
-    readonly save: "saveEditableView";
-    readonly notification: "notification";
-    readonly bulb: "bulb";
-    readonly settings: "settings";
+    readonly faceSadFilled: "emojiFillSad";
+    readonly facebook: "socialBlockFacebook";
+    readonly favoriteHollow: "favoriteHollow";
+    readonly file: "file";
+    readonly filledXCircleIcon: "filledXCircleIcon";
     readonly filter: "filter";
+    readonly flame: "highlyEngagedLead";
+    readonly folder: "folder";
+    readonly folderOpen: "folderOpen";
+    readonly forward: "forward";
     readonly gauge: "gauge";
-    readonly enroll: "enroll";
     readonly generateChart: "generateChart";
     readonly gift: "gift";
-    readonly flame: "highlyEngagedLead";
-    readonly inbox: "inbox";
+    readonly globe: "language";
+    readonly globeLine: "globe";
+    readonly goal: "goal";
+    readonly googlePlus: "socialBlockGoogleplus";
+    readonly guidedActions: "guidedActions";
+    readonly hash: "numericDataType";
+    readonly hide: "hide";
+    readonly home: "home";
+    readonly hubDB: "hubDB";
     readonly image: "insertImage";
-    readonly quote: "insertQuote";
+    readonly imageGallery: "imageGallery";
+    readonly inbox: "inbox";
+    readonly info: "info";
+    readonly infoNoCircle: "infoNoCircle";
     readonly insertVideo: "insertVideo";
+    readonly instagram: "socialBlockInstagram";
+    readonly integrations: "integrations";
     readonly invoice: "invoice";
     readonly key: "key";
-    readonly book: "knowledgeBase";
-    readonly globe: "language";
+    readonly language: "language";
+    readonly left: "left";
+    readonly lessCircle: "lessCircle";
     readonly lesson: "lesson";
+    readonly light: "light";
     readonly link: "link";
+    readonly linkedin: "socialBlockLinkedin";
     readonly listView: "listView";
+    readonly location: "location";
     readonly locked: "locked";
     readonly mention: "mention";
     readonly messages: "messages";
     readonly mobile: "mobile";
+    readonly moreCircle: "moreCircle";
+    readonly notEditable: "notEditable";
+    readonly notification: "notification";
     readonly notificationOff: "notificationOff";
-    readonly hash: "numericDataType";
     readonly objectAssociations: "objectAssociations";
     readonly objectAssociationsManyToMany: "objectAssociationsManyToMany";
     readonly objectAssociationsManyToOne: "objectAssociationsManyToOne";
     readonly office365: "office365";
     readonly order: "order";
     readonly paymentSubscriptions: "paymentSubscriptions";
-    readonly product: "product";
+    readonly pin: "pin";
+    readonly pinterest: "socialBlockPinterest";
     readonly powerPointFile: "powerPointFile";
     readonly presentation: "presentation";
+    readonly product: "product";
     readonly publish: "publish";
+    readonly question: "question";
     readonly questionAnswer: "questionAnswer";
+    readonly questionCircle: "questionCircle";
     readonly quickbooks: "quickbooks";
+    readonly quote: "insertQuote";
     readonly readMore: "readMore";
-    readonly realEstateListing: "realEstateListing";
     readonly readOnlyView: "readOnlyView";
+    readonly realEstateListing: "realEstateListing";
     readonly recentlySelected: "recentlySelected";
     readonly record: "record";
     readonly redo: "redo";
-    readonly undo: "undo";
+    readonly refresh: "refresh";
     readonly registration: "registration";
+    readonly remove: "remove";
     readonly replace: "replace";
+    readonly reports: "reports";
+    readonly right: "right";
+    readonly robot: "simpleBot";
     readonly rotate: "rotate";
+    readonly rss: "socialBlockRss";
     readonly salesQuote: "salesQuote";
     readonly salesTemplates: "salesTemplates";
+    readonly save: "saveEditableView";
+    readonly search: "search";
+    readonly send: "send";
     readonly sequences: "sequences";
+    readonly settings: "settings";
+    readonly shoppingCart: "cart";
+    readonly signal: "signal";
+    readonly signalPoor: "signalPoor";
+    readonly signature: "signature";
+    readonly snooze: "snooze";
+    readonly sortAlpAsc: "sortAlpAsc";
+    readonly sortAlpDesc: "sortAlpDesc";
+    readonly sortAmtAsc: "sortAmtAsc";
+    readonly sortAmtDesc: "sortAmtDesc";
+    readonly sortNumAsc: "sortNumAsc";
+    readonly sortNumDesc: "sortNumDesc";
+    readonly sortTableAsc: "sortTableAsc";
+    readonly sortTableDesc: "sortTableDesc";
     readonly spellCheck: "spellCheck";
+    readonly sprocket: "sprocket";
+    readonly star: "favorite";
+    readonly stopRecord: "stopRecord";
     readonly strike: "strike";
+    readonly styles: "styles";
+    readonly success: "success";
     readonly tablet: "tablet";
     readonly tag: "tag";
     readonly tasks: "tasks";
     readonly test: "test";
-    readonly ticket: "ticket";
-    readonly thumbsUp: "thumbsUp";
+    readonly text: "text";
+    readonly textBodyExpanded: "textBodyExpanded";
+    readonly textColor: "textColor";
+    readonly textDataType: "textDataType";
+    readonly textSnippet: "textSnippet";
     readonly thumbsDown: "thumbsDown";
+    readonly thumbsUp: "thumbsUp";
+    readonly ticket: "ticket";
     readonly translate: "translate";
     readonly trophy: "trophy";
+    readonly twitter: "socialBlockTwitter";
+    readonly undo: "undo";
+    readonly upCarat: "upCarat";
+    readonly upload: "upload";
+    readonly video: "video";
     readonly videoFile: "videoFile";
     readonly videoPlayerSubtitles: "videoPlayerSubtitles";
     readonly view: "view";
     readonly viewDetails: "viewDetails";
+    readonly warning: "warning";
     readonly website: "website";
     readonly workflows: "workflows";
-    readonly zoomIn: "zoomIn";
-    readonly zoomOut: "zoomOut";
-    readonly goal: "goal";
-    readonly campaigns: "campaigns";
-    readonly cap: "cap";
-    readonly block: "block";
-    readonly bank: "bank";
-    readonly approvals: "approvals";
-    readonly appointment: "appointment";
-    readonly facebook: "socialBlockFacebook";
-    readonly googlePlus: "socialBlockGoogleplus";
-    readonly instagram: "socialBlockInstagram";
-    readonly linkedin: "socialBlockLinkedin";
-    readonly pinterest: "socialBlockPinterest";
-    readonly rss: "socialBlockRss";
-    readonly twitter: "socialBlockTwitter";
     readonly x: "socialBlockX";
+    readonly xCircle: "xCircle";
     readonly xing: "socialBlockXing";
     readonly youtube: "socialBlockYoutube";
     readonly youtubePlay: "socialBlockYoutubeplay";
-    readonly sortAlpAsc: "sortAlpAsc";
-    readonly sortAlpDesc: "sortAlpDesc";
-    readonly sortAmtAsc: "sortAmtAsc";
-    readonly sortAmtDesc: "sortAmtDesc";
-    readonly sortNumAsc: "sortNumAsc";
-    readonly sortNumDesc: "sortNumDesc";
-    readonly sortTableAsc: "sortTableAsc";
-    readonly sortTableDesc: "sortTableDesc";
-    readonly text: "text";
-    readonly textColor: "textColor";
-    readonly textDataType: "textDataType";
-    readonly textSnippet: "textSnippet";
-    readonly calling: "calling";
-    readonly callingHangup: "callingHangup";
-    readonly callingMade: "callingMade";
-    readonly callingMissed: "callingMissed";
-    readonly callingVoicemail: "callingVoicemail";
-    readonly faceHappyFilled: "emojiFillHappy";
-    readonly faceNeutralFilled: "emojiFillNeutral";
-    readonly faceSadFilled: "emojiFillSad";
+    readonly zoomIn: "zoomIn";
+    readonly zoomOut: "zoomOut";
 };
 export type IconNames = keyof typeof iconNames;
 export type TypesOfReadOnlyArray<T extends ReadonlyArray<unknown>> = T extends ReadonlyArray<infer ElementType> ? ElementType : never;

package/dist/shared/types/shared.js

@@ -18,151 +18,196 @@ export class FormSubmitExtensionEvent extends ExtensionEvent {
     }
 }
 export const iconNames = {
-    success: 'success',
-    remove: 'remove',
     add: 'add',
+    appointment: 'appointment',
+    approvals: 'approvals',
+    artificialIntelligence: 'artificialIntelligence',
+    artificialIntelligenceEnhanced: 'artificialIntelligenceEnhanced',
     attach: 'attach',
-    date: 'date',
+    bank: 'bank',
+    block: 'block',
+    book: 'knowledgeBase',
+    bulb: 'bulb',
+    callTranscript: 'callTranscript',
+    calling: 'calling',
+    callingHangup: 'callingHangup',
+    callingMade: 'callingMade',
+    callingMissed: 'callingMissed',
+    callingVoicemail: 'callingVoicemail',
+    campaigns: 'campaigns',
+    cap: 'cap',
+    checkCircle: 'checkCircle',
+    circleFilled: 'circleFilled',
+    circleHollow: 'circleHollow',
+    clock: 'time',
+    comment: 'comments',
+    contact: 'contacts',
     copy: 'duplicate',
+    crm: 'crm',
+    dataSync: 'dataSync',
+    date: 'date',
+    delay: 'delay',
     delete: 'delete',
+    description: 'description',
+    developerProjects: 'developerProjects',
+    documents: 'documents',
+    downCarat: 'downCarat',
+    download: 'download',
     edit: 'edit',
+    ellipses: 'ellipses',
     email: 'email',
+    emailOpen: 'emailOpen',
+    emailThreadedReplies: 'emailThreadedReplies',
+    enrichment: 'enrichment',
+    enroll: 'enroll',
     exclamation: 'exclamation',
-    question: 'question',
-    home: 'home',
-    location: 'location',
-    upCarat: 'upCarat',
-    downCarat: 'downCarat',
-    warning: 'warning',
-    shoppingCart: 'cart',
-    clock: 'time',
-    comment: 'comments',
-    contact: 'contacts',
-    star: 'favorite',
-    file: 'file',
-    reports: 'reports',
-    video: 'video',
-    robot: 'simpleBot',
-    refresh: 'refresh',
+    exclamationCircle: 'exclamationCircle',
     faceHappy: 'emoji',
+    faceHappyFilled: 'emojiFillHappy',
     faceNeutral: 'emojiLineNeutral',
+    faceNeutralFilled: 'emojiFillNeutral',
     faceSad: 'emojiLineSad',
-    upload: 'upload',
-    download: 'download',
-    left: 'left',
-    right: 'right',
-    dataSync: 'dataSync',
-    imageGallery: 'imageGallery',
-    search: 'search',
-    save: 'saveEditableView',
-    notification: 'notification',
-    bulb: 'bulb',
-    settings: 'settings',
+    faceSadFilled: 'emojiFillSad',
+    facebook: 'socialBlockFacebook',
+    favoriteHollow: 'favoriteHollow',
+    file: 'file',
+    filledXCircleIcon: 'filledXCircleIcon',
     filter: 'filter',
+    flame: 'highlyEngagedLead',
+    folder: 'folder',
+    folderOpen: 'folderOpen',
+    forward: 'forward',
     gauge: 'gauge',
-    enroll: 'enroll',
     generateChart: 'generateChart',
     gift: 'gift',
-    flame: 'highlyEngagedLead',
-    inbox: 'inbox',
+    globe: 'language',
+    globeLine: 'globe',
+    goal: 'goal',
+    googlePlus: 'socialBlockGoogleplus',
+    guidedActions: 'guidedActions',
+    hash: 'numericDataType',
+    hide: 'hide',
+    home: 'home',
+    hubDB: 'hubDB',
     image: 'insertImage',
-    quote: 'insertQuote',
+    imageGallery: 'imageGallery',
+    inbox: 'inbox',
+    info: 'info',
+    infoNoCircle: 'infoNoCircle',
     insertVideo: 'insertVideo',
+    instagram: 'socialBlockInstagram',
+    integrations: 'integrations',
     invoice: 'invoice',
     key: 'key',
-    book: 'knowledgeBase',
-    globe: 'language',
+    language: 'language',
+    left: 'left',
+    lessCircle: 'lessCircle',
     lesson: 'lesson',
+    light: 'light',
     link: 'link',
+    linkedin: 'socialBlockLinkedin',
     listView: 'listView',
+    location: 'location',
     locked: 'locked',
     mention: 'mention',
     messages: 'messages',
     mobile: 'mobile',
+    moreCircle: 'moreCircle',
+    notEditable: 'notEditable',
+    notification: 'notification',
     notificationOff: 'notificationOff',
-    hash: 'numericDataType',
     objectAssociations: 'objectAssociations',
     objectAssociationsManyToMany: 'objectAssociationsManyToMany',
     objectAssociationsManyToOne: 'objectAssociationsManyToOne',
     office365: 'office365',
     order: 'order',
     paymentSubscriptions: 'paymentSubscriptions',
-    product: 'product',
+    pin: 'pin',
+    pinterest: 'socialBlockPinterest',
     powerPointFile: 'powerPointFile',
     presentation: 'presentation',
+    product: 'product',
     publish: 'publish',
+    question: 'question',
     questionAnswer: 'questionAnswer',
+    questionCircle: 'questionCircle',
     quickbooks: 'quickbooks',
+    quote: 'insertQuote',
     readMore: 'readMore',
-    realEstateListing: 'realEstateListing',
     readOnlyView: 'readOnlyView',
+    realEstateListing: 'realEstateListing',
     recentlySelected: 'recentlySelected',
     record: 'record',
     redo: 'redo',
-    undo: 'undo',
+    refresh: 'refresh',
     registration: 'registration',
+    remove: 'remove',
     replace: 'replace',
+    reports: 'reports',
+    right: 'right',
+    robot: 'simpleBot',
     rotate: 'rotate',
+    rss: 'socialBlockRss',
     salesQuote: 'salesQuote',
     salesTemplates: 'salesTemplates',
+    save: 'saveEditableView',
+    search: 'search',
+    send: 'send',
     sequences: 'sequences',
+    settings: 'settings',
+    shoppingCart: 'cart',
+    signal: 'signal',
+    signalPoor: 'signalPoor',
+    signature: 'signature',
+    snooze: 'snooze',
+    sortAlpAsc: 'sortAlpAsc',
+    sortAlpDesc: 'sortAlpDesc',
+    sortAmtAsc: 'sortAmtAsc',
+    sortAmtDesc: 'sortAmtDesc',
+    sortNumAsc: 'sortNumAsc',
+    sortNumDesc: 'sortNumDesc',
+    sortTableAsc: 'sortTableAsc',
+    sortTableDesc: 'sortTableDesc',
     spellCheck: 'spellCheck',
+    sprocket: 'sprocket',
+    star: 'favorite',
+    stopRecord: 'stopRecord',
     strike: 'strike',
+    styles: 'styles',
+    success: 'success',
     tablet: 'tablet',
     tag: 'tag',
     tasks: 'tasks',
     test: 'test',
-    ticket: 'ticket',
-    thumbsUp: 'thumbsUp',
+    text: 'text',
+    textBodyExpanded: 'textBodyExpanded',
+    textColor: 'textColor',
+    textDataType: 'textDataType',
+    textSnippet: 'textSnippet',
     thumbsDown: 'thumbsDown',
+    thumbsUp: 'thumbsUp',
+    ticket: 'ticket',
     translate: 'translate',
     trophy: 'trophy',
+    twitter: 'socialBlockTwitter',
+    undo: 'undo',
+    upCarat: 'upCarat',
+    upload: 'upload',
+    video: 'video',
     videoFile: 'videoFile',
     videoPlayerSubtitles: 'videoPlayerSubtitles',
     view: 'view',
     viewDetails: 'viewDetails',
+    warning: 'warning',
     website: 'website',
     workflows: 'workflows',
-    zoomIn: 'zoomIn',
-    zoomOut: 'zoomOut',
-    goal: 'goal',
-    campaigns: 'campaigns',
-    cap: 'cap',
-    block: 'block',
-    bank: 'bank',
-    approvals: 'approvals',
-    appointment: 'appointment',
-    facebook: 'socialBlockFacebook',
-    googlePlus: 'socialBlockGoogleplus',
-    instagram: 'socialBlockInstagram',
-    linkedin: 'socialBlockLinkedin',
-    pinterest: 'socialBlockPinterest',
-    rss: 'socialBlockRss',
-    twitter: 'socialBlockTwitter',
     x: 'socialBlockX',
+    xCircle: 'xCircle',
     xing: 'socialBlockXing',
     youtube: 'socialBlockYoutube',
     youtubePlay: 'socialBlockYoutubeplay',
-    sortAlpAsc: 'sortAlpAsc',
-    sortAlpDesc: 'sortAlpDesc',
-    sortAmtAsc: 'sortAmtAsc',
-    sortAmtDesc: 'sortAmtDesc',
-    sortNumAsc: 'sortNumAsc',
-    sortNumDesc: 'sortNumDesc',
-    sortTableAsc: 'sortTableAsc',
-    sortTableDesc: 'sortTableDesc',
-    text: 'text',
-    textColor: 'textColor',
-    textDataType: 'textDataType',
-    textSnippet: 'textSnippet',
-    calling: 'calling',
-    callingHangup: 'callingHangup',
-    callingMade: 'callingMade',
-    callingMissed: 'callingMissed',
-    callingVoicemail: 'callingVoicemail',
-    faceHappyFilled: 'emojiFillHappy',
-    faceNeutralFilled: 'emojiFillNeutral',
-    faceSadFilled: 'emojiFillSad',
+    zoomIn: 'zoomIn',
+    zoomOut: 'zoomOut',
 };
 /** @deprecated use ExtensionEvent/FormSubmitExtensionEvent instead */
 export class RemoteEvent {

package/dist/shared/types/worker-globals.d.ts

@@ -1,5 +1,6 @@
 import { Logger } from './logger.ts';
 import { HubspotExtendFunction } from './extend.ts';
+import type { ExtensionPoints, ExtensionPointApiContext, ExtensionPointApiActions } from './extension-points.ts';
 export interface WorkerGlobalsInternal {
     /**
      * A marker that the current global is a HubSpot extension worker.
@@ -14,4 +15,18 @@ export interface WorkerGlobalsInternal {
      * NOTE: `extend_V2` is used internally by `hubspot.extend` (where `hubspot` is imported from `@hubspot/ui-extensions`).
      */
     extend_V2: HubspotExtendFunction;
+    /**
+     * Namespace where all HubSpot APIs that go on the worker should live.
+     * This avoids polluting the global and reduces the possibility of customer code having collisions with our code.
+     */
+    hsWorkerAPI: {
+        /**
+         * Hook added to worker globals so customer code can access extension context at runtime.
+         */
+        useExtensionContext: <ExtensionPoint extends keyof ExtensionPoints>() => ExtensionPointApiContext<ExtensionPoint>;
+        /**
+         * Hook added to worker globals so customer code can access extension actions at runtime.
+         */
+        useExtensionActions: <ExtensionPoint extends keyof ExtensionPoints>() => ExtensionPointApiActions<ExtensionPoint>;
+    };
 }