@limetech/lime-web-components 5.0.0 → 5.1.0

package/dist/limeobject/repository.d.ts

@@ -1,45 +1,53 @@
 import { Expression } from '../query';
 import { StateRepository } from '../core';
+/**
+ * @public
+ * @group Lime objects
+ */
 export interface LimeObjectRepository extends StateRepository {
     /**
      * Load the specified limeobject into the state
      *
-     * @param {string} limetype
-     * @param {number} id
+     * @param limetype -
+     * @param id -
      */
     loadObject(limetype: string, id: number): void;
     /**
      * Load objects of the specified limetype into the state
      *
-     * @param {string} limetype name of the limetype
-     * @param {LoadOptions} options options about the objects to load
-     * @returns {ObjectResponse} list of objects together with total count of objects
+     * @param limetype - name of the limetype
+     * @param options - options about the objects to load
+     * @returns list of objects together with total count of objects
      */
     loadObjects(limetype: string, options?: LoadOptions): Promise<ObjectResponse>;
     /**
      * Load related objects into the state
      *
-     * @param {string} limetype name of the limetype of the owning limeobject
-     * @param {number} id the id of the owning limeobject
-     * @param {string} property name of the property that contain the relations
-     * @param {LoadOptions} options options about the objects to load
-     * @returns {ObjectResponse} list of related objects together with total count of objects
+     * @param limetype - name of the limetype of the owning limeobject
+     * @param id - the id of the owning limeobject
+     * @param property - name of the property that contain the relations
+     * @param options - options about the objects to load
+     * @returns list of related objects together with total count of objects
      */
     loadRelations(limetype: string, id: number, property: string, options?: LoadOptions): Promise<ObjectResponse>;
     /**
      * Loads a schema for the limetype.
      *
-     * @param {string} limetype name of the limetype of the owning limeobject
+     * @param limetype - name of the limetype of the owning limeobject
      */
     loadSchema(limetype: string): Promise<object>;
     /**
      * Delete the specified limeobject
      *
-     * @param {string} limetype name of the limetype of the limeobject
-     * @param {number} id the id of the limeobject
+     * @param limetype - name of the limetype of the limeobject
+     * @param id - the id of the limeobject
      */
     deleteObject(limetype: string, id: number): Promise<void>;
 }
+/**
+ * @public
+ * @group Lime objects
+ */
 export interface LoadOptions {
     /**
      * Maximum number of objects to load
@@ -58,6 +66,10 @@ export interface LoadOptions {
      */
     order?: PropertyOrder[];
 }
+/**
+ * @public
+ * @group Lime objects
+ */
 export interface PropertyOrder {
     /**
      * Name of the property to sort on
@@ -68,6 +80,10 @@ export interface PropertyOrder {
      */
     direction: 'ASC' | 'DESC';
 }
+/**
+ * @public
+ * @group Lime objects
+ */
 export interface ObjectResponse {
     /**
      * The objects that matched the query
@@ -86,15 +102,24 @@ export interface ObjectResponse {
      */
     aggregates?: AggregationGroups;
 }
+/**
+ * @public
+ * @group Lime objects
+ */
 export interface AggregationGroups {
     /**
      * Name of the aggregation group along with a list of aggregations
      */
     [name: string]: ObjectAggregation[];
 }
+/**
+ * @public
+ * @group Lime objects
+ */
 export interface ObjectAggregation {
     /**
      * Name of the property being aggregated along with its aggregated value
      */
     [property: string]: number | string;
 }
+//# sourceMappingURL=repository.d.ts.map

package/dist/limeobject/repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/limeobject/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IACzD;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/C;;;;;;OAMG;IACH,WAAW,CACP,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,aAAa,CACT,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACvC"}

package/dist/limeobject/types.d.ts

@@ -3,7 +3,7 @@ declare const SERVICE_NAME = "state.limeobjects";
 declare module '../core/platform' {
     interface PlatformServiceNameType {
         /**
-         * @see {@link Service LimeObjectRepository}
+         * @see {@link Service | LimeObjectRepository}
          */
         LimeObjectRepository: typeof SERVICE_NAME;
     }
@@ -12,3 +12,4 @@ declare module '../core/platform' {
     }
 }
 export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/limeobject/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/limeobject/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,IAAI,OAAO,EAAE,MAAM,cAAc,CAAC;AAG/D,QAAA,MAAM,YAAY,sBAAsB,CAAC;AAIzC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,oBAAoB,EAAE,OAAO,YAAY,CAAC;KAC7C;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC;KACvE;CACJ"}

