@spotto/contract 1.0.70-alpha.1 → 1.0.70-alpha.11

package/dist/submissions/uploads/index.js

@@ -0,0 +1,19 @@
+"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("./post"), exports);
+__exportStar(require("./[fileId]"), exports);
+//# sourceMappingURL=index.js.map

package/dist/submissions/uploads/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/submissions/uploads/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,6CAA0B"}

package/dist/submissions/uploads/post/index.d.ts

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

package/dist/submissions/uploads/post/index.js

@@ -0,0 +1,19 @@
+"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("./request"), exports);
+__exportStar(require("./response"), exports);
+//# sourceMappingURL=index.js.map

package/dist/submissions/uploads/post/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/submissions/uploads/post/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,6CAA0B"}

package/dist/submissions/uploads/post/request.d.ts

@@ -0,0 +1,9 @@
+import { SubmissionMediaContentType } from '../../constants';
+/** One file to upload — the declared type is pinned into the POST policy. */
+export interface PostSubmissionUploadsRequestFile {
+    contentType: SubmissionMediaContentType;
+}
+/** POST /submissions/uploads — mint presigned upload POSTs (§4.3). */
+export interface PostSubmissionUploadsRequest {
+    files: PostSubmissionUploadsRequestFile[];
+}

package/dist/submissions/uploads/post/request.js

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

package/dist/submissions/uploads/post/request.js.map

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

package/dist/submissions/uploads/post/response.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A ready-to-send presigned POST: multipart-form the `fields` verbatim (file
+ * last) at `url`. The policy enforces the declared content-type and the size
+ * cap, so a disallowed file bounces at upload time.
+ */
+export interface ISubmissionUploadPost {
+    url: string;
+    fields: Record<string, string>;
+}
+export interface PostSubmissionUploadsResponseFile {
+    /** Server-minted ULID — becomes the attachment's fileId at submit. */
+    fileId: string;
+    post: ISubmissionUploadPost;
+}
+export interface PostSubmissionUploadsResponse {
+    /** Same order as the request's files. */
+    files: PostSubmissionUploadsResponseFile[];
+}

package/dist/submissions/uploads/post/response.js

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

package/dist/submissions/uploads/post/response.js.map

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

package/dist/types/[id]/get.d.ts

@@ -1,5 +1,6 @@
 import { GetFieldResponse } from '../../fields/[id]/get';
