@reactionary/core 0.0.68 → 0.0.70

package/decorators/reactionary.decorator.js

@@ -1,7 +1,4 @@
-import {
-  trace,
-  SpanKind
-} from "@opentelemetry/api";
+import { trace, SpanKind } from "@opentelemetry/api";
 const TRACER_NAME = "@reactionary";
 const TRACER_VERSION = "0.0.1";
 let globalTracer = null;
@@ -36,7 +33,6 @@ class ReactionaryDecoratorOptions {
     this.cacheTimeToLiveInSeconds = 60;
   }
 }
-;
 function Reactionary(options) {
   return function(target, propertyKey, descriptor) {
     const original = descriptor.value;
@@ -48,42 +44,63 @@ function Reactionary(options) {
       );
     }
     descriptor.value = async function(...args) {
-      const tracer = getTracer();
-      return tracer.startActiveSpan(
-        propertyKey.toString(),
-        { kind: SpanKind.SERVER },
-        async (span) => {
-          const cacheKey = this.generateCacheKeyForQuery(scope, args[0]);
-          const fromCache = await this.cache.get(cacheKey, this.schema);
-          let result = fromCache;
-          if (!result) {
-            result = await original.apply(this, args);
-            const dependencyIds = this.generateDependencyIdsForModel(result);
-            this.cache.put(cacheKey, result, {
-              ttlSeconds: configuration.cacheTimeToLiveInSeconds,
-              dependencyIds
-            });
-          }
-          span.end();
-          if (!result) {
-            return result;
-          }
-          if (result instanceof Array) {
-            return result;
-          }
-          return this.assert(result);
+      return traceSpan(scope, async () => {
+        const input = validateInput(args[0], configuration.inputSchema);
+        const cacheKey = this.generateCacheKeyForQuery(scope, input);
+        const fromCache = await this.cache.get(cacheKey, this.schema);
+        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
+          });
         }
-      );
+        return validateOutput(result, configuration.outputSchema);
+      });
     };
     return descriptor;
   };
 }
