create-payload-app 0.3.19 → 0.3.21

package/README.md

@@ -15,7 +15,7 @@ CLI for easily starting new Payload project
       --name my-payload-app              Set project name
       --template template_name           Choose specific template
 
-        Available templates: js-blank, js-blog, js-todo, ts-blank, ts-blog, ts-todo
+        Available templates: blank, blog, todo
 
       --use-npm                          Use npm to install dependencies
       --no-deps                          Do not install any dependencies

package/dist/lib/common-files/nodemon.json

@@ -0,0 +1,4 @@
+{
+  "ext": "ts",
+  "exec": "ts-node src/server.ts"
+}

package/dist/lib/common-files/package.template.json

@@ -0,0 +1,30 @@
+{
+  "name": "{{projectName}}",
+  "description": "Payload project created from {{templateName}} template",
+  "version": "1.0.0",
+  "main": "dist/server.js",
+  "license": "MIT",
+  "scripts": {
+    "dev": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts nodemon",
+    "build:payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload build",
+    "build:server": "tsc",
+    "build": "{{runCommand}} copyfiles && {{runCommand}} build:payload && {{runCommand}} build:server",
+    "serve": "cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NODE_ENV=production node dist/server.js",
+    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png}\" dist/",
+    "generate:types": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:types",
+    "generate:graphQLSchema": "PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema"
+  },
+  "dependencies": {
+    "payload": "1.1.17",
+    "dotenv": "^8.2.0",
+    "express": "^4.17.1"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.9",
+    "cross-env": "^7.0.3",
+    "nodemon": "^2.0.6",
+    "ts-node": "^9.1.1",
+    "copyfiles": "^2.4.1",
+    "typescript": "^4.8.4"
+  }
+}

package/dist/lib/common-files/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "jsx": "react"
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "build",
+  ],
+  "ts-node": {
+    "transpileOnly": true
+  }
+}

package/dist/lib/common-files/typescript/package.template.json

@@ -8,7 +8,7 @@
     "dev": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts nodemon",
     "build:payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload build",
     "build:server": "tsc",
-    "build": "yarn copyfiles && yarn build:payload && yarn build:server",
+    "build": "{{runCommand}} copyfiles && {{runCommand}} build:payload && {{runCommand}} build:server",
     "serve": "cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NODE_ENV=production node dist/server.js",
     "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png}\" dist/",
     "generate:types": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:types",

package/dist/lib/create-project.test.js

