@api-client/core 0.11.10 → 0.12.0

package/src/modeling/{DataAssociation.ts → legacy/DataAssociation.ts}

@@ -1,17 +1,18 @@
 import { Json } from '@api-client/json'
-import { AmfShapeGenerator } from '../amf/AmfShapeGenerator.js'
-import { IApiAssociationShape, IApiPropertyShape } from '../amf/definitions/Shapes.js'
-import v4 from '../lib/uuid.js'
-import { IThing, Thing } from '../models/Thing.js'
+import { AmfShapeGenerator } from '../../amf/AmfShapeGenerator.js'
+import { IApiAssociationShape, IApiPropertyShape } from '../../amf/definitions/Shapes.js'
+import v4 from '../../lib/uuid.js'
+import { IThing, Thing } from '../../models/Thing.js'
 import { DataEntity, IDataEntity } from './DataEntity.js'
 import { DataNamespace } from './DataNamespace.js'
-import { type FieldValidationMessage, ValidationError } from '../exceptions/validation_error.js'
-import { DataAssociationKind } from '../models/kinds.js'
-import type { AssociationBinding, AssociationBindings, AssociationWebBindings } from './Bindings.js'
-import { DataAttributeAttributes, type DataAttributeAttribute } from './DataFormat.js'
+import { type FieldValidationMessage, ValidationError } from '../../exceptions/validation_error.js'
+import { DataAssociationKind } from '../../models/kinds.js'
+import type { AssociationBinding, AssociationBindings, AssociationWebBindings } from '../Bindings.js'
+import { DataAttributeAttributes, type DataAttributeAttribute } from '../DataFormat.js'
 
 /**
  * Describes association target of an entity
+ * @deprecated
  */
 export interface AssociationTarget {
   /**
@@ -36,6 +37,7 @@ export interface AssociationTarget {
  *
  * Depending on the schema translation an association can be embedded as a sub-object in the generated schema
  * or can be references via a primary key.
+ * @deprecated
  */
 export interface IDataAssociation {
   kind: typeof DataAssociationKind
@@ -115,6 +117,7 @@ export interface IDataAssociation {
  *
  * - **Hidden**:
  *  - `hidden`: (boolean) Defines if this association is a part of the schema or not.
+ * @deprecated
  */
 export class DataAssociation {
   kind = DataAssociationKind
@@ -283,6 +286,7 @@ export class DataAssociation {
    *
    * @param input The object to validate.
    * @throws {ValidationError} When the validation fails.
+   * @deprecated
    */
   static validate(input: unknown): void {
     const typed = input as IDataAssociation
@@ -496,6 +500,7 @@ export class DataAssociation {
    * Checks whether the passed value is one of the supported data property attributes.
    * @param value The value to test
    * @returns True when the passed value is one of the supported data property attributes.
+   * @deprecated
    */
   static isValidAttribute(value: unknown): value is DataAttributeAttribute {
     if (typeof value !== 'string') {

package/src/modeling/{DataEntity.ts → legacy/DataEntity.ts}

@@ -1,23 +1,26 @@
-import { IThing, Thing } from '../models/Thing.js'
-import v4 from '../lib/uuid.js'
+import { IThing, Thing } from '../../models/Thing.js'
+import v4 from '../../lib/uuid.js'
 import { DataNamespace } from './DataNamespace.js'
 import { DataProperty } from './DataProperty.js'
-import { type DataPropertyType } from './DataFormat.js'
+import { type DataPropertyType } from '../DataFormat.js'
 import { DataAssociation } from './DataAssociation.js'
-import { FileBreadcrumb } from '../models/store/File.js'
-import { DataEntityKind } from '../models/kinds.js'
+import { FileBreadcrumb } from '../../models/store/File.js'
+import { DataEntityKind } from '../../models/kinds.js'
 import { DataModel } from './DataModel.js'
-import { IApiNodeShape, IShapeUnion } from '../amf/definitions/Shapes.js'
-import { AmfShapeGenerator } from '../amf/AmfShapeGenerator.js'
-import { ApiSchemaGenerator } from '../amf/ApiSchemaGenerator.js'
-import { IShapeRenderOptions } from '../amf/shape/ShapeBase.js'
-import { RemovePropertyException } from '../exceptions/remove_property_exception.js'
-import { RemoveAssociationException } from '../exceptions/remove_association_exception.js'
-import { ValidationError, type FieldValidationMessage } from '../exceptions/validation_error.js'
-import { RemoveEntityException } from '../exceptions/remove_entity_exception.js'
-import { ForeignAssociationException } from '../exceptions/foreign_association_exception.js'
-import type { DataDomainRemoveOptions } from './types.js'
+import { IApiNodeShape, IShapeUnion } from '../../amf/definitions/Shapes.js'
+import { AmfShapeGenerator } from '../../amf/AmfShapeGenerator.js'
+import { ApiSchemaGenerator } from '../../amf/ApiSchemaGenerator.js'
+import { IShapeRenderOptions } from '../../amf/shape/ShapeBase.js'
+import { RemovePropertyException } from '../../exceptions/remove_property_exception.js'
+import { RemoveAssociationException } from '../../exceptions/remove_association_exception.js'
+import { ValidationError, type FieldValidationMessage } from '../../exceptions/validation_error.js'
+import { RemoveEntityException } from '../../exceptions/remove_entity_exception.js'
+import { ForeignAssociationException } from '../../exceptions/foreign_association_exception.js'
+import type { DataDomainRemoveOptions } from '../types.js'
 
+/**
+ * @deprecated
+ */
 interface OrderedItem {
   /**
    * The type of the ordered item.
@@ -32,6 +35,7 @@ interface OrderedItem {
 /**
  * Data entity is the smallest description of a data in the system
  * It contains properties and associations. At least one entity describe a data model.
+ * @deprecated
  */
 export interface IDataEntity {
   kind: typeof DataEntityKind
@@ -102,6 +106,7 @@ export interface IDataEntity {
 /**
  * Data entity is the smallest description of a data in the system
  * It contains properties and associations. At least one entity describe a data model.
+ * @deprecated
  */
 export class DataEntity {
   kind = DataEntityKind
@@ -603,9 +608,9 @@ export class DataEntity {
           item.removeAssociation(association.key)
         })
       } else {
-        const entitiesNames = result.map(({ entity }) => entity.info.renderLabel || entity.key)
+        const entitiesNames = result.map(({ entity }) => entity.info.getLabel(entity.key))
         throw new RemoveEntityException(
-          `Cannot remove entity ${this.info.renderLabel} because it is used as a target in associations in entities: ${entitiesNames.join(', ')}.`
+          `Cannot remove entity ${this.info.getLabel()} because it is used as a target in associations in entities: ${entitiesNames.join(', ')}.`
         )
       }
     }
@@ -617,9 +622,9 @@ export class DataEntity {
           child.parents = child.parents.filter((i) => i !== this.key)
         })
       } else {
-        const childrenNames = children.map((i) => i.info.renderLabel || i.key)
+        const childrenNames = children.map((i) => i.info.getLabel(i.key))
         throw new RemoveEntityException(
-          `Cannot remove entity ${this.info.renderLabel} because it is a parent for the following entities: ${childrenNames.join(', ')}.`
+          `Cannot remove entity ${this.info.getLabel()} because it is a parent for the following entities: ${childrenNames.join(', ')}.`
         )
       }
     }
@@ -868,7 +873,7 @@ export class DataEntity {
     const result: FileBreadcrumb[] = []
     result.push({
       key: this.key,
-      name: this.info.name || 'Unnamed entity',
+      name: this.info.getLabel('Unnamed entity'),
       kind: DataEntityKind,
     })
     const model = this.getParentInstance()
@@ -876,21 +881,21 @@ export class DataEntity {
       result.push({
         key: model.key,
         kind: model.kind,
-        name: model.info.name || 'Unnamed data model',
+        name: model.info.getLabel('Unnamed model'),
       })
       let parent = model.getParentInstance()
       while (parent && parent !== this.root) {
         result.push({
           key: parent.key,
           kind: parent.kind,
-          name: parent.info.name || 'Unnamed namespace',
+          name: parent.info.getLabel('Unnamed namespace'),
         })
         parent = parent.getParentInstance()
       }
     }
     result.push({
       key: this.root.key,
-      name: this.root.info.name || 'Unnamed namespace',
+      name: this.root.info.getLabel('Unnamed data domain'),
       kind: this.root.kind,
     })
     return result.reverse()

package/src/modeling/{DataEntityBuilder.ts → legacy/DataEntityBuilder.ts}

@@ -1,8 +1,8 @@
 import { DataEntity } from './DataEntity.js'
 import { DataNamespace } from './DataNamespace.js'
-import { type DataPropertyType } from './DataFormat.js'
-import { type IThing, Thing } from '../models/Thing.js'
-import v4 from '../lib/uuid.js'
+import { type DataPropertyType } from '../DataFormat.js'
+import { type IThing, Thing } from '../../models/Thing.js'
+import v4 from '../../lib/uuid.js'
 
 /**
  * A fluent builder for constructing `DataEntity` instances.
@@ -43,6 +43,7 @@ import v4 from '../lib/uuid.js'
  *   .addParent(baseEntity.key)
  *   .build()
  * ```
+ * @deprecated
  */
 export class DataEntityBuilder {
   private entity: DataEntity