@schemasentry/core 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @schemasentry/core
|
|
2
|
+
|
|
3
|
+
Type-safe schema builders and validation primitives for Schema Sentry.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @schemasentry/core
|
|
9
|
+
npm install @schemasentry/core
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Features
|
|
13
|
+
|
|
14
|
+
- **Type-safe builders** for 13+ schema types
|
|
15
|
+
- **Deterministic JSON-LD** output
|
|
16
|
+
- **Validation engine** with required/recommended field checks
|
|
17
|
+
- **Zero runtime dependencies**
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { Article, Organization, validateSchema } from "@schemasentry/core";
|
|
23
|
+
|
|
24
|
+
const article = Article({
|
|
25
|
+
headline: "My Article",
|
|
26
|
+
authorName: "John Doe",
|
|
27
|
+
datePublished: "2026-02-11",
|
|
28
|
+
url: "https://example.com/blog/my-article"
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
const result = validateSchema([article]);
|
|
32
|
+
if (!result.ok) {
|
|
33
|
+
console.log(result.issues);
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Supported Schema Types
|
|
38
|
+
|
|
39
|
+
- Organization, Person, Place, LocalBusiness
|
|
40
|
+
- WebSite, WebPage
|
|
41
|
+
- Article, BlogPosting
|
|
42
|
+
- Product
|
|
43
|
+
- FAQPage, HowTo
|
|
44
|
+
- BreadcrumbList
|
|
45
|
+
- Event, Review
|
|
46
|
+
- VideoObject, ImageObject
|
|
47
|
+
|
|
48
|
+
## Documentation
|
|
49
|
+
|
|
50
|
+
See [Schema Sentry Docs](https://github.com/arindamdawn/schema-sentry#readme)
|