@ox-content/code-play 3.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ubugeeei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# @ox-content/code-play
+
+Opt-in Code Play plugin for Ox Content. It runs documentation samples on demand
+and exposes a headless API plus Headless / preset UI.
+
+Nothing runs until you install this package **and** enable specific languages.
+
+## Install
+
+```bash
+npm install @ox-content/code-play
+```
+
+```ts
+import { oxContent } from "@ox-content/vite-plugin";
+import { codePlay } from "@ox-content/code-play";
+
+export default {
+  plugins: [
+    oxContent({ highlight: true }),
+    codePlay({
+      languages: {
+        typescript: { execute: true, typecheck: true },
+        rust: true,
+      },
+      ui: "default",
+      viewers: { config: true, stdio: true, stderr: true, provenance: true, timing: true },
+    }),
+  ],
+};
+```
+
+## Authoring
+
+````md
+```ts play
+const n: number = 1;
+console.log(n);
+```
+
+```rust play typecheck
+fn main() {
+    println!("ok");
+}
+```
+````
+
+```html
+<CodePlay lang="python"> print("hello") </CodePlay>
+```
+
+## Headless API
+
+```ts
+import { createCodePlay } from "@ox-content/code-play";
+
+const play = createCodePlay({ languages: { typescript: true } });
+const session = play.createSession({ language: "ts", code: "const n: number = 1;" });
+const check = await session.typecheck();
+const run = await session.run();
+
+run.stdio;
+run.stdout;
+run.stderr;
+run.provenance;
+run.timing;
+```
+
+## Security
+
+`play` fences are trusted site content. Do not mark unreviewed or
+visitor-supplied snippets as `play`.
+
+- No sample is executed during Markdown transform or SSG.
+- JavaScript and TypeScript run in `node:vm` on Node, or in
+  `<iframe sandbox="allow-scripts">` in the browser (no `allow-same-origin`).
+  They are never run with page-origin `Function`.
+- Published widgets hide **Typecheck** unless `endpoints.typecheck` is set.
+  **Cancel** appears while a run is in flight.
+- Framework previews use the same iframe flags and load runtimes from esm.sh.
+- Rust and Go POST source to the official playgrounds (or your `endpoints`).
+  The Vite `/__ox-code-play/*` proxy is **dev-only**.
+- Other languages need a Piston-compatible `endpoint` you trust.
+- `sh` never spawns a local shell.
+
+## Example
+
+A runnable Vite site lives in [`examples/code-play`](../../examples/code-play):
+
+```bash
+corepack pnpm --filter ./examples/code-play dev
+```
+
+The docs site also dogfoods JavaScript and TypeScript widgets on
+[Code Play](../../docs/content/examples/code-play.md).
+
+See [Code Play](../../docs/content/packages/code-play.md) in the docs site.

package/dist/boot.d.mts

@@ -0,0 +1,16 @@
+//#region src/boot.d.ts
+interface BootDocument {
+  readyState: string;
+  addEventListener(type: string, listener: () => void, options?: {
+    once?: boolean;
+  }): void;
+}
+/**
+ * Mount every `[data-ox-code-play]` widget. The SSG client (`ox-code-play.js`)
+ * calls this on load; apps that import `@ox-content/code-play/client` call it
+ * themselves.
+ */
+declare function bootCodePlay(hydrate?: (root?: ParentNode) => void, doc?: BootDocument | undefined): void;
+//#endregion
+export { bootCodePlay as t };
+//# sourceMappingURL=boot.d.mts.map

package/dist/boot.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boot.d.mts","names":[],"sources":["../src/boot.ts"],"mappings":";UAEiB;EACf;EACA,iBAAiB,cAAc,sBAAsB;IAAY;;;;;;;;iBAQnD,aACd,WAAU,OAAO,qBACjB,MAAK"}

package/dist/boot.mjs

@@ -0,0 +1,20 @@
+import { t as hydrateCodePlay } from "./hydrate2.mjs";
+//#region src/boot.ts
+/**
+* Mount every `[data-ox-code-play]` widget. The SSG client (`ox-code-play.js`)
+* calls this on load; apps that import `@ox-content/code-play/client` call it
+* themselves.
+*/
+function bootCodePlay(hydrate = hydrateCodePlay, doc = typeof document === "undefined" ? void 0 : document) {
+	if (!doc) return;
+	const run = () => hydrate();
+	if (doc.readyState === "loading") {
+		doc.addEventListener("DOMContentLoaded", run, { once: true });
+		return;
+	}
+	run();
+}
+//#endregion
+export { bootCodePlay as t };
+
+//# sourceMappingURL=boot.mjs.map

package/dist/boot.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"boot.mjs","names":[],"sources":["../src/boot.ts"],"sourcesContent":["import { hydrateCodePlay } from \"./hydrate\";\n\nexport interface BootDocument {\n  readyState: string;\n  addEventListener(type: string, listener: () => void, options?: { once?: boolean }): void;\n}\n\n/**\n * Mount every `[data-ox-code-play]` widget. The SSG client (`ox-code-play.js`)\n * calls this on load; apps that import `@ox-content/code-play/client` call it\n * themselves.\n */\nexport function bootCodePlay(\n  hydrate: (root?: ParentNode) => void = hydrateCodePlay,\n  doc: BootDocument | undefined = typeof document === \"undefined\" ? undefined : document,\n): void {\n  if (!doc) {\n    return;\n  }\n  const run = () => hydrate();\n  if (doc.readyState === \"loading\") {\n    doc.addEventListener(\"DOMContentLoaded\", run, { once: true });\n    return;\n  }\n  run();\n}\n"],"mappings":";;;;;;;AAYA,SAAgB,aACd,UAAuC,iBACvC,MAAgC,OAAO,aAAa,cAAc,KAAA,IAAY,UACxE;CACN,IAAI,CAAC,KACH;CAEF,MAAM,YAAY,QAAQ;CAC1B,IAAI,IAAI,eAAe,WAAW;EAChC,IAAI,iBAAiB,oBAAoB,KAAK,EAAE,MAAM,KAAK,CAAC;EAC5D;CACF;CACA,IAAI;AACN"}

package/dist/browser.d.mts

@@ -0,0 +1,2 @@
+import { t as bootCodePlay } from "./boot.mjs";
+export { bootCodePlay };