@ikas/storefront-cmd 4.0.0-alpha.10

package/src/scripts/generators/config/content.ts

@@ -0,0 +1,168 @@
+export const DEPENDENCIES = {
+  next: "canary",
+  react: "17.0.2",
+  "react-dom": "17.0.2",
+  mobx: "^6.1.3",
+  axios: "^0.26.0",
+  lodash: "^4.17.20",
+  archiver: "^5.3.0",
+  cors: "^2.8.5",
+  "html-react-parser": "^1.4.0",
+  "mobx-react-lite": "^3.1.5",
+  "next-transpile-modules": "^9.0.0",
+  "@ikas/storefront": "^4.0.0-alpha.7",
+  "@ikas/storefront-api": "^4.0.0-alpha.7",
+  "@ikas/storefront-assets": "^4.0.0-alpha.7",
+  "@ikas/storefront-cmd": "^4.0.0-alpha.7",
+  "@ikas/storefront-config": "^4.0.0-alpha.7",
+  "@ikas/storefront-model-functions": "^4.0.0-alpha.7",
+  "@ikas/storefront-models": "^4.0.0-alpha.7",
+  "@ikas/storefront-next": "^4.0.0-alpha.7",
+  "@ikas/storefront-providers": "^4.0.0-alpha.7",
+};
+
+export const DEV_DEPENDENCIES = {
+  "@types/node": "^14.14.6",
+  "@types/react": "^17.0.2",
+  "@types/react-dom": "^17.0.2",
+  "@typescript-eslint/eslint-plugin": "^2.10.0",
+  "@typescript-eslint/parser": "^2.10.0",
+  eslint: "^6.6.0",
+  "eslint-config-react-app": "^5.2.1",
+  "eslint-loader": "3.0.3",
+  "eslint-plugin-flowtype": "4.6.0",
+  "eslint-plugin-import": "2.20.1",
+  "eslint-plugin-jsx-a11y": "6.2.3",
+  "eslint-plugin-react": "7.19.0",
+  "eslint-plugin-react-hooks": "^1.6.1",
+  sass: "^1.43.4",
+  typescript: "^4.5.2",
+};
+
+export const RESOLUTIONS = {
+  "@types/react": "17.0.2",
+  "@types/react-dom": "17.0.2",
+};
+
+export const SCRIPTS = {
+  upgradeDependencies:
+    "yarn upgrade @ikas/storefront @ikas/storefront-api @ikas/storefront-assets @ikas/storefront-cmd @ikas/storefront-config @ikas/storefront-model-functions @ikas/storefront-models @ikas/storefront-next @ikas/storefront-providers",
+  dev: "next dev -p 3333",
+  build: "next build",
+  start: "next start",
+  generate: "ikas --generate",
+  "prettier:all": "npx prettier@^2.1 './**/src/**/*.(ts|tsx|css|scss)' --write",
+};
+
+export const TS_CONFIG = `{
+  "compilerOptions": {
+    "target": "esnext",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "experimentalDecorators": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "baseUrl": ".",
+    "useUnknownInCatchVariables": false,
+    "incremental": true
+  },
+  "typeRoots": [
+    "./node_modules/@types"
+  ],
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    "**/typings/global.d.ts",
+  ],
+  "exclude": [
+    "node_modules",
+    "./src/pages/api",
+  ]
+}`;
+
+export const NEXT_CONFIG = `const withTM = require("next-transpile-modules")([
+  "@ikas/storefront",
+  "@ikas/storefront-api",
+  "@ikas/storefront-assets",
+  "@ikas/storefront-cmd",
+  "@ikas/storefront-config",
+  "@ikas/storefront-model-functions",
+  "@ikas/storefront-models",
+  "@ikas/storefront-next",
+  "@ikas/storefront-providers",
+]);
+
+const config = {
+  i18n: {
+    defaultLocale: "en",
+    locales: ["en"],
+    localeDetection: false,
+  },
+  basePath: process.env.NEXTJS_BASE_PATH || "",
+
+  images: {
+    deviceSizes: [
+      180, 360, 540, 720, 900, 1080, 1296, 1512, 1728, 1950, 2560, 3840,
+    ],
+  },
+
+  webpack: (config, { buildId, dev, isServer, defaultLoaders, webpack }) => {
+    if (!isServer) {
+      config.resolve.fallback.fs = false;
+      config.resolve.fallback.net = false;
+      config.resolve.fallback.encoding = false;
+      config.resolve.fallback.crypto = false;
+      config.resolve.fallback.assert = false;
+      config.resolve.fallback.stream = false;
+      config.module.rules = [
+        ...config.module.rules,
+        {
+          test: /@ikas/i,
+          sideEffects: false,
+        },
+      ];
+    }
+    return config;
+  },
+};
+
+module.exports = withTM(config);`;
+
+export const DEV_ENV = `NEXT_PUBLIC_ENV=local
+NEXT_PUBLIC_BASE_URL=https://api.myikas.dev/api/sf
+NEXT_PUBLIC_IMG_BASE_URL=https://cdn.myikas.dev/
+NEXT_PUBLIC_UPLOAD_GQL_URL=https://api.myikas.dev/api/admin/graphql
+NEXT_PUBLIC_GQL_URL=https://api.myikas.dev/api/sf/graphql
+`;
+
+export const PROD_ENV = `NEXT_PUBLIC_ENV=local
+NEXT_PUBLIC_BASE_URL=https://api.myikas.com/api/sf
+NEXT_PUBLIC_IMG_BASE_URL=https://cdn.myikas.com/
+NEXT_PUBLIC_UPLOAD_GQL_URL=https://api.myikas.com/api/admin/graphql
+NEXT_PUBLIC_GQL_URL=https://api.myikas.com/api/sf/graphql
+`;
+
+export const BABEL_RC = `{
+  "presets": [
+    [
+      "next/babel",
+      {
+        "preset-react": { "throwIfNamespace": false },
+      }
+    ]
+  ],
+  "plugins": []
+}`;

