@1oo4/miv 1.0.0

package/README.md

@@ -0,0 +1,34 @@
+(**work in progress**) the MIV framework is in a beta state, we will not release it for real until Q1 2027. But it is already fully operational, and you can start using it now.
+
+MIV is a framework designed to build all sorts of applications, particularly those that would otherwise store their data in a database, or in local files on the user's machine.
+
+It has a Server side, and a Client side. The Server is mostly autonomous, **and is only available in C#** ; you will have to include it in a Windows Service or Docker container to use the TypeScript Client. Note that the Client also exists as a C# package to build applications with WPF or Avalonia.
+
+# What is already implemented for you
+
+* You won't have to write glue code with websockets everly time you need live updates.
+* You won't have to keep the UI in sync with the data by hand.
+* You won't have to think of a new CRUD+notify boilerplate each time you add a new feature.
+
+# Main features
+
+* Automatic UI update across all connected Clients when the data changes.
+* Uniform, structured way of representing your data.
+* Easily and intuitively write both simple and complex queries to modify data. Zero SQL needed.
+* Built-in Audit Trail : you will know when each data field was modified, and by who.
+
+# Architecture
+
+MIV is loosely inspired from a MVW architecture. You application will be divided into 3 domains :
+
+| Domain   | Location   | Usage                                                                                                                   |
+| -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------|
+| Server   | Server     | Mainly used to implement security checks. No work needed for prototypes or applications with low security requirements. |
+| Model    | Client     | A structured representation of your data. Automatically updated when the data from the Server changes.                  |
+| View     | Client     | A set of tools to display your data. Automatically updated when the Model changes.                                      |
+
+# Documentation
+
+This is a work in progress. Most of the Client side is documented, but the Server documentation/tutorial will not be ready until the end of 2026. The good thing is : you actually don't need the Server documentation to write a complete application, so feel free to try MIV now !
+
+You can follow the MIV tutorial at [https://miv.1004.tech/doc](https://miv.1004.tech/doc) (the documentation is a website created with the MIV framework)

package/dist/Client/AuditTrail.d.ts

@@ -0,0 +1,132 @@
+import { ErrorMessage } from "../Communication/ErrorMessage";
+import { MIVValueTypes } from "../MIVValueTypes";
+import { ClientConcreteType } from "./Construction/ClientTypes";
+import { SetInfo } from "./Construction/TypesInfos";
+export declare class AuditTrailObjectInfo {
+    readonly ID: bigint;
+    readonly TypeID: number;
+    private _type_private_;
+    get Type(): ClientConcreteType | undefined;
+    readonly Name: string;
+    readonly AllEvents: Array<AuditTrailItem>;
+    readonly Queries: Array<AuditTrailQueryPerObject>;
+    DisplayName: string | undefined;
+    DisplayTypeName: string | undefined;
+    private constructor();
+}
+export declare class AuditTrailQuery {
+    readonly ID: bigint;
+    readonly By: bigint;
+    readonly AtUTC: Date;
+    readonly Items: Array<AuditTrailItem>;
+    private constructor();
+}
+export declare abstract class AuditTrailItem {
+    readonly Query: AuditTrailQuery;
+}
+export declare class ATIChildCreated extends AuditTrailItem {
+    readonly Parent: AuditTrailObjectInfo;
+    readonly CreatedInfo: AuditTrailObjectInfo;
+    readonly Property: number;
+    private _set_miv_;
+    get ChildrenSet(): SetInfo | undefined;
+}
+export declare class ATIRelationCreated extends ATIChildCreated {
+    readonly Target: AuditTrailObjectInfo | undefined;
+    private constructor();
+}
+export declare class ATIChildDeleted extends AuditTrailItem {
+    readonly Parent: AuditTrailObjectInfo;
+    readonly DeletedInfo: AuditTrailObjectInfo;
+    readonly Property: number;
+    private _set_miv_;
+    get ChildrenSet(): SetInfo | undefined;
+}
+export declare class ATIRelationDeleted extends ATIChildDeleted {
+    readonly Target: AuditTrailObjectInfo | undefined;
+    private constructor();
+}
+export declare class ATIChildReassigned extends AuditTrailItem {
+    readonly OldParent: AuditTrailObjectInfo;
+    readonly OldProperty: number;
+    readonly NewParent: AuditTrailObjectInfo;
+    readonly NewProperty: number;
+    readonly ReassignedInfo: AuditTrailObjectInfo;
+    private _oldset_miv_;
+    get OldChildren(): SetInfo | undefined;
+    private _newset_miv_;
+    get NewChildren(): SetInfo | undefined;
+}
+export declare class ATIRelationReassigned extends ATIChildReassigned {
+    readonly Target: AuditTrailObjectInfo | undefined;
+    private constructor();
+}
+export declare abstract class ATValue extends AuditTrailItem {
+    readonly Owner: AuditTrailObjectInfo;
+    readonly Property: number;
+    private _info_miv_;
+    abstract GetKind(): MIVValueTypes;
+}
+export declare class ATVString extends ATValue {
+    readonly Value: string;
+    readonly OldValue: string;
+    private constructor();
+    GetKind(): MIVValueTypes;
+}
+export declare class ATVLong extends ATValue {
+    readonly Value: bigint;
+    readonly OldValue: bigint;
+    private constructor();
+    GetKind(): MIVValueTypes;
+}
+export declare class ATVDouble extends ATValue {
+    readonly Value: number;
+    readonly OldValue: number;
+    private constructor();
+    GetKind(): MIVValueTypes;
+}
+export declare class ATVBinary extends ATValue {
+    readonly Bytes: number;
+    readonly OldBytes: number;
+    private constructor();
+    GetKind(): MIVValueTypes;
+}
+export declare class ATVByte extends ATValue {
+    readonly Value: number;
+    readonly OldValue: number;
+    private constructor();
+    GetKind(): MIVValueTypes;
+}
+export declare class ATVDateTime extends ATValue {
+    readonly ValueUTC: Date;
+    readonly OldValueUTC: Date;
+    private constructor();
+    GetKind(): MIVValueTypes;
+}
+export declare class AuditTrailQueryPerObject {
+    readonly Query: AuditTrailQuery;
+    readonly Events: Array<AuditTrailItem>;
+}
+export declare class AuditTrailReport {
+    readonly Error: ErrorMessage | undefined;
+    readonly AllObjects: Array<AuditTrailObjectInfo>;
+    readonly ObjectsWithEvents: Array<AuditTrailObjectInfo>;
+    readonly Queries: Array<AuditTrailQuery>;
+}
+export declare abstract class AuditTrailHandler {
+    protected constructor();
+    protected Handle(item: AuditTrailItem): any | undefined;
+    abstract HandleChildCreated(item: ATIChildCreated): any | undefined;
+    abstract HandleRelationCreated(item: ATIRelationCreated): any | undefined;
+    abstract HandleChildDeleted(item: ATIChildDeleted): any | undefined;
+    abstract HandleRelationDeleted(item: ATIRelationDeleted): any | undefined;
+    abstract HandleChildReassigned(item: ATIChildReassigned): any | undefined;
+    abstract HandleRelationReassigned(item: ATIRelationReassigned): any | undefined;
+    abstract HandleString(item: ATVString): any | undefined;
+    abstract HandleByte(item: ATVByte): any | undefined;
+    abstract HandleLong(item: ATVLong): any | undefined;
+    abstract HandleDouble(item: ATVDouble): any | undefined;
+    abstract HandleDateTime(item: ATVDateTime): any | undefined;
+    abstract HandleBinary(item: ATVBinary): any | undefined;
+}
+//# sourceMappingURL=AuditTrail.d.ts.map

package/dist/Client/AuditTrail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditTrail.d.ts","sourceRoot":"","sources":["../../src/Client/AuditTrail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAK7D,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAgB,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAGlE,qBAAa,oBAAoB;IAE7B,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,OAAO,CAAC,cAAc,CAAiC;IACvD,IAAW,IAAI,IAAI,kBAAkB,GAAG,SAAS,CAAgC;IACjF,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACjD,SAAgB,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAClD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C,OAAO;CA2DV;AAED,qBAAa,eAAe;IAExB,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,KAAK,EAAE,IAAI,CAAC;IAC5B,SAAgB,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE7C,OAAO;CA0CV;AAED,8BAAsB,cAAc;IAehC,SAAgB,KAAK,EAAE,eAAe,CAAC;CA6B1C;AAED,qBAAa,eAAgB,SAAQ,cAAc;IAE/C,SAAgB,MAAM,EAAE,oBAAoB,CAAC;IAC7C,SAAgB,WAAW,EAAE,oBAAoB,CAAC;IAClD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,SAAS,CAAsB;IACvC,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAA2B;CA2C3E;AACD,qBAAa,kBAAmB,SAAQ,eAAe;IAEnD,SAAgB,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEzD,OAAO;CAiCV;AAED,qBAAa,eAAgB,SAAQ,cAAc;IAE/C,SAAgB,MAAM,EAAE,oBAAoB,CAAC;IAC7C,SAAgB,WAAW,EAAE,oBAAoB,CAAC;IAClD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,SAAS,CAAsB;IACvC,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAA2B;CA2C3E;AACD,qBAAa,kBAAmB,SAAQ,eAAe;IAEnD,SAAgB,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEzD,OAAO;CAiCV;AAED,qBAAa,kBAAmB,SAAQ,cAAc;IAElD,SAAgB,SAAS,EAAE,oBAAoB,CAAC;IAChD,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,SAAS,EAAE,oBAAoB,CAAC;IAChD,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,cAAc,EAAE,oBAAoB,CAAC;IACrD,OAAO,CAAC,YAAY,CAAsB;IAC1C,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAA8B;IAC3E,OAAO,CAAC,YAAY,CAAsB;IAC1C,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAA8B;CA4D9E;AACD,qBAAa,qBAAsB,SAAQ,kBAAkB;IAEzD,SAAgB,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEzD,OAAO;CAqCV;AAED,8BAAsB,OAAQ,SAAQ,cAAc;IAEhD,SAAgB,KAAK,EAAE,oBAAoB,CAAC;IAC5C,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,UAAU,CAA2B;aAiC7B,OAAO,IAAI,aAAa;CAC3C;AAED,qBAAa,SAAU,SAAQ,OAAO;IAElC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,OAAO;IA8BA,OAAO,IAAI,aAAa;CAGlC;AAED,qBAAa,OAAQ,SAAQ,OAAO;IAEhC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,OAAO;IA2BA,OAAO,IAAI,aAAa;CAGlC;AAED,qBAAa,SAAU,SAAQ,OAAO;IAElC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,OAAO;IA2BA,OAAO,IAAI,aAAa;CAGlC;AAED,qBAAa,SAAU,SAAQ,OAAO;IAElC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,OAAO;IA2BA,OAAO,IAAI,aAAa;CAGlC;AAED,qBAAa,OAAQ,SAAQ,OAAO;IAEhC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,OAAO;IA2BA,OAAO,IAAI,aAAa;CAGlC;AAED,qBAAa,WAAY,SAAQ,OAAO;IAEpC,SAAgB,QAAQ,EAAE,IAAI,CAAC;IAC/B,SAAgB,WAAW,EAAE,IAAI,CAAC;IAElC,OAAO;IA2BA,OAAO,IAAI,aAAa;CAGlC;AAED,qBAAa,wBAAwB;IAEjC,SAAgB,KAAK,EAAE,eAAe,CAAC;IACvC,SAAgB,MAAM,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAOjD;AAED,qBAAa,gBAAgB;IAEzB,SAAgB,KAAK,EAAE,YAAY,GAAG,SAAS,CAAC;IAChD,SAAgB,UAAU,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxD,SAAgB,iBAAiB,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC/D,SAAgB,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAqFnD;AAED,8BAAsB,iBAAiB;IACnC,SAAS;IAIT,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,GAAG,GAAG,SAAS;aAIvC,kBAAkB,CAAC,IAAI,EAAE,eAAe,GAAG,GAAG,GAAG,SAAS;aAC1D,qBAAqB,CAAC,IAAI,EAAE,kBAAkB,GAAG,GAAG,GAAG,SAAS;aAChE,kBAAkB,CAAC,IAAI,EAAE,eAAe,GAAG,GAAG,GAAG,SAAS;aAC1D,qBAAqB,CAAC,IAAI,EAAE,kBAAkB,GAAG,GAAG,GAAG,SAAS;aAChE,qBAAqB,CAAC,IAAI,EAAE,kBAAkB,GAAG,GAAG,GAAG,SAAS;aAChE,wBAAwB,CAAC,IAAI,EAAE,qBAAqB,GAAG,GAAG,GAAG,SAAS;aACtE,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,GAAG,GAAG,SAAS;aAC9C,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,GAAG,GAAG,SAAS;aAC1C,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,GAAG,GAAG,SAAS;aAC1C,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,GAAG,GAAG,SAAS;aAC9C,cAAc,CAAC,IAAI,EAAE,WAAW,GAAG,GAAG,GAAG,SAAS;aAClD,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,GAAG,GAAG,SAAS;CACjE"}