@umbraco-cms/backoffice 1.0.0-next.ce55cd35 → 1.0.0-next.d2c0dcf1

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.
package/modal.d.ts CHANGED
@@ -4,11 +4,12 @@ import * as lit_html from 'lit-html';
4
4
  import * as lit from 'lit';
5
5
  import { LitElement, TemplateResult } from 'lit';
6
6
  import { UUIModalDialogElement, UUIModalSidebarElement, UUIModalSidebarSize } from '@umbraco-ui/uui';
7
- import { UmbControllerHostElement, UmbControllerInterface } from './controller';
8
- import { UmbContextToken } from './context-api';
9
- import { UmbModalToken as UmbModalToken$1, UmbModalConfig as UmbModalConfig$1, UmbPickerModalData as UmbPickerModalData$1 } from './modal';
10
- import { LanguageResponseModel, FolderReponseModel } from './backend-api';
11
- import { UserDetails } from './models';
7
+ import { UmbControllerHostElement, UmbControllerInterface } from '@umbraco-cms/backoffice/controller';
8
+ import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
9
+ import { Params } from '@umbraco-cms/backoffice/router';
10
+ import { UmbModalToken as UmbModalToken$1, UmbModalConfig as UmbModalConfig$1, UmbPickerModalData as UmbPickerModalData$1 } from '@umbraco-cms/backoffice/modal';
11
+ import { LanguageResponseModel, FolderReponseModel } from '@umbraco-cms/backoffice/backend-api';
12
+ import { UserDetails } from '@umbraco-cms/backoffice/models';
12
13
 
