@api-client/core 0.19.17 → 0.19.18

package/src/models/store/File.ts

@@ -1,10 +1,10 @@
 import { nanoid } from '../../nanoid.js'
-import { IPermission, Permission, PermissionRole } from './Permission.js'
-import { IModification } from './Modification.js'
-import { IDeletion } from './Deletion.js'
-import { IUser, Kind as UserKind } from './User.js'
-import { IThing, Thing } from '../Thing.js'
-import { ICapabilities } from './Capabilities.js'
+import { PermissionSchema, Permission, PermissionRole } from './Permission.js'
+import { ModificationSchema } from './Modification.js'
+import { DeletionSchema } from './Deletion.js'
+import { UserSchema, Kind as UserKind } from './User.js'
+import { ThingSchema, Thing } from '../Thing.js'
+import { CapabilitiesSchema } from './Capabilities.js'
 import { FolderKind } from '../kinds.js'
 // this causes error
 // import { Kind as FolderKind } from '../Folder.js';
@@ -42,7 +42,7 @@ export interface FileBreadcrumb {
   name: string
 }
 
-export interface IStoredFile {
+export interface StoredFileSchema {
   /**
    * The kind of the File
    */
@@ -54,7 +54,7 @@ export interface IStoredFile {
   /**
    * The file's meta info.
    */
-  info: IThing
+  info: ThingSchema
   /**
    * 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.
@@ -71,11 +71,16 @@ export interface IStoredFile {
   shortcutTarget?: string
 }
 
+/**
+ * @deprecated Use {@link StoredFileSchema} instead.
+ */
+export type IStoredFile = StoredFileSchema
+
 /**
  * An interface describing an object in the data store that
  * describes a file or an object that can be treated as a file or a folder.
  */
-export interface IFile extends IStoredFile {
+export interface FileSchema extends StoredFileSchema {
   /**
    * The list of parents of the object. It is an ordered list of parents
    * from the top (first element) to the lowest parent in the tree (last element).
@@ -99,11 +104,11 @@ export interface IFile extends IStoredFile {
    * The information about the delete information.
    * Always set when the `delete` is true.
    */
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
   /**
    * The last modification made to this file.
    */
-  lastModified: IModification
+  lastModified: ModificationSchema
   /**
    * An arbitrary list of labels applied to the file.
    */
@@ -114,7 +119,7 @@ export interface IFile extends IStoredFile {
    *
    * This is a readonly field and it is ignored when creating / updating the file.
    */
-  capabilities?: ICapabilities
+  capabilities?: CapabilitiesSchema
   /**
    * Populated by the server when reading the file. The list of permissions to the object.
    *
@@ -124,7 +129,7 @@ export interface IFile extends IStoredFile {
    * Data store implementation note, this is not stored in the store but it is populated
    * when reading the object.
    */
-  permissions: IPermission[]
+  permissions: PermissionSchema[]
   /**
    * Populated by the store in some situations. If it's missing then you should request
    * breadcrumbs from the store.
@@ -132,6 +137,11 @@ export interface IFile extends IStoredFile {
   breadcrumb?: FileBreadcrumb[]
 }
 
+/**
+ * @deprecated Use {@link FileSchema} instead.
+ */
+export type IFile = FileSchema
+
 const parentsSymbol = Symbol('parents')
 const deletedSymbol = Symbol('deleted')
 const deletedInfoSymbol = Symbol('deletedInfo')
@@ -188,9 +198,9 @@ export class StoredFile {
    * @param input The input to create the file schema.
    * @returns The file schema object.
    */
-  static createSchema(input: Partial<IStoredFile> = {}): IStoredFile {
+  static createSchema(input: Partial<StoredFileSchema> = {}): StoredFileSchema {
     const { key = nanoid(), kind, iconColor, shortcutTarget } = input
-    const result: IStoredFile = {
+    const result: StoredFileSchema = {
       key,
       kind: kind || '',
       info: Thing.fromJSON(input.info, { name: 'Unnamed file' }).toJSON(),
@@ -205,7 +215,7 @@ export class StoredFile {
     return result
   }
 
-  constructor(state: IStoredFile) {
+  constructor(state: StoredFileSchema) {
     this.kind = state.kind
     this.key = state.key
     this.info = new Thing(state.info)
@@ -220,7 +230,7 @@ export class StoredFile {
   /**
    * @deprecated Use `createSchema()` and setup values in the constructor instead.
    */
-  new(init: IStoredFile): this {
+  new(init: StoredFileSchema): this {
     const { key = nanoid(), info, kind, iconColor, shortcutTarget } = init
     this.key = key
     this.kind = kind
@@ -242,8 +252,8 @@ export class StoredFile {
     return this
   }
 
-  toJSON(): IStoredFile {
-    const result: IStoredFile = {
+  toJSON(): StoredFileSchema {
+    const result: StoredFileSchema = {
       key: this.key,
       kind: this.kind,
       info: this.info.toJSON(),
@@ -264,13 +274,13 @@ export class StoredFile {
    * @param file The file object to create the capabilities to. The object is not mutated.
    * @param role The user role to the file.
    */
-  static createFileCapabilities(file: IStoredFile | StoredFile, role?: PermissionRole): ICapabilities {
+  static createFileCapabilities(file: StoredFileSchema | StoredFile, role?: PermissionRole): CapabilitiesSchema {
     const isCommenter = Permission.hasRole('commenter', role)
     const isOwner = Permission.hasRole('owner', role)
     const isReader = Permission.hasRole('reader', role)
     const isWriter = Permission.hasRole('writer', role)
     const isFolder = file.kind === FolderKind
-    const result: ICapabilities = {
+    const result: CapabilitiesSchema = {
       canReadMedia: !isFolder && isReader,
       canListChildren: isFolder && isReader,
       canComment: !isFolder && isCommenter,
@@ -287,20 +297,20 @@ export class StoredFile {
     return result
   }
 
-  createFileCapabilities(role: PermissionRole): ICapabilities {
+  createFileCapabilities(role: PermissionRole): CapabilitiesSchema {
     return File.createFileCapabilities(this, role)
   }
 
   /**
    * Mutates the file object by setting the `byMe` properties (on deleted and modified info)
    *
-   * Note, this can be done only on file schema (IFile). The `File` object has
+   * Note, this can be done only on file schema (FileSchema). The `File` object has
    * this properties frozen.
    *
    * @param file The file to mutate
    * @param user The user key to compare.
    */
-  static updateByMeMeta(file: IFile, user: string): void {
+  static updateByMeMeta(file: FileSchema, user: string): void {
     if (file.deletedInfo) {
       file.deletedInfo.byMe = file.deletedInfo.user === user
     }
@@ -317,7 +327,7 @@ export class StoredFile {
    * @param user The user that modifies the file.
    * @returns The same file.
    */
-  static setLastModified(file: IFile, user: IUser): IFile {
+  static setLastModified(file: FileSchema, user: UserSchema): FileSchema {
     if (!file) {
       throw new Error(`The file is required.`)
     }
@@ -344,7 +354,7 @@ export class StoredFile {
    * @param user The deleting user
    * @returns The same file reference.
    */
-  static setDeleted(file: IFile, user: IUser): IFile {
+  static setDeleted(file: FileSchema, user: UserSchema): FileSchema {
     if (!file) {
       throw new Error(`The file is required.`)
     }
@@ -400,22 +410,22 @@ export class File extends StoredFile {
     return this[deletedSymbol] || false
   }
 
-  [deletedInfoSymbol]?: Readonly<IDeletion>
+  [deletedInfoSymbol]?: Readonly<DeletionSchema>
 
   /**
    * The information about the delete information.
    * Always set when the `delete` is true.
    */
-  get deletedInfo(): Readonly<IDeletion> | undefined {
+  get deletedInfo(): Readonly<DeletionSchema> | undefined {
     return this[deletedInfoSymbol]
   }
 
-  [lastModifiedSymbol]: Readonly<IModification> = { user: '', time: 0, byMe: false }
+  [lastModifiedSymbol]: Readonly<ModificationSchema> = { user: '', time: 0, byMe: false }
 
   /**
    * The last modification made to this file.
    */
-  get lastModified(): Readonly<IModification> {
+  get lastModified(): Readonly<ModificationSchema> {
     return this[lastModifiedSymbol]
   }
 
@@ -424,7 +434,7 @@ export class File extends StoredFile {
    */
   labels?: string[];
 
-  [capabilitiesSymbol]?: Readonly<ICapabilities>
+  [capabilitiesSymbol]?: Readonly<CapabilitiesSchema>
 
   /**
    * This is populated when reading a file from the store.
@@ -432,11 +442,11 @@ export class File extends StoredFile {
    *
    * This is a readonly field and it is ignored when creating / updating the file.
    */
-  get capabilities(): Readonly<ICapabilities> | undefined {
+  get capabilities(): Readonly<CapabilitiesSchema> | undefined {
     return this[capabilitiesSymbol]
   }
 
-  [permissionsSymbol]: readonly IPermission[] = []
+  [permissionsSymbol]: readonly PermissionSchema[] = []
 
   /**
    * Populated by the server when reading the file. The list of permissions to the object.
@@ -444,12 +454,12 @@ export class File extends StoredFile {
    * This property cannot be manipulated directly by the client. Should be treated as
    * opaque value.
    */
-  get permissions(): readonly IPermission[] {
+  get permissions(): readonly PermissionSchema[] {
     return this[permissionsSymbol]
   }
 
-  static override createSchema(input: Partial<IFile> = {}): IFile {
-    const result = StoredFile.createSchema(input) as IFile
+  static override createSchema(input: Partial<FileSchema> = {}): FileSchema {
+    const result = StoredFile.createSchema(input) as FileSchema
     if (Array.isArray(input.parents)) {
       result.parents = [...input.parents]
     } else {
@@ -486,7 +496,7 @@ export class File extends StoredFile {
     return result
   }
 
-  constructor(state?: Partial<IFile>) {
+  constructor(state?: Partial<FileSchema>) {
     const init = File.createSchema(state)
     super(init)
     this[parentsSymbol] = [...init.parents]
@@ -506,7 +516,7 @@ export class File extends StoredFile {
   /**
    * @deprecated Use `createSchema()` and setup values in the constructor instead.
    */
-  override new(init: IFile): this {
+  override new(init: FileSchema): this {
     super.new(init)
     const { permissions = [], parents = [], permissionIds = [], deleted, deletedInfo, lastModified, labels } = init
     this[permissionsSymbol] = permissions.map((i) => ({ ...i }))
@@ -530,8 +540,8 @@ export class File extends StoredFile {
     return this
   }
 
-  override toJSON(): IFile {
-    const result: IFile = {
+  override toJSON(): FileSchema {
+    const result: FileSchema = {
       ...super.toJSON(),
       parents: [...this.parents],
       permissionIds: [...this.permissionIds],
@@ -540,7 +550,7 @@ export class File extends StoredFile {
     }
     if (this.deleted) {
       result.deleted = this.deleted
-      result.deletedInfo = { ...this.deletedInfo } as IDeletion
+      result.deletedInfo = { ...this.deletedInfo } as DeletionSchema
     }
     if (Array.isArray(this.labels)) {
       result.labels = [...this.labels]
@@ -568,7 +578,7 @@ export class File extends StoredFile {
    *
    * @param user The user that modifies the entity.
    */
-  setLastModified(user: IUser): void {
+  setLastModified(user: UserSchema): void {
     if (!user) {
       throw new Error(`The user is required.`)
     }
@@ -615,7 +625,7 @@ export class File extends StoredFile {
    *
    * @param user The user that deletes the entity.
    */
-  setDeleted(user: IUser): void {
+  setDeleted(user: UserSchema): void {
     if (!user) {
       throw new Error(`The user is required.`)
     }

package/src/models/store/Group.ts

@@ -1,5 +1,5 @@
 import { GroupKind } from '../kinds.js'
-import type { IDeletion } from './Deletion.js'
+import type { DeletionSchema } from './Deletion.js'
 import { nanoid } from '../../nanoid.js'
 
 /**
@@ -76,7 +76,7 @@ export interface GroupSchema {
    * This field is ignored by the API and is set automatically.
    * @readonly
    */
-  deleteInfo?: IDeletion
+  deleteInfo?: DeletionSchema
 }
 
 export class Group implements GroupSchema {
@@ -91,7 +91,7 @@ export class Group implements GroupSchema {
   users: string[] = []
   createdAt = 0
   updatedAt = 0
-  deleteInfo?: IDeletion
+  deleteInfo?: DeletionSchema
 
   static createSchema(input: Partial<GroupSchema> = {}): GroupSchema {
     const { key = nanoid() } = input

package/src/models/store/Invitation.ts

@@ -1,6 +1,6 @@
 import { nanoid } from '../../nanoid.js'
 import { InvitationKind } from '../kinds.js'
-import type { IDeletion } from './Deletion.js'
+import type { DeletionSchema } from './Deletion.js'
 import type { UserOrganizationGrantType } from './Organization.js'
 import type { Operation } from '@api-client/json/types.js'
 import { Builder } from '@api-client/json/patch/builder.js'
@@ -73,7 +73,7 @@ export interface InvitationSchema {
    * The information about the delete information.
    * Always set when the `delete` is true.
    */
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
   /**
    * The timestamp when the invitation was created.
    */
@@ -110,7 +110,7 @@ export class Invitation implements InvitationSchema {
   status: InvitationStatus
   grantType: UserOrganizationGrantType
   deleted: boolean
-  deletedInfo: IDeletion | undefined
+  deletedInfo: DeletionSchema | undefined
   createdAt: number
   updatedAt: number
   resent: number

package/src/models/store/Modification.ts

@@ -1,7 +1,7 @@
 /**
  * Information about a modification of a File.
  */
-export interface IModification {
+export interface ModificationSchema {
   /**
    * The key of the user modifying the record.
    */
@@ -22,3 +22,8 @@ export interface IModification {
    */
   time: number
 }
+
+/**
+ * @deprecated Use {@link ModificationSchema} instead.
+ */
+export type IModification = ModificationSchema

package/src/models/store/Organization.ts

@@ -1,5 +1,5 @@
 import { nanoid } from '../../nanoid.js'
-import type { IDeletion } from './Deletion.js'
+import type { DeletionSchema } from './Deletion.js'
 import { OrganizationKind } from '../kinds.js'
 
 export type UserOrganizationGrantType = 'owner' | 'manager' | 'editor' | 'viewer'
@@ -9,7 +9,7 @@ export type UserOrganizationGrantType = 'owner' | 'manager' | 'editor' | 'viewer
  * This association allows the user to use different identity providers that map to the same user, as long as the
  * email stays consistent.
  */
-export interface IOrganization {
+export interface OrganizationSchema {
   kind: typeof OrganizationKind
   /**
    * The database ID
@@ -19,6 +19,10 @@ export interface IOrganization {
    * The organization name
    */
   name: string
+  /**
+   * The organization slug. It is used to identify the organization in the URL.
+   */
+  slug: string
   /**
    * The key of the user that created the organization.
    */
@@ -35,7 +39,7 @@ export interface IOrganization {
    * The information about the delete information.
    * Always set when the `delete` is true.
    */
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
   /**
    * The grant type to the organization the **current user** has.
    * By nature, it's a dynamic field populated by the data store.
@@ -43,86 +47,67 @@ export interface IOrganization {
   grantType: UserOrganizationGrantType
 }
 
-export class Organization implements IOrganization {
-  kind: typeof OrganizationKind = OrganizationKind
+/**
+ * @deprecated use OrganizationSchema instead.
+ */
+export type IOrganization = OrganizationSchema
+
+export class Organization implements OrganizationSchema {
+  readonly kind: typeof OrganizationKind = OrganizationKind
   key = ''
   name = ''
+  slug = ''
   createdBy = ''
   createdDate = 0
   deleted = false
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
   grantType: UserOrganizationGrantType = 'viewer'
 
-  constructor(input?: string | IOrganization) {
-    let init: IOrganization
-    if (typeof input === 'string') {
-      init = JSON.parse(input)
-    } else if (typeof input === 'object') {
-      init = input
-    } else {
-      init = {
-        kind: OrganizationKind,
-        key: nanoid(),
-        name: '',
-        createdBy: '',
-        createdDate: Date.now(),
-        deleted: false,
-        grantType: 'viewer',
-      }
-    }
-    this.new(init)
-  }
-
-  new(init: IOrganization): void {
-    if (!Organization.isOrganization(init)) {
-      throw new Error(`Not an Organization.`)
+  static createSchema(input: Partial<OrganizationSchema> = {}): OrganizationSchema {
+    const { key = nanoid() } = input
+    const result: OrganizationSchema = {
+      kind: OrganizationKind,
+      key,
+      name: input.name || 'Unnamed organization',
+      slug: input.slug || '',
+      createdBy: input.createdBy || '',
+      createdDate: input.createdDate || Date.now(),
+      deleted: input.deleted || false,
+      grantType: input.grantType || 'viewer',
     }
-    const {
-      key = nanoid(),
-      name,
-      createdBy,
-      createdDate = Date.now(),
-      deleted = false,
-      deletedInfo,
-      grantType = 'viewer',
-    } = init
-    this.kind = OrganizationKind
-    this.key = key
-    this.name = name
-    this.createdBy = createdBy
-    this.createdDate = createdDate
-    this.deleted = deleted
-    this.grantType = grantType
-    if (deletedInfo) {
-      this.deletedInfo = deletedInfo
-    } else {
-      this.deletedInfo = undefined
+    if (input.deletedInfo) {
+      result.deletedInfo = input.deletedInfo
     }
+    return result
   }
 
-  /**
-   * Checks whether the input is a definition of an user organization.
-   */
-  static isOrganization(input: unknown): boolean {
-    const typed = input as IOrganization
-    if (!input || typed.kind !== OrganizationKind) {
-      return false
+  constructor(state?: Partial<OrganizationSchema>) {
+    const init = Organization.createSchema(state)
+    this.key = init.key
+    this.name = init.name
+    this.slug = init.slug
+    this.createdBy = init.createdBy
+    this.createdDate = init.createdDate
+    this.deleted = init.deleted ?? false
+    this.grantType = init.grantType
+    if (init.deletedInfo) {
+      this.deletedInfo = { ...init.deletedInfo }
     }
-    return true
   }
 
-  toJSON(): IOrganization {
-    const result: IOrganization = {
+  toJSON(): OrganizationSchema {
+    const result: OrganizationSchema = {
       kind: OrganizationKind,
       key: this.key,
       name: this.name,
+      slug: this.slug,
       createdBy: this.createdBy,
       createdDate: this.createdDate,
       deleted: this.deleted,
       grantType: this.grantType,
     }
     if (this.deletedInfo) {
-      result.deletedInfo = this.deletedInfo
+      result.deletedInfo = { ...this.deletedInfo }
     }
     return result
   }

package/src/models/store/Permission.ts

@@ -81,7 +81,7 @@ interface IBasePermission {
 /**
  * A schema describing a permission to a store object.
  */
-export interface IPermission extends IBasePermission {
+export interface PermissionSchema extends IBasePermission {
   kind: typeof Kind
   /**
    * The data store key of the permission.
@@ -90,6 +90,11 @@ export interface IPermission extends IBasePermission {
   key: string
 }
 
+/**
+ * @deprecated Use {@link PermissionSchema} instead.
+ */
+export type IPermission = PermissionSchema
+
 export class Permission {
   kind = Kind
   /**
@@ -164,7 +169,7 @@ export class Permission {
    * @param addingUser The key of the user that created this permission
    */
   static fromUserRole(role: PermissionRole, itemId: string, user: string, addingUser: string): Permission {
-    const init: IPermission = {
+    const init: PermissionSchema = {
       key: nanoid(),
       kind: Kind,
       itemId,
@@ -187,7 +192,7 @@ export class Permission {
    * @param addingUser The key of the user that created this permission
    */
   static fromGroupRole(role: PermissionRole, itemId: string, group: string, addingUser: string): Permission {
-    const init: IPermission = {
+    const init: PermissionSchema = {
       key: nanoid(),
       kind: Kind,
       itemId,
@@ -214,7 +219,7 @@ export class Permission {
     organizationId: string,
     addingUser: string
   ): Permission {
-    const init: IPermission = {
+    const init: PermissionSchema = {
       key: nanoid(),
       kind: Kind,
       itemId,
@@ -239,8 +244,8 @@ export class Permission {
     })
   }
 
-  constructor(input?: string | IPermission) {
-    let init: IPermission
+  constructor(input?: string | PermissionSchema) {
+    let init: PermissionSchema
     if (typeof input === 'string') {
       init = JSON.parse(input)
     } else if (typeof input === 'object') {
@@ -261,7 +266,7 @@ export class Permission {
     this.new(init)
   }
 
-  new(init: IPermission): void {
+  new(init: PermissionSchema): void {
     if (!Permission.isPermission(init)) {
       throw new Error(`Not a permission.`)
     }
@@ -299,7 +304,7 @@ export class Permission {
   }
 
   static isPermission(input: unknown): boolean {
-    const typed = input as IPermission
+    const typed = input as PermissionSchema
     if (!input || typed.kind !== Kind) {
       return false
     }
@@ -352,7 +357,7 @@ export class Permission {
    * @param permissions The list of permissions to check.
    * @returns True if the user has the required role.
    */
-  static hasRoleIn(minimumLevel: PermissionRole, permissions: IPermission[]): boolean {
+  static hasRoleIn(minimumLevel: PermissionRole, permissions: PermissionSchema[]): boolean {
     if (!permissions || !permissions.length) {
       return false
     }
@@ -363,7 +368,7 @@ export class Permission {
     const closestPermissions = sorted.filter((p) => p.depth === closestDepth)
 
     // 2. Specificity: User > Group > Organization
-    let effectivePermission: IPermission | undefined
+    let effectivePermission: PermissionSchema | undefined
 
     // Check for user permissions
     const userPermissions = closestPermissions.filter((p) => p.type === 'user')
@@ -397,8 +402,8 @@ export class Permission {
     return Permission.hasRole(minimumLevel, effectivePermission.role)
   }
 
-  toJSON(): IPermission {
-    const result: IPermission = {
+  toJSON(): PermissionSchema {
+    const result: PermissionSchema = {
       kind: Kind,
       key: this.key,
       role: this.role,