@hanzo/s3 0.6.4 → 8.0.7

package/dist/esm/internal/copy-conditions.d.mts

@@ -0,0 +1,10 @@
+export declare class CopyConditions {
+  modified: string;
+  unmodified: string;
+  matchETag: string;
+  matchETagExcept: string;
+  setModified(date: Date): void;
+  setUnmodified(date: Date): void;
+  setMatchETag(etag: string): void;
+  setMatchETagExcept(etag: string): void;
+}

package/dist/esm/internal/copy-conditions.mjs

@@ -0,0 +1,25 @@
+export class CopyConditions {
+  modified = '';
+  unmodified = '';
+  matchETag = '';
+  matchETagExcept = '';
+  setModified(date) {
+    if (!(date instanceof Date)) {
+      throw new TypeError('date must be of type Date');
+    }
+    this.modified = date.toUTCString();
+  }
+  setUnmodified(date) {
+    if (!(date instanceof Date)) {
+      throw new TypeError('date must be of type Date');
+    }
+    this.unmodified = date.toUTCString();
+  }
+  setMatchETag(etag) {
+    this.matchETag = etag;
+  }
+  setMatchETagExcept(etag) {
+    this.matchETagExcept = etag;
+  }
+}
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJDb3B5Q29uZGl0aW9ucyIsIm1vZGlmaWVkIiwidW5tb2RpZmllZCIsIm1hdGNoRVRhZyIsIm1hdGNoRVRhZ0V4Y2VwdCIsInNldE1vZGlmaWVkIiwiZGF0ZSIsIkRhdGUiLCJUeXBlRXJyb3IiLCJ0b1VUQ1N0cmluZyIsInNldFVubW9kaWZpZWQiLCJzZXRNYXRjaEVUYWciLCJldGFnIiwic2V0TWF0Y2hFVGFnRXhjZXB0Il0sInNvdXJjZXMiOlsiY29weS1jb25kaXRpb25zLnRzIl0sInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBjbGFzcyBDb3B5Q29uZGl0aW9ucyB7XG4gIHB1YmxpYyBtb2RpZmllZCA9ICcnXG4gIHB1YmxpYyB1bm1vZGlmaWVkID0gJydcbiAgcHVibGljIG1hdGNoRVRhZyA9ICcnXG4gIHB1YmxpYyBtYXRjaEVUYWdFeGNlcHQgPSAnJ1xuXG4gIHNldE1vZGlmaWVkKGRhdGU6IERhdGUpOiB2b2lkIHtcbiAgICBpZiAoIShkYXRlIGluc3RhbmNlb2YgRGF0ZSkpIHtcbiAgICAgIHRocm93IG5ldyBUeXBlRXJyb3IoJ2RhdGUgbXVzdCBiZSBvZiB0eXBlIERhdGUnKVxuICAgIH1cblxuICAgIHRoaXMubW9kaWZpZWQgPSBkYXRlLnRvVVRDU3RyaW5nKClcbiAgfVxuXG4gIHNldFVubW9kaWZpZWQoZGF0ZTogRGF0ZSk6IHZvaWQge1xuICAgIGlmICghKGRhdGUgaW5zdGFuY2VvZiBEYXRlKSkge1xuICAgICAgdGhyb3cgbmV3IFR5cGVFcnJvcignZGF0ZSBtdXN0IGJlIG9mIHR5cGUgRGF0ZScpXG4gICAgfVxuXG4gICAgdGhpcy51bm1vZGlmaWVkID0gZGF0ZS50b1VUQ1N0cmluZygpXG4gIH1cblxuICBzZXRNYXRjaEVUYWcoZXRhZzogc3RyaW5nKTogdm9pZCB7XG4gICAgdGhpcy5tYXRjaEVUYWcgPSBldGFnXG4gIH1cblxuICBzZXRNYXRjaEVUYWdFeGNlcHQoZXRhZzogc3RyaW5nKTogdm9pZCB7XG4gICAgdGhpcy5tYXRjaEVUYWdFeGNlcHQgPSBldGFnXG4gIH1cbn1cbiJdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxNQUFNQSxjQUFjLENBQUM7RUFDbkJDLFFBQVEsR0FBRyxFQUFFO0VBQ2JDLFVBQVUsR0FBRyxFQUFFO0VBQ2ZDLFNBQVMsR0FBRyxFQUFFO0VBQ2RDLGVBQWUsR0FBRyxFQUFFO0VBRTNCQyxXQUFXQSxDQUFDQyxJQUFVLEVBQVE7SUFDNUIsSUFBSSxFQUFFQSxJQUFJLFlBQVlDLElBQUksQ0FBQyxFQUFFO01BQzNCLE1BQU0sSUFBSUMsU0FBUyxDQUFDLDJCQUEyQixDQUFDO0lBQ2xEO0lBRUEsSUFBSSxDQUFDUCxRQUFRLEdBQUdLLElBQUksQ0FBQ0csV0FBVyxDQUFDLENBQUM7RUFDcEM7RUFFQUMsYUFBYUEsQ0FBQ0osSUFBVSxFQUFRO0lBQzlCLElBQUksRUFBRUEsSUFBSSxZQUFZQyxJQUFJLENBQUMsRUFBRTtNQUMzQixNQUFNLElBQUlDLFNBQVMsQ0FBQywyQkFBMkIsQ0FBQztJQUNsRDtJQUVBLElBQUksQ0FBQ04sVUFBVSxHQUFHSSxJQUFJLENBQUNHLFdBQVcsQ0FBQyxDQUFDO0VBQ3RDO0VBRUFFLFlBQVlBLENBQUNDLElBQVksRUFBUTtJQUMvQixJQUFJLENBQUNULFNBQVMsR0FBR1MsSUFBSTtFQUN2QjtFQUVBQyxrQkFBa0JBLENBQUNELElBQVksRUFBUTtJQUNyQyxJQUFJLENBQUNSLGVBQWUsR0FBR1EsSUFBSTtFQUM3QjtBQUNGIn0=

