@ckeditor/ckeditor5-ckbox 36.0.0 → 37.0.0-alpha.0

package/src/ckboxconfig.d.ts

@@ -0,0 +1,282 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ckbox/ckboxconfig
+ */
+import type { TokenUrl } from '@ckeditor/ckeditor5-cloud-services';
+/**
+ * The configuration of the {@link module:ckbox/ckbox~CKBox CKBox feature}.
+ *
+ * The minimal configuration for the CKBox feature requires providing the
+ * {@link module:ckbox/ckboxconfig~CKBoxConfig#tokenUrl `config.ckbox.tokenUrl`}:
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		ckbox: {
+ * 			tokenUrl: 'https://example.com/cs-token-endpoint'
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * Hovewer, you can also adjust the feature to fit your needs:
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		ckbox: {
+ * 			defaultUploadCategories: {
+ * 				Bitmaps: [ 'bmp' ],
+ * 				Pictures: [ 'jpg', 'jpeg' ],
+ * 				Scans: [ 'png', 'tiff' ]
+ * 			},
+ * 			ignoreDataId: true,
+ * 			serviceOrigin: 'https://example.com/',
+ * 			assetsOrigin: 'https://example.cloud/',
+ * 			tokenUrl: 'https://example.com/cs-token-endpoint'
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface CKBoxConfig {
+    /**
+     * The authentication token URL for CKBox feature.
+     *
+     * Defaults to {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl `config.cloudServices.tokenUrl`}
+     */
+    tokenUrl?: TokenUrl;
+    /**
+     * The theme for CKBox dialog.
+     */
+    theme?: string;
+    /**
+     * Defines the categories to which the uploaded images will be assigned.
+     * If configured, it overrides the category mappings defined on the cloud service.
+     * The value of this option should be an object, where the keys define categories and their values are the types of images
+     * that will be uploaded to these categories. The categories might be referenced by their name or ID.
+     *
+     * Example:
+     *
+     * ```ts
+     * const ckboxConfig = {
+     * 	defaultUploadCategories: {
+     * 		Bitmaps: [ 'bmp' ],
+     * 		Pictures: [ 'jpg', 'jpeg' ],
+     * 		Scans: [ 'png', 'tiff' ],
+     * 		// The category below is referenced by its ID.
+     * 		'fdf2a647-b67f-4a6c-b692-5ba1dc1ed87b': [ 'gif' ]
+     * 	}
+     * };
+     * ```
+     *
+     * @default null
+     */
+    defaultUploadCategories?: Record<string, Array<string>> | null;
+    /**
+     * Inserts the unique asset ID as the `data-ckbox-resource-id` attribute. To disable this behavior, set it to `true`.
+     *
+     * @default false
+     */
+    ignoreDataId?: boolean;
+    /**
+     * Configures the base URL of the API service. Required only in on-premises installations.
+     *
+     * @default 'https://api.ckbox.io'
+     */
+    serviceOrigin?: string;
+    /**
+     * Configures the base URL for assets inserted into the editor. Required only in on-premises installations.
+     *
+     * @default 'https://ckbox.cloud'
+     */
+    assetsOrigin?: string;
+    /**
+     * Configures the language for the CKBox dialog.
+     *
+     * Defaults to {@link module:utils/locale~Locale#uiLanguage `Locale#uiLanguage`}
+     */
+    language?: string;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:ckbox/ckbox~CKBox CKBox feature}.
+         *
+         * Read more in {@link module:ckbox/ckboxconfig~CKBoxConfig}.
+         */
+        ckbox?: CKBoxConfig;
+    }
+}
+/**
+ * Asset definition.
+ *
+ * The definition contains the unique `id`, asset `type` and an `attributes` definition.
+ */
+export type CKBoxAssetDefinition = CKBoxAssetImageDefinition | CKBoxAssetLinkDefinition;
+/**
+ * Image asset definition.
+ *
+ * The definition contains the unique `id`, asset `type` and an `attributes` definition.
+ */
+export interface CKBoxAssetImageDefinition {
+    /**
+     * An unique asset id.
+     */
+    id: string;
+    /**
+     * Asset type.
+     */
+    type: 'image';
+    /**
+     * Asset attributes.
+     */
+    attributes: CKBoxAssetImageAttributesDefinition;
+}
+/**
+ * Link asset definition.
+ *
+ * The definition contains the unique `id`, asset `type` and an `attributes` definition.
+ */
+export interface CKBoxAssetLinkDefinition {
+    /**
+     * An unique asset id.
+     */
+    id: string;
+    /**
+     * Asset type.
+     */
+    type: 'link';
+    /**
+     * Asset attributes.
+     */
+    attributes: CKBoxAssetLinkAttributesDefinition;
+}
+/**
+ * Asset attributes definition for an image.
+ *
+ * The definition contains the `imageFallbackUrl`, an `imageSources` array with one image source definition object and the
+ * `imageTextAlternative`.
+ *
+ * ```ts
+ * {
+ * 	imageFallbackUrl: 'https://example.com/assets/asset-id/images/1000.png',
+ * 	imageSources: [
+ * 		{
+ * 			sizes: '1000px',
+ * 			srcset:
+ * 				'https://example.com/assets/asset-id/images/100.webp 100w,' +
+ * 				'https://example.com/assets/asset-id/images/200.webp 200w,' +
+ * 				'https://example.com/assets/asset-id/images/300.webp 300w,' +
+ * 				'https://example.com/assets/asset-id/images/400.webp 400w,' +
+ * 				'https://example.com/assets/asset-id/images/500.webp 500w,' +
+ * 				'https://example.com/assets/asset-id/images/600.webp 600w,' +
+ * 				'https://example.com/assets/asset-id/images/700.webp 700w,' +
+ * 				'https://example.com/assets/asset-id/images/800.webp 800w,' +
+ * 				'https://example.com/assets/asset-id/images/900.webp 900w,' +
+ * 				'https://example.com/assets/asset-id/images/1000.webp 1000w',
+ * 			type: 'image/webp'
+ * 		}
+ * 	],
+ * 	imageTextAlternative: 'An alternative text for the image'
+ * }
+ * ```
+ */
+export interface CKBoxAssetImageAttributesDefinition {
+    /**
+     * A fallback URL for browsers that do not support the "webp" format.
+     */
+    imageFallbackUrl: string;
+    /**
+     * An array containing one image source definition object.
+     */
+    imageSources: Array<{
+        srcset: string;
+        sizes: string;
+        type: string;
+    }>;
+    /**
+     * An alternative text for an image.
+     */
+    imageTextAlternative: string;
+}
+/**
+ * Asset attributes definition for a link.
+ *
+ * The definition contains the `linkName` and `linkHref` strings.
+ *
+ * ```ts
+ * {
+ * 	linkName: 'File name',
+ * 	linkHref: 'https://example.com/assets/asset-id/file.pdf'
+ * }
+ * ```
+ */
+export interface CKBoxAssetLinkAttributesDefinition {
+    /**
+     * A link name.
+     */
+    linkName: string;
+    /**
+     * An URL for the asset.
+     */
+    linkHref: string;
+}
+/**
+ * Raw asset definition that is received from the CKBox feature.
+ */
+export interface CKBoxRawAssetDefinition {
+    /**
+     * A raw asset data definition.
+     */
+    data: CKBoxRawAssetDataDefinition;
+    /**
+     * An asset origin URL.
+     */
+    origin: string;
+}
+/**
+ * Part of raw asset data that is received from the CKBox feature.
+ */
+export interface CKBoxRawAssetDataDefinition {
+    /**
+     *  An unique asset id.
+     */
+    id: string;
+    /**
+     *  An asset extension.
+     */
+    extension: string;
+    /**
+     * An asset name.
+     */
+    name: string;
+    /**
+     *  A raw asset metadata definition.
+     */
+    metadata?: CKBoxRawAssetMetadataDefinition;
+}
+/**
+ * Part of raw asset data that is received from the CKBox feature. Properties are set only if the chosen asset is an image.
+ */
+export interface CKBoxRawAssetMetadataDefinition {
+    /**
+     * Image description.
+     */
+    description?: string;
+    /**
+     * Image width.
+     */
+    width?: number;
+    /**
+     * Image height.
+     */
+    height?: number;
+}

