add comments, add setSchemaDefinitionsObject (#752)

Author: cscheid

packages/_json-validator/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@quarto/_json-validator",
   "private": true,
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "A validation library for JSON objects with an emphasis on good error messages.",
   "author": {
     "name": "Posit PBC"

packages/_json-validator/src/schema.ts

@@ -71,17 +71,33 @@ export function schemaExhaustiveCompletions(schema: Schema): boolean {
 
 const definitionsObject: Record<string, ConcreteSchema> = {};
 
+/**
+ * Check if a schema definition exists in the current definitions object.
+ * @param key - The key of the schema definition to check.
+ * @returns True if the schema definition exists, false otherwise.
+ */
 export function hasSchemaDefinition(key: string): boolean {
   return definitionsObject[key] !== undefined;
 }
 
+/**
+ * Get a schema definition by its key.
+ * @param key - The key of the schema definition to retrieve.
+ * @returns The schema definition corresponding to the key.
+ * @throws Error if the schema definition does not exist.
+ */
 export function getSchemaDefinition(key: string): ConcreteSchema {
   if (definitionsObject[key] === undefined) {
     throw new Error(`Schema ${key} not found.`);
   }
   return definitionsObject[key];
 }
 
+/**
+ * Set a schema definition in the current definitions object.
+ * @param schema - The schema definition to set.
+ * @throws Error if the schema does not have a $id property.
+ */
 export function setSchemaDefinition(schema: ConcreteSchema) {
   if (schema.$id === undefined) {
     throw new Error(
@@ -95,13 +111,27 @@ export function setSchemaDefinition(schema: ConcreteSchema) {
   }
 }
 
+/**
+ * Get the schema definitions object. This is a shallow copy of the current definitions.
+ * @returns A copy of the schema definitions object.
+ */
 export function getSchemaDefinitionsObject(): Record<
   string,
   ConcreteSchema
 > {
   return Object.assign({}, definitionsObject);
 }
 
+/**
+ * Set the schema definitions object. This will replace the existing definitions.
+ * @param newDefinitions - The new definitions to set.
+ */
+export function setSchemaDefinitionsObject(
+  newDefinitions: Record<string, ConcreteSchema>
+): void {
+  Object.assign(definitionsObject, newDefinitions);
+}
+
 export function expandAliasesFrom(
   lst: string[],
   defs: Record<string, string[]>,

packages/json-validator/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quarto/json-validator",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "A validation library for JSON objects with an emphasis on good error messages.",
   "author": {
     "name": "Posit PBC"

packages/json-validator/src/schema.ts

@@ -71,17 +71,33 @@ export function schemaExhaustiveCompletions(schema: Schema): boolean {
 
 const definitionsObject: Record<string, ConcreteSchema> = {};
 
+/**
+ * Check if a schema definition exists in the current definitions object.
+ * @param key - The key of the schema definition to check.
+ * @returns True if the schema definition exists, false otherwise.
+ */
 export function hasSchemaDefinition(key: string): boolean {
   return definitionsObject[key] !== undefined;
 }
 
+/**
+ * Get a schema definition by its key.
+ * @param key - The key of the schema definition to retrieve.
+ * @returns The schema definition corresponding to the key.
+ * @throws Error if the schema definition does not exist.
+ */
 export function getSchemaDefinition(key: string): ConcreteSchema {
   if (definitionsObject[key] === undefined) {
     throw new Error(`Schema ${key} not found.`);
   }
   return definitionsObject[key];
 }
 
+/**
+ * Set a schema definition in the current definitions object.
+ * @param schema - The schema definition to set.
+ * @throws Error if the schema does not have a $id property.
+ */
 export function setSchemaDefinition(schema: ConcreteSchema) {
   if (schema.$id === undefined) {
     throw new Error(
@@ -95,13 +111,27 @@ export function setSchemaDefinition(schema: ConcreteSchema) {
   }
 }
 
+/**
+ * Get the schema definitions object. This is a shallow copy of the current definitions.
+ * @returns A copy of the schema definitions object.
+ */
 export function getSchemaDefinitionsObject(): Record<
   string,
   ConcreteSchema
 > {
   return Object.assign({}, definitionsObject);
 }
 
+/**
+ * Set the schema definitions object. This will replace the existing definitions.
+ * @param newDefinitions - The new definitions to set.
+ */
+export function setSchemaDefinitionsObject(
+  newDefinitions: Record<string, ConcreteSchema>
+): void {
+  Object.assign(definitionsObject, newDefinitions);
+}
+
 export function expandAliasesFrom(
   lst: string[],
   defs: Record<string, string[]>,