@dotcms/client 0.0.1-alpha.36 → 0.0.1-alpha.38

package/src/lib/query-builder/sdk-query-builder.d.ts

@@ -1,7 +1,29 @@
 import { Equals, Field } from './lucene-syntax/index';
 /**
  * 'QueryBuilder' Is a Typescript class that provides the ability to build a query string using the Lucene syntax in a more readable way.
+ * @example
+ * ```ts
+ *  const qb = new QueryBuilder();
+ *  const query = qb
+ *          .field('contentType')
+ *          .equals('Blog')
+ *          .field('conhost')
+ *          .equals('my-super-cool-site')
+ *          .build(); // Output: `+contentType:Blog +conhost:my-super-cool-site"`
+ * ```
  *
+ * @example
+ * ```ts
+ *  const qb = new QueryBuilder();
+ *  const query = qb
+ *          .field('contentType')
+ *          .equals('Blog')
+ *          .field('title')
+ *          .equals('Football')
+ *          .excludeField('summary')
+ *          .equals('Lionel Messi')
+ *          .build(); // Output: `+contentType:Blog +title:Football -summary:"Lionel Messi"`
+ * ```
  * @export
  * @class QueryBuilder
  */
@@ -10,7 +32,11 @@ export declare class QueryBuilder {
     /**
      * This method appends to the query a field that should be included in the search.
      *
-     * Ex: "+myField:"
+     * @example
+     * ```ts
+     * const qb = new QueryBuilder();
+     * qb.field("+myField: ", "myValue"); // Current query: "+myField: myValue"
+     * ```
      *
      * @param {string} field - The field that should be included in the search.
      * @return {*}  {Field} -  An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
@@ -20,7 +46,11 @@ export declare class QueryBuilder {
     /**
      * This method appends to the query a field that should be excluded from the search.
      *
-     * Ex: "-myField:"
+     * @example
+     * ```ts
+     * const qb = new QueryBuilder();
+     * qb.excludeField("myField").equals("myValue"); // Current query: "-myField: myValue"
+     * ```
      *
      * @param {string} field - The field that should be excluded from the search.
      * @return {*}  {Field} -  An instance of a Lucene Exclude Field. An exclude field is a key used to exclude for a specific value in a document.
@@ -32,7 +62,11 @@ export declare class QueryBuilder {
      * This raw query should end in Equals.
      * This method is useful when you want to append a complex query or an already written query to the query builder.
      *
-     * Ex: "+myField: value AND (someOtherValue OR anotherValue)"
+     * @example
+     * ```ts
+     * const qb = new QueryBuilder();
+     * qb.raw("+myField: value AND (someOtherValue OR anotherValue)"); // Current query: "+myField: value AND (someOtherValue OR anotherValue)"
+     * ```
      *
      * @param {string} query - A raw query string.
      * @return {*}  {Equals} - An instance of Equals. A term is a value used to search for a specific value in a document.

package/src/lib/query-builder/utils/index.d.ts

@@ -16,6 +16,11 @@ export declare enum OPERAND {
 /**
  * This function removes extra spaces from a string.
  *
+ * @example
+ * ```ts
+ * sanitizeQuery("  my query  "); // Output: "my query"
+ * ```
+ *
  * @export
  * @param {string} str
  * @return {*}  {string}
@@ -25,6 +30,12 @@ export declare function sanitizeQuery(str: string): string;
  * This function sanitizes a term by adding quotes if it contains spaces.
  * In lucene, a term with spaces should be enclosed in quotes.
  *
+ * @example
+ * ```ts
+ * sanitizePhrases(`my term`); // Output: `"my term"`
+ * sanitizePhrases(`myterm`); // Output: `myterm`
+ * ```
+ *
  * @export
  * @param {string} term
  * @return {*}  {string}
@@ -34,6 +45,11 @@ export declare function sanitizePhrases(term: string): string;
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the term before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const equals = buildEquals("+myField: ", "myValue"); // Current query: "+myField: myValue"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} term
@@ -44,6 +60,12 @@ export declare function buildEquals(query: string, term: string): Equals;
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the raw query before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildRawEquals(query, "-myField2: myValue2"); // Current query: "+myField: myValue -myField2: myValue"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} raw
@@ -54,6 +76,11 @@ export declare function buildRawEquals(query: string, raw: string): Equals;
  * This function builds a field to be used in a lucene query.
  * We need to format the field before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const field = buildField("+myField: ", "myValue"); // Current query: "+myField: myValue"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} field
@@ -64,6 +91,12 @@ export declare function buildField(query: string, field: string): Field;
  * This function builds an exclude field to be used in a lucene query.
  * We need to format the field before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildExcludeField(query, "myField2"); // Current query: "+myField: myValue -myField2:"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} field
@@ -74,6 +107,18 @@ export declare function buildExcludeField(query: string, field: string): Field;
  * This function builds an operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
  *
+ * @example
+ * <caption>E.g. Using the AND operand</caption>
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildOperand(query, OPERAND.AND); // Current query: "+myField: myValue AND"
+ * ```
+ * @example
+ * <caption>E.g. Using the OR operand</caption>
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildOperand(query, OPERAND.OR); // Current query: "+myField: myValue OR"
+ * ```
  * @export
  * @param {string} query
  * @param {OPERAND} operand
@@ -84,6 +129,12 @@ export declare function buildOperand(query: string, operand: OPERAND): Operand;
  * This function builds a NOT operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildNotOperand(query); // Current query: "+myField: myValue NOT"
+ * ```
+ *
  * @export
  * @param {string} query
  * @return {*}  {NotOperand}

package/src/lib/utils/graphql/transforms.d.ts

@@ -1,11 +1,24 @@
-export declare const graphqlToPageEntity: ({ page }: {
+/**
+ * Represents the response from a GraphQL query for a page.
+ *
+ * @interface GraphQLPageResponse
+ * @property {Record<string, unknown>} page - The main page data.
+ * @property {unknown} [key: string] - Additional properties that may be included in the response.
+ */
+interface GraphQLPageResponse {
     page: Record<string, unknown>;
-}) => {
-    layout: unknown;
-    template: unknown;
-    viewAs: unknown;
-    urlContentMap: unknown;
-    site: unknown;
-    page: any;
-    containers: Record<string, unknown>;
-} | null;
+    [key: string]: unknown;
+}
+/**
+ * Transforms a GraphQL Page response to a Page Entity.
+ *
+ * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
+ * @returns {object|null} The transformed Page Entity or null if the page is not present.
+ *
+ * @example
+ * ```ts
+ * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
+ * ```
+ */
+export declare const graphqlToPageEntity: (graphQLPageResponse: GraphQLPageResponse) => any;
+export {};

