@api-client/core 0.18.49 → 0.18.50

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

@@ -42813,13 +42813,13 @@
 "@id": "#210"
 },
 {
-"@id": "#213"
+"@id": "#219"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
-"@id": "#219"
+"@id": "#216"
 }
 ],
 "doc:root": false,
@@ -44253,7 +44253,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44274,7 +44274,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44295,7 +44295,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -45121,17 +45121,17 @@
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#338/source-map/synthesized-field/element_1",

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.18.49",
+  "version": "0.18.50",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/mocking/README.md

@@ -0,0 +1,40 @@
+# Mocking Library (`src/mocking`)
+
+This directory contains the mocking infrastructure for the API Cloud Core. It provides realistic data generation for testing and demo purposes without requiring a real backend.
+
+## Key Components
+
+### `ProjectMock`
+The main entry point for mocking a project environment. It aggregates various sub-mocks to simulate a complete project context.
+
+**Usage:**
+```typescript
+import { ProjectMock } from './ProjectMock';
+
+const mock = new ProjectMock();
+// Access sub-mocks
+console.log(mock.user);
+console.log(mock.projectRequest);
+```
+
+### `ModelingMock` & `LegacyMock`
+Specialized mocks for specific domains:
+- `ModelingMock`: Logic for API domain modeling.
+- `LegacyMock`: Support for older systems or deprecated interfaces.
+
+## Directory Structure
+
+- **`lib/`**: Contains the individual mock implementations.
+    - `DataCatalog.ts`: Generates `DataCatalogSchema` objects using `faker`.
+    - `File.ts`, `User.ts`, `Request.ts`: Other domain-specific entities.
+    - **Pattern**: Classes in `lib/` usually provide methods like `entityName(init)` and `entityNames(size, init)` to generate single or multiple mock objects.
+- **`legacy/`**: Old mock implementations kept for backward compatibility. Use with caution.
+
+## Developing Mocks
+
+When adding a new mock:
+1. Create a class in `lib/` (e.g., `NewEntity.ts`).
+2. Use `@faker-js/faker` for realistic random data.
+3. Allow overrides via a partial `init` parameter.
+4. Export single and list generation methods.
+5. Register it in `ProjectMock.ts` if it belongs to the global project context.

package/src/mocking/lib/DataCatalog.ts

@@ -53,10 +53,10 @@ export class DataCatalog {
    * @param size Number of data catalogs to generate. Default is 25.
    * @returns List of random data catalogs
    */
-  dataCatalogs(size = 25): DataCatalogSchema[] {
+  dataCatalogs(size = 25, init?: Partial<DataCatalogSchema>): DataCatalogSchema[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.dataCatalog())
+      result.push(this.dataCatalog(init))
     }
     return result
   }
@@ -97,10 +97,10 @@ export class DataCatalog {
    * @param size Number of data catalog versions to generate. Default is 25.
    * @returns List of random data catalog versions.
    */
-  dataCatalogVersions(size = 25): DataCatalogVersionSchema[] {
+  dataCatalogVersions(size = 25, init?: Partial<DataCatalogVersionSchema>): DataCatalogVersionSchema[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.dataCatalogVersion())
+      result.push(this.dataCatalogVersion(init))
     }
     return result
   }
@@ -129,10 +129,10 @@ export class DataCatalog {
    * @param size Number of data catalogs to generate. Default is 3.
    * @returns List of random data catalogs with versions.
    */
-  dataCatalogsWithVersion(size = 3): DataCatalogSchemaWithVersion[] {
+  dataCatalogsWithVersion(size = 3, init?: Partial<DataCatalogSchemaWithVersion>): DataCatalogSchemaWithVersion[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.dataCatalogWithVersion())
+      result.push(this.dataCatalogWithVersion(init))
     }
     return result
   }
@@ -156,10 +156,10 @@ export class DataCatalog {
    * @param size Number of data catalog version info objects to generate. Default is 5.
    * @returns List of random data catalog version info objects.
    */
-  versionInfos(size = 5): DataCatalogVersionInfo[] {
+  versionInfos(size = 5, init?: Partial<DataCatalogVersionInfo>): DataCatalogVersionInfo[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.versionInfo())
+      result.push(this.versionInfo(init))
     }
     return result
   }

