fa-model-catalog 0.0.0-stage → 0.1.1

package/.agents/skills/deploy/config/config.example.yaml

@@ -0,0 +1,27 @@
+remote:
+  host: server.example.com
+  keyPath: C:/Users/<user>/.ssh/id_rsa
+  port: 22
+  publicHost: catalog.example.com
+  repository: https://example.com/organization/model-catalog.git
+  user: root
+access:
+  clients:
+    - id: shared
+      keys:
+        - id: primary
+          token: REPLACE_WITH_ACCESS_TOKEN
+server:
+  accessFile: /etc/fa-model-catalog/access.yaml
+  catalogFile: /opt/model-catalog/catalog.yaml
+  host: 127.0.0.1
+  port: 3000
+  reloadIntervalMs: 5000
+deployment:
+  appDirectory: /opt/model-catalog
+  serviceName: fa-model-catalog
+  publicPort: 443
+  branch: master
+  nginxSite: /etc/nginx/sites-enabled/catalog.example.com.conf
+  nginxSnippet: /etc/nginx/snippets/fa-model-catalog.conf
+  catalogSource: catalog.example.yaml

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bazilio-san
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,63 @@
-# Temporary Holding Version
+# Shared model and pricing catalog
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The service stores model prices and capabilities in one validated file.
+Applications retrieve entries through the package client and calculate costs directly in memory.
+Catalog changes do not require applications to update the package.
+
+Node.js is required; the version and dependencies are specified in the [package manifest](package.json).
+
+```bash
+npm install --save-exact fa-model-catalog
+```
+
+The client sends `POST /v1/models/resolve` to the configured service.
+Set `MODEL_CATALOG_URL` to the HTTPS origin, such as `https://catalog.example.com`.
+The client adds `/v1/models/resolve` automatically. Direct HTTP callers use the full endpoint URL.
+
+Application connection example:
+
+```js
+import { createCatalogClient } from 'fa-model-catalog/client';
+import { calculatePrice } from 'fa-model-catalog/pricing';
+
+const client = createCatalogClient({
+  baseUrl: process.env.MODEL_CATALOG_URL,
+  token: process.env.MODEL_CATALOG_TOKEN,
+  models: ['gpt-6-sol'],
+});
+await client.start();
+try {
+  const [record] = await client.get(['gpt-6-sol']);
+  const result = calculatePrice(record, {
+    unit: 'tokens',
+    inputTokens: 1000,
+    cachedInputTokens: 200,
+    cacheWriteInputTokens: 100,
+    outputTokens: 50,
+  });
+  console.dir(result, { depth: null });
+} finally {
+  client.stop();
+}
+```
+
+In a long-running application, create one client per process and stop it during shutdown.
+Pass the key through private application settings; never include it in source files or logs.
+
+- [Catalog structure and name lookup](docs/catalog.md).
+- [Client, scheduling, and calculations](docs/client.md).
+- [Startup and operations](docs/operations.md).
+- [Development setup and project settings](docs/development.md).
+
+The example catalog illustrates the data format; information not confirmed by the provider remains available
+with an explanation of its limitations.
+Publishing the package does not confirm that every rate matches the provider's current price.
+
+Development uses the checks defined in the [package manifest](package.json):
+
+```bash
+npm ci
+npm run quality
+npm run catalog:check
+npm pack --dry-run
+```