@planningcenter/topbar 7.2.2-people.0 → 7.3.0-alpha.0

package/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Changelog
 
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased notifications]
+
+### Added
+- Notification bell, indicator, and dropdown that displayes the current user's read and unread notifications. On initial load, a GET request is sent to the notifications API and its response is used to populate the unread indicator. To use dummy data instead, you can pass `useDummyNotifications={true}` when calling any `Topbar` component.
+- Subscribe to push notifications via Jolt after initial load. This is a naive implementation in that whenever a push event is received, a fresh GET request is sent to the notifications API endpoint to retrieve the current state of ALL of the user's notifications.
+- Set a baseline prettier config
+
 ## [7.2.1] - 2021-12-09
 
-### FIxed
+### Fixed
 - Bug z-stacking Safari bug that caused expanded `smalltopbar` items to show up behind elements [#46](https://github.com/ministrycentered/topbar/pull/46)
 - Bug causing user settings to be hidden on mobile when Home wasn't enabled for the user [#47](https://github.com/ministrycentered/topbar/pull/47)
 
@@ -32,7 +44,6 @@
 ### Added
 - Add Home to the app switcher dropdown
 
-
 ## [7.0.0] - 2021-10-01
 
 - Add CSRF support to login ([#46](https://github.com/planningcenter/design/pull/46) @danielma)
@@ -83,6 +94,7 @@ Versions entries to this changelog weren't tracked very well and were presented
 
 
 
+[Unreleased notifications]: https://github.com/ministrycentered/topbar/compare/@planningcenter/topbar@7.2.1..notifications
 [7.2.1]: https://github.com/ministrycentered/topbar/compare/v7.2.0..v7.2.1
 [7.2.0]: https://github.com/ministrycentered/topbar/compare/v7.1.3..v7.2.0
 [7.1.3]: https://github.com/ministrycentered/topbar/compare/v7.1.2..v7.1.3

package/dist/modules/components/NotificationsMenuBlankState.d.ts

@@ -1,7 +1,12 @@
-/// <reference types="react" />
-declare const NotificationsMenuBlankState: ({ description, style, title, ...props }: {
-    description: string;
-    style?: object;
-    title?: string;
-}) => JSX.Element;
-export default NotificationsMenuBlankState;
+/// <reference types="react" />
+declare const NotificationsMenuBlankState: ({
+  description,
+  style,
+  title,
+  ...props
+}: {
+  description: string
+  style?: object
+  title?: string
+}) => JSX.Element
+export default NotificationsMenuBlankState

package/dist/modules/components/apps_menu.d.ts

@@ -1,13 +1,9 @@
 /// <reference types="react" />
 import * as PCO_URL from "@planningcenter/url";
+import { App } from "../interfaces";
 declare const AppsMenu: ({ appName, apps, env, toggle, visible, }: {
     appName: string;
-    apps: {
-        attributes: {
-            name: string;
-            url: string;
-        };
-    }[];
+    apps: App[];
     env: PCO_URL.Environment;
     toggle: any;
     visible: boolean;

package/dist/modules/components/conditional_wrap.d.ts

@@ -1,5 +1,5 @@
 import * as React from "react";
-declare const ConditionalWrap: ({ children, condition, wrap, ...props }: {
+declare const ConditionalWrap: ({ children, condition, wrap, }: {
     children: React.ReactNode;
     condition?: boolean;
     wrap: any;

package/dist/modules/components/notification_item.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="react" />
 import { Notification } from "../interfaces";
-declare const NotificationItem: ({ mobile, isLast, onToggleRead, showBottomBorder, notification: { appName, createdAt, isRead, link, title }, }: {
+declare const NotificationItem: ({ mobile, isLast, onMarkAsRead, onToggleRead, showBottomBorder, notification, }: {
     mobile?: boolean;
     isLast?: boolean;
+    onMarkAsRead?: (notification: Notification) => any;
     onToggleRead: any;
     showBottomBorder?: boolean;
     notification: Notification;

package/dist/modules/components/notifications_inbox.d.ts

@@ -1,14 +1,18 @@
-/// <reference types="react" />
-import * as PCO_URL from "@planningcenter/url";
-import { Notification } from "../interfaces";
-declare const NotificationsInbox: ({ env, render, userId, }: {
-    env: PCO_URL.Environment;
-    render: (props: {
-        handleMarkAllAsRead: () => any;
-        handleToggleRead: (notification: Notification) => any;
-        read: Notification[];
-        unread: Notification[];
-    }) => JSX.Element;
-    userId: string;
-}) => JSX.Element;
-export default NotificationsInbox;
+/// <reference types="react" />
+import * as PCO_URL from "@planningcenter/url"
+import { Notification } from "../interfaces"
+declare const NotificationsInbox: ({
+  env,
+  render,
+  userId,
+}: {
+  env: PCO_URL.Environment
+  render: (props: {
+    handleMarkAllAsRead: () => any
+    handleToggleRead: (notification: Notification) => any
+    read: Notification[]
+    unread: Notification[]
+  }) => JSX.Element
+  userId: string
+}) => JSX.Element
+export default NotificationsInbox

package/dist/modules/components/notifications_menu.d.ts

@@ -1,9 +1,8 @@
 /// <reference types="react" />
-import * as PCO_URL from "@planningcenter/url";
 import { Notification } from "../interfaces";
-declare const NotificationsMenu: ({ env, handleMarkAllAsRead, handleToggleRead, hasError, isLoading, mobile, notifications: { read, unread }, toggle, visible, }: {
-    env: PCO_URL.Environment;
+declare const NotificationsMenu: ({ handleMarkAllAsRead, handleMarkAsRead, handleToggleRead, hasError, isLoading, mobile, notifications: { read, unread }, toggle, visible, }: {
     handleMarkAllAsRead: () => any;
+    handleMarkAsRead: (notification: Notification) => any;
     handleToggleRead: (notification: Notification) => any;
     hasError?: boolean;
     isLoading?: boolean;

package/dist/modules/components/notifications_menu_blank_state.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-declare const NotificationsMenuBlankState: ({ dark, description, style, title, ...props }: {
+declare const NotificationsMenuBlankState: ({ dark, description, style, title, }: {
     dark?: boolean;
     description: string;
     style?: object;

package/dist/modules/components/outsider.d.ts

@@ -1,7 +1,7 @@
 import * as React from "react";
 export default class Outsider extends React.Component<{
-    component: any;
     cleanup: boolean;
+    component: any;
     onOutsideClick: any;
     visible: boolean;
 }, {}> {

package/dist/modules/dummy_data.d.ts

@@ -1,3 +1,3 @@
-import { Notification } from "./interfaces";
-export declare const DUMMY_DATA_UNREAD: Notification[];
-export declare const DUMMY_DATA_READ: Notification[];
+import { Notification } from "./interfaces"
+export declare const DUMMY_DATA_UNREAD: Notification[]
+export declare const DUMMY_DATA_READ: Notification[]

package/dist/modules/formatters.d.ts

@@ -1,15 +1,3 @@
-export interface App {
-    attributes: {
-        name: string;
-        url: string;
-    };
-}
-export interface ConnectedPerson {
-    id: number;
-    attributes: {
-        name: string;
-        organization_name: string;
-    };
-}
+import { App, ConnectedPerson } from "./interfaces";
 export declare const appsMenuFormatter: (apps: App[]) => App[];
 export declare const connectedPeopleMenuFormatter: (connectedPeople: ConnectedPerson[]) => ConnectedPerson[];

package/dist/modules/hooks/use_local_storage.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+declare function useLocalStorage(
+  key: string,
+  initialValue: any
+): {
+  storedValue: any
+  setStoredValue: import("react").Dispatch<any>
+  dropKey: () => void
+}
+export default useLocalStorage

package/dist/modules/hooks/use_notifications.d.ts

@@ -1,10 +1,12 @@
 import * as PCO_URL from "@planningcenter/url";
 import { Notification } from "../interfaces";
-declare const useNotifications: ({ env, userId, }: {
+declare const useNotifications: ({ disabled, env, userId, }: {
+    disabled?: boolean;
     env: PCO_URL.Environment;
     userId: string;
 }) => {
     handleMarkAllAsRead: () => any;
+    handleMarkAsRead: (notification: Notification) => any;
     handleToggleRead: (notification: Notification) => any;
     hasError: boolean;
     isLoading: boolean;

package/dist/modules/hooks/use_topbar_api.d.ts

@@ -0,0 +1,8 @@
+import * as PCO_URL from "@planningcenter/url";
+import { Fetch } from "../api_request";
+import { TopbarAPIResponse } from "../interfaces";
+declare const useTopbarAPI: ({ configuredFetch, env, }: {
+    configuredFetch: Fetch;
+    env: PCO_URL.Environment;
+}) => TopbarAPIResponse;
+export default useTopbarAPI;

package/dist/modules/topbar_context.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+declare const _default: import("react").Context<{
+    notificationsDisabled: boolean;
+}>;
+export default _default;