-import { IEmbeddedEntity } from '../../shared';
+import { IFieldBindingDelta } from '../../fields';
+import { IActionAttachment, IActionAttachmentAll, IEmbeddedEntity, IReadinessRule, IReadinessRuleAll } from '../../shared';
 export interface IFieldValue {
     id: string;
     name: string;
@@ -9,8 +10,16 @@ export interface IFieldValue {
     valueBoolean?: boolean;
     valueDate?: string;
     valueDateTime?: Date;
+    /** True when the value was derived by a COMPUTED/AGGREGATED binding (read-only). */
+    computed?: boolean;
 }
-export interface IFieldDefinitionAll extends GetFieldResponse {
+/**
+ * A resolved field on a type (own + inherited), carrying its authoring
+ * `typePath` and any binding delta (`source`/`expression`/`visibleWhen`). The
+ * server-computed metadata (`referencedFields`/`timeSensitive`) is internal and
+ * not surfaced here.
+ */
+export interface IFieldDefinitionAll extends GetFieldResponse, IFieldBindingDelta {
     typePath: string;
 }
 export interface IFieldValueAll extends IFieldValue {
@@ -36,4 +45,10 @@ export interface GetTypeResponse {
     manifestId?: string;
     manifestIds?: string[];
     supportsStocktake?: boolean;
+    /** Assets of this type are kits (containers) — G2G M2. */
+    typeKit?: boolean;
+    readinessRules?: IReadinessRule[];
+    readinessRulesAll?: IReadinessRuleAll[];
+    actions?: IActionAttachment[];
+    actionsAll?: IActionAttachmentAll[];
 }

package/dist/types/[id]/patch/request.d.ts

@@ -1,13 +1,27 @@
-import { IEmbeddedEntityWithIdOrName, IFieldValueWithConstraints } from '../../post';
+import { IEmbeddedEntityWithIdOrName, IFieldBinding, IFieldValueWithConstraints } from '../../post';
+import { IActionAttachment, IActionAttachmentAll, IReadinessRule, IReadinessRuleAll } from '../../../shared';
 export interface UpdateTypeRequest {
     name?: string;
     parent?: string;
     fullNameTemplate?: string | null;
     description?: string;
     path?: string;
-    fields?: IEmbeddedEntityWithIdOrName[];
+    fields?: IFieldBinding[];
     typeFields?: IEmbeddedEntityWithIdOrName[];
     typeFieldValues?: IFieldValueWithConstraints[];
     manifestIds?: string[];
     supportsStocktake?: boolean;
+    /** Assets of this type are kits (containers) — G2G M2. */
+    typeKit?: boolean;
+    readinessRules?: IReadinessRule[];
+    /**
+     * Server-derived, read-only projection (own + inherited rules) returned by
+     * GET. Tolerated on input only so a GET → edit → PATCH round-trip of the whole
+     * type doesn't 400; the server strips it and re-derives it from stored state +
+     * parent (prepareUpdate), so it never affects what is stored.
+     */
+    readinessRulesAll?: IReadinessRuleAll[];
+    actions?: IActionAttachment[];
+    /** Server-derived like `readinessRulesAll`: tolerated on input, stripped. */
+    actionsAll?: IActionAttachmentAll[];
 }

package/dist/types/post/request.d.ts

@@ -1,3 +1,5 @@
+import { IActionAttachment, IReadinessRule } from '../../shared';
+import { IFieldBindingDelta } from '../../fields';
 export declare type IEmbeddedEntityWithIdOrName = {
     id: string;
     name?: never;
@@ -8,6 +10,12 @@ export declare type IEmbeddedEntityWithIdOrName = {
     id: string;
     name: string;
 };
+/**
+ * A type's authored field binding: the field reference (`id`/`name`) plus an
+ * optional source/visibility delta (§5 / §1.4). A bare `{ id }` is an INPUT
+ * binding, exactly as before.
+ */
+export declare type IFieldBinding = IEmbeddedEntityWithIdOrName & IFieldBindingDelta;
 declare type ValueStringOnly = {
     valueString: string;
     valueInteger?: never;
@@ -66,18 +74,24 @@ declare type IdOrName = {
     id: string;
     name: string;
 };
-export declare type IFieldValueWithConstraints = IdOrName & (ValueStringOnly | ValueIntegerOnly | ValueDecimalOnly | ValueBooleanOnly | ValueDateOnly | ValueDateTimeOnly);
+export declare type IFieldValueWithConstraints = IdOrName & {
+    computed?: boolean;
+} & (ValueStringOnly | ValueIntegerOnly | ValueDecimalOnly | ValueBooleanOnly | ValueDateOnly | ValueDateTimeOnly);
 export interface PostTypeRequest {
     name: string;
     parent?: string;
     fullNameTemplate?: string | null;
     description?: string;
     path?: string;
-    fields?: IEmbeddedEntityWithIdOrName[];
+    fields?: IFieldBinding[];
     typeFields?: IEmbeddedEntityWithIdOrName[];
     typeFieldValues?: IFieldValueWithConstraints[];
     manifestIds?: string[];
     supportsStocktake?: boolean;
+    /** Assets of this type are kits (containers) — G2G M2. */
+    typeKit?: boolean;
+    readinessRules?: IReadinessRule[];
+    actions?: IActionAttachment[];
 }
 export declare type PostTypesRequest = PostTypeRequest[];
 export declare const testPostTypeRequest: PostTypeRequest;

package/dist/types/post/request.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/types/post/request.ts"],"names":[],"mappings":";;;AAuFA,QAAQ;AACK,QAAA,mBAAmB,GAAoB;IAClD,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,MAAM;IACZ,gBAAgB,EAAE,OAAO;IACzB,MAAM,EAAE;QACN;YACE,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,QAAQ;SACf;KACF;IACD,eAAe,EAAE;QACf;YACE,gBAAgB;YAChB,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,IAAI;YAClB,oBAAoB;SACrB;KACF;IACD,iBAAiB,EAAE,IAAI;CACxB,CAAA"}
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/types/post/request.ts"],"names":[],"mappings":";;;AA0GA,QAAQ;AACK,QAAA,mBAAmB,GAAoB;IAClD,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,MAAM;IACZ,gBAAgB,EAAE,OAAO;IACzB,MAAM,EAAE;QACN;YACE,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,QAAQ;SACf;KACF;IACD,eAAe,EAAE;QACf;YACE,gBAAgB;YAChB,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,IAAI;YAClB,oBAAoB;SACrB;KACF;IACD,iBAAiB,EAAE,IAAI;CACxB,CAAA"}

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,64 @@
+/**
+ * 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`.
+ *
+ * A layout is a flat, ordered list of widgets, each pinned to a rect on a
+ * 4-column grid (`gridPos`). The widget `type` is a closed union (below): adding
+ * a new kind is a contract change + republish + client bump. Per-widget `config`
+ * is left opaque and carries widget *behaviour* only (a saved-view id, an action
+ * id, a heading's text) — never geometry — so a widget can evolve without a
+ * contract change while the API still validates the structural parts.
+ *
+ * `version` discriminates stored layouts so the client can detect and
+ * reset/migrate an older one on read.
+ */
+/**
+ * The kinds of Home widget. Closed set — adding one is a contract change.
+ * - `tile-link` — a link card (a saved view or a nav destination); 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.
+ * - `hero` — the fleet-readiness hero (overview + inline needs-attention legend).
+ * - `heading` — a text heading to label a run of widgets (heading text lives in `config`).
+ *
+ * `hero` and `heading` are full-width structural widgets: the client renders them
+ * spanning the whole row at every breakpoint. As with all widgets, width is
+ * expressed through `gridPos.w`, not enforced by the API.
+ */
+export declare type HomeWidgetType = 'tile-link' | 'summary-list' | 'recent-activity' | 'recent-assets' | 'recent-locations' | 'needs-attention' | 'kit-spotlight' | 'hero' | 'heading';
+/**
+ * A widget's cell on the Home grid: top-left position (`x`/`y`) and size
+ * (`w`/`h`), in grid units. The grid is 4 columns wide, so `x + w <= 4`, and
+ * `h` is a whole number of row-units. Below the desktop breakpoint the client
+ * collapses to a single column, so `x`/`w` only bind on wide viewports.
+ */
+export interface HomeWidgetGridPos {
+    /** Column of the top-left corner (0-based; `x + w <= 4`). */
+    x: number;
+    /** Row of the top-left corner (0-based), in row-units. */
+    y: number;
+    /** Width in columns (1–4). */
+    w: number;
+    /** Height in row-units (>= 1). */
+    h: number;
+}
+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;
+    /** Position + size on the 4-column grid. */
+    gridPos: HomeWidgetGridPos;
+    /** Widget-specific *behaviour* config (e.g. a saved-view id, a heading's text). Opaque to the API; never geometry. */
+    config?: Record<string, unknown>;
+}
+export interface HomeLayout {
+    /** Layout schema version, so the client can detect + migrate/reset older stored layouts. */
+    version: number;
+    /** Flat, ordered widget list; geometry lives on each widget's `gridPos`. */
+    widgets: HomeWidget[];
+}

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

@@ -0,0 +1,19 @@
+"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`.
+ *
+ * A layout is a flat, ordered list of widgets, each pinned to a rect on a
+ * 4-column grid (`gridPos`). The widget `type` is a closed union (below): adding
+ * a new kind is a contract change + republish + client bump. Per-widget `config`
+ * is left opaque and carries widget *behaviour* only (a saved-view id, an action
+ * id, a heading's text) — never geometry — so a widget can evolve without a
+ * contract change while the API still validates the structural parts.
+ *
+ * `version` discriminates stored layouts so the client can detect and
+ * reset/migrate an older one on read.
+ */
+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;;;;;;;;;;;;;;;GAeG"}

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.1",
+  "version": "1.0.70-alpha.11",
   "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": "f9ca7e502cb0a991ebbc204eb54b166d64f2a307"
+  "gitHead": "3bfd5e720157f73503fd29486b6111952e44de5a"
 }