@sommpicks/sommpicks-shopify 24.12.0

package/Logger.ts

@@ -0,0 +1,18 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+export class Logger {
+    public static enableLogging = true;
+
+    public static error: any = (...args) => {
+        if(Logger.enableLogging) {
+            Logger._error(args);
+        }
+    }; 
+    public static info: any = (...args) => {
+        if(Logger.enableLogging) {
+            Logger._info(args);
+        }
+    };
+
+    public static _error: any = (...args) => {}; 
+    public static _info: any = (...args) => {}; 
+}

package/README.md

@@ -0,0 +1,258 @@
+# inspira-shopify
+
+Shopify Rest API calls utility
+
+## HOW TO USE
+
+```
+
+npm install --save inspira-shopify
+```
+
+### Use shopify rest calls
+
+```js
+
+import ShopifyRest from 'inspira-shopify';
+
+
+const inspiraShopify = new ShopifyRest('<your shop>.myshopify.com','<shopify token>');
+
+//Override default options
+const inspiraShopify = new ShopifyRest('<your shop>.myshopify.com','<shopify token>', {timeout:4000, retries: 3, debug: true, logger: mylogger});
+
+//Create a customer example
+inspiraShopify.customer.create(
+    {email:'wakeeekm@gmail.com', verified_email: true, first_name:'hweweji', last_name:'eqwewwert', phone:'07470874486'})
+    .catch((err) => { console.log( err)} )
+    .then((result) => { console.log(result)});
+
+```
+
+### Use shopify express Router
+
+Set shopify endpoints for installing your app.
+
+```js
+
+import { Router } from 'inspira-shopify';
+
+...
+
+const app = express();
+
+...
+
+function callback(token, shop, response, err) {
+    //manage your shopify token and send response to the client
+    if(err) { console.error(err)}
+    response.sendFile( ... );
+}
+
+app.use('/shopify', new Router( 'secret', 'key', 'scopes', 'app base url', callback).buildRoutes());
+
+```
+
+### Use Hmac utilities.
+
+```js
+
+import { HmacUtils } from 'inspira-shopify';
+
+...
+
+router.post('/<someendpoint>', HmacUtils.jsonWebhookParser, async (req, res) => {
+    const isHmacOk = await HmacUtils.checkHmac(req, 'SHOPIFY_SECRET');
+    if(!isHmacOk) throw 'Hmac not correct';
+    ...
+});
+
+...
+
+```
+
+### Cache Shopify Calls
+
+```js
+
+import { RestCacheWrapper } from 'inspira-shopify';
+
+...
+private static methodCached = new RestCacheWrapper<Response Type>(<Items to holds in cache>, <Shopify rest method to be cached>);
+
+await methodCached.execute(...args);
+...
+
+```
+
+### SHOPIFY REST OPTIONS
+
+- **timeout**(ms): timeout while perfoming rest call. Default is 3000.
+- **retries**: How many times will the call tried. It will retry when it is a network error or a 5xx error.
+- **debug**: When debug is set to true it will log debug data. You must specify a logger.
+- **logger**: Logger object used for logging data.
+
+And example of a logger can be:
+
+```js
+
+//using console for building my logger 
+const mylogger = {error: console.error, info: console.log};
+
+new ShopifyRest('<your shop>.myshopify.com','<shopify token>', {timeout:4000, retries: 3, debug: true, logger: mylogger})
+```
+## HOW TO PUBLISH
+
+Push a change with a new version set in package.json and bitbucket pipeline will automatically publish a new npm package.
+
+**NOTE:** To understand when the version number needs to change refer to [npm documentation](https://docs.npmjs.com/getting-started/semantic-versioning)
+
+## Functionalities
+
+- Customers 
+     - getInBatch
+     - getById
+     - getByEmail
+     - getByTag
+     - getByLastNameContains
+     - addAddress
+     - removeAddress
+     - updateAddress
+     - addressAsDefault
+     - replacesAddressAsDefault
+     - addAddressAsDefault
+     - create
+     - update
+     - get(numOfCustomers)
+     - getMetafields
+     - getMetafield
+     - postMetafield
+     - deleteMetafield
+     - sendInvite
+- Inventory
+     - setItemToTrackable
+     - setQuantity
+     - getLevel
+     - getInventoryItemsOfProduct
+     - adjustQuantityOfInventoryItem
+     - adjustQuantity
+     - setItemCostAndSkuToBe
+     - setItemCostToBe
+     - getInventoryLevelsOfProduct
+- Draft Order
+     - create
+     - createAndSendInvoice
+     - updateShippingAddress
+     - createFromCart
+     - fromCartToDraft
+- Order
+     - getFulfillments
+     - createFulfillments
+     - completeFulfillment
+     - openFulfillment
+     - cancelFulfillment
+     - fulfillAllItems
+     - getById
+     - addAdditionalAttribute
+     - setTags
+     - getAll
+     - getInBatch
+     - create
+     - applyWeightAndCountryBasedShippingToOrder
+     - getShippingByWeight
+     - updateShippingAddress
+     - getAvailableShippingRatesByAddress
+     - getAvailableShippingRatesByCustomerDefaultAddress
+     - applyShippingToOrder
+     - duplicate
+- OrderRisks
+     - getFromOrderById 
+- OrderRefunds
+     - getOrderRefunds
+     - createRefunds 
+- Product
+     - getAll
+     - getByTitle
+     - getByHandle
+     - getByProductType
+     - getById
+     - getCount
+     - getCountByPusblishedStatus
+     - update
+     - create
+     - delete
+     - publish
+     - unPublish
+     - get(numOfProducts)
+     - getMetafields
+     - getMetafield
+     - saveOrUpdateMetafield
+     - saveOrAddToMetafield
+     - deleteMetafield
+     - deleteMetafieldsByNamespace
+     - getUnpublishedInBatch
+     - getPublishedInBatchAfterDay
+     - getInBatch
+- Variant
+     - create
+     - update
+     - getCount
+     - getMetafields
+     - saveOrUpdateMetafield
+     - getMetafield
+     - getById
+     - delete
+     - deleteMetafieldByKey
+     - deleteMetafield
+     - deleteMetafieldByKeys
+- Webhook
+     - deleteAll
+     - delete (By ID)
+     - create
+     - getAll
+     - deleteByTopic
+     - updateWebhooksAPI
+- Fulfillment Service
+     - create
+     - getAll
+     - addTrackingInfoToFulfillment
+- Shop
+     - ShopDetails
+     - getShippingRates
+- Collections
+     - create
+     - createCollect
+     - getAll (limit 250)
+     - delete
+     - removeCollects (With TimerQueue)
+- Themes
+     - getAll (limit 250)
+     - getMainTheme (returns null if no theme has been found)
+- Template
+     - get
+     - put
+- Assets
+     - put
+- Locations
+     - getAll
+- Pages
+     - post
+     - put
+     - postMetafields
+- Discounts
+     - getPercentageDiscountCodeForItem
+     - getFixedDiscountCodeForOrder
+     - removeDiscount
+- Billing
+     - cancelBilling
+     - requestBilling
+     - getRecurringApplicationCharge
+     - getApplicationCharge
+     - singlePayment
+     - addUsage
+- Shopify express route needed for installing the App.
+- Shopify Hmac validation utilities.
+- Shopify Rest Utils.
+- Cache functionality.
+
+

package/addTypings.sh

@@ -0,0 +1,2 @@
+echo '/// <reference path="../typings/index.d.ts"/>' > $PWD/dist/indexBuild.d.ts
+cat $PWD/dist/index.d.ts >> $PWD/dist/indexBuild.d.ts

package/bitbucket-pipelines.yml

@@ -0,0 +1,38 @@
+image: node:20
+
+pipelines:
+  branches:
+    master:
+      - step:
+          caches:
+            - node
+          script:
+            - npm install
+            - npm run lint
+      - step:
+          caches:
+            - node
+          script:
+            - npm install
+            - npm test
+      - step:
+          caches:
+            - node
+          script:
+            - npm install
+            - npm run build
+            - sh publish.sh
+    releaseBetaChannel:
+      - step:
+          caches:
+            - node
+          script:
+            - npm install
+            - npm test
+      - step:
+          caches:
+            - node
+          script:
+            - npm install
+            - npm run build
+            - sh publish.sh

package/index.ts

@@ -0,0 +1,132 @@
+import CacheWrapper from  './services/CacheWrapper';
+import HmacValidator from './shopify/router/services/HmacValidator';
+import { Logger } from './Logger';
+import RestUtils from './shopify/router/services/RestUtils';
+import { ShopifyAssetService } from './shopify/ShopifyAssetService';
+import { ShopifyBillingService } from './shopify/ShopifyBillingService';
+import { ShopifyCollectionService } from './shopify/ShopifyCollectionService';
+import { ShopifyCustomerService } from './shopify/ShopifyCustomerService';
+import { ShopifyDraftOrderService } from './shopify/ShopifyDraftOrderService';
+import { ShopifyFulfillmentService } from './shopify/ShopifyFulfillmentService';
+import { ShopifyInventoryService } from './shopify/ShopifyInventoryService';
+import { ShopifyLocationService } from './shopify/ShopifyLocationService';
+import { ShopifyMandatoryRouter } from './shopify/router/ShopifyMandatoryRouter';
+import { ShopifyOrderRiskService } from './shopify/ShopifyOrderRiskService';
+import { ShopifyOrderService } from './shopify/ShopifyOrderService';
+import { ShopifyPageService } from './shopify/ShopifyPageService';
+import { ShopifyProductService } from './shopify/ShopifyProductService';
+import { ShopifyShopService } from './shopify/ShopifyShopService';
+import { ShopifyTemplateService } from './shopify/ShopifyTemplateService';
+import { ShopifyThemeService } from './shopify/ShopifyThemeService';
+import { AxiosInstanceExtended, ShopifyUtils } from './shopify/ShopifyUtils';
+import { ShopifyWebhookService } from './shopify/ShopifyWebhookService';
+import StoreRateLimiter from './shopify/router/services/rateLimiter/StoreRateLimiter';
+import { ShopifyDiscountService } from './shopify/ShopifyDiscountService';
+import { ShopifyOrderRefundsService } from './shopify/ShopifyOrderRefundsService';
+import WebhookSkipMiddleware from './shopify/router/WebhookSkipMiddleware';
+import InspiraShopifyUnableToReserveInventoryError from './shopify/errors/InspiraShopifyUnableToReserveInventoryError';
+import { ShopifyRouter } from './shopify/router/ShopifyRouter';
+import ShopifyRouterBis from './shopify/router/ShopifyRouterBis';
+import ShopifyRouterBisBis from './shopify/router/ShopifyRouterBisBis';
+import ShopifyRouterBisBisBis from './shopify/router/ShopifyRouterBisBisBis';
+import ShopifyRouterBisBisBisBis from './shopify/router/ShopifyRouterBisBisBisBis';
+import { ShopifyDeliveryCustomisationService } from './shopify/ShopifyDeliveryCustomisationService';
+import { ShopifyShippingZonesService } from './shopify/ShopifyShippingZonesService';
+import { ShopifyCartTrasnformationService } from './shopify/ShopifyCartTrasnformationService';
+import { ShopifyFunctionsProductDiscountsService } from './shopify/ShopifyFunctionsProductDiscountsService';
+import { ShopifyAppService } from './shopify/ShopifyAppService';
+
+export interface ILogger { 
+    error: (...restOfName: any[]) => void;
+    info:  (...restOfName: any[]) => void;
+}
+
+export interface IRest_Options { timeout: number, retries: number, logger: ILogger, debug: boolean; max_requests_per_sec: number; enableCache: boolean; cacheTimeInMiliseconds: number; }
+
+export default class ShopifyRest {
+    public customer: ShopifyCustomerService;
+    public inventory: ShopifyInventoryService;
+    public order: ShopifyOrderService;
+    public product: ShopifyProductService;
+    public webhook: ShopifyWebhookService;
+    public fulfillment: ShopifyFulfillmentService;
+    public store: ShopifyShopService;
+    public collections: ShopifyCollectionService;
+    public themes: ShopifyThemeService;
+    public templates: ShopifyTemplateService;
+    public assets: ShopifyAssetService;
+    public billing: ShopifyBillingService;
+    public draftOrders: ShopifyDraftOrderService;
+    public locations: ShopifyLocationService;
+    public orderRisks: ShopifyOrderRiskService;
+    public shippingZonesService: ShopifyShippingZonesService;
+    public pages: ShopifyPageService;
+    public app: ShopifyAppService;
+    public discounts: ShopifyDiscountService;
+    public refunds: ShopifyOrderRefundsService;
+    public shopifyDeliveryCustomisationService: ShopifyDeliveryCustomisationService;
+    public shopifyCartTrasnformationService: ShopifyCartTrasnformationService;
+    public shopifyFunctionsProductDiscountsService: ShopifyFunctionsProductDiscountsService;
+
+    private instance: AxiosInstanceExtended = null;
+
+
+    constructor(shop: string, token: string, privateAppApiKey: string, privateAppPassword: string, options: IRest_Options) {
+        if (options) {
+            if(options.debug) {
+                if(!options.logger) throw 'If debug mode is on then a looger must be set into options';
+                Logger._error = options.logger.error;
+                Logger._info = options.logger.info;
+            }
+        }
+        const instance = ShopifyUtils.getAxiosInstance(shop, token, privateAppApiKey, privateAppPassword, options);
+        this.customer = new ShopifyCustomerService(instance);
+        this.inventory = new ShopifyInventoryService(instance);
+        this.order = new ShopifyOrderService(instance);
+        this.product = new ShopifyProductService(instance);
+        this.webhook = new ShopifyWebhookService(instance);
+        this.fulfillment = new ShopifyFulfillmentService(instance);
+        this.store = new ShopifyShopService(instance);
+        this.collections = new ShopifyCollectionService(instance);
+        this.themes = new ShopifyThemeService(instance);
+        this.templates = new ShopifyTemplateService(instance);
+        this.assets = new ShopifyAssetService(instance);
+        this.billing = new ShopifyBillingService(instance);
+        this.draftOrders = new ShopifyDraftOrderService(instance);
+        this.locations = new ShopifyLocationService(instance);
+        this.orderRisks = new ShopifyOrderRiskService(instance);
+        this.pages = new ShopifyPageService(instance);
+        this.app = new ShopifyAppService(instance);
+        this.discounts = new ShopifyDiscountService(instance);
+        this.refunds = new ShopifyOrderRefundsService(instance);
+        this.shippingZonesService = new ShopifyShippingZonesService(instance);
+        this.shopifyDeliveryCustomisationService = new ShopifyDeliveryCustomisationService(instance);
+        this.shopifyCartTrasnformationService = new ShopifyCartTrasnformationService(instance);
+        this.shopifyFunctionsProductDiscountsService = new ShopifyFunctionsProductDiscountsService(instance);
+        this.instance = instance;
+    }
+
+    /**
+     * Enables or disables logging.
+     */
+    public logging = async (enable: boolean): Promise<void> => {
+        Logger.enableLogging = enable;
+    };
+
+    public getQueueInfo = () => {
+        return this.instance.getQueueInfo();
+    };
+}
+
+export const Router = ShopifyRouter;
+export const RouterBis = ShopifyRouterBis;
+export const RouterBisBis = ShopifyRouterBisBis;
+export const RouterBisBisBis = ShopifyRouterBisBisBis;
+export const RouterBisBisBisBis = ShopifyRouterBisBisBisBis;
+export const MandatoryRoutes = ShopifyMandatoryRouter;
+export const HmacUtils = HmacValidator;
+export const ShopifyRestUtils = RestUtils;
+export const RestCacheWrapper = CacheWrapper; 
+export const RateLimiter = StoreRateLimiter;
+export const ShopifyWebhookSkipMiddleware = WebhookSkipMiddleware;
+export const Error_InspiraShopifyUnableToReserveInventoryError = InspiraShopifyUnableToReserveInventoryError;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@sommpicks/sommpicks-shopify",
+  "version": "24.12.0",
+  "publishConfig": { "access": "restricted" },
+  "description": "Shopify REST API & GraphQL calls",
+  "main": "dist/index.js",
+  "types": "dist/indexBuild.d.ts",
+  "scripts": {
+    "test": "jest --runInBand --forceExit --verbose",
+    "test-file": "jest --runInBand --forceExit  --verbose --colors ShopifyWebhookService.test.ts",
+    "build": "rm -rf dist && tsc -p . && sh addTypings.sh",
+    "lint": "eslint -c .eslintrc.js --ext .ts,.tsx ./"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://kimy82@bitbucket.org/inspiradigital/inspira-shopify.git"
+  },
+  "author": "Inspira Digital",
+  "license": "ISC",
+  "homepage": "https://bitbucket.org/inspiradigital/inspira-shopify#readme",
+  "dependencies": {
+    "@sommpicks/sommpicks-shopify-rate-limit": "^2.0.0",
+    "axios-cache-interceptor": "^1.5.1",
+    "axios": "^1.6.8",
+    "axios-retry": "^4.1.0",
+    "express": "^4.17.2",
+    "graphql": "^15.4.0",
+    "graphql-tag": "^2.11.0",
+    "moment": "^2.29.1",
+    "parse-link-header": "^2.0.0",
+    "querystring": "^0.2.0",
+    "timer-queue": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.2",
+    "@types/jest": "^29.5.1",
+    "@types/node": "^20.0.0",
+    "@types/parse-link-header": "^1.0.0",
+    "@types/sinon-express-mock": "^1.3.5",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "eslint": "^8.51.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^4.6.2"
+  },
+  "jest": {
+    "verbose": true,
+    "testURL": "http://localhost/",
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(ts)$",
+    "preset": "ts-jest",
+    "moduleFileExtensions": [
+      "js",
+      "ts"
+    ]
+  }
+}

