Skip to content

Commit 93a091d

Browse files
mohamed-Dhiamohamed-Dhia
authoredFeb 17, 2025··
feat: dids controller (#365)
* feat: identity hub participant and participants contollers * fix: review requests * feat: keypairs controller * feat: dids controller * chore: updates * chore: trigger ci * chore: trigger ci * fix: use correct open api spec file name
1 parent fa30247 commit 93a091d

File tree

7 files changed

+289
-5
lines changed

7 files changed

+289
-5
lines changed
 

‎src/controllers/identity-controllers/dids-controller.ts

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import { EdcConnectorClientContext } from "../../context";
2+
import { DIDDocument } from "../../entities/DID";
3+
import { Inner } from "../../inner";
4+
5+
export class DIDsController {
6+
#inner: Inner;
7+
#context?: EdcConnectorClientContext;
8+
static readonly BASE_PATH = "/v1alpha/dids";
9+
10+
constructor(inner: Inner, context?: EdcConnectorClientContext) {
11+
this.#inner = inner;
12+
this.#context = context;
13+
}
14+
15+
async queryAll(
16+
query: { offset?: string; limit?: string } = {},
17+
context?: EdcConnectorClientContext,
18+
) {
19+
const actualContext = context || this.#context!;
20+
21+
return this.#inner.request<DIDDocument[]>(actualContext.identity, {
22+
path: DIDsController.BASE_PATH,
23+
method: "GET",
24+
apiToken: actualContext.apiToken,
25+
query,
26+
});
27+
}
28+
}

‎src/controllers/identity-controllers/participant-controllers/participant-controller.ts

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {
44
ParticipantRoleResponse,
55
} from "../../../entities/participant";
66
import { Inner } from "../../../inner";
7+
import { ParticipantDIDsController } from "./participant-dids-controller";
78
import { ParticipantKeyPairContoller } from "./participant-keypairs-controller";
89

910
export class ParticipantController {
@@ -92,4 +93,12 @@ export class ParticipantController {
9293
this.#context,
9394
);
9495
}
96+
97+
get dids() {
98+
return new ParticipantDIDsController(
99+
this.#inner,
100+
this.participantId,
101+
this.#context,
102+
);
103+
}
95104
}

