aimodels 0.2.2 → 0.2.4

package/README.md

@@ -13,36 +13,23 @@ npm install aimodels
 ```typescript
 import { models } from 'aimodels';
 
-// Get all available models
-console.log(models.all);
-
-// Get list of all providers
-console.log(models.providers); // ['openai', 'anthropic', 'mistral', ...]
-
-// Get list of model creators
-console.log(models.creators); // ['meta', 'mistral', ...]
+// Find models by capability
+const chatModels = models.can('chat');
+const multimodalModels = models.can('chat', 'img-in');
 
-// Get models from a specific provider
-const openAiModels = models.fromProvider('openai');
+// Find models by provider
+const openaiModels = models.fromProvider('openai');
 
-// Get models from a specific creator
+// Find models by creator
 const metaModels = models.fromCreator('meta');
 
-// Find a specific model
-const model = models.find('gpt-4');
+// Find models by context window
+const largeContextModels = models.withMinContext(32768);
+
+// Find specific model
+const model = models.id('gpt-4');
 console.log(model?.context.total); // Context window size
 console.log(model?.providers); // ['openai']
-
-// Get model pricing for a specific provider
-const price = models.getPrice('gpt-4', 'openai');
-console.log(price); // { type: 'token', input: 0.03, output: 0.06 }
-
-// Filter models by capabilities
-const chatModels = models.can('chat');
-const multimodalModels = models.can('chat', 'img-in');
-
-// Filter by context window
-const largeContextModels = models.withMinContext(32768);
 ```
 
 ## Features
@@ -51,43 +38,53 @@ const largeContextModels = models.withMinContext(32768);
 - Normalized data structure for easy comparison
 - Model capabilities (chat, img-in, img-out, function-out, etc.)
 - Context window information
-- Pricing information per provider
 - Creator and provider associations
 - TypeScript support with full type safety
 - Zero dependencies
 - Universal JavaScript support (Node.js, browsers, Deno)
 - Regular updates with new models
 
-
 ## Types
 
+### Model
 ```typescript
 interface Model {
-  id: string;           // Unique model identifier
-  name: string;         // Display name
-  can: string[];        // Capabilities (chat, img-in, img-out, etc.)
-  providers: string[];  // Available providers
-  context: {
-    total: number;      // Total context window size
-  };
-  license: string;      // License or creator
+  /** Unique identifier */
+  id: string;
+  /** Display name */
+  name: string;
+  /** Model capabilities */
+  can: Capability[];
+  /** Available providers */
+  providers: string[];
+  /** Context window information */
+  context: ModelContext;
+  /** License or creator */
+  license: string;
 }
+```
 
-type ModelPrice = 
-  | { type: 'token'; input: number; output: number }      // Price per 1K tokens
-  | { type: 'image'; price: number; size: string }        // Price per image
-  | { type: 'character'; price: number }                  // Price per character
-  | { type: 'minute'; price: number };                    // Price per minute
-
-interface Provider {
-  id: string;           // Provider identifier
-  name: string;         // Display name
-  websiteUrl: string;   // Provider's website
-  apiUrl: string;       // API documentation URL
-  models: Record<string, ModelPrice>;  // Model pricing
-}
+### Capabilities
+```typescript
+type Capability =
+  | "chat"         // shortcut for "text-in" and "text-out"
+  | "reason"       // when the model spends some tokens on reasoning
+  | "text-in"      // process text input
+  | "text-out"     // output text
+  | "img-in"       // understand images
+  | "img-out"      // generate images
+  | "sound-in"     // process audio input
+  | "sound-out"    // generate audio/speech
+  | "json-out"     // structured JSON output
+  | "function-out" // function calling
+  | "vectors-out"; // output vector embeddings
 ```
 
+For more detailed information, see:
+- [Model Capabilities](/docs/model-capabilities.md)
+- [Model Structure](/docs/model-structure.md)
+- [Providers](/docs/providers.md)
+
 ## License
 
 MIT

package/dist/index.d.mts

