@internetarchive/ia-item-navigator 0.0.0 → 0.0.2

package/src/interfaces/event-interfaces.ts

@@ -1,55 +1,48 @@
-import { TemplateResult } from 'lit-html';
-import { ModalConfig } from '@internetarchive/modal-manager';
-import { IntMenuProvider, IntMenuShortcut } from './menu-interfaces';
+import {
+  MenuProviderInterface,
+  MenuShortcutInterface,
+  MenuId,
+} from './menu-interfaces';
 
 /** Toggles Menu && Sets open panel */
-export interface IntManageSideMenuEvent extends CustomEvent {
+export interface ToggleSideMenuOpenEvent extends CustomEvent {
   type: 'updateSideMenu';
   detail: {
-    menuId: string | undefined | '';
+    menuId: MenuId | undefined | '';
     action: 'open' | 'toggle' | '';
   };
 }
 
 /** Sets open panel */
-export interface IntSetOpenMenuEvent extends CustomEvent {
+export interface ToggleSidePanelOpenEvent extends CustomEvent {
   type: 'menuTypeSelected';
   detail: {
-    id: string /** name of menu to open */;
+    id: MenuId | '';
   };
 }
 
 /** Sets menu order that is displayed */
-export interface IntSetMenuContentsEvent extends CustomEvent {
+export interface SetSideMenuContentsEvent extends CustomEvent {
   type: 'menuUpdated';
-  detail: IntMenuProvider[];
+  detail: MenuProviderInterface[];
 }
 
-/** list of shortcut configs that displays in minimized menu */
-export interface IntSetMenuShortcuts extends CustomEvent {
-  type: 'menuShortcutsUpdated';
-  detail: IntMenuShortcut[];
+/** Sets menu shortcuts that is displayed */
+export interface SetSideMenuShortcutsEvent extends CustomEvent {
+  type: 'menuUpdated';
+  detail: MenuShortcutInterface[];
 }
 
 /** Toggles fullscreen mode */
-export interface IntManageFullscreenEvent extends CustomEvent {
+export interface ManageFullscreenEvent extends CustomEvent {
   type: 'ViewportInFullScreen';
   detail: {
     isFullScreen: boolean;
   };
 }
 
-/** Toggles modal & sets contents */
-export interface IntOpenModalEvent extends CustomEvent {
-  type: 'showItemNavigatorModal';
-  detail: {
-    config: ModalConfig;
-    customModalContent: TemplateResult;
-  };
-}
-
 /** Toggles loading view */
-export interface IntLoadingStateUpdatedEvent extends CustomEvent {
+export interface loadingStateUpdatedEvent extends CustomEvent {
   type: 'loadingStateUpdated';
   detail: {
     loaded: boolean;

package/src/interfaces/menu-interfaces.ts

@@ -1,14 +1,13 @@
 import { TemplateResult } from 'lit-html';
 import { MetadataResponse } from '@internetarchive/search-service';
 
-export interface IntMenuShortcut {
+export type MenuId = string;
+export interface MenuShortcutInterface {
   icon: TemplateResult;
-  id: string;
+  id: MenuId;
 }
 
-export interface IntMenuIconAndDetails extends IntMenuShortcut {
-  icon: TemplateResult;
-  id: string;
+export interface MenuDetailsInterface extends MenuShortcutInterface {
   label: string;
   menuDetails?: TemplateResult;
   selected?: boolean;
@@ -16,11 +15,13 @@ export interface IntMenuIconAndDetails extends IntMenuShortcut {
   href?: string;
 }
 
-export interface IntProviderArgs {
+export interface MenuProviderBaseConfigInterface {
   item: MetadataResponse;
   baseHost: string;
   subPrefix: string;
+  updated?: any;
 }
-export interface IntMenuProvider
-  extends IntProviderArgs,
-    IntMenuIconAndDetails {}
+export interface MenuProviderInterface
+  extends MenuProviderBaseConfigInterface,
+    MenuDetailsInterface,
+    MenuShortcutInterface {}