commons-shared-web-ui 0.0.22 → 0.0.23

package/index.d.ts

@@ -342,6 +342,94 @@ interface RangeConfig {
     minDate?: string;
     maxDate?: string;
 }
+/**
+ * Describes a single query-parameter for a parameterised API URL.
+ * Supports static values (baked into the JSON config) and dynamic values
+ * resolved at runtime from a context object via dot-notation `sourcePath`.
+ *
+ * Used inside `LibraryUploadConfig.params` to declaratively list all
+ * query params the library-image sync API needs.
+ */
+interface ApiQueryParam {
+    /** The query-param key sent to the backend (e.g. 'entityType', 'completeUrl'). */
+    key: string;
+    /**
+     * A static value baked into the JSON config
+     * (e.g. 'ENTITY_TYPE.OPPORTUNITY_GALLERY').
+     * Leave unset when the value must be resolved dynamically at runtime.
+     */
+    staticValue?: string;
+    /**
+     * A dot-notation path resolved against a runtime context object
+     * (e.g. 'libraryItem.url'). Takes precedence over `staticValue`
+     * when the context provides a non-null value.
+     */
+    sourcePath?: string;
+    /**
+     * When true the HTTP request is aborted if this param cannot be resolved
+     * to a non-empty value.
+     */
+    required?: boolean;
+}
+/**
+ * Structured config for the library-image sync POST API.
+ * Declare each query param as an `ApiQueryParam` so the set can grow
+ * without any code changes.
+ *
+ * Example:
+ * {
+ *   "baseUrl": "gateway/commons-opportunity-service/api/v1/attachments/upload-url",
+ *   "params": [
+ *     { "key": "entityType", "staticValue": "ENTITY_TYPE.OPPORTUNITY_GALLERY", "required": true },
+ *     { "key": "completeUrl", "sourcePath": "libraryItem.url", "required": true }
+ *   ]
+ * }
+ */
+interface LibraryUploadConfig {
+    /** Base URL without any query string. */
+    baseUrl: string;
+    /**
+     * Declared query params. Static values are embedded in the config;
+     * dynamic values (e.g. `completeUrl`) are resolved at call time from
+     * a runtime context object using `sourcePath`.
+     */
+    params?: ApiQueryParam[];
+}
+/**
+ * All library-image picker settings grouped under one roof.
+ * Used as the `libraryConfig` key inside `AttachmentConfig`.
+ *
+ * Example:
+ * {
+ *   "apiUrl": "gateway/.../attachments/bulk/public?entityIds=1&entityType=...",
+ *   "dataPath": "data",
+ *   "urlPath": "completeURL",
+ *   "idPath": "id",
+ *   "uploadConfig": {
+ *     "baseUrl": "gateway/.../attachments/upload-url",
+ *     "params": [
+ *       { "key": "entityType", "staticValue": "ENTITY_TYPE.OPPORTUNITY_GALLERY", "required": true },
+ *       { "key": "completeUrl", "sourcePath": "libraryItem.url", "required": true }
+ *     ]
+ *   }
+ * }
+ */
+interface LibraryConfig {
+    /** API endpoint (GET) to load the library image list. */
+    apiUrl: string;
+    /** Dot-notation path to the image array in the API response (e.g. 'data.items'). */
+    dataPath?: string;
+    /** Dot-notation path to the image URL within each item (e.g. 'completeURL'). */
+    urlPath?: string;
+    /** Dot-notation path to the image ID within each item (e.g. 'id'). */
+    idPath?: string;
+    /**
+     * Structured config for the library-image sync POST API.
+     * Declare each query param as an `ApiQueryParam` so the set can
+     * grow without any code changes.
+     */
+    uploadConfig?: LibraryUploadConfig;
+}
 /**
  * Unified attachment / file-upload configuration.
  * Used by FILE_UPLOAD fields for any kind of upload — images, documents, PDFs, etc.
@@ -374,22 +462,20 @@ interface AttachmentConfig {
      * API endpoint to delete the file. Called when an uploaded file with an ID != 0 is removed.
      */
     deleteUrl?: string;
