@unchainedshop/api 4.0.0-rc.3 → 4.0.0-rc.4

package/src/mcp/tools/assortment/removeAssortmentMediaHandler.ts

@@ -0,0 +1,50 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+import { AssortmentMediaNotFoundError } from '../../../errors.js';
+
+export const RemoveAssortmentMediaSchema = {
+  assortmentMediaId: z.string().min(1).describe('ID of the assortment media to remove'),
+};
+
+export const RemoveAssortmentMediaZodSchema = z.object(RemoveAssortmentMediaSchema);
+
+export type RemoveAssortmentMediaParams = z.infer<typeof RemoveAssortmentMediaZodSchema>;
+
+export async function removeAssortmentMediaHandler(
+  context: Context,
+  params: RemoveAssortmentMediaParams,
+) {
+  const { assortmentMediaId } = params;
+  const { modules, userId } = context;
+
+  try {
+    log(`handler removeAssortmentMedia: ${assortmentMediaId}`, { userId });
+
+    const assortmentMedia = await modules.assortments.media.findAssortmentMedia({
+      assortmentMediaId,
+    });
+    if (!assortmentMedia) throw new AssortmentMediaNotFoundError({ assortmentMediaId });
+
+    await modules.files.delete(assortmentMedia.mediaId);
+    await modules.assortments.media.delete(assortmentMediaId);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ assortmentMedia }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error removing assortment media: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/removeAssortmentProductHandler.ts

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+import { AssortmentProductNotFoundError } from '../../../errors.js';
+
+export const RemoveAssortmentProductSchema = {
+  assortmentProductId: z.string().min(1).describe('ID of the assortment product to remove'),
+};
+
+export const RemoveAssortmentProductZodSchema = z.object(RemoveAssortmentProductSchema);
+
+export type RemoveAssortmentProductParams = z.infer<typeof RemoveAssortmentProductZodSchema>;
+
+export async function removeAssortmentProductHandler(
+  context: Context,
+  params: RemoveAssortmentProductParams,
+) {
+  const { assortmentProductId } = params;
+  const { modules, userId } = context;
+
+  try {
+    log(`handler removeAssortmentProduct: ${assortmentProductId}`, { userId });
+
+    const assortmentProduct = await modules.assortments.products.findAssortmentProduct({
+      assortmentProductId,
+    });
+    if (!assortmentProduct) throw new AssortmentProductNotFoundError({ assortmentProductId });
+
+    await modules.assortments.products.delete(assortmentProductId);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ assortmentProduct }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error removing assortment product: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/reorderAssortmentFiltersHandler.ts

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const ReorderAssortmentFilterInputSchema = z.object({
+  assortmentFilterId: z.string().min(1),
+  sortKey: z.number().int(),
+});
+
+export const ReorderAssortmentFiltersSchema = {
+  sortKeys: z
+    .array(ReorderAssortmentFilterInputSchema)
+    .min(1)
+    .describe('Array of assortmentFilterId and their new sort keys'),
+};
+
+export const ReorderAssortmentFiltersZodSchema = z.object(ReorderAssortmentFiltersSchema);
+
+export type ReorderAssortmentFiltersParams = z.infer<typeof ReorderAssortmentFiltersZodSchema>;
+
+export async function reorderAssortmentFiltersHandler(
+  context: Context,
+  params: ReorderAssortmentFiltersParams,
+) {
+  const { sortKeys } = params;
+  const { modules, userId } = context;
+
+  try {
+    log('handler reorderAssortmentFilters', { userId, sortKeys });
+
+    await modules.assortments.filters.updateManualOrder({
+      sortKeys,
+    } as any);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ success: true }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error reordering assortment filters: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/reorderAssortmentLinksHandler.ts

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const ReorderAssortmentLinkInputSchema = z.object({
+  assortmentLinkId: z.string().min(1),
+  sortKey: z.number(),
+});
+
+export const ReorderAssortmentLinksSchema = {
+  sortKeys: z
+    .array(ReorderAssortmentLinkInputSchema)
+    .min(1)
+    .describe('New sort order for assortment links'),
+};
+
+export const ReorderAssortmentLinksZodSchema = z.object(ReorderAssortmentLinksSchema);
+
+export type ReorderAssortmentLinksParams = z.infer<typeof ReorderAssortmentLinksZodSchema>;
+
+export async function reorderAssortmentLinksHandler(
+  context: Context,
+  params: ReorderAssortmentLinksParams,
+) {
+  const { sortKeys } = params;
+  const { modules, userId } = context;
+
+  try {
+    log('handler reorderAssortmentLinks', { userId, sortKeys });
+
+    await modules.assortments.links.updateManualOrder({
+      sortKeys: sortKeys,
+    } as any);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ success: true }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error reordering assortment links: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/reorderAssortmentMediaHandler.ts

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const ReorderAssortmentMediaInputSchema = z.object({
+  assortmentMediaId: z.string().min(1),
+  sortKey: z.number(),
+});
+
+export const ReorderAssortmentMediaSchema = {
+  sortKeys: z
+    .array(ReorderAssortmentMediaInputSchema)
+    .min(1)
+    .describe('New sort order for assortment media (first is primary)'),
+};
+
+export const ReorderAssortmentMediaZodSchema = z.object(ReorderAssortmentMediaSchema);
+
+export type ReorderAssortmentMediaParams = z.infer<typeof ReorderAssortmentMediaZodSchema>;
+
+export async function reorderAssortmentMediaHandler(
+  context: Context,
+  params: ReorderAssortmentMediaParams,
+) {
+  const { sortKeys } = params;
+  const { modules, userId } = context;
+
+  try {
+    log('handler reorderAssortmentMedia', { userId, sortKeys });
+
+    await modules.assortments.media.updateManualOrder({
+      sortKeys,
+    } as any);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ success: true }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error reordering assortment media: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/reorderAssortmentProductsHandler.ts

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const ReorderAssortmentProductInputSchema = z.object({
+  assortmentProductId: z.string().min(1),
+  sortKey: z.number(),
+});
+
+export const ReorderAssortmentProductsSchema = {
+  sortKeys: z
+    .array(ReorderAssortmentProductInputSchema)
+    .min(1)
+    .describe('New sort order for assortment products'),
+};
+
+export const ReorderAssortmentProductsZodSchema = z.object(ReorderAssortmentProductsSchema);
+
+export type ReorderAssortmentProductsParams = z.infer<typeof ReorderAssortmentProductsZodSchema>;
+
+export async function reorderAssortmentProductsHandler(
+  context: Context,
+  params: ReorderAssortmentProductsParams,
+) {
+  const { sortKeys } = params;
+  const { modules, userId } = context;
+
+  try {
+    log('handler reorderAssortmentProducts', { userId, sortKeys });
+
+    await modules.assortments.products.updateManualOrder({
+      sortKeys,
+    } as any);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ success: true }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error reordering assortment products: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/searchAssortmentProductHandler.ts

@@ -0,0 +1,87 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const SearchAssortmentProductSchema = {
+  assortmentId: z.string().min(1).describe('ID of the assortment to search in'),
+  queryString: z.string().optional().describe('Search query string'),
+  filterQuery: z
+    .array(z.object({ key: z.string(), value: z.string().optional() }))
+    .optional()
+    .describe('Filter conditions'),
+  includeInactive: z.boolean().optional().default(true),
+  ignoreChildAssortments: z.boolean().optional().default(false),
+  limit: z.number().int().min(1).max(100).default(20).describe('Pagination limit'),
+  offset: z.number().int().min(0).default(0).describe('Pagination offset'),
+};
+
+export const SearchAssortmentProductZodSchema = z.object(SearchAssortmentProductSchema);
+
+export type SearchAssortmentProductParams = z.infer<typeof SearchAssortmentProductZodSchema>;
+
+export async function searchAssortmentProductHandler(
+  context: Context,
+  params: SearchAssortmentProductParams,
+) {
+  const { userId, modules, services, locale } = context;
+  const { assortmentId, limit, offset, ...query } = params;
+
+  try {
+    log('handler searchAssortmentProduct', { userId, params });
+
+    const productIds = await modules.assortments.findProductIds({
+      assortmentId,
+      ignoreChildAssortments: query.ignoreChildAssortments,
+    });
+
+    const filterIds = await modules.assortments.filters.findFilterIds({
+      assortmentId,
+    });
+    const result = await services.filters.searchProducts({ ...query, productIds, filterIds } as any, {
+      locale: locale,
+    });
+    const productsCount = await modules.products.search.countFilteredProducts({
+      productSelector: result.searchConfiguration.productSelector,
+      productIds: result.aggregatedTotalProductIds,
+    });
+    const products = await modules.products.search.findFilteredProducts({
+      limit,
+      offset,
+      productIds: result.aggregatedFilteredProductIds,
+      productSelector: result.searchConfiguration.productSelector,
+      sort: result.searchConfiguration.sortStage,
+    });
+
+    const relevantProductIds = await modules.products.findProductIds({
+      productSelector: result.searchConfiguration.productSelector,
+      productIds: result.totalProductIds,
+      includeDrafts: result.searchConfiguration.searchQuery.includeInactive,
+    });
+    const filters = await services.filters.loadFilters(result.searchConfiguration.searchQuery, {
+      productIds: relevantProductIds,
+      forceLiveCollection: result.searchConfiguration.forceLiveCollection,
+    });
+    const filteredProductsCount = await modules.products.search.countFilteredProducts({
+      productSelector: result.searchConfiguration.productSelector,
+      productIds: result.aggregatedFilteredProductIds,
+    });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ productsCount, products, filters, filteredProductsCount }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error searching products: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/setBaseAssortmentHandler.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+import { getNormalizedAssortmentDetails } from '../../utils/getNormalizedAssortmentDetails.js';
+import { AssortmentNotFoundError } from '../../../errors.js';
+
+export const SetBaseAssortmentSchema = {
+  assortmentId: z.string().min(1).describe('ID of the assortment to set as base'),
+};
+
+export const SetBaseAssortmentZodSchema = z.object(SetBaseAssortmentSchema);
+export type SetBaseAssortmentParams = z.infer<typeof SetBaseAssortmentZodSchema>;
+
+export async function setBaseAssortmentHandler(context: Context, params: SetBaseAssortmentParams) {
+  const { modules, userId } = context;
+  const { assortmentId } = params;
+
+  try {
+    log('handler setBaseAssortment', { userId, assortmentId });
+
+    if (!(await modules.assortments.assortmentExists({ assortmentId })))
+      throw new AssortmentNotFoundError({ assortmentId });
+
+    await modules.assortments.setBase(assortmentId);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({
+            assortment: await getNormalizedAssortmentDetails({ assortmentId }, context),
+          }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error setting base assortment: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/translatedAssortmentMediaTextsHandler.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const TranslatedAssortmentMediaTextsSchema = {
+  assortmentMediaId: z.string().min(1).describe('ID of the assortment media to retrieve texts for'),
+};
+
+export const TranslatedAssortmentMediaTextsZodSchema = z.object(TranslatedAssortmentMediaTextsSchema);
+
+export type TranslatedAssortmentMediaTextsParams = z.infer<
+  typeof TranslatedAssortmentMediaTextsZodSchema
+>;
+
+export async function translatedAssortmentMediaTextsHandler(
+  context: Context,
+  params: TranslatedAssortmentMediaTextsParams,
+) {
+  const { assortmentMediaId } = params;
+  const { modules, userId } = context;
+
+  try {
+    log('handler translatedAssortmentMediaTexts', { userId, assortmentMediaId });
+
+    const texts = await modules.assortments.media.texts.findMediaTexts({
+      assortmentMediaId,
+    });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ texts }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error retrieving assortment media texts: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/translatedAssortmentTextsHandler.ts

@@ -0,0 +1,43 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const TranslatedAssortmentTextsSchema = {
+  assortmentId: z.string().min(1).describe('ID of the assortment to retrieve texts for'),
+};
+
+export const TranslatedAssortmentTextsZodSchema = z.object(TranslatedAssortmentTextsSchema);
+
+export type TranslatedAssortmentTextsParams = z.infer<typeof TranslatedAssortmentTextsZodSchema>;
+
+export async function translatedAssortmentTextsHandler(
+  context: Context,
+  params: TranslatedAssortmentTextsParams,
+) {
+  const { assortmentId } = params;
+  const { modules, userId } = context;
+
+  try {
+    log('handler translatedAssortmentTexts', { userId, assortmentId });
+
+    const texts = await modules.assortments.texts.findTexts({ assortmentId });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ texts }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error retrieving assortment texts: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/updateAssortmentHandler.ts

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+import { AssortmentNotFoundError } from '../../../errors.js';
+import { getNormalizedAssortmentDetails } from '../../utils/getNormalizedAssortmentDetails.js';
+
+export const UpdateAssortmentInputSchema = z.object({
+  isRoot: z
+    .boolean()
+    .optional()
+    .describe('If true, sets this assortment as a root assortment (top-level).'),
+  isActive: z.boolean().optional().describe('Whether this assortment is active'),
+  sequence: z
+    .number()
+    .int()
+    .optional()
+    .describe('Order of the assortment in a sorted list (lower number = higher priority).'),
+  tags: z
+    .array(z.string().min(1).toLowerCase())
+    .optional()
+    .describe('Tags (lowercase) used to categorize or filter the assortment.'),
+});
+
+export const UpdateAssortmentSchema = {
+  assortmentId: z.string().min(1).describe('ID of the assortment to update'),
+  assortment: UpdateAssortmentInputSchema.describe('Partial object with fields to update.'),
+};
+
+export const UpdateAssortmentZodSchema = z.object(UpdateAssortmentSchema);
+export type UpdateAssortmentParams = z.infer<typeof UpdateAssortmentZodSchema>;
+
+export async function updateAssortmentHandler(context: Context, params: UpdateAssortmentParams) {
+  const { modules, userId } = context;
+  const { assortmentId, assortment } = params;
+
+  try {
+    log('handler updateAssortment', { userId, params });
+
+    if (!(await modules.assortments.assortmentExists({ assortmentId })))
+      throw new AssortmentNotFoundError({ assortmentId });
+
+    await modules.assortments.update(assortmentId, assortment as any);
+    const updatedAssortment = await getNormalizedAssortmentDetails({ assortmentId }, context);
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({
+            assortment: updatedAssortment,
+          }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error updating assortment: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/assortment/updateAssortmentMediaTextsHandler.ts

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+import { AssortmentMediaNotFoundError } from '../../../errors.js';
+
+export const AssortmentMediaTextInputSchema = z.object({
+  locale: z
+    .string()
+    .min(2)
+    .describe(
+      'locale iso code like "en-US", "de-CH" use default defaultLanguageIsoCode in shop info if not explicitly provided. if language is explicitly provided check if it exists',
+    ),
+  title: z.string().optional().describe('Title in the given locale'),
+  subtitle: z.string().optional().describe('Subtitle in the given locale'),
+});
+
+export const UpdateAssortmentMediaTextsSchema = {
+  assortmentMediaId: z.string().min(1).describe('ID of the assortment media to update'),
+  texts: z.array(AssortmentMediaTextInputSchema).min(1).describe('Localized text values to update'),
+};
+
+export const UpdateAssortmentMediaTextsZodSchema = z.object(UpdateAssortmentMediaTextsSchema);
+
+export type UpdateAssortmentMediaTextsParams = z.infer<typeof UpdateAssortmentMediaTextsZodSchema>;
+
+export async function updateAssortmentMediaTextsHandler(
+  context: Context,
+  params: UpdateAssortmentMediaTextsParams,
+) {
+  const { assortmentMediaId, texts } = params;
+  const { modules, userId } = context;
+
+  try {
+    log('handler updateAssortmentMediaTexts', { userId, assortmentMediaId, texts });
+
+    const assortmentMedia = await modules.assortments.media.findAssortmentMedia({
+      assortmentMediaId,
+    });
+
+    if (!assortmentMedia) throw new AssortmentMediaNotFoundError({ assortmentMediaId });
+
+    const assortmentMediaTexts = await modules.assortments.media.texts.updateMediaTexts(
+      assortmentMediaId,
+      texts,
+    );
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ assortmentMediaTexts }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error updating assortment media texts: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}