@shivam995364/uplink-nodejs-test 0.1.0-beta.0

package/dist/native/index.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * @file native/index.ts
+ * @brief Centralized native module loader
+ *
+ * This module loads the native addon once and exports it for use
+ * throughout the application. This is more efficient than requiring
+ * the native module multiple times in different files.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.native = void 0;
+/**
+ * Load the native module once
+ */
+function loadNativeModule() {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
+        return require('../../build/Release/uplink_native.node');
+    }
+    catch (e) {
+        throw new Error('Failed to load uplink native module. ' +
+            'Make sure the native library is built and available. ' +
+            `Original error: ${e.message}`);
+    }
+}
+/**
+ * Singleton instance of the native module
+ */
+exports.native = loadNativeModule();
+/**
+ * Default export for convenience
+ */
+exports.default = exports.native;
+//# sourceMappingURL=index.js.map

package/dist/native/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/native/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAyIH;;GAEG;AACH,SAAS,gBAAgB;IACvB,IAAI,CAAC;QACH,qGAAqG;QACrG,OAAO,OAAO,CAAC,wCAAwC,CAAiB,CAAC;IAC3E,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,uCAAuC;YACrC,uDAAuD;YACvD,mBAAoB,CAAW,CAAC,OAAO,EAAE,CAC5C,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACU,QAAA,MAAM,GAAiB,gBAAgB,EAAE,CAAC;AAEvD;;GAEG;AACH,kBAAe,cAAM,CAAC"}

package/dist/project/index.d.ts

