@content-collections/core 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -23,13 +23,17 @@ declare const parsers: {
 
 type CacheFn = <TInput, TOutput>(input: TInput, compute: (input: TInput) => Promise<TOutput> | TOutput) => Promise<TOutput>;
 
-declare const literalSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull, z.ZodUndefined]>;
+declare const literalSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull, z.ZodUndefined, z.ZodDate, z.ZodMap<z.ZodUnknown, z.ZodUnknown>, z.ZodSet<z.ZodUnknown>, z.ZodBigInt]>;
 type Literal = z.infer<typeof literalSchema>;
-type Json = Literal | {
-    [key: string]: Json;
-} | Json[];
-declare const jsonObjectScheme: z.ZodRecord<z.ZodString, z.ZodType<Json, z.ZodTypeDef, Json>>;
-type JSONObject = z.infer<typeof jsonObjectScheme>;
+type SchemaType = Literal | {
+    [key: string]: SchemaType;
+} | SchemaType[];
+type NotSerializableError = `The return type of the transform function must be an object serializable object.
+See https://www.content-collections.dev/docs/serialization for more information.
+
+The following type is not valid:`;
+declare const serializableSchema: z.ZodRecord<z.ZodString, z.ZodType<SchemaType, z.ZodTypeDef, SchemaType>>;
+type Serializable = z.infer<typeof serializableSchema>;
 
 type Meta = {
     filePath: string;
@@ -75,13 +79,12 @@ type Collection<TName extends string, TShape extends ZodRawShape, TParser extend
     parser: TParser;
 };
 type AnyCollection = Collection<any, ZodRawShape, Parser, any, any, any>;
-type NonJSONObjectError = "The return type of the transform function must be an valid JSONObject, the following type is not valid:";
 declare const InvalidReturnTypeSymbol: unique symbol;
 type InvalidReturnType<TMessage extends string, TObject> = {
     [InvalidReturnTypeSymbol]: TMessage;
     object: TObject;
 };
-declare function defineCollection<TName extends string, TShape extends ZodRawShape, TParser extends Parser = "frontmatter", TSchema = Schema<TParser, TShape>, TTransformResult = never, TDocument = [TTransformResult] extends [never] ? Schema<TParser, TShape> : Awaited<TTransformResult>, TResult = TDocument extends JSONObject ? Collection<TName, TShape, TParser, TSchema, TTransformResult, TDocument> : InvalidReturnType<NonJSONObjectError, TDocument>>(collection: CollectionRequest<TName, TShape, TParser, TSchema, TTransformResult, TDocument>): TResult;
+declare function defineCollection<TName extends string, TShape extends ZodRawShape, TParser extends Parser = "frontmatter", TSchema = Schema<TParser, TShape>, TTransformResult = never, TDocument = [TTransformResult] extends [never] ? Schema<TParser, TShape> : Awaited<TTransformResult>, TResult = TDocument extends Serializable ? Collection<TName, TShape, TParser, TSchema, TTransformResult, TDocument> : InvalidReturnType<NotSerializableError, TDocument>>(collection: CollectionRequest<TName, TShape, TParser, TSchema, TTransformResult, TDocument>): TResult;
 type Cache = "memory" | "file" | "none";
 type Configuration<TCollections extends Array<AnyCollection>> = {
     collections: TCollections;
@@ -200,4 +203,4 @@ declare function createBuilder(configurationPath: string, options?: Options): Pr
 }>;
 type Builder = Awaited<ReturnType<typeof createBuilder>>;
 
-export { AnyCollection, AnyConfiguration, Builder, BuilderEvents, CollectError, Collection, CollectionRequest, Configuration, ConfigurationError, Context, Document, GetTypeByName, Meta, Modification, Schema, TransformError, createBuilder, defineCollection, defineConfig };
+export { type AnyCollection, type AnyConfiguration, type Builder, type BuilderEvents, CollectError, type Collection, type CollectionRequest, type Configuration, ConfigurationError, type Context, type Document, type GetTypeByName, type Meta, type Modification, type Schema, TransformError, createBuilder, defineCollection, defineConfig };

