@dl2app/react-native 0.0.0-stage → 0.1.0

package/src/index.ts

@@ -0,0 +1,41 @@
+import { Dimensions, Linking, PixelRatio, Platform } from "react-native";
+import { requireOptionalNativeModule } from "expo-modules-core";
+import { createDL2 } from "./core";
+import type { DL2Native } from "./types";
+
+function loadNative(): DL2Native | null {
+  try {
+    return requireOptionalNativeModule<DL2Native>("DL2");
+  } catch {
+    return null;
+  }
+}
+
+const DL2 = createDL2({
+  native: loadNative(),
+  linking: Linking,
+  platform: Platform.OS,
+  screen: () => {
+    // Points (iOS) and dp (Android): the same unit as `screen.width` in the browser that clicked.
+    const s = Dimensions.get("screen");
+    return { w: Math.round(s.width), h: Math.round(s.height), dpr: PixelRatio.get() };
+  },
+  fetch: (url, init) => fetch(url, init as RequestInit),
+});
+
+export default DL2;
+export { DL2 };
+export { DL2PasteButton } from "./PasteButton";
+export type { DL2PasteButtonProps } from "./PasteButton";
+export { parseUrl, extractClipboardToken, SDK_VERSION } from "./core";
+export type {
+  DL2Config,
+  DL2CreateLinkInput,
+  DL2DebugInfo,
+  DL2Error,
+  DL2ErrorCode,
+  DL2LinkEvent,
+  DL2LinkSource,
+  DL2MatchMethod,
+  DL2TrackOptions,
+} from "./types";

package/src/types.ts

@@ -0,0 +1,117 @@
+export type DL2ErrorCode =
+  | "not_configured"
+  | "network"
+  | "timeout"
+  | "invalid_key"
+  | "app_mismatch"
+  | "link_not_found"
+  | "rate_limited"
+  | "unknown";
+
+export type DL2Error = {
+  code: DL2ErrorCode;
+  message: string;
+  cause?: unknown;
+  /** HTTP status when the error came from an API response. */
+  status?: number;
+};
+
+export type DL2LinkSource = "universal_link" | "app_link" | "uri_scheme" | "deferred";
+export type DL2MatchMethod = "install_referrer" | "fingerprint" | "clipboard";
+
+export type DL2LinkEvent = {
+  /** The URL that opened the app, or the short link that was matched. */
+  url: string | null;
+  /** Path to navigate to, for example "/invite/42". */
+  path: string;
+  /** Query parameters of the link. */
+  params: Record<string, string>;
+  /** The link's deep link data. */
+  data: Record<string, unknown>;
+  source: DL2LinkSource;
+  isFirstOpen: boolean;
+  matchMethod?: DL2MatchMethod;
+  confidence?: number;
+  linkId?: string;
+  utm?: Record<string, string>;
+};
+
+export type DL2Config = {
+  publishableKey: string;
+  /** Every host your links use: the default host, the "-alt" host and custom domains. */
+  linkDomains: string[];
+  /** Optional custom URL scheme, without "://". */
+  uriScheme?: string;
+  /** Defaults: enabled true, timeoutMs 4000, useClipboard false. */
+  deferred?: { enabled?: boolean; timeoutMs?: number; useClipboard?: boolean };
+  /** Default https://api.dl2.app */
+  apiBaseUrl?: string;
+  debug?: boolean;
+  onError?: (e: DL2Error) => void;
+};
+
+export type DL2TrackOptions = {
+  value?: number;
+  /** ISO 4217 code, for example "USD". */
+  currency?: string;
+  props?: Record<string, unknown>;
+};
+
+export type DL2CreateLinkInput = {
+  path: string;
+  data?: Record<string, unknown>;
+  og?: { title?: string; description?: string; image?: string };
+  utm?: Record<string, string>;
+};
+
+export type DL2DebugInfo = {
+  sdkVersion: string;
+  configured: boolean;
+  nativeModule: boolean;
+  installId: string | null;
+  isFirstLaunch: boolean;
+  queuedEvents: number;
+  lastOpenResponse: unknown;
+  lastResolveResponse: unknown;
+  lastError: DL2Error | null;
+};
+
+export type DL2DeviceInfo = {
+  osVersion?: string;
+  appId?: string;
+  appVersion?: string;
+  lang?: string;
+  tz?: string;
+};
+
+/** The native module (Expo Modules API). Every function is asynchronous. */
+export interface DL2Native {
+  getItem(key: string): Promise<string | null>;
+  setItem(key: string, value: string): Promise<void>;
+  removeItem(key: string): Promise<void>;
+  /** Android: Play Install Referrer string. iOS: always null. */
+  getInstallReferrer(): Promise<string | null>;
+  getDeviceInfo(): Promise<DL2DeviceInfo>;
+  uuid?(): Promise<string>;
+}
+
+export type DL2FetchResponse = { ok: boolean; status: number; json(): Promise<unknown> };
+
+/** Everything the core needs from the platform. Injected so the core runs in plain Node for tests. */
+export interface DL2Deps {
+  /** null when the native module is not linked (for example in Expo Go). */
+  native: DL2Native | null;
+  linking: {
+    getInitialURL(): Promise<string | null>;
+    addEventListener(type: "url", handler: (e: { url: string }) => void): { remove(): void } | void;
+  };
+  platform: string;
+  screen(): { w: number; h: number; dpr: number };
+  fetch(
+    url: string,
+    init: { method: string; headers: Record<string, string>; body: string; signal?: unknown },
+  ): Promise<DL2FetchResponse>;
+  sleep?(ms: number): Promise<void>;
+  now?(): number;
+  random?(): number;
+}