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

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}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/country/countriesCountHandler.ts

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const CountriesCountSchema = {
+  includeInactive: z
+    .boolean()
+    .optional()
+    .default(false)
+    .describe('Whether to include inactive countries in the count'),
+  queryString: z.string().optional().describe('Optional text search filter'),
+};
+
+export const CountriesCountZodSchema = z.object(CountriesCountSchema);
+
+export type CountriesCountParams = z.infer<typeof CountriesCountZodSchema>;
+
+// Handler function
+export async function countriesCountHandler(context: Context, params: CountriesCountParams) {
+  const { includeInactive = false, queryString } = params;
+  const { modules, userId } = context;
+
+  try {
+    log(`query countriesCount (includeInactive: ${includeInactive}, query: ${queryString || ''})`, {
+      userId,
+    });
+
+    const count = await modules.countries.count(params);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify(count),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error counting countries: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/country/countriesHandler.ts

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { SortDirection } from '@unchainedshop/utils';
+
+const sortDirectionKeys = Object.keys(SortDirection) as [
+  keyof typeof SortDirection,
+  ...(keyof typeof SortDirection)[],
+];
+
+export const ListCountriesSchema = {
+  limit: z.number().int().min(1).max(100).default(50),
+  offset: z.number().int().min(0).default(0),
+  includeInactive: z.boolean().default(false),
+  queryString: z.string().min(1).optional(),
+  sort: z
+    .array(
+      z.object({
+        key: z.string().min(1),
+        value: z.enum(sortDirectionKeys).describe("Sort direction, e.g., 'ASC' or 'DESC'"),
+      }),
+    )
+    .optional(),
+};
+
+export const ListCountriesZodSchema = z.object(ListCountriesSchema);
+
+export type ListCountriesParams = z.infer<typeof ListCountriesZodSchema>;
+
+export async function countriesHandler(context: Context, params: ListCountriesParams) {
+  const { limit, offset, includeInactive, queryString, sort } = params;
+  const { modules } = context;
+
+  try {
+    const countries = await modules.countries.findCountries({
+      limit,
+      offset,
+      includeInactive,
+      queryString,
+      sort: sort as any[],
+    });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ countries }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error retrieving countries: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/country/countryHandler.ts

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { CountryNotFoundError } from '../../../errors.js';
+
+export const CountrySchema = {
+  countryId: z.string().min(1).describe('The ID of the country to fetch'),
+};
+
+export const CountryZodSchema = z.object(CountrySchema);
+
+export type CountryParams = z.infer<typeof CountryZodSchema>;
+
+export async function countryHandler(context: Context, params: CountryParams) {
+  const { countryId } = params;
+  const { modules } = context;
+
+  try {
+    const country = await modules.countries.findCountry({ countryId });
+
+    if (!country) throw new CountryNotFoundError({ countryId });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ country }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error retrieving country: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/country/createCountryHandler.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const CreateCountrySchema = {
+  country: z.object({
+    isoCode: z
+      .string()
+      .min(2)
+      .max(2)
+      .toUpperCase()
+      .describe('2-letter ISO 3166-1 alpha-2 country code (e.g., "CH", "US")'),
+  }),
+};
+
+export const CreateCountryZodSchema = z.object(CreateCountrySchema);
+export type CreateCountryParams = z.infer<typeof CreateCountryZodSchema>;
+
+export async function createCountryHandler(context: Context, params: CreateCountryParams) {
+  const { country } = params;
+  const { modules, userId } = context;
+  try {
+    log(`handler createCountry: ${country.isoCode}`, { userId });
+
+    const countryId = await modules.countries.create(country as any);
+
+    const newCountry = await modules.countries.findCountry({ countryId });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ country: newCountry }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error creating country: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/country/removeCountryHandler.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+import { CountryNotFoundError } from '../../../errors.js';
+
+export const RemoveCountrySchema = {
+  countryId: z.string().min(1).describe('ID of the country to remove'),
+};
+
+export const RemoveCountryZodSchema = z.object(RemoveCountrySchema);
+
+export type RemoveCountryParams = z.infer<typeof RemoveCountryZodSchema>;
+
+export async function removeCountryHandler(context: Context, params: RemoveCountryParams) {
+  const { countryId } = params;
+  const { modules, userId } = context;
+
+  try {
+    log(`handler removeCountry: ${countryId}`, { userId });
+
+    if (!(await modules.countries.countryExists({ countryId })))
+      throw new CountryNotFoundError({ countryId });
+
+    await modules.countries.delete(countryId);
+
+    const removedCountry = await modules.countries.findCountry({ countryId });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ country: removedCountry }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error removing country: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/country/updateCountryHandler.ts

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+import { CountryNotFoundError } from '../../../errors.js';
+
+export const UpdateCountrySchema = {
+  countryId: z.string().min(1).describe('ID of the country to update'),
+  country: z.object({
+    isoCode: z
+      .string()
+      .min(2)
+      .max(2)
+      .toUpperCase()
+      .describe('2-letter ISO 3166-1 alpha-2 country code (e.g., "CH", "US")'),
+    isActive: z.boolean().optional().describe('Whether the country is active'),
+    defaultCurrencyCode: z
+      .string()
+      .min(3)
+      .max(3)
+      .toUpperCase()
+      .optional()
+      .describe('Default currency code (e.g., "USD", "CHF")'),
+  }),
+};
+
+export const UpdateCountryZodSchema = z.object(UpdateCountrySchema);
+export type UpdateCountryParams = z.infer<typeof UpdateCountryZodSchema>;
+
+export async function updateCountryHandler(context: Context, params: UpdateCountryParams) {
+  const { country, countryId } = params;
+  const { modules, userId } = context;
+  try {
+    log(`handler updateCountry: ${countryId}`, { userId });
+
+    if (!(await modules.countries.countryExists({ countryId })))
+      throw new CountryNotFoundError({ countryId });
+
+    await modules.countries.update(countryId, country as any);
+
+    const updatedCountry = await modules.countries.findCountry({ countryId });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ country: updatedCountry }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error updating country: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/currency/createCurrencyHandler.ts

@@ -0,0 +1,55 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const CreateCurrencySchema = {
+  currency: z.object({
+    isoCode: z
+      .string()
+      .min(3)
+      .max(3)
+      .toUpperCase()
+      .describe('3-letter ISO currency code (e.g., "USD", "EUR", "CHF")'),
+    contractAddress: z.string().optional().describe('Blockchain contract address (optional)'),
+    decimals: z
+      .number()
+      .int()
+      .nonnegative()
+      .optional()
+      .describe('Decimal precision for the currency (optional)'),
+  }),
+};
+
+export const CreateCurrencyZodSchema = z.object(CreateCurrencySchema);
+export type CreateCurrencyParams = z.infer<typeof CreateCurrencyZodSchema>;
+
+export async function createCurrencyHandler(context: Context, params: CreateCurrencyParams) {
+  const { currency } = params;
+  const { modules, userId } = context;
+
+  try {
+    log(`Handler createCurrency: ${currency.isoCode}`, { userId });
+
+    const currencyId = await modules.currencies.create(currency as any);
+
+    const newCurrency = await modules.currencies.findCurrency({ currencyId });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({ currency: newCurrency }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error creating currency: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/currency/currenciesCountHandler.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { log } from '@unchainedshop/logger';
+
+export const CurrenciesCountSchema = {
+  includeInactive: z
+    .boolean()
+    .optional()
+    .default(false)
+    .describe('Include inactive currencies in count'),
+  queryString: z.string().optional().describe('Optional search filter'),
+};
+
+export const CurrenciesCountZodSchema = z.object(CurrenciesCountSchema);
+
+export type CurrenciesCountParams = z.infer<typeof CurrenciesCountZodSchema>;
+
+export async function currenciesCountHandler(context: Context, params: CurrenciesCountParams) {
+  const { includeInactive = false, queryString } = params;
+  const { modules, userId } = context;
+
+  try {
+    log(`Handler currenciesCount (includeInactive: ${includeInactive}, query: ${queryString ?? ''})`, {
+      userId,
+    });
+
+    const count = await modules.currencies.count(params);
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify(count),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error counting currencies: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}

package/src/mcp/tools/currency/currenciesHandler.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod';
+import { Context } from '../../../context.js';
+import { SortDirection } from '@unchainedshop/utils';
+
+const sortDirectionKeys = Object.keys(SortDirection) as [
+  keyof typeof SortDirection,
+  ...(keyof typeof SortDirection)[],
+];
+
+export const ListCurrenciesSchema = {
+  limit: z.number().int().min(1).max(100).default(50),
+  offset: z.number().int().min(0).default(0),
+  includeInactive: z.boolean().default(false),
+  queryString: z.string().min(1).optional(),
+  sort: z
+    .array(
+      z.object({
+        key: z.string().min(1),
+        value: z.enum(sortDirectionKeys).describe("Sort direction, e.g., 'ASC' or 'DESC'"),
+      }),
+    )
+    .optional(),
+};
+
+export const ListCurrenciesZodSchema = z.object(ListCurrenciesSchema);
+
+export type ListCurrenciesParams = z.infer<typeof ListCurrenciesZodSchema>;
+
+export async function currenciesHandler(context: Context, params: ListCurrenciesParams) {
+  const { limit, offset, includeInactive, queryString, sort } = params;
+
+  const { modules } = context;
+
+  try {
+    const currencies = await modules.currencies.findCurrencies({
+      limit,
+      offset,
+      includeInactive,
+      queryString,
+      sort: sort as any[],
+    });
+
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: JSON.stringify({
+            currencies,
+          }),
+        },
+      ],
+    };
+  } catch (error) {
+    return {
+      content: [
+        {
+          type: 'text' as const,
+          text: `Error retrieving currencies: ${(error as Error).message}`,
+        },
+      ],
+    };
+  }
+}