@pixelbin/admin

v4.1.1

Published

3 months ago

Pixelbin Backend SDK for Javascript

Downloads

1,297

0High
0Medium
0Low

pixelbin

Pixelbin Backend SDK for Javascript

Pixelbin Backend SDK for Javascript helps you integrate the core Pixelbin features with your application.

Getting Started

Getting started with Pixelbin Backend SDK for Javascript

Installation

npm install @pixelbin/admin --save

Usage

Quick Example

// import the PixelbinConfig and PixelbinClient
const { PixelbinConfig, PixelbinClient } = require("@pixelbin/admin");

// Create a config with you API_TOKEN
const config = new PixelbinConfig({
    domain: "https://api.pixelbin.io",
    apiSecret: "API_TOKEN",
    integrationPlatform: "YourAppName/1.0 (AppPlatform/2.0)", // this is optional
});

// Create a pixelbin instance
const pixelbin = new PixelbinClient(config);

async function getData() {
    try {
        // list the assets stored on your organization's Pixelbin Storage
        const explorer = pixelbin.assets.listFilesPaginator({
            onlyFiles: true,
            pageSize: 5,
        });
        while (explorer.hasNext()) {
            const { items, page } = await explorer.next();
            console.log(page.current); // 1
            console.log(page.hasNext); // false
            console.log(page.size); // 3
            console.log(items.length); // 3
        }
    } catch (err) {
        console.log(err);
    }
}

getData();

Uploader

upload

Uploads a file to PixelBin with greater control over the upload process.

| Argument | Type | Required | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | file | Buffer or Stream | yes | The file to be uploaded. | | name | string | no | Name of the file. | | path | string | no | Path of the containing folder. | | format | string | no | Format of the file. | | access | AccessEnum | no | Access level of the asset, can be either public-read or private. | | tags | [string] | no | Tags associated with the file. | | metadata | string | no | Metadata associated with the file. | | overwrite | boolean | no | Overwrite flag. If set to true, will overwrite any file that exists with the same path, name, and type. Defaults to false. | | filenameOverride | boolean | no | If set to true, will add unique characters to the name if an asset with the given name already exists. If the overwrite flag is set to true, preference will be given to the overwrite flag. If both are set to false, an error will be raised. | | expiry | number | no | Expiry time in seconds for the underlying signed URL. Defaults to 3000 seconds. | | uploadOptions | Object | no | Additional options for fine-tuning the upload process. Default: { chunkSize: 10 * 1024 * 1024, maxRetries: 2, concurrency: 3, exponentialFactor: 2 } | | chunkSize | number | no | Size of each chunk to upload. Default is 10 megabyte. | | maxRetries | number | no | Maximum number of retries if an upload fails. Default is 2 retries. | | concurrency | number | no | Number of concurrent chunk upload tasks. Default is 3 concurrent chunk uploads. | | exponentialFactor | number | no | The exponential factor for retry delay. Default is 2. |

returns: Promise

On Success

