@plone/volto 17.3.0 → 17.4.0

package/types/actions/content/content.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Create content function.
+ * @function createContent
+ * @param {string} url Parent URL.
+ * @param {Object|Array} content Content data.
+ * @param {string} subrequest Optional. Key of the subrequest.
+ * @returns {Object} Create content action.
+ */
+export function createContent(url: string, content: any | any[], subrequest: string): any;
+/**
+ * Delete content function.
+ * @function deleteContent
+ * @param {string|Array} urls Content url(s).
+ * @returns {Object} Delete content action.
+ */
+export function deleteContent(urls: string | any[]): any;
+/**
+ * Update content function.
+ * @function updateContent
+ * @param {string|Array} urls Content url(s).
+ * @param {Object|Array} content Content data.
+ * @param {Object|Array} headers Custom headers.
+ * @returns {Object} Update content action.
+ */
+export function updateContent(urls: string | any[], content: any | any[], headers?: any | any[]): any;
+/**
+ * Order content function
+ * @function orderContent
+ * @param {string} parent Parent url
+ * @param {string} url Content url
+ * @param {string|number} delta Order delta
+ * @param {Array} subset Subset ids
+ * @returns {Object} Order content action
+ */
+export function orderContent(parent: string, url: string, delta: string | number, subset: any[]): any;
+/**
+ * Sort content function
+ * @function sortContent
+ * @param {string} url Content url
+ * @param {string} on Sort on index
+ * @param {string} order Sort order
+ * @returns {Object} Sort content action
+ */
+export function sortContent(url: string, on: string, order: string): any;
+/**
+ * Get content function
+ * @function getContent
+ * @param {string} url Content url
+ * @param {string} version Version id
+ * @param {string} subrequest Key of the subrequest.
+ * @param {boolean} fullobjects If full object information should be retrieved
+ * @returns {Object} Get content action
+ */
+export function getContent(url: string, version?: string, subrequest?: string, page?: any, fullobjects?: boolean): any;
+/**
+ * Reset content function
+ * @function resetContent
+ * @param {string} subrequest Key of the subrequest.
+ * @returns {Object} Get content action
+ */
+export function resetContent(subrequest?: string): any;
+/**
+ * Add, remove or order indexes
+ * @param {string} url Content url
+ * @param {string} index indexes with order
+ * @returns {Object} Index content action
+ */
+export function updateColumnsContent(url: string, index: string): any;
+/**
+ * Lock content function.
+ * @function lockContent
+ * @param {string} urls Content url(s)
+ * @returns {Object} Lock content action.
+ */
+export function lockContent(urls: string): any;
+/**
+ * Unlock content function.
+ * @function unlockContent
+ * @param {string|Array} urls Content url(s).
+ * @returns {Object} Unlock content action.
+ */
+export function unlockContent(urls: string | any[], force?: boolean): any;
+export function linkIntegrityCheck(selection: any): {
+    type: any;
+    mode: string;
+    request: {
+        op: string;
+        path: string;
+    };
+};

package/types/actions/content/content.multilingual.test.d.ts

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

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

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

package/types/actions/contextNavigation/contextNavigation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get the context navigation
+ * @function getContextNavigation
+ * @param {string} url Content url.
+ * @param {params} params Options for the navigation component
+ * @returns {Object} Get context navigation action
+ */
+export function getContextNavigation(url: string, params?: any): any;

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

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

