@faststore/api 1.2.23

package/CHANGELOG.md

@@ -0,0 +1,333 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.2.23 (2021-10-27)
+
+
+### Features
+
+* **store-ui:** Add carousel tablist keyboard behavior ([#996](https://github.com/vtex/faststore/issues/996)) ([9081584](https://github.com/vtex/faststore/commit/908158460028009aaaa4ebbcd22eefab59e9bff8))
+
+
+
+
+
+## 1.2.22 (2021-10-26)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.21 (2021-10-26)
+
+
+### Features
+
+* **store-ui:** Form molecule ([#1004](https://github.com/vtex/faststore/issues/1004)) ([c584ef6](https://github.com/vtex/faststore/commit/c584ef693d111ede70d27730ecb3cce613b9aba3))
+
+
+
+
+
+## 1.2.20 (2021-10-26)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.19 (2021-10-25)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.18 (2021-10-25)
+
+
+### Features
+
+* **store-ui:** Breadcrumb molecule ([#986](https://github.com/vtex/faststore/issues/986)) ([325c738](https://github.com/vtex/faststore/commit/325c7387089d2f2c7152191b54fc3cb4918f1c68))
+
+
+
+
+
+## 1.2.17 (2021-10-21)
+
+
+### Features
+
+* **store-ui:** Loading Button molecule ([#962](https://github.com/vtex/faststore/issues/962)) ([6083ea0](https://github.com/vtex/faststore/commit/6083ea0273646a09e66ceedfab4b17c3960ac9fc)), closes [#918](https://github.com/vtex/faststore/issues/918) [#911](https://github.com/vtex/faststore/issues/911)
+
+
+### BREAKING CHANGES
+
+* **store-ui:** Remove deprecated folders (#927)
+
+
+
+
+
+## 1.2.16 (2021-10-21)
+
+
+### Features
+
+* **store-ui:** Label atom ([#1001](https://github.com/vtex/faststore/issues/1001)) ([3306ea6](https://github.com/vtex/faststore/commit/3306ea6b9b48996574eac4b8c1b737dff94a438e))
+
+
+
+
+
+## 1.2.15 (2021-10-21)
+
+
+### Bug Fixes
+
+* **store-ui:** Fix search-input a11y ([#1000](https://github.com/vtex/faststore/issues/1000)) ([f052f46](https://github.com/vtex/faststore/commit/f052f465e21aa4e2ca047327eeb0610b9b979f10))
+
+
+
+
+
+## 1.2.14 (2021-10-20)
+
+
+### Features
+
+* graphql-utils ([#998](https://github.com/vtex/faststore/issues/998)) ([bddf043](https://github.com/vtex/faststore/commit/bddf04308826369f86322851b554cc58ab5b2161))
+
+
+
+
+
+## 1.2.13 (2021-10-20)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.12 (2021-10-18)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.11 (2021-10-18)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.10 (2021-10-18)
+
+
+### Bug Fixes
+
+* **store-ui:** Component Architecture doc's code snippets ([#997](https://github.com/vtex/faststore/issues/997)) ([7f0d5f3](https://github.com/vtex/faststore/commit/7f0d5f307014f794063dd8d94d873478803888c0))
+
+
+
+
+
+## 1.2.9 (2021-10-18)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.8 (2021-10-15)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.7 (2021-10-15)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.6 (2021-10-15)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.5 (2021-10-15)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.4 (2021-10-14)
+
+
+### Features
+
+* **store-ui:** Accordion molecule ([#985](https://github.com/vtex/faststore/issues/985)) ([a35fb51](https://github.com/vtex/faststore/commit/a35fb51b675e41af6070da8b521a3a4da25a0d65))
+
+
+
+
+
+## 1.2.3 (2021-10-14)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.2 (2021-10-13)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.2.1 (2021-10-08)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.1.18 (2021-10-05)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.1.17 (2021-10-05)
+
+
+### Features
+
+* **store-api:** Add channel support for products ([#968](https://github.com/vtex/faststore/issues/968)) ([923d343](https://github.com/vtex/faststore/commit/923d343bcde8fbebfff9d32ba52ac26cd0504484))
+
+
+
+
+
+## 1.1.16 (2021-10-04)
+
+
+### Features
+
+* **store-api:** Add cart to store-api ([#963](https://github.com/vtex/faststore/issues/963)) ([0607d82](https://github.com/vtex/faststore/commit/0607d82f9f17de0b4045a7efbe99004d43e87056))
+
+
+
+
+
+## 1.1.15 (2021-10-01)
+
+
+### Features
+
+* Configure storybook theme ([#979](https://github.com/vtex/faststore/issues/979)) ([736811f](https://github.com/vtex/faststore/commit/736811f6381b4fd5f3f6d976198262216fe3ebcb))
+
+
+
+
+
+## 1.1.14 (2021-09-28)
+
+
+### Features
+
+* **store-ui:** Add Modal molecule ([#957](https://github.com/vtex/faststore/issues/957)) ([530b308](https://github.com/vtex/faststore/commit/530b3085a5707be459b37757844ce2e52b2f2981))
+
+
+
+
+
+## 1.1.13 (2021-09-23)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.1.12 (2021-09-22)
+
+
+### Bug Fixes
+
+* users were unable to develop a store in an account without CMS pages ([#969](https://github.com/vtex/faststore/issues/969)) ([7b28a4e](https://github.com/vtex/faststore/commit/7b28a4e0da1edec7e843a614339909c6565b220a))
+
+
+
+
+
+## 1.1.11 (2021-09-17)
+
+
+### Features
+
+* **store-ui:** Spinner atom ([#961](https://github.com/vtex/faststore/issues/961)) ([59034b7](https://github.com/vtex/faststore/commit/59034b726ac83c79f591cd24739a8c15316c92b3)), closes [#918](https://github.com/vtex/faststore/issues/918) [#911](https://github.com/vtex/faststore/issues/911)
+
+
+### BREAKING CHANGES
+
+* **store-ui:** Remove deprecated folders (#927)
+
+
+
+
+
+## 1.1.10 (2021-09-16)
+
+
+### Features
+
+* **store-api:** Add codegen ([#960](https://github.com/vtex/faststore/issues/960)) ([5231e6c](https://github.com/vtex/faststore/commit/5231e6c455be73b9d870627188c07a420651ed44))
+
+
+
+
+
+## 1.1.9 (2021-09-15)
+
+**Note:** Version bump only for package @vtex/store-api
+
+
+
+
+
+## 1.1.8 (2021-09-14)
+
+
+### Features
+
+* **store-api:** Store API TypeDefs ([#942](https://github.com/vtex/faststore/issues/942)) ([b440dc9](https://github.com/vtex/faststore/commit/b440dc9f023da82b5c443c465375e74f909d1b8d))

package/README.md

@@ -0,0 +1,115 @@
+# @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
+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:
+```ts
+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!
+}
+`
+
+// Setup custom resolvers
+const resolvers = {
+  Product: {
+    customField: async () => {
+      ...
+      // Your code goes here
+      ...
+    }
+  }
+}
+
+// Create custom schema
+const customSchema = makeExecutableSchema({ resolvers, typeDefs })
+const storeApiSchema = await getSchema({ platform: 'vtex', ...})
+
+// Merge schemas into a final schema
+const finalSchema = mergeSchemas(schemas: [
+  storeApiSchema,
+  customSchema
+])
+
+// 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}`);
+});
+```
+
+## 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.
+```