@mittwald/react-ghostmaker 1.5.3 → 1.6.0

package/README.md

@@ -497,6 +497,27 @@ class Blog {
 - Name and ID can be set explicitly (for readable query keys)
 - Works for multiple models and inheritance
 
+#### Framework-agnostic model code
+
+If your models live in code that must not depend on React (a shared model
+package, server-side or CLI code), import the decorator from the
+`@mittwald/react-ghostmaker/model` entry point instead of the main entry:
+
+```ts
+import { GhostMakerModel } from "@mittwald/react-ghostmaker/model";
+```
+
+This entry point only contains what is needed to describe models —
+`GhostMakerModel`, `ghostMakerModel`, `getModelName`, `getModelId` and the
+`GhostMakerModelMeta` and `DynamicModel` types — and imports neither React nor
+TanStack Query, not even for its type declarations. `react` and
+`@tanstack/react-query` are therefore optional peer dependencies: you only need
+them where you import from the main entry (`@mittwald/react-ghostmaker`), i.e.
+where you actually create and use ghosts.
+
+Both entry points share the same model registry, so models decorated via
+`/model` are recognized by ghosts created via the main entry.
+
 #### Alternative: `registerModelIdentifier` (deprecated)
 
 The previous `registerModelIdentifier` function is still available but marked as deprecated. It can be used to centrally register IDs for models:
@@ -861,6 +882,9 @@ Creates a ghost proxy from any object or class instance.
 - TanStack Query ^5
 - TypeScript (recommended)
 
+React and TanStack Query are only required for the main entry point, not for
+[`@mittwald/react-ghostmaker/model`](#framework-agnostic-model-code).
+
 ## 📄 License
 
 MIT © [Mittwald CM Service GmbH & Co. KG](https://github.com/mittwald)

package/dist/esm/index.js

@@ -3,5 +3,4 @@ export { registerModelIdentifier } from "./modelIdentifier.js";
 export { getQueryContext, forwardQueryContext } from "./context.js";
 export { invalidateGhosts } from "./invalidate.js";
 export * from "./maybeGhost/index.js";
-export { GhostMakerModel, ghostMakerModel } from "./metaData.js";
-export { getModelId, getModelName } from "./queries.js";
+export { GhostMakerModel, ghostMakerModel, getModelId, getModelName, } from "./metaData.js";

package/dist/esm/makeGhost.test-d.js

@@ -40,3 +40,10 @@ test("asGhost() works with generics", () => {
         asGhost(prop).foo().use();
     }
 });
+test("calling function on optional props works", () => {
+    const customerNameGhost = ProjectGhost.ofId("Project A")
+        .getDetailed()
+        .optionalCustomer?.getDetailed()
+        .getName();
+    expectTypeOf(customerNameGhost).toEqualTypeOf();
+});

package/dist/esm/metaData.js

@@ -36,6 +36,17 @@ export const getMetaData = (something) => {
     return (getMetaDataRecursive(something, undefined, getClass(something)) ??
         getDynamicMetaData(something));
 };
+export const getModelName = (something) => {
+    return getMetaData(something)?.name;
+};
+export const getModelId = (something) => {
+    if (is.object(something)) {
+        const getId = getMetaData(something)?.getId;
+        if (getId) {
+            return getId(something);
+        }
+    }
+};
 const getMetaDataRecursive = (something, collectedMeta, 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 klass) => {

package/dist/esm/model.js

@@ -0,0 +1 @@
+export { GhostMakerModel, ghostMakerModel, getModelId, getModelName, } from "./metaData.js";

package/dist/esm/queries.js

@@ -1,18 +1,7 @@
 import is from "@sindresorhus/is";
 import { hashObject } from "./hash.js";
-import { getMetaData } from "./metaData.js";
+import { getModelId, getModelName } from "./metaData.js";
 import { modelIdentifiers } from "./modelIdentifier.js";
-export const getModelName = (something) => {
-    return getMetaData(something)?.name;
-};
-export const getModelId = (something) => {
-    if (is.object(something)) {
-        const getId = getMetaData(something)?.getId;
-        if (getId) {
-            return getId(something);
-        }
-    }
-};
 const getObjectName = (something) => {
     const modelName = getModelName(something);
     if (modelName) {

package/dist/esm/reactFreeEntries.test.js

@@ -0,0 +1,39 @@
+import { readFileSync } from "node:fs";
+import { dirname, resolve } from "node:path";
+import ts from "typescript";
+import { describe, expect, test } from "vitest";
+const srcDir = __dirname;
+const isReactPackage = (specifier) => /^(react|react-dom|@tanstack\/react-query)(\/|$)/.test(specifier);
+const collectPackageImports = (entry) => {
+    const packageImports = new Map();
+    const visited = new Set();
+    const queue = [resolve(srcDir, entry)];
+    while (queue.length > 0) {
+        const file = queue.pop();
+        if (visited.has(file)) {
+            continue;
+        }
+        visited.add(file);
+        const { importedFiles } = ts.preProcessFile(readFileSync(file, "utf8"), true, true);
+        for (const { fileName: specifier } of importedFiles) {
+            if (specifier.startsWith(".")) {
+                queue.push(resolve(dirname(file), specifier));
+            }
+            else {
+                const importers = packageImports.get(specifier) ?? [];
+                importers.push(file.slice(srcDir.length + 1));
+                packageImports.set(specifier, importers);
+            }
+        }
+    }
+    return packageImports;
+};
+describe.each(["model.ts", "polytype.ts"])("entry point %s", (entry) => {
+    test("does not import React or TanStack Query, not even for types", () => {
+        const reactImports = Array.from(collectPackageImports(entry)).filter(([specifier]) => isReactPackage(specifier));
+        expect(Object.fromEntries(reactImports)).toEqual({});
+    });
+});
+test("the import walker detects React imports", () => {
+    expect(collectPackageImports("index.ts").has("react")).toBe(true);
+});

package/dist/esm/testMocks.js

@@ -186,6 +186,7 @@ let ProjectDetailed = (() => {
         id;
         name;
         customer;
+        optionalCustomer;
         constructor(id, name, customerId) {
             this.id = id;
             this.name = name;

package/dist/types/index.d.ts

@@ -4,5 +4,4 @@ export { type ReactGhost, UseGhostReturn } from "./types.ts";
 export { getQueryContext, forwardQueryContext } from "./context.ts";
 export { invalidateGhosts } from "./invalidate.ts";
 export * from "./maybeGhost/index.ts";
-export { GhostMakerModel, ghostMakerModel } from "./metaData.ts";
-export { getModelId, getModelName } from "./queries.ts";
+export { GhostMakerModel, ghostMakerModel, getModelId, getModelName, type DynamicModel, type GhostMakerModelMeta, } from "./metaData.ts";

package/dist/types/metaData.d.ts

@@ -1,13 +1,15 @@
 import type { AbstractClass, Class } from "type-fest";
 type DecoratorTarget = Class<unknown> | AbstractClass<unknown>;
-interface GhostMakerModelMeta<T extends DecoratorTarget> {
+export interface GhostMakerModelMeta<T extends DecoratorTarget> {
     getId?: (instance: InstanceType<T>) => string;
     name?: string;
 }
 export declare function GhostMakerModel<T extends DecoratorTarget>(options: GhostMakerModelMeta<T>): (target: T) => void;
-type DynamicModel = (something: unknown) => GhostMakerModelMeta<DecoratorTarget> | void | undefined;
+export type DynamicModel = (something: unknown) => GhostMakerModelMeta<DecoratorTarget> | void | undefined;
 export declare function ghostMakerModel(modelIdentifier: DynamicModel): void;
 export declare const getMetaData: (something: unknown) => GhostMakerModelMeta<DecoratorTarget> | undefined;
+export declare const getModelName: (something: unknown) => string | undefined;
+export declare const getModelId: (something: unknown) => string | undefined;
 export declare const getProtoypes: {
     current: (something: unknown) => any[];
 };

package/dist/types/model.d.ts

@@ -0,0 +1 @@
+export { GhostMakerModel, ghostMakerModel, getModelId, getModelName, type DynamicModel, type GhostMakerModelMeta, } from "./metaData.ts";

package/dist/types/queries.d.ts

@@ -1,6 +1,4 @@
 import type { GhostChain, GhostChainItem, QueryKey } from "./types.ts";
-export declare const getModelName: (something: unknown) => string | undefined;
-export declare const getModelId: (something: unknown) => string | undefined;
 export declare const queries: {
     ghostmaker: () => string[];
     target: (target: unknown) => string[];

package/dist/types/reactFreeEntries.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/testMocks.d.ts

@@ -37,6 +37,7 @@ export declare class ProjectDetailed {
     readonly id: string;
     readonly name: string;
     readonly customer: Customer;
+    readonly optionalCustomer?: Customer;
     constructor(id: string, name: string, customerId: string);
     getName(): string;
     getStatus(): Promise<string>;

package/dist/types/types.d.ts

@@ -22,7 +22,7 @@ export declare const transformFnProp: "___transformFn";
 export declare const isGhostMarker: "___ghostMarker";
 type GhostProp<V, TOriginal> = V extends AnyFunction ? (...args: Parameters<V>) => ReactGhost<Awaited<ReturnType<V>> | OrOptional<TOriginal>> : ReactGhost<V | OrOptional<TOriginal>>;
 export type ReactGhost<T> = ReactGhostMethods<T> & {
-    [K in keyof NonNullable<T>]-?: GhostProp<NonNullable<T>[K], T>;
+    [K in keyof NonNullable<T>]-?: Exclude<GhostProp<NonNullable<T>[K], T>, ReactGhost<undefined>>;
 };
 export interface GhostChainItem {
     propName: string | typeof transformFnProp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/react-ghostmaker",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "contributors": [
     "Marco Falkenberg <m.falkenberg@mittwald.de>"
@@ -27,6 +27,10 @@
       "types": "./dist/types/index.d.ts",
       "import": "./dist/esm/index.js"
     },
+    "./model": {
+      "types": "./dist/types/model.d.ts",
+      "import": "./dist/esm/model.js"
+    },
     "./polytype": {
       "types": "./dist/types/polytype.d.ts",
       "import": "./dist/esm/polytype.js"
@@ -78,8 +82,14 @@
     "react": ">=19.2"
   },
   "peerDependenciesMeta": {
+    "@tanstack/react-query": {
+      "optional": true
+    },
     "polytype": {
       "optional": true
+    },
+    "react": {
+      "optional": true
     }
   },
   "scripts": {