/api/user/organizations/invitations (GET)
Account information like email addresses is generated with faker-js it is not real user information.
await global.api.user.organizations.Invitations.get(req)Returns array
[
{
"invitationid": "invt_b7d24a5bacf1b3bc",
"organizationid": "orgn_d1132fa7afc26432",
"accountid": "acct_8bd5cb325333088e",
"object": "invitation",
"appid": "tests_1656039707",
"secretCode": "secret225",
"multi": true,
"acceptedAt": null,
"terminatedAt": null,
"createdAt": "2022-06-24T03:01:47.451Z",
"updatedAt": "2022-06-24T03:01:47.451Z"
},
{
"invitationid": "invt_71eaa0b5a5b1be8f",
"organizationid": "orgn_d1132fa7afc26432",
"accountid": "acct_8bd5cb325333088e",
"object": "invitation",
"appid": "tests_1656039707",
"secretCode": "secret224",
"multi": true,
"acceptedAt": null,
"terminatedAt": null,
"createdAt": "2022-06-24T03:01:47.443Z",
"updatedAt": "2022-06-24T03:01:47.443Z"
},
{
"invitationid": "invt_49f6659ffd0f5744",
"organizationid": "orgn_d1132fa7afc26432",
"accountid": "acct_8bd5cb325333088e",
"object": "invitation",
"appid": "tests_1656039707",
"secretCode": "secret223",
"multi": true,
"acceptedAt": null,
"terminatedAt": null,
"createdAt": "2022-06-24T03:01:47.434Z",
"updatedAt": "2022-06-24T03:01:47.434Z"
}
]
Receives
API routes may receive parameters from the URL and POST supporting simple and multipart:
Field | Value | Required | Type |
---|---|---|---|
all | boolean | optional | URL |
limit | integer | optional | URL |
offset | integer | optional | URL |
organizationid | string | optional | URL |
Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
Exception | Circumstances |
---|---|
invalid-account | ineligible accessing account |
invalid-accountid | missing querystring accountid |
invalid querystring accountid |
NodeJS source (view on github)
const organizations = require('../../../../../index.js')
module.exports = {
get: async (req) => {
if (!req.query || !req.query.accountid) {
throw new Error('invalid-accountid')
}
const account = await global.api.user.Account.get(req)
if (!account) {
throw new Error('invalid-account')
}
const where = {
appid: req.appid || global.appid
}
if (req.query.organizationid) {
const organization = await global.api.user.organizations.Organization.get(req)
if (!organization) {
throw new Error('invalid-organizationid')
}
if (organization.ownerid !== req.account.accountid) {
throw new Error('invalid-account')
}
where.organizationid = req.query.organizationid
} else {
where.accountid = req.query.accountid
}
let invitationids
if (req.query.all) {
invitationids = await organizations.Storage.Invitation.findAll({
where,
attributes: ['invitationid'],
order: [
['createdAt', 'DESC']
]
})
} else {
const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
invitationids = await organizations.Storage.Invitation.findAll({
where,
attributes: ['invitationid'],
offset,
limit,
order: [
['createdAt', 'DESC']
]
})
}
if (!invitationids || !invitationids.length) {
return null
}
const items = []
for (const invitationInfo of invitationids) {
req.query.invitationid = invitationInfo.dataValues.invitationid
const invitation = await global.api.user.organizations.Invitation.get(req)
items.push(invitation)
}
return items
}
}
Test source (view on github)
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const DashboardTestHelper = require('@layeredapps/dashboard/test-helper.js')
describe('/api/user/organizations/invitations', function () {
const cachedResponses = {}
const cachedInvitations = []
const organizationInvitations = []
before(async () => {
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
const user = await TestHelper.createUser()
global.userProfileFields = ['display-email', 'display-name']
await TestHelper.createProfile(user, {
'display-name': user.profile.fullName,
'display-email': user.profile.contactEmail
})
for (let i = 0, len = global.pageSize + 2; i < len; i++) {
await TestHelper.createOrganization(user, {
email: user.profile.displayEmail,
name: 'My organization',
profileid: user.profile.profileid,
pin: `12345${i}`
})
await TestHelper.createInvitation(user)
cachedInvitations.unshift(user.invitation.invitationid)
}
await TestHelper.createOrganization(user, {
email: user.profile.displayEmail,
name: 'My organization',
profileid: user.profile.profileid,
pin: '9976'
})
for (let i = 0, len = 3; i < len; i++) {
await TestHelper.createInvitation(user)
organizationInvitations.unshift(user.invitation.invitationid)
cachedInvitations.unshift(user.invitation.invitationid)
}
const req1 = TestHelper.createRequest(`/api/user/organizations/invitations?accountid=${user.account.accountid}&offset=1`)
req1.account = user.account
req1.session = user.session
cachedResponses.offset = await req1.get()
const req2 = TestHelper.createRequest(`/api/user/organizations/invitations?accountid=${user.account.accountid}&limit=1`)
req2.account = user.account
req2.session = user.session
cachedResponses.limit = await req2.get()
const req3 = TestHelper.createRequest(`/api/user/organizations/invitations?accountid=${user.account.accountid}&all=true`)
req3.account = user.account
req3.session = user.session
cachedResponses.all = await req3.get()
const req4 = TestHelper.createRequest(`/api/user/organizations/invitations?accountid=${user.account.accountid}&organizationid=${user.organization.organizationid}&all=true`)
req4.account = user.account
req4.session = user.session
cachedResponses.organizationid = await req4.get()
const req5 = TestHelper.createRequest(`/api/user/organizations/invitations?accountid=${user.account.accountid}`)
req5.account = user.account
req5.session = user.session
req5.filename = __filename
req5.saveResponse = true
cachedResponses.returns = await req5.get()
global.pageSize = 3
cachedResponses.pageSize = await req5.get()
})
describe('exceptions', () => {
describe('invalid-accountid', () => {
it('missing querystring accountid', async () => {
const owner = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/organizations/invitations')
req.account = owner.account
req.session = owner.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-accountid')
})
it('invalid querystring accountid', async () => {
const owner = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/organizations/invitations?accountid=invalid')
req.account = owner.account
req.session = owner.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-accountid')
})
})
describe('invalid-account', () => {
it('ineligible accessing account', async () => {
const owner = await TestHelper.createUser()
const user = await TestHelper.createUser()
global.userProfileFields = ['display-name', 'display-email']
await TestHelper.createProfile(owner, {
'display-name': owner.profile.fullName,
'display-email': owner.profile.contactEmail
})
await TestHelper.createProfile(user, {
'display-name': user.profile.fullName,
'display-email': user.profile.contactEmail
})
await TestHelper.createOrganization(owner, {
email: owner.profile.displayEmail,
name: 'My organization',
profileid: owner.profile.profileid,
pin: '12345'
})
await TestHelper.createInvitation(owner)
await TestHelper.createInvitation(owner)
await TestHelper.acceptInvitation(user, owner)
const req = TestHelper.createRequest(`/api/user/organizations/invitations?accountid=${owner.account.accountid}`)
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-account')
})
})
})
describe('receives', () => {
it('optional querystring offset (integer)', async () => {
const offset = 1
const invitationsNow = cachedResponses.offset
for (let i = 0, len = global.pageSize; i < len; i++) {
assert.strictEqual(invitationsNow[i].invitationid, cachedInvitations[offset + i])
}
})
it('optional querystring limit (integer)', async () => {
const limit = 1
const invitationsNow = cachedResponses.limit
assert.strictEqual(invitationsNow.length, limit)
})
it('optional querystring all (boolean)', async () => {
const invitationsNow = cachedResponses.all
assert.strictEqual(invitationsNow.length, cachedInvitations.length)
})
it('optional querystring organizationid (string)', async () => {
const invitationsNow = cachedResponses.organizationid
assert.strictEqual(invitationsNow.length, organizationInvitations.length)
})
})
describe('returns', () => {
it('array', async () => {
const invitationsNow = cachedResponses.returns
assert.strictEqual(invitationsNow.length, global.pageSize)
})
})
describe('configuration', () => {
it('environment PAGE_SIZE', async () => {
global.pageSize = 3
const invitationsNow = cachedResponses.pageSize
assert.strictEqual(invitationsNow.length, global.pageSize)
})
})
})