@csszyx/runtime 0.10.0 → 0.10.2

package/dist/index.d.cts

@@ -695,6 +695,73 @@ declare function pick(classes: string, selector: BoxSelector): string;
  * @returns The non-matching tokens joined by spaces.
  */
 declare function omit(classes: string, selector: BoxSelector): string;
+/** Options controlling how `splitBoxSz` partitions an sz object. */
+interface SplitBoxSzOptions {
+    /** Force these selectors onto the outer object, overriding the default map. */
+    outer?: BoxSelector[];
+    /** Force these selectors onto the inner object, overriding the default map. */
+    inner?: BoxSelector[];
+    /** Where an unrecognized key goes. Defaults to `'outer'`. */
+    fallback?: BoxRole;
+}
+/** The two sz-object buckets produced by `splitBoxSz`. */
+interface SplitBoxSzResult {
+    /** sz for the outer (border-outward) element. */
+    outer: SzObject;
+    /** sz for the inner (border-inward) element. */
+    inner: SzObject;
+}
+/**
+ * Classify an sz prop key by box-model role + semantic category, or `undefined`
+ * if it is not a csszyx-owned key. The sz-object analog of `classify` (which
+ * takes an emitted class token) — both read the same generated map, so
+ * `classifySzKey('m')` and `classify('m-4')` agree.
+ *
+ * @param key - An sz prop key (e.g. `'m'`, `'px'`, `'grow'`).
+ * @returns The key's role and category, or `undefined` if unowned.
+ */
+declare function classifySzKey(key: string): Classification | undefined;
+/**
+ * Partition an sz object (or any `SzInput`) into `{ outer, inner }` at the CSS
+ * box-model border line — the sz-object analog of `splitBox`. Each key routes to
+ * the same side its emitted class would (`splitBoxSz(x)` buckets keys to the
+ * roles `splitBox(compile(x))` gives the emitted classes). Arrays are flattened,
+ * `null`/`false` collapse to empty objects, and `options.inner`/`outer`/
+ * `fallback` behave like `SplitBoxOptions` (`inner` wins when a key matches both).
+ *
+ * @param sz - The sz object / input to partition.
+ * @param options - Overrides for forcing keys onto a node and the fallback role.
+ * @returns The `{ outer, inner }` sz-object buckets.
+ * @example splitBoxSz({ m: 4, px: 2 }) // → { outer: { m: 4 }, inner: { px: 2 } }
+ */
+declare function splitBoxSz(sz: SzInput, options?: SplitBoxSzOptions): SplitBoxSzResult;
+/**
+ * Does any key in `sz` match `selector` (after flattening, recursing into
+ * variants)? The sz-object analog of `has`.
+ *
+ * @param sz - The sz input to scan.
+ * @param selector - The selector to test keys against.
+ * @returns `true` if any key matches.
+ */
+declare function hasSz(sz: SzInput, selector: BoxSelector): boolean;
+/**
+ * Keep only the keys in `sz` that match `selector` (recursing into variants).
+ * The sz-object analog of `pick`.
+ *
+ * @param sz - The sz input to filter.
+ * @param selector - The selector keys must match to be kept.
+ * @returns A new sz object with the matching keys.
+ */
+declare function pickSz(sz: SzInput, selector: BoxSelector): SzObject;
+/**
+ * Drop the keys in `sz` that match `selector`, keeping the rest (recursing into
+ * variants). The sz-object analog of `omit`.
+ *
+ * @param sz - The sz input to filter.
+ * @param selector - The selector keys must match to be dropped.
+ * @returns A new sz object with the non-matching keys.
+ */
+declare function omitSz(sz: SzInput, selector: BoxSelector): SzObject;
 
 /**
  * Drop the `sz` prop before a component spreads `...rest` onto a host element.
@@ -880,5 +947,5 @@ declare function isRuntimeInitialized(): boolean;
  */
 declare function resetRuntime(): void;
 
-export { DEFAULT_RUNTIME_CONFIG, VERSION, _sz, _sz2, _sz3, _szMerge, abortHydration, attemptCSRRecovery, classify, clearHydrationErrors, computeMangleChecksumAsync, disableCSRRecovery, enableCSRRecovery, endHydration, getAbortedSubtreeCount, getHydrationErrors, getRecoveryMode, getRuntimeConfig, getSSRContext, guardHydration, has, hasRecoveryToken, initRuntime, isCSRRecoveryAllowed, isHydrating, isHydrationAborted, isRuntimeInitialized, isSSREnvironment, isValidMangleMap, isValidManifest, loadMangleMapFromDOM, loadManifestFromDOM, omit, pick, resetRuntime, splitBox, startHydration, stripSzProps, szv, validateHydrationClass, verifyAllTokens, verifyMangleChecksum, verifyMangleChecksumAsync, verifyMangleMapIntegrity, verifyRecoveryToken };
-export type { BoxRole, BoxSelector, Classification, HydrationError, HydrationErrorType, MangleMap, RecoveryManifest, RecoveryMode, RuntimeConfig, SSRContext, SplitBoxOptions, SplitBoxResult, SzInput, TokenData, VerificationResult };
+export { DEFAULT_RUNTIME_CONFIG, VERSION, _sz, _sz2, _sz3, _szMerge, abortHydration, attemptCSRRecovery, classify, classifySzKey, clearHydrationErrors, computeMangleChecksumAsync, disableCSRRecovery, enableCSRRecovery, endHydration, getAbortedSubtreeCount, getHydrationErrors, getRecoveryMode, getRuntimeConfig, getSSRContext, guardHydration, has, hasRecoveryToken, hasSz, initRuntime, isCSRRecoveryAllowed, isHydrating, isHydrationAborted, isRuntimeInitialized, isSSREnvironment, isValidMangleMap, isValidManifest, loadMangleMapFromDOM, loadManifestFromDOM, omit, omitSz, pick, pickSz, resetRuntime, splitBox, splitBoxSz, startHydration, stripSzProps, szv, validateHydrationClass, verifyAllTokens, verifyMangleChecksum, verifyMangleChecksumAsync, verifyMangleMapIntegrity, verifyRecoveryToken };
+export type { BoxRole, BoxSelector, Classification, HydrationError, HydrationErrorType, MangleMap, RecoveryManifest, RecoveryMode, RuntimeConfig, SSRContext, SplitBoxOptions, SplitBoxResult, SplitBoxSzOptions, SplitBoxSzResult, SzInput, TokenData, VerificationResult };

package/dist/index.d.mts

@@ -695,6 +695,73 @@ declare function pick(classes: string, selector: BoxSelector): string;
  * @returns The non-matching tokens joined by spaces.
  */
 declare function omit(classes: string, selector: BoxSelector): string;
+/** Options controlling how `splitBoxSz` partitions an sz object. */
+interface SplitBoxSzOptions {
+    /** Force these selectors onto the outer object, overriding the default map. */
+    outer?: BoxSelector[];
+    /** Force these selectors onto the inner object, overriding the default map. */
+    inner?: BoxSelector[];
+    /** Where an unrecognized key goes. Defaults to `'outer'`. */
+    fallback?: BoxRole;
+}
+/** The two sz-object buckets produced by `splitBoxSz`. */
+interface SplitBoxSzResult {
+    /** sz for the outer (border-outward) element. */
+    outer: SzObject;
+    /** sz for the inner (border-inward) element. */
+    inner: SzObject;
+}
+/**
+ * Classify an sz prop key by box-model role + semantic category, or `undefined`
+ * if it is not a csszyx-owned key. The sz-object analog of `classify` (which
+ * takes an emitted class token) — both read the same generated map, so
+ * `classifySzKey('m')` and `classify('m-4')` agree.
+ *
+ * @param key - An sz prop key (e.g. `'m'`, `'px'`, `'grow'`).
+ * @returns The key's role and category, or `undefined` if unowned.
+ */
+declare function classifySzKey(key: string): Classification | undefined;
+/**
+ * Partition an sz object (or any `SzInput`) into `{ outer, inner }` at the CSS
+ * box-model border line — the sz-object analog of `splitBox`. Each key routes to
+ * the same side its emitted class would (`splitBoxSz(x)` buckets keys to the
+ * roles `splitBox(compile(x))` gives the emitted classes). Arrays are flattened,
+ * `null`/`false` collapse to empty objects, and `options.inner`/`outer`/
+ * `fallback` behave like `SplitBoxOptions` (`inner` wins when a key matches both).
+ *
+ * @param sz - The sz object / input to partition.
+ * @param options - Overrides for forcing keys onto a node and the fallback role.
+ * @returns The `{ outer, inner }` sz-object buckets.
+ * @example splitBoxSz({ m: 4, px: 2 }) // → { outer: { m: 4 }, inner: { px: 2 } }
+ */
+declare function splitBoxSz(sz: SzInput, options?: SplitBoxSzOptions): SplitBoxSzResult;
+/**
+ * Does any key in `sz` match `selector` (after flattening, recursing into
+ * variants)? The sz-object analog of `has`.
+ *
+ * @param sz - The sz input to scan.
+ * @param selector - The selector to test keys against.
+ * @returns `true` if any key matches.
+ */
+declare function hasSz(sz: SzInput, selector: BoxSelector): boolean;
+/**
+ * Keep only the keys in `sz` that match `selector` (recursing into variants).
+ * The sz-object analog of `pick`.
+ *
+ * @param sz - The sz input to filter.
+ * @param selector - The selector keys must match to be kept.
+ * @returns A new sz object with the matching keys.
+ */
+declare function pickSz(sz: SzInput, selector: BoxSelector): SzObject;
+/**
+ * Drop the keys in `sz` that match `selector`, keeping the rest (recursing into
+ * variants). The sz-object analog of `omit`.
+ *
+ * @param sz - The sz input to filter.
+ * @param selector - The selector keys must match to be dropped.
+ * @returns A new sz object with the non-matching keys.
+ */
+declare function omitSz(sz: SzInput, selector: BoxSelector): SzObject;
 
 /**
  * Drop the `sz` prop before a component spreads `...rest` onto a host element.
@@ -880,5 +947,5 @@ declare function isRuntimeInitialized(): boolean;
  */
 declare function resetRuntime(): void;
 
