Merge pull request #83 from inokawa/strip-internal

Remove internal types from bundle

Author: inokawa

src/core/utils.ts

@@ -1,9 +1,17 @@
+/** @internal */
 export const noop = () => {};
+/** @internal */
 export const getKeys: <T extends object>(item: T) => (keyof T)[] = Object.keys;
+/** @internal */
 export const assign = Object.assign;
+/** @internal */
 export const isArray = Array.isArray;
+/** @internal */
 export const getStyle = (e: Element) => getComputedStyle(e);
 
+/**
+ * @internal
+ */
 export const isSameObject = (
   target: object = {},
   prev: object = {}
@@ -13,6 +21,9 @@ export const isSameObject = (
   return keys.every((k) => (target as any)[k] === (prev as any)[k]);
 };
 
+/**
+ * @internal
+ */
 export const isSameObjectArray = (
   target: object[],
   prev: object[]
@@ -21,9 +32,15 @@ export const isSameObjectArray = (
   return target.every((t, i) => isSameObject(t, prev[i]));
 };
 
+/**
+ * @internal
+ */
 export const toArray = <T>(items: T | T[]): T[] =>
   isArray(items) ? items : [items];
 
+/**
+ * @internal
+ */
 export const uniq = <T extends string | number>(items: T[]): T[] => {
   return Array.from(new Set(items));
 };

src/core/waapi.ts

@@ -41,6 +41,9 @@ export interface TypedKeyframeEffectOptions
   easing?: TypedEasing;
 }
 
+/**
+ * @internal
+ */
 export const getKeyframeKeys = (keyframes: TypedKeyframe[]): string[] =>
   uniq(keyframes.flatMap(getKeys)).reduce((acc, k) => {
     if (["offset", "easing", "composite"].includes(k)) {
@@ -55,6 +58,9 @@ export const getKeyframeKeys = (keyframes: TypedKeyframe[]): string[] =>
     return acc;
   }, [] as string[]);
 
+/**
+ * @internal
+ */
 export const createAnimation = (
   el: Element | null,
   keyframes: Keyframe[] | null,
@@ -83,6 +89,9 @@ export type PlayOptions = {
   restart?: boolean;
 };
 
+/**
+ * @internal
+ */
 export const _play = (animation: Animation, opts: PlayOptions = {}) => {
   // Reset reversed playback direction if completed
   if (animation.playbackRate < 0 && animation.playState === "finished") {
@@ -93,22 +102,41 @@ export const _play = (animation: Animation, opts: PlayOptions = {}) => {
   }
   animation.play();
 };
+
+/**
+ * @internal
+ */
 export const _reverse = (animation: Animation | undefined) => {
   if (!animation) return;
   animation.reverse();
 };
+
+/**
+ * @internal
+ */
 export const _cancel = (animation: Animation | undefined) => {
   if (!animation) return;
   animation.cancel();
 };
+
+/**
+ * @internal
+ */
 export const _finish = (animation: Animation | undefined) => {
   if (!animation) return;
   animation.finish();
 };
+
+/**
+ * @internal
+ */
 export const _pause = (animation: Animation | undefined) => {
   if (!animation) return;
   animation.pause();
 };
+// /**
+//  * @internal
+//  */
 // export const _persist = (
 //   animation: Animation | undefined,
 //   el: Element,
@@ -127,6 +155,9 @@ export const _pause = (animation: Animation | undefined) => {
 //   }
 //   animation.cancel();
 // };
+/**
+ * @internal
+ */
 export const _setTime = (
   animation: Animation | undefined,
   arg: number | ((endTime: number) => number)
@@ -137,6 +168,10 @@ export const _setTime = (
       ? arg(animation.effect!.getComputedTiming().endTime! as number)
       : arg;
 };
+
+/**
+ * @internal
+ */
 export const _setRate = (
   animation: Animation | undefined,
   arg: number | ((prevRate: number) => number)
@@ -148,6 +183,10 @@ export const _setRate = (
 };
 
 export type WaitingAnimationEventName = "finish" | "reverseFinish";
+
+/**
+ * @internal
+ */
 export const _waitFor = (
   animation: Animation | undefined,
   name: WaitingAnimationEventName

src/react/components/TransitionGroup.tsx

@@ -16,16 +16,23 @@ const toMap = (elements: ReactElement[]) =>
     return acc;
   }, {} as { [key: string]: ReactElement });
 
+/** @internal */
 export type TransitionState = "update" | "enter" | "exit";
+/** @internal */
 export const TransitionStateContext = createContext<TransitionState>("update");
 
+/** @internal */
 export const NOT_EXIT = 0;
+/** @internal */
 export const EXITING = 1;
+/** @internal */
 export const EXITED = 2;
+/** @internal */
 export type TransitionExitState =
   | typeof NOT_EXIT
   | typeof EXITING
   | typeof EXITED;
+/** @internal */
 export const TransitionNotifierContext =
   createContext<(state: TransitionExitState) => void>(noop);
 

src/react/hooks/state.ts

@@ -1,6 +1,9 @@
 import { isSameObject, isSameObjectArray } from "../../core/utils";
 import { createAnimation } from "../../core/waapi";
 
+/**
+ * @internal
+ */
 export interface AnimationObject {
   readonly _keyframes: Keyframe[];
   readonly _options: KeyframeEffectOptions | undefined;
@@ -9,7 +12,14 @@ export interface AnimationObject {
 
 const animations = new WeakMap<AnimationObject, Animation>();
 
+/**
+ * @internal
+ */
 export const getAnimation = (target: AnimationObject) => animations.get(target);
+
+/**
+ * @internal
+ */
 export const deleteAnimation = (target: AnimationObject) => {
   getAnimation(target)?.cancel();
   animations.delete(target);
@@ -22,6 +32,9 @@ const isEqual = (a: AnimationObject, b: AnimationObject): boolean => {
   );
 };
 
+/**
+ * @internal
+ */
 export const initAnimation = (
   el: Element,
   target: AnimationObject,

src/react/hooks/useIsomorphicLayoutEffect.ts

@@ -1,5 +1,8 @@
 import { useEffect, useLayoutEffect } from "react";
 
-// https://gist.github.com/gaearon/e7d97cdf38a2907924ea12e4ebdf3c85
+/**
+ * https://gist.github.com/gaearon/e7d97cdf38a2907924ea12e4ebdf3c85
+ * @internal
+ */
 export const useIsomorphicLayoutEffect =
   typeof window !== "undefined" ? useLayoutEffect : useEffect;

src/react/hooks/useLatestRef.ts

@@ -1,6 +1,9 @@
 import { useRef } from "react";
 import { useIsomorphicLayoutEffect } from "./useIsomorphicLayoutEffect";
 
+/**
+ * @internal
+ */
 export const useLatestRef = <T>(value: T) => {
   const ref = useRef<T>(value);
 

src/react/hooks/useStatic.ts

@@ -1,5 +1,8 @@
 import { useRef } from "react";
 
+/**
+ * @internal
+ */
 export const useStatic = <T>(init: () => T): T => {
   const ref = useRef<T>();
   return ref.current || (ref.current = init());

src/react/types/internal.ts

@@ -1,2 +1,4 @@
+/** @internal */
 export const SCROLL_TIMELINE = 1;
+/** @internal */
 export const VIEW_TIMELINE = 2;