@api-client/core 0.14.1 → 0.14.2

package/data/models/expanded-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/flattened-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/multiple-servers.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-3-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-date.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-types.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-unions.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/petstore.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/raml-date.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/recursive.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/schema-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },
@@ -12732,7 +12732,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -26128,6 +26128,11 @@
 "@id": "#331/source-map/inherited-shapes/element_0"
 }
 ],
+"sourcemaps:default-node": [
+{
+"@id": "#331/source-map/default-node/element_0"
+}
+],
 "sourcemaps:synthesized-field": [
 {
 "@id": "#331/source-map/synthesized-field/element_0"
@@ -26226,6 +26231,11 @@
 "@id": "#334/source-map/inherited-shapes/element_0"
 }
 ],
+"sourcemaps:default-node": [
+{
+"@id": "#334/source-map/default-node/element_0"
+}
+],
 "sourcemaps:synthesized-field": [
 {
 "@id": "#334/source-map/synthesized-field/element_0"
@@ -28525,6 +28535,11 @@
 "@id": "#19/source-map/inherited-shapes/element_0"
 }
 ],
+"sourcemaps:default-node": [
+{
+"@id": "#19/source-map/default-node/element_0"
+}
+],
 "sourcemaps:synthesized-field": [
 {
 "@id": "#19/source-map/synthesized-field/element_0"
@@ -28639,6 +28654,11 @@
 "@id": "#25/source-map/inherited-shapes/element_0"
 }
 ],
+"sourcemaps:default-node": [
+{
+"@id": "#25/source-map/default-node/element_0"
+}
+],
 "sourcemaps:synthesized-field": [
 {
 "@id": "#25/source-map/synthesized-field/element_0"
@@ -28719,6 +28739,11 @@
 "@id": "#28/source-map/inherited-shapes/element_0"
 }
 ],
+"sourcemaps:default-node": [
+{
+"@id": "#28/source-map/default-node/element_0"
+}
+],
 "sourcemaps:synthesized-field": [
 {
 "@id": "#28/source-map/synthesized-field/element_0"
@@ -30399,6 +30424,11 @@
 "sourcemaps:value": "amf://id#11"
 },
 {
+"@id": "#331/source-map/default-node/element_0",
+"sourcemaps:element": "amf://id#331",
+"sourcemaps:value": ""
+},
+{
 "@id": "#331/source-map/synthesized-field/element_0",
 "sourcemaps:element": "shacl:datatype",
 "sourcemaps:value": "true"
@@ -30472,6 +30502,11 @@
 "sourcemaps:value": "amf://id#13"
 },
 {
+"@id": "#334/source-map/default-node/element_0",
+"sourcemaps:element": "amf://id#334",
+"sourcemaps:value": ""
+},
+{
 "@id": "#334/source-map/synthesized-field/element_0",
 "sourcemaps:element": "shacl:datatype",
 "sourcemaps:value": "true"
@@ -32263,6 +32298,11 @@
 "sourcemaps:value": "amf://id#13"
 },
 {
+"@id": "#19/source-map/default-node/element_0",
+"sourcemaps:element": "amf://id#19",
+"sourcemaps:value": ""
+},
+{
 "@id": "#19/source-map/synthesized-field/element_0",
 "sourcemaps:element": "shacl:datatype",
 "sourcemaps:value": "true"
@@ -32327,6 +32367,11 @@
 "sourcemaps:value": "amf://id#11"
 },
 {
+"@id": "#25/source-map/default-node/element_0",
+"sourcemaps:element": "amf://id#25",
+"sourcemaps:value": ""
+},
+{
 "@id": "#25/source-map/synthesized-field/element_0",
 "sourcemaps:element": "shacl:datatype",
 "sourcemaps:value": "true"
@@ -32381,6 +32426,11 @@
 "sourcemaps:value": "amf://id#13"
 },
 {
+"@id": "#28/source-map/default-node/element_0",
+"sourcemaps:element": "amf://id#28",
+"sourcemaps:value": ""
+},
+{
 "@id": "#28/source-map/synthesized-field/element_0",
 "sourcemaps:element": "shacl:datatype",
 "sourcemaps:value": "true"
@@ -33397,6 +33447,11 @@
 "@id": "#373/source-map/synthesized-field/element_0"
 }
 ],
