feathers-pinia

What's Changed

• fix: handle unpaginated find response by @jd1378 in https://github.com/marshallswain/feathers-pinia/pull/172

Full Changelog: https://github.com/marshallswain/feathers-pinia/compare/v4.5.3...v4.5.4

What's Changed

• Add support to pass params to create method. by @dallinbjohnson in https://github.com/marshallswain/feathers-pinia/pull/165
• fix: prevent client from emitting the events back to server by @jd1378 in https://github.com/marshallswain/feathers-pinia/pull/166
• fix: allow custom types for User and export AuthenticateData by @jd1378 in https://github.com/marshallswain/feathers-pinia/pull/168
• feat(normalize-find): provide default context.result for find by @MajesticPotatoe in https://github.com/marshallswain/feathers-pinia/pull/153

New Contributors

• @jd1378 made their first contribution in https://github.com/marshallswain/feathers-pinia/pull/166

Full Changelog: https://github.com/marshallswain/feathers-pinia/compare/v4.2.6...v4.4.1

It's possible that the nested dynamic computed is breaking reactivity. The nested computed has been replaced with a direct reference to the stored value in itemsById.

Some reactivity in Pinia breaks when you use reactive instead of ref. This update switched the byId object to use a ref to fix reactivity.

🎁 useBackup

The new useBackup utility is the opposite of working with clones. Instead of binding your form to a clone, you use
the original record. It keeps a copy, letting you call backup or restore to revert changes. The save method
auto-diffs from the backup, keeping data size to a minimum.

🎁 New Relationship Utilities

New methods have been added to the FeathersPinia Client. These utilities can be used inside setupInstance functions to
help form relationships between services:

• app.pushToStore pushes data into other service stores. It replaces storeAssociated.
• app.defineVirtualProperty sets up a virtual property on an object.
• app.defineVirtualProperties sets up many virtual properties on an object.

🔥 storeAssociated Deprecated

As of Feathers-Pinia v4.2, the storeAssociated utility has been replaced with a suite of smaller, more-flexible,
single-purpose utilities. See Data Modeling for the new way to store associated data.

🎁 Share Stores Between Services

The PiniaServiceConfig interface now accepts a storeName string. storeName {String} is the name of the store to use for the service. It defaults to service:${servicePath}. You can also use storeName to make two services share the same store.

🎁 Proxy Services

The PiniaServiceConfig interface now also accepts an instanceServicePath string. The instanceServicePath {String} overrides the service used for instance-level service methods, like patch, and remove. This is useful for "proxy" services. For example: pages/full loads the page record with populated data, but you want to patch/remove the record through the pages service.

Also New

• Expose the diff util: the internal diff utility is now available in the exports.

Fixes

• Fixes an issue with Cloudflare Workers compatibility (which do not support EventEmitter)
• The useFind internal watch now uses flush: 'sync' to prevent an infinite loop during SSR.

It turns out that faulty conditional was saving us from a more serious problem. It caused a large fire when my CPU went up in flames. Just kidding. It just wasn't a simple fix, after all.

Reverts the changes made in this release: https://github.com/marshallswain/feathers-pinia/releases/tag/v3.0.6

Intended to solve the find response not being handled, as described in this issue: https://github.com/marshallswain/feathers-pinia/issues/126

All @feathersjs/ packages have been updated to the latest versions. As a result, some internal types were updated to prevent errors when using the FeathersPinia client.

The documentation has also been updated to show how to ensure all FeathersPiniaService methods are available for untyped Feathers clients. See the "Common Pitfalls" section on this page: https://feathers-pinia.pages.dev/guide/common-patterns.html

The basic gist is that you need to provide a ServiceTypes generic when calling the feathers() function:

// import the FeathersService type
import { feathers, type FeathersService } from '@feathersjs/feathers'

// Create a ServiceTypes generic
type ServiceTypes = Record<string, FeathersService>

// Provide `ServiceTypes` in angle brackets before the parentheses
const feathersClient = feathers<ServiceTypes>()

The included feathers-ofetch adapter was swallowing Feathers errors and turning them into a plain text error. Now the full error from the server is correctly returned from requests.

This didn't have any effect on WebSocket communication, which did not experience the error.

There are no practical changes for existing users, but this release improves compatibility with some Node.js versions and WebContainers.

Many thanks to @FossPrime! ❤️

This release moves all @feathersjs packages to peerDependencies to fix an issue where Types are out of sync every time a new FeathersJS release is published.

Nothing really noteworthy. Move along. 😁

This release dramatically simplifies Feathers-Pinia. It applies all best practices from 1.0 and the 2.0 refactor, but basically implicitly does it all for you without getting in the way. All of these changes are encompassed in this release:

