@api-client/core 0.18.38 → 0.18.40

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

@@ -42813,10 +42813,10 @@
 "@id": "#210"
 },
 {
-"@id": "#213"
+"@id": "#216"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
 "@id": "#219"
@@ -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'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -45121,12 +45121,12 @@
 {
 "@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)-(6,0)]"
 },
 {
 "@id": "#221/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.18.38",
+  "version": "0.18.40",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -87,12 +87,13 @@
     "@api-client/graph": "^0.3.5",
     "@api-client/json": "^0.2.0",
     "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@faker-js/faker": "^10.1.0",
+    "@jarrodek/amw": "^0.1.1",
     "@jarrodek/pluralize": "^1.0.2",
     "@metrichor/jmespath": "^0.3.1",
     "@pawel-up/csv": "^0.2.0",
     "@pawel-up/data-mock": "^0.4.0",
     "@pawel-up/jexl": "^4.0.1",
-    "@types/sinon": "^21.0.0",
     "@xmldom/xmldom": "^0.8.11",
     "amf-json-ld-lib": "^0.0.15",
     "chalk": "^5.4.1",
@@ -100,7 +101,6 @@
     "dompurify": "^3.2.6",
     "jsdom": "^27.0.0",
     "nanoid": "^5.1.5",
-    "sinon": "^21.0.0",
     "tslog": "^4.9.3",
     "ws": "^8.12.0",
     "xpath": "^0.0.34"
@@ -123,6 +123,7 @@
     "@types/json-schema": "^7.0.15",
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.0.1",
+    "@types/sinon": "^21.0.0",
     "@web/dev-server": "^0.4.6",
     "@web/dev-server-rollup": "^0.6.4",
     "@web/test-runner": "^0.20.0",
@@ -130,7 +131,8 @@
     "amf-client-js": "^5.9.1-3",
     "c8": "^10.1.3",
     "chai-as-promised": "^8.0.2",
-    "conventional-changelog-cli": "^5.0.0",
+    "conventional-changelog": "^7.1.0",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
     "cors": "^2.8.5",
     "eslint": "^9.20.1",
     "eslint-config-prettier": "^10.0.1",
@@ -145,6 +147,7 @@
     "oauth2-mock-server": "^8.0.0",
     "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",

package/src/mocking/ModelingMock.ts

@@ -0,0 +1,19 @@
+import { faker, type Faker } from '@faker-js/faker'
+import { Organization } from './lib/Organization.js'
+import { Group } from './lib/Group.js'
+import { User } from './lib/User.js'
+import { File } from './lib/File.js'
+import { Invitation } from './lib/Invitation.js'
+import { Trash } from './lib/Trash.js'
+import { Patch } from './lib/Patch.js'
+
+export class ModelingMock {
+  faker: Faker = faker
+  organization = new Organization()
+  group = new Group()
+  user = new User()
+  file = new File()
+  invitation = new Invitation()
+  trash = new Trash()
+  patch = new Patch()
+}

package/src/mocking/ProjectMock.ts

@@ -29,7 +29,7 @@ export class ProjectMock extends DataMock {
     super(init)
     this.projectRequest = new Request(init)
     this.response = new Response(init)
-    this.user = new User(init)
+    this.user = new User()
     this.history = new History(init)
     this.url = new Url(init)
     this.certificates = new Certificates(init)

package/src/mocking/lib/File.ts

@@ -0,0 +1,72 @@
+import { faker } from '@faker-js/faker'
+import { ProjectKind, DomainFileKind, CertificateFileKind, FolderKind, ApiFileKind } from '../../models/kinds.js'
+import { File as CoreFile, type IFile, type FileBreadcrumb } from '../../models/store/File.js'
+import { nanoid } from '../../nanoid.js'
+
+export class File {
+  /**
+   * Generates a random file object.
+   * @param init Optional values to be present in the object.
+   * @returns Random file
+   */
+  file(init: Partial<IFile> = {}): IFile {
+    const {
+      kind = faker.helpers.arrayElement([ProjectKind, DomainFileKind, CertificateFileKind, ApiFileKind] as const),
+      info = { name: faker.system.fileName() },
+    } = init
+    return CoreFile.createSchema({ kind, info })
+  }
+
+  /**
+   * Generates a list of random file objects.
+   * @param size Number of files to generate. Default is 25.
+   * @returns List of random files
+   */
+  files(size = 25): IFile[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.file())
+    }
+    return result
+  }
+
+  /**
+   * Generates a random folder object.
+   * @param init Optional values to be present in the object.
+   * @returns Random folder
+   */
+  folder(init: Partial<IFile> = {}): IFile {
+    return this.file({ kind: FolderKind, ...init })
+  }
+
+  /**
+   * Generates a list of random folder objects.
+   * @param size Number of folders to generate. Default is 25.
+   * @returns List of random folders
+   */
+  folders(size = 25): IFile[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.folder())
+    }
+    return result
+  }
+
+  /**
+   * Generates a random file breadcrumb object.
+   * @param size Optional depth of the breadcrumb. Default is random between 2-3.
+   * @returns Random file breadcrumb
+   */
+  fileBreadcrumbs(size?: number): FileBreadcrumb[] {
+    const depth = size ?? 2 + Math.floor(Math.random() * 2) // 2-3
+    const items: FileBreadcrumb[] = []
+    for (let i = 0; i < depth; i += 1) {
+      const kind =
+        i === depth - 1
+          ? faker.helpers.arrayElement([ProjectKind, DomainFileKind, CertificateFileKind, ApiFileKind] as const)
+          : FolderKind
+      items.push({ key: nanoid(), kind, name: faker.system.fileName() })
+    }
+    return items
+  }
+}

