chore: update TS types

Exabyte-io · Dec 14, 2024 · 6894ec8 · 6894ec8
1 parent d77ba96
commit 6894ec8
Show file tree

Hide file tree

Showing 13 changed files with 124 additions and 78 deletions.
diff --git a/dist/js/entity/mixins/props.d.ts b/dist/js/entity/mixins/props.d.ts
@@ -1,6 +1,7 @@
 import { type ConsistencyCheck } from "@mat3ra/esse/dist/js/types";
-import { InMemoryEntityConstructor } from "../in_memory";
-export declare function DefaultableMixin<T extends InMemoryEntityConstructor>(superclass: T): {
+import type { Constructor } from "../../utils/types";
+import { type InMemoryEntity, InMemoryEntityConstructor } from "../in_memory";
+export declare function DefaultableMixin<T extends Constructor<InMemoryEntity> = Constructor<InMemoryEntity>>(superclass: T): {
     new (...args: any[]): {
         readonly isDefault: boolean;
         _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
@@ -19,7 +20,7 @@ export declare function DefaultableMixin<T extends InMemoryEntityConstructor>(su
         readonly cls: string;
         getClsName(): string;
         getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-        getEntityByName(entities: import("../in_memory").InMemoryEntity[], entity: string, name: string): import("../in_memory").InMemoryEntity;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
         id: string;
         _id: string;
         schemaVersion: string;
@@ -50,7 +51,7 @@ export declare function TaggableMixin<T extends InMemoryEntityConstructor>(super
         readonly cls: string;
         getClsName(): string;
         getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-        getEntityByName(entities: import("../in_memory").InMemoryEntity[], entity: string, name: string): import("../in_memory").InMemoryEntity;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
         id: string;
         _id: string;
         schemaVersion: string;
@@ -78,7 +79,7 @@ export declare function HasScopeTrackMixin<T extends InMemoryEntityConstructor>(
         readonly cls: string;
         getClsName(): string;
         getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-        getEntityByName(entities: import("../in_memory").InMemoryEntity[], entity: string, name: string): import("../in_memory").InMemoryEntity;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
         id: string;
         _id: string;
         schemaVersion: string;
@@ -107,7 +108,7 @@ export declare function HasMetadataMixin<T extends InMemoryEntityConstructor>(su
         readonly cls: string;
         getClsName(): string;
         getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-        getEntityByName(entities: import("../in_memory").InMemoryEntity[], entity: string, name: string): import("../in_memory").InMemoryEntity;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
         id: string;
         _id: string;
         schemaVersion: string;
@@ -136,7 +137,7 @@ export declare function HasDescriptionMixin<T extends InMemoryEntityConstructor>
         readonly cls: string;
         getClsName(): string;
         getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-        getEntityByName(entities: import("../in_memory").InMemoryEntity[], entity: string, name: string): import("../in_memory").InMemoryEntity;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
         id: string;
         _id: string;
         schemaVersion: string;
@@ -165,7 +166,7 @@ export declare function NamedEntityMixin<T extends InMemoryEntityConstructor>(su
         readonly cls: string;
         getClsName(): string;
         getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-        getEntityByName(entities: import("../in_memory").InMemoryEntity[], entity: string, name: string): import("../in_memory").InMemoryEntity;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
         id: string;
         _id: string;
         schemaVersion: string;
@@ -194,7 +195,7 @@ export declare function HasConsistencyChecksMixin<T extends InMemoryEntityConstr
         readonly cls: string;
         getClsName(): string;
         getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-        getEntityByName(entities: import("../in_memory").InMemoryEntity[], entity: string, name: string): import("../in_memory").InMemoryEntity;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
         id: string;
         _id: string;
         schemaVersion: string;

diff --git a/dist/js/entity/other.d.ts b/dist/js/entity/other.d.ts
@@ -118,7 +118,7 @@ export declare const NamedDefaultableInMemoryEntity: {
     readonly defaultConfig: object | null;
     createDefault(): any;
 } & typeof InMemoryEntity;
-declare const HasMetadataNamedDefaultableInMemoryEntity_base: {
+export declare const HasMetadataNamedDefaultableInMemoryEntity: {
     new (...args: any[]): {
         metadata: object;
         updateMetadata(object: object): void;
@@ -204,9 +204,7 @@ declare const HasMetadataNamedDefaultableInMemoryEntity_base: {
     readonly defaultConfig: object | null;
     createDefault(): any;
 } & typeof InMemoryEntity;
-export declare class HasMetadataNamedDefaultableInMemoryEntity extends HasMetadataNamedDefaultableInMemoryEntity_base {
-}
-declare const HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity_base: {
+export declare const HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity: {
     new (...args: any[]): {
         consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
         addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
@@ -234,9 +232,92 @@ declare const HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity_base
         readonly slug: string;
         readonly isSystemEntity: boolean;
     };
-} & typeof HasMetadataNamedDefaultableInMemoryEntity;
-export declare class HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity extends HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity_base {
-}
+} & {
+    new (...args: any[]): {
+        metadata: object;
+        updateMetadata(object: object): void;
+        _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        prop<T = undefined>(name: string, defaultValue: T): T;
+        prop<T = undefined>(name: string): T | undefined;
+        setProp(name: string, value: unknown): void;
+        unsetProp(name: string): void;
+        setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject): /*elided*/ any;
+        toJSON(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        toJSONSafe(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        toJSONQuick(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        clone(extraContext?: object): /*elided*/ any;
+        validate(): void;
+        clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        isValid(): boolean;
+        readonly cls: string;
+        getClsName(): string;
+        getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
+        id: string;
+        _id: string;
+        schemaVersion: string;
+        systemName: string;
+        readonly slug: string;
+        readonly isSystemEntity: boolean;
+    };
+} & {
+    new (...args: any[]): {
+        name: string;
+        setName(name: string): void;
+        _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        prop<T = undefined>(name: string, defaultValue: T): T;
+        prop<T = undefined>(name: string): T | undefined;
+        setProp(name: string, value: unknown): void;
+        unsetProp(name: string): void;
+        setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject): /*elided*/ any;
+        toJSON(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        toJSONSafe(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        toJSONQuick(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        clone(extraContext?: object): /*elided*/ any;
+        validate(): void;
+        clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        isValid(): boolean;
+        readonly cls: string;
+        getClsName(): string;
+        getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
+        id: string;
+        _id: string;
+        schemaVersion: string;
+        systemName: string;
+        readonly slug: string;
+        readonly isSystemEntity: boolean;
+    };
+} & {
+    new (...args: any[]): {
+        readonly isDefault: boolean;
+        _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        prop<T = undefined>(name: string, defaultValue: T): T;
+        prop<T = undefined>(name: string): T | undefined;
+        setProp(name: string, value: unknown): void;
+        unsetProp(name: string): void;
+        setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject): /*elided*/ any;
+        toJSON(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        toJSONSafe(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        toJSONQuick(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        clone(extraContext?: object): /*elided*/ any;
+        validate(): void;
+        clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
+        isValid(): boolean;
+        readonly cls: string;
+        getClsName(): string;
+        getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
+        getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
+        id: string;
+        _id: string;
+        schemaVersion: string;
+        systemName: string;
+        readonly slug: string;
+        readonly isSystemEntity: boolean;
+    };
+    readonly defaultConfig: object | null;
+    createDefault(): any;
+} & typeof InMemoryEntity;
 export declare const NamedDefaultableRepetitionImportantSettingsInMemoryEntity: {
     new (...args: any[]): {
         readonly important: any;

diff --git a/dist/js/entity/other.js b/dist/js/entity/other.js
diff --git a/dist/js/entity/set.d.ts b/dist/js/entity/set.d.ts
@@ -1,46 +1,7 @@
 import { InMemoryEntity } from "./in_memory";
 declare const InMemoryEntitySet_base: {
     new (...args: any[]): {
-        containsEntity<T extends {
-            inSet: import("./set/mixins").InSet[];
-            getInSetFilteredByCls(cls: string): {
-                _id: string;
-                cls?: string;
-                slug?: string;
-                type?: string;
-                index?: number;
-            }[];
-            readonly parentEntitySetReference: {
-                _id: string;
-                cls?: string;
-                slug?: string;
-                type?: string;
-                index?: number;
-            } | undefined;
-            _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
-            prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
-            prop<T_1 = undefined>(name: string): T_1 | undefined;
-            setProp(name: string, value: unknown): void;
-            unsetProp(name: string): void;
-            setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject): /*elided*/ any;
-            toJSON(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
-            toJSONSafe(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
-            toJSONQuick(exclude?: string[]): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
-            clone(extraContext?: object): /*elided*/ any;
-            validate(): void;
-            clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
-            isValid(): boolean;
-            readonly cls: string;
-            getClsName(): string;
-            getAsEntityReference(byIdOnly?: boolean): import("@mat3ra/esse/dist/js/types").EntityReferenceSchema;
-            getEntityByName(entities: InMemoryEntity[], entity: string, name: string): InMemoryEntity;
-            id: string;
-            _id: string;
-            schemaVersion: string;
-            systemName: string;
-            readonly slug: string;
-            readonly isSystemEntity: boolean;
-        } & InMemoryEntity>(entity?: T | undefined): boolean | undefined;
+        containsEntity<T extends import("@mat3ra/esse/dist/js/types").SystemInSetSchema>(entity?: T | undefined): boolean;
         _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
         prop<T = undefined>(name: string, defaultValue: T): T;
         prop<T = undefined>(name: string): T | undefined;

diff --git a/dist/js/entity/set/mixins.d.ts b/dist/js/entity/set/mixins.d.ts
@@ -44,10 +44,9 @@ export declare function InMemoryEntityInSetMixin<T extends InMemoryEntityConstru
         readonly isSystemEntity: boolean;
     };
 } & T;
-type BaseEntityInSet = InstanceType<ReturnType<typeof InMemoryEntityInSetMixin>>;
 export declare function InMemoryEntitySetMixin<T extends InMemoryEntityConstructor>(superclass: T): {
     new (...args: any[]): {
-        containsEntity<T_1 extends BaseEntityInSet>(entity?: T_1 | undefined): boolean | undefined;
+        containsEntity<T_1 extends SystemInSetSchema>(entity?: T_1 | undefined): boolean;
         _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
         prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
         prop<T_1 = undefined>(name: string): T_1 | undefined;
@@ -73,4 +72,3 @@ export declare function InMemoryEntitySetMixin<T extends InMemoryEntityConstruct
         readonly isSystemEntity: boolean;
     };
 } & T;
-export {};
diff --git a/dist/js/entity/set/mixins.js b/dist/js/entity/set/mixins.js
@@ -23,7 +23,8 @@ function InMemoryEntityInSetMixin(superclass) {
 function InMemoryEntitySetMixin(superclass) {
     return class InMemoryEntitySetMixin extends superclass {
         containsEntity(entity) {
-            return entity === null || entity === void 0 ? void 0 : entity.inSet.some((ref) => ref._id === this.id);
+            var _a;
+            return Boolean((_a = entity === null || entity === void 0 ? void 0 : entity.inSet) === null || _a === void 0 ? void 0 : _a.some((ref) => ref._id === this.id));
         }
     };
 }
diff --git a/dist/js/utils/types.d.ts b/dist/js/utils/types.d.ts
@@ -0,0 +1,2 @@
+export type Constructor<T> = new (...args: any[]) => T;
+export type AbstractConstructor<T> = abstract new (...args: any[]) => T;
diff --git a/dist/js/utils/types.js b/dist/js/utils/types.js
@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
diff --git a/src/js/entity/in_memory.ts b/src/js/entity/in_memory.ts
@@ -174,7 +174,7 @@ export class InMemoryEntity implements BaseInMemoryEntitySchema {
         }
     }
 
-    static get cls() {
+    static get cls(): string {
         return this.prototype.constructor.name;
     }
 

diff --git a/src/js/entity/mixins/props.ts b/src/js/entity/mixins/props.ts
@@ -8,9 +8,12 @@ import {
     type NameEntitySchema,
 } from "@mat3ra/esse/dist/js/types";
 
-import { InMemoryEntityConstructor } from "../in_memory";
+import type { Constructor } from "../../utils/types";
+import { type InMemoryEntity, InMemoryEntityConstructor } from "../in_memory";
 
-export function DefaultableMixin<T extends InMemoryEntityConstructor>(superclass: T) {
+export function DefaultableMixin<
+    T extends Constructor<InMemoryEntity> = Constructor<InMemoryEntity>,
+>(superclass: T) {
     class DefaultableMixin extends superclass implements DefaultableEntitySchema {
         get isDefault() {
             return this.prop("isDefault", false);

diff --git a/src/js/entity/other.ts b/src/js/entity/other.ts
@@ -16,13 +16,12 @@ export const NamedInMemoryEntity = NamedEntityMixin(InMemoryEntity);
 
 export const NamedDefaultableInMemoryEntity = NamedEntityMixin(DefaultableMixin(InMemoryEntity));
 
-export class HasMetadataNamedDefaultableInMemoryEntity extends HasMetadataMixin(
+export const HasMetadataNamedDefaultableInMemoryEntity = HasMetadataMixin(
     NamedEntityMixin(DefaultableMixin(InMemoryEntity)),
-) {}
+);
 
-export class HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity extends HasConsistencyChecksMixin(
-    HasMetadataNamedDefaultableInMemoryEntity,
-) {}
+export const HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity =
+    HasConsistencyChecksMixin(HasMetadataNamedDefaultableInMemoryEntity);
 
 export const NamedDefaultableRepetitionImportantSettingsInMemoryEntity =
     ImportantSettingsProviderMixin(

diff --git a/src/js/entity/set/mixins.ts b/src/js/entity/set/mixins.ts
@@ -27,12 +27,10 @@ export function InMemoryEntityInSetMixin<T extends InMemoryEntityConstructor>(su
     };
 }
 
-type BaseEntityInSet = InstanceType<ReturnType<typeof InMemoryEntityInSetMixin>>;
-
 export function InMemoryEntitySetMixin<T extends InMemoryEntityConstructor>(superclass: T) {
     return class InMemoryEntitySetMixin extends superclass {
-        containsEntity<T extends BaseEntityInSet>(entity?: T) {
-            return entity?.inSet.some((ref) => ref._id === this.id);
+        containsEntity<T extends SystemInSetSchema>(entity?: T) {
+            return Boolean(entity?.inSet?.some((ref) => ref._id === this.id));
         }
     };
 }
diff --git a/src/js/utils/types.ts b/src/js/utils/types.ts
@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export type Constructor<T> = new (...args: any[]) => T;
+
+export type AbstractConstructor<T> = abstract new (...args: any[]) => T;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export type Constructor<T> = new (...args: any[]) => T;
		export type AbstractConstructor<T> = abstract new (...args: any[]) => T;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		"use strict";
		Object.defineProperty(exports, "__esModule", { value: true });
-Original file line number
+Diff line change
@@ Expand Up @@
             }
         }
-        static get cls() {
+        static get cls(): string {
             return this.prototype.constructor.name;
         }
@@ Expand Down @@