@api-client/core 0.14.5 → 0.14.7

package/data/models/example-generator-api.json

@@ -42068,13 +42068,13 @@
 "@id": "#194"
 },
 {
-"@id": "#197"
+"@id": "#203"
 },
 {
-"@id": "#200"
+"@id": "#197"
 },
 {
-"@id": "#203"
+"@id": "#200"
 },
 {
 "@id": "#206"
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43499,7 +43499,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43520,7 +43520,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44766,12 +44766,12 @@
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_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.5",
+  "version": "0.14.7",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/amf/ApiSchemaValues.ts

@@ -15,7 +15,7 @@ import {
   IApiScalarShape,
   IShapeUnion,
 } from './definitions/Shapes.js'
-import { ILoremWordInit, ITypeHashInit, ITypeNumberInit } from '@pawel-up/data-mock/types.js'
+import type { ILoremWordInit, ITypeHashInit, ITypeNumberInit } from '@pawel-up/data-mock/types.js'
 
 export interface IApiSchemaReadOptions {
   /**

package/src/modeling/ApiModel.ts

@@ -1,18 +1,20 @@
 import { nanoid } from '../nanoid.js'
-import { ApiModelKind } from '../models/kinds.js'
+import { ApiModelKind, DataDomainKind } from '../models/kinds.js'
 import { type IThing, Thing } from '../models/Thing.js'
 import type {
   AccessRule,
   AuthenticationConfiguration,
   AuthorizationConfiguration,
   ExposedEntity,
-  ForeignDomainDependency,
   RateLimitingConfiguration,
+  RolesBasedAccessControl,
   SessionConfiguration,
+  UsernamePasswordConfiguration,
 } from './types.js'
-import { DataDomain, type DataDomainSchema } from './DataDomain.js'
+import { DataDomain } from './DataDomain.js'
+import { DependentModel, type DomainDependency, type DependentModelSchema } from './DependentModel.js'
 
-export interface ApiModelSchema {
+export interface ApiModelSchema extends DependentModelSchema {
   /**
    * The data domain kind recognizable by the ecosystem.
    */
@@ -35,12 +37,6 @@ export interface ApiModelSchema {
    */
   userKey?: string
 
-  /**
-   * Reference to the stable, version-controlled data definition from the
-   * Data Catalog. When not set, the model cannot be published.
-   */
-  domain?: ForeignDomainDependency
-
   /**
    * Configuration for how users prove their identity.
    * The API model is invalid if this is not set.
@@ -80,7 +76,7 @@ export interface ApiModelSchema {
   rateLimiting?: RateLimitingConfiguration
 }
 
-export class ApiModel extends EventTarget {
+export class ApiModel extends DependentModel {
   /**
    * The data domain kind recognizable by the ecosystem.
    */
@@ -103,12 +99,6 @@ export class ApiModel extends EventTarget {
    */
   userKey?: string
 
-  /**
-   * Reference to the stable, version-controlled data definition from the
-   * Data Catalog. When not set, the model cannot be published.
-   */
-  domain?: ForeignDomainDependency
-
   /**
    * Configuration for how users prove their identity.
    * The API model is invalid if this is not set.
@@ -161,9 +151,20 @@ export class ApiModel extends EventTarget {
   #notifying = false
 
   /**
-   * A reference to the published data domain.
+   * A convenience getter that returns the DataDomain associated with this API model.
+   * Since the API model can have only one DataDomain,
+   * this getter returns the first dependency in the list.
+   *
+   * The parent interface `DependentModel` allows for multiple dependencies,
+   * to unify the dependency management across different models.
    */
-  dataDomain?: DataDomain
+  get domain(): DataDomain | undefined {
+    if (this.dependencyList.length === 0) {
+      return undefined
+    }
+    const domain = this.dependencyList[0]
+    return this.dependencies.get(domain.key)
+  }
 
   static createSchema(input: Partial<ApiModelSchema> = {}): ApiModelSchema {
     const { key = nanoid(), exposes = [] } = input
@@ -177,8 +178,8 @@ export class ApiModel extends EventTarget {
     if (input.userKey) {
       result.userKey = input.userKey
     }
-    if (input.domain) {
-      result.domain = input.domain
+    if (input.dependencyList) {
+      result.dependencyList = structuredClone(input.dependencyList)
     }
     if (input.authentication) {
       result.authentication = input.authentication
@@ -198,16 +199,21 @@ export class ApiModel extends EventTarget {
     return result
   }
 
-  constructor(state?: Partial<ApiModelSchema>, domain?: DataDomainSchema) {
-    super()
+  constructor(state?: Partial<ApiModelSchema>, domain?: DomainDependency) {
     const init = ApiModel.createSchema(state)
+    const instances: DataDomain[] = []
+    if (domain instanceof DataDomain) {
+      instances.push(domain)
+    } else if (typeof domain === 'object' && domain.kind === DataDomainKind) {
+      instances.push(new DataDomain(domain))
+    } else if (domain) {
+      throw new Error(`Invalid domain provided. Expected a DataDomain instance or schema.`)
+    }
+    super(init.dependencyList, instances)
     this.kind = init.kind
     this.key = init.key
     this.info = new Thing(init.info)
     this.userKey = init.userKey
-    if (init.domain) {
-      this.domain = structuredClone(init.domain)
-    }
     if (init.authentication) {
       this.authentication = structuredClone(init.authentication)
     }
@@ -228,9 +234,6 @@ export class ApiModel extends EventTarget {
     if (init.rateLimiting) {
       this.rateLimiting = structuredClone(init.rateLimiting)
     }
-    if (domain) {
-      this.dataDomain = new DataDomain(domain)
-    }
     this.#initializing = false
     this.info.addEventListener('change', () => {
       this.notifyChange()
@@ -247,8 +250,8 @@ export class ApiModel extends EventTarget {
     if (this.userKey) {
       result.userKey = this.userKey
     }
-    if (this.domain) {
-      result.domain = structuredClone(this.domain)
+    if (this.dependencyList.length > 0) {
+      result.dependencyList = structuredClone(this.dependencyList)
     }
     if (this.authentication) {
       result.authentication = structuredClone(this.authentication)
@@ -324,4 +327,44 @@ export class ApiModel extends EventTarget {
   getExposedEntity(entityKey: string): ExposedEntity | undefined {
     return this.exposes.find((e) => e.key === entityKey)
   }
+
+  /**
+   * Clears the API model for a new entity change.
+   * This method resets the dependencies, exposes, userKey,
+   * authentication, authorization, and session properties.
+   */
+  cleanForEntityChange(): void {
+    this.dependencies.clear()
+    this.dependencyList = []
+    this.exposes = []
+    this.userKey = undefined
+    if (this.session) {
+      this.session.properties = []
+    }
+    if (this.authentication && this.authentication.strategy === 'UsernamePassword') {
+      const typed = this.authentication as UsernamePasswordConfiguration
+      typed.passwordKey = undefined
+    }
+    if (this.authorization && this.authorization.strategy == 'RBAC') {
+      const typed = this.authorization as RolesBasedAccessControl
+      typed.roleKey = ''
+    }
+  }
+
+  /**
+   * Attaches a DataDomain to this API model.
+   * This method clears any existing dependencies and sets the new domain.
+   *
+   * @param domain The DataDomain to attach to this API model.
+   * @throws Error if the domain does not have a version set in its info.
+   */
+  attachDataDomain(domain: DataDomain): void {
+    if (!domain.info.version) {
+      throw new Error(`Cannot attach DataDomain without a version. Please set the version in the domain info.`)
+    }
+    this.cleanForEntityChange()
+    this.dependencies.set(domain.key, domain)
+    this.dependencyList = [{ key: domain.key, version: domain.info.version }]
+    this.notifyChange()
+  }
 }

package/src/modeling/DataDomain.ts

@@ -8,13 +8,7 @@ import {
   DomainNamespaceKind,
   DomainPropertyKind,
 } from '../models/kinds.js'
-import type {
-  AssociationAddOptions,
-  DomainGraphEdge,
-  DomainGraphNodeType,
-  ForeignDomainDependency,
-  SerializedGraph,
-} from './types.js'
+import type { AssociationAddOptions, DomainGraphEdge, DomainGraphNodeType, SerializedGraph } from './types.js'
 import { type DomainNamespaceSchema, DomainNamespace, type NamespaceOrderedItem } from './DomainNamespace.js'
 import { type DomainModelSchema, DomainModel } from './DomainModel.js'
 import { type DomainEntitySchema, DomainEntity } from './DomainEntity.js'
@@ -23,13 +17,13 @@ import { DomainProperty, DomainPropertySchema } from './DomainProperty.js'
 import { type IThing, Thing } from '../models/Thing.js'
 import { removeGraphNode } from './GraphUtils.js'
 import { serialize, deserialize, mergeGraph, removeForeignGraph } from './DomainSerialization.js'
+import { DependentModel, type DependentModelSchema, type DomainDependency } from './DependentModel.js'
 
-export interface DataDomainSchema {
+export interface DataDomainSchema extends DependentModelSchema {
   info: IThing
   kind: typeof DataDomainKind
   key: string
   graph?: SerializedGraph
-  dependencyList?: ForeignDomainDependency[]
   /**
    * The ordered list of fields (namespace and models) in the schema.
    * These only keep references to define the order of these properties
@@ -104,7 +98,7 @@ export interface DataDomainSchema {
  * @todo: Implement a mechanism to move an entity to a new
  * parent model.
  */
-export class DataDomain extends EventTarget {
+export class DataDomain extends DependentModel {
   /**
    * The kind of the domain element.
    */
@@ -119,18 +113,6 @@ export class DataDomain extends EventTarget {
    */
   graph: Graph<unknown, DomainGraphNodeType, DomainGraphEdge>
 
-  /**
-   * A map of foreign data domains.
-   * Key: The unique identifier of the foreign domain.
-   * Value: The foreign DataDomain instance.
-   */
-  dependencies: Map<string, DataDomain> = new Map<string, DataDomain>()
-
-  /**
-   * The list of foreign domain dependencies.
-   */
-  dependencyList: ForeignDomainDependency[] = []
-
   /**
    * The description of the domain property.
    */
@@ -196,13 +178,24 @@ export class DataDomain extends EventTarget {
    * @param state The previously serialized state of the graph.
    * @param dependencies An array of foreign data domains to register with this domain.
    */
-  constructor(state?: Partial<DataDomainSchema>, dependencies?: DataDomain[]) {
-    super()
+  constructor(state?: Partial<DataDomainSchema>, dependencies: DomainDependency[] = []) {
     const init = DataDomain.createSchema(state)
+    const instances: DataDomain[] = []
+    for (const dep of dependencies) {
+      if (dep instanceof DataDomain) {
+        instances.push(dep)
+      } else if (typeof dep === 'object' && dep.kind === DataDomainKind && dep.key) {
+        const domain = new DataDomain(dep)
+        instances.push(domain)
+      } else {
+        throw new Error(`Invalid foreign domain dependency: ${dep}`)
+      }
+    }
+    super(init.dependencyList, instances)
     this.kind = init.kind
     this.key = init.key
     this.info = new Thing(init.info)
-    this.graph = deserialize(this, init.graph, dependencies)
+    this.graph = deserialize(this, init.graph, instances)
     if (Array.isArray(init.fields)) {
       this.fields = [...init.fields]
     } else {

package/src/modeling/DependentModel.ts

@@ -0,0 +1,36 @@
+import type { DataDomain, DataDomainSchema } from './DataDomain.js'
+import type { ForeignDomainDependency } from './types.js'
+
+export type DomainDependency = DataDomain | DataDomainSchema
+
+export interface DependentModelSchema {
+  /**
+   * A list of foreign domain dependencies.
+   */
+  dependencyList?: ForeignDomainDependency[]
+}
+
+/**
+ * A base model that has dependencies on foreign data domains.
+ */
+export class DependentModel extends EventTarget {
+  /**
+   * A map of foreign data domains.
+   * Key: The unique identifier of the foreign domain.
+   * Value: The foreign DataDomain instance.
+   */
+  dependencies: Map<string, DataDomain> = new Map<string, DataDomain>()
+
+  /**
+   * The list of foreign domain dependencies.
+   */
+  dependencyList: ForeignDomainDependency[] = []
+
+  constructor(items: ForeignDomainDependency[] = [], instances: DataDomain[] = []) {
+    super()
+    this.dependencyList = [...items]
+    for (const dep of instances) {
+      this.dependencies.set(dep.key, dep)
+    }
+  }
+}

package/src/modeling/types.ts

@@ -337,6 +337,8 @@ export interface SessionConfiguration {
   /**
    * The properties from the `User` entity to be encoded into the session payload (JWT/cookie).
    * These properties become available in the `request.auth` object at runtime.
+   *
+   * In practice, these are the ids of the properties in the `User` entity.
    */
   properties: string[]
   /**

package/src/models/store/Backend.ts

@@ -1,180 +1,4 @@
 import type { PatchInfo } from '../../patch/types.js'
-import { type IPatchRevision } from '../../events/BaseEvents.js'
-import { type IHttpHistory, Kind as HttpHistoryKind } from '../HttpHistory.js'
-import { Kind as ProjectExecutionKind } from '../ProjectExecution.js'
-import type { IFile } from './File.js'
-import type { IPermission } from './Permission.js'
-import type { IRevision } from './Revision.js'
-/**
- * @deprecated
- */
-export enum BackendCommandType {
-  observe,
-  unobserve,
-}
-/**
- * @deprecated
- */
-export const BackendCommandKind = 'Core#BackendCommand'
-/**
- * @deprecated
- */
-export interface IBackendCommand {
-  kind: typeof BackendCommandKind
-  cmd: BackendCommandType
-}
-/**
- * @deprecated
- */
-export interface IBackendObserveCommand extends IBackendCommand {
-  path: string // includes query parameters
-}
-/**
- * @deprecated
- */
-export interface BroadcastEvent {
-  type: 'event'
-  operation: string
-  kind: string
-  key: string
-  path: string
-  organization: string // empty string for `/organizations`
-}
-/**
- * @deprecated
- */
-export interface BackendErrorEvent {
-  type: 'error'
-  cause: string
-  time: number
-}
-/**
- * @deprecated
- */
-export interface ClearedBroadcastEvent {
-  type: 'event'
-  operation: 'cleared'
-  name: string
-  organization: string
-  path: string
-}
-/**
- * @deprecated
- */
-export interface BroadcastFileData {
-  parent?: string
-}
-/**
- * @deprecated
- */
-export interface BroadcastCreatedEvent extends BroadcastEvent {
-  operation: 'created'
-  data: unknown
-  // path: string; -> /files, /certificates, /history, /project/executions, /organizations, /trash
-}
-/**
- * @deprecated
- */
-export interface FileCreatedBroadcastEvent extends BroadcastCreatedEvent, BroadcastFileData {}
-/**
- * @deprecated
- */
-export interface FileMetaCreatedBroadcastEvent extends FileCreatedBroadcastEvent {
-  data: IFile
-  alt: 'meta'
-}
-/**
- * @deprecated
- */
-export interface FileMediaCreatedBroadcastEvent extends FileCreatedBroadcastEvent {
-  alt: 'media'
-}
-/**
- * @deprecated
- */
-export interface HistoryCreatedBroadcastEvent extends BroadcastCreatedEvent {
-  project: string
-  request: string
-  app: string
-  kind: typeof HttpHistoryKind
-  data: IHttpHistory
-}
-/**
- * @deprecated
- */
-export interface FileRevisionCreatedBroadcastEvent extends BroadcastCreatedEvent, BroadcastFileData {
-  parent: string
-  data: IRevision
-}
-/**
- * @deprecated
- */
-export interface ProjectExecutionCreatedBroadcastEvent extends BroadcastCreatedEvent {
-  project: string
-  kind: typeof ProjectExecutionKind
-}
-/**
- * @deprecated
- */
-export interface BroadcastPatchEvent extends BroadcastEvent {
-  operation: 'patch'
-  data: IPatchRevision
-  // path: string; -> /files, /organizations
-}
-/**
- * @deprecated
- */
-export interface FilePatchBroadcastEvent extends BroadcastPatchEvent, BroadcastFileData {}
-
-/**
- * @deprecated
- */
-export interface AccessBroadcastEvent extends BroadcastEvent {
-  operation: 'access-granted' | 'access-removed'
-  data?: IPermission
-  // path: string; -> /files, /organizations, /organizations
-}
-
-/**
- * @deprecated
- */
-export interface FileAccessBroadcastEvent extends AccessBroadcastEvent {
-  parent?: string
-}
-
-/**
- * @deprecated
- */
-export interface DeletedBroadcastEvent extends BroadcastEvent {
-  operation: 'deleted'
-  // path: string; -> /files, /certificates, /history, /project/executions, /organizations, /trash
-}
-
-/**
- * @deprecated
- */
-export interface FileDeletedBroadcastEvent extends DeletedBroadcastEvent, BroadcastFileData {
-  /**
-   * The key of the created trash entry for the deleted object.
-   * This is **always** populated when the file alt is `meta`.
-   */
-  trash?: string
-}
-
-/**
- * @deprecated
- */
-export interface ProjectExecutionDeleteBroadcastEvent extends DeletedBroadcastEvent {
-  project: string
-}
-
-/**
- * @deprecated
- */
-export interface HistoryDeletedBroadcastEvent extends DeletedBroadcastEvent {
-  project: string
-  request: string
-}
 
 export interface ServerEvent {
   kind: string

package/src/sdk/RouteBuilder.ts

@@ -296,7 +296,7 @@ export class RouteBuilder {
     return `/v1/orgs/${oid}/groups/${gid}`
   }
 
-  static groupUsers(oid: string, gid: string): string | undefined {
+  static groupUsers(oid: string, gid: string): string {
     return `/v1/orgs/${oid}/groups/${gid}/users`
   }
 }