npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@brezel-js/api-client

v1.0.2

Published

API client for Brezel

Downloads

4

Readme

@brezel-js/api-client

This is a simple JavaScript SDK for interacting with the Brezel API.

Getting Started

To use it, you need to initialize it with your API key or user access token, your Brezel system, and API endpoint URI as shown below.

import Brezel from '@brezel-js/api-client';

const client = new Brezel({
    uri: 'https://api.example.com',
    system: 'test',
    key: 'testKey', // either via API key
    token: 'testToken', // ... or via an OAuth access token
});

Usage

Modules

Fetching all modules

client.fetchModules().then(modules => console.log(modules));

Fetching a specific module

client.fetchModule('moduleIdentifier').then(result => console.log(result));

Entities

Fetch entities of a specific module

client.fetchEntities('moduleIdentifier').then(result => console.log(result));

Fetch a specific entity by its ID

client.fetchEntity(7, 'moduleIdentifier').then(result => console.log(result));

Create a new entity

const entity = {
    module: {
        identifier: 'module1'
    },
    // Fields
    name: 'My Entity',
    // ...
};
client.createEntity(entity).then(result => console.log(result));

Update an entity

const entity = {
    id: 9,
    module: {
        identifier: 'module1'
    },
    // Fields
    name: 'My Entity',
    // ...
};
client.updateEntity(entity).then(result => console.log(result));

Save an entity

This method updates an existing entity, or creates a new entity if the ID is undefined.

const entity = {
    id: 9, // optional
    module: {
        identifier: 'module1'
    },
    // Fields
    name: 'My Entity',
    // ...
};
client.saveEntity(entity).then(result => console.log(result));

Filters

Data can be filtered when fetching entities by using a syntax like this:

client.fetchEntities('songs', {
    page: 1, // optional
    filters: [{
        column: 'album.title',
        operator: '=',
        value: 'Emotion'
    }]
}).then(result => console.log(result));

This will fetch only the entities having the relation album with the title 'Emotion'.

Fetch contents of a file

You can also fetch the contents of specific file entity by its entity ID. Given a file with an ID of "123", here's how you can retrieve the file:

client.fetchFile(123)
    .then(blob => {
        // Do something with the blob, e.g. generate a download URL
        const url = window.URL.createObjectURL(blob);
        console.log(url);
    });

The fetchFile() method retrieves a Blob object that represents the file's data. You can use this Blob object to create a local URL, which you can then use to embed the file in a webpage or download it to the user's computer.

Unit Tests

To run the unit tests:

npm run test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT