@api-client/core 0.8.21 → 0.9.0

package/build/src/runtime/store/interfaces/Certificates.d.ts

@@ -0,0 +1,49 @@
+import { HttpCertificate } from "../../../models/ClientCertificate.js";
+import { ContextChangeRecord, ContextDeleteRecord, ContextListResult, ContextSpaceListOptions, IBulkOperationResult } from "../../../events/BaseEvents.js";
+/**
+ * A store for the client certificates.
+ * This just keeps record of removed files. File location does not change.
+ */
+export interface Certificates {
+    /**
+     * Inserts a certificate to the store
+     *
+     * @param value The value to insert.
+     * @param space The parent space of the certificate.
+     */
+    add(value: HttpCertificate, space: string): Promise<ContextChangeRecord<HttpCertificate>>;
+    /**
+     * Adds certificates in a bulk operation.
+     * @param value The lits of certificates to add.
+     * @param space The parent workspace
+     * @returns The list of inserted certificates. `undefined` when there was an error inserting a certificate.
+     */
+    addBulk(values: HttpCertificate[], space: string): Promise<IBulkOperationResult<ContextChangeRecord<HttpCertificate>>>;
+    /**
+     * @param key The key of the certificate to read.
+     */
+    read(key: string): Promise<HttpCertificate>;
+    /**
+     * Lists certificate entires.
+     *
+     * @param space The parent space of the certificate.
+     * @param options The list query options.
+     */
+    list(options?: ContextSpaceListOptions): Promise<ContextListResult<HttpCertificate>>;
+    /**
+     * Marks the certificate as deleted.
+     *
+     * @param key The key of the certificate to delete.
+     */
+    delete(key: string): Promise<ContextDeleteRecord>;
+    /**
+     * Removed certificates in a bulk operation.
+     * @param keys The list of certificate keys to delete.
+     */
+    deleteBulk(keys: string[]): Promise<IBulkOperationResult<ContextDeleteRecord>>;
+    /**
+     * Removes all certificates from the store for the given workspace.
+     * @param space The parent workspace key
+     */
+    empty(space: string): Promise<void>;
+}

package/build/src/runtime/store/interfaces/Certificates.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Certificates.js.map

package/build/src/runtime/store/interfaces/Certificates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Certificates.js","sourceRoot":"","sources":["../../../../../src/runtime/store/interfaces/Certificates.ts"],"names":[],"mappings":""}

package/build/src/runtime/store/interfaces/Files.d.ts

@@ -0,0 +1,63 @@
+import { IFile, FileAddOptions, FileBreadcrumb } from '../../../models/store/File.js';
+import { ContextChangeRecord, ContextDeleteRecord, ContextListResult, ContextSpaceListOptions, IBulkOperationResult, IPatchInfo, IPatchRevision } from '../../../events/BaseEvents.js';
+/**
+ * A store that stores file/folder metadata in a filesystem like structure.
+ *
+ * In API Client the `space` is a parent for all data kept in the application.
+ */
+export interface Files {
+    /**
+     * Lists files in a space.
+     * @param options Query options. It must include `space`.
+     * @param kinds Optionally, lists the files with the listed kinds.
+     */
+    list(options: ContextSpaceListOptions, kinds?: string[]): Promise<ContextListResult<IFile>>;
+    /**
+     * Adds a new file to the store. Note, this throws an error when a file already exists.
+     *
+     * @param input The file to add.
+     * @param space The id of the parent space.
+     * @param opts The file add options.
+     */
+    add(input: IFile, space: string, opts?: FileAddOptions): Promise<ContextChangeRecord<IFile>>;
+    /**
+     * Reads a file meta from the store.
+     * It throws when the file does not exist or was deleted.
+     *
+     * @param key The id of the file to read the metadata for.
+     */
+    read(key: string): Promise<IFile>;
+    /**
+     * Reads multiple files in a single call.
+     * Unlike the `read()` method, this does not throw when a file is not found or deleted.
+     * When the file is missing it inserts `undefined` or `null` in the resulting array at the index
+     * of the missing key.
+     *
+     * Note, this returns `undefined` when directly querying the store but it may return `null` when
+     * structured clone algorithm is used between the application and the database.
+     *
+     * @param keys The list of keys to read
+     */
+    readBulk(keys: string[]): Promise<IBulkOperationResult<IFile>>;
+    /**
+     * Marks file as deleted.
+     * Files are not deleted by using this method. They are marked as deleted and later ignored
+     * by most of the API.
+     *
+     * @param key The database id of the file to remove.
+     */
+    delete(key: string): Promise<ContextDeleteRecord>;
+    /**
+     * This is the preferred way to update a file metadata. It allows to apply a reversible patch
+     * to the file and reverse it on demand.
+     *
+     * @param key The datastore id of the file to patch
+     * @param info The patch to apply.
+     */
+    patch(key: string, info: IPatchInfo): Promise<IPatchRevision>;
+    /**
+     * Lists breadcrumbs to the file.
+     * @param key The lowest file in the hierarchy
+     */
+    breadcrumbs(key: string): Promise<ContextListResult<FileBreadcrumb>>;
+}

