@phis/ui 0.4.1 → 0.4.3

package/types/renderable-block.d.ts

@@ -48,7 +48,12 @@ export type PhiRenderableBlockTransitionEasing = PhiMotionEasing;
 export type PhiRenderableBlockTransitionAxis = "x" | "y" | "z";
 export type PhiRenderableBlockTransitionOrigin = "top left" | "top center" | "top right" | "center left" | "center" | "center right" | "bottom left" | "bottom center" | "bottom right";
 export type PhiRenderableBlockTransitionTrigger = "on_mount" | "on_ready" | "on_visible" | "on_hover" | "on_focus" | "manual";
-export type PhiRenderableBlockViewportEffectAxis = "x" | "y";
+/**
+ * Along which axis a viewport effect moves, or about which one it turns. `z` turns flat in the page plane
+ * and only means something for `rotate`; a translate along `z` is refused when the config is read. Progress
+ * is measured along `x` for `x`, and along the page's own scroll direction for `y` and `z`.
+ */
+export type PhiRenderableBlockViewportEffectAxis = "x" | "y" | "z";
 export type PhiRenderableBlockViewportEffectProperty = "translate" | "opacity" | "rotate" | "scale";
 export type PhiRenderableBlockViewportEffectRangePoint = "enter" | "center" | "exit";
 export type PhiRenderableBlockViewportEffectUnit = "px" | "%" | "deg" | "";

package/types/table-widget.d.ts

@@ -426,6 +426,15 @@ export type PhiTableProviderQueryCapabilities = {
     filterFields?: readonly string[];
     sorting?: "none" | "single" | "multiple";
     pagination?: "none" | "offset" | "cursor";
+    /**
+     * Whether a query of this resource answers `total`, the rows the whole query has.
+     *
+     * Counting is a query of its own on a large table, so a paging resource answers it only where it
+     * says so here. A Table that shows a count -- `totalRows` or `pageCount` in its footer or summary --
+     * needs a resource that counts or does not page; one that pages without a count is paged back and
+     * forward. A resource that does not page answers every row at once, and its rows are its count.
+     */
+    total?: boolean;
     facets?: readonly string[];
     expansion?: boolean;
 };

package/types/table-widget.js

