@enonic-types/lib-content 7.11.3 → 7.12.0-RC1

package/content.d.ts

@@ -13,8 +13,8 @@ declare global {
     interface XpXData {
     }
 }
-import type { ByteSource, Content, PublishInfo } from '@enonic-types/core';
-export type { Attachment, ByteSource, PublishInfo, Content, Component, Region, } from '@enonic-types/core';
+import type { Aggregations, AggregationsResult, AggregationsToAggregationResults, ByteSource, Content, Filter, FormItem, Highlight, HighlightResult, PublishInfo, QueryDsl, SortDsl } from '@enonic-types/core';
+export type { Aggregation, Aggregations, AggregationsResult, Attachment, BooleanDslExpression, BooleanFilter, BucketsAggregationResult, BucketsAggregationsUnion, ByteSource, Component, Content, DateBucket, DateHistogramAggregation, DateRange, DateRangeAggregation, ExistsDslExpression, ExistsFilter, Filter, FormItem, FormItemInlineMixin, FormItemInput, FormItemLayout, FormItemOptionSet, FormItemSet, FulltextDslExpression, GeoDistanceAggregation, HasValueFilter, Highlight, HighlightResult, HistogramAggregation, IdsFilter, InDslExpression, LikeDslExpression, MatchAllDslExpression, MaxAggregation, MinAggregation, NgramDslExpression, NotExistsFilter, NumericRange, NumericRangeAggregation, PathMatchDslExpression, PublishInfo, QueryDsl, RangeDslExpression, Region, SingleValueMetricAggregationResult, SingleValueMetricAggregationsUnion, StatsAggregation, StatsAggregationResult, StemmedDslExpression, TermDslExpression, TermsAggregation, ValueCountAggregation, } from '@enonic-types/core';
 declare type Attachments = Content['attachments'];
 declare type ContentInheritType = Content['inherit'];
 declare type Workflow = Content['workflow'];
@@ -25,346 +25,6 @@ export interface GetContentParams {
     key: string;
     versionId?: string | null;
 }
-export interface Bucket {
-    [subAggregationName: string]: AggregationsResult | 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 BucketsAggregationResult {
-    buckets: (DateBucket | NumericBucket)[];
-}
-export interface StatsAggregationResult {
-    count: number;
-    min: number;
-    max: number;
-    avg: number;
-    sum: number;
-}
-export interface SingleValueMetricAggregationResult {
-    value: number;
-}
-export declare type AggregationsResult = BucketsAggregationResult | StatsAggregationResult | SingleValueMetricAggregationResult;
-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?: Record<string, Aggregation>;
-}
-export interface HistogramAggregation {
-    histogram: {
-        field: string;
-        order?: string;
-        interval?: number;
-        extendedBoundMin?: number;
-        extendedBoundMax?: number;
-        minDocCount?: number;
-    };
-    aggregations?: Record<string, Aggregation>;
-}
-export interface DateHistogramAggregation {
-    dateHistogram: {
-        field: string;
-        interval?: string;
-        minDocCount?: number;
-        format: string;
-    };
-    aggregations?: Record<string, Aggregation>;
-}
-export interface NumericRange {
-    from?: number;
-    to?: number;
-    key?: string;
-}
-export interface NumericRangeAggregation {
-    range: {
-        field: string;
-        ranges?: NumericRange[];
-    };
-    aggregations?: Record<string, Aggregation>;
-}
-export interface NumericRangeAggregation {
-    range: {
-        field: string;
-        ranges?: NumericRange[];
-    };
-    aggregations?: Record<string, Aggregation>;
-}
-export interface DateRange {
-    from?: string;
-    to?: string;
-    key?: string;
-}
-export interface DateRangeAggregation {
-    dateRange: {
-        field: string;
-        format: string;
-        ranges: DateRange[];
-    };
-    aggregations?: Record<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 = 'dateTime' | 'time';
-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;
-    boost?: number;
-}
-export interface NgramDslExpression {
-    fields: string[];
-    query: string;
-    operator?: DslOperator;
-    boost?: number;
-}
-export interface StemmedDslExpression {
-    fields: string[];
-    query: string;
-    language: string;
-    operator?: DslOperator;
-    boost?: number;
-}
-export interface ExistsDslExpression {
-    field: string;
-    boost?: number;
-}
-export interface BooleanDslExpression {
-    should?: QueryDsl | QueryDsl[];
-    must?: QueryDsl | QueryDsl[];
-    mustNot?: QueryDsl | QueryDsl[];
-    filter?: QueryDsl | QueryDsl[];
-    boost?: number;
-}
-export declare type QueryDsl = {
-    boolean: BooleanDslExpression;
-} | {
-    ngram: NgramDslExpression;
-} | {
-    stemmed: StemmedDslExpression;
-} | {
-    fulltext: FulltextDslExpression;
-} | {
-    matchAll: MatchAllDslExpression;
-} | {
-    pathMatch: PathMatchDslExpression;
-} | {
-    range: RangeDslExpression;
-} | {
-    like: LikeDslExpression;
-} | {
-    in: InDslExpression;
-} | {
-    term: TermDslExpression;
-} | {
-    exists: ExistsDslExpression;
-};
-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;
 /**
  * This function fetches a content.
  *
@@ -490,11 +150,11 @@ export interface DeleteContentParams {
  */
 declare function _delete(params: DeleteContentParams): boolean;
 export { _delete as delete, };
