@api-client/core 0.11.11 → 0.12.1

package/src/models/HostRule.ts

@@ -1,4 +1,4 @@
-import v4 from '../lib/uuid.js'
+import { nanoid } from 'nanoid'
 
 export const Kind = 'Core#HostRule'
 
@@ -56,7 +56,7 @@ export class HostRule {
 
   static fromValues(from: string, to: string): HostRule {
     const result = new HostRule({
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
       from,
       to,
@@ -76,7 +76,7 @@ export class HostRule {
       init = input
     } else {
       init = {
-        key: v4(),
+        key: nanoid(),
         kind: Kind,
         from: '',
         to: '',
@@ -94,7 +94,7 @@ export class HostRule {
     if (!HostRule.isHostRule(init)) {
       throw new Error(`Not a HostRule.`)
     }
-    const { from = '', to = '', enabled, comment, key = v4() } = init
+    const { from = '', to = '', enabled, comment, key = nanoid() } = init
     this.kind = Kind
     this.key = key
     this.from = from

package/src/models/HttpProject.ts

@@ -12,7 +12,7 @@ import { IProjectFolder, ProjectFolder } from './ProjectFolder.js'
 import { IProjectRequest, ProjectRequest, Kind as ProjectRequestKind } from './ProjectRequest.js'
 import { ProjectSchema, IProjectSchema } from './ProjectSchema.js'
 import { Request } from './Request.js'
-import v4 from '../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import { ARCSavedRequest, ARCHistoryRequest } from './legacy/request/ArcRequest.js'
 import { ArcLegacyProject, ARCProject } from './legacy/models/ArcLegacyProject.js'
 import { PostmanDataTransformer } from './transformers/PostmanDataTransformer.js'
@@ -372,7 +372,7 @@ export class HttpProject extends ProjectParent {
     } else {
       init = {
         kind: Kind,
-        key: v4(),
+        key: nanoid(),
         definitions: {},
         items: [],
         info: Thing.fromName('').toJSON(),
@@ -390,7 +390,7 @@ export class HttpProject extends ProjectParent {
     if (!init || !init.definitions || !init.items) {
       throw new Error(`Not a project.`)
     }
-    const { key = v4(), definitions = {}, items, info, license, provider } = init
+    const { key = nanoid(), definitions = {}, items, info, license, provider } = init
     this.key = key
     if (license) {
       this.license = new License(license)
@@ -739,7 +739,7 @@ export class HttpProject extends ProjectParent {
       finalRequest = new ProjectRequest(this, request)
     }
     if (!finalRequest.key) {
-      finalRequest.key = v4()
+      finalRequest.key = nanoid()
     }
 
     let root: ProjectFolder | HttpProject
@@ -1039,7 +1039,7 @@ export class HttpProject extends ProjectParent {
   clone(opts: IProjectCloneOptions = {}): HttpProject {
     const copy = new HttpProject(this.toJSON())
     if (!opts.withoutRevalidate) {
-      copy.key = v4()
+      copy.key = nanoid()
       HttpProject.regenerateKeys(copy)
     }
     return copy
@@ -1072,7 +1072,7 @@ export class HttpProject extends ProjectParent {
       if (!indexObject) {
         return
       }
-      const newKey = v4()
+      const newKey = nanoid()
       indexObject.key = newKey
       folder.key = newKey
     })
@@ -1082,15 +1082,15 @@ export class HttpProject extends ProjectParent {
       if (!indexObject) {
         return
       }
-      const newKey = v4()
+      const newKey = nanoid()
       indexObject.key = newKey
       request.key = newKey
     })
     ;(definitions.schemas || []).forEach((schema) => {
-      schema.key = v4()
+      schema.key = nanoid()
     })
     ;(definitions.certificates || []).forEach((cert) => {
-      cert.key = v4()
+      cert.key = nanoid()
     })
     ;(definitions.environments || []).forEach((environment) => {
       const oldKey = environment.key
@@ -1098,7 +1098,7 @@ export class HttpProject extends ProjectParent {
       if (!indexObject) {
         return
       }
-      const newKey = v4()
+      const newKey = nanoid()
       indexObject.key = newKey
       environment.key = newKey
     })
@@ -1133,7 +1133,7 @@ export class HttpProject extends ProjectParent {
       finalSchema = new ProjectSchema(schema)
     }
     if (!finalSchema.key) {
-      finalSchema.key = v4()
+      finalSchema.key = nanoid()
     }
     const { index } = opts
     const hasIndex = typeof index === 'number'
@@ -1328,7 +1328,7 @@ export class HttpProject extends ProjectParent {
       finalEnv = new Environment(env)
     }
     if (!finalEnv.key) {
-      finalEnv.key = v4()
+      finalEnv.key = nanoid()
     }
     return finalEnv
   }

package/src/models/Project.ts

@@ -1,7 +1,7 @@
+import { nanoid } from 'nanoid'
 import { IFile, File } from './store/File.js'
 import { Thing } from './Thing.js'
 import { HttpProject, IHttpProject } from './HttpProject.js'
-import v4 from '../lib/uuid.js'
 import { ProjectKind } from './kinds.js'
 
 /**
@@ -58,7 +58,7 @@ export class Project extends File {
     } else {
       init = {
         kind: ProjectKind,
-        key: v4(),
+        key: nanoid(),
         organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],

package/src/models/ProjectFolder.ts

@@ -1,3 +1,4 @@
+import { nanoid } from 'nanoid'
 import { ProjectParent } from './ProjectParent.js'
 import { type IProjectDefinitionProperty } from './ProjectDefinitionProperty.js'
 import { ProjectItem, type IProjectItem } from './ProjectItem.js'
@@ -6,7 +7,6 @@ import { type HttpProject, type IEnvironmentCreateOptions } from './HttpProject.
 import { type IThing, Thing } from './Thing.js'
 import { Environment, type IEnvironment } from './Environment.js'
 import { ProjectFolderKind } from './kinds.js'
-import v4 from '../lib/uuid.js'
 
 export const DefaultFolderName = 'New folder'
 
@@ -110,7 +110,7 @@ export class ProjectFolder extends ProjectParent {
         created: now,
         updated: now,
         items: [],
-        key: v4(),
+        key: nanoid(),
       }
     }
     this.new(init)
@@ -125,7 +125,7 @@ export class ProjectFolder extends ProjectParent {
     if (!ProjectFolder.isProjectFolder(init)) {
       throw new Error(`Not a project folder.`)
     }
-    const { key = v4(), created = Date.now(), updated = Date.now(), items, info } = init
+    const { key = nanoid(), created = Date.now(), updated = Date.now(), items, info } = init
     this.kind = ProjectFolderKind
     this.key = key
     this.created = created
@@ -175,7 +175,7 @@ export class ProjectFolder extends ProjectParent {
    */
   static fromName(project: HttpProject, name = DefaultFolderName): ProjectFolder {
     const now = Date.now()
-    const key = v4()
+    const key = nanoid()
     const info = Thing.fromName(name)
     const definition = new ProjectFolder(project, {
       key,
@@ -350,7 +350,7 @@ export class ProjectFolder extends ProjectParent {
   clone(opts: IFolderCloneOptions = {}): ProjectFolder {
     const { targetProject = this.project, targetFolder } = opts
     const copy = new ProjectFolder(targetProject, this.toJSON())
-    copy.key = v4()
+    copy.key = nanoid()
 
     const extProject = targetProject !== this.project
     if (extProject) {
@@ -428,7 +428,7 @@ export class ProjectFolder extends ProjectParent {
         return
       }
       const copy = new ProjectFolder(folder.getProject(), definition.toJSON())
-      copy.key = v4()
+      copy.key = nanoid()
       copy.items = []
       folder.addFolder(copy)
       if (withRequests) {

package/src/models/ProjectRequest.ts

@@ -1,8 +1,8 @@
+import { nanoid } from 'nanoid'
 import { ProjectDefinitionProperty, IProjectDefinitionProperty } from './ProjectDefinitionProperty.js'
 import { ProjectFolder } from './ProjectFolder.js'
 import { IHttpRequest, Kind as HttpRequestKind } from './HttpRequest.js'
 import { HttpProject } from './HttpProject.js'
-import v4 from '../lib/uuid.js'
 import { IRequest, Request } from './Request.js'
 import { Environment } from './Environment.js'
 import { Property } from './Property.js'
@@ -109,7 +109,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     }
     const now: number = Date.now()
     const request = new ProjectRequest(project, {
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
       created: now,
       updated: now,
@@ -136,7 +136,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     }
     const now: number = Date.now()
     const request = new ProjectRequest(project, {
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
       created: now,
       updated: now,
@@ -163,7 +163,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     }
     const now: number = Date.now()
     const request = new ProjectRequest(project, {
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
       created: now,
       updated: now,
@@ -183,7 +183,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
    * Creates a project request for a schema of a Request.
    */
   static fromRequest(request: IRequest, project: HttpProject): ProjectRequest {
-    const key = v4()
+    const key = nanoid()
     const init: IProjectRequest = { ...request, key, kind: Kind }
     const result = new ProjectRequest(project, init)
     return result
@@ -200,7 +200,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     } else {
       const now: number = Date.now()
       init = {
-        key: v4(),
+        key: nanoid(),
         kind: Kind,
         created: now,
         updated: now,
@@ -219,7 +219,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     super.new(init)
 
     const { key, environment } = init as IProjectRequest
-    this.key = key || v4()
+    this.key = key || nanoid()
     if (environment) {
       this.environment = environment
     }
@@ -282,7 +282,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
   clone(opts: IRequestCloneOptions = {}): ProjectRequest {
     const copy = new ProjectRequest(this.project, this.toJSON())
     if (!opts.withoutRevalidate) {
-      copy.key = v4()
+      copy.key = nanoid()
     }
     if (!opts.withoutAttach) {
       // if the parent is the project then add the request to the project.

package/src/models/ProjectSchema.ts

@@ -1,4 +1,4 @@
-import v4 from '../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import { Property, IProperty, PropertyType, Kind as PropertyKind } from './Property.js'
 export const Kind = 'Core#ProjectSchema'
 
@@ -78,7 +78,7 @@ export class ProjectSchema {
     const init: IProjectSchema = {
       kind: Kind,
       name,
-      key: v4(),
+      key: nanoid(),
     }
     return new ProjectSchema(init)
   }
@@ -94,7 +94,7 @@ export class ProjectSchema {
     const init: IProjectSchema = {
       kind: Kind,
       name,
-      key: v4(),
+      key: nanoid(),
       content,
       mime,
     }
@@ -114,7 +114,7 @@ export class ProjectSchema {
       init = {
         kind: Kind,
         name: '',
-        key: v4(),
+        key: nanoid(),
       }
     }
     this.new(init)
@@ -124,7 +124,7 @@ export class ProjectSchema {
    * Creates a new schema definition clearing anything that is so far defined.
    */
   new(init: IProjectSchema): void {
-    const { key = v4(), content, properties, mime, name = '' } = init
+    const { key = nanoid(), content, properties, mime, name = '' } = init
     this.name = name
     this.key = key
     if (content) {
@@ -148,7 +148,7 @@ export class ProjectSchema {
     const result: IProjectSchema = {
       kind: Kind,
       name: this.name || '',
-      key: this.key || v4(),
+      key: this.key || nanoid(),
     }
     if (this.content) {
       result.content = this.content

package/src/models/Thing.ts

@@ -1,4 +1,6 @@
 import { ThingKind } from './kinds.js'
+import { ModelValidationOptions } from './types.js'
+import { observed } from '../modeling/observed.js'
 
 /**
  * An interface describing a base metadata of a thing.
@@ -28,31 +30,33 @@ export declare interface IThing {
   version?: string
 }
 
-export class Thing {
+export class Thing extends EventTarget {
   kind = ThingKind
   /**
    * The name of the thing.
    */
-  name?: string
+  @observed() accessor name: string | undefined
   /**
    * Optional value to overwrite the `name` in the UI.
    * The primary descriptive field is the `name`. The display name is only used in the presentation of the data.
    */
-  displayName?: string
+  @observed() accessor displayName: string | undefined
   /**
    * The description of the thing.
    */
-  description?: string
+  @observed() accessor description: string | undefined
   /**
    * The version number of the thing.
    */
-  version?: string
+  @observed() accessor version: string | undefined
 
   /**
    * Returns one in this order:
    * - displayName
    * - name
    * - 'Unnamed object'
+   *
+   * @deprecated Use `getLabel()` instead.
    */
   get renderLabel(): string {
     return this.displayName || this.name || 'Unnamed object'
@@ -69,10 +73,42 @@ export class Thing {
     return thing
   }
 
+  /**
+   * Creates a new thing instance.
+   *
+   * @param input The thing definition used to restore the state.
+   */
+  static fromJSON(input: Partial<IThing> = {}, defaults: Partial<IThing> = {}): Thing {
+    const result = new Thing()
+    const { name, displayName, description, version } = input || {}
+    if (typeof name === 'string') {
+      result.name = name
+    } else if (typeof defaults.name === 'string') {
+      result.name = defaults.name
+    }
+    if (typeof displayName === 'string') {
+      result.displayName = displayName
+    } else if (typeof defaults.displayName === 'string') {
+      result.displayName = defaults.displayName
+    }
+    if (description) {
+      result.description = description
+    } else if (typeof defaults.description === 'string') {
+      result.description = defaults.description
+    }
+    if (version) {
+      result.version = version
+    } else if (typeof defaults.version === 'string') {
+      result.version = defaults.version
+    }
+    return result
+  }
+
   /**
    * @param input The thing definition used to restore the state.
    */
   constructor(input?: string | IThing) {
+    super()
     let init: IThing
     if (typeof input === 'string') {
       init = JSON.parse(input)
@@ -103,6 +139,22 @@ export class Thing {
     this.version = version
   }
 
+  notifyChange(): void {
+    this.dispatchEvent(new Event('change'))
+  }
+
+  static validate(input: unknown, options: ModelValidationOptions = {}): boolean {
+    const { strict } = options
+    if (input && typeof input === 'object') {
+      const typed = input as IThing
+      if (strict && typed.kind !== ThingKind) {
+        return false
+      }
+      return true
+    }
+    return false
+  }
+
   /**
    * Checks whether the input is a definition of a server.
    */
@@ -132,4 +184,17 @@ export class Thing {
     }
     return result
   }
+
+  /**
+   * Returns one in this order:
+   * - `this.displayName`
+   * - `this.name`
+   * - `defaultName`
+   * - 'Unnamed object'
+   *
+   * @param defaultName The default name to use when no other is available.
+   */
+  getLabel(defaultName?: string): string {
+    return this.displayName || this.name || defaultName || 'Unnamed object'
+  }
 }

package/src/models/kinds.ts

@@ -2,16 +2,42 @@ export const ProjectFolderKind = 'Core#ProjectFolder'
 export const ResponseKind = 'Core#HttpResponse'
 export const HttpResponseKind = 'Core#HttpResponse'
 export const CertificateFileKind = 'Core#CertificateFile'
-export const DataNamespaceKind = 'Core#DataNamespace'
-export const DataModelKind = 'Core#DataModel'
-export const DataEntityKind = 'Core#DataEntity'
-export const DataAssociationKind = 'Core#DataAssociation'
-export const DataPropertyKind = 'Core#DataProperty'
 export const FolderKind = 'Core#Folder'
 export const ProjectKind = 'Core#Project'
 export const ThingKind = 'Core#Thing'
-export const DataFileKind = 'Core#DataFile'
 export const DeletionKind = 'Core#Deletion'
 export const RevisionKind = 'Core#Revision'
 export const UnresolvedDependencyKind = 'Core#UnresolvedDependency'
 export const UserKind = 'Core#User'
+export const DomainFileKind = 'Data#DomainFile'
+export const DataDomainKind = 'Data#Domain'
+export const DomainNamespaceKind = 'Domain#Namespace'
+export const DomainModelKind = 'Domain#Model'
+export const DomainEntityKind = 'Domain#Entity'
+export const DomainAssociationKind = 'Domain#Association'
+export const DomainPropertyKind = 'Domain#Property'
+
+/**
+ * @deprecated Not used anymore.
+ */
+export const DataFileKind = 'Core#DataFile'
+/**
+ * @deprecated Not used anymore.
+ */
+export const DataNamespaceKind = 'Data#DataNamespace'
+/**
+ * @deprecated Not used anymore.
+ */
+export const DataModelKind = 'Data#DataModel'
+/**
+ * @deprecated Not used anymore.
+ */
+export const DataEntityKind = 'Data#DataEntity'
+/**
+ * @deprecated Not used anymore.
+ */
+export const DataAssociationKind = 'Data#DataAssociation'
+/**
+ * @deprecated Not used anymore.
+ */
+export const DataPropertyKind = 'Data#DataProperty'

package/src/models/store/DataFile.ts

@@ -1,7 +1,7 @@
-import v4 from '../../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import { File, IFile } from './File.js'
 import { Thing } from '../Thing.js'
-import { DataNamespace, IDataNamespace } from '../../modeling/DataNamespace.js'
+import { DataNamespace, IDataNamespace } from '../../modeling/legacy/DataNamespace.js'
 import { DataFileKind as Kind } from '../kinds.js'
 
 export interface IDataFile extends IFile {
@@ -10,6 +10,7 @@ export interface IDataFile extends IFile {
 
 /**
  * Used by the store. A file definition for the DataNamespace
+ * @deprecated Use DomainFile instead.
  */
 export class DataFile extends File {
   override kind = Kind
@@ -19,6 +20,7 @@ export class DataFile extends File {
    *
    * @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 {
     let final: IDataNamespace
@@ -59,7 +61,7 @@ export class DataFile extends File {
     } else {
       init = {
         kind: Kind,
-        key: v4(),
+        key: nanoid(),
         organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],

package/src/models/store/File.ts

@@ -1,9 +1,9 @@
+import { nanoid } from 'nanoid'
 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 v4 from '../../lib/uuid.js'
 import { ICapabilities } from './Capabilities.js'
 import { FolderKind } from '../kinds.js'
 // this causes error
@@ -206,7 +206,7 @@ export class StoredFile {
   }
 
   new(init: IStoredFile): this {
-    const { key = v4(), info, kind, owner, iconColor, organization, shortcutTarget } = init
+    const { key = nanoid(), info, kind, owner, iconColor, organization, shortcutTarget } = init
     this.key = key
     this.organization = organization
     this.kind = kind
@@ -485,7 +485,7 @@ export class File extends StoredFile {
    * @param owner The user id that is the owner of the file.
    */
   static fromName(name: string, organization: string, owner?: string, kind = ''): File {
-    const key = v4()
+    const key = nanoid()
     const definition = new File()
     definition.new({
       key,

package/src/models/store/Organization.ts

@@ -1,4 +1,4 @@
-import v4 from '../../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import type { IDeletion } from './Deletion.js'
 
 export const Kind = 'Core#Organization'
@@ -63,7 +63,7 @@ export class Organization implements IOrganization {
     } else {
       init = {
         kind: Kind,
-        key: v4(),
+        key: nanoid(),
         name: '',
         createdBy: '',
         createdDate: Date.now(),
@@ -79,7 +79,7 @@ export class Organization implements IOrganization {
       throw new Error(`Not an Organization.`)
     }
     const {
-      key = v4(),
+      key = nanoid(),
       name,
       createdBy,
       createdDate = Date.now(),

package/src/models/store/Permission.ts

@@ -1,4 +1,4 @@
-import v4 from '../../lib/uuid.js'
+import { nanoid } from 'nanoid'
 
 export const Kind = 'Core#Permission'
 
@@ -129,7 +129,7 @@ export class Permission {
    */
   static fromUserRole(role: PermissionRole, itemId: string, user: string, addingUser: string): Permission {
     const init: IPermission = {
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
       itemId,
       granteeId: user,
@@ -150,7 +150,7 @@ export class Permission {
    */
   static fromGroupRole(role: PermissionRole, itemId: string, group: string, addingUser: string): Permission {
     const init: IPermission = {
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
       itemId,
       granteeId: group,
@@ -175,7 +175,7 @@ export class Permission {
     addingUser: string
   ): Permission {
     const init: IPermission = {
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
       itemId,
       granteeId: organizationId,
@@ -192,7 +192,7 @@ export class Permission {
   static fromValues(init: IBasePermission): Permission {
     return new Permission({
       ...init,
-      key: v4(),
+      key: nanoid(),
       kind: Kind,
     })
   }
@@ -206,7 +206,7 @@ export class Permission {
     } else {
       init = {
         kind: Kind,
-        key: v4(),
+        key: nanoid(),
         granteeId: '',
         itemId: '',
         role: 'reader',
@@ -221,7 +221,7 @@ export class Permission {
     if (!Permission.isPermission(init)) {
       throw new Error(`Not a permission.`)
     }
-    const { key = v4(), granteeId, role, type, displayName, expirationTime, addingUser, itemId } = init
+    const { key = nanoid(), granteeId, role, type, displayName, expirationTime, addingUser, itemId } = init
     this.kind = Kind
     this.key = key
     this.granteeId = granteeId

package/src/models/store/UserIdentity.ts

@@ -1,4 +1,4 @@
-import v4 from '../../lib/uuid.js'
+import { nanoid } from 'nanoid'
 
 export const Kind = 'Core#UserIdentity'
 
@@ -57,7 +57,7 @@ export class UserIdentity implements IUserIdentity {
     } else {
       init = {
         kind: Kind,
-        key: v4(),
+        key: nanoid(),
         userId: '',
         provider: 'google',
         providerId: '',
@@ -71,7 +71,7 @@ export class UserIdentity implements IUserIdentity {
     if (!UserIdentity.isUserIdentity(init)) {
       throw new Error(`Not a UserIdentity.`)
     }
-    const { key = v4(), emailVerified, provider, providerId, userId, hostDomain } = init
+    const { key = nanoid(), emailVerified, provider, providerId, userId, hostDomain } = init
     this.kind = Kind
     this.key = key
     this.provider = provider