Merge pull request #17 from speakeasy-api/speakeasy-sdk-regen-1737159897

walker-tx · web-flow · commit 659a1d2c0691 · 2025-01-17T18:26:21.000-06:00
chore: 🐝 Update SDK - Generate 2.1.1
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 521af75f-d011-41f9-a5ff-9f8033773118
 management:
-  docChecksum: a1a59c22189bc31196cf2fee084ce983
+  docChecksum: a16089f06495dd5f7de1f5121d72ec45
   docVersion: 0.4.0
   speakeasyVersion: 1.469.1
   generationVersion: 2.493.21
-  releaseVersion: 2.1.0
-  configChecksum: 6939a47fc02096e5c82ee23222b77765
+  releaseVersion: 2.1.1
+  configChecksum: 4b92b57c7f6bd5b3b6d7532b6b9cb49b
   repoURL: https://github.com/speakeasy-api/speakeasy-code-samples-ts.git
   installationURL: https://github.com/speakeasy-api/speakeasy-code-samples-ts
   published: true
@@ -90,7 +90,7 @@ generatedFiles:
   - src/models/operations/index.ts
   - src/react-query/_context.tsx
   - src/react-query/_types.ts
-  - src/react-query/codeSamplesGet.ts
+  - src/react-query/codeSamples.ts
   - src/react-query/index.ts
   - src/sdk/codesamples.ts
   - src/sdk/index.ts
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -16,7 +16,7 @@ generation:
     oAuth2ClientCredentialsEnabled: false
     oAuth2PasswordEnabled: false
 typescript:
-  version: 2.1.0
+  version: 2.1.1
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,20 +2,20 @@ speakeasyVersion: 1.469.1
 sources:
     speakeasy-OAS:
         sourceNamespace: speakeasy-oas
-        sourceRevisionDigest: sha256:02572601581947b6cb4826a9d7b16bc6e60944906419b0c14823b9a1ad612b58
-        sourceBlobDigest: sha256:6987ce0a3f23b17659c8331786fe6fc4dc710afdeabe78a0e0cf8a3312878544
+        sourceRevisionDigest: sha256:c69fca1c1936f3efccfca1a87dec5637194adb3aeda5ab642b734e9e9aa52689
+        sourceBlobDigest: sha256:63701f5ff26c0ac6e0ea6e314b9dc7bf7063bf75b72a16206b62050baf740623
         tags:
             - latest
-            - speakeasy-sdk-regen-1737157435
+            - speakeasy-sdk-regen-1737159897
             - 0.4.0
 targets:
     code_samples_typescript_sdk:
         source: speakeasy-OAS
         sourceNamespace: speakeasy-oas
-        sourceRevisionDigest: sha256:02572601581947b6cb4826a9d7b16bc6e60944906419b0c14823b9a1ad612b58
-        sourceBlobDigest: sha256:6987ce0a3f23b17659c8331786fe6fc4dc710afdeabe78a0e0cf8a3312878544
+        sourceRevisionDigest: sha256:c69fca1c1936f3efccfca1a87dec5637194adb3aeda5ab642b734e9e9aa52689
+        sourceBlobDigest: sha256:63701f5ff26c0ac6e0ea6e314b9dc7bf7063bf75b72a16206b62050baf740623
         codeSamplesNamespace: speakeasy-oas-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:ddc680c8bc7dfa699ac62fef898eb45b8316732907d43daa4f7873439ea3b96e
+        codeSamplesRevisionDigest: sha256:d21ba30bee6a57bc8e484768a7f4d9bd55420fe5439cc48ba23034941477356c
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
diff --git a/REACT_QUERY.md b/REACT_QUERY.md
@@ -51,10 +51,10 @@ from TanStack Query.
 [use-query]: https://tanstack.com/query/v5/docs/framework/react/reference/useQuery
 
 ```tsx
-import { useCodeSamplesGet } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
+import { useCodeSamples } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 
 export function Example() {
-  const { data, error, status } = useCodeSamplesGet({
+  const { data, error, status } = useCodeSamples({
     registryUrl: "https://spec.speakeasy.com/my-org/my-workspace/my-source",
     operationIds: [
       "getPets",
@@ -82,11 +82,11 @@ more options provided by the query hooks to control these behaviors.
 
 ```tsx
 import { useState } from "react";