@@ -260,6 +260,26 @@ export function validatePhiTableProviderFieldValue(field, value, row) {
 }
 export function validatePhiTableWidgetBinding(config, resource) {
     const errors = [];
+    /*
+     * A count shown needs a count given. The rows of one page are not the query's, so a Table that says
+     * how many there are, or how many pages, is bound to a resource that counts -- or one that does not
+     * page and so answers every row at once (`query.total`).
+     */
+    const resourceCounts = resource.query.total === true ||
+        (resource.query.pagination !== "offset" && resource.query.pagination !== "cursor");
+    if (!resourceCounts) {
+        const footer = config.presentation.footer;
+        const shownSources = [
+            ...(footer?.values ?? []).map((item) => item.value),
+            ...(footer?.variants ?? []).flatMap((variant) => [variant.when.value, ...(variant.values ?? []).map((item) => item.value)]),
+            ...(config.presentation.summary?.rows ?? []).flatMap((row) => row.cells.map((cell) => cell.item.value)),
+        ];
+        const counted = shownSources.find((source) => source.source === "core" && (source.fieldKey === "totalRows" || source.fieldKey === "pageCount"));
+        if (counted) {
+            errors.push(`Table shows "${counted.fieldKey}", but resource "${resource.resourceKey}" pages without a count ` +
+                "(declare query.total on a resource that answers total).");
+        }
+    }
     const fields = new Set(resource.fields.map((field) => field.key));
     const fieldsByKey = new Map(resource.fields.map((field) => [field.key, field]));
     const columns = config.presentation.columns;

package/types.d.ts

@@ -18,7 +18,7 @@ export * from "./types/spacing";
 export * from "./types/runtime-condition";
 export * from "./types/state-machine";
 export * from "./types/access";
-export type { PhiAuthoringRenderPolicy, PhiCmsBuilderWidgetEditorInteraction, PhiCmsBuilderWidgetPlugin, PhiCmsBuilderWidgetRenderArgs, PhiCmsConfigField, PhiCmsConfigFieldChoiceCreateBehavior, PhiCmsConfigFieldChoiceFilter, PhiCmsConfigFieldChoiceMode, PhiCmsConfigFieldChoicePresentation, PhiCmsConfigFieldChoiceValueType, PhiCmsConfigFieldCollectionPresentation, PhiCmsConfigFieldColorMode, PhiCmsConfigFieldValueStorage, PhiCmsConfigFieldVisibilityRule, PhiCmsLayoutPlugin, PhiCmsLayoutPluginDefinition, PhiCmsLayoutPluginRenderArgs, PhiCmsLayoutSlotDefinition, PhiCmsPluginCommercialMeta, PhiCmsPluginCommercialPlan, PhiCmsPluginLicenseState, PhiCmsPreviewWidgetPlugin, PhiCmsResolvedRequestLoaderArgs, PhiCmsRuntimeWidgetPlugin, PhiCmsServerWidgetPlugin, PhiCmsSiteBridge, PhiCmsSiteRuntime, PhiCmsWidgetAuthoringCanvas, PhiCmsWidgetAuthoringContext, PhiCmsWidgetContentBinding, PhiCmsWidgetPlugin, PhiCmsWidgetPluginDefinition, PhiCmsWidgetPluginRenderArgs, PhiCmsWidgetRuntimeControllerRequirementArgs, PhiCmsWidgetRuntimeControllerRequirementResolver, PhiCmsWidgetSignalSubcontrolCollection, PhiPreviewRenderPolicy, PhiResolvedCmsRequest, PhiRuntimeControllerDefinition, PhiRuntimeControllerFlag, PhiRuntimeControllerMountScope, PhiRuntimeControllerPlugin, PhiRuntimeControllerPreloadMap, PhiRuntimeControllerRenderArgs, PhiRuntimeControllerRequirement, PhiRuntimeControllerServerPreloadArgs, PhiRuntimeControllerSetting, PhiRuntimeModule, PhiRuntimeModuleAuthoringClientProps, PhiRuntimeModuleCalendarAdapterClientDefinition, PhiRuntimeModuleCatalog, PhiRuntimeModuleCatalogEntry, PhiRuntimeModuleClientWidgetDefinition, PhiRuntimeModuleControllerClientProps, PhiRuntimeModuleControllerDescriptor, PhiRuntimeModuleControllerMountPolicy, PhiRuntimeModuleDataProviderClientDefinition, PhiRuntimeModuleDataProviderClientProps, PhiRuntimeModuleDataProviderDescriptor, PhiRuntimeModuleDefinition, PhiRuntimeModuleFeatureContext, PhiRuntimeModuleFeatureResolver, PhiRuntimeModuleFormDefinition, PhiRuntimeModuleLayoutDefinition, PhiRuntimeModuleLoader, PhiRuntimeModuleRenderPolicies, PhiRuntimeModuleUiProvider, PhiRuntimeModuleWidgetDefinition, PhiRuntimeRenderPolicy, } from "./types/cms-plugins";
+export type { PhiAuthoringRenderPolicy, PhiCmsBuilderWidgetEditorInteraction, PhiCmsBuilderWidgetPlugin, PhiCmsBuilderWidgetRenderArgs, PhiCmsConfigField, PhiCmsConfigFieldChoiceCreateBehavior, PhiCmsConfigFieldChoiceFilter, PhiCmsConfigFieldChoiceMode, PhiCmsConfigFieldChoicePresentation, PhiCmsConfigFieldChoiceValueType, PhiCmsConfigFieldCollectionPresentation, PhiCmsConfigFieldColorMode, PhiCmsConfigFieldVisibilityRule, PhiCmsLayoutPlugin, PhiCmsLayoutPluginDefinition, PhiCmsLayoutPluginRenderArgs, PhiCmsLayoutSlotDefinition, PhiCmsPluginCommercialMeta, PhiCmsPluginCommercialPlan, PhiCmsPluginLicenseState, PhiCmsPreviewWidgetPlugin, PhiCmsResolvedRequestLoaderArgs, PhiCmsRuntimeWidgetPlugin, PhiCmsServerWidgetPlugin, PhiCmsSiteBridge, PhiCmsSiteRuntime, PhiCmsWidgetAuthoringCanvas, PhiCmsWidgetAuthoringContext, PhiCmsWidgetContentBinding, PhiCmsWidgetPlugin, PhiCmsWidgetPluginDefinition, PhiCmsWidgetPluginRenderArgs, PhiCmsWidgetRuntimeControllerRequirementArgs, PhiCmsWidgetRuntimeControllerRequirementResolver, PhiCmsWidgetSignalSubcontrolCollection, PhiPreviewRenderPolicy, PhiResolvedCmsRequest, PhiRuntimeControllerDefinition, PhiRuntimeControllerFlag, PhiRuntimeControllerMountScope, PhiRuntimeControllerPlugin, PhiRuntimeControllerPreloadMap, PhiRuntimeControllerRenderArgs, PhiRuntimeControllerRequirement, PhiRuntimeControllerServerPreloadArgs, PhiRuntimeControllerSetting, PhiRuntimeModule, PhiRuntimeModuleAuthoringClientProps, PhiRuntimeModuleCalendarAdapterClientDefinition, PhiRuntimeModuleCatalog, PhiRuntimeModuleCatalogEntry, PhiRuntimeModuleClientWidgetDefinition, PhiRuntimeModuleControllerClientProps, PhiRuntimeModuleControllerDescriptor, PhiRuntimeModuleControllerMountPolicy, PhiRuntimeModuleDataProviderClientDefinition, PhiRuntimeModuleDataProviderClientProps, PhiRuntimeModuleDataProviderDescriptor, PhiRuntimeModuleDefinition, PhiRuntimeModuleFeatureContext, PhiRuntimeModuleFeatureResolver, PhiRuntimeModuleFormDefinition, PhiRuntimeModuleLayoutDefinition, PhiRuntimeModuleLoader, PhiRuntimeModuleRenderPolicies, PhiRuntimeModuleUiProvider, PhiRuntimeModuleWidgetDefinition, PhiRuntimeRenderPolicy, } from "./types/cms-plugins";
 export type * from "./types/cms-presets";
 export type * from "./types/slot-size-policy";
 export type * from "./types/runtime-data-provider";

package/widget-config.d.ts

@@ -7,4 +7,6 @@
  */
 export { readBoolean, readCssSize, readInteger, readNavItems, readNumber, readRenderableBlockConfig, readString, } from "./components/widgets/config/parser-primitives";
 export type { PhiCmsWidgetConfigBase } from "./components/widgets/config/parser-primitives";
+export { PhiConfigError, createPhiConfigReader, isPhiConfigError, } from "./components/widgets/config/strict-config-reader";
+export type { PhiConfigReader } from "./components/widgets/config/strict-config-reader";
 export { normalizePhiRenderableBlockResponsiveSize, normalizePhiRenderableBlockSize, readPhiResponsiveLength, } from "./helpers/renderable-block-normalizers";

package/widget-config.js

@@ -6,5 +6,11 @@
  * logic into every package that ships a Widget.
  */
 export { readBoolean, readCssSize, readInteger, readNavItems, readNumber, readRenderableBlockConfig, readString, } from "./components/widgets/config/parser-primitives";
+/*
+ * Strict reading (THIRD_PARTY_MODULES.md, "Reading a config"). A `parseConfig` built on it throws for a
+ * value that is present and wrong, naming the field; the Site then refuses to store it and a live page
+ * leaves the Widget out. The lenient readers above stay for what has not moved yet.
+ */
+export { PhiConfigError, createPhiConfigReader, isPhiConfigError, } from "./components/widgets/config/strict-config-reader";
 /* A block's size and lengths are read where every other reader of a block reads them (D1). */
 export { normalizePhiRenderableBlockResponsiveSize, normalizePhiRenderableBlockSize, readPhiResponsiveLength, } from "./helpers/renderable-block-normalizers";

package/plugins/runtime-modules/area-base-presets.d.ts

@@ -1,139 +0,0 @@
-import type { PhiCmsDescriptorBuildContext, PhiCmsRoutePresetDescriptor } from "../../types/cms-module-descriptors";
-export declare const PHI_AREA_BASE_RUNTIME_MODULE_AREA_SHELLS: ({
-    ownerModuleId: "@phis/ui/modules/accounting";
-    presetKey: string;
-    shellPresetVersion: number;
-    area: "accounting";
-    loadTree: ({ page, runtime }: PhiCmsDescriptorBuildContext) => Promise<import("../../types").PhiResolvedCmsPageTree>;
-} | {
-    ownerModuleId: "@phis/ui/modules/public";
-    presetKey: string;
-    shellPresetVersion: number;
-    area: "public";
-    exportedNodeKeys: readonly ["widgetBrand", "widgetNav", "widgetLocale"];
-    loadTree: ({ page, runtime }: PhiCmsDescriptorBuildContext) => Promise<import("../../types").PhiResolvedCmsPageTree>;
-} | {
-    ownerModuleId: "@phis/ui/modules/app";
-    presetKey: string;
-    shellPresetVersion: number;
-    area: "app";
-    loadTree: ({ page, runtime }: PhiCmsDescriptorBuildContext) => Promise<{
-        pageMeta: import("../../types").PhiCmsResolvedPageMeta | null | undefined;
-        runtimeModuleIds: `${string}/${string}`[] | null | undefined;
-        regions: import("../../types").PhiCmsRegionNode[];
-        overlays: import("../../types").PhiCmsOverlayNode[];
-        layoutNodes: import("../../types").PhiCmsLayoutNode[];
-        contentWidgets: import("../../types").PhiCmsContentWidgetNode[];
-        controllerSettings: import("../../types/cms").PhiCmsTreeControllerSettings;
-        page: import("../../types").PhiCmsPageNode;
-    }>;
-    exportedNodeKeys?: undefined;
-})[];
-export declare const PHI_AREA_BASE_RUNTIME_MODULE_ROUTES: (PhiCmsRoutePresetDescriptor | {
-    ownerModuleId: "@phis/ui/modules/public";
-    presetKey: string;
-    presetVersion: number;
-    area: "public";
-    title: string;
-    path: string;
-    defaultPageFlags: number;
-    loadTree: ({ page }: PhiCmsDescriptorBuildContext) => Promise<import("../../types").PhiResolvedCmsPageTree>;
-})[];
-export declare const PHI_CORE_RUNTIME_MODULE_THEMES: {
-    loadPreset: () => {
-        readonly key: "phis";
-        readonly version: 1;
-        readonly title: "Phis";
-        readonly description: "Warm orange brand color with a deep blue text base.";
-        readonly palette: {
-            readonly seed: {
-                readonly colorPrimary: "#E05A2A";
-                readonly colorInfo: "#7088BA";
-                readonly colorSuccess: "#4D8F6B";
-                readonly colorWarning: "#D99A2B";
-                readonly colorError: "#C94A3A";
-                readonly colorLink: "#7088BA";
-            };
-            readonly modes: {
-                readonly light: {
-                    readonly seed: {
-                        readonly colorTextBase: "#223A61";
-                        readonly colorBgBase: "#ffffff";
-                    };
-                    readonly overrides: {
-                        readonly colorFillQuaternary: "rgba(34, 58, 97, 0.03)";
-                    };
-                };
-                readonly dark: {
-                    readonly seed: {
-                        readonly colorTextBase: "#DCE7F8";
-                        readonly colorBgBase: "#050914";
-                    };
-                    readonly overrides: {
-                        readonly colorFillQuaternary: "rgba(220, 231, 248, 0.06)";
-                    };
-                };
-            };
-        };
-    };
-    description?: "Warm orange brand color with a deep blue text base." | undefined;
-    ownerModuleId: "@phis/ui/modules/core";
-    presetKey: string;
-    presetVersion: number;
-    themeKey: "phis";
-    title: "Phis";
-}[];
-/**
- * The Public form pages, in their own list because they appear only where Forms are allowed. The
- * contact page is Core's like the terms: every Site starts with a way to be reached, and neither is
- * a landing -- the front door is the Site package's business.
- */
-export declare const PHI_PUBLIC_FORM_RUNTIME_MODULE_ROUTES: ({
-    ownerModuleId: "@phis/ui/modules/public";
-    presetKey: "public-contact-page";
-    presetVersion: number;
-    area: "public";
-    title: string;
-    path: string;
-    navigation: ({
-        navKey: "public:header";
-        parentItemKey: null;
-        after: string;
-        item: {
-            itemKey: string;
-            label: {
-                defaultMessage: string;
-            };
-            icon: string;
-            routePresetKey: string;
-        };
-    } | {
-        navKey: "public:footer";
-        parentItemKey: null;
-        after: string;
-        item: {
-            itemKey: string;
-            label: {
-                defaultMessage: string;
-            };
-            routePresetKey: string;
-            icon?: undefined;
-        };
-    })[];
-    loadTree: ({ page }: PhiCmsDescriptorBuildContext & {
-        activeModuleIds: ReadonlySet<import("./contracts").PhiRuntimeModuleId>;
-        params: Readonly<Record<string, string>>;
-    }) => Promise<import("../../types").PhiResolvedCmsPageTree>;
-} | {
-    ownerModuleId: "@phis/ui/modules/public";
-    presetKey: "public-unsubscribe-page";
-    presetVersion: number;
-    area: "public";
-    title: string;
-    path: string;
-    navigation: never[];
-    loadTree: ({ page }: PhiCmsDescriptorBuildContext & {
-        activeModuleIds: ReadonlySet<import("./contracts").PhiRuntimeModuleId>;
-        params: Readonly<Record<string, string>>;
-    }) => Promise<import("../../types").PhiResolvedCmsPageTree>;
-})[];