-export interface ContentsResult<Hit extends Content<unknown>> {
+export interface ContentsResult<Hit extends Content<unknown>, AggregationOutput extends Record<string, AggregationsResult>> {
     total: number;
     count: number;
     hits: Hit[];
-    aggregations?: Record<string, AggregationsResult>;
+    aggregations: AggregationOutput;
     highlight?: Record<string, HighlightResult>;
 }
 export interface GetChildContentParams {
@@ -516,7 +176,7 @@ export interface GetChildContentParams {
  *
  * @returns {Object} Result (of content) fetched from the repository.
  */
-export declare function getChildren<Hit extends Content<unknown> = Content>(params: GetChildContentParams): ContentsResult<Hit>;
+export declare function getChildren<Hit extends Content<unknown> = Content, AggregationOutput extends Record<string, AggregationsResult> = never>(params: GetChildContentParams): ContentsResult<Hit, AggregationOutput>;
 export declare type IdGeneratorSupplier = (value: string) => string;
 export interface CreateContentParams<Data, Type extends string> {
     name?: string;
@@ -527,7 +187,7 @@ export interface CreateContentParams<Data, Type extends string> {
     contentType: Type;
     language?: string;
     childOrder?: string;
-    data?: Data;
+    data: Data;
     x?: XpXData;
     idGenerator?: IdGeneratorSupplier;
     workflow?: Workflow;
@@ -560,13 +220,13 @@ export interface CreateContentParams<Data, Type extends string> {
  * @returns {object} Content created as JSON.
  */
 export declare function create<Data = Record<string, unknown>, Type extends string = string>(params: CreateContentParams<Data, Type>): Content<Data, Type>;
-export interface QueryContentParams {
+export interface QueryContentParams<AggregationInput extends Aggregations> {
     start?: number;
     count?: number;
     query?: QueryDsl | string;
     sort?: string | SortDsl | SortDsl[];
     filters?: Filter | Filter[];
-    aggregations?: Record<string, Aggregation>;
+    aggregations?: AggregationInput;
     contentTypes?: string[];
     highlight?: Highlight;
 }
@@ -586,7 +246,7 @@ export interface QueryContentParams {
  *
  * @returns {object} Result of query.
  */
-export declare function query<Hit extends Content<unknown> = Content>(params: QueryContentParams): ContentsResult<Hit>;
+export declare function query<Hit extends Content<unknown> = Content, AggregationInput extends Aggregations = never>(params: QueryContentParams<AggregationInput>): ContentsResult<Hit, AggregationsToAggregationResults<AggregationInput>>;
 export interface ModifyContentParams<Data, Type extends string> {
     key: string;
     editor: (v: Content<Data, Type>) => Content<Data, Type>;
@@ -621,14 +281,12 @@ export interface PublishContentResult {
     failedContents: string[];
 }
 /**
- * This function publishes content to a branch.
+ * This function publishes content from the draft branch to the master 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
@@ -865,3 +523,64 @@ export interface ResetInheritanceHandler {
  * @param {string[]} params.inherit flags to be reset.
  */
 export declare function resetInheritance(params: ResetInheritanceParams): void;
+export interface ModifyMediaParams {
+    key: string;
+    name: string;
+    data: ByteSource;
+    artist?: string | string[];
+    caption?: string;
+    copyright?: string;
+    focalX?: number;
+    focalY?: number;
+    mimeType?: string;
+    tags?: string | string[];
+    workflow?: Workflow;
+}
+/** This function modifies a media content.
+ *
+ * @example-ref examples/content/modifyMedia.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id to the content.
+ * @param {string} params.name Name to the content.
+ * @param {function} params.data Data (as stream) to use.
+ * @param {string} [params.mimeType] Mime-type of the data.
+ * @param {string|string[]} [params.artist] Artist to the content.
+ * @param {string} [params.caption] Caption to the content.
+ * @param {string} [params.copyright] Copyright to the content.
+ * @param {string|string[]} [params.tags] Tags to the content.
+ * @param {object} [params.workflow] Workflow information to use. Default has state READY and empty check list.
+ * @param {number} [params.focalX=0.5] Focal point for X axis (if it's an image).
+ * @param {number} [params.focalY=0.5] Focal point for Y axis (if it's an image).
+ *
+ * @returns {object} Modified content as JSON.
+ */
+export declare function modifyMedia<Data = Record<string, unknown>, Type extends string = string>(params: ModifyMediaParams): Content<Data, Type> | null;
+export interface DuplicateContentParams {
+    contentId: string;
+    workflow?: Workflow;
+    includeChildren?: boolean;
+    variant?: boolean;
+    parent?: string;
+    name?: string;
+}
+export interface DuplicateContentsResult {
+    contentName: string;
+    sourceContentPath: string;
+    duplicatedContents: string[];
+}
+/** This function duplicates a content.
+ *
+ * @example-ref examples/content/duplicate.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.contentId Id to the content.
+ * @param {object} [params.workflow] Workflow information to use. Default has state READY and empty check list.
+ * @param {boolean} [params.includeChildren=true] Indicates that children contents must be duplicated, too. Default value `true`. Ignored if `variant=true`.
+ * @param {boolean} [params.variant=false] Indicates that duplicated content is a variant. Default value `false`.
+ * @param {string} [params.parent] Destination parent path. By default, a duplicated content will be added as a sibling of the source content.
+ * @param {string} [params.name] New content name.
+ *
+ * @returns {object} summary about duplicated content.
+ */
+export declare function duplicate(params: DuplicateContentParams): DuplicateContentsResult;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-content",
-    "version": "7.11.3",
+    "version": "7.12.0-RC1",
     "description": "Type definitions for lib-content.",
     "types": "content.d.ts",
     "files": [
@@ -27,7 +27,7 @@
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
     "dependencies": {
-        "@enonic-types/core": "7.11.3"
+        "@enonic-types/core": "7.12.0-RC1"
     },
     "publishConfig": {
         "access": "public"