posthog-react-native 1.1.4 → 2.0.0-alpha8

package/src/index.ts

@@ -1,5 +0,0 @@
-import { PostHog } from './posthog'
-
-export default new PostHog.Client()
-export { PostHog }
-export { Configuration, JsonMap } from './bridge'

package/src/make-pkg.ts

@@ -1,3 +0,0 @@
-import { version } from '../package.json'
-
-console.log(JSON.stringify({ version }, null, 2))

package/src/middleware.ts

@@ -1,128 +0,0 @@
-import { Context, Options, JsonMap } from './bridge'
-import { assertNever } from './utils'
-import { NativeWrapper } from './wrapper'
-
-export interface MiddlewarePayload<T extends string, D extends {}> {
-	type: T
-	data: D
-	context: Context
-	next(context?: Partial<Context>): void
-	// tslint:disable-next-line:unified-signatures
-	next(context?: Partial<Context>, data?: D): void
-}
-
-export interface CapturePayload
-	extends MiddlewarePayload<
-		'capture',
-		{
-			event: string
-			properties: JsonMap
-		}
-	> {}
-
-export interface ScreenPayload
-	extends MiddlewarePayload<
-		'screen',
-		{
-			screen: string
-			properties: JsonMap
-		}
-	> {}
-
-export interface IdentifyPayload
-	extends MiddlewarePayload<
-		'identify',
-		{
-			distinctId: string | null
-			properties: JsonMap
-		}
-	> {}
-
-export interface AliasPayload
-	extends MiddlewarePayload<
-		'alias',
-		{
-			alias: string
-		}
-	> {}
-
-export type Payload = CapturePayload | IdentifyPayload | ScreenPayload | AliasPayload
-
-export type Middleware = (payload: Payload) => void | Promise<void>
-export type PayloadFromType<T> = Extract<Payload, { type: T }>
-
-export class MiddlewareChain {
-	private readonly middlewares: Middleware[] = []
-
-	constructor(private readonly wrapper: NativeWrapper<any>) {}
-
-	public add(middleware: Middleware) {
-		this.middlewares.push(middleware)
-	}
-
-	public async run<T extends Payload['type'], P extends PayloadFromType<T>>(type: T, data: P['data']) {
-		const payload: Payload = await this.exec(type, data)
-
-		switch (payload.type) {
-			case 'alias':
-				return this.wrapper.run('alias', alias => alias(payload.data.alias))
-			case 'identify':
-				return this.wrapper.run('identify', identify => identify(payload.data.distinctId, payload.data.properties))
-			case 'screen':
-				return this.wrapper.run('screen', screen => screen(payload.data.screen, payload.data.properties))
-			case 'capture':
-				return this.wrapper.run('capture', capture => capture(payload.data.event, payload.data.properties))
-			default:
-				return assertNever(payload)
-		}
-	}
-
-	private async exec<T extends Payload['type'], P extends PayloadFromType<T>>(
-		type: T,
-		data: P['data'],
-		index = 0
-	): Promise<P> {
-		const { middlewares } = this
-		const middleware = middlewares[index]
-		const ctx = {}
-
-		if (index >= middlewares.length || !middleware) {
-			return makePayload(type, data)
-		}
-
-		let called = false
-
-		return new Promise<P>((resolve, reject) =>
-			Promise.resolve(
-				middleware.call(
-					middleware,
-					makePayload(type, data, (nextProps = data) => {
-						if (called) {
-							throw new Error('middleware.payload.next() can only be called one time')
-						}
-
-						called = true
-						this.exec(type, nextProps, index + 1)
-							.then(resolve)
-							.catch(reject)
-					})
-				)
-			).catch(reject)
-		)
-	}
-}
-
-const notImplemented = (name: string) => () => {
-	throw new Error(`.${name}() not implemented`)
-}
-
-const makePayload = <T extends Payload['type'], P extends PayloadFromType<T>>(
-	type: T,
-	data: P['data'],
-	next: (data?: P['data']) => void = notImplemented('next')
-) =>
-	({
-		data,
-		next,
-		type
-	} as P)

