@proteos/sdk 0.21.0 → 0.22.1

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

@@ -675,6 +675,36 @@ interface ComponentService {
     bundleUrl(slug: string): string;
 }
 
+/**
+ * Service for managing an org's stored DESIGN.md documents (design references).
+ *
+ * The markdown body is split from the metadata methods: list/get never carry
+ * `content` — read it with {@link getContent} and write it with
+ * {@link setContent} (create may seed it in one shot).
+ */
+interface DesignReferenceService {
+    /** Lists design references (metadata only — no `content`). */
+    list(options?: ListDesignReferencesOptions): PageIterator<DesignReference, ListDesignReferencesOptions>;
+    /** Fetches a single page of design references (metadata only). */
+    listPage(options?: ListDesignReferencesOptions): Promise<ListResult<DesignReference>>;
+    /** Gets a single design reference by id (metadata only — no `content`). */
+    get(id: string): Promise<DesignReference>;
+    /** Resolves a design reference by its per-org slug (metadata only). */
+    getBySlug(slug: string): Promise<DesignReference>;
+    /** Creates a design reference; `content` optionally seeds the body. */
+    create(request: CreateDesignReferenceRequest): Promise<DesignReference>;
+    /** Creates or (by slug) replaces a design reference, including its body. */
+    upsert(request: CreateDesignReferenceRequest): Promise<DesignReference>;
+    /** Updates a design reference's metadata (name/description/slug). */
+    update(id: string, request: UpdateDesignReferenceRequest): Promise<DesignReference>;
+    /** Deletes a design reference. */
+    delete(id: string): Promise<void>;
+    /** Reads the markdown body for a design reference. */
+    getContent(id: string): Promise<string>;
+    /** Overwrites the markdown body for a design reference (metadata untouched). */
+    setContent(id: string, content: string): Promise<void>;
+}
+
 /**
  * Service for managing entity definitions.
  * Entities define the structure of business objects in the system.
@@ -740,6 +770,12 @@ interface EntityService {
      * @throws {ProteosError} If entity not found (404)
      */
     getWithSchema(slug: string): Promise<EntityWithSchema>;
+    /**
+     * Gets a public-access (read) entity (with schema) through the UNAUTHENTICATED
+     * public endpoint — no Authorization header. A non-public or missing
+     * entity 404s identically.
+     */
+    getPublic(orgId: string, slug: string): Promise<EntityWithSchema>;
     /**
      * Creates a new entity.
      *
@@ -1487,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.
@@ -1495,6 +1572,7 @@ interface PageLayout {
     version: 1;
     main: LayoutElement;
     side_panel?: PageLayoutSidePanel;
+    style?: PageStyle;
 }
 declare const PageLayoutSchema: z.ZodObject<{
     version: z.ZodLiteral<1>;
@@ -1512,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;
@@ -1520,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;
@@ -1528,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;
 }>;
 
 /**
@@ -1587,6 +1693,10 @@ declare class MetaClient {
      * Service for managing apps.
      */
     readonly apps: AppService;
+    /**
+     * Service for managing design references (stored DESIGN.md documents).
+     */
+    readonly designReferences: DesignReferenceService;
     /**
      * Creates a new MetaClient instance.
      *
@@ -1879,6 +1989,12 @@ declare function parseUserMeta(attr: Attribute): UserAttributeMeta | null;
  * with no meta still resolves to an empty `{}` rather than null.
  */
 declare function parseFileMeta(attr: Attribute): FileAttributeMeta | null;
