@vc-shell/create-vc-app 1.0.88

package/CHANGELOG.md

@@ -0,0 +1,93 @@
+## [1.0.88](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.87...v1.0.88) (2023-06-27)
+
+
+
+## [1.0.87](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.86...v1.0.87) (2023-06-26)
+
+
+
+## [1.0.86](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.85...v1.0.86) (2023-06-23)
+
+
+
+## [1.0.85](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.84...v1.0.85) (2023-06-23)
+
+
+### Bug Fixes
+
+* check permissions plugin ([cc65272](https://github.com/VirtoCommerce/vc-shell/commit/cc65272d933e29f427b1403df2bdd627b15dd1e6))
+
+
+
+## [1.0.84](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.83...v1.0.84) (2023-06-23)
+
+
+
+## [1.0.83](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.82...v1.0.83) (2023-06-23)
+
+
+
+## [1.0.82](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.81...v1.0.82) (2023-06-23)
+
+
+
+## [1.0.81](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.80...v1.0.81) (2023-06-23)
+
+
+
+## [1.0.80](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.79...v1.0.80) (2023-06-22)
+
+
+
+## [1.0.79](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.78...v1.0.79) (2023-06-22)
+
+
+
+## [1.0.78](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.77...v1.0.78) (2023-06-22)
+
+
+
+## [1.0.77](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.76...v1.0.77) (2023-06-22)
+
+
+
+## [1.0.76](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.75...v1.0.76) (2023-06-22)
+
+
+
+## [1.0.75](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.74...v1.0.75) (2023-06-21)
+
+
+
+## [1.0.74](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.73...v1.0.74) (2023-06-21)
+
+
+### Bug Fixes
+
+* pass platformUrl to shell ([6265790](https://github.com/VirtoCommerce/vc-shell/commit/62657901ae6738883ed785e4f54507db85ba7d66))
+
+
+
+## [1.0.73](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.72...v1.0.73) (2023-06-08)
+
+
+
+## [1.0.72](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.71...v1.0.72) (2023-06-07)
+
+
+
+## [1.0.71](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.70...v1.0.71) (2023-06-02)
+
+
+### Bug Fixes
+
+* fixed create-vc-app template ([f433fea](https://github.com/VirtoCommerce/vc-shell/commit/f433feaf4b75badeea427b61061a08b9a6056c8a))
+
+
+### Features
+
+* **cli** create-vc-app scaffolding tool ([e6428ae](https://github.com/VirtoCommerce/vc-shell/commit/e6428ae654ba180971c6ab58f9abfa2452ca0e9b))
+* azure active directory signin ([46cee05](https://github.com/VirtoCommerce/vc-shell/commit/46cee052064434bdd143d744ca7557f5c0fd7e84))
+
+
+

package/README.md

@@ -0,0 +1,30 @@
+# Creating your first application
+
+Make sure you have executed `yarn` command and your current working directory is the one where you intend to create a project.
+
+Run following command:
+```bash
+$ npx create-vc-app
+```
+
+This command will execute application scaffolding tool. You will be presented with prompts:
+
+```text
+✔ App name: … <your-app-name>
+✔ Add Dashboard page? … No / Yes
+✔ Add Login/Invite/Reset password pages? … No / Yes
+✔ Add module starter? … No / Yes
+✔ Module starter name: … <your-first-module-name>
+
+Scaffolding app in ./<your-app-name>...
+
+Done.
+```
+
+
+Once app is created, follow the instructions to install dependencies and start dev server:
+```bash
+$ cd <your-app-name>
+$ yarn
+$ yarn serve
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,152 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const prompts_1 = tslib_1.__importDefault(require("prompts"));
+const minimist_1 = tslib_1.__importDefault(require("minimist"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const ejs = tslib_1.__importStar(require("ejs"));
+function isValidName(appName) {
+    return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(appName);
+}
+function toValidName(appName) {
+    return appName
+        .trim()
+        .toLowerCase()
+        .replace(/\s+/g, "-")
+        .replace(/^[._]/, "")
+        .replace(/[^a-z0-9-~]+/g, "-");
+}
+function emptyDir(dir) {
+    if (!fs_1.default.existsSync(dir)) {
+        return;
+    }
+}
+async function renderTemplate(src, dest, config) {
+    const stats = fs_1.default.statSync(src);
+    if (stats.isDirectory()) {
+        if (path_1.default.basename(src) === "node_modules") {
+            return;
+        }
+        fs_1.default.mkdirSync(dest, { recursive: true });
+        for (const file of fs_1.default.readdirSync(src)) {
+            if (path_1.default.parse(file).ext === ".ejs") {
+                try {
+                    const rendered = await ejs.renderFile(path_1.default.resolve(src, file), config);
+                    fs_1.default.writeFileSync(path_1.default.resolve(`${dest}/${path_1.default.parse(file).name}`), rendered);
+                    continue;
+                }
+                catch (e) {
+                    console.log(e);
+                }
+            }
+            renderTemplate(path_1.default.resolve(src, file), path_1.default.resolve(dest, file), config);
+        }
+        return;
+    }
+    if (fs_1.default.existsSync(dest)) {
+        fs_1.default.writeFileSync(dest, fs_1.default.readFileSync(src, "utf8"));
+        return;
+    }
+    fs_1.default.copyFileSync(src, dest);
+}
+async function create() {
+    const cwd = process.cwd();
+    const args = (0, minimist_1.default)(process.argv.slice(2));
+    let dir = args._[0];
+    const defaultAppName = !dir ? "vc-app" : dir;
+    let config = {};
+    try {
+        config = await (0, prompts_1.default)([
+            {
+                name: "appName",
+                type: dir ? null : "text",
+                message: "App name:",
+                initial: defaultAppName,
+                onState: (state) => (dir = toValidName(String(state.value).trim()) || defaultAppName),
+                format: (value) => toValidName(String(value).trim()),
+            },
+            {
+                name: "packageName",
+                type: () => (isValidName(dir) ? null : "text"),
+                message: "Package name:",
+                initial: () => toValidName(dir),
+                validate: (dir) => isValidName(dir) || "Invalid package.json name",
+            },
+            {
+                name: "dashboard",
+                type: "toggle",
+                message: "Add Dashboard page?",
+                initial: false,
+                active: "Yes",
+                inactive: "No",
+            },
+            {
+                name: "commonPages",
+                type: "toggle",
+                message: "Add Login/Invite/Reset password pages?",
+                initial: false,
+                active: "Yes",
+                inactive: "No",
+            },
+            {
+                name: "bladeModuleStarter",
+                type: "toggle",
+                message: "Add module starter?",
+                initial: false,
+                active: "Yes",
+                inactive: "No",
+            },
+            {
+                name: "bladeModuleName",
+                type: (prev) => (prev ? "text" : null),
+                message: "Module starter name:",
+                format: (value) => String(value).trim().replace(/\s+/g, "").replace(/^[._]/, ""),
+            },
+        ], {
+            onCancel: () => {
+                throw new Error(chalk_1.default.red("Creation cancelled"));
+            },
+        });
+    }
+    catch (e) {
+        console.log(e.message);
+        process.exit(1);
+    }
+    const { dashboard, commonPages, bladeModuleStarter } = config;
+    const root = path_1.default.join(cwd, dir);
+    if (fs_1.default.existsSync(root)) {
+        emptyDir(root);
+    }
+    else if (!fs_1.default.existsSync(root)) {
+        fs_1.default.mkdirSync(root);
+    }
+    console.log(`\nScaffolding app in ${root}...`);
+    const templateRoot = path_1.default.resolve(__dirname, "template");
+    const render = (templateName) => {
+        const templateDir = path_1.default.resolve(templateRoot, templateName);
+        renderTemplate(templateDir, root, config);
+    };
+    render("base");
+    if (dashboard) {
+        render("code/dashboard");
+    }
+    if (commonPages) {
+        render("code/commonPages");
+    }
+    if (bladeModuleStarter) {
+        render("code/blade");
+    }
+    console.log(`\nDone. You can now run application:\n`);
+    if (root !== cwd) {
+        const cdProjectName = path_1.default.relative(cwd, root);
+        console.log(`  ${chalk_1.default.bold(chalk_1.default.green(`cd ${cdProjectName.includes(" ") ? `"${cdProjectName}"` : cdProjectName}`))}`);
+    }
+    console.log(`  ${chalk_1.default.bold(chalk_1.default.green("yarn"))}`);
+    console.log(`  ${chalk_1.default.bold(chalk_1.default.green("yarn serve"))}`);
+}
+create().catch((e) => {
+    console.error(e);
+});

package/dist/template/base/.browserslistrc

@@ -0,0 +1,3 @@
+> 1%
+last 2 versions
+not dead

package/dist/template/base/.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

package/dist/template/base/.editorconfig

@@ -0,0 +1,22 @@
+# top-most EditorConfig file
+root = true
+
+# Global rules, override on case-by-case basis
+[*]
+charset = utf-8
+indent_style = space
+max_line_length = 120
+tab_width = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{vue,js,ts,scss}]
+quote_type = double
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false
+
+[*.svg]
+insert_final_newline = false

package/dist/template/base/.env.ejs

@@ -0,0 +1,5 @@
+APP_LOG_ENABLED=true
+APP_LOG_LEVEL=debug
+APP_PLATFORM_URL=https://vcmp-dev.paas.govirto.com/
+APP_PLATFORM_MODULES=[]
+APP_BASE_PATH=/apps/<%= appName %>/

package/dist/template/base/.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+api-client.ts

package/dist/template/base/.eslintrc.js

@@ -0,0 +1,40 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+  },
+  plugins: ["@typescript-eslint", "vue", "import"],
+  extends: [
+    "plugin:vue/vue3-recommended",
+    "eslint:recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "@vue/typescript/recommended",
+    "@vue/prettier",
+    "@vue/eslint-config-typescript/recommended",
+  ],
+  parser: "vue-eslint-parser",
+  parserOptions: {
+    node: true,
+  },
+  settings: {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts"],
+    },
+    "import/resolver": {
+      typescript: {
+        project: ["./tsconfig.json"],
+      },
+    },
+  },
+  rules: {
+    "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
+    "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
+    "@typescript-eslint/ban-ts-comment": "warn",
+    "@typescript-eslint/no-unused-vars": "warn",
+    "vue/multi-word-component-names": "off",
+    "vue/require-default-prop": "off",
+    "vue/no-v-html": "off",
+    "vue/no-template-shadow": "off",
+  },
+};

package/dist/template/base/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+#npx --no-install commitlint --edit "$1"

package/dist/template/base/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+#npm run lint-staged

package/dist/template/base/.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+*.js
+api-client.ts

package/dist/template/base/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleAttributePerLine": true,
+  "endOfLine": "auto"
+}

package/dist/template/base/.vscode/extensions.json

@@ -0,0 +1,16 @@
+{
+  "recommendations": [
+    "editorconfig.editorconfig",
+    "dbaeumer.vscode-eslint",
+    "yzhang.markdown-all-in-one",
+    "shd101wyy.markdown-preview-enhanced",
+    "csstools.postcss",
+    "esbenp.prettier-vscode",
+    "bradlc.vscode-tailwindcss",
+    "vue.volar",
+    "lokalise.i18n-ally"
+  ],
+  "unwantedRecommendations": [
+    "octref.vetur"
+  ]
+}

package/dist/template/base/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "files.eol": "\r\n",
+  "eslint.validate": [
+    "vue",
+    "javascript"
+  ],
+  "i18n-ally.localesPaths": [
+    "src/locales",
+  ]
+}

package/dist/template/base/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) Virto Solutions LTD. All rights reserved.
+
+Licensed under the Virto Commerce Open Software License (the "License"); you
+may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+https://virtocommerce.com/open-source-license
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.

package/dist/template/base/README.md

@@ -0,0 +1,54 @@
+# VirtoCommerce Vue3 Frontend for specialized back-office applications
+
+## Technologies used
+
+- **Vue3.** Progressive frontend framework with its key features allows to build fast applications.
+- **Typescript.** All components and composables have type definitions, so IDE can help you to build clean and working code.
+- **TailwindCSS.** The most popular and growing CSS framework providing wonderful flexible structure to speed up styling.
+- **Husky + ESLint + Prettier.** Autoformat, check and fix your code and prevent ugly codestyle within repository.
+- **Vite.** It is faster than Webpack. Really FASTER. Use it to develop with HMR benefits and to build for production.
+
+## Architecture
+
+```text
+├─ public                         // Static assets
+│  ├─ assets                      // Static images used inside the application.
+│  └─ img
+│     └─ icons                    // Icons used for favicons, PWA, etc.
+├─ src
+│  ├─ api_client                  // Generated API clients folder
+│  │  └─...
+│  ├─ components                  // Universal Vue components
+│  │  └─...
+│  ├─ config                      // Application extras config files
+│  │  └─ push-hub.ts              // SignalR config file
+│  ├─ locales                     // Locale files used to provide translated content
+│  │  └─ en.json
+│  ├─ modules                     // The collection of custom modules
+│  │  └─ ...                      // Module folder
+│  │     ├─ components            // The collection of components specific for this module
+│  │     ├─ composables           // The collection of shared logic written using Composable API pattern.
+│  │     ├─ locales               // Locale files used to provide translated content specific for this module
+│  │     ├─ pages                 // Set of module pages used within Application router
+│  │     └─ index.ts              // Module entry point
+│  ├─ pages                       // Set of application pages used within Application router.
+│  │  └─...
+│  ├─ router                      // SPA routing configuration
+│  │  └─...
+│  ├─ styles                      // Extras application style files
+│  │  └─ index.scss               // Tailwind initialization file
+│  └─ types                       // Typescript .d.ts files
+```
+
+## Getting started
+
+```bash
+# install and configure package dependencies and git hooks
+$ yarn
+
+# build application
+$ yarn build
+
+# start application with hot reload at localhost:8080
+$ yarn serve
+```

package/dist/template/base/index.html.ejs

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="">
+
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport"
+    content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no" />
+  <link rel="icon" href="img/icons/favicon.ico">
+    <link rel="apple-touch-icon" sizes="180x180" href="img/icons/apple-touch-icon.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="img/icons/favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="16x16" href="img/icons/favicon-16x16.png">
+    <meta name="theme-color" content="#ffffff">
+  <title><%= appName %></title>
+</head>
+
+<body>
+  <noscript>
+    <strong>Please enable JavaScript to continue.</strong>
+  </noscript>
+  <div id="app"></div>
+  <script type="module" src="/src/main.ts"></script>
+  <!-- built files will be auto injected -->
+</body>
+
+</html>

package/dist/template/base/package.json.ejs

@@ -0,0 +1,72 @@
+{
+  "name": "<%= appName %>",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "postinstall": "husky install",
+    "serve": "cross-env APP_ENV=development vite --force",
+    "preview": "vite preview",
+    "build": "yarn build:app & yarn build:types",
+    "build:app": "cross-env APP_ENV=production vite build",
+    "build:types": "vue-tsc --declaration --emitDeclarationOnly --outDir dist/types",
+    "type-check": "vue-tsc --noEmit",
+    "lint-staged": "lint-staged",
+    "generate-api-client": "cross-env api-client-generator --color",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
+    "bump": "cross-env-shell 'f() { yarn version --\"$@\" --no-commit-hooks --ignore-scripts --no-git-tag-version --yes && yarn changelog && git add . && yarn commit-release && yarn create:tag ; }; f'",
+    "commit-release": "cross-env-shell 'git commit -m v$npm_package_version'",
+    "create:tag": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
+    "@rollup/plugin-typescript": "^11.1.1",
+    "@types/lodash-es": "^4.17.7",
+    "@typescript-eslint/eslint-plugin": "^5.59.7",
+    "@typescript-eslint/parser": "^5.59.7",
+    "@vc-shell/api-client-generator": "^1.0.88",
+    "@vitejs/plugin-vue": "^4.2.3",
+    "@vue/eslint-config-prettier": "^7.1.0",
+    "@vue/eslint-config-typescript": "^11.0.3",
+    "autoprefixer": "^10.4.14",
+    "buffer-esm": "^1.2.0",
+    "conventional-changelog-cli": "^2.2.2",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.41.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-vue": "^9.14.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.2",
+    "lodash-es": "^4.17.21",
+    "postcss": "^8.4.23",
+    "prettier": "^2.8.8",
+    "querystring-es3": "^0.2.1",
+    "sass": "^1.62.1",
+    "tailwindcss": "^3.3.2",
+    "typescript": "~5.0.4",
+    "vite": "^4.3.9",
+    "vite-plugin-checker": "^0.6.0",
+    "vite-plugin-mkcert": "^1.15.0",
+    "vite-plugin-pwa": "^0.14.7",
+    "vue-eslint-parser": "^9.3.0",
+    "vue-tsc": "~1.6.5"
+  },
+  "dependencies": {
+    "@fortawesome/fontawesome-free": "^5.15.3",
+    "@vc-shell/config-generator": "^1.0.88",
+    "@vc-shell/framework": "^1.0.88",
+    "@vueuse/core": "^10.1.2",
+    "@vueuse/integrations": "^10.1.2",
+    "moment": "^2.29.4",
+    "roboto-fontface": "^0.10.0",
+    "vee-validate": "^4.9.4",
+    "vue": "^3.3.4",
+    "vue-router": "^4.2.1",
+    "yarn": "^1.22.19"
+  },
+  "lint-staged": {
+    "*.{js,ts,vue}": "eslint --fix"
+  }
+}

package/dist/template/base/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+};

package/dist/template/base/public/assets/app-select.svg

@@ -0,0 +1,11 @@
+<svg width="22" height="22" viewBox="0 0 22 22" fill="none" xmlns="http://www.w3.org/2000/svg">
+<circle cx="2.53846" cy="2.53846" r="2.53846" fill="#7E8E9D"/>
+<ellipse cx="11" cy="2.53846" rx="2.53846" ry="2.53846" fill="#7E8E9D"/>
+<ellipse cx="19.4616" cy="2.53846" rx="2.53846" ry="2.53846" fill="#7E8E9D"/>
+<ellipse cx="2.53846" cy="11" rx="2.53846" ry="2.53846" fill="#7E8E9D"/>
+<ellipse cx="2.53846" cy="19.4615" rx="2.53846" ry="2.53846" fill="#7E8E9D"/>
+<circle cx="11" cy="11" r="2.53846" fill="#7E8E9D"/>
+<circle cx="11" cy="19.4615" r="2.53846" fill="#7E8E9D"/>
+<circle cx="19.4616" cy="11" r="2.53846" fill="#7E8E9D"/>
+<circle cx="19.4616" cy="19.4615" r="2.53846" fill="#7E8E9D"/>
+</svg>