feat(new tool): JSON To Schema

Convert JSON data to JSON Schema, MySQL DDL, Mongoose Schema, Google BigQuery schema or ClickHouse Table Schema

Author: sharevb

components.d.ts

@@ -109,6 +109,7 @@ declare module '@vue/runtime-core' {
     JsonDiff: typeof import('./src/tools/json-diff/json-diff.vue')['default']
     JsonMinify: typeof import('./src/tools/json-minify/json-minify.vue')['default']
     JsonToCsv: typeof import('./src/tools/json-to-csv/json-to-csv.vue')['default']
+    JsonToSchema: typeof import('./src/tools/json-to-schema/json-to-schema.vue')['default']
     JsonToToml: typeof import('./src/tools/json-to-toml/json-to-toml.vue')['default']
     JsonToYaml: typeof import('./src/tools/json-to-yaml-converter/json-to-yaml.vue')['default']
     JsonViewer: typeof import('./src/tools/json-viewer/json-viewer.vue')['default']

package.json

@@ -61,6 +61,7 @@
     "figlet": "^1.7.0",
     "figue": "^1.2.0",
     "fuse.js": "^6.6.2",
+    "generate-schema": "^2.6.0",
     "highlight.js": "^11.7.0",
     "iarna-toml-esm": "^3.0.5",
     "ibantools": "^4.3.3",

pnpm-lock.yaml

@@ -1,7 +1,8 @@
 import { useRouteQuery } from '@vueuse/router';
 import { computed } from 'vue';
+import { useStorage } from '@vueuse/core';
 
-export { useQueryParam };
+export { useQueryParam, useQueryParamOrStorage };
 
 const transformers = {
   number: {
@@ -16,6 +17,12 @@ const transformers = {
     fromQuery: (value: string) => value.toLowerCase() === 'true',
     toQuery: (value: boolean) => (value ? 'true' : 'false'),
   },
+  object: {
+    fromQuery: (value: string) => {
+      return JSON.parse(value);
+    },
+    toQuery: (value: object) => JSON.stringify(value),
+  },
 };
 
 function useQueryParam<T>({ name, defaultValue }: { name: string; defaultValue: T }) {
@@ -33,3 +40,27 @@ function useQueryParam<T>({ name, defaultValue }: { name: string; defaultValue:
     },
   });
 }
+
+function useQueryParamOrStorage<T>({ name, storageName, defaultValue }: { name: string; storageName: string; defaultValue: T }) {
+  const type = typeof defaultValue;
+  const transformer = transformers[type as keyof typeof transformers] ?? transformers.string;
+
+  const storageRef = useStorage(storageName, defaultValue);
+  const proxyDefaultValue = transformer.toQuery(defaultValue as never);
+  const proxy = useRouteQuery(name, proxyDefaultValue);
+
+  const r = ref(defaultValue);
+
+  watch(r,
+    (value) => {
+      proxy.value = transformer.toQuery(value as never);
+      storageRef.value = value as never;
+    },
+    { deep: true });
+
+  r.value = (proxy.value && proxy.value !== proxyDefaultValue
+    ? transformer.fromQuery(proxy.value) as unknown as T
+    : storageRef.value as T) as never;
+
+  return r;
+}

src/composable/queryParams.ts

@@ -6,6 +6,7 @@ import { tool as asciiTextDrawer } from './ascii-text-drawer';
 
 import { tool as textToUnicode } from './text-to-unicode';
 import { tool as safelinkDecoder } from './safelink-decoder';
+import { tool as jsonToSchema } from './json-to-schema';
 import { tool as pdfSignatureChecker } from './pdf-signature-checker';
 import { tool as numeronymGenerator } from './numeronym-generator';
 import { tool as macAddressGenerator } from './mac-address-generator';
@@ -148,6 +149,7 @@ export const toolsByCategory: ToolCategory[] = [
       dockerRunToDockerComposeConverter,
       xmlFormatter,
       yamlViewer,
+      jsonToSchema,
     ],
   },
   {

src/tools/index.ts

@@ -0,0 +1,8 @@
+declare module 'generate-schema' {
+    function generic(jsonObject: object);
+    function mongoose(jsonObject: object);
+    function bigquery(jsonObject: object);
+    function json(title: string, jsonObject: object);
+    function mysql(tableName: string, jsonObject: object);
+    function clickhouse(tableName: string, jsonObject: object, dateField: string);
+}

src/tools/json-to-schema/generate-schema.d.ts

@@ -0,0 +1,12 @@
+import { Braces } from '@vicons/tabler';
+import { defineTool } from '../tool';
+
+export const tool = defineTool({
+  name: 'Json to Schema',
+  path: '/json-to-schema',
+  description: 'Convert JSON data to JSON Schema, MySQL DDL, Mongoose Schema, Google BigQuery schema or ClickHouse Table Schema',
+  keywords: ['json', 'schema', 'mysql', 'sql', 'ddl', 'mongoose', 'bigquery', 'clickhouse', 'table'],
+  component: () => import('./json-to-schema.vue'),
+  icon: Braces,
+  createdAt: new Date('2024-05-11'),
+});

src/tools/json-to-schema/index.ts

@@ -0,0 +1,86 @@
+<script setup lang="ts">
+import JSON5 from 'json5';
+import GenerateSchema from 'generate-schema';
+import { withDefaultOnError } from '../../utils/defaults';
+import type { UseValidationRule } from '@/composable/validation';
+import { useQueryParamOrStorage } from '@/composable/queryParams';
+
+const formats = [
+  { value: 'generic', label: 'Generic' },
+  { value: 'json', label: 'JSON Schema' },
+  { value: 'mysql', label: 'MySQL Table Schema' },
+  { value: 'mongoose', label: 'Mongoose Schema' },
+  { value: 'bigquery', label: 'Google BigQuery schema' },
+  { value: 'clickhouse', label: 'ClickHouse Table Schema' },
+];
+
+const tableName = ref('TableName');
+const format = useQueryParamOrStorage({ name: 'fmt', storageName: 'json-to-schema:fmt', defaultValue: 'json' });
+
+function convertJsonToSchema(value: string) {
+  const object = JSON5.parse(value);
+  switch (format.value) {
+    case 'json':
+      return JSON.stringify(GenerateSchema.json(tableName.value, object), null, 2);
+    case 'mysql':
+      return GenerateSchema.mysql(tableName.value, object);
+    case 'mongoose':
+      return JSON.stringify(GenerateSchema.mongoose(object), null, 2);
+    case 'bigquery':
+      return JSON.stringify(GenerateSchema.bigquery(object), null, 2);
+    case 'clickhouse':
+      return JSON.stringify(GenerateSchema.clickhouse(tableName.value, object, 'theDateField'), null, 2);
+    default:
+      return JSON.stringify(GenerateSchema.generic(object), null, 2);
+  }
+}
+const transformer = (value: string) => value.trim() === '' ? '' : withDefaultOnError(() => convertJsonToSchema(value), '');
+const schemaLanguage = computed(() => {
+  switch (format.value) {
+    case 'mysql':
+      return 'sql';
+    case 'mongoose':
+      return 'json';
+    case 'bigquery':
+      return 'json';
+    case 'clickhouse':
+      return 'json';
+    default:
+      return 'json';
+  }
+});
+
+const rules: UseValidationRule<string>[] = [
+  {
+    validator: (v: string) => v === '' || JSON5.parse(v),
+    message: 'Provided JSON is not valid.',
+  },
+];
+</script>
+
+<template>
+  <div>
+    <c-select
+      v-model:value="format"
+      :options="formats"
+      placeholder="Target Schema format"
+    />
+    <c-input-text
+      v-if="['clickhouse', 'json', 'mysql'].includes(format)"
+      v-model:value="tableName"
+      label="Table Name"
+      placeholder="Table Name"
+      mb-2
+    />
+    <n-divider />
+
+    <format-transformer
+      input-label="Your JSON"
+      input-placeholder="Paste your JSON here..."
+      output-label="Your schema"
+      :output-language="schemaLanguage"
+      :input-validation-rules="rules"
+      :transformer="transformer"
+    />
+  </div>
+</template>