kaafil-react-uikit 0.4.1 → 0.5.0

package/dist/core/index.d.cts

@@ -879,6 +879,28 @@ interface DefaultCapabilityViews {
  * required context (a missing default simply means every composite falls
  * back to its own built-in dark treatment). */
 declare function useDefaultCapabilityViews(): DefaultCapabilityViews;
+/**
+ * Turns a share token into the link a host would actually send a family.
+ *
+ * A FUNCTION, not a base-URL string, because concatenation only covers one
+ * of the shapes a real host needs. `https://crm.example/trip/<token>` is the
+ * easy case; `?share=<token>`, a token in the middle of a path, a per-locale
+ * prefix, or an encoded value are all just as ordinary, and a string forces
+ * every one of them into the kit's guess about where the token goes. The
+ * host already owns its URLs everywhere else in this package — hard rule #9,
+ * "the UIKit ships no router; navigation is `on*` callbacks" — and this is
+ * the same rule applied to the one URL the kit displays.
+ */
+type BuildShareUrl = (token: string) => string;
+/**
+ * The host's share-link builder, or `null` when it did not supply one.
+ *
+ * `null` is a real answer, not a missing provider: the share dialog falls
+ * back to showing the bare token, which is still the credential an operator
+ * can paste behind their own URL. Guessing a host's URL shape would be worse
+ * than showing the value.
+ */
+declare function useBuildShareUrl(): BuildShareUrl | null;
 interface KaafilUIKitProviderProps {
     readonly environment?: Environment;
     readonly onSessionExpired?: (credentialKind: Persona) => void;
@@ -903,6 +925,19 @@ interface KaafilUIKitProviderProps {
         readonly agency?: ConfigDocument;
     };
     readonly defaultCapabilityViews?: DefaultCapabilityViews;
+    /**
+     * Turns a share token into the link you send a family, e.g.
+     * ``(token) => `https://sharmatravels.example/trip/${token}` ``.
+     *
+     * SET THIS IF YOU USE SHARE LINKS. Kaafil returns a token, never a URL —
+     * the traveller page is on YOUR domain and the engine has no idea what it
+     * is. Without this the desk's share dialog can only show the raw token, a
+     * UUID an operator cannot meaningfully send to anyone. It is optional
+     * rather than required because a host that never mints a share link should
+     * not have to supply one, and because guessing your URL shape would be
+     * worse than showing the value you can paste behind it yourself.
+     */
+    readonly buildShareUrl?: BuildShareUrl;
     readonly children?: ReactNode;
 }
 type KaafilUIKitProviderCredentialProps = KaafilUIKitProviderCredential & KaafilUIKitProviderProps;
@@ -1273,4 +1308,4 @@ interface ThemeShellProps {
  */
 declare function ThemeShell({ theme, density, children }: ThemeShellProps): ReactNode;
 
-export { type AddTravellerNoteInput, type AgencyAdminMeReady, type AgencyAdminMeResult, type AgencyManagerProfileResult, type AgencyScopedParams, AppShell, type AppShellFamily, type AppShellFrame, type AppShellProps, type BlobStatusResult, type BlockerDeepLink, type BookingsReady, BrandShell, type BrandShellProps, CLOSEOUT_ACTION_TAB, type CapabilityStatusesResult, CapabilityTriple, type CloseoutActionKey, type CloseoutBlockerKey, type ConfigDocument, ConfigShell, type ConfigShellProps, ConflictRecord, type ConflictsResult, type CreateRegistryOptions, type DeepLinkParams, type DefaultCapabilityViews, DomainHookResult, ErrorClassification, ErrorShell, type ErrorShellClassification, type ErrorShellFallbackContext, type ErrorShellProps, type FeedbackNpsReady, type FeedbackNpsScope, HostCssCompatibilityProbe, type HostCssHazard, I18nShell, type I18nShellProps, type JourneyResult, type KaafilBrandAssets, KaafilSessionProbe, type KaafilSessionProbeProps, type KaafilTripTabKey, KaafilUIKitProvider, type KaafilUIKitProviderCredential, type KaafilUIKitProviderCredentialProps, type KaafilUIKitProviderProps, type ManagerAgencyProfileRead, type ManagersResult, NotImplementedError, type OfflineMutationConfig, type OfflineMutationResult, type OfflineMutationStatus, OfflineShell, type OfflineShellProps, type OutboxStatusOptions, type OutboxStatusResult, type Persona, type Registry, type ResolveBlockerInput, type ServerTimeApi, SessionShell, type SessionShellCredential, type SessionShellProps, type SessionState, type ShareFormAnswer, type ShareFormListItem, type ShareFormWriteInput, type ShareFormsListStatus, type ShareFormsResult, type ShareFormsWriteStatus, type ShareLinkRow, type ShareLinksResult, type ShareMeta, type ShareParams, type ShareSectionKey, type ShareSections, type ShareSnapshotOptions, type ShareSnapshotResult, type ShareSnapshotTrip, type SnapshotEntityResult, type SnapshotListResult, StalenessState, type TelemetryEvent, TelemetryShell, type TelemetryShellProps, ThemeShell, type ThemeShellProps, type TravellerFormResponseRow, type TravellerProfileRead, type TravellerProfileResult, type TreksReady, type TripManagerRow, type TripScopedParams, createRegistry, fromSearchParams, isTripTabKey, resolveBlockerDeepLink, toSearchParams, useAgencyAdminMe, useAgencyManagerProfile, useBlobStatus, useBookings, useCapabilities, useCapability, useCapabilityStatuses, useConflicts, useDefaultCapabilityViews, useFeedbackNps, useJourney, useKaafilBrand, useKaafilChrome, useKaafilShareMeta, useManagers, useOfflineEngine, useOfflineEvent, useOfflineMutation, useOutboxStatus, usePersona, useResolvedSetting, useServerTime, useSession, useShareForms, useShareLinks, useShareSnapshot, useSnapshotEntity, useSnapshotList, useStaleness, useTravellerFormResponses, useTravellerProfile, useTreks };
+export { type AddTravellerNoteInput, type AgencyAdminMeReady, type AgencyAdminMeResult, type AgencyManagerProfileResult, type AgencyScopedParams, AppShell, type AppShellFamily, type AppShellFrame, type AppShellProps, type BlobStatusResult, type BlockerDeepLink, type BookingsReady, BrandShell, type BrandShellProps, type BuildShareUrl, CLOSEOUT_ACTION_TAB, type CapabilityStatusesResult, CapabilityTriple, type CloseoutActionKey, type CloseoutBlockerKey, type ConfigDocument, ConfigShell, type ConfigShellProps, ConflictRecord, type ConflictsResult, type CreateRegistryOptions, type DeepLinkParams, type DefaultCapabilityViews, DomainHookResult, ErrorClassification, ErrorShell, type ErrorShellClassification, type ErrorShellFallbackContext, type ErrorShellProps, type FeedbackNpsReady, type FeedbackNpsScope, HostCssCompatibilityProbe, type HostCssHazard, I18nShell, type I18nShellProps, type JourneyResult, type KaafilBrandAssets, KaafilSessionProbe, type KaafilSessionProbeProps, type KaafilTripTabKey, KaafilUIKitProvider, type KaafilUIKitProviderCredential, type KaafilUIKitProviderCredentialProps, type KaafilUIKitProviderProps, type ManagerAgencyProfileRead, type ManagersResult, NotImplementedError, type OfflineMutationConfig, type OfflineMutationResult, type OfflineMutationStatus, OfflineShell, type OfflineShellProps, type OutboxStatusOptions, type OutboxStatusResult, type Persona, type Registry, type ResolveBlockerInput, type ServerTimeApi, SessionShell, type SessionShellCredential, type SessionShellProps, type SessionState, type ShareFormAnswer, type ShareFormListItem, type ShareFormWriteInput, type ShareFormsListStatus, type ShareFormsResult, type ShareFormsWriteStatus, type ShareLinkRow, type ShareLinksResult, type ShareMeta, type ShareParams, type ShareSectionKey, type ShareSections, type ShareSnapshotOptions, type ShareSnapshotResult, type ShareSnapshotTrip, type SnapshotEntityResult, type SnapshotListResult, StalenessState, type TelemetryEvent, TelemetryShell, type TelemetryShellProps, ThemeShell, type ThemeShellProps, type TravellerFormResponseRow, type TravellerProfileRead, type TravellerProfileResult, type TreksReady, type TripManagerRow, type TripScopedParams, createRegistry, fromSearchParams, isTripTabKey, resolveBlockerDeepLink, toSearchParams, useAgencyAdminMe, useAgencyManagerProfile, useBlobStatus, useBookings, useBuildShareUrl, useCapabilities, useCapability, useCapabilityStatuses, useConflicts, useDefaultCapabilityViews, useFeedbackNps, useJourney, useKaafilBrand, useKaafilChrome, useKaafilShareMeta, useManagers, useOfflineEngine, useOfflineEvent, useOfflineMutation, useOutboxStatus, usePersona, useResolvedSetting, useServerTime, useSession, useShareForms, useShareLinks, useShareSnapshot, useSnapshotEntity, useSnapshotList, useStaleness, useTravellerFormResponses, useTravellerProfile, useTreks };

package/dist/core/index.d.ts

@@ -879,6 +879,28 @@ interface DefaultCapabilityViews {
  * required context (a missing default simply means every composite falls
  * back to its own built-in dark treatment). */
 declare function useDefaultCapabilityViews(): DefaultCapabilityViews;
+/**
+ * Turns a share token into the link a host would actually send a family.
+ *
+ * A FUNCTION, not a base-URL string, because concatenation only covers one
+ * of the shapes a real host needs. `https://crm.example/trip/<token>` is the
+ * easy case; `?share=<token>`, a token in the middle of a path, a per-locale
+ * prefix, or an encoded value are all just as ordinary, and a string forces
+ * every one of them into the kit's guess about where the token goes. The
+ * host already owns its URLs everywhere else in this package — hard rule #9,
+ * "the UIKit ships no router; navigation is `on*` callbacks" — and this is
+ * the same rule applied to the one URL the kit displays.
+ */
+type BuildShareUrl = (token: string) => string;
+/**
+ * The host's share-link builder, or `null` when it did not supply one.
+ *
+ * `null` is a real answer, not a missing provider: the share dialog falls
+ * back to showing the bare token, which is still the credential an operator
+ * can paste behind their own URL. Guessing a host's URL shape would be worse
+ * than showing the value.
+ */
+declare function useBuildShareUrl(): BuildShareUrl | null;
 interface KaafilUIKitProviderProps {
     readonly environment?: Environment;
     readonly onSessionExpired?: (credentialKind: Persona) => void;
@@ -903,6 +925,19 @@ interface KaafilUIKitProviderProps {
         readonly agency?: ConfigDocument;
     };
     readonly defaultCapabilityViews?: DefaultCapabilityViews;
+    /**
+     * Turns a share token into the link you send a family, e.g.
+     * ``(token) => `https://sharmatravels.example/trip/${token}` ``.
+     *
+     * SET THIS IF YOU USE SHARE LINKS. Kaafil returns a token, never a URL —
+     * the traveller page is on YOUR domain and the engine has no idea what it
+     * is. Without this the desk's share dialog can only show the raw token, a
+     * UUID an operator cannot meaningfully send to anyone. It is optional
+     * rather than required because a host that never mints a share link should
+     * not have to supply one, and because guessing your URL shape would be
+     * worse than showing the value you can paste behind it yourself.
+     */
+    readonly buildShareUrl?: BuildShareUrl;
     readonly children?: ReactNode;
 }
 type KaafilUIKitProviderCredentialProps = KaafilUIKitProviderCredential & KaafilUIKitProviderProps;
@@ -1273,4 +1308,4 @@ interface ThemeShellProps {
  */
 declare function ThemeShell({ theme, density, children }: ThemeShellProps): ReactNode;
 
-export { type AddTravellerNoteInput, type AgencyAdminMeReady, type AgencyAdminMeResult, type AgencyManagerProfileResult, type AgencyScopedParams, AppShell, type AppShellFamily, type AppShellFrame, type AppShellProps, type BlobStatusResult, type BlockerDeepLink, type BookingsReady, BrandShell, type BrandShellProps, CLOSEOUT_ACTION_TAB, type CapabilityStatusesResult, CapabilityTriple, type CloseoutActionKey, type CloseoutBlockerKey, type ConfigDocument, ConfigShell, type ConfigShellProps, ConflictRecord, type ConflictsResult, type CreateRegistryOptions, type DeepLinkParams, type DefaultCapabilityViews, DomainHookResult, ErrorClassification, ErrorShell, type ErrorShellClassification, type ErrorShellFallbackContext, type ErrorShellProps, type FeedbackNpsReady, type FeedbackNpsScope, HostCssCompatibilityProbe, type HostCssHazard, I18nShell, type I18nShellProps, type JourneyResult, type KaafilBrandAssets, KaafilSessionProbe, type KaafilSessionProbeProps, type KaafilTripTabKey, KaafilUIKitProvider, type KaafilUIKitProviderCredential, type KaafilUIKitProviderCredentialProps, type KaafilUIKitProviderProps, type ManagerAgencyProfileRead, type ManagersResult, NotImplementedError, type OfflineMutationConfig, type OfflineMutationResult, type OfflineMutationStatus, OfflineShell, type OfflineShellProps, type OutboxStatusOptions, type OutboxStatusResult, type Persona, type Registry, type ResolveBlockerInput, type ServerTimeApi, SessionShell, type SessionShellCredential, type SessionShellProps, type SessionState, type ShareFormAnswer, type ShareFormListItem, type ShareFormWriteInput, type ShareFormsListStatus, type ShareFormsResult, type ShareFormsWriteStatus, type ShareLinkRow, type ShareLinksResult, type ShareMeta, type ShareParams, type ShareSectionKey, type ShareSections, type ShareSnapshotOptions, type ShareSnapshotResult, type ShareSnapshotTrip, type SnapshotEntityResult, type SnapshotListResult, StalenessState, type TelemetryEvent, TelemetryShell, type TelemetryShellProps, ThemeShell, type ThemeShellProps, type TravellerFormResponseRow, type TravellerProfileRead, type TravellerProfileResult, type TreksReady, type TripManagerRow, type TripScopedParams, createRegistry, fromSearchParams, isTripTabKey, resolveBlockerDeepLink, toSearchParams, useAgencyAdminMe, useAgencyManagerProfile, useBlobStatus, useBookings, useCapabilities, useCapability, useCapabilityStatuses, useConflicts, useDefaultCapabilityViews, useFeedbackNps, useJourney, useKaafilBrand, useKaafilChrome, useKaafilShareMeta, useManagers, useOfflineEngine, useOfflineEvent, useOfflineMutation, useOutboxStatus, usePersona, useResolvedSetting, useServerTime, useSession, useShareForms, useShareLinks, useShareSnapshot, useSnapshotEntity, useSnapshotList, useStaleness, useTravellerFormResponses, useTravellerProfile, useTreks };
+export { type AddTravellerNoteInput, type AgencyAdminMeReady, type AgencyAdminMeResult, type AgencyManagerProfileResult, type AgencyScopedParams, AppShell, type AppShellFamily, type AppShellFrame, type AppShellProps, type BlobStatusResult, type BlockerDeepLink, type BookingsReady, BrandShell, type BrandShellProps, type BuildShareUrl, CLOSEOUT_ACTION_TAB, type CapabilityStatusesResult, CapabilityTriple, type CloseoutActionKey, type CloseoutBlockerKey, type ConfigDocument, ConfigShell, type ConfigShellProps, ConflictRecord, type ConflictsResult, type CreateRegistryOptions, type DeepLinkParams, type DefaultCapabilityViews, DomainHookResult, ErrorClassification, ErrorShell, type ErrorShellClassification, type ErrorShellFallbackContext, type ErrorShellProps, type FeedbackNpsReady, type FeedbackNpsScope, HostCssCompatibilityProbe, type HostCssHazard, I18nShell, type I18nShellProps, type JourneyResult, type KaafilBrandAssets, KaafilSessionProbe, type KaafilSessionProbeProps, type KaafilTripTabKey, KaafilUIKitProvider, type KaafilUIKitProviderCredential, type KaafilUIKitProviderCredentialProps, type KaafilUIKitProviderProps, type ManagerAgencyProfileRead, type ManagersResult, NotImplementedError, type OfflineMutationConfig, type OfflineMutationResult, type OfflineMutationStatus, OfflineShell, type OfflineShellProps, type OutboxStatusOptions, type OutboxStatusResult, type Persona, type Registry, type ResolveBlockerInput, type ServerTimeApi, SessionShell, type SessionShellCredential, type SessionShellProps, type SessionState, type ShareFormAnswer, type ShareFormListItem, type ShareFormWriteInput, type ShareFormsListStatus, type ShareFormsResult, type ShareFormsWriteStatus, type ShareLinkRow, type ShareLinksResult, type ShareMeta, type ShareParams, type ShareSectionKey, type ShareSections, type ShareSnapshotOptions, type ShareSnapshotResult, type ShareSnapshotTrip, type SnapshotEntityResult, type SnapshotListResult, StalenessState, type TelemetryEvent, TelemetryShell, type TelemetryShellProps, ThemeShell, type ThemeShellProps, type TravellerFormResponseRow, type TravellerProfileRead, type TravellerProfileResult, type TreksReady, type TripManagerRow, type TripScopedParams, createRegistry, fromSearchParams, isTripTabKey, resolveBlockerDeepLink, toSearchParams, useAgencyAdminMe, useAgencyManagerProfile, useBlobStatus, useBookings, useBuildShareUrl, useCapabilities, useCapability, useCapabilityStatuses, useConflicts, useDefaultCapabilityViews, useFeedbackNps, useJourney, useKaafilBrand, useKaafilChrome, useKaafilShareMeta, useManagers, useOfflineEngine, useOfflineEvent, useOfflineMutation, useOutboxStatus, usePersona, useResolvedSetting, useServerTime, useSession, useShareForms, useShareLinks, useShareSnapshot, useSnapshotEntity, useSnapshotList, useStaleness, useTravellerFormResponses, useTravellerProfile, useTreks };