package/dist/index.js

@@ -45,7 +45,7 @@ import path from "path";
 // package.json
 var package_default = {
   name: "@content-collections/core",
-  version: "0.5.0",
+  version: "0.6.0",
   type: "module",
   main: "dist/index.js",
   types: "./dist/index.d.ts",
@@ -67,12 +67,16 @@ var package_default = {
     prepack: "cp ../../README.md ./README.md",
     postpack: "rm -f ./README.md"
   },
+  peerDependencies: {
+    typescript: "^5.0.2"
+  },
   devDependencies: {
     "@types/micromatch": "^4.0.7",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.14.2",
     "@types/pluralize": "^0.0.33",
+    "@types/serialize-javascript": "^5.0.4",
     "@vitest/coverage-v8": "^1.5.0",
-    tsup: "^7.2.0",
+    tsup: "^8.0.2",
     tsx: "^4.1.1",
     typescript: "^5.4.5",
     vitest: "^1.5.0"
@@ -80,11 +84,12 @@ var package_default = {
   dependencies: {
     "@parcel/watcher": "^2.4.1",
     camelcase: "^8.0.0",
-    esbuild: "^0.20.2",
+    esbuild: "^0.21.4",
     "fast-glob": "^3.3.2",
     "gray-matter": "^4.0.3",
     micromatch: "^4.0.5",
     pluralize: "^8.0.0",
+    "serialize-javascript": "^6.0.2",
     yaml: "^2.4.1",
     zod: "^3.22.5"
   }
@@ -288,6 +293,38 @@ function createCollector(emitter, baseDirectory = ".") {
 import fs2 from "fs/promises";
 import path3 from "path";
 import pluralize2 from "pluralize";
+
+// src/serializer.ts
+import z2 from "zod";
+import serializeJs from "serialize-javascript";
+var literalSchema = z2.union([
+  // json
+  z2.string(),
+  z2.number(),
+  z2.boolean(),
+  z2.null(),
+  // serializable-javascript
+  z2.undefined(),
+  z2.date(),
+  z2.map(z2.unknown(), z2.unknown()),
+  z2.set(z2.unknown()),
+  z2.bigint()
+]);
+var schema = z2.lazy(
+  () => z2.union([literalSchema, z2.array(schema), z2.record(schema)])
+);
+var extension = "js";
+var serializableSchema = z2.record(schema);
+function serialize(value) {
+  const serializedValue = serializeJs(value, {
+    space: 2,
+    unsafe: true,
+    ignoreFunction: true
+  });
+  return `export default ${serializedValue};`;
+}
+
+// src/writer.ts
 function createArrayConstName(name) {
   let suffix = name.charAt(0).toUpperCase() + name.slice(1);
   return "all" + pluralize2(suffix);
@@ -295,15 +332,11 @@ function createArrayConstName(name) {
 async function createDataFile(directory, collection) {
   const dataPath = path3.join(
     directory,
-    `${createArrayConstName(collection.name)}.json`
+    `${createArrayConstName(collection.name)}.${extension}`
   );
   await fs2.writeFile(
     dataPath,
-    JSON.stringify(
-      collection.documents.map((doc) => doc.document),
-      null,
-      2
-    )
+    serialize(collection.documents.map((doc) => doc.document))
   );
 }
 function createDataFiles(directory, collections) {
@@ -319,7 +352,7 @@ async function createJavaScriptFile(directory, configuration) {
 
 `;
   for (const name of collections) {
-    content += `import ${name} from "./${name}.json";
+    content += `import ${name} from "./${name}.${extension}";
 `;
   }
   content += "\n";
@@ -327,7 +360,9 @@ async function createJavaScriptFile(directory, configuration) {
   await fs2.writeFile(path3.join(directory, "index.js"), content, "utf-8");
 }
 function createImportPath(directory, target) {
-  let importPath = path3.posix.join(...path3.relative(directory, target).split(path3.sep));
+  let importPath = path3.posix.join(
+    ...path3.relative(directory, target).split(path3.sep)
+  );
   if (!importPath.startsWith(".")) {
     importPath = "./" + importPath;
   }
@@ -368,22 +403,6 @@ async function createWriter(directory) {
 // src/transformer.ts
 import { basename, dirname, extname } from "path";
 import { z as z3 } from "zod";
-
-// src/json.ts
-import z2 from "zod";
-var literalSchema = z2.union([
-  z2.string(),
-  z2.number(),
-  z2.boolean(),
-  z2.null(),
-  z2.undefined()
-]);
-var jsonSchema = z2.lazy(
-  () => z2.union([literalSchema, z2.array(jsonSchema), z2.record(jsonSchema)])
-);
-var jsonObjectScheme = z2.record(jsonSchema);
-
-// src/transformer.ts
 var TransformError = class extends Error {
   type;
   constructor(type, message) {
@@ -399,20 +418,20 @@ function createPath(path7, ext) {
   return p;
 }
 function createTransformer(emitter, cacheManager) {
-  function createSchema(parserName, schema) {
+  function createSchema(parserName, schema2) {
     const parser = parsers[parserName];
     if (!parser.hasContent) {
-      return z3.object(schema);
+      return z3.object(schema2);
     }
     return z3.object({
       content: z3.string(),
-      ...schema
+      ...schema2
     });
   }
   async function parseFile(collection, file) {
     const { data, path: path7 } = file;
-    const schema = createSchema(collection.parser, collection.schema);
-    let parsedData = await schema.safeParseAsync(data);
+    const schema2 = createSchema(collection.parser, collection.schema);
+    let parsedData = await schema2.safeParseAsync(data);
     if (!parsedData.success) {
       emitter.emit("transformer:validation-error", {
         collection,
@@ -422,9 +441,9 @@ function createTransformer(emitter, cacheManager) {
       return null;
     }
     const ext = extname(path7);
-    let extension = ext;
-    if (extension.startsWith(".")) {
-      extension = extension.slice(1);
+    let extension2 = ext;
+    if (extension2.startsWith(".")) {
+      extension2 = extension2.slice(1);
     }
     const document = {
       ...parsedData.data,
@@ -432,7 +451,7 @@ function createTransformer(emitter, cacheManager) {
         filePath: path7,
         fileName: basename(path7),
         directory: dirname(path7),
-        extension,
+        extension: extension2,
         path: createPath(path7, ext)
       }
     };
@@ -506,7 +525,7 @@ function createTransformer(emitter, cacheManager) {
   async function validateDocuments(collection, documents) {
     const docs = [];
     for (const doc of documents) {
-      let parsedData = await jsonObjectScheme.safeParseAsync(doc.document);
+      let parsedData = await serializableSchema.safeParseAsync(doc.document);
       if (parsedData.success) {
         docs.push(doc);
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-collections/core",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",
@@ -15,12 +15,16 @@
     "dist",
     "README.md"
   ],
+  "peerDependencies": {
+    "typescript": "^5.0.2"
+  },
   "devDependencies": {
     "@types/micromatch": "^4.0.7",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.14.2",
     "@types/pluralize": "^0.0.33",
+    "@types/serialize-javascript": "^5.0.4",
     "@vitest/coverage-v8": "^1.5.0",
-    "tsup": "^7.2.0",
+    "tsup": "^8.0.2",
     "tsx": "^4.1.1",
     "typescript": "^5.4.5",
     "vitest": "^1.5.0"
@@ -28,11 +32,12 @@
   "dependencies": {
     "@parcel/watcher": "^2.4.1",
     "camelcase": "^8.0.0",
-    "esbuild": "^0.20.2",
+    "esbuild": "^0.21.4",
     "fast-glob": "^3.3.2",
     "gray-matter": "^4.0.3",
     "micromatch": "^4.0.5",
     "pluralize": "^8.0.0",
+    "serialize-javascript": "^6.0.2",
     "yaml": "^2.4.1",
     "zod": "^3.22.5"
   },