@palmgrove/nefdb 1.0.0

package/dist/query.d.ts

@@ -0,0 +1,8 @@
+import type { EmissionFactor, FactorWithSource, MinimalFactor, QueryOptions } from "./types.js";
+export declare function get(id: string, options?: QueryOptions): MinimalFactor | FactorWithSource | EmissionFactor | undefined;
+export declare function query(filter: Partial<EmissionFactor> & {
+    source?: {
+        id?: string;
+    };
+}, options?: QueryOptions): MinimalFactor[] | FactorWithSource[] | EmissionFactor[];
+export declare function list(options?: QueryOptions): MinimalFactor[] | FactorWithSource[] | EmissionFactor[];

package/dist/sources/index.d.ts

@@ -0,0 +1,5 @@
+import type { SourceReference } from "../types.js";
+export type { SourceReference };
+export declare const sourcesById: Record<string, SourceReference>;
+export declare const allSources: SourceReference[];
+export declare function getSourceById(id: string): SourceReference | undefined;

package/dist/types.d.ts

@@ -0,0 +1,50 @@
+export interface EmissionFactor {
+    id: string;
+    category: FactorCategory;
+    subcategory: string;
+    description: string;
+    value: number;
+    unit: FactorUnit;
+    gas: GasBreakdown | null;
+    gwp_basis: "AR5" | "AR6";
+    scope: 1 | 2 | "1_and_2";
+    data_year: number;
+    published_year: number;
+    country: "NG";
+    region?: string;
+    disco?: DisCo;
+    source: SourceReference;
+    additional_sources?: SourceReference[];
+    uncertainty_pct?: number;
+    confidence: "high" | "medium" | "low";
+    methodology_note: string;
+    nefdb_version: string;
+    deprecated?: boolean;
+    superseded_by?: string;
+}
+export interface SourceReference {
+    id: string;
+    title: string;
+    publisher: string;
+    year: number;
+    url?: string;
+    page?: string;
+    access_date?: string;
+}
+export interface GasBreakdown {
+    CO2: number;
+    CH4: number;
+    N2O: number;
+}
+export declare const FACTOR_CATEGORIES: readonly ["grid_electricity", "fuel_combustion", "transport", "aviation", "waste", "water"];
+export type FactorCategory = (typeof FACTOR_CATEGORIES)[number];
+export declare const FACTOR_UNITS: readonly ["kgCO2e_per_kWh", "kgCO2e_per_litre", "kgCO2e_per_kg", "kgCO2e_per_m3", "kgCO2e_per_tonne", "kgCO2e_per_km", "kgCO2e_per_passenger_km", "kgCO2e_per_person_year", "multiplier"];
+export type FactorUnit = (typeof FACTOR_UNITS)[number];
+export declare const DISCOS: readonly ["AEDC", "BEDC", "EKEDC", "EEDC", "IBEDC", "IEDC", "JEDC", "KDEDC", "KEDC", "PEDC", "YEDC"];
+export type DisCo = (typeof DISCOS)[number];
+export interface QueryOptions {
+    withSource?: boolean;
+    full?: boolean;
+}
+export type MinimalFactor = Pick<EmissionFactor, "id" | "value" | "unit">;
+export type FactorWithSource = Pick<EmissionFactor, "id" | "value" | "unit" | "source">;

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@palmgrove/nefdb",
+  "version": "1.0.0",
+  "description": "Nigeria Emission Factor Database — the first open, versioned emission factor database for Nigerian operations",
+  "keywords": [
+    "nigeria",
+    "emission-factors",
+    "ghg",
+    "carbon",
+    "sustainability",
+    "esg",
+    "scope1",
+    "scope2"
+  ],
+  "homepage": "https://github.com/palmgrove/nefdb",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/palmgrove/nefdb.git"
+  },
+  "license": "CC-BY-SA-4.0",
+  "author": "Irenium Ltd <hello@palmgrove.ng>",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./data/json": "./data/nefdb_v1.json",
+    "./data/csv": "./data/nefdb_v1.csv"
+  },
+  "files": [
+    "dist/",
+    "data/",
+    "README.md",
+    "METHODOLOGY.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "bun build src/index.ts --outfile dist/index.js --format esm --target node && bun build src/index.ts --outfile dist/index.cjs --format cjs --target node && bun run build:types",
+    "build:csv": "bun run scripts/build_csv.ts",
+    "build:json": "bun run scripts/build_json.ts",
+    "build:types": "bun run scripts/build_types.ts",
+    "validate": "bun run scripts/validate.ts",
+    "test": "bun test",
+    "prepublishOnly": "bun run validate && bun run test && bun run build && bun run build:csv && bun run build:json"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  }
+}