@api-client/core 0.3.9 → 0.3.12

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

@@ -0,0 +1,67 @@
+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 } 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 = {
+      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/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/HttpHistory.ts

@@ -0,0 +1,229 @@
+import { IRequestLog, RequestLog, Kind as RequestLogKind } from './RequestLog.js';
+
+export const Kind = 'ARC#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

@@ -350,7 +350,7 @@ export class HttpProject extends ProjectParent {
     this.key = key;
     this.environments = [];
     if (Array.isArray(environments)) {
-      this.environments = environments;
+      this.environments = [...environments];
     }
     if (license) {
       this.license = new License(license);
@@ -416,7 +416,7 @@ export class HttpProject extends ProjectParent {
       result.definitions.schemas = this.definitions.schemas.map(i => i.toJSON());
     }
     if (Array.isArray(this.environments) && this.environments.length) {
-      result.environments = this.environments;
+      result.environments = [...this.environments];
     }
     if (Array.isArray(this.items) && this.items.length) {
       result.items = this.items.map(i => i.toJSON());

package/src/models/ProjectFolder.ts

@@ -148,7 +148,7 @@ export class ProjectFolder extends ProjectParent {
       this.info = new Thing({ kind: ThingKind, name: DefaultFolderName });
     }
     if (Array.isArray(environments)) {
-      this.environments = environments;
+      this.environments = [...environments];
     } else {
       this.environments = [];
     }
@@ -179,7 +179,7 @@ export class ProjectFolder extends ProjectParent {
       result.items = this.items.map(i => i.toJSON());
     }
     if (Array.isArray(this.environments)) {
-      result.environments = this.environments;
+      result.environments = [...this.environments];
     }
     return result;
   }

package/src/models/Workspace.ts

@@ -144,7 +144,7 @@ export class Workspace {
       this.info = new Thing({ kind: ThingKind, name: '' });
     }
     if (Array.isArray(users)) {
-      this.users = users;
+      this.users = [...users];
     } else {
       this.users = [];
     }
@@ -175,7 +175,7 @@ export class Workspace {
       owner,
     };
     if (Array.isArray(users) && users.length) {
-      result.users = users;
+      result.users = [...users];
     }
     return result;
   }