Application settings transferred form a server

UB application name

The base of all urls of your requests. Will be prepended to all urls while call UB.xhr

Additional headers what will be added to each XHR request

Domain information. Initialized after promise, returned by function getDomainInfo is resolved

Calc HMAC_SHA256 from key and string

var shaAsSting = UB.connection.HMAC_SHA256('secretKey', 'something').toString()

Last successful login name. Filled AFTER first 401 response

The preferred (used in previous user session if any or a default for application) locale

Set it to true for memorize all requests to recordedXHRs array (for debug only!)

UB Server URL with protocol and host

Calc SHA256 from string

var shaAsSting = UB.connection.SHA256('something').toString()

WebSocket ubNotifier protocol instance

Promise of running UBQL command with addNew method (asynchronously).

Response "data" is an array of default values for row.

Two difference from UBConnection.query:

• ubRequest.method set to 'addnew'
• requests is always buffered in the 20ms period into one ubql call
• Date & 'DateTime' entity attributes are converted from ISO8601 text representation to javaScript Date object

  
      $App.connection.addNew({entity: 'uba_user', fieldList: ['*']}).then(UB.logDebug)
// [{"entity":"uba_user","fieldList":["ID","isPending"],"method":"addnew",
//   "resultData":{"fields":["ID","isPending"],"rowCount": 1, "data":[[332462711046145,0]]}
// }]
  

Promise of running UBQL command with addNew method (asynchronously).

Result is Object with default values for row.

  
      $App.connection.addNewAsObject({"entity":"uba_user"}).then(UB.logDebug)
 // result is {ID: 332462709833729, isPending: false}
  

The starter method for all authorized requests to UB server. Return authorization promise resolved to UBSession. In case unauthorized:

• call requestAuthParams method passed to UBConnection constructor to retrieve user credentials
• call UBConnection#doAuth method

Used inside UBConnection#xhr, therefore developer rarely call it directly

Return:

Resolved to {UBSession} if auth success or rejected to {errMsg: string, errCode: number, errDetails: string} if fail

Clear all local cache (indexedDB session & permanent and UBConnection.cachedSessionEntityRequested)

Calculate cache key for request. This key is used to store data inside UBCache

Refresh all cache occurrence for root depending on cacheType:

• if Session - clear indexedDB for this root.
• if SessionEntity - remove entry in UBConnection#cachedSessionEntityRequested
• else - do nothing

Remove all cache occurrence for root depending on cacheType:

• clear indexedDB for this root.
• remove entry in UBConnection#cachedSessionEntityRequested

Convert raw server response data to javaScript data according to attribute types. Called by UBConnection#select Currently only Data/DateTime & boolean conversion done If resultLock present - resultLock.lockTime also converted

  
      // convert all string representation of date/dateTime to Date object, integer representation of bool to Boolean
return me.query({entity: 'my_entity', method: 'select'}, true)
  .then(me.convertResponseDataToJsTypes.bind(me))
  

Promise of running UBQL command with delete method (asynchronously). Difference from UBConnection.query:

• ubRequest.method set to 'delete' by default
• if necessary it will clear cache

  
      $App.connection.doDelete({
   entity: 'uba_user', fieldList: ['ID','name'], execParams: {ID: 1, name:'newName'}
 }).then(UB.logDebug)
  

Call a LocalDataStore#doFilterAndSort - see a parameters there

Emit ${entityCode}:changed event. In case entity has a unity mixin - emit also for unityEntity

The same as UB.get but with authorization

Return:

Future object

  
      // call entity method using rest syntax
const certResp = await UB.connection.get('/rest/uba_usercertificate/getCertificate?ID=334607980199937')
const certBin = certResp.data
  

Retrieve application information. Usually this is first method developer must call after create connection

Return:

Promise resolved to result of getAppInfo method

Retrieve content of document type attribute field from server. Usage samples:

Return:

Resolved to document content (either ArrayBuffer in case options.resultIsBinary===true or text/json)

  
      //Retrieve content of document as string using GET
 $App.connection.getDocument({
     entity:'ubm_form',
     attribute: 'formDef',
     ID: 100000232003
  }).then(function(result){console.log(typeof result)}); // string

 //The same, but using POST for bypass cache
 $App.connection.getDocument({
     entity:'ubm_form',
     attribute: 'formDef',
     ID: 100000232003
  }, {
     bypassCache: true
  }).then(function(result){console.log(typeof result)}); // string

 //Retrieve content of document as ArrayBuffer and bypass cache
 $App.connection.getDocument({
     entity:'ubm_form',
     attribute: 'formDef',
     ID: 100000232003
  }, {
     bypassCache: true, resultIsBinary: true
  }).then(function(result){
     console.log('Result is', typeof result, 'of length' , result.byteLength, 'bytes'); //output: Result is ArrayBuffer of length 2741 bytes
     let uiArr = new Uint8Array(result) // view into ArrayButter as on the array of byte
     console.log('First byte of result is ', uiArr[0])
  })
  

Get a http link to the "Document" attribute content which is valid for the duration of the user session.

This link can be used, for example, in HTML tag and so on.

Used in $App.downloadDocument method to download a BLOB content and in FileRenderer Vue component to display a BLOB content in browser.

Return:

Document URL (valid for the duration of the user session)

  
      //Retrieve content of document as string using GET
 const docURL = await UB.connection.getDocumentURL({
     entity:'ubm_form',
     attribute: 'formDef',
     ID: 100000232003,
     revision: 22,
  })
  // result is alike "/getDocument?entity=ubm_form&attribute=formDef&ID=100000232003&revision=22&session_signature=cbe83ece60126ee4a20d40c2"
  

Retrieve domain information from server. Promise resolve instance of UBDomain

Return preferred uData (stored in localStorage for specified user). Preferred uData passed as prefUData URL param during /auth handshake and can be used in server-side Session.on('login') handler

Promise of running UnityBase UBQL command with insert method (asynchronously). Difference from UBConnection.query:

• ubRequest.method set to 'insert'
• Date & 'DateTime' entity attributes are converted from ISO8601 text representation to javaScript Date object
• if necessary it will clear cache

  
      $App.connection.insert({
   entity: 'uba_user', fieldList: ['ID','name'], execParams: {ID: 1, name:'newName'}
 }).then(UB.logDebug);
  

Promise of running UnityBase UBQL command with insert method (asynchronously).

In case fieldList is passed - result will contains new values for attributes specified in fieldList as Object, otherwise - null

  
      $App.connection.insertAsObject({
  entity:"uba_user",
  fieldList:['ID', 'name', 'mi_modifyDate'],
  execParams: {name: 'insertedName'}
}).then(UB.logDebug)
  // {ID: 332462911062017, mi_modifyDate: Tue Apr 23 2019 17:04:30 GMT+0300 (Eastern European Summer Time), name: "insertedname"}
  

Is user currently logged in. There is no guaranty what session actually exist in server

Log out user from server

Inject encryption implementation and return a promise to object what implements a UbPkiInterface

The same as UB.post but with authorization

Return:

Future object

Promise of running UBQL command(s) (asynchronously). The difference from UBConnection.post is:

• ability to buffer request: can merge several query in the 20ms period into one ubql call

For well known UnityBase methods use aliases (addNew, select, insert, update, doDelete)

  
      //this two execution is passed to single ubql server execution
$App.connection.query({entity: 'uba_user', method: 'select', fieldList: ['*']}, true).then(UB.logDebug);
$App.connection.query({entity: 'ubm_navshortcut', method: 'select', fieldList: ['*']}, true).then(UB.logDebug);

//but this request is passed in separate ubql (because allowBuffer false in first request
$App.connection.query({entity: 'uba_user', method: 'select', fieldList: ['*']}).then(UB.logDebug);
$App.connection.query({entity: 'ubm_desktop', method: 'select', fieldList: ['*']}, true).then(UB.logDebug);
  

Promise of running UBQL command(s) (asynchronously).

Result is array of objects or null.

The difference from UBConnection.post is:

• ability to buffer request: can merge several query in the 20ms period into one ubql call

For well known UnityBase methods use aliases (addNew, select, insert, update, doDelete)

  
      //this two execution is passed to single ubql server execution
