diff --git a/etc/lime-elements.api.md b/etc/lime-elements.api.md index af6216c42b..1f845ad5e1 100644 --- a/etc/lime-elements.api.md +++ b/etc/lime-elements.api.md @@ -917,6 +917,31 @@ export interface EditorLink { text: string; } +// @beta +export const EditorMenuTypes: { + Bold: string; + Italic: string; + Blockquote: string; + HeaderLevel1: string; + HeaderLevel2: string; + HeaderLevel3: string; + Link: string; + OrderedList: string; + BulletList: string; + Strikethrough: string; + Code: string; + CodeBlock: string; +}; + +// @beta +export type EditorMenuTypes = (typeof EditorMenuTypes)[keyof typeof EditorMenuTypes]; + +// Warning: (ae-incompatible-release-tags) The symbol "editorMenuTypesArray" is marked as @public, but its signature references "EditorMenuTypes" which is marked as @beta +// Warning: (ae-missing-release-tag) "editorMenuTypesArray" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const editorMenuTypesArray: EditorMenuTypes[]; + // @alpha export interface EditorMetadata { images: EditorImage[]; @@ -958,6 +983,9 @@ export interface FileInfo { size?: number; } +// @public (undocumented) +export type FileType = 'pdf' | 'image' | 'video' | 'audio' | 'text' | 'office' | 'unknown'; + // @public (undocumented) export type FlexContainerAlign = 'start' | 'end' | 'center' | 'stretch'; @@ -1055,6 +1083,11 @@ export type FormSubKeySchema = Partial<{ [Key in Extract]: FormSchema; }>; +// Warning: (ae-missing-release-tag) "globalConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const globalConfig: Config; + // @public export interface GridLayoutOptions extends FormLayoutOptions { colSpan?: 1 | 2 | 3 | 4 | 5 | 'all'; @@ -2098,6 +2131,17 @@ export type Languages = 'da' | 'de' | 'en' | 'fi' | 'fr' | 'nb' | 'no' | 'nl' | // @public export type Layout = 'default' | 'stretchLastColumn' | 'stretchColumns' | 'lowDensity'; +// @beta +export const LevelMapping: { + Heading: string; + one: number; + two: number; + three: number; +}; + +// @beta +export type LevelMapping = (typeof LevelMapping)[keyof typeof LevelMapping]; + // Warning: (ae-missing-release-tag) "LimelActionBarCustomEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -2616,6 +2660,9 @@ export { ListSeparator as ListSeparator1 } // @public export type ListType = 'selectable' | 'radio' | 'checkbox'; +// @internal +export function _mapLayout(layout: Layout): any; + // @public interface MenuItem { badge?: number | string; @@ -2641,6 +2688,16 @@ export type MenuLoader = (item: MenuItem) => Promise Promise>; +// @beta +export const MouseButtons: { + Left: number; + Middle: number; + Right: number; +}; + +// @beta +export type MouseButtons = (typeof MouseButtons)[keyof typeof MouseButtons]; + // @public (undocumented) export type OfficeViewer = 'microsoft-office' | 'google-drive'; @@ -2665,9 +2722,19 @@ export type PickerValue = number | string | { [key: string]: any; }; +// Warning: (ae-missing-release-tag) "ProseMirrorAdapterElementWithFocus" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type ProseMirrorAdapterElementWithFocus = HTMLLimelProsemirrorAdapterElement & { + setFocus: () => void; +}; + // @public export type ReplaceObjectType = T extends any[] ? ElseType : T extends Record ? AllowedType : ElseType; +// @beta +export function resizeImage(file: File, options: ResizeOptions): Promise; + // @beta export type ResizeOptions = { width: number; @@ -2751,6 +2818,13 @@ export type TextEditorNode = { children?: Array; }; +// Warning: (ae-missing-release-tag) "TextEditorPlugin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export type TextEditorPlugin = { + node: CustomElementDefinition[]; +}; + // @alpha export type Trigger = { character: TriggerCharacter; @@ -2778,6 +2852,10 @@ export interface ValidationStatus { valid: boolean; } +// Warnings were encountered during analysis: +// +// dist/types/components/text-editor/types.d.ts:7:3 - (ae-incompatible-release-tags) The symbol "node" is marked as @public, but its signature references "CustomElementDefinition" which is marked as @alpha + // (No @packageDocumentation comment for this package) ``` diff --git a/kompendium-0.16.1.tgz b/kompendium-0.16.1.tgz new file mode 100644 index 0000000000..8022c63e94 Binary files /dev/null and b/kompendium-0.16.1.tgz differ diff --git a/package-lock.json b/package-lock.json index c1ea686467..9e8ca76e79 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35,7 +35,7 @@ "jest-cli": "^27.5.1", "jsonlint-mod": "^1.7.6", "jsx-dom": "^8.1.6", - "kompendium": "^0.15.0", + "kompendium": "file:kompendium-0.16.1.tgz", "lodash-es": "^4.17.21", "material-components-web": "^13.0.0", "moment": "^2.30.1", @@ -3356,6 +3356,13 @@ "node": ">=8" } }, + "node_modules/ansi-sequence-parser": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.3.tgz", + "integrity": "sha512-+fksAx9eG3Ab6LDnLs3ZqZa8KVJ/jYnX+D4Qe1azX+LFGFAXqynCQLOdLpNYN/l9e7l6hMWwZbrnctqr6eSQSw==", + "dev": true, + "license": "MIT" + }, "node_modules/ansi-styles": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", @@ -5771,20 +5778,6 @@ "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==", "dev": true }, - "node_modules/fs-extra": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", - "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", - "dev": true, - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" - }, - "engines": { - "node": ">=6 <7 || >=8" - } - }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -6057,27 +6050,6 @@ "optional": true, "peer": true }, - "node_modules/handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", - "dev": true, - "dependencies": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "wordwrap": "^1.0.0" - }, - "bin": { - "handlebars": "bin/handlebars" - }, - "engines": { - "node": ">=0.4.7" - }, - "optionalDependencies": { - "uglify-js": "^3.1.4" - } - }, "node_modules/has-bigints": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", @@ -6849,15 +6821,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/highlight.js": { - "version": "10.4.1", - "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.4.1.tgz", - "integrity": "sha512-yR5lWvNz7c85OhVAEAeFhVCc/GV4C30Fjzc/rCP0aCWzc1UUOPUk55dK/qdwTZHBvMZo+eZ2jpk62ndX/xMFlg==", - "dev": true, - "engines": { - "node": "*" - } - }, "node_modules/html-encoding-sniffer": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-2.0.1.tgz", @@ -8830,14 +8793,12 @@ "node": ">=6" } }, - "node_modules/jsonfile": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", - "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "node_modules/jsonc-parser": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", "dev": true, - "optionalDependencies": { - "graceful-fs": "^4.1.6" - } + "license": "MIT" }, "node_modules/jsonlint-mod": { "version": "1.7.6", @@ -8924,10 +8885,11 @@ } }, "node_modules/kompendium": { - "version": "0.15.0", - "resolved": "https://registry.npmjs.org/kompendium/-/kompendium-0.15.0.tgz", - "integrity": "sha512-cdznvHy3NYwqtehL3bCCl/cIUiqiRg5DdTKxhh1o5U9GvhITTE81fEMAgQ7dyZNhe37v1O441XpBY1TGEWlUtg==", + "version": "0.16.1", + "resolved": "file:kompendium-0.16.1.tgz", + "integrity": "sha512-UlAYXMuHKrFkXwbc7Pn3eqtrwNj3qTIerCX+y93Uw3m7n6vwgW1xfN+iUFb/mQQBLYAyY+RRG5kjlbToF9PnQw==", "dev": true, + "license": "MIT", "dependencies": { "chokidar": "^3.3.1", "fuse.js": "^6.4.6", @@ -8942,7 +8904,7 @@ "remark-parse": "^8.0.2", "remark-parse-yaml": "0.0.3", "remark-rehype": "^7.0.0", - "typedoc": "^0.17.8", + "typedoc": "^0.23.28", "typescript": "^4.7.4", "unified": "^9.0.0", "unist-util-flatmap": "^1.0.0", @@ -9387,7 +9349,8 @@ "version": "2.3.9", "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/make-dir": { "version": "3.1.0", @@ -9472,15 +9435,16 @@ } }, "node_modules/marked": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-1.0.0.tgz", - "integrity": "sha512-Wo+L1pWTVibfrSr+TTtMuiMfNzmZWiOPeO7rZsQUY5bgsxpHesBEcIWJloWVTFnrMXnf/TL30eTFSGJddmQAng==", + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", "dev": true, + "license": "MIT", "bin": { - "marked": "bin/marked" + "marked": "bin/marked.js" }, "engines": { - "node": ">= 8.16.2" + "node": ">= 12" } }, "node_modules/material-components-web": { @@ -10867,12 +10831,6 @@ "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", "dev": true }, - "node_modules/neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true - }, "node_modules/nice-try": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", @@ -13028,6 +12986,19 @@ "optional": true, "peer": true }, + "node_modules/shiki": { + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, "node_modules/shortid": { "version": "2.2.17", "resolved": "https://registry.npmjs.org/shortid/-/shortid-2.2.17.tgz", @@ -13976,60 +13947,51 @@ } }, "node_modules/typedoc": { - "version": "0.17.8", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.17.8.tgz", - "integrity": "sha512-/OyrHCJ8jtzu+QZ+771YaxQ9s4g5Z3XsQE3Ma7q+BL392xxBn4UMvvCdVnqKC2T/dz03/VXSLVKOP3lHmDdc/w==", + "version": "0.23.28", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.23.28.tgz", + "integrity": "sha512-9x1+hZWTHEQcGoP7qFmlo4unUoVJLB0H/8vfO/7wqTnZxg4kPuji9y3uRzEu0ZKez63OJAUmiGhUrtukC6Uj3w==", "dev": true, + "license": "Apache-2.0", "dependencies": { - "fs-extra": "^8.1.0", - "handlebars": "^4.7.6", - "highlight.js": "^10.0.0", - "lodash": "^4.17.15", - "lunr": "^2.3.8", - "marked": "1.0.0", - "minimatch": "^3.0.0", - "progress": "^2.0.3", - "shelljs": "^0.8.4", - "typedoc-default-themes": "^0.10.2" + "lunr": "^2.3.9", + "marked": "^4.2.12", + "minimatch": "^7.1.3", + "shiki": "^0.14.1" }, "bin": { "typedoc": "bin/typedoc" }, "engines": { - "node": ">= 8.0.0" + "node": ">= 14.14" }, "peerDependencies": { - "typescript": ">=3.8.3" + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x" } }, - "node_modules/typedoc-default-themes": { - "version": "0.10.2", - "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.10.2.tgz", - "integrity": "sha512-zo09yRj+xwLFE3hyhJeVHWRSPuKEIAsFK5r2u47KL/HBKqpwdUSanoaz5L34IKiSATFrjG5ywmIu98hPVMfxZg==", + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", "dev": true, + "license": "MIT", "dependencies": { - "lunr": "^2.3.8" - }, - "engines": { - "node": ">= 8" + "balanced-match": "^1.0.0" } }, - "node_modules/typedoc/node_modules/shelljs": { - "version": "0.8.5", - "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.5.tgz", - "integrity": "sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow==", + "node_modules/typedoc/node_modules/minimatch": { + "version": "7.4.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-7.4.6.tgz", + "integrity": "sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw==", "dev": true, - "license": "BSD-3-Clause", + "license": "ISC", "dependencies": { - "glob": "^7.0.0", - "interpret": "^1.0.0", - "rechoir": "^0.6.2" - }, - "bin": { - "shjs": "bin/shjs" + "brace-expansion": "^2.0.1" }, "engines": { - "node": ">=4" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/typescript": { @@ -14075,19 +14037,6 @@ "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", "dev": true }, - "node_modules/uglify-js": { - "version": "3.11.0", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.11.0.tgz", - "integrity": "sha512-e1KQFRCpOxnrJsJVqDUCjURq+wXvIn7cK2sRAx9XL3HYLL9aezOP4Pb1+Y3/o693EPk111Yj2Q+IUXxcpHlygQ==", - "dev": true, - "optional": true, - "bin": { - "uglifyjs": "bin/uglifyjs" - }, - "engines": { - "node": ">=0.8.0" - } - }, "node_modules/unbox-primitive": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.1.0.tgz", @@ -14405,15 +14354,6 @@ "integrity": "sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ==", "dev": true }, - "node_modules/universalify": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", - "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", - "dev": true, - "engines": { - "node": ">= 4.0.0" - } - }, "node_modules/update-browserslist-db": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.3.tgz", @@ -14582,6 +14522,20 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true, + "license": "MIT" + }, + "node_modules/vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true, + "license": "MIT" + }, "node_modules/w3c-hr-time": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", @@ -14774,12 +14728,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", - "dev": true - }, "node_modules/wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", @@ -17607,6 +17555,12 @@ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", "dev": true }, + "ansi-sequence-parser": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.3.tgz", + "integrity": "sha512-+fksAx9eG3Ab6LDnLs3ZqZa8KVJ/jYnX+D4Qe1azX+LFGFAXqynCQLOdLpNYN/l9e7l6hMWwZbrnctqr6eSQSw==", + "dev": true + }, "ansi-styles": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", @@ -19298,17 +19252,6 @@ "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==", "dev": true }, - "fs-extra": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", - "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", - "dev": true, - "requires": { - "graceful-fs": "^4.2.0", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" - } - }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -19491,19 +19434,6 @@ "optional": true, "peer": true }, - "handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", - "dev": true, - "requires": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "uglify-js": "^3.1.4", - "wordwrap": "^1.0.0" - } - }, "has-bigints": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", @@ -20036,12 +19966,6 @@ "integrity": "sha512-Ox1pJVrDCyGHMG9CFg1tmrRUMRPRsAWYc/PinY0XzJU4K7y7vjNoLKIQ7BR5UJMCxNN8EM1MNDmHWA/B3aZUuw==", "dev": true }, - "highlight.js": { - "version": "10.4.1", - "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.4.1.tgz", - "integrity": "sha512-yR5lWvNz7c85OhVAEAeFhVCc/GV4C30Fjzc/rCP0aCWzc1UUOPUk55dK/qdwTZHBvMZo+eZ2jpk62ndX/xMFlg==", - "dev": true - }, "html-encoding-sniffer": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-2.0.1.tgz", @@ -21451,14 +21375,11 @@ "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", "dev": true }, - "jsonfile": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", - "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", - "dev": true, - "requires": { - "graceful-fs": "^4.1.6" - } + "jsonc-parser": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", + "dev": true }, "jsonlint-mod": { "version": "1.7.6", @@ -21528,9 +21449,8 @@ "dev": true }, "kompendium": { - "version": "0.15.0", - "resolved": "https://registry.npmjs.org/kompendium/-/kompendium-0.15.0.tgz", - "integrity": "sha512-cdznvHy3NYwqtehL3bCCl/cIUiqiRg5DdTKxhh1o5U9GvhITTE81fEMAgQ7dyZNhe37v1O441XpBY1TGEWlUtg==", + "version": "file:kompendium-0.16.1.tgz", + "integrity": "sha512-UlAYXMuHKrFkXwbc7Pn3eqtrwNj3qTIerCX+y93Uw3m7n6vwgW1xfN+iUFb/mQQBLYAyY+RRG5kjlbToF9PnQw==", "dev": true, "requires": { "chokidar": "^3.3.1", @@ -21546,7 +21466,7 @@ "remark-parse": "^8.0.2", "remark-parse-yaml": "0.0.3", "remark-rehype": "^7.0.0", - "typedoc": "^0.17.8", + "typedoc": "^0.23.28", "typescript": "^4.7.4", "unified": "^9.0.0", "unist-util-flatmap": "^1.0.0", @@ -21963,9 +21883,9 @@ "dev": true }, "marked": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-1.0.0.tgz", - "integrity": "sha512-Wo+L1pWTVibfrSr+TTtMuiMfNzmZWiOPeO7rZsQUY5bgsxpHesBEcIWJloWVTFnrMXnf/TL30eTFSGJddmQAng==", + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", "dev": true }, "material-components-web": { @@ -22963,12 +22883,6 @@ "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", "dev": true }, - "neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true - }, "nice-try": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", @@ -24614,6 +24528,18 @@ "optional": true, "peer": true }, + "shiki": { + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", + "dev": true, + "requires": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, "shortid": { "version": "2.2.17", "resolved": "https://registry.npmjs.org/shortid/-/shortid-2.2.17.tgz", @@ -25303,45 +25229,37 @@ } }, "typedoc": { - "version": "0.17.8", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.17.8.tgz", - "integrity": "sha512-/OyrHCJ8jtzu+QZ+771YaxQ9s4g5Z3XsQE3Ma7q+BL392xxBn4UMvvCdVnqKC2T/dz03/VXSLVKOP3lHmDdc/w==", + "version": "0.23.28", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.23.28.tgz", + "integrity": "sha512-9x1+hZWTHEQcGoP7qFmlo4unUoVJLB0H/8vfO/7wqTnZxg4kPuji9y3uRzEu0ZKez63OJAUmiGhUrtukC6Uj3w==", "dev": true, "requires": { - "fs-extra": "^8.1.0", - "handlebars": "^4.7.6", - "highlight.js": "^10.0.0", - "lodash": "^4.17.15", - "lunr": "^2.3.8", - "marked": "1.0.0", - "minimatch": "^3.0.0", - "progress": "^2.0.3", - "shelljs": "^0.8.4", - "typedoc-default-themes": "^0.10.2" + "lunr": "^2.3.9", + "marked": "^4.2.12", + "minimatch": "^7.1.3", + "shiki": "^0.14.1" }, "dependencies": { - "shelljs": { - "version": "0.8.5", - "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.5.tgz", - "integrity": "sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow==", + "brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", "dev": true, "requires": { - "glob": "^7.0.0", - "interpret": "^1.0.0", - "rechoir": "^0.6.2" + "balanced-match": "^1.0.0" + } + }, + "minimatch": { + "version": "7.4.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-7.4.6.tgz", + "integrity": "sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" } } } }, - "typedoc-default-themes": { - "version": "0.10.2", - "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.10.2.tgz", - "integrity": "sha512-zo09yRj+xwLFE3hyhJeVHWRSPuKEIAsFK5r2u47KL/HBKqpwdUSanoaz5L34IKiSATFrjG5ywmIu98hPVMfxZg==", - "dev": true, - "requires": { - "lunr": "^2.3.8" - } - }, "typescript": { "version": "4.9.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", @@ -25366,13 +25284,6 @@ "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", "dev": true }, - "uglify-js": { - "version": "3.11.0", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.11.0.tgz", - "integrity": "sha512-e1KQFRCpOxnrJsJVqDUCjURq+wXvIn7cK2sRAx9XL3HYLL9aezOP4Pb1+Y3/o693EPk111Yj2Q+IUXxcpHlygQ==", - "dev": true, - "optional": true - }, "unbox-primitive": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.1.0.tgz", @@ -25611,12 +25522,6 @@ } } }, - "universalify": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", - "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", - "dev": true - }, "update-browserslist-db": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.3.tgz", @@ -25745,6 +25650,18 @@ "unist-util-stringify-position": "^2.0.0" } }, + "vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true + }, + "vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true + }, "w3c-hr-time": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", @@ -25892,12 +25809,6 @@ "has-tostringtag": "^1.0.2" } }, - "wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", - "dev": true - }, "wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", diff --git a/package.json b/package.json index 933a5b8311..181bf91ea1 100644 --- a/package.json +++ b/package.json @@ -63,7 +63,7 @@ "jest-cli": "^27.5.1", "jsonlint-mod": "^1.7.6", "jsx-dom": "^8.1.6", - "kompendium": "^0.15.0", + "kompendium": "file:kompendium-0.16.1.tgz", "lodash-es": "^4.17.21", "material-components-web": "^13.0.0", "moment": "^2.30.1", diff --git a/publish-docs.cjs b/publish-docs.cjs index c04bdf7a84..abc0044145 100644 --- a/publish-docs.cjs +++ b/publish-docs.cjs @@ -182,7 +182,16 @@ function build() { shell.exit(1); } - if (shell.exec('npm run docs:build').code !== 0) { + // Run production build first to create dist/types/index.d.ts + if (shell.exec('npm run build').code !== 0) { + shell.echo('build failed!'); + teardown(); + shell.exit(1); + } + + // Run docs build twice to ensure no type errors. + // (Known bug in Stencil, see https://github.com/stenciljs/core/issues/3534) + if (shell.exec('npm run docs:build && npm run docs:build').code !== 0) { shell.echo('docs:build failed!'); teardown(); shell.exit(1); @@ -226,9 +235,13 @@ function copyBuildOutput() { shell.exit(1); } + // Copy kompendium.json from .kompendium directory (stable location) if ( - shell.cp('-R', 'www/kompendium.json', `docsDist/versions/${version}`) - .code !== 0 + shell.cp( + '-R', + '.kompendium/kompendium.json', + `docsDist/versions/${version}` + ).code !== 0 ) { shell.echo('copying kompendium.json failed!'); teardown(); diff --git a/src/components/table/layout.ts b/src/components/table/layout.ts index 6d8b32bf7a..33b34e3ef3 100644 --- a/src/components/table/layout.ts +++ b/src/components/table/layout.ts @@ -18,7 +18,7 @@ export type Layout = * @returns the Tabulator layout * @internal */ -export function mapLayout(layout: Layout) { +export function _mapLayout(layout: Layout) { const layouts = { stretchLastColumn: 'fitDataStretch', stretchColumns: 'fitColumns', diff --git a/src/components/table/table.tsx b/src/components/table/table.tsx index 0e6637ca51..849396ce29 100644 --- a/src/components/table/table.tsx +++ b/src/components/table/table.tsx @@ -20,7 +20,7 @@ import { ColumnDefinitionFactory, createColumnSorter } from './columns'; import { isEqual, has } from 'lodash-es'; import { ElementPool } from './element-pool'; import { TableSelection } from './table-selection'; -import { mapLayout, Layout } from './layout'; +import { _mapLayout, Layout } from './layout'; import { areRowsEqual } from './utils'; import { Languages } from '../date-picker/date.types'; import translate from '../../global/translations'; @@ -530,7 +530,7 @@ export class Table { return { data: this.data, - layout: mapLayout(this.layout), + layout: _mapLayout(this.layout), columns: this.getColumnDefinitions(), dataSorting: this.handleDataSorting, pageLoaded: this.handlePageLoaded, diff --git a/src/components/text-editor/prosemirror-adapter/menu/types.ts b/src/components/text-editor/prosemirror-adapter/menu/types.ts index 8de1093fd8..e1233822e7 100644 --- a/src/components/text-editor/prosemirror-adapter/menu/types.ts +++ b/src/components/text-editor/prosemirror-adapter/menu/types.ts @@ -4,7 +4,6 @@ * The values correspond to the types that can be used with the `prosemirror-commands` library. * @beta */ - export const EditorMenuTypes = { Bold: 'strong', Italic: 'em', @@ -20,6 +19,12 @@ export const EditorMenuTypes = { CodeBlock: 'code_block', }; +/** + * The `EditorMenuType` type is used to specify the type of menu items that can be added to the editor toolbar. + * Each one represents a different type to be used for creating the prosemirror commands relevant to the button. + * The values correspond to the types that can be used with the `prosemirror-commands` library. + * @beta + */ export type EditorMenuTypes = (typeof EditorMenuTypes)[keyof typeof EditorMenuTypes]; @@ -42,6 +47,14 @@ export const LevelMapping = { three: 3, }; +/** + * `LevelMapping` is used to map string identifiers to numerical header levels. + * It provides a way to represent different levels of headings in ProseMirror commands. + * + * The `Heading` identifier is not a valid level and is used to identify the node type. + * The numerical values are used for creating ProseMirror commands to set the level of a heading node in the editor. + * @beta + */ export type LevelMapping = (typeof LevelMapping)[keyof typeof LevelMapping]; export type ProseMirrorAdapterElementWithFocus = @@ -70,4 +83,9 @@ export const MouseButtons = { Right: 2, }; +/** + * The `MouseButtons` type is used to represent the different mouse buttons. + * The values correspond to the button codes used in the `MouseEvent` interface. + * @beta + */ export type MouseButtons = (typeof MouseButtons)[keyof typeof MouseButtons]; diff --git a/src/global/config.ts b/src/global/config.ts index 9931d01c18..1731a97a3b 100644 --- a/src/global/config.ts +++ b/src/global/config.ts @@ -54,6 +54,6 @@ function getFeatureSwitches(storage: Storage) { } const config = new ConfigClass(); -export const globalConfig = (() => { +export const globalConfig: Config = (() => { return config; })(); diff --git a/src/interface.ts b/src/interface.ts index 0b3365eb42..b992eaf147 100644 --- a/src/interface.ts +++ b/src/interface.ts @@ -6,12 +6,17 @@ export * from './components/chip-set/chip.types'; export * from './components/circular-progress/circular-progress.types'; export * from './components/code-editor/code-editor.types'; export * from './components/collapsible-section/action'; +export * from './components/chart/chart.types'; export * from './components/date-picker/date.types'; export * from './components/dialog/dialog.types'; export * from './components/dock/dock.types'; +export * from './components/color-picker/color-picker.types'; +export * from './components/file-viewer/file-viewer.types'; export * from './global/shared-types/file.types'; export * from './components/flex-container/flex-container.types'; export * from './global/shared-types/custom-element.types'; +export * from './global/config'; +export * from './global/shared-types/link.types'; export { EventEmitter, ValidationStatus, @@ -34,22 +39,24 @@ export * from './components/help/help.types'; export * from './components/icon/icon.types'; export * from './components/info-tile/info-tile.types'; export * from './components/input-field/input-field.types'; -export { - ListComponent, - ListSeparator, -} from './components/list-item/list-item.types'; +export { ListComponent } from './components/list-item/list-item.types'; export * from './components/dynamic-label/label.types'; export * from './components/list/list.types'; export * from './components/menu/menu.types'; export * from './components/picker/actions.types'; export * from './components/picker/searcher.types'; +export * from './components/picker/value.types'; export * from './components/progress-flow/progress-flow.types'; export * from './components/select/option.types'; export * from './components/spinner/spinner.types'; export * from './components/tab-panel/tab-panel.types'; export * from './components/table/table.types'; +export * from './components/table/layout'; export * from './global/shared-types/separator.types'; export * from './global/shared-types/icon.types'; export * from './global/shared-types/image.types'; export * from './global/shared-types/color.types'; export * from './components/text-editor/text-editor.types'; +export * from './components/text-editor/types'; +export * from './components/text-editor/prosemirror-adapter/menu/types'; +export * from './util/image-resize'; diff --git a/stencil.config.docs.ts b/stencil.config.docs.ts index 5d0b727cc3..bb33cebff4 100644 --- a/stencil.config.docs.ts +++ b/stencil.config.docs.ts @@ -12,7 +12,7 @@ export const config: Config = { type: 'docs-custom', strict: true, generator: kompendium({ - typeRoot: './src/interface.ts', + typeRoot: './src/index.ts', guides: guides, }), }, diff --git a/stencil.config.ts b/stencil.config.ts index 924fb02f90..e4a5fb12e8 100644 --- a/stencil.config.ts +++ b/stencil.config.ts @@ -21,7 +21,7 @@ export const config: Config = { type: 'docs-custom', strict: true, generator: kompendium({ - typeRoot: './src/interface.ts', + typeRoot: './src/index.ts', guides: guides, }), }, diff --git a/tsconfig.dev.json b/tsconfig.dev.json index 56fe8d7df6..3361b6a065 100644 --- a/tsconfig.dev.json +++ b/tsconfig.dev.json @@ -6,6 +6,7 @@ "noUnusedParameters": false, "lib": ["dom", "es2022", "DOM.Iterable"] }, + "include": ["src", "types/jsx.d.ts", "dist/types"], "exclude": [ "node_modules", "**/test/**", diff --git a/tsconfig.docs.json b/tsconfig.docs.json index 2c772bc679..fd051ac54a 100644 --- a/tsconfig.docs.json +++ b/tsconfig.docs.json @@ -3,8 +3,10 @@ "compilerOptions": { "declaration": false, "declarationMap": false, - "sourceMap": false + "sourceMap": false, + "lib": ["dom", "es2022", "DOM.Iterable"] }, + "include": ["src", "types/jsx.d.ts", "dist/types"], "exclude": [ "node_modules", "**/test/**",