@atlaskit/adf-utils 18.2.0 → 18.2.2

package/dist/types-ts4.5/transforms/helpers.d.ts

@@ -0,0 +1,2 @@
+import { ADFEntity } from '../types';
+export declare const isEmpty: (node: ADFEntity) => boolean;

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

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

package/dist/types-ts4.5/transforms/invalid-media-content-transform.d.ts

@@ -0,0 +1,5 @@
+import { ADFEntity } from '../types';
+export declare const transformInvalidMediaContent: (adf: ADFEntity) => {
+    transformedAdf: ADFEntity;
+    isTransformed: boolean;
+};

package/dist/types-ts4.5/transforms/media-link-transform.d.ts

@@ -0,0 +1,5 @@
+import { ADFEntity } from '../types';
+export declare const transformMediaLinkMarks: (adf: ADFEntity) => {
+    transformedAdf: false | ADFEntity;
+    isTransformed: boolean;
+};

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

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

package/dist/types-ts4.5/transforms/text-link-code-transform.d.ts

@@ -0,0 +1,5 @@
+import { ADFEntity } from '../types';
+export declare const transformTextLinkCodeMarks: (adf: ADFEntity) => {
+    transformedAdf: false | ADFEntity;
+    isTransformed: boolean;
+};

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

@@ -0,0 +1,6 @@
+export { transformMediaLinkMarks } from './transforms/media-link-transform';
+export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';
+export { transformDedupeMarks } from './transforms/dedupe-marks-transform';
+export { transformNodesMissingContent } from './transforms/nodes-missing-content-transform';
+export { transformIndentationMarks } from './transforms/indentation-marks-transform';
+export { transformInvalidMediaContent } from './transforms/invalid-media-content-transform';

package/dist/types-ts4.5/traverse/filter.d.ts

@@ -0,0 +1,2 @@
+import { ADFEntity } from '../types';
+export declare function filter(adf: ADFEntity, callback: (node: ADFEntity) => boolean): Array<ADFEntity>;

package/dist/types-ts4.5/traverse/map.d.ts

@@ -0,0 +1,2 @@
+import { ADFEntity } from '../types';
+export declare function map<T = any>(adf: ADFEntity, callback: (node: ADFEntity) => T): Array<T>;

package/dist/types-ts4.5/traverse/reduce.d.ts

@@ -0,0 +1,2 @@
+import { ADFEntity } from '../types';
+export declare function reduce<T = any>(adf: ADFEntity, callback: (accunulator: T, node: ADFEntity) => T, initial: T): T;

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

@@ -0,0 +1,12 @@
+import { ADFEntity, VisitorCollection } from '../types';
+export declare function validateVisitors(_visitors: VisitorCollection): boolean;
+/**
+ * Provides recursive, depth-first search document traversal. Use visitors collection to define nodes of interest.
+ * If no visitor for given node is defined, no-op happens.
+ * If visitor returns new node, the old node is replaced.
+ * If visitor returns false, node is dropped from the document.
+ * If visitor returns null/undefined/void, original node is used.
+ * @param adf Document to traverse.
+ * @param visitors Collection of visitors.
+ */
+export declare function traverse(adf: ADFEntity, visitors: VisitorCollection): false | ADFEntity;

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

@@ -0,0 +1,4 @@
+export { traverse } from './traverse/traverse';
+export { map } from './traverse/map';
+export { reduce } from './traverse/reduce';
+export { filter } from './traverse/filter';

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

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

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

