@api-client/core 0.19.6 → 0.19.8

package/data/models/example-generator-api.json

@@ -42810,16 +42810,16 @@
 "@id": "#219"
 },
 {
-"@id": "#210"
+"@id": "#219"
 },
 {
-"@id": "#213"
+"@id": "#216"
 },
 {
-"@id": "#216"
+"@id": "#210"
 },
 {
-"@id": "#219"
+"@id": "#213"
 }
 ],
 "doc:root": false,
@@ -44232,7 +44232,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44253,7 +44253,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
+"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44274,7 +44274,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44295,7 +44295,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -45116,22 +45116,22 @@
 {
 "@id": "#212/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#212",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#338/source-map/synthesized-field/element_1",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.19.6",
+  "version": "0.19.8",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/modeling/DomainProperty.ts

@@ -542,6 +542,17 @@ export class DomainProperty extends DomainElement {
     return object.schema as PropertyWebBindings
   }
 
+  /**
+   * Reads the web binding definition, if any.
+   * Useful for reading binding data without mutating the model when the binding
+   * is missing (unlike `getWebBinding()` which creates the binding when missing).
+   * @returns The web binding definition, if any
+   */
+  readWebBinding(): PropertyWebBindings | undefined {
+    const object = this.bindings.find((i) => i.type === 'web') as PropertyBinding | undefined
+    return object?.schema as PropertyWebBindings | undefined
+  }
+
   /**
    * Returns the schema value of the binding, if any was created.
    * @param type The type of the binding to read.

package/src/modeling/ai/message_parser.ts

@@ -12,6 +12,7 @@ import { DataDomainDelta } from './DataDomainDelta.js'
  *
  * @param msg The generic AI chat message.
  * @returns The parsed in-memory wrapper context message.
+ * @deprecated Use `AiModelMessage.processMessageSafe` instead.
  */
 export function parseAiChatMessage(msg: AiMessageSchema): AiUserMessage | AiModelMessageWithDelta {
   if (msg.role === 'user') {

package/src/models/AiMessage.ts

@@ -3,6 +3,7 @@ import { AiMessageKind } from './kinds.js'
 import { nanoid } from '../nanoid.js'
 import type { AiDomainDelta } from '../modeling/ai/types.js'
 import { DataDomainDelta } from '../modeling/ai/DataDomainDelta.js'
+import { detectReasoning } from '../modeling/ai/message_parser.js'
 
 export type AiMessageRole = 'user' | 'model'
 export type AiMessageState = 'loading' | 'complete' | 'error' | 'terminated'
@@ -210,21 +211,39 @@ export class AiUserMessage extends AiMessageBase<AiUserMessageSchema> implements
   }
 }
 
-export class AiModelMessage extends AiMessageBase<AiModelMessageSchema> implements AiModelMessageSchema {
+/**
+ * Model messages have the `text` that most likely is a structured JSON
+ * with the `delta` and `reasoning` properties. When an `AiModelMessage` is instantiated,
+ * it will try to parse the `text` into the `delta` and `reasoning` properties, leaving the
+ * `text` property unchanged.
+ *
+ * The delta object will be different for different models and different use cases.
+ * It is up to the model to define the delta object. However, the delta object should
+ * be normalized by each child class.
+ *
+ * @template D The type of the delta.
+ */
+export abstract class AiModelMessage<D = unknown>
+  extends AiMessageBase<AiModelMessageSchema>
+  implements AiModelMessageSchema
+{
   state: AiMessageState
   applied?: boolean
   thoughts: string
 
   /**
-   * The delta of the message, if any.
+   * The extracted delta from the message.
    */
-  delta?: AiDomainDelta
+  delta?: D
+
   /**
-   * The reasoning of the delta.
+   * The extracted reasoning from the message.
    * Format in markdown.
    */
   reasoning?: string
 
+  #reasoningEnded = false
+
   static createSchema(input: Partial<AiModelMessageSchema>): AiModelMessageSchema {
     const base = AiMessageBase.createBaseSchema(input)
     return {
@@ -241,6 +260,7 @@ export class AiModelMessage extends AiMessageBase<AiModelMessageSchema> implemen
     this.state = input.state || 'loading'
     this.applied = input.applied
     this.thoughts = input.thoughts || ''
+    this.processMessageSafe()
   }
 
   override toJSON(): AiModelMessageSchema {
@@ -268,6 +288,8 @@ export class AiModelMessage extends AiMessageBase<AiModelMessageSchema> implemen
 
   /**
    * Adds a text chunk to the message. Useful when streaming.
+   *
+   * Note, this function progressively detects the reasoning on each chunk.
    * @param text The text chunk to add.
    */
   addText(text?: string): void {
@@ -275,6 +297,15 @@ export class AiModelMessage extends AiMessageBase<AiModelMessageSchema> implemen
       return
     }
     this.text += text
+    if (this.#reasoningEnded) {
+      return
+    }
+    const before = this.reasoning
+    const after = detectReasoning(this.text)
+    if (after && after === before) {
+      this.#reasoningEnded = true
+    }
+    this.reasoning = after
   }
 
   /**
@@ -283,12 +314,13 @@ export class AiModelMessage extends AiMessageBase<AiModelMessageSchema> implemen
    * It sets the delta and reasoning fields, if found in the message.
    */
   processMessage(): void {
-    if (!this.text) {
+    const { text } = this
+    if (!text) {
       return
     }
-    const parsed = JSON.parse(this.text)
+    const parsed = JSON.parse(text)
     if (parsed.delta) {
-      this.delta = DataDomainDelta.normalize(parsed.delta)
+      this.delta = this.normalizeDelta(parsed.delta)
     }
     if (parsed.reasoning) {
       this.reasoning = parsed.reasoning
@@ -307,29 +339,44 @@ export class AiModelMessage extends AiMessageBase<AiModelMessageSchema> implemen
     }
   }
 
+  /**
+   * Normalizes the delta to the final shape required by the system.
+   *
+   * Probabilistic models can produce deltas that are not always what the author expected.
+   * For example, the DataDomain delta has `modifiedEntities` property that sometimes is
+   * populated multiple times by the same entity. This should be normalized to a single
+   * operation so that the UI can correctly render the changes, without an expensive lookup
+   * operations. The author of the message model should predict these situations and handle
+   * them accordingly.
+   *
+   * @param delta The delta to normalize.
+   * @returns The normalized delta.
+   */
+  abstract normalizeDelta(delta: D): D
+}
+
+/**
+ * A model message that contains a delta of type `AiDomainDelta`.
+ */
+export class AiModelDataDomainMessage extends AiModelMessage<AiDomainDelta> {
   /**
    * Creates an empty model message. Useful when initializing LLM flow.
    * @param session The session key.
    * @returns An empty model message.
    */
-  static createEmpty(session: string): AiModelMessage {
-    return new AiModelMessage({
+  static createEmpty(session: string): AiModelDataDomainMessage {
+    return new AiModelDataDomainMessage({
       session,
       state: 'loading',
     })
   }
+
+  override normalizeDelta(delta: AiDomainDelta): AiDomainDelta {
+    return DataDomainDelta.normalize(delta)
+  }
 }
 
 /**
  * A union type representing any valid chat message in the AI session history.
  */
-export type AiMessage = AiUserMessage | AiModelMessage
-
-export const AiMessageFactory = {
-  fromSchema(schema: Partial<AiMessageSchema>): AiMessage {
-    if (schema.role === 'model') {
-      return new AiModelMessage(schema as Partial<AiModelMessageSchema>)
-    }
-    return new AiUserMessage(schema as Partial<AiUserMessageSchema>)
-  },
-}
+export type AiMessage = AiUserMessage | AiModelMessage | AiModelDataDomainMessage

package/tests/unit/modeling/domain_property.spec.ts

@@ -771,6 +771,44 @@ test.group('DomainProperty.readBinding()', () => {
   })
 })
 
+test.group('DomainProperty.readWebBinding()', () => {
+  test('returns undefined if no web binding exists', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent')
+    const binding = property.readWebBinding()
+    assert.isUndefined(binding)
+  })
+
+  test('returns the web binding schema if it exists', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', {
+      bindings: [{ type: 'web', schema: { format: 'float' } }],
+    })
+    const webBindings = property.readWebBinding()
+    assert.deepEqual(webBindings, { format: 'float' })
+  })
+
+  test('returns undefined if the web binding exists but has no schema', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', {
+      // @ts-expect-error Testing undefined value
+      bindings: [{ type: 'web', schema: undefined }],
+    })
+    const webBindings = property.readWebBinding()
+    assert.isUndefined(webBindings)
+  })
+
+  test('returns undefined if the web binding exists but the schema is null', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', {
+      // @ts-expect-error Testing null value
+      bindings: [{ type: 'web', schema: null }],
+    })
+    const webBindings = property.readWebBinding()
+    assert.isNull(webBindings)
+  })
+})
+
 test.group('DomainProperty.toApiShape()', () => {
   test('returns an object', ({ assert }) => {
     const dataDomain = new DataDomain()

package/tests/unit/models/AiMessage.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@japa/runner'
-import { AiUserMessage, AiModelMessage, AiMessageFactory } from '../../../src/models/AiMessage.js'
+import { AiUserMessage, AiModelDataDomainMessage } from '../../../src/models/AiMessage.js'
 import { AiMessageKind } from '../../../src/models/kinds.js'
 
 test.group('AiMessage | AiUserMessage', () => {
@@ -72,13 +72,13 @@ test.group('AiMessage | AiUserMessage', () => {
   })
 })
 
-test.group('AiMessage | AiModelMessage', () => {
+test.group('AiMessage | AiModelDataDomainMessage', () => {
   test('createSchema validates required session', ({ assert }) => {
-    assert.throws(() => AiModelMessage.createSchema({}), 'Session is required to create an AiMessage.')
+    assert.throws(() => AiModelDataDomainMessage.createSchema({}), 'Session is required to create an AiMessage.')
   })
 
   test('createSchema builds valid model schema', ({ assert }) => {
-    const schema = AiModelMessage.createSchema({ session: 'session1', text: 'Response' })
+    const schema = AiModelDataDomainMessage.createSchema({ session: 'session1', text: 'Response' })
     assert.isString(schema.key)
     assert.isNotEmpty(schema.key)
     assert.equal(schema.kind, AiMessageKind)
@@ -93,7 +93,7 @@ test.group('AiMessage | AiModelMessage', () => {
   })
 
   test('constructor builds AiModelMessage instance', ({ assert }) => {
-    const msg = new AiModelMessage({
+    const msg = new AiModelDataDomainMessage({
       key: 'msg1',
       session: 'sess1',
       text: 'Model utterance',
@@ -117,7 +117,7 @@ test.group('AiMessage | AiModelMessage', () => {
   })
 
   test('toJSON correctly serializes an AiModelMessage', ({ assert }) => {
-    const msg = new AiModelMessage({
+    const msg = new AiModelDataDomainMessage({
       key: 'msg1',
       session: 'sess1',
       text: 'Message Data',
@@ -148,7 +148,7 @@ test.group('AiMessage | AiModelMessage', () => {
   })
 
   test('addThought safely appends thoughts', ({ assert }) => {
-    const msg = new AiModelMessage({ session: 's1' })
+    const msg = new AiModelDataDomainMessage({ session: 's1' })
     msg.addThought('Hello ')
     msg.addThought('World!')
     msg.addThought()
@@ -156,20 +156,40 @@ test.group('AiMessage | AiModelMessage', () => {
   })
 
   test('addText safely appends text', ({ assert }) => {
-    const msg = new AiModelMessage({ session: 's1' })
+    const msg = new AiModelDataDomainMessage({ session: 's1' })
     msg.addText('Hello ')
     msg.addText('World!')
     msg.addText()
     assert.equal(msg.text, 'Hello World!')
   })
 
+  test('addText progressively detects reasoning and stops when reasoning ends', ({ assert }) => {
+    const msg = new AiModelDataDomainMessage({ session: 's1' })
+
+    msg.addText('{"reason')
+    assert.isUndefined(msg.reasoning)
+
+    msg.addText('ing": "I ')
+    assert.equal(msg.reasoning, 'I ')
+
+    msg.addText('think')
+    assert.equal(msg.reasoning, 'I think')
+
+    msg.addText(' therefore "')
+    assert.equal(msg.reasoning, 'I think therefore ')
+
+    // This triggers after === before, freezing reasoning detection.
+    msg.addText(', "delta": {')
+    assert.equal(msg.reasoning, 'I think therefore ')
+  })
+
   test('processMessage throws on invalid JSON', ({ assert }) => {
-    const msg = new AiModelMessage({ session: 's1', text: 'NOT JSON' })
+    const msg = new AiModelDataDomainMessage({ session: 's1', text: 'NOT JSON' })
     assert.throws(() => msg.processMessage(), SyntaxError)
   })
 
   test('processMessage parses delta and reasoning', ({ assert }) => {
-    const msg = new AiModelMessage({
+    const msg = new AiModelDataDomainMessage({
       session: 's1',
       text: JSON.stringify({
         reasoning: 'I need to make models',
@@ -183,34 +203,16 @@ test.group('AiMessage | AiModelMessage', () => {
   })
 
   test('processMessageSafe swallows errors', ({ assert }) => {
-    const msg = new AiModelMessage({ session: 's1', text: 'NOT JSON' })
+    const msg = new AiModelDataDomainMessage({ session: 's1', text: 'NOT JSON' })
     msg.processMessageSafe() // should not throw
     assert.isUndefined(msg.delta)
     assert.isUndefined(msg.reasoning)
   })
 
   test('createEmpty generates loading stub', ({ assert }) => {
-    const msg = AiModelMessage.createEmpty('sess1')
+    const msg = AiModelDataDomainMessage.createEmpty('sess1')
     assert.equal(msg.session, 'sess1')
     assert.equal(msg.state, 'loading')
     assert.equal(msg.role, 'model')
   })
 })
-
-test.group('AiMessage | AiMessageFactory', () => {
-  test('fromSchema generates AiUserMessage when role=user', ({ assert }) => {
-    const schema = AiUserMessage.createSchema({ session: 'sess', text: 'Hello User' })
-    const msg = AiMessageFactory.fromSchema(schema)
-    assert.instanceOf(msg, AiUserMessage)
-    assert.equal(msg.role, 'user')
-    assert.equal(msg.text, 'Hello User')
-  })
-
-  test('fromSchema generates AiModelMessage when role=model', ({ assert }) => {
-    const schema = AiModelMessage.createSchema({ session: 'sess', text: 'Hello Model' })
-    const msg = AiMessageFactory.fromSchema(schema)
-    assert.instanceOf(msg, AiModelMessage)
-    assert.equal(msg.role, 'model')
-    assert.equal(msg.text, 'Hello Model')
-  })
-})