package/src/modules.d.ts

@@ -1,2 +0,0 @@
-declare module '*.json'
-declare module 'react-native'

package/src/posthog.ts

@@ -1,305 +0,0 @@
-import Bridge, { JsonMap } from './bridge'
-import { configure } from './configuration'
-import { Middleware, MiddlewareChain } from './middleware'
-import { ErrorHandler, NativeWrapper } from './wrapper'
-
-// prettier-ignore
-export module PostHog {
-	export interface Configuration {
-		/**
-		 * Which PostHog host to send events to.
-		 *
-		 * `https://app.posthog.com` by default
-		 */
-		host?: string
-		/**
-		 * Whether the posthog client should automatically make a screen call when a
-		 * view controller is added to a view hierarchy.
-		 * Because the iOS underlying implementation uses method swizzling,
-		 * we recommend initializing the posthog client as early as possible.
-		 * 
-		 * Disabled by default.
-		 */
-		recordScreenViews?: boolean
-		/**
-		 * Whether the posthog client should automatically capture application lifecycle events, such as
-		 * "Application Installed", "Application Updated" and "Application Opened".
-		 * 
-		 * Disabled by default.
-		 */
-		captureApplicationLifecycleEvents?: boolean
-
-		/**
-		 * Whether the posthog client should automatically capture deep links. You'll still need to call the
-		 * continueUserActivity and openURL methods on the posthog client.
-		 *
-		 * Disabled by default.
-		 */
-		captureDeepLinks?: boolean
-
-		/**
-		 * Register a set of integrations to be used with this PostHog instance.
-		 */
-		debug?: boolean
-
-		/**
-		 * The number of queued events that the posthog client should flush at.
-		 * Setting this to `1` will not queue any events and will use more battery.
-		 * 
-		 * `20` by default.
-		 */
-		flushAt?: number
-
-		/**
-		 * The amount of time to wait before each tick of the flush timer, in seconds.
-		 * Smaller values will make events delivered in a more real-time manner and also use more battery.
-		 * A value smaller than 10 seconds will seriously degrade overall performance.
-		 *
-		 * `30` seconds by default.
-		 */
-		flushInterval?: number
-
-		/**
-		 * iOS specific settings.
-		 */
-		ios?: {
-			/**
-			 * Whether the posthog client should use location services.
-			 * If `true` and the host app hasn't asked for permission to use location services then the user will be
-			 * presented with an alert view asking to do so. `false` by default. If `true`, please make sure to add a
-			 * description for `NSLocationAlwaysUsageDescription` in your `Info.plist` explaining why your app is
-			 * accessing Location APIs.
-			 *
-			 * Disabled by default.
-			 */
-			shouldUseLocationServices?: boolean
-			/**
-			 * The maximum number of items to queue before starting to drop old ones. This should be a value greater
-			 * than zero, the behaviour is undefined otherwise. `1000` by default.
-			 *
-			 * `1000` by default.
-			 */
-			maxQueueSize?: number
-			/**
-			 * Whether the posthog client should record bluetooth information. If `true`, please make sure to add a
-			 * description for `NSBluetoothPeripheralUsageDescription` in your `Info.plist` explaining explaining why
-			 * your app is accessing Bluetooth APIs. `false` by default.
-			 *
-			 * Disabled by default.
-			 */
-			shouldUseBluetooth?: boolean
-			/**
-			 * Whether the posthog client should automatically capture in-app purchases from the App Store
-			 *
-			 * Disabled by default.
-			 */
-			captureInAppPurchases?: boolean
-			/**
-			 * Whether the posthog client should automatically capture push notifications.
-			 *
-			 * Disabled by default.
-			 */
-			capturePushNotifications?: boolean
-		}
-		/**
-		 * Android specific settings.
-		 */
-		android?: {
-			/**
-			 * Whether the posthog client should client the device identifier.
-			 * The device identifier is obtained using :
-			 * - `android.provider.Settings.Secure.ANDROID_ID`
-			 * - `android.os.Build.SERIAL`
-			 * - or Telephony Identifier retrieved via TelephonyManager as available
-			 * 
-			 * Enabled by default.
-			 */
-			collectDeviceId?: boolean
-		}
-	}
-
-	export class Client {
-		/**
-		 * Whether the client is ready to send events to PostHog.
-		 *
-		 * This becomes `true` when `.setup()` succeeds.
-		 * All calls will be queued until it becomes `true`.
-		 */
-		public readonly ready = false
-
-		private readonly wrapper = new NativeWrapper(this, err =>
-			this.handleError(err)
-		)
-		private readonly handlers: ErrorHandler[] = []
-		private readonly middlewares = new MiddlewareChain(this.wrapper)
-
-		/**
-		 * Catch React-Native bridge errors
-		 *
-		 * These errors are emitted when calling the native counterpart.
-		 * This only applies to methods with no return value (`Promise<void>`),
-		 * methods like `getAnonymousId` do reject promises.
-		 */
-		public catch(handler: ErrorHandler) {
-			this.handlers.push(handler)
-
-			return this
-		}
-
-		public middleware(middleware: Middleware) {
-			this.middlewares.add(middleware)
-
-			return this
-		}
-
-		/**
-		 * Use the native configuration.
-		 * 
-		 * You'll need to call this method when you configure PostHog's singleton
-		 * using the native API.
-		 */
-		public useNativeConfiguration() {
-			if(this.ready) {
-				throw new Error('PostHog has already been configured')
-			}
-
-			this.wrapper.ready()
-
-			return this
-		}
-
-		/**
-		 * Setup the PostHog module. All calls made before are queued
-		 * and only executed if the configuration was successful.
-		 *
-		 * ```js
-		 * await posthog.setup('YOUR_API_KEY', {
-		 *   captureAppLifecycleEvents: true,
-		 *   ios: {
-		 *     capturePushNotifications: true
-		 *   }
-		 * })
-		 * ```
-		 * 
-		 * @param apiKey Your PostHog.com API key
-		 * @param configuration An optional {@link Configuration} object.
-		 */
-		public async setup(apiKey: string, configuration: Configuration = {}) {
-			await Bridge.setup(
-				await configure(apiKey, configuration)
-			)
-			this.wrapper.ready()
-		}
-
-		/**
-		 * Record the actions your users perform.
-		 *
-		 * When a user performs an action in your app, you'll want to capture that action for later analysis.
-		 * Use the event name to say what the user did, and properties to specify any interesting details of the action.
-		 *
-		 * @param event The name of the event you're capturing.
-		 * We recommend using human-readable names like `Played a Song` or `Updated Status`.
-		 * @param properties A dictionary of properties for the event.
-		 * If the event was 'Added to Shopping Cart', it might have properties like price, productType, etc.
-		 */
-		public async capture(event: string, properties: JsonMap = {}) {
-			await this.middlewares.run('capture', { event, properties })
-		}
-
-		/**
-		 * Record the screens or views your users see.
-		 *
-		 * When a user views a screen in your app, you'll want to record that here.
-		 *
-		 * @param screen The title of the screen being viewed.
-		 * We recommend using human-readable names like 'Photo Feed' or 'Completed Purchase Screen'.
-		 * @param properties A dictionary of properties for the screen view event.
-		 * If the event was 'Added to Shopping Cart', it might have properties like price, productType, etc.
-		 */
-		public async screen(screen: string, properties: JsonMap = {}) {
-			await this.middlewares.run('screen', { screen, properties })
-		}
-
-		/**
-		 * Associate a user with their unique ID and record traits about them.
-		 *
-		 * When you learn more about who your user is, you can record that information with identify.
-		 *
-		 * @param distinctId database ID (or email address) for this user.
-		 * If you don't have a userId but want to record traits, you should pass nil.
-		 * @param properties A dictionary of properties you know about the user. Things like: email, name, plan, etc.
-		 */
-		public async identify(distinctId: string | null, properties: JsonMap = {}) {
-			await this.middlewares.run('identify', { distinctId, properties })
-		}
-
-
-		/**
-		 * Merge two user identities, effectively connecting two sets of user data as one.
-		 *
-		 * When you learn more about who the group is, you can record that information with group.
-		 *
-		 * @param alias The existing ID you want to link to the current distinct ID.
-		 */
-		public async alias(alias: string) {
-			await this.middlewares.run('alias', { alias })
-		}
-
-		/**
-		 * Reset any user state that is cached on the device.
-		 *
-		 * This is useful when a user logs out and you want to clear the identity.
-		 * It will clear any traits or userId's cached on the device.
-		 */
-		public async reset() {
-			await this.wrapper.run('reset', reset => reset())
-		}
-
-		/**
-		 * Trigger an upload of all queued events.
-		 *
-		 * This is useful when you want to force all messages queued on the device to be uploaded.
-		 * Please note that not all integrations respond to this method.
-		 */
-		public async flush() {
-			await this.wrapper.run('flush', flush => flush())
-		}
-
-		/**
-		 * Enable the sending of posthog data. Enabled by default.
-		 *
-		 * Occasionally used in conjunction with disable user opt-out handling.
-		 */
-		public async enable() {
-			await this.wrapper.run('enable', enable => enable())
-		}
-
-		/**
-		 * Completely disable the sending of any posthog data.
-		 *
-		 * If you have a way for users to actively or passively (sometimes based on location) opt-out of
-		 * posthog data collection, you can use this method to turn off all data collection.
-		 */
-		public async disable() {
-			await this.wrapper.run('disable', disable => disable())
-		}
-
-		/** Retrieve the anonymousId. */
-		public async getAnonymousId(): Promise<string> {
-			await this.wrapper.wait()
-
-			return Bridge.getAnonymousId()
-		}
-
-		private handleError(error: Error) {
-			const { handlers } = this
-
-			if (!handlers.length) {
-				console.error('Uncaught PostHog error', error)
-				throw error
-			} else {
-				handlers.forEach(handler => handler(error))
-			}
-		}
-	}
-}

