Merge branch 'main' of github.com:speakeasy-api/speakeasy-code-samples-ts

Author: walker-tx

.gitignore

@@ -17,3 +17,4 @@
 /.tshy-*
 /__tests__
 /.speakeasy/reports
+/react.*

.speakeasy/gen.lock

@@ -3,17 +3,17 @@ id: 521af75f-d011-41f9-a5ff-9f8033773118
 management:
   docChecksum: a0841885f1d2df6bf65c33550d1be776
   docVersion: 0.4.0
-  speakeasyVersion: 1.468.0
-  generationVersion: 2.492.3
-  releaseVersion: 2.0.11
-  configChecksum: 6131813611c165f99630ca021de715dc
+  speakeasyVersion: 1.468.5
+  generationVersion: 2.493.11
+  releaseVersion: 2.0.13
+  configChecksum: bb0274b648f58e16f339f488f406677b
   repoURL: https://github.com/speakeasy-api/speakeasy-code-samples-ts.git
   installationURL: https://github.com/speakeasy-api/speakeasy-code-samples-ts
   published: true
 features:
   typescript:
     additionalDependencies: 0.1.0
-    core: 3.18.12
+    core: 3.18.14
     defaultEnabledRetries: 0.1.0
     devContainers: 2.90.0
     envVarSecurityUsage: 0.1.2

.speakeasy/gen.yaml

@@ -16,15 +16,17 @@ generation:
     oAuth2ClientCredentialsEnabled: false
     oAuth2PasswordEnabled: false
 typescript:
-  version: 2.0.11
+  version: 2.0.13
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
-    peerDependencies: {}
+    peerDependencies:
+      highlight.js: ^11.11.1
   additionalPackageJSON: {}
   author: Speakeasy
   clientServerStatusCodesAsErrors: true
   defaultErrorName: APIError
+  enableCustomCodeRegions: false
   enableReactQuery: true
   enumFormat: enum
   flattenGlobalSecurity: true
@@ -40,7 +42,7 @@ typescript:
   inputModelSuffix: input
   maxMethodParams: 1
   methodArguments: require-security-and-request
-  moduleFormat: commonjs
+  moduleFormat: esm
   outputModelSuffix: output
   packageName: '@speakeasyapi/code-samples'
   responseFormat: flat

.speakeasy/workflow.lock

@@ -1,8 +1,8 @@
-speakeasyVersion: 1.468.0
+speakeasyVersion: 1.468.5
 sources:
     speakeasy-OAS:
         sourceNamespace: speakeasy-oas
-        sourceRevisionDigest: sha256:771ed09dacf285d6f18e27f01e0492f45f9248110476d381d0a6768cb4021320
+        sourceRevisionDigest: sha256:eccb5c0b494c102a3985fedd96b152ad956b8be90681e6f5f21b5756463f66ab
         sourceBlobDigest: sha256:6d9de4a70686f4366747b9dbf16917300a43dea8857ad6583f35ef3531bffbdb
         tags:
             - latest
@@ -11,10 +11,8 @@ targets:
     code_samples_typescript_sdk:
         source: speakeasy-OAS
         sourceNamespace: speakeasy-oas
-        sourceRevisionDigest: sha256:771ed09dacf285d6f18e27f01e0492f45f9248110476d381d0a6768cb4021320
+        sourceRevisionDigest: sha256:eccb5c0b494c102a3985fedd96b152ad956b8be90681e6f5f21b5756463f66ab
         sourceBlobDigest: sha256:6d9de4a70686f4366747b9dbf16917300a43dea8857ad6583f35ef3531bffbdb
-        codeSamplesNamespace: speakeasy-oas-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:12997450a71bf46eaf590c8da28f9c7599305c352f80814d77a29071c25a1f03
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

README.md

@@ -1,6 +1,6 @@
 # @speakeasyapi/code-samples
 
-Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@speakeasyapi/code-samples* API.
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage _@speakeasyapi/code-samples_ API.
 
 <div align="left">
     <a href="https://www.speakeasy.com/?utm_source=@speakeasyapi/code-samples&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -9,8 +9,8 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
     </a>
 </div>
 
-
 <br /><br />
+
 > [!IMPORTANT]
 > This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/speakeasy-self/speakeasy-self). Delete this section before > publishing to a package manager.
 
