@unseenco/theatre-gsap 0.4.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,2 @@
1
- import type { ISheet } from '@unseenco/theatre-core';
2
- /**
3
- * Drives registered GSAP animations from the sheet sequence playhead.
4
- *
5
- * @returns Disposer — call to detach the bridge.
6
- */
7
- export declare function attachGsapSequenceBridge(sheet: ISheet): () => void;
1
+ export { attachGsapSequenceBridge } from '@unseenco/theatre-core';
8
2
  //# sourceMappingURL=attachGsapSequenceBridge.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"attachGsapSequenceBridge.d.ts","sourceRoot":"","sources":["../src/attachGsapSequenceBridge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,wBAAwB,CAAA;AAMlD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,IAAI,CAqBlE"}
1
+ {"version":3,"file":"attachGsapSequenceBridge.d.ts","sourceRoot":"","sources":["../src/attachGsapSequenceBridge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,wBAAwB,EAAC,MAAM,wBAAwB,CAAA"}
@@ -0,0 +1,10 @@
1
+ import type { AttachTheatrePageScrollOptions, ISheet, PageScrollContext, PageScrollScroller, ScrollDriver } from '@unseenco/theatre-core';
2
+ export declare function getTheatrePageScrollContext(): PageScrollContext;
3
+ export declare function createDefaultPageScrollDriver(scroller?: PageScrollScroller): ScrollDriver;
4
+ export type { AttachTheatrePageScrollOptions };
5
+ /**
6
+ * @deprecated Import from `@unseenco/theatre-core` for page scroll without GSAP.
7
+ * This wrapper applies ScrollTrigger defaults when `configureTheatreGsap({ pageScroll })` is used.
8
+ */
9
+ export declare function attachTheatrePageScroll(sheet: ISheet, options?: AttachTheatrePageScrollOptions): () => void;
10
+ //# sourceMappingURL=attachTheatrePageScroll.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"attachTheatrePageScroll.d.ts","sourceRoot":"","sources":["../src/attachTheatrePageScroll.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,MAAM,EACN,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACb,MAAM,wBAAwB,CAAA;AA0B/B,wBAAgB,2BAA2B,IAAI,iBAAiB,CAY/D;AAED,wBAAgB,6BAA6B,CAC3C,QAAQ,GAAE,kBAA2D,GACpE,YAAY,CAGd;AAED,YAAY,EAAC,8BAA8B,EAAC,CAAA;AAE5C;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,8BAAmC,GAC3C,MAAM,IAAI,CAGZ"}
package/dist/config.d.ts CHANGED
@@ -1,9 +1,23 @@
1
1
  import type { OutlineNamespaceConfig } from '@unseenco/theatre-shared/utils/outlineNamespaces';
2
+ import type { PageScrollAxis, PageScrollScroller } from '@unseenco/theatre-shared/sheets/pageScrollContext';
3
+ export type TheatreGsapPageScrollConfig = {
4
+ /** Default scroller for ScrollTrigger layout and guards; `null` = native document. */
5
+ scroller?: PageScrollScroller;
6
+ /** Page scroll axis (default vertical). */
7
+ axis?: PageScrollAxis;
8
+ /**
9
+ * @deprecated ScrollTrigger.defaults is applied automatically when `pageScroll` is configured.
10
+ */
11
+ applyScrollTriggerDefaults?: boolean;
12
+ };
2
13
  export type TheatreGsapConfig = {
3
14
  /** Outline namespace segment for GSAP proxy objects (default `GSAP`). */
4
15
  namespace?: string;
5
16
  /** Applied to each sheet when the first GSAP object is registered on it. */
6
17
  outlineNamespace?: OutlineNamespaceConfig;
18
+ /** When true, skips the one-time gsap.ticker / core rAF integration warning. */
19
+ suppressGsapTickerRafWarning?: boolean;
20
+ pageScroll?: TheatreGsapPageScrollConfig;
7
21
  };
8
22
  export declare function configureTheatreGsap(config: TheatreGsapConfig): {
9
23
  reset: () => void;
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,kDAAkD,CAAA;AAG5F,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yEAAyE;IACzE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,sBAAsB,CAAA;CAC1C,CAAA;AASD,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,GAAG;IAC/D,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB,CAYA;AAED,wBAAgB,oBAAoB,IAAI,iBAAiB,CAExD"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,kDAAkD,CAAA;AAC5F,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EACnB,MAAM,mDAAmD,CAAA;AAQ1D,MAAM,MAAM,2BAA2B,GAAG;IACxC,sFAAsF;IACtF,QAAQ,CAAC,EAAE,kBAAkB,CAAA;IAC7B,2CAA2C;IAC3C,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yEAAyE;IACzE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,sBAAsB,CAAA;IACzC,gFAAgF;IAChF,4BAA4B,CAAC,EAAE,OAAO,CAAA;IACtC,UAAU,CAAC,EAAE,2BAA2B,CAAA;CACzC,CAAA;AA8BD,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,GAAG;IAC/D,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB,CA8BA;AAED,wBAAgB,oBAAoB,IAAI,iBAAiB,CAExD"}
@@ -0,0 +1,10 @@
1
+ import type { GsapScrollTriggerStaticLike } from './gsapScrollTriggerTypes';
2
+ /**
3
+ * Optional: bind the ScrollTrigger plugin instance your app registered with GSAP.
4
+ * When omitted, Theatre resolves ScrollTrigger from `gsap/ScrollTrigger` (ESM) or `globalThis.ScrollTrigger`.
5
+ */
6
+ export declare function bindGsapScrollTriggerPlugin(scrollTrigger: GsapScrollTriggerStaticLike): void;
7
+ export declare function getGsapScrollTriggerPlugin(): GsapScrollTriggerStaticLike | undefined;
8
+ export declare function requireGsapScrollTriggerPlugin(): GsapScrollTriggerStaticLike;
9
+ export declare function refreshGsapScrollTriggers(): void;
10
+ //# sourceMappingURL=gsapScrollTriggerPlugin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"gsapScrollTriggerPlugin.d.ts","sourceRoot":"","sources":["../src/gsapScrollTriggerPlugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,2BAA2B,EAAC,MAAM,0BAA0B,CAAA;AAIzE;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,2BAA2B,GACzC,IAAI,CAEN;AAED,wBAAgB,0BAA0B,IACtC,2BAA2B,GAC3B,SAAS,CAWZ;AAED,wBAAgB,8BAA8B,IAAI,2BAA2B,CAQ5E;AAED,wBAAgB,yBAAyB,IAAI,IAAI,CAEhD"}
@@ -0,0 +1,23 @@
1
+ /** Minimal GSAP ScrollTrigger surface for Theatre (avoids tight GSAP coupling). */
2
+ export type GsapScrollTriggerLike = {
3
+ start: number;
4
+ end: number;
5
+ horizontal?: boolean;
6
+ scroller?: unknown;
7
+ trigger?: unknown;
8
+ animation?: unknown;
9
+ vars?: {
10
+ id?: string;
11
+ animation?: unknown;
12
+ horizontal?: boolean;
13
+ scroller?: unknown;
14
+ };
15
+ };
16
+ export type GsapScrollTriggerStaticLike = {
17
+ refresh(): void;
18
+ getAll(): GsapScrollTriggerLike[];
19
+ defaults?(vars: {
20
+ scroller?: unknown;
21
+ }): void;
22
+ };
23
+ //# sourceMappingURL=gsapScrollTriggerTypes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"gsapScrollTriggerTypes.d.ts","sourceRoot":"","sources":["../src/gsapScrollTriggerTypes.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,IAAI,CAAC,EAAE;QACL,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;KACnB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,IAAI,IAAI,CAAA;IACf,MAAM,IAAI,qBAAqB,EAAE,CAAA;IACjC,QAAQ,CAAC,CAAC,IAAI,EAAE;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,CAAA;CAC5C,CAAA"}
@@ -0,0 +1,23 @@
1
+ import type { IRafDriver } from '@unseenco/theatre-core';
2
+ export type GsapTickerLike = {
3
+ ticker: {
4
+ add(fn: (time: number) => void): unknown;
5
+ remove(fn: (time: number) => void): unknown;
6
+ };
7
+ };
8
+ /**
9
+ * Drives a Theatre `rafDriver` from `gsap.ticker` (GSAP time in seconds → Theatre ms).
10
+ * Returns a cleanup that removes the ticker listener and unmarks the driver.
11
+ */
12
+ export declare function bindGsapTickerToRafDriver(rafDriver: IRafDriver, gsap: GsapTickerLike): () => void;
13
+ export declare function isRafDriverDrivenByGsapTicker(rafDriver: IRafDriver): boolean;
14
+ /**
15
+ * Schedules a deferred check so same-turn `setCoreRafDriver` → `bindGsapTickerToRafDriver`
16
+ * → `registerGsapAnimation` does not warn before the bind runs.
17
+ */
18
+ export declare function scheduleGsapTickerRafWarningCheck(): void;
19
+ /**
20
+ * Warns once per page load when Theatre's core rAF is not driven by `gsap.ticker`.
21
+ */
22
+ export declare function warnIfGsapTickerNotDrivingTheatreRaf(): void;
23
+ //# sourceMappingURL=gsapTickerRafBridge.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"gsapTickerRafBridge.d.ts","sourceRoot":"","sources":["../src/gsapTickerRafBridge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AAMtD,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAA;QACxC,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAA;KAC5C,CAAA;CACF,CAAA;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,UAAU,EACrB,IAAI,EAAE,cAAc,GACnB,MAAM,IAAI,CAUZ;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAE5E;AAKD;;;GAGG;AACH,wBAAgB,iCAAiC,IAAI,IAAI,CAOxD;AAED;;GAEG;AACH,wBAAgB,oCAAoC,IAAI,IAAI,CAY3D"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=gsapTickerRafBridge.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"gsapTickerRafBridge.test.d.ts","sourceRoot":"","sources":["../src/gsapTickerRafBridge.test.ts"],"names":[],"mappings":""}
package/dist/index.d.ts CHANGED
@@ -1,8 +1,18 @@
1
1
  export { registerGsapAnimation } from './registerGsapAnimation';
2
2
  export type { RegisterGsapAnimationOptions, RegisterGsapAnimationResult, } from './registerGsapAnimation';
3
+ export { registerGsapScrollTrigger } from './registerGsapScrollTrigger';
4
+ export type { RegisterGsapScrollTriggerOptions, RegisterGsapScrollTriggerResult, } from './registerGsapScrollTrigger';
5
+ export { registerAllGsapScrollTriggers } from './registerAllGsapScrollTriggers';
6
+ export type { RegisterAllGsapScrollTriggersResult } from './registerAllGsapScrollTriggers';
7
+ export { refreshRegisteredGsapScrollTriggerLayouts } from './registerGsapScrollTrigger';
8
+ export type { GsapScrollTriggerLike } from './gsapScrollTriggerTypes';
3
9
  export { attachGsapSequenceBridge } from './attachGsapSequenceBridge';
4
10
  export { configureTheatreGsap, getTheatreGsapConfig } from './config';
5
- export type { TheatreGsapConfig } from './config';
11
+ export type { TheatreGsapConfig, TheatreGsapPageScrollConfig } from './config';
12
+ export { attachTheatrePageScroll, createDefaultPageScrollDriver, getTheatrePageScrollContext, } from './attachTheatrePageScroll';
13
+ export { bindGsapScrollTriggerPlugin } from './gsapScrollTriggerPlugin';
14
+ export { bindGsapTickerToRafDriver, isRafDriverDrivenByGsapTicker, scheduleGsapTickerRafWarningCheck, warnIfGsapTickerNotDrivingTheatreRaf, } from './gsapTickerRafBridge';
15
+ export type { GsapTickerLike } from './gsapTickerRafBridge';
6
16
  export { getAnimationEntry, getAnimationEntryById, getAnimationEntryForSheetObject, listAnimationEntries, } from './animationRegistry';
7
17
  export type { GsapAnimationRegistryEntry } from './animationRegistry';
8
18
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,qBAAqB,EAAC,MAAM,yBAAyB,CAAA;AAC7D,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,GAC5B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAC,wBAAwB,EAAC,MAAM,4BAA4B,CAAA;AACnE,OAAO,EAAC,oBAAoB,EAAE,oBAAoB,EAAC,MAAM,UAAU,CAAA;AACnE,YAAY,EAAC,iBAAiB,EAAC,MAAM,UAAU,CAAA;AAC/C,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,qBAAqB,EAAC,MAAM,yBAAyB,CAAA;AAC7D,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,GAC5B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAC,yBAAyB,EAAC,MAAM,6BAA6B,CAAA;AACrE,YAAY,EACV,gCAAgC,EAChC,+BAA+B,GAChC,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAC,6BAA6B,EAAC,MAAM,iCAAiC,CAAA;AAC7E,YAAY,EAAC,mCAAmC,EAAC,MAAM,iCAAiC,CAAA;AACxF,OAAO,EAAC,yCAAyC,EAAC,MAAM,6BAA6B,CAAA;AACrF,YAAY,EAAC,qBAAqB,EAAC,MAAM,0BAA0B,CAAA;AACnE,OAAO,EAAC,wBAAwB,EAAC,MAAM,4BAA4B,CAAA;AACnE,OAAO,EAAC,oBAAoB,EAAE,oBAAoB,EAAC,MAAM,UAAU,CAAA;AACnE,YAAY,EAAC,iBAAiB,EAAE,2BAA2B,EAAC,MAAM,UAAU,CAAA;AAC5E,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,2BAA2B,GAC5B,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAC,2BAA2B,EAAC,MAAM,2BAA2B,CAAA;AACrE,OAAO,EACL,yBAAyB,EACzB,6BAA6B,EAC7B,iCAAiC,EACjC,oCAAoC,GACrC,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAA;AACzD,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAA"}