Rename useResource() to createResource() in ShadowObjectParams API (#4)

* Initial plan

* Rename useResource() to createResource() in ShadowObjectParams API

Co-authored-by: spearwolf <12805+spearwolf@users.noreply.github.com>

* Keep useResource() in 0.23.0 CHANGELOG entry to preserve history

Co-authored-by: spearwolf <12805+spearwolf@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: spearwolf <12805+spearwolf@users.noreply.github.com>

Author: Copilot

packages/shadow-objects/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to [@spearwolf/shadow-objects](https://github.com/spearwolf/
 The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+- renamed `useResource()` to `createResource()` in `ShadowObjectParams` interface
+
 ## [0.23.0] - 2025-11-26
 
 - enhance the shadow-objects creation api _aka_ `ShadowObjectParams`

packages/shadow-objects/README.md

@@ -106,7 +106,7 @@ The `ShadowObjectParams` object provides all necessary tools to interact with th
 | **`useParentContext(name)`** | Skips the current Entity and consumes context directly from the parent. |
 | **`provideContext(name, value)`** | Provides a context value (or signal) to descendant Entities. |
 | **`provideGlobalContext(name, value)`** | Provides a context value globally to all Entities. |
-| **`useResource(factory, cleanup)`** | Manages an external resource (e.g., a Three.js object) with automatic cleanup when dependencies change. |
+| **`createResource(factory, cleanup)`** | Manages an external resource (e.g., a Three.js object) with automatic cleanup when dependencies change. |
 | **`createEffect(callback)`** | Runs a side effect whenever accessed signals change. |
 | **`createSignal(initialValue)`** | Creates a local reactive state signal. |
 | **`createMemo(factory)`** | Creates a derived signal that updates only when dependencies change. |

packages/shadow-objects/src/in-the-dark/Kernel.spec.ts

@@ -547,7 +547,7 @@ describe('Kernel', () => {
       });
     });
 
-    describe('useResource', () => {
+    describe('createResource', () => {
       it('should create a resource and call cleanup on entity destruction', () => {
         const registry = new Registry();
         const kernel = new Kernel(registry);
@@ -559,8 +559,8 @@ describe('Kernel', () => {
 
         @ShadowObject({registry, token: 'testResource'})
         class TestResource {
-          constructor({useResource}: ShadowObjectParams) {
-            resourceSignal = useResource(createFn, cleanupFn);
+          constructor({createResource}: ShadowObjectParams) {
+            resourceSignal = createResource(createFn, cleanupFn);
           }
         }
         expect(TestResource).toBeDefined();
@@ -587,8 +587,8 @@ describe('Kernel', () => {
 
         @ShadowObject({registry, token: 'testUndefinedResource'})
         class TestUndefinedResource {
-          constructor({useResource}: ShadowObjectParams) {
-            useResource(createFn, cleanupFn);
+          constructor({createResource}: ShadowObjectParams) {
+            createResource(createFn, cleanupFn);
           }
         }
         expect(TestUndefinedResource).toBeDefined();

packages/shadow-objects/src/in-the-dark/Kernel.ts

@@ -442,7 +442,7 @@ export class Kernel {
           return result;
         },
 
-        useResource<T>(factory: () => T | undefined, cleanup?: (resource: T) => void): Signal<T | undefined> {
+        createResource<T>(factory: () => T | undefined, cleanup?: (resource: T) => void): Signal<T | undefined> {
           const resourceSignal = createSignal<T | undefined>(undefined);
           unsubscribeSecondary.add(() => destroySignal(resourceSignal));
 

packages/shadow-objects/src/types.ts

@@ -112,7 +112,7 @@ export interface ShadowObjectParams {
   useProperty<T = any>(name: string, isEqual?: CompareFunc<T>): SignalReader<T>;
   useProperties<K extends string>(props: Record<K, string>): Record<K, SignalReader<any>>;
 
-  useResource<T>(factory: () => T | undefined, cleanup?: (resource: T) => void): Signal<T | undefined>;
+  createResource<T>(factory: () => T | undefined, cleanup?: (resource: T) => void): Signal<T | undefined>;
 
   createEffect(...args: Parameters<typeof createEffect>): ReturnType<typeof createEffect>;
   createSignal<T = unknown>(...args: Parameters<typeof createSignal<T>>): ReturnType<typeof createSignal<T>>;