Used to create an instance of the OneBlinkAppsError class.
The message associated with the error
@@ -18,17 +18,17 @@Whether the attempted action required login
The title of the error
-The http status code associated with the error
-Whether the application state is offline
-The original error that was thrown
-Whether the attempted action required access
-Whether the attempted action required login
-The title of the error
Optional override for formatting stack traces
diff --git a/docs/classes/paymentService.westpacQuickStream.default.html b/docs/classes/paymentService.westpacQuickStream.default.html index 9cdb7549..f3a8eecd 100644 --- a/docs/classes/paymentService.westpacQuickStream.default.html +++ b/docs/classes/paymentService.westpacQuickStream.default.html @@ -1 +1 @@ -Captures an exception event and sends it to Sentry.
An exception-like object.
@@ -12,4 +12,4 @@String key of tag
Value of tag
-Helper functions for handling approvals
import { approvalsService } from '@oneblink/apps'
As an administrator, close a submission that has been approved.
await approvalsService.closeFormApprovalFlowInstance({
formApprovalFlowInstanceId: 1,
notificationEmailAddress: ['email@example.com'],
notes: 'Great work!!!',
internalNotes: 'It was not really that great...',
cannedResponseKey: 'my_canned_response_key',
})
Create an additional note for a form submission approval.
const formSubmissionApprovalId = 'd96ff812-f263-4a66-868d-e259a1fe4157'
const newFormSubmissionApprovalNote = {
note: 'this is my note',
}
const createdFormSubmissionApprovalNote =
await approvalsService.createApprovalAdditionalNote({
formSubmissionApprovalId,
newFormSubmissionApprovalNote,
})
Delete an additional note for a form submission approval.
const formSubmissionApprovalId = 'd96ff812-f263-4a66-868d-e259a1fe4157'
const formSubmissionApprovalNoteId = '1e84dee3-0dc0-4abe-b2cf-d15d62fd9d0b',
const updatedFormSubmissionApprovalNote =
await approvalsService.deleteApprovalAdditionalNote({
formSubmissionApprovalId,
formSubmissionApprovalNoteId,
})
Get an array containing usernames that have updated approvals in the within
the formsAppId associated with the passed formsAppId. Must be an Approvals
Administrator.
const formsAppId = 1
const { usernames } =
await approvalsService.getFormApprovalUsernames(formsAppId)
Get an Object containing approvals for the app regardless of approval groups and meta for paging. Must be an Approvals Administrator.
const formsAppId = 1
const limit = 50
const offset = 0
const { approvals, meta } =
await approvalsService.getFormSubmissionAdministrationApprovals({
formAppId,
limit,
offset,
})
Get a single FormSubmissionApproval belonging to the given id.
const formSubmissionApprovalId = 'd27966cc-128d-48a2-b681-6ad52012e113'
const {
formSubmissionApproval,
formApprovalFlowInstance,
formSubmissionMeta,
form,
history,
} = await approvalsService.getFormSubmissionApproval(
formSubmissionApprovalId,
)
Get an Object containing FormSubmissionApprovals assigned to the current user and the Form definitions in those approvals.
const formsAppId = 1
const {
formSubmissionApprovals,
formApprovalFlowInstances,
forms,
formSubmissionMeta,
} = await approvalsService.getFormSubmissionApprovals(formAppId)
As an administrator, reopen a submission that has been approved or denied.
await approvalsService.reopenFormApprovalFlowInstance({
formApprovalFlowInstanceId: 1,
notificationEmailAddress: 'email@example.com',
notes: 'Great work!!!',
internalNotes: 'It was not really that great...',
cannedResponseKey: 'my_canned_response_key',
})
Update an additional note for a form submission approval.
const formSubmissionApprovalId = 'd96ff812-f263-4a66-868d-e259a1fe4157'
const formSubmissionApprovalNote = {
id: '1e84dee3-0dc0-4abe-b2cf-d15d62fd9d0b',
note: 'this is my note',
createdAt: '2022-06-24T03:16:34.696Z',
createdBy: {
username: 'user@domain.com',
},
updatedAt: '2022-06-24T03:16:34.696Z',
lastUpdatedBy: {
username: 'user@domain.com',
},
}
const updatedFormSubmissionApprovalNote =
await approvalsService.updateApprovalAdditionalNote({
formSubmissionApprovalId,
formSubmissionApprovalNote,
})
Update a single FormSubmissionApproval assigned to the current user.
Helper functions for attachment handling
import { attachmentsService } from '@oneblink/apps'
The form element name for accessing its submission data
-The submission data model to be submitted
-Upload a submission attachment. Attachment can be passed as a Blob,
Uint8Array or string (base64). Will return data required form accessing
the attachment.
import { authService } from '@oneblink/apps'
Allow the currently logged in user to change their password by passing their existing password and a new password.
const currentPassword = 'P@$5w0rd'
const newPassword = 'P@$5w0rD'
await authService.changePassword(currentPassword, newPassword)
Check if MFA is enabled for this current user.
const isMfaEnabled = await authService.checkIsMfaEnabled()
if (isMfaEnabled) {
// Allow disabling MFA
} else {
// Allow enabling MFA
}
Disable MFA for the current user.
await authService.disableMfa()
Allow a user to start the forgot password process. The user will be emailed a temporary code that must be passed with a new password to the function returned.
@@ -46,7 +46,7 @@Used to give the resulting email sent to the user associated forms app branding and sending address
-Get the current user's App User details for a OneBlink Forms App. Returns
undefined if the current user is not logged in.
const formsAppId = 1
const formsAppUserDetails =
await authService.getCurrentFormsAppUser(formsAppId)
if (!formsAppUserDetails) {
// handle unauthorised user
}
Can be used to extract the keyId from the Forms Key token passed to
setFormsKeyToken(). Will be undefined if the token has not been set yet.
const keyId = authService.getFormsKeyId()
if (keyId) {
// Use keyId here...
}
Get the Id Token used to make requests to the OneBlink API. This will return
undefined if the current user is not logged in.
const idToken = await authService.getIdToken()
if (idToken) {
await fetch(url, {
headers: {
Authorization: `Bearer ${idToken}`,
},
})
} else {
// Handle user not being logged in
}
A friendly string that represents the current user. Uses first name, last
name, full name and username. This will return null the current user is not
logged in.
const name = authService.getUserFriendlyName()
if (name) {
// Display current user's name
}
Get current users profile based on there Id Token payload. This will return
null if the the current user is not logged in.
const profile = authService.getUserProfile()
if (profile) {
// Use profile here
}
Can be used to retrieve the userToken passed to setUserToken(). Will be
undefined if the token has not been set yet.
const userToken = authService.getUserToken()
if (userToken) {
// Use token here...
}
This function should be called when the user is redirected back to your app
after a login attempt. It will use the query string add the redirect URL to
create a session for the current user. It will return a URL as a string
@@ -112,7 +112,7 @@
try {
const continueTo = await authService.handleAuthentication()
// Redirect the user back to where they were before attempting to login
window.location.href = continueTo
} catch (error) {
// handle failed login attempts here.
}
Initialize the service with required configuration. This must be done before using before some of the function in this service.
authService.init({
oAuthClientId: 'YOUR_OAUTH_CLIENT_ID',
})
Determine if the current user is a OneBlink App User administrator for a
OneBlink Forms App. Returns false if the current user is not.
const formsAppId = 1
const isAdministrator = await authService.isAdministrator(formsAppId)
if (isAdministrator) {
// handle administator user
}
Determine if the current user is a OneBlink App User for a OneBlink Forms
App. Returns false if the current user is not logged in.
const formsAppId = 1
const isAuthorised = await authService.isAuthorised(formsAppId)
if (!isAuthorised) {
// handle unauthorised user
}
Check if the user is currently logged in
const isLoggedIn = authService.isLoggedIn()
// handle user being logged in or not
Redirect the user to the login screen. Passing an identityProvider is
optionally, it will allow users to skip the login page and be directed
straight to that providers login page
// OPtionally pass a
const identityProvider = 'Google'
await authService.loginHostedUI(identityProvider)
// User will be redirected to login page or promise will resolve
Create a session for a user by entering a username and password. If the user requires a password reset, the "resetPasswordCallback" property will be returned. This function should be called with the new password once entered @@ -174,7 +174,7 @@
async function handleLoginAttemptResponse({
resetPasswordCallback,
mfaCodeCallback,
}) {
// "resetPasswordCallback" will be undefined if a password reset was not required.
if (resetPasswordCallback) {
// Prompt the user to enter a new password
const newPassword = prompt(
'The password you entered was only temporary, and must be reset for security purposes. Please enter your new password below to continue.',
)
const resetPasswordResponse =
await resetPasswordCallback(newPassword)
return await handleLoginAttemptResponse(resetPasswordResponse)
}
// "mfaCodeCallback" will be undefined if MFA is not setup.
if (mfaCodeCallback) {
// Prompt the user to enter an MFA code
const code = prompt(
'Please enter a one-time code from your MFA app.',
)
const mfaCodeResponse = await mfaCodeCallback(code)
return await handleLoginAttemptResponse(mfaCodeResponse)
}
}
const username = 'user@email.io'
const password = 'P@$5w0rd'
const loginAttemptResponse = await authService.loginUsernamePassword(
username,
password,
)
await handleLoginAttemptResponse(loginAttemptResponse)
Log the current user out and remove an data stored locally by the user e.g. drafts.
await authService.logout()
Redirect the user to the logout screen to clear the users session on the
hosted login page. User will then be redirected to /logout. After being
redirected back to the application, the logout() function should be called
@@ -194,7 +194,7 @@
authService.logoutHostedUI()
Register a listener function that will be call when authentication tokens are updated or removed.
const listener = async () => {
// Check if the user is logged in still
const isLoggedIn = authService.isLoggedIn()
}
const deregister = await authService.registerAuthListener(listener)
// When no longer needed, remember to deregister the listener
deregister()
If the current user is not a Forms App User, this function will send a request on behalf of the current user to the OneBlink Forms App administrators to request access.
@@ -223,7 +223,7 @@const formsAppId = 1
await authService.requestAccess(formsAppId)
// Display a message to user indicating a request has been sent to the application administrators
Set the Forms Key token being used to make requests to the OneBlink API on behalf of the user.
authService.setFormsKeyToken('a valid json web token')
Set the User token being included in requests to the OneBlink API on behalf of the user.
authService.setUserToken('a value')
Setup MFA for the current user. The result will include a callback that should be called with the valid TOTP from an authenticator app.
const { secretCode, mfaCodeCallback } = await authService.setupMfa()
// Prompt the user to enter an MFA code
const code = prompt(
`Please enter a one-time code from your MFA app after creating a new entry with secret: ${secretCode}.`,
)
await mfaCodeCallback(code)
Allow a user to sign up to a forms app.
Helper functions for handling data while user is completing form.
import { autoSaveService } from '@oneblink/apps'
Delete all auto saved data.
await autoSaveService.deleteAllAutosaveData()
Delete saved data.
const formId = 1
const myKey = 'my-key'
await autoSaveService.deleteAutoSaveData(formId, myKey)
Get saved data.
const formId = 1
const myKey = 'my-key'
const prefillData = await autoSaveService.getAutoSaveData(formId, myKey)
if (prefillData) {
// Ask user if they would like to continue with this prefill data.
}
Get keys for autosave data.
const keys = await autoSaveService.getAutoSaveDataKeys()
if (keys.length) {
// Display keys to user
}
Create or update saved data.
Helper functions for handling drafts.
import { draftService } from '@oneblink/apps'
Remove a draft from the local store and sync with remote drafts.
const draftId = 'd3aeb944-d0b3-11ea-87d0-0242ac130003'
await draftService.deleteDraft(draftId)
Get a single Draft and the associated submission data.
const draftId = 'd3aeb944-d0b3-11ea-87d0-0242ac130003'
const { draft, draftData, lastElementUpdated } =
await draftService.getDraftAndData(draftId)
// use "draftData" to prefill a from
Get an array of Drafts for the currently logged in user.
const drafts = await draftService.getDrafts()
Register a listener function that will be passed an array of Drafts when a draft is added, updated or deleted.
const listener = async (drafts) => {
// use drafts here...
}
const deregister = await draftService.registerDraftsListener(listener)
// When no longer needed, remember to deregister the listener
deregister()
Force a sync of remote drafts with locally stored drafts. This function will
swallow all errors thrown unless true is passed for the throwError
property.
The id of the OneBlink Forms App to sync drafts with
true to throw errors while syncing
Create or update a Draft in the local store and sync it with remote drafts.
Will also handle cleaning up auto save data (if the autoSaveKey property is
passed).
Helper functions for form handling
import { formService } from '@oneblink/apps'
ISO datetime string
ISO datetime string
HEX colour
-The HCMS Content Type's items
Represents the total number of items based on the search. Can be used to achieve paging or infinite scrolling to load more.
-Delete CivicPlus HCMS content item.
Allows request to be aborted
@@ -27,9 +27,9 @@The identifier for the Form to determine the HCMS Content Type.
The identifier for the Forms App to determine the HCMS Content Type.
-Change the status of a CivicPlus HCMS content item to draft.
-Get the details for a single API.NSW Liquor licence based on the licenceID.
const formId = 1
const licenceId = '1-RL22KV'
const result = await formService.getAPINSWLiquorLicence(
formId,
licenceId,
)
Get BSB record based on a BSB number codes from Civica name register
const formId = 1
const bsb = '123-321'
const results = await formService.getBSBRecord(formId, bsb)
Get titles codes from Civica name register
const formId = 1
const results = await formService.getCivicaTitleCodes(formId)
Get a OneBlink Form by id or slug.
const form = await formService.getForm({
formId: 1,
formAppId: 1, // `formsAppId` is optional
formSlug: undefined,
})
// OR
const form = await formService.getForm({
formId: undefined,
formAppId: 1,
formSlug: 'audit',
})
Get a OneBlink Form Element Lookup.
const organisationId = '1234567890ABCDEFG'
const formsAppEnvironmentId = 1
const formElementLookupId = 1
const formElementLookup = await formService.getFormElementLookupById(
organisationId,
formsAppEnvironmentId,
formElementLookupId,
)
if (formElementLookup) {
// Use lookup
}
Get an array of OneBlink Form Element Lookups.
const organisationId = '1234567890ABCDEFG'
const formsAppEnvironmentId = 1
const formElementLookups = await formService.getFormElementLookups(
organisationId,
formsAppEnvironmentId,
)
Get the options for an options set.
The form element options set to generate options @@ -87,7 +87,7 @@
A signal to abort any asynchronous processing
A result object containing potential options or a predictable error
-Get a list of options sets for an organisation.
The identifier for the organisation to fetch options @@ -95,7 +95,7 @@
A signal to abort any asynchronous processing
An array of options sets
-Get an array of OneBlink Forms.
const formsAppId = 1
const forms = await formService.getForms(formAppId)
Get the Freshdesk Fields associated with a form
The identifier for the form to fetch freshdesk fields for
A signal to abort any asynchronous processing
An array of Freshdesk Fields
-Get the details for a single geoscape address based on the Id of a geoscape address resource.
const formId = 1
const addressId = 'ABC123'
const result = await formService.getGeoscapeAddress(formId, addressId)
Get a geoscape address from a latitude and longitude
const lat = 41.9475427
const lng = -87.6562292
const formId = 1
const result = await formService.getGeoscapeReverseGeocoding({
lat,
lng,
formId,
})
Get the details for a single Point address based on the Id of a Point address resource.
const formId = 1
const addressId = 'ABC123'
const result = await formService.getPointAddress(formId, addressId)
Load the options for Form Elements that are using a OneBlink List. Useful to cache all the dynamic options when first opening an application.
-The form definition the form element is in. Used to generate conditional logic for the
The form element to have options appended to
A new form element. The element passed in is not mutated.
-Parse Freshdesk Field options associated with a form element as form element options.
The element to array of Freshdesk Fields
An object containing valid options or a predictable error
-Change the status of a CivicPlus HCMS content item to published.
-Search for API.NSW Liquor licences based on a partial text search.
const result = await formService.searchAPINSWLiquorLicences({
formId: 1,
search: 'SMITH',
})
Search CivicPlus HCMS content items.
Optional OData filter definition.
@@ -183,7 +183,7 @@The identifier for the Form to determine the HCMS Content Type.
The identifier for the Forms App to determine the HCMS Content Type.
-Search for street names in Civica
const formId = 1
const queryParams = {
search: '1 Station ',
top: 10,
}
const result = await formService.searchCivicaStreetNames(
formId,
queryParams,
)
Search for geoscape addresses based on a partial address.
const formId = 1
const result = await formService.searchGeoscapeAddresses(formId, {
query: '123 N',
maxNumberOfResults: 10
stateTerritory: 'NSW'
})
Search for Point addresses based on a partial address.
Helper functions for handling Form Store Records
import { formStoreService } from '@oneblink/apps'
Filter for a single property in a Form Store Record
-Filters available for filter Form Store Records
Filter results by the date/time they were submitted
@@ -20,14 +20,14 @@Filter results by the submissionId, must be a valid GUID
Filter results by the user that submitted
-Filters available for filter Form Store Records
Sort the results by multiple properties
Unwind repeatable set entries to denormalise data, this makes data cleaner for tabular data purposes
-Export Form Store Records as a CSV file. This function will download the file automatically.
An AbortSignal to abort the request
-Get the available form elements for a form to display form store records
An AbortSignal to abort the request
-Search for Form Store Records
Helper functions for forms apps
import { formsAppService } from '@oneblink/apps'
Get configuration for a OneBlink Forms App.
Helper functions for job handling
import { jobService } from '@oneblink/apps'
Helper to store Job prefill data locally if it is not currently in the local store. Pass in an array of Jobs.
const jobs = [...]
await jobService.ensurePrefillFormDataExists(jobs)
Get Jobs for the current user. Jobs that are in the pending queue will be
filtered out and Jobs with drafts will include the draft property.
Helper functions for handling all things locale.
import { localisationService } from '@oneblink/apps'
Format a number as a string represented as a currency e.g. $123.31
const amount = 123.321
const text = localisationService.formatCurrency(amount)
// Display text
Format a Date as a string that just contains the date portion e.g.
31/01/2020
const date = new Date()
const text = localisationService.formatDate(date)
// Display text
Format a Date as a string that just contains the date portion in a long
format e.g. Thursday, 2 January 2020
const date = new Date()
const text = localisationService.formatDateLong(date)
// Display text
Format a Date as a string that contains the date and time portions e.g.
31/01/2020 5:31 pm
const date = new Date()
const text = localisationService.formatDatetime(date)
// Display text
Format a Date as a string that contains the date and time portions in a
long format e.g. Thursday, 2 January 2020 5:31 pm
const date = new Date()
const text = localisationService.formatDatetime(date)
// Display text
Format a number as a string represented as a readable number e.g.
123,321.123
const amount = 1234.4321
const text = localisationService.formatCurrency(amount)
// Display text
Format a Date as a string that just contains the time portion e.g. 5:31
pm
const date = new Date()
const text = localisationService.formatTime(date)
// Display text
Generate a Date based a string while adding/subtracting a number of days.
Use this function to generate a date with the correct time if only the date
part is required to be formatted for display purposes. Also supports passing
@@ -79,7 +79,7 @@
const dateOnly = localisationService.generateDate({
value: '2023-05-04',
dateOnly: true,
daysOffset: undefined,
})
const date = localisationService.generateDate({
value: '2023-05-04T02:49:23.616Z',
dateOnly: false,
daysOffset: undefined,
})
const now = localisationService.generateDate({
value: 'NOW',
dateOnly: false,
daysOffset: undefined,
})
Get the locale (e.g. en-AU) for the current tenant.
const locale = localisationService.getLocale()
Replace the {ELEMENT:<elementName>} values in text while a form is being
filled out. The replacements are suppose to be user friendly and for display
purposes, e.g. dates should be displayed in the user's desired format and
timezone.
Replace the {ELEMENT:<elementName>} values in text after a successful form
submission as well as other replaceable parameters e.g. submissionId. The
replacements are suppose to be user friendly and for display purposes, e.g.
dates should be displayed in the user's desired format and timezone.
An error class that extends
-Error