Skip to content

URL encode Catalog name + add additional schema validation #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gmethvin merged 1 commit into from
Nov 25, 2025
Merged

URL encode Catalog name + add additional schema validation #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions src/client/catalogs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ import type { BaseIterableClient } from "./base.js";
export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
return class extends Base {
async createCatalog(catalogName: string): Promise<IterableSuccessResponse> {
const response = await this.client.post(`/api/catalogs/${catalogName}`);
const response = await this.client.post(
`/api/catalogs/${encodeURIComponent(catalogName)}`
);
return this.validateResponse(response, IterableSuccessResponseSchema);
}

Expand All @@ -51,7 +53,7 @@ export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
});

const response = await this.client.post(
`/api/catalogs/${options.catalogName}/items`,
`/api/catalogs/${encodeURIComponent(options.catalogName)}/items`,
{
documents,
replaceUploadedFieldsOnly: false,
Expand All @@ -65,7 +67,7 @@ export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
itemId: string
): Promise<CatalogItemWithProperties> {
const response = await this.client.get(
`/api/catalogs/${catalogName}/items/${itemId}`
`/api/catalogs/${encodeURIComponent(catalogName)}/items/${encodeURIComponent(itemId)}`
);
return this.validateResponse(response, CatalogItemWithPropertiesSchema);
}
Expand All @@ -75,7 +77,7 @@ export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
itemId: string
): Promise<IterableSuccessResponse> {
const response = await this.client.delete(
`/api/catalogs/${catalogName}/items/${itemId}`
`/api/catalogs/${encodeURIComponent(catalogName)}/items/${encodeURIComponent(itemId)}`
);
return this.validateResponse(response, IterableSuccessResponseSchema);
}
Expand Down Expand Up @@ -118,10 +120,13 @@ export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
);
// The API returns { msg, code, params: { definedMappings, undefinedFields } }
// Extract params and validate that directly
return this.validateResponse(
{ data: response.data.params },
CatalogFieldMappingsResponseSchema
);
if (response.data && response.data.params) {
return this.validateResponse(
{ data: response.data.params },
CatalogFieldMappingsResponseSchema
);
}
return this.validateResponse(response, CatalogFieldMappingsResponseSchema);
}

