@stainless-api/playgrounds 0.0.1-beta.2 → 0.0.1-beta.20

package/CHANGELOG.md

@@ -1,5 +1,156 @@
 # @stainless-api/playgrounds
 
+## 0.0.1-beta.20
+
+### Patch Changes
+
+- Updated dependencies [3411ffe]
+- Updated dependencies [7439be7]
+  - @stainless-api/docs-ui@0.1.0-beta.64
+  - @stainless/sdk-json@0.1.0-beta.4
+
+## 0.0.1-beta.19
+
+### Patch Changes
+
+- Updated dependencies [274cefc]
+  - @stainless-api/docs-ui@0.1.0-beta.63
+
+## 0.0.1-beta.18
+
+### Patch Changes
+
+- Updated dependencies [6ef241e]
+- Updated dependencies [d3a85b5]
+- Updated dependencies [d3a85b5]
+- Updated dependencies [2dcb5fb]
+  - @stainless-api/docs-ui@0.1.0-beta.62
+
+## 0.0.1-beta.17
+
+### Patch Changes
+
+- Updated dependencies [3037a19]
+  - @stainless-api/ui-primitives@0.1.0-beta.45
+  - @stainless-api/docs-ui@0.1.0-beta.61
+
+## 0.0.1-beta.16
+
+### Patch Changes
+
+- Updated dependencies [b4b51f7]
+  - @stainless-api/ui-primitives@0.1.0-beta.44
+  - @stainless-api/docs-ui@0.1.0-beta.60
+
+## 0.0.1-beta.15
+
+### Patch Changes
+
+- Updated dependencies [32b2c88]
+- Updated dependencies [6fd3625]
+- Updated dependencies [98166fd]
+  - @stainless-api/docs-ui@0.1.0-beta.59
+  - @stainless/sdk-json@0.1.0-beta.3
+
+## 0.0.1-beta.14
+
+### Patch Changes
+
+- Updated dependencies [1b04416]
+- Updated dependencies [905cdac]
+  - @stainless-api/docs-ui@0.1.0-beta.58
+
+## 0.0.1-beta.13
+
+### Patch Changes
+
+- Updated dependencies [6eb6d38]
+- Updated dependencies [7bc8f4e]
+- Updated dependencies [2f6b86d]
+  - @stainless-api/docs-ui@0.1.0-beta.57
+  - @stainless-api/ui-primitives@0.1.0-beta.43
+
+## 0.0.1-beta.12
+
+### Patch Changes
+
+- Updated dependencies [2d82e2e]
+  - @stainless-api/ui-primitives@0.1.0-beta.42
+  - @stainless-api/docs-ui@0.1.0-beta.56
+
+## 0.0.1-beta.11
+
+### Patch Changes
+
+- Updated dependencies [750c348]
+  - @stainless-api/ui-primitives@0.1.0-beta.41
+  - @stainless-api/docs-ui@0.1.0-beta.55
+
+## 0.0.1-beta.10
+
+### Patch Changes
+
+- Updated dependencies [67aa6b5]
+  - @stainless-api/docs-ui@0.1.0-beta.54
+
+## 0.0.1-beta.9
+
+### Patch Changes
+
+- Updated dependencies [e9567b0]
+  - @stainless-api/ui-primitives@0.1.0-beta.40
+  - @stainless-api/docs-ui@0.1.0-beta.53
+
+## 0.0.1-beta.8
+
+### Patch Changes
+
+- Updated dependencies [5d6e5fa]
+  - @stainless-api/ui-primitives@0.1.0-beta.39
+  - @stainless-api/docs-ui@0.1.0-beta.52
+
+## 0.0.1-beta.7
+
+### Patch Changes
+
+- Updated dependencies [2a79bae]
+  - @stainless-api/ui-primitives@0.1.0-beta.38
+  - @stainless-api/docs-ui@0.1.0-beta.51
+
+## 0.0.1-beta.6
+
+### Patch Changes
+
+- Updated dependencies [2d00f0d]
+  - @stainless-api/docs-ui@0.1.0-beta.50
+  - @stainless-api/ui-primitives@0.1.0-beta.37
+
+## 0.0.1-beta.5
+
+### Patch Changes
+
+- Updated dependencies [af090c3]
+- Updated dependencies [4cf4aa5]
+- Updated dependencies [8886c7c]
+  - @stainless-api/docs-ui@0.1.0-beta.49
+  - @stainless-api/ui-primitives@0.1.0-beta.36
+
+## 0.0.1-beta.4
+
+### Patch Changes
+
+- Updated dependencies [ada37ee]
+  - @stainless-api/docs-ui@0.1.0-beta.48
+
+## 0.0.1-beta.3
+
+### Patch Changes
+
+- Updated dependencies [d75a72f]
+- Updated dependencies [2464347]
+  - @stainless/sdk-json@0.1.0-beta.2
+  - @stainless-api/docs-ui@0.1.0-beta.47
+
 ## 0.0.1-beta.2
 
 ### Patch Changes

