@ehrenkind/shopify-lib 0.6.1 → 0.7.1

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.
package/dist/index.d.cts CHANGED
@@ -1531,9 +1531,11 @@ declare enum CatalogStatus {
1531
1531
  Draft = "DRAFT"
1532
1532
  }
1533
1533
  /**
1534
- * An authenticated link to an external platform that supports syndication and optionally order ingestion, such as Facebook, Pinterest, an online store, or Point of Sale (POS).
1534
+ * A connection between a Shopify shop and an external selling platform that supports product syndication and optionally order ingestion. Each channel binds a merchant's account on a specific platform — such as Amazon, eBay, Google, or a point-of-sale system — to the shop, establishing the publishing destination for product feeds.
1535
1535
  *
1536
- * Each channel provides access to its underlying [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App), published products and collections, and [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) settings, as well as what features of the platform it supports such as [scheduled publishing](https://shopify.dev/docs/apps/build/sales-channels/scheduled-product-publishing). Use channels to manage where catalog items appear, track publication status across platforms, and control [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) visibility for different customer touchpoints.
1536
+ * Sales Channel applications use [`channelCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/channelCreate) to establish channels after merchant authentication, and can manage multiple channel connections per app. Each channel is bound to a channel specification that declares the platform's regional coverage, capabilities, and requirements.
1537
+ *
1538
+ * Use channels to manage where catalog items are syndicated, track publication status across platforms, and control [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) visibility for different selling destinations.
1537
1539
  */
1538
1540
  type Channel = Node & {
1539
1541
  __typename?: 'Channel';
@@ -1543,7 +1545,7 @@ type Channel = Node & {
1543
1545
  collectionPublicationsV3: ResourcePublicationConnection;
1544
1546
  /** The list of collections published to the channel. */
1545
1547
  collections: CollectionConnection;
1546
- /** The unique identifier for the channel. */
1548
+ /** A unique, human-readable identifier for the channel within the shop. Set during [`channelCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/channelCreate) or auto-generated from the specification handle and account ID. Use with [`channelByHandle`](https://shopify.dev/docs/api/admin-graphql/latest/queries/channelByHandle) for lookups. */
1547
1549
  handle: Scalars['String']['output'];
1548
1550
  /** Whether the collection is available to the channel. */
1549
1551
  hasCollection: Scalars['Boolean']['output'];
@@ -17645,6 +17647,8 @@ declare enum ShopifyPaymentsTransactionType {
17645
17647
  ApplicationFeeRefund = "APPLICATION_FEE_REFUND",
17646
17648
  /** The balance_transfer_inbound transaction type. */
17647
17649
  BalanceTransferInbound = "BALANCE_TRANSFER_INBOUND",
17650
+ /** The balance_transfer_outbound transaction type. */
17651
+ BalanceTransferOutbound = "BALANCE_TRANSFER_OUTBOUND",
17648
17652
  /** The billing_debit transaction type. */
17649
17653
  BillingDebit = "BILLING_DEBIT",
17650
17654
  /** The billing_debit_reversal transaction type. */
@@ -19977,6 +19981,7 @@ type OrderByIdFullQuery = {
19977
19981
  shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
19978
19982
  };
19979
19983
  image?: Maybe<Pick<Image, 'url' | 'width' | 'height' | 'altText'>>;
19984
+ lineItemGroup?: Maybe<Pick<LineItemGroup, 'id' | 'title' | 'quantity' | 'variantSku'>>;
19980
19985
  });
19981
19986
  }>;
19982
19987
  };
