feat: added JSON types

src/decorators/meta.ts

@@ -1,7 +1,7 @@
 import { buildSymbol } from '../utils/buildSymbol';
 import { isValidKey } from '../utils/isValidKey';
 
-import type { JSONAPIDataTypes } from '../types/dataTypes';
+import type { JSONAPIDataTypes } from '../types/json/dataTypes';
 
 export const metaSymbol = buildSymbol('meta');
 

src/types/attributesObject.ts

@@ -1,3 +1,3 @@
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 
-export type JSONAPIAttributesObject = JSONAPIObject;
+export type JSONAPIAttributesObject = JSONObject;

src/types/errorObject.ts

@@ -1,7 +1,7 @@
 import type { JSONAPILinkObject } from "./linkObject";
 import type { JSONAPILinksObject } from "./linksObject";
 import type { JSONAPIMetaObject } from "./metaObject";
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 import type { Satisfies } from "./helpers/satisfies";
 
 export type JSONAPIErrorObject = Satisfies<{
@@ -15,9 +15,9 @@ export type JSONAPIErrorObject = Satisfies<{
   title: string;
   detail: string;
   source: {
-    pointer: JSONAPIObject;
+    pointer: JSONObject;
     parameter: string;
     header: string;
   }
   meta: JSONAPIMetaObject;
-}, JSONAPIObject>;
+}, JSONObject>;

src/types/index.ts

@@ -1,11 +1,8 @@
-export * from './array';
+export * from './json';
 export * from './attributesObject';
-export * from './dataTypes';
 export * from './linkObject';
 export * from './linksObject';
 export * from './metaObject';
-export * from './object';
-export * from './primitives';
 export * from './relationshipsObject';
 export * from './relationshipObject';
 export * from './resourceObject';

src/types/json/array.ts

@@ -0,0 +1,4 @@
+import type { JSONObject } from './object';
+import type { JSONPrimitives } from './primitives';
+
+export type JSONArray = JSONObject[] | JSONPrimitives[];

src/types/json/dataTypes.ts

@@ -0,0 +1,5 @@
+import type { JSONArray } from './array';
+import type { JSONObject } from './object';
+import type { JSONPrimitives } from './primitives';
+
+export type JSONDataTypes = JSONPrimitives | JSONArray | JSONObject;

src/types/json/index.ts

@@ -0,0 +1,4 @@
+export * from './dataTypes';
+export * from './primitives';
+export * from './object';
+export * from './array';

src/types/json/object.ts

@@ -0,0 +1,3 @@
+import type { JSONDataTypes } from './dataTypes';
+
+export type JSONObject = { [key: string]: JSONDataTypes };

src/types/json/primitives.ts

@@ -0,0 +1 @@
+export type JSONPrimitives = string | number | boolean | null;

src/types/jsonApiObject.ts

@@ -0,0 +1,8 @@
+import type { Satisfies } from "./helpers/satisfies";
+import type { JSONObject } from "./json/object";
+
+export type JSONAPIObject = Satisfies<{
+  verison?: string;
+  ext?: string[];
+  profile?: string[];
+}, JSONObject>;

src/types/linkObject.ts

@@ -1,5 +1,5 @@
 import type { JSONAPIMetaObject } from './metaObject';
-import type { JSONAPIObject } from './object';
+import type { JSONObject } from './json/object';
 import type { Satisfies } from './helpers/satisfies';
 
 export type JSONAPILinkObject = Satisfies<
@@ -12,5 +12,5 @@ export type JSONAPILinkObject = Satisfies<
     hreflang?: string;
     meta?: JSONAPIMetaObject;
   },
-  JSONAPIObject
+  JSONObject
 >;

src/types/linksObject.ts

@@ -1,4 +1,4 @@
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 import type { Satisfies } from "./helpers/satisfies";
 
-export type JSONAPILinksObject = Satisfies<{ [key: string]: string | JSONAPILinksObject | null }, JSONAPIObject>;
+export type JSONAPILinksObject = Satisfies<{ [key: string]: string | JSONAPILinksObject | null }, JSONObject>;

