@dxos/react-ui-form 0.11.1 → 1.0.0-next-bbabc02363f18d7643ea4160e3a7a7809870fd0d

package/dist/lib/index.mjs

@@ -12,6 +12,7 @@ import * as Schema from "effect/Schema";
 import * as SchemaAST from "effect/SchemaAST";
 import { SchemaEx } from "@dxos/effect";
 import { DEFAULT_LAYOUT_NAME, FormLayoutAnnotation, ReferenceAnnotationId as ReferenceAnnotationId$1 } from "@dxos/echo/Annotation";
+import { DXN as DXN$1, EID as EID$1, PublicKey, URI } from "@dxos/keys";
 import { MarkdownView } from "@dxos/react-ui-markdown";
 import { getHashHue, getStyles, mx, osTranslations, tv } from "@dxos/ui-theme";
 import * as Cause from "effect/Cause";
@@ -22,7 +23,6 @@ import * as Equal from "effect/Equal";
 import * as Utils from "effect/Utils";
 import { addEventListener } from "@dxos/async";
 import { useObject, useQuery, useType } from "@dxos/echo-react";
-import { DXN as DXN$1, EID as EID$1, PublicKey, URI } from "@dxos/keys";
 import { Combobox, OrderedList } from "@dxos/react-ui-list";
 import { arrayMove, safeParseFloat } from "@dxos/util";
 import * as Match from "effect/Match";
@@ -266,6 +266,62 @@ var META_TAGS_KEY = "_tags";
 * `tags` field the schema declares itself.
 */
 var withMetaTags = (schema) => omitId(Schema.Struct({ [META_TAGS_KEY]: Schema.Array(Ref.Ref(Tag.Tag)).pipe(Schema.annotations({ title: "Tags" }), Schema.optional) }).pipe(Schema.extend(schema)));
+var isTag = Obj.instanceOf(Tag.Tag);
+/**
+* Narrows a tag picker's candidates to the tags a user may apply by hand: those with no origin.
+*
+* A tag that carries an origin is owned by whoever put it there — a Gmail label or a JMAP folder is
+* sync's to apply, and a canonical DXOS tag (`starred`, `sent`, `draft`) is applied by a purpose-built
+* affordance such as the star button or the draft lifecycle. Offering either in a generic picker
+* invites an attribution that nothing maintains: on a synced object the next delta silently strips it,
+* and on an unsynced one it never gets corrected at all. See `Tag.md` §"Tag origin".
+*
+* Non-tag candidates pass through untouched, so this is safe to apply to any ref field's results —
+* hence generic in the element type rather than narrowed to `Entity.Any`, which concrete instances are
+* deliberately not assignable to.
+*/
+var filterTagCandidates = (results) => results.filter((result) => !isTag(result) || Tag.isUserTag(result));
+/**
+* A ref's target entity id, ignoring whether the uri is local (`echo:/<id>`) or qualified
+* (`echo://<space>/<id>`) — `Ref.make` produces the former while `Obj.getURI` produces the latter, so
+* the two forms must compare equal. Same reason as `findRefOption`.
+*/
+var entityIdOf = (uri) => {
+	const parsed = EID$1.tryParse(uri);
+	return parsed ? EID$1.getEntityId(parsed) : void 0;
+};
+/**
+* Splits an object's meta tags into the ones a form may edit and the ones a provider owns.
+*
+* Provider-owned tags are held back rather than shown read-only: the tags field is a generic array of
+* refs whose delete affordance knows nothing about tags, so the only way to make one non-removable
+* would be to thread tag-specific policy through a type-agnostic renderer. Holding them out of the
+* form value instead keeps them off the picker *and* out of reach of the delete button, and matches
+* where they are already surfaced — as chips on the object's own views.
+*
+* The caller must write `preserved` back alongside whatever the form returns: `meta.tags` is replaced
+* wholesale on save, so omitting them would delete the object's provider tags on the first edit.
+*
+* `candidates` is the space's tag set (each tag's origin lives on the tag, not on the ref); non-tag
+* entries are ignored, so a caller may pass a broader query result.
+*/
+var partitionMetaTags = (refs, candidates) => {
+	const providerIds = /* @__PURE__ */ new Set();
+	for (const candidate of candidates) if (isTag(candidate) && Tag.isProviderTag(candidate)) {
+		const id = entityIdOf(Obj.getURI(candidate).toString());
+		if (id !== void 0) providerIds.add(id);
+	}
+	const editable = [];
+	const preserved = [];
+	for (const ref of refs) {
+		const id = entityIdOf(ref.uri);
+		(id !== void 0 && providerIds.has(id) ? preserved : editable).push(ref);
+	}
+	return {
+		editable,
+		preserved
+	};
+};
 //#endregion
 //#region src/hooks/useAsyncFieldEffect.ts
 /** Picks the declared dependency fields from the form values — the subset a dynamic field subscribes to. */
