simplentity 0.1.1 → 1.0.0-alpha.0

package/dist/bun/entity.d.ts

@@ -14,29 +14,51 @@ type EntityPropInputResolver<T extends EntityConfig> = {
 } & {
     [K in keyof Omit<T, RequiredFieldKeys<T>>]?: FieldTypeResolver<T[K]>;
 };
+type MethodDefinition = {
+    [key: string]: (...args: any[]) => any;
+};
+interface EntityInterface<C extends EntityConfig> {
+    get: <K extends keyof C>(key: K) => EntityConfigTypeResolver<C>[K];
+    toJSON: () => EntityConfigTypeResolver<C>;
+}
 /**
- * Create an entity class with the given fields
- * @param fields
+ * Creates an entity factory function that allows defining fields and optional methods for an entity.
+ * The returned factory provides a `create` method to instantiate entities with the specified fields
+ * and methods, while also supporting default values and runtime property manipulation.
+ *
+ * @template C - The configuration type for the entity fields.
+ * @template D - The type of the methods defined for the entity.
+ *
+ * @param fields - An object defining the fields of the entity. Each field should include its configuration
+ *                 and a method to retrieve its default value.
+ * @param methodDefinitionFunction - An optional function that defines additional methods for the entity.
+ *                                   It receives an object with `set` and `get` functions to manipulate
+ *                                   the entity's properties.
+ *
+ * @returns An object with a `create` method. The `create` method accepts an input object to initialize
+ *          the entity's properties and returns an entity instance with the defined fields, methods,
+ *          and utility functions (`get`, `set`, `toJSON`).
+ *
+ * @example
+ * ```typescript
+ * const userFactory = entity({
+ *   name: string(),
+ *   age: number().default(18),
+ *   isActive: boolean().default(true),
+ * }, ({ set, get }) => ({
+ *   incrementAge: () => set('age', get('age') + 1),
+ * }));
+ *
+ * const user = userFactory.create({ name: 'John' });
+ * console.log(user.props); // { name: 'John', age: 18, isActive: true }
+ * user.incrementAge();
+ * console.log(user.props.age); // 19
+ * ```
  */
