@api-client/core 0.8.22 → 0.9.1

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,91 @@
+import { Kind as ThingKind } from "./Thing.js";
+import v4 from '../lib/uuid.js';
+import { DefaultOwner, File, IFile } from "./store/File.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.
+ * 
+ * This has the same properties as a file stored in a filesystem and as such is represented.
+ */
+export interface ISpace extends IFile {
+  kind: typeof Kind;
+}
+
+/**
+ * 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 extends File {
+  override kind = Kind;
+
+  static fromName(name: string): Space {
+    const init: ISpace = {
+      kind: Kind,
+      key: v4(),
+      info: {
+        kind: ThingKind,
+        name,
+      },
+      lastModified: { user: '', time: 0, byMe: false },
+      owner: DefaultOwner,
+      parents: [],
+      permissionIds: [],
+      permissions: [],
+    };
+    return new Space(init);
+  }
+
+  constructor(input?: string | ISpace) {
+    super();
+    let init: ISpace;
+    if (typeof input === 'string') {
+      init = JSON.parse(input);
+    } else if (typeof input === 'object') {
+      init = input;
+    } else {
+      init = {
+        kind: Kind,
+        key: v4(),
+        info: {
+          kind: ThingKind,
+          name: '',
+        },
+        owner: DefaultOwner,
+        parents: [],
+        permissionIds: [],
+        permissions: [],
+        lastModified: { user: '', time: 0, byMe: false },
+      };
+    }
+    this.new(init);
+  }
+
+  override new(init: ISpace): void {
+    if (!Space.isProject(init)) {
+      throw new Error(`Not a project file.`);
+    }
+    super.new(init);
+    this.kind = Kind;
+  }
+
+  static isProject(input: unknown): boolean {
+    const typed = input as ISpace;
+    if (!input || typed.kind !== Kind) {
+      return false;
+    }
+    return true;
+  }
+
+  override toJSON(): ISpace {
+    const result: ISpace = {
+      ...super.toJSON(),
+      kind: Kind,
+    };
+    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;
+}

package/src/models/store/Backend.ts

@@ -1,8 +1,4 @@
 /* eslint-disable import/export */