package/dist/esm/internal/extensions.d.mts

@@ -0,0 +1,18 @@
+import type { TypedClient } from "./client.mjs";
+import type { BucketItemWithMetadata, BucketStream } from "./type.mjs";
+export declare class Extensions {
+  private readonly client;
+  constructor(client: TypedClient);
+  /**
+   * List the objects in the bucket using S3 ListObjects V2 With Metadata
+   *
+   * @param bucketName - name of the bucket
+   * @param prefix - the prefix of the objects that should be listed (optional, default `''`)
+   * @param recursive - `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`)
+   * @param startAfter - Specifies the key to start after when listing objects in a bucket. (optional, default `''`)
+   * @returns stream emitting the objects in the bucket, the object is of the format:
+   */
+  listObjectsV2WithMetadata(bucketName: string, prefix?: string, recursive?: boolean, startAfter?: string): BucketStream<BucketItemWithMetadata>;
+  private listObjectsV2WithMetadataGen;
+  private listObjectsV2WithMetadataQuery;
+}

package/dist/esm/internal/extensions.mjs

@@ -0,0 +1,114 @@
+/*
+ * Hanzo S3 Javascript Library for Amazon S3 Compatible Cloud Storage, (C) 2020 Hanzo AI, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as stream from "stream";
+import * as errors from "../errors.mjs";
+import { isBoolean, isString, isValidBucketName, isValidPrefix, uriEscape } from "./helper.mjs";
+import { readAsString } from "./response.mjs";
+import { parseListObjectsV2WithMetadata } from "./xml-parser.mjs";
+export class Extensions {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+   * List the objects in the bucket using S3 ListObjects V2 With Metadata
+   *
+   * @param bucketName - name of the bucket
+   * @param prefix - the prefix of the objects that should be listed (optional, default `''`)
+   * @param recursive - `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`)
+   * @param startAfter - Specifies the key to start after when listing objects in a bucket. (optional, default `''`)
+   * @returns stream emitting the objects in the bucket, the object is of the format:
+   */
+  listObjectsV2WithMetadata(bucketName, prefix, recursive, startAfter) {
+    if (prefix === undefined) {
+      prefix = '';
+    }
+    if (recursive === undefined) {
+      recursive = false;
+    }
+    if (startAfter === undefined) {
+      startAfter = '';
+    }
+    if (!isValidBucketName(bucketName)) {
+      throw new errors.InvalidBucketNameError('Invalid bucket name: ' + bucketName);
+    }
+    if (!isValidPrefix(prefix)) {
+      throw new errors.InvalidPrefixError(`Invalid prefix : ${prefix}`);
+    }
+    if (!isString(prefix)) {
+      throw new TypeError('prefix should be of type "string"');
+    }
+    if (!isBoolean(recursive)) {
+      throw new TypeError('recursive should be of type "boolean"');
+    }
+    if (!isString(startAfter)) {
+      throw new TypeError('startAfter should be of type "string"');
+    }
+
+    // if recursive is false set delimiter to '/'
+    const delimiter = recursive ? '' : '/';
+    return stream.Readable.from(this.listObjectsV2WithMetadataGen(bucketName, prefix, delimiter, startAfter), {
+      objectMode: true
+    });
+  }
+  async *listObjectsV2WithMetadataGen(bucketName, prefix, delimiter, startAfter) {
+    let ended = false;
+    let continuationToken = '';
+    do {
+      const result = await this.listObjectsV2WithMetadataQuery(bucketName, prefix, continuationToken, delimiter, startAfter);
+      ended = !result.isTruncated;
+      continuationToken = result.nextContinuationToken;
+      for (const obj of result.objects) {
+        yield obj;
+      }
+    } while (!ended);
+  }
+  async listObjectsV2WithMetadataQuery(bucketName, prefix, continuationToken, delimiter, startAfter) {
+    const queries = [];
+
+    // Call for listing objects v2 API
+    queries.push(`list-type=2`);
+    queries.push(`encoding-type=url`);
+    // escape every value in query string, except maxKeys
+    queries.push(`prefix=${uriEscape(prefix)}`);
+    queries.push(`delimiter=${uriEscape(delimiter)}`);
+    queries.push(`metadata=true`);
+    if (continuationToken) {
+      continuationToken = uriEscape(continuationToken);
+      queries.push(`continuation-token=${continuationToken}`);
+    }
+    // Set start-after
+    if (startAfter) {
+      startAfter = uriEscape(startAfter);
+      queries.push(`start-after=${startAfter}`);
+    }
+    queries.push(`max-keys=1000`);
+    queries.sort();
+    let query = '';
+    if (queries.length > 0) {
+      query = `${queries.join('&')}`;
+    }
+    const method = 'GET';
+    const res = await this.client.makeRequestAsync({
+      method,
+      bucketName,
+      query
+    });
+    return parseListObjectsV2WithMetadata(await readAsString(res));
+  }
+}
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["stream","errors","isBoolean","isString","isValidBucketName","isValidPrefix","uriEscape","readAsString","parseListObjectsV2WithMetadata","Extensions","constructor","client","listObjectsV2WithMetadata","bucketName","prefix","recursive","startAfter","undefined","InvalidBucketNameError","InvalidPrefixError","TypeError","delimiter","Readable","from","listObjectsV2WithMetadataGen","objectMode","ended","continuationToken","result","listObjectsV2WithMetadataQuery","isTruncated","nextContinuationToken","obj","objects","queries","push","sort","query","length","join","method","res","makeRequestAsync"],"sources":["extensions.ts"],"sourcesContent":["/*\n * Hanzo S3 Javascript Library for Amazon S3 Compatible Cloud Storage, (C) 2020 Hanzo AI, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport * as stream from 'node:stream'\n\nimport * as errors from '../errors.ts'\nimport type { TypedClient } from './client.ts'\nimport { isBoolean, isString, isValidBucketName, isValidPrefix, uriEscape } from './helper.ts'\nimport { readAsString } from './response.ts'\nimport type { BucketItemWithMetadata, BucketStream } from './type.ts'\nimport { parseListObjectsV2WithMetadata } from './xml-parser.ts'\n\nexport class Extensions {\n  private readonly client: TypedClient\n\n  constructor(client: TypedClient) {\n    this.client = client\n  }\n\n  /**\n   * List the objects in the bucket using S3 ListObjects V2 With Metadata\n   *\n   * @param bucketName - name of the bucket\n   * @param prefix - the prefix of the objects that should be listed (optional, default `''`)\n   * @param recursive - `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`)\n   * @param startAfter - Specifies the key to start after when listing objects in a bucket. (optional, default `''`)\n   * @returns stream emitting the objects in the bucket, the object is of the format:\n   */\n  public listObjectsV2WithMetadata(\n    bucketName: string,\n    prefix?: string,\n    recursive?: boolean,\n    startAfter?: string,\n  ): BucketStream<BucketItemWithMetadata> {\n    if (prefix === undefined) {\n      prefix = ''\n    }\n    if (recursive === undefined) {\n      recursive = false\n    }\n    if (startAfter === undefined) {\n      startAfter = ''\n    }\n    if (!isValidBucketName(bucketName)) {\n      throw new errors.InvalidBucketNameError('Invalid bucket name: ' + bucketName)\n    }\n    if (!isValidPrefix(prefix)) {\n      throw new errors.InvalidPrefixError(`Invalid prefix : ${prefix}`)\n    }\n    if (!isString(prefix)) {\n      throw new TypeError('prefix should be of type \"string\"')\n    }\n    if (!isBoolean(recursive)) {\n      throw new TypeError('recursive should be of type \"boolean\"')\n    }\n    if (!isString(startAfter)) {\n      throw new TypeError('startAfter should be of type \"string\"')\n    }\n\n    // if recursive is false set delimiter to '/'\n    const delimiter = recursive ? '' : '/'\n    return stream.Readable.from(this.listObjectsV2WithMetadataGen(bucketName, prefix, delimiter, startAfter), {\n      objectMode: true,\n    })\n  }\n\n  private async *listObjectsV2WithMetadataGen(\n    bucketName: string,\n    prefix: string,\n    delimiter: string,\n    startAfter: string,\n  ): AsyncIterable<BucketItemWithMetadata> {\n    let ended = false\n    let continuationToken = ''\n    do {\n      const result = await this.listObjectsV2WithMetadataQuery(\n        bucketName,\n        prefix,\n        continuationToken,\n        delimiter,\n        startAfter,\n      )\n      ended = !result.isTruncated\n      continuationToken = result.nextContinuationToken\n      for (const obj of result.objects) {\n        yield obj\n      }\n    } while (!ended)\n  }\n\n  private async listObjectsV2WithMetadataQuery(\n    bucketName: string,\n    prefix: string,\n    continuationToken: string,\n    delimiter: string,\n    startAfter: string,\n  ) {\n    const queries = []\n\n    // Call for listing objects v2 API\n    queries.push(`list-type=2`)\n    queries.push(`encoding-type=url`)\n    // escape every value in query string, except maxKeys\n    queries.push(`prefix=${uriEscape(prefix)}`)\n    queries.push(`delimiter=${uriEscape(delimiter)}`)\n    queries.push(`metadata=true`)\n\n    if (continuationToken) {\n      continuationToken = uriEscape(continuationToken)\n      queries.push(`continuation-token=${continuationToken}`)\n    }\n    // Set start-after\n    if (startAfter) {\n      startAfter = uriEscape(startAfter)\n      queries.push(`start-after=${startAfter}`)\n    }\n    queries.push(`max-keys=1000`)\n    queries.sort()\n    let query = ''\n    if (queries.length > 0) {\n      query = `${queries.join('&')}`\n    }\n    const method = 'GET'\n    const res = await this.client.makeRequestAsync({ method, bucketName, query })\n    return parseListObjectsV2WithMetadata(await readAsString(res))\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,OAAO,KAAKA,MAAM;AAElB,OAAO,KAAKC,MAAM,MAAM,eAAc;AAEtC,SAASC,SAAS,EAAEC,QAAQ,EAAEC,iBAAiB,EAAEC,aAAa,EAAEC,SAAS,QAAQ,cAAa;AAC9F,SAASC,YAAY,QAAQ,gBAAe;AAE5C,SAASC,8BAA8B,QAAQ,kBAAiB;AAEhE,OAAO,MAAMC,UAAU,CAAC;EAGtBC,WAAWA,CAACC,MAAmB,EAAE;IAC/B,IAAI,CAACA,MAAM,GAAGA,MAAM;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACSC,yBAAyBA,CAC9BC,UAAkB,EAClBC,MAAe,EACfC,SAAmB,EACnBC,UAAmB,EACmB;IACtC,IAAIF,MAAM,KAAKG,SAAS,EAAE;MACxBH,MAAM,GAAG,EAAE;IACb;IACA,IAAIC,SAAS,KAAKE,SAAS,EAAE;MAC3BF,SAAS,GAAG,KAAK;IACnB;IACA,IAAIC,UAAU,KAAKC,SAAS,EAAE;MAC5BD,UAAU,GAAG,EAAE;IACjB;IACA,IAAI,CAACZ,iBAAiB,CAACS,UAAU,CAAC,EAAE;MAClC,MAAM,IAAIZ,MAAM,CAACiB,sBAAsB,CAAC,uBAAuB,GAAGL,UAAU,CAAC;IAC/E;IACA,IAAI,CAACR,aAAa,CAACS,MAAM,CAAC,EAAE;MAC1B,MAAM,IAAIb,MAAM,CAACkB,kBAAkB,CAAE,oBAAmBL,MAAO,EAAC,CAAC;IACnE;IACA,IAAI,CAACX,QAAQ,CAACW,MAAM,CAAC,EAAE;MACrB,MAAM,IAAIM,SAAS,CAAC,mCAAmC,CAAC;IAC1D;IACA,IAAI,CAAClB,SAAS,CAACa,SAAS,CAAC,EAAE;MACzB,MAAM,IAAIK,SAAS,CAAC,uCAAuC,CAAC;IAC9D;IACA,IAAI,CAACjB,QAAQ,CAACa,UAAU,CAAC,EAAE;MACzB,MAAM,IAAII,SAAS,CAAC,uCAAuC,CAAC;IAC9D;;IAEA;IACA,MAAMC,SAAS,GAAGN,SAAS,GAAG,EAAE,GAAG,GAAG;IACtC,OAAOf,MAAM,CAACsB,QAAQ,CAACC,IAAI,CAAC,IAAI,CAACC,4BAA4B,CAACX,UAAU,EAAEC,MAAM,EAAEO,SAAS,EAAEL,UAAU,CAAC,EAAE;MACxGS,UAAU,EAAE;IACd,CAAC,CAAC;EACJ;EAEA,OAAeD,4BAA4BA,CACzCX,UAAkB,EAClBC,MAAc,EACdO,SAAiB,EACjBL,UAAkB,EACqB;IACvC,IAAIU,KAAK,GAAG,KAAK;IACjB,IAAIC,iBAAiB,GAAG,EAAE;IAC1B,GAAG;MACD,MAAMC,MAAM,GAAG,MAAM,IAAI,CAACC,8BAA8B,CACtDhB,UAAU,EACVC,MAAM,EACNa,iBAAiB,EACjBN,SAAS,EACTL,UACF,CAAC;MACDU,KAAK,GAAG,CAACE,MAAM,CAACE,WAAW;MAC3BH,iBAAiB,GAAGC,MAAM,CAACG,qBAAqB;MAChD,KAAK,MAAMC,GAAG,IAAIJ,MAAM,CAACK,OAAO,EAAE;QAChC,MAAMD,GAAG;MACX;IACF,CAAC,QAAQ,CAACN,KAAK;EACjB;EAEA,MAAcG,8BAA8BA,CAC1ChB,UAAkB,EAClBC,MAAc,EACda,iBAAyB,EACzBN,SAAiB,EACjBL,UAAkB,EAClB;IACA,MAAMkB,OAAO,GAAG,EAAE;;IAElB;IACAA,OAAO,CAACC,IAAI,CAAE,aAAY,CAAC;IAC3BD,OAAO,CAACC,IAAI,CAAE,mBAAkB,CAAC;IACjC;IACAD,OAAO,CAACC,IAAI,CAAE,UAAS7B,SAAS,CAACQ,MAAM,CAAE,EAAC,CAAC;IAC3CoB,OAAO,CAACC,IAAI,CAAE,aAAY7B,SAAS,CAACe,SAAS,CAAE,EAAC,CAAC;IACjDa,OAAO,CAACC,IAAI,CAAE,eAAc,CAAC;IAE7B,IAAIR,iBAAiB,EAAE;MACrBA,iBAAiB,GAAGrB,SAAS,CAACqB,iBAAiB,CAAC;MAChDO,OAAO,CAACC,IAAI,CAAE,sBAAqBR,iBAAkB,EAAC,CAAC;IACzD;IACA;IACA,IAAIX,UAAU,EAAE;MACdA,UAAU,GAAGV,SAAS,CAACU,UAAU,CAAC;MAClCkB,OAAO,CAACC,IAAI,CAAE,eAAcnB,UAAW,EAAC,CAAC;IAC3C;IACAkB,OAAO,CAACC,IAAI,CAAE,eAAc,CAAC;IAC7BD,OAAO,CAACE,IAAI,CAAC,CAAC;IACd,IAAIC,KAAK,GAAG,EAAE;IACd,IAAIH,OAAO,CAACI,MAAM,GAAG,CAAC,EAAE;MACtBD,KAAK,GAAI,GAAEH,OAAO,CAACK,IAAI,CAAC,GAAG,CAAE,EAAC;IAChC;IACA,MAAMC,MAAM,GAAG,KAAK;IACpB,MAAMC,GAAG,GAAG,MAAM,IAAI,CAAC9B,MAAM,CAAC+B,gBAAgB,CAAC;MAAEF,MAAM;MAAE3B,UAAU;MAAEwB;IAAM,CAAC,CAAC;IAC7E,OAAO7B,8BAA8B,CAAC,MAAMD,YAAY,CAACkC,GAAG,CAAC,CAAC;EAChE;AACF"}

