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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Project DM-D.S.S (dmdata.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,26 @@
+# @dmdata/telegram-json-type
+
+## 概要
+DMDATA.JP が提供する [JSON Schema](https://dmdata.jp/doc/reference/conversion/json/) の、TypeScript型定義（作成中）を公開しています。
+
+## 使い方
+
+### インストール
+`$ npm i -D @dmdata/telegram-json-type`
+
+### 型の使用
+
+```:typescirpt
+import { EarthquakeInformation }  from '@dmdata/telegram-json-types';
+
+const data = await fetch('https://data.api.dmdata.jp/v1/...')
+      .then(res => res.json()) as Promise<EarthquakeInformation.Main>
+      
+```
+
+## 使える型定義
+
+* [EewInformation](https://dmdata.jp/doc/reference/conversion/json/schema/eew-information)
+* [EarthquakeInformation](https://dmdata.jp/doc/reference/conversion/json/schema/earthquake-information)
+* [TsunamiInformation](https://dmdata.jp/doc/reference/conversion/json/schema/tsunami-information)
+* [WeatherTyphoon](https://dmdata.jp/doc/reference/conversion/json/schema/weather-typhoon)

package/dist/build.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/build.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const promises_1 = require("fs/promises");
+const TJS = __importStar(require("typescript-json-schema"));
+const config_1 = require("./config");
+const settings = {
+    required: true,
+};
+const compilerOptions = {
+    strictNullChecks: true,
+};
+(0, promises_1.readdir)(config_1.basePath)
+    .then(files => programTypescript(files));
+async function programTypescript(files) {
+    const tsTypeFiles = files.filter(file => /\.ts$/.test(file));
+    const filepath = tsTypeFiles.map(file => (0, path_1.resolve)(config_1.basePath, file));
+    const program = TJS.getProgramFromFiles(filepath, compilerOptions);
+    const generator = TJS.buildGenerator(program, settings);
+    const objectMaps = tsTypeFiles.map(file => tsTypeFileName2TypeSymbolName(file));
+    await (0, promises_1.rm)(config_1.distDir, { recursive: true, force: true });
+    await (0, promises_1.mkdir)(config_1.distDir, { recursive: true });
+    for (let i = 0; i < objectMaps.length; i++) {
+        const { schemaName, typeName } = objectMaps[i];
+        console.log(`Build ok: ${schemaName}: ${typeName}`);
+        const schema = generator?.getSchemaForSymbol(typeName, true);
+        await (0, promises_1.writeFile)((0, path_1.resolve)(config_1.distDir, `${schemaName}.json`), JSON.stringify(schema, undefined, 4));
+    }
+    console.log('Build complete');
+}
+function tsTypeFileName2TypeSymbolName(file) {
+    const schemaName = file.replace(/^([\w-]+?)(\.d)?\.ts$/, '$1');
+    const nameScope = schemaName.replace(/-(\w)|(^\w)/g, (match, p1 = '', p2 = '') => `${p1}${p2}`.toUpperCase());
+    return {
+        schemaName,
+        typeName: nameScope + '.Main'
+    };
+}

package/dist/config.d.ts

@@ -0,0 +1,2 @@
+export declare const basePath: string;
+export declare const distDir: string;

package/dist/config.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.distDir = exports.basePath = void 0;
+const path_1 = require("path");
+exports.basePath = (0, path_1.resolve)(__dirname, '../types/schema/');
+exports.distDir = (0, path_1.resolve)(__dirname, '../dist/jschema/');