@api-client/core 0.19.6 → 0.19.7

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.7",
   "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/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()