@faststore/api 1.3.22 → 1.3.26

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 1.3.26 (2021-12-09)
+
+**Note:** Version bump only for package @faststore/api
+
+
+
+
+
+## 1.3.25 (2021-12-09)
+
+**Note:** Version bump only for package @faststore/api
+
+
+
+
+
+## 1.3.24 (2021-12-09)
+
+
+### Bug Fixes
+
+* fix UI storybook imports ([#1069](https://github.com/vtex/faststore/issues/1069)) ([e4a2402](https://github.com/vtex/faststore/commit/e4a2402235c60488fde7021bf3200d967af3cb83))
+
+
+
+
+
+## 1.3.23 (2021-12-09)
+
+**Note:** Version bump only for package @faststore/api
+
+
+
+
+
 ## 1.3.22 (2021-12-07)
 
 **Note:** Version bump only for package @faststore/api

package/README.md

@@ -1,115 +1,57 @@
-# @faststore/api
-
-The only API you need for building your next ecommerce. 
-
-This package defines a front-end first, GraphQL API inspired by clean architecture and schema.org. 
-
-GraphQL types defined in this repo extends and simplifies schema.org. This makes it easier to make your frontend search friendly.
-Also, by using the clean architecture, all types defined on this schema are not platform specific, but created to resolve an specific business case on your frontend, like rendering listprices, sellers etc.
-
-Alongside the GraphQL type definitions, we provide standard implementations for common ecommerce platforms. Currently we support:
-1. VTEX
-2. Maybe add yours? 
-
-With the typedefs and resolvers, you can create an executable schema and deploy anywhere you want. For instance, one use case would be:
-1. Create an Apollo Server instane on Heroku
-2. Run the executable schema in a function on Next.JS
-3. Run the executable schema during a Gatsby build.
-
-## Install
-
-```bash
+<p align="center">
+  <a href="https://faststore.dev">
+    <img alt="Faststore" src="../ui/static/logo.png" width="60" />
+  </a>
+</p>
+<h1 align="center">
+  FastStore API
+</h1>
+<p align="center">
+  <strong>
+    Connect to your favorite ecommerce platform
+  </strong>
+</p>
+
+<div style="display: flex; justify-content: center; width: 100%">
+  <a href="https://www.npmjs.com/package/@faststore/api" style="padding: 0px 2px 0px 0px">
+    <img src="https://badge.fury.io/js/%40faststore%2Fui.svg" />
+  </a>
+  <a href="https://bundlephobia.com/package/@faststore/api" style="padding: 0px 0px 0px 2px">
+    <img src="https://badgen.net/bundlephobia/dependency-count/@faststore/api" />
+  </a>
+</div>
+
+## Installation
+
+From the command line in your project directory, run yarn add `@faststore/api`.
+
+```cmd
 yarn add @faststore/api
 ```
-
 ## Usage
-GraphQL is very versatile and can run in many places. To setup the schema in an apollo server, just:
-```ts
-import { getSchema } from '@faststore/api'
-import { ApolloServer } from 'apollo-server'
-
-// Get the Store schema
-const schema = await getSchema({ platform: 'vtex', account: 'my-account', environment: 'vtexcommercestable' })
-
-// Setup Apollo Server
-const server = new ApolloServer({ schema });
 
-// The `listen` method launches a web server.
-server.listen().then(({ url }) => {
-  console.log(`🚀  Server ready at ${url}`);
-});
-```
-
-## Extending the schema
-GraphQL is a very versatile language. By using the exported `getSchema` function, you can not only extend the base schema but also redefine the whole resolvers implementation.
-
-To extend the schema, one can:
+With servers like express: 
 ```ts
+import { execute } from 'graphql'
 import { getSchema } from '@faststore/api'
-import { makeExecutableSchema, mergeSchemas } from '@graphql-tools/schema'
-import { ApolloServer } from 'apollo-server'
 
-// Setup type extensions
-const typeDefs = `
-extend type Product {
-  customField: String!
-}
-`
+import express from 'express'
 
-// Setup custom resolvers
-const resolvers = {
-  Product: {
-    customField: async () => {
-      ...
-      // Your code goes here
-      ...
-    }
-  }
-}
+const app = express()
 
-// Create custom schema
-const customSchema = makeExecutableSchema({ resolvers, typeDefs })
-const storeApiSchema = await getSchema({ platform: 'vtex', ...})
+app.get('/graphql', async (req, res) => {
+  const { query, operationName, variables } = req.body
 
-// Merge schemas into a final schema
-const finalSchema = mergeSchemas(schemas: [
-  storeApiSchema,
-  customSchema
-])
+  const result = await execute({
+    schema: await getSchema(),
+    variableValues: variables,
+    operationName
+  })
 
-// Setup Apollo Server
-const server = new ApolloServer({ schema });
-
-// The `listen` method launches a web server.
-server.listen().then(({ url }) => {
-  console.log(`🚀  Server ready at ${url}`);
-});
+  res.status(200)
+  res.send(result)
+})
 ```
 
-## Inline platform
-If your ecommerce platform is not supported you have two options.
-1. Make a contribution
-2. Create inline resolvers for your platform
-
-Inline resolves means you are going to write all resolvers for the api schema in your project or in an external library. This is recommended if you are supporting a niche platform and want to have full control over how each field is processed.
-
-To create your own resolvers, you can:
-```ts
-import { getTypeDefs } from '@faststore/api'
-import { ApolloServer } from 'apollo-server'
-import { makeExecutableSchema } from '@graphql-tools/schema'
-
-// Get the Store API TypeDefs
-const typeDefs = getTypeDefs()
-
-const resolvers = {
-  ...
-  // add your resolvers
-  ...
-}
-
-// Create a runnable schema
-const schema = makeExecutableSchema({ resolvers, typeDefs })
-
-// You now have a runnable GraphQL schema, you can create a server or run queries locally.
-```
+## Docs
+For more information, please refer to our documentation: https://faststore.dev/reference/api/overview

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.3.22",
+  "version": "1.3.26",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -42,5 +42,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "a7fdfbb393d0745ccc425b325746344975f70cae"
+  "gitHead": "f8ce80cf4bcdfd2d307cad3ae506bc1193f4c4d0"
 }