package/src/mocking/lib/File.ts

@@ -15,7 +15,7 @@ export class File {
       kind = faker.helpers.arrayElement([ProjectKind, DomainFileKind, CertificateFileKind, ApiFileKind] as const),
       info = { name: faker.system.fileName() },
     } = init
-    return CoreFile.createSchema({ kind, info })
+    return CoreFile.createSchema({ ...init, kind, info })
   }
 
   /**
@@ -23,10 +23,10 @@ export class File {
    * @param size Number of files to generate. Default is 25.
    * @returns List of random files
    */
-  files(size = 25): IFile[] {
+  files(size = 25, init?: Partial<IFile>): IFile[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.file())
+      result.push(this.file(init))
     }
     return result
   }
@@ -45,10 +45,10 @@ export class File {
    * @param size Number of folders to generate. Default is 25.
    * @returns List of random folders
    */
-  folders(size = 25): IFile[] {
+  folders(size = 25, init?: Partial<IFile>): IFile[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.folder())
+      result.push(this.folder(init))
     }
     return result
   }

package/src/mocking/lib/Group.ts

@@ -42,10 +42,10 @@ export class Group {
    * @param size Number of organizations to generate. Default is 25.
    * @returns List of random organizations
    */
-  groups(size = 25): GroupSchema[] {
+  groups(size = 25, init?: Partial<GroupSchema>): GroupSchema[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.group())
+      result.push(this.group(init))
     }
     return result
   }

package/src/mocking/lib/Invitation.ts

@@ -48,10 +48,10 @@ export class Invitation {
    * @param size Number of invitations to generate. Default is 25.
    * @returns List of random invitations
    */
-  invitations(size = 25): InvitationSchema[] {
+  invitations(size = 25, init?: Partial<InvitationSchema>): InvitationSchema[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.invitation())
+      result.push(this.invitation(init))
     }
     return result
   }

package/src/mocking/lib/Organization.ts

@@ -32,10 +32,10 @@ export class Organization {
    * @param size Number of organizations to generate. Default is 25.
    * @returns List of random organizations
    */
-  organizations(size = 25): IOrganization[] {
+  organizations(size = 25, init?: Partial<IOrganization>): IOrganization[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.organization())
+      result.push(this.organization(init))
     }
     return result
   }

package/src/mocking/lib/Patch.ts

@@ -41,10 +41,10 @@ export class Patch {
    * @param size Number of invitations to generate. Default is 25.
    * @returns List of random invitations
    */
-  mediaPatchRevisions(size = 25): MediaPatchRevision[] {
+  mediaPatchRevisions(size = 25, init?: Partial<MediaPatchRevision>): MediaPatchRevision[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.mediaPatchRevision())
+      result.push(this.mediaPatchRevision(init))
     }
     return result
   }

package/src/mocking/lib/Trash.ts

