initial commit

Author: tolgap

.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.env.example

@@ -0,0 +1,6 @@
+SHOPIFY_API_KEY=
+SHOPIFY_API_SECRET=
+SHOP=
+HOST=
+REDIS_HOST=localhost
+REDIS_PORT=6379

.eslintrc.json

@@ -0,0 +1,35 @@
+{
+  "root": true,
+  "ignorePatterns": ["**/*"],
+  "plugins": ["@nrwl/nx"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {
+        "@nrwl/nx/enforce-module-boundaries": [
+          "error",
+          {
+            "enforceBuildableLibDependency": true,
+            "allow": [],
+            "depConstraints": [
+              {
+                "sourceTag": "*",
+                "onlyDependOnLibsWithTags": ["*"]
+              }
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "extends": ["plugin:@nrwl/nx/typescript"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "extends": ["plugin:@nrwl/nx/javascript"],
+      "rules": {}
+    }
+  ]
+}

.gitignore

@@ -0,0 +1,41 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+
+# dependencies
+node_modules
+/.env
+*.sqlite3
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db

.node-version

@@ -0,0 +1 @@
+16.15

.prettierignore

@@ -0,0 +1,4 @@
+# Add files here to ignore them from prettier formatting
+
+/dist
+/coverage

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "nrwl.angular-console",
+    "esbenp.prettier-vscode",
+    "firsttris.vscode-jest-runner",
+    "dbaeumer.vscode-eslint"
+  ]
+}

README.md

@@ -0,0 +1,61 @@
+# Example @nestjs-shopify/@nestjs-shopify application
+
+Uses [NX monorepo](https://nx.dev) under the hood. An example Shopify application
+with a [NestJS](https://nestjs.com) API backend, and a [NextJS](https://nextjs.org) frontend.
+
+## Architecture
+
+The NestJS `api` application is proxied via NX proxies to `/api`. The `api` application also contains
+a global prefix to `/api`.
+
+Because we use NX proxies, we basically disable the usage of NextJS API requests in the `pages/api` folder because the requests are always proxied to the backend.
+
+This application uses [Mikro-ORM](https://mikro-orm.io) for it's database. When performing offline auth, the authenticated shop gets inserted into the `shops` table with an offline token. This token can then be used for webhook/background operations.
+
+## Setup
+
+Install dependencies
+
+```
+npm install
+```
+
+Copy the example environment variables and fill in yours:
+
+```
+cp .env.example .env
+```
+
+The `HOST` env var should be your full Ngrok URL eg: https://7c350f27f75f.ngrok.io
+
+Run the migrations:
+
+```
+cd apps/api
+npx mikro-orm schema:update -r
+```
+
+## Running
+
+On terminal window 1:
+
+```
+npx nx run api:serve
+```
+
+On terminal window 2:
+
+```
+npx nx run web:serve
+```
+
+Visit `https://<HOST>/?shop=<SHOP>` to start the OAuth installation procedure of your app.
+
+## Authentication with Shopify
+
+The application allows for both Online and Offline authentication. But Shopify recommends using
+`offline` auth for only installing your application, and `online` auth for loading data in your frontend.
+
+The `ProductsController` in this application that returns the total product count in Shopify, utilizes `@ShopifyOnlineAuth()` decorator. That signals our application to look for online JWT tokens when calling the `GET /api/products/count` route.
+
+The frontend utilizes `@shopify/app-bridge` to transparently fetch online tokens for us using the `userLoggedInfetch` helper function.

apps/api/.env

@@ -0,0 +1 @@
+PORT=8080

apps/api/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/api/db/mikro-orm.config.ts

@@ -0,0 +1,17 @@
+import { Options } from '@mikro-orm/core';
+import { ShopEntity } from '../src/app/shops/shop.entity';
+import path from 'path';
+
+const baseDir = path.resolve(__dirname, '../../..');
+
+const config: Options = {
+  entities: [ShopEntity],
+  baseDir,
+  type: 'sqlite',
+  forceUtcTimezone: true,
+  timezone: 'Europe/Amsterdam',
+  dbName: 'api.sqlite3',
+  debug: true,
+};
+
+export default config;

apps/api/jest.config.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+  displayName: 'api',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/apps/api',
+};

apps/api/project.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/api/src",
+  "projectType": "application",
+  "targets": {
+    "build": {
+      "executor": "@nrwl/node:webpack",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/apps/api",
+        "main": "apps/api/src/main.ts",
+        "tsConfig": "apps/api/tsconfig.app.json"
+      },
+      "configurations": {
+        "production": {
+          "optimization": true,
+          "extractLicenses": true,
+          "inspect": false,
+          "fileReplacements": [
+            {
+              "replace": "apps/api/src/environments/environment.ts",
+              "with": "apps/api/src/environments/environment.prod.ts"
+            }
+          ]
+        }
+      }
+    },
+    "serve": {
+      "executor": "@nrwl/node:node",
+      "options": {
+        "buildTarget": "api:build"
+      },
+      "configurations": {
+        "production": {
+          "buildTarget": "api:build:production"
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["apps/api/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/apps/api"],
+      "options": {
+        "jestConfig": "apps/api/jest.config.ts",
+        "passWithNoTests": true
+      }
+    }
+  },
+  "tags": []
+}

apps/api/src/app/app.module.ts

@@ -0,0 +1,41 @@
+import { MikroOrmModule } from '@mikro-orm/nestjs';
+import {
+  ShopifyAuthOfflineModule,
+  ShopifyAuthOnlineModule,
+} from '@nestjs-shopify/auth';
+import { ShopifyCoreModule } from '@nestjs-shopify/core';
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { databaseConfig } from './config/database.config';
+import { ExceptionFiltersModule } from './exception-filters/exception-filters.module';
+import { ProductsModule } from './products/products.module';
+import { AfterAuthModule } from './shopify/after-auth/after-auth.module';
+import {
+  shopifyCoreConfig,
+  shopifyOfflineConfig,
+  shopifyOnlineConfig,
+} from './shopify/config';
+import { ShopifyOfflineConfigService } from './shopify/services/shopify-offline-config.service';
+import { ShopifyOnlineConfigService } from './shopify/services/shopify-online-config.service';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      cache: true,
+      isGlobal: true,
+    }),
+    MikroOrmModule.forRootAsync(databaseConfig.asProvider()),
+    ShopifyCoreModule.forRootAsync(shopifyCoreConfig.asProvider()),
+    ShopifyAuthOfflineModule.forRootAsync({
+      imports: [ConfigModule.forFeature(shopifyOfflineConfig), AfterAuthModule],
+      useClass: ShopifyOfflineConfigService,
+    }),
+    ShopifyAuthOnlineModule.forRootAsync({
+      imports: [ConfigModule.forFeature(shopifyOnlineConfig), AfterAuthModule],
+      useClass: ShopifyOnlineConfigService,
+    }),
+    ExceptionFiltersModule,
+    ProductsModule,
+  ],
+})
+export class AppModule {}

