@memberjunction/skip-types 2.126.1 → 2.128.0

package/dist/api-types.d.ts

@@ -175,6 +175,15 @@ export declare class SkipAPIRequest {
      * of the request
      */
     callingServerAccessToken?: string;
+    /**
+     * Optional payload data that was returned from a previous response. When the Skip API returns a response
+     * with a payload (e.g., a PRD from Requirements Expert), the client should pass that payload back in the
+     * next request so the agent can continue building on it.
+     *
+     * This enables incremental artifact building where structured data accumulates throughout the conversation.
+     * The payload is separate from artifacts - it represents work-in-progress data that hasn't been finalized yet.
+     */
+    payload?: Record<string, any>;
 }
 /**
  * Defines the shape of the data that is returned by the Skip API Server
@@ -197,6 +206,17 @@ export declare class SkipAPIResponse {
      * any additional messages that Skip generates as part of the conversation.
      */
     messages: SkipMessage[];
+    /**
+     * Optional payload data from the agent. When provided, the calling application can render this
+     * payload as an artifact for the user to review/edit. This enables incremental artifact building
+     * where the payload is passed back and forth between the user and agent, accumulating structured
+     * data throughout the conversation.
+     *
+     * Common use case: Requirements Expert emits a PRD with functionalRequirements, title, type,
+     * userExplanation etc. in the payload. The client renders this as an artifact for user review.
+     * When user responds, the client passes the payload back in the next SkipAPIRequest.payload field.
+     */
+    payload?: Record<string, any>;
 }
 /**
  * Special API request type that extends the base SkipAPIRequest to include script execution capabilities.

package/dist/api-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-types.d.ts","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAE5E;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAEzF;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,+BAA+B,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,qBAAa,cAAc;IACvB;;;;OAIG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,gBAAgB,CAAC;IAE/B;;;OAGG;IACH,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;CACpC;AAED;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;;OAGG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,cAAc;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"api-types.d.ts","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAE5E;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAEzF;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,+BAA+B,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,qBAAa,cAAc;IACvB;;;;OAIG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,gBAAgB,CAAC;IAE/B;;;OAGG;IACH,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;;OAGG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACjC;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,cAAc;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB"}

package/dist/api-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;AAUH;;;;;;;;;GASG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;CAClC,CAAC;AAGX;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,2BAA2B,EAAE,6BAA6B;CACpD,CAAC;AAGX;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAED;;GAEG;AACH,MAAa,cAAc;CAsF1B;AAtFD,wCAsFC;AAED;;GAEG;AACH,MAAa,eAAe;CAkB3B;AAlBD,0CAkBC;AAED;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC"}
+{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;AAUH;;;;;;;;;GASG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;CAClC,CAAC;AAGX;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,2BAA2B,EAAE,6BAA6B;CACpD,CAAC;AAGX;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAED;;GAEG;AACH,MAAa,cAAc;CAgG1B;AAhGD,wCAgGC;AAED;;GAEG;AACH,MAAa,eAAe;CA8B3B;AA9BD,0CA8BC;AAED;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/skip-types",
-  "version": "2.126.1",
+  "version": "2.128.0",
   "description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,10 +19,10 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/core": "2.126.1",
-    "@memberjunction/interactive-component-types": "2.126.1",
-    "@memberjunction/ai-core-plus": "2.126.1",
-    "@memberjunction/data-context": "2.126.1"
+    "@memberjunction/core": "2.128.0",
+    "@memberjunction/interactive-component-types": "2.128.0",
+    "@memberjunction/ai-core-plus": "2.128.0",
+    "@memberjunction/data-context": "2.128.0"
   },
   "repository": {
     "type": "git",