+/**
+ * A single operation a resource may be publicly exposed for. Independent set
+ * (not a level): a resource can be public for `write` without `read`. Only
+ * `read` is honored on the platform today; `write`/`delete` are reserved.
+ */
+type PublicAccessOperation = 'read' | 'write' | 'delete';
 /**
  * Entity definition.
  * Note: Entity uses `slug` as its primary identifier, not `id`.
@@ -1888,6 +2004,14 @@ interface Entity extends AuditFields {
     name: string;
     description: string;
     is_remote: boolean;
+    /**
+     * Operations ALL records of the entity are exposed for on the
+     * unauthenticated public surface. Only `["read"]` is honored today (records
+     * become world-readable; the entity definition is implicitly readable so
+     * they can be interpreted); `write`/`delete` are reserved. Empty = private
+     * (default).
+     */
+    public_record_access: PublicAccessOperation[];
     module_slug: string;
     /**
      * Liquid template that renders a human-readable title for an instance
@@ -1929,6 +2053,7 @@ declare const EntitySchema: z.ZodObject<{
     name: z.ZodString;
     description: z.ZodString;
     is_remote: z.ZodBoolean;
+    public_record_access: z.ZodDefault<z.ZodArray<z.ZodEnum<["read", "write", "delete"]>, "many">>;
     module_slug: z.ZodString;
     title_template: z.ZodDefault<z.ZodString>;
     attributes: z.ZodArray<z.ZodObject<{
@@ -1996,6 +2121,7 @@ declare const EntitySchema: z.ZodObject<{
     }[];
     slug: string;
     is_remote: boolean;
+    public_record_access: ("read" | "write" | "delete")[];
     module_slug: string;
     title_template: string;
 }, {
@@ -2027,6 +2153,7 @@ declare const EntitySchema: z.ZodObject<{
     slug: string;
     is_remote: boolean;
     module_slug: string;
+    public_record_access?: ("read" | "write" | "delete")[] | undefined;
     title_template?: string | undefined;
 }>;
 /**
@@ -2063,6 +2190,7 @@ declare const EntityWithSchemaSchema: z.ZodObject<{
     name: z.ZodString;
     description: z.ZodString;
     is_remote: z.ZodBoolean;
+    public_record_access: z.ZodDefault<z.ZodArray<z.ZodEnum<["read", "write", "delete"]>, "many">>;
     module_slug: z.ZodString;
     title_template: z.ZodDefault<z.ZodString>;
     attributes: z.ZodArray<z.ZodObject<{
@@ -2132,6 +2260,7 @@ declare const EntityWithSchemaSchema: z.ZodObject<{
     }[];
     slug: string;
     is_remote: boolean;
+    public_record_access: ("read" | "write" | "delete")[];
     module_slug: string;
     title_template: string;
     schema: Record<string, unknown>;
@@ -2165,6 +2294,7 @@ declare const EntityWithSchemaSchema: z.ZodObject<{
     is_remote: boolean;
     module_slug: string;
     schema: Record<string, unknown>;
+    public_record_access?: ("read" | "write" | "delete")[] | undefined;
     title_template?: string | undefined;
 }>;
 /**
@@ -2183,6 +2313,12 @@ interface CreateEntityRequest {
     slug: string;
     name: string;
     is_remote: boolean;
+    /**
+     * Operations to expose all records of the entity for, unauthenticated (only
+     * `["read"]` accepted today). Full-replacement on upsert: an upsert without
+     * the field resets it to private.
+     */
+    public_record_access?: PublicAccessOperation[];
     module_slug: string;
     description: string;
     title_template?: string;
