@livetiles/reach-plugin-types 0.4.16 → 0.4.17

package/lib/index.d.ts

@@ -1496,9 +1496,19 @@ declare module "libs/reach/util/common/src/user/Subscription" {
         subscriptionId: string;
         subscriptionName: string;
     }
-    export interface PluginExtension {
-        area: string;
-        componentName: string;
+    export enum ExtensionArea {
+        global = "Global",
+        page = "Page",
+        eventEditorFeedbackSection = "EventEditorFeedbackSection",
+        eventDetailViewSection = "EventDetailViewSection",
+        itemEditor = "ItemEditor"
+    }
+    export type InlinePlugin = {
+        area: ExtensionArea.itemEditor;
+        objectButton: PluginObjectButton;
+    };
+    export type PagePlugin = {
+        area: ExtensionArea.page;
         route: string;
         navigationNode?: {
             componentName?: string;
@@ -1508,7 +1518,20 @@ declare module "libs/reach/util/common/src/user/Subscription" {
                 [key: string]: string;
             };
         };
-    }
+    };
+    export type PluginExtension = {
+        area: ExtensionArea;
+        componentName: string;
+    } & (InlinePlugin | PagePlugin);
+    export type PluginObjectButton = {
+        buttonLabel: {
+            defaultLabel: string;
+            translations?: {
+                [key: string]: string;
+            };
+        };
+        iconName: string;
+    };
     export interface PluginNotificationDefinitions {
         key: string;
         title: string;
@@ -3030,17 +3053,15 @@ declare module "libs/reach/util/common/src/Models" {
     }
 }
 declare module "libs/reach/util/common/src/plugins/usePluginExtensions" {
-    import { PluginExtension, WebPluginDefinition } from "libs/reach/util/common/src/user/Subscription";
+    import { ExtensionArea, PluginExtension, WebPluginDefinition } from "libs/reach/util/common/src/user/Subscription";
     import { PageNavigationNodeProps } from "libs/reach/util/common/src/Models";
-    export enum ExtensionArea {
-        global = "Global",
-        page = "Page",
-        eventEditorFeedbackSection = "EventEditorFeedbackSection",
-        eventDetailViewSection = "EventDetailViewSection"
-    }
     export interface PluginNavigationNodeProps {
         navigationNodeProps?: PageNavigationNodeProps;
     }
+    export type EmbeddedPluginProps = PluginProps & {
+        isEditMode?: boolean;
+        componentInstanceId: string;
+    };
     export type PluginProps = Omit<WebPluginDefinition, 'extensions'> & PluginExtension;
     type DevPlugin = {
         pluginId: string;
@@ -3094,22 +3115,11 @@ declare module "libs/reach/util/common/src/plugins/PluginWrapper" {
 }
 declare module "libs/reach/util/common/src/plugins/Plugins" {
     import { FC } from 'react';
-    import { ExtensionArea } from "libs/reach/util/common/src/plugins/usePluginExtensions";
+    import { ExtensionArea } from "libs/reach/util/common/src/user/Subscription";
     export const Plugins: FC<{
         area: ExtensionArea;
     } & any>;
 }
-declare module "libs/reach/util/common/src/plugins/index" {
-    export * from "libs/reach/util/common/src/plugins/PluginContext";
-    export * from "libs/reach/util/common/src/plugins/PluginWrapper";
-    export * from "libs/reach/util/common/src/plugins/Plugins";
-    export * from "libs/reach/util/common/src/plugins/SystemJSHelper";
-    export * from "libs/reach/util/common/src/plugins/usePluginApi";
-    export * from "libs/reach/util/common/src/plugins/usePluginExtensions";
-    export * from "libs/reach/util/common/src/plugins/usePluginDeviceStore";
-    export * from "libs/reach/util/common/src/plugins/usePluginSubscriptionStore";
-    export * from "libs/reach/util/common/src/plugins/usePluginUserStore";
-}
 declare module "libs/reach/util/common/src/theme/ColorGenerator" {
     export class Color {
         private r;
@@ -3326,6 +3336,25 @@ declare module "libs/reach/util/common/src/Variables" {
     export const managePagesRowHeight = 40;
     export const mobilePreviewWidth = 414;
 }
+declare module "libs/reach/util/common/src/plugins/Plugin" {
+    import { FC } from 'react';
+    import { PluginProps } from "libs/reach/util/common/src/plugins/usePluginExtensions";
+    export const Plugin: FC<PluginProps & {
+        showDetailedErrorMessage?: boolean;
+    } & any>;
+}
+declare module "libs/reach/util/common/src/plugins/index" {
+    export * from "libs/reach/util/common/src/plugins/PluginContext";
+    export * from "libs/reach/util/common/src/plugins/PluginWrapper";
+    export * from "libs/reach/util/common/src/plugins/Plugins";
+    export * from "libs/reach/util/common/src/plugins/Plugin";
+    export * from "libs/reach/util/common/src/plugins/SystemJSHelper";
+    export * from "libs/reach/util/common/src/plugins/usePluginApi";
+    export * from "libs/reach/util/common/src/plugins/usePluginExtensions";
+    export * from "libs/reach/util/common/src/plugins/usePluginDeviceStore";
+    export * from "libs/reach/util/common/src/plugins/usePluginSubscriptionStore";
+    export * from "libs/reach/util/common/src/plugins/usePluginUserStore";
+}
 declare module "libs/reach/util/common/src/notification/NotificationContext" {
     import { FC, ReactNode } from 'react';
     import { ToastOptions } from 'react-toastify';
@@ -3681,7 +3710,7 @@ declare module "libs/reach/ui/common/src/PeoplePicker" {
     export const PeoplePicker: FC<Props>;
 }
 declare module "libs/reach/ui/common/src/plugins/reach-core" {
-    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";
+    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";
     import { LinkContext, ResourceContext } from "libs/reach/util/context/src/index";
     import { useAuthenticationContext } from "libs/shared/util/authentication/src/index";
     import { createId, logger } from "libs/shared/util/common/src/index";
@@ -3698,7 +3727,7 @@ declare module "libs/reach/ui/common/src/plugins/reach-core" {
      * @deprecated Please use `usePluginDeviceStore` instead
      */
     usePluginDeviceStore as usePluginStorage, usePluginDeviceStore, usePluginSubscriptionStore, usePluginSubscriptionStoreValue, usePluginUserStore, usePluginUserStoreValue, useReachApiEndPoints, AccountType, PeoplePicker, GutterToggle, EditorSettingsDialogWithFixedWidth as EditorSettingsDialog, Spinner, SelectionMode, EditorHighlight, useTheme, useSubscriptionHandlePathBuilder, useSubscriptionWebAppUrl, };
-    export type { Account, PluginNavigationNodeProps, PluginProps, PluginStorage, PluginStore, };
+    export type { Account, PluginNavigationNodeProps, PluginProps, PluginStorage, PluginStore, EmbeddedPluginProps, };
 }
 declare module "libs/reach/ui/common/src/content-keyword-utils" {
     import { CurrentUser, Keyword, KeywordGroup, KeywordsByGroupId } from "libs/reach/util/common/src/index";
@@ -7974,7 +8003,8 @@ declare module "libs/reach/feature/content/src/common/body/TextViewer" {
         Contact = "contact",
         InlinePageList = "inline-page-list",
         UrlPreview = "url-preview",
-        ActionButton = "action-button"
+        ActionButton = "action-button",
+        InlinePlugin = "inline-plugin"
     }
     export interface HtmlComponentMapper {
         component: FC<any>;
@@ -9278,6 +9308,10 @@ declare module "libs/reach/feature/content/src/common/body/InlineActionButtonLis
     }
     export const InlineActionButtonMapper: HtmlComponentMapper;
 }
+declare module "libs/reach/feature/content/src/common/body/InlineObjectPluginView" {
+    import { HtmlComponentMapper } from "libs/reach/feature/content/src/common/body/TextViewer";
+    export const InlineObjectPluginMapper: HtmlComponentMapper;
+}
 declare module "libs/reach/feature/content/src/common/detail/events/controls/EventDetailViewPeopleInfo" {
     import { FC } from 'react';
     export const EventDetailViewPeopleInfo: FC;
@@ -10011,6 +10045,13 @@ declare module "libs/reach/feature/content/src/common/hooks/useCommonEditorApi"
         getTaskViewCounts: (type: ItemResourceTypes, groupId?: string) => Promise<TaskSummary>;
     };
 }
+declare module "libs/reach/feature/content/src/common/hooks/useClickOutside" {
+    interface IClickHandles {
+        onInsideClick: () => void;
+        onOutsideClick: () => void;
+    }
+    export function useClickOutside<T extends HTMLElement>({ onInsideClick, onOutsideClick, }: IClickHandles): import("react").MutableRefObject<T>;
+}
 declare module "libs/reach/feature/content/src/common/sidebar/SidebarIcon" {
     import { LocationDescriptor } from 'history';
     import { FC, ReactNode } from 'react';
@@ -10179,6 +10220,7 @@ declare module "libs/reach/feature/content/src/common/index" {
     export * from "libs/reach/feature/content/src/common/body/ItemBodyWrapper";
     export * from "libs/reach/feature/content/src/common/body/InlineFileList";
     export * from "libs/reach/feature/content/src/common/body/InlineActionButtonList";
+    export * from "libs/reach/feature/content/src/common/body/InlineObjectPluginView";
     export * from "libs/reach/feature/content/src/common/body/inline-action-button/InlineActionButtonStyles";
     export * from "libs/reach/feature/content/src/common/detail/events/controls/EventMetaInfo";
     export * from "libs/reach/feature/content/src/common/detail/events/controls/EventRegistrationButton";
@@ -10232,6 +10274,7 @@ declare module "libs/reach/feature/content/src/common/index" {
     export * from "libs/reach/feature/content/src/common/hooks/useExternalContentHandler";
     export * from "libs/reach/feature/content/src/common/hooks/useCommonEditorApi";
     export * from "libs/reach/feature/content/src/common/hooks/usePageViewTracker";
+    export * from "libs/reach/feature/content/src/common/hooks/useClickOutside";
     export * from "libs/reach/feature/content/src/common/TargetLinkOverrideContext";
     export * from "libs/reach/feature/content/src/common/sidebar/BaseSidebarItem";
     export * from "libs/reach/feature/content/src/common/sidebar/SidebarGroup";

package/package.json

@@ -4,6 +4,6 @@
   "main": "",
   "types": "./index.d.ts",
   "license": "ISC",
-  "version": "0.4.16",
+  "version": "0.4.17",
   "dependencies": {}
 }