rytm-webflow 2.2.5 → 2.2.7

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "rytm-webflow",
-  "version": "2.2.5",
+  "version": "2.2.7",
   "description": "rytm webflow pack - ASwap, ShowUp",
   "main": "scripts/index.js",
+  "types": "scripts/index.d.ts",
   "scripts": {
     "update": "git pull",
     "push": "git add . && git commit -a -m \"$m\" && git push"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@bitbucket.org/rytm/rytm-webflow.git"
+    "url": "https://github.com/rytmdigital/rytm-webflow.git"
   },
   "author": "Rytm Digital / Roman Kühl",
   "license": "UNLICENSED",
-  "homepage": "https://bitbucket.org/rytm/rytm-webflow#readme",
+  "homepage": "https://github.com/rytmdigital/rytm-webflow.git",
   "devDependencies": {},
   "dependencies": {
     "gsap": "^3.5.1",

package/scripts/index.d.ts

@@ -0,0 +1,216 @@
+// Minimal stand-in for a ScrollMagic.Controller instance.
+// ScrollMagic ships no official types.
+interface ScrollMagicControllerInstance {
+  destroy(reset?: boolean): void;
+  update(immediately?: boolean): this;
+}
+
+// Shared shape returned by animation-prop parsers
+interface AnimationProps {
+  time: number;
+  tween: Record<string, unknown>;
+}
+
+// ScrollMagic scene props shape
+interface ScrollMagicSceneProps {
+  triggerElement: Element | string;
+  duration: number | string;
+  offset: number | string;
+}
+
+// Internal aswap event — target carries freshContent Element
+interface AswapEvent extends Event {
+  target: (EventTarget & { freshContent: Element }) | null;
+}
+
+// ─── ASwap ───────────────────────────────────────────────────
+
+export interface AswapProps {
+  animationTimeHide?: number;
+  animationTimeShow?: number;
+  formsEnabled?: boolean;
+  formsSelector?: string;
+  swipeEnabled?: boolean;
+  swipeMinDistance?: number;
+  historyEnabled?: boolean;
+  historyFallback?: boolean;
+  cacheOn?: boolean;
+  noCacheClassName?: string;
+  resetScrollOn?: boolean;
+  noScrollClassName?: string;
+  noSwapClassName?: string;
+  oldschoolBrowserFallback?: boolean;
+  preloadOnHover?: boolean;
+  refreshOnSameUrl?: boolean;
+  refreshOnContentParseError?: boolean;
+  swapSelector?: string;
+  defaultDocumentScrollBehavior?: string;
+  trace?: (...args: unknown[]) => void;
+  routes?: Record<string, AswapRoute>;
+}
+
+export interface AswapRoute {
+  controller: new (id: string | number) => Controller;
+  view?: new (id: string | number) => View;
+}
+
+export interface AswapEvents {
+  onInited?: () => void;
+  onRequestUrl?: () => void;
+  onRequestLoad?: () => void;
+  onRequestLoaded?: () => void;
+  onRequestSameUrl?: () => void;
+  onViewHide?: () => void;
+  onViewHidden?: () => void;
+  onViewSwapStart?: () => void;
+  onViewSwapComplete?: () => void;
+  onViewShow?: () => void;
+  onViewShown?: () => void;
+}
+
+export interface Aswap {
+  init(params?: AswapProps, events?: AswapEvents): void;
+  openURL(url: string, noHistory?: boolean, useCache?: boolean): void;
+  clearCache(url?: string | null): void;
+  formSubmit(form: HTMLFormElement): void;
+}
+
+// ─── Views ───────────────────────────────────────────────────
+
+export declare class View {
+  id: string | number;
+  active: boolean;
+
+  constructor(id: string | number);
+
+  prepare(container: Element | null): void;
+  show(container: Element | null): void;
+  shown(container: Element | null): void;
+  hide(container: Element | null): void;
+  hidden(container: Element | null): void;
+  loadImagesStart(container: Element | null): void;
+  loadImagesComplete(container: Element | null): void;
+
+  /** Arrow-function property — use to filter elements and exclude those belonging to nested views */
+  elementBelongsToView: (el: Element) => boolean;
+}
+
+export declare class WebflowView extends View {}
+
+export declare class WebflowListView extends View {}
+
+// ─── Controllers ─────────────────────────────────────────────
+
+export declare class Controller {
+  id: string | number;
+  name: string | false;
+  active: boolean;
+  view: View | false;
+
+  constructor(id: string | number);
+
+  setView(view: View): void;
+  isActive(): boolean;
+  getViewContainer(wrapper: Element): Element | null;
+  getContainerSelector(): string;
+  addEventListeners(): void;
+  removeEventListeners(): void;
+
+  onRequestUrl(e: AswapEvent): void;
+  onRequestLoad(e: AswapEvent): void;
+  onRequestLoaded(e: AswapEvent): void;
+  onViewHide(e: AswapEvent): void;
+  onViewHidden(e: AswapEvent): void;
+  onViewSwapStart(e: AswapEvent): void;
+  onViewSwapComplete(e: AswapEvent): void;
+  onViewShow(e: AswapEvent): void;
+  onViewShown(e: AswapEvent): void;
+}
+
+export declare class ControllerImgLoad extends Controller {
+  loadImagesStart(): void;
+  loadImagesComplete(e?: Event): void;
+}
+
+// ─── ShowUp ──────────────────────────────────────────────────
+
+export interface ShowUp {
+  init(): void;
+  rebuild(): void;
+  hide(): void;
+  destroy(): void;
+}
+
+// ─── Bootstrap 5 helpers ─────────────────────────────────────
+
+export interface Bootstrap5 {
+  hideFlyovers(): void;
+  hideModals(): void;
+  hideOffcanvases(): void;
+}
+
+// ─── scrollController ────────────────────────────────────────
+
+export interface ScrollController {
+  get(): ScrollMagicControllerInstance;
+  destroy(): void;
+  refresh(immediately?: boolean): void;
+}
+
+// ─── Utility functions ───────────────────────────────────────
+
+/** Split a comma-separated key:value string into an object */
+export declare function parseProps(str: string): Record<string, unknown>;
+
+/** Parse a webflow animation data-attribute string into show/hide animation props */
+export declare function getWebflowProps(str: string): {
+  show: AnimationProps;
+  hide: AnimationProps | false;
+};
+
+/** Parse a single animation group string into time + tween props */
+export declare function getWebflowAnimationProps(str: string): AnimationProps;
+
+/** Parse a parallax data-attribute string into parallax tween props */
+export declare function getParallaxProps(str: string): {
+  parallax?: AnimationProps;
+};
+
+/** Build ScrollMagic.Scene constructor props from an element and setup object */
+export declare function getScrollMagicSceneProps(
+  el: Element,
+  setup: Record<string, unknown>
+): ScrollMagicSceneProps;
+
+/** Check if an element is visible within the current viewport */
+export declare function elementIsVisibleInViewport(
+  el: Element,
+  partiallyVisible?: boolean
+): boolean;
+
+// ─── Constant ────────────────────────────────────────────────
+
+export declare const CLASS_NAME_WEBSCROLL_FIRED: string;
+
+// ─── Default export ───────────────────────────────────────────
+
+declare const RytmWebflow: {
+  aswap: Aswap;
+  Controller: typeof Controller;
+  ControllerImgLoad: typeof ControllerImgLoad;
+  View: typeof View;
+  WebflowView: typeof WebflowView;
+  WebflowListView: typeof WebflowListView;
+  /** Note: "bootsrap5" is the original (typo) name in the library */
+  bootsrap5: Bootstrap5;
+  scrollController: ScrollController;
+  showUp: ShowUp;
+  getWebflowProps: typeof getWebflowProps;
+  getWebflowAnimationProps: typeof getWebflowAnimationProps;
+  getParallaxProps: typeof getParallaxProps;
+  parseProps: typeof parseProps;
+  getScrollMagicSceneProps: typeof getScrollMagicSceneProps;
+  elementIsVisibleInViewport: typeof elementIsVisibleInViewport;
+};
+
+export default RytmWebflow;