Query Pre-processing for JSON Schema Storage

I'm working on an app in which I need to store JSON Schemas:

interface JsonSchema {
  title?: string;
  type?: string;
  description?: string;
  properties?: Record<string, any>;
  required?: string[];
  additionalProperties?: boolean;
  definitions?: Record<string, any>;
  $defs?: Record<string, any>;
  $schema?: string;
  $id?: string;
  comment?: string;
  $ref?: string;
  allOf?: JsonSchema[];
  anyOf?: JsonSchema[];
  oneOf?: JsonSchema[];
  not?: JsonSchema;
  items?: JsonSchema | JsonSchema[];
}

interface JsonSchema {
  title?: string;
  type?: string;
  description?: string;
  properties?: Record<string, any>;
  required?: string[];
  additionalProperties?: boolean;
  definitions?: Record<string, any>;
  $defs?: Record<string, any>;
  $schema?: string;
  $id?: string;
  comment?: string;
  $ref?: string;
  allOf?: JsonSchema[];
  anyOf?: JsonSchema[];
  oneOf?: JsonSchema[];
  not?: JsonSchema;
  items?: JsonSchema | JsonSchema[];
}

My first instinct was to use an Object data-type, but because Convex disallows keys starting with $ that idea was out. So I figured I could just use some serialization in the handler to store the JSON Schemas as plain text:

handler: async (ctx, args) => {
    const now = Date.now();

    // Serialize the schemas
    const inputSchemaJson = JSON.stringify(args.inputSchema || {});
    const outputSchemaJson = JSON.stringify(args.outputSchema || {});

    // Create the model document with required fields
    const modelData: ModelDocument = {
      modelId: args.modelId,
      name: args.name,
      isPlaceholder: args.isPlaceholder,
      isSchemaPlaceholder: args.isSchemaPlaceholder,
      task: args.task,
      inputSchemaJson,
      outputSchemaJson,
      createdAt: now,
      updatedAt: now,
    };

handler: async (ctx, args) => {
    const now = Date.now();

    // Serialize the schemas
    const inputSchemaJson = JSON.stringify(args.inputSchema || {});
    const outputSchemaJson = JSON.stringify(args.outputSchema || {});

    // Create the model document with required fields
    const modelData: ModelDocument = {
      modelId: args.modelId,
      name: args.name,
      isPlaceholder: args.isPlaceholder,
      isSchemaPlaceholder: args.isSchemaPlaceholder,
      task: args.task,
      inputSchemaJson,
      outputSchemaJson,
      createdAt: now,
      updatedAt: now,
    };

But it seems like the handler is pre-validating the args and rejecting the JSON Schemas because of the keys that start with $. I'd love for this serialization to happen auto-magically when creating / retrieving records—is there a preprocessing hook or something I can tap into to coerce the args into an acceptable format?

2 Replies

Convex Bot•4w ago

Thanks for posting in <#1088161997662724167>. Reminder: If you have a Convex Pro account, use the Convex Dashboard to file support tickets. - Provide context: What are you trying to achieve, what is the end-user interaction, what are you seeing? (full error message, command output, etc.) - Use search.convex.dev to search Docs, Stack, and Discord all at once. - Additionally, you can post your questions in the Convex Community's <#1228095053885476985> channel to receive a response from AI. - Avoid tagging staff unless specifically instructed. Thank you!

erquhart•4w ago

Guessing modelData is the object you're inserting to the database? Can you confirm that the schema for the table you're inserting to has inputSchemaJson and outputSchemaJson field types set to string? And that npx convex dev is running successfully and not erroring so your schema changes are deployed.

Query Pre-processing for JSON Schema Storage

Did you find this page helpful?