@proteos/sdk 0.22.0 → 0.23.0

package/dist/{types-DT29DVEj.d.ts → types-B0LqBATf.d.ts}

@@ -1523,6 +1523,47 @@ declare const PageLayoutSidePanelSchema: z.ZodObject<{
     width?: SizeValue | undefined;
     is_sticky?: boolean | undefined;
 }>;
+/**
+ * Design-token keys a page background may name instead of a raw CSS color. The
+ * web resolver maps each to `var(--color-<key>)`. Keep in sync with
+ * `pageBackgroundTokens` in the metadata-service layout validator.
+ */
+declare const PAGE_BACKGROUND_TOKENS: readonly ["bg", "bg-2", "bg-3", "ink", "ink-2", "ink-3", "ink-4", "rule", "rule-2", "accent", "accent-2", "accent-ink", "success", "warning", "danger", "info"];
+type PageBackgroundToken = (typeof PAGE_BACKGROUND_TOKENS)[number];
+/**
+ * Per-page presentation of a standalone page shell: background color plus the
+ * content container's max-width and side / top padding. Every field is
+ * optional; an omitted field falls back to the renderer default (the historical
+ * bg / 1200px / 24px-32px look). `max_width: "fill"` (or `"auto"`) with zero
+ * padding lets a component fill the page edge-to-edge.
+ *
+ * Honored only on `public` and `kiosk` pages in v1 (enforced server-side).
+ */
+interface PageStyle {
+    /** Design-token key (see PAGE_BACKGROUND_TOKENS) or a raw CSS color. */
+    background?: string;
+    /** Content max-width; `"fill"` / `"auto"` removes the cap. */
+    max_width?: SizeValue;
+    /** Horizontal / vertical padding of the content container (Tailwind px/py). */
+    padding_x?: SizeValue;
+    padding_y?: SizeValue;
+}
+declare const PageStyleSchema: z.ZodObject<{
+    background: z.ZodOptional<z.ZodString>;
+    max_width: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+    padding_x: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+    padding_y: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+}, "strip", z.ZodTypeAny, {
+    background?: string | undefined;
+    max_width?: SizeValue | undefined;
+    padding_x?: SizeValue | undefined;
+    padding_y?: SizeValue | undefined;
+}, {
+    background?: string | undefined;
+    max_width?: SizeValue | undefined;
+    padding_x?: SizeValue | undefined;
+    padding_y?: SizeValue | undefined;
+}>;
 /**
  * Top-level page layout. Replaces the legacy `mainContent` / `side_panel`
  * arrays of `PageSection`s with a single typed element tree.
@@ -1531,6 +1572,7 @@ interface PageLayout {
     version: 1;
     main: LayoutElement;
     side_panel?: PageLayoutSidePanel;
+    style?: PageStyle;
 }
 declare const PageLayoutSchema: z.ZodObject<{
     version: z.ZodLiteral<1>;
@@ -1548,6 +1590,22 @@ declare const PageLayoutSchema: z.ZodObject<{
         width?: SizeValue | undefined;
         is_sticky?: boolean | undefined;
     }>>;
+    style: z.ZodOptional<z.ZodObject<{
+        background: z.ZodOptional<z.ZodString>;
+        max_width: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+        padding_x: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+        padding_y: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+    }, "strip", z.ZodTypeAny, {
+        background?: string | undefined;
+        max_width?: SizeValue | undefined;
+        padding_x?: SizeValue | undefined;
+        padding_y?: SizeValue | undefined;
+    }, {
+        background?: string | undefined;
+        max_width?: SizeValue | undefined;
+        padding_x?: SizeValue | undefined;
+        padding_y?: SizeValue | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     version: 1;
     main: LayoutElement;
@@ -1556,6 +1614,12 @@ declare const PageLayoutSchema: z.ZodObject<{
         width?: SizeValue | undefined;
         is_sticky?: boolean | undefined;
     } | undefined;
+    style?: {
+        background?: string | undefined;
+        max_width?: SizeValue | undefined;
+        padding_x?: SizeValue | undefined;
+        padding_y?: SizeValue | undefined;
+    } | undefined;
 }, {
     version: 1;
     main: LayoutElement;
@@ -1564,6 +1628,12 @@ declare const PageLayoutSchema: z.ZodObject<{
         width?: SizeValue | undefined;
         is_sticky?: boolean | undefined;
     } | undefined;
+    style?: {
+        background?: string | undefined;
+        max_width?: SizeValue | undefined;
+        padding_x?: SizeValue | undefined;
+        padding_y?: SizeValue | undefined;
+    } | undefined;
 }>;
 
 /**
@@ -3051,6 +3121,22 @@ declare const PageSchema: z.ZodObject<{
             width?: SizeValue | undefined;
             is_sticky?: boolean | undefined;
         }>>;
+        style: z.ZodOptional<z.ZodObject<{
+            background: z.ZodOptional<z.ZodString>;
+            max_width: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+            padding_x: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+            padding_y: z.ZodOptional<z.ZodType<SizeValue, z.ZodTypeDef, SizeValue>>;
+        }, "strip", z.ZodTypeAny, {
+            background?: string | undefined;
+            max_width?: SizeValue | undefined;
+            padding_x?: SizeValue | undefined;
+            padding_y?: SizeValue | undefined;
+        }, {
+            background?: string | undefined;
+            max_width?: SizeValue | undefined;
+            padding_x?: SizeValue | undefined;
+            padding_y?: SizeValue | undefined;
+        }>>;
     }, "strip", z.ZodTypeAny, {
         version: 1;
         main: LayoutElement;
@@ -3059,6 +3145,12 @@ declare const PageSchema: z.ZodObject<{
             width?: SizeValue | undefined;
             is_sticky?: boolean | undefined;
         } | undefined;
+        style?: {
+            background?: string | undefined;
+            max_width?: SizeValue | undefined;
+            padding_x?: SizeValue | undefined;
+            padding_y?: SizeValue | undefined;
+        } | undefined;
     }, {
         version: 1;
         main: LayoutElement;
@@ -3067,6 +3159,12 @@ declare const PageSchema: z.ZodObject<{
             width?: SizeValue | undefined;
             is_sticky?: boolean | undefined;
         } | undefined;
+        style?: {
+            background?: string | undefined;
+            max_width?: SizeValue | undefined;
+            padding_x?: SizeValue | undefined;
+            padding_y?: SizeValue | undefined;
+        } | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "platform" | "record" | "kiosk" | "public";
@@ -3096,6 +3194,12 @@ declare const PageSchema: z.ZodObject<{
             width?: SizeValue | undefined;
             is_sticky?: boolean | undefined;
         } | undefined;
+        style?: {
+            background?: string | undefined;
+            max_width?: SizeValue | undefined;
+            padding_x?: SizeValue | undefined;
+            padding_y?: SizeValue | undefined;
+        } | undefined;
     };
     entity_slug?: string | undefined;
 }, {
@@ -3126,6 +3230,12 @@ declare const PageSchema: z.ZodObject<{
             width?: SizeValue | undefined;
             is_sticky?: boolean | undefined;
         } | undefined;
+        style?: {
+            background?: string | undefined;
+            max_width?: SizeValue | undefined;
+            padding_x?: SizeValue | undefined;
+            padding_y?: SizeValue | undefined;
+        } | undefined;
     };
     entity_slug?: string | undefined;
 }>;
@@ -3530,4 +3640,4 @@ interface DesignReferenceContent {
     content: string;
 }
 
-export { type FilterGroup as $, type AuditFields as A, CurrencyAttributeMetaSchema as B, type ClientOptions as C, type CurrencySymbolSide as D, type CurrencyValue as E, type FileRef as F, DEFAULT_OPTIONS as G, DEFAULT_PAGE_SIZE as H, DONE as I, type DeployModuleRequest as J, type DesignReference as K, type ListOptions as L, type DesignReferenceContent as M, DesignReferenceSchema as N, type DesignReferenceService as O, PageIterator as P, type Done as Q, type Entity as R, EntitySchema as S, type EntityService as T, type UserRef as U, type EntityWithSchema as V, EntityWithSchemaSchema as W, type FileAttributeMeta as X, FileRefSchema as Y, type FilterElement as Z, FilterElementSchema as _, type Attribute as a, type UpdatePageRequest as a$, FilterGroupSchema as a0, type List as a1, type ListAppsOptions as a2, type ListComponentsOptions as a3, type ListDesignReferencesOptions as a4, type ListEntitiesOptions as a5, type ListFn as a6, type ListListViewsOptions as a7, type ListListsOptions as a8, type ListMenuConfigurationsOptions as a9, type PageAction as aA, PageActionSchema as aB, type PageLayout as aC, PageLayoutSchema as aD, PageSchema as aE, type PageService as aF, type PageType as aG, type PublicPageComponent as aH, type PublicPageResponse as aI, type RelationAttributeMeta as aJ, RelationAttributeMetaSchema as aK, type RequestOptions as aL, type ResolvedClientOptions as aM, type ResponseMeta as aN, ResponseMetaSchema as aO, type SortConfig as aP, SortConfigSchema as aQ, type SortDirection as aR, type Timestamps as aS, type TokenProvider as aT, type UpdateAppRequest as aU, type UpdateComponentRequest as aV, type UpdateDesignReferenceRequest as aW, type UpdateEntityRequest as aX, type UpdateListRequest as aY, type UpdateListViewRequest as aZ, type UpdateMenuConfigurationRequest as a_, type ListModulesOptions as aa, type ListPagesOptions as ab, ListSchema as ac, type ListService as ad, type ListVariablesOptions as ae, type ListView as af, ListViewSchema as ag, type ListViewService as ah, type LogicalOperator as ai, type MenuConfiguration as aj, MenuConfigurationSchema as ak, type MenuConfigurationService as al, type MenuItem as am, MenuItemSchema as an, MenuItemType as ao, MetaClient as ap, type MetaListOptions as aq, type Module as ar, ModuleSchema as as, type ModuleService as at, type ModuleStatus as au, type OnDeleteAction as av, OnDeleteActionSchema as aw, PLATFORM_ATTRIBUTE_NAMES as ax, PLATFORM_USER_ID as ay, type Page as az, type ListResult as b, isBuiltInControl as b$, type UpdateVariableRequest as b0, UserRefSchema as b1, type UserType as b2, type Variable as b3, VariableSchema as b4, type VariableService as b5, allCurrencyCodes as b6, createIterator as b7, createListResultSchema as b8, currencyLabel as b9, type FieldElement as bA, FileAttributeMetaSchema as bB, type LayoutAlign as bC, type LayoutElement as bD, LayoutElementSchema as bE, LayoutElementType as bF, type LayoutGap as bG, type LayoutJustify as bH, type LayoutTab as bI, type NumberAttributeMeta as bJ, type ObjectAttributeMeta as bK, type PageLayoutSidePanel as bL, PageLayoutSidePanelSchema as bM, type RelatedListElement as bN, type ResponsiveSizing as bO, type RowElement as bP, type SectionElement as bQ, type SizeValue as bR, SizeValueSchema as bS, type SizingProps as bT, type StringAttributeMeta as bU, type StringFormat as bV, type TabsElement as bW, type TextElement as bX, type TextVariant as bY, type UserAttributeMeta as bZ, UserAttributeMetaSchema as b_, currencySymbol as ba, currencySymbolSide as bb, formatAmount as bc, formatMoney as bd, isPlatformAttributeName as be, localeNumberSeparators as bf, parseAmount as bg, parseCurrencyMeta as bh, parseFileMeta as bi, parseRelationMeta as bj, platformAttributes as bk, resolveOptions as bl, type ArrayAttributeMeta as bm, type AttributeForLookup as bn, type AttributeMeta as bo, BUILT_IN_CONTROLS as bp, type BuiltInControlSlug as bq, type ColumnElement as br, type CommonProps as bs, type ComponentElement as bt, type ControlBucket as bu, type DatetimeAttributeMeta as bv, type DatetimeFormat as bw, type DividerElement as bx, type EnumAttributeMeta as by, type EnumValue as bz, ProteosClient as c, lookupCompatibleControls as c0, lookupControls as c1, lookupPrimaryControl as c2, parseUserMeta as c3, type PublicAccessOperation as d, type App as e, AppSchema as f, type AppService as g, AttributeSchema as h, type AttributeType as i, AuditFieldsSchema as j, type Column as k, ColumnSchema as l, type ComparisonOperator as m, type Component as n, ComponentSchema as o, type ComponentService as p, type CreateAppRequest as q, type CreateComponentRequest as r, type CreateDesignReferenceRequest as s, type CreateEntityRequest as t, type CreateListRequest as u, type CreateListViewRequest as v, type CreateMenuConfigurationRequest as w, type CreatePageRequest as x, type CreateVariableRequest as y, type CurrencyAttributeMeta as z };
+export { type FilterGroup as $, type AuditFields as A, CurrencyAttributeMetaSchema as B, type ClientOptions as C, type CurrencySymbolSide as D, type CurrencyValue as E, type FileRef as F, DEFAULT_OPTIONS as G, DEFAULT_PAGE_SIZE as H, DONE as I, type DeployModuleRequest as J, type DesignReference as K, type ListOptions as L, type DesignReferenceContent as M, DesignReferenceSchema as N, type DesignReferenceService as O, PageIterator as P, type Done as Q, type Entity as R, EntitySchema as S, type EntityService as T, type UserRef as U, type EntityWithSchema as V, EntityWithSchemaSchema as W, type FileAttributeMeta as X, FileRefSchema as Y, type FilterElement as Z, FilterElementSchema as _, type Attribute as a, type UpdatePageRequest as a$, FilterGroupSchema as a0, type List as a1, type ListAppsOptions as a2, type ListComponentsOptions as a3, type ListDesignReferencesOptions as a4, type ListEntitiesOptions as a5, type ListFn as a6, type ListListViewsOptions as a7, type ListListsOptions as a8, type ListMenuConfigurationsOptions as a9, type PageAction as aA, PageActionSchema as aB, type PageLayout as aC, PageLayoutSchema as aD, PageSchema as aE, type PageService as aF, type PageType as aG, type PublicPageComponent as aH, type PublicPageResponse as aI, type RelationAttributeMeta as aJ, RelationAttributeMetaSchema as aK, type RequestOptions as aL, type ResolvedClientOptions as aM, type ResponseMeta as aN, ResponseMetaSchema as aO, type SortConfig as aP, SortConfigSchema as aQ, type SortDirection as aR, type Timestamps as aS, type TokenProvider as aT, type UpdateAppRequest as aU, type UpdateComponentRequest as aV, type UpdateDesignReferenceRequest as aW, type UpdateEntityRequest as aX, type UpdateListRequest as aY, type UpdateListViewRequest as aZ, type UpdateMenuConfigurationRequest as a_, type ListModulesOptions as aa, type ListPagesOptions as ab, ListSchema as ac, type ListService as ad, type ListVariablesOptions as ae, type ListView as af, ListViewSchema as ag, type ListViewService as ah, type LogicalOperator as ai, type MenuConfiguration as aj, MenuConfigurationSchema as ak, type MenuConfigurationService as al, type MenuItem as am, MenuItemSchema as an, MenuItemType as ao, MetaClient as ap, type MetaListOptions as aq, type Module as ar, ModuleSchema as as, type ModuleService as at, type ModuleStatus as au, type OnDeleteAction as av, OnDeleteActionSchema as aw, PLATFORM_ATTRIBUTE_NAMES as ax, PLATFORM_USER_ID as ay, type Page as az, type ListResult as b, type TextElement as b$, type UpdateVariableRequest as b0, UserRefSchema as b1, type UserType as b2, type Variable as b3, VariableSchema as b4, type VariableService as b5, allCurrencyCodes as b6, createIterator as b7, createListResultSchema as b8, currencyLabel as b9, type FieldElement as bA, FileAttributeMetaSchema as bB, type LayoutAlign as bC, type LayoutElement as bD, LayoutElementSchema as bE, LayoutElementType as bF, type LayoutGap as bG, type LayoutJustify as bH, type LayoutTab as bI, type NumberAttributeMeta as bJ, type ObjectAttributeMeta as bK, PAGE_BACKGROUND_TOKENS as bL, type PageBackgroundToken as bM, type PageLayoutSidePanel as bN, PageLayoutSidePanelSchema as bO, type PageStyle as bP, PageStyleSchema as bQ, type RelatedListElement as bR, type ResponsiveSizing as bS, type RowElement as bT, type SectionElement as bU, type SizeValue as bV, SizeValueSchema as bW, type SizingProps as bX, type StringAttributeMeta as bY, type StringFormat as bZ, type TabsElement as b_, currencySymbol as ba, currencySymbolSide as bb, formatAmount as bc, formatMoney as bd, isPlatformAttributeName as be, localeNumberSeparators as bf, parseAmount as bg, parseCurrencyMeta as bh, parseFileMeta as bi, parseRelationMeta as bj, platformAttributes as bk, resolveOptions as bl, type ArrayAttributeMeta as bm, type AttributeForLookup as bn, type AttributeMeta as bo, BUILT_IN_CONTROLS as bp, type BuiltInControlSlug as bq, type ColumnElement as br, type CommonProps as bs, type ComponentElement as bt, type ControlBucket as bu, type DatetimeAttributeMeta as bv, type DatetimeFormat as bw, type DividerElement as bx, type EnumAttributeMeta as by, type EnumValue as bz, ProteosClient as c, type TextVariant as c0, type UserAttributeMeta as c1, UserAttributeMetaSchema as c2, isBuiltInControl as c3, lookupCompatibleControls as c4, lookupControls as c5, lookupPrimaryControl as c6, parseUserMeta as c7, type PublicAccessOperation as d, type App as e, AppSchema as f, type AppService as g, AttributeSchema as h, type AttributeType as i, AuditFieldsSchema as j, type Column as k, ColumnSchema as l, type ComparisonOperator as m, type Component as n, ComponentSchema as o, type ComponentService as p, type CreateAppRequest as q, type CreateComponentRequest as r, type CreateDesignReferenceRequest as s, type CreateEntityRequest as t, type CreateListRequest as u, type CreateListViewRequest as v, type CreateMenuConfigurationRequest as w, type CreatePageRequest as x, type CreateVariableRequest as y, type CurrencyAttributeMeta as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteos/sdk",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "license": "Apache-2.0",
   "description": "TypeScript SDK for the Proteos platform",
   "repository": {

package/src/meta/layout/index.ts

@@ -33,9 +33,13 @@ export {
   type TextVariant,
 } from './elements.js'
 export {
+  PAGE_BACKGROUND_TOKENS,
+  type PageBackgroundToken,
   type PageLayout,
   PageLayoutSchema,
   type PageLayoutSidePanel,
   PageLayoutSidePanelSchema,
+  type PageStyle,
+  PageStyleSchema,
 } from './page-layout.js'
 export { type SizeValue, SizeValueSchema } from './size-value.js'

package/src/meta/layout/page-layout.ts

@@ -18,6 +18,58 @@ export const PageLayoutSidePanelSchema = z.object({
   content: LayoutElementSchema,
 })
 
+/**
+ * Design-token keys a page background may name instead of a raw CSS color. The
+ * web resolver maps each to `var(--color-<key>)`. Keep in sync with
+ * `pageBackgroundTokens` in the metadata-service layout validator.
+ */
+export const PAGE_BACKGROUND_TOKENS = [
+  'bg',
+  'bg-2',
+  'bg-3',
+  'ink',
+  'ink-2',
+  'ink-3',
+  'ink-4',
+  'rule',
+  'rule-2',
+  'accent',
+  'accent-2',
+  'accent-ink',
+  'success',
+  'warning',
+  'danger',
+  'info',
+] as const
+
+export type PageBackgroundToken = (typeof PAGE_BACKGROUND_TOKENS)[number]
+
+/**
+ * Per-page presentation of a standalone page shell: background color plus the
+ * content container's max-width and side / top padding. Every field is
+ * optional; an omitted field falls back to the renderer default (the historical
+ * bg / 1200px / 24px-32px look). `max_width: "fill"` (or `"auto"`) with zero
+ * padding lets a component fill the page edge-to-edge.
+ *
+ * Honored only on `public` and `kiosk` pages in v1 (enforced server-side).
+ */
+export interface PageStyle {
+  /** Design-token key (see PAGE_BACKGROUND_TOKENS) or a raw CSS color. */
+  background?: string
+  /** Content max-width; `"fill"` / `"auto"` removes the cap. */
+  max_width?: SizeValue
+  /** Horizontal / vertical padding of the content container (Tailwind px/py). */
+  padding_x?: SizeValue
+  padding_y?: SizeValue
+}
+
+export const PageStyleSchema = z.object({
+  background: z.string().optional(),
+  max_width: SizeValueSchema.optional(),
+  padding_x: SizeValueSchema.optional(),
+  padding_y: SizeValueSchema.optional(),
+})
+
 /**
  * Top-level page layout. Replaces the legacy `mainContent` / `side_panel`
  * arrays of `PageSection`s with a single typed element tree.
@@ -26,10 +78,12 @@ export interface PageLayout {
   version: 1
   main: LayoutElement
   side_panel?: PageLayoutSidePanel
+  style?: PageStyle
 }
 
 export const PageLayoutSchema = z.object({
   version: z.literal(1),
   main: LayoutElementSchema,
   side_panel: PageLayoutSidePanelSchema.optional(),
+  style: PageStyleSchema.optional(),
 })