aniview 1.0.0

package/dist/useAniviewContext.d.ts

@@ -0,0 +1,156 @@
+import React from "react";
+import { SharedValue, AnimatedProps, WithSpringConfig } from "react-native-reanimated";
+import { ViewProps, ViewStyle } from "react-native";
+import { WorldBounds } from "./core/AniviewMath";
+export type { WorldBounds };
+/**
+ * ANIVIEW DOMAIN TYPES
+ */
+export interface AniviewFrame {
+    /** Target page ID for spatial transitions (can be numeric index or semantic name) */
+    page?: number | string;
+    /** Custom event name for state-driven transitions (e.g., 'zoom', 'tilt') */
+    event?: string;
+    /** The value of the event driver that triggers this frame */
+    value?: number;
+    /** Style overrides for this frame */
+    style?: ViewStyle | ViewStyle[];
+    /**
+     * If true, this event-driven frame remains active across all pages.
+     * If false (default), the effect is modulated by proximity to the component's home page.
+     */
+    persistent?: boolean;
+    /** Optional opacity override shortcut */
+    opacity?: number;
+    /** Optional scale override shortcut */
+    scale?: number;
+    /** Optional rotate (Z) override shortcut (degrees) */
+    rotate?: number;
+    /** Spring config override for this specific frame transition (future) */
+    springConfig?: any;
+}
+export interface BakedFrame extends AniviewFrame {
+    worldX: number;
+    worldY: number;
+}
+export interface AniviewRegistration {
+    offset: {
+        x: number;
+        y: number;
+    };
+    dimensions: {
+        width: number;
+        height: number;
+    };
+}
+export interface AniviewProps extends AnimatedProps<ViewProps> {
+    pageId: number | string;
+    frames?: AniviewFrame[] | Record<string, AniviewFrame>;
+    events?: {
+        x: SharedValue<number>;
+        y: SharedValue<number>;
+        [key: string]: SharedValue<number>;
+    } | null;
+    children?: React.ReactNode;
+    style?: ViewStyle | ViewStyle[];
+    pointerEvents?: 'box-none' | 'none' | 'box-only' | 'auto';
+    /**
+     * If true, this component stays mounted even when offscreen.
+     * Essential for 3D/GL contexts.
+     * If false (default), it unmounts when offscreen to save RAM.
+     */
+    persistent?: boolean;
+}
+/**
+ * Imperative Handle for controlling the Aniview Physics Engine
+ */
+export interface AniviewHandle {
+    /** Programmatically snap to a specific page */
+    snapToPage: (pageId: number | string) => void;
+    /** Get the current active page ID */
+    getCurrentPage: () => number | string;
+    /** Lock specific axes (bitmask: 1=Left, 2=Right, 4=Up, 8=Down) */
+    lock: (mask: number) => void;
+}
+/**
+ * Interface for the Aniview configuration engine.
+ */
+export interface IAniviewConfig {
+    /** Gets the global (x, y) offset for a specific page relative to origin. */
+    getPageOffset(pageId: number | string, dims: AniviewContextType['dimensions']): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Pre-calculates absolute coordinates for a component's keyframes.
+     * Executed during the 'Baking' phase on the JS thread.
+     */
+    register(pageId: number | string, dims: AniviewContextType['dimensions'], keyframes?: AniviewFrame[] | Record<string, AniviewFrame>, localLayout?: {
+        x: number;
+        y: number;
+    }): {
+        homeOffset: {
+            x: number;
+            y: number;
+        };
+        bakedFrames: Record<string, BakedFrame>;
+        eventLanes: Record<string, BakedFrame[]>;
+        localLayout: {
+            x: number;
+            y: number;
+        };
+    };
+    /** Minimal offset context for direct page references */
+    registerPage(pageId: number | string, dims: AniviewContextType['dimensions']): AniviewRegistration;
+    /** Returns all valid page IDs defined in the layout matrix */
+    getPages(): number[];
+    /** Map of PageID -> (x, y) coordinates */
+    getPagesMap(dims: AniviewContextType['dimensions']): Record<number, {
+        x: number;
+        y: number;
+    }>;
+    /** Returns calculated min/max world boundaries for gesture clamping */
+    getWorldBounds(dims: AniviewContextType['dimensions']): WorldBounds;
+    /** Update dimensions dynamically (used by onLayout) */
+    updateDimensions(dims: AniviewContextType['dimensions']): void;
+    /** Update spring config dynamically */
+    updateSpringConfig(config: WithSpringConfig): void;
+    /** Generates the core Pan Gesture logic */
+    generateGesture(x: SharedValue<number>, y: SharedValue<number>, onPageChange?: (pageId: number | string) => void, lockMask?: SharedValue<number>, simultaneousHandlers?: any, gestureEnabled?: SharedValue<boolean>, dims?: AniviewContextType['dimensions'], isSnapping?: SharedValue<boolean>, lastTargetId?: SharedValue<number | string>): any;
+    /** Resolves a potentially semantic pageId string into its numeric index */
+    resolvePageId(pageId: number | string): number;
+    /** Returns the current active page ID (SharedValue) */
+    getCurrentPage(): SharedValue<number | string>;
+}
+export interface AniviewContextType {
+    dimensions: {
+        width: number;
+        height: number;
+        offsetX: number;
+        offsetY: number;
+    };
+    events: {
+        x: SharedValue<number>;
+        y: SharedValue<number>;
+        [key: string]: SharedValue<number>;
+    };
+    activationMap: Record<number, SharedValue<number>>;
+    panGesture: any;
+    config: IAniviewConfig;
+    /** Programmatically lock specific axes */
+    lock: (mask: number) => void;
+    /** Set of page IDs that should currently be mounted */
+    visiblePages: Set<number>;
+    /** Tracks if Aniview is currently snapping/animating toward a page */
+    isMoving: SharedValue<boolean>;
+}
+/**
+ * The full logic state for a specific Aniview component.
+ */
+export interface AniviewLogic extends AniviewContextType {
+    registration: AniviewRegistration;
+    activationValue: SharedValue<number>;
+    keyframes: Record<string, AniviewFrame> | undefined;
+}
+export declare const AniviewContext: React.Context<AniviewContextType | null>;
+//# sourceMappingURL=useAniviewContext.d.ts.map

