@code-pushup/models 0.69.4 → 0.70.0

package/src/lib/core-config.js

@@ -1,15 +1,15 @@
 import { z } from 'zod';
 import { categoriesSchema } from './category-config.js';
-import { getMissingRefsForCategories, missingRefsForCategoriesErrorMsg, } from './implementation/utils.js';
+import { createCheck } from './implementation/checks.js';
+import { findMissingSlugsInCategoryRefs } from './implementation/utils.js';
 import { persistConfigSchema } from './persist-config.js';
 import { pluginConfigSchema } from './plugin-config.js';
 import { uploadConfigSchema } from './upload-config.js';
 export const unrefinedCoreConfigSchema = z.object({
     plugins: z
-        .array(pluginConfigSchema, {
-        description: 'List of plugins to be used (official, community-provided, or custom)',
-    })
-        .min(1),
+        .array(pluginConfigSchema)
+        .min(1)
+        .describe('List of plugins to be used (official, community-provided, or custom)'),
     /** portal configuration for persisting results */
     persist: persistConfigSchema.optional(),
     /** portal configuration for uploading results */
@@ -24,8 +24,6 @@ export const coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
  */
 export function refineCoreConfig(schema) {
     // categories point to existing audit or group refs
-    return schema.refine(({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins), ({ categories, plugins }) => ({
-        message: missingRefsForCategoriesErrorMsg(categories, plugins),
-    }));
+    return schema.check(createCheck(findMissingSlugsInCategoryRefs));
 }
 //# sourceMappingURL=core-config.js.map

package/src/lib/core-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"core-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/core-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,2BAA2B,EAC3B,gCAAgC,GACjC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,kBAAkB,EAAE;QACzB,WAAW,EACT,sEAAsE;KACzE,CAAC;SACD,GAAG,CAAC,CAAC,CAAC;IACT,kDAAkD;IAClD,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,iDAAiD;IACjD,MAAM,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAwC;IACvE,mDAAmD;IACnD,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAC1B,CAAC,2BAA2B,CAAC,UAAU,EAAE,OAAO,CAAC,EACnD,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5B,OAAO,EAAE,gCAAgC,CAAC,UAAU,EAAE,OAAO,CAAC;KAC/D,CAAC,CACH,CAAC;AACJ,CAAC"}
+{"version":3,"file":"core-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/core-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,kBAAkB,CAAC;SACzB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,sEAAsE,CACvE;IACH,kDAAkD;IAClD,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,iDAAiD;IACjD,MAAM,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAwC;IACvE,mDAAmD;IACnD,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC,CAAC;AACnE,CAAC"}

package/src/lib/group.d.ts

@@ -2,13 +2,7 @@ import { z } from 'zod';
 export declare const groupRefSchema: z.ZodObject<{
     slug: z.ZodString;
     weight: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    slug: string;
-    weight: number;
-}, {
-    slug: string;
-    weight: number;
-}>;
+}, z.core.$strip>;
 /**
  * Type Definition: `GroupRef`
  *
@@ -23,17 +17,7 @@ export declare const groupMetaSchema: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
-}, "strip", z.ZodTypeAny, {
-    title: string;
-    description?: string | undefined;
-    docsUrl?: string | undefined;
-    isSkipped?: boolean | undefined;
-}, {
-    title: string;
-    description?: string | undefined;
-    docsUrl?: unknown;
-    isSkipped?: boolean | undefined;
-}>;
+}, z.core.$strip>;
 /**
  * Type Definition: `GroupMeta`
  *
@@ -43,56 +27,17 @@ export declare const groupMetaSchema: z.ZodObject<{
  * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupmeta}
  */
 export type GroupMeta = z.infer<typeof groupMetaSchema>;
-export declare const groupSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const groupSchema: z.ZodObject<{
     slug: z.ZodString;
-    refs: z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodObject<{
+    refs: z.ZodArray<z.ZodObject<{
         slug: z.ZodString;
         weight: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        slug: string;
-        weight: number;
-    }, {
-        slug: string;
-        weight: number;
-    }>, "many">, {
-        slug: string;
-        weight: number;
-    }[], {
-        slug: string;
-        weight: number;
-    }[]>, {
-        slug: string;
-        weight: number;
-    }[], {
-        slug: string;
-        weight: number;
-    }[]>;
-}, {
+    }, z.core.$strip>>;
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
-}>, "strip", z.ZodTypeAny, {
-    slug: string;
-    refs: {
-        slug: string;
-        weight: number;
-    }[];
-    title: string;
-    description?: string | undefined;
-    docsUrl?: string | undefined;
-    isSkipped?: boolean | undefined;
-}, {
-    slug: string;
-    refs: {
-        slug: string;
-        weight: number;
-    }[];
-    title: string;
-    description?: string | undefined;
-    docsUrl?: unknown;
-    isSkipped?: boolean | undefined;
-}>;
+}, z.core.$strip>;
 /**
  * Type Definition: `Group`
  *
@@ -102,73 +47,14 @@ export declare const groupSchema: z.ZodObject<z.objectUtil.extendShape<{
  * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#group}
  */
 export type Group = z.infer<typeof groupSchema>;
