@hubspot/ui-extensions 0.8.1 → 0.8.3

package/dist/coreComponents.d.ts

@@ -211,3 +211,24 @@ export declare const Checkbox: "Checkbox" & {
     readonly props?: types.CheckboxProps | undefined;
     readonly children?: true | undefined;
 } & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Checkbox", types.CheckboxProps, true>>;
+export declare const RadioButton: "RadioButton" & {
+    readonly type?: "RadioButton" | undefined;
+    readonly props?: types.RadioButtonProps | undefined;
+    readonly children?: true | undefined;
+} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"RadioButton", types.RadioButtonProps, true>>;
+export declare const List: "List" & {
+    readonly type?: "List" | undefined;
+    readonly props?: types.ListProps | undefined;
+    readonly children?: true | undefined;
+} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"List", types.ListProps, true>>;
+export declare const Toggle: "Toggle" & {
+    readonly type?: "Toggle" | undefined;
+    readonly props?: types.ToggleProps | undefined;
+    readonly children?: true | undefined;
+} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Toggle", types.ToggleProps, true>>;
+/** @experimental */
+export declare const Panel: "Panel" & {
+    readonly type?: "Panel" | undefined;
+    readonly props?: types.PanelProps | undefined;
+    readonly children?: true | undefined;
+} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Panel", types.PanelProps, true>>;

package/dist/coreComponents.js

@@ -45,3 +45,10 @@ export const MultiSelect = createRemoteReactComponent('MultiSelect');
 export const Flex = createRemoteReactComponent('Flex');
 export const DateInput = createRemoteReactComponent('DateInput');
 export const Checkbox = createRemoteReactComponent('Checkbox');
+export const RadioButton = createRemoteReactComponent('RadioButton');
+export const List = createRemoteReactComponent('List');
+export const Toggle = createRemoteReactComponent('Toggle');
+/** @experimental */
+export const Panel = createRemoteReactComponent('Panel', {
+    fragmentProps: ['footer'],
+});

package/dist/crm/components.d.ts