$App.connection.queryAsObject({entity: 'uba_user', method: 'select', fieldList: ['*']}, true).then(UB.logDebug);
$App.connection.queryAsObject({entity: 'ubm_navshortcut', method: 'select', fieldList: ['*']}, true).then(UB.logDebug);

//but this request is passed in separate ubql (because allowBuffer false in first request
$App.connection.queryAsObject({entity: 'uba_user', method: 'select', fieldList: ['*']}).then(UB.logDebug);
$App.connection.queryAsObject({entity: 'ubm_desktop', method: 'select', fieldList: ['*']}, true).then(UB.logDebug);
  

Create a new instance of repository

Group several ubRequest into one server request (executed in singe transaction on server side)

 $App.connection.runTrans([
      { entity: 'my_entity', method: 'update', ID: 1, execParams: {code: 'newCode'} },
      { entity: 'my_entity', method: 'update', ID: 2, execParams: {code: 'newCodeforElementWithID=2'} },
  ]).then(UB.logDebug);

Return:

Resolved to response.data

Group several ubRequest into one server request (executed in singe transaction on server side)

Each response will be returned in the same array position as corresponding request.

In case response contains resultData property of type {data: fields: } it will be converted to array-of-object dataStore format

In case method is insert or update array is replaced by first element. Example below use one entity, but real app can use any combination of entities and methods

  
      $App.connection.runTransAsObject([
  {entity: "tst_aclrls", method: 'insert', fieldList: ['ID', 'caption'], execParams: {caption: 'inserted1'}},
  {entity: "tst_aclrls", method: 'insert', opaqueParam: 'insertWoFieldList', execParams: {caption: 'inserted2'}},
  {entity: "tst_aclrls", method: 'update', fieldList: ['ID', 'caption'], execParams: {ID: 332463213805569, caption: 'updated1'}},
  {entity: "tst_aclrls", method: 'delete', execParams: {ID: 332463213805572}}]
).then(UB.logDebug)
// result is:
 [{
   "entity": "tst_aclrls","method": "insert","fieldList": ["ID","caption"],"execParams": {"caption": "inserted1","ID": 332463256010753},
   "resultData": {"ID": 332463256010753,"caption": "inserted1"}
 }, {
   "entity": "tst_aclrls","method": "insert","opaqueParam": "insertWoFieldList","execParams": {"caption": "inserted2","ID": 332463256010756},"fieldList": []
 }, {
   "entity": "tst_aclrls","method": "update","fieldList": ["ID","caption"],"execParams": {"ID": 332463213805569,"caption": "updated1"},
   "resultData": {"ID": 332463213805569,"caption": "updated1"}
 }, {
   "entity": "tst_aclrls","method": "delete","execParams": {"ID": 332463213805572},
   "ID": 332463213805572
 }]
  

Promise of running UBQL (asynchronously). Two difference from UBConnection.query:

• ubRequest.method by default set to 'select'
• requests is always buffered in the 20ms period into one ubql call
• Date & 'DateTime' entity attributes are converted from ISO8601 text representation to javaScript Date object
• if request entity is cached - cache used

  
      //retrieve users
 $App.connection.select({entity: 'uba_user', fieldList: ['*']}).then(UB.logDebug);

 //retrieve users and desktops and then both done - do something
 Promise.all($App.connection.select({entity: 'uba_user', fieldList: ['ID', 'name']})
   $App.connection.select({entity: 'ubm_desktop', fieldList: ['ID', 'code']})
 ).then(UB.logDebug);
  

Return server-side error message by error number

Saves a file content to the TEMP store of the specified entity attribute of Document type.

Should be called before insert of update. Result of this function is what shall be assigned to the attribute value during insert/update operation.

Return:

Promise resolved blob store metadata

Sets currently logged-in user preferred uData (stored in localStorage for specified user). Preferred uData passed as prefUData URL param during /auth handshake and can be used in server-side Session.on('login') handler

Allow to override a connection onRequest2fa function passed as config to UBConnection instance

Allow to override a connection requestAuthParams function passed as config to UBConnection instance

Sets UI tag for connection.

This tag will be added to a ubql HTTP request as uitag=${uiTag} and can be used to track from which part of UI request is generated

Recommended naming convention for tags are:

