@plurid/plurid-react 0.0.0-35 → 0.0.0-36

package/distribution/index.d.mts

@@ -4,7 +4,7 @@ import * as _plurid_plurid_themes from '@plurid/plurid-themes';
 import _plurid_plurid_themes__default, { Theme } from '@plurid/plurid-themes';
 export { Theme } from '@plurid/plurid-themes';
 import * as _plurid_plurid_data from '@plurid/plurid-data';
-import { PluridConfiguration, InternationalizationLanguageType, SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, TOOLBAR_DRAWERS, TreePlane, PlaneLink, SpaceTransform, PluridStateSpace, LinkCoordinates, PluridPlaneComponentProperty, PluridRouteComponentProperty, ComponentWithPlurid, PluridPlane, PluridRoute, PluridRoutePlane, IsoMatcherRouteResult, PluridPartialConfiguration, PluridLink, PluridRouterProperties, RegisteredPluridPlane, PluridApplication as PluridApplication$1, PluridMetastate, SpaceLocation, PluridApplicationView, LAYOUT_TYPES } from '@plurid/plurid-data';
+import { PluridConfiguration, InternationalizationLanguageType, SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, TOOLBAR_DRAWERS, TreePlane, PlaneLink, SpaceTransform, PluridStateSpace, LinkCoordinates, PluridPlaneComponentProperty, PluridRouteComponentProperty, ComponentWithPlurid, PluridPlane, PluridRoute, PluridRoutePlane, IsoMatcherRouteResult, PluridPartialConfiguration, PluridLink, PluridRouterProperties, RegisteredPluridPlane, PluridApplication as PluridApplication$1, PluridMetastate, SpaceLocation, PluridApplicationView, TreePlaneLocation, LAYOUT_TYPES } from '@plurid/plurid-data';
 export { ComponentWithPlurid, FlatPluridConfiguration, PLURID_PUBSUB_TOPIC, PLURID_ROUTER_LOCATION_CHANGED, PLURID_ROUTER_LOCATION_STORED, PluridApi, PluridConfiguration, PluridPartialConfiguration, PluridPlane, PluridPlaneComponentProperty, PluridPreserve, PluridPreserveTransmission, PluridPubSubPublishMessage, PluridPubSubSubscribeMessage, PluridRoute, PluridRouteComponentProperty, PluridRoutePlane, PluridRouteSpace, PluridRouteUniverse, PluridRouterProperties, PluridStorageAdapter, PluridStore, PluridUniverse, PluridView, RecursivePartial, SIZES, LAYOUT_TYPES as SPACE_LAYOUT, TRANSFORM_MODES, TRANSFORM_TOUCHES } from '@plurid/plurid-data';
 import * as react_redux from 'react-redux';
 import * as React$1 from 'react';
@@ -1196,6 +1196,66 @@ declare const encodeViewpoint: (transform: SpaceTransform) => string;
  */
 declare const decodeViewpoint: (encoded: string | null | undefined) => SpaceTransform | null;
 
