From ce85eaac34809a5d59640baa47d8c5254b8ba983 Mon Sep 17 00:00:00 2001 From: Steve Ruiz Date: Tue, 23 Jan 2024 15:27:25 +0000 Subject: [PATCH] Export TLCommandHistoryOptions type (#2598) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Export TLCommandHistoryOptions type. ### Change Type - [x] `patch` — Bug fix ### Release Notes - Added TLCommandHistoryOptions to the exported types. --- packages/editor/api-report.md | 7 +++++ packages/editor/api/api.json | 57 +++++++++++++++++++++++++++-------- packages/editor/src/index.ts | 1 + 3 files changed, 52 insertions(+), 13 deletions(-) diff --git a/packages/editor/api-report.md b/packages/editor/api-report.md index 954967354..c6ad5fcf2 100644 --- a/packages/editor/api-report.md +++ b/packages/editor/api-report.md @@ -2032,6 +2032,13 @@ export type TLCommandHandler = { squash?: (prevData: Data, nextData: Data) => Data; }; +// @public (undocumented) +export type TLCommandHistoryOptions = Partial<{ + squashing: boolean; + ephemeral: boolean; + preservesRedoStack: boolean; +}>; + // @public (undocumented) export type TLCompleteEvent = (info: TLCompleteEventInfo) => void; diff --git a/packages/editor/api/api.json b/packages/editor/api/api.json index 12f7f36d7..26c0cedc0 100644 --- a/packages/editor/api/api.json +++ b/packages/editor/api/api.json @@ -14508,7 +14508,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -15286,7 +15286,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -16217,7 +16217,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -16704,7 +16704,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -16769,7 +16769,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -16848,7 +16848,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -16926,7 +16926,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -17025,7 +17025,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -17949,7 +17949,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -18099,7 +18099,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -18178,7 +18178,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -18261,7 +18261,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -18357,7 +18357,7 @@ { "kind": "Reference", "text": "TLCommandHistoryOptions", - "canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type" }, { "kind": "Content", @@ -35953,6 +35953,37 @@ "endIndex": 2 } }, + { + "kind": "TypeAlias", + "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type TLCommandHistoryOptions = " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<{\n squashing: boolean;\n ephemeral: boolean;\n preservesRedoStack: boolean;\n}>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/editor/src/lib/editor/types/history-types.ts", + "releaseTag": "Public", + "name": "TLCommandHistoryOptions", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, { "kind": "TypeAlias", "canonicalReference": "@tldraw/editor!TLCompleteEvent:type", diff --git a/packages/editor/src/index.ts b/packages/editor/src/index.ts index 21fd7b4cf..17d191189 100644 --- a/packages/editor/src/index.ts +++ b/packages/editor/src/index.ts @@ -17,6 +17,7 @@ export { type Atom, type Signal, } from '@tldraw/state' +export type { TLCommandHistoryOptions } from './lib/editor/types/history-types' // eslint-disable-next-line local/no-export-star export * from '@tldraw/store' // eslint-disable-next-line local/no-export-star