-export declare const groupsSchema: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
+export declare const groupsSchema: z.ZodOptional<z.ZodArray<z.ZodObject<{
     slug: z.ZodString;
-    refs: z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodObject<{
+    refs: z.ZodArray<z.ZodObject<{
         slug: z.ZodString;
         weight: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        slug: string;
-        weight: number;
-    }, {
-        slug: string;
-        weight: number;
-    }>, "many">, {
-        slug: string;
-        weight: number;
-    }[], {
-        slug: string;
-        weight: number;
-    }[]>, {
-        slug: string;
-        weight: number;
-    }[], {
-        slug: string;
-        weight: number;
-    }[]>;
-}, {
+    }, z.core.$strip>>;
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
-}>, "strip", z.ZodTypeAny, {
-    slug: string;
-    refs: {
-        slug: string;
-        weight: number;
-    }[];
-    title: string;
-    description?: string | undefined;
-    docsUrl?: string | undefined;
-    isSkipped?: boolean | undefined;
-}, {
-    slug: string;
-    refs: {
-        slug: string;
-        weight: number;
-    }[];
-    title: string;
-    description?: string | undefined;
-    docsUrl?: unknown;
-    isSkipped?: boolean | undefined;
-}>, "many">>, {
-    slug: string;
-    refs: {
-        slug: string;
-        weight: number;
-    }[];
-    title: string;
-    description?: string | undefined;
-    docsUrl?: string | undefined;
-    isSkipped?: boolean | undefined;
-}[] | undefined, {
-    slug: string;
-    refs: {
-        slug: string;
-        weight: number;
-    }[];
-    title: string;
-    description?: string | undefined;
-    docsUrl?: unknown;
-    isSkipped?: boolean | undefined;
-}[] | undefined>;
+}, z.core.$strip>>>;

package/src/lib/group.js

@@ -1,6 +1,7 @@
 import { z } from 'zod';
+import { createDuplicateSlugsCheck, createDuplicatesCheck, } from './implementation/checks.js';
 import { metaSchema, scorableSchema, weightedRefSchema, } from './implementation/schemas.js';
