@useairfoil/producer-shopify 0.2.1 → 0.2.2

package/src/resources/refunds/row.ts

@@ -1,7 +1,7 @@
 import { Iceberg } from "@useairfoil/connector-kit";
 import * as Schema from "effect/Schema";
 
-import { field, moneyBag } from "../shared";
+import { moneyBag } from "../shared";
 
 export const TransactionKindSchema = Schema.Literals([
   "SALE",
@@ -31,63 +31,103 @@ export const RestockTypeSchema = Schema.Literals([
 ]);
 
 export const RefundSchema = Schema.Struct({
-  id: Schema.String.pipe(field(1, "Unique refund identifier.")),
-  legacyResourceId: Schema.String.pipe(field(2, "Numeric refund identifier stored as text.")),
-  orderId: Schema.String.pipe(field(3, "Refunded order identifier.")),
-  note: Schema.NullOr(Schema.String).pipe(field(4, "Refund note.")),
-  createdAt: Schema.NullOr(Schema.Date).pipe(field(5, "Time when the refund was created.")),
-  processedAt: Schema.Date.pipe(field(6, "Time when the refund was processed.")),
+  id: Schema.String.pipe(Schema.annotateKey({ description: "Unique refund identifier." })),
+  legacyResourceId: Schema.String.pipe(
+    Schema.annotateKey({ description: "Numeric refund identifier stored as text." }),
+  ),
+  orderId: Schema.String.pipe(Schema.annotateKey({ description: "Refunded order identifier." })),
+  note: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Refund note." })),
+  createdAt: Schema.NullOr(Schema.Date).pipe(
+    Schema.annotateKey({ description: "Time when the refund was created." }),
+  ),
+  processedAt: Schema.Date.pipe(
+    Schema.annotateKey({ description: "Time when the refund was processed." }),
+  ),
   transactions: Schema.Array(
     Schema.Struct({
-      id: Schema.String.pipe(field(101, "Unique transaction identifier.")),
-      kind: TransactionKindSchema.pipe(field(102, "Kind of transaction.")),
-      status: TransactionStatusSchema.pipe(field(103, "Status reported for the transaction.")),
-      amount: Schema.String.pipe(field(104, "Amount in the customer currency.")),
-      currencyCode: Schema.String.pipe(field(105, "Customer currency code.")),
-      gateway: Schema.NullOr(Schema.String).pipe(field(106, "Payment gateway.")),
-      test: Schema.Boolean.pipe(field(107, "Whether the transaction is a test.")),
-      errorCode: Schema.NullOr(Schema.String).pipe(field(108, "Gateway error code.")),
+      id: Schema.String.pipe(Schema.annotateKey({ description: "Unique transaction identifier." })),
+      kind: TransactionKindSchema.pipe(Schema.annotateKey({ description: "Kind of transaction." })),
+      status: TransactionStatusSchema.pipe(
+        Schema.annotateKey({ description: "Status reported for the transaction." }),
+      ),
+      amount: Schema.String.pipe(
+        Schema.annotateKey({ description: "Amount in the customer currency." }),
+      ),
+      currencyCode: Schema.String.pipe(
+        Schema.annotateKey({ description: "Customer currency code." }),
+      ),
+      gateway: Schema.NullOr(Schema.String).pipe(
+        Schema.annotateKey({ description: "Payment gateway." }),
+      ),
+      test: Schema.Boolean.pipe(
+        Schema.annotateKey({ description: "Whether the transaction is a test." }),
+      ),
+      errorCode: Schema.NullOr(Schema.String).pipe(
+        Schema.annotateKey({ description: "Gateway error code." }),
+      ),
       parentTransactionId: Schema.NullOr(Schema.String).pipe(
-        field(109, "Transaction this one refunds."),
+        Schema.annotateKey({ description: "Transaction this one refunds." }),
+      ),
+      createdAt: Schema.Date.pipe(
+        Schema.annotateKey({ description: "Time when the transaction was created." }),
       ),
-      createdAt: Schema.Date.pipe(field(110, "Time when the transaction was created.")),
       processedAt: Schema.NullOr(Schema.Date).pipe(
-        field(111, "Time when the transaction was processed."),
+        Schema.annotateKey({ description: "Time when the transaction was processed." }),
       ),
-    }).annotate({ fieldId: 100 }),
-  ).pipe(field(7, "Transactions that move the refunded money.")),
+    }),
+  ).pipe(Schema.annotateKey({ description: "Transactions that move the refunded money." })),
   refundLineItems: Schema.Array(
     Schema.Struct({
-      id: Schema.NullOr(Schema.String).pipe(field(201, "Unique refund line item identifier.")),
-      lineItemId: Schema.String.pipe(field(202, "Refunded order line item identifier.")),
-      quantity: Schema.Int.pipe(field(203, "Quantity refunded.")),
-      restockType: RestockTypeSchema.pipe(field(204, "How the items were restocked.")),
-      locationId: Schema.NullOr(Schema.String).pipe(field(205, "Restock location identifier.")),
-      subtotalSet: moneyBag(210).pipe(field(206, "Refunded subtotal.")),
-      totalTaxSet: moneyBag(220).pipe(field(207, "Refunded tax.")),
-    }).annotate({ fieldId: 200 }),
-  ).pipe(field(8, "Refunded order line items.")),
+      id: Schema.NullOr(Schema.String).pipe(
+        Schema.annotateKey({ description: "Unique refund line item identifier." }),
+      ),
+      lineItemId: Schema.String.pipe(
+        Schema.annotateKey({ description: "Refunded order line item identifier." }),
+      ),
+      quantity: Schema.Int.pipe(Schema.annotateKey({ description: "Quantity refunded." })),
+      restockType: RestockTypeSchema.pipe(
+        Schema.annotateKey({ description: "How the items were restocked." }),
+      ),
+      locationId: Schema.NullOr(Schema.String).pipe(
+        Schema.annotateKey({ description: "Restock location identifier." }),
+      ),
+      subtotalSet: moneyBag.pipe(Schema.annotateKey({ description: "Refunded subtotal." })),
+      totalTaxSet: moneyBag.pipe(Schema.annotateKey({ description: "Refunded tax." })),
+    }),
+  ).pipe(Schema.annotateKey({ description: "Refunded order line items." })),
   refundShippingLines: Schema.Array(
     Schema.Struct({
-      id: Schema.String.pipe(field(301, "Unique refund shipping line identifier.")),
-      shippingLineId: Schema.NullOr(Schema.String).pipe(field(302, "Refunded shipping line.")),
-      subtotalAmountSet: moneyBag(310).pipe(field(303, "Refunded shipping amount.")),
-    }).annotate({ fieldId: 300 }),
-  ).pipe(field(9, "Refunded shipping.")),
+      id: Schema.String.pipe(
+        Schema.annotateKey({ description: "Unique refund shipping line identifier." }),
+      ),
+      shippingLineId: Schema.NullOr(Schema.String).pipe(
+        Schema.annotateKey({ description: "Refunded shipping line." }),
+      ),
+      subtotalAmountSet: moneyBag.pipe(
+        Schema.annotateKey({ description: "Refunded shipping amount." }),
+      ),
+    }),
+  ).pipe(Schema.annotateKey({ description: "Refunded shipping." })),
   orderAdjustments: Schema.Array(
     Schema.Struct({
-      id: Schema.String.pipe(field(401, "Unique order adjustment identifier.")),
-      reason: Schema.NullOr(Schema.String).pipe(field(402, "Reason for the adjustment.")),
-      amountSet: moneyBag(410).pipe(field(403, "Adjustment amount.")),
-      taxAmountSet: moneyBag(420).pipe(field(404, "Tax on the adjustment.")),
-    }).annotate({ fieldId: 400 }),
-  ).pipe(field(10, "Refund discrepancy adjustments.")),
+      id: Schema.String.pipe(
+        Schema.annotateKey({ description: "Unique order adjustment identifier." }),
+      ),
+      reason: Schema.NullOr(Schema.String).pipe(
+        Schema.annotateKey({ description: "Reason for the adjustment." }),
+      ),
+      amountSet: moneyBag.pipe(Schema.annotateKey({ description: "Adjustment amount." })),
+      taxAmountSet: moneyBag.pipe(Schema.annotateKey({ description: "Tax on the adjustment." })),
+    }),
+  ).pipe(Schema.annotateKey({ description: "Refund discrepancy adjustments." })),
   duties: Schema.Array(
     Schema.Struct({
-      dutyId: Schema.NullOr(Schema.String).pipe(field(501, "Refunded duty identifier.")),
-      amountSet: moneyBag(510).pipe(field(502, "Refunded duty amount.")),
-    }).annotate({ fieldId: 500 }),
-  ).pipe(field(11, "Refunded duties.")),
+      dutyId: Schema.NullOr(Schema.String).pipe(
+        Schema.annotateKey({ description: "Refunded duty identifier." }),
+      ),
+      amountSet: moneyBag.pipe(Schema.annotateKey({ description: "Refunded duty amount." })),
+    }),
+  ).pipe(Schema.annotateKey({ description: "Refunded duties." })),
 })
   .annotate({
     description: "Refunds on orders in a Shopify store.",

package/src/resources/shared.ts

@@ -1,10 +1,6 @@
-import { Iceberg } from "@useairfoil/connector-kit";
 import { SchemaTransformation } from "effect";
 import * as Schema from "effect/Schema";
 
-export const field = (fieldId: number, description: string) =>
-  Iceberg.field(fieldId, { description });
-
 export const PageInfoSchema = Schema.Struct({
   hasNextPage: Schema.Boolean,
   endCursor: Schema.NullOr(Schema.String),
@@ -23,75 +19,86 @@ export const splitTags = (value: string): ReadonlyArray<string> =>
     .map((tag) => tag.trim())
     .filter((tag) => tag.length > 0);
 
-// Each row helper takes the first field ID of its block.
+export const moneyBag = Schema.Struct({
+  shopMoney: Schema.Struct({
+    amount: Schema.String.pipe(Schema.annotateKey({ description: "Amount in the shop currency." })),
+    currencyCode: Schema.String.pipe(Schema.annotateKey({ description: "Shop currency code." })),
+  }).pipe(Schema.annotateKey({ description: "Amount in the shop currency." })),
+  presentmentMoney: Schema.Struct({
+    amount: Schema.String.pipe(
+      Schema.annotateKey({ description: "Amount in the customer currency." }),
+    ),
+    currencyCode: Schema.String.pipe(
+      Schema.annotateKey({ description: "Customer currency code." }),
+    ),
+  }).pipe(Schema.annotateKey({ description: "Amount in the customer currency." })),
+});
+
+export const address = Schema.Struct({
+  firstName: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "First name." })),
+  lastName: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Last name." })),
+  name: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Full name." })),
+  company: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Company name." })),
+  address1: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "First address line." }),
+  ),
+  address2: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Second address line." }),
+  ),
+  city: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "City." })),
+  province: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Province or state." }),
+  ),
+  provinceCode: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Province or state code." }),
+  ),
+  country: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Country." })),
+  countryCode: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Two-letter country code." }),
+  ),
+  zip: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Postal code." })),
+  phone: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Phone number." })),
+  latitude: Schema.NullOr(Schema.Finite).pipe(Schema.annotateKey({ description: "Latitude." })),
+  longitude: Schema.NullOr(Schema.Finite).pipe(Schema.annotateKey({ description: "Longitude." })),
+});
 