@@ -20175,7 +20180,7 @@ type AllProductVariantsQuery = {
20175
20180
  productVariants: {
20176
20181
  edges: Array<{
20177
20182
  node: (Pick<ProductVariant$1, 'id' | 'legacyResourceId' | 'sku' | 'barcode' | 'inventoryQuantity' | 'price' | 'title'> & {
20178
- product: (Pick<Product, 'status' | 'title' | 'description' | 'handle' | 'onlineStoreUrl'> & {
20183
+ product: (Pick<Product, 'status' | 'title' | 'description' | 'handle' | 'onlineStoreUrl' | 'combinedListingRole'> & {
20179
20184
  featuredImage?: Maybe<Pick<Image, 'url'>>;
20180
20185
  });
20181
20186
  });
@@ -20256,7 +20261,7 @@ interface GeneratedQueryTypes {
20256
20261
  return: OrderByIdQuery;
20257
20262
  variables: OrderByIdQueryVariables;
20258
20263
  };
20259
- "#graphql\n query orderByIdFull($id: ID!) {\n order(id: $id) {\n id\n name\n createdAt\n updatedAt\n processedAt\n closedAt\n cancelledAt\n cancelReason\n totalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n customer {\n id\n firstName\n lastName\n email\n phone\n }\n displayFinancialStatus\n displayFulfillmentStatus\n shippingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n billingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n lineItems(first: 100) {\n edges {\n node {\n id\n sku\n title\n variantTitle\n quantity\n customAttributes {\n key\n value\n }\n originalUnitPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n vendor\n image {\n url\n width\n height\n altText\n }\n }\n }\n }\n fulfillments {\n id\n name\n totalQuantity\n status\n createdAt\n estimatedDeliveryAt\n deliveredAt\n trackingInfo {\n company\n number\n url\n }\n fulfillmentLineItems(first: 100) {\n edges {\n node {\n id\n quantity\n lineItem {\n id\n sku\n }\n }\n }\n }\n }\n shippingLine {\n originalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n taxLines {\n priceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n totalDiscountsSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n discountCodes\n refunds {\n totalRefundedSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n }\n }\n": {
20264
+ "#graphql\n query orderByIdFull($id: ID!) {\n order(id: $id) {\n id\n name\n createdAt\n updatedAt\n processedAt\n closedAt\n cancelledAt\n cancelReason\n totalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n customer {\n id\n firstName\n lastName\n email\n phone\n }\n displayFinancialStatus\n displayFulfillmentStatus\n shippingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n billingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n lineItems(first: 100) {\n edges {\n node {\n id\n sku\n title\n variantTitle\n quantity\n customAttributes {\n key\n value\n }\n originalUnitPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n vendor\n image {\n url\n width\n height\n altText\n }\n lineItemGroup {\n id\n title\n quantity\n variantSku\n }\n }\n }\n }\n fulfillments {\n id\n name\n totalQuantity\n status\n createdAt\n estimatedDeliveryAt\n deliveredAt\n trackingInfo {\n company\n number\n url\n }\n fulfillmentLineItems(first: 100) {\n edges {\n node {\n id\n quantity\n lineItem {\n id\n sku\n }\n }\n }\n }\n }\n shippingLine {\n originalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n taxLines {\n priceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n totalDiscountsSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n discountCodes\n refunds {\n totalRefundedSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n }\n }\n": {
20260
20265
  return: OrderByIdFullQuery;
20261
20266
  variables: OrderByIdFullQueryVariables;
20262
20267
  };
@@ -20280,7 +20285,7 @@ interface GeneratedQueryTypes {
20280
20285
  return: OrdersByCustomerIdQuery;
20281
20286
  variables: OrdersByCustomerIdQueryVariables;
20282
20287
  };
20283
- "#graphql\n query allProductVariants($first: Int!, $after: String) {\n productVariants(first: $first, after: $after) {\n edges {\n node {\n id\n legacyResourceId\n sku\n barcode\n inventoryQuantity\n price\n title\n product {\n status\n title\n description\n handle\n onlineStoreUrl\n featuredImage {\n url\n }\n }\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n": {
20288
+ "#graphql\n query allProductVariants($first: Int!, $after: String) {\n productVariants(first: $first, after: $after) {\n edges {\n node {\n id\n legacyResourceId\n sku\n barcode\n inventoryQuantity\n price\n title\n product {\n status\n title\n description\n handle\n onlineStoreUrl\n combinedListingRole\n featuredImage {\n url\n }\n }\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n": {
20284
20289
  return: AllProductVariantsQuery;
20285
20290
  variables: AllProductVariantsQueryVariables;
20286
20291
  };
@@ -20701,6 +20706,7 @@ declare const ProductVariantSchema: z.ZodObject<{
20701
20706
  description: z.ZodString;
20702
20707
  imageUrl: z.ZodNullable<z.ZodString>;
20703
20708
  inventoryQuantity: z.ZodNumber;
20709
+ combinedListingRole: z.ZodNullable<z.ZodEnum<["PARENT", "CHILD"]>>;
20704
20710
  }, "strip", z.ZodTypeAny, {
20705
20711
  status: "ACTIVE" | "ARCHIVED" | "DRAFT";
20706
20712
  url: string | null;
@@ -20711,6 +20717,7 @@ declare const ProductVariantSchema: z.ZodObject<{
20711
20717
  inventoryQuantity: number;
20712
20718
  price: string;
20713
20719
  title: string;
20720
+ combinedListingRole: "CHILD" | "PARENT" | null;
20714
20721
  imageUrl: string | null;
20715
20722
  }, {
20716
20723
  status: "ACTIVE" | "ARCHIVED" | "DRAFT";
@@ -20722,6 +20729,7 @@ declare const ProductVariantSchema: z.ZodObject<{
20722
20729
  inventoryQuantity: number;
20723
20730
  price: string;
20724
20731
  title: string;
20732
+ combinedListingRole: "CHILD" | "PARENT" | null;
20725
20733
  imageUrl: string | null;
20726
20734
  }>;
20727
20735
  type ProductVariant = z.infer<typeof ProductVariantSchema>;
package/dist/index.d.ts CHANGED
@@ -1531,9 +1531,11 @@ declare enum CatalogStatus {
1531
1531
  Draft = "DRAFT"
1532
1532
  }
1533
1533
  /**
1534
- * An authenticated link to an external platform that supports syndication and optionally order ingestion, such as Facebook, Pinterest, an online store, or Point of Sale (POS).
1534
+ * A connection between a Shopify shop and an external selling platform that supports product syndication and optionally order ingestion. Each channel binds a merchant's account on a specific platform — such as Amazon, eBay, Google, or a point-of-sale system — to the shop, establishing the publishing destination for product feeds.
1535
1535
  *
1536
- * Each channel provides access to its underlying [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App), published products and collections, and [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) settings, as well as what features of the platform it supports such as [scheduled publishing](https://shopify.dev/docs/apps/build/sales-channels/scheduled-product-publishing). Use channels to manage where catalog items appear, track publication status across platforms, and control [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) visibility for different customer touchpoints.
1536
+ * Sales Channel applications use [`channelCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/channelCreate) to establish channels after merchant authentication, and can manage multiple channel connections per app. Each channel is bound to a channel specification that declares the platform's regional coverage, capabilities, and requirements.
1537
+ *
1538
+ * Use channels to manage where catalog items are syndicated, track publication status across platforms, and control [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) visibility for different selling destinations.
1537
1539
  */
1538
1540
  type Channel = Node & {
1539
1541
  __typename?: 'Channel';
@@ -1543,7 +1545,7 @@ type Channel = Node & {
1543
1545
  collectionPublicationsV3: ResourcePublicationConnection;
1544
1546
  /** The list of collections published to the channel. */
1545
1547
  collections: CollectionConnection;
1546
- /** The unique identifier for the channel. */
1548
+ /** A unique, human-readable identifier for the channel within the shop. Set during [`channelCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/channelCreate) or auto-generated from the specification handle and account ID. Use with [`channelByHandle`](https://shopify.dev/docs/api/admin-graphql/latest/queries/channelByHandle) for lookups. */
1547
1549
  handle: Scalars['String']['output'];
1548
1550
  /** Whether the collection is available to the channel. */
1549
1551
  hasCollection: Scalars['Boolean']['output'];
@@ -17645,6 +17647,8 @@ declare enum ShopifyPaymentsTransactionType {
17645
17647
  ApplicationFeeRefund = "APPLICATION_FEE_REFUND",
17646
17648
  /** The balance_transfer_inbound transaction type. */
17647
17649
  BalanceTransferInbound = "BALANCE_TRANSFER_INBOUND",
17650
+ /** The balance_transfer_outbound transaction type. */
17651
+ BalanceTransferOutbound = "BALANCE_TRANSFER_OUTBOUND",
17648
17652
  /** The billing_debit transaction type. */
17649
17653
  BillingDebit = "BILLING_DEBIT",
17650
17654
  /** The billing_debit_reversal transaction type. */
@@ -19977,6 +19981,7 @@ type OrderByIdFullQuery = {
19977
19981
  shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
19978
19982
  };
19979
19983
  image?: Maybe<Pick<Image, 'url' | 'width' | 'height' | 'altText'>>;
19984
+ lineItemGroup?: Maybe<Pick<LineItemGroup, 'id' | 'title' | 'quantity' | 'variantSku'>>;
19980
19985
  });
19981
19986
  }>;
19982
19987
  };
@@ -20175,7 +20180,7 @@ type AllProductVariantsQuery = {
20175
20180
  productVariants: {
20176
20181
  edges: Array<{
20177
20182
  node: (Pick<ProductVariant$1, 'id' | 'legacyResourceId' | 'sku' | 'barcode' | 'inventoryQuantity' | 'price' | 'title'> & {
20178
- product: (Pick<Product, 'status' | 'title' | 'description' | 'handle' | 'onlineStoreUrl'> & {
20183
+ product: (Pick<Product, 'status' | 'title' | 'description' | 'handle' | 'onlineStoreUrl' | 'combinedListingRole'> & {
20179
20184
  featuredImage?: Maybe<Pick<Image, 'url'>>;
20180
20185
  });
20181
20186
  });
@@ -20256,7 +20261,7 @@ interface GeneratedQueryTypes {
20256
20261
  return: OrderByIdQuery;
20257
20262
  variables: OrderByIdQueryVariables;
20258
20263
  };
20259
- "#graphql\n query orderByIdFull($id: ID!) {\n order(id: $id) {\n id\n name\n createdAt\n updatedAt\n processedAt\n closedAt\n cancelledAt\n cancelReason\n totalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n customer {\n id\n firstName\n lastName\n email\n phone\n }\n displayFinancialStatus\n displayFulfillmentStatus\n shippingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n billingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n lineItems(first: 100) {\n edges {\n node {\n id\n sku\n title\n variantTitle\n quantity\n customAttributes {\n key\n value\n }\n originalUnitPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n vendor\n image {\n url\n width\n height\n altText\n }\n }\n }\n }\n fulfillments {\n id\n name\n totalQuantity\n status\n createdAt\n estimatedDeliveryAt\n deliveredAt\n trackingInfo {\n company\n number\n url\n }\n fulfillmentLineItems(first: 100) {\n edges {\n node {\n id\n quantity\n lineItem {\n id\n sku\n }\n }\n }\n }\n }\n shippingLine {\n originalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n taxLines {\n priceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n totalDiscountsSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n discountCodes\n refunds {\n totalRefundedSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n }\n }\n": {
20264
+ "#graphql\n query orderByIdFull($id: ID!) {\n order(id: $id) {\n id\n name\n createdAt\n updatedAt\n processedAt\n closedAt\n cancelledAt\n cancelReason\n totalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n customer {\n id\n firstName\n lastName\n email\n phone\n }\n displayFinancialStatus\n displayFulfillmentStatus\n shippingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n billingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n lineItems(first: 100) {\n edges {\n node {\n id\n sku\n title\n variantTitle\n quantity\n customAttributes {\n key\n value\n }\n originalUnitPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n vendor\n image {\n url\n width\n height\n altText\n }\n lineItemGroup {\n id\n title\n quantity\n variantSku\n }\n }\n }\n }\n fulfillments {\n id\n name\n totalQuantity\n status\n createdAt\n estimatedDeliveryAt\n deliveredAt\n trackingInfo {\n company\n number\n url\n }\n fulfillmentLineItems(first: 100) {\n edges {\n node {\n id\n quantity\n lineItem {\n id\n sku\n }\n }\n }\n }\n }\n shippingLine {\n originalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n taxLines {\n priceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n totalDiscountsSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n discountCodes\n refunds {\n totalRefundedSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n }\n }\n": {
20260
20265
  return: OrderByIdFullQuery;
20261
20266
  variables: OrderByIdFullQueryVariables;
20262
20267
  };
@@ -20280,7 +20285,7 @@ interface GeneratedQueryTypes {
20280
20285
  return: OrdersByCustomerIdQuery;
20281
20286
  variables: OrdersByCustomerIdQueryVariables;
20282
20287
  };
20283
- "#graphql\n query allProductVariants($first: Int!, $after: String) {\n productVariants(first: $first, after: $after) {\n edges {\n node {\n id\n legacyResourceId\n sku\n barcode\n inventoryQuantity\n price\n title\n product {\n status\n title\n description\n handle\n onlineStoreUrl\n featuredImage {\n url\n }\n }\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n": {
20288
+ "#graphql\n query allProductVariants($first: Int!, $after: String) {\n productVariants(first: $first, after: $after) {\n edges {\n node {\n id\n legacyResourceId\n sku\n barcode\n inventoryQuantity\n price\n title\n product {\n status\n title\n description\n handle\n onlineStoreUrl\n combinedListingRole\n featuredImage {\n url\n }\n }\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n": {
20284
20289
  return: AllProductVariantsQuery;
20285
20290
  variables: AllProductVariantsQueryVariables;
20286
20291
  };
@@ -20701,6 +20706,7 @@ declare const ProductVariantSchema: z.ZodObject<{
20701
20706
  description: z.ZodString;
20702
20707
  imageUrl: z.ZodNullable<z.ZodString>;
20703
20708
  inventoryQuantity: z.ZodNumber;
20709
+ combinedListingRole: z.ZodNullable<z.ZodEnum<["PARENT", "CHILD"]>>;
20704
20710
  }, "strip", z.ZodTypeAny, {
20705
20711
  status: "ACTIVE" | "ARCHIVED" | "DRAFT";
20706
20712
  url: string | null;
@@ -20711,6 +20717,7 @@ declare const ProductVariantSchema: z.ZodObject<{
20711
20717
  inventoryQuantity: number;
20712
20718
  price: string;
20713
20719
  title: string;
20720
+ combinedListingRole: "CHILD" | "PARENT" | null;
20714
20721
  imageUrl: string | null;
20715
20722
  }, {
20716
20723
  status: "ACTIVE" | "ARCHIVED" | "DRAFT";
@@ -20722,6 +20729,7 @@ declare const ProductVariantSchema: z.ZodObject<{
20722
20729
  inventoryQuantity: number;
20723
20730
  price: string;
20724
20731
  title: string;
20732
+ combinedListingRole: "CHILD" | "PARENT" | null;
20725
20733
  imageUrl: string | null;
20726
20734
  }>;
20727
20735
  type ProductVariant = z.infer<typeof ProductVariantSchema>;
package/dist/index.mjs CHANGED
@@ -1172,6 +1172,12 @@ var queryOrderByIdFull = gql`#graphql
1172
1172
  height
1173
1173
  altText
1174
1174
  }
1175
+ lineItemGroup {
1176
+ id
1177
+ title
1178
+ quantity
1179
+ variantSku
1180
+ }
1175
1181
  }
1176
1182
  }
1177
1183
  }
@@ -2020,6 +2026,7 @@ var queryAllProductVariants = gql`#graphql
2020
2026
  description
2021
2027
  handle
2022
2028
  onlineStoreUrl
2029
+ combinedListingRole
2023
2030
  featuredImage {
2024
2031
  url
2025
2032
  }
@@ -2045,7 +2052,8 @@ var ProductVariantSchema = z7.object({
2045
2052
  handle: z7.string(),
2046
2053
  description: z7.string(),
2047
2054
  imageUrl: z7.string().nullable(),
2048
- inventoryQuantity: z7.number()
2055
+ inventoryQuantity: z7.number(),
2056
+ combinedListingRole: z7.enum(["PARENT", "CHILD"]).nullable()
2049
2057
  });
2050
2058
  var GetAllProductVariantsReturn = z7.array(ProductVariantSchema);
2051
2059
  async function getAllProductVariants() {
@@ -2083,7 +2091,8 @@ async function getAllProductVariants() {
2083
2091
  handle: v.product.handle,
2084
2092
  description: v.product.description,
2085
2093
  imageUrl: v.product.featuredImage?.url ?? null,
2086
- inventoryQuantity: v.inventoryQuantity ?? 0
2094
+ inventoryQuantity: v.inventoryQuantity ?? 0,
2095
+ combinedListingRole: v.product.combinedListingRole ?? null
2087
2096
  };
2088
2097
  });
2089
2098
  return await returnOutputParsed(allVariants, GetAllProductVariantsReturn);