@vizejs/composable 0.345.0 → 0.347.7

package/dist/catalog-CuWhR-0q.d.mts

@@ -0,0 +1,506 @@
+import { i as CapabilityTarget } from "./capability-BNpkvSy5.mjs";
+
+//#region src/catalog-schema.d.ts
+/** Release maturity attached to every catalogued composable. */
+type ComposableStability = "experimental" | "stable" | "deprecated";
+/** Functional area used to group composables in documentation and tooling. */
+type ComposableCategory = "async" | "capability" | "events" | "i18n" | "lifecycle" | "media" | "networking" | "performance" | "state" | "storage" | "system" | "timing";
+/** Server-rendering behavior of a composable when invoked without a browser. */
+type ComposableSsrBehavior = "safe" | "deterministic-fallback" | "unsupported";
+/** Hydration responsibility associated with a composable's initial value. */
+type ComposableHydrationBehavior = "stable" | "caller-managed" | "not-applicable";
+/** Party that can release resources retained by a composable. */
+type ComposableCleanupOwner = "none" | "caller" | "reactive-scope" | "returned-value";
+/** Availability of one supported installation route. */
+type ComposableInstallationAvailability = {
+  /** The installation route can be used in the current release. */readonly status: "available"; /** User-facing package or command specifier for the route. */
+  readonly specifier: string;
+} | {
+  /** The installation route has not been implemented yet. */readonly status: "unavailable"; /** Stable explanation suitable for generated documentation. */
+  readonly reason: string;
+};
+/** Metadata for the aggregate package entry. */
+interface ComposableRootEntryMetadata {
+  /** Export-map key for the aggregate entry. */
+  readonly subpath: ".";
+  /** Repository-relative source module used to build the entry. */
+  readonly source: "src/index.ts";
+  /** How the aggregate compressed-size budget is calculated. */
+  readonly gzipBudget: "sum-of-reexported-entry-budgets";
+  /** Feature entries re-exported by the aggregate entry. */
+  readonly reexportedEntries: readonly `./${string}`[];
+  /** Entries kept subpath-only to isolate comparatively heavy dependencies. */
+  readonly isolatedEntries: readonly `./${string}`[];
+}
+/** Metadata for one independently importable package subpath. */
+interface ComposableEntryMetadata {
+  /** Export-map key, including the leading `./`. */
+  readonly subpath: `./${string}`;
+  /** Repository-relative source module used to build the entry. */
+  readonly source: `src/${string}.ts`;
+  /** Maximum gzip bytes for the entry's complete emitted module closure. */
+  readonly gzipBudgetBytes: number;
+  /** Exact JavaScript exports emitted by this entry. */
+  readonly runtimeExports: readonly string[];
+  /** Runtime utility names implemented by this entry. */
+  readonly utilities: readonly string[];
+}
+/** Operational metadata for one public runtime utility. */
+interface ComposableUtilityMetadata {
+  /** Exact public export name. */
+  readonly name: string;
+  /** Package subpath that owns the utility's implementation. */
+  readonly entry: `./${string}`;
+  /** Functional documentation group. */
+  readonly category: ComposableCategory;
+  /** Release maturity of the current contract. */
+  readonly stability: ComposableStability;
+  /** Runtime families in which the utility is designed to operate. */
+  readonly targets: readonly CapabilityTarget[];
+  /** Behavior when called during server rendering. */
+  readonly ssr: ComposableSsrBehavior;
+  /** Initial-value responsibility at the hydration boundary. */
+  readonly hydration: ComposableHydrationBehavior;
+  /** Parties capable of releasing resources created by the utility. */
+  readonly cleanupOwners: readonly ComposableCleanupOwner[];
+  /** Host capability globals read at call time, excluding language intrinsics. */
+  readonly runtimeGlobals: readonly string[];
+  /** Other catalogued utilities called by this implementation. */
+  readonly dependencies: readonly string[];
+}
+/** Machine-readable public contract for the composable package. */
+interface ComposableCatalog {
+  /** Schema version for catalog consumers. */
+  readonly schemaVersion: 1;
+  /** Compatibility promise for the schema rather than individual utilities. */
+  readonly catalogStability: "stable";
+  /** Published package name. */
+  readonly packageName: "@vizejs/composable";
+  /** Canonical ordering of supported runtime families. */
+  readonly targets: readonly CapabilityTarget[];
+  /** Availability of package-manager installation. */
+  readonly packageInstallation: ComposableInstallationAvailability;
+  /** Availability of source-copy installation. */
+  readonly sourceInstallation: ComposableInstallationAvailability;
+  /** Aggregate package entry and its budget policy. */
+  readonly rootEntry: ComposableRootEntryMetadata;
+  /** Independently importable entries in export-map order. */
+  readonly entries: readonly ComposableEntryMetadata[];
+  /** Public runtime utilities in entry and source order. */
+  readonly utilities: readonly ComposableUtilityMetadata[];
+}
+//#endregion
+//#region src/catalog.d.ts
+/**
+ * Complete, serializable catalog of the package's public runtime surface.
+ *
+ * This value is the source of truth for export-map conformance and compressed
+ * size gates. It intentionally contains data only: importing the module reads
+ * no host globals, creates no subscriptions, and starts no work. Utilities
+ * remain marked experimental while the package is pre-1.0. Source-copy
+ * installation is reported as unavailable until a deterministic installer
+ * with update provenance exists.
+ */
+declare const COMPOSABLE_CATALOG: {
+  readonly schemaVersion: 1;
+  readonly catalogStability: "stable";
+  readonly packageName: "@vizejs/composable";
+  readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+  readonly packageInstallation: {
+    readonly status: "available";
+    readonly specifier: "@vizejs/composable";
+  };
+  readonly sourceInstallation: {
+    readonly status: "unavailable";
+    readonly reason: "A provenance-preserving source-copy installer is not implemented.";
+  };
+  readonly rootEntry: {
+    readonly subpath: ".";
+    readonly source: "src/index.ts";
+    readonly gzipBudget: "sum-of-reexported-entry-budgets";
+    readonly reexportedEntries: readonly ["./abort-signal", "./async-resource", "./capability", "./catalog", "./disposal-scope", "./event-listener", "./locale", "./media-query", "./retry-async", "./retry-delay", "./scope", "./timeout-scheduler", "./use-counter", "./use-debounced", "./use-history", "./use-previous", "./use-throttled", "./use-toggle"];
+    readonly isolatedEntries: readonly ["./temporal"];
+  };
+  readonly entries: readonly [{
+    readonly subpath: "./abort-signal";
+    readonly source: "src/abort-signal.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["anyAbortSignal", "timeoutAbortSignal", "deadlineAbortSignal"];
+    readonly utilities: readonly ["anyAbortSignal", "timeoutAbortSignal", "deadlineAbortSignal"];
+  }, {
+    readonly subpath: "./async-resource";
+    readonly source: "src/async-resource.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useAsyncResource"];
+    readonly utilities: readonly ["useAsyncResource"];
+  }, {
+    readonly subpath: "./capability";
+    readonly source: "src/capability.ts";
+    readonly gzipBudgetBytes: 1024;
+    readonly runtimeExports: readonly ["availableCapability", "unavailableCapability", "isCapabilityAvailable", "isCapabilityUnavailable"];
+    readonly utilities: readonly ["availableCapability", "unavailableCapability", "isCapabilityAvailable", "isCapabilityUnavailable"];
+  }, {
+    readonly subpath: "./catalog";
+    readonly source: "src/catalog.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["COMPOSABLE_CATALOG"];
+    readonly utilities: readonly [];
+  }, {
+    readonly subpath: "./disposal-scope";
+    readonly source: "src/disposal-scope.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["DISPOSAL_ERROR_CODE", "DisposalError", "createDisposalScope"];
+    readonly utilities: readonly ["createDisposalScope"];
+  }, {
+    readonly subpath: "./event-listener";
+    readonly source: "src/event-listener.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useEventListener"];
+    readonly utilities: readonly ["useEventListener"];
+  }, {
+    readonly subpath: "./locale";
+    readonly source: "src/locale.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useLocale"];
+    readonly utilities: readonly ["useLocale"];
+  }, {
+    readonly subpath: "./media-query";
+    readonly source: "src/media-query.ts";
+    readonly gzipBudgetBytes: 1024;
+    readonly runtimeExports: readonly ["useMediaQuery", "useReducedMotion"];
+    readonly utilities: readonly ["useMediaQuery", "useReducedMotion"];
+  }, {
+    readonly subpath: "./retry-async";
+    readonly source: "src/retry-async.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["retryAsync"];
+    readonly utilities: readonly ["retryAsync"];
+  }, {
+    readonly subpath: "./retry-delay";
+    readonly source: "src/retry-delay.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["calculateRetryDelay"];
+    readonly utilities: readonly ["calculateRetryDelay"];
+  }, {
+    readonly subpath: "./scope";
+    readonly source: "src/scope.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["tryOnScopeDispose"];
+    readonly utilities: readonly ["tryOnScopeDispose"];
+  }, {
+    readonly subpath: "./temporal";
+    readonly source: "src/temporal.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["Temporal", "TemporalIntl", "useTemporalNow", "useTemporalZonedDateTime"];
+    readonly utilities: readonly ["useTemporalNow", "useTemporalZonedDateTime"];
+  }, {
+    readonly subpath: "./timeout-scheduler";
+    readonly source: "src/timeout-scheduler.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly [];
+    readonly utilities: readonly [];
+  }, {
+    readonly subpath: "./use-counter";
+    readonly source: "src/use-counter.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useCounter"];
+    readonly utilities: readonly ["useCounter"];
+  }, {
+    readonly subpath: "./use-debounced";
+    readonly source: "src/use-debounced.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useDebounced"];
+    readonly utilities: readonly ["useDebounced"];
+  }, {
+    readonly subpath: "./use-history";
+    readonly source: "src/use-history.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useHistory"];
+    readonly utilities: readonly ["useHistory"];
+  }, {
+    readonly subpath: "./use-previous";
+    readonly source: "src/use-previous.ts";
+    readonly gzipBudgetBytes: 1024;
+    readonly runtimeExports: readonly ["usePrevious"];
+    readonly utilities: readonly ["usePrevious"];
+  }, {
+    readonly subpath: "./use-throttled";
+    readonly source: "src/use-throttled.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useThrottled"];
+    readonly utilities: readonly ["useThrottled"];
+  }, {
+    readonly subpath: "./use-toggle";
+    readonly source: "src/use-toggle.ts";
+    readonly gzipBudgetBytes: number;
+    readonly runtimeExports: readonly ["useToggle"];
+    readonly utilities: readonly ["useToggle"];
+  }];
+  readonly utilities: readonly [{
+    readonly name: "anyAbortSignal";
+    readonly entry: "./abort-signal";
+    readonly category: "async";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["returned-value"];
+    readonly runtimeGlobals: readonly ["AbortController", "AbortSignal"];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "timeoutAbortSignal";
+    readonly entry: "./abort-signal";
+    readonly category: "timing";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["returned-value"];
+    readonly runtimeGlobals: readonly ["AbortController", "AbortSignal", "DOMException", "globalThis"];
+    readonly dependencies: readonly ["anyAbortSignal"];
+  }, {
+    readonly name: "deadlineAbortSignal";
+    readonly entry: "./abort-signal";
+    readonly category: "timing";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["returned-value"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly ["timeoutAbortSignal"];
+  }, {
+    readonly name: "useAsyncResource";
+    readonly entry: "./async-resource";
+    readonly category: "async";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["caller", "reactive-scope"];
+    readonly runtimeGlobals: readonly ["AbortController", "DOMException"];
+    readonly dependencies: readonly ["tryOnScopeDispose"];
+  }, {
+    readonly name: "availableCapability";
+    readonly entry: "./capability";
+    readonly category: "capability";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "unavailableCapability";
+    readonly entry: "./capability";
+    readonly category: "capability";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "isCapabilityAvailable";
+    readonly entry: "./capability";
+    readonly category: "capability";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "isCapabilityUnavailable";
+    readonly entry: "./capability";
+    readonly category: "capability";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "createDisposalScope";
+    readonly entry: "./disposal-scope";
+    readonly category: "lifecycle";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["caller", "reactive-scope"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly ["tryOnScopeDispose"];
+  }, {
+    readonly name: "useEventListener";
+    readonly entry: "./event-listener";
+    readonly category: "events";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["caller", "reactive-scope"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly ["tryOnScopeDispose"];
+  }, {
+    readonly name: "useLocale";
+    readonly entry: "./locale";
+    readonly category: "i18n";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "deterministic-fallback";
+    readonly hydration: "caller-managed";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly ["Intl", "navigator"];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "useMediaQuery";
+    readonly entry: "./media-query";
+    readonly category: "media";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "desktop"];
+    readonly ssr: "deterministic-fallback";
+    readonly hydration: "caller-managed";
+    readonly cleanupOwners: readonly ["reactive-scope"];
+    readonly runtimeGlobals: readonly ["window"];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "useReducedMotion";
+    readonly entry: "./media-query";
+    readonly category: "media";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "desktop"];
+    readonly ssr: "deterministic-fallback";
+    readonly hydration: "caller-managed";
+    readonly cleanupOwners: readonly ["reactive-scope"];
+    readonly runtimeGlobals: readonly ["window"];
+    readonly dependencies: readonly ["useMediaQuery"];
+  }, {
+    readonly name: "retryAsync";
+    readonly entry: "./retry-async";
+    readonly category: "async";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["returned-value"];
+    readonly runtimeGlobals: readonly ["AbortController"];
+    readonly dependencies: readonly ["timeoutAbortSignal", "calculateRetryDelay"];
+  }, {
+    readonly name: "calculateRetryDelay";
+    readonly entry: "./retry-delay";
+    readonly category: "timing";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "tryOnScopeDispose";
+    readonly entry: "./scope";
+    readonly category: "lifecycle";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "not-applicable";
+    readonly cleanupOwners: readonly ["reactive-scope"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "useTemporalNow";
+    readonly entry: "./temporal";
+    readonly category: "timing";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "deterministic-fallback";
+    readonly hydration: "caller-managed";
+    readonly cleanupOwners: readonly ["reactive-scope"];
+    readonly runtimeGlobals: readonly ["globalThis", "window"];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "useTemporalZonedDateTime";
+    readonly entry: "./temporal";
+    readonly category: "timing";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "deterministic-fallback";
+    readonly hydration: "caller-managed";
+    readonly cleanupOwners: readonly ["reactive-scope"];
+    readonly runtimeGlobals: readonly ["globalThis", "window"];
+    readonly dependencies: readonly ["useTemporalNow"];
+  }, {
+    readonly name: "useCounter";
+    readonly entry: "./use-counter";
+    readonly category: "state";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "useDebounced";
+    readonly entry: "./use-debounced";
+    readonly category: "timing";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "deterministic-fallback";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["caller", "reactive-scope"];
+    readonly runtimeGlobals: readonly ["globalThis", "window"];
+    readonly dependencies: readonly ["tryOnScopeDispose"];
+  }, {
+    readonly name: "useHistory";
+    readonly entry: "./use-history";
+    readonly category: "state";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["reactive-scope"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly ["tryOnScopeDispose"];
+  }, {
+    readonly name: "usePrevious";
+    readonly entry: "./use-previous";
+    readonly category: "state";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }, {
+    readonly name: "useThrottled";
+    readonly entry: "./use-throttled";
+    readonly category: "timing";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "deterministic-fallback";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["caller", "reactive-scope"];
+    readonly runtimeGlobals: readonly ["globalThis", "window"];
+    readonly dependencies: readonly ["tryOnScopeDispose"];
+  }, {
+    readonly name: "useToggle";
+    readonly entry: "./use-toggle";
+    readonly category: "state";
+    readonly stability: "experimental";
+    readonly targets: readonly ["web", "server", "worker", "native", "desktop", "terminal"];
+    readonly ssr: "safe";
+    readonly hydration: "stable";
+    readonly cleanupOwners: readonly ["none"];
+    readonly runtimeGlobals: readonly [];
+    readonly dependencies: readonly [];
+  }];
+};
+//#endregion
+export { ComposableEntryMetadata as a, ComposableRootEntryMetadata as c, ComposableUtilityMetadata as d, ComposableCleanupOwner as i, ComposableSsrBehavior as l, ComposableCatalog as n, ComposableHydrationBehavior as o, ComposableCategory as r, ComposableInstallationAvailability as s, COMPOSABLE_CATALOG as t, ComposableStability as u };