package/src/mocking/lib/Group.ts

@@ -0,0 +1,52 @@
+import { faker } from '@faker-js/faker'
+import { GroupKind } from '../../models/kinds.js'
+import { nanoid } from '../../nanoid.js'
+import type { GroupSchema } from '../../models/store/Group.js'
+
+export class Group {
+  /**
+   * Generates a random organization object.
+   * @param init Optional values to be present in the object.
+   * @returns Random organization
+   */
+  group(init: Partial<GroupSchema> = {}): GroupSchema {
+    const {
+      key = nanoid(),
+      name = faker.lorem.word(),
+      color = faker.color.rgb(),
+      oid = nanoid(),
+      owner = nanoid(),
+      createdAt = faker.date.past().getTime(),
+      updatedAt = faker.date.recent().getTime(),
+      description = faker.lorem.sentence(),
+      users = [],
+      icon = faker.image.avatar(),
+    } = init
+    return {
+      kind: GroupKind,
+      key,
+      name,
+      color,
+      oid,
+      owner,
+      createdAt,
+      updatedAt,
+      description,
+      users,
+      icon,
+    }
+  }
+
+  /**
+   * Generates a list of random organization objects.
+   * @param size Number of organizations to generate. Default is 25.
+   * @returns List of random organizations
+   */
+  groups(size = 25): GroupSchema[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.group())
+    }
+    return result
+  }
+}

package/src/mocking/lib/Invitation.ts

@@ -0,0 +1,58 @@
+import { faker } from '@faker-js/faker'
+import { InvitationKind } from '../../models/kinds.js'
+import type { InvitationSchema } from '../../models/store/Invitation.js'
+import { nanoid } from '../../nanoid.js'
+
+export class Invitation {
+  /**
+   * Generates a random invitation object.
+   * @param init Optional values to be present in the object.
+   * @returns Random invitation
+   */
+  invitation(init: Partial<InvitationSchema> = {}): InvitationSchema {
+    const {
+      key = nanoid(),
+      uid = nanoid(),
+      oid = nanoid(),
+      name = faker.person.fullName(),
+      email = faker.internet.email(),
+      createdAt = faker.date.past().getTime(),
+      updatedAt = faker.date.recent().getTime(),
+      token = nanoid(32),
+      expiresAt = faker.date.future().getTime(),
+      status = 'pending',
+      grantType = faker.helpers.arrayElement(['owner', 'manager', 'editor', 'viewer'] as const),
+      resent = 0,
+      lastSentAt = createdAt,
+    } = init
+    return {
+      kind: InvitationKind,
+      key,
+      uid,
+      oid,
+      name,
+      email,
+      createdAt,
+      updatedAt,
+      token,
+      expiresAt,
+      status,
+      grantType,
+      resent,
+      lastSentAt,
+    } as InvitationSchema
+  }
+
+  /**
+   * Generates a list of random invitation objects.
+   * @param size Number of invitations to generate. Default is 25.
+   * @returns List of random invitations
+   */
+  invitations(size = 25): InvitationSchema[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.invitation())
+    }
+    return result
+  }
+}

package/src/mocking/lib/Organization.ts

