npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bildvitta/store-module

v1.0.0

Published

`StoreModule` é uma biblioteca para gerar *stores* genéricas de C.R.U.D. É compatível com [Pinia](https://pinia.vuejs.org/) e [Vuex](https://vuex.vuejs.org/), foi desenvolvida para substituir a antiga [VuexStoreModule](https://github.com/bildvitta/vuex-st

Downloads

98

Readme

StoreModule

StoreModule é uma biblioteca para gerar stores genéricas de C.R.U.D. É compatível com Pinia e Vuex, foi desenvolvida para substituir a antiga VuexStoreModule, que faz basicamente a mesma coisa com algumas mudanças porém só é compatível com o Vuex, uma vez que o Pinia é o gerenciador de estado de aplicação recomendado pela equipe do Vue.

Esta biblioteca faz o uso do StoreAdapter.

1. Instalando

npm i @bildvitta/store-module

2. Usando com Pinia

Para utilizar o StoreModule, você precisa inicializa-lo passando o adapter pinia e o apiService axios, exemplo:

  1. Crie um arquivo chamado store-module.js contendo:
import StoreModule from '@bildvitta/store-module'
import axios from 'axios'

const storeModule = new StoreModule({
  apiService: axios,
  adapter: 'pinia'
})

export default storeModule
  1. Após a inicialização, vamos criar uma store de usuários, para isto crie um arquivo users.js contendo:
import storeModule from 'caminho-do-arquivo-store-module.js' // arquivo que inicializamos o StoreModule
import { defineStore } from 'pinia'

export default defineStore('users', storeModule.createStoreModule('users'))
  1. Pronto, a store foi criada com sucesso! Agora vamos importar a store para ver como poderia utilizar ela.
import usersStore from 'caminho-do-arquivo-users.js' // arquivo que criamos nossa store de usuários.

const user = usersStore()

console.log(user) // user tem acesso a toda nossa store, com states, getters e actions.

2.1. Usando com Pinia e Asteroid

Para utilizar esta biblioteca com Pinia e Asteroid, é necessário algumas configurações adicionais, uma vez que o asteroid faz o uso das stores através de variáveis globais, $store quando é vuex (que é injetada automaticamente pelo próprio vuex), e $piniaStore quando é pinia (que é injetado manualmente pelo DefineGlobalPiniaStore).

  1. Instale a biblioteca StoreAdapter:
npm i @bildvitta/store-adapter
  1. Crie um boot chamado store-adapter (ou algum outro nome de sua preferencia), importe este boot no quasar.config.js.

  2. Importe o plugin DefineGlobalPiniaStore do StoreAdapter dentro do boot.

  3. Após isto, importe todas as stores criadas na aplicação dentro deste boot e adicione elas ao plugin DefineGlobalPiniaStore.

Exemplo de como deveria ficar seu boot store-adapter.js:

import { boot } from 'quasar/wrappers'
import { DefineGlobalPiniaStore } from '@bildvitta/store-adapter'
import users from 'caminho-do-arquivo-users.js'

export default boot(({ app }) => {
  app.use(DefineGlobalPiniaStore, {
    stores: {
      users
    }
  })
})

3. Usando com Vuex

  1. Como a biblioteca da compatibilidade tanto para pinia quanto para vuex, não existem mutations dentro de nossas stores pois não existe mutations no pinia, por isto, precisamos desativar o modo strict do vuex, para isto, vá até a inicialização do vuex e desative passando strict: false, exemplo:
export default store(function (/* { ssrContext } */) {
  const Store = createStore({
    modules: {},

    strict: false // ----------------------Aqui desativamos o strict!!!----------------------
  })

  return Store
})

Caso você não desative o strict, vai disparar vários erros avisando que existem states sendo mutado fora de mutations.

Error: [vuex] Do not mutate vuex store state outside mutation handlers

  1. Para utilizar o StoreModule com o vuex, você precisa inicializa-lo passando o adapter vuex e o apiService axios, para isto crie um arquivo chamado store-module.js contendo:
import StoreModule from '@bildvitta/store-module'
import axios from 'axios'

const storeModule = new StoreModule({
  apiService: axios,
  adapter: 'vuex'
})

export default storeModule
  1. Após a inicialização, vamos criar uma store de usuários, para isto crie um arquivo users.js contendo:
import storeModule from 'caminho-do-arquivo-store-module.js'

export default storeModule.createStoreModule('users')
  1. Após, isto vamos no arquivo onde foi inicializado o Vuex, vamos importar o users.js e adicionar ele dentro de modules:
import users from 'caminho-do-users.js'

export default store(function (/* { ssrContext } */) {
  const Store = createStore({
    modules: {
      users // ----------------------Aqui adicionamos o modulo users!!!----------------------
    },

    strict: false
  })

  return Store
})
  1. Pronto, a store foi criada com sucesso! Agora vamos importar a store para ver como poderia utilizar ela.
import usersStore from 'caminho-do-arquivo-users.js' // arquivo que criamos nossa store de usuários.

import { mapActions, mapGetters, mapState } from 'vuex' // para utilizar o vuex é a forma convencional

3.1. Usando com Vuex e Asteroid

Para utilizar esta biblioteca com Vuex e Asteroid, não é necessário nenhuma configuração adicional.

4. API

new StoreModule(options: StoreModuleOptions).createStoreModule(
  resource: string,
  options: ModuleOptions
): StoreModule
export interface StoreModuleOptions {
  // adapter da store: pinia | vuex
  adapter: StoreModuleAdapter

  // instancia do axios
  apiService: ApiService

  // opção para alterar chave identificadora para ser usado como chave primaria
  // configuração global, caso não seja configurado o padrão é "uuid"
  idKey: string

  // itens por listagem definidos na action "fetchList"
  // configuração global, caso não seja configurado o padrão é 12
  perPage: number
}

export interface ModuleOptions {
    // actions do vuex ou pinia adicionais
  actions: ExternalActions

  // callback para alterar a url da action "destroy" que tem como parâmetro "{ id }"
  destroyURL: RunCallbackFn<DestroyURL>

  // opção para alterar a url da action "fetchFieldOptions"
  fetchFieldOptionsURL: string

  // opção para alterar a url da action "fetchFilters"
  fetchFiltersURL: string

  // opção para alterar a url da action "fetchList"
  fetchListURL: string

  // callback para alterar a url da action "fetchSingle" que tem como parâmetro "{ form, id }"
  fetchSingleURL: RunCallbackFn<FetchSingleURL>

  // getters do vuex ou pinia adicionais
  getters: ExternalGetters

  // opção para alterar chave identificadora para ser usado como chave primaria
  // sobrescreve a configuração global, caso não seja configurado o padrão é
  // configurado global StoreModuleOptions.idKey ou "uuid"
  idKey: string

  // callback para alterar a url da action "update" que tem como parâmetro "{ id }"
  updateURL: RunCallbackFn<UpdateURL>

  // callback para alterar a url da action "replace" que tem como parâmetro "{ id }"
  replaceURL: RunCallbackFn<ReplaceURL>

  // opção para alterar a url da action "create"
  createURL: string

  // state do vuex ou pinia adicionais 
  state: ExternalState
}

export interface StoreModule {
  // se for vuex namespaced então tem o valor "true"
  namespaced?: boolean

  // state do pinia ou vuex
  state: () => State

  // getters do pinia ou vuex
  getters: Getters

  // actions do pinia ou vuex
  actions: FactoryActions
}

5. Estrutura da store gerada

state
├── list
├── filters
└── totalPages
getters
└── byId
actions
├── create
├── destroy
├── fetchFieldOptions
├── fetchFilters
├── fetchList
├── fetchSingle
├── update
└── replace

5.1 Declaração de tipos

5.1.1 State

export interface State {
  filters: ItemOfItem
  list: ItemOfItem[]
  totalPages: number
}

5.1.2 Getters

export interface Getters {
  byId: (state: State) => (id: string | number) => Item | undefined
}

5.1.3 Actions

export interface Actions {
  destroy: (payload: DestroyActionPayload) => Promise<AxiosResponse<DestroyApiResponse>>
  fetchFieldOptions: (payload: FetchFieldOptionsActionPayload) => Promise<AxiosResponse<FetchFieldOptionsApiResponse>>
  fetchFilters: (payload: FetchFiltersActionPayload) => Promise<AxiosResponse<FetchFiltersApiResponse>>
  fetchList: (payload: FetchListActionPayload) => Promise<AxiosResponse<FetchListApiResponse>>
  fetchSingle: (payload: FetchSingleActionPayload) => Promise<AxiosResponse<FetchSingleApiResponse>>
  update: (payload: UpdateActionPayload) => Promise<AxiosResponse<UpdateApiResponse>>
  replace: (payload: ReplaceActionPayload) => Promise<AxiosResponse<ReplaceApiResponse>>
  create: (payload: CreateActionPayload) => Promise<AxiosResponse<CreateApiResponse>>
}

Roadmap

  • [ ] Instalar eslint
  • [ ] Testes unitários (vitest)