Require @orbit decorator to inject orbit services (#436)

* Use @orbit decorator to inject orbit services

* Rename services

* Pass owner to setupOrbit

* Fix order

* Update package.json

* Simplify decorator

* Update rollup.config.mjs

* Update README.md

* Update README.md

Author: RobbieTheWagner

README.md

@@ -88,9 +88,10 @@ In a new vite based app, we can use `import.meta.glob` to grab all the things we
 to register and pass them to `setupOrbit. You may want to set this up in your application route's `beforeModel` hook.
 
 ```ts
+import { getOwner } from "@ember/owner";
+import type Owner from "@ember/owner";
 import Route from "@ember/routing/route";
-import { service } from "@ember/service";
-import { setupOrbit, type Store } from "ember-orbit";
+import { orbit, setupOrbit, type Store } from "ember-orbit";
 import type Coordinator from "@orbit/coordinator";
 
 const dataModels = import.meta.glob("../data-models/*.{js,ts}", {
@@ -104,11 +105,14 @@ const dataStrategies = import.meta.glob("../data-strategies/*.{js,ts}", {
 });
 
 export default class ApplicationRoute extends Route {
-  @service declare dataCoordinator: Coordinator;
-  @service declare store: Store;
+  @orbit declare dataCoordinator: Coordinator;
+  @orbit declare store: Store;
 
   async beforeModel() {
+    const owner = getOwner(this) as Owner;
+
     setupOrbit(
+      owner,
       {
         ...dataModels,
         ...dataSources,
@@ -138,24 +142,6 @@ must be handled in each individual source.
 In a classic ember-cli app, we are not able to use `import.meta.glob` out of the box yet.
 Until ember-cli is updated to support this, you will need to install [ember-classic-import-meta-glob](https://github.com/NullVoxPopuli/ember-classic-import-meta-glob) to get it to work.
 
-### Registering services
-
-In your `app/app.ts` you will need to register all the services as well.
-It should be something like this:
-
-```ts
-import emberOrbitRegistry from "ember-orbit/registry.ts";
-
-// ...
-
-modules = {
-  // if the app is using ember-strict-application-resolver
-  ...emberOrbitRegistry(),
-  // or if using ember-resolver
-  ...emberOrbitRegistry("name-of-app"),
-};
-```
-
 ## Usage
 
 EO creates the following directories by default:
@@ -188,6 +174,20 @@ EO installs the following services by default:
   and local IDs for scenarios in which a server does not accept client-generated
   IDs.
 
+### Orbit Decorator Usage
+
+The `@orbit` decorator allows you to inject orbit services that are registered in `orbitRegistry.services` instead of using Ember's `@service` decorator. This decouples your services from Ember's owner system.
+
+```ts
+import { orbit } from "ember-orbit";
+
+class MyComponent {
+  @orbit declare dataCoordinator;
+
+  @orbit declare store;
+}
+```
+
 ### Defining models
 
 Models are used to access the underlying data in an EO `Store`.
@@ -633,9 +633,10 @@ enable the coordinator. Let's do this in our application route's `beforeModel`
 hook (in `app/routes/application.js`):
 
 ```ts
+import { getOwner } from "@ember/owner";
+import type Owner from "@ember/owner";
 import Route from "@ember/routing/route";
-import { service } from "@ember/service";
-import { setupOrbit, type Store } from "ember-orbit";
+import { orbit, setupOrbit, type Store } from "ember-orbit";
 import type Coordinator from "@orbit/coordinator";
 
 const dataModels = import.meta.glob("../data-models/*.{js,ts}", {
@@ -649,11 +650,14 @@ const dataStrategies = import.meta.glob("../data-strategies/*.{js,ts}", {
 });
 
 export default class ApplicationRoute extends Route {
-  @service declare dataCoordinator: Coordinator;
-  @service declare store: Store;
+  @orbit declare dataCoordinator: Coordinator;
+  @orbit declare store: Store;
 
   async beforeModel() {
+    const owner = getOwner(this) as Owner;
+
     setupOrbit(
+      owner,
       {
         ...dataModels,
         ...dataSources,

package.json

@@ -117,14 +117,7 @@
     "version": 2,
     "type": "addon",
     "main": "addon-main.cjs",
-    "app-js": {
-      "./services/data-coordinator.js": "./dist/_app_/services/data-coordinator.js",
-      "./services/data-key-map.js": "./dist/_app_/services/data-key-map.js",
-      "./services/data-normalizer.js": "./dist/_app_/services/data-normalizer.js",
-      "./services/data-schema.js": "./dist/_app_/services/data-schema.js",
-      "./services/data-validator.js": "./dist/_app_/services/data-validator.js",
-      "./services/store.js": "./dist/_app_/services/store.js"
-    }
+    "app-js": {}
   },
   "imports": {
     "#src/*": "./src/*"

rollup.config.mjs

@@ -25,12 +25,7 @@ export default {
     // up your addon's public API. Also make sure your package.json#exports
     // is aligned to the config here.
     // See https://github.com/embroider-build/embroider/blob/main/docs/v2-faq.md#how-can-i-define-the-public-exports-of-my-addon
-    addon.publicEntrypoints([
-      'index.js',
-      'registry.js',
-      'services/**/*.js',
-      'test-support/**/*.js',
-    ]),
+    addon.publicEntrypoints(['index.js', 'test-support/**/*.js']),
 
     // These are the modules that should get reexported into the traditional
     // "app" tree. Things in here should also be in publicEntrypoints above, but

src/-private/decorators/orbit.ts

@@ -0,0 +1,44 @@
+import { orbitRegistry } from '../utils/orbit-registry.ts';
+
+function getDescriptor(serviceName: string) {
+  return {
+    get() {
+      const services = orbitRegistry.services;
+      const service = services[serviceName as keyof typeof services];
+
+      if (service === undefined) {
+        throw new Error(
+          `No orbit service named '${serviceName}' was found. Available services: ${Object.keys(services).join(', ')}`,
+        );
+      }
+
+      return service;
+    },
+    configurable: true,
+    enumerable: true,
+  };
+}
+
+/**
+ * Decorator that injects orbit services from the orbitRegistry
+ * This provides an alternative to Ember's @service decorator that is decoupled from Ember's owner.
+ *
+ * Usage:
+ * - @orbit declare dataCoordinator;
+ * - @orbit('keyMap') declare myKeyMap;
+ */
+export function orbit(
+  nameOrTarget?: unknown,
+  propertyKey?: string | symbol,
+): any {
+  // Direct decorator usage: @orbit
+  if (propertyKey !== undefined) {
+    return getDescriptor(String(propertyKey));
+  }
+
+  // Factory decorator usage: @orbit() or @orbit('name')
+  const name = nameOrTarget as string | undefined;
+  return function (_target: any, propertyKey: string | symbol) {
+    return getDescriptor(name ?? String(propertyKey));
+  };
+}

src/-private/factories/coordinator-factory.ts

@@ -0,0 +1,29 @@
+import { orbitRegistry } from '../utils/orbit-registry.ts';
+import { Coordinator, type CoordinatorOptions } from '@orbit/coordinator';
+
+type CoordinatorInjections = {
+  sourceNames?: string[];
+  strategyNames?: string[];
+} & CoordinatorOptions;
+
+export default {
+  create(): Coordinator {
+    const injections: CoordinatorInjections = {};
+
+    const sourceNames = Object.keys(orbitRegistry.registrations.sources);
+    injections.sources = sourceNames
+      .map((name) => {
+        return orbitRegistry.registrations.sources[name];
+      })
+      .filter((source) => !!source);
+
+    const strategyNames = Object.keys(orbitRegistry.registrations.strategies);
+    injections.strategies = strategyNames
+      .map((name) => {
+        return orbitRegistry.registrations.strategies[name];
+      })
+      .filter((strategy) => !!strategy);
+
+    return new Coordinator(injections);
+  },
+};

src/-private/services/data-coordinator.ts

@@ -6,8 +6,8 @@ import { orbitRegistry } from '../utils/orbit-registry.ts';
 
 export default {
   create(injections: ModelRecordNormalizerSettings): ModelAwareNormalizer {
-    injections.keyMap = orbitRegistry.services.keyMap;
-    injections.schema = orbitRegistry.services.schema;
+    injections.keyMap = orbitRegistry.services.dataKeyMap;
+    injections.schema = orbitRegistry.services.dataSchema;
 
     return new ModelAwareNormalizer(injections);
   },

src/-private/services/data-normalizer.ts

@@ -2,7 +2,7 @@ import Store, { type StoreSettings } from '../store.ts';
 import type {
   ModelAwareQueryBuilder,
   ModelAwareTransformBuilder,
-} from '../utils/model-aware-types';
+} from '../utils/model-aware-types.ts';
 import { orbitRegistry } from '../utils/orbit-registry.ts';
 import type { RequestOptions } from '@orbit/data';
 import type MemorySource from '@orbit/memory';