@vendure/create 2.0.0-next.9 → 2.0.1

package/assets/.env.hbs

@@ -0,0 +1,14 @@
+APP_ENV=dev
+COOKIE_SECRET={{ cookieSecret }}
+SUPERADMIN_USERNAME={{{ escapeSingle superadminIdentifier }}}
+SUPERADMIN_PASSWORD={{{ escapeSingle superadminPassword }}}
+{{#if requiresConnection}}
+DB_HOST={{ dbHost }}
+DB_PORT={{ dbPort }}
+DB_NAME={{{ escapeSingle dbName }}}
+DB_USERNAME={{{ escapeSingle dbUserName }}}
+DB_PASSWORD={{{ escapeSingle dbPassword }}}
+{{/if}}
+{{#if dbSchema}}
+DB_SCHEMA={{ dbSchema }}
+{{/if}}

package/assets/Dockerfile.hbs

@@ -0,0 +1,9 @@
+FROM node:16
+
+WORKDIR /usr/src/app
+
+COPY package.json ./
+COPY {{#if useYarn}}yarn.lock{{else}}package-lock.json{{/if}} ./
+RUN {{#if useYarn}}yarn{{else}}npm install{{/if}} --production
+COPY . .
+RUN {{#if useYarn}}yarn{{else}}npm run{{/if}} build

package/assets/docker-compose.hbs

@@ -0,0 +1,39 @@
+version: "3"
+services:
+  server:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - 3000:3000
+    command: [{{#if useYarn}}"yarn"{{else}}"npm", "run"{{/if}}, "start:server"]
+    volumes:
+      - /usr/src/app
+    environment:
+      DB_HOST: database
+      DB_PORT: 5432
+      DB_NAME: vendure
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+  worker:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    command: [{{#if useYarn}}"yarn"{{else}}"npm", "run"{{/if}}, "start:worker"]
+    volumes:
+      - /usr/src/app
+    environment:
+      DB_HOST: database
+      DB_PORT: 5432
+      DB_NAME: vendure
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+  database:
+    image: postgres
+    volumes:
+      - /var/lib/postgresql/data
+    ports:
+      - 5432:5432
+    environment:
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: vendure

package/assets/environment.d.hbs

@@ -0,0 +1,24 @@
+export {};
+
+// Here we declare the members of the process.env object, so that we
+// can use them in our application code in a type-safe manner.
+declare global {
+    namespace NodeJS {
+        interface ProcessEnv {
+            APP_ENV: string;
+            COOKIE_SECRET: string;
+            SUPERADMIN_USERNAME: string;
+            SUPERADMIN_PASSWORD: string;
+            {{#if requiresConnection}}
+            DB_HOST: string;
+            DB_PORT: number;
+            DB_NAME: string;
+            DB_USERNAME: string;
+            DB_PASSWORD: string;
+            {{/if}}
+            {{#if dbSchema}}
+            DB_SCHEMA: string;
+            {{/if}}
+        }
+    }
+}

package/assets/index-worker.hbs

@@ -1,9 +1,8 @@
-{{#if isTs }}import { bootstrapWorker } from '@vendure/core';{{else}}const { bootstrapWorker } = require('@vendure/core');{{/if}}
-{{#if isTs }}import { config } from './vendure-config';{{else}}const { config } = require('./vendure-config');{{/if}}
+import { bootstrapWorker } from '@vendure/core';
+import { config } from './vendure-config';
 
 bootstrapWorker(config)
-.then(worker => worker.startJobQueue())
-.catch(err => {
-    // tslint:disable-next-line:no-console
-    console.log(err);
-});
+    .then(worker => worker.startJobQueue())
+    .catch(err => {
+        console.log(err);
+    });

package/assets/index.hbs

@@ -1,7 +1,8 @@
-{{#if isTs }}import { bootstrap } from '@vendure/core';{{else}}const { bootstrap } = require('@vendure/core');{{/if}}
-{{#if isTs }}import { config } from './vendure-config';{{else}}const { config } = require('./vendure-config');{{/if}}
+import { bootstrap, runMigrations } from '@vendure/core';
+import { config } from './vendure-config';
 
-bootstrap(config).catch(err => {
-    // tslint:disable-next-line:no-console
-    console.log(err);
-});
+runMigrations(config)
+    .then(() => bootstrap(config))
+    .catch(err => {
+        console.log(err);
+    });

package/assets/migration.hbs

@@ -1,13 +1,13 @@
-{{#if isTs }}import { generateMigration, revertLastMigration, runMigrations } from '@vendure/core';{{else}}const { generateMigration, revertLastMigration, runMigrations } = require('@vendure/core');{{/if}}
-{{#if isTs }}import program from 'commander';{{else}}const program = require('commander');{{/if}}
+import { generateMigration, revertLastMigration, runMigrations } from '@vendure/core';
+import program from 'commander';
 
-{{#if isTs }}import { config } from './src/vendure-config';{{else}}const { config } = require('./src/vendure-config');{{/if}}
+import { config } from './src/vendure-config';
 
 program
     .command('generate <name>')
     .description('Generate a new migration file with the given name')
     .action(name => {
-        return generateMigration(config, { name, outputDir: './migrations' });
+        return generateMigration(config, { name, outputDir: './src/migrations' });
     });
 
 program

package/assets/readme.hbs

@@ -2,6 +2,13 @@
 
 This project was generated with [`@vendure/create`](https://github.com/vendure-ecommerce/vendure/tree/master/packages/create).
 
+Useful links:
+
+- [Vendure docs](https://www.vendure.io/docs)
+- [Vendure Discord community](https://www.vendure.io/community)
+- [Vendure on GitHub](https://github.com/vendure-ecommerce/vendure)
+- [Vendure plugin template](https://github.com/vendure-ecommerce/plugin-template)
+
 ## Directory structure
 
 * `/src` contains the source code of your Vendure server. All your custom code and plugins should reside here.
@@ -10,48 +17,108 @@ This project was generated with [`@vendure/create`](https://github.com/vendure-e
 ## Development
 
 ```
-yarn start
-# or
-npm run start
+{{#if useYarn}}yarn dev{{else}}npm run dev{{/if}}
 ```
 
 will start the Vendure server and [worker](https://www.vendure.io/docs/developer-guide/vendure-worker/) processes from
 the `src` directory.
 
-{{#if isTs}}## Build
+## Build
 
 ```
-yarn build
-# or
-npm run build
+{{#if useYarn}}yarn build{{else}}npm run build{{/if}}
 ```
 
-will compile the TypeScript sources into the `/dist` directory.{{/if}}
+will compile the TypeScript sources into the `/dist` directory.
+
+## Production
+
+For production, there are many possibilities which depend on your operational requirements as well as your production
+hosting environment.
+
+### Running directly
+
+You can run the built files directly with the `start` script:
+
+```
+{{#if useYarn}}yarn start{{else}}npm run start{{/if}}
+```
+
+You could also consider using a process manager like [pm2](https://pm2.keymetrics.io/) to run and manage
+the server & worker processes.
+
+### Using Docker
+
+We've included a sample [Dockerfile](./Dockerfile) which you can build with the following command:
+
+```
+docker build -t vendure .
+```
+
+This builds an image and tags it with the name "vendure". We can then run it with:
+
+```
+# Run the server
+docker run -dp 3000:3000 -e "DB_HOST=host.docker.internal" --name vendure-server vendure npm run start:server
+
+# Run the worker
+docker run -dp 3000:3000 -e "DB_HOST=host.docker.internal" --name vendure-worker vendure npm run start:worker
+```
+
+Here is a breakdown of the command used above:
+
+- `docker run` - run the image we created with `docker build`
+- `-dp 3000:3000` - the `-d` flag means to run in "detached" mode, so it runs in the background and does not take
+control of your terminal. `-p 3000:3000` means to expose port 3000 of the container (which is what Vendure listens
+on by default) as port 3000 on your host machine.
+- `-e "DB_HOST=host.docker.internal"` - the `-e` option allows you to define environment variables. In this case we
+are setting the `DB_HOST` to point to a special DNS name that is created by Docker desktop which points to the IP of
+the host machine. Note that `host.docker.internal` only exists in a Docker Desktop environment and thus should only be
+used in development.
+- `--name vendure-server` - we give the container a human-readable name.
+- `vendure` - we are referencing the tag we set up during the build.
+- `npm run start:server` - this last part is the actual command that should be run inside the container.
+
+### Docker compose
+
+We've included a sample [docker-compose.yml](./docker-compose.yml) file which demonstrates how the server, worker, and
+database may be orchestrated with Docker Compose.
+
+## Plugins
+
+In Vendure, your custom functionality will live in [plugins](https://www.vendure.io/docs/plugins/).
+These should be located in the `./src/plugins` directory.
 
 ## Migrations
 
-[Migrations](https://www.vendure.io/docs/developer-guide/migrations/) allow safe updates to the database schema.
+[Migrations](https://www.vendure.io/docs/developer-guide/migrations/) allow safe updates to the database schema. Migrations
+will be required whenever you make changes to the `customFields` config or define new entities in a plugin.
 
 The following npm scripts can be used to generate migrations:
 
 ```
-yarn migration:generate [name]
-# or
-npm run migration:generate [name]
+{{#if useYarn}}yarn{{else}}npm run{{/if}} migration:generate [name]
 ```
 
-run any pending migrations that have been generated:
+The generated migration file will be found in the `./src/migrations/` directory, and should be committed to source control.
+Next time you start the server, and outstanding migrations found in that directory will be run by the `runMigrations()`
+function in the [index.ts file](./src/index.ts).
+
+If, during initial development, you do not wish to manually generate a migration on each change to customFields etc, you
+can set `dbConnectionOptions.synchronize` to `true`. This will cause the database schema to get automatically updated
+on each start, removing the need for migration files. Note that this is **not** recommended once you have production
+data that you cannot lose.
+
+---
+
+You can also run any pending migrations manually, without starting the server by running:
 
 ```
-yarn migration:run
-# or
-npm run migration:run
+{{#if useYarn}}yarn{{else}}npm run{{/if}} migration:run
 ```
 
-and revert the most recently-applied migration:
+You can revert the most recently-applied migration with:
 
 ```
-yarn migration:revert
-# or
-npm run migration:revert
+{{#if useYarn}}yarn{{else}}npm run{{/if}} migration:revert
 ```

package/assets/tsconfig.template.json

@@ -5,11 +5,16 @@
     "esModuleInterop": true,
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
-    "target": "es2017",
+    "strictPropertyInitialization": false,
+    "target": "es2019",
     "strict": true,
     "sourceMap": false,
+    "skipLibCheck": true,
     "outDir": "./dist",
     "baseUrl": "./"
   },
-  "exclude": ["node_modules", "migration.ts"]
+  "exclude": ["node_modules", "migration.ts"],
+  "ts-node": {
+    "files": true
+  }
 }

package/assets/vendure-config.hbs

@@ -1,82 +1,82 @@
-{{#if isTs }}import{{ else }}const{{/if}} {
+import {
     dummyPaymentHandler,
     DefaultJobQueuePlugin,
-    DefaultSearchPlugin,{{#if isTs}}
-    VendureConfig,{{/if}}
-} {{#if isTs}}from '@vendure/core'; {{ else }}= require('@vendure/core');{{/if}}
-{{#if isTs }}
+    DefaultSearchPlugin,
+    VendureConfig,
+} from '@vendure/core';
 import { defaultEmailHandlers, EmailPlugin } from '@vendure/email-plugin';
-{{ else }}
-const { defaultEmailHandlers, EmailPlugin } = require('@vendure/email-plugin');
-{{/if}}
-{{#if isTs }}
 import { AssetServerPlugin } from '@vendure/asset-server-plugin';
-{{ else }}
-const { AssetServerPlugin } = require('@vendure/asset-server-plugin');
-{{/if}}
-{{#if isTs }}
 import { AdminUiPlugin } from '@vendure/admin-ui-plugin';
-{{ else }}
-const { AdminUiPlugin } = require('@vendure/admin-ui-plugin');
-{{/if}}
-{{#if isTs }}
+import 'dotenv/config';
 import path from 'path';
-{{ else }}
-const path = require('path');
-{{/if}}
 
-{{#if isTs}}export {{/if}}const config{{#if isTs}}: VendureConfig{{/if}} = {
+const IS_DEV = process.env.APP_ENV === 'dev';
+
+export const config: VendureConfig = {
     apiOptions: {
         port: 3000,
         adminApiPath: 'admin-api',
-        adminApiPlayground: {
-            settings: {
-                'request.credentials': 'include',
-            }{{#if isTs}} as any{{/if}},
-        },// turn this off for production
-        adminApiDebug: true, // turn this off for production
         shopApiPath: 'shop-api',
-        shopApiPlayground: {
-            settings: {
-                'request.credentials': 'include',
-            }{{#if isTs}} as any{{/if}},
-        },// turn this off for production
-        shopApiDebug: true,// turn this off for production
+        // The following options are useful in development mode,
+        // but are best turned off for production for security
+        // reasons.
+        ...(IS_DEV ? {
+            adminApiPlayground: {
+                settings: { 'request.credentials': 'include' } as any,
+            },
+            adminApiDebug: true,
+            shopApiPlayground: {
+                settings: { 'request.credentials': 'include' } as any,
+            },
+            shopApiDebug: true,
+        } : {}),
     },
     authOptions: {
+        tokenMethod: ['bearer', 'cookie'],
         superadminCredentials: {
-            identifier: '{{{ escapeSingle superadminIdentifier }}}',
-            password: '{{{ escapeSingle superadminPassword }}}',
+            identifier: process.env.SUPERADMIN_USERNAME,
+            password: process.env.SUPERADMIN_PASSWORD,
         },
         cookieOptions: {
-          secret: process.env.COOKIE_SECRET || 'cookie-secret',
+          secret: process.env.COOKIE_SECRET,
         },
     },
     dbConnectionOptions: {
         type: '{{ dbType }}',
-        synchronize: true, // turn this off for production
+        // See the README.md "Migrations" section for an explanation of
+        // the `synchronize` and `migrations` options.
+        synchronize: false,
+        migrations: [path.join(__dirname, './migrations/*.+(js|ts)')],
         logging: false,
-        database: {{#if isSQLjs}}new Uint8Array([]){{else if isSQLite}}path.join(__dirname, '../vendure.sqlite'){{else}}'{{{ escapeSingle dbName }}}'{{/if}},
+        database: {{#if isSQLjs}}new Uint8Array([]){{else if isSQLite}}path.join(__dirname, '../vendure.sqlite'){{else}}process.env.DB_NAME{{/if}},
+        {{#if dbSchema}}
+        schema: process.env.DB_SCHEMA,
+        {{/if}}
         {{#if isSQLjs}}
         location: path.join(__dirname, 'vendure.sqlite'),
         autoSave: true,
         {{/if}}
         {{#if requiresConnection}}
-        host: '{{ dbHost }}',
-        port: {{ dbPort }},
-        username: '{{{ escapeSingle dbUserName }}}',
-        password: '{{{ escapeSingle dbPassword }}}',
+        host: process.env.DB_HOST,
+        port: +process.env.DB_PORT,
+        username: process.env.DB_USERNAME,
+        password: process.env.DB_PASSWORD,
         {{/if}}
-        migrations: [path.join(__dirname, '../migrations/*.ts')],
     },
     paymentOptions: {
         paymentMethodHandlers: [dummyPaymentHandler],
     },
+    // When adding or altering custom field definitions, the database will
+    // need to be updated. See the "Migrations" section in README.md.
     customFields: {},
     plugins: [
         AssetServerPlugin.init({
             route: 'assets',
             assetUploadDir: path.join(__dirname, '../static/assets'),
+            // For local dev, the correct value for assetUrlPrefix should
+            // be guessed correctly, but for production it will usually need
+            // to be set manually to match your production url.
+            assetUrlPrefix: IS_DEV ? undefined : 'https://www.my-shop.com/assets',
         }),
         DefaultJobQueuePlugin.init({ useDatabaseForBuffer: true }),
         DefaultSearchPlugin.init({ bufferUpdates: false, indexStockStatus: true }),
@@ -87,7 +87,8 @@ const path = require('path');
             handlers: defaultEmailHandlers,
             templatePath: path.join(__dirname, '../static/email/templates'),
             globalTemplateVars: {
-                // The following variables will change depending on your storefront implementation
+                // The following variables will change depending on your storefront implementation.
+                // Here we are assuming a storefront running at http://localhost:8080.
                 fromAddress: '"example" <noreply@example.com>',
                 verifyEmailAddressUrl: 'http://localhost:8080/verify',
                 passwordResetUrl: 'http://localhost:8080/password-reset',
@@ -100,8 +101,3 @@ const path = require('path');
         }),
     ],
 };
-{{#if isTs}}
-{{else}}
-
-module.exports = { config };
-{{/if}}

package/lib/constants.d.ts

@@ -1,7 +1,7 @@
-export declare const REQUIRED_NODE_VERSION = ">=10.13.0";
+export declare const REQUIRED_NODE_VERSION = ">=14.0.0";
 export declare const SERVER_PORT = 3000;
 /**
  * The TypeScript version needs to pinned because minor versions often
  * introduce breaking changes.
  */
-export declare const TYPESCRIPT_VERSION = "4.3.5";
+export declare const TYPESCRIPT_VERSION = "4.9.5";

package/lib/constants.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TYPESCRIPT_VERSION = exports.SERVER_PORT = exports.REQUIRED_NODE_VERSION = void 0;
-exports.REQUIRED_NODE_VERSION = '>=10.13.0';
+exports.REQUIRED_NODE_VERSION = '>=14.0.0';
 exports.SERVER_PORT = 3000;
 /**
  * The TypeScript version needs to pinned because minor versions often
  * introduce breaking changes.
  */
-exports.TYPESCRIPT_VERSION = '4.3.5';
+exports.TYPESCRIPT_VERSION = '4.9.5';
 //# sourceMappingURL=constants.js.map

package/lib/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG,WAAW,CAAC;AACpC,QAAA,WAAW,GAAG,IAAI,CAAC;AAChC;;;GAGG;AACU,QAAA,kBAAkB,GAAG,OAAO,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG,UAAU,CAAC;AACnC,QAAA,WAAW,GAAG,IAAI,CAAC;AAChC;;;GAGG;AACU,QAAA,kBAAkB,GAAG,OAAO,CAAC"}

package/lib/create-vendure-app.d.ts

@@ -1 +1,2 @@
-export {};
+import { CliLogLevel } from './types';
+export declare function createVendureApp(name: string | undefined, useNpm: boolean, logLevel: CliLogLevel, isCi?: boolean): Promise<void>;