@limetech/lime-web-components 5.0.1 → 5.1.0

package/dist/notifications/notifications.d.ts

@@ -1,23 +1,25 @@
 /**
  * Service for displaying different notification messages
+ * @public
+ * @group Notifications
  */
 export interface Notifications {
     /**
      * Display a blocking alert dialog
      *
-     * @param {string} title title of the dialog
-     * @param {string} message message to display in the dialog
-     * @param {AlertOptions} options
-     * @returns {Promise<void>} a promise that will be resolved when the dialog is closed
+     * @param title - title of the dialog
+     * @param message - message to display in the dialog
+     * @param options -
+     * @returns a promise that will be resolved when the dialog is closed
      */
     alert(title: string, message: string, options?: AlertOptions): Promise<void>;
     /**
      * Display a blocking confirm dialog
      *
-     * @param {string} title title of the dialog
-     * @param {string} message message to display in the dialog
-     * @param {ConfirmOptions} options
-     * @returns {Promise<boolean>} a promise that will be resolved to true when the dialog is closed.
+     * @param title - title of the dialog
+     * @param message - message to display in the dialog
+     * @param options -
+     * @returns a promise that will be resolved to true when the dialog is closed.
      * If the accepting button was pressed, the promise will resolve to true.
      * Otherwise, the promise will resolve to false.
      */
@@ -25,9 +27,9 @@ export interface Notifications {
     /**
      * Display a non-blocking notification
      *
-     * @param {string} message message to display in the notification
-     * @param {NotificationOptions} options
-     * @returns {Promise<boolean>} a promise that will be resolved when the notification is closed.
+     * @param message - message to display in the notification
+     * @param options -
+     * @returns a promise that will be resolved when the notification is closed.
      * If the notification has an action button and it was pressed, the promise will resolve to true.
      * Otherwise, the promise will resolve to false.
      */
@@ -35,9 +37,9 @@ export interface Notifications {
     /**
      * Display a non-blocking and non-transient message
      *
-     * @param {string} message message to display in the banner
-     * @param {ReportOptions} options
-     * @returns {Promise<boolean>} a promise that will be resolved when the notification is closed.
+     * @param message - message to display in the banner
+     * @param options -
+     * @returns a promise that will be resolved when the notification is closed.
      * If the notification has an action button and it was pressed, the promise will resolve to true.
      * Otherwise, the promise will resolve to false.
      */
@@ -45,6 +47,8 @@ export interface Notifications {
 }
 /**
  * Options for the confirmation dialog
+ * @public
+ * @group Notifications
  */
 export interface AlertOptions {
     /**
@@ -54,6 +58,8 @@ export interface AlertOptions {
 }
 /**
  * Options for the confirmation dialog
+ * @public
+ * @group Notifications
  */
 export interface ConfirmOptions {
     /**
@@ -67,6 +73,8 @@ export interface ConfirmOptions {
 }
 /**
  * Options for notifications
+ * @public
+ * @group Notifications
  */
 export interface NotificationOptions {
     /**
@@ -88,6 +96,8 @@ export interface NotificationOptions {
 }
 /**
  * Options for reports
+ * @public
+ * @group Notifications
  */
 export interface ReportOptions {
     /**
@@ -99,3 +109,4 @@ export interface ReportOptions {
      */
     icon?: string;
 }
+//# sourceMappingURL=notifications.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../../src/notifications/notifications.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;;;;OAOG;IACH,KAAK,CACD,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;;;;OASG;IACH,OAAO,CACH,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzE;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtE;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/notifications/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/notifications/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,QAAA,MAAM,YAAY,kBAAkB,CAAC;AAIrC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,YAAY,EAAE,OAAO,YAAY,CAAC;KACrC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,cAAc,CAAC,GAAG,aAAa,CAAC;KACrE;CACJ"}

package/dist/query/index.d.ts

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

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

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

package/dist/query/query.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @public
+ * @group Query
+ */
 export interface Query {
     limetype: string;
     limit?: number;
@@ -9,16 +13,28 @@ export interface Query {
         aggregates?: object;
     };
 }
+/**
+ * @public
+ * @group Query
+ */
 export interface QueryResponse {
     objects: any[];
     aggregates: any;
 }
+/**
+ * @public
+ * @group Query
+ */
 export interface Expression {
     key?: string;
     op: Operator;
     exp: any;
     type?: 'filter';
 }
+/**
+ * @public
+ * @group Query
+ */
 export declare enum Operator {
     AND = "AND",
     OR = "OR",
@@ -34,6 +50,10 @@ export declare enum Operator {
     GREATER_OR_EQUAL = ">=",
     ENDS = "=$"
 }
+/**
+ * @public
+ * @group Query
+ */
 export interface Filter {
     id: string;
     limetype: string;
@@ -46,3 +66,4 @@ export interface Filter {
     };
     iduser?: number;
 }
+//# sourceMappingURL=query.d.ts.map

package/dist/query/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/query/query.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,KAAK;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,cAAc,EAAE;QACZ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,UAAU,EAAE,GAAG,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,QAAQ,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,CAAC,EAAE,QAAQ,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAChB,GAAG,QAAQ;IACX,EAAE,OAAO;IACT,GAAG,MAAM;IACT,MAAM,MAAM;IACZ,UAAU,OAAO;IACjB,OAAO,MAAM;IACb,IAAI,MAAM;IACV,EAAE,OAAO;IACT,MAAM,OAAO;IACb,IAAI,MAAM;IACV,aAAa,OAAO;IACpB,gBAAgB,OAAO;IACvB,IAAI,OAAO;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QACF,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;KAC9B,CAAC;IACF,MAAM,EAAE,UAAU,CAAC;IACnB,WAAW,CAAC,EAAE;QACV,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;KAC9B,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/query/query.js

@@ -1,3 +1,7 @@
+/**
+ * @public
+ * @group Query
+ */
 export var Operator;
 (function (Operator) {
     Operator["AND"] = "AND";

package/dist/query/service.d.ts

@@ -1,12 +1,15 @@
 import { Query, QueryResponse } from '../query';
 /**
  * Service for executing queries using the query objects API
+ * @public
+ * @group Query
  */
 export interface QueryService {
     /**
      * Execute a query
      *
-     * @param query
+     * @param query -
      */
     execute(query: Query): Promise<QueryResponse>;
 }
+//# sourceMappingURL=service.d.ts.map

package/dist/query/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/query/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEhD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CACjD"}

package/dist/query/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/query/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,QAAA,MAAM,YAAY,UAAU,CAAC;AAI7B,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,KAAK,EAAE,OAAO,YAAY,CAAC;KAC9B;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC;KAC7D;CACJ"}

package/dist/routeregistry/index.d.ts

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

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

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

package/dist/routeregistry/registry.d.ts

@@ -25,41 +25,52 @@ import { LimeWebComponent } from '../core';
  * - `state`
  *
  * @example
+ * ```
  * // Registering a simple route
  * routeRegistry.registerRoute('/foo', 'foo-component');
+ * ```
  *
  * @example
+ * ```
  * // Registering a route with parameters
  * // `name` will be used as a prop on the component when it renders
  * routeRegistry.registerRoute('/foo/:name', 'foo-component');
+ * ```
  *
  * @example
+ * ```
  * // Registering a route with a context
  * // The `context` prop of the component will have the values of the
  * // `limetype` and `id` parameters
  * routeRegistry.registerRoute('/foo/:limetype/:id', 'foo-component');
+ * ```
  *
- * @experimental
+ * @beta
+ * @group Registering routes
  */
 export interface RouteRegistry {
     /**
      * Register a route for a component.
      *
-     * @param {string} pathPattern - path pattern used to match a component.
+     * @param pathPattern - path pattern used to match a component.
      * For more information about URL patterns read [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API).
-     * @param {string} component - Name of the component to register for the
+     * @param component - Name of the component to register for the
      * specified pattern
      */
     registerRoute(pathPattern: string, component: string): void;
     /**
      * Find the component for a given path.
      *
-     * @param {string} path - The path to match against.
-     * @return {MatchedComponent | undefined} the matched component along with
+     * @param path - The path to match against.
+     * @returns the matched component along with
      * path parameters, or `undefined` if no component could be found.
      */
     findComponent(path: string): MatchedComponent | undefined;
 }
+/**
+ * @beta
+ * @group Registering routes
+ */
 export declare type MatchedComponent = {
     /**
      * The name of the component.
@@ -74,7 +85,8 @@ export declare type MatchedComponent = {
  * Interface for components that are routed to and are registered with the
  * {@link RouteRegistry} service.
  *
- * @experimental
+ * @beta
+ * @group Registering routes
  */
 export interface RouteComponent extends LimeWebComponent {
     /**
@@ -90,3 +102,4 @@ export interface RouteComponent extends LimeWebComponent {
      */
     state?: unknown;
 }
+//# sourceMappingURL=registry.d.ts.map

package/dist/routeregistry/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/routeregistry/registry.ts"],"names":[],"mappings":"AAGA,OAAO,EAA2B,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;;;;OAOG;IACH,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5D;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;CAC7D;AAED;;;GAGG;AACH,oBAAY,gBAAgB,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACpD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/dist/routeregistry/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/routeregistry/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,IAAI,OAAO,EAAE,MAAM,YAAY,CAAC;AAGtD,QAAA,MAAM,YAAY,kBAAkB,CAAC;AAIrC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;;;;WAKG;QACH,aAAa,EAAE,OAAO,YAAY,CAAC;KACtC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC;KAChE;CACJ"}

package/dist/task/index.d.ts

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

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

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

package/dist/task/repository.d.ts

@@ -1,26 +1,32 @@
 import { StateRepository } from '../core';
 /**
  * Service for creating background tasks
+ * @public
+ * @group Tasks
  */
 export interface TaskRepository extends StateRepository {
     /**
      * Create a new background task
      *
-     * @param url url to the resource that will create the task
-     * @param data task specific data
-     * @param cancelAction true to allow task creation to be cancelled
-     * @param message notification message to display before the task is created instead of the default one
+     * @param url - url to the resource that will create the task
+     * @param data - task specific data
+     * @param cancelAction - true to allow task creation to be cancelled
+     * @param message - notification message to display before the task is created instead of the default one
      * @returns a promise that resolves to the id of the task if it was created successfully
      */
     create(url: string, data: any, cancelAction?: boolean, message?: string): Promise<string | void>;
     /**
      * Get status about specific tasks
      *
-     * @param ids the ids of the tasks to check
+     * @param ids - the ids of the tasks to check
      * @returns a promise that resolves to the status about the tasks
      */
     getStatus(ids: string[]): Promise<TaskStatus[]>;
 }
+/**
+ * @public
+ * @group Tasks
+ */
 export declare enum TaskState {
     /**
      * Task state is unknown
@@ -43,6 +49,10 @@ export declare enum TaskState {
      */
     Failure = "FAILURE"
 }
+/**
+ * @public
+ * @group Tasks
+ */
 export interface TaskStatus {
     /**
      * ID of the task
@@ -59,24 +69,40 @@ export interface TaskStatus {
 }
 /**
  * Events dispatched by the task service
+ * @public
+ * @group Tasks
  */
 export declare enum TaskEventType {
     /**
      * Dispatched when a task has been created.
      *
-     * @detail { task }
+     * @see {@link TaskEvent}
      */
     Created = "task.created",
     /**
      * Dispatched when the task has successfully been completed
      *
-     * @detail { task }
+     * @see {@link TaskEvent}
      */
     Success = "task.success",
     /**
      * Dispatched if an error occured while running the task
      *
-     * @detail { task | error? }
+     * @see {@link TaskEvent}
      */
     Failed = "task.failed"
 }
+/**
+ * @public
+ * @group Tasks
+ */
+export declare type TaskEventDetail = {
+    task: TaskStatus;
+    error?: unknown;
+};
+/**
+ * @public
+ * @group Tasks
+ */
+export declare type TaskEvent = CustomEvent<TaskEventDetail>;
+//# sourceMappingURL=repository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/task/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACnD;;;;;;;;OAQG;IACH,MAAM,CACF,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,GAAG,EACT,YAAY,CAAC,EAAE,OAAO,EACtB,OAAO,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,SAAS;IACjB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,KAAK,UAAU;IAEf;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,OAAO,YAAY;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,oBAAY,aAAa;IACrB;;;;OAIG;IACH,OAAO,iBAAiB;IAExB;;;;OAIG;IACH,OAAO,iBAAiB;IAExB;;;;OAIG;IACH,MAAM,gBAAgB;CACzB;AAED;;;GAGG;AACH,oBAAY,eAAe,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,oBAAY,SAAS,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC"}

package/dist/task/repository.js

@@ -1,4 +1,7 @@
-// eslint-disable-next-line no-shadow
+/**
+ * @public
+ * @group Tasks
+ */
 export var TaskState;
 (function (TaskState) {
     /**
@@ -24,26 +27,27 @@ export var TaskState;
 })(TaskState || (TaskState = {}));
 /**
  * Events dispatched by the task service
+ * @public
+ * @group Tasks
  */
-// eslint-disable-next-line no-shadow
 export var TaskEventType;
 (function (TaskEventType) {
     /**
      * Dispatched when a task has been created.
      *
-     * @detail { task }
+     * @see {@link TaskEvent}
      */
     TaskEventType["Created"] = "task.created";
     /**
      * Dispatched when the task has successfully been completed
      *
-     * @detail { task }
+     * @see {@link TaskEvent}
      */
     TaskEventType["Success"] = "task.success";
     /**
      * Dispatched if an error occured while running the task
      *
-     * @detail { task | error? }
+     * @see {@link TaskEvent}
      */
     TaskEventType["Failed"] = "task.failed";
 })(TaskEventType || (TaskEventType = {}));

package/dist/task/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/task/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,OAAO,EAAE,MAAM,cAAc,CAAC;AAGzD,QAAA,MAAM,YAAY,gBAAgB,CAAC;AAInC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,cAAc,EAAE,OAAO,YAAY,CAAC;KACvC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC;KACjE;CACJ"}

package/dist/testing/component-testing.d.ts

@@ -1,10 +1,19 @@
 import { SpecPage } from '@stencil/core/testing';
+/**
+ * @public
+ */
 export interface ComponentProps {
     [name: string]: any;
 }
+/**
+ * @public
+ */
 export interface ComponentListeners {
     [name: string]: (event: CustomEvent<any>) => void;
 }
+/**
+ * @public
+ */
 export interface ComponentConfig {
     /**
      * Tag name of the component
@@ -30,24 +39,28 @@ export interface ComponentConfig {
 /**
  * Create a new component
  *
- * @param {*} component the component class
- * @param {SpecPage} page the page to create the component on
- * @param {ComponentConfig} config component configuration
- * @returns {HTMLElement} the component
+ * @param component - the component class
+ * @param page - the page to create the component on
+ * @param config - component configuration
+ * @returns the component
+ * @public
  */
 export declare function createComponent(component: any, page: SpecPage, config: ComponentConfig): HTMLElement;
 /**
  * Destroy a component that was created by the `createComponent` function
  *
- * @param {HTMLElement} component the component to destroy
- * @returns {void}
+ * @param component - the component to destroy
+ * @returns
+ * @public
  */
 export declare function destroyComponent(component: HTMLElement): void;
 /**
  * Set a state variable on the component
  *
- * @param {HTMLElement} component the component
- * @param {object} state the state variables to set along with their values
- * @returns {void}
+ * @param component - the component
+ * @param state - the state variables to set along with their values
+ * @returns
+ * @public
  */
 export declare function setState(component: HTMLElement, state: object): void;
+//# sourceMappingURL=component-testing.d.ts.map

package/dist/testing/component-testing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-testing.d.ts","sourceRoot":"","sources":["../../src/testing/component-testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAIjD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC5B;AAgBD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC3B,SAAS,EAAE,GAAG,EACd,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,eAAe,GACxB,WAAW,CA4Bb;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAW7D;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,QAG7D"}