@pitcher/js-api 1.27.2 → 1.28.0

package/lib/apps/canvas-builder/components/ui/DynamicContent/dynamicContent.util.d.ts

@@ -0,0 +1,36 @@
+import { CSSProperties } from 'vue';
+import { DynamicContentProps } from '../../../types/canvas';
+/**
+ * Default heading font size (px) shown in the settings control. Must match the
+ * baseline `font-size-5` class the render/preview falls back to when unset
+ * (`font-size: 1.25rem` = 20px at a 16px root). Keep in sync if that class changes.
+ */
+export declare const DEFAULT_HEADING_FONT_SIZE = 20;
+export interface HeadingFormatting {
+    heading_font_family: string;
+    heading_font_size: number;
+    heading_color: string;
+    heading_alignment: 'left' | 'center' | 'right';
+    heading_bold: boolean;
+    heading_italic: boolean;
+    heading_underline: boolean;
+}
+/**
+ * Single source of truth for the heading's default formatting — the baseline look the
+ * settings modal opens on. Consumed by the ref initializers, `hasCustomFormatting`,
+ * `clearFormatting`, and `handleSave`'s collapse-to-undefined, so they can't drift.
+ * `themeFont` is the canvas theme font (`useCanvasTheme().font`), which the unset heading
+ * inherits; `heading_font_size` mirrors the `font-size-5` fallback.
+ */
+export declare function getHeadingFormattingDefaults(themeFont: string): HeadingFormatting;
+/**
+ * Builds the inline style overrides for the Dynamic Content heading.
+ * Only properties the user has explicitly set produce a value; unset properties
+ * return `undefined` so the component's baseline classes (`font-700 font-size-5
+ * color-text`) render — preserving the look of pre-existing canvases (PIT-7015 AC9).
+ *
+ * `heading_bold` is three-state on purpose: `undefined` (legacy / never set) and
+ * `true` both fall through to the bold `font-700` class; only an explicit `false`
+ * emits `fontWeight: 'normal'` to override it.
+ */
+export declare function getHeadingStyle(data: Partial<DynamicContentProps> | undefined): CSSProperties;

package/lib/apps/canvas-builder/components/ui/DynamicContent/dynamicContent.util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/apps/canvas-builder/composables/useCanvas.d.ts

