@api-client/core 0.6.18 → 0.6.22

package/src/events/models/ClientCertificateEvents.ts

@@ -6,11 +6,11 @@ export class ClientCertificateEvents {
   /**
    * Dispatches an event handled by the data store to read the client certificate.
    *
-   * @param target A node on which to dispatch the event.
    * @param id The id 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(target: EventTarget, id: string): Promise<HttpCertificate | undefined> {
+  static async read(id: string, target: EventTarget = window): Promise<HttpCertificate | undefined> {
     const e = new ContextReadEvent<HttpCertificate>(ModelEventTypes.ClientCertificate.read, id);
     target.dispatchEvent(e);
     return e.detail.result;
@@ -19,11 +19,11 @@ export class ClientCertificateEvents {
   /**
    * Dispatches an event to list the client certificates data.
    *
-   * @param target A node on which to dispatch the event.
    * @param opts Query options.
+   * @param target A node on which to dispatch the event.
    * @returns The list result.
    */
-  static async list(target: EventTarget, opts?: ContextListOptions): Promise<ContextListResult<HttpCertificate> | undefined> {
+  static async list(opts?: ContextListOptions, target: EventTarget = window): Promise<ContextListResult<HttpCertificate> | undefined> {
     const e = new ContextListEvent<HttpCertificate>(ModelEventTypes.ClientCertificate.list, opts);
     target.dispatchEvent(e);
     return e.detail.result;
@@ -32,11 +32,11 @@ export class ClientCertificateEvents {
   /**
    * Dispatches an event handled by the data store to delete a client certificate
    *
-   * @param target A node on which to dispatch the event.
    * @param id The id 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(target: EventTarget, id: string): Promise<ContextDeleteRecord | undefined> {
+  static async delete(id: string, target: EventTarget = window): Promise<ContextDeleteRecord | undefined> {
     const e = new ContextDeleteEvent(ModelEventTypes.ClientCertificate.delete, id, undefined);
     target.dispatchEvent(e);
     return e.detail.result;
@@ -45,11 +45,11 @@ export class ClientCertificateEvents {
   /**
    * Dispatches an event handled by the data store to insert a new client certificate.
    *
-   * @param target A node on which to dispatch the event.
    * @param item The certificate object.
+   * @param target A node on which to dispatch the event.
    * @returns Promise resolved to the change record
    */
-  static async insert(target: EventTarget, item: ICertificateCreateOptions): Promise<ContextChangeRecord<HttpCertificate> | undefined> {
+  static async insert(item: ICertificateCreateOptions, target: EventTarget = window): Promise<ContextChangeRecord<HttpCertificate> | undefined> {
     const e = new ContextUpdateEvent<ICertificateCreateOptions, HttpCertificate>(ModelEventTypes.ClientCertificate.insert, { item, });
     target.dispatchEvent(e);
     return e.detail.result;
@@ -67,7 +67,7 @@ class StateEvents {
    * @param target A node on which to dispatch the event.
    * @param record Change record
    */
-  static update(target: EventTarget, record: ContextChangeRecord<HttpCertificate>): void {
+  static update(record: ContextChangeRecord<HttpCertificate>, target: EventTarget = window): void {
     const e = new ContextStateUpdateEvent<HttpCertificate>(ModelEventTypes.ClientCertificate.State.update, record);
     target.dispatchEvent(e);
   }
@@ -75,10 +75,10 @@ class StateEvents {
   /**
    * Dispatches an event after a client certificate was deleted
    *
-   * @param target A node on which to dispatch the event.
    * @param record The context store delete record
+   * @param target A node on which to dispatch the event.
    */
-  static delete(target: EventTarget, record: ContextDeleteRecord): void {
+  static delete(record: ContextDeleteRecord, target: EventTarget = window): void {
     const e = new ContextStateDeleteEvent(ModelEventTypes.ClientCertificate.State.delete, record);
     target.dispatchEvent(e);
   }

package/src/events/process/ProcessEvents.ts

@@ -21,11 +21,11 @@ export class ProcessEvents {
    * in the background. The side effect of the event is the UI showing a process
    * indicator.
    * 
-   * @param target A node on which to dispatch the event.
    * @param pid The id of the process. The same id has to be passed to the stop event.
    * @param message Optional message rendered in the UI.
+   * @param target A node on which to dispatch the event.
    */
-  static loadingStart(target: EventTarget, pid: string, message: string): void {
+  static loadingStart(pid: string, message: string, target: EventTarget = window): void {
     const detail: IProcessStartDetail = { pid, message };
     const e = new CustomEvent(ProcessEventTypes.loadingStart, {
       cancelable: true,
@@ -40,10 +40,10 @@ export class ProcessEvents {
    * An event to be dispatched when the application has finished a long running process
    * in the background.
    * 
-   * @param target A node on which to dispatch the event.
    * @param pid The id of the process. The same id has to be passed to the stop event.
+   * @param target A node on which to dispatch the event.
    */
-  static loadingStop(target: EventTarget, pid: string): void {
+  static loadingStop(pid: string, target: EventTarget = window): void {
     const detail: IProcessStopDetail = { pid };
     const e = new CustomEvent(ProcessEventTypes.loadingStop, {
       cancelable: true,
@@ -58,12 +58,12 @@ export class ProcessEvents {
    * An event to be dispatched when the application has finished a long running process
    * in the background with an error.
    * 
-   * @param target A node on which to dispatch the event.
    * @param pid The id of the process used to start it.
    * @param message The message to be rendered to the user.
    * @param error The error object caused the event. Optional.
+   * @param target A node on which to dispatch the event.
    */
-  static loadingError(target: EventTarget, pid: string, message: string, error?: Error): void {
+  static loadingError(pid: string, message: string, error?: Error, target: EventTarget = window): void {
     const detail: IProcessErrorDetail = { pid, message, error };
     const e = new CustomEvent(ProcessEventTypes.loadingError, {
       cancelable: true,

package/src/events/reporting/ReportingEvents.ts

@@ -10,12 +10,12 @@ export class ReportingEvents {
   /**
    * Dispatches the general error event for UI logging purposes.
    * 
-   * @param target A node on which to dispatch the event
    * @param description The error description
    * @param error Optional original error object that has caused this event
    * @param component Optional component name.
+   * @param target A node on which to dispatch the event
    */
-  static error(target: EventTarget, description: string, error?: Error, component?: string): void {
+  static error(description: string, error?: Error, component?: string, target: EventTarget = window): void {
     const detail: IReportingErrorDetail = { error, description, component };
     const e = new CustomEvent(ReportingEventTypes.error, {
       bubbles: true,

package/src/events/telemetry/TelemetryEvents.ts

@@ -48,7 +48,7 @@ export class TelemetryEvents {
    * @param screenName The screen name
    * @param info Analytics base configuration
    */
-  static view(target: EventTarget, screenName: string, info: ITelemetryDetail = {}): void {
+  static view(screenName: string, target: EventTarget = window, info: ITelemetryDetail = {}): void {
     const detail: ITelemetryScreenViewDetail = {
       ...info, screenName,
     };
@@ -66,7 +66,7 @@ export class TelemetryEvents {
    * @param target A node on which to dispatch the event
    * @param detail The event configuration
    */
-  static event(target: EventTarget, detail: ITelemetryEventDetail): void {
+  static event(detail: ITelemetryEventDetail, target: EventTarget = window): void {
     const e = new CustomEvent(TelemetryEventTypes.event, {
       bubbles: true,
       composed: true,
@@ -83,7 +83,7 @@ export class TelemetryEvents {
    * @param fatal Whether the exception was fatal to the application
    * @param info Analytics base configuration
    */
-  static exception(target: EventTarget, description: string, fatal?: boolean, info: ITelemetryDetail = {}): void {
+  static exception(description: string, fatal?: boolean, target: EventTarget = window, info: ITelemetryDetail = {}): void {
     const detail: ITelemetryExceptionDetail = { ...info, description, fatal };
     const e = new CustomEvent(TelemetryEventTypes.exception, {
       bubbles: true,
@@ -102,7 +102,7 @@ export class TelemetryEvents {
    * @param url The share url
    * @param info Analytics base configuration
    */
-  static social(target: EventTarget, network: string, action: string, url: string, info: ITelemetryDetail = {}): void {
+  static social(network: string, action: string, url: string, target: EventTarget = window, info: ITelemetryDetail = {}): void {
     const detail: ITelemetrySocialDetail = { ...info, network, action, target: url };
     const e = new CustomEvent(TelemetryEventTypes.social, {
       bubbles: true,
@@ -122,7 +122,7 @@ export class TelemetryEvents {
    * @param label The timing label
    * @param info Analytics base configuration
    */
-  static timing(target: EventTarget, category: string, variable: string, value: number, label?: string, info: ITelemetryDetail = {}): void {
+  static timing(category: string, variable: string, value: number, label?: string, target: EventTarget = window, info: ITelemetryDetail = {}): void {
     const detail: ITelemetryTimingDetail = { ...info, category, variable, value, label };
     const e = new CustomEvent(TelemetryEventTypes.timing, {
       bubbles: true,
@@ -145,7 +145,7 @@ class StateEvents {
    * 
    * @param target The node on which to dispatch the event.
    */
-  static set(target: EventTarget): void {
+  static set(target: EventTarget = window): void {
     const e = new Event(TelemetryEventTypes.State.set, {
       composed: true,
       cancelable: true,

package/src/events/transport/TransportEvents.ts

@@ -39,7 +39,7 @@ export const TransportEvent = Object.freeze({
      * @param config Optional request configuration.
      * @returns The execution log or `undefined` when the event was not handled.
      */
-    send: async (target: EventTarget, request: IHttpRequest, authorization?: IRequestAuthorization[], config?: IRequestBaseConfig): Promise<IRequestLog | undefined> => {
+    send: async (request: IHttpRequest, authorization?: IRequestAuthorization[], config?: IRequestBaseConfig, target: EventTarget = window): Promise<IRequestLog | undefined> => {
       const e = new ContextEvent<ICoreRequestDetail, IRequestLog>(TransportEventTypes.Core.send, {
         request,
         authorization,
@@ -62,7 +62,7 @@ export const TransportEvent = Object.freeze({
      * @param init Optional request init options compatible with the Fetch API.
      * @returns Compatible with the Fetch API Response object or `undefined` when the event was not handled.
      */
-    send: async (target: EventTarget, request: IHttpRequest, init?: RequestInit): Promise<Response | undefined> => {
+    send: async (request: IHttpRequest, init?: RequestInit, target: EventTarget = window): Promise<Response | undefined> => {
       const e = new ContextEvent<IHttpRequestDetail, Response>(TransportEventTypes.Http.send, {
         request,
         init,
@@ -82,7 +82,7 @@ export const TransportEvent = Object.freeze({
      * @param opts The project execution options.
      * @returns 
      */
-    send: async (target: EventTarget, project: HttpProject | string, opts: IProjectRunnerOptions): Promise<IProjectExecutionLog | undefined> => {
+    send: async (project: HttpProject | string, opts: IProjectRunnerOptions, target: EventTarget = window): Promise<IProjectExecutionLog | undefined> => {
       const e = new ContextEvent<IProjectRequestDetail, IProjectExecutionLog>(TransportEventTypes.Project.send, {
         project,
         opts,

package/src/mocking/lib/Url.ts

@@ -16,7 +16,7 @@ export class Url {
   url(): IUrl {
     const date = this.types.datetime();
     const result: IUrl = {
-      url: this.internet.uri(),
+      key: this.internet.uri(),
       cnt: this.types.number({ min: 0 }),
       time: date.getTime(),
     };

package/src/models/AuthorizationData.ts

@@ -1,4 +1,7 @@
+import v4 from '../lib/uuid.js';
+
 export interface IAuthorizationData {
+  key: string;
   username?: string;
   password?: string;
   domain?: string;
@@ -12,6 +15,7 @@ export interface IAuthorizationData {
  * Each entry represent a Basic or NTLM authorization.
  */
 export class AuthorizationData {
+  key = '';
   username?: string;
   password?: string;
   domain?: string;
@@ -26,7 +30,9 @@ export class AuthorizationData {
     } else if (typeof input === 'object') {
       init = input;
     } else {
-      init = {};
+      init = {
+        key: v4(),
+      };
     }
     this.new(init);
   }
@@ -37,14 +43,16 @@ export class AuthorizationData {
    * Note, this throws an error when the provider is not an API Client provider object.
    */
   new(init: IAuthorizationData): void {
-    const { username, password, domain } = init;
+    const { username, password, domain, key = v4() } = init;
     this.username = username;
     this.password = password;
     this.domain = domain;
+    this.key = key;
   }
 
   toJSON(): IAuthorizationData {
     const result:IAuthorizationData = {
+      key: this.key,
     };
     if (this.username) {
       result.username = this.username;

package/src/models/ClientCertificate.ts

@@ -257,9 +257,9 @@ export class Certificate {
       type: 'p12',
     };
 
-    if (this.type === 'pem') {
+    if (this.type === 'pem' && this.certKey) {
       const typed = (result as unknown) as IPemCertificate;
-      typed.certKey = this.toStore(this.certKey!);
+      typed.certKey = this.toStore(this.certKey);
     }
 
     return result;

package/src/models/HostRule.ts

@@ -1,9 +1,16 @@
+import v4 from '../lib/uuid.js';
+
 export const Kind = 'Core#HostRule';
 
 /**
  * API Client host rule definition.
  */
 export interface IHostRule {
+  /**
+   * The key of the rule.
+   */
+  key: string;
+
   kind?: typeof Kind;
   /**
    * The from rule (may contain asterisks)
@@ -24,6 +31,11 @@ export interface IHostRule {
 }
 
 export class HostRule {
+  /**
+   * The key of the rule.
+   */
+  key = '';
+
   kind = Kind;
   /**
    * The from rule (may contain asterisks)
@@ -44,6 +56,7 @@ export class HostRule {
 
   static fromValues(from: string, to: string ): HostRule {
     const result = new HostRule({
+      key: v4(),
       kind: Kind,
       from,
       to,
@@ -63,6 +76,7 @@ export class HostRule {
       init = input;
     } else {
       init = {
+        key: v4(),
         kind: Kind,
         from: '',
         to: '',
@@ -80,8 +94,9 @@ export class HostRule {
     if (!HostRule.isHostRule(init)) {
       throw new Error(`Not a HostRule.`);
     }
-    const { from='', to='', enabled, comment } = init;
+    const { from='', to='', enabled, comment, key = v4() } = init;
     this.kind = Kind;
+    this.key = key;
     this.from = from;
     this.to = to;
     this.enabled = enabled;
@@ -102,6 +117,7 @@ export class HostRule {
   toJSON(): IHostRule {
     const result: IHostRule = {
       kind: Kind,
+      key: this.key,
       from : this.from,
       to : this.to,
     };

package/src/models/HttpProject.ts

@@ -1,3 +1,6 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-this-alias */
 import { ProjectParent } from './ProjectParent.js';
 import { IProjectDefinitionProperty } from './ProjectDefinitionProperty.js';
 import { Environment, IEnvironment, Kind as EnvironmentKind } from './Environment.js';

package/src/models/Url.ts

@@ -9,9 +9,9 @@ export interface IUrl {
    */
   time: number;
   /**
-   * The request URL stored in the history.
+   * The request URL stored in the history. This is also the store key.
    */
-  url: string;
+  key: string;
   /**
    * A timestamp of the midnight that corresponds to the `time` property.
    */
@@ -30,11 +30,11 @@ export class Url {
   /**
    * Last use timestamp.
    */
-  time:number = Date.now();
+  time: number = Date.now();
   /**
-   * The request URL stored in the history.
+   * The request URL stored in the history. This is also the store key.
    */
-  url = '';
+  key = '';
   /**
    * A timestamp of the midnight that corresponds to the `time` property.
    */
@@ -43,7 +43,7 @@ export class Url {
   /**
    * @param input The URL definition used to restore the state.
    */
-  constructor(input: string|IUrl) {
+  constructor(input: string | IUrl) {
     let init: IUrl;
     if (typeof input === 'string') {
       init = JSON.parse(input);
@@ -53,7 +53,7 @@ export class Url {
       init = {
         cnt: 0,
         time: Date.now(),
-        url: '',
+        key: '',
       };
     }
     this.new(init);
@@ -63,8 +63,8 @@ export class Url {
    * Creates a new URL clearing anything that is so far defined.
    */
   new(init: IUrl): void {
-    const { url='', cnt=0, time = Date.now(), midnight } = init;
-    this.url = url;
+    const { key = '', cnt = 0, time = Date.now(), midnight } = init;
+    this.key = key;
     this.cnt = cnt;
     this.time = time;
     if (midnight) {
@@ -78,7 +78,7 @@ export class Url {
 
   toJSON(): IUrl {
     const result: IUrl = {
-      url: this.url,
+      key: this.key,
       cnt: this.cnt,
       time: this.time,
       midnight: this.midnight,

package/src/models/arc/ArcHttpRequest.ts

@@ -0,0 +1,121 @@
+import { IRequest, Request } from "../Request.js";
+import v4 from "../../lib/uuid.js";
+import { HttpRequest, IHttpRequest } from "../HttpRequest.js";
+import { Thing } from "../Thing.js";
+
+export const Kind = 'Arc#ArcRequest';
+
+export interface IArcHttpRequest extends IRequest {
+  kind: typeof Kind;
+  key: string;
+}
+
+export class ArcHttpRequest extends Request {
+  kind = Kind;
+
+  /**
+   * The identifier of the request.
+   */
+  key = '';
+
+  /**
+   * Creates a project request from an URL.
+   * 
+   * @param url The Request URL. This is required.
+   */
+  static fromUrl(url: string): ArcHttpRequest {
+    const now: number = Date.now();
+    const request = new ArcHttpRequest({
+      key: v4(),
+      kind: Kind,
+      created: now,
+      updated: now,
+      expects: HttpRequest.fromBaseValues({ url, method: 'GET' }).toJSON(),
+      info: Thing.fromName(url).toJSON(),
+    });
+    return request;
+  }
+
+  /**
+   * Creates a project request from a name.
+   * 
+   * @param name The Request name.
+   */
+  static fromName(name: string): ArcHttpRequest {
+    const now: number = Date.now();
+    const request = new ArcHttpRequest({
+      key: v4(),
+      kind: Kind,
+      created: now,
+      updated: now,
+      expects: new HttpRequest().toJSON(),
+      info: Thing.fromName(name).toJSON(),
+    });
+    return request;
+  }
+
+  /**
+   * Creates a request from an HttpRequest definition.
+   * 
+   * @param info The request data.
+   */
+  static fromHttpRequest(info: IHttpRequest): ArcHttpRequest {
+    const now: number = Date.now();
+    const request = new ArcHttpRequest({
+      key: v4(),
+      kind: Kind,
+      created: now,
+      updated: now,
+      expects: HttpRequest.fromBaseValues({ method: info.method, url: info.url, headers: info.headers, payload: info.payload }).toJSON(),
+      info: Thing.fromName(info.url).toJSON(),
+    });
+    return request;
+  }
+
+  /**
+   * Creates a request for a schema of a Request.
+   */
+  static fromRequest(request: IArcHttpRequest): ArcHttpRequest {
+    const key = v4();
+    const init: IArcHttpRequest = { 
+      ...request, 
+      key, 
+      kind: Kind 
+    };
+    const result = new ArcHttpRequest(init);
+    return result;
+  }
+
+  constructor(input?: string | IArcHttpRequest) {
+    super(input);
+
+    let init: IArcHttpRequest | undefined;
+    if (typeof input === 'string') {
+      init = JSON.parse(input);
+    } else if (typeof input === 'object') {
+      init = input;
+    }
+    if (init) {
+      this.key = init.key || v4();
+    }
+    this.kind = Kind;
+  }
+
+  new(init: IArcHttpRequest): void {
+    super.new(init);
+    
+    const { key } = init;
+    this.key = key || v4();
+    this.kind = Kind;
+  }
+
+  toJSON(): IArcHttpRequest {
+    const request = super.toJSON();
+    const result: IArcHttpRequest = { 
+      ...request, 
+      key: this.key, 
+      kind: Kind 
+    };
+    return result;
+  }
+}