@itentialopensource/adapter-sharepoint 0.1.1 → 0.2.0

package/report/adapter-openapi.yaml

@@ -0,0 +1,447 @@
+openapi: 3.0.0
+info:
+  title: Sharepoint
+  contact: {}
+  version: '1.0'
+servers:
+- url: https://{site_url}/_api/web
+  variables:
+    site_url:
+      default: DefaultParameterValue
+paths:
+  /lists/{title}:
+    get:
+      tags:
+      - Lists
+      summary: getListByTitle
+      description: ''
+      operationId: getListByTitle
+      parameters:
+      - name: title
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /{guid}:
+    get:
+      tags:
+      - Lists
+      summary: getListByGuid
+      description: ''
+      operationId: getListByGuid
+      parameters:
+      - name: guid
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+    post:
+      tags:
+      - Lists
+      summary: updateList
+      description: ''
+      operationId: updateList
+      parameters:
+      - name: guid
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/updateListRequest'
+              - example:
+                  __metadata:
+                    type: SP.List
+                  Title: New title
+            example:
+              __metadata:
+                type: SP.List
+              Title: New title
+        required: true
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /lists:
+    post:
+      tags:
+      - Lists
+      summary: createList
+      description: ''
+      operationId: createList
+      parameters: []
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/createListRequest'
+              - example:
+                  __metadata:
+                    type: SP.List
+                  AllowContentTypes: true
+                  BaseTemplate: 100
+                  ContentTypesEnabled: true
+                  Description: My list description
+                  Title: Test
+            example:
+              __metadata:
+                type: SP.List
+              AllowContentTypes: true
+              BaseTemplate: 100
+              ContentTypesEnabled: true
+              Description: My list description
+              Title: Test
+        required: true
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /{relativeUrl}:
+    get:
+      tags:
+      - Folders
+      summary: getFolderByServerRelativeUrl
+      description: ''
+      operationId: getFolderByServerRelativeUrl
+      parameters:
+      - name: relativeUrl
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+    post:
+      tags:
+      - Folders
+      summary: deleteFolder
+      description: ''
+      operationId: deleteFolder
+      parameters:
+      - name: relativeUrl
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /folders:
+    post:
+      tags:
+      - Folders
+      summary: createFolder
+      description: ''
+      operationId: createFolder
+      parameters: []
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/createFolderRequest'
+              - example:
+                  __metadata:
+                    type: SP.Folder
+                  ServerRelativeUrl: /document library relative url/folder name
+            example:
+              __metadata:
+                type: SP.Folder
+              ServerRelativeUrl: /document library relative url/folder name
+        required: true
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /{relativeUrl}/ListItemAllFields:
+    get:
+      tags:
+      - Folders
+      summary: getFolderODataType
+      description: ''
+      operationId: getFolderODataType
+      parameters:
+      - name: relativeUrl
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+    post:
+      tags:
+      - Folders
+      summary: renameFolder
+      description: ''
+      operationId: renameFolder
+      parameters:
+      - name: relativeUrl
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      requestBody:
+        description: ''
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/renameFolderRequest'
+              - example:
+                  __metadata:
+                    type: '{odata.type from previous call}'
+                  Title: New name
+                  FileLeafRef: New name
+            example:
+              __metadata:
+                type: '{odata.type from previous call}'
+              Title: New name
+              FileLeafRef: New name
+        required: true
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /{relativeUrl}/Files:
+    get:
+      tags:
+      - Files
+      summary: getFilesByFolder
+      description: ''
+      operationId: getFilesByFolder
+      parameters:
+      - name: relativeUrl
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /{relativeUrl}/{fileName}/$value:
+    get:
+      tags:
+      - Files
+      summary: getFile
+      description: ''
+      operationId: getFile
+      parameters:
+      - name: relativeUrl
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      - name: fileName
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+  /{relativeUrl}/$value:
+    get:
+      tags:
+      - Files
+      summary: getFileByFileUrl
+      description: ''
+      operationId: getFileByFileUrl
+      parameters:
+      - name: relativeUrl
+        in: path
+        description: ''
+        required: true
+        style: simple
+        schema:
+          type: string
+          example: 'null'
+      responses:
+        '200':
+          description: ''
+          headers: {}
+          content: {}
+      deprecated: false
+components:
+  schemas:
+    createListRequest:
+      title: createListRequest
+      required:
+      - __metadata
+      - AllowContentTypes
+      - BaseTemplate
+      - ContentTypesEnabled
+      - Description
+      - Title
+      type: object
+      properties:
+        __metadata:
+          allOf:
+          - $ref: '#/components/schemas/Metadata'
+          - example:
+              type: SP.List
+        AllowContentTypes:
+          type: boolean
+        BaseTemplate:
+          type: integer
+          format: int32
+        ContentTypesEnabled:
+          type: boolean
+        Description:
+          type: string
+        Title:
+          type: string
+      example:
+        __metadata:
+          type: SP.List
+        AllowContentTypes: true
+        BaseTemplate: 100
+        ContentTypesEnabled: true
+        Description: My list description
+        Title: Test
+    Metadata:
+      title: Metadata
+      required:
+      - type
+      type: object
+      properties:
+        type:
+          type: string
+      example:
+        type: SP.List
+    updateListRequest:
+      title: updateListRequest
+      required:
+      - __metadata
+      - Title
+      type: object
+      properties:
+        __metadata:
+          allOf:
+          - $ref: '#/components/schemas/Metadata'
+          - example:
+              type: SP.List
+        Title:
+          type: string
+      example:
+        __metadata:
+          type: SP.List
+        Title: New title
+    createFolderRequest:
+      title: createFolderRequest
+      required:
+      - __metadata
+      - ServerRelativeUrl
+      type: object
+      properties:
+        __metadata:
+          allOf:
+          - $ref: '#/components/schemas/Metadata'
+          - example:
+              type: SP.List
+        ServerRelativeUrl:
+          type: string
+      example:
+        __metadata:
+          type: SP.Folder
+        ServerRelativeUrl: /document library relative url/folder name
+    renameFolderRequest:
+      title: renameFolderRequest
+      required:
+      - __metadata
+      - Title
+      - FileLeafRef
+      type: object
+      properties:
+        __metadata:
+          allOf:
+          - $ref: '#/components/schemas/Metadata'
+          - example:
+              type: SP.List
+        Title:
+          type: string
+        FileLeafRef:
+          type: string
+      example:
+        __metadata:
+          type: '{odata.type from previous call}'
+        Title: New name
+        FileLeafRef: New name
+tags:
+- name: Lists
+- name: Folders
+- name: Files

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.1.0",
-  "configLines": 2592,
-  "scriptLines": 1795,
-  "codeLines": 3656,
-  "testLines": 3521,
-  "testCases": 157,
-  "totalCodeLines": 8972,
-  "wfTasks": 29
+  "version": "0.1.1",
+  "configLines": 3336,
+  "scriptLines": 1783,
+  "codeLines": 3150,
+  "testLines": 3970,
+  "testCases": 186,
+  "totalCodeLines": 8903,
+  "wfTasks": 37
 }

