node-swiftclient

Openstack Swift Client Library for Node.js

A Node.js client library for interacting with OpenStack Swift Object Storage. This library provides robust functionality for managing containers and objects, offering a clean and straightforward API for common Swift operations. It supports all Swift authentication versions (v1.0, v2.0, and v3).

Installation

Install the library using npm/pnpm:

npm install node-swiftclient

or

yarn install node-swiftclient

Quick Example

How to create a container, upload a file, and list objects:

import { SwiftClient } from 'node-swiftclient';
import { Readable } from 'stream';

async function example() {
  // Initialize SwiftClient
  const client = new SwiftClient({
    authVersion: 3,
    authUrl: 'https://auth.example.com/v3',
    userName: 'demo',
    apiKey: 'demo',
    tenant: 'test',
    tenantDomain: 'Default',
    domain: 'Default',
  });

  // Create a container
  await client.createContainer('my-container', true, {
    'X-Meta-Info': 'example',
  });

  // List containers
  const containers = await client.listAllContainers();
  console.log('Containers:', containers);

  // Upload an object as a stream
  const container = client.getContainer('my-container');
  const stream = Readable.from('Hello, Swift!');
  await container.putObject('docs/hello.txt', stream);

  //List all object in pseudo-folder 'img'
  const objects = container.listObjects({ prefix: 'docs/' });
  console.log(objects);

  // Download the object as a buffer
  const buffer = await container.getObjectAsBuffer('docs/hello.txt');
  console.log('Downloaded Content:', buffer.toString());

  // Clean up: Delete the object and container
  await container.deleteObject('docs/hello.txt');
  await client.deleteContainer('my-container');
}

Key Features

• Container Management: Create, delete, and list containers.
• Object Management: Upload, download, delete, and list objects in containers.
• Metadata: Set and retrieve metadata for containers and objects.
• Authentication: Supports Swift authentication versions 1.0, 2.0, and 3.

API Documentation

SwiftClient

Method	Description
createContainer()	Creates a new container with optional metadata and headers.
getContainer()	Retrieves a SwiftContainer object for managing objects in a container.
listAllContainers()	Lists all containers with optional filters and headers.
deleteContainer()	Deletes a container.
getClientInfo()	Retrieves information about the authenticated Swift client.
getContainerMeta()	Retrieves metadata for the specified container.

SwiftContainer

Method	Description
listObjects()	Lists objects in the container with optional filtering and pagination.
listObjectFolders()	Lists object folders (subdirectories) with optional filtering and pagination.
iterateObjects()	Iterates over all objects in the container in batches.
getObjectMeta()	Retrieves metadata for a specific object.
patchObjectMeta()	Updates metadata for a specific object.
putObject()	Uploads an object to the container from a stream or buffer.
deleteObject()	Deletes a specific object from the container.
getObject()	Downloads a specific object as a readable stream.
getObjectInfo()	Retrieves information about an object without downloading its content.
getObjectAsBuffer()	Downloads a specific object as a buffer.

Example Usage

import { SwiftContainer } from './swift-container';

async function main(container: SwiftContainer) {
  // List objects in the container
  const objects = await container.listObjects({ prefix: 'folder/' });
  console.log('Objects:', objects);

  // Upload an object
  await container.putObject('example.txt', Buffer.from('Hello, world!'));

  // Retrieve metadata for an object
  const metadata = await container.getObjectMeta('example.txt');
  console.log('Metadata:', metadata);

  // Delete an object
  await container.deleteObject('example.txt');
}

Configuration

SwiftClient supports multiple authentication methods. Examples:

Auth Version 1

swift = new SwiftClient({
  authVersion: 1,
  authUrl: 'http://example.com/auth/v1.0',
  userName: 'tester2',
  password: 'testing2',
  tenant: 'test2',
});

Auth Version 2

Note: Version 2 is deprecated and you should upgrade your swift storage.

swift = new SwiftClient({
  authVersion: 2,
  authUrl: 'http://auth.example.com/v2.0',
  userName: 'demo',
  apiKey: 'demo',
  tenant: 'test',
});

Auth Version 3

swift = new SwiftClient({
  authVersion: 3,
  authUrl: 'http://auth.example.com/v3',
  userName: 'demo',
  apiKey: 'demo',
  tenant: 'test',
  tenantDomain: 'Default',
  domain: 'Default',
});

License

This library is licensed under the MIT License.