@unseenco/theatre-core 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -1788,64 +1788,13 @@ declare function setCoreRafDriver(driver: IRafDriver): void;
  */
 declare function isRemoteEditorWindow(): boolean;
 
-/**
- * Drives registered GSAP animations from the sheet sequence playhead.
- *
- * @returns Disposer — call to detach the bridge.
- */
-declare function attachGsapSequenceBridge(sheet: ISheet): () => void;
-
-/** `null` = native document scroll (window / documentElement). */
-type PageScrollScroller = Window | Element | null;
-type PageScrollAxis = 'vertical' | 'horizontal';
-type PageScrollContext = {
-    scroller: PageScrollScroller;
-    /** Scroll axis for page mode and ScrollTrigger registration (default vertical). */
-    axis?: PageScrollAxis;
-};
-declare const defaultPageScrollContext: PageScrollContext;
-declare function setActivePageScrollContext(context: PageScrollContext): void;
-declare function getActivePageScrollContext(): PageScrollContext;
-declare function resolvePageScrollAxis(context?: PageScrollContext): PageScrollAxis;
-declare function resolvePageScrollScroller(st: unknown, defaultsScroller?: PageScrollScroller): PageScrollScroller;
-declare function isNativeDocumentScroller(scroller: PageScrollScroller): boolean;
-/** Same scroller target for page-mode scroll registration (reference equality or both native doc). */
-declare function pageScrollScrollersMatch(a: PageScrollScroller, b: PageScrollScroller): boolean;
-/**
- * True when ST scroller and horizontal flag match the configured page scroll context.
- */
-declare function isPageScrollTrigger(st: unknown, context?: PageScrollContext): boolean;
-declare function isVerticalPageScrollTrigger(st: unknown, context?: PageScrollContext): boolean;
-
-type TheatrePageScrollConfig = {
-    /** Default scroller for page-mode layout helpers; `null` = native document. */
-    scroller?: PageScrollScroller;
-    /** Scroll axis (default vertical). */
-    axis?: PageScrollAxis;
-};
-declare function configureTheatrePageScroll(config: TheatrePageScrollConfig): {
-    reset: () => void;
-};
-declare function getTheatrePageScrollConfig(): TheatrePageScrollConfig;
-/** Active page scroll context from {@link configureTheatrePageScroll}. */
-declare function getTheatrePageScrollContext(): PageScrollContext;
-declare function createDefaultPageScrollDriver(scroller?: PageScrollScroller, axis?: PageScrollAxis): ScrollDriver;
-type AttachTheatrePageScrollOptions = {
-    driver?: ScrollDriver;
-};
-/**
- * Wires page-mode scroll → sequence sync using {@link configureTheatrePageScroll}
- * or an explicit driver (Lenis, overflow containers, etc.).
- */
-declare function attachTheatrePageScroll(sheet: ISheet, options?: AttachTheatrePageScrollOptions): () => void;
-
 /**
  * Returns a project of the given id, or creates one if it doesn't already exist.
  *
  * @remarks
  * If \@unseenco/theatre-studio is also loaded, then the state of the project will be managed by the studio.
  *
- * [Learn more about exporting](https://unseen-theatre.netlify.app/docs/guide/manual/projects#state)
+ * [Learn more about exporting](https://www.theatrejs.com/docs/latest/manual/projects#state)
  *
  * @example
  * Usage:
@@ -1870,7 +1819,7 @@ declare function getProject(id: string, config?: IProjectConfig): IProject;
  *
  * @param pointer - A Pointer (like `object.props.x`)
  * @param callback - The callback is called every time the value of pointer changes
- * @param rafDriver - (optional) The `rafDriver` to use. Learn how to use `rafDriver`s [from the docs](https://unseen-theatre.netlify.app/docs/guide/manual/advanced#rafdrivers).
+ * @param rafDriver - (optional) The `rafDriver` to use. Learn how to use `rafDriver`s [from the docs](https://www.theatrejs.com/docs/latest/manual/advanced#rafdrivers).
  * @returns An unsubscribe function
  *
  * @example
@@ -1907,6 +1856,57 @@ declare function onChange<P extends PointerType<$IntentionalAny> | Prism<$Intent
  */
 declare function val<T>(pointer: PointerType<T>): T;
 
+/**
+ * Drives registered GSAP animations from the sheet sequence playhead.
+ *
+ * @returns Disposer — call to detach the bridge.
+ */
+declare function attachGsapSequenceBridge(sheet: ISheet): () => void;
+
+/** `null` = native document scroll (window / documentElement). */
+type PageScrollScroller = Window | Element | null;
+type PageScrollAxis = 'vertical' | 'horizontal';
+type PageScrollContext = {
+    scroller: PageScrollScroller;
+    /** Scroll axis for page mode and ScrollTrigger registration (default vertical). */
+    axis?: PageScrollAxis;
+};
+declare const defaultPageScrollContext: PageScrollContext;
+declare function setActivePageScrollContext(context: PageScrollContext): void;
+declare function getActivePageScrollContext(): PageScrollContext;
+declare function resolvePageScrollAxis(context?: PageScrollContext): PageScrollAxis;
+declare function resolvePageScrollScroller(st: unknown, defaultsScroller?: PageScrollScroller): PageScrollScroller;
+declare function isNativeDocumentScroller(scroller: PageScrollScroller): boolean;
+/** Same scroller target for page-mode scroll registration (reference equality or both native doc). */
+declare function pageScrollScrollersMatch(a: PageScrollScroller, b: PageScrollScroller): boolean;
+/**
+ * True when ST scroller and horizontal flag match the configured page scroll context.
+ */
+declare function isPageScrollTrigger(st: unknown, context?: PageScrollContext): boolean;
+declare function isVerticalPageScrollTrigger(st: unknown, context?: PageScrollContext): boolean;
+
+type TheatrePageScrollConfig = {
+    /** Default scroller for page-mode layout helpers; `null` = native document. */
+    scroller?: PageScrollScroller;
+    /** Scroll axis (default vertical). */
+    axis?: PageScrollAxis;
+};
+declare function configureTheatrePageScroll(config: TheatrePageScrollConfig): {
+    reset: () => void;
+};
+declare function getTheatrePageScrollConfig(): TheatrePageScrollConfig;
+/** Active page scroll context from {@link configureTheatrePageScroll}. */
+declare function getTheatrePageScrollContext(): PageScrollContext;
+declare function createDefaultPageScrollDriver(scroller?: PageScrollScroller, axis?: PageScrollAxis): ScrollDriver;
+type AttachTheatrePageScrollOptions = {
+    driver?: ScrollDriver;
+};
+/**
+ * Wires page-mode scroll → sequence sync using {@link configureTheatrePageScroll}
+ * or an explicit driver (Lenis, overflow containers, etc.).
+ */
+declare function attachTheatrePageScroll(sheet: ISheet, options?: AttachTheatrePageScrollOptions): () => void;
+
 /**
  * The library providing the runtime functionality of Theatre.js.
  *