@spotto/contract 1.0.70-alpha.10 → 1.0.70-alpha.12

package/dist/submissions/index.js

@@ -0,0 +1,23 @@
+"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("./constants"), exports);
+__exportStar(require("./shared"), exports);
+__exportStar(require("./get"), exports);
+__exportStar(require("./post"), exports);
+__exportStar(require("./[id]"), exports);
+__exportStar(require("./uploads"), exports);
+//# sourceMappingURL=index.js.map

package/dist/submissions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/submissions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,2CAAwB;AACxB,wCAAqB;AACrB,yCAAsB;AACtB,yCAAsB;AACtB,4CAAyB"}

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

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

package/dist/submissions/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/post/index.js.map

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

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

@@ -0,0 +1,17 @@
+import { ActionTargetEntity } from '../../actions/shared';
+import { ISubmissionAttachment, ISubmissionFieldValue } from '../shared';
+export interface PostSubmissionRequest {
+    /** Client-minted idempotency key (ULID) — one per capture, reused on retry. */
+    clientReference: string;
+    actionName: string;
+    /** The form version pinned when the run opened. */
+    formName: string;
+    formVersion: number;
+    /** The run's target: a location run captures without write-back (§4.4). */
+    entity: ActionTargetEntity;
+    entityId: string;
+    /** Client fill time (ISO). */
+    capturedAt: string;
+    fieldValues?: ISubmissionFieldValue[];
+    attachments?: ISubmissionAttachment[];
+}

package/dist/submissions/post/request.js

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

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

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

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

@@ -0,0 +1,22 @@
+import { GetAssetResponse } from '../../assets';
+import { GetSubmissionResponse, ISubmissionEffect } from '../shared';
+/**
+ * Delivery status of one effect on a fresh submit (§4.2): a raiseAlert entry
+ * is 'raised' by being returned; sendMessage is 'sent' or 'failed' (the
+ * capture is committed either way — effects never roll it back). Replays
+ * carry the stored effects without statuses: effects are at-most-once and
+ * ran (if ever) on the original request.
+ */
+export declare type SubmissionEffectStatus = 'raised' | 'sent' | 'failed' | 'skipped';
+export interface PostSubmissionResponseEffect extends ISubmissionEffect {
+    status?: SubmissionEffectStatus;
+    /** The send failure detail when status is 'failed'. */
+    error?: string;
+}
+export interface PostSubmissionResponse extends GetSubmissionResponse {
+    /** True when this request replayed an already-recorded capture (§3.3 dedupe). */
+    replayed: boolean;
+    /** Fresh target readiness after recompute; absent when the target has gone. */
+    readiness?: GetAssetResponse['readiness'];
+    effects?: PostSubmissionResponseEffect[];
+}

package/dist/submissions/post/response.js

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

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

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

package/dist/submissions/shared.d.ts

@@ -0,0 +1,133 @@
+import { ActionAlertLevel, ActionEffectType, ActionTargetEntity } from '../actions/shared';
+import { IEmbeddedEntity } from '../shared';
+import { IFieldValue } from '../types';
+/**
+ * A value captured for one form field item, as transmitted at submit.
+ * Name-keyed (form items name global field definitions); exactly one value
+ * slot per entry — a multi-select (CHECKBOXES) sends one entry per selected
+ * option, and an unanswered field sends no entry at all.
+ */
+export interface ISubmissionFieldValue {
+    name: string;
+    valueString?: string;
+    valueInteger?: number;
+    valueDecimal?: number;
+    valueBoolean?: boolean;
+    /** DATE wire format: YYYY-MM-DD. */
+    valueDate?: string;
+    valueDateTime?: Date | string;
+    /** Tolerated on input for round-trips; stripped — identity resolves by name. */
+    id?: string;
+    /** Tolerated on input for round-trips; stripped — re-derived server-side. */
+    computed?: boolean;
+}
+/** A captured signature/photo reference (uploaded via B4's presigned POST). */
+export interface ISubmissionAttachment {
+    /** Names a capture block of the pinned form version — distinct per row. */
+    blockName: string;
+    fileId: string;
+    contentType: string;
+}
+/**
+ * A write-back audit value in stored format: DATE as a YYYYMMDD integer,
+ * DATETIME as a Date, CHECKBOXES as the full option array.
+ */
+export declare type SubmissionWriteBackValue = string | number | boolean | string[];
+/** One write-back row's outcome — applied with values, or skipped with why. */
+export interface ISubmissionWriteBackAudit {
+    to: string;
+    appliedValue?: SubmissionWriteBackValue;
+    /** The asset-level value the write replaced; absent when the field had none. */
+    previousValue?: SubmissionWriteBackValue;
+    /** Present on expression rows — the formula that produced the value. */
+    expression?: string;
+    skipped?: true;
+    reason?: string;
+}
+/**
+ * One effect outcome as stored on the event (§4.2): resolved content for an
+ * effect that ran — messages interpolated over the submit env — or a skip
+ * audit when the action's write authority was gone (§3.2). Delivery status
+ * never persists: the event commits before effects run (see the POST
+ * response's status overlay).
+ */
+export interface ISubmissionEffect {
+    type: ActionEffectType;
+    /** raiseAlert severity. */
+    level?: ActionAlertLevel;
+    /** Resolved message (missing references render as "(not set)"). */
+    message?: string;
+    /** sendMessage recipients. */
+    to?: string[];
+    /** sendMessage resolved subject. */
+    subject?: string;
+    skipped?: true;
+    reason?: string;
+}
+export interface ISubmissionContext {
+    entity: ActionTargetEntity;
+    entityId: string;
+    /** The asset's type at submit — never present on location runs (§4.4). */
+    typeId?: string;
+    /** The asset's type path at submit — never present on location runs (§4.4). */
+    typePath?: string;
+}
+/** The asset a submission ran against — identity plus its type path, both
+ * frozen at submit (later type renames never rewrite event history). */
+export interface ISubmissionAssetEmbed extends IEmbeddedEntity {
+    typePath?: string;
+}
+/** Overlay from an appended FormSubmissionVoided event. */
+export interface ISubmissionVoided {
+    eventId: string;
+    timestamp: number;
+    user: IEmbeddedEntity;
+    reason?: string;
+}
+/**
+ * The submission payload as stored on the FormSubmitted event — everything
+ * below the event envelope. Shared by the submission resource and the
+ * events-feed member.
+ */
+export interface ISubmissionPayload {
+    /** Client-minted idempotency key (ULID). */
+    clientReference: string;
+    /** Server-computed canonical hash of the capture (excludes attachment fileIds). */
+    fingerprint: string;
+    /** Absent when the action had been deleted by the time the capture drained. */
+    actionId?: string;
+    actionName: string;
+    actionLabel?: string;
+    formId: string;
+    formName: string;
+    formVersion: number;
+    /** Display label from the action's `event` config. */
+    eventLabel?: string;
+    context: ISubmissionContext;
+    /** Client fill time (ISO) — differs from the event timestamp under offline drain. */
+    capturedAt: string;
+    fieldValues: IFieldValue[];
+    attachments?: ISubmissionAttachment[];
+    writeBack?: ISubmissionWriteBackAudit[];
+    effects?: ISubmissionEffect[];
+}
+/** The payload of a FormSubmissionVoided event. */
+export interface ISubmissionVoidPayload {
+    /** The FormSubmitted event id this void applies to. */
+    original: string;
+    actionName: string;
+    actionLabel?: string;
+    formName: string;
+    formVersion: number;
+    reason?: string;
+}
+/** The submission resource — a parsed FormSubmitted event. Exactly one of
+ * `asset`/`location` is present, matching the run's target entity. */
+export interface GetSubmissionResponse extends ISubmissionPayload {
+    id: string;
+    timestamp: number;
+    asset?: ISubmissionAssetEmbed;
+    location?: IEmbeddedEntity;
+    user: IEmbeddedEntity;
+    voided?: ISubmissionVoided;
+}