package/eslint.config.js

@@ -1,2 +1,2 @@
-import { config } from '@stainless/eslint-config/astro';
+import { config } from '@stainless/eslint-config/base';
 export default config;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@stainless-api/playgrounds",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.20",
   "type": "module",
   "publishConfig": {
     "access": "public"
   },
   "exports": {
     ".": "./src/index.ts",
+    "./build": "./src/build.ts",
     "./package.json": "./package.json"
   },
   "peerDependencies": {
@@ -29,7 +30,7 @@
     "@codemirror/view": "^6.38.2",
     "@preact/signals-core": "^1.12.1",
     "@replit/codemirror-vscode-keymap": "^6.0.2",
-    "@shikijs/types": "^3.15.0",
+    "@shikijs/types": "^3.21.0",
     "@stainless-api/codemirror-ts": "^3.0.1",
     "@typescript/vfs": "^1.6.1",
     "clsx": "^2.1.1",
@@ -37,33 +38,34 @@
     "dompurify": "^3.2.6",
     "js-tokens": "^9.0.1",
     "lines-and-columns": "^2.0.4",
-    "lucide-react": "^0.555.0",
-    "marked": "^16.0.0",
-    "shiki": "^3.19.0",
+    "lucide-react": "^0.562.0",
+    "marked": "^17.0.1",
+    "shiki": "^3.21.0",
     "source-map": "^0.7.6",
     "type-fest": "^5.3.0",
     "unenv": "^1.10.0",
     "vite-plugin-prebundle-workers": "^0.2.0",
     "vscode-languageserver-protocol": "^3.17.5",
-    "@stainless-api/docs-ui": "0.1.0-beta.46",
-    "@stainless-api/ui-primitives": "0.1.0-beta.35",
-    "@stainless/sdk-json": "^0.1.0-beta.1"
+    "@stainless-api/docs-ui": "0.1.0-beta.64",
+    "@stainless-api/ui-primitives": "0.1.0-beta.45",
+    "@stainless/sdk-json": "^0.1.0-beta.4"
   },
   "devDependencies": {
-    "@types/node": "24.10.1",
+    "@types/is-callable": "^1.1.2",
+    "@types/node": "24.10.9",
     "@types/react": "19.2.7",
     "@types/react-dom": "^19.2.3",
     "is-callable": "^1.2.7",
     "pyodide": "^0.28.2",
-    "react": "^19.2.1",
-    "react-dom": "^19.2.1",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
     "typescript": "5.9.3",
     "vite": "^6.4.1",
-    "@stainless/eslint-config": "0.1.0-beta.0"
+    "@stainless/eslint-config": "0.1.0-beta.1"
   },
   "scripts": {
     "lint": "eslint .",
-    "check:types": "tsc --noEmit",
+    "check:types": "tsc --noEmit && tsc -p ./tsconfig.test.json",
     "test": "node --test"
   }
 }

package/src/build-py-types.ts

@@ -2,7 +2,7 @@ import { promises as fs, globSync } from 'fs';
 import path, { dirname, resolve } from 'path';
 import os from 'os';
 import { glob, readdir, realpath, writeFile } from 'fs/promises';
-import type data from 'virtual:stl-playground/python.json';
+import { type pyTypes } from './config';
 import { execCommand } from './util';
 import { createRequire } from 'module';
 
