@plone/volto 17.2.0 → 17.4.0

package/types/helpers/Url/Url.d.ts

@@ -0,0 +1,145 @@
+/**
+ * Get id from url.
+ * @function getId
+ * @param {string} url Url to be parsed.
+ * @return {string} Id of content object.
+ */
+export function getId(url: string): string;
+/**
+ * Get view of an url.
+ * @function getView
+ * @param {string} url Url to be parsed.
+ * @return {string} View of content object.
+ */
+export function getView(url: string): string;
+/**
+ * Flatten to app server URL - Given a URL if it starts with the API server URL
+ * this method flattens it (removes) the server part
+ * TODO: Update it when implementing non-root based app location (on a
+ * directory other than /, eg. /myapp)
+ * @method flattenToAppURL
+ * @param {string} url URL of the object
+ * @returns {string} Flattened URL to the app server
+ */
+export function flattenToAppURL(url: string): string;
+/**
+ * Given a URL it remove the querystring from the URL.
+ * @method stripQuerystring
+ * @param {string} url URL of the object
+ * @returns {string} URL without querystring
+ */
+export function stripQuerystring(url: string): string;
+/**
+ * Given a URL if it starts with the API server URL
+ * this method removes the /api or the /Plone part.
+ * @method toPublicURL
+ * @param {string} url URL of the object
+ * @returns {string} public URL
+ */
+export function toPublicURL(url: string): string;
+/**
+ * Flatten to app server HTML - Given a text if it contains some urls that starts
+ * with the API server URL this method flattens it (removes) the server part.
+ * TODO: Update it when implementing non-root based app location (on a
+ * directory other than /, eg. /myapp)
+ * @method flattenHTMLToAppURL
+ * @param {string} html Some html snippet
+ * @returns {string} Same HTML with Flattened URLs to the app server
+ */
+export function flattenHTMLToAppURL(html: string): string;
+/**
+ * Add the app url
+ * @method addAppURL
+ * @param {string} url URL of the object
+ * @returns {string} New URL with app
+ */
+export function addAppURL(url: string): string;
+/**
+ * Given a URL expands it to the backend URL
+ * Useful when you have to actually call the backend from the
+ * frontend code (eg. ICS calendar download)
+ * It is seamless mode aware
+ * @method expandToBackendURL
+ * @param {string} url URL or path of the object
+ * @returns {string} New URL with the backend URL
+ */
+export function expandToBackendURL(path: any): string;
+/**
+ * Check if internal url
+ * @method isInternalURL
+ * @param {string} url URL of the object
+ * @returns {boolean} True if internal url
+ */
+export function isInternalURL(url: string): boolean;
+/**
+ * Check if it's a valid url
+ * @method isUrl
+ * @param {string} url URL of the object
+ * @returns {boolean} True if is a valid url
+ */
+export function isUrl(url: string): boolean;
+/**
+ * Normalize URL, adds protocol (if required eg. user has not entered the protocol)
+ * @method normalizeUrl
+ * @param {string} url URL of the object
+ * @returns {boolean} URL with the protocol
+ */
+export function normalizeUrl(url: string): boolean;
+/**
+ * Removes protocol from URL (for display)
+ * @method removeProtocol
+ * @param {string} url URL of the object
+ * @returns {string} URL without the protocol part
+ */
+export function removeProtocol(url: string): string;
+export function isMail(text: any): boolean;
+export function isTelephone(text: any): boolean;
+export function normaliseMail(email: any): any;
+export function normalizeTelephone(tel: any): any;
+export function checkAndNormalizeUrl(url: any): {
+    isMail: boolean;
+    isTelephone: boolean;
+    url: any;
+    isValid: boolean;
+};
+/**
+ * Given an image info object, it does flatten all the scales information to
+ * match the ones stored in the catalog
+ * 'http://localhost:3000/{path}/@@images/{scalefile}' -> '@images/{scalefile}'
+ * @function flattenScales
+ * @param {string} path path of the content object
+ * @param {object} image image information object
+ * @returns {object} New object with the flattened scale URLs
+ */
+export function flattenScales(path: string, image: object): object;
+/**
+ * Get base url.
+ * @function getBaseUrl
+ * @param {string} url Url to be parsed.
+ * @return {string} Base url of content object.
+ */
+export const getBaseUrl: ((url: any) => any) & import("lodash").MemoizedFunction;
+/**
+ * Get parent url.
+ * @function getParentUrl
+ * @param {string} url Url to be parsed.
+ * @return {string} Parent url of content object.
+ */
+export const getParentUrl: ((url: any) => any) & import("lodash").MemoizedFunction;
+/**
+ * Returns true if the current view is a cms ui view
+ * @method isCmsUi
+ * @param {string} currentPathname pathname of the current view
+ * @returns {boolean} true if the current view is a cms ui view
+ */
+export const isCmsUi: ((currentPathname: any) => any) & import("lodash").MemoizedFunction;
+export function getFieldURL(data: object): string | any;
+export namespace URLUtils {
+    export { normalizeTelephone };
+    export { normaliseMail };
+    export { normalizeUrl };
+    export { isTelephone };
+    export { isMail };
+    export { isUrl };
+    export { checkAndNormalizeUrl };
+}

package/types/helpers/Url/Url.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/helpers/Url/urlRegex.d.ts

@@ -0,0 +1,3 @@
+export function mailRegex(): RegExp;
+export function telRegex(): RegExp;
+export function urlRegex(_opts: any): RegExp;

package/types/helpers/User/User.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Checks if the user has one or more given roles.
+ * @method userHasRoles
+ * @returns {boolean}
+ */
+export function userHasRoles(user: any, roles?: any[]): boolean;

package/types/helpers/Utils/Date.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Friendly formatting for dates
+ */
+export function formatDate({ date, format, locale, long, includeTime, formatToParts, }: {
+    date: any;
+    format: any;
+    locale?: string;
+    long: any;
+    includeTime: any;
+    formatToParts?: boolean;
+}): string | Intl.DateTimeFormatPart[];
+export function formatRelativeDate({ date, locale, relativeTo, style, formatToParts, }: {
+    date: any;
+    locale?: string;
+    relativeTo: any;
+    style?: string;
+    formatToParts?: boolean;
+}): string | Intl.RelativeTimeFormatPart[];
+export namespace short_date_format {
+    let year: string;
+    let month: string;
+    let day: string;
+}
+export namespace short_date_and_time_format {
+    let dateStyle: string;
+    let timeStyle: string;
+}
+export namespace long_date_format {
+    let dateStyle_1: string;
+    export { dateStyle_1 as dateStyle };
+    let timeStyle_1: string;
+    export { timeStyle_1 as timeStyle };
+}
+export function toDate(d: any): any;

package/types/helpers/Utils/Date.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/helpers/Utils/UseDetectClickOutside.stories.d.ts

@@ -0,0 +1,11 @@
+export const Default: any;
+export const WithPortal: any;
+export const WithPortalAndPopper: any;
+export const WithPortalAndPopperUsingBlockChooser: any;
+declare namespace _default {
+    export let title: string;
+    export { TestComponent as component };
+    export let decorators: ((Story: any) => JSX.Element)[];
+}
+export default _default;
+declare function TestComponent(props: any): JSX.Element;

