@powerlines/schema 0.11.23 → 0.11.24

package/dist/extract.cjs

@@ -2,6 +2,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
 const require_type_checks = require('./type-checks.cjs');
 const require_jtd = require('./jtd.cjs');
+const require_persistence = require('./persistence.cjs');
 const require_reflection = require('./reflection.cjs');
 const require_resolve = require('./resolve.cjs');
 let defu = require("defu");
@@ -253,10 +254,10 @@ async function extractSchema(context, input, options = {}) {
 */
 async function extract(context, input, options = {}) {
 	if (require_type_checks.isExtractedSchema(input) || require_type_checks.isSchema(input)) return input;
+	let result;
 	const variant = extractVariant(input);
 	const hash = extractHash(variant, input);
-	const cacheFilePath = (0, _stryke_path_join.joinPaths)(context.cachePath, "schemas", `${hash}.json`);
-	let result;
+	const cacheFilePath = (0, _stryke_path_join.joinPaths)(require_persistence.getCacheDirectory(context), `${hash}.json`);
 	if (context.config.skipCache !== true && context.fs.existsSync(cacheFilePath)) {
 		const schema = await context.fs.read(cacheFilePath);
 		if (schema) result = {
@@ -267,7 +268,7 @@ async function extract(context, input, options = {}) {
 	}
 	result ??= await extractSchema(context, input, options);
 	if (!result?.schema) throw new Error(`Failed to extract a valid schema from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`);
-	if (context.config.skipCache !== true) await context.fs.write(cacheFilePath, JSON.stringify(result.schema));
+	if (context.config.skipCache !== true) await require_persistence.writeSchema(context, result);
 	return result;
 }
 

package/dist/extract.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"extract.d.cts","names":[],"sources":["../src/extract.ts"],"mappings":";;;;;;;;AAoEA;iBAAgB,WAAA,CACd,OAAA,EAAS,kBAAA,EACT,KAAA,EAAO,WAAW;;;;;;;;AAAA;AA8BpB;iBAAgB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,UAAA,EAAY,IAAA,GAAO,aAAA,CAAc,SAAA;;;;;;;;;;iBAiBnB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,MAAA,YAAkB,aAAA,CAAc,SAAA;;;;;;;;iBAsClB,sBAAA,CACd,KAAA,EAAO,iBAAA,GACN,mBAAmB;;;AA3DsB;AAiB5C;;;;iBAuEgB,cAAA,CAAe,KAAA,EAAO,WAAA,GAAc,kBAAkB;;;;;;;;;iBAgBhD,mBAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CAEpD,KAAA,EAAO,iBAAA,EACP,OAAA,GAAU,kBAAA,GACT,OAAA,CAAQ,aAAA,CAAc,SAAA;;;;;;;AA1FkB;AAsC3C;iBA6FgB,aAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,OAAA,EAAS,mBAAA,EAAqB,KAAA,EAAO,iBAAA,GAAoB,YAAA;;;;;;;AA7FrC;AA6BtB;;;;;;;;AAAsE;AAgBtE;;;;iBAgHsB,aAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,eAAA,CAAgB,SAAA;;;;;;;;;;;;;;;;;;;;;;;AAlHO;AAyClC;;;;;iBAoKsB,OAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,MAAA,CAAO,SAAA"}
+{"version":3,"file":"extract.d.cts","names":[],"sources":["../src/extract.ts"],"mappings":";;;;;;;;AAqEA;iBAAgB,WAAA,CACd,OAAA,EAAS,kBAAA,EACT,KAAA,EAAO,WAAW;;;;;;;;AAAA;AA8BpB;iBAAgB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,UAAA,EAAY,IAAA,GAAO,aAAA,CAAc,SAAA;;;;;;;;;;iBAiBnB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,MAAA,YAAkB,aAAA,CAAc,SAAA;;;;;;;;iBAsClB,sBAAA,CACd,KAAA,EAAO,iBAAA,GACN,mBAAmB;;;AA3DsB;AAiB5C;;;;iBAuEgB,cAAA,CAAe,KAAA,EAAO,WAAA,GAAc,kBAAkB;;;;;;;;;iBAgBhD,mBAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CAEpD,KAAA,EAAO,iBAAA,EACP,OAAA,GAAU,kBAAA,GACT,OAAA,CAAQ,aAAA,CAAc,SAAA;;;;;;;AA1FkB;AAsC3C;iBA6FgB,aAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,OAAA,EAAS,mBAAA,EAAqB,KAAA,EAAO,iBAAA,GAAoB,YAAA;;;;;;;AA7FrC;AA6BtB;;;;;;;;AAAsE;AAgBtE;;;;iBAgHsB,aAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,eAAA,CAAgB,SAAA;;;;;;;;;;;;;;;;;;;;;;;AAlHO;AAyClC;;;;;iBAoKsB,OAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,MAAA,CAAO,SAAA"}

package/dist/extract.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"extract.d.mts","names":[],"sources":["../src/extract.ts"],"mappings":";;;;;;;;AAoEA;iBAAgB,WAAA,CACd,OAAA,EAAS,kBAAA,EACT,KAAA,EAAO,WAAW;;;;;;;;AAAA;AA8BpB;iBAAgB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,UAAA,EAAY,IAAA,GAAO,aAAA,CAAc,SAAA;;;;;;;;;;iBAiBnB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,MAAA,YAAkB,aAAA,CAAc,SAAA;;;;;;;;iBAsClB,sBAAA,CACd,KAAA,EAAO,iBAAA,GACN,mBAAmB;;;AA3DsB;AAiB5C;;;;iBAuEgB,cAAA,CAAe,KAAA,EAAO,WAAA,GAAc,kBAAkB;;;;;;;;;iBAgBhD,mBAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CAEpD,KAAA,EAAO,iBAAA,EACP,OAAA,GAAU,kBAAA,GACT,OAAA,CAAQ,aAAA,CAAc,SAAA;;;;;;;AA1FkB;AAsC3C;iBA6FgB,aAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,OAAA,EAAS,mBAAA,EAAqB,KAAA,EAAO,iBAAA,GAAoB,YAAA;;;;;;;AA7FrC;AA6BtB;;;;;;;;AAAsE;AAgBtE;;;;iBAgHsB,aAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,eAAA,CAAgB,SAAA;;;;;;;;;;;;;;;;;;;;;;;AAlHO;AAyClC;;;;;iBAoKsB,OAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,MAAA,CAAO,SAAA"}
+{"version":3,"file":"extract.d.mts","names":[],"sources":["../src/extract.ts"],"mappings":";;;;;;;;AAqEA;iBAAgB,WAAA,CACd,OAAA,EAAS,kBAAA,EACT,KAAA,EAAO,WAAW;;;;;;;;AAAA;AA8BpB;iBAAgB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,UAAA,EAAY,IAAA,GAAO,aAAA,CAAc,SAAA;;;;;;;;;;iBAiBnB,iBAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,MAAA,YAAkB,aAAA,CAAc,SAAA;;;;;;;;iBAsClB,sBAAA,CACd,KAAA,EAAO,iBAAA,GACN,mBAAmB;;;AA3DsB;AAiB5C;;;;iBAuEgB,cAAA,CAAe,KAAA,EAAO,WAAA,GAAc,kBAAkB;;;;;;;;;iBAgBhD,mBAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CAEpD,KAAA,EAAO,iBAAA,EACP,OAAA,GAAU,kBAAA,GACT,OAAA,CAAQ,aAAA,CAAc,SAAA;;;;;;;AA1FkB;AAsC3C;iBA6FgB,aAAA,mBACI,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,EAAA,CACpD,OAAA,EAAS,mBAAA,EAAqB,KAAA,EAAO,iBAAA,GAAoB,YAAA;;;;;;;AA7FrC;AA6BtB;;;;;;;;AAAsE;AAgBtE;;;;iBAgHsB,aAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,eAAA,CAAgB,SAAA;;;;;;;;;;;;;;;;;;;;;;;AAlHO;AAyClC;;;;;iBAoKsB,OAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAE3B,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,OAAA,CAAQ,YAAA,IAChB,OAAA,CAAQ,MAAA,CAAO,SAAA"}

package/dist/extract.mjs

@@ -1,5 +1,6 @@
 import { isExtractedSchema, isJTDSchema, isSchema, isUntypedInput, isUntypedSchema } from "./type-checks.mjs";
 import { jsonSchemaToJtd } from "./jtd.mjs";
+import { getCacheDirectory, writeSchema } from "./persistence.mjs";
 import { reflectionToJsonSchema } from "./reflection.mjs";
 import { resolve } from "./resolve.mjs";
 import defu from "defu";
@@ -250,10 +251,10 @@ async function extractSchema(context, input, options = {}) {
 */
 async function extract(context, input, options = {}) {
 	if (isExtractedSchema(input) || isSchema(input)) return input;
+	let result;
 	const variant = extractVariant(input);
 	const hash = extractHash(variant, input);
-	const cacheFilePath = joinPaths(context.cachePath, "schemas", `${hash}.json`);
-	let result;
+	const cacheFilePath = joinPaths(getCacheDirectory(context), `${hash}.json`);
 	if (context.config.skipCache !== true && context.fs.existsSync(cacheFilePath)) {
 		const schema = await context.fs.read(cacheFilePath);
 		if (schema) result = {
@@ -264,7 +265,7 @@ async function extract(context, input, options = {}) {
 	}
 	result ??= await extractSchema(context, input, options);
 	if (!result?.schema) throw new Error(`Failed to extract a valid schema from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`);
-	if (context.config.skipCache !== true) await context.fs.write(cacheFilePath, JSON.stringify(result.schema));
+	if (context.config.skipCache !== true) await writeSchema(context, result);
 	return result;
 }
 

package/dist/extract.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"extract.mjs","names":["isSetObject","extractJsonSchemaZod"],"sources":["../src/extract.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { Context } from \"@powerlines/core\";\nimport { isTypeDefinition } from \"@powerlines/core\";\nimport { esbuildPlugin } from \"@powerlines/deepkit/esbuild-plugin\";\nimport { isType, stringifyType, Type } from \"@powerlines/deepkit/vendor/type\";\nimport { StandardJSONSchemaV1 } from \"@standard-schema/spec\";\nimport { murmurhash } from \"@stryke/hash\";\nimport {\n  isJsonSchemaObjectType,\n  isStandardJsonSchema,\n  JsonSchemaType\n} from \"@stryke/json\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport {\n  extractJsonSchema as extractJsonSchemaZod,\n  isZod3Type\n} from \"@stryke/zod\";\nimport defu from \"defu\";\nimport type { BuildOptions } from \"esbuild\";\nimport * as z3 from \"zod/v3\";\nimport { jsonSchemaToJtd } from \"./jtd\";\nimport { reflectionToJsonSchema } from \"./reflection\";\nimport { resolve } from \"./resolve\";\nimport {\n  isExtractedSchema,\n  isJTDSchema,\n  isSchema,\n  isUntypedInput,\n  isUntypedSchema\n} from \"./type-checks\";\nimport {\n  ExtractedSchema,\n  JsonSchemaLike,\n  JTDSchemaType,\n  Schema,\n  SchemaInput,\n  SchemaInputVariant,\n  SchemaMetadata,\n  SchemaSource,\n  SchemaSourceInput,\n  SchemaSourceVariant,\n  TypeDefinitionReference,\n  UntypedInputObject,\n  UntypedSchema\n} from \"./types\";\n\n/**\n * Creates a hash string for a given schema definition input. The function checks the type of the input and generates a hash based on its content. If the input is a Zod schema, it hashes the JSON representation of its internal definition. If the input is a Standard JSON Schema, it hashes the JSON representation of its internal standard schema. If the input is already a JSON Schema object, it hashes its JSON representation directly. If the input is a reflected Deepkit Type object, it hashes its JSON representation. The resulting hash string can be used for caching or comparison purposes.\n */\nexport function extractHash(\n  variant: SchemaInputVariant,\n  input: SchemaInput\n): string {\n  if (isSetString(input)) {\n    return murmurhash({ variant, input });\n  } else if (isSetObject(input)) {\n    if (isZod3Type(input)) {\n      return murmurhash({ variant, input: input._def });\n    } else if (isStandardJsonSchema(input)) {\n      return murmurhash({ variant, input: input[\"~standard\"] });\n    } else if (isJsonSchemaObjectType(input)) {\n      return murmurhash({ variant, input });\n    } else if (isType(input)) {\n      return murmurhash({ variant, input: stringifyType(input) });\n    }\n  }\n\n  throw new Error(\n    `Failed to create an input hash for the provided schema definition input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a reflected Deepkit Type object.`\n  );\n}\n\n/**\n * Converts a reflected Deepkit {@link @powerlines/deepkit/vendor/type#Type} into a JSON Schema (draft-07) representation.\n *\n * @remarks\n * This function delegates to an internal recursive walker that handles the full set of Deepkit reflection kinds.\n *\n * @param reflection - The reflected Deepkit Type to convert.\n * @returns A JSON Schema (draft-07) fragment representing the type, or `undefined` when no schema could be produced.\n */\nexport function extractReflection<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(reflection: Type): JTDSchemaType<TMetadata> | undefined {\n  if (!isType(reflection)) {\n    return undefined;\n  }\n\n  return reflectionToJsonSchema<TMetadata>(reflection);\n}\n\n/**\n * Extracts a JSON Type Definition (RFC 8927) schema from a given schema definition, if possible.\n *\n * @remarks\n * This function checks if the provided input is a Zod schema, a Standard JSON Schema, or already a JSON Schema object, extracts a JSON Schema fragment via the appropriate adapter (Zod and Standard Schema produce draft-07 fragments), and then converts that fragment into a valid JTD form suitable for AJV's JTD validator.\n *\n * @param schema - The schema definition to extract from. This can be a Zod schema, a Standard JSON Schema, or a JSON Schema object.\n * @returns The extracted JTD schema if successful, otherwise undefined.\n */\nexport function extractJsonSchema<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(schema: unknown): JTDSchemaType<TMetadata> | undefined {\n  if (\n    isSetObject(schema) &&\n    (isZod3Type(schema) ||\n      isStandardJsonSchema(schema) ||\n      isJsonSchemaObjectType(schema) ||\n      isUntypedInput(schema) ||\n      isUntypedSchema(schema))\n  ) {\n    let jsonSchema: unknown;\n    if (isZod3Type(schema)) {\n      jsonSchema = extractJsonSchemaZod(schema);\n    } else if (isStandardJsonSchema(schema)) {\n      jsonSchema = schema[\"~standard\"].jsonSchema.input({\n        target: \"draft-2020-12\"\n      });\n    } else if (isUntypedInput(schema)) {\n      jsonSchema = schema.$schema;\n    } else {\n      jsonSchema = schema;\n    }\n\n    const jtd = jsonSchemaToJtd<TMetadata>(jsonSchema as JsonSchemaLike);\n    if (jtd) {\n      return jtd;\n    }\n  }\n\n  return undefined;\n}\n\n/**\n * Extracts a schema definition from a given input object, which can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a reflected Deepkit Type object. The function checks the type of the input and attempts to extract the corresponding schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns a `Schema` containing the extracted schema and its variant if successful; otherwise, it throws an error.\n *\n * @param input - The input object to extract the schema definition from.\n * @returns A `Schema` containing the extracted schema and its variant if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport function extractResolvedVariant(\n  input: SchemaSourceInput\n): SchemaSourceVariant {\n  if (isSetObject(input)) {\n    if (isZod3Type(input)) {\n      return \"zod3\";\n    } else if (isStandardJsonSchema(input)) {\n      return \"standard-schema\";\n    } else if (isJTDSchema(input)) {\n      return \"jtd-schema\";\n    } else if (isJsonSchemaObjectType(input)) {\n      return \"json-schema\";\n    } else if (isType(input)) {\n      return \"reflection\";\n    } else if (isUntypedInput(input) || isUntypedSchema(input)) {\n      return \"untyped\";\n    }\n  }\n\n  throw new Error(\n    `Failed to determine the variant of the provided schema definition input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a reflected Deepkit Type object, or an Untyped schema.`\n  );\n}\n\n/**\n * Extracts a schema definition from a given input object, which can be a Zod schema, a Standard JSON Schema, a JSON Schema object, a reflected Deepkit Type object, or an Untyped schema. The function checks the type of the input and attempts to extract the corresponding schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns a `Schema` containing the extracted schema and its variant if successful; otherwise, it throws an error.\n *\n * @param input - The input object to extract the schema definition from.\n * @returns A `Schema` containing the extracted schema and its variant if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport function extractVariant(input: SchemaInput): SchemaInputVariant {\n  if (isSetString(input) || isTypeDefinition(input)) {\n    return \"type-definition\";\n  }\n\n  return extractResolvedVariant(input as SchemaSourceInput);\n}\n\n/**\n * Extracts a JSON Schema object from a given schema definition input. The input can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a reflected Deepkit Type object. The function checks the type of the input and attempts to extract the corresponding JSON Schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns the extracted JSON Schema if successful; otherwise, it throws an error.\n *\n * @param input - The schema definition input to extract the JSON Schema from. This can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a TypeScript type definition.\n * @param variant - The variant of the schema definition to extract.\n * @returns The extracted JSON Schema if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport async function extractSchemaSchema<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(\n  input: SchemaSourceInput,\n  variant?: SchemaInputVariant\n): Promise<JTDSchemaType<TMetadata>> {\n  if (isExtractedSchema<TMetadata>(input)) {\n    return input.schema;\n  }\n\n  const resolvedVariant = variant ?? extractResolvedVariant(input);\n\n  let schema: JTDSchemaType<TMetadata> | undefined;\n  if (\n    resolvedVariant === \"zod3\" ||\n    resolvedVariant === \"json-schema\" ||\n    resolvedVariant === \"standard-schema\" ||\n    resolvedVariant === \"untyped\"\n  ) {\n    const jsonSchema = extractJsonSchema<TMetadata>(input);\n    if (jsonSchema) {\n      schema = jsonSchemaToJtd<TMetadata>(jsonSchema);\n    }\n  } else if (resolvedVariant === \"reflection\") {\n    schema = extractReflection<TMetadata>(input as Type);\n  } else if (resolvedVariant === \"jtd-schema\") {\n    schema = input as JTDSchemaType<TMetadata>;\n  }\n\n  if (schema) {\n    return schema;\n  }\n\n  throw new Error(\n    `Failed to extract a valid schema from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`\n  );\n}\n\n/**\n * Extracts a schema definition from a given input object, which can be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object. The function checks the type of the input and attempts to extract the corresponding schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns a `Schema` containing the extracted schema and its variant if successful; otherwise, it throws an error.\n *\n * @param variant - The variant of the schema definition to extract.\n * @param input - The input object to extract the schema definition from.\n * @returns A `Schema` containing the extracted schema and its variant if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport function extractSource<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(variant: SchemaSourceVariant, input: SchemaSourceInput): SchemaSource {\n  if (variant === \"zod3\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"zod3\",\n      schema: input as z3.ZodTypeAny\n    };\n  } else if (variant === \"untyped\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"untyped\",\n      schema: input as UntypedInputObject | UntypedSchema\n    };\n  } else if (variant === \"standard-schema\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"standard-schema\",\n      schema: input as StandardJSONSchemaV1\n    };\n  } else if (variant === \"json-schema\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"json-schema\",\n      schema: input as JsonSchemaType\n    };\n  } else if (variant === \"reflection\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"reflection\",\n      schema: input as Type\n    };\n  } else if (variant === \"jtd-schema\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"jtd-schema\",\n      schema: input as JTDSchemaType<TMetadata>\n    };\n  }\n\n  throw new Error(\n    `Failed to extract source information from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`\n  );\n}\n\n/**\n * Resolves the provided entry points to their corresponding type definitions. The function accepts an array of entry points, which can be strings (file paths) or type definition objects. It processes each entry point, resolving file paths and glob patterns to find matching files. For each resolved file, it creates a type definition object and resolves it using the `resolveInput` function. The function returns an array of resolved entry type definitions.\n *\n * @example\n * ```ts\n * // Resolve a schema definition from a file path\n * const schema1 = await extractSchema(context, \"./schemas.ts#MySchema\");\n * // Resolve a schema definition from a JSON Schema object\n * const schema2 = await extractSchema(context, schemaObject);\n * // Resolve a schema definition from a Zod schema\n * const schema3 = await extractSchema(context, zodSchema);\n * // Resolve a schema definition from a reflected Deepkit Type object\n * const schema4 = await extractSchema(context, reflectionType);\n * ```\n *\n * @param context - The plugin context used for resolving the schema definition input.\n * @param input - The schema definition input to extract the JSON Schema from. This can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a TypeScript type definition.\n * @param options - Optional overrides for the ESBuild configuration used during resolution.\n * @returns A promise that resolves to a {@link ExtractedSchema} containing the extracted JSON Schema and its variant, or the bytecode if JSON Schema extraction is not possible.\n */\nexport async function extractSchema<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>,\n  TContext extends Context = Context\n>(\n  context: TContext,\n  input: SchemaInput,\n  options: Partial<BuildOptions> = {}\n): Promise<ExtractedSchema<TMetadata>> {\n  if (isExtractedSchema<TMetadata>(input)) {\n    return input;\n  }\n\n  if (isSchema<TMetadata>(input)) {\n    return {\n      ...input,\n      source: {\n        hash: extractHash(\"jtd-schema\", input.schema),\n        variant: \"jtd-schema\",\n        schema: input.schema\n      }\n    };\n  }\n\n  let source: SchemaSource;\n\n  const variant = extractVariant(input);\n  const hash = extractHash(variant, input);\n\n  if (variant === \"type-definition\") {\n    const resolved = await resolve<SchemaSourceInput>(\n      context,\n      input as TypeDefinitionReference,\n      defu(options, {\n        plugins: [\n          esbuildPlugin(context, {\n            reflection: \"default\",\n            level: \"all\"\n          })\n        ]\n      })\n    );\n\n    source = extractSource(extractResolvedVariant(resolved), resolved);\n  } else if (\n    [\n      \"json-schema\",\n      \"jtd-schema\",\n      \"standard-schema\",\n      \"zod3\",\n      \"untyped\",\n      \"reflection\"\n    ].includes(variant)\n  ) {\n    source = extractSource(variant, input as SchemaSourceInput);\n  } else {\n    throw new Error(\n      `Invalid schema definition input \"${\n        variant\n      }\". The variant must be one of \"type-definition\", \"json-schema\", \"jtd-schema\", \"standard-schema\", \"zod3\", \"untyped\", or \"reflection\".`\n    );\n  }\n\n  return {\n    variant,\n    source,\n    schema: await extractSchemaSchema<TMetadata>(source.schema, source.variant),\n    hash\n  };\n}\n\n/**\n * Resolves the provided entry points to their corresponding type definitions. The function accepts an array of entry points, which can be strings (file paths) or type definition objects. It processes each entry point, resolving file paths and glob patterns to find matching files. For each resolved file, it creates a type definition object and resolves it using the `resolveInput` function. The function returns an array of resolved entry type definitions.\n *\n * @example\n * ```ts\n * // Resolve a schema definition from a file path\n * const schema1 = await extract(context, \"./schemas.ts#MySchema\");\n * // Resolve a schema definition from a JSON Schema object\n * const schema2 = await extract(context, schemaObject);\n * // Resolve a schema definition from a Zod schema\n * const schema3 = await extract(context, zodSchema);\n * // Resolve a schema definition from a reflected Deepkit Type object\n * const schema4 = await extract(context, reflectionType);\n * ```\n *\n * @see https://github.com/colinhacks/zod\n * @see https://standardschema.dev/json-schema#what-schema-libraries-support-this-spec\n * @see https://json-schema.org/\n * @see https://ajv.js.org/json-type-definition.html\n * @see https://deepkit.io/en/documentation/runtime-types/reflection\n * @see https://github.com/unjs/untyped\n * @see https://www.typescriptlang.org/docs/handbook/2/types-from-types.html\n *\n * @param context - The {@link Context | context} used for resolving the {@link Schema | schema} definition input.\n * @param input - The input object or string to extract the {@link Schema | schema} from. This can be {@link TypeDefinitionReference | a string that references a Typescript module}, a [Zod v3 schema](https://github.com/colinhacks/zod), any type that adheres to [the Standard JSON Schema specification](https://standardschema.dev/json-schema#what-schema-libraries-support-this-spec), a [JSON Schema object](https://json-schema.org/), a [JTD schema object](https://ajv.js.org/json-type-definition.html), an [untyped schema](https://github.com/unjs/untyped), or a [TypeScript type reflection](https://deepkit.io/en/documentation/runtime-types/reflection).\n * @param options - Optional overrides for the [ESBuild configuration](https://esbuild.github.io/api/#general-options) used during resolution.\n * @returns A promise that resolves to a {@link Schema | schema} object parsed from the input.\n */\nexport async function extract<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>,\n  TContext extends Context = Context\n>(\n  context: TContext,\n  input: SchemaInput,\n  options: Partial<BuildOptions> = {}\n): Promise<Schema<TMetadata>> {\n  if (isExtractedSchema<TMetadata>(input) || isSchema<TMetadata>(input)) {\n    return input;\n  }\n\n  const variant = extractVariant(input);\n  const hash = extractHash(variant, input);\n  const cacheFilePath = joinPaths(context.cachePath, \"schemas\", `${hash}.json`);\n\n  let result: Schema<TMetadata> | undefined;\n  if (\n    context.config.skipCache !== true &&\n    context.fs.existsSync(cacheFilePath)\n  ) {\n    const schema = await context.fs.read(cacheFilePath);\n    if (schema) {\n      result = {\n        variant,\n        hash,\n        schema: JSON.parse(schema) as JTDSchemaType<TMetadata>\n      };\n    }\n  }\n\n  result ??= await extractSchema<TMetadata>(context, input, options);\n  if (!result?.schema) {\n    throw new Error(\n      `Failed to extract a valid schema from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`\n    );\n  }\n\n  if (context.config.skipCache !== true) {\n    await context.fs.write(cacheFilePath, JSON.stringify(result.schema));\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAoEA,SAAgB,YACd,SACA,OACQ;CACR,IAAI,YAAY,KAAK,GACnB,OAAO,WAAW;EAAE;EAAS;CAAM,CAAC;MAC/B,IAAIA,cAAY,KAAK,GAC1B;MAAI,WAAW,KAAK,GAClB,OAAO,WAAW;GAAE;GAAS,OAAO,MAAM;EAAK,CAAC;OAC3C,IAAI,qBAAqB,KAAK,GACnC,OAAO,WAAW;GAAE;GAAS,OAAO,MAAM;EAAa,CAAC;OACnD,IAAI,uBAAuB,KAAK,GACrC,OAAO,WAAW;GAAE;GAAS;EAAM,CAAC;OAC/B,IAAI,OAAO,KAAK,GACrB,OAAO,WAAW;GAAE;GAAS,OAAO,cAAc,KAAK;EAAE,CAAC;CAC5D;CAGF,MAAM,IAAI,MACR,4LACF;AACF;;;;;;;;;;AAWA,SAAgB,kBAEd,YAAwD;CACxD,IAAI,CAAC,OAAO,UAAU,GACpB;CAGF,OAAO,uBAAkC,UAAU;AACrD;;;;;;;;;;AAWA,SAAgB,kBAEd,QAAuD;CACvD,IACEA,cAAY,MAAM,MACjB,WAAW,MAAM,KAChB,qBAAqB,MAAM,KAC3B,uBAAuB,MAAM,KAC7B,eAAe,MAAM,KACrB,gBAAgB,MAAM,IACxB;EACA,IAAI;EACJ,IAAI,WAAW,MAAM,GACnB,aAAaC,oBAAqB,MAAM;OACnC,IAAI,qBAAqB,MAAM,GACpC,aAAa,OAAO,aAAa,WAAW,MAAM,EAChD,QAAQ,gBACV,CAAC;OACI,IAAI,eAAe,MAAM,GAC9B,aAAa,OAAO;OAEpB,aAAa;EAGf,MAAM,MAAM,gBAA2B,UAA4B;EACnE,IAAI,KACF,OAAO;CAEX;AAGF;;;;;;;;AASA,SAAgB,uBACd,OACqB;CACrB,IAAID,cAAY,KAAK,GACnB;MAAI,WAAW,KAAK,GAClB,OAAO;OACF,IAAI,qBAAqB,KAAK,GACnC,OAAO;OACF,IAAI,YAAY,KAAK,GAC1B,OAAO;OACF,IAAI,uBAAuB,KAAK,GACrC,OAAO;OACF,IAAI,OAAO,KAAK,GACrB,OAAO;OACF,IAAI,eAAe,KAAK,KAAK,gBAAgB,KAAK,GACvD,OAAO;CACT;CAGF,MAAM,IAAI,MACR,+MACF;AACF;;;;;;;;AASA,SAAgB,eAAe,OAAwC;CACrE,IAAI,YAAY,KAAK,KAAK,iBAAiB,KAAK,GAC9C,OAAO;CAGT,OAAO,uBAAuB,KAA0B;AAC1D;;;;;;;;;AAUA,eAAsB,oBAGpB,OACA,SACmC;CACnC,IAAI,kBAA6B,KAAK,GACpC,OAAO,MAAM;CAGf,MAAM,kBAAkB,WAAW,uBAAuB,KAAK;CAE/D,IAAI;CACJ,IACE,oBAAoB,UACpB,oBAAoB,iBACpB,oBAAoB,qBACpB,oBAAoB,WACpB;EACA,MAAM,aAAa,kBAA6B,KAAK;EACrD,IAAI,YACF,SAAS,gBAA2B,UAAU;CAElD,OAAO,IAAI,oBAAoB,cAC7B,SAAS,kBAA6B,KAAa;MAC9C,IAAI,oBAAoB,cAC7B,SAAS;CAGX,IAAI,QACF,OAAO;CAGT,MAAM,IAAI,MACR,8MACF;AACF;;;;;;;;;AAUA,SAAgB,cAEd,SAA8B,OAAwC;CACtE,IAAI,YAAY,QACd,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,WACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,mBACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,eACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,cACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,cACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;CAGF,MAAM,IAAI,MACR,kNACF;AACF;;;;;;;;;;;;;;;;;;;;;AAsBA,eAAsB,cAIpB,SACA,OACA,UAAiC,CAAC,GACG;CACrC,IAAI,kBAA6B,KAAK,GACpC,OAAO;CAGT,IAAI,SAAoB,KAAK,GAC3B,OAAO;EACL,GAAG;EACH,QAAQ;GACN,MAAM,YAAY,cAAc,MAAM,MAAM;GAC5C,SAAS;GACT,QAAQ,MAAM;EAChB;CACF;CAGF,IAAI;CAEJ,MAAM,UAAU,eAAe,KAAK;CACpC,MAAM,OAAO,YAAY,SAAS,KAAK;CAEvC,IAAI,YAAY,mBAAmB;EACjC,MAAM,WAAW,MAAM,QACrB,SACA,OACA,KAAK,SAAS,EACZ,SAAS,CACP,cAAc,SAAS;GACrB,YAAY;GACZ,OAAO;EACT,CAAC,CACH,EACF,CAAC,CACH;EAEA,SAAS,cAAc,uBAAuB,QAAQ,GAAG,QAAQ;CACnE,OAAO,IACL;EACE;EACA;EACA;EACA;EACA;EACA;CACF,EAAE,SAAS,OAAO,GAElB,SAAS,cAAc,SAAS,KAA0B;MAE1D,MAAM,IAAI,MACR,oCACE,QACD,qIACH;CAGF,OAAO;EACL;EACA;EACA,QAAQ,MAAM,oBAA+B,OAAO,QAAQ,OAAO,OAAO;EAC1E;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,eAAsB,QAIpB,SACA,OACA,UAAiC,CAAC,GACN;CAC5B,IAAI,kBAA6B,KAAK,KAAK,SAAoB,KAAK,GAClE,OAAO;CAGT,MAAM,UAAU,eAAe,KAAK;CACpC,MAAM,OAAO,YAAY,SAAS,KAAK;CACvC,MAAM,gBAAgB,UAAU,QAAQ,WAAW,WAAW,GAAG,KAAK,MAAM;CAE5E,IAAI;CACJ,IACE,QAAQ,OAAO,cAAc,QAC7B,QAAQ,GAAG,WAAW,aAAa,GACnC;EACA,MAAM,SAAS,MAAM,QAAQ,GAAG,KAAK,aAAa;EAClD,IAAI,QACF,SAAS;GACP;GACA;GACA,QAAQ,KAAK,MAAM,MAAM;EAC3B;CAEJ;CAEA,WAAW,MAAM,cAAyB,SAAS,OAAO,OAAO;CACjE,IAAI,CAAC,QAAQ,QACX,MAAM,IAAI,MACR,8MACF;CAGF,IAAI,QAAQ,OAAO,cAAc,MAC/B,MAAM,QAAQ,GAAG,MAAM,eAAe,KAAK,UAAU,OAAO,MAAM,CAAC;CAGrE,OAAO;AACT"}
+{"version":3,"file":"extract.mjs","names":["isSetObject","extractJsonSchemaZod"],"sources":["../src/extract.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { Context } from \"@powerlines/core\";\nimport { isTypeDefinition } from \"@powerlines/core\";\nimport { esbuildPlugin } from \"@powerlines/deepkit/esbuild-plugin\";\nimport { isType, stringifyType, Type } from \"@powerlines/deepkit/vendor/type\";\nimport { StandardJSONSchemaV1 } from \"@standard-schema/spec\";\nimport { murmurhash } from \"@stryke/hash\";\nimport {\n  isJsonSchemaObjectType,\n  isStandardJsonSchema,\n  JsonSchemaType\n} from \"@stryke/json\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport {\n  extractJsonSchema as extractJsonSchemaZod,\n  isZod3Type\n} from \"@stryke/zod\";\nimport defu from \"defu\";\nimport type { BuildOptions } from \"esbuild\";\nimport * as z3 from \"zod/v3\";\nimport { jsonSchemaToJtd } from \"./jtd\";\nimport { getCacheDirectory, writeSchema } from \"./persistence\";\nimport { reflectionToJsonSchema } from \"./reflection\";\nimport { resolve } from \"./resolve\";\nimport {\n  isExtractedSchema,\n  isJTDSchema,\n  isSchema,\n  isUntypedInput,\n  isUntypedSchema\n} from \"./type-checks\";\nimport {\n  ExtractedSchema,\n  JsonSchemaLike,\n  JTDSchemaType,\n  Schema,\n  SchemaInput,\n  SchemaInputVariant,\n  SchemaMetadata,\n  SchemaSource,\n  SchemaSourceInput,\n  SchemaSourceVariant,\n  TypeDefinitionReference,\n  UntypedInputObject,\n  UntypedSchema\n} from \"./types\";\n\n/**\n * Creates a hash string for a given schema definition input. The function checks the type of the input and generates a hash based on its content. If the input is a Zod schema, it hashes the JSON representation of its internal definition. If the input is a Standard JSON Schema, it hashes the JSON representation of its internal standard schema. If the input is already a JSON Schema object, it hashes its JSON representation directly. If the input is a reflected Deepkit Type object, it hashes its JSON representation. The resulting hash string can be used for caching or comparison purposes.\n */\nexport function extractHash(\n  variant: SchemaInputVariant,\n  input: SchemaInput\n): string {\n  if (isSetString(input)) {\n    return murmurhash({ variant, input });\n  } else if (isSetObject(input)) {\n    if (isZod3Type(input)) {\n      return murmurhash({ variant, input: input._def });\n    } else if (isStandardJsonSchema(input)) {\n      return murmurhash({ variant, input: input[\"~standard\"] });\n    } else if (isJsonSchemaObjectType(input)) {\n      return murmurhash({ variant, input });\n    } else if (isType(input)) {\n      return murmurhash({ variant, input: stringifyType(input) });\n    }\n  }\n\n  throw new Error(\n    `Failed to create an input hash for the provided schema definition input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a reflected Deepkit Type object.`\n  );\n}\n\n/**\n * Converts a reflected Deepkit {@link @powerlines/deepkit/vendor/type#Type} into a JSON Schema (draft-07) representation.\n *\n * @remarks\n * This function delegates to an internal recursive walker that handles the full set of Deepkit reflection kinds.\n *\n * @param reflection - The reflected Deepkit Type to convert.\n * @returns A JSON Schema (draft-07) fragment representing the type, or `undefined` when no schema could be produced.\n */\nexport function extractReflection<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(reflection: Type): JTDSchemaType<TMetadata> | undefined {\n  if (!isType(reflection)) {\n    return undefined;\n  }\n\n  return reflectionToJsonSchema<TMetadata>(reflection);\n}\n\n/**\n * Extracts a JSON Type Definition (RFC 8927) schema from a given schema definition, if possible.\n *\n * @remarks\n * This function checks if the provided input is a Zod schema, a Standard JSON Schema, or already a JSON Schema object, extracts a JSON Schema fragment via the appropriate adapter (Zod and Standard Schema produce draft-07 fragments), and then converts that fragment into a valid JTD form suitable for AJV's JTD validator.\n *\n * @param schema - The schema definition to extract from. This can be a Zod schema, a Standard JSON Schema, or a JSON Schema object.\n * @returns The extracted JTD schema if successful, otherwise undefined.\n */\nexport function extractJsonSchema<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(schema: unknown): JTDSchemaType<TMetadata> | undefined {\n  if (\n    isSetObject(schema) &&\n    (isZod3Type(schema) ||\n      isStandardJsonSchema(schema) ||\n      isJsonSchemaObjectType(schema) ||\n      isUntypedInput(schema) ||\n      isUntypedSchema(schema))\n  ) {\n    let jsonSchema: unknown;\n    if (isZod3Type(schema)) {\n      jsonSchema = extractJsonSchemaZod(schema);\n    } else if (isStandardJsonSchema(schema)) {\n      jsonSchema = schema[\"~standard\"].jsonSchema.input({\n        target: \"draft-2020-12\"\n      });\n    } else if (isUntypedInput(schema)) {\n      jsonSchema = schema.$schema;\n    } else {\n      jsonSchema = schema;\n    }\n\n    const jtd = jsonSchemaToJtd<TMetadata>(jsonSchema as JsonSchemaLike);\n    if (jtd) {\n      return jtd;\n    }\n  }\n\n  return undefined;\n}\n\n/**\n * Extracts a schema definition from a given input object, which can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a reflected Deepkit Type object. The function checks the type of the input and attempts to extract the corresponding schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns a `Schema` containing the extracted schema and its variant if successful; otherwise, it throws an error.\n *\n * @param input - The input object to extract the schema definition from.\n * @returns A `Schema` containing the extracted schema and its variant if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport function extractResolvedVariant(\n  input: SchemaSourceInput\n): SchemaSourceVariant {\n  if (isSetObject(input)) {\n    if (isZod3Type(input)) {\n      return \"zod3\";\n    } else if (isStandardJsonSchema(input)) {\n      return \"standard-schema\";\n    } else if (isJTDSchema(input)) {\n      return \"jtd-schema\";\n    } else if (isJsonSchemaObjectType(input)) {\n      return \"json-schema\";\n    } else if (isType(input)) {\n      return \"reflection\";\n    } else if (isUntypedInput(input) || isUntypedSchema(input)) {\n      return \"untyped\";\n    }\n  }\n\n  throw new Error(\n    `Failed to determine the variant of the provided schema definition input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a reflected Deepkit Type object, or an Untyped schema.`\n  );\n}\n\n/**\n * Extracts a schema definition from a given input object, which can be a Zod schema, a Standard JSON Schema, a JSON Schema object, a reflected Deepkit Type object, or an Untyped schema. The function checks the type of the input and attempts to extract the corresponding schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns a `Schema` containing the extracted schema and its variant if successful; otherwise, it throws an error.\n *\n * @param input - The input object to extract the schema definition from.\n * @returns A `Schema` containing the extracted schema and its variant if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport function extractVariant(input: SchemaInput): SchemaInputVariant {\n  if (isSetString(input) || isTypeDefinition(input)) {\n    return \"type-definition\";\n  }\n\n  return extractResolvedVariant(input as SchemaSourceInput);\n}\n\n/**\n * Extracts a JSON Schema object from a given schema definition input. The input can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a reflected Deepkit Type object. The function checks the type of the input and attempts to extract the corresponding JSON Schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns the extracted JSON Schema if successful; otherwise, it throws an error.\n *\n * @param input - The schema definition input to extract the JSON Schema from. This can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a TypeScript type definition.\n * @param variant - The variant of the schema definition to extract.\n * @returns The extracted JSON Schema if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport async function extractSchemaSchema<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(\n  input: SchemaSourceInput,\n  variant?: SchemaInputVariant\n): Promise<JTDSchemaType<TMetadata>> {\n  if (isExtractedSchema<TMetadata>(input)) {\n    return input.schema;\n  }\n\n  const resolvedVariant = variant ?? extractResolvedVariant(input);\n\n  let schema: JTDSchemaType<TMetadata> | undefined;\n  if (\n    resolvedVariant === \"zod3\" ||\n    resolvedVariant === \"json-schema\" ||\n    resolvedVariant === \"standard-schema\" ||\n    resolvedVariant === \"untyped\"\n  ) {\n    const jsonSchema = extractJsonSchema<TMetadata>(input);\n    if (jsonSchema) {\n      schema = jsonSchemaToJtd<TMetadata>(jsonSchema);\n    }\n  } else if (resolvedVariant === \"reflection\") {\n    schema = extractReflection<TMetadata>(input as Type);\n  } else if (resolvedVariant === \"jtd-schema\") {\n    schema = input as JTDSchemaType<TMetadata>;\n  }\n\n  if (schema) {\n    return schema;\n  }\n\n  throw new Error(\n    `Failed to extract a valid schema from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`\n  );\n}\n\n/**\n * Extracts a schema definition from a given input object, which can be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object. The function checks the type of the input and attempts to extract the corresponding schema based on its variant. If the input is a Zod schema, it extracts the JSON Schema using the `extractJsonSchema` function. If the input is a Standard JSON Schema, it retrieves the JSON Schema targeting draft-07. If the input is already a JSON Schema object, it uses it directly. If the input is a reflected Deepkit Type object, it extracts the schema using the `extractReflection` function. The function returns a `Schema` containing the extracted schema and its variant if successful; otherwise, it throws an error.\n *\n * @param variant - The variant of the schema definition to extract.\n * @param input - The input object to extract the schema definition from.\n * @returns A `Schema` containing the extracted schema and its variant if successful.\n * @throws An error if the input does not contain a valid schema definition.\n */\nexport function extractSource<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>\n>(variant: SchemaSourceVariant, input: SchemaSourceInput): SchemaSource {\n  if (variant === \"zod3\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"zod3\",\n      schema: input as z3.ZodTypeAny\n    };\n  } else if (variant === \"untyped\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"untyped\",\n      schema: input as UntypedInputObject | UntypedSchema\n    };\n  } else if (variant === \"standard-schema\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"standard-schema\",\n      schema: input as StandardJSONSchemaV1\n    };\n  } else if (variant === \"json-schema\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"json-schema\",\n      schema: input as JsonSchemaType\n    };\n  } else if (variant === \"reflection\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"reflection\",\n      schema: input as Type\n    };\n  } else if (variant === \"jtd-schema\") {\n    return {\n      hash: extractHash(variant, input),\n      variant: \"jtd-schema\",\n      schema: input as JTDSchemaType<TMetadata>\n    };\n  }\n\n  throw new Error(\n    `Failed to extract source information from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`\n  );\n}\n\n/**\n * Resolves the provided entry points to their corresponding type definitions. The function accepts an array of entry points, which can be strings (file paths) or type definition objects. It processes each entry point, resolving file paths and glob patterns to find matching files. For each resolved file, it creates a type definition object and resolves it using the `resolveInput` function. The function returns an array of resolved entry type definitions.\n *\n * @example\n * ```ts\n * // Resolve a schema definition from a file path\n * const schema1 = await extractSchema(context, \"./schemas.ts#MySchema\");\n * // Resolve a schema definition from a JSON Schema object\n * const schema2 = await extractSchema(context, schemaObject);\n * // Resolve a schema definition from a Zod schema\n * const schema3 = await extractSchema(context, zodSchema);\n * // Resolve a schema definition from a reflected Deepkit Type object\n * const schema4 = await extractSchema(context, reflectionType);\n * ```\n *\n * @param context - The plugin context used for resolving the schema definition input.\n * @param input - The schema definition input to extract the JSON Schema from. This can be a Zod schema, a Standard JSON Schema, a JSON Schema object, or a TypeScript type definition.\n * @param options - Optional overrides for the ESBuild configuration used during resolution.\n * @returns A promise that resolves to a {@link ExtractedSchema} containing the extracted JSON Schema and its variant, or the bytecode if JSON Schema extraction is not possible.\n */\nexport async function extractSchema<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>,\n  TContext extends Context = Context\n>(\n  context: TContext,\n  input: SchemaInput,\n  options: Partial<BuildOptions> = {}\n): Promise<ExtractedSchema<TMetadata>> {\n  if (isExtractedSchema<TMetadata>(input)) {\n    return input;\n  }\n\n  if (isSchema<TMetadata>(input)) {\n    return {\n      ...input,\n      source: {\n        hash: extractHash(\"jtd-schema\", input.schema),\n        variant: \"jtd-schema\",\n        schema: input.schema\n      }\n    };\n  }\n\n  let source: SchemaSource;\n\n  const variant = extractVariant(input);\n  const hash = extractHash(variant, input);\n\n  if (variant === \"type-definition\") {\n    const resolved = await resolve<SchemaSourceInput>(\n      context,\n      input as TypeDefinitionReference,\n      defu(options, {\n        plugins: [\n          esbuildPlugin(context, {\n            reflection: \"default\",\n            level: \"all\"\n          })\n        ]\n      })\n    );\n\n    source = extractSource(extractResolvedVariant(resolved), resolved);\n  } else if (\n    [\n      \"json-schema\",\n      \"jtd-schema\",\n      \"standard-schema\",\n      \"zod3\",\n      \"untyped\",\n      \"reflection\"\n    ].includes(variant)\n  ) {\n    source = extractSource(variant, input as SchemaSourceInput);\n  } else {\n    throw new Error(\n      `Invalid schema definition input \"${\n        variant\n      }\". The variant must be one of \"type-definition\", \"json-schema\", \"jtd-schema\", \"standard-schema\", \"zod3\", \"untyped\", or \"reflection\".`\n    );\n  }\n\n  return {\n    variant,\n    source,\n    schema: await extractSchemaSchema<TMetadata>(source.schema, source.variant),\n    hash\n  };\n}\n\n/**\n * Resolves the provided entry points to their corresponding type definitions. The function accepts an array of entry points, which can be strings (file paths) or type definition objects. It processes each entry point, resolving file paths and glob patterns to find matching files. For each resolved file, it creates a type definition object and resolves it using the `resolveInput` function. The function returns an array of resolved entry type definitions.\n *\n * @example\n * ```ts\n * // Resolve a schema definition from a file path\n * const schema1 = await extract(context, \"./schemas.ts#MySchema\");\n * // Resolve a schema definition from a JSON Schema object\n * const schema2 = await extract(context, schemaObject);\n * // Resolve a schema definition from a Zod schema\n * const schema3 = await extract(context, zodSchema);\n * // Resolve a schema definition from a reflected Deepkit Type object\n * const schema4 = await extract(context, reflectionType);\n * ```\n *\n * @see https://github.com/colinhacks/zod\n * @see https://standardschema.dev/json-schema#what-schema-libraries-support-this-spec\n * @see https://json-schema.org/\n * @see https://ajv.js.org/json-type-definition.html\n * @see https://deepkit.io/en/documentation/runtime-types/reflection\n * @see https://github.com/unjs/untyped\n * @see https://www.typescriptlang.org/docs/handbook/2/types-from-types.html\n *\n * @param context - The {@link Context | context} used for resolving the {@link Schema | schema} definition input.\n * @param input - The input object or string to extract the {@link Schema | schema} from. This can be {@link TypeDefinitionReference | a string that references a Typescript module}, a [Zod v3 schema](https://github.com/colinhacks/zod), any type that adheres to [the Standard JSON Schema specification](https://standardschema.dev/json-schema#what-schema-libraries-support-this-spec), a [JSON Schema object](https://json-schema.org/), a [JTD schema object](https://ajv.js.org/json-type-definition.html), an [untyped schema](https://github.com/unjs/untyped), or a [TypeScript type reflection](https://deepkit.io/en/documentation/runtime-types/reflection).\n * @param options - Optional overrides for the [ESBuild configuration](https://esbuild.github.io/api/#general-options) used during resolution.\n * @returns A promise that resolves to a {@link Schema | schema} object parsed from the input.\n */\nexport async function extract<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>,\n  TContext extends Context = Context\n>(\n  context: TContext,\n  input: SchemaInput,\n  options: Partial<BuildOptions> = {}\n): Promise<Schema<TMetadata>> {\n  if (isExtractedSchema<TMetadata>(input) || isSchema<TMetadata>(input)) {\n    return input;\n  }\n\n  let result: Schema<TMetadata> | undefined;\n\n  const variant = extractVariant(input);\n  const hash = extractHash(variant, input);\n\n  const cacheFilePath = joinPaths(getCacheDirectory(context), `${hash}.json`);\n  if (\n    context.config.skipCache !== true &&\n    context.fs.existsSync(cacheFilePath)\n  ) {\n    const schema = await context.fs.read(cacheFilePath);\n    if (schema) {\n      result = {\n        variant,\n        hash,\n        schema: JSON.parse(schema) as JTDSchemaType<TMetadata>\n      };\n    }\n  }\n\n  result ??= await extractSchema<TMetadata>(context, input, options);\n  if (!result?.schema) {\n    throw new Error(\n      `Failed to extract a valid schema from the provided input. The input must be a Zod schema, a Standard JSON Schema, a JSON Schema object, a JTD schema, an untyped schema, or a reflected Deepkit Type object.`\n    );\n  }\n\n  if (context.config.skipCache !== true) {\n    await writeSchema(context, result);\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAqEA,SAAgB,YACd,SACA,OACQ;CACR,IAAI,YAAY,KAAK,GACnB,OAAO,WAAW;EAAE;EAAS;CAAM,CAAC;MAC/B,IAAIA,cAAY,KAAK,GAC1B;MAAI,WAAW,KAAK,GAClB,OAAO,WAAW;GAAE;GAAS,OAAO,MAAM;EAAK,CAAC;OAC3C,IAAI,qBAAqB,KAAK,GACnC,OAAO,WAAW;GAAE;GAAS,OAAO,MAAM;EAAa,CAAC;OACnD,IAAI,uBAAuB,KAAK,GACrC,OAAO,WAAW;GAAE;GAAS;EAAM,CAAC;OAC/B,IAAI,OAAO,KAAK,GACrB,OAAO,WAAW;GAAE;GAAS,OAAO,cAAc,KAAK;EAAE,CAAC;CAC5D;CAGF,MAAM,IAAI,MACR,4LACF;AACF;;;;;;;;;;AAWA,SAAgB,kBAEd,YAAwD;CACxD,IAAI,CAAC,OAAO,UAAU,GACpB;CAGF,OAAO,uBAAkC,UAAU;AACrD;;;;;;;;;;AAWA,SAAgB,kBAEd,QAAuD;CACvD,IACEA,cAAY,MAAM,MACjB,WAAW,MAAM,KAChB,qBAAqB,MAAM,KAC3B,uBAAuB,MAAM,KAC7B,eAAe,MAAM,KACrB,gBAAgB,MAAM,IACxB;EACA,IAAI;EACJ,IAAI,WAAW,MAAM,GACnB,aAAaC,oBAAqB,MAAM;OACnC,IAAI,qBAAqB,MAAM,GACpC,aAAa,OAAO,aAAa,WAAW,MAAM,EAChD,QAAQ,gBACV,CAAC;OACI,IAAI,eAAe,MAAM,GAC9B,aAAa,OAAO;OAEpB,aAAa;EAGf,MAAM,MAAM,gBAA2B,UAA4B;EACnE,IAAI,KACF,OAAO;CAEX;AAGF;;;;;;;;AASA,SAAgB,uBACd,OACqB;CACrB,IAAID,cAAY,KAAK,GACnB;MAAI,WAAW,KAAK,GAClB,OAAO;OACF,IAAI,qBAAqB,KAAK,GACnC,OAAO;OACF,IAAI,YAAY,KAAK,GAC1B,OAAO;OACF,IAAI,uBAAuB,KAAK,GACrC,OAAO;OACF,IAAI,OAAO,KAAK,GACrB,OAAO;OACF,IAAI,eAAe,KAAK,KAAK,gBAAgB,KAAK,GACvD,OAAO;CACT;CAGF,MAAM,IAAI,MACR,+MACF;AACF;;;;;;;;AASA,SAAgB,eAAe,OAAwC;CACrE,IAAI,YAAY,KAAK,KAAK,iBAAiB,KAAK,GAC9C,OAAO;CAGT,OAAO,uBAAuB,KAA0B;AAC1D;;;;;;;;;AAUA,eAAsB,oBAGpB,OACA,SACmC;CACnC,IAAI,kBAA6B,KAAK,GACpC,OAAO,MAAM;CAGf,MAAM,kBAAkB,WAAW,uBAAuB,KAAK;CAE/D,IAAI;CACJ,IACE,oBAAoB,UACpB,oBAAoB,iBACpB,oBAAoB,qBACpB,oBAAoB,WACpB;EACA,MAAM,aAAa,kBAA6B,KAAK;EACrD,IAAI,YACF,SAAS,gBAA2B,UAAU;CAElD,OAAO,IAAI,oBAAoB,cAC7B,SAAS,kBAA6B,KAAa;MAC9C,IAAI,oBAAoB,cAC7B,SAAS;CAGX,IAAI,QACF,OAAO;CAGT,MAAM,IAAI,MACR,8MACF;AACF;;;;;;;;;AAUA,SAAgB,cAEd,SAA8B,OAAwC;CACtE,IAAI,YAAY,QACd,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,WACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,mBACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,eACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,cACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;MACK,IAAI,YAAY,cACrB,OAAO;EACL,MAAM,YAAY,SAAS,KAAK;EAChC,SAAS;EACT,QAAQ;CACV;CAGF,MAAM,IAAI,MACR,kNACF;AACF;;;;;;;;;;;;;;;;;;;;;AAsBA,eAAsB,cAIpB,SACA,OACA,UAAiC,CAAC,GACG;CACrC,IAAI,kBAA6B,KAAK,GACpC,OAAO;CAGT,IAAI,SAAoB,KAAK,GAC3B,OAAO;EACL,GAAG;EACH,QAAQ;GACN,MAAM,YAAY,cAAc,MAAM,MAAM;GAC5C,SAAS;GACT,QAAQ,MAAM;EAChB;CACF;CAGF,IAAI;CAEJ,MAAM,UAAU,eAAe,KAAK;CACpC,MAAM,OAAO,YAAY,SAAS,KAAK;CAEvC,IAAI,YAAY,mBAAmB;EACjC,MAAM,WAAW,MAAM,QACrB,SACA,OACA,KAAK,SAAS,EACZ,SAAS,CACP,cAAc,SAAS;GACrB,YAAY;GACZ,OAAO;EACT,CAAC,CACH,EACF,CAAC,CACH;EAEA,SAAS,cAAc,uBAAuB,QAAQ,GAAG,QAAQ;CACnE,OAAO,IACL;EACE;EACA;EACA;EACA;EACA;EACA;CACF,EAAE,SAAS,OAAO,GAElB,SAAS,cAAc,SAAS,KAA0B;MAE1D,MAAM,IAAI,MACR,oCACE,QACD,qIACH;CAGF,OAAO;EACL;EACA;EACA,QAAQ,MAAM,oBAA+B,OAAO,QAAQ,OAAO,OAAO;EAC1E;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,eAAsB,QAIpB,SACA,OACA,UAAiC,CAAC,GACN;CAC5B,IAAI,kBAA6B,KAAK,KAAK,SAAoB,KAAK,GAClE,OAAO;CAGT,IAAI;CAEJ,MAAM,UAAU,eAAe,KAAK;CACpC,MAAM,OAAO,YAAY,SAAS,KAAK;CAEvC,MAAM,gBAAgB,UAAU,kBAAkB,OAAO,GAAG,GAAG,KAAK,MAAM;CAC1E,IACE,QAAQ,OAAO,cAAc,QAC7B,QAAQ,GAAG,WAAW,aAAa,GACnC;EACA,MAAM,SAAS,MAAM,QAAQ,GAAG,KAAK,aAAa;EAClD,IAAI,QACF,SAAS;GACP;GACA;GACA,QAAQ,KAAK,MAAM,MAAM;EAC3B;CAEJ;CAEA,WAAW,MAAM,cAAyB,SAAS,OAAO,OAAO;CACjE,IAAI,CAAC,QAAQ,QACX,MAAM,IAAI,MACR,8MACF;CAGF,IAAI,QAAQ,OAAO,cAAc,MAC/B,MAAM,YAAY,SAAS,MAAM;CAGnC,OAAO;AACT"}

package/dist/index.cjs

@@ -5,6 +5,7 @@ const require_helpers = require('./helpers.cjs');
 const require_codegen = require('./codegen.cjs');
 const require_constants = require('./constants.cjs');
 const require_jtd = require('./jtd.cjs');
+const require_persistence = require('./persistence.cjs');
 const require_reflection = require('./reflection.cjs');
 const require_resolve = require('./resolve.cjs');
 const require_extract = require('./extract.cjs');
@@ -21,6 +22,8 @@ exports.extractSchemaSchema = require_extract.extractSchemaSchema;
 exports.extractSource = require_extract.extractSource;
 exports.extractVariant = require_extract.extractVariant;
 exports.generateCode = require_codegen.generateCode;
+exports.getCacheDirectory = require_persistence.getCacheDirectory;
+exports.getCacheFilePath = require_persistence.getCacheFilePath;
 exports.getProperties = require_helpers.getProperties;
 exports.isExtractedSchema = require_type_checks.isExtractedSchema;
 exports.isJTDSchema = require_type_checks.isJTDSchema;
@@ -31,9 +34,12 @@ exports.isUntypedInput = require_type_checks.isUntypedInput;
 exports.isUntypedSchema = require_type_checks.isUntypedSchema;
 exports.jsonSchemaToJtd = require_jtd.jsonSchemaToJtd;
 exports.mergeSchemas = require_helpers.mergeSchemas;
+exports.readSchema = require_persistence.readSchema;
+exports.readSchemaSafe = require_persistence.readSchemaSafe;
 exports.reflectionToJsonSchema = require_reflection.reflectionToJsonSchema;
 exports.resolve = require_resolve.resolve;
 exports.resolveModule = require_resolve.resolveModule;
 exports.resolveReflection = require_resolve.resolveReflection;
 exports.stringifyType = require_codegen.stringifyType;
-exports.stringifyValue = require_codegen.stringifyValue;
+exports.stringifyValue = require_codegen.stringifyValue;
+exports.writeSchema = require_persistence.writeSchema;

package/dist/index.d.cts

@@ -5,7 +5,8 @@ import { JTDTypes } from "./constants.cjs";
 import { extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant } from "./extract.cjs";
 import { getProperties, mergeSchemas } from "./helpers.cjs";
 import { jsonSchemaToJtd } from "./jtd.cjs";
+import { getCacheDirectory, getCacheFilePath, readSchema, readSchemaSafe, writeSchema } from "./persistence.cjs";
 import { reflectionToJsonSchema } from "./reflection.cjs";
 import { resolve, resolveModule, resolveReflection } from "./resolve.cjs";
 import { isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema } from "./type-checks.cjs";
-export { BaseSchemaSource, BundleOptions, ExtractedSchema, JTDNumberType, JTDSchemaObjectForm, JTDSchemaObjectType, JTDSchemaSchemaSource, JTDSchemaType, JTDStringType, JTDType, JTDTypes, JsonSchemaLike, JsonSchemaSchemaSource, ObjectSchema, ReflectionSchemaSource, Schema, SchemaInput, SchemaInputVariant, SchemaMetadata, SchemaSource, SchemaSourceInput, SchemaSourceVariant, StandardSchemaSchemaSource, TypeDefinitionReference, UntypedInputObject, UntypedSchema, UntypedSchemaSource, Zod3SchemaSource, bundle, extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant, generateCode, getProperties, isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema, jsonSchemaToJtd, mergeSchemas, reflectionToJsonSchema, resolve, resolveModule, resolveReflection, stringifyType, stringifyValue };
+export { BaseSchemaSource, BundleOptions, ExtractedSchema, JTDNumberType, JTDSchemaObjectForm, JTDSchemaObjectType, JTDSchemaSchemaSource, JTDSchemaType, JTDStringType, JTDType, JTDTypes, JsonSchemaLike, JsonSchemaSchemaSource, ObjectSchema, ReflectionSchemaSource, Schema, SchemaInput, SchemaInputVariant, SchemaMetadata, SchemaSource, SchemaSourceInput, SchemaSourceVariant, StandardSchemaSchemaSource, TypeDefinitionReference, UntypedInputObject, UntypedSchema, UntypedSchemaSource, Zod3SchemaSource, bundle, extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant, generateCode, getCacheDirectory, getCacheFilePath, getProperties, isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema, jsonSchemaToJtd, mergeSchemas, readSchema, readSchemaSafe, reflectionToJsonSchema, resolve, resolveModule, resolveReflection, stringifyType, stringifyValue, writeSchema };

package/dist/index.d.mts

@@ -5,7 +5,8 @@ import { JTDTypes } from "./constants.mjs";
 import { extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant } from "./extract.mjs";
 import { getProperties, mergeSchemas } from "./helpers.mjs";
 import { jsonSchemaToJtd } from "./jtd.mjs";
+import { getCacheDirectory, getCacheFilePath, readSchema, readSchemaSafe, writeSchema } from "./persistence.mjs";
 import { reflectionToJsonSchema } from "./reflection.mjs";
 import { resolve, resolveModule, resolveReflection } from "./resolve.mjs";
 import { isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema } from "./type-checks.mjs";
-export { BaseSchemaSource, BundleOptions, ExtractedSchema, JTDNumberType, JTDSchemaObjectForm, JTDSchemaObjectType, JTDSchemaSchemaSource, JTDSchemaType, JTDStringType, JTDType, JTDTypes, JsonSchemaLike, JsonSchemaSchemaSource, ObjectSchema, ReflectionSchemaSource, Schema, SchemaInput, SchemaInputVariant, SchemaMetadata, SchemaSource, SchemaSourceInput, SchemaSourceVariant, StandardSchemaSchemaSource, TypeDefinitionReference, UntypedInputObject, UntypedSchema, UntypedSchemaSource, Zod3SchemaSource, bundle, extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant, generateCode, getProperties, isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema, jsonSchemaToJtd, mergeSchemas, reflectionToJsonSchema, resolve, resolveModule, resolveReflection, stringifyType, stringifyValue };
+export { BaseSchemaSource, BundleOptions, ExtractedSchema, JTDNumberType, JTDSchemaObjectForm, JTDSchemaObjectType, JTDSchemaSchemaSource, JTDSchemaType, JTDStringType, JTDType, JTDTypes, JsonSchemaLike, JsonSchemaSchemaSource, ObjectSchema, ReflectionSchemaSource, Schema, SchemaInput, SchemaInputVariant, SchemaMetadata, SchemaSource, SchemaSourceInput, SchemaSourceVariant, StandardSchemaSchemaSource, TypeDefinitionReference, UntypedInputObject, UntypedSchema, UntypedSchemaSource, Zod3SchemaSource, bundle, extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant, generateCode, getCacheDirectory, getCacheFilePath, getProperties, isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema, jsonSchemaToJtd, mergeSchemas, readSchema, readSchemaSafe, reflectionToJsonSchema, resolve, resolveModule, resolveReflection, stringifyType, stringifyValue, writeSchema };

package/dist/index.mjs

@@ -4,8 +4,9 @@ import { getProperties, mergeSchemas } from "./helpers.mjs";
 import { generateCode, stringifyType, stringifyValue } from "./codegen.mjs";
 import { JTDTypes } from "./constants.mjs";
 import { jsonSchemaToJtd } from "./jtd.mjs";
+import { getCacheDirectory, getCacheFilePath, readSchema, readSchemaSafe, writeSchema } from "./persistence.mjs";
 import { reflectionToJsonSchema } from "./reflection.mjs";
 import { resolve, resolveModule, resolveReflection } from "./resolve.mjs";
 import { extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant } from "./extract.mjs";
 
-export { JTDTypes, bundle, extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant, generateCode, getProperties, isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema, jsonSchemaToJtd, mergeSchemas, reflectionToJsonSchema, resolve, resolveModule, resolveReflection, stringifyType, stringifyValue };
+export { JTDTypes, bundle, extract, extractHash, extractJsonSchema, extractReflection, extractResolvedVariant, extractSchema, extractSchemaSchema, extractSource, extractVariant, generateCode, getCacheDirectory, getCacheFilePath, getProperties, isExtractedSchema, isJTDSchema, isJTDSchemaObject, isObjectSchema, isSchema, isUntypedInput, isUntypedSchema, jsonSchemaToJtd, mergeSchemas, readSchema, readSchemaSafe, reflectionToJsonSchema, resolve, resolveModule, resolveReflection, stringifyType, stringifyValue, writeSchema };

package/dist/persistence.cjs

@@ -0,0 +1,76 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
+const require_type_checks = require('./type-checks.cjs');
+const require_extract = require('./extract.cjs');
+let _stryke_path_join = require("@stryke/path/join");
+
+//#region src/persistence.ts
+/**
+* A helper function to get the cache directory path for storing schemas. This function takes a context object as input and returns the path to the cache directory where schemas are stored. The cache directory is constructed by joining the `cachePath` property from the context with a subdirectory named "schemas". This function is useful for centralizing the logic for determining where schema files should be cached, ensuring that all schema-related file operations use a consistent location for storing and retrieving cached schemas.
+*
+* @param context - The context object providing access to the cache path.
+* @returns The path to the cache directory for storing schemas, constructed by joining the context's `cachePath` with the "schemas" subdirectory.
+*/
+function getCacheDirectory(context) {
+	return (0, _stryke_path_join.joinPaths)(context.cachePath, "schemas");
+}
+/**
+* A helper function to get the file path for a cached schema based on the provided context and schema input. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file by joining the cache directory path (obtained from the `getCacheDirectory` function) with a filename derived from the extracted hash. The resulting file path points to where the cached schema should be stored or retrieved from in the file system. This function is essential for ensuring that all operations related to caching schemas use a consistent method for determining the correct file path based on the schema's unique identifier (hash).
+*
+* @param context - The context object providing access to the cache path.
+* @param input - The input schema from which to extract the variant and hash for constructing the cache file path.
+* @returns The file path to the cached schema JSON file, constructed by joining the cache directory path with a filename derived from the extracted hash of the schema input.
+*/
+function getCacheFilePath(context, input) {
+	const hash = require_extract.extractHash(require_extract.extractVariant(input), input);
+	return (0, _stryke_path_join.joinPaths)(getCacheDirectory(context), `${hash}.json`);
+}
+/**
+* Writes a given schema to the file system using the provided context. This function first checks if the input is a valid schema using the `isSchema` type guard. If the input is not a valid schema, it throws an error indicating that the provided input is invalid. If the input is valid, it proceeds to write the schema to a JSON file in the cache directory specified by the context. The file is named using the hash of the schema to ensure uniqueness and easy retrieval in future operations. The schema is serialized to JSON format before being written to the file system. This function is asynchronous and returns a promise that resolves once the writing operation is complete.
+*
+* @param context - The context object providing access to the file system and cache path.
+* @param schema - The schema to be written to the file system, which must be a valid schema object containing a `variant`, `schema`, and `hash` property.
+* @throws Will throw an error if the provided input is not a valid schema.
+*/
+async function writeSchema(context, schema) {
+	if (!require_type_checks.isSchema(schema)) throw new Error(`The provided input is not a valid schema. A valid schema must have a "variant" property indicating the type of the input and a "schema" property containing the parsed JTD schema object.`);
+	await context.fs.write(getCacheFilePath(context, schema), JSON.stringify(schema.schema));
+}
+/**
+* A helper function to read a schema from the file system using the provided context. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file based on the cache path provided in the context and the extracted hash. The function checks if the file exists in the cache; if it does not exist, it returns `undefined`. If the file exists, it reads the contents of the file, parses it as JSON, and returns the resulting object. This function is asynchronous and returns a promise that resolves to either the parsed schema object or `undefined` if the schema is not found in the cache.
+*
+* @param context - The context object providing access to the file system and cache path.
+* @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+* @returns A promise that resolves to the parsed schema object if found in the cache, or `undefined` if the schema does not exist in the cache.
+*/
+async function readSchemaSafe(context, input) {
+	const cacheFilePath = getCacheFilePath(context, input);
+	if (!await context.fs.exists(cacheFilePath)) return;
+	const data = await context.fs.read(cacheFilePath);
+	if (!data) return;
+	return JSON.parse(data);
+}
+/**
+* Reads a schema from the file system using the provided context and input. This function first attempts to read the schema using the `readSchemaSafe` helper function, which returns `undefined` if the schema is not found in the cache. If the schema is not found, this function throws an error indicating that the schema with the specified variant and hash does not exist in the cache. The error message suggests that this may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. It advises ensuring that the schema is properly written to the cache before attempting to read it. If the schema is successfully read from the cache, it is returned as a parsed object. This function is asynchronous and returns a promise that resolves to the parsed schema object if found, or throws an error if the schema is not found in the cache.
+*
+* @param context - The context object providing access to the file system and cache path.
+* @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+* @returns A promise that resolves to the parsed schema object if found in the cache, or throws an error if the schema does not exist in the cache.
+* @throws Will throw an error if the schema with the specified variant and hash does not exist in the cache.
+*/
+async function readSchema(context, input) {
+	const schema = await readSchemaSafe(context, input);
+	if (!schema) {
+		const variant = require_extract.extractVariant(input);
+		const hash = require_extract.extractHash(variant, input);
+		throw new Error(`The ${variant} schema with hash "${hash}" does not exist in the cache. This may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. Please ensure that the schema is properly written to the cache before attempting to read it.`);
+	}
+	return schema;
+}
+
+//#endregion
+exports.getCacheDirectory = getCacheDirectory;
+exports.getCacheFilePath = getCacheFilePath;
+exports.readSchema = readSchema;
+exports.readSchemaSafe = readSchemaSafe;
+exports.writeSchema = writeSchema;

package/dist/persistence.d.cts

@@ -0,0 +1,47 @@
+import { Schema, SchemaInput, SchemaMetadata } from "./types.cjs";
+import { Context } from "@powerlines/core";
+
+//#region src/persistence.d.ts
+/**
+ * A helper function to get the cache directory path for storing schemas. This function takes a context object as input and returns the path to the cache directory where schemas are stored. The cache directory is constructed by joining the `cachePath` property from the context with a subdirectory named "schemas". This function is useful for centralizing the logic for determining where schema files should be cached, ensuring that all schema-related file operations use a consistent location for storing and retrieving cached schemas.
+ *
+ * @param context - The context object providing access to the cache path.
+ * @returns The path to the cache directory for storing schemas, constructed by joining the context's `cachePath` with the "schemas" subdirectory.
+ */
+declare function getCacheDirectory(context: Context): string;
+/**
+ * A helper function to get the file path for a cached schema based on the provided context and schema input. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file by joining the cache directory path (obtained from the `getCacheDirectory` function) with a filename derived from the extracted hash. The resulting file path points to where the cached schema should be stored or retrieved from in the file system. This function is essential for ensuring that all operations related to caching schemas use a consistent method for determining the correct file path based on the schema's unique identifier (hash).
+ *
+ * @param context - The context object providing access to the cache path.
+ * @param input - The input schema from which to extract the variant and hash for constructing the cache file path.
+ * @returns The file path to the cached schema JSON file, constructed by joining the cache directory path with a filename derived from the extracted hash of the schema input.
+ */
+declare function getCacheFilePath(context: Context, input: SchemaInput): string;
+/**
+ * Writes a given schema to the file system using the provided context. This function first checks if the input is a valid schema using the `isSchema` type guard. If the input is not a valid schema, it throws an error indicating that the provided input is invalid. If the input is valid, it proceeds to write the schema to a JSON file in the cache directory specified by the context. The file is named using the hash of the schema to ensure uniqueness and easy retrieval in future operations. The schema is serialized to JSON format before being written to the file system. This function is asynchronous and returns a promise that resolves once the writing operation is complete.
+ *
+ * @param context - The context object providing access to the file system and cache path.
+ * @param schema - The schema to be written to the file system, which must be a valid schema object containing a `variant`, `schema`, and `hash` property.
+ * @throws Will throw an error if the provided input is not a valid schema.
+ */
+declare function writeSchema<TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>, TContext extends Context = Context>(context: TContext, schema: Schema<TMetadata>): Promise<void>;
+/**
+ * A helper function to read a schema from the file system using the provided context. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file based on the cache path provided in the context and the extracted hash. The function checks if the file exists in the cache; if it does not exist, it returns `undefined`. If the file exists, it reads the contents of the file, parses it as JSON, and returns the resulting object. This function is asynchronous and returns a promise that resolves to either the parsed schema object or `undefined` if the schema is not found in the cache.
+ *
+ * @param context - The context object providing access to the file system and cache path.
+ * @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+ * @returns A promise that resolves to the parsed schema object if found in the cache, or `undefined` if the schema does not exist in the cache.
+ */
+declare function readSchemaSafe<TContext extends Context = Context, TMetadata extends SchemaMetadata = SchemaMetadata>(context: TContext, input: SchemaInput): Promise<Schema<TMetadata> | undefined>;
+/**
+ * Reads a schema from the file system using the provided context and input. This function first attempts to read the schema using the `readSchemaSafe` helper function, which returns `undefined` if the schema is not found in the cache. If the schema is not found, this function throws an error indicating that the schema with the specified variant and hash does not exist in the cache. The error message suggests that this may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. It advises ensuring that the schema is properly written to the cache before attempting to read it. If the schema is successfully read from the cache, it is returned as a parsed object. This function is asynchronous and returns a promise that resolves to the parsed schema object if found, or throws an error if the schema is not found in the cache.
+ *
+ * @param context - The context object providing access to the file system and cache path.
+ * @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+ * @returns A promise that resolves to the parsed schema object if found in the cache, or throws an error if the schema does not exist in the cache.
+ * @throws Will throw an error if the schema with the specified variant and hash does not exist in the cache.
+ */
+declare function readSchema<TContext extends Context = Context, TMetadata extends SchemaMetadata = SchemaMetadata>(context: TContext, input: SchemaInput): Promise<Schema<TMetadata>>;
+//#endregion
+export { getCacheDirectory, getCacheFilePath, readSchema, readSchemaSafe, writeSchema };
+//# sourceMappingURL=persistence.d.cts.map

package/dist/persistence.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistence.d.cts","names":[],"sources":["../src/persistence.ts"],"mappings":";;;;;;AA8BA;;;;iBAAgB,iBAAA,CAAkB,OAAgB,EAAP,OAAO;AAWlD;;;;;;;AAAA,iBAAgB,gBAAA,CAAiB,OAAA,EAAS,OAAA,EAAS,KAAA,EAAO,WAAW;;AAAA;AAcrE;;;;;iBAAsB,WAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAC3B,OAAA,EAAS,QAAA,EAAU,MAAA,EAAQ,MAAA,CAAO,SAAA,IAAU,OAAA;;;;;;;;iBAoBxB,cAAA,kBACH,OAAA,GAAU,OAAA,oBACT,cAAA,GAAiB,cAAA,CAAA,CAEnC,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,GACN,OAAA,CAAQ,MAAA,CAAO,SAAA;;;;;;;;;iBAsBI,UAAA,kBACH,OAAA,GAAU,OAAA,oBACT,cAAA,GAAiB,cAAA,CAAA,CACnC,OAAA,EAAS,QAAA,EAAU,KAAA,EAAO,WAAA,GAAc,OAAA,CAAQ,MAAA,CAAO,SAAA"}

package/dist/persistence.d.mts

@@ -0,0 +1,47 @@
+import { Schema, SchemaInput, SchemaMetadata } from "./types.mjs";
+import { Context } from "@powerlines/core";
+
+//#region src/persistence.d.ts
+/**
+ * A helper function to get the cache directory path for storing schemas. This function takes a context object as input and returns the path to the cache directory where schemas are stored. The cache directory is constructed by joining the `cachePath` property from the context with a subdirectory named "schemas". This function is useful for centralizing the logic for determining where schema files should be cached, ensuring that all schema-related file operations use a consistent location for storing and retrieving cached schemas.
+ *
+ * @param context - The context object providing access to the cache path.
+ * @returns The path to the cache directory for storing schemas, constructed by joining the context's `cachePath` with the "schemas" subdirectory.
+ */
+declare function getCacheDirectory(context: Context): string;
+/**
+ * A helper function to get the file path for a cached schema based on the provided context and schema input. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file by joining the cache directory path (obtained from the `getCacheDirectory` function) with a filename derived from the extracted hash. The resulting file path points to where the cached schema should be stored or retrieved from in the file system. This function is essential for ensuring that all operations related to caching schemas use a consistent method for determining the correct file path based on the schema's unique identifier (hash).
+ *
+ * @param context - The context object providing access to the cache path.
+ * @param input - The input schema from which to extract the variant and hash for constructing the cache file path.
+ * @returns The file path to the cached schema JSON file, constructed by joining the cache directory path with a filename derived from the extracted hash of the schema input.
+ */
+declare function getCacheFilePath(context: Context, input: SchemaInput): string;
+/**
+ * Writes a given schema to the file system using the provided context. This function first checks if the input is a valid schema using the `isSchema` type guard. If the input is not a valid schema, it throws an error indicating that the provided input is invalid. If the input is valid, it proceeds to write the schema to a JSON file in the cache directory specified by the context. The file is named using the hash of the schema to ensure uniqueness and easy retrieval in future operations. The schema is serialized to JSON format before being written to the file system. This function is asynchronous and returns a promise that resolves once the writing operation is complete.
+ *
+ * @param context - The context object providing access to the file system and cache path.
+ * @param schema - The schema to be written to the file system, which must be a valid schema object containing a `variant`, `schema`, and `hash` property.
+ * @throws Will throw an error if the provided input is not a valid schema.
+ */
+declare function writeSchema<TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>, TContext extends Context = Context>(context: TContext, schema: Schema<TMetadata>): Promise<void>;
+/**
+ * A helper function to read a schema from the file system using the provided context. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file based on the cache path provided in the context and the extracted hash. The function checks if the file exists in the cache; if it does not exist, it returns `undefined`. If the file exists, it reads the contents of the file, parses it as JSON, and returns the resulting object. This function is asynchronous and returns a promise that resolves to either the parsed schema object or `undefined` if the schema is not found in the cache.
+ *
+ * @param context - The context object providing access to the file system and cache path.
+ * @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+ * @returns A promise that resolves to the parsed schema object if found in the cache, or `undefined` if the schema does not exist in the cache.
+ */
+declare function readSchemaSafe<TContext extends Context = Context, TMetadata extends SchemaMetadata = SchemaMetadata>(context: TContext, input: SchemaInput): Promise<Schema<TMetadata> | undefined>;
+/**
+ * Reads a schema from the file system using the provided context and input. This function first attempts to read the schema using the `readSchemaSafe` helper function, which returns `undefined` if the schema is not found in the cache. If the schema is not found, this function throws an error indicating that the schema with the specified variant and hash does not exist in the cache. The error message suggests that this may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. It advises ensuring that the schema is properly written to the cache before attempting to read it. If the schema is successfully read from the cache, it is returned as a parsed object. This function is asynchronous and returns a promise that resolves to the parsed schema object if found, or throws an error if the schema is not found in the cache.
+ *
+ * @param context - The context object providing access to the file system and cache path.
+ * @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+ * @returns A promise that resolves to the parsed schema object if found in the cache, or throws an error if the schema does not exist in the cache.
+ * @throws Will throw an error if the schema with the specified variant and hash does not exist in the cache.
+ */
+declare function readSchema<TContext extends Context = Context, TMetadata extends SchemaMetadata = SchemaMetadata>(context: TContext, input: SchemaInput): Promise<Schema<TMetadata>>;
+//#endregion
+export { getCacheDirectory, getCacheFilePath, readSchema, readSchemaSafe, writeSchema };
+//# sourceMappingURL=persistence.d.mts.map

package/dist/persistence.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistence.d.mts","names":[],"sources":["../src/persistence.ts"],"mappings":";;;;;;AA8BA;;;;iBAAgB,iBAAA,CAAkB,OAAgB,EAAP,OAAO;AAWlD;;;;;;;AAAA,iBAAgB,gBAAA,CAAiB,OAAA,EAAS,OAAA,EAAS,KAAA,EAAO,WAAW;;AAAA;AAcrE;;;;;iBAAsB,WAAA,mBACF,OAAA,CAAQ,cAAA,IAAkB,OAAA,CAAQ,cAAA,oBACnC,OAAA,GAAU,OAAA,CAAA,CAC3B,OAAA,EAAS,QAAA,EAAU,MAAA,EAAQ,MAAA,CAAO,SAAA,IAAU,OAAA;;;;;;;;iBAoBxB,cAAA,kBACH,OAAA,GAAU,OAAA,oBACT,cAAA,GAAiB,cAAA,CAAA,CAEnC,OAAA,EAAS,QAAA,EACT,KAAA,EAAO,WAAA,GACN,OAAA,CAAQ,MAAA,CAAO,SAAA;;;;;;;;;iBAsBI,UAAA,kBACH,OAAA,GAAU,OAAA,oBACT,cAAA,GAAiB,cAAA,CAAA,CACnC,OAAA,EAAS,QAAA,EAAU,KAAA,EAAO,WAAA,GAAc,OAAA,CAAQ,MAAA,CAAO,SAAA"}

package/dist/persistence.mjs

@@ -0,0 +1,71 @@
+import { isSchema } from "./type-checks.mjs";
+import { extractHash, extractVariant } from "./extract.mjs";
+import { joinPaths } from "@stryke/path/join";
+
+//#region src/persistence.ts
+/**
+* A helper function to get the cache directory path for storing schemas. This function takes a context object as input and returns the path to the cache directory where schemas are stored. The cache directory is constructed by joining the `cachePath` property from the context with a subdirectory named "schemas". This function is useful for centralizing the logic for determining where schema files should be cached, ensuring that all schema-related file operations use a consistent location for storing and retrieving cached schemas.
+*
+* @param context - The context object providing access to the cache path.
+* @returns The path to the cache directory for storing schemas, constructed by joining the context's `cachePath` with the "schemas" subdirectory.
+*/
+function getCacheDirectory(context) {
+	return joinPaths(context.cachePath, "schemas");
+}
+/**
+* A helper function to get the file path for a cached schema based on the provided context and schema input. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file by joining the cache directory path (obtained from the `getCacheDirectory` function) with a filename derived from the extracted hash. The resulting file path points to where the cached schema should be stored or retrieved from in the file system. This function is essential for ensuring that all operations related to caching schemas use a consistent method for determining the correct file path based on the schema's unique identifier (hash).
+*
+* @param context - The context object providing access to the cache path.
+* @param input - The input schema from which to extract the variant and hash for constructing the cache file path.
+* @returns The file path to the cached schema JSON file, constructed by joining the cache directory path with a filename derived from the extracted hash of the schema input.
+*/
+function getCacheFilePath(context, input) {
+	const hash = extractHash(extractVariant(input), input);
+	return joinPaths(getCacheDirectory(context), `${hash}.json`);
+}
+/**
+* Writes a given schema to the file system using the provided context. This function first checks if the input is a valid schema using the `isSchema` type guard. If the input is not a valid schema, it throws an error indicating that the provided input is invalid. If the input is valid, it proceeds to write the schema to a JSON file in the cache directory specified by the context. The file is named using the hash of the schema to ensure uniqueness and easy retrieval in future operations. The schema is serialized to JSON format before being written to the file system. This function is asynchronous and returns a promise that resolves once the writing operation is complete.
+*
+* @param context - The context object providing access to the file system and cache path.
+* @param schema - The schema to be written to the file system, which must be a valid schema object containing a `variant`, `schema`, and `hash` property.
+* @throws Will throw an error if the provided input is not a valid schema.
+*/
+async function writeSchema(context, schema) {
+	if (!isSchema(schema)) throw new Error(`The provided input is not a valid schema. A valid schema must have a "variant" property indicating the type of the input and a "schema" property containing the parsed JTD schema object.`);
+	await context.fs.write(getCacheFilePath(context, schema), JSON.stringify(schema.schema));
+}
+/**
+* A helper function to read a schema from the file system using the provided context. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file based on the cache path provided in the context and the extracted hash. The function checks if the file exists in the cache; if it does not exist, it returns `undefined`. If the file exists, it reads the contents of the file, parses it as JSON, and returns the resulting object. This function is asynchronous and returns a promise that resolves to either the parsed schema object or `undefined` if the schema is not found in the cache.
+*
+* @param context - The context object providing access to the file system and cache path.
+* @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+* @returns A promise that resolves to the parsed schema object if found in the cache, or `undefined` if the schema does not exist in the cache.
+*/
+async function readSchemaSafe(context, input) {
+	const cacheFilePath = getCacheFilePath(context, input);
+	if (!await context.fs.exists(cacheFilePath)) return;
+	const data = await context.fs.read(cacheFilePath);
+	if (!data) return;
+	return JSON.parse(data);
+}
+/**
+* Reads a schema from the file system using the provided context and input. This function first attempts to read the schema using the `readSchemaSafe` helper function, which returns `undefined` if the schema is not found in the cache. If the schema is not found, this function throws an error indicating that the schema with the specified variant and hash does not exist in the cache. The error message suggests that this may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. It advises ensuring that the schema is properly written to the cache before attempting to read it. If the schema is successfully read from the cache, it is returned as a parsed object. This function is asynchronous and returns a promise that resolves to the parsed schema object if found, or throws an error if the schema is not found in the cache.
+*
+* @param context - The context object providing access to the file system and cache path.
+* @param input - The input schema from which to extract the variant and hash for locating the cached schema file.
+* @returns A promise that resolves to the parsed schema object if found in the cache, or throws an error if the schema does not exist in the cache.
+* @throws Will throw an error if the schema with the specified variant and hash does not exist in the cache.
+*/
+async function readSchema(context, input) {
+	const schema = await readSchemaSafe(context, input);
+	if (!schema) {
+		const variant = extractVariant(input);
+		const hash = extractHash(variant, input);
+		throw new Error(`The ${variant} schema with hash "${hash}" does not exist in the cache. This may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. Please ensure that the schema is properly written to the cache before attempting to read it.`);
+	}
+	return schema;
+}
+
+//#endregion
+export { getCacheDirectory, getCacheFilePath, readSchema, readSchemaSafe, writeSchema };
+//# sourceMappingURL=persistence.mjs.map

package/dist/persistence.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistence.mjs","names":[],"sources":["../src/persistence.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { Context } from \"@powerlines/core\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { extractHash, extractVariant } from \"./extract\";\nimport { isSchema } from \"./type-checks\";\nimport { Schema, SchemaInput, SchemaMetadata } from \"./types\";\n\n/**\n * A helper function to get the cache directory path for storing schemas. This function takes a context object as input and returns the path to the cache directory where schemas are stored. The cache directory is constructed by joining the `cachePath` property from the context with a subdirectory named \"schemas\". This function is useful for centralizing the logic for determining where schema files should be cached, ensuring that all schema-related file operations use a consistent location for storing and retrieving cached schemas.\n *\n * @param context - The context object providing access to the cache path.\n * @returns The path to the cache directory for storing schemas, constructed by joining the context's `cachePath` with the \"schemas\" subdirectory.\n */\nexport function getCacheDirectory(context: Context): string {\n  return joinPaths(context.cachePath, \"schemas\");\n}\n\n/**\n * A helper function to get the file path for a cached schema based on the provided context and schema input. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file by joining the cache directory path (obtained from the `getCacheDirectory` function) with a filename derived from the extracted hash. The resulting file path points to where the cached schema should be stored or retrieved from in the file system. This function is essential for ensuring that all operations related to caching schemas use a consistent method for determining the correct file path based on the schema's unique identifier (hash).\n *\n * @param context - The context object providing access to the cache path.\n * @param input - The input schema from which to extract the variant and hash for constructing the cache file path.\n * @returns The file path to the cached schema JSON file, constructed by joining the cache directory path with a filename derived from the extracted hash of the schema input.\n */\nexport function getCacheFilePath(context: Context, input: SchemaInput): string {\n  const variant = extractVariant(input);\n  const hash = extractHash(variant, input);\n\n  return joinPaths(getCacheDirectory(context), `${hash}.json`);\n}\n\n/**\n * Writes a given schema to the file system using the provided context. This function first checks if the input is a valid schema using the `isSchema` type guard. If the input is not a valid schema, it throws an error indicating that the provided input is invalid. If the input is valid, it proceeds to write the schema to a JSON file in the cache directory specified by the context. The file is named using the hash of the schema to ensure uniqueness and easy retrieval in future operations. The schema is serialized to JSON format before being written to the file system. This function is asynchronous and returns a promise that resolves once the writing operation is complete.\n *\n * @param context - The context object providing access to the file system and cache path.\n * @param schema - The schema to be written to the file system, which must be a valid schema object containing a `variant`, `schema`, and `hash` property.\n * @throws Will throw an error if the provided input is not a valid schema.\n */\nexport async function writeSchema<\n  TMetadata extends Partial<SchemaMetadata> = Partial<SchemaMetadata>,\n  TContext extends Context = Context\n>(context: TContext, schema: Schema<TMetadata>) {\n  if (!isSchema<TMetadata>(schema)) {\n    throw new Error(\n      `The provided input is not a valid schema. A valid schema must have a \"variant\" property indicating the type of the input and a \"schema\" property containing the parsed JTD schema object.`\n    );\n  }\n\n  await context.fs.write(\n    getCacheFilePath(context, schema),\n    JSON.stringify(schema.schema)\n  );\n}\n\n/**\n * A helper function to read a schema from the file system using the provided context. This function first extracts the variant and hash from the input schema using the `extractVariant` and `extractHash` functions, respectively. It then constructs the file path to the cached schema JSON file based on the cache path provided in the context and the extracted hash. The function checks if the file exists in the cache; if it does not exist, it returns `undefined`. If the file exists, it reads the contents of the file, parses it as JSON, and returns the resulting object. This function is asynchronous and returns a promise that resolves to either the parsed schema object or `undefined` if the schema is not found in the cache.\n *\n * @param context - The context object providing access to the file system and cache path.\n * @param input - The input schema from which to extract the variant and hash for locating the cached schema file.\n * @returns A promise that resolves to the parsed schema object if found in the cache, or `undefined` if the schema does not exist in the cache.\n */\nexport async function readSchemaSafe<\n  TContext extends Context = Context,\n  TMetadata extends SchemaMetadata = SchemaMetadata\n>(\n  context: TContext,\n  input: SchemaInput\n): Promise<Schema<TMetadata> | undefined> {\n  const cacheFilePath = getCacheFilePath(context, input);\n  if (!(await context.fs.exists(cacheFilePath))) {\n    return undefined;\n  }\n\n  const data = await context.fs.read(cacheFilePath);\n  if (!data) {\n    return undefined;\n  }\n\n  return JSON.parse(data);\n}\n\n/**\n * Reads a schema from the file system using the provided context and input. This function first attempts to read the schema using the `readSchemaSafe` helper function, which returns `undefined` if the schema is not found in the cache. If the schema is not found, this function throws an error indicating that the schema with the specified variant and hash does not exist in the cache. The error message suggests that this may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. It advises ensuring that the schema is properly written to the cache before attempting to read it. If the schema is successfully read from the cache, it is returned as a parsed object. This function is asynchronous and returns a promise that resolves to the parsed schema object if found, or throws an error if the schema is not found in the cache.\n *\n * @param context - The context object providing access to the file system and cache path.\n * @param input - The input schema from which to extract the variant and hash for locating the cached schema file.\n * @returns A promise that resolves to the parsed schema object if found in the cache, or throws an error if the schema does not exist in the cache.\n * @throws Will throw an error if the schema with the specified variant and hash does not exist in the cache.\n */\nexport async function readSchema<\n  TContext extends Context = Context,\n  TMetadata extends SchemaMetadata = SchemaMetadata\n>(context: TContext, input: SchemaInput): Promise<Schema<TMetadata>> {\n  const schema = await readSchemaSafe<TContext, TMetadata>(context, input);\n  if (!schema) {\n    const variant = extractVariant(input);\n    const hash = extractHash(variant, input);\n\n    throw new Error(\n      `The ${variant} schema with hash \"${\n        hash\n      }\" does not exist in the cache. This may be due to a missing or corrupted cache file, or because the schema has not been written to the cache yet. Please ensure that the schema is properly written to the cache before attempting to read it.`\n    );\n  }\n\n  return schema;\n}\n"],"mappings":";;;;;;;;;;;AA8BA,SAAgB,kBAAkB,SAA0B;CAC1D,OAAO,UAAU,QAAQ,WAAW,SAAS;AAC/C;;;;;;;;AASA,SAAgB,iBAAiB,SAAkB,OAA4B;CAE7E,MAAM,OAAO,YADG,eAAe,KACA,GAAG,KAAK;CAEvC,OAAO,UAAU,kBAAkB,OAAO,GAAG,GAAG,KAAK,MAAM;AAC7D;;;;;;;;AASA,eAAsB,YAGpB,SAAmB,QAA2B;CAC9C,IAAI,CAAC,SAAoB,MAAM,GAC7B,MAAM,IAAI,MACR,2LACF;CAGF,MAAM,QAAQ,GAAG,MACf,iBAAiB,SAAS,MAAM,GAChC,KAAK,UAAU,OAAO,MAAM,CAC9B;AACF;;;;;;;;AASA,eAAsB,eAIpB,SACA,OACwC;CACxC,MAAM,gBAAgB,iBAAiB,SAAS,KAAK;CACrD,IAAI,CAAE,MAAM,QAAQ,GAAG,OAAO,aAAa,GACzC;CAGF,MAAM,OAAO,MAAM,QAAQ,GAAG,KAAK,aAAa;CAChD,IAAI,CAAC,MACH;CAGF,OAAO,KAAK,MAAM,IAAI;AACxB;;;;;;;;;AAUA,eAAsB,WAGpB,SAAmB,OAAgD;CACnE,MAAM,SAAS,MAAM,eAAoC,SAAS,KAAK;CACvE,IAAI,CAAC,QAAQ;EACX,MAAM,UAAU,eAAe,KAAK;EACpC,MAAM,OAAO,YAAY,SAAS,KAAK;EAEvC,MAAM,IAAI,MACR,OAAO,QAAQ,qBACb,KACD,+OACH;CACF;CAEA,OAAO;AACT"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/schema",
-  "version": "0.11.23",
+  "version": "0.11.24",
   "private": false,
   "description": "A package containing a Powerlines plugin to assist in developing other Powerlines plugins.",
   "keywords": [
@@ -71,6 +71,10 @@
       "require": "./dist/helpers.cjs"
     },
     "./jtd": { "import": "./dist/jtd.mjs", "require": "./dist/jtd.cjs" },
+    "./persistence": {
+      "import": "./dist/persistence.mjs",
+      "require": "./dist/persistence.cjs"
+    },
     "./reflection": {
       "import": "./dist/reflection.mjs",
       "require": "./dist/reflection.cjs"
@@ -113,5 +117,5 @@
   "peerDependencies": { "zod": "^3.25.0 || ^4.0.0" },
   "peerDependenciesMeta": { "zod": { "optional": true } },
   "publishConfig": { "access": "public" },
-  "gitHead": "f95fab7200cc5687144ea1b1ee4ba77b44000935"
+  "gitHead": "7fb37a42aa27f6cbc6b7412e259d0f7a79bac8ed"
 }