@api-client/core 0.18.58 → 0.18.59

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"
 }
 ],
@@ -42810,16 +42810,16 @@
 "@id": "#219"
 },
 {
-"@id": "#219"
+"@id": "#210"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#213"
+"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -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": [
 {
@@ -44232,7 +44232,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 : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44253,7 +44253,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.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": [
 {
@@ -44274,7 +44274,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": "-\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": [
 {
@@ -44295,7 +44295,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": "type: \"GENERAL\"\nvalue: \"www.company.be\"\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",
@@ -45116,22 +45116,22 @@
 {
 "@id": "#212/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#212",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,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.18.58",
+  "version": "0.18.59",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/decorators/observed.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const reactiveSymbol = Symbol('reactive')
 const proxySymbol = Symbol('proxy')
+const rawSymbol = Symbol('raw')
 
 interface DomainInstance {
   domain?: { notifyChange(): void }
@@ -38,6 +39,13 @@ export interface ObserveConfig {
  * @returns The not proxied object or undefined
  */
 export function toRaw<T extends object = object>(source: object, target: T): T | undefined {
+  if (target && (target as any)[rawSymbol]) {
+    let raw = (target as any)[rawSymbol]
+    while (raw && (raw as any)[rawSymbol]) {
+      raw = (raw as any)[rawSymbol]
+    }
+    return raw as T
+  }
   const proxies = Reflect.get(source, proxySymbol) as Map<object, object>
   if (!proxies) {
     return undefined
@@ -101,7 +109,7 @@ export function observed(config: ObserveConfig = {}): PropertyDecorator {
       }
 
       if (proxies.has(obj)) {
-        return obj
+        return proxies.get(obj)
       }
 
       // eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -109,6 +117,12 @@ export function observed(config: ObserveConfig = {}): PropertyDecorator {
 
       const proxy = new Proxy(obj, {
         get(target, prop) {
+          if (prop === proxySymbol) {
+            return Reflect.get(target, prop)
+          }
+          if (prop === rawSymbol) {
+            return target
+          }
           const value = Reflect.get(target, prop)
           return createDeepProxy.bind(targetObject)(value, notifyChange)
         },

package/src/modeling/actions/CreateAction.ts

@@ -27,4 +27,12 @@ export class CreateAction extends Action implements CreateActionSchema {
       kind: 'create',
     }
   }
+
+  static isCreateAction(action: Action): action is CreateAction {
+    return action.kind === 'create'
+  }
+
+  static isCreateActionSchema(schema: ActionSchema): schema is CreateActionSchema {
+    return schema.kind === 'create'
+  }
 }

package/src/modeling/actions/DeleteAction.ts

@@ -48,4 +48,12 @@ export class DeleteAction extends Action implements DeleteActionSchema {
       retentionPeriod: this.retentionPeriod,
     }
   }
+
+  static isDeleteAction(action: Action): action is DeleteAction {
+    return action.kind === 'delete'
+  }
+
+  static isDeleteActionSchema(schema: ActionSchema): schema is DeleteActionSchema {
+    return schema.kind === 'delete'
+  }
 }

package/src/modeling/actions/ListAction.ts

@@ -32,8 +32,8 @@ export interface ListActionSchema extends ActionSchema {
 export class ListAction extends Action implements ListActionSchema {
   @observed() override accessor kind: 'list'
   @observed({ deep: true }) accessor pagination: PaginationStrategy
-  @observed({ deep: true }) accessor filterableFields: string[]
-  @observed({ deep: true }) accessor sortableFields: string[]
+  @observed({ deep: true }) accessor filterableFields: string[] = []
+  @observed({ deep: true }) accessor sortableFields: string[] = []
 
   constructor(state: Partial<ListActionSchema> = {}) {
     super(state)
@@ -55,4 +55,12 @@ export class ListAction extends Action implements ListActionSchema {
       sortableFields: structuredClone(toRaw(this, this.sortableFields)) as string[],
     }
   }
+
+  static isListAction(action: Action): action is ListAction {
+    return action.kind === 'list'
+  }
+
+  static isListActionSchema(schema: ActionSchema): schema is ListActionSchema {
+    return schema.kind === 'list'
+  }
 }

package/src/modeling/actions/ReadAction.ts

@@ -29,4 +29,12 @@ export class ReadAction extends Action implements ReadActionSchema {
       kind: 'read',
     }
   }
+
+  static isReadAction(action: Action): action is ReadAction {
+    return action.kind === 'read'
+  }
+
+  static isReadActionSchema(schema: ActionSchema): schema is ReadActionSchema {
+    return schema.kind === 'read'
+  }
 }

package/src/modeling/actions/SearchAction.ts

@@ -35,4 +35,12 @@ export class SearchAction extends Action implements SearchActionSchema {
       fields: structuredClone(toRaw(this, this.fields)) as string[],
     }
   }
+
+  static isSearchActionSchema(schema: ActionSchema): schema is SearchActionSchema {
+    return schema.kind === 'search'
+  }
+
+  static isSearchAction(action: Action): action is SearchAction {
+    return action.kind === 'search'
+  }
 }

package/src/modeling/actions/UpdateAction.ts

@@ -38,4 +38,12 @@ export class UpdateAction extends Action implements UpdateActionSchema {
       allowedMethods: structuredClone(toRaw(this, this.allowedMethods)) as ('PUT' | 'PATCH')[],
     }
   }
+
+  static isUpdateAction(action: Action): action is UpdateAction {
+    return action.kind === 'update'
+  }
+
+  static isUpdateActionSchema(schema: ActionSchema): schema is UpdateActionSchema {
+    return schema.kind === 'update'
+  }
 }

package/tests/unit/decorators/observed.spec.ts

@@ -446,6 +446,48 @@ test.group('toRaw function', () => {
     const raw = toRaw(instance, obj)
     assert.equal(raw, undefined)
   }).tags(['@decorators', '@toRaw', '@core', '@unit', '@fast'])
+
+  test('should handle nested deep proxies (regression test)', ({ assert }) => {
+    const mockDomain = {
+      notifyChange() {},
+    }
+
+    class Child {
+      name = 'child'
+    }
+
+    class Parent {
+      domain = mockDomain
+      @observed({ deep: true }) accessor child: Child
+
+      constructor() {
+        this.child = new Child()
+      }
+    }
+
+    class GrandParent {
+      domain = mockDomain
+      @observed({ deep: true }) accessor parent: Parent
+
+      constructor() {
+        this.parent = new Parent()
+      }
+    }
+
+    const gp = new GrandParent()
+    // gp.parent is a proxy
+    // gp.parent.child is a nested proxy (proxy of a proxy)
+    const childProxy = gp.parent.child
+
+    const raw = toRaw(gp.parent, childProxy)
+
+    assert.isDefined(raw)
+    assert.equal(raw?.name, 'child')
+
+    // Should be able to structure clone it (proving it's a clean object without proxy wrappers)
+    const cloned = structuredClone(raw)
+    assert.deepEqual(cloned, { name: 'child' })
+  }).tags(['@decorators', '@toRaw', '@core', '@unit', '@regression'])
 })
 
 test.group('edge cases and error conditions', () => {