psgc-mcp
Version:
Philippine Standard Geographic Code MCP Server - provides hierarchical geographic data for the Philippines
539 lines • 19.9 kB
TypeScript
/**
* Zod validation schemas for PSGC API parameters
* Based on the official PSGC API OpenAPI specification
*/
import { z } from 'zod';
export declare const EntityTypeSchema: z.ZodEnum<["island-group", "region", "province", "district", "city", "municipality", "city-municipality", "sub-municipality", "barangay"]>;
export declare const IslandGroupCodeSchema: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
export declare const RegionCodeSchema: z.ZodString;
export declare const ProvinceCodeSchema: z.ZodString;
export declare const DistrictCodeSchema: z.ZodString;
export declare const CityCodeSchema: z.ZodString;
export declare const MunicipalityCodeSchema: z.ZodString;
export declare const SubMunicipalityCodeSchema: z.ZodString;
export declare const CityMunicipalityCodeSchema: z.ZodString;
export declare const BarangayCodeSchema: z.ZodString;
export declare const IslandGroupParamsSchema: z.ZodObject<{
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
}>;
export declare const RegionParamsSchema: z.ZodObject<{
regionCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
regionCode: string;
}, {
regionCode: string;
}>;
export declare const ProvinceParamsSchema: z.ZodObject<{
provinceCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
provinceCode: string;
}, {
provinceCode: string;
}>;
export declare const DistrictParamsSchema: z.ZodObject<{
districtCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
districtCode: string;
}, {
districtCode: string;
}>;
export declare const CityParamsSchema: z.ZodObject<{
cityCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
cityCode: string;
}, {
cityCode: string;
}>;
export declare const MunicipalityParamsSchema: z.ZodObject<{
municipalityCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
municipalityCode: string;
}, {
municipalityCode: string;
}>;
export declare const SubMunicipalityParamsSchema: z.ZodObject<{
subMunicipalityCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
subMunicipalityCode: string;
}, {
subMunicipalityCode: string;
}>;
export declare const CityMunicipalityParamsSchema: z.ZodObject<{
cityOrMunicipalityCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
cityOrMunicipalityCode: string;
}, {
cityOrMunicipalityCode: string;
}>;
export declare const BarangayParamsSchema: z.ZodObject<{
barangayCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
barangayCode: string;
}, {
barangayCode: string;
}>;
export declare const SearchByNameParamsSchema: z.ZodObject<{
name: z.ZodString;
type: z.ZodOptional<z.ZodEnum<["island-group", "region", "province", "district", "city", "municipality", "city-municipality", "sub-municipality", "barangay"]>>;
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
name: string;
limit: number;
type?: "island-group" | "region" | "province" | "district" | "city" | "municipality" | "city-municipality" | "sub-municipality" | "barangay" | undefined;
}, {
name: string;
type?: "island-group" | "region" | "province" | "district" | "city" | "municipality" | "city-municipality" | "sub-municipality" | "barangay" | undefined;
limit?: number | undefined;
}>;
export declare const ValidateCodeParamsSchema: z.ZodObject<{
code: z.ZodString;
type: z.ZodOptional<z.ZodEnum<["island-group", "region", "province", "district", "city", "municipality", "city-municipality", "sub-municipality", "barangay"]>>;
}, "strip", z.ZodTypeAny, {
code: string;
type?: "island-group" | "region" | "province" | "district" | "city" | "municipality" | "city-municipality" | "sub-municipality" | "barangay" | undefined;
}, {
code: string;
type?: "island-group" | "region" | "province" | "district" | "city" | "municipality" | "city-municipality" | "sub-municipality" | "barangay" | undefined;
}>;
export declare const GetHierarchyParamsSchema: z.ZodObject<{
code: z.ZodString;
}, "strip", z.ZodTypeAny, {
code: string;
}, {
code: string;
}>;
export declare const GeographicCodeSchema: z.ZodString;
export declare const SearchNameSchema: z.ZodString;
export declare const IslandGroupSchema: z.ZodObject<{
code: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
name: z.ZodString;
}, "strip", z.ZodTypeAny, {
code: "luzon" | "visayas" | "mindanao";
name: string;
}, {
code: "luzon" | "visayas" | "mindanao";
name: string;
}>;
export declare const RegionSchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
regionName: z.ZodOptional<z.ZodString>;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
name: string;
regionName?: string | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
name: string;
regionName?: string | undefined;
}>;
export declare const ProvinceSchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}>;
export declare const DistrictSchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}>;
export declare const MunicipalitySchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
isCapital: z.ZodOptional<z.ZodBoolean>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}>;
export declare const CitySchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
isCapital: z.ZodOptional<z.ZodBoolean>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}>;
export declare const SubMunicipalitySchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
}>;
export declare const CityMunicipalitySchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
isCapital: z.ZodOptional<z.ZodBoolean>;
isCity: z.ZodOptional<z.ZodBoolean>;
isMunicipality: z.ZodOptional<z.ZodBoolean>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
isCity?: boolean | undefined;
isMunicipality?: boolean | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
isCity?: boolean | undefined;
isMunicipality?: boolean | undefined;
}>;
export declare const BarangaySchema: z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
subMunicipalityCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
cityCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
municipalityCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodString;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string;
name: string;
districtCode?: string | boolean | undefined;
cityCode?: string | boolean | undefined;
municipalityCode?: string | boolean | undefined;
subMunicipalityCode?: string | boolean | undefined;
oldName?: string | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string;
name: string;
districtCode?: string | boolean | undefined;
cityCode?: string | boolean | undefined;
municipalityCode?: string | boolean | undefined;
subMunicipalityCode?: string | boolean | undefined;
oldName?: string | undefined;
}>;
export declare const IslandGroupsResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
name: z.ZodString;
}, "strip", z.ZodTypeAny, {
code: "luzon" | "visayas" | "mindanao";
name: string;
}, {
code: "luzon" | "visayas" | "mindanao";
name: string;
}>, "many">;
export declare const RegionsResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
regionName: z.ZodOptional<z.ZodString>;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
name: string;
regionName?: string | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
name: string;
regionName?: string | undefined;
}>, "many">;
export declare const ProvincesResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}>, "many">;
export declare const DistrictsResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
name: string;
}>, "many">;
export declare const CitiesResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
isCapital: z.ZodOptional<z.ZodBoolean>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}>, "many">;
export declare const MunicipalitiesResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
isCapital: z.ZodOptional<z.ZodBoolean>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
}>, "many">;
export declare const SubMunicipalitiesResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
}>, "many">;
export declare const CityMunicipalitiesResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
isCapital: z.ZodOptional<z.ZodBoolean>;
isCity: z.ZodOptional<z.ZodBoolean>;
isMunicipality: z.ZodOptional<z.ZodBoolean>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodUnion<[z.ZodString, z.ZodBoolean]>;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
isCity?: boolean | undefined;
isMunicipality?: boolean | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string | boolean;
name: string;
districtCode?: string | boolean | undefined;
oldName?: string | undefined;
isCapital?: boolean | undefined;
isCity?: boolean | undefined;
isMunicipality?: boolean | undefined;
}>, "many">;
export declare const BarangaysResponseSchema: z.ZodArray<z.ZodObject<{
code: z.ZodString;
name: z.ZodString;
oldName: z.ZodOptional<z.ZodString>;
subMunicipalityCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
cityCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
municipalityCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
districtCode: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
provinceCode: z.ZodString;
regionCode: z.ZodString;
islandGroupCode: z.ZodEnum<["luzon", "visayas", "mindanao"]>;
}, "strip", z.ZodTypeAny, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string;
name: string;
districtCode?: string | boolean | undefined;
cityCode?: string | boolean | undefined;
municipalityCode?: string | boolean | undefined;
subMunicipalityCode?: string | boolean | undefined;
oldName?: string | undefined;
}, {
islandGroupCode: "luzon" | "visayas" | "mindanao";
code: string;
regionCode: string;
provinceCode: string;
name: string;
districtCode?: string | boolean | undefined;
cityCode?: string | boolean | undefined;
municipalityCode?: string | boolean | undefined;
subMunicipalityCode?: string | boolean | undefined;
oldName?: string | undefined;
}>, "many">;
export type IslandGroupCode = z.infer<typeof IslandGroupCodeSchema>;
export type EntityType = z.infer<typeof EntityTypeSchema>;
export type IslandGroupParams = z.infer<typeof IslandGroupParamsSchema>;
export type RegionParams = z.infer<typeof RegionParamsSchema>;
export type ProvinceParams = z.infer<typeof ProvinceParamsSchema>;
export type DistrictParams = z.infer<typeof DistrictParamsSchema>;
export type CityParams = z.infer<typeof CityParamsSchema>;
export type MunicipalityParams = z.infer<typeof MunicipalityParamsSchema>;
export type SubMunicipalityParams = z.infer<typeof SubMunicipalityParamsSchema>;
export type CityMunicipalityParams = z.infer<typeof CityMunicipalityParamsSchema>;
export type BarangayParams = z.infer<typeof BarangayParamsSchema>;
export type SearchByNameParams = z.infer<typeof SearchByNameParamsSchema>;
export type ValidateCodeParams = z.infer<typeof ValidateCodeParamsSchema>;
export type GetHierarchyParams = z.infer<typeof GetHierarchyParamsSchema>;
//# sourceMappingURL=validation.schemas.d.ts.map