@c-rex/utils 0.1.3 → 0.1.5

package/dist/index.d.mts

@@ -1,44 +1,33 @@
-import { TreeOfContent, DirectoryNodes } from '@c-rex/interfaces';
+import { TreeOfContent, DirectoryNodes, informationUnitsRenditions } from '@c-rex/interfaces';
 import { ClassValue } from 'clsx';
-import { QueryParams } from '@c-rex/types';
+import { QueryParams, FileRenditionType } from '@c-rex/types';
 
-/**
- * Makes an asynchronous RPC API call to the server.
- * @param method - The RPC method name to call
- * @param params - Optional parameters to pass to the method
- * @returns A Promise resolving to the response data of type T, or null if an error occurs
- */
-declare const call: <T = unknown>(method: string, params?: any) => Promise<T>;
+declare const _generateShaKey: (input: string) => Promise<string>;
 /**
  * Retrieves the country code associated with a given language code.
  * @param lang - The language code to look up (e.g., "en-US")
  * @returns The corresponding country code, or the original language code if not found
  */
 declare const getCountryCodeByLang: (lang: string) => string;
+declare const getFromCookieString: (cookieString: string, key: string) => string;
 
-/**
- * Saves a value in memory on the server side.
- * @param value - The string value to save
- * @param key - The key under which to store the value
- * @throws Error if called in a browser environment
- */
-declare function saveInMemory(value: string, key: string): void;
-/**
- * Retrieves a value from memory on the server side.
- * @param key - The key of the value to retrieve
- * @returns The stored string value
- * @throws Error if called in a browser environment
- */
-declare function getFromMemory(key: string): string;
 /**
  * Fetches a cookie value from the server API in client-side code.
  * @param key - The key of the cookie to retrieve
  * @returns A Promise resolving to an object containing the key and value of the cookie
  */
