@streamline-pulse/formkrafter-core 0.32.1 → 0.33.0

package/dist/services/option_source_service.d.ts

@@ -1,8 +1,21 @@
+/** A catalog the host offers to select / multi-select fields (shown in the builder). */
+export interface OptionCatalogEntry {
+    /** What to put in `optionsRef` (filters may be appended: `towns?region={{data.region}}`). */
+    ref: string;
+    label: string;
+    description?: string;
+    /** Query parameters the catalog accepts, for dependent lists. */
+    filters?: string[];
+}
 export interface OptionSourceService {
     fetchOptions(ref: string): Promise<unknown>;
+    /** Optional: the catalogs available, so the builder can suggest refs. */
+    listCatalogs?(): Promise<OptionCatalogEntry[]>;
 }
 export interface FetchOptionSourceDefaults {
     baseUrl?: string;
+    /** Where to list the catalogs (default: `baseUrl`). The response is an array, or `{ data: [...] }`, of `{ ref | value, name | label, description?, filters? }`. */
+    catalogsUrl?: string;
     headers?: Record<string, string>;
     credentials?: RequestCredentials;
     fetch?: typeof fetch;
@@ -13,4 +26,6 @@ export declare class FetchOptionSourceService implements OptionSourceService {
     constructor(defaults?: FetchOptionSourceDefaults);
     private resolveUrl;
     fetchOptions(ref: string): Promise<unknown>;
+    private catalogs?;
+    listCatalogs(): Promise<OptionCatalogEntry[]>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamline-pulse/formkrafter-core",
-  "version": "0.32.1",
+  "version": "0.33.0",
   "description": "Framework-agnostic core for FormKrafter: form specs, RFC 6902 ops with undo/redo, Ajv validation, sandboxed rules engine and injectable services",
   "license": "MIT",
   "type": "module",