@finsweet/webflow-apps-utils 1.0.2 → 1.0.3

package/dist/utils/browser-storage/sessionStorage.js

@@ -1,6 +1,5 @@
 /**
- * Check if sessionStorage is available in the current environment.
- * @returns {boolean} True if sessionStorage is accessible, false otherwise.
+ * Checks if sessionStorage is available in the current environment.
  */
 import { getLogger } from '../logger';
 const logger = getLogger('webflow-apps-ui-utils');
@@ -18,9 +17,7 @@ export const isSessionStorageAvailable = () => {
     }
 };
 /**
- * A utility function for getting a value from sessionStorage.
- * @param {string} key - The key to retrieve the value for.
- * @returns {string | null} The value associated with the key, or null if not found or sessionStorage is not available.
+ * Gets a value from sessionStorage.
  */
 export const getSessionStorage = (key) => {
     if (isSessionStorageAvailable()) {
@@ -30,10 +27,7 @@ export const getSessionStorage = (key) => {
     return null;
 };
 /**
- * A utility function for setting a value in sessionStorage.
- * @param {string} key - The key to set the value for.
- * @param {string} value - The value to be stored.
- * @returns {boolean} True if the operation succeeded, false otherwise (or if sessionStorage is not available).
+ * Sets a value in sessionStorage.
  */
 export const setSessionStorage = (key, value) => {
     if (isSessionStorageAvailable()) {
@@ -43,9 +37,7 @@ export const setSessionStorage = (key, value) => {
     return false;
 };
 /**
- * A utility function for removing a value from sessionStorage.
- * @param key - The key to remove the value for.
- * @returns {boolean} True if the operation succeeded, false otherwise (or if sessionStorage is not available).
+ * Removes a value from sessionStorage.
  */
 export const removeSessionStorage = (key) => {
     if (isSessionStorageAvailable()) {

package/dist/utils/custom-code/api.d.ts

@@ -1,17 +1,13 @@
 import type { CustomCodeBlock } from '../../types';
 /**
- * A utility function for getting stored Custom Code based on id.
- * @param {string} id - The Custom Code block ID identifier. If not provided, all stored configs will be returned.
- * @returns {CustomCodeBlock | null} The stored configs, or null if not found.
+ * Gets stored Custom Code blocks by ID or returns all if no ID provided.
  */
 export declare const getCustomCode: (id?: string) => Promise<Array<CustomCodeBlock>>;
 /**
- * A utility function for setting a value in Custom Code.
- * @param {CustomCodeBlock} customCodeBlock - The custom code block to be stored.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ * Sets custom code blocks in the site.
  */
 export declare const setCustomCode: (customCodeBlock: Array<CustomCodeBlock>) => Promise<void>;
 /**
- * A utility function for removing Custom Code block.
+ * Removes a custom code block.
  */
 export declare const removeCustomCode: () => boolean;

package/dist/utils/custom-code/api.js

@@ -1,9 +1,7 @@
 import { getLogger } from '../logger';
 const logger = getLogger('webflow-apps-ui-utils');
 /**
- * A utility function for getting stored Custom Code based on id.
- * @param {string} id - The Custom Code block ID identifier. If not provided, all stored configs will be returned.
- * @returns {CustomCodeBlock | null} The stored configs, or null if not found.
+ * Gets stored Custom Code blocks by ID or returns all if no ID provided.
  */
 export const getCustomCode = async (id) => {
     //TODO: update this when typings are available plus any other place we have disabled this warning.
@@ -19,9 +17,7 @@ export const getCustomCode = async (id) => {
     return [];
 };
 /**
- * A utility function for setting a value in Custom Code.
- * @param {CustomCodeBlock} customCodeBlock - The custom code block to be stored.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ * Sets custom code blocks in the site.
  */
 export const setCustomCode = async (customCodeBlock) => {
     try {
@@ -33,7 +29,7 @@ export const setCustomCode = async (customCodeBlock) => {
     }
 };
 /**
- * A utility function for removing Custom Code block.
+ * Removes a custom code block.
  */
 export const removeCustomCode = () => {
     //TODO: implement when available

package/dist/utils/helpers/cleanupTooltipMessage.d.ts

@@ -1,5 +1,4 @@
 /**
- * Handle fullstop at the end of the message.
- * @param message
+ * Handles fullstop placement at the end of tooltip messages.
  */
 export declare const cleanupTooltipMessage: (message: string) => string;

package/dist/utils/helpers/cleanupTooltipMessage.js

@@ -1,6 +1,5 @@
 /**
- * Handle fullstop at the end of the message.
- * @param message
+ * Handles fullstop placement at the end of tooltip messages.
  */
 export const cleanupTooltipMessage = (message) => {
     if (!message?.trim())

package/dist/utils/helpers/goto.d.ts

@@ -1,7 +1,4 @@
 /**
- * Navigate to a new path. This uses the current hash from the router store.
- * It then users svelte-routing's navigate function to navigate to the new path.
- * @param path - The path to navigate to. Defaults to '/'.
- * @param state - The state to pass to the new path. Read more about state here: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState
+ * Navigates to a new path using the router store hash.
  */
 export declare const goto: (path?: string, state?: Record<string, unknown>) => void;

package/dist/utils/helpers/goto.js

@@ -4,9 +4,7 @@ import { routerStore } from '../../stores';
 import { getLogger } from '../logger';
 const logger = getLogger('webflow-apps-ui-utils');
 /**
- * Normalize a URL path to ensure it starts with a single slash and is parsed correctly by the URL constructor.
- * @param path
- * @returns
+ * Normalizes a URL path to ensure proper formatting.
  */
 const normalizeUrlPath = (path, hash) => {
     const safePath = path.replace(/([^:]\/)\/+/g, '$1');
@@ -18,10 +16,7 @@ const normalizeUrlPath = (path, hash) => {
     return url;
 };
 /**
- * Navigate to a new path. This uses the current hash from the router store.
- * It then users svelte-routing's navigate function to navigate to the new path.
- * @param path - The path to navigate to. Defaults to '/'.
- * @param state - The state to pass to the new path. Read more about state here: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState
+ * Navigates to a new path using the router store hash.
  */
 export const goto = (path = '/', state = {}) => {
     const { hash = '' } = get(routerStore);

package/dist/utils/helpers/index.d.ts

@@ -2,4 +2,5 @@ export * from './cleanupTooltipMessage';
 export * from './goto';
 export * from './noop';
 export * from './numbers';
+export * from './objectsToModuleExports';
 export * from './trimText';

package/dist/utils/helpers/index.js

@@ -2,4 +2,5 @@ export * from './cleanupTooltipMessage';
 export * from './goto';
 export * from './noop';
 export * from './numbers';
+export * from './objectsToModuleExports';
 export * from './trimText';

package/dist/utils/helpers/noop.d.ts

@@ -1,4 +1,4 @@
 /**
- * It literally does nothing.
+ * No-operation function that does nothing.
  */
 export declare const noop: (value?: unknown) => unknown;

package/dist/utils/helpers/noop.js

@@ -1,5 +1,5 @@
 /**
- * It literally does nothing.
+ * No-operation function that does nothing.
  */
 export const noop = (value) => {
     // No operation.

package/dist/utils/helpers/numbers.d.ts

@@ -1,27 +1,17 @@
 /**
- * Converts a string to a number, removing any invalid symbols like `$` or `,`.
- * @param value A string number.
- * @returns The valid number value.
+ * Converts a string to a number, removing invalid symbols.
  */
 export declare const normalizeNumber: (value: string) => number | undefined;
 /**
- * Parses a numeric Attribute string.
- * @param rawValue The raw string. Example: "20", "-25.3"...
- * @param fallback A value to fall back to when the parsed value is not valid.
+ * Parses a numeric attribute string with fallback support.
  */
 export declare function parseNumericAttribute(rawValue: string | number | null | undefined, fallback: number): number;
 export declare function parseNumericAttribute(rawValue: string | number | null | undefined, fallback?: number | null): number | null;
 /**
- * Calculates the amount of decimals that a float number has.
- * @param value A number.
+ * Calculates the number of decimal places in a float.
  */
 export declare const getDecimalPrecision: (value: number) => number;
 /**
- * Adjusts a numeric value to a step factor.
- * @param value The numeric value to adjust.
- * @param step The increment step.
- * @param precision The step's decimal precision. If not provided, it will be calculated.
- * @param minRange A minimum range value, used for offsetting.
- * @returns The adjusted value.
+ * Adjusts a numeric value to align with a step factor.
  */
 export declare const adjustValueToStep: (value: number, step: number, precision?: number, minRange?: number) => number;

package/dist/utils/helpers/numbers.js

@@ -1,7 +1,5 @@
 /**
- * Converts a string to a number, removing any invalid symbols like `$` or `,`.
- * @param value A string number.
- * @returns The valid number value.
+ * Converts a string to a number, removing invalid symbols.
  */
 export const normalizeNumber = (value) => {
     if (!value)
@@ -19,8 +17,7 @@ export function parseNumericAttribute(rawValue, fallback) {
     return null;
 }
 /**
- * Calculates the amount of decimals that a float number has.
- * @param value A number.
+ * Calculates the number of decimal places in a float.
  */
 export const getDecimalPrecision = (value) => {
     if (!isFinite(value))
@@ -34,21 +31,14 @@ export const getDecimalPrecision = (value) => {
     return precision;
 };
 /**
- * Ensures a decimal precision on a number.
- * @param value The number to handle.
- * @param precision The amount of decimals.
+ * Ensures a specific decimal precision on a number.
  */
 const setDecimalPrecision = (value, precision) => {
     const pow = Math.pow(10, precision);
     return Math.round(value * pow) / pow;
 };
 /**
- * Adjusts a numeric value to a step factor.
- * @param value The numeric value to adjust.
- * @param step The increment step.
- * @param precision The step's decimal precision. If not provided, it will be calculated.
- * @param minRange A minimum range value, used for offsetting.
- * @returns The adjusted value.
+ * Adjusts a numeric value to align with a step factor.
  */
 export const adjustValueToStep = (value, step, precision, minRange = 0) => {
     precision ??= getDecimalPrecision(step);

package/dist/utils/helpers/objectsToModuleExports.d.ts

@@ -1,7 +1,5 @@
 /**
- * Converts an array of objects to a single string containing multiple module export statements.
- * @param exportsArray - Array of objects with variable names and objects.
- * @returns The combined module export string.
+ * Converts an array of objects to module export statements.
  */
 export declare const objectsToModuleExports: (exportsArray: Array<{
     moduleName: string;

package/dist/utils/helpers/objectsToModuleExports.js

@@ -1,7 +1,5 @@
 /**
- * Converts an array of objects to a single string containing multiple module export statements.
- * @param exportsArray - Array of objects with variable names and objects.
- * @returns The combined module export string.
+ * Converts an array of objects to module export statements.
  */
 export const objectsToModuleExports = (exportsArray) => {
     return exportsArray

package/dist/utils/helpers/trimText.d.ts

@@ -1,15 +1,8 @@
 /**
- * Trims the given text in the middle and adds ellipsis if it exceeds the specified maximum length.
- *
- * @param text - The input text to be trimmed.
- * @param maxLength - The maximum length of the trimmed text. Default is 40.
- * @returns The trimmed text with ellipsis in the middle, if applicable.
+ * Trims text in the middle and adds ellipsis if it exceeds the maximum length.
  */
 export declare const trimText: (text: string, maxLength?: number) => string | undefined;
 /**
  * Trims whitespaces and extra spaces in a given text.
- *
- * @param text - The input text to be trimmed.
- * @returns The trimmed text with removed extra spaces.
  */
 export declare const trimExtraSpaces: (text: string) => string | undefined;

package/dist/utils/helpers/trimText.js

@@ -1,9 +1,5 @@
 /**
- * Trims the given text in the middle and adds ellipsis if it exceeds the specified maximum length.
- *
- * @param text - The input text to be trimmed.
- * @param maxLength - The maximum length of the trimmed text. Default is 40.
- * @returns The trimmed text with ellipsis in the middle, if applicable.
+ * Trims text in the middle and adds ellipsis if it exceeds the maximum length.
  */
 export const trimText = (text, maxLength = 40) => {
     if (!text)
@@ -18,9 +14,6 @@ export const trimText = (text, maxLength = 40) => {
 };
 /**
  * Trims whitespaces and extra spaces in a given text.
- *
- * @param text - The input text to be trimmed.
- * @returns The trimmed text with removed extra spaces.
  */
 export const trimExtraSpaces = (text) => {
     if (!text)

package/dist/utils/index.d.ts

@@ -1,4 +1,8 @@
+export * from './api';
 export * from './auth';
+export * from './browser-storage';
 export * from './constants';
+export * from './custom-code';
 export * from './helpers';
 export * from './logger';
+export * from './webflow-canvas';

package/dist/utils/index.js

@@ -1,4 +1,8 @@
+export * from './api';
 export * from './auth';
+export * from './browser-storage';
 export * from './constants';
+export * from './custom-code';
 export * from './helpers';
 export * from './logger';
+export * from './webflow-canvas';

package/dist/utils/logger/index.d.ts

@@ -13,7 +13,5 @@ export interface Logger {
 }
 /**
  * Create a logger instance for the given context
- * @param context - The context/identity for this logger instance
- * @returns Logger instance with all log methods
  */
 export declare function getLogger(context: LoggerContext): Logger;

package/dist/utils/logger/index.js

@@ -2,8 +2,6 @@
 import { getFinsweetComponentsEnvironment } from '../api';
 /**
  * Create a logger instance for the given context
- * @param context - The context/identity for this logger instance
- * @returns Logger instance with all log methods
  */
 export function getLogger(context) {
     const createLogMethod = (level) => {

package/dist/utils/webflow-canvas/attributes/getAllWebflowElementAttributes.d.ts

@@ -1,6 +1,4 @@
 /**
- * Retrieves all custom attributes from a Webflow element.
- * @param {AnyElement} params.element - The data object of the element.
- * @returns
+ * Gets all custom attributes from a Webflow element.
  */
 export declare const getAllWebflowElementAttributes: (element: AnyElement) => Promise<NamedValue[] | null>;

package/dist/utils/webflow-canvas/attributes/getAllWebflowElementAttributes.js

@@ -1,9 +1,7 @@
 import { getLogger } from '../../logger';
 const logger = getLogger('webflow-apps-ui-utils');
 /**
- * Retrieves all custom attributes from a Webflow element.
- * @param {AnyElement} params.element - The data object of the element.
- * @returns
+ * Gets all custom attributes from a Webflow element.
  */
 export const getAllWebflowElementAttributes = async (element) => {
     try {

package/dist/utils/webflow-canvas/attributes/getInstanceNamesFromObject.d.ts

@@ -1,8 +1,4 @@
 /**
- * Get the instance names from an object
- * @param obj - The object to get the instance names from
- * @param component - The component key
- * @param hasInstances - Whether the object has instances
- * @returns The instance names
+ * Gets instance names from an object based on component configuration.
  */
 export declare const getInstanceNamesFromObject: (obj: Record<string, any>, component: string, hasInstances?: boolean) => string[];

package/dist/utils/webflow-canvas/attributes/getInstanceNamesFromObject.js

@@ -1,10 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /**
- * Get the instance names from an object
- * @param obj - The object to get the instance names from
- * @param component - The component key
- * @param hasInstances - Whether the object has instances
- * @returns The instance names
+ * Gets instance names from an object based on component configuration.
  */
 export const getInstanceNamesFromObject = (obj, component, hasInstances) => {
     if (!obj || typeof obj !== 'object')

package/dist/utils/webflow-canvas/attributes/getWebflowElementAttribute.d.ts

@@ -1,7 +1,4 @@
 /**
- * Retrieves the value of a custom attribute on a Webflow element.
- * @param {AnyElement} params.element - The data object of the element.
- * @param {String} params.attributeName - The name of the custom attribute to set.
- * @returns
+ * Gets the value of a custom attribute from a Webflow element.
  */
 export declare const getWebflowElementAttribute: (element: AnyElement, attributeName: string) => Promise<string | null>;

package/dist/utils/webflow-canvas/attributes/getWebflowElementAttribute.js

@@ -1,10 +1,7 @@
 import { getLogger } from '../../logger';
 const logger = getLogger('webflow-apps-ui-utils');
 /**
- * Retrieves the value of a custom attribute on a Webflow element.
- * @param {AnyElement} params.element - The data object of the element.
- * @param {String} params.attributeName - The name of the custom attribute to set.
- * @returns
+ * Gets the value of a custom attribute from a Webflow element.
  */
 export const getWebflowElementAttribute = async (element, attributeName) => {
     try {

package/dist/utils/webflow-canvas/attributes/getWebflowElementTextContent.d.ts

@@ -1,6 +1,4 @@
 /**
- * Get the text content of the webflow element
- * @param el
- * @returns
+ * Gets the text content of a Webflow element.
  */
 export declare const getWebflowElementTextContent: (selectedElement: AnyElement) => Promise<string>;

package/dist/utils/webflow-canvas/attributes/getWebflowElementTextContent.js

@@ -1,7 +1,5 @@
 /**
- * Get the text content of the webflow element
- * @param el
- * @returns
+ * Gets the text content of a Webflow element.
  */
 export const getWebflowElementTextContent = async (selectedElement) => {
     const textContent = [];

package/dist/utils/webflow-canvas/attributes/removeWebflowElementAttribute.d.ts

@@ -1,7 +1,4 @@
 /**
- *  Removes the specified attribute from the DOMElement.
- *  @param {AnyElement} params.element - The data object of the element.
- *  @param {String} params.attributeName - The name of the custom attribute to remove.
- *  @param {Boolean} params.notify - Whether to show a notification after the attribute is removed.
+ * Removes a custom attribute from a Webflow element.
  */
 export declare const removeWebflowElementAttribute: (element: AnyElement, attributeName: string, notify?: boolean) => Promise<null | undefined>;

package/dist/utils/webflow-canvas/attributes/removeWebflowElementAttribute.js

@@ -1,10 +1,7 @@
 import { getLogger } from '../../logger';
 const logger = getLogger('webflow-apps-ui-utils');
 /**
- *  Removes the specified attribute from the DOMElement.
- *  @param {AnyElement} params.element - The data object of the element.
- *  @param {String} params.attributeName - The name of the custom attribute to remove.
- *  @param {Boolean} params.notify - Whether to show a notification after the attribute is removed.
+ * Removes a custom attribute from a Webflow element.
  */
 export const removeWebflowElementAttribute = async (element, attributeName, notify = true) => {
     try {

package/dist/utils/webflow-canvas/attributes/setStyles.d.ts

@@ -3,8 +3,6 @@ export interface StyleProps {
     style: PropertyMap;
 }
 /**
- * Create or Update style and apply it to the selected element
- * @param styles
- * @param element
+ * Creates or updates styles and applies them to the selected element.
  */
 export declare const setStyles: (styles: StyleProps[], element: AnyElement) => Promise<void>;

package/dist/utils/webflow-canvas/attributes/setStyles.js

@@ -1,7 +1,5 @@
 /**
- * Create or Update style and apply it to the selected element
- * @param styles
- * @param element
+ * Creates or updates styles and applies them to the selected element.
  */
 export const setStyles = async (styles, element) => {
     const promises = styles.map(async ({ name, style }) => {

package/dist/utils/webflow-canvas/attributes/setWebflowElementAttribute.d.ts

@@ -1,11 +1,4 @@
 /**
- * Sets the value of a custom attribute to a Webflow element.
- * If the attribute already exists, it will not be updated by default.
- * To update the attribute, the existing value must be different from the new value.
- * @param {AnyElement} params.element - The data object of the element.
- * @param {String} params.attributeName - The name of the custom attribute to set.
- * @param {String} params.attributeValue - The value of the custom attribute to set.
- *  @param {Boolean} params.notify - Whether to show a notification after the attribute is removed.
- * @returns
+ * Sets a custom attribute value on a Webflow element.
  */
 export declare const setWebflowElementAttribute: (element: AnyElement, attributeName: string, attributeValue: string, notify?: boolean) => Promise<void>;

package/dist/utils/webflow-canvas/attributes/setWebflowElementAttribute.js

@@ -2,14 +2,7 @@ import { getLogger } from '../../logger';
 import { getWebflowElementAttribute } from './getWebflowElementAttribute';
 const logger = getLogger('webflow-apps-ui-utils');
 /**
- * Sets the value of a custom attribute to a Webflow element.
- * If the attribute already exists, it will not be updated by default.
- * To update the attribute, the existing value must be different from the new value.
- * @param {AnyElement} params.element - The data object of the element.
- * @param {String} params.attributeName - The name of the custom attribute to set.
- * @param {String} params.attributeValue - The value of the custom attribute to set.
- *  @param {Boolean} params.notify - Whether to show a notification after the attribute is removed.
- * @returns
+ * Sets a custom attribute value on a Webflow element.
  */
 export const setWebflowElementAttribute = async (element, attributeName, attributeValue, notify = true) => {
     try {
@@ -47,11 +40,6 @@ export const setWebflowElementAttribute = async (element, attributeName, attribu
 };
 /**
  * Checks if the specified attribute exists on a Webflow element and matches the provided value.
- *
- * @param {AnyElement} element - The Webflow element to check.
- * @param {string} attributeName - The name of the attribute to find.
- * @param {string} attributeValue - The value to compare against the found attribute.
- * @return {boolean} - Returns true if the attribute exists and matches the provided value, otherwise false.
  */
 const checkAttribute = async (element, attributeName, attributeValue) => {
     const elementAttribute = await getWebflowElementAttribute(element, attributeName);

package/dist/utils/webflow-canvas/findInstanceElement.d.ts

@@ -22,11 +22,5 @@ export interface FindElementByReferenceProps {
 }
 /**
  * Searches for an instance inside or outside a component by its index.
- * @param targetIndex - The index of the instance to get.
- * @param instance - The instance to search for.
- * @param allElements - The elements to search through.
- * @param signal - AbortSignal for cancelling the operation.
- * @param selectElement - Whether to select the element when found.
- * @returns The element match with its component if applicable.
  */
 export declare const findInstanceElement: ({ targetIndex, instance, component, allElements, signal, selectElement }: GetElementFromComponentProps) => Promise<ElementFromComponentMatch | null>;

package/dist/utils/webflow-canvas/findInstanceElement.js

@@ -3,7 +3,7 @@ import { getLogger } from '../logger';
 import { getWebflowElementAttribute } from './attributes';
 const logger = getLogger('utils');
 /**
- * Exit the current component
+ * Exits the current component context.
  */
 const exitComponent = async () => {
     try {
@@ -15,12 +15,6 @@ const exitComponent = async () => {
 };
 /**
  * Searches for an instance inside or outside a component by its index.
- * @param targetIndex - The index of the instance to get.
- * @param instance - The instance to search for.
- * @param allElements - The elements to search through.
- * @param signal - AbortSignal for cancelling the operation.
- * @param selectElement - Whether to select the element when found.
- * @returns The element match with its component if applicable.
  */
 export const findInstanceElement = async ({ targetIndex, instance, component, allElements, signal, selectElement = false }) => {
     if (signal?.aborted)

package/dist/utils/webflow-canvas/getAllPages.d.ts

@@ -9,21 +9,14 @@ export type PageWithProps = {
     isPasswordProtected: boolean;
 };
 /**
- * Generates a slug for a page or folder
- * @param page - The page or folder to generate a slug for
- * @returns The slug for the page or folder
+ * Generates a slug for a page or folder.
  */
 export declare const getPathname: (page: Page | Folder) => Promise<string>;
 /**
- * Returns a single page with all its properties
- * @param page - The page to get
- * @param stagingUrl - The staging URL
- * @returns The page with all its properties
+ * Returns a single page with all its properties.
  */
 export declare const getPageMetadata: (page: Page) => Promise<PageWithProps>;
 /**
- * Returns all pages and folders from the Webflow project
- * @param pagesAndFolders - If true, returns both pages and folders, else only pages
- * @param kind - Filter pages by kind
+ * Returns all pages and folders from the Webflow project.
  */
 export declare const getAllPages: (pagesAndFolders?: boolean, kind?: PageWithProps["kind"]) => Promise<PageWithProps[]>;

package/dist/utils/webflow-canvas/getAllPages.js

@@ -2,9 +2,7 @@ import { getLogger } from '../logger';
 const logger = getLogger('webflow-apps-ui-utils');
 let pageStagingUrl;
 /**
- * Generates a slug for a page or folder
- * @param page - The page or folder to generate a slug for
- * @returns The slug for the page or folder
+ * Generates a slug for a page or folder.
  */
 export const getPathname = async (page) => {
     const parent = await page.getParent();
@@ -20,10 +18,7 @@ export const getPathname = async (page) => {
     return fullSlug.startsWith('/') ? fullSlug : `/${fullSlug}`;
 };
 /**
- * Returns a single page with all its properties
- * @param page - The page to get
- * @param stagingUrl - The staging URL
- * @returns The page with all its properties
+ * Returns a single page with all its properties.
  */
 export const getPageMetadata = async (page) => {
     if (!pageStagingUrl) {
@@ -55,9 +50,7 @@ export const getPageMetadata = async (page) => {
     };
 };
 /**
- * Returns all pages and folders from the Webflow project
- * @param pagesAndFolders - If true, returns both pages and folders, else only pages
- * @param kind - Filter pages by kind
+ * Returns all pages and folders from the Webflow project.
  */
 export const getAllPages = async (pagesAndFolders, kind) => {
     try {

package/dist/utils/webflow-canvas/getSiteStagingUrl.d.ts

@@ -1,7 +1,4 @@
 /**
- * Returns a valid webflow project staging URL.
- * @param {boolean} origin - If true, returns the origin URL (without https:// and without trailing slash).
- * @param {boolean} stagingName - If true, returns the staging name (without .webflow.io).
- * @returns {string}
+ * Returns a valid Webflow project staging URL.
  */
 export declare const getSiteStagingUrl: (origin?: boolean, stagingName?: boolean) => Promise<string>;