@@ -84,6 +84,10 @@ yarn add @tanstack/react-query react react-dom
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
 ```
+
+> [!NOTE]
+> This package is published as an ES Module (ESM) only. For applications using
+> CommonJS, use `await import("@speakeasyapi/code-samples")` to import and use this package.
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -119,6 +123,49 @@ run();
 ```
 <!-- End SDK Example Usage [usage] -->
 
+### React Component
+
+This library includes a React component that fetches and highlights code
+snippets using `highlight.js`. Along with displaying the snippet, it shows a loading state during
+fetching and provides a fallback view if an error occurs.
+
+```tsx
+import { SpeakeasyCodeSamplesCore } from "@speakeasyapi/code-samples/core";
+import {
+  CodeSample,
+  SpeakeasyCodeSamplesProvider,
+} from "@speakeasyapi/code-samples/react";
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+
+const queryClient = new QueryClient();
+
+const speakeasyCodeSamples = new SpeakeasyCodeSamplesCore({
+  apiKey: "<YOUR_API_KEY_HERE>",
+  registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
+});
+
+// Retries are handled by the underlying SDK.
+queryClient.setQueryDefaults(["@speakeasyapi/code-samples"], { retry: false });
+
+queryClient.setMutationDefaults(["@speakeasyapi/code-samples"], {
+  retry: false,
+});
+
+function App() {
+  return (
+    <QueryClientProvider client={queryClient}>
+      <SpeakeasyCodeSamplesProvider client={speakeasyCodeSamples}>
+        <CodeSample operationId="getPetById" language="typescript" />
+      </SpeakeasyCodeSamplesProvider>
+    </QueryClientProvider>
+  );
+}
+```
+
+> [!NOTE]
+> To apply styles to the highlighted code, import a `highlight.js` theme CSS
+> file into your project using methods like a `<link>` tag.
+
 <!-- Start Authentication [security] -->
 ## Authentication
 
@@ -537,7 +584,7 @@ looking for the latest version.
 
 ## Contributions
 
-While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
-We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
 
 ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@speakeasyapi/code-samples&utm_campaign=typescript)

jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@speakeasyapi/code-samples",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package-lock.json

@@ -1,8 +1,47 @@
 {
   "name": "@speakeasyapi/code-samples",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "author": "Speakeasy",
-  "main": "./index.js",
+  "type": "module",
+  "main": "./esm/index.js",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./esm/index.d.ts",
+      "default": "./esm/index.js"
+    },
+    "./package.json": "./package.json",
+    "./types": {
+      "source": "./src/types/index.ts",
+      "types": "./esm/types/index.d.ts",
+      "default": "./esm/types/index.js"
+    },
+    "./models/errors": {
+      "source": "./src/models/errors/index.ts",
+      "types": "./esm/models/errors/index.d.ts",
+      "default": "./esm/models/errors/index.js"
+    },
+    "./models/components": {
+      "source": "./src/models/components/index.ts",
+      "types": "./esm/models/components/index.d.ts",
+      "default": "./esm/models/components/index.js"
+    },
+    "./models/operations": {
+      "source": "./src/models/operations/index.ts",
+      "types": "./esm/models/operations/index.d.ts",
+      "default": "./esm/models/operations/index.js"
+    },
+    "./*.js": {
+      "source": "./src/*.ts",
+      "types": "./esm/*.d.ts",
+      "default": "./esm/*.js"
+    },
+    "./*": {
+      "source": "./src/*.ts",
+      "types": "./esm/*.d.ts",
+      "default": "./esm/*.js"
+    }
+  },
   "sideEffects": false,
   "repository": {
     "type": "git",
@@ -15,6 +54,7 @@
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5",
+    "highlight.js": "^11.11.1",
     "react": "^18 || ^19",
     "react-dom": "^18 || ^19",
     "zod": ">= 3"

package.json

@@ -5,6 +5,7 @@
 import { SpeakeasyCodeSamplesCore } from "../core.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
@@ -65,9 +66,9 @@ export async function codeSamplesGet(
     "registry_url": payload.registry_url ?? client._options.registryUrl,
   });
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     Accept: "application/json",
-  });
+  }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
   const securityInput = secConfig == null ? {} : { apiKey: secConfig };

src/funcs/codeSamplesGet.ts

@@ -0,0 +1,14 @@
+export function clsx(...args: Array<string | undefined>) {
+  let i = 0,
+    tmp,
+    str = "";
+  const len = args.length;
+  for (; i < len; i++) {
+    if ((tmp = args[i])) {
+      if (typeof tmp === "string") {
+        str += (str && " ") + tmp;
+      }
+    }
+  }
+  return str;
+}