glacier

BREAKING

• Renamed Result to ResultInit

Non breaking

• New Result type which follows wrapper.unwrap() pattern
• Result.from(init) converts a ResultInit into a Result
• Result.map(callback) maps the result data into another type
• Result.unwrap() returns the data or throws the error
• Result.rewrap(wrapper) transforms a wrapper (an object with unwrap()) into a Result
• Result.wrap(callback) and Result.wrapSync(callback) can wrap a throwable callback into a Result

Fixes

• Fixed a bug with normalization and storage

NO BREAKING CHANGE ✅

No new features or usage, lot of bugs were fixed but maybe new bugs arrived

BREAKING

• Renamed useQuery to useSchema (or useScrollSchema)
• Renamed useSingleQuery to useQuery

NOT BREAKING

• Allow schema factories to return undefined:

function getHello(socket?: WebSocket) {
  if (!socket) return

  return getSchema("hello", key => fetcher(key, socket))
}

BREAKING

• Made Core fields private

• removed tslib dependency

• BREAKING: error is no longer typed, it is always unknown, just like in a try-catch block
  Migration:

// previously
useSingleSchema<Data, Error, Key>(key, fetcher, params)

// now
useSingleSchema<Data, Key>(key, fetcher, params)

• BREAKING: serializer and normalizer are no longer allowed in global params
• less verbose type system
• removed all any types

• Optimistics now rollback to realData

• Fixed core mounting in React strict mode
  • Fixed garbage collection
  • Maybe other bugs?

• Unified Rollup config
• Updated deps
• modified react peer dependenct to >=17
• moved tslib as dependency

BREAKING CHANGE

• Result<D,E> is now stricter, you can either have data but no error, or error but no data

async function fetcher(url: string) {
  // ✅
  return { data: { name: "John Smith" } }

  // ✅
  return { error: new Error() }

  // ❌
  return { data: { name: "John Smith" }, error: new Error() }
}

• added Expo (React Native) example

moved test in another repo

• Added CodeSandbox

BREAKING CHANGES

• Renamed "Handle" to "Query"
• Renamed "Object" to "Instance"
• Renamed "use" to "useQuery"
• Renamed "single" to "getSingleSchema"
• Renamed "scroll" to "getScrollSchema"
• Renamed "useSingle" to "useSingleQuery"
• Renamed "useScroll" to "useScrollQuery"
• XSWR. is no longer needed (but still works)

Schemas become:

function getHelloSchema() {
  return getSingleSchema<Hello>("/api/hello", fetchAsJson)
}

Mixtures become:

function useAutoFetchMixture(query: Query) {
  useFetch(query)
  useVisible(query)
  useOnline(query)
}

Mixes become:

function useHelloMix() {
  const query = useQuery(getHelloSchema, [])
  useAutoFetchMixture(query)
  return query
}

NO BREAKING CHANGES

CHANGES

• Removed bunchee in favor of rollup => less bugs
• No longer bundled/minified => easier debugging
• Added source maps => easier debugging
• Moved tslib as peerDependency => reduced bundle size

NO BREAKING CHANGES

CHANGES

• type: module in package.json
• moved react as a peerDependency => reduced bundle size

CHANGES

• Updaters now yield Result instead of State: only allows data, error, and times (e.g. can't modify aborter in yield)
• Added new member realData in States, Handles and Objects: it allows you to get the real, non-optimistic data

• Updated deps
• Cleaned tsconfig
• Commits and releases are now GPG signed

CHANGES

• Update generator now can yield multiple optimistics:

user.update(async function* () {
  yield { data: "Naive optimistic data" } // data that we create on-the-fly from what we suppose it will look like
  const tx = await contract.doSomething(user.data) // make an Ethereum transaction
  yield { data: getUserDataFromLogs(tx) } // data that we expect before the transaction is mined
  const txr = await tx.wait() // wait for transaction mined
}, { timeout: 60 * 1000 })