@vc-shell/create-vc-app 2.0.0-alpha.16 → 2.0.0-alpha.17

package/dist/templates/host-app/_package.json.ejs

@@ -22,8 +22,8 @@
     "@types/node": "^20.10.5",
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
-    "@vc-shell/api-client-generator": "^2.0.0-alpha.16",
-    "@vc-shell/ts-config": "^2.0.0-alpha.16",
+    "@vc-shell/api-client-generator": "^2.0.0-alpha.17",
+    "@vc-shell/ts-config": "^2.0.0-alpha.17",
     "@vitejs/plugin-vue": "^5.2.3",
     "@vue/eslint-config-prettier": "^9.0.0",
     "@vue/eslint-config-typescript": "^13.0.0",
@@ -48,18 +48,16 @@
     "vite-plugin-checker": "^0.9.1",
     "vite-plugin-mkcert": "^1.17.1",
     "vue-eslint-parser": "^9.3.2",
-    "vue-tsc": "^2.2.10"
+    "vue-tsc": "^3.2.5"
   },
   "dependencies": {
-    "@vc-shell/config-generator": "^2.0.0-alpha.16",
-    "@vc-shell/framework": "^2.0.0-alpha.16",
+    "@vc-shell/config-generator": "^2.0.0-alpha.17",
+    "@vc-shell/framework": "^2.0.0-alpha.17",
     "@vueuse/core": "^10.7.1",
     "@vueuse/integrations": "^10.7.1",
-    "cross-spawn": "^7.0.3",
-    "moment": "^2.30.1",
     "vee-validate": "^4.12.4",
-    "vue": "^3.5.13",
-    "vue-router": "^4.2.5"
+    "vue": "^3.5.30",
+    "vue-router": "^5.0.3"
   },
   "lint-staged": {
     "*.{js,ts,html,css}": "prettier --write '**/*.{ts,vue}'",

package/dist/templates/host-app/src/main.ts.ejs

@@ -16,24 +16,26 @@ async function startApp() {
     console.log(e);
   }
 
-  const app = createApp(RouterView)
-    .use(VirtoShellFramework, {
-      router,
-      i18n: {
-        locale: import.meta.env.APP_I18N_LOCALE,
-        fallbackLocale: import.meta.env.APP_I18N_FALLBACK_LOCALE,
-      },
+  const { currentLocale, setLocale } = useLanguages();
+
+  const app = createApp(RouterView);
+
+  app.use(VirtoShellFramework, {
+    router,
+    i18n: {
+      locale: import.meta.env.APP_I18N_LOCALE,
+      fallbackLocale: import.meta.env.APP_I18N_FALLBACK_LOCALE,
+    },
 <% if (aiAgent) { %>
-      aiAgent: {
-        config: {
-          url: import.meta.env.APP_AI_AGENT_URL,
-        },
+    aiAgent: {
+      config: {
+        url: import.meta.env.APP_AI_AGENT_URL,
       },
+    },
 <% } %>
-    })
-    .use(router);
+  });
 
-  const { currentLocale, setLocale } = app.runWithContext(() => useLanguages());
+  app.use(router);
 
   bootstrap(app);
 
@@ -43,7 +45,7 @@ async function startApp() {
 
   setLocale(currentLocale.value);
 
-  app.config.errorHandler = (err) => {
+  app.config.errorHandler = (err: unknown) => {
     notification.error((err as Error).toString(), {
       timeout: 5000,
     });

package/dist/templates/host-app/tsconfig.json

@@ -6,6 +6,7 @@
     "rootDir": "src",
     "types": [
       "vite/client",
+      "@vc-shell/framework/globals"
       ]
   },
   "include": [

package/dist/templates/module/composables/useDetails.ts.ejs

@@ -1,38 +1,41 @@
-import { ref } from "vue";
-import { useAsync, useLoading } from "@vc-shell/framework";
-
-export default function use<%- ModuleNamePascalCase %>Details() {
-  const item = ref<Record<string, unknown>>({});
-
-  const { loading: itemLoading, action: fetchItem } = useAsync(async (id?: string) => {
-    // TODO: Replace with real API call
-    // const result = await apiClient.getById(id);
-    // item.value = result;
-  });
-
-  const { loading: saveLoading, action: saveAction } = useAsync(async () => {
-    // TODO: Replace with real API call
-    // if (item.value.id) {
-    //   await apiClient.update(item.value);
-    // } else {
-    //   await apiClient.create(item.value);
-    // }
-  });
-
-  const loading = useLoading(itemLoading, saveLoading);
-
-  async function getItem(id: string) {
-    await fetchItem(id);
-  }
-
-  async function saveItem() {
-    await saveAction();
-  }
-
-  return {
-    item,
-    loading,
-    getItem,
-    saveItem,
-  };
-}
+import { ref } from "vue";
+import { useAsync, useLoading, useModificationTracker } from "@vc-shell/framework";
+
+export default function use<%- ModuleNamePascalCase %>Details() {
+  const item = ref<Record<string, any>>({});
+  const { isModified, resetModificationState } = useModificationTracker(item);
+
+  const { loading: itemLoading, action: fetchItem } = useAsync(async (id?: string) => {
+    // TODO: Replace with real API call
+    // const result = await apiClient.getById(id);
+    // item.value = result;
+  });
+
+  const { loading: saveLoading, action: saveAction } = useAsync(async () => {
+    // TODO: Replace with real API call
+    // if (item.value.id) {
+    //   await apiClient.update(item.value);
+    // } else {
+    //   await apiClient.create(item.value);
+    // }
+  });
+
+  const loading = useLoading(itemLoading, saveLoading);
+
+  async function getItem(id: string) {
+    await fetchItem(id);
+  }
+
+  async function saveItem() {
+    await saveAction();
+  }
+
+  return {
+    item,
+    loading,
+    getItem,
+    saveItem,
+    isModified,
+    resetModificationState,
+  };
+}

package/dist/templates/module/index.ts.ejs

@@ -1,8 +1,11 @@
-import * as pages from "./pages";
-import * as locales from "./locales";
-import { createAppModule } from "@vc-shell/framework";
-
-export default createAppModule(pages, locales);
-
-export * from "./pages";
-export * from "./composables";
+import * as blades from "./pages";
+import * as locales from "./locales";
+import { defineAppModule } from "@vc-shell/framework";
+
+export default defineAppModule({
+  blades,
+  locales,
+});
+
+export * from "./pages";
+export * from "./composables";

package/dist/templates/module/locales/en.json.ejs

@@ -1,22 +1,33 @@
-{
-  "<%- ModuleNameScreamingSnake %>": {
-    "MENU": {
-      "TITLE": "<%- ModuleNameSentenceCase %>"
-    },
-    "PAGES": {
-      "LIST": {
-        "TITLE": "<%- ModuleNameSentenceCase %>",
-        "TOOLBAR": {
-          "REFRESH": "Refresh",
-          "ADD": "Add"
-        }
-      },
-      "DETAILS": {
-        "TITLE": "<%- ModuleNameSentenceCase %> Details"
-      },
-      "ALERTS": {
-        "CLOSE_CONFIRMATION": "You have unsaved changes. Close anyway?"
-      }
-    }
-  }
-}
+{
+  "<%- ModuleNameScreamingSnake %>": {
+    "MENU": {
+      "TITLE": "<%- ModuleNameSentenceCase %>"
+    },
+    "PAGES": {
+      "LIST": {
+        "TITLE": "<%- ModuleNameSentenceCase %>",
+        "COLUMNS": {
+          "NAME": "Name",
+          "CREATED_DATE": "Created"
+        },
+        "TOOLBAR": {
+          "REFRESH": "Refresh",
+          "ADD": "Add"
+        }
+      },
+      "DETAILS": {
+        "TITLE": "<%- ModuleNameSentenceCase %> Details",
+        "TITLE_NEW": "New <%- ModuleNameSentenceCase %>",
+        "FIELDS": {
+          "NAME": "Name"
+        },
+        "TOOLBAR": {
+          "SAVE": "Save"
+        }
+      }
+    },
+    "ALERTS": {
+      "CLOSE_CONFIRMATION": "You have unsaved changes. Are you sure you want to close?"
+    }
+  }
+}

package/dist/templates/module/pages/details.vue.ejs

@@ -10,7 +10,7 @@
         <!-- Add your form fields here -->
         <VcInput
           v-model="item.name"
-          :label="'Name'"
+          :label="$t('<%- ModuleNameScreamingSnake %>.PAGES.DETAILS.FIELDS.NAME')"
           required
         />
       </VcForm>
@@ -32,29 +32,30 @@ import {
 } from "@vc-shell/framework";
 import { ref, computed, onMounted } from "vue";
 import use<%- ModuleNamePascalCase %>Details from "../composables/useDetails";
+import { useI18n } from "vue-i18n";
 
-defineOptions({
+defineBlade({
   url: "/<%- ModuleName %>-details",
   name: "<%- ModuleNamePascalCase %>Details",
 });
 
+const { t } = useI18n({ useScope: "global" });
 const { param, closeSelf, callParent, onBeforeClose } = useBlade();
 
 const { showConfirmation } = usePopup();
 
-const { item, loading, getItem, saveItem } = use<%- ModuleNamePascalCase %>Details();
-const { isModified, resetModificationState } = useModificationTracker(item);
+const { item, loading, getItem, saveItem, isModified, resetModificationState } = use<%- ModuleNamePascalCase %>Details();
 
 const title = computed(() => {
   return param.value
-    ? String(item.value?.name || "<%- ModuleNameSentenceCase %> Details")
-    : "New <%- ModuleNameSentenceCase %>";
+    ? String(item.value?.name || t("<%- ModuleNameScreamingSnake %>.PAGES.DETAILS.TITLE"))
+    : t("<%- ModuleNameScreamingSnake %>.PAGES.DETAILS.TITLE_NEW");
 });
 
 const bladeToolbar = ref<IBladeToolbar[]>([
   {
     id: "save",
-    title: "Save",
+    title: t("<%- ModuleNameScreamingSnake %>.PAGES.DETAILS.TOOLBAR.SAVE"),
     icon: "lucide-save",
     disabled: computed(() => !isModified.value),
     async clickHandler() {
@@ -73,13 +74,10 @@ onMounted(async () => {
 
 onBeforeClose(async () => {
   if (isModified.value) {
-    return await showConfirmation("You have unsaved changes. Are you sure you want to close?");
+    return !(await showConfirmation(t("<%- ModuleNameScreamingSnake %>.ALERTS.CLOSE_CONFIRMATION")));
   }
+  return false;
 });
 
 useBeforeUnload(computed(() => isModified.value));
-
-defineExpose({
-  title,
-});
 </script>

package/dist/templates/module/pages/list.vue.ejs

@@ -16,8 +16,8 @@
       @pagination-click="(page: number) => { currentPage = page; getItems(); }"
     >
       <!-- Add your columns here -->
-      <VcColumn id="name" :header="'Name'" sortable />
-      <VcColumn id="createdDate" :header="'Created'" type="datetime" sortable />
+      <VcColumn id="name" :header="$t('<%- ModuleNameScreamingSnake %>.PAGES.LIST.COLUMNS.NAME')" sortable />
+      <VcColumn id="createdDate" :header="$t('<%- ModuleNameScreamingSnake %>.PAGES.LIST.COLUMNS.CREATED_DATE')" type="datetime" sortable />
     </VcDataTable>
   </VcBlade>
 </template>
@@ -30,11 +30,11 @@ import {
   useBlade,
   type IBladeToolbar,
 } from "@vc-shell/framework";
-import { ref, computed, markRaw } from "vue";
+import { ref } from "vue";
 import use<%- ModuleNamePascalCase %>List from "../composables/useList";
-import Details from "./details.vue";
+import { useI18n } from "vue-i18n";
 
-defineOptions({
+defineBlade({
   url: "/<%- ModuleName %>",
   name: "<%- ModuleNamePascalCase %>List",
   isWorkspace: true,
@@ -45,7 +45,8 @@ defineOptions({
   },
 });
 
-const { openBlade } = useBlade();
+const { t } = useI18n({ useScope: "global" });
+const { openBlade, exposeToChildren } = useBlade();
 
 const {
   data,
@@ -59,13 +60,13 @@ const {
 const bladeToolbar = ref<IBladeToolbar[]>([
   {
     id: "refresh",
-    title: "Refresh",
+    title: t("<%- ModuleNameScreamingSnake %>.PAGES.LIST.TOOLBAR.REFRESH"),
     icon: "lucide-refresh-cw",
     clickHandler: () => getItems(),
   },
   {
     id: "add",
-    title: "Add",
+    title: t("<%- ModuleNameScreamingSnake %>.PAGES.LIST.TOOLBAR.ADD"),
     icon: "lucide-plus",
     clickHandler: () => openDetails(),
   },
@@ -73,7 +74,7 @@ const bladeToolbar = ref<IBladeToolbar[]>([
 
 function openDetails(item?: { id?: string }) {
   openBlade({
-    blade: markRaw(Details),
+    name: "<%- ModuleNamePascalCase %>Details",
     param: item?.id,
     onClose() {
       getItems();
@@ -83,8 +84,5 @@ function openDetails(item?: { id?: string }) {
 
 getItems();
 
-defineExpose({
-  title: computed(() => "<%- ModuleNameSentenceCase %>"),
-  reload: getItems,
-});
+exposeToChildren({ reload: getItems });
 </script>

package/dist/templates/sample-module/index.ts

@@ -1,8 +1,11 @@
-import * as pages from "./pages";
-import * as locales from "./locales";
-import { createAppModule } from "@vc-shell/framework";
-
-export default createAppModule(pages, locales);
-
-export * from "./pages";
-export * from "./composables";
+import * as blades from "./pages";
+import * as locales from "./locales";
+import { defineAppModule } from "@vc-shell/framework";
+
+export default defineAppModule({
+  blades,
+  locales,
+});
+
+export * from "./pages";
+export * from "./composables";

package/dist/templates/sample-module/pages/details.vue

@@ -132,9 +132,9 @@ import { Field, useForm } from "vee-validate";
 import { useI18n } from "vue-i18n";
 import * as _ from "lodash-es";
 
-defineOptions({
-  url: "/sample-details",
+defineBlade({
   name: "SampleDetails",
+  url: "/sample-details",
 });
 
 const { param, closeSelf, callParent, onBeforeClose } = useBlade();
@@ -197,11 +197,15 @@ onMounted(async () => {
 
 onBeforeClose(async () => {
   if (!isDisabled.value && isModified.value) {
-    return await showConfirmation(t("SAMPLE_APP.PAGES.ALERTS.CLOSE_CONFIRMATION"));
+    return !(await showConfirmation(t("SAMPLE_APP.PAGES.ALERTS.CLOSE_CONFIRMATION")));
   }
+  return false;
 });
 
-useBeforeUnload(computed(() => !isDisabled.value && isModified.value));
 
 
+
+
+
+useBeforeUnload(computed(() => !isDisabled.value && isModified.value));
 </script>