@sovity.de/edc-client 3.0.1-1681718444756

package/README.md

@@ -0,0 +1,31 @@
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/sovity/edc-extensions">
+    <img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
+  </a>
+
+<h3 align="center">EDC-Connector Extension:<br />API Wrapper &amp; API Client:<br />TypeScript API Client</h3>
+
+  <p align="center">
+    <a href="https://github.com/sovity/edc-extensions/issues/new?template=bug_report.md">Report Bug</a>
+    ·
+    <a href="https://github.com/sovity/edc-extensions/issues/new?template=feature_request.md">Request Feature</a>
+  </p>
+</div>
+
+## About this component
+
+TypeScript Client Library to be imported and used in arbitrary applications like frontends or nodejs projects.
+
+## How to install
+
+See `@sovity/edc-client` on [npm.pkg.github.com](https://github.com/sovity/edc-extensions/pkgs/npm/edc-client).
+
+## License
+
+Apache License 2.0 - see [LICENSE](../../LICENSE)
+
+## Contact
+
+sovity GmbH - contact@sovity.de

package/dist/EdcClient.d.ts

@@ -0,0 +1,8 @@
+import { ExampleApi, UseCaseApi } from "./generated";
+/**
+ * API Client for our sovity EDC
+ */
+export interface EdcClient {
+    exampleApi: ExampleApi;
+    useCaseApi: UseCaseApi;
+}

package/dist/EdcClientOptions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Options for instantiating an EDC API Client
+ */
+export interface EdcClientOptions {
+    managementApiUrl: string;
+    managementApiKey?: string;
+}

package/dist/buildEdcClient.d.ts

@@ -0,0 +1,10 @@
+import { EdcClientOptions } from "./EdcClientOptions";
+import { ExampleApi, UseCaseApi } from "./generated";
+/**
+ * Configure & Build new EDC Client
+ * @param opts opts
+ */
+export declare function buildEdcClient(opts: EdcClientOptions): {
+    exampleApi: ExampleApi;
+    useCaseApi: UseCaseApi;
+};

package/dist/generated/apis/ExampleApi.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ExampleQuery, ExampleResult } from '../models';
+export interface ExampleEndpointRequest {
+    exampleQuery?: ExampleQuery;
+}
+/**
+ *
+ */
+export declare class ExampleApi extends runtime.BaseAPI {
+    /**
+     * Dummy endpoint that showcases how to document with our OpenAPI Code Generation.
+     */
+    exampleEndpointRaw(requestParameters: ExampleEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExampleResult>>;
+    /**
+     * Dummy endpoint that showcases how to document with our OpenAPI Code Generation.
+     */
+    exampleEndpoint(requestParameters?: ExampleEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExampleResult>;
+}

package/dist/generated/apis/UIApi.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ContractAgreementPage } from '../models';
+/**
+ *
+ */
+export declare class UIApi extends runtime.BaseAPI {
+    /**
+     * Collect all data for Contract Agreement Page
+     */
+    contractAgreementEndpointRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContractAgreementPage>>;
+    /**
+     * Collect all data for Contract Agreement Page
+     */
+    contractAgreementEndpoint(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContractAgreementPage>;
+}

package/dist/generated/apis/UseCaseApi.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { KpiResult } from '../models';
+/**
+ *
+ */
+export declare class UseCaseApi extends runtime.BaseAPI {
+    /**
+     * List available functions in policies, prohibitions and obligations.
+     */
+    getSupportedFunctionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * List available functions in policies, prohibitions and obligations.
+     */
+    getSupportedFunctions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Basic KPIs about the running EDC Connector.
+     */
+    kpiEndpointRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KpiResult>>;
+    /**
+     * Basic KPIs about the running EDC Connector.
+     */
+    kpiEndpoint(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KpiResult>;
+}

package/dist/generated/apis/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ExampleApi';
+export * from './UIApi';
+export * from './UseCaseApi';

package/dist/generated/index.d.ts

@@ -0,0 +1,3 @@
+export * from './runtime';
+export * from './apis';
+export * from './models';

package/dist/generated/models/Action.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Constraint } from './Constraint';
+/**
+ *
+ * @export
+ * @interface Action
+ */
+export interface Action {
+    /**
+     *
+     * @type {string}
+     * @memberof Action
+     */
+    type?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Action
+     */
+    includedIn?: string;
+    /**
+     *
+     * @type {Constraint}
+     * @memberof Action
+     */
+    constraint?: Constraint;
+}
+/**
+ * Check if a given object implements the Action interface.
+ */
+export declare function instanceOfAction(value: object): boolean;
+export declare function ActionFromJSON(json: any): Action;
+export declare function ActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Action;
+export declare function ActionToJSON(value?: Action | null): any;

package/dist/generated/models/AssetDto.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * AssetDto
+ * @export
+ * @interface AssetDto
+ */
+export interface AssetDto {
+    /**
+     * ID of asset
+     * @type {string}
+     * @memberof AssetDto
+     */
+    id?: string;
+    /**
+     * Asset properties
+     * @type {{ [key: string]: string; }}
+     * @memberof AssetDto
+     */
+    properties?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Check if a given object implements the AssetDto interface.
+ */
+export declare function instanceOfAssetDto(value: object): boolean;
+export declare function AssetDtoFromJSON(json: any): AssetDto;
+export declare function AssetDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssetDto;
+export declare function AssetDtoToJSON(value?: AssetDto | null): any;

package/dist/generated/models/Constraint.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Constraint
+ */
+export interface Constraint {
+    /**
+     *
+     * @type {string}
+     * @memberof Constraint
+     */
+    edctype: string;
+}
+/**
+ * Check if a given object implements the Constraint interface.
+ */
+export declare function instanceOfConstraint(value: object): boolean;
+export declare function ConstraintFromJSON(json: any): Constraint;
+export declare function ConstraintFromJSONTyped(json: any, ignoreDiscriminator: boolean): Constraint;
+export declare function ConstraintToJSON(value?: Constraint | null): any;

package/dist/generated/models/ContractAgreementDto.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AssetDto } from './AssetDto';
+import type { ContractNegotiationDto } from './ContractNegotiationDto';
+import type { Policy } from './Policy';
+import type { TransferprocessDto } from './TransferprocessDto';
+/**
+ * status-defining Contract-Agreements
+ * @export
+ * @interface ContractAgreementDto
+ */
+export interface ContractAgreementDto {
+    /**
+     * Contract-Agreement Dto
+     * @type {string}
+     * @memberof ContractAgreementDto
+     */
+    id?: string;
+    /**
+     *
+     * @type {AssetDto}
+     * @memberof ContractAgreementDto
+     */
+    asset?: AssetDto;
+    /**
+     *
+     * @type {Policy}
+     * @memberof ContractAgreementDto
+     */
+    policy?: Policy;
+    /**
+     * EDC Contract-Agreement contract negotiations
+     * @type {Array<ContractNegotiationDto>}
+     * @memberof ContractAgreementDto
+     */
+    contractNegotiations?: Array<ContractNegotiationDto>;
+    /**
+     * EDC Contract-Agreement transfer processes
+     * @type {Array<TransferprocessDto>}
+     * @memberof ContractAgreementDto
+     */
+    transferProcesses?: Array<TransferprocessDto>;
+}
+/**
+ * Check if a given object implements the ContractAgreementDto interface.
+ */
+export declare function instanceOfContractAgreementDto(value: object): boolean;
+export declare function ContractAgreementDtoFromJSON(json: any): ContractAgreementDto;
+export declare function ContractAgreementDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractAgreementDto;
+export declare function ContractAgreementDtoToJSON(value?: ContractAgreementDto | null): any;

package/dist/generated/models/ContractAgreementPage.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ContractAgreementDto } from './ContractAgreementDto';
+/**
+ * All data required for our UI's Contract Agreement Page.
+ * @export
+ * @interface ContractAgreementPage
+ */
+export interface ContractAgreementPage {
+    /**
+     * EDC Contract-Agreements
+     * @type {Array<ContractAgreementDto>}
+     * @memberof ContractAgreementPage
+     */
+    contractAgreements?: Array<ContractAgreementDto>;
+}
+/**
+ * Check if a given object implements the ContractAgreementPage interface.
+ */
+export declare function instanceOfContractAgreementPage(value: object): boolean;
+export declare function ContractAgreementPageFromJSON(json: any): ContractAgreementPage;
+export declare function ContractAgreementPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractAgreementPage;
+export declare function ContractAgreementPageToJSON(value?: ContractAgreementPage | null): any;

package/dist/generated/models/ContractNegotiationDto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * ContractNegotiationDto
+ * @export
+ * @interface ContractNegotiationDto
+ */
+export interface ContractNegotiationDto {
+    /**
+     * ID of contract negotiation
+     * @type {string}
+     * @memberof ContractNegotiationDto
+     */
+    id?: string;
+}
+/**
+ * Check if a given object implements the ContractNegotiationDto interface.
+ */
+export declare function instanceOfContractNegotiationDto(value: object): boolean;
+export declare function ContractNegotiationDtoFromJSON(json: any): ContractNegotiationDto;
+export declare function ContractNegotiationDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractNegotiationDto;
+export declare function ContractNegotiationDtoToJSON(value?: ContractNegotiationDto | null): any;

package/dist/generated/models/Duty.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Action } from './Action';
+import type { Constraint } from './Constraint';
+import type { Permission } from './Permission';
+/**
+ *
+ * @export
+ * @interface Duty
+ */
+export interface Duty {
+    /**
+     *
+     * @type {string}
+     * @memberof Duty
+     */
+    uid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Duty
+     */
+    target?: string;
+    /**
+     *
+     * @type {Action}
+     * @memberof Duty
+     */
+    action?: Action;
+    /**
+     *
+     * @type {string}
+     * @memberof Duty
+     */
+    assignee?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Duty
+     */
+    assigner?: string;
+    /**
+     *
+     * @type {Array<Constraint>}
+     * @memberof Duty
+     */
+    constraints?: Array<Constraint>;
+    /**
+     *
+     * @type {Permission}
+     * @memberof Duty
+     */
+    parentPermission?: Permission;
+    /**
+     *
+     * @type {Duty}
+     * @memberof Duty
+     */
+    consequence?: Duty;
+}
+/**
+ * Check if a given object implements the Duty interface.
+ */
+export declare function instanceOfDuty(value: object): boolean;
+export declare function DutyFromJSON(json: any): Duty;
+export declare function DutyFromJSONTyped(json: any, ignoreDiscriminator: boolean): Duty;
+export declare function DutyToJSON(value?: Duty | null): any;

