@ember-data/legacy-compat 5.4.0-alpha.53 → 5.4.0-alpha.55

package/addon/utils.js

@@ -0,0 +1,246 @@
+import { dasherize } from '@ember/string';
+import { macroCondition, dependencySatisfies, importSync, getOwnConfig } from '@embroider/macros';
+
+/**
+  Utilities for helping to migrate to stricter
+  and more consistent use of IDs and types.
+
+  @module @ember-data/legacy-compat/utils
+  @main @ember-data/legacy-compat/utils
+  @deprecated
+*/
+let singularize;
+if (macroCondition(dependencySatisfies('ember-inflector', '*'))) {
+  singularize = importSync('ember-inflector').singularize;
+}
+let MismatchReporter = function () {};
+
+// TODO: @runspired This pattern prevents AssertFn from being removed in production builds
+// but we should enable that if we can.
+let _AssertFn = function () {};
+const AssertFn = (message, condition) => {
+  if (!condition) {
+    _AssertFn(message, condition);
+  }
+  if (macroCondition(getOwnConfig().env.DEBUG)) {
+    if (!condition) {
+      throw new Error(`Assertion Failed: ${message}`);
+    }
+  }
+};
+let NormalizedType = str => {
+  return singularize(dasherize(str));
+};
+
+/**
+ * Configure a function to be called when an id or type
+ * changes during normalization. This is useful for instrumenting
+ * to discover places where usage in the app is not consistent.
+ *
+ * @method configureMismatchReporter
+ * @for @ember-data/legacy-compat/utils
+ * @param method a function which takes a mismatch-type ('formatted-id' | 'formatted-type'), actual, and expected value
+ * @public
+ * @static
+ */
+function configureMismatchReporter(fn) {
+  MismatchReporter = fn;
+}
+
+/**
+ * Configure a function to be called when an id or type
+ * fails validation. This is useful for instrumenting
+ * to discover places where usage in the app is not consistent.
+ *
+ * @method configureAssertFn
+ * @for @ember-data/legacy-compat/utils
+ * @param method a function which takes a message and a condition
+ * @public
+ * @static
+ */
+function configureAssertFn(fn) {
+  _AssertFn = fn;
+}
+
+/**
+ * Configure a function to be called to normalize
+ * a resource type string. Used by both formattedType
+ * and isEquivType to ensure consistent normalization
+ * during comparison.
+ *
+ * If validation fails or the type turns out be unnormalized
+ * the configured mismatch reporter and assert functions will
+ * be called.
+ *
+ * @method configureTypeNormalization
+ * @for @ember-data/legacy-compat/utils
+ * @param method a function which takes a string and returns a string
+ * @public
+ * @static
+ */
+function configureTypeNormalization(fn) {
+  NormalizedType = fn;
+}
+const NORMALIZED_TYPES = new Map();
+
+/**
+ * Converts a potentially unnormalized type into the format expected
+ * by our EmberData Cache. Currently this is singular-dasherized.
+ *
+ * you should not rely on this function to give you an exact format
+ * for display purposes. Formatting for display should be handled
+ * differently if the exact format matters.
+ *
+ * Asserts invalid types (undefined, null, '') in dev.
+ *
+ * **Usage**
+ *
+ * ```js
+ * import formattedType from 'soxhub-client/helpers/formatted-type';
+ *
+ * formattedType('post'); // => 'post'
+ * formattedType('posts'); // => 'post'
+ * formattedType('Posts'); // => 'post'
+ * formattedType('post-comment'); // => 'post-comment'
+ * formattedType('post-comments'); // => 'post-comment'
+ * formattedType('post_comment'); // => 'post-comment'
+ * formattedType('postComment'); // => 'post-comment'
+ * formattedType('PostComment'); // => 'post-comment'
+ * ```
+ *
+ * @method formattedType
+ * @for @ember-data/legacy-compat/utils
+ * @param {string} type the potentially un-normalized type
+ * @return {string} the normalized type
+ * @public
+ * @static
+ */
+function formattedType(type) {
+  AssertFn('formattedType: type must not be null', type !== null);
+  AssertFn('formattedType: type must not be undefined', type !== undefined);
+  AssertFn('formattedType: type must be a string', typeof type === 'string');
+  AssertFn('formattedType: type must not be empty', type.length > 0);
+  let normalized = NORMALIZED_TYPES.get(type);
+  if (normalized === undefined) {
+    normalized = NormalizedType(type);
+    NORMALIZED_TYPES.set(type, normalized);
+  }
+  if (normalized !== type) {
+    MismatchReporter('formatted-type', type, normalized);
+  }
+  return normalized;
+}
+
+/**
+ * Format an id to the format expected by the EmberData Cache.
+ * Currently this means that id should be `string | null`.
+ *
+ * Asserts invalid IDs (undefined, '', 0, '0') in dev.
+ *
+ * **Usage**
+ *
+ * ```js
+ * import formattedId from 'client/utils/formatted-id';
+ *
+ * formattedId('1'); // => '1'
+ * formattedId(1); // => '1'
+ * formattedId(null); // => null
+ *	```
+ *
+ * @method formattedId
+ * @for @ember-data/legacy-compat/utils
+ * @param {string | number | null} id the potentially un-normalized id
+ * @return {string | null} the normalized id
+ * @public
+ * @static
+ */
+
+function formattedId(id) {
+  AssertFn('formattedId: id must not be undefined', id !== undefined);
+  AssertFn('formattedId: id must be a number, string or null', typeof id === 'number' || typeof id === 'string' || id === null);
+  AssertFn('formattedId: id must not be empty', typeof id === 'number' || id === null || typeof id === 'string' && id.length > 0);
+  AssertFn('formattedId: id must not be 0', id !== '0' && id !== 0);
+  const formatted = id === null ? null : String(id);
+  if (formatted !== id) {
+    MismatchReporter('formatted-id', id, formatted);
+  }
+  return id === null ? null : String(id);
+}
+
+/**
+ * Compares two types for strict equality, converting them to
+ * the format expected by the EmberData Cache to ensure
+ * differences in format are accounted for in the comparison.
+ *
+ * Asserts when expected or actual are invalid types in dev.
+ * Expected may never be null.
+ *
+ * ```js
+ * isEquivType('posts', 'post'); // true
+ * isEquivType('post', 'post'); // true
+ * isEquivType('posts', 'posts'); // true
+ * isEquivType('post-comment', 'postComment'); // true
+ * isEquivType('post-comment', 'PostComment'); // true
+ * isEquivType('post-comment', 'post_comment'); // true
+ * isEquivType('post-comment', 'post-comment'); // true
+ * isEquivType('post-comment', 'post'); // false
+ * isEquivType('posts', null); // false
+ * ```
+ *
+ * @method isEquivType
+ * @for @ember-data/legacy-compat/utils
+ * @param {string} expected a potentially unnormalized type to match against
+ * @param {string} actual a potentially unnormalized type to match against
+ * @return {boolean} true if the types are equivalent
+ * @public
+ * @static
+ */
+function isEquivType(expected, actual) {
+  AssertFn('isEquivType: Expected type must not be null', expected !== null);
+  AssertFn('isEquivType: Expected type must not be undefined', expected !== undefined);
+  AssertFn('isEquivType: Expected type must be a string', typeof expected === 'string');
+  AssertFn('isEquivType: Expected type must not be empty', expected.length > 0);
+  AssertFn('isEquivType: Actual type must not be null', actual !== null);
+  AssertFn('isEquivType: Actual type must not be undefined', actual !== undefined);
+  AssertFn('isEquivType: Actual type must be a string', typeof actual === 'string');
+  AssertFn('isEquivType: Actual type must not be empty', actual.length > 0);
+  return expected === actual || formattedType(expected) === formattedType(actual);
+}
+
+/**
+ * Compares two IDs for strict equality, converting them to
+ * the format expected by the EmberData Cache to ensure
+ * differences in format are accounted for in the comparison.
+ *
+ * Asserts when expected or actual are invalid IDs in dev.
+ * Expected may never be null.
+ *
+ * ```js
+ * isEquivId('1', 1); // true
+ * isEquivId('2', '2'); // true
+ * isEquivId(3, '3'); // true
+ * isEquivId(4, '3'); // false
+ * isEquivId(1, null); // false
+ * ```
+ *
+ * @method isEquivId
+ * @for @ember-data/legacy-compat/utils
+ * @param {string | number} expected a potentially un-normalized id to match against
+ * @param {string | number} actual a potentially un-normalized id to match against
+ * @return {boolean} true if the ids are equivalent
+ * @public
+ * @static
+ */
+function isEquivId(expected, actual) {
+  AssertFn('isEquivId: Expected id must not be null', expected !== null);
+  AssertFn('isEquivId: Expected id must not be undefined', expected !== undefined);
+  AssertFn('isEquivId: Expected id must be a number or string', typeof expected === 'number' || typeof expected === 'string');
+  AssertFn('isEquivId: Expected id must not be empty', typeof expected === 'number' || typeof expected === 'string' && expected.length > 0);
+  AssertFn('isEquivId: Expected id must not be 0', expected !== '0' && expected !== 0);
+  AssertFn('isEquivId: Actual id must not be undefined', actual !== undefined);
+  AssertFn('isEquivId: Actual id must be a number, string or null', typeof actual === 'number' || typeof actual === 'string' || actual === null);
+  AssertFn('isEquivId: Actual id must not be empty', actual === null || typeof actual === 'number' || typeof actual === 'string' && actual.length > 0);
+  AssertFn('isEquivId: Actual id must not be 0', actual !== '0' && actual !== 0);
+  return expected === actual || formattedId(expected) === formattedId(actual);
+}
+export { configureAssertFn, configureMismatchReporter, configureTypeNormalization, formattedId, formattedType, isEquivId, isEquivType };