package/src/scripts/generators/config/index.ts

@@ -0,0 +1,113 @@
+import path from "path";
+import fs from "fs";
+import { sortObject } from "../../../utils/helper";
+import { createFile } from "../../../utils/fs";
+import {
+  TS_CONFIG,
+  BABEL_RC,
+  NEXT_CONFIG,
+  DEPENDENCIES,
+  DEV_DEPENDENCIES,
+  RESOLUTIONS,
+  SCRIPTS,
+  DEV_ENV,
+  PROD_ENV,
+} from "./content";
+
+export type ENV = "dev" | "prod";
+
+export class ConfigGenerator {
+  static async generate(env: ENV, workingDir?: string) {
+    return (
+      (await ConfigGenerator.generateTsConfig(workingDir)) &&
+      (await ConfigGenerator.generateBabelRc(workingDir)) &&
+      (await ConfigGenerator.generateNextConfig(workingDir)) &&
+      (await ConfigGenerator.generatePackageJson(workingDir)) &&
+      (await ConfigGenerator.generateEnv(env, workingDir))
+    );
+  }
+
+  static generateTsConfig(workingDir?: string) {
+    return createFile(workingDir || process.cwd(), "tsconfig.json", TS_CONFIG);
+  }
+
+  static generateBabelRc(workingDir?: string) {
+    return createFile(workingDir || process.cwd(), ".babelrc", BABEL_RC);
+  }
+
+  static generateNextConfig(workingDir?: string) {
+    return createFile(
+      workingDir || process.cwd(),
+      "next.config.js",
+      NEXT_CONFIG
+    );
+  }
+
+  static async generatePackageJson(workingDir?: string) {
+    try {
+      // const fs = await import("fs-extra");
+      const packageJsonPath = path.join(
+        workingDir || process.cwd(),
+        "package.json"
+      );
+      const packageJsonBuffer = fs.readFileSync(packageJsonPath);
+
+      if (packageJsonBuffer.length) {
+        const packageJson = JSON.parse(packageJsonBuffer.toString());
+
+        const setDependencies = (type: "dev" | "normal") => {
+          const dependencies = type === "dev" ? DEV_DEPENDENCIES : DEPENDENCIES;
+          const dependenciesKey =
+            type === "dev" ? "devDependencies" : "dependencies";
+
+          if (
+            !packageJson[dependenciesKey] ||
+            typeof packageJson[dependenciesKey] !== "object"
+          ) {
+            packageJson[dependenciesKey] = dependencies;
+          } else {
+            packageJson[dependenciesKey] = {
+              ...packageJson[dependenciesKey],
+              ...dependencies,
+            };
+          }
+
+          const orderedDependencies = sortObject(packageJson[dependenciesKey]);
+
+          packageJson[dependenciesKey] = orderedDependencies;
+        };
+
+        setDependencies("dev");
+        setDependencies("normal");
+
+        if (!packageJson.scripts || typeof packageJson.scripts !== "object") {
+          packageJson.scripts = SCRIPTS;
+        } else {
+          packageJson.scripts = {
+            ...packageJson.scripts,
+            ...SCRIPTS,
+          };
+        }
+
+        packageJson.resolutions = {
+          ...packageJson.resolutions,
+          ...RESOLUTIONS,
+        };
+
+        return await createFile(
+          packageJsonPath,
+          "",
+          JSON.stringify(packageJson, null, 2)
+        );
+      }
+    } catch (err) {
+      console.error(err);
+      return false;
+    }
+  }
+
+  static generateEnv(env: ENV, workingDir?: string) {
+    const envFileContent = env === "dev" ? DEV_ENV : PROD_ENV;
+    return createFile(workingDir || process.cwd(), ".env", envFileContent);
+  }
+}

