@autonomys/auto-drive 1.2.0 → 1.2.1

package/dist/api/calls/index.d.ts

@@ -50,6 +50,7 @@ export declare const apiCalls: {
     getObjectMetadata: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
         cid: string;
     }>) => Promise<import("..").ObjectInformation["metadata"]>;
+    getMe: (api: import("..").AutoDriveApi) => Promise<import("../models/user").UserInfo>;
     downloadObject: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
         cid: string;
     }>) => Promise<ReadableStream<Uint8Array>>;

package/dist/api/calls/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/calls/index.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,QAAQ;;;;;;;;;;;;gBAMg0B,CAAC;;;;;;qBAAgvC,CAAC;;;;;gBAAkiD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADzmH,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/calls/index.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,QAAQ;;;;;;;;;;;;gBAMg0B,CAAC;;;;;;qBAAgvC,CAAC;;;;;gBAAkiD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADzmH,CAAA"}

package/dist/api/calls/read.d.ts

@@ -2,6 +2,7 @@ import { ArgsWithoutPagination, ArgsWithPagination } from '../../utils/types';
 import { AutoDriveApi } from '../connection';
 import { PaginatedResult } from '../models/common';
 import { ObjectInformation, ObjectSummary, Scope } from '../models/objects';
+import { UserInfo } from '../models/user';
 /**
  * Retrieves the root objects based on the specified scope.
  *
@@ -96,4 +97,12 @@ export declare const getObjectOwners: (api: AutoDriveApi, query: ArgsWithoutPagi
 export declare const getObjectMetadata: (api: AutoDriveApi, query: ArgsWithoutPagination<{
     cid: string;
 }>) => Promise<ObjectInformation["metadata"]>;
+/**
+ * Get upload and download limits of the user
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @returns {Promise<UserInfo>} - A promise that resolves to the user info.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getMe: (api: AutoDriveApi) => Promise<UserInfo>;
 //# sourceMappingURL=read.d.ts.map

package/dist/api/calls/read.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../src/api/calls/read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,QACd,YAAY,SACV,kBAAkB,CAAC;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,KAC1C,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QACf,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAU3B,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAU3C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAUrC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,QACvB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAUvC,CAAA"}
+{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../src/api/calls/read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,QACd,YAAY,SACV,kBAAkB,CAAC;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,KAC1C,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QACf,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAU3B,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAU3C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAUrC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,QACvB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAUvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,QAAe,YAAY,KAAG,OAAO,CAAC,QAAQ,CAS/D,CAAA"}

package/dist/api/calls/read.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getObjectMetadata = exports.getObjectOwners = exports.getObjectUploadStatus = exports.getObject = exports.getDeleted = exports.getSharedWithMe = exports.getRoots = void 0;
+exports.getMe = exports.getObjectMetadata = exports.getObjectOwners = exports.getObjectUploadStatus = exports.getObject = exports.getDeleted = exports.getSharedWithMe = exports.getRoots = void 0;
 /**
  * Retrieves the root objects based on the specified scope.
  *
@@ -157,3 +157,20 @@ const getObjectMetadata = (api, query) => __awaiter(void 0, void 0, void 0, func
     return response.json();
 });
 exports.getObjectMetadata = getObjectMetadata;
+/**
+ * Get upload and download limits of the user
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @returns {Promise<UserInfo>} - A promise that resolves to the user info.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+const getMe = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield api.sendRequest('@me', {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get limits: ${response.statusText}`);
+    }
+    return response.json();
+});
+exports.getMe = getMe;

package/dist/api/models/user.d.ts

@@ -0,0 +1,28 @@
+export type SubscriptionGranularity = 'monthly';
+export type SubscriptionInfo = {
+    id: string;
+    organizationId: string;
+    uploadLimit: number;
+    downloadLimit: number;
+    granularity: SubscriptionGranularity;
+    pendingUploadCredits: number;
+    pendingDownloadCredits: number;
+};
+export declare enum UserRole {
+    User = "User",
+    Admin = "Admin"
+}
+export type User = {
+    oauthProvider: string;
+    oauthUserId: string;
+    role: UserRole;
+    downloadCredits: number;
+    uploadCredits: number;
+    publicId: string;
+    onboarded: true;
+};
+export type UserInfo = {
+    user: User;
+    subscription: SubscriptionInfo;
+};
+//# sourceMappingURL=user.d.ts.map

package/dist/api/models/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/api/models/user.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAAA;AAE/C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,uBAAuB,CAAA;IACpC,oBAAoB,EAAE,MAAM,CAAA;IAC5B,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,oBAAY,QAAQ;IAClB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,QAAQ,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,IAAI,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,IAAI,CAAA;IACV,YAAY,EAAE,gBAAgB,CAAA;CAC/B,CAAA"}

package/dist/api/models/user.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserRole = void 0;
+var UserRole;
+(function (UserRole) {
+    UserRole["User"] = "User";
+    UserRole["Admin"] = "Admin";
+})(UserRole || (exports.UserRole = UserRole = {}));

package/dist/api/wrappers.d.ts

@@ -1,5 +1,6 @@
 import { AutoDriveApi } from './connection';
 import { GenericFile, GenericFileWithinFolder } from './models/file';
+import { SubscriptionInfo } from './models/user';
 export type UploadFileOptions = {
     password?: string;
     compression?: boolean;
@@ -37,10 +38,26 @@ export declare const uploadFileFromInput: (api: AutoDriveApi, file: File, option
  * @param {string} [options.password] - The password for encryption (optional).
  * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
  * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
- * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
+ * @returns {Promise<string>} - The CID of the uploaded file.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
 export declare const uploadFile: (api: AutoDriveApi, file: GenericFile, options?: UploadFileOptions, uploadChunkSize?: number) => Promise<string>;
+/**
+ * Uploads an object as a JSON file to the server.
+ *
+ * This function serializes the provided object to a JSON string,
+ * and then uploads the JSON string as a file to the server.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {File | GenericFile} file - The file to be uploaded, which can be a File or a GenericFile.
+ * @param {UploadFileOptions} options - Options for the upload process.
+ * @param {string} [options.password] - The password for encryption (optional).
+ * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
+ * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
+ * @returns {Promise<string>} - The CID of the uploaded file.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export declare const uploadObjectAsJSON: (api: AutoDriveApi, object: unknown, name?: string | undefined, options?: UploadFileOptions, uploadChunkSize?: number) => Promise<string>;
 /**
  * Uploads an entire folder to the server.
  *
@@ -81,4 +98,9 @@ export declare const uploadFileWithinFolderUpload: (api: AutoDriveApi, uploadId:
  * @returns {Promise<ReadableStream<Uint8Array>>} A promise that resolves to a ReadableStream of the downloaded file.
  */
 export declare const downloadFile: (api: AutoDriveApi, cid: string, password?: string) => Promise<AsyncIterable<Buffer>>;