@@ -13,11 +13,22 @@ interface ModelPrice {
 type Capability = "chat" | "reason" | "text-in" | "text-out" | "img-in" | "img-out" | "sound-in" | "sound-out" | "json-out" | "function-out" | "vectors-out";
 
 declare class ModelCollection extends Array<Model> {
-    constructor(models: Model[]);
+    /** Create a new ModelCollection from an array of models */
+    constructor(models?: Model[]);
+    /** Filter models by one or more capabilities (all must be present) */
     can(...capabilities: Capability[]): ModelCollection;
+    /** Filter models by one or more languages (all must be supported) */
     know(...languages: string[]): ModelCollection;
+    /** Override array filter to return ModelCollection */
     filter(predicate: (value: Model, index: number, array: Model[]) => boolean): ModelCollection;
+    /** Override array slice to return ModelCollection */
     slice(start?: number, end?: number): ModelCollection;
+    /** Find a model by its ID */
+    id(modelId: string): Model | undefined;
+    /** Get models available from a specific provider */
+    fromProvider(provider: string): ModelCollection;
+    /** Filter models by minimum context window size */
+    withMinContext(tokens: number): ModelCollection;
 }
 interface ModelContext {
     /** Maximum total tokens (input + output) */
@@ -41,26 +52,6 @@ interface Model {
     /** Context window information */
     context: ModelContext;
 }
-interface ModelsAPI {
-    /** All available models */
-    all: ModelCollection;
-    /** List of all creators */
-    creators: string[];
-    /** List of all providers */
-    providers: string[];
-    /** Get models from a specific creator */
-    fromCreator(creator: string): ModelCollection;
-    /** Get models from a specific provider */
-    fromProvider(provider: string): ModelCollection;
-    /** Find a specific model by ID */
-    find(id: string): Model | undefined;
-    /** Filter models by one or more capabilities (all must be present) */
-    can(...capabilities: string[]): ModelCollection;
-    /** Filter models by minimum context window */
-    withMinContext(tokens: number): ModelCollection;
-    /** Get pricing for a model from a specific provider */
-    getPrice(modelId: string, provider: string): ModelPrice | undefined;
-}
 
 var creators = {
 	openai: {
@@ -84,6 +75,12 @@ var creators$1 = {
 	creators: creators
 };
 
-declare const models: ModelsAPI;
+declare class ModelsCollection extends ModelCollection {
+    get creators(): string[];
+    get providers(): string[];
+    fromCreator(creator: string): ModelCollection;
+    getPrice(modelId: string, provider: string): ModelPrice | undefined;
+}
+declare const models: ModelsCollection;
 
-export { creators$1 as creators, models };
+export { type Capability, type Model, ModelCollection, type ModelContext, type ModelPrice, creators$1 as creators, models };

package/dist/index.d.ts

@@ -13,11 +13,22 @@ interface ModelPrice {
 type Capability = "chat" | "reason" | "text-in" | "text-out" | "img-in" | "img-out" | "sound-in" | "sound-out" | "json-out" | "function-out" | "vectors-out";
 
 declare class ModelCollection extends Array<Model> {
-    constructor(models: Model[]);
+    /** Create a new ModelCollection from an array of models */
+    constructor(models?: Model[]);
+    /** Filter models by one or more capabilities (all must be present) */
     can(...capabilities: Capability[]): ModelCollection;
+    /** Filter models by one or more languages (all must be supported) */
     know(...languages: string[]): ModelCollection;
+    /** Override array filter to return ModelCollection */
     filter(predicate: (value: Model, index: number, array: Model[]) => boolean): ModelCollection;
+    /** Override array slice to return ModelCollection */
     slice(start?: number, end?: number): ModelCollection;
+    /** Find a model by its ID */
+    id(modelId: string): Model | undefined;
+    /** Get models available from a specific provider */
+    fromProvider(provider: string): ModelCollection;
+    /** Filter models by minimum context window size */
+    withMinContext(tokens: number): ModelCollection;
 }
 interface ModelContext {
     /** Maximum total tokens (input + output) */
@@ -41,26 +52,6 @@ interface Model {
     /** Context window information */
     context: ModelContext;
 }
-interface ModelsAPI {
-    /** All available models */
-    all: ModelCollection;
-    /** List of all creators */
-    creators: string[];
-    /** List of all providers */
-    providers: string[];
-    /** Get models from a specific creator */
-    fromCreator(creator: string): ModelCollection;
-    /** Get models from a specific provider */
-    fromProvider(provider: string): ModelCollection;
-    /** Find a specific model by ID */
-    find(id: string): Model | undefined;
-    /** Filter models by one or more capabilities (all must be present) */
-    can(...capabilities: string[]): ModelCollection;
-    /** Filter models by minimum context window */
-    withMinContext(tokens: number): ModelCollection;
-    /** Get pricing for a model from a specific provider */
-    getPrice(modelId: string, provider: string): ModelPrice | undefined;
-}
 
 var creators = {
 	openai: {
@@ -84,6 +75,12 @@ var creators$1 = {
 	creators: creators
 };
 
-declare const models: ModelsAPI;
+declare class ModelsCollection extends ModelCollection {
+    get creators(): string[];
+    get providers(): string[];
+    fromCreator(creator: string): ModelCollection;
+    getPrice(modelId: string, provider: string): ModelPrice | undefined;
+}
+declare const models: ModelsCollection;
 
-export { creators$1 as creators, models };
+export { type Capability, type Model, ModelCollection, type ModelContext, type ModelPrice, creators$1 as creators, models };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ModelCollection: () => ModelCollection,
   creators: () => creators_default,
   models: () => models
 });
@@ -27,26 +28,43 @@ module.exports = __toCommonJS(index_exports);
 
 // src/types/models.ts
 var ModelCollection = class _ModelCollection extends Array {
-  constructor(models2) {
-    super(...models2);
+  /** Create a new ModelCollection from an array of models */
+  constructor(models2 = []) {
+    super();
+    if (models2.length > 0) {
+      this.push(...models2);
+    }
     Object.setPrototypeOf(this, _ModelCollection.prototype);
   }
+  /** Filter models by one or more capabilities (all must be present) */
   can(...capabilities) {
-    return new _ModelCollection(
-      this.filter((model) => capabilities.every((cap) => model.can.includes(cap)))
-    );
+    return this.filter((model) => capabilities.every((cap) => model.can.includes(cap)));
   }
+  /** Filter models by one or more languages (all must be supported) */
   know(...languages) {
-    return new _ModelCollection(
-      this.filter((model) => languages.every((lang) => model.languages?.includes(lang)))
-    );
+    return this.filter((model) => languages.every((lang) => model.languages?.includes(lang)));
   }
-  // Override array methods to return ModelCollection
+  /** Override array filter to return ModelCollection */
   filter(predicate) {
-    return new _ModelCollection(super.filter(predicate));
+    const filtered = Array.from(this).filter(predicate);
+    return new _ModelCollection(filtered);
   }
+  /** Override array slice to return ModelCollection */
   slice(start, end) {
-    return new _ModelCollection(super.slice(start, end));
+    const sliced = Array.from(this).slice(start, end);
+    return new _ModelCollection(sliced);
+  }
+  /** Find a model by its ID */
+  id(modelId) {
+    return this.find((model) => model.id === modelId);
+  }
+  /** Get models available from a specific provider */
+  fromProvider(provider) {
+    return this.filter((model) => model.providers.includes(provider));
+  }
+  /** Filter models by minimum context window size */
+  withMinContext(tokens) {
+    return this.filter((model) => model.context.total >= tokens);
   }
 };
 
@@ -762,51 +780,32 @@ var creators_default = {
 // src/index.ts
 var allModels = buildAllModels();
 var providersData = buildProvidersData();
-var models = {
-  all: new ModelCollection(allModels),
+var ModelsCollection = class extends ModelCollection {
   get creators() {
     return Object.keys(creators_default.creators);
-  },
+  }
   get providers() {
     return providersData.providers.map((p) => p.id);
-  },
+  }
   fromCreator(creator) {
     return new ModelCollection(
-      allModels.filter(
+      this.filter(
         (model) => model.license.startsWith(creator) || // For open source models
-        providersData.providers.find((p) => p.id === creator)?.models[model.id]
+        !!providersData.providers.find((p) => p.id === creator)?.models[model.id]
         // For proprietary models
       )
     );
-  },
-  fromProvider(provider) {
-    return new ModelCollection(
-      allModels.filter((model) => model.providers.includes(provider))
-    );
-  },
-  find(id) {
-    return allModels.find((model) => model.id === id);
-  },
-  can(...capabilities) {
-    return new ModelCollection(
-      allModels.filter(
-        (model) => capabilities.every((capability) => model.can.includes(capability))
-      )
-    );
-  },
-  withMinContext(tokens) {
-    return new ModelCollection(
-      allModels.filter((model) => model.context.total >= tokens)
-    );
-  },
+  }
   getPrice(modelId, provider) {
     const providerData = providersData.providers.find((p) => p.id === provider);
     const price = providerData?.models[modelId];
     return price?.type === "token" ? price : void 0;
   }
 };
+var models = new ModelsCollection(allModels);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ModelCollection,
   creators,
   models
 });

package/dist/index.mjs

@@ -1,25 +1,42 @@
 // src/types/models.ts
 var ModelCollection = class _ModelCollection extends Array {
-  constructor(models2) {
-    super(...models2);
+  /** Create a new ModelCollection from an array of models */
+  constructor(models2 = []) {
+    super();
+    if (models2.length > 0) {
+      this.push(...models2);
+    }
     Object.setPrototypeOf(this, _ModelCollection.prototype);
   }
+  /** Filter models by one or more capabilities (all must be present) */
   can(...capabilities) {
-    return new _ModelCollection(
-      this.filter((model) => capabilities.every((cap) => model.can.includes(cap)))
-    );
+    return this.filter((model) => capabilities.every((cap) => model.can.includes(cap)));
   }
+  /** Filter models by one or more languages (all must be supported) */
   know(...languages) {
-    return new _ModelCollection(
-      this.filter((model) => languages.every((lang) => model.languages?.includes(lang)))
-    );
+    return this.filter((model) => languages.every((lang) => model.languages?.includes(lang)));
   }
-  // Override array methods to return ModelCollection
+  /** Override array filter to return ModelCollection */
   filter(predicate) {
-    return new _ModelCollection(super.filter(predicate));
+    const filtered = Array.from(this).filter(predicate);
+    return new _ModelCollection(filtered);
   }
+  /** Override array slice to return ModelCollection */
   slice(start, end) {
-    return new _ModelCollection(super.slice(start, end));
+    const sliced = Array.from(this).slice(start, end);
+    return new _ModelCollection(sliced);
+  }
+  /** Find a model by its ID */
+  id(modelId) {
+    return this.find((model) => model.id === modelId);
+  }
+  /** Get models available from a specific provider */
+  fromProvider(provider) {
+    return this.filter((model) => model.providers.includes(provider));
+  }
+  /** Filter models by minimum context window size */
+  withMinContext(tokens) {
+    return this.filter((model) => model.context.total >= tokens);
   }
 };
 
@@ -735,50 +752,31 @@ var creators_default = {
 // src/index.ts
 var allModels = buildAllModels();
 var providersData = buildProvidersData();
-var models = {
-  all: new ModelCollection(allModels),
+var ModelsCollection = class extends ModelCollection {
   get creators() {
     return Object.keys(creators_default.creators);
-  },
+  }
   get providers() {
     return providersData.providers.map((p) => p.id);
-  },
+  }
   fromCreator(creator) {
     return new ModelCollection(
-      allModels.filter(
+      this.filter(
         (model) => model.license.startsWith(creator) || // For open source models
-        providersData.providers.find((p) => p.id === creator)?.models[model.id]
+        !!providersData.providers.find((p) => p.id === creator)?.models[model.id]
         // For proprietary models
       )
     );
-  },
-  fromProvider(provider) {
-    return new ModelCollection(
-      allModels.filter((model) => model.providers.includes(provider))
-    );
-  },
-  find(id) {
-    return allModels.find((model) => model.id === id);
-  },
-  can(...capabilities) {
-    return new ModelCollection(
-      allModels.filter(
-        (model) => capabilities.every((capability) => model.can.includes(capability))
-      )
-    );
-  },
-  withMinContext(tokens) {
-    return new ModelCollection(
-      allModels.filter((model) => model.context.total >= tokens)
-    );
-  },
+  }
   getPrice(modelId, provider) {
     const providerData = providersData.providers.find((p) => p.id === provider);
     const price = providerData?.models[modelId];
     return price?.type === "token" ? price : void 0;
   }
 };
+var models = new ModelsCollection(allModels);
 export {
+  ModelCollection,
   creators_default as creators,
   models
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aimodels",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "A collection of AI model specifications across different providers",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -19,6 +19,7 @@
   "scripts": {
     "prebuild": "npm run typecheck && npm run lint && npm test",
     "build": "tsup src/index.ts --format cjs,esm --dts",
+    "gen-ai-rules": "node scripts/gen-ai-rules.js",
     "test": "deno test tests/",
     "test:watch": "deno test --watch tests/",
     "typecheck": "tsc --noEmit",