@nyc-transit-kit/nyc-open-data 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 nyc-transit-kit contributors
+
+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,5 @@
+# @nyc-transit-kit/nyc-open-data
+
+Part of `nyc-transit-kit`, an Effect-native Bun toolkit for official NYC and MTA transit data APIs.
+
+See the repository README and docs/api-reference.md for public import paths, CLI commands, and release notes.

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@nyc-transit-kit/nyc-open-data",
+  "version": "0.1.0",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": "./src/index.ts",
+    "./catalog": "./src/catalog.ts",
+    "./client": "./src/client.ts",
+    "./datasets": "./src/datasets.ts",
+    "./descriptors": "./src/descriptors.ts",
+    "./query": "./src/query.ts"
+  },
+  "types": "./src/index.ts",
+  "files": [
+    "LICENSE",
+    "README.md",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "test": "bun test ./test"
+  },
+  "dependencies": {
+    "@nyc-transit-kit/contracts": "0.1.0",
+    "@nyc-transit-kit/soda3": "0.1.0",
+    "effect": "4.0.0-beta.83"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mannyc2/nyc-transit-kit.git",
+    "directory": "packages/nyc-open-data"
+  },
+  "homepage": "https://github.com/mannyc2/nyc-transit-kit#readme",
+  "bugs": {
+    "url": "https://github.com/mannyc2/nyc-transit-kit/issues"
+  },
+  "keywords": [
+    "bun",
+    "effect",
+    "mta",
+    "nyc",
+    "socrata",
+    "transit"
+  ],
+  "engines": {
+    "bun": ">=1.3.14"
+  }
+}

package/src/catalog.ts

@@ -0,0 +1,29 @@
+import { catalogSearch } from "@nyc-transit-kit/soda3/catalog"
+import { defaultDomain } from "./descriptors"
+
+export const searchNycOpenDataCatalog = (input: {
+  readonly query?: string
+  readonly limit?: number
+  readonly offset?: number
+}) => {
+  const request: {
+    readonly domain: string
+    query?: string
+    limit?: number
+    offset?: number
+  } = {
+    domain: defaultDomain
+  }
+
+  if (input.query !== undefined) {
+    request.query = input.query
+  }
+  if (input.limit !== undefined) {
+    request.limit = input.limit
+  }
+  if (input.offset !== undefined) {
+    request.offset = input.offset
+  }
+
+  return catalogSearch(request)
+}

package/src/client.ts

@@ -0,0 +1,21 @@
+import { exportResponse } from "@nyc-transit-kit/soda3/export"
+import { defaultDomain } from "./descriptors"
+
+export { queryNycOpenDataDataset } from "./query"
+
+export const exportNycOpenDataDataset = (input: {
+  readonly datasetId: string
+  readonly format: "csv" | "json" | "geojson"
+  readonly query?: string
+  readonly range?: {
+    readonly start: number
+    readonly end: number
+  }
+}) =>
+  exportResponse({
+    domain: defaultDomain,
+    datasetId: input.datasetId,
+    format: input.format,
+    ...(input.query === undefined ? {} : { query: input.query }),
+    ...(input.range === undefined ? {} : { range: input.range })
+  })

package/src/datasets.ts

@@ -0,0 +1,3 @@
+import { findNycOpenDataDataset, knownNycOpenDataDatasets } from "./descriptors"
+
+export { findNycOpenDataDataset, knownNycOpenDataDatasets }

package/src/descriptors.ts