package/report/updateReport1698421467873.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 77
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 347
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 1908
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 95
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 810
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 21
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 4171
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 116
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -4,6 +4,7 @@
   "properties": {
     "host": "localhost",
     "port": 443,
+    "choosepath": "",
     "base_path": "/_api/web",
     "version": "",
     "cache_location": "none",
@@ -25,12 +26,27 @@
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",
-      "grant_type": ""
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ]
     },
     "healthcheck": {
       "type": "none",
       "frequency": 60000,
-      "query_object": {}
+      "query_object": {},
+      "addlHeaders": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -125,6 +141,12 @@
         {
           "path": "/get/devices",
           "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
           "query": {},
           "body": {},
           "headers": {},
@@ -186,6 +208,45 @@
           "responseFields": {}
         }
       ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "",
+          "frequency": 1440,
+          "flushOnFail": false,
+          "limit": 1000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "",
+              "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {},
+              "responseDatakey": "",
+              "responseFields": {}
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
+        }
+      ]
     }
   },
   "groups": [],

package/test/integration/adapterTestBasicGet.js

@@ -7,9 +7,9 @@
 /* eslint import/no-dynamic-require: warn */
 /* eslint import/no-unresolved: warn */
 
-const mocha = require('mocha');
 const path = require('path');
 const assert = require('assert');
+const mocha = require('mocha');
 const itParam = require('mocha-param');
 
 const utils = require('../../utils/tbUtils');