@api-client/core 0.13.5 → 0.14.0

package/src/models/store/File.ts

@@ -1,4 +1,4 @@
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import { IPermission, Permission, PermissionRole } from './Permission.js'
 import { IModification } from './Modification.js'
 import { IDeletion } from './Deletion.js'
@@ -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/models/store/Invitation.ts

@@ -1,4 +1,4 @@
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import { InvitationKind } from '../kinds.js'
 import type { IDeletion } from './Deletion.js'
 import type { UserOrganizationGrantType } from './Organization.js'

package/src/models/store/Organization.ts

@@ -1,4 +1,4 @@
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import type { IDeletion } from './Deletion.js'
 import { OrganizationKind } from '../kinds.js'
 

package/src/models/store/Permission.ts

@@ -1,4 +1,4 @@
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 
 export const Kind = 'Core#Permission'
 
@@ -11,6 +11,12 @@ export type PermissionType = 'user' | 'group' | 'organization'
  */
 export type PermissionRole = 'owner' | 'reader' | 'commenter' | 'writer'
 const orderedRoles: PermissionRole[] = ['reader', 'commenter', 'writer', 'owner']
+/**
+ * A predefined set of rules that can be used to determine the source of the permission.
+ * - `direct_user_grant`: The permission is granted directly to the user.
+ * - `creator_default_owner`: The permission is granted to the creator of the item as the default owner.
+ */
+export type PermissionSourceRule = 'direct_user_grant' | 'creator_default_owner' | 'parent_owner_editor_rule'
 
 interface IBasePermission {
   /**
@@ -54,6 +60,20 @@ interface IBasePermission {
    * The store id of the user that added this permission.
    */
   addingUser: string
+  /**
+   * The depth of the permission in the hierarchy.
+   * When `0` it means that the permissions do not use inheritance.
+   * When `1` it means the permission is set on the item itself.
+   * When `2` it means the permission is set on the parent item.
+   * When `3` it means the permission is set on the grandparent item, and so on.
+   * This is used to determine the depth of the permission in the hierarchy.
+   */
+  depth: number
+  /**
+   * The source rule of the permission.
+   * This is used to determine how the permission was granted.
+   */
+  sourceRule: PermissionSourceRule
 }
 
 /**
@@ -118,6 +138,20 @@ export class Permission {
    * The store id of the entity that is being granted the permission.
    */
   itemId = ''
