@umbraco-cms/backoffice 1.0.0-next.5e6a5e07 → 1.0.0-next.6c429eee

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
@@ -6,6 +6,7 @@ import { LitElement, TemplateResult } from 'lit';
6
6
  import { UUIModalDialogElement, UUIModalSidebarElement, UUIModalSidebarSize } from '@umbraco-ui/uui';
7
7
  import { UmbControllerHostElement, UmbControllerInterface } from './controller';
8
8
  import { UmbContextToken } from './context-api';
9
+ import { Params } from './router';
9
10
  import { UmbModalToken as UmbModalToken$1, UmbModalConfig as UmbModalConfig$1, UmbPickerModalData as UmbPickerModalData$1 } from './modal';
10
11
  import { LanguageResponseModel, FolderReponseModel } from './backend-api';
11
12
  import { UserDetails } from './models';
@@ -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;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@umbraco-cms/backoffice",
3
- "version": "1.0.0-next.5e6a5e07",
3
+ "version": "1.0.0-next.6c429eee",
4
4
  "license": "MIT",
5
5
  "keywords": [
6
6
  "umbraco",
package/repository.d.ts CHANGED
@@ -8,7 +8,7 @@ interface DataSourceResponse<T = undefined> {
8
8
  }
9
9
 
10
10
  interface UmbDataSource<CreateRequestType, UpdateRequestType, ResponseType> {
11
- createScaffold(parentId: string | null): Promise<DataSourceResponse$1<ResponseType>>;
11
+ createScaffold(parentId: string | null): Promise<DataSourceResponse$1<CreateRequestType>>;
12
12
  get(unique: string): Promise<DataSourceResponse$1<ResponseType>>;
13
13
  insert(data: CreateRequestType): Promise<any>;
14
14
  update(unique: string, data: UpdateRequestType): Promise<DataSourceResponse$1<ResponseType>>;
@@ -29,24 +29,18 @@ interface UmbTreeDataSource<PagedItemsType = any, ItemsType = any> {
29
29
  getItems(unique: Array<string>): Promise<DataSourceResponse$1<Array<ItemsType>>>;
30
30
  }
31
31
 
32
- interface UmbDetailRepository<DetailType> {
33
- createScaffold(parentId: string | null): Promise<{
34
- data?: DetailType;
35
- error?: ProblemDetailsModel;
36
- }>;
37
- requestById(id: string): Promise<{
38
- data?: DetailType;
39
- error?: ProblemDetailsModel;
40
- }>;
41
- create(data: DetailType): Promise<{
42
- error?: ProblemDetailsModel;
43
- }>;
44
- save(data: DetailType): Promise<{
45
- error?: ProblemDetailsModel;
46
- }>;
47
- delete(id: string): Promise<{
48
- error?: ProblemDetailsModel;
49
- }>;
32
+ interface UmbRepositoryErrorResponse {
33
+ error?: ProblemDetailsModel;
34
+ }
35
+ interface UmbRepositoryResponse<T> extends UmbRepositoryErrorResponse {
36
+ data?: T;
37
+ }
38
+ interface UmbDetailRepository<CreateRequestType = any, UpdateRequestType = any, ResponseType = any> {
39
+ createScaffold(parentId: string | null): Promise<UmbRepositoryResponse<CreateRequestType>>;
40
+ requestById(id: string): Promise<UmbRepositoryResponse<ResponseType>>;
41
+ create(data: CreateRequestType): Promise<UmbRepositoryErrorResponse>;
42
+ save(id: string, data: UpdateRequestType): Promise<UmbRepositoryErrorResponse>;
43
+ delete(id: string): Promise<UmbRepositoryErrorResponse>;
50
44
  }
51
45
 
52
46
  interface UmbPagedData<T> {
@@ -96,4 +90,4 @@ interface UmbFolderRepository {
96
90
  }>;
97
91
  }
98
92
 
99
- export { DataSourceResponse, UmbDataSource, UmbDetailRepository, UmbFolderDataSource, UmbFolderRepository, UmbPagedData, UmbTreeDataSource, UmbTreeRepository };
93
+ export { DataSourceResponse, UmbDataSource, UmbDetailRepository, UmbFolderDataSource, UmbFolderRepository, UmbPagedData, UmbRepositoryErrorResponse, UmbRepositoryResponse, UmbTreeDataSource, UmbTreeRepository };