package/src/lib/utils/page/common-utils.d.ts

@@ -1,11 +1,33 @@
-interface PageRequestParamsProps {
+import { PageApiOptions } from '../../client/sdk-js-client';
+/**
+ * Interface representing the properties for page request parameters.
+ *
+ * @export
+ * @interface PageRequestParamsProps
+ */
+export interface PageRequestParamsProps {
+    /**
+     * The API endpoint path.
+     * @type {string}
+     */
     path: string;
+    /**
+     * The query parameters for the API request.
+     * Can be an object with key-value pairs or a URLSearchParams instance.
+     * @type {{ [key: string]: unknown } | URLSearchParams}
+     */
     params: {
-        [key: string]: any;
-    } | undefined | URLSearchParams;
+        [key: string]: unknown;
+    } | URLSearchParams;
 }
-export declare const getPageRequestParams: ({ path, params }: PageRequestParamsProps) => {
-    path: string;
-    [key: string]: string | number;
-};
-export {};
+/**
+ * Generates the page request parameters to be used in the API call.
+ *
+ * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
+ * @returns {PageApiOptions} The options for the page API.
+ * @example
+ * ```ts
+ * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
+ * ```
+ */
+export declare const getPageRequestParams: ({ path, params }: PageRequestParamsProps) => PageApiOptions;