package/dist/useAniviewContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAniviewContext.d.ts","sourceRoot":"","sources":["../src/useAniviewContext.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAwB,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEvF,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,qFAAqF;IACrF,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,YAAY,CAAC,EAAE,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACjC,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED,MAAM,WAAW,YAAa,SAAQ,aAAa,CAAC,SAAS,CAAC;IAC5D,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvD,MAAM,CAAC,EAAE;QACP,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;KACpC,GAAG,IAAI,CAAC;IACT,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,CAAC;IAChC,aAAa,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IAC1D;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,+CAA+C;IAC/C,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,KAAK,IAAI,CAAC;IAC9C,qCAAqC;IACrC,cAAc,EAAE,MAAM,MAAM,GAAG,MAAM,CAAC;IACtC,kEAAkE;IAClE,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4EAA4E;IAC5E,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,kBAAkB,CAAC,YAAY,CAAC,GAAG;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAEzG;;;OAGG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,IAAI,EAAE,kBAAkB,CAAC,YAAY,CAAC,EACtC,SAAS,CAAC,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,EACzD,WAAW,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GACrC;QACD,UAAU,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACxC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;QACzC,WAAW,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACvC,CAAC;IAEF,wDAAwD;IACxD,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,kBAAkB,CAAC,YAAY,CAAC,GAAG,mBAAmB,CAAC;IAEnG,8DAA8D;IAC9D,QAAQ,IAAI,MAAM,EAAE,CAAC;IAErB,0CAA0C;IAC1C,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE9F,uEAAuE;IACvE,cAAc,CAAC,IAAI,EAAE,kBAAkB,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC;IAEpE,uDAAuD;IACvD,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAE/D,uCAAuC;IACvC,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEnD,2CAA2C;IAC3C,eAAe,CACb,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,EACtB,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,EACtB,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,KAAK,IAAI,EAChD,QAAQ,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,EAC9B,oBAAoB,CAAC,EAAE,GAAG,EAC1B,cAAc,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EACrC,IAAI,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC,EACvC,UAAU,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EACjC,YAAY,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,GAC1C,GAAG,CAAC;IAEP,2EAA2E;IAC3E,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAE/C,uDAAuD;IACvD,cAAc,IAAI,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAA;IACD,MAAM,EAAE;QACN,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;KACpC,CAAA;IACD,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACnD,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,cAAc,CAAC;IACvB,0CAA0C;IAC1C,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,uDAAuD;IACvD,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,sEAAsE;IACtE,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,YAAY,EAAE,mBAAmB,CAAC;IAClC,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAC;CACrD;AAED,eAAO,MAAM,cAAc,0CAAiD,CAAC"}

package/dist/useAniviewContext.js

@@ -0,0 +1,3 @@
+import { createContext } from "react";
+export const AniviewContext = createContext(null);
+//# sourceMappingURL=useAniviewContext.js.map

