@sovity.de/edc-client 7.2.1 → 7.3.0

package/README.md

@@ -24,7 +24,7 @@ You can find our API Wrapper Project
 
 ## How to install
 
-Requires a NodeJS / NPM project.
+Requires global fetch API (provided by Node.js 18+ or browser).
 
 ```shell script
 npm i --save @sovity.de/edc-client
@@ -34,6 +34,8 @@ npm i --save @sovity.de/edc-client
 
 Configure your EDC Client and use endpoints of our API Wrapper Extension:
 
+### Example Using API Key Auth
+
 ```typescript
 const edcClient: EdcClient = buildEdcClient({
     managementApiUrl: 'http://localhost:11002/api/management/v2',
@@ -46,6 +48,21 @@ let kpiData: KpiResult = await edcClient.useCaseApi.getKpis();
 A minimal example project using the typescript API client can be found
 [here](https://github.com/sovity/edc-extensions/tree/main/extensions/wrapper/clients/typescript-client-example).
 
+### Example Using OAuth2 Client Credentials
+
+```typescript
+const edcClient: EdcClient = buildEdcClient({
+    managementApiUrl: 'http://localhost:11002/api/management/v2',
+    clientCredentials: {
+        tokenUrl: 'http://localhost:11002/token',
+        clientId: '{{your-connector}}-app',
+        clientSecret: '...',
+    },
+});
+
+let kpiData: KpiResult = await edcClient.useCaseApi.getKpis();
+```
+
 ## License
 
 Apache License 2.0 - see

package/dist/sovity-edc-client.d.ts

@@ -82,6 +82,15 @@ export declare function buildEdcClient(opts: EdcClientOptions): EdcClient;
 
 export declare function canConsumeForm(consumes: Consume[]): boolean;
 
+/**
+ * Credentials for connecting to the EDC via the OAuth2 "Client Credentials" flow.
+ */
+declare interface ClientCredentials {
+    tokenUrl: string;
+    clientId: string;
+    clientSecret: string;
+}
+
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
@@ -734,6 +743,7 @@ export declare interface EdcClient {
 export declare interface EdcClientOptions {
     managementApiUrl: string;
     managementApiKey?: string;
+    clientCredentials?: ClientCredentials;
     configOverrides?: Partial<ConfigurationParameters>;
 }
 
@@ -1921,43 +1931,35 @@ export declare interface UiAsset {
      */
     temporalCoverageToInclusive?: Date;
     /**
-     * Unhandled Asset Properties (that were strings)
-     * @type {{ [key: string]: string; }}
+     * Contains the entire asset in the JSON-LD format
+     * @type {string}
      * @memberof UiAsset
      */
-    additionalProperties?: {
-        [key: string]: string;
-    };
+    assetJsonLd?: string;
     /**
-     * Unhandled Asset Properties (that were not strings but other JSON values)
-     * @type {{ [key: string]: string; }}
+     * Contains serialized custom properties in the JSON format.
+     * @type {string}
      * @memberof UiAsset
      */
-    additionalJsonProperties?: {
-        [key: string]: string;
-    };
+    customJsonAsString?: string;
     /**
-     * Private Asset Properties (that were strings)
-     * @type {{ [key: string]: string; }}
+     * Contains serialized custom properties in the JSON LD format. Contrary to the customJsonAsString field, this string must represent a JSON LD object and will be affected by JSON LD compaction and expansion. Due to a technical limitation, the properties can't be booleans.
+     * @type {string}
      * @memberof UiAsset
      */
-    privateProperties?: {
-        [key: string]: string;
-    };
+    customJsonLdAsString?: string;
     /**
-     * Private Asset Properties (that were not strings but other JSON values)
-     * @type {{ [key: string]: string; }}
+     * Same as customJsonAsString but the data will be stored in the private properties.
+     * @type {string}
      * @memberof UiAsset
      */
-    privateJsonProperties?: {
-        [key: string]: string;
-    };
+    privateCustomJsonAsString?: string;
     /**
-     * Contains the entire asset in the JSON-LD format
+     * Same as customJsonLdAsString but the data will be stored in the private properties. The same limitations apply.
      * @type {string}
      * @memberof UiAsset
      */
-    assetJsonLd?: string;
+    privateCustomJsonLdAsString?: string;
 }
 
 /**
@@ -2125,37 +2127,29 @@ export declare interface UiAssetCreateRequest {
         [key: string]: string;
     };
     /**
-     * Custom Asset Properties (that are strings)
-     * @type {{ [key: string]: string; }}
+     * Contains serialized custom properties in the JSON format.
+     * @type {string}
      * @memberof UiAssetCreateRequest
      */
-    additionalProperties?: {
-        [key: string]: string;
-    };
+    customJsonAsString?: string;
     /**
-     * Custom Asset Properties (that are not strings but other JSON values)
-     * @type {{ [key: string]: string; }}
+     * Contains serialized custom properties in the JSON LD format. Contrary to the customJsonAsString field, this string must represent a JSON LD object and will be affected by JSON LD compaction and expansion. Due to a technical limitation, the properties can't be booleans.
+     * @type {string}
      * @memberof UiAssetCreateRequest
      */
-    additionalJsonProperties?: {
-        [key: string]: string;
-    };
+    customJsonLdAsString?: string;
     /**
-     * Private Asset Properties (that are strings)
-     * @type {{ [key: string]: string; }}
+     * Same as customJsonAsString but the data will be stored in the private properties.
+     * @type {string}
      * @memberof UiAssetCreateRequest
      */
-    privateProperties?: {
-        [key: string]: string;
-    };
+    privateCustomJsonAsString?: string;
     /**
-     * Private Asset Properties (that are not strings but other JSON values)
-     * @type {{ [key: string]: string; }}
+     * Same as customJsonLdAsString but the data will be stored in the private properties. The same limitations apply.
+     * @type {string}
      * @memberof UiAssetCreateRequest
      */
-    privateJsonProperties?: {
-        [key: string]: string;
-    };
+    privateCustomJsonLdAsString?: string;
 }
 
 export declare function UiAssetCreateRequestFromJSON(json: any): UiAssetCreateRequest;
@@ -2315,37 +2309,29 @@ export declare interface UiAssetEditMetadataRequest {
      */
     temporalCoverageToInclusive?: Date;
     /**
-     * Custom Asset Properties (that are strings)
-     * @type {{ [key: string]: string; }}
+     * Contains serialized custom properties in the JSON format.
+     * @type {string}
      * @memberof UiAssetEditMetadataRequest
      */
-    additionalProperties?: {
-        [key: string]: string;
-    };
+    customJsonAsString?: string;
     /**
-     * Custom Asset Properties (that are not strings but other JSON values)
-     * @type {{ [key: string]: string; }}
+     * Contains serialized custom properties in the JSON LD format. Contrary to the customJsonAsString field, this string must represent a JSON LD object and will be affected by JSON LD compaction and expansion. Due to a technical limitation, the properties can't be booleans.
+     * @type {string}
      * @memberof UiAssetEditMetadataRequest
      */
-    additionalJsonProperties?: {
-        [key: string]: string;
-    };
+    customJsonLdAsString?: string;
     /**
-     * Private Asset Properties (that are strings)
-     * @type {{ [key: string]: string; }}
+     * Same as customJsonAsString but the data will be stored in the private properties.
+     * @type {string}
      * @memberof UiAssetEditMetadataRequest
      */
-    privateProperties?: {
-        [key: string]: string;
-    };
+    privateCustomJsonAsString?: string;
     /**
-     * Private Asset Properties (that are not strings but other JSON values)
-     * @type {{ [key: string]: string; }}
+     * Same as customJsonLdAsString but the data will be stored in the private properties. The same limitations apply.
+     * @type {string}
      * @memberof UiAssetEditMetadataRequest
      */
-    privateJsonProperties?: {
-        [key: string]: string;
-    };
+    privateCustomJsonLdAsString?: string;
 }
 
 export declare function UiAssetEditMetadataRequestFromJSON(json: any): UiAssetEditMetadataRequest;