@sommpicks/sommpicks-shopify 24.12.7 → 24.12.9

package/shopify/router/ShopifyRouter.ts

@@ -16,12 +16,41 @@ export class ShopifyRouter {
     }
 
     public buildRoutes(): express.Router {
+        //initial call to /shopify
         router.get('/', async (req,res,next) => {
+            Logger.info(`ShopifyRouter - request: ${req}`);
+            try {
+                if (process && process.env && process.env.SP_ROUTER_DEBUG === '1') {
+                    // eslint-disable-next-line no-console
+                    console.info('[sommpicks-shopify][ShopifyRouter][/shopify request]', {
+                        method: req.method,
+                        path: (req as any).path,
+                        query: (req as any).query,
+                        headers: { 'sec-fetch-dest': (req as any).headers?.['sec-fetch-dest'] }
+                    });
+                }
+            } catch { /* ignore debug logging errors */ }
             const scopes = await this.getScopes(req.query.shop as string);
+            Logger.info(`ShopifyRouter - scopes: ${scopes}`);
             res.locals.scopes = scopes;
             next();
         }, this.installRoute);
+        // endpoint when merchant accepts the installation
         router.get('/callback', this.callBackRoute);
+        router.get('/auth/callback', this.callBackRoute);
+        Logger.info('build routes was hit!');
+        try {
+            if (process && process.env && process.env.SP_ROUTER_DEBUG === '1') {
+                const r: any = router as any;
+                const routes = Array.isArray(r?.stack)
+                    ? r.stack
+                        .filter((l: any) => l && l.route)
+                        .map((l: any) => ({ path: l.route.path, methods: Object.keys(l.route.methods || {}) }))
+                    : [];
+                // eslint-disable-next-line no-console
+                console.info('[sommpicks-shopify][ShopifyRouter][routes]', routes);
+            }
+        } catch { /* ignore debug logging errors */ }
         return router;
     }
 
@@ -32,17 +61,23 @@ export class ShopifyRouter {
         const hmac = expresRequest.query.hmac as string;
         const code = expresRequest.query.code as string;
         const host = expresRequest.query.host as string;
+        Logger.info('we are using the updated version');
+        console.log('we are console logging the updated version');
         Logger.info(`ShopifyRouter - callBackRoute From shopify ${code}`);
         if (shop && hmac && code) {
             const map = Object.assign({}, expresRequest.query);
             delete map['signature'];
             delete map['hmac'];
             const secFetchDest = req.headers['sec-fetch-dest'];
-            const message = querystring.stringify(map as any);
+            const sortedKeys = Object.keys(map).sort();
+            const sortedMap: any = {};
+            sortedKeys.forEach(key => sortedMap[key] = map[key]);
+            const message = querystring.stringify(sortedMap);
 
             const hashEquals = this.cryptoService.checkHash(this.cryptoService.generateHash(message, this.shop_secret), hmac);
             if (!hashEquals) { expresResponse.status(401).send('HMAC validation failed'); return; }
             Logger.info(`getOathToken From shopify ${code}`);
+            // we send the key and secret to get the access token back
             OauthService.getOathToken(shop, this.shop_key, this.shop_secret, code,
                 (accessToken: string) => {
                     this.callback(accessToken, shop, host, expresResponse, secFetchDest === 'iframe', null);
@@ -62,10 +97,13 @@ export class ShopifyRouter {
         const scopes = res.locals.scopes;
         const shop = expresRequest.query.shop as string;
         const host = expresRequest.query.host;
+        Logger.info(`install route: request: ${expresRequest}, response: ${expresResponse}, scopes: ${scopes}, shop: ${shop}, host ${host}`);
         if (shop) {
+            // when the shopify session expires we render a page on the embedded app that loads the auth URL to refresh the token
             if(!expresRequest.query.session) {
                 expresResponse.render('session_expire', { redirectUrl: this.installUrl(shop, scopes) });
             } else {
+                // we send the session exists the app is installed. we redirect to BillingRoutes with status=already_accepted
                 expresResponse.redirect(`${this.appBaseUrl}/billing/created?host=${host}&shop=${shop}&status=already_accepted`);
             }
         } else {
@@ -74,12 +112,44 @@ export class ShopifyRouter {
     };
 
     private installUrl(shop: string, scopes: string): string {
-        return `https://${shop}/admin/oauth/authorize?client_id=${this.shop_key}&scope=${scopes}&redirect_uri=${this.redirectUri()}`;
+        // this URL is used to install the app. you can get it and run it on the browser, it should install the app
+        Logger.info(`installURL shop: ${shop}`);
+        // Explicitly request offline (permanent) access tokens
+        return `https://${shop}/admin/oauth/authorize?client_id=${this.shop_key}&scope=${scopes}&redirect_uri=${this.redirectUri()}&access_mode=offline`;
     }
 
     private redirectUri(): string {
+        // the callback for when the merchant has approved the request
         return `${this.appBaseUrl}${this.endpointUri}/callback`;
     }
 }
 
+// Debug export and router shape when enabled via env
+try {
+    if (process && process.env && process.env.SP_ROUTER_DEBUG === '1') {
+        const exportMeta = {
+            classType: typeof ShopifyRouter,
+            className: (ShopifyRouter as any)?.name,
+            prototypeMethods: Object.getOwnPropertyNames((ShopifyRouter as any)?.prototype || {}).filter(m => m !== 'constructor')
+        };
+        // eslint-disable-next-line no-console
+        console.info('[sommpicks-shopify][ShopifyRouter][export-meta]', exportMeta);
+
+        const r: any = router as any;
+        const routerMeta = {
+            type: typeof router,
+            isMiddleware: typeof router === 'function',
+            keys: Object.keys(r || {}),
+            stackLength: Array.isArray(r?.stack) ? r.stack.length : undefined,
+            props: {
+                caseSensitive: r?.caseSensitive,
+                mergeParams: r?.mergeParams,
+                strict: r?.strict
+            }
+        };
+        // eslint-disable-next-line no-console
+        console.info('[sommpicks-shopify][ShopifyRouter][express-router-meta]', routerMeta);
+    }
+} catch { /* ignore debug logging errors */ }
+
 export default ShopifyRouter;

package/tsconfig.json

@@ -4,6 +4,8 @@
         "target": "es6",
         "module": "commonjs",
         "sourceMap": true,
+        "inlineSources": true,
+        "declarationMap": true,
         "typeRoots": ["./node_modules/@types", "./typings"],
         "declaration": true
     }