@antelopejs/dms 0.11.1 → 0.12.0

package/frontend-vue/layers/dms-core/app/composables/watch/useWatch.ts

@@ -1,11 +1,15 @@
 import { isUndefined } from "../../utils/type-check";
 import { ComponentId } from "../../types/watch";
 
-function getValueByPath(obj: unknown, path: string): unknown {
+function getValueByPath(
+  obj: WatchEventDetail["data"],
+  path: string,
+): WatchActionCondition["value"] {
   const keys = path.split(".");
   let current: unknown = obj;
   for (const key of keys) {
     if (current === null || current === undefined) return undefined;
+    // oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion, anti-slop/no-unsafe-dictionary-type -- Event data has no common schema; this unchecked access intentionally retains primitive boxing and arbitrary nested property traversal rather than rejecting non-record values.
     current = (current as Record<string, unknown>)[key];
   }
   return current;
@@ -36,9 +40,11 @@ interface WatchEventDetail {
   data?: unknown;
 }
 
+type WatchEvent = Event & Partial<Pick<CustomEvent, "detail">>;
+
 function checkParamConditions(
   onParam: WatchAction["onParam"],
-  data: unknown,
+  data: WatchEventDetail["data"],
 ): boolean {
   if (!onParam) return true;
   const conditions = Array.isArray(onParam) ? onParam : [onParam];
@@ -53,7 +59,7 @@ function checkParamConditions(
 
 function isMatchingAction(
   action: WatchAction,
-  event: CustomEvent,
+  event: WatchEvent,
   detail: WatchEventDetail,
   componentId?: string,
 ): boolean {
@@ -68,31 +74,30 @@ function isMatchingAction(
 export function useWatch(
   actions: WatchAction[],
   componentId?: string,
-  defaultState: Record<string, unknown> = {},
+  defaultState: Parameters<WatchActionFunction>[2]["value"] = {},
 ) {
   const isLoading = ref(false);
-  const componentState = ref<Record<string, unknown>>(defaultState);
+  const componentState = ref(defaultState);
   const { getFunction } = useDefinedFunctions();
 
   const requiredEvents = new Set<string>(actions.map((action) => action.event));
 
   function runMatchingActions(
     matchingActions: WatchAction[],
-    event: CustomEvent,
+    event: WatchEvent,
   ) {
     isLoading.value = true;
     try {
       for (const action of matchingActions) {
-        const actionFn = getFunction(action.functionId) as
-          | WatchActionFunction
-          | undefined;
+        const actionFn = getFunction(action.functionId);
         if (!actionFn) {
           continue;
         }
+        // prettier-ignore
         try {
           actionFn(action, event.detail, componentState);
         } catch {
-          /* ignore — a single watch action failure must not break the loop */
+          // eslint-disable-line no-empty -- A synchronous action failure does not stop subsequent actions.
         }
       }
     } finally {
@@ -100,7 +105,7 @@ export function useWatch(
     }
   }
 
-  function handleWatchEvent(event: CustomEvent) {
+  function handleWatchEvent(event: WatchEvent) {
     const { detail } = event;
     if (!detail) {
       return;
@@ -118,11 +123,11 @@ export function useWatch(
   }
 
   onMounted(() => {
-    registerEventListeners(requiredEvents, handleWatchEvent as EventListener);
+    registerEventListeners(requiredEvents, handleWatchEvent);
   });
 
   onUnmounted(() => {
-    unregisterEventListeners(requiredEvents, handleWatchEvent as EventListener);
+    unregisterEventListeners(requiredEvents, handleWatchEvent);
   });
 
   return {

package/frontend-vue/layers/dms-core/app/entries/composables/auth/usePermissionPreview.ts

@@ -0,0 +1 @@
+export * from "../../../build/composables/auth/usePermissionPreview";

package/frontend-vue/layers/dms-core/app/entries/composables/renderNow.ts

@@ -0,0 +1 @@
+export * from "../../build/composables/renderNow";

package/frontend-vue/layers/dms-core/app/entries/composables/user/preferencesCookie.ts

@@ -0,0 +1 @@
+export * from "../../../build/composables/user/preferencesCookie";

package/frontend-vue/layers/dms-core/app/entries/composables/user/tablePreferences.ts

@@ -0,0 +1 @@
+export * from "../../../build/composables/user/tablePreferences";

package/frontend-vue/layers/dms-core/app/entries/i18n/locales/core-en-GB.json.ts

@@ -0,0 +1 @@
+export { default } from "../../../../i18n/locales/core-en-GB.json";

package/frontend-vue/layers/dms-core/app/entries/i18n/locales/core-fr-FR.json.ts

@@ -0,0 +1 @@
+export { default } from "../../../../i18n/locales/core-fr-FR.json";

package/frontend-vue/layers/dms-core/app/entries/shared/types/app-config.ts

@@ -0,0 +1 @@
+export * from "../../../../shared/types/app-config";

package/frontend-vue/layers/dms-core/app/entries/shared/types/runtime-config.ts

@@ -0,0 +1 @@
+import type {} from "../../../../shared/types/runtime-config";

package/frontend-vue/layers/dms-core/app/entries/types/block-action.ts

@@ -0,0 +1,12 @@
+import type { ButtonProps } from "@nuxt/ui";
+import type { Tone } from "../../types/tone";
+
+/** A link button a block option declares (interface-dms `BlockLinkAction`). */
+export interface BlockAction {
+  label: string;
+  /** Route, `#anchor` or URL; an absolute URL opens in a new tab. */
+  to: string;
+  icon?: string;
+  variant?: ButtonProps["variant"];
+  color?: Tone;
+}

package/frontend-vue/layers/dms-core/app/entries/utils/asyncDataScope.ts

@@ -0,0 +1 @@
+export * from "../../build/utils/asyncDataScope";

package/frontend-vue/layers/dms-core/app/entries/utils/crossTab.ts

@@ -0,0 +1 @@
+export * from "../../build/utils/crossTab";

package/frontend-vue/layers/dms-core/app/entries/utils/permission-preview.ts

@@ -0,0 +1 @@
+export * from "../../build/utils/permission-preview";

package/frontend-vue/layers/dms-core/app/plugins/async-data-scope.ts

@@ -20,7 +20,7 @@ export default defineDmsPlugin(() => {
   const { session } = useDmsUserSession<unknown, ScopedSession>();
   const scope = () => asyncDataScopeOf(session.value);
   setDmsAsyncDataScope(scope());
-  // One app per request on a server: its session never changes there.
+
   if (typeof window === "undefined") return;
   watch(scope, (next) => setDmsAsyncDataScope(next));
 });

package/frontend-vue/layers/dms-core/app/types/composed-text.ts

@@ -1,7 +1,9 @@
-// Mirror of ComposedText and its parameters from
-// @antelopejs/interface-dms/base/types/composed-text.
-
-/** A text composed in the reader's language from an i18n key and raw values. */
+/**
+ * A text composed in the reader's language from an i18n key and raw values.
+ * Keep this shape and its parameter types in sync with
+ * `@antelopejs/interface-dms/base/types/composed-text`, which defines the
+ * payload the backend sends.
+ */
 export interface ComposedText {
   /** The i18n key of the message; the leading `$` is optional. */
   key: string;

package/frontend-vue/layers/dms-core/app/types/confirm-dialog.ts

@@ -1,3 +1,5 @@
+import type { I18nTranslate } from "../composables/translation/useTranslation";
+
 /** One dependent a confirmed action affects, listed in its dialog. */
 export interface ConfirmDialogImpact {
   icon: string;
@@ -71,7 +73,7 @@ export interface ConfirmDialogSecondaryAction {
 export interface ConfirmDialog {
   title: string;
   description?: string;
-  params?: Record<string, unknown>;
+  params?: Parameters<I18nTranslate>[1];
   icon?: string;
   color?: ConfirmDialogColor;
   confirmLabel?: string;

package/frontend-vue/layers/{dms-ui → dms-core}/app/types/live.ts

@@ -34,7 +34,9 @@ export type PageLiveNoteTone = "neutral" | "warning" | "error";
  */
 export interface PageLiveNote {
   text: string;
-  params?: Record<string, unknown>;
+  params?: Parameters<
+    import("#dms-core/app/composables/translation/useTranslation").I18nTranslate
+  >[1];
   tone?: PageLiveNoteTone;
 }
 

package/frontend-vue/layers/dms-core/app/types/menu.ts

@@ -1,4 +1,5 @@
 import type { NavigationMenuItem } from "@nuxt/ui";
+import type { ValidationRouteContext } from "../utils/query-validation";
 
 /** Semantic look of a menu entry, mirroring `MenuItemVariant` in the backend. */
 export type MenuItemVariant = "default" | "accent";
@@ -60,5 +61,5 @@ export interface DmsMenuItem extends NavigationMenuItem {
 /** The route a menu is highlighted against. */
 export interface MenuRouteState {
   path: string;
-  query: Record<string, unknown>;
+  query: ValidationRouteContext["query"];
 }

package/frontend-vue/layers/{dms-layout → dms-core}/app/types/module-store.ts

@@ -133,6 +133,7 @@ export interface StoreDependencyChoice {
   /** npm package, never a git or local source. */
   package: string;
   /** Config written to its antelope.config.ts entry. */
+  // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- Each installed module owns its config schema; deriving from StoreDependencyChoice on the backend yields the same open dictionary, while a built-in module's schema would exclude third-party config.
   config?: Record<string, unknown>;
 }
 

package/frontend-vue/layers/{dms-layout → dms-core}/app/types/page.ts

@@ -1,11 +1,9 @@
 import type { BlockText } from "#dms-core/app/types/composed-text";
-import type { BlockAction } from "#dms-ui/app/build/components/blocks/BlockActions.vue";
-import type { PageLiveOptions } from "#dms-ui/app/types/live";
+import type { BlockAction } from "#dms-core/app/entries/types/block-action";
+import type { PageLiveOptions } from "#dms-core/app/types/live";
 import type { ModuleSourceKind } from "./module-store";
 
 export type MenuItemType = "label" | "link";
-// MenuItemVariant / MenuItemStatus / MenuItemQuery live in dms-core, the layer
-// that renders them: this one only consumes them.
 
 export interface PageValidation {
   requiredQueryParams?: string[];
@@ -51,9 +49,12 @@ export interface CategoryInfo extends Omit<MenuOptions, "category"> {
   urlTransparent?: boolean;
 }
 
-// Mirror of ModuleInfo and MODULE_URL_PREFIX from @antelopejs/interface-dms/page.
-// The frontend module cannot import backend types directly, so any change to the
-// backend definitions must be reflected here (and vice versa).
+/**
+ * Serialized projection of `ModuleInfo` from `@antelopejs/interface-dms/page`.
+ * Keep its data fields in sync with that contract. The backend's callable
+ * `status` and `readout` hooks are omitted here; `ModuleCatalogEntry` carries
+ * their resolved values instead.
+ */
 export interface ModuleInfo {
   id: string;
   title: string;
@@ -72,9 +73,11 @@ export interface ModuleInfo {
 
 export type ModuleWithAccess = ModuleInfo & { hasAccess: boolean };
 
-// Mirror of ModuleStatus / ModuleReadoutLine from @antelopejs/interface-dms/page.
+/** Keep in sync with `ModuleStatus` from `@antelopejs/interface-dms/page`. */
 export type ModuleStatus = "live" | "beta" | "update" | "attention";
+/** Keep in sync with `ModuleReadoutTone` from `@antelopejs/interface-dms/page`. */
 export type ModuleReadoutTone = "success" | "info" | "warning" | "error";
+/** Keep in sync with `ModuleReadoutLine` from `@antelopejs/interface-dms/page`. */
 export interface ModuleReadoutLine {
   text: string;
   tone?: ModuleReadoutTone;
@@ -96,6 +99,7 @@ export type ModuleCatalogEntry = ModuleWithAccess & {
   source?: ModuleSourceKind;
 };
 
+/** Keep in sync with `MODULE_URL_PREFIX` from `@antelopejs/interface-dms/page`. */
 export const MODULE_URL_PREFIX = "/modules";
 
 export interface PageInfo extends Omit<CategoryInfo, "category"> {
@@ -112,10 +116,11 @@ export type SiteLayoutTree = Omit<PageInfo, "layoutUrl"> & {
   /** The tone of a `badge` the server counted (`navBadge`); neutral when absent. */
   badgeTone?: MenuItemBadgeTone;
 };
-// Mirror of LayoutBannerVariant from @antelopejs/interface-dms/layout-banners.
+
+/** Keep in sync with `LayoutBannerVariant` from `@antelopejs/interface-dms/layout-banners`. */
 export type LayoutBannerVariant = "info" | "warning" | "error";
 
-// Mirror of LayoutBannerScope from @antelopejs/interface-dms/layout-banners.
+/** Keep in sync with `LayoutBannerScope` from `@antelopejs/interface-dms/layout-banners`. */
 export type LayoutBannerScope = "app" | "modules" | "everywhere";
 
 /**
@@ -137,6 +142,7 @@ export interface LayoutBanner {
   /** Link buttons after the text; the last one leads. */
   actions?: BlockAction[];
   component?: string;
+  // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- Banner components accept module-defined serialized props; inference cannot describe them and the frontend has no interface-dms dependency from which to derive the backend contract.
   props?: Record<string, unknown>;
 }
 
@@ -188,6 +194,7 @@ export interface ComponentChild<T = object> {
   id: string;
   component: ComponentInfo<T>;
   slot?: string;
+  // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- Component children carry module-defined sibling metadata independently of generic options T; inferring from built-in children would narrow this public extension contract.
   [key: string]: unknown;
 }
 
@@ -204,7 +211,7 @@ export interface ResolvedComponentInfo<T = object> {
   componentName?: string;
   children: ResolvedComponentInfo[];
   slot?: string;
-  [key: string]: unknown;
+  [key: string]: ComponentChild<T>[string];
 }
 
 export interface PageLayout {

package/frontend-vue/layers/dms-core/app/types/row-action-operators.ts

@@ -1,3 +1,5 @@
+import type { DataTypeFormatter } from "../composables/data-types/useDataType";
+
 type FieldComparatorSingle = <T>(fieldValue: T, ruleValue: T) => boolean;
 type FieldComparatorArray = <T>(fieldValue: T, ruleValue: T[]) => boolean;
 
@@ -52,7 +54,9 @@ export type FieldRule<
 }[keyof T];
 
 export type AnyFieldRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = {
   [Op in FieldOperatorKey]: FieldRule<T, Op>;
 }[FieldOperatorKey];

package/frontend-vue/layers/dms-core/app/types/row-action.ts

@@ -1,50 +1,71 @@
 import type { AnyFieldRule, FieldRule } from "./row-action-operators";
 import type { ActionConfirm } from "./confirm-dialog";
+import type { DataTypeFormatter } from "../composables/data-types/useDataType";
 
 export type FieldEqualsRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = FieldRule<T, "equals">;
 
 export type FieldNotEqualsRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = FieldRule<T, "notEquals">;
 
 export type FieldInRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = FieldRule<T, "in">;
 
 export type FieldNotInRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = FieldRule<T, "notIn">;
 
 export type AndRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = {
   and: RowActionRule<T>[];
 };
 
 export type OrRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = {
   or: RowActionRule<T>[];
 };
 
 export type NotRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = {
   not: RowActionRule<T>;
 };
 
 export type LogicalRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = AndRule<T> | OrRule<T> | NotRule<T>;
 
 export type RowActionRule<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > = AnyFieldRule<T> | LogicalRule<T>;
 
 export interface RowActionConfig<
-  T extends Record<string, unknown> = Record<string, unknown>,
+  T extends NonNullable<Parameters<DataTypeFormatter>[3]> = NonNullable<
+    Parameters<DataTypeFormatter>[3]
+  >,
 > {
   isEnabled?: boolean;
   isVisible?: boolean;

package/frontend-vue/layers/dms-core/app/types/watch.ts

@@ -8,6 +8,7 @@ export const ComponentId = {
 export type WatchActionFunction = (
   action: WatchAction,
   eventData: ComponentEventData,
+  // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- useWatch owns arbitrary mutable component state and also uses Record<string, unknown>; a JSON-only or one-component type would narrow this public callback contract.
   componentState: Ref<Record<string, unknown>>,
 ) => void;
 
@@ -20,6 +21,7 @@ export interface WatchAction {
   component: string;
   event: string;
   functionId: string;
+  // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- Registered action functions own their heterogeneous parameters; no shared schema or ComponentOptionsData contract covers all public action callers.
   params?: Record<string, unknown>;
   onParam?: WatchActionCondition | WatchActionCondition[];
 }

package/frontend-vue/layers/dms-core/app/utils/composedText.ts

@@ -14,6 +14,7 @@ import type {
 import {
   readTranslationKey,
   resolveI18nKey,
+  type I18nTranslate,
 } from "../composables/translation/useTranslation";
 import {
   formatDate,
@@ -21,11 +22,12 @@ import {
   formatRelativeDistance,
   readableNumberFormat,
 } from "./formatter";
+import { isNumber, isObject, isString } from "./type-check";
 
 /** `t` as vue-i18n takes it: the key, the named values, the plural count. */
 export type ComposedTextTranslate = (
   key: string,
-  named: Record<string, unknown>,
+  named: Parameters<I18nTranslate>[1],
   plural?: number,
 ) => string;
 
@@ -52,7 +54,6 @@ type ParamFormatters = {
   >;
 };
 
-// What a currency without a known minor unit is assumed to have, as most do.
 const DEFAULT_MINOR_DIGITS = 2;
 const DECIMAL_BASE = 10;
 const DEFAULT_DATE_FORMAT: ComposedTextDateFormat = "medium";
@@ -65,8 +66,6 @@ const DATE_FORMATS: Record<ComposedTextDateFormat, Intl.DateTimeFormatOptions> =
     long: { dateStyle: "long" },
   };
 
-// Intl refuses `dateStyle` next to `hour`, so each format names its time the
-// way its date is written.
 const DATETIME_FORMATS: Record<
   ComposedTextDateFormat,
   Intl.DateTimeFormatOptions
@@ -87,20 +86,16 @@ const NUMBER_FORMATS: Record<
 };
 
 /** Whether a value is a composed text rather than a plain string. */
-export function isComposedText(value: unknown): value is ComposedText {
-  return (
-    typeof value === "object" &&
-    value !== null &&
-    typeof (value as ComposedText).key === "string"
-  );
+export function isComposedText(
+  value: Parameters<typeof isObject>[0],
+): value is ComposedText {
+  return isObject(value) && value !== null && isString(value.key);
 }
 
-function isTypedParam(value: unknown): value is ComposedTextTypedParam {
-  return (
-    typeof value === "object" &&
-    value !== null &&
-    typeof (value as ComposedTextTypedParam).type === "string"
-  );
+function isTypedParam(
+  value: Parameters<typeof isObject>[0],
+): value is ComposedTextTypedParam {
+  return isObject(value) && value !== null && isString(value.type);
 }
 
 function formatMoney(
@@ -116,7 +111,6 @@ function formatMoney(
       format.resolvedOptions().maximumFractionDigits ?? DEFAULT_MINOR_DIGITS;
     return format.format(param.value / DECIMAL_BASE ** digits);
   } catch {
-    // A malformed currency code: the amount is still worth showing.
     return String(
       formatNumber(param.value / DECIMAL_BASE ** DEFAULT_MINOR_DIGITS, locale),
     );
@@ -146,7 +140,6 @@ function formatRelativeParam(
   param: ComposedTextRelativeDateParam,
   { locale, now }: ComposedTextContext,
 ): string {
-  // Intl throws on an invalid date: the raw value beats a broken page.
   if (Number.isNaN(new Date(param.value).getTime())) return String(param.value);
   return formatRelativeDistance(param.value, locale, { now });
 }
@@ -164,21 +157,22 @@ function formatParam(
   param: ComposedTextParam,
   context: ComposedTextContext,
 ): string {
-  if (typeof param === "string") return param;
-  if (typeof param === "number") {
+  if (isString(param)) return param;
+  if (isNumber(param)) {
     return String(formatNumber(param, context.locale));
   }
   if (isComposedText(param)) return composeText(param, context);
+  // oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion -- ParamFormatters preserves the nominal discriminator correlation, which indexed union inference loses. A switch would change legacy lookup behavior for malformed and inherited type keys.
   const formatter = PARAM_FORMATTERS[param.type] as
     | ParamFormatter<ComposedTextTypedParam>
     | undefined;
-  // A type from a newer backend: its raw value beats a hole in the sentence.
+
   return formatter ? formatter(param, context) : String(param.value ?? "");
 }
 
 function numberOf(param: ComposedTextParam | undefined): number | undefined {
-  if (typeof param === "number") return param;
-  if (isTypedParam(param) && typeof param.value === "number") {
+  if (isNumber(param)) return param;
+  if (isTypedParam(param) && isNumber(param.value)) {
     return param.value;
   }
   return undefined;
@@ -224,7 +218,7 @@ export function resolveComposedText(
   context: ComposedTextContext,
 ): string {
   if (text === null || text === undefined) return "";
-  if (typeof text === "number") {
+  if (isNumber(text)) {
     return String(formatNumber(text, context.locale));
   }
   if (isComposedText(text)) return composeText(text, context);

package/frontend-vue/layers/dms-core/app/utils/dedupedRefresh.ts

@@ -9,10 +9,12 @@
  * token out from under each other and log the user out.
  */
 export function runDeduped<T>(
+  // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- Public holder slots may contain unrelated values. A Promise<T>-valued dictionary would reject existing holder objects rather than validate the selected slot.
   holder: Record<PropertyKey, unknown>,
   key: PropertyKey,
   task: () => Promise<T>,
 ): Promise<T> {
+  // oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion -- The selected slot is historically trusted without validation, including truthy non-promises. Inference cannot prove Promise<T>; adding validation would change malformed-holder behavior.
   const existing = holder[key] as Promise<T> | null | undefined;
   if (existing) {
     return existing;