apps/api/src/app/config/database.config.ts

@@ -0,0 +1,13 @@
+import { MikroOrmModuleOptions } from '@mikro-orm/nestjs';
+import { Logger } from '@nestjs/common';
+import { registerAs } from '@nestjs/config';
+import config from '../../../db/mikro-orm.config';
+
+const logger = new Logger('MikroORM');
+export const getDatabaseConfig = (): MikroOrmModuleOptions => ({
+  ...config,
+  dbName: 'apps/api/api.sqlite3',
+  logger: logger.log.bind(logger),
+});
+
+export const databaseConfig = registerAs('database', getDatabaseConfig);

apps/api/src/app/exception-filters/all.exception-filter.ts

@@ -0,0 +1,21 @@
+import {
+  ShopifyAuthException,
+  ShopifyAuthExceptionFilter,
+} from '@nestjs-shopify/auth';
+import { ArgumentsHost, Catch } from '@nestjs/common';
+import { BaseExceptionFilter } from '@nestjs/core';
+
+@Catch()
+export class AllExceptionFilter extends BaseExceptionFilter {
+  constructor(private readonly shopifyFilter: ShopifyAuthExceptionFilter) {
+    super();
+  }
+
+  catch(exception: unknown, host: ArgumentsHost) {
+    if (exception instanceof ShopifyAuthException) {
+      return this.shopifyFilter.catch(exception, host);
+    }
+
+    return super.catch(exception, host);
+  }
+}

apps/api/src/app/exception-filters/exception-filters.module.ts

@@ -0,0 +1,15 @@
+import { ShopifyAuthExceptionFilter } from '@nestjs-shopify/auth';
+import { Module } from '@nestjs/common';
+import { APP_FILTER } from '@nestjs/core';
+import { AllExceptionFilter } from './all.exception-filter';
+
+@Module({
+  providers: [
+    ShopifyAuthExceptionFilter,
+    {
+      provide: APP_FILTER,
+      useClass: AllExceptionFilter,
+    },
+  ],
+})
+export class ExceptionFiltersModule {}