@ionic/portals-react-native 0.7.1 → 0.8.1

package/lib/typescript/src/index.d.ts

@@ -0,0 +1,159 @@
+import React from 'react';
+import { type EmitterSubscription, type ViewProps } from 'react-native';
+export declare const PortalView: (props: PortalProps) => React.JSX.Element;
+/**
+ * The data that is received from a subscription event.
+ */
+export interface Message {
+    /** The unique subscription reference received from {@link subscribe}*/
+    subscriptionRef: number;
+    data: any;
+    /** The topic the message was sent from */
+    topic: string;
+}
+/**
+ * Subscribes to messages for a topic
+ *
+ * @param topic The topic to subscribe to
+ * @param onMessageReceived The callback to invoke when a message is received
+ * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.
+ */
+export declare const subscribe: (topic: string, onMessageReceived: (message: Message) => void) => EmitterSubscription;
+/**
+ * Publishes a message to the provided topic
+ *
+ * @param topic The topic to publish the message to
+ * @param data The data to publish to subscribers
+ */
+export declare const publish: (topic: string, data: any) => void;
+export type WebVitals = {
+    firstContentfulPaint?: (duration: number) => void;
+    firstInputDelay?: (duration: number) => void;
+    timeToFirstByte?: (duration: number) => void;
+};
+/**
+ * Validates that a valid registration key has been procured from http://ionic.io/register-portals
+ * @param key The registration key
+ * @returns Promise<void>
+ */
+export declare const register: (key: string) => Promise<void>;
+/**
+ * The configuration of a web application to be embedded in a React Native application.
+ */
+export interface Portal {
+    /** The name of the Portal to be referenced. Must be **unique** */
+    name: string;
+    /** Any Capacitor plugins to be made available to the Portal */
+    plugins?: CapacitorPlugin[];
+    /**
+     * The root directory of the web application relative to Bundle.main on iOS
+     * and src/main/assets on Android. If omitted, `name` is used.
+     */
+    startDir?: string;
+    /** The name of the initial file to load. If omitted, 'index.html' is used. */
+    index?: string;
+    /** Any data needed at initial render when a portal is loaded. */
+    initialContext?: {
+        [key: string]: any;
+    };
+    assetMaps?: AssetMap[];
+    liveUpdate?: LiveUpdateConfig;
+}
+export interface CapacitorPlugin {
+    /** The classpath of the plugin to be used in Android. (e.g. com.capacitorjs.plugins.camera.CameraPlugin) */
+    androidClassPath: string;
+    /** The class name of the plugin to be used in iOS.
+     * This must be the name as it is exposed to the Objective-C runtime.
+     * For example, The CameraPlugin swift class is exposed to Objective-C as CAPCameraPlugin.
+     */
+    iosClassName: string;
+}
+export interface AssetMap {
+    /** The name to index the asset map by */
+    name: string;
+    /** Any path to match via the web. If omitted, {@link AssetMap#name} will be used. */
+    virtualPath?: string;
+    /** The root directory of the assets relative to Bundle.main on iOS
+     * and src/main/assets on Android. If omitted, the root of Bundle.main
+     * and src/main/assets will be used.
+     */
+    startDir?: string;
+}
+/**
+ * Props needed for rendering a {@link Portal}
+ */
+export type PortalProps = {
+    portal: Portal;
+    webVitals?: WebVitals;
+} & ViewProps;
+export interface LiveUpdate {
+    /** The AppFlow application ID */
+    appId: string;
+    /** The AppFlow distribution channel */
+    channel: string;
+}
+/** Data needed to register a live update to be managed */
+export type LiveUpdateConfig = LiveUpdate & {
+    syncOnAdd: boolean;
+};
+export interface LiveUpdateError {
+    /** The AppFlow application ID relating to the failure */
+    appId: string;
+    /** The step in the sync process the LiveUpdate failed on. (e.g. CHECK, UNPACK)*/
+    failStep: string;
+    /** A human readable error message */
+    message: string;
+}
+export interface Snapshot {
+    /** The snapshot id as found in AppFlow */
+    id: string;
+    /** The AppFlow build id that produced the snapshot */
+    buildId: string;
+}
+export interface SyncResult {
+    /** The {@link LiveUpdate} associated with the result  */
+    liveUpdate: LiveUpdate;
+    /** The {@link Snapshot} that was sync'd */
+    snapshot: Snapshot | null;
+    /** Whether the snapshot was downloaded or already on disk */
+    source: 'download' | 'cache';
+    /** If the active application path was changed. A `false` value would indicate
+     * the application already has the latest code for the associated {@link LiveUpdate}
+     * configuration.
+     */
+    activeApplicationPathChanged: boolean;
+}
+/** Used for communicating sync results of multiple live updates */
+export interface SyncResults {
+    results: SyncResult[];
+    errors: LiveUpdateError[];
+}
+/**
+ * Configures LiveUpdates to cyrptographically verify the contents of the downloaded bundles.
+ * This method must be called before any LiveUpdates are registered otherwise they will no longer be tracked.
+ *
+ * @param pathToKey The *relative* path to the public key for verification.
+ * This path should be the same relatibe to the main application bundle on iOS and the assets directory on Android.
+ * @returns Promise<void>
+ */
+export declare const enableSecureLiveUpdates: (pathToKey: string) => Promise<void>;
+/**
+ * Syncs a single live update.
+ *
+ * @param appId The AppFlow application ID to sync.
+ * @returns A Promise<LiveUpdate>. A failure should result in a {@link LiveUpdateError}.
+ */
+export declare const syncOne: (appId: string) => Promise<SyncResult>;
+/**
+ * Syncs many live updates.
+ *
+ * @param appIds The AppFlow application IDs to sync.
+ * @returns Promise<SyncResults>
+ */
+export declare const syncSome: (appIds: string[]) => Promise<SyncResults>;
+/**
+ * Syncs all registered LiveUpdates
+ * @returns Promise<SyncResults>
+ */
+export declare const syncAll: () => Promise<SyncResults>;
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACL,KAAK,mBAAmB,EAIxB,KAAK,SAAS,EACf,MAAM,cAAc,CAAC;AAMtB,eAAO,MAAM,UAAU,UAAW,WAAW,sBA2B5C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,uEAAuE;IACvE,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,GAAG,CAAC;IACV,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;CACf;AAID;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,UACb,MAAM,+BACgB,OAAO,KAAK,IAAI,KAC5C,mBAOF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,UAAW,MAAM,QAAQ,GAAG,SAG/C,CAAC;AA4BF,MAAM,MAAM,SAAS,GAAG;IACtB,oBAAoB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,QAAe,MAAM,KAAG,QAAQ,IAAI,CAExD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,cAAc,CAAC,EAAE;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,4GAA4G;IAC5G,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,qFAAqF;IACrF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG,SAAS,CAAC;AAEhF,MAAM,WAAW,UAAU;IACzB,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC;AAEnE,MAAM,WAAW,eAAe;IAC9B,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,iFAAiF;IACjF,QAAQ,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,yDAAyD;IACzD,UAAU,EAAE,UAAU,CAAC;IACvB,2CAA2C;IAC3C,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,6DAA6D;IAC7D,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;IAC7B;;;OAGG;IACH,4BAA4B,EAAE,OAAO,CAAC;CACvC;AAED,mEAAmE;AACnE,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,cACvB,MAAM,KAChB,QAAQ,IAAI,CAEd,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,UAAiB,MAAM,KAAG,QAAQ,UAAU,CAE/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,WAAkB,MAAM,EAAE,KAAG,QAAQ,WAAW,CAEpE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,OAAO,QAAa,QAAQ,WAAW,CAEnD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/portals-react-native",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "description": "Portals for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -57,19 +57,24 @@
   "devDependencies": {
     "@commitlint/config-conventional": "^17.0.2",
     "@evilmartians/lefthook": "^1.5.0",
-    "@react-native/eslint-config": "^0.73.1",
+    "@react-native/babel-preset": "0.75.4",
+    "@react-native/eslint-config": "0.75.4",
+    "@react-native/metro-config": "0.75.4",
+    "@react-native/typescript-config": "0.75.4",
     "@release-it/conventional-changelog": "^5.0.0",
     "@types/jest": "^29.5.5",
     "@types/react": "^18.2.44",
+    "@typescript-eslint/eslint-plugin": "latest",
     "commitlint": "^17.0.2",
     "del-cli": "^5.1.0",
     "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-jest": "^28.11.0",
+    "eslint-plugin-prettier": "^5.2.3",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",
-    "react": "18.2.0",
-    "react-native": "0.74.2",
+    "react": "18.3.1",
+    "react-native": "0.75.4",
     "react-native-builder-bob": "^0.23.2",
     "release-it": "^15.0.0",
     "turbo": "^1.10.7",
@@ -77,7 +82,8 @@
     "typescript": "^5.2.2"
   },
   "resolutions": {
-    "@types/react": "^18.2.44"
+    "@types/react": "^18.2.44",
+    "typescript": "5.2.2"
   },
   "peerDependencies": {
     "react": "*",
@@ -107,6 +113,9 @@
       "@react-native",
       "prettier"
     ],
