feat: expose WithId (#722)

contentful · May 18, 2021 · 80189db · 80189db
1 parent 0d763de
commit 80189db
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 7 deletions.
diff --git a/lib/types/index.ts b/lib/types/index.ts
@@ -70,6 +70,7 @@ export type {
   Items,
   Link,
   WithOptionalId,
+  WithId,
 } from './utils'
 
 export type { WindowAPI } from './window.types'
diff --git a/lib/types/space.types.ts b/lib/types/space.types.ts
@@ -1,4 +1,3 @@
-/* Space API */
 import { Entry } from './entry.types'
 import {
   Asset,

diff --git a/lib/types/utils.ts b/lib/types/utils.ts
@@ -1,14 +1,19 @@
-type SysWithId = {
+type Sys = {
   id: string
+  type: string
+  [key: string]: any
 }
 
-export type WithOptionalId<Type extends { sys: unknown }> = Omit<Type, 'sys'> & {
-  sys?: Partial<Omit<Type['sys'], 'id'> & SysWithId>
+type Entity = {
+  sys: Sys
+  [key: string]: any
 }
 
-export type WithId<Type extends { sys: unknown }> = Omit<Type, 'sys'> & {
-  sys: Partial<Omit<Type['sys'], 'id'>> & SysWithId
-}
+type Optional<Type, Keys extends keyof Type> = Partial<Type> & Omit<Type, Keys>
+
+export type WithSysWithAtLeastId = { sys: { id: string; [key: string]: any } }
+export type WithId<Type extends Entity> = Omit<Type, 'sys'> & WithSysWithAtLeastId
+export type WithOptionalId<Type extends Entity> = Optional<Type, 'sys'> | WithId<Type>
 
 export interface Link<LinkType = string, Type = string> {
   sys: {