@reactionary/core 0.2.19 → 0.3.1

package/client/client-builder.js

@@ -1,4 +1,5 @@
 import { NoOpCache } from "../cache/noop-cache.js";
+import { MulticastAnalyticsProvider } from "../providers/analytics.provider.js";
 import {
   RequestContextSchema
 } from "../schemas/session.schema.js";
@@ -36,14 +37,12 @@ class ClientBuilder {
         ...provider
       };
       if (provider.analytics) {
-        mergedAnalytics.push(...provider.analytics);
+        mergedAnalytics.push(provider.analytics);
       }
     }
-    if (mergedAnalytics.length > 0) {
-      client["analytics"] = mergedAnalytics;
-    }
     const completeClient = {
       ...client,
+      analytics: new MulticastAnalyticsProvider(sharedCache, this.context, mergedAnalytics),
       cache: sharedCache
     };
     return completeClient;

package/decorators/reactionary.decorator.js

@@ -135,7 +135,7 @@ function validateInput(input, schema) {
   if (!parse.success) {
     validated = error({
       type: "InvalidInput",
-      error: parse.error
+      error: JSON.stringify(z.flattenError(parse.error))
     });
   }
   return validated;
@@ -150,7 +150,7 @@ function validateOutput(output, schema) {
     if (!parse.success) {
       validated = error({
         type: "InvalidOutput",
-        error: parse.error
+        error: JSON.stringify(z.flattenError(parse.error))
       });
     }
   }

package/initialization.js

@@ -13,7 +13,13 @@ function createInitialRequestContext() {
       countyCode: "",
       cityCode: ""
     },
-    session: {},
+    session: {
+      identityContext: {
+        identifier: { userId: "" },
+        lastUpdated: /* @__PURE__ */ new Date(),
+        personalizationKey: crypto.randomUUID()
+      }
+    },
     correlationId: "",
     isBot: false,
     clientIp: "",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/core",
-  "version": "0.2.19",
+  "version": "0.3.1",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {

package/providers/analytics.provider.js

@@ -1,9 +1,70 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
 import { BaseProvider } from "./base.provider.js";
+import {
+  AnalyticsMutationSchema
+} from "../schemas/index.js";
+import { Reactionary } from "../decorators/reactionary.decorator.js";
 class AnalyticsProvider extends BaseProvider {
   getResourceName() {
     return "analytics";
   }
+  async track(event) {
+    switch (event.event) {
+      case "product-summary-view":
+        await this.processProductSummaryView(event);
+        break;
+      case "product-summary-click":
+        await this.processProductSummaryClick(event);
+        break;
+      case "product-details-view":
+        await this.processProductDetailsView(event);
+        break;
+      case "product-cart-add":
+        await this.processProductAddToCart(event);
+        break;
+      case "purchase":
+        await this.processPurchase(event);
+        break;
+    }
+  }
+  async processProductSummaryView(event) {
+  }
+  async processProductSummaryClick(event) {
+  }
+  async processProductDetailsView(event) {
+  }
+  async processProductAddToCart(event) {
+  }
+  async processPurchase(event) {
+  }
+}
+class MulticastAnalyticsProvider extends AnalyticsProvider {
+  constructor(cache, requestContext, providers) {
+    super(cache, requestContext);
+    this.providers = providers;
+  }
+  async track(event) {
+    for (const provider of this.providers) {
+      provider.track(event);
+    }
+  }
 }
+__decorateClass([
+  Reactionary({
+    inputSchema: AnalyticsMutationSchema
+  })
+], MulticastAnalyticsProvider.prototype, "track", 1);
 export {
-  AnalyticsProvider
+  AnalyticsProvider,
+  MulticastAnalyticsProvider
 };

package/schemas/errors/invalid-input.error.js

@@ -1,7 +1,7 @@
 import { z } from "zod";
 const InvalidInputErrorSchema = z.looseObject({
   type: z.literal("InvalidInput"),
-  error: z.ZodError
+  error: z.string()
 });
 export {
   InvalidInputErrorSchema

package/schemas/errors/invalid-output.error.js

@@ -1,7 +1,7 @@
 import { z } from "zod";
 const InvalidOutputErrorSchema = z.looseObject({
   type: z.literal("InvalidOutput"),
-  error: z.ZodError
+  error: z.string()
 });
 export {
   InvalidOutputErrorSchema

package/schemas/models/order.model.js

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { CartIdentifierSchema, CartItemIdentifierSchema, IdentityIdentifierSchema, OrderIdentifierSchema, OrderInventoryStatusSchema, OrderItemIdentifierSchema, OrderStatusSchema, ProductVariantIdentifierSchema } from "../models/identifiers.model.js";
+import { CartIdentifierSchema, IdentityIdentifierSchema, OrderIdentifierSchema, OrderInventoryStatusSchema, OrderItemIdentifierSchema, OrderStatusSchema, ProductVariantIdentifierSchema } from "../models/identifiers.model.js";
 import { BaseModelSchema } from "./base.model.js";
 import { AddressSchema } from "./profile.model.js";
 import { ShippingMethodSchema } from "./shipping-method.model.js";

package/schemas/mutations/analytics/index.js

@@ -0,0 +1,21 @@
+import z from "zod";
+import { AnalyticsMutationProductAddToCartEventSchema } from "./product-add-to-cart.mutation.js";
+import { AnalyticsMutationProductDetailsViewEventSchema } from "./product-details-view.mutation.js";
+import { AnalyticsMutationProductSummaryClickEventSchema } from "./product-summary-click.mutation.js";
+import { AnalyticsMutationProductSummaryViewEventSchema } from "./product-summary-view.mutation.js";
+import { AnalyticsMutationPurchaseEventSchema } from "./purchase.mutation.js";
+const AnalyticsMutationSchema = z.discriminatedUnion("event", [
+  AnalyticsMutationProductSummaryViewEventSchema,
+  AnalyticsMutationProductSummaryClickEventSchema,
+  AnalyticsMutationProductDetailsViewEventSchema,
+  AnalyticsMutationProductAddToCartEventSchema,
+  AnalyticsMutationPurchaseEventSchema
+]);
+export * from "./product-add-to-cart.mutation.js";
+export * from "./product-details-view.mutation.js";
+export * from "./product-summary-click.mutation.js";
+export * from "./product-summary-view.mutation.js";
+export * from "./purchase.mutation.js";
+export {
+  AnalyticsMutationSchema
+};

package/schemas/mutations/analytics/product-add-to-cart.mutation.js

@@ -0,0 +1,19 @@
+import z from "zod";
+import {
+  ProductSearchIdentifierSchema,
+  ProductIdentifierSchema
+} from "../../models/identifiers.model.js";
+import { BaseMutationSchema } from "../base.mutation.js";
+const AnalyticsMutationProductAddToCartEventSchema = BaseMutationSchema.extend({
+  event: z.literal("product-cart-add"),
+  source: z.discriminatedUnion("type", [
+    z.object({
+      type: z.literal("search"),
+      identifier: ProductSearchIdentifierSchema
+    })
+  ]).optional(),
+  product: ProductIdentifierSchema
+});
+export {
+  AnalyticsMutationProductAddToCartEventSchema
+};

package/schemas/mutations/analytics/product-details-view.mutation.js

@@ -0,0 +1,10 @@
+import z from "zod";
+import { ProductIdentifierSchema } from "../../models/identifiers.model.js";
+import { BaseMutationSchema } from "../base.mutation.js";
+const AnalyticsMutationProductDetailsViewEventSchema = BaseMutationSchema.extend({
+  event: z.literal("product-details-view"),
+  product: ProductIdentifierSchema
+});
+export {
+  AnalyticsMutationProductDetailsViewEventSchema
+};

package/schemas/mutations/analytics/product-summary-click.mutation.js

@@ -0,0 +1,20 @@
+import {
+  ProductIdentifierSchema,
+  ProductSearchIdentifierSchema
+} from "../../models/identifiers.model.js";
+import { BaseMutationSchema } from "../base.mutation.js";
+import { z } from "zod";
+const AnalyticsMutationProductSummaryClickEventSchema = BaseMutationSchema.extend({
+  event: z.literal("product-summary-click"),
+  product: ProductIdentifierSchema,
+  source: z.discriminatedUnion("type", [
+    z.object({
+      type: z.literal("search"),
+      identifier: ProductSearchIdentifierSchema
+    })
+  ]).optional(),
+  position: z.number().min(0)
+});
+export {
+  AnalyticsMutationProductSummaryClickEventSchema
+};

package/schemas/mutations/analytics/product-summary-view.mutation.js

@@ -0,0 +1,19 @@
+import {
+  ProductIdentifierSchema,
+  ProductSearchIdentifierSchema
+} from "../../models/identifiers.model.js";
+import { BaseMutationSchema } from "../base.mutation.js";
+import { z } from "zod";
+const AnalyticsMutationProductSummaryViewEventSchema = BaseMutationSchema.extend({
+  event: z.literal("product-summary-view"),
+  source: z.discriminatedUnion("type", [
+    z.object({
+      type: z.literal("search"),
+      identifier: ProductSearchIdentifierSchema
+    })
+  ]).optional(),
+  products: z.array(ProductIdentifierSchema)
+});
+export {
+  AnalyticsMutationProductSummaryViewEventSchema
+};

package/schemas/mutations/analytics/purchase.mutation.js

@@ -0,0 +1,10 @@
+import z from "zod";
+import { BaseMutationSchema } from "../base.mutation.js";
+import { OrderSchema } from "../../models/order.model.js";
+const AnalyticsMutationPurchaseEventSchema = BaseMutationSchema.extend({
+  event: z.literal("purchase"),
+  order: OrderSchema
+});
+export {
+  AnalyticsMutationPurchaseEventSchema
+};

package/schemas/mutations/index.js

@@ -1,4 +1,4 @@
-export * from "./analytics.mutation.js";
+export * from "./analytics/index.js";
 export * from "./base.mutation.js";
 export * from "./cart.mutation.js";
 export * from "./identity.mutation.js";

package/schemas/session.schema.js

@@ -1,11 +1,18 @@
 import { z } from "zod";
-import { WebStoreIdentifierSchema } from "./models/identifiers.model.js";
+import { IdentityIdentifierSchema, WebStoreIdentifierSchema } from "./models/identifiers.model.js";
 import { CurrencySchema } from "./models/currency.model.js";
 const LanguageContextSchema = z.looseObject({
   locale: z.string().default("en-US"),
   currencyCode: CurrencySchema.default(() => CurrencySchema.parse({}))
 });
-const SessionSchema = z.record(z.string(), z.any());
+const IdentityContextSchema = z.looseObject({
+  identifier: IdentityIdentifierSchema,
+  personalizationKey: z.string(),
+  lastUpdated: z.date()
+});
+const SessionSchema = z.record(z.string(), z.any()).and(z.object({
+  identityContext: IdentityContextSchema
+}));
 const TaxJurisdictionSchema = z.object({
   countryCode: z.string().default("US"),
   stateCode: z.string().default(""),
@@ -24,6 +31,7 @@ const RequestContextSchema = z.looseObject({
   referrer: z.string().default("").describe("The referrer URL, if available.")
 });
 export {
+  IdentityContextSchema,
   LanguageContextSchema,
   RequestContextSchema,
   SessionSchema,

package/src/client/client.d.ts

@@ -1,4 +1,3 @@
-import type { AnalyticsProvider } from "../providers/analytics.provider.js";
 import type { ProductProvider } from "../providers/product.provider.js";
 import type { ProductSearchProvider } from "../providers/product-search.provider.js";
 import type { IdentityProvider } from '../providers/identity.provider.js';
@@ -7,7 +6,7 @@ import type { PriceProvider } from "../providers/price.provider.js";
 import type { InventoryProvider } from "../providers/inventory.provider.js";
 import type { Cache } from "../cache/cache.interface.js";
 import type { CategoryProvider } from "../providers/category.provider.js";
-import type { CheckoutProvider, OrderProvider, ProfileProvider, StoreProvider } from "../providers/index.js";
+import type { AnalyticsProvider, CheckoutProvider, OrderProvider, ProfileProvider, StoreProvider } from "../providers/index.js";
 import type { OrderSearchProvider } from "../providers/order-search.provider.js";
 export interface Client {
     product: ProductProvider;
@@ -16,7 +15,7 @@ export interface Client {
     cache: Cache;
     cart: CartProvider;
     checkout: CheckoutProvider;
-    analytics: Array<AnalyticsProvider>;
+    analytics: AnalyticsProvider;
     price: PriceProvider;
     inventory: InventoryProvider;
     category: CategoryProvider;

package/src/initialization.d.ts

@@ -1,2 +1,2 @@
-import type { RequestContext } from "./schemas/session.schema.js";
+import type { RequestContext } from './schemas/session.schema.js';
 export declare function createInitialRequestContext(): RequestContext;

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

@@ -1,4 +1,18 @@
+import type { RequestContext } from '../schemas/session.schema.js';
 import { BaseProvider } from './base.provider.js';
+import type { Cache } from '../cache/cache.interface.js';
+import { type AnalyticsMutation, type AnalyticsMutationProductAddToCartEvent, type AnalyticsMutationProductDetailsViewEvent, type AnalyticsMutationProductSummaryClickEvent, type AnalyticsMutationProductSummaryViewEvent, type AnalyticsMutationPurchaseEvent } from '../schemas/index.js';
 export declare abstract class AnalyticsProvider extends BaseProvider {
     protected getResourceName(): string;
+    track(event: AnalyticsMutation): Promise<void>;
+    protected processProductSummaryView(event: AnalyticsMutationProductSummaryViewEvent): Promise<void>;
+    protected processProductSummaryClick(event: AnalyticsMutationProductSummaryClickEvent): Promise<void>;
+    protected processProductDetailsView(event: AnalyticsMutationProductDetailsViewEvent): Promise<void>;
+    protected processProductAddToCart(event: AnalyticsMutationProductAddToCartEvent): Promise<void>;
+    protected processPurchase(event: AnalyticsMutationPurchaseEvent): Promise<void>;
+}
+export declare class MulticastAnalyticsProvider extends AnalyticsProvider {
+    protected providers: Array<AnalyticsProvider>;
+    constructor(cache: Cache, requestContext: RequestContext, providers: Array<AnalyticsProvider>);
+    track(event: AnalyticsMutation): Promise<void>;
 }

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

@@ -5,6 +5,9 @@ import type { CartMutationApplyCoupon, CartMutationChangeCurrency, CartMutationD
 import type { CartQueryById } from "../schemas/queries/cart.query.js";
 import type { Result } from "../schemas/result.js";
 import { BaseProvider } from "./base.provider.js";
+/**
+ * @group Providers
+ */
 export declare abstract class CartProvider extends BaseProvider {
     /**
      * Get cart by ID.

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

@@ -8,6 +8,7 @@ import { BaseProvider } from "./base.provider.js";
  *
  * We only allow fetching one hierachy level at a time, for now. This is to avoid development patterns of "fetch 5000 categories in one go.."
  *
+ * @group Foo
  */
 export declare abstract class CategoryProvider extends BaseProvider {
     /**

package/src/schemas/errors/invalid-input.error.d.ts

@@ -2,6 +2,6 @@ import { z } from 'zod';
 import type { InferType } from '../../zod-utils.js';
 export declare const InvalidInputErrorSchema: z.ZodObject<{
     type: z.ZodLiteral<"InvalidInput">;
-    error: z.core.$constructor<z.ZodError<unknown>, z.core.$ZodIssue[]>;
+    error: z.ZodString;
 }, z.core.$loose>;
 export type InvalidInputError = InferType<typeof InvalidInputErrorSchema>;

package/src/schemas/errors/invalid-output.error.d.ts

@@ -2,6 +2,6 @@ import { z } from 'zod';
 import type { InferType } from '../../zod-utils.js';
 export declare const InvalidOutputErrorSchema: z.ZodObject<{
     type: z.ZodLiteral<"InvalidOutput">;
-    error: z.core.$constructor<z.ZodError<unknown>, z.core.$ZodIssue[]>;
+    error: z.ZodString;
 }, z.core.$loose>;
 export type InvalidOutputError = InferType<typeof InvalidOutputErrorSchema>;

package/src/schemas/models/identifiers.model.d.ts

@@ -128,6 +128,9 @@ export declare const ProductSearchIdentifierSchema: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$strip>>;
 }, z.core.$loose>;
+/**
+ * Bar
+ */
 export declare const OrderSearchIdentifierSchema: z.ZodObject<{
     term: z.ZodString;
     partNumber: z.ZodOptional<z.ZodArray<z.ZodString>>;

package/src/schemas/models/order.model.d.ts

@@ -3102,7 +3102,7 @@ export declare const OrderSchema: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$loose>>;
 }, z.core.$loose>;
-export type OrderStatus = InferType<typeof OrderStatusSchema>;
+export type OrderStatus = z.infer<typeof OrderStatusSchema>;
 export type OrderInventoryStatus = InferType<typeof OrderInventoryStatusSchema>;
 export type OrderItem = InferType<typeof OrderItemSchema>;
 export type Order = InferType<typeof OrderSchema>;