@okf/ootils 1.31.3 → 1.31.4

package/dist/browser.d.mts

@@ -214,6 +214,14 @@ declare const _recursExtractBlocks: ({ data, cb, sectionStack, blockPathPrefix }
     blockPathPrefix?: string;
 }) => void;
 
+/**
+ * Returns true if annotation is enabled on this tpl. Two conditions must be met:
+ * 1. The tpl is in the publishing segment (annotation only makes sense for publishing).
+ * 2. At least one block on the tpl has the annotation capability in the registry
+ *    (or legacy props.annotation.enable for unregistered blocks).
+ */
+declare const isTplAnnotationEnabled: (tpl: any) => boolean;
+
 /**
  * Calculates all possible rollup relationships for a tag type
  *
@@ -1649,4 +1657,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, compareAndGroupBlocks, deleteVal, extractAllBlocksFromTpl, extractAndOrganizeBlocks, genCleanCamelCaseId, genTagId, generateFilterKey, getFilterKeyForBlock, getPlatformContextContent, getRollupPossibilities, getRoutePathToContentTypeLanding, getRoutePathToEditContent, getRoutePathToModerateContent, getRoutePathToMyContent, getRoutePathToPublishedContent, getRoutePathToReviewDashboard, getRoutePathToTCI, getRoutePathToTagCategoryLanding, getVal, mergeAnnoDataIntoAnnotationsTags, parseSpecialConfigSyntax, processAuthorAndCommonFilters, _recursExtractBlocks as recursivelyExtractBlocks, segrigateDocs, setVal, toArray };
+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, compareAndGroupBlocks, deleteVal, extractAllBlocksFromTpl, extractAndOrganizeBlocks, genCleanCamelCaseId, genTagId, generateFilterKey, getFilterKeyForBlock, getPlatformContextContent, getRollupPossibilities, getRoutePathToContentTypeLanding, getRoutePathToEditContent, getRoutePathToModerateContent, getRoutePathToMyContent, getRoutePathToPublishedContent, getRoutePathToReviewDashboard, getRoutePathToTCI, getRoutePathToTagCategoryLanding, getVal, isTplAnnotationEnabled, mergeAnnoDataIntoAnnotationsTags, parseSpecialConfigSyntax, processAuthorAndCommonFilters, _recursExtractBlocks as recursivelyExtractBlocks, segrigateDocs, setVal, toArray };

package/dist/browser.d.ts

@@ -214,6 +214,14 @@ declare const _recursExtractBlocks: ({ data, cb, sectionStack, blockPathPrefix }
     blockPathPrefix?: string;
 }) => void;
 
+/**
+ * Returns true if annotation is enabled on this tpl. Two conditions must be met:
+ * 1. The tpl is in the publishing segment (annotation only makes sense for publishing).
+ * 2. At least one block on the tpl has the annotation capability in the registry
+ *    (or legacy props.annotation.enable for unregistered blocks).
+ */
+declare const isTplAnnotationEnabled: (tpl: any) => boolean;
+
 /**
  * Calculates all possible rollup relationships for a tag type
  *
@@ -1649,4 +1657,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, compareAndGroupBlocks, deleteVal, extractAllBlocksFromTpl, extractAndOrganizeBlocks, genCleanCamelCaseId, genTagId, generateFilterKey, getFilterKeyForBlock, getPlatformContextContent, getRollupPossibilities, getRoutePathToContentTypeLanding, getRoutePathToEditContent, getRoutePathToModerateContent, getRoutePathToMyContent, getRoutePathToPublishedContent, getRoutePathToReviewDashboard, getRoutePathToTCI, getRoutePathToTagCategoryLanding, getVal, mergeAnnoDataIntoAnnotationsTags, parseSpecialConfigSyntax, processAuthorAndCommonFilters, _recursExtractBlocks as recursivelyExtractBlocks, segrigateDocs, setVal, toArray };
+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, compareAndGroupBlocks, deleteVal, extractAllBlocksFromTpl, extractAndOrganizeBlocks, genCleanCamelCaseId, genTagId, generateFilterKey, getFilterKeyForBlock, getPlatformContextContent, getRollupPossibilities, getRoutePathToContentTypeLanding, getRoutePathToEditContent, getRoutePathToModerateContent, getRoutePathToMyContent, getRoutePathToPublishedContent, getRoutePathToReviewDashboard, getRoutePathToTCI, getRoutePathToTagCategoryLanding, getVal, isTplAnnotationEnabled, mergeAnnoDataIntoAnnotationsTags, parseSpecialConfigSyntax, processAuthorAndCommonFilters, _recursExtractBlocks as recursivelyExtractBlocks, segrigateDocs, setVal, toArray };

package/dist/browser.js

@@ -54,6 +54,7 @@ __export(browser_exports, {
   getRoutePathToTCI: () => getRoutePathToTCI,
   getRoutePathToTagCategoryLanding: () => getRoutePathToTagCategoryLanding,
   getVal: () => getVal,
+  isTplAnnotationEnabled: () => isTplAnnotationEnabled,
   mergeAnnoDataIntoAnnotationsTags: () => mergeAnnoDataIntoAnnotationsTags,
   parseSpecialConfigSyntax: () => parseSpecialConfigSyntax,
   processAuthorAndCommonFilters: () => processAuthorAndCommonFilters,
@@ -375,6 +376,210 @@ var _extractBlocksFromSomeBuilders = ({
   }
 };
 
+// src/blockRegistry/schemaPresets.ts
+var MONGO_SCHEMA_PRESETS = {
+  object: { type: Object },
+  string: { type: String }
+};
+var ELASTIC_MAPPING_PRESETS = {
+  largeText: {
+    properties: {
+      allText: {
+        type: "text",
+        analyzer: "LargeTextAnalyzer"
+      }
+    }
+  }
+};
+var CHUNKING_PRESETS = {
+  // Lexical-shaped text — uses semantic chunking on allText
+  lexicalSemantic: {
+    strategy: "semanticChunking",
+    windowSize: 3,
+    minSimilarityScore: 0.7
+  },
+  // Plain text input — single chunk per field
+  simpleText: {
+    strategy: "simpleChunking"
+  }
+};
+
+// src/blockRegistry/blocks/LexicalTextEditor.ts
+var LexicalTextEditor = {
+  compName: "LexicalTextEditor",
+  // Identity
+  category: "text",
+  qualQuant: "qual",
+  // Schema
+  mongoSchemaType: MONGO_SCHEMA_PRESETS.object,
+  esMapping: ELASTIC_MAPPING_PRESETS.largeText,
+  // Capabilities
+  capabilities: {
+    hasPlainText: true,
+    annotation: true,
+    aiAnnotation: true,
+    aiEnrichment: true,
+    searchable: true,
+    directDataImport: true,
+    csvExport: true,
+    translatable: true,
+    documentSummarizer: true,
+    stripFromMainOnAnnoChunkSync: true,
+    excludeFromListingProjection: true
+  },
+  // Field paths
+  fieldPaths: {
+    plainTextString: "allText",
+    searchField: "allText",
+    displayValue: "allText"
+  },
+  // Validation
+  validation: {
+    populatedCheckFn: "lexicalTextEditorHasValue",
+    formValidationFn: "lexicalTextEditorHasValue"
+  },
+  // Translation
+  translation: {
+    handlerType: "LexicalBlockHandler"
+  },
+  // Table rendering
+  tableCell: {
+    cellComp: "RichTextAsPlainTextLex",
+    sortPathSuffix: "editorState.root.children.0.children.0.text"
+  },
+  // CSV export
+  csvExport: {
+    transformFn: "KPRichLexicalEditor"
+  },
+  // Slack
+  slackFormat: {
+    handlerFn: "lexicalRichText"
+  },
+  // Batch import
+  batchImport: {
+    valueInjectorFn: "toLexicalValue"
+  },
+  // Content block option — TCI template builder & direct import UI
+  contentBlockOption: {
+    display: "Rich Text Field",
+    icon: "TextAa",
+    directImportGroupsIdx: [2, 2]
+  },
+  // Chunking config — used by okf-sub CreateChunksHandler
+  chunkingConfig: CHUNKING_PRESETS.lexicalSemantic
+};
+
+// src/blockRegistry/registry.ts
+var BlockRegistry = class {
+  constructor() {
+    this.blocks = /* @__PURE__ */ new Map();
+    this.register(LexicalTextEditor);
+  }
+  /** Register a block descriptor. */
+  register(descriptor) {
+    this.blocks.set(descriptor.compName, descriptor);
+  }
+  /** Get the full descriptor for a block type. Returns undefined if not registered. */
+  getBlock(compType) {
+    return this.blocks.get(compType);
+  }
+  /** Check if a block type is registered in the registry. */
+  isRegistered(compType) {
+    return this.blocks.has(compType);
+  }
+  /**
+   * Get all registered block descriptors that have a given capability set to a truthy value.
+   * Optionally pass a specific value to match (e.g. for enum-style capabilities).
+   */
+  getBlocksByCapability(capability, value = true) {
+    return Array.from(this.blocks.values()).filter((b) => {
+      const cap = b.capabilities[capability];
+      if (value === true) return !!cap;
+      return cap === value;
+    });
+  }
+  /**
+   * Get compType strings for all registered blocks with a given capability.
+   * Replaces scattered hardcoded arrays like:
+   *   const TEXT_FIELD_COMPONENTS = ["TextInput", "LexicalTextEditor", ...]
+   * becomes:
+   *   const TEXT_FIELD_COMPONENTS = blockRegistry.getComps('aiTextExtraction')
+   */
+  getComps(capability, value = true) {
+    return this.getBlocksByCapability(capability, value).map((b) => b.compName);
+  }
+  /** Get all registered blocks in a given category. */
+  getBlocksByCategory(category) {
+    return Array.from(this.blocks.values()).filter((b) => b.category === category);
+  }
+  /** Get compType strings for all qual blocks. */
+  getQualBlocks() {
+    return Array.from(this.blocks.values()).filter((b) => b.qualQuant === "qual").map((b) => b.compName);
+  }
+  /** Get compType strings for all quant blocks. */
+  getQuantBlocks() {
+    return Array.from(this.blocks.values()).filter((b) => b.qualQuant === "quant").map((b) => b.compName);
+  }
+  /** Check if a specific block has a specific capability. */
+  hasCapability(compType, capability) {
+    const block = this.blocks.get(compType);
+    if (!block) return false;
+    return !!block.capabilities[capability];
+  }
+  /** Get all registered block descriptors. */
+  getAll() {
+    return Array.from(this.blocks.values());
+  }
+  /**
+   * Get compName strings for all registered blocks that have a chunking config.
+   * Used by chunking pipelines and prompt-string injection (e.g. searchChunks tool
+   * description) to know which fields actually have chunks to search.
+   */
+  getCompsWithChunking() {
+    return Array.from(this.blocks.values()).filter((b) => !!b.chunkingConfig).map((b) => b.compName);
+  }
+  /**
+   * Filter a list of block instances down to those where annotation is enabled.
+   * A block is annotation-enabled if its registry capability `annotation` is true.
+   * For backwards compat with un-migrated blocks (e.g. deprecated KPRichInput/RichTextEditor),
+   * falls back to the legacy per-instance `props.annotation.enable` toggle.
+   *
+   * Today: every registered annotation-capable block (e.g. LexicalTextEditor) is auto-enabled.
+   */
+  getAnnotationEnabledBlocks(allBlocks) {
+    return allBlocks.filter((block) => {
+      const blockDef = this.blocks.get(block.comp);
+      if (blockDef) return !!blockDef.capabilities.annotation;
+      return block.props?.annotation?.enable === true;
+    });
+  }
+  /**
+   * Resolve the tagTypesConfig for a block instance.
+   *
+   * Resolution order:
+   * 1. `hardCodedTagTypesConfigForSM` — the intended self-managed default, which takes
+   *    priority over per-instance values (justifies not persisting per-block on self-managed).
+   *    Sourced from `GET_SELF_MANAGED_BASE_CONFIGS().annotation_tagTypesConfig` on BE,
+   *    or `platformConfigs.SELF_MANAGED_BASE_CONFIGS.annotation_tagTypesConfig` on FE.
+   *    Pass null/undefined for non-SM tenants.
+   * 2. `block.props.annotation.tagTypesConfig` — legacy per-instance persisted value.
+   * 3. Empty array.
+   */
+  getTagTypesConfig(block, hardCodedTagTypesConfigForSM) {
+    return hardCodedTagTypesConfigForSM || block.props?.annotation?.tagTypesConfig || [];
+  }
+};
+var blockRegistry = new BlockRegistry();
+
+// src/utils/isTplAnnotationEnabled.ts
+var isTplAnnotationEnabled = (tpl) => {
+  if (tpl?.general?.segment !== "publishing") return false;
+  const allBlocks = extractAllBlocksFromTpl({ tpl }).filter(
+    (b) => typeof b.comp === "string"
+  );
+  return blockRegistry.getAnnotationEnabledBlocks(allBlocks).length > 0;
+};
+
 // src/utils/getRollupPossibilities.ts
 var MAX_DEPTH_ROLLUP_POSSIBILITIES = 10;
 function getRollupPossibilities({
@@ -1454,201 +1659,6 @@ var compareAndGroupBlocks = (blocksPerTpl) => {
   return Array.from(templateGroupToFilters.values());
 };
 
-// src/blockRegistry/schemaPresets.ts
-var MONGO_SCHEMA_PRESETS = {
-  object: { type: Object },
-  string: { type: String }
-};
-var ELASTIC_MAPPING_PRESETS = {
-  largeText: {
-    properties: {
-      allText: {
-        type: "text",
-        analyzer: "LargeTextAnalyzer"
-      }
-    }
-  }
-};
-var CHUNKING_PRESETS = {
-  // Lexical-shaped text — uses semantic chunking on allText
-  lexicalSemantic: {
-    strategy: "semanticChunking",
-    windowSize: 3,
-    minSimilarityScore: 0.7
-  },
-  // Plain text input — single chunk per field
-  simpleText: {
-    strategy: "simpleChunking"
-  }
-};
-
-// src/blockRegistry/blocks/LexicalTextEditor.ts
-var LexicalTextEditor = {
-  compName: "LexicalTextEditor",
-  // Identity
-  category: "text",
-  qualQuant: "qual",
-  // Schema
-  mongoSchemaType: MONGO_SCHEMA_PRESETS.object,
-  esMapping: ELASTIC_MAPPING_PRESETS.largeText,
-  // Capabilities
-  capabilities: {
-    hasPlainText: true,
-    annotation: true,
-    aiAnnotation: true,
-    aiEnrichment: true,
-    searchable: true,
-    directDataImport: true,
-    csvExport: true,
-    translatable: true,
-    documentSummarizer: true,
-    stripFromMainOnAnnoChunkSync: true,
-    excludeFromListingProjection: true
-  },
-  // Field paths
-  fieldPaths: {
-    plainTextString: "allText",
-    searchField: "allText",
-    displayValue: "allText"
-  },
-  // Validation
-  validation: {
-    populatedCheckFn: "lexicalTextEditorHasValue",
-    formValidationFn: "lexicalTextEditorHasValue"
-  },
-  // Translation
-  translation: {
-    handlerType: "LexicalBlockHandler"
-  },
-  // Table rendering
-  tableCell: {
-    cellComp: "RichTextAsPlainTextLex",
-    sortPathSuffix: "editorState.root.children.0.children.0.text"
-  },
-  // CSV export
-  csvExport: {
-    transformFn: "KPRichLexicalEditor"
-  },
-  // Slack
-  slackFormat: {
-    handlerFn: "lexicalRichText"
-  },
-  // Batch import
-  batchImport: {
-    valueInjectorFn: "toLexicalValue"
-  },
-  // Content block option — TCI template builder & direct import UI
-  contentBlockOption: {
-    display: "Rich Text Field",
-    icon: "TextAa",
-    directImportGroupsIdx: [2, 2]
-  },
-  // Chunking config — used by okf-sub CreateChunksHandler
-  chunkingConfig: CHUNKING_PRESETS.lexicalSemantic
-};
-
-// src/blockRegistry/registry.ts
-var BlockRegistry = class {
-  constructor() {
-    this.blocks = /* @__PURE__ */ new Map();
-    this.register(LexicalTextEditor);
-  }
-  /** Register a block descriptor. */
-  register(descriptor) {
-    this.blocks.set(descriptor.compName, descriptor);
-  }
-  /** Get the full descriptor for a block type. Returns undefined if not registered. */
-  getBlock(compType) {
-    return this.blocks.get(compType);
-  }
-  /** Check if a block type is registered in the registry. */
-  isRegistered(compType) {
-    return this.blocks.has(compType);
-  }
-  /**
-   * Get all registered block descriptors that have a given capability set to a truthy value.
-   * Optionally pass a specific value to match (e.g. for enum-style capabilities).
-   */
-  getBlocksByCapability(capability, value = true) {
-    return Array.from(this.blocks.values()).filter((b) => {
-      const cap = b.capabilities[capability];
-      if (value === true) return !!cap;
-      return cap === value;
-    });
-  }
-  /**
-   * Get compType strings for all registered blocks with a given capability.
-   * Replaces scattered hardcoded arrays like:
-   *   const TEXT_FIELD_COMPONENTS = ["TextInput", "LexicalTextEditor", ...]
-   * becomes:
-   *   const TEXT_FIELD_COMPONENTS = blockRegistry.getComps('aiTextExtraction')
-   */
-  getComps(capability, value = true) {
-    return this.getBlocksByCapability(capability, value).map((b) => b.compName);
-  }
-  /** Get all registered blocks in a given category. */
-  getBlocksByCategory(category) {
-    return Array.from(this.blocks.values()).filter((b) => b.category === category);
-  }
-  /** Get compType strings for all qual blocks. */
-  getQualBlocks() {
-    return Array.from(this.blocks.values()).filter((b) => b.qualQuant === "qual").map((b) => b.compName);
-  }
-  /** Get compType strings for all quant blocks. */
-  getQuantBlocks() {
-    return Array.from(this.blocks.values()).filter((b) => b.qualQuant === "quant").map((b) => b.compName);
-  }
-  /** Check if a specific block has a specific capability. */
-  hasCapability(compType, capability) {
-    const block = this.blocks.get(compType);
-    if (!block) return false;
-    return !!block.capabilities[capability];
-  }
-  /** Get all registered block descriptors. */
-  getAll() {
-    return Array.from(this.blocks.values());
-  }
-  /**
-   * Get compName strings for all registered blocks that have a chunking config.
-   * Used by chunking pipelines and prompt-string injection (e.g. searchChunks tool
-   * description) to know which fields actually have chunks to search.
-   */
-  getCompsWithChunking() {
-    return Array.from(this.blocks.values()).filter((b) => !!b.chunkingConfig).map((b) => b.compName);
-  }
-  /**
-   * Filter a list of block instances down to those where annotation is enabled.
-   * A block is annotation-enabled if its registry capability `annotation` is true.
-   * For backwards compat with un-migrated blocks (e.g. deprecated KPRichInput/RichTextEditor),
-   * falls back to the legacy per-instance `props.annotation.enable` toggle.
-   *
-   * Today: every registered annotation-capable block (e.g. LexicalTextEditor) is auto-enabled.
-   */
-  getAnnotationEnabledBlocks(allBlocks) {
-    return allBlocks.filter((block) => {
-      const blockDef = this.blocks.get(block.comp);
-      if (blockDef) return !!blockDef.capabilities.annotation;
-      return block.props?.annotation?.enable === true;
-    });
-  }
-  /**
-   * Resolve the tagTypesConfig for a block instance.
-   *
-   * Resolution order:
-   * 1. `hardCodedTagTypesConfigForSM` — the intended self-managed default, which takes
-   *    priority over per-instance values (justifies not persisting per-block on self-managed).
-   *    Sourced from `GET_SELF_MANAGED_BASE_CONFIGS().annotation_tagTypesConfig` on BE,
-   *    or `platformConfigs.SELF_MANAGED_BASE_CONFIGS.annotation_tagTypesConfig` on FE.
-   *    Pass null/undefined for non-SM tenants.
-   * 2. `block.props.annotation.tagTypesConfig` — legacy per-instance persisted value.
-   * 3. Empty array.
-   */
-  getTagTypesConfig(block, hardCodedTagTypesConfigForSM) {
-    return hardCodedTagTypesConfigForSM || block.props?.annotation?.tagTypesConfig || [];
-  }
-};
-var blockRegistry = new BlockRegistry();
-
 // src/utils/autoGenFilterConfigsFromTpl/utils/extractAndOrganizeBlocks.ts
 var extractAndOrganizeBlocks = (selectedTpls, allTpls, { smTagTypesConfig } = {}) => {
   const extractedBlocks = {};
@@ -2488,6 +2498,7 @@ var genCleanCamelCaseId = (id) => {
   getRoutePathToTCI,
   getRoutePathToTagCategoryLanding,
   getVal,
+  isTplAnnotationEnabled,
   mergeAnnoDataIntoAnnotationsTags,
   parseSpecialConfigSyntax,
   processAuthorAndCommonFilters,