package/addon/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../src/utils.ts"],"sourcesContent":["/**\n  Utilities for helping to migrate to stricter\n  and more consistent use of IDs and types.\n\n  @module @ember-data/legacy-compat/utils\n  @main @ember-data/legacy-compat/utils\n  @deprecated\n*/\nimport { dasherize } from '@ember/string';\n\nimport { dependencySatisfies, importSync, macroCondition } from '@embroider/macros';\n\nimport { DEBUG } from '@ember-data/env';\n\ninterface AssertFunc {\n  (desc: string, condition: unknown): asserts condition;\n  (desc: string): never;\n}\n\ntype Reporter = (type: 'formatted-id' | 'formatted-type', actual: unknown, expected: unknown) => void;\ntype Normalizer = (type: string) => string;\nlet singularize: (str: string) => string;\nif (macroCondition(dependencySatisfies('ember-inflector', '*'))) {\n  singularize = (importSync('ember-inflector') as typeof import('ember-inflector')).singularize;\n}\n\nlet MismatchReporter: Reporter = function () {};\n\n// TODO: @runspired This pattern prevents AssertFn from being removed in production builds\n// but we should enable that if we can.\nlet _AssertFn: (message: string, condition: unknown) => void = function () {};\nconst AssertFn: AssertFunc = ((message: string, condition: unknown) => {\n  if (!condition) {\n    _AssertFn(message, condition);\n  }\n  if (DEBUG) {\n    if (!condition) {\n      throw new Error(`Assertion Failed: ${message}`);\n    }\n  }\n}) as unknown as AssertFunc;\nlet NormalizedType: Normalizer = (str: string) => {\n  return singularize(dasherize(str));\n};\n\n/**\n * Configure a function to be called when an id or type\n * changes during normalization. This is useful for instrumenting\n * to discover places where usage in the app is not consistent.\n *\n * @method configureMismatchReporter\n * @for @ember-data/legacy-compat/utils\n * @param method a function which takes a mismatch-type ('formatted-id' | 'formatted-type'), actual, and expected value\n * @public\n * @static\n */\nexport function configureMismatchReporter(fn: Reporter): void {\n  MismatchReporter = fn;\n}\n\n/**\n * Configure a function to be called when an id or type\n * fails validation. This is useful for instrumenting\n * to discover places where usage in the app is not consistent.\n *\n * @method configureAssertFn\n * @for @ember-data/legacy-compat/utils\n * @param method a function which takes a message and a condition\n * @public\n * @static\n */\nexport function configureAssertFn(fn: (message: string, condition: unknown) => void): void {\n  _AssertFn = fn;\n}\n\n/**\n * Configure a function to be called to normalize\n * a resource type string. Used by both formattedType\n * and isEquivType to ensure consistent normalization\n * during comparison.\n *\n * If validation fails or the type turns out be unnormalized\n * the configured mismatch reporter and assert functions will\n * be called.\n *\n * @method configureTypeNormalization\n * @for @ember-data/legacy-compat/utils\n * @param method a function which takes a string and returns a string\n * @public\n * @static\n */\nexport function configureTypeNormalization(fn: (type: string) => string): void {\n  NormalizedType = fn;\n}\n\nconst NORMALIZED_TYPES = new Map<string, string>();\n\n/**\n * Converts a potentially unnormalized type into the format expected\n * by our EmberData Cache. Currently this is singular-dasherized.\n *\n * you should not rely on this function to give you an exact format\n * for display purposes. Formatting for display should be handled\n * differently if the exact format matters.\n *\n * Asserts invalid types (undefined, null, '') in dev.\n *\n * **Usage**\n *\n * ```js\n * import formattedType from 'soxhub-client/helpers/formatted-type';\n *\n * formattedType('post'); // => 'post'\n * formattedType('posts'); // => 'post'\n * formattedType('Posts'); // => 'post'\n * formattedType('post-comment'); // => 'post-comment'\n * formattedType('post-comments'); // => 'post-comment'\n * formattedType('post_comment'); // => 'post-comment'\n * formattedType('postComment'); // => 'post-comment'\n * formattedType('PostComment'); // => 'post-comment'\n * ```\n *\n * @method formattedType\n * @for @ember-data/legacy-compat/utils\n * @param {string} type the potentially un-normalized type\n * @return {string} the normalized type\n * @public\n * @static\n */\nexport function formattedType<T extends string>(type: T | string): T {\n  AssertFn('formattedType: type must not be null', type !== null);\n  AssertFn('formattedType: type must not be undefined', type !== undefined);\n  AssertFn('formattedType: type must be a string', typeof type === 'string');\n  AssertFn('formattedType: type must not be empty', type.length > 0);\n  let normalized = NORMALIZED_TYPES.get(type);\n\n  if (normalized === undefined) {\n    normalized = NormalizedType(type);\n    NORMALIZED_TYPES.set(type, normalized);\n  }\n\n  if (normalized !== type) {\n    MismatchReporter('formatted-type', type, normalized);\n  }\n\n  return normalized as T;\n}\n\n/**\n * Format an id to the format expected by the EmberData Cache.\n * Currently this means that id should be `string | null`.\n *\n * Asserts invalid IDs (undefined, '', 0, '0') in dev.\n *\n * **Usage**\n *\n * ```js\n * import formattedId from 'client/utils/formatted-id';\n *\n * formattedId('1'); // => '1'\n * formattedId(1); // => '1'\n * formattedId(null); // => null\n *\t```\n *\n * @method formattedId\n * @for @ember-data/legacy-compat/utils\n * @param {string | number | null} id the potentially un-normalized id\n * @return {string | null} the normalized id\n * @public\n * @static\n */\nexport function formattedId(id: string | number): string;\nexport function formattedId(id: null): null;\nexport function formattedId(id: string | number | null): string | null;\nexport function formattedId(id: string | number | null): string | null {\n  AssertFn('formattedId: id must not be undefined', id !== undefined);\n  AssertFn(\n    'formattedId: id must be a number, string or null',\n    typeof id === 'number' || typeof id === 'string' || id === null\n  );\n  AssertFn(\n    'formattedId: id must not be empty',\n    typeof id === 'number' || id === null || (typeof id === 'string' && id.length > 0)\n  );\n  AssertFn('formattedId: id must not be 0', id !== '0' && id !== 0);\n\n  const formatted = id === null ? null : String(id);\n  if (formatted !== id) {\n    MismatchReporter('formatted-id', id, formatted);\n  }\n  return id === null ? null : String(id);\n}\n\n/**\n * Compares two types for strict equality, converting them to\n * the format expected by the EmberData Cache to ensure\n * differences in format are accounted for in the comparison.\n *\n * Asserts when expected or actual are invalid types in dev.\n * Expected may never be null.\n *\n * ```js\n * isEquivType('posts', 'post'); // true\n * isEquivType('post', 'post'); // true\n * isEquivType('posts', 'posts'); // true\n * isEquivType('post-comment', 'postComment'); // true\n * isEquivType('post-comment', 'PostComment'); // true\n * isEquivType('post-comment', 'post_comment'); // true\n * isEquivType('post-comment', 'post-comment'); // true\n * isEquivType('post-comment', 'post'); // false\n * isEquivType('posts', null); // false\n * ```\n *\n * @method isEquivType\n * @for @ember-data/legacy-compat/utils\n * @param {string} expected a potentially unnormalized type to match against\n * @param {string} actual a potentially unnormalized type to match against\n * @return {boolean} true if the types are equivalent\n * @public\n * @static\n */\nexport function isEquivType(expected: string, actual: string): boolean {\n  AssertFn('isEquivType: Expected type must not be null', expected !== null);\n  AssertFn('isEquivType: Expected type must not be undefined', expected !== undefined);\n  AssertFn('isEquivType: Expected type must be a string', typeof expected === 'string');\n  AssertFn('isEquivType: Expected type must not be empty', expected.length > 0);\n\n  AssertFn('isEquivType: Actual type must not be null', actual !== null);\n  AssertFn('isEquivType: Actual type must not be undefined', actual !== undefined);\n  AssertFn('isEquivType: Actual type must be a string', typeof actual === 'string');\n  AssertFn('isEquivType: Actual type must not be empty', actual.length > 0);\n\n  return expected === actual || formattedType(expected) === formattedType(actual);\n}\n\n/**\n * Compares two IDs for strict equality, converting them to\n * the format expected by the EmberData Cache to ensure\n * differences in format are accounted for in the comparison.\n *\n * Asserts when expected or actual are invalid IDs in dev.\n * Expected may never be null.\n *\n * ```js\n * isEquivId('1', 1); // true\n * isEquivId('2', '2'); // true\n * isEquivId(3, '3'); // true\n * isEquivId(4, '3'); // false\n * isEquivId(1, null); // false\n * ```\n *\n * @method isEquivId\n * @for @ember-data/legacy-compat/utils\n * @param {string | number} expected a potentially un-normalized id to match against\n * @param {string | number} actual a potentially un-normalized id to match against\n * @return {boolean} true if the ids are equivalent\n * @public\n * @static\n */\nexport function isEquivId(expected: string | number, actual: string | number | null): boolean {\n  AssertFn('isEquivId: Expected id must not be null', expected !== null);\n  AssertFn('isEquivId: Expected id must not be undefined', expected !== undefined);\n  AssertFn(\n    'isEquivId: Expected id must be a number or string',\n    typeof expected === 'number' || typeof expected === 'string'\n  );\n  AssertFn(\n    'isEquivId: Expected id must not be empty',\n    typeof expected === 'number' || (typeof expected === 'string' && expected.length > 0)\n  );\n  AssertFn('isEquivId: Expected id must not be 0', expected !== '0' && expected !== 0);\n\n  AssertFn('isEquivId: Actual id must not be undefined', actual !== undefined);\n  AssertFn(\n    'isEquivId: Actual id must be a number, string or null',\n    typeof actual === 'number' || typeof actual === 'string' || actual === null\n  );\n  AssertFn(\n    'isEquivId: Actual id must not be empty',\n    actual === null || typeof actual === 'number' || (typeof actual === 'string' && actual.length > 0)\n  );\n  AssertFn('isEquivId: Actual id must not be 0', actual !== '0' && actual !== 0);\n\n  return expected === actual || formattedId(expected) === formattedId(actual);\n}\n"],"names":["singularize","macroCondition","dependencySatisfies","importSync","MismatchReporter","_AssertFn","AssertFn","message","condition","getOwnConfig","env","DEBUG","Error","NormalizedType","str","dasherize","configureMismatchReporter","fn","configureAssertFn","configureTypeNormalization","NORMALIZED_TYPES","Map","formattedType","type","undefined","length","normalized","get","set","formattedId","id","formatted","String","isEquivType","expected","actual","isEquivId"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAcA,IAAIA,WAAoC,CAAA;AACxC,IAAIC,cAAc,CAACC,mBAAmB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC,EAAE;AAC/DF,EAAAA,WAAW,GAAIG,UAAU,CAAC,iBAAiB,CAAC,CAAsCH,WAAW,CAAA;AAC/F,CAAA;AAEA,IAAII,gBAA0B,GAAG,YAAY,EAAE,CAAA;;AAE/C;AACA;AACA,IAAIC,SAAwD,GAAG,YAAY,EAAE,CAAA;AAC7E,MAAMC,QAAoB,GAAIA,CAACC,OAAe,EAAEC,SAAkB,KAAK;EACrE,IAAI,CAACA,SAAS,EAAE;AACdH,IAAAA,SAAS,CAACE,OAAO,EAAEC,SAAS,CAAC,CAAA;AAC/B,GAAA;AACA,EAAA,IAAAP,cAAA,CAAAQ,YAAA,GAAAC,GAAA,CAAAC,KAAA,CAAW,EAAA;IACT,IAAI,CAACH,SAAS,EAAE;AACd,MAAA,MAAM,IAAII,KAAK,CAAE,CAAoBL,kBAAAA,EAAAA,OAAQ,EAAC,CAAC,CAAA;AACjD,KAAA;AACF,GAAA;AACF,CAA2B,CAAA;AAC3B,IAAIM,cAA0B,GAAIC,GAAW,IAAK;AAChD,EAAA,OAAOd,WAAW,CAACe,SAAS,CAACD,GAAG,CAAC,CAAC,CAAA;AACpC,CAAC,CAAA;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,yBAAyBA,CAACC,EAAY,EAAQ;AAC5Db,EAAAA,gBAAgB,GAAGa,EAAE,CAAA;AACvB,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,iBAAiBA,CAACD,EAAiD,EAAQ;AACzFZ,EAAAA,SAAS,GAAGY,EAAE,CAAA;AAChB,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,0BAA0BA,CAACF,EAA4B,EAAQ;AAC7EJ,EAAAA,cAAc,GAAGI,EAAE,CAAA;AACrB,CAAA;AAEA,MAAMG,gBAAgB,GAAG,IAAIC,GAAG,EAAkB,CAAA;;AAElD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,aAAaA,CAAmBC,IAAgB,EAAK;AACnEjB,EAAAA,QAAQ,CAAC,sCAAsC,EAAEiB,IAAI,KAAK,IAAI,CAAC,CAAA;AAC/DjB,EAAAA,QAAQ,CAAC,2CAA2C,EAAEiB,IAAI,KAAKC,SAAS,CAAC,CAAA;AACzElB,EAAAA,QAAQ,CAAC,sCAAsC,EAAE,OAAOiB,IAAI,KAAK,QAAQ,CAAC,CAAA;EAC1EjB,QAAQ,CAAC,uCAAuC,EAAEiB,IAAI,CAACE,MAAM,GAAG,CAAC,CAAC,CAAA;AAClE,EAAA,IAAIC,UAAU,GAAGN,gBAAgB,CAACO,GAAG,CAACJ,IAAI,CAAC,CAAA;EAE3C,IAAIG,UAAU,KAAKF,SAAS,EAAE;AAC5BE,IAAAA,UAAU,GAAGb,cAAc,CAACU,IAAI,CAAC,CAAA;AACjCH,IAAAA,gBAAgB,CAACQ,GAAG,CAACL,IAAI,EAAEG,UAAU,CAAC,CAAA;AACxC,GAAA;EAEA,IAAIA,UAAU,KAAKH,IAAI,EAAE;AACvBnB,IAAAA,gBAAgB,CAAC,gBAAgB,EAAEmB,IAAI,EAAEG,UAAU,CAAC,CAAA;AACtD,GAAA;AAEA,EAAA,OAAOA,UAAU,CAAA;AACnB,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIO,SAASG,WAAWA,CAACC,EAA0B,EAAiB;AACrExB,EAAAA,QAAQ,CAAC,uCAAuC,EAAEwB,EAAE,KAAKN,SAAS,CAAC,CAAA;AACnElB,EAAAA,QAAQ,CACN,kDAAkD,EAClD,OAAOwB,EAAE,KAAK,QAAQ,IAAI,OAAOA,EAAE,KAAK,QAAQ,IAAIA,EAAE,KAAK,IAC7D,CAAC,CAAA;EACDxB,QAAQ,CACN,mCAAmC,EACnC,OAAOwB,EAAE,KAAK,QAAQ,IAAIA,EAAE,KAAK,IAAI,IAAK,OAAOA,EAAE,KAAK,QAAQ,IAAIA,EAAE,CAACL,MAAM,GAAG,CAClF,CAAC,CAAA;EACDnB,QAAQ,CAAC,+BAA+B,EAAEwB,EAAE,KAAK,GAAG,IAAIA,EAAE,KAAK,CAAC,CAAC,CAAA;EAEjE,MAAMC,SAAS,GAAGD,EAAE,KAAK,IAAI,GAAG,IAAI,GAAGE,MAAM,CAACF,EAAE,CAAC,CAAA;EACjD,IAAIC,SAAS,KAAKD,EAAE,EAAE;AACpB1B,IAAAA,gBAAgB,CAAC,cAAc,EAAE0B,EAAE,EAAEC,SAAS,CAAC,CAAA;AACjD,GAAA;EACA,OAAOD,EAAE,KAAK,IAAI,GAAG,IAAI,GAAGE,MAAM,CAACF,EAAE,CAAC,CAAA;AACxC,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASG,WAAWA,CAACC,QAAgB,EAAEC,MAAc,EAAW;AACrE7B,EAAAA,QAAQ,CAAC,6CAA6C,EAAE4B,QAAQ,KAAK,IAAI,CAAC,CAAA;AAC1E5B,EAAAA,QAAQ,CAAC,kDAAkD,EAAE4B,QAAQ,KAAKV,SAAS,CAAC,CAAA;AACpFlB,EAAAA,QAAQ,CAAC,6CAA6C,EAAE,OAAO4B,QAAQ,KAAK,QAAQ,CAAC,CAAA;EACrF5B,QAAQ,CAAC,8CAA8C,EAAE4B,QAAQ,CAACT,MAAM,GAAG,CAAC,CAAC,CAAA;AAE7EnB,EAAAA,QAAQ,CAAC,2CAA2C,EAAE6B,MAAM,KAAK,IAAI,CAAC,CAAA;AACtE7B,EAAAA,QAAQ,CAAC,gDAAgD,EAAE6B,MAAM,KAAKX,SAAS,CAAC,CAAA;AAChFlB,EAAAA,QAAQ,CAAC,2CAA2C,EAAE,OAAO6B,MAAM,KAAK,QAAQ,CAAC,CAAA;EACjF7B,QAAQ,CAAC,4CAA4C,EAAE6B,MAAM,CAACV,MAAM,GAAG,CAAC,CAAC,CAAA;AAEzE,EAAA,OAAOS,QAAQ,KAAKC,MAAM,IAAIb,aAAa,CAACY,QAAQ,CAAC,KAAKZ,aAAa,CAACa,MAAM,CAAC,CAAA;AACjF,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,SAASA,CAACF,QAAyB,EAAEC,MAA8B,EAAW;AAC5F7B,EAAAA,QAAQ,CAAC,yCAAyC,EAAE4B,QAAQ,KAAK,IAAI,CAAC,CAAA;AACtE5B,EAAAA,QAAQ,CAAC,8CAA8C,EAAE4B,QAAQ,KAAKV,SAAS,CAAC,CAAA;AAChFlB,EAAAA,QAAQ,CACN,mDAAmD,EACnD,OAAO4B,QAAQ,KAAK,QAAQ,IAAI,OAAOA,QAAQ,KAAK,QACtD,CAAC,CAAA;AACD5B,EAAAA,QAAQ,CACN,0CAA0C,EAC1C,OAAO4B,QAAQ,KAAK,QAAQ,IAAK,OAAOA,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,CAACT,MAAM,GAAG,CACrF,CAAC,CAAA;EACDnB,QAAQ,CAAC,sCAAsC,EAAE4B,QAAQ,KAAK,GAAG,IAAIA,QAAQ,KAAK,CAAC,CAAC,CAAA;AAEpF5B,EAAAA,QAAQ,CAAC,4CAA4C,EAAE6B,MAAM,KAAKX,SAAS,CAAC,CAAA;AAC5ElB,EAAAA,QAAQ,CACN,uDAAuD,EACvD,OAAO6B,MAAM,KAAK,QAAQ,IAAI,OAAOA,MAAM,KAAK,QAAQ,IAAIA,MAAM,KAAK,IACzE,CAAC,CAAA;EACD7B,QAAQ,CACN,wCAAwC,EACxC6B,MAAM,KAAK,IAAI,IAAI,OAAOA,MAAM,KAAK,QAAQ,IAAK,OAAOA,MAAM,KAAK,QAAQ,IAAIA,MAAM,CAACV,MAAM,GAAG,CAClG,CAAC,CAAA;EACDnB,QAAQ,CAAC,oCAAoC,EAAE6B,MAAM,KAAK,GAAG,IAAIA,MAAM,KAAK,CAAC,CAAC,CAAA;AAE9E,EAAA,OAAOD,QAAQ,KAAKC,MAAM,IAAIN,WAAW,CAACK,QAAQ,CAAC,KAAKL,WAAW,CAACM,MAAM,CAAC,CAAA;AAC7E;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ember-data/legacy-compat",
   "description": "Compatibility Shims for Older EmberData",
