@sommpicks/sommpicks-shopify 24.12.0

package/shopify/helpers/ShopifyProductServiceHelper.ts

@@ -0,0 +1,450 @@
+import { AbstractService } from '../base/AbstractService';
+import { ConfirmationUpdate } from '../product/ShopifyVariantService';
+
+export class ShopifyProductServiceHelper extends AbstractService {
+
+    public static graphQLQuery = {
+        getVariantsBulkCreateMutation: (withImages: boolean, withInventory: boolean, removeStandaloneVariant: boolean): string => {
+            return `mutation productVariantsBulkCreate($productId: ID!, $variants: [ProductVariantsBulkInput!]! ${withImages ? ', $media: [CreateMediaInput!]!' : ''}) {
+                    productVariantsBulkCreate(productId: $productId, variants: $variants, ${withImages ? 'media: $media,' : '' } strategy: ${removeStandaloneVariant? 'REMOVE_STANDALONE_VARIANT' : 'DEFAULT'}) {
+                        productVariants {
+                            id
+                            price
+                            sku
+                            availableForSale
+                            inventoryQuantity
+                            inventoryPolicy
+                            taxable
+                            barcode
+                            media(first: 1) {
+                                    nodes{
+                                        id
+                                    }
+                                }
+                            selectedOptions { name value }
+                            ${ withInventory ? `inventoryItem {
+                                id
+                                measurement { weight { unit value } }
+                                tracked
+                                unitCost {
+                                    amount
+                                }
+                            }` : ''}
+                        }
+                    }
+                }`;
+        },
+        productOptionCreateMutation: (): string => {
+            return `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {
+                    productOptionsCreate(productId: $productId, options: $options) {
+                        userErrors {
+                            field
+                            message
+                            code
+                        }
+                        product {
+                            options {
+                                name
+                                linkedMetafield {
+                                    namespace
+                                    key
+                                }
+                                optionValues {
+                                    name
+                                    linkedMetafieldValue
+                                }
+                            }
+                        }
+                    }
+                }`;
+        },
+        productVariantsBulkUpdate: `mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) {
+            productVariantsBulkUpdate(productId: $productId, variants: $variants) {
+                product {
+                    id
+                }
+                productVariants {
+                    id
+                    price
+                    sku
+                    availableForSale
+                    inventoryQuantity
+                    inventoryPolicy
+                    taxable
+                    barcode
+                    media(first: 1) {
+                                    nodes{
+                                        id
+                                    }
+                                }
+                    selectedOptions { name value }
+                    inventoryItem {
+                        id
+                        measurement { weight { unit value } }
+                        tracked
+                        unitCost {
+                            amount
+                        }
+                    }
+                }
+                userErrors {
+                    field
+                    message
+                }
+            }
+        }`,
+        productVariantsBulkUpdateWithoutInventory: `mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) {
+            productVariantsBulkUpdate(productId: $productId, variants: $variants) {
+                product {
+                    id
+                }
+                productVariants {
+                    id
+                    price
+                    sku
+                    availableForSale
+                    inventoryQuantity
+                    inventoryPolicy
+                    taxable
+                    barcode
+                    media(first: 1) {
+                                    nodes{
+                                        id
+                                    }
+                                }
+                    selectedOptions { name value }
+                }
+                userErrors {
+                    field
+                    message
+                }
+            }
+        }`,
+        getProductVariant: `query ProductVariant($variantId: ID!) {
+            productVariant(id: $variantId) {
+                id
+                price
+                sku
+                barcode
+                availableForSale
+                inventoryQuantity
+                inventoryPolicy
+                taxable
+                media(first: 1) {
+                                nodes{
+                                    id
+                                }
+                            }
+                selectedOptions { name value }
+                inventoryItem {
+                    id
+                    measurement { weight { unit value } }
+                    tracked
+                    unitCost {
+                        amount
+                    }
+                }
+            }
+        }`,
+        getProductVariantMetafields: `query ProductVariant($variantId: ID!) {
+            productVariant(id: $variantId) {
+                id
+                metafields(first: 200) {
+                    nodes {
+                        key
+                        namespace
+                        value
+                        id
+                        description
+                        type
+                    }
+                }
+            }
+        }`,
+        deleteVariantsMutation: `mutation productVariantsBulkDelete($productId: ID!, $variantsIds: [ID!]!) {
+            productVariantsBulkDelete(productId: $productId, variantsIds: $variantsIds) {
+                product {
+                    id
+                }
+                userErrors {
+                    field
+                    message
+                }
+            }
+        }`,
+        getProductCreateMutation: (withInventory: boolean): string => {
+            return `mutation ($product: ProductCreateInput!, $media: [CreateMediaInput!]!) {
+                productCreate(product: $product, media: $media) {
+                    product {
+                        id
+                        descriptionHtml
+                        title
+                        vendor
+                        productType
+                        createdAt
+                        updatedAt
+                        publishedAt
+                        handle
+                        status
+                        images(first: 150) { edges { node { id url } } }
+                        tags
+                        options { name position optionValues { name } }
+                        variants(first: 150) {
+                            edges {
+                                node {
+                                    id
+                                    price
+                                    sku
+                                    barcode
+                                    availableForSale
+                                    inventoryQuantity
+                                    inventoryPolicy
+                                    taxable
+                                    media(first: 1) {
+                                        nodes{
+                                            id
+                                        }
+                                    }
+                                    selectedOptions { name value }
+                                    ${ withInventory ? `inventoryItem {
+                                        id
+                                        measurement { weight { unit value } }
+                                        tracked
+                                        unitCost {
+                                            amount
+                                        }
+                                    }` : '' }
+                                }
+                            }
+                        }
+                    }
+                }
+            }`;
+        }
+        ,
+        updateProductMutation: `mutation UpdateProduct($product: ProductUpdateInput!) {
+            productUpdate(product: $product) {
+                product {
+                    id
+                }
+                userErrors {
+                    field
+                    message
+                }
+            }
+        }`,
+        variantUpdateInventory: `mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
+            inventoryAdjustQuantities(input: $input) {
+                    userErrors {
+                       field
+                       message
+                    }
+                    inventoryAdjustmentGroup {
+                        createdAt
+                        reason
+                        referenceDocumentUri
+                        changes {
+                            name
+                            delta
+                        }
+                    }
+            }
+        }`,
+        variantSetInventory: `mutation inventorySetQuantities($input: InventorySetQuantitiesInput!) {
+            inventorySetQuantities(input: $input) {
+                    userErrors {
+                       field
+                       message
+                    }
+                    inventoryAdjustmentGroup {
+                        reason
+                        referenceDocumentUri
+                        changes {
+                            name
+                            delta
+                            quantityAfterChange
+                        }
+                    }
+            }
+        }`
+    };
+
+    constructor() {
+        super();
+    }
+
+    public addProduct = (products: IProduct[], graphProduct: ShopifygraphQl.IGenericProductResponse) => {
+        products.push(this.getProduct(graphProduct));
+    };
+
+    public getProduct = (graphProduct: ShopifygraphQl.IGenericProductResponse): IProduct => {
+        return {
+            id: this.getIdFromGraphId(graphProduct.id),
+            body_html: graphProduct.descriptionHtml ? graphProduct.descriptionHtml : null,
+            published: graphProduct.publishedAt ? true : false,
+            title: graphProduct.title ? graphProduct.title : null,
+            created_at: graphProduct.createdAt,
+            images: graphProduct.images && graphProduct.images.edges && graphProduct.images.edges.length > 0 ? graphProduct.images.edges.map(im => ({ id: this.getIdFromGraphId(im.node.id), src: im.node.url })) : null,
+            product_type: graphProduct.productType,
+            handle: graphProduct.handle ?? null,
+            published_at: graphProduct.publishedAt,
+            updated_at: graphProduct.updatedAt,
+            status: graphProduct.status,
+            vendor: graphProduct.vendor,
+            options: graphProduct.options && graphProduct.options.length > 0 ? graphProduct.options.map(op => ({ name: op.name, values: op.optionValues ? op.optionValues.map(v => v.name) : [] })) : [],
+            tags: graphProduct.tags ? graphProduct.tags : [],
+            variants: graphProduct.variants ? graphProduct.variants.edges.map(variant => this.getVariant(variant.node)) : []
+        };
+    };
+
+    public getVariant = (graphProductVariant: ShopifygraphQl.IGenericVariantResponse): IVariant => {
+        return {
+            id: this.getIdFromGraphId(graphProductVariant.id),
+            barcode: graphProductVariant.barcode ? graphProductVariant.barcode : null,
+            price: graphProductVariant.price,
+            sku: graphProductVariant.sku,
+            inventory_quantity: graphProductVariant.inventoryQuantity,
+            inventory_policy: graphProductVariant.inventoryPolicy,
+            compare_at_price: graphProductVariant.compareAtPrice,
+            taxable: graphProductVariant.taxable,
+            weight: graphProductVariant.inventoryItem?.measurement?.weight ? graphProductVariant.inventoryItem?.measurement.weight.value : null,
+            weight_unit: graphProductVariant.inventoryItem?.measurement?.weight ? graphProductVariant.inventoryItem?.measurement.weight.unit : null,
+            image_id: graphProductVariant.media?.nodes?.length > 0 ? this.getIdFromGraphId(graphProductVariant.media.nodes[0].id) : null,
+            inventory_item_id: graphProductVariant.inventoryItem?.id ? this.getIdFromGraphId(graphProductVariant.inventoryItem.id) : null,
+            option1: graphProductVariant.selectedOptions?.length > 0 ? graphProductVariant.selectedOptions[0].value : null,
+            option2: graphProductVariant.selectedOptions?.length > 1 ? graphProductVariant.selectedOptions[1].value : null,
+            option3: graphProductVariant.selectedOptions?.length > 2 ? graphProductVariant.selectedOptions[2].value : null,
+        } as IVariant;
+    };
+
+    public getVariantToPost = ( variant: IVariant, img: { imageSrc?: string; imageId?: number;}, productOptionNames: string[], locationId: number): ShopifygraphQl.IVariantToPost => {
+        const variantToCreate: ShopifygraphQl.IVariantToPost = {};
+        if (variant.barcode) {
+            variantToCreate.barcode = variant.barcode;
+        }
+        if (variant.compare_at_price) {
+            variantToCreate.compareAtPrice = `${variant.compare_at_price}`;
+        }
+        if (variant.inventory_policy) {
+            variantToCreate.inventoryPolicy = `${variant.inventory_policy.toLowerCase() === 'deny' ? 'DENY' : 'CONTINUE'}`;
+        }
+        if (variant.option1) {
+            variantToCreate.optionValues = [{ optionName: productOptionNames[0], name: variant.option1 }];
+        }
+        if (variant.option2) {
+            variantToCreate.optionValues.push({ optionName: productOptionNames[1], name: variant.option2 });
+        }
+        if (variant.option3) {
+            variantToCreate.optionValues.push({ optionName: productOptionNames[2], name: variant.option3 });
+        }
+        if (variant.price) {
+            variantToCreate.price = variant.price;
+        }
+        if (variant.inventory_quantity && locationId) {
+            variantToCreate.inventoryQuantities = [{ availableQuantity: variant.inventory_quantity, locationId: `gid://shopify/Location/${locationId}` }];
+        }
+        variantToCreate.taxable = variant.taxable ? true : false;
+        variantToCreate.inventoryItem = {};
+        if (variant.sku) {
+            variantToCreate.inventoryItem.sku = variant.sku;
+        }
+        if (locationId) {
+            variantToCreate.inventoryItem.tracked = true;
+        } else {
+            variantToCreate.inventoryItem.tracked = false;
+        }
+
+        if (img.imageSrc) {
+            variantToCreate.mediaSrc = [img.imageSrc];
+        } else if (img.imageId) {
+            variantToCreate.mediaId = `gid://shopify/MediaImage/${img.imageId}`;
+        }
+        if (variant.weight_unit && variant.weight) {
+            variantToCreate.inventoryItem.measurement = { weight: {} };
+            if (variant.weight_unit) {
+                let unit: any = variant.weight_unit.toUpperCase();
+                if (unit === 'G') {
+                    unit = 'GRAMS';
+                } else if (unit === 'LB') {
+                    unit = 'POUNDS';
+                } else if (unit === 'K') {
+                    unit = 'KILOGRAMS';
+                } else if (unit === 'OZ') {
+                    unit = 'OUNCES';
+                }
+                variantToCreate.inventoryItem.measurement.weight.unit = unit;
+            }
+            if (variant.weight) {
+                variantToCreate.inventoryItem.measurement.weight.value = variant.weight;
+            }
+        }
+        if (variant.inventory_quantity && locationId) {
+            variantToCreate.inventoryQuantities = [{ availableQuantity: variant.inventory_quantity, locationId: `gid://shopify/Location/${locationId}` }];
+        }
+        return variantToCreate;
+    };
+
+    public getVariantToUpdate = ( variant: IVariant, img: { imageSrc?: string; imageId?: number;}, productOptionNames: string[], taxableSetting: ConfirmationUpdate<'updateTaxable', 'taxable'>): ShopifygraphQl.IVariantToPost => {
+        const variantToCreate: ShopifygraphQl.IVariantToPost = {};
+        if (variant.barcode) {
+            variantToCreate.barcode = variant.barcode;
+        }
+        if (variant.compare_at_price) {
+            variantToCreate.compareAtPrice = `${variant.compare_at_price}`;
+        }
+        if (variant.inventory_policy) {
+            variantToCreate.inventoryPolicy = `${variant.inventory_policy.toLowerCase() === 'deny' ? 'DENY' : 'CONTINUE'}`;
+        }
+        if (variant.option1) {
+            variantToCreate.optionValues = [{ optionName: productOptionNames[0], name: variant.option1 }];
+        }
+        if (variant.option2) {
+            variantToCreate.optionValues.push({ optionName: productOptionNames[1], name: variant.option2 });
+        }
+        if (variant.option3) {
+            variantToCreate.optionValues.push({ optionName: productOptionNames[2], name: variant.option3 });
+        }
+        if (variant.price) {
+            variantToCreate.price = variant.price;
+        }
+        if (taxableSetting.updateTaxable) {
+            variantToCreate.taxable = taxableSetting.taxable ? true : false;
+        }
+        variantToCreate.inventoryItem = {};
+        if (variant.sku) {
+            variantToCreate.inventoryItem.sku = variant.sku;
+        }
+        if (variant.inventory_management !== 'NOT_MANGED') {
+            variantToCreate.inventoryItem.tracked = true;
+        } else {
+            variantToCreate.inventoryItem.tracked = false;
+        }
+
+        if (img?.imageSrc) {
+            variantToCreate.mediaSrc = [img.imageSrc];
+        } else if (img?.imageId) {
+            variantToCreate.mediaId = `gid://shopify/MediaImage/${img.imageId}`;
+        }
+        if (variant.weight_unit && variant.weight) {
+            variantToCreate.inventoryItem.measurement = { weight: {} };
+            if (variant.weight_unit) {
+                let unit: any = variant.weight_unit.toUpperCase();
+                if (unit === 'G') {
+                    unit = 'GRAMS';
+                } else if (unit === 'LB') {
+                    unit = 'POUNDS';
+                } else if (unit === 'K') {
+                    unit = 'KILOGRAMS';
+                } else if (unit === 'OZ') {
+                    unit = 'OUNCES';
+                }
+                variantToCreate.inventoryItem.measurement.weight.unit = unit;
+            }
+            if (variant.weight) {
+                variantToCreate.inventoryItem.measurement.weight.value = variant.weight;
+            }
+        }
+
+        return variantToCreate;
+    };
+}

