yaveon.ecm.d3dwebhooks 0.7.0 → 0.7.2

package/js/Yaveon.ECM.d3d.Client.d.ts

@@ -3,60 +3,12 @@ export declare class D3dClient {
     protected repositoryId: string;
     private defaultHeaders;
     constructor(baseUrl: string, repositoryId: string, accessToken: string);
-    /**
-    *  creates a copy of the default header and sets content-type to 'octet-stream'
-    *
-    * @returns a copy of the default header and with content-type set to 'octet-stream'
-    */
     private getUploadHeader;
-    /**
-    * uploads a binary chunk of data to d3 documents
-    *
-    * @param binaryData - this parameter takes in the upload body as byte array
-    * @returns The response object of the webservice call
-    */
     uploadChunk(binaryData: Uint8Array): Promise<any>;
-    /**
-    * updates a document with properties in the updateBody
-    *
-    * @param d3dObjectId - string id of the documents object
-    * @param updateBody - contains the properties which are supposed to be updated
-    * @returns The response object of the webservice call
-    */
     updateDocumentProperties(d3dObjectId: string, updateBody: Object): Promise<any>;
-    /**
-    *  returns the content of a d3 documents file
-    *
-    * @param d3dDocumentId - string id of the documents object
-    * @returns the retrieved documents file content
-    */
     getDocumentContent(d3dDocumentId: string): Promise<any>;
-    /**
-    *
-    * @param d3dObjectId - string id of the documents object
-    * @param ownerUpn - upn of the desired owner
-    * @param stateValue - string representation of a DmsObjectState
-    * @param alterationText - optional: value that contains the alteration reason for documents system
-    * @returns the d3dObject update response object
-    */
     setObjectState(d3dObjectId: string, ownerUpn: string, stateValue: string, alterationText?: string): Promise<any>;
-    /**
-    * returns a valid eTag value
-    *
-    * @param d3dObjectId - string id of the documents object
-    * @returns a valid eTag value string
-    */
     getETag(d3dObjectId: string): Promise<string>;
-    /**
-    * retrieves an object that represents the current user
-    * @returns the current user object
-    */
     getCurrentUserObject(): Promise<any>;
-    /**
-     * retrieves search results for the given search url
-     *
-     * @param searchUrlPart - contains the search query
-     * @returns the search result object
-     */
     getSearchResults(searchUrlPart: string): Promise<any>;
 }

package/js/Yaveon.ECM.d3d.Client.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.D3dClient = void 0;
 const Constants = __importStar(require("./Yaveon.ECM.d3d.Webhook.Constants"));
 const axios_1 = __importDefault(require("axios"));
