Files
medusa-store/www/docs/sidebars.js
Shahed Nasser c19788d872 docs for tax-inclusive pricing (#2159)
* docs for tax-inclusive pricing

* changes based on feedback

* changes based on feedback

* fix link

* fix: make prices optional param when updating a variant (#2155)

**Why**
- It should be possible to update variant props without having to send the prices array with every update

* feat(medusa): Tax-inclusive pricing (#2131)

* add feature flag for tax inclusive pricing

* update db model for TIP

* add migration

* set featureflag column decorators

* remove unused prop

* update tests to reflect feature_flags as any array

* fix types

* reference key from featureFlag file

* use feature flag key in models

* fix copy paste mistake

* unify spelling

* Create gorgeous-experts-guess.md

* feat(medusa): create/update endpoints of currency/region/price-lists/shipping-options should allow to pass includes_tax

* test(integration): continue to add some integration test

* test(integration): continue to add some integration test

* test(unit): Fix region service tests

* fix(medusa): API unit tests flags management

* feat(medusa): Minor cleanup

* style(medusa): Fix typo

* fix(medusa): rebase

* feat(medusa): Replace old tag with the new one

* feat(medusa): revert flag

* feat(medusa): Cleanup

* feat(medusa): feedback

* feat(medusa): Rename currency retrieve method

* test(medudsa): fix unit tests

* chore(medusa): fix oas

* feat(medusa): ShippingMethod should include tax setting from parent option (#2021)

* feat(medusa): Shipping method should includes tax from parent options

* feat(medusa): Condition the includes tax flag to the availability of the feature and add some other tests

* test(integration): Move cart/order ff test in separate files

* fix: snapshots folder

* fix(integration): snapshots

* Create calm-baboons-sit.md

* test(integration): file naming

Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com>

* Feat/tax inclusive pricing extend price selection strategy (#2087)

* initial changes to price selection strategy including unit tests

* typing for tax calculation

* update types and remove region and currency from prices results

* fix casing

* include tax calculation in priceselectionstrategy

* integration tests for tax inclusive pricing price calculations

* fix build

* include tax inclusive considerations when calculating tax fields for variants

* include only "includes_tax" fields from currency and region joins

* test to see errors in pipelines

* conditionally join featureflagged fields

* add "includes_tax" to price list factory

* add tests for tax inclusive price list prices and currency prices

* fix unit tests

* refactor pricing array checks to expect arraycontaining

* undo error handler

* Feat/tax inclusive pricing flag on generated lineitems (#2108)

* include tax inclusive pricing flag on generated lineitems

* initial addition of tax inclusivity for lineitem service

* add generate test to ensure that includes_tax is set when returned from price selection strategy

* add integration test for generating lineitem including tax

* add test for negative tax inclusion

* add tests for mixed pricing

* add negative test for setting tax exclusivity

* restructure the setting of includes_tax on lineitems

* fix: update cwd to be correct in cart test

* feat(medusa): Line item totals calculations (#2123)

* feat(medusa): Update totals and tax calculation way to calculate the totals

* feat(medusa): remove region feetching from decorate total

* feat(medusa): cleanup

* test(medusa): fix tax calculation tests

* comment

* test(integration): cleanup

* test(integration): cleanup

* fix(medusa): return service missing await

* feat(medusa): cleanup

* feat(medusa): cleanup

* test(integration): fix data

* feat(medusa): improve tax calculation readability

* test(medusa): improve tax calculation structure case

Co-authored-by: Sebastian Rindom <skrindom@gmail.com>

* Feat(medusa): tax inclusive pricing in shipping method tax (#2125)

* initial implementation and test

* include tax inclusive calculations for getting shipping options

* remove inaccurate comment

* remove console log

* refactor how prices and taxes are set for shipping methods

* fix integration tests

* remove verbose flag

* fix integration tests

* remove console log

* format util

* use util in price service and tax strategy

* fix faulty integration test

* undo tax calculation strategy changes in favor or Carlos' pr

* undo changes to tax calculation strategy tests

* round tax amount

* feat(medusa): cleanup calculate tax amount utils and its usage (#2136)

* feat(medusa): Refund line totals calculation (#2139)

Rely on the update of the following pr https://github.com/medusajs/medusa/pull/2136

**WIP Missing integration tests**

**What**

Update the totals calculation on the refund line to include the notion of tax inclusive

**Test**

- Update and add new tests around the refund


Fixes CORE-482

* feat(medusa): Tax inclusive discounts calculations (#2137)

**What**

- Calculate line adjustments correctly taking into account the tax inclusivity
- fix totals getLineItemTotals by adjusting the sub total with the original tax amount instead of the tax amount when the unit price includes the taxes

**Tests**
- The tests create a cart with a percentage discount of 15%, the cart includes 2 items mixing the tax inclusive and validate the items on the result cart as well as the totals on each item. I ve based my calculation validation based on what we have done + some articles around discount apply on price without taxes to validate the output.,
FIXES CORE-477

* Chore: shipping methods tax inclusive total (#2130)

* chore: calculate tax inclusive shipping methods

* chore: additional tests and check undefined tax_rate (#2157)

* chore: additional tests and check undefined tax_rate

* fix: naming + correct price type check

* fix: remove price_includes_tax from type

* fix: remove price_includes_tax from type

Co-authored-by: Philip Korsholm <philip.korsholm@hotmail.com>
Co-authored-by: adrien2p <adrien.deperetti@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com>
Co-authored-by: Philip Korsholm <88927411+pKorsholm@users.noreply.github.com>
Co-authored-by: Sebastian Rindom <skrindom@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>

* Remove unused QueryBuilderService (#2104)

**Issue number:** #2068

**What:**
- removed unused query-builder service files
  - medusa/src/services/query-builder.js
  - medusa/src/services/__mocks__/query-builder.js
- deleted export from medusa/src/services/index.ts
- (extra) deleted documentation files related to QueryBuilderService (QueryBuilderService.md)

* docs for tax-inclusive pricing

* changes based on feedback

* changes based on feedback

* feat(medusa-fulfillment-webshipper): Support personal customs no in orders (#2167)

* feat(webshipper): support personal customs no in orders

* docs: update readme with personal customs number info

* fix(medusa-file-spaces): return `fileKey` for Spaces upload (#2171)

**What**
- return `fileKey` in the response after the file is uploaded to Spaces

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* fix(medusa): Export/import fixes including export fields that contains new line char (#2150)

* feat(medusa-js,medusa-react,medusa): Add missing Currency endpoints (#2185)

* fix(medusa): Resent notification replaces parent notification

* chore: Bump medusa-file-minio

* fix(medusa): allow address updates on carts w/o existing address (#2176)

* chore: Bump minor version of plugins

* chore: Centralise ESLint rules (#2162)

* chore: centrilize eslint rules

* feat: order editing data model (#2184)

**What**
- add order editing entities
- add repositories
- add a feature flag for the order editing feature
- add the migrations file

RESOLVES CORE-490

* fix link

* fix(medusa): Check for Sales Channel on product import (#2202)

* docs: change title in Create a Service documentation (#2201)

Change title in Create a Service documentation

* chore(release): Publish

* added links to sidebar

Co-authored-by: Sebastian Rindom <skrindom@gmail.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Philip Korsholm <philip.korsholm@hotmail.com>
Co-authored-by: adrien2p <adrien.deperetti@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com>
Co-authored-by: Philip Korsholm <88927411+pKorsholm@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
Co-authored-by: Dorian <46839236+DorianMazur@users.noreply.github.com>
Co-authored-by: Frane Polić <16856471+fPolic@users.noreply.github.com>
Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
Co-authored-by: Bhargava Prabu Reddy <prabu0reddy777@gmail.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
Co-authored-by: sabakhilji <52318459+sabakhilji@users.noreply.github.com>
2022-09-20 10:34:53 +03:00

812 lines
21 KiB
JavaScript

/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
module.exports = {
docsSidebar: [
{
type: "category",
label: "Getting Started",
items: [
{
type: "doc",
id: "homepage",
label: "Overview",
},
{
type: "doc",
id: "introduction",
label: "Introduction",
},
{
type: "doc",
id: "quickstart/quick-start",
label: "Quickstart Guide",
},
{
type: "doc",
id: "usage",
},
]
},
{
type: "category",
label: "Setup & Deployment",
items: [
{
type: "doc",
id: "tutorial/set-up-your-development-environment",
label: "Set Up Dev Environment"
},
{
type: "doc",
id: "usage/configurations",
label: "Configure Server"
},
{
type: "category",
label: "Storefronts",
items: [
{
type: "doc",
id: "starters/gatsby-medusa-starter",
label: "Gatsby Storefront Quickstart",
},
{
type: "doc",
id: "starters/nextjs-medusa-starter",
label: "Next.js Storefront Quickstart",
},
],
},
{
type: "doc",
id: "admin/quickstart",
},
{
type: "doc",
id: "usage/create-medusa-app",
},
{
type: "category",
label: "Deployment",
items: [
{
type: "category",
label: "Server",
link: {
type: "doc",
id: "deployments/server/index"
},
items: [
{
type: "doc",
id: "deployments/server/deploying-on-heroku",
label: "Deploy on Heroku",
customProps: {
image: 'https://i.imgur.com/xNvxSkf.png'
}
},
{
type: "doc",
id: "deployments/server/deploying-on-digital-ocean",
label: "Deploy on DigitalOcean",
customProps: {
image: 'https://i.imgur.com/aahqJp4.png'
}
},
{
type: "doc",
id: "deployments/server/deploying-on-qovery",
label: "Deploy on Qovery",
customProps: {
image: 'https://i.imgur.com/qOvY2dN.png'
}
}
]
},
{
type: "category",
label: "Admin",
link: {
type: "doc",
id: "deployments/admin/index"
},
items: [
{
type: "doc",
id: "deployments/admin/deploying-on-netlify",
label: "Deploy on Netlify",
customProps: {
image: 'https://i.imgur.com/gCbsCvX.png'
}
},
]
},
{
type: "category",
label: "Storefront",
link: {
type: "doc",
id: "deployments/storefront/index"
},
items: [
{
type: "doc",
id: "deployments/storefront/deploying-gatsby-on-netlify",
label: "Deploy Gatsby on Netlify",
customProps: {
image: 'https://i.imgur.com/gCbsCvX.png'
}
},
]
},
],
},
{
type: "category",
label: 'Upgrade Guides',
collapsed: true,
link: {
type: 'doc',
id: 'advanced/backend/upgrade-guides/index'
},
items: [
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-0",
label: "v1.3.0"
},
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-6",
label: "v1.3.6"
},
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-8",
label: "v1.3.8"
},
]
},
]
},
{
type: "category",
label: "How-to Guides",
items: [
{
type: "doc",
id: "advanced/backend/endpoints/add-storefront",
label: "Create Endpoint for Storefront"
},
{
type: "doc",
id: "advanced/backend/endpoints/add-admin",
label: "Create Endpoint for Admin"
},
{
type: "doc",
id: "advanced/backend/services/create-service",
label: "Create a Service"
},
{
type: "doc",
id: "advanced/backend/subscribers/create-subscriber",
label: "Create a Subscriber"
},
{
type: "doc",
id: "advanced/backend/entities/index",
label: "Create an Entity"
},
{
type: "doc",
id: "advanced/backend/shipping/add-fulfillment-provider",
label: "Create a Fulfillment Provider"
},
{
type: "doc",
id: "advanced/backend/payment/how-to-create-payment-provider",
label: "Create a Payment Provider"
},
{
type: "doc",
id: "advanced/backend/notification/how-to-create-notification-provider",
label: "Create a Notification Provider"
},
{
type: "doc",
id: "advanced/backend/plugins/create",
label: "Create a Plugin"
},
{
type: "doc",
id: "advanced/backend/migrations/index",
label: "Create a Migration"
},
{
type: "doc",
id: "advanced/backend/cron-jobs/create",
label: "Create a Cron Job"
},
{
type: "category",
label: "Storefront",
items: [
{
type: "doc",
id: "guides/carts-in-medusa",
label: "Implement Cart"
},
{
type: "doc",
id: "advanced/storefront/how-to-implement-checkout-flow",
label: "Implement Checkout"
},
]
},
{
type: "category",
label: "Admin",
items: [
{
type: "doc",
id: "advanced/admin/import-products",
label: "Import Products"
},
{
type: "doc",
id: "advanced/backend/taxes/manual-calculation",
label: "Calculate Taxes Manually"
},
]
},
]
},
{
type: "category",
label: "Conceptual Guides",
items: [
{
type: "doc",
id: "advanced/backend/entities/overview",
label: "Entities"
},
{
type: "doc",
id: "advanced/backend/services/overview",
label: "Services"
},
{
type: "doc",
id: "advanced/backend/subscribers/overview",
label: "Subscribers"
},
{
type: "doc",
id: "advanced/backend/shipping/overview",
label: "Shipping Architecture"
},
{
type: "doc",
id: "advanced/backend/payment/overview",
label: "Payment Architecture"
},
{
type: "doc",
id: "advanced/backend/notification/overview",
label: "Notification Architecture"
},
{
type: "doc",
id: "advanced/backend/plugins/overview",
label: "Plugins"
},
{
type: "doc",
id: "advanced/backend/migrations/overview",
label: "Migrations"
},
{
type: "doc",
id: "advanced/backend/batch-jobs/index",
label: "Batch Jobs"
},
{
type: "doc",
id: "advanced/backend/taxes/inclusive-pricing",
label: "Tax Inclusive Pricing"
},
]
},
{
type: "category",
label: "Integrations",
items: [
{
type: "category",
label: "Analytics",
items: [
{
type: "doc",
id: "add-plugins/segment",
label: "Segment",
},
],
},
{
type: "category",
label: "CMS",
items: [
{
type: "category",
label: "Contentful",
link: {
type: "doc",
id: "add-plugins/contentful/index",
},
items: [
{
type: "doc",
id: "add-plugins/contentful/customize-contentful",
label: "Customize Integration",
},
]
},
{
type: "doc",
id: "add-plugins/strapi",
label: "Strapi",
},
],
},
{
type: "category",
label: "Notifications",
items: [
{
type: "doc",
id: "add-plugins/sendgrid",
label: "SendGrid",
},
{
type: "doc",
id: "add-plugins/mailchimp",
label: "Mailchimp",
},
{
type: "doc",
id: "add-plugins/twilio-sms",
label: "Twilio SMS",
},
{
type: "doc",
id: "add-plugins/slack",
label: "Slack",
},
],
},
{
type: "category",
label: "Payment",
items: [
{
type: "doc",
id: "add-plugins/klarna",
label: "Klarna",
},
{
type: "doc",
id: "add-plugins/paypal",
label: "PayPal",
},
{
type: "doc",
id: "add-plugins/stripe",
label: "Stripe",
},
],
},
{
type: "category",
label: "Search",
items: [
{
type: "doc",
id: "add-plugins/algolia",
label: "Algolia",
},
{
type: "doc",
id: "add-plugins/meilisearch",
label: "MeiliSearch",
},
],
},
{
type: "category",
label: "Storage",
items: [
{
type: "doc",
id: "add-plugins/minio",
label: "MinIO",
},
{
type: "doc",
id: "add-plugins/s3",
label: "S3",
},
{
type: "doc",
id: "add-plugins/spaces",
label: "Spaces",
},
],
},
],
},
{
type: "category",
label: "Troubleshooting",
items: [
{
type: "doc",
id: "troubleshooting/cors-issues",
label: "CORS issues",
},
{
type: "doc",
id: "troubleshooting/transaction-error-in-checkout",
label: "Error 409 in checkout",
},
{
type: "doc",
id: "troubleshooting/missing-payment-providers",
label: "Payment provider missing",
},
{
type: "doc",
id: "troubleshooting/redis-events",
label: "Redis not emitting events",
},
{
type: "doc",
id: "troubleshooting/signing-in-to-admin",
label: "Signing in to Medusa Admin",
},
{
type: "doc",
id: "troubleshooting/s3-acl-error",
label: "S3 Plugin ACL Error",
},
{
type: "doc",
id: "troubleshooting/documentation-error",
label: "Documentation Error",
},
],
},
{
type: "category",
label: "References",
items: [
{
type: "doc",
id: "cli/reference",
label: "CLI Reference",
},
{
type: "ref",
id: "references/entities/classes/Address",
label: "Entities Reference",
},
{
type: "doc",
id: "advanced/backend/subscribers/events-list",
label: "Events Reference"
},
{
type: "ref",
id: "js-client/overview",
label: "JS Client Reference",
},
{
type: "ref",
id: "references/services/classes/AuthService",
label: "Services Reference",
},
]
},
{
type: "doc",
id: "contribution-guidelines",
label: "Contribution Guidelines",
},
],
userGuideSidebar: [
{
type: 'autogenerated',
dirName: 'user-guide', // '.' means the current docs folder
}
],
servicesSidebar: [
{
type: 'autogenerated',
dirName: 'references/services/classes', // generate sidebar from the docs folder (or versioned_docs/<version>)
},
],
jsClientSidebar: [
{
type: "doc",
id: "js-client/overview",
label: "Overview",
},
{
type: "category",
collapsed: false,
label: "Resources",
items: [
{
type: "category",
label: "admin",
collapsed: true,
link: {
type: "doc",
id: "references/js-client/classes/Admin",
},
items: [
{
type: "doc",
id: "references/js-client/classes/AdminAuthResource",
label: "auth",
},
{
type: "doc",
id: "references/js-client/classes/AdminCollectionsResource",
label: "collections",
},
{
type: "doc",
id: "references/js-client/classes/AdminCustomerGroupsResource",
label: "customerGroups",
},
{
type: "doc",
id: "references/js-client/classes/AdminCustomersResource",
label: "customers",
},
{
type: "doc",
id: "references/js-client/classes/AdminDiscountsResource",
label: "discounts",
},
{
type: "doc",
id: "references/js-client/classes/AdminDraftOrdersResource",
label: "draftOrders",
},
{
type: "doc",
id: "references/js-client/classes/AdminGiftCardsResource",
label: "giftCards",
},
{
type: "doc",
id: "references/js-client/classes/AdminInvitesResource",
label: "invites",
},
{
type: "doc",
id: "references/js-client/classes/AdminNotesResource",
label: "notes",
},
{
type: "doc",
id: "references/js-client/classes/AdminNotificationsResource",
label: "notifications",
},
{
type: "doc",
id: "references/js-client/classes/AdminOrdersResource",
label: "orders",
},
{
type: "doc",
id: "references/js-client/classes/AdminPriceListResource",
label: "priceLists",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductsResource",
label: "products",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductTagsResource",
label: "productTags",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductTypesResource",
label: "productTypes",
},
{
type: "doc",
id: "references/js-client/classes/AdminRegionsResource",
label: "regions",
},
{
type: "doc",
id: "references/js-client/classes/AdminReturnReasonsResource",
label: "returnReasons",
},
{
type: "doc",
id: "references/js-client/classes/AdminReturnsResource",
label: "returns",
},
{
type: "doc",
id: "references/js-client/classes/AdminShippingOptionsResource",
label: "shippingOptions",
},
{
type: "doc",
id: "references/js-client/classes/AdminShippingProfilesResource",
label: "shippingProfiles",
},
{
type: "doc",
id: "references/js-client/classes/AdminStoresResource",
label: "store",
},
{
type: "doc",
id: "references/js-client/classes/AdminSwapsResource",
label: "swaps",
},
{
type: "doc",
id: "references/js-client/classes/AdminTaxRatesResource",
label: "taxRates",
},
{
type: "doc",
id: "references/js-client/classes/AdminUploadsResource",
label: "uploads",
},
{
type: "doc",
id: "references/js-client/classes/AdminUsersResource",
label: "users",
},
{
type: "doc",
id: "references/js-client/classes/AdminVariantsResource",
label: "variants",
},
]
},
{
type: "doc",
id: "references/js-client/classes/AuthResource",
label: "auth",
},
{
type: "category",
label: "carts",
link: {
type: "doc",
id: "references/js-client/classes/CartsResource",
},
collapsed: true,
items: [
{
type: "doc",
id: "references/js-client/classes/LineItemsResource",
label: "lineItems",
}
]
},
{
type: "doc",
id: "references/js-client/classes/CollectionsResource",
label: "collections",
},
{
type: "category",
label: "customers",
collapsed: true,
link: {
type: "doc",
id: "references/js-client/classes/CustomerResource",
},
items: [
{
type: "doc",
id: "references/js-client/classes/AddressesResource",
label: "addresses"
},
{
type: "doc",
id: "references/js-client/classes/PaymentMethodsResource",
label: "paymentMethods"
}
]
},
{
type: "doc",
id: "references/js-client/classes/GiftCardsResource",
label: "giftCards",
},
{
type: "doc",
id: "references/js-client/classes/OrdersResource",
label: "orders",
},
{
type: "doc",
id: "references/js-client/classes/PaymentMethodsResource",
label: "paymentMethods",
},
{
type: "category",
label: "products",
link: {
type: "doc",
id: "references/js-client/classes/ProductsResource",
},
collapsed: true,
items: [
{
type: "doc",
id: "references/js-client/classes/ProductVariantsResource",
label: "variants",
}
]
},
{
type: "doc",
id: "references/js-client/classes/RegionsResource",
label: "regions",
},
{
type: "doc",
id: "references/js-client/classes/ReturnReasonsResource",
label: "returnReason",
},
{
type: "doc",
id: "references/js-client/classes/ReturnsResource",
label: "returns",
},
{
type: "doc",
id: "references/js-client/classes/ShippingOptionsResource",
label: "shippingOptions",
},
{
type: "doc",
id: "references/js-client/classes/SwapsResource",
label: "swaps",
},
]
}
],
entitiesSidebar: [
{
type: 'autogenerated',
dirName: 'references/entities/classes', // generate sidebar from the docs folder (or versioned_docs/<version>)
},
],
}