chore: [BREAKING to prior alpha/betas] prepare SchemaRecord for stabl…

…e, lockdown exports (#9697)

* chore: prepare SchemaRecord for stable, lockdown exports

* cleanup imports

* fix assertion

packages/schema-record/README.md

@@ -64,8 +64,7 @@ that instance, it will call `teardownRecord`.
 
 ```diff
 import Store from '@ember-data/store';
-+import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
-+import { registerDerivations, SchemaService } from '@warp-drive/schema-record/schema';
++import { instantiateRecord, teardownRecord, registerDerivations, SchemaService } from '@warp-drive/schema-record';
 
 class AppStore extends Store {
 
@@ -75,11 +74,11 @@ class AppStore extends Store {
 +    return schema;
 +  }
 
-+  instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): SchemaRecord {
++  instantiateRecord(identifier, createArgs) {
 +    return instantiateRecord(this, identifier, createArgs);
 +  }
 
-+  teardownRecord(record: SchemaRecord): void {
++  teardownRecord(record) {
 +    return teardownRecord(record);
 +  }
 }
@@ -230,7 +229,7 @@ in the process gaining access to an editable copy. The immutable version will
 not show any in-process edits made to this editable copy.
 
 ```ts
-import { Checkout } from '@warp-drive/schema-record/record';
+import { Checkout } from '@warp-drive/schema-record';
 
 const editable = await user[Checkout]();
 ```
@@ -242,7 +241,7 @@ conventional fields like identity and `$type`. We can rewrite the schema
 definition above using this utility like so:
 
 ```ts
-import { withDefaults } from '@warp-drive/schema-record/schema';
+import { withDefaults } from '@warp-drive/schema-record';
 
 store.registerSchemas([
   withDefaults({

packages/schema-record/package.json

@@ -33,6 +33,10 @@
     "unstable-preview-types"
   ],
   "exports": {
+    ".": {
+      "types": "./unstable-preview-types/index.d.ts",
+      "default": "./dist/index.js"
+    },
     "./*": {
       "types": "./unstable-preview-types/*.d.ts",
       "default": "./dist/*.js"

packages/schema-record/src/-private.ts

@@ -0,0 +1 @@
+export { Editable, Legacy } from './-private/symbols';

packages/schema-record/src/hooks.ts → packages/schema-record/src/-private/hooks.ts

@@ -1,4 +1,5 @@
 import type Store from '@ember-data/store';
+import { assert } from '@warp-drive/build-config/macros';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 
 import { SchemaRecord } from './record';
@@ -25,6 +26,11 @@ export function instantiateRecord(
   return record;
 }
 
-export function teardownRecord(record: SchemaRecord): void {
+function assertSchemaRecord(record: unknown): asserts record is SchemaRecord {
+  assert('Expected a SchemaRecord', record && typeof record === 'object' && Destroy in record);
+}
+
+export function teardownRecord(record: unknown): void {
+  assertSchemaRecord(record);
   record[Destroy]();
 }

packages/schema-record/src/record.ts → packages/schema-record/src/-private/record.ts

@@ -28,7 +28,7 @@ import {
   ManagedObjectMap,
   peekManagedArray,
   peekManagedObject,
-} from './-private/compute';
+} from './fields/compute';
 import type { SchemaService } from './schema';
 import {
   ARRAY_SIGNAL,
@@ -125,6 +125,9 @@ export class SchemaRecord {
       },
 
       has(target: SchemaRecord, prop: string | number | symbol) {
+        if (prop === Destroy || prop === Checkout) {
+          return true;
+        }
         return fields.has(prop as string);
       },
 

packages/schema-record/src/index.ts

@@ -0,0 +1,4 @@
+export { instantiateRecord, teardownRecord } from './-private/hooks';
+export { type Transformation, SchemaService, withDefaults, fromIdentity, registerDerivations } from './-private/schema';
+export { type SchemaRecord } from './-private/record';
+export { Checkout } from './-private/symbols';

packages/schema-record/vite.config.mjs

@@ -2,7 +2,7 @@ import { createConfig } from '@warp-drive/internal-config/vite/config.js';
 
 export const externals = ['@ember/debug'];
 
-export const entryPoints = ['src/hooks.ts', 'src/record.ts', 'src/schema.ts'];
+export const entryPoints = ['src/index.ts', 'src/-private.ts'];
 
 export default createConfig(
   {

packages/store/src/-private/store-service.ts

@@ -277,7 +277,7 @@ export interface Store {
    * For Example, to use the default SchemaService for SchemaRecord
    *
    * ```ts
-   * import { SchemaService } from '@warp-drive/schema-record/schema';
+   * import { SchemaService } from '@warp-drive/schema-record';
    *
    * class extends Store {
    *   createSchemaService() {
@@ -307,7 +307,7 @@ export interface Store {
    *
    * ```ts
    * import { DelegatingSchemaService } from '@ember-data/model/migration-support';
-   * import { SchemaService } from '@warp-drive/schema-record/schema';
+   * import { SchemaService } from '@warp-drive/schema-record';
    *
    * class extends Store {
    *   createSchemaService() {

tests/main/tests/integration/cache-handler/request-dedupe-test.ts

@@ -8,9 +8,13 @@ import type { CacheCapabilitiesManager } from '@ember-data/store/types';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { SingleResourceDataDocument } from '@warp-drive/core-types/spec/document';
 import type { Type } from '@warp-drive/core-types/symbols';
-import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
-import type { SchemaRecord } from '@warp-drive/schema-record/record';
-import { registerDerivations, SchemaService, withDefaults } from '@warp-drive/schema-record/schema';
+import {
+  instantiateRecord,
+  registerDerivations,
+  SchemaService,
+  teardownRecord,
+  withDefaults,
+} from '@warp-drive/schema-record';
 
 type User = {
   id: string;
@@ -40,7 +44,7 @@ class TestStore extends Store {
     return instantiateRecord(this, identifier, createRecordArgs);
   }
 
-  teardownRecord(record: SchemaRecord) {
+  teardownRecord(record: unknown) {
     teardownRecord(record);
   }
 }

tests/warp-drive__schema-record/tests/edit-workflow-test.ts

@@ -6,8 +6,7 @@ import { serializePatch, serializeResources, updateRecord } from '@ember-data/js
 import RequestManager from '@ember-data/request';
 import { CacheHandler, recordIdentifierFor } from '@ember-data/store';
 import type { Type } from '@warp-drive/core-types/symbols';
-import { Checkout } from '@warp-drive/schema-record/record';
-import { registerDerivations, withDefaults } from '@warp-drive/schema-record/schema';
+import { Checkout, registerDerivations, withDefaults } from '@warp-drive/schema-record';
 
 import type Store from '../app/services/store';
 

tests/warp-drive__schema-record/tests/reads/belongs-to-test.ts

@@ -6,7 +6,7 @@ import { setupTest } from 'ember-qunit';
 
 import type Store from '@ember-data/store';
 import type { Type } from '@warp-drive/core-types/symbols';
-import { registerDerivations, withDefaults } from '@warp-drive/schema-record/schema';
+import { registerDerivations, withDefaults } from '@warp-drive/schema-record';
 
 type User = {
   id: string | null;

tests/warp-drive__schema-record/tests/reads/has-many-test.ts

@@ -10,7 +10,7 @@ import type Store from '@ember-data/store';
 import { CacheHandler } from '@ember-data/store';
 import type { RelatedCollection } from '@ember-data/store/-private';
 import type { Type } from '@warp-drive/core-types/symbols';
-import { registerDerivations, withDefaults } from '@warp-drive/schema-record/schema';
+import { registerDerivations, withDefaults } from '@warp-drive/schema-record';
 
 type User = {
   id: string | null;