package/shopify/product/ShopifyProductCountService.ts

@@ -0,0 +1,110 @@
+import { AxiosInstance } from 'axios';
+import { print } from 'graphql';
+import gql from 'graphql-tag';
+import * as moment from 'moment';
+import { AbstractService } from '../base/AbstractService';
+import { Logger } from '../../Logger';
+import InspiraShopifyError from '../errors/InspiraShopifyError';
+
+export class ShopifyProductCountService extends AbstractService {
+
+    constructor(private axiosInstance: AxiosInstance) { super(); }
+
+    /**
+     * Gets the count of products. No matter of published status.
+     * 
+     * @returns Promise
+     */
+    public getCount_REST = async (): Promise<number> => {
+        return new Promise<number>(async (resolve) => {
+            try {
+                const numberOfProducts = await this.getCountByPusblishedStatus_REST('any');
+                resolve(numberOfProducts);
+            } catch (error) { this.logErrorAndThrow(error); }
+        });
+    };
+
+    /**
+     * Gets the count of products depending on published status.
+     * 
+     * @returns Promise
+     */
+    public getCountByPusblishedStatus_REST = async (status: 'any' | 'published' | 'unpublished'): Promise<number> => {
+        return new Promise<number>(async (resolve) => {
+            try {
+                Logger.info(`Counting all products by published status ${status}`);
+                const response = await this.axiosInstance.get(`/products/count.json?published_status=${status}`);
+                const numberOfProducts = response.data.count;
+                Logger.info(`${numberOfProducts} products`);
+                resolve(numberOfProducts);
+            } catch (error) { this.logErrorAndThrow(error); }
+        });
+    };
+
+    /**
+     * Gets the count of products depending on published status And created at days ago.
+     * 
+     * @returns Promise
+     */
+    public getCountByPusblishedStatusAndCreatedAt_REST = async (status: 'any' | 'published' | 'unpublished', daysAgo: number): Promise<number> => {
+        return new Promise<number>(async (resolve) => {
+            try {
+                const dayAgoString = moment().add(-daysAgo, 'days').format('YYYY-MM-DDTHH:mm:ss');
+                Logger.info(`Counting all products by published status ${status} and created after ${dayAgoString}`);
+                const response = await this.axiosInstance.get(`/products/count.json?published_status=${status}&created_at_min=${dayAgoString}`);
+                const numberOfProducts = response.data.count;
+                Logger.info(`${numberOfProducts} products`);
+                resolve(numberOfProducts);
+            } catch (error) { this.logErrorAndThrow(error); }
+        });
+    };
+
+    /**
+     * Counts to a MAX of 10K
+     * 
+     * @param {number} daysAgo created after
+     * @returns {number} Returns count of products
+     */
+    public getCount= async (publishedStatus:  'any' | 'published' | 'unpublished',  daysAgo?: number): Promise<number> => {
+        try {
+            Logger.info('Get product count publications');
+            let queryParams = '';
+            if(publishedStatus === 'published' || publishedStatus === 'unpublished') {
+                queryParams = `published_status:'${publishedStatus}'`;
+            }
+            if(daysAgo) {
+                const dayAgoString = moment().add(-daysAgo, 'days').format('YYYY-MM-DDTHH:mm:ss');
+                if(queryParams.length > 0) {
+                    queryParams = `${queryParams} AND created_at:>'${dayAgoString}'`;
+                } else {
+                    queryParams = `created_at:>'${dayAgoString}'`;
+                }
+            }
+            const countQuery = gql` { productsCount( query: "${queryParams}") { count } }`;
+            const response = await this.axiosInstance.post('/graphql.json', { query: print(countQuery) }, { query_cost: 15 });
+            if (response && response.data && response.data.data && response.data.data.productsCount) {
+                const count: number = response.data.data.productsCount.count;
+                return count;
+            } else {
+                throw new InspiraShopifyError({ message: JSON.stringify(response.data.errors) });
+            }
+        } catch (error) { this.logErrorAndThrow(error); }
+    };
+
+    /**
+     * Counts total number of products
+     */
+    public getTotalCount= async (): Promise<number> => {
+        try {
+            Logger.info('Get total products count');
+            const countQuery = gql` { productsCount { count } }`;
+            const response = await this.axiosInstance.post('/graphql.json', { query: print(countQuery) }, { query_cost: 15 });
+            if (response && response.data && response.data.data && response.data.data.productsCount) {
+                const count: number = response.data.data.productsCount.count;
+                return count;
+            } else {
+                throw new InspiraShopifyError({ message: JSON.stringify(response.data.errors) });
+            }
+        } catch (error) { this.logErrorAndThrow(error); }
+    };
+}