@api-client/core 0.19.5 → 0.19.7

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

@@ -42062,9 +42062,6 @@
 "@id": "#209"
 },
 {
-"@id": "#206"
-},
-{
 "@id": "#191"
 },
 {
@@ -42080,6 +42077,9 @@
 "@id": "#203"
 },
 {
+"@id": "#206"
+},
+{
 "@id": "#209"
 }
 ],
@@ -43436,7 +43436,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43457,7 +43457,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43499,7 +43499,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43520,7 +43520,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
+"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43541,7 +43541,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
+"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44756,32 +44756,32 @@
 {
 "@id": "#193/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#193",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#205",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#208/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#208",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#223/source-map/lexical/element_0",

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.5",
+  "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/src/modeling/ai/domain_response_schema.ts

@@ -9,6 +9,18 @@ const SemanticSchema = {
   required: ['id'],
 }
 
+const AssociationTarget = {
+  type: Type.OBJECT,
+  properties: {
+    key: { type: Type.STRING, description: 'The key of the target entity.' },
+    domain: {
+      type: Type.STRING,
+      description: 'The key of the target data domain. Only set when the target is in a different data domain.',
+    },
+  },
+  required: ['key'],
+}
+
 const SchemaDefaultValue = {
   type: Type.OBJECT,
   properties: {
@@ -27,28 +39,28 @@ const SchemaDefaultValue = {
 const PropertySchemaShape = {
   type: Type.OBJECT,
   properties: {
-    minimum: { type: Type.NUMBER },
-    maximum: { type: Type.NUMBER },
-    exclusiveMinimum: { type: Type.BOOLEAN },
-    exclusiveMaximum: { type: Type.BOOLEAN },
-    multipleOf: { type: Type.NUMBER },
-    enum: { type: Type.ARRAY, items: { type: Type.STRING } },
-    examples: { type: Type.ARRAY, items: { type: Type.STRING } },
-    defaultValue: SchemaDefaultValue,
-    pattern: { type: Type.STRING },
+    minimum: { type: Type.NUMBER, nullable: true },
+    maximum: { type: Type.NUMBER, nullable: true },
+    exclusiveMinimum: { type: Type.BOOLEAN, nullable: true },
+    exclusiveMaximum: { type: Type.BOOLEAN, nullable: true },
+    multipleOf: { type: Type.NUMBER, nullable: true },
+    enum: { type: Type.ARRAY, items: { type: Type.STRING }, nullable: true },
+    examples: { type: Type.ARRAY, items: { type: Type.STRING }, nullable: true },
+    defaultValue: { ...SchemaDefaultValue, nullable: true },
+    pattern: { type: Type.STRING, nullable: true },
   },
 }
 
 const PropertyConstraintsSchema = {
   type: Type.OBJECT,
   properties: {
-    required: { type: Type.BOOLEAN },
-    unique: { type: Type.BOOLEAN },
-    index: { type: Type.BOOLEAN },
-    primary: { type: Type.BOOLEAN },
-    multiple: { type: Type.BOOLEAN },
-    readOnly: { type: Type.BOOLEAN },
-    writeOnly: { type: Type.BOOLEAN },
+    required: { type: Type.BOOLEAN, nullable: true },
+    unique: { type: Type.BOOLEAN, nullable: true },
+    index: { type: Type.BOOLEAN, nullable: true },
+    primary: { type: Type.BOOLEAN, nullable: true },
+    multiple: { type: Type.BOOLEAN, nullable: true },
+    readOnly: { type: Type.BOOLEAN, nullable: true },
+    writeOnly: { type: Type.BOOLEAN, nullable: true },
   },
 }
 
@@ -74,7 +86,7 @@ const PropertySchema = {
       items: SemanticSchema,
       description: "List of semantics applied to this property. Note: ONLY use semantics with scope='property'.",
     },
-    tags: { type: Type.ARRAY, items: { type: Type.STRING } },
+    tags: { type: Type.ARRAY, items: { type: Type.STRING }, nullable: true },
   },
   required: ['key', 'name', 'type', 'displayName', 'description'],
 }
@@ -97,7 +109,7 @@ const AssociationSchema = {
     name: { type: Type.STRING },
     displayName: { type: Type.STRING },
     description: { type: Type.STRING },
-    targets: { type: Type.ARRAY, items: { type: Type.STRING }, description: 'List of target entity keys' },
+    targets: { type: Type.ARRAY, items: AssociationTarget },
     required: { type: Type.BOOLEAN },
     multiple: {
       type: Type.BOOLEAN,
@@ -150,6 +162,9 @@ const EntitySchema = {
   required: ['key', 'name', 'modelKey', 'displayName', 'description'],
 }
 
+/**
+ * Allows modifying a property (not adding)
+ */
 const PropertyDeltaSchema = {
   type: Type.OBJECT,
   properties: {
@@ -161,9 +176,9 @@ const PropertyDeltaSchema = {
       type: Type.STRING,
       description: 'Enum: string, number, boolean, date, datetime, time, binary',
     },
-    constraints: PropertyConstraintsSchema,
-    deprecated: { type: Type.BOOLEAN },
-    schema: PropertySchemaShape,
+    constraints: { ...PropertyConstraintsSchema, nullable: true },
+    deprecated: { type: Type.BOOLEAN, nullable: true },
+    schema: { ...PropertySchemaShape, nullable: true },
     addedSemantics: {
       type: Type.ARRAY,
       items: SemanticSchema,
@@ -182,13 +197,14 @@ const AssociationDeltaSchema = {
     name: { type: Type.STRING },
     displayName: { type: Type.STRING },
     description: { type: Type.STRING },
-    targets: { type: Type.ARRAY, items: { type: Type.STRING } },
-    required: { type: Type.BOOLEAN },
+    targets: { type: Type.ARRAY, items: AssociationTarget },
+    required: { type: Type.BOOLEAN, nullable: true },
     multiple: {
       type: Type.BOOLEAN,
+      nullable: true,
       description: 'Whether the association can have multiple targets (like User has multiple addresses)',
     },
-    onDelete: { type: Type.STRING, description: 'Enum: restrict, cascade, setNull, doNothing' },
+    onDelete: { type: Type.STRING, nullable: true, description: 'Enum: restrict, cascade, setNull, doNothing' },
     addedSemantics: {
       type: Type.ARRAY,
       items: SemanticSchema,
@@ -256,7 +272,7 @@ export const DOMAIN_SCHEMA = {
               name: { type: Type.STRING },
               displayName: { type: Type.STRING },
               description: { type: Type.STRING },
-              tags: { type: Type.ARRAY, items: { type: Type.STRING } },
+              tags: { type: Type.ARRAY, items: { type: Type.STRING }, nullable: true },
               addedSemantics: {
                 type: Type.ARRAY,
                 items: SemanticSchema,

package/src/modeling/ai/prompts/domain_system.ts

@@ -19,13 +19,12 @@ The \`reasoning\` string in your JSON output is the presentation layer. It will
 - **Keep it Conversational:** Use simple markdown (like bullet points) to provide a friendly, easily scannable summary of what you built for them.
 - **Proactive Next Steps:** Always conclude your summary with a single, highly relevant question asking the user what they want to do next. Base this on what you just built or what might be missing.
 
-# REFERENTIAL INTEGRITY (NO PHANTOM KEYS)
-You must absolutely guarantee that every key listed in an association's \`targets\` array actually exists. 
-- **The Target Rule:** A target key is ONLY valid if it meets one of two conditions:
-  1. It is the exact \`key\` of an entity you are actively creating in the \`addedEntities\` array in this exact response.
-  2. It is the exact \`key\` of an entity explicitly provided to you in the Current Domain context.
-- **ANTI-PATTERN:** Inventing a logical target key (e.g., \`resource_entity\`, \`user_id\`) that does not exist in the context or your current payload. 
-- **Missing Targets:** If the user asks you to link to an entity that does not exist, you MUST create that missing entity in \`addedEntities\` first so you have a valid key to target.
+# REFERENTIAL INTEGRITY (STRICT KEYS ONLY)
+You must absolutely guarantee that you never hallucinate or invent a \`key\` for an existing object. 
+- **Modifications & Deletions:** When adding objects to \`modifiedModels\`, \`modifiedEntities\`, \`deletedModelKeys\`, or \`deletedEntityKeys\`, the \`key\` you use MUST be an exact match to an existing \`nanoid\` key provided to you in the Current Domain Context.
+- **Association Targets:** A target key in an association is ONLY valid if it exists in the Current Domain Context, or if you are actively creating it in \`addedEntities\`.
+- **ANTI-PATTERN:** Inventing a placeholder key to modify an object that you don't know the exact nanoid for.
+- **Handling Missing Objects:** If the user asks you to modify an entity but it does not exist in the provided context, you MUST assume it is a brand new entity. Define its complete schema inside \`addedEntities\` instead of trying to modify a phantom key.
 
 # CREATION & DEPENDENCY LOGIC (THE TWO-PASS RULE)
 When creating multiple new entities that relate to one another, you must respect referential integrity. You cannot reference an entity in an association before it exists.

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()