@itentialopensource/adapter-azure_devops 0.1.5 → 0.1.6

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.1.6 [12-01-2022]
+
+* ADAPT-2476
+
+See merge request itentialopensource/adapters/devops-netops/adapter-azure_devops!6
+
+---
+
 ## 0.1.5 [11-22-2022]
 
 * Implement API request Commits – Get Commits

package/adapter.js

@@ -5994,12 +5994,15 @@ class AzureDevops extends AdapterBaseCl {
    * @param {string} organization - The name of the Azure DevOps organization.
    * @param {string} repositoryId - The name or ID of the repository.
    * @param {string} project - Project ID or project name
+   * @param {string} [itemPath] - The item path.
    * @param {string} [scopePath] - The path scope.  The default is null.
    * @param {string} [recursionLevel] - The recursion level of this request. The default is 'none', no recursion.
    * @param {boolean} [includeContentMetadata] - Set to true to include content metadata.  Default is false.
    * @param {boolean} [latestProcessedChange] - Set to true to include the latest changes.  Default is false.
    * @param {boolean} [download] - Set to true to download the response as a file.  Default is false.
    * @param {boolean} [includeLinks] - Set to true to include links to items.  Default is false.
+   * @param {boolean} [includeContent] - Set to true to include item content when requesting json. Default is false.
+   * @param {boolean} [resolveLfs] - Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.
    * @param {string} [format] - If specified, this overrides the HTTP Accept request header to return either 'json' or 'zip'. If $format is specified, then api-version should also be specified as a quer...(description truncated)
    * @param {string} [versionDescriptorVersion] - Version string identifier (name of tag\/branch, SHA1 of commit)
    * @param {string} [versionDescriptorVersionOptions] - Version options - Specify additional modifiers to version (e.g Previous)
@@ -6013,7 +6016,7 @@ class AzureDevops extends AdapterBaseCl {
    * @task true
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
-  itemsList(organization, repositoryId, project, scopePath, recursionLevel = 'none', includeContentMetadata, latestProcessedChange, download, includeLinks, format, versionDescriptorVersion, versionDescriptorVersionOptions = 'none', versionDescriptorVersionType = 'branch', apiVersion, callback) {
+  itemsList(organization, repositoryId, project, itemPath, scopePath, recursionLevel = 'none', includeContentMetadata, latestProcessedChange, download, includeLinks, includeContent, resolveLfs, format, versionDescriptorVersion, versionDescriptorVersionOptions = 'none', versionDescriptorVersionType = 'branch', apiVersion, callback) {
     const meth = 'adapter-itemsList';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
@@ -6045,9 +6048,14 @@ class AzureDevops extends AdapterBaseCl {
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
+    if (itemPath === undefined || itemPath === null || itemPath === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['itemPath'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { scopePath, recursionLevel, includeContentMetadata, latestProcessedChange, download, includeLinks, format, versionDescriptorVersion, versionDescriptorVersionOptions, versionDescriptorVersionType, apiVersion };
+    const queryParamsAvailable = { itemPath, scopePath, recursionLevel, includeContentMetadata, latestProcessedChange, download, includeLinks, includeContent, resolveLfs, format, versionDescriptorVersion, versionDescriptorVersionOptions, versionDescriptorVersionType, apiVersion };
     const queryParams = {};
     const pathVars = [organization, project, repositoryId];
     const bodyVars = {};

package/entities/Items/schema.json

@@ -15,6 +15,17 @@
       ],
       "external_name": "ph_request_type"
     },
+    "itemPath": {
+      "type": "string",
+      "description": "The item path.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "path"
+    },
     "apiVersion": {
       "type": "string",
       "description": "Version of the API to use.  This should be set to '6.1-preview.1' to use this version of the api.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-azure_devops",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "This adapter integrates with system described as: Azure DevOps.",
   "main": "adapter.js",
   "systemName": "Microsoft Azure DevOps",

package/pronghorn.json

@@ -27617,6 +27617,16 @@
             "type": "string"
           }
         },
+        {
+          "name": "itemPath",
+          "type": "string",
+          "info": "The item path.",
+          "required": true,
+          "schema": {
+            "title": "itemPath",
+            "type": "string"
+          }
+        },
         {
           "name": "scopePath",
           "type": "string",
@@ -27677,6 +27687,26 @@
             "type": "boolean"
           }
         },
+        {
+          "name": "includeContent",
+          "type": "boolean",
+          "info": "Set to true to include item content when requesting json. Default is false.",
+          "required": false,
+          "schema": {
+            "title": "includeContent",
+            "type": "boolean"
+          }
+        },
+        {
+          "name": "resolveLfs",
+          "type": "boolean",
+          "info": "Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.",
+          "required": false,
+          "schema": {
+            "title": "resolveLfs",
+            "type": "boolean"
+          }
+        },
         {
           "name": "format",
           "type": "string",

package/test/integration/adapterTestIntegration.js

@@ -3235,7 +3235,7 @@ describe('[integration] Azure_devops Adapter Test', () => {
     describe('#itemsList - errors', () => {
       it('should work if integrated or standalone with mockdata', (done) => {
         try {
-          a.itemsList('fakedata', 'fakedata', 'fakedata', null, null, null, null, null, null, null, null, null, null, 'fakedata', (data, error) => {
+          a.itemsList('fakedata', 'fakedata', 'fakedata', 'fakedata', null, null, null, null, null, null, null, null, null, null, null, null, 'fakedata', (data, error) => {
             try {
               if (stub) {
                 runCommonAsserts(data, error);

package/test/unit/adapterTestUnit.js

@@ -5619,7 +5619,7 @@ describe('[unit] Azure_devops Adapter Test', () => {
       }).timeout(attemptTimeout);
       it('should error if - missing organization', (done) => {
         try {
-          a.itemsList(null, null, null, null, null, null, null, null, null, null, null, null, null, null, (data, error) => {
+          a.itemsList(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, (data, error) => {
             try {
               const displayE = 'organization is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-azure_devops-adapter-itemsList', displayE);
@@ -5636,7 +5636,7 @@ describe('[unit] Azure_devops Adapter Test', () => {
       }).timeout(attemptTimeout);
       it('should error if - missing repositoryId', (done) => {
         try {
-          a.itemsList('fakeparam', null, null, null, null, null, null, null, null, null, null, null, null, null, (data, error) => {
+          a.itemsList('fakeparam', null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, (data, error) => {
             try {
               const displayE = 'repositoryId is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-azure_devops-adapter-itemsList', displayE);
@@ -5653,7 +5653,7 @@ describe('[unit] Azure_devops Adapter Test', () => {
       }).timeout(attemptTimeout);
       it('should error if - missing project', (done) => {
         try {
-          a.itemsList('fakeparam', 'fakeparam', null, null, null, null, null, null, null, null, null, null, null, null, (data, error) => {
+          a.itemsList('fakeparam', 'fakeparam', null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, (data, error) => {
             try {
               const displayE = 'project is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-azure_devops-adapter-itemsList', displayE);
@@ -5670,7 +5670,7 @@ describe('[unit] Azure_devops Adapter Test', () => {
       }).timeout(attemptTimeout);
       it('should error if - missing apiVersion', (done) => {
         try {
-          a.itemsList('fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', null, (data, error) => {
+          a.itemsList('fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', 'fakeparam', null, (data, error) => {
             try {
               const displayE = 'apiVersion is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-azure_devops-adapter-itemsList', displayE);