package/types/helpers/Utils/Utils.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Deep diff between two object, using lodash
+ * @param  {Object} object Object compared
+ * @param  {Object} base   Object to compare with
+ * @return {Object}        Return a new object who represent the diff
+ */
+export function difference(object: any, base: any): any;
+/**
+ * A helper to pipe a configuration object through configuration loaders
+ *
+ * @param {Array} configMethods A list of configuration methods
+ * @param {Object} config The Volto singleton config object
+ */
+export function applyConfig(configMethods: any[], config: any): any;
+/**
+ * A HOC factory that propagates the status of asyncConnected requests back to
+ * the main server process, to allow properly expressing an error status as
+ * HTTP status code
+ *
+ * @param {} code HTTP return code
+ */
+export function withServerErrorCode(code: any): (WrappedComponent: any) => (props: any) => JSX.Element;
+/**
+ * Normalize (unicode) string to a normalized plain ascii string
+ * @method normalizeString
+ * @param {string} str The string to be normalized
+ * @returns {string} Normalized plain ascii string
+ */
+export function normalizeString(str: string): string;
+/**
+ * Given an event target element returns if it's an interactive element
+ * of the one in the list.
+ * @param {node} element event.target element type
+ * @returns {boolean} If it's an interactive element of the list
+ */
+export function isInteractiveElement(element: node, interactiveElements?: string[]): boolean;
+export function safeWrapper(func: Function): (config: any) => any;
+export function getInitials(title: any, limit: any): string;
+export function getColor(name: any): any;
+export function parseDateTime(locale: string, value: string, format: string, moment: any): any | string;
+export function toGettextLang(language: string): string;
+export function normalizeLanguageName(language: string): string;
+export function toReactIntlLang(language: string): string;
+export function toLangUnderscoreRegion(language: string): string;
+export function toBackendLang(language: string): string;
+export function hasApiExpander(expander: string, path?: string, type?: string): boolean;
+export function insertInArray(array: any[], element: any, index: number): any[];
+export function replaceItemOfArray(array: any[], index: number, value: any): any[];
+export function removeFromArray(array: any[], index: number): any[];
+export function reorderArray(array: any[], origin: number, target: number): any[];
+export function slugify(string: string): string;
+export function cloneDeepSchema(object: object): object;
+export function arrayRange(start: number, stop: number, step: number): any[];

package/types/helpers/Utils/Utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/helpers/Utils/useDetectClickOutside.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Hook used to detect clicks outside a component (or an escape key press).
+ * onTriggered function is triggered on `click` or escape `keyup` event.
+ */
+export function useDetectClickOutside({ onTriggered, disableClick, disableKeys, allowAnyKey, triggerKeys, }: {
+    onTriggered: any;
+    disableClick: any;
+    disableKeys: any;
+    allowAnyKey: any;
+    triggerKeys: any;
+}): import("react").MutableRefObject<any>;

package/types/helpers/Utils/useEvent.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Hook to listen for an event on the document
+ */
+export function useEvent(event: any, handler: any): void;

package/types/helpers/Utils/usePagination.d.ts

@@ -0,0 +1,4 @@
+export function usePagination(id?: any, defaultPage?: number): {
+    currentPage: any;
+    setCurrentPage: (page: any) => void;
+};

package/types/helpers/Utils/usePagination.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/helpers/Utils/usePrevious.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Hook used to "cache" the "previous" value of a prop or a computed variable.
+ */
+export function usePrevious(value: any): any;

package/types/helpers/Utils/usePrevious.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/helpers/Vocabularies/Vocabularies.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Get string as Boolean.
+ * @function getBoolean
+ * @param {Object} value The value.
+ * @return {string} Field name of the layout
+ */
+export function getBoolean(value: any): string;
+/**
+ * Get vocabulary from hint.
+ * @function getVocabFromHint
+ * @param {Object} props The props.
+ * @return {string} Field name of the layout
+ */
+export function getVocabFromHint(props: any): string;
+/**
+ * Get vocabulary from field.
+ * @function getVocabFromField
+ * @param {Object} props The props.
+ * @return {string} Field name of the layout
+ */
+export function getVocabFromField(props: any): string;
+/**
+ * Get vocabulary from items.
+ * @function getVocabFromItems
+ * @param {Object} props The props.
+ * @return {string} Field name of the layout
+ */
+export function getVocabFromItems(props: any): string;
+/**
+ * Get vocabulary given a URL (coming from a Schema) or from a vocabulary name.
+ * @function getVocabName
+ * @param {string} vocabNameOrURL
+ * @returns {string} Vocabulary name
+ */
+export function getVocabName(vocabNameOrURL: string): string;
+/**
+ * Get Fields vocabulary
+ * @function getFieldsVocabulary
+ * @returns {Object} Fields vocabulary
+ */
+export function getFieldsVocabulary(): any;

