@livetiles/reach-plugin-types 0.5.0-preview.79 → 0.5.0-preview.82

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/lib/index.d.ts +70 -26
  2. package/package.json +1 -1
package/lib/index.d.ts CHANGED
@@ -1502,9 +1502,19 @@ declare module "libs/reach/util/common/src/user/Subscription" {
1502
1502
  subscriptionId: string;
1503
1503
  subscriptionName: string;
1504
1504
  }
1505
- export interface PluginExtension {
1506
- area: string;
1507
- componentName: string;
1505
+ export enum ExtensionArea {
1506
+ global = "Global",
1507
+ page = "Page",
1508
+ eventEditorFeedbackSection = "EventEditorFeedbackSection",
1509
+ eventDetailViewSection = "EventDetailViewSection",
1510
+ itemEditor = "ItemEditor"
1511
+ }
1512
+ export type InlinePlugin = {
1513
+ area: ExtensionArea.itemEditor;
1514
+ objectButton: PluginObjectButton;
1515
+ };
1516
+ export type PagePlugin = {
1517
+ area: ExtensionArea.page;
1508
1518
  route: string;
1509
1519
  navigationNode?: {
1510
1520
  componentName?: string;
@@ -1514,7 +1524,20 @@ declare module "libs/reach/util/common/src/user/Subscription" {
1514
1524
  [key: string]: string;
1515
1525
  };
1516
1526
  };
1517
- }
1527
+ };
1528
+ export type PluginExtension = {
1529
+ area: ExtensionArea;
1530
+ componentName: string;
1531
+ } & (InlinePlugin | PagePlugin);
1532
+ export type PluginObjectButton = {
1533
+ buttonLabel: {
1534
+ defaultLabel: string;
1535
+ translations?: {
1536
+ [key: string]: string;
1537
+ };
1538
+ };
1539
+ iconName: string;
1540
+ };
1518
1541
  export interface PluginNotificationDefinitions {
1519
1542
  key: string;
1520
1543
  title: string;
@@ -3048,17 +3071,15 @@ declare module "libs/reach/util/common/src/Models" {
3048
3071
  }
3049
3072
  }
