@octopus-community/react-native 1.0.7 → 1.9.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"addHasAccessToCommunityListener.d.ts","sourceRoot":"","sources":["../../../src/addHasAccessToCommunityListener.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oCAAoC,GAAG,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,+BAA+B,CAC7C,QAAQ,EAAE,oCAAoC,8CAQ/C"}

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

@@ -0,0 +1,31 @@
+import { type UrlOpeningStrategy } from './types/urlOpeningStrategy';
+export type NavigateToUrlListenerCallback = (url: string) => UrlOpeningStrategy | Promise<UrlOpeningStrategy>;
+/**
+ * Adds a listener for URL navigation events from the Octopus Community UI.
+ *
+ * Only has an effect when the UI was opened with `openUI({ interceptUrls: true })`.
+ * When the user taps a link, this callback is invoked with the URL. Return
+ * `handledByApp` if your app handles the URL (e.g. in-app web view), or
+ * `handledByOctopus` to let the SDK open it in the system browser.
+ *
+ * @param callback - Function called with the tapped URL. Can be async.
+ *   Return `UrlOpeningStrategy.handledByApp` or `UrlOpeningStrategy.handledByOctopus`.
+ * @returns A subscription object with a `remove()` method to unsubscribe.
+ *
+ * @example
+ * ```typescript
+ * const subscription = addNavigateToUrlListener(async (url) => {
+ *   if (url.startsWith('https://myapp.com/')) {
+ *     // Handle deep link in-app
+ *     Linking.openURL(url);
+ *     return UrlOpeningStrategy.handledByApp;
+ *   }
+ *   return UrlOpeningStrategy.handledByOctopus; // Open in system browser
+ * });
+ *
+ * // Later, to unsubscribe:
+ * subscription.remove();
+ * ```
+ */
+export declare function addNavigateToUrlListener(callback: NavigateToUrlListenerCallback): import("react-native").EmitterSubscription;
+//# sourceMappingURL=addNavigateToUrlListener.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addNavigateToUrlListener.d.ts","sourceRoot":"","sources":["../../../src/addNavigateToUrlListener.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,kBAAkB,EAExB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,MAAM,6BAA6B,GAAG,CAC1C,GAAG,EAAE,MAAM,KACR,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,6BAA6B,8CAcxC"}

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

@@ -0,0 +1,24 @@
+export type NotSeenNotificationsCountListenerCallback = (count: number) => void;
+/**
+ * Adds a listener for not seen notifications count changes.
+ *
+ * This listener is triggered whenever the count of unseen notifications changes.
+ * The count is automatically updated by the SDK, but can also be manually refreshed
+ * using `updateNotSeenNotificationsCount()`.
+ *
+ * @param callback - Function called when the notification count changes
+ * @returns A subscription object with a `remove()` method to unsubscribe
+ *
+ * @example
+ * ```typescript
+ * const subscription = addNotSeenNotificationsCountListener((count) => {
+ *   console.log(`Unseen notifications: ${count}`);
+ *   // Update your app's badge or UI
+ * });
+ *
+ * // Later, to unsubscribe:
+ * subscription.remove();
+ * ```
+ */
+export declare function addNotSeenNotificationsCountListener(callback: NotSeenNotificationsCountListenerCallback): import("react-native").EmitterSubscription;
+//# sourceMappingURL=addNotSeenNotificationsCountListener.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addNotSeenNotificationsCountListener.d.ts","sourceRoot":"","sources":["../../../src/addNotSeenNotificationsCountListener.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,yCAAyC,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,yCAAyC,8CAQpD"}

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