@@ -143,7 +143,7 @@ export async function buildPythonTypes(typesPath: string, installPackage: string
         JSON.stringify({
           files: files,
           wheel: wheelPath,
-        } satisfies typeof data),
+        } satisfies typeof pyTypes),
       ),
     ]);
   } finally {

package/src/codemirror/comlink.ts

@@ -1,7 +1,4 @@
-/* eslint-disable @typescript-eslint/no-unsafe-function-type */
-/* eslint-disable @typescript-eslint/no-empty-object-type */
-/* eslint-disable @typescript-eslint/no-misused-new */
-/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unsafe-function-type, @typescript-eslint/no-empty-object-type, @typescript-eslint/no-misused-new, @typescript-eslint/no-explicit-any */
 /**
  * @license
  * Copyright 2019 Google LLC

package/src/codemirror/fix-lsp-markdown.ts

@@ -2,8 +2,7 @@ import { LSPPlugin } from '@codemirror/lsp-client';
 import { Marked } from 'marked';
 import { sanitizeHTML } from './sanitize-html';
 import { highlighter } from './shiki';
-// @ts-expect-error TODO: make independent from stl-starlight
-import { HIGHLIGHT_THEMES } from 'virtual:stl-starlight-virtual-module';
+import { HIGHLIGHT_THEMES } from '../config';
 type MarkupKind = 'plaintext' | 'markdown';
 interface MarkupContent {
   /**

package/src/codemirror/python.ts

@@ -5,17 +5,15 @@ import type { Language } from './react';
 import { proxy, releaseProxy, type Remote, wrap } from './comlink';
 import type { API } from './python/pyodide';
 import type { Logger } from '../Logs';
-import wheelUrl from 'virtual:stl-playground/python/wheel.whl?url';
-import pyTypes from 'virtual:stl-playground/python.json';
-
-if (!pyTypes) {
-  throw new Error('Python playgrounds failed to build.');
-}
+import { pyTypes, wheelUrl } from '../config.js';
 
 const pyrightWorkerURL = 'https://cdn.jsdelivr.net/npm/browser-basedpyright@1.33.0/dist/pyright.worker.js';
 
-const wheelBlobPromise = fetch(wheelUrl).then((e) => e.blob());
 export async function createPyright(signal: AbortSignal, doc: string): Promise<Language> {
+  const wheelBlobPromise = fetch(wheelUrl).then((e) => e.blob());
+  if (!pyTypes) {
+    throw new Error('Python playgrounds failed to build.');
+  }
   const { SandboxWorker } = await import('../sandbox-worker/index.js');
   let pyodideWorker: Worker;
   let pyodideAPI: Remote<API>;

package/src/codemirror/react.tsx

@@ -13,17 +13,11 @@ import type { Completion } from '@codemirror/autocomplete';
 import { Button, Dropdown } from '@stainless-api/ui-primitives';
 import { PlaygroundIcon } from '../icon.tsx';
 import { initDropdown } from '@stainless-api/ui-primitives/scripts';
-// @ts-expect-error TODO: make independent from stl-starlight
-import { navigate } from 'astro:transitions/client';
-// @ts-expect-error TODO: make independent from stl-starlight
-import { updateSelectedLanguage } from 'virtual:stl-playground/unstable-update-language';
-// @ts-expect-error TODO: make independent from stl-starlight
-import { BASE_PATH } from 'virtual:stl-starlight-virtual-module';
-import authData from 'virtual:stl-playground/auth.json';
 import { Panel } from '../Panel.tsx';
 import { PlaygroundPanelWrapper } from '../PlaygroundPanelWrapper.tsx';
 import { MaskedInput } from '@stainless-api/docs-ui/components/MaskedInput';
 import useStorage from '../use-storage.ts';
+import { authData } from '../config.ts';
 
 let codeMirrorPromise: Promise<typeof import('./deps.ts')>;
 function loadCodeMirror(): Promise<typeof import('./deps.ts')> {
@@ -347,12 +341,14 @@ export const Editor = ({
   container,
   onLoad,
   unmount,
+  onLanguageSelect,
 }: {
   lang: PlaygroundLanguage;
   doc: string;
   container: HTMLElement;
   onLoad: (onShow: () => void) => void;
   unmount: () => void;
+  onLanguageSelect: ((value: string) => void) | undefined;
 }) => {
   const titleNode = useMemo(
     () => container.querySelector('.stldocs-snippet-request-title-method')!.cloneNode(true),
@@ -366,12 +362,7 @@ export const Editor = ({
     prefixIds(clone, idPrefix);
     initDropdown({
       root: clone.querySelector('#' + idPrefix + 'stldocs-snippet-select')!,
-      onSelect: (value) => {
-        const originalLanguage = document.getElementById(idPrefix + 'stldocs-snippet-select')?.dataset
-          .currentValue;
-        const path: string = updateSelectedLanguage(BASE_PATH, originalLanguage, value);
-        navigate(path.replace(/(\?.+)?($|#)/, (_, str, end) => (str ? str + '&play' : '?play') + end));
-      },
+      onSelect: onLanguageSelect,
     });
     return clone;
   }, [container]);

package/src/codemirror/shiki.ts

@@ -9,8 +9,7 @@ import {
 } from '@codemirror/view';
 import { SupportedLanguageSyntaxes } from '@stainless-api/docs-ui/routing';
 import { createHighlighter } from 'shiki';
-// @ts-expect-error TODO: make independent from stl-starlight
-import { HIGHLIGHT_THEMES } from 'virtual:stl-starlight-virtual-module';
+import { HIGHLIGHT_THEMES } from '../config';
 export const highlighter = await createHighlighter({
   themes: [HIGHLIGHT_THEMES?.dark ?? 'github-dark', HIGHLIGHT_THEMES?.light ?? 'github-light'],
   langs: SupportedLanguageSyntaxes,

package/src/codemirror/typescript/worker.ts

@@ -8,7 +8,7 @@ import estree from 'prettier/plugins/estree';
 import { SourceMapConsumer } from 'source-map';
 import { LinesAndColumns } from 'lines-and-columns';
 
-type TypescriptTypes = NonNullable<typeof import('virtual:stl-playground/typescript.json').default>;
+type TypescriptTypes = NonNullable<typeof import('../../config').tsTypes>;
 
 // @ts-expect-error this is kinda awful but it makes ts autocomplete work without source patching
 Object.prototype.keepLegacyLimitationForAutocompletionSymbols = false;

package/src/codemirror/typescript.tsx

@@ -10,15 +10,10 @@ import type { Language } from './react';
 import { proxy, type Remote } from './comlink';
 import type { Logger } from '../Logs';
 import type { RunnerAPI } from './typescript/runner';
-import typescriptTypes from 'virtual:stl-playground/typescript.json';
-import authData from 'virtual:stl-playground/auth.json';
 import { docToHTML } from './fix-lsp-markdown';
 import { API } from './typescript/worker';
 import { EditorView } from '@codemirror/view';
-
-if (!typescriptTypes) {
-  throw new Error('TypeScript playgrounds failed to build.');
-}
+import { authData, tsTypes } from '../config.js';
 
 function displayPartsToString(displayParts: SymbolDisplayPart[] | undefined): string {
   if (displayParts) {
@@ -53,7 +48,7 @@ const useMeta = /iPad|iPhone|iPod|Mac/.test(navigator.userAgent);
 type GoToOptions = {
   gotoHandler?: (currentPath: string, hoverData: HoverInfo, view: EditorView) => true | undefined;
 };
-export function tsGoto(opts: GoToOptions = {}) {
+function tsGoto(opts: GoToOptions = {}) {
   return EditorView.domEventHandlers({
     mousedown: (event, view) => {
       const config = view.state.facet(tsFacet);
@@ -87,12 +82,15 @@ export function tsGoto(opts: GoToOptions = {}) {
 }
 
 export async function createTypescript(signal: AbortSignal, doc: string): Promise<Language> {
+  if (!tsTypes) {
+    throw new Error('TypeScript playgrounds failed to build.');
+  }
   const { SandboxWorker } = await import('../sandbox-worker/index.js');
   const innerWorker: Worker = new SandboxWorker(tsWorkerURL, { name: 'typescript' });
   signal.addEventListener('abort', () => innerWorker.terminate());
   const worker = Comlink.wrap<API>(innerWorker);
   await worker.stlInit({
-    typescriptTypes: typescriptTypes!,
+    typescriptTypes: tsTypes,
     suggestedEnv: authData!
       .flatMap((e) => e.opts)
       .map((e) => e.read_env)

package/src/config.ts

@@ -0,0 +1,43 @@
+// having global state is icky but it's the fastest path rn
+export let wheelUrl: string;
+export let pyTypes: { files: Record<string, string>; wheel: string } | null;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export let HIGHLIGHT_THEMES: any;
+export let tsTypes: {
+  links: [string, string][];
+  files: [string, string][];
+} | null;
+export let authData:
+  | ({
+      type: 'http_bearer' | 'query' | 'header' | 'oauth2' | 'http_basic' | 'http_digest';
+      description?: string;
+      name: string;
+      title: string;
+      header: string | undefined;
+      example: string | undefined;
+    } & {
+      opts: {
+        name: string;
+        type: 'string' | 'number' | 'boolean' | 'null' | 'integer';
+        nullable: boolean;
+        description?: string | undefined;
+        example?: unknown;
+        default?: unknown;
+        read_env?: string | undefined;
+        auth?:
+          | {
+              security_scheme: string;
+              role?: 'value' | 'password' | 'username' | 'client_id' | 'client_secret' | undefined;
+            }
+          | undefined;
+      }[];
+    })[]
+  | null;
+export type Config = Omit<typeof import('./config'), 'configure'>;
+export function configure(options: Config): void {
+  HIGHLIGHT_THEMES = options.HIGHLIGHT_THEMES;
+  authData = options.authData;
+  pyTypes = options.pyTypes;
+  tsTypes = options.tsTypes;
+  wheelUrl = options.wheelUrl;
+}

package/src/create.tsx

@@ -4,15 +4,20 @@ import { signal } from '@preact/signals-core';
 import { Editor } from './codemirror/react';
 import { LogsContext } from './logs-context';
 import './playground.css';
+import { Config, configure } from './config';
 
 export type PlaygroundLanguage = 'python' | 'typescript' | 'http';
 
-export function createPlayground(props: {
-  lang: PlaygroundLanguage;
-  doc: string;
-  /** div.stl-snippet-request-container */
-  container: HTMLElement;
-}): () => Promise<void> {
+export function createPlayground(
+  props: {
+    lang: PlaygroundLanguage;
+    doc: string;
+    /** div.stl-snippet-request-container */
+    container: HTMLElement;
+    onLanguageSelect: (value: string) => void;
+  } & Config,
+): () => Promise<void> {
+  configure(props);
   const ready = new Promise<{ element: HTMLDivElement; onShow(): void }>((resolve) => {
     const element = document.createElement('div');
     const root = createRoot(element);

package/src/virtual-module.d.ts

@@ -1,45 +1,4 @@
-type CreatePlayground = typeof import('./create').createPlayground;
 type ComlinkRemote<T> = import('./codemirror/comlink').Remote<T>;
-declare module 'virtual:stl-playground/typescript.json' {
-  const data: {
-    links: [string, string][];
-    files: [string, string][];
-  } | null;
-  export { data as default };
-}
-declare module 'virtual:stl-playground/python.json' {
-  const data: { files: Record<string, string>; wheel: string } | null;
-  export { data as default };
-}
-declare module 'virtual:stl-playground/auth.json' {
-  const data:
-    | ({
-        type: 'http_bearer' | 'query' | 'header' | 'oauth2' | 'http_basic' | 'http_digest';
-        description?: string;
-        name: string;
-        title: string;
-        header: string | undefined;
-        example: string | undefined;
-      } & {
-        opts: {
-          name: string;
-          type: 'string' | 'number' | 'boolean' | 'null' | 'integer';
-          nullable: boolean;
-          description?: string | undefined;
-          example?: unknown;
-          default?: unknown;
-          read_env?: string | undefined;
-          auth?:
-            | {
-                security_scheme: string;
-                role?: 'value' | 'password' | 'username' | 'client_id' | 'client_secret' | undefined;
-              }
-            | undefined;
-        }[];
-      })[]
-    | null;
-  export { data as default };
-}
 declare module 'comlink' {
   type Remote<T> = ComlinkRemote<T>;
 }

package/test/stl-starlight-virtual-module-assertions.ts

@@ -0,0 +1,26 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/// <reference types="../../stl-starlight/virtual-module" />
+type IsAny<T> = boolean extends (T extends never ? true : false) ? true : false;
+type Equal<T, U> =
+  IsAny<T> extends true ? IsAny<U> : [T] extends [U] ? ([U] extends [T] ? true : false) : false;
+type Assert<T extends true> = T;
+
+type _1 = Assert<Equal<typeof import('virtual:stl-playground/create'), typeof import('../src/create')>>;
+type _2 = Assert<
+  Equal<
+    (typeof import('virtual:stl-playground/create'))['createPlayground'],
+    (typeof import('../src/create'))['createPlayground']
+  >
+>;
+type _3 = Assert<
+  Equal<
+    Parameters<(typeof import('virtual:stl-playground/create'))['createPlayground']>,
+    Parameters<(typeof import('../src/create'))['createPlayground']>
+  >
+>;
+type _4 = Assert<
+  Equal<
+    ReturnType<(typeof import('virtual:stl-playground/create'))['createPlayground']>,
+    ReturnType<(typeof import('../src/create'))['createPlayground']>
+  >
+>;

package/test/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/tsconfig.json

@@ -1,11 +1,12 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
+    "types": ["node"],
     "noEmit": false,
     "declaration": true,
     "declarationDir": "dist",
     "outDir": "dist",
     "jsx": "react-jsx"
   },
-  "include": ["src"]
+  "include": ["src", "*.config.*"]
 }

package/tsconfig.test.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["test"],
+  "compilerOptions": {
+    "types": ["node"],
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.test.tsbuildinfo"
+  }
+}