@@ -0,0 +1,42 @@
+import { faker } from '@faker-js/faker'
+import { OrganizationKind } from '../../models/kinds.js'
+import { nanoid } from '../../nanoid.js'
+import type { IOrganization } from '../../models/store/Organization.js'
+
+export class Organization {
+  /**
+   * Generates a random organization object.
+   * @param init Optional values to be present in the object.
+   * @returns Random organization
+   */
+  organization(init: Partial<IOrganization> = {}): IOrganization {
+    const {
+      key = nanoid(),
+      name = faker.company.name(),
+      createdBy = nanoid(),
+      createdDate = faker.date.past().getTime(),
+      grantType = faker.helpers.arrayElement(['owner', 'manager', 'editor', 'viewer'] as const),
+    } = init
+    return {
+      kind: OrganizationKind,
+      key,
+      name,
+      createdBy,
+      createdDate,
+      grantType,
+    }
+  }
+
+  /**
+   * Generates a list of random organization objects.
+   * @param size Number of organizations to generate. Default is 25.
+   * @returns List of random organizations
+   */
+  organizations(size = 25): IOrganization[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.organization())
+    }
+    return result
+  }
+}

package/src/mocking/lib/Patch.ts

@@ -0,0 +1,128 @@
+import { faker } from '@faker-js/faker'
+import type { MediaPatchRevision } from '../../patch/types.js'
+import { nanoid } from '../../nanoid.js'
+import type {
+  AddOperation,
+  CopyOperation,
+  MoveOperation,
+  Operation,
+  RemoveOperation,
+  ReplaceOperation,
+  TestOperation,
+} from '@api-client/json/patch/types.js'
+
+export class Patch {
+  /**
+   * Generates a random invitation object.
+   * @param init Optional values to be present in the object.
+   * @returns Random invitation
+   */
+  mediaPatchRevision(init: Partial<MediaPatchRevision> = {}): MediaPatchRevision {
+    const {
+      id = nanoid(),
+      timestamp = faker.date.recent().getTime(),
+      patch = this.patches(faker.number.int({ min: 1, max: 5 })),
+      version = faker.number.int({ min: 1, max: 1000 }),
+      revert = [],
+      newVersion = version + 1,
+    } = init
+    return {
+      id,
+      timestamp,
+      patch,
+      version,
+      revert,
+      newVersion,
+    } as MediaPatchRevision
+  }
+
+  /**
+   * Generates a list of random invitation objects.
+   * @param size Number of invitations to generate. Default is 25.
+   * @returns List of random invitations
+   */
+  mediaPatchRevisions(size = 25): MediaPatchRevision[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.mediaPatchRevision())
+    }
+    return result
+  }
+
+  /**
+   * Generates a random JSON patch operation.
+   * @returns A random patch information.
+   */
+  patch(): Operation {
+    const type = faker.helpers.arrayElement(['add', 'remove', 'replace', 'move', 'copy', 'test'] as const)
+    switch (type) {
+      case 'add':
+        return this.addPatch()
+      case 'remove':
+        return this.removePatch()
+      case 'replace':
+        return this.replacePatch()
+      case 'move':
+        return this.movePatch()
+      case 'copy':
+        return this.copyPatch()
+      case 'test':
+        return this.testPatch()
+    }
+  }
+
+  patches(size = 25): Operation[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.patch())
+    }
+    return result
+  }
+
+  addPatch(): AddOperation {
+    return {
+      op: 'add',
+      path: `/${nanoid()}`,
+      value: faker.lorem.word(),
+    }
+  }
+
+  removePatch(): RemoveOperation {
+    return {
+      op: 'remove',
+      path: `/${nanoid()}`,
+    } as RemoveOperation
+  }
+
+  replacePatch(): ReplaceOperation {
+    return {
+      op: 'replace',
+      path: `/${nanoid()}`,
+      value: faker.lorem.word(),
+    } as ReplaceOperation
+  }
+
+  movePatch(): MoveOperation {
+    return {
+      op: 'move',
+      from: `/${nanoid()}`,
+      path: `/${nanoid()}`,
+    } as MoveOperation
+  }
+
+  copyPatch(): CopyOperation {
+    return {
+      op: 'copy',
+      from: `/${nanoid()}`,
+      path: `/${nanoid()}`,
+    } as CopyOperation
+  }
+
+  testPatch(): TestOperation {
+    return {
+      op: 'test',
+      path: `/${nanoid()}`,
+      value: faker.lorem.word(),
+    } as TestOperation
+  }
+}

