navigation-stack 0.5.2 → 0.6.0

package/test/redux/middleware/parseInputLocationMiddleware.test.js

@@ -1,62 +0,0 @@
-import ActionTypes from '../../../src/redux/ActionTypes';
-import parseInputLocationMiddleware from '../../../src/redux/middleware/parseInputLocationMiddleware';
-
-describe('parseInputLocationMiddleware', () => {
-  let next;
-  let dispatch;
-  beforeEach(() => {
-    next = sinon.spy();
-    dispatch = parseInputLocationMiddleware()(next);
-  });
-
-  it('should transform input location of PUSH action (`string` to `object`)', () => {
-    dispatch({
-      type: ActionTypes.PUSH,
-      payload: '/foo?bar=baz#qux',
-    });
-
-    expect(next).to.be.calledWith({
-      type: ActionTypes.PUSH,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        query: {
-          bar: 'baz',
-        },
-        hash: '#qux',
-      },
-    });
-  });
-
-  it('should transform input location of REPLACE action (`string` to `object`)', () => {
-    dispatch({
-      type: ActionTypes.REPLACE,
-      payload: '/foo?bar=baz#qux',
-    });
-
-    expect(next).to.be.calledWith({
-      type: ActionTypes.REPLACE,
-      payload: {
-        pathname: '/foo',
-        search: '?bar=baz',
-        query: {
-          bar: 'baz',
-        },
-        hash: '#qux',
-      },
-    });
-  });
-
-  it('should not affect other action', () => {
-    const UNKNOWN = 'UNKNOWN';
-    dispatch({
-      type: UNKNOWN,
-      payload: '/foo?bar=baz#qux',
-    });
-
-    expect(next).to.be.calledWith({
-      type: UNKNOWN,
-      payload: '/foo?bar=baz#qux',
-    });
-  });
-});

package/test/testUtil.js

@@ -1,3 +0,0 @@
-export function shouldWarn(about) {
-  console.warn.expected.push(about); // eslint-disable-line no-console
-}

package/types/data-storage/index.d.ts

@@ -1,35 +0,0 @@
-// TypeScript Version: 3.0
-
-import { Session } from '../index.d.js';
-
-export {};
-
-export type GenericValue =
-  | string
-  | number
-  | boolean
-  | Record<string, unknown>
-  | null
-  | undefined;
-
-export class DataStorage<
-  Key extends string = string,
-  Value extends GenericValue = GenericValue,
-> {
-  constructor(session: Session, options: { namespace: string });
-
-  get(key: Key): Value;
-
-  set(key: Key, value: Value): void;
-}
-
-export class LocationDataStorage<
-  Key extends string = string,
-  Value extends GenericValue = GenericValue,
-> {
-  constructor(session: Session, options: { namespace: string });
-
-  get(location: Location, key: Key): Value;
-
-  set(location: Location, key: Key, value: Value): void;
-}

package/types/redux/index.d.ts

@@ -1,90 +0,0 @@
-import { InputLocation, Session } from '../index.d.js';
-
-export interface CreateMiddlewaresOptions {
-  basePath?: string;
-}
-
-export function createMiddlewares(
-  session: Session,
-  options?: CreateMiddlewaresOptions,
-): Middleware[];
-
-export const ActionTypes: {
-  INIT: '@@navigation-stack/INIT';
-  PUSH: '@@navigation-stack/PUSH';
-  REPLACE: '@@navigation-stack/REPLACE';
-  NAVIGATE: '@@navigation-stack/NAVIGATE';
-  SHIFT: '@@navigation-stack/SHIFT';
-  UPDATE: '@@navigation-stack/UPDATE';
-  STOP: '@@navigation-stack/STOP';
-};
-
-export interface InitAction {
-  type: (typeof ActionTypes)['INIT'];
-  payload?: InputLocation;
-}
-
-export interface PushAction {
-  type: (typeof ActionTypes)['PUSH'];
-  payload: InputLocation;
-}
-
-export interface ReplaceAction {
-  type: (typeof ActionTypes)['REPLACE'];
-  payload: InputLocation;
-}
-
-export interface ShiftAction {
-  type: (typeof ActionTypes)['SHIFT'];
-  payload: number;
-}
-
-export interface DisposeAction {
-  type: (typeof ActionTypes)['STOP'];
-}
-
-export type Action =
-  | InitAction
-  | PushAction
-  | ReplaceAction
-  | ShiftAction
-  | DisposeAction;
-
-export const Actions: {
-  init(initialLocation?: InputLocation): InitAction;
-  push(location: InputLocation): PushAction;
-  replace(location: InputLocation): ReplaceAction;
-  shift(delta: number): ShiftAction;
-  stop(): DisposeAction;
-};
-
-export const locationReducer: Reducer<Location, Action>;
-
-// The following types are copy-pasted from `redux`.
-
-interface ReduxAction<T = any> {
-  type: T;
-}
-
-interface AnyAction extends ReduxAction {
-  // Allows any extra properties to be defined in an action.
-  [extraProps: string]: any;
-}
-
-interface Dispatch<A extends Action = AnyAction> {
-  <T extends A>(action: T): T;
-}
-
-interface MiddlewareAPI<D extends Dispatch = Dispatch, S = any> {
-  dispatch: D;
-  getState(): S;
-}
-
-interface Middleware<S = any, D extends Dispatch = Dispatch> {
-  (api: MiddlewareAPI<D, S>): (next: Dispatch) => (action: any) => any;
-}
-
-type Reducer<S = any, A extends Action = AnyAction> = (
-  state: S | undefined,
-  action: A,
-) => S;

