@canarycoders/ai 0.4.0 → 0.6.0

package/README.md

@@ -16,9 +16,9 @@ bun add @canarycoders/ai
 ## Quick start
 
 ```ts
-import CanaryLLM from "@canarycoders/ai";
+import CanaryCodersAI from "@canarycoders/ai";
 
-const client = new CanaryLLM({ apiKey: process.env.CANARY_AI_API_KEY });
+const client = new CanaryCodersAI({ apiKey: process.env.CANARY_AI_API_KEY });
 
 const res = await client.chat.complete({
   provider: "openai",
@@ -29,7 +29,7 @@ const res = await client.chat.complete({
 console.log(res.content, res.usage.totalTokens);
 ```
 
-`apiKey` defaults to `CANARY_AI_API_KEY` (legacy `CANARYLLM_API_KEY` still works) and `baseURL` to the hosted gateway, so `new CanaryLLM()` with the env var set is enough.
+`apiKey` defaults to `CANARY_AI_API_KEY` (legacy `CANARYLLM_API_KEY` still works) and `baseURL` to the hosted gateway, so `new CanaryCodersAI()` with the env var set is enough.
 
 ## How the queue works
 
@@ -161,6 +161,10 @@ await oa.chat.completions.create({
 | `defaultTag` | — | attached to requests for usage attribution |
 | `poll` | — | default poll timing for queued ops |
 
+## Agent skill
+
+`skills/canary-ai/` ships a Codex/Claude Code Agent Skill that drives the gateway (research, X search, chat, image generation, model discovery) from a single Bun script, no MCP server needed. See [docs.ai.canarycoders.es/agent-skill](https://docs.ai.canarycoders.es/agent-skill) for install/update/uninstall steps. It's a plain repo folder, not part of the published npm package.
+
 ## Keeping types in sync
 
 The gateway API is the source of truth. Regenerate types from its OpenAPI spec and diff them against the hand-written ones:

package/dist/compat.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/compat.ts"],"names":[],"mappings":";;;AAgBA,SAAS,GAAG,OAAA,EAAyB;AACnC,EAAA,OAAO,CAAA,EAAG,OAAA,CAAQ,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA,GAAA,CAAA;AACvC;AAEO,SAAS,YAAA,CAAa,SAAiB,MAAA,EAA8B;AAC1E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC;AAEO,SAAS,eAAA,CAAgB,SAAiB,MAAA,EAA8B;AAC7E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC","file":"compat.cjs","sourcesContent":["/**\n * Helpers to point the official OpenAI / Anthropic SDKs at CanaryLLM's\n * drop-in compatible endpoints. Use the `provider/modelId` model-string format\n * (e.g. `\"openai/gpt-4o-mini\"`, `\"anthropic/claude-sonnet-4-5\"`).\n *\n * @example\n * import OpenAI from \"openai\";\n * import { openaiTarget } from \"@canarycoders/ai/compat\";\n * const oa = new OpenAI(openaiTarget(baseURL, apiKey));\n */\nexport interface CompatTarget {\n  baseURL: string;\n  apiKey: string;\n  defaultHeaders?: Record<string, string>;\n}\n\nfunction v1(baseURL: string): string {\n  return `${baseURL.replace(/\\/+$/, \"\")}/v1`;\n}\n\nexport function openaiTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n\nexport function anthropicTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n"]}
+{"version":3,"sources":["../src/compat.ts"],"names":[],"mappings":";;;AAgBA,SAAS,GAAG,OAAA,EAAyB;AACnC,EAAA,OAAO,CAAA,EAAG,OAAA,CAAQ,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA,GAAA,CAAA;AACvC;AAEO,SAAS,YAAA,CAAa,SAAiB,MAAA,EAA8B;AAC1E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC;AAEO,SAAS,eAAA,CAAgB,SAAiB,MAAA,EAA8B;AAC7E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC","file":"compat.cjs","sourcesContent":["/**\n * Helpers to point the official OpenAI / Anthropic SDKs at CanaryCoders AI's\n * drop-in compatible endpoints. Use the `provider/modelId` model-string format\n * (e.g. `\"openai/gpt-4o-mini\"`, `\"anthropic/claude-sonnet-4-5\"`).\n *\n * @example\n * import OpenAI from \"openai\";\n * import { openaiTarget } from \"@canarycoders/ai/compat\";\n * const oa = new OpenAI(openaiTarget(baseURL, apiKey));\n */\nexport interface CompatTarget {\n  baseURL: string;\n  apiKey: string;\n  defaultHeaders?: Record<string, string>;\n}\n\nfunction v1(baseURL: string): string {\n  return `${baseURL.replace(/\\/+$/, \"\")}/v1`;\n}\n\nexport function openaiTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n\nexport function anthropicTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n"]}

package/dist/compat.d.cts

@@ -1,5 +1,5 @@
 /**
- * Helpers to point the official OpenAI / Anthropic SDKs at CanaryLLM's
+ * Helpers to point the official OpenAI / Anthropic SDKs at CanaryCoders AI's
  * drop-in compatible endpoints. Use the `provider/modelId` model-string format
  * (e.g. `"openai/gpt-4o-mini"`, `"anthropic/claude-sonnet-4-5"`).
  *

package/dist/compat.d.ts

@@ -1,5 +1,5 @@
 /**
- * Helpers to point the official OpenAI / Anthropic SDKs at CanaryLLM's
+ * Helpers to point the official OpenAI / Anthropic SDKs at CanaryCoders AI's
  * drop-in compatible endpoints. Use the `provider/modelId` model-string format
  * (e.g. `"openai/gpt-4o-mini"`, `"anthropic/claude-sonnet-4-5"`).
  *

package/dist/compat.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/compat.ts"],"names":[],"mappings":";AAgBA,SAAS,GAAG,OAAA,EAAyB;AACnC,EAAA,OAAO,CAAA,EAAG,OAAA,CAAQ,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA,GAAA,CAAA;AACvC;AAEO,SAAS,YAAA,CAAa,SAAiB,MAAA,EAA8B;AAC1E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC;AAEO,SAAS,eAAA,CAAgB,SAAiB,MAAA,EAA8B;AAC7E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC","file":"compat.js","sourcesContent":["/**\n * Helpers to point the official OpenAI / Anthropic SDKs at CanaryLLM's\n * drop-in compatible endpoints. Use the `provider/modelId` model-string format\n * (e.g. `\"openai/gpt-4o-mini\"`, `\"anthropic/claude-sonnet-4-5\"`).\n *\n * @example\n * import OpenAI from \"openai\";\n * import { openaiTarget } from \"@canarycoders/ai/compat\";\n * const oa = new OpenAI(openaiTarget(baseURL, apiKey));\n */\nexport interface CompatTarget {\n  baseURL: string;\n  apiKey: string;\n  defaultHeaders?: Record<string, string>;\n}\n\nfunction v1(baseURL: string): string {\n  return `${baseURL.replace(/\\/+$/, \"\")}/v1`;\n}\n\nexport function openaiTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n\nexport function anthropicTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n"]}
+{"version":3,"sources":["../src/compat.ts"],"names":[],"mappings":";AAgBA,SAAS,GAAG,OAAA,EAAyB;AACnC,EAAA,OAAO,CAAA,EAAG,OAAA,CAAQ,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA,GAAA,CAAA;AACvC;AAEO,SAAS,YAAA,CAAa,SAAiB,MAAA,EAA8B;AAC1E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC;AAEO,SAAS,eAAA,CAAgB,SAAiB,MAAA,EAA8B;AAC7E,EAAA,OAAO,EAAE,OAAA,EAAS,EAAA,CAAG,OAAO,GAAG,MAAA,EAAO;AACxC","file":"compat.js","sourcesContent":["/**\n * Helpers to point the official OpenAI / Anthropic SDKs at CanaryCoders AI's\n * drop-in compatible endpoints. Use the `provider/modelId` model-string format\n * (e.g. `\"openai/gpt-4o-mini\"`, `\"anthropic/claude-sonnet-4-5\"`).\n *\n * @example\n * import OpenAI from \"openai\";\n * import { openaiTarget } from \"@canarycoders/ai/compat\";\n * const oa = new OpenAI(openaiTarget(baseURL, apiKey));\n */\nexport interface CompatTarget {\n  baseURL: string;\n  apiKey: string;\n  defaultHeaders?: Record<string, string>;\n}\n\nfunction v1(baseURL: string): string {\n  return `${baseURL.replace(/\\/+$/, \"\")}/v1`;\n}\n\nexport function openaiTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n\nexport function anthropicTarget(baseURL: string, apiKey: string): CompatTarget {\n  return { baseURL: v1(baseURL), apiKey };\n}\n"]}

package/dist/index.cjs

@@ -1594,7 +1594,7 @@ function readEnv(key) {
   if (typeof process !== "undefined" && process.env) return process.env[key];
   return void 0;
 }
-var CanaryLLM = class {
+var CanaryCodersAI = class {
   chat;
   queue;
   images;
@@ -1653,14 +1653,15 @@ var CanaryLLM = class {
 };
 
 // src/index.ts
-var src_default = CanaryLLM;
+var src_default = CanaryCodersAI;
 
 exports.APIConnectionError = APIConnectionError;
 exports.APIConnectionTimeoutError = APIConnectionTimeoutError;
 exports.APIError = APIError;
 exports.AuthenticationError = AuthenticationError;
 exports.BadRequestError = BadRequestError;
-exports.CanaryLLM = CanaryLLM;
+exports.CanaryCodersAI = CanaryCodersAI;
+exports.CanaryLLM = CanaryCodersAI;
 exports.ConflictError = ConflictError;
 exports.InternalServerError = InternalServerError;
 exports.Job = Job;