@api-client/core 0.3.11 → 0.4.1

package/src/models/RequestLog.ts

@@ -1,17 +1,17 @@
 import { IResponseRedirect, ResponseRedirect  } from './ResponseRedirect.js';
 import { ISentRequest, SentRequest } from './SentRequest.js';
 import { IErrorResponse, ErrorResponse } from './ErrorResponse.js';
-import { IArcResponse, ArcResponse } from './ArcResponse.js';
+import { IResponse, Response } from './Response.js';
 import { IRequestsSize, RequestsSize } from './RequestsSize.js';
 import { ResponseRedirect as LegacyRedirect } from './legacy/request/ArcResponse.js';
 
-export const Kind = 'ARC#ResponseLog';
+export const Kind = 'Core#ResponseLog';
 
 /**
  * Describes a request / response pair associated with a request.
  */
 export interface IRequestLog {
-  kind: 'ARC#ResponseLog';
+  kind: typeof Kind;
   /**
    * Describes an HTTP request sent by the transport.
    */
@@ -19,7 +19,7 @@ export interface IRequestLog {
   /**
    * The last response made with this request, if any.
    */
-  response?: IArcResponse | IErrorResponse;
+  response?: IResponse | IErrorResponse;
   /**
    * The list of redirects, if any.
    */
@@ -28,6 +28,10 @@ export interface IRequestLog {
    * Request and response size. Some HTTP clients may not give this information.
    */
   size?: IRequestsSize;
+  /**
+   * Optional request ID defined on an HTTP project that triggered this log.
+   */
+  requestId?: string;
 }
 
 /**
@@ -42,7 +46,7 @@ export class RequestLog {
   /**
    * The last response made with this request, if any.
    */
-  response?: ArcResponse | ErrorResponse;
+  response?: Response | ErrorResponse;
   /**
    * The list of redirects, if any.
    */
@@ -51,6 +55,10 @@ export class RequestLog {
    * Request and response size. Some HTTP clients may not give this information.
    */
   size?: RequestsSize;
+  /**
+   * Optional request ID defined on an HTTP project that triggered this log.
+   */
+  requestId?: string;
 
   static fromRequest(request: ISentRequest): RequestLog {
     return new RequestLog({
@@ -59,7 +67,7 @@ export class RequestLog {
     });
   }
 
-  static fromRequestResponse(request: ISentRequest, response: IArcResponse | IErrorResponse): RequestLog {
+  static fromRequestResponse(request: ISentRequest, response: IResponse | IErrorResponse): RequestLog {
     return new RequestLog({
       kind: Kind,
       request,
@@ -86,20 +94,18 @@ export class RequestLog {
 
   /**
    * Creates a new response clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the object is not an ARC response.
    */
   new(init: IRequestLog): void {
-    const { request, response, redirects, size } = init;
+    const { request, response, redirects, size, requestId } = init;
     this.kind = Kind;
     if (request) {
       this.request = new SentRequest(request);
     }
     if (response) {
-      if (ArcResponse.isErrorResponse(response)) {
+      if (Response.isErrorResponse(response)) {
         this.response = new ErrorResponse(response as IErrorResponse);
       } else {
-        this.response = new ArcResponse(response as IArcResponse);
+        this.response = new Response(response as IResponse);
       }
     } else {
       this.response = undefined;
@@ -114,6 +120,11 @@ export class RequestLog {
     } else {
       this.size = undefined;
     }
+    if (requestId) {
+      this.requestId = requestId;
+    } else {
+      this.requestId = undefined;
+    }
   }
 
   toJSON(): IRequestLog {
@@ -132,6 +143,9 @@ export class RequestLog {
     if (this.response) {
       result.response = this.response.toJSON();
     }
+    if (this.requestId) {
+      result.requestId = this.requestId;
+    }
     return result;
   }
 

package/src/models/RequestTime.ts

@@ -1,10 +1,10 @@
-export const Kind = 'ARC#RequestTime';
+export const Kind = 'Core#RequestTime';
 
 /**
- * Schema definition for ARC request timings. This is mostly consistent with HAR timings.
+ * Schema definition for API Client request timings. This is mostly consistent with HAR timings.
  */
 export interface IRequestTime {
-  kind?: 'ARC#RequestTime';
+  kind?: typeof Kind;
   connect: number;
   receive: number;
   send: number;
@@ -48,9 +48,7 @@ export class RequestTime {
   }
 
   /**
-   * Creates a new thing clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the server is not an ARC thing.
+   * Creates a new timing clearing anything that is so far defined.
    */
   new(init: IRequestTime): void {
     const { connect=-1, receive=-1, send=-1, wait=-1, blocked=-1, dns=-1, ssl=-1 } = init;

package/src/models/RequestUiMeta.ts

@@ -2,7 +2,7 @@ import { IProperty, Property } from './Property.js';
 import { IMultipartBody } from '../lib/transformers/PayloadSerializer.js';
 import { RequestUiMeta as LegacyRequestUiMeta } from './legacy/request/ArcRequest.js';
 
-export const Kind = 'ARC#RequestUiMeta';
+export const Kind = 'Core#RequestUiMeta';
 
 /**
  * URL editor meta data.
@@ -41,7 +41,7 @@ export interface IAuthMeta {
 
 export interface IActionsMeta {
   /**
-   * The index of the selected arc actions view.
+   * The index of the selected API Client actions view.
    */
   selected?: number;
 }
@@ -64,7 +64,7 @@ export interface IResponseUiMeta {
  */
 export interface IBodyMetaModel {
   /**
-   * The id of the editor. Each editor in ARC has own id.
+   * The id of the editor. Each editor in API Client has own id.
    */
   type: string;
   /**
@@ -124,7 +124,7 @@ export interface IRequestUiMeta {
    */
   authorization?: IAuthMeta;
   /**
-   * ARC request actions editor UI config.
+   * API Client request actions editor UI config.
    */
   actions?: IActionsMeta;
   /**
@@ -156,7 +156,7 @@ export class RequestUiMeta {
    */
   authorization?: IAuthMeta;
   /**
-   * ARC request actions editor UI config.
+   * API Client request actions editor UI config.
    */
   actions?: IActionsMeta;
   /**

package/src/models/RequestsSize.ts

@@ -1,4 +1,4 @@
-export const Kind = 'ARC#ResponseSize';
+export const Kind = 'Core#ResponseSize';
 
 export interface IRequestsSize {
   kind?: typeof Kind;
@@ -44,8 +44,6 @@ export class RequestsSize {
 
   /**
    * Creates a new response size clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the object is not an ARC response size.
    */
   new(init: IRequestsSize): void {
     const { request, response } = init;

package/src/models/{ArcResponse.ts → Response.ts}

@@ -11,7 +11,7 @@ export { Kind };
 /**
  * An HTTP response object.
  */
-export interface IArcResponse extends IHttpResponse {
+export interface IResponse extends IHttpResponse {
   /**
    * The request timings. 
    * Some HTTP clients may not give this information.
@@ -27,7 +27,7 @@ export interface IArcResponse extends IHttpResponse {
   auth?: IResponseAuthorization;
 }
 
-export class ArcResponse extends HttpResponse {
+export class Response extends HttpResponse {
   /**
    * The request timings. 
    * Some HTTP clients may not give this information.
@@ -42,8 +42,8 @@ export class ArcResponse extends HttpResponse {
    */
   auth?: ResponseAuthorization;
 
-  static fromValues(status: number, statusText?: string, headers?: string): ArcResponse {
-    return new ArcResponse({
+  static fromValues(status: number, statusText?: string, headers?: string): Response {
+    return new Response({
       kind: Kind,
       status,
       statusText,
@@ -52,8 +52,8 @@ export class ArcResponse extends HttpResponse {
     });
   }
 
-  static async fromLegacy(input: LegacyResponse): Promise<ArcResponse> {
-    const init: IArcResponse = {
+  static async fromLegacy(input: LegacyResponse): Promise<Response> {
+    const init: IResponse = {
       kind: Kind,
       status: input.status || 0,
       loadingTime: input.loadingTime || 0,
@@ -83,15 +83,15 @@ export class ArcResponse extends HttpResponse {
     if (input.timings) {
       init.timings = new RequestTime(input.timings).toJSON();
     }
-    return new ArcResponse(init);
+    return new Response(init);
   }
 
   /**
    * @param input The response definition used to restore the state.
    */
-  constructor(input?: string|IArcResponse) {
+  constructor(input?: string|IResponse) {
     super();
-    let init: IArcResponse;
+    let init: IResponse;
     if (typeof input === 'string') {
       init = JSON.parse(input);
     } else if (typeof input === 'object') {
@@ -108,10 +108,8 @@ export class ArcResponse extends HttpResponse {
 
   /**
    * Creates a new response clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the object is not an ARC response.
    */
-  new(init: IArcResponse): void {
+  new(init: IResponse): void {
     super.new(init);
     const { loadingTime=0, timings, auth } = init;
     this.loadingTime = loadingTime;
@@ -127,8 +125,8 @@ export class ArcResponse extends HttpResponse {
     }
   }
 
-  toJSON(): IArcResponse {
-    const response = super.toJSON() as IArcResponse;
+  toJSON(): IResponse {
+    const response = super.toJSON() as IResponse;
     response.loadingTime = this.loadingTime;
     if (this.timings) {
       response.timings = this.timings.toJSON();

package/src/models/ResponseAuthorization.ts

@@ -1,7 +1,7 @@
-export const Kind = 'ARC#ResponseAuthorization';
+export const Kind = 'Core#ResponseAuthorization';
 
 export interface IResponseAuthorization {
-  kind: 'ARC#ResponseAuthorization';
+  kind: typeof Kind;
   /**
    * The requested by the authorization server authentication method
    */
@@ -60,11 +60,11 @@ export class ResponseAuthorization {
   /**
    * Creates a new response authorization clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the object is not an ARC response authorization.
+   * Note, this throws an error when the object is not a response authorization.
    */
   new(init: IResponseAuthorization): void {
     if (!ResponseAuthorization.isResponseAuthorization(init)) {
-      throw new Error(`Not an ARC response authorization.`);
+      throw new Error(`Not a response authorization.`);
     }
     const { method, state, headers, challengeHeader } = init;
     this.kind = Kind;

package/src/models/ResponseRedirect.ts

@@ -2,13 +2,13 @@ import { IHttpResponse, HttpResponse, Kind as ResponseKind } from './HttpRespons
 import { IRequestTime, RequestTime } from './RequestTime.js';
 import { ResponseRedirect as LegacyRedirect } from './legacy/request/ArcResponse.js';
 
-export const Kind = 'ARC#HttpResponseRedirect';
+export const Kind = 'Core#HttpResponseRedirect';
 
 /**
  * An information about a redirect
  */
 export interface IResponseRedirect {
-  kind: string;
+  kind: typeof Kind;
   /**
    * Redirection response
    */
@@ -33,7 +33,7 @@ export interface IResponseRedirect {
 
 
 export class ResponseRedirect {
-  kind = Kind;
+  kind: typeof Kind = Kind;
   /**
    * Redirection response
    */
@@ -119,8 +119,6 @@ export class ResponseRedirect {
 
   /**
    * Creates a new redirect clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the object is not an ARC redirect.
    */
   new(init: IResponseRedirect): void {
     const { response, timings, startTime=0, endTime=0, url='', kind=Kind } = init;

package/src/models/RevisionInfo.ts

@@ -1,4 +1,4 @@
-export const Kind = 'ARC#Revision';
+export const Kind = 'Core#Revision';
 
 /**
  * The definition of a patch revision.

package/src/models/SentRequest.ts

@@ -21,7 +21,7 @@ export interface IBaseSentRequest extends IBaseHttpRequest {
 
 /**
  * An interface describing a request made by the HTTP transport.
- * Each transport used by ARC must return this structure in the response event.
+ * Each transport used by API Client must return this structure in the response event.
  * This is not a replacement for the editor request that also has to be returned.
  * 
  * Another difference is that this headers contains a final list of headers sent to the 
@@ -103,9 +103,7 @@ export class SentRequest extends HttpRequest {
   }
 
   /**
-   * Creates a new request clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the object is not an ARC request.
+   * Creates a new sent request clearing anything that is so far defined.
    */
   new(init: ISentRequest): void {
     super.new(init);

package/src/models/Server.ts

@@ -1,7 +1,7 @@
-export const Kind = 'ARC#Server';
+export const Kind = 'Core#Server';
 
 export interface IServer {
-  kind: 'ARC#Server';
+  kind: typeof Kind;
   /**
    * The base URI of the server.
    * 
@@ -85,11 +85,11 @@ export class Server {
   /**
    * Creates a new server clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the server is not an ARC server.
+   * Note, this throws an error when the server is not a server.
    */
   new(init: IServer): void {
     if (!Server.isServer(init)) {
-      throw new Error(`Not an ARC server.`);
+      throw new Error(`Not a server.`);
     }
     const { uri, description, protocol, basePath } = init;
     this.kind = Kind;

package/src/models/Thing.ts

@@ -1,4 +1,4 @@
-export const Kind = 'ARC#Thing';
+export const Kind = 'Core#Thing';
 
 /**
  * An interface describing a base metadata of a thing.
@@ -7,7 +7,7 @@ export declare interface IThing {
   /**
    * The data kind. The application ignores the input with an unknown `kind`, unless it can be determined from the context.
    */
-  kind?: 'ARC#Thing';
+  kind?: typeof Kind;
   /**
    * The name of the thing.
    */
@@ -68,11 +68,11 @@ export class Thing {
   /**
    * 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 a thing.
    */
   new(init: IThing): void {
     if (!Thing.isThing(init)) {
-      throw new Error(`Not an ARC thing.`);
+      throw new Error(`Not a thing.`);
     }
     const { description, name, version } = init;
     this.kind = Kind;

package/src/models/Url.ts

@@ -41,7 +41,7 @@ export class Url {
   midnight?: number;
 
   /**
-   * @param input The environment definition used to restore the state.
+   * @param input The URL definition used to restore the state.
    */
   constructor(input: string|IUrl) {
     let init: IUrl;
@@ -60,9 +60,7 @@ export class Url {
   }
 
   /**
-   * Creates a new environment clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the environment is not an ARC environment. 
+   * Creates a new URL clearing anything that is so far defined.
    */
   new(init: IUrl): void {
     const { url='', cnt=0, time = Date.now(), midnight } = init;

package/src/models/User.ts

@@ -62,9 +62,10 @@ export interface IUserPicture {
   data?: string;
 }
 
-export const Kind = 'ARC#User';
+export const Kind = 'Core#User';
 
 interface BaseUser {
+  kind: typeof Kind;
   /**
    * Data store key of the user.
    */

package/src/models/WebApi.ts

@@ -1,4 +1,4 @@
-export const Kind = 'ARC#WebApi';
+export const Kind = 'Core#WebApi';
 
 /**
  * @deprecated This was used in the old version of ARC.

package/src/models/WebApiIndex.ts

@@ -1,4 +1,4 @@
-export const Kind = 'ARC#WebApiIndex';
+export const Kind = 'Core#WebApiIndex';
 
 /**
  * @deprecated This was used in the old version of ARC.

package/src/models/Workspace.ts

@@ -2,7 +2,7 @@ import { AccessControlLevel } from "./User.js";
 import { IThing, Thing, Kind as ThingKind } from './Thing.js';
 import v4 from '../lib/uuid.js';
 
-export const Kind = 'ARC#Space';
+export const Kind = 'Core#Space';
 /**
  * A definition of the working space for users.
  * 
@@ -10,7 +10,7 @@ export const Kind = 'ARC#Space';
  * created by the system users, where they can store their projects and other data.
  */
 export interface IWorkspace {
-  kind: 'ARC#Space';
+  kind: typeof Kind;
   /**
    * The space identifier.
    */
@@ -75,7 +75,7 @@ export class Workspace {
    */
   projects: string[] = [];
   /**
-   * Only set when the object was created from the data received by the ARC backend.
+   * Only set when the object was created from the data received by the API Client backend.
    * Level access of the current user to the space.
    * Note, this information is never serialized with the object.
    */
@@ -127,11 +127,11 @@ export class Workspace {
   /**
    * 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 a space. 
    */
   new(init: IWorkspace | IUserWorkspace): void {
     if (!Workspace.isWorkspace(init)) {
-      throw new Error(`Not an ARC space.`);
+      throw new Error(`Not a space.`);
     }
     const { key = v4(), projects = [], info, owner = DefaultOwner, users } = init;
     this.kind = Kind;

package/src/models/actions/Action.ts

@@ -5,13 +5,13 @@ import { Kind as SetCookieKind, SetCookieAction, ISetCookieAction } from './runn
 import { Kind as SetVariableKind, SetVariableAction, ISetVariableAction } from './runnable/SetVariableAction.js';
 import { Action as LegacyAction, SetCookieConfig, SetVariableConfig, DeleteCookieConfig } from '../legacy/actions/Actions.js';
 
-export const Kind = 'ARC#Action';
+export const Kind = 'Core#Action';
 
 /**
  * An interface representing a single action.
  */
 export interface IAction {
-  kind?: 'ARC#Action';
+  kind?: typeof Kind;
   /**
    * Action name.
    */

package/src/models/actions/Condition.ts

@@ -1,7 +1,7 @@
 import { ActionTypeEnum, RequestDataSourceEnum, ResponseDataSourceEnum, OperatorEnum } from './Enums.js';
 import { Condition as LegacyCondition } from '../legacy/actions/Actions.js';
 
-export const Kind = 'ARC#Condition';
+export const Kind = 'Core#Condition';
 
 /**
  * A base interface describing a configuration to extract data from a request or a response.
@@ -33,7 +33,7 @@ export interface IDataSource {
  * Describes action's condition configuration.
  */
 export interface ICondition extends IDataSource {
-  kind: 'ARC#Condition',
+  kind: typeof Kind,
   /**
    * The comparison operator.
    */

package/src/models/actions/RunnableAction.ts

@@ -2,7 +2,7 @@ import { ICondition, Condition } from './Condition.js';
 import { IAction, Action } from './Action.js';
 import { RunnableAction as LegacyRunnable } from '../legacy/actions/Actions.js';
 
-export const Kind = 'ARC#RunnableAction';
+export const Kind = 'Core#RunnableAction';
 
 /**
  * An interface representing a runnable set of action in a condition.

package/src/models/actions/runnable/DeleteCookieAction.ts

@@ -1,10 +1,10 @@
 import { DeleteCookieConfig } from '../../legacy/actions/Actions.js';
 import { Runnable, IRunnable } from './Runnable.js';
 
-export const Kind = 'ARC#DeleteCookieAction';
+export const Kind = 'Core#DeleteCookieAction';
 
 export interface IDeleteCookieAction extends IRunnable {
-  kind?: 'ARC#DeleteCookieAction';
+  kind?: typeof Kind;
   /**
    * When set it uses request URL instead of defined URL in the action.
    */

package/src/models/actions/runnable/SetCookieAction.ts

@@ -3,10 +3,10 @@ import { Runnable, IRunnable } from './Runnable.js';
 import { IDataSource } from '../Condition.js';
 import { RequestDataSourceEnum } from '../Enums.js';
 
-export const Kind = 'ARC#SetCookieAction';
+export const Kind = 'Core#SetCookieAction';
 
 export interface ISetCookieAction extends IRunnable {
-  kind?: 'ARC#SetCookieAction';
+  kind?: typeof Kind;
   /**
    * Name of the cookie
    */

package/src/models/actions/runnable/SetVariableAction.ts

@@ -3,10 +3,10 @@ import { Runnable, IRunnable } from './Runnable.js';
 import { IDataSource } from '../Condition.js';
 import { RequestDataSourceEnum } from '../Enums.js';
 
-export const Kind = 'ARC#SetVariableAction';
+export const Kind = 'Core#SetVariableAction';
 
 export interface ISetVariableAction extends IRunnable {
-  kind?: 'ARC#SetVariableAction';
+  kind?: typeof Kind;
   /**
    * Name of the variable to set
    */

package/src/models/transformers/ImportUtils.ts

@@ -1,7 +1,7 @@
 /* eslint-disable no-param-reassign */
 /* eslint-disable no-plusplus */
 /**
- * User can export single request in ARC. In this case ARC opens new tab
+ * User can export single request in ARC. In this case the app opens new tab
  * rather actually imports the data. This function tests if this is the case.
  * @param data Normalized import data
  */

package/src/models/transformers/PostmanBackupTransformer.ts

@@ -5,6 +5,7 @@ import { ProjectFolder } from '../ProjectFolder.js';
 import { ProjectRequest } from '../ProjectRequest.js';
 import { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js';
 import { Environment } from '../Environment.js';
+import { Kind as ThingKind } from '../Thing.js';
 
 interface PostmanBackupV1 {
   version: number;
@@ -147,7 +148,7 @@ export class PostmanBackupTransformer extends PostmanTransformer {
       definitions: {},
       environments: [],
       info: {
-        kind: 'ARC#Thing',
+        kind: ThingKind,
         name,
       },
       items: [],

package/src/models/transformers/PostmanV21Transformer.ts

@@ -6,6 +6,7 @@ import { ProjectRequest } from '../ProjectRequest.js';
 import { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js';
 import v4 from '../../lib/uuid.js';
 import { Environment } from '../Environment.js';
+import { Kind as ThingKind } from '../Thing.js';
 
 export const currentItemValue = Symbol('currentItemValue');
 
@@ -134,7 +135,7 @@ export class PostmanV21Transformer extends PostmanTransformer {
       definitions: {},
       environments: [],
       info: {
-        kind: 'ARC#Thing',
+        kind: ThingKind,
         name: info.name || 'Unnamed Postman project',
       },
       items: [],

package/src/models/transformers/PostmanV2Transformer.ts

@@ -6,6 +6,7 @@ import { ProjectRequest } from '../ProjectRequest.js';
 import { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js';
 import v4 from '../../lib/uuid.js';
 import { Environment } from '../Environment.js';
+import { Kind as ThingKind } from '../Thing.js';
 
 export const currentItemValue = Symbol('currentItemValue');
 
@@ -131,7 +132,7 @@ export class PostmanV2Transformer extends PostmanTransformer {
       definitions: {},
       environments: [],
       info: {
-        kind: 'ARC#Thing',
+        kind: ThingKind,
         name: info.name || 'Unnamed Postman project',
       },
       items: [],