Socket
Socket
Sign inDemoInstall

@ndustrial/contxt-sdk

Package Overview
Dependencies
82
Maintainers
12
Versions
123
Alerts
File Explorer

Advanced tools

npm Scripts
License

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 3.0.1 to 3.0.2

6

CHANGELOG.md

@@ -0,1 +1,7 @@

## [v3.0.2](http://github.com/ndustrialio/contxt-sdk-js/tree/v3.0.2) (2021-01-13)
**Changed**
- Fixed API URLs for `Coordinator.roles#addProjectEnvironment`, `Coordinator.roles#removeProjectEnvironment`, `Coordinator.users#addProjectEnvironment`, `Coordinator.users#removeProjectEnvironment` and updated the parameters so a project slug is no longer needed
## [v3.0.1](http://github.com/ndustrialio/contxt-sdk-js/tree/v3.0.1) (2021-01-11)

@@ -2,0 +8,0 @@

18

docs/Roles.md

@@ -11,3 +11,3 @@ <a name="Roles"></a>

* [.addApplication(roleId, applicationId)](#Roles+addApplication) ⇒ <code>Promise</code>
* [.addProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug, accessType)](#Roles+addProjectEnvironment) ⇒ <code>Promise</code>
* [.addProjectEnvironment(roleId, projectEnvironmentSlug, accessType)](#Roles+addProjectEnvironment) ⇒ <code>Promise</code>
* [.create(organizationId, role)](#Roles+create) ⇒ <code>Promise</code>

@@ -17,3 +17,3 @@ * [.delete(organizationId, roleId)](#Roles+delete) ⇒ <code>Promise</code>

* [.removeApplication(roleId, applicationId)](#Roles+removeApplication) ⇒ <code>Promise</code>
* [.removeProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug)](#Roles+removeProjectEnvironment) ⇒ <code>Promise</code>
* [.removeProjectEnvironment(roleId, projectEnvironmentSlug)](#Roles+removeProjectEnvironment) ⇒ <code>Promise</code>

@@ -57,6 +57,6 @@ <a name="new_Roles_new"></a>

### contxtSdk.coordinator.roles.addProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug, accessType) ⇒ <code>Promise</code>
### contxtSdk.coordinator.roles.addProjectEnvironment(roleId, projectEnvironmentSlug, accessType) ⇒ <code>Promise</code>
Add a project environment to a role
API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
Method: POST

@@ -71,3 +71,2 @@

| roleId | <code>string</code> | The UUID formatted ID of the role |
| projectSlug | <code>string</code> | The slug of the project |
| projectEnvironmentSlug | <code>string</code> | The slug of the project environment |

@@ -79,3 +78,3 @@ | accessType | <code>&#x27;reader&#x27;</code> \| <code>&#x27;admin&#x27;</code> | The level of access for the role |

contxtSdk.roles
.addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
.addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
.then((roleProject) => console.log(roleProject))

@@ -181,6 +180,6 @@ .catch((err) => console.log(err));

### contxtSdk.coordinator.roles.removeProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug) ⇒ <code>Promise</code>
### contxtSdk.coordinator.roles.removeProjectEnvironment(roleId, projectEnvironmentSlug) ⇒ <code>Promise</code>
Remove a project environment from a role
API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
Method: DELETE

@@ -195,3 +194,2 @@

| roleId | <code>string</code> | The UUID formatted ID of the role |
| projectSlug | <code>string</code> | The slug of the project |
| projectEnvironmentSlug | <code>string</code> | The slug of the project environment |

@@ -202,4 +200,4 @@

contxtSdk.roles
.removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
.removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
.catch((err) => console.log(err));
```

18

docs/Users.md

@@ -13,3 +13,3 @@ <a name="Users"></a>

* [.addRole(userId, roleId)](#Users+addRole) ⇒ <code>Promise</code>
* [.addProjectEnvironment(userId, projectSlug, projectEnvironmentSlug, accessType)](#Users+addProjectEnvironment) ⇒ <code>Promise</code>
* [.addProjectEnvironment(userId, projectEnvironmentSlug, accessType)](#Users+addProjectEnvironment) ⇒ <code>Promise</code>
* [.get(userId)](#Users+get) ⇒ <code>Promise</code>

@@ -21,3 +21,3 @@ * [.getByOrganizationId(organizationId)](#Users+getByOrganizationId) ⇒ <code>Promise</code>

* [.removeRole(userId, roleId)](#Users+removeRole) ⇒ <code>Promise</code>
* [.removeProjectEnvironment(userId, projectSlug, projectEnvironmentSlug)](#Users+removeProjectEnvironment) ⇒ <code>Promise</code>
* [.removeProjectEnvironment(userId, projectEnvironmentSlug)](#Users+removeProjectEnvironment) ⇒ <code>Promise</code>
* [.sync(userId)](#Users+sync) ⇒ <code>Promise</code>

@@ -121,6 +121,6 @@

### contxtSdk.coordinator.users.addProjectEnvironment(userId, projectSlug, projectEnvironmentSlug, accessType) ⇒ <code>Promise</code>
### contxtSdk.coordinator.users.addProjectEnvironment(userId, projectEnvironmentSlug, accessType) ⇒ <code>Promise</code>
Adds a project environment to a user
API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
API Endpoint: '/users/:userId/project_environments/:projectEnvironmentSlug
Method: POST

@@ -135,3 +135,2 @@

| userId | <code>string</code> | The ID of the user |
| projectSlug | <code>string</code> | The slug of the project |
| projectEnvironmentSlug | <code>string</code> | The slug of the project environment |

@@ -143,3 +142,3 @@ | accessType | <code>&#x27;reader&#x27;</code> \| <code>&#x27;admin&#x27;</code> | The level of access for the user |

contxtSdk.coordinator.users
.addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
.addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
.then((userProject) => console.log(userProject))

@@ -304,6 +303,6 @@ .catch((err) => console.log(err));

### contxtSdk.coordinator.users.removeProjectEnvironment(userId, projectSlug, projectEnvironmentSlug) ⇒ <code>Promise</code>
### contxtSdk.coordinator.users.removeProjectEnvironment(userId, projectEnvironmentSlug) ⇒ <code>Promise</code>
Removes a project environment from a user
API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
API Endpoint: 'users/:userId/project_environments/:projectEnvironmentSlug
Method: DELETE

@@ -318,3 +317,2 @@

| userId | <code>string</code> | The ID of the user |
| projectSlug | <code>string</code> | The ID of the project |
| projectEnvironmentSlug | <code>string</code> | The slug of the project environment |

@@ -325,3 +323,3 @@

contxtSdk.coordinator.users
.removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
.removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
.catch((err) => console.log(err));

@@ -328,0 +326,0 @@ ```

26

esm/coordinator/roles.js

@@ -114,7 +114,6 @@ var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
* API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
* Method: POST
*
* @param {string} roleId The UUID formatted ID of the role
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -129,3 +128,3 @@ * @param {'reader' | 'admin'} accessType The level of access for the role

* contxtSdk.roles
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
* .then((roleProject) => console.log(roleProject))

@@ -137,3 +136,3 @@ * .catch((err) => console.log(err));

key: 'addProjectEnvironment',
value: function addProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug, accessType) {
value: function addProjectEnvironment(roleId, projectEnvironmentSlug, accessType) {
if (!roleId) {

@@ -143,6 +142,2 @@ return Promise.reject(new Error('A roleId is required for adding a project environment to a role.'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for adding a project environment to a role.'));
}
if (!projectEnvironmentSlug) {

@@ -156,3 +151,3 @@ return Promise.reject(new Error('A project environment slug is required for adding a project environment to a role.'));

return this._request.post(this._baseUrl + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/roles/' + roleId, {
return this._request.post(this._baseUrl + '/roles/' + roleId + '/project_environments/' + projectEnvironmentSlug, {
access_type: accessType

@@ -336,7 +331,6 @@ }).then(function (response) {

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
* API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
* Method: DELETE
*
* @param {string} roleId The UUID formatted ID of the role
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -350,3 +344,3 @@ *

* contxtSdk.roles
* .removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
* .removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
* .catch((err) => console.log(err));

@@ -357,3 +351,3 @@ */

key: 'removeProjectEnvironment',
value: function removeProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug) {
value: function removeProjectEnvironment(roleId, projectEnvironmentSlug) {
if (!roleId) {

@@ -363,6 +357,2 @@ return Promise.reject(new Error('A roleId is required for removing a project environment from a role.'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for removing a project environment from a role.'));
}
if (!projectEnvironmentSlug) {

@@ -372,3 +362,3 @@ return Promise.reject(new Error('A project environment slug is required for removing a project environment from a role.'));

return this._request.delete(this._baseUrl + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/roles/' + roleId);
return this._request.delete(this._baseUrl + '/roles/' + roleId + '/project_environments/' + projectEnvironmentSlug);
}

@@ -375,0 +365,0 @@ }]);

26

esm/coordinator/users.js

@@ -223,7 +223,6 @@ var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
* API Endpoint: '/users/:userId/project_environments/:projectEnvironmentSlug
* Method: POST
*
* @param {string} userId The ID of the user
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -238,3 +237,3 @@ * @param {'reader' | 'admin'} accessType The level of access for the user

* contxtSdk.coordinator.users
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
* .then((userProject) => console.log(userProject))

@@ -246,3 +245,3 @@ * .catch((err) => console.log(err));

key: 'addProjectEnvironment',
value: function addProjectEnvironment(userId, projectSlug, projectEnvironmentSlug, accessType) {
value: function addProjectEnvironment(userId, projectEnvironmentSlug, accessType) {
if (!userId) {

@@ -252,6 +251,2 @@ return Promise.reject(new Error('A user ID is required for adding a project environment to a user'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for adding a project environment to a user'));
}
if (!projectEnvironmentSlug) {

@@ -265,3 +260,3 @@ return Promise.reject(new Error('A project environment slug is required for adding a project environment to a user.'));

return this._request.post(this._getBaseUrl() + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/users/' + userId, {
return this._request.post(this._getBaseUrl() + '/users/' + userId + '/project_environments/' + projectEnvironmentSlug, {
access_type: accessType

@@ -529,7 +524,6 @@ }).then(function (response) {

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
* API Endpoint: 'users/:userId/project_environments/:projectEnvironmentSlug
* Method: DELETE
*
* @param {string} userId The ID of the user
* @param {string} projectSlug The ID of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -543,3 +537,3 @@ *

* contxtSdk.coordinator.users
* .removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
* .removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
* .catch((err) => console.log(err));

@@ -550,3 +544,3 @@ */

key: 'removeProjectEnvironment',
value: function removeProjectEnvironment(userId, projectSlug, projectEnvironmentSlug) {
value: function removeProjectEnvironment(userId, projectEnvironmentSlug) {
if (!userId) {

@@ -556,6 +550,2 @@ return Promise.reject(new Error('A user ID is required for removing a project environment from a user'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for removing a project environment from a user'));
}
if (!projectEnvironmentSlug) {

@@ -565,3 +555,3 @@ return Promise.reject(new Error('A project environment slug is required for removing a project environment from a user.'));

return this._request.delete(this._getBaseUrl() + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/users/' + userId);
return this._request.delete(this._getBaseUrl() + '/users/' + userId + '/project_environments/' + projectEnvironmentSlug);
}

@@ -568,0 +558,0 @@

26

lib/coordinator/roles.js

@@ -119,7 +119,6 @@ 'use strict';

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
* API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
* Method: POST
*
* @param {string} roleId The UUID formatted ID of the role
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -134,3 +133,3 @@ * @param {'reader' | 'admin'} accessType The level of access for the role

* contxtSdk.roles
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
* .then((roleProject) => console.log(roleProject))

@@ -142,3 +141,3 @@ * .catch((err) => console.log(err));

key: 'addProjectEnvironment',
value: function addProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug, accessType) {
value: function addProjectEnvironment(roleId, projectEnvironmentSlug, accessType) {
if (!roleId) {

@@ -148,6 +147,2 @@ return Promise.reject(new Error('A roleId is required for adding a project environment to a role.'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for adding a project environment to a role.'));
}
if (!projectEnvironmentSlug) {

@@ -161,3 +156,3 @@ return Promise.reject(new Error('A project environment slug is required for adding a project environment to a role.'));

return this._request.post(this._baseUrl + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/roles/' + roleId, {
return this._request.post(this._baseUrl + '/roles/' + roleId + '/project_environments/' + projectEnvironmentSlug, {
access_type: accessType

@@ -341,7 +336,6 @@ }).then(function (response) {

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
* API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
* Method: DELETE
*
* @param {string} roleId The UUID formatted ID of the role
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -355,3 +349,3 @@ *

* contxtSdk.roles
* .removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
* .removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
* .catch((err) => console.log(err));

@@ -362,3 +356,3 @@ */

key: 'removeProjectEnvironment',
value: function removeProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug) {
value: function removeProjectEnvironment(roleId, projectEnvironmentSlug) {
if (!roleId) {

@@ -368,6 +362,2 @@ return Promise.reject(new Error('A roleId is required for removing a project environment from a role.'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for removing a project environment from a role.'));
}
if (!projectEnvironmentSlug) {

@@ -377,3 +367,3 @@ return Promise.reject(new Error('A project environment slug is required for removing a project environment from a role.'));

return this._request.delete(this._baseUrl + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/roles/' + roleId);
return this._request.delete(this._baseUrl + '/roles/' + roleId + '/project_environments/' + projectEnvironmentSlug);
}

@@ -380,0 +370,0 @@ }]);

26

lib/coordinator/users.js

@@ -232,7 +232,6 @@ 'use strict';

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
* API Endpoint: '/users/:userId/project_environments/:projectEnvironmentSlug
* Method: POST
*
* @param {string} userId The ID of the user
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -247,3 +246,3 @@ * @param {'reader' | 'admin'} accessType The level of access for the user

* contxtSdk.coordinator.users
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
* .then((userProject) => console.log(userProject))

@@ -255,3 +254,3 @@ * .catch((err) => console.log(err));

key: 'addProjectEnvironment',
value: function addProjectEnvironment(userId, projectSlug, projectEnvironmentSlug, accessType) {
value: function addProjectEnvironment(userId, projectEnvironmentSlug, accessType) {
if (!userId) {

@@ -261,6 +260,2 @@ return Promise.reject(new Error('A user ID is required for adding a project environment to a user'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for adding a project environment to a user'));
}
if (!projectEnvironmentSlug) {

@@ -274,3 +269,3 @@ return Promise.reject(new Error('A project environment slug is required for adding a project environment to a user.'));

return this._request.post(this._getBaseUrl() + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/users/' + userId, {
return this._request.post(this._getBaseUrl() + '/users/' + userId + '/project_environments/' + projectEnvironmentSlug, {
access_type: accessType

@@ -538,7 +533,6 @@ }).then(function (response) {

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
* API Endpoint: 'users/:userId/project_environments/:projectEnvironmentSlug
* Method: DELETE
*
* @param {string} userId The ID of the user
* @param {string} projectSlug The ID of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -552,3 +546,3 @@ *

* contxtSdk.coordinator.users
* .removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
* .removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
* .catch((err) => console.log(err));

@@ -559,3 +553,3 @@ */

key: 'removeProjectEnvironment',
value: function removeProjectEnvironment(userId, projectSlug, projectEnvironmentSlug) {
value: function removeProjectEnvironment(userId, projectEnvironmentSlug) {
if (!userId) {

@@ -565,6 +559,2 @@ return Promise.reject(new Error('A user ID is required for removing a project environment from a user'));

if (!projectSlug) {
return Promise.reject(new Error('A project slug is required for removing a project environment from a user'));
}
if (!projectEnvironmentSlug) {

@@ -574,3 +564,3 @@ return Promise.reject(new Error('A project environment slug is required for removing a project environment from a user.'));

return this._request.delete(this._getBaseUrl() + '/projects/' + projectSlug + '/environments/' + projectEnvironmentSlug + '/users/' + userId);
return this._request.delete(this._getBaseUrl() + '/users/' + userId + '/project_environments/' + projectEnvironmentSlug);
}

@@ -577,0 +567,0 @@

2

package.json
{
"name": "@ndustrial/contxt-sdk",
"version": "3.0.1",
"version": "3.0.2",
"description": "",

@@ -5,0 +5,0 @@ "main": "lib/index.js",

39

src/coordinator/roles.js

@@ -107,7 +107,6 @@ import { toSnakeCase, toCamelCase } from '../utils/objects';

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
* API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
* Method: POST
*
* @param {string} roleId The UUID formatted ID of the role
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -122,12 +121,7 @@ * @param {'reader' | 'admin'} accessType The level of access for the role

* contxtSdk.roles
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
* .then((roleProject) => console.log(roleProject))
* .catch((err) => console.log(err));
*/
addProjectEnvironment(
roleId,
projectSlug,
projectEnvironmentSlug,
accessType
) {
addProjectEnvironment(roleId, projectEnvironmentSlug, accessType) {
if (!roleId) {

@@ -141,10 +135,2 @@ return Promise.reject(

if (!projectSlug) {
return Promise.reject(
new Error(
'A project slug is required for adding a project environment to a role.'
)
);
}
if (!projectEnvironmentSlug) {

@@ -170,3 +156,3 @@ return Promise.reject(

this._baseUrl
}/projects/${projectSlug}/environments/${projectEnvironmentSlug}/roles/${roleId}`,
}/roles/${roleId}/project_environments/${projectEnvironmentSlug}`,
{

@@ -374,7 +360,6 @@ access_type: accessType

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/roles/:roleId/'
* API Endpoint: 'roles/:roleId/project_environments/:projectEnvironmentSlug'
* Method: DELETE
*
* @param {string} roleId The UUID formatted ID of the role
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -388,6 +373,6 @@ *

* contxtSdk.roles
* .removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
* .removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
* .catch((err) => console.log(err));
*/
removeProjectEnvironment(roleId, projectSlug, projectEnvironmentSlug) {
removeProjectEnvironment(roleId, projectEnvironmentSlug) {
if (!roleId) {

@@ -401,10 +386,2 @@ return Promise.reject(

if (!projectSlug) {
return Promise.reject(
new Error(
'A project slug is required for removing a project environment from a role.'
)
);
}
if (!projectEnvironmentSlug) {

@@ -421,3 +398,3 @@ return Promise.reject(

this._baseUrl
}/projects/${projectSlug}/environments/${projectEnvironmentSlug}/roles/${roleId}`
}/roles/${roleId}/project_environments/${projectEnvironmentSlug}`
);

@@ -424,0 +401,0 @@ }

69

src/coordinator/roles.spec.js

@@ -171,3 +171,2 @@ import Roles from './roles';

let request;
let project;
let projectEnvironment;

@@ -179,3 +178,2 @@ let role;

beforeEach(function() {
project = fixture.build('contxtProject');
projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -206,3 +204,2 @@ role = fixture.build('contxtRole');

role.id,
project.slug,
projectEnvironment.slug,

@@ -215,5 +212,5 @@ expectedRoleProjectEnvironment.accessType

expect(request.post).to.be.calledWith(
`${expectedHost}/projects/${project.slug}/environments/${
`${expectedHost}/roles/${role.id}/project_environments/${
projectEnvironment.slug
}/roles/${role.id}`,
}`,
{

@@ -243,3 +240,2 @@ access_type: expectedRoleProjectEnvironment.accessType

it('throws an error', function() {
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -253,3 +249,2 @@ const roleProjectEnvironment = fixture.build(

null,
project.slug,
projectEnvironment.slug,

@@ -265,27 +260,5 @@ roleProjectEnvironment.accessType

context('when the project slug is not provided', function() {
it('throws an error', function() {
const role = fixture.build('contxtRole');
const projectEnvironment = fixture.build('contxtProjectEnvironment');
const roleProjectEnvironment = fixture.build(
'contxtRoleProjectEnvironment'
);
const roles = new Roles(baseSdk, baseRequest, expectedHost);
const promise = roles.addProjectEnvironment(
role.id,
null,
projectEnvironment.slug,
roleProjectEnvironment.accessType
);
return expect(promise).to.be.rejectedWith(
'A project slug is required for adding a project environment to a role.'
);
});
});
context('when the project environment slug is not provided', function() {
it('throws an error', function() {
const role = fixture.build('contxtRole');
const project = fixture.build('contxtProject');
const roleProjectEnvironment = fixture.build(

@@ -297,3 +270,2 @@ 'contxtRoleProjectEnvironment'

role.id,
project.slug,
null,

@@ -312,3 +284,2 @@ roleProjectEnvironment.accessType

const role = fixture.build('contxtRole');
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -318,3 +289,2 @@ const roles = new Roles(baseSdk, baseRequest, expectedHost);

role.id,
project.slug,
projectEnvironment.slug,

@@ -333,3 +303,2 @@ null

const role = fixture.build('contxtRole');
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -340,3 +309,2 @@

role.id,
project.slug,
projectEnvironment.slug,

@@ -936,3 +904,2 @@ faker.random.word()

context('when all required parameters are provided', function() {
let project;
let projectEnvironment;

@@ -943,3 +910,2 @@ let role;

beforeEach(function() {
project = fixture.build('contxtProject');
projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -951,3 +917,2 @@ role = fixture.build('contxtRole');

role.id,
project.slug,
projectEnvironment.slug

@@ -959,5 +924,5 @@ );

expect(baseRequest.delete).to.be.calledWith(
`${expectedHost}/projects/${project.slug}/environments/${
`${expectedHost}/roles/${role.id}/project_environments/${
projectEnvironment.slug
}/roles/${role.id}`
}`
);

@@ -973,3 +938,2 @@ });

it('throws an error', function() {
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -979,3 +943,2 @@ const roles = new Roles(baseSdk, baseRequest, expectedHost);

null,
project.slug,
projectEnvironment.slug

@@ -990,29 +953,7 @@ );

context('when the project slug is not provided', function() {
it('throws an error', function() {
const projectEnvironment = fixture.build('contxtProjectEnvironment');
const role = fixture.build('contxtRole');
const roles = new Roles(baseSdk, baseRequest, expectedHost);
const promise = roles.removeProjectEnvironment(
role.id,
null,
projectEnvironment.slug
);
return expect(promise).to.be.rejectedWith(
'A project slug is required for removing a project environment from a role.'
);
});
});
context('when the project environment slug is not provided', function() {
it('throws an error', function() {
const project = fixture.build('contxtProject');
const role = fixture.build('contxtRole');
const roles = new Roles(baseSdk, baseRequest, expectedHost);
const promise = roles.removeProjectEnvironment(
role.id,
project.slug,
null
);
const promise = roles.removeProjectEnvironment(role.id, null);

@@ -1019,0 +960,0 @@ return expect(promise).to.be.rejectedWith(

39

src/coordinator/users.js

@@ -225,7 +225,6 @@ import axios from 'axios';

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
* API Endpoint: '/users/:userId/project_environments/:projectEnvironmentSlug
* Method: POST
*
* @param {string} userId The ID of the user
* @param {string} projectSlug The slug of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -240,12 +239,7 @@ * @param {'reader' | 'admin'} accessType The level of access for the user

* contxtSdk.coordinator.users
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug', 'admin')
* .addProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug', 'admin')
* .then((userProject) => console.log(userProject))
* .catch((err) => console.log(err));
*/
addProjectEnvironment(
userId,
projectSlug,
projectEnvironmentSlug,
accessType
) {
addProjectEnvironment(userId, projectEnvironmentSlug, accessType) {
if (!userId) {

@@ -259,10 +253,2 @@ return Promise.reject(

if (!projectSlug) {
return Promise.reject(
new Error(
'A project slug is required for adding a project environment to a user'
)
);
}
if (!projectEnvironmentSlug) {

@@ -286,3 +272,3 @@ return Promise.reject(

.post(
`${this._getBaseUrl()}/projects/${projectSlug}/environments/${projectEnvironmentSlug}/users/${userId}`,
`${this._getBaseUrl()}/users/${userId}/project_environments/${projectEnvironmentSlug}`,
{

@@ -580,7 +566,6 @@ access_type: accessType

*
* API Endpoint: 'projects/:projectSlug/environments/:projectEnvironmentSlug/users/:userId
* API Endpoint: 'users/:userId/project_environments/:projectEnvironmentSlug
* Method: DELETE
*
* @param {string} userId The ID of the user
* @param {string} projectSlug The ID of the project
* @param {string} projectEnvironmentSlug The slug of the project environment

@@ -594,6 +579,6 @@ *

* contxtSdk.coordinator.users
* .removeProject('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-slug', 'project-environment-slug')
* .removeProjectEnvironment('36b8421a-cc4a-4204-b839-1397374fb16b', 'project-environment-slug')
* .catch((err) => console.log(err));
*/
removeProjectEnvironment(userId, projectSlug, projectEnvironmentSlug) {
removeProjectEnvironment(userId, projectEnvironmentSlug) {
if (!userId) {

@@ -607,10 +592,2 @@ return Promise.reject(

if (!projectSlug) {
return Promise.reject(
new Error(
'A project slug is required for removing a project environment from a user'
)
);
}
if (!projectEnvironmentSlug) {

@@ -625,3 +602,3 @@ return Promise.reject(

return this._request.delete(
`${this._getBaseUrl()}/projects/${projectSlug}/environments/${projectEnvironmentSlug}/users/${userId}`
`${this._getBaseUrl()}/users/${userId}/project_environments/${projectEnvironmentSlug}`
);

@@ -628,0 +605,0 @@ }

69

src/coordinator/users.spec.js

@@ -458,3 +458,2 @@ import axios from 'axios';

let request;
let project;
let projectEnvironment;

@@ -466,3 +465,2 @@ let user;

beforeEach(function() {
project = fixture.build('contxtProject');
projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -498,3 +496,2 @@ user = fixture.build('contxtUser');

user.id,
project.slug,
projectEnvironment.slug,

@@ -511,5 +508,5 @@ expectedUserProjectEnvironment.accessType

expect(request.post).to.be.calledWith(
`${expectedTenantBaseUrl}/projects/${project.slug}/environments/${
`${expectedTenantBaseUrl}/users/${user.id}/project_environments/${
projectEnvironment.slug
}/users/${user.id}`,
}`,
{

@@ -537,3 +534,2 @@ access_type: expectedUserProjectEnvironment.accessType

it('throws an error', function() {
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -547,3 +543,2 @@ const userProjectEnvironment = fixture.build(

null,
project.slug,
projectEnvironment.slug,

@@ -559,27 +554,5 @@ userProjectEnvironment.accessType

context('when the project slug is not provided', function() {
it('throws an error', function() {
const user = fixture.build('contxtUser');
const projectEnvironment = fixture.build('contxtProjectEnvironment');
const userProjectEnvironment = fixture.build(
'contxtUserProjectEnvironment'
);
const users = new Users(baseSdk, baseRequest, expectedTenantBaseUrl);
const promise = users.addProjectEnvironment(
user.id,
null,
projectEnvironment.slug,
userProjectEnvironment.accessType
);
return expect(promise).to.be.rejectedWith(
'A project slug is required for adding a project environment to a user'
);
});
});
context('when the project environment slug is not provided', function() {
it('throws an error', function() {
const user = fixture.build('contxtUser');
const project = fixture.build('contxtProject');
const userProjectEnvironment = fixture.build(

@@ -591,3 +564,2 @@ 'contxtUserProjectEnvironment'

user.id,
project.slug,
null,

@@ -606,3 +578,2 @@ userProjectEnvironment.accessType

const user = fixture.build('contxtUser');
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -612,3 +583,2 @@ const users = new Users(baseSdk, baseRequest, expectedTenantBaseUrl);

user.id,
project.slug,
projectEnvironment.slug,

@@ -627,3 +597,2 @@ null

const user = fixture.build('contxtUser');
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -633,3 +602,2 @@ const users = new Users(baseSdk, baseRequest, expectedTenantBaseUrl);

user.id,
project.slug,
projectEnvironment.slug,

@@ -1370,3 +1338,2 @@ faker.random.word()

let getBaseUrl;
let project;
let projectEnvironment;

@@ -1377,3 +1344,2 @@ let user;

beforeEach(function() {
project = fixture.build('contxtProject');
projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -1390,3 +1356,2 @@ user = fixture.build('contxtUser');

user.id,
project.slug,
projectEnvironment.slug

@@ -1402,5 +1367,5 @@ );

expect(baseRequest.delete).to.be.calledWith(
`${expectedTenantBaseUrl}/projects/${project.slug}/environments/${
`${expectedTenantBaseUrl}/users/${user.id}/project_environments/${
projectEnvironment.slug
}/users/${user.id}`
}`
);

@@ -1416,3 +1381,2 @@ });

it('throws an error', function() {
const project = fixture.build('contxtProject');
const projectEnvironment = fixture.build('contxtProjectEnvironment');

@@ -1422,3 +1386,2 @@ const users = new Users(baseSdk, baseRequest, expectedTenantBaseUrl);

null,
project.slug,
projectEnvironment.slug

@@ -1433,29 +1396,7 @@ );

context('when the project slug is not provided', function() {
it('throws an error', function() {
const projectEnvironment = fixture.build('contxtProjectEnvironment');
const user = fixture.build('contxtUser');
const users = new Users(baseSdk, baseRequest, expectedTenantBaseUrl);
const promise = users.removeProjectEnvironment(
user.id,
null,
projectEnvironment.slug
);
return expect(promise).to.be.rejectedWith(
'A project slug is required for removing a project environment from a user'
);
});
});
context('when the project environment slug is not provided', function() {
it('throws an error', function() {
const project = fixture.build('contxtProject');
const user = fixture.build('contxtUser');
const users = new Users(baseSdk, baseRequest, expectedTenantBaseUrl);
const promise = users.removeProjectEnvironment(
user.id,
project.slug,
null
);
const promise = users.removeProjectEnvironment(user.id, null);

@@ -1462,0 +1403,0 @@ return expect(promise).to.be.rejectedWith(

esm/coordinator/roles.js.map

Sorry, the diff of this file is not supported yet

esm/coordinator/users.js.map

Sorry, the diff of this file is not supported yet

lib/coordinator/roles.js.map

Sorry, the diff of this file is not supported yet

lib/coordinator/users.js.map

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc