@reactionary/provider-fake 0.0.59 → 0.0.60

package/README.md

@@ -1,7 +1,23 @@
-# Fake
+# Fake provider for Reactionary
 
-This library was generated with [Nx](https://nx.dev).
+## Supports
 
-## Building
 
-Run `nx build provider-fake` to build the library.
+
+| Feature | Support | Notes |
+| -----------   | ----------- | --------- |
+| product       | Full      |          |
+| productSearch | Full     |  |
+| identity | Full     | |
+| cart | Full     |  |
+| checkout | Planned     |  |
+| order | Planned     |  |
+| inventory | Full     |  |
+| price | Full   |  |
+| category | Full     |  |
+| store | Full    |  |
+
+
+## Notes
+
+Not as many different product names as we would have liked. Maybe we need to create our own faker test data.

package/core/initialize.js

@@ -1,14 +1,15 @@
 import {
   ProductSchema,
-  SearchResultSchema,
+  ProductSearchResultSchema,
   CategorySchema,
   CartSchema,
   InventorySchema,
   StoreSchema,
-  PriceSchema
+  PriceSchema,
+  ProductSearchResultItemSchema
 } from "@reactionary/core";
 import { FakeProductProvider } from "../providers/product.provider.js";
-import { FakeSearchProvider } from "../providers/search.provider.js";
+import { FakeSearchProvider } from "../providers/product-search.provider.js";
 import { FakeCategoryProvider } from "../providers/category.provider.js";
 import {
   FakeCartProvider,
@@ -26,10 +27,10 @@ function withFakeCapabilities(configuration, capabilities) {
         cache
       );
     }
-    if (capabilities.search) {
-      client.search = new FakeSearchProvider(
+    if (capabilities.productSearch) {
+      client.productSearch = new FakeSearchProvider(
         configuration,
-        SearchResultSchema,
+        ProductSearchResultItemSchema,
         cache
       );
     }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@reactionary/provider-fake",
-  "version": "0.0.59",
+  "version": "0.0.60",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {
-    "@reactionary/core": "0.0.59",
+    "@reactionary/core": "0.0.60",
     "zod": "4.1.9",
     "@faker-js/faker": "^9.8.0"
   },

package/providers/cart.provider.js

@@ -47,7 +47,7 @@ class FakeCartProvider extends CartProvider {
     const cartId = payload.cart.key || `cart-${this.generator.string.uuid()}`;
     const cart = await this.getById({ cart: { key: cartId } }, reqCtx);
     const existingItemIndex = cart.items.findIndex(
-      (item) => item.sku.key === payload.sku.key
+      (item) => item.variant.sku === payload.variant.sku
     );
     if (existingItemIndex >= 0) {
       cart.items[existingItemIndex].quantity += payload.quantity;
@@ -55,7 +55,7 @@ class FakeCartProvider extends CartProvider {
       const price = this.generator.number.int({ min: 100, max: 1e5 }) / 100;
       cart.items.push({
         identifier: { key: `item-${Date.now()}` },
-        sku: payload.sku,
+        variant: payload.variant,
         quantity: payload.quantity,
         price: {
           unitPrice: {
@@ -77,7 +77,7 @@ class FakeCartProvider extends CartProvider {
           }
         },
         product: {
-          key: `product-for-${payload.sku.key}`
+          key: `product-for-${payload.variant.sku}`
         }
       });
     }

package/providers/index.js

@@ -5,5 +5,5 @@ export * from "./identity.provider.js";
 export * from "./inventory.provider.js";
 export * from "./price.provider.js";
 export * from "./product.provider.js";
-export * from "./search.provider.js";
+export * from "./product-search.provider.js";
 export * from "./store.provider.js";

package/providers/inventory.provider.js

@@ -1,4 +1,5 @@
 import {
+  InventoryIdentifierSchema,
   InventoryProvider
 } from "@reactionary/core";
 import { base, en, Faker } from "@faker-js/faker";
@@ -9,7 +10,7 @@ class FakeInventoryProvider extends InventoryProvider {
   }
   async getBySKU(payload, _reqCtx) {
     let hash = 0;
-    const skuString = payload.sku.key;
+    const skuString = payload.variant.sku;
     for (let i = 0; i < skuString.length; i++) {
       hash = (hash << 5) - hash + skuString.charCodeAt(i);
       hash = hash & hash;
@@ -19,10 +20,10 @@ class FakeInventoryProvider extends InventoryProvider {
       locale: [en, base]
     });
     const model = this.newModel();
-    model.identifier = {
-      sku: payload.sku,
+    model.identifier = InventoryIdentifierSchema.parse({
+      variant: payload.variant,
       fulfillmentCenter: payload.fulfilmentCenter
-    };
+    });
     model.sku = skuString;
     model.quantity = generator.number.int({ min: 0, max: 100 });
     if (model.quantity > 0) {

package/providers/price.provider.js

@@ -13,11 +13,11 @@ class FakePriceProvider extends PriceProvider {
     return result;
   }
   async getBySKU(payload, _reqCtx) {
-    if (payload.sku.key === "unknown-sku") {
-      return this.createEmptyPriceResult(payload.sku.key, _reqCtx.languageContext.currencyCode);
+    if (payload.variant.sku === "unknown-sku") {
+      return this.createEmptyPriceResult(payload.variant.sku, _reqCtx.languageContext.currencyCode);
     }
     let hash = 0;
-    const skuString = payload.sku.key;
+    const skuString = payload.variant.sku;
     for (let i = 0; i < skuString.length; i++) {
       hash = (hash << 5) - hash + skuString.charCodeAt(i);
       hash = hash & hash;
@@ -29,7 +29,7 @@ class FakePriceProvider extends PriceProvider {
     const model = this.newModel();
     Object.assign(model, {
       identifier: {
-        sku: payload.sku
+        variant: payload.variant
       },
       unitPrice: {
         value: generator.number.int({ min: 300, max: 1e5 }) / 100,
@@ -38,7 +38,7 @@ class FakePriceProvider extends PriceProvider {
       meta: {
         cache: {
           hit: false,
-          key: payload.sku.key
+          key: payload.variant.sku
         },
         placeholder: false
       }

package/providers/product-search.provider.js

@@ -0,0 +1,135 @@
+import {
+  ImageSchema,
+  ProductSearchProvider,
+  ProductSearchResultItemSchema,
+  ProductSearchResultSchema
+} from "@reactionary/core";
+import { Faker, en, base } from "@faker-js/faker";
+import { jitter } from "../utilities/jitter.js";
+class FakeSearchProvider extends ProductSearchProvider {
+  constructor(config, schema, cache) {
+    super(schema, cache);
+    this.config = config;
+  }
+  async queryByTerm(payload, _reqCtx) {
+    await jitter(this.config.jitter.mean, this.config.jitter.deviation);
+    const query = payload.search;
+    const querySpecificity = 20 - query.term.length - query.paginationOptions.pageNumber - query.facets.length;
+    const totalProducts = 10 * querySpecificity;
+    const totalPages = Math.ceil(totalProducts / query.paginationOptions.pageSize);
+    const productsOnPage = Math.min(totalProducts, query.paginationOptions.pageSize);
+    const productGenerator = new Faker({
+      seed: querySpecificity,
+      locale: [en, base]
+    });
+    const facetGenerator = new Faker({
+      seed: 100,
+      locale: [en, base]
+    });
+    const products = new Array();
+    const facets = new Array();
+    for (let i = 0; i < productsOnPage; i++) {
+      const srcUrl = productGenerator.image.urlPicsumPhotos({
+        height: 300,
+        width: 300,
+        grayscale: true,
+        blur: 8
+      });
+      const img = ImageSchema.parse({
+        sourceUrl: srcUrl,
+        altText: "Fake product image",
+        height: 300,
+        width: 300
+      });
+      products.push(
+        ProductSearchResultItemSchema.parse(
+          {
+            identifier: {
+              key: "product_" + productGenerator.commerce.isbn()
+            },
+            image: img,
+            name: productGenerator.commerce.productName(),
+            slug: productGenerator.lorem.slug(),
+            variants: [{
+              variant: {
+                sku: productGenerator.commerce.isbn()
+              },
+              image: img,
+              options: void 0
+            }]
+          }
+        )
+      );
+    }
+    const facetBase = ["color", "size"];
+    for (const base2 of facetBase) {
+      const facet = {
+        identifier: {
+          key: base2
+        },
+        name: base2,
+        values: []
+      };
+      for (let i = 0; i < 10; i++) {
+        const valueKey = i.toString();
+        const isActive = query.facets.find(
+          (x) => x.facet.key === facet.identifier.key && x.key === valueKey
+        ) !== void 0;
+        facet.values.push({
+          active: isActive,
+          count: facetGenerator.number.int({ min: 1, max: 50 }),
+          identifier: {
+            facet: {
+              key: facet.identifier.key
+            },
+            key: valueKey
+          },
+          name: facetGenerator.color.human()
+        });
+      }
+      facets.push(facet);
+    }
+    const result = ProductSearchResultSchema.parse({
+      identifier: {
+        term: query.term,
+        paginationOptions: {
+          pageNumber: query.paginationOptions.pageNumber,
+          pageSize: query.paginationOptions.pageSize
+        },
+        facets: query.facets,
+        filters: []
+      },
+      facets,
+      items: products,
+      pageNumber: query.paginationOptions.pageNumber,
+      pageSize: query.paginationOptions.pageSize,
+      totalCount: totalProducts,
+      totalPages,
+      meta: {
+        cache: {
+          hit: false,
+          key: ""
+        },
+        placeholder: false
+      }
+    });
+    const foo = this.childFunction();
+    return result;
+  }
+  parseFacetValue(facetValueIdentifier, label, count, reqCtx) {
+    throw new Error("Method not implemented.");
+  }
+  parseFacet(facetIdentifier, facetValue, reqCtx) {
+    throw new Error("Method not implemented.");
+  }
+  parseVariant(variant, product, reqCtx) {
+    throw new Error("Method not implemented.");
+  }
+  childFunction() {
+    const foo = 42;
+    return foo;
+  }
+}
+export {
+  FakeSearchProvider
+};

package/schema/capabilities.schema.js

@@ -1,7 +1,7 @@
 import { CapabilitiesSchema } from "@reactionary/core";
 const FakeCapabilitiesSchema = CapabilitiesSchema.pick({
   product: true,
-  search: true,
+  productSearch: true,
   identity: true,
   category: true,
   cart: true,

package/src/core/initialize.d.ts

@@ -1,12 +1,12 @@
-import type { Cache as ReactinaryCache, ProductProvider, SearchProvider, IdentityProvider, CategoryProvider, CartProvider, InventoryProvider, StoreProvider, PriceProvider } from '@reactionary/core';
+import type { Cache as ReactinaryCache, ProductProvider, ProductSearchProvider, IdentityProvider, CategoryProvider, CartProvider, InventoryProvider, StoreProvider, PriceProvider } from '@reactionary/core';
 import type { FakeConfiguration } from '../schema/configuration.schema.js';
 import type { FakeCapabilities } from '../schema/capabilities.schema.js';
 type FakeClient<T extends FakeCapabilities> = (T['cart'] extends true ? {
     cart: CartProvider;
 } : object) & (T['product'] extends true ? {
     product: ProductProvider;
-} : object) & (T['search'] extends true ? {
-    search: SearchProvider;
+} : object) & (T['productSearch'] extends true ? {
+    productSearch: ProductSearchProvider;
 } : object) & (T['identity'] extends true ? {
     identity: IdentityProvider;
 } : object) & (T['category'] extends true ? {

package/src/providers/index.d.ts

@@ -5,5 +5,5 @@ export * from './identity.provider.js';
 export * from './inventory.provider.js';
 export * from './price.provider.js';
 export * from './product.provider.js';
-export * from './search.provider.js';
+export * from './product-search.provider.js';
 export * from './store.provider.js';

package/src/providers/product-search.provider.d.ts

@@ -0,0 +1,14 @@
+import { ProductSearchProvider } from '@reactionary/core';
+import type { ProductSearchResult, ProductSearchResultFacet, ProductSearchResultItem, Cache as ReactionaryCache, FacetIdentifier, FacetValueIdentifier, ProductSearchResultFacetValue, ProductSearchResultItemVariant } from '@reactionary/core';
+import type { RequestContext, ProductSearchQueryByTerm } from '@reactionary/core';
+import type z from 'zod';
+import type { FakeConfiguration } from '../schema/configuration.schema.js';
+export declare class FakeSearchProvider<T extends ProductSearchResultItem = ProductSearchResultItem> extends ProductSearchProvider<T> {
+    protected config: FakeConfiguration;
+    constructor(config: FakeConfiguration, schema: z.ZodType<T>, cache: ReactionaryCache);
+    queryByTerm(payload: ProductSearchQueryByTerm, _reqCtx: RequestContext): Promise<ProductSearchResult>;
+    protected parseFacetValue(facetValueIdentifier: FacetValueIdentifier, label: string, count: number, reqCtx: RequestContext): ProductSearchResultFacetValue;
+    protected parseFacet(facetIdentifier: FacetIdentifier, facetValue: unknown, reqCtx: RequestContext): ProductSearchResultFacet;
+    protected parseVariant(variant: unknown, product: unknown, reqCtx: RequestContext): ProductSearchResultItemVariant;
+    protected childFunction(): number;
+}

package/src/schema/capabilities.schema.d.ts

@@ -3,10 +3,10 @@ export declare const FakeCapabilitiesSchema: z.ZodObject<{
     price: z.ZodOptional<z.ZodBoolean>;
     product: z.ZodOptional<z.ZodBoolean>;
     identity: z.ZodOptional<z.ZodBoolean>;
-    search: z.ZodOptional<z.ZodBoolean>;
     cart: z.ZodOptional<z.ZodBoolean>;
     inventory: z.ZodOptional<z.ZodBoolean>;
     category: z.ZodOptional<z.ZodBoolean>;
     store: z.ZodOptional<z.ZodBoolean>;
+    productSearch: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$loose>;
 export type FakeCapabilities = z.infer<typeof FakeCapabilitiesSchema>;

package/providers/search.provider.js

@@ -1,99 +0,0 @@
-import {
-  SearchProvider
-} from "@reactionary/core";
-import { Faker, en, base } from "@faker-js/faker";
-import { jitter } from "../utilities/jitter.js";
-class FakeSearchProvider extends SearchProvider {
-  constructor(config, schema, cache) {
-    super(schema, cache);
-    this.config = config;
-  }
-  async queryByTerm(payload, _reqCtx) {
-    await jitter(this.config.jitter.mean, this.config.jitter.deviation);
-    const query = payload.search;
-    const querySpecificity = 20 - query.term.length - query.page - query.facets.length;
-    const totalProducts = 10 * querySpecificity;
-    const totalPages = Math.ceil(totalProducts / query.pageSize);
-    const productsOnPage = Math.min(totalProducts, query.pageSize);
-    const productGenerator = new Faker({
-      seed: querySpecificity,
-      locale: [en, base]
-    });
-    const facetGenerator = new Faker({
-      seed: 100,
-      locale: [en, base]
-    });
-    const products = new Array();
-    const facets = new Array();
-    for (let i = 0; i < productsOnPage; i++) {
-      products.push({
-        identifier: {
-          key: productGenerator.commerce.isbn()
-        },
-        image: productGenerator.image.urlPicsumPhotos({
-          height: 300,
-          width: 300,
-          grayscale: true,
-          blur: 8
-        }),
-        name: productGenerator.commerce.productName(),
-        slug: productGenerator.lorem.slug()
-      });
-    }
-    const facetBase = ["color", "size"];
-    for (const base2 of facetBase) {
-      const facet = {
-        identifier: {
-          key: base2
-        },
-        name: base2,
-        values: []
-      };
-      for (let i = 0; i < 10; i++) {
-        const valueKey = i.toString();
-        const isActive = query.facets.find(
-          (x) => x.facet.key === facet.identifier.key && x.key === valueKey
-        ) !== void 0;
-        facet.values.push({
-          active: isActive,
-          count: facetGenerator.number.int({ min: 1, max: 50 }),
-          identifier: {
-            facet: {
-              key: facet.identifier.key
-            },
-            key: valueKey
-          },
-          name: facetGenerator.color.human()
-        });
-      }
-      facets.push(facet);
-    }
-    const result = {
-      pages: totalPages,
-      identifier: {
-        term: query.term,
-        page: query.page,
-        facets: query.facets,
-        pageSize: query.pageSize
-      },
-      facets,
-      products,
-      meta: {
-        cache: {
-          hit: false,
-          key: ""
-        },
-        placeholder: false
-      }
-    };
-    const foo = this.childFunction();
-    return this.schema.parse(result);
-  }
-  childFunction() {
-    const foo = 42;
-    return foo;
-  }
-}
-export {
-  FakeSearchProvider
-};

package/src/providers/search.provider.d.ts

@@ -1,11 +0,0 @@
-import { SearchProvider } from '@reactionary/core';
-import type { SearchResult, Cache as ReactionaryCache } from '@reactionary/core';
-import type { RequestContext, SearchQueryByTerm } from '@reactionary/core';
-import type z from 'zod';
-import type { FakeConfiguration } from '../schema/configuration.schema.js';
-export declare class FakeSearchProvider<T extends SearchResult = SearchResult> extends SearchProvider<T> {
-    protected config: FakeConfiguration;
-    constructor(config: FakeConfiguration, schema: z.ZodType<T>, cache: ReactionaryCache);
-    queryByTerm(payload: SearchQueryByTerm, _reqCtx: RequestContext): Promise<SearchResult>;
-    protected childFunction(): number;
-}