@@ -2194,6 +2330,7 @@ interface CreateEntityRequest {
 interface UpdateEntityRequest {
     name?: string;
     is_remote?: boolean;
+    public_record_access?: PublicAccessOperation[];
     module_slug?: string;
     description?: string;
     title_template?: string;
@@ -2984,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;
@@ -2992,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;
@@ -3000,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";
@@ -3029,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;
 }, {
@@ -3059,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;
 }>;
@@ -3350,5 +3527,117 @@ interface UpdateAppRequest {
     description?: string;
     icon_slug?: string;
 }
+/**
+ * A stored DESIGN.md document — a named design reference an org authors and that
+ * design agents read as the source of truth for a surface. `name` + `description`
+ * are the selector ("which reference, and when to use it").
+ *
+ * `content` (the markdown body) is NOT returned by list/get — fetch it via
+ * {@link DesignReferenceService.getContent} and write it via `setContent`.
+ */
+interface DesignReference extends AuditFields {
+    id: string;
+    org_id: string;
+    slug: string;
+    name: string;
+    description: string;
+    /** The DESIGN.md body. Only present on the dedicated content endpoint; undefined on list/get. */
+    content?: string;
+}
+declare const DesignReferenceSchema: z.ZodObject<{
+    created_at: z.ZodString;
+    updated_at: z.ZodString;
+    created_by: z.ZodObject<{
+        type: z.ZodEnum<["person", "agent", "api"]>;
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "person" | "agent" | "api";
+        id: string;
+    }, {
+        type: "person" | "agent" | "api";
+        id: string;
+    }>;
+    updated_by: z.ZodObject<{
+        type: z.ZodEnum<["person", "agent", "api"]>;
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "person" | "agent" | "api";
+        id: string;
+    }, {
+        type: "person" | "agent" | "api";
+        id: string;
+    }>;
+} & {
+    id: z.ZodString;
+    slug: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    content: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    created_at: string;
+    updated_at: string;
+    created_by: {
+        type: "person" | "agent" | "api";
+        id: string;
+    };
+    updated_by: {
+        type: "person" | "agent" | "api";
+        id: string;
+    };
+    description: string;
+    slug: string;
+    content?: string | undefined;
+}, {
+    id: string;
+    name: string;
+    created_at: string;
+    updated_at: string;
+    created_by: {
+        type: "person" | "agent" | "api";
+        id: string;
+    };
+    updated_by: {
+        type: "person" | "agent" | "api";
+        id: string;
+    };
+    description: string;
+    slug: string;
+    content?: string | undefined;
+}>;
+/**
+ * Options for listing design references.
+ */
+interface ListDesignReferencesOptions extends MetaListOptions {
+    id?: string;
+    slug?: string;
+    name?: string;
+    description?: string;
+}
+/**
+ * Request to create a design reference. `content` optionally seeds the body.
+ */
+interface CreateDesignReferenceRequest {
+    slug: string;
+    name: string;
+    description?: string;
+    content?: string;
+}
+/**
+ * Request to update a design reference's metadata. Content is edited via the
+ * dedicated content endpoint, not here.
+ */
+interface UpdateDesignReferenceRequest {
+    slug?: string;
+    name?: string;
+    description?: string;
+}
+/**
+ * The markdown body, from GET/PUT /design-references/:id/content.
+ */
+interface DesignReferenceContent {
+    content: string;
+}
 
-export { type ListFn as $, type AuditFields as A, type CurrencyValue as B, type ClientOptions as C, DEFAULT_OPTIONS as D, DEFAULT_PAGE_SIZE as E, type FileRef as F, DONE as G, type DeployModuleRequest as H, type Done as I, type Entity as J, EntitySchema as K, type ListOptions as L, type EntityService as M, type EntityWithSchema as N, EntityWithSchemaSchema as O, PageIterator as P, type FileAttributeMeta as Q, FileRefSchema as R, type FilterElement as S, FilterElementSchema as T, type UserRef as U, type FilterGroup as V, FilterGroupSchema as W, type List as X, type ListAppsOptions as Y, type ListComponentsOptions as Z, type ListEntitiesOptions as _, type Attribute as a, createIterator as a$, type ListListViewsOptions as a0, type ListListsOptions as a1, type ListMenuConfigurationsOptions as a2, type ListModulesOptions as a3, type ListPagesOptions as a4, ListSchema as a5, type ListService as a6, type ListVariablesOptions as a7, type ListView as a8, ListViewSchema as a9, type PublicPageComponent as aA, type PublicPageResponse as aB, type RelationAttributeMeta as aC, RelationAttributeMetaSchema as aD, type RequestOptions as aE, type ResolvedClientOptions as aF, type ResponseMeta as aG, ResponseMetaSchema as aH, type SortConfig as aI, SortConfigSchema as aJ, type SortDirection as aK, type Timestamps as aL, type TokenProvider as aM, type UpdateAppRequest as aN, type UpdateComponentRequest as aO, type UpdateEntityRequest as aP, type UpdateListRequest as aQ, type UpdateListViewRequest as aR, type UpdateMenuConfigurationRequest as aS, type UpdatePageRequest as aT, type UpdateVariableRequest as aU, UserRefSchema as aV, type UserType as aW, type Variable as aX, VariableSchema as aY, type VariableService as aZ, allCurrencyCodes as a_, type ListViewService as aa, type LogicalOperator as ab, type MenuConfiguration as ac, MenuConfigurationSchema as ad, type MenuConfigurationService as ae, type MenuItem as af, MenuItemSchema as ag, MenuItemType as ah, MetaClient as ai, type MetaListOptions as aj, type Module as ak, ModuleSchema as al, type ModuleService as am, type ModuleStatus as an, type OnDeleteAction as ao, OnDeleteActionSchema as ap, PLATFORM_ATTRIBUTE_NAMES as aq, PLATFORM_USER_ID as ar, type Page as as, type PageAction as at, PageActionSchema as au, type PageLayout as av, PageLayoutSchema as aw, PageSchema as ax, type PageService as ay, type PageType as az, type ListResult as b, createListResultSchema as b0, currencyLabel as b1, currencySymbol as b2, currencySymbolSide as b3, formatAmount as b4, formatMoney as b5, isPlatformAttributeName as b6, localeNumberSeparators as b7, parseAmount as b8, parseCurrencyMeta as b9, type LayoutTab as bA, type NumberAttributeMeta as bB, type ObjectAttributeMeta as bC, type PageLayoutSidePanel as bD, PageLayoutSidePanelSchema as bE, type RelatedListElement as bF, type ResponsiveSizing as bG, type RowElement as bH, type SectionElement as bI, type SizeValue as bJ, SizeValueSchema as bK, type SizingProps as bL, type StringAttributeMeta as bM, type StringFormat as bN, type TabsElement as bO, type TextElement as bP, type TextVariant as bQ, type UserAttributeMeta as bR, UserAttributeMetaSchema as bS, isBuiltInControl as bT, lookupCompatibleControls as bU, lookupControls as bV, lookupPrimaryControl as bW, parseUserMeta as bX, parseFileMeta as ba, parseRelationMeta as bb, platformAttributes as bc, resolveOptions as bd, type ArrayAttributeMeta as be, type AttributeForLookup as bf, type AttributeMeta as bg, BUILT_IN_CONTROLS as bh, type BuiltInControlSlug as bi, type ColumnElement as bj, type CommonProps as bk, type ComponentElement as bl, type ControlBucket as bm, type DatetimeAttributeMeta as bn, type DatetimeFormat as bo, type DividerElement as bp, type EnumAttributeMeta as bq, type EnumValue as br, type FieldElement as bs, FileAttributeMetaSchema as bt, type LayoutAlign as bu, type LayoutElement as bv, LayoutElementSchema as bw, LayoutElementType as bx, type LayoutGap as by, type LayoutJustify as bz, ProteosClient as c, type App as d, AppSchema as e, type AppService as f, AttributeSchema as g, type AttributeType as h, AuditFieldsSchema as i, type Column as j, ColumnSchema as k, type ComparisonOperator as l, type Component as m, ComponentSchema as n, type ComponentService as o, type CreateAppRequest as p, type CreateComponentRequest as q, type CreateEntityRequest as r, type CreateListRequest as s, type CreateListViewRequest as t, type CreateMenuConfigurationRequest as u, type CreatePageRequest as v, type CreateVariableRequest as w, type CurrencyAttributeMeta as x, CurrencyAttributeMetaSchema as y, type CurrencySymbolSide 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.21.0",
+  "version": "0.22.1",
   "license": "Apache-2.0",
   "description": "TypeScript SDK for the Proteos platform",
   "repository": {

package/src/auth/platform-entities.ts

@@ -30,6 +30,7 @@ export const PLATFORM_ENTITIES: readonly PlatformEntity[] = [
   { slug: 'components', name: 'Components' },
   { slug: 'lists', name: 'Lists' },
   { slug: 'list-views', name: 'List Views' },
+  { slug: 'design-references', name: 'Design References' },
   // System (metadata-service)
   { slug: 'modules', name: 'Modules' },
   { slug: 'variables', name: 'Variables' },
@@ -39,6 +40,9 @@ export const PLATFORM_ENTITIES: readonly PlatformEntity[] = [
   // Automation (function-service)
   { slug: 'hooks', name: 'Hooks' },
   { slug: 'actions', name: 'Actions' },
+  // Workflows (workflow-service)
+  { slug: 'workflows', name: 'Workflows' },
+  { slug: 'workflow-executions', name: 'Workflow Executions' },
   // Knowledge (knowledge-service)
   { slug: 'knowledge-nodes', name: 'Knowledge Nodes' },
   { slug: 'knowledge-links', name: 'Knowledge Links' },

package/src/data/records.ts

@@ -10,6 +10,7 @@ import type {
 
 const RECORDS_BASE_PATH = '/data/v1/records'
 const BATCH_RECORDS_BASE_PATH = '/data/v1/batch/records'
+const PUBLIC_RECORDS_BASE_PATH = '/data/v1/public/orgs'
 
 /**
  * Service for managing records (per-entity data rows) via the data-service.
@@ -63,6 +64,34 @@ export interface RecordService {
     entitySlug: string,
     transactions: BatchUpsertTransaction[],
   ): Promise<BatchUpsertRecordsResponse>
+
+  /**
+   * Lists records of a public-read entity through the UNAUTHENTICATED
+   * public endpoint (no Authorization header) as an async iterator. A
+   * non-public or missing entity 404s identically.
+   */
+  listPublic(
+    orgId: string,
+    entitySlug: string,
+    options?: ListRecordsOptions,
+  ): PageIterator<RecordData, ListRecordsOptions>
+
+  /**
+   * Fetches a single page of records through the unauthenticated public
+   * endpoint. Same filter grammar and pagination as `listPage`.
+   */
+  listPublicPage(
+    orgId: string,
+    entitySlug: string,
+    options?: ListRecordsOptions,
+  ): Promise<ListResult<RecordData>>
+
+  /**
+   * Gets a single record of a public-read entity through the
+   * unauthenticated public endpoint. Knowledge-text values stay unenriched
+   * (bare refs) on this path.
+   */
+  getPublic(orgId: string, entitySlug: string, id: string): Promise<RecordData>
 }
 
 /**
@@ -119,4 +148,35 @@ export class RecordServiceImpl implements RecordService {
       transactions,
     )
   }
+
+  listPublic(
+    orgId: string,
+    entitySlug: string,
+    options: ListRecordsOptions = {},
+  ): PageIterator<RecordData, ListRecordsOptions> {
+    return new PageIterator((opts) => this.listPublicPage(orgId, entitySlug, opts), options)
+  }
+
+  async listPublicPage(
+    orgId: string,
+    entitySlug: string,
+    options: ListRecordsOptions = {},
+  ): Promise<ListResult<RecordData>> {
+    return this.client.requestWithQuery<ListResult<RecordData>>(
+      'GET',
+      `${PUBLIC_RECORDS_BASE_PATH}/${encodeURIComponent(orgId)}/records/${encodeURIComponent(entitySlug)}`,
+      options,
+      undefined,
+      { skipAuth: true },
+    )
+  }
+
+  async getPublic(orgId: string, entitySlug: string, id: string): Promise<RecordData> {
+    return this.client.request<RecordData>(
+      'GET',
+      `${PUBLIC_RECORDS_BASE_PATH}/${encodeURIComponent(orgId)}/records/${encodeURIComponent(entitySlug)}/${encodeURIComponent(id)}`,
+      undefined,
+      { skipAuth: true },
+    )
+  }
 }