@content-collections/core 0.10.0 → 0.11.0

package/dist/index.d.ts

@@ -60,7 +60,7 @@ declare const literalSchema: z__default.ZodUnion<[z__default.ZodString, z__defau
 type Literal = z__default.infer<typeof literalSchema>;
 type SchemaType = Literal | {
     [key: string]: SchemaType;
-} | SchemaType[];
+} | ReadonlyArray<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.
 
@@ -95,6 +95,11 @@ type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
 type GetSchema<TCollection extends AnyCollection> = TCollection extends Collection<any, any, any, infer TSchema, any, any> ? Prettify<TSchema> : never;
+declare const skippedSymbol: unique symbol;
+type SkippedSignal = {
+    [skippedSymbol]: true;
+    reason?: string;
+};
 type Context<TSchema = unknown> = {
     documents<TCollection extends AnyCollection>(collection: TCollection): Array<GetSchema<TCollection>>;
     cache: CacheFn;
@@ -103,6 +108,7 @@ type Context<TSchema = unknown> = {
         directory: string;
         documents: () => Promise<Array<TSchema>>;
     };
+    skip: (reason?: string) => SkippedSignal;
 };
 type Z = typeof z$1;
 type CollectionRequest<TName extends string, TShape extends TSchemaProp, TParser, TSchema, TTransformResult, TDocument> = {
@@ -130,7 +136,7 @@ type InvalidReturnType<TMessage extends string, TObject> = {
 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 TSchemaProp, TParser extends ConfiguredParser = "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;
+declare function defineCollection<TName extends string, TShape extends TSchemaProp, TParser extends ConfiguredParser = "frontmatter", TSchema = Schema<TParser, TShape>, TTransformResult = never, TDocument = [TTransformResult] extends [never] ? Schema<TParser, TShape> : Exclude<Awaited<TTransformResult>, SkippedSignal>, 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;
@@ -187,6 +193,11 @@ type TransformerEvents = {
         collection: AnyCollection;
         error: TransformError;
     };
+    "transformer:document-skipped": {
+        collection: AnyCollection;
+        filePath: string;
+        reason?: string;
+    };
 };
 type ErrorType$1 = "Validation" | "Configuration" | "Transform" | "Result";
 declare class TransformError extends Error {
@@ -299,7 +310,7 @@ declare function createBuilder(configurationPath: string, options?: Options, emi
         unsubscribe: () => Promise<void>;
     }>;
     on: {
-        <TKey extends "builder:start" | "builder:end" | "builder:created" | "watcher:file-changed" | "watcher:config-changed" | "watcher:config-reload-error" | "collector:read-error" | "collector:parse-error" | "transformer:validation-error" | "transformer:result-error" | "transformer:error" | "watcher:subscribe-error" | "watcher:subscribed" | "watcher:unsubscribed">(key: TKey, listener: (event: Events[TKey]) => void): void;
+        <TKey extends "builder:start" | "builder:end" | "builder:created" | "watcher:file-changed" | "watcher:config-changed" | "watcher:config-reload-error" | "collector:read-error" | "collector:parse-error" | "transformer:validation-error" | "transformer:result-error" | "transformer:error" | "transformer:document-skipped" | "watcher:subscribe-error" | "watcher:subscribed" | "watcher:unsubscribed">(key: TKey, listener: (event: Events[TKey]) => void): void;
         <TKey extends "_error" | "_all">(key: TKey, listener: (event: SystemEvents[TKey]) => void): void;
     };
 }>;
@@ -311,4 +322,4 @@ declare const deprecations: {
 type Deprecation = keyof typeof deprecations;
 declare function suppressDeprecatedWarnings(...deprecations: Array<Deprecation | "all">): void;
 
-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, defineParser, suppressDeprecatedWarnings };
+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, type SkippedSignal, TransformError, type Watcher, createBuilder, createDefaultImport, createNamedImport, defineCollection, defineConfig, defineParser, skippedSymbol, suppressDeprecatedWarnings };

package/dist/index.js

@@ -115,7 +115,7 @@ import { existsSync as existsSync2 } from "node:fs";
 import fs2 from "node:fs/promises";
 import path3 from "node:path";
 
