@nevermined-io/core-kit 0.0.58-rc0 → 0.0.58

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.
Files changed (60) hide show
  1. package/dist/artifacts/generated.d.ts +9775 -3866
  2. package/dist/artifacts/generated.d.ts.map +1 -1
  3. package/dist/artifacts/generated.js +7428 -3943
  4. package/dist/contracts/AssetRegistry.d.ts +47 -15
  5. package/dist/contracts/AssetRegistry.d.ts.map +1 -1
  6. package/dist/contracts/AssetRegistry.js +65 -26
  7. package/dist/contracts/ContractBase.d.ts +3 -0
  8. package/dist/contracts/ContractBase.d.ts.map +1 -1
  9. package/dist/contracts/ContractBase.js +80 -7
  10. package/dist/contracts/ContractsApi.d.ts +7 -0
  11. package/dist/contracts/ContractsApi.d.ts.map +1 -1
  12. package/dist/contracts/ContractsApi.js +7 -0
  13. package/dist/contracts/FiatPaymentTemplate.d.ts +1 -1
  14. package/dist/contracts/FiatPaymentTemplate.d.ts.map +1 -1
  15. package/dist/contracts/FiatPaymentTemplate.js +2 -2
  16. package/dist/contracts/FiatSettlementCondition.d.ts +1 -1
  17. package/dist/contracts/FiatSettlementCondition.d.ts.map +1 -1
  18. package/dist/contracts/FiatSettlementCondition.js +2 -2
  19. package/dist/contracts/FixedPaymentTemplate.d.ts +2 -2
  20. package/dist/contracts/FixedPaymentTemplate.d.ts.map +1 -1
  21. package/dist/contracts/FixedPaymentTemplate.js +5 -5
  22. package/dist/contracts/NFT1155Base.d.ts +9 -0
  23. package/dist/contracts/NFT1155Base.d.ts.map +1 -1
  24. package/dist/contracts/NFT1155Base.js +3 -0
  25. package/dist/contracts/PayAsYouGoTemplate.d.ts +13 -0
  26. package/dist/contracts/PayAsYouGoTemplate.d.ts.map +1 -0
  27. package/dist/contracts/PayAsYouGoTemplate.js +59 -0
  28. package/dist/errors/NeverminedErrors.d.ts +4 -1
  29. package/dist/errors/NeverminedErrors.d.ts.map +1 -1
  30. package/dist/errors/NeverminedErrors.js +7 -2
  31. package/dist/models/AgentAccessToken.d.ts +1 -1
  32. package/dist/models/AgentAccessToken.d.ts.map +1 -1
  33. package/dist/models/AgentAccessToken.js +1 -1
  34. package/dist/nevermined/api/PaymentsApi.d.ts +6 -4
  35. package/dist/nevermined/api/PaymentsApi.d.ts.map +1 -1
  36. package/dist/nevermined/api/PaymentsApi.js +41 -16
  37. package/dist/nevermined/api/ServicesApi.d.ts +0 -5
  38. package/dist/nevermined/api/ServicesApi.d.ts.map +1 -1
  39. package/dist/nevermined/api/ServicesApi.js +0 -6
  40. package/dist/nevermined/index.d.ts +0 -1
  41. package/dist/nevermined/index.d.ts.map +1 -1
  42. package/dist/nevermined/index.js +0 -1
  43. package/dist/nevermined/utils/BlockchainViemUtils.d.ts +1 -8
  44. package/dist/nevermined/utils/BlockchainViemUtils.d.ts.map +1 -1
  45. package/dist/nevermined/utils/BlockchainViemUtils.js +1 -11
  46. package/dist/nevermined/utils/ZeroDevPolicies.d.ts.map +1 -1
  47. package/dist/nevermined/utils/ZeroDevPolicies.js +20 -16
  48. package/dist/services/index.d.ts +0 -1
  49. package/dist/services/index.d.ts.map +1 -1
  50. package/dist/services/index.js +0 -1
  51. package/dist/utils/ConversionTypeHelpers.d.ts +1 -4
  52. package/dist/utils/ConversionTypeHelpers.d.ts.map +1 -1
  53. package/dist/utils/ConversionTypeHelpers.js +7 -8
  54. package/package.json +1 -1
  55. package/dist/nevermined/DID.d.ts +0 -45
  56. package/dist/nevermined/DID.d.ts.map +0 -1
  57. package/dist/nevermined/DID.js +0 -90
  58. package/dist/services/MetadataService.d.ts +0 -53
  59. package/dist/services/MetadataService.d.ts.map +0 -1
  60. package/dist/services/MetadataService.js +0 -155
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nevermined-io/core-kit",
3
- "version": "0.0.58-rc0",
3
+ "version": "0.0.58",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.js",
@@ -1,45 +0,0 @@
1
- /**
2
- * Decentralized ID.
3
- */
4
- export declare class DID {
5
- /**
6
- * Parses a DID from a string.
7
- * @param didString - DID in string format or DID instance.
8
- * The didString can be in did:nv: format or 0x: format.
9
- * @returns {@link DID}
10
- */
11
- static parse(didString: string | DID): DID;
12
- /**
13
- * Returns a new DID.
14
- * @returns {@link DID}
15
- */
16
- static generate(): DID;
17
- static parseBigInt(value: any, radix?: number): any;
18
- /**
19
- * Returns a new DID from a base36 encoded string.
20
- * @param encoded - Base36 encoded string.
21
- * @returns {@link DID}
22
- */
23
- static fromEncoded(encoded: string): DID;
24
- /**
25
- * Generates an encoded string in base 36 from a DID.
26
- * @returns A base36 encoded string.
27
- */
28
- getEncoded(): string;
29
- /**
30
- * Short ID.
31
- */
32
- private id;
33
- private constructor();
34
- /**
35
- * Returns the DID (i.e did:nv:...)
36
- * @returns A string with the prefixed id.
37
- */
38
- getDid(): string;
39
- /**
40
- * Returns the Short ID.
41
- * @returns A string of the _id_ without the prefix.
42
- */
43
- getId(): string;
44
- }
45
- //# sourceMappingURL=DID.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"DID.d.ts","sourceRoot":"","sources":["../../src/nevermined/DID.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,GAAG;IACd;;;;;OAKG;WACW,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,GAAG,GAAG;IA0BjD;;;OAGG;WACW,QAAQ,IAAI,GAAG;WAIf,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,SAAK;IAYhD;;;;OAIG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG;IAM/C;;;OAGG;IACI,UAAU,IAAI,MAAM;IAI3B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAQ;IAElB,OAAO;IAIP;;;OAGG;IACI,MAAM,IAAI,MAAM;IAIvB;;;OAGG;IACI,KAAK,IAAI,MAAM;CAGvB"}
@@ -1,90 +0,0 @@
1
- import { generateId } from '../utils/index.js';
2
- const DID_PREFIX = 'did:nv:';
3
- /**
4
- * Decentralized ID.
5
- */
6
- export class DID {
7
- /**
8
- * Parses a DID from a string.
9
- * @param didString - DID in string format or DID instance.
10
- * The didString can be in did:nv: format or 0x: format.
11
- * @returns {@link DID}
12
- */
13
- static parse(didString) {
14
- if (didString instanceof DID) {
15
- didString = didString.getDid();
16
- }
17
- let did = null;
18
- const did0xMatch = didString.match(/^0x([a-f0-9]{64})$/i);
19
- if (did0xMatch) {
20
- did = new DID(did0xMatch[1]);
21
- }
22
- else {
23
- const didMatch = didString.match(/^did:nv:([a-f0-9]{64})$/i);
24
- if (didMatch) {
25
- did = new DID(didMatch[1]);
26
- }
27
- }
28
- if (!did) {
29
- throw new Error(`Parsing DID failed, ${didString}`);
30
- }
31
- return did;
32
- }
33
- /**
34
- * Returns a new DID.
35
- * @returns {@link DID}
36
- */
37
- static generate() {
38
- return new DID(generateId());
39
- }
40
- static parseBigInt(value, radix = 36) {
41
- // value: string
42
- const size = 10;
43
- const factor = BigInt(radix ** size);
44
- let i = value.length % size || size;
45
- const parts = [value.slice(0, i)];
46
- while (i < value.length)
47
- parts.push(value.slice(i, (i += size)));
48
- return parts.reduce((r, v) => r * factor + BigInt(parseInt(v, radix)), BigInt(0));
49
- }
50
- /**
51
- * Returns a new DID from a base36 encoded string.
52
- * @param encoded - Base36 encoded string.
53
- * @returns {@link DID}
54
- */
55
- static fromEncoded(encoded) {
56
- const decoded = this.parseBigInt(encoded).toString(16);
57
- if (decoded.length !== 64)
58
- return new DID(`0${decoded}`);
59
- else
60
- return new DID(decoded);
61
- }
62
- /**
63
- * Generates an encoded string in base 36 from a DID.
64
- * @returns A base36 encoded string.
65
- */
66
- getEncoded() {
67
- return BigInt(`0x${this.id}`).toString(36);
68
- }
69
- /**
70
- * Short ID.
71
- */
72
- id;
73
- constructor(id) {
74
- this.id = id;
75
- }
76
- /**
77
- * Returns the DID (i.e did:nv:...)
78
- * @returns A string with the prefixed id.
79
- */
80
- getDid() {
81
- return `${DID_PREFIX}${this.id}`;
82
- }
83
- /**
84
- * Returns the Short ID.
85
- * @returns A string of the _id_ without the prefix.
86
- */
87
- getId() {
88
- return this.id;
89
- }
90
- }
@@ -1,53 +0,0 @@
1
- import { DDO, SearchQuery } from '@nvm-monorepo/commons';
2
- import { DID } from '../nevermined/DID.js';
3
- import { Api } from './Api.js';
4
- export declare const apiPath = "/api/v1/protocol/agents";
5
- export declare const servicePath = "/api/v1/metadata/assets/service";
6
- export interface QueryResult {
7
- results: DDO[];
8
- page: number;
9
- totalPages: number;
10
- totalResults: {
11
- [jsonPath: string]: any;
12
- };
13
- }
14
- export interface AuthToken {
15
- access_token: string;
16
- }
17
- /**
18
- * Provides a interface with Metadata.
19
- * Metadata provides an off-chain database store for metadata about data assets.
20
- */
21
- export declare class MetadataService extends Api {
22
- getVersionInfo(): Promise<any>;
23
- getAccessUrl(accessToken: any, payload: any): Promise<string>;
24
- /**
25
- * Search over the DDOs using a query.
26
- * @param query - Query to filter the DDOs.
27
- * @returns A list of {@link QueryResult}s.
28
- */
29
- queryMetadata(query: SearchQuery): Promise<QueryResult>;
30
- /**
31
- * Update a DDO in Metadata.
32
- * @param ddo - DDO to be stored.assignable
33
- * @returns Final DDO.
34
- */
35
- updateDDO(did: DID | string, ddo: DDO, backendAuthToken: string): Promise<DDO>;
36
- /**
37
- * Stores a DDO in Metadata.
38
- * @param ddo - DDO to be stored.
39
- * @returns Final DDO.
40
- */
41
- storeDDO(ddo: DDO, backendAuthToken: string): Promise<DDO>;
42
- /**
43
- * Retrieves a DDO by DID.
44
- * @param did - DID of the asset.
45
- * @param metadataServiceEndpoint - Metadata service endpoint.
46
- * @returns DDO of the asset.
47
- */
48
- retrieveDDO(did?: DID | string, metadataServiceEndpoint?: string): Promise<DDO>;
49
- delete(did: DID | string, backendAuthToken: string): Promise<import("node-fetch").Response>;
50
- retrieveDDOByUrl(metadataServiceEndpoint?: string): Promise<DDO>;
51
- getServiceEndpoint(did: DID): string;
52
- }
53
- //# sourceMappingURL=MetadataService.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"MetadataService.d.ts","sourceRoot":"","sources":["../../src/services/MetadataService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,eAAO,MAAM,OAAO,4BAA4B,CAAA;AAChD,eAAO,MAAM,WAAW,oCAAoC,CAAA;AAE5D,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,GAAG,EAAE,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAA;CAC1C;AAED,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,GAAG;IACzB,cAAc;IAId,YAAY,CAAC,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAuB1E;;;;OAIG;IACU,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IA2BpE;;;;OAIG;IACU,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA0B3F;;;;OAIG;IACU,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA0BvE;;;;;OAKG;IACU,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM,EAAE,uBAAuB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAgC/E,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,gBAAgB,EAAE,MAAM;IAWlD,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,MAAM;IAIvD,kBAAkB,CAAC,GAAG,EAAE,GAAG;CAGnC"}
@@ -1,155 +0,0 @@
1
- import { DDO } from '@nvm-monorepo/commons';
2
- import { ApiError, HttpError } from '../errors/NeverminedErrors.js';
3
- import { DID } from '../nevermined/DID.js';
4
- import { Api } from './Api.js';
5
- export const apiPath = '/api/v1/protocol/agents';
6
- export const servicePath = '/api/v1/metadata/assets/service';
7
- /**
8
- * Provides a interface with Metadata.
9
- * Metadata provides an off-chain database store for metadata about data assets.
10
- */
11
- export class MetadataService extends Api {
12
- async getVersionInfo() {
13
- return (await this.nevermined.utils.fetch.get(this.url)).json();
14
- }
15
- async getAccessUrl(accessToken, payload) {
16
- const accessUrl = await this.nevermined.utils.fetch
17
- .post(`${accessToken.service_endpoint}/${accessToken.resource_id}`, payload)
18
- .then((response) => {
19
- if (response.ok) {
20
- return response.text();
21
- }
22
- throw new HttpError(`getAccessUrl Failed - ${response.statusText} ${response.url}`, response.status);
23
- })
24
- .then((consumptionUrl) => {
25
- this.logger.info('Success accessing consume endpoint: ', consumptionUrl);
26
- return consumptionUrl;
27
- })
28
- .catch((error) => {
29
- throw new ApiError(error);
30
- });
31
- return accessUrl;
32
- }
33
- /**
34
- * Search over the DDOs using a query.
35
- * @param query - Query to filter the DDOs.
36
- * @returns A list of {@link QueryResult}s.
37
- */
38
- async queryMetadata(query) {
39
- const result = await this.nevermined.utils.fetch
40
- .post(`${this.url}${apiPath}/query`, JSON.stringify(query))
41
- .then((response) => {
42
- if (response.ok) {
43
- return response.json();
44
- }
45
- throw new HttpError(`queryMetadata failed - ${response.statusText} ${response.url}`, response.status);
46
- })
47
- .then((results) => {
48
- return {
49
- results: (results.results || []).map((ddo) => new DDO(ddo)),
50
- page: results.page,
51
- totalPages: results.total_pages,
52
- totalResults: results.total_results,
53
- };
54
- })
55
- .catch((error) => {
56
- throw new ApiError(error);
57
- });
58
- return result;
59
- }
60
- /**
61
- * Update a DDO in Metadata.
62
- * @param ddo - DDO to be stored.assignable
63
- * @returns Final DDO.
64
- */
65
- async updateDDO(did, ddo, backendAuthToken) {
66
- const fullUrl = `${this.url}${apiPath}/${DID.parse(did).getDid()}`;
67
- const result = await this.nevermined.utils.fetch
68
- .put(fullUrl, DDO.serialize(ddo), {
69
- Authorization: `Bearer ${backendAuthToken}`,
70
- })
71
- .then((response) => {
72
- if (response.ok) {
73
- return response.json();
74
- }
75
- throw new HttpError(`updateDDO failed - ${response.statusText} ${response.url}`, response.status);
76
- })
77
- .then((response) => {
78
- return new DDO(response);
79
- })
80
- .catch((error) => {
81
- throw new ApiError(error);
82
- });
83
- return result;
84
- }
85
- /**
86
- * Stores a DDO in Metadata.
87
- * @param ddo - DDO to be stored.
88
- * @returns Final DDO.
89
- */
90
- async storeDDO(ddo, backendAuthToken) {
91
- const fullUrl = `${this.url}${apiPath}`;
92
- const result = await this.nevermined.utils.fetch
93
- .post(fullUrl, DDO.serialize(ddo), {
94
- Authorization: `Bearer ${backendAuthToken}`,
95
- })
96
- .then((response) => {
97
- if (response.ok) {
98
- return response.json();
99
- }
100
- throw new HttpError(`storeDDO failed - ${response.statusText} ${response.url}`, response.status);
101
- })
102
- .then((response) => {
103
- return new DDO(response);
104
- })
105
- .catch((error) => {
106
- throw new ApiError(error);
107
- });
108
- return result;
109
- }
110
- /**
111
- * Retrieves a DDO by DID.
112
- * @param did - DID of the asset.
113
- * @param metadataServiceEndpoint - Metadata service endpoint.
114
- * @returns DDO of the asset.
115
- */
116
- async retrieveDDO(did, metadataServiceEndpoint) {
117
- let fullUrl;
118
- if (did) {
119
- fullUrl = metadataServiceEndpoint || `${this.url}${apiPath}/${DID.parse(did).getDid()}`;
120
- }
121
- else if (metadataServiceEndpoint) {
122
- fullUrl = metadataServiceEndpoint;
123
- }
124
- else {
125
- throw new ApiError(`A DID or metadataServiceEndpoint needs to be specified`);
126
- }
127
- const result = await this.nevermined.utils.fetch
128
- .get(fullUrl)
129
- .then((response) => {
130
- if (response.ok) {
131
- return response.json();
132
- }
133
- throw new HttpError(`retrieveDDO failed - ${response.statusText} ${response.url}`, response.status);
134
- })
135
- .then((response) => {
136
- return new DDO(response);
137
- })
138
- .catch((error) => {
139
- throw new ApiError(error);
140
- });
141
- return result;
142
- }
143
- async delete(did, backendAuthToken) {
144
- const result = await this.nevermined.utils.fetch.delete(`${this.url}${apiPath}/${DID.parse(did).getDid()}`, undefined, {
145
- Authorization: `Bearer ${backendAuthToken}`,
146
- });
147
- return result;
148
- }
149
- async retrieveDDOByUrl(metadataServiceEndpoint) {
150
- return this.retrieveDDO(undefined, metadataServiceEndpoint);
151
- }
152
- getServiceEndpoint(did) {
153
- return `${this.url}${apiPath}/did:nv:${did.getId()}`;
154
- }
155
- }