@cumulus/schemas 17.0.0 → 18.1.0

package/dist/generate-schemas.d.ts

@@ -6,7 +6,7 @@ declare type SchemaReplacements = {
  *
  * @param {string} schemaTemplatePath - Input schema template path
  * @param {string} schemaOutputPath - Path to write updated output schema
- * @param {Object} replacements
+ * @param {object} replacements
  *   Object map specifying values to replace in schema template
  * @returns {void}
  */
@@ -14,8 +14,8 @@ export declare function templateJsonSchema(schemaTemplatePath: string, schemaOut
 /**
  * Generate output JSON schema from template with file properties updated.
  *
- * @param {string} schemaTemplatePath - Input schema template path
- * @param {string} schemaOutputPath - Path to write updated output schema
+ * @param schemaTemplatePath - Input schema template path
+ * @param schemaOutputPath   - Path to write updated output schema
  * @returns {void}
  */
 export declare function templateJsonSchemaWithFiles(schemaTemplatePath: string, schemaOutputPath: string): void;

package/dist/generate-schemas.js

@@ -12,7 +12,7 @@ const filesJsonSchema = require('../files.schema.json');
  *
  * @param {string} schemaTemplatePath - Input schema template path
  * @param {string} schemaOutputPath - Path to write updated output schema
- * @param {Object} replacements
+ * @param {object} replacements
  *   Object map specifying values to replace in schema template
  * @returns {void}
  */
@@ -27,8 +27,8 @@ exports.templateJsonSchema = templateJsonSchema;
 /**
  * Generate output JSON schema from template with file properties updated.
  *
- * @param {string} schemaTemplatePath - Input schema template path
- * @param {string} schemaOutputPath - Path to write updated output schema
+ * @param schemaTemplatePath - Input schema template path
+ * @param schemaOutputPath   - Path to write updated output schema
  * @returns {void}
  */
 function templateJsonSchemaWithFiles(schemaTemplatePath, schemaOutputPath) {

package/dist/generate-task-schemas.js

@@ -4,17 +4,48 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
+const promises_1 = __importDefault(require("fs/promises"));
 const path_1 = __importDefault(require("path"));
-const { templateJsonSchemaWithFiles, } = require('./generate-schemas');
-const taskDirectory = process.argv[2];
-const command = process.argv[3];
-const taskSchemasDirectory = path_1.default.join(taskDirectory, 'schemas');
-if (command === 'files') {
-    const schemaTemplateFiles = fs_1.default.readdirSync(taskSchemasDirectory)
-        .filter((filename) => filename.endsWith('.template'));
-    schemaTemplateFiles.forEach((schemaTemplateFile) => {
-        templateJsonSchemaWithFiles(path_1.default.join(taskSchemasDirectory, schemaTemplateFile), path_1.default.join(taskSchemasDirectory, schemaTemplateFile.replace('.template', '')));
+const generate_schemas_1 = require("./generate-schemas");
+const generate_types_1 = __importDefault(require("./generate-types"));
+const TYPESCRIPT_OPTION = '--typescript';
+function parseOptions(taskDirectory, args) {
+    let tsFile;
+    if (args.includes(TYPESCRIPT_OPTION)) {
+        const position = args.indexOf(TYPESCRIPT_OPTION);
+        if (args.length <= position + 1) {
+            throw new Error('Missing filepath for typescript option');
+        }
+        tsFile = promises_1.default.open(path_1.default.join(taskDirectory, args[position + 1]), 'w');
+    }
+    return { tsFile };
+}
+async function runFilesCommand(taskDirectory, rawOptions) {
+    const taskSchemasDirectory = path_1.default.join(taskDirectory, 'schemas');
+    const options = parseOptions(taskDirectory, rawOptions);
+    const schemaFiles = await promises_1.default.readdir(taskSchemasDirectory);
+    schemaFiles.filter((filename) => filename.endsWith('.template'))
+        .forEach((schemaTemplateFile) => {
+        const inputFile = path_1.default.join(taskSchemasDirectory, schemaTemplateFile);
+        const outputFile = path_1.default.join(taskSchemasDirectory, schemaTemplateFile.replace('.template', ''));
+        (0, generate_schemas_1.templateJsonSchemaWithFiles)(inputFile, outputFile);
     });
+    if (options.tsFile) {
+        const outputFile = await options.tsFile;
+        await (0, generate_types_1.default)(taskSchemasDirectory, outputFile);
+    }
+}
+async function main() {
+    const taskDirectory = process.argv[2];
+    const command = process.argv[3];
+    const options = process.argv.slice(4);
+    switch (command) {
+        case 'files':
+            await runFilesCommand(taskDirectory, options);
+            return;
+        default:
+            console.error('Unknown command');
+    }
 }
+main();
 //# sourceMappingURL=generate-task-schemas.js.map

package/dist/generate-types.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import type { FileHandle } from 'fs/promises';
+export default function generateTypes(folderPath: string, outputFile: FileHandle): Promise<void>;
+//# sourceMappingURL=generate-types.d.ts.map

package/dist/generate-types.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const json_schema_to_typescript_1 = require("json-schema-to-typescript");
+const upperFirst_1 = __importDefault(require("lodash/upperFirst"));
+const camelCase_1 = __importDefault(require("lodash/camelCase"));
+const promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+const BANNER_COMMENT = `
+/**
+ * This file is generated using @cumulus/schema. Any modifications made to this file
+ * will be overwritten when the build script is rerun. Please do not modify this file.
+ */
+`;
+async function generateTypeFromFile(filePath, bannerComment) {
+    const rawSchema = await promises_1.default.readFile(filePath, { encoding: 'utf-8' });
+    const jsonSchema = JSON.parse(rawSchema);
+    if (!jsonSchema.title) {
+        throw new Error(`Must have a title defined in the JSONSchema defined in ${filePath}.`);
+    }
+    return await (0, json_schema_to_typescript_1.compile)(jsonSchema, (0, upperFirst_1.default)((0, camelCase_1.default)(jsonSchema.title)), {
+        additionalProperties: false,
+        bannerComment,
+    });
+}
+async function generateTypes(folderPath, outputFile) {
+    const schemaFiles = await promises_1.default.readdir(folderPath);
+    const types = await Promise.all(schemaFiles.filter((file) => /^\w+\.json$/.test(file))
+        .map((filePath, idx) => generateTypeFromFile(path_1.default.join(folderPath, filePath), idx === 0 ? BANNER_COMMENT : '')));
+    await promises_1.default.writeFile(outputFile, types.join('\n'));
+}
+exports.default = generateTypes;
+//# sourceMappingURL=generate-types.js.map

package/files.schema.json

@@ -0,0 +1,45 @@
+{
+  "type": "array",
+  "items": {
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "bucket",
+      "key"
+    ],
+    "properties": {
+      "bucket": {
+        "description": "Bucket where file is archived in S3",
+        "type": "string"
+      },
+      "checksum": {
+        "description": "Checksum value for file",
+        "type": "string"
+      },
+      "checksumType": {
+        "description": "Type of checksum (e.g. md5, sha256, etc)",
+        "type": "string"
+      },
+      "fileName": {
+        "description": "Name of file (e.g. file.txt)",
+        "type": "string"
+      },
+      "key": {
+        "description": "S3 Key for archived file",
+        "type": "string"
+      },
+      "size": {
+        "description": "Size of file (in bytes)",
+        "type": "number"
+      },
+      "source": {
+        "description": "Source URI of the file from origin system (e.g. S3, FTP, HTTP)",
+        "type": "string"
+      },
+      "type": {
+        "description": "Type of file (e.g. data, metadata, browse)",
+        "type": "string"
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/schemas",
-  "version": "17.0.0",
+  "version": "18.1.0",
   "description": "Helpers for managing Cumulus task schemas",
   "homepage": "https://github.com/nasa/cumulus/tree/master/packages/schemas",
   "repository": {
@@ -14,7 +14,8 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "*.schema.json"
   ],
   "scripts": {
     "clean": "git clean -d -x -e node_modules -f",
@@ -41,7 +42,9 @@
   "author": "Cumulus Authors",
   "license": "Apache-2.0",
   "dependencies": {
-    "json-templates": "^4.1.0"
+    "json-schema-to-typescript": "^13.0.2",
+    "json-templates": "^4.1.0",
+    "lodash": "^4.17.21"
   },
-  "gitHead": "a5acb591242a334a730cebd6159f3a88a466432b"
+  "gitHead": "8428a02e0903d8d303c7dd36215aa6a24906e07b"
 }