package/types/scroll-position/index.d.ts

@@ -1,107 +0,0 @@
-// TypeScript Version: 3.0
-
-import { EnvironmentScrollPosition, Location, Session } from '../index.d.js';
-
-export { EnvironmentScrollPosition, Location, Session } from '../index.d.js';
-
-export {};
-
-export class ScrollPositionRestoration<
-  ScrollableContainer = any,
-  Anchor = any,
-> {
-  constructor(
-    session: Session<ScrollableContainer, Anchor>,
-
-    // `_options` are currently only used in tests.
-    _options?: {
-      // `_options._shouldSetPageScrollPositionOnLocationChange`
-      // isn't used in real life and is not part of the public API.
-      // It's only used in tests.
-      _shouldSetPageScrollPositionOnLocationChange?: (
-        location: Location,
-        prevLocation: Location | undefined,
-      ) => boolean;
-
-      // `_options._getSavedPageScrollPositionOnLocationChange`
-      // isn't used in real life and is not part of the public API.
-      // It's only used in tests.
-      _getSavedPageScrollPositionOnLocationChange?: (
-        location: Location,
-        prevLocation: Location | undefined,
-      ) => [number, number] | undefined;
-
-      // Using this option, a developer could theoretically provide their own implementation
-      // of setting a scroll position. For example, it could use "smooth" (animated) scrolling, etc.
-      // This could be part of the public API if anyone provided a sensible real-world use case for it.
-      _pageScrollPositionSetter?: ScrollPositionSetter<
-        ScrollableContainer,
-        Anchor
-      >;
-    },
-  );
-
-  addScrollableContainer(
-    scrollableContainerKey: string,
-    scrollableContainer: ScrollableContainer,
-
-    // `_options` are currently only used in tests.
-    _options?: {
-      // `_options._shouldSetScrollPositionOnLocationChange`
-      // isn't used in real life and is not part of the public API.
-      // It's only used in tests.
-      _shouldSetScrollPositionOnLocationChange?: (
-        location: Location,
-        prevLocation: Location | undefined,
-      ) => boolean;
-
-      // `_options._getSavedScrollPositionOnLocationChange`
-      // isn't used in real life and is not part of the public API.
-      // It's only used in tests.
-      _getSavedScrollPositionOnLocationChange?: (
-        location: Location,
-        prevLocation: Location | undefined,
-      ) => [number, number] | undefined;
-
-      // Using this option, a developer could theoretically provide their own implementation
-      // of setting a scroll position. For example, it could use "smooth" (animated) scrolling, etc.
-      // This could be part of the public API if anyone provided a sensible real-world use case for it.
-      _scrollPositionSetter: ScrollPositionSetter<ScrollableContainer, Anchor>;
-    },
-  ): () => void;
-
-  locationRendered: (location: Location) => Promise<void>;
-
-  stop(): void;
-
-  // `_enableSavingScrollPosition()` and `_disableSavingScrollPosition()`
-  // aren't used in real life and are not part of the public API.
-  // They're only used in tests.
-  _enableSavingScrollPosition(): void;
-
-  // `_enableSavingScrollPosition()` and `_disableSavingScrollPosition()`
-  // aren't used in real life and are not part of the public API.
-  // They're only used in tests.
-  _disableSavingScrollPosition(): void;
-}
-
-// Theoretically, a developer could pass their own `ScrollPositionSetter` implementation
-// when calling `.addScrollableContainer()` or
-export interface ScrollPositionSetter<ScrollableContainer, Anchor> {
-  // Sets scroll position of a page or a scrollable element.
-  // Returns a `Promise` that resolves when it has finished setting the scroll position.
-  set(
-    // When setting page scroll position, `scrollableContainer` is `undefined`.
-    // When setting scrollable element scroll position, `scrollableContainer` is the scrollable element.
-    scrollableContainer: ScrollableContainer,
-    // When setting page scroll position, it could be either an anchor or numeric coordinates.
-    // When setting scrollable element scroll position, it could only be numeric coordinates.
-    scrollPositionOrAnchor: Anchor | [number, number],
-    // `scrollPosition` provides the API for setting scroll position according to the environment.
-    // For example, `WebBrowserScrollPosition` provides the methods for setting scroll position in a web browser.
-    scrollPosition: EnvironmentScrollPosition<ScrollableContainer, Anchor>,
-  ): Promise<void>;
-
-  // Cancels any pending (or in-progress) setting of scroll position.
-  cancel(): void;
-}