@engineers/gcloud-storage 0.0.0-temp → 0.0.8-temp

package/index.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Bucket, CreateBucketRequest, File, SaveOptions, Storage, UploadResponse, StorageOptions as _StorageOptions } from '@google-cloud/storage';
+import { PathLike } from 'node:fs';
+export interface StorageOptions extends _StorageOptions {
+    bucket: string;
+    rootDir?: string;
+}
+export interface UploadOptions {
+    destination: string;
+}
+export interface DownloadOptions {
+    destination?: string;
+    encoding?: BufferEncoding | null;
+}
+export interface DeleteOptions {
+    ignoreNotFound?: boolean;
+}
+export interface ExistsOptions {
+}
+export interface CreateBucketMeta extends CreateBucketRequest {
+    labels?: {
+        [key: string]: string;
+    };
+}
+export default class {
+    storage: Storage;
+    bucket: Bucket;
+    private baseDir;
+    constructor(options: StorageOptions);
+    upload(path: PathLike, options?: UploadOptions | string): Promise<UploadResponse | void>;
+    download(file: PathLike | File, options?: DownloadOptions | string): Promise<Buffer | string | Array<any> | {
+        [key: string]: any;
+    } | void>;
+    downloadAll(destination: PathLike, directory?: PathLike, filter?: RegExp | ((file: string) => boolean), options?: {
+        start?: number;
+        end?: number;
+    }): Promise<{
+        [key: string]: boolean;
+    }>;
+    write(path: PathLike, content?: any, options?: SaveOptions): Promise<any>;
+    read(file: PathLike | File, options?: DownloadOptions | string): Promise<string | void | any[] | Buffer | {
+        [key: string]: any;
+    }>;
+    delete(path: PathLike, options?: DeleteOptions): Promise<any>;
+    exists(path: PathLike, options?: ExistsOptions): Promise<boolean>;
+    create(metaData?: CreateBucketMeta): Promise<import("@google-cloud/storage").CreateBucketResponse>;
+}

package/{index.mjs → index.js}

@@ -3,7 +3,7 @@ import {
   Storage
 } from "@google-cloud/storage";
 import { mkdirSync } from "node:fs";
-import { dirname } from "node:path";
+import { dirname, resolve } from "node:path";
 import stripJsonComments from "strip-json-comments";
 import { URL } from "node:url";
 
@@ -107,7 +107,7 @@ var plainLink = toRegExp(
 var src_default = class {
   storage;
   bucket;
-  rootPath;
+  baseDir;
   /**
    * creates a new bucket
    *
@@ -126,7 +126,7 @@ var src_default = class {
     if (opts.bucket.includes("/")) {
       let parts = opts.bucket.split("/");
       opts.bucket = parts.shift();
-      this.rootPath = parts.join("/");
+      this.baseDir = parts.join("/") + opts.rootDir ? "/" + opts.rootDir : "";
     }
     this.bucket = this.storage.bucket(opts.bucket);
   }
@@ -144,8 +144,8 @@ var src_default = class {
     let opts = {
       ...typeof options === "string" ? { destination: options } : options || {}
     };
-    if (this.rootPath && opts?.destination) {
-      opts.destination = `${this.rootPath}/${opts.destination}`;
+    if (this.baseDir && opts?.destination) {
+      opts.destination = `${this.baseDir}/${opts.destination}`;
     }
     return this.bucket.upload(path.toString(), opts);
   }
@@ -166,7 +166,7 @@ var src_default = class {
   download(file, options) {
     if (typeof file === "string" || file instanceof Buffer || file instanceof URL) {
       file = this.bucket.file(
-        this.rootPath ? `${this.rootPath}/${file.toString()}` : file.toString()
+        this.baseDir ? `${this.baseDir}/${file.toString()}` : file.toString()
       );
     }
     let opts = Object.assign(
@@ -211,14 +211,14 @@ var src_default = class {
     } else if (filter instanceof RegExp) {
       filter = (file) => filter.test(file);
     }
-    if (this.rootPath) {
-      directory = `${this.rootPath}/${directory}`;
+    if (this.baseDir) {
+      directory = `${this.baseDir}/${directory}`;
     }
     return this.bucket.getFiles({ prefix: directory?.toString() }).then((files) => files[0].filter((file) => filter(file.name))).then(
       (files) => Promise.all(
         files.slice(options.start, options.end).map(
           (file) => this.download(file, {
-            destination: `${destination.toString()}/${file.name}`
+            destination: resolve(`${destination.toString()}/${file.name}`)
           }).then((result) => {
             results[file.name] = true;
           }).catch((error) => {
@@ -237,19 +237,23 @@ var src_default = class {
    * @returns the original content
    */
   write(path, content = "", options) {
-    if (this.rootPath) {
-      path = `${this.rootPath}/${path}`;
+    if (this.baseDir) {
+      path = `${this.baseDir}/${path}`;
     }
     return this.bucket.file(path.toString()).save(
       ["array", "object"].includes(objectType(content)) ? JSON.stringify(content) : content,
       options
     ).then(() => content);
   }
+  /** an alias to download() to be compatible with node:fs functions */
+  read(file, options) {
+    return this.download(file, options);
+  }
   // eslint-disable-next-line no-secrets/no-secrets
   // https://stackoverflow.com/a/64539948/12577650
   delete(path, options) {
-    if (this.rootPath) {
-      path = `${this.rootPath}/${path}`;
+    if (this.baseDir) {
+      path = `${this.baseDir}/${path}`;
     }
     return this.bucket.file(path.toString()).delete(options);
   }
@@ -264,8 +268,8 @@ var src_default = class {
    * @returns boolean
    */
   exists(path, options) {
-    if (this.rootPath) {
-      path = `/${this.rootPath}/${path}`;
+    if (this.baseDir) {
+      path = `/${this.baseDir}/${path}`;
     }
     return this.bucket.file(path.toString()).exists(options).then((result) => result[0]);
   }
@@ -274,11 +278,11 @@ var src_default = class {
    * add the desired labels as key-value pairs to metaData.labels
    * https://cloud.google.com/storage/docs/using-bucket-labels#storage-modify-bucket-label-nodejs
    *
-   * @param bucketName
    * @param metaData
    * @returns
    */
-  create(bucketName, metaData) {
+  create(metaData) {
+    let bucketName = this.bucket.name;
     let { labels, ...meta } = metaData || {};
     return this.storage.createBucket(bucketName, meta).then((result) => {
       this.bucket.name = bucketName;

package/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,32 +1,12 @@
 {
   "name": "@engineers/gcloud-storage",
-  "version": "0.0.0-temp",
+  "version": "0.0.8-temp",
   "type": "module",
   "private": false,
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/its-dibo/dibo.git"
-  },
-  "homepage": "https://github.com/its-dibo/dibo#readme",
-  "bugs": {
-    "url": "https://github.com/its-dibo/dibo/issues",
-    "email": "sh.eldeeb.2010+github@gmail.com"
-  },
-  "license": "MIT",
-  "author": "Sherif Eldeeb <sh.eldeeb.2010+github@gmail.com> (https://github.com/its-dibo)",
-  "funding": [
-    {
-      "type": "paypal",
-      "url": "https://paypal.me/group99001"
-    },
-    {
-      "type": "patreon",
-      "url": "https://www.patreon.com/GoogleDev"
-    }
-  ],
   "description": "google cloud storage",
   "dependencies": {
-    "@google-cloud/storage": "^6.10.1"
+    "@google-cloud/storage": "^6.10.1",
+    "strip-json-comments": "^5.0.1"
   },
   "imports": {
     "#*": "./*"