npm.io
1.0.0-beta.1 • Published 1 year ago

@piveau/sdk-vue

Licence
Apache-2.0
Version
1.0.0-beta.1
Deps
8
Size
1006 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

@piveau/sdk-vue

Asynchronous state management for interacting with piveau services in Vue.js.

Looking for a standalone API client? Try @piveau/sdk-core

Quick Features

  • Provides intelligent client-side caching, background updates, and optimistic updates of piveau backend data state in a declarative way, powered by @tanstack/vue-query
  • Composable utility functions to help you model real-world use cases easier, e.g., facets, search, and pagination
  • Runtime resource schema validation and model type inference powered by Zod
  • Shape data from API to your data model using getters
  • Vue 3 compatible
  • Supports Server-Side Rendering with Nuxt
  • Written with TypeScript

Usage

Node 20+, Vue 3

Install with npm/pnpm install @piveau/sdk-vue, or yarn add @piveau/sdk-vue. For better devtooling, we recommend installing @piveau/sdk-core and vue-query with npm/pnpm install @piveau/sdk-core @tanstack/vue-query@5.

Recommended: In main.ts, setup the plugin:

import { plugin } from '@piveau/sdk-vue'
import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query'
import { createApp } from 'vue'
import App from './App.vue'

const qc = new QueryClient()

const app = createApp(App)

app.use(VueQueryPlugin, {
  queryClient: qc,
})

app.use(plugin, {
  queryClient: qc,
})
Node 20+, Nuxt 3 *Work in Progress* See https://tanstack.com/query/latest/docs/framework/vue/guides/ssr and register the sdk-vue plugin as above

piveau API Support

  • /search/filter={filter} for searching resources
  • /search/{index}/{id} for fetching a single resource

Work in Progress

  • hub
  • consus
  • metrics
  • statistics