@@ -0,0 +1,409 @@
+/**
+ * @file project/index.ts
+ * @brief ProjectResultStruct class for uplink-nodejs
+ *
+ * Provides TypeScript wrapper for project operations.
+ */
+import type { BucketInfo, ListBucketsOptions, ObjectInfo, ListObjectsOptions, CopyObjectOptions, MoveObjectOptions, UploadOptions, DownloadOptions } from '../types';
+import { UploadResultStruct } from '../upload';
+import { DownloadResultStruct } from '../download';
+/** Native handle type */
+type ProjectHandle = unknown;
+/**
+ * Represents an open project on Storj.
+ *
+ * A project is the main entry point for bucket and object operations.
+ * Always call `close()` when done to free resources.
+ */
+export declare class ProjectResultStruct {
+    private readonly _handle;
+    private _isOpen;
+    /**
+     * Create a new ProjectResultStruct from a native handle
+     * @internal
+     */
+    constructor(handle: ProjectHandle);
+    /**
+     * Get the internal handle (for internal use only)
+     * @internal
+     */
+    get _nativeHandle(): ProjectHandle;
+    /**
+     * Check if the project is still open
+     */
+    get isOpen(): boolean;
+    /**
+     * Close the project and release resources.
+     *
+     * After calling this method, no other methods should be called
+     * on this project instance.
+     *
+     * @example
+     * ```typescript
+     * const project = await access.openProject();
+     * try {
+     *   // Use project...
+     * } finally {
+     *   await project.close();
+     * }
+     * ```
+     */
+    close(): Promise<void>;
+    /**
+     * Revoke an access grant.
+     *
+     * Revokes the API key embedded in the provided access grant.
+     * This is useful when you want to invalidate a previously shared access.
+     *
+     * @param access - The access grant to revoke (AccessResultStruct)
+     * @returns Promise resolving when the access is revoked
+     * @throws Error if revocation fails
+     *
+     * @example
+     * ```typescript
+     * // Create a shared access with limited permissions
+     * const sharedAccess = await access.share(permission, prefixes);
+     *
+     * // Give the shared access to someone...
+     *
+     * // Later, revoke the access when no longer needed
+     * await project.revokeAccess(sharedAccess);
+     * ```
+     */
+    revokeAccess(access: {
+        _nativeHandle: unknown;
+    }): Promise<void>;
+    /**
+     * Validate that the project is still open
+     * @throws Error if project is closed
+     */
+    private validateOpen;
+    /**
+     * Validate a bucket name
+     * @param name - Bucket name to validate
+     * @throws TypeError if bucket name is invalid
+     */
+    private validateBucketName;
+    /**
+     * Create a new bucket.
+     *
+     * @param name - Bucket name (3-63 lowercase alphanumeric chars or hyphens)
+     * @returns Promise resolving to the created bucket info
+     * @throws TypeError if bucket name is invalid
+     * @throws Error if bucket already exists
+     *
+     * @example
+     * ```typescript
+     * const bucket = await project.createBucket('my-bucket');
+     * console.log(`Created bucket: ${bucket.name}`);
+     * ```
+     */
+    createBucket(name: string): Promise<BucketInfo>;
+    /**
+     * Ensure a bucket exists, creating it if necessary.
+     *
+     * This is idempotent - calling it multiple times has the same effect
+     * as calling it once.
+     *
+     * @param name - Bucket name (3-63 lowercase alphanumeric chars or hyphens)
+     * @returns Promise resolving to the bucket info
+     * @throws TypeError if bucket name is invalid
+     *
+     * @example
+     * ```typescript
+     * const bucket = await project.ensureBucket('my-bucket');
+     * // Bucket now exists, whether it was just created or already existed
+     * ```
+     */
+    ensureBucket(name: string): Promise<BucketInfo>;
+    /**
+     * Get information about a bucket.
+     *
+     * @param name - Bucket name
+     * @returns Promise resolving to the bucket info
+     * @throws TypeError if bucket name is invalid
+     * @throws Error if bucket does not exist
+     *
+     * @example
+     * ```typescript
+     * const bucket = await project.statBucket('my-bucket');
+     * console.log(`Bucket created: ${bucket.created}`);
+     * ```
+     */
+    statBucket(name: string): Promise<BucketInfo>;
+    /**
+     * Delete an empty bucket.
+     *
+     * The bucket must be empty before it can be deleted.
+     * Use `deleteBucketWithObjects` to delete a bucket and all its contents.
+     *
+     * @param name - Bucket name
+     * @returns Promise resolving when the bucket is deleted
+     * @throws TypeError if bucket name is invalid
+     * @throws Error if bucket does not exist or is not empty
+     *
+     * @example
+     * ```typescript
+     * await project.deleteBucket('my-bucket');
+     * ```
+     */
+    deleteBucket(name: string): Promise<void>;
+    /**
+     * Delete a bucket and all its objects.
+     *
+     * WARNING: This will permanently delete all objects in the bucket!
+     *
+     * @param name - Bucket name
+     * @returns Promise resolving when the bucket and all objects are deleted
+     * @throws TypeError if bucket name is invalid
+     * @throws Error if bucket does not exist
+     *
+     * @example
+     * ```typescript
+     * // Delete bucket and all its contents
+     * await project.deleteBucketWithObjects('my-bucket');
+     * ```
+     */
+    deleteBucketWithObjects(name: string): Promise<void>;
+    /**
+     * List all buckets in the project.
+     *
+     * @param options - Optional listing options
+     * @returns Promise resolving to an array of bucket info
+     *
+     * @example
+     * ```typescript
+     * const buckets = await project.listBuckets();
+     * for (const bucket of buckets) {
+     *   console.log(`- ${bucket.name} (created: ${bucket.created})`);
+     * }
+     * ```
+     */
+    listBuckets(options?: ListBucketsOptions): Promise<BucketInfo[]>;
+    /**
+     * Validate an object key
+     * @param key - Object key to validate
+     * @throws TypeError if object key is invalid
+     */
+    private validateObjectKey;
+    /**
+     * Get information about an object.
+     *
+     * @param bucketName - Name of the bucket containing the object
+     * @param objectKey - Object key (path)
+     * @returns Promise resolving to the object info
+     * @throws TypeError if bucket name or object key is invalid
+     * @throws Error if object does not exist
+     *
+     * @example
+     * ```typescript
+     * const info = await project.statObject('my-bucket', 'path/to/file.txt');
+     * console.log(`Size: ${info.system.contentLength} bytes`);
+     * console.log(`Created: ${info.system.created}`);
+     * ```
+     */
+    statObject(bucketName: string, objectKey: string): Promise<ObjectInfo>;
+    /**
+     * Delete an object.
+     *
+     * @param bucketName - Name of the bucket containing the object
+     * @param objectKey - Object key (path)
+     * @returns Promise resolving when the object is deleted
+     * @throws TypeError if bucket name or object key is invalid
+     * @throws Error if object does not exist
+     *
+     * @example
+     * ```typescript
+     * await project.deleteObject('my-bucket', 'path/to/file.txt');
+     * ```
+     */
+    deleteObject(bucketName: string, objectKey: string): Promise<void>;
+    /**
+     * List objects in a bucket.
+     *
+     * @param bucketName - Name of the bucket to list objects from
+     * @param options - Optional listing options
+     * @returns Promise resolving to an array of object info
+     * @throws TypeError if bucket name is invalid
+     *
+     * @example
+     * ```typescript
+     * // List all objects
+     * const objects = await project.listObjects('my-bucket');
+     *
+     * // List with prefix and pagination
+     * const objects = await project.listObjects('my-bucket', {
+     *   prefix: 'photos/',
+     *   recursive: true,
+     *   system: true,
+     *   custom: true
+     * });
+     *
+     * for (const obj of objects) {
+     *   if (obj.isPrefix) {
+     *     console.log(`[DIR] ${obj.key}`);
+     *   } else {
+     *     console.log(`${obj.key} (${obj.system.contentLength} bytes)`);
+     *   }
+     * }
+     * ```
+     */
+    listObjects(bucketName: string, options?: ListObjectsOptions): Promise<ObjectInfo[]>;
+    /**
+     * Copy an object to a new location.
+     *
+     * @param oldBucket - Source bucket name
+     * @param oldKey - Source object key
+     * @param newBucket - Destination bucket name
+     * @param newKey - Destination object key
+     * @param options - Optional copy options
+     * @returns Promise resolving to the new object info
+     * @throws TypeError if bucket name or object key is invalid
+     * @throws Error if source object does not exist
+     *
+     * @example
+     * ```typescript
+     * // Copy within same bucket
+     * const copied = await project.copyObject(
+     *   'my-bucket', 'original.txt',
+     *   'my-bucket', 'copy.txt'
+     * );
+     *
+     * // Copy to different bucket
+     * const copied = await project.copyObject(
+     *   'source-bucket', 'file.txt',
+     *   'dest-bucket', 'backup/file.txt'
+     * );
+     * ```
+     */
+    copyObject(oldBucket: string, oldKey: string, newBucket: string, newKey: string, options?: CopyObjectOptions): Promise<ObjectInfo>;
+    /**
+     * Move (rename) an object to a new location.
+     *
+     * @param oldBucket - Source bucket name
+     * @param oldKey - Source object key
+     * @param newBucket - Destination bucket name
+     * @param newKey - Destination object key
+     * @param options - Optional move options
+     * @returns Promise resolving when the move is complete
+     * @throws TypeError if bucket name or object key is invalid
+     * @throws Error if source object does not exist
+     *
+     * @example
+     * ```typescript
+     * // Rename within same bucket
+     * await project.moveObject(
+     *   'my-bucket', 'old-name.txt',
+     *   'my-bucket', 'new-name.txt'
+     * );
+     *
+     * // Move to different bucket
+     * await project.moveObject(
+     *   'source-bucket', 'file.txt',
+     *   'archive-bucket', 'archived/file.txt'
+     * );
+     * ```
+     */
+    moveObject(oldBucket: string, oldKey: string, newBucket: string, newKey: string, options?: MoveObjectOptions): Promise<void>;
+    /**
+     * Update object custom metadata.
+     *
+     * Replaces the existing custom metadata with new metadata.
+     * System metadata (created, expires, contentLength) cannot be modified.
+     *
+     * @param bucketName - Bucket name containing the object
+     * @param objectKey - Object key to update
+     * @param metadata - New custom metadata (replaces existing)
+     * @returns Promise resolving when metadata is updated
+     * @throws TypeError if bucket name or object key is invalid
+     * @throws Error if object does not exist
+     *
+     * @example
+     * ```typescript
+     * // Update custom metadata
+     * await project.updateObjectMetadata('my-bucket', 'file.txt', {
+     *   'Content-Type': 'text/plain',
+     *   'X-Author': 'John Doe',
+     *   'X-Version': '2'
+     * });
+     *
+     * // Clear custom metadata by passing empty object
+     * await project.updateObjectMetadata('my-bucket', 'file.txt', {});
+     * ```
+     */
+    updateObjectMetadata(bucketName: string, objectKey: string, metadata: Record<string, string>): Promise<void>;
+    /**
+     * Start uploading an object.
+     *
+     * Returns an UploadResultStruct for writing data and finalizing the upload.
+     *
+     * @param bucketName - Name of the bucket to upload to
+     * @param objectKey - Object key (path) for the uploaded object
+     * @param options - Optional upload options (e.g., expiration)
+     * @returns Promise resolving to an UploadResultStruct
+     * @throws TypeError if bucket name or object key is invalid
+     *
+     * @example
+     * ```typescript
+     * // Simple upload
+     * const upload = await project.uploadObject('my-bucket', 'file.txt');
+     * await upload.write(Buffer.from('Hello, World!'), 13);
+     * await upload.commit();
+     *
+     * // Upload with expiration
+     * const upload = await project.uploadObject('my-bucket', 'temp.txt', {
+     *   expires: new Date(Date.now() + 24 * 60 * 60 * 1000) // 24 hours
+     * });
+     * await upload.write(data, data.length);
+     * await upload.commit();
+     *
+     * // Upload with custom metadata
+     * const upload = await project.uploadObject('my-bucket', 'photo.jpg');
+     * await upload.setCustomMetadata({
+     *   'Content-Type': 'image/jpeg',
+     *   'X-Custom-Tag': 'vacation'
+     * });
+     * await upload.write(imageBuffer, imageBuffer.length);
+     * await upload.commit();
+     * ```
+     */
+    uploadObject(bucketName: string, objectKey: string, options?: UploadOptions): Promise<UploadResultStruct>;
+    /**
+     * Start a download from a bucket.
+     *
+     * Opens a download stream for the specified object. Use the returned
+     * DownloadResultStruct to read data and close the download when done.
+     *
+     * @param bucketName - Name of the bucket to download from
+     * @param objectKey - Object key (path) to download
+     * @param options - Optional download options (offset, length)
+     * @returns Promise resolving to a DownloadResultStruct
+     * @throws TypeError if bucket name or object key is invalid
+     *
+     * @example
+     * ```typescript
+     * // Download entire object
+     * const download = await project.downloadObject('my-bucket', 'file.txt');
+     * const buffer = Buffer.alloc(1024);
+     * let totalBytes = 0;
+     * let result;
+     * do {
+     *   result = await download.read(buffer, buffer.length);
+     *   totalBytes += result.bytesRead;
+     * } while (result.bytesRead > 0);
+     * await download.close();
+     *
+     * // Download with offset and length (partial download)
+     * const download = await project.downloadObject('my-bucket', 'large-file.bin', {
+     *   offset: 1000,
+     *   length: 500
+     * });
+     * const chunk = Buffer.alloc(500);
+     * await download.read(chunk, chunk.length);
+     * await download.close();
+     * ```
+     */
+    downloadObject(bucketName: string, objectKey: string, options?: DownloadOptions): Promise<DownloadResultStruct>;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/project/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/project/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,UAAU,EACV,kBAAkB,EAClB,UAAU,EACV,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,eAAe,EAChB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGnD,yBAAyB;AACzB,KAAK,aAAa,GAAG,OAAO,CAAC;AAE7B;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,OAAO,CAAiB;IAEhC;;;OAGG;gBACS,MAAM,EAAE,aAAa;IAOjC;;;OAGG;IACH,IAAI,aAAa,IAAI,aAAa,CAGjC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;;;;;;;;;;OAeG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAS5B;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrE;;;OAGG;IACH,OAAO,CAAC,YAAY;IAMpB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMrD;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMrD;;;;;;;;;;;;;OAaG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMnD;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/C;;;;;;;;;;;;;;;OAeG;IACG,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1D;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAOtE;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAMzB;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAO5E;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAM1F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,UAAU,CACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAgBtB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,UAAU,CACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,oBAAoB,CACxB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,YAAY,CAChB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,kBAAkB,CAAC;IAS9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,oBAAoB,CAAC;CAUjC"}