@qbraid-core/storage 0.7.0

package/README.md

@@ -0,0 +1,71 @@
+<img align="right" width="100" alt="qbraid" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid.png">
+
+# [@qbraid-core/storage](https://qbraid.github.io/qbraid-core-js/modules/_qbraid-core_storage.html)
+
+[![Stable][preview-stability]](https://qbraid.github.io/qbraid-core-js/#launch-stages)
+[![npm](https://img.shields.io/npm/v/@qbraid-core/storage?color=blue)](https://npm.im/@qbraid-core/storage)
+
+Client for the qBraid Quantum storage service.
+
+## Installation
+
+```bash
+npm install @qbraid-core/storage
+```
+
+## Usage Example
+
+### Upload a File
+
+```typescript
+import { FileStorageClient } from '@qbraid-core/storage';
+
+const client = new FileStorageClient();
+
+const filePath = 'path/to/file.txt'; // existing file on the local filesystem
+const namespace = 'my-namespace';
+const objectPath = 'server/path/to/file.txt';
+const response = await client.uploadFile(filePath, namespace, objectPath);
+
+console.log(response);
+```
+
+### Download a File
+
+```typescript
+import { FileStorageClient } from '@qbraid-core/storage';
+
+const client = new FileStorageClient();
+
+const namespace = 'my-namespace';
+const objectPath = 'server/path/to/file.txt';
+
+const downloadResponse = await client.downloadFile(namespace, objectPath);
+
+if (downloadResponse.stream) {
+  const stream = downloadResponse.stream as Readable;
+  let fileContents = '';
+
+  stream.on('data', chunk => {
+    fileContents += chunk;
+  });
+
+  stream.on('end', () => {
+    console.log('File contents:', fileContents);
+  });
+
+  stream.on('error', err => {
+    console.error('Error reading file stream:', err);
+  });
+} else if (downloadResponse.error) {
+  console.error('Error downloading file:', downloadResponse.error);
+}
+```
+
+## License
+
+This software is proprietary and subject to the terms of the [qBraid Commercial Software License](https://qbraid.github.io/qbraid-core-js/#license).
+
+[stable-stability]: https://img.shields.io/badge/stability-stable-green
+[preview-stability]: https://img.shields.io/badge/stability-preview-orange
+[deprecated-stability]: https://img.shields.io/badge/stability-deprecated-red

package/dist/src/client.d.ts

@@ -0,0 +1,7 @@
+import { QbraidSession, QbraidClient } from '@qbraid-core/base';
+import { DownloadFileResponse, UploadFileResponse } from './types';
+export declare class FileStorageClient extends QbraidClient {
+    constructor(session?: QbraidSession);
+    downloadFile(namespace: string, objectPath: string): Promise<DownloadFileResponse>;
+    uploadFile(filePath: string, namespace: string, objectPath: string, overwrite?: boolean): Promise<UploadFileResponse>;
+}

package/dist/src/client.js

@@ -0,0 +1,42 @@
+"use strict";
+// Copyright (c) 2025, qBraid Development Team
+// All rights reserved.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileStorageClient = void 0;
+const fs_1 = require("fs");
+const stream_1 = require("stream");
+const base_1 = require("@qbraid-core/base");
+const form_data_1 = __importDefault(require("form-data"));
+class FileStorageClient extends base_1.QbraidClient {
+    constructor(session) {
+        super(session);
+    }
+    async downloadFile(namespace, objectPath) {
+        const response = await this.session.client.get(`/files/download/${namespace}/${objectPath}`, { responseType: 'stream' });
+        // the response can either be a stream
+        if (response.data instanceof stream_1.Readable) {
+            return { stream: response.data };
+        }
+        // or an error message
+        return response.data;
+    }
+    async uploadFile(filePath, namespace, objectPath, overwrite = false) {
+        if (!(0, fs_1.existsSync)(filePath)) {
+            throw new Error(`File at path ${filePath} does not exist`);
+        }
+        const form = new form_data_1.default();
+        form.append('file', (0, fs_1.createReadStream)(filePath));
+        form.append('namespace', namespace);
+        form.append('objectPath', objectPath);
+        form.append('overwrite', overwrite.toString());
+        const response = await this.session.client.post('/files/upload', form, {
+            headers: form.getHeaders(),
+        });
+        return response.data;
+    }
+}
+exports.FileStorageClient = FileStorageClient;
+//# sourceMappingURL=client.js.map

package/dist/src/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;;;;AAEvB,2BAAkD;AAClD,mCAAkC;AAElC,4CAAgE;AAChE,0DAAiC;AAGjC,MAAa,iBAAkB,SAAQ,mBAAY;IACjD,YAAY,OAAuB;QACjC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,UAAkB;QACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAC5C,mBAAmB,SAAS,IAAI,UAAU,EAAE,EAC5C,EAAE,YAAY,EAAE,QAAQ,EAAE,CAC3B,CAAC;QAEF,sCAAsC;QACtC,IAAI,QAAQ,CAAC,IAAI,YAAY,iBAAQ,EAAE,CAAC;YACtC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,CAAC;QAED,sBAAsB;QACtB,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,UAAU,CACd,QAAgB,EAChB,SAAiB,EACjB,UAAkB,EAClB,YAAqB,KAAK;QAE1B,IAAI,CAAC,IAAA,eAAU,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,gBAAgB,QAAQ,iBAAiB,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAA,qBAAgB,EAAC,QAAQ,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAqB,eAAe,EAAE,IAAI,EAAE;YACzF,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;SAC3B,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF;AA1CD,8CA0CC"}

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module storage
+ */
+export { FileStorageClient } from './client';
+export type { DownloadFileResponse, UploadFileResponse } from './types';

package/dist/src/index.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright (c) 2025, qBraid Development Team
+// All rights reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileStorageClient = void 0;
+/**
+ * @module storage
+ */
+var client_1 = require("./client");
+Object.defineProperty(exports, "FileStorageClient", { enumerable: true, get: function () { return client_1.FileStorageClient; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;AAEvB;;GAEG;AAEH,mCAA6C;AAApC,2GAAA,iBAAiB,OAAA"}

package/dist/src/types.d.ts

@@ -0,0 +1,11 @@
+import { Readable } from 'stream';
+export interface DownloadFileResponse {
+    stream?: Readable;
+    error?: string;
+}
+export interface UploadFileResponse {
+    message?: string;
+    namespace?: string;
+    objectPath?: string;
+    error?: string;
+}

package/dist/src/types.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) 2025, qBraid Development Team
+// All rights reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@qbraid-core/storage",
+  "description": "Client for the qBraid file storage service.",
+  "version": "0.7.0",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "author": "qBraid Development Team",
+  "license": "Proprietary",
+  "files": [
+    "dist/src"
+  ],
+  "keywords": [
+    "qbraid",
+    "qbraid-core",
+    "qbraid-core-js",
+    "qbraid storage",
+    "qbraid cloud",
+    "qbraid api",
+    "qbraid apis",
+    "cloud",
+    "quantum",
+    "quantum computing"
+  ],
+  "repository": {
+    "type": "git",
+    "directory": "packages/storage",
+    "url": "git+https://github.com/qBraid/qbraid-core-js.git"
+  },
+  "homepage": "https://qbraid.github.io/qbraid-core-js/modules/storage.html",
+  "dependencies": {
+    "@qbraid-core/base": "0.7.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo src/*.d.ts src/*.js",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "format": "prettier --write \"src/**/*.{ts,json}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,json}\"",
+    "docs": "typedoc"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}