+    "plugins": [
+      "prettier"
+    ],
     "rules": {
       "prettier/prettier": [
         "error",
@@ -115,7 +124,8 @@
           "singleQuote": true,
           "tabWidth": 2,
           "trailingComma": "es5",
-          "useTabs": false
+          "useTabs": false,
+          "endOfLine": "auto"
         }
       ]
     }
@@ -151,4 +161,4 @@
       ]
     ]
   }
-}
+}

package/ios/Podfile

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../node_modules/react-native/scripts/react_native_pods'
-require_relative '../node_modules/@react-native-community/cli-platform-ios/native_modules'
-
-platform :ios, '14.0'
-
-target 'ReactNativePortals' do
-  # Comment the next line if you don't want to use dynamic frameworks
-  config = use_native_modules!
-  use_react_native!(path: config[:reactNativePath])
-  # Pods for ReactNativePortals
-  pod 'IonicPortals', '~> 0.11.0'
-  pod 'IonicLiveUpdates', '~> 0.5.2'
-end
-
-dynamic_frameworks = ['Capacitor', 'CapacitorCordova']
-
-pre_install do |installer|
-  installer.pod_targets.each do |pod|
-    if dynamic_frameworks.include?(pod.name)
-      def pod.static_framework?
-        false
-      end
-      def pod.build_type
-        Pod::BuildType.dynamic_framework
-      end
-    end
-  end
-end
-
-post_install do |installer|
-  installer.pods_project.targets.each do |target|
-    target.build_configurations.each do |config|
-      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)',
-                                                                 '_LIBCPP_ENABLE_CXX17_REMOVED_UNARY_BINARY_FUNCTION']
-    end
-  end
-end