@api-client/core 0.8.21 → 0.9.0

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)[];
-}

package/src/models/store/File.ts

@@ -6,10 +6,43 @@ import { IThing, Thing } from '../Thing.js';
 import v4 from '../../lib/uuid.js';
 import { ICapabilities } from './Capabilities.js';
 // this causes error
-// import { Kind as WorkspaceKind } from '../Workspace.js';
+// import { Kind as FolderKind } from '../Folder.js';
 
 export const DefaultOwner = 'default';
 
+export interface FileAddOptions {
+  /**
+   * The parent folder where to put the file.
+   * The `parents` array is always cleared from the file object before adding it to the store.
+   */
+  parent?: string;
+}
+
+export interface MediaReadOptions {
+  /**
+   * When set it reads the file that was marked as `_deleted`. By default it throws when file was deleted.
+   */
+  deleted?: boolean;
+}
+
+/**
+ * A breadcrumb when creating the breadcrumb list for a file.
+ */
+export interface FileBreadcrumb {
+  /**
+   * The datastore key of the object.
+   */
+  key: string;
+  /**
+   * THe kind of the object.
+   */
+  kind: string;
+  /**
+   * The name of the object.
+   */
+  name: string;
+}
+
 export interface IStoredFile {
   /**
    * The kind of the File
@@ -354,15 +387,15 @@ export class StoredFile {
       canUntrash: isOwner,
       canReadMedia: false,
     };
-    // Do not use the `WorkspaceKind` reference here as it's circular and creates
+    // Do not use the `FolderKind` reference here as it's circular and creates
     // an error.
-    if (file.kind === 'Core#Space' && isWriter) {
+    if (file.kind === 'Core#Folder' && isWriter) {
       result.canAddChildren = true;
     }
-    if (file.kind === 'Core#Space') {
+    if (file.kind === 'Core#Folder') {
       result.canListChildren = isReader;
     }
-    if (file.kind !== 'Core#Space') {
+    if (file.kind !== 'Core#Folder') {
       result.canReadMedia = isReader;
     }
     return result;

package/src/proxy/ProxyService.ts

@@ -1,6 +1,5 @@
 import { IProjectExecutionLog } from "../runtime/reporters/Reporter.js";
 import { IRequestLog } from "../models/RequestLog.js";
-import AppProjectProxy, { IAppProjectProxyInit } from "./AppProjectProxy.js";
 import HttpProjectProxy, { IHttpProjectProxyInit, IHttpProjectStoreProxyInit } from "./HttpProjectProxy.js";
 import { IProxyResult } from "./Proxy.js";
 import RequestProxy, { IRequestProxyInit } from "./RequestProxy.js";
@@ -31,18 +30,4 @@ export default class ProxyService {
     await proxy.configure(init, token, storeUri);
     return proxy.execute();
   }
-
-  /**
-   * Executes an AppProject.
-   * 
-   * @param token The user access token to read data from the store.
-   * @param storeUri The store's base URI.
-   * @param init The project run configuration.
-   * @returns The key under which the proxy is cached.
-   */
-  async proxyAppProject(token: string, storeUri: string, init: IAppProjectProxyInit): Promise<IProxyResult<IProjectExecutionLog>> {
-    const proxy = new AppProjectProxy();
-    await proxy.configure(init, token, storeUri);
-    return proxy.execute() as Promise<IProxyResult<IProjectExecutionLog>>;
-  }
 }

package/src/proxy/readme.md

@@ -4,6 +4,5 @@ The libraries to create an HTTP/Socket proxy for API things (projects, requests)
 
 ## Libraries
 
-- `AppProjectProxy` - a class that runs request from an `AppProject`
 - `HttpProjectProxy` - a class that runs request from an `HttpProject`
 - `RequestProxy` - a class that runs a single request as `HttpRequest`

package/src/runtime/node/InteropInterfaces.ts

@@ -4,7 +4,6 @@ import { Environment } from '../../models/Environment.js';
 import { Logger } from '../../lib/logging/Logger.js';
 import { IRequestLog } from '../../models/RequestLog.js';
 import { CookieJar } from '../../cookies/CookieJar.js';