package/src/ckboxconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/ckboxediting.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ckbox/ckboxediting
+ */
+import type { InitializedToken } from '@ckeditor/ckeditor5-cloud-services';
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * The CKBox editing feature. It introduces the {@link module:ckbox/ckboxcommand~CKBoxCommand CKBox command} and
+ * {@link module:ckbox/ckboxuploadadapter~CKBoxUploadAdapter CKBox upload adapter}.
+ */
+export default class CKBoxEditing extends Plugin {
+    /**
+     * CKEditor Cloud Services access token.
+     */
+    private _token;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'CKBoxEditing';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    init(): Promise<void>;
+    /**
+     * Returns a token used by the CKBox plugin for communication with the CKBox service.
+     */
+    getToken(): InitializedToken;
+    /**
+     * Initializes the `ckbox` editor configuration.
+     */
+    private _initConfig;
+    /**
+     * Extends the schema to allow the `ckboxImageId` and `ckboxLinkId` attributes for links and images.
+     */
+    private _initSchema;
+    /**
+     * Configures the upcast and downcast conversions for the `ckboxImageId` and `ckboxLinkId` attributes.
+     */
+    private _initConversion;
+    /**
+     * Registers post-fixers that add or remove the `ckboxLinkId` and `ckboxImageId` attributes.
+     */
+    private _initFixers;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [CKBoxEditing.pluginName]: CKBoxEditing;
+    }
+}