package/build/src/runtime/store/interfaces/Files.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Files.js.map

package/build/src/runtime/store/interfaces/Files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Files.js","sourceRoot":"","sources":["../../../../../src/runtime/store/interfaces/Files.ts"],"names":[],"mappings":""}

package/build/src/runtime/store/interfaces/History.d.ts

@@ -0,0 +1,63 @@
+import { ContextChangeRecord, ContextDeleteRecord, ContextListResult, HistoryListOptions, IBulkOperationResult } from "../../../events/BaseEvents.js";
+import { IHttpHistory, IHttpHistoryBulkAdd } from "../../../models/HttpHistory.js";
+/**
+ * A store for the HTTP requests history.
+ */
+export interface History {
+    /**
+     * Adds a history object to the store.
+     *
+     * @param history The history object
+     * @param space The parent space key
+     */
+    add(item: IHttpHistory): Promise<ContextChangeRecord<IHttpHistory>>;
+    /**
+     * Adds history in a bulk operation.
+     * @param info The bulk add operation schema.
+     * @param space The parent space key
+     */
+    addBulk(info: IHttpHistoryBulkAdd): Promise<IBulkOperationResult<ContextChangeRecord<IHttpHistory>>>;
+    /**
+     * Lists the history data.
+     * @param space The parent space key
+     * @param options List options
+     */
+    list(options?: HistoryListOptions): Promise<ContextListResult<IHttpHistory>>;
+    /**
+     * Marks the data as deleted. It also removes the data from the indexes.
+     * Only the owner can delete the history object. This may change in the future.
+     *
+     * @param key The history object key to delete. This is an URL-encoded key.
+     */
+    delete(key: string): Promise<ContextDeleteRecord>;
+    /**
+     * Deletes a history in a bulk operation.
+     * @param keys The list of history keys to delete. This is base64url encoded keys
+     */
+    deleteBulk(keys: string[]): Promise<IBulkOperationResult<ContextDeleteRecord>>;
+    /**
+     * Reads a history item.
+     *
+     * @param key The key of the history object to read.
+     */
+    read(key: string): Promise<IHttpHistory>;
+    /**
+     * Clears the datastore from history for a space.
+     *
+     * @param space The parent space key
+     */
+    clearSpace(space: string): Promise<void>;
+    /**
+     * Clears all history from a project
+     *
+     * @param project The parent project key
+     */
+    clearProject(project: string): Promise<void>;
+    /**
+     * Clears all history from a request
+     *
+     * @param project The parent project key
+     * @param request The parent request key
+     */
+    clearRequest(project: string, request: string): Promise<void>;
+}

package/build/src/runtime/store/interfaces/History.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=History.js.map

package/build/src/runtime/store/interfaces/History.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"History.js","sourceRoot":"","sources":["../../../../../src/runtime/store/interfaces/History.ts"],"names":[],"mappings":""}

package/build/src/runtime/store/interfaces/Media.d.ts

