@conduction/nextcloud-vue 2.56.0-beta.26 → 2.56.0-beta.28

package/dist/esm/store/plugins/interactions.js

@@ -3,7 +3,8 @@ import { setFavourite, setReadState, setWatching, listWatchers, setWatcher } fro
 /**
  * Interactions plugin for the object store.
  *
- * Per-user interaction calls on a record: favourite, follow (watch) and the
+ * Per-user interaction calls on a record: follow (watch, with its
+ * notifications switch), the deprecated favourite (a quiet follow), and the
  * followers list. Each write puts the server's answer into the stored object's
  * `@self`, so a list showing the same object agrees with the toggle.
  *
@@ -55,7 +56,10 @@ function interactionsPlugin() {
 			},
 
 			/**
-			 * Star a record.
+			 * Star a record: a quiet follow on the server.
+			 *
+			 * @deprecated A favourite is a follow with notifications off since
+			 * OpenRegister's `merge-follow-and-favourites`; use `watch(type, id, { notify: false })`.
 			 *
 			 * @param {string} type The registered object type slug
 			 * @param {string} objectId The object ID
@@ -65,13 +69,15 @@ function interactionsPlugin() {
 				const { register, schema } = this._interactionTarget(type);
 				const result = await setFavourite(register, schema, objectId, true);
 				if (result.ok) {
-					this._patchSelf(type, objectId, { favourite: true });
+					this._patchSelf(type, objectId, { favourite: true, watching: true });
 				}
 				return result
 			},
 
 			/**
-			 * Unstar a record.
+			 * Unstar a record: unfollow it.
+			 *
+			 * @deprecated Use `unwatch`.
 			 *
 			 * @param {string} type The registered object type slug
 			 * @param {string} objectId The object ID
@@ -81,7 +87,7 @@ function interactionsPlugin() {
 				const { register, schema } = this._interactionTarget(type);
 				const result = await setFavourite(register, schema, objectId, false);
 				if (result.ok) {
-					this._patchSelf(type, objectId, { favourite: false });
+					this._patchSelf(type, objectId, { favourite: false, watching: false, watchNotify: undefined });
 				}
 				return result
 			},
@@ -119,17 +125,21 @@ function interactionsPlugin() {
 			},
 
 			/**
-			 * Follow a record.
+			 * Follow a record, optionally setting its notifications switch.
 			 *
 			 * @param {string} type The registered object type slug
 			 * @param {string} objectId The object ID
+			 * @param {object} [options] Options
+			 * @param {boolean} [options.notify] The notifications switch; left out, a new follow notifies
 			 * @return {Promise<object>} The outcome
+			 * @spec openspec/changes/one-follow-control/specs/record-follow/spec.md#requirement-one-follow-control-with-a-notifications-switch
 			 */
