@api-client/core 0.8.22 → 0.9.0

package/src/events/transport/TransportEvents.ts

@@ -7,7 +7,6 @@ import { TransportEventTypes } from "./TransportEventTypes.js";
 import { IProjectExecutionLog } from "../../runtime/reporters/Reporter.js";
 import { IRequestProxyInit } from "../../proxy/RequestProxy.js";
 import { IHttpProjectProxyInit, IHttpProjectStoreProxyInit } from "../../proxy/HttpProjectProxy.js";
-import { IAppProjectProxyInit } from "../../proxy/AppProjectProxy.js";
 import { IProxyResult } from "../../proxy/Proxy.js";
 
 export interface IHttpRequestDetail {
@@ -45,18 +44,6 @@ export const TransportEvent = Object.freeze({
       target.dispatchEvent(e);
       return e.detail.result;
     },
-
-    /**
-     * For both the project or a folder (since it's all single configuration.)
-     * 
-     * @param target The events target
-     * @param init The project execution configuration
-     */
-    appProject: async (init: IAppProjectProxyInit, target: EventTarget = window): Promise<IProxyResult<IProjectExecutionLog> | undefined> => {
-      const e = new ContextEvent<IAppProjectProxyInit, IProxyResult<IProjectExecutionLog>>(TransportEventTypes.Core.appProject, init);
-      target.dispatchEvent(e);
-      return e.detail.result;
-    },
   }),
   /** 
    * Transport via the native platform's bindings.

package/src/mocking/ProjectMock.ts

@@ -6,13 +6,11 @@ import { History } from './lib/History.js';
 import { Url } from './lib/Url.js';
 import { Certificates } from './lib/Certificates.js';
 import { HostRules } from './lib/HostRules.js';
-import { App } from './lib/App.js';
 
 export { IRequestLogInit } from './lib/Request.js';
 export { IResponseInit } from './lib/Response.js';
 export { IUserInit } from './lib/User.js';
 export { IHttpHistoryInit, IHttpHistoryListInit } from './lib/History.js';
-export { IAppRequestInit } from './lib/App.js';
 
 export class ProjectMock extends DataMock {
   projectRequest: Request;
@@ -22,7 +20,6 @@ export class ProjectMock extends DataMock {
   url: Url;
   certificates: Certificates;
   hostRules: HostRules;
-  app: App;
   
   /**
    * @param init The library init options.
@@ -36,6 +33,5 @@ export class ProjectMock extends DataMock {
     this.url = new Url(init);
     this.certificates = new Certificates(init);
     this.hostRules = new HostRules(init);
-    this.app = new App(init);
   }
 }

package/src/mocking/lib/History.ts

@@ -85,6 +85,11 @@ export class History {
       created: date.getTime(),
       log: await this.request.log(init.log),
       user: '',
+      app: '',
+      key: '',
+      project: '',
+      request: '',
+      space: '',
     }
     date.setHours(0, 0, 0, 0);
     result.midnight = date.getTime();

package/src/models/{Workspace.ts → Folder.ts}

@@ -2,14 +2,14 @@ import { IFile, File, DefaultOwner } from "./store/File.js";
 import { Thing, Kind as ThingKind } from './Thing.js';
 import v4 from '../lib/uuid.js';
 
-export const Kind = 'Core#Space';
+export const Kind = 'Core#Folder';
 /**
  * A definition of the working space for users.
  * 
  * A working space is a logical container in the data store
  * created by the system users, where they can store their projects and other data.
  */
