@api-client/core 0.6.24 → 0.6.25

package/build/src/events/BaseEvents.d.ts

@@ -90,17 +90,40 @@ export interface ContextDeleteEventDetail {
      */
     parent?: string;
 }
+export interface ContextDeleteBulkEventDetail {
+    /**
+     * The list of ids of the domain object to remove.
+     */
+    ids: string[];
+    /**
+     * The id of the parent object, if applicable.
+     */
+    parent?: string;
+}
 /**
  * An event to be used to delete a state in the context provider.
  */
 export declare class ContextDeleteEvent extends ContextEvent<ContextDeleteEventDetail, ContextDeleteRecord> {
     /**
+     * An event to be used to delete a state in the context provider.
      * @param type The type of the event to dispatch.
      * @param id The id of the object to delete
      * @param parent The id of the parent object, if applicable.
      */
     constructor(type: string, id: string, parent?: string);
 }
+/**
+ * An event to be used to delete a number of entities in the context provider.
+ */
+export declare class ContextDeleteBulkEvent extends ContextEvent<ContextDeleteBulkEventDetail, ContextDeleteRecord> {
+    /**
+     * An event to be used to delete a number of entities in the context provider.
+     * @param type The type of the event to dispatch.
+     * @param ids The list of ids of the domain object to remove.
+     * @param parent The id of the parent object, if applicable.
+     */
+    constructor(type: string, ids: string[], parent?: string);
+}
 export interface ContextDeleteRecord {
     /**
      * The data kind of the deleted item.
@@ -116,6 +139,20 @@ export interface ContextDeleteRecord {
      */
     parent?: string;
 }
+/**
+ * An event dispatched to the context store to restore previously deleted items.
+ */
+export declare class ContextRestoreEvent<T> extends ContextEvent<ContextDeleteRecord[], ContextChangeRecord<T>> {
+    /**
+     * An event dispatched to the context store to restore previously deleted items.
+     *
+     * The result of the event is the list of `ContextChangeRecord` for the restored items.
+     *
+     * @param type The type of the event.
+     * @param records The records of previously deleted items.
+     */
+    constructor(type: string, records: ContextDeleteRecord[]);
+}
 /**
  * An event dispatched when a context store object has been deleted.
  * In general a single context store uses the same event to dispatch the change record.
@@ -154,10 +191,37 @@ export interface ContextUpdateEventDetail<T> {
  * This is equivalent to PUT operation in REST HTTP.
  *
  * @template T The object that is being updated.
+ * @template U The object that is returned by the context store after updating. By default it is the `T`.
  */
 export declare class ContextUpdateEvent<T extends object, U = T> extends ContextEvent<ContextUpdateEventDetail<T>, ContextChangeRecord<U>> {
+    /**
+     * An event that is dispatched to update the entire object in the store.
+     * This is equivalent to PUT operation in REST HTTP.
+     *
+     * @param type The type of the event to dispatch
+     * @param updateInfo The update information.
+     */
     constructor(type: string, updateInfo: ContextUpdateEventDetail<T>);
 }
+/**
+ * An event that is dispatched to update a list of objects in the store.
+ * This is equivalent to PUT operation in REST HTTP.
+ *
+ * If there's a parent, this event only allows to update entities in bulk for the same parent.
+ *
+ * @template T The object that is being updated.
+ * @template U The object that is returned by the context store after updating. By default it is the `T`.
+ */
+export declare class ContextUpdateBulkEvent<T extends object, U = T> extends ContextEvent<ContextUpdateEventDetail<T[]>, ContextChangeRecord<U>[]> {
+    /**
+     * An event that is dispatched to update the entire object in the store.
+     * This is equivalent to PUT operation in REST HTTP.
+     *
+     * @param type The type of the event to dispatch
+     * @param updateInfo The update information.
+     */
+    constructor(type: string, updateInfo: ContextUpdateEventDetail<T[]>);
+}
 /**
  * Data store query result object.
  */
@@ -193,3 +257,46 @@ export declare class ContextListEvent<T> extends ContextEvent<ContextListOptions
      */
     constructor(type: string, opts?: ContextListOptions);
 }
