@ionic/portals-react-native 0.5.1 → 0.6.0

package/lib/typescript/index.d.ts

@@ -1,181 +0,0 @@
-import { EmitterSubscription, ViewProps } from 'react-native';
-export { default as PortalView } from './PortalView';
-/**
- * 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 declare const onFirstContentfulPaint: (portalName: string, callback: (duration: number) => void) => Promise<void>;
-export declare const onFirstInputDelay: (portalName: string, callback: (duration: number) => void) => Promise<void>;
-export declare const onTimeToFirstByte: (portalName: string, callback: (duration: number) => void) => Promise<void>;
-export declare const registerWebVitals: (portalName: string, firstContentfulPaint: (duration: number) => void, firstInputDelay: (duration: number) => void, timeToFirstByte: (duration: number) => void) => Promise<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;
-}
-/**
- * A subset of {@link Portal} properties needed for rendering a Portal. `initialContext` can be used to override
- * any initialContext defined in the original {@link Portal} definition.
- */
-export type PortalProp = {
-    portal: Pick<Portal, 'name' | 'initialContext'>;
-};
-/**
- * Props needed for rendering a {@link Portal}
- */
-export type PortalProps = PortalProp & ViewProps;
-/**
- * Adds a Portal to an internal registry. Must be called before attempting to render a {@link PortalView}.
- *
- * @param portal The portal to add to the internal registry.
- * @returns Promise containing the Portal that was added to the registry.
- */
-export declare const addPortal: (portal: Portal) => Promise<Portal>;
-/**
- * Adds all portals to an internal registry. This or {@link addPortal} must be called before attempting to render a {@link PortalView}
- *
- * @param portals The portals to add to the internal registry.
- * @returns Promise containing the Portals that were added to the registry.
- */
-export declare const addPortals: (portals: Portal[]) => Promise<Portal[]>;
-/**
- * Gets a {@link Portal} previously registered via {@link addPortal} or {@link addPortals}.
- *
- * @param name The portal name to retrieve from the internal registry.
- * @returns Promise containing the registered {@link Portal}. If the {@link Portal} was not registered, the Promise will fail.
- */
-export declare const getPortal: (name: string) => Promise<Portal>;
-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>;