+  /**
+   * The depth of the permission in the hierarchy.
+   * When `0` it means that the permissions do not use inheritance.
+   * When `1` it means the permission is set on the item itself.
+   * When `2` it means the permission is set on the parent item.
+   * When `3` it means the permission is set on the grandparent item, and so on.
+   * This is used to determine the depth of the permission in the hierarchy.
+   */
+  depth = 0
+  /**
+   * The source rule of the permission.
+   * This is used to determine how the permission was granted.
+   */
+  sourceRule: PermissionSourceRule = 'direct_user_grant'
 
   /**
    * Creates a Permission object for a user.
@@ -136,6 +170,8 @@ export class Permission {
       role,
       type: 'user',
       addingUser,
+      depth: 0,
+      sourceRule: 'direct_user_grant',
     }
     return new Permission(init)
   }
@@ -157,6 +193,8 @@ export class Permission {
       role,
       type: 'group',
       addingUser,
+      depth: 0,
+      sourceRule: 'direct_user_grant',
     }
     return new Permission(init)
   }
@@ -182,6 +220,8 @@ export class Permission {
       role,
       type: 'organization',
       addingUser,
+      depth: 0,
+      sourceRule: 'direct_user_grant',
     }
     return new Permission(init)
   }
@@ -212,6 +252,8 @@ export class Permission {
         role: 'reader',
         type: 'user',
         addingUser: '',
+        depth: 0,
+        sourceRule: 'direct_user_grant',
       }
     }
     this.new(init)
@@ -221,7 +263,18 @@ export class Permission {
     if (!Permission.isPermission(init)) {
       throw new Error(`Not a permission.`)
     }
-    const { key = nanoid(), granteeId, role, type, displayName, expirationTime, addingUser, itemId } = init
+    const {
+      key = nanoid(),
+      granteeId,
+      role,
+      type,
+      displayName,
+      expirationTime,
+      addingUser,
+      itemId,
+      depth,
+      sourceRule,
+    } = init
     this.kind = Kind
     this.key = key
     this.granteeId = granteeId
@@ -229,6 +282,8 @@ export class Permission {
     this.role = role
     this.type = type
     this.addingUser = addingUser
+    this.depth = depth || 0
+    this.sourceRule = sourceRule || 'direct_user_grant'
     if (displayName) {
       this.displayName = displayName
     } else {
@@ -296,6 +351,8 @@ export class Permission {
       addingUser: this.addingUser,
       granteeId: this.granteeId,
       itemId: this.itemId,
+      depth: this.depth,
+      sourceRule: this.sourceRule,
     }
     if (this.displayName) {
       result.displayName = this.displayName

package/src/models/store/UserIdentity.ts

@@ -1,4 +1,4 @@
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 
 export const Kind = 'Core#UserIdentity'
 

package/src/models/transformers/ArcDexieTransformer.ts

@@ -1,4 +1,4 @@
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import { BaseTransformer, dataValue } from './BaseTransformer.js'
 import { Creator, Browser, Page, Entry, Header } from './har.js'
 import {

package/src/models/transformers/ArcLegacyTransformer.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import { BaseTransformer, dataValue } from './BaseTransformer.js'
 import { ArcExportObject, ExportArcProjects, ExportArcSavedRequest } from '../legacy/DataExport.js'
 

package/src/models/transformers/ArcPouchTransformer.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import { BaseTransformer, dataValue } from './BaseTransformer.js'
 import {
   ArcExportObject,

package/src/models/transformers/PostmanV21Transformer.ts

@@ -4,7 +4,7 @@ import { HttpProject, IHttpProject, Kind as ProjectKind } from '../HttpProject.j
 import { ProjectFolder } from '../ProjectFolder.js'
 import { ProjectRequest } from '../ProjectRequest.js'
 import { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js'
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import { Environment } from '../Environment.js'
 import { Thing } from '../Thing.js'
 

package/src/models/transformers/PostmanV2Transformer.ts

@@ -4,7 +4,7 @@ import { HttpProject, IHttpProject, Kind as HttpProjectKind } from '../HttpProje
 import { ProjectFolder } from '../ProjectFolder.js'
 import { ProjectRequest } from '../ProjectRequest.js'
 import { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js'
-import { nanoid } from 'nanoid'
+import { nanoid } from '../../nanoid.js'
 import { Environment } from '../Environment.js'
 import { Thing } from '../Thing.js'
 

package/src/nanoid.ts

@@ -0,0 +1,10 @@
+import { customAlphabet } from 'nanoid'
+/**
+ * The data store uses the LTREE for storing hierarchical data.
+ * The PG extension for LTREE requires the keys to be
+ * alphanumeric and underscore characters only.
+ * This is a custom nanoid generator that generates
+ * 21 character long IDs using the allowed characters. The same the API is using.
+ */
+const nanoid = customAlphabet('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_', 21)
+export { nanoid }

package/src/patch/PatchClient.ts

@@ -1,6 +1,6 @@
 import type { Operation } from '@api-client/json/patch/types.js'
 import { JsonDocument } from '@api-client/json/patch/json_document.js'
