Introuduce private custom field option (#4314)

superdesk · Aug 24, 2023 · af8cd7f · af8cd7f
1 parent 7604ef1
commit af8cd7f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/scripts/apps/vocabularies/controllers/VocabularyEditController.tsx b/scripts/apps/vocabularies/controllers/VocabularyEditController.tsx
@@ -226,7 +226,7 @@ export function VocabularyEditController(
 
     const fields = getFields();
 
-    $scope.customFieldTypes = Object.keys(fields).map((id) => ({
+    $scope.customFieldTypes = Object.keys(fields).filter((id) => fields[id].private !== true).map((id) => ({
         id: id,
         label: fields[id].label,
     }));

diff --git a/scripts/core/superdesk-api.d.ts b/scripts/core/superdesk-api.d.ts
@@ -3359,6 +3359,10 @@ declare module 'superdesk-api' {
         editorComponent: React.ComponentClass<IEditorComponentProps<IValueOperational, IConfig, IUserPreferences>>;
         previewComponent: React.ComponentType<IPreviewComponentProps<IValueOperational, IConfig>>;
 
+        /**
+         * Allows for the field to be hidden from custom field type config
+         */
+        private?: boolean;
         /**
          * Must return `true` if not empty.
          */

diff --git a/scripts/extensions/broadcasting/src/authoring-fields/subitems/index.tsx b/scripts/extensions/broadcasting/src/authoring-fields/subitems/index.tsx
@@ -17,15 +17,21 @@ export type ISubitemsValueOperational = Array<ISubitem>;
 export type ISubitemsValueStorage = ISubitemsValueOperational;
 export type ISubitemsFieldConfig = never;
 export type ISubitemsUserPreferences = never;
+export type ISubItemsFieldType = ICustomFieldType<
+    ISubitemsValueOperational,
+    ISubitemsValueStorage,
+    ISubitemsFieldConfig,
+    ISubitemsUserPreferences
+>;
 
-export function getSubItemsField()
-: ICustomFieldType<ISubitemsValueOperational, ISubitemsValueStorage, ISubitemsFieldConfig, ISubitemsUserPreferences> {
+export function getSubItemsField(): ISubItemsFieldType {
     const field: ReturnType<typeof getSubItemsField> = {
         id: SUBITEMS_FIELD_TYPE,
         label: gettext('Subitems'),
         editorComponent: Editor,
         previewComponent: Preview,
 
+        private: true,
         hasValue: (valueOperational) => valueOperational != null && Object.keys(valueOperational).length > 0,
         getEmptyValue: () => [],