package/src/scripts/generators/index.ts

@@ -0,0 +1,6 @@
+export * from "./api";
+export * from "./components";
+export * from "./config";
+export * from "./pages";
+export * from "./theme";
+export * from "./types";

package/src/scripts/generators/pages/index.ts

@@ -0,0 +1,102 @@
+import { IkasThemeJsonPageType } from "@ikas/storefront-models";
+import path from "path";
+import { createFile, deleteDirContent } from "../../../utils/fs";
+import {
+  PageInfo,
+  PAGE_INFO,
+  CHECKOUT_PAGE_CONTENT,
+  EDITOR_PAGE_CONTENT,
+} from "./info";
+
+export class PageGenerator {
+  static async generate(workingDir?: string) {
+    const pagesDir = path.join(workingDir || process.cwd(), "src", "pages");
+    await deleteDirContent(pagesDir, ["_app.tsx", "_document.tsx", "api"]);
+
+    let pagesGenerateSuccess = true;
+    for (const pageInfo of PAGE_INFO) {
+      pagesGenerateSuccess =
+        pagesGenerateSuccess &&
+        (await PageGenerator.generatePageWithInfo(pageInfo, workingDir));
+    }
+
+    const checkoutPageInfo = PAGE_INFO.find((pi) => pi.isCheckout);
+    const editorPageInfo = PAGE_INFO.find((pi) => pi.isEditor);
+
+    const checkoutPageGenerateSuccess = checkoutPageInfo
+      ? await PageGenerator.generatePageWithInfo(checkoutPageInfo, workingDir)
+      : false;
+    const editorPageGenerateSuccess = editorPageInfo
+      ? await PageGenerator.generatePageWithInfo(editorPageInfo, workingDir)
+      : false;
+
+    return (
+      pagesGenerateSuccess &&
+      checkoutPageGenerateSuccess &&
+      editorPageGenerateSuccess
+    );
+  }
+
+  static async generatePageWithInfo(pageInfo: PageInfo, workingDir?: string) {
+    try {
+      let fileStr = "";
+
+      if (pageInfo.isCheckout) {
+        fileStr = CHECKOUT_PAGE_CONTENT;
+      } else if (pageInfo.isEditor) {
+        fileStr = EDITOR_PAGE_CONTENT;
+      } else {
+        const providerName = pageInfo.pageComponentName + "Next";
+        const pageComponentImportStr = `import { ${pageInfo.pageComponentName} } from "@ikas/storefront";\r\n`;
+        const providerImportStr = `import { ${pageInfo.pageComponentName} as ${providerName} } from "@ikas/storefront-next";\r\n`;
+        const componentsImportStr = `import Components from "src/components/__generated__/pages/${pageInfo.path.replace(
+          ".tsx",
+          ""
+        )}";\r\n`;
+
+        const pageComponentStr = `
+const PageComponent = ${pageInfo.pageComponentName}.default;
+
+const Page = (props: any) => {
+  return <PageComponent components={Components} {...props} />;
+};
+
+export default Page;\r\n`;
+
+        const getStaticPathsStr = pageInfo.isDynamicSSG
+          ? `export const getStaticPaths = ${providerName}.getStaticPaths;\r\n`
+          : "";
+
+        const dataFetchingStr = pageInfo.isSSR
+          ? `export const getServerSideProps = ${providerName}.getServerSideProps;\r\n`
+          : `export const getStaticProps = ${providerName}.getStaticProps;\r\n`;
+
+        fileStr =
+          pageComponentImportStr +
+          providerImportStr +
+          componentsImportStr +
+          pageComponentStr +
+          getStaticPathsStr +
+          dataFetchingStr;
+      }
+
+      return await createFile(
+        path.join(workingDir || process.cwd(), "src", "pages"),
+        pageInfo.path,
+        fileStr
+      );
+    } catch (err) {
+      console.error(err);
+      return false;
+    }
+  }
+
+  static async generatePageWithType(pageType: IkasThemeJsonPageType) {
+    const pageInfo = PAGE_INFO.find((pi) => pi.pageTypes.includes(pageType));
+    if (pageInfo) {
+      return await PageGenerator.generatePageWithInfo(pageInfo);
+    }
+
+    return false;
+  }
+}