@@ -62,16 +62,16 @@ describe('createProject', function () {
         var args = { _: ['project-name'], '--no-deps': true };
         var packageManager = 'yarn';
         it('creates static project', function () { return __awaiter(void 0, void 0, void 0, function () {
-            var expectedPayloadVersion, template, packageJsonPath, packageJson;
+            var expectedPayloadVersion, templateName, template, packageJsonPath, packageJson;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, (0, create_project_1.getLatestPayloadVersion)()];
                     case 1:
                         expectedPayloadVersion = _a.sent();
+                        templateName = 'todo';
                         template = {
-                            name: 'ts-todo',
+                            name: templateName,
                             type: 'static',
-                            language: 'typescript',
                         };
                         return [4 /*yield*/, (0, create_project_1.createProject)(args, projectDir, template, packageManager)];
                     case 2:
@@ -81,7 +81,7 @@ describe('createProject', function () {
                         expect(packageJson.dependencies.payload).toBe(expectedPayloadVersion);
                         // Check package name and description
                         expect(packageJson.name).toEqual(path_1.default.basename(projectDir));
-                        expect(packageJson.description).toContain('ts-todo');
+                        expect(packageJson.description).toContain(templateName);
                         // Check all common files are create
                         assertProjectFileExists('.npmrc');
                         assertProjectFileExists('.gitignore');

package/dist/lib/parse-template.js

@@ -41,7 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseTemplate = void 0;
 var prompts_1 = __importDefault(require("prompts"));
-function parseTemplate(args, validTemplates, language) {
+function parseTemplate(args, validTemplates) {
     return __awaiter(this, void 0, void 0, function () {
         var templateName_1, template_1, filteredTemplates, response, template;
         return __generator(this, function (_a) {
@@ -54,24 +54,20 @@ function parseTemplate(args, validTemplates, language) {
                             throw new Error('Invalid template given');
                         return [2 /*return*/, template_1];
                     }
-                    filteredTemplates = validTemplates
-                        .filter(function (d) { return d.name.startsWith(language); })
-                        .map(function (t) { return t.name.replace("".concat(language, "-"), ''); });
+                    filteredTemplates = validTemplates.map(function (t) { return t.name; });
                     return [4 /*yield*/, (0, prompts_1.default)({
                             type: 'select',
                             name: 'value',
                             message: 'Choose project template',
                             choices: filteredTemplates.map(function (p) {
-                                return { title: p, value: "".concat(language, "-").concat(p) };
+                                return { title: p, value: p };
                             }),
                             validate: function (value) { return !!value.length; },
                         }, {
                             onCancel: function () {
                                 process.exit(0);
                             },
-                        })
-                        // const template = `${language}-${response.value}`
-                    ];
+                        })];
                 case 1:
                     response = _a.sent();
                     template = validTemplates.find(function (t) { return t.name === response.value; });

package/dist/lib/templates.js

@@ -72,7 +72,6 @@ function getValidTemplates() {
                 return {
                     name: name,
                     type: 'static',
-                    language: name.startsWith('js-') ? 'javascript' : 'typescript',
                 };
             });
             return [2 /*return*/, templates];

package/dist/lib/write-common-files.js

@@ -64,19 +64,20 @@ function writeCommonFiles(projectDir, template, packageManager) {
                     ];
                 case 2:
                     _a.sent();
-                    return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, template.language, 'package.template.json'), 'utf8')];
+                    return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, 'package.template.json'), 'utf8')];
                 case 3:
                     packageJsonTemplate = _a.sent();
                     packageJson = handlebars_1.default.compile(packageJsonTemplate)({
                         projectName: path_1.default.basename(projectDir),
                         templateName: template.name,
+                        runCommand: packageManager === 'yarn' ? 'yarn' : 'npm run',
                     });
                     return [4 /*yield*/, fs_extra_1.default.writeFile(path_1.default.resolve(projectDir, 'package.json'), packageJson)
                         // nodemon.json
                     ];
                 case 4:
                     _a.sent();
-                    nodemon = path_1.default.resolve(commonFilesDir, template.language, 'nodemon.json');
+                    nodemon = path_1.default.resolve(commonFilesDir, 'nodemon.json');
                     nodemonDest = path_1.default.resolve(projectDir, 'nodemon.json');
                     return [4 /*yield*/, fs_extra_1.default.copy(nodemon, nodemonDest)
                         // README.md
@@ -95,15 +96,15 @@ function writeCommonFiles(projectDir, template, packageManager) {
                     ];
                 case 7:
                     _a.sent();
-                    if (!(template.language === 'typescript')) return [3 /*break*/, 9];
-                    tsconfig = path_1.default.resolve(commonFilesDir, template.language, 'tsconfig.json');
+                    tsconfig = path_1.default.resolve(commonFilesDir, 'tsconfig.json');
                     tsconfigDest = path_1.default.resolve(projectDir, 'tsconfig.json');
-                    return [4 /*yield*/, fs_extra_1.default.copy(tsconfig, tsconfigDest)];
+                    return [4 /*yield*/, fs_extra_1.default.copy(tsconfig, tsconfigDest)
+                        // docker-compose.yml
+                    ];
                 case 8:
                     _a.sent();
-                    _a.label = 9;
-                case 9: return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, 'docker-compose.template.yml'), 'utf8')];
-                case 10:
+                    return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, 'docker-compose.template.yml'), 'utf8')];
+                case 9:
                     dockerComposeTemplate = _a.sent();
                     dockerCompose = handlebars_1.default.compile(dockerComposeTemplate)(packageManager === 'yarn'
                         ? { installCmd: 'yarn install', devCmd: 'yarn dev' }
@@ -111,16 +112,16 @@ function writeCommonFiles(projectDir, template, packageManager) {
                     return [4 /*yield*/, fs_extra_1.default.writeFile(path_1.default.resolve(projectDir, 'docker-compose.yml'), dockerCompose)
                         // Dockerfile
                     ];
-                case 11:
+                case 10:
                     _a.sent();
                     return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, 'Dockerfile.template'), 'utf8')];
-                case 12:
+                case 11:
                     dockerfileTemplate = _a.sent();
                     dockerfile = handlebars_1.default.compile(dockerfileTemplate)(packageManager === 'yarn'
                         ? { installCmd: 'yarn install', buildCmd: 'yarn build' }
                         : { installCmd: 'npm install', buildCmd: 'npm run build' });
                     return [4 /*yield*/, fs_extra_1.default.writeFile(path_1.default.resolve(projectDir, 'Dockerfile'), dockerfile)];