package/publish.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Extract package information using Node.js
+PACKAGE_VERSION=$(node -e "console.log(require('./package.json').version)")
+IS_BETA=$(node -e "console.log(require('./package.json').version.includes('beta'))")
+PACKAGE_NAME=$(node -e "console.log(require('./package.json').name)")
+
+# Check if the package version already exists on npm
+if npm show "$PACKAGE_NAME@$PACKAGE_VERSION" 2>/dev/null; then
+  echo "Skipping publish, package $PACKAGE_NAME@$PACKAGE_VERSION already published"
+else
+  # Conditional publishing based on beta flag
+  if [ $IS_BETA = "true" ]; then
+    echo "Publishing version $PACKAGE_VERSION in channel Beta" 
+    npm publish --tag beta 
+  else
+    echo "Publishing version $PACKAGE_VERSION in channel Prod" 
+    npm publish 
+  fi
+fi

package/services/CacheWrapper.ts

@@ -0,0 +1,30 @@
+export default class CacheWrapper<T> {
+    
+    private records: Map<string, any> = new Map<string, any>();
+
+    constructor(private maxSize: number, private call: any) { }
+
+    public execute = async (...args): Promise<T> => {
+        return new Promise<T> ((resolve) => {
+            const key = args[0];
+            if(this.records.has(key)){
+                resolve(this.records.get(key));
+                return;
+            }         
+            const value = this.call.apply(null, args);
+            this.clearEntry();
+            this.records.set(key, value);
+            resolve(value);
+        });
+    };
+
+    public clear = () => {
+        this.records.clear();
+    };
+
+    public clearEntry = () => {
+        if(this.records.size > this.maxSize) {
+            this.records.delete(this.records.keys().next().value);
+        }
+    };
+}