@genesislcap/foundation-errors 14.303.0 → 14.303.2

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/package.json +10 -10
  2. package/docs/api-report.md +0 -202
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-errors",
3
3
  "description": "Genesis Foundation UI Error Utils",
4
- "version": "14.303.0",
4
+ "version": "14.303.2",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -49,16 +49,16 @@
49
49
  }
50
50
  },
51
51
  "devDependencies": {
52
- "@genesislcap/foundation-testing": "14.303.0",
53
- "@genesislcap/genx": "14.303.0",
54
- "@genesislcap/rollup-builder": "14.303.0",
55
- "@genesislcap/ts-builder": "14.303.0",
56
- "@genesislcap/uvu-playwright-builder": "14.303.0",
57
- "@genesislcap/vite-builder": "14.303.0",
58
- "@genesislcap/webpack-builder": "14.303.0"
52
+ "@genesislcap/foundation-testing": "14.303.2",
53
+ "@genesislcap/genx": "14.303.2",
54
+ "@genesislcap/rollup-builder": "14.303.2",
55
+ "@genesislcap/ts-builder": "14.303.2",
56
+ "@genesislcap/uvu-playwright-builder": "14.303.2",
57
+ "@genesislcap/vite-builder": "14.303.2",
58
+ "@genesislcap/webpack-builder": "14.303.2"
59
59
  },
60
60
  "dependencies": {
61
- "@genesislcap/foundation-logger": "14.303.0"
61
+ "@genesislcap/foundation-logger": "14.303.2"
62
62
  },
63
63
  "repository": {
64
64
  "type": "git",
@@ -68,5 +68,5 @@
68
68
  "publishConfig": {
69
69
  "access": "public"
70
70
  },
71
- "gitHead": "1495670cf431019b7a29589f6ab7b80c0ec31945"
71
+ "gitHead": "f556f123bafe956a7ba9328bb3f78f4d7d2495ba"
72
72
  }