-			async watch(type, objectId) {
+			async watch(type, objectId, options = {}) {
 				const { register, schema } = this._interactionTarget(type);
-				const result = await setWatching(register, schema, objectId, true);
+				const result = await setWatching(register, schema, objectId, true, options);
 				if (result.ok) {
-					this._patchSelf(type, objectId, { watching: true });
+					const notify = result.data && typeof result.data.notify === 'boolean' ? result.data.notify : true;
+					this._patchSelf(type, objectId, { watching: true, favourite: true, watchNotify: notify });
 				}
 				return result
 			},
@@ -145,7 +155,7 @@ function interactionsPlugin() {
 				const { register, schema } = this._interactionTarget(type);
 				const result = await setWatching(register, schema, objectId, false);
 				if (result.ok) {
-					this._patchSelf(type, objectId, { watching: false });
+					this._patchSelf(type, objectId, { watching: false, favourite: false, watchNotify: undefined });
 				}
 				return result
 			},

package/dist/esm/store/plugins/interactions.js.map

@@ -1 +1 @@
-{"version":3,"file":"interactions.js","sources":["../../../../src/store/plugins/interactions.js"],"sourcesContent":["import { listWatchers, setFavourite, setReadState, setWatcher, setWatching } from '../../utils/recordInteractions.js'\n\n/**\n * Interactions plugin for the object store.\n *\n * Per-user interaction calls on a record: favourite, follow (watch) and the\n * followers list. Each write puts the server's answer into the stored object's\n * `@self`, so a list showing the same object agrees with the toggle.\n *\n * Actions: favourite, unfavourite, watch, unwatch, fetchWatchers, addWatcher, removeWatcher, markRead, markUnread.\n * Each returns the outcome `{ ok, status, data, message }` and never throws.\n *\n * @return {object} The plugin definition (name, state, getters, actions)\n *\n * @example\n * const useStore = createObjectStore('object', { plugins: [interactionsPlugin()] })\n * const store = useStore()\n * await store.watch('case', caseId)\n * const { data } = await store.fetchWatchers('case', caseId)\n */\nexport function interactionsPlugin() {\n\treturn {\n\t\tname: 'Interactions',\n\n\t\tstate: () => ({}),\n\n\t\tgetters: {},\n\n\t\tactions: {\n\t\t\t/**\n\t\t\t * Merge a patch into the stored object's `@self`.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @param {object} patch Keys to merge into `@self`\n\t\t\t */\n\t\t\t_patchSelf(type, objectId, patch) {\n\t\t\t\tconst stored = this.objects && this.objects[type] && this.objects[type][objectId]\n\t\t\t\tif (!stored) {\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t\tconst next = { ...stored, '@self': { ...(stored['@self'] || {}), ...patch } }\n\t\t\t\tthis.objects = { ...this.objects, [type]: { ...this.objects[type], [objectId]: next } }\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Resolve a type slug to its register and schema.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @return {{register: string, schema: string}} The path segments\n\t\t\t */\n\t\t\t_interactionTarget(type) {\n\t\t\t\tconst config = this._getTypeConfig(type)\n\t\t\t\treturn { register: config.register, schema: config.schema }\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Star a record.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync favourite(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setFavourite(register, schema, objectId, true)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { favourite: true })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Unstar a record.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync unfavourite(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setFavourite(register, schema, objectId, false)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { favourite: false })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Mark a record read (`PUT .../read-state`).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync markRead(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setReadState(register, schema, objectId, true)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { unread: false })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Mark a record unread (`DELETE .../read-state`).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync markUnread(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setReadState(register, schema, objectId, false)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { unread: true })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Follow a record.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync watch(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setWatching(register, schema, objectId, true)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { watching: true })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Unfollow a record.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync unwatch(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setWatching(register, schema, objectId, false)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { watching: false })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * List the followers of a record (needs `update` on it).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome; `data` is `{ results, total }`\n\t\t\t */\n\t\t\tasync fetchWatchers(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\treturn listWatchers(register, schema, objectId)\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Add a colleague as a follower (needs `manage`).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @param {string} userId The colleague's user id\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync addWatcher(type, objectId, userId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\treturn setWatcher(register, schema, objectId, userId, true)\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Remove a follower (needs `manage`, or be the user yourself).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @param {string} userId The follower's user id\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync removeWatcher(type, objectId, userId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\treturn setWatcher(register, schema, objectId, userId, false)\n\t\t\t},\n\t\t},\n\t}\n}\n"],"names":[],"mappings":";;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,kBAAkB,GAAG;AACrC,CAAC,OAAO;AACR,EAAE,IAAI,EAAE,cAAc;AACtB;AACA,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AACnB;AACA,EAAE,OAAO,EAAE,EAAE;AACb;AACA,EAAE,OAAO,EAAE;AACX;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;AACrC,IAAI,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAC;AACrF,IAAI,IAAI,CAAC,MAAM,EAAE;AACjB,KAAK,MAAM;AACX,KAAK;AACL,IAAI,MAAM,IAAI,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,GAAE;AACjF,IAAI,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,GAAG,IAAI,EAAE,GAAE;AAC3F,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,kBAAkB,CAAC,IAAI,EAAE;AAC5B,IAAI,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAC;AAC5C,IAAI,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;AAC/D,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE;AACnC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAC;AACvE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAC;AACzD,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE;AACrC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAC;AACxE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAC;AAC1D,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE;AAClC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAC;AACvE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAC;AACvD,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE;AACpC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAC;AACxE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAC;AACtD,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE;AAC/B,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAC;AACtE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAC;AACxD,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE;AACjC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAC;AACvE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAC;AACzD,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE;AACvC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC;AACnD,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE;AAC5C,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,OAAO,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC;AAC/D,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE;AAC/C,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,OAAO,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC;AAChE,IAAI;AACJ,GAAG;AACH,EAAE;AACF;;;;"}
+{"version":3,"file":"interactions.js","sources":["../../../../src/store/plugins/interactions.js"],"sourcesContent":["import { listWatchers, setFavourite, setReadState, setWatcher, setWatching } from '../../utils/recordInteractions.js'\n\n/**\n * Interactions plugin for the object store.\n *\n * Per-user interaction calls on a record: follow (watch, with its\n * notifications switch), the deprecated favourite (a quiet follow), and the\n * followers list. Each write puts the server's answer into the stored object's\n * `@self`, so a list showing the same object agrees with the toggle.\n *\n * Actions: favourite, unfavourite, watch, unwatch, fetchWatchers, addWatcher, removeWatcher, markRead, markUnread.\n * Each returns the outcome `{ ok, status, data, message }` and never throws.\n *\n * @return {object} The plugin definition (name, state, getters, actions)\n *\n * @example\n * const useStore = createObjectStore('object', { plugins: [interactionsPlugin()] })\n * const store = useStore()\n * await store.watch('case', caseId)\n * const { data } = await store.fetchWatchers('case', caseId)\n */\nexport function interactionsPlugin() {\n\treturn {\n\t\tname: 'Interactions',\n\n\t\tstate: () => ({}),\n\n\t\tgetters: {},\n\n\t\tactions: {\n\t\t\t/**\n\t\t\t * Merge a patch into the stored object's `@self`.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @param {object} patch Keys to merge into `@self`\n\t\t\t */\n\t\t\t_patchSelf(type, objectId, patch) {\n\t\t\t\tconst stored = this.objects && this.objects[type] && this.objects[type][objectId]\n\t\t\t\tif (!stored) {\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t\tconst next = { ...stored, '@self': { ...(stored['@self'] || {}), ...patch } }\n\t\t\t\tthis.objects = { ...this.objects, [type]: { ...this.objects[type], [objectId]: next } }\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Resolve a type slug to its register and schema.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @return {{register: string, schema: string}} The path segments\n\t\t\t */\n\t\t\t_interactionTarget(type) {\n\t\t\t\tconst config = this._getTypeConfig(type)\n\t\t\t\treturn { register: config.register, schema: config.schema }\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Star a record: a quiet follow on the server.\n\t\t\t *\n\t\t\t * @deprecated A favourite is a follow with notifications off since\n\t\t\t * OpenRegister's `merge-follow-and-favourites`; use `watch(type, id, { notify: false })`.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync favourite(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setFavourite(register, schema, objectId, true)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { favourite: true, watching: true })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Unstar a record: unfollow it.\n\t\t\t *\n\t\t\t * @deprecated Use `unwatch`.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync unfavourite(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setFavourite(register, schema, objectId, false)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { favourite: false, watching: false, watchNotify: undefined })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Mark a record read (`PUT .../read-state`).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync markRead(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setReadState(register, schema, objectId, true)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { unread: false })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Mark a record unread (`DELETE .../read-state`).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync markUnread(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setReadState(register, schema, objectId, false)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { unread: true })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Follow a record, optionally setting its notifications switch.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @param {object} [options] Options\n\t\t\t * @param {boolean} [options.notify] The notifications switch; left out, a new follow notifies\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t * @spec openspec/changes/one-follow-control/specs/record-follow/spec.md#requirement-one-follow-control-with-a-notifications-switch\n\t\t\t */\n\t\t\tasync watch(type, objectId, options = {}) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setWatching(register, schema, objectId, true, options)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tconst notify = result.data && typeof result.data.notify === 'boolean' ? result.data.notify : true\n\t\t\t\t\tthis._patchSelf(type, objectId, { watching: true, favourite: true, watchNotify: notify })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Unfollow a record.\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync unwatch(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\tconst result = await setWatching(register, schema, objectId, false)\n\t\t\t\tif (result.ok) {\n\t\t\t\t\tthis._patchSelf(type, objectId, { watching: false, favourite: false, watchNotify: undefined })\n\t\t\t\t}\n\t\t\t\treturn result\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * List the followers of a record (needs `update` on it).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @return {Promise<object>} The outcome; `data` is `{ results, total }`\n\t\t\t */\n\t\t\tasync fetchWatchers(type, objectId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\treturn listWatchers(register, schema, objectId)\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Add a colleague as a follower (needs `manage`).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @param {string} userId The colleague's user id\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync addWatcher(type, objectId, userId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\treturn setWatcher(register, schema, objectId, userId, true)\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Remove a follower (needs `manage`, or be the user yourself).\n\t\t\t *\n\t\t\t * @param {string} type The registered object type slug\n\t\t\t * @param {string} objectId The object ID\n\t\t\t * @param {string} userId The follower's user id\n\t\t\t * @return {Promise<object>} The outcome\n\t\t\t */\n\t\t\tasync removeWatcher(type, objectId, userId) {\n\t\t\t\tconst { register, schema } = this._interactionTarget(type)\n\t\t\t\treturn setWatcher(register, schema, objectId, userId, false)\n\t\t\t},\n\t\t},\n\t}\n}\n"],"names":[],"mappings":";;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,kBAAkB,GAAG;AACrC,CAAC,OAAO;AACR,EAAE,IAAI,EAAE,cAAc;AACtB;AACA,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AACnB;AACA,EAAE,OAAO,EAAE,EAAE;AACb;AACA,EAAE,OAAO,EAAE;AACX;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;AACrC,IAAI,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAC;AACrF,IAAI,IAAI,CAAC,MAAM,EAAE;AACjB,KAAK,MAAM;AACX,KAAK;AACL,IAAI,MAAM,IAAI,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,GAAE;AACjF,IAAI,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,GAAG,IAAI,EAAE,GAAE;AAC3F,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,kBAAkB,CAAC,IAAI,EAAE;AAC5B,IAAI,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAC;AAC5C,IAAI,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;AAC/D,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE;AACnC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAC;AACvE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAC;AACzE,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE;AACrC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAC;AACxE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,EAAC;AACnG,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE;AAClC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAC;AACvE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAC;AACvD,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE;AACpC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAC;AACxE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAC;AACtD,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,GAAG,EAAE,EAAE;AAC7C,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAC;AAC/E,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,KAAI;AACtG,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,EAAC;AAC9F,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE;AACjC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAC;AACvE,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE;AACnB,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,EAAC;AACnG,KAAK;AACL,IAAI,OAAO,MAAM;AACjB,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE;AACvC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC;AACnD,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE;AAC5C,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,OAAO,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC;AAC/D,IAAI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE;AAC/C,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAC;AAC9D,IAAI,OAAO,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC;AAChE,IAAI;AACJ,GAAG;AACH,EAAE;AACF;;;;"}

package/dist/esm/store/useObjectStore.js

@@ -6,6 +6,7 @@ import { parseResponseError, networkError, genericError } from '../utils/errors.
 import { normalizeFacets } from '../utils/facets.js';
 import { prefixUrl, capitalize, buildHeaders, buildQueryString } from '../utils/headers.js';
 import { extractId } from '../utils/id.js';
+import { readLensReports } from '../utils/lensAvailability.js';
 import { dispatchObjectCreated } from '../utils/walkthroughSignals.js';
 import { mergePluginState, mergePluginGetters, mergePluginActions } from './pluginMerge.js';
 import { liveUpdatesPlugin } from './plugins/liveUpdates.js';
@@ -86,6 +87,16 @@ function baseState(baseUrl = DEFAULT_BASE_URL) {
 		 * @type {{string: object}}
 		 */
 		facets: {},
+		/**
+		 * Personal-lens reports of the latest collection response per type:
+		 * the body's `@self.lenses` (`{ recent: { available, reason } }`),
+		 * `{}` when it carried none. Written with the rows, so it always
+		 * describes the page on screen.
+		 *
+		 * @type {{string: object}}
+		 * @spec openspec/changes/lens-says-why-it-is-empty/specs/personal-lens-availability/spec.md#requirement-a-list-response-carries-the-report-of-the-lenses-it-was-asked-for
+		 */
+		lenses: {},
 		/** @type {{baseUrl: string, organisationUuidGetter: (() => string|null)|null, languageGetter: (() => string|null)|null, targetLanguageGetter: (() => string|null)|null}} */
 		_options: {
 			baseUrl: prefixedBaseUrl,
@@ -195,6 +206,7 @@ const baseGetters = {
 	 * @return {(type: string) => object}
 	 */
 	getFacets: (state) => (type) => state.facets[type] || {},
+	getLenses: (state) => (type) => state.lenses[type] || {},
 };
 
 // ── Base actions ────────────────────────────────────────────────────────
@@ -265,6 +277,7 @@ const baseActions = {
 		this.schemas = { ...this.schemas, [slug]: null };
 		this.registers = { ...this.registers, [slug]: null };
 		this.facets = { ...this.facets, [slug]: {} };
+		this.lenses = { ...this.lenses, [slug]: {} };
 	},
 
 	/**
@@ -308,6 +321,7 @@ const baseActions = {
 		this.schemas = omit(this.schemas, slug);
 		this.registers = omit(this.registers, slug);
 		this.facets = omit(this.facets, slug);
+		this.lenses = omit(this.lenses, slug);
 	},
 
 	/**
@@ -441,6 +455,7 @@ const baseActions = {
 		this.collections = {};
 		this.objects = {};
 		this.facets = {};
+		this.lenses = {};
 		this.pagination = {};
 		// Errors + loading flags are per-fetch and don't need a reset.
 	},
@@ -737,6 +752,8 @@ const baseActions = {
 			const results = data.results || data;
 
 			this.collections = { ...this.collections, [type]: results };
+			// Why a personal lens came back empty, if it says (openregister#4514).
+			this.lenses = { ...this.lenses, [type]: readLensReports(data) };
 			this.pagination = {
 				...this.pagination,
 				[type]: {