@pitcher/js-api 1.27.3 → 1.28.0

package/lib/sdk/payload.types.d.ts

@@ -568,6 +568,79 @@ export interface PiaSearchAnswerPayload {
      */
     max_tokens?: number;
 }
+/**
+ * A single AppsDB entry (next-core `core_appsdb_entries` row / iOS offline mirror record).
+ */
+export interface AppsDbEntry {
+    /**
+     * Unique identifier (ULID).
+     */
+    id: string;
+    /**
+     * Object type the entry belongs to (e.g. `personalfolders`, `favorite`).
+     */
+    type: string;
+    user_id?: number | null;
+    org_id?: string | null;
+    instance_id?: string | null;
+    /**
+     * Opaque application data. Keys are stored verbatim (no casing transformation).
+     */
+    data: Record<string, any>;
+    created_at?: string;
+    updated_at?: string;
+}
+/**
+ * Payload for `appsDbGetEntries` — list AppsDB entries of a type.
+ */
+export interface AppsDbGetEntriesPayload {
+    /**
+     * The object type to read. On iOS only types allowlisted via the
+     * `offline_appsdb_types` instance/org setting are served from the offline mirror.
+     */
+    type: string;
+    user_id?: number;
+    instance_id?: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Entry-list result shared by `appsDbGetEntries` and `appsDbPsql`.
+ */
+export interface AppsDbEntriesResult {
+    entries: AppsDbEntry[];
+    totalCount?: number;
+    hasMore?: boolean;
+}
+/**
+ * Payload for `appsDbUpsertEntry`. With `id` the entry is updated (the server
+ * deep-merges `data`); without `id` a new entry is created.
+ */
+export interface AppsDbUpsertEntryPayload {
+    id?: string;
+    type?: string;
+    user_id?: number;
+    instance_id?: string;
+    /**
+     * Create an instance-wide entry with no user attribution (allowlist-gated
+     * server-side, see next-core `appsdb/ownership.ts`).
+     */
+    no_user_id?: boolean;
+    data: Record<string, any>;
+}
+/**
+ * Payload for `appsDbDeleteEntry`.
+ */
+export interface AppsDbDeleteEntryPayload {
+    id: string;
+}
+/**
+ * Payload for `appsDbPsql` — a PSQL (SQL-like) query against AppsDB, e.g.
+ * `SELECT * FROM favorite WHERE user_id = 1 AND data.file_id = 'abc'`.
+ */
+export interface AppsDbPsqlPayload {
+    query: string;
+}
 /**
  * Unified `piaSearchAnswer` result across both serving paths.
  */

package/lib/types/app.d.ts

@@ -17,6 +17,13 @@ export type ModuleSettingsField = {
     help_text?: string;
     is_required?: boolean;
     options?: ModuleSettingsOption[];
+    /**
+     * For SELECT fields whose options aren't known at publish time: a key the host resolves to a live
+     * option list injected via `provide('dynamicFieldOptions', { <key>: Option[] })`. The Embeddable
+     * settings panel uses that resolved list in place of the field's static `options`. Used by assessment-canvas (T2.4):
+     * `dynamic_options: 'assessments'` → the instance's assessments, forwarded by ld-app.
+     */
+    dynamic_options?: string;
 };
 export type ModuleSettingsSection = {
     label?: string;
@@ -43,6 +50,13 @@ export type Module = {
     enabled: boolean;
     headless?: boolean;
     auto_install?: boolean;
+    /**
+     * L&D-only marker (module.canvas). When true, the app is offered in the Add-Component /
+     * Embeddable pickers ONLY where the host opts in via `provide('allowCourseOnlyApps', true)` —
+     * i.e. the L&D course host — and hidden in normal sales / DSR canvases where it can't function.
+     * Used by the assessment-canvas wrap app (T2.4 / PIT-6978).
+     */
+    course_only?: boolean;
     entry?: string;
     settings?: ModuleSettings;
     defaults: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.27.3",
+  "version": "1.28.0",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",