@@ -0,0 +1,137 @@
+import { ADFEntity, ADFEntityMark } from '../types';
+export interface MarkValidationResult {
+    valid: boolean;
+    originalMark: ADFEntityMark;
+    newMark?: ADFEntityMark;
+    errorCode?: ValidationError['code'];
+    message?: string;
+}
+export interface Output {
+    valid: boolean;
+    entity?: ADFEntity;
+}
+export interface NodeValidationResult {
+    valid: boolean;
+    entity?: ADFEntity;
+    marksValidationOutput?: MarkValidationResult[];
+}
+export interface ValidatorContent {
+    type: 'array';
+    items: Array<string | Array<string>>;
+    minItems?: number;
+    maxItems?: number;
+    optional?: boolean;
+    allowUnsupportedBlock: boolean;
+    allowUnsupportedInline: boolean;
+    isTupleLike?: boolean;
+}
+export type AttributesSpec = {
+    type: 'number';
+    optional?: boolean;
+    minimum: number;
+    maximum: number;
+} | {
+    type: 'integer';
+    optional?: boolean;
+    minimum: number;
+    maximum: number;
+} | {
+    type: 'boolean';
+    optional?: boolean;
+} | {
+    type: 'string';
+    optional?: boolean;
+    minLength?: number;
+    pattern?: RegExp;
+    validatorFn?: string;
+} | {
+    type: 'enum';
+    values: Array<string>;
+    optional?: boolean;
+} | {
+    type: 'object';
+    optional?: boolean;
+} | {
+    type: 'array';
+    items: Array<AttributesSpec>;
+    optional?: boolean;
+};
+export interface ValidatorSpec {
+    props?: {
+        attrs?: {
+            props: {
+                [key: string]: AttributesSpec;
+            };
+            optional?: boolean;
+        };
+        content?: ValidatorContent;
+        text?: AttributesSpec;
+        marks?: {
+            type: 'array';
+            items: Array<Array<string>>;
+            maxItems?: number;
+            optional?: boolean;
+        };
+    };
+    minItems?: number;
+    maxItems?: number;
+    required?: Array<string>;
+}
+export interface ValidationErrorMap {
+    MISSING_PROPERTIES: {
+        props: Array<string>;
+    };
+    REDUNDANT_PROPERTIES: {
+        props: Array<string>;
+    };
+    REDUNDANT_ATTRIBUTES: {
+        attrs: Array<string>;
+    };
+    REDUNDANT_MARKS: {
+        marks: Array<string>;
+    };
+    INVALID_TYPE: never;
+    INVALID_TEXT: never;
+    INVALID_CONTENT: never;
+    INVALID_CONTENT_LENGTH: {
+        length: number;
+        requiredLength: number;
+        type: RequiredContentLength;
+    };
+    INVALID_ATTRIBUTES: {
+        attrs: Array<string>;
+    };
+    UNSUPPORTED_ATTRIBUTES: {
+        attrs: Array<string>;
+    };
+    DEPRECATED: never;
+}
+export type RequiredContentLength = 'minimum' | 'maximum';
+export type Content = Array<string | [
+    string,
+    object
+] | Array<string>>;
+export type ValidationErrorType = keyof ValidationErrorMap;
+export interface ValidationError {
+    code: ValidationErrorType;
+    message: string;
+    meta?: object;
+}
+export type ErrorCallback = (entity: ADFEntity, error: ValidationError, options: ErrorCallbackOptions) => ADFEntity | undefined;
+export type ValidationMode = 'strict' | 'loose';
+export interface ValidationOptions {
+    mode?: ValidationMode;
+    allowPrivateAttributes?: boolean;
+}
+export interface SpecValidatorResult {
+    hasValidated: boolean;
+    result?: NodeValidationResult;
+}
+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;
+    allowUnsupportedBlock?: boolean;
+    allowUnsupportedInline?: boolean;
+}
+export type Validate = (entity: ADFEntity, errorCallback?: ErrorCallback, allowed?: Content, parentSpec?: ValidatorSpec) => Output;

package/dist/types-ts4.5/validator/entry.d.ts

@@ -0,0 +1 @@
+export type { DocNode } from '@atlaskit/adf-schema';

package/dist/types-ts4.5/validator/rules.d.ts

@@ -0,0 +1,3 @@
+export declare const validatorFnMap: {
+    [key: string]: (value: string) => boolean;
+};

