@williamthorsen/release-kit 5.2.1 → 5.3.0

package/dist/esm/types.d.ts

@@ -1,9 +1,11 @@
+import { z } from 'zod';
 export type ReleaseType = 'major' | 'minor' | 'patch';
 export type ChangelogAudience = 'all' | 'dev';
 export interface ChangelogItem {
     description: string;
     body?: string;
     breaking?: boolean;
+    hash?: string;
 }
 export interface ChangelogSection {
     title: string;
@@ -20,12 +22,16 @@ export interface ChangelogJsonConfig {
     outputPath: string;
     devOnlySections: string[];
 }
+export interface ChangelogOverride {
+    audience?: 'all' | 'dev' | 'skip';
+    description?: string;
+    body?: string;
+    breaking?: boolean;
+}
+export type ChangelogOverridesFile = Record<string, ChangelogOverride>;
 export interface ReleaseNotesConfig {
     shouldInjectIntoReadme: boolean;
 }
-export interface ProjectConfig {
-    tagPrefix?: string;
-}
 export interface ResolvedProjectConfig {
     tagPrefix: string;
 }
@@ -114,39 +120,100 @@ export interface PrepareResult {
 }
 export interface WorkTypeConfig {
     header: string;
-    aliases?: string[];
+    aliases?: string[] | undefined;
 }
 export interface VersionPatterns {
     major: string[];
     minor: string[];
 }
-export interface ReleaseKitConfig {
-    workspaces?: WorkspaceOverride[];
-    versionPatterns?: VersionPatterns;
-    workTypes?: Record<string, WorkTypeConfig>;
-    breakingPolicies?: Record<string, 'forbidden' | 'optional' | 'required'>;
-    formatCommand?: string;
-    cliffConfigPath?: string;
-    scopeAliases?: Record<string, string>;
-    changelogJson?: Partial<ChangelogJsonConfig>;
-    releaseNotes?: Partial<ReleaseNotesConfig>;
-    retiredPackages?: RetiredPackage[];
-    project?: ProjectConfig;
-}
-export interface LegacyIdentity {
-    name: string;
-    tagPrefix: string;
-}
-export interface RetiredPackage {
-    name: string;
-    tagPrefix: string;
-    successor?: string;
-}
-export interface WorkspaceOverride {
-    dir: string;
-    shouldExclude?: boolean;
-    legacyIdentities?: LegacyIdentity[];
-}
+export declare const legacyIdentitySchema: z.ZodObject<{
+    name: z.ZodString;
+    tagPrefix: z.ZodString;
+}, z.core.$strict>;
+export type LegacyIdentity = z.infer<typeof legacyIdentitySchema>;
+export declare const retiredPackageSchema: z.ZodObject<{
+    name: z.ZodString;
+    tagPrefix: z.ZodString;
+    successor: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type RetiredPackage = z.infer<typeof retiredPackageSchema>;
+export declare const workspaceOverrideSchema: z.ZodObject<{
+    dir: z.ZodString;
+    shouldExclude: z.ZodOptional<z.ZodBoolean>;
+    legacyIdentities: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        tagPrefix: z.ZodString;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type WorkspaceOverride = z.infer<typeof workspaceOverrideSchema>;
+export declare const projectConfigSchema: z.ZodObject<{
+    tagPrefix: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ProjectConfig = z.infer<typeof projectConfigSchema>;
+export declare const changelogJsonInputSchema: z.ZodObject<{
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    outputPath: z.ZodOptional<z.ZodString>;
+    devOnlySections: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+export declare const releaseNotesInputSchema: z.ZodObject<{
+    shouldInjectIntoReadme: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export declare const workTypeConfigSchema: z.ZodObject<{
+    header: z.ZodString;
+    aliases: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+export declare const versionPatternsSchema: z.ZodObject<{
+    major: z.ZodArray<z.ZodString>;
+    minor: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export declare const breakingPolicyValueSchema: z.ZodEnum<{
+    optional: "optional";
+    forbidden: "forbidden";
+    required: "required";
+}>;
+export declare const releaseKitConfigSchema: z.ZodObject<{
+    breakingPolicies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<{
+        optional: "optional";
+        forbidden: "forbidden";
+        required: "required";
+    }>>>;
+    changelogJson: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodOptional<z.ZodBoolean>;
+        outputPath: z.ZodOptional<z.ZodString>;
+        devOnlySections: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    cliffConfigPath: z.ZodOptional<z.ZodString>;
+    formatCommand: z.ZodOptional<z.ZodString>;
+    project: z.ZodOptional<z.ZodObject<{
+        tagPrefix: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    releaseNotes: z.ZodOptional<z.ZodObject<{
+        shouldInjectIntoReadme: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    retiredPackages: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        tagPrefix: z.ZodString;
+        successor: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>>;
+    scopeAliases: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    versionPatterns: z.ZodOptional<z.ZodObject<{
+        major: z.ZodArray<z.ZodString>;
+        minor: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    workspaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        dir: z.ZodString;
+        shouldExclude: z.ZodOptional<z.ZodBoolean>;
+        legacyIdentities: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            tagPrefix: z.ZodString;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>>>;
+    workTypes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        header: z.ZodString;
+        aliases: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type ReleaseKitConfig = z.infer<typeof releaseKitConfigSchema>;
 export interface Commit {
     message: string;
     hash: string;

package/dist/esm/types.js

@@ -0,0 +1,60 @@
+import { z } from "zod";
+const legacyIdentitySchema = z.object({
+  name: z.string().min(1),
+  tagPrefix: z.string().min(1)
+}).strict();
+const retiredPackageSchema = z.object({
+  name: z.string().min(1),
+  tagPrefix: z.string().min(1),
+  successor: z.string().min(1).optional()
+}).strict();
+const workspaceOverrideSchema = z.object({
+  dir: z.string().min(1),
+  shouldExclude: z.boolean().optional(),
+  legacyIdentities: z.array(legacyIdentitySchema).optional()
+}).strict();
+const projectConfigSchema = z.object({
+  tagPrefix: z.string().min(1).optional()
+}).strict();
+const changelogJsonInputSchema = z.object({
+  enabled: z.boolean().optional(),
+  outputPath: z.string().optional(),
+  devOnlySections: z.array(z.string()).optional()
+}).strict();
+const releaseNotesInputSchema = z.object({
+  shouldInjectIntoReadme: z.boolean().optional()
+}).strict();
+const workTypeConfigSchema = z.object({
+  header: z.string(),
+  aliases: z.array(z.string()).optional()
+}).strict();
+const versionPatternsSchema = z.object({
+  major: z.array(z.string()),
+  minor: z.array(z.string())
+}).strict();
+const breakingPolicyValueSchema = z.enum(["forbidden", "optional", "required"]);
+const releaseKitConfigSchema = z.object({
+  breakingPolicies: z.record(z.string(), breakingPolicyValueSchema).optional(),
+  changelogJson: changelogJsonInputSchema.optional(),
+  cliffConfigPath: z.string().min(1).optional(),
+  formatCommand: z.string().min(1).optional(),
+  project: projectConfigSchema.optional(),
+  releaseNotes: releaseNotesInputSchema.optional(),
+  retiredPackages: z.array(retiredPackageSchema).optional(),
+  scopeAliases: z.record(z.string(), z.string()).optional(),
+  versionPatterns: versionPatternsSchema.optional(),
+  workspaces: z.array(workspaceOverrideSchema).optional(),
+  workTypes: z.record(z.string(), workTypeConfigSchema).optional()
+}).strict();
+export {
+  breakingPolicyValueSchema,
+  changelogJsonInputSchema,
+  legacyIdentitySchema,
+  projectConfigSchema,
+  releaseKitConfigSchema,
+  releaseNotesInputSchema,
+  retiredPackageSchema,
+  versionPatternsSchema,
+  workTypeConfigSchema,
+  workspaceOverrideSchema
+};