@docbrasil/api-systemmanager 1.0.77 → 1.0.78

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/api/user/document.js +25 -25
  2. package/dist/bundle.cjs +25 -25
  3. package/dist/bundle.mjs +1 -1
  4. package/doc/api.md +5 -253
  5. package/package.json +1 -1
package/api/user/document.js CHANGED
@@ -140,7 +140,7 @@ class Documents {
140
140
  * @param {string} params.orgname Organization name
141
141
  * @param {string} params.areaId Doc area id (_id database)
142
142
  * @param {string} params.docId Document id (_id database)
143
- * @param {string} [params.documentDate=new\ Date()] Date of document
143
+ * @param {string} [params.documentDate=new Date()] Date of document
144
144
  * @param {string} params.document The path to the file. If S3, the key to S3, gotten after getting a signed URL
145
145
  * @param {string} params.filename File name
146
146
  * @param {string} params.type Mimetype of the document (image/png)
@@ -189,34 +189,34 @@ class Documents {
189
189
  const self = this;
190
190
 
191
191
  try {
192
- Joi.assert(params, Joi.object().required());
193
- Joi.assert(params.orgname, Joi.string().required());
194
- Joi.assert(params.areaId, Joi.string().required());
195
- Joi.assert(params.docId, Joi.string().required());
196
- Joi.assert(params.type, Joi.string().required());
197
- Joi.assert(params.name, Joi.string().required());
198
- Joi.assert(params.docTypeId, Joi.string().required());
199
- Joi.assert(params.bytes, Joi.number().required());
200
- Joi.assert(params.orgId, Joi.string().required());
201
- Joi.assert(session, Joi.string().required());
202
- Joi.assert(params.signedUrl, Joi.string().required());
192
+ Joi.assert(params, Joi.object().required().error(new Error('params is required')));
193
+ Joi.assert(params.orgname, Joi.string().required().error(new Error('orgname is required')));
194
+ Joi.assert(params.areaId, Joi.string().required().error(new Error('areaId is required')));
195
+ Joi.assert(params.docId, Joi.string().required().error(new Error('docId is required')));
196
+ Joi.assert(params.type, Joi.string().required().error(new Error('type is required')));
197
+ Joi.assert(params.name, Joi.string().required().error(new Error('name is required')));
198
+ Joi.assert(params.docTypeId, Joi.string().required().error(new Error('docTypeId is required')));
199
+ Joi.assert(params.bytes, Joi.number().required().error(new Error('bytes is required')));
200
+ Joi.assert(params.orgId, Joi.string().required().error(new Error('orgId is required')));
201
+ Joi.assert(session, Joi.string().required().error(new Error('session is required')));
202
+ Joi.assert(params.signedUrl, Joi.string().required().default('').error(new Error('signedUrl is required, even if an empty string')));
203
203
 
204
204
  // Get fields required, and set data default to create document
205
205
  const payloadToSend = self._formatDocument(params);
206
206
 
207
- Joi.assert(payloadToSend.documentDate, Joi.string().allow(''));
208
- Joi.assert(payloadToSend.content, Joi.string().allow(''));
209
- Joi.assert(payloadToSend.description, Joi.string().allow(''));
210
- Joi.assert(payloadToSend.category, Joi.string().allow(''));
211
- Joi.assert(payloadToSend.tags, Joi.array());
212
- Joi.assert(payloadToSend.hasPhisicalStorage, Joi.boolean());
213
- Joi.assert(payloadToSend.boxId, Joi.string().allow(''));
214
- Joi.assert(payloadToSend.storageStatus, Joi.string().allow(''));
215
- Joi.assert(payloadToSend.ocrDocumentBackend, Joi.boolean());
216
- Joi.assert(payloadToSend.docAreaPermission, Joi.object().allow({}));
217
- Joi.assert(payloadToSend.docTypeFieldsData, Joi.object().allow({}));
218
- Joi.assert(payloadToSend.urlType, Joi.string().allow(''));
219
- Joi.assert(payloadToSend.addType, Joi.string().allow(''));
207
+ Joi.assert(payloadToSend.documentDate, Joi.string().allow('').error(new Error('documentData is required after formatting payload')));
208
+ Joi.assert(payloadToSend.content, Joi.string().allow('').error(new Error('content is required after formatting payload')));
209
+ Joi.assert(payloadToSend.description, Joi.string().allow('').error(new Error('description is required after formatting payload')));
210
+ Joi.assert(payloadToSend.category, Joi.string().allow('').error(new Error('catetory is required after formatting payload')));
211
+ Joi.assert(payloadToSend.tags, Joi.array().error(new Error('tags is required after formatting payload')));
212
+ Joi.assert(payloadToSend.hasPhisicalStorage, Joi.boolean().error(new Error('hasPhisicalStorage is required after formatting payload')));
213
+ Joi.assert(payloadToSend.boxId, Joi.string().allow('').error(new Error('boxId is required after formatting payload')));
214
+ Joi.assert(payloadToSend.storageStatus, Joi.string().allow('').error(new Error('storageStatus is required after formatting payload')));
215
+ Joi.assert(payloadToSend.ocrDocumentBackend, Joi.boolean().error(new Error('ocrDocumentBackend is required after formatting payload')));
216
+ Joi.assert(payloadToSend.docAreaPermission, Joi.object().allow({}).error(new Error('docAreaPermission is required after formatting payload')));
217
+ Joi.assert(payloadToSend.docTypeFieldsData, Joi.object().allow({}).error(new Error('docTypeFieldsData is required after formatting payload')));
218
+ Joi.assert(payloadToSend.urlType, Joi.string().allow('').error(new Error('urlType is required after formatting payload')));
219
+ Joi.assert(payloadToSend.addType, Joi.string().allow('').error(new Error('addType is required after formatting payload')));
220
220
 
221
221
  const {areaId, orgId} = params;
222
222
  const apiCall = self._client
package/dist/bundle.cjs CHANGED
@@ -692,7 +692,7 @@ class Documents {
692
692
  * @param {string} params.orgname Organization name
693
693
  * @param {string} params.areaId Doc area id (_id database)
694
694
  * @param {string} params.docId Document id (_id database)
695
- * @param {string} [params.documentDate=new\ Date()] Date of document
695
+ * @param {string} [params.documentDate=new Date()] Date of document
696
696
  * @param {string} params.document The path to the file. If S3, the key to S3, gotten after getting a signed URL
697
697
  * @param {string} params.filename File name
698
698
  * @param {string} params.type Mimetype of the document (image/png)
@@ -741,34 +741,34 @@ class Documents {
741
741
  const self = this;
742
742
 
743
743
  try {
744
- Joi__default["default"].assert(params, Joi__default["default"].object().required());
745
- Joi__default["default"].assert(params.orgname, Joi__default["default"].string().required());
746
- Joi__default["default"].assert(params.areaId, Joi__default["default"].string().required());
747
- Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
748
- Joi__default["default"].assert(params.type, Joi__default["default"].string().required());
749
- Joi__default["default"].assert(params.name, Joi__default["default"].string().required());
750
- Joi__default["default"].assert(params.docTypeId, Joi__default["default"].string().required());
751
- Joi__default["default"].assert(params.bytes, Joi__default["default"].number().required());
752
- Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required());
753
- Joi__default["default"].assert(session, Joi__default["default"].string().required());
754
- Joi__default["default"].assert(params.signedUrl, Joi__default["default"].string().required());
744
+ Joi__default["default"].assert(params, Joi__default["default"].object().required().error(new Error('params is required')));
745
+ Joi__default["default"].assert(params.orgname, Joi__default["default"].string().required().error(new Error('orgname is required')));
746
+ Joi__default["default"].assert(params.areaId, Joi__default["default"].string().required().error(new Error('areaId is required')));
747
+ Joi__default["default"].assert(params.docId, Joi__default["default"].string().required().error(new Error('docId is required')));
748
+ Joi__default["default"].assert(params.type, Joi__default["default"].string().required().error(new Error('type is required')));
749
+ Joi__default["default"].assert(params.name, Joi__default["default"].string().required().error(new Error('name is required')));
750
+ Joi__default["default"].assert(params.docTypeId, Joi__default["default"].string().required().error(new Error('docTypeId is required')));
751
+ Joi__default["default"].assert(params.bytes, Joi__default["default"].number().required().error(new Error('bytes is required')));
752
+ Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required().error(new Error('orgId is required')));
753
+ Joi__default["default"].assert(session, Joi__default["default"].string().required().error(new Error('session is required')));
754
+ Joi__default["default"].assert(params.signedUrl, Joi__default["default"].string().required().default('').error(new Error('signedUrl is required, even if an empty string')));
755
755
 
756
756
  // Get fields required, and set data default to create document
757
757
  const payloadToSend = self._formatDocument(params);
758
758
 
759
- Joi__default["default"].assert(payloadToSend.documentDate, Joi__default["default"].string().allow(''));
760
- Joi__default["default"].assert(payloadToSend.content, Joi__default["default"].string().allow(''));
761
- Joi__default["default"].assert(payloadToSend.description, Joi__default["default"].string().allow(''));
762
- Joi__default["default"].assert(payloadToSend.category, Joi__default["default"].string().allow(''));
763
- Joi__default["default"].assert(payloadToSend.tags, Joi__default["default"].array());
764
- Joi__default["default"].assert(payloadToSend.hasPhisicalStorage, Joi__default["default"].boolean());
765
- Joi__default["default"].assert(payloadToSend.boxId, Joi__default["default"].string().allow(''));
766
- Joi__default["default"].assert(payloadToSend.storageStatus, Joi__default["default"].string().allow(''));
767
- Joi__default["default"].assert(payloadToSend.ocrDocumentBackend, Joi__default["default"].boolean());
768
- Joi__default["default"].assert(payloadToSend.docAreaPermission, Joi__default["default"].object().allow({}));
769
- Joi__default["default"].assert(payloadToSend.docTypeFieldsData, Joi__default["default"].object().allow({}));
770
- Joi__default["default"].assert(payloadToSend.urlType, Joi__default["default"].string().allow(''));
771
- Joi__default["default"].assert(payloadToSend.addType, Joi__default["default"].string().allow(''));
759
+ Joi__default["default"].assert(payloadToSend.documentDate, Joi__default["default"].string().allow('').error(new Error('documentData is required after formatting payload')));
760
+ Joi__default["default"].assert(payloadToSend.content, Joi__default["default"].string().allow('').error(new Error('content is required after formatting payload')));
761
+ Joi__default["default"].assert(payloadToSend.description, Joi__default["default"].string().allow('').error(new Error('description is required after formatting payload')));
762
+ Joi__default["default"].assert(payloadToSend.category, Joi__default["default"].string().allow('').error(new Error('catetory is required after formatting payload')));
763
+ Joi__default["default"].assert(payloadToSend.tags, Joi__default["default"].array().error(new Error('tags is required after formatting payload')));
764
+ Joi__default["default"].assert(payloadToSend.hasPhisicalStorage, Joi__default["default"].boolean().error(new Error('hasPhisicalStorage is required after formatting payload')));
765
+ Joi__default["default"].assert(payloadToSend.boxId, Joi__default["default"].string().allow('').error(new Error('boxId is required after formatting payload')));
766
+ Joi__default["default"].assert(payloadToSend.storageStatus, Joi__default["default"].string().allow('').error(new Error('storageStatus is required after formatting payload')));
767
+ Joi__default["default"].assert(payloadToSend.ocrDocumentBackend, Joi__default["default"].boolean().error(new Error('ocrDocumentBackend is required after formatting payload')));
768
+ Joi__default["default"].assert(payloadToSend.docAreaPermission, Joi__default["default"].object().allow({}).error(new Error('docAreaPermission is required after formatting payload')));
769
+ Joi__default["default"].assert(payloadToSend.docTypeFieldsData, Joi__default["default"].object().allow({}).error(new Error('docTypeFieldsData is required after formatting payload')));
770
+ Joi__default["default"].assert(payloadToSend.urlType, Joi__default["default"].string().allow('').error(new Error('urlType is required after formatting payload')));
771
+ Joi__default["default"].assert(payloadToSend.addType, Joi__default["default"].string().allow('').error(new Error('addType is required after formatting payload')));
772
772
 
773
773
  const {areaId, orgId} = params;
774
774
  const apiCall = self._client