-//const axios = require('axios');
 class D3dClient {
     constructor(baseUrl, repositoryId, accessToken) {
         this.baseUrl = baseUrl;
@@ -39,46 +38,22 @@ class D3dClient {
         this.defaultHeaders.Origin = baseUrl;
         axios_1.default.defaults.headers.common = this.defaultHeaders;
     }
-    /**
-    *  creates a copy of the default header and sets content-type to 'octet-stream'
-    *
-    * @returns a copy of the default header and with content-type set to 'octet-stream'
-    */
     getUploadHeader() {
         let headerCopy = JSON.parse(JSON.stringify(this.defaultHeaders));
         headerCopy['Content-Type'] = "application/octet-stream";
         return headerCopy;
     }
-    /**
-    * uploads a binary chunk of data to d3 documents
-    *
-    * @param binaryData - this parameter takes in the upload body as byte array
-    * @returns The response object of the webservice call
-    */
     async uploadChunk(binaryData) {
         let uploadHeader = this.getUploadHeader();
         let uploadUrl = this.baseUrl + "/dms/r/" + this.repositoryId + "/blob/chunk/";
         let uploadResponse = await axios_1.default.post(uploadUrl, binaryData, { headers: uploadHeader });
         return uploadResponse;
     }
-    /**
-    * updates a document with properties in the updateBody
-    *
-    * @param d3dObjectId - string id of the documents object
-    * @param updateBody - contains the properties which are supposed to be updated
-    * @returns The response object of the webservice call
-    */
     async updateDocumentProperties(d3dObjectId, updateBody) {
         const updateUrl = this.baseUrl + '/dms/r/' + this.repositoryId + '/o2/' + d3dObjectId;
         let updateResponse = await axios_1.default.put(updateUrl, updateBody);
         return updateResponse;
     }
-    /**
-    *  returns the content of a d3 documents file
-    *
-    * @param d3dDocumentId - string id of the documents object
-    * @returns the retrieved documents file content
-    */
     async getDocumentContent(d3dDocumentId) {
         const fileUrl = this.baseUrl + '/dms/r/' + this.repositoryId + '/o2m/' + d3dDocumentId;
         const getFileResponse = await axios_1.default.get(fileUrl);
@@ -86,14 +61,6 @@ class D3dClient {
         const getFileContentResponse = await axios_1.default.get(fileContentUrl);
         return getFileContentResponse.data;
     }
-    /**
-    *
-    * @param d3dObjectId - string id of the documents object
-    * @param ownerUpn - upn of the desired owner
-    * @param stateValue - string representation of a DmsObjectState
-    * @param alterationText - optional: value that contains the alteration reason for documents system
-    * @returns the d3dObject update response object
-    */
     async setObjectState(d3dObjectId, ownerUpn, stateValue, alterationText = '') {
         if (!Constants.DmsObjectStates.isValid(stateValue)) {
             throw stateValue + " is not a valid document state. Valid states are " + Object.values(Constants.DmsObjectStates.States).join(", ");
@@ -102,11 +69,6 @@ class D3dClient {
             stateValue = Constants.FILE_STATUS_RELEASED;
         }
         const updateUrl = this.baseUrl + '/dms/r/' + this.repositoryId + '/o2/' + d3dObjectId + '/v/current';
-        /* let updateBody: Map <string,string> = new Map <string,string>([
-            ['eTag', await this.getETag(d3dObjectId)],
-            ['state', stateValue],
-            ['destionationUserOrGroup', ownerUpn]
-        ]); */
         let updateBody = {
             "eTag": await this.getETag(d3dObjectId),
             "state": stateValue,
@@ -114,51 +76,20 @@ class D3dClient {
             "alterationText": alterationText
         };
         let updateResponse = null;
-        try {
-            updateResponse = await axios_1.default.put(updateUrl, updateBody);
-        }
-        catch (ex) {
-            debugger;
-        }
+        updateResponse = await axios_1.default.put(updateUrl, updateBody);
         return updateResponse;
     }
-    /**
-    * returns a valid eTag value
-    *
-    * @param d3dObjectId - string id of the documents object
-    * @returns a valid eTag value string
-    */
     async getETag(d3dObjectId) {
         const eTagRequestUrl = this.baseUrl + '/dms/r/' + this.repositoryId + '/o2/' + d3dObjectId;
-        try {
-            const eTagResponse = await axios_1.default.get(eTagRequestUrl);
-            return eTagResponse.data.eTag;
-        }
-        catch (ex) {
-            throw ex.Message;
-        }
+        const eTagResponse = await axios_1.default.get(eTagRequestUrl);
+        return eTagResponse.data.eTag;
     }
-    /**
-    * retrieves an object that represents the current user
-    * @returns the current user object
-    */
     async getCurrentUserObject() {
         let requestUrl = this.baseUrl + "/identityprovider/validate";
         let response;
-        try {
-            response = await axios_1.default.get(requestUrl);
-        }
-        catch (ex) {
-            throw ex.Message;
-        }
+        response = await axios_1.default.get(requestUrl);
         return response.data;
     }
-    /**
-     * retrieves search results for the given search url
-     *
-     * @param searchUrlPart - contains the search query
-     * @returns the search result object
-     */
     async getSearchResults(searchUrlPart) {
         let resultItems;
         let searchUrl = this.baseUrl + '/dms/r/' + this.repositoryId + '/sr' + searchUrlPart;

package/js/Yaveon.ECM.d3d.Webhook.Client.d.ts

@@ -4,52 +4,11 @@ export declare class D3dWebhookClient extends D3dClient {
     private configFileId;
     private currentUserName;
     constructor(baseUrl: string, repositoryId: string, accessToken: string);
-    /**
-    * updates the config file in d3 documents with the given config object
-    *
-    * @param configObject - config object that shall be written to d3d documents
-    * @param updateBody - contains the necessary metadata
-    * @returns {string} contentLocationUri
-    */
     updateConfiguration(configObject: Object, alterationText: string): Promise<any>;
-    /**
-    * ensures that configuration file id is present. Throws if file can't be found.
-    *
-    * @returns void
-    */
     private ensureConfigurationFileId;
-    /**
-    * retrieves the webhook configuration from d3 documents
-    *
-    * @returns webhook configuration object
-    */
     getConfiguration(): Promise<any>;
-    /**
-    * sets the config file to state 'processing'
-    *
-    * @param configFileId  - string id of the config file document
-    * @returns void
-    */
     blockConfiguration(): Promise<void>;
-    /**
-    * sets the config file to state 'released'
-    *
-    * @param configFileId  - string id of the config file document
-    * @returns void
-    */
     releaseConfiguration(alterationText?: string): Promise<void>;
-    /**
-     * retrieves the current user name
-     *
-     * @returns the current user name as string
-     */
     getCurrentUserName(): Promise<string>;
-    /**
-    * returns the document categroy specific number range information from config
-    *
-    * @param doc - the current document object
-    * @param config - the current config object
-    * @returns the document categroy's' number range information from config
-    */
     getNumberRangeInformation(doc: any, config: any): INumberRangePropertyObject[];
 }

package/js/Yaveon.ECM.d3d.Webhook.Client.js

@@ -32,13 +32,6 @@ class D3dWebhookClient extends Yaveon_ECM_d3d_Client_1.D3dClient {
         this.configFileId = '';
         this.currentUserName = '';
     }
-    /**
-    * updates the config file in d3 documents with the given config object
-    *
-    * @param configObject - config object that shall be written to d3d documents
-    * @param updateBody - contains the necessary metadata
-    * @returns {string} contentLocationUri
-    */
     async updateConfiguration(configObject, alterationText) {
         await this.ensureConfigurationFileId();
         let uploadResponse = await this.uploadChunk((new TextEncoder).encode(JSON.stringify(configObject)));
@@ -52,34 +45,23 @@ class D3dWebhookClient extends Yaveon_ECM_d3d_Client_1.D3dClient {
         let updateResponse = await this.updateDocumentProperties(this.configFileId, updateBody);
         return updateResponse;
     }
-    /**
-    * ensures that configuration file id is present. Throws if file can't be found.
-    *
-    * @returns void
-    */
     async ensureConfigurationFileId() {
         if (this.configFileId) {
             return;
         }
         let searchResults = await this.getSearchResults('?properties={"property_filename":["' + Constants.ConfigFileName + '"],"property_filetype":["' + Constants.ConfigFileExtension + '"]}');
         if (searchResults.count === 0) {
-            throw "Configuration file with filname '" + Constants.ConfigFileName + "' and filetype '" + Constants.ConfigFileExtension + "' could not be found.";
+            let err = new Error("Configuration file with filname '" + Constants.ConfigFileName + "' and filetype '" + Constants.ConfigFileExtension + "' could not be found.");
+            throw err;
         }
         this.configFileId = searchResults[0].id;
     }
-    /**
-    * retrieves the webhook configuration from d3 documents
-    *
-    * @returns webhook configuration object
-    */
     async getConfiguration() {
         let searchResults = await this.getSearchResults('?properties={"property_filename":["' + Constants.ConfigFileName + '"],"property_filetype":["' + Constants.ConfigFileExtension + '"]}');
         let configFileState = searchResults[0].displayProperties.find((p) => p.id === Constants.FILE_STATUS_PROPERTY_NAME).value.toLowerCase();
         this.configFileId = searchResults[0].id;
-        // make sure to not use a configuration that is about to get changed
         let counter = 0;
         while (configFileState !== Constants.DmsObjectStates.States.Released) {
-            // go to sleep
             await new Promise(resolve => setTimeout(resolve, Constants.ConfigFileLockedTimeout));
             if (counter >= 2) {
                 await this.releaseConfiguration(this.configFileId);
@@ -90,44 +72,20 @@ class D3dWebhookClient extends Yaveon_ECM_d3d_Client_1.D3dClient {
         }
         return await this.getDocumentContent(this.configFileId);
     }
-    /**
-    * sets the config file to state 'processing'
-    *
-    * @param configFileId  - string id of the config file document
-    * @returns void
-    */
     async blockConfiguration() {
         await this.ensureConfigurationFileId();
         await this.setObjectState(this.configFileId, (await this.getCurrentUserName()), Constants.DmsObjectStates.States.Processing);
     }
-    /**
-    * sets the config file to state 'released'
-    *
-    * @param configFileId  - string id of the config file document
-    * @returns void
-    */
     async releaseConfiguration(alterationText = '') {
         await this.ensureConfigurationFileId();
         await this.setObjectState(this.configFileId, (await this.getCurrentUserName()), Constants.DmsObjectStates.States.Released, alterationText);
     }
-    /**
-     * retrieves the current user name
-     *
-     * @returns the current user name as string
-     */
     async getCurrentUserName() {
         if (this.currentUserName == null) {
             this.currentUserName = (await this.getCurrentUserObject()).userName;
         }
         return this.currentUserName;
     }
-    /**
-    * returns the document categroy specific number range information from config
-    *
-    * @param doc - the current document object
-    * @param config - the current config object
-    * @returns the document categroy's' number range information from config
-    */
     getNumberRangeInformation(doc, config) {
         let tenantInfo = config.numberRanges.tenants.find((cp) => {
             let tenantProperty = doc.properties.find((p) => p.id.toLowerCase() === cp.tenantPropertyGuid.toLowerCase());

package/js/Yaveon.ECM.d3d.Webhook.Constants.js

@@ -13,7 +13,6 @@ var _dmsObjectStates;
 class DmsObjectStates {
     static isValid(stateValue) {
         return Object.values(_dmsObjectStates).includes(stateValue);
-        // return true;
     }
     ;
 }
@@ -25,12 +24,6 @@ exports.ConfigFileDisplayName = 'Webhook Konfiguration';
 exports.FILE_STATUS_PROPERTY_NAME = 'property_state';
 exports.FILE_STATUS_RELEASED = 'release';
 exports.ConfigFileLockedTimeout = 3000;
-// export const  defaultHeaders: Map <string,string> = new Map <string,string> ([
-//     ['Accept', 'application/json+hal'],
-//     ['Authorization', ''], 
-//     ['Content-Type', 'application/json;charset=utf-8'],
-//     ['Origin', '']
-// ]);
 exports.defaultHeaders = {
     Accept: 'application/json+hal',
     Authorization: '',

package/js/Yaveon.ECM.d3d.Webhook.SetNumberId.d.ts

@@ -0,0 +1 @@
+export declare let SetNumberId: (req: any, res: any) => Promise<void>;

package/js/{Yaveon.ECM.d3d.Webhook.SetNumberId.Test.js → Yaveon.ECM.d3d.Webhook.SetNumberId.js}

@@ -1,16 +1,15 @@
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SetNumberId = void 0;
 const Yaveon_ECM_d3d_Webhook_Client_1 = require("./Yaveon.ECM.d3d.Webhook.Client");
 process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = '1';
-module.exports = async (req, res) => {
+let SetNumberId = async (req, res) => {
     let reqBody = req.json();
     let doc = reqBody.doc;
     let resultMsg = '';
     let resultState = 200;
     let whClient = new Yaveon_ECM_d3d_Webhook_Client_1.D3dWebhookClient(req.get('x-dv-baseuri'), req.get('x-dv-repository-id'), 'Bearer ' + req.get('Authorization').replace('Bearer ', ''));
-    // obtain configuration file
     let config = await whClient.getConfiguration();
-    // block configuration to prevent concurrent updates
     await whClient.blockConfiguration();
     let alterationText = "";
     try {
@@ -47,4 +46,5 @@ module.exports = async (req, res) => {
     }
     res.status(resultState).set(req.get()).send((resultState === 200 ? Buffer.from(JSON.stringify(reqBody)) : resultMsg));
 };
-//# sourceMappingURL=Yaveon.ECM.d3d.Webhook.SetNumberId.Test.js.map
+exports.SetNumberId = SetNumberId;
+//# sourceMappingURL=Yaveon.ECM.d3d.Webhook.SetNumberId.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yaveon.ecm.d3dwebhooks",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "Utility files for triggered d3d webhooks",
   "main": "",
   "scripts": {

package/js/Yaveon.ECM.d3d.Webhook.SetNumberId.Test.d.ts

@@ -1 +0,0 @@
-export {};