package/dist/generated/models/ExampleItem.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Example nested object.
+ * @export
+ * @interface ExampleItem
+ */
+export interface ExampleItem {
+    /**
+     *
+     * @type {string}
+     * @memberof ExampleItem
+     */
+    name?: string;
+}
+/**
+ * Check if a given object implements the ExampleItem interface.
+ */
+export declare function instanceOfExampleItem(value: object): boolean;
+export declare function ExampleItemFromJSON(json: any): ExampleItem;
+export declare function ExampleItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExampleItem;
+export declare function ExampleItemToJSON(value?: ExampleItem | null): any;

package/dist/generated/models/ExampleQuery.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * This is the query of the example endpoint.
+ * @export
+ * @interface ExampleQuery
+ */
+export interface ExampleQuery {
+    /**
+     *
+     * @type {string}
+     * @memberof ExampleQuery
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ExampleQuery
+     */
+    myNestedList: Array<string>;
+}
+/**
+ * Check if a given object implements the ExampleQuery interface.
+ */
+export declare function instanceOfExampleQuery(value: object): boolean;
+export declare function ExampleQueryFromJSON(json: any): ExampleQuery;
+export declare function ExampleQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExampleQuery;
+export declare function ExampleQueryToJSON(value?: ExampleQuery | null): any;

