@limetech/lime-web-components 5.0.1 → 5.1.0

package/dist/filter/repository.d.ts

@@ -1,18 +1,23 @@
 import { Filter } from '../query';
 import { StateRepository } from '../core';
+/**
+ * @public
+ * @group Filters
+ */
 export interface FilterRepository extends StateRepository {
     /**
      * Saves the new filter to the database
      *
-     * @param filter a filter to save
-     * @returns {Promise<void>} a promise that will be resolved when the filter is saved
+     * @param filter - a filter to save
+     * @returns a promise that will be resolved when the filter is saved
      */
     save(filter: Filter): Promise<void>;
     /**
      * Deletes the filter
      *
-     * @param id a filter id to delete
-     * @returns {Promise<void>} a promise that will be resolved when the filter is deleted
+     * @param id - a filter id to delete
+     * @returns a promise that will be resolved when the filter is deleted
      */
     delete(filter: Filter): Promise<void>;
 }
+//# sourceMappingURL=repository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/filter/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC"}

package/dist/filter/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/filter/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/http/http.d.ts

@@ -3,52 +3,58 @@
  *
  * By default, the service will work with the JSON data format. If anything but JSON is returned from the endpoint,
  * the `responseType` property in the `options` parameter needs to be set.
+ * @public
+ * @group HTTP
  */
 export interface HttpClient {
     /**
      * Sends a get request.
      *
-     * @param {string} url - Url to resource (for instance my_addon/endpoint).
-     * @param {object} options - The HTTP options to send with the request.
-     * @returns {Promise}
+     * @param url - Url to resource (for instance my_addon/endpoint).
+     * @param options - The HTTP options to send with the request.
+     * @returns
      */
     get(url: string, options?: HttpOptions): Promise<any>;
     /**
      * Sends a post request.
      *
-     * @param {string} url - Url to resource (for instance my_addon/endpoint).
-     * @param {object} data - Payload to send to the server.
-     * @param {object} options - The HTTP options to send with the request.
-     * @returns {Promise}
+     * @param url - Url to resource (for instance my_addon/endpoint).
+     * @param data - Payload to send to the server.
+     * @param options - The HTTP options to send with the request.
+     * @returns
      */
     post(url: string, data?: {}, options?: HttpOptions): Promise<any>;
     /**
      * Sends a patch request.
      *
-     * @param {string} url - Url to resource (for instance my_addon/endpoint).
-     * @param {object} data - Payload to send to the server.
-     * @param {object} options - The HTTP options to send with the request.
-     * @returns {Promise}
+     * @param url - Url to resource (for instance my_addon/endpoint).
+     * @param data - Payload to send to the server.
+     * @param options - The HTTP options to send with the request.
+     * @returns
      */
     patch(url: string, data?: {}, options?: HttpOptions): Promise<any>;
     /**
      * Sends a put request.
      *
-     * @param {string} url - Url to resource (for instance my_addon/endpoint).
-     * @param {object} data - Payload to send to the server.
-     * @param {object} options - The HTTP options to send with the request.
-     * @returns {Promise}
+     * @param url - Url to resource (for instance my_addon/endpoint).
+     * @param data - Payload to send to the server.
+     * @param options - The HTTP options to send with the request.
+     * @returns
      */
     put(url: string, data?: {}, options?: HttpOptions): Promise<any>;
     /**
      * Sends a delete request.
      *
-     * @param {string} url - Url to resource (for instance my_addon/endpoint).
-     * @param {object} options - The HTTP options to send with the request.
-     * @returns {Promise}
+     * @param url - Url to resource (for instance my_addon/endpoint).
+     * @param options - The HTTP options to send with the request.
+     * @returns
      */
     delete(url: string, options?: HttpOptions): Promise<any>;
 }
