pjpimentel / dots Goto Github PK

View Code? Open in Web Editor NEW

81.0 5.0 15.0 2.72 MB

digital ocean api typescript/javascript wrapper

Home Page: https://dots.pimentel.co

License: MIT License

TypeScript 99.83% JavaScript 0.17%

digital-ocean typescript wrapper javascript digitalocean digital ocean sdk api cloud

dots's Introduction

dots

digital ocean api wrapper

installing

    npm install --save dots-wrapper@latest

using

typescript

  import { createApiClient } from 'dots-wrapper';
  const myApiToken = 'my-long-token';
  const dots = createApiClient({token: myApiToken});

  const main = async () => {
    const {data:{account}} = await dots.account.getAccount();
    console.log(account);
  };

  main();

javascript/nodejs

  const {createApiClient} = require('dots-wrapper');
  const myApiToken = 'my-long-token';
  const dots = createApiClient({token: myApiToken});

  const main = async () => {
    const {data:{account}} = await dots.account.getAccount();
    console.log(account);
  };

  main();

browser

index.html

  <script src='https://unpkg.com/dots-wrapper@latest/dist/index-browser.min.js'></script>

js.js

  const {createApiClient} = window.dots;
  const myApiToken = 'my-long-token';
  const dots = createApiClient({token: myApiToken});

  const main = async () => {
    const {data:{account}} = await dots.account.getAccount();
    console.log(account);
  };

  main();

docs

contributors

license: mit

dots's People

Contributors

Stargazers

Watchers

Forkers

natania-d imcotton mavilein aarchangel64 freakyturtle queilawithaq shenev1979 codyogden carlosbaraza yakumwamba mannew kkhanhluu mueschm

dots's Issues

Add missing invoices API endpoint

Is your feature request related to a problem? Please describe.
I want to provide downloadable invoices in PDF or CSV format which can be downloaded via API instead of providing download links from https://cloud.digitalocean.com.

Describe the solution you'd like
Add missing invoices API endpoint.

Describe alternatives you've considered
Currently I provide a link to downloadable invoices from https://cloud.digitalocean.com, but here you have to be logged-in to access invoices as PDF or CSV.

Is your request a new API endpoint?
https://developers.digitalocean.com/documentation/v2/#invoices

unit tests + ci

[v3] action

list-actions
get-action

TypeError: Cannot destructure property 'backups' of 'undefined' as it is undefined.

When creating droplet with values from example getting next error (version 3.5.7):
TypeError: Cannot destructure property 'backups' of 'undefined' as it is undefined.
[dev] [2021-07-05 17:19:15] at Object.createDroplet (/workspace/node_modules/dots-wrapper/dist/modules/droplet/create-droplet/create-droplet.js:4:47)
attributes to req:

add vpc module

https://developers.digitalocean.com/documentation/changelog/

monitoring api

add monitoring methods: https://docs.digitalocean.com/reference/api/api-reference/#tag/Monitoring

Support for App Platform

Is your feature request related to a problem? Please describe.
No.

Describe the solution you'd like
Support for app platform requests.

Is your request a new API endpoint?
https://developers.digitalocean.com/documentation/v2/#apps

[v3] build + deploy

databases

[ci] fix cron npm publish beta

TypeError: undefined is not a function on 'Droplet.list'

digitalOcean.Droplet.list(1).subscribe(
      droplets => console.log(droplets),
      err => console.log(err)
    );