package/types/helpers/Widget/utils.d.ts

@@ -0,0 +1 @@
+export function getWidget(id: any, field: any): any;

package/types/helpers/Widget/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/helpers/Widget/widget.d.ts

@@ -0,0 +1 @@
+export function getWidgetView(props: dict): string;

package/types/helpers/Workflows/Workflows.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Maps the available transitions to the current list of colors and returns a
+ * react-select option object
+ * @param  {Object} transition
+ *  {id: "published", title: "Published"}
+ * @return {Object} The react-select options object
+ *  { value: 'published', label: 'Published', color: '#007bc1' }
+ */
+export function getCurrentStateMapping(state: any): any;
+/**
+ * Maps the available transitions to the current list of colors and returns a
+ * react-select option object
+ * @param  {Object} transition
+ *  {
+ *     '@id': 'http://localhost:3000/de/@workflow/publish',
+ *     title: 'Veröffentlichen'
+ *  }
+ * @return {Object} The react-select options object
+ *  { value: 'public', label: 'Published', color: '#007bc1', url: 'http://localhost:3000/de/@workflow/publish' }
+ */
+export function getWorkflowOptions(transition: any): any;

package/types/helpers/Workflows/Workflows.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/helpers/index.d.ts

@@ -0,0 +1,16 @@
+export { default as langmap } from "./LanguageMap/LanguageMap";
+export { default as Helmet } from "./Helmet/Helmet";
+export { messages } from "./MessageLabels/MessageLabels";
+export { asyncConnect } from "./AsyncConnect";
+export { userHasRoles } from "./User/User";
+export { useDetectClickOutside } from "./Utils/useDetectClickOutside";
+export { useEvent } from "./Utils/useEvent";
+export { usePrevious } from "./Utils/usePrevious";
+export { usePagination } from "./Utils/usePagination";
+export { default as useUndoManager } from "./UndoManager/useUndoManager";
+export { getCookieOptions } from "./Cookies/cookies";
+export { getWidgetView } from "./Widget/widget";
+export { getSiteAsyncPropExtender } from "./Site";
+export { default as FormValidation, validateFileUploadSize } from "./FormValidation/FormValidation";
+export { withBlockSchemaEnhancer, withVariationSchemaEnhancer, withBlockExtensions, applySchemaEnhancer, resolveExtension, resolveBlockExtensions, addStyling, composeSchema } from "./Extensions";
+export { getCurrentStateMapping, getWorkflowOptions } from "./Workflows/Workflows";

package/types/hooks/client/useClient.d.ts

@@ -0,0 +1 @@
+export function useClient(): boolean;

package/types/hooks/clipboard/useClipboard.d.ts

@@ -0,0 +1 @@
+export default function useClipboard(clipboardText?: string): (boolean | import("react").Dispatch<import("react").SetStateAction<boolean>>)[];

package/types/hooks/index.d.ts

@@ -0,0 +1 @@
+export {};

package/types/icons/load-icons.d.ts

@@ -0,0 +1,2 @@
+export default icons;
+declare const icons: {};

package/types/index.d.ts

@@ -0,0 +1 @@
+export {};

package/types/middleware/Api.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/middleware/api.d.ts

@@ -0,0 +1,24 @@
+/**
+ *
+ * Add configured expanders to an api call for an action
+ * Requirements:
+ *
+ * - It should add the expanders set in the config settings
+ * - It should preserve any query if present
+ * - It should preserve (and add) any expand parameter (if present) e.g. translations
+ * - It should take use the correct codification for arrays in querystring (repeated parameter for each member of the array)
+ *
+ * @function addExpandersToPath
+ * @param {string} path The url/path including the querystring
+ * @param {*} type The action type
+ * @returns {string} The url/path with the configured expanders added to the query string
+ */
+export function addExpandersToPath(path: string, type: any, isAnonymous: any): string;
+export default apiMiddlewareFactory;
+/**
+ * Api middleware.
+ * @function
+ * @param {Object} api Api object.
+ * @returns {Promise} Action promise.
+ */
+declare function apiMiddlewareFactory(api: any): Promise<any>;

