{"id":24472937,"url":"https://github.com/shutterstock/streaming-sitemaps","last_synced_at":"2026-05-20T03:36:16.912Z","repository":{"id":254204002,"uuid":"842239678","full_name":"shutterstock/streaming-sitemaps","owner":"shutterstock","description":"AWS CDK Construct that processes Kinesis messages and writes XML sitemaps to S3","archived":false,"fork":false,"pushed_at":"2024-12-04T17:41:49.000Z","size":4889,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-14T14:47:23.021Z","etag":null,"topics":["aws","aws-lambda","cli","dynamodb","kinesis","sitemaps","streaming","xml","xml-sitemap"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shutterstock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-14T00:30:31.000Z","updated_at":"2025-03-05T20:01:48.000Z","dependencies_parsed_at":"2024-08-22T02:33:25.245Z","dependency_job_id":"2a92e38a-64bc-44aa-bc2b-0097859928f0","html_url":"https://github.com/shutterstock/streaming-sitemaps","commit_stats":null,"previous_names":["shutterstock/streaming-sitemaps"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/shutterstock/streaming-sitemaps","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shutterstock%2Fstreaming-sitemaps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shutterstock%2Fstreaming-sitemaps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shutterstock%2Fstreaming-sitemaps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shutterstock%2Fstreaming-sitemaps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shutterstock","download_url":"https://codeload.github.com/shutterstock/streaming-sitemaps/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shutterstock%2Fstreaming-sitemaps/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33244783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-20T03:30:51.439Z","status":"ssl_error","status_checked_at":"2026-05-20T03:30:49.443Z","response_time":356,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-lambda","cli","dynamodb","kinesis","sitemaps","streaming","xml","xml-sitemap"],"created_at":"2025-01-21T08:14:10.214Z","updated_at":"2026-05-20T03:36:16.896Z","avatar_url":"https://github.com/shutterstock.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![CI Build](https://github.com/shutterstock/streaming-sitemaps/actions/workflows/ci.yml/badge.svg)\n\n# Streaming Sitemaps\n\nStreaming Sitemaps is a comprehensive solution for generating and managing XML sitemaps for large-scale websites. It provides a set of tools and AWS CDK constructs to create, convert, download, and manage sitemaps in an efficient and scalable manner.\n\n- [sitemaps-cdk](packages/sitemaps-cdk/API.md)\n  - AWS CDK construct to create set of AWS Lambda functions:\n    - Sitemap Writer - Generate XML sitemaps from a stream of sitemap JSON items delivered via an AWS Kinesis stream\n    - Index Writer - Maintain an XML sitemap index that is updated when new sitemap XML files are created\n    - Freshener - Rebuild the sitemap index and sitemap XML files on demand (this applies changes to older items that were saved to the DB but not written to the XML files immediately)\n  - Saves record of each item in a DynamoDB table, for deduplication, marking deletes, and to enable the Freshener to rebuild the sitemap index and sitemap XML files on demand\n- [sitemaps-cli](packages/sitemaps-cli/README.md)\n  - `convert` - Convert an XML or XML.gz sitemap to JSON, from a file or HTTP URL\n  - `create from-csv` - Create a sitemap index and sitemap files from CSV file\n  - `create from-dynamodb` - Create a sitemap index and/or sitemap files DynamoDB Table\n  - `download` - Download sitemap index and all sitemaps linked by a sitemap index; `s3://` URLs are supported if AWS credentials are available - For indices the `http[s]://hostname` of the individual sitemaps will be replaced with the `s3://[bucket_name]/` of the sitemap index\n  - `mirror-to-s3` - Mirror a sitemap index and all sitemaps linked by a sitemap index to an S3 bucket\n  - `upload-to-s3` - Upload local sitemap index and sitemaps to S3\n\n# Table of Contents \u003c!-- omit in toc --\u003e\n\n- [Streaming Sitemaps](#streaming-sitemaps)\n- [Deployment Patterns](#deployment-patterns)\n  - [Low Volume Deploys](#low-volume-deploys)\n  - [High Volume Deploys](#high-volume-deploys)\n- [Installation](#installation)\n  - [Sitemaps CLI](#sitemaps-cli)\n  - [CDK Constructs](#cdk-constructs)\n    - [Example CDK Stack](#example-cdk-stack)\n- [License](#license)\n\n# Deployment Patterns\n\n## Low Volume Deploys\n\n- Low Volume sitemaps typically have 5 million or less items in each sitemap\n- Low Volume sitemaps can be written by a single shared `sitemap-writer` and `index-writer` deployment\n- The point at which a deployment would need to switch to High Volume is determined both by the total number of items, but also by the frequency of update messages for older items\n  - Updates for items not in the current file will slow down throughput substantially\n  - These updates can be written into the DB directly by a pre-processing lambda, or by the `sitemap-writer` lambda\n  - Writing the updates in a preprocessor will keep the XML file write density high and will allow using the simpler low-volume deploy pattern for longer\n- The DynamoDB Table and S3 Bucket, and Freshener deployment are both shared by all sitemaps\n\n![Low Volume Deploys](docs/assets/StreamingSitemaps-LowVolume.png)\n\n## High Volume Deploys\n\n![High Volume Deploys](docs/assets/StreamingSitemaps-HighVolumeAdvanced.png)\n\n- High Volume sitemaps typically have 10 million or more items in each sitemap\n- High Volume sitemaps have a dedicated `sitemap-writer` and `index-writer` for the high volume types\n- High Volume deployments can share a DynamoDB Table, S3 Bucket, and Freshener deployment with Low Volume deployments and with other High Volume deployments\n- A type can be migrated from Low Volume to High Volume and vice versa as needed\n\n# Installation\n\n## Sitemaps CLI\n\n```sh\nnpm install -g @shutterstock/sitemaps-cli\n\nsitemaps-cli help\n```\n\n## CDK Constructs\n\n```sh\nnpm install --save-dev @shutterstock/sitemaps-cdk\n```\n\n### Example CDK Stack\n\n[Example CDK Stack](packages/cdk/lib/cdk-stack.ts)\n\n# License\n\nStreaming Sitemaps is licensed under the MIT License. For more information, see the [LICENSE.md](LICENSE.md) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshutterstock%2Fstreaming-sitemaps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshutterstock%2Fstreaming-sitemaps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshutterstock%2Fstreaming-sitemaps/lists"}