@api-client/core 0.5.10 → 0.5.14

package/src/models/HttpProject.ts

@@ -1107,6 +1107,26 @@ export class HttpProject extends ProjectParent {
     return result.reverse();
   }
 
+  /**
+   * @returns Returns the effective environments. If the project has been initialized with an environment then it is returned. Otherwise other environments.
+   */
+  getEnvironments(): Environment[] {
+    if (Array.isArray(this.initEnvironments)) {
+      return this.initEnvironments;
+    }
+    return super.getEnvironments();
+  }
+
+  /**
+   * Finds a definition for an environment regardless of its parent.
+   * 
+   * @param key The Key of the environment to find.
+   * @returns The environment definition or undefined if not found.
+   */
+  findEnvironment(key: string): Environment | undefined {
+    return this.definitions.environments.find(i => i.key === key);
+  }
+
   /**
    * Makes a copy of this project.
    */
@@ -1257,13 +1277,6 @@ export class HttpProject extends ProjectParent {
     return this.definitions.schemas;
   }
 
-  getEnvironments(): Environment[] {
-    if (Array.isArray(this.initEnvironments)) {
-      return this.initEnvironments;
-    }
-    return super.getEnvironments();
-  }
-
   /**
    * Iterates over requests in the project.
    */

package/src/models/ProjectParent.ts

@@ -110,4 +110,31 @@ export abstract class ProjectParent implements ProjectDefinitionProperty {
     });
     return result;
   }
+
+  /**
+   * @param key The environment key to read.
+   */
+  getEnvironment(key: string): Environment | undefined {
+    const { environments } = this;
+    if (!environments.length) {
+      return undefined;
+    }
+    const has = environments.includes(key);
+    if (!has) {
+      return undefined;
+    }
+    const project = this.getProject();
+    if (!project.definitions.environments) {
+      return undefined;
+    }
+    return project.definitions.environments.find(i => i.key === key);
+  }
+
+  /**
+   * This is a link to the `getEnvironments()`. The difference is that on the 
+   * project level it won't return environments defined with the class initialization.
+   */
+  listEnvironments(): Environment[] {
+    return this.getEnvironments();
+  }
 }

package/src/models/Property.ts

@@ -420,4 +420,22 @@ export class Property {
     }
     return result;
   }
+
+  /**
+   * Maps the list of properties to a single map.
+   * It overrides previously defined properties on the map in case of multiple variables with the same name.
+   * 
+   * @param properties The list of properties to map.
+   * @returns A map where keys are property names and values are the property values.
+   */
+  static toMap(properties: (IProperty | Property)[]): Record<string, any> {
+    const result: Record<string, any> = {};
+    properties.forEach(p => {
+      if (p.enabled === false) {
+        return;
+      }
+      result[p.name] = p.value;
+    });
+    return result;
+  }
 }

package/src/models/Server.ts

