@api-client/core 0.9.24 → 0.10.0

package/src/models/HttpResponse.ts

@@ -2,8 +2,7 @@ import { ISerializablePayload, SerializablePayload } from './SerializablePayload
 import { PayloadSerializer } from '../lib/transformers/PayloadSerializer.js';
 import { HTTPResponse as LegacyHttpResponse } from './legacy/request/ArcResponse.js';
 import { Normalizer } from './legacy/Normalizer.js';
-
-export const Kind = 'Core#HttpResponse';
+import { HttpResponseKind } from './kinds.js';
 
 export interface IHttpResponse extends ISerializablePayload {
   kind?: string;
@@ -22,7 +21,7 @@ export interface IHttpResponse extends ISerializablePayload {
 }
 
 export class HttpResponse extends SerializablePayload {
-  kind = Kind;
+  kind = HttpResponseKind;
   /**
    * The response status code
    */
@@ -38,7 +37,7 @@ export class HttpResponse extends SerializablePayload {
 
   static fromValues(status: number, statusText?: string, headers?: string): HttpResponse {
     return new HttpResponse({
-      kind: Kind,
+      kind: HttpResponseKind,
       status,
       statusText,
       headers,
@@ -47,7 +46,7 @@ export class HttpResponse extends SerializablePayload {
 
   static async fromLegacy(response: LegacyHttpResponse): Promise<HttpResponse> {
     const init: IHttpResponse = {
-      kind: Kind,
+      kind: HttpResponseKind,
       status: response.status || 0,
     };
     if (response.statusText) {
@@ -77,7 +76,7 @@ export class HttpResponse extends SerializablePayload {
       init = input;
     } else {
       init = {
-        kind: Kind,
+        kind: HttpResponseKind,
         status: 0,
       };
     }
@@ -93,7 +92,7 @@ export class HttpResponse extends SerializablePayload {
     if (!HttpResponse.isHttpResponse(init)) {
       throw new Error(`Not a response.`);
     }
-    const { status, statusText, headers, payload, kind = Kind } = init;
+    const { status, statusText, headers, payload, kind = HttpResponseKind } = init;
     this.kind = kind;
     this.status = status;
     this.statusText = statusText;

package/src/models/Project.ts

@@ -2,15 +2,14 @@ import { IFile, File, DefaultOwner } from "./store/File.js";
 import { Thing } from './Thing.js';
 import { HttpProject, IHttpProject } from './HttpProject.js';
 import v4 from '../lib/uuid.js';
-
-export const Kind = 'Core#Project';
+import { ProjectKind } from "./kinds.js";
 
 /**
  * This model represents a meta data for an HTTP project stored with the data store.
  * This does not include the HTTP project entity, though, it is referenced through the same key.
  */
 export interface IProject extends IFile {
-  kind: typeof Kind;
+  kind: typeof ProjectKind;
 }
 
 /**
@@ -18,7 +17,7 @@ export interface IProject extends IFile {
  * This does not include the HTTP project entity, though, it is referenced through the same key.
  */
 export class Project extends File {
-  override kind = Kind;
+  override kind = ProjectKind;
 
   static fromProject(project: HttpProject | IHttpProject, space: string, owner = DefaultOwner): Project {
     let final: IHttpProject;
@@ -28,7 +27,7 @@ export class Project extends File {
       final = project as IHttpProject;
     }
     const init: IProject = {
-      kind: Kind,
+      kind: ProjectKind,
       key: project.key,
       space,
       info: { ...final.info },
@@ -50,7 +49,7 @@ export class Project extends File {
       init = input;
     } else {
       init = {
-        kind: Kind,
+        kind: ProjectKind,
         key: v4(),
         space: '',
         info: Thing.fromName('').toJSON(),
@@ -69,12 +68,12 @@ export class Project extends File {
       throw new Error(`Not a project file.`);
     }
     super.new(init);
-    this.kind = Kind;
+    this.kind = ProjectKind;
   }
 
   static isProject(input: unknown): boolean {
     const typed = input as IProject;
-    if (!input || typed.kind !== Kind) {
+    if (!input || typed.kind !== ProjectKind) {
       return false;
     }
     return true;
@@ -83,7 +82,7 @@ export class Project extends File {
   override toJSON(): IProject {
     const result: IProject = {
       ...super.toJSON(),
-      kind: Kind,
+      kind: ProjectKind,
     };
     return result;
   }

package/src/models/ProjectFolder.ts

@@ -3,11 +3,11 @@ import { IProjectDefinitionProperty } from './ProjectDefinitionProperty.js';
 import { ProjectItem, IProjectItem } from './ProjectItem.js';
 import { ProjectRequest, Kind as ProjectRequestKind, IProjectRequest } from './ProjectRequest.js';
 import { HttpProject, IEnvironmentCreateOptions } from './HttpProject.js';
-import { IThing, Thing, Kind as ThingKind } from './Thing.js';
+import { IThing, Thing } from './Thing.js';
 import { Environment, IEnvironment } from './Environment.js';
+import { ProjectFolderKind } from './kinds.js';
 import v4 from '../lib/uuid.js';
 
-export const Kind = 'Core#ProjectFolder';
 export const DefaultFolderName = 'New folder';
 
 export interface IFolderAddOptions {
@@ -45,7 +45,7 @@ export interface IFolderCloneOptions {
 }
 
 export interface IProjectFolder extends IProjectDefinitionProperty {
-  kind: typeof Kind;
+  kind: typeof ProjectFolderKind;
   /**
    * The identifier of the folder.
    */
@@ -80,7 +80,7 @@ export class ProjectFolder extends ProjectParent {
     return DefaultFolderName;
   }
 
-  override kind = Kind;
+  override kind = ProjectFolderKind;
   /**
    * A reference to the top level project object.
    */
@@ -105,11 +105,8 @@ export class ProjectFolder extends ProjectParent {
     } else {
       const now: number = Date.now();
       init = {
-        kind: Kind,
-        info: {
-          kind: ThingKind,
-          name: DefaultFolderName,
-        },
+        kind: ProjectFolderKind,
+        info: Thing.fromName(DefaultFolderName).toJSON(),
         created: now,
         updated: now,
         items: [],
@@ -129,7 +126,7 @@ export class ProjectFolder extends ProjectParent {
       throw new Error(`Not a project folder.`);
     }
     const { key = v4(), created = Date.now(), updated = Date.now(), items, info } = init;
-    this.kind = Kind;
+    this.kind = ProjectFolderKind;
     this.key = key;
     this.created = created;
     this.updated = updated;
@@ -141,7 +138,7 @@ export class ProjectFolder extends ProjectParent {
     if (info) {
       this.info = new Thing(info);
     } else {
-      this.info = new Thing({ kind: ThingKind, name: DefaultFolderName });
+      this.info = Thing.fromName(DefaultFolderName);
     }
   }
 
@@ -150,7 +147,7 @@ export class ProjectFolder extends ProjectParent {
    */
   static isProjectFolder(input: unknown): boolean {
     const typed = input as IProjectFolder;
-    if (!input || typed.kind !== Kind) {
+    if (!input || typed.kind !== ProjectFolderKind) {
       return false;
     }
     return true;
@@ -158,7 +155,7 @@ export class ProjectFolder extends ProjectParent {
 
   toJSON(): IProjectFolder {
     const result: IProjectFolder = {
-      kind: Kind,
+      kind: ProjectFolderKind,
       info: this.info.toJSON(),
       key: this.key,
       created: this.created,
@@ -179,13 +176,13 @@ export class ProjectFolder extends ProjectParent {
   static fromName(project: HttpProject, name = DefaultFolderName): ProjectFolder {
     const now = Date.now();
     const key = v4();
-    const info = new Thing({ kind: ThingKind, name });
+    const info = Thing.fromName(name);
     const definition = new ProjectFolder(project, {
       key,
       created: now,
       updated: now,
       items: [],
-      kind: Kind,
+      kind: ProjectFolderKind,
       info: info.toJSON(),
     });
     return definition;
@@ -295,7 +292,7 @@ export class ProjectFolder extends ProjectParent {
    */
   listFolderItems(): ProjectItem[] {
     const { items = [] } = this;
-    return items.filter(i => i.kind === Kind);
+    return items.filter(i => i.kind === ProjectFolderKind);
   }
 
   /**
@@ -471,7 +468,7 @@ export class ProjectFolder extends ProjectParent {
    * @param withRequests Whether to clone requests with the folder.
    */
   protected cloneSubFolders(folder: ProjectFolder, project: HttpProject, withRequests = true): void {
-    const folders = this.items.filter(i => i.kind === Kind);
+    const folders = this.items.filter(i => i.kind === ProjectFolderKind);
     folders.forEach(f => {
       const definition = project.findFolder(f.key, { keyOnly: true });
       if (!definition) {

package/src/models/ProjectItem.ts

@@ -1,7 +1,8 @@
-import { Kind as ProjectFolderKind, ProjectFolder } from './ProjectFolder.js';
+import type { ProjectFolder } from './ProjectFolder.js';
 import { Kind as ProjectRequestKind, ProjectRequest } from './ProjectRequest.js';
 import { Kind as EnvironmentKind, Environment } from './Environment.js';
 import { HttpProject } from './HttpProject.js';
+import { ProjectFolderKind } from './kinds.js';
 
 type Kind = typeof ProjectFolderKind | typeof ProjectRequestKind | typeof EnvironmentKind;
 

package/src/models/ProjectParent.ts

@@ -1,7 +1,7 @@
 import { HttpProject } from "./HttpProject.js";
 import { ProjectFolder } from "./ProjectFolder.js";
 import { ProjectItem } from "./ProjectItem.js";
-import { Thing, Kind as ThingKind } from "./Thing.js";
+import { Thing } from "./Thing.js";
 import { ProjectDefinitionProperty } from "./ProjectDefinitionProperty.js";
 
 /**
@@ -22,7 +22,7 @@ export abstract class ProjectParent implements ProjectDefinitionProperty {
   /**
    * The basic information about the project / folder.
    */
-  info: Thing = new Thing({ kind: ThingKind, name: '' });
+  info: Thing = Thing.fromName('');
 
   abstract attachedCallback(): void;
 

package/src/models/ProjectRequest.ts

@@ -1,4 +1,3 @@
-import { Kind as ThingKind } from './Thing.js';
 import { ProjectDefinitionProperty, IProjectDefinitionProperty } from './ProjectDefinitionProperty.js';
 import { ProjectFolder } from './ProjectFolder.js';
 import { IHttpRequest, Kind as HttpRequestKind } from './HttpRequest.js';
@@ -10,6 +9,7 @@ import { Property } from './Property.js';
 import { Server } from './Server.js';
 import { UriTemplate } from '../lib/parsers/UriTemplate.js';
 import { RequestAuthorization } from './RequestAuthorization.js';
+import { Thing } from './Thing.js';
 
 export const Kind = 'Core#ProjectRequest';
 
@@ -118,10 +118,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
         method: 'GET',
         url,
       },
-      info: {
-        kind: ThingKind,
-        name: url,
-      },
+      info: Thing.fromName(url).toJSON(),
     });
     return request;
   }
@@ -148,10 +145,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
         method: 'GET',
         url: '',
       },
-      info: {
-        kind: ThingKind,
-        name,
-      },
+      info: Thing.fromName(name).toJSON(),
     });
     return request;
   }
@@ -180,10 +174,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
         headers: info.headers,
         payload: info.payload,
       },
-      info: {
-        kind: ThingKind,
-        name: info.url,
-      },
+      info: Thing.fromName(info.url).toJSON(),
     });
     return request;
   }
@@ -218,10 +209,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
           method: 'GET',
           url: '',
         },
-        info: {
-          kind: ThingKind,
-          name: '',
-        },
+        info: Thing.fromName('').toJSON(),
       };
     }
     this.new(init);

package/src/models/Request.ts

@@ -1,6 +1,6 @@
 import { Core as JsonCore } from '@api-client/json'
 import { IRequestConfig, RequestConfig } from './RequestConfig.js';
-import { Thing, IThing, Kind as ThingKind } from './Thing.js';
+import { Thing, IThing } from './Thing.js';
 import { HttpCertificate, Certificate } from './ClientCertificate.js';
 import { IRequestAuthorization, RequestAuthorization } from './RequestAuthorization.js';
 import { IRequestLog, RequestLog, Kind as LogKind } from './RequestLog.js';
@@ -139,10 +139,7 @@ export class Request {
         method: 'GET',
         url,
       },
-      info: {
-        kind: ThingKind,
-        name: url,
-      },
+      info: Thing.fromName(url).toJSON(),
     });
     return request;
   }
@@ -163,10 +160,7 @@ export class Request {
         method: 'GET',
         url: '',
       },
-      info: {
-        kind: ThingKind,
-        name,
-      },
+      info: Thing.fromName(name).toJSON(),
     });
     return request;
   }
@@ -189,10 +183,7 @@ export class Request {
         headers: info.headers,
         payload: info.payload,
       },
-      info: {
-        kind: ThingKind,
-        name: info.url,
-      },
+      info: Thing.fromName(info.url).toJSON(),
     });
     return request;
   }
@@ -210,10 +201,7 @@ export class Request {
         url: normalized.url || '',
         headers: normalized.headers,
       },
-      info: {
-        kind: ThingKind,
-        name: normalized.name || 'Unnamed request',
-      },
+      info: Thing.fromName(normalized.name || 'Unnamed request').toJSON(),
     };
     init.created = normalized.created;
     init.updated = normalized.updated;
@@ -341,10 +329,7 @@ export class Request {
           method: 'GET',
           url: '',
         },
-        info: {
-          kind: ThingKind,
-          name: '',
-        },
+        info: Thing.fromName('').toJSON(),
       };
     }
     this.new(init);
@@ -358,9 +343,6 @@ export class Request {
       this.expects = new HttpRequest();
     }
     if (info) {
-      if (!info.kind) {
-        info.kind = ThingKind;
-      }
       this.info = new Thing(info);
     } else {
       this.info = Thing.fromName('')

package/src/models/Response.ts

@@ -1,12 +1,11 @@
-import { IHttpResponse, HttpResponse, Kind } from './HttpResponse.js';
+import { IHttpResponse, HttpResponse } from './HttpResponse.js';
 import { IRequestTime, RequestTime } from './RequestTime.js';
 import { IResponseAuthorization, ResponseAuthorization } from './ResponseAuthorization.js';
 import { IErrorResponse } from './ErrorResponse.js';
 import { Response as LegacyResponse } from './legacy/request/ArcResponse.js';
 import { PayloadSerializer } from '../lib/transformers/PayloadSerializer.js';
 import { Normalizer } from './legacy/Normalizer.js';
-
-export { Kind };
+import { HttpResponseKind } from './kinds.js';
 
 /**
  * An HTTP response object.
@@ -44,7 +43,7 @@ export class Response extends HttpResponse {
 
   static override fromValues(status: number, statusText?: string, headers?: string): Response {
     return new Response({
-      kind: Kind,
+      kind: HttpResponseKind,
       status,
       statusText,
       headers,
@@ -54,7 +53,7 @@ export class Response extends HttpResponse {
 
   static override async fromLegacy(input: LegacyResponse): Promise<Response> {
     const init: IResponse = {
-      kind: Kind,
+      kind: HttpResponseKind,
       status: input.status || 0,
       loadingTime: input.loadingTime || 0,
     };
@@ -98,7 +97,7 @@ export class Response extends HttpResponse {
       init = input;
     } else {
       init = {
-        kind: Kind,
+        kind: HttpResponseKind,
         status: 0,
         loadingTime: 0,
       };

package/src/models/ResponseRedirect.ts

@@ -1,6 +1,7 @@
-import { IHttpResponse, HttpResponse, Kind as ResponseKind } from './HttpResponse.js';
+import { IHttpResponse, HttpResponse } from './HttpResponse.js';
 import { IRequestTime, RequestTime } from './RequestTime.js';
 import { ResponseRedirect as LegacyRedirect } from './legacy/request/ArcResponse.js';
+import { ResponseKind } from './kinds.js';
 
 export const Kind = 'Core#HttpResponseRedirect';
 

package/src/models/Thing.ts

@@ -1,4 +1,4 @@
-export const Kind = 'Core#Thing';
+import { ThingKind } from "./kinds.js";
 
 /**
  * An interface describing a base metadata of a thing.
@@ -7,7 +7,7 @@ export declare interface IThing {
   /**
    * The data kind. The application ignores the input with an unknown `kind`, unless it can be determined from the context.
    */
-  kind?: typeof Kind;
+  kind?: typeof ThingKind;
   /**
    * The name of the thing.
    */
@@ -28,7 +28,7 @@ export declare interface IThing {
 }
 
 export class Thing {
-  kind = Kind;
+  kind = ThingKind;
   /**
    * The name of the thing.
    */
@@ -63,7 +63,7 @@ export class Thing {
   static fromName(name: string): Thing {
     const thing = new Thing({
       name,
-      kind: Kind,
+      kind: ThingKind,
     });
     return thing;
   }
@@ -79,7 +79,7 @@ export class Thing {
       init = input;
     } else {
       init = {
-        kind: Kind,
+        kind: ThingKind,
       };
     }
     this.new(init);
@@ -95,7 +95,7 @@ export class Thing {
       throw new Error(`Not a thing.`);
     }
     const { description, name, version, displayName } = init;
-    this.kind = Kind;
+    this.kind = ThingKind;
     this.name = name;
     this.displayName = displayName;
     this.description = description;
@@ -107,7 +107,7 @@ export class Thing {
    */
   static isThing(input: unknown): boolean {
     const typed = input as IThing;
-    if (input && typed.kind === Kind) {
+    if (input && typed.kind === ThingKind) {
       return true;
     }
     return false;
@@ -115,7 +115,7 @@ export class Thing {
 
   toJSON(): IThing {
     const result: IThing = {
-      kind: Kind,
+      kind: ThingKind,
     };
     if (typeof this.name === 'string') {
       result.name = this.name;

package/src/models/data/DataNamespace.ts

@@ -4,10 +4,10 @@ import { IDataAssociation, DataAssociation, AssociationTarget } from "./DataAsso
 import { IDataEntity, DataEntity } from "./DataEntity.js";
 import { IDataModel, DataModel, Kind as DataModelKind } from "./DataModel.js";
 import { IDataProperty, DataProperty } from "./DataProperty.js";
+import { DataNamespaceKind } from "../kinds.js";
 import v4 from '../../lib/uuid.js';
 
-export const Kind = 'Core#DataNamespace';
-type ItemKind = typeof Kind | typeof DataModelKind;
+type ItemKind = typeof DataNamespaceKind | typeof DataModelKind;
 
 interface IDataDefinitions {
   models?: IDataModel[];
@@ -32,7 +32,7 @@ interface DataDefinitions {
 }
 
 interface IDataNamespaceParent {
-  kind: typeof Kind;
+  kind: typeof DataNamespaceKind;
   /**
    * The key of the namespace.
    */
@@ -73,7 +73,7 @@ export interface IDataItem {
 }
 
 class DataNamespaceParent {
-  kind = Kind;
+  kind = DataNamespaceKind;
 
   key = '';
 
@@ -130,7 +130,7 @@ class DataNamespaceParent {
     const root = this.getRoot();
     const { namespaces } = root.definitions;
     items.forEach(i => {
-      if (i.kind !== Kind) {
+      if (i.kind !== DataNamespaceKind) {
         return;
       }
       const def = namespaces.find(j => j.key === i.key);
@@ -203,7 +203,7 @@ export class DataItem implements IDataItem {
 
   static isDataItem(input: unknown): boolean {
     const typed = input as IDataItem;
-    if (!input || ![DataModelKind, Kind].includes(typed.kind)) {
+    if (!input || ![DataModelKind, DataNamespaceKind].includes(typed.kind)) {
       return false;
     }
     return true;
@@ -211,7 +211,7 @@ export class DataItem implements IDataItem {
 
   static dataNamespace(root: DataNamespace, key: string): DataItem {
     const item = new DataItem(root, {
-      kind: Kind,
+      kind: DataNamespaceKind,
       key,
     });
     return item;
@@ -319,11 +319,11 @@ export class DataNamespace extends DataNamespaceParent {
     } else if (typeof input === 'object') {
       init = input;
       if (!init.kind) {
-        init.kind = Kind;
+        init.kind = DataNamespaceKind;
       }
     } else {
       init = {
-        kind: Kind,
+        kind: DataNamespaceKind,
         key: v4(),
         definitions: {},
         items: [],
@@ -386,7 +386,7 @@ export class DataNamespace extends DataNamespaceParent {
   toJSON(): IDataNamespace {
     const result: IDataNamespace = {
       key: this.key,
-      kind: Kind,
+      kind: DataNamespaceKind,
       info: this.info.toJSON(),
       items: this.items.map(i => i.toJSON()),
       definitions: {},

package/src/models/kinds.ts

@@ -0,0 +1,8 @@
+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 FolderKind = 'Core#Folder';
+export const ProjectKind = 'Core#Project';
+export const ThingKind = 'Core#Thing';

package/src/models/store/File.ts

@@ -5,6 +5,7 @@ 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
 // import { Kind as FolderKind } from '../Folder.js';
 
@@ -397,15 +398,13 @@ export class StoredFile {
       canUntrash: isOwner,
       canReadMedia: false,
     };
-    // Do not use the `FolderKind` reference here as it's circular and creates
-    // an error.
-    if (file.kind === 'Core#Folder' && isWriter) {
+    if (file.kind === FolderKind && isWriter) {
       result.canAddChildren = true;
     }
-    if (file.kind === 'Core#Folder') {
+    if (file.kind === FolderKind) {
       result.canListChildren = isReader;
     }
-    if (file.kind !== 'Core#Folder') {
+    if (file.kind !== FolderKind) {
       result.canReadMedia = isReader;
     }
     return result;

package/src/models/transformers/PostmanBackupTransformer.ts

@@ -1,11 +1,11 @@
 /* eslint-disable no-unused-vars */
 import { PostmanTransformer, dataValue, paramValue } from './PostmanTransformer.js';
-import { HttpProject, IHttpProject, Kind as ProjectKind } from '../HttpProject.js';
+import { HttpProject, IHttpProject, Kind as HttpProjectKind } from '../HttpProject.js';
 import { ProjectFolder } from '../ProjectFolder.js';
 import { ProjectRequest } from '../ProjectRequest.js';
 import { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js';
 import { Environment } from '../Environment.js';
-import { Kind as ThingKind } from '../Thing.js';
+import { Thing } from '../Thing.js';
 
 interface PostmanBackupV1 {
   version: number;
@@ -144,12 +144,9 @@ export class PostmanBackupTransformer extends PostmanTransformer {
   createProject(collection: PostmanCollection): HttpProject {
     const { description, id, name } = collection;
     const init: IHttpProject = {
-      kind: ProjectKind,
+      kind: HttpProjectKind,
       definitions: {},
-      info: {
-        kind: ThingKind,
-        name,
-      },
+      info: Thing.fromName(name).toJSON(),
       items: [],
       key: id,
     };

package/src/models/transformers/PostmanDataTransformer.ts

@@ -3,7 +3,7 @@ import { PostmanBackupTransformer } from './PostmanBackupTransformer.js';
 import { PostmanV2Transformer } from './PostmanV2Transformer.js';
 import { PostmanV21Transformer } from './PostmanV21Transformer.js';
 import { PostmanTransformer } from './PostmanTransformer.js';
-import { HttpProject } from '../HttpProject.js';
+import type { HttpProject } from '../HttpProject.js';
 
 /**
  * Transforms Postman collections (v2 and v2.1) and Postman's data export