@storyblok/region-helper

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![Codecov][codecov-src]][codecov-href]

A helper package to handle Storyblok APIs in different regions.

Usage

Install package:

``sh


npm

npm install @storyblok/region-helper

yarn

yarn add @storyblok/region-helper

pnpm

pnpm install @storyblok/region-helper

bun

bun install @storyblok/region-helper
`

Import:

`js
// ESM
import {} from '@storyblok/region-helper'

// CommonJS
const {} = require('@storyblok/region-helper')
`

How it works

The region-helper package helps identify the region to which a given Space ID belongs, while abstracting away complexities such as handling different Space ID formats (e.g., range-based or bit-based).

- For values < 2^48: Uses range-based identification
- For values ≥ 2^48: Uses bit-based identification

$3

For space IDs up to 32 bits, regions are determined by number ranges:

- EU/CN: 0 to 1,000,000
- US: 1,000,000 to 2,000,000
- CA: 2,000,000 to 3,000,000
- AP: 3,000,000 to 4,000,000

`js
// Example with legacy space ID
const spaceId = 1_500_000
const region = getRegion(spaceId) // Returns 'us'
`

$3

For space IDs of 49-53 bits, the region is encoded in the first 5 bits:

- 0b00000 or 0b00001: EU (Europe)
- 0b00010: US (United States)
- 0b00011: CA (Canada)
- 0b00100: AP (Australia)
- 0b00110: CN (China)

`js
// Example with new space ID format
const spaceId = 282_994_740_194_929n
const region = getRegion(spaceId) // Returns 'eu'
``

This ensures backward compatibility while supporting the new extended space ID format.

License

Made with 💛

Published under MIT License.

[npm-version-src]: https://img.shields.io/npm/v/@storyblok/region-helper?style=flat&colorA=18181B&colorB=F0DB4F
[npm-version-href]: https://npmjs.com/package/@storyblok/region-helper
[npm-downloads-src]: https://img.shields.io/npm/dm/@storyblok/region-helper?style=flat&colorA=18181B&colorB=F0DB4F
[npm-downloads-href]: https://npmjs.com/package/@storyblok/region-helper
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/@storyblok/region-helper/main?style=flat&colorA=18181B&colorB=F0DB4F
[codecov-href]: https://codecov.io/gh/unjs/@storyblok/region-helper
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@storyblok/region-helper?style=flat&colorA=18181B&colorB=F0DB4F
[bundle-href]: https://bundlephobia.com/result?p=@storyblok/region-helper