gsl-channel-details
TypeScript icon, indicating that this package has built-in type declarations

0.5.11 • Public • Published

Plugin de Channel Details Plugin Vendure

O plugin ChannelDetailsPlugin é uma extensão importante para a API do framework de e-commerce Vendure introduzindo a capacidade de recuperar informações detalhadas sobre um canal de vendas específico. Ao ser ativado, o plugin adiciona um novo tipo de dado chamado ChannelDetails ao esquema GraphQL da API. Esse tipo contém diversos campos relevantes, como código do canal, descrição, idiomas e moedas disponíveis, configurações de estoque, entre outros.

Além disso, o plugin implementa uma nova query chamada currentChannelDetails, que pode ser utilizada para recuperar os detalhes do canal atual. Para isso, ele utiliza um resolver personalizado, o ShopChannelDetailsResolver, que é responsável por acessar o serviço ChannelDetailsService. Este serviço, por sua vez, utiliza o TransactionalConnection para realizar consultas SQL personalizadas e buscar informações específicas do canal no banco de dados, como banners e endereços associados.

Com isso, o ChannelDetailsPlugin enriquece significativamente a experiência do usuário ao permitir o acesso a informações detalhadas sobre os canais de vendas, como banners e endereços, tudo de forma integrada e eficiente dentro do Gseller.

Após configurar o seu projeto Vendure, você pode usar este plugin via npm install:

npm install channel-details-plugin

e inclua-o no arquivo vendure-config conforme abaixo:


import { ChannelDetailsPlugin } from "channel-details-plugin";
...
export const config: VendureConfig = {
  ...
  plugins: [
    ...,
	ChannelDetailsPlugin
  ]
}

Os tipos, entradas e mutações atualizadas após a instalação do plugin são:

Shop Api Main Type

    type AddressChannelDetail {
       createdAt: DateTime
       updatedAt: DateTime
       deletedAt: DateTime
       fullName: String
       company: String
       streetLine1: String
       streetLine2: String
       city: String
       province: String
       postalCode: String
       country: String
       phoneNumber: String
       distributionCenter: Boolean
       neighborhood: String
       number: String
       id: ID
       channelId: ID
    }

    type ChannelDetails {
      createdAt: DateTime
      updatedAt: DateTime
      code: String
      token: String
      description: String
      defaultLanguageCode: String
      availableLanguageCodes: [String]
      defaultCurrencyCode: String
      availableCurrencyCodes: [String]
      trackInventory: Boolean
      outOfStockThreshold: Int
      pricesIncludeTax: Boolean
      channelId: ID
      sellerId: ID
      defaultTaxZoneId: ID
      defaultShippingZoneId: ID
      customFieldsLogoid: String
      banners: channelBannersByChannelResponse
      addresses: Address
    }

Shop Query

    extend type Query {
      currentChannelDetails: ChannelDetails
    }

Readme

Keywords

none

Package Sidebar

Install

npm i gsl-channel-details

Weekly Downloads

6

Version

0.5.11

License

ISC

Unpacked Size

22.5 kB

Total Files

23

Last publish

Collaborators

  • caiquereis