Improved image typings (plone#6064)

RedTurtle · Jun 1, 2024 · a2f8d59 · a2f8d59
1 parent 57c97e7
commit a2f8d59
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 13 deletions.
diff --git a/packages/types/news/6064.bugfix b/packages/types/news/6064.bugfix
@@ -0,0 +1 @@
+Improved image typings @pnicolli
diff --git a/packages/types/src/content/common.d.ts b/packages/types/src/content/common.d.ts
@@ -34,8 +34,8 @@ export type RelatedItem = {
   '@type': string;
   UID: string;
   description: string;
-  image_field: unknown;
-  image_scales: unknown;
+  image_field: string;
+  image_scales: Record<string, Image> | null;
   review_state: string;
   title: string;
 };
@@ -46,7 +46,7 @@ export type ImageScale = {
   width: number;
 };
 
-export type PreviewImage = {
+export type Image = {
   'content-type': string;
   download: string;
   filename: string;

diff --git a/packages/types/src/content/index.d.ts b/packages/types/src/content/index.d.ts
@@ -1,9 +1,4 @@
-import type {
-  Expanders,
-  ContainedItem,
-  PreviewImage,
-  RelatedItem,
-} from './common';
+import type { Expanders, ContainedItem, Image, RelatedItem } from './common';
 
 export interface Content {
   '@components': Expanders;
@@ -33,6 +28,7 @@ export interface Content {
   expires: string | null;
   id: string;
   is_folderish: boolean;
+  image?: Image | null;
   items: ContainedItem[];
   items_total: number;
   language: unknown;
@@ -68,7 +64,7 @@ export interface Content {
     title: string;
   };
   preview_caption: string | null;
-  preview_image: PreviewImage;
+  preview_image?: Image | null;
   previous_item: {
     '@id': string;
     '@type': string;
@@ -81,7 +77,7 @@ export interface Content {
   subjects: [];
   table_of_contents: boolean | null;
   title: string;
-  type_tile: string | null;
+  type_title: string | null;
   version: number | null;
   versioning_enabled: boolean | null;
   working_copy: unknown;

diff --git a/packages/types/src/services/common.d.ts b/packages/types/src/services/common.d.ts
@@ -1,4 +1,4 @@
-import type { PreviewImage } from '../content/common';
+import type { Image } from '../content/common';
 
 export interface Brain {
   '@id': string;
@@ -33,7 +33,7 @@ export interface Brain {
   head_title: string | null; // TODO is this correct?
   id: string;
   image_field: string; // TODO could this be more specific?
-  image_scales: Record<string, PreviewImage> | null; // TODO could this be more specific?
+  image_scales: Record<string, Image> | null; // TODO could this be more specific?
   in_response_to: string | null; // TODO is this correct?
   is_folderish: boolean;
   last_comment_date: string | null;