package/types/actions/controlpanels/controlpanels.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Get controlpanel function.
+ * @function getControlpanel
+ * @param {id} id Controlpanel id.
+ * @returns {Object} Get controlpanel action.
+ */
+export function getControlpanel(id: any): any;
+/**
+ * Post controlpanel function.
+ * @function postControlpanel
+ * @param {id} id Controlpanel id.
+ * @param {Object} data Controlpanel data.
+ * @returns {Object} Post controlpanel action.
+ */
+export function postControlpanel(id: any, data: any): any;
+/**
+ * Delete controlpanel function.
+ * @function deleteControlpanel
+ * @param {id} id Controlpanel id.
+ * @param {string} item Controlpanel item to be deleted.
+ * @returns {Object} Delete controlpanel action.
+ */
+export function deleteControlpanel(id: any, item: string): any;
+/**
+ * List controlpanels function.
+ * @function listControlpanels
+ * @returns {Object} List controlpanels action.
+ */
+export function listControlpanels(): any;
+/**
+ * Update controlpanel function.
+ * @function updateControlpanel
+ * @param {string} url Controlpanel url.
+ * @param {Object} data Controlpanel data.
+ * @returns {Object} Update controlpanel action.
+ */
+export function updateControlpanel(url: string, data: any): any;
+export function getSystemInformation(): {
+    type: any;
+    request: {
+        op: string;
+        path: string;
+    };
+};
+export function getDatabaseInformation(): {
+    type: any;
+    request: {
+        op: string;
+        path: string;
+    };
+};

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

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

package/types/actions/diff/diff.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get diff.
+ * @function getDiff
+ * @param {string} url Content url.
+ * @param {string} one First version id
+ * @param {string} two Second version id
+ * @returns {Object} Get diff action.
+ */
+export function getDiff(url: string, one: string, two: string): any;

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

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

package/types/actions/emailNotification/emailNotification.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Email notification function
+ * @function emailNotification
+ * @param {string} from User id
+ * @param {string} message Old password.
+ * @param {string} name New password.
+ * @param {string} subject New password.
+ * @returns {Object} Edit password action.
+ */
+export function emailNotification(from: string, message: string, name: string, subject: string): any;

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

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

package/types/actions/emailSend/emailSend.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Email send function
+ * @function emailSend
+ * @param {string} name New password.
+ * @param {string} from Sender mail address.
+ * @param {string} to Receiver mail address.
+ * @param {string} subject Email subject.
+ * @param {string} message Email message.
+ * @returns {Object} Edit emailSend action.
+ */
+export function emailSend(name: string, from: string, to: string, subject: string, message: string): any;

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

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

package/types/actions/groups/groups.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Create group function.
+ * @function createGroup
+ * @param {Object} data Group data.
+ * @returns {Object} Create group action.
+ */
+export function createGroup(data: any): any;
+/**
+ * Delete group function.
+ * @function deleteGroup
+ * @param {string} id Group id
+ * @returns {Object} Delete group action.
+ */
+export function deleteGroup(id: string): any;
+/**
+ * Get group function
+ * @function getGroup
+ * @param {string} id Group id
+ * @returns {Object} Get group action
+ */
+export function getGroup(id: string): any;
+/**
+ * List groups function
+ * Two group lists needed by user group membership control panel: one for joining, one for filtering users.
+ * @function listGroups
+ * @returns {Object} List groups action
+ */
+export function listGroups(query: any, query_group_filter: any): any;
+/**
+ * Update group function.
+ * @function updateGroup
+ * @param {string} id Group id
+ * @param {Object} data Group data.
+ * @returns {Object} Update group action.
+ */
+export function updateGroup(id: string, data: any): any;

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

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

package/types/actions/history/history.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Get history function.
+ * @function getHistory
+ * @param {string} url Content url.
+ * @returns {Object} Get history action.
+ */
+export function getHistory(url: string): any;
+/**
+ * Revert history function.
+ * @function revertHistory
+ * @param {string} url Content url.
+ * @param {number} version Revert version.
+ * @returns {Object} Revet history action.
+ */
+export function revertHistory(url: string, version: number): any;

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

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

