Skip to content

Commit a107cae

Browse files
bitbeckersbitbeckers
committed
feat(sds): implement sds apis and tests
1 parent cb3268d commit a107cae

13 files changed

+609
-169
lines changed

‎packages/sdk-core/README.md‎

Lines changed: 459 additions & 79 deletions
Large diffs are not rendered by default.

‎packages/sdk-core/src/repository/BlobOperationsImpl.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export class BlobOperationsImpl implements BlobOperations {
122122
}
123123

124124
return {
125-
ref: result.data.blob.ref,
125+
ref: { $link: result.data.blob.ref.toString() },
126126
mimeType: result.data.blob.mimeType,
127127
size: result.data.blob.size,
128128
};

‎packages/sdk-core/src/repository/CollaboratorOperationsImpl.ts‎

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,10 @@ export class CollaboratorOperationsImpl implements CollaboratorOperations {
209209
/**
210210
* Lists all collaborators on the repository.
211211
*
212-
* @returns Promise resolving to array of access grants
212+
* @param params - Optional pagination parameters
213+
* @param params.limit - Maximum number of results (1-100, default 50)
214+
* @param params.cursor - Pagination cursor from previous response
215+
* @returns Promise resolving to collaborators and optional cursor
213216
* @throws {@link NetworkError} if the list operation fails
214217
*
215218
* @remarks
@@ -218,23 +221,37 @@ export class CollaboratorOperationsImpl implements CollaboratorOperations {
218221
*
219222
* @example
220223
* ```typescript
221-
* const collaborators = await repo.collaborators.list();
224+
* // Get first page
225+
* const page1 = await repo.collaborators.list({ limit: 10 });
226+
* console.log(`Found ${page1.collaborators.length} collaborators`);
227+
*
228+
* // Get next page if available
229+
* if (page1.cursor) {
230+
* const page2 = await repo.collaborators.list({ limit: 10, cursor: page1.cursor });
231+
* }
222232
*
223233
* // Filter active collaborators
224-
* const active = collaborators.filter(c => !c.revokedAt);
225-
*
226-
* // Group by role
227-
* const byRole = {
228-
* owners: active.filter(c => c.role === "owner"),
229-
* admins: active.filter(c => c.role === "admin"),
230-
* editors: active.filter(c => c.role === "editor"),
231-
* viewers: active.filter(c => c.role === "viewer"),
232-
* };
234+
* const active = page1.collaborators.filter(c => !c.revokedAt);
233235
* ```
234236
*/
235-
async list(): Promise<RepositoryAccessGrant[]> {
237+
async list(params?: { limit?: number; cursor?: string }): Promise<{
238+
collaborators: RepositoryAccessGrant[];
239+
cursor?: string;
240+
}> {
241+
const queryParams = new URLSearchParams({
242+
repo: this.repoDid,
243+
});
244+
245+
if (params?.limit !== undefined) {
246+
queryParams.set("limit", params.limit.toString());
247+
}
248+
249+
if (params?.cursor) {
250+
queryParams.set("cursor", params.cursor);
251+
}
252+
236253
const response = await this.session.fetchHandler(
237-
`${this.serverUrl}/xrpc/com.sds.repo.listCollaborators?repo=${encodeURIComponent(this.repoDid)}`,
254+
`${this.serverUrl}/xrpc/com.sds.repo.listCollaborators?${queryParams.toString()}`,
238255
{ method: "GET" },
239256
);
240257

@@ -243,7 +260,7 @@ export class CollaboratorOperationsImpl implements CollaboratorOperations {
243260
}
244261

245262
const data = await response.json();
246-
return (data.collaborators || []).map(
263+
const collaborators = (data.collaborators || []).map(
247264
(c: {
248265
userDid: string;
249266
permissions: string[]; // SDS API returns string array
@@ -262,6 +279,11 @@ export class CollaboratorOperationsImpl implements CollaboratorOperations {
262279
};
263280
},
264281
);
282+
283+
return {
284+
collaborators,
285+
cursor: data.cursor,
286+
};
265287
}
266288

267289
/**
@@ -285,7 +307,7 @@ export class CollaboratorOperationsImpl implements CollaboratorOperations {
285307
*/
286308
async hasAccess(userDid: string): Promise<boolean> {
287309
try {
288-
const collaborators = await this.list();
310+
const { collaborators } = await this.list();
289311
return collaborators.some((c) => c.userDid === userDid && !c.revokedAt);
290312
} catch {
291313
return false;
@@ -307,7 +329,7 @@ export class CollaboratorOperationsImpl implements CollaboratorOperations {
307329
* ```
308330
*/
309331
async getRole(userDid: string): Promise<RepositoryRole | null> {
310-
const collaborators = await this.list();
332+
const { collaborators } = await this.list();
311333
const collab = collaborators.find((c) => c.userDid === userDid && !c.revokedAt);
312334
return collab?.role ?? null;
313335
}

‎packages/sdk-core/src/repository/HypercertOperationsImpl.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ export class HypercertOperationsImpl extends EventEmitter<HypercertEvents> imple
208208
if (uploadResult.success) {
209209
imageBlobRef = {
210210
$type: "blob",
211-
ref: uploadResult.data.blob.ref,
211+
ref: { $link: uploadResult.data.blob.ref.toString() },
212212
mimeType: uploadResult.data.blob.mimeType,
213213
size: uploadResult.data.blob.size,
214214
};
@@ -676,7 +676,7 @@ export class HypercertOperationsImpl extends EventEmitter<HypercertEvents> imple
676676
if (uploadResult.success) {
677677
locationValue = {
678678
$type: "blob",
679-
ref: uploadResult.data.blob.ref,
679+
ref: { $link: uploadResult.data.blob.ref.toString() },
680680
mimeType: uploadResult.data.blob.mimeType,
681681
size: uploadResult.data.blob.size,
682682
};
@@ -999,7 +999,7 @@ export class HypercertOperationsImpl extends EventEmitter<HypercertEvents> imple
999999
if (uploadResult.success) {
10001000
coverPhotoRef = {
10011001
$type: "blob",
1002-
ref: uploadResult.data.blob.ref,
1002+
ref: { $link: uploadResult.data.blob.ref.toString() },
10031003
mimeType: uploadResult.data.blob.mimeType,
10041004
size: uploadResult.data.blob.size,
10051005
};

‎packages/sdk-core/src/repository/OrganizationOperationsImpl.ts‎

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ export class OrganizationOperationsImpl implements OrganizationOperations {
170170
*/
171171
async get(did: string): Promise<OrganizationInfo | null> {
172172
try {
173-
const orgs = await this.list();
174-
return orgs.find((o) => o.did === did) ?? null;
173+
const { organizations } = await this.list();
174+
return organizations.find((o) => o.did === did) ?? null;
175175
} catch {
176176
return null;
177177
}
@@ -180,7 +180,10 @@ export class OrganizationOperationsImpl implements OrganizationOperations {
180180
/**
181181
* Lists organizations the current user has access to.
182182
*
183-
* @returns Promise resolving to array of organization info
183+
* @param params - Optional pagination parameters
184+
* @param params.limit - Maximum number of results (1-100, default 50)
185+
* @param params.cursor - Pagination cursor from previous response
186+
* @returns Promise resolving to organizations and optional cursor
184187
* @throws {@link NetworkError} if the list operation fails
185188
*
186189
* @remarks
@@ -192,21 +195,25 @@ export class OrganizationOperationsImpl implements OrganizationOperations {
192195
*
193196
* @example
194197
* ```typescript
195-
* const orgs = await repo.organizations.list();
198+
* // Get first page
199+
* const page1 = await repo.organizations.list({ limit: 20 });
200+
* console.log(`Found ${page1.organizations.length} organizations`);
196201
*
197-
* // Filter by access type
198-
* const owned = orgs.filter(o => o.accessType === "owner");
199-
* const collaborated = orgs.filter(o => o.accessType === "collaborator");
202+
* // Get next page if available
203+
* if (page1.cursor) {
204+
* const page2 = await repo.organizations.list({ limit: 20, cursor: page1.cursor });
205+
* }
200206
*
201-
* console.log(`You own ${owned.length} organizations`);
202-
* console.log(`You collaborate on ${collaborated.length} organizations`);
207+
* // Filter by access type
208+
* const owned = page1.organizations.filter(o => o.accessType === "owner");
209+
* const shared = page1.organizations.filter(o => o.accessType === "shared");
203210
* ```
204211
*
205212
* @example Display organization details
206213
* ```typescript
207-
* const orgs = await repo.organizations.list();
214+
* const { organizations } = await repo.organizations.list();
208215
*
209-
* for (const org of orgs) {
216+
* for (const org of organizations) {
210217
* console.log(`${org.name} (@${org.handle})`);
211218
* console.log(` DID: ${org.did}`);
212219
* console.log(` Access: ${org.accessType}`);
@@ -216,14 +223,29 @@ export class OrganizationOperationsImpl implements OrganizationOperations {
216223
* }
217224
* ```
218225
*/
219-
async list(): Promise<OrganizationInfo[]> {
226+
async list(params?: { limit?: number; cursor?: string }): Promise<{
227+
organizations: OrganizationInfo[];
228+
cursor?: string;
229+
}> {
220230
const userDid = this.session.did || this.session.sub;
221231
if (!userDid) {
222232
throw new NetworkError("No authenticated user found");
223233
}
224234

235+
const queryParams = new URLSearchParams({
236+
userDid,
237+
});
238+
239+
if (params?.limit !== undefined) {
240+
queryParams.set("limit", params.limit.toString());
241+
}
242+
243+
if (params?.cursor) {
244+
queryParams.set("cursor", params.cursor);
245+
}
246+
225247
const response = await this.session.fetchHandler(
226-
`${this.serverUrl}/xrpc/com.sds.organization.list?userDid=${encodeURIComponent(userDid)}`,
248+
`${this.serverUrl}/xrpc/com.sds.organization.list?${queryParams.toString()}`,
227249
{ method: "GET" },
228250
);
229251

@@ -232,7 +254,7 @@ export class OrganizationOperationsImpl implements OrganizationOperations {
232254
}
233255

234256
const data = await response.json();
235-
return (data.organizations || []).map(
257+
const organizations = (data.organizations || []).map(
236258
(r: {
237259
did: string;
238260
handle: string;
@@ -251,5 +273,10 @@ export class OrganizationOperationsImpl implements OrganizationOperations {
251273
permissions: r.permissions,
252274
}),
253275
);
276+
277+
return {
278+
organizations,
279+
cursor: data.cursor,
280+
};
254281
}
255282
}

‎packages/sdk-core/src/repository/interfaces.ts‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -809,9 +809,15 @@ export interface CollaboratorOperations {
809809
/**
810810
* Lists all collaborators on the repository.
811811
*
812-
* @returns Promise resolving to array of access grants
812+
* @param params - Optional pagination parameters
813+
* @param params.limit - Maximum number of results (1-100, default 50)
814+
* @param params.cursor - Pagination cursor from previous response
815+
* @returns Promise resolving to collaborators and optional cursor
813816
*/
814-
list(): Promise<RepositoryAccessGrant[]>;
817+
list(params?: { limit?: number; cursor?: string }): Promise<{
818+
collaborators: RepositoryAccessGrant[];
819+
cursor?: string;
820+
}>;
815821

816822
/**
817823
* Checks if a user has any access to the repository.
@@ -891,7 +897,13 @@ export interface OrganizationOperations {
891897
/**
892898
* Lists organizations the current user has access to.
893899
*
894-
* @returns Promise resolving to array of organization info
900+
* @param params - Optional pagination parameters
901+
* @param params.limit - Maximum number of results (1-100, default 50)
902+
* @param params.cursor - Pagination cursor from previous response
903+
* @returns Promise resolving to organizations and optional cursor
895904
*/
896-
list(): Promise<OrganizationInfo[]>;
905+
list(params?: { limit?: number; cursor?: string }): Promise<{
906+
organizations: OrganizationInfo[];
907+
cursor?: string;
908+
}>;
897909
}

‎packages/sdk-core/tests/repository/BlobOperationsImpl.test.ts‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,14 @@ describe("BlobOperationsImpl", () => {
2828
describe("upload", () => {
2929
it("should upload a blob successfully", async () => {
3030
const mockBlob = new Blob(["test content"], { type: "text/plain" });
31+
const mockCID = {
32+
toString: () => "bafyrei123",
33+
};
3134
mockAgent.com.atproto.repo.uploadBlob.mockResolvedValue({
3235
success: true,
3336
data: {
3437
blob: {
35-
ref: { $link: "bafyrei123" },
38+
ref: mockCID,
3639
mimeType: "text/plain",
3740
size: 12,
3841
},
@@ -61,10 +64,9 @@ describe("BlobOperationsImpl", () => {
6164

6265
await blobOps.upload(mockBlob);
6366

64-
expect(mockAgent.com.atproto.repo.uploadBlob).toHaveBeenCalledWith(
65-
expect.any(Uint8Array),
66-
{ encoding: "image/png" },
67-
);
67+
expect(mockAgent.com.atproto.repo.uploadBlob).toHaveBeenCalledWith(expect.any(Uint8Array), {
68+
encoding: "image/png",
69+
});
6870
});
6971

7072
it("should default to application/octet-stream for blobs without type", async () => {
@@ -82,10 +84,9 @@ describe("BlobOperationsImpl", () => {
8284

8385
await blobOps.upload(mockBlob);
8486

85-
expect(mockAgent.com.atproto.repo.uploadBlob).toHaveBeenCalledWith(
86-
expect.any(Uint8Array),
87-
{ encoding: "application/octet-stream" },
88-
);
87+
expect(mockAgent.com.atproto.repo.uploadBlob).toHaveBeenCalledWith(expect.any(Uint8Array), {
88+
encoding: "application/octet-stream",
89+
});
8990
});
9091

9192
it("should throw NetworkError when API returns success: false", async () => {

‎packages/sdk-core/tests/repository/CollaboratorOperationsImpl.test.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,10 @@ describe("CollaboratorOperationsImpl", () => {
147147

148148
const result = await collaboratorOps.list();
149149

150-
expect(result).toHaveLength(2);
151-
expect(result[0].userDid).toBe("did:plc:user1");
152-
expect(result[0].role).toBe("editor");
153-
expect(result[1].role).toBe("viewer");
150+
expect(result.collaborators).toHaveLength(2);
151+
expect(result.collaborators[0].userDid).toBe("did:plc:user1");
152+
expect(result.collaborators[0].role).toBe("editor");
153+
expect(result.collaborators[1].role).toBe("viewer");
154154
});
155155

156156
it("should handle empty collaborators list", async () => {
@@ -161,7 +161,7 @@ describe("CollaboratorOperationsImpl", () => {
161161

162162
const result = await collaboratorOps.list();
163163

164-
expect(result).toHaveLength(0);
164+
expect(result.collaborators).toHaveLength(0);
165165
});
166166

167167
it("should correctly map permissions to roles", async () => {
@@ -187,8 +187,8 @@ describe("CollaboratorOperationsImpl", () => {
187187

188188
const result = await collaboratorOps.list();
189189

190-
expect(result[0].role).toBe("owner");
191-
expect(result[1].role).toBe("admin");
190+
expect(result.collaborators[0].role).toBe("owner");
191+
expect(result.collaborators[1].role).toBe("admin");
192192
});
193193

194194
it("should throw NetworkError on failure", async () => {

‎packages/sdk-core/tests/repository/OrganizationOperationsImpl.test.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,11 @@ describe("OrganizationOperationsImpl", () => {
159159

160160
const result = await orgOps.list();
161161

162-
expect(result).toHaveLength(2);
163-
expect(result[0].did).toBe("did:plc:org1");
164-
expect(result[0].accessType).toBe("owner");
165-
expect(result[1].did).toBe("did:plc:org2");
166-
expect(result[1].accessType).toBe("shared");
162+
expect(result.organizations).toHaveLength(2);
163+
expect(result.organizations[0].did).toBe("did:plc:org1");
164+
expect(result.organizations[0].accessType).toBe("owner");
165+
expect(result.organizations[1].did).toBe("did:plc:org2");
166+
expect(result.organizations[1].accessType).toBe("shared");
167167
});
168168

169169
it("should handle empty repositories list", async () => {
@@ -174,7 +174,7 @@ describe("OrganizationOperationsImpl", () => {
174174

175175
const result = await orgOps.list();
176176

177-
expect(result).toHaveLength(0);
177+
expect(result.organizations).toHaveLength(0);
178178
});
179179

180180
it("should use session DID in query", async () => {
@@ -234,7 +234,7 @@ describe("OrganizationOperationsImpl", () => {
234234

235235
const result = await orgOps.list();
236236

237-
expect(result[0].createdAt).toBeDefined();
237+
expect(result.organizations[0].createdAt).toBeDefined();
238238
});
239239
});
240240
});

0 commit comments

Comments
 (0)