‎src/controllers/identity-controllers/participant-controllers/participant-dids-controller.ts

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
import { EdcConnectorClientContext } from "../../../context";
2+
import { QuerySpec } from "../../../entities";
3+
import { DIDDocument, DIDService } from "../../../entities/DID";
4+
import { Inner } from "../../../inner";
5+
6+
export class ParticipantDIDsController {
7+
#inner: Inner;
8+
#context?: EdcConnectorClientContext;
9+
static readonly BASE_PATH = "/v1alpha/participants";
10+
11+
constructor(
12+
inner: Inner,
13+
public participantId: string,
14+
context?: EdcConnectorClientContext,
15+
) {
16+
this.#inner = inner;
17+
this.#context = context;
18+
}
19+
20+
publishDID(did: string, context?: EdcConnectorClientContext) {
21+
const actualContext = context || this.#context!;
22+
23+
// NOTE: fix in docs
24+
return this.#inner.request<void>(actualContext.identity, {
25+
path: `${ParticipantDIDsController.BASE_PATH}/${this.participantId}/dids/publish`,
26+
method: "POST",
27+
body: { did },
28+
apiToken: actualContext.apiToken,
29+
});
30+
}
31+
32+
getDIDs(query: QuerySpec, context?: EdcConnectorClientContext) {
33+
const actualContext = context || this.#context!;
34+
35+
return this.#inner.request<DIDDocument[]>(actualContext.identity, {
36+
path: `${ParticipantDIDsController.BASE_PATH}/${this.participantId}/dids/query`,
37+
method: "POST",
38+
body: query,
39+
apiToken: actualContext.apiToken,
40+
});
41+
}
42+
43+
getDIDstate(did: string, context?: EdcConnectorClientContext) {
44+
const actualContext = context || this.#context!;
45+
46+
//NOTE: Check for doc error
47+
return this.#inner.request<string>(actualContext.identity, {
48+
path: `${ParticipantDIDsController.BASE_PATH}/${this.participantId}/dids/state`,
49+
method: "POST",
50+
body: { did },
51+
apiToken: actualContext.apiToken,
52+
});
53+
}
54+
55+
unpublishDID(did: string, context?: EdcConnectorClientContext) {
56+
const actualContext = context || this.#context!;
57+
58+
// NOTE: fix in docs
59+
return this.#inner.request<void>(actualContext.identity, {
60+
path: `${ParticipantDIDsController.BASE_PATH}/${this.participantId}/dids/unpublish`,
61+
method: "POST",
62+
body: { did },
63+
apiToken: actualContext.apiToken,
64+
});
65+
}
66+
67+
addDIDEndpoint(
68+
did: string,
69+
service: DIDService,
70+
autoPublish = false,
71+
context?: EdcConnectorClientContext,
72+
) {
73+
const actualContext = context || this.#context!;
74+
75+
// NOTE: fix in docs
76+
return this.#inner.request<void>(actualContext.identity, {
77+
path: `${ParticipantDIDsController.BASE_PATH}/${this.participantId}/dids/${did}/endpoints`,
78+
method: "POST",
79+
query: {
80+
autoPublish: String(autoPublish),
81+
},
82+
body: service,
83+
apiToken: actualContext.apiToken,
84+
});
85+
}
86+
87+
deleteDIDEndpoint(
88+
did: string,
89+
serviceId?: string, // NOTE: should be mandetory
90+
autoPublish = false,
91+
context?: EdcConnectorClientContext,
92+
) {
93+
const actualContext = context || this.#context!;
94+
95+
const query: Record<string, string> = {
96+
autoPublish: String(autoPublish),
97+
};
98+
99+
if (serviceId) {
100+
query.serviceId = serviceId;
101+
}
102+
103+
// NOTE: fix in docs
104+
return this.#inner.request<void>(actualContext.identity, {
105+
path: `${ParticipantDIDsController.BASE_PATH}/${this.participantId}/dids/${did}/endpoints`,
106+
method: "DELETE",
107+
query,
108+
apiToken: actualContext.apiToken,
109+
});
110+
}
111+
112+
replaceDIDEndpoint(
113+
did: string,
114+
autoPublish = false,
115+
context?: EdcConnectorClientContext,
116+
) {
117+
const actualContext = context || this.#context!;
118+
119+
// NOTE: fix in docs
120+
return this.#inner.request<void>(actualContext.identity, {
121+
path: `${ParticipantDIDsController.BASE_PATH}/${this.participantId}/dids/${did}/endpoints`,
122+
method: "PATCH",
123+
query: {
124+
autoPublish: String(autoPublish),
125+
},
126+
apiToken: actualContext.apiToken,
127+
});
128+
}
129+
}

‎src/entities/DID.ts

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
export interface DIDDocument {
2+
"@context": {
3+
[key: string]: unknown;
4+
}[];
5+
6+
authentication: string[];
7+
id: string;
8+
service: {
9+
id: string;
10+
serviceEndpoint: string;
11+
type: string;
12+
}[];
13+
verificationMethod: {
14+
controller: string;
15+
id: string;
16+
publicKeyJwk: {
17+
[key: string]: unknown;
18+
};
19+
publicKeyMultibase: string;
20+
type: string;
21+
}[];
22+
}
23+
24+
export interface DIDService {
25+
id: string;
26+
serviceEndpoint: string;
27+
type: string;
28+
}

‎src/facades/identity.ts

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { DIDsController } from "../controllers/identity-controllers/dids-controller";
12
import { KeyPairsController } from "../controllers/identity-controllers/keypairs-controller";
23
import { ParticipantController } from "../controllers/identity-controllers/participant-controllers/participant-controller";
34
import { ParticipantsController } from "../controllers/identity-controllers/participants-controller";
@@ -15,4 +16,8 @@ export class IdentityController extends EdcController {
1516
get keyPairs() {
1617
return new KeyPairsController(this.inner, this.context);
1718
}
19+
20+
get DIDs() {
21+
return new DIDsController(this.inner, this.context);
22+
}
1823
}

‎src/inner.ts

+2-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { EdcConnectorClientError, EdcConnectorClientErrorType } from "./error";
22