-declare const getCookieInFront: (key: string) => Promise<{
+declare const getCookie: (key: string) => Promise<{
     key: string;
     value: string | null;
 }>;
+/**
+ * Sets a cookie value through the server API in client-side code.
+ * @param key - The key of the cookie to set
+ * @param value - The value to store in the cookie
+ * @param maxAge - Optional maximum age of the cookie in seconds. Defaults to DEFAULT_COOKIE_LIMIT if not specified.
+ * @returns A Promise that resolves when the cookie has been set
+ */
+declare const setCookie: (key: string, value: string, maxAge?: number) => Promise<void>;
 
 /**
  * Generates breadcrumb items by recursively extracting active items and their active children from a TreeOfContent array.
@@ -59,18 +48,7 @@ type ReturnType = {
     rootNode: DirectoryNodes | null;
     result: TreeOfContent[];
 };
-/**
- * Generates a hierarchical tree of content from directory nodes.
- * @param directoryNodes - Array of DirectoryNodes to build the tree from
- * @returns A Promise resolving to an object containing the root node and the resulting tree structure
- */
 declare const generateTreeOfContent: (directoryNodes: DirectoryNodes[]) => Promise<ReturnType>;
-/**
- * Gets the information unit ID from a directory node ID.
- * @param directoryNodeID - The ID of the directory node
- * @returns A Promise resolving to the information unit ID, or an empty string if not found
- */
-declare const getLink: (directoryNodeID: string) => Promise<string>;
 
 /**
  * Creates an array of parameter objects from a list of field values.
@@ -89,35 +67,22 @@ declare const createParams: (fieldsList: string[], key?: string) => {
  */
 declare const generateQueryParams: (params: QueryParams[]) => string;
 
+declare const manageToken: () => Promise<string | null>;
+
+type RenditionType = {
+    filesToDownload: FileRenditionType[];
+    filesToOpen: FileRenditionType[];
+};
+declare const getFileRenditions: ({ renditions }: {
+    renditions: informationUnitsRenditions[];
+}) => RenditionType;
+
 /**
- * Loads article data including content, tree structure, breadcrumbs, and available versions.
- * @param id - The ID of the article to load
- * @param type - The type of article ("documents" or "topics", defaults to "documents")
- * @returns A Promise resolving to an object containing the article data
+ * Makes an asynchronous RPC API call to the server.
+ * @param method - The RPC method name to call
+ * @param params - Optional parameters to pass to the method
+ * @returns A Promise resolving to the response data of type T
  */
-declare const loadArticleData: (id: string, type?: string) => Promise<{
-    htmlContent: string;
-    treeOfContent: TreeOfContent[];
-    breadcrumbItems: TreeOfContent[];
-    availableVersions: {
-        shortId: string;
-        link: string;
-        lang: string;
-        country: string;
-        active: boolean;
-    }[];
-    documents: {
-        filesToDownload: {
-            format: string;
-            link: string;
-        }[];
-        filesToOpen: {
-            format: string;
-            link: string;
-        }[];
-    };
-    title: string;
-    articleLanguage: string;
-}>;
+declare const call: <T = unknown>(method: string, params?: any) => Promise<T>;
 
-export { call, cn, createParams, generateBreadcrumbItems, generateQueryParams, generateTreeOfContent, getCookieInFront, getCountryCodeByLang, getFromMemory, getLink, loadArticleData, saveInMemory };
+export { _generateShaKey, call, cn, createParams, generateBreadcrumbItems, generateQueryParams, generateTreeOfContent, getCookie, getCountryCodeByLang, getFileRenditions, getFromCookieString, manageToken, setCookie };

package/dist/index.d.ts

@@ -1,44 +1,33 @@
-import { TreeOfContent, DirectoryNodes } from '@c-rex/interfaces';
+import { TreeOfContent, DirectoryNodes, informationUnitsRenditions } from '@c-rex/interfaces';
 import { ClassValue } from 'clsx';
-import { QueryParams } from '@c-rex/types';
+import { QueryParams, FileRenditionType } from '@c-rex/types';
 
-/**
- * Makes an asynchronous RPC API call to the server.
- * @param method - The RPC method name to call
- * @param params - Optional parameters to pass to the method
- * @returns A Promise resolving to the response data of type T, or null if an error occurs
- */
-declare const call: <T = unknown>(method: string, params?: any) => Promise<T>;
+declare const _generateShaKey: (input: string) => Promise<string>;
 /**
  * Retrieves the country code associated with a given language code.
  * @param lang - The language code to look up (e.g., "en-US")
  * @returns The corresponding country code, or the original language code if not found
  */
 declare const getCountryCodeByLang: (lang: string) => string;
+declare const getFromCookieString: (cookieString: string, key: string) => string;
 
-/**
- * Saves a value in memory on the server side.
- * @param value - The string value to save
- * @param key - The key under which to store the value
- * @throws Error if called in a browser environment
- */
-declare function saveInMemory(value: string, key: string): void;
-/**
- * Retrieves a value from memory on the server side.
- * @param key - The key of the value to retrieve
- * @returns The stored string value
- * @throws Error if called in a browser environment
- */
-declare function getFromMemory(key: string): string;
 /**
  * Fetches a cookie value from the server API in client-side code.
  * @param key - The key of the cookie to retrieve
  * @returns A Promise resolving to an object containing the key and value of the cookie
  */
-declare const getCookieInFront: (key: string) => Promise<{
+declare const getCookie: (key: string) => Promise<{
     key: string;
     value: string | null;
 }>;
+/**
+ * Sets a cookie value through the server API in client-side code.
+ * @param key - The key of the cookie to set
+ * @param value - The value to store in the cookie
+ * @param maxAge - Optional maximum age of the cookie in seconds. Defaults to DEFAULT_COOKIE_LIMIT if not specified.
+ * @returns A Promise that resolves when the cookie has been set
+ */
+declare const setCookie: (key: string, value: string, maxAge?: number) => Promise<void>;
 
 /**
  * Generates breadcrumb items by recursively extracting active items and their active children from a TreeOfContent array.
@@ -59,18 +48,7 @@ type ReturnType = {
     rootNode: DirectoryNodes | null;
     result: TreeOfContent[];
 };
-/**
- * Generates a hierarchical tree of content from directory nodes.
- * @param directoryNodes - Array of DirectoryNodes to build the tree from
- * @returns A Promise resolving to an object containing the root node and the resulting tree structure
- */
 declare const generateTreeOfContent: (directoryNodes: DirectoryNodes[]) => Promise<ReturnType>;
-/**
- * Gets the information unit ID from a directory node ID.
- * @param directoryNodeID - The ID of the directory node
- * @returns A Promise resolving to the information unit ID, or an empty string if not found
- */
-declare const getLink: (directoryNodeID: string) => Promise<string>;
 
 /**
  * Creates an array of parameter objects from a list of field values.
@@ -89,35 +67,22 @@ declare const createParams: (fieldsList: string[], key?: string) => {
  */
 declare const generateQueryParams: (params: QueryParams[]) => string;
 
+declare const manageToken: () => Promise<string | null>;
+
+type RenditionType = {
+    filesToDownload: FileRenditionType[];
+    filesToOpen: FileRenditionType[];
+};
+declare const getFileRenditions: ({ renditions }: {
+    renditions: informationUnitsRenditions[];
+}) => RenditionType;
+
 /**
- * Loads article data including content, tree structure, breadcrumbs, and available versions.
- * @param id - The ID of the article to load
- * @param type - The type of article ("documents" or "topics", defaults to "documents")
- * @returns A Promise resolving to an object containing the article data
+ * Makes an asynchronous RPC API call to the server.
+ * @param method - The RPC method name to call
+ * @param params - Optional parameters to pass to the method
+ * @returns A Promise resolving to the response data of type T
  */
-declare const loadArticleData: (id: string, type?: string) => Promise<{
-    htmlContent: string;
-    treeOfContent: TreeOfContent[];
-    breadcrumbItems: TreeOfContent[];
-    availableVersions: {
-        shortId: string;
-        link: string;
-        lang: string;
-        country: string;
-        active: boolean;
-    }[];
-    documents: {
-        filesToDownload: {
-            format: string;
-            link: string;
-        }[];
-        filesToOpen: {
-            format: string;
-            link: string;
-        }[];
-    };
-    title: string;
-    articleLanguage: string;
-}>;
+declare const call: <T = unknown>(method: string, params?: any) => Promise<T>;
 
-export { call, cn, createParams, generateBreadcrumbItems, generateQueryParams, generateTreeOfContent, getCookieInFront, getCountryCodeByLang, getFromMemory, getLink, loadArticleData, saveInMemory };
+export { _generateShaKey, call, cn, createParams, generateBreadcrumbItems, generateQueryParams, generateTreeOfContent, getCookie, getCountryCodeByLang, getFileRenditions, getFromCookieString, manageToken, setCookie };