@spotto/contract 1.0.70-alpha.4 → 1.0.70-alpha.5

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

@@ -1,7 +1,7 @@
 import { type Point } from 'geojson';
 import { IEmbeddedLabel } from '../../labels';
 import { LocationStatus, LocationType } from '../../locations/constants';
-import { IEntityMeta, IEmbeddedEntity } from '../../shared';
+import { IEntityMeta, IEmbeddedEntity, IReadiness } from '../../shared';
 import { IAssetTelemetry } from '../../telemetry';
 import { IFieldValue } from '../../types';
 export interface ILastLocation {
@@ -74,4 +74,12 @@ export interface GetAssetResponse {
     homeLocationPath?: string;
     readers?: IEmbeddedEntity[];
     manifestIds?: string[];
+    typeKit?: boolean;
+    groupParentId?: string;
+    groupAncestors?: string[];
+    groupMember?: boolean;
+    groupChildCount?: number;
+    groupSatisfiesKit?: boolean;
+    readiness?: IReadiness;
+    timeSensitive?: boolean;
 }

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

@@ -8,4 +8,9 @@ export interface UpdateAssetRequest {
     fieldValues?: IFieldValueWithConstraints[];
     homeLocationId?: string;
     manifestIds?: string[];
+    /**
+     * Kit membership (G2G M2): a kit id joins/moves the asset under that kit,
+     * `null` leaves its current kit, omitted leaves membership unchanged.
+     */
+    groupParentId?: string | null;
 }

package/dist/assets/get/query.d.ts

@@ -1,8 +1,8 @@
-import { DateCondition, SearchableSortFields, SortOrders } from '../../shared';
+import { DateCondition, ReadinessState, SearchableSortFields, SortOrders } from '../../shared';
 import { LocationStatus } from '../../locations/constants';
 export declare type AssetSearchField = 'name' | 'tagIds';
-export declare type AssetEmbedField = 'meta' | 'tagIds' | 'candidateLocations' | 'telemetry' | 'readers';
-export declare type AssetSortField = SearchableSortFields | 'battery';
+export declare type AssetEmbedField = 'meta' | 'tagIds' | 'candidateLocations' | 'telemetry' | 'readers' | 'readiness';
+export declare type AssetSortField = SearchableSortFields | 'battery' | 'ready';
 export declare type AssetBatteryStatus = 'critical' | 'low' | 'ok';
 declare type _CustomFieldsAssetFilterBase = {
     id: string;
@@ -50,6 +50,9 @@ export interface AssetFilters {
     supportsWith?: boolean;
     withAsset?: boolean;
     dispatched?: boolean;
+    timeSensitive?: boolean;
+    ready?: ReadinessState[];
+    hasReadyIssues?: boolean;
     createdAt?: DateCondition[];
     updatedAt?: DateCondition[];
     lastSeen?: DateCondition[];

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

@@ -8,6 +8,8 @@ export interface PostAssetRequest {
     fieldValues?: IFieldValueWithConstraints[];
     homeLocationId?: string;
     manifestIds?: string[];
+    /** Join a kit at creation — the direct parent kit's id (G2G M2). */
+    groupParentId?: string;
 }
 export declare type PostAssetsRequest = PostAssetRequest[];
 export declare const testPostAssetRequest: PostAssetRequest;

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

@@ -1 +1 @@
-{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/assets/post/request.ts"],"names":[],"mappings":";;;AAeA,QAAQ;AACK,QAAA,oBAAoB,GAAqB;IACpD,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,MAAM;IAClB,MAAM,EAAE,OAAO;CAChB,CAAA"}
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/assets/post/request.ts"],"names":[],"mappings":";;;AAiBA,QAAQ;AACK,QAAA,oBAAoB,GAAqB;IACpD,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,MAAM;IAClB,MAAM,EAAE,OAAO;CAChB,CAAA"}

package/dist/fields/constants.d.ts

@@ -2,3 +2,22 @@ export declare type FieldDataType = 'STRING' | 'INTEGER' | 'DECIMAL' | 'BOOLEAN'
 export declare const FIELD_DATA_TYPES: FieldDataType[];
 export declare type FieldInputType = 'SINGLELINE' | 'MULTILINE' | 'LINK' | 'RICHTEXT' | 'DROPDOWN' | 'RADIO' | 'CHECKBOXES' | 'DATE' | 'DATETIME' | 'INTEGER' | 'DECIMAL' | 'SWITCH';
 export declare const FIELD_INPUT_TYPES: FieldInputType[];
+export declare type FieldSource = 'INPUT' | 'COMPUTED' | 'AGGREGATED';
+export declare const FIELD_SOURCES: FieldSource[];
+export declare type AggregateFunction = 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'COUNT';
+export declare const AGGREGATE_FUNCTIONS: AggregateFunction[];
+/**
+ * A per-type field-binding delta, layered onto the inherited field identity
+ * (`fieldsAll = parent.fieldsAll ⊕ fields`). Omitted `source` on an override =
+ * inherit; explicit `INPUT` = reset to user-entered.
+ *   - `expression`   — COMPUTED: excelexp over the asset's other fields.
+ *   - `visibleWhen`  — conditional visibility (client-render only).
+ *   - `function`     — AGGREGATED (M2 — kits): the same field is reduced across
+ *     a kit's direct members.
+ */
+export interface IFieldBindingDelta {
+    source?: FieldSource;
+    expression?: string;
+    visibleWhen?: string;
+    function?: AggregateFunction;
+}

package/dist/fields/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FIELD_INPUT_TYPES = exports.FIELD_DATA_TYPES = void 0;
+exports.AGGREGATE_FUNCTIONS = exports.FIELD_SOURCES = exports.FIELD_INPUT_TYPES = exports.FIELD_DATA_TYPES = void 0;
 const dataTypes = {
     STRING: null,
     INTEGER: null,
@@ -25,4 +25,18 @@ const inputTypes = {
     SWITCH: null,
 };
 exports.FIELD_INPUT_TYPES = Object.keys(inputTypes);
+const fieldSources = {
+    INPUT: null,
+    COMPUTED: null,
+    AGGREGATED: null,
+};
+exports.FIELD_SOURCES = Object.keys(fieldSources);
+const aggregateFunctions = {
+    SUM: null,
+    AVG: null,
+    MIN: null,
+    MAX: null,
+    COUNT: null,
+};
+exports.AGGREGATE_FUNCTIONS = Object.keys(aggregateFunctions);
 //# sourceMappingURL=constants.js.map

package/dist/fields/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/fields/constants.ts"],"names":[],"mappings":";;;AAQA,MAAM,SAAS,GAAqC;IAClD,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;CACf,CAAA;AAEY,QAAA,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAoB,CAAA;AAgBzE,MAAM,UAAU,GAAsC;IACpD,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,IAAI;CACb,CAAA;AAEY,QAAA,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAqB,CAAA"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/fields/constants.ts"],"names":[],"mappings":";;;AAQA,MAAM,SAAS,GAAqC;IAClD,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;CACf,CAAA;AAEY,QAAA,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAoB,CAAA;AAgBzE,MAAM,UAAU,GAAsC;IACpD,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,IAAI;CACb,CAAA;AAEY,QAAA,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAqB,CAAA;AAS5E,MAAM,YAAY,GAAmC;IACnD,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;CACjB,CAAA;AAEY,QAAA,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAkB,CAAA;AAIvE,MAAM,kBAAkB,GAAyC;IAC/D,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,KAAK,EAAE,IAAI;CACZ,CAAA;AAEY,QAAA,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAC5C,kBAAkB,CACI,CAAA"}

package/dist/shared/index.d.ts

@@ -9,3 +9,4 @@ export * from './sort';
 export * from './timezone';
 export * from './timestamp';
 export * from './relative-date';
+export * from './readiness';

package/dist/shared/index.js

@@ -25,4 +25,5 @@ __exportStar(require("./sort"), exports);
 __exportStar(require("./timezone"), exports);
 __exportStar(require("./timestamp"), exports);
 __exportStar(require("./relative-date"), exports);
+__exportStar(require("./readiness"), exports);
 //# sourceMappingURL=index.js.map

package/dist/shared/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,2CAAwB;AACxB,0CAAuB;AACvB,2CAAwB;AACxB,4CAAyB;AACzB,yCAAsB;AACtB,0CAAuB;AACvB,yCAAsB;AACtB,6CAA0B;AAC1B,8CAA2B;AAC3B,kDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,2CAAwB;AACxB,0CAAuB;AACvB,2CAAwB;AACxB,4CAAyB;AACzB,yCAAsB;AACtB,0CAAuB;AACvB,yCAAsB;AACtB,6CAA0B;AAC1B,8CAA2B;AAC3B,kDAA+B;AAC/B,8CAA2B"}

package/dist/shared/readiness.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Good-to-Go (G2G) asset readiness — shared API contract shapes.
+ *
+ * Readiness rules are authored on types (and inherited like fields), evaluated
+ * against an asset's field values by the excelexp engine. A rule whose
+ * expression evaluates TRUE raises an issue at its level; an asset's overall
+ * `ready` is the worst level among its issues.
+ */
+/** Readiness severity: 1 = amber (warning), 2 = red (blocking). */
+export declare type ReadinessLevel = 1 | 2;
+/** Overall readiness: 0 = ready (green), else the worst issue level. */
+export declare type ReadinessState = 0 | ReadinessLevel;
+/**
+ * An authored readiness rule on a type. `expression` is an excelexp boolean;
+ * when it evaluates TRUE the issue fires at `level` with `message` rendered as
+ * a `{FieldName}` template.
+ */
+export interface IReadinessRule {
+    level: ReadinessLevel;
+    expression: string;
+    message: string;
+}
+/**
+ * A resolved rule (own + inherited), carrying the path of the type that
+ * authored it — mirrors how `IFieldDefinitionAll` carries `typePath`.
+ */
+export interface IReadinessRuleAll extends IReadinessRule {
+    /** Id of the type that authored the rule. */
+    typeId: string;
+    typePath: string;
+}
+/** A fired readiness issue on an asset. */
+export interface IReadinessIssue {
+    /** The type that authored the fired rule. */
+    typeId: string;
+    /**
+     * The asset the issue came from: the asset itself for a leaf, or a member
+     * for a kit (kit issues are materialized copies of member issues).
+     */
+    assetId: string;
+    assetName: string;
+    level: ReadinessLevel;
+    /** Rendered message (the rule's `message` template with field values). */
+    reason: string;
+    /**
+     * Referenced DATE / number fields that had no value, causing the rule to
+     * fail closed. Present only when the issue fired on missing data.
+     */
+    missingFields?: string[];
+}
+/** Stored/returned readiness for an asset. */
+export interface IReadiness {
+    /** Worst level among `readyIssues`; 0 = ready (green). */
+    ready: ReadinessState;
+    readyIssues: IReadinessIssue[];
+    /** Epoch ms of the evaluation that produced this result. */
+    evaluatedAt?: number;
+}

package/dist/shared/readiness.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Good-to-Go (G2G) asset readiness — shared API contract shapes.
+ *
+ * Readiness rules are authored on types (and inherited like fields), evaluated
+ * against an asset's field values by the excelexp engine. A rule whose
+ * expression evaluates TRUE raises an issue at its level; an asset's overall
+ * `ready` is the worst level among its issues.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=readiness.js.map

package/dist/shared/readiness.js.map

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

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 { 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,8 @@ export interface GetTypeResponse {
     manifestId?: string;
     manifestIds?: string[];
     supportsStocktake?: boolean;
+    /** Assets of this type are kits (containers) — G2G M2. */
+    typeKit?: boolean;
+    readinessRules?: IReadinessRule[];
+    readinessRulesAll?: IReadinessRuleAll[];
 }

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

@@ -1,13 +1,24 @@
-import { IEmbeddedEntityWithIdOrName, IFieldValueWithConstraints } from '../../post';
+import { IEmbeddedEntityWithIdOrName, IFieldBinding, IFieldValueWithConstraints } from '../../post';
+import { 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[];
 }

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

@@ -1,3 +1,5 @@
+import { 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,23 @@ 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[];
 }
 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":";;;AAyGA,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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotto/contract",
   "license": "ISC",
-  "version": "1.0.70-alpha.4",
+  "version": "1.0.70-alpha.5",
   "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": "5fbc0257d9e7ac188d66b7d5ca3bbfc0a66b0653"
+  "gitHead": "8a9d62932fd6cab497181105341be04599f993f5"
 }