@capacitor/file-viewer 1.0.0-dev.1

package/CapacitorFileViewer.podspec

@@ -0,0 +1,18 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorFileViewer'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/FileViewerPlugin/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '14.0'
+  s.dependency 'IONFileViewerLib', spec='~> 1.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ionic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Package.swift

@@ -0,0 +1,34 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapacitorFileViewer",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapacitorFileViewer",
+            targets: ["FileViewerPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", branch: "7.0.0")
+    ],
+    targets: [
+        .binaryTarget(
+            name: "IONFileViewerLib",
+            url: "https://github.com/ionic-team/ion-ios-fileviewer/releases/download/1.0.0/IONFileViewerLib.zip",
+            checksum: "02728411a63b4dcb630251d6b37f0ea173804a6408d916a0ba3f1ea9d4301b1a" // sha-256
+        ),
+        .target(
+            name: "FileViewerPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                "IONFileViewerLib"
+            ],
+            path: "ios/Sources/FileViewerPlugin"),
+        .testTarget(
+            name: "FileViewerPluginTests",
+            dependencies: ["FileViewerPlugin"],
+            path: "ios/Tests/FileViewerPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,221 @@
+# @capacitor/file-viewer
+
+The FileViewer API provides mechanisms for opening files and previewing media. Not available on web.
+
+The media preview methods are currently only supported on iOS. It uses a built-in player.
+
+## Install
+
+```bash
+npm install @capacitor/file-viewer
+npx cap sync
+```
+
+## Example
+
+```typescript
+import { FileViewer } from "@capacitor/file-viewer";
+
+// can use a plugin like @capacitor/filesystem to get the full path to the file
+const openDocument = async () => {
+  await FileViewer.openDocumentFromLocalPath({
+    path: "path/to/file.pdf"
+  });
+};
+
+// ios-specific
+const previewMedia = async () => {
+  await FileViewer.previewMediaContentFromUrl({
+    path: "https://url_hosting_media/file.mp4"
+  });
+}
+```
+
+## API
+
+<docgen-index>
+
+* [`openDocumentFromLocalPath(...)`](#opendocumentfromlocalpath)
+* [`openDocumentFromResources(...)`](#opendocumentfromresources)
+* [`openDocumentFromUrl(...)`](#opendocumentfromurl)
+* [`previewMediaContentFromLocalPath(...)`](#previewmediacontentfromlocalpath)
+* [`previewMediaContentFromResources(...)`](#previewmediacontentfromresources)
+* [`previewMediaContentFromUrl(...)`](#previewmediacontentfromurl)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+For list of existing error codes, see [Errors](#errors).
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+File Viewer API
+
+Only available in Native Android and iOS; not available for Web / PWAs.
+
+### openDocumentFromLocalPath(...)
+
+```typescript
+openDocumentFromLocalPath(options: OpenFromLocalPathOptions) => Promise<void>
+```
+
+Open a file stored in the local file system
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#openfromlocalpathoptions">OpenFromLocalPathOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### openDocumentFromResources(...)
+
+```typescript
+openDocumentFromResources(options: OpenFromResourcesOptions) => Promise<void>
+```
+
+Open an app resource file
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#openfromresourcesoptions">OpenFromResourcesOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### openDocumentFromUrl(...)
+
+```typescript
+openDocumentFromUrl(options: OpenFromUrlOptions) => Promise<void>
+```
+
+Open a file from a remote url
+
+| Param         | Type                                                              |
+| ------------- | ----------------------------------------------------------------- |
+| **`options`** | <code><a href="#openfromurloptions">OpenFromUrlOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### previewMediaContentFromLocalPath(...)
+
+```typescript
+previewMediaContentFromLocalPath(options: PreviewMediaFromLocalPathOptions) => Promise<void>
+```
+
+Preview a media file (namely, video) stored in the local file system.
+Only implemented in iOS. Android defaults to `openDocumentFromLocalPath`.
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#openfromlocalpathoptions">OpenFromLocalPathOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### previewMediaContentFromResources(...)
+
+```typescript
+previewMediaContentFromResources(options: PreviewMediaFromResourcesOptions) => Promise<void>
+```
+
+Preview a media file (namely, video) from the app's resources.
+Only implemented in iOS. Android defaults to `openDocumentFromResources`.
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#openfromresourcesoptions">OpenFromResourcesOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### previewMediaContentFromUrl(...)
+
+```typescript
+previewMediaContentFromUrl(options: PreviewMediaFromUrlOptions) => Promise<void>
+```
+
+Preview a media file (namely, video) from a remote url.
+Only implemented in iOS. Android defaults to `openDocumentFromUrl`.
+
+| Param         | Type                                                              |
+| ------------- | ----------------------------------------------------------------- |
+| **`options`** | <code><a href="#openfromurloptions">OpenFromUrlOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### OpenFromLocalPathOptions
+
+| Prop       | Type                | Description                                | Since |
+| ---------- | ------------------- | ------------------------------------------ | ----- |
+| **`path`** | <code>string</code> | The full absolute path to the file to open | 1.0.0 |
+
+
+#### OpenFromResourcesOptions
+
+| Prop       | Type                | Description                                    | Since |
+| ---------- | ------------------- | ---------------------------------------------- | ----- |
+| **`path`** | <code>string</code> | The relative path to the resource file to open | 1.0.0 |
+
+
+#### OpenFromUrlOptions
+
+| Prop      | Type                | Description                                 | Since |
+| --------- | ------------------- | ------------------------------------------- | ----- |
+| **`url`** | <code>string</code> | The remote url pointing to the file to open | 1.0.0 |
+
+
+### Type Aliases
+
+
+#### PreviewMediaFromLocalPathOptions
+
+<code><a href="#openfromlocalpathoptions">OpenFromLocalPathOptions</a></code>
+
+
+#### PreviewMediaFromResourcesOptions
+
+<code><a href="#openfromresourcesoptions">OpenFromResourcesOptions</a></code>
+
+
+#### PreviewMediaFromUrlOptions
+
+<code><a href="#openfromurloptions">OpenFromUrlOptions</a></code>
+
+</docgen-api>
+
+### Errors
+
+The plugin returns the following errors with specific codes on native Android and iOS:
+
+| Error code        | Platform(s)      | Message                      |
+|-------------------|------------------|------------------------------|
+| OS-PLUG-FLVW-0004 | Android, iOS     | The file you are trying to open does not exist. |
+| OS-PLUG-FLVW-0005 | Android, iOS     | The URL you are trying to open is malformed. |
+| OS-PLUG-FLVW-0006 | Android, iOS     | Path of the file to open is either null or empty. |
+| OS-PLUG-FLVW-0007 | Android, iOS     | URL to open is either null or empty. |
+| OS-PLUG-FLVW-0008 | Android, iOS     | Could not open the file. |
+| OS-PLUG-FLVW-0009 | Android, iOS     | Invalid parameters. |
+| OS-PLUG-FLVW-0010 | Android          | There is no app to open this file. |
+| OS-PLUG-FLVW-0011 | iOS              | Cordova / Capacitor bridge isn’t initialized. |
+| OS-PLUG-FLVW-0012 | iOS              | The download failed. |
+| OS-PLUG-FLVW-0013 | iOS              | The file has no extension. |

package/android/build.gradle

@@ -0,0 +1,68 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+
+buildscript {
+    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.9.24'
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.3'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+android {
+    namespace "com.capacitorjs.plugins.fileviewer"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+kotlin {
+    jvmToolchain(21)
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "io.ionic.libs:ionfileviewer-android:1.0.0"
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+
+    testImplementation "junit:junit:$junitVersion"
+
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest />

package/android/src/main/java/com/capacitorjs/plugins/fileviewer/FileViewerErrors.kt

@@ -0,0 +1,68 @@
+package com.capacitorjs.plugins.fileviewer
+
+import io.ionic.libs.ionfileviewerlib.model.IONFLVWException
+
+object FileViewerErrors {
+    private fun formatErrorCode(number: Int): String {
+        return "OS-PLUG-FLVW-" + number.toString().padStart(4, '0')
+    }
+
+    data class ErrorInfo(
+        val code: String,
+        val message: String
+    )
+
+    val fileDoesNotExist = ErrorInfo(
+        code = formatErrorCode(4),
+        message = "The file you are trying to open does not exist."
+    )
+
+    fun urlMalformed(url: String) = if (url.isBlank()) {
+        urlEmpty
+    } else {
+        ErrorInfo(
+            code = formatErrorCode(5),
+            message = "The URL you are trying to open is malformed - $url"
+        )
+    }
+
+    fun filePathInvalid(path: String?) = if (path.isNullOrBlank()) {
+        filePathEmpty
+    } else {
+        invalidParameters
+    }
+
+    val filePathEmpty = ErrorInfo(
+        code = formatErrorCode(6),
+        message = "Path of the file to open is either null or empty."
+    )
+
+    val urlEmpty = ErrorInfo(
+        code = formatErrorCode(7),
+        message = "URL to open is either null or empty."
+    )
+
+    val genericError = ErrorInfo(
+        code = formatErrorCode(8),
+        message = "Could not open the document."
+    )
+
+    val invalidParameters: ErrorInfo = ErrorInfo(
+        code = formatErrorCode(9),
+        message = "Invalid parameters."
+    )
+
+    val noAppToOpen = ErrorInfo(
+        code = formatErrorCode(10),
+        message = "There is no app to open this document."
+    )
+}
+
+fun Throwable.toFileViewerError(): FileViewerErrors.ErrorInfo = when (this) {
+    is IONFLVWException.FileDoesNotExist -> FileViewerErrors.fileDoesNotExist
+    is IONFLVWException.InvalidURL -> FileViewerErrors.urlMalformed(url)
+    is IONFLVWException.InvalidPath -> FileViewerErrors.filePathInvalid(path)
+    is IONFLVWException.EmptyURL -> FileViewerErrors.urlEmpty
+    is IONFLVWException.NoApp -> FileViewerErrors.noAppToOpen
+    else -> FileViewerErrors.genericError
+}

package/android/src/main/java/com/capacitorjs/plugins/fileviewer/FileViewerPlugin.kt

@@ -0,0 +1,96 @@
+package com.capacitorjs.plugins.fileviewer
+
+import android.app.Activity
+import com.getcapacitor.Plugin
+import com.getcapacitor.PluginCall
+import com.getcapacitor.PluginMethod
+import com.getcapacitor.annotation.CapacitorPlugin
+import io.ionic.libs.ionfileviewerlib.IONFLVWController
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.cancel
+import kotlinx.coroutines.launch
+
+@CapacitorPlugin(name = "FileViewer")
+class FileViewerPlugin : Plugin() {
+
+    private val ioScope: CoroutineScope by lazy { CoroutineScope(Dispatchers.IO) }
+    private val controller: IONFLVWController by lazy { IONFLVWController() }
+
+    override fun handleOnDestroy() {
+        super.handleOnDestroy()
+        ioScope.cancel()
+    }
+
+    @PluginMethod
+    fun openDocumentFromLocalPath(call: PluginCall) {
+        val filePath: String? = call.getString("path")
+        checkPreconditionsAndRun(call) { activity ->
+            controller.openDocumentFromLocalPath(activity, filePath ?: "")
+                .handleResult(call)
+        }
+    }
+
+    @PluginMethod
+    fun openDocumentFromResources(call: PluginCall) {
+        val resourcePath: String? = call.getString("path")
+        checkPreconditionsAndRun(call) { activity ->
+            // this method needs to be called from a non-UI thread, because it can involve I/O operations.
+            ioScope.launch {
+                controller.openDocumentFromResources(activity, assetPath = resourcePath ?: "")
+                    .handleResult(call)
+            }
+        }
+    }
+
+    @PluginMethod
+    fun openDocumentFromUrl(call: PluginCall) {
+        val url: String? = call.getString("url")
+        checkPreconditionsAndRun(call) { activity ->
+            controller.openDocumentFromUrl(activity, url ?: "")
+                .handleResult(call)
+        }
+    }
+
+    @PluginMethod
+    fun previewMediaContentFromLocalPath(call: PluginCall) = openDocumentFromLocalPath(call)
+
+    @PluginMethod
+    fun previewMediaContentFromResources(call: PluginCall) = openDocumentFromResources(call)
+
+    @PluginMethod
+    fun previewMediaContentFromUrl(call: PluginCall) = openDocumentFromUrl(call)
+
+    /**
+     * Handle a result from the native library
+     *
+     * @param call the capacitor plugin call - to notify of success or error
+     */
+    private fun Result<Unit>.handleResult(call: PluginCall) = onSuccess {
+        call.resolve()
+    }.onFailure {
+        call.sendError(it.toFileViewerError())
+    }
+
+
+    /**
+     * check if preconditions match before running the capacitor plugin method
+     *
+     * @param call the capacitor plugin call to notify of errors in case preconditions are not met
+     * @param runner callback that is run in case preconditions are met
+     */
+    private fun checkPreconditionsAndRun(call: PluginCall, runner: (Activity) -> Unit) {
+        activity?.also {
+            runner(it)
+        } ?: run {
+            call.sendError(FileViewerErrors.genericError)
+        }
+    }
+
+    /**
+     * Extension function to return a unsuccessful plugin result
+     * @param error error class representing the error to return, containing a code and message
+     */
+    private fun PluginCall.sendError(error: FileViewerErrors.ErrorInfo) =
+        this.reject(error.message, error.code)
+}

package/dist/definitions.d.ts

@@ -0,0 +1,74 @@
+export interface OpenFromLocalPathOptions {
+    /**
+     * The full absolute path to the file to open
+     * @since 1.0.0
+     */
+    path: string;
+}
+export interface OpenFromResourcesOptions {
+    /**
+     * The relative path to the resource file to open
+     * @since 1.0.0
+     */
+    path: string;
+}
+export interface OpenFromUrlOptions {
+    /**
+     * The remote url pointing to the file to open
+     * @since 1.0.0
+     */
+    url: string;
+}
+export type PreviewMediaFromLocalPathOptions = OpenFromLocalPathOptions;
+export type PreviewMediaFromResourcesOptions = OpenFromResourcesOptions;
+export type PreviewMediaFromUrlOptions = OpenFromUrlOptions;
+/**
+ * File Viewer API
+ *
+ * Only available in Native Android and iOS; not available for Web / PWAs.
+ */
+export interface FileViewerPlugin {
+    /**
+     * Open a file stored in the local file system
+     *
+     * @since 1.0.0
+     */
+    openDocumentFromLocalPath(options: OpenFromLocalPathOptions): Promise<void>;
+    /**
+     * Open an app resource file
+     *
+     * @since 1.0.0
+     */
+    openDocumentFromResources(options: OpenFromResourcesOptions): Promise<void>;
+    /**
+     * Open a file from a remote url
+     *
+     * @since 1.0.0
+     */
+    openDocumentFromUrl(options: OpenFromUrlOptions): Promise<void>;
+    /**
+     * Preview a media file (namely, video) stored in the local file system.
+     * Only implemented in iOS. Android defaults to `openDocumentFromLocalPath`.
+     *
+     * @since 1.0.0
+     */
+    previewMediaContentFromLocalPath(options: PreviewMediaFromLocalPathOptions): Promise<void>;
+    /**
+     * Preview a media file (namely, video) from the app's resources.
+     * Only implemented in iOS. Android defaults to `openDocumentFromResources`.
+     *
+     * @since 1.0.0
+     */
+    previewMediaContentFromResources(options: PreviewMediaFromResourcesOptions): Promise<void>;
+    /**
+     * Preview a media file (namely, video) from a remote url.
+     * Only implemented in iOS. Android defaults to `openDocumentFromUrl`.
+     *
+     * @since 1.0.0
+     */
+    previewMediaContentFromUrl(options: PreviewMediaFromUrlOptions): Promise<void>;
+}
+export type PluginError = {
+    code: string;
+    message: string;
+};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { FileViewerPlugin } from './definitions';
+declare const FileViewer: FileViewerPlugin;
+export * from './definitions';
+export { FileViewer };

package/dist/plugin.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("@capacitor/core");function s(e){e.CapacitorUtils.Synapse=new Proxy({},{get(a,i){return new Proxy({},{get(f,o){return(w,c,r)=>{const n=e.Capacitor.Plugins[i];if(n===void 0){r(new Error(`Capacitor plugin ${i} not found`));return}if(typeof n[o]!="function"){r(new Error(`Method ${o} not found in Capacitor plugin ${i}`));return}(async()=>{try{const t=await n[o](w);c(t)}catch(t){r(t)}})()}}})}})}function l(e){e.CapacitorUtils.Synapse=new Proxy({},{get(a,i){return e.cordova.plugins[i]}})}function d(e=!1){window.CapacitorUtils=window.CapacitorUtils||{},window.Capacitor!==void 0&&!e?s(window):window.cordova!==void 0&&l(window)}const p=u.registerPlugin("FileViewer",{web:()=>Promise.resolve().then(()=>require("./web-CLhv9W7r.cjs")).then(e=>new e.FileViewerWeb)});d();exports.FileViewer=p;

package/dist/plugin.js

@@ -0,0 +1 @@
+(function(o,i){typeof exports=="object"&&typeof module<"u"?i(exports,require("@capacitor/core")):typeof define=="function"&&define.amd?define(["exports","@capacitor/core"],i):(o=typeof globalThis<"u"?globalThis:o||self,i(o.CapacitorFileViewer={},o.capacitorExports))})(this,function(o,i){"use strict";function a(e){e.CapacitorUtils.Synapse=new Proxy({},{get(t,n){return new Proxy({},{get(b,r){return(f,P,c)=>{const p=e.Capacitor.Plugins[n];if(p===void 0){c(new Error(`Capacitor plugin ${n} not found`));return}if(typeof p[r]!="function"){c(new Error(`Method ${r} not found in Capacitor plugin ${n}`));return}(async()=>{try{const s=await p[r](f);P(s)}catch(s){c(s)}})()}}})}})}function u(e){e.CapacitorUtils.Synapse=new Proxy({},{get(t,n){return e.cordova.plugins[n]}})}function d(e=!1){window.CapacitorUtils=window.CapacitorUtils||{},window.Capacitor!==void 0&&!e?a(window):window.cordova!==void 0&&u(window)}const l=i.registerPlugin("FileViewer",{web:()=>Promise.resolve().then(()=>m).then(e=>new e.FileViewerWeb)});d();class w extends i.WebPlugin{openDocumentFromLocalPath(t){return Promise.reject("Not implemented in web")}openDocumentFromResources(t){return Promise.reject("Not implemented in web")}openDocumentFromUrl(t){return Promise.reject("Not implemented in web")}previewMediaContentFromLocalPath(t){return Promise.reject("Not implemented in web")}previewMediaContentFromResources(t){return Promise.reject("Not implemented in web")}previewMediaContentFromUrl(t){return Promise.reject("Not implemented in web")}}const m=Object.freeze(Object.defineProperty({__proto__:null,FileViewerWeb:w},Symbol.toStringTag,{value:"Module"}));o.FileViewer=l,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})});

package/dist/plugin.mjs

@@ -0,0 +1,53 @@
+import { registerPlugin as p } from "@capacitor/core";
+function u(i) {
+  i.CapacitorUtils.Synapse = new Proxy(
+    {},
+    {
+      get(a, o) {
+        return new Proxy({}, {
+          get(l, n) {
+            return (w, c, r) => {
+              const t = i.Capacitor.Plugins[o];
+              if (t === void 0) {
+                r(new Error(`Capacitor plugin ${o} not found`));
+                return;
+              }
+              if (typeof t[n] != "function") {
+                r(new Error(`Method ${n} not found in Capacitor plugin ${o}`));
+                return;
+              }
+              (async () => {
+                try {
+                  const e = await t[n](w);
+                  c(e);
+                } catch (e) {
+                  r(e);
+                }
+              })();
+            };
+          }
+        });
+      }
+    }
+  );
+}
+function s(i) {
+  i.CapacitorUtils.Synapse = new Proxy(
+    {},
+    {
+      get(a, o) {
+        return i.cordova.plugins[o];
+      }
+    }
+  );
+}
+function d(i = !1) {
+  window.CapacitorUtils = window.CapacitorUtils || {}, window.Capacitor !== void 0 && !i ? u(window) : window.cordova !== void 0 && s(window);
+}
+const g = p("FileViewer", {
+  web: () => import("./web-R-VO1Dq5.js").then((i) => new i.FileViewerWeb())
+});
+d();
+export {
+  g as FileViewer
+};

package/dist/web-CLhv9W7r.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("@capacitor/core");class t extends o.WebPlugin{openDocumentFromLocalPath(e){return Promise.reject("Not implemented in web")}openDocumentFromResources(e){return Promise.reject("Not implemented in web")}openDocumentFromUrl(e){return Promise.reject("Not implemented in web")}previewMediaContentFromLocalPath(e){return Promise.reject("Not implemented in web")}previewMediaContentFromResources(e){return Promise.reject("Not implemented in web")}previewMediaContentFromUrl(e){return Promise.reject("Not implemented in web")}}exports.FileViewerWeb=t;

package/dist/web-R-VO1Dq5.js

@@ -0,0 +1,24 @@
+import { WebPlugin as o } from "@capacitor/core";
+class n extends o {
+  openDocumentFromLocalPath(e) {
+    return Promise.reject("Not implemented in web");
+  }
+  openDocumentFromResources(e) {
+    return Promise.reject("Not implemented in web");
+  }
+  openDocumentFromUrl(e) {
+    return Promise.reject("Not implemented in web");
+  }
+  previewMediaContentFromLocalPath(e) {
+    return Promise.reject("Not implemented in web");
+  }
+  previewMediaContentFromResources(e) {
+    return Promise.reject("Not implemented in web");
+  }
+  previewMediaContentFromUrl(e) {
+    return Promise.reject("Not implemented in web");
+  }
+}
+export {
+  n as FileViewerWeb
+};

package/dist/web.d.ts

@@ -0,0 +1,10 @@
+import { WebPlugin } from '@capacitor/core';
+import { FileViewerPlugin, OpenFromLocalPathOptions, OpenFromResourcesOptions, OpenFromUrlOptions, PreviewMediaFromLocalPathOptions, PreviewMediaFromResourcesOptions, PreviewMediaFromUrlOptions } from './definitions';
+export declare class FileViewerWeb extends WebPlugin implements FileViewerPlugin {
+    openDocumentFromLocalPath(_options: OpenFromLocalPathOptions): Promise<void>;
+    openDocumentFromResources(_options: OpenFromResourcesOptions): Promise<void>;
+    openDocumentFromUrl(_options: OpenFromUrlOptions): Promise<void>;
+    previewMediaContentFromLocalPath(_options: PreviewMediaFromLocalPathOptions): Promise<void>;
+    previewMediaContentFromResources(_options: PreviewMediaFromResourcesOptions): Promise<void>;
+    previewMediaContentFromUrl(_options: PreviewMediaFromUrlOptions): Promise<void>;
+}

package/ios/Sources/FileViewerPlugin/FileViewerError.swift

@@ -0,0 +1,42 @@
+enum FileViewerError: Error {
+    case fileDoesNotExist
+    case urlMalformed(url: String)
+    case pathEmpty
+    case urlEmpty
+    case couldNotOpenDocument
+    case bridgeNotInitialised
+    case downloadFailed
+    case missingFileExtension
+
+    func toCodeMessagePair() -> (code: String, message: String) {
+        ("OS-PLUG-FLVW-\(String(format: "%04d", code))", description)
+    }
+}
+
+private extension FileViewerError {
+    var code: Int {
+        switch self {
+        case .fileDoesNotExist: 4
+        case .urlMalformed: 5
+        case .pathEmpty: 6
+        case .urlEmpty: 7
+        case .couldNotOpenDocument: 8
+        case .bridgeNotInitialised: 11
+        case .downloadFailed: 12
+        case .missingFileExtension: 13
+        }
+    }
+
+    var description: String {
+        switch self {
+        case .fileDoesNotExist: "The file you are trying to open does not exist."
+        case .urlMalformed(let url): "The URL you are trying to open is malformed - \(url)"
+        case .pathEmpty: "Path of the file to open is either null or empty."
+        case .urlEmpty: "URL to open is either null or empty."
+        case .couldNotOpenDocument: "Could not open the document."
+        case .downloadFailed: "The download failed."
+        case .missingFileExtension: "The file has no extension."
+        case .bridgeNotInitialised: "Cordova bridge isn't initialized."
+        }
+    }
+}

package/ios/Sources/FileViewerPlugin/FileViewerPlugin.swift

@@ -0,0 +1,136 @@
+import Capacitor
+import IONFileViewerLib
+import UIKit
+
+typealias FileViewerService = any IONFLVWOpenDocumentManager & IONFLVWPreviewMediaManager
+
+@objc(FileViewerPlugin)
+public class FileViewerPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "FileViewerPlugin"
+    public let jsName = "FileViewer"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "openDocumentFromLocalPath", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "openDocumentFromResources", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "openDocumentFromUrl", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "previewMediaContentFromLocalPath", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "previewMediaContentFromResources", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "previewMediaContentFromUrl", returnType: CAPPluginReturnPromise)
+    ]
+
+    private var fileViewer: FileViewerService?
+
+    override public func load() {
+        if let viewController = self.bridge?.viewController as? UIViewController {
+            fileViewer = IONFLVWManager(viewController: viewController)
+        }
+    }
+
+    func getService() -> Result<FileViewerService, FileViewerError> {
+        if fileViewer == nil { load() }
+        return fileViewer.map(Result.success) ?? .failure(.bridgeNotInitialised)
+    }
+}
+
+// MARK: - Public API Methods
+private extension FileViewerPlugin {
+    @objc func openDocumentFromLocalPath(_ call: CAPPluginCall) {
+        let filePath = call.getString("path")
+        executeOperation(call, operationRunner: { service in
+            do {
+                try service.openDocumentFromLocalPath(filePath: filePath ?? "", completion: { call.resolve() })
+            } catch {
+                self.sendError(call, self.mapError(error))
+            }
+        })
+    }
+
+    @objc func openDocumentFromResources(_ call: CAPPluginCall) {
+        let resourcePath = call.getString("path")
+        executeOperation(call, operationRunner: { service in
+            do {
+                try service.openDocumentFromResources(assetPath: resourcePath ?? "", completion: { call.resolve() })
+            } catch {
+                self.sendError(call, self.mapError(error))
+            }
+        })
+    }
+
+    @objc func openDocumentFromUrl(_ call: CAPPluginCall) {
+        let url = call.getString("url")
+        executeOperation(call, operationRunner: { service in
+            do {
+                try service.openDocumentFromUrl(url: url ?? "", completion: { err in
+                    if let error = err {
+                        self.sendError(call, self.mapError(error))
+                    } else {
+                        call.resolve()
+                    }
+                })
+            } catch {
+                self.sendError(call, self.mapError(error))
+            }
+        })
+    }
+
+    @objc func previewMediaContentFromLocalPath(_ call: CAPPluginCall) {
+        let filePath = call.getString("path")
+        executeOperation(call, operationRunner: { service in
+            do {
+                try service.previewMediaContentFromLocalPath(filePath: filePath ?? "")
+                call.resolve()
+            } catch {
+                self.sendError(call, self.mapError(error))
+            }
+        })
+    }
+
+    @objc func previewMediaContentFromResources(_ call: CAPPluginCall) {
+        let resourcePath = call.getString("path")
+        executeOperation(call, operationRunner: { service in
+            do {
+                try service.previewMediaContentFromResources(assetPath: resourcePath ?? "")
+                call.resolve()
+            } catch {
+                self.sendError(call, self.mapError(error))
+            }
+        })
+    }
+
+    @objc func previewMediaContentFromUrl(_ call: CAPPluginCall) {
+        let url = call.getString("url")
+        executeOperation(call, operationRunner: { service in
+            do {
+                try service.previewMediaContentFromUrl(url: url ?? "")
+                call.resolve()
+            } catch {
+                self.sendError(call, self.mapError(error))
+            }
+        })
+    }
+
+    func executeOperation(_ call: CAPPluginCall, operationRunner: @escaping (FileViewerService) -> Void) {
+        switch getService() {
+        case .success(let service): DispatchQueue.main.async {
+            operationRunner(service)
+        }
+        case .failure(let error): sendError(call, error)
+        }
+    }
+
+    func sendError(_ call: CAPPluginCall, _ error: FileViewerError) {
+        let errorPair = error.toCodeMessagePair()
+        call.reject(errorPair.message, errorPair.code)
+    }
+
+    func mapError(_ error: Error, url: String = "") -> FileViewerError {
+        return switch error {
+        case IONFLVWError.fileDoesNotExist: .fileDoesNotExist
+        case IONFLVWError.invalidURL: .urlMalformed(url: url)
+        case IONFLVWError.emptyFilePath: .pathEmpty
+        case IONFLVWError.invalidEmptyURL: .urlEmpty
+        case IONFLVWError.downloadFailed: .downloadFailed
+        case IONFLVWError.missingFileExtension: .missingFileExtension
+        default: .couldNotOpenDocument
+        }
+    }
+}

package/ios/Tests/FileViewerPluginTests/FileViewerPluginTests.swift

@@ -0,0 +1,15 @@
+import XCTest
+@testable import FileViewerPlugin
+
+class FileViewerTests: XCTestCase {
+    func testEcho() {
+        // This is an example of a functional test case for a plugin.
+        // Use XCTAssert and related functions to verify your tests produce the correct results.
+
+        let implementation = FileViewer()
+        let value = "Hello, World!"
+        let result = implementation.echo(value)
+
+        XCTAssertEqual(value, result)
+    }
+}

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "@capacitor/file-viewer",
+  "version": "1.0.0-dev.1",
+  "description": "The FileViewer API provides mechanisms for opening files and previewing media. Not available on web.",
+  "main": "./dist/plugin.cjs",
+  "module": "./dist/plugin.mjs",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/plugin.mjs",
+      "require": "./dist/plugin.cjs"
+    }
+  },
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Sources",
+    "ios/Tests",
+    "Package.swift",
+    "CapacitorFileViewer.podspec"
+  ],
+  "author": "Ionic",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ionic-team/capacitor-file-viewer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ionic-team/capacitor-file-viewer/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "xcodebuild -scheme CapacitorFileViewer -destination generic/platform=iOS",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint",
+    "prettier": "prettier \"src/**/*.{css,html,ts,js,java}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api FileViewerPlugin --output-readme README.md --output-json dist/docs/docs.json",
+    "build": "npm run clean && npm run docgen && vite build",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "semantic-release": "semantic-release"
+  },
+  "dependencies": {
+    "@capacitor/synapse": "^1.0.2"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^7.0.0",
+    "@capacitor/core": "^7.0.0",
+    "@capacitor/docgen": "^0.2.2",
+    "@capacitor/ios": "^7.0.0",
+    "@eslint/js": "^8.56.0",
+    "@rollup/wasm-node": "~4.19.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^10.1.2",
+    "@semantic-release/npm": "^12.0.1",
+    "@typescript-eslint/eslint-plugin": "~7.17.0",
+    "@typescript-eslint/parser": "~7.17.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "mustache": "^4.2.0",
+    "prettier": "~3.3.3",
+    "prettier-plugin-java": "~2.6.4",
+    "rimraf": "^3.0.2",
+    "semantic-release": "^24.0.0",
+    "swiftlint": "^1.0.2",
+    "typescript": "~5.4.5",
+    "vite": "^5.2.11",
+    "vite-plugin-dts": "^4.4.0"
+  },
+  "peerDependencies": {
+    "@capacitor/core": "^7.0.0"
+  },
+  "overrides": {
+    "vite": {
+      "rollup": "npm:@rollup/wasm-node"
+    }
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}