asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
7a9740bad70893f5fb33e426c334e50d43b60a4e
medusa-store/docs/content/references/services/classes/ProductVariantService.md
Shahed Nasser 6f1b49af03 chore: merge docs from master to develop (#3650) 
* Fix issue on fixed total amount discount when using includes tax (#3472)

The calculation of the fixed discount amount breaks when having includes_tax setting active, due to the line item totals are incorrect and returning everything as 0, thus the totalItemPercentage will be Infinitiy due to the division by a subtotal of 0

* chore: Add missing changeset for @medusajs/medusa

* feat(medusa): Improve performance of Products domain (#3417)

* feat(medusa): Improve product update performances

* fix tests and update

* update mock repo

* improve repo

* cleanup

* fix

* cleanup + bulk emit + unit test fix

* improvements

* improve

* fix unit tests

* fix export

* fix product update handler

* enhance mock repo

* fix import integration

* fix end point tests

* revert mock repo product variant

* fix unit

* cleanup

* cleanup

* address feedback

* fix quotes in tests

* address feedback

* Create new-tips-mate.md

* use types

* chore: Remove integration-tests from changeset

* chore(release): v1.7.14

* chore(docs): Generated Docs Announcement Bar (automated) (#3489)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* fix(medusa): EventBusService.emit using Redis mock (#3491)

* Fix eventBusService.emit using redis mock

* revert gitignore

* enqueuer

* unit test add redis_url

* fix test

* chore(docs): Generated Services Reference (automated) (#3490)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* 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

* docs: fixed discount details (#3499)

* docs: fix trailing slash causing 404 (#3508)

* docs: fix error during navigation (#3509)

* docs: removed the gatsby storefront guide (#3527)

* docs: removed the gatsby storefront guide

* docs: fixed query value

* chore(docs): Removed Docs Announcement Bar (automated) (#3536)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity (#3539)

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity

* fix unit tests

* Create brave-seahorses-film.md

* docs: fix admin redirects (#3548)

* chore(release): v1.7.15

* chore(docs): Generated Docs Announcement Bar (automated) (#3550)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* chore(docs): Generated Services Reference (automated) (#3551)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

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

* chore: updated READMEs of plugins (#3546)

* chore: updated READMEs of plugins

* added notice to plugins

* docs: added a deploy guide for next.js storefront (#3558)

* docs: added a deploy next.js guide

* docs: fix image zoom

* docs: fixes to next.js deployment guide to vercel (#3562)

* chore(workflows): Enable manual workflow in pre-release mode (#3566)

* chore(docs): Removed Docs Announcement Bar (automated) (#3598)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Rounding issues on line item adjustments (#3446)

* chores(medusa): Attempt to fix discount rounding issues

* add migration

* update entities

* apply multipler factor properly

* fix discount service

* WIP

* fix rounding issues in discounts

* fix some tests

* Exclude raw_discount_total from responses

* fix adjustments

* cleanup response

* fix

* fix draft order integration

* fix order integration

* fix order integration

* address feedback

* fix test

* Create .changeset/polite-llamas-sit.md

* remove comment

---------

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

* chore(workflows): Add release notification (#3629)

---------

Co-authored-by: pepijn-vanvlaanderen <pepijn@webbers.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
Co-authored-by: Adrien de Peretti <adrien.deperetti@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-03-31 09:34:38 +02:00

22 KiB
Raw Blame History

Class: ProductVariantService

Hierarchy

  • TransactionBaseService

    ↳ ProductVariantService

Constructors

constructor

• new ProductVariantService(__namedParameters)

Parameters

Name Type
__namedParameters Object

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/product-variant.ts:72

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11

cartRepository_

• Protected Readonly cartRepository_: typeof CartRepository

Defined in

packages/medusa/src/services/product-variant.ts:70

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/product-variant.ts:64

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/product-variant.ts:59

moneyAmountRepository_

• Protected Readonly moneyAmountRepository_: typeof MoneyAmountRepository

Defined in

packages/medusa/src/services/product-variant.ts:67

priceSelectionStrategy_

• Protected Readonly priceSelectionStrategy_: IPriceSelectionStrategy

Defined in

packages/medusa/src/services/product-variant.ts:66

productOptionValueRepository_

• Protected Readonly productOptionValueRepository_: typeof ProductOptionValueRepository

Defined in

packages/medusa/src/services/product-variant.ts:69

productRepository_

• Protected Readonly productRepository_: typeof ProductRepository

Defined in

packages/medusa/src/services/product-variant.ts:63

productVariantRepository_

• Protected Readonly productVariantRepository_: typeof ProductVariantRepository

Defined in

packages/medusa/src/services/product-variant.ts:62

regionService_

• Protected Readonly regionService_: RegionService

Defined in

packages/medusa/src/services/product-variant.ts:65

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/product-variant.ts:60

Events

▪ Static Events: Object

Type declaration

Name Type
CREATED string
DELETED string
UPDATED string

Defined in

packages/medusa/src/services/product-variant.ts:53

Methods

addOptionValue

▸ addOptionValue(variantId, optionId, optionValue): Promise<ProductOptionValue>

Adds option value to a variant. Fails when product with variant does not exist or if that product does not have an option with the given option id. Fails if given variant is not found. Option value must be of type string or number.

Parameters

Name Type Description
variantId string the variant to decorate.
optionId string the option from product.
optionValue string option value to add.

Returns

Promise<ProductOptionValue>

the result of the update operation.

Defined in

packages/medusa/src/services/product-variant.ts:823

addOrUpdateCurrencyPrices

▸ addOrUpdateCurrencyPrices(data): Promise<void>

Parameters

Name Type
data { price: WithRequiredProperty<ProductVariantPrice, "currency_code"> ; variantId: string }[]

Returns

Promise<void>

Defined in

packages/medusa/src/services/product-variant.ts:613

addOrUpdateRegionPrices

▸ addOrUpdateRegionPrices(data): Promise<void>

Parameters

Name Type
data UpdateVariantRegionPriceData[]

Returns

Promise<void>

Defined in

packages/medusa/src/services/product-variant.ts:542

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult> the transactional work to be done
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult> the isolation level to be used for the work.
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult> Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50

create

▸ create(productOrProductId, variant): Promise<ProductVariant>

Creates an unpublished product variant. Will validate against parent product to ensure that the variant can in fact be created.

Parameters

Name Type Description
productOrProductId string | Product the product the variant will be added to
variant CreateProductVariantInput the variant to create

Returns

Promise<ProductVariant>

resolves to the creation result.

Defined in

packages/medusa/src/services/product-variant.ts:167

delete

▸ delete(variantIds): Promise<void>

Deletes variant or variants. Will never fail due to delete being idempotent.

Parameters

Name Type Description
variantIds string | string[] the id of the variant to delete. Must be castable as an ObjectId

Returns

Promise<void>

empty promise

Defined in

packages/medusa/src/services/product-variant.ts:976

deleteOptionValue

▸ deleteOptionValue(variantId, optionId): Promise<void>

Deletes option value from given variant. Will never fail due to delete being idempotent.

Parameters

Name Type Description
variantId string the variant to decorate.
optionId string the option from product.

Returns

Promise<void>

empty promise

Defined in

packages/medusa/src/services/product-variant.ts:850

getFreeTextQueryBuilder_

▸ getFreeTextQueryBuilder_(variantRepo, query, q?): SelectQueryBuilder<ProductVariant>

Lists variants based on the provided parameters and includes the count of variants that match the query.

Parameters

Name Type Description
variantRepo ProductVariantRepository the variant repository
query FindWithRelationsOptions object that defines the scope for what should be returned
q? string free text query

Returns

SelectQueryBuilder<ProductVariant>

an array containing the products as the first element and the total count of products that matches the query as the second element.

Defined in

packages/medusa/src/services/product-variant.ts:1078

getRegionPrice

▸ getRegionPrice(variantId, context): Promise<null | number>

Gets the price specific to a region. If no region specific money amount exists the function will try to use a currency price. If no default currency price exists the function will throw an error.

Parameters

Name Type Description
variantId string the id of the variant to get price from
context GetRegionPriceContext context for getting region price

Returns

Promise<null | number>

the price specific to the region

Defined in

packages/medusa/src/services/product-variant.ts:697

isVariantInSalesChannels

▸ isVariantInSalesChannels(id, salesChannelIds): Promise<boolean>

Check if the variant is assigned to at least one of the provided sales channels.

Parameters

Name Type Description
id string product variant id
salesChannelIds string[] an array of sales channel ids

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/product-variant.ts:1016

list

▸ list(selector, config?): Promise<ProductVariant[]>

Parameters

Name Type Description
selector FilterableProductVariantProps the query object for find
config FindConfig<ProductVariant> & PriceSelectionContext query config object for variant retrieval

Returns

Promise<ProductVariant[]>

the result of the find operation

Defined in

packages/medusa/src/services/product-variant.ts:918

listAndCount

▸ listAndCount(selector, config?): Promise<[ProductVariant[], number]>

Parameters

Name Type Description
selector FilterableProductVariantProps the query object for find
config FindConfig<ProductVariant> & PriceSelectionContext query config object for variant retrieval

Returns

Promise<[ProductVariant[], number]>

the result of the find operation

Defined in

packages/medusa/src/services/product-variant.ts:877

prepareListQuery_

▸ prepareListQuery_(selector, config): Object

Creates a query object to be used for list queries.

Parameters

Name Type Description
selector FilterableProductVariantProps the selector to create the query from
config FindConfig<ProductVariant> the config to use for the query

Returns

Object

an object containing the query, relations and free-text search param.

Name Type
q? string
query FindWithRelationsOptions
relations string[]

Defined in

packages/medusa/src/services/product-variant.ts:1039

retrieve

▸ retrieve(variantId, config?): Promise<ProductVariant>

Gets a product variant by id.

Parameters

Name Type Description
variantId string the id of the product to get.
config FindConfig<ProductVariant> & PriceSelectionContext query config object for variant retrieval.

Returns

Promise<ProductVariant>

the product document.

Defined in

packages/medusa/src/services/product-variant.ts:103

retrieveBySKU

▸ retrieveBySKU(sku, config?): Promise<ProductVariant>

Gets a product variant by id.

Parameters

Name Type Description
sku string The unique stock keeping unit used to identify the product variant.
config FindConfig<ProductVariant> & PriceSelectionContext query config object for variant retrieval.

Returns

Promise<ProductVariant>

the product document.

Defined in

packages/medusa/src/services/product-variant.ts:131

setCurrencyPrice

▸ setCurrencyPrice(variantId, price): Promise<MoneyAmount>

Deprecated

use addOrUpdateCurrencyPrices instead Sets the default price for the given currency.

Parameters

Name Type Description
variantId string the id of the variant to set prices for
price ProductVariantPrice the price for the variant

Returns

Promise<MoneyAmount>

the result of the update operation

Defined in

packages/medusa/src/services/product-variant.ts:764

setRegionPrice

▸ setRegionPrice(variantId, price): Promise<MoneyAmount>

Deprecated

use addOrUpdateRegionPrices instead Sets the default price of a specific region

Parameters

Name Type Description
variantId string the id of the variant to update
price ProductVariantPrice the price for the variant.

Returns

Promise<MoneyAmount>

the result of the update operation

Defined in

packages/medusa/src/services/product-variant.ts:727

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

update

▸ update(variantData): Promise<ProductVariant[]>

Updates a collection of variant.

Parameters

Name Type Description
variantData { updateData: UpdateProductVariantInput ; variant: ProductVariant }[] a collection of variant and the data to update.

Returns

Promise<ProductVariant[]>

resolves to the update result.

Defined in

packages/medusa/src/services/product-variant.ts:264

▸ update(variantOrVariantId, update): Promise<ProductVariant>

Updates a variant. Price updates should use dedicated methods. The function will throw, if price updates are attempted.

Parameters

Name Type Description
variantOrVariantId string | Partial<ProductVariant> variant or id of a variant.
update UpdateProductVariantInput an object with the update values.

Returns

Promise<ProductVariant>

resolves to the update result.

Defined in

packages/medusa/src/services/product-variant.ts:279

▸ update(variantOrVariantId, update): Promise<ProductVariant>

Parameters

Name Type
variantOrVariantId string | Partial<ProductVariant>
update UpdateProductVariantInput

Returns

Promise<ProductVariant>

Defined in

packages/medusa/src/services/product-variant.ts:284

updateBatch

▸ Protected updateBatch(variantData): Promise<ProductVariant[]>

Parameters

Name Type
variantData UpdateProductVariantData[]

Returns

Promise<ProductVariant[]>

Defined in

packages/medusa/src/services/product-variant.ts:340

updateOptionValue

▸ updateOptionValue(variantId, optionId, optionValue): Promise<ProductOptionValue>

Updates variant's option value. Option value must be of type string or number.

Parameters

Name Type Description
variantId string the variant to decorate.
optionId string the option from product.
optionValue string option value to add.

Returns

Promise<ProductOptionValue>

the result of the update operation.

Defined in

packages/medusa/src/services/product-variant.ts:785

updateVariantPrices

▸ updateVariantPrices(data): Promise<void>

Updates variant/prices collection. Deletes any prices that are not in the update object, and is not associated with a price list.

Parameters

Name Type
data UpdateVariantPricesData[]

Returns

Promise<void>

empty promise

Defined in

packages/medusa/src/services/product-variant.ts:440

▸ updateVariantPrices(variantId, prices): Promise<void>

Updates a variant's prices. Deletes any prices that are not in the update object, and is not associated with a price list.

Parameters

Name Type Description
variantId string the id of variant
prices ProductVariantPrice[] the update prices

Returns

Promise<void>

empty promise

Defined in

packages/medusa/src/services/product-variant.ts:449

updateVariantPricesBatch

▸ Protected updateVariantPricesBatch(data): Promise<void>

Parameters

Name Type
data UpdateVariantPricesData[]

Returns

Promise<void>

Defined in

packages/medusa/src/services/product-variant.ts:469

withTransaction

▸ withTransaction(transactionManager?): ProductVariantService

Parameters

Name Type
transactionManager? EntityManager

Returns

ProductVariantService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14

Reference in New Issue View Git Blame Copy Permalink