@reactionary/core 0.1.12 → 0.2.1

package/cache/memory-cache.js

@@ -1,4 +1,5 @@
 import { getReactionaryCacheMeter } from "../metrics/metrics.js";
+import { error, NotFoundErrorSchema, success } from "../schemas/index.js";
 class MemoryCache {
   constructor() {
     this.entries = new Array();
@@ -13,7 +14,6 @@ class MemoryCache {
       return null;
     }
     const parsed = schema.parse(c.value);
-    parsed.meta.cache.hit = true;
     this.meter.hits.add(1, {
       "labels.cache_type": "memory"
     });

package/decorators/reactionary.decorator.js

@@ -1,5 +1,6 @@
 import { trace } from "@opentelemetry/api";
 import { getReactionaryMeter } from "../metrics/metrics.js";
+import { error, success } from "../schemas/result.js";
 const TRACER_NAME = "@reactionary";
 const TRACER_VERSION = "0.0.1";
 let globalTracer = null;
@@ -56,26 +57,43 @@ function Reactionary(options) {
         meter.requestInProgress.add(1, attributes);
         try {
           const input = validateInput(args[0], configuration.inputSchema);
-          const cacheKey = this.generateCacheKeyForQuery(scope, input);
+          if (!input.success) {
+            return input;
+          }
+          const cacheKey = this.generateCacheKeyForQuery(scope, input.value);
           const fromCache = await this.cache.get(
             cacheKey,
             options.inputSchema
           );
-          let result = fromCache;
-          if (!result) {
-            result = await original.apply(this, [input]);
-            const dependencyIds = this.generateDependencyIdsForModel(result);
-            this.cache.put(cacheKey, result, {
-              ttlSeconds: configuration.cacheTimeToLiveInSeconds,
-              dependencyIds
-            });
+          let result;
+          if (!fromCache) {
+            result = await original.apply(this, [input.value]);
+            const r = result;
+            if (r.success) {
+              const dependencyIds = this.generateDependencyIdsForModel(r.value);
+              this.cache.put(cacheKey, r.value, {
+                ttlSeconds: configuration.cacheTimeToLiveInSeconds,
+                dependencyIds
+              });
+            }
           } else {
+            result = success(fromCache);
             cacheStatus = "hit";
           }
-          return validateOutput(result, configuration.outputSchema);
+          const validatedResult = validateOutput(result, configuration.outputSchema);
+          if (validatedResult.success) {
+            validatedResult.meta.cache.hit = !!fromCache;
+            validatedResult.meta.cache.key = cacheKey;
+          }
+          return result;
         } catch (err) {
+          console.error(err);
           status = "error";
-          throw err;
+          const result = error({
+            type: "Generic",
+            message: "REDACTED"
+          });
+          return result;
         } finally {
           const duration = performance.now() - startTime;
           const finalAttributes = {
@@ -94,17 +112,33 @@ function Reactionary(options) {
 }
 function validateInput(input, schema) {
   if (!schema) {
-    return input;
+    return success(input);
+  }
+  let validated = success(input);
+  const parse = schema.safeParse(input);
+  if (!parse.success) {
+    validated = error({
+      type: "InvalidInput",
+      error: parse.error
+    });
   }
-  const parsed = schema.parse(input);
-  return parsed;
+  return validated;
 }
 function validateOutput(output, schema) {
   if (!schema) {
     return output;
   }
-  const parsed = schema.parse(output);
-  return parsed;
+  let validated = output;
+  if (output.success) {
+    const parse = schema.safeParse(output.value);
+    if (!parse.success) {
+      validated = error({
+        type: "InvalidOutput",
+        error: parse.error
+      });
+    }
+  }
+  return validated;
 }
 async function traceSpan(name, fn) {
   const tracer = getTracer();

package/package.json

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

package/providers/base.provider.js

@@ -19,21 +19,6 @@ class BaseProvider {
     const queryHash = h.hash(query);
     return `${scope}:${queryHash}`;
   }
-  generateCacheKeyPaginatedResult(resultSetName, res) {
-    const type = this.getResourceName();
-    const langPart = this.context.languageContext.locale;
-    const currencyPart = this.context.languageContext.currencyCode || "default";
-    const storePart = this.context.storeIdentifier?.key || "default";
-    return `${type}-${resultSetName}-paginated|pageNumber:${res.pageNumber}|pageSize:${res.pageSize}|store:${storePart}|lang:${langPart}|currency:${currencyPart}`;
-  }
-  generateCacheKeySingle(identifier) {
-    const type = this.getResourceName();
-    const idPart = Object.entries(identifier).map(([k, v]) => `${k}:${v}`).join("#");
-    const langPart = this.context.languageContext.locale;
-    const currencyPart = this.context.languageContext.currencyCode || "default";
-    const storePart = this.context.storeIdentifier?.key || "default";
-    return `${type}-${idPart}|store:${storePart}|lang:${langPart}|currency:${currencyPart}`;
-  }
 }
 export {
   BaseProvider

package/providers/cart.provider.js

@@ -1,44 +1,5 @@
 import { BaseProvider } from "./base.provider.js";
 class CartProvider extends BaseProvider {
-  createEmptyCart() {
-    const cart = {
-      identifier: { key: "" },
-      meta: { placeholder: true, cache: { hit: true, key: "empty-cart" } },
-      description: "",
-      items: [],
-      name: "",
-      price: {
-        grandTotal: {
-          value: 0,
-          currency: "XXX"
-        },
-        totalDiscount: {
-          value: 0,
-          currency: "XXX"
-        },
-        totalProductPrice: {
-          value: 0,
-          currency: "XXX"
-        },
-        totalShipping: {
-          value: 0,
-          currency: "XXX"
-        },
-        totalSurcharge: {
-          value: 0,
-          currency: "XXX"
-        },
-        totalTax: {
-          value: 0,
-          currency: "XXX"
-        }
-      },
-      userId: {
-        userId: ""
-      }
-    };
-    return cart;
-  }
   getResourceName() {
     return "cart";
   }

package/providers/inventory.provider.js

@@ -7,14 +7,7 @@ class InventoryProvider extends BaseProvider {
     const inventory = {
       identifier: key,
       quantity: 0,
-      status: "outOfStock",
-      meta: {
-        cache: {
-          hit: false,
-          key: this.generateCacheKeySingle(key)
-        },
-        placeholder: true
-      }
+      status: "outOfStock"
     };
     return inventory;
   }

package/providers/order.provider.js

@@ -2,7 +2,6 @@ import { BaseProvider } from "./base.provider.js";
 class OrderProvider extends BaseProvider {
   createEmptyOrder() {
     const order = {
-      meta: { placeholder: true, cache: { hit: true, key: "empty-order" } },
       identifier: {
         key: ""
       },

package/providers/price.provider.js

@@ -19,13 +19,6 @@ class PriceProvider extends BaseProvider {
       unitPrice: {
         value: -1,
         currency: this.context.languageContext.currencyCode
-      },
-      meta: {
-        cache: {
-          hit: false,
-          key: `price-${sku}-${this.context.languageContext.currencyCode}`
-        },
-        placeholder: true
       }
     };
     return price;

package/providers/product.provider.js

@@ -21,13 +21,6 @@ class ProductProvider extends BaseProvider {
         upc: ""
       },
       manufacturer: "",
-      meta: {
-        cache: {
-          hit: false,
-          key: ""
-        },
-        placeholder: true
-      },
       name: "",
       options: [],
       parentCategories: [],

package/schemas/errors/generic.error.js

@@ -0,0 +1,8 @@
+import { z } from "zod";
+const GenericErrorSchema = z.looseObject({
+  type: z.literal("Generic"),
+  message: z.string().nonempty()
+});
+export {
+  GenericErrorSchema
+};

package/schemas/errors/index.js

@@ -0,0 +1,4 @@
+export * from "./generic.error.js";
+export * from "./invalid-input.error.js";
+export * from "./invalid-output.error.js";
+export * from "./not-found.error.js";

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

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

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

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

package/schemas/errors/not-found.error.js

@@ -0,0 +1,8 @@
+import { z } from "zod";
+const NotFoundErrorSchema = z.looseObject({
+  type: z.literal("NotFound"),
+  identifier: z.unknown()
+});
+export {
+  NotFoundErrorSchema
+};

package/schemas/index.js

@@ -1,5 +1,7 @@
+export * from "./errors/index.js";
 export * from "./models/index.js";
 export * from "./mutations/index.js";
 export * from "./queries/index.js";
 export * from "./capabilities.schema.js";
 export * from "./session.schema.js";
+export * from "./result.js";

package/schemas/models/base.model.js

@@ -1,22 +1,11 @@
 import { z } from "zod";
-const CacheInformationSchema = z.looseObject({
-  hit: z.boolean().default(false),
-  key: z.string().default("")
-});
-const MetaSchema = z.looseObject({
-  cache: CacheInformationSchema.default(() => CacheInformationSchema.parse({})),
-  placeholder: z.boolean().default(false).describe("Whether or not the entity exists in a remote system, or is a default placeholder.")
-});
-const BaseModelSchema = z.looseObject({
-  meta: MetaSchema.default(() => MetaSchema.parse({}))
-});
+const BaseModelSchema = z.looseObject({});
 const PaginationOptionsSchema = z.looseObject({
   pageNumber: z.number().default(1).describe("Current page number, starting from 1"),
   pageSize: z.number().min(1).max(50).default(20).describe("Number of items per page")
 });
 function createPaginatedResponseSchema(itemSchema) {
   return z.object({
-    meta: MetaSchema.default(() => MetaSchema.parse({})),
     pageNumber: z.number().min(1).describe("Current page number, starting from 1"),
     pageSize: z.number().min(1).describe("Number of items per page"),
     totalCount: z.number().min(0).describe("Total number of items available"),
@@ -32,9 +21,7 @@ const ImageSchema = z.looseObject({
 });
 export {
   BaseModelSchema,
-  CacheInformationSchema,
   ImageSchema,
-  MetaSchema,
   PaginationOptionsSchema,
   createPaginatedResponseSchema
 };

package/schemas/mutations/cart.mutation.js

@@ -5,7 +5,7 @@ import { AddressSchema } from "../models/profile.model.js";
 import { CurrencySchema } from "../models/currency.model.js";
 import { MonetaryAmountSchema } from "../models/price.model.js";
 const CartMutationItemAddSchema = BaseMutationSchema.extend({
-  cart: CartIdentifierSchema,
+  cart: CartIdentifierSchema.optional(),
   variant: ProductVariantIdentifierSchema,
   quantity: z.number()
 });

package/schemas/mutations/checkout.mutation.js

@@ -3,19 +3,19 @@ import { CartIdentifierSchema, AddressSchema, PaymentInstructionIdentifierSchema
 import { BaseMutationSchema } from "./base.mutation.js";
 const CheckoutMutationInitiateCheckoutSchema = BaseMutationSchema.extend({
   cart: CartSchema,
-  billingAddress: AddressSchema.omit({ identifier: true, meta: true }).optional(),
+  billingAddress: AddressSchema.omit({ identifier: true }).optional(),
   notificationEmail: z.string().optional(),
   notificationPhone: z.string().optional()
 });
 const CheckoutMutationSetShippingAddressSchema = BaseMutationSchema.extend({
   checkout: CartIdentifierSchema,
-  shippingAddress: AddressSchema.omit({ identifier: true, meta: true })
+  shippingAddress: AddressSchema.omit({ identifier: true })
 });
 const CheckoutMutationFinalizeCheckoutSchema = BaseMutationSchema.extend({
   checkout: CartIdentifierSchema
 });
 const CheckoutMutationAddPaymentInstructionSchema = BaseMutationSchema.extend({
-  paymentInstruction: PaymentInstructionSchema.omit({ meta: true, status: true, identifier: true }),
+  paymentInstruction: PaymentInstructionSchema.omit({ status: true, identifier: true }),
   checkout: CartIdentifierSchema
 });
 const CheckoutMutationRemovePaymentInstructionSchema = BaseMutationSchema.extend({
@@ -23,7 +23,7 @@ const CheckoutMutationRemovePaymentInstructionSchema = BaseMutationSchema.extend
   checkout: CartIdentifierSchema
 });
 const CheckoutMutationSetShippingInstructionSchema = BaseMutationSchema.extend({
-  shippingInstruction: ShippingInstructionSchema.omit({ meta: true }),
+  shippingInstruction: ShippingInstructionSchema,
   checkout: CartIdentifierSchema
 });
 export {

package/schemas/result.js

@@ -0,0 +1,51 @@
+import { trace } from "@opentelemetry/api";
+function assertSuccess(result) {
+  if (!result.success) {
+    throw new Error(
+      `Expected Result.success = true, but got false. Error: ${result.error}`
+    );
+  }
+}
+function assertError(result) {
+  if (result.success) {
+    throw new Error(`Expected failure but got success: ${result.value}`);
+  }
+}
+function unwrapValue(result) {
+  assertSuccess(result);
+  return result.value;
+}
+function unwrapError(result) {
+  assertError(result);
+  return result.error;
+}
+function success(value) {
+  return {
+    success: true,
+    value,
+    meta: {
+      trace: trace.getActiveSpan()?.spanContext().traceId || "",
+      cache: {
+        hit: false,
+        key: ""
+      }
+    }
+  };
+}
+function error(error2) {
+  return {
+    success: false,
+    error: error2,
+    meta: {
+      trace: trace.getActiveSpan()?.spanContext().traceId || ""
+    }
+  };
+}
+export {
+  assertError,
+  assertSuccess,
+  error,
+  success,
+  unwrapError,
+  unwrapValue
+};

package/src/cache/memory-cache.d.ts

@@ -1,4 +1,5 @@
 import type { BaseModel } from '../schemas/models/index.js';
+import type { Result } from '../schemas/result.js';
 import type { Cache, CacheEntryOptions } from './cache.interface.js';
 import type z from 'zod';
 /**
@@ -13,7 +14,7 @@ export declare class MemoryCache implements Cache {
     }[];
     protected meter: import("../metrics/metrics.js").ReactionaryCacheMetrics;
     get<T extends BaseModel>(key: string, schema: z.ZodType<T>): Promise<T | null>;
-    put(key: string, value: unknown, options: CacheEntryOptions): Promise<void>;
+    put(key: string, value: Result<unknown>, options: CacheEntryOptions): Promise<void>;
     invalidate(dependencyIds: Array<string>): Promise<void>;
     clear(): Promise<void>;
 }

package/src/decorators/reactionary.decorator.d.ts

@@ -1,6 +1,7 @@
 import type { Tracer } from '@opentelemetry/api';
 import type { z } from 'zod';
 import type { BaseProvider } from '../providers/index.js';
+import { type Result } from '../schemas/result.js';
 export declare function getTracer(): Tracer;
 /**
  * The options associated with annotating a provider function and marking
@@ -46,11 +47,11 @@ export declare function Reactionary(options: Partial<ReactionaryDecoratorOptions
 /**
  * Utility function to handle input validation.
  */
-export declare function validateInput(input: any, schema: z.ZodType | undefined): any;
+export declare function validateInput<T>(input: T, schema: z.ZodType | undefined): Result<T>;
 /**
  * Utility function to handle output validation.
  */
-export declare function validateOutput(output: any, schema: z.ZodType | undefined): any;
+export declare function validateOutput(output: Result<unknown>, schema: z.ZodType | undefined): Result<unknown>;
 /**
  * Utility function to wrap entry / exit into decorated functions in a
  * traced span for OTEL handling.

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

@@ -1,6 +1,5 @@
 import type { Cache } from '../cache/cache.interface.js';
 import { type RequestContext } from '../schemas/session.schema.js';
-import type { IdentifierType } from '../schemas/models/identifiers.model.js';
 /**
  * Base capability provider, responsible for mutations (changes) and queries (fetches)
  * for a given business object domain.
@@ -11,8 +10,6 @@ export declare abstract class BaseProvider {
     constructor(cache: Cache, context: RequestContext);
     generateDependencyIdsForModel(model: unknown): Array<string>;
     protected generateCacheKeyForQuery(scope: string, query: object): string;
-    protected generateCacheKeyPaginatedResult(resultSetName: string, res: any): string;
-    protected generateCacheKeySingle(identifier: IdentifierType): string;
     /**
      * Returns the abstract resource name provided by the remote system.
      */

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

@@ -1,7 +1,9 @@
+import type { NotFoundError } from "../schemas/index.js";
 import type { Cart } from "../schemas/models/cart.model.js";
 import type { CartIdentifier } from "../schemas/models/identifiers.model.js";
 import type { CartMutationApplyCoupon, CartMutationChangeCurrency, CartMutationDeleteCart, CartMutationItemAdd, CartMutationItemQuantityChange, CartMutationItemRemove, CartMutationRemoveCoupon } from "../schemas/mutations/cart.mutation.js";
 import type { CartQueryById } from "../schemas/queries/cart.query.js";
+import type { Result } from "../schemas/result.js";
 import { BaseProvider } from "./base.provider.js";
 export declare abstract class CartProvider extends BaseProvider {
     /**
@@ -11,14 +13,14 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param payload
      * @param session
      */
-    abstract getById(payload: CartQueryById): Promise<Cart>;
+    abstract getById(payload: CartQueryById): Promise<Result<Cart, NotFoundError>>;
     /**
      * Get the active cart id for the user.
      *
      * Usecase: Most common usecase during site load, or after login. You want to get the active cart for the user, so you can display it in the minicart.
      * @param session
      */
-    abstract getActiveCartId(): Promise<CartIdentifier>;
+    abstract getActiveCartId(): Promise<Result<CartIdentifier, NotFoundError>>;
     /**
      * Add item to cart. If no cart exists, create a new one. Returns the updated and recalculated cart.
      * Does not automatically consolidate items, so if you want to have second add of same item to increase quantity,
@@ -28,7 +30,7 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param payload
      * @param session
      */
-    abstract add(payload: CartMutationItemAdd): Promise<Cart>;
+    abstract add(payload: CartMutationItemAdd): Promise<Result<Cart>>;
     /**
      * Remove item from cart. If the cart is empty after removal, delete the cart. Returns the updated and recalculated cart.
      *
@@ -36,7 +38,7 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param payload
      * @param session
      */
-    abstract remove(payload: CartMutationItemRemove): Promise<Cart>;
+    abstract remove(payload: CartMutationItemRemove): Promise<Result<Cart>>;
     /**
      * Change quantity of item in cart. If the cart is empty after change, delete the cart. Returns the updated and recalculated cart.
      * Changing quantity to 0 is not allowed. Use the remove call instead. This is done to avoid accidental removal of item.
@@ -46,7 +48,7 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param payload
      * @param session
      */
-    abstract changeQuantity(payload: CartMutationItemQuantityChange): Promise<Cart>;
+    abstract changeQuantity(payload: CartMutationItemQuantityChange): Promise<Result<Cart>>;
     /**
      * Deletes the entire cart.
      *
@@ -54,7 +56,7 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param payload
      * @param session
      */
-    abstract deleteCart(payload: CartMutationDeleteCart): Promise<Cart>;
+    abstract deleteCart(payload: CartMutationDeleteCart): Promise<Result<void>>;
     /**
      * Applies a coupon code to the cart. Returns the updated and recalculated cart.
      *
@@ -62,7 +64,7 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param payload
      * @param session
      */
-    abstract applyCouponCode(payload: CartMutationApplyCoupon): Promise<Cart>;
+    abstract applyCouponCode(payload: CartMutationApplyCoupon): Promise<Result<Cart>>;
     /**
      * Removes a coupon code from the cart. Returns the updated and recalculated cart.
      *
@@ -70,7 +72,7 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param payload
      * @param session
      */
-    abstract removeCouponCode(payload: CartMutationRemoveCoupon): Promise<Cart>;
+    abstract removeCouponCode(payload: CartMutationRemoveCoupon): Promise<Result<Cart>>;
     /**
      * Changes the currency of the cart.
      *
@@ -78,7 +80,6 @@ export declare abstract class CartProvider extends BaseProvider {
      * @param newCurrency
      * @param session
      */
-    abstract changeCurrency(payload: CartMutationChangeCurrency): Promise<Cart>;
-    protected createEmptyCart(): Cart;
+    abstract changeCurrency(payload: CartMutationChangeCurrency): Promise<Result<Cart>>;
     protected getResourceName(): string;
 }

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

@@ -1,4 +1,4 @@
-import type { Category, CategoryPaginatedResult } from "../schemas/index.js";
+import type { Category, CategoryPaginatedResult, NotFoundError, Result } from "../schemas/index.js";
 import type { CategoryQueryById, CategoryQueryBySlug, CategoryQueryForBreadcrumb, CategoryQueryForChildCategories, CategoryQueryForTopCategories } from "../schemas/queries/category.query.js";
 import { BaseProvider } from "./base.provider.js";
 /**
@@ -25,7 +25,7 @@ export declare abstract class CategoryProvider extends BaseProvider {
      * @param id
      * @param session
      */
-    abstract getById(payload: CategoryQueryById): Promise<Category>;
+    abstract getById(payload: CategoryQueryById): Promise<Result<Category, NotFoundError>>;
     /**
      * Gets a single category by its seo slug
      *
@@ -33,7 +33,7 @@ export declare abstract class CategoryProvider extends BaseProvider {
      * @param slug the slug
      * @param session
      */
-    abstract getBySlug(payload: CategoryQueryBySlug): Promise<Category | null>;
+    abstract getBySlug(payload: CategoryQueryBySlug): Promise<Result<Category, NotFoundError>>;
     /**
      * Gets the breadcrumb path to the category, i.e. all parents up to the root.
      * The returned order is from root to leaf.
@@ -42,7 +42,7 @@ export declare abstract class CategoryProvider extends BaseProvider {
      * @param id
      * @param session
      */
-    abstract getBreadcrumbPathToCategory(payload: CategoryQueryForBreadcrumb): Promise<Category[]>;
+    abstract getBreadcrumbPathToCategory(payload: CategoryQueryForBreadcrumb): Promise<Result<Category[]>>;
     /**
      * Finds all child categories of a given category.
      *
@@ -53,7 +53,7 @@ export declare abstract class CategoryProvider extends BaseProvider {
      * @param id The ID of the parent category.
      * @param session The session information.
      */
-    abstract findChildCategories(payload: CategoryQueryForChildCategories): Promise<CategoryPaginatedResult>;
+    abstract findChildCategories(payload: CategoryQueryForChildCategories): Promise<Result<CategoryPaginatedResult>>;
     /**
      * Returns all top categories, i.e. categories without a parent.
      *
@@ -61,6 +61,6 @@ export declare abstract class CategoryProvider extends BaseProvider {
      * @param paginationOptions
      * @param session
      */
-    abstract findTopCategories(payload: CategoryQueryForTopCategories): Promise<CategoryPaginatedResult>;
+    abstract findTopCategories(payload: CategoryQueryForTopCategories): Promise<Result<CategoryPaginatedResult>>;
     protected getResourceName(): string;
 }