package/dist/generated/models/ExampleResult.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ExampleItem } from './ExampleItem';
+/**
+ * This is the result of the example endpoint.
+ * @export
+ * @interface ExampleResult
+ */
+export interface ExampleResult {
+    /**
+     * Some name field
+     * @type {string}
+     * @memberof ExampleResult
+     */
+    name: string;
+    /**
+     *
+     * @type {ExampleItem}
+     * @memberof ExampleResult
+     */
+    myNestedItem: ExampleItem;
+    /**
+     * Some array of nested objects
+     * @type {Array<ExampleItem>}
+     * @memberof ExampleResult
+     */
+    myNestedList: Array<ExampleItem>;
+    /**
+     * Configured IDS Endpoint
+     * @type {string}
+     * @memberof ExampleResult
+     */
+    idsEndpoint: string;
+    /**
+     * Example enum to test enum documentation.
+     * @type {string}
+     * @memberof ExampleResult
+     */
+    myEnum?: ExampleResultMyEnumEnum;
+}
+/**
+ * @export
+ */
+export declare const ExampleResultMyEnumEnum: {
+    readonly First: "FIRST";
+    readonly Second: "SECOND";
+};
+export type ExampleResultMyEnumEnum = typeof ExampleResultMyEnumEnum[keyof typeof ExampleResultMyEnumEnum];
+/**
+ * Check if a given object implements the ExampleResult interface.
+ */
+export declare function instanceOfExampleResult(value: object): boolean;
+export declare function ExampleResultFromJSON(json: any): ExampleResult;
+export declare function ExampleResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExampleResult;
+export declare function ExampleResultToJSON(value?: ExampleResult | null): any;

package/dist/generated/models/KpiResult.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Wrapper KPI API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { TransferProcessStatesDto } from './TransferProcessStatesDto';
+/**
+ * EDC-status-defining KPIs
+ * @export
+ * @interface KpiResult
+ */
+export interface KpiResult {
+    /**
+     * Counts of assets
+     * @type {number}
+     * @memberof KpiResult
+     */
+    assetsCount: number;
+    /**
+     * Counts of policies
+     * @type {number}
+     * @memberof KpiResult
+     */
+    policiesCount: number;
+    /**
+     * Counts of contract definitions
+     * @type {number}
+     * @memberof KpiResult
+     */
+    contractDefinitionsCount: number;
+    /**
+     * Counts of contract agreements
+     * @type {number}
+     * @memberof KpiResult
+     */
+    contractAgreementsCount: number;
+    /**
+     *
+     * @type {TransferProcessStatesDto}
+     * @memberof KpiResult
+     */
+    transferProcessDto: TransferProcessStatesDto;
+}
+/**
+ * Check if a given object implements the KpiResult interface.
+ */
+export declare function instanceOfKpiResult(value: object): boolean;
+export declare function KpiResultFromJSON(json: any): KpiResult;
+export declare function KpiResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): KpiResult;
+export declare function KpiResultToJSON(value?: KpiResult | null): any;