Compare commits
No commits in common. "main" and "v2.0.1" have entirely different histories.
24 changed files with 547 additions and 876 deletions
2
LICENSE
2
LICENSE
|
|
@ -1,6 +1,6 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2024 Zeptotech
|
||||
Copyright (c) <year> <copyright holders>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
|
|
|
|||
165
README.md
165
README.md
|
|
@ -1,40 +1,25 @@
|
|||
<p align="center">
|
||||
<a href="https://code.zeptotech.net/Sharkitek/Core">
|
||||
<picture>
|
||||
<img alt="Sharkitek logo" width="200" src="https://code.zeptotech.net/Sharkitek/Core/raw/branch/main/logo.svg" />
|
||||
</picture>
|
||||
</a>
|
||||
</p>
|
||||
<h1 align="center">
|
||||
Sharkitek
|
||||
</h1>
|
||||
|
||||
<h4 align="center">
|
||||
<a href="https://code.zeptotech.net/Sharkitek/Core">Documentation</a> |
|
||||
<a href="https://code.zeptotech.net/Sharkitek/Core">Website</a>
|
||||
</h4>
|
||||
|
||||
<p align="center">
|
||||
TypeScript library for well-designed model architectures
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Version 3.3.0" src="https://img.shields.io/badge/version-3.3.0-blue" />
|
||||
</p>
|
||||
# Sharkitek Core
|
||||
|
||||
## Introduction
|
||||
|
||||
Sharkitek is a Javascript / TypeScript library designed to ease development of client-side models.
|
||||
|
||||
With Sharkitek, you define the architecture of your models by specifying their properties and their types.
|
||||
Then, you can use the defined methods like `serialize`, `deserialize`, `patch` or `serializeDiff`.
|
||||
Then, you can use the defined methods like `serialize`, `deserialize` or `serializeDiff`.
|
||||
|
||||
```typescript
|
||||
class Example extends s.model({
|
||||
id: s.property.numeric(),
|
||||
name: s.property.string(),
|
||||
})
|
||||
class Example extends Model<Example>
|
||||
{
|
||||
id: number;
|
||||
name: string;
|
||||
|
||||
protected SDefinition(): ModelDefinition<Example>
|
||||
{
|
||||
return {
|
||||
id: SDefine(SNumeric),
|
||||
name: SDefine(SString),
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -46,16 +31,30 @@ class Example extends s.model({
|
|||
/**
|
||||
* A person.
|
||||
*/
|
||||
class Person extends s.model({
|
||||
id: s.property.numeric(),
|
||||
name: s.property.string(),
|
||||
firstName: s.property.string(),
|
||||
email: s.property.string(),
|
||||
createdAt: s.property.date(),
|
||||
active: s.property.boolean(),
|
||||
}, "id")
|
||||
class Person extends Model<Person>
|
||||
{
|
||||
id: number;
|
||||
name: string;
|
||||
firstName: string;
|
||||
email: string;
|
||||
createdAt: Date;
|
||||
active: boolean = true;
|
||||
|
||||
protected SIdentifier(): ModelIdentifier<Person>
|
||||
{
|
||||
return "id";
|
||||
}
|
||||
|
||||
protected SDefinition(): ModelDefinition<Person>
|
||||
{
|
||||
return {
|
||||
name: SDefine(SString),
|
||||
firstName: SDefine(SString),
|
||||
email: SDefine(SString),
|
||||
createdAt: SDefine(SDate),
|
||||
active: SDefine(SBool),
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -63,27 +62,29 @@ class Person extends s.model({
|
|||
/**
|
||||
* An article.
|
||||
*/
|
||||
class Article extends s.model({
|
||||
id: s.property.numeric(),
|
||||
title: s.property.string(),
|
||||
authors: s.property.array(s.property.model(Author)),
|
||||
text: s.property.string(),
|
||||
evaluation: s.property.decimal(),
|
||||
tags: s.property.array(
|
||||
s.property.object({
|
||||
name: s.property.string(),
|
||||
})
|
||||
),
|
||||
}, "id")
|
||||
class Article extends Model<Article>
|
||||
{
|
||||
id: number;
|
||||
title: string;
|
||||
authors: Author[] = [];
|
||||
text: string;
|
||||
evaluation: number;
|
||||
tags: {
|
||||
name: string;
|
||||
}[];
|
||||
|
||||
protected SIdentifier(): ModelIdentifier<Article>
|
||||
{
|
||||
return "id";
|
||||
}
|
||||
|
||||
protected SDefinition(): ModelDefinition<Article>
|
||||
{
|
||||
return {
|
||||
id: SDefine(SNumeric),
|
||||
title: SDefine(SString),
|
||||
authors: SDefine(SArray(SModel(Author))),
|
||||
text: SDefine(SString),
|
||||
evaluation: SDefine(SDecimal),
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -101,42 +102,53 @@ Sharkitek defines some basic types by default, in these classes:
|
|||
- `DecimalType`: number in the model, formatted string in the serialized object.
|
||||
- `DateType`: date in the model, ISO formatted date in the serialized object.
|
||||
- `ArrayType`: array in the model, array in the serialized object.
|
||||
- `ObjectType`: object in the model, object in the serialized object.
|
||||
- `ModelType`: instance of a specific class in the model, object in the serialized object.
|
||||
|
||||
When you are defining a property of a Sharkitek model, you must provide its type by instantiating one of these classes.
|
||||
When you are defining a Sharkitek property, you must provide its type by instantiating one of these classes.
|
||||
|
||||
```typescript
|
||||
class Example extends s.model({
|
||||
foo: s.property.define(new StringType()),
|
||||
})
|
||||
class Example extends Model<Example>
|
||||
{
|
||||
foo: string;
|
||||
|
||||
protected SDefinition(): ModelDefinition<Example>
|
||||
{
|
||||
return {
|
||||
foo: new Definition(new StringType()),
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
To ease the use of these classes and reduce read complexity,
|
||||
properties of each type are easily definable with a function for each type.
|
||||
To ease the use of these classes and reduce read complexity, some constant variables and functions are defined in the library,
|
||||
following a certain naming convention: "S{type_name}".
|
||||
|
||||
- `BoolType` => `s.property.boolean`
|
||||
- `StringType` => `s.property.string`
|
||||
- `NumericType` => `s.property.numeric`
|
||||
- `DecimalType` => `s.property.decimal`
|
||||
- `DateType` => `s.property.date`
|
||||
- `ArrayType` => `s.property.array`
|
||||
- `ObjectType` => `s.property.object`
|
||||
- `ModelType` => `s.property.model`
|
||||
- `BoolType` => `SBool`
|
||||
- `StringType` => `SString`
|
||||
- `NumericType` => `SNumeric`
|
||||
- `DecimalType` => `SDecimal`
|
||||
- `DateType` => `SDate`
|
||||
- `ArrayType` => `SArray`
|
||||
- `ModelType` => `SModel`
|
||||
|
||||
Type implementers should provide a corresponding function for each defined type. They can even provide
|
||||
multiple functions or constants with predefined parameters.
|
||||
(For example, we could define `s.property.stringArray()` which would be similar to `s.property.array(s.property.string())`.)
|
||||
When the types require parameters, the constant is defined as a function. If there is no parameter, then a simple
|
||||
variable is enough.
|
||||
|
||||
Type implementers should provide a corresponding variable or function for each defined type. They can even provide
|
||||
multiple functions or constants when predefined parameters. (For example, we could define `SStringArray` which would
|
||||
be a variable similar to `SArray(SString)`.)
|
||||
|
||||
```typescript
|
||||
class Example extends s.model({
|
||||
foo: s.property.string(),
|
||||
})
|
||||
class Example extends Model<Example>
|
||||
{
|
||||
foo: string;
|
||||
foo: string = undefined;
|
||||
|
||||
protected SDefinition(): ModelDefinition<Example>
|
||||
{
|
||||
return {
|
||||
foo: SDefine(SString),
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -196,6 +208,7 @@ const result = model.serializeDiff();
|
|||
// result = { id: 5, title: "A new title for a new world" }
|
||||
// if `id` is not defined as the model identifier:
|
||||
// result = { title: "A new title for a new world" }
|
||||
|
||||
```
|
||||
|
||||
#### `resetDiff()`
|
||||
|
|
@ -225,9 +238,10 @@ const result = model.serializeDiff();
|
|||
// result = { id: 5 }
|
||||
// if `id` is not defined as the model identifier:
|
||||
// result = {}
|
||||
|
||||
```
|
||||
|
||||
#### `patch()`
|
||||
#### `save()`
|
||||
|
||||
Get difference between original values and current ones, then reset it.
|
||||
Similar to call `serializeDiff()` then `resetDiff()`.
|
||||
|
|
@ -246,9 +260,10 @@ const model = (new TestModel()).deserialize({
|
|||
|
||||
model.title = "A new title for a new world";
|
||||
|
||||
const result = model.patch();
|
||||
const result = model.save();
|
||||
// if `id` is defined as the model identifier:
|
||||
// result = { id: 5, title: "A new title for a new world" }
|
||||
// if `id` is not defined as the model identifier:
|
||||
// result = { title: "A new title for a new world" }
|
||||
|
||||
```
|
||||
|
|
|
|||
38
build.ts
Normal file
38
build.ts
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
import {build} from "esbuild";
|
||||
|
||||
/**
|
||||
* Build the library.
|
||||
* @param devMode - Dev mode.
|
||||
*/
|
||||
function buildLibrary(devMode: boolean = false): void
|
||||
{
|
||||
// Compilation de l'application.
|
||||
build({
|
||||
entryPoints: ["src/index.ts"],
|
||||
outfile: "lib/index.js",
|
||||
bundle: true,
|
||||
minify: true,
|
||||
sourcemap: true,
|
||||
format: "esm",
|
||||
loader: {
|
||||
".ts": "ts",
|
||||
},
|
||||
watch: devMode ? {
|
||||
// Affichage suite à une recompilation.
|
||||
onRebuild(error, result) {
|
||||
console.log(new Date());
|
||||
if (!error && result.errors.length == 0)
|
||||
console.log("Successfully built.");
|
||||
else
|
||||
console.error("Error!");
|
||||
}
|
||||
} : false,
|
||||
})
|
||||
// Fonction lancée pour une compilation réussie.
|
||||
.then(() => { console.log(new Date()); console.log("Success."); })
|
||||
// Fonction lancée pour une compilation échouée.
|
||||
.catch((e) => console.error(e.message));
|
||||
}
|
||||
|
||||
// @ts-ignore
|
||||
buildLibrary(process.argv?.[2] == "dev");
|
||||
|
|
@ -1,10 +1,9 @@
|
|||
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
|
||||
|
||||
export default {
|
||||
module.exports = {
|
||||
preset: "ts-jest",
|
||||
testEnvironment: "node",
|
||||
|
||||
roots: [
|
||||
"./tests",
|
||||
],
|
||||
};
|
||||
};
|
||||
37
logo.svg
37
logo.svg
|
|
@ -1,37 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
|
||||
|
||||
<svg
|
||||
fill="#000000"
|
||||
width="900"
|
||||
height="900"
|
||||
viewBox="0 0 36 36"
|
||||
version="1.1"
|
||||
id="svg1"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/">
|
||||
<defs
|
||||
id="defs1" />
|
||||
<title
|
||||
id="title1">shark</title>
|
||||
<path
|
||||
d="M 18.033615,1.4513338 C 10.403464,6.2983278 6.2910007,18.59117 6.2910007,34.205527 H 29.708999 c 0,-15.613237 -4.045235,-27.9071992 -11.675384,-32.7541932 z m -7.467688,15.9532972 1.284018,1.073376 -0.440332,-2.462712 c 0.5154,-0.767498 1.064412,-1.447601 1.641435,-2.029105 l 1.345642,1.913699 0.275626,-3.236931 c 0.657695,-0.416801 1.342279,-0.713715 2.045911,-0.877298 l 1.281776,2.534419 1.281775,-2.534419 c 0.69915,0.162462 1.378133,0.456016 2.032467,0.869455 l 0.28907,3.393792 1.406144,-2.001093 c 0.554614,0.568059 1.082339,1.226874 1.579811,1.96636 l -0.43921,2.462712 1.284016,-1.073375 c 1.706421,3.099118 2.943378,7.246962 3.466621,11.948299 -0.06683,3.889694 -21.7515603,2.320881 -21.8036319,-0.0011 0.5221219,-4.700217 1.7590797,-8.849181 3.4666199,-11.947179 z"
|
||||
id="path2"
|
||||
style="display:inline;fill:#1c4878;fill-opacity:1;stroke-width:1.12043" />
|
||||
<path
|
||||
d="M 18.030001,4.0195273 C 11.220001,8.3455277 6.2910007,20.269527 6.2910007,34.205527 H 29.708999 c 0,-13.935 -4.869,-25.8599993 -11.678998,-30.1859997 z m -6.664999,15.1909997 1.146,0.958 -0.393,-2.198 c 0.46,-0.685 0.949999,-1.292 1.465,-1.811 l 1.200997,1.708 0.246,-2.889 c 0.587,-0.372 1.198,-0.637 1.826,-0.783 l 1.144,2.262 1.144,-2.262 c 0.624,0.145 1.23,0.407 1.814,0.776 l 0.258,3.029 1.255,-1.786 c 0.495,0.507 0.966,1.095 1.41,1.755 l -0.392,2.198 1.146,-0.958 c 1.523,2.766 2.627,6.468 3.094,10.664 -0.626,-2.009 -1.659,-3.774 -2.975,-5.146 l 0.25,-2.235 -1.6,1.042 c -0.381,-0.283 -0.777,-0.537 -1.188,-0.759 l -0.208,-2.556 -1.641,1.801 c -0.456,-0.13 -0.924,-0.222 -1.401,-0.276 l -0.968,-2.074 -0.968,2.074 c -0.508,0.057 -1.006,0.159 -1.49,0.302 l -1.549999,-1.701 -0.197,2.425 c -0.415,0.224 -0.815,0.479 -1.199,0.765 l -1.6,-1.042 0.25,2.234 c -1.3159993,1.371 -2.3489993,3.136 -2.9749993,5.145 0.466,-4.195 1.57,-7.898 3.0939993,-10.663 z"
|
||||
id="path1"
|
||||
style="display:inline;fill:#3178c6;fill-opacity:1" />
|
||||
<metadata
|
||||
id="metadata1">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:title>shark</dc:title>
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 2.6 KiB |
81
package.json
81
package.json
|
|
@ -1,47 +1,38 @@
|
|||
{
|
||||
"name": "@sharkitek/core",
|
||||
"version": "3.3.0",
|
||||
"description": "TypeScript library for well-designed model architectures.",
|
||||
"keywords": [
|
||||
"deserialization",
|
||||
"diff",
|
||||
"dirty",
|
||||
"model",
|
||||
"object",
|
||||
"property",
|
||||
"serialization",
|
||||
"sharkitek",
|
||||
"typescript"
|
||||
],
|
||||
"repository": "https://code.zeptotech.net/Sharkitek/Core",
|
||||
"author": {
|
||||
"name": "Madeorsk",
|
||||
"email": "madeorsk@protonmail.com"
|
||||
},
|
||||
"license": "MIT",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsc && vite build",
|
||||
"test": "jest"
|
||||
},
|
||||
"type": "module",
|
||||
"source": "src/index.ts",
|
||||
"types": "lib/index.d.ts",
|
||||
"main": "lib/index.js",
|
||||
"files": [
|
||||
"lib/**/*"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.13",
|
||||
"@types/node": "^22.7.4",
|
||||
"jest": "^29.7.0",
|
||||
"ts-jest": "^29.2.5",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.6.2",
|
||||
"vite": "^5.4.8",
|
||||
"vite-plugin-dts": "^4.2.2"
|
||||
},
|
||||
"packageManager": "yarn@4.5.0"
|
||||
"name": "@sharkitek/core",
|
||||
"version": "2.0.1",
|
||||
"description": "Sharkitek core models library.",
|
||||
"keywords": [
|
||||
"sharkitek",
|
||||
"model",
|
||||
"serialization",
|
||||
"diff",
|
||||
"dirty",
|
||||
"deserialization",
|
||||
"property"
|
||||
],
|
||||
"repository": "https://git.madeorsk.com/Sharkitek/core",
|
||||
"author": "Madeorsk <madeorsk@protonmail.com>",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"build": "parcel build",
|
||||
"test": "jest"
|
||||
},
|
||||
"source": "src/index.ts",
|
||||
"main": "lib/index.js",
|
||||
"types": "lib/index.d.ts",
|
||||
"files": [
|
||||
"lib/**/*"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@parcel/packager-ts": "2.7.0",
|
||||
"@parcel/transformer-typescript-types": "2.7.0",
|
||||
"@types/jest": "^28.1.6",
|
||||
"esbuild": "^0.15.8",
|
||||
"jest": "^28.1.3",
|
||||
"parcel": "^2.7.0",
|
||||
"ts-jest": "^28.0.7",
|
||||
"ts-node": "^10.9.1",
|
||||
"typescript": "^4.7.4"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
34
src/Model/Definition.ts
Normal file
34
src/Model/Definition.ts
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
import {Type} from "./Types/Type";
|
||||
|
||||
/**
|
||||
* Options of a definition.
|
||||
*/
|
||||
export interface DefinitionOptions<SerializedType, SharkitekType>
|
||||
{ //TODO implement some options, like `mandatory`.
|
||||
}
|
||||
|
||||
/**
|
||||
* A Sharkitek model property definition.
|
||||
*/
|
||||
export class Definition<SerializedType, SharkitekType>
|
||||
{
|
||||
/**
|
||||
* Initialize a property definition with the given type and options.
|
||||
* @param type - The model property type.
|
||||
* @param options - Property definition options.
|
||||
*/
|
||||
constructor(
|
||||
public type: Type<SerializedType, SharkitekType>,
|
||||
public options: DefinitionOptions<SerializedType, SharkitekType> = {},
|
||||
) {}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize a property definition with the given type and options.
|
||||
* @param type - The model property type.
|
||||
* @param options - Property definition options.
|
||||
*/
|
||||
export function SDefine<SerializedType, SharkitekType>(type: Type<SerializedType, SharkitekType>, options: DefinitionOptions<SerializedType, SharkitekType> = {})
|
||||
{
|
||||
return new Definition(type, options);
|
||||
}
|
||||
|
|
@ -1,296 +1,217 @@
|
|||
import {Definition} from "./PropertyDefinition";
|
||||
import {Definition} from "./Definition";
|
||||
|
||||
/**
|
||||
* Type definition of a model constructor.
|
||||
* Model properties definition type.
|
||||
*/
|
||||
export type ConstructorOf<T extends object> = { new(): T; };
|
||||
export type ModelDefinition<T> = Partial<Record<keyof T, Definition<unknown, unknown>>>;
|
||||
/**
|
||||
* Model identifier type.
|
||||
*/
|
||||
export type ModelIdentifier<T> = keyof T;
|
||||
|
||||
/**
|
||||
* Unknown property definition.
|
||||
* A Sharkitek model.
|
||||
*/
|
||||
export type UnknownDefinition = Definition<unknown, unknown>;
|
||||
|
||||
/**
|
||||
* A model shape.
|
||||
*/
|
||||
export type ModelShape = Record<string, UnknownDefinition>;
|
||||
|
||||
/**
|
||||
* Properties of a model based on its shape.
|
||||
*/
|
||||
export type PropertiesModel<Shape extends ModelShape> = {
|
||||
[k in keyof Shape]: Shape[k]["_sharkitek"];
|
||||
};
|
||||
|
||||
/**
|
||||
* Serialized object type based on model shape.
|
||||
*/
|
||||
export type SerializedModel<Shape extends ModelShape> = {
|
||||
[k in keyof Shape]: Shape[k]["_serialized"];
|
||||
};
|
||||
|
||||
/**
|
||||
* Type of a model object.
|
||||
*/
|
||||
export type Model<Shape extends ModelShape, IdentifierType = unknown> = ModelDefinition<Shape, IdentifierType> & PropertiesModel<Shape>;
|
||||
|
||||
/**
|
||||
* Type of the extends function of model classes.
|
||||
*/
|
||||
export type ExtendsFunctionType<ModelType extends Model<Shape, IdentifierType<Shape, Identifier>>, Shape extends ModelShape, Identifier extends keyof Shape = any> =
|
||||
<Extension extends object>(extension: ThisType<ModelType> & Extension) => ModelClass<ModelType & Extension, Shape, Identifier>;
|
||||
|
||||
/**
|
||||
* Type of a model class.
|
||||
*/
|
||||
export type ModelClass<ModelType extends Model<Shape, IdentifierType<Shape, Identifier>>, Shape extends ModelShape, Identifier extends keyof Shape = any> = (
|
||||
ConstructorOf<ModelType> & {
|
||||
extends: ExtendsFunctionType<ModelType, Shape, Identifier>;
|
||||
}
|
||||
);
|
||||
|
||||
/**
|
||||
* Identifier type.
|
||||
*/
|
||||
export type IdentifierType<Shape extends ModelShape, K extends keyof Shape> = Shape[K]["_sharkitek"];
|
||||
|
||||
/**
|
||||
* Identifier name type.
|
||||
*/
|
||||
export type IdentifierNameType<Shape> = Shape extends ModelShape ? keyof Shape : unknown;
|
||||
|
||||
/**
|
||||
* Interface of a Sharkitek model definition.
|
||||
*/
|
||||
export interface ModelDefinition<Shape extends ModelShape, IdentifierType, ModelType extends Model<Shape, IdentifierType> = Model<Shape, IdentifierType>>
|
||||
export abstract class Model<THIS>
|
||||
{
|
||||
/**
|
||||
* Model properties definition function.
|
||||
*/
|
||||
protected abstract SDefinition(): ModelDefinition<THIS>;
|
||||
|
||||
/**
|
||||
* Return the name of the model identifier property.
|
||||
*/
|
||||
protected SIdentifier(): ModelIdentifier<THIS>
|
||||
{
|
||||
return undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get given property definition.
|
||||
* @protected
|
||||
*/
|
||||
protected getPropertyDefinition(propertyName: string): Definition<unknown, unknown>
|
||||
{
|
||||
return (this.SDefinition() as any)?.[propertyName];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of the model properties.
|
||||
* @protected
|
||||
*/
|
||||
protected getProperties(): string[]
|
||||
{
|
||||
return Object.keys(this.SDefinition());
|
||||
}
|
||||
|
||||
/**
|
||||
* Calling a function for a defined property.
|
||||
* @param propertyName - The property for which to check definition.
|
||||
* @param callback - The function called when the property is defined.
|
||||
* @param notProperty - The function called when the property is not defined.
|
||||
* @protected
|
||||
*/
|
||||
protected propertyWithDefinition(propertyName: string, callback: (propertyDefinition: Definition<unknown, unknown>) => void, notProperty: () => void = () => {}): unknown
|
||||
{
|
||||
// Getting the current property definition.
|
||||
const propertyDefinition = this.getPropertyDefinition(propertyName);
|
||||
if (propertyDefinition)
|
||||
// There is a definition for the current property, calling the right callback.
|
||||
return callback(propertyDefinition);
|
||||
else
|
||||
// No definition for the given property, calling the right callback.
|
||||
return notProperty();
|
||||
}
|
||||
/**
|
||||
* Calling a function for each defined property.
|
||||
* @param callback - The function to call.
|
||||
* @protected
|
||||
*/
|
||||
protected forEachModelProperty(callback: (propertyName: string, propertyDefinition: Definition<unknown, unknown>) => unknown): any|void
|
||||
{
|
||||
for (const propertyName of this.getProperties())
|
||||
{ // For each property, checking that its type is defined and calling the callback with its type.
|
||||
const result = this.propertyWithDefinition(propertyName, (propertyDefinition) => {
|
||||
// If the property is defined, calling the function with the property name and definition.
|
||||
const result = callback(propertyName, propertyDefinition);
|
||||
|
||||
// If there is a return value, returning it directly (loop is broken).
|
||||
if (typeof result !== "undefined") return result;
|
||||
});
|
||||
|
||||
// If there is a return value, returning it directly (loop is broken).
|
||||
if (typeof result !== "undefined") return result;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The original properties values.
|
||||
* @protected
|
||||
*/
|
||||
protected _originalProperties: Record<string, any> = {};
|
||||
|
||||
/**
|
||||
* The original (serialized) object.
|
||||
* @protected
|
||||
*/
|
||||
protected _originalObject: any = null;
|
||||
|
||||
/**
|
||||
* Determine if the model is new or not.
|
||||
*/
|
||||
isNew(): boolean
|
||||
{
|
||||
return !this._originalObject;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if the model is dirty or not.
|
||||
*/
|
||||
isDirty(): boolean
|
||||
{
|
||||
return this.forEachModelProperty((propertyName, propertyDefinition) => (
|
||||
// For each property, checking if it is different.
|
||||
propertyDefinition.type.propertyHasChanged(this._originalProperties[propertyName], (this as any)[propertyName])
|
||||
// There is a difference, we should return false.
|
||||
? true
|
||||
// There is no difference, returning nothing.
|
||||
: undefined
|
||||
)) === true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get model identifier.
|
||||
*/
|
||||
getIdentifier(): IdentifierType;
|
||||
getIdentifier(): unknown
|
||||
{
|
||||
return (this as any)[this.SIdentifier()];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get model identifier name.
|
||||
*/
|
||||
getIdentifierName(): IdentifierNameType<Shape>;
|
||||
|
||||
/**
|
||||
* Serialize the model.
|
||||
*/
|
||||
serialize(): SerializedModel<Shape>;
|
||||
/**
|
||||
* Deserialize the model.
|
||||
* @param obj Serialized object.
|
||||
*/
|
||||
deserialize(obj: SerializedModel<Shape>): ModelType;
|
||||
|
||||
/**
|
||||
* Find out if the model is new (never deserialized) or not.
|
||||
*/
|
||||
isNew(): boolean;
|
||||
/**
|
||||
* Find out if the model is dirty or not.
|
||||
*/
|
||||
isDirty(): boolean;
|
||||
|
||||
/**
|
||||
* Serialize the difference between current model state and the original one.
|
||||
*/
|
||||
serializeDiff(): Partial<SerializedModel<Shape>>;
|
||||
/**
|
||||
* Set current properties values as original values.
|
||||
*/
|
||||
resetDiff(): void;
|
||||
resetDiff()
|
||||
{
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each property, set its original value to its current property value.
|
||||
this._originalProperties[propertyName] = (this as any)[propertyName];
|
||||
propertyDefinition.type.resetDiff((this as any)[propertyName]);
|
||||
});
|
||||
}
|
||||
/**
|
||||
* Serialize the difference between current model state and original one.
|
||||
*/
|
||||
serializeDiff(): any
|
||||
{
|
||||
// Creating a serialized object.
|
||||
const serializedDiff: any = {};
|
||||
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each defined model property, adding it to the serialized object if it has changed.
|
||||
if (this.SIdentifier() == propertyName
|
||||
|| propertyDefinition.type.propertyHasChanged(this._originalProperties[propertyName], (this as any)[propertyName]))
|
||||
// Adding the current property to the serialized object if it is the identifier or its value has changed.
|
||||
serializedDiff[propertyName] = propertyDefinition.type.serializeDiff((this as any)[propertyName]);
|
||||
})
|
||||
|
||||
return serializedDiff; // Returning the serialized object.
|
||||
}
|
||||
/**
|
||||
* Get difference between original values and current ones, then reset it.
|
||||
* Similar to call `serializeDiff()` then `resetDiff()`.
|
||||
*/
|
||||
patch(): Partial<SerializedModel<Shape>>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Define a Sharkitek model.
|
||||
* @param shape Model shape definition.
|
||||
* @param identifier Identifier property name.
|
||||
*/
|
||||
export function model<ModelType extends Model<Shape, IdentifierType<Shape, Identifier>>, Shape extends ModelShape, Identifier extends IdentifierNameType<Shape> = any>(
|
||||
shape: Shape,
|
||||
identifier?: Identifier,
|
||||
): ModelClass<ModelType, Shape, Identifier>
|
||||
{
|
||||
// Get shape entries.
|
||||
const shapeEntries = Object.entries(shape) as [keyof Shape, UnknownDefinition][];
|
||||
|
||||
return withExtends(
|
||||
// Initialize generic model class.
|
||||
class GenericModel implements ModelDefinition<Shape, IdentifierType<Shape, Identifier>, ModelType>
|
||||
{
|
||||
constructor()
|
||||
{
|
||||
// Initialize properties to undefined.
|
||||
Object.assign(this,
|
||||
// Build empty properties model from shape entries.
|
||||
Object.fromEntries(shapeEntries.map(([key]) => [key, undefined])) as PropertiesModel<Shape>
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Calling a function for each defined property.
|
||||
* @param callback - The function to call.
|
||||
* @protected
|
||||
*/
|
||||
protected forEachModelProperty<ReturnType>(callback: (propertyName: keyof Shape, propertyDefinition: UnknownDefinition) => ReturnType): ReturnType
|
||||
{
|
||||
for (const [propertyName, propertyDefinition] of shapeEntries)
|
||||
{ // For each property, checking that its type is defined and calling the callback with its type.
|
||||
// If the property is defined, calling the function with the property name and definition.
|
||||
const result = callback(propertyName, propertyDefinition);
|
||||
// If there is a return value, returning it directly (loop is broken).
|
||||
if (typeof result !== "undefined") return result;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The original properties values.
|
||||
* @protected
|
||||
*/
|
||||
protected _originalProperties: Partial<PropertiesModel<Shape>> = {};
|
||||
|
||||
/**
|
||||
* The original (serialized) object.
|
||||
* @protected
|
||||
*/
|
||||
protected _originalObject: SerializedModel<Shape>|null = null;
|
||||
|
||||
|
||||
|
||||
getIdentifier(): IdentifierType<Shape, Identifier>
|
||||
{
|
||||
return (this as PropertiesModel<Shape>)?.[identifier];
|
||||
}
|
||||
|
||||
getIdentifierName(): IdentifierNameType<Shape>
|
||||
{
|
||||
return identifier;
|
||||
}
|
||||
|
||||
serialize(): SerializedModel<Shape>
|
||||
{
|
||||
// Creating an empty (=> partial) serialized object.
|
||||
const serializedObject: Partial<SerializedModel<Shape>> = {};
|
||||
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each defined model property, adding it to the serialized object.
|
||||
serializedObject[propertyName] = propertyDefinition.type.serialize((this as PropertiesModel<Shape>)?.[propertyName]);
|
||||
});
|
||||
|
||||
return serializedObject as SerializedModel<Shape>; // Returning the serialized object.
|
||||
}
|
||||
|
||||
deserialize(obj: SerializedModel<Shape>): ModelType
|
||||
{
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each defined model property, assigning its deserialized value.
|
||||
(this as PropertiesModel<Shape>)[propertyName] = propertyDefinition.type.deserialize(obj[propertyName]);
|
||||
});
|
||||
|
||||
// Reset original property values.
|
||||
this.resetDiff();
|
||||
|
||||
this._originalObject = obj; // The model is not a new one, but loaded from a deserialized one. Storing it.
|
||||
|
||||
return this as unknown as ModelType;
|
||||
}
|
||||
|
||||
|
||||
isNew(): boolean
|
||||
{
|
||||
return !this._originalObject;
|
||||
}
|
||||
|
||||
isDirty(): boolean
|
||||
{
|
||||
return this.forEachModelProperty((propertyName, propertyDefinition) => (
|
||||
// For each property, checking if it is different.
|
||||
propertyDefinition.type.propertyHasChanged(this._originalProperties[propertyName], (this as PropertiesModel<Shape>)[propertyName])
|
||||
// There is a difference, we should return false.
|
||||
? true
|
||||
// There is no difference, returning nothing.
|
||||
: undefined
|
||||
)) === true;
|
||||
}
|
||||
|
||||
|
||||
serializeDiff(): Partial<SerializedModel<Shape>>
|
||||
{
|
||||
// Creating an empty (=> partial) serialized object.
|
||||
const serializedObject: Partial<SerializedModel<Shape>> = {};
|
||||
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each defined model property, adding it to the serialized object if it has changed or if it is the identifier.
|
||||
if (
|
||||
identifier == propertyName ||
|
||||
propertyDefinition.type.propertyHasChanged(this._originalProperties[propertyName], (this as PropertiesModel<Shape>)[propertyName])
|
||||
) // Adding the current property to the serialized object if it is the identifier or its value has changed.
|
||||
serializedObject[propertyName] = propertyDefinition.type.serializeDiff((this as PropertiesModel<Shape>)?.[propertyName]);
|
||||
});
|
||||
|
||||
return serializedObject; // Returning the serialized object.
|
||||
}
|
||||
|
||||
resetDiff(): void
|
||||
{
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each property, set its original value to its current property value.
|
||||
this._originalProperties[propertyName] = structuredClone(this as PropertiesModel<Shape>)[propertyName];
|
||||
propertyDefinition.type.resetDiff((this as PropertiesModel<Shape>)[propertyName]);
|
||||
});
|
||||
}
|
||||
|
||||
patch(): Partial<SerializedModel<Shape>>
|
||||
{
|
||||
// Get the difference.
|
||||
const diff = this.serializeDiff();
|
||||
|
||||
// Once the difference has been obtained, reset it.
|
||||
this.resetDiff();
|
||||
|
||||
return diff; // Return the difference.
|
||||
}
|
||||
|
||||
} as unknown as ConstructorOf<ModelType>
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Any Sharkitek model.
|
||||
*/
|
||||
export type AnyModel = Model<any, any>;
|
||||
/**
|
||||
* Any Sharkitek model class.
|
||||
*/
|
||||
export type AnyModelClass = ModelClass<AnyModel, any>;
|
||||
|
||||
/**
|
||||
* Add extends function to a model class.
|
||||
* @param genericModel The model class on which to add the extends function.
|
||||
*/
|
||||
function withExtends<ModelType extends Model<Shape, IdentifierType<Shape, Identifier>>, Shape extends ModelShape, Identifier extends keyof Shape = any>(
|
||||
genericModel: ConstructorOf<ModelType>
|
||||
): ModelClass<ModelType, Shape, Identifier>
|
||||
{
|
||||
return Object.assign(
|
||||
genericModel,
|
||||
{ // Extends function definition.
|
||||
extends<Extension extends object>(extension: Extension): ModelClass<ModelType & Extension, Shape, Identifier>
|
||||
{
|
||||
// Clone the model class and add extends function.
|
||||
const classClone = withExtends(class extends (genericModel as AnyModelClass) {} as AnyModelClass as ConstructorOf<ModelType & Extension>);
|
||||
// Add extension to the model class prototype.
|
||||
Object.assign(classClone.prototype, extension);
|
||||
return classClone;
|
||||
}
|
||||
}
|
||||
) as AnyModelClass as ModelClass<ModelType, Shape, Identifier>;
|
||||
save(): any
|
||||
{
|
||||
// Get the difference.
|
||||
const diff = this.serializeDiff();
|
||||
|
||||
// Once the difference has been gotten, reset it.
|
||||
this.resetDiff();
|
||||
|
||||
return diff; // Return the difference.
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Serialize the model.
|
||||
*/
|
||||
serialize(): any
|
||||
{
|
||||
// Creating a serialized object.
|
||||
const serializedObject: any = {};
|
||||
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each defined model property, adding it to the serialized object.
|
||||
serializedObject[propertyName] = propertyDefinition.type.serialize((this as any)[propertyName]);
|
||||
});
|
||||
|
||||
return serializedObject; // Returning the serialized object.
|
||||
}
|
||||
|
||||
/**
|
||||
* Special operations on parse.
|
||||
* @protected
|
||||
*/
|
||||
protected parse(): void
|
||||
{} // Nothing by default. TODO: create an event system to create functions like "beforeDeserialization" or "afterDeserialization".
|
||||
|
||||
/**
|
||||
* Deserialize the model.
|
||||
*/
|
||||
deserialize(serializedObject: any): THIS
|
||||
{
|
||||
this.forEachModelProperty((propertyName, propertyDefinition) => {
|
||||
// For each defined model property, assigning its deserialized value to the model.
|
||||
(this as any)[propertyName] = propertyDefinition.type.deserialize(serializedObject[propertyName]);
|
||||
});
|
||||
|
||||
// Reset original property values.
|
||||
this.resetDiff();
|
||||
|
||||
this._originalObject = serializedObject; // The model is not a new one, but loaded from a deserialized one.
|
||||
|
||||
return this as unknown as THIS; // Returning this, after deserialization.
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
export {define} from "./PropertyDefinition";
|
||||
|
||||
export {array} from "./Types/ArrayType";
|
||||
export {bool, boolean} from "./Types/BoolType";
|
||||
export {date} from "./Types/DateType";
|
||||
export {decimal} from "./Types/DecimalType";
|
||||
export {model} from "./Types/ModelType";
|
||||
export {numeric} from "./Types/NumericType";
|
||||
export {object} from "./Types/ObjectType";
|
||||
export {string} from "./Types/StringType";
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
import {Type} from "./Types/Type";
|
||||
|
||||
/**
|
||||
* Property definition class.
|
||||
*/
|
||||
export class Definition<SerializedType, ModelType>
|
||||
{
|
||||
readonly _sharkitek: ModelType;
|
||||
readonly _serialized: SerializedType;
|
||||
|
||||
/**
|
||||
* Create a property definer instance.
|
||||
* @param type Property type.
|
||||
*/
|
||||
constructor(public readonly type: Type<SerializedType, ModelType>)
|
||||
{}
|
||||
}
|
||||
|
||||
/**
|
||||
* New definition of a property of the given type.
|
||||
* @param type Type of the property to define.
|
||||
*/
|
||||
export function define<SerializedType, ModelType>(type: Type<SerializedType, ModelType>): Definition<SerializedType, ModelType>
|
||||
{
|
||||
return new Definition(type);
|
||||
}
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
|
||||
/**
|
||||
* Type of an array of values.
|
||||
|
|
@ -7,94 +6,60 @@ import {define, Definition} from "../PropertyDefinition";
|
|||
export class ArrayType<SerializedValueType, SharkitekValueType> extends Type<SerializedValueType[], SharkitekValueType[]>
|
||||
{
|
||||
/**
|
||||
* Initialize a new array type of a Sharkitek model property.
|
||||
* @param valueDefinition Definition the array values.
|
||||
* Constructs a new array type of Sharkitek model property.
|
||||
* @param valueType - Type of the array values.
|
||||
*/
|
||||
constructor(protected valueDefinition: Definition<SerializedValueType, SharkitekValueType>)
|
||||
constructor(protected valueType: Type<SerializedValueType, SharkitekValueType>)
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
serialize(value: SharkitekValueType[]|null|undefined): SerializedValueType[]|null|undefined
|
||||
serialize(value: SharkitekValueType[]): SerializedValueType[]
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return value.map((value) => (
|
||||
// Serializing each value of the array.
|
||||
this.valueDefinition.type.serialize(value)
|
||||
this.valueType.serialize(value)
|
||||
));
|
||||
}
|
||||
|
||||
deserialize(value: SerializedValueType[]|null|undefined): SharkitekValueType[]|null|undefined
|
||||
deserialize(value: SerializedValueType[]): SharkitekValueType[]
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return value.map((serializedValue) => (
|
||||
// Deserializing each value of the array.
|
||||
this.valueDefinition.type.deserialize(serializedValue)
|
||||
this.valueType.deserialize(serializedValue)
|
||||
));
|
||||
}
|
||||
|
||||
serializeDiff(value: SharkitekValueType[]|null|undefined): SerializedValueType[]|null|undefined
|
||||
serializeDiff(value: SharkitekValueType[]): any
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
// Serializing diff of all elements.
|
||||
return value.map((value) => this.valueDefinition.type.serializeDiff(value) as SerializedValueType);
|
||||
return value.map((value) => this.valueType.serializeDiff(value));
|
||||
}
|
||||
|
||||
resetDiff(value: SharkitekValueType[]|null|undefined): void
|
||||
resetDiff(value: SharkitekValueType[]): void
|
||||
{
|
||||
// Do nothing if it is not an array.
|
||||
if (!Array.isArray(value)) return;
|
||||
|
||||
// Reset diff of all elements.
|
||||
value.forEach((value) => this.valueDefinition.type.resetDiff(value));
|
||||
}
|
||||
|
||||
propertyHasChanged(originalValue: SharkitekValueType[]|null|undefined, currentValue: SharkitekValueType[]|null|undefined): boolean
|
||||
{
|
||||
// If any array length is different, arrays are different.
|
||||
if (originalValue?.length != currentValue?.length) return true;
|
||||
// If length is undefined, values are probably not arrays.
|
||||
if (originalValue?.length == undefined) return false;
|
||||
|
||||
for (const key of originalValue.keys())
|
||||
{ // Check for any change for each value in the array.
|
||||
if (this.valueDefinition.type.propertyHasChanged(originalValue[key], currentValue[key]))
|
||||
// The value has changed, the array is different.
|
||||
return true;
|
||||
}
|
||||
|
||||
return false; // No change detected.
|
||||
}
|
||||
|
||||
serializedPropertyHasChanged(originalValue: SerializedValueType[] | null | undefined, currentValue: SerializedValueType[] | null | undefined): boolean
|
||||
{
|
||||
// If any array length is different, arrays are different.
|
||||
if (originalValue?.length != currentValue?.length) return true;
|
||||
// If length is undefined, values are probably not arrays.
|
||||
if (originalValue?.length == undefined) return false;
|
||||
|
||||
for (const key of originalValue.keys())
|
||||
{ // Check for any change for each value in the array.
|
||||
if (this.valueDefinition.type.serializedPropertyHasChanged(originalValue[key], currentValue[key]))
|
||||
// The value has changed, the array is different.
|
||||
return true;
|
||||
}
|
||||
|
||||
return false; // No change detected.
|
||||
value.forEach((value) => this.valueType.resetDiff(value));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New array property definition.
|
||||
* @param valueDefinition Array values type definition.
|
||||
* Type of an array of values.
|
||||
* @param valueType - Type of the array values.
|
||||
*/
|
||||
export function array<SerializedValueType, SharkitekValueType>(valueDefinition: Definition<SerializedValueType, SharkitekValueType>): Definition<SerializedValueType[], SharkitekValueType[]>
|
||||
export function SArray<SerializedValueType, SharkitekValueType>(valueType: Type<SerializedValueType, SharkitekValueType>)
|
||||
{
|
||||
return define(new ArrayType(valueDefinition));
|
||||
return new ArrayType<SerializedValueType, SharkitekValueType>(valueType);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,42 +1,22 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
|
||||
/**
|
||||
* Type of any boolean value.
|
||||
*/
|
||||
export class BoolType extends Type<boolean, boolean>
|
||||
{
|
||||
deserialize(value: boolean|null|undefined): boolean|null|undefined
|
||||
deserialize(value: boolean): boolean
|
||||
{
|
||||
// Keep NULL and undefined values.
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return !!value; // ensure bool type.
|
||||
}
|
||||
|
||||
serialize(value: boolean|null|undefined): boolean|null|undefined
|
||||
serialize(value: boolean): boolean
|
||||
{
|
||||
// Keep NULL and undefined values.
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return !!value; // ensure bool type.
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New boolean property definition.
|
||||
* Type of any boolean value.
|
||||
*/
|
||||
export function bool(): Definition<boolean, boolean>
|
||||
{
|
||||
return define(new BoolType());
|
||||
}
|
||||
/**
|
||||
* New boolean property definition.
|
||||
* Alias of bool.
|
||||
*/
|
||||
export function boolean(): ReturnType<typeof bool>
|
||||
{
|
||||
return bool();
|
||||
}
|
||||
export const SBool = new BoolType();
|
||||
|
|
|
|||
|
|
@ -1,37 +1,22 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
|
||||
/**
|
||||
* Type of dates.
|
||||
*/
|
||||
export class DateType extends Type<string, Date>
|
||||
{
|
||||
deserialize(value: string|null|undefined): Date|null|undefined
|
||||
deserialize(value: string): Date
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return new Date(value);
|
||||
}
|
||||
|
||||
serialize(value: Date|null|undefined): string|null|undefined
|
||||
serialize(value: Date): string
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return value?.toISOString();
|
||||
}
|
||||
|
||||
propertyHasChanged(originalValue: Date|null|undefined, currentValue: Date|null|undefined): boolean
|
||||
{
|
||||
return originalValue?.toISOString() != currentValue?.toISOString();
|
||||
return value.toISOString();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New date property definition.
|
||||
* Type of dates.
|
||||
*/
|
||||
export function date(): Definition<string, Date>
|
||||
{
|
||||
return define(new DateType());
|
||||
}
|
||||
export const SDate = new DateType();
|
||||
|
|
|
|||
|
|
@ -1,32 +1,22 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
|
||||
/**
|
||||
* Type of decimal numbers.
|
||||
*/
|
||||
export class DecimalType extends Type<string, number>
|
||||
{
|
||||
deserialize(value: string|null|undefined): number|null|undefined
|
||||
deserialize(value: string): number
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return parseFloat(value);
|
||||
}
|
||||
|
||||
serialize(value: number|null|undefined): string|null|undefined
|
||||
serialize(value: number): string
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return value?.toString();
|
||||
return value.toString();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New decimal property definition.
|
||||
* Type of decimal numbers.
|
||||
*/
|
||||
export function decimal(): Definition<string, number>
|
||||
{
|
||||
return define(new DecimalType());
|
||||
}
|
||||
export const SDecimal = new DecimalType();
|
||||
|
|
|
|||
|
|
@ -1,69 +1,55 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
import {ConstructorOf, Model, ModelShape, SerializedModel} from "../Model";
|
||||
import {Model} from "../Model";
|
||||
|
||||
/**
|
||||
* Type definition of the constructor of a specific type.
|
||||
*/
|
||||
export type ConstructorOf<T> = { new(): T; }
|
||||
|
||||
/**
|
||||
* Type of a Sharkitek model value.
|
||||
*/
|
||||
export class ModelType<Shape extends ModelShape> extends Type<SerializedModel<Shape>, Model<Shape>>
|
||||
export class ModelType<M extends Model<M>> extends Type<any, M>
|
||||
{
|
||||
/**
|
||||
* Initialize a new model type of a Sharkitek model property.
|
||||
* @param modelConstructor Model constructor.
|
||||
* Constructs a new model type of a Sharkitek model property.
|
||||
* @param modelConstructor - Constructor of the model.
|
||||
*/
|
||||
constructor(protected modelConstructor: ConstructorOf<Model<Shape>>)
|
||||
constructor(protected modelConstructor: ConstructorOf<M>)
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
serialize(value: Model<Shape>|null|undefined): SerializedModel<Shape>|null|undefined
|
||||
serialize(value: M|null): any
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
// Serializing the given model.
|
||||
return value?.serialize();
|
||||
return value ? value.serialize() : null;
|
||||
}
|
||||
|
||||
deserialize(value: SerializedModel<Shape>|null|undefined): Model<Shape>|null|undefined
|
||||
deserialize(value: any): M|null
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
// Deserializing the given object in the new model.
|
||||
return (new this.modelConstructor()).deserialize(value) as Model<Shape>;
|
||||
return value ? (new this.modelConstructor()).deserialize(value) : null;
|
||||
}
|
||||
|
||||
serializeDiff(value: Model<Shape>|null|undefined): Partial<SerializedModel<Shape>>|null|undefined
|
||||
serializeDiff(value: M): any
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
// Serializing the given model.
|
||||
return value?.serializeDiff();
|
||||
return value ? value.serializeDiff() : null;
|
||||
}
|
||||
|
||||
resetDiff(value: Model<Shape>|null|undefined): void
|
||||
resetDiff(value: M): void
|
||||
{
|
||||
// Reset diff of the given model.
|
||||
value?.resetDiff();
|
||||
}
|
||||
|
||||
propertyHasChanged(originalValue: Model<Shape>|null|undefined, currentValue: Model<Shape>|null|undefined): boolean
|
||||
{
|
||||
if (originalValue === undefined) return currentValue !== undefined;
|
||||
if (originalValue === null) return currentValue !== null;
|
||||
|
||||
// If the current value is dirty, property has changed.
|
||||
return currentValue.isDirty();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New model property definition.
|
||||
* @param modelConstructor Model constructor.
|
||||
* Type of a Sharkitek model value.
|
||||
* @param modelConstructor - Constructor of the model.
|
||||
*/
|
||||
export function model<Shape extends ModelShape>(modelConstructor: ConstructorOf<Model<Shape>>): Definition<SerializedModel<Shape>, Model<Shape>>
|
||||
export function SModel<M extends Model<M>>(modelConstructor: ConstructorOf<M>)
|
||||
{
|
||||
return define(new ModelType(modelConstructor));
|
||||
return new ModelType(modelConstructor);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,26 +1,22 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
|
||||
/**
|
||||
* Type of any numeric value.
|
||||
*/
|
||||
export class NumericType extends Type<number, number>
|
||||
{
|
||||
deserialize(value: number|null|undefined): number|null|undefined
|
||||
deserialize(value: number): number
|
||||
{
|
||||
return value;
|
||||
}
|
||||
|
||||
serialize(value: number|null|undefined): number|null|undefined
|
||||
serialize(value: number): number
|
||||
{
|
||||
return value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New numeric property definition.
|
||||
* Type of any numeric value.
|
||||
*/
|
||||
export function numeric(): Definition<number, number>
|
||||
{
|
||||
return define(new NumericType());
|
||||
}
|
||||
export const SNumeric = new NumericType();
|
||||
|
|
|
|||
|
|
@ -1,118 +0,0 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
import {ModelShape, PropertiesModel, SerializedModel, UnknownDefinition} from "../Model";
|
||||
|
||||
/**
|
||||
* Type of a custom object.
|
||||
*/
|
||||
export class ObjectType<Shape extends ModelShape> extends Type<SerializedModel<Shape>, PropertiesModel<Shape>>
|
||||
{
|
||||
/**
|
||||
* Initialize a new object type of a Sharkitek model property.
|
||||
* @param shape
|
||||
*/
|
||||
constructor(protected readonly shape: Shape)
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
deserialize(value: SerializedModel<Shape>|null|undefined): PropertiesModel<Shape>|null|undefined
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return Object.fromEntries(
|
||||
// For each defined field, deserialize its value according to its type.
|
||||
(Object.entries(this.shape) as [keyof Shape, UnknownDefinition][]).map(([fieldName, fieldDefinition]) => (
|
||||
// Return an entry with the current field name and the deserialized value.
|
||||
[fieldName, fieldDefinition.type.deserialize(value?.[fieldName])]
|
||||
))
|
||||
) as PropertiesModel<Shape>;
|
||||
}
|
||||
|
||||
serialize(value: PropertiesModel<Shape>|null|undefined): SerializedModel<Shape>|null|undefined
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return Object.fromEntries(
|
||||
// For each defined field, serialize its value according to its type.
|
||||
(Object.entries(this.shape) as [keyof Shape, UnknownDefinition][]).map(([fieldName, fieldDefinition]) => (
|
||||
// Return an entry with the current field name and the serialized value.
|
||||
[fieldName, fieldDefinition.type.serialize(value?.[fieldName])]
|
||||
))
|
||||
) as PropertiesModel<Shape>;
|
||||
}
|
||||
|
||||
serializeDiff(value: PropertiesModel<Shape>|null|undefined): Partial<SerializedModel<Shape>>|null|undefined
|
||||
{
|
||||
if (value === undefined) return undefined;
|
||||
if (value === null) return null;
|
||||
|
||||
return Object.fromEntries(
|
||||
// For each defined field, serialize its diff value according to its type.
|
||||
(Object.entries(this.shape) as [keyof Shape, UnknownDefinition][]).map(([fieldName, fieldDefinition]) => (
|
||||
// Return an entry with the current field name and the serialized diff value.
|
||||
[fieldName, fieldDefinition.type.serializeDiff(value?.[fieldName])]
|
||||
))
|
||||
) as PropertiesModel<Shape>;
|
||||
}
|
||||
|
||||
resetDiff(value: PropertiesModel<Shape>|null|undefined)
|
||||
{
|
||||
// For each field, reset its diff.
|
||||
(Object.entries(this.shape) as [keyof Shape, UnknownDefinition][]).forEach(([fieldName, fieldDefinition]) => {
|
||||
// Reset diff of the current field.
|
||||
fieldDefinition.type.resetDiff(value?.[fieldName]);
|
||||
});
|
||||
}
|
||||
|
||||
propertyHasChanged(originalValue: PropertiesModel<Shape>|null|undefined, currentValue: PropertiesModel<Shape>|null|undefined): boolean
|
||||
{
|
||||
// Get keys arrays.
|
||||
const originalKeys = Object.keys(originalValue) as (keyof Shape)[];
|
||||
const currentKeys = Object.keys(currentValue) as (keyof Shape)[];
|
||||
|
||||
if (originalKeys.join(",") != currentKeys.join(","))
|
||||
// Keys have changed, objects are different.
|
||||
return true;
|
||||
|
||||
for (const key of originalKeys)
|
||||
{ // Check for any change for each value in the object.
|
||||
if (this.shape[key].type.propertyHasChanged(originalValue[key], currentValue[key]))
|
||||
// The value has changed, the object is different.
|
||||
return true;
|
||||
}
|
||||
|
||||
return false; // No change detected.
|
||||
}
|
||||
|
||||
serializedPropertyHasChanged(originalValue: SerializedModel<Shape>|null|undefined, currentValue: SerializedModel<Shape>|null|undefined): boolean
|
||||
{
|
||||
// Get keys arrays.
|
||||
const originalKeys = Object.keys(originalValue) as (keyof Shape)[];
|
||||
const currentKeys = Object.keys(currentValue) as (keyof Shape)[];
|
||||
|
||||
if (originalKeys.join(",") != currentKeys.join(","))
|
||||
// Keys have changed, objects are different.
|
||||
return true;
|
||||
|
||||
for (const key of originalKeys)
|
||||
{ // Check for any change for each value in the object.
|
||||
if (this.shape[key].type.serializedPropertyHasChanged(originalValue[key], currentValue[key]))
|
||||
// The value has changed, the object is different.
|
||||
return true;
|
||||
}
|
||||
|
||||
return false; // No change detected.
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New object property definition.
|
||||
* @param shape Shape of the object.
|
||||
*/
|
||||
export function object<Shape extends ModelShape>(shape: Shape): Definition<SerializedModel<Shape>, PropertiesModel<Shape>>
|
||||
{
|
||||
return define(new ObjectType(shape));
|
||||
}
|
||||
|
|
@ -1,26 +1,22 @@
|
|||
import {Type} from "./Type";
|
||||
import {define, Definition} from "../PropertyDefinition";
|
||||
|
||||
/**
|
||||
* Type of any string value.
|
||||
*/
|
||||
export class StringType extends Type<string, string>
|
||||
{
|
||||
deserialize(value: string|null|undefined): string|null|undefined
|
||||
deserialize(value: string): string
|
||||
{
|
||||
return value;
|
||||
}
|
||||
|
||||
serialize(value: string|null|undefined): string|null|undefined
|
||||
serialize(value: string): string
|
||||
{
|
||||
return value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* New string property definition.
|
||||
* Type of any string value.
|
||||
*/
|
||||
export function string(): Definition<string, string>
|
||||
{
|
||||
return define(new StringType());
|
||||
}
|
||||
export const SString = new StringType();
|
||||
|
|
|
|||
|
|
@ -1,25 +1,25 @@
|
|||
/**
|
||||
* Abstract class of a Sharkitek model property type.
|
||||
*/
|
||||
export abstract class Type<SerializedType, ModelType>
|
||||
export abstract class Type<SerializedType, SharkitekType>
|
||||
{
|
||||
/**
|
||||
* Serialize the given value of a Sharkitek model property.
|
||||
* @param value Value to serialize.
|
||||
* @param value - Value to serialize.
|
||||
*/
|
||||
abstract serialize(value: ModelType|null|undefined): SerializedType|null|undefined;
|
||||
abstract serialize(value: SharkitekType): SerializedType;
|
||||
|
||||
/**
|
||||
* Deserialize the given value of a serialized Sharkitek model.
|
||||
* @param value - Value to deserialize.
|
||||
*/
|
||||
abstract deserialize(value: SerializedType|null|undefined): ModelType|null|undefined;
|
||||
abstract deserialize(value: SerializedType): SharkitekType;
|
||||
|
||||
/**
|
||||
* Serialize the given value only if it has changed.
|
||||
* @param value - Value to deserialize.
|
||||
*/
|
||||
serializeDiff(value: ModelType|null|undefined): Partial<SerializedType>|null|undefined
|
||||
serializeDiff(value: SharkitekType): SerializedType|null
|
||||
{
|
||||
return this.serialize(value); // By default, nothing changes.
|
||||
}
|
||||
|
|
@ -28,7 +28,7 @@ export abstract class Type<SerializedType, ModelType>
|
|||
* Reset the difference between the original value and the current one.
|
||||
* @param value - Value for which reset diff data.
|
||||
*/
|
||||
resetDiff(value: ModelType|null|undefined): void
|
||||
resetDiff(value: SharkitekType): void
|
||||
{
|
||||
// By default, nothing to do.
|
||||
}
|
||||
|
|
@ -38,7 +38,7 @@ export abstract class Type<SerializedType, ModelType>
|
|||
* @param originalValue - Original property value.
|
||||
* @param currentValue - Current property value.
|
||||
*/
|
||||
propertyHasChanged(originalValue: ModelType|null|undefined, currentValue: ModelType|null|undefined): boolean
|
||||
propertyHasChanged(originalValue: SharkitekType, currentValue: SharkitekType): boolean
|
||||
{
|
||||
return originalValue != currentValue;
|
||||
}
|
||||
|
|
@ -48,7 +48,7 @@ export abstract class Type<SerializedType, ModelType>
|
|||
* @param originalValue - Original serialized property value.
|
||||
* @param currentValue - Current serialized property value.
|
||||
*/
|
||||
serializedPropertyHasChanged(originalValue: SerializedType|null|undefined, currentValue: SerializedType|null|undefined): boolean
|
||||
serializedPropertyHasChanged(originalValue: SerializedType, currentValue: SerializedType): boolean
|
||||
{
|
||||
return originalValue != currentValue;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,14 +0,0 @@
|
|||
import * as property from "./Properties";
|
||||
export { property };
|
||||
|
||||
export * from "./Model";
|
||||
export {Definition} from "./PropertyDefinition";
|
||||
|
||||
export {ArrayType} from "./Types/ArrayType";
|
||||
export {BoolType} from "./Types/BoolType";
|
||||
export {DateType} from "./Types/DateType";
|
||||
export {DecimalType} from "./Types/DecimalType";
|
||||
export {ModelType} from "./Types/ModelType";
|
||||
export {NumericType} from "./Types/NumericType";
|
||||
export {ObjectType} from "./Types/ObjectType";
|
||||
export {StringType} from "./Types/StringType";
|
||||
18
src/index.ts
18
src/index.ts
|
|
@ -1,4 +1,14 @@
|
|||
import * as s from "./Model";
|
||||
export * from "./Model";
|
||||
export { s };
|
||||
export default s;
|
||||
|
||||
|
||||
export * from "./Model/Model";
|
||||
|
||||
export * from "./Model/Definition";
|
||||
|
||||
export * from "./Model/Types/Type";
|
||||
export * from "./Model/Types/ArrayType";
|
||||
export * from "./Model/Types/BoolType";
|
||||
export * from "./Model/Types/DateType";
|
||||
export * from "./Model/Types/DecimalType";
|
||||
export * from "./Model/Types/ModelType";
|
||||
export * from "./Model/Types/NumericType";
|
||||
export * from "./Model/Types/StringType";
|
||||
|
|
|
|||
|
|
@ -1,24 +1,39 @@
|
|||
import {s} from "../src";
|
||||
import {
|
||||
SArray,
|
||||
SDecimal,
|
||||
SModel,
|
||||
SNumeric,
|
||||
SString,
|
||||
SDate,
|
||||
SBool,
|
||||
Model,
|
||||
ModelDefinition,
|
||||
SDefine, ModelIdentifier
|
||||
} from "../src";
|
||||
|
||||
/**
|
||||
* Another test model.
|
||||
*/
|
||||
class Author extends s.model({
|
||||
name: s.property.string(),
|
||||
firstName: s.property.string(),
|
||||
email: s.property.string(),
|
||||
createdAt: s.property.date(),
|
||||
active: s.property.bool(),
|
||||
}).extends({
|
||||
extension(): string
|
||||
{
|
||||
return this.name;
|
||||
}
|
||||
})
|
||||
class Author extends Model<Author>
|
||||
{
|
||||
name: string;
|
||||
firstName: string;
|
||||
email: string;
|
||||
createdAt: Date;
|
||||
active: boolean = true;
|
||||
|
||||
constructor(name: string = "", firstName: string = "", email: string = "", createdAt: Date = new Date())
|
||||
protected SDefinition(): ModelDefinition<Author>
|
||||
{
|
||||
return {
|
||||
name: SDefine(SString),
|
||||
firstName: SDefine(SString),
|
||||
email: SDefine(SString),
|
||||
createdAt: SDefine(SDate),
|
||||
active: SDefine(SBool),
|
||||
};
|
||||
}
|
||||
|
||||
constructor(name: string = undefined, firstName: string = undefined, email: string = undefined, createdAt: Date = undefined)
|
||||
{
|
||||
super();
|
||||
|
||||
|
|
@ -32,27 +47,29 @@ class Author extends s.model({
|
|||
/**
|
||||
* A test model.
|
||||
*/
|
||||
class Article extends s.model({
|
||||
id: s.property.numeric(),
|
||||
title: s.property.string(),
|
||||
authors: s.property.array(s.property.model(Author)),
|
||||
text: s.property.string(),
|
||||
evaluation: s.property.decimal(),
|
||||
tags: s.property.array(
|
||||
s.property.object({
|
||||
name: s.property.string(),
|
||||
})
|
||||
),
|
||||
}, "id")
|
||||
class Article extends Model<Article>
|
||||
{
|
||||
id: number;
|
||||
title: string;
|
||||
authors: Author[] = [];
|
||||
text: string;
|
||||
evaluation: number;
|
||||
tags: {
|
||||
name: string;
|
||||
}[];
|
||||
|
||||
protected SIdentifier(): ModelIdentifier<Article>
|
||||
{
|
||||
return "id";
|
||||
}
|
||||
|
||||
protected SDefinition(): ModelDefinition<Article>
|
||||
{
|
||||
return {
|
||||
id: SDefine(SNumeric),
|
||||
title: SDefine(SString),
|
||||
authors: SDefine(SArray(SModel(Author))),
|
||||
text: SDefine(SString),
|
||||
evaluation: SDefine(SDecimal),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
it("deserialize", () => {
|
||||
|
|
@ -65,7 +82,6 @@ it("deserialize", () => {
|
|||
],
|
||||
text: "this is a long test.",
|
||||
evaluation: "25.23",
|
||||
tags: [ {name: "test"}, {name: "foo"} ],
|
||||
}).serialize()).toStrictEqual({
|
||||
id: 1,
|
||||
title: "this is a test",
|
||||
|
|
@ -75,7 +91,6 @@ it("deserialize", () => {
|
|||
],
|
||||
text: "this is a long test.",
|
||||
evaluation: "25.23",
|
||||
tags: [ {name: "test"}, {name: "foo"} ],
|
||||
});
|
||||
});
|
||||
|
||||
|
|
@ -89,9 +104,6 @@ it("create and check state then serialize", () => {
|
|||
];
|
||||
article.text = "this is a long test.";
|
||||
article.evaluation = 25.23;
|
||||
article.tags = [];
|
||||
article.tags.push({name: "test"});
|
||||
article.tags.push({name: "foo"});
|
||||
|
||||
expect(article.isNew()).toBeTruthy();
|
||||
expect(article.getIdentifier()).toStrictEqual(1);
|
||||
|
|
@ -104,22 +116,20 @@ it("create and check state then serialize", () => {
|
|||
],
|
||||
text: "this is a long test.",
|
||||
evaluation: "25.23",
|
||||
tags: [ {name: "test"}, {name: "foo"} ],
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
it("deserialize then patch", () => {
|
||||
it("deserialize then save", () => {
|
||||
const article = (new Article()).deserialize({
|
||||
id: 1,
|
||||
title: "this is a test",
|
||||
authors: [
|
||||
{ name: "DOE", firstName: "John", email: "test@test.test", createdAt: (new Date()).toISOString(), active: true, },
|
||||
{ name: "TEST", firstName: "Another", email: "another@test.test", createdAt: (new Date()).toISOString(), active: false, },
|
||||
{ name: "DOE", firstName: "John", email: "test@test.test", createdAt: new Date(), active: true, },
|
||||
{ name: "TEST", firstName: "Another", email: "another@test.test", createdAt: new Date(), active: false, },
|
||||
],
|
||||
text: "this is a long test.",
|
||||
evaluation: "25.23",
|
||||
tags: [ {name: "test"}, {name: "foo"} ],
|
||||
});
|
||||
|
||||
expect(article.isNew()).toBeFalsy();
|
||||
|
|
@ -130,39 +140,34 @@ it("deserialize then patch", () => {
|
|||
|
||||
expect(article.isDirty()).toBeTruthy();
|
||||
|
||||
expect(article.patch()).toStrictEqual({
|
||||
expect(article.save()).toStrictEqual({
|
||||
id: 1,
|
||||
text: "Modified text.",
|
||||
});
|
||||
});
|
||||
|
||||
it("patch with modified submodels", () => {
|
||||
it("save with modified submodels", () => {
|
||||
const article = (new Article()).deserialize({
|
||||
id: 1,
|
||||
title: "this is a test",
|
||||
authors: [
|
||||
{ name: "DOE", firstName: "John", email: "test@test.test", createdAt: (new Date()).toISOString(), active: true, },
|
||||
{ name: "TEST", firstName: "Another", email: "another@test.test", createdAt: (new Date("1997-09-09")).toISOString(), active: false, },
|
||||
{ name: "DOE", firstName: "John", email: "test@test.test", createdAt: new Date(), active: true, },
|
||||
{ name: "TEST", firstName: "Another", email: "another@test.test", createdAt: new Date(), active: false, },
|
||||
],
|
||||
text: "this is a long test.",
|
||||
evaluation: "25.23",
|
||||
tags: [ {name: "test"}, {name: "foo"} ],
|
||||
});
|
||||
|
||||
article.authors[0].name = "TEST";
|
||||
article.authors[1].createdAt.setMonth(9);
|
||||
article.authors = article.authors.map((author) => {
|
||||
author.name = "TEST";
|
||||
return author;
|
||||
});
|
||||
|
||||
expect(article.patch()).toStrictEqual({
|
||||
expect(article.save()).toStrictEqual({
|
||||
id: 1,
|
||||
authors: [
|
||||
{ name: "TEST" },
|
||||
{ createdAt: (new Date("1997-10-09")).toISOString() }, //{ name: "TEST", firstName: "Another", email: "another@test.test" },
|
||||
{ name: "TEST", },
|
||||
{}, //{ name: "TEST", firstName: "Another", email: "another@test.test" },
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it("test author extension", () => {
|
||||
const author = new Author();
|
||||
author.name = "test name";
|
||||
expect(author.extension()).toStrictEqual("test name");
|
||||
});
|
||||
|
|
|
|||
|
|
@ -1,27 +1,22 @@
|
|||
{
|
||||
"ts-node": {
|
||||
"compilerOptions": {
|
||||
"module": "ESNext",
|
||||
"types": ["node"],
|
||||
"module": "CommonJS"
|
||||
}
|
||||
},
|
||||
|
||||
"files": ["src/index.ts"],
|
||||
"compilerOptions": {
|
||||
"outDir": "./lib/",
|
||||
"incremental": true,
|
||||
"sourceMap": true,
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"esModuleInterop": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"resolveJsonModule": true,
|
||||
"experimentalDecorators": true,
|
||||
"emitDecoratorMetadata": true,
|
||||
"declaration": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"sourceMap": true,
|
||||
"module": "ES6",
|
||||
"target": "ES6",
|
||||
"moduleResolution": "Bundler",
|
||||
"moduleResolution": "Node",
|
||||
"target": "ES6",
|
||||
|
||||
"lib": [
|
||||
"ESNext",
|
||||
"DOM"
|
||||
|
|
|
|||
|
|
@ -1,30 +0,0 @@
|
|||
import {ConfigEnv, defineConfig, UserConfig} from "vite";
|
||||
import dts from "vite-plugin-dts";
|
||||
|
||||
// https://vitejs.dev/config/
|
||||
|
||||
export default defineConfig(({ mode }: ConfigEnv): UserConfig => {
|
||||
return ({
|
||||
build: {
|
||||
outDir: "lib",
|
||||
sourcemap: true,
|
||||
minify: "esbuild",
|
||||
lib: {
|
||||
entry: "src/index.ts",
|
||||
formats: ["es"],
|
||||
fileName: "index",
|
||||
},
|
||||
rollupOptions: {
|
||||
external: ["reflect-metadata"],
|
||||
},
|
||||
},
|
||||
|
||||
plugins: [
|
||||
dts({
|
||||
insertTypesEntry: true,
|
||||
rollupTypes: true,
|
||||
exclude: ["node_modules"],
|
||||
}),
|
||||
]
|
||||
});
|
||||
});
|
||||
Loading…
Reference in a new issue