-import { IAppProject } from 'browser.js';
 
 export interface IRequestRunnerOptions {
   /**
@@ -72,7 +71,7 @@ export interface IProjectParallelRunnerOptions extends IProjectRunnerOptions {
 }
 
 export interface IProjectParallelWorkerOptions extends IProjectRunnerOptions {
-  project: IHttpProject | IAppProject;
+  project: IHttpProject;
 }
 
 export interface IProjectRunnerOptions {

package/src/runtime/node/ProjectParallelRunner.ts

@@ -3,7 +3,6 @@ import { cpus } from 'os';
 import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 import { HttpProject } from '../../models/HttpProject.js';
-import { AppProject } from '../../models/AppProject.js';
 import { IProjectExecutionLog, IProjectExecutionIteration } from '../reporters/Reporter.js';
 import { BaseRunner } from './BaseRunner.js';
 import { State } from './enums.js';
@@ -67,13 +66,13 @@ export interface ProjectParallelRunner {
  * change. This event can be user to refresh the UI to reflect the newest state.
  */
 export class ProjectParallelRunner extends BaseRunner {
-  project: HttpProject | AppProject;
+  project: HttpProject;
   options: IProjectParallelRunnerOptions;
   workers: WorkerInfoInternal[] = [];
   private mainResolver?: (report: IProjectExecutionLog) => void;
   private mainRejecter?: (err: Error) => void;
 
-  constructor(project: HttpProject | AppProject, opts: IProjectParallelRunnerOptions = {}) {
+  constructor(project: HttpProject, opts: IProjectParallelRunnerOptions = {}) {
     super();
     this.project = project;
     this.options = opts;

package/src/runtime/node/ProjectRequestRunner.ts

@@ -14,7 +14,6 @@ import { IProjectExecutionResult, IRequestRunnerOptions, IRequestRunnerRunOption
 import { State } from './enums.js';
 import { HttpRequestRunner } from '../http-runner/HttpRequestRunner.js';
 import { CookieJar } from '../../cookies/CookieJar.js';
-import { AppProject, AppProjectFolder, AppProjectFolderKind, AppProjectItem, AppProjectRequest, AppProjectRequestKind } from '../../models/AppProject.js';
 import { ProjectItem } from '../../models/ProjectItem.js';
 
 export interface ProjectRequestRunner {
@@ -53,7 +52,7 @@ export interface ProjectRequestRunner {
  */
 export class ProjectRequestRunner extends EventEmitter {
   logger?: Logger;
-  project: HttpProject | AppProject;
+  project: HttpProject;
   /**
    * An instance of a cookie jar (store) to put/read cookies.
    */
@@ -73,7 +72,7 @@ export class ProjectRequestRunner extends EventEmitter {
     return this._state;
   }
 
-  constructor(project: HttpProject | AppProject, opts: IRequestRunnerOptions = {}) {
+  constructor(project: HttpProject, opts: IRequestRunnerOptions = {}) {
     super();
     this.project = project;
     this.logger = opts.logger;
@@ -126,32 +125,32 @@ export class ProjectRequestRunner extends EventEmitter {
     }
   }
 
-  protected async * _runIterator(items: (ProjectItem | AppProjectItem)[], variables: Record<string, string>, options: IRequestRunnerRunOptions): AsyncGenerator<IRunResult> {
+  protected async * _runIterator(items: ProjectItem[], variables: Record<string, string>, options: IRequestRunnerRunOptions): AsyncGenerator<IRunResult> {
     for (const item of items) {
       const current = item.getItem();
       if (!current) {
         continue;
       }
-      if (current.kind === AppProjectRequestKind || current.kind === ProjectRequestKind) {
+      if (current.kind === ProjectRequestKind) {
         if (Array.isArray(options.ignore) && options.ignore.includes(current.key)) {
           continue;
         }
         if (Array.isArray(options.requests) && !options.requests.includes(current.key) && !options.requests.includes(current.info.name || '')) {
           continue;
         }
-        const info = await this._runItem(current as AppProjectRequest | ProjectRequest, variables);
+        const info = await this._runItem(current as ProjectRequest, variables);
         yield info;
-      } else if (current.kind === ProjectFolderKind || current.kind === AppProjectFolderKind) {
+      } else if (current.kind === ProjectFolderKind) {
         if (!options.recursive) {
           continue;
         }
-        const parent = current as ProjectFolder | AppProjectFolder;
+        const parent = current as ProjectFolder;
         // make a copy so the variables executed in the encapsulated environment won't leak out to the current environment.
         let encapsulated = false;
         // we restore the `baseUri` after exiting the folder.
         const currentBaseUri = variables.baseUri;
         const { items: parentItems } = parent;
-        const envItem = (parentItems as (ProjectItem | AppProjectItem)[]).find(i => i.kind === EnvironmentKind);
+        const envItem = (parentItems as ProjectItem[]).find(i => i.kind === EnvironmentKind);
         let parentVariables: Record<string, string> = {};
         let childVariables = variables;
         if (envItem) {
@@ -214,7 +213,7 @@ export class ProjectRequestRunner extends EventEmitter {
     }
   }
 
-  private async _runItem(request: ProjectRequest | AppProjectRequest, variables: Record<string, string>): Promise<IRunResult> {
+  private async _runItem(request: ProjectRequest, variables: Record<string, string>): Promise<IRunResult> {
     if (this._state === State.Aborted) {
       throw new Error(`The execution has been aborted.`);
     }
@@ -226,7 +225,7 @@ export class ProjectRequestRunner extends EventEmitter {
     return info;
   } 
 
-  protected async execute(request: ProjectRequest | AppProjectRequest, variables: Record<string, string>): Promise<IRunResult> {
+  protected async execute(request: ProjectRequest, variables: Record<string, string>): Promise<IRunResult> {
     const config = request.getConfig();
     const factory = new HttpRequestRunner();
     factory.variables = variables;
@@ -285,14 +284,14 @@ export class ProjectRequestRunner extends EventEmitter {
     return info;
   }
 
-  protected async getVariables(parent: HttpProject | AppProject | ProjectFolder | AppProjectFolder): Promise<Record<string, string>> {
+  protected async getVariables(parent: HttpProject | ProjectFolder): Promise<Record<string, string>> {
     if (this.masterEnvironment) {
       return this.applyVariables([this.masterEnvironment]);
     }
     return this.createEnvironment(parent);
   }
 
-  protected async createEnvironment(parent: HttpProject | AppProject | ProjectFolder | AppProjectFolder): Promise<Record<string, string>> {
+  protected async createEnvironment(parent: HttpProject | ProjectFolder): Promise<Record<string, string>> {
     const envs = await this.readEnvironments(parent);
     return this.applyVariables(envs);
   }
@@ -300,7 +299,7 @@ export class ProjectRequestRunner extends EventEmitter {
   /**
    * Reads the list of the environments to apply to this runtime.
    */
-  protected async readEnvironments(parent: HttpProject | AppProject | ProjectFolder | AppProjectFolder): Promise<Environment[]> {
+  protected async readEnvironments(parent: HttpProject | ProjectFolder): Promise<Environment[]> {
     const folderKey = parent.kind === ProjectFolderKind ? (parent as ProjectFolder).key : undefined;
     return this.project.readEnvironments({ parent: folderKey });
   }

package/src/runtime/node/ProjectRunner.ts

@@ -11,9 +11,8 @@ import { pathExists, readJson } from '../../lib/fs/Fs.js';
 import { BaseRunner } from './BaseRunner.js';
 import { IProjectRunnerOptions, IRequestRunnerOptions } from './InteropInterfaces.js';
 import { State } from './enums.js';
-import { AppProject, AppProjectFolder } from '../../models/AppProject.js';
 
-type ProjectParent = HttpProject | ProjectFolder | AppProject | AppProjectFolder;
+type ProjectParent = HttpProject | ProjectFolder;
 
 export interface ProjectRunner {
   /**
@@ -90,7 +89,7 @@ export abstract class ProjectRunner extends BaseRunner {
   /**
    * The HTTP project to run requests from.
    */
-  project?: HttpProject | AppProject;
+  project?: HttpProject;
   /**
    * The execution options for the project.
    */
@@ -173,7 +172,7 @@ export abstract class ProjectRunner extends BaseRunner {
    * A required step before running the project.
    * It configures the execution context. It may throw an error when configuration is not valid.
    */
-  async configure(project: HttpProject | AppProject, opts: IProjectRunnerOptions = {}): Promise<void> {
+  async configure(project: HttpProject, opts: IProjectRunnerOptions = {}): Promise<void> {
     this.project = project;
     this.options = opts || {};
     if (typeof this.options.iterations === 'number' && this.options.iterations >= 0) {

package/src/runtime/node/ProjectRunnerWorker.ts

@@ -3,7 +3,6 @@
 import process from 'process';
 import cluster from 'cluster';
 import { HttpProject, Kind as HttpProjectKind } from '../../models/HttpProject.js';
-import { AppProject, AppProjectKind } from '../../models/AppProject.js';
 import { IProjectExecutionLog } from '../reporters/Reporter.js';
 import { IWorkerMessage } from './ProjectParallelRunner.js';
 import { IProjectParallelWorkerOptions } from './InteropInterfaces.js';
@@ -33,11 +32,9 @@ class ProjectExeWorker extends ProjectRunner {
     options.cookies = new InMemoryCookieJar();
     try {
       const schema = options.project;
-      let project: HttpProject | AppProject;
+      let project: HttpProject;
       if (schema.kind === HttpProjectKind) {
         project = new HttpProject(schema);
-      } else if (schema.kind === AppProjectKind) {
-        project = new AppProject(schema);
       } else {
         throw new Error(`Unknown project kind: ${schema.kind}`);
       }