@api-client/core 0.8.4 → 0.8.6

package/data/models/expanded-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/flattened-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/multiple-servers.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-3-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-date.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-types.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/oas-unions.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/petstore.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "OAS 3.0"
 },

package/data/models/raml-date.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/recursive.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },

package/data/models/schema-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },
@@ -13128,7 +13128,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {

package/data/models/secured-api.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },
@@ -16122,7 +16122,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16168,7 +16168,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16204,7 +16204,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16258,7 +16258,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16304,7 +16304,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16340,7 +16340,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16381,7 +16381,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16422,7 +16422,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16458,7 +16458,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16499,7 +16499,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16540,7 +16540,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16576,7 +16576,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16612,7 +16612,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16648,7 +16648,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -16681,7 +16681,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {

package/data/models/tracked-to-linked.json

@@ -5,7 +5,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:transformed": true,
 "doc:sourceSpec": "RAML 1.0"
 },
@@ -1737,7 +1737,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -1765,7 +1765,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {
@@ -1793,7 +1793,7 @@
 "@type": [
 "doc:APIContractProcessingData"
 ],
-"apiContract:modelVersion": "3.8.0",
+"apiContract:modelVersion": "3.8.1",
 "doc:sourceSpec": "RAML 1.0"
 },
 {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.8.4",
+  "version": "0.8.6",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",
@@ -59,7 +59,7 @@
     "mocha": "^10.0.0",
     "nock": "^13.2.7",
     "oauth2-mock-server": "^5.0.0",
-    "sinon": "^14.0.0",
+    "sinon": "^15.0.1",
     "source-map-support": "^0.5.21",
     "ssl-root-cas": "^1.3.1",
     "ts-node": "^10.4.0",

package/src/Platform.ts

@@ -6,6 +6,11 @@ export const hasFormData: boolean = typeof FormData === 'function';
  * Whether the current platform has Blob interface
  */
 export const hasBlob: boolean = typeof Blob === 'function';
+
+/**
+ * Whether the current platform has File interface
+ */
+export const hasFile: boolean = typeof File === 'function';
 /**
  * Whether the current platform has the `Buffer` interface.
  */

package/src/events/BaseEvents.ts

@@ -298,8 +298,13 @@ export interface ContextListResult<T> {
   /**
    * Next page token to be used with pagination.
    * It is not set when the query has not returned any results.
+   * @deprecated Use `cursor` instead.
    */
   nextPageToken?: string;
+  /**
+   * The cursor to use with the next query. It has the list state encoded in it.
+   */
+  cursor?: string;
   /**
    * The list of items in the response.
    * May be empty array when there was no more results.
@@ -317,12 +322,40 @@ export interface ContextListOptions {
   limit?: number;
   /**
    * A string that should be used with the pagination.
+   * @deprecated Use `cursor` instead.
    */
   nextPageToken?: string;
   /**
-   * Optional parent for the query.
+   * Page cursor to use with the query. This is returned by the 
+   */
+  cursor?: string;
+  /**
+   * Optional general purpose parent for the query.
    */
   parent?: string;
+  /**
+   * Supported by some endpoints. When set it performs a query on the data store.
+   */
+  query?: string;
+  /**
+   * Only with the `query` property. Tells the system in which fields to search for the query term.
+   */
+  queryField?: string[];
+  /**
+   * Whether to use the `descending` order.
+   */
+  descending?: boolean;
+  /**
+   * General purpose type property to filer the results.
+   * This is used, for example, by the history store to list history for a specific type of requests,
+   */
+  type?: string;
+  /**
+   * Used when synchronizing data in the local store with the data stored in the net-store.
+   * The timestamp when the last synchronization was performed. The resulting array will contain only items that 
+   * have been updated since that date.
+   */
+  since?: number;
 }
 
 export class ContextListEvent<T> extends ContextEvent<ContextListOptions, ContextListResult<T>> {

package/src/lib/transformers/PayloadSerializer.ts

@@ -1,4 +1,4 @@
-import { hasBlob, hasBuffer, hasFormData } from '../../Platform.js';
+import { hasBlob, hasBuffer, hasFile, hasFormData } from '../../Platform.js';
 
 export type PayloadTypes = 'string' | 'file' | 'blob' | 'buffer' | 'arraybuffer' | 'formdata' | 'x-www-form-urlencoded';
 export type DeserializedPayload = string | Blob | File | FormData | Buffer | ArrayBuffer | undefined;
@@ -137,7 +137,7 @@ export class PayloadSerializer {
     //   return payload;
     // }
 
-    if (hasBlob && payload instanceof File) {
+    if (hasFile && payload instanceof File) {
       return PayloadSerializer.stringifyFile(payload);
     }
     if (hasBlob && payload instanceof Blob) {
@@ -266,7 +266,7 @@ export class PayloadSerializer {
     let value: ISafePayload;
     // API Client adds the "blob" when adding a text value with a mime type.
     // This is recognized by the UI to restore the entry as the text and not a file.
-    if (file instanceof File && file.name !== 'blob') {
+    if (hasFile && file instanceof File && file.name !== 'blob') {
       value = await PayloadSerializer.stringifyFile(file);
     } else {
       value = await PayloadSerializer.stringifyBlob(file);
@@ -289,7 +289,7 @@ export class PayloadSerializer {
     if (typeof payload === 'string') {
       return payload;
     }
-    if (hasBuffer && !hasBlob) {
+    if (hasBuffer && (!hasBlob || !hasFile)) {
       // we are in the nodejs environment. 
       // We mostly gonna return a Buffer here.
       switch (payload.type) {
@@ -298,6 +298,7 @@ export class PayloadSerializer {
         case 'blob': return PayloadSerializer.deserializeBlobBuffer(payload);
         case 'buffer': return PayloadSerializer.deserializeBuffer(payload.data as number[]);
         case 'arraybuffer': return PayloadSerializer.deserializeArrayBufferBuffer(payload.data as number[]);
+        // generally speaking in this ecosystem we don't ever need to read FormData from a request/response in Node.
         case 'formdata': return undefined;
         default: return undefined;
       }

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

@@ -80,7 +80,7 @@ export class CoreEngine extends HttpEngine {
       const message = await this.prepareMessage();
       await this.writeMessage(message);
     } catch (cause) {
-      const e = cause as any;
+      const e = cause as SerializableError;
       const err = new SerializableError(e.message, { cause: e });
       if (e.code || e.code === 0) {
         err.code = e.code as string;
@@ -259,6 +259,9 @@ export class CoreEngine extends HttpEngine {
       options.checkServerIdentity = this._checkServerIdentity.bind(this);
     } else {
       options.rejectUnauthorized = false;
+      options.checkServerIdentity = (): Error | undefined => {
+        return undefined;
+      }
       // target.requestOCSP = false;
     }
     const certs = this.opts.certificates;
@@ -412,7 +415,7 @@ export class CoreEngine extends HttpEngine {
       headers.set('Authorization', `NTLM ${msg.toBase64()}`);
       headers.set('Connection', 'keep-alive');
     } else if (this.auth && this.auth.state === 1) {
-      const msg = auth.createMessage3(this.auth.challengeHeader!, this.uri.host);
+      const msg = auth.createMessage3(this.auth.challengeHeader as string, this.uri.host);
       this.auth.state = 2;
       headers.set('Authorization', `NTLM ${msg.toBase64()}`);
     }
@@ -651,8 +654,9 @@ export class CoreEngine extends HttpEngine {
     if (msg && msg.indexOf('\n') !== -1) {
       msg = msg.split('\n')[0];
     }
-    this.currentResponse!.status = typedStatus;
-    this.currentResponse!.statusText = msg;
+    const cr = this.currentResponse as Response;
+    cr.status = typedStatus;
+    cr.statusText = msg;
     this.logger.info('Received status', typedStatus, msg);
     this.state = RequestState.Headers;
     return data;