format

Author: SirSimon04

.cdsprettier.json

@@ -0,0 +1,8 @@
+{
+  "maxDocCommentLine": 80,
+  "formatDocComments": true,
+  "tabSize": 2,
+  "alignPostAnnotations": false,
+  "alignColonsInAnnotations": false,
+  "alignValuesInAnnotations": false
+}

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  tabWidth: 2,
+  semi: true,
+  printWidth: 100,
+  trailingComma: "all",
+};

CHANGELOG.md

@@ -36,29 +36,26 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Fixed handling of unmanaged composition of many
 - Proper casing of the operation enum type
 
-
 ### Changed
 
 - Added warning and mitigation for multi-tenant deployments with MTX
 - Added a disclaimer of upcoming new version having a minimum requirement of CDS 8.6 for multitenancy fix
 - Changed the default limit on non-HANA databases from 255 to 5000 characters for all String values
 - Updated peer dependency from CDS7 to CDS8
 
-
 ## Version 1.0.7 - 20.08.24
 
 ### Added
 
- - A global switch to preserve change logs for deleted data
- - For hierarchical entities, a method to determine their structure and a flag to indicate whether it is a root entity was introduced. For child entities, information about the parent is recorded.
-
+- A global switch to preserve change logs for deleted data
+- For hierarchical entities, a method to determine their structure and a flag to indicate whether it is a root entity was introduced. For child entities, information about the parent is recorded.
 
 ### Fixed
 
 - CDS 8 does not support queries for draft-enabled entities on the application service anymore. This was causing: SqliteError: NOT NULL constraint failed: (...).DraftAdministrativeData_DraftUUID
 - CDS 8 deprecated cds.transaction, causing change logs of nested documents to be wrong, replaced with req.event
 - CDS 8 rejects all direct CRUD requests for auto-exposed Compositions in non-draft cases. This was affecting test cases, since the ChangeView falls into this category
-- req._params and req.context are not official APIs and stopped working with CDS 8, replaced with official APIs
+- req.\_params and req.context are not official APIs and stopped working with CDS 8, replaced with official APIs
 - When running test cases in CDS 8, some requests failed with a status code of 404
 - ServiceEntity is not captured in the ChangeLog table in some cases
 - When modeling an inline entity, a non-existent association and parent ID was recorded
@@ -70,22 +67,21 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Data marked as personal data using data privacy annotations won't get change-tracked anymore to satisfy product standards
 - Restructured Documentation
 
-
 ## Version 1.0.6 - 29.04.24
 
 ### Fixed
 
- -  Storage of wrong ObjectID in some special scenarios
- -  Missing localization of managed fields
- -  Views without keys won't get the association and UI facet pushed anymore
+- Storage of wrong ObjectID in some special scenarios
+- Missing localization of managed fields
+- Views without keys won't get the association and UI facet pushed anymore
 
 ### Added
 
- - A method to disable automatic generation of the UI Facet
+- A method to disable automatic generation of the UI Facet
 
 ### Changed
 
- - Improved documentation of the @changelog Annotation
+- Improved documentation of the @changelog Annotation
 
 ## Version 1.0.5 - 15.01.24
 
@@ -112,7 +108,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Added
 
-- Added note about using `SAPUI5 v1.120.0` or later for proper lazy loading of the *Change History* table.
+- Added note about using `SAPUI5 v1.120.0` or later for proper lazy loading of the _Change History_ table.
 - In README, add warning about tracking personal data.
 
 ### Changed
@@ -141,4 +137,3 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Added
 
 - Initial release
-

CONTRIBUTING.md

@@ -10,11 +10,11 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor
 
 We use GitHub to manage reviews of pull requests.
 
-* If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute)
+- If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute)
 
-* Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.
+- Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.
 
-* The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation.
+- The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation.
 
 ## Steps to Contribute
 
@@ -28,11 +28,11 @@ You are welcome to contribute code in order to fix a bug or to implement a new f
 
 The following rule governs code contributions:
 
-* Contributions must be licensed under the [Apache 2.0 License](./LICENSE)
-* Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
+- Contributions must be licensed under the [Apache 2.0 License](./LICENSE)
+- Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
 
 ## Issues and Planning
 
-* We use GitHub issues to track bugs and enhancement requests.
+- We use GitHub issues to track bugs and enhancement requests.
 
-* Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.
+- Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.

README.md

