simplentity 0.1.0

package/README.md

@@ -0,0 +1,60 @@
+# simplentity
+
+The simplentity is a simple typed entity library.
+It provides the implementation of type-safe entities and manipulation.
+
+> [!NOTE]
+> I created the library to learn TypeScript and the type system for me.
+> So, it may not be suitable for production use.
+
+
+## Installation
+Coming soon...
+
+## Usage
+
+```typescript
+import {entity, number, string, boolean} from 'simplentity';
+
+// Define a user entity
+class User extends entity({
+  id: string().defaultFn(() => randomUUID()), // randomUUID is a third-party library. Not included.
+  name: string(),
+  age: number().notRequired(),
+  isActive: boolean().default(true),
+}) {
+  activate(): void {
+    // You can get suggestions for the properties of the entity.
+    this.set('isActive', true);
+  }
+  
+  deactivate(): void {
+    this.set('isActive', false);
+  }
+}
+
+// Properties that have NotRequired or Default(Fn) are optional.
+// If a property has a default value, it is automatically assigned to the property when you create the entity instance.
+const user = new User({
+  name: 'John Doe',
+})
+/*
+{
+  id: 'd02daa87-3984-4c6f-be9b-a13a478354b5',
+  name: 'John Doe',
+  isActive: true,
+}
+*/
+
+// You can get property values via the get method.
+// Of course, you can get suggestions for the properties of the entity.
+const name = user.get('name'); // 'John Doe'
+```
+
+## Todo
+- [ ] Add more built-in types
+- [ ] Validation
+- [ ] JSON serialization
+- [ ] Custom field types
+- [ ] Custom field validation
+- [ ] Custom field serialization

package/dist/bun/entity.d.ts

@@ -0,0 +1,42 @@
+import type { Field } from "./field.ts";
+type EntityConfig = {
+    [key: string]: Field<unknown>;
+};
+type EntityConfigTypeResolver<T extends EntityConfig> = {
+    [K in keyof T]: T[K]["_"]["notRequired"] extends true ? FieldTypeResolver<T[K]> | undefined : FieldTypeResolver<T[K]>;
+};
+type RequiredFieldKeys<T extends EntityConfig> = {
+    [K in keyof T]: T[K]["_"]["notRequired"] extends true ? never : T[K]["_"]["hasDefault"] extends true ? never : K;
+}[keyof T];
+type FieldTypeResolver<T> = T extends Field<infer U> ? U : never;
+type EntityPropInputResolver<T extends EntityConfig> = {
+    [K in RequiredFieldKeys<T>]: FieldTypeResolver<T[K]>;
+} & {
+    [K in keyof Omit<T, RequiredFieldKeys<T>>]?: FieldTypeResolver<T[K]>;
+};
+/**
+ * Create an entity class with the given fields
+ * @param fields
+ */
+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 {};

package/dist/bun/field.d.ts

@@ -0,0 +1,35 @@
+type FieldConfig<T> = {
+    notRequired: boolean;
+    hasDefault: boolean;
+    data: T;
+};
+type FieldRuntimeConfig<T> = {
+    notRequired: boolean;
+    hasDefault: boolean;
+    default: T | undefined;
+    defaultFn?: () => T;
+};
+interface ConfigurableFieldBase<T> {
+    _: FieldConfig<T>;
+}
+type NotRequired<T extends ConfigurableFieldBase<unknown>> = T & {
+    _: {
+        notRequired: true;
+    };
+};
+type HasDefault<T extends ConfigurableFieldBase<unknown>> = T & {
+    _: {
+        hasDefault: true;
+    };
+};
+export declare abstract class Field<T> implements ConfigurableFieldBase<T> {
+    _: FieldConfig<T>;
+    protected config: FieldRuntimeConfig<T>;
+    constructor();
+    notRequired(): NotRequired<this>;
+    default(value: T): HasDefault<this>;
+    defaultFn(fn: () => T): HasDefault<this>;
+    getConfig(): FieldRuntimeConfig<T>;
+    getDefaultValue(): T | undefined;
+}
+export {};

package/dist/bun/index.d.ts

@@ -0,0 +1,3 @@
+import { entity } from "./entity.ts";
+import { boolean, date, number, string } from "./fields/index.ts";
+export { entity, string, number, boolean, date };