+export interface IQueryDetail {
+    /**
+     * The query term. All values are always passed as string. Context store must parse value if it requires other types.
+     */
+    term: string;
+    /**
+     * If the context store supports it, the tags to use with the query function to limit the results.
+     */
+    tags?: string[];
+    /**
+     * General purpose type to be defined by the context store.
+     * Allows to specify the type of the query to perform.
+     */
+    type?: string;
+    /**
+     * General purpose keyword to be defined by the context store.
+     * The purpose is to instruct the context store to perform detailed search.
+     * Usually this means longer search time but more accurate results.
+     */
+    detailed?: boolean;
+}
+/**
+ * An event dispatched to the context store to perform a query operation.
+ * If the context store supports the query operation, it should use the definition of `IQueryDetail` to perform the query.
+ * The result is the list of objects ordered by the store from the most relevant items to the least.
+ *
+ * The implementation should not assume pagination and return enough results for the user to find what they were looking for
+ * or to redefine the query. Suggested limit is `50` which in many cases is equivalent of 2 pages of results.
+ */
+export declare class ContextQueryEvent<T = unknown> extends ContextEvent<IQueryDetail, T[]> {
+    /**
+     * An event dispatched to the context store to perform a query operation.
+     * If the context store supports the query operation, it should use the definition of `IQueryDetail` to perform the query.
+     * The result is the list of objects ordered by the store from the most relevant items to the least.
+     *
+     * The implementation should not assume pagination and return enough results for the user to find what they were looking for
+     * or to redefine the query. Suggested limit is `50` which in many cases is equivalent of 2 pages of results.
+     *
+     * @param type The type of the event.
+     * @param opts The query options.
+     */
+    constructor(type: string, opts: IQueryDetail);
+}

package/build/src/events/BaseEvents.js

