914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
15 KiB
Class: LineItemService
Hierarchy
-
TransactionBaseService↳
LineItemService
Constructors
constructor
• new LineItemService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/line-item.ts:56
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
cartRepository_
• Protected Readonly cartRepository_: Repository<Cart> & { findOneWithRelations: (relations: FindOptionsRelations<Cart>, optionsWithoutRelations: Omit<FindManyOptions<Cart>, "relations">) => Promise<Cart> ; findWithRelations: (relations: FindOptionsRelations<Cart>, optionsWithoutRelations: Omit<FindManyOptions<Cart>, "relations">) => Promise<Cart[]> }
Defined in
medusa/src/services/line-item.ts:47
featureFlagRouter_
• Protected Readonly featureFlagRouter_: FlagRouter
Defined in
medusa/src/services/line-item.ts:52
itemTaxLineRepo_
• Protected Readonly itemTaxLineRepo_: Repository<LineItemTaxLine> & { deleteForCart: (cartId: string) => Promise<void> ; upsertLines: (lines: LineItemTaxLine[]) => Promise<LineItemTaxLine[]> }
Defined in
medusa/src/services/line-item.ts:46
lineItemAdjustmentService_
• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService
Defined in
medusa/src/services/line-item.ts:53
lineItemRepository_
• Protected Readonly lineItemRepository_: Repository<LineItem> & { findByReturn: (returnId: string) => Promise<LineItem & { return_item: ReturnItem }[]> }
Defined in
medusa/src/services/line-item.ts:45
manager_
• Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
pricingService_
• Protected Readonly pricingService_: PricingService
Defined in
medusa/src/services/line-item.ts:50
productService_
• Protected Readonly productService_: ProductService
Defined in
medusa/src/services/line-item.ts:49
productVariantService_
• Protected Readonly productVariantService_: ProductVariantService
Defined in
medusa/src/services/line-item.ts:48
regionService_
• Protected Readonly regionService_: RegionService
Defined in
medusa/src/services/line-item.ts:51
taxProviderService_
• Protected Readonly taxProviderService_: TaxProviderService
Defined in
medusa/src/services/line-item.ts:54
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
• Protected get activeManager_(): EntityManager
Returns
EntityManager
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
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
medusa/src/interfaces/transaction-base-service.ts:56
cloneTo
▸ cloneTo(ids, data?, options?): Promise<LineItem[]>
Parameters
| Name | Type |
|---|---|
ids |
string | string[] |
data |
DeepPartial<LineItem> |
options |
Object |
options.setOriginalLineItemId? |
boolean |
Returns
Promise<LineItem[]>
Defined in
medusa/src/services/line-item.ts:514
create
▸ create<T, TResult>(data): Promise<TResult>
Create a line item
Type parameters
| Name | Type |
|---|---|
T |
LineItem | LineItem[] |
TResult |
T extends LineItem[] ? LineItem[] : LineItem |
Parameters
| Name | Type | Description |
|---|---|---|
data |
T |
the line item object to create |
Returns
Promise<TResult>
the created line item
Defined in
medusa/src/services/line-item.ts:392
createReturnLines
▸ createReturnLines(returnId, cartId): Promise<LineItem[]>
Creates return line items for a given cart based on the return items in a return.
Parameters
| Name | Type | Description |
|---|---|---|
returnId |
string |
the id to generate return items from. |
cartId |
string |
the cart to assign the return line items to. |
Returns
Promise<LineItem[]>
the created line items
Defined in
medusa/src/services/line-item.ts:130
createTaxLine
▸ createTaxLine(args): LineItemTaxLine
Create a line item tax line.
Parameters
| Name | Type | Description |
|---|---|---|
args |
DeepPartial<LineItemTaxLine> |
tax line partial passed to the repo create method |
Returns
LineItemTaxLine
a new line item tax line
Defined in
medusa/src/services/line-item.ts:506
delete
▸ delete(id): Promise<undefined | null | LineItem>
Deletes a line item.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the line item to delete |
Returns
Promise<undefined | null | LineItem>
the result of the delete operation
Defined in
medusa/src/services/line-item.ts:465
deleteWithTaxLines
▸ deleteWithTaxLines(id): Promise<undefined | null | LineItem>
Deprecated
no the cascade on the entity takes care of it Deletes a line item with the tax lines.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the line item to delete |
Returns
Promise<undefined | null | LineItem>
the result of the delete operation
Defined in
medusa/src/services/line-item.ts:485
generate
▸ generate<T, TResult>(variantIdOrData, regionIdOrContext, quantity?, context?): Promise<TResult>
Generate a single or multiple line item without persisting the data into the db
Type parameters
| Name | Type |
|---|---|
T |
string | GenerateInputData | GenerateInputData[] |
TResult |
T extends string ? LineItem : T extends LineItem ? LineItem : LineItem[] |
Parameters
| Name | Type |
|---|---|
variantIdOrData |
T |
regionIdOrContext |
T extends string ? string : GenerateLineItemContext |
quantity? |
number |
context |
GenerateLineItemContext |
Returns
Promise<TResult>
Defined in
medusa/src/services/line-item.ts:191
generateLineItem
▸ Protected generateLineItem(variant, quantity, context): Promise<LineItem>
Parameters
| Name | Type |
|---|---|
variant |
Object |
variant.id |
string |
variant.product |
Object |
variant.product.discountable |
boolean |
variant.product.is_giftcard |
boolean |
variant.product.thumbnail |
null | string |
variant.product.title |
string |
variant.product_id |
string |
variant.title |
string |
quantity |
number |
context |
GenerateLineItemContext & { variantPricing: ProductVariantPricing } |
Returns
Promise<LineItem>
Defined in
medusa/src/services/line-item.ts:316
list
▸ list(selector, config?): Promise<LineItem[]>
Parameters
| Name | Type |
|---|---|
selector |
Selector<LineItem> |
config |
FindConfig<LineItem> |
Returns
Promise<LineItem[]>
Defined in
medusa/src/services/line-item.ts:83
retrieve
▸ retrieve(id, config?): Promise<LineItem>
Retrieves a line item by its id.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the line item to retrieve |
config |
Object |
the config to be used at query building |
Returns
Promise<LineItem>
the line item
Defined in
medusa/src/services/line-item.ts:104
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
▸ update(idOrSelector, data): Promise<LineItem[]>
Updates a line item
Parameters
| Name | Type | Description |
|---|---|---|
idOrSelector |
string | Selector<LineItem> |
the id or selector of the line item(s) to update |
data |
Partial<LineItem> |
the properties to update the line item(s) |
Returns
Promise<LineItem[]>
the updated line item(s)
Defined in
medusa/src/services/line-item.ts:422
validateGenerateArguments
▸ Protected validateGenerateArguments<T, TResult>(variantIdOrData, regionIdOrContext, quantity?): void
Type parameters
| Name | Type |
|---|---|
T |
string | GenerateInputData | GenerateInputData[] |
TResult |
T extends string ? LineItem : T extends LineItem ? LineItem : LineItem[] |
Parameters
| Name | Type |
|---|---|
variantIdOrData |
string | T |
regionIdOrContext |
T extends string ? string : GenerateLineItemContext |
quantity? |
number |
Returns
void
Defined in
medusa/src/services/line-item.ts:585
withTransaction
▸ withTransaction(transactionManager?): LineItemService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction