@gtfs-jp/types 4.0.0-beta.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kai-Z-JP
+
+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,109 @@
+# @gtfs-jp/types
+
+GTFS-JP v4 全33テーブルのスキーマ定義と、スキーマから導出される TypeScript 型を提供します。
+
+## Install
+
+```bash
+npm install @gtfs-jp/types
+```
+
+## Usage
+
+### テーブル名の一覧と判定
+
+```ts
+import {
+  GTFS_JP_V4_TABLE_NAMES,
+  isGtfsJpV4TableName,
+} from "@gtfs-jp/types";
+
+console.log(GTFS_JP_V4_TABLE_NAMES);
+// ["feed_info", "agency", "stops", "routes", "trips", ...]
+
+isGtfsJpV4TableName("routes");  // true
+isGtfsJpV4TableName("unknown"); // false
+```
+
+### スキーマの取得
+
+```ts
+import { getGtfsJpV4TableSchema } from "@gtfs-jp/types";
+
+const schema = getGtfsJpV4TableSchema("routes");
+// schema.fileName  → "routes.txt"
+// schema.requirement → "required"
+// schema.columns   → { route_id: { kind: "string", required: true }, ... }
+```
+
+### 型付き行データ
+
+```ts
+import type { GtfsJpV4TableRow } from "@gtfs-jp/types";
+
+// routes テーブルの行型が自動導出される
+type RouteRow = GtfsJpV4TableRow<"routes">;
+// { route_id: string; agency_id: string | undefined; route_type: number; ... }
+
+const row: RouteRow = {
+  route_id: "R1",
+  agency_id: "A1",
+  route_type: 3,
+};
+```
+
+### ファイル名とテーブル名の相互変換
+
+```ts
+import {
+  resolveGtfsJpV4TableNameFromFileName,
+  resolveGtfsJpV4FileNameFromTableName,
+  isGtfsJpV4FileName,
+} from "@gtfs-jp/types";
+
+resolveGtfsJpV4TableNameFromFileName("routes.txt"); // "routes"
+resolveGtfsJpV4FileNameFromTableName("routes");     // "routes.txt"
+isGtfsJpV4FileName("routes.txt"); // true
+```
+
+## API
+
+### 定数
+
+| 名前                       | 説明                   |
+|--------------------------|----------------------|
+| `GTFS_JP_V4_SCHEMA`      | 全33テーブルのスキーマ定義配列     |
+| `GTFS_JP_V4_TABLE_NAMES` | テーブル名の `readonly` 配列 |
+| `GTFS_JP_V4_FILE_NAMES`  | ファイル名の `readonly` 配列 |
+
+### 関数
+
+| 名前                                                | 説明                     |
+|---------------------------------------------------|------------------------|
+| `getGtfsJpV4TableSchema(tableName)`               | テーブル名からスキーマを取得         |
+| `getGtfsJpV4TableSchemaByFileName(fileName)`      | ファイル名からスキーマを取得         |
+| `isGtfsJpV4TableName(value)`                      | GTFS-JP v4 テーブル名かどうか判定 |
+| `isGtfsJpV4FileName(value)`                       | GTFS-JP v4 ファイル名かどうか判定 |
+| `resolveGtfsJpV4TableNameFromFileName(fileName)`  | ファイル名 → テーブル名          |
+| `resolveGtfsJpV4FileNameFromTableName(tableName)` | テーブル名 → ファイル名          |
+
+### 型
+
+| 名前                        | 説明              |
+|---------------------------|-----------------|
+| `GtfsJpV4TableName`       | 全テーブル名のユニオン型    |
+| `GtfsJpV4FileName`        | 全ファイル名のユニオン型    |
+| `GtfsJpV4TableRow<TName>` | テーブル名から導出される行の型 |
+| `GtfsJpV4TableSchema`     | テーブルスキーマの型      |
+| `GtfsJpV4ColumnSchema`    | カラムスキーマの型       |
+
+### スカラー型
+
+CSV の値に意味的な型を付与するブランド型です。実体はすべて `string` または `number` です。
+
+`GtfsId` `GtfsText` `GtfsDate` `GtfsTime` `GtfsUrl` `GtfsEmail` `GtfsColor` `GtfsPhoneNumber` `GtfsTimezone`
+`GtfsLanguageCode` `GtfsCurrencyCode` `BinaryFlag`
+
+## License
+
+[MIT](../../LICENSE)