-  "version": "5.4.0-alpha.53",
+  "version": "5.4.0-alpha.55",
   "license": "MIT",
   "author": "Chris Thoburn <runspired@users.noreply.github.com>",
   "repository": {
@@ -42,8 +42,8 @@
     "version": 1
   },
   "dependencies": {
-    "@ember-data/private-build-infra": "5.4.0-alpha.53",
-    "@embroider/macros": "^1.15.0",
+    "@ember-data/private-build-infra": "5.4.0-alpha.55",
+    "@embroider/macros": "^1.15.1",
     "ember-cli-babel": "^8.2.0"
   },
   "dependenciesMeta": {
@@ -79,12 +79,13 @@
     }
   },
   "peerDependencies": {
-    "@ember-data/graph": "5.4.0-alpha.53",
-    "@ember-data/json-api": "5.4.0-alpha.53",
-    "@ember-data/request": "5.4.0-alpha.53",
-    "@ember-data/store": "5.4.0-alpha.53",
+    "@ember-data/graph": "5.4.0-alpha.55",
+    "@ember-data/json-api": "5.4.0-alpha.55",
+    "@ember-data/request": "5.4.0-alpha.55",
+    "@ember-data/store": "5.4.0-alpha.55",
     "@ember/string": "^3.1.1",
-    "@warp-drive/core-types": "0.0.0-alpha.39"
+    "ember-inflector": "^4.0.2",
+    "@warp-drive/core-types": "0.0.0-alpha.41"
   },
   "peerDependenciesMeta": {
     "@ember-data/graph": {
@@ -92,6 +93,9 @@
     },
     "@ember-data/json-api": {
       "optional": true
+    },
+    "ember-inflector": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -105,24 +109,24 @@
     "@babel/preset-env": "^7.24.4",
     "@babel/preset-typescript": "^7.24.1",
     "@babel/runtime": "^7.24.4",
-    "@ember-data/graph": "5.4.0-alpha.53",
-    "@ember-data/json-api": "5.4.0-alpha.53",
-    "@ember-data/request": "5.4.0-alpha.53",
-    "@ember-data/request-utils": "5.4.0-alpha.53",
-    "@ember-data/store": "5.4.0-alpha.53",
-    "@ember-data/tracking": "5.4.0-alpha.53",
+    "@ember-data/graph": "5.4.0-alpha.55",
+    "@ember-data/json-api": "5.4.0-alpha.55",
+    "@ember-data/request": "5.4.0-alpha.55",
+    "@ember-data/request-utils": "5.4.0-alpha.55",
+    "@ember-data/store": "5.4.0-alpha.55",
+    "@ember-data/tracking": "5.4.0-alpha.55",
     "@ember/string": "^3.1.1",
-    "@embroider/addon-dev": "^4.2.1",
+    "@embroider/addon-dev": "^4.3.1",
     "@glimmer/component": "^1.1.2",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@warp-drive/core-types": "0.0.0-alpha.39",
-    "@warp-drive/internal-config": "5.4.0-alpha.53",
+    "@warp-drive/core-types": "0.0.0-alpha.41",
+    "@warp-drive/internal-config": "5.4.0-alpha.55",
     "ember-inflector": "^4.0.2",
     "ember-source": "~5.7.0",
     "pnpm-sync-dependencies-meta-injected": "0.0.10",
-    "rollup": "^4.14.0",
-    "typescript": "^5.4.4",
+    "rollup": "^4.14.1",
+    "typescript": "^5.4.5",
     "walk-sync": "^3.0.0"
   },
   "ember": {

package/unstable-preview-types/index.d.ts

@@ -1,20 +1,21 @@
+/// <reference path="./utils.d.ts" />
 /// <reference path="./builders.d.ts" />
 /// <reference path="./-private.d.ts" />
-/// <reference path="./builders/find-record.d.ts" />
-/// <reference path="./builders/find-all.d.ts" />
-/// <reference path="./builders/query.d.ts" />
-/// <reference path="./builders/save-record.d.ts" />
-/// <reference path="./builders/utils.d.ts" />
-/// <reference path="./legacy-network-handler/fetch-manager.d.ts" />
 /// <reference path="./legacy-network-handler/identifier-has-id.d.ts" />
+/// <reference path="./legacy-network-handler/minimum-serializer-interface.d.ts" />
+/// <reference path="./legacy-network-handler/legacy-data-fetch.d.ts" />
+/// <reference path="./legacy-network-handler/snapshot.d.ts" />
+/// <reference path="./legacy-network-handler/snapshot-record-array.d.ts" />
 /// <reference path="./legacy-network-handler/minimum-adapter-interface.d.ts" />
 /// <reference path="./legacy-network-handler/legacy-data-utils.d.ts" />
-/// <reference path="./legacy-network-handler/legacy-data-fetch.d.ts" />
 /// <reference path="./legacy-network-handler/legacy-network-handler.d.ts" />
-/// <reference path="./legacy-network-handler/snapshot-record-array.d.ts" />
 /// <reference path="./legacy-network-handler/serializer-response.d.ts" />
-/// <reference path="./legacy-network-handler/minimum-serializer-interface.d.ts" />
-/// <reference path="./legacy-network-handler/snapshot.d.ts" />
+/// <reference path="./legacy-network-handler/fetch-manager.d.ts" />
+/// <reference path="./builders/save-record.d.ts" />
+/// <reference path="./builders/find-all.d.ts" />
+/// <reference path="./builders/query.d.ts" />
+/// <reference path="./builders/utils.d.ts" />
+/// <reference path="./builders/find-record.d.ts" />
 declare module '@ember-data/legacy-compat' {
   import type Store from '@ember-data/store';
   import type { ObjectValue } from '@warp-drive/core-types/json/raw';

package/unstable-preview-types/utils.d.ts

@@ -0,0 +1,159 @@
+declare module '@ember-data/legacy-compat/utils' {
+  type Reporter = (type: 'formatted-id' | 'formatted-type', actual: unknown, expected: unknown) => void;
+  /**
+   * Configure a function to be called when an id or type
+   * changes during normalization. This is useful for instrumenting
+   * to discover places where usage in the app is not consistent.
+   *
+   * @method configureMismatchReporter
+   * @for @ember-data/legacy-compat/utils
+   * @param method a function which takes a mismatch-type ('formatted-id' | 'formatted-type'), actual, and expected value
+   * @public
+   * @static
+   */
+  export function configureMismatchReporter(fn: Reporter): void;
+  /**
+   * Configure a function to be called when an id or type
+   * fails validation. This is useful for instrumenting
+   * to discover places where usage in the app is not consistent.
+   *
+   * @method configureAssertFn
+   * @for @ember-data/legacy-compat/utils
+   * @param method a function which takes a message and a condition
+   * @public
+   * @static
+   */
+  export function configureAssertFn(fn: (message: string, condition: unknown) => void): void;
+  /**
+   * Configure a function to be called to normalize
+   * a resource type string. Used by both formattedType
+   * and isEquivType to ensure consistent normalization
+   * during comparison.
+   *
+   * If validation fails or the type turns out be unnormalized
+   * the configured mismatch reporter and assert functions will
+   * be called.
+   *
+   * @method configureTypeNormalization
+   * @for @ember-data/legacy-compat/utils
+   * @param method a function which takes a string and returns a string
+   * @public
+   * @static
+   */
+  export function configureTypeNormalization(fn: (type: string) => string): void;
+  /**
+   * Converts a potentially unnormalized type into the format expected
+   * by our EmberData Cache. Currently this is singular-dasherized.
+   *
+   * you should not rely on this function to give you an exact format
+   * for display purposes. Formatting for display should be handled
+   * differently if the exact format matters.
+   *
+   * Asserts invalid types (undefined, null, '') in dev.
+   *
+   * **Usage**
+   *
+   * ```js
+   * import formattedType from 'soxhub-client/helpers/formatted-type';
+   *
+   * formattedType('post'); // => 'post'
+   * formattedType('posts'); // => 'post'
+   * formattedType('Posts'); // => 'post'
+   * formattedType('post-comment'); // => 'post-comment'
+   * formattedType('post-comments'); // => 'post-comment'
+   * formattedType('post_comment'); // => 'post-comment'
+   * formattedType('postComment'); // => 'post-comment'
+   * formattedType('PostComment'); // => 'post-comment'
+   * ```
+   *
+   * @method formattedType
+   * @for @ember-data/legacy-compat/utils
+   * @param {string} type the potentially un-normalized type
+   * @return {string} the normalized type
+   * @public
+   * @static
+   */
+  export function formattedType<T extends string>(type: T | string): T;
+  /**
+   * Format an id to the format expected by the EmberData Cache.
+   * Currently this means that id should be `string | null`.
+   *
+   * Asserts invalid IDs (undefined, '', 0, '0') in dev.
+   *
+   * **Usage**
+   *
+   * ```js
+   * import formattedId from 'client/utils/formatted-id';
+   *
+   * formattedId('1'); // => '1'
+   * formattedId(1); // => '1'
+   * formattedId(null); // => null
+   *	```
+   *
+   * @method formattedId
+   * @for @ember-data/legacy-compat/utils
+   * @param {string | number | null} id the potentially un-normalized id
+   * @return {string | null} the normalized id
+   * @public
+   * @static
+   */
+  export function formattedId(id: string | number): string;
+  export function formattedId(id: null): null;
+  export function formattedId(id: string | number | null): string | null;
+  /**
+   * Compares two types for strict equality, converting them to
+   * the format expected by the EmberData Cache to ensure
+   * differences in format are accounted for in the comparison.
+   *
+   * Asserts when expected or actual are invalid types in dev.
+   * Expected may never be null.
+   *
+   * ```js
+   * isEquivType('posts', 'post'); // true
+   * isEquivType('post', 'post'); // true
+   * isEquivType('posts', 'posts'); // true
+   * isEquivType('post-comment', 'postComment'); // true
+   * isEquivType('post-comment', 'PostComment'); // true
+   * isEquivType('post-comment', 'post_comment'); // true
+   * isEquivType('post-comment', 'post-comment'); // true
+   * isEquivType('post-comment', 'post'); // false
+   * isEquivType('posts', null); // false
+   * ```
+   *
+   * @method isEquivType
+   * @for @ember-data/legacy-compat/utils
+   * @param {string} expected a potentially unnormalized type to match against
+   * @param {string} actual a potentially unnormalized type to match against
+   * @return {boolean} true if the types are equivalent
+   * @public
+   * @static
+   */
+  export function isEquivType(expected: string, actual: string): boolean;
+  /**
+   * Compares two IDs for strict equality, converting them to
+   * the format expected by the EmberData Cache to ensure
+   * differences in format are accounted for in the comparison.
+   *
+   * Asserts when expected or actual are invalid IDs in dev.
+   * Expected may never be null.
+   *
+   * ```js
+   * isEquivId('1', 1); // true
+   * isEquivId('2', '2'); // true
+   * isEquivId(3, '3'); // true
+   * isEquivId(4, '3'); // false
+   * isEquivId(1, null); // false
+   * ```
+   *
+   * @method isEquivId
+   * @for @ember-data/legacy-compat/utils
+   * @param {string | number} expected a potentially un-normalized id to match against
+   * @param {string | number} actual a potentially un-normalized id to match against
+   * @return {boolean} true if the ids are equivalent
+   * @public
+   * @static
+   */
+  export function isEquivId(expected: string | number, actual: string | number | null): boolean;
+  export {};
+}
+//# sourceMappingURL=utils.d.ts.map

package/unstable-preview-types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAmBA,KAAK,QAAQ,GAAG,CAAC,IAAI,EAAE,cAAc,GAAG,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;AA0BtG;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI,CAE5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAEzF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,0BAA0B,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAE7E;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,GAAG,CAAC,CAiBnE;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AACzD,wBAAgB,WAAW,CAAC,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC;AAC5C,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;AAoBvE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAYrE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAyB5F"}