Add $id field to schema with versioned URL

.github/pull_request_template.md

@@ -0,0 +1,2 @@
+<!-- Thank you for your Pull Request! -->
+<!-- Please make sure your commit increments the package version in package.json, package-lock.json, and schema.json. -->

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nasa-jpl/seq-json-schema",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "license": "MIT",
   "type": "module",
   "repository": {
@@ -19,7 +19,7 @@
   },
   "devDependencies": {
     "ajv": "^8.12.0",
-    "json-schema-to-typescript": "^13.0.1",
+    "json-schema-to-typescript": "^13.0.2",
     "prettier": "^2.8.8"
   }
 }

schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "SeqJson",
+  "$id": "https://github.com/NASA-AMMOS/seq-json-schema/tree/v1.0.20",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$defs": {
     "activate": {

scripts/generate-types.js

@@ -7,14 +7,18 @@ import { writeFileSync } from 'fs';
  * @return {string}
  */
 function patchTypes(types) {
-  // Remove the 'Request1' object since the library  does not generate the
+  // Remove the 'Request1' object since the library does not generate the
   // correct type for the request 'oneOf' in the schema.
   // See: https://github.com/bcherny/json-schema-to-typescript/issues/381
   types = types.replace(/ \& Request1/, '');
   types = types.replace(
     `export type Request1 =\n  | {\n      [k: string]: unknown;\n    }\n  | {\n      [k: string]: unknown;\n    };\n`,
     '',
   );
+
+  // Update the main interface so the base type is named 'SeqJson'.
+  types = types.replace(/export interface HttpsGithubComNASAAMMOSSeqJsonSchemaTree.* {/, 'export interface SeqJson {');
+
   return types;
 }
 

setup.py

@@ -1,9 +1,15 @@
+from json import loads
 from pathlib import Path
 from setuptools import setup
 
 this_directory = Path(__file__).parent
 long_description = (this_directory / 'README.md').read_text()
 
+with open(this_directory / 'package.json', 'r') as f:
+  package_json = f.read()
+
+version = loads(package_json).get('version')
+
 setup(
   author='camargo',
   author_email='[email protected]',
@@ -14,5 +20,5 @@
   name='seq-json-schema',
   packages=['seq-json-schema'],
   url='https://github.com/NASA-AMMOS/seq-json-schema',
-  version='1.0.19'
+  version=version
 )