@tiny-mce-umbraco/backoffice 16.0.0-rc2

package/dist/tiny-mce-umbraco.d.ts

@@ -0,0 +1,252 @@
+import type { ClassConstructor } from '@umbraco-cms/backoffice/extension-api';
+import type { Client } from '@hey-api/client-fetch';
+import { CSSResult } from 'lit';
+import { Editor } from 'tinymce';
+import type { ManifestApi } from '@umbraco-cms/backoffice/extension-api';
+import type { Options as Options_2 } from '@hey-api/client-fetch';
+import { RawEditorOptions } from 'tinymce';
+import { RequestResult } from '@hey-api/client-fetch';
+import type { TDataShape } from '@hey-api/client-fetch';
+import { TemplateResult } from 'lit-html';
+import { TinyMceConfigResponseModel as TinyMceConfigResponseModel_2 } from './types.gen';
+import type { UmbApi } from '@umbraco-cms/backoffice/extension-api';
+import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api';
+import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
+import type { UmbPropertyEditorConfigCollection } from '@umbraco-cms/backoffice/property-editor';
+import { UUIFormControlMixinElement } from '@umbraco-ui/uui-base';
+
+export declare const availableLanguages: string[];
+
+export declare type ClientOptions = {
+    baseUrl: 'https://localhost:44308' | (string & {});
+};
+
+export declare const defaultFallbackConfig: RawEditorOptions;
+
+export declare const defaultPremiumPluginsList: readonly ["a11ychecker", "advcode", "advtable", "advtemplate", "typography", "ai", "casechange", "checklist", "mediaembed", "export", "footnotes", "formatpainter", "mergetags", "pageembed", "powerpaste", "permanentpen", "tinymcespellchecker", "tableofcontents"];
+
+export declare type GetConfigData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/management/api/v1/tiny-mce/config';
+};
+
+export declare type GetConfigError = GetConfigErrors[keyof GetConfigErrors];
+
+export declare type GetConfigErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+    /**
+     * The authenticated user does not have access to this resource
+     */
+    403: unknown;
+    /**
+     * Not Found
+     */
+    404: ProblemDetails;
+};
+
+export declare type GetConfigResponse = GetConfigResponses[keyof GetConfigResponses];
+
+export declare type GetConfigResponses = {
+    /**
+     * OK
+     */
+    200: TinyMceConfigResponseModel;
+};
+
+/**
+ * The manifest for a TinyMCE plugin.
+ * The plugin will be loaded into the TinyMCE editor.
+ * A plugin can add things like buttons, menu items, context menu items, etc. through the TinyMCE API.
+ * A plugin can also add custom commands to the editor.
+ * A plugin can also modify the behavior of the editor.
+ * @see [TinyMCE Plugin](https://www.tiny.cloud/docs/tinymce/6/apis/tinymce.plugin/) for more information.
+ */
+export declare interface ManifestTinyMcePlugin extends ManifestApi<UmbTinyMcePluginBase> {
+    type: 'tinyMcePlugin';
+    meta?: MetaTinyMcePlugin;
+}
+
+export declare interface MetaTinyMcePlugin {
+    /**
+     * If the plugin adds toolbar buttons, this property can be used to configure the buttons.
+     * This configuration will be used on the Rich Text Editor configuration page.
+     */
+    plugins?: string[];
+    /**
+     * If the plugin adds toolbar buttons, this property can be used to configure the buttons.
+     * This configuration will be used on the Rich Text Editor configuration page.
+     */
+    toolbar?: Array<{
+        /**
+         * The alias of the toolbar button that will be configured in the TinyMCE editor.
+         * @see [TinyMCE Toolbar](https://www.tiny.cloud/docs/tinymce/6/toolbar-configuration-options/) for more information.
+         */
+        alias: string;
+        /**
+         * The label of the option shown on the Rich Text Editor configuration page.
+         */
+        label: string;
+        /**
+         * The icon shown on the Rich Text Editor configuration page. The icon has to be a part of TinyMCE's icon set.
+         * @optional
+         * @see [TinyMCE Icon Set](https://www.tiny.cloud/docs/tinymce/6/editor-icon-identifiers/) for available default icons.
+         */
+        icon?: string;
+        /**
+         * If this is a TinyMCE plugin that can be enabled/disabled
+         */
+        isplugin?: boolean;
+        /**
+         * Name of the plugin this is a part of (links to the plugin for property editor UI)
+         */
+        pluginAlias?: string;
+    }>;
+    /**
+     * @title Sets the default configuration for the TinyMCE editor.
+     * @description This configuration will be used when the editor is initialized. See the [TinyMCE Configuration](https://www.tiny.cloud/docs/configure/) for more information.
+     * @optional
+     * @TJS-type object
+     * @examples [
+     * {
+     *   "plugins": "wordcount",
+     *   "statusbar": true
+     * }
+     * ]
+     */
+    config?: RawEditorOptions;
+}
+
+export declare type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options_2<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+
+export declare const pastePreProcessHandler: RawEditorOptions['paste_preprocess'];
+
+export declare type ProblemDetails = {
+    type?: string | null;
+    title?: string | null;
+    status?: number | null;
+    detail?: string | null;
+    instance?: string | null;
+    [key: string]: unknown | (string | null) | (string | null) | (number | null) | (string | null) | (string | null) | undefined;
+};
+
+export declare type RichTextEditorCommand = {
+    alias: string;
+    name: string;
+    mode: RichTextEditorCommandModeModel;
+};
+
+export declare enum RichTextEditorCommandModeModel {
+    INSERT = "Insert",
+    SELECTION = "Selection",
+    ALL = "All"
+}
+
+export declare type RichTextEditorSettings = {
+    commands: Array<RichTextEditorCommand>;
+    plugins: Array<string>;
+    customConfig: {
+        [key: string]: string;
+    };
+    validElements: string;
+    invalidElements: string;
+    cloudApiKey?: string | null;
+};
+
+export declare type TinyMceConfigResponseModel = {
+    richTextEditor?: RichTextEditorSettings | null;
+    config?: TinyMceSettings | null;
+};
+
+export declare type TinyMcePluginArguments = {
+    host: UmbInputTinyMceElement;
+    editor: Editor;
+};
+
+export declare interface TinyMcePluginInterface {
+    init(): Promise<void>;
+}
+
+export declare class TinyMceService {
+    static getConfig<ThrowOnError extends boolean = false>(options?: Options<GetConfigData, ThrowOnError>): RequestResult<TinyMceConfigResponseModel_2, unknown, ThrowOnError>;
+}
+
+export declare type TinyMceSettings = {
+    apikey: string;
+    tinyMceVersion: string;
+    tinyMceUrl: string;
+    openAiApikey: string;
+    pluginsToExclude: Array<string>;
+    customConfig: {};
+};
+
+export declare const UMB_BLOCK_ENTRY_WEB_COMPONENTS_ABSOLUTE_PATH = "@umbraco-cms/backoffice/block-rte";
+
+export declare const UMB_BLOCK_RTE_PROPERTY_EDITOR_UI_ALIAS = "Umb.PropertyEditorUi.TinyMCE";
+
+export declare class UmbInputTinyMceElement extends UmbInputTinyMceElement_base {
+    #private;
+    configuration?: UmbPropertyEditorConfigCollection;
+    protected getFormElement(): HTMLIFrameElement | undefined;
+    set value(newValue: FormDataEntryValue | FormData);
+    get value(): FormDataEntryValue | FormData;
+    /**
+     * Sets the input to readonly mode, meaning value cannot be changed but still able to read and select its content.
+     * @type {boolean}
+     * @attr
+     * @default
+     */
+    get readonly(): boolean;
+    set readonly(value: boolean);
+    private readonly _editorElement?;
+    getEditor(): Editor | null | undefined;
+    firstUpdated(): void;
+    disconnectedCallback(): void;
+    getFormatStyles(stylesheetPaths: Array<string>): Promise<any[]>;
+    /**
+     * Nothing rendered by default - TinyMCE initialization creates
+     * a target div and binds the RTE to that element
+     */
+    render(): TemplateResult<1>;
+    static readonly styles: CSSResult[];
+}
+
+declare const UmbInputTinyMceElement_base: (new (...args: any[]) => UUIFormControlMixinElement<FormDataEntryValue | FormData>) & typeof UmbLitElement;
+
+export declare class UmbTinyMcePluginBase extends UmbControllerBase implements UmbApi, TinyMcePluginInterface {
+    editor: Editor;
+    configuration?: UmbPropertyEditorConfigCollection;
+    constructor(arg: TinyMcePluginArguments);
+    static extendEditorConfig(_config: any): Promise<void>;
+    init(): Promise<void>;
+}
+
+export declare interface UmbTinyMcePluginClass extends ClassConstructor<UmbTinyMcePluginBase> {
+    extendEditorConfig?: (_config: any) => Promise<void>;
+}
+
+/**
+ * Setup sanitization for preventing injecting arbitrary JavaScript execution in attributes:
+ * https://github.com/advisories/GHSA-w7jx-j77m-wp65
+ * https://github.com/advisories/GHSA-5vm8-hhgr-jcjp
+ * @param editor
+ */
+export declare const uriAttributeSanitizer: (editor: Editor) => void;
+
+export { }