33
interface InnerRequest {
44
path: string;
5-
method: "DELETE" | "GET" | "POST" | "PUT";
5+
method: "DELETE" | "GET" | "POST" | "PUT" | "PATCH";
66
query?: Record<string, string>;
77
body?: unknown;
88
apiToken?: string;
@@ -28,10 +28,7 @@ export class Inner {
2828
return response.json();
2929
}
3030

31-
async stream(
32-
baseUrl: string,
33-
innerRequest: InnerStream,
34-
): Promise<Response> {
31+
async stream(baseUrl: string, innerRequest: InnerStream): Promise<Response> {
3532
const response = await this.#fetch(baseUrl, innerRequest);
3633

3734
if (response.status === 204 || !response.body) {

‎tests/controllers/identity-tests/dids.test.ts

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
import { GenericContainer, StartedTestContainer } from "testcontainers";
2+
import { EdcConnectorClient } from "../../../src";
3+
import { ParticipantDIDsController } from "../../../src/controllers/identity-controllers/participant-controllers/participant-dids-controller";
4+
import { DIDsController } from "../../../src/controllers/identity-controllers/dids-controller";
5+
6+
describe("DIDs", () => {
7+
let startedContainer: StartedTestContainer;
8+
let DIDs: DIDsController;
9+
let participantDIDs: ParticipantDIDsController;
10+
11+
beforeAll(async () => {
12+
startedContainer = await new GenericContainer("stoplight/prism:5.8.1")
13+
.withCopyFilesToContainer([
14+
{
15+
source: "node_modules/identity-api.yml",
16+
target: "/identity-api.yml",
17+
},
18+
])
19+
.withCommand(["mock", "-h", "0.0.0.0", "/identity-api.yml"])
20+
.withExposedPorts(4010)
21+
.start();
22+
23+
DIDs = new EdcConnectorClient.Builder()
24+
.identityUrl("http://localhost:" + startedContainer.getFirstMappedPort())
25+
.build().identity.DIDs;
26+
27+
participantDIDs = new EdcConnectorClient.Builder()
28+
.identityUrl("http://localhost:" + startedContainer.getFirstMappedPort())
29+
.build()
30+
.identity.participant("1").dids;
31+
});
32+
33+
afterAll(async () => {
34+
await startedContainer.stop();
35+
});
36+
37+
it("should query all DIDs", async () => {
38+
const dids = await DIDs.queryAll();
39+
40+
expect(dids).not.toBeNull();
41+
expect(dids.length).toBeGreaterThan(0);
42+
43+
expect(dids[0]).toHaveProperty("authentication");
44+
expect(dids[0]).toHaveProperty("id");
45+
expect(dids[0]).toHaveProperty("service");
46+
expect(dids[0]).toHaveProperty("verificationMethod");
47+
});
48+
49+
it.skip("should publish DID", () => {
50+
expect(participantDIDs.publishDID("1")).resolves.not.toThrow();
51+
});
52+
53+
it("should get participant DIDs", async () => {
54+
const dids = await participantDIDs.getDIDs({});
55+
56+
expect(dids).not.toBeNull();
57+
expect(dids.length).toBeGreaterThan(0);
58+
59+
expect(dids[0]).toHaveProperty("authentication");
60+
expect(dids[0]).toHaveProperty("id");
61+
expect(dids[0]).toHaveProperty("service");
62+
expect(dids[0]).toHaveProperty("verificationMethod");
63+
});
64+
65+
it.skip("should get participant DID state", async () => {
66+
expect(participantDIDs.getDIDstate("1")).resolves.not.toThrow();
67+
});
68+
69+
it.skip("should unpublish participant DID", async () => {
70+
expect(participantDIDs.unpublishDID("1")).resolves.not.toThrow();
71+
});
72+
73+
it.skip("should add participant DID endpoint", async () => {
74+
expect(
75+
participantDIDs.addDIDEndpoint("1", {
76+
id: "string",
77+
serviceEndpoint: "string",
78+
type: "string",
79+
}),
80+
).resolves.not.toThrow();
81+
});
82+
83+
it.skip("should delete participant DID endpoint", async () => {
84+
expect(
85+
participantDIDs.deleteDIDEndpoint("didID", "serviceID"),
86+
).resolves.not.toThrow();
87+
});
88+
});

0 commit comments

Comments
 (0)
Please sign in to comment.