@@ -1,4 +1,4 @@
-import { CrmAssociationPivotProps, CrmAssociationTableProps, CrmDataHighlightProps, CrmObjectPropertyProps, CrmPropertyListProps, CrmReportProps, CrmAssociationPropertyListProps, CrmStageTrackerProps, CrmActionButtonProps, CrmActionLinkProps, CrmCardActionsProps } from '../types';
+import { CrmAssociationPivotProps, CrmAssociationTableProps, CrmDataHighlightProps, CrmObjectPropertyProps, CrmPropertyListProps, CrmReportProps, CrmAssociationPropertyListProps, CrmStageTrackerProps, CrmStatisticsProps, CrmActionButtonProps, CrmActionLinkProps, CrmCardActionsProps } from '../types';
 declare const CrmObjectProperty: "CrmObjectProperty" & {
     readonly type?: "CrmObjectProperty" | undefined;
     readonly props?: CrmObjectPropertyProps | undefined;
@@ -39,6 +39,11 @@ declare const CrmStageTracker: "CrmStageTracker" & {
     readonly props?: CrmStageTrackerProps | undefined;
     readonly children?: true | undefined;
 } & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"CrmStageTracker", CrmStageTrackerProps, true>>;
+declare const CrmStatistics: "CrmStatistics" & {
+    readonly type?: "CrmStatistics" | undefined;
+    readonly props?: CrmStatisticsProps | undefined;
+    readonly children?: true | undefined;
+} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"CrmStatistics", CrmStatisticsProps, true>>;
 declare const CrmActionButton: "CrmActionButton" & {
     readonly type?: "CrmActionButton" | undefined;
     readonly props?: CrmActionButtonProps | undefined;
@@ -54,4 +59,4 @@ declare const CrmCardActions: "CrmCardActions" & {
     readonly props?: CrmCardActionsProps | undefined;
     readonly children?: true | undefined;
 } & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"CrmCardActions", CrmCardActionsProps, true>>;
-export { CrmObjectProperty, CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmAssociationPropertyList, CrmStageTracker, CrmActionButton, CrmActionLink, CrmCardActions, };
+export { CrmObjectProperty, CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmAssociationPropertyList, CrmStageTracker, CrmStatistics, CrmActionButton, CrmActionLink, CrmCardActions, };

package/dist/crm/components.js

@@ -7,7 +7,8 @@ const CrmReport = createExtensionComponent('CrmReport');
 const CrmAssociationPivot = createExtensionComponent('CrmAssociationPivot');
 const CrmAssociationPropertyList = createExtensionComponent('CrmAssociationPropertyList');
 const CrmStageTracker = createExtensionComponent('CrmStageTracker');
+const CrmStatistics = createExtensionComponent('CrmStatistics');
 const CrmActionButton = createExtensionComponent('CrmActionButton');
 const CrmActionLink = createExtensionComponent('CrmActionLink');
 const CrmCardActions = createExtensionComponent('CrmCardActions');
-export { CrmObjectProperty, CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmAssociationPropertyList, CrmStageTracker, CrmActionButton, CrmActionLink, CrmCardActions, };
+export { CrmObjectProperty, CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmAssociationPropertyList, CrmStageTracker, CrmStatistics, CrmActionButton, CrmActionLink, CrmCardActions, };

package/dist/crm/index.d.ts

@@ -1,2 +1,2 @@
-import { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmActionButton, CrmActionLink, CrmCardActions } from './components';
-export { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmActionButton, CrmActionLink, CrmCardActions, };
+import { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmStatistics, CrmActionButton, CrmActionLink, CrmCardActions } from './components';
+export { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmStatistics, CrmActionButton, CrmActionLink, CrmCardActions, };

package/dist/crm/index.js

@@ -1,2 +1,2 @@
-import { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmActionButton, CrmActionLink, CrmCardActions, } from './components';
-export { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmActionButton, CrmActionLink, CrmCardActions, };
+import { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmStatistics, CrmActionButton, CrmActionLink, CrmCardActions, } from './components';
+export { CrmPropertyList, CrmAssociationTable, CrmDataHighlight, CrmReport, CrmAssociationPivot, CrmObjectProperty, CrmAssociationPropertyList, CrmStageTracker, CrmStatistics, CrmActionButton, CrmActionLink, CrmCardActions, };

package/dist/types.d.ts

@@ -365,10 +365,16 @@ interface BaseInputProps<T = string, V = string> {
 /**
  * The props type for {@link !components.Input}.
  *
- * @interface
  * @category Component Props
  */
-export type InputProps = BaseInputProps;
+export interface InputProps extends BaseInputProps {
+    /**
+     * Sets the type of input to render.
+     *
+     * @defaultValue `"text"`
+     */
+    type?: 'text' | 'password';
+}
 /**
  * The props type for {@link !components.TextArea}.
  *
@@ -787,14 +793,19 @@ interface Team {
     name: string;
     teammates: number[];
 }
+/**
+ * The props type for {@link !components.Checkbox}.
+ *
+ * @category Component Props
+ */
 export interface CheckboxProps {
     /**
-     * A string representing the value of the checkbox. This is not displayed on the client-side,
+     * A string representing the value of the input. This is not displayed on the client-side,
      * but on the server this is the value given to the data submitted with the checkbox's name.
      */
     value?: string;
     /**
-     * The current status of the checkbox.
+     * The current status of the input.
      */
     checked?: boolean;
     /**
@@ -816,7 +827,7 @@ export interface CheckboxProps {
      */
     variant?: 'default' | 'small';
     /**
-     * A function that is called with the checkbox status changes.
+     * A function that is called when the `checked` input status changes.
      *
      * @event
      */
@@ -828,7 +839,8 @@ export interface CheckboxProps {
      */
     inline?: boolean;
     /**
-     * When set to `true`, the option will be selected by default.
+     * When set to `true`, the option will be selected by default. Use it to
+     * set the default `checked` state when the component is **uncontrolled**.
      */
     initialIsChecked?: boolean;
     /**
@@ -836,6 +848,12 @@ export interface CheckboxProps {
      */
     'aria-label'?: string;
 }
+/**
+ * The props type for {@link !components.RadioButton}.
+ * @category Component Props
+ * @interface
+ */
+export type RadioButtonProps = Omit<CheckboxProps, 'aria-label'>;
 export type ToggleGroupOption = {
     /** The text that displays in the dropdown menu. */
     label: string;
@@ -969,10 +987,24 @@ export interface PortalContext {
     timezone: string;
 }
 /** @ignore */
-export interface Context {
+export interface CrmRecordContext {
+    objectId: number;
+    objectTypeId: string;
+}
+/** @ignore */
+export interface BaseContext {
     user: UserContext;
     portal: PortalContext;
 }
+/** @ignore */
+export interface CrmContext extends BaseContext {
+    location: 'crm.record.tab' | 'crm.record.sidebar';
+    crm: CrmRecordContext;
+}
+/** @ignore */
+export interface GenericContext extends BaseContext {
+    location: 'uie.playground.middle';
+}
 export interface StackProps {
     distance?: AllDistances;
     children?: React.ReactNode;
@@ -1184,6 +1216,7 @@ export interface ExtensionPointContract {
     actions?: {
         [k: string]: ExtensionPointAction;
     } | {};
+    context: BaseContext;
     customComponents: Record<string, ComponentType<any>>;
 }
 /** @ignore */
@@ -1200,22 +1233,27 @@ export type FetchCrmObjectPropertiesAction = (properties: string[]) => Promise<R
 /** @ignore */
 export type OpenIframeModalAction = (action: OpenIframeActionPayload) => void;
 /** @ignore */
+export type refreshObjectPropertiesAction = () => void;
+/** @ignore */
 export interface CrmMiddleExtensionPoint extends ExtensionPointContract {
     actions: {
         addAlert: AddAlertAction;
         reloadPage: ReloadPageAction;
         fetchCrmObjectProperties: FetchCrmObjectPropertiesAction;
         openIframeModal: OpenIframeModalAction;
+        refreshObjectProperties?: refreshObjectPropertiesAction;
     };
+    context: CrmContext;
     customComponents: {
         CrmPropertyList: ComponentType<CrmPropertyListProps>;
         CrmAssociationTable: ComponentType<CrmAssociationTableProps>;
         CrmDataHighlight: ComponentType<CrmDataHighlightProps>;
         CrmReport: ComponentType<CrmReportProps>;
         CrmAssociationPivot: ComponentType<CrmAssociationPivotProps>;
-        CrmObjectProperty?: ComponentType<CrmObjectPropertyProps>;
-        CrmAssociationPropertyList?: ComponentType<CrmAssociationPropertyListProps>;
-        CrmStageTracker?: ComponentType<CrmStageTrackerProps>;
+        CrmObjectProperty: ComponentType<CrmObjectPropertyProps>;
+        CrmAssociationPropertyList: ComponentType<CrmAssociationPropertyListProps>;
+        CrmStageTracker: ComponentType<CrmStageTrackerProps>;
+        CrmStatistics?: ComponentType<CrmStatisticsProps>;
         CrmActionButton?: ComponentType<CrmActionButtonProps>;
         CrmActionLink?: ComponentType<CrmActionLinkProps>;
         CrmCardActions?: ComponentType<CrmCardActionsProps>;
@@ -1228,7 +1266,9 @@ export interface CrmSidebarExtensionPoint extends ExtensionPointContract {
         reloadPage: ReloadPageAction;
         fetchCrmObjectProperties: FetchCrmObjectPropertiesAction;
         openIframeModal: OpenIframeModalAction;
+        refreshObjectProperties?: refreshObjectPropertiesAction;
     };
+    context: CrmContext;
     customComponents: {
         [k: string]: never;
     };
@@ -1305,6 +1345,34 @@ export interface CrmStageTrackerProps {
     showProperties?: boolean;
 }
 /** @ignore */
+interface BaseCrmStatisticItem {
+    label: string;
+}
+/** @ignore */
+interface FilterGroup {
+    filters: Array<CrmSearchFilter>;
+}
+/** @ignore */
+interface BasicMetricItem extends BaseCrmStatisticItem {
+    statisticType: 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'DISTINCT_APPROX' | 'COUNT';
+    propertyName: string;
+    filterGroups?: Array<FilterGroup>;
+}
+/** @ignore */
+interface PercentileMetricItem extends BaseCrmStatisticItem {
+    statisticType: 'PERCENTILES';
+    propertyName: string;
+    percentile: number;
+    filterGroups?: Array<FilterGroup>;
+}
+/** @ignore */
+type CrmStatisticItem = BasicMetricItem | PercentileMetricItem;
+/** @ignore */
+export interface CrmStatisticsProps {
+    objectTypeId: string;
+    statistics: Array<CrmStatisticItem>;
+}
+/** @ignore */
 interface ObjectCoordinates {
     objectTypeId: string;
     objectId: number;
@@ -1386,6 +1454,7 @@ interface RemotePlaygroundExtensionPoint extends ExtensionPointContract {
     actions: {
         warn: () => void;
     };
+    context: GenericContext;
     customComponents: {
         ExampleCrmComponent: ComponentType<ExampleCrmComponentProps>;
     };
@@ -1402,10 +1471,17 @@ export interface ExampleCrmComponentProps {
     count: number;
 }
 /** @ignore */
+export type PanelAction = (panelId: string) => void;
+/** @ignore */
+export interface GlobalActions {
+    openPanel: PanelAction;
+    closePanel: PanelAction;
+}
+/** @ignore */
 export interface ExtensionPointApi<ExtensionPointName extends keyof ExtensionPoints> {
-    context: Context;
     runServerlessFunction: ServerlessFuncRunner;
-    actions: ExtensionPoints[ExtensionPointName]['actions'];
+    actions: ExtensionPoints[ExtensionPointName]['actions'] & GlobalActions;
+    context: ExtensionPoints[ExtensionPointName]['context'];
 }
 /** @ignore */
 interface OpenIframeActionPayload {
@@ -1751,4 +1827,135 @@ export interface AccordionProps {
      */
     onClick?: () => void;
 }
+/**
+ * The props type for {@link !components.List}.
+ *
+ * @category Component Props
+ */
+export interface ListProps {
+    /**
+     * The content of the list. Each child will be wrapped in an `li` tag.
+     */
+    children: ReactNode;
+    /**
+     * The type of list to render.
+     *
+     * @defaultValue `"unordered"`
+     */
+    variant?: 'unordered' | 'unordered-styled' | 'ordered' | 'ordered-styled' | 'inline' | 'inline-divided';
+}
+/**
+ * The props type for {@link !components.Toggle}.
+ *
+ * @category Component Props
+ */
+export interface ToggleProps {
+    /**
+     * The current status of the input.
+     */
+    checked?: boolean;
+    /**
+     * When set to `true`, the option cannot be selected.
+     */
+    readonly?: boolean;
+    /**
+     * The unique identifier for the toggle element.
+     */
+    name?: string;
+    /**
+     * The size variation of the toggle.
+     *
+     * @defaultValue `"default"`
+     */
+    size?: TShirtSizes['sm'] | TShirtSizes['xs'] | 'default';
+    /**
+     * A function that is called when the `checked` input status changes.
+     *
+     * @event
+     */
+    onChange?: (checked: boolean) => void;
+    /**
+     * When set to `true`, the option will be selected by default. Use it to
+     * set the default `checked` state when the component is **uncontrolled**.
+     */
+    initialIsChecked?: boolean;
+    /**
+     * The companion text of for Toggle. It can be displayed on top,
+     * inline, or hidden. When hidden, it will remain usable for screen readers.
+     */
+    label: string;
+    /**
+     * Controls the display setting of the label prop.
+     *
+     * @defaultValue `"inline"`
+     */
+    labelDisplay?: 'inline' | 'top' | 'hidden';
+    /**
+     * The text that appears on the Toggle when `checked={true}`.
+     *
+     * @defaultValue `"ON"`
+     */
+    textChecked?: string;
+    /**
+     * The text that appears on the Toggle when `checked={false}`.
+     *
+     * @defaultValue `"ON"`
+     */
+    textUnchecked?: string;
+}
+export interface PanelProps {
+    /**
+     * Accessibility label.
+     *
+     */
+    'aria-label'?: string;
+    /**
+     * The main content of the panel when it opens.
+     *
+     */
+    children?: React.ReactNode;
+    /**
+     * A unique ID for the panel
+     *
+     */
+    id: string;
+    /**
+     * A function that will be invoked when the panel has finished opening.
+     *
+     */
+    onOpen?: () => void;
+    /**
+     * A function that will be invoked when the panel has finished closing.
+     *
+     */
+    onClose?: () => void;
+    /**
+     * The width of the panel
+     *
+     * @defaultValue `"sm"`
+     */
+    width?: TShirtSizes['sm'] | TShirtSizes['md'] | TShirtSizes['lg'];
+    /**
+     * The title of the panel
+     *
+     */
+    title?: string;
+    /**
+     * The Footer of the panel
+     *
+     */
+    footer?: React.ReactNode;
+    /**
+     * When set to `true`, the table will not have side padding.
+     *
+     * @defaultValue `false`
+     */
+    flush?: boolean;
+    /**
+     * The variant of the panel
+     *
+     * @defaultValue `"default"`
+     */
+    variant?: 'modal' | 'default';
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -50,5 +50,5 @@
   "devDependencies": {
     "typescript": "5.0.4"
   },
-  "gitHead": "5fd5fe43bc0b09750653dd7121d56bf0d60788bb"
+  "gitHead": "ab25629916c542f19bf8cde83a10ad8bd225078f"
 }