@api-client/core 0.8.8 → 0.8.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/build/src/models/store/Backend.d.ts +10 -2
  2. package/package.json +1 -1
  3. package/src/models/store/Backend.ts +10 -2
package/build/src/models/store/Backend.d.ts CHANGED
@@ -107,8 +107,16 @@ export interface IBackendEvent extends IBackendMessage {
107
107
  *
108
108
  * Note, `updated` is when the entire object must be revalidated in the opposite
109
109
  * to `patch` where the patch should be applied to the object.
110
- */
111
- operation: 'created' | 'patch' | 'deleted' | 'access-granted' | 'access-removed';
110
+ *
111
+ * - created - when an entity was created
112
+ * - patch - when a patch operation was applied to an entity
113
+ * - deleted - when an entity was deleted
114
+ * - access-granted - when access to an entity was granted. This also includes when the access level change.
115
+ * - access-removed - when access to an entity was removed.
116
+ * - updated - used in special cases as most communication uses patch. Informs the whole object was updated.
117
+ * - cleared - when the data store was cleared and all entities destroyed.
118
+ */
119
+ operation: 'created' | 'patch' | 'deleted' | 'access-granted' | 'access-removed' | 'updated' | 'cleared';
112
120
  /**
113
121
  * The kind of data that has been changed.
114
122
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@api-client/core",
3
3
  "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
4
- "version": "0.8.8",
4
+ "version": "0.8.9",
5
5
  "license": "Apache-2.0",
6
6
  "main": "build/index.js",
7
7
  "module": "build/index.js",
package/src/models/store/Backend.ts CHANGED
@@ -117,8 +117,16 @@ export interface IBackendEvent extends IBackendMessage {
117
117
  *
118
118
  * Note, `updated` is when the entire object must be revalidated in the opposite
119
119
  * to `patch` where the patch should be applied to the object.
120
- */
121
- operation: 'created' | 'patch' | 'deleted' | 'access-granted' | 'access-removed';
120
+ *
121
+ * - created - when an entity was created
122
+ * - patch - when a patch operation was applied to an entity
123
+ * - deleted - when an entity was deleted
124
+ * - access-granted - when access to an entity was granted. This also includes when the access level change.
125
+ * - access-removed - when access to an entity was removed.
126
+ * - updated - used in special cases as most communication uses patch. Informs the whole object was updated.
127
+ * - cleared - when the data store was cleared and all entities destroyed.
128
+ */
129
+ operation: 'created' | 'patch' | 'deleted' | 'access-granted' | 'access-removed' | 'updated' | 'cleared';
122
130
  /**
123
131
  * The kind of data that has been changed.
124
132
  */