+export declare const getPendingCredits: (api: AutoDriveApi) => Promise<{
+    upload: number;
+    download: number;
+}>;
+export declare const getSubscriptionInfo: (api: AutoDriveApi) => Promise<SubscriptionInfo>;
 //# sourceMappingURL=wrappers.d.ts.map

package/dist/api/wrappers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wrappers.d.ts","sourceRoot":"","sources":["../../src/api/wrappers.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAA;AAGpE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CACxC,CAAA;AA6BD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,QACzB,YAAY,QACX,IAAI,YACD,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CAgDhB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,QACX,WAAW,YACR,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CA+ChB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,YACP,QAAQ,GAAG,IAAI,EAAE,+CAKxB;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,KAC1F,OAAO,CAAC,MAAM,CA2DhB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,QAClC,YAAY,YACP,MAAM,QACV,uBAAuB,oBACX,MAAM,YACf,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,KAC7C,OAAO,CAAC,MAAM,CAchB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,QAClB,YAAY,OACZ,MAAM,aACA,MAAM,KAChB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAwB/B,CAAA"}
+{"version":3,"file":"wrappers.d.ts","sourceRoot":"","sources":["../../src/api/wrappers.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAA;AAEpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAEhD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CACxC,CAAA;AA6BD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,QACzB,YAAY,QACX,IAAI,YACD,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CAgDhB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,QACX,WAAW,YACR,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CA+ChB,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,QACxB,YAAY,UACT,OAAO,SACR,MAAM,GAAG,SAAS,YAChB,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CAiBhB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,YACP,QAAQ,GAAG,IAAI,EAAE,+CAKxB;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,KAC1F,OAAO,CAAC,MAAM,CA2DhB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,QAClC,YAAY,YACP,MAAM,QACV,uBAAuB,oBACX,MAAM,YACf,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,KAC7C,OAAO,CAAC,MAAM,CAchB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,QAClB,YAAY,OACZ,MAAM,aACA,MAAM,KAChB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAwB/B,CAAA;AAED,eAAO,MAAM,iBAAiB,QACvB,YAAY,KAChB,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAM9C,CAAA;AAED,eAAO,MAAM,mBAAmB,QAAe,YAAY,KAAG,OAAO,CAAC,gBAAgB,CAIrF,CAAA"}

package/dist/api/wrappers.js

@@ -19,7 +19,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadFile = exports.uploadFileWithinFolderUpload = exports.uploadFolderFromInput = exports.uploadFile = exports.uploadFileFromInput = void 0;
+exports.getSubscriptionInfo = exports.getPendingCredits = exports.downloadFile = exports.uploadFileWithinFolderUpload = exports.uploadFolderFromInput = exports.uploadObjectAsJSON = exports.uploadFile = exports.uploadFileFromInput = void 0;
 const mime_types_1 = __importDefault(require("mime-types"));
 const async_1 = require("../utils/async");
 const misc_1 = require("../utils/misc");
@@ -131,7 +131,7 @@ exports.uploadFileFromInput = uploadFileFromInput;
  * @param {string} [options.password] - The password for encryption (optional).
  * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
  * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
- * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
+ * @returns {Promise<string>} - The CID of the uploaded file.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
 const uploadFile = (api_1, file_1, ...args_1) => __awaiter(void 0, [api_1, file_1, ...args_1], void 0, function* (api, file, options = {}, uploadChunkSize) {
@@ -175,6 +175,36 @@ const uploadFile = (api_1, file_1, ...args_1) => __awaiter(void 0, [api_1, file_
     return result.cid;
 });
 exports.uploadFile = uploadFile;
+/**
+ * Uploads an object as a JSON file to the server.
+ *
+ * This function serializes the provided object to a JSON string,
+ * and then uploads the JSON string as a file to the server.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {File | GenericFile} file - The file to be uploaded, which can be a File or a GenericFile.
+ * @param {UploadFileOptions} options - Options for the upload process.
+ * @param {string} [options.password] - The password for encryption (optional).
+ * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
+ * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
+ * @returns {Promise<string>} - The CID of the uploaded file.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+const uploadObjectAsJSON = (api_1, object_1, name_1, ...args_1) => __awaiter(void 0, [api_1, object_1, name_1, ...args_1], void 0, function* (api, object, name, options = {}, uploadChunkSize) {
+    try {
+        const json = Buffer.from(JSON.stringify(object));
+        return (0, exports.uploadFile)(api, {
+            read: () => (0, async_1.bufferToIterable)(json),
+            name: name || 'object.json',
+            mimeType: 'application/json',
+            size: json.length,
+        }, options, uploadChunkSize);
+    }
+    catch (e) {
+        throw new Error('Failed to serialize object to JSON');
+    }
+});
+exports.uploadObjectAsJSON = uploadObjectAsJSON;
 /**
  * Uploads an entire folder to the server.
  *
@@ -285,3 +315,16 @@ const downloadFile = (api, cid, password) => __awaiter(void 0, void 0, void 0, f
     return iterable;
 });
 exports.downloadFile = downloadFile;
+const getPendingCredits = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    const me = yield index_1.apiCalls.getMe(api);
+    return {
+        upload: me.subscription.pendingUploadCredits,
+        download: me.subscription.pendingDownloadCredits,
+    };
+});
+exports.getPendingCredits = getPendingCredits;
+const getSubscriptionInfo = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    const me = yield index_1.apiCalls.getMe(api);
+    return me.subscription;
+});
+exports.getSubscriptionInfo = getSubscriptionInfo;

package/dist/utils/async.d.ts

@@ -2,4 +2,5 @@ import { Buffer } from 'buffer';
 export declare const asyncByChunk: (asyncIterable: AsyncIterable<Buffer>, chunkSize: number) => AsyncGenerator<Buffer<ArrayBuffer>, void, unknown>;
 export declare const asyncFromStream: (stream: ReadableStream<Uint8Array>) => AsyncIterable<Buffer>;
 export declare const fileToIterable: (file: File | Blob) => AsyncIterable<Buffer>;
+export declare const bufferToIterable: (buffer: Buffer) => AsyncIterable<Buffer>;
 //# sourceMappingURL=async.d.ts.map

package/dist/utils/async.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"async.d.ts","sourceRoot":"","sources":["../../src/utils/async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B,eAAO,MAAM,YAAY,kBACR,aAAa,CAAC,MAAM,CAAC,aACzB,MAAM,uDAelB,CAAA;AAED,eAAO,MAAM,eAAe,WAClB,cAAc,CAAC,UAAU,CAAC,KACjC,aAAa,CAAC,MAAM,CAOtB,CAAA;AAED,eAAO,MAAM,cAAc,SAA0B,IAAI,GAAG,IAAI,KAAG,aAAa,CAAC,MAAM,CAKtF,CAAA"}
+{"version":3,"file":"async.d.ts","sourceRoot":"","sources":["../../src/utils/async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B,eAAO,MAAM,YAAY,kBACR,aAAa,CAAC,MAAM,CAAC,aACzB,MAAM,uDAelB,CAAA;AAED,eAAO,MAAM,eAAe,WAClB,cAAc,CAAC,UAAU,CAAC,KACjC,aAAa,CAAC,MAAM,CAOtB,CAAA;AAED,eAAO,MAAM,cAAc,SAA0B,IAAI,GAAG,IAAI,KAAG,aAAa,CAAC,MAAM,CAKtF,CAAA;AAED,eAAO,MAAM,gBAAgB,WAA4B,MAAM,KAAG,aAAa,CAAC,MAAM,CAErF,CAAA"}

package/dist/utils/async.js

@@ -20,7 +20,7 @@ var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _ar
     function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileToIterable = exports.asyncFromStream = exports.asyncByChunk = void 0;
+exports.bufferToIterable = exports.fileToIterable = exports.asyncFromStream = exports.asyncByChunk = void 0;
 const buffer_1 = require("buffer");
 const asyncByChunk = function (asyncIterable, chunkSize) {
     return __asyncGenerator(this, arguments, function* () {
@@ -71,3 +71,9 @@ const fileToIterable = function (file) {
     });
 };
 exports.fileToIterable = fileToIterable;
+const bufferToIterable = function (buffer) {
+    return __asyncGenerator(this, arguments, function* () {
+        yield yield __await(buffer);
+    });
+};
+exports.bufferToIterable = bufferToIterable;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@autonomys/auto-drive",
   "packageManager": "yarn@4.2.2",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -42,12 +42,12 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@autonomys/auto-dag-data": "^1.2.0",
+    "@autonomys/auto-dag-data": "^1.2.1",
     "jszip": "^3.10.1",
     "mime-types": "^2.1.35",
     "process": "^0.11.10",
     "stream": "^0.0.3",
     "zod": "^3.23.8"
   },
-  "gitHead": "4e00ac77a400bf1ca76b0f9034045f67c815a9cb"
+  "gitHead": "72285a024adcc7681ec59fabd1f061a6e40aeb09"
 }

package/src/api/calls/read.ts

@@ -2,6 +2,7 @@ import { ArgsWithoutPagination, ArgsWithPagination } from '../../utils/types'
 import { AutoDriveApi } from '../connection'
 import { PaginatedResult } from '../models/common'
 import { ObjectInformation, ObjectSummary, Scope } from '../models/objects'
+import { UserInfo } from '../models/user'
 
 /**
  * Retrieves the root objects based on the specified scope.
@@ -193,3 +194,21 @@ export const getObjectMetadata = async (
 
   return response.json()
 }
+
+/**
+ * Get upload and download limits of the user
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @returns {Promise<UserInfo>} - A promise that resolves to the user info.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getMe = async (api: AutoDriveApi): Promise<UserInfo> => {
+  const response = await api.sendRequest('@me', {
+    method: 'GET',
+  })
+  if (!response.ok) {
+    throw new Error(`Failed to get limits: ${response.statusText}`)
+  }
+
+  return response.json()
+}

package/src/api/models/user.ts

@@ -0,0 +1,31 @@
+export type SubscriptionGranularity = 'monthly'
+
+export type SubscriptionInfo = {
+  id: string
+  organizationId: string
+  uploadLimit: number
+  downloadLimit: number
+  granularity: SubscriptionGranularity
+  pendingUploadCredits: number
+  pendingDownloadCredits: number
+}
+
+export enum UserRole {
+  User = 'User',
+  Admin = 'Admin',
+}
+
+export type User = {
+  oauthProvider: string
+  oauthUserId: string
+  role: UserRole
+  downloadCredits: number
+  uploadCredits: number
+  publicId: string
+  onboarded: true
+}
+
+export type UserInfo = {
+  user: User
+  subscription: SubscriptionInfo
+}

package/src/api/wrappers.ts

@@ -1,10 +1,11 @@
 import mime from 'mime-types'
-import { asyncByChunk, asyncFromStream, fileToIterable } from '../utils/async'
+import { asyncByChunk, asyncFromStream, bufferToIterable, fileToIterable } from '../utils/async'
 import { progressToPercentage } from '../utils/misc'
 import { apiCalls } from './calls/index'
 import { AutoDriveApi } from './connection'
 import { GenericFile, GenericFileWithinFolder } from './models/file'
 import { constructFromInput, constructZipBlobFromTreeAndPaths } from './models/folderTree'
+import { SubscriptionInfo } from './models/user'
 
 export type UploadFileOptions = {
   password?: string
@@ -125,7 +126,7 @@ export const uploadFileFromInput = (
  * @param {string} [options.password] - The password for encryption (optional).
  * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
  * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
- * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
+ * @returns {Promise<string>} - The CID of the uploaded file.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
 export const uploadFile = async (
@@ -182,6 +183,46 @@ export const uploadFile = async (
   return result.cid
 }
 
+/**
+ * Uploads an object as a JSON file to the server.
+ *
+ * This function serializes the provided object to a JSON string,
+ * and then uploads the JSON string as a file to the server.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {File | GenericFile} file - The file to be uploaded, which can be a File or a GenericFile.
+ * @param {UploadFileOptions} options - Options for the upload process.
+ * @param {string} [options.password] - The password for encryption (optional).
+ * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
+ * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
+ * @returns {Promise<string>} - The CID of the uploaded file.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export const uploadObjectAsJSON = async (
+  api: AutoDriveApi,
+  object: unknown,
+  name?: string | undefined,
+  options: UploadFileOptions = {},
+  uploadChunkSize?: number,
+): Promise<string> => {
+  try {
+    const json = Buffer.from(JSON.stringify(object))
+    return uploadFile(
+      api,
+      {
+        read: () => bufferToIterable(json),
+        name: name || 'object.json',
+        mimeType: 'application/json',
+        size: json.length,
+      },
+      options,
+      uploadChunkSize,
+    )
+  } catch (e) {
+    throw new Error('Failed to serialize object to JSON')
+  }
+}
+
 /**
  * Uploads an entire folder to the server.
  *
@@ -335,3 +376,19 @@ export const downloadFile = async (
 
   return iterable
 }
+
+export const getPendingCredits = async (
+  api: AutoDriveApi,
+): Promise<{ upload: number; download: number }> => {
+  const me = await apiCalls.getMe(api)
+  return {
+    upload: me.subscription.pendingUploadCredits,
+    download: me.subscription.pendingDownloadCredits,
+  }
+}
+
+export const getSubscriptionInfo = async (api: AutoDriveApi): Promise<SubscriptionInfo> => {
+  const me = await apiCalls.getMe(api)
+
+  return me.subscription
+}

package/src/utils/async.ts

@@ -36,3 +36,7 @@ export const fileToIterable = async function* (file: File | Blob): AsyncIterable
     yield Buffer.from(await file.slice(i, i + chunkSize).arrayBuffer())
   }
 }
+
+export const bufferToIterable = async function* (buffer: Buffer): AsyncIterable<Buffer> {
+  yield buffer
+}