docs: publish restructure (#3496)

* docs: added features and guides overview page * added image * added version 2 * added version 3 * added version 4 * docs: implemented new color scheme * docs: redesigned sidebar (#3193) * docs: redesigned navbar for restructure (#3199) * docs: redesigned footer (#3209) * docs: redesigned cards (#3230) * docs: redesigned admonitions (#3231) * docs: redesign announcement bar (#3236) * docs: redesigned large cards (#3239) * docs: redesigned code blocks (#3253) * docs: redesigned search modal and page (#3264) * docs: redesigned doc footer (#3268) * docs: added new sidebars + refactored css and assets (#3279) * docs: redesigned api reference sidebar * docs: refactored css * docs: added code tabs transition * docs: added new sidebars * removed unused assets * remove unusued assets * Fix deploy errors * fix incorrect link * docs: fixed code responsivity + missing icons (#3283) * docs: changed icons (#3296) * docs: design fixes to the sidebar (#3297) * redesign fixes * docs: small design fixes * docs: several design fixes after restructure (#3299) * docs: bordered icon fixes * docs: desgin fixes * fixes to code blocks and sidebar scroll * design adjustments * docs: restructured homepage (#3305) * docs: restructured homepage * design fixes * fixed core concepts icon * docs: added core concepts page (#3318) * docs: restructured homepage * design fixes * docs: added core concepts page * changed text of different components * docs: added architecture link * added missing prop for user guide * docs: added regions overview page (#3327) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page (#3331) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page * fix link * resolve link issues * docs: updated regions architecture image * docs: second-iteration fixes (#3347) * docs: redesigned document * design fixes * docs: added products overview page (#3354) * docs: added carts overview page (#3363) * docs: added orders overview (#3364) * docs: added orders overview * added links in overview * docs: added vercel redirects * docs: added soon badge for cards (#3389) * docs: resolved feedback changes + organized troubleshooting pages (#3409) * docs: resolved feedback changes * added extra line * docs: changed icons for restructure (#3421) * docs: added taxes overview page (#3422) * docs: added taxes overview page * docs: fix sidebar label * added link to taxes overview page * fixed link * docs: fixed sidebar scroll (#3429) * docs: added discounts overview (#3432) * docs: added discounts overview * fixed links * docs: added gift cards overview (#3433) * docs: added price lists overview page (#3440) * docs: added price lists overview page * fixed links * docs: added sales channels overview page (#3441) * docs: added sales overview page * fixed links * docs: added users overview (#3443) * docs: fixed sidebar border height (#3444) * docs: fixed sidebar border height * fixed svg markup * docs: added possible solutions to feedback component (#3449) * docs: added several overview pages + restructured files (#3463) * docs: added several overview pages * fixed links * docs: added feature flags + PAK overview pages (#3464) * docs: added feature flags + PAK overview pages * fixed links * fix link * fix link * fixed links colors * docs: added strategies overview page (#3468) * docs: automated upgrade guide (#3470) * docs: automated upgrade guide * fixed vercel redirect * docs: restructured files in docs codebase (#3475) * docs: restructured files * docs: fixed eslint exception * docs: finished restructure loose-ends (#3493) * fixed uses of backend * docs: finished loose ends * eslint fixes * fixed links * merged master * added update instructions for v1.7.12
2023-03-16 17:03:10 +02:00
parent f312ce1e0f
commit 1decaa27c7
415 changed files with 12422 additions and 5098 deletions
@@ -0,0 +1,128 @@
+---
+description: 'Learn how to override the price selection strategy. The price selection strategy is used to determine the best price based on a specific context.'
+addHowToData: true
+---
+
+# How to Override Price Selection Strategy
+
+In this document, you’ll learn how to override Medusa’s price selection strategy to create a custom pricing strategy.
+
+:::note
+
+If you’re interested in learning what a price selection strategy is and how it works, check out [this documentation](../price-selection-strategy.md) instead.
+
+:::
+
+## 1. Create Class
+
+Create a TypeScript or JavaScript file in `src/strategies` of your Medusa backend project with a class that extends the `AbstractPriceSelectionStrategy` class:
+
+```ts title=src/strategies/price.ts
+import { 
+  AbstractPriceSelectionStrategy, 
+  IPriceSelectionStrategy, 
+  PriceSelectionContext, 
+  PriceSelectionResult,
+} from "@medusajs/medusa"
+
+import { EntityManager } from "typeorm"
+
+export default class MyStrategy extends 
+  AbstractPriceSelectionStrategy {
+    withTransaction(
+      manager: EntityManager
+    ): IPriceSelectionStrategy {
+      if (!manager) {
+        return this
+      }
+
+      return new MyStrategy()
+    }
+
+    async calculateVariantPrice(
+      variant_id: string,
+      context: PriceSelectionContext
+    ): Promise<PriceSelectionResult> {
+      // TODO
+    }
+}
+```
+
+You can use services or repositories in the strategy by adding them to the constructor and updating the parameters passed to the `MyStrategy` constructor in `withTransaction`. For example:
+
+```ts
+import { 
+  AbstractPriceSelectionStrategy, 
+  CustomerService, 
+  IPriceSelectionStrategy, 
+  PriceSelectionContext, 
+  PriceSelectionResult, 
+} from "@medusajs/medusa"
+
+export default class MyStrategy extends 
+  AbstractPriceSelectionStrategy {
+    private customerService: CustomerService
+
+    constructor({
+      customerService,
+    }) {
+      super()
+      this.customerService = customerService
+    }
+
+    withTransaction(
+      manager: EntityManager
+    ): IPriceSelectionStrategy {
+      if (!manager) {
+        return this
+      }
+
+      return new MyStrategy({
+        customerService: this.customerService,
+      })
+    }
+    // ...
+}
+```
+
+---
+
+## 2. Implement calculateVariantPrice
+
+Implement the price selection strategy you want inside the `calculateVariantPrice` method.
+
+This method accepts the variant ID as a first parameter and the [context](../price-selection-strategy.md#context-object) object as a second parameter.
+
+This method must return an object having the following fields:
+
+```ts noReport
+{
+  originalPrice, // number | null
+  calculatedPrice, // number | null
+  prices // MoneyAmount[]
+}
+```
+
+You can learn more about optional properties and the meaning behind every property [here](../price-selection-strategy.md#calculatevariantprice-method).
+
+---
+
+## 3. Run Build Command
+
+In your terminal, run the build command to transpile the files in the `src` directory into the `dist` directory:
+
+```bash npm2yarn
+npm run build
+```
+
+---
+
+## Test it Out
+
+Run your backend to test it out:
+
+```bash npm2yarn
+npm run start
+```
+
+Then, try out your strategy using any of the [Products](/api/store/#tag/Product) or [Carts](/api/store/#tag/Cart) endpoints which include retrieving product variants and line items respectively. You should then see the prices in the response based on your implemented strategy.