package/package.json

@@ -0,0 +1,55 @@
+{
+	"name": "@tiny-mce-umbraco/backoffice",
+	"version": "16.0.0-rc2",
+	"description": "This Umbraco CMS package enables access to the TinyMCE-based Rich Text Editor (RTE) in version 16 and above. It also supports the use of TinyMCE Premium plugins with a valid subscription. Additional features include streamlined configuration for RTE Data Types in Umbraco and enhanced settings that support direct JSON-based configuration via .NET (appsettings.config).",
+	"keywords": [
+		"umbraco",
+		"tinymce",
+		"rte"
+	],
+	"author": "ProWorks Corporation",
+	"license": "MIT",
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"types": "types/index.d.ts",
+	"files": [ "dist" ],
+	"scripts": {
+		"dev": "tsc && vite build --watch",
+		"build": "tsc && vite build",
+		"build:api": "tsc -p tsconfig.api.json && api-extractor run --verbose",
+		"pack:api": "npm pack",
+		"generate-client": "node scripts/generate-openapi.js https://localhost:44308/umbraco/swagger/tiny-mce/swagger.json"
+	},
+	"dependencies": {
+		"tinymce": "^6.8.5",
+		"tinymce-i18n": "^24.12.30"
+	},
+	"devDependencies": {
+		"@hey-api/client-fetch": "^0.10.0",
+		"@hey-api/openapi-ts": "^0.66.1",
+		"@microsoft/api-extractor": "^7.52.8",
+		"@rollup/plugin-json": "^6.1.0",
+		"@rollup/plugin-node-resolve": "^16.0.0",
+		"@rollup/plugin-replace": "^6.0.2",
+		"@umbraco-cms/backoffice": "^16.0.0-rc3",
+		"chalk": "^5.3.0",
+		"cross-env": "7.0.3",
+		"eslint": "^9.25.1",
+		"node-fetch": "^3.3.2",
+		"rollup": "^4.34.8",
+		"rollup-plugin-esbuild": "^6.2.0",
+		"rollup-plugin-import-css": "^3.5.8",
+		"tiny-glob": "^0.2.9",
+		"typescript": "^5.7.3",
+		"vite": "^6.2.2",
+		"vite-plugin-static-copy": "^2.2.0",
+		"vite-tsconfig-paths": "^5.1.4"
+	},
+	"peerDependencies": {
+		"@umbraco-cms/backoffice": "^16.0.0-rc3",
+		"tinymce": "^6.8.5",
+		"tinymce-i18n": "^24.12.30"
+	}
+}