@api-client/core 0.5.9 → 0.5.12

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/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/FilesSdk.ts

@@ -148,6 +148,44 @@ export class FilesSdk extends SdkBase {
     return data;
   }
 
+  /**
+   * Reads a number of files in a bulk operation.
+   * 
+   * @param keys The list of keys to read. When the user has no access to the file it returns undefined 
+   * in that place. It also inserts `undefined` in place of a file that doesn't exist.
+   * @param request Optional request options.
+   */
+  async readBulk(keys: string[], request: ISdkRequestOptions = {}): Promise<IListResponse<IFile|undefined>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.filesBulk());
+    const body = JSON.stringify(keys);
+    const result = await this.sdk.http.post(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to read files in bulk. ';
+    if (result.status !== 200) {
+      this.logInvalidResponse(result);
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status);
+        e.response = result.body;
+      }
+      throw e;
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
+    }
+    let data: IListResponse<IFile | undefined>;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!Array.isArray(data.data)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+
   /**
    * Patches file's meta in the store.
    * 
@@ -300,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/RouteBuilder.ts

@@ -9,6 +9,13 @@ export class RouteBuilder {
     return '/files';
   }
 
+  /**
+   * @returns The path to the /files/bulk route.
+   */
+  static filesBulk(): string {
+    return '/files/bulk';
+  }
+
   /**
    * @returns The path to the /files/[id] route.
    */