@atlaskit/adf-utils 19.21.1 → 19.21.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/adf-utils
 
+## 19.21.2
+
+### Patch Changes
+
+- [`3d63d4f953f04`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3d63d4f953f04) -
+  EDITOR-1171 Unifying adf-utils behaviours for blockTaskItem and taskItem
+- [`0fdcb6f2f96fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fdcb6f2f96fd) -
+  Sorted type and interface props to improve Atlaskit docs
+
 ## 19.21.1
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -3,9 +3,9 @@
 	"compilerOptions": {
 		"declaration": true,
 		"target": "es5",
-		"composite": true,
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__adf-utils",
-		"rootDir": "../"
+		"rootDir": "../",
+		"composite": true
 	},
 	"include": [
 		"../src/**/*.ts",

package/dist/cjs/scrub/scrub-content.js

@@ -31,7 +31,8 @@ var BYPASS_ATTR_LIST = {
   tableCell: ['background', 'colspan', 'colwidth', 'defaultMarks', 'rowspan'],
   tableHeader: ['background', 'colspan', 'colwidth', 'defaultMarks', 'rowspan'],
   tableRow: ['defaultMarks'],
-  taskItem: ['state']
+  taskItem: ['state'],
+  blockTaskItem: ['state']
 };
 // Ignored via go/ees005
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/es2019/scrub/scrub-content.js

@@ -18,7 +18,8 @@ const BYPASS_ATTR_LIST = {
   tableCell: ['background', 'colspan', 'colwidth', 'defaultMarks', 'rowspan'],
   tableHeader: ['background', 'colspan', 'colwidth', 'defaultMarks', 'rowspan'],
   tableRow: ['defaultMarks'],
-  taskItem: ['state']
+  taskItem: ['state'],
+  blockTaskItem: ['state']
 };
 // Ignored via go/ees005
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/esm/scrub/scrub-content.js

@@ -24,7 +24,8 @@ var BYPASS_ATTR_LIST = {
   tableCell: ['background', 'colspan', 'colwidth', 'defaultMarks', 'rowspan'],
   tableHeader: ['background', 'colspan', 'colwidth', 'defaultMarks', 'rowspan'],
   tableRow: ['defaultMarks'],
-  taskItem: ['state']
+  taskItem: ['state'],
+  blockTaskItem: ['state']
 };
 // Ignored via go/ees005
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/types/builders/types.d.ts

@@ -1,7 +1,7 @@
 export type WithMark = {
-    type: any;
-    marks?: Array<any>;
     [prop: string]: any;
+    marks?: Array<any>;
+    type: any;
 };
 export type WithAppliedMark<T, M> = T & {
     marks?: Array<M>;

package/dist/types/transforms/dedupe-marks-transform.d.ts

@@ -1,8 +1,8 @@
 import { type ADFEntity, type ADFEntityMark } from '../types';
 interface TransformDedupeMarksResult {
-    transformedAdf: ADFEntity;
-    isTransformed: boolean;
     discardedMarks: ADFEntityMark[];
+    isTransformed: boolean;
+    transformedAdf: ADFEntity;
 }
 export declare const transformDedupeMarks: (adf: ADFEntity) => TransformDedupeMarksResult;
 export {};

package/dist/types/transforms/indentation-marks-transform.d.ts

@@ -1,7 +1,7 @@
 import { type ADFEntity } from '../types';
 interface TransformIndentationMarksResult {
-    transformedAdf: ADFEntity;
     isTransformed: boolean;
+    transformedAdf: ADFEntity;
 }
 export declare const transformIndentationMarks: (adf: ADFEntity) => TransformIndentationMarksResult;
 export {};

package/dist/types/transforms/nested-table-transform.d.ts

@@ -1,10 +1,10 @@
 import type { ADFEntity } from '../types';
 export declare const isNestedTableExtension: (extensionNode: ADFEntity) => boolean;
 export declare const transformNestedTablesIncomingDocument: (adf: ADFEntity, options?: {
-    environment?: "renderer" | "editor";
     disableNestedRendererTreatment?: boolean;
+    environment?: "renderer" | "editor";
 }) => {
-    transformedAdf: ADFEntity;
     isTransformed: boolean;
+    transformedAdf: ADFEntity;
 };
 export declare const transformNestedTableNodeOutgoingDocument: (tableCellNode: ADFEntity) => ADFEntity;

package/dist/types/transforms/nodes-missing-content-transform.d.ts

@@ -1,7 +1,7 @@
 import { type ADFEntity } from '../types';
 interface TransformNodesMissingContentResult {
-    transformedAdf: ADFEntity;
     isTransformed: boolean;
+    transformedAdf: ADFEntity;
 }
 export declare const transformNodesMissingContent: (adf: ADFEntity) => TransformNodesMissingContentResult;
 export {};

package/dist/types/types/index.d.ts

@@ -1,18 +1,18 @@
 export interface ADFEntityMark {
-    type: string;
     attrs?: {
         [name: string]: any;
     };
+    type: string;
 }
 export interface ADFEntity {
-    type: string;
+    [key: string]: any;
     attrs?: {
         [name: string]: any;
     };
     content?: Array<ADFEntity | undefined>;
     marks?: Array<ADFEntityMark>;
     text?: string;
-    [key: string]: any;
+    type: string;
 }
 export type Visitor = (node: ADFEntity, parent: EntityParent, index: number, depth: number) => ADFEntity | false | undefined | void;
 export type VisitorCollection = {

package/dist/types/types/validatorTypes.d.ts

@@ -1,105 +1,95 @@
 import type { ADFEntity, ADFEntityMark } from '../types';
 export interface MarkValidationResult {
-    valid: boolean;
-    originalMark: ADFEntityMark;
-    newMark?: ADFEntityMark;
     errorCode?: ValidationError['code'];
     message?: string;
+    newMark?: ADFEntityMark;
+    originalMark: ADFEntityMark;
+    valid: boolean;
 }
 export interface Output {
-    valid: boolean;
     entity?: ADFEntity;
+    valid: boolean;
 }
 export interface NodeValidationResult {
-    valid: boolean;
     entity?: ADFEntity;
     marksValidationOutput?: MarkValidationResult[];
+    valid: boolean;
 }
 export interface ValidatorContent {
-    type: 'array';
-    items: Array<string | Array<string>>;
-    minItems?: number;
-    maxItems?: number;
-    optional?: boolean;
     allowUnsupportedBlock: boolean;
     allowUnsupportedInline: boolean;
     isTupleLike?: boolean;
+    items: Array<string | Array<string>>;
+    maxItems?: number;
+    minItems?: number;
+    optional?: boolean;
+    type: 'array';
 }
 export type AttributesSpec = {
-    type: 'number';
-    optional?: boolean;
-    minimum: number;
     maximum: number;
-} | {
-    type: 'integer';
-    optional?: boolean;
     minimum: number;
-    maximum: number;
+    optional?: boolean;
+    type: 'number';
 } | {
-    type: 'boolean';
+    maximum: number;
+    minimum: number;
     optional?: boolean;
+    type: 'integer';
 } | {
-    type: 'string';
     optional?: boolean;
+    type: 'boolean';
+} | {
     minLength?: number;
+    optional?: boolean;
     pattern?: RegExp;
+    type: 'string';
     validatorFn?: string;
 } | {
+    optional?: boolean;
     type: 'enum';
     values: Array<string>;
-    optional?: boolean;
 } | {
-    type: 'object';
     optional?: boolean;
+    type: 'object';
 } | {
-    type: 'array';
+    isTupleLike?: boolean;
     items: Array<AttributesSpec>;
-    optional?: boolean;
-    minItems?: number;
     maxItems?: number;
-    isTupleLike?: boolean;
+    minItems?: number;
+    optional?: boolean;
+    type: 'array';
 } | ValidatorSpecAttrs;
 export interface ValidatorSpecAttrs {
+    optional?: boolean;
     props: {
         [key: string]: AttributesSpec;
     };
-    optional?: boolean;
 }
 export interface ValidatorSpec {
+    maxItems?: number;
+    minItems?: number;
     props?: {
-        type?: {
-            type: 'enum';
-            values: Array<string>;
-        };
         attrs?: ValidatorSpecAttrs;
         content?: ValidatorContent;
-        text?: AttributesSpec;
         marks?: {
-            type: 'array';
             items: Array<Array<string>>;
             maxItems?: number;
             optional?: boolean;
+            type: 'array';
+        };
+        text?: AttributesSpec;
+        type?: {
+            type: 'enum';
+            values: Array<string>;
         };
     };
-    minItems?: number;
-    maxItems?: number;
     required?: Array<string>;
 }
 export interface ValidationErrorMap {
-    MISSING_PROPERTIES: {
-        props: Array<string>;
-    };
-    REDUNDANT_PROPERTIES: {
-        props: Array<string>;
-    };
-    REDUNDANT_ATTRIBUTES: {
+    DEPRECATED: never;
+    INVALID_ATTRIBUTES: {
         attrs: Array<string>;
     };
-    REDUNDANT_MARKS: {
-        marks: Array<string>;
-    };
-    INVALID_TYPE: never;
-    INVALID_TEXT: never;
     INVALID_CONTENT: {
         parentType?: string;
     };
@@ -108,13 +98,23 @@ export interface ValidationErrorMap {
         requiredLength: number;
         type: RequiredContentLength;
     };
-    INVALID_ATTRIBUTES: {
+    INVALID_TEXT: never;
+    INVALID_TYPE: never;
+    MISSING_PROPERTIES: {
+        props: Array<string>;
+    };
+    REDUNDANT_ATTRIBUTES: {
         attrs: Array<string>;
     };
+    REDUNDANT_MARKS: {
+        marks: Array<string>;
+    };
+    REDUNDANT_PROPERTIES: {
+        props: Array<string>;
+    };
     UNSUPPORTED_ATTRIBUTES: {
         attrs: Array<string>;
     };
-    DEPRECATED: never;
 }
 export type RequiredContentLength = 'minimum' | 'maximum';
 export type Content = Array<string | [string, object] | Array<string>>;
@@ -127,8 +127,8 @@ export interface ValidationError {
 export type ErrorCallback = (entity: ADFEntity, error: ValidationError, options: ErrorCallbackOptions) => ADFEntity | undefined;
 export type ValidationMode = 'strict' | 'loose';
 export interface ValidationOptions {
-    mode?: ValidationMode;
     allowPrivateAttributes?: boolean;
+    mode?: ValidationMode;
 }
 export interface SpecValidatorResult {
     hasValidated: boolean;
@@ -136,10 +136,10 @@ export interface SpecValidatorResult {
 }
 export type Err = <T extends ValidationErrorType>(code: T, msg: string, meta?: T extends keyof ValidationErrorMap ? ValidationErrorMap[T] : never) => NodeValidationResult;
 export interface ErrorCallbackOptions {
-    isNodeAttribute?: boolean;
-    isMark?: any;
+    allowNestedTables?: boolean;
     allowUnsupportedBlock?: boolean;
     allowUnsupportedInline?: boolean;
-    allowNestedTables?: boolean;
+    isMark?: any;
+    isNodeAttribute?: boolean;
 }
 export type Validate = (entity: ADFEntity, errorCallback?: ErrorCallback, allowed?: Content, parentSpec?: ValidatorSpec) => Output;

package/dist/types-ts4.5/builders/types.d.ts

@@ -1,7 +1,7 @@
 export type WithMark = {
-    type: any;
-    marks?: Array<any>;
     [prop: string]: any;
+    marks?: Array<any>;
+    type: any;
 };
 export type WithAppliedMark<T, M> = T & {
     marks?: Array<M>;

package/dist/types-ts4.5/transforms/dedupe-marks-transform.d.ts

@@ -1,8 +1,8 @@
 import { type ADFEntity, type ADFEntityMark } from '../types';
 interface TransformDedupeMarksResult {
-    transformedAdf: ADFEntity;
-    isTransformed: boolean;
     discardedMarks: ADFEntityMark[];
+    isTransformed: boolean;
+    transformedAdf: ADFEntity;
 }
 export declare const transformDedupeMarks: (adf: ADFEntity) => TransformDedupeMarksResult;
 export {};

package/dist/types-ts4.5/transforms/indentation-marks-transform.d.ts

@@ -1,7 +1,7 @@
 import { type ADFEntity } from '../types';
 interface TransformIndentationMarksResult {
-    transformedAdf: ADFEntity;
     isTransformed: boolean;
+    transformedAdf: ADFEntity;
 }
 export declare const transformIndentationMarks: (adf: ADFEntity) => TransformIndentationMarksResult;
 export {};

package/dist/types-ts4.5/transforms/nested-table-transform.d.ts

@@ -1,10 +1,10 @@
 import type { ADFEntity } from '../types';
 export declare const isNestedTableExtension: (extensionNode: ADFEntity) => boolean;
 export declare const transformNestedTablesIncomingDocument: (adf: ADFEntity, options?: {
-    environment?: "renderer" | "editor";
     disableNestedRendererTreatment?: boolean;
+    environment?: "renderer" | "editor";
 }) => {
-    transformedAdf: ADFEntity;
     isTransformed: boolean;
+    transformedAdf: ADFEntity;
 };
 export declare const transformNestedTableNodeOutgoingDocument: (tableCellNode: ADFEntity) => ADFEntity;

package/dist/types-ts4.5/transforms/nodes-missing-content-transform.d.ts

@@ -1,7 +1,7 @@
 import { type ADFEntity } from '../types';
 interface TransformNodesMissingContentResult {
-    transformedAdf: ADFEntity;
     isTransformed: boolean;
+    transformedAdf: ADFEntity;
 }
 export declare const transformNodesMissingContent: (adf: ADFEntity) => TransformNodesMissingContentResult;
 export {};

package/dist/types-ts4.5/types/index.d.ts

@@ -1,18 +1,18 @@
 export interface ADFEntityMark {
-    type: string;
     attrs?: {
         [name: string]: any;
     };
+    type: string;
 }
 export interface ADFEntity {
-    type: string;
+    [key: string]: any;
     attrs?: {
         [name: string]: any;
     };
     content?: Array<ADFEntity | undefined>;
     marks?: Array<ADFEntityMark>;
     text?: string;
-    [key: string]: any;
+    type: string;
 }
 export type Visitor = (node: ADFEntity, parent: EntityParent, index: number, depth: number) => ADFEntity | false | undefined | void;
 export type VisitorCollection = {

package/dist/types-ts4.5/types/validatorTypes.d.ts

@@ -1,105 +1,95 @@
 import type { ADFEntity, ADFEntityMark } from '../types';
 export interface MarkValidationResult {
-    valid: boolean;
-    originalMark: ADFEntityMark;
-    newMark?: ADFEntityMark;
     errorCode?: ValidationError['code'];
     message?: string;
+    newMark?: ADFEntityMark;
+    originalMark: ADFEntityMark;
+    valid: boolean;
 }
 export interface Output {
-    valid: boolean;
     entity?: ADFEntity;
+    valid: boolean;
 }
 export interface NodeValidationResult {
-    valid: boolean;
     entity?: ADFEntity;
     marksValidationOutput?: MarkValidationResult[];
+    valid: boolean;
 }
 export interface ValidatorContent {
-    type: 'array';
-    items: Array<string | Array<string>>;
-    minItems?: number;
-    maxItems?: number;
-    optional?: boolean;
     allowUnsupportedBlock: boolean;
     allowUnsupportedInline: boolean;
     isTupleLike?: boolean;
+    items: Array<string | Array<string>>;
+    maxItems?: number;
+    minItems?: number;
+    optional?: boolean;
+    type: 'array';
 }
 export type AttributesSpec = {
-    type: 'number';
-    optional?: boolean;
-    minimum: number;
     maximum: number;
-} | {
-    type: 'integer';
-    optional?: boolean;
     minimum: number;
-    maximum: number;
+    optional?: boolean;
+    type: 'number';
 } | {
-    type: 'boolean';
+    maximum: number;
+    minimum: number;
     optional?: boolean;
+    type: 'integer';
 } | {
-    type: 'string';
     optional?: boolean;
+    type: 'boolean';
+} | {
     minLength?: number;
+    optional?: boolean;
     pattern?: RegExp;
+    type: 'string';
     validatorFn?: string;
 } | {
+    optional?: boolean;
     type: 'enum';
     values: Array<string>;
-    optional?: boolean;
 } | {
-    type: 'object';
     optional?: boolean;
+    type: 'object';
 } | {
-    type: 'array';
+    isTupleLike?: boolean;
     items: Array<AttributesSpec>;
-    optional?: boolean;
-    minItems?: number;
     maxItems?: number;
-    isTupleLike?: boolean;
+    minItems?: number;
+    optional?: boolean;
+    type: 'array';
 } | ValidatorSpecAttrs;
 export interface ValidatorSpecAttrs {
+    optional?: boolean;
     props: {
         [key: string]: AttributesSpec;
     };
-    optional?: boolean;
 }
 export interface ValidatorSpec {
+    maxItems?: number;
+    minItems?: number;
     props?: {
-        type?: {
-            type: 'enum';
-            values: Array<string>;
-        };
         attrs?: ValidatorSpecAttrs;
         content?: ValidatorContent;
-        text?: AttributesSpec;
         marks?: {
-            type: 'array';
             items: Array<Array<string>>;
             maxItems?: number;
             optional?: boolean;
+            type: 'array';
+        };
+        text?: AttributesSpec;
+        type?: {
+            type: 'enum';
+            values: Array<string>;
         };
     };
-    minItems?: number;
-    maxItems?: number;
     required?: Array<string>;
 }
 export interface ValidationErrorMap {
-    MISSING_PROPERTIES: {
-        props: Array<string>;
-    };
-    REDUNDANT_PROPERTIES: {
-        props: Array<string>;
-    };
-    REDUNDANT_ATTRIBUTES: {
+    DEPRECATED: never;
+    INVALID_ATTRIBUTES: {
         attrs: Array<string>;
     };
-    REDUNDANT_MARKS: {
-        marks: Array<string>;
-    };
-    INVALID_TYPE: never;
-    INVALID_TEXT: never;
     INVALID_CONTENT: {
         parentType?: string;
     };
@@ -108,13 +98,23 @@ export interface ValidationErrorMap {
         requiredLength: number;
         type: RequiredContentLength;
     };
-    INVALID_ATTRIBUTES: {
+    INVALID_TEXT: never;
+    INVALID_TYPE: never;
+    MISSING_PROPERTIES: {
+        props: Array<string>;
+    };
+    REDUNDANT_ATTRIBUTES: {
         attrs: Array<string>;
     };
+    REDUNDANT_MARKS: {
+        marks: Array<string>;
+    };
+    REDUNDANT_PROPERTIES: {
+        props: Array<string>;
+    };
     UNSUPPORTED_ATTRIBUTES: {
         attrs: Array<string>;
     };
-    DEPRECATED: never;
 }
 export type RequiredContentLength = 'minimum' | 'maximum';
 export type Content = Array<string | [
@@ -130,8 +130,8 @@ export interface ValidationError {
 export type ErrorCallback = (entity: ADFEntity, error: ValidationError, options: ErrorCallbackOptions) => ADFEntity | undefined;
 export type ValidationMode = 'strict' | 'loose';
 export interface ValidationOptions {
-    mode?: ValidationMode;
     allowPrivateAttributes?: boolean;
+    mode?: ValidationMode;
 }
 export interface SpecValidatorResult {
     hasValidated: boolean;
@@ -139,10 +139,10 @@ export interface SpecValidatorResult {
 }
 export type Err = <T extends ValidationErrorType>(code: T, msg: string, meta?: T extends keyof ValidationErrorMap ? ValidationErrorMap[T] : never) => NodeValidationResult;
 export interface ErrorCallbackOptions {
-    isNodeAttribute?: boolean;
-    isMark?: any;
+    allowNestedTables?: boolean;
     allowUnsupportedBlock?: boolean;
     allowUnsupportedInline?: boolean;
-    allowNestedTables?: boolean;
+    isMark?: any;
+    isNodeAttribute?: boolean;
 }
 export type Validate = (entity: ADFEntity, errorCallback?: ErrorCallback, allowed?: Content, parentSpec?: ValidatorSpec) => Output;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/adf-utils",
-	"version": "19.21.1",
+	"version": "19.21.2",
 	"description": "Set of utilities to traverse, modify and create ADF documents.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"