@proteos/sdk 0.46.0 → 0.47.0

package/src/meta/types.ts

@@ -864,6 +864,19 @@ export interface UpdateComponentRequest {
 
 /**
  * List column definition.
+ *
+ * `attribute` is an attribute name or a dot path, told apart by the type of
+ * the first segment:
+ *
+ *   - `name` — an attribute on the list's own entity.
+ *   - `address.city` — a leaf inside one of its `object` attributes.
+ *   - `company_id.name` — a field of the RELATED record, reached through a
+ *     relation attribute (the first segment is the FK).
+ *
+ * A bare `object` attribute is not a valid column — it carries no value of
+ * its own, only leaves. Sorting follows the same grammar minus the relation
+ * hop: an attribute or an object path can be ordered by, a related field
+ * cannot (it would need a join).
  */
 export interface Column {
   attribute: string
@@ -877,7 +890,9 @@ export interface Column {
 export type SortDirection = 'asc' | 'desc'
 
 /**
- * Sort configuration.
+ * Sort configuration. `attribute` is an attribute name or an object path
+ * (`address.city`); relation paths are not sortable — ordering by a related
+ * field would need a join the records query doesn't do.
  */
 export interface SortConfig {
   attribute: string
@@ -904,6 +919,60 @@ export {
   type LogicalOperator,
 }
 
+// ============================================================================
+// Toolbar action buttons (shared by pages and lists)
+// ============================================================================
+
+/**
+ * What a page toolbar button invokes. Absent normalizes to `action` (pages
+ * persisted before `kind` existed).
+ */
+export type PageActionKind = 'action' | 'workflow'
+
+/**
+ * Page action definition — one toolbar button. `kind: action` invokes a
+ * function-service Action by slug (`action`) and may prefill its params;
+ * `kind: workflow` starts a manual run of a workflow by key (`workflow`) and
+ * may prefill its manual-trigger inputs. `params` / `inputs` map target field
+ * names to Liquid templates rendered against the page scope
+ * `{ record, entity, params, user }`; a resolved field is locked in the invoke
+ * dialog. `skip_confirmation` fires the target immediately when every required
+ * field resolved from the templates.
+ */
+export interface PageAction {
+  label: string
+  icon: string
+  kind?: PageActionKind
+  action?: string
+  workflow?: string
+  params?: Record<string, string>
+  inputs?: Record<string, string>
+  skip_confirmation?: boolean
+}
+
+export const PageActionSchema = z.object({
+  label: z.string(),
+  icon: z.string(),
+  kind: z.enum(['action', 'workflow']).optional(),
+  action: z.string().optional(),
+  workflow: z.string().optional(),
+  params: z.record(z.string()).optional(),
+  inputs: z.record(z.string()).optional(),
+  skip_confirmation: z.boolean().optional(),
+})
+
+/**
+ * Whether a list's rows can be checked, and whether the checkboxes show from
+ * the start:
+ *
+ * - `on_demand` (default) — a Select toggle in the toolbar reveals them.
+ * - `always` — checkboxes are showing from the start.
+ * - `off` — rows can never be checked, even when the list carries actions.
+ */
+export type SelectionMode = 'on_demand' | 'always' | 'off'
+
+export const SelectionModeSchema = z.enum(['on_demand', 'always', 'off'])
+
 /**
  * List configuration.
  * Note: List uses `slug` as its primary identifier, not `id`.
@@ -915,6 +984,15 @@ export interface List extends AuditFields {
   name: string
   entity_slug: string
   columns: Column[]
+  /**
+   * Toolbar buttons on the list, same shape a page carries. They act on the
+   * rows SELECTED in the list, so an `action` button names an `entity_batch`
+   * action (invoked once with every selected record id) and prefill templates
+   * resolve against the list scope `{ selection, entity, user }`.
+   */
+  actions?: PageAction[]
+  /** Row-selection affordance; absent normalizes to `on_demand`. */
+  selection_mode?: SelectionMode
   /** Record page to open from this list; empty/absent = org default for the entity. */
   default_page_slug?: string
   sorting: SortConfig[]
@@ -938,6 +1016,8 @@ export const ListSchema = AuditFieldsSchema.extend({
   name: z.string(),
   entity_slug: z.string(),
   columns: z.array(ColumnSchema),
+  actions: z.array(PageActionSchema).optional(),
+  selection_mode: SelectionModeSchema.optional(),
   default_page_slug: z.string().optional(),
   sorting: z.array(SortConfigSchema),
   filters: z.array(FilterGroupSchema),
@@ -962,6 +1042,8 @@ export interface CreateListRequest {
   entity_slug: string
   name: string
   columns: Column[]
+  actions?: PageAction[]
+  selection_mode?: SelectionMode
   default_page_slug?: string
   sorting: SortConfig[]
   filters: FilterGroup[]
@@ -974,6 +1056,8 @@ export interface UpdateListRequest {
   name?: string
   module_slug?: string
   columns?: Column[]
+  actions?: PageAction[]
+  selection_mode?: SelectionMode
   /** Set to '' to clear back to the org default. */
   default_page_slug?: string
   sorting?: SortConfig[]
@@ -1047,44 +1131,6 @@ export interface UpdateListViewRequest {
 // Page Types
 // ============================================================================
 
-/**
- * What a page toolbar button invokes. Absent normalizes to `action` (pages
- * persisted before `kind` existed).
- */
-export type PageActionKind = 'action' | 'workflow'
-
-/**
- * Page action definition — one toolbar button. `kind: action` invokes a
- * function-service Action by slug (`action`) and may prefill its params;
- * `kind: workflow` starts a manual run of a workflow by key (`workflow`) and
- * may prefill its manual-trigger inputs. `params` / `inputs` map target field
- * names to Liquid templates rendered against the page scope
- * `{ record, entity, params, user }`; a resolved field is locked in the invoke
- * dialog. `skip_confirmation` fires the target immediately when every required
- * field resolved from the templates.
- */
-export interface PageAction {
-  label: string
-  icon: string
-  kind?: PageActionKind
-  action?: string
-  workflow?: string
-  params?: Record<string, string>
-  inputs?: Record<string, string>
-  skip_confirmation?: boolean
-}
-
-export const PageActionSchema = z.object({
-  label: z.string(),
-  icon: z.string(),
-  kind: z.enum(['action', 'workflow']).optional(),
-  action: z.string().optional(),
-  workflow: z.string().optional(),
-  params: z.record(z.string()).optional(),
-  inputs: z.record(z.string()).optional(),
-  skip_confirmation: z.boolean().optional(),
-})
-
 /**
  * Page type — encodes what the page binds to and how it is served (chrome +
  * auth posture both follow from it):