@darajs/ui-notifications 0.4.8

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2023 Impulse Innovations Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { NotificationPayload } from './notification-payload';
+export { default as NotificationWrapper, NotificationContext } from './notification-wrapper';
+export { useNotifications, UseNotificationsInterface } from './use-notifications';
+export { default as Notification } from './notification';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { default as NotificationWrapper, NotificationContext } from './notification-wrapper';
+export { useNotifications } from './use-notifications';
+export { default as Notification } from './notification';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAiBA,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAA6B,MAAM,qBAAqB,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/notification-payload.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Status } from '@darajs/ui-utils';
+/**
+ * The Data structure for defining a notification
+ */
+export interface NotificationPayload {
+    key: string;
+    message: string;
+    status: Status;
+    title?: string;
+}
+//# sourceMappingURL=notification-payload.d.ts.map

package/dist/notification-payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-payload.d.ts","sourceRoot":"","sources":["../src/notification-payload.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/notification-payload.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=notification-payload.js.map

package/dist/notification-payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-payload.js","sourceRoot":"","sources":["../src/notification-payload.tsx"],"names":[],"mappings":""}

package/dist/notification-wrapper.d.ts

@@ -0,0 +1,26 @@
+import * as React from 'react';
+import { Subject } from 'rxjs';
+import { NotificationPayload } from './notification-payload';
+/**
+ * The main notification context, it exposes a stream of notifications to anything wanting to consume them as well as a
+ * generic push method for sending a new one
+ * Additionally, it exposes a callback for when the notification is too small and more details are needed and clicked
+ */
+export declare const NotificationContext: React.Context<{
+    notifications$: Subject<NotificationPayload>;
+    onMoreDetailsClick: any;
+    push: (notification: NotificationPayload) => void;
+}>;
+interface NotificationWrapperProps {
+    /** Optional, pass through of the native style property */
+    style?: React.CSSProperties;
+}
+/**
+ * The notification wrapper adds an invisible container to the right hand side of the application that feeds
+ * notifications in from the bottom by subscribing to the notifications$ stream on context
+ *
+ * @param props the component props
+ */
+declare function NotificationWrapper(props: NotificationWrapperProps): JSX.Element;
+export default NotificationWrapper;
+//# sourceMappingURL=notification-wrapper.d.ts.map

package/dist/notification-wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-wrapper.d.ts","sourceRoot":"","sources":["../src/notification-wrapper.tsx"],"names":[],"mappings":"AAiBA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAO/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AA4B7D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;yBAGP,mBAAmB;EAC1C,CAAC;AAIH,UAAU,wBAAwB;IAC9B,0DAA0D;IAC1D,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CAC/B;AAED;;;;;GAKG;AACH,iBAAS,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,GAAG,GAAG,CAAC,OAAO,CA6CzE;AAED,eAAe,mBAAmB,CAAC"}

package/dist/notification-wrapper.js

@@ -0,0 +1,88 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { useCallback, useContext, useEffect, useState } from 'react';
+import * as React from 'react';
+import { Subject } from 'rxjs';
+import { delay } from 'rxjs/operators';
+import styled from '@darajs/styled-components';
+import { useSubscription } from '@darajs/ui-utils';
+import Notification from './notification';
+const Container = styled.div `
+    pointer-events: none;
+
+    position: fixed;
+    z-index: 6000;
+    right: 1rem;
+
+    display: flex;
+    flex-direction: column;
+    gap: 1rem;
+    align-items: center;
+    justify-content: flex-end;
+
+    width: 324px;
+    height: 100%;
+    padding: 0.75rem 0;
+`;
+const baseNotifications$ = new Subject();
+/**
+ * The main notification context, it exposes a stream of notifications to anything wanting to consume them as well as a
+ * generic push method for sending a new one
+ * Additionally, it exposes a callback for when the notification is too small and more details are needed and clicked
+ */
+export const NotificationContext = React.createContext({
+    notifications$: baseNotifications$,
+    onMoreDetailsClick: null,
+    push: (notification) => baseNotifications$.next(notification),
+});
+const EXPIRY = 9900; // Set to just below 10s so notifications close before polling occurs
+/**
+ * The notification wrapper adds an invisible container to the right hand side of the application that feeds
+ * notifications in from the bottom by subscribing to the notifications$ stream on context
+ *
+ * @param props the component props
+ */
+function NotificationWrapper(props) {
+    const [notifications, setNotifications] = useState([]);
+    const wrapSub = useSubscription();
+    const { notifications$, onMoreDetailsClick } = useContext(NotificationContext);
+    // Subscribe to the notifications stream and add them to the list of notifications to render
+    useEffect(() => {
+        if (notifications$) {
+            wrapSub(notifications$.subscribe({
+                next: (notification) => {
+                    setNotifications((prev) => [...prev.filter((n) => n.key !== notification.key), notification]);
+                },
+            }));
+        }
+    }, [notifications$, wrapSub]);
+    // Subscribe to the notifications stream delayed by 10s and remove notifications from the list
+    useEffect(() => {
+        wrapSub(notifications$.pipe(delay(EXPIRY)).subscribe({
+            next: (notification) => {
+                setNotifications((prev) => prev.filter(({ key }) => notification.key !== key));
+            },
+        }));
+    }, [notifications$, wrapSub]);
+    const onDismiss = useCallback((key) => {
+        setNotifications((prev) => prev.filter((notification) => notification.key !== key));
+    }, []);
+    return (_jsx(Container, { style: props.style, children: notifications.map((notification) => (_jsx(Notification, { notification: notification, onDismiss: onDismiss, onMoreDetailsClick: onMoreDetailsClick }, notification.key))) }));
+}
+export default NotificationWrapper;
+//# sourceMappingURL=notification-wrapper.js.map

