@api-client/core 0.3.11 → 0.4.1

package/readme.md

@@ -2,17 +2,17 @@
 
 The core library of the API Client application. This build on top of the experience of Advanced REST Client.
 
-Contains the core models, events, and logic related to ARC. This replaces the `events`, `lib`, and parts of `base` libraries.
+Contains the core models, events, and logic related to API Client.
 
 ## Purpose
 
-The core library provides the libraries that ARC and related projects are re-using under the hood.
+The core library provides the libraries that API Client and related projects are re-using under the hood.
 
 The library is structured as follows:
 
-- models - the data model libraries providing the data schema definition for ARC and related projects and the common logic to manipulate the data
+- models - the data model libraries providing the data schema definition for API Client and related projects and the common logic to manipulate the data
 - runtime - the executable part of the library; contains classes that executes an HTTP request, runs a series of requests defined in a project, etc
-- utilities - helper libraries that can be shared across the ARC ecosystem
+- utilities - helper libraries that can be shared across the API Client ecosystem
 
 ## What it isn't
 
@@ -36,7 +36,7 @@ These libraries can be used, among others, to:
 
 ## Community driven
 
-The entire ARC project is community driven. We build tools for API developers to make them successful without investing into very expensive enterprise solutions. We are happy to hear from you. If your ideas can benefit the community we will implement them. That's on us. But you are welcome to clone the project, build your idea, and send us a PR. We will accept it if it won't influence the stability of the project and it's safe to marge with the main branch.
+The entire API Client project is community driven. We build tools for API developers to make them successful without investing into very expensive enterprise solutions. We are happy to hear from you. If your ideas can benefit the community we will implement them. That's on us. But you are welcome to clone the project, build your idea, and send us a PR. We will accept it if it won't influence the stability of the project and it's safe to marge with the main branch.
 
 ## Documentation
 

package/src/data/JmesparthReader.ts

@@ -5,7 +5,7 @@ import { DataReader } from './DataReader.js';
  * Reads the value from a JSON document using the the JmesPath notation.
  * See https://jmespath.org/
  * 
- * Note, after consideration this implementation is not used with ARC projects to extract 
+ * Note, after consideration this implementation is not used with API Client projects to extract 
  * request data. Instead, we use `JsonReader` that converts the JSON to XML so the same 
  * XPath can be used for both JSON and XML.
  */

package/src/events/models/ProjectEvents.ts

@@ -198,7 +198,7 @@ class ProjectEnvironmentEvents {
 }
 
 /**
- * ARC's HTTP project events.
+ * API Client's HTTP project events.
  * 
  * Note, `id`s refers to datastore ids but `key`s are internal identifiers inside the project.
  * Whenever id is used it refers to the store's ids. When `key` is used it is the id of the project or any of its components.
@@ -328,4 +328,4 @@ export class ProjectEvents {
   static get Environment(): typeof ProjectEnvironmentEvents {
     return ProjectEnvironmentEvents;
   }
-};
+}

package/src/events/readme.md

@@ -1,6 +1,6 @@
 # Events
 
-This package contains a definition of events used by the ARC ecosystem to communicate with context providers.
+This package contains a definition of events used by the API Client ecosystem to communicate with context providers.
 
 ## Context provider
 

package/src/lib/transformers/PayloadSerializer.ts

@@ -188,7 +188,7 @@ export class PayloadSerializer {
       enabled: true,
     };
     if (file.name === 'blob') {
-      // ARC adds the "blob" filename when the content type is set on the editor.
+      // API Client adds the "blob" filename when the content type is set on the editor.
       // otherwise it wouldn't be possible to set the content type value.
       part.type = file.type;
     } else {
@@ -297,9 +297,9 @@ export class PayloadSerializer {
   }
 
   /**
-   * Deserializes FormData from ARC data model.
+   * Deserializes FormData from API Client data model.
    *
-   * @param {IMultipartBody[]} model ARC model for multipart.
+   * @param parts API Client model for multipart.
    * @return {FormData} Restored form data
    */
   static deserializeFormData(parts: IMultipartBody[]): FormData {

package/src/mocking/ProjectMock.ts

@@ -1,13 +1,19 @@
 import { DataMock, DataMockInit } from '@pawel-up/data-mock';
 import { Request } from './lib/Request.js';
 import { Response } from './lib/Response.js';
+import { User } from './lib/User.js';
+import { History } from './lib/History.js';
 
 export { IRequestLogInit } from './lib/Request.js';
-export { IArcResponseInit } from './lib/Response.js';
+export { IResponseInit } from './lib/Response.js';
+export { ISpaceUserInit, IUserInit } from './lib/User.js';
+export { IHttpHistoryInit, IHttpHistoryListInit } from './lib/History.js';
 
 export class ProjectMock extends DataMock {
   projectRequest: Request;
   response: Response;
+  user: User;
+  history: History;
   
   /**
    * @param init The library init options.
@@ -16,5 +22,7 @@ export class ProjectMock extends DataMock {
     super(init);
     this.projectRequest = new Request(init);
     this.response = new Response(init);
+    this.user = new User(init);
+    this.history = new History(init);
   }
 }

package/src/mocking/lib/History.ts

@@ -0,0 +1,179 @@
+import { Internet, Types, DataMockInit, Person, Random, TypeDateTimeInit } from '@pawel-up/data-mock';
+// import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
+import { IHttpHistory, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
+import { Request, IRequestLogInit } from './Request.js';
+
+
+export interface IHttpHistoryInit {
+  /**
+   * Either space id, list of spaces to pick one or whether to generate a space.
+   */
+  space?: boolean | string | string[];
+  /**
+   * User is always generated per store requirements.
+   */
+  user?: string | string[];
+  /**
+   * Either project id, list of projects to pick one or whether to generate a project.
+   */
+  project?: boolean | string | string[];
+  /**
+   * Either request id, list of requests to pick one or whether to generate a request.
+   */
+  request?: boolean | string | string[];
+  /**
+   * Either app id, list of apps to pick one or whether to generate an app.
+   */
+  app?: boolean | string | string[];
+  /**
+   * The log init options
+   */
+  log?: IRequestLogInit;
+  /**
+   * The created time init options.
+   */
+  created?: TypeDateTimeInit;
+}
+
+export interface IHttpHistoryListInit extends IHttpHistoryInit {
+  /**
+   * When set it generates as many user IDs.
+   * Ignored when the `user` is set.
+   */
+  usersSize?: number;
+  /**
+   * When set it generates as many space ids.
+   * Ignored when the `space` is set.
+   */
+  spacesSize?: number;
+  /**
+   * When set it generates as many project ids.
+   * Ignored when the `project` is set.
+   */
+  projectsSize?: number;
+  /**
+   * When set it generates as many request ids.
+   * Ignored when the `request` is set.
+   */
+  requestsSize?: number;
+  /**
+   * When set it generates as many app ids.
+   * Ignored when the `app` is set.
+   */
+  appsSize?: number;
+}
+
+export class History {
+  person: Person;
+  types: Types;
+  internet: Internet;
+  random: Random;
+  request: Request;
+
+  constructor(init: DataMockInit={}) {
+    this.person = new Person(init);
+    this.types = new Types(init.seed);
+    this.internet = new Internet(init);
+    this.random = new Random(init.seed);
+    this.request = new Request(init);
+  }
+
+  httpHistory(init: IHttpHistoryInit = {}): IHttpHistory {
+    const date = this.types.datetime(init.created);
+    const result: IHttpHistory = {
+      kind: HttpHistoryKind,
+      created: date.getTime(),
+      log: this.request.log(init.log),
+      user: '',
+    }
+    date.setHours(0, 0, 0, 0);
+    result.midnight = date.getTime();
+
+    if (typeof init.space === 'string') {
+      result.space = init.space;
+    } else if (Array.isArray(init.space)) {
+      result.space = this.random.pickOne(init.space);
+    } else if (init.space) {
+      result.space = this.types.string(10);
+    }
+    
+    if (typeof init.user === 'string') {
+      result.user = init.user;
+    } else if (Array.isArray(init.user)) {
+      result.user = this.random.pickOne(init.user);
+    } else {
+      result.user = this.types.uuid();
+    }
+    
+    if (typeof init.project === 'string') {
+      result.project = init.project;
+    } else if (Array.isArray(init.project)) {
+      result.project = this.random.pickOne(init.project);
+    } else if (init.project) {
+      result.project = this.types.uuid();
+    }
+    
+    if (typeof init.request === 'string') {
+      result.request = init.request;
+    } else if (Array.isArray(init.request)) {
+      result.request = this.random.pickOne(init.request);
+    } else if (init.request) {
+      result.request = this.types.uuid();
+    }
+    
+    if (typeof init.app === 'string') {
+      result.app = init.app;
+    } else if (Array.isArray(init.app)) {
+      result.app = this.random.pickOne(init.app);
+    } else if (init.app) {
+      result.app = this.types.uuid();
+    }
+    return result;
+  }
+
+  httpHistoryList(size=25, init: IHttpHistoryListInit = {}): IHttpHistory[] {
+    const { usersSize, spacesSize, projectsSize, requestsSize, appsSize } = init;
+    const copy = { ...init };
+    if (usersSize && typeof init.user === 'undefined') {
+      const users: string[] = [];
+      for (let i = 0; i < usersSize; i++) {
+        users.push(this.types.uuid());
+      }
+      copy.user = users;
+    }
+    if (spacesSize && typeof init.space === 'undefined') {
+      const space: string[] = [];
+      for (let i = 0; i < spacesSize; i++) {
+        space.push(this.types.string(10));
+      }
+      copy.space = space;
+    }
+    if (projectsSize && typeof init.project === 'undefined') {
+      const project: string[] = [];
+      for (let i = 0; i < projectsSize; i++) {
+        project.push(this.types.uuid());
+      }
+      copy.project = project;
+    }
+    if (requestsSize && typeof init.request === 'undefined') {
+      const requests: string[] = [];
+      for (let i = 0; i < requestsSize; i++) {
+        requests.push(this.types.uuid());
+      }
+      copy.request = requests;
+    }
+    if (appsSize && typeof init.app === 'undefined') {
+      const apps: string[] = [];
+      for (let i = 0; i < appsSize; i++) {
+        apps.push(this.types.uuid());
+      }
+      copy.app = apps;
+    }
+
+    const result: IHttpHistory[] = [];
+    for (let i = 0; i < size; i++) {
+      result.push(this.httpHistory(copy));
+    }
+    return result;
+  }
+}

package/src/mocking/lib/Request.ts

@@ -3,12 +3,12 @@ import { Http, Types, Lorem, Time, DataMockInit, HttpRequestInit } from '@pawel-
 import { IHttpRequest, Kind as HttpRequestKind } from '../../models/HttpRequest.js';
 import { IRequest, Kind as RequestKind } from '../../models/Request.js';
 import { ISentRequest } from '../../models/SentRequest.js';
-import { IRequestLog } from '../../models/RequestLog.js';
-import { IArcResponseInit, Response } from './Response.js';
+import { IRequestLog, Kind as RequestLogKind } from '../../models/RequestLog.js';
+import { IResponseInit, Response } from './Response.js';
 
 export interface IRequestLogInit {
   request?: HttpRequestInit;
-  response?: IArcResponseInit;
+  response?: IResponseInit;
   /**
    * When set it ignores size information
    */
@@ -66,13 +66,13 @@ export class Request {
 
   log(init: IRequestLogInit = {}): IRequestLog {
     const result: IRequestLog = {
-      kind: 'ARC#ResponseLog',
+      kind: RequestLogKind,
     };
     if (!init.noRequest) {
       result.request = this.sentRequest(init.request);
     }
     if (!init.noResponse) {
-      result.response = this.response.arcResponse(init.response);
+      result.response = this.response.response(init.response);
     }
     if (init.redirects) {
       result.redirects = this.response.redirects();

package/src/mocking/lib/Response.ts

@@ -1,10 +1,10 @@
 import { Http, Har, Types, Lorem, Time, DataMockInit, HttpResponseInit, HarTimingInit, Internet } from '@pawel-up/data-mock';
 import { IHttpResponse, Kind as HttpResponseKind } from '../../models/HttpResponse.js';
-import { IArcResponse, Kind as ArcResponseKind } from '../../models/ArcResponse.js';
+import { IResponse, Kind as ResponseKind } from '../../models/Response.js';
 import { IRequestsSize } from '../../models/RequestsSize.js';
 import { IResponseRedirect, Kind as ResponseRedirectKind  } from '../../models/ResponseRedirect.js';
 
-export interface IArcResponseInit extends HttpResponseInit, HarTimingInit {
+export interface IResponseInit extends HttpResponseInit, HarTimingInit {
   /**
    * When set it does not generate a response payload.
    */
@@ -36,7 +36,7 @@ export class Response {
     this.internet = new Internet(init);
   }
 
-  response(init: IArcResponseInit = {}): IHttpResponse {
+  httpResponse(init: IResponseInit = {}): IHttpResponse {
     const ct = init.noBody ? undefined : this.http.headers.contentType();
     const body = init.noBody ? undefined : this.http.payload.payload(ct);
     const headers = this.http.headers.headers('response', { mime: ct });
@@ -56,12 +56,12 @@ export class Response {
     return result;
   }
 
-  arcResponse(init: IArcResponseInit={}): IArcResponse {
-    const base = this.response(init);
+  response(init: IResponseInit={}): IResponse {
+    const base = this.httpResponse(init);
     const length = this.types.number({ min: 10, max: 4000 });
-    const result: IArcResponse = {
+    const result: IResponse = {
       ...base,
-      kind: ArcResponseKind,
+      kind: ResponseKind,
       loadingTime: length,
     };
     if (init.timings) {
@@ -78,7 +78,7 @@ export class Response {
     return result;
   }
 
-  redirect(init?: IArcResponseInit): IResponseRedirect {
+  redirect(init?: IResponseInit): IResponseRedirect {
     const start = this.time.timestamp();
     const end = this.time.timestamp({ min: start + 1 })
     const info: IResponseRedirect = {
@@ -86,12 +86,12 @@ export class Response {
       startTime: start,
       endTime: end,
       url: this.internet.uri(),
-      response: this.response({ ...init, statusGroup: 3}),
+      response: this.httpResponse({ ...init, statusGroup: 3}),
     };
     return info;
   }
 
-  redirects(size=1, init?: IArcResponseInit): IResponseRedirect[] {
+  redirects(size=1, init?: IResponseInit): IResponseRedirect[] {
     const result: IResponseRedirect[] = [];
     for (let i = 0; i < size; i++) {
       result.push(this.redirect(init));

package/src/mocking/lib/User.ts

@@ -0,0 +1,68 @@
+import { Internet, Types, DataMockInit, Person, Random } from '@pawel-up/data-mock';
+// import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
+import { IUser, ISpaceUser, AccessControlLevel, Kind as UserKind } from '../../models/User.js';
+
+
+export interface IUserInit {
+  noEmail?: boolean;
+  noPicture?: boolean;
+  noProvider?: boolean;
+}
+
+export interface ISpaceUserInit extends IUserInit {
+  level?: AccessControlLevel;
+  levelPool?: AccessControlLevel[];
+}
+
+const accessPool: AccessControlLevel[] = ['read', 'comment', 'write', 'admin', 'owner'];
+
+export class User {
+  person: Person;
+  types: Types;
+  internet: Internet;
+  random: Random;
+
+  constructor(init: DataMockInit={}) {
+    this.person = new Person(init);
+    this.types = new Types(init.seed);
+    this.internet = new Internet(init);
+    this.random = new Random(init.seed);
+  }
+
+  user(init: IUserInit = {}): IUser {
+    const result: IUser = {
+      kind: UserKind,
+      key: this.types.uuid(),
+      name: this.person.name(),
+    }
+    if (!init.noEmail) {
+      result.email = [{
+        email: this.internet.email(),
+        verified: this.types.boolean(),
+      }];
+    }
+    if (!init.noPicture) {
+      result.picture = {
+        url: this.internet.avatar(),
+      };
+    }
+    if (!init.noProvider) {
+      result.provider = {
+        refreshToken: this.types.uuid(),
+      };
+    }
+    return result;
+  }
+
+  spaceUser(init: ISpaceUserInit = {}): ISpaceUser {
+    const user = this.user(init) as ISpaceUser;
+    if (init.level) {
+      user.level = init.level;
+    } else if (Array.isArray(init.levelPool)) {
+      user.level = this.random.pickOne(init.levelPool);
+    } else {
+      user.level = this.random.pickOne(accessPool);
+    }
+    return user;
+  }
+}

package/src/models/AuthorizationData.ts

@@ -6,7 +6,7 @@ export interface IAuthorizationData {
 
 
 /**
- * Represents an auth data stored in ARC's data store to be retrieved
+ * Represents an auth data stored in API Client's data store to be retrieved
  * when the response status is 401.
  * 
  * Each entry represent a Basic or NTLM authorization.
@@ -34,7 +34,7 @@ export class AuthorizationData {
   /**
    * Creates a new provider clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the provider is not an ARC provider object.
+   * Note, this throws an error when the provider is not an API Client provider object.
    */
   new(init: IAuthorizationData): void {
     const { username, password, domain } = init;

package/src/models/Backend.ts

@@ -1,3 +1,4 @@
+/* eslint-disable import/export */
 export type BackendMode = 'single-user' | 'multi-user';
 
 export interface IBackendInfo {
@@ -104,4 +105,96 @@ export interface IListOptions {
    * Only with the `query` property. Tells the system in which fields to search for the query term.
    */
   queryField?: string[];
+  type?: string;
+}
+
+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 space containing the project.
+   * The access to the history records for the project is tested against the user space.
+   */
+  space: string;
+  /**
+   * 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 space containing the project that contains the request.
+   * The access to the history records for the request is tested against the user space.
+   */
+  space: 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;
 }

package/src/models/ClientCertificate.ts

@@ -61,7 +61,7 @@ export interface ICertificateIndex {
 }
 
 /**
- * A base client certificate object used in ARC to create / list objects.
+ * A base client certificate object used in API Client to create / list objects.
  * This is not a data entity but rather something used to outside of a context of a data store.
  */
 export interface IClientCertificate extends IRequestCertificate, ICertificateIndex {

package/src/models/Environment.ts

@@ -16,7 +16,7 @@ export interface IEnvironmentCloneOptions {
  * A project environment definition.
  */
 export interface IEnvironment {
-  kind: 'ARC#Environment';
+  kind: typeof Kind;
   /**
    * The identifier of the environment.
    */
@@ -47,7 +47,7 @@ export interface IEnvironment {
   security?: unknown;
 }
 
-export const Kind = 'ARC#Environment';
+export const Kind = 'Core#Environment';
 
 /**
  * An environment is applied to a project or a folder.
@@ -145,11 +145,11 @@ export class Environment {
   /**
    * Creates a new environment clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the environment is not an ARC environment. 
+   * Note, this throws an error when the environment is not an environment. 
    */
   new(init: IEnvironment): void {
     if (!Environment.isEnvironment(init)) {
-      throw new Error(`Not an ARC environment.`);
+      throw new Error(`Not an environment.`);
     }
     const { key=v4(), variables, info, server, encapsulated=false, security } = init;
     this.kind = Kind;

package/src/models/ErrorResponse.ts

@@ -86,7 +86,7 @@ export class ErrorResponse extends HttpResponse {
   /**
    * Creates a new request clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the object is not an ARC request.
+   * Note, this throws an error when the object is not an API Client request.
    */
   new(init: IErrorResponse): void {
     super.new(init);

package/src/models/HostRule.ts

@@ -1,7 +1,7 @@
-export const Kind = 'ARC#HostRule';
+export const Kind = 'Core#HostRule';
 
 /**
- * ARC host rule definition.
+ * API Client host rule definition.
  */
 export interface IHostRule {
   kind?: typeof Kind;
@@ -74,11 +74,11 @@ export class HostRule {
   /**
    * Creates a new thing clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the server is not an ARC thing.
+   * Note, this throws an error when the server is not an API Client thing.
    */
   new(init: IHostRule): void {
     if (!HostRule.isHostRule(init)) {
-      throw new Error(`Not an ARC HostRule.`);
+      throw new Error(`Not a HostRule.`);
     }
     const { from='', to='', enabled, comment } = init;
     this.kind = Kind;
@@ -138,7 +138,7 @@ export class HostRule {
   /**
    * Evaluates hosts rule and applies it to the `url`.
    * @param {string} url The URL to evaluate
-   * @param {HostRule} rule ARC rule definition
+   * @param {HostRule} rule The host rule definition
    * @return {string} Processed url.
    */
   static evaluateRule(url: string, rule: HostRule): string | undefined {