@tallyrelease/cli 0.1.1-beta.1 → 0.2.0-beta.7

package/dist/plan-schema.d.ts

@@ -0,0 +1,127 @@
+import { z } from "zod";
+import type { Plan } from "@tallyrelease/core";
+/** True only for identical types, including optional fields. */
+type Equals<A, B> = (<T>() => T extends A ? 1 : 2) extends <T>() => T extends B ? 1 : 2 ? true : false;
+/** Schema of `tallyrelease plan --json`, published as `plan.schema.json`. */
+export declare const planSchema: z.ZodObject<{
+    line: z.ZodNullable<z.ZodObject<{
+        rule: z.ZodString;
+        kind: z.ZodEnum<{
+            default: "default";
+            maintenance: "maintenance";
+        }>;
+        channel: z.ZodNullable<z.ZodString>;
+        maxBump: z.ZodNullable<z.ZodEnum<{
+            patch: "patch";
+            minor: "minor";
+        }>>;
+        absolute: z.ZodNullable<z.ZodObject<{
+            unit: z.ZodNullable<z.ZodString>;
+            group: z.ZodNullable<z.ZodString>;
+            major: z.ZodNumber;
+            minor: z.ZodExactOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    units: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        path: z.ZodString;
+        plugin: z.ZodString;
+        scheme: z.ZodString;
+        tags: z.ZodArray<z.ZodString>;
+        group: z.ZodNullable<z.ZodString>;
+        affected: z.ZodNullable<z.ZodObject<{
+            reason: z.ZodEnum<{
+                direct: "direct";
+                dependent: "dependent";
+                global: "global";
+                all: "all";
+                group: "group";
+            }>;
+            via: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+        kind: z.ZodEnum<{
+            none: "none";
+            rebuild: "rebuild";
+            prerelease: "prerelease";
+        }>;
+        baseTag: z.ZodNullable<z.ZodString>;
+        lineBaseTag: z.ZodNullable<z.ZodString>;
+        from: z.ZodNullable<z.ZodString>;
+        bump: z.ZodNullable<z.ZodEnum<{
+            patch: "patch";
+            major: "major";
+            minor: "minor";
+        }>>;
+        releaseAs: z.ZodNullable<z.ZodString>;
+        propagatedFrom: z.ZodArray<z.ZodString>;
+        absorbedFrom: z.ZodArray<z.ZodString>;
+        next: z.ZodNullable<z.ZodString>;
+        version: z.ZodNullable<z.ZodString>;
+        sha: z.ZodString;
+        changes: z.ZodArray<z.ZodObject<{
+            sha: z.ZodExactOptional<z.ZodString>;
+            type: z.ZodString;
+            breaking: z.ZodBoolean;
+            scope: z.ZodExactOptional<z.ZodString>;
+            subject: z.ZodString;
+            pr: z.ZodExactOptional<z.ZodNumber>;
+            via: z.ZodExactOptional<z.ZodString>;
+            releaseAs: z.ZodExactOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    groups: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        members: z.ZodArray<z.ZodString>;
+        baseTag: z.ZodNullable<z.ZodString>;
+        from: z.ZodNullable<z.ZodString>;
+        bump: z.ZodNullable<z.ZodEnum<{
+            patch: "patch";
+            major: "major";
+            minor: "minor";
+        }>>;
+        next: z.ZodNullable<z.ZodString>;
+        version: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    released: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        path: z.ZodString;
+        version: z.ZodString;
+        tag: z.ZodString;
+        floatingTags: z.ZodArray<z.ZodString>;
+        releaseSha: z.ZodString;
+        catchUp: z.ZodBoolean;
+        pr: z.ZodNullable<z.ZodNumber>;
+        line: z.ZodEnum<{
+            default: "default";
+            maintenance: "maintenance";
+        }>;
+    }, z.core.$strict>>;
+    schema: z.ZodLiteral<1>;
+    tool: z.ZodString;
+    repo: z.ZodString;
+    branch: z.ZodString;
+    head: z.ZodString;
+    build: z.ZodObject<{
+        base: z.ZodNullable<z.ZodString>;
+        baseSource: z.ZodEnum<{
+            cli: "cli";
+            "push-before": "push-before";
+            "pr-merge-base": "pr-merge-base";
+            "merge-group": "merge-group";
+            "forge-last-success": "forge-last-success";
+            "local-merge-base": "local-merge-base";
+            none: "none";
+        }>;
+        all: z.ZodBoolean;
+        globalInputs: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>;
+    unattributed: z.ZodArray<z.ZodString>;
+    warnings: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+        plugin: z.ZodExactOptional<z.ZodString>;
+        unit: z.ZodExactOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const planSchemaExact: Equals<z.infer<typeof planSchema>, Plan>;
+export {};

package/dist/plan-schema.js

@@ -0,0 +1,81 @@
+import { z } from "zod";
+import { affectedDocSchema } from "./affected-schema.js";
+/* eslint-enable @typescript-eslint/no-unnecessary-type-parameters */
+const bump = z.enum(["major", "minor", "patch"]);
+/** Schema of `tallyrelease plan --json`, published as `plan.schema.json`. */
+export const planSchema = z.strictObject({
+    ...affectedDocSchema.omit({ units: true }).shape,
+    line: z
+        .strictObject({
+        rule: z.string(),
+        kind: z.enum(["default", "maintenance"]),
+        channel: z.string().nullable(),
+        maxBump: z.enum(["minor", "patch"]).nullable(),
+        absolute: z
+            .strictObject({
+            unit: z.string().nullable(),
+            group: z.string().nullable(),
+            major: z.number(),
+            minor: z.number().exactOptional(),
+        })
+            .nullable(),
+    })
+        .nullable(),
+    units: z.array(z.strictObject({
+        id: z.string(),
+        path: z.string(),
+        plugin: z.string(),
+        scheme: z.string(),
+        tags: z.array(z.string()),
+        group: z.string().nullable(),
+        affected: z
+            .strictObject({
+            reason: affectedDocSchema.shape.units.element.shape.reason,
+            via: z.array(z.string()),
+        })
+            .nullable(),
+        kind: z.enum(["prerelease", "rebuild", "none"]),
+        baseTag: z.string().nullable(),
+        lineBaseTag: z.string().nullable(),
+        from: z.string().nullable(),
+        bump: bump.nullable(),
+        releaseAs: z.string().nullable(),
+        propagatedFrom: z.array(z.string()),
+        absorbedFrom: z.array(z.string()),
+        next: z.string().nullable(),
+        version: z.string().nullable(),
+        sha: z.string(),
+        changes: z.array(z.strictObject({
+            sha: z.string().exactOptional(),
+            type: z.string(),
+            breaking: z.boolean(),
+            scope: z.string().exactOptional(),
+            subject: z.string(),
+            pr: z.number().exactOptional(),
+            via: z.string().exactOptional(),
+            releaseAs: z.string().exactOptional(),
+        })),
+    })),
+    groups: z.array(z.strictObject({
+        name: z.string(),
+        members: z.array(z.string()),
+        baseTag: z.string().nullable(),
+        from: z.string().nullable(),
+        bump: bump.nullable(),
+        next: z.string().nullable(),
+        version: z.string().nullable(),
+    })),
+    released: z.array(z.strictObject({
+        id: z.string(),
+        path: z.string(),
+        version: z.string(),
+        tag: z.string(),
+        floatingTags: z.array(z.string()),
+        releaseSha: z.string(),
+        catchUp: z.boolean(),
+        pr: z.number().nullable(),
+        line: z.enum(["default", "maintenance"]),
+    })),
+});
+// Fails to compile when the schema misses or adds a field of `Plan`.
+export const planSchemaExact = true;

package/dist/plan.schema.json

@@ -0,0 +1,515 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"type": "object",
+	"properties": {
+		"schema": {
+			"type": "number",
+			"const": 1
+		},
+		"tool": {
+			"type": "string"
+		},
+		"repo": {
+			"type": "string"
+		},
+		"branch": {
+			"type": "string"
+		},
+		"head": {
+			"type": "string"
+		},
+		"build": {
+			"type": "object",
+			"properties": {
+				"base": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"baseSource": {
+					"type": "string",
+					"enum": [
+						"cli",
+						"push-before",
+						"pr-merge-base",
+						"merge-group",
+						"forge-last-success",
+						"local-merge-base",
+						"none"
+					]
+				},
+				"all": {
+					"type": "boolean"
+				},
+				"globalInputs": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			},
+			"required": [
+				"base",
+				"baseSource",
+				"all",
+				"globalInputs"
+			],
+			"additionalProperties": false
+		},
+		"unattributed": {
+			"type": "array",
+			"items": {
+				"type": "string"
+			}
+		},
+		"warnings": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"code": {
+						"type": "string"
+					},
+					"message": {
+						"type": "string"
+					},
+					"plugin": {
+						"type": "string"
+					},
+					"unit": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"code",
+					"message"
+				],
+				"additionalProperties": false
+			}
+		},
+		"line": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"rule": {
+							"type": "string"
+						},
+						"kind": {
+							"type": "string",
+							"enum": [
+								"default",
+								"maintenance"
+							]
+						},
+						"channel": {
+							"type": [
+								"string",
+								"null"
+							]
+						},
+						"maxBump": {
+							"anyOf": [
+								{
+									"type": "string",
+									"enum": [
+										"minor",
+										"patch"
+									]
+								},
+								{
+									"type": "null"
+								}
+							]
+						},
+						"absolute": {
+							"anyOf": [
+								{
+									"type": "object",
+									"properties": {
+										"unit": {
+											"type": [
+												"string",
+												"null"
+											]
+										},
+										"group": {
+											"type": [
+												"string",
+												"null"
+											]
+										},
+										"major": {
+											"type": "number"
+										},
+										"minor": {
+											"type": "number"
+										}
+									},
+									"required": [
+										"unit",
+										"group",
+										"major"
+									],
+									"additionalProperties": false
+								},
+								{
+									"type": "null"
+								}
+							]
+						}
+					},
+					"required": [
+						"rule",
+						"kind",
+						"channel",
+						"maxBump",
+						"absolute"
+					],
+					"additionalProperties": false
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"units": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"path": {
+						"type": "string"
+					},
+					"plugin": {
+						"type": "string"
+					},
+					"scheme": {
+						"type": "string"
+					},
+					"tags": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					},
+					"group": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"affected": {
+						"anyOf": [
+							{
+								"type": "object",
+								"properties": {
+									"reason": {
+										"type": "string",
+										"enum": [
+											"direct",
+											"dependent",
+											"global",
+											"all",
+											"group"
+										]
+									},
+									"via": {
+										"type": "array",
+										"items": {
+											"type": "string"
+										}
+									}
+								},
+								"required": [
+									"reason",
+									"via"
+								],
+								"additionalProperties": false
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"kind": {
+						"type": "string",
+						"enum": [
+							"prerelease",
+							"rebuild",
+							"none"
+						]
+					},
+					"baseTag": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"lineBaseTag": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"from": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"bump": {
+						"anyOf": [
+							{
+								"type": "string",
+								"enum": [
+									"major",
+									"minor",
+									"patch"
+								]
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"releaseAs": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"propagatedFrom": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					},
+					"absorbedFrom": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					},
+					"next": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"version": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"sha": {
+						"type": "string"
+					},
+					"changes": {
+						"type": "array",
+						"items": {
+							"type": "object",
+							"properties": {
+								"sha": {
+									"type": "string"
+								},
+								"type": {
+									"type": "string"
+								},
+								"breaking": {
+									"type": "boolean"
+								},
+								"scope": {
+									"type": "string"
+								},
+								"subject": {
+									"type": "string"
+								},
+								"pr": {
+									"type": "number"
+								},
+								"via": {
+									"type": "string"
+								},
+								"releaseAs": {
+									"type": "string"
+								}
+							},
+							"required": [
+								"type",
+								"breaking",
+								"subject"
+							],
+							"additionalProperties": false
+						}
+					}
+				},
+				"required": [
+					"id",
+					"path",
+					"plugin",
+					"scheme",
+					"tags",
+					"group",
+					"affected",
+					"kind",
+					"baseTag",
+					"lineBaseTag",
+					"from",
+					"bump",
+					"releaseAs",
+					"propagatedFrom",
+					"absorbedFrom",
+					"next",
+					"version",
+					"sha",
+					"changes"
+				],
+				"additionalProperties": false
+			}
+		},
+		"groups": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"members": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					},
+					"baseTag": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"from": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"bump": {
+						"anyOf": [
+							{
+								"type": "string",
+								"enum": [
+									"major",
+									"minor",
+									"patch"
+								]
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"next": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"version": {
+						"type": [
+							"string",
+							"null"
+						]
+					}
+				},
+				"required": [
+					"name",
+					"members",
+					"baseTag",
+					"from",
+					"bump",
+					"next",
+					"version"
+				],
+				"additionalProperties": false
+			}
+		},
+		"released": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"path": {
+						"type": "string"
+					},
+					"version": {
+						"type": "string"
+					},
+					"tag": {
+						"type": "string"
+					},
+					"floatingTags": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					},
+					"releaseSha": {
+						"type": "string"
+					},
+					"catchUp": {
+						"type": "boolean"
+					},
+					"pr": {
+						"type": [
+							"number",
+							"null"
+						]
+					},
+					"line": {
+						"type": "string",
+						"enum": [
+							"default",
+							"maintenance"
+						]
+					}
+				},
+				"required": [
+					"id",
+					"path",
+					"version",
+					"tag",
+					"floatingTags",
+					"releaseSha",
+					"catchUp",
+					"pr",
+					"line"
+				],
+				"additionalProperties": false
+			}
+		}
+	},
+	"required": [
+		"schema",
+		"tool",
+		"repo",
+		"branch",
+		"head",
+		"build",
+		"unattributed",
+		"warnings",
+		"line",
+		"units",
+		"groups",
+		"released"
+	],
+	"additionalProperties": false
+}