@conduction/nextcloud-vue 2.61.0 → 2.63.0

package/dist/esm/utils/walkthroughSignals.js

@@ -0,0 +1,88 @@
+/**
+ * SPDX-FileCopyrightText: 2026 Conduction B.V.
+ * SPDX-License-Identifier: EUPL-1.2
+ *
+ * Signals the walkthrough listens for.
+ *
+ * A step with `advanceOn: { type: 'object-created', register, schema }`
+ * advances when a `cn-walkthrough:object-created` window event arrives for
+ * that register and schema. Every create path in the library calls
+ * {@link dispatchObjectCreated}: the object store's save, the index page's
+ * create override, and the related list's create form.
+ *
+ * @module utils/walkthroughSignals
+ */
+
+const OBJECT_CREATED_EVENT = 'cn-walkthrough:object-created';
+
+/**
+ * Ids announced in the last few seconds. One save can pass through two
+ * layers (a page's create override that itself calls the store), and one
+ * create must advance a tour by one step, not two.
+ *
+ * @type {Map<string, number>}
+ */
+const recent = new Map();
+const DEDUPE_MS = 2000;
+
+/**
+ * The id of an OpenRegister object, whatever shape the response has.
+ *
+ * @param {object} object The created object.
+ * @return {string} The id, or ''.
+ */
+function idOf(object) {
+	if (!object || typeof object !== 'object') {
+		return ''
+	}
+	const self = object['@self'] || {};
+	return String(object.id || object.uuid || self.id || self.uuid || '')
+}
+
+/**
+ * Announce that an object was created.
+ *
+ * `register` and `schema` are the slugs the creating surface knows. An
+ * object's own `@self.register` / `@self.schema` are numeric ids on
+ * OpenRegister, which a manifest's `advanceOn` never uses.
+ *
+ * @spec openspec/changes/walkthrough-advance-pause-resume/specs/cn-walkthrough/spec.md
+ * @param {object} payload What was created.
+ * @param {string|number} [payload.register] The register slug (or id).
+ * @param {string|number} [payload.schema] The schema slug (or id).
+ * @param {object} payload.object The created object.
+ * @return {boolean} True when the event was dispatched (false for a duplicate or no window).
+ */
+function dispatchObjectCreated({ register, schema, object } = {}) {
+	if (typeof window === 'undefined' || !object || typeof object !== 'object') {
+		return false
+	}
+	const id = idOf(object);
+	const now = Date.now();
+	for (const [key, at] of recent) {
+		if (now - at > DEDUPE_MS) {
+			recent.delete(key);
+		}
+	}
+	if (id) {
+		if (recent.has(id)) {
+			return false
+		}
+		recent.set(id, now);
+	}
+	const detail = {
+		...object,
+		register: register !== undefined && register !== null && register !== '' ? register : object.register,
+		schema: schema !== undefined && schema !== null && schema !== '' ? schema : object.schema,
+		object,
+	};
+	try {
+		window.dispatchEvent(new CustomEvent(OBJECT_CREATED_EVENT, { detail }));
+	} catch {
+		return false
+	}
+	return true
+}
+
+export { OBJECT_CREATED_EVENT, dispatchObjectCreated };
+//# sourceMappingURL=walkthroughSignals.js.map

