@warp-drive/legacy 5.8.0-alpha.3 → 5.8.0-alpha.30

package/dist/index.js

@@ -0,0 +1,195 @@
+import { Store, RequestManager, Fetch, CacheHandler, recordIdentifierFor } from '@warp-drive/core';
+import { SchemaService, registerDerivations, instantiateRecord as instantiateRecord$1, teardownRecord as teardownRecord$1 } from '@warp-drive/core/reactive';
+import { DefaultCachePolicy } from '@warp-drive/core/store';
+import { LegacyNetworkHandler, adapterFor, serializerFor, pushPayload, normalize, serializeRecord, cleanup } from './compat.js';
+import { EmberArrayLikeExtension, EmberObjectArrayExtension, EmberObjectExtension } from './compat/extensions.js';
+import '@ember/object';
+import '@warp-drive/core/types/symbols';
+import '@ember/debug';
+import '@warp-drive/utilities/string';
+import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import '@warp-drive/core/store/-private';
+import "./errors-B9CDPh3R.js";
+import "./schema-provider-BnVr_CnJ.js";
+import { i as instantiateRecord, t as teardownRecord, m as modelFor } from "./hooks-CQXyievu.js";
+import { registerDerivations as registerDerivations$1, DelegatingSchemaService } from './model/migration-support.js';
+import { F as FragmentExtension, a as FragmentArrayExtension, f as fragmentsModelFor } from "./model-for-B0TSd9HU.js";
+import { restoreDeprecatedStoreBehaviors } from './store.js';
+
+/**
+ * @module
+ * @mergeModuleWith <project>
+ */
+
+/**
+ * Use the legacy store with the given options.
+ */
+function useLegacyStore(options, StoreKlass = Store) {
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`If legacyRequests is true, linksMode must be false`);
+    }
+  })(!(options.linksMode && options.legacyRequests)) : {};
+  // we extend the store to ensure we don't leak our prototype overrides to other stores below.
+  class BaseKlass extends StoreKlass {}
+  class LegacyConfiguredStore extends BaseKlass {
+    requestManager = new RequestManager().use([options.linksMode ? null : LegacyNetworkHandler, ...(options.handlers ?? []), Fetch].filter(Boolean)).useCache(CacheHandler);
+    lifetimes = options.policy ?? new DefaultCachePolicy({
+      apiCacheHardExpires: 15 * 60 * 1000,
+      // 15 minutes
+      apiCacheSoftExpires: 1 * 30 * 1000,
+      // 30 seconds
+      constraints: {
+        headers: {
+          'X-WarpDrive-Expires': true,
+          'Cache-Control': true,
+          Expires: true
+        }
+      }
+    });
+    createSchemaService() {
+      // prepare for PolarisMode
+      const schema = new SchemaService();
+      registerDerivations(schema);
+      if (options.schemas) schema.registerResources(options.schemas);
+      if (options.traits) {
+        for (const trait of options.traits) {
+          schema.registerTrait(trait);
+        }
+      }
+      if (options.derivations) {
+        for (const derivation of options.derivations) {
+          schema.registerDerivation(derivation);
+        }
+      }
+      if (options.transformations) {
+        for (const transformation of options.transformations) {
+          schema.registerTransformation(transformation);
+        }
+      }
+      if (options.hashFns) {
+        for (const hashFn of options.hashFns) {
+          schema.registerHashFn(hashFn);
+        }
+      }
+      if (options.CAUTION_MEGA_DANGER_ZONE_extensions) {
+        for (const extension of options.CAUTION_MEGA_DANGER_ZONE_extensions) {
+          schema.CAUTION_MEGA_DANGER_ZONE_registerExtension(extension);
+        }
+      }
+
+      // Add support for LegacyMode ReactiveResource with Maximal coverage
+      // for upgrading from 4.x
+      registerDerivations$1(schema);
+      schema.CAUTION_MEGA_DANGER_ZONE_registerExtension(EmberArrayLikeExtension);
+      schema.CAUTION_MEGA_DANGER_ZONE_registerExtension(EmberObjectArrayExtension);
+      schema.CAUTION_MEGA_DANGER_ZONE_registerExtension(EmberObjectExtension);
+
+      // add support for fragments
+      if (options.modelFragments) {
+        schema.CAUTION_MEGA_DANGER_ZONE_registerExtension?.(FragmentExtension);
+        schema.CAUTION_MEGA_DANGER_ZONE_registerExtension?.(FragmentArrayExtension);
+      }
+
+      // Add fallback for Models
+      return new DelegatingSchemaService(this, schema);
+    }
+    createCache(capabilities) {
+      // eslint-disable-next-line new-cap
+      return new options.cache(capabilities);
+    }
+    instantiateRecord(key, createArgs) {
+      if (this.schema.isDelegated(key)) {
+        return instantiateRecord.call(this, key, createArgs);
+      }
+      return instantiateRecord$1(this, key, createArgs);
+    }
+    teardownRecord(record) {
+      const key = recordIdentifierFor(record);
+      if (this.schema.isDelegated(key)) {
+        return teardownRecord.call(this, record);
+      }
+      return teardownRecord$1(record);
+    }
+    modelFor(type) {
+      assertType(this.schema, type);
+      // TODO I'm not sure this is right
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`modelFor should only be used to lookup legacy models when in linksMode: false`);
+        }
+      })(!options.linksMode || !this.schema.isDelegated({
+        type
+      })) : {};
+      const klass =
+      // prefer real models if present
+      modelFor.call(this, type) || (
+      // fallback to ShimModelClass specific to fragments if fragments support in use
+      options.modelFragments ? fragmentsModelFor.call(this, type) : false) ||
+      // fallback to ShimModelClass
+      super.modelFor(type);
+      return klass;
+    }
+    adapterFor(modelName, _allowMissing) {
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`useLegacyStore was setup in linksMode. linksMode assumes that all requests have been migrated away from adapters and serializers.`);
+        }
+      })(!options.linksMode) : {};
+      // @ts-expect-error
+      return adapterFor.call(this, modelName, _allowMissing);
+    }
+    serializerFor(...args) {
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`useLegacyStore was setup in linksMode. linksMode assumes that all requests have been migrated away from adapters and serializers.`);
+        }
+      })(!options.linksMode) : {};
+      return serializerFor.call(this, ...args);
+    }
+    pushPayload(...args) {
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`useLegacyStore was setup in linksMode. linksMode assumes that all requests have been migrated away from adapters and serializers.`);
+        }
+      })(!options.linksMode) : {};
+      return pushPayload.call(this, ...args);
+    }
+    normalize(...args) {
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`useLegacyStore was setup in linksMode. linksMode assumes that all requests have been migrated away from adapters and serializers.`);
+        }
+      })(!options.linksMode) : {};
+      return normalize.call(this, ...args);
+    }
+    serializeRecord(...args) {
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`useLegacyStore was setup in linksMode. linksMode assumes that all requests have been migrated away from adapters and serializers.`);
+        }
+      })(!options.linksMode) : {};
+      return serializeRecord.call(this, ...args);
+    }
+    destroy() {
+      if (!options.linksMode) {
+        cleanup.call(this);
+      }
+      super.destroy();
+    }
+  }
+  if (options.legacyRequests) {
+    restoreDeprecatedStoreBehaviors(BaseKlass);
+  }
+  return LegacyConfiguredStore;
+}
+function assertType(schema, type) {
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`Expected type ${type} to be a valid ResourceType`);
+    }
+  })(schema.hasResource({
+    type
+  })) : {};
+}
+export { useLegacyStore };

