@dmdata/telegram-json-types 1.0.9-jschema.1 → 1.1.1

package/jest.config.ts

@@ -0,0 +1,202 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "C:\\Users\\soshi\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls, instances and results before every test
+ // clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "\\\\node_modules\\\\",
+  //   "\\.pnp\\.[^\\\\]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+
+  roots: [
+    "<rootDir>/test"
+  ],
+
+  transform: {
+    "^.+\\.ts$": "ts-jest"
+  },
+};

package/package.json

@@ -1,21 +1,33 @@
-{
-  "name": "@dmdata/telegram-json-types",
-  "version": "1.0.9-jschema.1",
-  "scripts": {
-    "build:jschema": "npx tsc --project tsconfig.jschema.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"
-  },
-  "types": "index.d.ts",
-  "main": "./dist/jschema-load.js",
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "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.1",
+  "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"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pdmdss/telegram-json-types"
+  },
+  "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/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/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,11 +1,57 @@
 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 WeatherTyphoon 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';
+import { TelegramJSONMain } from './main';
+
+type All =
+  EarthquakeInformation.v1_0_0.Main |
+  EarthquakeInformation.v1_1_0.Main |
+  EarthquakeExplanation.v1_0_0.Main |
+  EarthquakeCounts.v1_0_0.Main |
+  EarthquakeHypocenterUpdate.v1_0_0.Main |
+  EarthquakeNankai.v1_0_0.Main |
+  EewInformation.v1_0_0.Main |
+  TsunamiInformation.v1_0_0.Main |
+  VolcanoInformation.v1_0_0.Main |
+  WeatherInformation.v1_0_0.Main |
+  WeatherImpactSociety.v1_0_0.Main |
+  WeatherEarly.v1_0_0.Main |
+  WeatherWarning.v1_0_0.Main |
+  WeatherTornado.v1_0_0.Main |
+  WeatherTyphoon.v1_0_0.Main |
+  WeatherLandslide.v1_0_0.Main |
+  WeatherRiverFlood.v1_0_0.Main;
 
 export {
   EarthquakeInformation,
+  EarthquakeExplanation,
+  EarthquakeCounts,
+  EarthquakeHypocenterUpdate,
+  EarthquakeNankai,
   EewInformation,
   TsunamiInformation,
-  WeatherTyphoon
+  VolcanoInformation,
+  WeatherInformation,
+  WeatherImpactSociety,
+  WeatherEarly,
+  WeatherWarning,
+  WeatherTornado,
+  WeatherTyphoon,
+  WeatherLandslide,
+  WeatherRiverFlood,
+  TelegramJSONMain,
+  All
 };

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
+};