@enonic-types/lib-content 8.0.3 → 8.0.4-B2

package/content.d.ts

@@ -41,7 +41,10 @@ export interface PatchableContent<Data extends Record<string, unknown> = Record<
     variantOf: string;
     attachments: Attachments;
     validationErrors: ValidationError[];
-    type: Type;
+    /**
+     * Read-only. Available on the content passed to the patcher, but assigning it has no effect.
+     */
+    readonly type: Type;
     childOrder: string;
     originProject: string;
     originalParentPath: string;
@@ -429,9 +432,21 @@ export interface PublishContentParams {
     includeDependencies?: boolean;
     message?: string;
 }
+export type PublishFailureReason = 'ALREADY_EXIST' | 'PARENT_NOT_FOUND' | 'ACCESS_DENIED' | 'INVALID' | 'NOT_READY';
+export interface PublishFailure {
+    id: string;
+    reason: PublishFailureReason;
+}
 export interface PublishContentResult {
     pushedContents: string[];
     failedContents: string[];
+    /**
+     * One entry per content the publish engine rejected, with the reason it was rejected.
+     *
+     * Keys that could not be resolved to any content never reach the engine and so have no reason;
+     * they are listed in `failedContents` only.
+     */
+    failed: PublishFailure[];
 }
 /**
  * This function publishes content from the draft branch to the master branch.
@@ -449,7 +464,10 @@ export interface PublishContentResult {
  * @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.
+ * @returns {object} Status of the publish operation in JSON. In addition to the `pushedContents` and `failedContents` id arrays,
+ * `failed` holds one `{id, reason}` entry per content the engine rejected, where reason is one of
+ * `ALREADY_EXIST`, `PARENT_NOT_FOUND`, `ACCESS_DENIED`, `INVALID` or `NOT_READY`. Keys that could not be resolved to any
+ * content never reach the engine and are listed in `failedContents` only.
  */
 export declare function publish(params: PublishContentParams): PublishContentResult;
 export interface UnpublishContentParams {
@@ -572,7 +590,11 @@ export interface ApplyPermissionsParams {
     addPermissions?: AccessControlEntry[];
     removePermissions?: AccessControlEntry[];
 }
-export type ApplyPermissionsResult = Record<string, BranchResult[]>;
+export type ApplyPermissionsResult = Record<string, Permissions>;
+/**
+ * @deprecated Never emitted by `applyPermissions`, which returns one `Permissions` object per content id.
+ * Kept only so existing imports keep resolving.
+ */
 export interface BranchResult {
     branch: string;
     permissions: AccessControlEntry[];
@@ -798,6 +820,14 @@ export interface ContentVersion {
 }
 export interface ContentVersionAction {
     operation: string;
+    /**
+     * Branch the operation was performed in.
+     */
+    origin?: string;
+    /**
+     * Version id of the editorial content this version originates from.
+     */
+    editorial?: string;
     user: string;
     opTime: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-content",
-    "version": "8.0.3",
+    "version": "8.0.4-B2",
     "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.3"
+        "@enonic-types/core": "8.0.4-B2"
     },
     "publishConfig": {
         "access": "public"