Merge pull request #20288 from emberjs/stabilize-owner-types

[FEATURE] Stable types for `@ember/owner`

.eslintignore

@@ -7,4 +7,4 @@ dist/
 tmp/
 smoke-tests/
 types/
-type-tests/preview
+type-tests/

.github/workflows/ci.yml

@@ -43,8 +43,10 @@ jobs:
           cache: yarn
       - name: install dependencies
         run: yarn install --frozen-lockfile --non-interactive
-      - name: Check types
-        run: yarn type-check
+      - name: build stable type definitions
+        run: yarn build:types
+      - name: Check published types
+        run: yarn type-check:types
 
   types-range:
     name: Type Checking (other supported versions)
@@ -61,10 +63,12 @@ jobs:
           cache: yarn
       - name: install dependencies
         run: yarn install --frozen-lockfile --non-interactive
+      - name: build stable type definitions
+        run: yarn build:types
       - name: install TS@${{matrix.ts-version}}
         run: yarn add -D typescript@${{ matrix.ts-version }}
-      - name: Check types with TS@${{matrix.ts-version}}
-        run: yarn type-check
+      - name: Check published types with TS@${{matrix.ts-version}}
+        run: yarn type-check:types
 
   basic-test:
     name: Debug and Prebuilt (All Tests by Package + Canary Features)

package.json

@@ -33,9 +33,10 @@
     "url": "git+https://github.com/emberjs/ember.js.git"
   },
   "scripts": {
-    "build": "ember build --environment production",
+    "build:js": "ember build --environment production",
+    "build:types": "node types/publish.mjs",
+    "build": "npm-run-all build:*",
     "docs": "ember ember-cli-yuidoc",
-    "types": "node types/publish.mjs",
     "link:glimmer": "node bin/yarn-link-glimmer.js",
     "start": "ember serve",
     "lint": "npm-run-all --continue-on-error --aggregate-output --parallel \"lint:!(fix)\"",
@@ -49,8 +50,8 @@
     "test:blueprints": "yarn test:blueprints:js && yarn test:blueprints:ts",
     "test:node": "qunit tests/node/**/*-test.js",
     "test:browserstack": "node bin/run-browserstack-tests.js",
-    "type-check:stable": "tsc --noEmit",
-    "type-check:preview": "tsc --noEmit --project type-tests/preview",
+    "type-check:internals": "tsc --noEmit",
+    "type-check:types": "tsc --noEmit --project type-tests",
     "type-check": "npm-run-all type-check:*"
   },
   "dependencies": {

packages/@ember/owner/index.ts

@@ -33,7 +33,7 @@
 // We need to provide a narrower public interface to `getOwner` so that we only
 // expose the `Owner` type, *not* our richer `InternalOwner` type and its
 // various bits of private API.
-import Owner, { getOwner as internalGetOwner } from '../-internals/owner';
+import Owner, { getOwner as internalGetOwner } from '@ember/-internals/owner';
 
 // NOTE: this documentation appears here instead of at the definition site so
 // it can appear correctly in both API docs and for TS, while providing a richer
@@ -99,4 +99,4 @@ export {
   KnownForTypeResult,
   Resolver,
   DIRegistry,
-} from '../-internals/owner';
+} from '@ember/-internals/owner';

type-tests/preview/@ember/application-test/index.ts → type-tests/@ember/application-test/index.ts

@@ -4,6 +4,10 @@ import Owner from '@ember/owner';
 import ApplicationInstance from '@ember/application/instance';
 import Service from '@ember/service';
 import { expectTypeOf } from 'expect-type';
+import { getOwner as getOwnerProper, setOwner as setOwnerProper } from '@ember/owner';
+
+expectTypeOf(getOwner).toEqualTypeOf(getOwnerProper);
+expectTypeOf(setOwner).toEqualTypeOf(setOwnerProper);
 
 expectTypeOf(getOwner({})).toEqualTypeOf<Owner | undefined>();
 

type-tests/preview/@ember/owner-tests.ts → type-tests/@ember/owner-tests.ts

@@ -10,13 +10,6 @@ import Owner, {
 } from '@ember/owner';
 import Component from '@glimmer/component';
 import { expectTypeOf } from 'expect-type';
-import {
-  getOwner as getOwnerApplication,
-  setOwner as setOwnerApplication,
-} from '@ember/application';
-
-expectTypeOf(getOwnerApplication).toEqualTypeOf(getOwner);
-expectTypeOf(setOwnerApplication).toEqualTypeOf(setOwner);
 
 // Just a class we can construct in the Factory and FactoryManager tests
 declare class ConstructThis {

type-tests/index.d.ts

@@ -0,0 +1,3 @@
+// This is equivalent to the import we have end users write.
+import '../types/stable';
+import '../types/preview';

types/preview/@ember/engine/-private/container-proxy-mixin.d.ts

@@ -1,5 +1,5 @@
 declare module '@ember/engine/-private/container-proxy-mixin' {
-  import { ContainerProxy } from '@ember/owner';
+  import { ContainerProxy } from '@ember/-internals/owner';
   import Mixin from '@ember/object/mixin';
 
   /**

types/preview/@ember/engine/-private/registry-proxy-mixin.d.ts

@@ -1,5 +1,5 @@
 declare module '@ember/engine/-private/registry-proxy-mixin' {
-  import { RegistryProxy } from '@ember/owner';
+  import { RegistryProxy } from '@ember/-internals/owner';
   import Mixin from '@ember/object/mixin';
 
   /**