-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(medusa): Convert FulfillmentService to TypeScript (#1962)
- Loading branch information
Showing
7 changed files
with
226 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
"medusa-fulfillment-manual": patch | ||
"medusa-interfaces": patch | ||
"@medusajs/medusa": patch | ||
--- | ||
|
||
Convert FulfillmentService to TypeScript |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,191 @@ | ||
import { MedusaError } from "medusa-core-utils" | ||
import BaseFulfillmentService from "medusa-interfaces/dist/fulfillment-service" | ||
import { EntityManager } from "typeorm" | ||
import { TransactionBaseService } from "../interfaces" | ||
import { | ||
Cart, | ||
Fulfillment, | ||
FulfillmentProvider, | ||
LineItem, | ||
Order, | ||
Return, | ||
ShippingMethod, | ||
ShippingOption, | ||
} from "../models" | ||
import { FulfillmentProviderRepository } from "../repositories/fulfillment-provider" | ||
import { CreateFulfillmentOrder } from "../types/fulfillment" | ||
import { | ||
CreateReturnType, | ||
FulfillmentOptions, | ||
} from "../types/fulfillment-provider" | ||
import { MedusaContainer } from "../types/global" | ||
|
||
type FulfillmentProviderKey = `fp_${string}` | ||
|
||
type FulfillmentProviderContainer = MedusaContainer & { | ||
fulfillmentProviderRepository: typeof FulfillmentProviderRepository | ||
manager: EntityManager | ||
} & { | ||
[key in `${FulfillmentProviderKey}`]: BaseFulfillmentService | ||
} | ||
|
||
/** | ||
* Helps retrive fulfillment providers | ||
*/ | ||
class FulfillmentProviderService extends TransactionBaseService { | ||
protected manager_: EntityManager | ||
protected transactionManager_: EntityManager | undefined | ||
|
||
protected readonly container_: FulfillmentProviderContainer | ||
|
||
protected readonly fulfillmentProviderRepository_: typeof FulfillmentProviderRepository | ||
|
||
constructor(container: FulfillmentProviderContainer) { | ||
super(container) | ||
|
||
const { manager, fulfillmentProviderRepository } = container | ||
|
||
this.container_ = container | ||
this.manager_ = manager | ||
this.fulfillmentProviderRepository_ = fulfillmentProviderRepository | ||
} | ||
|
||
async registerInstalledProviders(providers: string[]): Promise<void> { | ||
return await this.atomicPhase_(async (manager) => { | ||
const fulfillmentProviderRepo = manager.getCustomRepository( | ||
this.fulfillmentProviderRepository_ | ||
) | ||
await fulfillmentProviderRepo.update({}, { is_installed: false }) | ||
|
||
for (const p of providers) { | ||
const n = fulfillmentProviderRepo.create({ id: p, is_installed: true }) | ||
await fulfillmentProviderRepo.save(n) | ||
} | ||
}) | ||
} | ||
|
||
async list(): Promise<FulfillmentProvider[]> { | ||
const fpRepo = this.manager_.getCustomRepository( | ||
this.fulfillmentProviderRepository_ | ||
) | ||
|
||
return await fpRepo.find({}) | ||
} | ||
|
||
async listFulfillmentOptions( | ||
providerIds: string[] | ||
): Promise<FulfillmentOptions[]> { | ||
return await Promise.all( | ||
providerIds.map(async (p) => { | ||
const provider = await this.retrieveProvider(p) | ||
return { | ||
provider_id: p, | ||
options: | ||
(await provider.getFulfillmentOptions()) as unknown as Record< | ||
string, | ||
unknown | ||
>[], | ||
} | ||
}) | ||
) | ||
} | ||
|
||
/** | ||
* @param providerId - the provider id | ||
* @return the payment fulfillment provider | ||
*/ | ||
retrieveProvider(providerId: string): BaseFulfillmentService { | ||
try { | ||
return this.container_[`fp_${providerId}`] | ||
} catch (err) { | ||
throw new MedusaError( | ||
MedusaError.Types.NOT_FOUND, | ||
`Could not find a fulfillment provider with id: ${providerId}` | ||
) | ||
} | ||
} | ||
|
||
async createFulfillment( | ||
method: ShippingMethod, | ||
items: LineItem[], | ||
order: CreateFulfillmentOrder, | ||
fulfillment: Omit<Fulfillment, "beforeInsert"> | ||
): Promise<Record<string, unknown>> { | ||
const provider = this.retrieveProvider(method.shipping_option.provider_id) | ||
return provider.createFulfillment( | ||
method.data, | ||
items, | ||
order, | ||
fulfillment | ||
) as unknown as Record<string, unknown> | ||
} | ||
|
||
async canCalculate(option: ShippingOption): Promise<boolean> { | ||
const provider = this.retrieveProvider(option.provider_id) | ||
return provider.canCalculate(option.data) as unknown as boolean | ||
} | ||
|
||
async validateFulfillmentData( | ||
option: ShippingOption, | ||
data: Record<string, unknown>, | ||
cart: Cart | Record<string, unknown> | ||
): Promise<Record<string, unknown>> { | ||
const provider = this.retrieveProvider(option.provider_id) | ||
return provider.validateFulfillmentData( | ||
option.data, | ||
data, | ||
cart | ||
) as unknown as Record<string, unknown> | ||
} | ||
|
||
async cancelFulfillment(fulfillment: Fulfillment): Promise<Fulfillment> { | ||
const provider = this.retrieveProvider(fulfillment.provider_id) | ||
return provider.cancelFulfillment( | ||
fulfillment.data | ||
) as unknown as Fulfillment | ||
} | ||
|
||
async calculatePrice( | ||
option: ShippingOption, | ||
data: Record<string, unknown>, | ||
cart?: Order | Cart | ||
): Promise<number> { | ||
const provider = this.retrieveProvider(option.provider_id) | ||
return provider.calculatePrice(option.data, data, cart) as unknown as number | ||
} | ||
|
||
async validateOption(option: ShippingOption): Promise<boolean> { | ||
const provider = this.retrieveProvider(option.provider_id) | ||
return provider.validateOption(option.data) as unknown as boolean | ||
} | ||
|
||
async createReturn( | ||
returnOrder: CreateReturnType | ||
): Promise<Record<string, unknown>> { | ||
const option = returnOrder.shipping_method.shipping_option | ||
const provider = this.retrieveProvider(option.provider_id) | ||
return provider.createReturn(returnOrder) as unknown as Record< | ||
string, | ||
unknown | ||
> | ||
} | ||
|
||
/** | ||
* Fetches documents from the fulfillment provider | ||
* @param providerId - the id of the provider | ||
* @param fulfillmentData - the data relating to the fulfillment | ||
* @param documentType - the typ of | ||
* @returns document to fetch | ||
*/ | ||
// TODO: consider removal in favor of "getReturnDocuments" and "getShipmentDocuments" | ||
async retrieveDocuments( | ||
providerId: string, | ||
fulfillmentData: Record<string, unknown>, | ||
documentType: "invoice" | "label" | ||
): Promise<any> { | ||
const provider = this.retrieveProvider(providerId) | ||
return provider.retrieveDocuments(fulfillmentData, documentType) | ||
} | ||
} | ||
|
||
export default FulfillmentProviderService |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.