@faststore/api 1.11.8 → 1.12.6

package/dist/directives/cacheControl.d.ts

@@ -0,0 +1,9 @@
+import type { Directive } from "./index";
+export interface CacheControl {
+    sMaxAge?: number;
+    staleWhileRevalidate?: number;
+    scope?: string;
+}
+export declare const stringify: ({ scope, sMaxAge, staleWhileRevalidate }: CacheControl) => string;
+declare const directive: Directive;
+export default directive;

package/dist/directives/index.d.ts

@@ -0,0 +1,5 @@
+import { GraphQLSchema } from "graphql";
+export declare type Directive = {
+    typeDefs: string;
+    transformer: (schema: GraphQLSchema) => GraphQLSchema;
+};

package/dist/index.d.ts

@@ -1,8 +1,10 @@
 import type { Options as OptionsVTEX } from './platforms/vtex';
 export * from './__generated__/schema';
 export * from './platforms/errors';
+export { stringify as stringifyCacheControl } from './directives/cacheControl';
+export type { CacheControl } from './directives/cacheControl';
 export declare type Options = OptionsVTEX;
-export declare const getTypeDefs: () => string;
+export declare const getTypeDefs: () => string[];
 export declare const getResolvers: (options: Options) => {
     StoreCollection: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/commerce/types/Brand").Brand | (import("./platforms/vtex/clients/commerce/types/CategoryTree").CategoryTree & {
         level: number;

package/dist/platforms/vtex/index.d.ts

@@ -1,7 +1,7 @@
-import type { SearchArgs } from './clients/search';
 import type { Loaders } from './loaders';
 import type { Clients } from './clients';
 import type { Channel } from './utils/channel';
+import type { SearchArgs } from './clients/search';
 export interface Options {
     platform: 'vtex';
     account: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.11.8",
+  "version": "1.12.6",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "3775ec32d866149eb6519e68b7b2b977ffc0dace"
+  "gitHead": "74bbbc8c3573be89754ccb50b0d1bc135b332ca9"
 }

package/src/directives/cacheControl.ts

@@ -0,0 +1,76 @@
+import { getDirective, MapperKind, mapSchema } from "@graphql-tools/utils";
+import { GraphQLSchema } from "graphql";
+
+import type { Directive } from "./index";
+
+const NAME = "cacheControl";
+
+export interface CacheControl {
+  sMaxAge?: number;
+  staleWhileRevalidate?: number;
+  scope?: string;
+}
+
+export const stringify = (
+  { scope = "private", sMaxAge = 0, staleWhileRevalidate = 0 }: CacheControl,
+) =>
+  `${scope}, s-maxage=${sMaxAge}, stale-while-revalidate=${staleWhileRevalidate}`;
+
+const min = (a: number | undefined, b: number | undefined) => {
+  if (typeof a === "number" && typeof b === "number") {
+    return a > b ? b : a;
+  }
+
+  if (typeof a === "number") {
+    return a;
+  }
+
+  return b;
+};
+
+const minScope = (
+  a: string | undefined,
+  b: string | undefined,
+) => {
+  if (typeof a === "string" && typeof b === "string") {
+    return a === "public" && b === "public" ? "public" : "private";
+  }
+
+  return a || b;
+};
+
+const directive: Directive = {
+  typeDefs:
+    `directive @cacheControl(sMaxAge: Int, staleWhileRevalidate: Int, scope: String) on FIELD_DEFINITION`,
+  transformer: (schema: GraphQLSchema) =>
+    mapSchema(schema, {
+      [MapperKind.OBJECT_FIELD]: (fieldConfig) => {
+        const cacheControl = getDirective(schema, fieldConfig, NAME)?.[0] as
+          | CacheControl
+          | undefined;
+
+        if (cacheControl) {
+          const { sMaxAge, staleWhileRevalidate, scope } = cacheControl;
+
+          const resolver = fieldConfig.resolve
+
+          fieldConfig.resolve = (obj, args, ctx, info) => {
+            ctx.cacheControl = {
+              sMaxAge: min(ctx.cacheControl?.sMaxAge, sMaxAge),
+              staleWhileRevalidate: min(
+                ctx.cacheControl?.staleWhileRevalidate,
+                staleWhileRevalidate,
+              ),
+              scope: minScope(ctx.cacheControl?.scope, scope),
+            };
+
+            return resolver?.(obj, args, ctx, info);
+          };
+        }
+
+        return fieldConfig;
+      },
+    }),
+};
+
+export default directive;

package/src/directives/index.ts

@@ -0,0 +1,6 @@
+import { GraphQLSchema } from "graphql"
+
+export type Directive = {
+  typeDefs: string
+  transformer: (schema: GraphQLSchema) => GraphQLSchema
+}

package/src/index.ts

@@ -5,10 +5,14 @@ import {
   getResolvers as getResolversVTEX,
 } from './platforms/vtex'
 import { typeDefs } from './typeDefs'
+import cacheControlDirective from './directives/cacheControl'
+import type { Directive } from './directives'
 import type { Options as OptionsVTEX } from './platforms/vtex'
 
 export * from './__generated__/schema'
 export * from './platforms/errors'
+export { stringify as stringifyCacheControl } from './directives/cacheControl'
+export type { CacheControl } from './directives/cacheControl'
 
 export type Options = OptionsVTEX
 
@@ -19,7 +23,11 @@ const platforms = {
   },
 }
 
-export const getTypeDefs = () => typeDefs
+const directives: Directive[] = [
+  cacheControlDirective
+]
+
+export const getTypeDefs = () => [typeDefs, ...directives.map(d => d.typeDefs)]
 
 export const getResolvers = (options: Options) =>
   platforms[options.platform].getResolvers(options)
@@ -27,8 +35,11 @@ export const getResolvers = (options: Options) =>
 export const getContextFactory = (options: Options) =>
   platforms[options.platform].getContextFactory(options)
 
-export const getSchema = async (options: Options) =>
-  makeExecutableSchema({
+export const getSchema = async (options: Options) => {
+  const schema = makeExecutableSchema({
     resolvers: getResolvers(options),
-    typeDefs,
+    typeDefs: getTypeDefs(),
   })
+
+  return directives.reduce((s, d) => d.transformer(s), schema)
+}

package/src/platforms/vtex/index.ts

@@ -1,5 +1,4 @@
 import { getClients } from './clients'
-import type { SearchArgs } from './clients/search'
 import { getLoaders } from './loaders'
 import { StoreAggregateOffer } from './resolvers/aggregateOffer'
 import { StoreAggregateRating } from './resolvers/aggregateRating'
@@ -25,6 +24,7 @@ import ChannelMarshal from './utils/channel'
 import type { Loaders } from './loaders'
 import type { Clients } from './clients'
 import type { Channel } from './utils/channel'
+import type { SearchArgs } from './clients/search'
 
 export interface Options {
   platform: 'vtex'

package/src/typeDefs/query.graphql

@@ -176,6 +176,7 @@ type Query {
     """
     locator: [IStoreSelectedFacet!]!
   ): StoreProduct!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 
   """
   Returns the details of a collection based on the collection slug.
@@ -186,6 +187,7 @@ type Query {
     """
     slug: String!
   ): StoreCollection!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 
   """
   Returns the result of a product, facet, or suggestion search.
@@ -212,6 +214,7 @@ type Query {
     """
     selectedFacets: [IStoreSelectedFacet!]
   ): StoreSearchResult!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 
   """
   Returns information about all products.
@@ -220,12 +223,13 @@ type Query {
     """
     Product pagination argument, indicating how many items should be returned from the complete result list.
     """
-    first: Int!,
+    first: Int!
     """
     Product pagination argument, indicating the cursor corresponding with the item after which the items should be fetched.
     """
     after: String
   ): StoreProductConnection!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 
   """
   Returns information about all collections.
@@ -234,10 +238,11 @@ type Query {
     """
     Collection pagination argument, indicating how many items should be returned from the complete result list.
     """
-    first: Int!,
+    first: Int!
     """
     Collection pagination argument, indicating the cursor corresponding with the item after which the items should be fetched.
     """
     after: String
   ): StoreCollectionConnection!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 }