kmpdfkit_demo/lib/compdfkit.dart

// Copyright © 2014-2025 PDF Technologies, Inc. All Rights Reserved.
//
// THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
// AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE ComPDFKit LICENSE AGREEMENT.
// UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
// This notice may not be removed from this file.

import 'dart:io';

import 'package:compdfkit_flutter/configuration/cpdf_configuration.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/services.dart';


/// ComPDFKit plugin to load PDF and image documents on both platform iOS and Android.
class ComPDFKit {
  static const MethodChannel _methodChannel = MethodChannel('com.compdfkit.flutter.plugin');

  /// Please enter your ComPDFKit license to initialize the ComPDFKit SDK.<br/>
  /// This method is used for offline license authentication.
  /// In version **1.13.0**, we have introduced a brand-new online authentication licensing scheme.
  /// By default, the ComPDFKit SDK performs online authentication.
  /// If you are unsure about the type of your license, please contact the [ComPDFKit team.](https://www.compdf.com/support).
  ///
  /// **samples:**<br/>
  /// ```dart
  /// ComPDFKit.init('your compdfkit license')
  /// ```
  static void init(String key) async {
    _methodChannel.invokeMethod('init_sdk', {'key': key});
  }

  /// Please enter your ComPDFKit license to initialize the ComPDFKit SDK.<br/>
  /// This method is used for online license authentication
  /// In version **1.13.0**, we have introduced a brand-new online authentication licensing scheme.
  /// By default, the ComPDFKit SDK performs online authentication.
  /// If you obtained your ComPDFKit License before the release of version 1.13.0, please use [ComPDFKit.init] <br/>
  /// If you are unsure about the type of your license, please contact the [ComPDFKit team.](https://www.compdf.com/support).
  ///
  /// **samples:**<br/>
  /// **online auth**
  /// ```dart
  /// ComPDFKit.initialize(androidOnlineLicense : 'your android platform compdfkit license', iosOnlineLicense: 'your ios platform compdfkit license')
  /// ```
  static void initialize({required String androidOnlineLicense,required String iosOnlineLicense}) {
    _methodChannel.invokeMethod('init_sdk_keys', {'androidOnlineLicense': androidOnlineLicense, 'iosOnlineLicense': iosOnlineLicense});
  }

  /// Get the version code of the ComPDFKit SDK.
  static Future<String> getVersionCode() async {
    String versionCode =
        await _methodChannel.invokeMethod('sdk_version_code');
    return versionCode;
  }

  /// Get the version information of ComPDFKit SDK.
  static Future<String> getSDKBuildTag() async {
    String buildTag = await _methodChannel.invokeMethod('sdk_build_tag');
    return buildTag;
  }

  /// Enter the local PDF file path, document password (if required),
  /// and configuration parameters, and display the PDF document in a new window.
  ///
  /// **for Samples:**
  /// ```dart
  /// ComPDFKit.openDocument(
  ///     'xxx/compdfkit.pdf',
  ///     password : '',
  ///     configuration:CPDFConfiguration())
  /// ```
  static void openDocument(String document,
      {String? password, CPDFConfiguration? configuration}) async {
    await _methodChannel.invokeMethod('open_document', <String, dynamic>{
      'document': document,
      'password': password,
      'configuration': configuration?.toJson()
    });
  }

  /// Retrieve the path of your operating system's temporary directory.
  /// Support [Android] and [iOS] only for now.
  static Future<Directory> getTemporaryDirectory() async {
    final String? path =
        await _methodChannel.invokeMethod('get_temporary_directory');
    if (path == null) {
      throw Exception('Unable to get temporary directory');
    }
    return Directory(path);
  }

  /// Delete annotated electronic signature file list data
  /// **for Samples:**
  /// ```dart
  /// ComPDFKit.removeSignFileList()
  /// ```
  static Future<bool> removeSignFileList() async {
    return await _methodChannel.invokeMethod('remove_sign_file_list');
  }

  static Future<String?> pickFile() async {
    final String? filePath = await _methodChannel.invokeMethod('pick_file');
    return filePath;
  }

  /// This method is supported only on the Android platform. It is used to create a URI for saving a file on the Android device.
  /// The file is saved in the `Downloads` directory by default, but you can specify a subdirectory within `Downloads` using the
  /// [childDirectoryName] parameter. If the [childDirectoryName] is not provided, the file will be saved directly in the `Downloads` directory.
  /// The [fileName] parameter is required to specify the name of the file (e.g., `test.pdf`).
  ///
  /// Example usage:
  /// ```dart
  /// String? uri = await ComPDFKit.createUri('test.pdf');
  /// ```
  ///
  /// - [fileName] (required) specifies the name of the file, for example `test.pdf`.
  /// - [childDirectoryName] (optional) specifies a subdirectory within the `Downloads` folder.
  /// - [mimeType] (optional) is the MIME type of the file, defaulting to `application/pdf`.
  static Future<String?> createUri(
      String fileName,
      {String? childDirectoryName,
        String mimeType = 'application/pdf'}) async {
    final String? uri = await _methodChannel.invokeMethod('create_uri', {
      'file_name' : fileName,
      'child_directory_name' : childDirectoryName,
      'mime_type' : mimeType
    });
    return uri;
  }

  /// Import font directory and configure whether to include system fonts.
  ///
  /// - Parameters:
  ///   - **dirPath**: The directory path where the font files are stored.
  ///     The imported fonts will be available for selection in text annotations and content editing, resolving issues with missing text in certain languages.
  ///   - **addSysFont**: Whether to include system fonts. Default is `true`, which will show system fonts in the font list.
  ///
  /// Note:
  /// This method must be called before [ComPDFKit.init] or [ComPDFKit.initialize], otherwise the settings will have no effect.
  ///
  /// Example:
  /// ```dart
  /// ComPDFKit.setImportFontDir('path/to/your/font', addSysFont: true);
  /// ComPDF
  static Future<bool> setImportFontDir(String dirPath, {bool addSysFont = true}) async {
    try{
      return await _methodChannel.invokeMethod('set_import_font_directory', {
        'dir_path': dirPath,
        'add_sys_font': addSysFont
      });
    }catch(e){
      debugPrint("setImportFontDir error: $e");
      return false;
    }
  }

  static Future<bool> createDocumentInstance(String id) async {
    return await _methodChannel.invokeMethod('create_document_plugin', id);
  }
}