@@ -0,0 +1,43 @@
+import type { SDKEvent } from './types/sdkEvents';
+export type SDKEventListenerCallback = (event: SDKEvent) => void;
+/**
+ * Adds a listener for SDK events.
+ *
+ * This listener receives all SDK events including:
+ * - Content creation (posts, comments, replies)
+ * - Content deletion
+ * - Reactions and interactions
+ * - Gamification events
+ * - Screen navigation
+ * - Profile modifications
+ * - Session events
+ * - And more...
+ *
+ * Use TypeScript type guards to narrow down specific event types:
+ *
+ * @param callback - Function called when any SDK event occurs
+ * @returns A subscription object with a `remove()` method to unsubscribe
+ *
+ * @example
+ * ```typescript
+ * const subscription = addSDKEventListener((event) => {
+ *   switch (event.type) {
+ *     case 'postCreated':
+ *       console.log(`Post created: ${event.postId}`);
+ *       break;
+ *     case 'reactionModified':
+ *       console.log(`Reaction changed on ${event.contentId}`);
+ *       break;
+ *     case 'gamificationPointsGained':
+ *       console.log(`Gained ${event.points} points for ${event.action}`);
+ *       break;
+ *     // ... handle other event types
+ *   }
+ * });
+ *
+ * // Later, to unsubscribe:
+ * subscription.remove();
+ * ```
+ */
+export declare function addSDKEventListener(callback: SDKEventListenerCallback): import("react-native").EmitterSubscription;
+//# sourceMappingURL=addSDKEventListener.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addSDKEventListener.d.ts","sourceRoot":"","sources":["../../../src/addSDKEventListener.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,MAAM,MAAM,wBAAwB,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,wBAAwB,8CAIrE"}

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

@@ -12,19 +12,35 @@ export interface ConnectUserParams {
          */
         profilePicture?: string;
         biography?: string;
-        /**
-         * Whether the user has reached legal age.
-         * Used for age-appropriate content filtering and compliance.
-         */
-        legalAgeReached?: boolean;
     };
 }
 /**
  * Connects a user using SSO authentication.
  *
- * This function establishes a connection between your app's user and Octopus.
- * It requires that you have configured SSO mode during SDK initialization
- * and have set up a token provider using `useUserTokenProvider` or `addUserTokenRequestListener`.
+ * This function establishes a connection between your app's user and Octopus. It requires that you
+ * have configured SSO mode during SDK initialization and have set up a token provider using
+ * `useUserTokenProvider` or `addUserTokenRequestListener`. The token is obtained via your token
+ * provider; you do not pass it directly to `connectUser`. Call `connectUser` after the user logs in;
+ * call `disconnectUser` when they log out.
+ *
+ * @param params - User id and optional profile (username, profilePicture, biography). See {@link ConnectUserParams}.
+ * @returns A promise that resolves when the user is connected. Rejects if the SDK is not initialized,
+ *          SSO is not configured, or the token provider fails.
+ * @see {@link useUserTokenProvider} – provide JWT from React components.
+ * @see {@link addUserTokenRequestListener} – provide JWT without React.
+ * @see {@link disconnectUser} – disconnect the current user.
+ *
+ * @example
+ * ```typescript
+ * await connectUser({
+ *   userId: 'unique-user-id-from-your-backend',
+ *   profile: {
+ *     username: 'john_doe',
+ *     profilePicture: 'https://example.com/avatar.jpg',
+ *     biography: 'Software developer'
+ *   }
+ * });
+ * ```
  */
 export declare function connectUser(params: ConnectUserParams): Promise<void>;
 //# sourceMappingURL=connectUser.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"connectUser.d.ts","sourceRoot":"","sources":["../../../src/connectUser.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;;WAGG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpE"}
+{"version":3,"file":"connectUser.d.ts","sourceRoot":"","sources":["../../../src/connectUser.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpE"}

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

@@ -3,11 +3,24 @@ export * from './openUI';
 export * from './closeUI';
 export * from './connectUser';
 export * from './disconnectUser';
+export * from './trackCustomEvent';
+export * from './overrideDefaultLocale';
+export * from './updateNotSeenNotificationsCount';
+export * from './overrideCommunityAccess';
+export * from './trackCommunityAccess';
 export * from './addUserTokenRequestListener';
 export * from './useUserTokenProvider';
 export * from './addLoginRequiredListener';
 export * from './addEditUserListener';
+export * from './addNotSeenNotificationsCountListener';
+export * from './addHasAccessToCommunityListener';
+export * from './addSDKEventListener';
+export * from './addNavigateToUrlListener';
 export * from './types/userProfileField';
+export * from './types/sdkEvents';
+export * from './types/urlOpeningStrategy';
 export * from './logger';
 export * from './enums/LogLevel.enum';
+export { OctopusUIView } from './OctopusUIView';
+export type { OctopusUIViewProps } from './OctopusUIView';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC"}

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

@@ -89,6 +89,17 @@ export interface OctopusTheme {
         image?: ImageResolvedAssetSource;
     };
 }