-                case 13:
+                case 12:
                     _a.sent();
                     return [2 /*return*/];
             }

package/dist/main.js

@@ -46,7 +46,6 @@ var command_exists_1 = __importDefault(require("command-exists"));
 var create_project_1 = require("./lib/create-project");
 var get_db_connection_1 = require("./lib/get-db-connection");
 var generate_secret_1 = require("./lib/generate-secret");
-var parse_language_1 = require("./lib/parse-language");
 var parse_project_name_1 = require("./lib/parse-project-name");
 var parse_template_1 = require("./lib/parse-template");
 var templates_1 = require("./lib/templates");
@@ -73,11 +72,11 @@ var Main = /** @class */ (function () {
     }
     Main.prototype.init = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, _b, templateArg, valid, _c, _d, projectName, language, validTemplates, template, databaseUri, payloadSecret, projectDir, packageManager, error_1;
+            var _a, _b, templateArg, valid, _c, _d, projectName, validTemplates, template, databaseUri, payloadSecret, projectDir, packageManager, error_1;
             return __generator(this, function (_e) {
                 switch (_e.label) {
                     case 0:
-                        _e.trys.push([0, 16, , 17]);
+                        _e.trys.push([0, 15, , 16]);
                         if (!this.args['--help']) return [3 /*break*/, 2];
                         _b = (_a = console).log;
                         return [4 /*yield*/, (0, messages_1.helpMessage)()];
@@ -103,42 +102,39 @@ var Main = /** @class */ (function () {
                         return [4 /*yield*/, (0, parse_project_name_1.parseProjectName)(this.args)];
                     case 6:
                         projectName = _e.sent();
-                        return [4 /*yield*/, (0, parse_language_1.parseLanguage)(this.args)];
-                    case 7:
-                        language = _e.sent();
                         return [4 /*yield*/, (0, templates_1.getValidTemplates)()];
-                    case 8:
+                    case 7:
                         validTemplates = _e.sent();
-                        return [4 /*yield*/, (0, parse_template_1.parseTemplate)(this.args, validTemplates, language)];
-                    case 9:
+                        return [4 /*yield*/, (0, parse_template_1.parseTemplate)(this.args, validTemplates)];
+                    case 8:
                         template = _e.sent();
                         return [4 /*yield*/, (0, get_db_connection_1.getDatabaseConnection)(this.args, projectName)];
-                    case 10:
+                    case 9:
                         databaseUri = _e.sent();
                         return [4 /*yield*/, (0, generate_secret_1.generateSecret)()];
-                    case 11:
+                    case 10:
                         payloadSecret = _e.sent();
                         projectDir = projectName === '.' ? process.cwd() : "./".concat((0, slugify_1.default)(projectName));
                         return [4 /*yield*/, getPackageManager(this.args)];
-                    case 12:
+                    case 11:
                         packageManager = _e.sent();
-                        if (!!this.args['--dry-run']) return [3 /*break*/, 15];
+                        if (!!this.args['--dry-run']) return [3 /*break*/, 14];
                         return [4 /*yield*/, (0, create_project_1.createProject)(this.args, projectDir, template, packageManager)];
-                    case 13:
+                    case 12:
                         _e.sent();
                         return [4 /*yield*/, (0, write_env_file_1.writeEnvFile)(projectName, databaseUri, payloadSecret)];
-                    case 14:
+                    case 13:
                         _e.sent();
-                        _e.label = 15;
-                    case 15:
+                        _e.label = 14;
+                    case 14:
                         (0, log_1.success)('Payload project successfully created');
                         console.log((0, messages_1.successMessage)(projectDir, packageManager));
-                        return [3 /*break*/, 17];
-                    case 16:
+                        return [3 /*break*/, 16];
+                    case 15:
                         error_1 = _e.sent();
                         console.log(error_1);
-                        return [3 /*break*/, 17];
-                    case 17: return [2 /*return*/];
+                        return [3 /*break*/, 16];
+                    case 16: return [2 /*return*/];
                 }
             });
         });

package/dist/templates/blank/src/collections/Examples.ts

@@ -0,0 +1,17 @@
+import { CollectionConfig } from 'payload/types';
+
+// Example Collection - For reference only, this must be added to payload.config.ts to be used.
+const Examples: CollectionConfig = {
+  slug: 'examples',
+  admin: {
+    useAsTitle: 'someField',
+  },
+  fields: [
+    {
+      name: 'someField',
+      type: 'text',
+    },
+  ],
+}
+
+export default Examples;

package/dist/templates/blank/src/collections/Users.ts

@@ -0,0 +1,18 @@
+import { CollectionConfig } from 'payload/types';
+
+const Users: CollectionConfig = {
+  slug: 'users',
+  auth: true,
+  admin: {
+    useAsTitle: 'email',
+  },
+  access: {
+    read: () => true,
+  },
+  fields: [
+    // Email added by default
+    // Add more fields as needed
+  ],
+};
+
+export default Users;

package/dist/templates/blank/src/payload.config.ts

@@ -0,0 +1,22 @@
+import { buildConfig } from 'payload/config';
+import path from 'path';
+// import Examples from './collections/Examples';
+import Users from './collections/Users';
+
+export default buildConfig({
+  serverURL: 'http://localhost:3000',
+  admin: {
+    user: Users.slug,
+  },
+  collections: [
+    Users,
+    // Add Collections here
+    // Examples,
+  ],
+  typescript: {
+    outputFile: path.resolve(__dirname, 'payload-types.ts'),
+  },
+  graphQL: {
+    schemaOutputFile: path.resolve(__dirname, 'generated-schema.graphql'),
+  },
+});

package/dist/templates/blank/src/server.ts

@@ -0,0 +1,24 @@
+import express from 'express';
+import payload from 'payload';
+
+require('dotenv').config();
+const app = express();
+
+// Redirect root to Admin panel
+app.get('/', (_, res) => {
+  res.redirect('/admin');
+});
+
+// Initialize Payload
+payload.init({
+  secret: process.env.PAYLOAD_SECRET,
+  mongoURL: process.env.MONGODB_URI,
+  express: app,
+  onInit: () => {
+    payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)
+  },
+})
+
+// Add your own express routes here
+
+app.listen(3000);

