feat(core): implement CapacitorCustomPlatform for 3rd party platforms

core/src/definitions-internal.ts

@@ -4,7 +4,6 @@ import type {
   PluginResultData,
   PluginResultError,
 } from './definitions';
-import type { CapacitorPlatformsInstance } from './platforms';
 
 export interface PluginHeaderMethod {
   readonly name: string;
@@ -165,9 +164,14 @@ export interface StoredCallback {
   reject?: (...args: any[]) => any;
 }
 
+export interface CapacitorCustomPlatformInstance {
+  name: string;
+  plugins: { [pluginName: string]: any };
+}
+
 export interface WindowCapacitor {
   Capacitor?: CapacitorInstance;
-  CapacitorPlatforms?: CapacitorPlatformsInstance;
+  CapacitorCustomPlatform?: CapacitorCustomPlatformInstance;
   Ionic?: {
     WebView?: {
       getServerBasePath?: any;

core/src/index.ts

@@ -10,9 +10,6 @@ export type {
   PluginResultError,
 } from './definitions';
 
-// Platforms Map
-export { CapacitorPlatforms, addPlatform, setPlatform } from './platforms';
-
 // Global APIs
 export { Capacitor, registerPlugin } from './global';
 

core/src/runtime.ts

@@ -1,10 +1,10 @@
 import type { CapacitorGlobal, PluginImplementations } from './definitions';
 import type {
+  CapacitorCustomPlatformInstance,
   CapacitorInstance,
   PluginHeader,
   WindowCapacitor,
 } from './definitions-internal';
-import type { CapacitorPlatformsInstance } from './platforms';
 import { CapacitorException, getPlatformId, ExceptionCode } from './util';
 
 export interface RegisteredPlugin {
@@ -14,19 +14,20 @@ export interface RegisteredPlugin {
 }
 
 export const createCapacitor = (win: WindowCapacitor): CapacitorInstance => {
+  const capCustomPlatform: CapacitorCustomPlatformInstance =
+    win.CapacitorCustomPlatform || null;
   const cap: CapacitorInstance = win.Capacitor || ({} as any);
   const Plugins = (cap.Plugins = cap.Plugins || ({} as any));
-  const capPlatforms: CapacitorPlatformsInstance = win.CapacitorPlatforms;
 
-  const defaultGetPlatform = () => getPlatformId(win);
-  const getPlatform =
-    capPlatforms?.currentPlatform?.getPlatform || defaultGetPlatform;
+  const getPlatform = () => {
+    return capCustomPlatform !== null
+      ? capCustomPlatform.name
+      : getPlatformId(win);
+  };
 
-  const defaultIsNativePlatform = () => getPlatformId(win) !== 'web';
-  const isNativePlatform =
-    capPlatforms?.currentPlatform?.isNativePlatform || defaultIsNativePlatform;
+  const isNativePlatform = () => getPlatformId(win) !== 'web';
 
-  const defaultIsPluginAvailable = (pluginName: string): boolean => {
+  const isPluginAvailable = (pluginName: string): boolean => {
     const plugin = registeredPlugins.get(pluginName);
 
     if (plugin?.platforms.has(getPlatform())) {
@@ -41,16 +42,9 @@ export const createCapacitor = (win: WindowCapacitor): CapacitorInstance => {
 
     return false;
   };
-  const isPluginAvailable =
-    capPlatforms?.currentPlatform?.isPluginAvailable ||
-    defaultIsPluginAvailable;
 
-  const defaultGetPluginHeader = (
-    pluginName: string,
-  ): PluginHeader | undefined =>
+  const getPluginHeader = (pluginName: string): PluginHeader | undefined =>
     cap.PluginHeaders?.find(h => h.name === pluginName);
-  const getPluginHeader =
-    capPlatforms?.currentPlatform?.getPluginHeader || defaultGetPluginHeader;
 
   const handleError = (err: Error) => win.console.error(err);
 
@@ -66,7 +60,7 @@ export const createCapacitor = (win: WindowCapacitor): CapacitorInstance => {
 
   const registeredPlugins = new Map<string, RegisteredPlugin>();
 
-  const defaultRegisterPlugin = (
+  const registerPlugin = (
     pluginName: string,
     jsImplementations: PluginImplementations = {},
   ): any => {
@@ -89,7 +83,17 @@ export const createCapacitor = (win: WindowCapacitor): CapacitorInstance => {
           typeof jsImplementations[platform] === 'function'
             ? (jsImplementation = await jsImplementations[platform]())
             : (jsImplementation = jsImplementations[platform]);
+      } else if (
+        capCustomPlatform !== null &&
+        !jsImplementation &&
+        'web' in jsImplementations
+      ) {
+        jsImplementation =
+          typeof jsImplementations['web'] === 'function'
+            ? (jsImplementation = await jsImplementations['web']())
+            : (jsImplementation = jsImplementations['web']);
       }
+      //*/
 
       return jsImplementation;
     };
@@ -222,8 +226,6 @@ export const createCapacitor = (win: WindowCapacitor): CapacitorInstance => {
 
     return proxy;
   };
-  const registerPlugin =
-    capPlatforms?.currentPlatform?.registerPlugin || defaultRegisterPlugin;
 
   // Add in convertFileSrc for web, it will already be available in native context
   if (!cap.convertFileSrc) {