/**
Expand Down Expand Up @@ -151,10 +156,13 @@ export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
const response = await this.client.get(url);
// The API returns { msg, code, params: { catalogItemsWithProperties, totalItemsCount } }
// Extract params and validate that directly
return this.validateResponse(
{ data: response.data.params },
GetCatalogItemsResponseSchema
);
if (response.data && response.data.params) {
return this.validateResponse(
{ data: response.data.params },
GetCatalogItemsResponseSchema
);
}
return this.validateResponse(response, GetCatalogItemsResponseSchema);
}

/**
Expand Down
37 changes: 28 additions & 9 deletions src/client/lists.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ import {
CreateListResponseSchema,
GetListPreviewUsersParams,
GetListPreviewUsersResponse,
GetListPreviewUsersResponseSchema,
GetListSizeParams,
GetListSizeResponse,
GetListSizeResponseSchema,
GetListsResponse,
GetListsResponseSchema,
GetListUsersParams,
Expand Down Expand Up @@ -70,9 +72,14 @@ export function Lists<T extends Constructor<BaseIterableClient>>(Base: T) {
.trim()
.split("\n")
.filter((email) => email.trim());
return {
const result = {
users: emails.map((email) => ({ email: email.trim() })),
};
// Validate the constructed response
return this.validateResponse(
{ data: result },
GetListUsersResponseSchema
);
}

// Fallback to original format if it's already JSON
Expand All @@ -96,9 +103,12 @@ export function Lists<T extends Constructor<BaseIterableClient>>(Base: T) {
const response = await this.client.get(
`/api/lists/${params.listId}/size`
);
// API returns a string, but we want to return a proper object
// API returns a string number, convert to proper object and validate
const size = parseInt(response.data, 10);
return { size };
return this.validateResponse(
{ data: { size } },
GetListSizeResponseSchema
);
}

/**
Expand All @@ -120,13 +130,22 @@ export function Lists<T extends Constructor<BaseIterableClient>>(Base: T) {
const response = await this.client.get(
`/api/lists/previewUsers?${queryParams.toString()}`
);

// API returns plain text with users separated by newlines
const usersText = response.data as string;
const users = usersText
.trim()
.split("\n")
.filter((user) => user.length > 0);
return { users };
const responseData = response.data;
if (typeof responseData === "string") {
const users = responseData
.trim()
.split("\n")
.filter((user) => user.length > 0);
return this.validateResponse(
{ data: { users } },
GetListPreviewUsersResponseSchema
);
}

// Fallback to JSON validation if response is not plain text
return this.validateResponse(response, GetListPreviewUsersResponseSchema);
}
};
}
134 changes: 134 additions & 0 deletions tests/unit/catalogs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,140 @@ describe("Catalog Operations", () => {
afterEach(() => {
jest.clearAllMocks();
});

describe("createCatalog", () => {
it("should create catalog with correct endpoint", async () => {
const mockResponse = {
data: {
msg: "Catalog created successfully",
code: "Success",
},
};
mockAxiosInstance.post.mockResolvedValue(mockResponse);

const result = await client.createCatalog("test-catalog");

expect(mockAxiosInstance.post).toHaveBeenCalledWith(
"/api/catalogs/test-catalog"
);
expect(result).toEqual(mockResponse.data);
});

it("should encode catalog name with special characters", async () => {
const mockResponse = {
data: {
msg: "Catalog created successfully",
code: "Success",
},
};
mockAxiosInstance.post.mockResolvedValue(mockResponse);

await client.createCatalog("test catalog/with+special");

expect(mockAxiosInstance.post).toHaveBeenCalledWith(
"/api/catalogs/test%20catalog%2Fwith%2Bspecial"
);
});
});

describe("updateCatalogItems", () => {
it("should encode catalog name with special characters", async () => {
const mockResponse = {
data: {
msg: "Items updated",
code: "Success",
},
};
mockAxiosInstance.post.mockResolvedValue(mockResponse);

await client.updateCatalogItems({
catalogName: "my catalog",
items: [{ id: "item1", name: "Test" }],
});

expect(mockAxiosInstance.post).toHaveBeenCalledWith(
"/api/catalogs/my%20catalog/items",
expect.any(Object)
);
});
});

describe("getCatalogItem", () => {
it("should get item with correct endpoint", async () => {
const mockResponse = {
data: {
catalogName: "products",
itemId: "item1",
lastModified: 1704067200000,
size: 1024,
value: { name: "Product 1" },
},
};
mockAxiosInstance.get.mockResolvedValue(mockResponse);

const result = await client.getCatalogItem("products", "item1");

expect(mockAxiosInstance.get).toHaveBeenCalledWith(
"/api/catalogs/products/items/item1"
);
expect(result).toEqual(mockResponse.data);
});

it("should encode catalog name and item ID with special characters", async () => {
const mockResponse = {
data: {
catalogName: "my catalog",
itemId: "item/1",
lastModified: 1704067200000,
size: 1024,
value: {},
},
};
mockAxiosInstance.get.mockResolvedValue(mockResponse);

await client.getCatalogItem("my catalog", "item/1");

expect(mockAxiosInstance.get).toHaveBeenCalledWith(
"/api/catalogs/my%20catalog/items/item%2F1"
);
});
});

describe("deleteCatalogItem", () => {
it("should delete item with correct endpoint", async () => {
const mockResponse = {
data: {
msg: "Item deleted",
code: "Success",
},
};
mockAxiosInstance.delete.mockResolvedValue(mockResponse);

const result = await client.deleteCatalogItem("products", "item1");

expect(mockAxiosInstance.delete).toHaveBeenCalledWith(
"/api/catalogs/products/items/item1"
);
expect(result).toEqual(mockResponse.data);
});

it("should encode catalog name and item ID with special characters", async () => {
const mockResponse = {
data: {
msg: "Item deleted",
code: "Success",
},
};
mockAxiosInstance.delete.mockResolvedValue(mockResponse);

await client.deleteCatalogItem("my catalog", "item+1");

expect(mockAxiosInstance.delete).toHaveBeenCalledWith(
"/api/catalogs/my%20catalog/items/item%2B1"
);
});
});

describe("getCatalogs", () => {
it("should build pagination query parameters", async () => {
const mockResponse = {
Expand Down