-import { errorItems, exists, hasDuplicateStrings, } from './implementation/utils.js';
+import { formatSlugsList } from './implementation/utils.js';
 export const groupRefSchema = weightedRefSchema('Weighted reference to a group', "Reference slug to a group within this plugin (e.g. 'max-lines')");
 export const groupMetaSchema = metaSchema({
     titleDescription: 'Descriptive name for the group',
@@ -10,32 +11,10 @@ export const groupMetaSchema = metaSchema({
     isSkippedDescription: 'Indicates whether the group is skipped',
 });
 export const groupSchema = scorableSchema('A group aggregates a set of audits into a single score which can be referenced from a category. ' +
-    'E.g. the group slug "performance" groups audits and can be referenced in a category', groupRefSchema, getDuplicateRefsInGroups, duplicateRefsInGroupsErrorMsg).merge(groupMetaSchema);
+    'E.g. the group slug "performance" groups audits and can be referenced in a category', groupRefSchema, createDuplicatesCheck(({ slug }) => slug, duplicates => `Group has duplicate references to audits: ${formatSlugsList(duplicates)}`)).merge(groupMetaSchema);
 export const groupsSchema = z
-    .array(groupSchema, {
-    description: 'List of groups',
-})
+    .array(groupSchema)
+    .check(createDuplicateSlugsCheck('Group'))
     .optional()
-    .refine(groups => !getDuplicateSlugsInGroups(groups), groups => ({
-    message: duplicateSlugsInGroupsErrorMsg(groups),
-}));
-// ============
-// helper for validator: group refs are unique
-function duplicateRefsInGroupsErrorMsg(groups) {
-    const duplicateRefs = getDuplicateRefsInGroups(groups);
-    return `In plugin groups the following references are not unique: ${errorItems(duplicateRefs)}`;
-}
-function getDuplicateRefsInGroups(groups) {
-    return hasDuplicateStrings(groups.map(({ slug: ref }) => ref).filter(exists));
-}
-// helper for validator: group refs are unique
-function duplicateSlugsInGroupsErrorMsg(groups) {
-    const duplicateRefs = getDuplicateSlugsInGroups(groups);
-    return `In groups the following slugs are not unique: ${errorItems(duplicateRefs)}`;
-}
-function getDuplicateSlugsInGroups(groups) {
-    return Array.isArray(groups)
-        ? hasDuplicateStrings(groups.map(({ slug }) => slug))
-        : false;
-}
+    .describe('List of groups');
 //# sourceMappingURL=group.js.map

package/src/lib/group.js.map

@@ -1 +1 @@
-{"version":3,"file":"group.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAEL,UAAU,EACV,cAAc,EACd,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,UAAU,EACV,MAAM,EACN,mBAAmB,GACpB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAC7C,+BAA+B,EAC/B,iEAAiE,CAClE,CAAC;AAGF,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACxC,gBAAgB,EAAE,gCAAgC;IAClD,sBAAsB,EAAE,qCAAqC;IAC7D,kBAAkB,EAAE,0BAA0B;IAC9C,WAAW,EAAE,gBAAgB;IAC7B,oBAAoB,EAAE,wCAAwC;CAC/D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CACvC,kGAAkG;IAChG,qFAAqF,EACvF,cAAc,EACd,wBAAwB,EACxB,6BAA6B,CAC9B,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAIzB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,KAAK,CAAC,WAAW,EAAE;IAClB,WAAW,EAAE,gBAAgB;CAC9B,CAAC;KACD,QAAQ,EAAE;KACV,MAAM,CACL,MAAM,CAAC,EAAE,CAAC,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAC5C,MAAM,CAAC,EAAE,CAAC,CAAC;IACT,OAAO,EAAE,8BAA8B,CAAC,MAAM,CAAC;CAChD,CAAC,CACH,CAAC;AAEJ,eAAe;AAEf,8CAA8C;AAC9C,SAAS,6BAA6B,CAAC,MAAqB;IAC1D,MAAM,aAAa,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO,6DAA6D,UAAU,CAC5E,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAqB;IACrD,OAAO,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,8CAA8C;AAC9C,SAAS,8BAA8B,CAAC,MAA2B;IACjE,MAAM,aAAa,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,iDAAiD,UAAU,CAChE,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,MAA2B;IAC5D,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAC1B,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC,KAAK,CAAC;AACZ,CAAC"}
+{"version":3,"file":"group.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,UAAU,EACV,cAAc,EACd,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAC7C,+BAA+B,EAC/B,iEAAiE,CAClE,CAAC;AAGF,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACxC,gBAAgB,EAAE,gCAAgC;IAClD,sBAAsB,EAAE,qCAAqC;IAC7D,kBAAkB,EAAE,0BAA0B;IAC9C,WAAW,EAAE,gBAAgB;IAC7B,oBAAoB,EAAE,wCAAwC;CAC/D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CACvC,kGAAkG;IAChG,qFAAqF,EACvF,cAAc,EACd,qBAAqB,CACnB,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,EAClB,UAAU,CAAC,EAAE,CACX,6CAA6C,eAAe,CAAC,UAAU,CAAC,EAAE,CAC7E,CACF,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAIzB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,KAAK,CAAC,WAAW,CAAC;KAClB,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;KACzC,QAAQ,EAAE;KACV,QAAQ,CAAC,gBAAgB,CAAC,CAAC"}

package/src/lib/implementation/checks.d.ts

@@ -0,0 +1,8 @@
+import type { z } from 'zod';
+export declare function createCheck<T>(findErrorFn: (value: T) => false | {
+    message: string;
+}): z.core.CheckFn<T>;
+export declare function createDuplicatesCheck<T>(keyFn: (item: T) => string, errorMsgFn: (duplicates: string[]) => string): z.core.CheckFn<T[]>;
+export declare function createDuplicateSlugsCheck<T extends {
+    slug: string;
+}>(name: 'Audit' | 'Plugin' | 'Category' | 'Group'): z.core.CheckFn<T[]>;

package/src/lib/implementation/checks.js

@@ -0,0 +1,28 @@
+import { hasDuplicateStrings } from './utils.js';
+export function createCheck(findErrorFn) {
+    return ctx => {
+        const error = findErrorFn(ctx.value);
+        if (error) {
+            // eslint-disable-next-line functional/immutable-data, no-param-reassign
+            ctx.issues = [
+                ...ctx.issues,
+                {
+                    code: 'custom',
+                    message: error.message,
+                    input: ctx.value,
+                },
+            ];
+        }
+    };
+}
+export function createDuplicatesCheck(keyFn, errorMsgFn) {
+    return createCheck(items => {
+        const keys = items.map(keyFn);
+        const duplicates = hasDuplicateStrings(keys);
+        return duplicates && { message: errorMsgFn(duplicates) };
+    });
+}
+export function createDuplicateSlugsCheck(name) {
+    return createDuplicatesCheck(({ slug }) => slug, duplicates => `${name} slugs must be unique, but received duplicates: ${duplicates.map(slug => JSON.stringify(slug)).join(', ')}`);
+}
+//# sourceMappingURL=checks.js.map

package/src/lib/implementation/checks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/checks.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,UAAU,WAAW,CACzB,WAAsD;IAEtD,OAAO,GAAG,CAAC,EAAE;QACX,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE,CAAC;YACV,wEAAwE;YACxE,GAAG,CAAC,MAAM,GAAG;gBACX,GAAG,GAAG,CAAC,MAAM;gBACb;oBACE,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,KAAK,EAAE,GAAG,CAAC,KAAK;iBACjB;aACF,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,KAA0B,EAC1B,UAA4C;IAE5C,OAAO,WAAW,CAAC,KAAK,CAAC,EAAE;QACzB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,UAAU,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,IAA+C;IAE/C,OAAO,qBAAqB,CAC1B,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,EAClB,UAAU,CAAC,EAAE,CACX,GAAG,IAAI,mDAAmD,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACtH,CAAC;AACJ,CAAC"}

package/src/lib/implementation/function.d.ts

@@ -0,0 +1,22 @@
+import { z } from 'zod/v4';
+import type { $ZodFunction } from 'zod/v4/core';
+/**
+ * Converts Zod v4 function factory (returned by `z.function`) to Zod schema.
+ *
+ * Supports asynchronous functions. For synchronous functions, you can use {@link convertSyncZodFunctionToSchema}.
+ *
+ * @param factory `z.function({  input: [...], output: ... })`
+ * @returns Zod schema with compile-time and runtime validations.
+ */
+export declare function convertAsyncZodFunctionToSchema<T extends $ZodFunction>(factory: T): z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<Awaited<Parameters<T["implementAsync"]>[0] extends infer T_1 ? T_1 extends Parameters<T["implementAsync"]>[0] ? T_1 extends z.core.$InferOuterFunctionTypeAsync<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut> ? T_1 : z.core.$InferOuterFunctionTypeAsync<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut> : never : never>, unknown>>;
+/**
+ * Converts Zod v4 function factory (returned by `z.function`) to Zod schema.
+ *
+ * **IMPORTANT!** Use for synchronous functions only. For asynchronous functions use {@link convertAsyncZodFunctionToSchema}.
+ *
+ * @throws `Encountered Promise during synchronous parse. Use .parseAsync() instead.` if used with async functions.
+ *
+ * @param factory `z.function({  input: [...], output: ... })`
+ * @returns Zod schema with compile-time and runtime validations.
+ */
+export declare function convertSyncZodFunctionToSchema<T extends $ZodFunction>(factory: T): z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<(...args: Parameters<T["_output"]>) => ReturnType<Parameters<T["implement"]>[0]> extends ReturnType<T["_output"]> ? ReturnType<Parameters<T["implement"]>[0]> : ReturnType<T["_output"]>, unknown>>;

package/src/lib/implementation/function.js

@@ -0,0 +1,53 @@
+import { z } from 'zod/v4';
+// https://zod.dev/v4/changelog?id=zfunction
+// https://github.com/colinhacks/zod/issues/4143#issuecomment-2931729793
+// https://github.com/matejchalk/zod2md?tab=readme-ov-file#function-schemas
+/**
+ * Converts Zod v4 function factory (returned by `z.function`) to Zod schema.
+ *
+ * Supports asynchronous functions. For synchronous functions, you can use {@link convertSyncZodFunctionToSchema}.
+ *
+ * @param factory `z.function({  input: [...], output: ... })`
+ * @returns Zod schema with compile-time and runtime validations.
+ */
+export function convertAsyncZodFunctionToSchema(factory) {
+    return z
+        .custom()
+        .transform((arg, ctx) => {
+        if (typeof arg !== 'function') {
+            ctx.addIssue(`Expected function, received ${typeof arg}`);
+            return z.NEVER;
+        }
+        return factory.implementAsync(arg);
+    })
+        .meta({
+        // enables zod2md to include function signature in docs
+        $ZodFunction: factory,
+    });
+}
+/**
+ * Converts Zod v4 function factory (returned by `z.function`) to Zod schema.
+ *
+ * **IMPORTANT!** Use for synchronous functions only. For asynchronous functions use {@link convertAsyncZodFunctionToSchema}.
+ *
+ * @throws `Encountered Promise during synchronous parse. Use .parseAsync() instead.` if used with async functions.
+ *
+ * @param factory `z.function({  input: [...], output: ... })`
+ * @returns Zod schema with compile-time and runtime validations.
+ */
+export function convertSyncZodFunctionToSchema(factory) {
+    return z
+        .custom()
+        .transform((arg, ctx) => {
+        if (typeof arg !== 'function') {
+            ctx.addIssue(`Expected function, received ${typeof arg}`);
+            return z.NEVER;
+        }
+        return factory.implement(arg);
+    })
+        .meta({
+        // enables zod2md to include function signature in docs
+        $ZodFunction: factory,
+    });
+}
+//# sourceMappingURL=function.js.map

package/src/lib/implementation/function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/function.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAG3B,4CAA4C;AAC5C,wEAAwE;AACxE,2EAA2E;AAE3E;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAC7C,OAAU;IAEV,OAAO,CAAC;SACL,MAAM,EAAE;SACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACtB,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE,CAAC;YAC9B,GAAG,CAAC,QAAQ,CAAC,+BAA+B,OAAO,GAAG,EAAE,CAAC,CAAC;YAC1D,OAAO,CAAC,CAAC,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,OAAO,CAAC,cAAc,CAAC,GAAyC,CAAC,CAAC;IAC3E,CAAC,CAAC;SACD,IAAI,CAAC;QACJ,uDAAuD;QACvD,YAAY,EAAE,OAAO;KACtB,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,8BAA8B,CAC5C,OAAU;IAEV,OAAO,CAAC;SACL,MAAM,EAAE;SACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACtB,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE,CAAC;YAC9B,GAAG,CAAC,QAAQ,CAAC,+BAA+B,OAAO,GAAG,EAAE,CAAC,CAAC;YAC1D,OAAO,CAAC,CAAC,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,OAAO,CAAC,SAAS,CAAC,GAAoC,CAAC,CAAC;IACjE,CAAC,CAAC;SACD,IAAI,CAAC;QACJ,uDAAuD;QACvD,YAAY,EAAE,OAAO;KACtB,CAAC,CAAC;AACP,CAAC"}