src/types/metaObject.ts

@@ -1,3 +1,3 @@
-import type { JSONAPIObject } from './object';
+import type { JSONObject } from './json/object';
 
-export type JSONAPIMetaObject = JSONAPIObject;
+export type JSONAPIMetaObject = JSONObject;

src/types/relationshipObject.ts

@@ -1,11 +1,11 @@
 import type { JSONAPIResourceIdentifierObject } from "./resourceIdentifierObject";
 import type { JSONAPILinksObject } from "./linksObject";
 import type { JSONAPIMetaObject } from "./metaObject";
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 import type { Satisfies } from "./helpers/satisfies";
 
 export type JSONAPIRelationshipObject = Satisfies<{
   data: JSONAPIResourceIdentifierObject;
   links?: JSONAPILinksObject;
   meta?: JSONAPIMetaObject;
-}, JSONAPIObject>;
+}, JSONObject>;

src/types/relationshipsObject.ts

@@ -1,5 +1,5 @@
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 import type { Satisfies } from "./helpers/satisfies";
 import type { JSONAPIRelationshipObject } from "./relationshipObject";
 
-export type JSONAPIRelationshipsObject = Satisfies<{ [key: string]: JSONAPIRelationshipObject }, JSONAPIObject>;
+export type JSONAPIRelationshipsObject = Satisfies<{ [key: string]: JSONAPIRelationshipObject }, JSONObject>;

src/types/resourceIdentifierObject.ts

@@ -1,9 +1,9 @@
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 import type { Satisfies } from "./helpers/satisfies";
 
 export type JSONAPIResourceIdentifierObject = Satisfies<{
   type: string;
 } & (
   { id: string }
   | { lid: string }
-), JSONAPIObject>;
+), JSONObject>;

src/types/resourceObject.ts

@@ -1,7 +1,7 @@
 import type { JSONAPIAttributesObject } from "./attributesObject";
 import type { JSONAPILinksObject } from "./linksObject";
 import type { JSONAPIMetaObject } from "./metaObject";
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 import type { JSONAPIRelationshipsObject } from "./relationshipsObject";
 import type { JSONAPILinkObject } from "./linkObject";
 import type { Satisfies } from "./helpers/satisfies";
@@ -17,4 +17,4 @@ export type JSONAPIResourceObject = Satisfies<
     };
     meta?: JSONAPIMetaObject;
   }
-, JSONAPIObject>;
+, JSONObject>;

src/types/topLevelObject.ts

@@ -1,28 +1,25 @@
 import type { JSONAPIErrorObject } from "./errorObject";
 import type { JSONAPILinksObject } from "./linksObject";
 import type { JSONAPIMetaObject } from "./metaObject";
-import type { JSONAPIObject } from "./object";
+import type { JSONObject } from "./json/object";
 import type { JSONAPIResourceObject } from "./resourceObject"
 import type { JSONAPILinkObject } from "./linkObject";
 import type { JSONAPIPaginationLinks } from "./paginationLinks";
 import type { JSONAPIResourceIdentifierObject } from "./resourceIdentifierObject";
 import type { Satisfies } from "./helpers/satisfies";
+import type { JSONAPIObject } from "./jsonApiObject";
 
 export type JSONAPITopLevelObject = Satisfies<({
   data: JSONAPIResourceObject | JSONAPIResourceObject[] | JSONAPIResourceIdentifierObject | JSONAPIResourceIdentifierObject[] | null;
   included?: JSONAPIResourceObject[];
 } | {
   errors: JSONAPIErrorObject[];
 }) & {
-  jsonapi?: {
-    verison?: string;
-    ext?: string[];
-    profile?: string[];
-  },
+  jsonapi?: JSONAPIObject,
   meta?: JSONAPIMetaObject;
   links?: JSONAPILinksObject & {
     self?: JSONAPILinkObject;
     related?: JSONAPILinkObject;
     describedby?: JSONAPILinkObject;
   } & JSONAPIPaginationLinks;
-}, JSONAPIObject>;
+}, JSONObject>;