@spotto/contract 1.0.70-alpha.6 → 1.0.70-alpha.8

package/dist/ai/expression/response.d.ts

@@ -3,8 +3,19 @@ export interface PostAiExpressionResponse {
     ok: boolean;
     /** The generated excelexp expression, or null when declined / unbuildable. */
     expression: string | null;
-    /** Author-facing note: why it declined, or what is ambiguous. */
+    /**
+     * readinessRule: the display text shown when the rule fires — house-style, with
+     * `{FieldName}` placeholders. null for computedField, and null on a decline.
+     */
     message: string | null;
+    /**
+     * readinessRule severity, set ONLY from explicit severity words in the prompt:
+     * 1 = amber, 2 = red. null when the prompt stated no severity (the author picks)
+     * or for computedField.
+     */
+    level: 1 | 2 | null;
+    /** Author-facing explanation/caveat: why it declined, or a one-line caveat. */
+    note: string | null;
     /** Server-side compiler findings (empty when the expression compiles cleanly). */
     warnings: string[];
     /** The model that answered. */

package/dist/users/current.d.ts

@@ -2,6 +2,7 @@ import { IEntityMeta, IEmbeddedEntity } from '../shared';
 import { Preferences } from '../organisations/constants';
 import { Integrations } from '../integrations/constants';
 import { System } from '../system';
+import { HomeLayout } from './home-layout';
 export interface EmbeddedRole extends IEmbeddedEntity {
     permissions: string[];
 }
@@ -28,6 +29,12 @@ export interface CurrentUserResponse {
      * - `undefined` — legacy native user (non-SSO org, or pre-SSO).
      */
     authProvider?: 'sso' | 'native';
+    /**
+     * Personal Home-screen layout (widget arrangement). Persisted on the user doc
+     * and written via `POST /users/current/home-layout`. `undefined` until the
+     * user customises — the client then renders its built-in default layout.
+     */
+    homeLayout?: HomeLayout;
 }
 export interface CurrentUserPublicResponse {
     id: string;

package/dist/users/home-layout/index.d.ts

@@ -0,0 +1,3 @@
+export * from './shared';
+export * from './request';
+export * from './response';

package/dist/users/home-layout/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./shared"), exports);
+__exportStar(require("./request"), exports);
+__exportStar(require("./response"), exports);
+//# sourceMappingURL=index.js.map

package/dist/users/home-layout/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/users/home-layout/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,4CAAyB;AACzB,6CAA0B"}

package/dist/users/home-layout/request.d.ts

@@ -0,0 +1,5 @@
+import { HomeLayout } from './shared';
+/** Body for `POST /users/current/home-layout` — replaces the caller's home layout. */
+export interface UpdateHomeLayoutRequest {
+    homeLayout: HomeLayout;
+}

package/dist/users/home-layout/request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=request.js.map

package/dist/users/home-layout/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/users/home-layout/request.ts"],"names":[],"mappings":""}

package/dist/users/home-layout/response.d.ts

@@ -0,0 +1,5 @@
+import { HomeLayout } from './shared';
+/** Response for `POST /users/current/home-layout` — echoes the saved layout. */
+export interface UpdateHomeLayoutResponse {
+    homeLayout: HomeLayout;
+}

package/dist/users/home-layout/response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=response.js.map

package/dist/users/home-layout/response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../src/users/home-layout/response.ts"],"names":[],"mappings":""}

package/dist/users/home-layout/shared.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Per-user Home screen layout — a personal, server-persisted arrangement of
+ * Home widgets. Stored directly on the user document (like `homeLocationId`),
+ * returned on `GET /users/current`, and written via
+ * `POST /users/current/home-layout`.
+ *
+ * The widget `type` is a closed union (below): adding a new widget kind is a
+ * contract change + republish + client bump. Per-widget `config` is left opaque
+ * — its shape is the client's concern, so a widget's behaviour can evolve
+ * without a contract change. Sections are modelled now (single + untitled in
+ * P1) so titled groups can land later without another contract change.
+ */
+/** Width a widget occupies in its section grid. `'full'` spans the row at every breakpoint. */
+export declare type HomeWidgetSpan = 1 | 2 | 'full';
+/**
+ * The kinds of Home widget. Closed set — adding one is a contract change.
+ * - `tile-link` — a link card (a saved view, a nav destination, or a URL); may show a live count.
+ * - `summary-list` — top-N rows of a saved view's results.
+ * - `recent-activity` — the account's latest activity feed.
+ * - `recent-assets` / `recent-locations` — most-recently-updated entities.
+ * - `needs-attention` — assets flagged not-ready / partially-ready.
+ * - `kit-spotlight` — kit readiness summary.
+ */
+export declare type HomeWidgetType = 'tile-link' | 'summary-list' | 'recent-activity' | 'recent-assets' | 'recent-locations' | 'needs-attention' | 'kit-spotlight';
+export interface HomeWidget {
+    /** Stable client-generated id (ulid) — the reorder / remove key. */
+    id: string;
+    /** Widget kind (closed union). The client registry maps it to a renderer + config shape. */
+    type: HomeWidgetType;
+    /** Width preset; falls back to the widget's registry default when omitted. */
+    span?: HomeWidgetSpan;
+    /** Widget-specific configuration (e.g. a saved-view id, a title, a row limit). Opaque to the API. */
+    config?: Record<string, unknown>;
+}
+export interface HomeLayoutSection {
+    /** Stable client-generated id (ulid). */
+    id: string;
+    /** Optional section heading. Sections are single + untitled in P1; titled groups arrive in P2. */
+    title?: string;
+    widgets: HomeWidget[];
+}
+export interface HomeLayout {
+    /** Layout schema version, for forward-migrating stored layouts. */
+    version: number;
+    sections: HomeLayoutSection[];
+}

package/dist/users/home-layout/shared.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * Per-user Home screen layout — a personal, server-persisted arrangement of
+ * Home widgets. Stored directly on the user document (like `homeLocationId`),
+ * returned on `GET /users/current`, and written via
+ * `POST /users/current/home-layout`.
+ *
+ * The widget `type` is a closed union (below): adding a new widget kind is a
+ * contract change + republish + client bump. Per-widget `config` is left opaque
+ * — its shape is the client's concern, so a widget's behaviour can evolve
+ * without a contract change. Sections are modelled now (single + untitled in
+ * P1) so titled groups can land later without another contract change.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.js.map

package/dist/users/home-layout/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../../src/users/home-layout/shared.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}

package/dist/users/index.d.ts

@@ -1,5 +1,6 @@
 export * from './constants';
 export * from './current';
+export * from './home-layout';
 export * from './post';
 export * from './get';
 export * from './[id]';

package/dist/users/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants"), exports);
 __exportStar(require("./current"), exports);
+__exportStar(require("./home-layout"), exports);
 __exportStar(require("./post"), exports);
 __exportStar(require("./get"), exports);
 __exportStar(require("./[id]"), exports);

package/dist/users/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/users/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,4CAAyB;AACzB,yCAAsB;AACtB,wCAAqB;AACrB,yCAAsB;AACtB,4CAAyB;AACzB,mDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/users/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,4CAAyB;AACzB,gDAA6B;AAC7B,yCAAsB;AACtB,wCAAqB;AACrB,yCAAsB;AACtB,4CAAyB;AACzB,mDAAgC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotto/contract",
   "license": "ISC",
-  "version": "1.0.70-alpha.6",
+  "version": "1.0.70-alpha.8",
   "description": "Spotto's API Contract type definitions",
   "main": "./dist/index.js",
   "files": [
@@ -18,5 +18,5 @@
     "@types/geojson": "^7946.0.11",
     "shx": "^0.3.4"
   },
-  "gitHead": "e32007c14ef62c49c1230f49be30f97fa033d7db"
+  "gitHead": "94cde3fcfef3aaae93339641b208aca87965104c"
 }