-
-import { JsonPatch } from '@api-client/json'
-import { AccessOperation } from './Permission.js';
-
 export type BackendMode = 'single-user' | 'multi-user';
 
 export interface IBackendInfo {
@@ -140,341 +136,3 @@ export interface IBackendEvent extends IBackendMessage {
    */
   parent?: string;
 }
-
-export interface IListResponse<T = unknown> {
-  /**
-   * The cursor to use with the next query.
-   * Not set when no more results.
-   */
-  cursor?: string;
-  /**
-   * The list of objects returned from the store.
-   */
-  items: T[];
-}
-
-export interface IQueryResponse<T = unknown> {
-  /**
-   * An ordered list of results.
-   */
-  items: IQueryResult<T>[];
-}
-
-export interface IQueryResult<T = unknown> {
-  /**
-   * The document.
-   */
-  doc: T;
-  /**
-   * The list of indexes where this document was found.
-   */
-  index: string[];
-}
-
-export interface IListOptions {
-  /**
-   * Page cursor to use with the query.
-   */
-  cursor?: string;
-  /**
-   * Number of items in the result.
-   * Ignored when `cursor` is set.
-   * 
-   * Note, when changing the number of items in the result
-   * you need to start listing over again.
-   */
-  limit?: number;
-  /**
-   * Supported by some endpoints. When set it performs a query on the data store.
-   */
-  query?: string;
-  /**
-   * Only with the `query` property. Tells the system in which fields to search for the query term.
-   */
-  queryField?: string[];
-  /**
-   * General purpose type property to filer the results.
-   * This is used, for example, by the history store to list history for a specific type of requests,
-   */
-  type?: string;
-  /**
-   * Whether the list should contain children of a parent.
-   * This is a key of the parent.
-   */
-  parent?: string;
-  /**
-   * Used when synchronizing data in the local store with the data stored in the net-store.
-   * The timestamp when the last synchronization was performed. The resulting array will contain only items that 
-   * have been updated since that date.
-   */
-  since?: number;
-}
-
-export interface ICursorOptions {
-  /**
-   * Page cursor to use with the query.
-   */
-  cursor?: string;
-}
-
-/**
- * Listing options for the HTTP history.
- */
-export type HistoryListOptions = IHistorySpaceListOptions | IHistoryProjectListOptions | IHistoryRequestListOptions | IHistoryUserListOptions | IHistoryAppListOptions;
-
-/**
- * Query options to list history for a user space.
- * The user has to have access to the user space to read / create / delete the history.
- */
-export interface IHistorySpaceListOptions extends IListOptions {
-  type: 'space';
-  /**
-   * The id of the space.
-   */
-  id: string;
-  /**
-   * Whether to limit the list of results to the history that belongs to the current user.
-   */
-  user?: boolean;
-}
-
-/**
- * Query options to list history for an HTTP project.
- * The user has to have access to the parent user space to read / create / delete the history.
- */
-export interface IHistoryProjectListOptions extends IListOptions {
-  type: 'project';
-  /**
-   * The id of the project.
-   */
-  id: string;
-  /**
-   * Whether to limit the list of results to the history that belongs to the current user.
-   */
-  user?: boolean;
-}
-
-/**
- * Query options to list history for a request in a project.
- * The user has to have access to the parent user space to read / create / delete the history.
- */
-export interface IHistoryRequestListOptions extends IListOptions {
-  type: 'request';
-  /**
-   * The id of the project that contains the request.
-   */
-  project: string;
-  /**
-   * The id of the request.
-   */
-  id: string;
-  /**
-   * Whether to limit the list of results to the history that belongs to the current user.
-   */
-  user?: boolean;
-}
-
-/**
- * Query options to list history for a user. This targets lists all user history. If you need to 
- * filter the user history use other interfaces with the `user` flag set.
- */
-export interface IHistoryUserListOptions extends IListOptions {
-  type: 'user';
-}
-
-/**
- * Query options to list history for a history object that was created by an application that has no concept
- * of user spaces. In this case the queries are always made against the current user.
- */
-export interface IHistoryAppListOptions extends IListOptions {
-  type: 'app';
-  /**
-   * The id of the application.
-   * These queries are always made for a user.
-   */
-  id: string;
-}
-
-export interface IPatchBase {
-  /**
-   * Auto generated by the client sending the PATCH.
-   */
-  id: string;
-  /**
-   * The application id that generated the patch.
-   * This is a string that is assigned to each application in the suite.
-   * External applications need to use a constant string for their apps.
-   */
-  app: string;
-  /**
-   * The version of the application that generated the patch.
-   * This can and will be used to handle potential differences between suite applications.
-   */
-  appVersion: string;
-  /**
-   * The patch generated by the client.
-   */
-  patch: unknown;
-}
-
-/**
- * An interface describing a schema to be sent to the server
- * when making a patch of a file.
- */
-export interface IPatchInfo extends IPatchBase {
-  /**
-   * The patch generated by the client.
-   */
-  patch: JsonPatch;
-}
-
-/**
- * An interface describing a schema to be sent to the server
- * when making a patch with user access to a file.
- */
-export interface IAccessPatchInfo extends IPatchBase {
-  /**
-   * The patch generated by the client.
-   */
-  patch: AccessOperation[];
-}
-
-/**
- * A schema sent by the store server in a response to the patch request.
- * It contains an information about the applied patch, the reverse operation associated with it,
- * application information, and the generated by the client patch id.
- */
-export interface IPatchRevision extends IPatchInfo {
-  /**
-   * The patch to apply to the object to revert the changes.
-   */
-  revert: JsonPatch;
-}
-
-/**
- * Describes a batch read operation body.
- */
-export interface IBatchRead {
-  /**
-   * The keys of the items to read. The response has the ordered list of results.
-   */
-  items: string[];
-}
-
-/**
- * Describes a result of the batch read operation body.
- */
-export interface IBatchReadResult<T = unknown> {
-  /**
-   * The ordered list of read entities.
-   * Each element can be null/undefined when the item cannot be read.
-   * 
-   * The batch operation does not return specific errors. Use the direct read operation
-   * for the detailed error.
-   */
-  items: (T | null | undefined)[];
-}
-
-/**
- * Describes a batch update/create operation body.
- */
-export interface IBatchUpdate<T = unknown> {
-  /**
-   * The items to add or update in a batch operation.
-   */
-  items: T[];
-  /**
-   * The optional key of the parent object of the created/updated items.
-   */
-  parent?: string;
-}
-
-/**
- * Describes a result of the batch update/create operation body.
- */
-export interface IBatchUpdateResult<T = unknown> {
-  /**
-   * The ordered list of create/update result for each item.
-   */
-  items: T[];
-  /**
-   * The optional key of the parent object of the created/updated items.
-   */
-  parent?: string;
-}
-
-/**
- * Describes a batch delete operation body.
- */
-export interface IBatchDelete {
-  /**
-   * The list of keys of items to delete.
-   */
-  items: string[];
-  /**
-   * The optional key of the parent object of the deleted items.
-   * Not used by the store but reported back through the events.
-   */
-  parent?: string;
-}
-
-/**
- * Describes a result of the batch delete operation.
- */
-export interface IBatchDeleteResult {
-  /**
-   * The ordered list of delete result for each item.
-   * 
-   * The batch operation does not return specific errors. Use the direct delete operation
-   * for the detailed error.
-   */
-  items: (IDeleteRecord | undefined | null)[];
-}
-
-export interface IDeleteRecord {
-  /**
-   * The key of the removed object.
-   */
-  key: string;
-  /**
-   * The key of the parent object, if applicable.
-   */
-  parent?: string;
-}
-
-/**
- * Describes a batch undelete operation body.
- */
-export interface IBatchUndelete {
-  /**
-   * The list of keys of the items to undelete.
-   */
-  items: string[];
-  /**
-   * The optional key of the parent object of the deleted items.
-   */
-  parent?: string;
-}
-
-export interface IRevertResult<T = unknown> {
-  /**
-   * The data kind of the changed item.
-   */
-  kind?: string;
-  /**
-   * The key of the changed object.
-   */
-  key: string;
-  /**
-   * The updated object.
-   */
-  item?: T;
-  /**
-   * Optionally, when relevant, the key of the parent of the changed object.
-   */
-  parent?: string;
-}
-
-export interface IRevertResponse<T = unknown> {
-  items: (IRevertResult<T> | undefined)[];
-}