package/types/middleware/blacklistRoutes.d.ts

@@ -0,0 +1,5 @@
+export default blacklistRoutes;
+declare function blacklistRoutes({ dispatch, getState }: {
+    dispatch: any;
+    getState: any;
+}): (next: any) => (action: any) => any;

package/types/middleware/index.d.ts

@@ -0,0 +1 @@
+export { default as blacklistRoutes } from "./blacklistRoutes";

package/types/middleware/storeProtectLoadUtils.d.ts

@@ -0,0 +1,9 @@
+export function loadProtector(state?: {}, action?: {}): {};
+export function protectLoadStart({ dispatch, getState }: {
+    dispatch: any;
+    getState: any;
+}): (next: any) => (action: any) => any;
+export function protectLoadEnd({ dispatch, getState }: {
+    dispatch: any;
+    getState: any;
+}): (next: any) => (action: any) => any;

package/types/middleware/storeProtectLoadUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/actions/actions.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Actions reducer.
+ * @function actions
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function actions(state?: any, action?: any): any;

package/types/reducers/actions/actions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/addons/addons.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Addons reducer.
+ * @function addons
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function addons(state?: any, action?: any): any;

package/types/reducers/aliases/aliases.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Aliases reducer.
+ * @function aliases
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function aliases(state?: any, action?: any): any;

package/types/reducers/aliases/aliases.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/apierror/apierror.d.ts

@@ -0,0 +1,8 @@
+/**
+ * apierror reducer.
+ * @function apierror
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function apierror(state?: any, action?: any): any;

package/types/reducers/apierror/apierror.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/asyncConnect/asyncConnect.d.ts

@@ -0,0 +1,7 @@
+export default function asyncConnect(state?: {
+    loaded: boolean;
+    loadState: {};
+}, action?: {}): {
+    loaded: boolean;
+    loadState: {};
+};

package/types/reducers/authRole/authRole.d.ts

@@ -0,0 +1,8 @@
+/**  storing the authRole state
+ * authRole reducer.
+ * @function authRole
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function authRole(state?: any, action?: any): any;

package/types/reducers/authRole/authRole.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/blocksClipboard/blocksClipboard.d.ts

@@ -0,0 +1 @@
+export default function blocks(state?: {}, action?: {}): {};

package/types/reducers/breadcrumbs/breadcrumbs.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Breadcrumbs reducer.
+ * @function breadcrumbs
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function breadcrumbs(state?: any, action?: any): any;

package/types/reducers/breadcrumbs/breadcrumbs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/browserdetect/browserdetect.d.ts

@@ -0,0 +1,8 @@
+/**
+ * browserdetect reducer.
+ * @function browserdetect
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function browserdetect(state?: any, action?: any): any;

package/types/reducers/clipboard/clipboard.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Clipboard reducer.
+ * @function clipboard
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function clipboard(state?: any, action?: any): any;

package/types/reducers/clipboard/clipboard.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/comments/comments.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Comments reducer.
+ * @function comments
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function comments(state?: any, action?: any): any;

package/types/reducers/comments/comments.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/content/content.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Content reducer.
+ * @function content
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function content(state?: any, action?: any): any;

package/types/reducers/content/content.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/contentRulesEvents/contentRulesEvents.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Rules reducer.
+ * @function rules
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function contentrulesevents(state?: any, action?: any): any;

package/types/reducers/contextNavigation/contextNavigation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Context Navigation reducer.
+ * @function navigation
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function rawdata(state?: any, action?: any): any;

package/types/reducers/contextNavigation/contextNavigation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/reducers/controlPanelRule/controlPanelRule.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Rules reducer.
+ * @function rules
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function controlPanelRule(state?: any, action?: any): any;