package/src/utils.ts

@@ -1,3 +0,0 @@
-export function assertNever(never: never) {
-	throw new Error('Expected never, got ' + never)
-}

package/src/wrapper.ts

@@ -1,61 +0,0 @@
-import bridge, { Bridge } from './bridge'
-
-export interface NativeDelegate {
-	ready: boolean
-}
-export type ErrorHandler = (err: Error) => void
-
-export class NativeWrapper<T extends NativeDelegate> {
-	constructor(
-		private readonly delegate: T,
-		private readonly handler: ErrorHandler,
-		private readonly queue: Array<() => void> = []
-	) {}
-
-	/**
-	 * Run a bridge method.
-	 * It first waits for `.setup()` or `.useNativeConfiguration()` to be
-	 * called and redirects exceptions to `handler`.
-	 * @param method Name of the method to call.
-	 * @param caller Function with the bridge function as first argument.
-	 */
-	public async run<M extends keyof Bridge>(
-		method: M,
-		caller: (fn: Bridge[M]) => Promise<void>
-	) {
-		const { delegate, handler, queue } = this
-
-		if (delegate.ready) {
-			await run()
-		} else {
-			queue.push(run)
-		}
-
-		async function run() {
-			try {
-				await caller(bridge[method])
-			} catch (err) {
-				return handler(err)
-			}
-		}
-	}
-
-	/** Waits for `.setup()` or `.useNativeConfiguration()` to be called. */
-	public async wait() {
-		if (this.delegate.ready) {
-			return
-		}
-
-		return new Promise(resolve => this.queue.push(resolve))
-	}
-
-	public ready() {
-		const { delegate, queue } = this
-
-		delegate.ready = true
-
-		while (queue.length) {
-			queue.shift()!()
-		}
-	}
-}