package/dist/helpers.d.ts

@@ -0,0 +1,10 @@
+import type { GtfsJpV4FileName, GtfsJpV4SchemaEntry, GtfsJpV4SchemaEntryByName, GtfsJpV4TableName } from "./types.js";
+export declare const GTFS_JP_V4_TABLE_NAMES: readonly GtfsJpV4TableName[];
+export declare const GTFS_JP_V4_FILE_NAMES: readonly GtfsJpV4FileName[];
+export declare const isGtfsJpV4TableName: (value: string) => value is GtfsJpV4TableName;
+export declare const isGtfsJpV4FileName: (value: string) => value is GtfsJpV4FileName;
+export declare const getGtfsJpV4TableSchema: <TName extends GtfsJpV4TableName>(tableName: TName) => GtfsJpV4SchemaEntryByName<TName>;
+export declare const getGtfsJpV4TableSchemaByFileName: (fileName: GtfsJpV4FileName) => GtfsJpV4SchemaEntry;
+export declare const resolveGtfsJpV4TableNameFromFileName: (fileName: string) => GtfsJpV4TableName | undefined;
+export declare const resolveGtfsJpV4FileNameFromTableName: (tableName: GtfsJpV4TableName) => GtfsJpV4FileName;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,sBAAsB,EAE9B,SAAS,iBAAiB,EAAE,CAAC;AAElC,eAAO,MAAM,qBAAqB,EAE7B,SAAS,gBAAgB,EAAE,CAAC;AAUjC,eAAO,MAAM,mBAAmB,GAAI,OAAO,MAAM,KAAG,KAAK,IAAI,iBACV,CAAC;AAEpD,eAAO,MAAM,kBAAkB,GAAI,OAAO,MAAM,KAAG,KAAK,IAAI,gBACX,CAAC;AAElD,eAAO,MAAM,sBAAsB,GAAI,KAAK,SAAS,iBAAiB,EACpE,WAAW,KAAK,KACf,yBAAyB,CAAC,KAAK,CAOjC,CAAC;AAEF,eAAO,MAAM,gCAAgC,GAC3C,UAAU,gBAAgB,KACzB,mBAOF,CAAC;AAEF,eAAO,MAAM,oCAAoC,GAC/C,UAAU,MAAM,KACf,iBAAiB,GAAG,SAItB,CAAC;AAEF,eAAO,MAAM,oCAAoC,GAC/C,WAAW,iBAAiB,KAC3B,gBAEF,CAAC"}

package/dist/helpers.js

@@ -0,0 +1,30 @@
+import { GTFS_JP_V4_SCHEMA } from "./schema.js";
+export const GTFS_JP_V4_TABLE_NAMES = GTFS_JP_V4_SCHEMA.map((schema) => schema.tableName);
+export const GTFS_JP_V4_FILE_NAMES = GTFS_JP_V4_SCHEMA.map((schema) => schema.fileName);
+const schemaByTableName = new Map(GTFS_JP_V4_SCHEMA.map((schema) => [schema.tableName, schema]));
+const schemaByFileName = new Map(GTFS_JP_V4_SCHEMA.map((schema) => [schema.fileName, schema]));
+export const isGtfsJpV4TableName = (value) => schemaByTableName.has(value);
+export const isGtfsJpV4FileName = (value) => schemaByFileName.has(value);
+export const getGtfsJpV4TableSchema = (tableName) => {
+    const schema = schemaByTableName.get(tableName);
+    if (!schema) {
+        throw new Error(`Unknown GTFS-JP v4 table: ${tableName}`);
+    }
+    return schema;
+};
+export const getGtfsJpV4TableSchemaByFileName = (fileName) => {
+    const schema = schemaByFileName.get(fileName);
+    if (!schema) {
+        throw new Error(`Unknown GTFS-JP v4 file: ${fileName}`);
+    }
+    return schema;
+};
+export const resolveGtfsJpV4TableNameFromFileName = (fileName) => {
+    const normalized = fileName.toLowerCase();
+    const schema = schemaByFileName.get(normalized);
+    return schema?.tableName;
+};
+export const resolveGtfsJpV4FileNameFromTableName = (tableName) => {
+    return getGtfsJpV4TableSchema(tableName).fileName;
+};
+//# sourceMappingURL=helpers.js.map

