@power-seo/sitemap 1.0.7 → 1.0.11

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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +14 -8
  3. package/package.json +35 -20
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 CCBD SEO Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @power-seo/sitemap
2
2
 
3
+ ![sitemap banner](../../image/sitemap/banner.svg)
4
+
5
+ XML sitemap generation for TypeScript — streaming output, automatic index splitting, image/video/news extensions, and URL validation — works in Next.js, Remix, Express, and edge runtimes with zero runtime dependencies.
6
+
3
7
  [![npm version](https://img.shields.io/npm/v/@power-seo/sitemap)](https://www.npmjs.com/package/@power-seo/sitemap)
4
8
  [![npm downloads](https://img.shields.io/npm/dm/@power-seo/sitemap)](https://www.npmjs.com/package/@power-seo/sitemap)
5
9
  [![Socket](https://socket.dev/api/badge/npm/package/@power-seo/sitemap)](https://socket.dev/npm/package/@power-seo/sitemap)
@@ -8,8 +12,6 @@
8
12
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)](https://www.typescriptlang.org/)
9
13
  [![tree-shakeable](https://img.shields.io/badge/tree--shakeable-yes-brightgreen)](https://bundlephobia.com/package/@power-seo/sitemap)
10
14
 
11
- XML sitemap generation for TypeScript — streaming output, automatic index splitting, image/video/news extensions, and URL validation — works in Next.js, Remix, Express, and edge runtimes with zero runtime dependencies.
12
-
13
15
  `@power-seo/sitemap` produces standards-compliant `<urlset>` and `<sitemapindex>` XML from typed URL arrays. Provide a hostname and URL list — get back a valid XML string ready to serve as `Content-Type: application/xml`. For large catalogs, stream chunks with constant memory usage or auto-split at the 50,000-URL spec limit with a generated index file. All five functions are independently importable and tree-shakeable.
14
16
 
15
17
  > **Zero runtime dependencies** — only `@power-seo/core` as a peer.
@@ -29,6 +31,8 @@ XML sitemap generation for TypeScript — streaming output, automatic index spli
29
31
  | Hostname handling | ❌ Hardcode absolute URLs everywhere | ✅ Pass `hostname` once; use relative `loc` paths |
30
32
  | Validation | ❌ Silent bad data reaches Google | ✅ `validateSitemapUrl()` returns errors + warnings |
31
33
 
34
+ ![Sitemap Generator Comparison](../../image/sitemap/comparison.svg)
35
+
32
36
  ---
33
37
 
34
38
  ## Features
@@ -49,6 +53,8 @@ XML sitemap generation for TypeScript — streaming output, automatic index spli
49
53
  - **Zero runtime dependencies** — pure TypeScript, no external XML libraries
50
54
  - **Tree-shakeable** — import only the functions you use
51
55
 
56
+ ![Google Search Console Sitemap UI](../../image/sitemap/gsc-ui.svg)
57
+
52
58
  ---
53
59
 
54
60
  ## Comparison
@@ -68,6 +74,8 @@ XML sitemap generation for TypeScript — streaming output, automatic index spli
68
74
  | Tree-shakeable | ✅ | ❌ | ❌ | ❌ |
69
75
  | Next.js `app/sitemap.ts` adapter | ✅ | ✅ | ❌ | ❌ |
70
76
 
77
+ ![Sitemap Extensions Accuracy](../../image/sitemap/extensions-accuracy.svg)
78
+
71
79
  ---
72
80
 
73
81
  ## Installation
@@ -84,10 +92,6 @@ yarn add @power-seo/sitemap
84
92
  pnpm add @power-seo/sitemap
85
93
  ```
86
94
 
87
- ```bash
88
- bun add @power-seo/sitemap
89
- ```
90
-
91
95
  ---
92
96
 
93
97
  ## Quick Start
@@ -112,6 +116,8 @@ const xml = generateSitemap({
112
116
 
113
117
  `hostname` is required — it is prepended to any `loc` value that is a relative path. Absolute `loc` values (starting with `http`) are used as-is.
114
118
 
119
+ ![Sitemap Streaming Benefit](../../image/sitemap/streaming-benefit.svg)
120
+
115
121
  ---
116
122
 
117
123
  ## Usage
@@ -481,7 +487,7 @@ All 17 packages are independently installable — use only what you need.
481
487
  | [`@power-seo/core`](https://www.npmjs.com/package/@power-seo/core) | `npm i @power-seo/core` | Framework-agnostic utilities, types, validators, and constants |
482
488
  | [`@power-seo/react`](https://www.npmjs.com/package/@power-seo/react) | `npm i @power-seo/react` | React SEO components — meta, Open Graph, Twitter Card, breadcrumbs |
483
489
  | [`@power-seo/meta`](https://www.npmjs.com/package/@power-seo/meta) | `npm i @power-seo/meta` | SSR meta helpers for Next.js App Router, Remix v2, and generic SSR |
484
- | [`@power-seo/schema`](https://www.npmjs.com/package/@power-seo/schema) | `npm i @power-seo/schema` | Type-safe JSON-LD structured data — 20 builders + 18 React components |
490
+ | [`@power-seo/schema`](https://www.npmjs.com/package/@power-seo/schema) | `npm i @power-seo/schema` | Type-safe JSON-LD structured data — 23 builders + 21 React components |
485
491
  | [`@power-seo/content-analysis`](https://www.npmjs.com/package/@power-seo/content-analysis) | `npm i @power-seo/content-analysis` | Yoast-style SEO content scoring engine with React components |
486
492
  | [`@power-seo/readability`](https://www.npmjs.com/package/@power-seo/readability) | `npm i @power-seo/readability` | Readability scoring — Flesch-Kincaid, Gunning Fog, Coleman-Liau, ARI |
487
493
  | [`@power-seo/preview`](https://www.npmjs.com/package/@power-seo/preview) | `npm i @power-seo/preview` | SERP, Open Graph, and Twitter/X Card preview generators |
@@ -500,7 +506,7 @@ All 17 packages are independently installable — use only what you need.
500
506
 
501
507
  ## Keywords
502
508
 
503
- xml sitemap generator typescript · sitemap npm package · nextjs sitemap · streaming sitemap · sitemap index generator · image sitemap extension · video sitemap extension · news sitemap google · split sitemap 50000 urls · sitemap validation · edge runtime sitemap · remix sitemap · programmatic seo sitemap · sitemap generator zero dependencies · typescript xml sitemap · sitemap url priority · crawl budget optimization · sitemap changelog · google sitemap spec · seo sitemap typescript
509
+ seo · sitemap · xml · xml sitemap · sitemap generator · sitemap index · nextjs sitemap · streaming sitemap · image sitemap · video sitemap · news sitemap · split sitemap · sitemap validation · edge runtime · remix · crawl budget · google sitemap · url priority · typescript · zero dependency
504
510
 
505
511
  ---
506
512
 
package/package.json CHANGED
@@ -1,7 +1,29 @@
1
1
  {
2
2
  "name": "@power-seo/sitemap",
3
- "version": "1.0.7",
3
+ "version": "1.0.11",
4
4
  "description": "XML sitemap generation, streaming, and validation with image, video, and news support",
5
+ "keywords": [
6
+ "seo",
7
+ "sitemap",
8
+ "xml",
9
+ "xml-sitemap",
10
+ "sitemap-generator",
11
+ "sitemap-index",
12
+ "nextjs-sitemap",
13
+ "streaming-sitemap",
14
+ "image-sitemap",
15
+ "video-sitemap",
16
+ "news-sitemap",
17
+ "split-sitemap",
18
+ "sitemap-validation",
19
+ "edge-runtime",
20
+ "remix",
21
+ "crawl-budget",
22
+ "google-sitemap",
23
+ "url-priority",
24
+ "typescript",
25
+ "zero-dependency"
26
+ ],
5
27
  "license": "MIT",
6
28
  "type": "module",
7
29
  "exports": {
@@ -17,18 +39,8 @@
17
39
  "files": [
18
40
  "dist"
19
41
  ],
20
- "scripts": {
21
- "build": "tsup",
22
- "dev": "tsup --watch",
23
- "test": "vitest run",
24
- "test:watch": "vitest",
25
- "typecheck": "tsc --noEmit",
26
- "lint": "eslint src/",
27
- "lint:fix": "eslint src/ --fix",
28
- "clean": "rimraf dist"
29
- },
30
42
  "dependencies": {
31
- "@power-seo/core": "workspace:*"
43
+ "@power-seo/core": "1.0.11"
32
44
  },
33
45
  "devDependencies": {
34
46
  "rimraf": "^6.1.3",
@@ -36,13 +48,6 @@
36
48
  "typescript": "^5.7.0",
37
49
  "vitest": "^2.1.0"
38
50
  },
39
- "keywords": [
40
- "seo",
41
- "sitemap",
42
- "xml",
43
- "sitemap-index",
44
- "typescript"
45
- ],
46
51
  "sideEffects": false,
47
52
  "author": "CyberCraft Bangladesh <info@ccbd.dev>",
48
53
  "repository": {
@@ -60,5 +65,15 @@
60
65
  "funding": {
61
66
  "type": "github",
62
67
  "url": "https://github.com/sponsors/cybercraftbd"
68
+ },
69
+ "scripts": {
70
+ "build": "tsup",
71
+ "dev": "tsup --watch",
72
+ "test": "vitest run",
73
+ "test:watch": "vitest",
74
+ "typecheck": "tsc --noEmit",
75
+ "lint": "eslint src/",
76
+ "lint:fix": "eslint src/ --fix",
77
+ "clean": "rimraf dist"
63
78
  }
64
- }
79
+ }