@api-client/core 0.8.6 → 0.8.8

package/src/models/ErrorResponse.ts

@@ -42,7 +42,7 @@ export class ErrorResponse extends HttpResponse {
     });
   }
 
-  static async fromLegacy(input: LegacyErrorResponse): Promise<ErrorResponse> {
+  static override async fromLegacy(input: LegacyErrorResponse): Promise<ErrorResponse> {
     const init: IErrorResponse = {
       kind: Kind,
       status: input.status || 0,
@@ -88,7 +88,7 @@ export class ErrorResponse extends HttpResponse {
    * 
    * Note, this throws an error when the object is not an API Client request.
    */
-  new(init: IErrorResponse): void {
+  override new(init: IErrorResponse): void {
     super.new(init);
     if (init.error) {
       if (typeof init.error === 'string') {
@@ -100,7 +100,7 @@ export class ErrorResponse extends HttpResponse {
     }
   }
 
-  toJSON(): IErrorResponse {
+  override toJSON(): IErrorResponse {
     const response = super.toJSON() as IErrorResponse;
     response.error = this.error;
     return response;

package/src/models/HttpProject.ts

@@ -267,7 +267,7 @@ interface HttpProjectDefinitions {
  * An instance of an HttpProject.
  */
 export class HttpProject extends ProjectParent {
-  kind = Kind;
+  override kind = Kind;
   private initEnvironments?: Environment[];
   /**
    * The license information for this HTTP project.
@@ -506,7 +506,7 @@ export class HttpProject extends ProjectParent {
   /**
    * @returns JSON representation of the project
    */
-  toString(): string {
+  override toString(): string {
     return JSON.stringify(this);
   }
 
@@ -1522,7 +1522,7 @@ export class HttpProject extends ProjectParent {
    * 
    * @param opts The environment read options
    */
-  async readEnvironments(opts: IReadEnvironmentOptions = {}): Promise<Environment[]> {
+  readEnvironments(opts: IReadEnvironmentOptions = {}): Environment[] {
     const result: Environment[] = [];
     const { parent, nameOrKey } = opts;
 

package/src/models/Project.ts

@@ -26,7 +26,7 @@ export interface IProject extends IFile {
  * both spaces and projects are returned in a single query.
  */
 export class Project extends File {
-  kind = Kind;
+  override kind = Kind;
 
   static fromProject(project: HttpProject | IHttpProject): Project {
     let final: IHttpProject;
@@ -73,7 +73,7 @@ export class Project extends File {
     this.new(init);
   }
 
-  new(init: IProject): void {
+  override new(init: IProject): void {
     if (!Project.isProject(init)) {
       throw new Error(`Not a project file.`);
     }
@@ -89,7 +89,7 @@ export class Project extends File {
     return true;
   }
 
-  toJSON(): IProject {
+  override toJSON(): IProject {
     const result: IProject = {
       ...super.toJSON(),
       kind: Kind,

package/src/models/ProjectFolder.ts

@@ -81,7 +81,7 @@ export class ProjectFolder extends ProjectParent {
     return DefaultFolderName;
   }
 
-  kind = Kind;
+  override kind = Kind;
   /**
    * A reference to the top level project object.
    */
@@ -418,7 +418,7 @@ export class ProjectFolder extends ProjectParent {
    * @param opts Cloning options
    */
   clone(opts: IFolderCloneOptions = {}): ProjectFolder {
-    const { targetProject=this.project, targetFolder } = opts;
+    const { targetProject = this.project, targetFolder } = opts;
     const copy = new ProjectFolder(targetProject, this.toJSON());
     copy.key = v4();
 

package/src/models/ProjectRequest.ts

@@ -6,6 +6,7 @@ import { HttpProject } from './HttpProject.js';
 import v4 from '../lib/uuid.js';
 import { IRequest, Request } from './Request.js';
 import { IAppProjectRequest } from './AppProject.js';
+import { Environment } from './Environment.js';
 
 export const Kind = 'Core#ProjectRequest';
 
@@ -15,6 +16,10 @@ export interface IProjectRequest extends IProjectDefinitionProperty, IRequest {
    * The identifier of the request.
    */
   key: string;
+  /**
+   * The key of an environment defined on the project to apply to this request.
+   */
+  environment?: string;
 }
 
 export interface IRequestCloneOptions {
@@ -39,15 +44,23 @@ export interface IRequestCloneOptions {
  * safely store the payload.
  */
 export class ProjectRequest extends Request implements ProjectDefinitionProperty {
-  kind = Kind;
+  override kind = Kind;
+  
   /**
    * The identifier of the request.
    */
   key = '';
+  
   /**
    * A reference to the top level project object.
    */
   project: HttpProject;
+
+  /**
+   * The key of an environment defined on the project to apply to this request.
+   */
+  environment?: string;
+  
   /**
    * Checks whether the input is a definition of a project folder.
    */
@@ -66,7 +79,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
    * @param url The Request URL. This is required.
    * @param project The parent project.
    */
-  static fromUrl(url: string, project?: HttpProject): ProjectRequest {
+  static override fromUrl(url: string, project?: HttpProject): ProjectRequest {
     if (!project) {
       throw new Error(`The project is required.`);
     }
@@ -96,7 +109,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
    * @param name The Request name.
    * @param project The parent project.This is required.
    */
-  static fromName(name: string, project?: HttpProject): ProjectRequest {
+  static override fromName(name: string, project?: HttpProject): ProjectRequest {
     if (!project) {
       throw new Error(`The project is required.`);
     }
@@ -126,7 +139,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
    * @param project The parent project This is required.
    * @param info The request data.
    */
-  static fromHttpRequest(info: IHttpRequest, project?: HttpProject): ProjectRequest {
+  static override fromHttpRequest(info: IHttpRequest, project?: HttpProject): ProjectRequest {
     if (!project) {
       throw new Error(`The project is required.`);
     }
@@ -190,16 +203,22 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     this.new(init);
   }
 
-  new(init: IProjectRequest | IAppProjectRequest): void {
+  override new(init: IProjectRequest | IAppProjectRequest): void {
     super.new(init);
 
-    const { key } = init;
+    const { key, environment } = init as IProjectRequest;
     this.key = key || v4();
+    if (environment) {
+      this.environment = environment;
+    }
   }
 
-  toJSON(): IProjectRequest {
+  override toJSON(): IProjectRequest {
     const request = super.toJSON();
     const result: IProjectRequest = { ...request, key: this.key, kind: Kind };
+    if (this.environment) {
+      result.environment = this.environment;
+    }
     return result;
   }
 
@@ -275,4 +294,30 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     const obj = new ProjectRequest(project, request);
     return obj.clone(opts);
   }
+
+  /**
+   * @returns The environment that should be applied to the request, if any.
+   */
+  getEnvironment(): Environment | undefined {
+    const { environment, project } = this;
+    if (!environment) {
+      return undefined;
+    }
+    let parent = this.getParent();
+    if (parent === project) {
+      parent = undefined;
+    }
+    return project.findEnvironment(environment);
+  }
+
+  /**
+   * @returns All environments that can be applied to this request.
+   */
+  readEnvironments(): Environment[] {
+    let parent = this.getParent();
+    if (parent === this.project) {
+      parent = undefined;
+    }
+    return this.project.readEnvironments({ parent: parent?.key });
+  }
 }

package/src/models/Request.ts

@@ -116,6 +116,7 @@ export class Request {
    * 
    * @param url The Request URL.
    */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   static fromUrl(url: string): Request {
     const now: number = Date.now();
     const request = new Request({

package/src/models/Response.ts

@@ -42,7 +42,7 @@ export class Response extends HttpResponse {
    */
   auth?: ResponseAuthorization;
 
-  static fromValues(status: number, statusText?: string, headers?: string): Response {
+  static override fromValues(status: number, statusText?: string, headers?: string): Response {
     return new Response({
       kind: Kind,
       status,
@@ -52,7 +52,7 @@ export class Response extends HttpResponse {
     });
   }
 
-  static async fromLegacy(input: LegacyResponse): Promise<Response> {
+  static override async fromLegacy(input: LegacyResponse): Promise<Response> {
     const init: IResponse = {
       kind: Kind,
       status: input.status || 0,
@@ -109,7 +109,7 @@ export class Response extends HttpResponse {
   /**
    * Creates a new response clearing anything that is so far defined.
    */
-  new(init: IResponse): void {
+  override new(init: IResponse): void {
     super.new(init);
     const { loadingTime=0, timings, auth } = init;
     this.loadingTime = loadingTime;
@@ -125,7 +125,7 @@ export class Response extends HttpResponse {
     }
   }
 
-  toJSON(): IResponse {
+  override toJSON(): IResponse {
     const response = super.toJSON() as IResponse;
     response.loadingTime = this.loadingTime;
     if (this.timings) {

package/src/models/SentRequest.ts

@@ -51,7 +51,7 @@ export class SentRequest extends HttpRequest {
    */
   endTime = 0;
 
-  static fromBaseValues(values: IBaseSentRequest): SentRequest {
+  static override fromBaseValues(values: IBaseSentRequest): SentRequest {
     return new SentRequest({
       ...values,
       kind: Kind,
@@ -105,7 +105,7 @@ export class SentRequest extends HttpRequest {
   /**
    * Creates a new sent request clearing anything that is so far defined.
    */
-  new(init: ISentRequest): void {
+  override new(init: ISentRequest): void {
     super.new(init);
     const { httpMessage, startTime=0, endTime=0 } = init;
     this.httpMessage = httpMessage;
@@ -113,7 +113,7 @@ export class SentRequest extends HttpRequest {
     this.endTime = endTime;
   }
 
-  toJSON(): ISentRequest {
+  override toJSON(): ISentRequest {
     const request = super.toJSON() as ISentRequest;
     request.httpMessage = this.httpMessage;
     request.startTime = this.startTime;

package/src/models/Workspace.ts

@@ -20,7 +20,7 @@ export interface IWorkspace extends IFile {
  * created by the system users, where they can store their projects and other data.
  */
 export class Workspace extends File {
-  kind = Kind;
+  override kind = Kind;
   
   /**
    * Creates a new Space object from a name.
@@ -77,7 +77,7 @@ export class Workspace extends File {
    * 
    * Note, this throws an error when the environment is not a space. 
    */
-  new(init: IWorkspace): void {
+  override new(init: IWorkspace): void {
     if (!Workspace.isWorkspace(init)) {
       throw new Error(`Not a space.`);
     }
@@ -96,7 +96,7 @@ export class Workspace extends File {
     return true;
   }
 
-  toJSON(): IWorkspace {
+  override toJSON(): IWorkspace {
     const result: IWorkspace = {
       ...super.toJSON(),
       kind: Kind,

package/src/models/data/DataFile.ts

@@ -13,7 +13,7 @@ export interface IDataFile extends IFile {
  * Used by the store. A file definition for the DataNamespace
  */
 export class DataFile extends File {
-  kind = Kind;
+  override kind = Kind;
 
   /**
    * Creates the file definition for a DataNamespace contents.
@@ -66,7 +66,7 @@ export class DataFile extends File {
     this.new(init);
   }
   
-  new(init: IDataFile): void {
+  override new(init: IDataFile): void {
     if (!DataFile.isDataFile(init)) {
       throw new Error(`Not a data file.`);
     }
@@ -82,7 +82,7 @@ export class DataFile extends File {
     return true;
   }
 
-  toJSON(): IDataFile {
+  override toJSON(): IDataFile {
     const result: IDataFile = {
       ...super.toJSON(),
       kind: Kind,

package/src/models/data/DataNamespace.ts

@@ -426,7 +426,7 @@ export class DataNamespace extends DataNamespaceParent {
    * @param init The name of the namespace to add, namespace's schema, or instance.
    * @param parent The optional key of the parent namespace to add the new namespace to.
    */
-  addNamespace(init: string | IDataNamespace | DataNamespace, parent?: string): DataNamespace {
+  override addNamespace(init: string | IDataNamespace | DataNamespace, parent?: string): DataNamespace {
     let root: DataNamespace;
     if (parent) {
       const rootCandidate = this.findParent(parent);

package/src/models/store/File.ts

@@ -458,13 +458,13 @@ export class File extends StoredFile {
     return this[permissionsSymbol];
   }
   
-  new(init: IFile): void {
+  override new(init: IFile): void {
     super.new(init);
     const { permissions=[] } = init;
     this[permissionsSymbol] = permissions.map(i => ({ ...i }));
   }
 
-  toJSON(): IFile {
+  override toJSON(): IFile {
     const result: IFile = {
       ...super.toJSON(),
       permissions: [...this.permissions],

package/src/runtime/http-engine/CoreEngine.ts

@@ -97,7 +97,7 @@ export class CoreEngine extends HttpEngine {
   /**
    * Cleans the state after finished.
    */
-  _cleanUp(): void {
+  override _cleanUp(): void {
     super._cleanUp();
     this.state = RequestState.Status;
     this.rawHeaders = undefined;
@@ -109,7 +109,7 @@ export class CoreEngine extends HttpEngine {
   /**
    * Cleans up the state for redirect.
    */
-  _cleanUpRedirect(): void {
+  override _cleanUpRedirect(): void {
     super._cleanUpRedirect();
     this.state = RequestState.Status;
     this.rawHeaders = undefined;
@@ -522,7 +522,7 @@ export class CoreEngine extends HttpEngine {
   /**
    * Generate response object and publish it to the listeners.
    */
-  _publishResponse(): Promise<void> {
+  override _publishResponse(): Promise<void> {
     this.state = RequestState.Done;
     if (!this._rawBody) {
       if (this.responseInfo.body) {
@@ -538,7 +538,7 @@ export class CoreEngine extends HttpEngine {
    * @param location The redirect location.
    * @return Redirect response object
    */
-  async _createRedirectResponse(location: string): Promise<ResponseRedirect> {
+  override async _createRedirectResponse(location: string): Promise<ResponseRedirect> {
     const { currentResponse = new Response() } = this;
     this.currentResponse = currentResponse;
     if (!this.currentResponse.payload) {

package/src/runtime/node/ProjectRunner.ts

@@ -219,7 +219,7 @@ export abstract class ProjectRunner extends BaseRunner {
   /**
    * Creates the report of the execution.
    */
-  protected async createReport(): Promise<IProjectExecutionLog> {
+  protected override async createReport(): Promise<IProjectExecutionLog> {
     const log: IProjectExecutionLog = {
       started: this.startTime as number,
       ended: this.endTime as number,

package/src/runtime/store/Errors.ts

@@ -87,7 +87,7 @@ export class SdkError extends SerializableError {
    */
   detail?: string;
 
-  toJSON(): ISdkError {
+  override toJSON(): ISdkError {
     const result = super.toJSON();
     if (this.response) {
       result.response = this.response;