13
14
  declare class UmbSearchModalElement extends LitElement {
14
15
  #private;
@@ -126,316 +127,6 @@ declare class UmbModalContext {
126
127
  }
127
128
  declare const UMB_MODAL_CONTEXT_TOKEN: UmbContextToken<UmbModalContext>;
128
129
 
129
- interface IRouterSlot<D = any, P = any> extends HTMLElement {
130
- readonly route: IRoute<D> | null;
131
- readonly isRoot: boolean;
132
- readonly fragments: IPathFragments | null;
133
- readonly params: Params | null;
134
- readonly match: IRouteMatch<D> | null;
135
- routes: IRoute<D>[];
136
- add: ((routes: IRoute<D>[], navigate?: boolean) => void);
137
- clear: (() => void);
138
- render: (() => Promise<void>);
139
- constructAbsolutePath: ((path: PathFragment) => string);
140
- parent: IRouterSlot<P> | null | undefined;
141
- queryParentRouterSlot: (() => IRouterSlot<P> | null);
142
- }
143
- type IRoutingInfo<D = any, P = any> = {
144
- slot: IRouterSlot<D, P>;
145
- match: IRouteMatch<D>;
146
- };
147
- type CustomResolver<D = any, P = any> = ((info: IRoutingInfo<D>) => boolean | void | Promise<boolean> | Promise<void>);
148
- type Guard<D = any, P = any> = ((info: IRoutingInfo<D, P>) => boolean | Promise<boolean>);
149
- type PageComponent = HTMLElement;
150
- type ModuleResolver = Promise<{
151
- default: any;
152
- }>;
153
- type Class<T extends PageComponent = PageComponent> = {
154
- new (...args: any[]): T;
155
- };
156
- type Setup<D = any> = ((component: PageComponent, info: IRoutingInfo<D>) => void);
157
- type PathMatch = "prefix" | "suffix" | "full" | "fuzzy";
158
- /**
159
- * The base route interface.
160
- * D = the data type of the data
161
- */
162
- interface IRouteBase<D = any> {
163
- path: PathFragment;
164
- data?: D;
165
- guards?: Guard[];
166
- pathMatch?: PathMatch;
167
- }
168
- /**
169
- * Route type used for redirection.
170
- */
171
- interface IRedirectRoute<D = any> extends IRouteBase<D> {
172
- redirectTo: string;
173
- preserveQuery?: boolean;
174
- }
175
- /**
176
- * Route type used to resolve and stamp components.
177
- */
178
- interface IComponentRoute<D = any> extends IRouteBase<D> {
179
- component: Class | ModuleResolver | PageComponent | (() => Class) | (() => PageComponent) | (() => ModuleResolver);
180
- setup?: Setup;
181
- }
182
- /**
183
- * Route type used to take control of how the route should resolve.
184
- */
185
- interface IResolverRoute<D = any> extends IRouteBase<D> {
186
- resolve: CustomResolver;
187
- }
188
- type IRoute<D = any> = IRedirectRoute<D> | IComponentRoute<D> | IResolverRoute<D>;
189
- type PathFragment = string;
190
- type IPathFragments = {
191
- consumed: PathFragment;
192
- rest: PathFragment;
193
- };
194
- interface IRouteMatch<D = any> {
195
- route: IRoute<D>;
196
- params: Params;
197
- fragments: IPathFragments;
198
- match: RegExpMatchArray;
199
- }
200
- type PushStateEvent = CustomEvent<null>;
201
- type ReplaceStateEvent = CustomEvent<null>;
202
- type ChangeStateEvent = CustomEvent<null>;
203
- type WillChangeStateEvent = CustomEvent<{
204
- url?: string | null;
205
- eventName: GlobalRouterEvent;
206
- }>;
207
- type NavigationStartEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
208
- type NavigationSuccessEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
209
- type NavigationCancelEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
210
- type NavigationErrorEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
211
- type NavigationEndEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
212
- type Params = {
213
- [key: string]: string;
214
- };
215
- /**
216
- * History related events.
217
- */
218
- type GlobalRouterEvent = "pushstate" | "replacestate" | "popstate" | "changestate" | "willchangestate" | "navigationstart" | "navigationcancel" | "navigationerror" | "navigationsuccess" | "navigationend";
219
- declare global {
220
- interface GlobalEventHandlersEventMap {
221
- "pushstate": PushStateEvent;
222
- "replacestate": ReplaceStateEvent;
223
- "popstate": PopStateEvent;
224
- "changestate": ChangeStateEvent;
225
- "navigationstart": NavigationStartEvent;
226
- "navigationend": NavigationEndEvent;
227
- "navigationsuccess": NavigationSuccessEvent;
228
- "navigationcancel": NavigationCancelEvent;
229
- "navigationerror": NavigationErrorEvent;
230
- "willchangestate": WillChangeStateEvent;
231
- }
232
- }
233
-
234
- /**
235
- * Slot for a node in the router tree.
236
- * @slot - Default content.
237
- * @event changestate - Dispatched when the router slot state changes.
238
- */
239
- declare class RouterSlot<D = any, P = any> extends HTMLElement implements IRouterSlot<D, P> {
240
- /**
241
- * Listeners on the router.
242
- */
243
- private listeners;
244
- /**
245
- * The available routes.
246
- */
247
- private _routes;
248
- get routes(): IRoute<D>[];
249
- set routes(routes: IRoute<D>[]);
250
- /**
251
- * The parent router.
252
- * Is REQUIRED if this router is a child.
253
- * When set, the relevant listeners are added or teared down because they depend on the parent.
254
- */
255
- _parent: IRouterSlot<P> | null | undefined;
256
- get parent(): IRouterSlot<P> | null | undefined;
257
- set parent(router: IRouterSlot<P> | null | undefined);
258
- /**
259
- * Whether the router is a root router.
260
- */
261
- get isRoot(): boolean;
262
- /**
263
- * The current route match.
264
- */
265
- private _routeMatch;
266
- get match(): IRouteMatch<D> | null;
267
- /**
268
- * The current route of the match.
269
- */
270
- get route(): IRoute<D> | null;
271
- /**
272
- * The current path fragment of the match
273
- */
274
- get fragments(): IPathFragments | null;
275
- /**
276
- * The current params of the match.
277
- */
278
- get params(): Params | null;
279
- /**
280
- * Hooks up the element.
281
- */
282
- constructor();
283
- /**
284
- * Query the parent router slot when the router slot is connected.
285
- */
286
- connectedCallback(): void;
287
- /**
288
- * Tears down the element.
289
- */
290
- disconnectedCallback(): void;
291
- /**
292
- * Queries the parent router.
293
- */
294
- queryParentRouterSlot(): IRouterSlot<P> | null;
295
- /**
296
- * Returns an absolute path relative to the router slot.
297
- * @param path
298
- */
299
- constructAbsolutePath(path: PathFragment): string;
300
- /**
301
- * Adds routes to the router.
302
- * Navigates automatically if the router slot is the root and is connected.
303
- * @param routes
304
- * @param navigate
305
- */
306
- add(routes: IRoute<D>[], navigate?: boolean): void;
307
- /**
308
- * Removes all routes.
309
- */
310
- clear(): void;
311
- /**
312
- * Each time the path changes, load the new path.
313
- */
314
- render(): Promise<void>;
315
- /**
316
- * Attaches listeners, either globally or on the parent router.
317
- */
318
- protected attachListeners(): void;
319
- /**
320
- * Clears the children in the DOM.
321
- */
322
- protected clearChildren(): void;
323
- /**
324
- * Detaches the listeners.
325
- */
326
- protected detachListeners(): void;
327
- /**
328
- * Notify the listeners.
329
- */
330
- notifyChildRouters(info: any): void;
331
- /**
332
- * Loads a new path based on the routes.
333
- * Returns true if a navigation was made to a new page.
334
- */
335
- protected renderPath(path: string | PathFragment): Promise<boolean>;
336
- }
337
- declare global {
338
- interface HTMLElementTagNameMap {
339
- "router-slot": RouterSlot;
340
- }
341
- }
342
-
343
- /**
344
- * Router link.
345
- * @slot - Default content.
346
- */
347
- declare class RouterLink extends HTMLElement {
348
- private listeners;
349
- private _context;
350
- static get observedAttributes(): string[];
351
- /**
352
- * The path of the navigation.
353
- * @attr
354
- */
355
- set path(value: string | PathFragment);
356
- get path(): string | PathFragment;
357
- /**
358
- * Whether the element is disabled or not.
359
- * @attr
360
- */
361
- get disabled(): boolean;
362
- set disabled(value: boolean);
363
- /**
364
- * Whether the element is active or not.
365
- * @attr
366
- */
367
- get active(): boolean;
368
- set active(value: boolean);
369
- /**
370
- * Whether the focus should be delegated.
371
- * @attr
372
- */
373
- get delegateFocus(): boolean;
374
- set delegateFocus(value: boolean);
375
- /**
376
- * Whether the query should be preserved or not.
377
- * @attr
378
- */
379
- get preserveQuery(): boolean;
380
- set preserveQuery(value: boolean);
381
- /**
382
- * The current router slot context.
383
- */
384
- get context(): IRouterSlot | null;
385
- set context(value: IRouterSlot | null);
386
- /**
387
- * Returns the absolute path.
388
- */
389
- get absolutePath(): string;
390
- constructor();
391
- /**
392
- * Hooks up the element.
393
- */
394
- connectedCallback(): void;
395
- /**
396
- * Tear down listeners.
397
- */
398
- disconnectedCallback(): void;
399
- /**
400
- * Reacts to attribute changed callback.
401
- * @param name
402
- * @param oldValue
403
- * @param newValue
404
- */
405
- attributeChangedCallback(name: string, oldValue: unknown, newValue: unknown): void;
406
- private updateTabIndex;
407
- /**
408
- * Returns the absolute path constructed relative to the context.
409
- * If no router parent was found the path property is the absolute one.
410
- */
411
- constructAbsolutePath(path: string): string;
412
- /**
413
- * Updates whether the route is active or not.
414
- */
415
- protected updateActive(): void;
416
- /**
417
- * Navigates to the specified path.
418
- */
419
- navigate(path: string, e?: Event): void;
420
- }
421
- declare global {
422
- interface HTMLElementTagNameMap {
423
- "router-link": RouterLink;
424
- }
425
- }
426
-
427
- declare global {
428
- interface History {
429
- "native": {
430
- "back": ((distance?: any) => void);
431
- "forward": ((distance?: any) => void);
432
- "go": ((delta?: any) => void);
433
- "pushState": ((data: any, title?: string, url?: string | null) => void);
434
- "replaceState": ((data: any, title?: string, url?: string | null) => void);
435
- };
436
- }
437
- }
438
-
439
130
  type UmbModalRouteBuilder = (params: {
440
131
  [key: string]: string | number;
441
132
  }) => string;
@@ -576,8 +267,8 @@ interface UmbExportDictionaryModalResult {
576
267
  declare const UMB_EXPORT_DICTIONARY_MODAL: UmbModalToken$1<UmbExportDictionaryModalData, UmbExportDictionaryModalResult>;
577
268
 
578
269
  interface UmbIconPickerModalData {
579
- multiple: boolean;
580
- selection: string[];
270
+ color: string | undefined;
271
+ icon: string | undefined;
581
272
  }
582
273
  interface UmbIconPickerModalResult {
583
274
  color: string | undefined;
@@ -704,6 +395,15 @@ interface UmbFolderModalResult {
704
395
  }
705
396
  declare const UMB_FOLDER_MODAL: UmbModalToken$1<UmbFolderModalData, UmbFolderModalResult>;
706
397
 
398
+ interface UmbDataTypePickerModalData {
399
+ selection?: Array<string>;
400
+ multiple?: boolean;
401
+ }
402
+ interface UmbDataTypePickerModalResult {
403
+ selection: Array<string>;
404
+ }
405
+ declare const UMB_DATA_TYPE_PICKER_MODAL: UmbModalToken$1<UmbDataTypePickerModalData, UmbDataTypePickerModalResult>;
406
+
707
407
  interface UmbPickerModalData<T> {
708
408
  multiple: boolean;
709
409
  selection: Array<string>;
@@ -713,4 +413,4 @@ interface UmbPickerModalResult<T> {
713
413
  selection: Array<string>;
714
414
  }
715
415
 
716
- export { OEmbedResult, OEmbedStatus, UMB_ALLOWED_DOCUMENT_TYPES_MODAL, UMB_CHANGE_PASSWORD_MODAL, UMB_CONFIRM_MODAL, UMB_CONTEXT_DEBUGGER_MODAL, UMB_CREATE_DICTIONARY_MODAL, UMB_CREATE_USER_MODAL, UMB_CURRENT_USER_MODAL, UMB_DOCUMENT_PICKER_MODAL, UMB_DOCUMENT_TYPE_PICKER_MODAL, UMB_EMBEDDED_MEDIA_MODAL, UMB_EXAMINE_FIELDS_SETTINGS_MODAL, UMB_EXPORT_DICTIONARY_MODAL, UMB_FOLDER_MODAL, UMB_ICON_PICKER_MODAL, UMB_IMPORT_DICTIONARY_MODAL, UMB_INVITE_USER_MODAL, UMB_LANGUAGE_PICKER_MODAL, UMB_LINK_PICKER_MODAL, UMB_MEDIA_PICKER_MODAL, UMB_MODAL_CONTEXT_TOKEN, UMB_PROPERTY_EDITOR_UI_PICKER_MODAL, UMB_PROPERTY_SETTINGS_MODAL, UMB_SEARCH_MODAL, UMB_SECTION_PICKER_MODAL, UMB_TEMPLATE_MODAL, UMB_TEMPLATE_PICKER_MODAL, UMB_USER_GROUP_PICKER_MODAL, UMB_USER_PICKER_MODAL, UmbAllowedDocumentTypesModalData, UmbAllowedDocumentTypesModalResult, UmbChangePasswordModalData, UmbConfirmModalData, UmbConfirmModalResult, UmbContextDebuggerModalData, UmbCreateDictionaryModalData, UmbCreateDictionaryModalResult, UmbCreateDocumentModalResultData, UmbDocumentPickerModalData, UmbDocumentPickerModalResult, UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult, UmbEmbeddedMediaModalData, UmbEmbeddedMediaModalResult, UmbExamineFieldsSettingsModalData, UmbExportDictionaryModalData, UmbExportDictionaryModalResult, UmbFolderModalData, UmbFolderModalResult, UmbIconPickerModalData, UmbIconPickerModalResult, UmbImportDictionaryModalData, UmbImportDictionaryModalResult, UmbLanguagePickerModalData, UmbLanguagePickerModalResult, UmbLinkPickerConfig, UmbLinkPickerLink, UmbLinkPickerModalData, UmbLinkPickerModalResult, UmbMediaPickerModalData, UmbMediaPickerModalResult, UmbModalConfig, UmbModalContext, UmbModalHandler, UmbModalHandlerClass, UmbModalRouteBuilder, UmbModalRouteRegistration, UmbModalRouteRegistrationController, UmbModalToken, UmbModalType, UmbPickerModalData, UmbPickerModalResult, UmbPropertyEditorUIPickerModalData, UmbPropertyEditorUIPickerModalResult, UmbPropertySettingsModalResult, UmbSectionPickerModalData, UmbTemplateModalData, UmbTemplateModalResult, UmbTemplatePickerModalData, UmbTemplatePickerModalResult };
416
+ export { OEmbedResult, OEmbedStatus, UMB_ALLOWED_DOCUMENT_TYPES_MODAL, UMB_CHANGE_PASSWORD_MODAL, UMB_CONFIRM_MODAL, UMB_CONTEXT_DEBUGGER_MODAL, UMB_CREATE_DICTIONARY_MODAL, UMB_CREATE_USER_MODAL, UMB_CURRENT_USER_MODAL, UMB_DATA_TYPE_PICKER_MODAL, UMB_DOCUMENT_PICKER_MODAL, UMB_DOCUMENT_TYPE_PICKER_MODAL, UMB_EMBEDDED_MEDIA_MODAL, UMB_EXAMINE_FIELDS_SETTINGS_MODAL, UMB_EXPORT_DICTIONARY_MODAL, UMB_FOLDER_MODAL, UMB_ICON_PICKER_MODAL, UMB_IMPORT_DICTIONARY_MODAL, UMB_INVITE_USER_MODAL, UMB_LANGUAGE_PICKER_MODAL, UMB_LINK_PICKER_MODAL, UMB_MEDIA_PICKER_MODAL, UMB_MODAL_CONTEXT_TOKEN, UMB_PROPERTY_EDITOR_UI_PICKER_MODAL, UMB_PROPERTY_SETTINGS_MODAL, UMB_SEARCH_MODAL, UMB_SECTION_PICKER_MODAL, UMB_TEMPLATE_MODAL, UMB_TEMPLATE_PICKER_MODAL, UMB_USER_GROUP_PICKER_MODAL, UMB_USER_PICKER_MODAL, UmbAllowedDocumentTypesModalData, UmbAllowedDocumentTypesModalResult, UmbChangePasswordModalData, UmbConfirmModalData, UmbConfirmModalResult, UmbContextDebuggerModalData, UmbCreateDictionaryModalData, UmbCreateDictionaryModalResult, UmbCreateDocumentModalResultData, UmbDataTypePickerModalData, UmbDataTypePickerModalResult, UmbDocumentPickerModalData, UmbDocumentPickerModalResult, UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult, UmbEmbeddedMediaModalData, UmbEmbeddedMediaModalResult, UmbExamineFieldsSettingsModalData, UmbExportDictionaryModalData, UmbExportDictionaryModalResult, UmbFolderModalData, UmbFolderModalResult, UmbIconPickerModalData, UmbIconPickerModalResult, UmbImportDictionaryModalData, UmbImportDictionaryModalResult, UmbLanguagePickerModalData, UmbLanguagePickerModalResult, UmbLinkPickerConfig, UmbLinkPickerLink, UmbLinkPickerModalData, UmbLinkPickerModalResult, UmbMediaPickerModalData, UmbMediaPickerModalResult, UmbModalConfig, UmbModalContext, UmbModalHandler, UmbModalHandlerClass, UmbModalRouteBuilder, UmbModalRouteRegistration, UmbModalRouteRegistrationController, UmbModalToken, UmbModalType, UmbPickerModalData, UmbPickerModalResult, UmbPropertyEditorUIPickerModalData, UmbPropertyEditorUIPickerModalResult, UmbPropertySettingsModalResult, UmbSectionPickerModalData, UmbTemplateModalData, UmbTemplateModalResult, UmbTemplatePickerModalData, UmbTemplatePickerModalResult };
package/models.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { EntityTreeItemResponseModel, FolderTreeItemResponseModel, PackageManifestResponseModel } from './backend-api';
1
+ import { EntityTreeItemResponseModel, FolderTreeItemResponseModel, PackageManifestResponseModel } from '@umbraco-cms/backoffice/backend-api';
2
2
 
3
3
  type HTMLElementConstructor<T = HTMLElement> = new (...args: any[]) => T;
4
4
  type ClassConstructor<T> = new (...args: any[]) => T;
package/notification.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as rxjs from 'rxjs';
2
- import { UmbContextToken } from './context-api';
2
+ import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
3
3
 
4
4
  /**
5
5
  * @export
@@ -1,6 +1,6 @@
1
1
  import * as rxjs from 'rxjs';
2
2
  import { Observable, BehaviorSubject } from 'rxjs';
3
- import { UmbControllerInterface, UmbControllerHostElement } from './controller';
3
+ import { UmbControllerInterface, UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
4
4
 
5
5
  declare class UmbObserver<T> {
6
6
  #private;
@@ -18,55 +18,55 @@ declare class UmbObserverController<T = unknown> extends UmbObserver<T> implemen
18
18
 
19
19
  /**
20
20
  * @export
21
- * @class BasicState
21
+ * @class UmbBasicState
22
22
  * @extends {BehaviorSubject<T>}
23
23
  * @description - A RxJS BehaviorSubject this Subject ensures the data is unique, not updating any Observes unless there is an actual change of the value.
24
24
  */
25
- declare class BasicState<T> extends BehaviorSubject<T> {
25
+ declare class UmbBasicState<T> extends BehaviorSubject<T> {
26
26
  constructor(initialData: T);
27
27
  next(newData: T): void;
28
28
  }
29
29
 
30
30
  /**
31
31
  * @export
32
- * @class BooleanState
32
+ * @class UmbBooleanState
33
33
  * @extends {BehaviorSubject<T>}
34
34
  * @description - A RxJS BehaviorSubject this Subject ensures the data is unique, not updating any Observes unless there is an actual change of the value.
35
35
  */
36
- declare class BooleanState<T> extends BasicState<T | boolean> {
36
+ declare class UmbBooleanState<T> extends UmbBasicState<T | boolean> {
37
37
  constructor(initialData: T | boolean);
38
38
  }
39
39
 
40
40
  /**
41
41
  * @export
42
- * @class NumberState
42
+ * @class UmbNumberState
43
43
  * @extends {BehaviorSubject<T>}
44
44
  * @description - A RxJS BehaviorSubject this Subject ensures the data is unique, not updating any Observes unless there is an actual change of the value.
45
45
  */
46
- declare class NumberState<T> extends BasicState<T | number> {
46
+ declare class UmbNumberState<T> extends UmbBasicState<T | number> {
47
47
  constructor(initialData: T | number);
48
48
  }
49
49
 
50
50
  /**
51
51
  * @export
52
- * @class StringState
53
- * @extends {BasicState<T>}
52
+ * @class UmbStringState
53
+ * @extends {UmbBasicState<T>}
54
54
  * @description - A RxJS BehaviorSubject this Subject ensures the data is unique, not updating any Observes unless there is an actual change of the value.
55
55
  */
56
- declare class StringState<T> extends BasicState<T | string> {
56
+ declare class UmbStringState<T> extends UmbBasicState<T | string> {
57
57
  constructor(initialData: T | string);
58
58
  }
59
59
 
60
- interface ClassStateData {
61
- equal(otherClass: ClassStateData): boolean;
60
+ interface UmbClassStateData {
61
+ equal(otherClass: UmbClassStateData): boolean;
62
62
  }
63
63
  /**
64
64
  * @export
65
- * @class ClassState
65
+ * @class UmbClassState
66
66
  * @extends {BehaviorSubject<T>}
67
67
  * @description - A RxJS BehaviorSubject which can hold class instance which has a equal method to compare in coming instances for changes.
68
68
  */
69
- declare class ClassState<T extends ClassStateData | undefined | null> extends BehaviorSubject<T> {
69
+ declare class UmbClassState<T extends UmbClassStateData | undefined | null> extends BehaviorSubject<T> {
70
70
  constructor(initialData: T);
71
71
  next(newData: T): void;
72
72
  }
@@ -77,12 +77,12 @@ type MemoizationFunction<R> = (previousResult: R, currentResult: R) => boolean;
77
77
 
78
78
  /**
79
79
  * @export
80
- * @class DeepState
80
+ * @class UmbDeepState
81
81
  * @extends {BehaviorSubject<T>}
82
82
  * @description - A RxJS BehaviorSubject which deepFreezes the data to ensure its not manipulated from any implementations.
83
83
  * Additionally the Subject ensures the data is unique, not updating any Observes unless there is an actual change of the content.
84
84
  */
85
- declare class DeepState<T> extends BehaviorSubject<T> {
85
+ declare class UmbDeepState<T> extends BehaviorSubject<T> {
86
86
  constructor(initialData: T);
87
87
  getObservablePart<ReturnType>(mappingFunction: MappingFunction<T, ReturnType>, memoizationFunction?: MemoizationFunction<ReturnType>): rxjs.Observable<ReturnType>;
88
88
  next(newData: T): void;
@@ -90,14 +90,14 @@ declare class DeepState<T> extends BehaviorSubject<T> {
90
90
 
91
91
  /**
92
92
  * @export
93
- * @class ArrayState
94
- * @extends {DeepState<T>}
93
+ * @class UmbArrayState
94
+ * @extends {UmbDeepState<T>}
95
95
  * @description - A RxJS BehaviorSubject which deepFreezes the object-data to ensure its not manipulated from any implementations.
96
96
  * Additionally the Subject ensures the data is unique, not updating any Observes unless there is an actual change of the content.
97
97
  *
98
98
  * The ArrayState provides methods to append data when the data is an Object.
99
99
  */
100
- declare class ArrayState<T> extends DeepState<T[]> {
100
+ declare class UmbArrayState<T> extends UmbDeepState<T[]> {
101
101
  #private;
102
102
  constructor(initialData: T[], getUniqueMethod?: (entry: T) => unknown);
103
103
  /**
@@ -109,7 +109,7 @@ declare class ArrayState<T> extends DeepState<T[]> {
109
109
  * { key: 1, value: 'foo'},
110
110
  * { key: 2, value: 'bar'}
111
111
  * ];
112
- * const myState = new ArrayState(data, (x) => x.key);
112
+ * const myState = new UmbArrayState(data, (x) => x.key);
113
113
  * myState.sortBy((a, b) => (a.sortOrder || 0) - (b.sortOrder || 0));
114
114
  */
115
115
  sortBy(sortMethod?: (a: T, b: T) => number): this;
@@ -117,35 +117,35 @@ declare class ArrayState<T> extends DeepState<T[]> {
117
117
  /**
118
118
  * @method remove
119
119
  * @param {unknown[]} uniques - The unique values to remove.
120
- * @return {ArrayState<T>} Reference to it self.
120
+ * @return {UmbArrayState<T>} Reference to it self.
121
121
  * @description - Remove some new data of this Subject.
122
122
  * @example <caption>Example remove entry with id '1' and '2'</caption>
123
123
  * const data = [
124
124
  * { id: 1, value: 'foo'},
125
125
  * { id: 2, value: 'bar'}
126
126
  * ];
127
- * const myState = new ArrayState(data, (x) => x.id);
127
+ * const myState = new UmbArrayState(data, (x) => x.id);
128
128
  * myState.remove([1, 2]);
129
129
  */
130
130
  remove(uniques: unknown[]): this;
131
131
  /**
132
132
  * @method removeOne
133
133
  * @param {unknown} unique - The unique value to remove.
134
- * @return {ArrayState<T>} Reference to it self.
134
+ * @return {UmbArrayState<T>} Reference to it self.
135
135
  * @description - Remove some new data of this Subject.
136
136
  * @example <caption>Example remove entry with id '1'</caption>
137
137
  * const data = [
138
138
  * { id: 1, value: 'foo'},
139
139
  * { id: 2, value: 'bar'}
140
140
  * ];
141
- * const myState = new ArrayState(data, (x) => x.id);
141
+ * const myState = new UmbArrayState(data, (x) => x.id);
142
142
  * myState.removeOne(1);
143
143
  */
144
144
  removeOne(unique: unknown): this;
145
145
  /**
146
146
  * @method filter
147
147
  * @param {unknown} filterMethod - The unique value to remove.
148
- * @return {ArrayState<T>} Reference to it self.
148
+ * @return {UmbArrayState<T>} Reference to it self.
149
149
  * @description - Remove some new data of this Subject.
150
150
  * @example <caption>Example remove entry with key '1'</caption>
151
151
  * const data = [
@@ -153,7 +153,7 @@ declare class ArrayState<T> extends DeepState<T[]> {
153
153
  * { key: 2, value: 'bar'},
154
154
  * { key: 3, value: 'poo'}
155
155
  * ];
156
- * const myState = new ArrayState(data, (x) => x.key);
156
+ * const myState = new UmbArrayState(data, (x) => x.key);
157
157
  * myState.filter((entry) => entry.key !== 1);
158
158
  *
159
159
  * Result:
@@ -167,28 +167,28 @@ declare class ArrayState<T> extends DeepState<T[]> {
167
167
  /**
168
168
  * @method appendOne
169
169
  * @param {T} entry - new data to be added in this Subject.
170
- * @return {ArrayState<T>} Reference to it self.
170
+ * @return {UmbArrayState<T>} Reference to it self.
171
171
  * @description - Append some new data to this Subject.
172
172
  * @example <caption>Example append some data.</caption>
173
173
  * const data = [
174
174
  * { key: 1, value: 'foo'},
175
175
  * { key: 2, value: 'bar'}
176
176
  * ];
177
- * const myState = new ArrayState(data);
177
+ * const myState = new UmbArrayState(data);
178
178
  * myState.append({ key: 1, value: 'replaced-foo'});
179
179
  */
180
180
  appendOne(entry: T): this;
181
181
  /**
182
182
  * @method append
183
183
  * @param {T[]} entries - A array of new data to be added in this Subject.
184
- * @return {ArrayState<T>} Reference to it self.
184
+ * @return {UmbArrayState<T>} Reference to it self.
185
185
  * @description - Append some new data to this Subject, if it compares to existing data it will replace it.
186
186
  * @example <caption>Example append some data.</caption>
187
187
  * const data = [
188
188
  * { key: 1, value: 'foo'},
189
189
  * { key: 2, value: 'bar'}
190
190
  * ];
191
- * const myState = new ArrayState(data);
191
+ * const myState = new UmbArrayState(data);
192
192
  * myState.append([
193
193
  * { key: 1, value: 'replaced-foo'},
194
194
  * { key: 3, value: 'another-bla'}
@@ -199,14 +199,14 @@ declare class ArrayState<T> extends DeepState<T[]> {
199
199
  * @method updateOne
200
200
  * @param {unknown} unique - Unique value to find entry to update.
201
201
  * @param {Partial<T>} entry - new data to be added in this Subject.
202
- * @return {ArrayState<T>} Reference to it self.
202
+ * @return {UmbArrayState<T>} Reference to it self.
203
203
  * @description - Update a item with some new data, requires the ArrayState to be constructed with a getUnique method.
204
204
  * @example <caption>Example append some data.</caption>
205
205
  * const data = [
206
206
  * { key: 1, value: 'foo'},
207
207
  * { key: 2, value: 'bar'}
208
208
  * ];
209
- * const myState = new ArrayState(data, (x) => x.key);
209
+ * const myState = new UmbArrayState(data, (x) => x.key);
210
210
  * myState.updateOne(2, {value: 'updated-bar'});
211
211
  */
212
212
  updateOne(unique: unknown, entry: Partial<T>): this;
@@ -214,22 +214,22 @@ declare class ArrayState<T> extends DeepState<T[]> {
214
214
 
215
215
  /**
216
216
  * @export
217
- * @class ObjectState
218
- * @extends {DeepState<T>}
217
+ * @class UmbObjectState
218
+ * @extends {UmbDeepState<T>}
219
219
  * @description - A RxJS BehaviorSubject which deepFreezes the object-data to ensure its not manipulated from any implementations.
220
220
  * Additionally the Subject ensures the data is unique, not updating any Observes unless there is an actual change of the content.
221
221
  *
222
- * The ObjectState provides methods to append data when the data is an Object.
222
+ * The UmbObjectState provides methods to append data when the data is an Object.
223
223
  */
224
- declare class ObjectState<T> extends DeepState<T> {
224
+ declare class UmbObjectState<T> extends UmbDeepState<T> {
225
225
  /**
226
226
  * @method update
227
227
  * @param {Partial<T>} partialData - A object containing some of the data to update in this Subject.
228
228
  * @description - Append some new data to this Object.
229
- * @return {ObjectState<T>} Reference to it self.
229
+ * @return {UmbObjectState<T>} Reference to it self.
230
230
  * @example <caption>Example append some data.</caption>
231
231
  * const data = {key: 'myKey', value: 'myInitialValue'};
232
- * const myState = new ObjectState(data);
232
+ * const myState = new UmbObjectState(data);
233
233
  * myState.update({value: 'myNewValue'});
234
234
  */
235
235
  update(partialData: Partial<T>): this;
@@ -254,13 +254,25 @@ declare function createObservablePart<R, T>(source$: Observable<T>, mappingFunct
254
254
  * @param {(mappable: T) => R} mappingFunction - Method to return the part for this Observable to return.
255
255
  * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the data has changed. Should return true when data is different.
256
256
  * @description - Creates a RxJS Observable from RxJS Subject.
257
- * @example <caption>Example append new entry for a ArrayState or a part of DeepState/ObjectState it which is an array. Where the key is unique and the item will be updated if matched with existing.</caption>
257
+ * @example <caption>Example append new entry for a ArrayState or a part of UmbDeepState/UmbObjectState it which is an array. Where the key is unique and the item will be updated if matched with existing.</caption>
258
258
  * const entry = {id: 'myKey', value: 'myValue'};
259
259
  * const newDataSet = appendToFrozenArray(mySubject.getValue(), entry, x => x.id === id);
260
260
  * mySubject.next(newDataSet);
261
261
  */
262
262
  declare function appendToFrozenArray<T>(data: T[], entry: T, getUniqueMethod?: (entry: T) => unknown): T[];
263
263
 
264
+ /**
265
+ * @export
266
+ * @method filterFrozenArray
267
+ * @param {Array<T>} data - RxJS Subject to use for this Observable.
268
+ * @param {(entry: T) => boolean} filterMethod - Method to filter the array.
269
+ * @description - Creates a RxJS Observable from RxJS Subject.
270
+ * @example <caption>Example remove an entry of a ArrayState or a part of DeepState/ObjectState it which is an array. Where the key is unique and the item will be updated if matched with existing.</caption>
271
+ * const newDataSet = filterFrozenArray(mySubject.getValue(), x => x.id !== "myKey");
272
+ * mySubject.next(newDataSet);
273
+ */
274
+ declare function filterFrozenArray<T>(data: T[], filterMethod: (entry: T) => boolean): T[];
275
+
264
276
  /**
265
277
  * @export
266
278
  * @method partialUpdateFrozenArray
@@ -268,11 +280,11 @@ declare function appendToFrozenArray<T>(data: T[], entry: T, getUniqueMethod?: (
268
280
  * @param {(mappable: T) => R} mappingFunction - Method to return the part for this Observable to return.
269
281
  * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the data has changed. Should return true when data is different.
270
282
  * @description - Creates a RxJS Observable from RxJS Subject.
271
- * @example <caption>Example append new entry for a ArrayState or a part of DeepState/ObjectState it which is an array. Where the key is unique and the item will be updated if matched with existing.</caption>
283
+ * @example <caption>Example append new entry for a ArrayState or a part of UmbDeepState/UmbObjectState it which is an array. Where the key is unique and the item will be updated if matched with existing.</caption>
272
284
  * const partialEntry = {value: 'myValue'};
273
285
  * const newDataSet = partialUpdateFrozenArray(mySubject.getValue(), partialEntry, x => x.key === 'myKey');
274
286
  * mySubject.next(newDataSet);
275
287
  */
276
288
  declare function partialUpdateFrozenArray<T>(data: T[], partialEntry: Partial<T>, findMethod: (entry: T) => boolean): T[];
277
289
 
278
- export { ArrayState, BasicState, BooleanState, ClassState, DeepState, MappingFunction, NumberState, ObjectState, StringState, UmbObserver, UmbObserverController, appendToFrozenArray, createObservablePart, partialUpdateFrozenArray };
290
+ export { MappingFunction, UmbArrayState, UmbBasicState, UmbBooleanState, UmbClassState, UmbDeepState, UmbNumberState, UmbObjectState, UmbObserver, UmbObserverController, UmbStringState, appendToFrozenArray, createObservablePart, filterFrozenArray, partialUpdateFrozenArray };