-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
import.ts
955 lines (826 loc) · 28 KB
/
import.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
/* eslint-disable valid-jsdoc */
import { EntityManager } from "typeorm"
import { MedusaError } from "medusa-core-utils"
import { AbstractBatchJobStrategy, IFileService } from "../../../interfaces"
import CsvParser from "../../../services/csv-parser"
import {
BatchJobService,
ProductService,
ProductVariantService,
RegionService,
SalesChannelService,
ShippingProfileService,
} from "../../../services"
import { CreateProductInput, UpdateProductInput } from "../../../types/product"
import {
CreateProductVariantInput,
UpdateProductVariantInput,
} from "../../../types/product-variant"
import {
ImportJobContext,
InjectedProps,
OperationType,
ProductImportBatchJob,
ProductImportCsvSchema,
TBuiltProductImportLine,
TParsedProductImportRowData,
} from "./types"
import { BatchJob, SalesChannel } from "../../../models"
import { FlagRouter } from "../../../utils/flag-router"
import { transformProductData, transformVariantData } from "./utils"
import SalesChannelFeatureFlag from "../../../loaders/feature-flags/sales-channels"
/**
* Process this many variant rows before reporting progress.
*/
const BATCH_SIZE = 100
/**
* Default strategy class used for a batch import of products/variants.
*/
class ProductImportStrategy extends AbstractBatchJobStrategy {
static identifier = "product-import-strategy"
static batchType = "product-import"
private processedCounter: Record<string, number> = {}
protected readonly featureFlagRouter_: FlagRouter
protected manager_: EntityManager
protected transactionManager_: EntityManager | undefined
protected readonly fileService_: IFileService
protected readonly regionService_: RegionService
protected readonly productService_: ProductService
protected readonly batchJobService_: BatchJobService
protected readonly salesChannelService_: SalesChannelService
protected readonly productVariantService_: ProductVariantService
protected readonly shippingProfileService_: ShippingProfileService
protected readonly csvParser_: CsvParser<
ProductImportCsvSchema,
Record<string, string>,
Record<string, string>
>
constructor({
batchJobService,
productService,
salesChannelService,
productVariantService,
shippingProfileService,
regionService,
fileService,
manager,
featureFlagRouter,
}: InjectedProps) {
// eslint-disable-next-line prefer-rest-params
super(arguments[0])
const isSalesChannelsFeatureOn = featureFlagRouter.isFeatureEnabled(
SalesChannelFeatureFlag.key
)
this.csvParser_ = new CsvParser({
...CSVSchema,
columns: [
...CSVSchema.columns,
...(isSalesChannelsFeatureOn ? SalesChannelsSchema.columns : []),
],
})
this.featureFlagRouter_ = featureFlagRouter
this.manager_ = manager
this.fileService_ = fileService
this.batchJobService_ = batchJobService
this.productService_ = productService
this.salesChannelService_ = salesChannelService
this.productVariantService_ = productVariantService
this.shippingProfileService_ = shippingProfileService
this.regionService_ = regionService
}
buildTemplate(): Promise<string> {
throw new Error("Not implemented!")
}
/**
* Create a description of a row on which the error occurred and throw a Medusa error.
*
* @param row - Parsed CSV row data
* @param errorDescription - Concrete error
*/
protected static throwDescriptiveError(
row: TParsedProductImportRowData,
errorDescription?: string
): never {
const message = `Error while processing row with:
product id: ${row["product.id"]},
product handle: ${row["product.handle"]},
variant id: ${row["variant.id"]}
variant sku: ${row["variant.sku"]}
${errorDescription}`
throw new MedusaError(MedusaError.Types.INVALID_DATA, message)
}
/**
* Generate instructions for update/create of products/variants from parsed CSV rows.
*
* @param csvData - An array of parsed CSV rows.
*/
async getImportInstructions(
csvData: TParsedProductImportRowData[]
): Promise<Record<OperationType, TParsedProductImportRowData[]>> {
const transactionManager = this.transactionManager_ ?? this.manager_
const shippingProfile = await this.shippingProfileService_
.withTransaction(transactionManager)
.retrieveDefault()
const seenProducts = {}
const productsCreate: TParsedProductImportRowData[] = []
const productsUpdate: TParsedProductImportRowData[] = []
const variantsCreate: TParsedProductImportRowData[] = []
const variantsUpdate: TParsedProductImportRowData[] = []
for (const row of csvData) {
if ((row["variant.prices"] as Record<string, any>[]).length) {
await this.prepareVariantPrices(row)
}
if (row["variant.id"]) {
variantsUpdate.push(row)
} else {
variantsCreate.push(row)
}
// save only first occurrence
if (!seenProducts[row["product.handle"] as string]) {
row["product.profile_id"] = shippingProfile!.id
if (row["product.product.id"]) {
productsUpdate.push(row)
} else {
productsCreate.push(row)
}
seenProducts[row["product.handle"] as string] = true
}
}
return {
[OperationType.ProductCreate]: productsCreate,
[OperationType.VariantCreate]: variantsCreate,
[OperationType.ProductUpdate]: productsUpdate,
[OperationType.VariantUpdate]: variantsUpdate,
}
}
/**
* Prepare prices records for insert - find and append region ids to records that contain a region name.
*
* @param row - An object containing parsed row data.
*/
protected async prepareVariantPrices(row): Promise<void> {
const transactionManager = this.transactionManager_ ?? this.manager_
const prices: Record<string, string | number>[] = []
for (const price of row["variant.prices"]) {
const record: Record<string, string | number> = {
amount: price.amount,
}
if (price.regionName) {
try {
record.region_id = (
await this.regionService_
.withTransaction(transactionManager)
.retrieveByName(price.regionName)
)?.id
} catch (e) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Trying to set a price for a region ${price.regionName} that doesn't exist`
)
}
} else {
record.currency_code = price.currency_code
}
prices.push(record)
}
row["variant.prices"] = prices
}
/**
* A worker method called after a batch job has been created.
* The method parses a CSV file, generates sets of instructions
* for processing and stores these instructions to a JSON file
* which is uploaded to a bucket.
*
* @param batchJobId - An id of a job that is being preprocessed.
*/
async preProcessBatchJob(batchJobId: string): Promise<void> {
const transactionManager = this.transactionManager_ ?? this.manager_
const batchJob = await this.batchJobService_
.withTransaction(transactionManager)
.retrieve(batchJobId)
const csvFileKey = (batchJob.context as ImportJobContext).fileKey
const csvStream = await this.fileService_.getDownloadStream({
fileKey: csvFileKey,
})
let builtData: Record<string, string>[]
try {
const parsedData = await this.csvParser_.parse(csvStream)
builtData = await this.csvParser_.buildData(parsedData)
} catch (e) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
"The csv file parsing failed due to: " + e.message
)
}
const ops = await this.getImportInstructions(builtData)
await this.uploadImportOpsFile(batchJobId, ops)
let totalOperationCount = 0
const operationsCounts = {}
Object.keys(ops).forEach((key) => {
operationsCounts[key] = ops[key].length
totalOperationCount += ops[key].length
})
await this.batchJobService_
.withTransaction(transactionManager)
.update(batchJobId, {
result: {
advancement_count: 0,
// number of update/create operations to execute
count: totalOperationCount,
operations: operationsCounts,
stat_descriptors: [
{
key: "product-import-count",
name: "Products/variants to import",
message: `There will be ${
ops[OperationType.ProductCreate].length
} products created (${
ops[OperationType.ProductUpdate].length
} updated).
${
ops[OperationType.VariantCreate].length
} variants will be created and ${
ops[OperationType.VariantUpdate].length
} updated`,
},
],
},
})
}
/**
* The main processing method called after a batch job
* is ready/confirmed for processing.
*
* @param batchJobId - An id of a batch job that is being processed.
*/
async processJob(batchJobId: string): Promise<void> {
return await this.atomicPhase_(async (manager) => {
const batchJob = (await this.batchJobService_
.withTransaction(manager)
.retrieve(batchJobId)) as ProductImportBatchJob
await this.createProducts(batchJob)
await this.updateProducts(batchJob)
await this.createVariants(batchJob)
await this.updateVariants(batchJob)
await this.finalize(batchJob)
})
}
/**
* Create, or retrieve by name, sales channels from the input data.
*
* NOTE: Sales channel names provided in the CSV must exist in the DB.
* New sales channels will not be created.
*
* @param data an array of sales channels partials
* @return an array of sales channels created or retrieved by name
*/
private async processSalesChannels(
data: Pick<SalesChannel, "name" | "id">[]
): Promise<SalesChannel[]> {
const transactionManager = this.transactionManager_ ?? this.manager_
const salesChannelServiceTx =
this.salesChannelService_.withTransaction(transactionManager)
const salesChannels: SalesChannel[] = []
for (const input of data) {
let channel: SalesChannel | null = null
if (input.id) {
try {
channel = await salesChannelServiceTx.retrieve(input.id, {
select: ["id"],
})
} catch (e) {
// noop - check if the channel exists with provided name
}
}
if (!channel) {
try {
channel = (await salesChannelServiceTx.retrieveByName(input.name, {
select: ["id"],
})) as SalesChannel
} catch (e) {
// noop
}
}
if (channel) {
salesChannels.push(channel)
}
}
return salesChannels
}
/**
* Method creates products using `ProductService` and parsed data from a CSV row.
*
* @param batchJob - The current batch job being processed.
*/
private async createProducts(batchJob: ProductImportBatchJob): Promise<void> {
if (!batchJob.result.operations[OperationType.ProductCreate]) {
return
}
const transactionManager = this.transactionManager_ ?? this.manager_
const productOps = await this.downloadImportOpsFile(
batchJob.id,
OperationType.ProductCreate
)
const productServiceTx =
this.productService_.withTransaction(transactionManager)
const isSalesChannelsFeatureOn = this.featureFlagRouter_.isFeatureEnabled(
SalesChannelFeatureFlag.key
)
for (const productOp of productOps) {
const productData = transformProductData(
productOp
) as unknown as CreateProductInput
try {
if (isSalesChannelsFeatureOn && productOp["product.sales_channels"]) {
productData["sales_channels"] = await this.processSalesChannels(
productOp["product.sales_channels"] as Pick<
SalesChannel,
"name" | "id"
>[]
)
}
await productServiceTx.create(productData)
} catch (e) {
ProductImportStrategy.throwDescriptiveError(productOp, e.message)
}
await this.updateProgress(batchJob.id)
}
}
/**
* Method updates existing products in the DB using a CSV row data.
*
* @param batchJob - The current batch job being processed.
*/
private async updateProducts(batchJob: ProductImportBatchJob): Promise<void> {
if (!batchJob.result.operations[OperationType.ProductUpdate]) {
return
}
const transactionManager = this.transactionManager_ ?? this.manager_
const productOps = await this.downloadImportOpsFile(
batchJob.id,
OperationType.ProductUpdate
)
const productServiceTx =
this.productService_.withTransaction(transactionManager)
const isSalesChannelsFeatureOn = this.featureFlagRouter_.isFeatureEnabled(
SalesChannelFeatureFlag.key
)
for (const productOp of productOps) {
const productData = transformProductData(productOp) as UpdateProductInput
try {
if (isSalesChannelsFeatureOn) {
productData["sales_channels"] = await this.processSalesChannels(
productOp["product.sales_channels"] as Pick<
SalesChannel,
"name" | "id"
>[]
)
}
await productServiceTx.update(
productOp["product.id"] as string,
productData
)
} catch (e) {
ProductImportStrategy.throwDescriptiveError(productOp, e.message)
}
await this.updateProgress(batchJob.id)
}
}
/**
* Method creates product variants from a CSV data.
* Method also handles processing of variant options.
*
* @param batchJob - The current batch job being processed.
*/
private async createVariants(batchJob: ProductImportBatchJob): Promise<void> {
if (!batchJob.result.operations[OperationType.VariantCreate]) {
return
}
const transactionManager = this.transactionManager_ ?? this.manager_
const variantOps = await this.downloadImportOpsFile(
batchJob.id,
OperationType.VariantCreate
)
for (const variantOp of variantOps) {
try {
const variant = transformVariantData(variantOp)
const product = await this.productService_
.withTransaction(transactionManager)
.retrieveByHandle(variantOp["product.handle"] as string, {
relations: ["variants", "variants.options", "options"],
})
const optionIds =
(variantOp["product.options"] as Record<string, string>[])?.map(
(variantOption) =>
product!.options.find(
(createdProductOption) =>
createdProductOption.title === variantOption.title
)!.id
) || []
variant.options =
(variant.options as Record<string, any>[])?.map((o, index) => ({
...o,
option_id: optionIds[index],
})) || []
await this.productVariantService_
.withTransaction(transactionManager)
.create(product!, variant as unknown as CreateProductVariantInput)
await this.updateProgress(batchJob.id)
} catch (e) {
ProductImportStrategy.throwDescriptiveError(variantOp, e.message)
}
}
}
/**
* Method updates product variants from a CSV data.
*
* @param batchJob - The current batch job being processed.
*/
private async updateVariants(batchJob: ProductImportBatchJob): Promise<void> {
if (!batchJob.result.operations[OperationType.VariantUpdate]) {
return
}
const transactionManager = this.transactionManager_ ?? this.manager_
const variantOps = await this.downloadImportOpsFile(
batchJob.id,
OperationType.VariantUpdate
)
const productServiceTx =
this.productService_.withTransaction(transactionManager)
for (const variantOp of variantOps) {
try {
const product = await productServiceTx.retrieveByHandle(
variantOp["product.handle"] as string
)
await this.prepareVariantOptions(variantOp, product.id)
await this.productVariantService_
.withTransaction(transactionManager)
.update(
variantOp["variant.id"] as string,
transformVariantData(variantOp) as UpdateProductVariantInput
)
} catch (e) {
ProductImportStrategy.throwDescriptiveError(variantOp, e.message)
}
await this.updateProgress(batchJob.id)
}
}
/**
* Extend records used for creating variant options with corresponding product option ids.
*
* @param variantOp - Parsed row data form CSV
* @param productId - id of variant's product
*/
protected async prepareVariantOptions(
variantOp,
productId: string
): Promise<void> {
const transactionManager = this.transactionManager_ ?? this.manager_
const productOptions = variantOp["variant.options"] || []
const productServiceTx =
this.productService_.withTransaction(transactionManager)
for (const o of productOptions) {
const option = await productServiceTx.retrieveOptionByTitle(
o._title,
productId
)
o.option_id = option?.id
}
}
/**
* Store import ops JSON file to a bucket.
*
* @param batchJobId - An id of the current batch job being processed.
* @param results - An object containing parsed CSV data.
*/
protected async uploadImportOpsFile(
batchJobId: string,
results: Record<OperationType, TParsedProductImportRowData[]>
): Promise<void> {
const uploadPromises: Promise<void>[] = []
const transactionManager = this.transactionManager_ ?? this.manager_
for (const op in results) {
if (results[op]?.length) {
const { writeStream, promise } = await this.fileService_
.withTransaction(transactionManager)
.getUploadStreamDescriptor({
name: ProductImportStrategy.buildFilename(batchJobId, op),
ext: "json",
})
uploadPromises.push(promise)
writeStream.write(JSON.stringify(results[op]))
writeStream.end()
}
}
await Promise.all(uploadPromises)
}
/**
* Remove parsed ops JSON file.
*
* @param batchJobId - An id of the current batch job being processed.
* @param op - Type of import operation.
*/
protected async downloadImportOpsFile(
batchJobId: string,
op: OperationType
): Promise<TParsedProductImportRowData[]> {
let data = ""
const transactionManager = this.transactionManager_ ?? this.manager_
const readableStream = await this.fileService_
.withTransaction(transactionManager)
.getDownloadStream({
fileKey: ProductImportStrategy.buildFilename(batchJobId, op, {
appendExt: ".json",
}),
})
return await new Promise((resolve) => {
readableStream.on("data", (chunk) => {
data += chunk
})
readableStream.on("end", () => {
resolve(JSON.parse(data))
})
readableStream.on("error", () => {
// TODO: maybe should throw
resolve([] as TParsedProductImportRowData[])
})
})
}
/**
* Delete parsed CSV ops files.
*
* @param batchJobId - An id of the current batch job being processed.
*/
protected async deleteOpsFiles(batchJobId: string): Promise<void> {
const transactionManager = this.transactionManager_ ?? this.manager_
const fileServiceTx = this.fileService_.withTransaction(transactionManager)
for (const op of Object.values(OperationType)) {
try {
await fileServiceTx.delete({
fileKey: ProductImportStrategy.buildFilename(batchJobId, op, {
appendExt: ".json",
}),
})
} catch (e) {
// noop
}
}
}
/**
* Update count of processed data in the batch job `result` column
* and cleanup temp JSON files.
*
* @param batchJob - The current batch job being processed.
*/
private async finalize(batchJob: BatchJob): Promise<void> {
const transactionManager = this.transactionManager_ ?? this.manager_
delete this.processedCounter[batchJob.id]
await this.batchJobService_
.withTransaction(transactionManager)
.update(batchJob.id, {
result: { advancement_count: batchJob.result.count },
})
const { fileKey } = batchJob.context as ImportJobContext
await this.fileService_
.withTransaction(transactionManager)
.delete({ fileKey })
await this.deleteOpsFiles(batchJob.id)
}
/**
* Store the progress in the batch job `result` column.
* Method is called after every update/create operation,
* but after every `BATCH_SIZE` processed rows info is written to the DB.
*
* @param batchJobId - An id of the current batch job being processed.
*/
private async updateProgress(batchJobId: string): Promise<void> {
const newCount = (this.processedCounter[batchJobId] || 0) + 1
this.processedCounter[batchJobId] = newCount
if (newCount % BATCH_SIZE !== 0) {
return
}
await this.batchJobService_
.withTransaction(this.transactionManager_ ?? this.manager_)
.update(batchJobId, {
result: {
advancement_count: newCount,
},
})
}
private static buildFilename(
batchJobId: string,
operation: string,
{ appendExt }: { appendExt?: string } = { appendExt: undefined }
): string {
const filename = `imports/products/ops/${batchJobId}-${operation}`
return appendExt ? filename + appendExt : filename
}
}
export default ProductImportStrategy
/**
* Schema definition for the CSV parser.
*/
const CSVSchema: ProductImportCsvSchema = {
columns: [
// PRODUCT
{
name: "Product id",
mapTo: "product.id",
},
{
name: "Product Handle",
mapTo: "product.handle",
required: true,
},
{ name: "Product Title", mapTo: "product.title" },
{ name: "Product Subtitle", mapTo: "product.subtitle" },
{ name: "Product Description", mapTo: "product.description" },
{ name: "Product Status", mapTo: "product.status" },
{ name: "Product Thumbnail", mapTo: "product.thumbnail" },
{ name: "Product Weight", mapTo: "product.weight" },
{ name: "Product Length", mapTo: "product.length" },
{ name: "Product Width", mapTo: "product.width" },
{ name: "Product Height", mapTo: "product.height" },
{ name: "Product HS Code", mapTo: "product.hs_code" },
{ name: "Product Origin Country", mapTo: "product.origin_country" },
{ name: "Product MID Code", mapTo: "product.mid_code" },
{ name: "Product Material", mapTo: "product.material" },
// PRODUCT-COLLECTION
{ name: "Product Collection Title", mapTo: "product.collection.title" },
{ name: "Product Collection Handle", mapTo: "product.collection.handle" },
// PRODUCT-TYPE
{ name: "Product Type", mapTo: "product.type.value" },
// PRODUCT-TAGS
{
name: "Product Tags",
mapTo: "product.tags",
transform: (value: string) =>
`${value}`.split(",").map((v) => ({ value: v })),
},
//
{ name: "Product Discountable", mapTo: "product.discountable" },
{ name: "Product External ID", mapTo: "product.external_id" },
// PRODUCT-SHIPPING_PROFILE
{ name: "Product Profile Name", mapTo: "product.profile.name" },
{ name: "Product Profile Type", mapTo: "product.profile.type" },
// VARIANTS
{
name: "Variant id",
mapTo: "variant.id",
},
{ name: "Variant Title", mapTo: "variant.title" },
{ name: "Variant SKU", mapTo: "variant.sku" },
{ name: "Variant Barcode", mapTo: "variant.barcode" },
{ name: "Variant Inventory Quantity", mapTo: "variant.inventory_quantity" },
{ name: "Variant Allow backorder", mapTo: "variant.allow_backorder" },
{ name: "Variant Manage inventory", mapTo: "variant.manage_inventory" },
{ name: "Variant Weight", mapTo: "variant.weight" },
{ name: "Variant Length", mapTo: "variant.length" },
{ name: "Variant Width", mapTo: "variant.width" },
{ name: "Variant Height", mapTo: "variant.height" },
{ name: "Variant HS Code", mapTo: "variant.hs_code" },
{ name: "Variant Origin Country", mapTo: "variant.origin_country" },
{ name: "Variant MID Code", mapTo: "variant.mid_code" },
{ name: "Variant Material", mapTo: "variant.material" },
// ==== DYNAMIC FIELDS ====
// PRODUCT_OPTIONS
{
name: "Option Name",
match: /Option \d+ Name/,
reducer: (builtLine, key, value): TBuiltProductImportLine => {
builtLine["product.options"] = builtLine["product.options"] || []
if (typeof value === "undefined" || value === null) {
return builtLine
}
;(
builtLine["product.options"] as Record<string, string | number>[]
).push({ title: value })
return builtLine
},
},
{
name: "Option Value",
match: /Option \d+ Value/,
reducer: (
builtLine: TParsedProductImportRowData,
key: string,
value: string,
context: any
): TBuiltProductImportLine => {
builtLine["variant.options"] = builtLine["variant.options"] || []
if (typeof value === "undefined" || value === null) {
return builtLine
}
;(
builtLine["variant.options"] as Record<string, string | number>[]
).push({
value,
_title: context.line[key.slice(0, -6) + " Name"],
})
return builtLine
},
},
// PRICES
{
name: "Price Region",
match: /Price .* \[([A-Z]{2,4})\]/,
reducer: (
builtLine: TParsedProductImportRowData,
key,
value
): TBuiltProductImportLine => {
builtLine["variant.prices"] = builtLine["variant.prices"] || []
if (typeof value === "undefined" || value === null) {
return builtLine
}
const regionName = key.split(" ")[1]
;(
builtLine["variant.prices"] as Record<string, string | number>[]
).push({
amount: value,
regionName,
})
return builtLine
},
},
{
name: "Price Currency",
match: /Price [A-Z]{2,4}/,
reducer: (
builtLine: TParsedProductImportRowData,
key,
value
): TBuiltProductImportLine => {
builtLine["variant.prices"] = builtLine["variant.prices"] || []
if (typeof value === "undefined" || value === null) {
return builtLine
}
const currency = key.split(" ")[1]
;(
builtLine["variant.prices"] as Record<string, string | number>[]
).push({
amount: value,
currency_code: currency,
})
return builtLine
},
},
// IMAGES
{
name: "Image Url",
match: /Image \d+ Url/,
reducer: (builtLine: any, key, value): TBuiltProductImportLine => {
builtLine["product.images"] = builtLine["product.images"] || []
if (typeof value === "undefined" || value === null) {
return builtLine
}
builtLine["product.images"].push(value)
return builtLine
},
},
],
}
const SalesChannelsSchema: ProductImportCsvSchema = {
columns: [
{
name: "Sales Channel Name",
match: /Sales Channel \d+ Name/,
reducer: (builtLine, key, value): TBuiltProductImportLine => {
builtLine["product.sales_channels"] =
builtLine["product.sales_channels"] || []
if (typeof value === "undefined" || value === null) {
return builtLine
}
;(
builtLine["product.sales_channels"] as Record<
string,
string | number
>[]
).push({
name: value,
})
return builtLine
},
},
{
name: "Sales Channel Id",
match: /Sales Channel \d+ Id/,
reducer: (builtLine, key, value): TBuiltProductImportLine => {
builtLine["product.sales_channels"] =
builtLine["product.sales_channels"] || []
if (typeof value === "undefined" || value === null) {
return builtLine
}
;(
builtLine["product.sales_channels"] as Record<
string,
string | number
>[]
).push({
id: value,
})
return builtLine
},
},
],
}