package/dist/notification-wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-wrapper.js","sourceRoot":"","sources":["../src/notification-wrapper.tsx"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAG1C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAA;;;;;;;;;;;;;;;;CAgB3B,CAAC;AAQF,MAAM,kBAAkB,GAAG,IAAI,OAAO,EAAuB,CAAC;AAE9D;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,CAAC,aAAa,CAAC;IACnD,cAAc,EAAE,kBAAkB;IAClC,kBAAkB,EAAE,IAAI;IACxB,IAAI,EAAE,CAAC,YAAiC,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC;CACrF,CAAC,CAAC;AAEH,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,qEAAqE;AAO1F;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,KAA+B;IACxD,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAA6B,EAAE,CAAC,CAAC;IACnF,MAAM,OAAO,GAAG,eAAe,EAAE,CAAC;IAClC,MAAM,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAE/E,4FAA4F;IAC5F,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,cAAc,EAAE,CAAC;YACjB,OAAO,CACH,cAAc,CAAC,SAAS,CAAC;gBACrB,IAAI,EAAE,CAAC,YAAY,EAAE,EAAE;oBACnB,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;gBAClG,CAAC;aACJ,CAAC,CACL,CAAC;QACN,CAAC;IACL,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;IAE9B,8FAA8F;IAC9F,SAAS,CAAC,GAAG,EAAE;QACX,OAAO,CACH,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACzC,IAAI,EAAE,CAAC,YAAY,EAAE,EAAE;gBACnB,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;YACnF,CAAC;SACJ,CAAC,CACL,CAAC;IACN,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;IAE9B,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,GAAW,EAAE,EAAE;QAC1C,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;IACxF,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACH,KAAC,SAAS,IAAC,KAAK,EAAE,KAAK,CAAC,KAAK,YACxB,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CACjC,KAAC,YAAY,IAET,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,EACpB,kBAAkB,EAAE,kBAAkB,IAHjC,YAAY,CAAC,GAAG,CAIvB,CACL,CAAC,GACM,CACf,CAAC;AACN,CAAC;AAED,eAAe,mBAAmB,CAAC"}

package/dist/notification.d.ts

@@ -0,0 +1,18 @@
+import { NotificationPayload } from './notification-payload';
+export interface NotificationProps {
+    /** The notification to render */
+    notification: NotificationPayload;
+    /** Handler to trigger the dismissal of the notification */
+    onDismiss?: (key: string) => void | Promise<void>;
+    /** Optional handler to trigger when the more details button is clicked */
+    onMoreDetailsClick?: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>, notification: NotificationPayload) => void;
+}
+/**
+ * Simple display component for a notification, will pick up the status, title and message and display them. Also
+ * renders a dismiss button in the top right corner.
+ *
+ * @param props the component props
+ */
+declare function Notification(props: NotificationProps): JSX.Element;
+export default Notification;
+//# sourceMappingURL=notification.d.ts.map

package/dist/notification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../src/notification.tsx"],"names":[],"mappings":"AAsBA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAgH7D,MAAM,WAAW,iBAAiB;IAC9B,iCAAiC;IACjC,YAAY,EAAE,mBAAmB,CAAC;IAClC,2DAA2D;IAC3D,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,0EAA0E;IAC1E,kBAAkB,CAAC,EAAE,CACjB,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,UAAU,CAAC,EAClD,YAAY,EAAE,mBAAmB,KAChC,IAAI,CAAC;CACb;AAED;;;;;GAKG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,GAAG,CAAC,OAAO,CAuB3D;AAED,eAAe,YAAY,CAAC"}

package/dist/notification.js

@@ -0,0 +1,122 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { mix } from 'polished';
+import styled, { theme } from '@darajs/styled-components';
+import { CircleCheck, CircleInfo, CircleXmark, Cross, TriangleExclamation } from '@darajs/ui-icons';
+import { Status, getStatusColor } from '@darajs/ui-utils';
+const NotificationWrapper = styled.div `
+    pointer-events: auto;
+
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+
+    width: 22rem;
+    height: ${(props) => (props.hasTitle ? '5.625rem' : '4.375rem')};
+    padding: 1rem;
+
+    color: ${(props) => getStatusColor(props.status, props.theme.colors)};
+
+    background-color: ${(props) => mix(0.1, getStatusColor(props.status, props.theme.colors), props.theme.colors.background)};
+    border: 1px solid ${(props) => getStatusColor(props.status, props.theme.colors)};
+    border-radius: 0.25rem;
+    box-shadow: 0 2px 4px rgb(0 0 0 / 10%);
+`;
+const Message = styled.div `
+    display: flex;
+    flex-direction: column;
+
+    width: 15.75rem;
+
+    font-size: 1rem;
+    line-height: 1.1875rem;
+`;
+// -webkit-box worked in Chrome, Safari and Firefox so we will be ignoring linting here as it was the simplest solution
+const Heading = styled.h2 `
+    overflow: hidden;
+    display: -webkit-box; /* stylelint-disable-line value-no-vendor-prefix */
+    -webkit-box-orient: vertical;
+
+    font-size: 1rem;
+    font-weight: 700;
+    text-overflow: ellipsis;
+
+    -webkit-line-clamp: 1;
+`;
+const Body = styled.span `
+    overflow: hidden;
+    display: -webkit-box; /* stylelint-disable-line value-no-vendor-prefix */
+    -webkit-box-orient: vertical;
+
+    font-weight: 400;
+    line-height: 1.25rem;
+    text-overflow: ellipsis;
+
+    -webkit-line-clamp: ${(props) => (props.moreDetailsShown ? 1 : 2)};
+`;
+const Icon = styled.div `
+    display: flex;
+
+    svg {
+        width: 1.5rem;
+        height: 1.3125rem;
+        color: ${(props) => getStatusColor(props.status, props.theme.colors)};
+    }
+`;
+const MoreDetailsButton = styled.button `
+    cursor: pointer;
+
+    display: flex;
+
+    padding-left: 0;
+
+    color: ${() => theme.colors.grey4};
+
+    background: transparent;
+    border: none;
+
+    :hover {
+        text-decoration: underline;
+    }
+`;
+const CloseBtn = styled(Cross) `
+    height: 1.2rem;
+    color: ${(props) => getStatusColor(props.status, props.theme.colors)};
+`;
+function getIcon(status) {
+    if ([Status.ERROR, Status.FAILED].includes(status)) {
+        return _jsx(CircleXmark, {});
+    }
+    if ([Status.CANCELED, Status.WARNING].includes(status)) {
+        return _jsx(TriangleExclamation, {});
+    }
+    return status === Status.SUCCESS ? _jsx(CircleCheck, {}) : _jsx(CircleInfo, {});
+}
+/**
+ * Simple display component for a notification, will pick up the status, title and message and display them. Also
+ * renders a dismiss button in the top right corner.
+ *
+ * @param props the component props
+ */
+function Notification(props) {
+    const isOverflowing = props.notification.message.length > 30;
+    const showMoreDetails = props.onMoreDetailsClick && isOverflowing;
+    return (_jsxs(NotificationWrapper, { hasTitle: !!props.notification.title, status: props.notification.status, children: [_jsx(Icon, { status: props.notification.status, children: getIcon(props.notification.status) }), _jsxs(Message, { children: [_jsx(Heading, { children: props.notification.title }), _jsx(Body, { moreDetailsShown: showMoreDetails, children: props.notification.message }), showMoreDetails && (_jsx(MoreDetailsButton, { onClick: (e) => props.onMoreDetailsClick(e, props.notification), type: "button", children: "Details >" }))] }), _jsx(CloseBtn, { asButton: true, onClick: () => props.onDismiss(props.notification.key), status: props.notification.status })] }));
+}
+export default Notification;
+//# sourceMappingURL=notification.js.map

