@okf/ootils 1.44.2 → 1.46.0

package/dist/universal.d.ts

@@ -767,7 +767,7 @@ declare namespace BASE_BULLMQ_CONFIG {
         }
         export { workerConfig_11 as workerConfig };
     }
-    namespace SARVAM_TRANSCRIPTION_QUEUE {
+    namespace CONTENT_DOC_COLAB_SESH_SIDE_EFFECTS_QUEUE {
         let id_12: string;
         export { id_12 as id };
         export namespace queueConfig_12 {
@@ -807,7 +807,7 @@ declare namespace BASE_BULLMQ_CONFIG {
         }
         export { workerConfig_12 as workerConfig };
     }
-    namespace INTERCOM_CONVERSATIONS_QUEUE {
+    namespace SARVAM_TRANSCRIPTION_QUEUE {
         let id_13: string;
         export { id_13 as id };
         export namespace queueConfig_13 {
@@ -847,7 +847,7 @@ declare namespace BASE_BULLMQ_CONFIG {
         }
         export { workerConfig_13 as workerConfig };
     }
-    namespace TAG_SYNC_PLAN_QUEUE {
+    namespace INTERCOM_CONVERSATIONS_QUEUE {
         let id_14: string;
         export { id_14 as id };
         export namespace queueConfig_14 {
@@ -887,7 +887,7 @@ declare namespace BASE_BULLMQ_CONFIG {
         }
         export { workerConfig_14 as workerConfig };
     }
-    namespace TAG_SYNC_BATCH_QUEUE {
+    namespace TAG_SYNC_PLAN_QUEUE {
         let id_15: string;
         export { id_15 as id };
         export namespace queueConfig_15 {
@@ -927,11 +927,13 @@ declare namespace BASE_BULLMQ_CONFIG {
         }
         export { workerConfig_15 as workerConfig };
     }
-    namespace SCHEDULED_EXTERNAL_SYNC_QUEUE {
+    namespace TAG_SYNC_BATCH_QUEUE {
         let id_16: string;
         export { id_16 as id };
         export namespace queueConfig_16 {
             export namespace defaultJobOptions_16 {
+                let attempts_16: number;
+                export { attempts_16 as attempts };
                 export namespace backoff_16 {
                     let type_16: string;
                     export { type_16 as type };
@@ -939,8 +941,6 @@ declare namespace BASE_BULLMQ_CONFIG {
                     export { delay_16 as delay };
                 }
                 export { backoff_16 as backoff };
-                let attempts_16: number;
-                export { attempts_16 as attempts };
                 let removeOnComplete_16: number;
                 export { removeOnComplete_16 as removeOnComplete };
                 let removeOnFail_16: number;
@@ -967,13 +967,11 @@ declare namespace BASE_BULLMQ_CONFIG {
         }
         export { workerConfig_16 as workerConfig };
     }
-    namespace REINDEX_QUEUE {
+    namespace SCHEDULED_EXTERNAL_SYNC_QUEUE {
         let id_17: string;
         export { id_17 as id };
         export namespace queueConfig_17 {
             export namespace defaultJobOptions_17 {
-                let attempts_17: number;
-                export { attempts_17 as attempts };
                 export namespace backoff_17 {
                     let type_17: string;
                     export { type_17 as type };
@@ -981,8 +979,8 @@ declare namespace BASE_BULLMQ_CONFIG {
                     export { delay_17 as delay };
                 }
                 export { backoff_17 as backoff };
-                let delay_18: number;
-                export { delay_18 as delay };
+                let attempts_17: number;
+                export { attempts_17 as attempts };
                 let removeOnComplete_17: number;
                 export { removeOnComplete_17 as removeOnComplete };
                 let removeOnFail_17: number;
@@ -1009,6 +1007,48 @@ declare namespace BASE_BULLMQ_CONFIG {
         }
         export { workerConfig_17 as workerConfig };
     }
+    namespace REINDEX_QUEUE {
+        let id_18: string;
+        export { id_18 as id };
+        export namespace queueConfig_18 {
+            export namespace defaultJobOptions_18 {
+                let attempts_18: number;
+                export { attempts_18 as attempts };
+                export namespace backoff_18 {
+                    let type_18: string;
+                    export { type_18 as type };
+                    let delay_18: number;
+                    export { delay_18 as delay };
+                }
+                export { backoff_18 as backoff };
+                let delay_19: number;
+                export { delay_19 as delay };
+                let removeOnComplete_18: number;
+                export { removeOnComplete_18 as removeOnComplete };
+                let removeOnFail_18: number;
+                export { removeOnFail_18 as removeOnFail };
+            }
+            export { defaultJobOptions_18 as defaultJobOptions };
+            export namespace streams_18 {
+                export namespace events_18 {
+                    let maxLen_18: number;
+                    export { maxLen_18 as maxLen };
+                }
+                export { events_18 as events };
+            }
+            export { streams_18 as streams };
+        }
+        export { queueConfig_18 as queueConfig };
+        export namespace workerConfig_18 {
+            let concurrency_18: number;
+            export { concurrency_18 as concurrency };
+            let lockDuration_18: number;
+            export { lockDuration_18 as lockDuration };
+            let maxStalledCount_18: number;
+            export { maxStalledCount_18 as maxStalledCount };
+        }
+        export { workerConfig_18 as workerConfig };
+    }
 }
 
 interface PlatformContextContentItem {
@@ -1054,6 +1094,24 @@ interface MergeParams {
  */
 declare const mergeAnnoDataIntoAnnotationsTags: ({ prevObj, newLexValue, thisBlockValuePath, author, }: MergeParams) => any;
 
+/**
+ * Is this tpl block a collab-editable field? ONE definition, used by BOTH
+ * sides so they can never disagree:
+ *  - okf-sub loadContentDocument builds the server-side editable allowlist
+ *    from it (the flush drops writes outside that list)
+ *  - okf-fe ViewBlockGenerator derives per-block editability from it
+ *
+ * Editable = binds to a real content path. Exclusions:
+ *  - no valuePath (display-only blocks) / the odd "." valuePath some legacy
+ *    tpls carry (see getTypesForSchemaFromTpl, which skips it too)
+ *  - kp_-prefixed segments (publish status, lifecycle dates, author refs —
+ *    machinery, not content). NOTE: non-block system fields (lastActivity,
+ *    tagId...) are excluded by construction anyway — they're never tpl
+ *    blocks; this regex only guards block-defined kp_ paths.
+ */
+declare const COLLAB_SYSTEM_PATH_REGEX: RegExp;
+declare function isCollabEditableBlock(block: any): boolean;
+
 declare const parseSpecialConfigSyntax: ({ config, content, returnUndefinedIfReplacementWordNotFound }: {
     config: string | object;
     content: Record<string, any>;
@@ -1276,6 +1334,21 @@ declare const processAuthorAndCommonFilters: (allTpls: any[], filterScopes: stri
                 filterType: string;
                 valuePath: string;
             };
+        } | {
+            filterId: string;
+            blockId: string;
+            display: string;
+            value: string;
+            filterKey: string | undefined;
+            source: {
+                filterType: string;
+                scope: string;
+                profileTypes?: undefined;
+            };
+            target: {
+                filterType: string;
+                valuePath: string;
+            };
         })[];
     }[];
 };
@@ -1405,6 +1478,7 @@ declare const _self_managed_buildDocHierarchyConfig: ({ combinedDocumentBlocks,
             filters: any[];
             rollups: any[];
             rollupDisplayMap: Record<string, string>;
+            childByParentId: Record<string, any>;
         }[];
     };
     target: {
@@ -1565,6 +1639,7 @@ declare const autoGenFilterConfigsFromTpl: ({ selectedTpls, allTpls, filterScope
                     filters: any[];
                     rollups: any[];
                     rollupDisplayMap: Record<string, string>;
+                    childByParentId: Record<string, any>;
                 }[];
             };
             target: {
@@ -1631,6 +1706,21 @@ declare const autoGenFilterConfigsFromTpl: ({ selectedTpls, allTpls, filterScope
                 filterType: string;
                 valuePath: string;
             };
+        } | {
+            filterId: string;
+            blockId: string;
+            display: string;
+            value: string;
+            filterKey: string | undefined;
+            source: {
+                filterType: string;
+                scope: string;
+                profileTypes?: undefined;
+            };
+            target: {
+                filterType: string;
+                valuePath: string;
+            };
         })[];
     })[];
 } | null)[];
@@ -1970,4 +2060,4 @@ declare class BlockRegistry {
 /** Singleton instance — the one registry shared across the app. */
 declare const blockRegistry: BlockRegistry;
 
-export { BASE_BULLMQ_CONFIG, type BlockCapabilities, type BlockDef, BlockRegistry, CHUNKING_PRESETS, ELASTIC_MAPPING_PRESETS, FILTER_IDS, MONGO_SCHEMA_PRESETS, TEMP_removeDuplicateFilters, UI_CONTENT, _self_managed_buildAnnoHierarchyConfig, _self_managed_buildDocHierarchyConfig, _self_managed_getFixedAnnoRollupBlocks, _self_managed_getFixedAnnoTagBlock, autoGenFilterConfigsFromTpl, blockRegistry, buildFilterConfigurations, collectMarkIdsInOrder, compareAndGroupBlocks, deleteVal, extractAllBlocksFromTpl, extractAndOrganizeBlocks, genCleanCamelCaseId, genTagId, generateFilterKey, getAnnoFilterBucketKey, getFilterKeyForBlock, getPlatformContextContent, getRollupPossibilities, getRoutePathToContentTypeLanding, getRoutePathToEditContent, getRoutePathToModerateContent, getRoutePathToMyContent, getRoutePathToPublishedContent, getRoutePathToReviewDashboard, getRoutePathToTCI, getRoutePathToTagCategoryLanding, getVal, isTplAnnotationEnabled, mergeAnnoDataIntoAnnotationsTags, parseSpecialConfigSyntax, plainTextToLexical, processAuthorAndCommonFilters, _recursExtractBlocks as recursivelyExtractBlocks, segrigateDocs, setVal, toArray };
+export { BASE_BULLMQ_CONFIG, type BlockCapabilities, type BlockDef, BlockRegistry, CHUNKING_PRESETS, COLLAB_SYSTEM_PATH_REGEX, ELASTIC_MAPPING_PRESETS, FILTER_IDS, MONGO_SCHEMA_PRESETS, TEMP_removeDuplicateFilters, UI_CONTENT, _self_managed_buildAnnoHierarchyConfig, _self_managed_buildDocHierarchyConfig, _self_managed_getFixedAnnoRollupBlocks, _self_managed_getFixedAnnoTagBlock, autoGenFilterConfigsFromTpl, blockRegistry, buildFilterConfigurations, collectMarkIdsInOrder, compareAndGroupBlocks, deleteVal, extractAllBlocksFromTpl, extractAndOrganizeBlocks, genCleanCamelCaseId, genTagId, generateFilterKey, getAnnoFilterBucketKey, getFilterKeyForBlock, getPlatformContextContent, getRollupPossibilities, getRoutePathToContentTypeLanding, getRoutePathToEditContent, getRoutePathToModerateContent, getRoutePathToMyContent, getRoutePathToPublishedContent, getRoutePathToReviewDashboard, getRoutePathToTCI, getRoutePathToTagCategoryLanding, getVal, isCollabEditableBlock, isTplAnnotationEnabled, mergeAnnoDataIntoAnnotationsTags, parseSpecialConfigSyntax, plainTextToLexical, processAuthorAndCommonFilters, _recursExtractBlocks as recursivelyExtractBlocks, segrigateDocs, setVal, toArray };

package/dist/universal.js

@@ -23,6 +23,7 @@ __export(universal_exports, {
   BASE_BULLMQ_CONFIG: () => BASE_BULLMQ_CONFIG,
   BlockRegistry: () => BlockRegistry,
   CHUNKING_PRESETS: () => CHUNKING_PRESETS,
+  COLLAB_SYSTEM_PATH_REGEX: () => COLLAB_SYSTEM_PATH_REGEX,
   ELASTIC_MAPPING_PRESETS: () => ELASTIC_MAPPING_PRESETS,
   FILTER_IDS: () => FILTER_IDS,
   MONGO_SCHEMA_PRESETS: () => MONGO_SCHEMA_PRESETS,
@@ -56,6 +57,7 @@ __export(universal_exports, {
   getRoutePathToTCI: () => getRoutePathToTCI,
   getRoutePathToTagCategoryLanding: () => getRoutePathToTagCategoryLanding,
   getVal: () => getVal,
+  isCollabEditableBlock: () => isCollabEditableBlock,
   isTplAnnotationEnabled: () => isTplAnnotationEnabled,
   mergeAnnoDataIntoAnnotationsTags: () => mergeAnnoDataIntoAnnotationsTags,
   parseSpecialConfigSyntax: () => parseSpecialConfigSyntax,
@@ -1215,6 +1217,43 @@ var BASE_BULLMQ_CONFIG = {
       maxStalledCount: 3
     }
   },
+  /**
+   * Collab-editing session-boundary side effects for CONTENT docs.
+   * Enqueued by okf-sub's collab service when a field lock releases / the
+   * last editor leaves a live doc; the worker calls okf-be's internal
+   * contentDocCollabSessionSideEffects endpoint (tag-rename sync, chunks/annos
+   * producers, Elastic sync, cache invalidations, analytics).
+   * Queued (rather than fire-and-forget HTTP from the boundary) for retry
+   * ability + Bullboard trackability — a failed boundary would otherwise be
+   * silently lost when the doc unloads. Steps are idempotent except
+   * analytics, which runs LAST so retries only duplicate it on a
+   * lost-response network edge.
+   */
+  CONTENT_DOC_COLAB_SESH_SIDE_EFFECTS_QUEUE: {
+    id: "content-doc-colab-sesh-side-effects-queue",
+    queueConfig: {
+      defaultJobOptions: {
+        attempts: 3,
+        backoff: {
+          type: "exponential",
+          delay: 5e3
+        },
+        removeOnComplete: 50,
+        removeOnFail: 200
+      },
+      streams: {
+        events: {
+          maxLen: 1e3
+          // SockerIOService QueueEvents tails this stream for progress tracking; trimming at 10 dropped completion events mid-burst (stuck FE tracker). Entries are small now that job returnvalues are trimmed, so 1000 is cheap.
+        }
+      }
+    },
+    workerConfig: {
+      concurrency: 10,
+      lockDuration: 9e4,
+      maxStalledCount: 3
+    }
+  },
   SARVAM_TRANSCRIPTION_QUEUE: {
     id: "sarvam-transcription-queue",
     queueConfig: {
@@ -1491,6 +1530,10 @@ var mergeAnnoDataIntoAnnotationsTags = ({
   return newConsolidated;
 };
 
+// src/collab/isCollabEditableBlock.js
+var COLLAB_SYSTEM_PATH_REGEX = /(^|\.)kp_/;
+var isCollabEditableBlock = (block) => !!block?.valuePath && block.valuePath !== "." && !COLLAB_SYSTEM_PATH_REGEX.test(block.valuePath);
+
 // src/utils/parseSpecialConfigSyntax.ts
 var parseSpecialConfigSyntax = ({
   config,
@@ -2281,6 +2324,24 @@ var processAuthorAndCommonFilters = (allTpls, filterScopes, annoEnabledBlocks =
           filterType: "dateRangeType",
           valuePath: "kp_date_published"
         }
+      },
+      // "Documents" filter — narrows results to specific chosen documents of the
+      // datasets in view, matched on their own _id. Options list those datasets'
+      // documents by title (documentsType fetch, which uses the ambient contentTypes);
+      // the backend matches { _id: { $in: [ids] } } via target valuePath "_id"
+      // (getValuePathQuery ObjectId-casts any `_id`-ending path).
+      {
+        filterId: "documentsFilter",
+        blockId: "documentsFilter",
+        display: "Documents",
+        value: "documents",
+        filterKey: generateFilterKey({
+          filterType: "valuePathType",
+          valuePath: "_id",
+          scope: "doc"
+        }),
+        source: { filterType: "documentsType", scope: "tags" },
+        target: { filterType: "valuePathType", valuePath: "_id" }
       }
     ]
   }] : [];
@@ -2641,12 +2702,19 @@ var _self_managed_buildDocHierarchyConfig = ({
       const t = allTpls.find((tp) => tp.kp_content_type === ct);
       if (t?.general?.content?.title) rollupDisplayMap[ct] = t.general.content.title;
     }
+    const childByParentId = {};
+    for (const r of rollupsWithParents) {
+      if (r.parentFilterId && r.isTagRollup && r.source?.filterType === "tagType") {
+        childByParentId[r.parentFilterId] = r;
+      }
+    }
     return {
       contentType: tpl.kp_content_type,
       display: tplData?.general?.content?.title || tpl.kp_content_type,
       filters: filtersWithParents,
       rollups: rollupsWithParents,
-      rollupDisplayMap
+      rollupDisplayMap,
+      childByParentId
     };
   });
   const filteredPerDataset = perDataset.filter(
@@ -2915,6 +2983,7 @@ var plainTextToLexical = (value) => {
   BASE_BULLMQ_CONFIG,
   BlockRegistry,
   CHUNKING_PRESETS,
+  COLLAB_SYSTEM_PATH_REGEX,
   ELASTIC_MAPPING_PRESETS,
   FILTER_IDS,
   MONGO_SCHEMA_PRESETS,
@@ -2948,6 +3017,7 @@ var plainTextToLexical = (value) => {
   getRoutePathToTCI,
   getRoutePathToTagCategoryLanding,
   getVal,
+  isCollabEditableBlock,
   isTplAnnotationEnabled,
   mergeAnnoDataIntoAnnotationsTags,
   parseSpecialConfigSyntax,

package/dist/universal.mjs

@@ -1145,6 +1145,43 @@ var BASE_BULLMQ_CONFIG = {
       maxStalledCount: 3
     }
   },
+  /**
+   * Collab-editing session-boundary side effects for CONTENT docs.
+   * Enqueued by okf-sub's collab service when a field lock releases / the
+   * last editor leaves a live doc; the worker calls okf-be's internal
+   * contentDocCollabSessionSideEffects endpoint (tag-rename sync, chunks/annos
+   * producers, Elastic sync, cache invalidations, analytics).
+   * Queued (rather than fire-and-forget HTTP from the boundary) for retry
+   * ability + Bullboard trackability — a failed boundary would otherwise be
+   * silently lost when the doc unloads. Steps are idempotent except
+   * analytics, which runs LAST so retries only duplicate it on a
+   * lost-response network edge.
+   */
+  CONTENT_DOC_COLAB_SESH_SIDE_EFFECTS_QUEUE: {
+    id: "content-doc-colab-sesh-side-effects-queue",
+    queueConfig: {
+      defaultJobOptions: {
+        attempts: 3,
+        backoff: {
+          type: "exponential",
+          delay: 5e3
+        },
+        removeOnComplete: 50,
+        removeOnFail: 200
+      },
+      streams: {
+        events: {
+          maxLen: 1e3
+          // SockerIOService QueueEvents tails this stream for progress tracking; trimming at 10 dropped completion events mid-burst (stuck FE tracker). Entries are small now that job returnvalues are trimmed, so 1000 is cheap.
+        }
+      }
+    },
+    workerConfig: {
+      concurrency: 10,
+      lockDuration: 9e4,
+      maxStalledCount: 3
+    }
+  },
   SARVAM_TRANSCRIPTION_QUEUE: {
     id: "sarvam-transcription-queue",
     queueConfig: {
@@ -1421,6 +1458,10 @@ var mergeAnnoDataIntoAnnotationsTags = ({
   return newConsolidated;
 };
 
+// src/collab/isCollabEditableBlock.js
+var COLLAB_SYSTEM_PATH_REGEX = /(^|\.)kp_/;
+var isCollabEditableBlock = (block) => !!block?.valuePath && block.valuePath !== "." && !COLLAB_SYSTEM_PATH_REGEX.test(block.valuePath);
+
 // src/utils/parseSpecialConfigSyntax.ts
 var parseSpecialConfigSyntax = ({
   config,
@@ -2211,6 +2252,24 @@ var processAuthorAndCommonFilters = (allTpls, filterScopes, annoEnabledBlocks =
           filterType: "dateRangeType",
           valuePath: "kp_date_published"
         }
+      },
+      // "Documents" filter — narrows results to specific chosen documents of the
+      // datasets in view, matched on their own _id. Options list those datasets'
+      // documents by title (documentsType fetch, which uses the ambient contentTypes);
+      // the backend matches { _id: { $in: [ids] } } via target valuePath "_id"
+      // (getValuePathQuery ObjectId-casts any `_id`-ending path).
+      {
+        filterId: "documentsFilter",
+        blockId: "documentsFilter",
+        display: "Documents",
+        value: "documents",
+        filterKey: generateFilterKey({
+          filterType: "valuePathType",
+          valuePath: "_id",
+          scope: "doc"
+        }),
+        source: { filterType: "documentsType", scope: "tags" },
+        target: { filterType: "valuePathType", valuePath: "_id" }
       }
     ]
   }] : [];
@@ -2571,12 +2630,19 @@ var _self_managed_buildDocHierarchyConfig = ({
       const t = allTpls.find((tp) => tp.kp_content_type === ct);
       if (t?.general?.content?.title) rollupDisplayMap[ct] = t.general.content.title;
     }
+    const childByParentId = {};
+    for (const r of rollupsWithParents) {
+      if (r.parentFilterId && r.isTagRollup && r.source?.filterType === "tagType") {
+        childByParentId[r.parentFilterId] = r;
+      }
+    }
     return {
       contentType: tpl.kp_content_type,
       display: tplData?.general?.content?.title || tpl.kp_content_type,
       filters: filtersWithParents,
       rollups: rollupsWithParents,
-      rollupDisplayMap
+      rollupDisplayMap,
+      childByParentId
     };
   });
   const filteredPerDataset = perDataset.filter(
@@ -2844,6 +2910,7 @@ export {
   BASE_BULLMQ_CONFIG,
   BlockRegistry,
   CHUNKING_PRESETS,
+  COLLAB_SYSTEM_PATH_REGEX,
   ELASTIC_MAPPING_PRESETS,
   FILTER_IDS,
   MONGO_SCHEMA_PRESETS,
@@ -2877,6 +2944,7 @@ export {
   getRoutePathToTCI,
   getRoutePathToTagCategoryLanding,
   getVal,
+  isCollabEditableBlock,
   isTplAnnotationEnabled,
   mergeAnnoDataIntoAnnotationsTags,
   parseSpecialConfigSyntax,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.44.2",
+  "version": "1.46.0",
   "description": "Utility functions for both browser and Node.js",
   "main": "dist/index.js",
   "module": "dist/index.mjs",