package/dist/bun/index.js

@@ -0,0 +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};

package/dist/cjs/entity.cjs

@@ -0,0 +1,77 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/entity.ts
+var entity_exports = {};
+__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);
+    }
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  entity
+});

package/dist/cjs/entity.d.ts

@@ -0,0 +1,42 @@
+import type { Field } from "./field.ts";
+type EntityConfig = {
+    [key: string]: Field<unknown>;
+};
+type EntityConfigTypeResolver<T extends EntityConfig> = {
+    [K in keyof T]: T[K]["_"]["notRequired"] extends true ? FieldTypeResolver<T[K]> | undefined : FieldTypeResolver<T[K]>;
+};
+type RequiredFieldKeys<T extends EntityConfig> = {
+    [K in keyof T]: T[K]["_"]["notRequired"] extends true ? never : T[K]["_"]["hasDefault"] extends true ? never : K;
+}[keyof T];
+type FieldTypeResolver<T> = T extends Field<infer U> ? U : never;
+type EntityPropInputResolver<T extends EntityConfig> = {
+    [K in RequiredFieldKeys<T>]: FieldTypeResolver<T[K]>;
+} & {
+    [K in keyof Omit<T, RequiredFieldKeys<T>>]?: FieldTypeResolver<T[K]>;
+};
+/**
+ * Create an entity class with the given fields
+ * @param fields
+ */
+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 {};

package/dist/cjs/field.cjs

@@ -0,0 +1,59 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/field.ts
+var field_exports = {};
+__export(field_exports, {
+  Field: () => Field
+});
+module.exports = __toCommonJS(field_exports);
+var Field = class {
+  config;
+  constructor() {
+    this.config = {
+      notRequired: false,
+      hasDefault: false,
+      default: void 0
+    };
+  }
+  notRequired() {
+    this.config.notRequired = true;
+    return this;
+  }
+  default(value) {
+    this.config.default = value;
+    this.config.hasDefault = true;
+    return this;
+  }
+  defaultFn(fn) {
+    this.config.defaultFn = fn;
+    this.config.hasDefault = true;
+    return this;
+  }
+  getConfig() {
+    return this.config;
+  }
+  getDefaultValue() {
+    return this.config.default ?? this.config.defaultFn?.();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Field
+});

package/dist/cjs/field.d.ts

@@ -0,0 +1,35 @@
+type FieldConfig<T> = {
+    notRequired: boolean;
+    hasDefault: boolean;
+    data: T;
+};
+type FieldRuntimeConfig<T> = {
+    notRequired: boolean;
+    hasDefault: boolean;
+    default: T | undefined;
+    defaultFn?: () => T;
+};
+interface ConfigurableFieldBase<T> {
+    _: FieldConfig<T>;
+}
+type NotRequired<T extends ConfigurableFieldBase<unknown>> = T & {
+    _: {
+        notRequired: true;
+    };
+};
+type HasDefault<T extends ConfigurableFieldBase<unknown>> = T & {
+    _: {
+        hasDefault: true;
+    };
+};
+export declare abstract class Field<T> implements ConfigurableFieldBase<T> {
+    _: FieldConfig<T>;
+    protected config: FieldRuntimeConfig<T>;
+    constructor();
+    notRequired(): NotRequired<this>;
+    default(value: T): HasDefault<this>;
+    defaultFn(fn: () => T): HasDefault<this>;
+    getConfig(): FieldRuntimeConfig<T>;
+    getDefaultValue(): T | undefined;
+}
+export {};

package/dist/cjs/fields/boolean.cjs

@@ -0,0 +1,68 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/fields/boolean.ts
+var boolean_exports = {};
+__export(boolean_exports, {
+  boolean: () => boolean
+});
+module.exports = __toCommonJS(boolean_exports);
+
+// src/field.ts
+var Field = class {
+  config;
+  constructor() {
+    this.config = {
+      notRequired: false,
+      hasDefault: false,
+      default: void 0
+    };
+  }
+  notRequired() {
+    this.config.notRequired = true;
+    return this;
+  }
+  default(value) {
+    this.config.default = value;
+    this.config.hasDefault = true;
+    return this;
+  }
+  defaultFn(fn) {
+    this.config.defaultFn = fn;
+    this.config.hasDefault = true;
+    return this;
+  }
+  getConfig() {
+    return this.config;
+  }
+  getDefaultValue() {
+    return this.config.default ?? this.config.defaultFn?.();
+  }
+};
+
+// src/fields/boolean.ts
+var BooleanField = class extends Field {
+};
+var boolean = () => {
+  return new BooleanField();
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  boolean
+});