package/dist/limetype/acl.d.ts

@@ -1,6 +1,11 @@
+/**
+ * @public
+ * @group Lime types
+ */
 export interface Acl {
     delete: boolean;
     read: boolean;
     update: boolean;
     create: boolean;
 }
+//# sourceMappingURL=acl.d.ts.map

package/dist/limetype/acl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acl.d.ts","sourceRoot":"","sources":["../../src/limetype/acl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,GAAG;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACnB"}

package/dist/limetype/decorator.d.ts

@@ -1,6 +1,8 @@
 import { StateOptions, ContextAwareStateOptions } from '../core';
 /**
  * Config for the {@link SelectLimeTypes} state decorator
+ * @public
+ * @group Lime types
  */
 export interface SelectLimeTypesOptions extends StateOptions {
     name?: string;
@@ -8,14 +10,19 @@ export interface SelectLimeTypesOptions extends StateOptions {
 /**
  * Gets an object with all limetypes where name is used as key
  *
- * @param {SelectLimeTypesOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Lime types
  */
 export declare function SelectLimeTypes(options?: SelectLimeTypesOptions): PropertyDecorator;
 /**
  * Get the limetype for the current context
  *
- * @param {StateOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Lime types
  */
 export declare function SelectCurrentLimeType(options?: ContextAwareStateOptions): PropertyDecorator;
+//# sourceMappingURL=decorator.d.ts.map

package/dist/limetype/decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/limetype/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEZ,wBAAwB,EAC3B,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC3B,OAAO,GAAE,sBAA2B,GACrC,iBAAiB,CAMnB;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACjC,OAAO,GAAE,wBAA6B,GACvC,iBAAiB,CAQnB"}

package/dist/limetype/decorator.js

@@ -3,8 +3,10 @@ import { createStateDecorator } from '../core/decorators/factory';
 /**
  * Gets an object with all limetypes where name is used as key
  *
- * @param {SelectLimeTypesOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Lime types
  */
 export function SelectLimeTypes(options = {}) {
     const config = {
@@ -15,8 +17,10 @@ export function SelectLimeTypes(options = {}) {
 /**
  * Get the limetype for the current context
  *
- * @param {StateOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Lime types
  */
 export function SelectCurrentLimeType(options = {}) {
     const config = {

package/dist/limetype/index.d.ts

@@ -3,3 +3,4 @@ export * from './limetype';
 export * from './property';
 export * from './types';
 export * from './decorator';
+//# sourceMappingURL=index.d.ts.map

package/dist/limetype/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/limetype/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}

package/dist/limetype/limetype.d.ts

@@ -1,5 +1,9 @@
 import { Acl } from './acl';
 import { LimeProperty } from './property';
+/**
+ * @public
+ * @group Lime types
+ */
 export interface LimeType {
     name: string;
     label: string;
@@ -12,14 +16,17 @@ export interface LimeType {
     /**
      * Get a property by name
      *
-     * @param {string} name name of property to get. Allows a path to be
+     * @param name - name of property to get. Allows a path to be
      * specified using dot notation to get properties of relations
      *
      * @throws Will throw an error containing the name of the missing property
-     * @returns {LimeProperty} the property specified by the name argument
+     * @returns the property specified by the name argument
      *
      * @example
+     * ```
      * const phoneProperty = dealLimetype.getProperty('company.phone')
+     * ```
      */
     getProperty(name: string): LimeProperty;
 }
+//# sourceMappingURL=limetype.d.ts.map

package/dist/limetype/limetype.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"limetype.d.ts","sourceRoot":"","sources":["../../src/limetype/limetype.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,GAAG,CAAC;IACT,SAAS,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAEzC;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC;CAC3C"}

package/dist/limetype/property.d.ts

@@ -1,5 +1,9 @@
 import { Acl } from './acl';
 import { LimeType } from './limetype';
+/**
+ * @public
+ * @group Lime types
+ */
 export interface LimeProperty {
     acl: Acl;
     defaultvalue: any;
@@ -17,6 +21,10 @@ export interface LimeProperty {
         getBackreference: () => LimeProperty;
     };
 }
+/**
+ * @public
+ * @group Lime types
+ */
 export interface Option {
     key: string;
     inactive: boolean;
@@ -24,9 +32,34 @@ export interface Option {
     order?: number;
     id?: number;
 }
+/**
+ * @public
+ * @group Lime types
+ */
 export declare type PropertyType = 'string' | 'text' | 'phone' | 'integer' | 'decimal' | 'percent' | 'time' | 'timeofday' | 'date' | 'year' | 'quarter' | 'month' | 'yesno' | 'link' | 'user' | 'xml' | 'option' | 'set' | 'file' | 'hasone' | 'hasmany' | 'belongsto' | 'hasandbelongstomany' | 'system';
+/**
+ * @public
+ * @group Lime types
+ */
 export declare function isRelation(property: LimeProperty): boolean;
+/**
+ * @public
+ * @group Lime types
+ */
 export declare function isSingleRelation(property: LimeProperty): boolean;
+/**
+ * @public
+ * @group Lime types
+ */
 export declare function isDate(property: LimeProperty): boolean;
+/**
+ * @public
+ * @group Lime types
+ */
 export declare function isString(property: LimeProperty): boolean;
+/**
+ * @public
+ * @group Lime types
+ */
 export declare function isFloat(property: LimeProperty): boolean;
+//# sourceMappingURL=property.d.ts.map

package/dist/limetype/property.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../src/limetype/property.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,GAAG,EAAE,GAAG,CAAC;IACT,YAAY,EAAE,GAAG,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE;QACP,WAAW,EAAE,MAAM,QAAQ,CAAC;QAC5B,gBAAgB,EAAE,MAAM,YAAY,CAAC;KACxC,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,oBAAY,YAAY,GAClB,QAAQ,GACR,MAAM,GACN,OAAO,GACP,SAAS,GACT,SAAS,GACT,SAAS,GACT,MAAM,GACN,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,QAAQ,GACR,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,qBAAqB,GACrB,QAAQ,CAAC;AAEf;;;GAGG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,YAAY,WAShD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,YAAY,WAItD;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,YAAY,WAW5C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,YAAY,WAI9C;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,YAAY,WAI7C"}

package/dist/limetype/property.js

@@ -1,3 +1,7 @@
+/**
+ * @public
+ * @group Lime types
+ */
 export function isRelation(property) {
     const propTypes = [
         'belongsto',
@@ -7,10 +11,18 @@ export function isRelation(property) {
     ];
     return property && propTypes.includes(property.type);
 }
+/**
+ * @public
+ * @group Lime types
+ */
 export function isSingleRelation(property) {
     const propTypes = ['belongsto', 'hasone'];
     return property && propTypes.includes(property.type);
 }
+/**
+ * @public
+ * @group Lime types
+ */
 export function isDate(property) {
     const propTypes = [
         'time',
@@ -22,10 +34,18 @@ export function isDate(property) {
     ];
     return property && propTypes.includes(property.type);
 }
+/**
+ * @public
+ * @group Lime types
+ */
 export function isString(property) {
     const propTypes = ['string', 'text', 'phone', 'link'];
     return property && propTypes.includes(property.type);
 }
+/**
+ * @public
+ * @group Lime types
+ */
 export function isFloat(property) {
     const propTypes = ['decimal', 'percent'];
     return property && propTypes.includes(property.type);

package/dist/limetype/types.d.ts

@@ -12,3 +12,4 @@ declare module '../core/platform' {
     }
 }
 export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/limetype/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/limetype/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG1C,QAAA,MAAM,YAAY,oBAAoB,CAAC;AAIvC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,kBAAkB,EAAE,OAAO,YAAY,CAAC;KAC3C;IAED,UAAU,wBAAwB;QAC9B,GAAG,CACC,IAAI,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,GACpD,eAAe,CAAC;KACtB;CACJ"}

package/dist/navigator/command.d.ts

@@ -3,22 +3,13 @@ import { Location } from './navigator';
  * Navigates to a new location
  *
  * @id `navigator.navigate`
+ * @beta
+ * @group Navigation
  */
 export declare class NavigateCommand implements Partial<Location> {
-    /**
-     * @inheritdoc
-     */
     path?: string;
-    /**
-     * @inheritdoc
-     */
     query?: Record<string, unknown>;
-    /**
-     * @inheritdoc
-     */
     hash?: string;
-    /**
-     * @inheritdoc
-     */
     state?: unknown;
 }
+//# sourceMappingURL=command.d.ts.map

package/dist/navigator/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../src/navigator/command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;;;;GAMG;AACH,qBAGa,eAAgB,YAAW,OAAO,CAAC,QAAQ,CAAC;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CAC1B"}

package/dist/navigator/command.js

@@ -4,6 +4,8 @@ import { Command } from '../commandbus';
  * Navigates to a new location
  *
  * @id `navigator.navigate`
+ * @beta
+ * @group Navigation
  */
 let NavigateCommand = class NavigateCommand {
 };

package/dist/navigator/decorator.d.ts

@@ -1,6 +1,8 @@
 import { ContextAwareStateOptions } from '../core';
 /**
  * Config for the {@link SelectQueryParam} decorator
+ * @beta
+ * @group Navigation
  */
 export interface SelectQueryParamOptions extends ContextAwareStateOptions {
     /**
@@ -11,8 +13,10 @@ export interface SelectQueryParamOptions extends ContextAwareStateOptions {
 /**
  * Gets a named query param from the location
  *
- * @experimental
- * @param {StateOptions} options state decorator options
- * @returns {PropertyDecorator} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @beta
+ * @group Navigation
  */
 export declare function SelectQueryParam(options: SelectQueryParamOptions): PropertyDecorator;
+//# sourceMappingURL=decorator.d.ts.map

package/dist/navigator/decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/navigator/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAuB,MAAM,SAAS,CAAC;AAMxE;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACrE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC5B,OAAO,EAAE,uBAAuB,GACjC,iBAAiB,CAMnB"}

package/dist/navigator/decorator.js

@@ -3,9 +3,10 @@ import { createStateDecorator, } from '../core/decorators/factory';
 /**
  * Gets a named query param from the location
  *
- * @experimental
- * @param {StateOptions} options state decorator options
- * @returns {PropertyDecorator} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @beta
+ * @group Navigation
  */
 export function SelectQueryParam(options) {
     const config = {

package/dist/navigator/index.d.ts

@@ -2,3 +2,4 @@ export * from './navigator';
 export * from './types';
 export * from './decorator';
 export * from './command';
+//# sourceMappingURL=index.d.ts.map

package/dist/navigator/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/navigator/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}

package/dist/navigator/navigator.d.ts

@@ -10,6 +10,7 @@
  * New locations can be registered using the {@link RouteRegistry} service
  *
  * @example
+ * ```
  * // Listen on navigation events
  * eventDispatcher.addListener('navigate', onNavigate);
  * navigator.navigate('/object/deal/1001');
@@ -17,8 +18,10 @@
  * function onNavigate(event: NavigationEvent) {
  *     console.log(event.detail);
  * }
+ * ```
  *
- * @experimental
+ * @beta
+ * @group Navigation
  */
 export interface Navigator {
     /**
@@ -27,8 +30,8 @@ export interface Navigator {
      * @emits navigate - When the location has been changed the
      * {@link EventDispatcher} will emit a {@link NavigationEvent}
      *
-     * @param {string} path path to the location
-     * @param query query string parameters to append to the URL
+     * @param path - path to the location
+     * @param query - query string parameters to append to the URL
      */
     navigate(path: string, query?: Location['query']): void;
     /**
@@ -45,15 +48,15 @@ export interface Navigator {
      * When replacing, state will only be changed if a new value is provided.
      *
      * @emits navigate - When the location has been changed the
-     * {@link EventDispatcherService} will emit a {@link NavigationEvent}
+     * {@link EventDispatcher} will emit a {@link NavigationEvent}
      *
-     * @param location a new location or parts of the location to replace
+     * @param location - a new location or parts of the location to replace
      */
     navigate(location: LocationChange): void;
     /**
      * Get the current location
      *
-     * @return {Location}
+     * @returns
      */
     getLocation(): Location;
     /**
@@ -71,6 +74,7 @@ export interface Navigator {
      * of them returns true.
      *
      * @example
+     * ```
      * navigator.addBlocker(myBlocker);
      *
      * function myBlocker(transition) {
@@ -82,26 +86,31 @@ export interface Navigator {
      *   });
      *   return true;
      * }
+     * ```
      *
-     * @param {Blocker} blocker function to be called before navigation
+     * @param blocker - function to be called before navigation
      */
     addBlocker(blocker: Blocker): void;
     /**
      * Removes a previously configured blocker.
      *
-     * @param {Blocker} blocker previously added blocker function
+     * @param blocker - previously added blocker function
      */
     removeBlocker(blocker: Blocker): void;
     /**
      * Create a URL for the given location
      *
-     * @param {Partial<Location>} location the location to create a URL for.
+     * @param location - the location to create a URL for.
      * Any `state` of the location will be ignored.
      *
-     * @return {URL} the URL to the location
+     * @returns the URL to the location
      */
     createUrl(location: Partial<Location>): URL;
 }
+/**
+ * @beta
+ * @group Navigation
+ */
 export declare type Location = {
     /**
      * The path to the location
@@ -120,6 +129,10 @@ export declare type Location = {
      */
     state: unknown;
 };
+/**
+ * @beta
+ * @group Navigation
+ */
 export declare type LocationChange = Partial<Location> & {
     /**
      * Specifies whether to push a new entry or replace the current entry in
@@ -130,29 +143,44 @@ export declare type LocationChange = Partial<Location> & {
 /**
  * @event navigate - Emitted when a new location is navigated to or the current
  * location is updated
+ * @beta
+ * @group Navigation
  */
 export declare type NavigationEvent = CustomEvent<Location>;
 /**
  * Function to retry navigation
+ * @beta
+ * @group Navigation
  */
 export declare type Retry = () => void;
 /**
  * {@link Transition} describes the transition when navigating from a
  * {@link Location} to another {@link Location}.
  *
- * @param {Location} to location to navigate to
- * @param {Location} from current location before navigation
- * @param {Retry} retry function to retry navigation
+ * @beta
+ * @group Navigation
  */
 export declare type Transition = {
+    /**
+     * Location to navigate to
+     */
     to: Location;
+    /**
+     * Current location before navigation
+     */
     from: Location;
+    /**
+     * Function to retry navigation
+     */
     retry: Retry;
 };
 /**
  * Function to determine if navigation should be blocked or not.
  *
- * @param {Transition} transition the transition to evaluate
+ * @param transition - the transition to evaluate
  * @returns true if navigation should be blocked
+ * @beta
+ * @group Navigation
  */
 export declare type Blocker = (transition: Transition) => boolean;
+//# sourceMappingURL=navigator.d.ts.map

package/dist/navigator/navigator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigator.d.ts","sourceRoot":"","sources":["../../src/navigator/navigator.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAExD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAEzC;;;;OAIG;IACH,WAAW,IAAI,QAAQ,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;CAC/C;AAED;;;GAGG;AACH,oBAAY,QAAQ,GAAG;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,oBAAY,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG;IAC7C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,eAAe,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;AAEpD;;;;GAIG;AACH,oBAAY,KAAK,GAAG,MAAM,IAAI,CAAC;AAE/B;;;;;;GAMG;AACH,oBAAY,UAAU,GAAG;IACrB;;OAEG;IACH,EAAE,EAAE,QAAQ,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,oBAAY,OAAO,GAAG,CAAC,UAAU,EAAE,UAAU,KAAK,OAAO,CAAC"}

package/dist/navigator/types.d.ts

@@ -3,10 +3,10 @@ declare const SERVICE_NAME = "navigator";
 declare module '../core/platform' {
     interface PlatformServiceNameType {
         /**
-         * @see {@link Service Navigator}
+         * @see {@link Service | Navigator}
          *
          * @note Work in progress, do not use!
-         * @private
+         * @beta
          */
         Navigator: typeof SERVICE_NAME;
     }
@@ -15,3 +15,4 @@ declare module '../core/platform' {
     }
 }
 export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/navigator/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigator/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC;AAGnD,QAAA,MAAM,YAAY,cAAc,CAAC;AAIjC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;;;;WAKG;QACH,SAAS,EAAE,OAAO,YAAY,CAAC;KAClC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;KAC5D;CACJ"}

package/dist/notifications/index.d.ts

@@ -1,2 +1,3 @@
 export * from './notifications';
 export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/notifications/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/notifications/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}