@@ -1,202 +0,0 @@
1
- ## API Report File for "@genesislcap/foundation-errors"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { LogLevel } from '@genesislcap/foundation-logger';
8
-
9
- // @public
10
- export interface ConfirmingAction {
11
- // (undocumented)
12
- readonly action: Function;
13
- // (undocumented)
14
- readonly label: String;
15
- }
16
-
17
- // @public
18
- export interface DismissingAction {
19
- // (undocumented)
20
- readonly action?: Function;
21
- // (undocumented)
22
- readonly label: String;
23
- }
24
-
25
- // @public
26
- export interface ErrorBanner {
27
- // (undocumented)
28
- readonly confirmingActions?: Array<ConfirmingAction>;
29
- // (undocumented)
30
- readonly dismissingAction?: DismissingAction;
31
- }
32
-
33
- // @public
34
- export class ErrorBannerBuilder {
35
- build(): ErrorBanner;
36
- withConfirmingAction(confirmingAction: ConfirmingAction): ErrorBannerBuilder;
37
- withDismissingAction(dismissingAction: DismissingAction): ErrorBannerBuilder;
38
- }
39
-
40
- // @public
41
- export enum ErrorBoundaryEvent {
42
- // (undocumented)
43
- ERROR_BOUNDARY_EVENT = "error-boundary-event"
44
- }
45
-
46
- // @public
47
- export class ErrorBuilder {
48
- build(): ErrorStructure;
49
- withAlert(alert: boolean): ErrorBuilder;
50
- withBanner(banner: ErrorBanner): ErrorBuilder;
51
- withDialog(dialog: ErrorDialog): ErrorBuilder;
52
- withErrorDetails(errorDetails: string): ErrorBuilder;
53
- withLogLevel(logLevel: LogLevel): ErrorBuilder;
54
- withNotification(notification: ErrorNotification): ErrorBuilder;
55
- withSnackbar(snackbar: Snackbar): ErrorBuilder;
56
- withTitle(title: string): ErrorBuilder;
57
- }
58
-
59
- // @public
60
- export interface ErrorDialog {
61
- // (undocumented)
62
- readonly confirmingActions?: Array<ConfirmingAction>;
63
- // (undocumented)
64
- readonly dismissingAction?: DismissingAction;
65
- }
66
-
67
- // @public
68
- export class ErrorDialogBuilder {
69
- build(): ErrorDialog;
70
- withConfirmingAction(confirmingAction: ConfirmingAction): ErrorDialogBuilder;
71
- withDismissingAction(dismissingAction: DismissingAction): ErrorDialogBuilder;
72
- }
73
-
74
- // Warning: (ae-internal-missing-underscore) The name "ErrorDialogElement" should be prefixed with an underscore because the declaration is marked as @internal
75
- //
76
- // @internal (undocumented)
77
- export type ErrorDialogElement = ErrorElement & {
78
- show: Function;
79
- };
80
-
81
- // Warning: (ae-internal-missing-underscore) The name "ErrorElement" should be prefixed with an underscore because the declaration is marked as @internal
82
- //
83
- // @internal (undocumented)
84
- export type ErrorElement = HTMLElement & {
85
- error: ErrorStructure;
86
- };
87
-
88
- // @public
89
- export interface ErrorNotification {
90
- // (undocumented)
91
- readonly autoClose?: boolean;
92
- // (undocumented)
93
- readonly closeTimeout?: number;
94
- // (undocumented)
95
- readonly position?: ErrorNotificationPosition;
96
- // (undocumented)
97
- readonly type?: ErrorNotificationType;
98
- }
99
-
100
- // @public
101
- export type ErrorNotificationPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
102
-
103
- // @public
104
- export type ErrorNotificationType = 'warning' | 'success';
105
-
106
- // @public
107
- export interface ErrorStructure {
108
- // (undocumented)
109
- readonly config?: {
110
- readonly logLevel?: LogLevel;
111
- readonly alert?: boolean;
112
- readonly notification?: ErrorNotification;
113
- readonly banner?: ErrorBanner;
114
- readonly snackbar?: Snackbar;
115
- readonly dialog?: ErrorDialog;
116
- };
117
- // (undocumented)
118
- readonly errorDetails: string;
119
- // (undocumented)
120
- readonly logLevel?: LogLevel;
121
- // (undocumented)
122
- readonly title: string;
123
- }
124
-
125
- // @public
126
- export const getErrorBannerAnchor: (element: any) => HTMLElement | null;
127
-
128
- // @public
129
- export const getErrorBannerBuilder: () => ErrorBannerBuilder;
130
-
131
- // @public
132
- export const getErrorBuilder: () => ErrorBuilder;
133
-
134
- // @public
135
- export const getErrorContainer: (id: string, tagName: String) => HTMLElement;
136
-
137
- // @public
138
- export const getErrorDetails: (details: ErrorStructure) => string;
139
-
140
- // @public
141
- export const getErrorDialogBuilder: () => ErrorDialogBuilder;
142
-
143
- // @public
144
- export const getLoglevel: (details: ErrorStructure) => LogLevel;
145
-
146
- // @public
147
- export const getNotificationBuilder: () => NotificationBuilder;
148
-
149
- // @public
150
- export const getSnackbarBuilder: () => SnackbarBuilder;
151
-
152
- // @public
153
- export class NotificationBuilder {
154
- build(): ErrorNotification;
155
- withAutoClose(autoClose: boolean): NotificationBuilder;
156
- withCloseTimeout(closeTimeout: number): NotificationBuilder;
157
- withPosition(position: ErrorNotificationPosition): NotificationBuilder;
158
- withType(type: ErrorNotificationType): NotificationBuilder;
159
- }
160
-
161
- // @public
162
- export const showBanner: (error: ErrorStructure, tagName: String, errorBoundary: HTMLElement) => void;
163
-
164
- // Warning: (ae-internal-missing-underscore) The name "showDialog" should be prefixed with an underscore because the declaration is marked as @internal
165
- //
166
- // @internal
167
- export const showDialog: (error: ErrorStructure, tagName: String) => void;
168
-
169
- // @public
170
- export const showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void;
171
-
172
- // Warning: (ae-internal-missing-underscore) The name "showNotification" should be prefixed with an underscore because the declaration is marked as @internal
173
- //
174
- // @internal
175
- export const showNotification: (error: ErrorStructure, tagName: String) => void;
176
-
177
- // Warning: (ae-internal-missing-underscore) The name "showSnackbar" should be prefixed with an underscore because the declaration is marked as @internal
178
- //
179
- // @internal
180
- export const showSnackbar: (error: ErrorStructure, tagName: String) => void;
181
-
182
- // @public
183
- export interface Snackbar {
184
- // (undocumented)
185
- readonly confirmingActions?: Array<ConfirmingAction>;
186
- // (undocumented)
187
- readonly type?: SnackbarType;
188
- }
189
-
190
- // @public
191
- export class SnackbarBuilder {
192
- build(): Snackbar;
193
- withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
194
- withType(type: SnackbarType): SnackbarBuilder;
195
- }
196
-
197
- // @public
198
- export type SnackbarType = 'error' | 'success';
199
-
200
- // (No @packageDocumentation comment for this package)
201
-
202
- ```