@compact-design/core 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { type RepairIssue } from "./lint";
 import { isPatchDocument } from "./normalize";
-import { type PatchResult } from "./patch";
+import { PatchError, type PatchResult } from "./patch";
 import { schema } from "./schema";
 import type { InternalDocument, InternalPatchDocument } from "./types";
 export interface ValidationResult {
@@ -12,11 +12,41 @@ export interface ValidationResult {
 export declare function parse(source: string): unknown;
 export declare function normalize(value: unknown): InternalDocument;
 export declare function normalizePatch(value: unknown): InternalPatchDocument;
+/**
+ * Validate a full document or a patch document. Patch documents are checked
+ * against the schema ($defs.patchSet rejects unknown keys) and by core's
+ * patch normalizer (deferred keys, conflicting keys). Rules that depend on the
+ * target node run in validatePatch / applyPatch.
+ */
 export declare function validate(value: unknown): ValidationResult;
+export interface PatchValidationResult {
+    valid: boolean;
+    issues: RepairIssue[];
+    patch?: InternalPatchDocument;
+    document?: InternalDocument;
+    affectedIds?: string[];
+    warnings?: string[];
+}
+/**
+ * Validate a raw patch against the document it will be applied to: schema,
+ * key rules, target-type rules, and validateDocument on the patched result
+ * (bindings, styleRefs, variants, sizes, ...). Only issues the patch
+ * introduces are reported; issues already in the input document never block.
+ * Returns the patched document when valid. Never throws.
+ */
+export declare function validatePatch(document: InternalDocument, patch: unknown): PatchValidationResult;
 export declare function lint(value: InternalDocument): RepairIssue[];
+/** Apply a normalized patch. Throws PatchError when an operation or the patched document is invalid. */
 export declare function applyPatch(document: InternalDocument, patch: InternalPatchDocument): PatchResult;
-export { isPatchDocument, schema };
+export { isPatchDocument, schema, PatchError };
+export { normalizePatchSet } from "./normalize";
+export { corePatchContext, newDocumentIssues } from "./patch";
+export { PATCH_SET_KEYS, PATCH_SET_EXCLUDED_NODE_KEYS, PATCH_SET_SEMANTICS, PATCH_SET_APPLIES_TO, PATCH_SET_DEFERRED_KEYS, PATCH_TEXT_STYLE_KEYS, isPatchSetKey, patchSetShapeIssues, patchSetTargetIssues, patchSetBindingFields } from "./patch-keys";
+export type { PatchSetKey, PatchSetSemantics, PatchTargetContext } from "./patch-keys";
 export { indexDocument } from "./references";
+export { detectVariantRenames, variantAxesUncarriedOptions, type AxisRename, type OptionRename, type VariantAxisPatchEntry, type VariantAxesPatch } from "./patch-definitions";
+export { buildDuplicateIdMap, buildDuplicateIdMapFromIds, collectSubtreeIds, cloneSubtreeWithIds, remapIssueKeyThroughDuplicate, remapDelimitedIds, subtreeContainsType } from "./patch-duplicate";
+export { assertPrototypeSetDestinations, assertPrototypePatchRules, prototypeDestinationErrors, prototypePatchStrictErrors, forEachPrototypeDestination, isAfterTimeoutReaction, isTopLevelNodeId } from "./patch-prototype";
 export type { DocumentIndex } from "./references";
 export type { PatchResult, RepairIssue };
 export type * from "./types";