+type PluridPlaneIsolation = 'none' | 'self' | 'other';
+interface PluridPlaneLens {
+    /**
+     * The ID of the plane this content is rendered inside;
+     * `undefined` outside plane content (route exterior, shell, overlays).
+     */
+    planeID: string | undefined;
+    /**
+     * Hover-derived: this plane is the space's active plane.
+     */
+    active: boolean;
+    /**
+     * This plane is in the multi-selection working set.
+     */
+    selected: boolean;
+    /**
+     * `'self'` when this plane is the isolated one, `'other'` when another
+     * plane is isolated (this content is faded out / inert), `'none'` when
+     * no isolation is active.
+     */
+    isolation: PluridPlaneIsolation;
+    /**
+     * The plane is shown in the space (`treePlane.show !== false`).
+     */
+    shown: boolean;
+    /**
+     * The space zoom factor.
+     */
+    scale: number;
+    /**
+     * The measured view size the space computes against.
+     */
+    viewSize: {
+        width: number;
+        height: number;
+    };
+    /**
+     * The plane's spatial location - a STABLE reference that changes only
+     * when THIS plane moves (structural sharing).
+     */
+    location: TreePlaneLocation | undefined;
+}
+/**
+ * Live lens over the plane a content component is rendered inside - the
+ * substrate seam for content-heavy consumers (pause a video when the plane
+ * is not `active`, lazy-load when it becomes `shown`, pick asset quality
+ * from `scale`).
+ *
+ * Field subscriptions are per-primitive (the engine's own granular-derived
+ * pattern), so consuming content re-renders only when a consumed value
+ * actually changes - not per orbit frame.
+ *
+ * Valid only under a `PluridApplication` (react-redux throws without the
+ * engine store). Outside plane content but inside the application (route
+ * exteriors, overlays) `planeID` is `undefined` and the plane-derived
+ * fields are inert (`active`/`selected` false, `isolation` 'none',
+ * `shown` true).
+ */
+declare const usePluridPlane: () => PluridPlaneLens;
+
 declare const usePluridRouter: () => string;
 
 declare const _default: {
@@ -1437,4 +1497,4 @@ declare const Plurid: {
 };
 type PluridRouterPartialProperties = Partial<PluridRouterProperties<PluridReactComponent>>;
 
-export { PluridApplication, ConnectedPluridApplicationConfigurator as PluridApplicationConfigurator, ConnectedExternalPlane as PluridExternalPlane, ConnectedIframePlane as PluridIframePlane, ConnectedPluridLink as PluridLink, ConnectedPluridPlaneConfigurator as PluridPlaneConfigurator, PluridProvider, type PluridReactComponent, type PluridReactPlane, type PluridReactPlaneComponent, type PluridReactRoute, type PluridReactRouteComponent, type PluridReactRoutePlane, type PluridRouteMatch, PluridRouterBrowser, PluridRouterLink, type PluridRouterPartialProperties, PluridRouterStatic, ConnectedPluridVirtualList as PluridVirtualList, arrangementSignature, decodeViewpoint, Plurid as default, encodeViewpoint, getDirectPlaneMatch, internals, _default as pluridSelectors, _default$1 as pluridStateModules, serverComputeMetastate, usePluridRouter };
+export { PluridApplication, ConnectedPluridApplicationConfigurator as PluridApplicationConfigurator, ConnectedExternalPlane as PluridExternalPlane, ConnectedIframePlane as PluridIframePlane, ConnectedPluridLink as PluridLink, ConnectedPluridPlaneConfigurator as PluridPlaneConfigurator, type PluridPlaneIsolation, type PluridPlaneLens, PluridProvider, type PluridReactComponent, type PluridReactPlane, type PluridReactPlaneComponent, type PluridReactRoute, type PluridReactRouteComponent, type PluridReactRoutePlane, type PluridRouteMatch, PluridRouterBrowser, PluridRouterLink, type PluridRouterPartialProperties, PluridRouterStatic, ConnectedPluridVirtualList as PluridVirtualList, arrangementSignature, decodeViewpoint, Plurid as default, encodeViewpoint, getDirectPlaneMatch, internals, _default as pluridSelectors, _default$1 as pluridStateModules, serverComputeMetastate, usePluridPlane, usePluridRouter };

package/distribution/index.d.ts

@@ -4,7 +4,7 @@ import * as _plurid_plurid_themes from '@plurid/plurid-themes';
 import _plurid_plurid_themes__default, { Theme } from '@plurid/plurid-themes';
 export { Theme } from '@plurid/plurid-themes';
 import * as _plurid_plurid_data from '@plurid/plurid-data';
-import { PluridConfiguration, InternationalizationLanguageType, SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, TOOLBAR_DRAWERS, TreePlane, PlaneLink, SpaceTransform, PluridStateSpace, LinkCoordinates, PluridPlaneComponentProperty, PluridRouteComponentProperty, ComponentWithPlurid, PluridPlane, PluridRoute, PluridRoutePlane, IsoMatcherRouteResult, PluridPartialConfiguration, PluridLink, PluridRouterProperties, RegisteredPluridPlane, PluridApplication as PluridApplication$1, PluridMetastate, SpaceLocation, PluridApplicationView, LAYOUT_TYPES } from '@plurid/plurid-data';
+import { PluridConfiguration, InternationalizationLanguageType, SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, TOOLBAR_DRAWERS, TreePlane, PlaneLink, SpaceTransform, PluridStateSpace, LinkCoordinates, PluridPlaneComponentProperty, PluridRouteComponentProperty, ComponentWithPlurid, PluridPlane, PluridRoute, PluridRoutePlane, IsoMatcherRouteResult, PluridPartialConfiguration, PluridLink, PluridRouterProperties, RegisteredPluridPlane, PluridApplication as PluridApplication$1, PluridMetastate, SpaceLocation, PluridApplicationView, TreePlaneLocation, LAYOUT_TYPES } from '@plurid/plurid-data';
 export { ComponentWithPlurid, FlatPluridConfiguration, PLURID_PUBSUB_TOPIC, PLURID_ROUTER_LOCATION_CHANGED, PLURID_ROUTER_LOCATION_STORED, PluridApi, PluridConfiguration, PluridPartialConfiguration, PluridPlane, PluridPlaneComponentProperty, PluridPreserve, PluridPreserveTransmission, PluridPubSubPublishMessage, PluridPubSubSubscribeMessage, PluridRoute, PluridRouteComponentProperty, PluridRoutePlane, PluridRouteSpace, PluridRouteUniverse, PluridRouterProperties, PluridStorageAdapter, PluridStore, PluridUniverse, PluridView, RecursivePartial, SIZES, LAYOUT_TYPES as SPACE_LAYOUT, TRANSFORM_MODES, TRANSFORM_TOUCHES } from '@plurid/plurid-data';
 import * as react_redux from 'react-redux';
 import * as React$1 from 'react';
@@ -1196,6 +1196,66 @@ declare const encodeViewpoint: (transform: SpaceTransform) => string;
  */
 declare const decodeViewpoint: (encoded: string | null | undefined) => SpaceTransform | null;
 
+type PluridPlaneIsolation = 'none' | 'self' | 'other';
+interface PluridPlaneLens {
+    /**
+     * The ID of the plane this content is rendered inside;
+     * `undefined` outside plane content (route exterior, shell, overlays).
+     */
+    planeID: string | undefined;
+    /**
+     * Hover-derived: this plane is the space's active plane.
+     */
+    active: boolean;
+    /**
+     * This plane is in the multi-selection working set.
+     */
+    selected: boolean;
+    /**
+     * `'self'` when this plane is the isolated one, `'other'` when another
+     * plane is isolated (this content is faded out / inert), `'none'` when
+     * no isolation is active.
+     */
+    isolation: PluridPlaneIsolation;
+    /**
+     * The plane is shown in the space (`treePlane.show !== false`).
+     */
+    shown: boolean;
+    /**
+     * The space zoom factor.
+     */
+    scale: number;
+    /**
+     * The measured view size the space computes against.
+     */
+    viewSize: {
+        width: number;
+        height: number;
+    };
+    /**
+     * The plane's spatial location - a STABLE reference that changes only
+     * when THIS plane moves (structural sharing).
+     */
+    location: TreePlaneLocation | undefined;
+}
+/**
+ * Live lens over the plane a content component is rendered inside - the
+ * substrate seam for content-heavy consumers (pause a video when the plane
+ * is not `active`, lazy-load when it becomes `shown`, pick asset quality
+ * from `scale`).
+ *
+ * Field subscriptions are per-primitive (the engine's own granular-derived
+ * pattern), so consuming content re-renders only when a consumed value
+ * actually changes - not per orbit frame.
+ *
+ * Valid only under a `PluridApplication` (react-redux throws without the
+ * engine store). Outside plane content but inside the application (route
+ * exteriors, overlays) `planeID` is `undefined` and the plane-derived
+ * fields are inert (`active`/`selected` false, `isolation` 'none',
+ * `shown` true).
+ */
+declare const usePluridPlane: () => PluridPlaneLens;
+
 declare const usePluridRouter: () => string;
 
 declare const _default: {
@@ -1437,4 +1497,4 @@ declare const Plurid: {
 };
 type PluridRouterPartialProperties = Partial<PluridRouterProperties<PluridReactComponent>>;
 
-export { PluridApplication, ConnectedPluridApplicationConfigurator as PluridApplicationConfigurator, ConnectedExternalPlane as PluridExternalPlane, ConnectedIframePlane as PluridIframePlane, ConnectedPluridLink as PluridLink, ConnectedPluridPlaneConfigurator as PluridPlaneConfigurator, PluridProvider, type PluridReactComponent, type PluridReactPlane, type PluridReactPlaneComponent, type PluridReactRoute, type PluridReactRouteComponent, type PluridReactRoutePlane, type PluridRouteMatch, PluridRouterBrowser, PluridRouterLink, type PluridRouterPartialProperties, PluridRouterStatic, ConnectedPluridVirtualList as PluridVirtualList, arrangementSignature, decodeViewpoint, Plurid as default, encodeViewpoint, getDirectPlaneMatch, internals, _default as pluridSelectors, _default$1 as pluridStateModules, serverComputeMetastate, usePluridRouter };
+export { PluridApplication, ConnectedPluridApplicationConfigurator as PluridApplicationConfigurator, ConnectedExternalPlane as PluridExternalPlane, ConnectedIframePlane as PluridIframePlane, ConnectedPluridLink as PluridLink, ConnectedPluridPlaneConfigurator as PluridPlaneConfigurator, type PluridPlaneIsolation, type PluridPlaneLens, PluridProvider, type PluridReactComponent, type PluridReactPlane, type PluridReactPlaneComponent, type PluridReactRoute, type PluridReactRouteComponent, type PluridReactRoutePlane, type PluridRouteMatch, PluridRouterBrowser, PluridRouterLink, type PluridRouterPartialProperties, PluridRouterStatic, ConnectedPluridVirtualList as PluridVirtualList, arrangementSignature, decodeViewpoint, Plurid as default, encodeViewpoint, getDirectPlaneMatch, internals, _default as pluridSelectors, _default$1 as pluridStateModules, serverComputeMetastate, usePluridPlane, usePluridRouter };