+/**
+ * UI customization options for platform-specific layout adjustments.
+ */
+export interface OctopusUIOptions {
+    /**
+     * Additional bottom inset applied to the Octopus UI.
+     * - On iOS, mapped to `bottomSafeAreaInset` (points)
+     * - On Android, mapped to `contentPadding` bottom (dp)
+     */
+    bottomSafeAreaInset?: number;
+}
 /**
  * Configuration params for initializing the Octopus SDK.
  */
@@ -111,30 +122,29 @@ export interface InitializeParams {
     };
     /** Optional theme customization for the Octopus UI */
     theme?: OctopusTheme;
+    /** Optional UI customization for layout-related tweaks */
+    ui?: OctopusUIOptions;
 }
 /**
  * Initializes the Octopus SDK with the provided configuration.
  *
- * This function must be called before using any other Octopus SDK features.
- * It sets up the SDK with your API key and configures the authentication mode.
+ * This function must be called before using any other Octopus SDK features. It sets up the SDK
+ * with your API key, connection mode (SSO or Octopus-managed authentication), and optional theme
+ * and UI options. For SSO, you also need to set up a token provider with `useUserTokenProvider` or
+ * `addUserTokenRequestListener` before calling `connectUser`.
+ *
+ * @param params - See {@link InitializeParams} (including `theme`, `ui`). For theming guide see the main README.
+ * @see {@link connectUser} – connect a user after initialization (SSO mode).
  *
  * @example
  * ```typescript
- * // Initialize with SSO mode
  * await initialize({
  *   apiKey: 'your-api-key',
- *   connectionMode: {
- *     type: 'sso',
- *     appManagedFields: ['username', 'profilePicture']
- *   }
+ *   connectionMode: { type: 'sso', appManagedFields: ['username', 'profilePicture'] }
  * });
- *
- * // Initialize with Octopus authentication
  * await initialize({
  *   apiKey: 'your-api-key',
- *   connectionMode: {
- *     type: 'octopus'
- *   }
+ *   connectionMode: { type: 'octopus' }
  * });
  * ```
  */

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

