setup npm

Author: mattapperson

.devcontainer/setup.sh

@@ -10,7 +10,7 @@ mkdir samples
 npm install --ignore-scripts
 npm install -g ts-node --ignore-scripts
 npm link
-npm link openrouter
+npm link @openrouter/sdk
 TS_CONFIG_CONTENT=$(cat <<EOL
 {
   "compilerOptions": {

.github/workflows/sdk_generation.yaml

@@ -30,4 +30,5 @@ jobs:
       set_version: ${{ github.event.inputs.set_version }}
     secrets:
       github_access_token: ${{ secrets.GITHUB_TOKEN }}
+      npm_token: ${{ secrets.NPM_TOKEN }}
       speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

.github/workflows/sdk_publish.yaml

@@ -0,0 +1,23 @@
+name: Publish
+permissions:
+  checks: write
+  contents: write
+  pull-requests: write
+  statuses: write
+  id-token: write
+"on":
+  push:
+    branches:
+      - main
+    paths:
+      - .speakeasy/gen.lock
+  workflow_dispatch: {}
+jobs:
+  publish:
+    uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15
+    with:
+      target: openrouter
+    secrets:
+      github_access_token: ${{ secrets.GITHUB_TOKEN }}
+      npm_token: ${{ secrets.NPM_TOKEN }}
+      speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

.speakeasy/gen.lock

@@ -6,7 +6,8 @@ management:
   speakeasyVersion: 1.622.2
   generationVersion: 2.711.4
   releaseVersion: 0.0.0-beta.0
-  configChecksum: 1f820324330044d6a48b831014bfba57
+  configChecksum: ad5304d3b5e52b274ee22f4454e04f08
+  published: true
 features:
   typescript:
     acceptHeaders: 2.81.2

.speakeasy/gen.yaml

@@ -61,7 +61,7 @@ typescript:
   modelPropertyCasing: camel
   moduleFormat: dual
   outputModelSuffix: output
-  packageName: openrouter
+  packageName: '@openrouter/sdk'
   responseFormat: flat
   sseFlatResponse: false
   templateVersion: v2

.speakeasy/workflow.lock

@@ -14,7 +14,7 @@ targets:
         sourceRevisionDigest: sha256:33ae487def452ee14ec8255ee26d55b3ad26e168d2294efe2992bb32259feb2e
         sourceBlobDigest: sha256:1f36153e04b279d7f1d297bbb9ce7cf750dd8790aa012d7c3291a16ee59c39a6
         codeSamplesNamespace: open-router-chat-completions-api-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:13206bdd3eff8a3c19782d61891937b1f9d2c481a99e7cd489df4c3850b7383f
+        codeSamplesRevisionDigest: sha256:b321b255d705f018afadbd16e374a90e6e653be398e55f3221ac0f6cd811d4a6
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -29,6 +29,9 @@ workflow:
         openrouter:
             target: typescript
             source: OpenRouter API
+            publish:
+                npm:
+                    token: $npm_token
             codeSamples:
                 registry:
                     location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api-typescript-code-samples

.speakeasy/workflow.yaml

@@ -11,6 +11,9 @@ targets:
     openrouter:
         target: typescript
         source: OpenRouter API
+        publish:
+            npm:
+                token: $npm_token
         codeSamples:
             registry:
                 location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api-typescript-code-samples

FUNCTIONS.md

@@ -19,8 +19,8 @@ specific category of applications.
 ## Example
 
 ```typescript
-import { OpenRouterCore } from "openrouter/core.js";
-import { getCredits } from "openrouter/funcs/getCredits.js";
+import { OpenRouterCore } from "@openrouter/sdk/core.js";
+import { getCredits } from "@openrouter/sdk/funcs/getCredits.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.

REACT_QUERY.md

@@ -18,8 +18,8 @@ your React app at the root or layout component. For example:
 
 ```tsx
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-import { OpenRouterCore } from "openrouter";
-import { OpenRouterProvider } from "openrouter/react-query";
+import { OpenRouterCore } from "@openrouter/sdk";
+import { OpenRouterProvider } from "@openrouter/sdk/react-query";
 
 const queryClient = new QueryClient();
 const openRouter = new OpenRouterCore({
@@ -29,8 +29,8 @@ const openRouter = new OpenRouterCore({
 });
 
 // Retries are handled by the underlying SDK.
-queryClient.setQueryDefaults(["openrouter"], { retry: false });
-queryClient.setMutationDefaults(["openrouter"], { retry: false });
+queryClient.setQueryDefaults(["@openrouter/sdk"], { retry: false });
+queryClient.setMutationDefaults(["@openrouter/sdk"], { retry: false });
 
 export function App() {
   return (
@@ -52,7 +52,7 @@ from TanStack Query.
 [use-query]: https://tanstack.com/query/v5/docs/framework/react/reference/useQuery
 
 ```tsx
-import { useGetCredits } from "openrouter/react-query/getCredits.js";
+import { useGetCredits } from "@openrouter/sdk/react-query/getCredits.js";
 
 export function Example() {
   const { data, error, status } = useGetCredits();
@@ -68,7 +68,7 @@ more options provided by the query hooks to control these behaviors.
 
 ```tsx
 import { useState } from "react";
-import { useGetCredits } from "openrouter/react-query/getCredits.js";
+import { useGetCredits } from "@openrouter/sdk/react-query/getCredits.js";
 
 export function ExampleWithOptions() {
   const [enabled, setEnabled] = useState(true);
@@ -109,7 +109,7 @@ Query.
 [use-mutation]: https://tanstack.com/query/v5/docs/framework/react/reference/useMutation
 
 ```tsx
-import { usePostCreditsCoinbaseMutation } from "openrouter/react-query/postCreditsCoinbase.js";
+import { usePostCreditsCoinbaseMutation } from "@openrouter/sdk/react-query/postCreditsCoinbase.js";
 
 export function Example() {
   const { mutate, status } = usePostCreditsCoinbaseMutation();
@@ -137,7 +137,7 @@ Since the underlying SDK handles request timeouts and retries, there are a few
 more options provided by the mutation hooks to control these behaviors.
 
 ```tsx
-import { usePostCreditsCoinbaseMutation } from "openrouter/react-query/postCreditsCoinbase.js";
+import { usePostCreditsCoinbaseMutation } from "@openrouter/sdk/react-query/postCreditsCoinbase.js";
 
 export function ExampleWithOptions() {
   const { mutate, status } = usePostCreditsCoinbaseMutation({
@@ -172,9 +172,9 @@ query hook there are two functions that help invalidate cached data:
 
 ```tsx
 import { useQueryClient } from "@tanstack/react-query";
-import { invalidateGetCredits, invalidateAllGetCredits } from "openrouter/react-query/getCredits.js";
+import { invalidateGetCredits, invalidateAllGetCredits } from "@openrouter/sdk/react-query/getCredits.js";
 // Replace this with a real mutation
-import { useExampleMutation } from "openrouter/react-query/example.js";
+import { useExampleMutation } from "@openrouter/sdk/react-query/example.js";
 
 export function Example() {
   const { queryClient } = useQueryClient();
@@ -218,9 +218,9 @@ hooks that integrate neatly with React Suspense.
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
 import { ErrorBoundary } from "react-error-boundary";
 
-import { OpenRouterCore } from "openrouter";
-import { OpenRouterProvider } from "openrouter/react-query";
-import { useGetCreditsSuspense } from "openrouter/react-query/getCredits.js";
+import { OpenRouterCore } from "@openrouter/sdk";
+import { OpenRouterProvider } from "@openrouter/sdk/react-query";
+import { useGetCreditsSuspense } from "@openrouter/sdk/react-query/getCredits.js";
 
 const queryClient = new QueryClient();
 const openRouter = new OpenRouterCore({
@@ -276,8 +276,8 @@ import {
   HydrationBoundary,
   QueryClient,
 } from "@tanstack/react-query";
-import { OpenRouterCore } from "openrouter";
-import { prefetchGetCredits } from "openrouter/react-query/getCredits.js";
+import { OpenRouterCore } from "@openrouter/sdk";
+import { prefetchGetCredits } from "@openrouter/sdk/react-query/getCredits.js";
 
 export default async function Page() {
   const queryClient = new QueryClient();

README.md

@@ -45,40 +45,36 @@ For more information about the API: [OpenRouter Documentation](https://openroute
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
 
 ```bash
-npm add <UNSET>
+npm add @openrouter/sdk
 # Install optional peer dependencies if you plan to use React hooks
 npm add @tanstack/react-query react react-dom
 ```
 
 ### PNPM
 
 ```bash
-pnpm add <UNSET>
+pnpm add @openrouter/sdk
 # Install optional peer dependencies if you plan to use React hooks
 pnpm add @tanstack/react-query react react-dom
 ```
 
 ### Bun
 
 ```bash
-bun add <UNSET>
+bun add @openrouter/sdk
 # Install optional peer dependencies if you plan to use React hooks
 bun add @tanstack/react-query react react-dom
 ```
 
 ### Yarn
 
 ```bash
-yarn add <UNSET>
+yarn add @openrouter/sdk
 # Install optional peer dependencies if you plan to use React hooks
 yarn add @tanstack/react-query react react-dom
 ```
@@ -99,7 +95,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 ### Example
 
 ```typescript
-import { OpenRouter } from "openrouter";
+import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
   security: {
@@ -132,7 +128,7 @@ This SDK supports the following security schemes globally:
 
 You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
 ```typescript
-import { OpenRouter } from "openrouter";
+import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
   security: {
@@ -302,7 +298,7 @@ terminate when the server no longer has any events to send and closes the
 underlying connection.
 
 ```typescript
-import { OpenRouter } from "openrouter";
+import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
   security: {
@@ -331,7 +327,7 @@ Some of the endpoints in this SDK support retries.  If you use the SDK without a
 
 To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
 ```typescript
-import { OpenRouter } from "openrouter";
+import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
   security: {
@@ -362,7 +358,7 @@ run();
 
 If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
 ```typescript
-import { OpenRouter } from "openrouter";
+import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
   retryConfig: {
@@ -407,8 +403,8 @@ run();
 
 ### Example
 ```typescript
-import { OpenRouter } from "openrouter";
-import * as errors from "openrouter/models/errors";
+import { OpenRouter } from "@openrouter/sdk";
+import * as errors from "@openrouter/sdk/models/errors";
 
 const openRouter = new OpenRouter({
   security: {
@@ -482,7 +478,7 @@ You can pass a logger that matches `console`'s interface as an SDK option.
 > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
 
 ```typescript
-import { OpenRouter } from "openrouter";
+import { OpenRouter } from "@openrouter/sdk";
 
 const sdk = new OpenRouter({ debugLogger: console });
 ```