package/dist/notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../src/notification.tsx"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,OAAO,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACpG,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAiB1D,MAAM,mBAAmB,GAAG,MAAM,CAAC,GAAG,CAA0B;;;;;;;;cAQlD,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC;;;aAGtD,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;;wBAEhD,CAAC,KAAK,EAAE,EAAE,CAC1B,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;wBACzE,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;;;CAGlF,CAAC;AAEF,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAA;;;;;;;;CAQzB,CAAC;AAEF,uHAAuH;AACvH,MAAM,OAAO,GAAG,MAAM,CAAC,EAAE,CAAA;;;;;;;;;;CAUxB,CAAC;AAEF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAuB;;;;;;;;;0BASrB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,CAAC;AAEF,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAwB;;;;;;iBAM9B,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;;CAE3E,CAAC;AAEF,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAA;;;;;;;aAO1B,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK;;;;;;;;CAQpC,CAAC;AAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAwB;;aAEzC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;CACvE,CAAC;AAEF,SAAS,OAAO,CAAC,MAAc;IAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACjD,OAAO,KAAC,WAAW,KAAG,CAAC;IAC3B,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACrD,OAAO,KAAC,mBAAmB,KAAG,CAAC;IACnC,CAAC;IACD,OAAO,MAAM,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAC,WAAW,KAAG,CAAC,CAAC,CAAC,KAAC,UAAU,KAAG,CAAC;AACxE,CAAC;AAcD;;;;;GAKG;AACH,SAAS,YAAY,CAAC,KAAwB;IAC1C,MAAM,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC;IAC7D,MAAM,eAAe,GAAG,KAAK,CAAC,kBAAkB,IAAI,aAAa,CAAC;IAElE,OAAO,CACH,MAAC,mBAAmB,IAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,MAAM,aACxF,KAAC,IAAI,IAAC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,MAAM,YAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,GAAQ,EACpF,MAAC,OAAO,eACJ,KAAC,OAAO,cAAE,KAAK,CAAC,YAAY,CAAC,KAAK,GAAW,EAC7C,KAAC,IAAI,IAAC,gBAAgB,EAAE,eAAe,YAAG,KAAK,CAAC,YAAY,CAAC,OAAO,GAAQ,EAC3E,eAAe,IAAI,CAChB,KAAC,iBAAiB,IAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,EAAC,QAAQ,0BAE7E,CACvB,IACK,EACV,KAAC,QAAQ,IACL,QAAQ,QACR,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EACtD,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,MAAM,GACnC,IACgB,CACzB,CAAC;AACN,CAAC;AAED,eAAe,YAAY,CAAC"}

package/dist/use-notifications.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CurriedFunction2 } from 'lodash';
+import { NotificationPayload } from './notification-payload';
+export interface UseNotificationsInterface {
+    pushErrorNotification: CurriedFunction2<string, Error, void>;
+    pushNotification: (notification: NotificationPayload) => void;
+    pushWarningNotification: CurriedFunction2<string, Error, void>;
+}
+/**
+ * A helper hook that exposes some helpful methods for defining notifications quickly based of error messages. The error
+ * and warning functions are both curried so they can easily be dropped into error handling call backs with only the
+ * title defined
+ */
+export declare function useNotifications(): UseNotificationsInterface;
+//# sourceMappingURL=use-notifications.d.ts.map

package/dist/use-notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-notifications.d.ts","sourceRoot":"","sources":["../src/use-notifications.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAM1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAO7D,MAAM,WAAW,yBAAyB;IACtC,qBAAqB,EAAE,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC7D,gBAAgB,EAAE,CAAC,YAAY,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC9D,uBAAuB,EAAE,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;CAClE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,yBAAyB,CAyB5D"}

package/dist/use-notifications.js