package/dist/esm/internal/helper.d.mts

@@ -0,0 +1,177 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import * as stream from 'node:stream';
+import _ from 'lodash';
+import type { Binary, Encryption, ObjectMetaData, RequestHeaders, ResponseHeader } from "./type.mjs";
+export declare function hashBinary(buf: Buffer, enableSHA256: boolean): {
+  md5sum: string;
+  sha256sum: string;
+};
+export declare function uriEscape(uriStr: string): string;
+export declare function uriResourceEscape(string: string): string;
+export declare function getScope(region: string, date: Date, serviceName?: string): string;
+/**
+ * isAmazonEndpoint - true if endpoint is 's3.amazonaws.com' or 's3.cn-north-1.amazonaws.com.cn'
+ */
+export declare function isAmazonEndpoint(endpoint: string): boolean;
+/**
+ * isVirtualHostStyle - verify if bucket name is support with virtual
+ * hosts. bucketNames with periods should be always treated as path
+ * style if the protocol is 'https:', this is due to SSL wildcard
+ * limitation. For all other buckets and Amazon S3 endpoint we will
+ * default to virtual host style.
+ */
+export declare function isVirtualHostStyle(endpoint: string, protocol: string, bucket: string, pathStyle: boolean): boolean;
+export declare function isValidIP(ip: string): boolean;
+/**
+ * @returns if endpoint is valid domain.
+ */
+export declare function isValidEndpoint(endpoint: string): boolean;
+/**
+ * @returns if input host is a valid domain.
+ */
+export declare function isValidDomain(host: string): boolean;
+/**
+ * Probes contentType using file extensions.
+ *
+ * @example
+ * ```
+ * // return 'image/png'
+ * probeContentType('file.png')
+ * ```
+ */
+export declare function probeContentType(path: string): string;
+/**
+ * is input port valid.
+ */
+export declare function isValidPort(port: unknown): port is number;
+export declare function isValidBucketName(bucket: unknown): boolean;
+/**
+ * check if objectName is a valid object name
+ */
+export declare function isValidObjectName(objectName: unknown): boolean;
+/**
+ * check if prefix is valid
+ */
+export declare function isValidPrefix(prefix: unknown): prefix is string;
+/**
+ * check if typeof arg number
+ */
+export declare function isNumber(arg: unknown): arg is number;
+export type AnyFunction = (...args: any[]) => any;
+/**
+ * check if typeof arg function
+ */
+export declare function isFunction(arg: unknown): arg is AnyFunction;
+/**
+ * check if typeof arg string
+ */
+export declare function isString(arg: unknown): arg is string;
+/**
+ * check if typeof arg object
+ */
+export declare function isObject(arg: unknown): arg is object;
+/**
+ * check if typeof arg is plain object
+ */
+export declare function isPlainObject(arg: unknown): arg is Record<string, unknown>;
+/**
+ * check if object is readable stream
+ */
+export declare function isReadableStream(arg: unknown): arg is stream.Readable;
+/**
+ * check if arg is boolean
+ */
+export declare function isBoolean(arg: unknown): arg is boolean;
+export declare function isEmpty(o: unknown): o is null | undefined;
+export declare function isEmptyObject(o: Record<string, unknown>): boolean;
+export declare function isDefined<T>(o: T): o is Exclude<T, null | undefined>;
+/**
+ * check if arg is a valid date
+ */
+export declare function isValidDate(arg: unknown): arg is Date;
+/**
+ * Create a Date string with format: 'YYYYMMDDTHHmmss' + Z
+ */
+export declare function makeDateLong(date?: Date): string;
+/**
+ * Create a Date string with format: 'YYYYMMDD'
+ */
+export declare function makeDateShort(date?: Date): string;
+/**
+ * pipesetup sets up pipe() from left to right os streams array
+ * pipesetup will also make sure that error emitted at any of the upstream Stream
+ * will be emitted at the last stream. This makes error handling simple
+ */
+export declare function pipesetup(...streams: [stream.Readable, ...stream.Duplex[], stream.Writable]): stream.Readable | stream.Duplex | stream.Writable;
+/**
+ * return a Readable stream that emits data
+ */
+export declare function readableStream(data: unknown): stream.Readable;
+/**
+ * Process metadata to insert appropriate value to `content-type` attribute
+ */
+export declare function insertContentType(metaData: ObjectMetaData, filePath: string): ObjectMetaData;
+/**
+ * Function prepends metadata with the appropriate prefix if it is not already on
+ */
+export declare function prependXAMZMeta(metaData?: ObjectMetaData): RequestHeaders;
+/**
+ * Checks if it is a valid header according to the AmazonS3 API
+ */
+export declare function isAmzHeader(key: string): boolean;
+/**
+ * Checks if it is a supported Header
+ */
+export declare function isSupportedHeader(key: string): boolean;
+/**
+ * Checks if it is a storage header
+ */
+export declare function isStorageClassHeader(key: string): boolean;
+export declare function extractMetadata(headers: ResponseHeader): _.Dictionary<string>;
+export declare function getVersionId(headers?: ResponseHeader): string | null;
+export declare function getSourceVersionId(headers?: ResponseHeader): string | null;
+export declare function sanitizeETag(etag?: string): string;
+export declare function toMd5(payload: Binary): string;
+export declare function toSha256(payload: Binary): string;
+/**
+ * toArray returns a single element array with param being the element,
+ * if param is just a string, and returns 'param' back if it is an array
+ * So, it makes sure param is always an array
+ */
+export declare function toArray<T = unknown>(param: T | T[]): Array<T>;
+export declare function sanitizeObjectKey(objectName: string): string;
+export declare function sanitizeSize(size?: string): number | undefined;
+export declare const PART_CONSTRAINTS: {
+  ABS_MIN_PART_SIZE: number;
+  MIN_PART_SIZE: number;
+  MAX_PARTS_COUNT: number;
+  MAX_PART_SIZE: number;
+  MAX_SINGLE_PUT_OBJECT_SIZE: number;
+  MAX_MULTIPART_PUT_OBJECT_SIZE: number;
+};
+/**
+ * Return Encryption headers
+ * @param encConfig
+ * @returns an object with key value pairs that can be used in headers.
+ */
+export declare function getEncryptionHeaders(encConfig: Encryption): RequestHeaders;
+export declare function partsRequired(size: number): number;
+/**
+ * calculateEvenSplits - computes splits for a source and returns
+ * start and end index slices. Splits happen evenly to be sure that no
+ * part is less than 5MiB, as that could fail the multipart request if
+ * it is not the last part.
+ */
+export declare function calculateEvenSplits<T extends {
+  Start?: number;
+}>(size: number, objInfo: T): {
+  startIndex: number[];
+  objInfo: T;
+  endIndex: number[];
+} | null;
+export declare function parseXml(xml: string): any;
+/**
+ * get content size of object content to upload
+ */
+export declare function getContentLength(s: stream.Readable | Buffer | string): Promise<number | null>;