@dxos/react-ui-attention 0.8.4-main.c85a9c8dae → 0.8.4-main.d05673bc65

package/dist/types/src/attention.d.ts

@@ -2,6 +2,7 @@ import { Atom, type Registry } from '@effect-atom/atom-react';
 import { type Attention } from './types';
 /**
  * Manages attention state for an application.
+ * Attention keys are slash-qualified graph IDs; ancestry is derived from progressive prefixes.
  */
 export declare class AttentionManager {
     private readonly _registry;
@@ -9,34 +10,35 @@ export declare class AttentionManager {
     private readonly _currentAtom;
     constructor(_registry: Registry.Registry, initial?: string[]);
     /**
-     * Atom for the currently attended element path.
+     * Atom for the currently attended element IDs.
      */
     get current(): Atom.Atom<string[]>;
     /**
-     * Gets the currently attended element path.
+     * Gets the currently attended element IDs.
      */
     getCurrent(): readonly string[];
     /**
-     * Subscribe to changes in the current attention path.
+     * Subscribe to changes in the current attention IDs.
      */
     subscribeCurrent(cb: (current: readonly string[]) => void): () => void;
     /**
-     * All attention paths.
+     * All tracked qualified IDs.
      */
-    keys(): string[][];
+    keys(): string[];
     /**
-     * Get the attention state for a given path.
+     * Get the attention state for a given qualified ID.
      */
-    get(key: string[]): Attention;
+    get(id: string): Attention;
     /**
-     * Subscribe to changes in the attention state for a given path.
+     * Subscribe to changes in the attention state for a given qualified ID.
      */
-    subscribe(key: string[], cb: (attention: Attention) => void): () => void;
+    subscribe(id: string, cb: (attention: Attention) => void): () => void;
     private _getAtom;
     private _set;
 }
 /**
- * Accumulates all attendable id's between the element provided and the root, inclusive.
+ * Accumulates all attendable IDs between the element provided and the root, inclusive.
+ * Each `data-attendable-id` value is treated as a single qualified ID (no splitting).
  */
 export declare const getAttendables: (selector: string, cursor: Element, acc?: string[]) => string[];
 export type AttendableId = {
@@ -45,4 +47,21 @@ export type AttendableId = {
 export type Related = {
     related?: boolean;
 };
+/**
+ * Decompose a qualified graph ID into progressive prefixes for ancestry tracking.
+ * e.g. `root/a/b/c` yields `['root', 'root/a', 'root/a/b', 'root/a/b/c']`.
+ */
+export declare const expandAttendableId: (qualifiedId: string) => string[];
+/**
+ * Whether the last segment of a qualified ID starts with the attendable path separator.
+ */
+export declare const isSeparatorPrefixed: (qualifiedId: string) => boolean;
+/**
+ * Get the parent qualified ID (everything before the last `/` segment).
+ */
+export declare const getParentId: (qualifiedId: string | undefined) => string | undefined;
+/**
+ * Extract the segment ID (last segment) of a qualified ID.
+ */
+export declare const getSegmentId: (qualifiedId: string) => string;
 //# sourceMappingURL=attention.d.ts.map

package/dist/types/src/attention.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"attention.d.ts","sourceRoot":"","sources":["../../../src/attention.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAI9D,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAKpE;;GAEG;AACH,qBAAa,gBAAgB;IAOzB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAJ5B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiE;IACtF,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0B;gBAGpC,SAAS,EAAE,QAAQ,CAAC,QAAQ,EAC7C,OAAO,GAAE,MAAM,EAAO;IAQxB;;OAEG;IACH,IAAI,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAEjC;IAED;;OAEG;IACH,UAAU,IAAI,SAAS,MAAM,EAAE;IAI/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI;IAOtE;;OAEG;IACH,IAAI,IAAI,MAAM,EAAE,EAAE;IAIlB;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,SAAS;IAK7B;;OAEG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,GAAG,MAAM,IAAI;IAQxE,OAAO,CAAC,QAAQ;IA8ChB,OAAO,CAAC,IAAI;CAQb;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,EAAE,QAAQ,OAAO,EAAE,MAAK,MAAM,EAAO,KAAG,MAAM,EAqB5F,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAAE,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAErD,MAAM,MAAM,OAAO,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC"}
+{"version":3,"file":"attention.d.ts","sourceRoot":"","sources":["../../../src/attention.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAE9D,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpE;;;GAGG;AACH,qBAAa,gBAAgB;IAKzB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAJ5B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA+C;IACpE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0B;gBAGpC,SAAS,EAAE,QAAQ,CAAC,QAAQ,EAC7C,OAAO,GAAE,MAAM,EAAO;IAQxB;;OAEG;IACH,IAAI,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAEjC;IAED;;OAEG;IACH,UAAU,IAAI,SAAS,MAAM,EAAE;IAI/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI;IAOtE;;OAEG;IACH,IAAI,IAAI,MAAM,EAAE;IAIhB;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS;IAK1B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,GAAG,MAAM,IAAI;IAQrE,OAAO,CAAC,QAAQ;IAuEhB,OAAO,CAAC,IAAI;CAQb;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,EAAE,QAAQ,OAAO,EAAE,MAAK,MAAM,EAAO,KAAG,MAAM,EAoB5F,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAAE,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAErD,MAAM,MAAM,OAAO,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,aAAa,MAAM,KAAG,MAAM,EAG9D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAa,MAAM,KAAG,OAGzD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,aAAa,MAAM,GAAG,SAAS,KAAG,MAAM,GAAG,SAOtE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,aAAa,MAAM,KAAG,MAElD,CAAC"}

package/dist/types/src/components/AttentionProvider.d.ts

@@ -7,33 +7,31 @@ declare const ATTENDABLE_ATTRIBUTE = "data-attendable-id";
 declare const ATTENTION_SOURCE_ATTRIBUTE = "data-w-attention-source";
 type AttentionContextValue = {
     attention: AttentionManager;
-    path: string[];
 };
 declare const useAttentionContext: (consumerName: string) => AttentionContextValue;
+/**
+ * Subscribe to the attention state for a qualified graph ID.
+ */
 declare const useAttention: (attendableId?: string) => Attention;
 declare const useAttended: () => readonly string[];
 /**
  * Computes HTML element attributes to apply so the attention system can detect changes.
- * @param attendableId
  */
 declare const useAttentionAttributes: (attendableId?: string) => Record<string, string | undefined>;
-declare const useAttentionPath: () => string[];
 declare const RootAttentionProvider: ({ children, attention: propsAttention, onChange, }: PropsWithChildren<Partial<{
     attention: AttentionManager;
     onChange: (nextAttended: string[]) => void;
 }>>) => React.JSX.Element;
-declare const AttentionProvider: ({ id, children }: PropsWithChildren<{
-    id: string;
-}>) => React.JSX.Element;
 export type AttendableContainerProps = ThemedClassName<ComponentPropsWithRef<'div'> & {
     id: string;
     asChild?: boolean;
 }>;
 /**
- * Note that DeckPlugin and StackPlugin both handle attention on their own, and when rendering content in those cases it
- * is not necessary to also render an `AttendableContainer`. This component is primarily for Storybook stories and other
- * testing scenarios, or the rare cases where an attendable entity is rendered outside of either of those plugins.
+ * Note that DeckPlugin and StackPlugin both handle attention on their own,
+ * and when rendering content in those cases it is not necessary to also render an `AttendableContainer`.
+ * This component is primarily for Storybook stories and other testing scenarios,
+ * or the rare cases where an attendable entity is rendered outside of either of those plugins.
  */
 declare const AttendableContainer: React.ForwardRefExoticComponent<Omit<AttendableContainerProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
-export { RootAttentionProvider, AttentionProvider, AttendableContainer, useAttentionContext, useAttention, useAttended, useAttentionAttributes, useAttentionPath, ATTENTION_NAME, ATTENDABLE_ATTRIBUTE, ATTENTION_SOURCE_ATTRIBUTE, };
+export { RootAttentionProvider, AttendableContainer, useAttentionContext, useAttention, useAttended, useAttentionAttributes, ATTENTION_NAME, ATTENDABLE_ATTRIBUTE, ATTENTION_SOURCE_ATTRIBUTE, };
 //# sourceMappingURL=AttentionProvider.d.ts.map

package/dist/types/src/components/AttentionProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AttentionProvider.d.ts","sourceRoot":"","sources":["../../../../src/components/AttentionProvider.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,EACZ,KAAK,qBAAqB,EAE1B,KAAK,iBAAiB,EAMvB,MAAM,OAAO,CAAC;AAIf,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,OAAO,EAAE,gBAAgB,EAAkB,MAAM,cAAc,CAAC;AAChE,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC;AAErE,QAAA,MAAM,cAAc,cAAc,CAAC;AACnC,QAAA,MAAM,oBAAoB,uBAAuB,CAAC;AAClD,QAAA,MAAM,0BAA0B,4BAA4B,CAAC;AAE7D,KAAK,qBAAqB,GAAG;IAC3B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF,QAAA,MAAiC,mBAAmB,iDAGlD,CAAC;AAIH,QAAA,MAAM,YAAY,GAAI,eAAe,MAAM,KAAG,SA2B7C,CAAC;AAEF,QAAA,MAAM,WAAW,yBAmBhB,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,sBAAsB,GAAI,eAAe,MAAM,uCAUpD,CAAC;AAEF,QAAA,MAAM,gBAAgB,gBAGrB,CAAC;AAEF,QAAA,MAAM,qBAAqB,GAAI,oDAI5B,iBAAiB,CAClB,OAAO,CAAC;IACN,SAAS,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;CAC5C,CAAC,CACH,sBAgCA,CAAC;AAEF,QAAA,MAAM,iBAAiB,GAAI,kBAAkB,iBAAiB,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,sBAS7E,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,CACpD,qBAAqB,CAAC,KAAK,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CACjE,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,mBAAmB,8GAgBxB,CAAC;AAEF,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACZ,WAAW,EACX,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,0BAA0B,GAC3B,CAAC"}
+{"version":3,"file":"AttentionProvider.d.ts","sourceRoot":"","sources":["../../../../src/components/AttentionProvider.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,EACZ,KAAK,qBAAqB,EAE1B,KAAK,iBAAiB,EAMvB,MAAM,OAAO,CAAC;AAIf,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,OAAO,EAAE,gBAAgB,EAAkB,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C,QAAA,MAAM,cAAc,cAAc,CAAC;AACnC,QAAA,MAAM,oBAAoB,uBAAuB,CAAC;AAClD,QAAA,MAAM,0BAA0B,4BAA4B,CAAC;AAE7D,KAAK,qBAAqB,GAAG;IAC3B,SAAS,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,QAAA,MAAiC,mBAAmB,iDAElD,CAAC;AAIH;;GAEG;AACH,QAAA,MAAM,YAAY,GAAI,eAAe,MAAM,KAAG,SAmB7C,CAAC;AAEF,QAAA,MAAM,WAAW,yBAiBhB,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,sBAAsB,GAAI,eAAe,MAAM,uCAUpD,CAAC;AAEF,QAAA,MAAM,qBAAqB,GAAI,oDAI5B,iBAAiB,CAClB,OAAO,CAAC;IACN,SAAS,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;CAC5C,CAAC,CACH,sBAgCA,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,CACpD,qBAAqB,CAAC,KAAK,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CACjE,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,mBAAmB,8GAgBxB,CAAC;AAEF,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACZ,WAAW,EACX,sBAAsB,EACtB,cAAc,EACd,oBAAoB,EACpB,0BAA0B,GAC3B,CAAC"}