@widgetic/editor 4.1.12 → 4.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,4 +3,4 @@
3
3
  * its sentences with it until the page gives another translator). The editor's screens get their words, in the page's
4
4
  * language, from `useEditorLanguage` (see `language.ts`).
5
5
  */
6
- export declare const translateEnglish: import("@widgetic/design-system/i18n").Translate<"editor.app.loading" | "editor.app.tryAgain" | "editor.app.retry" | "editor.failure.widgetNotPublished" | "editor.failure.sessionEndedWhileSaving" | "editor.failure.sessionEnded" | "editor.failure.compositionNotFound" | "editor.failure.noAccess" | "editor.failure.noWidget" | "editor.failure.widgetNotFound" | "editor.failure.saveNeedsConnection" | "editor.failure.loadNeedsConnection" | "editor.failure.saveFailed" | "editor.failure.loadFailed" | "editor.failure.settingsLoadFailed" | "editor.failure.noSettings" | "editor.failure.errorCode" | "editor.conflict.title" | "editor.conflict.bodyNamed" | "editor.conflict.body" | "editor.conflict.keepMine" | "editor.conflict.keepMineHint" | "editor.conflict.loadLatest" | "editor.conflict.loadLatestHint" | "editor.conflict.working" | "editor.conflict.resolveFailed" | "editor.presence.blockedTitleNamed" | "editor.presence.blockedTitleYou" | "editor.presence.blockedTitle" | "editor.presence.blockedBody" | "editor.presence.lostTitleNamed" | "editor.presence.lostTitleYou" | "editor.presence.lostTitle" | "editor.presence.lostBody" | "editor.presence.takeOver" | "editor.presence.takeOverHint" | "editor.presence.lookOnly" | "editor.presence.lookOnlyHint" | "editor.presence.working" | "editor.presence.actionFailed" | "editor.presence.readOnlyNamed" | "editor.presence.readOnlyYou" | "editor.presence.readOnly" | "editor.presence.readOnlyFree" | "editor.presence.startEditing" | "editor.props.title" | "editor.props.designTab" | "editor.props.contentTab" | "editor.props.contentCard" | "editor.props.save" | "editor.props.saving" | "editor.props.noConfiguration" | "editor.props.noDesignSchema" | "editor.props.noSchemaData" | "editor.props.noComponents" | "editor.props.noProperties" | "editor.props.addItem" | "editor.props.deleteItem" | "editor.embed.title" | "editor.embed.loading" | "editor.embed.noCode" | "editor.embed.codeHeader" | "editor.embed.headerArea" | "editor.embed.readMore" | "editor.embed.copy" | "editor.embed.copied" | "editor.embed.copiedHint" | "editor.embed.copiedDone" | "editor.embed.copyFailed" | "editor.embed.copyFailedHint" | "editor.preview.title" | "editor.preview.dragHandle" | "editor.preview.desktop" | "editor.preview.mobile" | "editor.preview.widthShort" | "editor.preview.heightShort" | "editor.preview.noUrl" | "editor.preview.copyUrl" | "editor.preview.refresh" | "editor.preview.fitToPanel" | "editor.preview.mobileViewport" | "editor.preview.desktopViewport" | "editor.preview.openInNewTab" | "editor.preview.newTab" | "editor.preview.selectWidget" | "editor.preview.widgetName" | "editor.preview.notPublished" | "editor.preview.publishToPreview" | "editor.preview.frameTitle" | "editor.preview.frameTitleNamed" | "editor.preview.unavailable" | "editor.preview.loadFailedPreview" | "editor.preview.retry" | "editor.preview.retryBuild" | "editor.preview.retryPreview" | "editor.preview.fixErrors" | "editor.preview.viewErrors" | "editor.preview.runtimeError" | "editor.preview.compilationErrors" | "editor.preview.compilationErrorsDetail" | "editor.preview.noCodeYet" | "editor.preview.noPreview" | "editor.preview.building" | "editor.preview.loadingWidget" | "editor.preview.loadingPreview" | "editor.preview.checkingWidget" | "editor.preview.applyingSettings" | "editor.preview.connecting" | "editor.preview.generatingCode" | "editor.list.recentlyUsed" | "editor.list.more" | "editor.list.searchResults" | "editor.list.loadingMore" | "editor.list.deleteItem" | "editor.category.all" | "editor.category.mine" | "editor.category.sansSerif" | "editor.category.serif" | "editor.category.script" | "editor.category.other" | "editor.category.icons" | "editor.category.emojis" | "editor.category.clipart" | "editor.font.select" | "editor.font.title" | "editor.font.search" | "editor.font.list" | "editor.font.loading" | "editor.font.noneFound" | "editor.font.noneAvailable" | "editor.font.remove" | "editor.font.weight" | "editor.font.weightList" | "editor.fontWeight.withItalic" | "editor.fontWeight.italic" | "editor.fontWeight.thin" | "editor.fontWeight.extraLight" | "editor.fontWeight.light" | "editor.fontWeight.regular" | "editor.fontWeight.medium" | "editor.fontWeight.semiBold" | "editor.fontWeight.bold" | "editor.fontWeight.extraBold" | "editor.fontWeight.black" | "editor.vector.select" | "editor.vector.title" | "editor.vector.search" | "editor.vector.list" | "editor.vector.noneFound" | "editor.vector.noneAvailable" | "editor.file.useFile" | "editor.file.useImage" | "editor.file.useVideo" | "editor.file.useAudio" | "editor.file.useDocument" | "editor.file.addFile" | "editor.file.addImage" | "editor.file.addVideo" | "editor.file.addAudio" | "editor.file.addDocument" | "editor.file.play" | "editor.file.pause" | "editor.file.notFound" | "editor.file.emptyFolder" | "editor.file.clear" | "editor.file.pickFailed" | "editor.file.dialogTitle" | "editor.file.closeDialog" | "editor.color.noRecent" | "editor.color.picker" | "editor.date.pick" | "editor.date.pickRange" | "editor.date.invalid" | "editor.date.selectMonth" | "editor.date.selectYear" | "editor.date.calendarLabel" | "editor.date.rangeCalendarLabel" | "editor.date.previousMonth" | "editor.date.nextMonth" | "editor.dateField.dayHint" | "editor.dateField.monthHint" | "editor.dateField.yearHint" | "editor.dateField.dayLabel" | "editor.dateField.monthLabel" | "editor.dateField.yearLabel" | "editor.dropdown.select" | "editor.switch.off" | "editor.switch.on" | "editor.tags.add" | "editor.position.x" | "editor.position.y" | "editor.fixedPosition.set" | "editor.fixedPosition.topLeft" | "editor.fixedPosition.topCenter" | "editor.fixedPosition.topRight" | "editor.fixedPosition.centerLeft" | "editor.fixedPosition.centerCenter" | "editor.fixedPosition.centerRight" | "editor.fixedPosition.bottomLeft" | "editor.fixedPosition.bottomCenter" | "editor.fixedPosition.bottomRight" | "editor.corners.group" | "editor.corners.topLeft" | "editor.corners.topRight" | "editor.corners.bottomLeft" | "editor.corners.bottomRight" | "editor.corners.lock" | "editor.corners.unlock" | "editor.textArea.toolbar" | "editor.textArea.toggleBold" | "editor.textArea.toggleItalic" | "editor.textArea.toggleUnderline" | "editor.textArea.toggleLink" | "editor.textArea.text" | "editor.textArea.paragraph" | "editor.textArea.heading1" | "editor.textArea.heading2" | "editor.textArea.heading3" | "editor.textArea.bulletList" | "editor.textArea.numberedList" | "editor.textArea.checkList" | "editor.textArea.textStyles" | "editor.textArea.listStyles" | "editor.textArea.enterUrl" | "editor.schema.subtitleFont">;
6
+ export declare const translateEnglish: import("@widgetic/design-system/i18n").Translate<"editor.app.loading" | "editor.app.tryAgain" | "editor.app.retry" | "editor.failure.widgetNotPublished" | "editor.failure.sessionEndedWhileSaving" | "editor.failure.sessionEnded" | "editor.failure.compositionNotFound" | "editor.failure.noAccess" | "editor.failure.noWidget" | "editor.failure.widgetNotFound" | "editor.failure.saveNeedsConnection" | "editor.failure.loadNeedsConnection" | "editor.failure.saveFailed" | "editor.failure.loadFailed" | "editor.failure.settingsLoadFailed" | "editor.failure.noSettings" | "editor.failure.errorCode" | "editor.conflict.title" | "editor.conflict.bodyNamed" | "editor.conflict.body" | "editor.conflict.keepMine" | "editor.conflict.keepMineHint" | "editor.conflict.loadLatest" | "editor.conflict.loadLatestHint" | "editor.conflict.working" | "editor.conflict.resolveFailed" | "editor.presence.blockedTitleNamed" | "editor.presence.blockedTitleYou" | "editor.presence.blockedTitle" | "editor.presence.blockedBody" | "editor.presence.lostTitleNamed" | "editor.presence.lostTitleYou" | "editor.presence.lostTitle" | "editor.presence.lostBody" | "editor.presence.takeOver" | "editor.presence.takeOverHint" | "editor.presence.lookOnly" | "editor.presence.lookOnlyHint" | "editor.presence.working" | "editor.presence.actionFailed" | "editor.presence.readOnlyNamed" | "editor.presence.readOnlyYou" | "editor.presence.readOnly" | "editor.presence.readOnlyFree" | "editor.presence.startEditing" | "editor.props.title" | "editor.props.designTab" | "editor.props.contentTab" | "editor.props.contentCard" | "editor.props.save" | "editor.props.saving" | "editor.props.noConfiguration" | "editor.props.noDesignSchema" | "editor.props.noSchemaData" | "editor.props.noComponents" | "editor.props.noProperties" | "editor.props.addItem" | "editor.props.deleteItem" | "editor.embed.title" | "editor.embed.loading" | "editor.embed.noCode" | "editor.embed.codeHeader" | "editor.embed.headerArea" | "editor.embed.readMore" | "editor.embed.copy" | "editor.embed.copied" | "editor.embed.copiedHint" | "editor.embed.copiedDone" | "editor.embed.copyFailed" | "editor.embed.copyFailedHint" | "editor.preview.title" | "editor.preview.dragHandle" | "editor.preview.desktop" | "editor.preview.mobile" | "editor.preview.widthShort" | "editor.preview.heightShort" | "editor.preview.noUrl" | "editor.preview.copyUrl" | "editor.preview.refresh" | "editor.preview.fitToPanel" | "editor.preview.mobileViewport" | "editor.preview.desktopViewport" | "editor.preview.openInNewTab" | "editor.preview.newTab" | "editor.preview.selectWidget" | "editor.preview.widgetName" | "editor.preview.notPublished" | "editor.preview.publishToPreview" | "editor.preview.frameTitle" | "editor.preview.frameTitleNamed" | "editor.preview.unavailable" | "editor.preview.loadFailedPreview" | "editor.preview.retry" | "editor.preview.retryBuild" | "editor.preview.retryPreview" | "editor.preview.fixErrors" | "editor.preview.viewErrors" | "editor.preview.runtimeError" | "editor.preview.compilationErrors" | "editor.preview.compilationErrorsDetail" | "editor.preview.noCodeYet" | "editor.preview.noPreview" | "editor.preview.building" | "editor.preview.loadingWidget" | "editor.preview.loadingPreview" | "editor.preview.checkingWidget" | "editor.preview.applyingSettings" | "editor.preview.connecting" | "editor.preview.generatingCode" | "editor.list.recentlyUsed" | "editor.list.more" | "editor.list.searchResults" | "editor.list.loadingMore" | "editor.list.deleteItem" | "editor.category.all" | "editor.category.mine" | "editor.category.sansSerif" | "editor.category.serif" | "editor.category.script" | "editor.category.other" | "editor.category.icons" | "editor.category.emojis" | "editor.category.clipart" | "editor.font.select" | "editor.font.title" | "editor.font.search" | "editor.font.list" | "editor.font.loading" | "editor.font.noneFound" | "editor.font.noneAvailable" | "editor.font.remove" | "editor.font.weight" | "editor.font.weightList" | "editor.fontWeight.withItalic" | "editor.fontWeight.italic" | "editor.fontWeight.thin" | "editor.fontWeight.extraLight" | "editor.fontWeight.light" | "editor.fontWeight.regular" | "editor.fontWeight.medium" | "editor.fontWeight.semiBold" | "editor.fontWeight.bold" | "editor.fontWeight.extraBold" | "editor.fontWeight.black" | "editor.vector.select" | "editor.vector.title" | "editor.vector.search" | "editor.vector.list" | "editor.vector.noneFound" | "editor.vector.noneAvailable" | "editor.file.useFile" | "editor.file.useImage" | "editor.file.useVideo" | "editor.file.useAudio" | "editor.file.useDocument" | "editor.file.addFile" | "editor.file.addImage" | "editor.file.addVideo" | "editor.file.addAudio" | "editor.file.addDocument" | "editor.file.play" | "editor.file.pause" | "editor.file.notFound" | "editor.file.emptyFolder" | "editor.file.clear" | "editor.file.pickFailed" | "editor.file.dialogTitle" | "editor.file.closeDialog" | "editor.color.noRecent" | "editor.color.picker" | "editor.date.pick" | "editor.date.pickRange" | "editor.date.invalid" | "editor.date.selectMonth" | "editor.date.selectYear" | "editor.date.calendarLabel" | "editor.date.rangeCalendarLabel" | "editor.date.previousMonth" | "editor.date.nextMonth" | "editor.dateField.dayHint" | "editor.dateField.monthHint" | "editor.dateField.yearHint" | "editor.dateField.dayLabel" | "editor.dateField.monthLabel" | "editor.dateField.yearLabel" | "editor.knowledge.loading" | "editor.knowledge.unavailable" | "editor.knowledge.retry" | "editor.knowledge.empty" | "editor.knowledge.listLabel" | "editor.knowledge.characters" | "editor.knowledge.processing" | "editor.knowledge.removeLabel" | "editor.knowledge.removeConfirm" | "editor.knowledge.keep" | "editor.knowledge.removing" | "editor.knowledge.sending" | "editor.knowledge.sendingOf" | "editor.knowledge.addFiles" | "editor.knowledge.dropHint" | "editor.knowledge.addText" | "editor.knowledge.documentsUsed" | "editor.knowledge.textUsed" | "editor.knowledge.titleLabel" | "editor.knowledge.titlePlaceholder" | "editor.knowledge.textLabel" | "editor.knowledge.textPlaceholder" | "editor.knowledge.addDocument" | "editor.knowledge.cancel" | "editor.knowledge.dismiss" | "editor.knowledgeError.titleRequired" | "editor.knowledgeError.titleTooLong" | "editor.knowledgeError.textRequired" | "editor.knowledgeError.textTooLong" | "editor.knowledgeError.fileRequired" | "editor.knowledgeError.fileTooLarge" | "editor.knowledgeError.fileTypeUnsupported" | "editor.knowledgeError.fileUnreadable" | "editor.knowledgeError.fileNoText" | "editor.knowledgeError.duplicate" | "editor.knowledgeError.limitDocuments" | "editor.knowledgeError.limitText" | "editor.knowledgeError.tryLater" | "editor.knowledgeError.tooManyAdds" | "editor.knowledgeError.connection" | "editor.knowledgeError.generic" | "editor.knowledgeError.moreProblems" | "editor.knowledgeError.notSent" | "editor.dropdown.select" | "editor.switch.off" | "editor.switch.on" | "editor.tags.add" | "editor.position.x" | "editor.position.y" | "editor.fixedPosition.set" | "editor.fixedPosition.topLeft" | "editor.fixedPosition.topCenter" | "editor.fixedPosition.topRight" | "editor.fixedPosition.centerLeft" | "editor.fixedPosition.centerCenter" | "editor.fixedPosition.centerRight" | "editor.fixedPosition.bottomLeft" | "editor.fixedPosition.bottomCenter" | "editor.fixedPosition.bottomRight" | "editor.corners.group" | "editor.corners.topLeft" | "editor.corners.topRight" | "editor.corners.bottomLeft" | "editor.corners.bottomRight" | "editor.corners.lock" | "editor.corners.unlock" | "editor.textArea.toolbar" | "editor.textArea.toggleBold" | "editor.textArea.toggleItalic" | "editor.textArea.toggleUnderline" | "editor.textArea.toggleLink" | "editor.textArea.text" | "editor.textArea.paragraph" | "editor.textArea.heading1" | "editor.textArea.heading2" | "editor.textArea.heading3" | "editor.textArea.bulletList" | "editor.textArea.numberedList" | "editor.textArea.checkList" | "editor.textArea.textStyles" | "editor.textArea.listStyles" | "editor.textArea.enterUrl" | "editor.schema.subtitleFont">;
package/dist/index.d.ts CHANGED
@@ -9,6 +9,7 @@ export { default as EmbedEditor } from './components/editors/EmbedEditor.svelte'
9
9
  export { default as CompositionEditorApp } from './components/editors/CompositionEditorApp.svelte';
