@c-rex/services 0.1.5 → 0.1.7

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { CrexApi } from '@c-rex/core';
 import { Method } from 'axios';
-import { informationUnitsRenditions, DirectoryNodes, DirectoryNodesResponse, informationUnitsResponse, informationUnitsItems, LanguageAndCountries } from '@c-rex/interfaces';
+import { informationUnitsRenditions, DirectoryNodes, DirectoryNodesResponse, informationUnitsResponse, informationUnitsItems, LanguageAndCountries, DefaultResponse, TopicsResponseItem } from '@c-rex/interfaces';
 
 declare const WILD_CARD_OPTIONS: {
     readonly BOTH: "BOTH";
@@ -102,13 +102,14 @@ declare class DocumentTypesService extends BaseService {
     constructor();
     /**
      * Retrieves document type labels for the specified fields.
-     * The labels are restricted to English language (EN-us).
      *
-     * @param fields - Array of field names to retrieve labels for
      * @returns A promise that resolves to an array of label strings
      * @throws Error if the API request fails
      */
-    getLabels(fields: string[]): Promise<string[]>;
+    getLabels(): Promise<{
+        shortId: string;
+        label: string;
+    }[]>;
 }
 
 /**
@@ -183,4 +184,36 @@ declare class LanguageService extends BaseService {
     getLanguagesAndCountries(): Promise<LanguageAndCountries[]>;
 }
 
-export { DirectoryNodesService, DocumentTypesService, InformationUnitsService, LanguageService, RenditionsService };
+type getListProps = {
+    queries?: string;
+    page?: number;
+    filters?: string[];
+    fields?: string[];
+    languages?: string[];
+    wildcard?: WildCardType;
+    operator?: string;
+    like?: boolean;
+    pageSize?: number;
+};
+/**
+ * Service for interacting with information units in the API.
+ * Provides methods to retrieve and search information units.
+ */
+declare class TopicsService extends BaseService {
+    constructor();
+    /**
+     * Retrieves a list of topics based on specified criteria.
+     *
+     * @param options - Options for filtering and paginating the topics list
+     * @param options.queries - Optional search query string
+     * @param options.page - Optional page number for pagination (defaults to 1)
+     * @param options.fields - Optional array of fields to include in the response
+     * @param options.filters - Optional array of filter strings to apply
+     * @param options.languages - Optional array of language codes to filter by
+     * @returns A promise that resolves to the information units response
+     * @throws Error if the API request fails
+     */
+    getList({ queries, page, fields, filters, languages, wildcard, operator, pageSize }: getListProps): Promise<DefaultResponse<TopicsResponseItem, null>>;
+}
+
+export { DirectoryNodesService, DocumentTypesService, InformationUnitsService, LanguageService, RenditionsService, TopicsService };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { CrexApi } from '@c-rex/core';
 import { Method } from 'axios';
-import { informationUnitsRenditions, DirectoryNodes, DirectoryNodesResponse, informationUnitsResponse, informationUnitsItems, LanguageAndCountries } from '@c-rex/interfaces';
+import { informationUnitsRenditions, DirectoryNodes, DirectoryNodesResponse, informationUnitsResponse, informationUnitsItems, LanguageAndCountries, DefaultResponse, TopicsResponseItem } from '@c-rex/interfaces';
 
 declare const WILD_CARD_OPTIONS: {
     readonly BOTH: "BOTH";
@@ -102,13 +102,14 @@ declare class DocumentTypesService extends BaseService {
     constructor();
     /**
      * Retrieves document type labels for the specified fields.
-     * The labels are restricted to English language (EN-us).
      *
-     * @param fields - Array of field names to retrieve labels for
      * @returns A promise that resolves to an array of label strings
      * @throws Error if the API request fails
      */
-    getLabels(fields: string[]): Promise<string[]>;
+    getLabels(): Promise<{
+        shortId: string;
+        label: string;
+    }[]>;
 }
 
 /**
@@ -183,4 +184,36 @@ declare class LanguageService extends BaseService {
     getLanguagesAndCountries(): Promise<LanguageAndCountries[]>;
 }
 
-export { DirectoryNodesService, DocumentTypesService, InformationUnitsService, LanguageService, RenditionsService };
+type getListProps = {
+    queries?: string;
+    page?: number;
+    filters?: string[];
+    fields?: string[];
+    languages?: string[];
+    wildcard?: WildCardType;
+    operator?: string;
+    like?: boolean;
+    pageSize?: number;
+};
+/**
+ * Service for interacting with information units in the API.
+ * Provides methods to retrieve and search information units.
+ */
+declare class TopicsService extends BaseService {
+    constructor();
+    /**
+     * Retrieves a list of topics based on specified criteria.
+     *
+     * @param options - Options for filtering and paginating the topics list
+     * @param options.queries - Optional search query string
+     * @param options.page - Optional page number for pagination (defaults to 1)
+     * @param options.fields - Optional array of fields to include in the response
+     * @param options.filters - Optional array of filter strings to apply
+     * @param options.languages - Optional array of language codes to filter by
+     * @returns A promise that resolves to the information units response
+     * @throws Error if the API request fails
+     */
+    getList({ queries, page, fields, filters, languages, wildcard, operator, pageSize }: getListProps): Promise<DefaultResponse<TopicsResponseItem, null>>;
+}
+
+export { DirectoryNodesService, DocumentTypesService, InformationUnitsService, LanguageService, RenditionsService, TopicsService };

package/dist/index.js

@@ -34,7 +34,8 @@ __export(index_exports, {
   DocumentTypesService: () => DocumentTypesService,
   InformationUnitsService: () => InformationUnitsService,
   LanguageService: () => LanguageService,
-  RenditionsService: () => RenditionsService
+  RenditionsService: () => RenditionsService,
+  TopicsService: () => TopicsService
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -58,6 +59,7 @@ var API = {
   }
 };
 var SDK_CONFIG_KEY = "crex-sdk-config";
+var CONTENT_LANG_KEY = "CONTENT_LANG_KEY";
 var FLAGS_BY_LANG = {
   "en": "US",
   "de": "DE"
@@ -66,10 +68,12 @@ var EN_LANG = "en";
 var TOPIC = "TOPIC";
 var DOCUMENT = "DOCUMENT";
 var PACKAGE = "PACKAGE";
+var FRAGMENT = "FRAGMENT";
 var RESULT_TYPES = {
   TOPIC,
   DOCUMENT,
-  PACKAGE
+  PACKAGE,
+  FRAGMENT
 };
 var DEFAULT_COOKIE_LIMIT = 7 * 24 * 60 * 60 * 1e3;
 var CREX_TOKEN_HEADER_KEY = "crex-token";
@@ -237,7 +241,7 @@ var CrexApi = class {
   async initAPI() {
     this.logger = new CrexLogger();
     if (!this.customerConfig) {
-      const aux = await (0, import_headers.cookies)().get(SDK_CONFIG_KEY);
+      const aux = (0, import_headers.cookies)().get(SDK_CONFIG_KEY);
       if (aux != void 0) {
         this.customerConfig = JSON.parse(aux.value);
       } else {
@@ -363,6 +367,17 @@ var getCountryCodeByLang = (lang) => {
   const country = FLAGS_BY_LANG[lang];
   return country;
 };
+var formatDateToLocale = (date, locale) => {
+  if (typeof date !== "string" || !date) {
+    return date;
+  }
+  const dateAux = new Date(date);
+  return new Intl.DateTimeFormat(locale, {
+    day: "2-digit",
+    month: "long",
+    year: "numeric"
+  }).format(dateAux);
+};
 
 // ../utils/src/call.ts
 var call = async (method, params) => {
@@ -570,12 +585,18 @@ var DirectoryNodesService = class extends BaseService {
 };
 
 // src/transforms/documentTypes.ts
+var import_next_cookies2 = require("@c-rex/utils/next-cookies");
+var import_headers2 = require("next/headers");
 var transformDocumentTypes = (data) => {
   const labels = [];
+  const config = (0, import_next_cookies2.getConfigs)();
+  const contentLanguage = (0, import_headers2.cookies)().get(CONTENT_LANG_KEY)?.value || config.languageSwitcher.default;
+  const language = contentLanguage.split("-")[0];
   data.items.forEach((documentItem) => {
-    const aux = documentItem.labels.flatMap((item) => item);
-    aux.forEach((item) => {
-      if (item.language == "en") labels.push(item.value);
+    const label = documentItem.labels.find((item) => item.language.toLowerCase() === language.toLowerCase());
+    labels.push({
+      shortId: documentItem.shortId,
+      label: label ? label.value : ""
     });
   });
   return labels;
@@ -588,34 +609,30 @@ var DocumentTypesService = class extends BaseService {
   }
   /**
    * Retrieves document type labels for the specified fields.
-   * The labels are restricted to English language (EN-us).
    * 
-   * @param fields - Array of field names to retrieve labels for
    * @returns A promise that resolves to an array of label strings
    * @throws Error if the API request fails
    */
-  async getLabels(fields) {
-    const params = [
-      {
-        key: "Restrict",
-        value: `languages~EN-us`
-      },
-      ...createParams(fields, "Fields")
-    ];
+  async getLabels() {
     return await this.request({
-      params,
+      params: [{
+        key: "sparqlWhere",
+        value: "?iu iirds:is-applicable-for-document-type ?s . ?iu iirds:has-topic-type <https://www.c-rex.net/iirds/td#Blogpost>"
+      }],
       transformer: transformDocumentTypes
     });
   }
 };
 
 // src/transforms/information.ts
-var import_next_cookies2 = require("@c-rex/utils/next-cookies");
+var import_next_cookies3 = require("@c-rex/utils/next-cookies");
+var import_headers3 = require("next/headers");
 var import_logger2 = require("@c-rex/core/logger");
 var transformInformationUnits = async (data) => {
-  const config = await (0, import_next_cookies2.getConfigs)();
   const logger = new import_logger2.CrexLogger();
-  const items = await Promise.all(data.items.map(async (item) => {
+  const config = await (0, import_next_cookies3.getConfigs)();
+  const filteredTags = {};
+  const items = data.items.map((item) => {
     const type = item.class.labels.filter((item2) => item2.language === EN_LANG)[0].value.toUpperCase();
     const { filesToOpen, filesToDownload } = getFileRenditions({ renditions: item?.renditions });
     let link = `/topics/${item.shortId}`;
@@ -651,10 +668,60 @@ var transformInformationUnits = async (data) => {
       filesToOpen,
       filesToDownload
     };
-  }));
-  const filteredList = items.filter((item) => item != null);
+  });
+  if (data.tags) {
+    const contentLang = ((0, import_headers3.cookies)().get(CONTENT_LANG_KEY)?.value || EN_LANG).toLowerCase();
+    const splittedContentLang = contentLang.split("-")[0];
+    for (const [key, value] of Object.entries(data.tags)) {
+      if (!value || !value.items || value.items.length === 0) {
+        continue;
+      }
+      if (!config.search.tags.includes(key)) {
+        continue;
+      }
+      const aux = value.items.map((item) => {
+        if (item?.shortId === void 0) return null;
+        if (Number(item.hits) === 0) return null;
+        if (item?.labels === void 0 || item?.labels.length === 0) {
+          logger.log({
+            level: "warning",
+            message: `No labels on item with id ${item.shortId} from category ${key}`
+          });
+          return null;
+        }
+        let label = "";
+        for (const labelItem of item.labels) {
+          if (labelItem.language === void 0) {
+            logger.log({
+              level: "info",
+              message: `No language on label ${labelItem.value} from category ${key}`
+            });
+            label = labelItem.value;
+            break;
+          }
+          if (labelItem.language.toLowerCase() === contentLang || labelItem.language.toLowerCase() === splittedContentLang) {
+            label = labelItem.value;
+            break;
+          }
+          label = labelItem.value;
+        }
+        return {
+          hits: item.hits,
+          total: item.total,
+          label,
+          active: false,
+          shortId: item.shortId
+        };
+      }).filter((item) => item !== null);
+      if (aux.length === 0) {
+        continue;
+      }
+      filteredTags[key] = aux;
+    }
+  }
   return {
-    items: filteredList,
+    tags: filteredTags,
+    items,
     pageInfo: data.pageInfo
   };
 };
@@ -702,21 +769,22 @@ var InformationUnitsService = class extends BaseService {
     const remainFields = createParams(fields, "Fields");
     const remainFilters = createParams(filters, "Filter");
     const restrictions = createParams(restrict, "Restrict");
-    const languageParams = createParams(
-      languages.map((item) => `?s iirds:language '${item}'`),
-      "sparqlWhere"
-    );
+    const languageParam = `VALUES ?lang { ${languages.map((lang) => `"${lang}"`).join(" ")} } ?s iirds:language ?lang .`;
     const params = [
       { key: "pageSize", value: "12" },
       { key: "wildcard", value: wildcard.toLowerCase() },
       { key: "PageNumber", value: page.toString() },
       { key: "Operator", value: operator },
+      { key: "tags", value: "true" },
+      // TODO use customer config values and add a param to each one
       { key: "Like", value: like.toString() },
       ...remainFields,
-      ...languageParams,
       ...remainFilters,
       ...restrictions
     ];
+    if (languages.length > 0) {
+      params.push({ key: "sparqlWhere", value: languageParam });
+    }
     if (queries.length > 0) {
       params.push(
         { key: "Query", value: queries }
@@ -744,7 +812,9 @@ var InformationUnitsService = class extends BaseService {
       { key: "Fields", value: "titles" },
       { key: "Fields", value: "languages" },
       { key: "Fields", value: "labels" },
-      { key: "Fields", value: "packages" }
+      { key: "Fields", value: "packages" },
+      { key: "Fields", value: "created" },
+      { key: "Fields", value: "revision" }
     ];
     return await this.request({
       path: id,
@@ -773,10 +843,10 @@ var InformationUnitsService = class extends BaseService {
 };
 
 // src/language.ts
-var import_next_cookies3 = require("@c-rex/utils/next-cookies");
+var import_next_cookies4 = require("@c-rex/utils/next-cookies");
 var LanguageService = class extends BaseService {
   constructor() {
-    const configs = (0, import_next_cookies3.getConfigs)();
+    const configs = (0, import_next_cookies4.getConfigs)();
     super(configs.languageSwitcher.endpoint);
   }
   /**
@@ -811,12 +881,139 @@ var LanguageService = class extends BaseService {
     });
   }
 };
+
+// src/transforms/topics.ts
+var import_next_cookies5 = require("@c-rex/utils/next-cookies");
+var import_headers4 = require("next/headers");
+var import_logger3 = require("@c-rex/core/logger");
+var transformTopics = async (data) => {
+  const logger = new import_logger3.CrexLogger();
+  const config = (0, import_next_cookies5.getConfigs)();
+  const contentLang = ((0, import_headers4.cookies)().get(CONTENT_LANG_KEY)?.value || config.languageSwitcher.default).toLowerCase();
+  const items = data.items.map((item) => {
+    const type = item.class.labels.filter((item2) => item2.language === EN_LANG)[0].value.toUpperCase();
+    let link = `/topics/${item.shortId}`;
+    if (config.results.articlePageLayout == "BLOG") {
+      link = `/blog/${item.shortId}`;
+    } else if (type == RESULT_TYPES.DOCUMENT) {
+      link = `/documents/${item.shortId}`;
+    }
+    let title = "NO TITLE";
+    let language = "NO LANGUAGE";
+    try {
+      if (item.titles) {
+        title = item.titles[0].value;
+        language = item.titles[0].language;
+      } else {
+        title = item.labels[0].value;
+        language = item.labels[0].language;
+      }
+    } catch {
+      logger.log({
+        level: "error",
+        message: `No label or title on item ${item.shortId}`
+      });
+    }
+    let renditionUrl = "";
+    const renditions = item.renditions.filter((item2) => item2.format == "application/xhtml+xml");
+    if (renditions.length > 0 || renditions[0] !== void 0) {
+      const filteredLinks = renditions[0].links.filter((renditionItem) => renditionItem.rel == "view");
+      if (filteredLinks.length > 0 || filteredLinks[0] !== void 0) {
+        renditionUrl = filteredLinks[0].href;
+      }
+      ;
+    }
+    ;
+    let categoryType = type;
+    if (item.applicableForTypes && item.applicableForTypes.length > 0) {
+      const splittedContentLang = contentLang.split("-")[0];
+      categoryType = item.applicableForTypes[0].labels.find((item2) => item2.language === splittedContentLang)?.value || categoryType;
+    }
+    return {
+      language,
+      title,
+      type: categoryType,
+      localeType: "",
+      shortId: item.shortId,
+      created: formatDateToLocale(item.created, contentLang),
+      disabled: config.results.disabledResults.includes(type),
+      link,
+      renditionUrl,
+      image: null,
+      description: null
+    };
+  });
+  return {
+    tags: null,
+    items,
+    pageInfo: data.pageInfo
+  };
+};
+
+// src/topics.ts
+var TopicsService = class extends BaseService {
+  constructor() {
+    super("Topics/");
+  }
+  /**
+   * Retrieves a list of topics based on specified criteria.
+   * 
+   * @param options - Options for filtering and paginating the topics list
+   * @param options.queries - Optional search query string
+   * @param options.page - Optional page number for pagination (defaults to 1)
+   * @param options.fields - Optional array of fields to include in the response
+   * @param options.filters - Optional array of filter strings to apply
+   * @param options.languages - Optional array of language codes to filter by
+   * @returns A promise that resolves to the information units response
+   * @throws Error if the API request fails
+   */
+  async getList({
+    queries = "",
+    page = 1,
+    fields = [],
+    filters = [],
+    languages = [],
+    wildcard = WILD_CARD_OPTIONS.BOTH,
+    operator = OPERATOR_OPTIONS.AND,
+    pageSize = 12
+  }) {
+    const remainFields = createParams(fields, "Fields");
+    const remainFilters = createParams(filters, "Filter");
+    const languageParam = `VALUES ?lang { ${languages.map((lang) => `"${lang}"`).join(" ")} } ?s iirds:language ?lang .`;
+    const params = [
+      { key: "pageSize", value: pageSize.toString() },
+      { key: "PageNumber", value: page.toString() },
+      { key: "Sort", value: "-created;-score" },
+      ...remainFields,
+      ...remainFilters
+    ];
+    if (wildcard.length > 0) {
+      params.push({ key: "Operator", value: operator });
+    }
+    if (wildcard.length > 0) {
+      params.push({ key: "wildcard", value: wildcard.toLowerCase() });
+    }
+    if (languages.length > 0) {
+      params.push({ key: "sparqlWhere", value: languageParam });
+    }
+    if (queries.length > 0) {
+      params.push(
+        { key: "Query", value: queries }
+      );
+    }
+    return await this.request({
+      params,
+      transformer: transformTopics
+    });
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DirectoryNodesService,
   DocumentTypesService,
   InformationUnitsService,
   LanguageService,
-  RenditionsService
+  RenditionsService,
+  TopicsService
 });
 //# sourceMappingURL=index.js.map