@limetech/lime-web-components 5.0.0 → 5.1.0

package/README.md

@@ -8,9 +8,16 @@ To build the dist folder, run `npm run build`.
 
 Read the full documentation at [https://lundalogik.github.io/lime-web-components/](https://lundalogik.github.io/lime-web-components/)
 
+## API changes
+
+If you do any changes to the public API, you need to run `npm run api:update` in
+order to update the file `etc/lime-web-components.api.md` which describes the 
+public API. The file is generated so do not update it manually. If the file is 
+not updated, the GitHub build will fail when the API is verified.
+
 ## Deploy documentation
 
-Documentation is deployed to GitHub Pages when a new release is built by Jenkins. It can also be deployed manually from a Linux or macOS computer. *NB! Running the publish script locally will update your git config for the repository with the values of the GIT_AUTHOR_EMAIL and GIT_AUTHOR_NAME environment variables. If you set these to anything other than your own user, you may wish to update your config again after publishing. The script will also make changes to a few files, and will checkout these again at the end. Any uncommitted changes you've made to these files **will be lost**. The script also removes the local copy of the branch gh-pages.*
+Documentation is deployed to GitHub Pages when a new release is built by GitHub Actions. It can also be deployed manually from a Linux or macOS computer. *NB! Running the publish script locally will update your git config for the repository with the values of the GIT_AUTHOR_EMAIL and GIT_AUTHOR_NAME environment variables. If you set these to anything other than your own user, you may wish to update your config again after publishing. The script will also make changes to a few files, and will checkout these again at the end. Any uncommitted changes you've made to these files **will be lost**. The script also removes the local copy of the branch gh-pages.*
 
 Follow these steps:
 
@@ -21,7 +28,7 @@ Follow these steps:
   - GH_USERNAME - the GitHub user to which the above access-token belongs
 2. Run `git fetch`.
 3. Run `git branch` and make sure you do *not* have a local copy of the branch `gh-pages`. If you do, push anything that should be pushed, and remove the local branch.
-4. From the repo-root, run `npm run docz:publish -- --v=<version>`, where `<version>` is the version of lime-elements you are building the documentation for. **Any existing documentation for this version number will be overwritten.** If no version is supplied, the version will be set to `0.0.0-dev`. If `--dryRun=true` is supplied, the entire script will run, except the push to GitHub.
+4. From the repo-root, run `npm run docs:publish -- --v=<version>`, where `<version>` is the version of lime-elements you are building the documentation for. **Any existing documentation for this version number will be overwritten.** If no version is supplied, the version will be set to `0.0.0-dev`. If `--dryRun=true` is supplied, the entire script will run, except the push to GitHub.
 
 ## Get help
 

package/dist/application/decorators/application.d.ts

@@ -2,7 +2,10 @@ import { StateOptions } from '../../core';
 /**
  * Get the name of the application
  *
- * @param {StateOptions} [options] options for the state selector
- * @returns {Function} state decorator
+ * @param options - options for the state selector
+ * @returns state decorator
+ * @public
+ * @group Application
  */
 export declare function SelectApplicationName(options?: StateOptions): PropertyDecorator;
+//# sourceMappingURL=application.d.ts.map

package/dist/application/decorators/application.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../src/application/decorators/application.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,YAAY,CAAC;AAGpB;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACjC,OAAO,GAAE,YAAiB,GAC3B,iBAAiB,CAOnB"}

package/dist/application/decorators/application.js

@@ -3,8 +3,10 @@ import { createStateDecorator } from '../../core/decorators/factory';
 /**
  * Get the name of the application
  *
- * @param {StateOptions} [options] options for the state selector
- * @returns {Function} state decorator
+ * @param options - options for the state selector
+ * @returns state decorator
+ * @public
+ * @group Application
  */
 export function SelectApplicationName(options = {}) {
     const config = {

package/dist/application/decorators/index.d.ts

@@ -1,3 +1,4 @@
 export * from './application';
 export * from './user';
 export * from './session';
+//# sourceMappingURL=index.d.ts.map

package/dist/application/decorators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/application/decorators/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC"}

package/dist/application/decorators/session.d.ts

@@ -2,7 +2,10 @@ import { StateOptions } from '../../core';
 /**
  * Get the application session
  *
- * @param {StateOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Application
  */
 export declare function SelectSession(options?: StateOptions): PropertyDecorator;
+//# sourceMappingURL=session.d.ts.map

package/dist/application/decorators/session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../../src/application/decorators/session.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,YAAY,CAAC;AAGpB;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,YAAiB,GAAG,iBAAiB,CAO3E"}

package/dist/application/decorators/session.js

@@ -3,8 +3,10 @@ import { createStateDecorator } from '../../core/decorators/factory';
 /**
  * Get the application session
  *
- * @param {StateOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Application
  */
 export function SelectSession(options = {}) {
     const config = {

package/dist/application/decorators/user.d.ts

@@ -2,7 +2,10 @@ import { StateOptions } from '../../core';
 /**
  * Get the currently logged in user
  *
- * @param {StateOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Application
  */
 export declare function SelectCurrentUser(options?: StateOptions): PropertyDecorator;
+//# sourceMappingURL=user.d.ts.map

package/dist/application/decorators/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/application/decorators/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,YAAY,CAAC;AAGpB;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC7B,OAAO,GAAE,YAAiB,GAC3B,iBAAiB,CAOnB"}

package/dist/application/decorators/user.js

@@ -3,8 +3,10 @@ import { createStateDecorator } from '../../core/decorators/factory';
 /**
  * Get the currently logged in user
  *
- * @param {StateOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Application
  */
 export function SelectCurrentUser(options = {}) {
     const config = {

package/dist/application/index.d.ts

@@ -2,3 +2,4 @@ export * from './types';
 export * from './decorators';
 export * from './session';
 export * from './user';
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/application/session.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @public
+ * @group Application
+ */
 export interface Session {
     /**
      * Whether the session is active or not
@@ -65,3 +69,4 @@ export interface Session {
      */
     workstation: string;
 }
+//# sourceMappingURL=session.d.ts.map

package/dist/application/session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/application/session.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB"}

package/dist/application/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/application/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG1C,QAAA,MAAM,YAAY,sBAAsB,CAAC;AAIzC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,WAAW,EAAE,OAAO,YAAY,CAAC;KACpC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,aAAa,CAAC,GAAG,eAAe,CAAC;KACtE;CACJ"}

package/dist/application/user.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @public
+ * @group Application
+ */
 export interface User {
     /**
      * The name of the user
@@ -32,6 +36,10 @@ export interface User {
      */
     coworker: UserCoworker;
 }
+/**
+ * @public
+ * @group Application
+ */
 export interface UserGroup {
     /**
      * Name of the group
@@ -46,7 +54,11 @@ export interface UserGroup {
      */
     description: string;
 }
-interface UserCoworker {
+/**
+ * @public
+ * @group Application
+ */
+export interface UserCoworker {
     /**
      * Id of the coworker `LimeObject`
      */
@@ -56,4 +68,4 @@ interface UserCoworker {
      */
     limetype: string;
 }
-export {};
+//# sourceMappingURL=user.d.ts.map

package/dist/application/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/application/user.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,IAAI;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,EAAE,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB"}

package/dist/commandbus/commandbus.d.ts

@@ -1,100 +1,138 @@
+/**
+ * @public
+ * @group Command bus
+ */
 export declare type CommandClass = new (...args: any[]) => any;
+/**
+ * @public
+ * @group Command bus
+ */
 export declare type CommandIdentifier = CommandClass | string;
 /**
  * Service for registering and executing commands
+ * @public
+ * @group Command bus
  */
 export interface CommandBus extends CommandHandler {
     /**
      * Register a command to be executed by the given handler
      *
-     * @param {CommandClass} commandClass type of command
-     * @param {CommandHandler} handler the handler instance used to execute the command
+     * @param commandClass - type of command
+     * @param handler - the handler instance used to execute the command
      */
     register(commandClass: CommandClass, handler: CommandHandler): void;
     /**
      * Execute the given command with it's registered command handler
      *
-     * @param {Object} command command to execute
+     * @param command - command to execute
      *
-     * @returns {any} result from the command handler
+     * @returns result from the command handler
      */
     handle(command: object): any;
     /**
      * Check if a command is supported
      *
-     * @param {CommandIdentifier} commandId identifier of the command. Can be either the class or the string the class was registered with
+     * @param commandId - identifier of the command. Can be either the class or the string the class was registered with
      *
-     * @returns {boolean} true if the command is supported, false otherwise
+     * @returns true if the command is supported, false otherwise
      */
     isSupported(commandId: CommandIdentifier): boolean;
     /**
      * Get a handler associated with a command
      *
-     * @param {CommandClass} commandClass The command class
+     * @param commandClass - The command class
      *
-     * @returns {CommandHandler} the handler for the command class
+     * @returns the handler for the command class
      */
     getHandler(commandClass: CommandClass): CommandHandler;
     /**
      * Create a command instance from a {@link CommandConfig}
      *
-     * @param {CommandConfig} config The command configuration
-     * @throws {Error} Thrown if the command has not been registered yet
+     * @param config - The command configuration
+     * @throws Thrown if the command has not been registered yet
      */
     createCommand<T = any>(config: CommandConfig<T>): T;
 }
 /**
  * Service for executing commands
+ * @public
+ * @group Command bus
  */
 export interface CommandHandler {
     /**
      * Handle the execution of the given command
      *
-     * @param {Object} command the command to handle
+     * @param command - the command to handle
      *
-     * @returns {any} the result of the operation
+     * @returns the result of the operation
      */
     handle(command: object): any;
 }
+/**
+ * @public
+ * @group Command bus
+ */
 export declare type CallableCommandMiddleware = (command: object) => any;
 /**
  * Middleware for the command bus
+ * @public
+ * @group Command bus
  */
 export interface CommandMiddleware {
     /**
      * Execute the middleware before passing the command further down the chain
      *
-     * @param {Object} command the command that is being handled
-     * @param {CallableCommandMiddleware} next the next middleware in the chain
+     * @param command - the command that is being handled
+     * @param next - the next middleware in the chain
      *
-     * @returns {any} the result of the operation
+     * @returns the result of the operation
      */
     execute(command: object, next: CallableCommandMiddleware): any;
 }
 /**
  * Events dispatched by the commandbus event middleware
+ * @public
+ * @group Command bus
  */
 export declare enum CommandEventName {
     /**
      * Dispatched when the command has been received by the commandbus.
      * Calling `preventDefault()` on the event will stop the command from being handled
      *
-     * @detail { command }
+     * @see {@link CommandEvent}
      */
     Received = "command.received",
     /**
      * Dispatched when the command has been handled by the commandbus
      *
-     * @detail { command | result }
+     * @see {@link CommandEvent}
      */
     Handled = "command.handled",
     /**
      * Dispatched if an error occurs while handling the command
      *
-     * @detail { command | error }
+     * @see {@link CommandEvent}
      */
     Failed = "command.failed"
 }
+/**
+ * @public
+ * @group Command bus
+ */
+export declare type CommandEventDetail = {
+    command: object;
+    result?: unknown;
+    error?: unknown;
+};
+/**
+ * @public
+ * @group Command bus
+ */
+export declare type CommandEvent = CustomEvent<CommandEventDetail>;
+/**
+ * @public
+ * @group Command bus
+ */
 export interface CommandOptions {
     /**
      * Id of the command
@@ -103,6 +141,7 @@ export interface CommandOptions {
 }
 /**
  * Config for describing a command
+ * @public
  */
 export interface CommandConfig<T = any> {
     /**
@@ -120,16 +159,21 @@ export interface CommandConfig<T = any> {
 /**
  * Register a class as a command
  *
- * @param {CommandOptions} options a CommandOptions object containing the id of the command
+ * @param options - a CommandOptions object containing the id of the command
  *
- * @returns {Function} callback which accepts a `CommandClass` and sets the command id
+ * @returns callback which accepts a `CommandClass` and sets the command id
+ * @public
+ * @group Command bus
  */
 export declare function Command(options: CommandOptions): (commandClass: CommandClass) => void;
 /**
  * Get the registered id of the command
  *
- * @param {Object | CommandIdentifier} value either a command or a command identifier
+ * @param value - either a command or a command identifier
  *
- * @returns {string} id of the command
+ * @returns id of the command
+ * @public
+ * @group Command bus
  */
 export declare function getCommandId(value: object | CommandIdentifier): string;
+//# sourceMappingURL=commandbus.d.ts.map

package/dist/commandbus/commandbus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandbus.d.ts","sourceRoot":"","sources":["../../src/commandbus/commandbus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,YAAY,GAAG,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAEvD;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,YAAY,GAAG,MAAM,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,cAAc;IAC9C;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpE;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAEnD;;;;;;OAMG;IACH,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,cAAc,CAAC;IAEvD;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CACvD;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;CAChC;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,GAAG,CAAC;AAEjE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,GAAG,GAAG,CAAC;CAClE;AAED;;;;GAIG;AACH,oBAAY,gBAAgB;IACxB;;;;;OAKG;IACH,QAAQ,qBAAqB;IAE7B;;;;OAIG;IACH,OAAO,oBAAoB;IAE3B;;;;OAIG;IACH,MAAM,mBAAmB;CAC5B;AAED;;;GAGG;AACH,oBAAY,kBAAkB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,oBAAY,YAAY,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IAClC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,cAAc,kBACrB,YAAY,UAGrC;AAOD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,MAAM,CAgBtE"}

package/dist/commandbus/commandbus.js

@@ -1,35 +1,38 @@
 /**
  * Events dispatched by the commandbus event middleware
+ * @public
+ * @group Command bus
  */
-// eslint-disable-next-line no-shadow
 export var CommandEventName;
 (function (CommandEventName) {
     /**
      * Dispatched when the command has been received by the commandbus.
      * Calling `preventDefault()` on the event will stop the command from being handled
      *
-     * @detail { command }
+     * @see {@link CommandEvent}
      */
     CommandEventName["Received"] = "command.received";
     /**
      * Dispatched when the command has been handled by the commandbus
      *
-     * @detail { command | result }
+     * @see {@link CommandEvent}
      */
     CommandEventName["Handled"] = "command.handled";
     /**
      * Dispatched if an error occurs while handling the command
      *
-     * @detail { command | error }
+     * @see {@link CommandEvent}
      */
     CommandEventName["Failed"] = "command.failed";
 })(CommandEventName || (CommandEventName = {}));
 /**
  * Register a class as a command
  *
- * @param {CommandOptions} options a CommandOptions object containing the id of the command
+ * @param options - a CommandOptions object containing the id of the command
  *
- * @returns {Function} callback which accepts a `CommandClass` and sets the command id
+ * @returns callback which accepts a `CommandClass` and sets the command id
+ * @public
+ * @group Command bus
  */
 export function Command(options) {
     return (commandClass) => {
@@ -43,9 +46,11 @@ function setCommandId(commandClass, id) {
 /**
  * Get the registered id of the command
  *
- * @param {Object | CommandIdentifier} value either a command or a command identifier
+ * @param value - either a command or a command identifier
  *
- * @returns {string} id of the command
+ * @returns id of the command
+ * @public
+ * @group Command bus
  */
 export function getCommandId(value) {
     if (typeof value === 'string') {

package/dist/commandbus/index.d.ts

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

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

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

package/dist/commandbus/types.d.ts

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

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

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

package/dist/config/decorator.d.ts

@@ -1,6 +1,8 @@
 import { StateOptions } from '../core';
 /**
  * Config for the {@link SelectConfig} state decorator
+ * @public
+ * @group Config
  */
 export interface SelectConfigOptions extends StateOptions {
     name?: string;
@@ -8,7 +10,10 @@ export interface SelectConfigOptions extends StateOptions {
 /**
  * Gets an object with all configs where key is used as key.
  *
- * @param {SelectConfigOptions} options state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Config
  */
 export declare function SelectConfig(options: SelectConfigOptions): PropertyDecorator;
+//# sourceMappingURL=decorator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/config/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,iBAAiB,CAM5E"}

package/dist/config/decorator.js

@@ -3,8 +3,10 @@ import { createStateDecorator } from '../core/decorators/factory';
 /**
  * Gets an object with all configs where key is used as key.
  *
- * @param {SelectConfigOptions} options state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Config
  */
 export function SelectConfig(options) {
     const config = {

package/dist/config/index.d.ts

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

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

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

package/dist/config/repository.d.ts

@@ -1,17 +1,22 @@
 import { StateRepository } from '../core/state';
+/**
+ * @public
+ * @group Config
+ */
 export interface ConfigRepository extends StateRepository {
     /**
      * Check if a config exists
      *
-     * @param key name of the key containing the config
+     * @param key - name of the key containing the config
      * @returns true if config exists
      */
     has(key: string): boolean;
     /**
      * Get config from the state
      *
-     * @param key name of the key containing the config
+     * @param key - name of the key containing the config
      * @returns the config
      */
     get<T = any>(key: string): T;
 }
+//# sourceMappingURL=repository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/config/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;CAChC"}

package/dist/config/types.d.ts

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

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

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

package/dist/core/context.d.ts

@@ -1,5 +1,7 @@
 /**
  * Interface for the context in which the Lime Web Component appears
+ * @public
+ * @group Core
  */
 export interface LimeWebComponentContext {
     /**
@@ -15,3 +17,4 @@ export interface LimeWebComponentContext {
      */
     parent?: LimeWebComponentContext;
 }
+//# sourceMappingURL=context.d.ts.map

package/dist/core/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/core/context.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,CAAC;CACpC"}

package/dist/core/decorators/factory.d.ts

@@ -1,5 +1,9 @@
 import { LimeWebComponent, StateOptions } from '..';
 declare type OptionFactory = (options: StateOptions, component: LimeWebComponent) => StateOptions;
+/**
+ * @group Core
+ * @internal
+ */
 export interface StateDecoratorConfig {
     /**
      * Name of the state service to use in the platform
@@ -12,18 +16,20 @@ export interface StateDecoratorConfig {
     /**
      * Factory for creating options dynamically
      *
-     * @param {StateOptions} options decorator options
-     * @param {LimeWebComponent} component the web component
-     * @returns {StateOptions} state options
+     * @param options - decorator options
+     * @param component - the web component
+     * @returns state options
      */
     optionFactory?: OptionFactory;
 }
 /**
  * Create a new state decorator
  *
- * @param {StateOptions} options decorator options
- * @param {StateDecoratorConfig} config decorator configuration
- * @returns {Function} state decorator
+ * @param options - decorator options
+ * @param config - decorator configuration
+ * @returns state decorator
+ * @public
  */
 export declare function createStateDecorator(options: StateOptions, config: StateDecoratorConfig): PropertyDecorator;
 export {};
+//# sourceMappingURL=factory.d.ts.map