-export const moneyBag = (baseId: number) =>
+export const attributes = Schema.Array(
   Schema.Struct({
-    shopMoney: Schema.Struct({
-      amount: Schema.String.pipe(field(baseId + 3, "Amount in the shop currency.")),
-      currencyCode: Schema.String.pipe(field(baseId + 4, "Shop currency code.")),
-    }).pipe(field(baseId + 1, "Amount in the shop currency.")),
-    presentmentMoney: Schema.Struct({
-      amount: Schema.String.pipe(field(baseId + 5, "Amount in the customer currency.")),
-      currencyCode: Schema.String.pipe(field(baseId + 6, "Customer currency code.")),
-    }).pipe(field(baseId + 2, "Amount in the customer currency.")),
-  });
-
-export const address = (baseId: number) =>
+    key: Schema.String.pipe(Schema.annotateKey({ description: "Attribute name." })),
+    value: Schema.NullOr(Schema.String).pipe(
+      Schema.annotateKey({ description: "Attribute value." }),
+    ),
+  }),
+);
+
+export const taxLines = Schema.Array(
   Schema.Struct({
-    firstName: Schema.NullOr(Schema.String).pipe(field(baseId + 1, "First name.")),
-    lastName: Schema.NullOr(Schema.String).pipe(field(baseId + 2, "Last name.")),
-    name: Schema.NullOr(Schema.String).pipe(field(baseId + 3, "Full name.")),
-    company: Schema.NullOr(Schema.String).pipe(field(baseId + 4, "Company name.")),
-    address1: Schema.NullOr(Schema.String).pipe(field(baseId + 5, "First address line.")),
-    address2: Schema.NullOr(Schema.String).pipe(field(baseId + 6, "Second address line.")),
-    city: Schema.NullOr(Schema.String).pipe(field(baseId + 7, "City.")),
-    province: Schema.NullOr(Schema.String).pipe(field(baseId + 8, "Province or state.")),
-    provinceCode: Schema.NullOr(Schema.String).pipe(field(baseId + 9, "Province or state code.")),
-    country: Schema.NullOr(Schema.String).pipe(field(baseId + 10, "Country.")),
-    countryCode: Schema.NullOr(Schema.String).pipe(field(baseId + 11, "Two-letter country code.")),
-    zip: Schema.NullOr(Schema.String).pipe(field(baseId + 12, "Postal code.")),
-    phone: Schema.NullOr(Schema.String).pipe(field(baseId + 13, "Phone number.")),
-    latitude: Schema.NullOr(Schema.Finite).pipe(field(baseId + 14, "Latitude.")),
-    longitude: Schema.NullOr(Schema.Finite).pipe(field(baseId + 15, "Longitude.")),
-  });
-
-export const attributes = (baseId: number) =>
-  Schema.Array(
-    Schema.Struct({
-      key: Schema.String.pipe(field(baseId + 2, "Attribute name.")),
-      value: Schema.NullOr(Schema.String).pipe(field(baseId + 3, "Attribute value.")),
-    }).annotate({ fieldId: baseId + 1 }),
-  );
-
-export const taxLines = (baseId: number) =>
-  Schema.Array(
-    Schema.Struct({
-      title: Schema.String.pipe(field(baseId + 2, "Tax name.")),
-      rate: Schema.NullOr(Schema.Finite).pipe(field(baseId + 3, "Tax rate as a fraction.")),
-      priceSet: moneyBag(baseId + 10).pipe(field(baseId + 4, "Tax amount.")),
-    }).annotate({ fieldId: baseId + 1 }),
-  );
-
-export const discountAllocations = (baseId: number) =>
-  Schema.Array(
-    Schema.Struct({
-      discountApplicationIndex: Schema.Int.pipe(
-        field(baseId + 2, "Index of the order discount application."),
-      ),
-      amountSet: moneyBag(baseId + 10).pipe(field(baseId + 3, "Allocated discount amount.")),
-    }).annotate({ fieldId: baseId + 1 }),
-  );
-
-export type MoneyBag = Schema.Schema.Type<ReturnType<typeof moneyBag>>;
-
-export type Address = Schema.Schema.Type<ReturnType<typeof address>>;
-
-export type Attribute = Schema.Schema.Type<ReturnType<typeof attributes>>[number];
-
-export type TaxLine = Schema.Schema.Type<ReturnType<typeof taxLines>>[number];
-
-export type DiscountAllocation = Schema.Schema.Type<ReturnType<typeof discountAllocations>>[number];
+    title: Schema.String.pipe(Schema.annotateKey({ description: "Tax name." })),
+    rate: Schema.NullOr(Schema.Finite).pipe(
+      Schema.annotateKey({ description: "Tax rate as a fraction." }),
+    ),
+    priceSet: moneyBag.pipe(Schema.annotateKey({ description: "Tax amount." })),
+  }),
+);
+
+export const discountAllocations = Schema.Array(
+  Schema.Struct({
+    discountApplicationIndex: Schema.Int.pipe(
+      Schema.annotateKey({ description: "Index of the order discount application." }),
+    ),
+    amountSet: moneyBag.pipe(Schema.annotateKey({ description: "Allocated discount amount." })),
+  }),
+);
+
+export type MoneyBag = Schema.Schema.Type<typeof moneyBag>;
+
+export type Address = Schema.Schema.Type<typeof address>;
+
+export type Attribute = Schema.Schema.Type<typeof attributes>[number];
+
+export type TaxLine = Schema.Schema.Type<typeof taxLines>[number];
+
+export type DiscountAllocation = Schema.Schema.Type<typeof discountAllocations>[number];
 
 export const RestMoneyBagSchema = Schema.Struct({
   shop_money: Schema.Struct({ amount: Schema.String, currency_code: Schema.String }),

package/src/start.ts

@@ -33,7 +33,7 @@ export const startCommand = Command.make("start", {}, () =>
     const entrypoint = yield* ShopifyConnector.ShopifyConnector;
 
     return yield* ConnectorApp.start(entrypoint, { port }).pipe(
-      Effect.provide(Ingestor.layerWingsConfig(entrypoint)),
+      Effect.provide(Ingestor.layerArrowFlightConfig(entrypoint)),
     );
   }).pipe(
     Effect.annotateLogs({ component: "producer-shopify" }),
@@ -47,4 +47,4 @@ export const startCommand = Command.make("start", {}, () =>
     ),
     Effect.provide(RuntimeConfig.layerHosted()),
   ),
-).pipe(Command.withDescription("Run the production connector against Wings"));
+).pipe(Command.withDescription("Run the connector"));