package/dist/useAniviewContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAniviewContext.js","sourceRoot":"","sources":["../src/useAniviewContext.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAyK7C,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAA4B,IAAI,CAAC,CAAC"}

package/dist/useAniviewLock.d.ts

@@ -0,0 +1,20 @@
+import { AniviewLock, AniviewAxisLock } from './core/AniviewLock';
+export { AniviewLock };
+export type { AniviewAxisLock };
+/**
+ * Hook to lock/unlock Aniview swipe gestures from within a child component.
+ * Provides a clean API for disabling specific directions.
+ *
+ * Usage:
+ * const { lockDirections } = useAniviewLock();
+ * lockDirections({ left: true }); // Prevent swiping left
+ */
+export declare function useAniviewLock(): {
+    lockDirections: (directions: AniviewAxisLock) => void;
+    unlock: () => void;
+    isMoving: import("react-native-reanimated").SharedValue<boolean> | undefined;
+    AniviewLock: {
+        mask: (directions: AniviewAxisLock) => number;
+    };
+};
+//# sourceMappingURL=useAniviewLock.d.ts.map

package/dist/useAniviewLock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAniviewLock.d.ts","sourceRoot":"","sources":["../src/useAniviewLock.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAElE,OAAO,EAAE,WAAW,EAAE,CAAC;AACvB,YAAY,EAAE,eAAe,EAAE,CAAC;AAEhC;;;;;;;GAOG;AACH,wBAAgB,cAAc;iCAGU,eAAe;;;;;;EAkBtD"}

package/dist/useAniviewLock.js

@@ -0,0 +1,32 @@
+import { useContext } from 'react';
+import { AniviewContext } from './useAniviewContext';
+import { AniviewLock } from './core/AniviewLock';
+export { AniviewLock };
+/**
+ * Hook to lock/unlock Aniview swipe gestures from within a child component.
+ * Provides a clean API for disabling specific directions.
+ *
+ * Usage:
+ * const { lockDirections } = useAniviewLock();
+ * lockDirections({ left: true }); // Prevent swiping left
+ */
+export function useAniviewLock() {
+    const context = useContext(AniviewContext);
+    const lockDirections = (directions) => {
+        if (context) {
+            context.lock(AniviewLock.mask(directions));
+        }
+    };
+    const unlock = () => {
+        if (context) {
+            context.lock(0);
+        }
+    };
+    return {
+        lockDirections,
+        unlock,
+        isMoving: context?.isMoving,
+        AniviewLock // Export helper as well
+    };
+}
+//# sourceMappingURL=useAniviewLock.js.map

package/dist/useAniviewLock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAniviewLock.js","sourceRoot":"","sources":["../src/useAniviewLock.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAmB,MAAM,oBAAoB,CAAC;AAElE,OAAO,EAAE,WAAW,EAAE,CAAC;AAGvB;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAE3C,MAAM,cAAc,GAAG,CAAC,UAA2B,EAAE,EAAE;QACnD,IAAI,OAAO,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,GAAG,EAAE;QAChB,IAAI,OAAO,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACH,cAAc;QACd,MAAM;QACN,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,WAAW,CAAC,wBAAwB;KACvC,CAAC;AACN,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "aniview",
+  "version": "1.0.0",
+  "description": "Absolute World Coordinate Animation Engine for React Native",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "react-native": "src/index.ts",
+  "source": "src/index.ts",
+  "files": [
+    "dist/",
+    "src/",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TitanicEclair/aniview.git"
+  },
+  "homepage": "https://github.com/TitanicEclair/aniview#readme",
+  "bugs": {
+    "url": "https://github.com/TitanicEclair/aniview/issues"
+  },
+  "keywords": [
+    "react-native",
+    "animation",
+    "gesture",
+    "reanimated",
+    "page-transition",
+    "coordinate-system",
+    "worklet",
+    "pager"
+  ],
+  "author": "Madelyn Cruz Tan",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "prepare": "npm run build",
+    "lint": "tsc --noEmit",
+    "test": "jest"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-native": ">=0.71.0",
+    "react-native-gesture-handler": ">=2.14.0",
+    "react-native-reanimated": ">=3.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.14",
+    "@types/react": "~19.1.0",
+    "@types/react-test-renderer": "^19.1.0",
+    "jest": "~29.7.0",
+    "react-native-gesture-handler": "^2.30.0",
+    "react-native-reanimated": "^4.2.1",
+    "react-test-renderer": "^19.2.4",
+    "tsx": "^4.21.0",
+    "typescript": "~5.3.0"
+  }
+}