@api-client/core 0.3.11 → 0.4.1

package/src/models/HttpHistory.ts

@@ -1,25 +1,35 @@
 import { IRequestLog, RequestLog, Kind as RequestLogKind } from './RequestLog.js';
 
-export const Kind = 'ARC#HttpHistory';
+export const Kind = 'Core#HttpHistory';
 export const createdSymbol = Symbol('created');
 export const midnightSymbol = Symbol('midnight');
 
 export interface IHttpHistory {
   kind: typeof Kind;
   /**
-   * The application code. The same as used in `Application#code`.
-   * Optional.
+   * 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.
    */
-  app?: string;
+  key?: string;
+  /**
+   * Optional user space id. Must be set when the originating request belongs to a user space.
+   */
+  space?: string;
   /**
-   * The user project the request belongs to.
-   * Optional. Also note, the project may not exist anymore in the store or the request has been removed from the project.
+   * Optional project id. Must be set when the originating request belongs to a user space.
    */
   project?: string;
   /**
-   * The optional user id that made that request.
+   * 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;
+  user: string;
   /**
    * The optional request id in the project that generated this log.
    */
@@ -38,12 +48,39 @@ export interface IHttpHistory {
   midnight?: number;
 }
 
+/**
+ * An interface used when adding a history in bulk.
+ * The store creates a history object propagating meta values defined here
+ * onto the history objects.
+ * Because of that, bulk operation can only be performed when the requests are made in similar 
+ * context (app, space, project).
+ */
+export interface IHttpHistoryBulkAdd {
+  /**
+   * 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 optional request id in the project that generated this log.
+   */
+  request?: string;
+  /**
+   * The list of request logs.
+   */
+  log: IRequestLog[];
+}
+
 /**
  * An HTTP history is an object containing an information of a request and response
  * made with the application.
- * It consist of the RequestLog and optional information about the application that made that request and the HTTP project
- * the request belongs to as well as the id of the request.
- * However, this object may not contain these information for general purpose of the history store.
  * 
  * Note, history object are not mutable. Can only be created or deleted.
  */
@@ -52,19 +89,29 @@ export class HttpHistory {
   [midnightSymbol]: number;
   kind = Kind;
   /**
-   * The application code. The same as used in `Application#code`.
-   * Optional.
+   * 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.
    */
-  app?: string;
+  key?: string;
   /**
-   * The user project the request belongs to.
-   * Optional. Also note, the project may not exist anymore in the store or the request has been removed from the project.
+   * 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;
   /**
-   * The optional user id that made that request.
+   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
    */
-  user?: string;
+  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.
    */
@@ -84,7 +131,7 @@ export class HttpHistory {
       this[createdSymbol] = value;
     }
     const d = new Date(this[createdSymbol]);
-    d.setHours(0, 0, 0, 0)
+    d.setHours(0, 0, 0, 0);
     this[midnightSymbol] = d.getTime();
   }
 
@@ -127,6 +174,7 @@ export class HttpHistory {
       init = {
         kind: Kind,
         created: now,
+        user: '',
         log: {
           kind: RequestLogKind,
         },
@@ -136,17 +184,27 @@ export class HttpHistory {
   }
 
   new(init: IHttpHistory): void {
-    const { log, created = Date.now(), midnight, app, project, request, user } = init;
+    const { log, created = Date.now(), midnight, space, project, request, user, key, app } = init;
     this.log = new RequestLog(log);
     this.created = created;
-    if (midnight) {
-      this.midnight = midnight;
+    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 {
@@ -160,7 +218,7 @@ export class HttpHistory {
     if (user) {
       this.user = user;
     } else {
-      this.user = undefined;
+      this.user = '';
     }
   }
 
@@ -170,9 +228,13 @@ export class HttpHistory {
       created: this.created,
       midnight: this.midnight,
       log: this.log.toJSON(),
+      user: this.user,
     };
-    if (this.app) {
-      result.app = this.app;
+    if (this.key) {
+      result.key = this.key;
+    }
+    if (this.space) {
+      result.space = this.space;
     }
     if (this.project) {
       result.project = this.project;
@@ -180,8 +242,8 @@ export class HttpHistory {
     if (this.request) {
       result.request = this.request;
     }
-    if (this.user) {
-      result.user = this.user;
+    if (this.app) {
+      result.app = this.app;
     }
     return result;
   }

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.
@@ -167,12 +166,12 @@ export interface IProjectRequestIterator {
 }
 
 /**
- * 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 +339,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;

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 {