@api-client/core 0.6.27 → 0.6.30

package/src/events/BaseEvents.ts

@@ -35,9 +35,9 @@ export class ContextEvent<S extends object, R> extends CustomEvent<S & ContextEv
 
 export interface ContextReadEventDetail {
   /**
-   * The id of the state object to read.
+   * The key of the state object to read.
    */
-  id: string;
+  key: string;
   /**
    * Optional parent, when needed.
    */
@@ -50,19 +50,19 @@ export interface ContextReadEventDetail {
 export class ContextReadEvent<T> extends ContextEvent<ContextReadEventDetail, T> {
   /**
    * @param type The type of the event
-   * @param id The domain id of the object to read
+   * @param key The domain key of the object to read
    * @param parent Optional parent, when needed.
    */
-  constructor(type: string, id: string, parent?: string) {
-    super(type, { id, parent });
+  constructor(type: string, key: string, parent?: string) {
+    super(type, { key, parent });
   }
 }
 
 export interface ContextReadBulkEventDetail {
   /**
-   * The list of ids to read.
+   * The list of keys to read.
    */
-  ids: string[];
+  keys: string[];
 }
 
 /**
@@ -71,10 +71,10 @@ export interface ContextReadBulkEventDetail {
 export class ContextReadBulkEvent<T> extends ContextEvent<ContextReadBulkEventDetail, T[]> {
   /**
    * @param type The type of the event
-   * @param ids The list of domain ids to read. These must be of the same domain type.
+   * @param keys The list of domain keys to read. These must be of the same domain type.
    */
-  constructor(type: string, ids: string[]) {
-    super(type, { ids });
+  constructor(type: string, keys: string[]) {
+    super(type, { keys });
   }
 }
 
@@ -89,7 +89,7 @@ export interface ContextChangeRecord<T> {
    */
   kind?: string;
   /**
-   * The ID of the changed context state object.
+   * The key of the changed context state object.
    */
   key: string;
   /**
@@ -97,29 +97,29 @@ export interface ContextChangeRecord<T> {
    */
   item?: T;
   /**
-   * Optionally, when relevant, the id of the parent of the changed object.
+   * Optionally, when relevant, the key of the parent of the changed object.
    */
   parent?: string;
 }
 
 export interface ContextDeleteEventDetail {
   /**
-   * The id of the domain object to remove.
+   * The key of the domain object to remove.
    */
-  id: string;
+  key: string;
   /**
-   * The id of the parent object, if applicable.
+   * The key of the parent object, if applicable.
    */
   parent?: string;
 }
 
 export interface ContextDeleteBulkEventDetail {
   /**
-   * The list of ids of the domain object to remove.
+   * The list of keys of the domain object to remove.
    */
-  ids: string[];
+  keys: string[];
   /**
-   * The id of the parent object, if applicable.
+   * The key of the parent object, if applicable.
    */
   parent?: string;
 }
@@ -131,11 +131,11 @@ export class ContextDeleteEvent extends ContextEvent<ContextDeleteEventDetail, C
   /**
    * An event to be used to delete a state in the context provider.
    * @param type The type of the event to dispatch.
-   * @param id The id of the object to delete
-   * @param parent The id of the parent object, if applicable.
+   * @param key The key of the object to delete
+   * @param parent The key of the parent object, if applicable.
    */
-  constructor(type: string, id: string, parent?: string) {
-    super(type, { id, parent });
+  constructor(type: string, key: string, parent?: string) {
+    super(type, { key, parent });
   }
 }
 
@@ -146,11 +146,11 @@ export class ContextDeleteBulkEvent extends ContextEvent<ContextDeleteBulkEventD
   /**
    * An event to be used to delete a number of entities in the context provider.
    * @param type The type of the event to dispatch.
-   * @param ids The list of ids of the domain object to remove.
-   * @param parent The id of the parent object, if applicable.
+   * @param keys The list of ids of the domain object to remove.
+   * @param parent The key of the parent object, if applicable.
    */
-  constructor(type: string, ids: string[], parent?: string) {
-    super(type, { ids, parent });
+  constructor(type: string, keys: string[], parent?: string) {
+    super(type, { keys, parent });
   }
 }
 
@@ -161,11 +161,11 @@ export interface ContextDeleteRecord {
    */
   kind?: string;
   /**
-   * The id of the removed object.
+   * The key of the removed object.
    */
-  id: string;
+  key: string;
   /**
-   * The id of the parent object, if applicable.
+   * The key of the parent object, if applicable.
    */
   parent?: string;
 }
@@ -173,7 +173,7 @@ export interface ContextDeleteRecord {
 /**
  * An event dispatched to the context store to restore previously deleted items.
  */
-export class ContextRestoreEvent<T> extends ContextEvent<ContextDeleteRecord[], ContextChangeRecord<T>[]> {
+export class ContextRestoreEvent<T> extends ContextEvent<{ records: ContextDeleteRecord[] }, (ContextChangeRecord<T> | undefined)[]> {
   /**
    * An event dispatched to the context store to restore previously deleted items.
    * 
@@ -183,7 +183,7 @@ export class ContextRestoreEvent<T> extends ContextEvent<ContextDeleteRecord[],
    * @param records The records of previously deleted items.
    */
   constructor(type: string, records: ContextDeleteRecord[]) {
-    super(type, records);
+    super(type, { records });
   }
 }
 
@@ -232,7 +232,7 @@ export interface ContextUpdateEventDetail<T> {
    */
   item: T;
   /**
-   * The id of the parent object, if applicable.
+   * The key of the parent object, if applicable.
    */
   parent?: string;
 }
@@ -243,7 +243,7 @@ export interface ContextUpdateBulkEventDetail<T> {
    */
   items: T[];
   /**
-   * The id of the parent object, if applicable.
+   * The key of the parent object, if applicable.
    */
   parent?: string;
 }

package/src/events/models/ClientCertificateEvents.ts

@@ -6,12 +6,12 @@ export class ClientCertificateEvents {
   /**
    * Dispatches an event handled by the data store to read the client certificate.
    *
-   * @param id The id of the client certificate
+   * @param key The key of the client certificate
    * @param target A node on which to dispatch the event.
    * @returns Promise resolved to a client certificate model.
    */
-  static async read(id: string, target: EventTarget = window): Promise<HttpCertificate | undefined> {
-    const e = new ContextReadEvent<HttpCertificate>(ModelEventTypes.ClientCertificate.read, id);
+  static async read(key: string, target: EventTarget = window): Promise<HttpCertificate | undefined> {
+    const e = new ContextReadEvent<HttpCertificate>(ModelEventTypes.ClientCertificate.read, key);
     target.dispatchEvent(e);
     return e.detail.result;
   }
@@ -32,12 +32,12 @@ export class ClientCertificateEvents {
   /**
    * Dispatches an event handled by the data store to delete a client certificate
    *
-   * @param id The id of the project to delete.
+   * @param key The key of the project to delete.
    * @param target A node on which to dispatch the event.
    * @returns Promise resolved to a new revision after delete.
    */
-  static async delete(id: string, target: EventTarget = window): Promise<ContextDeleteRecord | undefined> {
-    const e = new ContextDeleteEvent(ModelEventTypes.ClientCertificate.delete, id, undefined);
+  static async delete(key: string, target: EventTarget = window): Promise<ContextDeleteRecord | undefined> {
+    const e = new ContextDeleteEvent(ModelEventTypes.ClientCertificate.delete, key, undefined);
     target.dispatchEvent(e);
     return e.detail.result;
   }

package/src/events/transport/TransportEvents.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unused-vars */
 import { IRequestAuthorization } from "../../models/RequestAuthorization.js";
 import { IHttpRequest } from "../../models/HttpRequest.js";
 import { IRequestBaseConfig } from "../../models/RequestConfig.js";

package/src/mocking/ProjectMock.ts

@@ -4,6 +4,9 @@ import { Response } from './lib/Response.js';
 import { User } from './lib/User.js';
 import { History } from './lib/History.js';
 import { Url } from './lib/Url.js';
+import { Certificates } from './lib/Certificates.js';
+import { HostRules } from './lib/HostRules.js';
+import { Arc } from './lib/Arc.js';
 
 export { IRequestLogInit } from './lib/Request.js';
 export { IResponseInit } from './lib/Response.js';
@@ -16,6 +19,9 @@ export class ProjectMock extends DataMock {
   user: User;
   history: History;
   url: Url;
+  certificates: Certificates;
+  hostRules: HostRules;
+  arc: Arc;
   
   /**
    * @param init The library init options.
@@ -27,5 +33,8 @@ export class ProjectMock extends DataMock {
     this.user = new User(init);
     this.history = new History(init);
     this.url = new Url(init);
+    this.certificates = new Certificates(init);
+    this.hostRules = new HostRules(init);
+    this.arc = new Arc(init);
   }
 }

package/src/mocking/lib/Arc.ts

@@ -0,0 +1,34 @@
+import { Types, IDataMockInit, IHttpRequestInit } from '@pawel-up/data-mock';
+import { IArcHttpRequest, Kind as ArcHttpRequestKind } from '../../models/arc/ArcHttpRequest.js';
+import { Request } from './Request.js';
+
+export class Arc {
+  protected request: Request;
+  protected types: Types;
+
+  constructor(init: IDataMockInit={}) {
+    this.request = new Request(init);
+    this.types = new Types(init.seed);
+    // this.lorem = new Lorem(init);
+    // this.time = new Time(init);
+    // this.http = new Http(init);
+    // this.response = new Response(init);
+  }
+
+  arcRequest(init?: IHttpRequestInit): IArcHttpRequest {
+    const request = this.request.request(init);
+    return {
+      key: this.types.uuid(),
+      ...request,
+      kind: ArcHttpRequestKind,
+    };
+  }
+
+  arcRequests(size = 25, init?: IHttpRequestInit): IArcHttpRequest[] {
+    const result: IArcHttpRequest[] = [];
+    for (let i = 0; i < size; i++) {
+      result.push(this.arcRequest(init));
+    }
+    return result;
+  }
+}

package/src/mocking/lib/Certificates.ts

@@ -0,0 +1,60 @@
+import { IDataMockInit, Lorem, Random, Types, Utils } from '@pawel-up/data-mock';
+import { HttpCertificate, Certificate, ICertificateData } from '../../models/ClientCertificate.js';
+
+export declare interface CertificateCreateInit {
+  binary?: boolean;
+  noPassphrase?: boolean;
+  type?: 'p12' | 'pem';
+}
+
+export class Certificates {
+  lorem: Lorem;
+  types: Types;
+  random: Random;
+
+  constructor(init: IDataMockInit={}) {
+    this.lorem = new Lorem(init);
+    this.types = new Types(init.seed);
+    this.random = new Random(init.seed);
+  }
+
+  /**
+   * Creates a certificate definition.
+   */
+  certificate(opts: CertificateCreateInit = {}): HttpCertificate {
+    const type = opts.type ? opts.type : this.random.pickOne(['p12', 'pem']);
+    const data = this.lorem.paragraph();
+    const cert = opts.binary ? Utils.strToBuffer(data) : data;
+    let instance: Certificate;
+    if (type === 'p12') {
+      instance = Certificate.fromP12(cert, this.lorem.word());
+    } else if (type === 'pem') {
+      instance = Certificate.fromPem(cert, cert, this.lorem.word());
+    } else {
+      throw new Error(`Invalid certificate type.`);
+    }
+    if (!opts.noPassphrase) {
+      instance.cert.passphrase = this.lorem.word();
+      if (type === 'pem') {
+        const key = instance.certKey as ICertificateData;
+        key.passphrase = this.lorem.word();
+      }
+    }
+    
+    return instance.toJSON();
+  }
+
+  /**
+   * Creates a list of ClientCertificate objects that are used to create a new certificates.
+   * 
+   * @param size The number of certificates to generate.
+   * @param opts Create options
+   */
+   certificates(size = 15, opts: CertificateCreateInit = {}): HttpCertificate[] {
+    const result: HttpCertificate[] = [];
+    for (let i = 0; i < size; i++) {
+      result[result.length] = this.certificate(opts);
+    }
+    return result;
+  }
+}

package/src/mocking/lib/HostRules.ts

@@ -0,0 +1,42 @@
+import { Lorem, Types, Internet, IDataMockInit } from '@pawel-up/data-mock';
+import { IHostRule } from '../../models/HostRule.js';
+
+export class HostRules {
+  types: Types;
+  lorem: Lorem;
+  internet: Internet;
+
+  constructor(init: IDataMockInit = {}) {
+    this.types = new Types(init.seed);
+    this.lorem = new Lorem(init);
+    this.internet = new Internet(init);
+  }
+
+  /**
+   * Generates random host rule data object.
+   */
+  rule(): IHostRule {
+    const result: IHostRule = {
+      key: this.types.uuid(),
+      from: this.internet.uri(),
+      to: this.internet.uri(),
+      enabled: this.types.boolean(),
+      comment: this.lorem.paragraph(),
+    };
+    return result;
+  }
+
+  /**
+   * Generates a list of host rules.
+   *
+   * @param size Number of items to generate. Default to 25.
+   * @return List of datastore entries.
+   */
+  rules(size = 25): IHostRule[] {
+    const result = [];
+    for (let i = 0; i < size; i++) {
+      result.push(this.rule());
+    }
+    return result;
+  }
+}

package/src/mocking/lib/Request.ts

@@ -1,7 +1,7 @@
 import { Http, Types, Lorem, Time, IDataMockInit, IHttpRequestInit } from '@pawel-up/data-mock';
 // import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
 import { IHttpRequest, Kind as HttpRequestKind } from '../../models/HttpRequest.js';
-import { IRequest, Kind as RequestKind } from '../../models/Request.js';
+import { IRequest, Kind as RequestKind, Request as RequestModel } from '../../models/Request.js';
 import { ISentRequest } from '../../models/SentRequest.js';
 import { IRequestLog, Kind as RequestLogKind } from '../../models/RequestLog.js';
 import { IResponseInit, Response } from './Response.js';
@@ -45,14 +45,17 @@ export class Request {
   }
 
   request(init?: IHttpRequestInit): IRequest {
-    return {
+    const schema = {
       kind: RequestKind,
       expects: this.httpRequest(init),
       info: {
         name: this.lorem.words(2),
         description: this.lorem.paragraph(),
       },
-    }
+      created: this.time.timestamp(),
+    };
+    const instance = new RequestModel(schema);
+    return instance.toJSON();
   }
 
   httpRequest(init?: IHttpRequestInit): IHttpRequest {

package/src/mocking/lib/Url.ts

@@ -1,31 +1,38 @@
-import { IDataMockInit, Internet, Types } from "@pawel-up/data-mock";
-import { IUrl } from "../../models/Url.js";
+import { Internet, Types, Time, IDataMockInit } from '@pawel-up/data-mock';
+import { IUrl } from '../../models/Url.js';
 
-/**
- * Mocks the URL data.
- */
 export class Url {
   types: Types;
   internet: Internet;
-  
+  time: Time;
+
   constructor(init: IDataMockInit={}) {
     this.types = new Types(init.seed);
     this.internet = new Internet(init);
+    this.time = new Time(init);
   }
 
+  /**
+   * Generates a single ARC URL model item.
+   */
   url(): IUrl {
-    const date = this.types.datetime();
+    const url = this.internet.uri();
+    const time = this.types.datetime().getTime();
     const result: IUrl = {
-      key: this.internet.uri(),
-      cnt: this.types.number({ min: 0 }),
-      time: date.getTime(),
+      time,
+      cnt: this.types.number({ min: 100, max: 1000 }),
+      key: url,
+      midnight: this.time.midnight(time),
     };
-    date.setHours(0, 0, 0, 0);
-    result.midnight = date.getTime();
     return result;
   }
 
-  urls(size=25): IUrl[] {
+  /**
+   * Generates list of ARC URL models.
+   *
+   * @returns List of datastore entries.
+   */
+  urls(size = 25): IUrl[] {
     const result: IUrl[] = [];
     for (let i = 0; i < size; i++) {
       result.push(this.url());

package/src/models/ClientCertificate.ts

@@ -71,7 +71,7 @@ export interface IPemCertificate extends ICertificate {
   certKey: ICertificateData;
 }
 
-export type HttpCertificate = IP12Certificate | IPemCertificate;
+export type HttpCertificate = IP12Certificate | IPemCertificate | ICertificate;
 
 export interface IPemCreateOptions {
   type: 'p12';
@@ -128,7 +128,7 @@ export class Certificate {
    * Timestamp when the certificate was inserted into the data store.
    * Required when returning a result. Auto-generated when inserting, if missing.
    */
-  created?: number;
+  created = 0;
   /**
    * Certificate type. Either `p12` or `pem`.
    */
@@ -162,6 +162,7 @@ export class Certificate {
       key: v4(),
       name,
       type: 'pem',
+      created: Date.now(),
     };
     if (keyPassphrase) {
       init.certKey.passphrase = keyPassphrase;
@@ -185,6 +186,7 @@ export class Certificate {
       key: v4(),
       name,
       type: 'p12',
+      created: Date.now(),
     };
     if (passphrase) {
       init.cert.passphrase = passphrase;
@@ -224,6 +226,7 @@ export class Certificate {
         key: _id,
         name,
         type: 'p12',
+        created,
       };
       return new Certificate(init);
     }
@@ -231,16 +234,15 @@ export class Certificate {
   }
 
   constructor(certificate: HttpCertificate) {
-    const { type, cert, key = v4(), name = '', created } = certificate;
+    const { type, cert, key = v4(), name = '', created = Date.now() } = certificate;
     this.key = key;
     this.name = name;
     this.type = type;
     this.cert = Certificate.fromStore(cert);
-    if (typeof created === 'number') {
-      this.created = created;
-    }
+    this.created = created;
     if (type === 'pem') {
-      this.certKey = Certificate.fromStore(certificate.certKey);
+      const typed = certificate as IPemCertificate;
+      this.certKey = Certificate.fromStore(typed.certKey);
     }
   }
 
@@ -288,12 +290,13 @@ export class Certificate {
   }
 
   toJSON(): HttpCertificate {
-    const result: IP12Certificate = {
+    const result: HttpCertificate = {
       kind: Kind,
       key: this.key,
       cert: Certificate.toStore(this.cert),
       name: this.name,
-      type: 'p12',
+      type: this.type,
+      created: this.created,
     };
 
     if (this.type === 'pem' && this.certKey) {

package/src/models/arc/ArcHttpRequest.ts

@@ -1,5 +1,4 @@
 import { IRequest, Request } from "../Request.js";
-import v4 from "../../lib/uuid.js";
 import { HttpRequest, IHttpRequest } from "../HttpRequest.js";
 import { Thing } from "../Thing.js";
 
@@ -15,6 +14,7 @@ export class ArcHttpRequest extends Request {
 
   /**
    * The identifier of the request.
+   * The key is related to the `created` property. It is the `new Date(created).toJSON()` value.
    */
   key = '';
 
@@ -24,9 +24,10 @@ export class ArcHttpRequest extends Request {
    * @param url The Request URL. This is required.
    */
   static fromUrl(url: string): ArcHttpRequest {
-    const now: number = Date.now();
+    const d = new Date();
+    const now: number = d.getTime();
     const request = new ArcHttpRequest({
-      key: v4(),
+      key: d.toJSON(),
       kind: Kind,
       created: now,
       updated: now,
@@ -42,9 +43,10 @@ export class ArcHttpRequest extends Request {
    * @param name The Request name.
    */
   static fromName(name: string): ArcHttpRequest {
-    const now: number = Date.now();
+    const d = new Date();
+    const now: number = d.getTime();
     const request = new ArcHttpRequest({
-      key: v4(),
+      key: d.toJSON(),
       kind: Kind,
       created: now,
       updated: now,
@@ -60,9 +62,10 @@ export class ArcHttpRequest extends Request {
    * @param info The request data.
    */
   static fromHttpRequest(info: IHttpRequest): ArcHttpRequest {
-    const now: number = Date.now();
+    const d = new Date();
+    const now: number = d.getTime();
     const request = new ArcHttpRequest({
-      key: v4(),
+      key: d.toJSON(),
       kind: Kind,
       created: now,
       updated: now,
@@ -76,11 +79,13 @@ export class ArcHttpRequest extends Request {
    * Creates a request for a schema of a Request.
    */
   static fromRequest(request: IArcHttpRequest): ArcHttpRequest {
-    const key = v4();
+    const d = new Date(request.created || Date.now());
+    const now: number = d.getTime();
     const init: IArcHttpRequest = { 
       ...request, 
-      key, 
-      kind: Kind 
+      key: d.toJSON(), 
+      kind: Kind,
+      created: now,
     };
     const result = new ArcHttpRequest(init);
     return result;
@@ -96,7 +101,10 @@ export class ArcHttpRequest extends Request {
       init = input;
     }
     if (init) {
-      this.key = init.key || v4();
+      this.key = init.key;
+    }
+    if (!this.key) {
+      this.key = new Date(this.created || Date.now()).toJSON();
     }
     this.kind = Kind;
   }
@@ -105,7 +113,7 @@ export class ArcHttpRequest extends Request {
     super.new(init);
     
     const { key } = init;
-    this.key = key || v4();
+    this.key = key || new Date(init.created || Date.now()).toJSON();
     this.kind = Kind;
   }
 

package/src/models/arc/ArcProject.ts

@@ -951,12 +951,15 @@ export class ArcProject extends ArcProjectParent {
         init.kind = ArcProjectKind;
       }
     } else {
+      const now = Date.now();
       init = {
         kind: ArcProjectKind,
         key: v4(),
         definitions: {},
         items: [],
         info: Thing.fromName('').toJSON(),
+        created: now,
+        updated: now,
       }
     }
     this.new(init);
@@ -1001,6 +1004,8 @@ export class ArcProject extends ArcProjectParent {
       definitions: {},
       items: [],
       info: this.info.toJSON(),
+      created: this.created,
+      updated: this.updated,
     };
     if (Array.isArray(this.definitions.requests) && this.definitions.requests.length) {
       result.definitions.requests = this.definitions.requests.map(i => i.toJSON());