feat(soba/abstractions): rename injectHelper to helper

nartc · nartc · commit bcfefe0ad820 · 2025-03-22T08:49:44.000-05:00
diff --git a/libs/soba/abstractions/src/lib/helper.ts b/libs/soba/abstractions/src/lib/helper.ts
@@ -16,7 +16,7 @@ import { Object3D } from 'three';
 
 type HelperArgs<T> = T extends [infer _, ...infer R] ? R : never;
 
-export function injectHelper<
+export function helper<
 	TConstructor extends new (...args: any[]) => THREE.Object3D,
 	THelperInstance extends InstanceType<TConstructor> & { update: () => void; dispose: () => void },
 >(
@@ -27,7 +27,7 @@ export function injectHelper<
 		args = () => [] as unknown as HelperArgs<ConstructorParameters<TConstructor>>,
 	}: { injector?: Injector; args?: () => HelperArgs<ConstructorParameters<TConstructor>> } = {},
 ) {
-	return assertInjector(injectHelper, injector, () => {
+	return assertInjector(helper, injector, () => {
 		const store = injectStore();
 
 		const helper = computed(() => {
@@ -65,6 +65,12 @@ export function injectHelper<
 	});
 }
 
+/**
+ * @deprecated use helper instead. Will be removed in v5.0.0
+ * @since v4.0.0
+ */
+export const injectHelper = helper;
+
 @Component({
 	selector: 'ngts-helper',
 	template: `
@@ -89,7 +95,7 @@ export class NgtsHelper<TConstructor extends new (...args: any[]) => THREE.Objec
 		return instanceState.parent() as unknown as THREE.Object3D;
 	});
 
-	helper = injectHelper(this.parent, this.type, { args: this.options });
+	helper = helper(this.parent, this.type, { args: this.options });
 
 	constructor() {
 		extend({ Object3D });
diff --git a/libs/soba/src/performances/bvh.stories.ts b/libs/soba/src/performances/bvh.stories.ts
@@ -10,7 +10,7 @@ import {
 } from '@angular/core';
 import { Meta } from '@storybook/angular';
 import { beforeRender, NgtArgs, NgtThreeElements } from 'angular-three';
-import { injectHelper } from 'angular-three-soba/abstractions';
+import { helper } from 'angular-three-soba/abstractions';
 import { NgtsOrbitControls } from 'angular-three-soba/controls';
 import { NgtsBVH } from 'angular-three-soba/performances';
 import * as THREE from 'three';
@@ -44,7 +44,7 @@ class TorusBVH {
 	protected color = signal('#ff0000');
 
 	constructor() {
-		injectHelper(this.meshRef, () => MeshBVHHelper);
+		helper(this.meshRef, () => MeshBVHHelper);
 	}
 }
 
diff --git a/libs/soba/staging/src/lib/caustics.ts b/libs/soba/staging/src/lib/caustics.ts
@@ -9,7 +9,7 @@ import {
 	viewChild,
 } from '@angular/core';
 import { beforeRender, extend, getInstanceState, NgtThreeElements, omit, pick, resolveRef } from 'angular-three';
-import { injectHelper, NgtsEdges } from 'angular-three-soba/abstractions';
+import { helper, NgtsEdges } from 'angular-three-soba/abstractions';
 import { fbo } from 'angular-three-soba/misc';
 import { CausticsProjectionMaterial, createCausticsUpdate } from 'angular-three-soba/vanilla-exports';
 import { mergeInputs } from 'ngxtension/inject-inputs';
@@ -158,7 +158,7 @@ export class NgtsCaustics {
 	protected causticsTarget = fbo(this.causticsTargetParams);
 	protected causticsTargetB = fbo(this.causticsTargetParams);
 
-	private cameraHelper = injectHelper(
+	private cameraHelper = helper(
 		() => (this.debug() ? this.cameraRef().nativeElement : null),
 		() => THREE.CameraHelper,
 	);