-function validateInput() {
-  console.log("foo");
+function validateInput(input, schema) {
+  if (!schema) {
+    return input;
+  }
+  const parsed = schema.parse(input);
+  return parsed;
+}
+function validateOutput(output, schema) {
+  if (!schema) {
+    return output;
+  }
+  const parsed = schema.parse(output);
+  return parsed;
+}
+async function traceSpan(name, fn) {
+  const tracer = getTracer();
+  return tracer.startActiveSpan(name, async (span) => {
+    try {
+      return fn();
+    } catch (err) {
+      if (err instanceof Error) {
+        span.recordException(err);
+        span.setStatus({ code: 2, message: err.message });
+      } else {
+        span.recordException({ message: String(err) });
+        span.setStatus({ code: 2, message: String(err) });
+      }
+      throw err;
+    } finally {
+      span.end();
+    }
+  });
 }
 export {
   Reactionary,
   ReactionaryDecoratorOptions,
   getTracer,
-  validateInput
+  traceSpan,
+  validateInput,
+  validateOutput
 };

package/index.js

@@ -140,11 +140,11 @@ import {
 import {
   BaseQuerySchema,
   CartQueryByIdSchema,
-  CategoryQueryById,
-  CategoryQueryBySlug,
-  CategoryQueryForBreadcrumb,
-  CategoryQueryForChildCategories,
-  CategoryQueryForTopCategories,
+  CategoryQueryByIdSchema,
+  CategoryQueryBySlugSchema,
+  CategoryQueryForBreadcrumbSchema,
+  CategoryQueryForChildCategoriesSchema,
+  CategoryQueryForTopCategoriesSchema,
   CheckoutQueryByIdSchema,
   CheckoutQueryForAvailablePaymentMethodsSchema,
   CheckoutQueryForAvailableShippingMethodsSchema,
@@ -197,11 +197,11 @@ export {
   CategoryIdentifierSchema,
   CategoryPaginatedResultSchema,
   CategoryProvider,
-  CategoryQueryById,
-  CategoryQueryBySlug,
-  CategoryQueryForBreadcrumb,
-  CategoryQueryForChildCategories,
-  CategoryQueryForTopCategories,
+  CategoryQueryByIdSchema,
+  CategoryQueryBySlugSchema,
+  CategoryQueryForBreadcrumbSchema,
+  CategoryQueryForChildCategoriesSchema,
+  CategoryQueryForTopCategoriesSchema,
   CategorySchema,
   CheckoutIdentifierSchema,
   CheckoutItemIdentifierSchema,

package/package.json

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

package/schemas/mutations/checkout.mutation.js

@@ -23,7 +23,7 @@ const CheckoutMutationRemovePaymentInstructionSchema = BaseMutationSchema.extend
   checkout: CartIdentifierSchema.required()
 });
 const CheckoutMutationSetShippingInstructionSchema = BaseMutationSchema.extend({
-  shippingInstruction: ShippingInstructionSchema.omit({ meta: true, status: true, identifier: true }).required(),
+  shippingInstruction: ShippingInstructionSchema.omit({ meta: true }).required(),
   checkout: CartIdentifierSchema.required()
 });
 export {

package/schemas/queries/category.query.js

@@ -2,26 +2,26 @@ import { z } from "zod";
 import { CategoryIdentifierSchema } from "../models/identifiers.model.js";
 import { BaseQuerySchema } from "./base.query.js";
 import { PaginationOptionsSchema } from "../models/base.model.js";
-const CategoryQueryById = BaseQuerySchema.extend({
+const CategoryQueryByIdSchema = BaseQuerySchema.extend({
   id: CategoryIdentifierSchema.default(() => CategoryIdentifierSchema.parse({}))
 });
-const CategoryQueryBySlug = BaseQuerySchema.extend({
+const CategoryQueryBySlugSchema = BaseQuerySchema.extend({
   slug: z.string().default("")
 });
-const CategoryQueryForBreadcrumb = BaseQuerySchema.extend({
+const CategoryQueryForBreadcrumbSchema = BaseQuerySchema.extend({
   id: CategoryIdentifierSchema.default(() => CategoryIdentifierSchema.parse({}))
 });
-const CategoryQueryForChildCategories = BaseQuerySchema.extend({
+const CategoryQueryForChildCategoriesSchema = BaseQuerySchema.extend({
   parentId: CategoryIdentifierSchema.default(() => CategoryIdentifierSchema.parse({})),
   paginationOptions: PaginationOptionsSchema.default(() => PaginationOptionsSchema.parse({}))
 });
-const CategoryQueryForTopCategories = BaseQuerySchema.extend({
+const CategoryQueryForTopCategoriesSchema = BaseQuerySchema.extend({
   paginationOptions: PaginationOptionsSchema.default(() => PaginationOptionsSchema.parse({}))
 });
 export {
-  CategoryQueryById,
-  CategoryQueryBySlug,
-  CategoryQueryForBreadcrumb,
-  CategoryQueryForChildCategories,
-  CategoryQueryForTopCategories
+  CategoryQueryByIdSchema,
+  CategoryQueryBySlugSchema,
+  CategoryQueryForBreadcrumbSchema,
+  CategoryQueryForChildCategoriesSchema,
+  CategoryQueryForTopCategoriesSchema
 };

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

@@ -1,5 +1,6 @@
 import type { BaseProvider } from '../providers/index.js';
 import type { Tracer } from '@opentelemetry/api';
+import type { z } from 'zod';
 export declare function getTracer(): Tracer;
 /**
  * The options associated with annotating a provider function and marking
@@ -27,8 +28,14 @@ export declare class ReactionaryDecoratorOptions {
      * given query.
      */
     cacheTimeToLiveInSeconds: number;
-    inputSchema?: any;
-    outputSchema?: any;
+    /**
+     * The schema for the input (query or mutation) type, for validation purposes
+     */
+    inputSchema?: z.ZodType;
+    /**
+     * The schema for the primary output type, for validation purposes
+     */
+    outputSchema?: z.ZodType;
 }
 /**
  * Decorator for provider functions to provide functionality such as caching, tracing and type-checked
@@ -36,4 +43,16 @@ export declare class ReactionaryDecoratorOptions {
  * providers.
  */
 export declare function Reactionary(options: Partial<ReactionaryDecoratorOptions>): (target: BaseProvider, propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;
-export declare function validateInput(): void;
+/**
+ * Utility function to handle input validation.
+ */
+export declare function validateInput(input: any, schema: z.ZodType | undefined): any;
+/**
+ * Utility function to handle output validation.
+ */
+export declare function validateOutput(output: any, schema: z.ZodType | undefined): any;
+/**
+ * Utility function to wrap entry / exit into decorated functions in a
+ * traced span for OTEL handling.
+ */
+export declare function traceSpan<T>(name: string, fn: () => Promise<T> | T): Promise<T>;

package/src/index.d.ts

@@ -12,6 +12,6 @@ export { AddressIdentifierSchema, AddressSchema, AnalyticsEventSchema, Anonymous
 export type { Address, AddressIdentifier, AnalyticsEvent, AnonymousIdentity, BaseModel, CacheInformation, Cart, CartIdentifier, CartItem, CartItemIdentifier, Category, CategoryIdentifier, CategoryPaginatedResult, Checkout, CheckoutIdentifier, CheckoutItem, CheckoutItemIdentifier, CostBreakDown, Currency, FacetIdentifier, FacetValueIdentifier, FulfillmentCenterIdentifier, GuestIdentity, IdentifierType, Identity, IdentityIdentifier, Image, Inventory, InventoryIdentifier, ItemCostBreakdown, Meta, MonetaryAmount, Order, OrderIdentifier, OrderItem, OrderItemIdentifier, PaginationOptions, PaymentInstruction, PaymentInstructionIdentifier, PaymentMethod, PaymentMethodIdentifier, PaymentStatus, PickupPoint, PickupPointIdentifier, Price, PriceIdentifier, Product, ProductAttribute, ProductAttributeIdentifier, ProductAttributeValue, ProductAttributeValueIdentifier, ProductIdentifier, ProductOption, ProductOptionIdentifier, ProductOptionValue, ProductOptionValueIdentifier, ProductSearchResult, ProductSearchResultFacet, ProductSearchResultFacetValue, ProductSearchResultItem, ProductSearchResultItemVariant, ProductVariant, ProductVariantIdentifier, ProductVariantOption, Profile, RegisteredIdentity, SearchIdentifier, ShippingInstruction, ShippingMethod, ShippingMethodIdentifier, Store, StoreIdentifier, TieredPrice, WebStoreIdentifier, } from './schemas/models/index.js';
 export { AnalyticsMutationSchema, AnalyticsMutationSearchEventSchema, AnalyticsMutationSearchProductClickEventSchema, BaseMutationSchema, CartMutationAddPaymentMethodSchema, CartMutationApplyCouponSchema, CartMutationChangeCurrencySchema, CartMutationCheckoutSchema, CartMutationDeleteCartSchema, CartMutationItemAddSchema, CartMutationItemQuantityChangeSchema, CartMutationItemRemoveSchema, CartMutationRemoveCouponSchema, CartMutationRemovePaymentMethodSchema, CartMutationSetBillingAddressSchema, CartMutationSetShippingInfoSchema, CheckoutMutationAddPaymentInstructionSchema, CheckoutMutationFinalizeCheckoutSchema, CheckoutMutationInitiateCheckoutSchema, CheckoutMutationRemovePaymentInstructionSchema, CheckoutMutationSetShippingAddressSchema, CheckoutMutationSetShippingInstructionSchema, IdentityMutationLoginSchema, IdentityMutationLogoutSchema, IdentityMutationRegisterSchema, ProfileMutationUpdateSchema, } from './schemas/mutations/index.js';
 export type { AnalyticsMutation, AnalyticsMutationSearchEvent, AnalyticsMutationSearchProductClickEvent, BaseMutation, CartMutationAddPaymentMethod, CartMutationApplyCoupon, CartMutationChangeCurrency, CartMutationCheckout, CartMutationDeleteCart, CartMutationItemAdd, CartMutationItemQuantityChange, CartMutationItemRemove, CartMutationRemoveCoupon, CartMutationRemovePaymentMethod, CartMutationSetBillingAddress, CartMutationSetShippingInfo, CheckoutMutationAddPaymentInstruction, CheckoutMutationFinalizeCheckout, CheckoutMutationInitiateCheckout, CheckoutMutationRemovePaymentInstruction, CheckoutMutationSetShippingAddress, CheckoutMutationSetShippingInstruction, IdentityMutationLogin, IdentityMutationLogout, IdentityMutationRegister, ProfileMutationUpdate, } from './schemas/mutations/index.js';
-export { BaseQuerySchema, CartQueryByIdSchema, CategoryQueryById, CategoryQueryBySlug, CategoryQueryForBreadcrumb, CategoryQueryForChildCategories, CategoryQueryForTopCategories, CheckoutQueryByIdSchema, CheckoutQueryForAvailablePaymentMethodsSchema, CheckoutQueryForAvailableShippingMethodsSchema, IdentityQuerySelfSchema, InventoryQueryBySKUSchema, OrderQueryByIdSchema, PriceQueryBySkuSchema, ProductQueryByIdSchema, ProductQueryBySKUSchema, ProductQueryBySlugSchema, ProductQueryVariantsSchema, ProductSearchQueryByTermSchema, ProfileQuerySelfSchema, StoreQueryByProximitySchema, } from './schemas/queries/index.js';
-export type { BaseQuery, CartQueryById, CheckoutQueryById, CheckoutQueryForAvailablePaymentMethods, CheckoutQueryForAvailableShippingMethods, IdentityQuerySelf, InventoryQueryBySKU, OrderQueryById, PriceQueryBySku, ProductQueryById, ProductQueryBySKU, ProductQueryBySlug, ProductQueryVariants, ProductSearchQueryByTerm, ProfileQuerySelf, StoreQueryByProximity, } from './schemas/queries/index.js';
+export { BaseQuerySchema, CartQueryByIdSchema, CategoryQueryByIdSchema, CategoryQueryBySlugSchema, CategoryQueryForBreadcrumbSchema, CategoryQueryForChildCategoriesSchema, CategoryQueryForTopCategoriesSchema, CheckoutQueryByIdSchema, CheckoutQueryForAvailablePaymentMethodsSchema, CheckoutQueryForAvailableShippingMethodsSchema, IdentityQuerySelfSchema, InventoryQueryBySKUSchema, OrderQueryByIdSchema, PriceQueryBySkuSchema, ProductQueryByIdSchema, ProductQueryBySKUSchema, ProductQueryBySlugSchema, ProductQueryVariantsSchema, ProductSearchQueryByTermSchema, ProfileQuerySelfSchema, StoreQueryByProximitySchema, } from './schemas/queries/index.js';
+export type { BaseQuery, CartQueryById, CheckoutQueryById, CategoryQueryById, CategoryQueryBySlug, CategoryQueryForBreadcrumb, CategoryQueryForChildCategories, CategoryQueryForTopCategories, CheckoutQueryForAvailablePaymentMethods, CheckoutQueryForAvailableShippingMethods, IdentityQuerySelf, InventoryQueryBySKU, OrderQueryById, PriceQueryBySku, ProductQueryById, ProductQueryBySKU, ProductQueryBySlug, ProductQueryVariants, ProductSearchQueryByTerm, ProfileQuerySelf, StoreQueryByProximity, } from './schemas/queries/index.js';
 export { createInitialRequestContext } from './initialization.js';

package/src/schemas/queries/category.query.d.ts

@@ -1,18 +1,18 @@
 import { z } from "zod";
-export declare const CategoryQueryById: z.ZodObject<{
+export declare const CategoryQueryByIdSchema: z.ZodObject<{
     id: z.ZodDefault<z.ZodObject<{
         key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
-export declare const CategoryQueryBySlug: z.ZodObject<{
+export declare const CategoryQueryBySlugSchema: z.ZodObject<{
     slug: z.ZodDefault<z.ZodString>;
 }, z.core.$loose>;
-export declare const CategoryQueryForBreadcrumb: z.ZodObject<{
+export declare const CategoryQueryForBreadcrumbSchema: z.ZodObject<{
     id: z.ZodDefault<z.ZodObject<{
         key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
-export declare const CategoryQueryForChildCategories: z.ZodObject<{
+export declare const CategoryQueryForChildCategoriesSchema: z.ZodObject<{
     parentId: z.ZodDefault<z.ZodObject<{
         key: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
     }, z.core.$loose>>;
@@ -21,14 +21,14 @@ export declare const CategoryQueryForChildCategories: z.ZodObject<{
         pageSize: z.ZodDefault<z.ZodNumber>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
-export declare const CategoryQueryForTopCategories: z.ZodObject<{
+export declare const CategoryQueryForTopCategoriesSchema: z.ZodObject<{
     paginationOptions: z.ZodDefault<z.ZodObject<{
         pageNumber: z.ZodDefault<z.ZodNumber>;
         pageSize: z.ZodDefault<z.ZodNumber>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
-export type CategoryQueryById = z.infer<typeof CategoryQueryById>;
-export type CategoryQueryBySlug = z.infer<typeof CategoryQueryBySlug>;
-export type CategoryQueryForBreadcrumb = z.infer<typeof CategoryQueryForBreadcrumb>;
-export type CategoryQueryForChildCategories = z.infer<typeof CategoryQueryForChildCategories>;
-export type CategoryQueryForTopCategories = z.infer<typeof CategoryQueryForTopCategories>;
+export type CategoryQueryById = z.infer<typeof CategoryQueryByIdSchema>;
+export type CategoryQueryBySlug = z.infer<typeof CategoryQueryBySlugSchema>;
+export type CategoryQueryForBreadcrumb = z.infer<typeof CategoryQueryForBreadcrumbSchema>;
+export type CategoryQueryForChildCategories = z.infer<typeof CategoryQueryForChildCategoriesSchema>;
+export type CategoryQueryForTopCategories = z.infer<typeof CategoryQueryForTopCategoriesSchema>;