@@ -49,6 +49,7 @@ export class ContextReadBulkEvent extends ContextEvent {
  */
 export class ContextDeleteEvent extends ContextEvent {
     /**
+     * An event to be used to delete a state in the context provider.
      * @param type The type of the event to dispatch.
      * @param id The id of the object to delete
      * @param parent The id of the parent object, if applicable.
@@ -57,6 +58,36 @@ export class ContextDeleteEvent extends ContextEvent {
         super(type, { id, parent });
     }
 }
+/**
+ * An event to be used to delete a number of entities in the context provider.
+ */
+export class ContextDeleteBulkEvent extends ContextEvent {
+    /**
+     * An event to be used to delete a number of entities in the context provider.
+     * @param type The type of the event to dispatch.
+     * @param ids The list of ids of the domain object to remove.
+     * @param parent The id of the parent object, if applicable.
+     */
+    constructor(type, ids, parent) {
+        super(type, { ids, parent });
+    }
+}
+/**
+ * An event dispatched to the context store to restore previously deleted items.
+ */
+export class ContextRestoreEvent extends ContextEvent {
+    /**
+     * An event dispatched to the context store to restore previously deleted items.
+     *
+     * The result of the event is the list of `ContextChangeRecord` for the restored items.
+     *
+     * @param type The type of the event.
+     * @param records The records of previously deleted items.
+     */
+    constructor(type, records) {
+        super(type, records);
+    }
+}
 /**
  * An event dispatched when a context store object has been deleted.
  * In general a single context store uses the same event to dispatch the change record.
@@ -99,8 +130,37 @@ export class ContextStateUpdateEvent extends CustomEvent {
  * This is equivalent to PUT operation in REST HTTP.
  *
  * @template T The object that is being updated.
+ * @template U The object that is returned by the context store after updating. By default it is the `T`.
  */
 export class ContextUpdateEvent extends ContextEvent {
+    /**
+     * An event that is dispatched to update the entire object in the store.
+     * This is equivalent to PUT operation in REST HTTP.
+     *
+     * @param type The type of the event to dispatch
+     * @param updateInfo The update information.
+     */
+    constructor(type, updateInfo) {
+        super(type, updateInfo);
+    }
+}
+/**
+ * An event that is dispatched to update a list of objects in the store.
+ * This is equivalent to PUT operation in REST HTTP.
+ *
+ * If there's a parent, this event only allows to update entities in bulk for the same parent.
+ *
+ * @template T The object that is being updated.
+ * @template U The object that is returned by the context store after updating. By default it is the `T`.
+ */
+export class ContextUpdateBulkEvent extends ContextEvent {
+    /**
+     * An event that is dispatched to update the entire object in the store.
+     * This is equivalent to PUT operation in REST HTTP.
+     *
+     * @param type The type of the event to dispatch
+     * @param updateInfo The update information.
+     */
     constructor(type, updateInfo) {
         super(type, updateInfo);
     }
@@ -114,4 +174,28 @@ export class ContextListEvent extends ContextEvent {
         super(type, opts);
     }
 }
+/**
+ * An event dispatched to the context store to perform a query operation.
+ * If the context store supports the query operation, it should use the definition of `IQueryDetail` to perform the query.
+ * The result is the list of objects ordered by the store from the most relevant items to the least.
+ *
+ * The implementation should not assume pagination and return enough results for the user to find what they were looking for
+ * or to redefine the query. Suggested limit is `50` which in many cases is equivalent of 2 pages of results.
+ */
+export class ContextQueryEvent extends ContextEvent {
+    /**
+     * An event dispatched to the context store to perform a query operation.
+     * If the context store supports the query operation, it should use the definition of `IQueryDetail` to perform the query.
+     * The result is the list of objects ordered by the store from the most relevant items to the least.
+     *
+     * The implementation should not assume pagination and return enough results for the user to find what they were looking for
+     * or to redefine the query. Suggested limit is `50` which in many cases is equivalent of 2 pages of results.
+     *
+     * @param type The type of the event.
+     * @param opts The query options.
+     */
+    constructor(type, opts) {
+        super(type, opts);
+    }
+}
 //# sourceMappingURL=BaseEvents.js.map

package/build/src/events/BaseEvents.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseEvents.js","sourceRoot":"","sources":["../../../src/events/BaseEvents.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAc3C;;GAEG;AACH,MAAM,OAAO,YAAkC,SAAQ,WAAgD;IACrG;;;OAGG;IACH,YAAY,IAAY,EAAE,MAAS;QACjC,KAAK,CAAC,IAAI,EAAE;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,IAAI;YAChB,MAAM,EAAE;gBACN,MAAM,EAAE,SAAS;gBACjB,GAAG,MAAM;aACV;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAaD;;GAEG;AACH,MAAM,OAAO,gBAAoB,SAAQ,YAAuC;IAC9E;;;;OAIG;IACH,YAAY,IAAY,EAAE,EAAU,EAAE,MAAe;QACnD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF;AASD;;GAEG;AACH,MAAM,OAAO,oBAAwB,SAAQ,YAA2C;IACtF;;;OAGG;IACH,YAAY,IAAY,EAAE,GAAa;QACrC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IACvB,CAAC;CACF;AAqCD;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,YAA2D;IACjG;;;;OAIG;IACH,YAAY,IAAY,EAAE,EAAU,EAAE,MAAe;QACnD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF;AAkBD;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,WAAgC;IAC3E;;;OAGG;IACH,YAAY,IAAY,EAAE,MAA2B;QACnD,KAAK,CAAC,IAAI,EAAE;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,uBAA2B,SAAQ,WAAmC;IACjF;;;OAGG;IACH,YAAY,IAAY,EAAE,MAA8B;QACtD,KAAK,CAAC,IAAI,EAAE;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;CACF;AAaD;;;;;GAKG;AACH,MAAM,OAAO,kBAA4C,SAAQ,YAAiE;IAChI,YAAY,IAAY,EAAE,UAAuC;QAC/D,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC1B,CAAC;CACF;AAgCD,MAAM,OAAO,gBAAoB,SAAQ,YAAsD;IAC7F;;;OAGG;IACH,YAAY,IAAY,EAAE,OAA2B,EAAE;QACrD,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpB,CAAC;CACF"}
+{"version":3,"file":"BaseEvents.js","sourceRoot":"","sources":["../../../src/events/BaseEvents.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAc3C;;GAEG;AACH,MAAM,OAAO,YAAkC,SAAQ,WAAgD;IACrG;;;OAGG;IACH,YAAY,IAAY,EAAE,MAAS;QACjC,KAAK,CAAC,IAAI,EAAE;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,IAAI;YAChB,MAAM,EAAE;gBACN,MAAM,EAAE,SAAS;gBACjB,GAAG,MAAM;aACV;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAaD;;GAEG;AACH,MAAM,OAAO,gBAAoB,SAAQ,YAAuC;IAC9E;;;;OAIG;IACH,YAAY,IAAY,EAAE,EAAU,EAAE,MAAe;QACnD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF;AASD;;GAEG;AACH,MAAM,OAAO,oBAAwB,SAAQ,YAA2C;IACtF;;;OAGG;IACH,YAAY,IAAY,EAAE,GAAa;QACrC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IACvB,CAAC;CACF;AAgDD;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,YAA2D;IACjG;;;;;OAKG;IACH,YAAY,IAAY,EAAE,EAAU,EAAE,MAAe;QACnD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,YAA+D;IACzG;;;;;OAKG;IACH,YAAY,IAAY,EAAE,GAAa,EAAE,MAAe;QACtD,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/B,CAAC;CACF;AAkBD;;GAEG;AACH,MAAM,OAAO,mBAAuB,SAAQ,YAA2D;IACrG;;;;;;;OAOG;IACH,YAAY,IAAY,EAAE,OAA8B;QACtD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACvB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,WAAgC;IAC3E;;;OAGG;IACH,YAAY,IAAY,EAAE,MAA2B;QACnD,KAAK,CAAC,IAAI,EAAE;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,uBAA2B,SAAQ,WAAmC;IACjF;;;OAGG;IACH,YAAY,IAAY,EAAE,MAA8B;QACtD,KAAK,CAAC,IAAI,EAAE;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;CACF;AAaD;;;;;;GAMG;AACH,MAAM,OAAO,kBAA4C,SAAQ,YAAiE;IAChI;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,UAAuC;QAC/D,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAgD,SAAQ,YAAqE;IACxI;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,UAAyC;QACjE,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC1B,CAAC;CACF;AAgCD,MAAM,OAAO,gBAAoB,SAAQ,YAAsD;IAC7F;;;OAGG;IACH,YAAY,IAAY,EAAE,OAA2B,EAAE;QACrD,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpB,CAAC;CACF;AA2BD;;;;;;;GAOG;AACH,MAAM,OAAO,iBAA+B,SAAQ,YAA+B;IACjF;;;;;;;;;;OAUG;IACH,YAAY,IAAY,EAAE,IAAkB;QAC1C,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpB,CAAC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.6.24",
+  "version": "0.6.25",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",

package/src/events/BaseEvents.ts

@@ -113,11 +113,23 @@ export interface ContextDeleteEventDetail {
   parent?: string;
 }
 
+export interface ContextDeleteBulkEventDetail {
+  /**
+   * The list of ids of the domain object to remove.
+   */
+  ids: string[];
+  /**
+   * The id of the parent object, if applicable.
+   */
+  parent?: string;
+}
+
 /**
  * An event to be used to delete a state in the context provider.
  */
 export class ContextDeleteEvent extends ContextEvent<ContextDeleteEventDetail, ContextDeleteRecord> {
   /**
+   * An event to be used to delete a state in the context provider.
    * @param type The type of the event to dispatch.
    * @param id The id of the object to delete
    * @param parent The id of the parent object, if applicable.
@@ -127,6 +139,21 @@ export class ContextDeleteEvent extends ContextEvent<ContextDeleteEventDetail, C
   }
 }
 
+/**
+ * An event to be used to delete a number of entities in the context provider.
+ */
+export class ContextDeleteBulkEvent extends ContextEvent<ContextDeleteBulkEventDetail, ContextDeleteRecord> {
+  /**
+   * An event to be used to delete a number of entities in the context provider.
+   * @param type The type of the event to dispatch.
+   * @param ids The list of ids of the domain object to remove.
+   * @param parent The id of the parent object, if applicable.
+   */
+  constructor(type: string, ids: string[], parent?: string) {
+    super(type, { ids, parent });
+  }
+}
+
 export interface ContextDeleteRecord {
   /**
    * The data kind of the deleted item.
@@ -143,6 +170,23 @@ export interface ContextDeleteRecord {
   parent?: string;
 }
 
+/**
+ * An event dispatched to the context store to restore previously deleted items.
+ */
+export class ContextRestoreEvent<T> extends ContextEvent<ContextDeleteRecord[], ContextChangeRecord<T>> {
+  /**
+   * An event dispatched to the context store to restore previously deleted items.
+   * 
+   * The result of the event is the list of `ContextChangeRecord` for the restored items.
+   * 
+   * @param type The type of the event.
+   * @param records The records of previously deleted items.
+   */
+  constructor(type: string, records: ContextDeleteRecord[]) {
+    super(type, records);
+  }
+}
+
 /**
  * An event dispatched when a context store object has been deleted.
  * In general a single context store uses the same event to dispatch the change record.
@@ -198,13 +242,43 @@ export interface ContextUpdateEventDetail<T> {
  * This is equivalent to PUT operation in REST HTTP.
  * 
  * @template T The object that is being updated.
+ * @template U The object that is returned by the context store after updating. By default it is the `T`.
  */
 export class ContextUpdateEvent<T extends object, U = T> extends ContextEvent<ContextUpdateEventDetail<T>, ContextChangeRecord<U>> {
+  /**
+   * An event that is dispatched to update the entire object in the store.
+   * This is equivalent to PUT operation in REST HTTP.
+   * 
+   * @param type The type of the event to dispatch
+   * @param updateInfo The update information.
+   */
   constructor(type: string, updateInfo: ContextUpdateEventDetail<T>) {
     super(type, updateInfo);
   }
 }
 
+/**
+ * An event that is dispatched to update a list of objects in the store.
+ * This is equivalent to PUT operation in REST HTTP.
+ * 
+ * If there's a parent, this event only allows to update entities in bulk for the same parent.
+ * 
+ * @template T The object that is being updated.
+ * @template U The object that is returned by the context store after updating. By default it is the `T`.
+ */
+export class ContextUpdateBulkEvent<T extends object, U = T> extends ContextEvent<ContextUpdateEventDetail<T[]>, ContextChangeRecord<U>[]> {
+  /**
+   * An event that is dispatched to update the entire object in the store.
+   * This is equivalent to PUT operation in REST HTTP.
+   * 
+   * @param type The type of the event to dispatch
+   * @param updateInfo The update information.
+   */
+  constructor(type: string, updateInfo: ContextUpdateEventDetail<T[]>) {
+    super(type, updateInfo);
+  }
+}
+
 /**
  * Data store query result object.
  */
@@ -244,3 +318,53 @@ export class ContextListEvent<T> extends ContextEvent<ContextListOptions, Contex
     super(type, opts);
   }
 }
+
+export interface IQueryDetail {
+  /**
+   * The query term. All values are always passed as string. Context store must parse value if it requires other types.
+   */
+  term: string;
+
+  /**
+   * If the context store supports it, the tags to use with the query function to limit the results.
+   */
+  tags?: string[];
+
+  /**
+   * General purpose type to be defined by the context store.
+   * Allows to specify the type of the query to perform.
+   */
+  type?: string;
+
+  /**
+   * General purpose keyword to be defined by the context store.
+   * The purpose is to instruct the context store to perform detailed search.
+   * Usually this means longer search time but more accurate results.
+   */
+  detailed?: boolean;
+}
+
+/**
+ * An event dispatched to the context store to perform a query operation.
+ * If the context store supports the query operation, it should use the definition of `IQueryDetail` to perform the query.
+ * The result is the list of objects ordered by the store from the most relevant items to the least.
+ * 
+ * The implementation should not assume pagination and return enough results for the user to find what they were looking for
+ * or to redefine the query. Suggested limit is `50` which in many cases is equivalent of 2 pages of results.
+ */
+export class ContextQueryEvent<T = unknown> extends ContextEvent<IQueryDetail, T[]> {
+  /**
+   * An event dispatched to the context store to perform a query operation.
+   * If the context store supports the query operation, it should use the definition of `IQueryDetail` to perform the query.
+   * The result is the list of objects ordered by the store from the most relevant items to the least.
+   * 
+   * The implementation should not assume pagination and return enough results for the user to find what they were looking for
+   * or to redefine the query. Suggested limit is `50` which in many cases is equivalent of 2 pages of results.
+   * 
+   * @param type The type of the event.
+   * @param opts The query options.
+   */
+  constructor(type: string, opts: IQueryDetail) {
+    super(type, opts);
+  }
+}