package/dist/cjs/fields/date.cjs

@@ -0,0 +1,68 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/fields/date.ts
+var date_exports = {};
+__export(date_exports, {
+  date: () => date
+});
+module.exports = __toCommonJS(date_exports);
+
+// src/field.ts
+var Field = class {
+  config;
+  constructor() {
+    this.config = {
+      notRequired: false,
+      hasDefault: false,
+      default: void 0
+    };
+  }
+  notRequired() {
+    this.config.notRequired = true;
+    return this;
+  }
+  default(value) {
+    this.config.default = value;
+    this.config.hasDefault = true;
+    return this;
+  }
+  defaultFn(fn) {
+    this.config.defaultFn = fn;
+    this.config.hasDefault = true;
+    return this;
+  }
+  getConfig() {
+    return this.config;
+  }
+  getDefaultValue() {
+    return this.config.default ?? this.config.defaultFn?.();
+  }
+};
+
+// src/fields/date.ts
+var DateField = class extends Field {
+};
+var date = () => {
+  return new DateField();
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  date
+});

package/dist/cjs/fields/index.cjs

@@ -0,0 +1,95 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/fields/index.ts
+var fields_exports = {};
+__export(fields_exports, {
+  boolean: () => boolean,
+  date: () => date,
+  number: () => number,
+  string: () => string
+});
+module.exports = __toCommonJS(fields_exports);
+
+// src/field.ts
+var Field = class {
+  config;
+  constructor() {
+    this.config = {
+      notRequired: false,
+      hasDefault: false,
+      default: void 0
+    };
+  }
+  notRequired() {
+    this.config.notRequired = true;
+    return this;
+  }
+  default(value) {
+    this.config.default = value;
+    this.config.hasDefault = true;
+    return this;
+  }
+  defaultFn(fn) {
+    this.config.defaultFn = fn;
+    this.config.hasDefault = true;
+    return this;
+  }
+  getConfig() {
+    return this.config;
+  }
+  getDefaultValue() {
+    return this.config.default ?? this.config.defaultFn?.();
+  }
+};
+
+// src/fields/boolean.ts
+var BooleanField = class extends Field {
+};
+var boolean = () => {
+  return new BooleanField();
+};
+
+// src/fields/date.ts
+var DateField = class extends Field {
+};
+var date = () => {
+  return new DateField();
+};
+
+// src/fields/number.ts
+var NumberField = class extends Field {
+};
+var number = () => {
+  return new NumberField();
+};
+
+// src/fields/string.ts
+var StringField = class extends Field {
+};
+var string = () => {
+  return new StringField();
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  boolean,
+  date,
+  number,
+  string
+});

package/dist/cjs/fields/number.cjs

@@ -0,0 +1,68 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/fields/number.ts
+var number_exports = {};
+__export(number_exports, {
+  number: () => number
+});
+module.exports = __toCommonJS(number_exports);
+
+// src/field.ts
+var Field = class {
+  config;
+  constructor() {
+    this.config = {
+      notRequired: false,
+      hasDefault: false,
+      default: void 0
+    };
+  }
+  notRequired() {
+    this.config.notRequired = true;
+    return this;
+  }
+  default(value) {
+    this.config.default = value;
+    this.config.hasDefault = true;
+    return this;
+  }
+  defaultFn(fn) {
+    this.config.defaultFn = fn;
+    this.config.hasDefault = true;
+    return this;
+  }
+  getConfig() {
+    return this.config;
+  }
+  getDefaultValue() {
+    return this.config.default ?? this.config.defaultFn?.();
+  }
+};
+
+// src/fields/number.ts
+var NumberField = class extends Field {
+};
+var number = () => {
+  return new NumberField();
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  number
+});