@content-collections/core 0.8.2 → 0.9.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import z__default, { ZodRawShape, z as z$1, ZodObject, ZodTypeAny, ZodString } from 'zod';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import z__default, { ZodRawShape, z as z$1, ZodObject } from 'zod';
 export * from 'zod';
 
 type Options$2 = {
@@ -16,8 +17,14 @@ 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;
+type ParseFn = (content: string) => Record<string, unknown> | Promise<Record<string, unknown>>;
+type Parser = {
+    hasContent: boolean;
+    parse: ParseFn;
+};
+type PredefinedParsers = typeof parsers;
+type PredefinedParser = keyof typeof parsers;
+type ConfiguredParser = PredefinedParser | Parser;
 declare function parseYaml(content: string): any;
 declare function frontmatterParser(fileContent: string): {
     content: string;
@@ -26,23 +33,28 @@ declare function frontmatterOnlyParser(fileContent: string): {
     [key: string]: any;
 };
 declare const parsers: {
-    readonly frontmatter: {
-        readonly hasContent: true;
-        readonly parse: typeof frontmatterParser;
+    frontmatter: {
+        hasContent: true;
+        parse: typeof frontmatterParser;
     };
-    readonly "frontmatter-only": {
-        readonly hasContent: false;
-        readonly parse: typeof frontmatterOnlyParser;
+    "frontmatter-only": {
+        hasContent: false;
+        parse: typeof frontmatterOnlyParser;
     };
-    readonly json: {
-        readonly hasContent: false;
-        readonly parse: (text: string, reviver?: (this: any, key: string, value: any) => any) => any;
+    json: {
+        hasContent: false;
+        parse: (text: string, reviver?: (this: any, key: string, value: any) => any) => any;
     };
-    readonly yaml: {
-        readonly hasContent: false;
-        readonly parse: typeof parseYaml;
+    yaml: {
+        hasContent: false;
+        parse: typeof parseYaml;
     };
 };
+type DefineParserResult<TArgument extends Parser | ParseFn> = TArgument extends Function ? {
+    hasContent: false;
+    parse: ParseFn;
+} : TArgument extends infer Parser ? Parser : never;
+declare function defineParser<TArgument extends Parser | ParseFn>(parser: TArgument): DefineParserResult<TArgument>;
 
 declare const literalSchema: z__default.ZodUnion<[z__default.ZodString, z__default.ZodNumber, z__default.ZodBoolean, z__default.ZodNull, z__default.ZodUndefined, z__default.ZodDate, z__default.ZodMap<z__default.ZodUnknown, z__default.ZodUnknown>, z__default.ZodSet<z__default.ZodUnknown>, z__default.ZodBigInt]>;
 type Literal = z__default.infer<typeof literalSchema>;
@@ -64,18 +76,24 @@ type Meta = {
     extension: string;
 };
 type WithContent = {
-    content: ZodString;
+    content: string;
 };
-type AddContent<TShape extends ZodRawShape> = TShape extends {
-    content: ZodTypeAny;
-} ? TShape : TShape & WithContent;
-type GetParsedShape<TParser extends Parser, TShape extends ZodRawShape> = Parsers[TParser]["hasContent"] extends true ? AddContent<TShape> : TShape;
-type GetShape<TParser extends Parser | undefined, TShape extends ZodRawShape> = TParser extends Parser ? GetParsedShape<TParser, TShape> : AddContent<TShape>;
-type Schema<TParser extends Parser | undefined, TShape extends ZodRawShape> = z$1.infer<ZodObject<GetShape<TParser, TShape>>> & {
+type AddContent<TOutput> = TOutput extends {
+    content: any;
+} ? TOutput : TOutput & WithContent;
+type GetParser<TParser extends ConfiguredParser> = TParser extends PredefinedParser ? PredefinedParsers[TParser] : TParser;
+type HasContent<TParser extends ConfiguredParser> = GetParser<TParser>["hasContent"];
+type LegacySchema<TResult extends ZodRawShape = ZodRawShape> = (z: Z) => TResult;
+type TSchemaProp = StandardSchemaV1 | LegacySchema;
+type GetLegacySchemaShape<LegacySchema> = LegacySchema extends (z: Z) => infer TObjectShape ? TObjectShape : never;
+type GetOutputShape<TShape extends TSchemaProp> = TShape extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TShape> : TShape extends ZodObject<any> ? z$1.infer<TShape> : TShape extends LegacySchema ? z$1.infer<ZodObject<GetLegacySchemaShape<TShape>>> : never;
+type GetOutput<TParser extends ConfiguredParser, TShape extends TSchemaProp, TOutput = GetOutputShape<TShape>> = HasContent<TParser> extends true ? AddContent<TOutput> : TOutput;
+type Schema<TParser extends ConfiguredParser, TShape extends TSchemaProp> = GetOutput<TParser, TShape> & {
     _meta: Meta;
 };
+type GetSchema<TCollection extends AnyCollection> = TCollection extends Collection<any, infer TSchema, any, any, any, any> ? GetOutputShape<TSchema> : never;
 type Context<TSchema = unknown> = {
-    documents<TCollection extends AnyCollection>(collection: TCollection): Array<Schema<TCollection["parser"], TCollection["schema"]>>;
+    documents<TCollection extends AnyCollection>(collection: TCollection): Array<GetSchema<TCollection>>;
     cache: CacheFn;
     collection: {
         name: string;
@@ -84,23 +102,23 @@ type Context<TSchema = unknown> = {
     };
 };
 type Z = typeof z$1;
-type CollectionRequest<TName extends string, TShape extends ZodRawShape, TParser, TSchema, TTransformResult, TDocument> = {
+type CollectionRequest<TName extends string, TShape extends TSchemaProp, TParser, TSchema, TTransformResult, TDocument> = {
     name: TName;
     parser?: TParser;
     typeName?: string;
-    schema: (z: Z) => TShape;
+    schema: TShape;
     transform?: (data: TSchema, context: Context<TSchema>) => TTransformResult;
     directory: string;
     include: string | string[];
     exclude?: string | string[];
     onSuccess?: (documents: Array<TDocument>) => void | Promise<void>;
 };
-type Collection<TName extends string, TShape extends ZodRawShape, TParser extends Parser, TSchema, TTransformResult, TDocument> = Omit<CollectionRequest<TName, TShape, TParser, TSchema, TTransformResult, TDocument>, "schema"> & {
+type Collection<TName extends string, TShape extends TSchemaProp, TParser extends ConfiguredParser, TSchema, TTransformResult, TDocument> = Omit<CollectionRequest<TName, TShape, TParser, TSchema, TTransformResult, TDocument>, "schema"> & {
     typeName: string;
-    schema: TShape;
+    schema: StandardSchemaV1;
     parser: TParser;
 };
-type AnyCollection = Collection<any, ZodRawShape, Parser, any, any, any>;
+type AnyCollection = Collection<any, TSchemaProp, ConfiguredParser, any, any, any>;
 declare const InvalidReturnTypeSymbol: unique symbol;
 type InvalidReturnType<TMessage extends string, TObject> = {
     [InvalidReturnTypeSymbol]: TMessage;
@@ -109,7 +127,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 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;
+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;
 type Cache = "memory" | "file" | "none";
 type Configuration<TCollections extends Array<AnyCollection>> = {
     collections: TCollections;
@@ -132,7 +150,7 @@ type CollectionFile = {
 type CollectionByName<TConfiguration extends AnyConfiguration> = {
     [TCollection in TConfiguration["collections"][number] as TCollection["name"]]: TCollection;
 };
-type GetDocument<TCollection extends AnyCollection> = TCollection extends Collection<any, ZodRawShape, any, any, any, infer TDocument> ? TDocument : never;
+type GetDocument<TCollection extends AnyCollection> = TCollection extends Collection<any, any, any, any, any, infer TDocument> ? TDocument : never;
 type GetTypeByName<TConfiguration extends AnyConfiguration, TName extends keyof CollectionByName<TConfiguration>, TCollection = CollectionByName<TConfiguration>[TName]> = TCollection extends AnyCollection ? GetDocument<TCollection> : never;
 
 type CollectorEvents = {
@@ -284,4 +302,10 @@ 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, createDefaultImport, createNamedImport, defineCollection, defineConfig };
+declare const deprecations: {
+    legacySchema: string;
+};
+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 };