@converse/skeletor 4.0.1 → 4.0.2

package/package.json

@@ -39,19 +39,20 @@
   "contributors": [
     "JC Brand"
   ],
-  "version": "4.0.1",
+  "version": "4.0.2",
   "engines": {
     "node": ">=22.0.0"
   },
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/conversejs/skeletor.git"
+    "url": "git+https://github.com/conversejs/skeletor.git"
   },
   "scripts": {
     "build": "npm run clean && rollup -c",
     "check": "npm run check:types && npm run test && npm run test:node && npm run lint",
     "check:types": "tsc --noEmit",
+    "check:dts": "tsc -p tsconfig.dts.json",
     "clean": "rm -rf dist",
     "dev": "karma start --single-run=false",
     "lint": "eslint src/*.ts test/*.ts",
@@ -86,12 +87,6 @@
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.10.2",
-    "@babel/plugin-external-helpers": "^7.10.1",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6",
-    "@babel/plugin-proposal-optional-chaining": "^7.13.12",
-    "@babel/preset-env": "^7.9.5",
-    "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^28.0.3",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-terser": "^1.0.0",
@@ -103,8 +98,6 @@
     "@types/sinon": "^17.0.4",
     "@typescript-eslint/eslint-plugin": "^8.29.0",
     "@typescript-eslint/parser": "^8.29.0",
-    "babel-eslint": "^10.1.0",
-    "babel-loader": "^9.2.1",
     "chai": "^4.2.0",
     "eslint": "^8.57.0",
     "karma": "^6.3.16",

package/src/collection.ts

@@ -65,6 +65,23 @@ async function hydrate(collection: Collection<any>): Promise<void> {
   await collection.fetch({ fromStorage: true, promise: true });
 }
 
+/**
+ * `model` and `comparator` are declared on an interface merged with the class
+ * rather than on the class itself, so that subclasses may override them either
+ * as instance properties (`model = Contact`) or as accessors (`get model()`).
+ * TypeScript rejects the one form overriding the other (TS2610, TS2611) only
+ * when the base member is declared on a class.
+ */
+export interface Collection<T extends Model = Model> {
+  /**
+   * The model class to instantiate when raw attributes are added. Defaults to
+   * `Model` when unset. Typed loosely so that model classes whose constructors
+   * take required or narrower attributes and options fit.
+   */
+  model: new (attributes?: any, options?: any) => T;
+  comparator: Comparator<T>;
+}
+
 /**
  * @public
  * If models tend to represent a single row of data, a Collection is
@@ -74,15 +91,14 @@ async function hydrate(collection: Collection<any>): Promise<void> {
  * belonging to this particular author, and so on. Collections maintain
  * indexes of their models, both in order, and for lookup by `id`.
  */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging -- see the interface above
 export class Collection<T extends Model = Model> extends EventEmitterObject {
   [key: symbol]: () => CollectionIterator<T>;
   _storage?: PersistentStorage;
-  _comparator?: Comparator<T>;
   _url: string = '';
   hydrated?: Promise<void>;
   models: T[];
   protected _byId: Record<string, T>;
-  protected _model?: new (attributes?: Partial<ModelAttributes>, options?: ModelOptions) => T;
 
   /**
    * Create a new **Collection**, perhaps to contain a specific type of `model`.
@@ -93,7 +109,7 @@ export class Collection<T extends Model = Model> extends EventEmitterObject {
     super();
     options = options || {};
     this.preinitialize.apply(this, arguments as any);
-    if (options.model) this._model = options.model;
+    if (options.model) this.model = options.model;
     if (options.comparator !== undefined) this.comparator = options.comparator;
     this._reset();
     this.initialize.apply(this, arguments as any);
@@ -108,14 +124,6 @@ export class Collection<T extends Model = Model> extends EventEmitterObject {
     }
   }
 
-  get comparator(): Comparator<T> {
-    return this._comparator;
-  }
-
-  set comparator(c: Comparator<T>) {
-    this._comparator = c;
-  }
-
   /**
    * The canonical storage accessor. Set to a `PersistentStorage` instance
    * to enable local persistence for this collection.
@@ -156,18 +164,6 @@ export class Collection<T extends Model = Model> extends EventEmitterObject {
     return false;
   }
 
-  /**
-   * The default model for a collection is just a **Model**.
-   * This should be overridden in most cases.
-   */
-  get model(): new (attributes?: Partial<ModelAttributes>, options?: ModelOptions) => T | Model {
-    return this._model ?? Model;
-  }
-
-  set model(model: new (attributes?: Partial<ModelAttributes>, options?: ModelOptions) => T) {
-    this._model = model;
-  }
-
   get length(): number {
     return this.models.length;
   }
@@ -745,7 +741,7 @@ export class Collection<T extends Model = Model> extends EventEmitterObject {
    * Define how to uniquely identify models in the collection.
    */
   modelId(attrs: ModelAttributes): string | number | undefined {
-    return attrs[this.model.prototype?.idAttribute || 'id'];
+    return attrs[(this.model ?? Model).prototype?.idAttribute || 'id'];
   }
 
   /** Get an iterator of all models in this collection. */
@@ -779,7 +775,7 @@ export class Collection<T extends Model = Model> extends EventEmitterObject {
   }
 
   createModel(attrs: ModelAttributes, options?: Options): T {
-    const Klass = this.model;
+    const Klass = this.model ?? Model;
     return new Klass(attrs, options) as T;
   }
 

package/src/types.ts

@@ -62,10 +62,7 @@ export type EventListenerMap = Record<string, ListeningType>;
 /**
  * @public
  */
-export interface EventHandlersMap {
-  all?: EventHandler[];
-  [name: string]: EventHandler[];
-}
+export type EventHandlersMap = Record<string, EventHandler[]>;
 
 /**
  * @public
@@ -168,7 +165,9 @@ export type IterateeFunction = (
  */
 export type ComputedProperty<M> = {
   deps: string[];
-  fn: (model: M) => any;
+  // Method syntax, so that TypeScript checks `fn` bivariantly and
+  // `ComputedProperties<Subclass>` stays assignable to `ComputedProperties<Model>`.
+  fn(model: M): any;
 };
 
 /**
@@ -198,7 +197,7 @@ export type FetchOrCreateOptions = Options & {
  * @public
  */
 export type CollectionOptions<T extends Model = Model> = Options & {
-  model?: new (attributes?: Partial<ModelAttributes>, options?: ModelOptions) => T;
+  model?: new (attributes?: any, options?: any) => T;
   comparator?: Comparator<T>;
   previousModels?: Model[];
 };