@antelopejs/dms 0.15.0 → 0.15.1

package/frontend-vue/layers/dms-layout/app/composables/page/useInstalledModules.ts

@@ -0,0 +1,78 @@
+import type { StoreListing } from "#dms-core/app/types/module-store";
+import type { ModuleCatalogEntry } from "#dms-core/app/types/page";
+import type { Ref } from "vue";
+import {
+  sortStoreModules,
+  storeOnlyModules,
+  toModuleStoreEntry,
+  withStoreDetails,
+} from "../../build/utils/module-store-catalog";
+import { ENDPOINT_STORE_LISTING } from "./useModuleStore";
+import { useModulesListing } from "./useModulesListing";
+
+/**
+ * The installed modules, as the Modules page lists them and the sidebar
+ * counts them: the modules that register pages, with the store's details,
+ * and the installed store modules that register none, such as the Builder.
+ * Both read it here, so the badge and the page never count differently.
+ *
+ * @param modulesListing The registered modules
+ * @param moduleStore The module store
+ */
+export const useInstalledModules = (
+  modulesListing: ReturnType<typeof useModulesListing>,
+  moduleStore: { listing: Readonly<Ref<StoreListing | undefined>> },
+) => {
+  const { locale } = useI18n();
+  const { processI18n } = useTranslation();
+
+  const storeModules = computed(() =>
+    sortStoreModules(
+      (moduleStore.listing.value?.modules ?? []).map((entry) =>
+        toModuleStoreEntry(entry, modulesListing.modules.value ?? []),
+      ),
+      processI18n,
+      locale.value,
+    ),
+  );
+
+  const modules = computed<ModuleCatalogEntry[]>(() => {
+    const registered = withStoreDetails(
+      (modulesListing.modules.value ?? []).filter((entry) => entry.hasAccess),
+      storeModules.value,
+    );
+    return [...registered, ...storeOnlyModules(storeModules.value, registered)];
+  });
+
+  return { storeModules, modules };
+};
+
+/**
+ * How many modules are installed, for the sidebar's badge. The store listing
+ * waits on the npm registry, so a server render must not wait for it: the
+ * browser reads it, and the count shows once mounted and the read is over,
+ * whether it answered or failed. Until then the badge is absent, on the server
+ * and on the browser's first render, which a page that handed the listing
+ * over (the Modules page) would otherwise have filled in and mismatched, and
+ * while the read runs, so the count never shows without the store's modules.
+ */
+export const useInstalledModuleCount = () => {
+  const isOwner = useIsOwner();
+  const storeListing = useApiData<StoreListing>(
+    () => (isOwner.value ? ENDPOINT_STORE_LISTING : null),
+    { server: false },
+  );
+  const { modules } = useInstalledModules(useModulesListing(), {
+    listing: computed(() => storeListing.data.value ?? undefined),
+  });
+  const isMounted = ref(false);
+  onMounted(() => (isMounted.value = true));
+  const isSettled = computed(
+    () =>
+      storeListing.status.value === "success" ||
+      storeListing.status.value === "error",
+  );
+  return computed(() =>
+    isMounted.value && isSettled.value ? modules.value.length : 0,
+  );
+};

package/frontend-vue/layers/dms-layout/app/custom-pages/modules.vue

@@ -20,7 +20,6 @@ import {
   useModulesListing,
 } from "../composables/page/useModulesListing";
 import { useModuleHistory } from "../composables/page/useModuleHistory";
-import type { ModuleCatalogEntry } from "#dms-core/app/types/page";
 import {
   MODULE_CATEGORY_ALL,
   MODULE_STORE_PATH,
@@ -33,13 +32,8 @@ import {
   summarizeModules,
   type ModuleSortMode,
 } from "../build/utils/modules-catalog";
-import {
-  sortStoreModules,
-  storeOnlyModules,
-  storeOpenTarget,
-  toModuleStoreEntry,
-  withStoreDetails,
-} from "../build/utils/module-store-catalog";
+import { storeOpenTarget } from "../build/utils/module-store-catalog";
+import { useInstalledModules } from "../composables/page/useInstalledModules";
 import { useModuleStore } from "../composables/page/useModuleStore";
 import { useModuleStoreActions } from "../composables/page/useModuleStoreActions";
 import DmsSearchInput from "#dms-ui/app/entries/components/form/SearchInput";
@@ -123,26 +117,13 @@ const isInitiallyLoading = computed(
 );
 const isRetrying = ref(false);
 
-const storeModules = computed(() =>
-  sortStoreModules(
-    (moduleStore.listing.value?.modules ?? []).map((entry) =>
-      toModuleStoreEntry(entry, modulesListing.modules.value ?? []),
-    ),
-    processI18n,
-    locale.value,
-  ),
+const { storeModules, modules } = useInstalledModules(
+  modulesListing,
+  moduleStore,
 );
 const storeEntries = computed(
   () => new Map(storeModules.value.map((entry) => [entry.id, entry])),
 );
-
-const modules = computed<ModuleCatalogEntry[]>(() => {
-  const registered = withStoreDetails(
-    (modulesListing.modules.value ?? []).filter((entry) => entry.hasAccess),
-    storeModules.value,
-  );
-  return [...registered, ...storeOnlyModules(storeModules.value, registered)];
-});
 const summary = computed(() => summarizeModules(modules.value));
 
 const visitedAt = computed(

package/frontend-vue/layers/dms-layout/i18n/locales/layout-en-GB.json

@@ -1,6 +1,7 @@
 {
   "navigation": {
-    "goToHomepage": "Go to homepage"
+    "goToHomepage": "Go to homepage",
+    "goToBrandHomepage": "{name}, go to homepage"
   },
   "header": {
     "home": "Home",

package/frontend-vue/layers/dms-layout/i18n/locales/layout-fr-FR.json

@@ -1,6 +1,7 @@
 {
   "navigation": {
-    "goToHomepage": "Aller à la page d'accueil"
+    "goToHomepage": "Aller à la page d'accueil",
+    "goToBrandHomepage": "{name}, aller à la page d'accueil"
   },
   "header": {
     "home": "Accueil",

package/frontend-vue/layers/dms-onboarding/app/components/onboarding/steps/register.vue

@@ -23,6 +23,8 @@ import {
 
 interface RegisterStepProps {
   platform: OnboardingPlatform;
+  /** The token the address carried; empty when the wizard has to ask for it. */
+  setupToken: string;
 }
 
 interface RegisterStepEmits {
@@ -43,6 +45,7 @@ const MAX_NAME_PART_LENGTH = 100;
 
 const isLoading = ref(false);
 const isRegistered = ref(false);
+const asksForSetupToken = !props.setupToken;
 
 const namePart = z.string().trim().min(1).max(MAX_NAME_PART_LENGTH);
 
@@ -52,12 +55,14 @@ const fields = z
     lastName: namePart,
     email: z.string().trim().email(),
     password: passwordSchema,
+    setupToken: z.string().trim().min(1),
   })
   .transform((data) => ({
     firstName: striptags(data.firstName),
     lastName: striptags(data.lastName),
     email: striptags(data.email),
     password: data.password,
+    setupToken: data.setupToken,
   }));
 
 type Schema = z.output<typeof fields>;
@@ -68,6 +73,7 @@ const state = reactive<Partial<Schema>>({
   lastName: undefined,
   email: undefined,
   password: undefined,
+  setupToken: props.setupToken,
 });
 useLiveFormErrors(form, state);
 
@@ -106,7 +112,7 @@ async function onSubmit(event: FormSubmitEvent<Schema>) {
     }
 
     await showError(error, "page.onboarding.administrator.error_title", {
-      fields: ["firstName", "lastName", "email", "password"],
+      fields: ["firstName", "lastName", "email", "password", "setupToken"],
       form,
     });
   } finally {
@@ -139,6 +145,20 @@ async function onSubmit(event: FormSubmitEvent<Schema>) {
     >
       <AuthFormAlert :error="formError" />
 
+      <UFormField
+        v-if="asksForSetupToken"
+        :label="$t('page.onboarding.administrator.setup_token')"
+        :help="$t('page.onboarding.administrator.setup_token_help')"
+        name="setupToken"
+      >
+        <UInput
+          v-model="state.setupToken"
+          autocomplete="off"
+          size="lg"
+          class="w-full"
+        />
+      </UFormField>
+
       <div class="grid gap-3 sm:grid-cols-2">
         <UFormField
           :label="$t('page.onboarding.administrator.first_name')"

package/frontend-vue/layers/dms-onboarding/app/custom-pages/onboarding.vue

@@ -26,6 +26,19 @@ watch(metaTitle, (title) => {
 });
 const administrator = ref<OnboardingAdministrator | null>(null);
 
+const route = useDmsRoute();
+const router = useDmsRouter();
+const setupToken = ref("");
+
+useHead({ meta: [{ name: "referrer", content: "no-referrer" }] });
+
+onMounted(() => {
+  const { token, ...query } = route.query;
+  if (typeof token !== "string" || !token) return;
+  setupToken.value = token;
+  void router.replace({ query });
+});
+
 const stepLabels = computed(() =>
   ONBOARDING_STEPS.map((id) => t(`page.onboarding.steps.${id}`)),
 );
@@ -53,6 +66,7 @@ function onRegistered(owner: OnboardingAdministrator) {
     <Register
       v-else-if="step === 'administrator'"
       :platform="platform"
+      :setup-token="setupToken"
       @back="step = 'platform'"
       @registered="onRegistered"
     />

package/frontend-vue/layers/dms-onboarding/i18n/locales/onboarding-en-GB.json

@@ -28,6 +28,8 @@
         "first_name": "First name",
         "last_name": "Last name",
         "name_required": "Required",
+        "setup_token": "Setup token",
+        "setup_token_help": "Printed in the server log when the instance started, or the value of DMS_SETUP_TOKEN.",
         "email": "Work e-mail",
         "submit": "Create administrator account",
         "back": "Back to platform details",

package/frontend-vue/layers/dms-onboarding/i18n/locales/onboarding-fr-FR.json

@@ -28,6 +28,8 @@
         "first_name": "Prénom",
         "last_name": "Nom",
         "name_required": "Obligatoire",
+        "setup_token": "Jeton d'installation",
+        "setup_token_help": "Affiché dans les logs du serveur au démarrage de l'instance, ou valeur de DMS_SETUP_TOKEN.",
         "email": "E-mail professionnel",
         "submit": "Créer le compte administrateur",
         "back": "Retour aux informations de la plateforme",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/dms",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "AntelopeJS DMS. Plug in your PostgreSQL, MongoDB or RethinkDB database and your coding agent builds a back office and analytics dashboard as typed TypeScript. Real-time updates on the data the DMS manages.",
   "keywords": [
     "antelopejs",
@@ -74,8 +74,8 @@
     "@antelopejs/interface-core": ">=0.2.6 <1.0.0",
     "@antelopejs/interface-data-api": ">=0.5.0 <1.0.0",
     "@antelopejs/interface-database": ">=0.1.11 <1.0.0",
-    "@antelopejs/interface-database-decorators": ">=0.1.10 <1.0.0",
-    "@antelopejs/interface-dms": ">=0.10.2 <0.11.0",
+    "@antelopejs/interface-database-decorators": ">=0.1.12 <1.0.0",
+    "@antelopejs/interface-dms": ">=0.10.4 <0.11.0",
     "@antelopejs/interface-email": ">=0.0.6 <1.0.0",
     "@antelopejs/interface-file-storage": ">=0.1.4 <1.0.0",
     "archiver": "^7.0.1",