package/types/actions/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./asyncConnect/asyncConnect";
+export { getUserSchema } from "./userschema/userschema";
+export { getSite } from "./site/site";
+export { getNavroot } from "./navroot/navroot";
+export { installAddon, listAddons, uninstallAddon, upgradeAddon } from "./addons/addons";
+export { changeLanguage, changeLanguageCookies } from "./language/language";
+export { applyWorkingCopy, createWorkingCopy, removeWorkingCopy } from "./workingcopy/workingcopy";
+export { getUpgradeInformation, runUpgrade } from "./upgrade/upgrade";

package/types/actions/language/language.d.ts

@@ -0,0 +1,9 @@
+export function changeLanguageCookies(language: any, req: any): void;
+/**
+ * Changes current language using react-intl-redux action and setting the cookie
+ * @function changeLanguage
+ * @param {string} language target language.
+ * @param {number} locale set of locales corresponding the target language.
+ * @returns {Object} Change the target language action.
+ */
+export function changeLanguage(language: string, locale: number, req: any): any;

package/types/actions/lazyLibraries/lazyLibraries.d.ts

@@ -0,0 +1 @@
+export function loadLazyLibrary(libName: any, libModule: any): (dispatch: any, getState: any) => void;

package/types/actions/messages/messages.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Add message function
+ * @function addMessage
+ * @param {string} title Message header
+ * @param {string} body Message body.
+ * @param {string} level Message level.
+ * @returns {Object} Add message action.
+ */
+export function addMessage(title: string, body: string, level: string): any;
+/**
+ * Remove message function
+ * @function removeMessage
+ * @param {number} index Message index
+ * @returns {Object} Add message action.
+ */
+export function removeMessage(index: number): any;
+/**
+ * Purge all messages function
+ * @function purgeMessages
+ * @returns {Object} Add message action.
+ */
+export function purgeMessages(): any;

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

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

package/types/actions/navigation/navigation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get navigation.
+ * @function getNavigation
+ * @param {string} url Content url.
+ * @param {number} depth Depth of the navigation tree.
+ * @returns {Object} Get navigation action.
+ */
+export function getNavigation(url: string, depth: number): any;

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

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

package/types/actions/navroot/navroot.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get the navigation root information.
+ * @function getNavroot
+ * @returns {Object} navroot
+ */
+export function getNavroot(url: any): any;

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

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

package/types/actions/querystring/querystring.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get querystring.
+ * @function getQuerystring
+ * @returns {Object} Get querystring action.
+ */
+export function getQuerystring(): any;

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

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

package/types/actions/querystringsearch/querystringsearch.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get querystring results.
+ * @function getQueryStringResults
+ * @param {Object} data Data.
+ * @returns {Object} Get querystringsearch results action.
+ */
+export function getQueryStringResults(path: any, data: any, subrequest: any, page: any): any;

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

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

package/types/actions/relations/rebuild.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Rebuild relation function.
+ * @function rebuildRelations
+ * @param {Boolean} flush Flush intids
+ * @returns {Object} Rebuild relation action.
+ */
+export function rebuildRelations(flush?: boolean): any;

package/types/actions/relations/relations.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Create relation function.
+ * @function createRelations
+ * @param {Object|Array} content Relation data.
+ * @returns {Object} Create relation action.
+ */
+export function createRelations(content: any | any[]): any;
+/**
+ * Delete relation function.
+ * @function deleteRelations
+ * @param {string} id Relation id
+ * @returns {Object} Delete relation action.
+ */
+export function deleteRelations(content: any): any;
+/**
+ * Query relations
+ * @function queryRelations
+ * @param {string} relation Name of relation
+ * @param {boolean} onlyBroken
+ * @returns {Object} List relations action
+ */
+export function queryRelations(relation?: string, onlyBroken?: boolean, subrequest?: any, source?: any, target?: any, query_source?: any, query_target?: any): any;
+/** Get relation stats
+ * @function getRelationStats
+ * @returns {Object} Relation stats
+ */
+export function getRelationStats(): any;

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

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

package/types/actions/roles/roles.d.ts

