directus-sdk-javascript - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

index.js

@@ -54,3 +54,3 @@ module.exports = function(e) {
     "use strict";
-    var i = r(4), a = i.buildPath, o = i.performRequest, s = r(8), n = s.createItem, l = s.getItems, c = s.getItem, u = s.updateItem, d = s.deleteItem, p = r(10), f = p.createFile, m = p.getFiles, b = p.getFile, T = p.updateFile, h = r(11), k = h.getTables, v = h.getTable, g = h.createTable, O = r(12), N = O.createColumn, R = O.getColumns, I = O.getColumn, q = O.updateColumn, C = O.deleteColumn, E = r(13), y = E.createPrivilege, F = E.getGroupPrivilege, B = E.getTablePrivilege, G = E.updatePrivilege, U = r(14), P = U.getPreference, S = U.updatePreference, j = r(15), x = j.getMessages, w = j.getMessage, L = r(16), J = L.getActivity, V = r(17), _ = V.getBookmarks, D = V.getUserBookmarks, A = V.getBookmark, M = V.createBookmark, z = V.deleteBookmark, H = r(18), Y = H.getSettings, K = H.getSettingsByCollection, Q = H.updateSettings;
+    var i = r(4), a = i.buildPath, o = i.performRequest, s = r(8), n = s.createItem, l = s.getItems, c = s.getItem, u = s.updateItem, d = s.deleteItem, p = r(10), f = p.createFile, m = p.getFiles, b = p.getFile, T = p.updateFile, h = r(11), k = h.getTables, v = h.getTable, g = h.createTable, O = r(12), N = O.createColumn, R = O.getColumns, I = O.getColumn, q = O.updateColumn, C = O.deleteColumn, E = r(13), y = E.createPrivilege, F = E.getGroupPrivilege, B = E.getTablePrivilege, G = E.updatePrivilege, U = r(14), P = U.getPreference, S = U.updatePreference, j = r(15), x = j.getMessages, J = j.getMessage, L = r(16), w = L.getActivity, _ = r(17), V = _.getBookmarks, D = _.getUserBookmarks, A = _.getBookmark, M = _.createBookmark, z = _.deleteBookmark, H = r(18), Y = H.getSettings, K = H.getSettingsByCollection, Q = H.updateSettings;
     e.exports = {
@@ -83,5 +83,5 @@ buildPath: a,
         getMessages: x,
-        getMessage: w,
-        getActivity: J,
-        getBookmarks: _,
+        getMessage: J,
+        getActivity: w,
+        getBookmarks: V,
         getUserBookmarks: D,
@@ -412,4 +412,2 @@ getBookmark: A,
             var e = i([ {
-                id: i.INT | i.Required
-            }, {
                 data: i.OBJECT | i.Required
@@ -419,3 +417,3 @@ }, {
             } ], arguments), t = a.defer(), r = [ e.id ];
-            return this.performRequest("POST", this.endpoints.columnList, r, e.data, function(e, r) {
+            return this.performRequest("POST", this.endpoints.groupPrivileges, r, e.data, function(e, r) {
                 e && t.reject(e), t.resolve(r);
@@ -430,3 +428,3 @@ }), t.promise.nodeify(e.callback);
             } ], arguments), t = a.defer(), r = [ e.id ];
-            return this.performRequest("GET", this.endpoints.columnList, r, function(e, r) {
+            return this.performRequest("GET", this.endpoints.groupPrivileges, r, function(e, r) {
                 e && t.reject(e), t.resolve(r);
@@ -466,3 +464,3 @@ }), t.promise.nodeify(e.callback);
     e.exports = {
-        getPreference: function() {
+        getPreferences: function() {
             var e = i([ {
@@ -477,3 +475,3 @@ table: i.STRING | i.Required
         },
-        updatePreference: function() {
+        updatePreferences: function() {
             var e = i([ {
@@ -539,3 +537,2 @@ table: i.STRING | i.Required
         getBookmarks: function() {
-            if (this.apiVersion < 1.1) throw Error("This method can't be used with api version " + this.apiVersion + " use version ^1.1 instead");
             var e = i([ {
@@ -558,3 +555,2 @@ callback: i.FUNCTION | i.Optional
         getBookmark: function() {
-            if (this.apiVersion < 1.1) throw Error("This method can't be used with api version " + this.apiVersion + " use version ^1.1 instead");
             var e = i([ {
@@ -561,0 +557,0 @@ id: i.INT | i.Required

package.json

 {
   "name": "directus-sdk-javascript",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "WIP - Directus SDK for JavaScript (Node and Browser)",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -10,150 +10,38 @@ # directus-sdk-javascript
 
-## Work in progress
+## Installation and Usage
 
-## Install
-
+Install the package via npm
 `npm install directus-sdk-javascript`
 
-## Usage
+Initialize the SDK object with your the desired api key and url
 
-### Directus Hosted
 ```javascript
-const DirectusSDK = require('directus-sdk-javascript');
+const SDK = require('directus-sdk-javascript');
 
-const client = new DirectusSDK('user-token', {
-  // the sub-domain in your instance url
-  instanceKey: 'user--instance'
-});
-
-client.getEntries('articles', (err, res) => {
-  if(err) throw err;
-  res.forEach((article) => {
-    console.log(article.title);
-  });
-});
+const client = new SDK(
+  'api-key-12345',
+  'http://directus.url/api/', // Directus-hosted or own server
+  1.1 // API Version
+);
 ```
 
-### Own Server
+All methods can be used with either callbacks or promises.
+
 ```javascript
-const DirectusSDK = require('directus-sdk-javascript');
-
-const client = new DirectusSDK('user-token', {
-  baseUrl: 'http://yoursite.com/api',
-  apiVersion: 1 // Optional - default 1
-});
-
-client.getEntries('articles', (err, res) => {
+client.getEntries('projects', (err, res) => {
   if(err) throw err;
-  res.forEach((article) => {
-    console.log(article.title);
-  });
+  console.log(res);
 });
 ```
 
-## Supported Methods / Endpoints
-
-_All methods can be used with either callbacks **or** promises_
-
-_For more info on what parameters are supported: check the [official Directus API docs](http://getdirectus.com/api/overview/api-overview)_
-
 ```javascript
-client.getTables([Function callback]);
+client.getEntries('projects')
+  .then(res => {
+    console.log(res);
+  })
+  .catch(err => {
+    throw err;
+  });
 ```
 
-```javascript
-client.getTable(String table, [Function callback]);
-```
-
-
-```javascript
-client.getColumns(String table, [Object params, Function callback]);
-```
-
-```javascript
-client.getColumn(String table, String column, [Function callback]);
-```
-
-
-```javascript
-client.getEntries(String table, [Object params, Function callback]);
-```
-
-```javascript
-client.getEntry(String table, Number id, [Object params, Function callback]);
-```
-
-```javascript
-client.createEntry(String table, Object data, [Function callback]);
-```
-
-```javascript
-client.updateEntry(String table, Number id, Object data, [Function callback]);
-```
-
-```javascript
-client.deleteEntry(String table, Number id, [deleteFromDB: Boolean = false, Function callback]);
-```
-
-
-```javascript
-client.getUser([Object params, Function callback]);
-```
-
-```javascript
-client.getUser(Number id, [Object params, Function callback]);
-```
-
-```javascript
-client.createUse(Object data, [Function callback]);
-```
-
-```javascript
-client.updateUser(Number id, Object data, [Function callback]);
-```
-
-```javascript
-client.deleteUser(Number id, [deleteFromDB: Boolean = false, Function callback]);
-```
-
-
-```javascript
-client.getGroup([Object params, Function callback]);
-```
-
-```javascript
-client.getGroup(Number id, [Object params, Function callback]);
-```
-
-```javascript
-client.getGroupPrivileges(Number id, [Function callback]);
-```
-
-
-```javascript
-client.getFile([Object params, Function callback]);
-```
-
-```javascript
-client.getFile(Number id, Object params, Function callback]);
-```
-
-```javascript
-client.createFile(Object data, [Function callback]);
-```
-
-```javascript
-client.updateFile(Number id, Object data, [Function callback]);
-```
-
-```javascript
-client.deleteFile(Number id, [deleteFromDB: Boolean = false, Function callback]);
-```
-
-
-```javascript
-client.getSettings([Function callback]);
-```
-
-```javascript
-client.getSettingsByCollection(String collectionName, [Function callback]);
-```
+Check [the official API docs for a complete overview of all endpoints and available methods](http://api.getdirectus.com/1.1/)

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

87500

decreased by-2.88%

Lines of code

1374

decreased by-0.29%

Number of lines in readme file

47

decreased by-70.44%

No dependency changes