@enonic-types/lib-content 8.0.0-A2 → 8.0.0-B1

package/content.d.ts

@@ -11,8 +11,8 @@ declare global {
         '/lib/xp/content': typeof import('./content');
     }
 }
-import { Aggregations, AggregationsResult, AggregationsToAggregationResults, Attachment, ByteSource, Content, ContentComponent, ContentComponentConstraint, ContentInheritValue, Filter, FormItem, Highlight, HighlightResult, Layout, LayoutComponent, Page, PageComponent, Part, PartComponent, PublishInfo, QueryDsl, SortDsl, UserKey, ValidationError, Workflow, WorkflowState } from '@enonic-types/core';
-export type { Aggregation, Aggregations, AggregationsResult, Attachment, BooleanDslExpression, BooleanFilter, Bucket, BucketsAggregationResult, BucketsAggregationsUnion, ByteSource, Component, Content, ContentComponent, ContentComponentConstraint, DateBucket, DateHistogramAggregation, DateRange, DateRangeAggregation, DistanceUnit, DslOperator, DslQueryType, ExistsDslExpression, ExistsFilter, FieldSortDsl, Filter, FormItem, FormItemFormFragment, FormItemInput, FormItemLayout, FormItemOptionSet, FormItemSet, FulltextDslExpression, GeoDistanceAggregation, GeoDistanceSortDsl, GroupKey, HasValueFilter, Highlight, HighlightResult, HistogramAggregation, IdsFilter, InDslExpression, InputType, LikeDslExpression, MatchAllDslExpression, MaxAggregation, MinAggregation, NgramDslExpression, NotExistsFilter, NumericBucket, NumericRange, NumericRangeAggregation, PathMatchDslExpression, PublishInfo, QueryDsl, RangeDslExpression, Region, RoleKey, ScriptValue, SingleValueMetricAggregationResult, SingleValueMetricAggregationsUnion, SortDirection, SortDsl, StatsAggregation, StatsAggregationResult, StemmedDslExpression, TermDslExpression, TermsAggregation, UserKey, ValueCountAggregation, ValueType, } from '@enonic-types/core';
+import { Aggregations, AggregationsResult, AggregationsToAggregationResults, Attachment, ByteSource, ConfigValue, Content, ContentComponent, ContentComponentConstraint, ContentInheritValue, Filter, FormItem, Highlight, HighlightResult, Layout, LayoutComponent, Page, PageComponent, Part, PartComponent, PublishInfo, QueryDsl, SortDsl, UserKey, ValidationError, Workflow, WorkflowState } from '@enonic-types/core';
+export type { Aggregation, Aggregations, AggregationsResult, Attachment, BooleanDslExpression, BooleanFilter, Bucket, BucketsAggregationResult, BucketsAggregationsUnion, ByteSource, Component, Content, ContentComponent, ContentComponentConstraint, DateBucket, DateHistogramAggregation, DateRange, DateRangeAggregation, DistanceUnit, DslOperator, DslQueryType, ExistsDslExpression, ExistsFilter, FieldSortDsl, Filter, FormItem, FormItemFormFragment, FormItemInput, FormItemLayout, FormItemOptionSet, FormItemSet, FulltextDslExpression, GeoDistanceAggregation, GeoDistanceSortDsl, GroupKey, HasValueFilter, Highlight, HighlightResult, HistogramAggregation, IdsFilter, InDslExpression, InputType, LikeDslExpression, MatchAllDslExpression, MaxAggregation, MinAggregation, NgramDslExpression, NotExistsFilter, NumericBucket, NumericRange, NumericRangeAggregation, PathMatchDslExpression, PublishInfo, QueryDsl, RangeDslExpression, Region, RoleKey, ScriptValue, SingleValueMetricAggregationResult, SingleValueMetricAggregationsUnion, SortDirection, SortDsl, StatsAggregation, StatsAggregationResult, StemmedDslExpression, TermDslExpression, TermsAggregation, UserKey, ValueCountAggregation, ValueType, ConfigValue, } from '@enonic-types/core';
 type Attachments = Content['attachments'];
 export type PageComponentWhenAutomaticTemplate = Record<string, never>;
 export interface PageComponentWhenSpecificTemplate {
@@ -349,7 +349,6 @@ export declare function update<Data extends Record<string, unknown> = Record<str
 export declare function patch(params: PatchContentParams): PatchContentResult;
 export interface EditableContentMetadata {
     source: Content;
-    language?: string;
     owner?: string;
     variantOf?: string;
 }
@@ -361,7 +360,7 @@ export interface UpdateMetadataResult<Data extends Record<string, unknown> = Rec
     content: Content<Data, Type>;
 }
 /**
- * This function updates metadata (language, owner, and variantOf) for a content.
+ * This function updates metadata (owner and variantOf) for a content.
  * The update is applied to both master and draft branches.
  *
  * @example-ref examples/content/updateMetadata.js
@@ -460,9 +459,13 @@ export declare function exists(params: ContentExistsParams): boolean;
 export interface CreateMediaParams {
     name: string;
     parentPath?: string;
-    mimeType?: string;
     focalX?: number;
     focalY?: number;
+    artist?: string | string[];
+    tags?: string | string[];
+    caption?: string;
+    altText?: string;
+    copyright?: string;
     data: ByteSource;
     idGenerator?: (v: string) => string;
 }
@@ -474,9 +477,13 @@ export interface CreateMediaParams {
  * @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=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).
+ * @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 {string|string[]} [params.artist] Artist of the media.
+ * @param {string|string[]} [params.tags] Tags of the media.
+ * @param {string} [params.caption] Caption of the media.
+ * @param {string} [params.altText] Alt text of the media.
+ * @param {string} [params.copyright] Copyright of the media.
  * @param  params.data Data (as stream) to use.
  *
  * @returns {object} Returns the created media content.
@@ -589,31 +596,31 @@ export interface Icon {
  * @typedef ContentType
  * @type Object
  * @property {string} name Name of the content type.
- * @property {string} displayName Display name of the content type.
+ * @property {string} title Title 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.
+ * @property {object} config Custom schema configuration for the descriptor.
  */
 export interface ContentType {
     name: string;
-    displayName: string;
+    title: string;
     description: string;
     superType: string;
     abstract: boolean;
     final: boolean;
     allowChildContent: boolean;
-    displayNameExpression: string;
     modifiedTime: string;
     icon?: Icon;
     form: FormItem[];
+    config: Record<string, ConfigValue>;
 }
 /**
  * Returns the properties and icon of the specified content type.
@@ -674,7 +681,6 @@ export interface ModifyMediaParams {
     copyright?: string;
     focalX?: number;
     focalY?: number;
-    mimeType?: string;
     tags?: string | string[];
     workflow?: Workflow;
 }
@@ -687,7 +693,6 @@ export interface UpdateMediaParams {
     copyright?: string;
     focalX?: number;
     focalY?: number;
-    mimeType?: string;
     tags?: string | string[];
     workflow?: Workflow;
 }
@@ -699,14 +704,13 @@ export interface UpdateMediaParams {
  * @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).
+ * @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).
  *
  * @returns {object} Modified content as JSON.
  */
@@ -719,14 +723,13 @@ export declare function modifyMedia<Data = Record<string, unknown>, Type extends
  * @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).
+ * @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).
  *
  * @returns {object} Modified content as JSON.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-content",
-    "version": "8.0.0-A2",
+    "version": "8.0.0-B1",
     "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": "8.0.0-A2"
+        "@enonic-types/core": "8.0.0-B1"
     },
     "publishConfig": {
         "access": "public"