@dmdata/telegram-json-types 1.0.9-jschema.0 → 1.1.0

package/package.json

@@ -1,21 +1,29 @@
-{
-  "name": "@dmdata/telegram-json-types",
-  "version": "1.0.9-jschema.0",
-  "scripts": {
-    "build:jschema": "npx tsc --project tsconfig.jschema.json",
-    "build:dist-jschema": "npx ts-node ./dist/build.js",
-    "prepublishOnly": "npm run build:jschema && npm run build:dist-jschema",
-    "publish:npm": "npm version patch && npm publish --access=public"
-  },
-  "types": "index.d.ts",
-  "main": "./dist/jschema-load.js",
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/node": "^14.18.9",
-    "typescript": "^4.5.5",
-    "ts-node": "^10.4.0",
-    "typescript-json-schema": "^0.53.0"
-  }
-}
+{
+  "name": "@dmdata/telegram-json-types",
+  "version": "1.1.0",
+  "scripts": {
+    "build:jschema": "npx tsc --project jschema/tsconfig.json",
+    "build:dist-jschema": "node ./dist/build.js",
+    "prepublishOnly": "npm run build:jschema && npm run build:dist-jschema",
+    "publish:npm": "npm version patch && npm publish --access=public",
+    "test": "jest",
+    "type-test": "npm run build:dist-jschema && npm run test"
+  },
+  "types": "index.d.ts",
+  "main": "./dist/jschema-load.js",
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^27.4.0",
+    "@types/node": "^14.18.9",
+    "@types/node-fetch": "^2.5.12",
+    "ajv": "^8.9.0",
+    "jest": "^27.4.7",
+    "node-fetch": "^2.6.7",
+    "ts-jest": "^27.1.3",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.5",
+    "typescript-json-schema": "^0.53.0"
+  }
+}

package/test/sample-schema-check.test.ts

@@ -0,0 +1,54 @@
+import Ajv from 'ajv';
+import fetch from 'node-fetch';
+import { getJSchema } from '../jschema/jschema-load';
+
+const checkSchemaTypes = [
+  'eew-information',
+  'earthquake-information',
+  'earthquake-explanation',
+  'earthquake-counts',
+  'earthquake-hypocenter-update',
+  'earthquake-nankai',
+  'tsunami-information',
+  'volcano-information',
+  'weather-information',
+  'weather-impact-society',
+  'weather-early',
+  'weather-warning',
+  'weather-tornado',
+  'weather-typhoon',
+  'weather-landslide',
+  'weather-river-flood'
+];
+
+const ajv = new Ajv({
+  strictTuples: false
+});
+
+test.each(checkSchemaTypes)('CheckSchemaType: %s', async schemaType => {
+  const sampleList = await getList(schemaType);
+
+  for (let i = 0; i < sampleList.length; i++) {
+    const url = sampleList[i];
+    const json: any = await fetch(url).then(res => res.json());
+    const schema = await getJSchema(json._schema.type, json._schema.version);
+    const validate = ajv.compile(schema);
+    const valid = validate(json);
+
+    console.group(url);
+    expect(validate.errors ?? []).toEqual([]);
+    console.groupEnd();
+  }
+});
+
+
+async function getList(schemaType: string) {
+  const url = `https://sample.dmdata.jp/conversion/json/schema/${schemaType}/`;
+  return await fetch(url).then(res => res.text())
+    .then(html => html
+      .replace(/^.+?<pre>.+?<hr>(.+?)<\/pre>.+?$/s, '$1')
+      .match(/<a\shref="(.+?)">/g)
+      ?.map(a => url + a.replace(/^<a\shref="(.+?)">$/, '$1'))
+      .filter(href => /\.json$/.test(href)) ?? []
+    );
+}

package/tsconfig.json

@@ -1,15 +1,28 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "target": "es2020",
-    "sourceMap": false,
-    "alwaysStrict": true,
-    "noImplicitThis": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "baseUrl": "./",
-  },
-}
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2020",
+    "sourceMap": false,
+    "alwaysStrict": true,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "baseUrl": "./",
+    "paths": {
+      "@t/*": [
+        "./types/*"
+      ]
+    }
+  },
+  "include": [
+    "types/**/*",
+    "test/**/*"
+  ],
+  "exclude": [
+    "jschema",
+    "node_modules"
+  ]
+}

package/types/component/code-name.ts