10
10
  export { CompositionApiError, createCompositionApi, type CompositionApi, type CompositionApiOptions, type CompositionPreviewInfo, type SaveCompositionBody, type TokenReason } from './composition/compositionApi.js';
11
11
  export { failureMessage, type CompositionEditorEvent, type CompositionEditorState, type ConflictResolution, type DeviceView, type EditorConflict, type EditorFailure } from './composition/compositionEditorController.js';
12
+ export type { KnowledgeDocument, KnowledgeDocumentStatus, KnowledgeListing, KnowledgeTotals } from './composition/knowledgeDocuments.js';
12
13
  export type { EditLeaseHolder } from './composition/compositionApi.js';
13
14
  export type { PresencePhase, PresenceState } from './composition/editLeaseController.js';
14
15
  export { EDITOR_MESSAGES, ALL_EDITOR_MESSAGES, checkEditorMessages, provideEditorLanguage, useEditorLanguage, type EditorLanguage, type EditorLanguageHandle, type EditorMessageKey } from './i18n/index.js';
@@ -0,0 +1,10 @@
1
+ import type { KnowledgeDocumentsClient } from './composition/knowledgeDocuments.js';
2
+ /** Gives the calls for the composition being edited, or `undefined` when there is none. */
3
+ export type KnowledgeDocumentsGetter = () => KnowledgeDocumentsClient | undefined;
4
+ /** Called while an editor component is being created: everything below it can reach the client with {@link useEditorKnowledgeDocuments}. */
5
+ export declare function provideEditorKnowledgeDocuments(getClient: KnowledgeDocumentsGetter): void;
6
+ /**
7
+ * Called while a component is being created. Gives the function that tells which composition's documents the editor above it
8
+ * edits. Outside an editor that provides one (a control used on its own) it always gives `undefined`.
9
+ */
10
+ export declare function useEditorKnowledgeDocuments(): KnowledgeDocumentsGetter;
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Hands the calls that list, add and remove the documents of AI Answers from the composition editor down to the Documents panel.
3
+ *
4
+ * Same pattern as {@link mediaLibraryContext}: the panel sits several components below the editor and is made from a schema,
5
+ * so the client is not passed as a prop through every layer; a Svelte context reaches it directly, and stays separate for each
6
+ * editor on a page. Only an editor that knows WHICH composition it edits (`CompositionEditorApp`) provides one. `PropsEditor`
7
+ * used on its own (the widget creator) has no composition to put documents in, and the panel says so instead of failing.
8
+ *
9
+ * What is stored is a function that gives the client, not the client itself, so a host that changes its token function or
10
+ * its composition is read at the moment of use.
11
+ */
12
+ import { getContext, setContext } from 'svelte';
13
+ const KNOWLEDGE_DOCUMENTS_CONTEXT_KEY = Symbol.for('widgetic.editor.knowledgeDocuments');
14
+ /** Called while an editor component is being created: everything below it can reach the client with {@link useEditorKnowledgeDocuments}. */
15
+ export function provideEditorKnowledgeDocuments(getClient) {
16
+ setContext(KNOWLEDGE_DOCUMENTS_CONTEXT_KEY, getClient);
17
+ }
18
+ /**
19
+ * Called while a component is being created. Gives the function that tells which composition's documents the editor above it
20
+ * edits. Outside an editor that provides one (a control used on its own) it always gives `undefined`.
21
+ */
22
+ export function useEditorKnowledgeDocuments() {
23
+ try {
24
+ return getContext(KNOWLEDGE_DOCUMENTS_CONTEXT_KEY) ?? (() => undefined);
25
+ }
26
+ catch (error) {
27
+ // getContext only works while a component is being created; anywhere else there is no editor above to ask.
28
+ console.warn('[editor] useEditorKnowledgeDocuments was called outside a component; the panel has no composition to use', error);
29
+ return () => undefined;
30
+ }
31
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@widgetic/editor",
3
- "version": "4.1.12",
3
+ "version": "4.1.14",
4
4
  "license": "SEE LICENSE IN LICENSE",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",