TypeError: undefined is not a function
    at Array.every (<anonymous>)
    at Object.isCollection (type.guards.js:453)
    at TapSubscriber._tapNext (endpoint.js:54)
    at TapSubscriber.push../node_modules/rxjs/_esm5/internal/operators/tap.js.TapSubscriber._next (tap.js:45)
    at TapSubscriber.push../node_modules/rxjs/_esm5/internal/Subscriber.js.Subscriber.next (Subscriber.js:54)
    at MapSubscriber.push../node_modules/rxjs/_esm5/internal/operators/map.js.MapSubscriber._next (map.js:41)
    at MapSubscriber.push../node_modules/rxjs/_esm5/internal/Subscriber.js.Subscriber.next (Subscriber.js:54)
    at MapSubscriber.push../node_modules/rxjs/_esm5/internal/operators/map.js.MapSubscriber._next (map.js:41)
    at MapSubscriber.push../node_modules/rxjs/_esm5/internal/Subscriber.js.Subscriber.next (Subscriber.js:54)
    at subscribeToPromise.js:7```

ILoadBalancer missing fields

Describe the bug
The ILoadBalancer should have a tag field (string).

To Reproduce
Steps to reproduce the behavior:

Run loadBalancer.listLoadBalancers
Check the list of load balancers, they have a tag field. See here as well: https://developers.digitalocean.com/documentation/v2/#load-balancers
However, the ILoadBalancer interface has no tag field.

Expected behavior
I do not want TS errors for the tag field in ILoadBalancer.

Screenshots

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context
Add any other context about the problem here.

kubernetes

[v3] size

list-sizes

[add] delete droplet by tag

spaces

check viability

[v3] tag

[v3] droplet

Add `force_rebuild` option to app.createAppDeployment

Hi, Pedro. This is a great project. Really impressed with how easy it is to integrate into some webhooks I'm building. This feature request is small, but important for getting static site content updated through a rebuild via the DO API.

Is your feature request related to a problem? Please describe.
For some static site build processes, the API request must have a body of {force_rebuild: true}, otherwise the static site will not be rebuilt with new content.

Describe the solution you'd like
The DigitalOcean API Documentation allows a force_rebuild to be passed in the body of the Create App Deployment endpoint. The solution would be to allow this as an option in the dots.app.createAppDeployment method, and pass it as a body in the POST request.

Describe alternatives you've considered
Forcing a rebuild from the source doesn't seem available unless I use the API directly.

Is your request a new API endpoint?
No. This modifies an already existing method.

Additional context
In the Apps Platform UI, this option is available by clicking the Actions > Force Rebuild and Deploy > (Check the box) > Click Deploy

Missing fields on App Platform types

Describe the bug

I'm not allowed to read certain fields in the API response, like in_progress_deployment:

Even though the docs specify they exist (and they're returned when hitting the API manually):

https://developers.digitalocean.com/documentation/v2/#retrieve-an-existing-app

projects

[feature] upgrade rxjs to @latest

get droplet free memory metrics

[v3] firewall

unittest to docs

implement unit test to docs files.

ensure:

each module should have yours.
each module read should have the ref to all fns in readme
the main readme should have a valid link to each module

[v3] image

[v3] load balancer

[v3] sshkey

container-registry

configure-container-registry (Configure Container Registry)
get-container-registry-information (Get Container Registry Information)
get-container-registry-docker-credentials (Get Docker Credentials for Container Registry)
delete-container-registry (Delete Container Registry)

"undefined is not a function" when subscribing to a list of droplets

Hi,

I'm suddenly getting an error with the latest version 2.2.0 on a code that was running in production normally. It is a simplified version.

dots.Droplet
        .list(0, 5)
        .subscribe(
            (response : any) => {},
            (err: Error) => {
                console.log('ERROR', err.message)
            }
        );

ERROR undefined is not a function

Any ideas?

add balance module

https://developers.digitalocean.com/documentation/changelog/

[v3] certificate

droplet create not accepts ssh fingerprint

I'm creating a droplet and passing

ssh_keys: [
                '51:0b:f8:a7:5c:74:b4:e3:c3:7e:bd:42:10:01:2c:x8'
            ],

actually i'm proving fingerprint of sshkey instead of id
and error i'm getting while compiling is -

 error TS2345: Argument of type '{ name: string; region: string; size: string; image: string; ssh_keys: string[]; backups: boolean; ipv6: boolean; user_data: string; tags: string[]; }' is not assignable to parameter of type 'ICreateDropletApiRequest'.        
  Types of property 'ssh_keys' are incompatible.
    Type 'string[]' is not assignable to type 'number[]'.
      Type 'string' is not assignable to type 'number'.

29         const { data: { droplet } } = await dots.droplet.createDroplet(input);

it should allow string type as well

Quick fix - modules/droplet/create-droplet/create-droplet.d.ts line 15
suggested change - ssh_keys?: number | string[];

refactor ids

where id is used, should be: <entitiy>_id.
the type should be update and the ID should be retrocompatible

load-balancer
snapshot
ssh-key
volume

[v3] floating ip

[v3] account

get-account

get droplet cpu metrics

[v3] domain

cdn-endpoints

create-cdn-endpoint (Create a new CDN endpoint)
get-cdn-endpoint (Retrieve an existing CDN endpoint)
list-cdn-endpoints (List all CDN endpoints)
update-cdn-endpoint (Update an existing CDN endpoint)
delete-cdn-endpoint (Delete a CDN endpoint)
purge-cache (Purge the cache for an existing CDN endpoint)

Creating droplet gives undefined as a response

   doc.Droplet.create(specs).subscribe(
		obs => {
			console.log("obs", obs);
		},
		err => {
			console.log("err", err);
		}
	);

logs nothing and let droplet = await doc.Droplet.create(specs).toPromise(); returns undefined.

The droplet is successfully created though and the response contains the correct data:

data: 
   { droplet: 
      { id: ...,
        name: ...,
        memory: 1024,
        vcpus: 1,
        disk: 25,
        locked: true,
        status: 'new',
        kernel: null,
        created_at: '2018-02-27T20:12:59Z',
...

Invalid api response when trying to Image.list()

digitalOcean.Image.list()...
digitalOcean.Image.list('application')...

gives me Invalid api response

[v3] project readme/issue template

[v3] region

list-regions

[v3] snapshot

Delete volume by name

The DigitalOcean API supports deleting a droplet by its name. This seems to not be supported by this library however.

For droplets, the following exists:

droplet.deleteDropletsByTag({ tag_name: "my tag" })

A similar method should exist, but for volumes and the volume name.

volume.deleteVolumeByName({ name: "my name", region: "fra1" })

List Droplet By Tag

Is your feature request related to a problem? Please describe.
I need the droplet ID, and the only way to query is by tag.

Describe the solution you'd like
try {
const input = {
per_page=2,
page=1,
tag_name: 'tagname',
};
const {
data: { dropletId },
} = await dots.droplet.listDroplets(input);
console.log(dropletId);
} catch (error) {
console.log(error);
}

Describe alternatives you've considered
Nothing yet. I would hate to have to shell out to use doctl.

Is your request a new API endpoint?
https://docs.digitalocean.com/reference/api/api-reference/#operation/list_all_droplets

Additional context
Nope I think that gets it. My understanding there is no way to get a specific droplet ID without query the tag.

Brad

[fix] vulnerabilities dependencies

CVE-2017-17461 Moderate severity
CVE-2017-1000427 Moderate severity

how to specify the domain name to add the record to?

try {
const input = {
type: "A", // string
name: "www", // string
data: "162.10.66.0", // string
priority: null, // number
port: null, // number
ttl: 1800, // number
weight: null, // number
flags: null, // number
tag: null // string
};
const {data:{domain_record}} = await dots.domain.createDomainRecord(input);
console.log(domain_record);
} catch (error) {
console.log(error);
}

in the api docs it is part of the url
https://api.digitalocean.com/v2/domains/{domain_name}/records