• nsc-${shortcutCode} for something executed from navshortcut
• frm-${formCode} for forms
• afm-${entity} for auto-forms
• rpt-${reportCode} for reports

Switch current session. Use only on server side

Promise of running UBQL command with update method (asynchronously). Difference from UBConnection.query:

• ubRequest.method set to 'update'
• Date & 'DateTime' entity attributes are converted from ISO8601 text representation to javaScript Date object
• if necessary it will clear cache

In case fieldList is passed - result will contains updated values for attributes specified in fieldList in Array representation

  
      $App.connection.update({
   entity: 'uba_user',
   fieldList: ['ID','name', 'mi_modifyDate'],
   execParams: {ID: 332462122205200, name:'test', mi_modifyDate:"2019-04-23T13:00:00Z"}
 }).then(UB.logDebug);
 // [{"entity":"uba_user","fieldList":["ID","name","mi_modifyDate"],
 //   "execParams":{"ID":332462122205200,"name":"test","mi_modifyDate":"2019-04-23T13:03:51Z","mi_modifyUser":10},
 //   "method":"update",
 //   "resultData":{"fields":["ID","name","mi_modifyDate"],"rowCount": 1,
 //               "data":[[332462122205200,"test","2019-04-23T13:03:51Z"]]}
 // }]
  

Promise of running UBQL command with update method (asynchronously).

In case fieldList is passed - result will contain updated values for attributes specified in fieldList as Object;

If fieldList is not passed or empty - return null

  
      $App.connection.updateAsObject({
  entity: 'uba_user',
  fieldList: ['ID','name','mi_modifyDate', 'isPending'],
  execParams: {ID: 33246, name:'newName', mi_modifyDate:"2019-04-23T13:00:00Z"}
}).then(UB.logDebug);
// {"ID": 332462122205200, "name": newName", "mi_modifyDate": new Date("2019-04-23T13:03:51Z"), isPending: false}
  

Is auth schema for logged-in user allows password changing (currently - only UB and CERT* with requireUserName)

Return custom data for logged-in user, or {lang: 'en', login: 'anonymous'} in case not logged in

If key is provided - return only key part of user data. For a list of possible keys see Session.uData in server side documentation

  
      $App.connection.userData('lang');
// or the same but dedicated alias
$App.connection.userLang()
  

Return current user language or 'en' in case not logged in

Return current user logon name or 'anonymous' in case not logged in

Shortcut method to perform authorized/encrypted request to application we connected. Will:

• add Authorization header for non-anonymous sessions
• add UBConnection#baseURL to config.url
• call UB.xhr
• in case server return 401 clear current authorization, call UBConnection#authorize and repeat the request

By default, xhr retrieve data in JSON format, but for ubql endpoint can accept Content-Type header and serialize DataStore in one of:

• text/xml; charset=UTF-8
• application/vnd.oasis.opendocument.spreadsheet
• text/csv; charset=UTF-8
• text/html; charset=UTF-8

  
      // get response as CSV and save it to file
 const { data } = await UB.connection.xhr({
   method: 'POST',
   url: 'ubql',
   data: [UB.Repository.attrs('*').ubql()],
   responseType: 'blob',
   headers: { 'Content-Type': 'text/csv; charset=UTF-8' }
 })
 window.saveAs(data, `${fileName}.csv`)
  

Fired for UBConnection instance in case of bad authorization

Fired for UBConnection instance after success authorization

Fired for UBConnection instance in case authentication type CERT and simpleCertAuth is true just after private key is loaded and certificate is parsed but before auth handshake starts.

Here you can extract username from certificate. By default, it is EDPOU or DRFO or email.

Fires after successful response for update/insert/delete for entity received

  
      UB.connection.on('uba_user:changed', function ({entity, method, resultData}) {
  console.log(`Someone call ${method} User with ID ${resultData.ID}`
})
  

Fires just after form is refreshed using processing.refresh()

  
      // @param {THTTPRequest} req
UB.connection.on('uba_user:refresh', function (data) {
  console.log(`Someone call refresh for User with ID ${data.ID}`
})
  

Fired for UBConnection instance in case user password is expired. The only valid endpoint after this is changePassword

Accept 1 arg `(connection: UBConnection)