@api-client/core 0.14.0 → 0.14.2

package/tests/unit/modeling/domain_entity_example_generator_xml.spec.ts

@@ -7,7 +7,7 @@ const dateRe = /^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
 const timeRe = /^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/
 const mime = 'application/xml'
 
-test.group('XML DataEntity Generator: string', (group) => {
+test.group('XML DomainEntity Generator: string', (group) => {
   let e1: DomainEntity
 
   group.each.setup(() => {
@@ -177,7 +177,7 @@ test.group('XML DataEntity Generator: string', (group) => {
   })
 })
 
-test.group('XML DataEntity Generator: number', (group) => {
+test.group('XML DomainEntity Generator: number', (group) => {
   let e1: DomainEntity
 
   group.each.setup(() => {
@@ -416,7 +416,7 @@ test.group('XML DataEntity Generator: number', (group) => {
   })
 })
 
-test.group('XML DataEntity Generator: int64 format', (group) => {
+test.group('XML DomainEntity Generator: int64 format', (group) => {
   let e1: DomainEntity
   let p1: DomainProperty
 
@@ -641,7 +641,7 @@ test.group('XML DataEntity Generator: int64 format', (group) => {
   })
 })
 
-test.group('XML DataEntity Generator: date', (group) => {
+test.group('XML DomainEntity Generator: date', (group) => {
   let e1: DomainEntity
 
   group.each.setup(() => {
@@ -768,7 +768,7 @@ test.group('XML DataEntity Generator: date', (group) => {
   })
 })
 
-test.group('XML DataEntity Generator: datetime', (group) => {
+test.group('XML DomainEntity Generator: datetime', (group) => {
   let e1: DomainEntity
 
   group.each.setup(() => {
@@ -877,7 +877,7 @@ test.group('XML DataEntity Generator: datetime', (group) => {
   })
 })
 
-test.group('XML DataEntity Generator: time', (group) => {
+test.group('XML DomainEntity Generator: time', (group) => {
   let e1: DomainEntity
 
   group.each.setup(() => {
@@ -1004,7 +1004,7 @@ test.group('XML DataEntity Generator: time', (group) => {
   })
 })
 
-test.group('XML DataEntity Generator: boolean', (group) => {
+test.group('XML DomainEntity Generator: boolean', (group) => {
   let e1: DomainEntity
 
   group.each.setup(() => {
@@ -1049,7 +1049,7 @@ test.group('XML DataEntity Generator: boolean', (group) => {
   })
 })
 
-// test.group('XML DataEntity Generator: nil', (group) => {
+// test.group('XML DomainEntity Generator: nil', (group) => {
 //   let e1: DomainEntity
 
 //   group.each.setup(() => {
@@ -1094,7 +1094,7 @@ test.group('XML DataEntity Generator: boolean', (group) => {
 //   })
 // })
 
-test.group('XML DataEntity Generator: associations', (group) => {
+test.group('XML DomainEntity Generator: associations', (group) => {
   let d1: DomainModel
   let e1: DomainEntity
   let e2: DomainEntity
@@ -1319,7 +1319,7 @@ test.group('XML DataEntity Generator: associations', (group) => {
   }).skip()
 })
 
-test.group('XML DataEntity Generator: parents', (group) => {
+test.group('XML DomainEntity Generator: parents', (group) => {
   let d1: DomainModel
   let e1: DomainEntity
   let e2: DomainEntity

package/tests/unit/modeling/{domain.property.spec.ts → domain_property.spec.ts}

@@ -1,5 +1,6 @@
 import { test } from '@japa/runner'
 import { DataDomain, DomainPropertyKind, DomainProperty, Thing, DataFormat } from '../../../src/index.js'
+import { SemanticType } from '../../../src/modeling/Semantics.js'
 
 test.group('DomainProperty.createSchema()', () => {
   test('creates a schema with default values', ({ assert }) => {
@@ -17,7 +18,7 @@ test.group('DomainProperty.createSchema()', () => {
     assert.isUndefined(schema.writeOnly)
     assert.isUndefined(schema.deprecated)
     assert.isUndefined(schema.tags)
-    assert.isUndefined(schema.taxonomy)
+    assert.isUndefined(schema.semantics)
     assert.isUndefined(schema.schema)
     assert.deepEqual(schema.bindings, [])
   })
@@ -34,7 +35,7 @@ test.group('DomainProperty.createSchema()', () => {
       writeOnly: true,
       deprecated: true,
       tags: ['tag1', 'tag2'],
-      taxonomy: ['tax1', 'tax2'],
+      semantics: [{ id: SemanticType.CreatedTimestamp }],
       type: 'number',
       schema: { minimum: 0 },
       bindings: [{ type: 'web', schema: { format: 'float' } }],
@@ -51,7 +52,7 @@ test.group('DomainProperty.createSchema()', () => {
     assert.isTrue(schema.writeOnly)
     assert.isTrue(schema.deprecated)
     assert.deepEqual(schema.tags, ['tag1', 'tag2'])
-    assert.deepEqual(schema.taxonomy, ['tax1', 'tax2'])
+    assert.deepEqual(schema.semantics, [{ id: SemanticType.CreatedTimestamp }])
     assert.deepEqual(schema.schema, { minimum: 0 })
     assert.deepEqual(schema.bindings, [{ type: 'web', schema: { format: 'float' } }])
   })
@@ -87,7 +88,7 @@ test.group('DomainProperty.createSchema()', () => {
       writeOnly: undefined,
       deprecated: undefined,
       tags: undefined,
-      taxonomy: undefined,
+      semantics: undefined,
       schema: undefined,
       bindings: undefined,
     })
@@ -104,7 +105,7 @@ test.group('DomainProperty.createSchema()', () => {
     assert.isUndefined(schema.writeOnly)
     assert.isUndefined(schema.deprecated)
     assert.isUndefined(schema.tags)
-    assert.isUndefined(schema.taxonomy)
+    assert.isUndefined(schema.semantics)
     assert.isUndefined(schema.schema)
     assert.deepEqual(schema.bindings, [])
   })
@@ -128,7 +129,7 @@ test.group('DomainProperty.createSchema()', () => {
       // @ts-expect-error Testing null values
       tags: null,
       // @ts-expect-error Testing null values
-      taxonomy: null,
+      semantics: null,
       // @ts-expect-error Testing null values
       schema: null,
       // @ts-expect-error Testing null values
@@ -142,7 +143,7 @@ test.group('DomainProperty.createSchema()', () => {
     assert.isUndefined(schema.writeOnly)
     assert.isUndefined(schema.deprecated)
     assert.isUndefined(schema.tags)
-    assert.isUndefined(schema.taxonomy)
+    assert.isUndefined(schema.semantics)
     assert.isUndefined(schema.schema)
     assert.deepEqual(schema.bindings, [])
   })
@@ -150,11 +151,11 @@ test.group('DomainProperty.createSchema()', () => {
   test('creates a schema with all properties empty array', ({ assert }) => {
     const schema = DomainProperty.createSchema({
       tags: [],
-      taxonomy: [],
+      semantics: [],
       bindings: [],
     })
     assert.deepEqual(schema.tags, [])
-    assert.deepEqual(schema.taxonomy, [])
+    assert.deepEqual(schema.semantics, [])
     assert.deepEqual(schema.bindings, [])
   })
 
@@ -180,11 +181,11 @@ test.group('DomainProperty.createSchema()', () => {
   test('creates a schema with all array properties set to empty arrays', ({ assert }) => {
     const schema = DomainProperty.createSchema({
       tags: [],
-      taxonomy: [],
+      semantics: [],
       bindings: [],
     })
     assert.deepEqual(schema.tags, [])
-    assert.deepEqual(schema.taxonomy, [])
+    assert.deepEqual(schema.semantics, [])
     assert.deepEqual(schema.bindings, [])
   })
 
@@ -202,12 +203,12 @@ test.group('DomainProperty.createSchema()', () => {
       // @ts-expect-error Testing null values
       tags: null,
       // @ts-expect-error Testing null values
-      taxonomy: null,
+      semantics: null,
       // @ts-expect-error Testing null values
       bindings: null,
     })
     assert.isUndefined(schema.tags)
-    assert.isUndefined(schema.taxonomy)
+    assert.isUndefined(schema.semantics)
     assert.deepEqual(schema.bindings, [])
   })
 
@@ -242,7 +243,7 @@ test.group('DomainProperty.constructor()', () => {
     assert.isUndefined(property.writeOnly)
     assert.isUndefined(property.deprecated)
     assert.deepEqual(property.tags, [])
-    assert.deepEqual(property.taxonomy, [])
+    assert.deepEqual(property.semantics, [])
     assert.isUndefined(property.schema)
     assert.deepEqual(property.bindings, [])
     assert.equal(property['parent'], parent)
@@ -263,7 +264,7 @@ test.group('DomainProperty.constructor()', () => {
       writeOnly: true,
       deprecated: true,
       tags: ['tag1', 'tag2'],
-      taxonomy: ['tax1', 'tax2'],
+      semantics: [{ id: SemanticType.CreatedTimestamp }],
       type: 'number',
       schema: { minimum: 0 },
       bindings: [{ type: 'web', schema: { format: 'float' } }],
@@ -281,7 +282,7 @@ test.group('DomainProperty.constructor()', () => {
     assert.isTrue(property.writeOnly)
     assert.isTrue(property.deprecated)
     assert.deepEqual(property.tags, ['tag1', 'tag2'])
-    assert.deepEqual(property.taxonomy, ['tax1', 'tax2'])
+    assert.deepEqual(property.semantics, [{ id: SemanticType.CreatedTimestamp }])
     assert.deepEqual(property.schema, { minimum: 0 })
     assert.deepEqual(property.bindings, [{ type: 'web', schema: { format: 'float' } }])
     assert.equal(property['parent'], parent)
@@ -404,7 +405,7 @@ test.group('DomainProperty.toJSON()', () => {
     assert.isUndefined(json.writeOnly)
     assert.isUndefined(json.deprecated)
     assert.isUndefined(json.tags)
-    assert.isUndefined(json.taxonomy)
+    assert.isUndefined(json.semantics)
     assert.isUndefined(json.schema)
     assert.isUndefined(json.bindings)
   })
@@ -423,7 +424,7 @@ test.group('DomainProperty.toJSON()', () => {
       writeOnly: true,
       deprecated: true,
       tags: ['tag1', 'tag2'],
-      taxonomy: ['tax1', 'tax2'],
+      semantics: [{ id: SemanticType.CreatedTimestamp }],
       type: 'number',
       schema: { minimum: 0 },
       bindings: [{ type: 'web', schema: { format: 'float' } }],
@@ -442,7 +443,7 @@ test.group('DomainProperty.toJSON()', () => {
     assert.isTrue(json.writeOnly)
     assert.isTrue(json.deprecated)
     assert.deepEqual(json.tags, ['tag1', 'tag2'])
-    assert.deepEqual(json.taxonomy, ['tax1', 'tax2'])
+    assert.deepEqual(json.semantics, [{ id: SemanticType.CreatedTimestamp }])
     assert.deepEqual(json.schema, { minimum: 0 })
     assert.deepEqual(json.bindings, [{ type: 'web', schema: { format: 'float' } }])
   })
@@ -452,13 +453,13 @@ test.group('DomainProperty.toJSON()', () => {
     const parent = 'test-parent'
     const property = new DomainProperty(root, parent, {
       tags: [],
-      taxonomy: [],
+      semantics: [],
       bindings: [],
     })
     const json = property.toJSON()
 
     assert.isUndefined(json.tags)
-    assert.isUndefined(json.taxonomy)
+    assert.isUndefined(json.semantics)
     assert.isUndefined(json.bindings)
   })
 
@@ -474,7 +475,7 @@ test.group('DomainProperty.toJSON()', () => {
       writeOnly: undefined,
       deprecated: undefined,
       tags: undefined,
-      taxonomy: undefined,
+      semantics: undefined,
       schema: undefined,
       bindings: undefined,
     })
@@ -488,7 +489,7 @@ test.group('DomainProperty.toJSON()', () => {
     assert.isUndefined(json.writeOnly)
     assert.isUndefined(json.deprecated)
     assert.isUndefined(json.tags)
-    assert.isUndefined(json.taxonomy)
+    assert.isUndefined(json.semantics)
     assert.isUndefined(json.schema)
     assert.isUndefined(json.bindings)
   })
@@ -820,3 +821,118 @@ test.group('DomainProperty.toApiShape()', () => {
     assert.isDefined(result)
   })
 })
+
+test.group('DomainProperty.addSemantic()', () => {
+  test('adds a new semantic to the property', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic = { id: SemanticType.CreatedTimestamp }
+    property.addSemantic(semantic)
+    assert.deepInclude(property.semantics, semantic)
+  })
+
+  test('updates an existing semantic', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic1 = { id: SemanticType.CreatedTimestamp, config: { value: 'old' } }
+    const semantic2 = { id: SemanticType.CreatedTimestamp, config: { value: 'new' } }
+    property.addSemantic(semantic1)
+    property.addSemantic(semantic2)
+    assert.lengthOf(property.semantics, 1)
+    assert.deepInclude(property.semantics, semantic2)
+  })
+
+  test('throws an error if the semantic is not a property semantic', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent')
+    const semantic = { id: SemanticType.User } // User is an Entity semantic
+    assert.throws(() => {
+      property.addSemantic(semantic)
+    }, `Invalid semantic type: ${SemanticType.User}. Expected a property semantic.`)
+  })
+
+  test('notifies change when adding a new semantic', async ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic = { id: SemanticType.CreatedTimestamp }
+    property.addSemantic(semantic)
+    await assert.dispatches(dataDomain, 'change', { timeout: 20 })
+  })
+
+  test('notifies change when updating an existing semantic', async ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic1 = { id: SemanticType.CreatedTimestamp, config: { value: 'old' } }
+    const semantic2 = { id: SemanticType.CreatedTimestamp, config: { value: 'new' } }
+    property.addSemantic(semantic1)
+    // Clear the event queue before the second add
+    await new Promise((resolve) => setTimeout(resolve, 0))
+    property.addSemantic(semantic2)
+    await assert.dispatches(dataDomain, 'change', { timeout: 20 })
+  })
+})
+
+test.group('DomainProperty.removeSemantic()', () => {
+  test('removes an existing semantic from the property', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic = { id: SemanticType.CreatedTimestamp }
+    property.addSemantic(semantic)
+    assert.deepInclude(property.semantics, semantic)
+    property.removeSemantic(SemanticType.CreatedTimestamp)
+    assert.notDeepInclude(property.semantics, semantic)
+    assert.lengthOf(property.semantics, 0)
+  })
+
+  test('does nothing if the semantic to remove does not exist', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic = { id: SemanticType.CreatedTimestamp }
+    property.addSemantic(semantic)
+    const initialSemantics = [...property.semantics]
+    property.removeSemantic('non-existent-semantic-id' as SemanticType)
+    assert.deepEqual(property.semantics, initialSemantics)
+  })
+
+  test('notifies change when a semantic is removed', async ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic = { id: SemanticType.CreatedTimestamp }
+    property.addSemantic(semantic)
+    // Clear the event queue before removal
+    await new Promise((resolve) => setTimeout(resolve, 0))
+    property.removeSemantic(SemanticType.CreatedTimestamp)
+    await assert.dispatches(dataDomain, 'change', { timeout: 20 })
+  })
+
+  test('does not notify change if the semantic to remove does not exist', async ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent')
+    // Clear the event queue before removal
+    await new Promise((resolve) => setTimeout(resolve, 0))
+    property.removeSemantic('non-existent-semantic-id' as SemanticType)
+    await assert.notDispatches(dataDomain, 'change', { timeout: 20 })
+  })
+})
+
+test.group('DomainProperty.hasSemantic()', () => {
+  test('returns true if the property has the specified semantic', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent', { type: 'datetime' })
+    const semantic = { id: SemanticType.CreatedTimestamp }
+    property.addSemantic(semantic)
+    assert.isTrue(property.hasSemantic(SemanticType.CreatedTimestamp))
+  })
+
+  test('returns false if the property does not have the specified semantic', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent')
+    assert.isFalse(property.hasSemantic(SemanticType.CreatedTimestamp))
+  })
+
+  test('returns false for an empty semantics array', ({ assert }) => {
+    const dataDomain = new DataDomain()
+    const property = new DomainProperty(dataDomain, 'test-parent')
+    assert.isFalse(property.hasSemantic(SemanticType.CreatedTimestamp))
+  })
+})

package/tests/unit/modeling/semantics.spec.ts

@@ -0,0 +1,149 @@
+import { test } from '@japa/runner'
+import {
+  SemanticType,
+  SemanticScope,
+  isEntitySemantic,
+  isPropertySemantic,
+  isAssociationSemantic,
+  DataSemantics,
+  type EntitySemantic,
+  type PropertySemantic,
+  type AssociationSemantic,
+  type DataSemantic,
+} from '../../../src/modeling/Semantics.js'
+
+test.group('Semantics', () => {
+  test('SemanticType enum should have correct values', ({ assert }) => {
+    assert.equal(SemanticType.User, 'https://apinow.app/semantics/entities/#User')
+    assert.equal(SemanticType.CreatedTimestamp, 'https://apinow.app/semantics/properties/#CreatedTimestamp')
+    assert.equal(SemanticType.UpdatedTimestamp, 'https://apinow.app/semantics/properties/#UpdatedTimestamp')
+    assert.equal(SemanticType.DeletedTimestamp, 'https://apinow.app/semantics/properties/#DeletedTimestamp')
+    assert.equal(SemanticType.DeletedFlag, 'https://apinow.app/semantics/properties/#DeletedFlag')
+    assert.equal(SemanticType.PublicUniqueName, 'https://apinow.app/semantics/properties/#PublicUniqueName')
+    assert.equal(SemanticType.UserRole, 'https://apinow.app/semantics/entities/#UserRole')
+    assert.equal(
+      SemanticType.ResourceOwnerIdentifier,
+      'https://apinow.app/semantics/associations/#ResourceOwnerIdentifier'
+    )
+  })
+
+  test('SemanticScope enum should have correct values', ({ assert }) => {
+    assert.equal(SemanticScope.Entity, 'Entity')
+    assert.equal(SemanticScope.Property, 'Property')
+    assert.equal(SemanticScope.Association, 'Association')
+  })
+
+  test('isEntitySemantic type guard', ({ assert }) => {
+    const entitySemantic: EntitySemantic = {
+      id: SemanticType.User,
+      displayName: 'User Entity',
+      description: 'Test',
+      scope: SemanticScope.Entity,
+    }
+    const propertySemantic: PropertySemantic = {
+      id: SemanticType.CreatedTimestamp,
+      displayName: 'Creation Timestamp',
+      description: 'Test',
+      scope: SemanticScope.Property,
+    }
+    const associationSemantic: AssociationSemantic = {
+      id: SemanticType.ResourceOwnerIdentifier,
+      displayName: 'Resource Owner Identifier',
+      description: 'Test',
+      scope: SemanticScope.Association,
+    }
+
+    assert.isTrue(isEntitySemantic(entitySemantic))
+    assert.isFalse(isEntitySemantic(propertySemantic))
+    assert.isFalse(isEntitySemantic(associationSemantic))
+  })
+
+  test('isPropertySemantic type guard', ({ assert }) => {
+    const entitySemantic: EntitySemantic = {
+      id: SemanticType.User,
+      displayName: 'User Entity',
+      description: 'Test',
+      scope: SemanticScope.Entity,
+    }
+    const propertySemantic: PropertySemantic = {
+      id: SemanticType.CreatedTimestamp,
+      displayName: 'Creation Timestamp',
+      description: 'Test',
+      scope: SemanticScope.Property,
+    }
+    const associationSemantic: AssociationSemantic = {
+      id: SemanticType.ResourceOwnerIdentifier,
+      displayName: 'Resource Owner Identifier',
+      description: 'Test',
+      scope: SemanticScope.Association,
+    }
+
+    assert.isFalse(isPropertySemantic(entitySemantic))
+    assert.isTrue(isPropertySemantic(propertySemantic))
+    assert.isFalse(isPropertySemantic(associationSemantic))
+  })
+
+  test('isAssociationSemantic type guard', ({ assert }) => {
+    const entitySemantic: EntitySemantic = {
+      id: SemanticType.User,
+      displayName: 'User Entity',
+      description: 'Test',
+      scope: SemanticScope.Entity,
+    }
+    const propertySemantic: PropertySemantic = {
+      id: SemanticType.CreatedTimestamp,
+      displayName: 'Creation Timestamp',
+      description: 'Test',
+      scope: SemanticScope.Property,
+    }
+    const associationSemantic: AssociationSemantic = {
+      id: SemanticType.ResourceOwnerIdentifier,
+      displayName: 'Resource Owner Identifier',
+      description: 'Test',
+      scope: SemanticScope.Association,
+    }
+
+    assert.isFalse(isAssociationSemantic(entitySemantic))
+    assert.isFalse(isAssociationSemantic(propertySemantic))
+    assert.isTrue(isAssociationSemantic(associationSemantic))
+  })
+
+  test('DataSemantics should contain correct definitions', ({ assert }) => {
+    const semanticTypes = Object.values(SemanticType)
+    semanticTypes.forEach((type) => {
+      const semantic: DataSemantic | undefined = DataSemantics[type]
+      assert.isDefined(semantic, `Semantic definition for ${type} should exist`)
+      if (!semantic) return
+
+      assert.equal(semantic.id, type, `ID for ${type} should match`)
+      assert.isString(semantic.displayName, `displayName for ${type} should be a string`)
+      assert.isNotEmpty(semantic.displayName, `displayName for ${type} should not be empty`)
+      assert.isString(semantic.description, `description for ${type} should be a string`)
+      assert.isNotEmpty(semantic.description, `description for ${type} should not be empty`)
+
+      assert.oneOf(semantic.scope, Object.values(SemanticScope), `scope for ${type} should be a valid SemanticScope`)
+
+      if (isPropertySemantic(semantic)) {
+        if (semantic.applicableDataTypes) {
+          assert.isArray(semantic.applicableDataTypes, `applicableDataTypes for ${type} should be an array if present`)
+          semantic.applicableDataTypes.forEach((dt) => {
+            assert.isString(dt, `Each applicableDataType for ${type} should be a string`)
+          })
+        }
+      }
+    })
+
+    // Specific checks for some semantics
+    const userSemantic = DataSemantics[SemanticType.User]
+    assert.equal(userSemantic.scope, SemanticScope.Entity)
+
+    const createdTimestampSemantic = DataSemantics[SemanticType.CreatedTimestamp]
+    assert.equal(createdTimestampSemantic.scope, SemanticScope.Property)
+    if (isPropertySemantic(createdTimestampSemantic)) {
+      assert.deepEqual(createdTimestampSemantic.applicableDataTypes, ['datetime'])
+    }
+
+    const resourceOwnerSemantic = DataSemantics[SemanticType.ResourceOwnerIdentifier]
+    assert.equal(resourceOwnerSemantic.scope, SemanticScope.Association)
+  })
+})

package/build/src/amf/AmfShapeGenerator.d.ts

@@ -1,103 +0,0 @@
-import { type PropertyWebBindings } from '../modeling/Bindings.js';
-import { DataAssociation } from '../modeling/legacy/DataAssociation.js';
-import { DataEntity } from '../modeling/legacy/DataEntity.js';
-import { DataProperty, type DataPropertySchema } from '../modeling/legacy/DataProperty.js';
-import { IApiAnyShape, IApiArrayShape, IApiDataExample, IApiFileShape, IApiNodeShape, IApiPropertyShape, IApiRecursiveShape, IApiScalarShape, IApiShape, IShapeUnion } from './definitions/Shapes.js';
-import { DataValueGenerator } from './DataValueGenerator.js';
-/**
- * Serializes Data shapes (DataEntity, DataProperty, DataAssociation) to AMF-related shapes.
- *
- * This is used when defining entities (according to the `DataEntity` schema)
- *  and then we want to translate this into AMF shapes.
- *
- * @deprecated This class refers to the deprecated old data domain model.
- * Use the `ShapeGenerator` with the new domain model.
- */
-export declare class AmfShapeGenerator {
-    #private;
-    /**
-     * Used with data domain value generation for entity properties.
-     * Lazily loaded class only when functions are used.
-     * This needs to be a class instances because some functions are incremental
-     */
-    get valueGenerator(): DataValueGenerator;
-    /**
-     * Serializes the Entity to the AMF node shape.
-     *
-     * @param input The Property to serialize.
-     * @param generatedEntities The list keys of already generated entities. This prohibits recursive shape generation.
-     */
-    entity(input: DataEntity, generatedEntities?: string[]): IApiNodeShape | IApiRecursiveShape;
-    /**
-     * Serializes an Entity Property to the AMF property shape.
-     *
-     * @param input The Property to serialize.
-     */
-    property(input: DataProperty): IApiPropertyShape;
-    /**
-     * Serializes an Entity property to the AMF property shape with association
-     * targets as defined in the schema configuration.
-     *
-     * @param input The Property to serialize.
-     */
-    associationProperty(input: DataAssociation, generatedEntities?: string[]): IApiPropertyShape;
-    /**
-     * Generates a shape for an association. Most likely you want to use the `associationProperty()` method instead.
-     *
-     * @param input The data association instance.
-     * @returns The range value for the PropertyShape.
-     */
-    associationShape(input: DataAssociation, generatedEntities?: string[]): IShapeUnion | undefined;
-    /**
-     * Generates a shape list for an union. Most likely you want to use the `associationProperty()` method instead.
-     *
-     * @param input The data association instance.
-     * @returns The range value for the PropertyShape.
-     */
-    associationUnion(input: DataAssociation, generatedEntities?: string[]): IShapeUnion | IShapeUnion[] | undefined;
-    /**
-     * The DataProperty may have both the `schema` and the `bindings`. For AMF shape we read `schema` for
-     * default value, examples, and enum values. We also look for the `web`
-     * bindings for more detailed definition of a shape.
-     *
-     * @param input
-     * @returns
-     */
-    protected _readPropertyRange(input: DataProperty): IApiArrayShape | IApiFileShape | IApiScalarShape;
-    protected _createAmfSchema(input: DataProperty, schema?: DataPropertySchema, bindings?: PropertyWebBindings): IApiArrayShape | IApiFileShape | IApiScalarShape;
-    /**
-     * Normally this would be part of generating a scalar schema but the the property is an array this
-     * is generated on the array and not on the range.
-     *
-     * @param result The scalar or array shape.
-     * @param schema The property schema
-     * @param type The data type of the parent property as set on the `range`
-     * @param isArray Whether the DataProperty is multiple
-     */
-    protected _setShapeSchema(input: DataProperty, result: IApiAnyShape, schema: DataPropertySchema, type: string, isArray?: boolean): void;
-    protected _generateArrayShape(input: DataProperty, schema?: DataPropertySchema, bindings?: PropertyWebBindings): IApiArrayShape;
-    protected _generateScalarShape(input: DataProperty, schema?: DataPropertySchema, bindings?: PropertyWebBindings): IApiScalarShape;
-    protected _generateExamples(examples: string[], type: string): IApiDataExample[];
-    protected _generateArrayExamples(examples: string[], type: string): IApiDataExample[];
-    protected _generateFileShape(input: DataProperty, schema?: DataPropertySchema, bindings?: PropertyWebBindings): IApiFileShape;
-    protected _fillScalarShapeCommonProperties(result: IApiFileShape | IApiScalarShape, input: DataProperty, bindings?: PropertyWebBindings): void;
-    protected _updateBaseProperties(input: DataProperty | DataAssociation | DataEntity, target: IApiShape): void;
-    protected _recursiveShape(input: DataEntity): IApiRecursiveShape;
-    /**
-     * Translates generated schema from an array shape to the shape defined in the `items` of the array.
-     *
-     * @param array The source array.
-     * @returns The definition of the `items` of the array.
-     */
-    refactorArrayToShape(array: IApiArrayShape): IShapeUnion;
-    /**
-     * Translates the shape to an array shape. This happens when data model property
-     * is changed from 'multiple' to not-multiple and back.
-     *
-     * @param id The key of the parameter or an association
-     * @param shape The shape to wrap as an array.
-     * @returns Array shape.
-     */
-    refactorShapeToArray(id: string, shape: IShapeUnion): IApiArrayShape;
-}
-//# sourceMappingURL=AmfShapeGenerator.d.ts.map

package/build/src/amf/AmfShapeGenerator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AmfShapeGenerator.d.ts","sourceRoot":"","sources":["../../../src/amf/AmfShapeGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAA;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAA;AAC7D,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,oCAAoC,CAAA;AAG1F,OAAO,EAIL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,SAAS,EACT,WAAW,EAMZ,MAAM,yBAAyB,CAAA;AAIhC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAE5D;;;;;;;;GAQG;AACH,qBAAa,iBAAiB;;IAG5B;;;;OAIG;IACH,IAAI,cAAc,IAAI,kBAAkB,CAKvC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,iBAAiB,GAAE,MAAM,EAAO,GAAG,aAAa,GAAG,kBAAkB;IAgC/F;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,iBAAiB;IAoBhD;;;;;OAKG;IACH,mBAAmB,CAAC,KAAK,EAAE,eAAe,EAAE,iBAAiB,GAAE,MAAM,EAAO,GAAG,iBAAiB;IAYhG;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,eAAe,EAAE,iBAAiB,GAAE,MAAM,EAAO,GAAG,WAAW,GAAG,SAAS;IA8CnG;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,eAAe,EAAE,iBAAiB,GAAE,MAAM,EAAO,GAAG,WAAW,GAAG,WAAW,EAAE,GAAG,SAAS;IAWnH;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc,GAAG,aAAa,GAAG,eAAe;IASnG,SAAS,CAAC,gBAAgB,CACxB,KAAK,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,kBAAkB,EAC3B,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,cAAc,GAAG,aAAa,GAAG,eAAe;IAWnD;;;;;;;;OAQG;IACH,SAAS,CAAC,eAAe,CACvB,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,GAChB,IAAI;IA2BP,SAAS,CAAC,mBAAmB,CAC3B,KAAK,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,kBAAkB,EAC3B,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,cAAc;IAgBjB,SAAS,CAAC,oBAAoB,CAC5B,KAAK,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,kBAAkB,EAC3B,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,eAAe;IAalB,SAAS,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe,EAAE;IAchF,SAAS,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe,EAAE;IAgBrF,SAAS,CAAC,kBAAkB,CAC1B,KAAK,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,kBAAkB,EAC3B,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,aAAa;IAkBhB,SAAS,CAAC,gCAAgC,CACxC,MAAM,EAAE,aAAa,GAAG,eAAe,EACvC,KAAK,EAAE,YAAY,EACnB,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,IAAI;IAgEP,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,eAAe,GAAG,UAAU,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI;IAY5G,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,kBAAkB;IAIhE;;;;;OAKG;IACH,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,WAAW;IAKxD;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,cAAc;CAKrE"}