@@ -1,3 +1,6 @@
+import { IProperty, Property } from './Property.js';
+import { UriTemplate } from '../lib/parsers/UriTemplate.js';
+
 export const Kind = 'Core#Server';
 
 export interface IServer {
@@ -129,8 +132,10 @@ export class Server {
 
   /**
    * Constructs the final URI from the server configuration.
+   * 
+   * @param variables When set it evaluates the generated URI against these variables
    */
-  readUri(): string {
+  readUri(variables?: (IProperty | Property)[]): string {
     const { uri, protocol, basePath } = this;
     let result = '';
     if (!uri) {
@@ -148,6 +153,32 @@ export class Server {
       }
       result += basePath.startsWith('/') ? basePath : `/${basePath}`
     }
+    if (variables) {
+      return this.evaluateUri(result, variables);
+    }
+    return result;
+  }
+
+  /**
+   * Evaluates the URI against the variables.
+   * 
+   * Note, this doesn't throw errors. When error occurs it returns the input string. 
+   * 
+   * @param uri The URI to process
+   * @param variables The list of variables to use
+   * @returns Expanded URI.
+   */
+  protected evaluateUri(uri: string, variables: (IProperty | Property)[]): string {
+    if (!variables || !variables.length) {
+      return uri;
+    }
+    let result = uri;
+    try {
+      const map = Property.toMap(variables);
+      result = new UriTemplate(uri).expand(map, { ignoreMissing: true });
+    } catch (e) {
+      // 
+    }
     return result;
   }
 }

package/src/models/{Backend.ts → store/Backend.ts}

@@ -1,4 +1,7 @@
 /* eslint-disable import/export */
+
+import { JsonPatch } from '@api-client/json'
+
 export type BackendMode = 'single-user' | 'multi-user';
 
 export interface IBackendInfo {
@@ -16,14 +19,45 @@ export interface IBackendInfo {
    * @default single-user
    */
   mode: BackendMode;
+  
   /**
-   * Optional, the store base path when set on the configuration.
+   * Client authentication configuration
    */
-  prefix?: string;
+  auth: {
+    /**
+     * The path to the authentication endpoint.
+     * This is always populated whether the store is in the single- or multi-user mode.
+     */
+    path: string;
+    /**
+     * When configured, the OAuth2 redirect URI.
+     */
+    redirect?: string;
+    /**
+     * When configured the type of the authentication protocol.
+     */
+    type?: string;
+  }
+
   /**
-   * The path to the authentication endpoint.
+   * The information about hosting.
    */
-  authPath: string;
+  hosting: {
+    /**
+     * Optional, the store base path when set on the configuration.
+     */
+    prefix?: string;
+    /**
+     * When configured with the host information, this is the public host name of the store.
+     * When using udp to discover the store in the local network, this is the ip address of the machine the store
+     * is running on.
+     */
+    host?: string;
+    /**
+     * The port number the store operates on.
+     */
+    port: number;
+  }
 }
 
 export interface IBackendCommand {
@@ -205,3 +239,41 @@ export interface IHistoryAppListOptions extends IListOptions {
    */
   id: string;
 }
+
+/**
+ * An interface describing a schema to be sent to the server
+ * when making a patch of a file.
+ */
+export interface IPatchInfo {
+  /**
+   * Auto generated by the client sending the PATCH.
+   */
+  id: string;
+  /**
+   * The application id that generated the patch.
+   * This is a string that is assigned to each application in the suite.
+   * External applications need to use a constant string for their apps.
+   */
+  app: string;
+  /**
+   * The version of the application that generated the patch.
+   * This can and will be used to handle potential differences between suite applications.
+   */
+  appVersion: string;
+  /**
+   * The patch generated by the client.
+   */
+  patch: JsonPatch;
+}
+
+/**
+ * A schema sent by the store server in a response to the patch request.
+ * It contains an information about the applied patch, the reverse operation associated with it,
+ * application information, and the generated by the client patch id.
+ */
+export interface IPatchRevision extends IPatchInfo {
+  /**
+   * The patch to apply to the object to revert the changes.
+   */
+  revert: JsonPatch;
+}

package/src/runtime/actions/runnable/DeleteCookieRunnable.ts

@@ -2,7 +2,7 @@ import { IHttpRequest } from 'src/models/HttpRequest.js';
 import { ActionRunnable } from './ActionRunnable.js';
 import { IDeleteCookieAction } from '../../../models/actions/runnable/DeleteCookieAction.js';
 import { Events } from '../../../events/Events.js';
-import { IRequestLog } from 'src/models/RequestLog.js';
+import { IRequestLog } from '../../../models/RequestLog.js';
 
 export class DeleteCookieRunnable extends ActionRunnable {
   async response(log: IRequestLog): Promise<void> {

package/src/runtime/actions/runnable/SetCookieRunnable.ts

@@ -4,7 +4,7 @@ import { ActionRunnable } from './ActionRunnable.js';
 import { ISetCookieAction } from '../../../models/actions/runnable/SetCookieAction.js';
 import { Events } from '../../../events/Events.js';
 import { RequestDataExtractor } from '../../../data/RequestDataExtractor.js';
-import { IRequestLog } from 'src/models/RequestLog.js';
+import { IRequestLog } from '../../../models/RequestLog.js';
 
 export class SetCookieRunnable extends ActionRunnable {
   async request(request: IHttpRequest): Promise<void> {

package/src/runtime/actions/runnable/SetVariableRunnable.ts

@@ -3,7 +3,7 @@ import { ActionRunnable } from './ActionRunnable.js';
 import { ISetVariableAction } from '../../../models/actions/runnable/SetVariableAction.js';
 import { Events } from '../../../events/Events.js';
 import { RequestDataExtractor } from '../../../data/RequestDataExtractor.js';
-import { IRequestLog } from 'src/models/RequestLog.js';
+import { IRequestLog } from '../../../models/RequestLog.js';
 
 export class SetVariableRunnable extends ActionRunnable {
   async request(request: IHttpRequest): Promise<void> {

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

@@ -3,7 +3,7 @@ import tls from 'tls';
 import http from 'http';
 import https from 'https';
 import { HttpEngine, HttpEngineOptions, HeadersReceivedDetail } from './HttpEngine.js';
-import { IRequestLog } from 'src/models/RequestLog.js';
+import { IRequestLog } from '../../models/RequestLog.js';
 import { IHttpRequest } from '../../models/HttpRequest.js';
 import { Response } from '../../models/Response.js';
 import { SerializableError } from '../../models/SerializableError.js';

package/src/runtime/store/BackendSdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IBackendInfo } from '../../models/Backend.js';
+import { IBackendInfo } from '../../models/store/Backend.js';
 
 export class BackendSdk extends SdkBase {
   /**

package/src/runtime/store/FilesSdk.ts

@@ -1,8 +1,7 @@
 import WebSocketNode from 'ws';
-import { Patch } from '@api-client/json';
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { IListOptions, IListResponse, IPatchInfo, IPatchRevision } from '../../models/store/Backend.js';
 import { AccessOperation } from '../../models/store/Permission.js';
 import { IUser } from '../../models/store/User.js';
 import { IFile } from '../../models/store/File.js';
@@ -193,7 +192,7 @@ export class FilesSdk extends SdkBase {
    * @param value The patch to apply.
    * @param request Optional request options.
    */
-  patch(key: string, value: Patch.JsonPatch, media: false, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
+  patch(key: string, value: IPatchInfo, media: false, request?: ISdkRequestOptions): Promise<IPatchRevision>;
 
   /**
    * Patches file's content in the store.
@@ -202,7 +201,7 @@ export class FilesSdk extends SdkBase {
    * @param value The patch to apply.
    * @param request Optional request options.
    */
-  patch(key: string, value: Patch.JsonPatch, media: true, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
+  patch(key: string, value: IPatchInfo, media: true, request?: ISdkRequestOptions): Promise<IPatchRevision>;
 
   /**
    * Patches a file in the store.
@@ -211,7 +210,7 @@ export class FilesSdk extends SdkBase {
    * @param request Optional request options.
    * @returns The JSON patch to revert the change using the `@api-client/json` library
    */
-  async patch(key: string, value: Patch.JsonPatch, media?: boolean, request: ISdkRequestOptions = {}): Promise<Patch.JsonPatch> {
+  async patch(key: string, value: IPatchInfo, media?: boolean, request: ISdkRequestOptions = {}): Promise<IPatchRevision> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.file(key));
     if (media) {
@@ -233,16 +232,17 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
     }
-    let data: any;
+    let data: IPatchRevision;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
       throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
     }
+    // revert is added to the response
     if (!data.revert) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
     }
-    return data.revert as Patch.JsonPatch;
+    return data;
   }
 
   /**
@@ -338,4 +338,20 @@ export class FilesSdk extends SdkBase {
     const url = this.sdk.getUrl(RouteBuilder.files());
     return this.sdk.ws.createAndConnect(url.toString(), token);
   }
+
+  /**
+   * Creates a WS client that listens to the file events.
+   * 
+   * @param key The file key to observe
+   * @param media Whether to observe changes to the file media instead of meta.
+   * @param request Optional request options.
+   */
+  async observeFile(key: string, media?: boolean, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.file(key));
+    if (media) {
+      url.searchParams.set('alt', 'media');
+    }
+    return this.sdk.ws.createAndConnect(url.toString(), token);
+  }
 }

package/src/runtime/store/HistorySdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListResponse, HistoryListOptions, IHistoryRequestListOptions } from '../../models/Backend.js';
+import { IListResponse, HistoryListOptions, IHistoryRequestListOptions } from '../../models/store/Backend.js';
 import { IHttpHistory, IHttpHistoryBulkAdd, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
 
 export class HistorySdk extends SdkBase {

package/src/runtime/store/Sdk.ts

@@ -1,4 +1,4 @@
-import { IListOptions } from '../../models/Backend.js';
+import { IListOptions } from '../../models/store/Backend.js';
 import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 import { AuthSdk } from './AuthSdk.js';

package/src/runtime/store/SharedSdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { IListOptions, IListResponse } from '../../models/store/Backend.js';
 import { Kind as ProjectKind } from '../../models/Project.js';
 import { Kind as WorkspaceKind } from '../../models/Workspace.js';
 import { IFile } from '../../models/store/File.js';

package/src/runtime/store/UsersSdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { IListOptions, IListResponse } from '../../models/store/Backend.js';
 import { IUser } from '../../models/store/User.js';
 
 export class UsersSdk extends SdkBase {

package/build/src/models/Backend.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Backend.js.map

package/build/src/models/Backend.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Backend.js","sourceRoot":"","sources":["../../../src/models/Backend.ts"],"names":[],"mappings":""}