package/dist/esm/utils/walkthroughSignals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"walkthroughSignals.js","sources":["../../../src/utils/walkthroughSignals.js"],"sourcesContent":["/**\n * SPDX-FileCopyrightText: 2026 Conduction B.V.\n * SPDX-License-Identifier: EUPL-1.2\n *\n * Signals the walkthrough listens for.\n *\n * A step with `advanceOn: { type: 'object-created', register, schema }`\n * advances when a `cn-walkthrough:object-created` window event arrives for\n * that register and schema. Every create path in the library calls\n * {@link dispatchObjectCreated}: the object store's save, the index page's\n * create override, and the related list's create form.\n *\n * @module utils/walkthroughSignals\n */\n\nexport const OBJECT_CREATED_EVENT = 'cn-walkthrough:object-created'\n\n/**\n * Ids announced in the last few seconds. One save can pass through two\n * layers (a page's create override that itself calls the store), and one\n * create must advance a tour by one step, not two.\n *\n * @type {Map<string, number>}\n */\nconst recent = new Map()\nconst DEDUPE_MS = 2000\n\n/**\n * The id of an OpenRegister object, whatever shape the response has.\n *\n * @param {object} object The created object.\n * @return {string} The id, or ''.\n */\nfunction idOf(object) {\n\tif (!object || typeof object !== 'object') {\n\t\treturn ''\n\t}\n\tconst self = object['@self'] || {}\n\treturn String(object.id || object.uuid || self.id || self.uuid || '')\n}\n\n/**\n * Announce that an object was created.\n *\n * `register` and `schema` are the slugs the creating surface knows. An\n * object's own `@self.register` / `@self.schema` are numeric ids on\n * OpenRegister, which a manifest's `advanceOn` never uses.\n *\n * @spec openspec/changes/walkthrough-advance-pause-resume/specs/cn-walkthrough/spec.md\n * @param {object} payload What was created.\n * @param {string|number} [payload.register] The register slug (or id).\n * @param {string|number} [payload.schema] The schema slug (or id).\n * @param {object} payload.object The created object.\n * @return {boolean} True when the event was dispatched (false for a duplicate or no window).\n */\nexport function dispatchObjectCreated({ register, schema, object } = {}) {\n\tif (typeof window === 'undefined' || !object || typeof object !== 'object') {\n\t\treturn false\n\t}\n\tconst id = idOf(object)\n\tconst now = Date.now()\n\tfor (const [key, at] of recent) {\n\t\tif (now - at > DEDUPE_MS) {\n\t\t\trecent.delete(key)\n\t\t}\n\t}\n\tif (id) {\n\t\tif (recent.has(id)) {\n\t\t\treturn false\n\t\t}\n\t\trecent.set(id, now)\n\t}\n\tconst detail = {\n\t\t...object,\n\t\tregister: register !== undefined && register !== null && register !== '' ? register : object.register,\n\t\tschema: schema !== undefined && schema !== null && schema !== '' ? schema : object.schema,\n\t\tobject,\n\t}\n\ttry {\n\t\twindow.dispatchEvent(new CustomEvent(OBJECT_CREATED_EVENT, { detail }))\n\t} catch {\n\t\treturn false\n\t}\n\treturn true\n}\n\n/**\n * Test-only: forget the recently announced ids.\n *\n * @internal\n */\nexport function __resetObjectCreatedDedupeForTests() {\n\trecent.clear()\n}\n"],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,oBAAoB,GAAG,gCAA+B;AACnE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,MAAM,GAAG,IAAI,GAAG,GAAE;AACxB,MAAM,SAAS,GAAG,KAAI;AACtB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,IAAI,CAAC,MAAM,EAAE;AACtB,CAAC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;AAC5C,EAAE,OAAO,EAAE;AACX,EAAE;AACF,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,GAAE;AACnC,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;AACtE,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,qBAAqB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE;AACzE,CAAC,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;AAC7E,EAAE,OAAO,KAAK;AACd,EAAE;AACF,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAC;AACxB,CAAC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,GAAE;AACvB,CAAC,KAAK,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,EAAE;AACjC,EAAE,IAAI,GAAG,GAAG,EAAE,GAAG,SAAS,EAAE;AAC5B,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAC;AACrB,GAAG;AACH,EAAE;AACF,CAAC,IAAI,EAAE,EAAE;AACT,EAAE,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;AACtB,GAAG,OAAO,KAAK;AACf,GAAG;AACH,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,EAAC;AACrB,EAAE;AACF,CAAC,MAAM,MAAM,GAAG;AAChB,EAAE,GAAG,MAAM;AACX,EAAE,QAAQ,EAAE,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,EAAE,GAAG,QAAQ,GAAG,MAAM,CAAC,QAAQ;AACvG,EAAE,MAAM,EAAE,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM;AAC3F,EAAE,MAAM;AACR,GAAE;AACF,CAAC,IAAI;AACL,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,CAAC,EAAC;AACzE,EAAE,CAAC,MAAM;AACT,EAAE,OAAO,KAAK;AACd,EAAE;AACF,CAAC,OAAO,IAAI;AACZ;;;;"}