@api-client/core 0.19.16 → 0.19.18

package/src/modeling/helpers/Intelisense.ts

@@ -2,7 +2,7 @@ import type { DomainEntity } from '../DomainEntity.js'
 import type { DomainElement } from '../DomainElement.js'
 import type { DomainProperty } from '../DomainProperty.js'
 import type { DomainAssociation } from '../DomainAssociation.js'
-import type { IThing } from '../../models/Thing.js'
+import type { ThingSchema } from '../../models/Thing.js'
 import { SemanticType } from '../Semantics.js'
 import { createEmailSemantic, DEFAULT_EMAIL_CONFIG } from '../definitions/Email.js'
 import { createPasswordSemantic, DEFAULT_PASSWORD_CONFIG } from '../definitions/Password.js'
@@ -117,7 +117,7 @@ export function addAutoField(entity: DomainEntity, autoField: string): DomainEle
  * @param entity The entity to which the ID field will be added.
  * @returns The added primary field property.
  */
-export function addIdField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addIdField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findIdField(entity, true)
   if (existing) {
     // If the ID field already exists, return it.
@@ -143,7 +143,7 @@ export function addIdField(entity: DomainEntity, info: Partial<IThing> = {}): Do
  * @param entity The entity to which the email field will be added.
  * @returns The added email field property.
  */
-export function addEmailField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addEmailField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findEmailField(entity, true)
   if (existing) {
     return existing
@@ -166,7 +166,7 @@ export function addEmailField(entity: DomainEntity, info: Partial<IThing> = {}):
  * @param info Additional information for the password field.
  * @returns The added password field property.
  */
-export function addPasswordField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addPasswordField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findPasswordField(entity, true)
   if (existing) {
     return existing
@@ -186,7 +186,7 @@ export function addPasswordField(entity: DomainEntity, info: Partial<IThing> = {
  * The version field is used to track the version of the entity.
  * @returns The added version field property.
  */
-export function addVersionField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addVersionField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findVersionField(entity, true)
   if (existing) {
     // If the version field already exists, return it.
@@ -205,7 +205,7 @@ export function addVersionField(entity: DomainEntity, info: Partial<IThing> = {}
   return prop
 }
 
-export function addNameField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addNameField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findNameField(entity, true)
   if (existing) {
     return existing
@@ -220,7 +220,7 @@ export function addNameField(entity: DomainEntity, info: Partial<IThing> = {}):
   return prop
 }
 
-export function addDisplayNameField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addDisplayNameField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findDisplayNameField(entity, true)
   if (existing) {
     return existing
@@ -251,7 +251,7 @@ export function addDisplayNameField(entity: DomainEntity, info: Partial<IThing>
  * @param entity The entity to which the description field will be added.
  * @returns The added description field property.
  */
-export function addDescriptionField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addDescriptionField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findDescriptionField(entity, true)
   if (existing) {
     return existing
@@ -283,7 +283,7 @@ export function addDescriptionField(entity: DomainEntity, info: Partial<IThing>
  * @param info Additional information about the field.
  * @returns The added status field property.
  */
-export function addStatusField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addStatusField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findStatusField(entity, true)
   if (existing) {
     return existing
@@ -320,7 +320,7 @@ export function addStatusField(entity: DomainEntity, info: Partial<IThing> = {})
  * @param info Additional information about the field.
  * @returns The added owner field property.
  */
-export function addOwnerField(entity: DomainEntity, info: Partial<IThing> = {}): DomainAssociation {
+export function addOwnerField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainAssociation {
   const existing = findOwnerField(entity, true)
   if (existing) {
     return existing
@@ -370,7 +370,7 @@ export function addOwnerField(entity: DomainEntity, info: Partial<IThing> = {}):
  * @param info Additional information about the field.
  * @returns The added updated by field property.
  */
-export function addUpdatedByField(entity: DomainEntity, info: Partial<IThing> = {}): DomainAssociation {
+export function addUpdatedByField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainAssociation {
   const existing = findUpdatedByField(entity, true)
   if (existing) {
     return existing
@@ -405,7 +405,7 @@ export function addUpdatedByField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The created created at field.
  */
-export function addCreatedAtField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addCreatedAtField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findCreatedAtField(entity, true)
   if (existing) {
     // If the created_at field already exists, return it.
@@ -444,7 +444,7 @@ export function addCreatedAtField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The created updated at field.
  */
-export function addUpdatedAtField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addUpdatedAtField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findUpdatedAtField(entity, true)
   if (existing) {
     // If the updated_at field already exists, return it.
@@ -484,7 +484,7 @@ export function addUpdatedAtField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The added deleted at field property.
  */
-export function addDeletedAtField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addDeletedAtField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findDeletedAtField(entity, true)
   if (existing) {
     // If the deleted_at field already exists, return it.
@@ -503,7 +503,7 @@ export function addDeletedAtField(entity: DomainEntity, info: Partial<IThing> =
   return prop
 }
 
-export function addRoleField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addRoleField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findRoleField(entity, true)
   if (existing) {
     return existing
@@ -541,7 +541,7 @@ export function addRoleField(entity: DomainEntity, info: Partial<IThing> = {}):
  * @param info Additional information about the field.
  * @returns The added is_deleted field property.
  */
-export function addIsDeletedField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addIsDeletedField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findIsDeletedField(entity, true)
   if (existing) {
     // If the is_deleted field already exists, return it.
@@ -574,7 +574,7 @@ export function addIsDeletedField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The created first name field.
  */
-export function addFirstNameField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addFirstNameField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findFirstNameField(entity)
   if (existing) {
     return existing
@@ -600,7 +600,7 @@ export function addFirstNameField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The created first name field.
  */
-export function addLastNameField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addLastNameField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findLastNameField(entity)
   if (existing) {
     return existing
@@ -630,7 +630,7 @@ export function addLastNameField(entity: DomainEntity, info: Partial<IThing> = {
  * @param info Additional information about the field.
  * @returns The created phone field.
  */
-export function addPhoneField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addPhoneField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findPhoneField(entity, true)
   if (existing) {
     return existing
@@ -668,7 +668,7 @@ export function addPhoneField(entity: DomainEntity, info: Partial<IThing> = {}):
  * @param info Additional information about the field.
  * @returns The created avatar URL field.
  */
-export function addAvatarUrlField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addAvatarUrlField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findAvatarUrlField(entity, true)
   if (existing) {
     return existing
@@ -701,7 +701,7 @@ export function addAvatarUrlField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The created public unique name field.
  */
-export function addPublicUniqueNameField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addPublicUniqueNameField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findPublicUniqueNameField(entity, true)
   if (existing) {
     return existing
@@ -733,7 +733,7 @@ export function addPublicUniqueNameField(entity: DomainEntity, info: Partial<ITh
  * @param info Additional information about the field.
  * @returns The created SKU field.
  */
-export function addSkuField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addSkuField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findSkuField(entity, true)
   if (existing) {
     return existing
@@ -764,7 +764,7 @@ export function addSkuField(entity: DomainEntity, info: Partial<IThing> = {}): D
  * @param info Additional information about the field.
  * @returns The created price field.
  */
-export function addPriceField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addPriceField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findPriceField(entity, true)
   if (existing) {
     return existing
@@ -805,7 +805,7 @@ export function addPriceField(entity: DomainEntity, info: Partial<IThing> = {}):
  * @param info Additional information about the field.
  * @returns The created quantity field.
  */
-export function addQuantityField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addQuantityField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findQuantityField(entity, true)
   if (existing) {
     return existing
@@ -835,7 +835,7 @@ export function addQuantityField(entity: DomainEntity, info: Partial<IThing> = {
  * @param info Additional information about the field.
  * @returns The created weight field.
  */
-export function addWeightField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addWeightField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findWeightField(entity, true)
   if (existing) {
     return existing
@@ -862,7 +862,7 @@ export function addWeightField(entity: DomainEntity, info: Partial<IThing> = {})
  * @param info Additional information about the field.
  * @returns The created images field.
  */
-export function addImagesField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addImagesField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findImagesField(entity, true)
   if (existing) {
     return existing
@@ -900,7 +900,7 @@ export function addImagesField(entity: DomainEntity, info: Partial<IThing> = {})
 export function addCustomStatusField(
   entity: DomainEntity,
   enumValues: string[],
-  info: Partial<IThing> = {}
+  info: Partial<ThingSchema> = {}
 ): DomainProperty {
   const existing = findStatusField(entity, true)
   if (existing) {
@@ -942,7 +942,7 @@ export function addBooleanField(
   entity: DomainEntity,
   fieldName: string,
   defaultValue = 'false',
-  info: Partial<IThing> = {}
+  info: Partial<ThingSchema> = {}
 ): DomainProperty {
   const existing = findBooleanField(entity, fieldName, true)
   if (existing) {
@@ -976,7 +976,7 @@ export function addBooleanField(
  * @param info Additional information about the field.
  * @returns The created session ID field.
  */
-export function addSessionIdField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addSessionIdField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findSessionIdField(entity, true)
   if (existing) {
     return existing
@@ -1002,7 +1002,7 @@ export function addSessionIdField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The created expiration field.
  */
-export function addExpiresAtField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addExpiresAtField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findExpiresAtField(entity, true)
   if (existing) {
     return existing
@@ -1029,7 +1029,7 @@ export function addExpiresAtField(entity: DomainEntity, info: Partial<IThing> =
  * @param info Additional information about the field.
  * @returns The created unit price field.
  */
-export function addUnitPriceField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addUnitPriceField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findUnitPriceField(entity, true)
   if (existing) {
     return existing
@@ -1050,7 +1050,7 @@ export function addCurrencyAmountField(
   entity: DomainEntity,
   fieldName: string,
   displayName: string,
-  info: Partial<IThing> = {}
+  info: Partial<ThingSchema> = {}
 ): DomainProperty {
   const prop = entity.addProperty({
     info: {
@@ -1371,7 +1371,7 @@ function findExpiresAtField(entity: DomainEntity, direct = false): DomainPropert
   )
 }
 
-export function addStreetAddressField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addStreetAddressField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findStreetAddressField(entity, true)
   if (existing) return existing
   const prop = entity.addProperty({
@@ -1387,7 +1387,10 @@ function findStreetAddressField(entity: DomainEntity, direct = false): DomainPro
   return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.StreetAddress), direct)
 }
 
-export function addStreetAddressSupplementalField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addStreetAddressSupplementalField(
+  entity: DomainEntity,
+  info: Partial<ThingSchema> = {}
+): DomainProperty {
   // we do not look for duplicates here, because the address can have multiple supplements (like line2, line3, etc.)
   let latest = 0
   for (const prop of entity.properties) {
@@ -1408,7 +1411,7 @@ export function addStreetAddressSupplementalField(entity: DomainEntity, info: Pa
   return prop
 }
 
-export function addCityField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addCityField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findCityField(entity, true)
   if (existing) return existing
   const prop = entity.addProperty({
@@ -1425,7 +1428,7 @@ function findCityField(entity: DomainEntity, direct = false): DomainProperty | u
   return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.City), direct)
 }
 
-export function addPostalCodeField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addPostalCodeField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findPostalCodeField(entity, true)
   if (existing) return existing
   const prop = entity.addProperty({
@@ -1442,7 +1445,7 @@ function findPostalCodeField(entity: DomainEntity, direct = false): DomainProper
   return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.PostalCode), direct)
 }
 
-export function addCountryField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addCountryField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findCountryField(entity, true)
   if (existing) return existing
   const prop = entity.addProperty({
@@ -1459,7 +1462,7 @@ function findCountryField(entity: DomainEntity, direct = false): DomainProperty
   return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.Country), direct)
 }
 
-export function addRegionField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+export function addRegionField(entity: DomainEntity, info: Partial<ThingSchema> = {}): DomainProperty {
   const existing = findRegionField(entity, true)
   if (existing) return existing
   const prop = entity.addProperty({

package/src/models/AiMessage.ts

@@ -1,4 +1,4 @@
-import type { IDeletion } from './store/Deletion.js'
+import type { DeletionSchema } from './store/Deletion.js'
 import { AiMessageKind } from './kinds.js'
 import { nanoid } from '../nanoid.js'
 import type { AiDomainDelta } from '../modeling/ai/types.js'
@@ -47,7 +47,7 @@ export interface AiMessageSchemaBase {
    * The information about the delete information.
    * Always set when the `deleted` is true.
    */
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
 }
 
 /**
@@ -137,7 +137,7 @@ export abstract class AiMessageBase<
   session: string
   text: string
   deleted: boolean
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
 
   protected static createBaseSchema(input: Partial<AiMessageSchemaBase>): Omit<AiMessageSchemaBase, 'role'> {
     const { key = nanoid(), session, text = '', createdAt = 0, updatedAt = 0 } = input

package/src/models/AiSession.ts

@@ -1,4 +1,4 @@
-import type { IDeletion } from './store/Deletion.js'
+import type { DeletionSchema } from './store/Deletion.js'
 import { AiSessionKind } from './kinds.js'
 import { nanoid } from '../nanoid.js'
 import type { AiModelMessage } from './AiMessage.js'
@@ -57,7 +57,7 @@ export interface AiSessionSchema {
    * The information about the delete information.
    * Always set when the `delete` is true.
    */
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
   /**
    * If the session is related to a file (data domain, API model, etc.), this is the key of the file.
    * It is useful to filter session by specific object.
@@ -82,7 +82,7 @@ export class AiSession implements AiSessionSchema {
   createdAt: number
   updatedAt: number
   deleted: boolean
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
   fileKey?: string
 
   /**

package/src/models/CertificateFile.ts

@@ -1,10 +1,10 @@
 import { nanoid } from '../nanoid.js'
 import { Certificate, ICertificate } from './ClientCertificate.js'
 import { CertificateFileKind } from './kinds.js'
-import { IFile, File } from './store/File.js'
+import { FileSchema, File } from './store/File.js'
 import { Thing } from './Thing.js'
 
-export interface ICertificateFile extends IFile {
+export interface ICertificateFile extends FileSchema {
   kind: typeof CertificateFileKind
 }
 

package/src/models/Environment.ts

@@ -1,6 +1,6 @@
 import { Property, IProperty } from './Property.js'
 import { Server, IServer } from './Server.js'
-import { IThing, Thing } from './Thing.js'
+import { ThingSchema, Thing } from './Thing.js'
 import { nanoid } from '../nanoid.js'
 import { ARCVariable } from './legacy/models/Variable.js'
 import { IRequestAuthorization, RequestAuthorization } from './RequestAuthorization.js'
@@ -27,7 +27,7 @@ export interface IEnvironment {
   /**
    * The environment's meta info.
    */
-  info: IThing
+  info: ThingSchema
   /**
    * The server's definition for the environment.
    * When a server is defined for the environment then all request that have no

package/src/models/Folder.ts

@@ -1,4 +1,4 @@
-import { IFile, File } from './store/File.js'
+import { FileSchema, File } from './store/File.js'
 import { nanoid } from '../nanoid.js'
 import { Thing } from './Thing.js'
 import { FolderKind } from './kinds.js'
@@ -6,10 +6,15 @@ import { FolderKind } from './kinds.js'
 /**
  * A definition of a folder.
  */
-export interface IFolder extends IFile {
+export interface FolderSchema extends FileSchema {
   kind: typeof FolderKind
 }
 
+/**
+ * @deprecated Use {@link FolderSchema} instead.
+ */
+export type IFolder = FolderSchema
+
 /**
  * A definition of a folder.
  */
@@ -28,9 +33,9 @@ export class Folder extends File {
   /**
    * @param input The environment definition used to restore the state.
    */
-  constructor(input?: string | IFolder) {
+  constructor(input?: string | FolderSchema) {
     super()
-    let init: IFolder
+    let init: FolderSchema
     if (typeof input === 'string') {
       init = JSON.parse(input)
     } else if (typeof input === 'object') {
@@ -52,7 +57,7 @@ export class Folder extends File {
   /**
    * Creates a new environment clearing anything that is so far defined.
    */
-  override new(init: IFolder): this {
+  override new(init: FolderSchema): this {
     if (!Folder.isFolder(init)) {
       throw new Error(`Not a folder.`)
     }
@@ -65,15 +70,15 @@ export class Folder extends File {
    * Checks whether the input is a definition of a folder.
    */
   static isFolder(input: unknown): boolean {
-    const typed = input as IFolder
+    const typed = input as FolderSchema
     if (!input || typed.kind !== FolderKind) {
       return false
     }
     return true
   }
 
-  override toJSON(): IFolder {
-    const result: IFolder = {
+  override toJSON(): FolderSchema {
+    const result: FolderSchema = {
       ...super.toJSON(),
       kind: FolderKind,
     }

package/src/models/HttpProject.ts

@@ -6,7 +6,7 @@ import { IProjectDefinitionProperty } from './ProjectDefinitionProperty.js'
 import { Environment, IEnvironment, Kind as EnvironmentKind } from './Environment.js'
 import { License, ILicense } from './License.js'
 import { Provider, IProvider } from './Provider.js'
-import { IThing, Thing } from './Thing.js'
+import { ThingSchema, Thing } from './Thing.js'
 import { ProjectItem, IProjectItem } from './ProjectItem.js'
 import { IProjectFolder, ProjectFolder } from './ProjectFolder.js'
 import { IProjectRequest, ProjectRequest, Kind as ProjectRequestKind } from './ProjectRequest.js'
@@ -229,7 +229,7 @@ export interface IHttpProject extends IProjectDefinitionProperty {
   /**
    * The basic information about the project.
    */
-  info: IThing
+  info: ThingSchema
   /**
    * Information about project provider.
    */

package/src/models/ProjectFolder.ts

@@ -4,7 +4,7 @@ import { type IProjectDefinitionProperty } from './ProjectDefinitionProperty.js'
 import { ProjectItem, type IProjectItem } from './ProjectItem.js'
 import { type ProjectRequest, Kind as ProjectRequestKind, type IProjectRequest } from './ProjectRequest.js'
 import { type HttpProject, type IEnvironmentCreateOptions } from './HttpProject.js'
-import { type IThing, Thing } from './Thing.js'
+import { type ThingSchema, Thing } from './Thing.js'
 import { Environment, type IEnvironment } from './Environment.js'
 import { ProjectFolderKind } from './kinds.js'
 
@@ -53,7 +53,7 @@ export interface IProjectFolder extends IProjectDefinitionProperty {
   /**
    * Folder meta
    */
-  info: IThing
+  info: ThingSchema
   /**
    * The ordered list of HTTP requests / folders in the projects.
    * The UI uses this to manipulate the view without changing the definitions.

package/src/models/Request.ts

@@ -1,5 +1,5 @@
 import { IRequestConfig, RequestConfig } from './RequestConfig.js'
-import { Thing, IThing } from './Thing.js'
+import { Thing, ThingSchema } from './Thing.js'
 import { HttpCertificate, Certificate } from './ClientCertificate.js'
 import { IRequestAuthorization, RequestAuthorization } from './RequestAuthorization.js'
 import { IRequestLog, RequestLog, Kind as LogKind } from './RequestLog.js'
@@ -30,7 +30,7 @@ export interface IRequest {
   /**
    * The basic information about the request.
    */
-  info: IThing
+  info: ThingSchema
   /**
    * The HTTP definition of the request.
    */
@@ -432,7 +432,7 @@ export class Request {
   /**
    * Sets the basic information about a project.
    */
-  setInfo(info: IThing): void {
+  setInfo(info: ThingSchema): void {
     this.info = new Thing(info)
     this.updated = Date.now()
   }

package/src/models/Thing.ts

@@ -5,7 +5,7 @@ import { observed } from '../decorators/observed.js'
 /**
  * An interface describing a base metadata of a thing.
  */
-export declare interface IThing {
+export interface ThingSchema {
   /**
    * The data kind. The application ignores the input with an unknown `kind`, unless
    * it can be determined from the context.
@@ -30,6 +30,11 @@ export declare interface IThing {
   version?: string
 }
 
+/**
+ * @deprecated Use {@link ThingSchema} instead.
+ */
+export type IThing = ThingSchema
+
 export class Thing extends EventTarget {
   kind = ThingKind
   /**
@@ -78,7 +83,7 @@ export class Thing extends EventTarget {
    *
    * @param input The thing definition used to restore the state.
    */
-  static fromJSON(input: Partial<IThing> = {}, defaults: Partial<IThing> = {}): Thing {
+  static fromJSON(input: Partial<ThingSchema> = {}, defaults: Partial<ThingSchema> = {}): Thing {
     const result = new Thing()
     const { name, displayName, description, version } = input || {}
     if (typeof name === 'string') {
@@ -107,9 +112,9 @@ export class Thing extends EventTarget {
   /**
    * @param input The thing definition used to restore the state.
    */
-  constructor(input?: string | IThing) {
+  constructor(input?: string | ThingSchema) {
     super()
-    let init: IThing
+    let init: ThingSchema
     if (typeof input === 'string') {
       init = JSON.parse(input)
     } else if (typeof input === 'object') {
@@ -127,7 +132,7 @@ export class Thing extends EventTarget {
    *
    * Note, this throws an error when the server is not a thing.
    */
-  new(init: IThing): void {
+  new(init: ThingSchema): void {
     if (!Thing.isThing(init)) {
       throw new Error(`Not a thing.`)
     }
@@ -146,7 +151,7 @@ export class Thing extends EventTarget {
   static validate(input: unknown, options: ModelValidationOptions = {}): boolean {
     const { strict } = options
     if (input && typeof input === 'object') {
-      const typed = input as IThing
+      const typed = input as ThingSchema
       if (strict && typed.kind !== ThingKind) {
         return false
       }
@@ -159,15 +164,15 @@ export class Thing extends EventTarget {
    * Checks whether the input is a definition of a server.
    */
   static isThing(input: unknown): boolean {
-    const typed = input as IThing
+    const typed = input as ThingSchema
     if (input && typed.kind === ThingKind) {
       return true
     }
     return false
   }
 
-  toJSON(): IThing {
-    const result: IThing = {
+  toJSON(): ThingSchema {
+    const result: ThingSchema = {
       kind: ThingKind,
     }
     if (typeof this.name === 'string') {

package/src/models/TrashEntry.ts

@@ -1,4 +1,4 @@
-import { IDeletion } from './store/Deletion.js'
+import { DeletionSchema } from './store/Deletion.js'
 
 export interface TrashEntryCreate {
   /**
@@ -41,7 +41,7 @@ export interface TrashEntry extends TrashEntryCreate {
   /**
    * The delete info.
    */
-  info: IDeletion
+  info: DeletionSchema
   /**
    * Trash entry capabilities for the user.
    */

package/src/models/store/Capabilities.ts

@@ -3,7 +3,7 @@
  * This is populated by the store each time the user requests
  * a file.
  */
-export interface ICapabilities {
+export interface CapabilitiesSchema {
   /**
    * Whether the user can edit the content of the file.
    * This is always false for folders.
@@ -55,3 +55,8 @@ export interface ICapabilities {
    */
   canMove: boolean
 }
+
+/**
+ * @deprecated Use {@link CapabilitiesSchema} instead.
+ */
+export type ICapabilities = CapabilitiesSchema

package/src/models/store/Deletion.ts

@@ -2,7 +2,7 @@ import { DeletionKind } from '../kinds.js'
 /**
  * A schema describing the delete action performed on an entity.
  */
-export interface IDeletion {
+export interface DeletionSchema {
   /**
    * The deletion kind
    */
@@ -31,3 +31,8 @@ export interface IDeletion {
    */
   byMe: boolean
 }
+
+/**
+ * @deprecated Use DeletionSchema instead.
+ */
+export type IDeletion = DeletionSchema