• v3.0.0-pre.17: 🎁 Integrated Storage Sync
• v3.0.0-pre.16: 🐜 bugfix for hybrid useFind after removing an item
• v3.0.0-pre.15: useFind's find is back, new defaultLimit option
• v3.0.0-pre.14: 🐜 allLocalData bug fixes
• v3.0.0-pre.13: 🐜 Fix pending state during pagination
• v3.0.0-pre.12: 🎁 Initial Hybrid Pagination with useFind
• v3.0.0-pre.11: 🐜 Fix useAuth Custom Types, update packages
• v3.0.0-pre.10: 🎁 storeRelated utility distributes data into correct service stores
• v3.0.0-pre.9: 🎁 Service Store Customizations
• v3.0.0-pre.8: 🐜 Fix Application type
• v3.0.0-pre.7: 🐜 Fix useFind not allowing pagination in local mode
• v3.0.0-pre.6: 🎁 Standalone Data Stores
• v3.0.0-pre.5: 🎁 Global setupInstance and configuration merging
• v3.0.0-pre.4: 🎁 Bring back auto-imports preset
• v3.0.0-pre.3: 🐜 Finish stabilizing SSR rendering with useFind
• v3.0.0-pre.2: 🚀 Implement Service events and an API name Change
• v3.0.0-pre.1: 🎁 First 3.0 release: leading to a simple life

The syncWithStorage plugin is now built in and can be enabled in the createPiniaClient configuration.

Here are some examples. Read more in the documentation:

• Configuration
• syncWithStorage

Sync All Service Data

Here's how to set it up for the entire Feathers-Pinia client instance:

export const api = createPiniaClient(feathersClient, {
  idField: '_id',
  pinia,
  syncWithStorage: true,
  storage: window.localStorage,
})

Note that you must provide the global-only storage option AND the syncWithStorage option to enable the feature.

Sync Individual Service Data

Here's how to enable storage sync for a single service:

export const api = createPiniaClient(feathersClient, {
  idField: '_id',
  pinia,
  syncWithStorage: false,
  storage: window.localStorage,
  services: {
    'my-service': {
      syncWithStorage: true
    }
  }
})

Customize Storage Keys

You can customize which store keys are synchronized to storage by passing an array to syncWithStorage. You must
provide all keys, since this will override the default value, which is ['itemsById', 'pagination'].

export const api = createPiniaClient(feathersClient, {
  idField: '_id',
  pinia,
  syncWithStorage: ['itemsById', 'pagination', 'tempsById'],
  storage: window.localStorage,
})

Fixes a bug where removing an item would cause a temporary item to be created in its place. Only applies to useFind with paginateOn: 'hybrid'

🎁 new defaultLimit option

A new defaultLimit option lets you change the default query $limit to something other than 10.

useFind's find util functionality restored

🐜 The params are now cached and called internally when you call find without any params.

allLocalData now shows the correct data during pending state.

The correct data is now shown while switching pages during pagination.

Breaking Change

The paginateOnServer option has been changed to paginateOn: 'server'.

paginateOn offers three modes

• client is the current default. It's the same as the previous paginateOnServer: false.
• server is the same as the previous paginateOnServer: true.
• hybrid is a combination of server and client. It pulls one page at a time from the server while maintaining live lists.

Hybrid Pagination with useFind

Enable hybrid pagination on useFind by setting paginateOn: 'hybrid'. Then you can enjoy server-paginated data while still enjoying live lists.

Implementation Summary

Hybrid pagination works similar to server pagination. It keeps track of the current query and the records that were received for it. It then uses the first returned record as a checkpoint while analyzing the $skip in the query. Here are some starting-point scenarios of how it behaves:

• $limit: 10, $skip: 0 will return the first page of results. New results that sort to the top of the list will appear as normal for client pagination.
• $limit: 10, $skip: 10 will return the second page of results from the server. useFind will recognize that we don't have any records in the store that come before the first record in the current page. This means there's an empty ten-record buffer that needs to be filled before the realtime data will update the live list. This will be made more accurate in the future by watching for created and patched events that come in and adjusting the buffer, accordingly.

See more details in the test file: https://github.com/marshallswain/feathers-pinia/blob/v3/tests/use-find-get/use-find-hybrid.test.ts

Fix useAuth Custom Types

You can now completely replace AuthenticateData with a custom type. TypeScript no longer throws a fit when you do this:

interface AuthenticateData {
  strategy: 'jwt' | 'local' | 'ldap'
  accessToken?: string
  tuid?: string
  password?: string
}

defineStore('auth', () => {
  const utils = useAuth<AuthenticateData>({ api }) // custom type passed in the generic
  utils.reAuthenticate()
  return { ...utils }
})

Update packages

Upgrades to the latest FeathersJS release and fixes breaking changes in the latest Vitest update.