@@ -0,0 +1,29 @@
+import curry from 'lodash/curry';
+import React, { useContext } from 'react';
+import { Status } from '@darajs/ui-utils';
+import { NotificationContext } from './notification-wrapper';
+/**
+ * A helper hook that exposes some helpful methods for defining notifications quickly based of error messages. The error
+ * and warning functions are both curried so they can easily be dropped into error handling call backs with only the
+ * title defined
+ */
+export function useNotifications() {
+    const { push } = useContext(NotificationContext);
+    const curriedPush = React.useCallback((status) => curry((title, err) => {
+        const message = (err === null || err === void 0 ? void 0 : err.status) ? `${err.status}: ${err.message}` : err.message;
+        push({
+            key: title,
+            message,
+            status,
+            title: `${status.toUpperCase()}: ${title}`,
+        });
+    }), [push]);
+    const pushErrorNotification = React.useMemo(() => curriedPush(Status.ERROR), [curriedPush]);
+    const pushWarningNotification = React.useMemo(() => curriedPush(Status.WARNING), [curriedPush]);
+    return {
+        pushErrorNotification,
+        pushNotification: push,
+        pushWarningNotification,
+    };
+}
+//# sourceMappingURL=use-notifications.js.map

package/dist/use-notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-notifications.js","sourceRoot":"","sources":["../src/use-notifications.tsx"],"names":[],"mappings":"AAiBA,OAAO,KAAK,MAAM,cAAc,CAAC;AACjC,OAAO,KAAK,EAAE,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAG1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAY7D;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC5B,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CACjC,CAAC,MAAc,EAAE,EAAE,CACf,KAAK,CAAC,CAAC,KAAa,EAAE,GAAa,EAAQ,EAAE;QACzC,MAAM,OAAO,GAAG,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,EAAC,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QAC5E,IAAI,CAAC;YACD,GAAG,EAAE,KAAK;YACV,OAAO;YACP,MAAM;YACN,KAAK,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;SAC7C,CAAC,CAAC;IACP,CAAC,CAAC,EACN,CAAC,IAAI,CAAC,CACT,CAAC;IAEF,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5F,MAAM,uBAAuB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAEhG,OAAO;QACH,qBAAqB;QACrB,gBAAgB,EAAE,IAAI;QACtB,uBAAuB;KAC1B,CAAC;AACN,CAAC"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@darajs/ui-notifications",
+  "version": "0.4.8",
+  "description": "Notification system for the Dara UI Framework",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "jsnext:main": "dist/index.js",
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "lint": "eslint src --ext .tsx --max-warnings 0 && stylelint './src/**/*.tsx'",
+    "format": "prettier src --write",
+    "format:check": "prettier src --check",
+    "lint:fix": "eslint src --ext .tsx --max-warnings 0 --fix && stylelint './src/**/*.tsx' --fix",
+    "test-watch": "jest --watch",
+    "storybook": "start-storybook -p 6006",
+    "build-storybook": "build-storybook"
+  },
+  "author": "Krzysztof Bielikowicz <krzysztof@causalens.com>",
+  "license": "Apache-2.0",
+  "prettier": "@darajs/prettier-config",
+  "devDependencies": {
+    "@darajs/eslint-config": "0.4.8",
+    "@darajs/prettier-config": "0.4.8",
+    "@darajs/stylelint-config": "0.4.8",
+    "@storybook/addon-a11y": "^6.5.16",
+    "@storybook/addon-actions": "^6.5.16",
+    "@storybook/addon-essentials": "^6.5.16",
+    "@storybook/addon-links": "^6.5.16",
+    "@storybook/addon-styling": "^0.3.2",
+    "@storybook/builder-webpack5": "^6.5.16",
+    "@storybook/manager-webpack5": "^6.5.16",
+    "@storybook/react": "^6.5.16",
+    "@storybook/theming": "^6.5.16",
+    "@types/jest": "^25.2.3",
+    "@types/lodash": "^4.14.155",
+    "@types/react": "^18.0",
+    "@types/styled-components": "^5.1.26",
+    "eslint": "^8.1.0",
+    "jest": "^29.5.0",
+    "prettier": "^3.0.0",
+    "react-test-renderer": "^17.0",
+    "rimraf": "^3.0.2",
+    "storybook-dark-mode": "^2.1.1",
+    "stylelint": "^15.0.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "@darajs/styled-components": "0.4.8",
+    "@darajs/ui-icons": "0.4.8",
+    "@darajs/ui-utils": "0.4.8",
+    "lodash": "4.17.21",
+    "polished": "^4.1.1",
+    "react": "^18.0",
+    "rxjs": "^7.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "28ec9380d883a6f5f0fcd05f27beda7e412fa95f"
+}