@@ -409,6 +409,13 @@ declare const componentNodesById: import('vue').ComputedRef<{
             readonly show_heading?: boolean | undefined;
             readonly heading_text?: string | undefined;
             readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+            readonly heading_font_family?: string | undefined;
+            readonly heading_font_size?: number | undefined;
+            readonly heading_color?: string | undefined;
+            readonly heading_alignment?: "left" | "center" | "right" | undefined;
+            readonly heading_bold?: boolean | undefined;
+            readonly heading_italic?: boolean | undefined;
+            readonly heading_underline?: boolean | undefined;
         } | {
             readonly filters?: readonly {
                 readonly property: string;
@@ -913,6 +920,13 @@ declare const sectionComponentNodesBySectionId: import('vue').ComputedRef<{
                 readonly show_heading?: boolean | undefined;
                 readonly heading_text?: string | undefined;
                 readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+                readonly heading_font_family?: string | undefined;
+                readonly heading_font_size?: number | undefined;
+                readonly heading_color?: string | undefined;
+                readonly heading_alignment?: "left" | "center" | "right" | undefined;
+                readonly heading_bold?: boolean | undefined;
+                readonly heading_italic?: boolean | undefined;
+                readonly heading_underline?: boolean | undefined;
             } | {
                 readonly filters?: readonly {
                     readonly property: string;
@@ -1573,6 +1587,13 @@ export default function useCanvas(): {
             readonly show_heading?: boolean | undefined;
             readonly heading_text?: string | undefined;
             readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+            readonly heading_font_family?: string | undefined;
+            readonly heading_font_size?: number | undefined;
+            readonly heading_color?: string | undefined;
+            readonly heading_alignment?: "left" | "center" | "right" | undefined;
+            readonly heading_bold?: boolean | undefined;
+            readonly heading_italic?: boolean | undefined;
+            readonly heading_underline?: boolean | undefined;
         } | {
             readonly filters?: readonly {
                 readonly property: string;
@@ -2089,6 +2110,13 @@ export default function useCanvas(): {
             readonly show_heading?: boolean | undefined;
             readonly heading_text?: string | undefined;
             readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+            readonly heading_font_family?: string | undefined;
+            readonly heading_font_size?: number | undefined;
+            readonly heading_color?: string | undefined;
+            readonly heading_alignment?: "left" | "center" | "right" | undefined;
+            readonly heading_bold?: boolean | undefined;
+            readonly heading_italic?: boolean | undefined;
+            readonly heading_underline?: boolean | undefined;
         } | {
             readonly filters?: readonly {
                 readonly property: string;
@@ -2567,6 +2595,13 @@ export default function useCanvas(): {
             show_heading?: boolean | undefined;
             heading_text?: string | undefined;
             layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+            heading_font_family?: string | undefined;
+            heading_font_size?: number | undefined;
+            heading_color?: string | undefined;
+            heading_alignment?: "left" | "center" | "right" | undefined;
+            heading_bold?: boolean | undefined;
+            heading_italic?: boolean | undefined;
+            heading_underline?: boolean | undefined;
         } | {
             filters?: {
                 property: string;
@@ -3026,6 +3061,13 @@ export default function useCanvas(): {
             show_heading?: boolean | undefined;
             heading_text?: string | undefined;
             layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+            heading_font_family?: string | undefined;
+            heading_font_size?: number | undefined;
+            heading_color?: string | undefined;
+            heading_alignment?: "left" | "center" | "right" | undefined;
+            heading_bold?: boolean | undefined;
+            heading_italic?: boolean | undefined;
+            heading_underline?: boolean | undefined;
         } | {
             filters?: {
                 property: string;
@@ -3561,6 +3603,13 @@ export default function useCanvas(): {
                 readonly show_heading?: boolean | undefined;
                 readonly heading_text?: string | undefined;
                 readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+                readonly heading_font_family?: string | undefined;
+                readonly heading_font_size?: number | undefined;
+                readonly heading_color?: string | undefined;
+                readonly heading_alignment?: "left" | "center" | "right" | undefined;
+                readonly heading_bold?: boolean | undefined;
+                readonly heading_italic?: boolean | undefined;
+                readonly heading_underline?: boolean | undefined;
             } | {
                 readonly filters?: readonly {
                     readonly property: string;
@@ -4270,6 +4319,13 @@ export default function useCanvas(): {
                     readonly show_heading?: boolean | undefined;
                     readonly heading_text?: string | undefined;
                     readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+                    readonly heading_font_family?: string | undefined;
+                    readonly heading_font_size?: number | undefined;
+                    readonly heading_color?: string | undefined;
+                    readonly heading_alignment?: "left" | "center" | "right" | undefined;
+                    readonly heading_bold?: boolean | undefined;
+                    readonly heading_italic?: boolean | undefined;
+                    readonly heading_underline?: boolean | undefined;
                 } | {
                     readonly filters?: readonly {
                         readonly property: string;
@@ -4738,6 +4794,13 @@ export default function useCanvas(): {
             show_heading?: boolean | undefined;
             heading_text?: string | undefined;
             layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+            heading_font_family?: string | undefined;
+            heading_font_size?: number | undefined;
+            heading_color?: string | undefined;
+            heading_alignment?: "left" | "center" | "right" | undefined;
+            heading_bold?: boolean | undefined;
+            heading_italic?: boolean | undefined;
+            heading_underline?: boolean | undefined;
         } | {
             filters?: {
                 property: string;

package/lib/apps/canvas-builder/composables/useCanvasBlocks.d.ts

@@ -560,6 +560,13 @@ export default function useCanvasBlocks(): {
                 readonly show_heading?: boolean | undefined;
                 readonly heading_text?: string | undefined;
                 readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+                readonly heading_font_family?: string | undefined;
+                readonly heading_font_size?: number | undefined;
+                readonly heading_color?: string | undefined;
+                readonly heading_alignment?: "left" | "center" | "right" | undefined;
+                readonly heading_bold?: boolean | undefined;
+                readonly heading_italic?: boolean | undefined;
+                readonly heading_underline?: boolean | undefined;
             } | {
                 readonly filters?: readonly {
                     readonly property: string;
@@ -1061,6 +1068,13 @@ export default function useCanvasBlocks(): {
                 readonly show_heading?: boolean | undefined;
                 readonly heading_text?: string | undefined;
                 readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+                readonly heading_font_family?: string | undefined;
+                readonly heading_font_size?: number | undefined;
+                readonly heading_color?: string | undefined;
+                readonly heading_alignment?: "left" | "center" | "right" | undefined;
+                readonly heading_bold?: boolean | undefined;
+                readonly heading_italic?: boolean | undefined;
+                readonly heading_underline?: boolean | undefined;
             } | {
                 readonly filters?: readonly {
                     readonly property: string;

package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts

@@ -366,6 +366,13 @@ export default function useCanvasHistory(): {
                 show_heading?: boolean | undefined;
                 heading_text?: string | undefined;
                 layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+                heading_font_family?: string | undefined;
+                heading_font_size?: number | undefined;
+                heading_color?: string | undefined;
+                heading_alignment?: "left" | "center" | "right" | undefined;
+                heading_bold?: boolean | undefined;
+                heading_italic?: boolean | undefined;
+                heading_underline?: boolean | undefined;
             } | {
                 filters?: {
                     property: string;
@@ -833,6 +840,13 @@ export default function useCanvasHistory(): {
                 show_heading?: boolean | undefined;
                 heading_text?: string | undefined;
                 layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
+                heading_font_family?: string | undefined;
+                heading_font_size?: number | undefined;
+                heading_color?: string | undefined;
+                heading_alignment?: "left" | "center" | "right" | undefined;
+                heading_bold?: boolean | undefined;
+                heading_italic?: boolean | undefined;
+                heading_underline?: boolean | undefined;
             } | {
                 filters?: {
                     property: string;

package/lib/apps/canvas-builder/composables/usePopupApps.d.ts

@@ -44,6 +44,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -58,6 +59,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -94,6 +96,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -108,6 +111,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -144,6 +148,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -158,6 +163,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -194,6 +200,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -208,6 +215,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -244,6 +252,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -258,6 +267,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -294,6 +304,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -308,6 +319,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -344,6 +356,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -358,6 +371,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -493,6 +507,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -507,6 +522,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -543,6 +559,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -557,6 +574,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -593,6 +611,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -607,6 +626,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -643,6 +663,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -657,6 +678,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -693,6 +715,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -707,6 +730,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -743,6 +767,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -757,6 +782,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;
@@ -793,6 +819,7 @@ export declare function usePopupApps(): {
                     enabled: boolean;
                     headless?: boolean | undefined;
                     auto_install?: boolean | undefined;
+                    course_only?: boolean | undefined;
                     entry?: string | undefined;
                     settings?: {
                         sections: {
@@ -807,6 +834,7 @@ export declare function usePopupApps(): {
                                     label: string;
                                     value: string;
                                 }[] | undefined;
+                                dynamic_options?: string | undefined;
                             }[];
                         }[];
                     } | undefined;

package/lib/apps/canvas-builder/types/canvas.d.ts

@@ -109,6 +109,13 @@ export interface DynamicContentProps {
     show_heading?: boolean;
     heading_text?: string;
     layout_type?: ContentGridLayoutTypes;
+    heading_font_family?: string;
+    heading_font_size?: number;
+    heading_color?: string;
+    heading_alignment?: 'left' | 'center' | 'right';
+    heading_bold?: boolean;
+    heading_italic?: boolean;
+    heading_underline?: boolean;
 }
 export interface CustomDataTableHierarchyLevel {
     type: 'group' | 'data';

package/lib/apps/canvas-builder/util/canvas.util.d.ts

@@ -14,6 +14,17 @@ export declare function getComponentDescription(type: ComponentTypes | string, t
     description?: string;
 }): string;
 export declare function getNodeDisplayNameByComponentType(node: ComponentNode | null | undefined): string;
+/**
+ * Resolves a component's human-readable title the same way the editor's Reorder panel does:
+ * prefer the admin-given name (`tracking_id`, via getNodeDisplayNameByComponentType), otherwise
+ * fall back to a localized component-type label. The name is trimmed first, so a whitespace-only
+ * value (e.g. a blank Text or a whitespace tracking_id) falls back to the type label instead of
+ * rendering a blank row; the `!== node.type` guard likewise prevents an un-renamed node (whose
+ * tracking_id defaults to its type string) from surfacing the raw type as its title.
+ * Shared by the editor Reorder panel and the rep "Customize your homepage" panel so the two views
+ * stay consistent by construction.
+ */
+export declare function getNodeDisplayTitle(node: ComponentNode, t: (input: string) => string): string;
 export declare function getSectionGlobalComponentSpacing(section: CanvasRetrieve['sections'][number]): string | undefined;
 export declare function discardSectionComponentOverride(sectionId: CanvasRetrieve['id'], componentId: ComponentNode['id'], overrides: SectionComponentOverrides): SectionComponentOverrides;
 export declare function addCanvasComponent(currentContent: ComponentNode[], add: {

package/lib/components/CFileViewer/pdf/CFileViewer.pdf.util.d.ts

@@ -0,0 +1,17 @@
+import { default as PSPDFKitType } from 'pspdfkit';
+/**
+ * Tear down a PSPDFKit instance for a container without ever throwing.
+ *
+ * A password-protected PDF makes PSPDFKit render its own built-in password
+ * dialog and stay mid-load (the `PSPDFKit.load()` Promise never resolves, so no
+ * instance is ever assigned). Calling `PSPDFKit.unload(container)` while the
+ * container is still loading throws — which previously propagated out of the
+ * viewer's close handler and aborted it before the host was told to close. The
+ * user was then stuck on the password prompt with no way out but a full browser
+ * refresh (neither Exit nor Esc worked).
+ *
+ * Swallowing the unload error here keeps close/unmount teardown resilient: the
+ * container is removed from the DOM by the unmount that follows, which is what
+ * actually disposes the stuck dialog.
+ */
+export declare function safePspdfkitUnload(pspdfkit: Pick<typeof PSPDFKitType, 'unload'> | undefined, container: HTMLElement | null): void;

package/lib/components/CFileViewer/pdf/CFileViewer.pdf.util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/components/CRichTextEditor/components/CTextTypeSelect.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/composables/useCourseOnlyApps.d.ts

@@ -0,0 +1,11 @@
+import { AppFile } from '../types/app';
+/**
+ * Course-only apps (`module.canvas.course_only`, e.g. the L&D assessment-canvas wrap, PIT-6978) are
+ * offered in the Add-Component / Embeddable pickers ONLY where the host opts in via
+ * `provide('allowCourseOnlyApps', true)` — course-canvas-host does; normal sales / DSR canvases don't.
+ * Shared by AddComponentModal + Embeddable.settings so the two filters can't drift.
+ */
+export declare function useCourseOnlyApps(): {
+    allowCourseOnlyApps: boolean;
+    isAppAllowed: (app: AppFile) => boolean;
+};

package/lib/sdk/api/HighLevelApi.d.ts

@@ -126,6 +126,10 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     aiGetCapabilities(): Promise<import('../payload.types').AIRuntimeCapabilities>;
     aiComplete(payload: import('../payload.types').AICompletePayload): Promise<import('../payload.types').AICompleteResult>;
     piaSearchAnswer(payload: import('../payload.types').PiaSearchAnswerPayload): Promise<import('../payload.types').PiaSearchAnswerResult>;
+    appsDbGetEntries(payload: import('../payload.types').AppsDbGetEntriesPayload): Promise<import('../payload.types').AppsDbEntriesResult>;
+    appsDbUpsertEntry(payload: import('../payload.types').AppsDbUpsertEntryPayload): Promise<import('../payload.types').AppsDbEntry>;
+    appsDbDeleteEntry(payload: import('../payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+    appsDbPsql(payload: import('../payload.types').AppsDbPsqlPayload): Promise<import('../payload.types').AppsDbEntriesResult>;
     open(payload?: import('../payload.types').OpenRequestPayload): Promise<string>;
     openExternalUrl(payload: import('../payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('../interfaces').PitcherEnv>;

package/lib/sdk/api/modules/appsDb.d.ts

@@ -0,0 +1,57 @@
+import { AppsDbDeleteEntryPayload, AppsDbEntriesResult, AppsDbEntry, AppsDbGetEntriesPayload, AppsDbPsqlPayload, AppsDbUpsertEntryPayload } from '../../payload.types';
+/**
+ * Lists AppsDB entries of a type, adapting to the platform:
+ * - Web: GET to the next-core AppsDB REST API.
+ * - iOS: reads the local offline mirror via the `appsdb_get_entries` bridge
+ *   request. Types not allowlisted in the `offline_appsdb_types` setting fail
+ *   with `code = type_not_synced` and automatically fall back to the network.
+ *
+ * @example
+ * const { entries } = await api.appsDbGetEntries({ type: 'favorite' })
+ */
+export declare function appsDbGetEntries(payload: AppsDbGetEntriesPayload): Promise<AppsDbEntriesResult>;
+/**
+ * Creates or updates (deep-merges) an AppsDB entry, adapting to the platform:
+ * - Web: POST (create) or PUT (update, when `id` is set) to the next-core AppsDB REST API.
+ * - iOS: the `appsdb_upsert_entry` bridge request writes on the server and
+ *   mirrors the authoritative result locally. Offline it rejects with
+ *   `code = offline_write_not_supported` — AppsDB writes are online-only.
+ *
+ * The `data` blob is sent verbatim (no key-casing transformation), and all
+ * `appsDb*` responses are likewise returned verbatim — even for
+ * `casing: 'camel'` consumers — so bridge and REST results are identical.
+ *
+ * @example
+ * const entry = await api.appsDbUpsertEntry({ type: 'favorite', user_id: 1, data: { file_id: 'abc' } })
+ */
+export declare function appsDbUpsertEntry(payload: AppsDbUpsertEntryPayload): Promise<AppsDbEntry>;
+/**
+ * Deletes an AppsDB entry (soft delete server-side), adapting to the platform:
+ * - Web: DELETE to the next-core AppsDB REST API.
+ * - iOS: the `appsdb_delete_entry` bridge request deletes on the server and
+ *   removes the entry from the local offline mirror. Offline it rejects with
+ *   `code = offline_write_not_supported`.
+ *
+ * @example
+ * await api.appsDbDeleteEntry({ id: '01H5ZXE7YP2JR6Q1Z2G3K4H5J6' })
+ */
+export declare function appsDbDeleteEntry(payload: AppsDbDeleteEntryPayload): Promise<void>;
+/**
+ * Runs a PSQL (SQL-like) query against AppsDB: POST to the next-core
+ * `/appsdb/psql` endpoint whenever the network is available.
+ *
+ * On iOS the local offline mirror (`appsdb_get_entries` + client-side
+ * evaluation of simple `field = literal` AND-chains) serves the query ONLY
+ * while the device is offline, or when an online fetch fails at the
+ * connection level. Online queries are always answered by the server: Hub
+ * flows use psql results to decide between creating and updating an entry,
+ * and the mirror can lag the server by a sync cycle (multi-device) — a stale
+ * empty read would turn an update into a duplicate create. Offline that same
+ * stale read is harmless because AppsDB writes are rejected offline anyway.
+ *
+ * @example
+ * const { entries } = await api.appsDbPsql({
+ *   query: "SELECT * FROM personalfolders WHERE user_id = 1 AND data.custom_domain = 'acme.my.pitcher.com'",
+ * })
+ */
+export declare function appsDbPsql(payload: AppsDbPsqlPayload): Promise<AppsDbEntriesResult>;

package/lib/sdk/api/modules/appsDb.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sdk/api/modules/index.d.ts

@@ -1,4 +1,5 @@
 export * from './ai';
+export * from './appsDb';
 export * from './open';
 export * from './env';
 export * from './languages';

package/lib/sdk/main.d.ts

@@ -198,6 +198,10 @@ export declare function useApi(options?: ApiOptions): {
     aiGetCapabilities(): Promise<import('./payload.types').AIRuntimeCapabilities>;
     aiComplete(payload: import('./payload.types').AICompletePayload): Promise<import('./payload.types').AICompleteResult>;
     piaSearchAnswer(payload: import('./payload.types').PiaSearchAnswerPayload): Promise<import('./payload.types').PiaSearchAnswerResult>;
+    appsDbGetEntries(payload: import('./payload.types').AppsDbGetEntriesPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
+    appsDbUpsertEntry(payload: import('./payload.types').AppsDbUpsertEntryPayload): Promise<import('./payload.types').AppsDbEntry>;
+    appsDbDeleteEntry(payload: import('./payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+    appsDbPsql(payload: import('./payload.types').AppsDbPsqlPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
     open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
@@ -491,6 +495,10 @@ export declare function useApi(options?: ApiOptions): {
         aiGetCapabilities(): Promise<import('./payload.types').AIRuntimeCapabilities>;
         aiComplete(payload: import('./payload.types').AICompletePayload): Promise<import('./payload.types').AICompleteResult>;
         piaSearchAnswer(payload: import('./payload.types').PiaSearchAnswerPayload): Promise<import('./payload.types').PiaSearchAnswerResult>;
+        appsDbGetEntries(payload: import('./payload.types').AppsDbGetEntriesPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
+        appsDbUpsertEntry(payload: import('./payload.types').AppsDbUpsertEntryPayload): Promise<import('./payload.types').AppsDbEntry>;
+        appsDbDeleteEntry(payload: import('./payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+        appsDbPsql(payload: import('./payload.types').AppsDbPsqlPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
         open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
         openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
         getEnv(): Promise<import('./interfaces').PitcherEnv>;
@@ -730,6 +738,10 @@ export declare function useApi(options?: ApiOptions): {
     aiGetCapabilities(): Promise<import('./payload.types').AIRuntimeCapabilities>;
     aiComplete(payload: import('./payload.types').AICompletePayload): Promise<import('./payload.types').AICompleteResult>;
     piaSearchAnswer(payload: import('./payload.types').PiaSearchAnswerPayload): Promise<import('./payload.types').PiaSearchAnswerResult>;
+    appsDbGetEntries(payload: import('./payload.types').AppsDbGetEntriesPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
+    appsDbUpsertEntry(payload: import('./payload.types').AppsDbUpsertEntryPayload): Promise<import('./payload.types').AppsDbEntry>;
+    appsDbDeleteEntry(payload: import('./payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+    appsDbPsql(payload: import('./payload.types').AppsDbPsqlPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {