@api-client/core 0.13.6 → 0.14.0

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

@@ -41731,10 +41731,10 @@
 "@id": "#197"
 },
 {
-"@id": "#200"
+"@id": "#206"
 },
 {
-"@id": "#206"
+"@id": "#200"
 },
 {
 "@id": "#203"
@@ -42470,6 +42470,9 @@
 "@id": "#219"
 },
 {
+"@id": "#219"
+},
+{
 "@id": "#210"
 },
 {
@@ -42477,9 +42480,6 @@
 },
 {
 "@id": "#216"
-},
-{
-"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -43159,7 +43159,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": [
 {
@@ -43201,7 +43201,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43892,7 +43892,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\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": [
 {
@@ -43913,7 +43913,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": [
 {
@@ -43934,7 +43934,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": [
 {
@@ -43955,7 +43955,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44431,7 +44431,7 @@
 {
 "@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",
@@ -44441,7 +44441,7 @@
 {
 "@id": "#208/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#208",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#223/source-map/lexical/element_0",
@@ -44781,17 +44781,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/eslint.config.js

@@ -14,6 +14,7 @@ export const GLOBAL_IGNORE_LIST = [
   '.github/',
   '.husky/',
   '.tmp/',
+  '.rollup.cache/',
   '.vscode/',
   '.wireit/',
   'amf-models/',

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.13.6",
+  "version": "0.14.0",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -208,7 +208,7 @@
       ],
       "output": [
         ".tmp/**",
-        ".tsbuildinfo"
+        ".tmp/testing/tsconfig.browser.tsbuildinfo"
       ]
     },
     "build:ts": {
@@ -220,7 +220,7 @@
       ],
       "output": [
         "build/**",
-        ".tsbuildinfo"
+        "build/tsconfig.tsbuildinfo"
       ]
     },
     "build:browser": {
@@ -233,7 +233,7 @@
       ],
       "output": [
         ".tmp/testing/**",
-        ".tsbuildinfo"
+        ".tmp/testing/tsconfig.browser.tsbuildinfo"
       ]
     },
     "build:node": {
@@ -246,7 +246,7 @@
       ],
       "output": [
         ".tmp/node/**",
-        ".tsbuildinfo"
+        ".tmp/node/tsconfig.node.tsbuildinfo"
       ]
     },
     "lint:eslint": {

package/src/modeling/DomainFile.ts

@@ -14,17 +14,16 @@ export interface IDomainFile extends IFile {
 export class DomainFile extends File {
   override kind = DomainFileKind
 
-  static override fromName(name: string, organization: string, owner?: string): DomainFile {
-    return super.fromName(name, organization, owner, DomainFileKind) as DomainFile
+  static override fromName(name: string): DomainFile {
+    return super.fromName(name, DomainFileKind) as DomainFile
   }
 
   /**
    * Creates the file definition for a DataNamespace contents.
    *
    * @param input The data namespace instance or schema.
-   * @param owner Optional owner to set.
    */
-  static fromDataDomain(input: DataDomain | DataDomainSchema, organization: string, owner?: string): DomainFile {
+  static fromDataDomain(input: DataDomain | DataDomainSchema): DomainFile {
     let final: DataDomainSchema
     if (typeof (input as DataDomain).toJSON === 'function') {
       final = (input as DataDomain).toJSON()
@@ -34,10 +33,8 @@ export class DomainFile extends File {
     const init: IDomainFile = {
       kind: DomainFileKind,
       key: final.key,
-      organization,
       info: { ...final.info },
-      lastModified: { user: owner || '', time: 0, byMe: false },
-      owner,
+      lastModified: { user: '', time: 0, byMe: false },
       parents: [],
       permissionIds: [],
       permissions: [],
@@ -56,7 +53,6 @@ export class DomainFile extends File {
       init = {
         kind: DomainFileKind,
         key: nanoid(),
-        organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],
         permissionIds: [],

package/src/models/CertificateFile.ts

@@ -11,18 +11,12 @@ export interface ICertificateFile extends IFile {
 export class CertificateFile extends File {
   override kind = CertificateFileKind
 
-  static fromCertificate(
-    certificate: ICertificate | Certificate,
-    organization: string,
-    owner?: string
-  ): CertificateFile {
+  static fromCertificate(certificate: ICertificate | Certificate): CertificateFile {
     const init: ICertificateFile = {
       kind: CertificateFileKind,
       key: certificate.key,
-      organization,
       info: Thing.fromName(certificate.name).toJSON(),
-      lastModified: { user: owner || '', time: 0, byMe: false },
-      owner,
+      lastModified: { user: '', time: 0, byMe: false },
       parents: [],
       permissionIds: [],
       permissions: [],
@@ -32,10 +26,9 @@ export class CertificateFile extends File {
 
   /**
    * @param name The name to set.
-   * @param owner The user id that is the owner of the file.
    */
-  static override fromName(name: string, organization: string, owner?: string): CertificateFile {
-    return super.fromName(name, organization, owner, CertificateFileKind) as CertificateFile
+  static override fromName(name: string): CertificateFile {
+    return super.fromName(name, CertificateFileKind) as CertificateFile
   }
 
   constructor(input?: string | ICertificateFile) {
@@ -49,7 +42,6 @@ export class CertificateFile extends File {
       init = {
         kind: CertificateFileKind,
         key: nanoid(),
-        organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],
         permissionIds: [],

package/src/models/Folder.ts

@@ -20,10 +20,9 @@ export class Folder extends File {
    * Creates a new Folder object from a name.
    *
    * @param name The name to set.
-   * @param owner The user id that is the owner of the folder.
    */
-  static override fromName(name: string, organization: string, owner?: string): Folder {
-    return super.fromName(name, organization, owner, FolderKind) as Folder
+  static override fromName(name: string): Folder {
+    return super.fromName(name, FolderKind) as Folder
   }
 
   /**
@@ -40,7 +39,6 @@ export class Folder extends File {
       init = {
         kind: FolderKind,
         key: nanoid(),
-        organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],
         permissionIds: [],

package/src/models/Project.ts

@@ -19,7 +19,7 @@ export interface IProject extends IFile {
 export class Project extends File {
   override kind = ProjectKind
 
-  static fromProject(project: HttpProject | IHttpProject, organization: string, owner?: string): Project {
+  static fromProject(project: HttpProject | IHttpProject): Project {
     let final: IHttpProject
     if (typeof (project as HttpProject).toJSON === 'function') {
       final = (project as HttpProject).toJSON()
@@ -29,10 +29,8 @@ export class Project extends File {
     const init: IProject = {
       kind: ProjectKind,
       key: project.key,
-      organization,
       info: { ...final.info },
-      lastModified: { user: owner || '', time: 0, byMe: false },
-      owner,
+      lastModified: { user: '', time: 0, byMe: false },
       parents: [],
       permissionIds: [],
       permissions: [],
@@ -42,10 +40,9 @@ export class Project extends File {
 
   /**
    * @param name The name to set.
-   * @param owner The user id that is the owner of the file.
    */
-  static override fromName(name: string, organization: string, owner?: string): Project {
-    return super.fromName(name, organization, owner, ProjectKind) as Project
+  static override fromName(name: string): Project {
+    return super.fromName(name, ProjectKind) as Project
   }
 
   constructor(input?: string | IProject) {
@@ -59,7 +56,6 @@ export class Project extends File {
       init = {
         kind: ProjectKind,
         key: nanoid(),
-        organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],
         permissionIds: [],

package/src/models/store/DataFile.ts

@@ -19,10 +19,9 @@ export class DataFile extends File {
    * Creates the file definition for a DataNamespace contents.
    *
    * @param input The data namespace instance or schema.
-   * @param owner Optional owner to set.
    * @deprecated Use DomainFile instead.
    */
-  static fromDataNamespace(input: DataNamespace | IDataNamespace, organization: string, owner?: string): DataFile {
+  static fromDataNamespace(input: DataNamespace | IDataNamespace): DataFile {
     let final: IDataNamespace
     if (typeof (input as DataNamespace).toJSON === 'function') {
       final = (input as DataNamespace).toJSON()
@@ -32,10 +31,8 @@ export class DataFile extends File {
     const init: IDataFile = {
       kind: Kind,
       key: final.key,
-      organization,
       info: { ...final.info },
-      lastModified: { user: owner || '', time: 0, byMe: false },
-      owner,
+      lastModified: { user: '', time: 0, byMe: false },
       parents: [],
       permissionIds: [],
       permissions: [],
@@ -45,10 +42,9 @@ export class DataFile extends File {
 
   /**
    * @param name The name to set.
-   * @param owner The user id that is the owner of the file.
    */
-  static override fromName(name: string, organization: string, owner?: string): DataFile {
-    return super.fromName(name, organization, owner, Kind) as DataFile
+  static override fromName(name: string): DataFile {
+    return super.fromName(name, Kind) as DataFile
   }
 
   constructor(input?: string | IDataFile) {
@@ -62,7 +58,6 @@ export class DataFile extends File {
       init = {
         kind: Kind,
         key: nanoid(),
-        organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],
         permissionIds: [],

package/src/models/store/File.ts

@@ -51,19 +51,10 @@ export interface IStoredFile {
    * The identifier of the entity
    */
   key: string
-  /**
-   * The parent organization of the file.
-   */
-  organization: string
   /**
    * The file's meta info.
    */
   info: IThing
-  /**
-   * The owner of this object. The id of the User object.
-   * Once the File is persistent by the API this is always populated.
-   */
-  owner?: string
   /**
    * The color of the icon to render for this file in the file explorer.
    * This should be a hex format, e.g.: #c00 for red.
@@ -144,7 +135,6 @@ export interface IFile extends IStoredFile {
 const parentsSymbol = Symbol('parents')
 const deletedSymbol = Symbol('deleted')
 const deletedInfoSymbol = Symbol('deletedInfo')
-const ownerSymbol = Symbol('owner')
 const lastModifiedSymbol = Symbol('lastModified')
 const capabilitiesSymbol = Symbol('capabilities')
 const permissionsSymbol = Symbol('permissions')
@@ -160,24 +150,10 @@ export class StoredFile {
    * The identifier of the entity
    */
   key = ''
-  /**
-   * The parent organization of the file.
-   */
-  organization = ''
   /**
    * The name of the environment.
    */
-  info: Thing = Thing.fromName('');
-
-  [ownerSymbol]?: string
-
-  /**
-   * The owner of this file. This is the id of the User object.
-   * Set to `default` when there are no users in the system (no authentication).
-   */
-  get owner(): string | undefined {
-    return this[ownerSymbol]
-  }
+  info: Thing = Thing.fromName('')
 
   /**
    * The color of the icon to render for this file in the file explorer.
@@ -206,11 +182,9 @@ export class StoredFile {
   }
 
   new(init: IStoredFile): this {
-    const { key = nanoid(), info, kind, owner, iconColor, organization, shortcutTarget } = init
+    const { key = nanoid(), info, kind, iconColor, shortcutTarget } = init
     this.key = key
-    this.organization = organization
     this.kind = kind
-    this[ownerSymbol] = owner
     if (info) {
       this.info = new Thing(info)
     } else {
@@ -230,13 +204,10 @@ export class StoredFile {
   }
 
   toJSON(): IStoredFile {
-    const { owner } = this
     const result: IStoredFile = {
       key: this.key,
-      organization: this.organization,
       kind: this.kind,
       info: this.info.toJSON(),
-      owner,
     }
     if (this.iconColor) {
       result.iconColor = this.iconColor
@@ -484,19 +455,17 @@ export class File extends StoredFile {
    * @param name The name to set.
    * @param owner The user id that is the owner of the file.
    */
-  static fromName(name: string, organization: string, owner?: string, kind = ''): File {
+  static fromName(name: string, kind = ''): File {
     const key = nanoid()
     const definition = new File()
     definition.new({
       key,
       kind,
-      organization,
       info: Thing.fromName(name).toJSON(),
-      owner,
       parents: [],
       permissionIds: [],
       permissions: [],
-      lastModified: { user: owner || '', time: 0, byMe: false },
+      lastModified: { user: '', time: 0, byMe: false },
     })
     return definition
   }

package/src/sdk/FilesSdk.ts

@@ -200,7 +200,7 @@ export class FilesSdk extends SdkBase {
     opts: IMetaCreateOptions = {},
     request: SdkOptions = {}
   ): Promise<IFolder> {
-    const file = Folder.fromName(name, organization)
+    const file = Folder.fromName(name)
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.files(organization))
     if (opts.parent) {

package/tests/unit/modeling/domain_file.spec.ts

@@ -1,42 +1,28 @@
 import { test } from '@japa/runner'
 import { DomainFile, IDomainFile, ThingKind, DomainFileKind, DataDomain } from '../../../src/index.js'
 
-const organization = 'test-organization'
-
 test.group('DomainFile.fromDataDomain()', () => {
   test('sets the kind', ({ assert }) => {
     const p1 = new DataDomain({ info: { name: 'p1' } })
-    const result = DomainFile.fromDataDomain(p1, organization)
+    const result = DomainFile.fromDataDomain(p1)
     assert.equal(result.kind, DomainFileKind)
   })
 
-  test('sets the organization', ({ assert }) => {
-    const p1 = new DataDomain({ info: { name: 'p1' } })
-    const result = DomainFile.fromDataDomain(p1, organization)
-    assert.equal(result.organization, organization)
-  })
-
   test('sets the name', ({ assert }) => {
     const p1 = new DataDomain({ info: { name: 'p1' } })
-    const result = DomainFile.fromDataDomain(p1, organization)
+    const result = DomainFile.fromDataDomain(p1)
     assert.equal(result.info.name, 'p1')
   })
 
   test('sets the key', ({ assert }) => {
     const p1 = new DataDomain({ info: { name: 'p1' } })
-    const result = DomainFile.fromDataDomain(p1, organization)
+    const result = DomainFile.fromDataDomain(p1)
     assert.equal(result.key, p1.key)
   })
 
-  test('sets the configured owner', ({ assert }) => {
-    const p1 = new DataDomain({ info: { name: 'p1' } })
-    const result = DomainFile.fromDataDomain(p1, organization, 'other')
-    assert.equal(result.owner, 'other')
-  })
-
   test('respects schema instead of instance', ({ assert }) => {
     const p1 = new DataDomain({ info: { name: 'p1' } })
-    const result = DomainFile.fromDataDomain(p1.toJSON(), organization)
+    const result = DomainFile.fromDataDomain(p1.toJSON())
     assert.equal(result.info.name, 'p1')
   })
 })
@@ -45,7 +31,6 @@ test.group('constructor()', () => {
   test('creates a default data file', ({ assert }) => {
     const result = new DomainFile()
     assert.equal(result.kind, DomainFileKind)
-    assert.isUndefined(result.owner)
     assert.typeOf(result.key, 'string')
     assert.typeOf(result.lastModified, 'object')
   })
@@ -53,13 +38,11 @@ test.group('constructor()', () => {
   test('creates a data file from the schema values', ({ assert }) => {
     const schema: IDomainFile = {
       kind: DomainFileKind,
-      organization,
       info: {
         kind: ThingKind,
         name: 'hello',
         description: 'a desc',
       },
-      owner: 'me',
       key: '123',
       parents: ['p1'],
       permissionIds: ['pr1'],
@@ -81,9 +64,7 @@ test.group('constructor()', () => {
     }
     const result = new DomainFile(schema)
     assert.equal(result.kind, DomainFileKind)
-    assert.equal(result.organization, organization)
     assert.equal(result.info.name, 'hello')
-    assert.equal(result.owner, 'me')
     assert.equal(result.key, '123')
     assert.deepEqual(result.parents, ['p1'])
     assert.deepEqual(result.permissionIds, ['pr1'])
@@ -95,13 +76,11 @@ test.group('constructor()', () => {
   test('creates a data file from the JSON schema string', ({ assert }) => {
     const schema: IDomainFile = {
       kind: DomainFileKind,
-      organization,
       info: {
         kind: ThingKind,
         name: 'hello',
         description: 'a desc',
       },
-      owner: 'me',
       key: '123',
       parents: ['p1'],
       permissionIds: ['pr1'],
@@ -122,9 +101,7 @@ test.group('constructor()', () => {
     }
     const result = new DomainFile(JSON.stringify(schema))
     assert.equal(result.kind, DomainFileKind)
-    assert.equal(result.organization, organization)
     assert.equal(result.info.name, 'hello')
-    assert.equal(result.owner, 'me')
     assert.equal(result.key, '123')
     assert.deepEqual(result.lastModified, schema.lastModified)
   })

package/tests/unit/models/Certificate/from_name.spec.ts

@@ -1,32 +1,20 @@
 import { test } from '@japa/runner'
 import { CertificateFile, CertificateFileKind } from '../../../../src/index.js'
 
-const organization = 'test-organization'
-
 test.group('CertificateFile.fromName()', () => {
   test('sets the kind', ({ assert }) => {
-    const result = CertificateFile.fromName('name', organization)
+    const result = CertificateFile.fromName('name')
     assert.equal(result.kind, CertificateFileKind)
   })
 
-  test('sets the organization', ({ assert }) => {
-    const result = CertificateFile.fromName('name', organization)
-    assert.equal(result.organization, organization)
-  })
-
   test('sets the name', ({ assert }) => {
-    const result = CertificateFile.fromName('name', organization)
+    const result = CertificateFile.fromName('name')
     assert.equal(result.info.name, 'name')
   })
 
   test('sets the key', ({ assert }) => {
-    const result = CertificateFile.fromName('name', organization)
+    const result = CertificateFile.fromName('name')
     assert.typeOf(result.key, 'string')
     assert.notEqual(result.key, '')
   })
-
-  test('sets the owner', ({ assert }) => {
-    const result = CertificateFile.fromName('name', organization, 'other')
-    assert.equal(result.owner, 'other')
-  })
 })

package/tests/unit/models/File/constructor.spec.ts

@@ -5,7 +5,6 @@ test.group('File.constructor()', () => {
   test('creates a default File', ({ assert }) => {
     const result = new File()
     assert.equal(result.kind, '')
-    assert.isUndefined(result.owner)
     assert.equal(result.key, '')
     assert.deepEqual(result.info.toJSON(), { kind: ThingKind, name: '' })
     assert.deepEqual(result.parents, [])

package/tests/unit/models/File/new.spec.ts

@@ -4,18 +4,15 @@ import { File, ThingKind, IFile } from '../../../../src/index.js'
 test.group('File.new()', (group) => {
   let file: File
   let base: IFile
-  const organization = 'test123'
   group.each.setup(async () => {
     file = new File()
     base = {
       kind: 'test-kind',
-      organization,
       info: {
         kind: ThingKind,
         name: 'hello',
         description: 'a desc',
       },
-      owner: 'me',
       key: '123',
       parents: ['p1'],
       permissionIds: ['pr1'],
@@ -45,11 +42,6 @@ test.group('File.new()', (group) => {
     assert.equal(file.key, '123')
   })
 
-  test('sets the organization', ({ assert }) => {
-    file.new({ ...base })
-    assert.equal(file.organization, organization)
-  })
-
   test('sets a new key when missing', ({ assert }) => {
     const iFile = { ...base }
     Reflect.deleteProperty(iFile, 'key')
@@ -99,11 +91,6 @@ test.group('File.new()', (group) => {
     assert.deepEqual(file.permissionIds, [])
   })
 
-  test('sets the owner', ({ assert }) => {
-    file.new({ ...base })
-    assert.equal(file.owner, 'me')
-  })
-
   test('sets the lastModified', ({ assert }) => {
     file.new({ ...base })
     assert.deepEqual(file.lastModified, base.lastModified)

package/tests/unit/models/File/shortcutTo.spec.ts

@@ -46,8 +46,7 @@ test.group('File.shortcutTo()', () => {
   })
 
   test('creates a shortcut from a name with fromName()', ({ assert }) => {
-    const organization = 'test-org'
-    const file = File.fromName('test-file', organization)
+    const file = File.fromName('test-file')
     const targetId = 'target-file-id'
     file.shortcutTo(targetId)
     assert.equal(file.shortcutTarget, targetId)