3050
3073
  declare module "libs/reach/util/common/src/plugins/usePluginExtensions" {
3051
- import { PluginExtension, WebPluginDefinition } from "libs/reach/util/common/src/user/Subscription";
3074
+ import { ExtensionArea, PluginExtension, WebPluginDefinition } from "libs/reach/util/common/src/user/Subscription";
3052
3075
  import { PageNavigationNodeProps } from "libs/reach/util/common/src/Models";
3053
- export enum ExtensionArea {
3054
- global = "Global",
3055
- page = "Page",
3056
- eventEditorFeedbackSection = "EventEditorFeedbackSection",
3057
- eventDetailViewSection = "EventDetailViewSection"
3058
- }
3059
3076
  export interface PluginNavigationNodeProps {
3060
3077
  navigationNodeProps?: PageNavigationNodeProps;
3061
3078
  }
3079
+ export type EmbeddedPluginProps = PluginProps & {
3080
+ isEditMode?: boolean;
3081
+ componentInstanceId: string;
3082
+ };
3062
3083
  export type PluginProps = Omit<WebPluginDefinition, 'extensions'> & PluginExtension;
3063
3084
  type DevPlugin = {
3064
3085
  pluginId: string;
@@ -3112,22 +3133,11 @@ declare module "libs/reach/util/common/src/plugins/PluginWrapper" {
3112
3133
  }
3113
3134
  declare module "libs/reach/util/common/src/plugins/Plugins" {
3114
3135
  import { FC } from 'react';
3115
- import { ExtensionArea } from "libs/reach/util/common/src/plugins/usePluginExtensions";
3136
+ import { ExtensionArea } from "libs/reach/util/common/src/user/Subscription";
3116
3137
  export const Plugins: FC<{
3117
3138
  area: ExtensionArea;
3118
3139
  } & any>;
3119
3140
  }
3120
- declare module "libs/reach/util/common/src/plugins/index" {
3121
- export * from "libs/reach/util/common/src/plugins/PluginContext";
3122
- export * from "libs/reach/util/common/src/plugins/PluginWrapper";
3123
- export * from "libs/reach/util/common/src/plugins/Plugins";
3124
- export * from "libs/reach/util/common/src/plugins/SystemJSHelper";
3125
- export * from "libs/reach/util/common/src/plugins/usePluginApi";
3126
- export * from "libs/reach/util/common/src/plugins/usePluginExtensions";
3127
- export * from "libs/reach/util/common/src/plugins/usePluginDeviceStore";
3128
- export * from "libs/reach/util/common/src/plugins/usePluginSubscriptionStore";
3129
- export * from "libs/reach/util/common/src/plugins/usePluginUserStore";
3130
- }
3131
3141
  declare module "libs/reach/util/common/src/theme/ColorGenerator" {
3132
3142
  export class Color {
3133
3143
  private r;
@@ -3344,6 +3354,25 @@ declare module "libs/reach/util/common/src/Variables" {
3344
3354
  export const managePagesRowHeight = 40;
3345
3355
  export const mobilePreviewWidth = 414;
3346
3356
  }
3357
+ declare module "libs/reach/util/common/src/plugins/Plugin" {
3358
+ import { FC } from 'react';
3359
+ import { PluginProps } from "libs/reach/util/common/src/plugins/usePluginExtensions";
3360
+ export const Plugin: FC<PluginProps & {
3361
+ showDetailedErrorMessage?: boolean;
3362
+ } & any>;
3363
+ }
3364
+ declare module "libs/reach/util/common/src/plugins/index" {
3365
+ export * from "libs/reach/util/common/src/plugins/PluginContext";
3366
+ export * from "libs/reach/util/common/src/plugins/PluginWrapper";
3367
+ export * from "libs/reach/util/common/src/plugins/Plugins";
3368
+ export * from "libs/reach/util/common/src/plugins/Plugin";
3369
+ export * from "libs/reach/util/common/src/plugins/SystemJSHelper";
3370
+ export * from "libs/reach/util/common/src/plugins/usePluginApi";
3371
+ export * from "libs/reach/util/common/src/plugins/usePluginExtensions";
3372
+ export * from "libs/reach/util/common/src/plugins/usePluginDeviceStore";
3373
+ export * from "libs/reach/util/common/src/plugins/usePluginSubscriptionStore";
3374
+ export * from "libs/reach/util/common/src/plugins/usePluginUserStore";
3375
+ }
3347
3376
  declare module "libs/reach/util/common/src/notification/NotificationContext" {
3348
3377
  import { FC, ReactNode } from 'react';
3349
3378
  import { ToastOptions } from 'react-toastify';
@@ -3699,7 +3728,7 @@ declare module "libs/reach/ui/common/src/PeoplePicker" {
3699
3728
  export const PeoplePicker: FC<Props>;
3700
3729
  }
3701
3730
  declare module "libs/reach/ui/common/src/plugins/reach-core" {
3702
- import { Account, AccountType, PluginNavigationNodeProps, PluginProps, PluginStorage, PluginStore, useAccountApi, useCurrentUser, useNotificationContext, usePluginDeviceStore, usePluginSettings, usePluginSubscriptionStore, usePluginSubscriptionStoreValue, usePluginUserStore, usePluginUserStoreValue, useReachApiEndPoints, useSubscriptionHandlePathBuilder, useSubscriptionWebAppUrl, useTheme } from "libs/reach/util/common/src/index";
3731
+ import { Account, AccountType, PluginNavigationNodeProps, PluginProps, PluginStorage, PluginStore, useAccountApi, useCurrentUser, useNotificationContext, usePluginDeviceStore, usePluginSettings, usePluginSubscriptionStore, usePluginSubscriptionStoreValue, usePluginUserStore, usePluginUserStoreValue, useReachApiEndPoints, useSubscriptionHandlePathBuilder, useSubscriptionWebAppUrl, useTheme, EmbeddedPluginProps } from "libs/reach/util/common/src/index";
3703
3732
  import { LinkContext, ResourceContext } from "libs/reach/util/context/src/index";
3704
3733
  import { useAuthenticationContext } from "libs/shared/util/authentication/src/index";
3705
3734
  import { createId, logger } from "libs/shared/util/common/src/index";
@@ -3716,7 +3745,7 @@ declare module "libs/reach/ui/common/src/plugins/reach-core" {
3716
3745
  * @deprecated Please use `usePluginDeviceStore` instead
3717
3746
  */
3718
3747
  usePluginDeviceStore as usePluginStorage, usePluginDeviceStore, usePluginSubscriptionStore, usePluginSubscriptionStoreValue, usePluginUserStore, usePluginUserStoreValue, useReachApiEndPoints, AccountType, PeoplePicker, GutterToggle, EditorSettingsDialogWithFixedWidth as EditorSettingsDialog, Spinner, SelectionMode, EditorHighlight, useTheme, useSubscriptionHandlePathBuilder, useSubscriptionWebAppUrl, };
3719
- export type { Account, PluginNavigationNodeProps, PluginProps, PluginStorage, PluginStore, };
3748
+ export type { Account, PluginNavigationNodeProps, PluginProps, PluginStorage, PluginStore, EmbeddedPluginProps, };
3720
3749
  }
3721
3750
  declare module "libs/reach/ui/common/src/content-keyword-utils" {
3722
3751
  import { CurrentUser, Keyword, KeywordGroup, KeywordsByGroupId } from "libs/reach/util/common/src/index";
@@ -7992,7 +8021,8 @@ declare module "libs/reach/feature/content/src/common/body/TextViewer" {
7992
8021
  Contact = "contact",
7993
8022
  InlinePageList = "inline-page-list",
7994
8023
  UrlPreview = "url-preview",
7995
- ActionButton = "action-button"
8024
+ ActionButton = "action-button",
8025
+ InlinePlugin = "inline-plugin"
7996
8026
  }
7997
8027
  export interface HtmlComponentMapper {
7998
8028
  component: FC<any>;
@@ -8137,6 +8167,7 @@ declare module "libs/reach/feature/content/src/common/item-tile/Title" {
8137
8167
  enableModalRouting?: boolean;
8138
8168
  itemId?: string;
8139
8169
  isOverrideLink: boolean;
8170
+ icon?: string;
8140
8171
  }>;
8141
8172
  }
8142
8173
  declare module "libs/reach/feature/content/src/common/breadcrumb/utils" {
@@ -9302,6 +9333,10 @@ declare module "libs/reach/feature/content/src/common/body/InlineActionButtonLis
9302
9333
  }
9303
9334
  export const InlineActionButtonMapper: HtmlComponentMapper;
9304
9335
  }
9336
+ declare module "libs/reach/feature/content/src/common/body/InlineObjectPluginView" {
9337
+ import { HtmlComponentMapper } from "libs/reach/feature/content/src/common/body/TextViewer";
9338
+ export const InlineObjectPluginMapper: HtmlComponentMapper;
9339
+ }
9305
9340
  declare module "libs/reach/feature/content/src/common/detail/events/controls/EventDetailViewPeopleInfo" {
9306
9341
  import { FC } from 'react';
9307
9342
  export const EventDetailViewPeopleInfo: FC;
@@ -10035,6 +10070,13 @@ declare module "libs/reach/feature/content/src/common/hooks/useCommonEditorApi"
10035
10070
  getTaskViewCounts: (type: ItemResourceTypes, groupId?: string) => Promise<TaskSummary>;
10036
10071
  };
10037
10072
  }
10073
+ declare module "libs/reach/feature/content/src/common/hooks/useClickOutside" {
10074
+ interface IClickHandles {
10075
+ onInsideClick: () => void;
10076
+ onOutsideClick: () => void;
10077
+ }
10078
+ export function useClickOutside<T extends HTMLElement>({ onInsideClick, onOutsideClick, }: IClickHandles): import("react").MutableRefObject<T>;
10079
+ }
10038
10080
  declare module "libs/reach/feature/content/src/common/sidebar/SidebarIcon" {
10039
10081
  import { LocationDescriptor } from 'history';
10040
10082
  import { FC, ReactNode } from 'react';
@@ -10203,6 +10245,7 @@ declare module "libs/reach/feature/content/src/common/index" {
10203
10245
  export * from "libs/reach/feature/content/src/common/body/ItemBodyWrapper";
10204
10246
  export * from "libs/reach/feature/content/src/common/body/InlineFileList";
10205
10247
  export * from "libs/reach/feature/content/src/common/body/InlineActionButtonList";
10248
+ export * from "libs/reach/feature/content/src/common/body/InlineObjectPluginView";
10206
10249
  export * from "libs/reach/feature/content/src/common/body/inline-action-button/InlineActionButtonStyles";
10207
10250
  export * from "libs/reach/feature/content/src/common/detail/events/controls/EventMetaInfo";
10208
10251
  export * from "libs/reach/feature/content/src/common/detail/events/controls/EventRegistrationButton";
@@ -10256,6 +10299,7 @@ declare module "libs/reach/feature/content/src/common/index" {
10256
10299
  export * from "libs/reach/feature/content/src/common/hooks/useExternalContentHandler";
10257
10300
  export * from "libs/reach/feature/content/src/common/hooks/useCommonEditorApi";
10258
10301
  export * from "libs/reach/feature/content/src/common/hooks/usePageViewTracker";
10302
+ export * from "libs/reach/feature/content/src/common/hooks/useClickOutside";
10259
10303
  export * from "libs/reach/feature/content/src/common/TargetLinkOverrideContext";
10260
10304
  export * from "libs/reach/feature/content/src/common/sidebar/BaseSidebarItem";
10261
10305
  export * from "libs/reach/feature/content/src/common/sidebar/SidebarGroup";
package/package.json CHANGED
@@ -4,6 +4,6 @@
4
4
  "main": "",
5
5
  "types": "./index.d.ts",
6
6
  "license": "ISC",
7
- "version": "0.5.0-preview.79",
7
+ "version": "0.5.0-preview.82",
8
8
  "dependencies": {}
9
9
  }