@meetreeve/ui 0.9.0 → 0.10.0

package/dist/index.d.mts

@@ -641,6 +641,73 @@ interface ConnectorGrantInput {
     granteeType: ConnectorGranteeType;
     granteeId: string;
 }
+/**
+ * One credential input on the paste path (DEV-7849 / G1). Data-driven per
+ * provider exactly like the legacy cockpit modal's `fieldDefs` prop, which
+ * this shape is lifted from (src/components/connectors/dual-auth-modal.tsx)
+ * — the package renders `label`/`placeholder` generically and never knows
+ * which provider it is rendering.
+ */
+interface ConnectorCredentialField {
+    key: string;
+    label: string;
+    placeholder?: string | null;
+    /** Input type; "password" masks the value. Defaults to "text". */
+    type?: "text" | "password" | "url";
+    /** Only an explicit `false` makes a field optional. */
+    required?: boolean;
+    /** Prefilled value the form starts from (e.g. PostHog's default host);
+     *  submitted as-is when the customer doesn't change it. */
+    defaultValue?: string | null;
+}
+/** One numbered step of a setup guide; `copyable` is a literal to paste. */
+interface ConnectorGuideStep {
+    text: string;
+    copyable?: string | null;
+}
+/**
+ * A fully-rendered setup guide as the server returns it (SG-1). The backend
+ * refuses to render a guide it cannot fully ground, so this is never a
+ * partially interpolated guide — see `hasUngroundedPlaceholder` for what
+ * happens if one ever arrives anyway.
+ */
+interface ConnectorSetupGuide {
+    prerequisites: string[];
+    steps: ConnectorGuideStep[];
+    verify: string;
+    scope_note: string;
+}
+/**
+ * The result of testing a credential WITHOUT storing it (DEV-7852 / G4).
+ *
+ * `valid` is deliberately tri-state and mirrors the server's own semantics
+ * (`TestCredentialsResponse`): true/false for a provider with a live
+ * verifier, null for one that has none. null is NOT a pass — the UI says so
+ * in words rather than showing a green check it cannot justify.
+ */
+interface ConnectorCredentialTestResult {
+    valid: boolean | null;
+    /** The account the verifier resolved, shown on success. */
+    account_name?: string | null;
+    /**
+     * Why the test failed. Already redacted server-side (the repo's
+     * no-raw-error-passthrough invariant) — the picker renders it verbatim and
+     * never composes its own message out of an upstream envelope.
+     */
+    error?: string | null;
+    /**
+     * Failure reasons keyed by credential field key. For a multi-field
+     * credential bundle a bare "invalid credentials" is close to useless, so
+     * anything that can be attributed to one field is rendered on that field.
+     */
+    field_errors?: Record<string, string> | null;
+    /**
+     * What the stored credential would actually be able to do, as read back
+     * from the verifier — e.g. "reporting only, this token cannot publish".
+     * Absent when the verifier reports no permission set.
+     */
+    permissions_note?: string | null;
+}
 interface ConnectableEntry {
     slug: string;
     name: string;
@@ -676,6 +743,18 @@ interface ConnectableEntry {
     deprecated: boolean;
     /** Org-connect permission + role options for this entry (CD-4). */
     org_connect?: OrgConnectPolicy | null;
+    /**
+     * Fully-rendered setup guide for this entry, or null/absent when the
+     * server has none for it (DEV-7849 / G1). Absent is the NORMAL state
+     * while the guide registry fills in (G2/G3), never an error.
+     */
+    guide?: ConnectorSetupGuide | null;
+    /**
+     * Credential fields for the bring-your-own-credential path (DEV-7849).
+     * Absent or empty = this entry has no paste path and only the OAuth
+     * connect button renders, exactly as before.
+     */
+    credential_fields?: ConnectorCredentialField[] | null;
 }
 interface ConnectorPickerClient {
     listConnectable(opts: {
@@ -700,6 +779,21 @@ interface ConnectorPickerClient {
     listGrants?(entry: ConnectableEntry): Promise<ConnectorGrant[]>;
     grant?(entry: ConnectableEntry, input: ConnectorGrantInput): Promise<void>;
     revokeGrant?(entry: ConnectableEntry, grantId: string): Promise<void>;
+    /**
+     * Store a pasted credential (DEV-7849 / G1). Optional, same posture as the
+     * grant methods: the credential form renders only when the injected client
+     * provides this, so a pre-G1 client keeps working unchanged. Rejecting
+     * with an Error surfaces that message on the form.
+     */
+    submitCredentials?(entry: ConnectableEntry, values: Record<string, string>, opts?: {
+        kind: ConnectionKind;
+    }): Promise<void>;
+    /**
+     * Validate a credential without storing it (DEV-7852 / G4). Optional for
+     * the same reason `submitCredentials` is: a client that cannot test simply
+     * gets the G1 form with no Test action and no test gate.
+     */
+    testCredentials?(entry: ConnectableEntry, values: Record<string, string>): Promise<ConnectorCredentialTestResult>;
 }
 /**
  * Structurally identical to the app's own `DnaLens` (src/lib/dna-lens.ts) —
@@ -724,4 +818,4 @@ interface ConnectorPickerProps {
 }
 declare function ConnectorPicker({ client, purpose, lens, layout, onConnected, }: ConnectorPickerProps): react.JSX.Element | null;
 
-export { type AppRungItem, AppSidebar, type AppSidebarBrand, type AppSidebarModuleDef, type AppSidebarProps, type AppSidebarTopItem, type Brand, BrandGlyph, type BrandGlyphProps, type ConnectableCapability, type ConnectableEntry, type ConnectableTransport, type ConnectionKind, type ConnectorGrant, type ConnectorGrantInput, type ConnectorGranteeType, ConnectorPicker, type ConnectorPickerClient, type ConnectorPickerLens, type ConnectorPickerProps, type ConnectorRoleOption, type ContextOrgGroup, ContextSwitcher, type ContextSwitcherItem, type ContextSwitcherProps, type FallbackModuleDef, Flyout, type FlyoutChild, type FlyoutProps, GLYPH_CANVAS_FILL, type GroupRungItem, type HeaderNavItem, LOCKUP_GAP, LOCKUP_ROW, MARK_CAP_RATIO, MARK_WEIGHT, type OrgConnectPolicy, REEVE_ACCENT, ResponsiveHeader, type ResponsiveHeaderProps, type RungItem, type SidebarLadder, type SidebarLadderParsed, type SidebarRung, type UseLadderRungOptions, WORDMARK_WEIGHT, deriveFallbackLadder, faviconUrl, groupByOrg, reconcileLadder, resolveLadder, useLadderRung, useResponsivePlaceholder, zSidebarLadder };
+export { type AppRungItem, AppSidebar, type AppSidebarBrand, type AppSidebarModuleDef, type AppSidebarProps, type AppSidebarTopItem, type Brand, BrandGlyph, type BrandGlyphProps, type ConnectableCapability, type ConnectableEntry, type ConnectableTransport, type ConnectionKind, type ConnectorCredentialField, type ConnectorCredentialTestResult, type ConnectorGrant, type ConnectorGrantInput, type ConnectorGranteeType, type ConnectorGuideStep, ConnectorPicker, type ConnectorPickerClient, type ConnectorPickerLens, type ConnectorPickerProps, type ConnectorRoleOption, type ConnectorSetupGuide, type ContextOrgGroup, ContextSwitcher, type ContextSwitcherItem, type ContextSwitcherProps, type FallbackModuleDef, Flyout, type FlyoutChild, type FlyoutProps, GLYPH_CANVAS_FILL, type GroupRungItem, type HeaderNavItem, LOCKUP_GAP, LOCKUP_ROW, MARK_CAP_RATIO, MARK_WEIGHT, type OrgConnectPolicy, REEVE_ACCENT, ResponsiveHeader, type ResponsiveHeaderProps, type RungItem, type SidebarLadder, type SidebarLadderParsed, type SidebarRung, type UseLadderRungOptions, WORDMARK_WEIGHT, deriveFallbackLadder, faviconUrl, groupByOrg, reconcileLadder, resolveLadder, useLadderRung, useResponsivePlaceholder, zSidebarLadder };

package/dist/index.d.ts

@@ -641,6 +641,73 @@ interface ConnectorGrantInput {
     granteeType: ConnectorGranteeType;
     granteeId: string;
 }
+/**
+ * One credential input on the paste path (DEV-7849 / G1). Data-driven per
+ * provider exactly like the legacy cockpit modal's `fieldDefs` prop, which
+ * this shape is lifted from (src/components/connectors/dual-auth-modal.tsx)
+ * — the package renders `label`/`placeholder` generically and never knows
+ * which provider it is rendering.
+ */
+interface ConnectorCredentialField {
+    key: string;
+    label: string;
+    placeholder?: string | null;
+    /** Input type; "password" masks the value. Defaults to "text". */
+    type?: "text" | "password" | "url";
+    /** Only an explicit `false` makes a field optional. */
+    required?: boolean;
+    /** Prefilled value the form starts from (e.g. PostHog's default host);
+     *  submitted as-is when the customer doesn't change it. */
+    defaultValue?: string | null;
+}
+/** One numbered step of a setup guide; `copyable` is a literal to paste. */
+interface ConnectorGuideStep {
+    text: string;
+    copyable?: string | null;
+}
+/**
+ * A fully-rendered setup guide as the server returns it (SG-1). The backend
+ * refuses to render a guide it cannot fully ground, so this is never a
+ * partially interpolated guide — see `hasUngroundedPlaceholder` for what
+ * happens if one ever arrives anyway.
+ */
+interface ConnectorSetupGuide {
+    prerequisites: string[];
+    steps: ConnectorGuideStep[];
+    verify: string;
+    scope_note: string;
+}
+/**
+ * The result of testing a credential WITHOUT storing it (DEV-7852 / G4).
+ *
+ * `valid` is deliberately tri-state and mirrors the server's own semantics
+ * (`TestCredentialsResponse`): true/false for a provider with a live
+ * verifier, null for one that has none. null is NOT a pass — the UI says so
+ * in words rather than showing a green check it cannot justify.
+ */
+interface ConnectorCredentialTestResult {
+    valid: boolean | null;
+    /** The account the verifier resolved, shown on success. */
+    account_name?: string | null;
+    /**
+     * Why the test failed. Already redacted server-side (the repo's
+     * no-raw-error-passthrough invariant) — the picker renders it verbatim and
+     * never composes its own message out of an upstream envelope.
+     */
+    error?: string | null;
+    /**
+     * Failure reasons keyed by credential field key. For a multi-field
+     * credential bundle a bare "invalid credentials" is close to useless, so
+     * anything that can be attributed to one field is rendered on that field.
+     */
+    field_errors?: Record<string, string> | null;
+    /**
+     * What the stored credential would actually be able to do, as read back
+     * from the verifier — e.g. "reporting only, this token cannot publish".
+     * Absent when the verifier reports no permission set.
+     */
+    permissions_note?: string | null;
+}
 interface ConnectableEntry {
     slug: string;
     name: string;
@@ -676,6 +743,18 @@ interface ConnectableEntry {
     deprecated: boolean;
     /** Org-connect permission + role options for this entry (CD-4). */
     org_connect?: OrgConnectPolicy | null;
+    /**
+     * Fully-rendered setup guide for this entry, or null/absent when the
+     * server has none for it (DEV-7849 / G1). Absent is the NORMAL state
+     * while the guide registry fills in (G2/G3), never an error.
+     */
+    guide?: ConnectorSetupGuide | null;
+    /**
+     * Credential fields for the bring-your-own-credential path (DEV-7849).
+     * Absent or empty = this entry has no paste path and only the OAuth
+     * connect button renders, exactly as before.
+     */
+    credential_fields?: ConnectorCredentialField[] | null;
 }
 interface ConnectorPickerClient {
     listConnectable(opts: {
@@ -700,6 +779,21 @@ interface ConnectorPickerClient {
     listGrants?(entry: ConnectableEntry): Promise<ConnectorGrant[]>;
     grant?(entry: ConnectableEntry, input: ConnectorGrantInput): Promise<void>;
     revokeGrant?(entry: ConnectableEntry, grantId: string): Promise<void>;
+    /**
+     * Store a pasted credential (DEV-7849 / G1). Optional, same posture as the
+     * grant methods: the credential form renders only when the injected client
+     * provides this, so a pre-G1 client keeps working unchanged. Rejecting
+     * with an Error surfaces that message on the form.
+     */
+    submitCredentials?(entry: ConnectableEntry, values: Record<string, string>, opts?: {
+        kind: ConnectionKind;
+    }): Promise<void>;
+    /**
+     * Validate a credential without storing it (DEV-7852 / G4). Optional for
+     * the same reason `submitCredentials` is: a client that cannot test simply
+     * gets the G1 form with no Test action and no test gate.
+     */
+    testCredentials?(entry: ConnectableEntry, values: Record<string, string>): Promise<ConnectorCredentialTestResult>;
 }
 /**
  * Structurally identical to the app's own `DnaLens` (src/lib/dna-lens.ts) —
@@ -724,4 +818,4 @@ interface ConnectorPickerProps {
 }
 declare function ConnectorPicker({ client, purpose, lens, layout, onConnected, }: ConnectorPickerProps): react.JSX.Element | null;
 
-export { type AppRungItem, AppSidebar, type AppSidebarBrand, type AppSidebarModuleDef, type AppSidebarProps, type AppSidebarTopItem, type Brand, BrandGlyph, type BrandGlyphProps, type ConnectableCapability, type ConnectableEntry, type ConnectableTransport, type ConnectionKind, type ConnectorGrant, type ConnectorGrantInput, type ConnectorGranteeType, ConnectorPicker, type ConnectorPickerClient, type ConnectorPickerLens, type ConnectorPickerProps, type ConnectorRoleOption, type ContextOrgGroup, ContextSwitcher, type ContextSwitcherItem, type ContextSwitcherProps, type FallbackModuleDef, Flyout, type FlyoutChild, type FlyoutProps, GLYPH_CANVAS_FILL, type GroupRungItem, type HeaderNavItem, LOCKUP_GAP, LOCKUP_ROW, MARK_CAP_RATIO, MARK_WEIGHT, type OrgConnectPolicy, REEVE_ACCENT, ResponsiveHeader, type ResponsiveHeaderProps, type RungItem, type SidebarLadder, type SidebarLadderParsed, type SidebarRung, type UseLadderRungOptions, WORDMARK_WEIGHT, deriveFallbackLadder, faviconUrl, groupByOrg, reconcileLadder, resolveLadder, useLadderRung, useResponsivePlaceholder, zSidebarLadder };
+export { type AppRungItem, AppSidebar, type AppSidebarBrand, type AppSidebarModuleDef, type AppSidebarProps, type AppSidebarTopItem, type Brand, BrandGlyph, type BrandGlyphProps, type ConnectableCapability, type ConnectableEntry, type ConnectableTransport, type ConnectionKind, type ConnectorCredentialField, type ConnectorCredentialTestResult, type ConnectorGrant, type ConnectorGrantInput, type ConnectorGranteeType, type ConnectorGuideStep, ConnectorPicker, type ConnectorPickerClient, type ConnectorPickerLens, type ConnectorPickerProps, type ConnectorRoleOption, type ConnectorSetupGuide, type ContextOrgGroup, ContextSwitcher, type ContextSwitcherItem, type ContextSwitcherProps, type FallbackModuleDef, Flyout, type FlyoutChild, type FlyoutProps, GLYPH_CANVAS_FILL, type GroupRungItem, type HeaderNavItem, LOCKUP_GAP, LOCKUP_ROW, MARK_CAP_RATIO, MARK_WEIGHT, type OrgConnectPolicy, REEVE_ACCENT, ResponsiveHeader, type ResponsiveHeaderProps, type RungItem, type SidebarLadder, type SidebarLadderParsed, type SidebarRung, type UseLadderRungOptions, WORDMARK_WEIGHT, deriveFallbackLadder, faviconUrl, groupByOrg, reconcileLadder, resolveLadder, useLadderRung, useResponsivePlaceholder, zSidebarLadder };