@@ -37,10 +37,10 @@ export class Trash {
    * @param size Number of invitations to generate. Default is 25.
    * @returns List of random invitations
    */
-  trashEntries(size = 25): CoreTrashEntry[] {
+  trashEntries(size = 25, init?: Partial<CoreTrashEntry>): CoreTrashEntry[] {
     const result = []
     for (let i = 0; i < size; i++) {
-      result.push(this.trashEntry())
+      result.push(this.trashEntry(init))
     }
     return result
   }

package/src/models/README.md

@@ -7,14 +7,15 @@
 Data models should only contain the data related to the functionality, and not view.
 Each application should keep separate metadata related to the view configuration.
 
-### Translatable from a YAML format
-
-We aim to be interoperable with AMF so when designing a data model first design a YAML example with the data and then create a type definition. Additionally, you need to design an AML dialect for the data.
-
 ### The "kind" as the object type identifier
 
 Each data object that can exist by itself or in multiple contexts' should contain the `kind` property that uniquely identifies the type. For example, the `HttpProject` class has the `Core#HttpProject`. These kinds are used by other libraries to identify which data types they are given as the input.
+Kinds are defined in the `src/models/kinds.ts` file.
 
 ### Validation
 
 THe data models should contain validators that produce the validation report. This ensures the support libraries can perform a validation of the data model they are receiving as an input to keep integrity of the data.
+
+## The "store" models
+
+All models under the `src/models/store` directory are considered "API" related models. For example, the `File` model is used to describe the file object in the API, but it is not used as any application's core data model. 

package/tests/unit/mocking/current/DataCatalog.spec.ts

@@ -138,6 +138,13 @@ test.group('dataCatalogs()', (group) => {
     catalog.dataCatalogs(5)
     assert.equal(spy.callCount, 5)
   })
+
+  test('uses passed initialization values', ({ assert }) => {
+    const result = catalog.dataCatalogs(3, { name: 'Batch Catalog' })
+    result.forEach((item) => {
+      assert.equal(item.name, 'Batch Catalog')
+    })
+  })
 })
 
 test.group('dataCatalogVersion()', (group) => {
@@ -265,6 +272,13 @@ test.group('dataCatalogVersions()', (group) => {
     catalog.dataCatalogVersions(3)
     assert.equal(spy.callCount, 3)
   })
+
+  test('uses passed initialization values', ({ assert }) => {
+    const result = catalog.dataCatalogVersions(3, { version: 'v1.2.3' })
+    result.forEach((item) => {
+      assert.equal(item.version, 'v1.2.3')
+    })
+  })
 })
 
 test.group('dataCatalogWithVersion()', (group) => {
@@ -372,6 +386,13 @@ test.group('dataCatalogsWithVersion()', (group) => {
       assert.isAtLeast(item.versions.length, 1)
     })
   })
+
+  test('uses passed initialization values', ({ assert }) => {
+    const result = catalog.dataCatalogsWithVersion(3, { name: 'Versioned Batch' })
+    result.forEach((item) => {
+      assert.equal(item.name, 'Versioned Batch')
+    })
+  })
 })
 
 test.group('versionInfo()', (group) => {
@@ -446,4 +467,11 @@ test.group('versionInfos()', (group) => {
     catalog.versionInfos(6)
     assert.equal(spy.callCount, 6)
   })
+
+  test('uses passed initialization values', ({ assert }) => {
+    const result = catalog.versionInfos(3, { version: 'v9.9.9' })
+    result.forEach((item) => {
+      assert.equal(item.version, 'v9.9.9')
+    })
+  })
 })

package/tests/unit/mocking/current/File.spec.ts

@@ -0,0 +1,79 @@
+import { test } from '@japa/runner'
+import { File } from '../../../../src/mocking/lib/File.js'
+import { FolderKind, ProjectKind } from '../../../../src/models/kinds.js'
+import type { IFile } from '../../../../src/models/store/File.js'
+
+test.group('File', (group) => {
+  let fileMock: File
+
+  group.each.setup(() => {
+    fileMock = new File()
+  })
+
+  test('file() returns a valid object', ({ assert }) => {
+    const result = fileMock.file()
+    assert.typeOf(result, 'object')
+    assert.property(result, 'kind')
+    assert.property(result, 'info')
+  })
+
+  test('file(init) allows overriding properties', ({ assert }) => {
+    const init: Partial<IFile> = {
+      kind: ProjectKind,
+      info: { name: 'My Project' },
+    }
+    const result = fileMock.file(init)
+    assert.equal(result.kind, ProjectKind)
+    assert.equal(result.info.name, 'My Project')
+  })
+
+  test('files() returns a list', ({ assert }) => {
+    const result = fileMock.files(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+  })
+
+  test('files(size, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<IFile> = {
+      kind: ProjectKind,
+    }
+    const result = fileMock.files(3, init)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.kind, ProjectKind)
+    })
+  })
+
+  test('folder() returns a valid object', ({ assert }) => {
+    const result = fileMock.folder()
+    assert.typeOf(result, 'object')
+    assert.equal(result.kind, FolderKind)
+  })
+
+  test('folder(init) allows overriding properties', ({ assert }) => {
+    const init: Partial<IFile> = {
+      key: 'custom-folder-key',
+    }
+    const result = fileMock.folder(init)
+    assert.equal(result.kind, FolderKind)
+    assert.equal(result.key, 'custom-folder-key')
+  })
+
+  test('folders() returns a list', ({ assert }) => {
+    const result = fileMock.folders(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+  })
+
+  test('folders(size, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<IFile> = {
+      key: 'batch-key',
+    }
+    const result = fileMock.folders(3, init)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.kind, FolderKind)
+      assert.equal(item.key, 'batch-key')
+    })
+  })
+})