package/src/mocking/lib/Trash.ts

@@ -0,0 +1,47 @@
+import { faker } from '@faker-js/faker'
+import { ProjectKind, DomainFileKind, CertificateFileKind, FolderKind, ApiFileKind } from '../../models/kinds.js'
+import type { TrashEntry as CoreTrashEntry } from '../../models/TrashEntry.js'
+import { nanoid } from '../../nanoid.js'
+
+export class Trash {
+  /**
+   * Generates a random invitation object.
+   * @param init Optional values to be present in the object.
+   * @returns Random invitation
+   */
+  trashEntry(init: Partial<CoreTrashEntry> = {}): CoreTrashEntry {
+    const {
+      key = nanoid(),
+      refKey = nanoid(),
+      kind = faker.helpers.arrayElement([
+        ProjectKind,
+        DomainFileKind,
+        CertificateFileKind,
+        FolderKind,
+        ApiFileKind,
+      ] as const),
+      info = { byMe: false, time: faker.date.recent().getTime(), user: nanoid(), name: faker.system.fileName() },
+      capabilities = { canDelete: true, canRestore: true },
+    } = init
+    return {
+      key,
+      refKey,
+      kind,
+      info,
+      capabilities,
+    } as CoreTrashEntry
+  }
+
+  /**
+   * Generates a list of random invitation objects.
+   * @param size Number of invitations to generate. Default is 25.
+   * @returns List of random invitations
+   */
+  trashEntries(size = 25): CoreTrashEntry[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.trashEntry())
+    }
+    return result
+  }
+}

package/src/mocking/lib/User.ts

@@ -1,10 +1,6 @@
-import type { IDataMockInit } from '@pawel-up/data-mock/types.js'
-import { Types } from '@pawel-up/data-mock/Types.js'
-import { Person } from '@pawel-up/data-mock/Person.js'
-import { Internet } from '@pawel-up/data-mock/Internet.js'
-import { Random } from '@pawel-up/data-mock/Random.js'
+import { faker } from '@faker-js/faker'
+import { nanoid } from '../../nanoid.js'
 import { IUser, Kind as UserKind } from '../../models/store/User.js'
-import { Time } from '@pawel-up/data-mock/Time.js'
 
 export interface IUserInit {
   noEmail?: boolean
@@ -13,48 +9,53 @@ export interface IUserInit {
 }
 
 export class User {
-  person: Person
-  types: Types
-  internet: Internet
-  random: Random
-  time: Time
-
-  constructor(init: IDataMockInit = {}) {
-    this.person = new Person(init)
-    this.types = new Types(init.seed)
-    this.internet = new Internet(init)
-    this.random = new Random(init.seed)
-    this.time = new Time(init)
-  }
-
+  /**
+   * Generates a random user object.
+   * @param init Configuration options for the user object.
+   * @returns Random user
+   */
   user(init: IUserInit = {}): IUser {
     const result: IUser = {
       kind: UserKind,
-      key: this.types.string(21),
-      name: this.person.name(),
-      status: this.random.pickOne(['active', 'deleted', 'suspended', 'pending']),
+      key: nanoid(),
+      name: faker.person.fullName(),
+      status: faker.helpers.arrayElement(['active', 'deleted', 'suspended', 'pending']),
       email: [],
-      created: this.time.timestamp(),
-      updated: this.time.timestamp(),
+      created: faker.date.past().getTime(),
+      updated: faker.date.recent().getTime(),
     }
     if (!init.noEmail) {
       result.email = [
         {
-          email: this.internet.email(),
-          verified: this.types.boolean(),
+          email: faker.internet.email(),
+          verified: faker.datatype.boolean(),
         },
       ]
     }
     if (!init.noPicture) {
       result.picture = {
-        url: this.internet.avatar(),
+        url: faker.image.avatar(),
       }
     }
     if (!init.noProvider) {
       result.provider = {
-        refreshToken: this.types.string(21),
+        refreshToken: faker.string.alphanumeric(21),
       }
     }
     return result
   }
+
+  /**
+   * Generates a list of random user objects.
+   * @param size The size of the returning array
+   * @param init Configuration options for the user object.
+   * @returns List of random users
+   */
+  users(size = 25, init: IUserInit = {}): IUser[] {
+    const result: IUser[] = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.user(init))
+    }
+    return result
+  }
 }