@ehrenkind/shopify-lib 0.5.0 → 0.5.2

package/dist/index.d.cts

@@ -41,6 +41,10 @@ type MetaobjectFieldDefinition$1 = {
     type: string;
     description?: string;
     required?: boolean;
+    validations?: Array<{
+        name: string;
+        value: string;
+    }>;
 };
 type CreateMetaobjectDefinitionInput = {
     type: string;
@@ -1470,6 +1474,8 @@ type CashRoundingAdjustment = {
 /**
  * A list of products with publishing and pricing information.
  * A catalog can be associated with a specific context, such as a [`Market`](https://shopify.dev/api/admin-graphql/current/objects/market), [`CompanyLocation`](https://shopify.dev/api/admin-graphql/current/objects/companylocation), or [`App`](https://shopify.dev/api/admin-graphql/current/objects/app).
+ *
+ * Catalogs can optionally include a publication to control product visibility and a price list to customize pricing. When a publication isn't associated with a catalog, product availability is determined by the sales channel.
  */
 type Catalog = {
     /** A globally-unique ID. */
@@ -10262,7 +10268,7 @@ type Market = HasMetafieldDefinitions & HasMetafields & Node & {
     webPresences: MarketWebPresenceConnection;
 };
 /**
- * A catalog for managing product availability and pricing for specific [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) contexts. Each catalog links to one or more markets and defines what [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects customers see through its [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) settings. The catalog can include a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) for market-specific pricing adjustments.
+ * A catalog for managing product availability and pricing for specific [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) contexts. Each catalog links to one or more markets. The catalog can optionally include a [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) to control which [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects customers see, and a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) for market-specific pricing adjustments. When a publication isn't associated with the catalog, product availability is determined by the sales channel.
  *
  * Use catalogs to create distinct shopping experiences for different geographic regions or customer segments.
  *
@@ -20169,7 +20175,7 @@ type LeanProductVariantsQuery = {
     productVariants: {
         edges: Array<{
             node: (Pick<ProductVariant$1, 'id' | 'title' | 'sku'> & {
-                product: Pick<Product, 'id' | 'title'>;
+                product: Pick<Product, 'id' | 'title' | 'status'>;
             });
         }>;
         pageInfo: Pick<PageInfo, 'hasNextPage' | 'endCursor'>;
@@ -20261,7 +20267,7 @@ interface GeneratedQueryTypes {
         return: AllProductVariantsQuery;
         variables: AllProductVariantsQueryVariables;
     };
-    "#graphql\n    query leanProductVariants($first: Int!, $after: String, $queryFilter: String) {\n      productVariants(first: $first, after: $after, query: $queryFilter) {\n        edges {\n          node { \n            id\n            title\n            sku\n            product {\n              id\n              title\n            }\n          }\n        }\n        pageInfo { \n          hasNextPage\n          endCursor\n        }\n      }\n    }\n  ": {
+    "#graphql\n    query leanProductVariants($first: Int!, $after: String, $queryFilter: String) {\n      productVariants(first: $first, after: $after, query: $queryFilter) {\n        edges {\n          node {\n            id\n            title\n            sku\n            product {\n              id\n              title\n              status\n            }\n          }\n        }\n        pageInfo {\n          hasNextPage\n          endCursor\n        }\n      }\n    }\n  ": {
         return: LeanProductVariantsQuery;
         variables: LeanProductVariantsQueryVariables;
     };
@@ -20594,30 +20600,39 @@ declare const GetLeanProductVariantsReturn: z.ZodArray<z.ZodObject<{
     variantId: z.ZodString;
     variantTitle: z.ZodString;
     sku: z.ZodString;
+    status: z.ZodEnum<["ACTIVE", "ARCHIVED", "DRAFT"]>;
 }, "strip", z.ZodTypeAny, {
+    status: "ACTIVE" | "ARCHIVED" | "DRAFT";
     productId: string;
     sku: string;
     variantId: string;
     productTitle: string;
     variantTitle: string;
 }, {
+    status: "ACTIVE" | "ARCHIVED" | "DRAFT";
     productId: string;
     sku: string;
     variantId: string;
     productTitle: string;
     variantTitle: string;
 }>, "many">;
-type GetLeanProductVariantsReturnType = z.infer<typeof GetLeanProductVariantsReturn>;
+type LeanProductVariant = z.infer<typeof GetLeanProductVariantsReturn>[number];
+type LeanProductVariantsOptions = {
+    /** Filter to only active/draft products (excludes ARCHIVED). Defaults to false. */
+    activeOnly?: boolean;
+};
 /**
  * Retrieves a lean list of product variants from Shopify, optionally filtered by SKUs.
  * Product variants are mapped to a simpler output structure.
  * Variants missing essential properties (e.g., SKU) will be filtered out and logged.
  *
  * @param {string[]} [skus] - An optional array of SKUs to filter by. If provided, only variants matching these SKUs will be fetched.
- * @returns {Promise<GetLeanProductVariantsReturnType>} A promise that resolves to an array of lean product variant data.
+ * @param {LeanProductVariantsOptions} [options] - Optional settings.
+ * @param {boolean} [options.activeOnly=false] - If true, excludes ARCHIVED products at query level.
+ * @returns {Promise<LeanProductVariant[]>} A promise that resolves to an array of lean product variant data.
  * @throws {Error} If the GraphQL query fails, returns no data, or if the `productVariants` field is missing in the response.
  */
-declare function getLeanProductVariants(skus?: string[]): Promise<GetLeanProductVariantsReturnType>;
+declare function getLeanProductVariants(skus?: string[], options?: LeanProductVariantsOptions): Promise<LeanProductVariant[]>;
 
 declare const GetProductVariantsBySkusReturn: z.ZodArray<z.ZodObject<{
     productId: z.ZodString;
@@ -20818,4 +20833,4 @@ type Metaobject = NonNullable<MetaobjectByHandleQuery['metaobjectByHandle']>;
  */
 declare function getMetaobjectByHandle(handle: MetaobjectHandleInput): Promise<Metaobject | undefined>;
 
-export { type BulkUpdateProductVariantsResult, type CalculateRefundLineItem, type CalculateRefundOptions, type CreateFulfillmentResult, type CreateMetaobjectDefinitionInput, type CreateMetaobjectDefinitionResult, type CreateRefundLineItem, type CreateRefundOptions, type CreateRefundResult, type CreateRefundTransaction, type Customer, type CustomerSegmentMember, type CustomerSegmentMembersResult, type Fulfillment, type FulfillmentLineItem$1 as FulfillmentLineItem, type FulfillmentOrder, type FulfillmentTrackingIds, type FullOrder, type FullOrderByName, type LeanOrder, type LeanOrderByName, type Metaobject, type MetaobjectFieldDefinition$1 as MetaobjectFieldDefinition, type MetaobjectHandleInput, type OrderCancellationInfo, type OrderPaymentDetails, type OrderPreview, type ProductVariant, type ProductVariantBySku, type ProductVariantsBySkusOptions, type RefundMoney, type SegmentAttributeStatistics, ShopifyUserError, type ShopifyUserErrorDetail, type SuggestedRefund, type UpdateFulfillmentTrackingResult, type UpsertMetaobjectInput, type UpsertMetaobjectResult, type VariantUpdateInput, bulkUpdateProductVariants, calculateRefund, cancelOrderById, createFile, createFulfillment, createMetaobjectDefinition, createRefund, deleteCustomerById, deleteFilesByIds, getAllProductVariants, getCustomerSegmentMembers, getCustomersByEmail, getFulfillmentById, getFulfillmentOrdersByOrderId, getFulfillmentTrackingIds, getLeanProductVariants, getMetaobjectByHandle, getOrderById, getOrderByName, getOrderCancellationInfoByName, getOrderPaymentDetailsById, getOrdersByCustomerId, getProductVariantsBySkus, parseGid, updateFulfillmentTracking, upsertMetaobject };
+export { type BulkUpdateProductVariantsResult, type CalculateRefundLineItem, type CalculateRefundOptions, type CreateFulfillmentResult, type CreateMetaobjectDefinitionInput, type CreateMetaobjectDefinitionResult, type CreateRefundLineItem, type CreateRefundOptions, type CreateRefundResult, type CreateRefundTransaction, type Customer, type CustomerSegmentMember, type CustomerSegmentMembersResult, type Fulfillment, type FulfillmentLineItem$1 as FulfillmentLineItem, type FulfillmentOrder, type FulfillmentTrackingIds, type FullOrder, type FullOrderByName, type LeanOrder, type LeanOrderByName, type LeanProductVariant, type LeanProductVariantsOptions, type Metaobject, type MetaobjectFieldDefinition$1 as MetaobjectFieldDefinition, type MetaobjectHandleInput, type OrderCancellationInfo, type OrderPaymentDetails, type OrderPreview, type ProductVariant, type ProductVariantBySku, type ProductVariantsBySkusOptions, type RefundMoney, type SegmentAttributeStatistics, ShopifyUserError, type ShopifyUserErrorDetail, type SuggestedRefund, type UpdateFulfillmentTrackingResult, type UpsertMetaobjectInput, type UpsertMetaobjectResult, type VariantUpdateInput, bulkUpdateProductVariants, calculateRefund, cancelOrderById, createFile, createFulfillment, createMetaobjectDefinition, createRefund, deleteCustomerById, deleteFilesByIds, getAllProductVariants, getCustomerSegmentMembers, getCustomersByEmail, getFulfillmentById, getFulfillmentOrdersByOrderId, getFulfillmentTrackingIds, getLeanProductVariants, getMetaobjectByHandle, getOrderById, getOrderByName, getOrderCancellationInfoByName, getOrderPaymentDetailsById, getOrdersByCustomerId, getProductVariantsBySkus, parseGid, updateFulfillmentTracking, upsertMetaobject };

package/dist/index.d.ts

@@ -41,6 +41,10 @@ type MetaobjectFieldDefinition$1 = {
     type: string;
     description?: string;
     required?: boolean;
+    validations?: Array<{
+        name: string;
+        value: string;
+    }>;
 };
 type CreateMetaobjectDefinitionInput = {
     type: string;
@@ -1470,6 +1474,8 @@ type CashRoundingAdjustment = {
 /**
  * A list of products with publishing and pricing information.
  * A catalog can be associated with a specific context, such as a [`Market`](https://shopify.dev/api/admin-graphql/current/objects/market), [`CompanyLocation`](https://shopify.dev/api/admin-graphql/current/objects/companylocation), or [`App`](https://shopify.dev/api/admin-graphql/current/objects/app).
+ *
+ * Catalogs can optionally include a publication to control product visibility and a price list to customize pricing. When a publication isn't associated with a catalog, product availability is determined by the sales channel.
  */
 type Catalog = {
     /** A globally-unique ID. */
@@ -10262,7 +10268,7 @@ type Market = HasMetafieldDefinitions & HasMetafields & Node & {
     webPresences: MarketWebPresenceConnection;
 };
 /**
- * A catalog for managing product availability and pricing for specific [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) contexts. Each catalog links to one or more markets and defines what [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects customers see through its [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) settings. The catalog can include a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) for market-specific pricing adjustments.
+ * A catalog for managing product availability and pricing for specific [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) contexts. Each catalog links to one or more markets. The catalog can optionally include a [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) to control which [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects customers see, and a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) for market-specific pricing adjustments. When a publication isn't associated with the catalog, product availability is determined by the sales channel.
  *
  * Use catalogs to create distinct shopping experiences for different geographic regions or customer segments.
  *
@@ -20169,7 +20175,7 @@ type LeanProductVariantsQuery = {
     productVariants: {
         edges: Array<{
             node: (Pick<ProductVariant$1, 'id' | 'title' | 'sku'> & {
-                product: Pick<Product, 'id' | 'title'>;
+                product: Pick<Product, 'id' | 'title' | 'status'>;
             });
         }>;
         pageInfo: Pick<PageInfo, 'hasNextPage' | 'endCursor'>;
@@ -20261,7 +20267,7 @@ interface GeneratedQueryTypes {
         return: AllProductVariantsQuery;
         variables: AllProductVariantsQueryVariables;
     };
-    "#graphql\n    query leanProductVariants($first: Int!, $after: String, $queryFilter: String) {\n      productVariants(first: $first, after: $after, query: $queryFilter) {\n        edges {\n          node { \n            id\n            title\n            sku\n            product {\n              id\n              title\n            }\n          }\n        }\n        pageInfo { \n          hasNextPage\n          endCursor\n        }\n      }\n    }\n  ": {
+    "#graphql\n    query leanProductVariants($first: Int!, $after: String, $queryFilter: String) {\n      productVariants(first: $first, after: $after, query: $queryFilter) {\n        edges {\n          node {\n            id\n            title\n            sku\n            product {\n              id\n              title\n              status\n            }\n          }\n        }\n        pageInfo {\n          hasNextPage\n          endCursor\n        }\n      }\n    }\n  ": {
         return: LeanProductVariantsQuery;
         variables: LeanProductVariantsQueryVariables;
     };
@@ -20594,30 +20600,39 @@ declare const GetLeanProductVariantsReturn: z.ZodArray<z.ZodObject<{
     variantId: z.ZodString;
     variantTitle: z.ZodString;
     sku: z.ZodString;
+    status: z.ZodEnum<["ACTIVE", "ARCHIVED", "DRAFT"]>;
 }, "strip", z.ZodTypeAny, {
+    status: "ACTIVE" | "ARCHIVED" | "DRAFT";
     productId: string;
     sku: string;
     variantId: string;
     productTitle: string;
     variantTitle: string;
 }, {
+    status: "ACTIVE" | "ARCHIVED" | "DRAFT";
     productId: string;
     sku: string;
     variantId: string;
     productTitle: string;
     variantTitle: string;
 }>, "many">;
-type GetLeanProductVariantsReturnType = z.infer<typeof GetLeanProductVariantsReturn>;
+type LeanProductVariant = z.infer<typeof GetLeanProductVariantsReturn>[number];
+type LeanProductVariantsOptions = {
+    /** Filter to only active/draft products (excludes ARCHIVED). Defaults to false. */
+    activeOnly?: boolean;
+};
 /**
  * Retrieves a lean list of product variants from Shopify, optionally filtered by SKUs.
  * Product variants are mapped to a simpler output structure.
  * Variants missing essential properties (e.g., SKU) will be filtered out and logged.
  *
  * @param {string[]} [skus] - An optional array of SKUs to filter by. If provided, only variants matching these SKUs will be fetched.
- * @returns {Promise<GetLeanProductVariantsReturnType>} A promise that resolves to an array of lean product variant data.
+ * @param {LeanProductVariantsOptions} [options] - Optional settings.
+ * @param {boolean} [options.activeOnly=false] - If true, excludes ARCHIVED products at query level.
+ * @returns {Promise<LeanProductVariant[]>} A promise that resolves to an array of lean product variant data.
  * @throws {Error} If the GraphQL query fails, returns no data, or if the `productVariants` field is missing in the response.
  */
-declare function getLeanProductVariants(skus?: string[]): Promise<GetLeanProductVariantsReturnType>;
+declare function getLeanProductVariants(skus?: string[], options?: LeanProductVariantsOptions): Promise<LeanProductVariant[]>;
 
 declare const GetProductVariantsBySkusReturn: z.ZodArray<z.ZodObject<{
     productId: z.ZodString;
@@ -20818,4 +20833,4 @@ type Metaobject = NonNullable<MetaobjectByHandleQuery['metaobjectByHandle']>;
  */
 declare function getMetaobjectByHandle(handle: MetaobjectHandleInput): Promise<Metaobject | undefined>;
 
-export { type BulkUpdateProductVariantsResult, type CalculateRefundLineItem, type CalculateRefundOptions, type CreateFulfillmentResult, type CreateMetaobjectDefinitionInput, type CreateMetaobjectDefinitionResult, type CreateRefundLineItem, type CreateRefundOptions, type CreateRefundResult, type CreateRefundTransaction, type Customer, type CustomerSegmentMember, type CustomerSegmentMembersResult, type Fulfillment, type FulfillmentLineItem$1 as FulfillmentLineItem, type FulfillmentOrder, type FulfillmentTrackingIds, type FullOrder, type FullOrderByName, type LeanOrder, type LeanOrderByName, type Metaobject, type MetaobjectFieldDefinition$1 as MetaobjectFieldDefinition, type MetaobjectHandleInput, type OrderCancellationInfo, type OrderPaymentDetails, type OrderPreview, type ProductVariant, type ProductVariantBySku, type ProductVariantsBySkusOptions, type RefundMoney, type SegmentAttributeStatistics, ShopifyUserError, type ShopifyUserErrorDetail, type SuggestedRefund, type UpdateFulfillmentTrackingResult, type UpsertMetaobjectInput, type UpsertMetaobjectResult, type VariantUpdateInput, bulkUpdateProductVariants, calculateRefund, cancelOrderById, createFile, createFulfillment, createMetaobjectDefinition, createRefund, deleteCustomerById, deleteFilesByIds, getAllProductVariants, getCustomerSegmentMembers, getCustomersByEmail, getFulfillmentById, getFulfillmentOrdersByOrderId, getFulfillmentTrackingIds, getLeanProductVariants, getMetaobjectByHandle, getOrderById, getOrderByName, getOrderCancellationInfoByName, getOrderPaymentDetailsById, getOrdersByCustomerId, getProductVariantsBySkus, parseGid, updateFulfillmentTracking, upsertMetaobject };
+export { type BulkUpdateProductVariantsResult, type CalculateRefundLineItem, type CalculateRefundOptions, type CreateFulfillmentResult, type CreateMetaobjectDefinitionInput, type CreateMetaobjectDefinitionResult, type CreateRefundLineItem, type CreateRefundOptions, type CreateRefundResult, type CreateRefundTransaction, type Customer, type CustomerSegmentMember, type CustomerSegmentMembersResult, type Fulfillment, type FulfillmentLineItem$1 as FulfillmentLineItem, type FulfillmentOrder, type FulfillmentTrackingIds, type FullOrder, type FullOrderByName, type LeanOrder, type LeanOrderByName, type LeanProductVariant, type LeanProductVariantsOptions, type Metaobject, type MetaobjectFieldDefinition$1 as MetaobjectFieldDefinition, type MetaobjectHandleInput, type OrderCancellationInfo, type OrderPaymentDetails, type OrderPreview, type ProductVariant, type ProductVariantBySku, type ProductVariantsBySkusOptions, type RefundMoney, type SegmentAttributeStatistics, ShopifyUserError, type ShopifyUserErrorDetail, type SuggestedRefund, type UpdateFulfillmentTrackingResult, type UpsertMetaobjectInput, type UpsertMetaobjectResult, type VariantUpdateInput, bulkUpdateProductVariants, calculateRefund, cancelOrderById, createFile, createFulfillment, createMetaobjectDefinition, createRefund, deleteCustomerById, deleteFilesByIds, getAllProductVariants, getCustomerSegmentMembers, getCustomersByEmail, getFulfillmentById, getFulfillmentOrdersByOrderId, getFulfillmentTrackingIds, getLeanProductVariants, getMetaobjectByHandle, getOrderById, getOrderByName, getOrderCancellationInfoByName, getOrderPaymentDetailsById, getOrdersByCustomerId, getProductVariantsBySkus, parseGid, updateFulfillmentTracking, upsertMetaobject };

package/dist/index.mjs

@@ -1815,35 +1815,46 @@ var GetLeanProductVariantsReturn = z5.array(
     productTitle: z5.string(),
     variantId: z5.string(),
     variantTitle: z5.string(),
-    sku: z5.string()
+    sku: z5.string(),
+    status: z5.enum(["ACTIVE", "ARCHIVED", "DRAFT"])
   })
 );
-async function getLeanProductVariants(skus) {
+async function getLeanProductVariants(skus, options) {
   const queryGql = gql`#graphql
     query leanProductVariants($first: Int!, $after: String, $queryFilter: String) {
       productVariants(first: $first, after: $after, query: $queryFilter) {
         edges {
-          node { 
+          node {
             id
             title
             sku
             product {
               id
               title
+              status
             }
           }
         }
-        pageInfo { 
+        pageInfo {
           hasNextPage
           endCursor
         }
       }
     }
   `;
-  const initialVariables = { first: 250 };
+  const queryParts = [];
   if (skus && skus.length > 0) {
-    initialVariables.queryFilter = skus.map((sku) => `sku:${sku}`).join(" OR ");
+    queryParts.push(skus.map((sku) => `sku:${sku}`).join(" OR "));
+  }
+  if (options?.activeOnly) {
+    queryParts.push("product_status:active,draft");
   }
+  const initialVariables = {
+    first: 250,
+    ...queryParts.length > 0 && {
+      queryFilter: queryParts.filter(Boolean).join(" AND ")
+    }
+  };
   const extractedNodes = await fetchShopifyGraphql({
     query: queryGql,
     variables: initialVariables,
@@ -1871,7 +1882,8 @@ async function getLeanProductVariants(skus) {
           productTitle: v.product.title,
           variantId: v.id,
           variantTitle: v.title,
-          sku: v.sku
+          sku: v.sku,
+          status: v.product.status
         }
       ];
     }