chore: improve materials metadata

Author: k0stik

dist/js/entity/mixins/HasMetadataMixin.d.ts

@@ -1,10 +1,11 @@
-import { type HasMetadataSchemaMixin } from "../../generated/HasMetadataSchemaMixin";
+import type { MetadataSchema } from "@mat3ra/esse/dist/js/types";
 import type { Constructor } from "../../utils/types";
 import { InMemoryEntity } from "../in_memory";
-type HasMetadataProperties = {
-    updateMetadata: (object: object) => void;
+type Metadata = MetadataSchema["metadata"];
+export type HasMetadata<T extends Metadata = Metadata> = {
+    metadata?: T;
+    updateMetadata: (object: Partial<T>) => void;
 };
-export type HasMetadata = HasMetadataSchemaMixin & HasMetadataProperties;
-export type HasMetadataInMemoryEntityConstructor = Constructor<HasMetadata>;
+export type HasMetadataInMemoryEntityConstructor<T extends Metadata = Metadata> = Constructor<HasMetadata<T>>;
 export declare function hasMetadataMixin<T extends InMemoryEntity>(item: T): asserts item is T & HasMetadata;
 export {};

dist/js/entity/mixins/HasMetadataMixin.js

@@ -1,17 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasMetadataMixin = hasMetadataMixin;
-const HasMetadataSchemaMixin_1 = require("../../generated/HasMetadataSchemaMixin");
 function hasMetadataPropertiesMixin(item) {
     // @ts-expect-error
     const properties = {
+        get metadata() {
+            return this.prop("metadata");
+        },
+        set metadata(value) {
+            this.setProp("metadata", value);
+        },
         updateMetadata(object) {
             this.setProp("metadata", { ...this.metadata, ...object });
         },
     };
     Object.defineProperties(item, Object.getOwnPropertyDescriptors(properties));
 }
 function hasMetadataMixin(item) {
-    (0, HasMetadataSchemaMixin_1.hasMetadataSchemaMixin)(item);
     hasMetadataPropertiesMixin(item);
 }

scripts/generate-mixins.ts

@@ -27,7 +27,7 @@ const OUTPUT_PATHS = {
     "system/defaultable": "src/js/generated/DefaultableSchemaMixin.ts",
     "system/has-consistency-check": "src/js/generated/HasConsistencyChecksSchemaMixin.ts",
     "system/description": "src/js/generated/HasDescriptionSchemaMixin.ts",
-    "system/metadata": "src/js/generated/HasMetadataSchemaMixin.ts",
+    // "system/metadata": "src/js/generated/HasMetadataSchemaMixin.ts",
     "system/name": "src/js/generated/NamedEntitySchemaMixin.ts",
     "system/tags": "src/js/generated/TaggableSchemaMixin.ts",
     "system/runtime-items": "src/js/generated/RuntimeItemsSchemaMixin.ts",

src/js/entity/mixins/HasMetadataMixin.ts

@@ -1,24 +1,31 @@
-import {
-    type HasMetadataSchemaMixin,
-    hasMetadataSchemaMixin,
-} from "../../generated/HasMetadataSchemaMixin";
+import type { MetadataSchema } from "@mat3ra/esse/dist/js/types";
+
 import type { Constructor } from "../../utils/types";
 import { InMemoryEntity } from "../in_memory";
 
-type HasMetadataProperties = {
-    updateMetadata: (object: object) => void;
-};
+type Metadata = MetadataSchema["metadata"];
 
-export type HasMetadata = HasMetadataSchemaMixin & HasMetadataProperties;
+export type HasMetadata<T extends Metadata = Metadata> = {
+    metadata?: T;
+    updateMetadata: (object: Partial<T>) => void;
+};
 
-export type HasMetadataInMemoryEntityConstructor = Constructor<HasMetadata>;
+export type HasMetadataInMemoryEntityConstructor<T extends Metadata = Metadata> = Constructor<
+    HasMetadata<T>
+>;
 
-function hasMetadataPropertiesMixin<T extends InMemoryEntity>(
+function hasMetadataPropertiesMixin<T extends InMemoryEntity, M extends Metadata = Metadata>(
     item: T,
 ): asserts item is T & HasMetadata {
     // @ts-expect-error
-    const properties: InMemoryEntity & HasMetadata = {
-        updateMetadata(object: object) {
+    const properties: InMemoryEntity & HasMetadata<M> = {
+        get metadata() {
+            return this.prop<M>("metadata");
+        },
+        set metadata(value: M | undefined) {
+            this.setProp("metadata", value);
+        },
+        updateMetadata(object: Partial<M>) {
             this.setProp("metadata", { ...this.metadata, ...object });
         },
     };
@@ -28,6 +35,5 @@ function hasMetadataPropertiesMixin<T extends InMemoryEntity>(
 export function hasMetadataMixin<T extends InMemoryEntity>(
     item: T,
 ): asserts item is T & HasMetadata {
-    hasMetadataSchemaMixin(item);
     hasMetadataPropertiesMixin(item);
 }