@api-client/core 0.3.12 → 0.4.2

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.
@@ -166,13 +165,45 @@ export interface IProjectRequestIterator {
   ignore?: string[];
 }
 
+export interface IProjectFolderIterator {
+  /**
+   * The parent folder key or name. Sets the starting point to iterate over the folder.
+   */
+  parent?: string
+  /**
+   * When set it includes folders in the current folder and sub-folder according to the order
+   * defined in the folder.
+   */
+  recursive?: boolean;
+  /**
+   * The list of names or keys to ignore.
+   */
+  ignore?: string[];
+}
+
+export interface IProjectFolderIteratorResult {
+  /**
+   * The folder.
+   */
+  folder: ProjectFolder;
+  /**
+   * Optional parent key.
+   */
+  parent?: string;
+  /**
+   * How deep in the structure the folder is located.
+   * The indent is relative to the `parent`.
+   */
+  indent: number;
+}
+
 /**
- * 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 +371,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;
@@ -1234,7 +1265,7 @@ export class HttpProject extends ProjectParent {
   }
 
   /**
-   * Iterates over requests in the project,
+   * Iterates over requests in the project.
    */
   * requestIterator(opts: IProjectRequestIterator = {}): Generator<ProjectRequest> {
     const { definitions } = this;
@@ -1286,6 +1317,55 @@ export class HttpProject extends ProjectParent {
     }
   }
 
