@useairfoil/producer-shopify 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/LICENSE.txt +201 -0
  2. package/dist/index.d.mts +1 -1
  3. package/dist/index.mjs +1 -1
  4. package/dist/main.mjs +7 -5
  5. package/dist/main.mjs.map +1 -1
  6. package/dist/{src-Bgvuhcfk.mjs → src-YBU_KSf5.mjs} +272 -273
  7. package/dist/src-YBU_KSf5.mjs.map +1 -0
  8. package/package.json +17 -17
  9. package/src/create-table.ts +6 -1
  10. package/src/main.ts +8 -2
  11. package/src/resources/carts/row.ts +59 -35
  12. package/src/resources/customers/row.ts +67 -39
  13. package/src/resources/orders/row.ts +242 -116
  14. package/src/resources/products/row.ts +72 -42
  15. package/src/resources/refunds/row.ts +84 -44
  16. package/src/resources/shared.ts +77 -70
  17. package/src/start.ts +2 -2
  18. package/dist/src-Bgvuhcfk.mjs.map +0 -1
package/src/resources/orders/row.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { Iceberg } from "@useairfoil/connector-kit";
2
2
  import * as Schema from "effect/Schema";
3
3
 
4
- import { address, attributes, discountAllocations, field, moneyBag, taxLines } from "../shared";
4
+ import { address, attributes, discountAllocations, moneyBag, taxLines } from "../shared";
5
5
 