-export interface IWorkspace extends IFile {
+export interface IFolder extends IFile {
   kind: typeof Kind;
 }
 
@@ -19,7 +19,7 @@ export interface IWorkspace extends IFile {
  * A working space is a logical container in the data store
  * created by the system users, where they can store their projects and other data.
  */
-export class Workspace extends File {
+export class Folder extends File {
   override kind = Kind;
   
   /**
@@ -28,10 +28,10 @@ export class Workspace extends File {
    * @param name The name to set.
    * @param owner The user id that is the owner of the space.
    */
-  static fromName(name: string, owner = DefaultOwner): Workspace {
+  static fromName(name: string, owner = DefaultOwner): Folder {
     const key = v4();
     const info = new Thing({ kind: ThingKind, name });
-    const definition = new Workspace({
+    const definition = new Folder({
       key,
       kind: Kind,
       info: info.toJSON(),
@@ -47,9 +47,9 @@ export class Workspace extends File {
   /**
    * @param input The environment definition used to restore the state.
    */
-  constructor(input?: string | IWorkspace) {
+  constructor(input?: string | IFolder) {
     super();
-    let init: IWorkspace;
+    let init: IFolder;
     if (typeof input === 'string') {
       init = JSON.parse(input);
     } else if (typeof input === 'object') {
@@ -77,8 +77,8 @@ export class Workspace extends File {
    * 
    * Note, this throws an error when the environment is not a space. 
    */
-  override new(init: IWorkspace): void {
-    if (!Workspace.isWorkspace(init)) {
+  override new(init: IFolder): void {
+    if (!Folder.isWorkspace(init)) {
       throw new Error(`Not a space.`);
     }
     super.new(init);
@@ -89,15 +89,15 @@ export class Workspace extends File {
    * Checks whether the input is a definition of an user space.
    */
   static isWorkspace(input: unknown): boolean {
-    const typed = input as IWorkspace;
+    const typed = input as IFolder;
     if (!input || typed.kind !== Kind) {
       return false;
     }
     return true;
   }
 
-  override toJSON(): IWorkspace {
-    const result: IWorkspace = {
+  override toJSON(): IFolder {
+    const result: IFolder = {
       ...super.toJSON(),
       kind: Kind,
     };

package/src/models/HttpHistory.ts

@@ -4,41 +4,38 @@ export const Kind = 'Core#HttpHistory';
 export const createdSymbol = Symbol('created');
 export const midnightSymbol = Symbol('midnight');
 
+/**
+ * An HTTP history log.
+ * It's a definition of a HTTP requests history made in an app.
+ */
 export interface IHttpHistory {
   kind: typeof Kind;
   /**
-   * The data store key. Only present when the object was already inserted into the data store.
-   * In majority of cases this value is set. It is not set when generating the history object before sending it to the store.
-   * 
-   * Note for data store implementations. This must be a URL-safe value so the id should be encoded if needed.
-   * 
-   * @readonly
+   * The key of the history entry. The application must 
+   * revalidate the local copy of the record as the store may change the key.
    */
-  key?: string;
+  key: string;
   /**
-   * Optional user space id. When set the history will become available to all space users.
+   * The key of the parent workspace.
    */
-  space?: string;
+  space: string;
   /**
-   * Optional project id. When set the history will become available to all project users.
+   * The key of the project the request belongs to.
    */
-  project?: string;
+  project: string;
   /**
-   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   * The application id that generated the history entry.
    */
-  app?: string;
+  app: string;
   /**
-   * The user id that made that request.
-   * Note, the default API Client's store automatically adds the user information to the record overriding any pre-set user id, making it a read-only
-   * value.
-   * 
-   * @readonly
+   * The key of the request that generated the history entry.
    */
-  user?: string;
+  request: string;
   /**
-   * The optional request id in the project that generated this log.
+   * The user id that made that request.
+   * This is only available when the store support multi-user environment.
    */
-  request?: string;
+  user?: string;
   /**
    * The request log.
    */
@@ -62,21 +59,21 @@ export interface IHttpHistory {
  */
 export interface IHttpHistoryBulkAdd {
   /**
-   * Optional user space id. Must be set when the originating request belongs to a user space.
+   * The key of the parent workspace.
    */
-  space?: string;
+  space: string;
   /**
-   * Optional project id. Must be set when the originating request belongs to a user space.
+   * The key of the project the request belongs to.
    */
-  project?: string;
+  project: string;
   /**
-   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   * The application id that generated the history entry.
    */
-  app?: string;
+  app: string;
   /**
-   * The optional request id in the project that generated this log.
+   * The key of the request that generated the history entry.
    */
-  request?: string;
+  request: string;
   /**
    * The list of request logs.
    */
@@ -96,33 +93,31 @@ export class HttpHistory {
   
   kind = Kind;
   /**
-   * The data store key. Only present when the object was already inserted into the data store.
-   * In majority of cases this value is set. It is not set when generating the history object before sending it to the store.
-   * 
-   * Note for data store implementations. This must be a URL-safe value so the id should be encoded if needed.
+   * The key of the history entry. The application must 
+   * revalidate the local copy of the record as the store may change the key.
    */
-  key?: string;
+  key = '';
   /**
-   * Optional user space id. Must be set when the originating request belongs to a user space.
+   * The key of the parent workspace.
    */
-  space?: string;
+  space = '';
   /**
-   * Optional project id. Must be set when the originating request belongs to a user space.
+   * The key of the project the request belongs to.
    */
-  project?: string;
+  project = '';
   /**
-   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   * The application id that generated the history entry.
    */
-  app?: string;
+  app = '';
   /**
    * The user id that made that request.
-   * Note, the default API Client's store automatically adds the user information to the record overriding any pre-set user id.
+   * This is only available when the store support multi-user environment.
    */
   user = '';
   /**
-   * The optional request id in the project that generated this log.
+   * The key of the request that generated the history entry.
    */
-  request?: string;
+  request = '';
   /**
    * The execution log of the HTTP request with a response.
    */
@@ -182,6 +177,11 @@ export class HttpHistory {
         kind: Kind,
         created: now,
         user: '',
+        app: '',
+        key: '',
+        project: '',
+        request: '',
+        space: '',
         log: {
           kind: RequestLogKind,
         },
@@ -197,12 +197,12 @@ export class HttpHistory {
     if (key) {
       this.key = key;
     } else {
-      this.key = undefined;
+      this.key = '';
     }
     if (app) {
       this.app = app;
     } else {
-      this.app = undefined;
+      this.app = '';
     }
     if (midnight) {
       this.midnight = midnight;
@@ -210,17 +210,17 @@ export class HttpHistory {
     if (space) {
       this.space = space;
     } else {
-      this.space = undefined;
+      this.space = '';
     }
     if (project) {
       this.project = project;
     } else {
-      this.project = undefined;
+      this.project = '';
     }
     if (request) {
       this.request = request;
     } else {
-      this.request = undefined;
+      this.request = '';
     }
     if (user) {
       this.user = user;
@@ -236,22 +236,12 @@ export class HttpHistory {
       midnight: this.midnight,
       log: this.log.toJSON(),
       user: this.user,
+      key: this.key,
+      space: this.space,
+      project: this.project,
+      request: this.request,
+      app: this.app,
     };
-    if (this.key) {
-      result.key = this.key;
-    }
-    if (this.space) {
-      result.space = this.space;
-    }
-    if (this.project) {
-      result.project = this.project;
-    }
-    if (this.request) {
-      result.request = this.request;
-    }
-    if (this.app) {
-      result.app = this.app;
-    }
     return result;
   }
 

package/src/models/HttpProject.ts

@@ -16,7 +16,6 @@ import v4 from '../lib/uuid.js';
 import { ARCSavedRequest, ARCHistoryRequest } from './legacy/request/ArcRequest.js';
 import { ArcLegacyProject, ARCProject } from './legacy/models/ArcLegacyProject.js';
 import { PostmanDataTransformer } from './transformers/PostmanDataTransformer.js';
-import { IAppProject } from './AppProject.js';
 import { Certificate, HttpCertificate } from './ClientCertificate.js';
 import { ICCAuthorization } from './Authorization.js';
 
@@ -352,34 +351,6 @@ export class HttpProject extends ProjectParent {
     return HttpProject.fromName(name);
   }
 
-  static fromAppProject(init: IAppProject): HttpProject {
-    const result = new HttpProject();
-    const { definitions = {}, items, info, key = v4() } = init;
-    result.key = key;
-    result.info = new Thing(info);
-    if (Array.isArray(items)) {
-      result.items = items.map(i => ProjectItem.fromAppProject(result, i));
-    }
-    if (Array.isArray(definitions.environments)) {
-      result.definitions.environments = definitions.environments.map(i => new Environment(i));
-    }
-    if (Array.isArray(definitions.requests)) {
-      result.definitions.requests = definitions.requests.map(i => {
-        const instance = new ProjectRequest(result, i);
-        instance.attachedCallback();
-        return instance;
-      });
-    }
-    if (Array.isArray(definitions.folders)) {
-      result.definitions.folders = definitions.folders.map(i => {
-        const instance = ProjectFolder.fromAppProject(result, i);
-        instance.attachedCallback();
-        return instance;
-      });
-    }
-    return result;
-  }
-
   /**
    * @param input The project definition used to restore the state.
    * @param environments Optional list of environments to use with this project. It overrides environments stored in the project definition.

package/src/models/Project.ts

@@ -8,10 +8,6 @@ export const Kind = 'Core#Project';
 /**
  * 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.
- * 
- * A concept of a project is similar to a Workspace. It is an object that is rendered in the UIs
- * like a workspace but has a different meaning. On the store side, when listing workspace items,
- * both spaces and projects are returned in a single query.
  */
 export interface IProject extends IFile {
   kind: typeof Kind;
@@ -20,10 +16,6 @@ export interface IProject extends IFile {
 /**
  * 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.
- * 
- * A concept of a project is similar to a Workspace. It is an object that is rendered in the UIs
- * like a workspace but has a different meaning. On the store side, when listing workspace items,
- * both spaces and projects are returned in a single query.
  */
 export class Project extends File {
   override kind = Kind;

package/src/models/ProjectFolder.ts

@@ -6,7 +6,6 @@ import { HttpProject, IEnvironmentCreateOptions } from './HttpProject.js';
 import { IThing, Thing, Kind as ThingKind } from './Thing.js';
 import { Environment, IEnvironment } from './Environment.js';
 import v4 from '../lib/uuid.js';
-import { IAppProjectParent } from './AppProject.js';
 
 export const Kind = 'Core#ProjectFolder';
 export const DefaultFolderName = 'New folder';
@@ -95,21 +94,6 @@ export class ProjectFolder extends ProjectParent {
    */
   created = 0;
 
-  static fromAppProject(project: HttpProject, init: IAppProjectParent): ProjectFolder {
-    const result = new ProjectFolder(project);
-    const { key = v4(), created = Date.now(), updated = Date.now(), items, info } = init;
-    result.key = key;
-    result.created = created;
-    result.updated = updated;
-    if (info) {
-      result.info = new Thing(info);
-    }
-    if (Array.isArray(items)) {
-      result.items = items.map(i => ProjectItem.fromAppProject(project, i));
-    }
-    return result;
-  }
-
   constructor(project: HttpProject, input?: string | IProjectFolder) {
     super();
     this.project = project;

package/src/models/ProjectItem.ts

@@ -2,7 +2,6 @@ import { Kind as ProjectFolderKind, 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 { AppProjectFolderKind, AppProjectRequestKind, IAppProjectItem } from './AppProject.js';
 
 type Kind = typeof ProjectFolderKind | typeof ProjectRequestKind | typeof EnvironmentKind;
 
@@ -75,23 +74,6 @@ export class ProjectItem {
     return item;
   }
 
-  static fromAppProject(project: HttpProject, item: IAppProjectItem): ProjectItem {
-    let kind: Kind;
-    if (item.kind === AppProjectFolderKind) {
-      kind = ProjectFolderKind
-    } else if (item.kind === AppProjectRequestKind) {
-      kind = ProjectRequestKind
-    } else if (item.kind === EnvironmentKind) {
-      kind = EnvironmentKind
-    } else {
-      throw new Error(`Invalid item kind: ${item.kind}`);
-    }
-    return new ProjectItem(project, {
-      kind,
-      key: item.key,
-    });
-  }
-
   /**
    * @param project The top-most project.
    * @param input The project item definition used to restore the state.

package/src/models/ProjectRequest.ts

@@ -5,7 +5,6 @@ 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 { IAppProjectRequest } from './AppProject.js';
 import { Environment } from './Environment.js';
 import { Property } from './Property.js';
 import { Server } from './Server.js';
@@ -198,10 +197,10 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     return result;
   }
 
-  constructor(project: HttpProject, input?: string | IProjectRequest | IAppProjectRequest) {
+  constructor(project: HttpProject, input?: string | IProjectRequest) {
     super(input);
     this.project = project;
-    let init: IProjectRequest | IAppProjectRequest;
+    let init: IProjectRequest;
     if (typeof input === 'string') {
       init = JSON.parse(input);
     } else if (typeof input === 'object') {
@@ -227,7 +226,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     this.new(init);
   }
 
-  override new(init: IProjectRequest | IAppProjectRequest): void {
+  override new(init: IProjectRequest): void {
     super.new(init);
 
     const { key, environment } = init as IProjectRequest;

package/src/models/RequestConfig.ts

@@ -82,7 +82,7 @@ export interface IRequestConfig extends IRequestBaseConfig {
   ignoreSessionCookies?: boolean;
   /**
    * A list of variables to use with the request.
-   * Note, request variables override application and workspace variables.
+   * Note, request variables override application and Folder variables.
    */
   variables?: IProperty[];
 }

package/src/models/Space.ts

@@ -0,0 +1,105 @@
+import { IThing, Thing, Kind as ThingKind } from "./Thing.js";
+import v4 from '../lib/uuid.js';
+
+export const Kind = 'Core#Space';
+
+/**
+ * The definition of a space (or workspace).
+ * A space is the parent container keeping all the data the user sees in the application.
+ * By changing space the user has completely different set of data.
+ */
+export interface ISpace {
+  /**
+   * The key of the space.
+   */
+  key: string;
+
+  kind: typeof Kind;
+
+  /**
+   * The basic information about the space.
+   */
+  info: IThing;
+}
+
+/**
+ * The definition of a space (or workspace).
+ * A space is the parent container keeping all the data the user sees in the application.
+ * By changing space the user has completely different set of data.
+ */
+export class Space {
+  /**
+   * The key of the rule.
+   */
+  key = '';
+
+  kind = Kind;
+
+  /**
+   * The basic information about the project / folder.
+   */
+  info: Thing = new Thing({ kind: ThingKind, name: '' });
+
+  static fromName(name: string): Space {
+    const key = v4();
+    const result = new Space({
+      key,
+      kind: Kind,
+      info: Thing.fromName(name).toJSON()
+    });
+    return result;
+  }
+
+  constructor(input?: string | ISpace) {
+    let init: ISpace;
+    if (typeof input === 'string') {
+      init = JSON.parse(input);
+    } else if (typeof input === 'object') {
+      init = input;
+    } else {
+      init = {
+        key: v4(),
+        kind: Kind,
+        info: Thing.fromName('').toJSON(),
+      };
+    }
+    this.new(init);
+  }
+
+  new(init: ISpace): void {
+    if (!Space.isSpace(init)) {
+      throw new Error(`Not a Space.`);
+    }
+    const { info, key = v4() } = init;
+    this.kind = Kind;
+    this.key = key;
+    if (info) {
+      if (!info.kind) {
+        info.kind = ThingKind;
+      }
+      this.info = new Thing(info);
+    } else {
+      this.info = Thing.fromName('')
+    }
+  }
+
+  /**
+   * Checks whether the input is a definition of a host rule.
+   */
+  static isSpace(input: unknown): boolean {
+    const typed = input as ISpace;
+    if (input && typed.kind && typed.kind === Kind) {
+      return true;
+    }
+    return false;
+  }
+
+  toJSON(): ISpace {
+    const result: ISpace = {
+      kind: Kind,
+      key: this.key,
+      info: this.info.toJSON(),
+    };
+    return result;
+  }
+}

package/src/models/TrashEntry.ts

@@ -0,0 +1,29 @@
+import { IDeletion } from "./store/Deletion.js";
+
+export interface TrashEntryCreate {
+  /**
+   * The store key of the object that has been deleted.
+   */
+  file: string;
+  /**
+   * The kind of the delete object.
+   */
+  kind: string;
+  /**
+   * The name of the deleted object.
+   * 
+   * If the object does not have a name then it shouldn't be here.
+   */
+  name: string;
+}
+
+export interface TrashEntry extends TrashEntryCreate {
+  /**
+   * The key of the trash entry.
+   */
+  key: string;
+  /**
+   * The delete info.
+   */
+  info: IDeletion;
+}