@octanejs/auto-animate 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 FormKit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+# @octanejs/auto-animate
+
+Octane binding for [`@formkit/auto-animate@0.10.0`](https://github.com/formkit/auto-animate). The vanilla `autoAnimate` core is reused unchanged. The React hook is ported at `@octanejs/auto-animate/react`.
+
+```tsrx
+import { useAutoAnimate } from '@octanejs/auto-animate/react';
+
+export function List(props: { items: string[] }) @{
+	const [parent] = useAutoAnimate();
+	<ul ref={parent}>
+		@for (const item of props.items; key item) {
+			<li>{item}</li>
+		}
+	</ul>
+}
+```
+
+Vue, Preact, Solid, Angular, Nuxt, Marko, and Qwik entry points are not part of this binding. See [UPSTREAM.md](./UPSTREAM.md).

package/UPSTREAM.md

@@ -0,0 +1,52 @@
+# Upstream provenance
+
+`@octanejs/auto-animate` is pinned to `@formkit/auto-animate@0.10.0`.
+
+- repository: https://github.com/formkit/auto-animate
+- tag: `0.10.0`
+- tag commit: `b6a6feebf75c198dd85f280c549bc0303f9e7aa8`
+- advertised range: `0.10.x`
+- license: MIT
+- npm integrity: `sha512-KGomRttjUfORuPUaR/ZGQw+6xfMrTM+sxnILv7JAd9AmabU9rg9i6gF/iC0Ih+QpKCubJpCA/1DX9UHKE8cX+A==`
+- npm shasum: `0eadd565f50e54e5dc6f29c41b32d32b53661eab`
+
+## Source boundary
+
+- `upstream/src/` is the canonical tagged source (vanilla core, framework adapters, tests, LICENSE).
+- `upstream/npm/` is the published tarball (compiled `index.mjs` / `react/index.mjs`).
+- The Octane package depends on `@formkit/auto-animate@0.10.0` and re-exports the vanilla core. Only `src/react/` is a port of `upstream/src/react/index.ts`.
+
+Vendored evidence is development-only and excluded from package `files`.
+
+## Export crosswalk
+
+| Upstream export | Octane status | Evidence / divergence |
+| --- | --- | --- |
+| `autoAnimate` (`.`) | Reused verbatim from `@formkit/auto-animate` | `src/index.ts`; `tests/auto-animate.test.ts` |
+| default export | Reused verbatim | `src/index.ts` |
+| `getTransitionSizes` | Reused verbatim | `src/index.ts` |
+| `vAutoAnimate` | Gap | Vue directive on the root package; Octane has no Vue renderer |
+| `AutoAnimateOptions` / `AutoAnimationPlugin` / `AnimationController` | Reused types | `src/index.ts` |
+| `./react` `useAutoAnimate` | Ported | `src/react/index.tsrx`; `tests/auto-animate.test.ts` |
+| `./vue` | Gap | Other-framework adapter; Octane has no Vue renderer |
+| `./preact` | Gap | Other-framework adapter |
+| `./solid` | Gap | Other-framework adapter |
+| `./angular` | Gap | Other-framework adapter |
+| `./nuxt` | Gap | Nuxt module |
+| `./marko` | Gap | Marko tag |
+| `./qwik` (source only) | Gap | Not a published npm export at this pin; source exists in `upstream/src/qwik` |
+
+## Upstream test disposition
+
+| Upstream artifact | Disposition |
+| --- | --- |
+| `upstream/src/index.ts` (vanilla) | Reused via npm dependency; not rewritten |
+| `upstream/tests/` Playwright e2e (`tests/*.spec.ts`, multi-framework) | Out of scope: browser e2e across Vue/Preact/Solid/Angular/Nuxt/Marko/Qwik. Recorded as a gap, not skipped in-repo. |
+| `playwright.config.ts` | Out of scope with the e2e suite |
+
+Octane behavioral coverage is `tests/auto-animate.test.ts` (hook ref attach, enable/disable, omitted options). It is Octane-only framework-contract coverage because upstream ships no Vitest unit suite for the React hook.
+
+## Intentional divergences
+
+- Compiler-injected hook slots may occupy the `options` argument; a `symbol` is treated as omitted options.
+- Non-React framework entry points are not published on `@octanejs/auto-animate`.

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@octanejs/auto-animate",
+  "version": "0.0.1",
+  "description": "Octane binding for @formkit/auto-animate 0.10.0: vanilla core reused, React useAutoAnimate ported.",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=22.22.2"
+  },
+  "author": {
+    "name": "Dominic Gannaway",
+    "email": "dg@domgan.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/octanejs/octane.git",
+    "directory": "packages/auto-animate"
+  },
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
+  "types": "./src/index.ts",
+  "files": [
+    "src",
+    "README.md",
+    "UPSTREAM.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": "./src/index.ts",
+    "./react": "./src/react/index.tsrx",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@formkit/auto-animate": "0.10.0"
+  },
+  "peerDependencies": {
+    "octane": "0.1.45"
+  },
+  "devDependencies": {
+    "vitest": "^4.1.10",
+    "@octanejs/testing-library": "0.1.42",
+    "octane": "0.1.45"
+  },
+  "scripts": {
+    "test": "vitest run --root ../.. --config vitest.config.js --project auto-animate",
+    "typecheck": "tsrx-tsc --noEmit"
+  }
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+export { default, autoAnimate, getTransitionSizes } from '@formkit/auto-animate';
+export type {
+	AutoAnimateOptions,
+	AutoAnimationPlugin,
+	AnimationController,
+} from '@formkit/auto-animate';

package/src/react/index.tsrx

@@ -0,0 +1,50 @@
+import { useState, useCallback, useMemo, useEffect } from 'octane';
+import autoAnimate from '@formkit/auto-animate';
+import type {
+	AutoAnimateOptions,
+	AutoAnimationPlugin,
+	AnimationController,
+} from '@formkit/auto-animate';
+
+type AutoAnimateRefCallback<T extends Element> = (node: T | null) => void;
+
+/**
+ * AutoAnimate hook for adding dead-simple transitions and animations.
+ * Per packages/auto-animate/upstream/src/react/index.ts
+ */
+export function useAutoAnimate<T extends Element>(
+	options?: Partial<AutoAnimateOptions> | AutoAnimationPlugin | symbol,
+): [AutoAnimateRefCallback<T>, (enabled: boolean) => void] {
+	// OCTANE DIVERGENCE: compiler injects a trailing hook slot; when the hook
+	// is called with no options the slot lands in the first argument.
+	const resolvedOptions =
+		typeof options === 'symbol' ? undefined : options;
+	const [controller, setController] = useState<AnimationController | undefined>();
+	const memoizedOptions = useMemo(function memoOptions() {
+		return resolvedOptions;
+	}, []);
+	const element = useCallback(function bindElement(node: T | null) {
+		if (node instanceof HTMLElement) {
+			setController(autoAnimate(node, memoizedOptions));
+		} else {
+			setController(undefined);
+		}
+	}, [memoizedOptions]);
+	const setEnabled = useCallback(function setEnabled(enabled: boolean) {
+		if (controller) {
+			if (enabled) {
+				controller.enable();
+			} else {
+				controller.disable();
+			}
+		}
+	}, [controller]);
+
+	useEffect(function destroyController() {
+		return function onUnmount() {
+			controller?.destroy?.();
+		};
+	}, [controller]);
+
+	return [element, setEnabled];
+}