@content-collections/core 0.7.3 → 0.8.0

package/README.md

@@ -17,7 +17,7 @@ Transform your content into type-safe data collections. Eliminate the need for m
 - **Simple to use**:
   No need to manually fetch and parse your content anymore. Just import it and start using Content Collections. It provides a simple API, allowing you to concentrate on building your app.
 
-- **Tansformation**:
+- **Transformation**:
   Content Collections allows you to transform your content before it enters your app. You can use it to modify your content, join two collections or even fetch data from a server.
 
 ## Installation

package/dist/index.d.ts

@@ -3,17 +3,34 @@ export * from 'zod';
 
 type CacheFn = <TInput, TOutput>(input: TInput, compute: (input: TInput) => Promise<TOutput> | TOutput) => Promise<TOutput>;
 
+declare const importSymbol: unique symbol;
+type Import<T> = {
+    [importSymbol]: true;
+    path: string;
+    name?: string;
+};
+type GetTypeOfImport<T> = T extends Import<infer U> ? U : never;
+declare function createDefaultImport<T>(path: string): Import<T>;
+declare function createNamedImport<T>(name: string, path: string): Import<T>;
+
 type Parsers = typeof parsers;
 type Parser = keyof typeof parsers;
 declare function parseYaml(content: string): any;
 declare function frontmatterParser(fileContent: string): {
     content: string;
 };
+declare function frontmatterOnlyParser(fileContent: string): {
+    [key: string]: any;
+};
 declare const parsers: {
     readonly frontmatter: {
         readonly hasContent: true;
         readonly parse: typeof frontmatterParser;
     };
+    readonly "frontmatter-only": {
+        readonly hasContent: false;
+        readonly parse: typeof frontmatterOnlyParser;
+    };
     readonly json: {
         readonly hasContent: false;
         readonly parse: (text: string, reviver?: (this: any, key: string, value: any) => any) => any;
@@ -86,7 +103,10 @@ 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 Serializable ? Collection<TName, TShape, TParser, TSchema, TTransformResult, TDocument> : InvalidReturnType<NotSerializableError, TDocument>>(collection: CollectionRequest<TName, TShape, TParser, TSchema, TTransformResult, TDocument>): TResult;
+type ResolveImports<TTransformResult> = TTransformResult extends Import<any> ? GetTypeOfImport<TTransformResult> : TTransformResult extends Array<infer U> ? Array<ResolveImports<U>> : TTransformResult extends (...args: any[]) => any ? TTransformResult : TTransformResult extends object ? {
+    [K in keyof TTransformResult]: ResolveImports<TTransformResult[K]>;
+} : TTransformResult;
+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, ResolveImports<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;
@@ -261,4 +281,4 @@ declare function createBuilder(configurationPath: string, options?: Options, emi
 }>;
 type Builder = Awaited<ReturnType<typeof createBuilder>>;
 
-export { type AnyCollection, type AnyConfiguration, type Builder, type BuilderEvents, CollectError, type Collection, type CollectionRequest, type Configuration, ConfigurationError, ConfigurationReloadError, type Context, type Document, type GetTypeByName, type Meta, type Modification, type Schema, TransformError, type Watcher, createBuilder, defineCollection, defineConfig };
+export { type AnyCollection, type AnyConfiguration, type Builder, type BuilderEvents, CollectError, type Collection, type CollectionRequest, type Configuration, ConfigurationError, ConfigurationReloadError, type Context, type Document, type GetTypeByName, type Meta, type Modification, type Schema, TransformError, type Watcher, createBuilder, createDefaultImport, createNamedImport, defineCollection, defineConfig };

package/dist/index.js

@@ -111,8 +111,8 @@ import { parse, stringify } from "yaml";
 function parseYaml(content) {
   return parse(content.trim());
 }
-function frontmatterParser(fileContent) {
-  const { data, content } = matter(fileContent, {
+function frontmatter(fileContent) {
+  return matter(fileContent, {
     engines: {
       yaml: {
         parse: parseYaml,
@@ -120,16 +120,27 @@ function frontmatterParser(fileContent) {
       }
     }
   });
+}
+function frontmatterParser(fileContent) {
+  const { data, content } = frontmatter(fileContent);
   return {
     ...data,
     content: content.trim()
   };
 }
+function frontmatterOnlyParser(fileContent) {
+  const { data } = frontmatter(fileContent);
+  return data;
+}
 var parsers = {
   frontmatter: {
     hasContent: true,
     parse: frontmatterParser
   },
+  ["frontmatter-only"]: {
+    hasContent: false,
+    parse: frontmatterOnlyParser
+  },
   json: {
     hasContent: false,
     parse: JSON.parse
@@ -349,6 +360,27 @@ import { z as z2 } from "zod";
 // src/serializer.ts
 import serializeJs from "serialize-javascript";
 import z from "zod";
+
+// src/import.ts
+var importSymbol = Symbol("import");
+function isImport(value) {
+  return value && value[importSymbol];
+}
+function createDefaultImport(path10) {
+  return {
+    [importSymbol]: true,
+    path: path10
+  };
+}
+function createNamedImport(name, path10) {
+  return {
+    [importSymbol]: true,
+    path: path10,
+    name
+  };
+}
+
+// src/serializer.ts
 var literalSchema = z.union([
   // json
   z.string(),
@@ -367,13 +399,39 @@ var schema = z.lazy(
 );
 var extension = "js";
 var serializableSchema = z.record(schema);
+function createImport(imp, variableName) {
+  const variableDeclaration = imp.name ? `{ ${imp.name} as ${variableName} }` : variableName;
+  return `import ${variableDeclaration} from "${imp.path}";
+`;
+}
 function serialize(value) {
-  const serializedValue = serializeJs(value, {
+  let serializedValue = "";
+  let counter = 0;
+  function handleImports(item) {
+    if (item instanceof Object) {
+      Object.entries(item).forEach(([key, value2]) => {
+        if (isImport(value2)) {
+          counter++;
+          const variableName = `__v_${counter}`;
+          serializedValue += createImport(value2, variableName);
+          item[key] = variableName;
+        } else if (value2 instanceof Object) {
+          handleImports(value2);
+        }
+      });
+    }
+  }
+  value.forEach(handleImports);
+  serializedValue += "\n";
+  const js = serializeJs(value, {
     space: 2,
     unsafe: true,
     ignoreFunction: true
+  }).replace(/"__v_(\d+)"/g, (_, index) => {
+    return `__v_${index}`;
   });
-  return `export default ${serializedValue};`;
+  serializedValue += "export default " + js;
+  return serializedValue;
 }
 
 // src/transformer.ts
@@ -1194,6 +1252,8 @@ export {
   ConfigurationReloadError,
   TransformError,
   createBuilder,
+  createDefaultImport,
+  createNamedImport,
   defineCollection,
   defineConfig
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-collections/core",
-  "version": "0.7.3",
+  "version": "0.8.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,11 +24,11 @@
     "@types/picomatch": "^3.0.1",
     "@types/pluralize": "^0.0.33",
     "@types/serialize-javascript": "^5.0.4",
-    "@vitest/coverage-v8": "^2.1.3",
+    "@vitest/coverage-v8": "^2.1.5",
     "tsup": "^8.2.4",
-    "tsx": "^4.1.1",
+    "tsx": "^4.19.2",
     "typescript": "^5.5.4",
-    "vitest": "^2.1.3"
+    "vitest": "^2.1.5"
   },
   "dependencies": {
     "@parcel/watcher": "^2.4.1",