package/src/scripts/generators/pages/info.ts

@@ -0,0 +1,161 @@
+import { IkasThemeJsonPageType } from "@ikas/storefront-models";
+
+export type PageInfo = {
+  path: string;
+  pageComponentName: string;
+  pageTypes: IkasThemeJsonPageType[];
+  isDynamicSSG?: boolean;
+  isSSR?: boolean;
+  isEditor?: boolean;
+  isCheckout?: boolean;
+};
+
+export const CHECKOUT_COMPONENT_ID = "checkout";
+
+export const PAGE_INFO: PageInfo[] = [
+  {
+    path: "[slug]/index.tsx",
+    pageComponentName: "SlugPage",
+    pageTypes: [
+      IkasThemeJsonPageType.PRODUCT,
+      IkasThemeJsonPageType.CATEGORY,
+      IkasThemeJsonPageType.BRAND,
+    ],
+    isDynamicSSG: true,
+  },
+  {
+    path: "account/orders/[id].tsx",
+    pageComponentName: "OrderDetailPage",
+    pageTypes: [IkasThemeJsonPageType.ORDER_DETAIL],
+    isSSR: true,
+  },
+  {
+    path: "account/orders/index.tsx",
+    pageComponentName: "OrdersPage",
+    pageTypes: [IkasThemeJsonPageType.ORDERS],
+  },
+  {
+    path: "account/addresses.tsx",
+    pageComponentName: "AddressesPage",
+    pageTypes: [IkasThemeJsonPageType.ADDRESSES],
+  },
+  {
+    path: "account/favorite-products.tsx",
+    pageComponentName: "FavoriteProductsPage",
+    pageTypes: [IkasThemeJsonPageType.FAVORITE_PRODUCTS],
+  },
+  {
+    path: "account/forgot-password.tsx",
+    pageComponentName: "ForgotPasswordPage",
+    pageTypes: [IkasThemeJsonPageType.FORGOT_PASSWORD],
+  },
+  {
+    path: "account/index.tsx",
+    pageComponentName: "AccountPage",
+    pageTypes: [IkasThemeJsonPageType.ACCOUNT],
+  },
+  {
+    path: "account/login.tsx",
+    pageComponentName: "LoginPage",
+    pageTypes: [IkasThemeJsonPageType.LOGIN],
+  },
+  {
+    path: "account/raffles.tsx",
+    pageComponentName: "AccountRafflesPage",
+    pageTypes: [IkasThemeJsonPageType.RAFFLE_ACCOUNT],
+  },
+  {
+    path: "account/recover-password.tsx",
+    pageComponentName: "RecoverPasswordPage",
+    pageTypes: [IkasThemeJsonPageType.RECOVER_PASSWORD],
+  },
+  {
+    path: "account/register.tsx",
+    pageComponentName: "RegisterPage",
+    pageTypes: [IkasThemeJsonPageType.REGISTER],
+  },
+  {
+    path: "blog/[slug].tsx",
+    pageComponentName: "BlogSlugPage",
+    pageTypes: [
+      IkasThemeJsonPageType.BLOG,
+      IkasThemeJsonPageType.BLOG_CATEGORY,
+    ],
+    isDynamicSSG: true,
+  },
+  {
+    path: "blog/index.tsx",
+    pageComponentName: "BlogPage",
+    pageTypes: [IkasThemeJsonPageType.BLOG_INDEX],
+  },
+  {
+    path: "pages/[slug].tsx",
+    pageComponentName: "CustomPage",
+    pageTypes: [IkasThemeJsonPageType.CUSTOM],
+    isDynamicSSG: true,
+  },
+  {
+    path: "raffle/[slug].tsx",
+    pageComponentName: "RafflePage",
+    pageTypes: [IkasThemeJsonPageType.RAFFLE_DETAIL],
+    isDynamicSSG: true,
+  },
+  {
+    path: "raffle/index.tsx",
+    pageComponentName: "RafflesPage",
+    pageTypes: [IkasThemeJsonPageType.RAFFLE],
+  },
+  {
+    path: "404.tsx",
+    pageComponentName: "NotFoundPage",
+    pageTypes: [IkasThemeJsonPageType.NOT_FOUND],
+  },
+  {
+    path: "cart.tsx",
+    pageComponentName: "CartPage",
+    pageTypes: [IkasThemeJsonPageType.CART],
+  },
+  {
+    path: "index.tsx",
+    pageComponentName: "IndexPage",
+    pageTypes: [IkasThemeJsonPageType.INDEX],
+  },
+  {
+    path: "search.tsx",
+    pageComponentName: "SearchPage",
+    pageTypes: [IkasThemeJsonPageType.SEARCH],
+  },
+  {
+    path: "checkout.tsx",
+    pageComponentName: "CheckoutPage",
+    pageTypes: [],
+    isCheckout: true,
+  },
+  {
+    path: "editor.tsx",
+    pageComponentName: "EditorPage",
+    pageTypes: [],
+    isEditor: true,
+  },
+];
+
+export const CHECKOUT_PAGE_CONTENT = `import { CheckoutPage } from "@ikas/storefront";
+import { CheckoutPage as CheckoutPageNext } from "@ikas/storefront-next";
+
+export default CheckoutPage.default;
+export const getStaticProps = CheckoutPageNext.getStaticProps;
+`;
+
+export const EDITOR_PAGE_CONTENT = `import { EditorPage } from "@ikas/storefront";
+import { EditorPage as EditorPageNext } from "@ikas/storefront-next";
+import Components from "../components/__generated__/editor";
+
+const PageComponent = EditorPage.default;
+
+const Page = (props: any) => {
+  return <PageComponent components={Components} {...props} />;
+};
+
+export default Page;
+export const getStaticProps = EditorPageNext.getStaticProps;
+`;

