refactor: document object and service response data type

Alwatr · Nov 27, 2022 · 5346efa · 5346efa
1 parent cc52765
commit 5346efa
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 4 deletions.
diff --git a/packages/core/fetch/src/fetch.ts b/packages/core/fetch/src/fetch.ts
@@ -1,8 +1,20 @@
 import {createLogger, alwatrRegisteredList} from '@alwatr/logger';
 
-import type {FetchOptions, CacheDuplicate, CacheStrategy} from './type';
-
-export {FetchOptions, CacheDuplicate, CacheStrategy};
+import type {
+  FetchOptions,
+  CacheDuplicate,
+  CacheStrategy,
+  AlwatrDocumentObject,
+  AlwatrServiceResponse,
+} from './type';
+
+export {
+  FetchOptions,
+  CacheDuplicate,
+  CacheStrategy,
+  AlwatrDocumentObject,
+  AlwatrServiceResponse,
+};
 
 const logger = createLogger('alwatr/fetch');
 

diff --git a/packages/core/fetch/src/type.ts b/packages/core/fetch/src/type.ts
@@ -1,4 +1,3 @@
-
 export type CacheStrategy = 'network_only' | 'network_first' | 'cache_only' | 'cache_first' | 'stale_while_revalidate';
 export type CacheDuplicate = 'never' | 'always' | 'until_load' | 'auto';
 
@@ -87,3 +86,33 @@ export interface FetchOptions extends RequestInit {
    */
   token?: string;
 }
+
+export type AlwatrDocumentObject = {
+  [key: string]: unknown;
+  id: string;
+  _meta?: {
+    rev: number;
+    created: number;
+    updated: number;
+  };
+};
+
+export type AlwatrServiceResponseFailed = {
+  ok: false;
+  errorCode: string;
+  _meta?: Record<string, unknown>;
+};
+
+export type AlwatrServiceResponseSuccess<
+  TData extends Record<string, unknown>,
+  TMeta extends Record<string, unknown> = never
+> = {
+  ok: true;
+  _meta?: TMeta;
+  data: TData;
+};
+
+export type AlwatrServiceResponse<
+  TData extends Record<string, unknown>,
+  TMeta extends Record<string, unknown> = never
+> = AlwatrServiceResponseSuccess<TData, TMeta> | AlwatrServiceResponseFailed;