package/dist/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAQhD,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,GAAG,CACzD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CACG,CAAC;AAElC,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC,GAAG,CACxD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CACG,CAAC;AAEjC,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAC/B,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAC9D,CAAC;AAEF,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAC9B,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAC7D,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAA8B,EAAE,CAC/E,iBAAiB,CAAC,GAAG,CAAC,KAA0B,CAAC,CAAC;AAEpD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAA6B,EAAE,CAC7E,gBAAgB,CAAC,GAAG,CAAC,KAAyB,CAAC,CAAC;AAElD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,SAAgB,EACkB,EAAE;IACpC,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAChD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,6BAA6B,SAAS,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,MAA0C,CAAC;AACpD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,QAA0B,EACL,EAAE;IACvB,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,QAAgB,EACe,EAAE;IACjC,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,EAAsB,CAAC;IAC9D,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAChD,OAAO,MAAM,EAAE,SAAS,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,SAA4B,EACV,EAAE;IACpB,OAAO,sBAAsB,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;AACpD,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { GTFS_JP_V4_SCHEMA, type GtfsJpV4ColumnRequirement, type GtfsJpV4ColumnSchema, type GtfsJpV4Requirement, type GtfsJpV4TableSchema, } from "./schema.js";
+export { GTFS_JP_V4_FILE_NAMES, GTFS_JP_V4_TABLE_NAMES, getGtfsJpV4TableSchema, getGtfsJpV4TableSchemaByFileName, isGtfsJpV4FileName, isGtfsJpV4TableName, resolveGtfsJpV4FileNameFromTableName, resolveGtfsJpV4TableNameFromFileName, } from "./helpers.js";
+export type { BinaryFlag, GtfsColor, GtfsCurrencyCode, GtfsDate, GtfsEmail, GtfsId, GtfsLanguageCode, GtfsPhoneNumber, GtfsRow, GtfsScalar, GtfsText, GtfsTime, GtfsTimezone, GtfsUrl, GtfsJpV4ColumnsByTableName, GtfsJpV4FileName, GtfsJpV4Format, GtfsJpV4SchemaEntry, GtfsJpV4SchemaEntryByName, GtfsJpV4TableName, GtfsJpV4TableRequirement, GtfsJpV4TableRow, GtfsJpV4TypedRows, RowFromColumns, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,gCAAgC,EAChC,kBAAkB,EAClB,mBAAmB,EACnB,oCAAoC,EACpC,oCAAoC,GACrC,MAAM,cAAc,CAAC;AAEtB,YAAY,EACV,UAAU,EACV,SAAS,EACT,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,0BAA0B,EAC1B,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,GACf,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { GTFS_JP_V4_SCHEMA, } from "./schema.js";
+export { GTFS_JP_V4_FILE_NAMES, GTFS_JP_V4_TABLE_NAMES, getGtfsJpV4TableSchema, getGtfsJpV4TableSchemaByFileName, isGtfsJpV4FileName, isGtfsJpV4TableName, resolveGtfsJpV4FileNameFromTableName, resolveGtfsJpV4TableNameFromFileName, } from "./helpers.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,GAKlB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,gCAAgC,EAChC,kBAAkB,EAClB,mBAAmB,EACnB,oCAAoC,EACpC,oCAAoC,GACrC,MAAM,cAAc,CAAC"}