@@ -0,0 +1,6 @@
+/**
+ * List roles.
+ * @function listRoles
+ * @returns {Object} List roles action.
+ */
+export function listRoles(): any;

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

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

package/types/actions/rules/rules.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Get rules function.
+ * @function getRules
+ * @param {string} url Content url.
+ * @returns {Object} Get rules action.
+ */
+export function getRules(url: string): any;
+/**
+ * Get rules for control panel function.
+ * @function getControlPanelRules
+ * @param {string} url Content url.
+ * @returns {Object} Get rules action.
+ */
+export function getControlPanelRules(url: string): any;
+/**
+ * Get rules for control panel function.
+ * @function getControlPanelRule
+ * @param {string} url Content url.
+ * @returns {Object} Get rules action.
+ */
+export function getControlPanelRule(url: string, rule: any): any;
+/**
+ * Enable rules function.
+ * @function enableRules
+ * @param {string} url Content url.
+ * @param {Array} rules Array containing rules id's.
+ * @returns {Object} Enable rules action.
+ */
+export function enableRules(url: string, rules: any[]): any;
+/**
+ * Disable rules function.
+ * @function disableRules
+ * @param {string} url Content url.
+ * @param {Array} rules Array containing rules id's.
+ * @returns {Object} Disable rules action.
+ */
+export function disableRules(url: string, rules: any[]): any;
+/**
+ * Apply rules to subfolders function.
+ * @function applyRulesToSubfolders
+ * @param {string} url Content url.
+ * @param {Array} rules Array containing rules id's.
+ * @returns {Object} apply rules to subfolders action.
+ */
+export function applyRulesToSubfolders(url: string, rules: any[]): any;
+/**
+ * Unnaply Rules to subfolders function.
+ * @function unapplyRulesToSubfolders
+ * @param {string} url Content url.
+ * @param {Array} rules Array containing rules id's.
+ * @returns {Object} unnaply rules to subfolders action.
+ */
+export function unapplyRulesToSubfolders(url: string, rules: any[]): any;
+/**
+ * Remove rules function.
+ * @function removeRules
+ * @param {string} url Content url.
+ * @param {Array} rules Array containing rules id's.
+ * @returns {Object} remove rules action.
+ */
+export function removeRules(url: string, rules: any[]): any;
+/**
+ * Add rules function.
+ * @function addRule
+ * @param {string} url Content url.
+ * @param {string} rule String with rule id.
+ * @returns {Object} add rule action.
+ */
+export function addRule(url: string, rule: string): any;
+/**
+ * Delete rule function.
+ * @function deleteControlPanelRule
+ * @param {string} url Content url.
+ * @param {string} rule String with rule id.
+ * @returns {Object} delete rule action.
+ */
+export function deleteControlPanelRule(url: string, rule: string): any;
+/**
+ * Get content rules events function.
+ * @function getContentRulesEvents
+ * @param {string} url Content url.
+ * @returns {Object} Get content rules events action.
+ */
+export function getContentRulesEvents(url: string): any;
+/**
+ * Add new rule function.
+ * @function addNewRule
+ * @param {string} url Content url.
+ * @returns {Object} Add new rule action.
+ */
+export function addNewRule(url: string, data: any): any;
+/**
+ * Move rule condition function.
+ * @function moveRuleCondition
+ * @param {string} url Content url.
+ * @returns {Object} Move rule condition action.
+ */
+export function moveRuleCondition(url: string, data: any, ruleId: any, condId: any): any;
+/**
+ * Move rule action function.
+ * @function moveRuleAction
+ * @param {string} url Content url.
+ * @returns {Object} Move rule action action.
+ */
+export function moveRuleAction(url: string, data: any, ruleId: any, actionId: any): any;
+/**
+ * Edit rule function.
+ * @function editRule
+ * @param {string} url Content url.
+ * @returns {Object} Edit rule action.
+ */
+export function editRule(url: string, data: any, rule: any): any;
+/**
+ * Remove rule condition function.
+ * @function removeCondition
+ * @param {string} url Content url.
+ * @returns {Object} Remove rule condition action.
+ */
+export function removeCondition(url: string, rule: any, condition: any): any;
+/**
+ * Add rule condition function.
+ * @function addCondition
+ * @param {string} url Content url.
+ * @returns {Object} Add rule condition action.
+ */
+export function addCondition(url: string, rule: any, data: any): any;
+/**
+ * Edit rule condition function.
+ * @function editCondition
+ * @param {string} url Content url.
+ * @returns {Object} Edit rule condition action.
+ */
+export function editCondition(url: string, rule: any, data: any, condition_index: any): any;
+/**
+ * Get rule condition function.
+ * @function getCondition
+ * @param {string} url Content url.
+ * @returns {Object} Get rule condition action.
+ */
+export function getCondition(url: string, rule: any, condition_index: any): any;
+/**
+ * Remove rule action function.
+ * @function removeAction
+ * @param {string} url Content url.
+ * @returns {Object} Remove rule ction action.
+ */
+export function removeAction(url: string, rule: any, action: any): any;
+/**
+ * Add rule action function.
+ * @function addAction
+ * @param {string} url Content url.
+ * @returns {Object} Add rule ction action.
+ */
+export function addAction(url: string, rule: any, data: any): any;
+/**
+ * Edit rule action function.
+ * @function editAction
+ * @param {string} url Content url.
+ * @returns {Object} Edit rule action action.
+ */
+export function editAction(url: string, rule: any, data: any, action_index: any): any;
+/**
+ * Get rule action function.
+ * @function getAction
+ * @param {string} url Content url.
+ * @returns {Object} Get rule action action.
+ */
+export function getAction(url: string, rule: any, action_index: any): any;