-export declare const entity: <Config extends EntityConfig>(fields: Config) => {
-    new (props: EntityPropInputResolver<Config>): {
-        readonly "__#1@#entityConfig": Config;
-        "__#1@#props": EntityConfigTypeResolver<Config>;
-        /**
-         * Get the value of the field by key
-         * @param key
-         */
-        get<K extends keyof Config>(key: K): EntityConfigTypeResolver<Config>[K];
-        /**
-         * Set the value of the field by key
-         *
-         * WARNING: This method should be called only from the methods of the entity.
-         * Its accessor should be protected but TypeScript declaration does not allow protected methods in exported classes.
-         * @param key
-         * @param value
-         */
-        set<K extends keyof Config>(key: K, value: EntityConfigTypeResolver<Config>[K]): void;
-        toJSON(): EntityConfigTypeResolver<Config>;
-    };
+export declare function entity<C extends EntityConfig, D extends MethodDefinition>(fields: C, methodDefinitionFunction?: (params: {
+    set: <K extends keyof C>(key: K, value: EntityConfigTypeResolver<C>[K]) => void;
+    get: <K extends keyof C>(key: K) => EntityConfigTypeResolver<C>[K];
+}) => D): {
+    create(props: EntityPropInputResolver<C>): EntityInterface<C> & D;
 };
 export {};

package/dist/bun/field.d.ts

@@ -24,7 +24,7 @@ type HasDefault<T extends ConfigurableFieldBase<unknown>> = T & {
 };
 export declare abstract class Field<T> implements ConfigurableFieldBase<T> {
     _: FieldConfig<T>;
-    protected config: FieldRuntimeConfig<T>;
+    config: FieldRuntimeConfig<T>;
     constructor();
     notRequired(): NotRequired<this>;
     default(value: T): HasDefault<this>;

package/dist/bun/index.js

@@ -1,2 +1,2 @@
 // @bun
-class f{#u;#t;constructor(t,o){this.#u=o,Object.freeze(this.#u),this.#t=Object.entries(o).reduce((e,[n,a])=>{let r=t[n]??a.getDefaultValue();if(a.getConfig().hasDefault&&r===void 0)throw new Error(`The field "${n}" has a default value but undefined was provided.`);return e[n]=r,e},{})}get(t){return this.#t[t]}set(t,o){this.#t[t]=o}toJSON(){return this.#t}}var R=(t)=>{return class extends f{constructor(o){super(o,t)}}};class u{config;constructor(){this.config={notRequired:!1,hasDefault:!1,default:void 0}}notRequired(){return this.config.notRequired=!0,this}default(t){return this.config.default=t,this.config.hasDefault=!0,this}defaultFn(t){return this.config.defaultFn=t,this.config.hasDefault=!0,this}getConfig(){return this.config}getDefaultValue(){return this.config.default??this.config.defaultFn?.()}}class i extends u{}var s=()=>{return new i};class h extends u{}var T=()=>{return new h};class g extends u{}var m=()=>{return new g};class d extends u{}var l=()=>{return new d};export{l as string,m as number,R as entity,T as date,s as boolean};
+function d(n,q){return{create(D){let f=Object.entries(n).reduce((u,[o,r])=>{let e=D[o]??r.getDefaultValue();if(r.getConfig().hasDefault&&e===void 0)u[o]=r.getDefaultValue();else u[o]=e;return u},{}),b=(u,o)=>{f[u]=o},a=(u)=>{return f[u]},p=()=>{return f},C=q?.({set:b,get:a})??{};return{get:a,toJSON:p,...C}}}}class t{config;constructor(){this.config={notRequired:!1,hasDefault:!1,default:void 0}}notRequired(){return this.config.notRequired=!0,this}default(n){return this.config.default=n,this.config.hasDefault=!0,this}defaultFn(n){return this.config.defaultFn=n,this.config.hasDefault=!0,this}getConfig(){return this.config}getDefaultValue(){return this.config.default??this.config.defaultFn?.()}}class i extends t{}var s=()=>{return new i};class h extends t{}var T=()=>{return new h};class g extends t{}var R=()=>{return new g};class l extends t{}var m=()=>{return new l};export{m as string,R as number,d as entity,T as date,s as boolean};

package/dist/cjs/entity.cjs

@@ -23,54 +23,39 @@ __export(entity_exports, {
   entity: () => entity
 });
 module.exports = __toCommonJS(entity_exports);
-var Entity = class {
-  #entityConfig;
-  #props;
-  constructor(props, entityConfig) {
-    this.#entityConfig = entityConfig;
-    Object.freeze(this.#entityConfig);
-    this.#props = Object.entries(entityConfig).reduce(
-      (acc, [key, field]) => {
-        const value = props[key] ?? field.getDefaultValue();
-        if (field.getConfig().hasDefault && value === void 0) {
-          throw new Error(`The field "${key}" has a default value but undefined was provided.`);
-        }
-        acc[key] = value;
-        return acc;
-      },
-      {}
-    );
-  }
-  /**
-   * Get the value of the field by key
-   * @param key
-   */
-  get(key) {
-    return this.#props[key];
-  }
-  /**
-   * Set the value of the field by key
-   *
-   * WARNING: This method should be called only from the methods of the entity.
-   * Its accessor should be protected but TypeScript declaration does not allow protected methods in exported classes.
-   * @param key
-   * @param value
-   */
-  set(key, value) {
-    this.#props[key] = value;
-  }
-  // biome-ignore lint/style/useNamingConvention: toJSON is a name to be used in JSON.stringify
-  toJSON() {
-    return this.#props;
-  }
-};
-var entity = (fields) => {
-  return class extends Entity {
-    constructor(props) {
-      super(props, fields);
+function entity(fields, methodDefinitionFunction) {
+  return {
+    create(props) {
+      const assignedProps = Object.entries(fields).reduce(
+        (acc, [key, field]) => {
+          const value = props[key] ?? field.getDefaultValue();
+          if (field.getConfig().hasDefault && value === void 0) {
+            acc[key] = field.getDefaultValue();
+          } else {
+            acc[key] = value;
+          }
+          return acc;
+        },
+        {}
+      );
+      const set = (key, value) => {
+        assignedProps[key] = value;
+      };
+      const get = (key) => {
+        return assignedProps[key];
+      };
+      const toJSON = () => {
+        return assignedProps;
+      };
+      const methods = methodDefinitionFunction?.({ set, get }) ?? {};
+      return {
+        get,
+        toJSON,
+        ...methods
+      };
     }
   };
-};
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   entity

package/dist/cjs/entity.d.ts

@@ -14,29 +14,51 @@ type EntityPropInputResolver<T extends EntityConfig> = {
 } & {
     [K in keyof Omit<T, RequiredFieldKeys<T>>]?: FieldTypeResolver<T[K]>;
 };
+type MethodDefinition = {
+    [key: string]: (...args: any[]) => any;
+};
+interface EntityInterface<C extends EntityConfig> {
+    get: <K extends keyof C>(key: K) => EntityConfigTypeResolver<C>[K];
+    toJSON: () => EntityConfigTypeResolver<C>;
+}
 /**
- * Create an entity class with the given fields
- * @param fields
+ * Creates an entity factory function that allows defining fields and optional methods for an entity.
+ * The returned factory provides a `create` method to instantiate entities with the specified fields
+ * and methods, while also supporting default values and runtime property manipulation.
+ *
+ * @template C - The configuration type for the entity fields.
+ * @template D - The type of the methods defined for the entity.
+ *
+ * @param fields - An object defining the fields of the entity. Each field should include its configuration
+ *                 and a method to retrieve its default value.
+ * @param methodDefinitionFunction - An optional function that defines additional methods for the entity.
+ *                                   It receives an object with `set` and `get` functions to manipulate
+ *                                   the entity's properties.
+ *
+ * @returns An object with a `create` method. The `create` method accepts an input object to initialize
+ *          the entity's properties and returns an entity instance with the defined fields, methods,
+ *          and utility functions (`get`, `set`, `toJSON`).
+ *
+ * @example
+ * ```typescript
+ * const userFactory = entity({
+ *   name: string(),
+ *   age: number().default(18),
+ *   isActive: boolean().default(true),
+ * }, ({ set, get }) => ({
+ *   incrementAge: () => set('age', get('age') + 1),
+ * }));
+ *
+ * const user = userFactory.create({ name: 'John' });
+ * console.log(user.props); // { name: 'John', age: 18, isActive: true }
+ * user.incrementAge();
+ * console.log(user.props.age); // 19
+ * ```
  */
-export declare const entity: <Config extends EntityConfig>(fields: Config) => {
-    new (props: EntityPropInputResolver<Config>): {
-        readonly "__#1@#entityConfig": Config;
-        "__#1@#props": EntityConfigTypeResolver<Config>;
-        /**
-         * Get the value of the field by key
-         * @param key
-         */
-        get<K extends keyof Config>(key: K): EntityConfigTypeResolver<Config>[K];
-        /**
-         * Set the value of the field by key
-         *
-         * WARNING: This method should be called only from the methods of the entity.
-         * Its accessor should be protected but TypeScript declaration does not allow protected methods in exported classes.
-         * @param key
-         * @param value
-         */
-        set<K extends keyof Config>(key: K, value: EntityConfigTypeResolver<Config>[K]): void;
-        toJSON(): EntityConfigTypeResolver<Config>;
-    };
+export declare function entity<C extends EntityConfig, D extends MethodDefinition>(fields: C, methodDefinitionFunction?: (params: {
+    set: <K extends keyof C>(key: K, value: EntityConfigTypeResolver<C>[K]) => void;
+    get: <K extends keyof C>(key: K) => EntityConfigTypeResolver<C>[K];
+}) => D): {
+    create(props: EntityPropInputResolver<C>): EntityInterface<C> & D;
 };
 export {};

package/dist/cjs/field.d.ts

@@ -24,7 +24,7 @@ type HasDefault<T extends ConfigurableFieldBase<unknown>> = T & {
 };
 export declare abstract class Field<T> implements ConfigurableFieldBase<T> {
     _: FieldConfig<T>;
-    protected config: FieldRuntimeConfig<T>;
+    config: FieldRuntimeConfig<T>;
     constructor();
     notRequired(): NotRequired<this>;
     default(value: T): HasDefault<this>;

package/dist/cjs/index.cjs

@@ -29,54 +29,39 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/entity.ts
-var Entity = class {
-  #entityConfig;
-  #props;
-  constructor(props, entityConfig) {
-    this.#entityConfig = entityConfig;
-    Object.freeze(this.#entityConfig);
-    this.#props = Object.entries(entityConfig).reduce(
-      (acc, [key, field]) => {
-        const value = props[key] ?? field.getDefaultValue();
-        if (field.getConfig().hasDefault && value === void 0) {
-          throw new Error(`The field "${key}" has a default value but undefined was provided.`);
-        }
-        acc[key] = value;
-        return acc;
-      },
-      {}
-    );
-  }
-  /**
-   * Get the value of the field by key
-   * @param key
-   */
-  get(key) {
-    return this.#props[key];
-  }
-  /**
-   * Set the value of the field by key
-   *
-   * WARNING: This method should be called only from the methods of the entity.
-   * Its accessor should be protected but TypeScript declaration does not allow protected methods in exported classes.
-   * @param key
-   * @param value
-   */
-  set(key, value) {
-    this.#props[key] = value;
-  }
-  // biome-ignore lint/style/useNamingConvention: toJSON is a name to be used in JSON.stringify
-  toJSON() {
-    return this.#props;
-  }
-};
-var entity = (fields) => {
-  return class extends Entity {
-    constructor(props) {
-      super(props, fields);
+function entity(fields, methodDefinitionFunction) {
+  return {
+    create(props) {
+      const assignedProps = Object.entries(fields).reduce(
+        (acc, [key, field]) => {
+          const value = props[key] ?? field.getDefaultValue();
+          if (field.getConfig().hasDefault && value === void 0) {
+            acc[key] = field.getDefaultValue();
+          } else {
+            acc[key] = value;
+          }
+          return acc;
+        },
+        {}
+      );
+      const set = (key, value) => {
+        assignedProps[key] = value;
+      };
+      const get = (key) => {
+        return assignedProps[key];
+      };
+      const toJSON = () => {
+        return assignedProps;
+      };
+      const methods = methodDefinitionFunction?.({ set, get }) ?? {};
+      return {
+        get,
+        toJSON,
+        ...methods
+      };
     }
   };
-};
+}
 
 // src/field.ts
 var Field = class {

package/dist/entity.d.ts

@@ -14,29 +14,51 @@ type EntityPropInputResolver<T extends EntityConfig> = {
 } & {
     [K in keyof Omit<T, RequiredFieldKeys<T>>]?: FieldTypeResolver<T[K]>;
 };
+type MethodDefinition = {
+    [key: string]: (...args: any[]) => any;
+};
+interface EntityInterface<C extends EntityConfig> {
+    get: <K extends keyof C>(key: K) => EntityConfigTypeResolver<C>[K];
+    toJSON: () => EntityConfigTypeResolver<C>;
+}
 /**
- * Create an entity class with the given fields
- * @param fields
+ * Creates an entity factory function that allows defining fields and optional methods for an entity.
+ * The returned factory provides a `create` method to instantiate entities with the specified fields
+ * and methods, while also supporting default values and runtime property manipulation.
+ *
+ * @template C - The configuration type for the entity fields.
+ * @template D - The type of the methods defined for the entity.
+ *
+ * @param fields - An object defining the fields of the entity. Each field should include its configuration
+ *                 and a method to retrieve its default value.
+ * @param methodDefinitionFunction - An optional function that defines additional methods for the entity.
+ *                                   It receives an object with `set` and `get` functions to manipulate
+ *                                   the entity's properties.
+ *
+ * @returns An object with a `create` method. The `create` method accepts an input object to initialize
+ *          the entity's properties and returns an entity instance with the defined fields, methods,
+ *          and utility functions (`get`, `set`, `toJSON`).
+ *
+ * @example
+ * ```typescript
+ * const userFactory = entity({
+ *   name: string(),
+ *   age: number().default(18),
+ *   isActive: boolean().default(true),
+ * }, ({ set, get }) => ({
+ *   incrementAge: () => set('age', get('age') + 1),
+ * }));
+ *
+ * const user = userFactory.create({ name: 'John' });
+ * console.log(user.props); // { name: 'John', age: 18, isActive: true }
+ * user.incrementAge();
+ * console.log(user.props.age); // 19
+ * ```
  */
-export declare const entity: <Config extends EntityConfig>(fields: Config) => {
-    new (props: EntityPropInputResolver<Config>): {
-        readonly "__#1@#entityConfig": Config;
-        "__#1@#props": EntityConfigTypeResolver<Config>;
-        /**
-         * Get the value of the field by key
-         * @param key
-         */
-        get<K extends keyof Config>(key: K): EntityConfigTypeResolver<Config>[K];
-        /**
-         * Set the value of the field by key
-         *
-         * WARNING: This method should be called only from the methods of the entity.
-         * Its accessor should be protected but TypeScript declaration does not allow protected methods in exported classes.
-         * @param key
-         * @param value
-         */
-        set<K extends keyof Config>(key: K, value: EntityConfigTypeResolver<Config>[K]): void;
-        toJSON(): EntityConfigTypeResolver<Config>;
-    };
+export declare function entity<C extends EntityConfig, D extends MethodDefinition>(fields: C, methodDefinitionFunction?: (params: {
+    set: <K extends keyof C>(key: K, value: EntityConfigTypeResolver<C>[K]) => void;
+    get: <K extends keyof C>(key: K) => EntityConfigTypeResolver<C>[K];
+}) => D): {
+    create(props: EntityPropInputResolver<C>): EntityInterface<C> & D;
 };
 export {};

package/dist/entity.js

@@ -1,52 +1,37 @@
 // src/entity.ts
-var Entity = class {
-  #entityConfig;
-  #props;
-  constructor(props, entityConfig) {
-    this.#entityConfig = entityConfig;
-    Object.freeze(this.#entityConfig);
-    this.#props = Object.entries(entityConfig).reduce(
-      (acc, [key, field]) => {
-        const value = props[key] ?? field.getDefaultValue();
-        if (field.getConfig().hasDefault && value === void 0) {
-          throw new Error(`The field "${key}" has a default value but undefined was provided.`);
-        }
-        acc[key] = value;
-        return acc;
-      },
-      {}
-    );
-  }
-  /**
-   * Get the value of the field by key
-   * @param key
-   */
-  get(key) {
-    return this.#props[key];
-  }
-  /**
-   * Set the value of the field by key
-   *
-   * WARNING: This method should be called only from the methods of the entity.
-   * Its accessor should be protected but TypeScript declaration does not allow protected methods in exported classes.
-   * @param key
-   * @param value
-   */
-  set(key, value) {
-    this.#props[key] = value;
-  }
-  // biome-ignore lint/style/useNamingConvention: toJSON is a name to be used in JSON.stringify
-  toJSON() {
-    return this.#props;
-  }
-};
-var entity = (fields) => {
-  return class extends Entity {
-    constructor(props) {
-      super(props, fields);
+function entity(fields, methodDefinitionFunction) {
+  return {
+    create(props) {
+      const assignedProps = Object.entries(fields).reduce(
+        (acc, [key, field]) => {
+          const value = props[key] ?? field.getDefaultValue();
+          if (field.getConfig().hasDefault && value === void 0) {
+            acc[key] = field.getDefaultValue();
+          } else {
+            acc[key] = value;
+          }
+          return acc;
+        },
+        {}
+      );
+      const set = (key, value) => {
+        assignedProps[key] = value;
+      };
+      const get = (key) => {
+        return assignedProps[key];
+      };
+      const toJSON = () => {
+        return assignedProps;
+      };
+      const methods = methodDefinitionFunction?.({ set, get }) ?? {};
+      return {
+        get,
+        toJSON,
+        ...methods
+      };
     }
   };
-};
+}
 export {
   entity
 };

package/dist/field.d.ts

@@ -24,7 +24,7 @@ type HasDefault<T extends ConfigurableFieldBase<unknown>> = T & {
 };
 export declare abstract class Field<T> implements ConfigurableFieldBase<T> {
     _: FieldConfig<T>;
-    protected config: FieldRuntimeConfig<T>;
+    config: FieldRuntimeConfig<T>;
     constructor();
     notRequired(): NotRequired<this>;
     default(value: T): HasDefault<this>;

package/dist/index.js

@@ -1,52 +1,37 @@
 // src/entity.ts
-var Entity = class {
-  #entityConfig;
-  #props;
-  constructor(props, entityConfig) {
-    this.#entityConfig = entityConfig;
-    Object.freeze(this.#entityConfig);
-    this.#props = Object.entries(entityConfig).reduce(
-      (acc, [key, field]) => {
-        const value = props[key] ?? field.getDefaultValue();
-        if (field.getConfig().hasDefault && value === void 0) {
-          throw new Error(`The field "${key}" has a default value but undefined was provided.`);
-        }
-        acc[key] = value;
-        return acc;
-      },
-      {}
-    );
-  }
-  /**
-   * Get the value of the field by key
-   * @param key
-   */
-  get(key) {
-    return this.#props[key];
-  }
-  /**
-   * Set the value of the field by key
-   *
-   * WARNING: This method should be called only from the methods of the entity.
-   * Its accessor should be protected but TypeScript declaration does not allow protected methods in exported classes.
-   * @param key
-   * @param value
-   */
-  set(key, value) {
-    this.#props[key] = value;
-  }
-  // biome-ignore lint/style/useNamingConvention: toJSON is a name to be used in JSON.stringify
-  toJSON() {
-    return this.#props;
-  }
-};
-var entity = (fields) => {
-  return class extends Entity {
-    constructor(props) {
-      super(props, fields);
+function entity(fields, methodDefinitionFunction) {
+  return {
+    create(props) {
+      const assignedProps = Object.entries(fields).reduce(
+        (acc, [key, field]) => {
+          const value = props[key] ?? field.getDefaultValue();
+          if (field.getConfig().hasDefault && value === void 0) {
+            acc[key] = field.getDefaultValue();
+          } else {
+            acc[key] = value;
+          }
+          return acc;
+        },
+        {}
+      );
+      const set = (key, value) => {
+        assignedProps[key] = value;
+      };
+      const get = (key) => {
+        return assignedProps[key];
+      };
+      const toJSON = () => {
+        return assignedProps;
+      };
+      const methods = methodDefinitionFunction?.({ set, get }) ?? {};
+      return {
+        get,
+        toJSON,
+        ...methods
+      };
     }
   };
-};
+}
 
 // src/field.ts
 var Field = class {

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "simplentity",
-  "version": "0.1.1",
+  "version": "1.0.0-alpha.0",
+  "description": "A type-safe entity library for TypeScript.",
   "type": "module",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",