@@ -23,8 +23,8 @@ Usage of this plugin requires a valid subscription of the [SAP Print Service](ht
 To use this plugin to print documents there are two main steps:
 
 1. Add required annotations to your CDS model.
-    a. Entity
-    b. Action
+   a. Entity
+   b. Action
 2. Configure print queues to select from available options. (Optional, but recommended)
 
 ### Annotations in CDS model
@@ -47,6 +47,7 @@ entity Incidents : cuid {
 - `@print.fileName`: Annotates the field containing the name of the document
 
 #### Annotation of actions
+
 Sending a print request works via bound actions annotated with `@print`. The parameter of the action are used to define the print job details.
 
 ```cds
@@ -72,7 +73,7 @@ service IncidentService {
           qnameID: String,
           @print.numberOfCopies
           @UI.ParameterDefaultValue : 1
-          copies: Integer 
+          copies: Integer
       );
     };
 }
@@ -82,7 +83,8 @@ service IncidentService {
 - `@print.queue`: Annotates the parameter specifying the print queue. It is recommended to use a value help for this parameter to select from available print queues. See TOOD
 - `@print.numberOfCopies`: Annotates the parameter specifying the number of copies to print
 
-### Queues 
+### Queues
+
 Every print request needs to specify a print queue it is send to. It is recommended to provide a value help for the print queue selection. To enbale this, define an entity as projection on the `Queues` entity provided by the print service. When this projection is in place, the plugin automatically provides the available print queues coming from the print service.
 
 ```cds

cds-plugin.js

@@ -1,5 +1,5 @@
-const cds = require('@sap/cds');
-const LOG = cds.log('print');
+const cds = require("@sap/cds");
+const LOG = cds.log("print");
 
 const PRINT = "@print";
 const PRINT_NUMBER_OF_COPIES = "@print.numberOfCopies";
@@ -10,100 +10,96 @@ const PRINT_FILE_CONTENT = "@print.fileContent";
 const QUEUE_ENTITY_NAME = "sap.print.Queues";
 
 cds.once("served", async () => {
-    // Iterate over all services
-    for (let srv of cds.services) {
-        // Iterate over all entities in the service
-        for (let entity of srv.entities) {
-
-            if (entity.projection?.from.ref[0] === QUEUE_ENTITY_NAME) {
-                const printer = await cds.connect.to("print");
-
-                srv.after('READ', entity, async (_, req) => {
-                    const q = await printer.getQueues();
-                    q.forEach((item, index) => {
-                        req.results[index] = { ID: item.ID };
-                    });
-                    req.results.$count = q.length;
-                    return;
-                });
-            }
-
-            if(!entity.actions) continue
-
-            for(const action of entity.actions) {
-                if(action[PRINT]) {
-
-                    const printer = await cds.connect.to("print");
-
-                    const { numberOfCopiesAttribute, queueIDAttribute, fileNameAttribute, contentAttribute } = getPrintParamsAttributeFromAction(entity, action);
-
-                    srv.on(action.name, entity, async (req) => {
-
-
-                        const numberOfCopies = req.data[numberOfCopiesAttribute];
-                        const queueID = req.data[queueIDAttribute];
-
-                        const object = await SELECT.one.from(req.subject).columns([fileNameAttribute, contentAttribute]);
-
-                        if(!object) return req.reject(404, `Object not found for printing.`);
-                        if(!numberOfCopies) return req.reject(400, `Please specify number of copies to print.`);
-                        if(!queueID) return req.reject(400, `Please specify print queue.`);
-
-                        const streamToBase64 = async (stream) => {
-                            const chunks = [];
-                            for await (const chunk of stream) {
-                                chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
-                            }
-                            return Buffer.concat(chunks).toString('base64');
-                        };
-                        try {
-
-                            await printer.print({
-                                qname: queueID, 
-                                numberOfCopies: numberOfCopies,
-                                docsToPrint: [{
-                                    fileName: object[fileNameAttribute],
-                                    content: await streamToBase64(object[contentAttribute]),
-                                    isMainDocument: true
-                                }]
-                            })
-
-                            return req.info({
-                                status: 200,
-                                message: `Print job for file ${object[fileNameAttribute]} sent to queue ${queueID} for ${numberOfCopies} copies.`
-                            });
-
-                        }
-                        catch (error) {
-                            return req.reject(500, `Error: ${error.message ?? "Unknown error"}`);
-                        }
-
-
-                    });
-                }
+  // Iterate over all services
+  for (let srv of cds.services) {
+    // Iterate over all entities in the service
+    for (let entity of srv.entities) {
+      if (entity.projection?.from.ref[0] === QUEUE_ENTITY_NAME) {
+        const printer = await cds.connect.to("print");
+
+        srv.after("READ", entity, async (_, req) => {
+          const q = await printer.getQueues();
+          q.forEach((item, index) => {
+            req.results[index] = { ID: item.ID };
+          });
+          req.results.$count = q.length;
+          return;
+        });
+      }
+
+      if (!entity.actions) continue;
+
+      for (const action of entity.actions) {
+        if (action[PRINT]) {
+          const printer = await cds.connect.to("print");
+
+          const { numberOfCopiesAttribute, queueIDAttribute, fileNameAttribute, contentAttribute } =
+            getPrintParamsAttributeFromAction(entity, action);
+
+          srv.on(action.name, entity, async (req) => {
+            const numberOfCopies = req.data[numberOfCopiesAttribute];
+            const queueID = req.data[queueIDAttribute];
+
+            const object = await SELECT.one
+              .from(req.subject)
+              .columns([fileNameAttribute, contentAttribute]);
+
+            if (!object) return req.reject(404, `Object not found for printing.`);
+            if (!numberOfCopies)
+              return req.reject(400, `Please specify number of copies to print.`);
+            if (!queueID) return req.reject(400, `Please specify print queue.`);
+
+            const streamToBase64 = async (stream) => {
+              const chunks = [];
+              for await (const chunk of stream) {
+                chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+              }
+              return Buffer.concat(chunks).toString("base64");
+            };
+            try {
+              await printer.print({
+                qname: queueID,
+                numberOfCopies: numberOfCopies,
+                docsToPrint: [
+                  {
+                    fileName: object[fileNameAttribute],
+                    content: await streamToBase64(object[contentAttribute]),
+                    isMainDocument: true,
+                  },
+                ],
+              });
+
+              return req.info({
+                status: 200,
+                message: `Print job for file ${object[fileNameAttribute]} sent to queue ${queueID} for ${numberOfCopies} copies.`,
+              });
+            } catch (error) {
+              return req.reject(500, `Error: ${error.message ?? "Unknown error"}`);
             }
+          });
         }
+      }
     }
+  }
 });
 
 function getPrintParamsAttributeFromAction(entity, action) {
-
-    const copiesElement = Object.values(action.params).find(el => el[PRINT_NUMBER_OF_COPIES]);
-    const queueElement = Object.values(action.params).find(el => el[PRINT_QUEUE]);
-
-    const fileName = Object.values(entity.elements).find(el => el[PRINT_FILE_NAME]);
-    const content = Object.values(entity.elements).find(el => el[PRINT_FILE_CONTENT]);
-
-
-    if(!copiesElement || !queueElement, !fileName || !content) {
-        cds.error(`Print action ${action.name} is missing required annotations. Make sure @print.numberOfCopies, @print.queue are present in the action and @print.fileName and @print.fileContent are present in the entity.`);
-    }
-
-    return {
-        numberOfCopiesAttribute: copiesElement.name,
-        queueIDAttribute: queueElement.name,
-        fileNameAttribute: fileName.name,
-        contentAttribute: content.name
-    };
+  const copiesElement = Object.values(action.params).find((el) => el[PRINT_NUMBER_OF_COPIES]);
+  const queueElement = Object.values(action.params).find((el) => el[PRINT_QUEUE]);
+
+  const fileName = Object.values(entity.elements).find((el) => el[PRINT_FILE_NAME]);
+  const content = Object.values(entity.elements).find((el) => el[PRINT_FILE_CONTENT]);
+
+  if ((!copiesElement || !queueElement, !fileName || !content)) {
+    cds.error(
+      `Print action ${action.name} is missing required annotations. Make sure @print.numberOfCopies, @print.queue are present in the action and @print.fileName and @print.fileContent are present in the entity.`,
+    );
+  }
+
+  return {
+    numberOfCopiesAttribute: copiesElement.name,
+    queueIDAttribute: queueElement.name,
+    fileNameAttribute: fileName.name,
+    contentAttribute: content.name,
+  };
 }
-

jest-integration.config.js

@@ -1,7 +1,7 @@
 const integrationconfig = {
-    verbose: true,
-    testTimeout: 100000,
-    testMatch: ["**/test/integration/annotation.test.js"]
-  };
-  
-  module.exports = integrationconfig;
+  verbose: true,
+  testTimeout: 100000,
+  testMatch: ["**/test/integration/annotation.test.js"],
+};
+
+module.exports = integrationconfig;

jest.config.js

@@ -1,18 +1,18 @@
 const config = {
   verbose: true,
   testTimeout: 100000,
-  testMatch: ["**/test/lib/**/*.test.js","**/test/srv/**/*.test.js"],
-  collectCoverageFrom: ["**/lib/**/*","srv/**/*"],
+  testMatch: ["**/test/lib/**/*.test.js", "**/test/srv/**/*.test.js"],
+  collectCoverageFrom: ["**/lib/**/*", "srv/**/*"],
   coveragePathIgnorePatterns: ["node_modules", "<rootDir>/lib/persistence"],
   coverageReporters: ["lcov", "text", "text-summary"],
   coverageThreshold: {
     global: {
       branches: 90,
       lines: 90,
       statements: 90,
-      functions: 90
+      functions: 90,
     },
-  }
+  },
 };
 
-module.exports = config;
+module.exports = config;

lib/printUtil.js

@@ -1,2 +1 @@
-
 module.exports = { print, getQueues };