+"sourcemaps:default-node": [
+{
+"@id": "#373/source-map/default-node/element_0"
+}
+],
 "sourcemaps:lexical": [
 {
 "@id": "#373/source-map/lexical/element_1"
@@ -34765,6 +34820,11 @@
 "sourcemaps:value": "true"
 },
 {
+"@id": "#373/source-map/default-node/element_0",
+"sourcemaps:element": "amf://id#373",
+"sourcemaps:value": ""
+},
+{
 "@id": "#373/source-map/lexical/element_1",
 "sourcemaps:element": "amf://id#373",
 "sourcemaps:value": "[(486,10)-(490,0)]"

package/data/models/secured-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },
@@ -17110,7 +17110,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17156,7 +17156,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17192,7 +17192,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17246,7 +17246,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17292,7 +17292,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17328,7 +17328,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17369,7 +17369,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17410,7 +17410,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17446,7 +17446,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17487,7 +17487,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17528,7 +17528,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17564,7 +17564,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17600,7 +17600,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17636,7 +17636,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -17669,7 +17669,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {

package/data/models/tracked-to-linked.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },
@@ -1777,7 +1777,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -1805,7 +1805,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -1833,7 +1833,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.10.0",
+"apiContract:modelVersion": "3.11.0",
 "doc:sourceSpec": "RAML 1.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.14.1",
+  "version": "0.14.2",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -111,7 +111,7 @@
     "@types/express-ntlm": "^2.3.3",
     "@types/jsdom": "^21.1.7",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.13.4",
+    "@types/node": "^24.0.1",
     "@types/sinon": "^17.0.1",
     "@web/dev-server": "^0.4.6",
     "@web/dev-server-rollup": "^0.6.4",

package/src/modeling/DomainAssociation.ts

@@ -12,6 +12,26 @@ import type { AssociationTarget, DomainGraphEdge } from './types.js'
 import { ShapeGenerator } from './amf/ShapeGenerator.js'
 import { DataSemantics, isAssociationSemantic, type SemanticType, type AppliedDataSemantic } from './Semantics.js'
 
+/**
+ * Defines the behavior when a parent entity in an association is deleted.
+ *
+ * - `restrict`: Prevents the deletion of a parent entity if it has any associated child entities.
+ *               The generated API should return a clear and specific error message (e.g., 409 Conflict).
+ *   - _Example_: Do not allow a Department to be deleted if it still has Employees.
+ * - `cascade`: Automatically deletes all associated child entities when the parent entity is deleted.
+ *   - _Example_: Deleting a User will also delete all their associated Posts and Comments.
+ * - `setNull`: Sets the foreign key of the associated child entities to NULL. This is only valid if the
+ *   association property on the child entity is nullable.
+ *   - _Example_: When a `Project` is deleted, the `project_id` on associated `Tasks` is set to NULL,
+ *   making them unassigned but not deleting them.
+ * - `doNothing`: No action is taken on the associated child entities when the parent entity is deleted.
+ *   - _Example_: Deleting a `Category` does not affect associated `Products`, which remain in the database
+ *               but may become orphaned.
+ *               This is useful when the association is optional or when child entities should not be deleted
+ *               or modified upon the deletion of a parent entity.
+ */
+export type OnDeleteRule = 'restrict' | 'cascade' | 'setNull' | 'doNothing'
+
 export interface DomainAssociationSchema extends DomainElementSchema {
   kind: typeof DomainAssociationKind
   /**
@@ -54,6 +74,14 @@ export interface DomainAssociationSchema extends DomainElementSchema {
    * describe the association in more detail.
    */
   semantics?: AppliedDataSemantic[]
+  /**
+   * Defines the behavior when a parent entity in an association is deleted.
+   */
+  onDelete?: OnDeleteRule
+  /**
+   * Whether the association is read-only.
+   */
+  readOnly?: boolean
 }
 
 /**
@@ -153,6 +181,16 @@ export class DomainAssociation extends DomainElement {
    */
   @observed({ deep: true }) accessor semantics: AppliedDataSemantic[] = []
 
+  /**
+   * Defines the behavior when a parent entity in an association is deleted.
+   */
+  @observed() accessor onDelete: OnDeleteRule | undefined
+
+  /**
+   * Whether the association is read-only.
+   */
+  @observed() accessor readOnly: boolean | undefined
+
   /**
    * Creates a full data association schema with defaults.
    *
@@ -170,6 +208,12 @@ export class DomainAssociation extends DomainElement {
     if (Array.isArray(semantics)) {
       result.semantics = [...semantics]
     }
+    if (input.onDelete) {
+      result.onDelete = input.onDelete
+    }
+    if (typeof input.readOnly === 'boolean') {
+      result.readOnly = input.readOnly
+    }
     if (input.schema) {
       result.schema = structuredClone(input.schema)
     }
@@ -227,6 +271,12 @@ export class DomainAssociation extends DomainElement {
     } else {
       this.semantics = []
     }
+    if (init.onDelete) {
+      this.onDelete = init.onDelete
+    }
+    if (typeof init.readOnly === 'boolean') {
+      this.readOnly = init.readOnly
+    }
   }
 
   /**
@@ -258,6 +308,12 @@ export class DomainAssociation extends DomainElement {
     if (Array.isArray(this.semantics) && this.semantics.length) {
       result.semantics = toRaw(this, this.semantics)?.map((i) => structuredClone(i))
     }
+    if (this.onDelete) {
+      result.onDelete = this.onDelete
+    }
+    if (typeof this.readOnly === 'boolean' && this.readOnly) {
+      result.readOnly = this.readOnly
+    }
     return result
   }
 

package/src/modeling/Semantics.ts

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 import type { DomainPropertyType } from './DataFormat.js'
 
 /**
@@ -17,6 +18,14 @@ export enum SemanticType {
   DeletedTimestamp = 'https://apinow.app/semantics/properties/#DeletedTimestamp',
   DeletedFlag = 'https://apinow.app/semantics/properties/#DeletedFlag',
   PublicUniqueName = 'https://apinow.app/semantics/properties/#PublicUniqueName',
+  /**
+   * Designates a Data Property as the `role` of a user within the system.
+   * This is used to define the user's permissions and access levels.
+   * For example, a user with the role of "admin" would have elevated permissions
+   * compared to a user with the role of "guest".
+   * Roles are defined on the entity as enums, or as a string property with a controlled vocabulary.
+   */
+  UserRole = 'https://apinow.app/semantics/entities/#UserRole',
   // Association-Level Semantics
   ResourceOwnerIdentifier = 'https://apinow.app/semantics/associations/#ResourceOwnerIdentifier',
 }
@@ -159,6 +168,14 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'A user-friendly, unique public identifier for a resource, often used in URLs.',
     applicableDataTypes: ['string'],
   },
+  [SemanticType.UserRole]: {
+    id: SemanticType.UserRole,
+    displayName: 'User Role Field',
+    scope: SemanticScope.Property,
+    description:
+      'A text field that is recognized by the runtime as a role of a user in the API. Used with the role-based authorization strategy.',
+    applicableDataTypes: ['string'],
+  },
 }
 
 /**