gis.ph-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yahaay Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,123 @@
+# GIS.PH JavaScript/TypeScript SDK
+
+The **`gis.ph-sdk`** package provides a robust, type-safe client for interacting with the `api.gis.ph` service. It simplifies integration by handling authentication, request signing, and error parsing, allowing developers to focus on building features.
+
+## Installation
+
+Install the package via your preferred package manager:
+
+```bash
+npm install gis.ph-sdk
+# or
+yarn add gis.ph-sdk
+# or
+pnpm add gis.ph-sdk
+```
+
+## Getting Started
+
+Initialize the client with your API key or access token.
+
+```typescript
+import { GisPh } from 'gis.ph-sdk';
+
+const client = new GisPh({
+  apiKey: 'YOUR_API_KEY',
+  // accessToken: 'YOUR_SUPABASE_ACCESS_TOKEN', // Optional: for user-specific context
+});
+```
+
+## Resources
+
+The SDK organizes API endpoints into logical resources.
+
+### Provinces
+
+Interact with Philippine provinces data.
+
+#### List Provinces
+Retrieve a paginated list of provinces.
+
+```typescript
+const response = await client.provinces.list({
+  page: 1,
+  limit: 10
+});
+
+console.log(response.data); // Array of Province objects
+```
+
+#### Get Province
+Retrieve details for a specific province by ID.
+
+```typescript
+const { data: province } = await client.provinces.get('PROVINCE_ID');
+```
+
+### Barangays
+
+Interact with barangay data, including search functionality.
+
+#### List Barangays
+Filter barangays by province (required) and optionally by municipality or name.
+
+```typescript
+const response = await client.barangays.list({
+  province: 'Bohol',       // Required: Exact match
+  municipality: 'Tubigon', // Optional: Starts-with search
+  limit: 20
+});
+```
+
+#### Search Barangays
+Perform a global text search for barangays across all provinces.
+
+```typescript
+const response = await client.barangays.search({
+  q: 'Poblacion',
+  limit: 5
+});
+```
+
+#### Get Barangay
+Retrieve details for a specific barangay by ID.
+
+```typescript
+const { data: barangay } = await client.barangays.get('BARANGAY_ID');
+```
+
+## Authentication
+
+The SDK supports two authentication methods:
+
+1.  **API Key (`apiKey`)**: Best for server-side integrations or public client-side access where allowed. Sets the `X-API-Key` header.
+2.  **Access Token (`accessToken`)**: Used for authenticated user sessions (e.g., Supabase JWTs). Sets the `Authorization: Bearer <token>` header.
+
+You can provide one or both in the constructor configuration.
+
+## Error Handling
+
+API errors are thrown as `GisPhError` instances, containing status codes and detailed error messages.
+
+```typescript
+import { GisPh, GisPhError } from 'gis.ph-sdk';
+
+try {
+  await client.barangays.list({ province: '' }); // Missing required param
+} catch (error) {
+  if (error instanceof GisPhError) {
+    console.error(`API Error ${error.status}: ${error.code} - ${error.message}`);
+    // Example: API Error 400: VALIDATION_ERROR - Invalid province
+  } else {
+    console.error('Network or unexpected error:', error);
+  }
+}
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and ships with type definitions. Key interfaces like `Province`, `Barangay`, and `ApiResponse` are exported for use in your application.
+
+```typescript
+import type { Province, Barangay } from 'gis.ph-sdk';
+```

package/dist/index.cjs

@@ -0,0 +1,162 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Barangays: () => Barangays,
+  GisPh: () => GisPh,
+  GisPhError: () => GisPhError,
+  Provinces: () => Provinces
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/core/errors.ts
+var GisPhError = class extends Error {
+  status;
+  code;
+  issues;
+  constructor(message, status, code, issues) {
+    super(message);
+    this.name = "GisPhError";
+    this.status = status;
+    this.code = code;
+    this.issues = issues;
+  }
+};
+
+// src/core/fetcher.ts
+var Fetcher = class {
+  config;
+  constructor(config) {
+    this.config = {
+      baseUrl: "https://api.gis.ph/v1",
+      ...config
+    };
+  }
+  async request(endpoint, options = {}) {
+    const url = new URL(`${this.config.baseUrl}${endpoint}`);
+    if (options.query) {
+      Object.entries(options.query).forEach(([key, value]) => {
+        if (value !== void 0 && value !== null) {
+          url.searchParams.append(key, String(value));
+        }
+      });
+    }
+    const headers = {
+      "Content-Type": "application/json",
+      ...options.headers
+    };
+    if (this.config.accessToken) {
+      headers["Authorization"] = `Bearer ${this.config.accessToken}`;
+    }
+    if (this.config.apiKey) {
+      headers["X-API-Key"] = this.config.apiKey;
+    }
+    try {
+      const response = await fetch(url.toString(), {
+        ...options,
+        headers
+      });
+      let data;
+      const contentType = response.headers.get("content-type");
+      if (contentType && contentType.includes("application/json")) {
+        data = await response.json();
+      } else {
+        data = await response.text();
+      }
+      if (!response.ok) {
+        throw new GisPhError(
+          data?.message || response.statusText,
+          response.status,
+          data?.error?.code,
+          data?.error?.issues
+        );
+      }
+      if (data && typeof data === "object" && "data" in data) {
+        return data.data;
+      }
+      return data;
+    } catch (error) {
+      if (error instanceof GisPhError) {
+        throw error;
+      }
+      throw new GisPhError(
+        error instanceof Error ? error.message : "Unknown network error",
+        0
+      );
+    }
+  }
+};
+
+// src/core/base.ts
+var BaseResource = class {
+  fetcher;
+  constructor(fetcher) {
+    this.fetcher = fetcher;
+  }
+};
+
+// src/resources/barangays.ts
+var Barangays = class extends BaseResource {
+  async list(params) {
+    return this.fetcher.request("/barangays", {
+      query: params
+    });
+  }
+  async get(id) {
+    return this.fetcher.request(`/barangays/${id}`);
+  }
+  async search(params) {
+    return this.fetcher.request("/barangays/search", {
+      query: params
+    });
+  }
+};
+
+// src/resources/provinces.ts
+var Provinces = class extends BaseResource {
+  async list(params = {}) {
+    return this.fetcher.request("/provinces", {
+      query: params
+    });
+  }
+  async get(id) {
+    return this.fetcher.request(`/provinces/${id}`);
+  }
+};
+
+// src/client.ts
+var GisPh = class {
+  barangays;
+  provinces;
+  fetcher;
+  constructor(config = {}) {
+    this.fetcher = new Fetcher(config);
+    this.barangays = new Barangays(this.fetcher);
+    this.provinces = new Provinces(this.fetcher);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Barangays,
+  GisPh,
+  GisPhError,
+  Provinces
+});

package/dist/index.d.cts

@@ -0,0 +1,94 @@
+interface GisPhConfig {
+    /**
+     * API Key for server-side or authorized access.
+     */
+    apiKey?: string;
+    /**
+     * Supabase access token for client-side user context.
+     */
+    accessToken?: string;
+    /**
+     * Base URL for the API. Defaults to https://api.gis.ph/v1
+     */
+    baseUrl?: string;
+}
+interface RequestOptions extends RequestInit {
+    query?: Record<string, string | number | undefined | null>;
+}
+interface ApiResponse<T> {
+    data: T;
+    meta?: {
+        total: number;
+        page: number;
+        limit: number;
+        totalPages: number;
+    };
+    error: null | {
+        message: string;
+        code?: string;
+        issues?: any[];
+    };
+}
+
+declare class Fetcher {
+    private config;
+    constructor(config: GisPhConfig);
+    request<T>(endpoint: string, options?: RequestOptions): Promise<T>;
+}
+
+declare class BaseResource {
+    protected fetcher: Fetcher;
+    constructor(fetcher: Fetcher);
+}
+
+interface Barangay {
+    id: string;
+    name: string;
+    [key: string]: any;
+}
+interface BarangayListParams {
+    province: string;
+    municipality?: string;
+    name?: string;
+    page?: number;
+    limit?: number;
+}
+interface BarangaySearchParams {
+    q: string;
+    limit?: number;
+}
+declare class Barangays extends BaseResource {
+    list(params: BarangayListParams): Promise<ApiResponse<Barangay[]>>;
+    get(id: string): Promise<ApiResponse<Barangay>>;
+    search(params: BarangaySearchParams): Promise<ApiResponse<Barangay[]>>;
+}
+
+interface Province {
+    id: string;
+    name: string;
+    [key: string]: any;
+}
+interface ProvinceListParams {
+    page?: number;
+    limit?: number;
+}
+declare class Provinces extends BaseResource {
+    list(params?: ProvinceListParams): Promise<ApiResponse<Province[]>>;
+    get(id: string): Promise<ApiResponse<Province>>;
+}
+
+declare class GisPhError extends Error {
+    status: number;
+    code?: string | undefined;
+    issues?: any[] | undefined;
+    constructor(message: string, status: number, code?: string, issues?: any[]);
+}
+
+declare class GisPh {
+    barangays: Barangays;
+    provinces: Provinces;
+    private fetcher;
+    constructor(config?: GisPhConfig);
+}
+
+export { type ApiResponse, type Barangay, type BarangayListParams, type BarangaySearchParams, Barangays, GisPh, type GisPhConfig, GisPhError, type Province, type ProvinceListParams, Provinces, type RequestOptions };

package/dist/index.d.ts

@@ -0,0 +1,94 @@
+interface GisPhConfig {
+    /**
+     * API Key for server-side or authorized access.
+     */
+    apiKey?: string;
+    /**
+     * Supabase access token for client-side user context.
+     */
+    accessToken?: string;
+    /**
+     * Base URL for the API. Defaults to https://api.gis.ph/v1
+     */
+    baseUrl?: string;
+}
+interface RequestOptions extends RequestInit {
+    query?: Record<string, string | number | undefined | null>;
+}
+interface ApiResponse<T> {
+    data: T;
+    meta?: {
+        total: number;
+        page: number;
+        limit: number;
+        totalPages: number;
+    };
+    error: null | {
+        message: string;
+        code?: string;
+        issues?: any[];
+    };
+}
+
+declare class Fetcher {
+    private config;
+    constructor(config: GisPhConfig);
+    request<T>(endpoint: string, options?: RequestOptions): Promise<T>;
+}
+
+declare class BaseResource {
+    protected fetcher: Fetcher;
+    constructor(fetcher: Fetcher);
+}
+
+interface Barangay {
+    id: string;
+    name: string;
+    [key: string]: any;
+}
+interface BarangayListParams {
+    province: string;
+    municipality?: string;
+    name?: string;
+    page?: number;
+    limit?: number;
+}
+interface BarangaySearchParams {
+    q: string;
+    limit?: number;
+}
+declare class Barangays extends BaseResource {
+    list(params: BarangayListParams): Promise<ApiResponse<Barangay[]>>;
+    get(id: string): Promise<ApiResponse<Barangay>>;
+    search(params: BarangaySearchParams): Promise<ApiResponse<Barangay[]>>;
+}
+
+interface Province {
+    id: string;
+    name: string;
+    [key: string]: any;
+}
+interface ProvinceListParams {
+    page?: number;
+    limit?: number;
+}
+declare class Provinces extends BaseResource {
+    list(params?: ProvinceListParams): Promise<ApiResponse<Province[]>>;
+    get(id: string): Promise<ApiResponse<Province>>;
+}
+
+declare class GisPhError extends Error {
+    status: number;
+    code?: string | undefined;
+    issues?: any[] | undefined;
+    constructor(message: string, status: number, code?: string, issues?: any[]);
+}
+
+declare class GisPh {
+    barangays: Barangays;
+    provinces: Provinces;
+    private fetcher;
+    constructor(config?: GisPhConfig);
+}
+
+export { type ApiResponse, type Barangay, type BarangayListParams, type BarangaySearchParams, Barangays, GisPh, type GisPhConfig, GisPhError, type Province, type ProvinceListParams, Provinces, type RequestOptions };

package/dist/index.js

@@ -0,0 +1,132 @@
+// src/core/errors.ts
+var GisPhError = class extends Error {
+  status;
+  code;
+  issues;
+  constructor(message, status, code, issues) {
+    super(message);
+    this.name = "GisPhError";
+    this.status = status;
+    this.code = code;
+    this.issues = issues;
+  }
+};
+
+// src/core/fetcher.ts
+var Fetcher = class {
+  config;
+  constructor(config) {
+    this.config = {
+      baseUrl: "https://api.gis.ph/v1",
+      ...config
+    };
+  }
+  async request(endpoint, options = {}) {
+    const url = new URL(`${this.config.baseUrl}${endpoint}`);
+    if (options.query) {
+      Object.entries(options.query).forEach(([key, value]) => {
+        if (value !== void 0 && value !== null) {
+          url.searchParams.append(key, String(value));
+        }
+      });
+    }
+    const headers = {
+      "Content-Type": "application/json",
+      ...options.headers
+    };
+    if (this.config.accessToken) {
+      headers["Authorization"] = `Bearer ${this.config.accessToken}`;
+    }
+    if (this.config.apiKey) {
+      headers["X-API-Key"] = this.config.apiKey;
+    }
+    try {
+      const response = await fetch(url.toString(), {
+        ...options,
+        headers
+      });
+      let data;
+      const contentType = response.headers.get("content-type");
+      if (contentType && contentType.includes("application/json")) {
+        data = await response.json();
+      } else {
+        data = await response.text();
+      }
+      if (!response.ok) {
+        throw new GisPhError(
+          data?.message || response.statusText,
+          response.status,
+          data?.error?.code,
+          data?.error?.issues
+        );
+      }
+      if (data && typeof data === "object" && "data" in data) {
+        return data.data;
+      }
+      return data;
+    } catch (error) {
+      if (error instanceof GisPhError) {
+        throw error;
+      }
+      throw new GisPhError(
+        error instanceof Error ? error.message : "Unknown network error",
+        0
+      );
+    }
+  }
+};
+
+// src/core/base.ts
+var BaseResource = class {
+  fetcher;
+  constructor(fetcher) {
+    this.fetcher = fetcher;
+  }
+};
+
+// src/resources/barangays.ts
+var Barangays = class extends BaseResource {
+  async list(params) {
+    return this.fetcher.request("/barangays", {
+      query: params
+    });
+  }
+  async get(id) {
+    return this.fetcher.request(`/barangays/${id}`);
+  }
+  async search(params) {
+    return this.fetcher.request("/barangays/search", {
+      query: params
+    });
+  }
+};
+
+// src/resources/provinces.ts
+var Provinces = class extends BaseResource {
+  async list(params = {}) {
+    return this.fetcher.request("/provinces", {
+      query: params
+    });
+  }
+  async get(id) {
+    return this.fetcher.request(`/provinces/${id}`);
+  }
+};
+
+// src/client.ts
+var GisPh = class {
+  barangays;
+  provinces;
+  fetcher;
+  constructor(config = {}) {
+    this.fetcher = new Fetcher(config);
+    this.barangays = new Barangays(this.fetcher);
+    this.provinces = new Provinces(this.fetcher);
+  }
+};
+export {
+  Barangays,
+  GisPh,
+  GisPhError,
+  Provinces
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "gis.ph-sdk",
+  "version": "1.0.0",
+  "description": "Official JavaScript/TypeScript SDK for api.gis.ph - Access Philippine geographical data (Provinces, Barangays, LGUs) and more.",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "philippines",
+    "gis",
+    "sdk",
+    "api",
+    "barangay",
+    "province",
+    "lgu",
+    "regions",
+    "typescript"
+  ],
+  "author": "Gerald Villacarlos <gerald@yahaay.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yahaaylabs/gis.ph-sdk-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yahaaylabs/gis.ph-sdk-js/issues"
+  },
+  "homepage": "https://github.com/yahaaylabs/gis.ph-sdk-js#readme",
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
+  }
+}