-// ../../node_modules/.pnpm/bundle-require@5.0.0_esbuild@0.25.0/node_modules/bundle-require/dist/index.js
+// ../../node_modules/.pnpm/bundle-require@5.0.0_esbuild@0.25.6/node_modules/bundle-require/dist/index.js
 import {
   build,
   context
@@ -292,7 +292,7 @@ var loadTsConfigInternal = (dir = process.cwd(), name = "tsconfig.json", isExten
 };
 var loadTsConfig = (dir, name) => loadTsConfigInternal(dir, name);
 
-// ../../node_modules/.pnpm/bundle-require@5.0.0_esbuild@0.25.0/node_modules/bundle-require/dist/index.js
+// ../../node_modules/.pnpm/bundle-require@5.0.0_esbuild@0.25.6/node_modules/bundle-require/dist/index.js
 var tsconfigPathsToRegExp = (paths) => {
   return Object.keys(paths || {}).map((key) => {
     return new RegExp(`^${key.replace(/\*/, ".*")}$`);
@@ -693,12 +693,70 @@ function createSynchronizer(readCollectionFile, collections, baseDirectory = "."
 
 // src/transformer.ts
 import os from "node:os";
-import { basename, dirname as dirname2, extname } from "node:path";
+import { basename, dirname as dirname2, extname, join as join3 } from "node:path";
 import pLimit from "p-limit";
 
+// src/config.ts
+import { z } from "zod";
+
+// src/warn.ts
+var deprecations = {
+  legacySchema: `The use of a function as a schema is deprecated.
+Please use a StandardSchema compliant library directly.
+For more information, see:
+https://content-collections.dev/docs/deprecations/schema-as-function`
+};
+var _suppressDeprecatedWarnings = [];
+function suppressDeprecatedWarnings(...deprecations2) {
+  for (const deprecation of deprecations2) {
+    if (deprecation === "all") {
+      _suppressDeprecatedWarnings.push(
+        ...Object.keys(deprecations2)
+      );
+      return;
+    } else {
+      _suppressDeprecatedWarnings.push(deprecation);
+    }
+  }
+}
+function warnDeprecated(deprecation, logger = console.warn) {
+  if (_suppressDeprecatedWarnings.includes(deprecation)) {
+    return;
+  }
+  logger(`[CC DEPRECATED]: ${deprecations[deprecation]}`);
+}
+
+// src/config.ts
+var skippedSymbol = Symbol("skipped");
+var InvalidReturnTypeSymbol = Symbol(`InvalidReturnType`);
+function defineCollection(collection) {
+  let typeName = collection.typeName;
+  if (!typeName) {
+    typeName = generateTypeName(collection.name);
+  }
+  let parser = collection.parser;
+  if (!parser) {
+    parser = "frontmatter";
+  }
+  let schema2 = collection.schema;
+  if (!schema2["~standard"]) {
+    warnDeprecated("legacySchema");
+    schema2 = z.object(schema2(z));
+  }
+  return {
+    ...collection,
+    typeName,
+    parser,
+    schema: schema2
+  };
+}
+function defineConfig(config) {
+  return config;
+}
+
 // src/serializer.ts
 import serializeJs from "serialize-javascript";
-import z from "zod";
+import z2 from "zod";
 
 // src/import.ts
 var importSymbol = Symbol("import");
@@ -720,24 +778,24 @@ function createNamedImport(name, path10) {
 }
 
 // src/serializer.ts
-var literalSchema = z.union([
+var literalSchema = z2.union([
   // json
-  z.string(),
-  z.number(),
-  z.boolean(),
-  z.null(),
+  z2.string(),
+  z2.number(),
+  z2.boolean(),
+  z2.null(),
   // serializable-javascript
-  z.undefined(),
-  z.date(),
-  z.map(z.unknown(), z.unknown()),
-  z.set(z.unknown()),
-  z.bigint()
+  z2.undefined(),
+  z2.date(),
+  z2.map(z2.unknown(), z2.unknown()),
+  z2.set(z2.unknown()),
+  z2.bigint()
 ]);
-var schema = z.lazy(
-  () => z.union([literalSchema, z.array(schema), z.record(schema)])
+var schema = z2.lazy(
+  () => z2.union([literalSchema, z2.array(schema), z2.record(schema)])
 );
 var extension = "js";
-var serializableSchema = z.record(schema);
+var serializableSchema = z2.record(schema);
 function createImport(imp, variableName) {
   const variableDeclaration = imp.name ? `{ ${imp.name} as ${variableName} }` : variableName;
   return `import ${variableDeclaration} from "${imp.path}";
@@ -781,6 +839,9 @@ var TransformError = class extends Error {
     this.type = type;
   }
 };
+function isSkippedSignal(signal) {
+  return signal[skippedSymbol] === true;
+}
 function createPath(path10, ext) {
   let p = path10.slice(0, -ext.length);
   if (p.endsWith("/index")) {
@@ -872,7 +933,11 @@ function createTransformer(emitter, cacheManager) {
           return collection.documents.map((doc) => doc.document);
         }
       },
-      cache: cache.cacheFn
+      cache: cache.cacheFn,
+      skip: (reason) => ({
+        [skippedSymbol]: true,
+        reason
+      })
     };
   }
   async function transformDocument(collections, collection, transform, doc) {
@@ -881,10 +946,18 @@ function createTransformer(emitter, cacheManager) {
     try {
       const document = await transform(doc.document, context2);
       await cache.tidyUp();
-      return {
-        ...doc,
-        document
-      };
+      if (isSkippedSignal(document)) {
+        emitter.emit("transformer:document-skipped", {
+          collection,
+          filePath: join3(collection.directory, doc.document._meta.filePath),
+          reason: document.reason
+        });
+      } else {
+        return {
+          ...doc,
+          document
+        };
+      }
     } catch (error) {
       if (error instanceof TransformError) {
         emitter.emit("transformer:error", {
@@ -1283,63 +1356,6 @@ async function createBuilder(configurationPath, options = {
     on: emitter.on
   };
 }
-
-// src/config.ts
-import { z as z2 } from "zod";
-
-// src/warn.ts
-var deprecations = {
-  legacySchema: `The use of a function as a schema is deprecated.
-Please use a StandardSchema compliant library directly.
-For more information, see:
-https://content-collections.dev/docs/deprecations/schema-as-function`
-};
-var _suppressDeprecatedWarnings = [];
-function suppressDeprecatedWarnings(...deprecations2) {
-  for (const deprecation of deprecations2) {
-    if (deprecation === "all") {
-      _suppressDeprecatedWarnings.push(
-        ...Object.keys(deprecations2)
-      );
-      return;
-    } else {
-      _suppressDeprecatedWarnings.push(deprecation);
-    }
-  }
-}
-function warnDeprecated(deprecation, logger = console.warn) {
-  if (_suppressDeprecatedWarnings.includes(deprecation)) {
-    return;
-  }
-  logger(`[CC DEPRECATED]: ${deprecations[deprecation]}`);
-}
-
-// src/config.ts
-var InvalidReturnTypeSymbol = Symbol(`InvalidReturnType`);
-function defineCollection(collection) {
-  let typeName = collection.typeName;
-  if (!typeName) {
-    typeName = generateTypeName(collection.name);
-  }
-  let parser = collection.parser;
-  if (!parser) {
-    parser = "frontmatter";
-  }
-  let schema2 = collection.schema;
-  if (!schema2["~standard"]) {
-    warnDeprecated("legacySchema");
-    schema2 = z2.object(schema2(z2));
-  }
-  return {
-    ...collection,
-    typeName,
-    parser,
-    schema: schema2
-  };
-}
-function defineConfig(config) {
-  return config;
-}
 export {
   CollectError,
   ConfigurationError,
@@ -1351,5 +1367,6 @@ export {
   defineCollection,
   defineConfig,
   defineParser,
+  skippedSymbol,
   suppressDeprecatedWarnings
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@content-collections/core",
   "type": "module",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Core of Content Collections",
   "author": "Sebastian Sdorra <s.sdorra@gmail.com>",
   "license": "MIT",
@@ -33,12 +33,12 @@
     "@types/picomatch": "^3.0.1",
     "@types/pluralize": "^0.0.33",
     "@types/serialize-javascript": "^5.0.4",
-    "@vitest/coverage-v8": "^3.1.3",
+    "@vitest/coverage-v8": "^3.2.4",
     "bundle-require": "^5.0.0",
     "tsup": "^8.2.4",
     "tsx": "^4.19.2",
     "typescript": "^5.5.4",
-    "vitest": "^3.1.3"
+    "vitest": "^3.2.4"
   },
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
@@ -57,6 +57,6 @@
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts -d dist",
     "typecheck": "tsc",
-    "test": "vitest --run --coverage"
+    "test": "vitest --run --coverage --typecheck"
   }
 }