package/dist/templates/blog/src/collections/Categories.ts

@@ -0,0 +1,20 @@
+import { CollectionConfig } from 'payload/types';
+
+const Categories: CollectionConfig = {
+  slug: 'categories',
+  admin: {
+    useAsTitle: 'name',
+  },
+  access: {
+    read: () => true,
+  },
+  fields: [
+    {
+      name: 'name',
+      type: 'text',
+    },
+  ],
+  timestamps: false,
+}
+
+export default Categories;

package/dist/templates/blog/src/collections/Posts.ts

@@ -0,0 +1,62 @@
+import { CollectionConfig } from 'payload/types';
+
+const Posts: CollectionConfig = {
+  slug: 'posts',
+  admin: {
+    defaultColumns: ['title', 'author', 'category', 'tags', 'status'],
+    useAsTitle: 'title',
+  },
+  access: {
+    read: () => true,
+  },
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+    },
+    {
+      name: 'author',
+      type: 'relationship',
+      relationTo: 'users',
+    },
+    {
+      name: 'publishedDate',
+      type: 'date',
+    },
+    {
+      name: 'category',
+      type: 'relationship',
+      relationTo: 'categories'
+    },
+    {
+      name: 'tags',
+      type: 'relationship',
+      relationTo: 'tags',
+      hasMany: true,
+    },
+    {
+      name: 'content',
+      type: 'richText'
+    },
+    {
+      name: 'status',
+      type: 'select',
+      options: [
+        {
+          value: 'draft',
+          label: 'Draft',
+        },
+        {
+          value: 'published',
+          label: 'Published',
+        },
+      ],
+      defaultValue: 'draft',
+      admin: {
+        position: 'sidebar',
+      }
+    }
+  ],
+}
+
+export default Posts;

package/dist/templates/blog/src/collections/Tags.ts

@@ -0,0 +1,20 @@
+import { CollectionConfig } from 'payload/types';
+
+const Tags: CollectionConfig = {
+  slug: 'tags',
+  admin: {
+    useAsTitle: 'name',
+  },
+  access: {
+    read: () => true,
+  },
+  fields: [
+    {
+      name: 'name',
+      type: 'text',
+    },
+  ],
+  timestamps: false,
+}
+
+export default Tags;

package/dist/templates/blog/src/collections/Users.ts

@@ -0,0 +1,21 @@
+import { CollectionConfig } from 'payload/types';
+
+const Users: CollectionConfig = {
+  slug: 'users',
+  auth: true,
+  admin: {
+    useAsTitle: 'email',
+  },
+  access: {
+    read: () => true,
+  },
+  fields: [
+    // Email added by default
+    {
+      name: 'name',
+      type: 'text',
+    }
+  ],
+};
+
+export default Users;