| property | description | example | | -------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | orgId (Number) | Organization id | 5320086 | | type (String) | | file | | name (String) | name of the file | testfile.jpeg | | path (String) | Path of containing folder. | /path/to/image.jpeg | | fileId (String) | id of file | testfile.jpeg | | access (String) | Access level of asset, can be either public-read or private | public-read | | tags (Array) | Tags associated with the file. | ["tag1", "tag2"] | | metadata (Object) | Metadata associated with the file. | {"source:"", "publicUploadId":""} | | format (String) | file format | jpeg | | assetType (String) | type of asset | image | | size (Number) | file size | 37394 | | width (Number) | file width | 720 | | height (Number) | file height | 450 | | context (Object) | contains the file metadata and other contexts of file | {"steps":[],"req":{"headers":{},"query":{}},"meta":{"format":"png","size":195337,"width":812,"height":500,"space":"srgb","channels":4,"depth":"uchar","density":144,"isProgressive":false,"resolutionUnit":"inch","hasProfile":true,"hasAlpha":true,"extension":"jpeg","contentType":"image/png","assetType":"image","isImageAsset":true,"isAudioAsset":false,"isVideoAsset":false,"isRawAsset":false,"isTransformationSupported":true}} | | isOriginal (Boolean) | flag about files type | true | | _id (String) | record id | a0b0b19a-d526-4xc07-ae51-0xxxxxx | | url (String) | uploaded image url | https://cdn.pixelbin.io/v2/user-e26cf3/original/testfile.jpeg |

Example :

Uploading a buffer

// import the PixelbinConfig and PixelbinClient
const { PixelbinConfig, PixelbinClient } = require("@pixelbin/admin");
const fs = require("fs");

// Create a config with you API_TOKEN
const config = new PixelbinConfig({
    domain: "https://api.pixelbin.io",
    apiSecret: "API_TOKEN",
    integrationPlatform: "YourAppName/1.0 (AppPlatform/2.0)", // this is optional
});

// Create a pixelbin instance
const pixelbin = new PixelbinClient(config);

const buffer = fs.readFileSync("./myimage.png")

const result = await pixelbin.uploader.upload({
  file: buffer,
  name: "myimage",
  path: "folder",
  format: "png",
  tags: [],
  metadata: {},
  overwrite: false,
  filenameOverride: false,
  access: "public-read",
  uploadOptions: {
    chunkSize: 5 * 1024 * 1024 // 5MB
    concurrency: 2, // 2 concurrent chunk uploads
    maxRetries: 1, // 2 retries for errors that can be retried
    exponentialFactor: 1, // exponential factor for retries
  }
});

console.log(result.url)
// "https://cdn.pixelbin.io/v2/mycloudname/original/folder/myimage.png"

Example :

Uploading a stream

// import the PixelbinConfig and PixelbinClient
const { PixelbinConfig, PixelbinClient } = require("@pixelbin/admin");
const fs = require("fs");

// Create a config with you API_TOKEN
const config = new PixelbinConfig({
    domain: "https://api.pixelbin.io",
    apiSecret: "API_TOKEN",
    integrationPlatform: "YourAppName/1.0 (AppPlatform/2.0)", // this is optional
});

// Create a pixelbin instance
const pixelbin = new PixelbinClient(config);

const buffer = fs.createReadStream("./myimage.png")

const result = await pixelbin.uploader.upload({
  file: buffer,
  name: "myimage",
  path: "folder",
  format: "png",
  tags: [],
  metadata: {},
  overwrite: false,
  filenameOverride: false,
  access: "public-read",
  uploadOptions: {
    chunkSize: 5 * 1024 * 1024 // 5MB
    concurrency: 2, // 2 concurrent chunk uploads
    maxRetries: 1, // 2 retries for errors that can be retried
    exponentialFactor: 1, // exponential factor for retries
  }
});

console.log(result.url)
// "https://cdn.pixelbin.io/v2/mycloudname/original/folder/myimage.png"

Integration Platform

The integrationPlatform parameter allows you to customize the User-Agent string in API requests. This helps in identifying the specific application or plugin making the request, useful for analytics and troubleshooting.

How to Use

Include the integrationPlatform in your Pixelbin configuration as shown above. The string should clearly identify your application or plugin and include version details as well as any platform your system is deployed on if applicable.

Syntax : Pixelbin{integration_name}/{integration_version} ({platform_name}/{platform_version})

Security Utils

For generating Signed URLs

Generate a signed PixelBin url

| Parameter | Description | Example | | ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------ | | url (string) | A valid Pixelbin URL to be signed | https://cdn.pixelbin.io/v2/dummy-cloudname/original/__playground/playground-default.jpeg | | expirySeconds (number) | Number of seconds the signed URL should be valid for | 20 | | accessKey (string) | Access key of the token used for signing | 42 | | token (string) | Value of the token used for signing | dummy-token |

Example:

const { security } = require("@pixelbin/admin");

const signedUrl = security.signURL(
    "https://cdn.pixelbin.io/v2/dummy-cloudname/original/__playground/playground-default.jpeg", // url
    20, // expirySeconds
    "0b55aaff-d7db-45f0-b556-9b45a6f2200e", // accessKey
    "dummy-token", // token
);
// signedUrl
// https://cdn.pixelbin.io/v2/dummy-cloudname/original/__playground/playground-default.jpeg?pbs=8eb6a00af74e57967a42316e4de238aa88d92961649764fad1832c1bff101f25&pbe=1695635915&pbt=0b55aaff-d7db-45f0-b556-9b45a6f2200e

Usage with custom domain url

const { security } = require("@pixelbin/admin");

const signedUrl = security.signURL(
    "https://krit.imagebin.io/v2/original/__playground/playground-default.jpeg", // url
    30, // expirySeconds
    "0b55aaff-d7db-45f0-b556-9b45a6f2200e", // accessKey
    "dummy-token", // token
);
// signedUrl
// https://krit.imagebin.io/v2/original/__playground/playground-default.jpeg?pbs=1aef31c1e0ecd8a875b1d3184f324327f4ab4bce419d81d1eb1a818ee5f2e3eb&pbe=1695705975&pbt=0b55aaff-d7db-45f0-b556-9b45a6f2200e

URL Utils

Pixelbin provides url utilities to construct and deconstruct Pixelbin urls.

urlToObj

Deconstruct a pixelbin url

| Parameter | Description | Example | | --------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | url (string) | A valid Pixelbin URL | https://cdn.pixelbin.io/v2/your-cloud-name/z-slug/t.resize(h:100,w:200)~t.flip()/path/to/image.jpeg | | opts (Object) | Options for the conversion | Default: { isCustomDomain: false } | | opts.isCustomDomain | Indicates if the URL belongs to a custom domain (default: false) |

Returns:

| Property | Description | Example | | ------------------------- | ---------------------------------------------------- | ------------------------------------- | | baseURL (string) | Base path of the URL | https://cdn.pixelbin.io | | filePath (string) | Path to the file on Pixelbin storage | /path/to/image.jpeg | | version (string) | Version of the URL | v2 | | cloudName (string) | Cloud name from the URL | your-cloud-name | | transformations (array) | A list of transformation objects | [{ "plugin": "t", "name": "flip" }] | | zone (string) | Zone slug from the URL | z-slug | | pattern (string) | Transformation pattern extracted from the URL | t.resize(h:100,w:200)~t.flip() | | worker (boolean) | Indicates if the URL is a URL Translation Worker URL | false | | workerPath (string) | Input path to a URL Translation Worker | resize:w200,h400/folder/image.jpeg | | options (Object) | Query parameters added, such as "dpr" and "f_auto" | { dpr: 2.5, f_auto: true} |

Example:

const { url } = require("@pixelbin/admin");

const pixelbinUrl =
    "https://cdn.pixelbin.io/v2/your-cloud-name/z-slug/t.resize(h:100,w:200)~t.flip()/path/to/image.jpeg";

const obj = url.urlToObj(pixelbinUrl);
// obj
// {
//     "cloudName": "your-cloud-name",
//     "zone": "z-slug",
//     "version": "v2",
//     "transformations": [
//         {
//             "plugin": "t",
//             "name": "resize",
//             "values": [
//                 {
//                     "key": "h",
//                     "value": "100"
//                 },
//                 {
//                     "key": "w",
//                     "value": "200"
//                 }
//             ]
//         },
//         {
//             "plugin": "t",
//             "name": "flip",
//         }
//     ],
//     "filePath": "path/to/image.jpeg",
//     "baseUrl": "https://cdn.pixelbin.io",
//     "wrkr": false,
//     "workerPath": "",
//     "options": {}
// }

const { url } = require("@pixelbin/admin");

const customDomainUrl =
    "https://xyz.designify.media/v2/z-slug/t.resize(h:100,w:200)~t.flip()/path/to/image.jpeg";

const obj = url.urlToObj(customDomainUrl, { isCustomDomain: true });
// obj
// {
//     "zone": "z-slug",
//     "version": "v2",
//     "transformations": [
//         {
//             "plugin": "t",
//             "name": "resize",
//             "values": [
//                 {
//                     "key": "h",
//                     "value": "100"
//                 },
//                 {
//                     "key": "w",
//                     "value": "200"
//                 }
//             ]
//         },
//         {
//             "plugin": "t",
//             "name": "flip",
//         }
//     ],
//     "filePath": "path/to/image.jpeg",
//     "baseUrl": "https://xyz.designify.media",
//     "wrkr": false,
//     "workerPath": "",
//     "options": {}
// }

const { url } = require("@pixelbin/admin");

const workerUrl =
    "https://cdn.pixelbin.io/v2/your-cloud-name/z-slug/wrkr/resize:h100,w:200/folder/image.jpeg";

const obj = url.urlToObj(pixelbinUrl);
// obj
// {
//     "cloudName": "your-cloud-name",
//     "zone": "z-slug",
//     "version": "v2",
//     "transformations": [],
//     "filePath": "",
//     "worker": true,
//     "workerPath": "resize:h100,w:200/folder/image.jpeg",
//     "baseUrl": "https://cdn.pixelbin.io"
//     "options": {}
// }

objToUrl

Converts the extracted url obj to a Pixelbin url.

| Property | Description | Example | | -------------------------- | ---------------------------------------------------- | ------------------------------------- | | cloudName (string) | The cloudname extracted from the URL | your-cloud-name | | zone (string) | 6 character zone slug | z-slug | | version (string) | CDN API version | v2 | | transformations (array) | Extracted transformations from the URL | [{ "plugin": "t", "name": "flip" }] | | filePath (string) | Path to the file on Pixelbin storage | /path/to/image.jpeg | | baseUrl (string) | Base URL | https://cdn.pixelbin.io/ | | isCustomDomain (boolean) | Indicates if the URL is for a custom domain | false | | worker (boolean) | Indicates if the URL is a URL Translation Worker URL | false | | workerPath (string) | Input path to a URL Translation Worker | resize:w200,h400/folder/image.jpeg | | options (Object) | Query parameters added, such as "dpr" and "f_auto" | { "dpr": "2", "f_auto": "true" } |

const { url } = require("@pixelbin/admin");

const obj = {
    cloudName: "your-cloud-name",
    zone: "z-slug",
    version: "v2",
    transformations: [
        {
            plugin: "t",
            name: "resize",
            values: [
                {
                    key: "h",
                    value: "100",
                },
                {
                    key: "w",
                    value: "200",
                },
            ],
        },
        {
            plugin: "t",
            name: "flip",
        },
    ],
    filePath: "path/to/image.jpeg",
    baseUrl: "https://cdn.pixelbin.io",
};
const url = url.objToUrl(obj); // obj is as shown above
// url
// https://cdn.pixelbin.io/v2/your-cloud-name/z-slug/t.resize(h:100,w:200)~t.flip()/path/to/image.jpeg

Usage with custom domain

const { url } = require("@pixelbin/admin");

const obj = {
    zone: "z-slug",
    version: "v2",
    transformations: [
        {
            plugin: "t",
            name: "resize",
            values: [
                {
                    key: "h",
                    value: "100",
                },
                {
                    key: "w",
                    value: "200",
                },
            ],
        },
        {
            plugin: "t",
            name: "flip",
        },
    ],
    filePath: "path/to/image.jpeg",
    baseUrl: "https://xyz.designify.media",
    isCustomDomain: true,
};
const url = url.objToUrl(obj); // obj is as shown above
// url
// https://xyz.designify.media/v2/z-slug/t.resize(h:100,w:200)~t.flip()/path/to/image.jpeg

Usage with URL Translation Worker

const { url } = require("@pixelbin/admin");

const obj = {
    cloudName: "your-cloud-name",
    zone: "z-slug",
    version: "v2",
    transformations: [],
    filePath: "",
    worker: true,
    workerPath: "resize:h100,w:200/folder/image.jpeg",
    baseUrl: "https://cdn.pixelbin.io",
};
const url = url.objToUrl(obj); // obj is as shown above
// url
// https://cdn.pixelbin.io/v2/your-cloud-name/z-slug/wrkr/resize:h100,w:200/folder/image.jpeg

For Uploading File Buffer

To upload a Buffer, originalFilename must be passed in the options object.

const { Readable } = require("stream");
const res = await pixelbin.assets.fileUpload({
    file: Readable.from(req.file.buffer),
    name: req.body.name,
    options: { originalFilename: req.file.originalname },
    overwrite: true,
});

Documentation

API docs

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Pixelbin Backend SDK for Javascript

Getting Started

Installation

Usage

Quick Example

Uploader

upload

Uploading a buffer

Uploading a stream

Integration Platform

How to Use

Security Utils

For generating Signed URLs

URL Utils

urlToObj

objToUrl

For Uploading File Buffer

Documentation