@enonic-types/lib-content 0.1.0 → 7.11.0-B1

package/{index.d.ts → content.d.ts}

@@ -1,886 +1,908 @@
-/**
- * Functions and constants to find and manipulate content.
- *
- * @example
- * var contentLib = require('/lib/xp/content');
- *
- * @module content
- */
-declare global {
-    interface XpLibraries {
-        '/lib/xp/content': typeof import('./content');
-    }
-}
-declare type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
-export declare const ARCHIVE_ROOT_PATH: string;
-export declare const CONTENT_ROOT_PATH: string;
-/**
- * @typedef ContentType
- * @type Object
- * @property {string} name Name of the content type.
- * @property {string} displayName Display name of the content type.
- * @property {string} description Description of the content type.
- * @property {string} superType Name of the super type, or null if it has no super type.
- * @property {boolean} abstract Whether or not content of this type may be instantiated.
- * @property {boolean} final Whether or not it may be used as super type of other content types.
- * @property {boolean} allowChildContent Whether or not allow creating child items on content of this type.
- * @property {string} displayNameExpression ES6 string template for generating the content name based on values in the content form.
- * @property {object} [icon] Icon of the content type.
- * @property {object} [icon.data] Stream with the binary data for the icon.
- * @property {string} [icon.mimeType] Mime type of the icon image.
- * @property {string} [icon.modifiedTime] Modified time of the icon. May be used for caching.
- * @property {object[]} form Form schema represented as an array of form items: Input, ItemSet, Layout, OptionSet.
- */
-export interface GetContentParams {
-    key: string;
-    versionId?: string | null;
-}
-export interface Attachment {
-    name: string;
-    label?: string;
-    size: number;
-    mimeType: string;
-}
-export interface Attachments {
-    [key: string]: Attachment;
-}
-export interface PublishInfo {
-    from?: string;
-    to?: string;
-    first?: string;
-}
-export declare type XDataEntry = Record<string, Record<string, unknown>>;
-export declare type XData = Record<string, XDataEntry>;
-export declare type WorkflowState = 'IN_PROGRESS' | 'PENDING_APPROVAL' | 'REJECTED' | 'READY';
-export declare type WorkflowCheckState = 'PENDING' | 'REJECTED' | 'APPROVED';
-export interface Workflow {
-    state: WorkflowState;
-    checks?: Record<string, WorkflowCheckState>;
-}
-export declare type ContentInheritType = 'CONTENT' | 'PARENT' | 'NAME' | 'SORT';
-export interface Bucket {
-    [subAggregationName: string]: BucketsAggregation | StatsAggregation | SingleValueMetricAggregation | string | number | undefined;
-    key: string;
-    docCount: number;
-}
-export interface NumericBucket extends Bucket {
-    from?: number;
-    to?: number;
-}
-export interface DateBucket extends Bucket {
-    from?: string;
-    to?: string;
-}
-export interface BucketsAggregation {
-    buckets: (DateBucket | NumericBucket)[];
-}
-export interface StatsAggregation {
-    count: number;
-    min: number;
-    max: number;
-    avg: number;
-    sum: number;
-}
-export interface SingleValueMetricAggregation {
-    value: number;
-}
-export declare type AggregationsResult = BucketsAggregation | StatsAggregation | SingleValueMetricAggregation;
-export declare type Aggregation = TermsAggregation | HistogramAggregation | DateHistogramAggregation | NumericRangeAggregation | DateRangeAggregation | StatsAggregation | GeoDistanceAggregation | MinAggregation | MaxAggregation | ValueCountAggregation;
-export interface TermsAggregation {
-    terms: {
-        field: string;
-        order?: string;
-        size?: number;
-        minDocCount?: number;
-    };
-    aggregations?: {
-        [subAggregations: string]: Aggregation;
-    };
-}
-export interface HistogramAggregation {
-    histogram: {
-        field: string;
-        order?: string;
-        interval?: number;
-        extendedBoundMin?: number;
-        extendedBoundMax?: number;
-        minDocCount?: number;
-    };
-    aggregations?: {
-        [subAggregations: string]: Aggregation;
-    };
-}
-export interface DateHistogramAggregation {
-    dateHistogram: {
-        field: string;
-        interval?: string;
-        minDocCount?: number;
-        format: string;
-    };
-    aggregations?: {
-        [subAggregations: string]: Aggregation;
-    };
-}
-export interface NumericRange {
-    from?: number;
-    to?: number;
-    key?: string;
-}
-export interface NumericRangeAggregation {
-    range: {
-        field: string;
-        ranges?: NumericRange[];
-    };
-    aggregations?: {
-        [subAggregations: string]: Aggregation;
-    };
-}
-export interface NumericRangeAggregation {
-    range: {
-        field: string;
-        ranges?: NumericRange[];
-    };
-    aggregations?: {
-        [subAggregations: string]: Aggregation;
-    };
-}
-export interface DateRange {
-    from?: string;
-    to?: string;
-    key?: string;
-}
-export interface DateRangeAggregation {
-    dateRange: {
-        field: string;
-        format: string;
-        ranges: DateRange[];
-    };
-    aggregations?: {
-        [subAggregations: string]: Aggregation;
-    };
-}
-export interface StatsAggregation {
-    stats: {
-        field: string;
-    };
-}
-export interface GeoDistanceAggregation {
-    geoDistance: {
-        field: string;
-        unit: string;
-        origin?: {
-            lat: string;
-            lon: string;
-        };
-        ranges?: NumericRange[];
-    };
-}
-export interface MinAggregation {
-    min: {
-        field: string;
-    };
-}
-export interface MaxAggregation {
-    max: {
-        field: string;
-    };
-}
-export interface ValueCountAggregation {
-    count: {
-        field: string;
-    };
-}
-export interface Highlight {
-    encoder?: 'default' | 'html';
-    tagsSchema?: 'styled';
-    fragmenter?: 'simple' | 'span';
-    fragmentSize?: number;
-    noMatchSize?: number;
-    numberOfFragments?: number;
-    order?: 'score' | 'none';
-    preTag?: string;
-    postTag?: string;
-    requireFieldMatch?: boolean;
-    properties?: Record<string, Highlight>;
-}
-export interface HighlightResult {
-    [highlightedFieldName: string]: string[];
-}
-export interface ExistsFilter {
-    exists: {
-        field: string;
-    };
-}
-export interface NotExistsFilter {
-    notExists: {
-        field: string;
-    };
-}
-export interface HasValueFilter {
-    hasValue: {
-        field: string;
-        values: unknown[];
-    };
-}
-export interface IdsFilter {
-    ids: {
-        values: string[];
-    };
-}
-export interface BooleanFilter {
-    boolean: {
-        must?: Filter[];
-        mustNot?: Filter[];
-        should?: Filter[];
-    };
-}
-export declare type Filter = ExistsFilter | NotExistsFilter | HasValueFilter | IdsFilter | BooleanFilter;
-export declare type FormItemType = 'Input' | 'ItemSet' | 'Layout' | 'OptionSet';
-export declare type InputType = 'Time' | 'DateTime' | 'CheckBox' | 'ComboBox' | 'Long' | 'Double' | 'RadioButton' | 'TextArea' | 'ContentTypeFilter' | 'GeoPoint' | 'TextLine' | 'Tag' | 'CustomSelector' | 'AttachmentUploader' | 'ContentSelector' | 'MediaSelector' | 'ImageSelector' | 'Date' | 'MediaUploader' | 'SiteConfigurator' | 'HtmlArea';
-export interface FormItemSet {
-    formItemType: string | FormItemType;
-    name: string;
-    label: string;
-    customText: string;
-    helpText: string;
-    maximize: boolean;
-    inputType: InputType;
-    occurrences: {
-        maximum: number;
-        minimum: number;
-    };
-    items: FormItem[];
-}
-export interface FormItemLayout {
-    formItemType: string | FormItemType;
-    name: string;
-    label: string;
-    items: unknown;
-}
-export declare type ValueType = 'BinaryReference' | 'Boolean' | 'DateTime' | 'Double' | 'GeoPoint' | 'Link' | 'LocalDateTime' | 'LocalDate' | 'LocalTime' | 'Long' | 'PropertySet' | 'Reference' | 'String' | 'Xml';
-export interface FormItemInput {
-    formItemType: string | FormItemType;
-    name: string;
-    label: string;
-    customText: string;
-    helpText: string;
-    validationRegexp: string;
-    maximize: boolean;
-    inputType: InputType;
-    occurrences: {
-        maximum: number;
-        minimum: number;
-    };
-    default: {
-        value: string;
-        type: ValueType;
-    };
-    config: {
-        [configName: string]: {
-            [attributeKey: string]: string;
-            value: string;
-        }[];
-    };
-}
-export interface FormItemOptionSet {
-    formItemType: string | FormItemType;
-    name: string;
-    label: string;
-    expanded: boolean;
-    helpText: string;
-    occurrences: {
-        maximum: number;
-        minimum: number;
-    };
-    selection: {
-        maximum: number;
-        minimum: number;
-    };
-    options: {
-        name: string;
-        label: string;
-        helpText: string;
-        default: boolean;
-        items: FormItem[];
-    }[];
-}
-export declare type FormItem = FormItemSet | FormItemLayout | FormItemOptionSet | FormItemInput;
-export declare type DslQueryType = LiteralUnion<'dateTime' | 'time'> | number | boolean;
-export declare type DslOperator = 'OR' | 'AND';
-export interface TermDslExpression {
-    field: string;
-    value: unknown;
-    type?: DslQueryType;
-    boost?: number;
-}
-export interface InDslExpression {
-    field: string;
-    values: unknown[];
-    type?: DslQueryType;
-    boost?: number;
-}
-export interface LikeDslExpression {
-    field: string;
-    value: string;
-    type?: DslQueryType;
-    boost?: number;
-}
-export interface RangeDslExpression {
-    field: string;
-    type?: DslQueryType;
-    lt?: unknown;
-    lte?: unknown;
-    gt?: unknown;
-    gte?: unknown;
-    boost?: number;
-}
-export interface PathMatchDslExpression {
-    field: string;
-    path: string;
-    minimumMatch?: number;
-    boost?: number;
-}
-export interface MatchAllDslExpression {
-    boost?: number;
-}
-export interface FulltextDslExpression {
-    fields: string[];
-    query: string;
-    operator?: DslOperator;
-}
-export interface NgramDslExpression {
-    fields: string[];
-    query: string;
-    operator?: DslOperator;
-}
-export interface StemmedDslExpression {
-    fields: string[];
-    query: string;
-    language: string;
-}
-export interface BooleanDslExpression {
-    should?: DslExpression | DslExpression[];
-    must?: DslExpression | DslExpression[];
-    mustNot?: DslExpression | DslExpression[];
-    filter?: DslExpression | DslExpression[];
-}
-export declare type DslExpression = TermDslExpression | InDslExpression | LikeDslExpression | RangeDslExpression | PathMatchDslExpression | MatchAllDslExpression | FulltextDslExpression | NgramDslExpression | BooleanDslExpression | StemmedDslExpression;
-export interface QueryDsl {
-    boolean?: BooleanDslExpression;
-    ngram?: NgramDslExpression;
-    fulltext?: FulltextDslExpression;
-    matchAll?: MatchAllDslExpression;
-    pathMatch?: PathMatchDslExpression;
-    range?: RangeDslExpression;
-    like?: LikeDslExpression;
-    in?: InDslExpression;
-    term?: TermDslExpression;
-}
-export interface Content {
-    _id: string;
-    _name: string;
-    _path: string;
-    _score: number;
-    creator: string;
-    modifier: string;
-    createdTime: string;
-    modifiedTime: string;
-    owner: string;
-    type: string;
-    displayName: string;
-    hasChildren: boolean;
-    language: string;
-    valid: boolean;
-    originProject: string;
-    childOrder?: string;
-    _sort?: object[];
-    data: Record<string, unknown>;
-    x: XData;
-    attachments: Attachments;
-    publish?: PublishInfo;
-    workflow?: Workflow;
-    inherit?: ContentInheritType[];
-}
-/**
- * This function fetches a content.
- *
- * @example-ref examples/content/get.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- * @param {string} [params.versionId] Version Id of the content.
- *
- * @returns {object} The content (as JSON) fetched from the repository.
- */
-export declare function get(params: GetContentParams): Content | null;
-/**
- * This function returns a content attachments.
- *
- * @example-ref examples/content/getAttachments.js
- *e
- * @param {string} key Path or id to the content.
- *
- * @returns {object} An object with all the attachments that belong to the content, where the key is the attachment name. Or null if the content cannot be found.
- */
-export declare function getAttachments(key: string): Attachments | null;
-export interface GetAttachmentStreamParams {
-    key: string;
-    name: string;
-}
-/**
- * This function returns a data-stream for the specified content attachment.
- *
- * @example-ref examples/content/getAttachmentStream.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- * @param {string} params.name Attachment name.
- *
- * @returns {*} Stream of the attachment data.
- */
-export declare function getAttachmentStream(params: GetAttachmentStreamParams): object | null;
-export interface AddAttachmentParam {
-    key: string;
-    name: string;
-    mimeType: string;
-    data: object;
-    label?: string;
-}
-/**
- * Adds an attachment to an existing content.
- *
- * @example-ref examples/content/addAttachment.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- * @param {string} params.name Attachment name.
- * @param {string} params.mimeType Attachment content type.
- * @param {string} [params.label] Attachment label.
- * @param {object} params.data Stream with the binary data for the attachment.
- */
-export declare function addAttachment(params: AddAttachmentParam): void;
-export interface RemoveAttachmentParams {
-    key: string;
-    name: string | string[];
-}
-/**
- * Removes an attachment from an existing content.
- *
- * @example-ref examples/content/removeAttachment.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- * @param {string|string[]} params.name Attachment name, or array of names.
- */
-export declare function removeAttachment(params: RemoveAttachmentParams): void;
-export interface Site extends Content {
-    description: string;
-}
-export interface GetSiteParams {
-    key?: string | null;
-}
-/**
- * This function returns the parent site of a content.
- *
- * @example-ref examples/content/getSite.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- *
- * @returns {object} The current site as JSON.
- */
-export declare function getSite(params: GetSiteParams): Site;
-export interface GetSiteConfigParams {
-    key: string;
-    applicationKey: string;
-}
-export declare type SiteConfig = Record<string, unknown>;
-/**
- * This function returns the site configuration for this app in the parent site of a content.
- *
- * @example-ref examples/content/getSiteConfig.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- * @param {string} params.applicationKey Application key.
- *
- * @returns {object} The site configuration for current application as JSON.
- */
-export declare function getSiteConfig(params: GetSiteConfigParams): SiteConfig;
-export interface DeleteContentParams {
-    key: string;
-}
-/**
- * This function deletes a content.
- *
- * @example-ref examples/content/delete.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- *
- * @returns {boolean} True if deleted, false otherwise.
- */
-declare function _delete(params: DeleteContentParams): boolean;
-export { _delete as delete, };
-export interface ContentsResult {
-    total: number;
-    count: number;
-    hits: Content[];
-    aggregations?: Record<string, AggregationsResult>;
-    highlight?: Record<string, HighlightResult>;
-}
-export interface GetChildContentParams {
-    key: string;
-    start?: number;
-    count?: number;
-    sort?: string;
-}
-/**
- * This function fetches children of a content.
- *
- * @example-ref examples/content/getChildren.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the parent content.
- * @param {number} [params.start=0] Start index (used for paging).
- * @param {number} [params.count=10] Number of contents to fetch.
- * @param {string} [params.sort] Sorting expression.
- *
- * @returns {Object} Result (of content) fetched from the repository.
- */
-export declare function getChildren(params: GetChildContentParams): ContentsResult;
-export declare type IdGeneratorSupplier = (value: string) => string;
-export interface CreateContentParams {
-    name?: string;
-    parentPath: string;
-    displayName?: string;
-    requireValid?: boolean;
-    refresh?: boolean;
-    contentType: string;
-    language?: string;
-    childOrder?: string;
-    data?: object;
-    x?: object;
-    idGenerator: IdGeneratorSupplier;
-    workflow?: object;
-}
-/**
- * This function creates a content.
- *
- * The parameter `name` is optional, but if it is not set then `displayName` must be specified. When name is not set, the
- * system will auto-generate a `name` based on the `displayName`, by lower-casing and replacing certain characters. If there
- * is already a content with the auto-generated name, a suffix will be added to the `name` in order to make it unique.
- *
- * To create a content where the name is not important and there could be multiple instances under the same parent content,
- * skip the `name` parameter and specify a `displayName`.
- *
- * @example-ref examples/content/create.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} [params.name] Name of content.
- * @param {string} params.parentPath Path to place content under.
- * @param {string} [params.displayName] Display name. Default is same as `name`.
- * @param {boolean} [params.requireValid=true] The content has to be valid, according to the content type, to be created. If requireValid=true and the content is not strictly valid, an error will be thrown.
- * @param {boolean} [params.refresh=true] If refresh is true, the created content will to be searchable through queries immediately, else within 1 second. Since there is a performance penalty doing this refresh, refresh should be set to false for bulk operations.
- * @param {string} params.contentType Content type to use.
- * @param {string} [params.language] The language tag representing the content’s locale.
- * @param {string} [params.childOrder] Default ordering of children when doing getChildren if no order is given in query
- * @param {object} params.data Actual content data.
- * @param {object} [params.x] eXtra data to use.
- * @param {object} [params.workflow] Workflow information to use. Default has state READY and empty check list.
- *
- * @returns {object} Content created as JSON.
- */
-export declare function create(params: CreateContentParams): Content;
-export interface QueryContentParams {
-    start?: number;
-    count?: number;
-    query?: QueryDsl | string;
-    filters?: Filter | Filter[];
-    aggregations?: Record<string, Aggregation>;
-    sort?: string | object | object[];
-    contentTypes?: string[];
-    highlight?: Highlight;
-}
-/**
- * This command queries content.
- *
- * @example-ref examples/content/query.js
- *
- * @param {object} params JSON with the parameters.
- * @param {number} [params.start=0] Start index (used for paging).
- * @param {number} [params.count=10] Number of contents to fetch.
- * @param {string|object} params.query Query expression.
- * @param {object} [params.filters] Filters to apply to query result
- * @param {string|object|object[]} [params.sort] Sorting expression.
- * @param {string} [params.aggregations] Aggregations expression.
- * @param {string[]} [params.contentTypes] Content types to filter on.
- *
- * @returns {Object} Result of query.
- */
-export declare function query(params: QueryContentParams): ContentsResult;
-export interface ModifyContentParams {
-    key: string;
-    editor: (v: Content) => Content;
-    requireValid?: boolean;
-}
-/**
- * This function modifies a content.
- *
- * @example-ref examples/content/modify.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.key Path or id to the content.
- * @param {function} params.editor Editor callback function.
- * @param {boolean} [params.requireValid=true] The content has to be valid, according to the content type, to be updated. If requireValid=true and the content is not strictly valid, an error will be thrown.
- *
- * @returns {object} Modified content as JSON.
- */
-export declare function modify(params: ModifyContentParams): Content;
-export interface Schedule {
-    from?: string;
-    to?: string;
-}
-export interface PublishContentParams {
-    keys: string[];
-    sourceBranch: string;
-    targetBranch: string;
-    schedule: Schedule;
-    includeChildren?: boolean;
-    excludeChildrenIds?: string[];
-    includeDependencies?: boolean;
-    message: string;
-}
-export interface PublishContentResult {
-    pushedContents: string[];
-    deletedContents: string[];
-    failedContents: string[];
-}
-/**
- * This function publishes content to a branch.
- *
- * @example-ref examples/content/publish.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string[]} params.keys List of all content keys(path or id) that should be published.
- * @param {string} params.sourceBranch The branch where the content to be published is stored.
- * @param {string} params.targetBranch The branch to which the content should be published.  Technically, publishing is just a move from one branch
- * to another, and publishing user content from master to draft is therefore also valid usage of this function, which may be practical if user input to a web-page is stored on master.
- * @param {object} [params.schedule] Schedule the publish.
- * @param {string} [params.schedule.from] Time from which the content is considered published. Defaults to the time of the publish
- * @param {string} [params.schedule.to] Time until which the content is considered published.
- * @param {string[]} [params.excludeChildrenIds] List of all content keys which children should be excluded from publishing content.
- * @param {boolean} [params.includeDependencies=true] Whether all related content should be included when publishing content.
- * @param {string} params.message Publish message.
- *
- * @returns {object} Status of the publish operation in JSON.
- */
-export declare function publish(params: PublishContentParams): PublishContentResult;
-export interface UnpublishContentParams {
-    keys: string[];
-}
-/**
- * This function unpublishes content that had been published to the master branch.
- *
- * @example-ref examples/content/unpublish.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string[]} params.keys List of all content keys(path or id) that should be unpublished.
- *
- * @returns {string[]} List with ids of the content that were unpublished.
- */
-export declare function unpublish(params: UnpublishContentParams): string[];
-export interface ContentExistsParams {
-    key: string;
-}
-/**
- * Check if content exists.
- *
- * @example-ref examples/content/exists.js
- *
- * @param {string} params.key content id.
- *
- * @returns {boolean} True if exist, false otherwise.
- */
-export declare function exists(params: ContentExistsParams): boolean;
-export interface CreateMediaParams {
-    name: string;
-    parentPath: string;
-    mimeType: string;
-    focalX: string;
-    focalY: string;
-    data: string;
-    idGenerator: (v: string) => string;
-}
-/**
- * Creates a media content.
- *
- * @example-ref examples/content/createMedia.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.name Name of content.
- * @param {string} [params.parentPath=/] Path to place content under.
- * @param {string} [params.mimeType] Mime-type of the data.
- * @param {number} [params.focalX] Focal point for X axis (if it's an image).
- * @param {number} [params.focalY] Focal point for Y axis (if it's an image).
- * @param  params.data Data (as stream) to use.
- *
- * @returns {object} Returns the created media content.
- */
-export declare function createMedia(params: CreateMediaParams): Content;
-export interface MoveContentParams {
-    source: string;
-    target: string;
-}
-/**
- * Rename a content or move it to a new path.
- *
- * @example-ref examples/content/move.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.source Path or id of the content to be moved or renamed.
- * @param {string} params.target New path or name for the content. If the target ends in slash '/', it specifies the parent path where to be moved. Otherwise it means the new desired path or name for the content.
- *
- * @returns {object} The content that was moved or renamed.
- */
-export declare function move(params: MoveContentParams): Content;
-export interface ArchiveContentParams {
-    content: string;
-}
-/**
- * Archive a content.
- *
- * @example-ref examples/content/archive.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.content Path or id of the content to be archived.
- *
- * @returns {string[]} List with ids of the contents that were archived.
- */
-export declare function archive(params: ArchiveContentParams): string[];
-export interface RestoreContentParams {
-    content: string;
-    path: string;
-}
-/**
- * Restore a content from the archive.
- *
- * @example-ref examples/content/restore.js
- *
- * @param {object} params JSON with the parameters.
- * @param {string} params.content Path or id of the content to be restored.
- * @param {string} params.path Path of parent for restored content.
- *
- * @returns {string[]} List with ids of the contents that were restored.
- */
-export declare function restore(params: RestoreContentParams): string[];
-export declare type Permission = 'READ' | 'CREATE' | 'MODIFY' | 'DELETE' | 'PUBLISH' | 'READ_PERMISSIONS' | 'WRITE_PERMISSIONS';
-export interface AccessControlEntry {
-    principal: string;
-    allow?: Permission[];
-    deny?: Permission[];
-}
-export interface SetPermissionsParams {
-    key: string;
-    inheritPermissions: boolean;
-    overwriteChildPermissions: boolean;
-    permissions: AccessControlEntry[];
-}
-export interface Permissions {
-    inheritsPermissions: boolean;
-    permissions?: Permission[];
-}
-/**
- * Sets permissions on a content.
- *
- * @example-ref examples/content/setPermissions.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Path or id of the content.
- * @param {boolean} [params.inheritPermissions] Set to true if the content must inherit permissions. Default to false.
- * @param {boolean} [params.overwriteChildPermissions] Set to true to overwrite child permissions. Default to false.
- * @param {array} [params.permissions] Array of permissions.
- * @param {string} params.permissions.principal Principal key.
- * @param {array} params.permissions.allow Allowed permissions.
- * @param {array} params.permissions.deny Denied permissions.
- * @returns {boolean} True if successful, false otherwise.
- */
-export declare function setPermissions(params: SetPermissionsParams): boolean;
-export interface GetPermissionsParams {
-    key: string;
-}
-/**
- * Gets permissions on a content.
- *
- * @example-ref examples/content/getPermissions.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Path or id of the content.
- * @returns {object} Content permissions.
- */
-export declare function getPermissions(params: GetPermissionsParams): Permissions | null;
-export interface Icon {
-    data: object;
-    mimeType: string;
-    modifiedTime: string;
-}
-export interface ContentType {
-    name: string;
-    displayName: string;
-    description: string;
-    superType: string;
-    abstract: boolean;
-    final: boolean;
-    allowChildContent: boolean;
-    displayNameExpression: string;
-    modifiedTime: string;
-    icon?: Icon;
-    form: FormItem[];
-}
-/**
- * Returns the properties and icon of the specified content type.
- *
- * @example-ref examples/content/getType.js
- *
- * @param name Name of the content type, as 'app:name' (e.g. 'com.enonic.myapp:article').
- * @returns {ContentType} The content type object if found, or null otherwise. See ContentType type definition below.
- */
-export declare function getType(name: string): ContentType;
-/**
- * Returns the list of all the content types currently registered in the system.
- *
- * @example-ref examples/content/getTypes.js
- *
- * @returns {ContentType[]} Array with all the content types found. See ContentType type definition below.
- */
-export declare function getTypes(): ContentType[];
-export interface GetOutboundDependenciesParams {
-    key: string;
-}
-/**
- * Returns outbound dependencies on a content.
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Path or id of the content.
- * @returns {object} Content Ids.
- */
-export declare function getOutboundDependencies(params: GetOutboundDependenciesParams): string[];
-export interface ResetInheritanceParams {
-    key: string;
-    projectName: string;
-    inherit: ContentInheritType[];
-}
-export interface ResetInheritanceHandler {
-    setKey(value: string): void;
-    setProjectName(value: string): void;
-    setInherit(value: ContentInheritType[]): void;
-    execute(): void;
-}
-/** Resets dropped inherit flags back.
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Path or id of the content.
- * @param {string} params.projectName name of project with content.
- * @param {string[]} params.inherit flags to be reset.
- */
-export declare function resetInheritance(params: ResetInheritanceParams): void;
+/**
+ * Functions and constants to find and manipulate content.
+ *
+ * @example
+ * var contentLib = require('/lib/xp/content');
+ *
+ * @module content
+ */
+declare global {
+    interface XpLibraries {
+        '/lib/xp/content': typeof import('./content');
+    }
+}
+declare type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
+export declare const ARCHIVE_ROOT_PATH: string;
+export declare const CONTENT_ROOT_PATH: string;
+export interface GetContentParams {
+    key: string;
+    versionId?: string | null;
+}
+export interface Attachment {
+    name: string;
+    label?: string;
+    size: number;
+    mimeType: string;
+}
+export interface Attachments {
+    [key: string]: Attachment;
+}
+export interface PublishInfo {
+    from?: string;
+    to?: string;
+    first?: string;
+}
+export declare type XDataEntry = Record<string, Record<string, unknown>>;
+export declare type XData = Record<string, XDataEntry>;
+export declare type WorkflowState = 'IN_PROGRESS' | 'PENDING_APPROVAL' | 'REJECTED' | 'READY';
+export declare type WorkflowCheckState = 'PENDING' | 'REJECTED' | 'APPROVED';
+export interface Workflow {
+    state: WorkflowState;
+    checks?: Record<string, WorkflowCheckState>;
+}
+export declare type ContentInheritType = 'CONTENT' | 'PARENT' | 'NAME' | 'SORT';
+export interface Bucket {
+    [subAggregationName: string]: BucketsAggregation | StatsAggregation | SingleValueMetricAggregation | string | number | undefined;
+    key: string;
+    docCount: number;
+}
+export interface NumericBucket extends Bucket {
+    from?: number;
+    to?: number;
+}
+export interface DateBucket extends Bucket {
+    from?: string;
+    to?: string;
+}
+export interface BucketsAggregation {
+    buckets: (DateBucket | NumericBucket)[];
+}
+export interface StatsAggregation {
+    count: number;
+    min: number;
+    max: number;
+    avg: number;
+    sum: number;
+}
+export interface SingleValueMetricAggregation {
+    value: number;
+}
+export declare type AggregationsResult = BucketsAggregation | StatsAggregation | SingleValueMetricAggregation;
+export declare type Aggregation = TermsAggregation | HistogramAggregation | DateHistogramAggregation | NumericRangeAggregation | DateRangeAggregation | StatsAggregation | GeoDistanceAggregation | MinAggregation | MaxAggregation | ValueCountAggregation;
+export interface TermsAggregation {
+    terms: {
+        field: string;
+        order?: string;
+        size?: number;
+        minDocCount?: number;
+    };
+    aggregations?: {
+        [subAggregations: string]: Aggregation;
+    };
+}
+export interface HistogramAggregation {
+    histogram: {
+        field: string;
+        order?: string;
+        interval?: number;
+        extendedBoundMin?: number;
+        extendedBoundMax?: number;
+        minDocCount?: number;
+    };
+    aggregations?: {
+        [subAggregations: string]: Aggregation;
+    };
+}
+export interface DateHistogramAggregation {
+    dateHistogram: {
+        field: string;
+        interval?: string;
+        minDocCount?: number;
+        format: string;
+    };
+    aggregations?: {
+        [subAggregations: string]: Aggregation;
+    };
+}
+export interface NumericRange {
+    from?: number;
+    to?: number;
+    key?: string;
+}
+export interface NumericRangeAggregation {
+    range: {
+        field: string;
+        ranges?: NumericRange[];
+    };
+    aggregations?: {
+        [subAggregations: string]: Aggregation;
+    };
+}
+export interface NumericRangeAggregation {
+    range: {
+        field: string;
+        ranges?: NumericRange[];
+    };
+    aggregations?: {
+        [subAggregations: string]: Aggregation;
+    };
+}
+export interface DateRange {
+    from?: string;
+    to?: string;
+    key?: string;
+}
+export interface DateRangeAggregation {
+    dateRange: {
+        field: string;
+        format: string;
+        ranges: DateRange[];
+    };
+    aggregations?: {
+        [subAggregations: string]: Aggregation;
+    };
+}
+export interface StatsAggregation {
+    stats: {
+        field: string;
+    };
+}
+export interface GeoDistanceAggregation {
+    geoDistance: {
+        field: string;
+        unit: string;
+        origin?: {
+            lat: string;
+            lon: string;
+        };
+        ranges?: NumericRange[];
+    };
+}
+export interface MinAggregation {
+    min: {
+        field: string;
+    };
+}
+export interface MaxAggregation {
+    max: {
+        field: string;
+    };
+}
+export interface ValueCountAggregation {
+    count: {
+        field: string;
+    };
+}
+export interface Highlight {
+    encoder?: 'default' | 'html';
+    tagsSchema?: 'styled';
+    fragmenter?: 'simple' | 'span';
+    fragmentSize?: number;
+    noMatchSize?: number;
+    numberOfFragments?: number;
+    order?: 'score' | 'none';
+    preTag?: string;
+    postTag?: string;
+    requireFieldMatch?: boolean;
+    properties?: Record<string, Highlight>;
+}
+export interface HighlightResult {
+    [highlightedFieldName: string]: string[];
+}
+export interface ExistsFilter {
+    exists: {
+        field: string;
+    };
+}
+export interface NotExistsFilter {
+    notExists: {
+        field: string;
+    };
+}
+export interface HasValueFilter {
+    hasValue: {
+        field: string;
+        values: unknown[];
+    };
+}
+export interface IdsFilter {
+    ids: {
+        values: string[];
+    };
+}
+export interface BooleanFilter {
+    boolean: {
+        must?: Filter[];
+        mustNot?: Filter[];
+        should?: Filter[];
+    };
+}
+export declare type Filter = ExistsFilter | NotExistsFilter | HasValueFilter | IdsFilter | BooleanFilter;
+export declare type FormItemType = 'Input' | 'ItemSet' | 'Layout' | 'OptionSet';
+export declare type InputType = 'Time' | 'DateTime' | 'CheckBox' | 'ComboBox' | 'Long' | 'Double' | 'RadioButton' | 'TextArea' | 'ContentTypeFilter' | 'GeoPoint' | 'TextLine' | 'Tag' | 'CustomSelector' | 'AttachmentUploader' | 'ContentSelector' | 'MediaSelector' | 'ImageSelector' | 'Date' | 'MediaUploader' | 'SiteConfigurator' | 'HtmlArea';
+export interface FormItemSet {
+    formItemType: string | FormItemType;
+    name: string;
+    label: string;
+    customText: string;
+    helpText: string;
+    maximize: boolean;
+    inputType: InputType;
+    occurrences: {
+        maximum: number;
+        minimum: number;
+    };
+    items: FormItem[];
+}
+export interface FormItemLayout {
+    formItemType: string | FormItemType;
+    name: string;
+    label: string;
+    items: FormItem[];
+}
+export declare type ValueType = 'BinaryReference' | 'Boolean' | 'DateTime' | 'Double' | 'GeoPoint' | 'Link' | 'LocalDateTime' | 'LocalDate' | 'LocalTime' | 'Long' | 'PropertySet' | 'Reference' | 'String' | 'Xml';
+export interface FormItemInput {
+    formItemType: string | FormItemType;
+    name: string;
+    label: string;
+    customText: string;
+    helpText: string;
+    validationRegexp: string;
+    maximize: boolean;
+    inputType: InputType;
+    occurrences: {
+        maximum: number;
+        minimum: number;
+    };
+    default: {
+        value: string;
+        type: ValueType;
+    };
+    config: {
+        [configName: string]: {
+            [attributeKey: string]: string;
+            value: string;
+        }[];
+    };
+}
+export interface FormItemOptionSet {
+    formItemType: string | FormItemType;
+    name: string;
+    label: string;
+    expanded: boolean;
+    helpText: string;
+    occurrences: {
+        maximum: number;
+        minimum: number;
+    };
+    selection: {
+        maximum: number;
+        minimum: number;
+    };
+    options: {
+        name: string;
+        label: string;
+        helpText: string;
+        default: boolean;
+        items: FormItem[];
+    }[];
+}
+export declare type FormItem = FormItemSet | FormItemLayout | FormItemOptionSet | FormItemInput;
+export declare type DslQueryType = LiteralUnion<'dateTime' | 'time'> | number | boolean;
+export declare type DslOperator = 'OR' | 'AND';
+export interface TermDslExpression {
+    field: string;
+    value: unknown;
+    type?: DslQueryType;
+    boost?: number;
+}
+export interface InDslExpression {
+    field: string;
+    values: unknown[];
+    type?: DslQueryType;
+    boost?: number;
+}
+export interface LikeDslExpression {
+    field: string;
+    value: string;
+    type?: DslQueryType;
+    boost?: number;
+}
+export interface RangeDslExpression {
+    field: string;
+    type?: DslQueryType;
+    lt?: unknown;
+    lte?: unknown;
+    gt?: unknown;
+    gte?: unknown;
+    boost?: number;
+}
+export interface PathMatchDslExpression {
+    field: string;
+    path: string;
+    minimumMatch?: number;
+    boost?: number;
+}
+export interface MatchAllDslExpression {
+    boost?: number;
+}
+export interface FulltextDslExpression {
+    fields: string[];
+    query: string;
+    operator?: DslOperator;
+}
+export interface NgramDslExpression {
+    fields: string[];
+    query: string;
+    operator?: DslOperator;
+}
+export interface StemmedDslExpression {
+    fields: string[];
+    query: string;
+    language: string;
+}
+export interface BooleanDslExpression {
+    should?: DslExpression | DslExpression[];
+    must?: DslExpression | DslExpression[];
+    mustNot?: DslExpression | DslExpression[];
+    filter?: DslExpression | DslExpression[];
+}
+export declare type DslExpression = TermDslExpression | InDslExpression | LikeDslExpression | RangeDslExpression | PathMatchDslExpression | MatchAllDslExpression | FulltextDslExpression | NgramDslExpression | BooleanDslExpression | StemmedDslExpression;
+export declare type QueryDsl = {
+    boolean: BooleanDslExpression;
+} | {
+    ngram: NgramDslExpression;
+} | {
+    fulltext: FulltextDslExpression;
+} | {
+    matchAll: MatchAllDslExpression;
+} | {
+    pathMatch: PathMatchDslExpression;
+} | {
+    range: RangeDslExpression;
+} | {
+    like: LikeDslExpression;
+} | {
+    in: InDslExpression;
+} | {
+    term: TermDslExpression;
+};
+export declare type SortDirection = 'ASC' | 'DESC';
+export declare type DistanceUnit = 'm' | 'meters' | 'in' | 'inch' | 'yd' | 'yards' | 'ft' | 'feet' | 'km' | 'kilometers' | 'NM' | 'nmi' | 'nauticalmiles' | 'mm' | 'millimeters' | 'cm' | 'centimeters' | 'mi' | 'miles';
+export interface FieldSortDsl {
+    field: string;
+    direction?: SortDirection;
+}
+export interface GeoDistanceSortDsl extends FieldSortDsl {
+    unit?: DistanceUnit;
+    location?: {
+        lat: number;
+        lon: number;
+    };
+}
+export declare type SortDsl = FieldSortDsl | GeoDistanceSortDsl;
+export interface Content {
+    _id: string;
+    _name: string;
+    _path: string;
+    _score: number;
+    creator: string;
+    modifier: string;
+    createdTime: string;
+    modifiedTime: string;
+    owner: string;
+    type: string;
+    displayName: string;
+    hasChildren: boolean;
+    language: string;
+    valid: boolean;
+    originProject: string;
+    childOrder?: string;
+    _sort?: object[];
+    data: Record<string, unknown>;
+    x: XData;
+    attachments: Attachments;
+    publish?: PublishInfo;
+    workflow?: Workflow;
+    inherit?: ContentInheritType[];
+}
+/**
+ * This function fetches a content.
+ *
+ * @example-ref examples/content/get.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ * @param {string} [params.versionId] Version Id of the content.
+ *
+ * @returns {object} The content (as JSON) fetched from the repository.
+ */
+export declare function get(params: GetContentParams): Content | null;
+/**
+ * This function returns a content attachments.
+ *
+ * @example-ref examples/content/getAttachments.js
+ *
+ * @param {string} key Path or id to the content.
+ *
+ * @returns {object} An object with all the attachments that belong to the content, where the key is the attachment name. Or null if the content cannot be found.
+ */
+export declare function getAttachments(key: string): Attachments | null;
+export interface GetAttachmentStreamParams {
+    key: string;
+    name: string;
+}
+/**
+ * This function returns a data-stream for the specified content attachment.
+ *
+ * @example-ref examples/content/getAttachmentStream.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ * @param {string} params.name Attachment name.
+ *
+ * @returns {*} Stream of the attachment data.
+ */
+export declare function getAttachmentStream(params: GetAttachmentStreamParams): object | null;
+export interface AddAttachmentParam {
+    key: string;
+    name: string;
+    mimeType: string;
+    data: object;
+    label?: string;
+}
+/**
+ * Adds an attachment to an existing content.
+ *
+ * @example-ref examples/content/addAttachment.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ * @param {string} params.name Attachment name.
+ * @param {string} params.mimeType Attachment content type.
+ * @param {string} [params.label] Attachment label.
+ * @param {object} params.data Stream with the binary data for the attachment.
+ */
+export declare function addAttachment(params: AddAttachmentParam): void;
+export interface RemoveAttachmentParams {
+    key: string;
+    name: string | string[];
+}
+/**
+ * Removes an attachment from an existing content.
+ *
+ * @example-ref examples/content/removeAttachment.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ * @param {string|string[]} params.name Attachment name, or array of names.
+ */
+export declare function removeAttachment(params: RemoveAttachmentParams): void;
+export interface Site extends Content {
+    description: string;
+}
+export interface GetSiteParams {
+    key?: string | null;
+}
+/**
+ * This function returns the parent site of a content.
+ *
+ * @example-ref examples/content/getSite.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ *
+ * @returns {object} The current site as JSON.
+ */
+export declare function getSite(params: GetSiteParams): Site | null;
+export interface GetSiteConfigParams {
+    key: string;
+    applicationKey: string;
+}
+export declare type SiteConfig = Record<string, unknown>;
+/**
+ * This function returns the site configuration for this app in the parent site of a content.
+ *
+ * @example-ref examples/content/getSiteConfig.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ * @param {string} params.applicationKey Application key.
+ *
+ * @returns {object} The site configuration for current application as JSON.
+ */
+export declare function getSiteConfig(params: GetSiteConfigParams): SiteConfig | null;
+export interface DeleteContentParams {
+    key: string;
+}
+/**
+ * This function deletes a content.
+ *
+ * @example-ref examples/content/delete.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ *
+ * @returns {boolean} True if deleted, false otherwise.
+ */
+declare function _delete(params: DeleteContentParams): boolean;
+export { _delete as delete, };
+export interface ContentsResult {
+    total: number;
+    count: number;
+    hits: Content[];
+    aggregations?: Record<string, AggregationsResult>;
+    highlight?: Record<string, HighlightResult>;
+}
+export interface GetChildContentParams {
+    key: string;
+    start?: number;
+    count?: number;
+    sort?: string;
+}
+/**
+ * This function fetches children of a content.
+ *
+ * @example-ref examples/content/getChildren.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the parent content.
+ * @param {number} [params.start=0] Start index (used for paging).
+ * @param {number} [params.count=10] Number of contents to fetch.
+ * @param {string} [params.sort] Sorting expression.
+ *
+ * @returns {Object} Result (of content) fetched from the repository.
+ */
+export declare function getChildren(params: GetChildContentParams): ContentsResult;
+export declare type IdGeneratorSupplier = (value: string) => string;
+export interface CreateContentParams {
+    name?: string;
+    parentPath: string;
+    displayName?: string;
+    requireValid?: boolean;
+    refresh?: boolean;
+    contentType: string;
+    language?: string;
+    childOrder?: string;
+    data?: object;
+    x?: object;
+    idGenerator: IdGeneratorSupplier;
+    workflow?: object;
+}
+/**
+ * This function creates a content.
+ *
+ * The parameter `name` is optional, but if it is not set then `displayName` must be specified. When name is not set, the
+ * system will auto-generate a `name` based on the `displayName`, by lower-casing and replacing certain characters. If there
+ * is already a content with the auto-generated name, a suffix will be added to the `name` in order to make it unique.
+ *
+ * To create a content where the name is not important and there could be multiple instances under the same parent content,
+ * skip the `name` parameter and specify a `displayName`.
+ *
+ * @example-ref examples/content/create.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} [params.name] Name of content.
+ * @param {string} params.parentPath Path to place content under.
+ * @param {string} [params.displayName] Display name. Default is same as `name`.
+ * @param {boolean} [params.requireValid=true] The content has to be valid, according to the content type, to be created. If requireValid=true and the content is not strictly valid, an error will be thrown.
+ * @param {boolean} [params.refresh=true] If refresh is true, the created content will to be searchable through queries immediately, else within 1 second. Since there is a performance penalty doing this refresh, refresh should be set to false for bulk operations.
+ * @param {string} params.contentType Content type to use.
+ * @param {string} [params.language] The language tag representing the content’s locale.
+ * @param {string} [params.childOrder] Default ordering of children when doing getChildren if no order is given in query
+ * @param {object} params.data Actual content data.
+ * @param {object} [params.x] eXtra data to use.
+ * @param {object} [params.workflow] Workflow information to use. Default has state READY and empty check list.
+ *
+ * @returns {object} Content created as JSON.
+ */
+export declare function create(params: CreateContentParams): Content;
+export interface QueryContentParams {
+    start?: number;
+    count?: number;
+    query?: QueryDsl | string;
+    sort?: string | SortDsl | SortDsl[];
+    filters?: Filter | Filter[];
+    aggregations?: Record<string, Aggregation>;
+    contentTypes?: string[];
+    highlight?: Highlight;
+}
+/**
+ * This command queries content.
+ *
+ * @example-ref examples/content/query.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {number} [params.start=0] Start index (used for paging).
+ * @param {number} [params.count=10] Number of contents to fetch.
+ * @param {string|object} params.query Query expression.
+ * @param {object|object[]} [params.filters] Filters to apply to query result
+ * @param {string|object|object[]} [params.sort] Sorting expression.
+ * @param {object} [params.aggregations] Aggregations expression.
+ * @param {string[]} [params.contentTypes] Content types to filter on.
+ *
+ * @returns {object} Result of query.
+ */
+export declare function query(params: QueryContentParams): ContentsResult;
+export interface ModifyContentParams {
+    key: string;
+    editor: (v: Content) => Content;
+    requireValid?: boolean;
+}
+/**
+ * This function modifies a content.
+ *
+ * @example-ref examples/content/modify.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ * @param {function} params.editor Editor callback function.
+ * @param {boolean} [params.requireValid=true] The content has to be valid, according to the content type, to be updated. If requireValid=true and the content is not strictly valid, an error will be thrown.
+ *
+ * @returns {object} Modified content as JSON.
+ */
+export declare function modify(params: ModifyContentParams): Content | null;
+export interface Schedule {
+    from?: string;
+    to?: string;
+}
+export interface PublishContentParams {
+    keys: string[];
+    sourceBranch: string;
+    targetBranch: string;
+    schedule: Schedule;
+    includeChildren?: boolean;
+    excludeChildrenIds?: string[];
+    includeDependencies?: boolean;
+    message: string;
+}
+export interface PublishContentResult {
+    pushedContents: string[];
+    deletedContents: string[];
+    failedContents: string[];
+}
+/**
+ * This function publishes content to a branch.
+ *
+ * @example-ref examples/content/publish.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string[]} params.keys List of all content keys(path or id) that should be published.
+ * @param {string} params.sourceBranch The branch where the content to be published is stored.
+ * @param {string} params.targetBranch The branch to which the content should be published.  Technically, publishing is just a move from one branch
+ * to another, and publishing user content from master to draft is therefore also valid usage of this function, which may be practical if user input to a web-page is stored on master.
+ * @param {object} [params.schedule] Schedule the publish.
+ * @param {string} [params.schedule.from] Time from which the content is considered published. Defaults to the time of the publish
+ * @param {string} [params.schedule.to] Time until which the content is considered published.
+ * @param {string[]} [params.excludeChildrenIds] List of all content keys which children should be excluded from publishing content.
+ * @param {boolean} [params.includeDependencies=true] Whether all related content should be included when publishing content.
+ * @param {string} params.message Publish message.
+ *
+ * @returns {object} Status of the publish operation in JSON.
+ */
+export declare function publish(params: PublishContentParams): PublishContentResult;
+export interface UnpublishContentParams {
+    keys: string[];
+}
+/**
+ * This function unpublishes content that had been published to the master branch.
+ *
+ * @example-ref examples/content/unpublish.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string[]} params.keys List of all content keys(path or id) that should be unpublished.
+ *
+ * @returns {string[]} List with ids of the content that were unpublished.
+ */
+export declare function unpublish(params: UnpublishContentParams): string[];
+export interface ContentExistsParams {
+    key: string;
+}
+/**
+ * Check if content exists.
+ *
+ * @example-ref examples/content/exists.js
+ *
+ * @param {string} params.key content id.
+ *
+ * @returns {boolean} True if exist, false otherwise.
+ */
+export declare function exists(params: ContentExistsParams): boolean;
+export interface CreateMediaParams {
+    name: string;
+    parentPath: string;
+    mimeType: string;
+    focalX: string;
+    focalY: string;
+    data: string;
+    idGenerator: (v: string) => string;
+}
+/**
+ * Creates a media content.
+ *
+ * @example-ref examples/content/createMedia.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.name Name of content.
+ * @param {string} [params.parentPath=/] Path to place content under.
+ * @param {string} [params.mimeType] Mime-type of the data.
+ * @param {number} [params.focalX] Focal point for X axis (if it's an image).
+ * @param {number} [params.focalY] Focal point for Y axis (if it's an image).
+ * @param  params.data Data (as stream) to use.
+ *
+ * @returns {object} Returns the created media content.
+ */
+export declare function createMedia(params: CreateMediaParams): Content;
+export interface MoveContentParams {
+    source: string;
+    target: string;
+}
+/**
+ * Rename a content or move it to a new path.
+ *
+ * @example-ref examples/content/move.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.source Path or id of the content to be moved or renamed.
+ * @param {string} params.target New path or name for the content. If the target ends in slash '/', it specifies the parent path where to be moved. Otherwise it means the new desired path or name for the content.
+ *
+ * @returns {object} The content that was moved or renamed.
+ */
+export declare function move(params: MoveContentParams): Content;
+export interface ArchiveContentParams {
+    content: string;
+}
+/**
+ * Archive a content.
+ *
+ * @example-ref examples/content/archive.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.content Path or id of the content to be archived.
+ *
+ * @returns {string[]} List with ids of the contents that were archived.
+ */
+export declare function archive(params: ArchiveContentParams): string[];
+export interface RestoreContentParams {
+    content: string;
+    path: string;
+}
+/**
+ * Restore a content from the archive.
+ *
+ * @example-ref examples/content/restore.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.content Path or id of the content to be restored.
+ * @param {string} params.path Path of parent for restored content.
+ *
+ * @returns {string[]} List with ids of the contents that were restored.
+ */
+export declare function restore(params: RestoreContentParams): string[];
+export declare type Permission = 'READ' | 'CREATE' | 'MODIFY' | 'DELETE' | 'PUBLISH' | 'READ_PERMISSIONS' | 'WRITE_PERMISSIONS';
+export interface AccessControlEntry {
+    principal: string;
+    allow?: Permission[];
+    deny?: Permission[];
+}
+export interface SetPermissionsParams {
+    key: string;
+    inheritPermissions: boolean;
+    overwriteChildPermissions: boolean;
+    permissions: AccessControlEntry[];
+}
+export interface Permissions {
+    inheritsPermissions: boolean;
+    permissions?: Permission[];
+}
+/**
+ * Sets permissions on a content.
+ *
+ * @example-ref examples/content/setPermissions.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Path or id of the content.
+ * @param {boolean} [params.inheritPermissions] Set to true if the content must inherit permissions. Default to false.
+ * @param {boolean} [params.overwriteChildPermissions] Set to true to overwrite child permissions. Default to false.
+ * @param {array} [params.permissions] Array of permissions.
+ * @param {string} params.permissions.principal Principal key.
+ * @param {array} params.permissions.allow Allowed permissions.
+ * @param {array} params.permissions.deny Denied permissions.
+ * @returns {boolean} True if successful, false otherwise.
+ */
+export declare function setPermissions(params: SetPermissionsParams): boolean;
+export interface GetPermissionsParams {
+    key: string;
+}
+/**
+ * Gets permissions on a content.
+ *
+ * @example-ref examples/content/getPermissions.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Path or id of the content.
+ * @returns {object} Content permissions.
+ */
+export declare function getPermissions(params: GetPermissionsParams): Permissions | null;
+export interface Icon {
+    data: object;
+    mimeType: string;
+    modifiedTime: string;
+}
+/**
+ * @typedef ContentType
+ * @type Object
+ * @property {string} name Name of the content type.
+ * @property {string} displayName Display name of the content type.
+ * @property {string} description Description of the content type.
+ * @property {string} superType Name of the super type, or null if it has no super type.
+ * @property {boolean} abstract Whether or not content of this type may be instantiated.
+ * @property {boolean} final Whether or not it may be used as super type of other content types.
+ * @property {boolean} allowChildContent Whether or not allow creating child items on content of this type.
+ * @property {string} displayNameExpression ES6 string template for generating the content name based on values in the content form.
+ * @property {object} [icon] Icon of the content type.
+ * @property {object} [icon.data] Stream with the binary data for the icon.
+ * @property {string} [icon.mimeType] Mime type of the icon image.
+ * @property {string} [icon.modifiedTime] Modified time of the icon. May be used for caching.
+ * @property {object[]} form Form schema represented as an array of form items: Input, ItemSet, Layout, OptionSet.
+ */
+export interface ContentType {
+    name: string;
+    displayName: string;
+    description: string;
+    superType: string;
+    abstract: boolean;
+    final: boolean;
+    allowChildContent: boolean;
+    displayNameExpression: string;
+    modifiedTime: string;
+    icon?: Icon;
+    form: FormItem[];
+}
+/**
+ * Returns the properties and icon of the specified content type.
+ *
+ * @example-ref examples/content/getType.js
+ *
+ * @param name Name of the content type, as 'app:name' (e.g. 'com.enonic.myapp:article').
+ * @returns {ContentType} The content type object if found, or null otherwise. See ContentType type definition below.
+ */
+export declare function getType(name: string): ContentType | null;
+/**
+ * Returns the list of all the content types currently registered in the system.
+ *
+ * @example-ref examples/content/getTypes.js
+ *
+ * @returns {ContentType[]} Array with all the content types found. See ContentType type definition below.
+ */
+export declare function getTypes(): ContentType[];
+export interface GetOutboundDependenciesParams {
+    key: string;
+}
+/**
+ * Returns outbound dependencies on a content.
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Path or id of the content.
+ * @returns {object} Content Ids.
+ */
+export declare function getOutboundDependencies(params: GetOutboundDependenciesParams): string[];
+export interface ResetInheritanceParams {
+    key: string;
+    projectName: string;
+    inherit: ContentInheritType[];
+}
+export interface ResetInheritanceHandler {
+    setKey(value: string): void;
+    setProjectName(value: string): void;
+    setInherit(value: ContentInheritType[]): void;
+    execute(): void;
+}
+/** Resets dropped inherit flags back.
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Path or id of the content.
+ * @param {string} params.projectName name of project with content.
+ * @param {string[]} params.inherit flags to be reset.
+ */
+export declare function resetInheritance(params: ResetInheritanceParams): void;