6
6
  export const OrderCancelReasonSchema = Schema.Literals([
7
7
  "CUSTOMER",
@@ -40,133 +40,259 @@ export const DiscountTargetTypeSchema = Schema.Literals(["LINE_ITEM", "SHIPPING_
40
40
  export const DiscountValueTypeSchema = Schema.Literals(["PERCENTAGE", "FIXED_AMOUNT"]);
41
41
 
42
42
  export const DiscountApplicationSchema = Schema.Struct({
43
- index: Schema.Int.pipe(field(161, "Position used by discount allocations.")),
44
- type: DiscountApplicationTypeSchema.pipe(field(162, "How the discount was applied.")),
45
- code: Schema.NullOr(Schema.String).pipe(field(163, "Discount code.")),
46
- title: Schema.NullOr(Schema.String).pipe(field(164, "Discount title.")),
47
- description: Schema.NullOr(Schema.String).pipe(field(165, "Manual discount description.")),
48
- allocationMethod: DiscountAllocationMethodSchema.pipe(field(166, "How the value is split.")),
49
- targetSelection: DiscountTargetSelectionSchema.pipe(field(167, "Which lines are targeted.")),
50
- targetType: DiscountTargetTypeSchema.pipe(field(168, "Kind of lines targeted.")),
51
- valueType: DiscountValueTypeSchema.pipe(field(169, "Whether the value is a percent.")),
52
- value: Schema.String.pipe(field(170, "Percent or amount in the customer currency.")),
43
+ index: Schema.Int.pipe(
44
+ Schema.annotateKey({ description: "Position used by discount allocations." }),
45
+ ),
46
+ type: DiscountApplicationTypeSchema.pipe(
47
+ Schema.annotateKey({ description: "How the discount was applied." }),
48
+ ),
49
+ code: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Discount code." })),
50
+ title: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Discount title." })),
51
+ description: Schema.NullOr(Schema.String).pipe(
52
+ Schema.annotateKey({ description: "Manual discount description." }),
53
+ ),
54
+ allocationMethod: DiscountAllocationMethodSchema.pipe(
55
+ Schema.annotateKey({ description: "How the value is split." }),
56
+ ),
57
+ targetSelection: DiscountTargetSelectionSchema.pipe(
58
+ Schema.annotateKey({ description: "Which lines are targeted." }),
59
+ ),
60
+ targetType: DiscountTargetTypeSchema.pipe(
61
+ Schema.annotateKey({ description: "Kind of lines targeted." }),
62
+ ),
63
+ valueType: DiscountValueTypeSchema.pipe(
64
+ Schema.annotateKey({ description: "Whether the value is a percent." }),
65
+ ),
66
+ value: Schema.String.pipe(
67
+ Schema.annotateKey({ description: "Percent or amount in the customer currency." }),
68
+ ),
53
69
  });
54
70
 
55
71
  export const ShippingLineSchema = Schema.Struct({
56
- id: Schema.NullOr(Schema.String).pipe(field(501, "Unique shipping line identifier.")),
57
- title: Schema.String.pipe(field(502, "Shipping method title.")),
58
- code: Schema.NullOr(Schema.String).pipe(field(503, "Shipping rate code.")),
59
- source: Schema.NullOr(Schema.String).pipe(field(504, "Source of the shipping rate.")),
60
- carrierIdentifier: Schema.NullOr(Schema.String).pipe(field(505, "Carrier service identifier.")),
61
- phone: Schema.NullOr(Schema.String).pipe(field(506, "Phone number for the shipping line.")),
62
- isRemoved: Schema.Boolean.pipe(field(507, "Whether the line was removed by an edit.")),
63
- originalPriceSet: moneyBag(520).pipe(field(508, "Price before discounts.")),
64
- discountedPriceSet: moneyBag(530).pipe(field(509, "Price after discounts.")),
65
- currentDiscountedPriceSet: moneyBag(540).pipe(
66
- field(510, "Price after discounts, edits, and refunds."),
67
- ),
68
- taxLines: taxLines(550).pipe(field(511, "Taxes on the shipping line.")),
69
- discountAllocations: discountAllocations(570).pipe(field(512, "Discounts on the line.")),
72
+ id: Schema.NullOr(Schema.String).pipe(
73
+ Schema.annotateKey({ description: "Unique shipping line identifier." }),
74
+ ),
75
+ title: Schema.String.pipe(Schema.annotateKey({ description: "Shipping method title." })),
76
+ code: Schema.NullOr(Schema.String).pipe(
77
+ Schema.annotateKey({ description: "Shipping rate code." }),
78
+ ),
79
+ source: Schema.NullOr(Schema.String).pipe(
80
+ Schema.annotateKey({ description: "Source of the shipping rate." }),
81
+ ),
82
+ carrierIdentifier: Schema.NullOr(Schema.String).pipe(
83
+ Schema.annotateKey({ description: "Carrier service identifier." }),
84
+ ),
85
+ phone: Schema.NullOr(Schema.String).pipe(
86
+ Schema.annotateKey({ description: "Phone number for the shipping line." }),
87
+ ),
88
+ isRemoved: Schema.Boolean.pipe(
89
+ Schema.annotateKey({ description: "Whether the line was removed by an edit." }),
90
+ ),
91
+ originalPriceSet: moneyBag.pipe(Schema.annotateKey({ description: "Price before discounts." })),
92
+ discountedPriceSet: moneyBag.pipe(Schema.annotateKey({ description: "Price after discounts." })),
93
+ currentDiscountedPriceSet: moneyBag.pipe(
94
+ Schema.annotateKey({ description: "Price after discounts, edits, and refunds." }),
95
+ ),
96
+ taxLines: taxLines.pipe(Schema.annotateKey({ description: "Taxes on the shipping line." })),
97
+ discountAllocations: discountAllocations.pipe(
98
+ Schema.annotateKey({ description: "Discounts on the line." }),
99
+ ),
70
100
  });
71
101
 
72
102
  export const OrderLineItemSchema = Schema.Struct({
73
- id: Schema.String.pipe(field(601, "Unique line item identifier.")),
74
- name: Schema.String.pipe(field(602, "Product and variant name.")),
75
- title: Schema.String.pipe(field(603, "Product title.")),
76
- variantTitle: Schema.NullOr(Schema.String).pipe(field(604, "Variant title.")),
77
- sku: Schema.NullOr(Schema.String).pipe(field(605, "Stock keeping unit.")),
78
- vendor: Schema.NullOr(Schema.String).pipe(field(606, "Product vendor.")),
79
- productId: Schema.NullOr(Schema.String).pipe(field(607, "Product identifier.")),
80
- variantId: Schema.NullOr(Schema.String).pipe(field(608, "Product variant identifier.")),
81
- quantity: Schema.Int.pipe(field(609, "Quantity when the order was placed.")),
82
- currentQuantity: Schema.Int.pipe(field(610, "Quantity after removals and refunds.")),
83
- taxable: Schema.Boolean.pipe(field(611, "Whether the line item is taxable.")),
84
- requiresShipping: Schema.Boolean.pipe(field(612, "Whether the line item needs shipping.")),
85
- isGiftCard: Schema.Boolean.pipe(field(613, "Whether the line item is a gift card.")),
86
- originalUnitPriceSet: moneyBag(630).pipe(field(614, "Unit price before discounts.")),
87
- totalDiscountSet: moneyBag(640).pipe(field(615, "Total discount on the line.")),
88
- taxLines: taxLines(650).pipe(field(616, "Taxes on the line.")),
89
- discountAllocations: discountAllocations(670).pipe(field(617, "Discounts on the line.")),
90
- customAttributes: attributes(690).pipe(field(618, "Custom line properties.")),
103
+ id: Schema.String.pipe(Schema.annotateKey({ description: "Unique line item identifier." })),
104
+ name: Schema.String.pipe(Schema.annotateKey({ description: "Product and variant name." })),
105
+ title: Schema.String.pipe(Schema.annotateKey({ description: "Product title." })),
106
+ variantTitle: Schema.NullOr(Schema.String).pipe(
107
+ Schema.annotateKey({ description: "Variant title." }),
108
+ ),
109
+ sku: Schema.NullOr(Schema.String).pipe(
110
+ Schema.annotateKey({ description: "Stock keeping unit." }),
111
+ ),
112
+ vendor: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Product vendor." })),
113
+ productId: Schema.NullOr(Schema.String).pipe(
114
+ Schema.annotateKey({ description: "Product identifier." }),
115
+ ),
116
+ variantId: Schema.NullOr(Schema.String).pipe(
117
+ Schema.annotateKey({ description: "Product variant identifier." }),
118
+ ),
119
+ quantity: Schema.Int.pipe(
120
+ Schema.annotateKey({ description: "Quantity when the order was placed." }),
121
+ ),
122
+ currentQuantity: Schema.Int.pipe(
123
+ Schema.annotateKey({ description: "Quantity after removals and refunds." }),
124
+ ),
125
+ taxable: Schema.Boolean.pipe(
126
+ Schema.annotateKey({ description: "Whether the line item is taxable." }),
127
+ ),
128
+ requiresShipping: Schema.Boolean.pipe(
129
+ Schema.annotateKey({ description: "Whether the line item needs shipping." }),
130
+ ),
131
+ isGiftCard: Schema.Boolean.pipe(
132
+ Schema.annotateKey({ description: "Whether the line item is a gift card." }),
133
+ ),
134
+ originalUnitPriceSet: moneyBag.pipe(
135
+ Schema.annotateKey({ description: "Unit price before discounts." }),
136
+ ),
137
+ totalDiscountSet: moneyBag.pipe(
138
+ Schema.annotateKey({ description: "Total discount on the line." }),
139
+ ),
140
+ taxLines: taxLines.pipe(Schema.annotateKey({ description: "Taxes on the line." })),
141
+ discountAllocations: discountAllocations.pipe(
142
+ Schema.annotateKey({ description: "Discounts on the line." }),
143
+ ),
144
+ customAttributes: attributes.pipe(Schema.annotateKey({ description: "Custom line properties." })),
91
145
  });
92
146
 
93
147
  export const OrderSchema = Schema.Struct({
94
- id: Schema.String.pipe(field(1, "Unique order identifier.")),
95
- legacyResourceId: Schema.String.pipe(field(2, "Numeric order identifier stored as text.")),
96
- name: Schema.String.pipe(field(3, "Order name shown to the merchant.")),
97
- email: Schema.NullOr(Schema.String).pipe(field(4, "Email used for the order.")),
98
- phone: Schema.NullOr(Schema.String).pipe(field(5, "Phone used for the order.")),
99
- customerId: Schema.NullOr(Schema.String).pipe(field(6, "Customer identifier.")),
100
- customerLocale: Schema.NullOr(Schema.String).pipe(field(7, "Customer language.")),
101
- customerAcceptsMarketing: Schema.Boolean.pipe(field(8, "Whether the buyer accepts marketing.")),
102
- billingAddress: Schema.NullOr(address(100)).pipe(field(9, "Billing address.")),
103
- shippingAddress: Schema.NullOr(address(120)).pipe(field(10, "Shipping address.")),
104
- note: Schema.NullOr(Schema.String).pipe(field(11, "Order note.")),
105
- customAttributes: attributes(140).pipe(field(12, "Custom order attributes.")),
106
- tags: Schema.Array(Schema.String.annotate({ fieldId: 150 })).pipe(
107
- field(13, "Tags added to the order."),
108
- ),
109
- confirmationNumber: Schema.NullOr(Schema.String).pipe(field(14, "Confirmation number.")),
110
- poNumber: Schema.NullOr(Schema.String).pipe(field(15, "Purchase order number.")),
111
- sourceName: Schema.NullOr(Schema.String).pipe(field(16, "Channel that created the order.")),
112
- sourceIdentifier: Schema.NullOr(Schema.String).pipe(field(17, "Identifier from the source.")),
113
- appId: Schema.NullOr(Schema.String).pipe(field(18, "App that created the order.")),
114
- paymentGatewayNames: Schema.Array(Schema.String.annotate({ fieldId: 152 })).pipe(
115
- field(19, "Payment gateways used."),
116
- ),
117
- test: Schema.Boolean.pipe(field(20, "Whether the order is a test order.")),
118
- taxesIncluded: Schema.Boolean.pipe(field(21, "Whether prices include taxes.")),
119
- taxExempt: Schema.Boolean.pipe(field(22, "Whether the order is exempt from tax.")),
120
- dutiesIncluded: Schema.Boolean.pipe(field(23, "Whether prices include duties.")),
121
- estimatedTaxes: Schema.Boolean.pipe(field(24, "Whether taxes are estimates.")),
122
- totalWeight: Schema.NullOr(Schema.Int).pipe(field(25, "Total weight in grams.")),
148
+ id: Schema.String.pipe(Schema.annotateKey({ description: "Unique order identifier." })),
149
+ legacyResourceId: Schema.String.pipe(
150
+ Schema.annotateKey({ description: "Numeric order identifier stored as text." }),
151
+ ),
152
+ name: Schema.String.pipe(
153
+ Schema.annotateKey({ description: "Order name shown to the merchant." }),
154
+ ),
155
+ email: Schema.NullOr(Schema.String).pipe(
156
+ Schema.annotateKey({ description: "Email used for the order." }),
157
+ ),
158
+ phone: Schema.NullOr(Schema.String).pipe(
159
+ Schema.annotateKey({ description: "Phone used for the order." }),
160
+ ),
161
+ customerId: Schema.NullOr(Schema.String).pipe(
162
+ Schema.annotateKey({ description: "Customer identifier." }),
163
+ ),
164
+ customerLocale: Schema.NullOr(Schema.String).pipe(
165
+ Schema.annotateKey({ description: "Customer language." }),
166
+ ),
167
+ customerAcceptsMarketing: Schema.Boolean.pipe(
168
+ Schema.annotateKey({ description: "Whether the buyer accepts marketing." }),
169
+ ),
170
+ billingAddress: Schema.NullOr(address).pipe(
171
+ Schema.annotateKey({ description: "Billing address." }),
172
+ ),
173
+ shippingAddress: Schema.NullOr(address).pipe(
174
+ Schema.annotateKey({ description: "Shipping address." }),
175
+ ),
176
+ note: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Order note." })),
177
+ customAttributes: attributes.pipe(
178
+ Schema.annotateKey({ description: "Custom order attributes." }),
179
+ ),
180
+ tags: Schema.Array(Schema.String).pipe(
181
+ Schema.annotateKey({ description: "Tags added to the order." }),
182
+ ),
183
+ confirmationNumber: Schema.NullOr(Schema.String).pipe(
184
+ Schema.annotateKey({ description: "Confirmation number." }),
185
+ ),
186
+ poNumber: Schema.NullOr(Schema.String).pipe(
187
+ Schema.annotateKey({ description: "Purchase order number." }),
188
+ ),
189
+ sourceName: Schema.NullOr(Schema.String).pipe(
190
+ Schema.annotateKey({ description: "Channel that created the order." }),
191
+ ),
192
+ sourceIdentifier: Schema.NullOr(Schema.String).pipe(
193
+ Schema.annotateKey({ description: "Identifier from the source." }),
194
+ ),
195
+ appId: Schema.NullOr(Schema.String).pipe(
196
+ Schema.annotateKey({ description: "App that created the order." }),
197
+ ),
198
+ paymentGatewayNames: Schema.Array(Schema.String).pipe(
199
+ Schema.annotateKey({ description: "Payment gateways used." }),
200
+ ),
201
+ test: Schema.Boolean.pipe(
202
+ Schema.annotateKey({ description: "Whether the order is a test order." }),
203
+ ),
204
+ taxesIncluded: Schema.Boolean.pipe(
205
+ Schema.annotateKey({ description: "Whether prices include taxes." }),
206
+ ),
207
+ taxExempt: Schema.Boolean.pipe(
208
+ Schema.annotateKey({ description: "Whether the order is exempt from tax." }),
209
+ ),
210
+ dutiesIncluded: Schema.Boolean.pipe(
211
+ Schema.annotateKey({ description: "Whether prices include duties." }),
212
+ ),
213
+ estimatedTaxes: Schema.Boolean.pipe(
214
+ Schema.annotateKey({ description: "Whether taxes are estimates." }),
215
+ ),
216
+ totalWeight: Schema.NullOr(Schema.Int).pipe(
217
+ Schema.annotateKey({ description: "Total weight in grams." }),
218
+ ),
123
219
  displayFinancialStatus: Schema.NullOr(OrderFinancialStatusSchema).pipe(
124
- field(26, "Payment status of the order."),
220
+ Schema.annotateKey({ description: "Payment status of the order." }),
125
221
  ),
126
222
  cancelReason: Schema.NullOr(OrderCancelReasonSchema).pipe(
127
- field(27, "Reason the order was cancelled."),
128
- ),
129
- cancelledAt: Schema.NullOr(Schema.Date).pipe(field(28, "Time when the order was cancelled.")),
130
- closedAt: Schema.NullOr(Schema.Date).pipe(field(29, "Time when the order was closed.")),
131
- processedAt: Schema.Date.pipe(field(30, "Time when the order was processed.")),
132
- createdAt: Schema.Date.pipe(field(31, "Time when the order was created.")),
133
- updatedAt: Schema.Date.pipe(field(32, "Time when the order was last changed.")),
134
- currencyCode: Schema.String.pipe(field(33, "Shop currency code.")),
135
- presentmentCurrencyCode: Schema.String.pipe(field(34, "Customer currency code.")),
136
- discountCodes: Schema.Array(Schema.String.annotate({ fieldId: 151 })).pipe(
137
- field(35, "Discount codes used."),
138
- ),
139
- discountApplications: Schema.Array(DiscountApplicationSchema.annotate({ fieldId: 160 })).pipe(
140
- field(36, "Discounts applied to the order."),
141
- ),
142
- subtotalPriceSet: Schema.NullOr(moneyBag(200)).pipe(
143
- field(37, "Subtotal when the order was placed."),
144
- ),
145
- currentSubtotalPriceSet: moneyBag(210).pipe(field(38, "Subtotal after edits and refunds.")),
146
- totalDiscountsSet: Schema.NullOr(moneyBag(220)).pipe(
147
- field(39, "Discounts when the order was placed."),
148
- ),
149
- currentTotalDiscountsSet: moneyBag(230).pipe(field(40, "Discounts after edits and refunds.")),
150
- totalShippingPriceSet: moneyBag(240).pipe(field(41, "Shipping when the order was placed.")),
151
- currentShippingPriceSet: moneyBag(250).pipe(field(42, "Shipping after edits and refunds.")),
152
- totalTaxSet: Schema.NullOr(moneyBag(260)).pipe(field(43, "Tax when the order was placed.")),
153
- currentTotalTaxSet: moneyBag(270).pipe(field(44, "Tax after edits and refunds.")),
154
- originalTotalDutiesSet: Schema.NullOr(moneyBag(280)).pipe(
155
- field(45, "Duties when the order was placed."),
156
- ),
157
- currentTotalDutiesSet: Schema.NullOr(moneyBag(290)).pipe(
158
- field(46, "Duties after edits and refunds."),
159
- ),
160
- totalPriceSet: moneyBag(300).pipe(field(47, "Total when the order was placed.")),
161
- currentTotalPriceSet: moneyBag(310).pipe(field(48, "Total after edits and refunds.")),
162
- taxLines: taxLines(400).pipe(field(49, "Taxes when the order was placed.")),
163
- shippingLines: Schema.Array(ShippingLineSchema.annotate({ fieldId: 500 })).pipe(
164
- field(50, "Shipping lines, including removed ones."),
165
- ),
166
- lineItems: Schema.Array(OrderLineItemSchema.annotate({ fieldId: 600 })).pipe(
167
- field(51, "Line items in the order."),
168
- ),
169
- _deleted: Schema.optional(Schema.Boolean).pipe(field(52, "Whether the order was deleted.")),
223
+ Schema.annotateKey({ description: "Reason the order was cancelled." }),
224
+ ),
225
+ cancelledAt: Schema.NullOr(Schema.Date).pipe(
226
+ Schema.annotateKey({ description: "Time when the order was cancelled." }),
227
+ ),
228
+ closedAt: Schema.NullOr(Schema.Date).pipe(
229
+ Schema.annotateKey({ description: "Time when the order was closed." }),
230
+ ),
231
+ processedAt: Schema.Date.pipe(
232
+ Schema.annotateKey({ description: "Time when the order was processed." }),
233
+ ),
234
+ createdAt: Schema.Date.pipe(
235
+ Schema.annotateKey({ description: "Time when the order was created." }),
236
+ ),
237
+ updatedAt: Schema.Date.pipe(
238
+ Schema.annotateKey({ description: "Time when the order was last changed." }),
239
+ ),
240
+ currencyCode: Schema.String.pipe(Schema.annotateKey({ description: "Shop currency code." })),
241
+ presentmentCurrencyCode: Schema.String.pipe(
242
+ Schema.annotateKey({ description: "Customer currency code." }),
243
+ ),
244
+ discountCodes: Schema.Array(Schema.String).pipe(
245
+ Schema.annotateKey({ description: "Discount codes used." }),
246
+ ),
247
+ discountApplications: Schema.Array(DiscountApplicationSchema).pipe(
248
+ Schema.annotateKey({ description: "Discounts applied to the order." }),
249
+ ),
250
+ subtotalPriceSet: Schema.NullOr(moneyBag).pipe(
251
+ Schema.annotateKey({ description: "Subtotal when the order was placed." }),
252
+ ),
253
+ currentSubtotalPriceSet: moneyBag.pipe(
254
+ Schema.annotateKey({ description: "Subtotal after edits and refunds." }),
255
+ ),
256
+ totalDiscountsSet: Schema.NullOr(moneyBag).pipe(
257
+ Schema.annotateKey({ description: "Discounts when the order was placed." }),
258
+ ),
259
+ currentTotalDiscountsSet: moneyBag.pipe(
260
+ Schema.annotateKey({ description: "Discounts after edits and refunds." }),
261
+ ),
262
+ totalShippingPriceSet: moneyBag.pipe(
263
+ Schema.annotateKey({ description: "Shipping when the order was placed." }),
264
+ ),
265
+ currentShippingPriceSet: moneyBag.pipe(
266
+ Schema.annotateKey({ description: "Shipping after edits and refunds." }),
267
+ ),
268
+ totalTaxSet: Schema.NullOr(moneyBag).pipe(
269
+ Schema.annotateKey({ description: "Tax when the order was placed." }),
270
+ ),
271
+ currentTotalTaxSet: moneyBag.pipe(
272
+ Schema.annotateKey({ description: "Tax after edits and refunds." }),
273
+ ),
274
+ originalTotalDutiesSet: Schema.NullOr(moneyBag).pipe(
275
+ Schema.annotateKey({ description: "Duties when the order was placed." }),
276
+ ),
277
+ currentTotalDutiesSet: Schema.NullOr(moneyBag).pipe(
278
+ Schema.annotateKey({ description: "Duties after edits and refunds." }),
279
+ ),
280
+ totalPriceSet: moneyBag.pipe(
281
+ Schema.annotateKey({ description: "Total when the order was placed." }),
282
+ ),
283
+ currentTotalPriceSet: moneyBag.pipe(
284
+ Schema.annotateKey({ description: "Total after edits and refunds." }),
285
+ ),
286
+ taxLines: taxLines.pipe(Schema.annotateKey({ description: "Taxes when the order was placed." })),
287
+ shippingLines: Schema.Array(ShippingLineSchema).pipe(
288
+ Schema.annotateKey({ description: "Shipping lines, including removed ones." }),
289
+ ),
290
+ lineItems: Schema.Array(OrderLineItemSchema).pipe(
291
+ Schema.annotateKey({ description: "Line items in the order." }),
292
+ ),
293
+ _deleted: Schema.optional(Schema.Boolean).pipe(
294
+ Schema.annotateKey({ description: "Whether the order was deleted." }),
295
+ ),
170
296
  })
171
297
  .annotate({
172
298
  description: "Orders in a Shopify store.",
package/src/resources/products/row.ts CHANGED
@@ -1,76 +1,106 @@
1
1
  import { Iceberg } from "@useairfoil/connector-kit";
2
2
  import * as Schema from "effect/Schema";
3
3
 
4
- import { field } from "../shared";
5
-
6
4
  export const ProductStatusSchema = Schema.Literals(["ACTIVE", "ARCHIVED", "DRAFT", "UNLISTED"]);
7
5
 
8
6
  export const ProductVariantInventoryPolicySchema = Schema.Literals(["CONTINUE", "DENY"]);
9
7
 
10
8
  const ProductImageSchema = Schema.Struct({
11
- url: Schema.String.pipe(field(202, "URL of the image.")),
12
- altText: Schema.NullOr(Schema.String).pipe(field(203, "Alternative text for the image.")),
9
+ url: Schema.String.pipe(Schema.annotateKey({ description: "URL of the image." })),
10
+ altText: Schema.NullOr(Schema.String).pipe(
11
+ Schema.annotateKey({ description: "Alternative text for the image." }),
12
+ ),
13
13
  });
14
14
 
15
15
  export const ProductFeaturedMediaSchema = Schema.Struct({
16
- image: Schema.NullOr(ProductImageSchema).pipe(field(201, "Image for the featured media.")),
16
+ image: Schema.NullOr(ProductImageSchema).pipe(
17
+ Schema.annotateKey({ description: "Image for the featured media." }),
18
+ ),
17
19
  });
18
20
 
19
21
  export const ProductOptionSchema = Schema.Struct({
20
- id: Schema.String.pipe(field(302, "Unique product option identifier.")),
21
- name: Schema.String.pipe(field(303, "Name of the product option.")),
22
- position: Schema.Int.pipe(field(304, "Position of the option on the product.")),
23
- values: Schema.Array(Schema.String.annotate({ fieldId: 306 })).pipe(
24
- field(305, "Values available for the option."),
22
+ id: Schema.String.pipe(Schema.annotateKey({ description: "Unique product option identifier." })),
23
+ name: Schema.String.pipe(Schema.annotateKey({ description: "Name of the product option." })),
24
+ position: Schema.Int.pipe(
25
+ Schema.annotateKey({ description: "Position of the option on the product." }),
26
+ ),
27
+ values: Schema.Array(Schema.String).pipe(
28
+ Schema.annotateKey({ description: "Values available for the option." }),
25
29
  ),
26
30
  });
27
31
 
28
32
  export const ProductVariantSchema = Schema.Struct({
29
- id: Schema.String.pipe(field(402, "Unique product variant identifier.")),
30
- legacyResourceId: Schema.String.pipe(field(403, "Numeric variant identifier stored as text.")),
31
- title: Schema.String.pipe(field(404, "Display title of the variant.")),
32
- sku: Schema.NullOr(Schema.String).pipe(field(405, "Stock keeping unit for the variant.")),
33
- barcode: Schema.NullOr(Schema.String).pipe(field(406, "Barcode for the variant.")),
34
- price: Schema.String.pipe(field(407, "Price of the variant.")),
33
+ id: Schema.String.pipe(Schema.annotateKey({ description: "Unique product variant identifier." })),
34
+ legacyResourceId: Schema.String.pipe(
35
+ Schema.annotateKey({ description: "Numeric variant identifier stored as text." }),
36
+ ),
37
+ title: Schema.String.pipe(Schema.annotateKey({ description: "Display title of the variant." })),
38
+ sku: Schema.NullOr(Schema.String).pipe(
39
+ Schema.annotateKey({ description: "Stock keeping unit for the variant." }),
40
+ ),
41
+ barcode: Schema.NullOr(Schema.String).pipe(
42
+ Schema.annotateKey({ description: "Barcode for the variant." }),
43
+ ),
44
+ price: Schema.String.pipe(Schema.annotateKey({ description: "Price of the variant." })),
35
45
  compareAtPrice: Schema.NullOr(Schema.String).pipe(
36
- field(408, "Original price used for comparison."),
46
+ Schema.annotateKey({ description: "Original price used for comparison." }),
37
47
  ),
38
48
  inventoryPolicy: ProductVariantInventoryPolicySchema.pipe(
39
- field(409, "Behavior when the variant is out of stock."),
49
+ Schema.annotateKey({ description: "Behavior when the variant is out of stock." }),
50
+ ),
51
+ taxable: Schema.Boolean.pipe(
52
+ Schema.annotateKey({ description: "Whether the variant is taxable." }),
53
+ ),
54
+ createdAt: Schema.Date.pipe(
55
+ Schema.annotateKey({ description: "Time when the variant was created." }),
56
+ ),
57
+ updatedAt: Schema.Date.pipe(
58
+ Schema.annotateKey({ description: "Time when the variant was last changed." }),
40
59
  ),
41
- taxable: Schema.Boolean.pipe(field(410, "Whether the variant is taxable.")),
42
- createdAt: Schema.Date.pipe(field(411, "Time when the variant was created.")),
43
- updatedAt: Schema.Date.pipe(field(412, "Time when the variant was last changed.")),
44
60
  });
45
61
 
46
62
  export const ProductSchema = Schema.Struct({
47
- id: Schema.String.pipe(field(1, "Unique product identifier.")),
48
- legacyResourceId: Schema.String.pipe(field(2, "Numeric product identifier stored as text.")),
49
- title: Schema.String.pipe(field(3, "Title of the product.")),
50
- handle: Schema.String.pipe(field(4, "URL handle for the product.")),
51
- descriptionHtml: Schema.String.pipe(field(5, "Product description as HTML.")),
52
- productType: Schema.String.pipe(field(6, "Merchant-defined product type.")),
53
- vendor: Schema.String.pipe(field(7, "Vendor of the product.")),
54
- status: ProductStatusSchema.pipe(field(8, "Current product status.")),
55
- tags: Schema.Array(Schema.String.annotate({ fieldId: 101 })).pipe(
56
- field(9, "Tags added to the product."),
57
- ),
58
- createdAt: Schema.Date.pipe(field(10, "Time when the product was created.")),
59
- updatedAt: Schema.Date.pipe(field(11, "Time when the product was last changed.")),
60
- publishedAt: Schema.NullOr(Schema.Date).pipe(field(12, "Time when the product was published.")),
63
+ id: Schema.String.pipe(Schema.annotateKey({ description: "Unique product identifier." })),
64
+ legacyResourceId: Schema.String.pipe(
65
+ Schema.annotateKey({ description: "Numeric product identifier stored as text." }),
66
+ ),
67
+ title: Schema.String.pipe(Schema.annotateKey({ description: "Title of the product." })),
68
+ handle: Schema.String.pipe(Schema.annotateKey({ description: "URL handle for the product." })),
69
+ descriptionHtml: Schema.String.pipe(
70
+ Schema.annotateKey({ description: "Product description as HTML." }),
71
+ ),
72
+ productType: Schema.String.pipe(
73
+ Schema.annotateKey({ description: "Merchant-defined product type." }),
74
+ ),
75
+ vendor: Schema.String.pipe(Schema.annotateKey({ description: "Vendor of the product." })),
76
+ status: ProductStatusSchema.pipe(Schema.annotateKey({ description: "Current product status." })),
77
+ tags: Schema.Array(Schema.String).pipe(
78
+ Schema.annotateKey({ description: "Tags added to the product." }),
79
+ ),
80
+ createdAt: Schema.Date.pipe(
81
+ Schema.annotateKey({ description: "Time when the product was created." }),
82
+ ),
83
+ updatedAt: Schema.Date.pipe(
84
+ Schema.annotateKey({ description: "Time when the product was last changed." }),
85
+ ),
86
+ publishedAt: Schema.NullOr(Schema.Date).pipe(
87
+ Schema.annotateKey({ description: "Time when the product was published." }),
88
+ ),
61
89
  templateSuffix: Schema.NullOr(Schema.String).pipe(
62
- field(13, "Theme template suffix used by the product."),
90
+ Schema.annotateKey({ description: "Theme template suffix used by the product." }),
63
91
  ),
64
92
  featuredMedia: Schema.NullOr(ProductFeaturedMediaSchema).pipe(
65
- field(14, "Featured media for the product."),
93
+ Schema.annotateKey({ description: "Featured media for the product." }),
94
+ ),
95
+ options: Schema.Array(ProductOptionSchema).pipe(
96
+ Schema.annotateKey({ description: "Options for the product." }),
66
97
  ),
67
- options: Schema.Array(ProductOptionSchema.annotate({ fieldId: 301 })).pipe(
68
- field(15, "Options for the product."),
98
+ variants: Schema.Array(ProductVariantSchema).pipe(
99
+ Schema.annotateKey({ description: "Variants of the product." }),
69
100
  ),
70
- variants: Schema.Array(ProductVariantSchema.annotate({ fieldId: 401 })).pipe(
71
- field(16, "Variants of the product."),
101
+ _deleted: Schema.optional(Schema.Boolean).pipe(
102
+ Schema.annotateKey({ description: "Whether the product was deleted." }),
72
103
  ),
73
- _deleted: Schema.optional(Schema.Boolean).pipe(field(17, "Whether the product was deleted.")),
74
104
  })
75
105
  .annotate({
76
106
  description: "Products in a Shopify store.",