@@ -0,0 +1,42 @@
+import { IPatchInfo, IPatchRevision } from "../../../events/BaseEvents.js";
+import { MediaReadOptions } from "../../../models/store/File.js";
+/**
+ * A media is the contents of a File.
+ * Keys are the same as for a file but kept in a different namespace.
+ *
+ * Note, this class does not check for space dependency. This should be done when requesting a file, not contents.
+ */
+export interface Media {
+    /**
+     * Creates / re-creates file contents.
+     *
+     * @param key The datastore id of the file to create/update the contents for.
+     * @param contents The contents to store.
+     * @param mime The content mime type. Used for (de)serialization.
+     * @param allowOverwrite Whether overwriting is permitted. When not then in throws an error when trying to re-create a file.
+     */
+    add(key: string, contents: unknown, mime: string, allowOverwrite: boolean): Promise<void>;
+    /**
+     * Reads file contents.
+     * @param key The datastore key of the file
+     * @param opts Read options.
+     */
+    read(key: string, opts?: MediaReadOptions): Promise<unknown>;
+    /**
+     * Deletes file contents.
+     * Note, this won't broadcast the delete event as this is done by the `files?alt=meta`.
+     *
+     * @param key The file key to delete.
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * This is the preferred way to update a file contents.
+     *
+     * Note, the broadcast event will most likely contain the `kind` of the **file** metadata and not content's.
+     * The media has no concept of a `kind` as it may store any data.
+     *
+     * @param key The datastore key of the file to patch
+     * @param info The patch to apply.
+     */
+    patch(key: string, info: IPatchInfo): Promise<IPatchRevision>;
+}

package/build/src/runtime/store/interfaces/Media.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Media.js.map

package/build/src/runtime/store/interfaces/Media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Media.js","sourceRoot":"","sources":["../../../../../src/runtime/store/interfaces/Media.ts"],"names":[],"mappings":""}

package/build/src/runtime/store/interfaces/Revisions.d.ts

@@ -0,0 +1,25 @@
+import { IRevision } from "../../../models/store/Revision.js";
+import { ContextListResult, ContextSpaceListOptions } from "../../../events/BaseEvents.js";
+import { JsonPatch } from "@api-client/json";
+/**
+ * A store to keep revision data for a file.
+ * This only stores revision data for file contents, not metadata.
+ */
+export interface Revisions {
+    /**
+     * Lists revisions for a single file.
+     *
+     * @param key The id of the file to lists revisions for.
+     * @param options The list query options
+     */
+    list(key: string, options: ContextSpaceListOptions): Promise<ContextListResult<IRevision>>;
+    /**
+     * Creates a new revision for a file contents.
+     *
+     * @param key The datastore id of the file
+     * @param space The parent space
+     * @param kind The kind of the file that was patched
+     * @param patch The applied patch.
+     */
+    add(key: string, space: string, kind: string, patch: JsonPatch): Promise<IRevision>;
+}

package/build/src/runtime/store/interfaces/Revisions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Revisions.js.map

package/build/src/runtime/store/interfaces/Revisions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Revisions.js","sourceRoot":"","sources":["../../../../../src/runtime/store/interfaces/Revisions.ts"],"names":[],"mappings":""}

package/build/src/runtime/store/interfaces/Spaces.d.ts

@@ -0,0 +1,42 @@
+import { ISpace } from "../../../models/Space.js";
+import { ContextListResult, ContextListOptions, ContextDeleteRecord, ContextChangeRecord } from "../../../events/BaseEvents.js";
+/**
+ * A store that keeps a list of spaces created in the application.
+ */
+export interface Spaces {
+    /**
+     * Lists spaces created by the user.
+     * @param options The list query options
+     */
+    list(options?: ContextListOptions): Promise<ContextListResult<ISpace>>;
+    /**
+     * Creates a space from the name.
+     *
+     * @param name The name of the space to create
+     */
+    add(name: string): Promise<ContextChangeRecord<ISpace>>;
+    /**
+     * Creates a space from a space definition.
+     * @param space The space definition.
+     */
+    add(space: ISpace): Promise<ContextChangeRecord<ISpace>>;
+    /**
+     * Creates a space from a name or a definition.
+     *
+     * @param nameOrObject The space name or definition.
+     */
+    add(nameOrObject: string | ISpace): Promise<ContextChangeRecord<ISpace>>;
+    /**
+     * Reads a single space from the store.
+     * @param key The key of the space to read.
+     */
+    read(key: string): Promise<ISpace>;
+    /**
+     * Marks space as deleted.
+     * Note, this does not remove any data from the store. It marks the space as deleted
+     * and then the space is ignored by most of the API.
+     *
+     * @param key The key of the space to delete.
+     */
+    delete(key: string): Promise<ContextDeleteRecord>;
+}

package/build/src/runtime/store/interfaces/Spaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Spaces.js.map

package/build/src/runtime/store/interfaces/Spaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Spaces.js","sourceRoot":"","sources":["../../../../../src/runtime/store/interfaces/Spaces.ts"],"names":[],"mappings":""}

package/build/src/runtime/store/interfaces/Trash.d.ts

@@ -0,0 +1,38 @@
+import { IFile } from "../../../models/store/File.js";
+import { ContextChangeRecord, ContextListResult, ContextSpaceListOptions } from "../../../events/BaseEvents.js";
+import { TrashEntry, TrashEntryCreate } from "../../../models/TrashEntry.js";
+/**
+ * A store for the file trash.
+ * This just keeps record of removed files. File location does not change.
+ */
+export interface Trash {
+    /**
+     * Inserts a record of file delete.
+     *
+     * @param entry The trash entry definition
+     * @param space The parent space of the file
+     */
+    add(entry: TrashEntryCreate, space: string): Promise<ContextChangeRecord<TrashEntry>>;
+    /**
+     * Lists trashed entires.
+     * @param options The list query options.
+     */
+    list(options: ContextSpaceListOptions): Promise<ContextListResult<TrashEntry>>;
+    /**
+     * Removes a trash entry permanently from the store.
+     * @param key The key of the deleted object
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Restores a file from the trash.
+     * It deletes a trash entry and updates the `file` object.
+     *
+     * @param key The key of the file to restore
+     */
+    restore(key: string): Promise<ContextChangeRecord<IFile>>;
+    /**
+     * Empties the trash for the given space.
+     * @param space The space key to remove trash for.
+     */
+    empty(space: string): Promise<void>;
+}

package/build/src/runtime/store/interfaces/Trash.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Trash.js.map

package/build/src/runtime/store/interfaces/Trash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Trash.js","sourceRoot":"","sources":["../../../../../src/runtime/store/interfaces/Trash.ts"],"names":[],"mappings":""}

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.8.21",
+  "version": "0.9.0",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",
@@ -22,6 +22,17 @@
     "url": "https://github.com/api-client/core/issues",
     "email": "pawel.psztyc@gmail.com"
   },
+  "dependencies": {
+    "@api-client/json": "^0.1.3",
+    "@metrichor/jmespath": "^0.3.1",
+    "@pawel-up/data-mock": "^0.3.0",
+    "@pawel-up/jexl": "^3.0.0",
+    "@xmldom/xmldom": "^0.8.2",
+    "amf-json-ld-lib": "^0.0.14",
+    "console-table-printer": "^2.11.0",
+    "ws": "^8.6.0",
+    "xpath": "^0.0.32"
+  },
   "devDependencies": {
     "@commitlint/cli": "^17.0.0",
     "@commitlint/config-conventional": "^17.0.0",
@@ -87,17 +98,6 @@
       "eslint --fix"
     ]
   },
-  "dependencies": {
-    "@api-client/json": "^0.1.3",
-    "@metrichor/jmespath": "^0.3.1",
-    "@pawel-up/data-mock": "^0.3.0",
-    "@pawel-up/jexl": "^3.0.0",
-    "@xmldom/xmldom": "^0.8.2",
-    "amf-json-ld-lib": "^0.0.14",
-    "console-table-printer": "^2.11.0",
-    "ws": "^8.6.0",
-    "xpath": "^0.0.32"
-  },
   "engines": {
     "node": ">=15"
   }

