next-geo-block 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,70 @@
+import { NextRequest, NextResponse } from 'next/server';
+export { NextRequest } from 'next/server';
+
+declare function timezoneToCountry(tz: string): string | undefined;
+
+type CountryCode = string;
+interface GeoBlockRule {
+    /**
+     * Path patterns this rule applies to. Supports:
+     *   - exact paths:        '/checkout'
+     *   - trailing wildcard:  '/admin/*'        (any depth under /admin)
+     *   - single-segment '*': '/u/* /settings'  (matches /u/<anything>/settings)
+     *   - regex (anchored):   /^\/api\/v\d+\/private/
+     */
+    paths: Array<string | RegExp>;
+    /** ISO 3166-1 alpha-2 codes to block on these paths. Case-insensitive. */
+    block: CountryCode[];
+}
+type OnBlock = (ctx: {
+    request: NextRequest;
+    country: CountryCode;
+    pathname: string;
+    matchedRule: GeoBlockRule;
+    /** How the country was resolved. */
+    source: 'header' | 'timezone';
+}) => Response | NextResponse | Promise<Response | NextResponse>;
+/**
+ * Use the client's local timezone as a country fallback when no country
+ * header is present. The client must have already populated a cookie or
+ * header — middleware/proxy cannot read `Intl.DateTimeFormat()` directly.
+ * See README for the client snippet.
+ *
+ * Pass `true` for defaults (cookie `client_tz`, header `x-client-timezone`).
+ */
+type TimezoneFallback = boolean | {
+    cookie?: string;
+    header?: string;
+    /**
+     * Custom IANA → ISO 3166-1 alpha-2 resolver. Overrides the bundled map.
+     */
+    resolve?: (tz: string) => CountryCode | undefined;
+};
+interface GeoBlockOptions {
+    rules: GeoBlockRule[];
+    /**
+     * Path to rewrite blocked requests to. Defaults to '/blocked'.
+     * Set to `null` to skip the default rewrite and use `onBlock` (or a 451).
+     */
+    blockedPath?: string | null;
+    /**
+     * When the country still can't be resolved (no header, no timezone),
+     * let the request through (true) or treat it as blocked (false). Default: true.
+     */
+    failOpen?: boolean;
+    /**
+     * Custom response when a request is blocked. Overrides `blockedPath`.
+     */
+    onBlock?: OnBlock;
+    /**
+     * Additional headers to read country from, tried first.
+     * Built-ins: x-vercel-ip-country, cf-ipcountry, x-country-code.
+     */
+    countryHeaders?: string[];
+    /** See {@link TimezoneFallback}. Default: false. */
+    fallbackTimezone?: TimezoneFallback;
+}
+declare function getCountry(request: NextRequest, extraHeaders?: string[]): CountryCode | undefined;
+declare function createGeoBlock(options: GeoBlockOptions): (request: NextRequest) => Promise<NextResponse | Response>;
+
+export { type CountryCode, type GeoBlockOptions, type GeoBlockRule, type OnBlock, type TimezoneFallback, createGeoBlock, getCountry, timezoneToCountry };

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+import { NextRequest, NextResponse } from 'next/server';
+export { NextRequest } from 'next/server';
+
+declare function timezoneToCountry(tz: string): string | undefined;
+
+type CountryCode = string;
+interface GeoBlockRule {
+    /**
+     * Path patterns this rule applies to. Supports:
+     *   - exact paths:        '/checkout'
+     *   - trailing wildcard:  '/admin/*'        (any depth under /admin)
+     *   - single-segment '*': '/u/* /settings'  (matches /u/<anything>/settings)
+     *   - regex (anchored):   /^\/api\/v\d+\/private/
+     */
+    paths: Array<string | RegExp>;
+    /** ISO 3166-1 alpha-2 codes to block on these paths. Case-insensitive. */
+    block: CountryCode[];
+}
+type OnBlock = (ctx: {
+    request: NextRequest;
+    country: CountryCode;
+    pathname: string;
+    matchedRule: GeoBlockRule;
+    /** How the country was resolved. */
+    source: 'header' | 'timezone';
+}) => Response | NextResponse | Promise<Response | NextResponse>;
+/**
+ * Use the client's local timezone as a country fallback when no country
+ * header is present. The client must have already populated a cookie or
+ * header — middleware/proxy cannot read `Intl.DateTimeFormat()` directly.
+ * See README for the client snippet.
+ *
+ * Pass `true` for defaults (cookie `client_tz`, header `x-client-timezone`).
+ */
+type TimezoneFallback = boolean | {
+    cookie?: string;
+    header?: string;
+    /**
+     * Custom IANA → ISO 3166-1 alpha-2 resolver. Overrides the bundled map.
+     */
+    resolve?: (tz: string) => CountryCode | undefined;
+};
+interface GeoBlockOptions {
+    rules: GeoBlockRule[];
+    /**
+     * Path to rewrite blocked requests to. Defaults to '/blocked'.
+     * Set to `null` to skip the default rewrite and use `onBlock` (or a 451).
+     */
+    blockedPath?: string | null;
+    /**
+     * When the country still can't be resolved (no header, no timezone),
+     * let the request through (true) or treat it as blocked (false). Default: true.
+     */
+    failOpen?: boolean;
+    /**
+     * Custom response when a request is blocked. Overrides `blockedPath`.
+     */
+    onBlock?: OnBlock;
+    /**
+     * Additional headers to read country from, tried first.
+     * Built-ins: x-vercel-ip-country, cf-ipcountry, x-country-code.
+     */
+    countryHeaders?: string[];
+    /** See {@link TimezoneFallback}. Default: false. */
+    fallbackTimezone?: TimezoneFallback;
+}
+declare function getCountry(request: NextRequest, extraHeaders?: string[]): CountryCode | undefined;
+declare function createGeoBlock(options: GeoBlockOptions): (request: NextRequest) => Promise<NextResponse | Response>;
+
+export { type CountryCode, type GeoBlockOptions, type GeoBlockRule, type OnBlock, type TimezoneFallback, createGeoBlock, getCountry, timezoneToCountry };