package/src/scripts/generators/theme/index.ts

@@ -0,0 +1,63 @@
+import path from "path";
+import fs from "fs";
+import { createFile } from "../../../utils/fs";
+import {
+  IkasThemeJson,
+  IkasThemeJsonPageType,
+  IkasThemeJsonStockPreference,
+} from "@ikas/storefront-models";
+
+export class ThemeJsonGenerator {
+  static generate(themeJson: IkasThemeJson) {
+    return createFile(
+      path.join(process.cwd(), "src", "theme.json"),
+      "",
+      JSON.stringify(themeJson, null, 2)
+    );
+  }
+
+  static generateInitialThemeJsonFile() {
+    const themeJson: IkasThemeJson = {
+      pages: [],
+      components: [],
+      name: "My Theme",
+      customData: [],
+      settings: {
+        colors: [],
+        favicon: {
+          id: null,
+        },
+        fontFamily: {
+          name: null,
+          variants: null,
+        },
+        stockPreference: IkasThemeJsonStockPreference.SHOW_ALL,
+      },
+    };
+
+    themeJson.pages.push({
+      id: "1",
+      components: [],
+      canonicals: null,
+      description: null,
+      disableIndex: null,
+      name: null,
+      pageTitle: null,
+      slug: null,
+      specifications: [],
+      type: IkasThemeJsonPageType.INDEX,
+    });
+
+    return ThemeJsonGenerator.generate(themeJson);
+  }
+
+  static async getTheme() {
+    try {
+      const themePath = path.join(process.cwd(), "src", "theme.json");
+      const fileBuffer = fs.readFileSync(themePath);
+      return fileBuffer.length ? JSON.parse(fileBuffer.toString()) : null;
+    } catch (err) {
+      console.error(err);
+    }
+  }
+}