fix(middleware): export PersistOptions type definitions

[abraaoz]

No description provided.

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit b0fa90c:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration
Next.js	Configuration

[dai-shi]

It's somewhat intentional to not export some of types.
What is your issue without exporting those?

[abraaoz]

I must use the PersistOptions type from zustand/middleware in order to create my own persist middleware, like this:

import create, { State, StateCreator } from 'zustand';
import { persist, PersistOptions, StateStorage } from 'zustand/middleware';

export type Hydrated = {
  /**
   * Indicates whether the state has already been loaded from storage.
   * @see https://github.com/pmndrs/zustand/issues/346#issuecomment-915819674
   */
  hasHydrated?: boolean;
};

export type StateWithHydrated = State & Hydrated;

export type Migrations = {
  [timestamp: number]: (previousState: object, previousVersion: number) => object
};

export const createWithPersist = <TState extends StateWithHydrated> (
  createState: StateCreator<TState>,
  optionsWithMigrations: PersistOptions<TState> & { migrations: Migrations },
) => {
    // my implementation here...
};

[dai-shi]

I must use the PersistOptions type from zustand/middleware in order to create my own persist middleware

That sounds reasonable. Can you make the PR to only export PersistOptions?

btw, this should be possible too:

type PersistOptions = Parameters<typeof persist>[1]

[abraaoz]

I must use the PersistOptions type from zustand/middleware in order to create my own persist middleware

That sounds reasonable. Can you make the PR to only export PersistOptions?

btw, this should be possible too:

type PersistOptions = Parameters<typeof persist>[1]

Using Parameters<> looses the Generic in the type definition.
Example:

type PersistOptions = Parameters<typeof persist>[1];
const options: PersistOptions<TState> = ...; // ❌ does not work because it has generic

import { PersistOptions } from 'zustand/middleware';
const options: PersistOptions<TState> = ...; // ✔️ works, even with generic

[abraaoz]

"make the PR to only export PersistOptions"
done.

[dai-shi]

Using Parameters<> looses the Generic in the type definition.

Great point. I missed that.

[dai-shi]

Please run prettier and it's good to go.

[abraaoz]

Thank you @dai-shi !!