@sap-ux/axios-extension 1.11.1 → 1.11.3

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.
@@ -2,6 +2,11 @@ import type { Logger } from '@sap-ux/logger';
2
2
  import type { AdtCategory, AdtCollection } from 'abap/types';
3
3
  import { Axios } from 'axios';
4
4
  interface AdtServiceExtension {
5
+ /**
6
+ * Attaches an ADT schema to the service.
7
+ *
8
+ * @param serviceSchema - The ADT collection to attach.
9
+ */
5
10
  attachAdtSchema(serviceSchema: AdtCollection): void;
6
11
  }
7
12
  /**
@@ -4,6 +4,12 @@ import http from 'http';
4
4
  import type { ABAPSystem } from './abap-system';
5
5
  interface Redirect {
6
6
  server: http.Server;
7
+ /**
8
+ * Redirect URL.
9
+ *
10
+ * @param port Port number.
11
+ * @returns Redirect URL.
12
+ */
7
13
  redirectUrl(port: number): string;
8
14
  }
9
15
  export interface SetupRedirectOptions {
@@ -12,10 +12,23 @@ export interface ServiceDocument {
12
12
  EntitySets: string[];
13
13
  }
14
14
  export interface ODataServiceExtension {
15
+ /**
16
+ * Retrieves the service document.
17
+ *
18
+ * @returns A Promise that resolves to a ServiceDocument
19
+ */
15
20
  document(): Promise<ServiceDocument>;
21
+ /**
22
+ * Retrieves the metadata of the service.
23
+ *
24
+ * @returns A Promise that resolves to a string containing the metadata
25
+ */
16
26
  metadata(): Promise<string>;
17
27
  }
18
28
  export interface ODataResponse<T> extends AxiosResponse {
29
+ /**
30
+ *
31
+ */
19
32
  odata(): T;
20
33
  }
21
34
  /**
@@ -18,6 +18,12 @@ export interface ProviderConfiguration {
18
18
  cookies: string;
19
19
  }
20
20
  export interface ServiceProviderExtension {
21
+ /**
22
+ * Retrieves the service based on the provided path.
23
+ *
24
+ * @param path - The path of the service.
25
+ * @returns service.
26
+ */
21
27
  service(path: string): Service;
22
28
  }
23
29
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap-ux/axios-extension",
3
- "version": "1.11.1",
3
+ "version": "1.11.3",
4
4
  "description": "Extension of the Axios module adding convenience methods to interact with SAP systems especially with OData services.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -22,14 +22,14 @@
22
22
  "qs": "6.7.3",
23
23
  "xpath": "0.0.33",
24
24
  "@xmldom/xmldom": "0.8.10",
25
- "@sap-ux/btp-utils": "0.14.0",
26
- "@sap-ux/logger": "0.5.0"
25
+ "@sap-ux/btp-utils": "0.14.2",
26
+ "@sap-ux/logger": "0.5.1"
27
27
  },
28
28
  "devDependencies": {
29
29
  "@types/lodash": "4.14.202",
30
30
  "nock": "13.4.0",
31
31
  "supertest": "6.3.3",
32
- "@sap-ux/project-access": "1.17.2"
32
+ "@sap-ux/project-access": "1.17.5"
33
33
  },
34
34
  "files": [
35
35
  "dist",
@@ -38,7 +38,6 @@
38
38
  "!dist/**/*.map"
39
39
  ],
40
40
  "engines": {
41
- "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
42
41
  "node": ">=18.x"
43
42
  },
44
43
  "scripts": {