package/tests/unit/mocking/current/Group.spec.ts

@@ -0,0 +1,49 @@
+import { test } from '@japa/runner'
+import { Group } from '../../../../src/mocking/lib/Group.js'
+import { GroupKind } from '../../../../src/models/kinds.js'
+import type { GroupSchema } from '../../../../src/models/store/Group.js'
+
+test.group('Group', (group) => {
+  let groupMock: Group
+
+  group.each.setup(() => {
+    groupMock = new Group()
+  })
+
+  test('group() returns a valid object', ({ assert }) => {
+    const result = groupMock.group()
+    assert.typeOf(result, 'object')
+    assert.equal(result.kind, GroupKind)
+    assert.property(result, 'key')
+    assert.property(result, 'name')
+    assert.property(result, 'color')
+    assert.property(result, 'users')
+  })
+
+  test('group(init) allows overriding properties', ({ assert }) => {
+    const init: Partial<GroupSchema> = {
+      name: 'Custom Group',
+      color: '#ff0000',
+    }
+    const result = groupMock.group(init)
+    assert.equal(result.name, 'Custom Group')
+    assert.equal(result.color, '#ff0000')
+  })
+
+  test('groups() returns a list', ({ assert }) => {
+    const result = groupMock.groups(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+  })
+
+  test('groups(size, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<GroupSchema> = {
+      description: 'Batch Description',
+    }
+    const result = groupMock.groups(3, init)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.description, 'Batch Description')
+    })
+  })
+})

package/tests/unit/mocking/current/Invitation.spec.ts

@@ -0,0 +1,49 @@
+import { test } from '@japa/runner'
+import { Invitation } from '../../../../src/mocking/lib/Invitation.js'
+import { InvitationKind } from '../../../../src/models/kinds.js'
+import type { InvitationSchema } from '../../../../src/models/store/Invitation.js'
+
+test.group('Invitation', (group) => {
+  let invitation: Invitation
+
+  group.each.setup(() => {
+    invitation = new Invitation()
+  })
+
+  test('invitation() returns a valid object', ({ assert }) => {
+    const result = invitation.invitation()
+    assert.typeOf(result, 'object')
+    assert.equal(result.kind, InvitationKind)
+    assert.property(result, 'key')
+    assert.property(result, 'email')
+    assert.property(result, 'token')
+    assert.property(result, 'status')
+  })
+
+  test('invitation(init) allows overriding properties', ({ assert }) => {
+    const init: Partial<InvitationSchema> = {
+      email: 'test@example.com',
+      status: 'accepted',
+    }
+    const result = invitation.invitation(init)
+    assert.equal(result.email, 'test@example.com')
+    assert.equal(result.status, 'accepted')
+  })
+
+  test('invitations() returns a list', ({ assert }) => {
+    const result = invitation.invitations(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+  })
+
+  test('invitations(size, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<InvitationSchema> = {
+      status: 'declined',
+    }
+    const result = invitation.invitations(3, init)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.status, 'declined')
+    })
+  })
+})

package/tests/unit/mocking/current/Organization.spec.ts

