@enonic-types/lib-content 8.0.0-B4 → 8.0.0-B5

package/content.d.ts

@@ -11,7 +11,7 @@ declare global {
         '/lib/xp/content': typeof import('./content');
     }
 }
-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';
+import { Aggregations, AggregationsResult, AggregationsToAggregationResults, 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>;
@@ -33,20 +33,19 @@ export interface PatchableContent<Data extends Record<string, unknown> = Record<
     createdTime: string;
     modifier: UserKey;
     modifiedTime: string;
-    publishInfo: PublishInfo;
+    publish: PublishInfo;
     processedReferences: string[];
-    workflowInfo: Workflow;
+    workflow: Workflow;
     manualOrderValue: number;
     inherit: ContentInheritValue[];
     variantOf: string;
-    modifyAttachments: Attachment;
-    removeAttachments: string[];
-    createAttachments: AddAttachmentParam[];
+    attachments: Attachments;
     validationErrors: ValidationError[];
     type: Type;
     childOrder: string;
     originProject: string;
     originalParentPath: string;
+    originalName: string;
     archivedTime: string;
     archivedBy: UserKey;
 }
@@ -246,7 +245,9 @@ export interface CreateContentParams<Data, Type extends string, _Component exten
  * @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.page] Page configuration to use.
  * @param {object} [params.x] eXtra data to use.
+ * @param {function} [params.idGenerator] Function used to generate the id-suffix appended to the content name.
  * @param {object} [params.workflow] Workflow information to use. Default has state READY and empty check list.
  *
  * @returns {object} Content created as JSON.
@@ -270,11 +271,12 @@ export interface QueryContentParams<AggregationInput extends Aggregations = neve
  * @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 {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.
+ * @param {object} [params.highlight] Highlight expression.
  *
  * @returns {object} Result of query.
  */
@@ -292,10 +294,28 @@ export interface UpdateContentParams<Data, Type extends string> {
     editor: (v: Content<Data, Type>) => Content<Data, Type>;
     requireValid?: boolean;
 }
+export interface ModifyAttachmentParam {
+    name: string;
+    label?: string;
+    mimeType?: string;
+    sha512?: string;
+    size?: number;
+}
+export interface CreateAttachmentParam {
+    name: string;
+    label?: string;
+    mimeType?: string;
+    data?: ByteSource | string;
+}
+export interface PatchAttachmentsParam {
+    createAttachments?: CreateAttachmentParam[];
+    modifyAttachments?: ModifyAttachmentParam[];
+    removeAttachments?: string[];
+}
 export interface PatchContentParams {
     key: string;
-    patcher: (v: PatchableContent) => PatchableContent;
-    attachments?: AddAttachmentParam[];
+    patcher: (v: PatchableContent) => PatchableContent | void;
+    attachments?: PatchAttachmentsParam;
     branches?: string[];
     skipSync?: boolean;
 }
@@ -341,6 +361,10 @@ export declare function update<Data extends Record<string, unknown> = Record<str
  * @param {object} params JSON with the parameters.
  * @param {string} params.key Path or id to the content.
  * @param {function} params.patcher Patcher callback function.
+ * @param {object} [params.attachments] Attachments to create, modify or remove on the patched content.
+ * @param {object[]} [params.attachments.createAttachments] Attachments to add to the content.
+ * @param {object[]} [params.attachments.modifyAttachments] Existing attachments to modify on the content.
+ * @param {string[]} [params.attachments.removeAttachments] Names of attachments to remove from the content.
  * @param {boolean} [params.skipSync=false] If true, the content will not be immediately synced to the child projects.
  * @param {string[]} [params.branches=[]] List of branches to patch the content in. If not specified, the context's branch is used.
  *
@@ -397,7 +421,6 @@ export declare function updateWorkflow(params: UpdateWorkflowParams): UpdateWork
 export interface PublishContentParams {
     keys: string[];
     schedule?: Schedule;
-    includeChildren?: boolean;
     /**
      * @deprecated Use excludeDescendantsOf instead.
      */
@@ -451,7 +474,8 @@ export interface ContentExistsParams {
  *
  * @example-ref examples/content/exists.js
  *
- * @param {string} params.key content id.
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Path or id of the content.
  *
  * @returns {boolean} True if exist, false otherwise.
  */
@@ -521,7 +545,7 @@ export interface ArchiveContentParams {
 export declare function archive(params: ArchiveContentParams): string[];
 export interface RestoreContentParams {
     content: string;
-    path: string;
+    path?: string;
 }
 /**
  * Restore a content from the archive.
@@ -530,7 +554,7 @@ export interface RestoreContentParams {
  *
  * @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.
+ * @param {string} [params.path] Path of parent for restored content.
  *
  * @returns {string[]} List with ids of the contents that were restored.
  */
@@ -563,11 +587,11 @@ export interface Permissions {
  *
  * @param {object} params JSON parameters.
  * @param {string} params.key Path or id of the content.
- * @param {string} [params.scope] Scope of operation. Possible values are 'SINGE', 'TREE' or 'SUBTREE'. Default is 'SINGLE'.
+ * @param {string} [params.scope] Scope of operation. Possible values are 'SINGLE', 'TREE' or 'SUBTREE'. Default is 'SINGLE'.
  * @param {array} [params.permissions] Array of permissions. Cannot be used together with addPermissions and removePermissions.
  * @param {string} params.permissions.principal Principal key.
- * @param {array} params.permissions.allow Allowed permissions.
- * @param {array} params.permissions.deny Denied permissions.
+ * @param {array} [params.permissions.allow] Allowed permissions.
+ * @param {array} [params.permissions.deny] Denied permissions.
  * @param {array} [params.addPermissions] Array of permissions to add. Cannot be used together with permissions.
  * @param {array} [params.removePermissions] Array of permissions to remove. Cannot be used together with permissions.
  *
@@ -602,6 +626,7 @@ export interface Icon {
  * @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} modifiedTime Modified time of the content type.
  * @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.
@@ -627,7 +652,7 @@ export interface ContentType {
  *
  * @example-ref examples/content/getType.js
  *
- * @param name Name of the content type, as 'app:name' (e.g. 'com.enonic.myapp:article').
+ * @param {string} 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;
@@ -647,7 +672,7 @@ export interface GetOutboundDependenciesParams {
  *
  * @param {object} params JSON parameters.
  * @param {string} params.key Path or id of the content.
- * @returns {object} Content Ids.
+ * @returns {string[]} List of content ids.
  */
 export declare function getOutboundDependencies(params: GetOutboundDependenciesParams): string[];
 export interface ResetInheritanceParams {
@@ -682,7 +707,6 @@ export interface ModifyMediaParams {
     focalX?: number;
     focalY?: number;
     tags?: string | string[];
-    workflow?: Workflow;
 }
 export interface UpdateMediaParams {
     key: string;
@@ -694,7 +718,6 @@ export interface UpdateMediaParams {
     focalX?: number;
     focalY?: number;
     tags?: string | string[];
-    workflow?: Workflow;
 }
 /** This function modifies a media content.
  *
@@ -708,7 +731,6 @@ export interface UpdateMediaParams {
  * @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] Focal point for X axis (if it's an image).
  * @param {number} [params.focalY] Focal point for Y axis (if it's an image).
  *
@@ -727,7 +749,6 @@ export declare function modifyMedia<Data = Record<string, unknown>, Type extends
  * @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] Focal point for X axis (if it's an image).
  * @param {number} [params.focalY] Focal point for Y axis (if it's an image).
  *

package/package.json

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