package/src/events/BaseEvents.ts

@@ -1,5 +1,6 @@
+import { JsonPatch } from '@api-client/json'
 import CustomEvent from './CustomEvent.js';
-import { IQueryResponse } from '../models/store/Backend.js';
+import { AccessOperation } from '../models/store/Permission.js';
 
 /**
  * Base event detail definition for the events that returns a `result`
@@ -48,7 +49,7 @@ export interface ContextReadEventDetail {
 /**
  * An event to be used to read a state from a context provider.
  */
-export class ContextReadEvent<T> extends ContextEvent<ContextReadEventDetail, T> {
+export class ContextReadEvent<T> extends ContextEvent<ContextReadEventDetail, T | null | undefined> {
   /**
    * @param type The type of the event
    * @param key The domain key of the object to read
@@ -73,7 +74,7 @@ export interface ContextReadBulkEventDetail {
 /**
  * An event to be used to read a list of object from the API store.
  */
-export class ContextReadBulkEvent<T> extends ContextEvent<ContextReadBulkEventDetail, T[]> {
+export class ContextReadBulkEvent<T> extends ContextEvent<ContextReadBulkEventDetail, IBulkOperationResult<(T | null | undefined)>> {
   /**
    * @param type The type of the event
    * @param keys The list of domain keys to read. These must be of the same domain type.
@@ -144,10 +145,23 @@ export class ContextDeleteEvent extends ContextEvent<ContextDeleteEventDetail, C
   }
 }
 
+/**
+ * Describes a result of the batch delete operation.
+ */
+export interface IBulkOperationResult<T> {
+  /**
+   * The ordered list of delete result for each item.
+   * 
+   * The batch operation does not return specific errors. Use the direct delete operation
+   * for the detailed error.
+   */
+  items: (T | undefined | null)[];
+}
+
 /**
  * An event to be used to delete a number of entities in the context provider.
  */
-export class ContextDeleteBulkEvent extends ContextEvent<ContextDeleteBulkEventDetail, ContextDeleteRecord[]> {
+export class ContextDeleteBulkEvent extends ContextEvent<ContextDeleteBulkEventDetail, IBulkOperationResult<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.
@@ -178,7 +192,7 @@ export interface ContextDeleteRecord {
 /**
  * An event dispatched to the context store to restore previously deleted items.
  */
-export class ContextRestoreEvent<T> extends ContextEvent<{ records: ContextDeleteRecord[] }, (ContextChangeRecord<T> | undefined)[]> {
+export class ContextRestoreEvent<T> extends ContextEvent<{ records: ContextDeleteRecord[] }, IBulkOperationResult<ContextChangeRecord<T>>> {
   /**
    * An event dispatched to the context store to restore previously deleted items.
    * 
@@ -242,7 +256,7 @@ export interface ContextUpdateEventDetail<T> {
   parent?: string;
 }
 
-export interface ContextUpdateBulkEventDetail<T> {
+export interface ContextUpdateBulkEventDetail<T = unknown> {
   /**
    * The list of context store objects to be updated by the context provider.
    */
@@ -282,7 +296,7 @@ export class ContextUpdateEvent<T extends object, U = T> extends ContextEvent<Co
  * @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<ContextUpdateBulkEventDetail<T>, ContextChangeRecord<U>[]> {
+export class ContextUpdateBulkEvent<T extends object, U = T> extends ContextEvent<ContextUpdateBulkEventDetail<T>, IBulkOperationResult<ContextChangeRecord<U>>> {
   /**
    * An event that is dispatched to update the entire object in the store.
    * This is equivalent to PUT operation in REST HTTP.
@@ -299,12 +313,6 @@ export class ContextUpdateBulkEvent<T extends object, U = T> extends ContextEven
  * Data store query result object.
  */
 export interface ContextListResult<T> {
-  /**
-   * Next page token to be used with pagination.
-   * It is not set when the query has not returned any results.
-   * @deprecated Use `cursor` instead.
-   */
-  nextPageToken?: string;
   /**
    * The cursor to use with the next query. It has the list state encoded in it.
    */
@@ -324,11 +332,6 @@ export interface ContextListOptions {
    * The number of results per the page.
    */
   limit?: number;
-  /**
-   * A string that should be used with the pagination.
-   * @deprecated Use `cursor` instead.
-   */
-  nextPageToken?: string;
   /**
    * Page cursor to use with the query. This is returned by the 
    */
@@ -349,6 +352,10 @@ export interface ContextListOptions {
    * Whether to use the `descending` order.
    */
   descending?: boolean;
+  /**
+   * The name of the field to order then results.
+   */
+  orderField?: string;
   /**
    * General purpose type property to filer the results.
    * This is used, for example, by the history store to list history for a specific type of requests,
@@ -362,6 +369,13 @@ export interface ContextListOptions {
   since?: number;
 }
 
+export interface ContextSpaceListOptions extends ContextListOptions {
+  /**
+   * The identifier of the parent space (or organization).
+   */
+  space: string;
+}
+
 export class ContextListEvent<T> extends ContextEvent<ContextListOptions, ContextListResult<T>> {
   /**
    * @param type The type of the event
@@ -397,6 +411,24 @@ export interface IQueryDetail {
   detailed?: boolean;
 }
 
+export interface IQueryResponse<T = unknown> {
+  /**
+   * An ordered list of results.
+   */
+  items: IQueryResult<T>[];
+}
+
+export interface IQueryResult<T = unknown> {
+  /**
+   * The document.
+   */
+  doc: T;
+  /**
+   * The list of indexes where this document was found.
+   */
+  index: string[];
+}
+
 /**
  * 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.
@@ -421,3 +453,89 @@ export class ContextQueryEvent<T = unknown> extends ContextEvent<IQueryDetail, I
     super(type, opts);
   }
 }
+
+/**
+ * Query options to list history for a request in a project.
+ * The user has to have access to the parent user space to read / create / delete the history.
+ */
+export interface IHistoryRequestListOptions extends ContextListOptions {
+  type: 'request';
+  /**
+   * The key of the parent space.
+   */
+  space: string;
+  /**
+   * The id of the project that contains the request.
+   */
+  project: string;
+  /**
+   * The id of the request.
+   */
+  id: string;
+  /**
+   * Whether to limit the list of results to the history that belongs to the current user.
+   */
+  user?: boolean;
+}
+
+/**
+ * Listing options for the HTTP history.
+ */
+export type HistoryListOptions = IHistoryRequestListOptions;
+
+
+export interface IPatchBase {
+  /**
+   * Auto generated by the client sending the PATCH.
+   */
+  id: string;
+  /**
+   * The application id that generated the patch.
+   * This is a string that is assigned to each application in the suite.
+   * External applications need to use a constant string for their apps.
+   */
+  app: string;
+  /**
+   * The version of the application that generated the patch.
+   * This can and will be used to handle potential differences between suite applications.
+   */
+  appVersion: string;
+  /**
+   * The patch generated by the client.
+   */
+  patch: unknown;
+}
+
+/**
+ * An interface describing a schema to be sent to the server
+ * when making a patch of a file.
+ */
+export interface IPatchInfo extends IPatchBase {
+  /**
+   * The patch generated by the client.
+   */
+  patch: JsonPatch;
+}
+
+/**
+ * An interface describing a schema to be sent to the server
+ * when making a patch with user access to a file.
+ */
+export interface IAccessPatchInfo extends IPatchBase {
+  /**
+   * The patch generated by the client.
+   */
+  patch: AccessOperation[];
+}
+
+/**
+ * A schema sent by the store server in a response to the patch request.
+ * It contains an information about the applied patch, the reverse operation associated with it,
+ * application information, and the generated by the client patch id.
+ */
+export interface IPatchRevision extends IPatchInfo {
+  /**
+   * The patch to apply to the object to revert the changes.
+   */
+  revert: JsonPatch;
+}