-import { useCodeSamplesGet } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
+import { useCodeSamples } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 
 export function ExampleWithOptions() {
   const [enabled, setEnabled] = useState(true);
-  const { data, error, status } = useCodeSamplesGet(
+  const { data, error, status } = useCodeSamples(
     {
       registryUrl: "https://spec.speakeasy.com/my-org/my-workspace/my-source",
       operationIds: [
@@ -137,7 +137,7 @@ query hook there are two functions that help invalidate cached data:
 
 ```tsx
 import { useQueryClient } from "@tanstack/react-query";
-import { invalidateCodeSamplesGet, invalidateAllCodeSamplesGet } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
+import { invalidateCodeSamples, invalidateAllCodeSamples } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 // Replace this with a real mutation
 import { useExampleMutation } from "@speakeasyapi/code-samples/react-query/example.js";
 
@@ -155,9 +155,9 @@ export function Example() {
         mutate(formData, {
           onSuccess: () => {
             // Invalidate a single cache entry:
-            invalidateCodeSamplesGet(queryClient, /* ... arguments ... */);
+            invalidateCodeSamples(queryClient, /* ... arguments ... */);
             // OR, invalidate all cache entries for the query targets:
-            invalidateAllCodeSamplesGet(queryClient);
+            invalidateAllCodeSamples(queryClient);
           },
         });
       }}
@@ -185,7 +185,7 @@ import { ErrorBoundary } from "react-error-boundary";
 
 import { SpeakeasyCodeSamplesCore } from "@speakeasyapi/code-samples";
 import { SpeakeasyCodeSamplesProvider } from "@speakeasyapi/code-samples/react-query";
-import { useCodeSamplesGetSuspense } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
+import { useCodeSamplesSuspense } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 
 const queryClient = new QueryClient();
 const speakeasyCodeSamples = new SpeakeasyCodeSamplesCore({
@@ -221,7 +221,7 @@ export function App() {
 }
 
 function Example() {
-  const { data } = useCodeSamplesGetSuspense({
+  const { data } = useCodeSamplesSuspense({
     registryUrl: "https://spec.speakeasy.com/my-org/my-workspace/my-source",
     operationIds: [
       "getPets",
@@ -256,7 +256,7 @@ import {
   QueryClient,
 } from "@tanstack/react-query";
 import { SpeakeasyCodeSamplesCore } from "@speakeasyapi/code-samples";
-import { prefetchCodeSamplesGet } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
+import { prefetchCodeSamples } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 
 export default async function Page() {
   const queryClient = new QueryClient();
@@ -265,7 +265,7 @@ export default async function Page() {
     registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
   });
 
-  await prefetchCodeSamplesGet(queryClient, speakeasyCodeSamples, {
+  await prefetchCodeSamples(queryClient, speakeasyCodeSamples, {
     registryUrl: "https://spec.speakeasy.com/my-org/my-workspace/my-source",
     operationIds: [
       "getPets",
diff --git a/README.md b/README.md
@@ -285,7 +285,7 @@ To learn about this feature and how to get started, check
 
 <summary>Available React hooks</summary>
 
-- [`useCodeSamplesGet`](docs/sdks/codesamples/README.md#get) - Retrieve usage snippets
+- [`useCodeSamples`](docs/sdks/codesamples/README.md#get) - Retrieve usage snippets
 
 </details>
 <!-- End React hooks with TanStack Query [react-query] -->
diff --git a/RELEASES.md b/RELEASES.md
@@ -82,4 +82,14 @@ Based on:
 ### Generated
 - [typescript v2.1.0] .
 ### Releases
-- [NPM v2.1.0] https://www.npmjs.com/package/@speakeasyapi/code-samples/v/2.1.0 - .
+- [NPM v2.1.0] https://www.npmjs.com/package/@speakeasyapi/code-samples/v/2.1.0 - .
+
+## 2025-01-18 00:24:44
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.469.1 (2.493.21) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v2.1.1] .
+### Releases
+- [NPM v2.1.1] https://www.npmjs.com/package/@speakeasyapi/code-samples/v/2.1.1 - .
diff --git a/docs/sdks/codesamples/README.md b/docs/sdks/codesamples/README.md
@@ -107,18 +107,18 @@ associated utilities.
 ```tsx
 import {
   // Query hooks for fetching data.
-  useCodeSamplesGet,
-  useCodeSamplesGetSuspense,
+  useCodeSamples,
+  useCodeSamplesSuspense,
 
   // Utility for prefetching data during server-side rendering and in React
   // Server Components that will be immediately available to client components
   // using the hooks.
-  prefetchCodeSamplesGet,
+  prefetchCodeSamples,
   
   // Utilities to invalidate the query cache for this query in response to
   // mutations and other user actions.
-  invalidateCodeSamplesGet,
-  invalidateAllCodeSamplesGet,
+  invalidateCodeSamples,
+  invalidateAllCodeSamples,
 } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 ```
 
diff --git a/jsr.json b/jsr.json
@@ -2,7 +2,7 @@
 
 {
   "name": "@speakeasyapi/code-samples",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@speakeasyapi/code-samples",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "author": "Speakeasy",
   "type": "module",
   "main": "./esm/index.js",
diff --git a/src/lib/config.ts b/src/lib/config.ts
@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.4.0",
-  sdkVersion: "2.1.0",
+  sdkVersion: "2.1.1",
   genVersion: "2.493.21",
   userAgent:
-    "speakeasy-sdk/typescript 2.1.0 2.493.21 0.4.0 @speakeasyapi/code-samples",
+    "speakeasy-sdk/typescript 2.1.1 2.493.21 0.4.0 @speakeasyapi/code-samples",
 } as const;
diff --git a/src/react-query/codeSamples.ts b/src/react-query/codeSamples.ts
@@ -26,21 +26,21 @@ import {
   TupleToPrefixes,
 } from "./_types.js";
 
-export type CodeSamplesGetQueryData = components.UsageSnippets;
+export type CodeSamplesQueryData = components.UsageSnippets;
 
 /**
  * Retrieve usage snippets
  *
  * @remarks
  * Retrieve usage snippets from an OpenAPI document stored in the registry. Supports filtering by language and operation ID.
  */
-export function useCodeSamplesGet(
+export function useCodeSamples(
   request: operations.GetCodeSamplesRequest,
-  options?: QueryHookOptions<CodeSamplesGetQueryData>,
-): UseQueryResult<CodeSamplesGetQueryData, Error> {
+  options?: QueryHookOptions<CodeSamplesQueryData>,
+): UseQueryResult<CodeSamplesQueryData, Error> {
   const client = useSpeakeasyCodeSamplesContext();
   return useQuery({
-    ...buildCodeSamplesGetQuery(
+    ...buildCodeSamplesQuery(
       client,
       request,
       options,
@@ -55,13 +55,13 @@ export function useCodeSamplesGet(
  * @remarks
  * Retrieve usage snippets from an OpenAPI document stored in the registry. Supports filtering by language and operation ID.
  */
-export function useCodeSamplesGetSuspense(
+export function useCodeSamplesSuspense(
   request: operations.GetCodeSamplesRequest,
-  options?: SuspenseQueryHookOptions<CodeSamplesGetQueryData>,
-): UseSuspenseQueryResult<CodeSamplesGetQueryData, Error> {
+  options?: SuspenseQueryHookOptions<CodeSamplesQueryData>,
+): UseSuspenseQueryResult<CodeSamplesQueryData, Error> {
   const client = useSpeakeasyCodeSamplesContext();
   return useSuspenseQuery({
-    ...buildCodeSamplesGetQuery(
+    ...buildCodeSamplesQuery(
       client,
       request,
       options,
@@ -70,20 +70,20 @@ export function useCodeSamplesGetSuspense(
   });
 }
 
-export function prefetchCodeSamplesGet(
+export function prefetchCodeSamples(
   queryClient: QueryClient,
   client$: SpeakeasyCodeSamplesCore,
   request: operations.GetCodeSamplesRequest,
 ): Promise<void> {
   return queryClient.prefetchQuery({
-    ...buildCodeSamplesGetQuery(
+    ...buildCodeSamplesQuery(
       client$,
       request,
     ),
   });
 }
 
-export function setCodeSamplesGetData(
+export function setCodeSamplesData(
   client: QueryClient,
   queryKeyBase: [
     parameters: {
@@ -93,14 +93,14 @@ export function setCodeSamplesGetData(
       languages?: Array<string> | undefined;
     },
   ],
-  data: CodeSamplesGetQueryData,
-): CodeSamplesGetQueryData | undefined {
-  const key = queryKeyCodeSamplesGet(...queryKeyBase);
+  data: CodeSamplesQueryData,
+): CodeSamplesQueryData | undefined {
+  const key = queryKeyCodeSamples(...queryKeyBase);
 
-  return client.setQueryData<CodeSamplesGetQueryData>(key, data);
+  return client.setQueryData<CodeSamplesQueryData>(key, data);
 }
 
-export function invalidateCodeSamplesGet(
+export function invalidateCodeSamples(
   client: QueryClient,
   queryKeyBase: TupleToPrefixes<
     [parameters: {
@@ -123,7 +123,7 @@ export function invalidateCodeSamplesGet(
   });
 }
 
-export function invalidateAllCodeSamplesGet(
+export function invalidateAllCodeSamples(
   client: QueryClient,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
@@ -133,24 +133,24 @@ export function invalidateAllCodeSamplesGet(
   });
 }
 
-export function buildCodeSamplesGetQuery(
+export function buildCodeSamplesQuery(
   client$: SpeakeasyCodeSamplesCore,
   request: operations.GetCodeSamplesRequest,
   options?: RequestOptions,
 ): {
   queryKey: QueryKey;
-  queryFn: (context: QueryFunctionContext) => Promise<CodeSamplesGetQueryData>;
+  queryFn: (context: QueryFunctionContext) => Promise<CodeSamplesQueryData>;
 } {
   return {
-    queryKey: queryKeyCodeSamplesGet({
+    queryKey: queryKeyCodeSamples({
       registryUrl: request.registryUrl,
       operationIds: request.operationIds,
       methodPaths: request.methodPaths,
       languages: request.languages,
     }),
-    queryFn: async function codeSamplesGetQueryFn(
+    queryFn: async function codeSamplesQueryFn(
       ctx,
-    ): Promise<CodeSamplesGetQueryData> {
+    ): Promise<CodeSamplesQueryData> {
       const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
       const mergedOptions = {
         ...options,
@@ -166,7 +166,7 @@ export function buildCodeSamplesGetQuery(
   };
 }
 
-export function queryKeyCodeSamplesGet(
+export function queryKeyCodeSamples(
   parameters: {
     registryUrl?: string | undefined;
     operationIds?: Array<string> | undefined;
diff --git a/src/react-query/index.ts b/src/react-query/index.ts
@@ -8,4 +8,4 @@ export {
 } from "./_context.js";
 export * from "./_types.js";
 
-export * from "./codeSamplesGet.js";
+export * from "./codeSamples.js";

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`{`
`4`	`4`	`"name": "@speakeasyapi/code-samples",`
`5`		`- "version": "2.1.0",`
	`5`	`+ "version": "2.1.1",`
`6`	`6`	`"exports": {`
`7`	`7`	`".": "./src/index.ts",`
`8`	`8`	`"./models/errors": "./src/models/errors/index.ts",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@speakeasyapi/code-samples",`
`3`		`- "version": "2.1.0",`
	`3`	`+ "version": "2.1.1",`
`4`	`4`	`"author": "Speakeasy",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"main": "./esm/index.js",`