-    /** API endpoint to GET the default library images list */
-    libraryApiUrl?: string;
-    /** Dot-notation path to the image array in the library API response (e.g. 'data.items') */
-    libraryDataPath?: string;
-    /** Dot-notation path to the image URL within each library item (e.g. 'url') */
-    libraryUrlPath?: string;
-    /** Dot-notation path to the image ID within each library item */
-    libraryIdPath?: string;
+    /**
+     * All library-image picker settings (API, response paths, sync upload).
+     * Replaces the former flat `libraryApiUrl`, `libraryDataPath`,
+     * `libraryUrlPath`, `libraryIdPath`, and `libraryUploadConfig` fields.
+     */
+    libraryConfig?: LibraryConfig;
     /** Optional description shown in the left info panel for media upload */
     description?: string;
     /** Optional bullet-point feature lines shown in the left info panel for media upload */
     features?: string[];
 }
 interface LocationConfig {
-    /** Default active tab: 'VENUE' | 'ONLINE' | 'TBA'. Defaults to 'VENUE'. */
-    defaultTab?: 'VENUE' | 'ONLINE' | 'TBA';
+    /** Default active tab (e.g. 'VENUE', 'ONLINE', 'TBA'). Defaults to 'VENUE' when not provided. */
+    defaultTab?: string;
     /** Allow multiple locations. Replaces the need for maxLocations. */
     allowMulti?: boolean;
     /** Maximum number of venue locations allowed. Defaults to 5 if allowMulti is true. */
@@ -438,7 +524,8 @@ interface LocationItem {
  * `tab` indicates which mode is active.
  */
 interface LocationFieldValue {
-    tab: 'VENUE' | 'ONLINE' | 'TBA';
+    /** Active location tab (e.g. 'VENUE', 'ONLINE', 'TBA'). Defaults to 'VENUE'. */
+    tab: string;
     /** Array of venue locations (only valid when tab === 'VENUE') */
     venues?: LocationItem[];
     /** Event URL (only valid when tab === 'ONLINE') */
@@ -468,8 +555,8 @@ interface ValidationResult {
 interface MediaItem {
     /** Server-assigned ID (for pre-filled items) */
     id?: number;
-    /** 'image' | 'youtube' */
-    mediaType: 'image' | 'youtube';
+    /** Media type (e.g. 'image', 'youtube'). Defaults to 'image'. */
+    mediaType: string;
     /** Remote URL of the image returned by the upload API, or the YouTube embed URL */
     url: string;
     /** Thumbnail URL (for YouTube previews) */
@@ -1057,8 +1144,8 @@ declare class FormFieldComponent implements OnInit, OnDestroy {
     libraryLoading: boolean;
     libraryError: string;
     mediaUploadError: string;
-    /** Active tab: VENUE | ONLINE | TBA */
-    locationActiveTab: 'VENUE' | 'ONLINE' | 'TBA';
+    /** Active tab: any string, e.g. 'VENUE', 'ONLINE', 'TBA'. Defaults to 'VENUE'. */
+    locationActiveTab: string;
     /** Current text in the venue search box */
     locationSearchText: string;
     /** Google Places autocomplete suggestions */
@@ -1227,6 +1314,11 @@ declare class FormFieldComponent implements OnInit, OnDestroy {
     private _extractYoutubeId;
     onMediaMenuDevice(): void;
     onMediaFileSelected(event: Event): void;
+    /**
+     * Resolves the library-image sync POST endpoint from `attachmentConfig.libraryConfig.uploadConfig`.
+     * Returns `null` when not configured; the caller skips the API call.
+     */
+    private buildLibraryUploadRequest;
     onMediaMenuLibrary(): void;
     private _loadLibraryImages;
     getLibraryItemUrl(item: any): string;
@@ -1240,7 +1332,7 @@ declare class FormFieldComponent implements OnInit, OnDestroy {
     private showMediaError;
     private initLocationField;
     private _ensureGoogleMapsScript;
-    onLocationTabChange(tab: 'VENUE' | 'ONLINE' | 'TBA'): void;
+    onLocationTabChange(tab: string): void;
     get locationValue(): LocationFieldValue;
     get locationVenues(): LocationItem[];
     get locationOnlineUrl(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commons-shared-web-ui",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "peerDependencies": {
     "@angular/animations": "20.3.15",
     "@angular/cdk": "20.2.14",

package/src/lib/styles/global.scss

@@ -1,6 +1,7 @@
 @use '../modules/side-nav/side-nav.theme' as sideNav;
 @use '../modules/form-builder/form-builder.theme' as fb;
 @import 'quill/dist/quill.snow.css';
+@import './utilities.scss';
 
 :root {
   @include sideNav.side-nav-theme();