@btfuse/core/lib/FusePlugin.d.ts

A native-first framework for building hybdrid web-native applications

import { AbstractFuseAPIFactory } from "./AbstractFuseAPIFactory";
import { FuseAPI } from "./FuseAPI";
import { TFuseAPICallbackHandler } from './FuseCallbackManager';
import { FuseContext } from "./FuseContext";
import { FuseAPIResponse } from './FuseAPIResponse';
import { Platform } from "./Platform";
import { ContentType } from "./ContentType";
import { TSerializable } from "./TSerializable";
import { FuseSerializer } from "./FuseSerializer";
export type TAPIBridgeFunction<TContentType extends ContentType = ContentType, TData extends TSerializable = TSerializable> = (type?: TContentType, data?: TData) => Promise<FuseAPIResponse>;
/**
 * Base class for Fuse Plugins
 */
export declare abstract class FusePlugin<TAPIOpts = unknown> {
    private $context;
    private $apiFactory;
    constructor(context: FuseContext);
    /**
     * Creates the API bridge
     * @param platform - The runtime platform
     * @returns
     */
    protected _createAPI(platform: Platform): FuseAPI;
    /**
     * @virtual
     *
     * @remarks
     *
     * Create a concrete {@link FuseAPI} factory capable of creating FuseAPI
     * instance for the current runtime.
     *
     * @returns A concrete {@link FuseAPI} Factory
     */
    protected _createAPIFactory(): AbstractFuseAPIFactory;
    /**
     *
     * @returns The concrete API factory
     */
    protected _getAPIFactory(): AbstractFuseAPIFactory;
    /**
     * TAPIOpts is a plugin generic type declaring options.
     * User may use this to declare a path on how to get a particular FuseAPI.
     *
     * This API may be overridden by subclasses to utilise the given options.
     * The default implementation is to simply return a standard FuseAPI.
     *
     * @param opts - API options
     * @returns
     */
    protected _getAPI(opts?: TAPIOpts): FuseAPI;
    /**
     * Returns a standard FuseAPI
     * @returns
     */
    private $getAPI;
    /**
     * Creates a callback context that can be passed to native
     * The native code can use the callbackID to callback to the JS code.
     *
     * The callback can be used several times.
     *
     * Release the callback using _releaseCallback with the given callbackID.
     * These API usages should be part of your plugin API. When releasing a callback,
     * a standard API call should be made to your plugin to tell the native side that
     * the callback is no longer usable, and it should clean up the native resources surrounding
     * the callback context.
     *
     * Note that callback data payloads only supports strings.
     *
     * @param cb - The callback function
     * @returns String - callbackID
     */
    protected _createCallback(cb: TFuseAPICallbackHandler, apiOpts?: TAPIOpts): string;
    /**
     * Releases a created callback.
     *
     * @param id - callbackID
     */
    protected _releaseCallback(id: string, apiOpts?: TAPIOpts): void;
    /**
     * Returns the FuseContext
     *
     * @returns The current context
     */
    getContext(): FuseContext;
    /**
     * @remarks
     *
     * Concrete classes should implement and return a string that uniquely represents this plugin.
     * The string must conform to URL fragment rules. It shall only contain the following characters:
     *  - Alphabetical letters
     *  - Numbers
     *  - dots and hyphens
     *
     * @virtual
     */
    protected abstract _getID(): string;
    /**
     * Returns the plugin ID
     */
    getID(): string;
    /**
     * The execution API. Concrete classes can call this to perform calls to the native side.
     *
     * The concrete class should expose public methods with type information exposed.
     *
     * @param method - The method link, this should match the endpoint defined in the native API.
     * @param contentType - the MIME type of the data you are passing in.
     * @param data - The data to pass to the native environment
     * @returns The response body from native. FuseResponseReader has some utility methods to read the data in common formats (e.g. text or JSON)
     */
    protected _exec(method: string, contentType?: string, data?: TSerializable, apiOpts?: TAPIOpts): Promise<FuseAPIResponse>;
    /**
     * @remarks
     * This is useful when you want to use an API as a callback, without exposing
     * the plugin implementation. The returned function is a bounded function.
     * When invoked, it will call on the API endpoint and returns a {@link FuseAPIResponse}
     * asynchronously.
     *
     * @sealed
     * @param route - The API end point
     * @param serializer - The serializer to use. Defaults to {@link FuseSerializer} which is a sensible serializer.
     * @returns A context-binding function that can be given to another object.
     */
    protected _createAPIBridge(route: string, serializer?: FuseSerializer): TAPIBridgeFunction;
}