package/types/actions/schema/schema.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Get schema function.
+ * @function getSchema
+ * @param {string} type Content type.
+ * @param {string} url Content url.
+ * @returns {Object} Get schema action.
+ */
+export function getSchema(type: string, url: string): any;
+/**
+ * Post schema function.
+ * @function postSchema
+ * @param {string} type Content type.
+ * @param {Object} data Schema data.
+ * @returns {Object} Post schema action.
+ */
+export function postSchema(type: string, data: any): any;
+/**
+ * Put schema function.
+ * @function putSchema
+ * @param {string} type Content type.
+ * @param {Object} data Schema data.
+ * @returns {Object} Put schema action.
+ */
+export function putSchema(type: string, data: any): any;
+/**
+ * Update schema function.
+ * @function updateSchema
+ * @param {string} type Content type.
+ * @param {Object} data Schema data.
+ * @returns {Object} Update schema action.
+ */
+export function updateSchema(type: string, data: any): any;

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

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

package/types/actions/search/search.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Search content function.
+ * @function searchContent
+ * @param {string} url Url to use as base.
+ * @param {Object} options Search options.
+ * @param {string} subrequest Key of the subrequest.
+ * @returns {Object} Search content action.
+ */
+export function searchContent(url: string, options: any, subrequest?: string): any;
+/**
+ * Reset search content function.
+ * @function resetSearchContent
+ * @param {string} subrequest Key of the subrequest.
+ * @returns {Object} Search content action.
+ */
+export function resetSearchContent(subrequest?: string): any;

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

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

package/types/actions/sharing/sharing.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Update sharing function.
+ * @function updateSharing
+ * @param {string} url Content url.
+ * @param {Object} sharing Sharing data.
+ * @returns {Object} Update sharing action.
+ */
+export function updateSharing(url: string, sharing: any): any;
+/**
+ * Get sharing function.
+ * @function getSharing
+ * @param {string} url Content url.
+ * @param {string} search Search value.
+ * @returns {Object} Get sharing action.
+ */
+export function getSharing(url: string, search?: string): any;

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

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