@mittwald/react-ghostmaker 1.2.0 → 1.3.0

package/README.md

@@ -841,21 +841,19 @@ Creates a ghost proxy from any object or class instance.
 - **`.invalidate(queryClient)`** - Invalidate this specific ghost's cached data
 - **`await ghost`** - Directly await the ghost to get the resolved value
 
+
 ### Utility Functions
 
 - **`asGhostProps(props)`** - Converts props to ghost-compatible format
-- **`registerModelIdentifier(fn)`** - Register ID extraction function for
-  caching
+- **`GhostMakerModel(options)`** - Decorator to define model name and ID for automatic query key generation
 - **`invalidateGhostsById(id)`** - Globally invalidate cached data by ID
 - **`getGhostId(ghost)`** - Get the unique ID of a ghost
 
 ### Types
 
-- **`MaybeReactGhost<T>`** - Type for props that accept both ghosts and regular
-  objects
+- **`MaybeReactGhost<T>`** - Type for props that accept both ghosts and regular objects
 - **`ReactGhost<T>`** - Type for ghost proxy objects
-- **`UseGhostReturn<T>`** - Return type of `useGhost()` with
-  `{ value, invalidate }`
+- **`UseGhostReturn<T>`** - Return type of `useGhost()` with `{ value, invalidate }`
 
 ## 🤝 Requirements
 

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 export { makeGhost } from "./makeGhost";
+export { registerModelIdentifier } from "./modelIdentifier";
 export { getQueryContext, forwardQueryContext } from "./context";
 export { invalidateGhosts } from "./invalidate";
 export * from "./maybeGhost";
-export { GhostMakerModel } from "./metaData";
+export { GhostMakerModel, ghostMakerModel } from "./metaData";
 export { getModelId, getModelName } from "./queries";

package/dist/esm/metaData.js

@@ -1,9 +1,36 @@
+import is from "@sindresorhus/is";
 const store = new Map();
-export const getMetaData = (something) => {
-    return store.get(something);
-};
 export function GhostMakerModel(options) {
     return function (target) {
         store.set(target, options);
     };
 }
+const modelIdentifiers = [];
+export function ghostMakerModel(modelIdentifier) {
+    modelIdentifiers.push(modelIdentifier);
+}
+const getMetaDataFromIdentifiers = (something) => {
+    for (const identifyModel of modelIdentifiers) {
+        const meta = identifyModel(something);
+        if (meta) {
+            return meta;
+        }
+    }
+};
+export const getMetaData = (something) => {
+    return (getMetaDataRecursive(something, undefined, is.object(something) ? something.constructor : undefined) ?? getMetaDataFromIdentifiers(something));
+};
+const getMetaDataRecursive = (something, collectedOptions, 
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+klass) => {
+    const currentClass = is.object(something) ? something.constructor : undefined;
+    const meta = store.get(klass ?? currentClass);
+    const mergedMeta = meta || collectedOptions ? { ...meta, ...collectedOptions } : undefined;
+    if (mergedMeta && "getId" in mergedMeta && "name" in mergedMeta) {
+        return mergedMeta;
+    }
+    if (!klass) {
+        return mergedMeta;
+    }
+    return getMetaDataRecursive(something, mergedMeta, Object.getPrototypeOf(klass));
+};

package/dist/esm/queries.js

@@ -3,35 +3,15 @@ import { hashObject } from "./hash";
 import { getMetaData } from "./metaData";
 import { modelIdentifiers } from "./modelIdentifier";
 export const getModelName = (something) => {
-    const isObject = is.object(something);
-    const getModelNameRecursive = (
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-    klass) => {
-        if (!klass) {
-            return;
-        }
-        return (getMetaData(klass)?.name ??
-            getModelNameRecursive(Object.getPrototypeOf(klass)));
-    };
-    const klass = isObject ? something.constructor : undefined;
-    return getModelNameRecursive(klass);
+    return getMetaData(something)?.name;
 };
 export const getModelId = (something) => {
-    const isObject = is.object(something);
-    const getIdRecursive = (
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-    klass) => {
-        if (!klass) {
-            return;
-        }
-        const getId = getMetaData(klass)?.getId;
+    if (is.object(something)) {
+        const getId = getMetaData(something)?.getId;
         if (getId) {
             return getId(something);
         }
-        return getIdRecursive(Object.getPrototypeOf(klass));
-    };
-    const klass = isObject ? something.constructor : undefined;
-    return getIdRecursive(klass);
+    }
 };
 const getObjectName = (something) => {
     const modelName = getModelName(something);

package/dist/types/index.d.ts

@@ -1,7 +1,8 @@
 export { makeGhost } from "./makeGhost";
+export { registerModelIdentifier } from "./modelIdentifier";
 export { type ReactGhost, UseGhostReturn } from "./types";
 export { getQueryContext, forwardQueryContext } from "./context";
 export { invalidateGhosts } from "./invalidate";
 export * from "./maybeGhost";
-export { GhostMakerModel } from "./metaData";
+export { GhostMakerModel, ghostMakerModel } from "./metaData";
 export { getModelId, getModelName } from "./queries";

package/dist/types/metaData.d.ts

@@ -1,8 +1,11 @@
-import type { Class } from "type-fest";
-interface GhostMakerModelOptions<T extends Class<unknown>> {
+import type { AbstractClass, Class } from "type-fest";
+type DecoratorTarget = Class<unknown> | AbstractClass<unknown>;
+interface GhostMakerModelMeta<T extends DecoratorTarget> {
     getId?: (instance: InstanceType<T>) => string;
     name?: string;
 }
-export declare const getMetaData: (something: unknown) => GhostMakerModelOptions<Class<unknown>> | undefined;
-export declare function GhostMakerModel<T extends Class<unknown>>(options: GhostMakerModelOptions<T>): (target: T) => void;
+export declare function GhostMakerModel<T extends DecoratorTarget>(options: GhostMakerModelMeta<T>): (target: T) => void;
+type IdentifyModel = (something: unknown) => GhostMakerModelMeta<DecoratorTarget> | undefined;
+export declare function ghostMakerModel(modelIdentifier: IdentifyModel): void;
+export declare const getMetaData: (something: unknown) => GhostMakerModelMeta<DecoratorTarget> | undefined;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/react-ghostmaker",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "contributors": [
     "Marco Falkenberg <m.falkenberg@mittwald.de>"