@reactionary/source 0.6.1 → 0.6.3

package/packages/core/src/capabilities/index.ts

@@ -0,0 +1,18 @@
+export * from './analytics.capability.js';
+export * from './base.capability.js';
+export * from './cart.capability.js';
+export * from './category.capability.js';
+export * from './checkout.capability.js';
+export * from './identity.capability.js';
+export * from './inventory.capability.js';
+export * from './price.capability.js';
+export * from './product.capability.js';
+export * from './profile.capability.js';
+export * from './product-search.capability.js';
+export * from './product-recommendations.capability.js';
+export * from './product-associations.capability.js';
+export * from './product-reviews.capability.js';
+export * from './product-list.capability.js'
+export * from './store.capability.js';
+export * from './order.capability.js'
+export * from './order-search.capability.js'

package/{core/src/providers/inventory.provider.ts → packages/core/src/capabilities/inventory.capability.ts}

@@ -3,22 +3,22 @@ import type { InventoryIdentifier } from '../schemas/models/identifiers.model.js
 import type { Inventory } from '../schemas/models/inventory.model.js';
 import type { InventoryQueryBySKU } from '../schemas/queries/inventory.query.js';
 import type { Result } from '../schemas/result.js';
-import { BaseProvider } from './base.provider.js';
+import { BaseCapability } from './base.capability.js';
 