package/dist/submissions/shared.js

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

package/dist/submissions/shared.js.map

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

package/dist/submissions/uploads/[fileId]/get.d.ts

@@ -0,0 +1,11 @@
+/** GET /submissions/uploads/{fileId} — path parameters. */
+export interface SubmissionUploadPath {
+    fileId: string;
+}
+/**
+ * A short-lived presigned download for a committed object under the caller's
+ * own org — the key derives from the authenticated org, never from input.
+ */
+export interface GetSubmissionUploadResponse {
+    url: string;
+}

package/dist/submissions/uploads/[fileId]/get.js

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

package/dist/submissions/uploads/[fileId]/get.js.map

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

package/dist/submissions/uploads/[fileId]/index.d.ts

@@ -0,0 +1 @@
+export * from './get';

package/dist/submissions/uploads/[fileId]/index.js

@@ -0,0 +1,18 @@
+"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("./get"), exports);
+//# sourceMappingURL=index.js.map

package/dist/submissions/uploads/[fileId]/index.js.map

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

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

@@ -0,0 +1,2 @@
+export * from './post';
+export * from './[fileId]';

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,6 +1,6 @@
 import { GetFieldResponse } from '../../fields/[id]/get';
 import { IFieldBindingDelta } from '../../fields';
-import { IEmbeddedEntity, IReadinessRule, IReadinessRuleAll } from '../../shared';
+import { IActionAttachment, IActionAttachmentAll, IEmbeddedEntity, IReadinessRule, IReadinessRuleAll } from '../../shared';
 export interface IFieldValue {
     id: string;
     name: string;
@@ -49,4 +49,6 @@ export interface GetTypeResponse {
     typeKit?: boolean;
     readinessRules?: IReadinessRule[];
     readinessRulesAll?: IReadinessRuleAll[];
+    actions?: IActionAttachment[];
+    actionsAll?: IActionAttachmentAll[];
 }

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

@@ -1,5 +1,5 @@
 import { IEmbeddedEntityWithIdOrName, IFieldBinding, IFieldValueWithConstraints } from '../../post';
-import { IReadinessRule, IReadinessRuleAll } from '../../../shared';
+import { IActionAttachment, IActionAttachmentAll, IReadinessRule, IReadinessRuleAll } from '../../../shared';
 export interface UpdateTypeRequest {
     name?: string;
     parent?: string;
@@ -21,4 +21,7 @@ export interface UpdateTypeRequest {
      * 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,4 +1,4 @@
-import { IReadinessRule } from '../../shared';
+import { IActionAttachment, IReadinessRule } from '../../shared';
 import { IFieldBindingDelta } from '../../fields';
 export declare type IEmbeddedEntityWithIdOrName = {
     id: string;
@@ -91,6 +91,7 @@ export interface PostTypeRequest {
     /** 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":";;;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"}
+{"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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotto/contract",
   "license": "ISC",
-  "version": "1.0.70-alpha.10",
+  "version": "1.0.70-alpha.12",
   "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": "401c779540b38f2313d405a9ce34f7ce0054418f"
+  "gitHead": "609333e7153afaa63e907e108dfa0fd08df49246"
 }