package/dist/templates/blog/src/payload.config.ts

@@ -0,0 +1,25 @@
+import { buildConfig } from 'payload/config';
+import path from 'path';
+import Categories from './collections/Categories';
+import Posts from './collections/Posts';
+import Tags from './collections/Tags';
+import Users from './collections/Users';
+
+export default buildConfig({
+  serverURL: 'http://localhost:3000',
+  admin: {
+    user: Users.slug,
+  },
+  collections: [
+    Categories,
+    Posts,
+    Tags,
+    Users,
+  ],
+  typescript: {
+    outputFile: path.resolve(__dirname, 'payload-types.ts')
+  },
+  graphQL: {
+    schemaOutputFile: path.resolve(__dirname, 'generated-schema.graphql'),
+  },
+});

package/dist/templates/blog/src/server.ts

@@ -0,0 +1,24 @@
+import express from 'express';
+import payload from 'payload';
+
+require('dotenv').config();
+const app = express();
+
+// Redirect root to Admin panel
+app.get('/', (_, res) => {
+  res.redirect('/admin');
+});
+
+// Initialize Payload
+payload.init({
+  secret: process.env.PAYLOAD_SECRET,
+  mongoURL: process.env.MONGODB_URI,
+  express: app,
+  onInit: () => {
+    payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)
+  },
+})
+
+// Add your own express routes here
+
+app.listen(3000);

package/dist/templates/todo/src/collections/TodoLists.ts

@@ -0,0 +1,38 @@
+import { CollectionConfig } from 'payload/types';
+
+const Todo: CollectionConfig = {
+  slug: 'todos',
+  admin: {
+    defaultColumns: ['listName', 'tasks', 'updatedAt'],
+    useAsTitle: 'listName',
+  },
+  access: {
+    create: () => true,
+    read: () => true,
+    update: () => true,
+    delete: () => true,
+  },
+  fields: [
+    {
+      name: 'listName',
+      type: 'text',
+    },
+    {
+      name: 'tasks',
+      type: 'array',
+      fields: [
+        {
+          name: 'name',
+          type: 'text',
+        },
+        {
+          name: 'complete',
+          type: 'checkbox',
+          defaultValue: false,
+        }
+      ]
+    },
+  ],
+}
+
+export default Todo;

package/dist/templates/todo/src/collections/Users.ts

@@ -0,0 +1,18 @@
+import { CollectionConfig } from 'payload/types';
+
+const Users: CollectionConfig = {
+  slug: 'users',
+  auth: true,
+  admin: {
+    useAsTitle: 'email',
+  },
+  access: {
+    read: () => true,
+  },
+  fields: [
+    // Email added by default
+    // Add more fields as needed
+  ],
+};
+
+export default Users;

package/dist/templates/todo/src/payload.config.ts

@@ -0,0 +1,21 @@
+import { buildConfig } from 'payload/config';
+import path from 'path';
+import TodoLists from './collections/TodoLists';
+import Users from './collections/Users';
+
+export default buildConfig({
+  serverURL: 'http://localhost:3000',
+  admin: {
+    user: Users.slug,
+  },
+  collections: [
+    TodoLists,
+    Users,
+  ],
+  typescript: {
+    outputFile: path.resolve(__dirname, 'payload-types.ts')
+  },
+  graphQL: {
+    schemaOutputFile: path.resolve(__dirname, 'generated-schema.graphql'),
+  },
+});

package/dist/templates/todo/src/server.ts

@@ -0,0 +1,24 @@
+import express from 'express';
+import payload from 'payload';
+
+require('dotenv').config();
+const app = express();
+
+// Redirect root to Admin panel
+app.get('/', (_, res) => {
+  res.redirect('/admin');
+});
+
+// Initialize Payload
+payload.init({
+  secret: process.env.PAYLOAD_SECRET,
+  mongoURL: process.env.MONGODB_URI,
+  express: app,
+  onInit: () => {
+    payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)
+  },
+})
+
+// Add your own express routes here
+
+app.listen(3000);

package/package.json

@@ -36,7 +36,7 @@
     "prompts": "^2.4.0",
     "terminal-link": "^2.1.1"
   },
-  "version": "0.3.19",
+  "version": "0.3.21",
   "devDependencies": {
     "@types/command-exists": "^1.2.0",
     "@types/degit": "^2.8.3",