@@ -1 +1 @@
-{"version":3,"file":"initialize.d.ts","sourceRoot":"","sources":["../../../src/initialize.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAG7D,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gGAAgG;IAChG,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,yFAAyF;IACzF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oEAAoE;IACpE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,oCAAoC;QACpC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,oCAAoC;QACpC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,mCAAmC;QACnC,KAAK,CAAC,EAAE,gBAAgB,CAAC;QACzB,mCAAmC;QACnC,KAAK,CAAC,EAAE,gBAAgB,CAAC;QACzB,sCAAsC;QACtC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;QAC5B,sCAAsC;QACtC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;KAC7B,CAAC;IACF;;;OAGG;IACH,YAAY,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,MAAM,CAAC,EACH,eAAe,GACf;QACE,4BAA4B;QAC5B,KAAK,EAAE,eAAe,CAAC;QACvB,2BAA2B;QAC3B,IAAI,EAAE,eAAe,CAAC;KACvB,CAAC;IACN,iCAAiC;IACjC,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,yBAAyB;IACzB,IAAI,CAAC,EAAE;QACL,0FAA0F;QAC1F,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,cAAc,EACV;QACE,6BAA6B;QAC7B,IAAI,EAAE,KAAK,CAAC;QACZ,iEAAiE;QACjE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;KACtC,GACD;QACE,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;KACjB,CAAC;IACN,sDAAsD;IACtD,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8BlE"}
+{"version":3,"file":"initialize.d.ts","sourceRoot":"","sources":["../../../src/initialize.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAG7D,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gGAAgG;IAChG,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,yFAAyF;IACzF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oEAAoE;IACpE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,oCAAoC;QACpC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,oCAAoC;QACpC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,mCAAmC;QACnC,KAAK,CAAC,EAAE,gBAAgB,CAAC;QACzB,mCAAmC;QACnC,KAAK,CAAC,EAAE,gBAAgB,CAAC;QACzB,sCAAsC;QACtC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;QAC5B,sCAAsC;QACtC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;KAC7B,CAAC;IACF;;;OAGG;IACH,YAAY,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,MAAM,CAAC,EACH,eAAe,GACf;QACE,4BAA4B;QAC5B,KAAK,EAAE,eAAe,CAAC;QACvB,2BAA2B;QAC3B,IAAI,EAAE,eAAe,CAAC;KACvB,CAAC;IACN,iCAAiC;IACjC,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,yBAAyB;IACzB,IAAI,CAAC,EAAE;QACL,0FAA0F;QAC1F,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,cAAc,EACV;QACE,6BAA6B;QAC7B,IAAI,EAAE,KAAK,CAAC;QACZ,iEAAiE;QACjE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;KACtC,GACD;QACE,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;KACjB,CAAC;IACN,sDAAsD;IACtD,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,0DAA0D;IAC1D,EAAE,CAAC,EAAE,gBAAgB,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8BlE"}

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

@@ -1,5 +1,32 @@
+/**
+ * Options for opening the Octopus UI.
+ */
+export interface OpenUIOptions {
+    /**
+     * When `true`, URLs tapped inside the community UI are not opened by the SDK.
+     * Instead, a `navigateToUrl` event is emitted. Subscribe with
+     * `addNavigateToUrlListener` to receive the URL and decide whether to handle
+     * it in-app or delegate back to the SDK (system browser).
+     *
+     * @default false
+     */
+    interceptUrls?: boolean;
+}
 /**
  * Opens the Octopus UI home screen.
+ *
+ * @param options - Optional configuration. Use `interceptUrls: true` to receive
+ *   URL taps via `addNavigateToUrlListener` instead of having the SDK open them.
+ * @returns A promise that resolves when the UI has been opened.
+ *
+ * @example
+ * ```typescript
+ * // Open UI with default behaviour (SDK opens links in system browser)
+ * await openUI();
+ *
+ * // Open UI with URL interception (app receives links via addNavigateToUrlListener)
+ * await openUI({ interceptUrls: true });
+ * ```
  */
-export declare function openUI(): Promise<void>;
+export declare function openUI(options?: OpenUIOptions): Promise<void>;
 //# sourceMappingURL=openUI.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"openUI.d.ts","sourceRoot":"","sources":["../../../src/openUI.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAEtC"}
+{"version":3,"file":"openUI.d.ts","sourceRoot":"","sources":["../../../src/openUI.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAI7D"}

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

@@ -0,0 +1,30 @@
+/**
+ * Override the community access cohort for the current user.
+ *
+ * **When to use:** When the **Octopus SDK manages the A/B logic** — i.e. Octopus assigns
+ * the cohort and decides who has access to the community. In that case, the "Has access
+ * to community" state is the cohort value. Use this function to override that cohort
+ * (e.g. for testing or feature gating). The new state is reflected via `addHasAccessToCommunityListener`.
+ *
+ * **When not to use:** If **your app** decides who has access (e.g. your own feature flag or A/B logic),
+ * do not use `overrideCommunityAccess`. Use `trackCommunityAccess` instead to report the access
+ * value to Octopus for analytics only; that does not change the actual access state in the SDK.
+ *
+ * @param hasAccess - `true` to grant access, `false` to deny access.
+ * @returns A promise that resolves when the override has been applied.
+ * @throws An error if the SDK is not initialized or the call fails.
+ * @see {@link addHasAccessToCommunityListener} – subscribe to the Octopus-managed community access state.
+ * @see {@link trackCommunityAccess} – when your app manages access, report it for analytics only (no change to SDK state).
+ *
+ * @example
+ * ```typescript
+ * const subscription = addHasAccessToCommunityListener((hasAccess) => {
+ *   console.log(`Has access to community: ${hasAccess}`);
+ * });
+ * await overrideCommunityAccess(true);
+ * await overrideCommunityAccess(false);
+ * subscription.remove();
+ * ```
+ */
+export declare function overrideCommunityAccess(hasAccess: boolean): Promise<void>;
+//# sourceMappingURL=overrideCommunityAccess.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"overrideCommunityAccess.d.ts","sourceRoot":"","sources":["../../../src/overrideCommunityAccess.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAEzE"}

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

@@ -0,0 +1,37 @@
+/**
+ * Parameters for overriding the default locale used by the Octopus SDK UI.
+ * Uses ISO 639-1 language code and optional ISO 3166-1 alpha-2 country code.
+ */
+export interface OverrideLocaleParams {
+    /** ISO 639-1 language code (e.g. `"en"`, `"fr"`). */
+    languageCode: string;
+    /** Optional ISO 3166-1 alpha-2 country code (e.g. `"US"`, `"FR"`). */
+    countryCode?: string;
+}
+/**
+ * Override the default locale used by the Octopus SDK for its UI.
+ *
+ * The change takes effect immediately for subsequently displayed SDK screens.
+ * Pass `null` to reset to the system default locale.
+ *
+ * @param locale - Object with `languageCode` and optional `countryCode`
+ *   (e.g. `{ languageCode: 'fr' }` or `{ languageCode: 'en', countryCode: 'US' }`).
+ *   Pass `null` to use the system default (no override).
+ * @returns A promise that resolves when the override has been applied.
+ * @throws An error if the SDK is not initialized or the call fails.
+ * @throws An error if locale is invalid (e.g. non-ISO language/country codes).
+ *
+ * @example
+ * ```typescript
+ * // Use French
+ * await overrideDefaultLocale({ languageCode: 'fr' });
+ *
+ * // Use English (US)
+ * await overrideDefaultLocale({ languageCode: 'en', countryCode: 'US' });
+ *
+ * // Reset to system default
+ * await overrideDefaultLocale(null);
+ * ```
+ */
+export declare function overrideDefaultLocale(locale: OverrideLocaleParams | null): Promise<void>;
+//# sourceMappingURL=overrideDefaultLocale.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"overrideDefaultLocale.d.ts","sourceRoot":"","sources":["../../../src/overrideDefaultLocale.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,qDAAqD;IACrD,YAAY,EAAE,MAAM,CAAC;IACrB,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAoCD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,oBAAoB,GAAG,IAAI,GAClC,OAAO,CAAC,IAAI,CAAC,CAaf"}

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

@@ -0,0 +1,27 @@
+/**
+ * Track community access for analytics without changing the actual access.
+ *
+ * **When to use:** When **your app manages its own A/B logic** — i.e. your app decides who can see
+ * the community (e.g. via your own feature flag or experiment). Call this to report that decision
+ * to Octopus for analytics only. It does not grant or restrict access in the SDK; it only records
+ * the value for reporting.
+ *
+ * **When not to use:** If the **Octopus SDK manages the cohort** (Octopus assigns who has access),
+ * use `overrideCommunityAccess` to change the cohort and `addHasAccessToCommunityListener` to react
+ * to it. Use `trackCommunityAccess` only when the access decision is owned by your app and you just
+ * need to report it.
+ *
+ * @param hasAccess - The access value to report (e.g. the variant your app decided).
+ * @returns A promise that resolves when the tracking call has completed.
+ * @throws An error if the SDK is not initialized or the call fails.
+ * @see {@link overrideCommunityAccess} – when Octopus manages the cohort, override it (and use addHasAccessToCommunityListener to react).
+ * @see {@link addHasAccessToCommunityListener} – subscribe to the Octopus-managed access state (relevant when Octopus or override sets it).
+ *
+ * @example
+ * ```typescript
+ * await trackCommunityAccess(true);
+ * await trackCommunityAccess(false);
+ * ```
+ */
+export declare function trackCommunityAccess(hasAccess: boolean): Promise<void>;
+//# sourceMappingURL=trackCommunityAccess.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trackCommunityAccess.d.ts","sourceRoot":"","sources":["../../../src/trackCommunityAccess.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAEtE"}

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

@@ -0,0 +1,30 @@
+/**
+ * Track custom events that are merged into Octopus analytics reports.
+ *
+ * Use this to send app-specific business events (e.g. purchases, feature usage)
+ * so they appear alongside Octopus Community analytics.
+ *
+ * All property values must be strings. Non-string values should be stringified
+ * before calling (e.g. numbers as `"123"`, booleans as `"true"`).
+ *
+ * @param name - The name of the custom event (e.g. `"purchase"`, `"screen_view"`).
+ * @param properties - Optional map of string key-value pairs attached to the event.
+ * @returns A promise that resolves when the event has been tracked.
+ * @throws An error if the SDK is not initialized or tracking fails.
+ *
+ * @example
+ * ```typescript
+ * await trackCustomEvent('purchase', {
+ *   product_id: '123',
+ *   price: '9.99',
+ *   currency: 'EUR',
+ * });
+ *
+ * await trackCustomEvent('feature_used', {
+ *   feature: 'community_search',
+ *   source: 'home_screen',
+ * });
+ * ```
+ */
+export declare function trackCustomEvent(name: string, properties?: Record<string, string>): Promise<void>;
+//# sourceMappingURL=trackCustomEvent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trackCustomEvent.d.ts","sourceRoot":"","sources":["../../../src/trackCustomEvent.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAClC,OAAO,CAAC,IAAI,CAAC,CAEf"}