@@ -0,0 +1,31 @@
+import { makeDescriptorRegistry } from "@nyc-transit-kit/contracts/descriptor-registry"
+import { NycOpenDataDatasetDescriptor } from "@nyc-transit-kit/contracts/nyc-open-data"
+import * as Schema from "effect/Schema"
+import { nycOpenDataDescriptorRecords } from "./internal/descriptor-records"
+
+export const defaultDomain = "data.cityofnewyork.us"
+
+const decodeDescriptor = Schema.decodeUnknownSync(NycOpenDataDatasetDescriptor)
+const descriptorRegistry = makeDescriptorRegistry({
+  descriptors: nycOpenDataDescriptorRecords.map((record) => decodeDescriptor(record)),
+  id: (dataset) => String(dataset.id)
+})
+
+const requireNycOpenDataDescriptor = (datasetId: string) => {
+  const descriptor = descriptorRegistry.findById(datasetId)
+  if (descriptor === undefined) {
+    throw new Error(`Missing NYC Open Data descriptor: ${datasetId}`)
+  }
+  return descriptor
+}
+
+export const busLanesLocalStreetsDescriptor = requireNycOpenDataDescriptor("ycrg-ses3")
+
+export const dotTrafficSpeedsDescriptor = requireNycOpenDataDescriptor("i4gi-tjb9")
+
+export const trafficVolumeCountsDescriptor = requireNycOpenDataDescriptor("btm5-ppia")
+
+export const knownNycOpenDataDatasets: ReadonlyArray<NycOpenDataDatasetDescriptor> =
+  descriptorRegistry.all
+
+export const findNycOpenDataDataset = (datasetId: string) => descriptorRegistry.findById(datasetId)

package/src/index.ts

@@ -0,0 +1,12 @@
+export const packageName = "@nyc-transit-kit/nyc-open-data"
+export { searchNycOpenDataCatalog } from "./catalog"
+export { exportNycOpenDataDataset } from "./client"
+export {
+  busLanesLocalStreetsDescriptor,
+  defaultDomain,
+  dotTrafficSpeedsDescriptor,
+  findNycOpenDataDataset,
+  knownNycOpenDataDatasets,
+  trafficVolumeCountsDescriptor
+} from "./descriptors"
+export { queryNycOpenDataDataset } from "./query"

package/src/internal/descriptor-records.ts

@@ -0,0 +1,42 @@
+import type { NycOpenDataDatasetDescriptorInput } from "@nyc-transit-kit/contracts/nyc-open-data"
+
+export const nycOpenDataDescriptorRecords = [
+  {
+    id: "ycrg-ses3",
+    name: "Bus Lanes - Local Streets",
+    domain: "data.cityofnewyork.us",
+    agency: "DOT",
+    backing: "socrata",
+    description: "NYC DOT bus lane centerline dataset hosted on NYC Open Data.",
+    sourceUrl: "https://data.cityofnewyork.us/d/ycrg-ses3",
+    tags: ["transportation", "transit"],
+    adapterStatus: "none",
+    lastVerified: "2026-06-16"
+  },
+  {
+    id: "i4gi-tjb9",
+    name: "DOT Traffic Speeds",
+    domain: "data.cityofnewyork.us",
+    agency: "DOT",
+    backing: "socrata",
+    description: "NYC DOT traffic speeds dataset hosted on NYC Open Data.",
+    sourceUrl: "https://data.cityofnewyork.us/d/i4gi-tjb9",
+    tags: ["transportation", "traffic"],
+    temporalFields: ["data_as_of"],
+    adapterStatus: "none",
+    lastVerified: "2026-06-16"
+  },
+  {
+    id: "btm5-ppia",
+    name: "Traffic Volume Counts Historical",
+    domain: "data.cityofnewyork.us",
+    agency: "DOT",
+    backing: "socrata",
+    description: "NYC DOT historical traffic volume counts dataset hosted on NYC Open Data.",
+    sourceUrl: "https://data.cityofnewyork.us/d/btm5-ppia",
+    tags: ["transportation", "traffic"],
+    temporalFields: ["count_date"],
+    adapterStatus: "none",
+    lastVerified: "2026-06-16"
+  }
+] satisfies ReadonlyArray<NycOpenDataDatasetDescriptorInput>

package/src/query.ts

@@ -0,0 +1,23 @@
+import { queryRows } from "@nyc-transit-kit/soda3/query"
+import { defaultDomain } from "./descriptors"
+
+export const queryNycOpenDataDataset = (input: {
+  readonly datasetId: string
+  readonly query: string
+  readonly page?: {
+    readonly pageNumber: number
+    readonly pageSize: number
+  }
+}) =>
+  input.page === undefined
+    ? queryRows({
+        domain: defaultDomain,
+        datasetId: input.datasetId,
+        query: input.query
+      })
+    : queryRows({
+        domain: defaultDomain,
+        datasetId: input.datasetId,
+        query: input.query,
+        page: input.page
+      })