@api-client/core 0.19.10 → 0.19.12

package/eslint.config.js

@@ -80,7 +80,6 @@ export default [
       'src/models/SerializablePayload.ts',
       'src/lib/calculators/DataCalculator.ts',
       'src/lib/Buffer.ts',
-      'src/events/amf/AmfEvents.ts',
       'src/authorization/lib/SecurityProcessor.ts',
     ],
     languageOptions: {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.19.10",
-  "license": "Apache-2.0",
+  "version": "0.19.12",
+  "license": "UNLICENSED",
   "exports": {
     "./browser.js": {
       "default": "./build/src/browser.js",
@@ -19,8 +19,6 @@
     },
     "./package.json": "./package.json",
     "./nanoid.js": "./build/src/nanoid.js",
-    "./amf/*.js": "./build/src/amf/*.js",
-    "./amf/*": "./build/src/amf/*",
     "./authorization/*.js": "./build/src/authorization/*.js",
     "./authorization/*": "./build/src/authorization/*",
     "./config/*.js": "./build/src/config/*.js",
@@ -53,7 +51,6 @@
     "./testing/*": "./build/src/testing/*"
   },
   "imports": {
-    "#amf/*": "./src/amf/*",
     "#authorization/*": "./src/authorization/*",
     "#cookies/*": "./src/cookies/*",
     "#data/*": "./src/data/*",
@@ -84,6 +81,7 @@
     "url": "https://github.com/api-client/core/issues"
   },
   "dependencies": {
+    "@api-client/amf-core": "^0.1.2",
     "@api-client/graph": "^0.3.5",
     "@api-client/json": "^0.2.0",
     "@esm-bundle/chai": "^4.3.4-fix.0",
@@ -95,7 +93,6 @@
     "@pawel-up/data-mock": "^0.4.0",
     "@pawel-up/jexl": "^4.0.1",
     "@xmldom/xmldom": "^0.8.11",
-    "amf-json-ld-lib": "^0.0.15",
     "chalk": "^5.4.1",
     "console-table-printer": "^2.11.2",
     "dompurify": "^3.2.6",
@@ -109,10 +106,7 @@
     "@commitlint/cli": "^20.1.0",
     "@commitlint/config-conventional": "^20.0.0",
     "@eslint/js": "^10.0.1",
-    "@japa/api-client": "^3.0.3",
     "@japa/assert": "^4.0.1",
-    "@japa/browser-client": "^2.1.1",
-    "@japa/expect-type": "^2.0.3",
     "@japa/runner": "^5.3.0",
     "@pawel-up/semver": "^0.1.4",
     "@types/chai-as-promised": "^8.0.2",
@@ -128,7 +122,6 @@
     "@web/dev-server-rollup": "^0.6.4",
     "@web/test-runner": "^0.20.0",
     "@web/test-runner-playwright": "^0.11.0",
-    "amf-client-js": "^5.10.0-0",
     "c8": "^11.0.0",
     "chai-as-promised": "^8.0.2",
     "conventional-changelog": "^7.1.0",
@@ -148,7 +141,6 @@
     "prettier": "^3.5.1",
     "schema-org-json-schemas": "^2.1.4",
     "sinon": "^21.0.0",
-    "ts-lit-plugin": "^2.0.2",
     "ts-node-maintained": "^10.9.5",
     "typescript": "^5.5.2",
     "typescript-eslint": "^8.24.1"
@@ -158,7 +150,7 @@
     "build:ts": "tsc --project tsconfig.json",
     "build:node": "tsc --project tsconfig.node.json",
     "build": "npm run build:ts && npm run copy:assets",
-    "prepare": "husky && npm run fixes && npm run build:ts && npm run build:api-models",
+    "prepare": "husky && npm run fixes && npm run build:ts",
     "fixes": "node scripts/fix-rollup-plugin.js",
     "tsc": "tsc",
     "tsc:tests": "tsc --project tsconfig.browser.json",
@@ -169,7 +161,6 @@
     "test:coverage": "npm run test:node:coverage && npm run test:browser",
     "test:node": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
     "test:node:coverage": "c8 --reporter lcov --reporter text node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
-    "build:api-models": "node data/model.js",
     "copy:assets": "cp -f ./oauth-popup.html ./build/oauth-popup.html",
     "start": "echo \"Use the npm run dev instead\"",
     "lint": "npm run lint:prettier && npm run lint:eslint",
@@ -184,8 +175,14 @@
     "release:major": "node scripts/release.js major"
   },
   "lint-staged": {
+    "*.js": [
+      "eslint --fix"
+    ],
     "*.ts": [
-      "npm run format"
+      "eslint --fix"
+    ],
+    "*.json": [
+      "prettier --write"
     ]
   },
   "engines": {

package/src/events/EventTypes.ts

@@ -6,10 +6,8 @@ import { ReportingEventTypes } from './reporting/ReportingEventTypes.js'
 import { TelemetryEventTypes } from './telemetry/TelemetryEventTypes.js'
 import { EnvironmentEventTypes } from './environment/EnvironmentEventTypes.js'
 import { TransportEventTypes } from './transport/TransportEventTypes.js'
-import { AmfEventTypes } from './amf/AmfEventTypes.js'
 
 export const EventTypes = Object.freeze({
-  Amf: AmfEventTypes,
   Authorization: AuthorizationEventTypes,
   Cookie: CookieEventTypes,
   Encryption: EncryptionEventTypes,

package/src/events/Events.ts

@@ -6,10 +6,8 @@ import { ReportingEvents } from './reporting/ReportingEvents.js'
 import { TelemetryEvents } from './telemetry/TelemetryEvents.js'
 import { TransportEvent } from './transport/TransportEvents.js'
 import { EnvironmentEvents } from './environment/EnvironmentEvents.js'
-import { AmfEvents } from './amf/AmfEvents.js'
 
 export const Events = Object.freeze({
-  Amf: AmfEvents,
   Authorization: AuthorizationEvents,
   Cookie: CookieEvents,
   Encryption: EncryptionEvents,

package/src/modeling/ApiValidation.ts

@@ -0,0 +1,86 @@
+import { ApiModel } from './ApiModel.js'
+import { ApiModelValidationItem } from './types.js'
+import { ApiModelKind } from '../models/kinds.js'
+import {
+  validateApiModelInfo,
+  validateApiModelDependency,
+  validateApiModelSecurity,
+  validateApiModelMetadata,
+  validateExposedEntity,
+} from './validation/api_model_rules.js'
+
+/**
+ * ApiValidation performs comprehensive validation on an API model.
+ *
+ * This class orchestrates validation across all API model elements including
+ * info, security, exposures, and actions. It ensures that the API model is
+ * well-formed and follows established conventions before it can be published.
+ */
+export class ApiValidation {
+  report: ApiModelValidationItem[] = []
+  #infoCount = 0
+  #warningCount = 0
+  #errorCount = 0
+  #counted = false
+
+  get infoCount(): number {
+    if (!this.#counted) {
+      this.computeIssueCounters()
+    }
+    return this.#infoCount
+  }
+
+  get warningCount(): number {
+    if (!this.#counted) {
+      this.computeIssueCounters()
+    }
+    return this.#warningCount
+  }
+
+  get errorCount(): number {
+    if (!this.#counted) {
+      this.computeIssueCounters()
+    }
+    return this.#errorCount
+  }
+
+  constructor(protected model: ApiModel) {}
+
+  /**
+   * Performs comprehensive validation on the entire API model.
+   *
+   * @returns A comprehensive validation report with all issues found
+   */
+  validate(): ApiModelValidationItem[] {
+    this.#counted = false
+    this.report = []
+
+    this.report.push(...validateApiModelInfo(this.model))
+    this.report.push(...validateApiModelDependency(this.model))
+    this.report.push(...validateApiModelSecurity(this.model))
+    this.report.push(...validateApiModelMetadata(this.model))
+
+    if (!this.model.exposes || this.model.exposes.size === 0) {
+      this.report.push({
+        code: 'API_NO_EXPOSURES',
+        message: 'Your API currently has no exposed data for external clients to request.',
+        suggestion: 'Expose a data model so apps can communicate with it.',
+        severity: 'warning',
+        context: { apiModelKey: this.model.key, kind: ApiModelKind, key: this.model.key, property: 'exposes' },
+      })
+    } else {
+      for (const exposure of this.model.exposes.values()) {
+        this.report.push(...validateExposedEntity(exposure, this.model))
+      }
+    }
+
+    return this.report
+  }
+
+  computeIssueCounters(): void {
+    this.#infoCount = this.report.filter((validation) => validation.severity === 'info').length
+    this.#warningCount = this.report.filter((validation) => validation.severity === 'warning').length
+    this.#errorCount = this.report.filter((validation) => validation.severity === 'error').length
+    this.#counted = true
+  }
+}

package/src/modeling/Bindings.ts

@@ -1,5 +1,5 @@
-import { IApiXmlSerializer } from '../amf/definitions/Shapes.js'
-import { DomainPropertyFormat } from './DataFormat.js'
+import type { Shapes } from '@api-client/amf-core'
+import type { DomainPropertyFormat } from './DataFormat.js'
 
 interface Binding {
   /**
@@ -69,7 +69,7 @@ export interface PropertyWebBindings {
   /**
    * The XML encoding instructions.
    */
-  xml?: IApiXmlSerializer
+  xml?: Shapes.IApiXmlSerializer
   /**
    * Only valid for the `file` property type.
    * The list of file mime types.

package/src/modeling/DomainAssociation.ts

@@ -5,7 +5,7 @@ import { nanoid } from '../nanoid.js'
 import { type IThing, Thing } from '../models/Thing.js'
 import { observed, retargetChange, toRaw } from '../decorators/observed.js'
 import type { DomainEntity } from './DomainEntity.js'
-import type { IApiAssociationShape, IApiPropertyShape } from '../amf/definitions/Shapes.js'
+import type { Shapes } from '@api-client/amf-core'
 import type { AssociationBinding, AssociationBindings, AssociationWebBindings } from './Bindings.js'
 import { DomainAttributeAttribute, DomainAttributeAttributes } from './DataFormat.js'
 import type { AssociationTarget, DomainGraphEdge } from './types.js'
@@ -53,7 +53,7 @@ export interface DomainAssociationSchema extends DomainElementSchema {
    * referenced entities schemas. Note, changes in the referenced entities may not be propagated
    * to schemas altered by the user.
    */
-  schema?: IApiAssociationShape
+  schema?: Shapes.IApiAssociationShape
   /**
    * The list of bindings for this property.
    *
@@ -153,7 +153,7 @@ export class DomainAssociation extends DomainElement {
    * The schema allowing to translate the model into a
    * specific format (like JSON, RAML, XML, etc.)
    */
-  @observed({ deep: true }) accessor schema: IApiAssociationShape | undefined
+  @observed({ deep: true }) accessor schema: Shapes.IApiAssociationShape | undefined
 
   /**
    * The list of bindings for this property.
@@ -351,7 +351,7 @@ export class DomainAssociation extends DomainElement {
    * const schema = association.ensureSchema();
    * ```
    */
-  ensureSchema(): IApiAssociationShape {
+  ensureSchema(): Shapes.IApiAssociationShape {
     if (!this.schema) {
       this.schema = {}
     }
@@ -547,7 +547,7 @@ export class DomainAssociation extends DomainElement {
    *
    * @returns AMF property shape definition.
    */
-  toApiShape(): IApiPropertyShape {
+  toApiShape(): Shapes.IApiPropertyShape {
     const serializer = new ShapeGenerator()
     return serializer.associationProperty(this)
   }

package/src/modeling/DomainEntity.ts

@@ -4,7 +4,8 @@ import { DomainElement, type DomainElementSchema } from './DomainElement.js'
 import { nanoid } from '../nanoid.js'
 import { type IThing, Thing } from '../models/Thing.js'
 import { observed, retargetChange, toRaw } from '../decorators/observed.js'
-import type { IShapeUnion } from '../amf/definitions/Shapes.js'
+import type { Shapes, IShapeRenderOptions } from '@api-client/amf-core'
+import { ApiSchemaGenerator } from '@api-client/amf-core'
 import { DomainProperty, type DomainPropertySchema } from './DomainProperty.js'
 import { RemovePropertyException } from '../exceptions/remove_property_exception.js'
 import { DomainAssociation, DomainAssociationSchema } from './DomainAssociation.js'
@@ -13,8 +14,6 @@ import type { DomainModel } from './DomainModel.js'
 import type { DomainNamespace } from './DomainNamespace.js'
 import { ValidationError } from '../exceptions/validation_error.js'
 import { ShapeGenerator } from './amf/ShapeGenerator.js'
-import type { IShapeRenderOptions } from '../amf/shape/ShapeBase.js'
-import { ApiSchemaGenerator } from '../amf/ApiSchemaGenerator.js'
 import { removeGraphNode } from './GraphUtils.js'
 import { DataSemantics, isEntitySemantic, type SemanticType, type AppliedDataSemantic } from './Semantics.js'
 
@@ -806,7 +805,7 @@ export class DomainEntity extends DomainElement {
    *
    * @returns AMF property shape definition.
    */
-  toApiShape(): IShapeUnion {
+  toApiShape(): Shapes.IShapeUnion {
     const serializer = new ShapeGenerator()
     return serializer.entity(this)
   }

package/src/modeling/DomainProperty.ts

@@ -20,11 +20,10 @@ import { ShapeGenerator } from './amf/ShapeGenerator.js'
 import type { PropertyBinding, PropertyBindings, PropertyWebBindings } from './Bindings.js'
 import type { ModelValidationOptions } from '../models/types.js'
 import type { DomainEntity } from './DomainEntity.js'
-import type { IApiPropertyShape } from '../amf/definitions/Shapes.js'
+import type { Shapes, IShapeRenderOptions } from '@api-client/amf-core'
+import { ApiSchemaGenerator } from '@api-client/amf-core'
 import type { PropertySchema } from './types.js'
 import { DataSemantics, isPropertySemantic, type SemanticType, type AppliedDataSemantic } from './Semantics.js'
-import { ApiSchemaGenerator } from '../amf/ApiSchemaGenerator.js'
-import type { IShapeRenderOptions } from '../amf/shape/ShapeBase.js'
 
 export interface DomainPropertySchema extends DomainElementSchema {
   kind: typeof DomainPropertyKind
@@ -576,7 +575,7 @@ export class DomainProperty extends DomainElement {
    *
    * @returns AMF property shape definition.
    */
-  toApiShape(): IApiPropertyShape {
+  toApiShape(): Shapes.IApiPropertyShape {
     const serializer = new ShapeGenerator()
     return serializer.property(this)
   }

package/src/modeling/DomainValidation.ts

@@ -1,9 +1,8 @@
-import { DataDomainKind } from '../models/kinds.js'
 import { DataDomain } from './DataDomain.js'
-import type { DomainImpactReport } from './types.js'
 import { AssociationValidation } from './validation/association_validation.js'
 import { EntityValidation } from './validation/entity_validation.js'
 import { PropertyValidation } from './validation/property_validation.js'
+import { DomainValidationSchema } from './validation/rules.js'
 import { SemanticValidation } from './validation/semantic_validation.js'
 
 /**
@@ -76,12 +75,35 @@ import { SemanticValidation } from './validation/semantic_validation.js'
  * @see {@link SemanticValidation} for detailed semantic validation rules
  */
 export class DomainValidation {
-  private root: DataDomain
+  report: DomainValidationSchema[] = []
+  #infoCount = 0
+  #warningCount = 0
+  #errorCount = 0
+  #counted = false
 
-  constructor(root: DataDomain) {
-    this.root = root
+  get infoCount(): number {
+    if (!this.#counted) {
+      this.computeIssueCounters()
+    }
+    return this.#infoCount
+  }
+
+  get warningCount(): number {
+    if (!this.#counted) {
+      this.computeIssueCounters()
+    }
+    return this.#warningCount
+  }
+
+  get errorCount(): number {
+    if (!this.#counted) {
+      this.computeIssueCounters()
+    }
+    return this.#errorCount
   }
 
+  constructor(protected domain: DataDomain) {}
+
   /**
    * Performs comprehensive validation on the entire data domain.
    *
@@ -91,93 +113,54 @@ export class DomainValidation {
    *
    * @returns A comprehensive validation report with all issues found
    */
-  validate(): DomainImpactReport {
-    const result: DomainImpactReport = {
-      key: '',
-      kind: DataDomainKind,
-      impact: [],
-      canProceed: true,
-    }
-    const entityValidator = new EntityValidation(this.root)
-    const propertyValidator = new PropertyValidation(this.root)
-    const associationValidator = new AssociationValidation(this.root)
-    const semanticValidator = new SemanticValidation(this.root)
+  validate(): DomainValidationSchema[] {
+    this.#counted = false
+    this.report = []
+    const entityValidator = new EntityValidation(this.domain)
+    const propertyValidator = new PropertyValidation(this.domain)
+    const associationValidator = new AssociationValidation(this.domain)
+    const semanticValidator = new SemanticValidation(this.domain)
 
     let hasEntities = false
-    // Validate entities, properties, and associations
-    for (const entity of this.root.listEntities()) {
-      if (entity.domain.key !== this.root.key) {
+    for (const entity of this.domain.listEntities()) {
+      if (entity.domain.key !== this.domain.key) {
         // we don't need to validate foreign entities
         continue
       }
       hasEntities = true
-      const report = entityValidator.validate(entity)
-      for (const item of report) {
-        const blocking = item.severity === 'error'
-        result.canProceed = result.canProceed && !blocking
-        result.impact.push({
-          key: item.key,
-          kind: item.kind,
-          type: 'publish',
-          impact: item.message,
-          resolution: item.help,
-          severity: item.severity,
-          parent: item.parent,
-        })
-      }
+      const entities = entityValidator.validate(entity)
+      this.report.push(...entities)
       for (const property of entity.properties) {
-        const report = propertyValidator.validate(property)
-        for (const item of report) {
-          const blocking = item.severity === 'error'
-          result.canProceed = result.canProceed && !blocking
-          result.impact.push({
-            key: item.key,
-            kind: item.kind,
-            type: 'publish',
-            impact: item.message,
-            resolution: item.help,
-            severity: item.severity,
-            parent: item.parent,
-          })
+        if (property.domain.key !== this.domain.key) {
+          // we don't need to validate foreign properties
+          continue
         }
+        const properties = propertyValidator.validate(property)
+        this.report.push(...properties)
       }
       for (const association of entity.associations) {
-        const report = associationValidator.validate(association)
-        for (const item of report) {
-          const blocking = item.severity === 'error'
-          result.canProceed = result.canProceed && !blocking
-          result.impact.push({
-            key: item.key,
-            kind: item.kind,
-            type: 'publish',
-            impact: item.message,
-            resolution: item.help,
-            severity: item.severity,
-            parent: item.parent,
-          })
+        if (association.domain.key !== this.domain.key) {
+          // we don't need to validate foreign properties
+          continue
         }
+        const associations = associationValidator.validate(association)
+        this.report.push(...associations)
       }
     }
     if (!hasEntities) {
       // no entities, no need to validate anything else
-      return result
+      return this.report
     }
     // Validate semantics
     const semanticReport = semanticValidator.validate()
-    for (const item of semanticReport) {
-      const blocking = item.severity === 'error'
-      result.canProceed = result.canProceed && !blocking
-      result.impact.push({
-        key: item.key,
-        kind: item.kind,
-        type: 'publish',
-        impact: item.message,
-        resolution: item.help,
-        severity: item.severity,
-        parent: item.parent,
-      })
-    }
+    this.report.push(...semanticReport)
+    return this.report
+  }
 
-    return result
+  computeIssueCounters(): void {
+    this.#infoCount = this.report.filter((validation) => validation.severity === 'info').length
+    this.#warningCount = this.report.filter((validation) => validation.severity === 'warning').length
+    this.#errorCount = this.report.filter((validation) => validation.severity === 'error').length
+    this.#counted = true
   }
 }

package/src/modeling/ai/types.ts

@@ -1,4 +1,4 @@
-import type { IApiAssociationShape } from '../../amf/definitions/Shapes.js'
+import type { Shapes } from '@api-client/amf-core'
 import type { Exception } from '../../exceptions/exception.js'
 import type { AiSessionSchema } from '../../models/AiSession.js'
 import type { DomainPropertyType } from '../DataFormat.js'
@@ -150,7 +150,7 @@ export interface AiDomainAssociation {
   multiple?: boolean
   onDelete?: OnDeleteRule
   semantics?: AiDomainSemantic[]
-  schema?: IApiAssociationShape
+  schema?: Shapes.IApiAssociationShape
 }
 
 /**

package/src/{amf → modeling/amf}/DataValueGenerator.ts

@@ -1,6 +1,5 @@
-import { nanoid } from '../nanoid.js'
-import uuidV4 from '../lib/uuid.js'
-import { DomainPropertyType } from '../modeling/DataFormat.js'
+import { nanoid } from '../../nanoid.js'
+import { DomainPropertyType } from '../DataFormat.js'
 
 export const noValue = Symbol('noValue')
 
@@ -56,7 +55,7 @@ export class DataValueGenerator {
         // TODO: we need more settings controlling the random string generation.
         return nanoid(8)
       case 'uuid-v4':
-        return uuidV4()
+        return crypto.randomUUID()
       default:
         return noValue
     }