@@ -666,7 +722,7 @@ var formTheme = {
 			sectionDescription: "text-description",
 			fieldSet: "",
 			field: "",
-			fieldLabel: "min-h-(--dx-control) grid grid-cols-[1fr_auto_auto_auto] items-center select-none",
+			fieldLabel: "min-h-(--dx-control) grid grid-cols-[1fr_auto_auto_auto] items-center",
 			fieldLabelText: "",
 			fieldDescription: "text-description",
 			fieldControl: "",
@@ -2016,7 +2072,11 @@ var defaultGetOptions = (results, { parentLabel, getTypePlaceholder } = {}) => r
 		label: Entity.getLabel(labelEntity) ?? (typename ? getTypePlaceholder?.(typename) : void 0) ?? id
 	};
 });
-var defaultUseResults = (db, typename) => useQuery(db, !typename ? Query.select(Filter.nothing()) : typename === ANY_OBJECT_TYPENAME ? Query.select(Filter.everything()) : Query.select(Filter.type(DXN$1.make(typename))).from(Scope.space(), Scope.registry()));
+var defaultUseResults = (db, typename) => {
+	const results = useQuery(db, !typename ? Query.select(Filter.nothing()) : typename === ANY_OBJECT_TYPENAME ? Query.select(Filter.everything()) : Query.select(Filter.type(DXN$1.make(typename))).from(Scope.space(), Scope.registry()));
+	const isTagField = typename === Type.getTypename(Tag.Tag);
+	return useMemo(() => isTagField ? filterTagCandidates(results) : results, [isTagField, results]);
+};
 var RefField = (props) => {
 	const { type, readonly, label, jsonPath, placeholder, presentation, required, getStatus, getValue, createOptionLabel, createOptionIcon, createInitialValuePath, createFieldMap, db, useType: useType$3 = useType, useResults = defaultUseResults, getOptions = defaultGetOptions, onCreate, resolveCreateEntry, onValueChange } = props;
 	const { t } = useTranslation(translationKey);
@@ -3159,7 +3219,9 @@ var __dxlog_file$2 = "/__w/dxos/dxos/packages/ui/react-ui-form/src/components/Ob
 var ObjectForm = ({ object, type, schema, showTags = true }) => {
 	const db = Obj.getDatabase(object);
 	const [snapshot] = useObject(object);
-	const tags = [...Obj.getMeta(object).tags];
+	const meta = Obj.getMeta(object);
+	const spaceTags = useQuery(db, Filter.type(Tag.Tag));
+	const { editable: tags, preserved: preservedTags } = useMemo(() => partitionMetaTags([...meta.tags], spaceTags), [meta.tags, spaceTags]);
 	const values = useMemo(() => ({
 		[META_TAGS_KEY]: tags,
 		...snapshot
@@ -3176,14 +3238,14 @@ var ObjectForm = ({ object, type, schema, showTags = true }) => {
 		invariant(db, void 0, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$2,
-			L: 49,
+			L: 54,
 			S: void 0,
 			A: ["db", ""]
 		});
 		invariant(Type.isObject(type), void 0, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$2,
-			L: 50,
+			L: 55,
 			S: void 0,
 			A: ["Type.isObject(type)", ""]
 		});
@@ -3196,7 +3258,8 @@ var ObjectForm = ({ object, type, schema, showTags = true }) => {
 		if (!isValid) return;
 		const changedPaths = Object.keys(changed).filter((path) => changed[path]);
 		if (changedPaths.some((path) => SchemaEx.splitJsonPath(path)[0] === "_tags")) Obj.update(object, (object) => {
-			Obj.getMeta(object).tags = Array.isArray(metaTags) ? [...metaTags] : [];
+			const edited = Array.isArray(metaTags) ? metaTags : [];
+			Obj.getMeta(object).tags = [...preservedTags, ...edited];
 		});
 		const nonTagPaths = changedPaths.filter((path) => SchemaEx.splitJsonPath(path)[0] !== META_TAGS_KEY);
 		if (nonTagPaths.length > 0) Obj.update(object, () => {
@@ -3206,7 +3269,7 @@ var ObjectForm = ({ object, type, schema, showTags = true }) => {
 				Obj.setValue(object, parts, value);
 			}
 		});
-	}, [object]);
+	}, [object, preservedTags]);
 	return /* @__PURE__ */ jsx(Form.Root, {
 		schema: formSchema,
 		values,
@@ -3235,7 +3298,9 @@ var createFieldMap$1 = { hue: ({ type, label, presentation, getValue, onValueCha
 var __dxlog_file$1 = "/__w/dxos/dxos/packages/ui/react-ui-form/src/components/ObjectProperties/ObjectProperties.tsx";
 var ObjectProperties = composable(({ children, object, getCreateDefaults, resolveCreateEntry, ...props }, forwardedRef) => {
 	const db = Obj.getDatabase(object);
-	const tags = [...Obj.getMeta(object).tags];
+	const meta = Obj.getMeta(object);
+	const spaceTags = useQuery(db, Filter.type(Tag.Tag));
+	const { editable: tags, preserved: preservedTags } = useMemo(() => partitionMetaTags([...meta.tags], spaceTags), [meta.tags, spaceTags]);
 	const values = useMemo(() => ({
 		[META_TAGS_KEY]: tags,
 		...object
@@ -3249,14 +3314,14 @@ var ObjectProperties = composable(({ children, object, getCreateDefaults, resolv
 		invariant(db, void 0, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$1,
-			L: 69,
+			L: 74,
 			S: void 0,
 			A: ["db", ""]
 		});
 		invariant(Type.isObject(type), void 0, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$1,
-			L: 70,
+			L: 75,
 			S: void 0,
 			A: ["Type.isObject(type)", ""]
 		});
@@ -3268,7 +3333,8 @@ var ObjectProperties = composable(({ children, object, getCreateDefaults, resolv
 		if (!isValid) return;
 		const changedPaths = Object.keys(changed).filter((path) => changed[path]);
 		if (changedPaths.some((path) => SchemaEx.splitJsonPath(path)[0] === "_tags")) Obj.update(object, (object) => {
-			Obj.getMeta(object).tags = Array.isArray(metaTags) ? [...metaTags] : [];
+			const edited = Array.isArray(metaTags) ? metaTags : [];
+			Obj.getMeta(object).tags = [...preservedTags, ...edited];
 		});
 		const nonTagPaths = changedPaths.filter((path) => SchemaEx.splitJsonPath(path)[0] !== META_TAGS_KEY);
 		if (nonTagPaths.length > 0) Obj.update(object, () => {
@@ -3278,7 +3344,7 @@ var ObjectProperties = composable(({ children, object, getCreateDefaults, resolv
 				Obj.setValue(object, parts, value);
 			}
 		});
-	}, [object]);
+	}, [object, preservedTags]);
 	if (!formSchema) return null;
 	return /* @__PURE__ */ jsx(Form.Root, {
 		db,
@@ -3897,8 +3963,10 @@ var ViewEditor = forwardRef(({ classNames, type, view, mode = "schema", registry
 			children: /* @__PURE__ */ jsx(Form.Viewport, { children: /* @__PURE__ */ jsxs(Form.Content, { children: [
 				schemaReadonly && !readonly && /* @__PURE__ */ jsx(Message.Root, {
 					valence: "info",
-					classNames: "my-form-padding",
-					children: /* @__PURE__ */ jsx(Message.Title, { children: t("system-schema.description") })
+					children: /* @__PURE__ */ jsx(Message.Content, {
+						classNames: "my-form-padding",
+						children: /* @__PURE__ */ jsx(Message.Title, { children: t("system-schema.description") })
+					})
 				}),
 				/* @__PURE__ */ jsx(Form.FieldSet, {}),
 				type && /* @__PURE__ */ jsx(FieldList, {
@@ -3949,7 +4017,7 @@ var FieldList = ({ type, view, registry, readonly, showHeading = false, onDelete
 		invariant(!readonly, void 0, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file,
-			L: 290,
+			L: 292,
 			S: void 0,
 			A: ["!readonly", ""]
 		});
@@ -3960,7 +4028,7 @@ var FieldList = ({ type, view, registry, readonly, showHeading = false, onDelete
 		invariant(!readonly, void 0, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file,
-			L: 297,
+			L: 299,
 			S: void 0,
 			A: ["!readonly", ""]
 		});
@@ -3975,7 +4043,7 @@ var FieldList = ({ type, view, registry, readonly, showHeading = false, onDelete
 		invariant(!readonly, void 0, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file,
-			L: 309,
+			L: 311,
 			S: void 0,
 			A: ["!readonly", ""]
 		});
@@ -4059,6 +4127,6 @@ var FieldList = ({ type, view, registry, readonly, showHeading = false, onDelete
 	});
 };
 //#endregion
-export { ArrayField, AsyncSelectField, AutofillAnnotation, AutofillAnnotationId, AutofillField, BooleanField, ComboboxField, CompactIconButton, DateField, EMAIL_REGEX, FieldEditor, Form, FormContextProvider, FormField, FormFieldErrorBoundary, FormFieldHeader, FormFieldLabel, FormFieldSet, FormFieldSetContainer, FormRow, GeoPointField, InlineRefField, META_TAGS_KEY, MarkdownField, NAME_ADDR_REGEX, NumberField, ObjectForm, ObjectPicker, ObjectProperties, ObjectTree, OptionsLookupAnnotation, OptionsLookupAnnotationId, PasswordField, REF_REGEX, RefEditor, RefField, SelectField, SelectOptionField, TextAreaField, TextField, TupleField, ViewEditor, autofill, cellClassesForFieldType, createSelectField, findRefOption, formatMailbox, getDefaultValue, getFormProperties, getNumericConstraints, getRefProps, getRootFormProperties, omitHiddenFormFields, omitId, optionsLookup, parseValue, pathNotUniqueError, pickValues, presentationFor, refEditor, refEditorRedecorate, useAsyncFieldEffect, useFormContext, useFormFieldState, useFormHandler, useFormValues, useKeyHandler, withMetaTags };
+export { ArrayField, AsyncSelectField, AutofillAnnotation, AutofillAnnotationId, AutofillField, BooleanField, ComboboxField, CompactIconButton, DateField, EMAIL_REGEX, FieldEditor, Form, FormContextProvider, FormField, FormFieldErrorBoundary, FormFieldHeader, FormFieldLabel, FormFieldSet, FormFieldSetContainer, FormRow, GeoPointField, InlineRefField, META_TAGS_KEY, MarkdownField, NAME_ADDR_REGEX, NumberField, ObjectForm, ObjectPicker, ObjectProperties, ObjectTree, OptionsLookupAnnotation, OptionsLookupAnnotationId, PasswordField, REF_REGEX, RefEditor, RefField, SelectField, SelectOptionField, TextAreaField, TextField, TupleField, ViewEditor, autofill, cellClassesForFieldType, createSelectField, filterTagCandidates, findRefOption, formatMailbox, getDefaultValue, getFormProperties, getNumericConstraints, getRefProps, getRootFormProperties, omitHiddenFormFields, omitId, optionsLookup, parseValue, partitionMetaTags, pathNotUniqueError, pickValues, presentationFor, refEditor, refEditorRedecorate, useAsyncFieldEffect, useFormContext, useFormFieldState, useFormHandler, useFormValues, useKeyHandler, withMetaTags };
 
 //# sourceMappingURL=index.mjs.map