@atlaskit/editor-wikimarkup-transformer 11.16.0 → 11.16.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-wikimarkup-transformer
 
+## 11.16.1
+
+### Patch Changes
+
+- [`0fdcb6f2f96fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fdcb6f2f96fd) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 11.16.0
 
 ### Minor Changes

package/dist/cjs/parser/tokenize/links/link-resolver.js

@@ -18,7 +18,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
  *
  * @param context    The render context
  * @param parsedLink The parsed link information
- * @return the corresponding link. If no link can be created, null is returned
+ * @returns the corresponding link. If no link can be created, null is returned
  */
 
 // jira-components/jira-core/src/main/resources/system-contentlinkresolvers-plugin.xml

package/dist/es2019/parser/tokenize/links/link-resolver.js

@@ -10,7 +10,7 @@ import { issueLinkResolver } from './issue-link';
  *
  * @param context    The render context
  * @param parsedLink The parsed link information
- * @return the corresponding link. If no link can be created, null is returned
+ * @returns the corresponding link. If no link can be created, null is returned
  */
 
 // jira-components/jira-core/src/main/resources/system-contentlinkresolvers-plugin.xml

package/dist/esm/parser/tokenize/links/link-resolver.js

@@ -13,7 +13,7 @@ import { issueLinkResolver } from './issue-link';
  *
  * @param context    The render context
  * @param parsedLink The parsed link information
- * @return the corresponding link. If no link can be created, null is returned
+ * @returns the corresponding link. If no link can be created, null is returned
  */
 
 // jira-components/jira-core/src/main/resources/system-contentlinkresolvers-plugin.xml

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

@@ -3,7 +3,7 @@ import { type Context } from '../interfaces';
 export type MarkEncoder = (text: string, attrs: any) => string;
 export type NodeEncoder = (node: PMNode, opts?: NodeEncoderOpts) => string;
 export type NodeEncoderOpts = {
-    parent?: PMNode;
     context?: Context;
+    parent?: PMNode;
 };
 export declare function encode(node: PMNode, context?: Context): string;

package/dist/types/interfaces.d.ts

@@ -1,10 +1,9 @@
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 export interface AddArgs {
-    style: string | null;
     content: PMNode[];
+    style: string | null;
 }
 export interface Builder {
-    type: string;
     /**
      * Add a item to the builder
      * @param {AddCellArgs[]} items
@@ -15,22 +14,23 @@ export interface Builder {
      * @returns {PMNode}
      */
     buildPMNode: () => PMNode;
+    type: string;
 }
 export interface ListItem {
+    children: List[];
     content?: any[];
     parent: List;
-    children: List[];
 }
 export interface List {
     children: ListItem[];
-    type: ListType;
     parent?: ListItem;
+    type: ListType;
 }
 export type ListType = 'bulletList' | 'orderedList';
 export type CellType = 'tableHeader' | 'tableCell';
 export interface TableCell {
-    type: CellType;
     content: PMNode[];
+    type: CellType;
 }
 export interface TableRow {
     cells: TableCell[];
@@ -39,36 +39,36 @@ export interface Table {
     rows: TableRow[];
 }
 export interface AddCellArgs extends AddArgs {
-    style: string;
     content: PMNode[];
+    style: string;
 }
 export interface ConversionMap {
     [key: string]: string;
 }
 export interface MediaConversionMap {
     [key: string]: {
-        transform?: string;
         embed?: boolean;
+        transform?: string;
     };
 }
 export type TokenErrCallback = (err: Error, tokenType: string) => void;
 export interface Context {
-    readonly issueKeyRegex?: RegExp | undefined;
-    readonly tokenErrCallback?: TokenErrCallback;
     readonly conversion?: {
         readonly inlineCardConversion?: ConversionMap;
         readonly mediaConversion?: MediaConversionMap;
         mentionConversion?: ConversionMap;
     };
-    readonly hydration?: {
+    readonly defaults?: {
         readonly media?: {
-            targetCollectionId?: string;
+            height: number | null;
+            width: number | null;
         };
     };
-    readonly defaults?: {
+    readonly hydration?: {
         readonly media?: {
-            width: number | null;
-            height: number | null;
+            targetCollectionId?: string;
         };
     };
+    readonly issueKeyRegex?: RegExp | undefined;
+    readonly tokenErrCallback?: TokenErrCallback;
 }

package/dist/types/parser/text.d.ts

@@ -2,9 +2,9 @@ import { type Node as PMNode, type Schema } from '@atlaskit/editor-prosemirror/m
 import { TokenType } from './tokenize';
 import { type Context } from '../interfaces';
 export declare function parseString({ input, schema, ignoreTokenTypes, context, includeLeadingSpace, }: {
-    input: string;
-    schema: Schema;
-    ignoreTokenTypes: TokenType[];
     context: Context;
+    ignoreTokenTypes: TokenType[];
     includeLeadingSpace?: boolean;
+    input: string;
+    schema: Schema;
 }): PMNode[];

package/dist/types/parser/tokenize/common-formatter.d.ts

@@ -2,9 +2,9 @@ import type { Schema } from '@atlaskit/editor-prosemirror/model';
 import type { Token } from './';
 import type { Context } from '../../interfaces';
 export interface FormatterOption {
+    closing: string;
     context: Context;
     opening: string;
-    closing: string;
     rawContentProcessor: (raw: string, length: number) => Token;
 }
 export declare function commonFormatter(input: string, position: number, schema: Schema, opt: FormatterOption): Token;

package/dist/types/parser/tokenize/common-macro.d.ts

@@ -2,9 +2,9 @@ import { type Schema } from '@atlaskit/editor-prosemirror/model';
 import { type Token } from './';
 import { type Context } from '../../interfaces';
 export interface MacroOption {
+    context: Context;
     keyword: string;
     paired: boolean;
-    context: Context;
     rawContentProcessor: (rawAttrs: string, rawContent: string, length: number, schema: Schema, context: Context) => Token;
 }
 export declare function commonMacro(input: string, schema: Schema, opt: MacroOption): Token;

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

@@ -35,21 +35,21 @@ export declare enum TokenType {
     FORCE_LINE_BREAK = "FORCE_LINE_BREAK"
 }
 export interface TextToken {
-    readonly type: 'text';
-    readonly text: string;
     readonly length: number;
+    readonly text: string;
+    readonly type: 'text';
 }
 export interface PMNodeToken {
-    readonly type: 'pmnode';
-    readonly nodes: PMNode[];
     readonly length: number;
+    readonly nodes: PMNode[];
+    readonly type: 'pmnode';
 }
 export type TokenErrCallback = (err: Error, tokenType: string) => void;
 export type Token = TextToken | PMNodeToken;
 export type TokenParser = ({ input, position, schema, context, }: {
+    context: Context;
     input: string;
     position: number;
     schema: Schema;
-    context: Context;
 }) => Token;
 export declare function parseToken(input: string, type: TokenType, position: number, schema: Schema, context: Context): Token;

package/dist/types/parser/tokenize/keyword.d.ts

@@ -1,7 +1,7 @@
 import { TokenType } from './';
 interface KeywordToken {
-    type: TokenType;
     regex: RegExp;
+    type: TokenType;
 }
 export declare const macroKeywordTokenMap: KeywordToken[];
 export declare function parseMacroKeyword(input: string): {

package/dist/types/parser/tokenize/links/link-parser.d.ts

@@ -1,17 +1,17 @@
 export interface Link {
-    readonly originalLinkText: string;
     readonly linkBody: string | null;
-    readonly notLinkBody: string;
     readonly linkTitle: string | null;
+    readonly notLinkBody: string;
+    readonly originalLinkText: string;
 }
 export declare function parseLink(linkText: string): Link;
 export interface ContentLink extends Link {
-    readonly spaceKey: string | null;
-    readonly destinationTitle: string;
     readonly anchor: string | null;
-    readonly shortcutName: string | null;
-    readonly shortcutValue: string | null;
     readonly attachmentName: string | null;
     readonly contentId: number;
+    readonly destinationTitle: string;
+    readonly shortcutName: string | null;
+    readonly shortcutValue: string | null;
+    readonly spaceKey: string | null;
 }
 export declare function parseContentLink(link: Link | string): ContentLink;

package/dist/types/parser/utils/color-name-mapping.d.ts

@@ -2,9 +2,9 @@ export interface RGBColors {
     [key: string]: RGB;
 }
 export interface RGB {
-    r: number;
-    g: number;
     b: number;
+    g: number;
+    r: number;
 }
 declare const mapping: RGBColors;
 export default mapping;

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

@@ -3,7 +3,7 @@ import { type Context } from '../interfaces';
 export type MarkEncoder = (text: string, attrs: any) => string;
 export type NodeEncoder = (node: PMNode, opts?: NodeEncoderOpts) => string;
 export type NodeEncoderOpts = {
-    parent?: PMNode;
     context?: Context;
+    parent?: PMNode;
 };
 export declare function encode(node: PMNode, context?: Context): string;

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

@@ -1,10 +1,9 @@
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 export interface AddArgs {
-    style: string | null;
     content: PMNode[];
+    style: string | null;
 }
 export interface Builder {
-    type: string;
     /**
      * Add a item to the builder
      * @param {AddCellArgs[]} items
@@ -15,22 +14,23 @@ export interface Builder {
      * @returns {PMNode}
      */
     buildPMNode: () => PMNode;
+    type: string;
 }
 export interface ListItem {
+    children: List[];
     content?: any[];
     parent: List;
-    children: List[];
 }
 export interface List {
     children: ListItem[];
-    type: ListType;
     parent?: ListItem;
+    type: ListType;
 }
 export type ListType = 'bulletList' | 'orderedList';
 export type CellType = 'tableHeader' | 'tableCell';
 export interface TableCell {
-    type: CellType;
     content: PMNode[];
+    type: CellType;
 }
 export interface TableRow {
     cells: TableCell[];
@@ -39,36 +39,36 @@ export interface Table {
     rows: TableRow[];
 }
 export interface AddCellArgs extends AddArgs {
-    style: string;
     content: PMNode[];
+    style: string;
 }
 export interface ConversionMap {
     [key: string]: string;
 }
 export interface MediaConversionMap {
     [key: string]: {
-        transform?: string;
         embed?: boolean;
+        transform?: string;
     };
 }
 export type TokenErrCallback = (err: Error, tokenType: string) => void;
 export interface Context {
-    readonly issueKeyRegex?: RegExp | undefined;
-    readonly tokenErrCallback?: TokenErrCallback;
     readonly conversion?: {
         readonly inlineCardConversion?: ConversionMap;
         readonly mediaConversion?: MediaConversionMap;
         mentionConversion?: ConversionMap;
     };
-    readonly hydration?: {
+    readonly defaults?: {
         readonly media?: {
-            targetCollectionId?: string;
+            height: number | null;
+            width: number | null;
         };
     };
-    readonly defaults?: {
+    readonly hydration?: {
         readonly media?: {
-            width: number | null;
-            height: number | null;
+            targetCollectionId?: string;
         };
     };
+    readonly issueKeyRegex?: RegExp | undefined;
+    readonly tokenErrCallback?: TokenErrCallback;
 }

package/dist/types-ts4.5/parser/text.d.ts

@@ -2,9 +2,9 @@ import { type Node as PMNode, type Schema } from '@atlaskit/editor-prosemirror/m
 import { TokenType } from './tokenize';
 import { type Context } from '../interfaces';
 export declare function parseString({ input, schema, ignoreTokenTypes, context, includeLeadingSpace, }: {
-    input: string;
-    schema: Schema;
-    ignoreTokenTypes: TokenType[];
     context: Context;
+    ignoreTokenTypes: TokenType[];
     includeLeadingSpace?: boolean;
+    input: string;
+    schema: Schema;
 }): PMNode[];

package/dist/types-ts4.5/parser/tokenize/common-formatter.d.ts

@@ -2,9 +2,9 @@ import type { Schema } from '@atlaskit/editor-prosemirror/model';
 import type { Token } from './';
 import type { Context } from '../../interfaces';
 export interface FormatterOption {
+    closing: string;
     context: Context;
     opening: string;
-    closing: string;
     rawContentProcessor: (raw: string, length: number) => Token;
 }
 export declare function commonFormatter(input: string, position: number, schema: Schema, opt: FormatterOption): Token;

package/dist/types-ts4.5/parser/tokenize/common-macro.d.ts

@@ -2,9 +2,9 @@ import { type Schema } from '@atlaskit/editor-prosemirror/model';
 import { type Token } from './';
 import { type Context } from '../../interfaces';
 export interface MacroOption {
+    context: Context;
     keyword: string;
     paired: boolean;
-    context: Context;
     rawContentProcessor: (rawAttrs: string, rawContent: string, length: number, schema: Schema, context: Context) => Token;
 }
 export declare function commonMacro(input: string, schema: Schema, opt: MacroOption): Token;

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

@@ -35,21 +35,21 @@ export declare enum TokenType {
     FORCE_LINE_BREAK = "FORCE_LINE_BREAK"
 }
 export interface TextToken {
-    readonly type: 'text';
-    readonly text: string;
     readonly length: number;
+    readonly text: string;
+    readonly type: 'text';
 }
 export interface PMNodeToken {
-    readonly type: 'pmnode';
-    readonly nodes: PMNode[];
     readonly length: number;
+    readonly nodes: PMNode[];
+    readonly type: 'pmnode';
 }
 export type TokenErrCallback = (err: Error, tokenType: string) => void;
 export type Token = TextToken | PMNodeToken;
 export type TokenParser = ({ input, position, schema, context, }: {
+    context: Context;
     input: string;
     position: number;
     schema: Schema;
-    context: Context;
 }) => Token;
 export declare function parseToken(input: string, type: TokenType, position: number, schema: Schema, context: Context): Token;

package/dist/types-ts4.5/parser/tokenize/keyword.d.ts

@@ -1,7 +1,7 @@
 import { TokenType } from './';
 interface KeywordToken {
-    type: TokenType;
     regex: RegExp;
+    type: TokenType;
 }
 export declare const macroKeywordTokenMap: KeywordToken[];
 export declare function parseMacroKeyword(input: string): {

package/dist/types-ts4.5/parser/tokenize/links/link-parser.d.ts

@@ -1,17 +1,17 @@
 export interface Link {
-    readonly originalLinkText: string;
     readonly linkBody: string | null;
-    readonly notLinkBody: string;
     readonly linkTitle: string | null;
+    readonly notLinkBody: string;
+    readonly originalLinkText: string;
 }
 export declare function parseLink(linkText: string): Link;
 export interface ContentLink extends Link {
-    readonly spaceKey: string | null;
-    readonly destinationTitle: string;
     readonly anchor: string | null;
-    readonly shortcutName: string | null;
-    readonly shortcutValue: string | null;
     readonly attachmentName: string | null;
     readonly contentId: number;
+    readonly destinationTitle: string;
+    readonly shortcutName: string | null;
+    readonly shortcutValue: string | null;
+    readonly spaceKey: string | null;
 }
 export declare function parseContentLink(link: Link | string): ContentLink;

package/dist/types-ts4.5/parser/utils/color-name-mapping.d.ts

@@ -2,9 +2,9 @@ export interface RGBColors {
     [key: string]: RGB;
 }
 export interface RGB {
-    r: number;
-    g: number;
     b: number;
+    g: number;
+    r: number;
 }
 declare const mapping: RGBColors;
 export default mapping;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-wikimarkup-transformer",
-	"version": "11.16.0",
+	"version": "11.16.1",
 	"description": "Wiki markup transformer for JIRA and Confluence",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"