package/dist/types-ts4.5/validator/specs/alignment.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                align: {
+                    type: string;
+                    values: string[];
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/annotation.d.ts

@@ -0,0 +1,20 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                id: {
+                    type: string;
+                };
+                annotationType: {
+                    type: string;
+                    values: string[];
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/atomic_inline.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/dist/types-ts4.5/validator/specs/blockCard.d.ts

@@ -0,0 +1,26 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: ({
+            props: {
+                url: {
+                    type: string;
+                    validatorFn: string;
+                };
+                data?: undefined;
+            };
+        } | {
+            props: {
+                data: {
+                    type: string;
+                };
+                url?: undefined;
+            };
+        })[];
+    };
+    required: string[];
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/block_content.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/dist/types-ts4.5/validator/specs/blockquote.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        content: {
+            type: string;
+            items: string[];
+            minItems: number;
+            allowUnsupportedBlock: boolean;
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/bodiedExtension.d.ts

@@ -0,0 +1,50 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                extensionKey: {
+                    type: string;
+                    minLength: number;
+                };
+                extensionType: {
+                    type: string;
+                    minLength: number;
+                };
+                parameters: {
+                    type: string;
+                    optional: boolean;
+                };
+                text: {
+                    type: string;
+                    optional: boolean;
+                };
+                layout: {
+                    type: string;
+                    values: string[];
+                    optional: boolean;
+                };
+                localId: {
+                    type: string;
+                    minLength: number;
+                    optional: boolean;
+                };
+            };
+        };
+        marks: {
+            type: string;
+            items: never[];
+            optional: boolean;
+        };
+        content: {
+            type: string;
+            items: string[];
+            minItems: number;
+            allowUnsupportedBlock: boolean;
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/bodiedExtension_with_marks.d.ts

@@ -0,0 +1,10 @@
+declare const _default: (string | {
+    props: {
+        marks: {
+            type: string;
+            items: string[][];
+            optional: boolean;
+        };
+    };
+})[];
+export default _default;

package/dist/types-ts4.5/validator/specs/border.d.ts

@@ -0,0 +1,22 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                size: {
+                    type: string;
+                    minimum: number;
+                    maximum: number;
+                };
+                color: {
+                    type: string;
+                    pattern: string;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/breakout.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                mode: {
+                    type: string;
+                    values: string[];
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/bulletList.d.ts

@@ -0,0 +1,14 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        content: {
+            type: string;
+            items: string[];
+            minItems: number;
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/caption.d.ts

@@ -0,0 +1,14 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        content: {
+            type: string;
+            items: string[][];
+            minItems: number;
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/code.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/codeBlock.d.ts

@@ -0,0 +1,38 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        content: {
+            type: string;
+            items: (string | {
+                props: {
+                    marks: {
+                        type: string;
+                        items: never[];
+                        maxItems: number;
+                        optional: boolean;
+                    };
+                };
+            })[][];
+            allowUnsupportedInline: boolean;
+            optional: boolean;
+        };
+        marks: {
+            type: string;
+            items: never[];
+            optional: boolean;
+        };
+        attrs: {
+            props: {
+                language: {
+                    type: string;
+                    optional: boolean;
+                };
+            };
+            optional: boolean;
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/codeBlock_with_marks.d.ts

@@ -0,0 +1,10 @@
+declare const _default: (string | {
+    props: {
+        marks: {
+            type: string;
+            items: string[];
+            optional: boolean;
+        };
+    };
+})[];
+export default _default;

package/dist/types-ts4.5/validator/specs/codeBlock_with_no_marks.d.ts

@@ -0,0 +1,11 @@
+declare const _default: (string | {
+    props: {
+        marks: {
+            type: string;
+            items: never[];
+            maxItems: number;
+            optional: boolean;
+        };
+    };
+})[];
+export default _default;

package/dist/types-ts4.5/validator/specs/code_inline.d.ts

@@ -0,0 +1,10 @@
+declare const _default: (string | {
+    props: {
+        marks: {
+            type: string;
+            items: string[][];
+            optional: boolean;
+        };
+    };
+})[];
+export default _default;

package/dist/types-ts4.5/validator/specs/dataConsumer.d.ts

@@ -0,0 +1,20 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                sources: {
+                    type: string;
+                    items: {
+                        type: string;
+                    }[];
+                    minItems: number;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/date.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                timestamp: {
+                    type: string;
+                    minLength: number;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/decisionItem.d.ts

@@ -0,0 +1,25 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        content: {
+            type: string;
+            items: string[];
+            allowUnsupportedInline: boolean;
+            optional: boolean;
+        };
+        attrs: {
+            props: {
+                localId: {
+                    type: string;
+                };
+                state: {
+                    type: string;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/decisionList.d.ts

@@ -0,0 +1,22 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        content: {
+            type: string;
+            items: string[];
+            minItems: number;
+            allowUnsupportedBlock: boolean;
+        };
+        attrs: {
+            props: {
+                localId: {
+                    type: string;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types-ts4.5/validator/specs/doc.d.ts

@@ -0,0 +1,18 @@
+declare const _default: {
+    props: {
+        version: {
+            type: string;
+            values: number[];
+        };
+        type: {
+            type: string;
+            values: string[];
+        };
+        content: {
+            type: string;
+            items: string[][];
+            allowUnsupportedBlock: boolean;
+        };
+    };
+};
+export default _default;