@@ -0,0 +1,50 @@
+import { test } from '@japa/runner'
+import { Organization } from '../../../../src/mocking/lib/Organization.js'
+import { OrganizationKind } from '../../../../src/models/kinds.js'
+import type { IOrganization } from '../../../../src/models/store/Organization.js'
+
+test.group('Organization', (group) => {
+  let organization: Organization
+
+  group.each.setup(() => {
+    organization = new Organization()
+  })
+
+  test('organization() returns a valid object', ({ assert }) => {
+    const result = organization.organization()
+    assert.typeOf(result, 'object')
+    assert.equal(result.kind, OrganizationKind)
+    assert.property(result, 'key')
+    assert.property(result, 'name')
+    assert.property(result, 'createdBy')
+    assert.property(result, 'createdDate')
+    assert.property(result, 'grantType')
+  })
+
+  test('organization(init) allows overriding properties', ({ assert }) => {
+    const init: Partial<IOrganization> = {
+      key: 'custom-org-key',
+      name: 'Custom Org',
+    }
+    const result = organization.organization(init)
+    assert.equal(result.key, 'custom-org-key')
+    assert.equal(result.name, 'Custom Org')
+  })
+
+  test('organizations() returns a list', ({ assert }) => {
+    const result = organization.organizations(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+  })
+
+  test('organizations(size, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<IOrganization> = {
+      name: 'Batch Org',
+    }
+    const result = organization.organizations(3, init)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.name, 'Batch Org')
+    })
+  })
+})

package/tests/unit/mocking/current/Patch.spec.ts

@@ -0,0 +1,47 @@
+import { test } from '@japa/runner'
+import { Patch } from '../../../../src/mocking/lib/Patch.js'
+import type { MediaPatchRevision } from '../../../../src/patch/types.js'
+
+test.group('Patch', (group) => {
+  let patch: Patch
+
+  group.each.setup(() => {
+    patch = new Patch()
+  })
+
+  test('mediaPatchRevision() returns a valid object', ({ assert }) => {
+    const result = patch.mediaPatchRevision()
+    assert.typeOf(result, 'object')
+    assert.property(result, 'id')
+    assert.property(result, 'timestamp')
+    assert.property(result, 'patch')
+    assert.property(result, 'version')
+  })
+
+  test('mediaPatchRevision(init) allows overriding properties', ({ assert }) => {
+    const init: Partial<MediaPatchRevision> = {
+      id: 'custom-id',
+      version: 99,
+    }
+    const result = patch.mediaPatchRevision(init)
+    assert.equal(result.id, 'custom-id')
+    assert.equal(result.version, 99)
+  })
+
+  test('mediaPatchRevisions() returns a list', ({ assert }) => {
+    const result = patch.mediaPatchRevisions(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+  })
+
+  test('mediaPatchRevisions(size, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<MediaPatchRevision> = {
+      version: 123,
+    }
+    const result = patch.mediaPatchRevisions(3, init)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.version, 123)
+    })
+  })
+})

package/tests/unit/mocking/current/Trash.spec.ts

@@ -0,0 +1,49 @@
+import { test } from '@japa/runner'
+import { Trash } from '../../../../src/mocking/lib/Trash.js'
+import { ProjectKind } from '../../../../src/models/kinds.js'
+import type { TrashEntry } from '../../../../src/models/TrashEntry.js'
+
+test.group('Trash', (group) => {
+  let trash: Trash
+
+  group.each.setup(() => {
+    trash = new Trash()
+  })
+
+  test('trashEntry() returns a valid object', ({ assert }) => {
+    const result = trash.trashEntry()
+    assert.typeOf(result, 'object')
+    assert.property(result, 'key')
+    assert.property(result, 'refKey')
+    assert.property(result, 'kind')
+    assert.property(result, 'info')
+    assert.property(result, 'capabilities')
+  })
+
+  test('trashEntry(init) allows overriding properties', ({ assert }) => {
+    const init: Partial<TrashEntry> = {
+      key: 'custom-key',
+      kind: ProjectKind,
+    }
+    const result = trash.trashEntry(init)
+    assert.equal(result.key, 'custom-key')
+    assert.equal(result.kind, ProjectKind)
+  })
+
+  test('trashEntries() returns a list', ({ assert }) => {
+    const result = trash.trashEntries(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+  })
+
+  test('trashEntries(size, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<TrashEntry> = {
+      kind: ProjectKind,
+    }
+    const result = trash.trashEntries(3, init)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.kind, ProjectKind)
+    })
+  })
+})