@sommpicks/sommpicks-shopify 24.12.0

package/shopify/product/ShopifyProductListService.ts

@@ -0,0 +1,333 @@
+import { AxiosInstance } from 'axios';
+import { print } from 'graphql';
+import gql from 'graphql-tag';
+import { Logger } from '../../Logger';
+import InspiraShopifyError from '../errors/InspiraShopifyError';
+import * as moment from 'moment';
+import { ShopifyProductServiceHelper } from '../helpers/ShopifyProductServiceHelper';
+import { AbstractService } from '../base/AbstractService';
+
+export class ShopifyProductListService extends AbstractService {
+
+    private shopifyProductServiceHelper: ShopifyProductServiceHelper;
+
+    constructor(private axiosInstance: AxiosInstance) {
+        super();
+        this.shopifyProductServiceHelper = new ShopifyProductServiceHelper();
+    }
+
+    /**
+     * 
+     * @param numOfProducts number or all if you want them all
+     * @param filter by title, handle published Status and createdDaysAgo
+     * @param daysAgo number or all if no filter
+     * @param options by default it loads all data
+     * @returns {IProduct} List of products
+     */
+    public get = async ( numOfProducts: number | 'all',
+        filter: { title?: string; handle?: string; publishedStatus: 'any' | 'published' | 'unpublished';  createdDaysAgo: number | 'all', productType?: string; vendor?: string; },
+        options: { add_variants?: boolean; add_weight?: boolean; add_body_html?: boolean; add_title?: boolean; add_images?: boolean; add_tags?: boolean; add_options?: boolean; }): Promise<IProduct[]> => {
+        try {
+            Logger.info(`ShopifyProductListService - get -> Get products with criteria filter: ${JSON.stringify(filter)} and numOfProducts ${numOfProducts}`);
+            const products: IProduct[] = [];
+            const queryParams = this.buildProductsQuery(filter.publishedStatus, filter.createdDaysAgo, 'all', filter.handle, filter.title, filter.vendor, filter.productType, null);
+            let nextCursor = '';
+            Logger.info(`ShopifyProductListService - get -> First products query going in ... Query: ${queryParams}`);
+            while (nextCursor !== null) {
+                if (numOfProducts !== 'all' && products.length >= numOfProducts) {
+                    break;
+                }
+                const productsQuery = this.buildProductsGraphQL(numOfProducts, queryParams, nextCursor, options);
+                Logger.info(`ShopifyProductListService - get -> Products graphQL query going in ${productsQuery}`);
+                const response = await this.axiosInstance.post('/graphql.json', { query: print(gql`${productsQuery}`) }, { query_cost: 800 });
+                if (response && response.data && response.data.data && response.data.data.products) {
+                    const responseData: ShopifygraphQl.IProductResponseFrame = response.data.data;
+                    Logger.info(`ShopifyProductListService -> Products graphQL pageInfo ${JSON.stringify(responseData?.products?.pageInfo)}`);
+                    if (responseData.products.pageInfo.hasNextPage) {
+                        nextCursor = responseData.products.pageInfo.endCursor;
+                    } else {
+                        nextCursor = null;
+                    }
+                    for (const product of responseData.products.edges) {
+                        this.shopifyProductServiceHelper.addProduct(products, product.node);
+                    }
+                } else {
+                    throw new InspiraShopifyError({ message: JSON.stringify(response.data.errors) });
+                }
+
+            }
+            Logger.info(`ShopifyProductListService - get -> ${products.length} Products returning`);
+            return products;
+        } catch (error) { this.logErrorAndThrow(error); }
+    };
+
+
+    /**
+     * 
+     * @param {number[]} ids product ids to look (Max of 100)
+     * @param options by default it loads all data
+     * @returns {IProduct} List of products
+     */
+    public getByIds = async (ids: number[],
+        options: { add_variants?: boolean; add_weight?: boolean; add_body_html?: boolean; add_title?: boolean; add_images?: boolean; add_tags?: boolean; add_options?: boolean; }): Promise<IProduct[]> => {
+        try {
+            Logger.info(`ShopifyProductListService - getByIds -> Get products ids: ${JSON.stringify(ids)}`);
+            const products: IProduct[] = [];
+            const productsQuery = this.buildProductsGraphQL(ids.length, `${ids.map(id => `(id:${id})`).join(' OR ')}`, null, options);
+            Logger.info(`ShopifyProductListService - getByIds -> Products graphQL query going in ${productsQuery}`);
+            const response = await this.axiosInstance.post('/graphql.json', { query: print(gql`${productsQuery}`) }, { query_cost: 800 });
+            if (response && response.data && response.data.data && response.data.data.products) {
+                const responseData: ShopifygraphQl.IProductResponseFrame = response.data.data;
+                for (const product of responseData.products.edges) {
+                    this.shopifyProductServiceHelper.addProduct(products, product.node);
+                }
+            } else {
+                throw new InspiraShopifyError({ message: JSON.stringify(response.data.errors) });
+            }
+            Logger.info(`ShopifyProductListService - getByIds -> ${products.length} Products returning`);
+            return products;
+        } catch (error) { this.logErrorAndThrow(error); }
+    };
+
+
+    /**
+     * 
+     * @param {string } cursor sent null to start from begining
+     * @param daysAgo number or all if no filter
+     * @param options by default it loads all data
+     * @returns {IProduct} List of products
+     */
+    public getInBatch = async (cursor: string,
+        filter: { title?: string; handle?: string; publishedStatus: 'any' | 'published' | 'unpublished';  createdDaysAgo: number | 'all', updatedDaysAgo: number | 'all', productType?: string; vendor?: string; collectionID: number | null },  
+        options: { add_variants?: boolean; add_weight?: boolean; add_body_html?: boolean; add_title?: boolean; add_images?: boolean; add_tags?: boolean; add_options?: boolean; }): Promise<IProductBatch> => {
+        try {
+            Logger.info(`ShopifyProductListService - getInBatch -> Get products with criteria : ${JSON.stringify(filter)}`);
+            const productsInBatch: IProductBatch = { products: [], nextCursor: null };
+            const queryParams = this.buildProductsQuery(filter.publishedStatus, filter.createdDaysAgo, filter.updatedDaysAgo, filter.handle, filter.title, filter.vendor, filter.productType, filter.collectionID);
+
+            Logger.info(`ShopifyProductListService - getInBatch -> First products query going in ... Query: ${queryParams}`);
+
+            const productsQuery = this.buildProductsGraphQL('all', queryParams, cursor, options);
+            
+            Logger.info(`ShopifyProductListService - getInBatch -> Products graphQL query going in ${productsQuery}`);
+            const response = await this.axiosInstance.post('/graphql.json', { query: print(gql`${productsQuery}`) }, { query_cost: 800 });
+            if (response && response.data && response.data.data && response.data.data.products) {
+                const responseData: ShopifygraphQl.IProductResponseFrame = response.data.data;
+                Logger.info(`ShopifyProductListService -> Products graphQL pageInfo ${JSON.stringify(responseData?.products?.pageInfo)}`);
+                if (responseData.products.pageInfo.hasNextPage) {
+                    productsInBatch.nextCursor = responseData.products.pageInfo.endCursor;
+                } else {
+                    productsInBatch.nextCursor = null;
+                }
+                for (const product of responseData.products.edges) {
+                    this.shopifyProductServiceHelper.addProduct(productsInBatch.products, product.node);
+                }
+            } else {
+                throw new InspiraShopifyError({ message: JSON.stringify(response.data.errors) });
+            }
+            Logger.info(`ShopifyProductListService - getInBatch -> ${productsInBatch.products.length} Products returning`);
+            return productsInBatch;
+        } catch (error) { this.logErrorAndThrow(error); }
+    };
+
+    /**
+     * 
+     * @param id of the product
+     * @param options by default it loads all data
+     * @returns {IProduct} product
+     */
+    public getById = async (id: number,
+        options: { add_variants?: boolean; add_weight?: boolean; add_body_html?: boolean; add_title?: boolean; add_images?: boolean; add_tags?: boolean; add_options?: boolean; }): Promise<IProduct> => {
+        try {
+            Logger.info(`ShopifyProductListService - getById -> Get product with id ${id}`);
+            let productToReturn: IProduct = null;
+
+            const productQuery = `{ product(id: "${this.getGraphProductIdFromId(id)}")  {
+                    id
+                    ${options.add_body_html === false ? '' : 'descriptionHtml'}
+                    ${options.add_title === false ? '' : 'title'}
+                    vendor
+                    productType
+                    createdAt
+                    updatedAt
+                    publishedAt
+                    handle
+                    status
+                    ${options.add_images === false ? '' : 'images(first: 20) { edges { node { id url } } }'}
+                    ${options.add_tags === false ? '' : 'tags'}
+                    ${options.add_options === false ? '' : 'options { name position optionValues { name } }'}
+                    ${options.add_variants === false ? '' : `variants(first: 150) {
+                        edges {
+                            node {
+                                id
+                                price
+                                sku
+                                availableForSale
+                                inventoryQuantity
+                                inventoryPolicy
+                                taxable
+                                ${options.add_images === false ? '' : 'media(first:1) { nodes { id } }'}
+                                ${options.add_options === false ? '' : 'selectedOptions { name value }'}
+                                inventoryItem {
+                                    id
+                                    ${options.add_weight === false ? '' : 'measurement { weight { unit value } }'}
+                                    tracked
+                                    unitCost {
+                                        amount
+                                    }
+                                }
+                            }
+                        }
+                    }` }
+                }
+            }`;
+            Logger.info(`ShopifyProductListService - getById -> Product graphQL query going in ${productQuery}`);
+            const response = await this.axiosInstance.post('/graphql.json', { query: print(gql`${productQuery}`) }, { query_cost: 80 });
+            if (response && response.data && response.data.data && response.data.data.product) {
+                const responseProduct: ShopifygraphQl.IGenericProductResponse = response.data.data.product;
+                productToReturn = {
+                    id: this.getIdFromGraphId(responseProduct.id),
+                    body_html: responseProduct.descriptionHtml ? responseProduct.descriptionHtml : null,
+                    published: responseProduct.publishedAt ? true : false,
+                    title: responseProduct.title ? responseProduct.title : null,
+                    created_at: responseProduct.createdAt,
+                    images: responseProduct.images && responseProduct.images.edges && responseProduct.images.edges.length > 0 ? responseProduct.images.edges.map(im => ({ id: this.getIdFromGraphId(im.node.id), src: im.node.url })) : null,
+                    product_type: responseProduct.productType,
+                    published_at: responseProduct.publishedAt,
+                    updated_at: responseProduct.updatedAt,
+                    handle: responseProduct.handle,
+                    status: responseProduct.status,
+                    vendor: responseProduct.vendor,
+                    options: responseProduct.options && responseProduct.options.length > 0 ? responseProduct.options.map(op => ({ name: op.name, values: op.optionValues ? op.optionValues.map(v => v.name) : [] })) : [],
+                    tags: responseProduct.tags ? responseProduct.tags : [],
+                    variants: responseProduct.variants ? responseProduct.variants.edges.map(variant => ({
+                        id: this.getIdFromGraphId(variant.node.id),
+                        barcode: variant.node.barcode ? variant.node.barcode : null,
+                        price: variant.node.price,
+                        sku: variant.node.sku,
+                        inventory_quantity: variant.node.inventoryQuantity,
+                        inventory_policy: variant.node.inventoryPolicy,
+                        compare_at_price: variant.node.compareAtPrice,
+                        taxable: variant.node.taxable,
+                        weight: variant.node.inventoryItem?.measurement?.weight ? variant.node.inventoryItem?.measurement.weight.value : null,
+                        weight_unit: variant.node.inventoryItem?.measurement?.weight ? variant.node.inventoryItem?.measurement.weight.unit : null,
+                        image_id: variant.node.media?.nodes?.length > 0 ? this.getIdFromGraphId(variant.node.media.nodes[0].id) : null,
+                        inventory_item_id: this.getIdFromGraphId(variant.node.inventoryItem.id),
+                        option1: variant.node.selectedOptions?.length > 0 ? variant.node.selectedOptions[0].value : null,
+                        option2: variant.node.selectedOptions?.length > 1 ? variant.node.selectedOptions[1].value : null,
+                        option3: variant.node.selectedOptions?.length > 2 ? variant.node.selectedOptions[2].value : null,
+                    } as IVariant)) : []
+                };
+            }
+            Logger.info(`ShopifyProductListService - getById -> ${productToReturn?.id} Products returning`);
+            return productToReturn;
+        } catch (error) { this.logErrorAndThrow(error); }
+    };
+
+    private buildProductsQuery = (publishedStatus: 'any' | 'published' | 'unpublished', daysAgoCreated: number | 'all',  daysAgoUpdated: number | 'all', handle: string, title: string, vendor: string, productType: string, collectionId: number): string => {
+        let queryParams = '';
+        if (publishedStatus === 'published' || publishedStatus === 'unpublished') {
+            queryParams = `published_status:'${publishedStatus}'`;
+        }
+        if (daysAgoCreated && daysAgoCreated !== 'all') {
+            const dayAgoString = moment().add(-daysAgoCreated, 'days').format('YYYY-MM-DDTHH:mm:ss');
+            if (queryParams.length > 0) {
+                queryParams = `${queryParams} AND created_at:>'${dayAgoString}'`;
+            } else {
+                queryParams = `created_at:>'${dayAgoString}'`;
+            }
+        }
+        if (daysAgoUpdated && daysAgoUpdated !== 'all') {
+            const dayAgoUpdatedString = moment().add(-daysAgoUpdated, 'days').format('YYYY-MM-DDTHH:mm:ss');
+            if (queryParams.length > 0) {
+                queryParams = `${queryParams} AND updated_at:>'${dayAgoUpdatedString}'`;
+            } else {
+                queryParams = `updated_at:>'${dayAgoUpdatedString}'`;
+            }
+        }
+        if (handle) {
+            if (queryParams.length > 0) {
+                queryParams = `${queryParams} AND handle:'${handle}'`;
+            } else {
+                queryParams = `handle:'${handle}'`;
+            }
+        }
+        if (title) {
+            if (queryParams.length > 0) {
+                queryParams = `${queryParams} AND title:'${title}'`;
+            } else {
+                queryParams = `title:'${title}'`;
+            }
+        }
+        if (vendor) {
+            if (queryParams.length > 0) {
+                queryParams = `${queryParams} AND vendor:'${vendor}'`;
+            } else {
+                queryParams = `vendor:'${vendor}'`;
+            }
+        }
+        if (productType) {
+            if (queryParams.length > 0) {
+                queryParams = `${queryParams} AND product_type:'${productType}'`;
+            } else {
+                queryParams = `product_type:'${productType}'`;
+            }
+        }
+        if (collectionId) {
+            if (queryParams.length > 0) {
+                queryParams = `${queryParams} AND collection_id:'${collectionId}'`;
+            } else {
+                queryParams = `collection_id:'${collectionId}'`;
+            }
+        }
+        return queryParams;
+    };
+
+    private buildProductsGraphQL = (numOfProducts: number | 'all', queryParams: string, nextCursor: string, options: { add_variants?: boolean; add_weight?: boolean; add_body_html?: boolean; add_title?: boolean; add_images?: boolean; add_tags?: boolean; add_options?: boolean; }): string => {
+        const productsQuery = `{ products(first: ${numOfProducts !== 'all' && numOfProducts < 100 ? numOfProducts : 100} ${queryParams !== '' ? `, query: "${queryParams}"` : ''} ${nextCursor !== '' && nextCursor !== null ? `, after: "${nextCursor}"` : ''})  {
+            pageInfo {  endCursor hasNextPage }
+            edges {
+                node {
+                    id
+                    ${options.add_body_html === false ? '' : 'descriptionHtml'}
+                    ${options.add_title === false ? '' : 'title'}
+                    vendor
+                    productType
+                    createdAt
+                    updatedAt
+                    publishedAt
+                    handle
+                    status
+                    ${options.add_images === false ? '' : 'images(first: 20) { edges { node { id url } } }'}
+                    ${options.add_tags === false ? '' : 'tags'}
+                    ${options.add_options === false ? '' : 'options { name position optionValues { name } }'}
+                    ${options.add_variants === false ? '' : `variants(first: 150) {
+                        edges {
+                            node {
+                                id
+                                price
+                                sku
+                                availableForSale
+                                inventoryQuantity
+                                inventoryPolicy
+                                taxable
+                                compareAtPrice
+                                ${options.add_images === false ? '' : 'image { id url }'}
+                                ${options.add_options === false ? '' : 'selectedOptions { name value }'}
+                                inventoryItem {
+                                    id
+                                    ${options.add_weight === false ? '' : 'measurement { weight { unit value } }'}
+                                    tracked
+                                    unitCost {
+                                        amount
+                                    }
+                                }
+                            }
+                        }
+                    }` } 
+                }
+            }
+        } }`;
+        return productsQuery;
+    };
+}