@code-pushup/models 0.2.0 → 0.3.0

package/index.js

@@ -5,6 +5,11 @@ import { z as z2 } from "zod";
 import { z } from "zod";
 import { MATERIAL_ICONS } from "@code-pushup/portal-client";
 
+// packages/models/src/lib/implementation/limits.ts
+var MAX_SLUG_LENGTH = 128;
+var MAX_TITLE_LENGTH = 256;
+var MAX_DESCRIPTION_LENGTH = 65536;
+
 // packages/models/src/lib/implementation/utils.ts
 var slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
@@ -40,12 +45,12 @@ function executionMetaSchema(options = {
 function slugSchema(description = "Unique ID (human-readable, URL-safe)") {
   return z.string({ description }).regex(slugRegex, {
     message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
-  }).max(128, {
-    message: "slug can be max 128 characters long"
+  }).max(MAX_SLUG_LENGTH, {
+    message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
   });
 }
 function descriptionSchema(description = "Description (markdown)") {
-  return z.string({ description }).max(65536).optional();
+  return z.string({ description }).max(MAX_DESCRIPTION_LENGTH).optional();
 }
 function docsUrlSchema(description = "Documentation site") {
   return urlSchema(description).optional().or(z.string().max(0));
@@ -54,7 +59,7 @@ function urlSchema(description) {
   return z.string({ description }).url();
 }
 function titleSchema(description = "Descriptive name") {
-  return z.string({ description }).max(256);
+  return z.string({ description }).max(MAX_TITLE_LENGTH);
 }
 function metaSchema(options) {
   const {
@@ -522,6 +527,9 @@ var reportSchema = packageVersionSchema({
   )
 );
 export {
+  MAX_DESCRIPTION_LENGTH,
+  MAX_SLUG_LENGTH,
+  MAX_TITLE_LENGTH,
   auditGroupSchema,
   auditOutputsSchema,
   auditReportSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "dependencies": {
     "zod": "^3.22.1",
     "@code-pushup/portal-client": "^0.1.2"

package/src/index.d.ts

@@ -1,12 +1,13 @@
-export { CategoryConfig, CategoryRef, categoryRefSchema, categoryConfigSchema, } from './lib/category-config';
+export { CategoryConfig, CategoryRef, categoryConfigSchema, categoryRefSchema, } from './lib/category-config';
 export { CoreConfig, coreConfigSchema, refineCoreConfig, unrefinedCoreConfigSchema, } from './lib/core-config';
+export { MAX_DESCRIPTION_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits';
+export { materialIconSchema } from './lib/implementation/schemas';
 export { Format, PersistConfig, formatSchema, persistConfigSchema, } from './lib/persist-config';
 export { PluginConfig, pluginConfigSchema } from './lib/plugin-config';
-export { auditSchema, Audit, pluginAuditsSchema, } from './lib/plugin-config-audits';
-export { AuditGroupRef, AuditGroup, auditGroupSchema, } from './lib/plugin-config-groups';
+export { Audit, auditSchema, pluginAuditsSchema, } from './lib/plugin-config-audits';
+export { AuditGroup, AuditGroupRef, auditGroupSchema, } from './lib/plugin-config-groups';
+export { OnProgress, RunnerConfig, RunnerFunction, onProgressSchema, runnerConfigSchema, } from './lib/plugin-config-runner';
 export { AuditOutput, AuditOutputs, auditOutputsSchema, } from './lib/plugin-process-output';
 export { Issue, IssueSeverity } from './lib/plugin-process-output-audit-issue';
-export { AuditReport, auditReportSchema, PluginReport, Report, pluginReportSchema, reportSchema, } from './lib/report';
+export { AuditReport, PluginReport, Report, auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report';
 export { UploadConfig, uploadConfigSchema } from './lib/upload-config';
-export { materialIconSchema } from './lib/implementation/schemas';
-export { onProgressSchema, OnProgress, RunnerFunction, runnerConfigSchema, RunnerConfig, } from './lib/plugin-config-runner';

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

@@ -0,0 +1,3 @@
+export declare const MAX_SLUG_LENGTH = 128;
+export declare const MAX_TITLE_LENGTH = 256;
+export declare const MAX_DESCRIPTION_LENGTH = 65536;