https://github.com/takker99/scrapbox-userscript-std
UNOFFICIAL standard module for Scrapbox UserScript
https://github.com/takker99/scrapbox-userscript-std
cosense scrapbox
Last synced: about 2 months ago
JSON representation
UNOFFICIAL standard module for Scrapbox UserScript
- Host: GitHub
- URL: https://github.com/takker99/scrapbox-userscript-std
- Owner: takker99
- License: mit
- Created: 2021-09-30T02:40:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T04:06:08.000Z (2 months ago)
- Last Synced: 2025-04-11T05:18:12.809Z (2 months ago)
- Topics: cosense, scrapbox
- Language: TypeScript
- Homepage: https://scrapbox.io/takker/scrapbox-userscript-std
- Size: 714 KB
- Stars: 19
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scrapbox-userscript-std
[](https://jsr.io/@cosense/std)
[](https://github.com/takker99/scrapbox-userscript-std/actions?query=workflow%3Aci)
UNOFFICIAL standard module for Scrapbox UserScript
## Getting Started
This library serves as an unofficial standard library for developing Scrapbox
userscripts. It provides a comprehensive set of utilities for interacting with
Scrapbox's features, including REST API operations, browser interactions, and
common utilities.
### Installation
1. Bundler Configuration This library is distributed through JSR (JavaScript
Registry) and requires a bundler configuration. Follow these steps:
a. Configure your bundler to use JSR:
- For esbuild: Add JSR to your import map
- For other bundlers: Refer to your bundler's JSR integration documentation
b. Import the library:
```typescript
// Import commonly used functions
import { getPage } from "jsr:@cosense/std/rest";
import { parseAbsoluteLink } from "jsr:@cosense/std";
// Import specific modules (recommended)
import { getLinks } from "jsr:@cosense/std/rest";
import { press } from "jsr:@cosense/std/browser/dom";
import { getLines } from "jsr:@cosense/std/browser/dom";
```
2. Module Organization The library is organized into the following main modules:
- `rest/`: API operations for Scrapbox REST endpoints
- Page operations
- Project management
- User authentication
- `browser/`: Browser-side operations
- DOM manipulation
- WebSocket communication
- Event handling
- Core utilities:
- `title`: Title parsing and formatting
- `parseAbsoluteLink`: External link analysis
- Additional helper functions
## Examples
### Basic Usage
1. Retrieving Page Information
```typescript
// Get page content and metadata
import { getPage } from "jsr:@cosense/std/rest";
const result = await getPage("projectName", "pageName");
if (result.ok) {
const page = result.val;
console.log("Page title:", page.title);
console.log("Page content:", page.lines.map((line) => line.text));
console.log("Page descriptions:", page.descriptions.join("\n"));
}
```
2. DOM Operations
```typescript
// Interact with the current page's content
import { getLines, press } from "jsr:@cosense/std/browser/dom";
// Get all lines from the current page
const lines = getLines();
console.log(lines.map((line) => line.text));
// Simulate keyboard input
await press("Enter"); // Add a new line
await press("Tab"); // Indent the line
```
3. External Link Analysis
```typescript
// Parse external links (YouTube, Spotify, etc.)
import { parseAbsoluteLink } from "jsr:@cosense/std";
import type { LinkNode } from "@progfay/scrapbox-parser";
// Create a link node with absolute path type
const link = {
type: "link" as const,
pathType: "absolute" as const,
href: "https://www.youtube.com/watch?v=xxxxx",
content: "",
raw: "[https://www.youtube.com/watch?v=xxxxx]",
} satisfies LinkNode & { pathType: "absolute" };
// Parse and handle different link types
const parsed = parseAbsoluteLink(link);
if (parsed?.type === "youtube") {
// Handle YouTube links
console.log("YouTube video ID:", parsed.href.split("v=")[1]);
const params = new URLSearchParams(parsed.href.split("?")[1]);
const start = params.get("t");
if (start) {
console.log("Video timestamp:", start);
}
} else if (parsed?.type === "spotify") {
// Handle Spotify links
const match = parsed.href.match(/spotify\.com\/track\/([^?]+)/);
if (match) {
console.log("Spotify track ID:", match[1]);
}
}
```
### Important Notes
- This library requires a bundler for use in userscripts
- Full TypeScript support with type definitions included
- Comprehensive error handling with type-safe responses
- For more examples and use cases, see the
[Examples](https://github.com/takker99/scrapbox-userscript-std/tree/main/examples)
directory
### Additional Resources
- [JSR Package Page](https://jsr.io/@cosense/std)
- [API Documentation](https://jsr.io/@cosense/std/doc)
- [GitHub Repository](https://github.com/takker99/scrapbox-userscript-std)