+/**
+ * @public
+ * @group HTTP
+ */
 export interface HttpOptions {
     /**
      * Query parameters to include in the request
@@ -63,16 +69,29 @@ export interface HttpOptions {
      */
     responseType?: HttpResponseType;
 }
+/**
+ * @public
+ * @group HTTP
+ */
 export interface HttpParams {
     [param: string]: string | string[];
 }
+/**
+ * @public
+ * @group HTTP
+ */
 export interface HttpHeaders {
     [header: string]: string | string[];
 }
+/**
+ * @public
+ * @group HTTP
+ */
 export declare type HttpResponseType = 'text' | 'json' | 'arraybuffer' | 'blob';
 /**
  * Exceptiopn thrown by {@link HttpClient} when an error occurs while sending a
  * request
+ * @public
  */
 export interface HttpResponseError extends Error {
     name: 'HttpResponseError';
@@ -85,3 +104,4 @@ export interface HttpResponseError extends Error {
      */
     response: Response;
 }
+//# sourceMappingURL=http.d.ts.map

package/dist/http/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/http/http.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACvB;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEnE;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEjE;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;AAExE;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,KAAK;IAC5C,IAAI,EAAE,mBAAmB,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACtB"}

package/dist/http/index.d.ts

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

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

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

package/dist/http/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/http/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAGpC,QAAA,MAAM,YAAY,SAAS,CAAC;AAI5B,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,IAAI,EAAE,OAAO,YAAY,CAAC;KAC7B;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;KAC1D;CACJ"}

package/dist/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * This is the public API for Lime Web Components. It contains helper functions
+ * and interfaces for all services available in the Lime CRM platform.
+ *
+ * @packageDocumentation
+ */
 export * from './core';
 export * from './limetype';
 export * from './limeobject';
@@ -17,3 +23,4 @@ export * from './device';
 export * from './filter';
 export * from './userdata';
 export * from './application';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -1,3 +1,9 @@
+/**
+ * This is the public API for Lime Web Components. It contains helper functions
+ * and interfaces for all services available in the Lime CRM platform.
+ *
+ * @packageDocumentation
+ */
 export * from './core';
 export * from './limetype';
 export * from './limeobject';

package/dist/keybindings/index.d.ts

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

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

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

package/dist/keybindings/registry.d.ts

@@ -18,6 +18,7 @@
  * `unbind` method.
  *
  * @example
+ * ```
  * // The command bus needs to have a handler registered for the command
  * // before it can be bound to a key sequence
  * const handler = new MyHandler();
@@ -29,43 +30,47 @@
  *
  * // Remove the binding when we no longer need it to trigger the command
  * keybindingRegistry.unbind('ctrl+s')
+ * ```
  * @note This service is work in progress
- * @private
+ * @beta
+ * @group Keyboard shortcuts
  */
 export interface KeybindingRegistry {
     /**
      * Bind a command to a specific key combination to add it to the registry
      *
-     * @param {string} keys the string representation of keys
-     * @param {Object} command the command to trigger when keys are pressed
+     * @param keys - the string representation of keys
+     * @param command - the command to trigger when keys are pressed
      * @throws Will throw an error if the command is invalid or not registered
      */
     bind: (keys: string, command: object) => void;
     /**
      * Unbind a keybinding to remove it from the registry
      *
-     * @param {string} keys the string representation of the key combination
-     * @param {Object} command the command connected to the key combination
+     * @param keys - the string representation of the key combination
+     * @param command - the command connected to the key combination
      */
     unbind: (keys: string, command: object) => void;
     /**
      * Get a list of the key bindings that are currently in the registry
      *
-     * @returns {Keybinding[]} the list of command and its specific key combination
+     * @returns the list of command and its specific key combination
      */
     getKeybindings: () => Keybinding[];
     /**
      * Checks if a key combination or a specific keybinding is already bound
      *
-     * @param {string} keys the string representation of a key combination
-     * @param {Object} command the command connected to the key combination
-     * @returns {boolean} true if key combination already exists, else false
+     * @param keys - the string representation of a key combination
+     * @param command - the command connected to the key combination
+     * @returns true if key combination already exists, else false
      */
     isBound: (keys: string, command?: object) => boolean;
 }
 /**
  * A key combination and its corresponding command that will be triggered when
  * the key combination is pressed
+ * @beta
+ * @group Keyboard shortcuts
  */
 export interface Keybinding {
     /**
@@ -77,3 +82,4 @@ export interface Keybinding {
      */
     command: object;
 }
+//# sourceMappingURL=registry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/keybindings/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;;OAMG;IACH,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAE9C;;;;;OAKG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,cAAc,EAAE,MAAM,UAAU,EAAE,CAAC;IAEnC;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;CACxD;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB"}

package/dist/keybindings/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/keybindings/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,OAAO,EAAE,MAAM,YAAY,CAAC;AAG3D,QAAA,MAAM,YAAY,uBAAuB,CAAC;AAI1C,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;;;;WAKG;QACH,kBAAkB,EAAE,OAAO,YAAY,CAAC;KAC3C;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC;KACrE;CACJ"}

package/dist/limeobject/commands/bulk-create-dialog.d.ts

@@ -31,6 +31,8 @@ import { LimeType } from '../../limetype';
  * ```
  *
  * @id `limeobject.bulk-create-dialog`
+ * @public
+ * @group Lime objects
  */
 export declare class BulkCreateDialogCommand {
     /**
@@ -47,3 +49,4 @@ export declare class BulkCreateDialogCommand {
      */
     relations: string[];
 }
+//# sourceMappingURL=bulk-create-dialog.d.ts.map

package/dist/limeobject/commands/bulk-create-dialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-create-dialog.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/bulk-create-dialog.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAGa,uBAAuB;IAChC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAC;IAE1B;;;OAGG;IACI,MAAM,EAAE,UAAU,CAAC;IAE1B;;OAEG;IACI,SAAS,EAAE,MAAM,EAAE,CAAM;CACnC"}

package/dist/limeobject/commands/bulk-create-dialog.js

@@ -31,6 +31,8 @@ import { Command } from '../../commandbus';
  * ```
  *
  * @id `limeobject.bulk-create-dialog`
+ * @public
+ * @group Lime objects
  */
 let BulkCreateDialogCommand = class BulkCreateDialogCommand {
     constructor() {

package/dist/limeobject/commands/create-dialog.d.ts

@@ -9,6 +9,8 @@ import { LimeType } from '../../limetype';
  * This dialog also useful to edit a limeobject that already exists
  *
  * @id `limeobject.create-dialog`
+ * @public
+ * @group Lime objects
  */
 export declare class CreateLimeobjectDialogCommand {
     /**
@@ -26,3 +28,4 @@ export declare class CreateLimeobjectDialogCommand {
     title?: string;
     context?: LimeWebComponentContext;
 }
+//# sourceMappingURL=create-dialog.d.ts.map

package/dist/limeobject/commands/create-dialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-dialog.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/create-dialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;;;;;;GAWG;AACH,qBAGa,6BAA6B;IACtC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAC;IAE1B;;OAEG;IACI,UAAU,CAAC,EAAE,GAAG,CAAC;IAExB;;OAEG;IACI,KAAK,CAAC,EAAE,OAAO,CAAS;IAKxB,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAC5C"}

package/dist/limeobject/commands/create-dialog.js

@@ -9,6 +9,8 @@ import { Command } from '../../commandbus';
  * This dialog also useful to edit a limeobject that already exists
  *
  * @id `limeobject.create-dialog`
+ * @public
+ * @group Lime objects
  */
 let CreateLimeobjectDialogCommand = class CreateLimeobjectDialogCommand {
     constructor() {

package/dist/limeobject/commands/delete-object.d.ts

@@ -3,8 +3,11 @@ import { LimeType } from '../../limetype';
  * Deletes the object from the database
  *
  * @id `limeobject.delete-object`
+ * @public
+ * @group Lime objects
  */
 export declare class DeleteObjectCommand {
     id: number;
     limetype: LimeType;
 }
+//# sourceMappingURL=delete-object.d.ts.map

package/dist/limeobject/commands/delete-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-object.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/delete-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;GAMG;AACH,qBAGa,mBAAmB;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,QAAQ,CAAC;CACtB"}

package/dist/limeobject/commands/delete-object.js

@@ -4,6 +4,8 @@ import { Command } from '../../commandbus';
  * Deletes the object from the database
  *
  * @id `limeobject.delete-object`
+ * @public
+ * @group Lime objects
  */
 let DeleteObjectCommand = class DeleteObjectCommand {
 };

package/dist/limeobject/commands/index.d.ts

@@ -3,3 +3,4 @@ export * from './create-dialog';
 export * from './delete-object';
 export * from './object-access';
 export * from './save-object';
+//# sourceMappingURL=index.d.ts.map

package/dist/limeobject/commands/index.d.ts.map

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

package/dist/limeobject/commands/object-access.d.ts

@@ -3,8 +3,11 @@ import { LimeType } from '../../limetype';
  * Open a dialog to view and edit object access information
  *
  * @id `limeobject.object-access`
+ * @public
+ * @group Lime objects
  */
 export declare class OpenObjectAccessDialogCommand {
     id: number;
     limetype: LimeType;
 }
+//# sourceMappingURL=object-access.d.ts.map

package/dist/limeobject/commands/object-access.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-access.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/object-access.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;GAMG;AACH,qBAGa,6BAA6B;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,QAAQ,CAAC;CACtB"}

package/dist/limeobject/commands/object-access.js

@@ -4,6 +4,8 @@ import { Command } from '../../commandbus';
  * Open a dialog to view and edit object access information
  *
  * @id `limeobject.object-access`
+ * @public
+ * @group Lime objects
  */
 let OpenObjectAccessDialogCommand = class OpenObjectAccessDialogCommand {
 };

package/dist/limeobject/commands/save-object.d.ts

@@ -3,6 +3,8 @@ import { LimeObject } from '../../limeobject';
  * Saves the object to the database
  *
  * @id `limeobject.save-object`
+ * @public
+ * @group Lime objects
  */
 export declare class SaveLimeObjectCommand {
     /**
@@ -14,3 +16,4 @@ export declare class SaveLimeObjectCommand {
      */
     route?: boolean;
 }
+//# sourceMappingURL=save-object.d.ts.map

package/dist/limeobject/commands/save-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"save-object.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/save-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C;;;;;;GAMG;AACH,qBAGa,qBAAqB;IAC9B;;OAEG;IACI,UAAU,EAAE,UAAU,CAAC;IAE9B;;OAEG;IACI,KAAK,CAAC,EAAE,OAAO,CAAS;CAClC"}

package/dist/limeobject/commands/save-object.js

@@ -4,6 +4,8 @@ import { Command } from '../../commandbus';
  * Saves the object to the database
  *
  * @id `limeobject.save-object`
+ * @public
+ * @group Lime objects
  */
 let SaveLimeObjectCommand = class SaveLimeObjectCommand {
     constructor() {

package/dist/limeobject/decorator.d.ts

@@ -1,6 +1,8 @@
 import { StateOptions, LimeWebComponent, ContextAwareStateOptions } from '../core';
 /**
  * Config for the {@link SelectLimeObjects} state decorator
+ * @public
+ * @group Lime objects
  */
 export interface SelectLimeObjectsOptions extends StateOptions {
     /**
@@ -19,14 +21,19 @@ export interface SelectLimeObjectsOptions extends StateOptions {
 /**
  * Get a list of limeobjects
  *
- * @param {SelectLimeObjectsOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Lime objects
  */
 export declare function SelectLimeObjects(options?: SelectLimeObjectsOptions): PropertyDecorator;
 /**
  * Get the limeobject 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 objects
  */
 export declare function SelectCurrentLimeObject(options?: ContextAwareStateOptions): PropertyDecorator;
+//# sourceMappingURL=decorator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/limeobject/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEZ,gBAAgB,EAChB,wBAAwB,EAC3B,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC1D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,gBAAgB,KAAK,MAAM,CAAC;IAEtD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC7B,OAAO,GAAE,wBAA6B,GACvC,iBAAiB,CAOnB;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CACnC,OAAO,GAAE,wBAA6B,GACvC,iBAAiB,CAQnB"}

package/dist/limeobject/decorator.js

@@ -3,8 +3,10 @@ import { createStateDecorator } from '../core/decorators/factory';
 /**
  * Get a list of limeobjects
  *
- * @param {SelectLimeObjectsOptions} [options] state decorator options
- * @returns {Function} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group Lime objects
  */
 export function SelectLimeObjects(options = {}) {
     const config = {
@@ -16,8 +18,10 @@ export function SelectLimeObjects(options = {}) {
 /**
  * Get the limeobject 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 objects
  */
 export function SelectCurrentLimeObject(options = {}) {
     const config = {

package/dist/limeobject/error.d.ts

@@ -1,4 +1,39 @@
 import { LimeObject } from './limeobject';
+/**
+ * @public
+ * @group Lime objects
+ */
 export interface SaveLimeObjectError extends Error {
+    /**
+     * The limeobject that could not be saved
+     */
     limeobject: LimeObject;
+    /**
+     * Validation error messages
+     */
+    errors?: ValidationError;
 }
+/**
+ * Describes a hierarchy of errors after validation has failed. The error
+ * object will have the same structure as the object being validated, e.g. each
+ * key in the error will have a corresponding key in the validated object.
+ *
+ * @example
+ * ```json
+ * {
+ *   "name": ["Length can not be more than 15", "Contains invalid characters"],
+ *   "address": {
+ *     "city": ["City does not exist"],
+ *     "zipcode": ["Invalid zipcode"]
+ *   }
+ * }
+ * ```
+ * @public
+ */
+export interface ValidationError {
+    /**
+     * Name of the field the error belongs to
+     */
+    [key: string]: string[] | ValidationError;
+}
+//# sourceMappingURL=error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/limeobject/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,KAAK;IAC9C;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,eAAe,CAAC;CAC7C"}

package/dist/limeobject/index.d.ts

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

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

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

package/dist/limeobject/limeobject.d.ts

@@ -1,6 +1,8 @@
 import { LimeType } from '../limetype';
 /**
  * A Lime object
+ * @public
+ * @group Lime objects
  */
 export interface LimeObject {
     /**
@@ -22,18 +24,18 @@ export interface LimeObject {
     /**
      * Get the value of a property by name
      *
-     * @param {string} name name of property to get the value of. Allows a path
+     * @param name - name of property to get the value of. Allows a path
      * to be specified using dot notation to get the value of a related
      * property
      *
-     * @returns {any} the value of the specified property. If it is a relation,
+     * @returns the value of the specified property. If it is a relation,
      * the related `LimeObject` will be returned
      */
     getValue(name: string): any;
     /**
      * Get the limetype of the object
      *
-     * @returns {Limetype} the limetype
+     * @returns the limetype
      */
     getLimetype(): LimeType;
     /**
@@ -41,3 +43,4 @@ export interface LimeObject {
      */
     [property: string]: any;
 }
+//# sourceMappingURL=limeobject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"limeobject.d.ts","sourceRoot":"","sources":["../../src/limeobject/limeobject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;OASG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IAE5B;;;;OAIG;IACH,WAAW,IAAI,QAAQ,CAAC;IAExB;;OAEG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CAC3B"}