@digia-engage/core 1.0.0-beta.1

package/src/NativeDigiaModule.ts

@@ -0,0 +1,86 @@
+/**
+ * NativeDigiaModule
+ *
+ * Low-level TurboModule binding to the native Digia Engage module.
+ *
+ * The module is resolved lazily on first use (not at import time) so that
+ * module evaluation before native initialisation doesn't throw.
+ * Resolution order:
+ *   1. TurboModuleRegistry.get()   — New Architecture / JSI path
+ *   2. NativeModules               — bridge interop layer (RN 0.73+ New Arch
+ *                                    with isTurboModule: false in ReactModuleInfo)
+ *   3. null                        — non-Android environments; methods no-op
+ *
+ * Prefer using the high-level `Digia` singleton from `index.ts`.
+ */
+import type { TurboModule } from 'react-native';
+import { NativeModules, TurboModuleRegistry } from 'react-native';
+
+/**
+ * Codegen spec — drives Android/iOS TurboModule generation.
+ *
+ * Rules for codegen compatibility:
+ * • File must be named `Native*.ts` (already satisfied).
+ * • All method parameter types must be scalar, Promise, Object, or Array.
+ * • `Object` maps to ReadableMap on Android, NSDictionary on iOS.
+ */
+export interface Spec extends TurboModule {
+    /** Initialise the SDK. Call once before anything else. */
+    initialize(apiKey: string, environment: string, logLevel: string): Promise<void>;
+
+    /**
+     * Wire the internal RNEventBridgePlugin with the native SDK.
+     * Called automatically by Digia.register() on first plugin registration.
+     * Never call this directly.
+     */
+    registerBridge(): void;
+
+    /** Notify the SDK of the currently visible screen. */
+    setCurrentScreen(name: string): void;
+
+    /**
+     * Forward a campaign payload from a JS CEP plugin into the native
+     * rendering engine via the DigiaCEPDelegate.
+     */
+    triggerCampaign(
+        id: string,
+        content: Object,
+        cepContext: Object,
+    ): void;
+
+    /** Invalidate / dismiss a campaign by its ID. */
+    invalidateCampaign(campaignId: string): void;
+}
+
+// Try TurboModuleRegistry first (New Architecture / JSI).
+// Fall back to NativeModules (bridge interop layer — enabled by default in
+// RN 0.73+ New Architecture when the module is registered with
+// isTurboModule: false in ReactModuleInfo).
+// If neither resolves, warn in DEV and use no-op stubs so non-Android
+// environments (web, Storybook) don't crash.
+let _resolved: Spec | null = null;
+function getModule(): Spec | null {
+    if (_resolved !== null) return _resolved;
+    _resolved =
+        TurboModuleRegistry.get<Spec>('DigiaEngageModule') ??
+        (NativeModules.DigiaEngageModule as Spec | undefined) ??
+        null;
+    if (__DEV__ && !_resolved) {
+        console.warn(
+            '[Digia] DigiaEngageModule not found.\n' +
+            'Make sure @digia/engage is linked and the app has been rebuilt.',
+        );
+    }
+    return _resolved;
+}
+
+export const nativeDigiaModule: Spec = {
+    initialize: (apiKey, environment, logLevel) =>
+        getModule()?.initialize(apiKey, environment, logLevel) ?? Promise.resolve(),
+    registerBridge: () => getModule()?.registerBridge(),
+    setCurrentScreen: (name) => getModule()?.setCurrentScreen(name),
+    triggerCampaign: (id, content, cepContext) =>
+        getModule()?.triggerCampaign(id, content, cepContext),
+    invalidateCampaign: (campaignId) => getModule()?.invalidateCampaign(campaignId),
+    getConstants: () => getModule()?.getConstants?.() ?? {},
+};

package/src/index.ts

@@ -0,0 +1,15 @@
+/**
+ * @digia/engage-react-native
+ *
+ * React Native bridge for the Digia Engage SDK.
+ *
+ * The SDK surfaces Digia Compose UI inside React Native via:
+ *   • `Digia`          – SDK lifecycle (initialize, setCurrentScreen)
+ *   • `DigiaHostView`  – Transparent native overlay view that hosts Compose dialogs/
+ *                        bottom-sheets managed by the Digia CEP engine.
+ */
+
+export { Digia } from './Digia';
+export { DigiaHostView } from './DigiaHostView';
+export { DigiaSlotView } from './DigiaSlotView';
+export type { DigiaConfig, DigiaDelegate, DigiaPlugin, InAppPayload } from './types';

package/src/types.ts

@@ -0,0 +1,61 @@
+/**
+ * Payload delivered to the Digia rendering engine for a CEP campaign.
+ *
+ * Mirrors InAppPayload on Android / Flutter.
+ */
+export interface InAppPayload {
+    /** Unique campaign ID from the CEP platform. */
+    id: string;
+    /** Marketer-authored content map (JSON-serialisable). */
+    content: Record<string, unknown>;
+    /** CEP-platform metadata, e.g. { campaignId, campaignName }. */
+    cepContext: Record<string, unknown>;
+}
+
+/**
+ * Delegate passed by the Digia SDK to each registered plugin via setup().
+ *
+ * Mirrors DigiaCEPDelegate on Android / Flutter.
+ * Call these instead of touching Digia directly from inside a plugin.
+ */
+export interface DigiaDelegate {
+    /** Deliver a campaign payload into the Digia rendering engine. */
+    onCampaignTriggered(payload: InAppPayload): void;
+    /** Invalidate / dismiss a campaign by its ID. */
+    onCampaignInvalidated(campaignId: string): void;
+}
+
+/**
+ * Interface that every Digia CEP plugin must implement.
+ *
+ * Mirrors DigiaCEPPlugin on Android / Flutter.
+ * Register plugins via `Digia.register(plugin)` — do NOT call setup() directly.
+ */
+export interface DigiaPlugin {
+    readonly identifier: string;
+    /** Called by Digia.register() — do not call manually. */
+    setup(delegate: DigiaDelegate): void;
+    /** Called by Digia.setCurrentScreen() — do not call manually. */
+    forwardScreen(name: string): void;
+    /** Called by Digia.unregister() or when tearing down the app. */
+    teardown(): void;
+}
+
+/**
+ * Configuration for initialising the Digia Engage SDK.
+ */
+export interface DigiaConfig {
+    /** The API key provided by Digia. */
+    apiKey: string;
+    /**
+     * The target environment.
+     * @default 'production'
+     */
+    environment?: 'production' | 'sandbox';
+    /**
+     * Log verbosity.
+     * @default 'error'
+     */
+    logLevel?: 'none' | 'error' | 'verbose';
+}
+