@ankhorage/contracts 10.0.0 → 11.0.0

package/src/navigator.ts

@@ -1,9 +1,10 @@
-import type { IconSpec } from './types';
+import type { IconSpec, ManifestValue } from './types';
 
-export const NAVIGATOR_TYPES = ['stack', 'tabs', 'drawer'] as const;
+export const NAVIGATOR_TYPES = ['slot', 'stack', 'tabs', 'drawer', 'split-view', 'custom'] as const;
 export type NavigatorType = (typeof NAVIGATOR_TYPES)[number];
 
 export const NAVIGATOR_PRESETS = [
+  'slot',
   'stack',
   'tabs',
   'tabs-stack',
@@ -17,9 +18,82 @@ export const NAVIGATOR_PRESETS = [
   'root-stack-drawer-stack',
   'root-stack-drawer-tabs',
   'root-stack-drawer-tabs-stack',
+  'split-view',
+  'custom',
 ] as const;
 export type NavigatorPreset = (typeof NAVIGATOR_PRESETS)[number];
 
+export const STACK_IMPLEMENTATIONS = ['native', 'javascript', 'experimental'] as const;
+export type StackImplementation = (typeof STACK_IMPLEMENTATIONS)[number];
+
+export const STACK_PRESENTATIONS = [
+  'card',
+  'modal',
+  'transparentModal',
+  'containedModal',
+  'containedTransparentModal',
+  'fullScreenModal',
+  'formSheet',
+] as const;
+export type StackPresentation = (typeof STACK_PRESENTATIONS)[number];
+
+export const JAVASCRIPT_STACK_PRESENTATIONS = ['card', 'modal', 'transparentModal'] as const;
+export type JavaScriptStackPresentation = (typeof JAVASCRIPT_STACK_PRESENTATIONS)[number];
+
+export interface StackHeaderOptions {
+  title?: string;
+  headerShown?: boolean;
+  headerTransparent?: boolean;
+  headerBackVisible?: boolean;
+}
+
+export type StackScreenOptions = StackHeaderOptions &
+  (
+    | {
+        presentation?: Exclude<StackPresentation, 'formSheet'>;
+        sheetAllowedDetents?: never;
+        sheetGrabberVisible?: never;
+      }
+    | {
+        presentation: 'formSheet';
+        sheetAllowedDetents?: 'fitToContents' | number[];
+        sheetGrabberVisible?: boolean;
+      }
+  );
+
+export type JavaScriptStackScreenOptions = StackHeaderOptions & {
+  presentation?: JavaScriptStackPresentation;
+};
+
+export type StackImplementationConfig =
+  | {
+      /** Omission selects the stable native stack implementation. */
+      implementation?: 'native';
+      options?: StackScreenOptions;
+    }
+  | {
+      implementation: 'javascript';
+      options?: JavaScriptStackScreenOptions;
+    }
+  | {
+      /** Expo Router Experimental Stack is alpha, native-only, and available from SDK 56. */
+      implementation: 'experimental';
+      options?: StackHeaderOptions;
+    };
+
+export const DRAWER_POSITIONS = ['left', 'right'] as const;
+export type DrawerPosition = (typeof DRAWER_POSITIONS)[number];
+
+export const DRAWER_TYPES = ['front', 'back', 'slide', 'permanent'] as const;
+export type DrawerType = (typeof DRAWER_TYPES)[number];
+
+export interface DrawerNavigatorOptions {
+  drawerPosition?: DrawerPosition;
+  drawerType?: DrawerType;
+  swipeEnabled?: boolean;
+  headerShown?: boolean;
+}
+
 export const FIXED_CUSTOM_TABS_PRESENTATIONS = ['bottom', 'top', 'rail', 'sidebar'] as const;
 export type FixedCustomTabsPresentation = (typeof FIXED_CUSTOM_TABS_PRESENTATIONS)[number];
 
@@ -33,22 +107,54 @@ export type CustomTabsPresentation = (typeof CUSTOM_TABS_PRESENTATIONS)[number];
 export const JAVASCRIPT_TABS_PRESENTATIONS = ['bottom', 'top'] as const;
 export type JavaScriptTabsPresentation = (typeof JAVASCRIPT_TABS_PRESENTATIONS)[number];
 
+export const NATIVE_TABS_MINIMIZE_BEHAVIORS = [
+  'automatic',
+  'never',
+  'onScrollDown',
+  'onScrollUp',
+] as const;
+export type NativeTabsMinimizeBehavior = (typeof NATIVE_TABS_MINIMIZE_BEHAVIORS)[number];
+
 export interface ResponsiveTabsPresentation {
   compact: FixedCustomTabsPresentation;
   medium?: FixedCustomTabsPresentation;
   expanded: FixedCustomTabsPresentation;
 }
 
-export interface CustomTabsConfig {
+export type CustomTabsPresentationConfig =
+  | {
+      presentation: FixedCustomTabsPresentation;
+      responsive?: never;
+      customPresentationId?: never;
+    }
+  | {
+      presentation: 'responsive';
+      responsive: ResponsiveTabsPresentation;
+      customPresentationId?: never;
+    }
+  | {
+      presentation: 'custom';
+      responsive?: never;
+      /** Serializable registered presentation id. */
+      customPresentationId: string;
+    };
+
+export type CustomTabsConfig = {
   implementation: 'custom';
-  presentation: CustomTabsPresentation;
-  responsive?: ResponsiveTabsPresentation;
-  /** Serializable registered presentation id used when `presentation` is `custom`. */
-  customPresentationId?: string;
+} & CustomTabsPresentationConfig;
+
+export type CustomTabsWebConfig = CustomTabsPresentationConfig;
+
+export interface NavigatorScreenReference {
+  screenId: string;
 }
 
 export interface NativeTabsConfig {
   implementation: 'native';
+  /** Expo Router Native Tabs is alpha; minimizing is available on iOS 26+ from SDK 55. */
+  minimizeBehavior?: NativeTabsMinimizeBehavior;
+  /** Registered screen rendered through NativeTabs.BottomAccessory, available from SDK 55. */
+  bottomAccessory?: NavigatorScreenReference;
 }
 
 export interface JavaScriptTabsConfig {
@@ -62,7 +168,7 @@ export interface AdaptiveTabsConfig {
   /** Android/iOS branch. Expo Router may expose this implementation as unstable. */
   native?: NativeTabsConfig;
   /** Web branch rendered through headless custom tabs. */
-  web?: Omit<CustomTabsConfig, 'implementation'>;
+  web?: CustomTabsWebConfig;
 }
 
 export type TabsImplementationConfig =
@@ -71,16 +177,19 @@ export type TabsImplementationConfig =
 interface NavigatorNodeBase {
   initialRouteName?: string;
   routes: RouteDefinition[];
-  /** Typed upstream options can be layered by the owning Navigator package. */
-  options?: Record<string, unknown>;
 }
 
-export interface StackNavigatorNode extends NavigatorNodeBase {
-  type: 'stack';
+export interface SlotNavigatorNode extends NavigatorNodeBase {
+  type: 'slot';
 }
 
+export type StackNavigatorNode = NavigatorNodeBase & {
+  type: 'stack';
+} & StackImplementationConfig;
+
 export interface DrawerNavigatorNode extends NavigatorNodeBase {
   type: 'drawer';
+  options?: DrawerNavigatorOptions;
 }
 
 export type TabsNavigatorConfig = {
@@ -89,7 +198,30 @@ export type TabsNavigatorConfig = {
 
 export type TabsNavigatorNode = NavigatorNodeBase & TabsNavigatorConfig;
 
-export type NavigatorNode = DrawerNavigatorNode | StackNavigatorNode | TabsNavigatorNode;
+export interface SplitViewNavigatorNode extends NavigatorNodeBase {
+  type: 'split-view';
+  columns: {
+    primary: NavigatorScreenReference;
+    supplementary?: NavigatorScreenReference;
+  };
+  inspector?: NavigatorScreenReference;
+  /** Split View is alpha and iOS-only; other platforms fall back to Slot. */
+  topColumnForCollapsing?: 'primary' | 'supplementary' | 'secondary';
+}
+
+export interface CustomNavigatorNode extends NavigatorNodeBase {
+  type: 'custom';
+  navigatorId: string;
+  config?: Readonly<Record<string, ManifestValue>>;
+}
+
+export type NavigatorNode =
+  | CustomNavigatorNode
+  | DrawerNavigatorNode
+  | SlotNavigatorNode
+  | SplitViewNavigatorNode
+  | StackNavigatorNode
+  | TabsNavigatorNode;
 
 export interface RouteDefinition {
   name: string;
@@ -100,6 +232,8 @@ export interface RouteDefinition {
   showInPrimaryNavigation?: boolean;
   guards?: string[];
   screenId?: string;
+  /** Presentation applied by the resolved parent stack implementation. */
+  stackOptions?: StackScreenOptions;
   navigator?: NavigatorNode;
 }
 
@@ -110,10 +244,12 @@ export interface NavigatorFlows {
 
 export interface NavigatorDefaults {
   tabs?: TabsImplementationConfig;
+  stack?: StackImplementationConfig;
 }
 
 export interface NavigatorPlatformConfig {
   tabs?: TabsImplementationConfig;
+  stack?: StackImplementationConfig;
 }
 
 export interface NavigatorPlatforms {

package/src/types.ts

@@ -8,7 +8,7 @@ import type {
 } from './bindings';
 import type { ApiDefinitionList, DataSourceRegistry } from './data';
 import type { AppDeployManifest } from './deploy';
-import type { MediaManifest } from './media';
+import type { MediaAssetReference, MediaManifest } from './media';
 import type { AppNavigatorManifest } from './navigator';
 import type { RepositoryManifest } from './repository';
 import type { ScreenRequirements } from './requirements';
@@ -222,13 +222,25 @@ export type AuthProfileCreateStrategy = (typeof AUTH_PROFILE_CREATE_STRATEGIES)[
 export const AUTH_PROFILE_UPDATE_STRATEGIES = ['api', 'app'] as const;
 export type AuthProfileUpdateStrategy = (typeof AUTH_PROFILE_UPDATE_STRATEGIES)[number];
 
-export interface IconSpec {
-  name: string;
-  provider?: string;
+interface IconPresentationSpec {
   size?: number | string;
   color?: string;
 }
 
+export interface NamedIconSpec extends IconPresentationSpec {
+  name: string;
+  provider?: string;
+  source?: never;
+}
+
+export interface SvgIconSpec extends IconPresentationSpec {
+  source: MediaAssetReference;
+  name?: never;
+  provider?: never;
+}
+
+export type IconSpec = NamedIconSpec | SvgIconSpec;
+
 export interface UiNodeRepeatSpec {
   source: BindingValueSource;
   itemAlias?: string;