@api-client/core 0.3.10 → 0.4.0

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/Application.ts

@@ -0,0 +1,19 @@
+/**
+ * A definition if an application.
+ */
+export interface IApplication {
+  /**
+   * The unique code identifying the application in the ecosystem.
+   * For example, `api-client` application has its own code reported through this property.
+   * This is not generated per instance but per application.
+   */
+  code: string;
+  /**
+   * Application display name.
+   */
+  name: string;
+  /**
+   * The current version of the application.
+   */
+  version: string;
+}

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/HistoryIndex.ts

@@ -1,8 +1,11 @@
+export const Kind = 'Core#HistoryIndex';
+
 /**
- * An object that is stored in ARCs internal store to build history navigation.
+ * An object that is stored in API Client's internal store to build history navigation.
  * It does not contain all the history data. Just the ones that are presented in the UI.
  */
 export interface IHistoryIndex {
+  kind: typeof Kind;
   /**
    * Timestamp when the request was last updated.
    */
@@ -47,6 +50,7 @@ export class HistoryIndex {
       init = input;
     } else {
       init = {
+        kind: Kind,
         updated: 0,
         midnight: 0,
         url: '',
@@ -66,6 +70,7 @@ export class HistoryIndex {
 
   toJSON(): IHistoryIndex {
     const result: IHistoryIndex = {
+      kind: Kind,
       updated: this.updated,
       midnight: this.midnight,
       url: this.url,

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 {

package/src/models/HttpHistory.ts

@@ -0,0 +1,229 @@
+import { IRequestLog, RequestLog, Kind as RequestLogKind } from './RequestLog.js';
+
+export const Kind = 'Core#HttpHistory';
+export const createdSymbol = Symbol('created');
+export const midnightSymbol = Symbol('midnight');
+
+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.
+   */
+  key?: string;
+  /**
+   * Optional user space id. Must be set when the originating request belongs to a user space.
+   */
+  space?: string;
+  /**
+   * Optional project id. Must be set when the originating request belongs to a user space.
+   */
+  project?: string;
+  /**
+   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   */
+  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.
+   */
+  user: string;
+  /**
+   * The optional request id in the project that generated this log.
+   */
+  request?: string;
+  /**
+   * The request log.
+   */
+  log: IRequestLog;
+  /**
+   * The timestamp when this history request has been created.
+   */
+  created: number;
+  /**
+   * A timestamp of the midnight when the object was created
+   */
+  midnight?: number;
+}
+
+/**
+ * An HTTP history is an object containing an information of a request and response
+ * made with the application.
+ * 
+ * Note, history object are not mutable. Can only be created or deleted.
+ */
+export class HttpHistory {
+  [createdSymbol]: number;
+  [midnightSymbol]: number;
+  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.
+   */
+  key?: string;
+  /**
+   * Optional user space id. Must be set when the originating request belongs to a user space.
+   */
+  space?: string;
+  /**
+   * Optional project id. Must be set when the originating request belongs to a user space.
+   */
+  project?: string;
+  /**
+   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   */
+  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.
+   */
+  user = '';
+  /**
+   * The optional request id in the project that generated this log.
+   */
+  request?: string;
+  /**
+   * The execution log of the HTTP request with a response.
+   */
+  log: RequestLog = new RequestLog();
+
+  /**
+   * @param value The timestamp when the request was created.
+   */
+  set created(value: number | undefined) {
+    if (!value) {
+      this[createdSymbol] = Date.now();
+    } else {
+      this[createdSymbol] = value;
+    }
+    const d = new Date(this[createdSymbol]);
+    d.setHours(0, 0, 0, 0);
+    this[midnightSymbol] = d.getTime();
+  }
+
+  /**
+   * @returns The timestamp when the request was created.
+   */
+  get created(): number {
+    return this[createdSymbol] || Date.now();
+  }
+
+  /**
+   * @param value The timestamp of the midnight when the request object was updated
+   */
+  set midnight(value: number | undefined) {
+    if (!value) {
+      this[midnightSymbol] = this.defaultMidnight();
+    } else {
+      this[midnightSymbol] = value;
+    }
+  }
+
+  /**
+   * @returns The timestamp of the midnight when the request object was updated
+   */
+  get midnight(): number {
+    if (this[midnightSymbol]) {
+      return this[midnightSymbol];
+    }
+    return this.defaultMidnight();
+  }
+
+  constructor(input?: string|IHttpHistory) {
+    let init: IHttpHistory;
+    if (typeof input === 'string') {
+      init = JSON.parse(input);
+    } else if (typeof input === 'object') {
+      init = input;
+    } else {
+      const now:number = Date.now();
+      init = {
+        kind: Kind,
+        created: now,
+        user: '',
+        log: {
+          kind: RequestLogKind,
+        },
+      };
+    }
+    this.new(init);
+  }
+
+  new(init: IHttpHistory): void {
+    const { log, created = Date.now(), midnight, space, project, request, user, key, app } = init;
+    this.log = new RequestLog(log);
+    this.created = created;
+    if (key) {
+      this.key = key;
+    } else {
+      this.key = undefined;
+    }
+    if (app) {
+      this.app = app;
+    } else {
+      this.app = undefined;
+    }
+    if (midnight) {
+      this.midnight = midnight;
+    }
+    if (space) {
+      this.space = space;
+    } else {
+      this.space = undefined;
+    }
+    if (project) {
+      this.project = project;
+    } else {
+      this.project = undefined;
+    }
+    if (request) {
+      this.request = request;
+    } else {
+      this.request = undefined;
+    }
+    if (user) {
+      this.user = user;
+    } else {
+      this.user = '';
+    }
+  }
+
+  toJSON(): IHttpHistory {
+    const result: IHttpHistory = {
+      kind: Kind,
+      created: this.created,
+      midnight: this.midnight,
+      log: this.log.toJSON(),
+      user: this.user,
+    };
+    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;
+  }
+
+  /**
+   * @returns The default value for the midnight when the request was last updated.
+   */
+  defaultMidnight(): number {
+    const d = new Date(this.created);
+    d.setHours(0, 0, 0, 0);
+    return d.getTime();
+  }
+}

package/src/models/HttpProject.ts

@@ -14,8 +14,7 @@ import { ARCSavedRequest, ARCHistoryRequest } from './legacy/request/ArcRequest.
 import { ArcLegacyProject, ARCProject } from './legacy/models/ArcLegacyProject.js';
 import { PostmanDataTransformer } from './transformers/PostmanDataTransformer.js';
 
-export type HttpProjectKind = 'ARC#HttpProject';
-export const Kind = 'ARC#HttpProject';
+export const Kind = 'Core#HttpProject';
 
 /**
  * A list of options to initialize a project in various situations.
@@ -167,12 +166,12 @@ export interface IProjectRequestIterator {
 }
 
 /**
- * The new definition of a project in ARC.
+ * The new definition of a project in API Client.
  * Note, this is not the same as future `ApiProject` which is reserved for building APIs
  * using RAML or OAS.
  */
 export interface IHttpProject extends IProjectDefinitionProperty {
-  kind: HttpProjectKind;
+  kind: typeof Kind;
   /**
    * The license information for this HTTP project.
    */
@@ -340,11 +339,11 @@ export class HttpProject extends ProjectParent {
   /**
    * Creates a new project definition clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the project is not an ARC project.
+   * Note, this throws an error when the project is not an API Client project.
    */
   new(init: IHttpProject): void {
     if (!init || !init.definitions || !init.items) {
-      throw new Error(`Not an ARC project.`);
+      throw new Error(`Not a project.`);
     }
     const { key = v4(), definitions = {}, items, info, license, provider, environments } = init;
     this.key = key;

package/src/models/HttpProjectListItem.ts

@@ -1,4 +1,4 @@
-export const Kind = 'ARC#HttpProjectListItem';
+export const Kind = 'Core#HttpProjectListItem';
 /**
  * The HTTP Project definition to be used in lists.
  */

package/src/models/HttpRequest.ts

@@ -1,7 +1,7 @@
 import { SerializablePayload } from './SerializablePayload.js';
 import { Payload } from '../lib/transformers/PayloadSerializer.js';
 
-export const Kind = 'ARC#HttpRequest';
+export const Kind = 'Core#HttpRequest';
 
 export interface IBaseHttpRequest {
   /**
@@ -85,7 +85,7 @@ export class HttpRequest extends SerializablePayload {
   /**
    * 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 a request.
    */
   new(init: IHttpRequest): void {
     const { url, method='GET', headers, payload, kind = Kind } = init;