+  /**
+   * Iterates over requests in the project.
+   * @param opts Iterator configuration options
+   * @param indent Used internally to add `indent` to the result
+   */
+  * folderIterator(opts: IProjectFolderIterator={}, indent=0): Generator<IProjectFolderIteratorResult> {
+    const { definitions } = this;
+    const { ignore=[], parent, recursive } = opts;
+    const root = parent ? this.findFolder(parent) : this;
+    if (!root) {
+      throw new Error(`The parent folder not found: ${parent}.`);
+    }
+    const items = root.items;
+    if (!items || !items.length) {
+      return;
+    }
+    for (const item of items) {
+      if (item.kind !== ProjectFolderKind) {
+        continue;
+      }
+      const folder = definitions.folders.find(i => i.key === item.key);
+      if (!folder) {
+        // missing definition.
+        continue;
+      }
+      if (ignore.includes(folder.key) || (folder.info.name && ignore.includes(folder.info.name))) {
+        continue;
+      }
+      const result: IProjectFolderIteratorResult = {
+        folder,
+        indent,
+      }
+      if (parent) {
+        result.parent = parent;
+      }
+      yield result;
+      if (recursive) {
+        const it = this.folderIterator({
+          parent: folder.key,
+          recursive,
+          ignore,
+        }, indent += 1);
+        for (const f of it) {
+          yield f;
+        }
+      }
+    }
+  }
+
   [Symbol.iterator](): Generator<ProjectRequest> {
     return this.requestIterator({
       recursive: true,

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;

package/src/models/HttpResponse.ts

@@ -3,7 +3,7 @@ import { Payload, PayloadSerializer } from '../lib/transformers/PayloadSerialize
 import { HTTPResponse as LegacyHttpResponse } from './legacy/request/ArcResponse.js';
 import { Normalizer } from './legacy/Normalizer.js';
 
-export const Kind = 'ARC#HttpResponse';
+export const Kind = 'Core#HttpResponse';
 
 export interface IHttpResponse {
   kind?: string;
@@ -91,11 +91,11 @@ export class HttpResponse extends SerializablePayload {
   /**
    * Creates a new response clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the object is not an ARC response.
+   * Note, this throws an error when the object is not a response.
    */
   new(init: IHttpResponse): void {
     if (!HttpResponse.isHttpResponse(init)) {
-      throw new Error(`Not an ARC response.`);
+      throw new Error(`Not a response.`);
     }
     const { status, statusText, headers, payload, kind=Kind } = init;
     this.kind = kind;

package/src/models/License.ts

@@ -1,7 +1,7 @@
-export const Kind = 'ARC#License';
+export const Kind = 'Core#License';
 
 export interface ILicense {
-  kind: 'ARC#License'
+  kind: typeof Kind;
   /**
    * The URL to the license text.
    * Only `url` or `content` can be used at a time.
@@ -71,11 +71,11 @@ export class License {
   /**
    * Creates a new license clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the license is not an ARC license object.
+   * Note, this throws an error when the license is not a license object.
    */
   new(init: ILicense): void {
     if (!License.isLicense(init)) {
-      throw new Error(`Not an ARC license.`);
+      throw new Error(`Not a license.`);
     }
     const { url, content, name } = init;
     this.kind = Kind;

package/src/models/ProjectFolder.ts

@@ -6,7 +6,7 @@ import { HttpProject } from './HttpProject.js';
 import { IThing, Thing, Kind as ThingKind } from './Thing.js';
 import v4 from '../lib/uuid.js';
 
-export const Kind = 'ARC#ProjectFolder';
+export const Kind = 'Core#ProjectFolder';
 export const DefaultFolderName = 'New folder';
 
 export interface IFolderAddOptions {
@@ -126,11 +126,11 @@ export class ProjectFolder extends ProjectParent {
   /**
    * Creates a new project folder clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the project folder is not an ARC project folder.
+   * Note, this throws an error when the project folder is not a project folder.
    */
   new(init: IProjectFolder): void {
     if (!ProjectFolder.isProjectFolder(init)) {
-      throw new Error(`Not an ARC project folder.`);
+      throw new Error(`Not a project folder.`);
     }
     const { key = v4(), created = Date.now(), updated = Date.now(), items, environments, info } = init;
     this.kind = Kind;

package/src/models/ProjectItem.ts

@@ -92,11 +92,11 @@ export class ProjectItem {
   /**
    * Creates a new project item clearing anything that is so far defined.
    * 
-   * Note, this throws an error when the project item is not an ARC project item. 
+   * Note, this throws an error when the project item is not a project item. 
    */
   new(init: IProjectItem): void {
     if (!ProjectItem.isProjectItem(init)) {
-      throw new Error(`Not an ARC project item.`);
+      throw new Error(`Not a project item.`);
     }
     const { kind, key } = init;
     this.kind = kind;

package/src/models/ProjectRequest.ts

@@ -6,10 +6,10 @@ import { HttpProject } from './HttpProject.js';
 import v4 from '../lib/uuid.js';
 import { IRequest, Request } from './Request.js';
 
-export const Kind = 'ARC#ProjectRequest';
+export const Kind = 'Core#ProjectRequest';
 
 export interface IProjectRequest extends IProjectDefinitionProperty, IRequest {
-  kind: 'ARC#ProjectRequest';
+  kind: typeof Kind;
   /**
    * The identifier of the request.
    */

package/src/models/ProjectSchema.ts

@@ -1,9 +1,9 @@
 import v4 from '../lib/uuid.js';
 import { Property, IProperty, PropertyType, Kind as PropertyKind } from './Property.js';
-export const Kind = 'ARC#ProjectSchema';
+export const Kind = 'Core#ProjectSchema';
 
 export interface IProjectSchema {
-  kind?: 'ARC#ProjectSchema';
+  kind?: typeof Kind;
   /**
    * The identifier of the environment.
    */

package/src/models/Property.ts

@@ -3,7 +3,7 @@ import { ApiType } from './legacy/models/ApiTypes.js';
 export type PropertyType = 'string' | 'integer' | 'float' | 'nil' | 'boolean' | 'date' | 'datetime' | 'time' | 'int32' | 'int64' | 'uint32' | 'uint64' | 'sint32' | 'sint64' | 'fixed32' | 'fixed64' | 'sfixed32' | 'sfixed64' | 'double' | 'bytes';
 
 export interface IProperty {
-  kind: 'ARC#Property';
+  kind: typeof Kind;
   /**
    * Property name
    */
@@ -42,7 +42,7 @@ export interface IProperty {
   repeated?: boolean;
 }
 
-export const Kind = 'ARC#Property';
+export const Kind = 'Core#Property';
 
 /**
  * A property of an HTTP request.
@@ -358,13 +358,13 @@ export class Property {
   }
 
   /**
-   * Creates a new environment clearing anything that is so far defined.
+   * Creates a new property.
    * 
-   * Note, this throws an error when the property is not an ARC environment.
+   * Note, this throws an error when the property is not a property.
    */
   new(init: IProperty): void {
     if (!Property.isProperty(init)) {
-      throw new Error(`Not an ARC property.`);
+      throw new Error(`Not a property.`);
     }
     const { name, value, default: defaultValue, description, enabled, enum: enumValue, required, type, repeated } = init;
     this.kind = Kind;

package/src/models/Provider.ts

@@ -5,7 +5,7 @@ export declare interface IProvider {
   /**
    * The data kind. The application ignores the input with an unknown `kind`, unless it can be determined from the context.
    */
-  kind: 'ARC#Provider';
+  kind: typeof Kind;
   /**
    * The URL to the provider
    */
@@ -20,7 +20,7 @@ export declare interface IProvider {
   email?: string;
 }
 
-export const Kind = 'ARC#Provider';
+export const Kind = 'Core#Provider';
 
 export class Provider {
   kind = Kind;
@@ -56,11 +56,11 @@ export class Provider {
   /**
    * 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 a provider object.
    */
   new(init: IProvider): void {
     if (!Provider.isProvider(init)) {
-      throw new Error(`Not an ARC provider.`);
+      throw new Error(`Not a provider.`);
     }
     const { url, email, name } = init;
     this.kind = Kind;

package/src/models/README.md

@@ -1,4 +1,4 @@
-# API Client/ARC models
+# API Client models
 
 ## Principles for designing a data model
 
@@ -13,7 +13,7 @@ We aim to be interoperable with AMF so when designing a data model first design
 
 ### The "kind" as the object type identifier
 
-Each data object that can exist by itself or in multiple contexts' should contain the `kind` property that uniquely identifies the type. For example, the `HttpProject` class has the `ARC#HttpProject`. These kinds are used by other libraries to identify which data types they are given as the input.
+Each data object that can exist by itself or in multiple contexts' should contain the `kind` property that uniquely identifies the type. For example, the `HttpProject` class has the `Core#HttpProject`. These kinds are used by other libraries to identify which data types they are given as the input.
 
 ### Validation
 

package/src/models/Request.ts

@@ -6,7 +6,7 @@ import { IRequestAuthorization, RequestAuthorization } from './RequestAuthorizat
 import { IRequestLog, RequestLog, Kind as LogKind } from './RequestLog.js';
 import { SentRequest } from './SentRequest.js';
 import { ErrorResponse } from './ErrorResponse.js';
-import { ArcResponse } from './ArcResponse.js';
+import { Response } from './Response.js';
 import { RequestsSize } from './RequestsSize.js';
 import { IHttpRequest, HttpRequest, Kind as HttpRequestKind } from './HttpRequest.js';
 import { ARCSavedRequest, ARCHistoryRequest } from './legacy/request/ArcRequest.js';
@@ -14,13 +14,13 @@ import { ErrorResponse as LegacyErrorResponse, Response as LegacyResponse } from
 import { PayloadSerializer } from '../lib/transformers/PayloadSerializer.js';
 import { Normalizer } from './legacy/Normalizer.js';
 
-export const Kind = 'ARC#Request';
+export const Kind = 'Core#Request';
 export const createdSymbol = Symbol('created');
 export const updatedSymbol = Symbol('updated');
 export const midnightSymbol = Symbol('midnight');
 
 /**
- * The definition of a request object that functions inside ARC
+ * The definition of a request object that functions inside API Client
  * with the full configuration.
  */
 export interface IRequest {
@@ -228,7 +228,7 @@ export class Request {
         log.response = await ErrorResponse.fromLegacy(typedError);
       } else {
         const typedResponse = normalized.response as LegacyResponse;
-        log.response = await ArcResponse.fromLegacy(typedResponse);
+        log.response = await Response.fromLegacy(typedResponse);
         if (Array.isArray(typedResponse.redirects) && typedResponse.redirects.length) {
           const promises = typedResponse.redirects.map((redirect) => log.addLegacyRedirect(redirect));
           await Promise.allSettled(promises);

package/src/models/RequestActions.ts

@@ -55,7 +55,7 @@ export class RequestActions {
   }
 
   /**
-   * @param input The provider definition used to restore the state.
+   * @param input The request actions definition used to restore the state.
    */
   constructor(input?: string | IRequestActions) {
     let init: IRequestActions;
@@ -70,9 +70,7 @@ export class RequestActions {
   }
 
   /**
-   * 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.
+   * Creates a new request actions clearing anything that is so far defined.
    */
   new(init: IRequestActions): void {
     const { request, response } = init;

package/src/models/RequestAuthorization.ts

@@ -1,13 +1,13 @@
 import { IAuthorizationSettingsUnion, AuthorizationType } from './Authorization.js';
 import { RequestAuthorization as LegacyAuthorization } from './legacy/request/ArcRequest.js';
 
-export const Kind = 'ARC#RequestAuthorization';
+export const Kind = 'Core#RequestAuthorization';
 
 /**
  * Authorization configuration for the request.
  */
 export interface IRequestAuthorization {
-  kind: string;
+  kind: typeof Kind;
   /**
    * Authorization configuration
    */
@@ -89,9 +89,7 @@ export class RequestAuthorization {
   }
 
   /**
-   * 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.
+   * Creates a new request authorization clearing anything that is so far defined.
    */
   new(init: IRequestAuthorization): void {
     const { config, type, enabled, valid } = init;

package/src/models/RequestConfig.ts

@@ -2,7 +2,7 @@ import { IHostRule, HostRule } from './HostRule.js';
 import { IProperty, Property } from './Property.js';
 import { RequestConfig as LegacyConfig } from './legacy/request/ArcRequest.js';
 
-export const Kind = 'ARC#RequestConfig';
+export const Kind = 'Core#RequestConfig';
 
 export interface IRequestBaseConfig {
   /**
@@ -62,10 +62,10 @@ export interface IRequestBaseConfig {
 }
 
 /**
- * ARC request `config` object.
+ * API Client request `config` object.
  */
 export interface IRequestConfig extends IRequestBaseConfig {
-  kind: string;
+  kind: typeof Kind;
   /**
    * Whether the processor should use this configuration.
    */
@@ -205,8 +205,6 @@ export class RequestConfig {
 
   /**
    * Creates a new request configuration clearing anything that is so far defined.
-   * 
-   * Note, this throws an error when the object is not an ARC request configuration. 
    */
   new(init: IRequestConfig): void {
     const { 

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;