feat: add casts (#1)

Author: SpiderDan98

.github/workflows/release.yaml

@@ -8,11 +8,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Update version
         run: echo "`jq '.version="${{github.ref_name}}"' package.json`" > package.json
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
       - name: Install packages

package.json

@@ -22,7 +22,8 @@
   "exports": {
     ".": {
       "import": "./dist/json-model.js",
-      "require": "./dist/json-model.umd.cjs"
+      "require": "./dist/json-model.umd.cjs",
+      "types": "./dist/index.d.ts"
     }
   },
   "scripts": {

src/index.ts

@@ -1,6 +1,2 @@
-import createModel from "@/model-factory";
-
-export type * from "@/types";
+export * from "@/types";
 export * from "@/model-factory";
-
-export default createModel;

src/model-factory.ts

@@ -1,7 +1,34 @@
 import forgetKeys from "./lib/forgetKeys";
-import type { Config, ConfigDefinition, Model } from "./types";
+import type {
+  CastFunction,
+  Config,
+  ConfigDefinition,
+  DefaultCasts,
+  Model,
+} from "./types";
+
+const defaultCasts: Record<DefaultCasts, CastFunction> = {
+  date: (date) =>
+    typeof date === "string" || typeof date === "number"
+      ? new Date(date)
+      : date,
+  float: (float) =>
+    typeof float === "number"
+      ? float
+      : typeof float === "string"
+      ? parseFloat(float)
+      : float,
+  int: (int) =>
+    typeof int === "number"
+      ? int
+      : typeof int === "string"
+      ? parseInt(int)
+      : int,
+  string: (string) => (!string ? string : String(string)),
+};
 
 let globalConfig: Config = {
+  casts: {},
   models: {},
   ignoreAttributes: [],
   resolveModelName: (model) => (model as any)?.type || "",
@@ -35,36 +62,49 @@ const resolveConfig = (baseConfig: Config, ...config: ConfigDefinition[]) =>
   );
 
 export const createModel = <Data extends object = {}>(
-  modelConfig: ConfigDefinition = {}
+  modelConfig: ConfigDefinition<keyof Data> = {}
 ) =>
   class BaseModel {
-    constructor(data: Data, localConfig: ConfigDefinition = {}) {
+    constructor(data: Data, localConfig: ConfigDefinition<keyof Data> = {}) {
       const {
         resolveModelName,
         resolveRelationshipNames,
         ignoreAttributes,
         models,
+        casts,
       } = resolveConfig(globalConfig, modelConfig, localConfig);
       const relationships = resolveRelationshipNames(data);
       const attributes = forgetKeys(data, [
         ...relationships,
         ...ignoreAttributes,
       ]);
 
+      for (const [key, cast] of Object.entries(casts)) {
+        const resolvedCast =
+          typeof cast === "string" ? defaultCasts[cast] : cast || (() => null);
+        if ((attributes as any)[key]) {
+          (attributes as any)[key] = resolvedCast((attributes as any)[key]);
+        }
+      }
+
       Object.assign(this, attributes);
 
       for (const relationship of relationships) {
         const relationData = data[relationship as keyof Data];
         const isMany = Array.isArray(relationData);
         const RelationshipModel =
-          models[resolveModelName(isMany ? relationData?.[0] : relationData)];
+          models[
+            resolveModelName(
+              isMany ? relationData?.[0] : relationData
+            ) as string
+          ];
 
         if (isMany ? !relationData.length : !relationData) {
           return;
         }
 
         if (!RelationshipModel) {
-          console.error(`Model ${relationship} not registred.`);
+          console.error(`Model ${relationship as string} not registred.`);
           return;
         }
 

src/types.ts

@@ -1,25 +1,26 @@
-export declare type ObjectKey = string | number;
+export declare type ObjectKey = string | number | symbol;
 
-export interface Config {
+export declare type CastFunction = (value: unknown) => unknown;
+export declare type DefaultCasts = "date" | "string" | "int" | "float";
+
+export interface Config<CastKeys extends ObjectKey = ObjectKey> {
+  casts: Partial<Record<CastKeys, DefaultCasts | CastFunction>>;
   models: Record<string, Model<any>>;
   ignoreAttributes: ObjectKey[];
   resolveModelName: <M extends object>(model: M) => ObjectKey;
   resolveRelationshipNames: <M extends object>(model: M) => ObjectKey[];
 }
 
-export declare type ConfigDefinition =
-  | ((config: Config) => Config)
-  | Partial<Config>;
+export declare type ConfigDefinition<CastKeys extends ObjectKey = ObjectKey> =
+  | ((config: Config<CastKeys>) => Config<CastKeys>)
+  | Partial<Config<CastKeys>>;
 
 export interface Model<Output extends object = {}> {
-  new (data: Record<string, unknown>, localConfig?: ConfigDefinition): Output;
+  new (data: object, localConfig?: ConfigDefinition<keyof Output>): Output;
 
-  create<
-    T extends object,
-    Data extends Record<string, unknown> | Record<string, unknown>[] = {}
-  >(
+  create<T extends object, Data extends object | object[] = {}>(
     this: new (...args: any[]) => T,
     data: Data,
-    localConfig?: ConfigDefinition
+    localConfig?: ConfigDefinition<keyof Output>
   ): Data extends object[] ? (Output & T)[] : Output & T;
 }