@api-client/core 0.18.47 → 0.18.48

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

@@ -42062,10 +42062,10 @@
 "@id": "#209"
 },
 {
-"@id": "#191"
+"@id": "#206"
 },
 {
-"@id": "#200"
+"@id": "#191"
 },
 {
 "@id": "#194"
@@ -42074,10 +42074,10 @@
 "@id": "#197"
 },
 {
-"@id": "#203"
+"@id": "#200"
 },
 {
-"@id": "#206"
+"@id": "#203"
 },
 {
 "@id": "#209"
@@ -43436,7 +43436,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43499,7 +43499,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\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: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43541,7 +43541,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
+"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44756,7 +44756,7 @@
 {
 "@id": "#193/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#193",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#196/source-map/lexical/element_0",
@@ -44771,17 +44771,17 @@
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#205",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#208/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#208",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#223/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.47",
+  "version": "0.18.48",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -113,7 +113,7 @@
     "@japa/assert": "^4.0.1",
     "@japa/browser-client": "^2.1.1",
     "@japa/expect-type": "^2.0.3",
-    "@japa/runner": "^4.2.0",
+    "@japa/runner": "^5.3.0",
     "@pawel-up/semver": "^0.1.4",
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/chai-as-promised": "^8.0.2",

package/src/mocking/ModelingMock.ts

@@ -7,6 +7,7 @@ import { Invitation } from './lib/Invitation.js'
 import { Trash } from './lib/Trash.js'
 import { Patch } from './lib/Patch.js'
 import { DataCatalog } from './lib/DataCatalog.js'
+import { Permission } from './lib/Permission.js'
 
 export class ModelingMock {
   faker: Faker = faker
@@ -18,4 +19,5 @@ export class ModelingMock {
   trash = new Trash()
   patch = new Patch()
   dataCatalog = new DataCatalog()
+  permission = new Permission()
 }

package/src/mocking/lib/File.ts

@@ -6,6 +6,7 @@ import { nanoid } from '../../nanoid.js'
 export class File {
   /**
    * Generates a random file object.
+   * Note that this generator doesn't create the permissions object. Use Permission class for that.
    * @param init Optional values to be present in the object.
    * @returns Random file
    */

package/src/mocking/lib/Permission.ts

@@ -0,0 +1,100 @@
+import { faker } from '@faker-js/faker'
+import { nanoid } from '../../nanoid.js'
+import {
+  IPermission,
+  Kind as PermissionKind,
+  type PermissionRole,
+  type PermissionType,
+  type PermissionSourceRule,
+} from '../../models/store/Permission.js'
+
+export class Permission {
+  /**
+   * Generates a random permission object.
+   * @param init Configuration options for the permission object.
+   * @returns Random permission
+   */
+  permission(init: Partial<IPermission> = {}): IPermission {
+    const type = init.type ?? faker.helpers.arrayElement(['user', 'group', 'organization'] as PermissionType[])
+    const role = init.role ?? faker.helpers.arrayElement(['reader', 'commenter', 'writer', 'owner'] as PermissionRole[])
+
+    const result: IPermission = {
+      kind: PermissionKind,
+      key: init.key ?? nanoid(),
+      type,
+      granteeId: init.granteeId ?? nanoid(),
+      itemId: init.itemId ?? nanoid(),
+      role,
+      addingUser: init.addingUser ?? nanoid(),
+      depth: init.depth ?? 0,
+      sourceRule:
+        init.sourceRule ??
+        faker.helpers.arrayElement([
+          'direct_user_grant',
+          'creator_default_owner',
+          'parent_owner_editor_rule',
+        ] as PermissionSourceRule[]),
+    }
+
+    if ('displayName' in init) {
+      result.displayName = init.displayName
+    } else {
+      if (type === 'user') {
+        result.displayName = faker.person.fullName()
+      } else if (type === 'group') {
+        result.displayName = faker.lorem.word()
+      } else if (type === 'organization') {
+        result.displayName = faker.company.name()
+      }
+    }
+
+    if ('expirationTime' in init) {
+      result.expirationTime = init.expirationTime
+    } else if (type === 'user' || type === 'group') {
+      result.expirationTime = faker.date.future().getTime()
+    }
+
+    return result
+  }
+
+  /**
+   * Generates a random user permission object.
+   * @param init Configuration options for the permission object.
+   * @returns Random user permission
+   */
+  userPermission(init: Partial<IPermission> = {}): IPermission {
+    return this.permission({ ...init, type: 'user' })
+  }
+
+  /**
+   * Generates a random group permission object.
+   * @param init Configuration options for the permission object.
+   * @returns Random group permission
+   */
+  groupPermission(init: Partial<IPermission> = {}): IPermission {
+    return this.permission({ ...init, type: 'group' })
+  }
+
+  /**
+   * Generates a random organization permission object.
+   * @param init Configuration options for the permission object.
+   * @returns Random organization permission
+   */
+  organizationPermission(init: Partial<IPermission> = {}): IPermission {
+    return this.permission({ ...init, type: 'organization' })
+  }
+
+  /**
+   * Generates a list of random permission objects.
+   * @param size The size of the returning array. Default is 25.
+   * @param init Configuration options for the permission object.
+   * @returns List of random permissions
+   */
+  permissions(size = 25, init: Partial<IPermission> = {}): IPermission[] {
+    const result: IPermission[] = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.permission(init))
+    }
+    return result
+  }
+}

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

@@ -0,0 +1,285 @@
+import { test } from '@japa/runner'
+import { Permission } from '../../../../src/mocking/lib/Permission.js'
+import { Kind as PermissionKind } from '../../../../src/models/store/Permission.js'
+import type { IPermission } from '../../../../src/models/store/Permission.js'
+
+test.group('permission()', (group) => {
+  let permission: Permission
+
+  group.each.setup(() => {
+    permission = new Permission()
+  })
+
+  test('returns an object', ({ assert }) => {
+    const result = permission.permission()
+    assert.typeOf(result, 'object')
+  })
+
+  test('has the {property} property of a type {type}')
+    .with([
+      { property: 'kind', type: 'string' },
+      { property: 'key', type: 'string' },
+      { property: 'type', type: 'string' },
+      { property: 'granteeId', type: 'string' },
+      { property: 'itemId', type: 'string' },
+      { property: 'role', type: 'string' },
+      { property: 'addingUser', type: 'string' },
+      { property: 'depth', type: 'number' },
+      { property: 'sourceRule', type: 'string' },
+    ])
+    .run(({ assert }, { property, type }) => {
+      const result = permission.permission()
+      assert.typeOf(result[property as keyof IPermission], type)
+    })
+
+  test('has the correct kind', ({ assert }) => {
+    const result = permission.permission()
+    assert.equal(result.kind, PermissionKind)
+  })
+
+  test('type is one of the valid values', ({ assert }) => {
+    const result = permission.permission()
+    assert.include(['user', 'group', 'organization'], result.type)
+  })
+
+  test('role is one of the valid values', ({ assert }) => {
+    const result = permission.permission()
+    assert.include(['reader', 'commenter', 'writer', 'owner'], result.role)
+  })
+
+  test('sourceRule is one of the valid values', ({ assert }) => {
+    const result = permission.permission()
+    assert.include(['direct_user_grant', 'creator_default_owner', 'parent_owner_editor_rule'], result.sourceRule)
+  })
+
+  test('uses passed key', ({ assert }) => {
+    const result = permission.permission({ key: 'custom-key' })
+    assert.equal(result.key, 'custom-key')
+  })
+
+  test('uses passed type', ({ assert }) => {
+    const result = permission.permission({ type: 'group' })
+    assert.equal(result.type, 'group')
+  })
+
+  test('uses passed granteeId', ({ assert }) => {
+    const result = permission.permission({ granteeId: 'grantee-123' })
+    assert.equal(result.granteeId, 'grantee-123')
+  })
+
+  test('uses passed itemId', ({ assert }) => {
+    const result = permission.permission({ itemId: 'item-456' })
+    assert.equal(result.itemId, 'item-456')
+  })
+
+  test('uses passed role', ({ assert }) => {
+    const result = permission.permission({ role: 'writer' })
+    assert.equal(result.role, 'writer')
+  })
+
+  test('uses passed addingUser', ({ assert }) => {
+    const result = permission.permission({ addingUser: 'user-789' })
+    assert.equal(result.addingUser, 'user-789')
+  })
+
+  test('uses passed depth', ({ assert }) => {
+    const result = permission.permission({ depth: 2 })
+    assert.equal(result.depth, 2)
+  })
+
+  test('uses passed sourceRule', ({ assert }) => {
+    const result = permission.permission({ sourceRule: 'creator_default_owner' })
+    assert.equal(result.sourceRule, 'creator_default_owner')
+  })
+
+  test('generates displayName by default', ({ assert }) => {
+    const result = permission.permission()
+    assert.typeOf(result.displayName, 'string')
+  })
+
+  test('uses passed displayName', ({ assert }) => {
+    const result = permission.permission({ displayName: 'John Doe' })
+    assert.equal(result.displayName, 'John Doe')
+  })
+
+  test('can explicitly set displayName to undefined', ({ assert }) => {
+    const result = permission.permission({ displayName: undefined })
+    assert.isUndefined(result.displayName)
+  })
+
+  test('generates expirationTime for user type by default', ({ assert }) => {
+    const result = permission.permission({ type: 'user' })
+    assert.typeOf(result.expirationTime, 'number')
+  })
+
+  test('generates expirationTime for group type by default', ({ assert }) => {
+    const result = permission.permission({ type: 'group' })
+    assert.typeOf(result.expirationTime, 'number')
+  })
+
+  test('does not generate expirationTime for organization type', ({ assert }) => {
+    const result = permission.permission({ type: 'organization' })
+    assert.isUndefined(result.expirationTime)
+  })
+
+  test('uses passed expirationTime', ({ assert }) => {
+    const time = Date.now() + 86400000
+    const result = permission.permission({ expirationTime: time })
+    assert.equal(result.expirationTime, time)
+  })
+
+  test('can explicitly set expirationTime to undefined', ({ assert }) => {
+    const result = permission.permission({ type: 'user', expirationTime: undefined })
+    assert.isUndefined(result.expirationTime)
+  })
+})
+
+test.group('userPermission()', (group) => {
+  let permission: Permission
+
+  group.each.setup(() => {
+    permission = new Permission()
+  })
+
+  test('returns an object', ({ assert }) => {
+    const result = permission.userPermission()
+    assert.typeOf(result, 'object')
+  })
+
+  test('has type set to user', ({ assert }) => {
+    const result = permission.userPermission()
+    assert.equal(result.type, 'user')
+  })
+
+  test('has displayName', ({ assert }) => {
+    const result = permission.userPermission()
+    assert.typeOf(result.displayName, 'string')
+  })
+
+  test('has expirationTime', ({ assert }) => {
+    const result = permission.userPermission()
+    assert.typeOf(result.expirationTime, 'number')
+  })
+
+  test('uses passed init values', ({ assert }) => {
+    const result = permission.userPermission({ role: 'owner', itemId: 'item-123' })
+    assert.equal(result.type, 'user')
+    assert.equal(result.role, 'owner')
+    assert.equal(result.itemId, 'item-123')
+  })
+})
+
+test.group('groupPermission()', (group) => {
+  let permission: Permission
+
+  group.each.setup(() => {
+    permission = new Permission()
+  })
+
+  test('returns an object', ({ assert }) => {
+    const result = permission.groupPermission()
+    assert.typeOf(result, 'object')
+  })
+
+  test('has type set to group', ({ assert }) => {
+    const result = permission.groupPermission()
+    assert.equal(result.type, 'group')
+  })
+
+  test('has displayName', ({ assert }) => {
+    const result = permission.groupPermission()
+    assert.typeOf(result.displayName, 'string')
+  })
+
+  test('has expirationTime', ({ assert }) => {
+    const result = permission.groupPermission()
+    assert.typeOf(result.expirationTime, 'number')
+  })
+
+  test('uses passed init values', ({ assert }) => {
+    const result = permission.groupPermission({ role: 'commenter', granteeId: 'group-456' })
+    assert.equal(result.type, 'group')
+    assert.equal(result.role, 'commenter')
+    assert.equal(result.granteeId, 'group-456')
+  })
+})
+
+test.group('organizationPermission()', (group) => {
+  let permission: Permission
+
+  group.each.setup(() => {
+    permission = new Permission()
+  })
+
+  test('returns an object', ({ assert }) => {
+    const result = permission.organizationPermission()
+    assert.typeOf(result, 'object')
+  })
+
+  test('has type set to organization', ({ assert }) => {
+    const result = permission.organizationPermission()
+    assert.equal(result.type, 'organization')
+  })
+
+  test('has displayName', ({ assert }) => {
+    const result = permission.organizationPermission()
+    assert.typeOf(result.displayName, 'string')
+  })
+
+  test('does not have expirationTime', ({ assert }) => {
+    const result = permission.organizationPermission()
+    assert.isUndefined(result.expirationTime)
+  })
+
+  test('uses passed init values', ({ assert }) => {
+    const result = permission.organizationPermission({ role: 'reader', addingUser: 'admin-789' })
+    assert.equal(result.type, 'organization')
+    assert.equal(result.role, 'reader')
+    assert.equal(result.addingUser, 'admin-789')
+  })
+})
+
+test.group('permissions()', (group) => {
+  let permission: Permission
+
+  group.each.setup(() => {
+    permission = new Permission()
+  })
+
+  test('returns an array', ({ assert }) => {
+    const result = permission.permissions()
+    assert.isArray(result)
+  })
+
+  test('returns 25 items by default', ({ assert }) => {
+    const result = permission.permissions()
+    assert.lengthOf(result, 25)
+  })
+
+  test('returns specified number of items', ({ assert }) => {
+    const result = permission.permissions(10)
+    assert.lengthOf(result, 10)
+  })
+
+  test('all items have the correct kind', ({ assert }) => {
+    const result = permission.permissions(5)
+    result.forEach((item) => {
+      assert.equal(item.kind, PermissionKind)
+    })
+  })
+
+  test('uses passed init values for all items', ({ assert }) => {
+    const result = permission.permissions(5, { type: 'user', role: 'owner' })
+    result.forEach((item) => {
+      assert.equal(item.type, 'user')
+      assert.equal(item.role, 'owner')
+    })
+  })
+
+  test('generates unique keys', ({ assert }) => {
+    const result = permission.permissions(10)
+    const keys = result.map((item) => item.key)
+    const uniqueKeys = new Set(keys)
+    assert.equal(keys.length, uniqueKeys.size)
+  })
+})