package/dist/{json-DziiodPf.js → json-BHxlccxF.js}

@@ -25,20 +25,18 @@ const SOURCE_POINTER_PRIMARY_REGEXP = /^\/?data/;
 const PRIMARY_ATTRIBUTE_KEY = 'base';
 
 /**
- * <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-  <p>
-    ⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+ * :::danger
+    ⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
     If starting a new app or thinking of implementing a new adapter, consider writing a
-    <a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/warp-drive-data/warp-drive/tree/main/packages/request#readme">RequestManager</a>
-  </p>
-  </blockquote>
+    {@link Handler} instead to be used with the {@link RequestManager}
+  :::
 
-  In EmberData a Serializer is used to serialize and deserialize
+  In WarpDrive a Serializer is used to serialize and deserialize
   records when they are transferred in and out of an external source.
   This process involves normalizing property names, transforming
   attribute values and serializing relationships.
 
-  By default, EmberData uses and recommends the `JSONAPISerializer`.
+  By default, WarpDrive uses and recommends the `JSONAPISerializer`.
 
   `JSONSerializer` is useful for simpler or legacy backends that may
   not support the http://jsonapi.org/ spec.
@@ -159,7 +157,7 @@ const JSONSerializer = Serializer.extend({
     }
     ```
      When serialized:
-     ```javascript
+     ```js
     {
       "firstName": "Harry",
       "lastName": "Houdini",
@@ -170,9 +168,7 @@ const JSONSerializer = Serializer.extend({
      Setting `serialize` to `true` enforces serialization for hasMany
     relationships even if it's neither a many-to-many nor many-to-none
     relationship.
-     @property attrs
-    @public
-    @type {Object}
+     @public
   */
   mergedProperties: ['attrs'],
   /**

package/dist/model/-private.js

@@ -1 +1 @@
-export { E as Errors, L as LEGACY_SUPPORT, P as PromiseBelongsTo, a as PromiseManyArray, l as lookupLegacySupport } from "../errors-8kD2mSe_.js";
+export { E as Errors, L as LEGACY_SUPPORT, P as PromiseBelongsTo, a as PromiseManyArray, l as lookupLegacySupport } from "../errors-B9CDPh3R.js";

package/dist/model/migration-support.js

@@ -4,8 +4,8 @@ import { Context } from '@warp-drive/core/reactive/-private';
 import { notifyInternalSignal, assertPrivateStore } from '@warp-drive/core/store/-private';
 import { getOrSetGlobal } from '@warp-drive/core/types/-private';
 import { Type } from '@warp-drive/core/types/symbols';
-import { l as lookupLegacySupport, E as Errors } from "../errors-8kD2mSe_.js";
-import { b as buildSchema, u as unloadRecord, s as serialize, _ as _save, a as save, r as rollbackAttributes, c as _reload, d as reload, h as hasMany, e as _destroyRecord, f as destroyRecord, g as deleteRecord, R as RecordState, i as changedAttributes, j as belongsTo, k as createSnapshot } from "../schema-provider-DQu4Rjco.js";
+import { l as lookupLegacySupport, E as Errors } from "../errors-B9CDPh3R.js";
+import { b as buildSchema, u as unloadRecord, s as serialize, _ as _save, a as save, r as rollbackAttributes, c as _reload, d as reload, h as hasMany, e as _destroyRecord, f as destroyRecord, i as deleteRecord, R as RecordState, j as changedAttributes, k as belongsTo, l as createSnapshot } from "../schema-provider-BnVr_CnJ.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 
 /**
@@ -417,7 +417,9 @@ function registerDerivations(schema) {
  */
 
 class DelegatingSchemaService {
+  /** @internal */
   _preferred;
+  /** @internal */
   _secondary;
   constructor(store, schema) {
     this._preferred = schema;
@@ -452,6 +454,14 @@ class DelegatingSchemaService {
     }
     return this._secondary.fields(resource);
   }
+  cacheFields(resource) {
+    if (this._preferred.cacheFields?.(resource)) {
+      return this._preferred.cacheFields(resource);
+    }
+
+    // @ts-expect-error
+    return this._secondary.cacheFields?.(resource);
+  }
   transformation(field) {
     return this._preferred.transformation(field);
   }
@@ -482,6 +492,9 @@ class DelegatingSchemaService {
   registerHashFn(hashFn) {
     this._preferred.registerHashFn(hashFn);
   }
+  CAUTION_MEGA_DANGER_ZONE_hasExtension(ext) {
+    return this._preferred.CAUTION_MEGA_DANGER_ZONE_hasExtension(ext);
+  }
   CAUTION_MEGA_DANGER_ZONE_registerExtension(extension) {
     this._preferred.CAUTION_MEGA_DANGER_ZONE_registerExtension(extension);
   }

package/dist/model-for-B0TSd9HU.js

@@ -0,0 +1,221 @@
+import { tracked, cached } from '@glimmer/tracking';
+import { Context } from '@warp-drive/core/reactive/-private';
+import { a as decorateFieldV2, i as initializeDeferredDecorator, d as decorateMethodV2 } from "./runtime-BPCpkOf1-BKOwiRJp.js";
+class Fragment {
+  static {
+    decorateFieldV2(this.prototype, "isDestroying", [tracked], function () {
+      return false;
+    });
+  }
+  #isDestroying = (initializeDeferredDecorator(this, "isDestroying"), void 0); // We might want to check the parent values once we move this code to warp-drive.
+  static {
+    decorateFieldV2(this.prototype, "isDestroyed", [tracked], function () {
+      return false;
+    });
+  }
+  #isDestroyed = (initializeDeferredDecorator(this, "isDestroyed"), void 0);
+  get hasDirtyAttributes() {
+    const {
+      path,
+      resourceKey,
+      store
+    } = this[Context];
+    const record = store.peekRecord(resourceKey);
+    if (record.hasDirtyAttributes && path) {
+      const root = path.at(0);
+      return root in record.changedAttributes();
+    }
+    return false;
+  }
+  static {
+    decorateMethodV2(this.prototype, "hasDirtyAttributes", [cached]);
+  }
+  get isFragment() {
+    return true;
+  }
+  get $type() {
+    const {
+      field
+    } = this[Context];
+    return field?.type;
+  }
+  rollbackAttributes() {
+    const {
+      path,
+      resourceKey,
+      store
+    } = this[Context];
+    if (path) {
+      const oldValue = store.cache.getRemoteAttr(resourceKey, path);
+      store.cache.setAttr(resourceKey, path, oldValue);
+    }
+  }
+}
+const FragmentExtension = {
+  kind: 'object',
+  name: 'fragment',
+  features: Fragment
+};
+class FragmentArray {
+  static {
+    decorateFieldV2(this.prototype, "isDestroying", [tracked], function () {
+      return false;
+    });
+  }
+  #isDestroying = (initializeDeferredDecorator(this, "isDestroying"), void 0); // We might want to check the parent values once we move this code to warp-drive.
+  static {
+    decorateFieldV2(this.prototype, "isDestroyed", [tracked], function () {
+      return false;
+    });
+  }
+  #isDestroyed = (initializeDeferredDecorator(this, "isDestroyed"), void 0);
+  get hasDirtyAttributes() {
+    const {
+      path,
+      resourceKey,
+      store
+    } = this[Context];
+    const record = store.peekRecord(resourceKey);
+    if (record.hasDirtyAttributes && path) {
+      const root = path.at(0);
+      return root in record.changedAttributes();
+    }
+    return false;
+  }
+  static {
+    decorateMethodV2(this.prototype, "hasDirtyAttributes", [cached]);
+  }
+  addFragment(fragment) {
+    if (!fragment) {
+      return;
+    }
+    return this.addObject(fragment);
+  }
+  createFragment(fragment) {
+    if (!fragment) {
+      return;
+    }
+    return this.pushObject(fragment);
+  }
+  removeFragment(fragment) {
+    if (!fragment) {
+      return;
+    }
+    const index = this.indexOf(fragment);
+    if (index !== -1) {
+      this.splice(index, 1);
+    }
+  }
+  rollbackAttributes() {
+    for (const fragment of this) {
+      // @ts-expect-error TODO: fix these types
+      fragment?.rollbackAttributes?.();
+    }
+  }
+}
+const FragmentArrayExtension = {
+  kind: 'array',
+  name: 'fragment-array',
+  features: FragmentArray
+};
+
+// if modelFor turns out to be a bottleneck we should replace with a Map
+// and clear it during store teardown.
+const AvailableShims = new WeakMap();
+function getShimClass(store, modelName) {
+  let shims = AvailableShims.get(store);
+  if (!shims) {
+    shims = Object.create(null);
+    AvailableShims.set(store, shims);
+  }
+  let shim = shims[modelName];
+  if (shim === undefined) {
+    shim = shims[modelName] = new ShimModelClass(store, modelName);
+  }
+  return shim;
+}
+const AttributeKinds = ['field', 'attribute', 'object', 'array', 'schema-object', 'schema-array'];
+
+// Mimics the static apis of @ember-data/model
+class ShimModelClass {
+  constructor(store, modelName) {
+    this.__store = store;
+    this.modelName = modelName;
+  }
+  get fields() {
+    const fields = new Map();
+    const fieldSchemas = this.__store.schema.fields({
+      type: this.modelName
+    });
+    fieldSchemas.forEach((schema, key) => {
+      // @ts-expect-error checking if a string is a valid string
+      if (AttributeKinds.includes(schema.kind)) {
+        fields.set(key, 'attribute');
+      } else if (schema.kind === 'belongsTo' || schema.kind === 'hasMany') {
+        fields.set(key, schema.kind);
+      }
+    });
+    return fields;
+  }
+  get attributes() {
+    const attrs = new Map();
+    const fields = this.__store.schema.fields({
+      type: this.modelName
+    });
+    fields.forEach((schema, key) => {
+      if (schema.kind === 'attribute') {
+        attrs.set(key, schema);
+        // @ts-expect-error checking if a string is a valid string
+      } else if (AttributeKinds.includes(schema.kind)) {
+        attrs.set(key, {
+          kind: 'attribute',
+          name: key,
+          type: null,
+          options: schema.options ?? {}
+        });
+      }
+    });
+    return attrs;
+  }
+  get relationshipsByName() {
+    const rels = new Map();
+    const fields = this.__store.schema.fields({
+      type: this.modelName
+    });
+    fields.forEach((schema, key) => {
+      if (schema.kind === 'belongsTo' || schema.kind === 'hasMany') {
+        rels.set(key, schema);
+      }
+    });
+    return rels;
+  }
+  eachAttribute(callback, binding) {
+    this.attributes.forEach((schema, key) => {
+      callback.call(binding, key, schema);
+    });
+  }
+  eachRelationship(callback, binding) {
+    this.__store.schema.fields({
+      type: this.modelName
+    }).forEach((schema, key) => {
+      if (schema.kind === 'belongsTo' || schema.kind === 'hasMany') {
+        callback.call(binding, key, schema);
+      }
+    });
+  }
+  eachTransformedAttribute(callback, binding) {
+    this.__store.schema.fields({
+      type: this.modelName
+    }).forEach((schema, key) => {
+      if (schema.kind === 'attribute') {
+        const type = schema.type;
+        if (type) callback.call(binding, key, type);
+      }
+    });
+  }
+}
+function fragmentsModelFor(modelName) {
+  return getShimClass(this, modelName);
+}
+const modelFor = fragmentsModelFor;
+export { FragmentExtension as F, FragmentArrayExtension as a, FragmentArray as b, Fragment as c, fragmentsModelFor as f, modelFor as m };

package/dist/model-fragments.js

@@ -0,0 +1,76 @@
+import { singularize, pluralize } from '@warp-drive/utilities/string';
+import { withDefaults } from './model/migration-support.js';
+import { F as FragmentExtension, a as FragmentArrayExtension } from "./model-for-B0TSd9HU.js";
+export { c as Fragment, b as FragmentArray, m as modelFor } from "./model-for-B0TSd9HU.js";
+
+/**
+ * Used as a helper to setup the relevant parts of an array
+ * schema and add extensions etc.
+ *
+ * @param arrayName The name of the array
+ * @returns The schema for an array
+ */
+function withArrayDefaults(arrayName) {
+  return {
+    kind: 'array',
+    name: arrayName,
+    type: `array:${singularize(arrayName)}`,
+    options: {
+      arrayExtensions: ['ember-object', 'ember-array-like', 'fragment-array']
+    }
+  };
+}
+
+/**
+ * Used as a helper to setup the relevant parts of a fragment schema
+ * and add extensions etc.
+ *
+ * @param fragmentType The type of the fragment
+ * @param fragmentName The optional name of the fragment. If not provided, it will default to the fragmentType.
+ * @returns The schema for a fragment
+ */
+function withFragmentDefaults(fragmentType, fragmentName) {
+  return {
+    kind: 'schema-object',
+    type: `fragment:${fragmentType}`,
+    name: fragmentName ?? fragmentType,
+    options: {
+      objectExtensions: ['ember-object', 'fragment']
+    }
+  };
+}
+
+/**
+ * Used as a helper to setup the relevant parts of a fragment-array
+ * schema and add extensions etc.
+ *
+ * @param fragmentArrayType The type of the fragment-array
+ * @param fragmentArrayName The name of the fragment-array
+ * @returns The schema for a fragment-array
+ */
+function withFragmentArrayDefaults(fragmentArrayType, fragmentArrayName) {
+  return {
+    kind: 'schema-array',
+    type: `fragment:${singularize(fragmentArrayType)}`,
+    name: fragmentArrayName ?? pluralize(fragmentArrayType),
+    options: {
+      arrayExtensions: ['ember-object', 'ember-array-like', 'fragment-array'],
+      defaultValue: true
+    }
+  };
+}
+function withLegacy(schema) {
+  return withDefaults({
+    ...schema,
+    identity: {
+      kind: '@id',
+      name: 'id'
+    },
+    objectExtensions: ['ember-object', 'fragment']
+  });
+}
+function registerFragmentExtensions(schema) {
+  schema.CAUTION_MEGA_DANGER_ZONE_registerExtension?.(FragmentExtension);
+  schema.CAUTION_MEGA_DANGER_ZONE_registerExtension?.(FragmentArrayExtension);
+}
+export { FragmentArrayExtension, FragmentExtension, registerFragmentExtensions, withArrayDefaults, withFragmentArrayDefaults, withFragmentDefaults, withLegacy };