-export { DEFAULT_RUNTIME_CONFIG, VERSION, _sz, _sz2, _sz3, _szMerge, abortHydration, attemptCSRRecovery, classify, clearHydrationErrors, computeMangleChecksumAsync, disableCSRRecovery, enableCSRRecovery, endHydration, getAbortedSubtreeCount, getHydrationErrors, getRecoveryMode, getRuntimeConfig, getSSRContext, guardHydration, has, hasRecoveryToken, initRuntime, isCSRRecoveryAllowed, isHydrating, isHydrationAborted, isRuntimeInitialized, isSSREnvironment, isValidMangleMap, isValidManifest, loadMangleMapFromDOM, loadManifestFromDOM, omit, pick, resetRuntime, splitBox, startHydration, stripSzProps, szv, validateHydrationClass, verifyAllTokens, verifyMangleChecksum, verifyMangleChecksumAsync, verifyMangleMapIntegrity, verifyRecoveryToken };
-export type { BoxRole, BoxSelector, Classification, HydrationError, HydrationErrorType, MangleMap, RecoveryManifest, RecoveryMode, RuntimeConfig, SSRContext, SplitBoxOptions, SplitBoxResult, SzInput, TokenData, VerificationResult };
+export { DEFAULT_RUNTIME_CONFIG, VERSION, _sz, _sz2, _sz3, _szMerge, abortHydration, attemptCSRRecovery, classify, classifySzKey, clearHydrationErrors, computeMangleChecksumAsync, disableCSRRecovery, enableCSRRecovery, endHydration, getAbortedSubtreeCount, getHydrationErrors, getRecoveryMode, getRuntimeConfig, getSSRContext, guardHydration, has, hasRecoveryToken, hasSz, initRuntime, isCSRRecoveryAllowed, isHydrating, isHydrationAborted, isRuntimeInitialized, isSSREnvironment, isValidMangleMap, isValidManifest, loadMangleMapFromDOM, loadManifestFromDOM, omit, omitSz, pick, pickSz, resetRuntime, splitBox, splitBoxSz, startHydration, stripSzProps, szv, validateHydrationClass, verifyAllTokens, verifyMangleChecksum, verifyMangleChecksumAsync, verifyMangleMapIntegrity, verifyRecoveryToken };
+export type { BoxRole, BoxSelector, Classification, HydrationError, HydrationErrorType, MangleMap, RecoveryManifest, RecoveryMode, RuntimeConfig, SSRContext, SplitBoxOptions, SplitBoxResult, SplitBoxSzOptions, SplitBoxSzResult, SzInput, TokenData, VerificationResult };