-import { nanoid } from 'nanoid'
+import { nanoid } from '../nanoid.js'
 import type { MediaPatchInfo, PatchInfo } from './types.js'
 
 /**

package/src/sdk/FilesSdk.ts

@@ -12,7 +12,7 @@ import type { FileBreadcrumb, IFile } from '../models/store/File.js'
 import { FolderKind, CertificateFileKind, ProjectKind, DomainFileKind } from '../models/kinds.js'
 import type { ContextListResult, IBulkOperationResult, ContextListOptions } from '../events/BaseEvents.js'
 import type { IAccessAddOperation, IAccessRemoveOperation, PermissionRole } from '../models/store/Permission.js'
-import { nanoid } from 'nanoid'
+import { nanoid } from '../nanoid.js'
 import { Folder, type IFolder } from '../models/Folder.js'
 import type { AccessPatchInfo, MediaPatchInfo, MediaPatchRevision, PatchInfo } from '../patch/types.js'
 import { Exception } from '../exceptions/exception.js'
@@ -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'],
@@ -72,6 +55,8 @@ test.group('constructor()', () => {
           role: 'commenter',
           type: 'organization',
           itemId: '678',
+          depth: 0,
+          sourceRule: 'creator_default_owner',
         },
       ],
       lastModified: { byMe: false, time: 0, user: 'id', name: 'test' },
@@ -79,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'])
@@ -93,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'],
@@ -112,15 +93,15 @@ test.group('constructor()', () => {
           role: 'commenter',
           type: 'organization',
           itemId: '678',
+          depth: 0,
+          sourceRule: 'creator_default_owner',
         },
       ],
       lastModified: { byMe: false, time: 0, user: 'id', name: 'test' },
     }
     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'],
@@ -28,6 +25,8 @@ test.group('File.new()', (group) => {
           role: 'commenter',
           type: 'organization',
           itemId: '678',
+          depth: 0,
+          sourceRule: 'creator_default_owner',
         },
       ],
       lastModified: { byMe: false, time: 1, user: 'u1', name: 'mod-test' },
@@ -43,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')
@@ -97,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)

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

@@ -4,19 +4,16 @@ import { File, ThingKind, IFile } from '../../../../src/index.js'
 test.group('File.toJSON()', (group) => {
   let file: File
   let base: IFile
-  const organization = 'test123'
 
   group.each.setup(() => {
     file = new File()
     base = {
       kind: 'test-kind',
-      organization,
       info: {
         kind: ThingKind,
         name: 'hello',
         description: 'a desc',
       },
-      owner: 'me',
       key: '123',
       parents: ['p1'],
       permissionIds: ['pr1'],
@@ -29,6 +26,8 @@ test.group('File.toJSON()', (group) => {
           role: 'commenter',
           type: 'organization',
           itemId: '678',
+          depth: 0,
+          sourceRule: 'creator_default_owner',
         },
       ],
       lastModified: { byMe: false, time: 1, user: 'u1', name: 'mod-test' },
@@ -41,21 +40,11 @@ test.group('File.toJSON()', (group) => {
     assert.equal(result.key, base.key)
   })
 
-  test('sets the organization', ({ assert }) => {
-    const result = file.toJSON()
-    assert.equal(result.organization, organization)
-  })
-
   test('sets the kind', ({ assert }) => {
     const result = file.toJSON()
     assert.equal(result.kind, base.kind)
   })
 
-  test('sets the owner', ({ assert }) => {
-    const result = file.toJSON()
-    assert.equal(result.owner, base.owner)
-  })
-
   test('sets the info', ({ assert }) => {
     const result = file.toJSON()
     assert.deepEqual(result.info, base.info)

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

@@ -2,10 +2,8 @@ import { test } from '@japa/runner'
 import { File, Folder } from '../../../../src/index.js'
 
 test.group('File.updateByMeMeta()', () => {
-  const organization = 'test123'
-
   test('sets deletedInfo.byMe for the same user', ({ assert }) => {
-    const schema = Folder.fromName('s1', organization).toJSON()
+    const schema = Folder.fromName('s1').toJSON()
     schema.deletedInfo = {
       byMe: false,
       time: 1,
@@ -17,7 +15,7 @@ test.group('File.updateByMeMeta()', () => {
   })
 
   test('sets deletedInfo.byMe for the different user', ({ assert }) => {
-    const schema = Folder.fromName('s1', organization).toJSON()
+    const schema = Folder.fromName('s1').toJSON()
     schema.deletedInfo = {
       byMe: false,
       time: 1,
@@ -29,7 +27,7 @@ test.group('File.updateByMeMeta()', () => {
   })
 
   test('sets lastModified.byMe for the same user', ({ assert }) => {
-    const schema = Folder.fromName('s1', organization).toJSON()
+    const schema = Folder.fromName('s1').toJSON()
     schema.lastModified = {
       byMe: false,
       time: 1,
@@ -41,7 +39,7 @@ test.group('File.updateByMeMeta()', () => {
   })
 
   test('sets lastModified.byMe for the different user', ({ assert }) => {
-    const schema = Folder.fromName('s1', organization).toJSON()
+    const schema = Folder.fromName('s1').toJSON()
     schema.lastModified = {
       byMe: false,
       time: 1,