-export abstract class InventoryProvider extends BaseProvider {
-  public abstract getBySKU(payload: InventoryQueryBySKU): Promise<Result<Inventory, NotFoundError>>;
+export abstract class InventoryCapability<TInventory extends Inventory = Inventory> extends BaseCapability {
+  public abstract getBySKU(payload: InventoryQueryBySKU): Promise<Result<TInventory, NotFoundError>>;
 
   protected override getResourceName(): string {
     return 'inventory';
   }
 
-  protected createEmptyInventory(key: InventoryIdentifier): Inventory {
+  protected createEmptyInventory(key: InventoryIdentifier): TInventory {
     const inventory = {
         identifier: key,
         quantity: 0,
         status: 'outOfStock'
     } satisfies Inventory;
 
-    return inventory;
+    return inventory as unknown as TInventory;
   }
 }

package/{core/src/providers/order-search.provider.ts → packages/core/src/capabilities/order-search.capability.ts}

@@ -1,7 +1,7 @@
 import type { OrderSearchResult } from "../schemas/models/order-search.model.js";
 import type { OrderSearchQueryByTerm } from "../schemas/queries/order-search.query.js";
 import type { Result } from "../schemas/result.js";
-import { BaseProvider } from "./base.provider.js";
+import { BaseCapability } from "./base.capability.js";
 
 /**
  * This provider handles order search operations. In some situations you may have different providers for order history listing and detail retrieval.
@@ -9,7 +9,9 @@ import { BaseProvider } from "./base.provider.js";
  *
  * Usecase: An e-commerce platform wants to provide customers with a way to search through their past orders using filters like date range, order status, or total amount spent.
  */
-export abstract class OrderSearchProvider extends BaseProvider {
+export abstract class OrderSearchCapability<
+  TOrderSearchResult extends OrderSearchResult = OrderSearchResult,
+> extends BaseCapability {
   protected override getResourceName(): string {
     return 'order-search';
   }
@@ -21,7 +23,7 @@ export abstract class OrderSearchProvider extends BaseProvider {
    * Usecase: A widget on the frontpage after login, shows the last 5 orders placed by the customer.
    * @param payload The search criteria for querying orders.
    */
-  public abstract queryByTerm(payload: OrderSearchQueryByTerm): Promise<Result<OrderSearchResult>>;
+  public abstract queryByTerm(payload: OrderSearchQueryByTerm): Promise<Result<TOrderSearchResult>>;
 
 
 

package/{core/src/providers/order.provider.ts → packages/core/src/capabilities/order.capability.ts}

@@ -1,10 +1,10 @@
-import { BaseProvider } from './base.provider.js';
+import { BaseCapability } from './base.capability.js';
 import type { Order } from '../schemas/models/index.js';
 import type { OrderQueryById } from '../schemas/queries/index.js';
 import type { Result } from '../schemas/result.js';
 import type { NotFoundError } from '../schemas/index.js';
 
-export abstract class OrderProvider extends BaseProvider {
+export abstract class OrderCapability<TOrder extends Order = Order> extends BaseCapability {
   /**
    * Get order by ID.
    *
@@ -12,9 +12,9 @@ export abstract class OrderProvider extends BaseProvider {
    * @param payload
    * @param session
    */
-  public abstract getById(payload: OrderQueryById): Promise<Result<Order, NotFoundError>>;
+  public abstract getById(payload: OrderQueryById): Promise<Result<TOrder, NotFoundError>>;
 
-  protected createEmptyOrder(): Order {
+  protected createEmptyOrder(): TOrder {
     const order = {
       identifier: {
         key: '',
@@ -54,7 +54,7 @@ export abstract class OrderProvider extends BaseProvider {
       },
     } satisfies Order;
 
-    return order;
+    return order as unknown as TOrder;
   }
 
   protected override getResourceName(): string {

package/{core/src/providers/price.provider.ts → packages/core/src/capabilities/price.capability.ts}

@@ -3,9 +3,9 @@ import type {
   CustomerPriceQuery,
   ListPriceQuery,
 } from '../schemas/queries/price.query.js';
-import { BaseProvider } from './base.provider.js';
+import { BaseCapability } from './base.capability.js';
 
-export abstract class PriceProvider extends BaseProvider {
+export abstract class PriceCapability<TPrice extends Price = Price> extends BaseCapability {
   /**
    * Get a list price price by SKU. This is the most general, undiscounted price and is typically
    * used as the "before" price in most ecommerce setups.
@@ -14,7 +14,7 @@ export abstract class PriceProvider extends BaseProvider {
    * @param payload The SKU to query
    * @param session The session information
    */
-  public abstract getListPrice(payload: ListPriceQuery): Promise<Result<Price>>;
+  public abstract getListPrice(payload: ListPriceQuery): Promise<Result<TPrice>>;
 
   /**
    * Get a customer-specific price by SKU.
@@ -25,7 +25,7 @@ export abstract class PriceProvider extends BaseProvider {
    * @param payload The SKU to query
    * @param session The session information
    */
-  public abstract getCustomerPrice(payload: CustomerPriceQuery): Promise<Result<Price>>;
+  public abstract getCustomerPrice(payload: CustomerPriceQuery): Promise<Result<TPrice>>;
 
   /**
    * Utility function to create an empty price result, with a value of -1.
@@ -35,7 +35,7 @@ export abstract class PriceProvider extends BaseProvider {
    * @param currency
    * @returns
    */
-  protected createEmptyPriceResult(sku: string): Price {
+  protected createEmptyPriceResult(sku: string): TPrice {
     const price = {
       identifier: {
         variant: {
@@ -50,7 +50,7 @@ export abstract class PriceProvider extends BaseProvider {
       onSale: false,
     } satisfies Price;
 
-    return price;
+    return price as unknown as TPrice;
   }
 
   protected override getResourceName(): string {

package/{core/src/providers/product-associations.provider.ts → packages/core/src/capabilities/product-associations.capability.ts}

@@ -1,6 +1,6 @@
 import type { ProductIdentifier, ProductVariantIdentifier } from "../schemas/index.js";
 import type { ProductAssociationsGetAccessoriesQuery, ProductAssociationsGetSparepartsQuery, ProductAssociationsGetReplacementsQuery } from "../schemas/queries/product-associations.query.js";
-import { BaseProvider } from "./base.provider.js";
+import { BaseCapability } from "./base.capability.js";
 import type { Result } from '../schemas/result.js';
 import type { ProductAssociation } from '../schemas/models/product-associations.model.js';
 
@@ -9,7 +9,9 @@ import type { ProductAssociation } from '../schemas/models/product-associations.
  * accessories, spareparts, and replacements. These associations are typically used to provide recommendations to customers on the product detail page, but can also be used in other contexts such as the cart or post-purchase, but
  * do not carry any personalization concept to them.
  */
-export abstract class ProductAssociationsProvider extends BaseProvider {
+export abstract class ProductAssociationsCapability<
+  TProductAssociation extends ProductAssociation = ProductAssociation,
+> extends BaseCapability {
 
   /**
    * Returns a list of product identifiers which are accessories to the given product.
@@ -23,7 +25,7 @@ export abstract class ProductAssociationsProvider extends BaseProvider {
    *
    * TODO:  This should be a PaginatedResult
    */
-  public abstract getAccessories(query: ProductAssociationsGetAccessoriesQuery): Promise<Result<ProductAssociation[]>>;
+  public abstract getAccessories(query: ProductAssociationsGetAccessoriesQuery): Promise<Result<TProductAssociation[]>>;
 
   /**
    * Returns a list of product identifiers which are spareparts to the given product.
@@ -34,7 +36,7 @@ export abstract class ProductAssociationsProvider extends BaseProvider {
    *
    * TODO:  This should be a PaginatedResult
    */
-  public abstract getSpareparts(query: ProductAssociationsGetSparepartsQuery): Promise<Result<ProductAssociation[]>>;
+  public abstract getSpareparts(query: ProductAssociationsGetSparepartsQuery): Promise<Result<TProductAssociation[]>>;
 
 
   /**
@@ -43,7 +45,7 @@ export abstract class ProductAssociationsProvider extends BaseProvider {
    * TODO:  This should be a PaginatedResult
    * @param query
    */
-  public abstract getReplacements(query: ProductAssociationsGetReplacementsQuery): Promise<Result<ProductAssociation[]>>;
+  public abstract getReplacements(query: ProductAssociationsGetReplacementsQuery): Promise<Result<TProductAssociation[]>>;
 
 
   getResourceName(): string {

package/{core/src/providers/product-list.provider.ts → packages/core/src/capabilities/product-list.capability.ts}

@@ -3,7 +3,7 @@ import type { ProductListItemMutationCreate, ProductListItemMutationDelete, Prod
 import type { ProductListQuery, ProductListQueryById } from "../schemas/queries/product-list.query.js";
 import { type ProductListItemsQuery } from "../schemas/queries/product-list.query.js";
 import type { Result } from "../schemas/result.js";
-import { BaseProvider } from "./base.provider.js";
+import { BaseCapability } from "./base.capability.js";
 
 /**
  * The product list provider is a general purpose provider for creating various types of product lists, such as favorite lists, projects, wishlists, requisitionlists, etc
@@ -13,7 +13,12 @@ import { BaseProvider } from "./base.provider.js";
  *
  * Some systems might only support single entries of each type, but the general case is to support multiples.
  */
-export abstract class ProductListProvider extends BaseProvider {
+export abstract class ProductListCapability<
+  TProductList extends ProductList = ProductList,
+  TProductListItem extends ProductListItem = ProductListItem,
+  TProductListPaginatedResult extends ProductListPaginatedResult = ProductListPaginatedResult,
+  TProductListItemPaginatedResult extends ProductListItemPaginatedResult = ProductListItemPaginatedResult,
+> extends BaseCapability {
 
   protected getResourceName(): string {
     return 'product-lists';
@@ -24,7 +29,7 @@ export abstract class ProductListProvider extends BaseProvider {
    * you might have stored the identifier from an earlier session or looked it up previously.
    * @param payload
    */
-  public abstract getById(payload: ProductListQueryById): Promise<Result<ProductList>>;
+  public abstract getById(payload: ProductListQueryById): Promise<Result<TProductList>>;
 
 
   /**
@@ -33,7 +38,7 @@ export abstract class ProductListProvider extends BaseProvider {
    *
    * @param query
    */
-  public abstract queryLists(query: ProductListQuery): Promise<Result<ProductListPaginatedResult>>;
+  public abstract queryLists(query: ProductListQuery): Promise<Result<TProductListPaginatedResult>>;
 
 
   /**
@@ -44,14 +49,14 @@ export abstract class ProductListProvider extends BaseProvider {
    * which the customer can then add the product to.
    * @param mutation
    */
-  public abstract addList(mutation: ProductListMutationCreate): Promise<Result<ProductList>>;
+  public abstract addList(mutation: ProductListMutationCreate): Promise<Result<TProductList>>;
 
   /**
    *
    * Usecase: update name of list, or other metadata related to the list, such as "this is my summer wishlist", or "this is my favorite list for cameras".
    * @param mutation
    */
-  public abstract updateList(mutation: ProductListMutationUpdate): Promise<Result<ProductList>>;
+  public abstract updateList(mutation: ProductListMutationUpdate): Promise<Result<TProductList>>;
 
   /**
    * Usecase: customer wants to delete a list, such as "delete my summer wishlist", including all the product list items
@@ -63,13 +68,13 @@ export abstract class ProductListProvider extends BaseProvider {
    * Usecase: in the frontend you want to show a list of the products in the customers wishlist.
    * @param query
    */
-  public abstract queryListItems(query: ProductListItemsQuery): Promise<Result<ProductListItemPaginatedResult>>;
+  public abstract queryListItems(query: ProductListItemsQuery): Promise<Result<TProductListItemPaginatedResult>>;
 
   /**
    * Usecase: Add a new product-variant to a list
    * @param mutation
    */
-  public abstract addItem(mutation: ProductListItemMutationCreate): Promise<Result<ProductListItem>>;
+  public abstract addItem(mutation: ProductListItemMutationCreate): Promise<Result<TProductListItem>>;
 
   /**
    * Usecase: Remove a product-variant from a list.
@@ -81,6 +86,6 @@ export abstract class ProductListProvider extends BaseProvider {
    * Usecase: Update the quantity of a product-variant in a list.
    * @param mutation
    */
-  public abstract updateItem(mutation: ProductListItemMutationUpdate): Promise<Result<ProductListItem>>;
+  public abstract updateItem(mutation: ProductListItemMutationUpdate): Promise<Result<TProductListItem>>;
 
 }

package/{core/src/providers/product-recommendations.provider.ts → packages/core/src/capabilities/product-recommendations.capability.ts}

@@ -2,12 +2,12 @@ import type { Cache } from '../cache/cache.interface.js';
 import { Reactionary } from "../decorators/reactionary.decorator.js";
 import { success, type ProductRecommendation, type ProductRecommendationsByCollectionQuery, type RequestContext, type Result } from "../schemas/index.js";
 import { ProductRecommendationsQuerySchema, type ProductRecommendationAlgorithmAlsoViewedProductsQuery, type ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery, type ProductRecommendationAlgorithmPopuplarProductsQuery, type ProductRecommendationAlgorithmRelatedProductsQuery, type ProductRecommendationAlgorithmSimilarProductsQuery, type ProductRecommendationAlgorithmTopPicksProductsQuery, type ProductRecommendationAlgorithmTrendingInCategoryQuery, type ProductRecommendationsQuery } from "../schemas/queries/product-recommendations.query.js";
-import { BaseProvider } from "./base.provider.js";
+import { BaseCapability } from "./base.capability.js";
 
-export abstract class ProductRecommendationsProvider extends BaseProvider {
+export abstract class ProductRecommendationsCapability extends BaseCapability {
 
   /**
-   * returns a list of recommended products, based on the selected algorithm and the provided query parameters. The recommendations should be relevant to the product specified in the query, and can be personalized based on the customer segments or contexts provided. The provider should return a list of product variant identifiers that are recommended for the given product, which can then be used to fetch the full product details from the product provider if needed.
+   * returns a list of recommended products, based on the selected algorithm and the provided query parameters. The recommendations should be relevant to the product specified in the query, and can be personalized based on the customer segments or contexts provided. The capability should return a list of product variant identifiers that are recommended for the given product, which can then be used to fetch the full product details from the product capability if needed.
    *   *
    * Usecase:
    *   - PDP - "Customers who viewed this product also viewed"
@@ -89,17 +89,17 @@ export abstract class ProductRecommendationsProvider extends BaseProvider {
 
 
 
-export class MulticastProductRecommendationsProvider extends ProductRecommendationsProvider {
-  protected providers: Array<ProductRecommendationsProvider>;
+export class MulticastProductRecommendationsCapability extends ProductRecommendationsCapability {
+  protected capabilities: Array<ProductRecommendationsCapability>;
 
   constructor(
     cache: Cache,
     requestContext: RequestContext,
-    providers: Array<ProductRecommendationsProvider>
+    capabilities: Array<ProductRecommendationsCapability>
   ) {
     super(cache, requestContext);
 
-    this.providers = providers;
+    this.capabilities = capabilities;
   }
 
   @Reactionary({
@@ -107,15 +107,15 @@ export class MulticastProductRecommendationsProvider extends ProductRecommendati
   })
   public override  async getRecommendations(query: ProductRecommendationsQuery): Promise<Result<ProductRecommendation[]>> {
     const output = [];
-    for (const provider of this.providers) {
-      const providerOutput = await provider.getRecommendations(query);
-      if (providerOutput.success) {
+    for (const capability of this.capabilities) {
+      const capabilityOutput = await capability.getRecommendations(query);
+      if (capabilityOutput.success) {
 
-        output.push(...providerOutput.value);
+        output.push(...capabilityOutput.value);
       } else {
         // For other types of errors, we might want to log them or handle them differently
-        console.error(`Error from provider ${provider.constructor.name}:`, providerOutput.error);
-        return providerOutput
+        console.error(`Error from capability ${capability.constructor.name}:`, capabilityOutput.error);
+        return capabilityOutput
       }
       if (output.length >= query.numberOfRecommendations) {
         break;
@@ -126,18 +126,18 @@ export class MulticastProductRecommendationsProvider extends ProductRecommendati
 
   public override async getCollection(query: ProductRecommendationsByCollectionQuery): Promise<Result<ProductRecommendation[]>> {
     const output = [];
-    for (const provider of this.providers) {
-      const providerOutput = await provider.getCollection(query);
-      if (providerOutput.success) {
-        output.push(...providerOutput.value);
+    for (const capability of this.capabilities) {
+      const capabilityOutput = await capability.getCollection(query);
+      if (capabilityOutput.success) {
+        output.push(...capabilityOutput.value);
       } else {
-        if (providerOutput.error.type === 'NotFound') {
-          // If the error is a NotFound error, we can ignore it and continue to the next provider
+        if (capabilityOutput.error.type === 'NotFound') {
+          // If the error is a NotFound error, we can ignore it and continue to the next capability
           continue;
         } else {
           // For other types of errors, we might want to log them or handle them differently
-          console.error(`Error from provider ${provider.constructor.name}:`, providerOutput.error);
-          return providerOutput;
+          console.error(`Error from capability ${capability.constructor.name}:`, capabilityOutput.error);
+          return capabilityOutput;
         }
       }
       if (output.length >= query.numberOfRecommendations) {

package/{core/src/providers/product-reviews.provider.ts → packages/core/src/capabilities/product-reviews.capability.ts}

@@ -1,14 +1,18 @@
 import type { Result, ProductReview, ProductRatingSummary, ProductReviewPaginatedResult } from '../schemas/index.js';
 import type { ProductReviewsListQuery, ProductReviewsGetRatingSummaryQuery } from '../schemas/queries/product-reviews.query.js';
 import type { ProductReviewMutationSubmit } from '../schemas/mutations/product-reviews.mutation.js';
-import { BaseProvider } from './base.provider.js';
+import { BaseCapability } from './base.capability.js';
 import { type ProductRatingIdentifier } from '../schemas/models/identifiers.model.js';
 /**
  * The product reviews provider is responsible for providing detailed product reviews from customers.
  * Reviews contain ratings along with textual feedback, author information, and verification status.
  * This provider also handles aggregated rating summaries for products.
  */
-export abstract class ProductReviewsProvider extends BaseProvider {
+export abstract class ProductReviewsCapability<
+  TProductRatingSummary extends ProductRatingSummary = ProductRatingSummary,
+  TProductReviewPaginatedResult extends ProductReviewPaginatedResult = ProductReviewPaginatedResult,
+  TProductReview extends ProductReview = ProductReview,
+> extends BaseCapability {
   /**
    * Get the rating summary for a product, including average rating and distribution.
    *
@@ -17,7 +21,7 @@ export abstract class ProductReviewsProvider extends BaseProvider {
    */
   public abstract getRatingSummary(
     query: ProductReviewsGetRatingSummaryQuery
-  ): Promise<Result<ProductRatingSummary>>;
+  ): Promise<Result<TProductRatingSummary>>;
 
   /**
    * Get a paginated list of reviews for a product.
@@ -27,7 +31,7 @@ export abstract class ProductReviewsProvider extends BaseProvider {
    */
   public abstract findReviews(
     query: ProductReviewsListQuery
-  ): Promise<Result<ProductReviewPaginatedResult>>;
+  ): Promise<Result<TProductReviewPaginatedResult>>;
   /**
    * Submit a review for a product.
    *
@@ -36,7 +40,7 @@ export abstract class ProductReviewsProvider extends BaseProvider {
    */
   public abstract submitReview(
     mutation: ProductReviewMutationSubmit
-  ): Promise<Result<ProductReview>>;
+  ): Promise<Result<TProductReview>>;
 
 
   protected createEmptyProductRatingSummary(key: ProductRatingIdentifier): ProductRatingSummary {

package/packages/core/src/capabilities/product-search.capability.ts

@@ -0,0 +1,48 @@
+import type { Category, FacetValueIdentifier, Result } from '../index.js';
+import type { ProductSearchResult } from '../schemas/models/product-search.model.js';
+import type {
+  ProductSearchQueryByTerm,
+  ProductSearchQueryCreateNavigationFilter,
+} from '../schemas/queries/product-search.query.js';
+import { BaseCapability } from './base.capability.js';
+
+export abstract class ProductSearchCapability<
+  TProductSearchResult extends ProductSearchResult = ProductSearchResult,
+> extends BaseCapability {
+  protected override getResourceName(): string {
+    return 'product-search';
+  }
+
+  public abstract queryByTerm(
+    payload: ProductSearchQueryByTerm,
+  ): Promise<Result<TProductSearchResult>>;
+
+  /**
+   * Since each platform has it own way of representing categories and their hierarchy, we leave it to the platform to tell us how to get from a
+   * category breadcrumb path to a global category navigation filter that can be applied to product searches.
+   *
+   * So, the CLP pattern would be
+   *
+   * const c: Category = await categoryProvider.getBySlug({ slug: 'some-category' });
+   * const breadcrumbPath: Category[] = await categoryProvider.getBreadcrumbPathToCategory({ id: c.identifier });
+   * const categoryFilter: FacetValueIdentifier = categoryNavigationProvider.createCategoryNavigationFilterBreadcrumbs(breadcrumbPath);
+   * const searchResult: ProductSearchResult = await productSearchProvider.queryByTerm({ term: 'some search', facets: [], categoryFilter: [categoryFilter], ... });
+   *
+   * from here, you would maybe get facets back with subcategories, but those are relative to the current category filter you have applied, so you
+   * do not need any special handling for that.
+   *
+   * Usecase: You are rendering a category page and you want to run a product search to find everything in that category (or below).
+   *
+   * @param categoryPath
+   */
+  public abstract createCategoryNavigationFilter(
+    payload: ProductSearchQueryCreateNavigationFilter,
+  ): Promise<Result<FacetValueIdentifier>>;
+
+  /**
+   * Parses a facet value from the search response.
+   * @param facetValueIdentifier The identifier for the facet value.
+   * @param label The label for the facet value.
+   * @param count The count for the facet value.
+   */
+}

package/{core/src/providers/product.provider.ts → packages/core/src/capabilities/product.capability.ts}

@@ -1,10 +1,10 @@
 import type { Product } from '../schemas/models/product.model.js';
-import { BaseProvider } from './base.provider.js';
+import { BaseCapability } from './base.capability.js';
 import type { ProductQueryById, ProductQueryBySKU, ProductQueryBySlug } from '../schemas/queries/product.query.js';
 import type { Result } from '../schemas/result.js';
 import type { NotFoundError } from '../schemas/index.js';
 
-export abstract class ProductProvider extends BaseProvider {
+export abstract class ProductCapability<TProduct extends Product = Product> extends BaseCapability {
 
 
   /**
@@ -17,7 +17,7 @@ export abstract class ProductProvider extends BaseProvider {
    * Marketing will TYPICALLY recommend products, and in some cases maybe HeroVariants of a product.
    * In that case, you would need to resolve the product to its hero variant first, and then get the SKU from there.
    */
-  public abstract getById(payload: ProductQueryById): Promise<Result<Product>>;
+  public abstract getById(payload: ProductQueryById): Promise<Result<TProduct>>;
 
 
   /**
@@ -27,7 +27,7 @@ export abstract class ProductProvider extends BaseProvider {
    *
    * Usecase: You are rendering a product detail page, and you need to fetch the product by its slug.
    */
-  public abstract getBySlug(payload: ProductQueryBySlug): Promise<Result<Product, NotFoundError>>;
+  public abstract getBySlug(payload: ProductQueryBySlug): Promise<Result<TProduct, NotFoundError>>;
 
 
   /**
@@ -39,9 +39,9 @@ export abstract class ProductProvider extends BaseProvider {
    * and you need to fetch the product details for that SKU. You will get the a Product back, with the variant matching the SKU set as heroSku.
    * It might also be used on a quick-order page, or product recommendations from external system.
    */
-  public abstract getBySKU(payload: ProductQueryBySKU): Promise<Result<Product>>;
+  public abstract getBySKU(payload: ProductQueryBySKU): Promise<Result<TProduct>>;
 
-  protected createEmptyProduct(id: string): Product {
+  protected createEmptyProduct(id: string): TProduct {
     // FIXME: We can probably get rid of this once we switch to errors as values, as we shouldn't even
     // be materializing an empty product...
     const product = {
@@ -73,7 +73,7 @@ export abstract class ProductProvider extends BaseProvider {
       variants: [],
     } satisfies Product;
 
-    return product;
+    return product as unknown as TProduct;
   }
 
   /**

package/{core/src/providers/profile.provider.ts → packages/core/src/capabilities/profile.capability.ts}

@@ -3,9 +3,9 @@ import type { Profile } from '../schemas/models/index.js';
 import type { ProfileMutationAddShippingAddress, ProfileMutationMakeShippingAddressDefault, ProfileMutationRemoveShippingAddress, ProfileMutationSetBillingAddress, ProfileMutationUpdate, ProfileMutationUpdateShippingAddress } from '../schemas/mutations/index.js';
 import type { ProfileQuerySelf as ProfileQueryById } from '../schemas/queries/index.js';
 import type { Result } from '../schemas/result.js';
-import { BaseProvider } from './base.provider.js';
+import { BaseCapability } from './base.capability.js';
 
-export abstract class ProfileProvider extends BaseProvider {
+export abstract class ProfileCapability<TProfile extends Profile = Profile> extends BaseCapability {
 
   /**
    * Returns the profile of the currently authenticated (registered) user.
@@ -13,7 +13,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: Fetch the profile of the logged-in user for display in header, or account settings.
    * @param payload
    */
-  public abstract getById(payload: ProfileQueryById): Promise<Result<Profile, NotFoundError>>;
+  public abstract getById(payload: ProfileQueryById): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Updates the base profile information of the currently authenticated (registered) user.
@@ -26,7 +26,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: Update the user's name, email, or phone number.
    * @param payload
    */
-  public abstract update(payload: ProfileMutationUpdate): Promise<Result<Profile, NotFoundError>>;
+  public abstract update(payload: ProfileMutationUpdate): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Creates a new shipping address for the currently authenticated (registered) user.
@@ -36,7 +36,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * done at checkout should be considered local to that session, unless the addressbook is empty.
    * @param payload
    */
-  public abstract addShippingAddress(payload: ProfileMutationAddShippingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract addShippingAddress(payload: ProfileMutationAddShippingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Updates an existing shipping address for the currently authenticated (registered) user.
@@ -45,7 +45,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * done at checkout should be considered local to that session/order, unless the addressbook is empty.
    * @param payload
    */
-  public abstract updateShippingAddress(payload: ProfileMutationUpdateShippingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract updateShippingAddress(payload: ProfileMutationUpdateShippingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Removes an existing shipping address for the currently authenticated (registered) user.
@@ -55,7 +55,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: User deletes a shipping address from their profile.
    * @param payload
    */
-  public abstract removeShippingAddress(payload: ProfileMutationRemoveShippingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract removeShippingAddress(payload: ProfileMutationRemoveShippingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Configures an existing shipping address as the default shipping address for the currently authenticated (registered) user.
@@ -63,7 +63,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: User selects a default shipping address in their profile.
    * @param payload
    */
-  public abstract makeShippingAddressDefault(payload: ProfileMutationMakeShippingAddressDefault): Promise<Result<Profile, NotFoundError>>;
+  public abstract makeShippingAddressDefault(payload: ProfileMutationMakeShippingAddressDefault): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Sets the current/active billing address for the currently authenticated (registered) user.
@@ -74,7 +74,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * entity being billed, and as such it makes sense to have a single authoritative billing address.
    * @param payload
    */
-  public abstract setBillingAddress(payload: ProfileMutationSetBillingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract setBillingAddress(payload: ProfileMutationSetBillingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   protected override getResourceName(): string {
     return 'profile';

package/{core/src/providers/store.provider.ts → packages/core/src/capabilities/store.capability.ts}

@@ -1,10 +1,10 @@
 import type { Store } from '../schemas/models/store.model.js';
 import type { StoreQueryByProximity } from '../schemas/queries/index.js';
 import type { Result } from '../schemas/result.js';
-import { BaseProvider } from './base.provider.js';
+import { BaseCapability } from './base.capability.js';
 
-export abstract class StoreProvider extends BaseProvider {
-  public abstract queryByProximity(payload: StoreQueryByProximity): Promise<Result<Array<Store>>>;
+export abstract class StoreCapability<TStore extends Store = Store> extends BaseCapability {
+  public abstract queryByProximity(payload: StoreQueryByProximity): Promise<Result<Array<TStore>>>;
 
   protected override getResourceName(): string {
     return 'store';