@@ -0,0 +1,4 @@
+export interface CodeName {
+  code: string;
+  name: string;
+}

package/types/{schema/component → component}/coordinate.d.ts

@@ -3,8 +3,8 @@ import { UnitValue } from './unit-value';
 export type Coordinate<Geo = never> = {
   latitude: { text: string, value: string };
   longitude: { text: string, value: string };
-  height?: UnitValue<'深さ', 'km'>;
-  condition: undefined;
+  height?: UnitValue<'高さ', 'm'>;
+  condition: never;
   geodeticSystem: Geo;
 } | {
   latitude: never;

package/types/{schema/component → component}/unit-value.d.ts

@@ -1,13 +1,13 @@
-export type UnitValue<Type = string, Unit = string, Condition = never> = {
-  type: Type;
-  unit: Unit;
-  value: string | null;
-  condition: Condition
-};
-
-export type UnitValueNotNull<Type = string, Unit = string, Condition = never> = {
-  type: Type;
-  unit: Unit;
-  value: string;
-  condition: Condition
-};
+export type UnitValue<Type = string, Unit = string, Condition = never> = {
+  type: Type;
+  unit: Unit;
+  value: string | null;
+  condition: Condition
+};
+
+export type UnitValueNotNull<Type = string, Unit = string, Condition = never> = {
+  type: Type;
+  unit: Unit;
+  value: string;
+  condition: Condition
+};

package/types/index.d.ts

@@ -1,4 +1,35 @@
-export * from './schema/eew-information';
-export * from './schema/earthquake-information';
-export * from './schema/tsunami-information';
-export * from './schema/weather-typhoon';
+import * as EarthquakeInformation from './schema/earthquake-information';
+import * as EarthquakeExplanation from './schema/earthquake-explanation';
+import * as EarthquakeCounts from './schema/earthquake-counts';
+import * as EarthquakeHypocenterUpdate from './schema/earthquake-hypocenter-update';
+import * as EarthquakeNankai from './schema/earthquake-nankai';
+import * as EewInformation from './schema/eew-information';
+import * as TsunamiInformation from './schema/tsunami-information';
+import * as VolcanoInformation from './schema/volcano-information';
+import * as WeatherInformation from './schema/weather-information';
+import * as WeatherImpactSociety from './schema/weather-impact-society';
+import * as WeatherEarly from './schema/weather-early';
+import * as WeatherWarning from './schema/weather-warning';
+import * as WeatherTornado from './schema/weather-tornado';
+import * as WeatherTyphoon from './schema/weather-typhoon';
+import * as WeatherLandslide from './schema/weather-landslide';
+import * as WeatherRiverFlood from './schema/weather-river-flood';
+
+export {
+  EarthquakeInformation,
+  EarthquakeExplanation,
+  EarthquakeCounts,
+  EarthquakeHypocenterUpdate,
+  EarthquakeNankai,
+  EewInformation,
+  TsunamiInformation,
+  VolcanoInformation,
+  WeatherInformation,
+  WeatherImpactSociety,
+  WeatherEarly,
+  WeatherWarning,
+  WeatherTornado,
+  WeatherTyphoon,
+  WeatherLandslide,
+  WeatherRiverFlood
+};

package/types/schema/earthquake-counts/1.0.0.d.ts

@@ -0,0 +1,69 @@
+import { TelegramJSONMain } from '@t/main';
+
+export namespace EarthquakeCounts {
+  export interface Schema {
+    type: 'earthquake-counts';
+    version: '1.0.0';
+  }
+
+  export interface EarthquakeCountTargetTime {
+    start: string;
+    end: string;
+  }
+
+  export interface EarthquakeCountValues {
+    all: string | null;
+    felt: string | null;
+  }
+
+  export interface EarthquakeCount {
+    type: '１時間地震回数' | '累積地震回数' | '地震回数';
+    targetTime: EarthquakeCountTargetTime;
+    values: EarthquakeCountValues;
+  }
+
+  export interface Comments {
+    free: string;
+  }
+
+  export interface PublicBody {
+    earthquakeCounts?: EarthquakeCount[];
+    nextAdvisory?: string;
+    text?: string;
+    comments?: Comments;
+  }
+
+  export interface CancelBody {
+    text: string;
+  }
+
+  export interface Public extends TelegramJSONMain {
+    _schema: Schema;
+    type: '地震回数に関する情報';
+    title: '地震回数に関する情報';
+    infoType: '発表' | '訂正';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: string;
+    infoKind: '地震回数情報';
+    body: PublicBody;
+  }
+
+  export interface Cancel extends TelegramJSONMain {
+    _schema: Schema;
+    type: '地震回数に関する情報';
+    title: '地震回数に関する情報';
+    infoType: '取消';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: string;
+    infoKind: '地震回数情報';
+    body: CancelBody;
+  }
+
+  export type Main = Public | Cancel;
+}

package/types/schema/earthquake-counts/index.d.ts

@@ -0,0 +1,7 @@
+import { EarthquakeCounts as v1_0_0 } from './1.0.0';
+
+
+export {
+  v1_0_0 as Latest,
+  v1_0_0
+};

package/types/schema/earthquake-explanation/1.0.0.d.ts

@@ -0,0 +1,57 @@
+import { TelegramJSONMain } from '@t/main';
+
+export namespace EarthquakeExplanation {
+  export interface Schema {
+    type: 'earthquake-explanation';
+    version: '1.0.0';
+  }
+
+  export interface Naming {
+    text: string;
+    en?: string;
+  }
+
+  export interface Comments {
+    free: string;
+  }
+
+  export interface PublicBody {
+    naming?: Naming;
+    text: string;
+    comments?: Comments;
+  }
+
+  export interface CancelBody {
+    text: string;
+  }
+
+  export interface Public extends TelegramJSONMain {
+    _schema: Schema;
+    type: '地震の活動状況等に関する情報';
+    title: '地震の活動状況等に関する情報';
+    infoType: '発表' | '訂正';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: null;
+    infoKind: '地震の活動状況等に関する情報';
+    body: PublicBody;
+  }
+
+  export interface Cancel extends TelegramJSONMain {
+    _schema: Schema;
+    type: '地震の活動状況等に関する情報';
+    title: '地震の活動状況等に関する情報';
+    infoType: '取消';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: null;
+    infoKind: '地震の活動状況等に関する情報';
+    body: CancelBody;
+  }
+
+  export type Main = Public | Cancel;
+}

package/types/schema/earthquake-explanation/index.d.ts

@@ -0,0 +1,7 @@
+import { EarthquakeExplanation as v1_0_0 } from './1.0.0';
+
+
+export {
+  v1_0_0 as Latest,
+  v1_0_0
+};

package/types/schema/earthquake-hypocenter-update/1.0.0.d.ts

@@ -0,0 +1,53 @@
+import { TelegramJSONMain } from '@t/main';
+import { Earthquake } from '@t/component/earthquake';
+
+export namespace EarthquakeHypocenterUpdate {
+  export interface Schema {
+    type: 'earthquake-hypocenter-update';
+    version: '1.0.0';
+  }
+
+  export interface Comments {
+    free: string;
+  }
+
+  export interface PublicBody {
+    earthquake: Earthquake;
+    text?: string;
+    comments?: Comments;
+  }
+
+  export interface CancelBody {
+    text: string;
+  }
+
+  export interface Public extends TelegramJSONMain {
+    _schema: Schema;
+    type: '顕著な地震の震源要素更新のお知らせ';
+    title: '顕著な地震の震源要素更新のお知らせ';
+    infoType: '発表' | '訂正';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: null;
+    infoKind: '震源要素更新のお知らせ';
+    body: PublicBody;
+  }
+
+  export interface Cancel extends TelegramJSONMain {
+    _schema: Schema;
+    type: '顕著な地震の震源要素更新のお知らせ';
+    title: '顕著な地震の震源要素更新のお知らせ';
+    infoType: '取消';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: null;
+    infoKind: '震源要素更新のお知らせ';
+    body: CancelBody;
+  }
+
+  export type Main = Public | Cancel;
+}

package/types/schema/earthquake-hypocenter-update/index.d.ts

@@ -0,0 +1,7 @@
+import { EarthquakeHypocenterUpdate as v1_0_0 } from './1.0.0';
+
+
+export {
+  v1_0_0 as Latest,
+  v1_0_0
+};

package/types/schema/earthquake-information/1.0.0.d.ts

@@ -0,0 +1,159 @@
+import { TelegramJSONMain } from '@t/main';
+import { CodeName } from '@t/component/code-name';
+import { Earthquake } from '@t/component/earthquake';
+
+export namespace EarthquakeInformation {
+  export interface Schema {
+    type: 'earthquake-information';
+    version: '1.0.0';
+  }
+
+  export type IntensityClass = '1' | '2' | '3' | '4' | '5-' | '5+' | '6-' | '6+' | '7';
+
+  export interface IntensityMaxInt extends CodeName {
+    maxInt: IntensityClass;
+  }
+
+  export interface IntensityMaxIntOnRevise extends CodeName {
+    maxInt?: IntensityClass;
+    revise?: '上方修正' | '追加';
+  }
+
+  export interface IntensityCity extends CodeName {
+    maxInt?: IntensityClass;
+    revise?: '上方修正' | '追加';
+    condition?: '震度５弱以上未入電';
+  }
+
+  export interface IntensityStation extends CodeName {
+    int: IntensityClass | '!5-';
+    revise?: '上方修正' | '追加';
+    condition?: '震度５弱以上未入電';
+  }
+
+  export type Comment = {
+    free?: string;
+    forecast?: {
+      text: string;
+      codes: string[];
+    };
+    var?: {
+      text: string;
+      codes: string[];
+    };
+  };
+
+
+  export interface IntensityVXSE51 {
+    maxInt: IntensityClass;
+    prefectures: IntensityMaxInt[];
+    regions: IntensityMaxInt[];
+  }
+
+  export interface IntensityVXSE53 {
+    maxInt: IntensityClass;
+    prefectures: IntensityMaxIntOnRevise[];
+    regions: IntensityMaxIntOnRevise[];
+    cities: IntensityCity[];
+    stations: IntensityStation[];
+  }
+
+
+  export interface PublicBodyVXSE51 {
+    intensity: IntensityVXSE51;
+    text?: string;
+    comments: Omit<Comment, 'var'>;
+  }
+
+  export interface PublicBodyVXSE52 {
+    earthquake: Earthquake;
+    text?: string;
+    comments: Omit<Comment, 'var'>;
+  }
+
+  export interface PublicBodyVXSE53 {
+    earthquake: Earthquake;
+    intensity?: IntensityVXSE53;
+    text?: string;
+    comments: Comment;
+  }
+
+  export interface PublicBodyVXZSE40 {
+    text: string;
+  }
+
+  export interface CancelBody {
+    text: string;
+  }
+
+  export interface PublicVXSE51 extends TelegramJSONMain {
+    _schema: Schema;
+    type: '震度速報';
+    title: '震度速報';
+    infoType: '発表' | '訂正';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: null;
+    infoKind: '震度速報';
+    body: PublicBodyVXSE51;
+  }
+
+  export interface PublicVXSE52 extends TelegramJSONMain {
+    _schema: Schema;
+    type: '震源に関する情報';
+    title: '震源に関する情報';
+    infoType: '発表' | '訂正';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: null;
+    infoKind: '震源速報';
+    body: PublicBodyVXSE52;
+  }
+
+  export interface PublicVXSE53 extends TelegramJSONMain {
+    _schema: Schema;
+    type: '震源・震度に関する情報';
+    title: '震源・震度情報' | '遠地地震に関する情報';
+    infoType: '発表' | '訂正';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: string;
+    infoKind: '地震情報';
+    body: PublicBodyVXSE53;
+  }
+
+  export interface PublicVZSE40 extends TelegramJSONMain {
+    _schema: Schema;
+    type: '地震・津波に関するお知らせ';
+    title: '地震・津波に関するお知らせ';
+    infoType: '発表' | '訂正';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    serialNo: null;
+    infoKind: '地震・津波に関するお知らせ';
+    body: PublicBodyVXZSE40;
+  }
+
+  export interface Cancel extends TelegramJSONMain {
+    _schema: Schema;
+    type: '震度速報' | '震源に関する情報' | '震源・震度に関する情報' | '地震・津波に関するお知らせ';
+    title: '震度速報' | '震源に関する情報' | '震源・震度情報' | '遠地地震に関する情報' | '地震・津波に関するお知らせ';
+    infoType: '取消';
+    targetDateTimeDubious: never;
+    targetDuration: never;
+    validDateTime: never;
+    eventId: string;
+    infoKind: '震度速報' | '震源速報' | '地震情報' | '地震・津波に関するお知らせ';
+    body: CancelBody;
+  }
+
+  export  type Main = (PublicVXSE51 | PublicVXSE52 | PublicVXSE53 | PublicVZSE40) | Cancel;
+}