chore: [BREAKING to prior alpha/betas] prepare SchemaRecord for stable, lockdown exports

packages/experiments/src/data-worker/README.md

@@ -97,7 +97,7 @@ import JSONAPICache from '@ember-data/json-api';
 import { DataWorker, CacheHandler } from '@warp-drive/experiments/data-worker';
 import type { CacheCapabilitiesManager } from '@ember-data/store/types';
 import { CachePolicy } from '@ember-data/request-utils';
-import { SchemaService } from '@warp-drive/schema-record/schema';
+import { SchemaService } from '@warp-drive/schema-record';
 
 class WorkerStore extends Store {
   requestManager = new RequestManager()

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

@@ -272,7 +272,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() {
@@ -302,7 +302,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__ember/app/services/store.ts

@@ -5,9 +5,7 @@ import DataStore, { CacheHandler } from '@ember-data/store';
 import type { CacheCapabilitiesManager } from '@ember-data/store/types';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { Cache } from '@warp-drive/core-types/cache';
-import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
-import type { SchemaRecord } from '@warp-drive/schema-record/record';
-import { SchemaService } from '@warp-drive/schema-record/schema';
+import { instantiateRecord, SchemaService, teardownRecord } from '@warp-drive/schema-record';
 
 export default class Store extends DataStore {
   constructor(args: unknown) {
@@ -26,11 +24,11 @@ export default class Store extends DataStore {
     return new JSONAPICache(capabilities);
   }
 
-  instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): SchemaRecord {
+  instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>) {
     return instantiateRecord(this, identifier, createArgs);
   }
 
-  teardownRecord(record: SchemaRecord): void {
+  teardownRecord(record: unknown): void {
     return teardownRecord(record);
   }
 }

tests/warp-drive__ember/tests/integration/request-component-invalidation-test.gts

@@ -16,9 +16,13 @@ import { module, setupRenderingTest, test as _test } from '@warp-drive/diagnosti
 import { Request } from '@warp-drive/ember';
 import { MockServerHandler } from '@warp-drive/holodeck';
 import { GET } from '@warp-drive/holodeck/mock';
-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';
 
 function trim(str?: string | null): string {
   if (!str) {
@@ -83,7 +87,7 @@ class TestStore extends Store {
     return instantiateRecord(this, identifier, createRecordArgs);
   }
 
-  teardownRecord(record: SchemaRecord) {
+  teardownRecord(record: unknown) {
     teardownRecord(record);
   }
 }

tests/warp-drive__ember/tests/integration/request-component-subscription-test.gts

@@ -16,9 +16,13 @@ import { module, setupRenderingTest, test as _test } from '@warp-drive/diagnosti
 import { Request } from '@warp-drive/ember';
 import { MockServerHandler } from '@warp-drive/holodeck';
 import { GET } from '@warp-drive/holodeck/mock';
-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;
@@ -112,7 +116,7 @@ class TestStore extends Store {
     return instantiateRecord(this, identifier, createRecordArgs);
   }
 
-  teardownRecord(record: SchemaRecord) {
+  teardownRecord(record: unknown) {
     teardownRecord(record);
   }
 }

tests/warp-drive__ember/tests/integration/request-component-test.gts

@@ -18,7 +18,7 @@ import { module, setupRenderingTest, test as _test } from '@warp-drive/diagnosti
 import { getRequestState, Request } from '@warp-drive/ember';
 import { mock, MockServerHandler } from '@warp-drive/holodeck';
 import { GET } from '@warp-drive/holodeck/mock';
-import { registerDerivations, withDefaults } from '@warp-drive/schema-record/schema';
+import { registerDerivations, withDefaults } from '@warp-drive/schema-record';
 
 // our tests use a rendering test context and add manager to it
 interface LocalTestContext extends RenderingTestContext {

tests/warp-drive__experiments/app/services/store.ts

@@ -5,9 +5,7 @@ import DataStore, { CacheHandler } from '@ember-data/store';
 import type { CacheCapabilitiesManager } from '@ember-data/store/types';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { Cache } from '@warp-drive/core-types/cache';
-import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
-import type { SchemaRecord } from '@warp-drive/schema-record/record';
-import { SchemaService } from '@warp-drive/schema-record/schema';
+import { instantiateRecord, SchemaService, teardownRecord } from '@warp-drive/schema-record';
 
 export default class Store extends DataStore {
   constructor(args: unknown) {
@@ -26,11 +24,11 @@ export default class Store extends DataStore {
     return new JSONAPICache(capabilities);
   }
 
-  instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): SchemaRecord {
+  instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>) {
     return instantiateRecord(this, identifier, createArgs);
   }
 
-  teardownRecord(record: SchemaRecord): void {
+  teardownRecord(record: unknown): void {
     return teardownRecord(record);
   }
 }

tests/warp-drive__experiments/tests/integration/data-worker/basic-test.ts

@@ -8,9 +8,7 @@ import { module, test } from '@warp-drive/diagnostic';
 import { WorkerFetch } from '@warp-drive/experiments/worker-fetch';
 import { MockServerHandler } from '@warp-drive/holodeck';
 import { GET } from '@warp-drive/holodeck/mock';
-import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
-import type { SchemaRecord } from '@warp-drive/schema-record/record';
-import { registerDerivations, SchemaService } from '@warp-drive/schema-record/schema';
+import { instantiateRecord, registerDerivations, SchemaService, teardownRecord } from '@warp-drive/schema-record';
 
 import { UserSchema } from './user-schema';
 
@@ -67,7 +65,7 @@ module('Unit | DataWorker | Basic', function (_hooks) {
       }
 
       teardownRecord(record: unknown): void {
-        return teardownRecord(record as SchemaRecord);
+        return teardownRecord(record);
       }
     }
 

tests/warp-drive__experiments/tests/integration/data-worker/basic-worker.ts

@@ -5,7 +5,7 @@ import { CachePolicy } from '@ember-data/request-utils';
 import Store from '@ember-data/store';
 import type { CacheCapabilitiesManager } from '@ember-data/store/types';
 import { CacheHandler, DataWorker } from '@warp-drive/experiments/data-worker';
-import { SchemaService } from '@warp-drive/schema-record/schema';
+import { SchemaService } from '@warp-drive/schema-record';
 
 import { UserSchema } from './user-schema';
 

tests/warp-drive__experiments/tests/integration/data-worker/persisted-worker.ts

@@ -5,7 +5,7 @@ import { CachePolicy } from '@ember-data/request-utils';
 import Store from '@ember-data/store';
 import type { CacheCapabilitiesManager } from '@ember-data/store/types';
 import { CacheHandler, DataWorker } from '@warp-drive/experiments/data-worker';
-import { SchemaService } from '@warp-drive/schema-record/schema';
+import { SchemaService } from '@warp-drive/schema-record';
 
 import { UserSchema } from './user-schema';
 

tests/warp-drive__experiments/tests/integration/data-worker/serialization-test.ts

@@ -8,9 +8,7 @@ import { module, test } from '@warp-drive/diagnostic';
 import { WorkerFetch } from '@warp-drive/experiments/worker-fetch';
 import { MockServerHandler } from '@warp-drive/holodeck';
 import { GET } from '@warp-drive/holodeck/mock';
-import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
-import type { SchemaRecord } from '@warp-drive/schema-record/record';
-import { registerDerivations, SchemaService } from '@warp-drive/schema-record/schema';
+import { instantiateRecord, registerDerivations, SchemaService, teardownRecord } from '@warp-drive/schema-record';
 
 import { UserSchema } from './user-schema';
 
@@ -76,7 +74,7 @@ module('Unit | DataWorker | Serialization & Persistence', function (_hooks) {
       }
 
       teardownRecord(record: unknown): void {
-        return teardownRecord(record as SchemaRecord);
+        return teardownRecord(record);
       }
     }
 

tests/warp-drive__experiments/tests/integration/data-worker/user-schema.ts

@@ -1,4 +1,4 @@
-import { withDefaults } from '@warp-drive/schema-record/schema';
+import { withDefaults } from '@warp-drive/schema-record';
 
 export const UserSchema = withDefaults({
   type: 'user',

tests/warp-drive__schema-record/app/services/store.ts

@@ -4,9 +4,7 @@ import Fetch from '@ember-data/request/fetch';
 import DataStore, { CacheHandler } from '@ember-data/store';
 import type { CacheCapabilitiesManager } from '@ember-data/store/types';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
-import { instantiateRecord, teardownRecord } from '@warp-drive/schema-record/hooks';
-import type { SchemaRecord } from '@warp-drive/schema-record/record';
-import { SchemaService } from '@warp-drive/schema-record/schema';
+import { instantiateRecord, SchemaService, teardownRecord } from '@warp-drive/schema-record';
 
 export default class Store extends DataStore {
   constructor(args: unknown) {
@@ -25,11 +23,11 @@ export default class Store extends DataStore {
     return new JSONAPICache(capabilities);
   }
 
-  override instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): SchemaRecord {
+  override instantiateRecord(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>) {
     return instantiateRecord(this, identifier, createArgs);
   }
 
-  override teardownRecord(record: SchemaRecord): void {
+  override teardownRecord(record: unknown): void {
     return 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/legacy/mode-test.ts

@@ -13,8 +13,8 @@ import RequestManager from '@ember-data/request';
 import type Store from '@ember-data/store';
 import { CacheHandler } from '@ember-data/store';
 import type { Type } from '@warp-drive/core-types/symbols';
-import { Editable, Legacy } from '@warp-drive/schema-record/record';
-import { registerDerivations, withDefaults } from '@warp-drive/schema-record/schema';
+import { registerDerivations, withDefaults } from '@warp-drive/schema-record';
+import { Editable, Legacy } from '@warp-drive/schema-record/-private';
 
 type Errors = Model['errors'];
 type RecordState = Model['currentState'];

tests/warp-drive__schema-record/tests/legacy/reactivity/basic-fields-test.ts

@@ -13,8 +13,7 @@ import type Store from '@ember-data/store';
 import { recordIdentifierFor } from '@ember-data/store';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import { Type } from '@warp-drive/core-types/symbols';
-import type { SchemaRecord } from '@warp-drive/schema-record/record';
-import type { Transformation } from '@warp-drive/schema-record/schema';
+import type { SchemaRecord, Transformation } from '@warp-drive/schema-record';
 
 import { simplePayloadNormalize } from '../../-utils/normalize-payload';
 import { reactiveContext } from '../../-utils/reactive-context';