vinext 0.0.49 → 0.0.51

package/dist/server/cache-proof.d.ts

@@ -1,9 +1,11 @@
 import { AppRouteSemanticIds } from "../routing/app-route-graph.js";
 
 //#region src/server/cache-proof.d.ts
-declare const CACHE_PROOF_MODEL_SCHEMA_VERSION = 0;
-type CacheProofModelSchemaVersion = 0;
-type CacheProofRejectionCode = "CP_MODEL_DISABLED" | "CP_DIMENSION_COUNT_EXCEEDED" | "CP_DIMENSION_NAME_MISSING" | "CP_DIMENSION_NAME_TOO_LONG" | "CP_DIMENSION_VALUE_COUNT_EXCEEDED" | "CP_DIMENSION_VALUE_TOO_LONG" | "CP_DIMENSION_VALUES_MISSING" | "CP_ENCODED_VARIANT_TOO_LONG" | "CP_INVALID_VARIANT_BUDGET" | "CP_ROUTE_VARIANT_CEILING_EXCEEDED" | "CP_UNSAFE_PUBLIC_DIMENSION" | "CP_BOUNDARY_OUTCOME_MISMATCH" | "CP_BOUNDARY_OUTCOME_UNKNOWN";
+declare const CACHE_PROOF_MODEL_SCHEMA_VERSION = 1;
+type CacheProofModelSchemaVersion = 1;
+type CacheProofRejectionCode = "CP_MODEL_DISABLED" | "CP_DIMENSION_COUNT_EXCEEDED" | "CP_DIMENSION_NAME_MISSING" | "CP_DIMENSION_NAME_TOO_LONG" | "CP_DIMENSION_VALUE_COUNT_EXCEEDED" | "CP_DIMENSION_VALUE_TOO_LONG" | "CP_DIMENSION_VALUES_MISSING" | "CP_ENCODED_VARIANT_TOO_LONG" | "CP_INVALID_VARIANT_BUDGET" | "CP_ROUTE_VARIANT_BUDGET_ROUTE_MISMATCH" | "CP_ROUTE_VARIANT_CEILING_EXCEEDED" | "CP_UNSAFE_PUBLIC_DIMENSION" | "CP_BOUNDARY_OUTCOME_MISMATCH" | "CP_BOUNDARY_OUTCOME_UNKNOWN" | "CP_PRIVATE_DYNAMIC_DOWNGRADE" | "CP_STATIC_LAYOUT_CANDIDATE_OUTPUT_KIND" | "CP_STATIC_LAYOUT_CURRENT_OUTPUT_KIND" | "CP_STATIC_LAYOUT_ID_MISMATCH" | "CP_STATIC_LAYOUT_OBSERVATION_OUTPUT_KIND" | "CP_STATIC_LAYOUT_OBSERVATION_OUTPUT_MISMATCH" | "CP_STATIC_LAYOUT_PRIVATE_DYNAMIC_DOWNGRADE" | "CP_STATIC_LAYOUT_PRIVATE_VARIANT_DIMENSION" | "CP_STATIC_LAYOUT_REQUEST_API_OBSERVED" | "CP_STATIC_LAYOUT_REQUEST_API_UNKNOWN" | "CP_STATIC_LAYOUT_ROOT_BOUNDARY_MISMATCH" | "CP_STATIC_LAYOUT_ROOT_BOUNDARY_UNKNOWN";
+type CacheProofAcceptanceCode = "CP_STATIC_LAYOUT_REUSE_PROVEN";
+type CacheProofTraceCode = CacheProofAcceptanceCode | CacheProofRejectionCode;
 type CacheProofTraceFieldValue = string | number | boolean | null | readonly string[];
 type CacheProofTraceFields = Readonly<Record<string, CacheProofTraceFieldValue>>;
 type CacheProofBreakerFallbackMode = "renderFresh" | "privateUncacheable";
@@ -83,6 +85,9 @@ type CacheProofOutputScope = Readonly<{
   routeId: string;
   templateId: string;
 }>;
+type StaticLayoutCacheProofOutputScope = Extract<CacheProofOutputScope, {
+  kind: "layout";
+}>;
 type CacheVariant = Readonly<{
   budget: CacheVariantBudget;
   cacheKey: string;
@@ -94,7 +99,6 @@ type CacheVariant = Readonly<{
 type BuildCacheVariantInput = Readonly<{
   budget: CacheVariantBudget;
   dimensions: readonly CacheVariantDimensionInput[];
-  existingVariantCount: number;
   output: CacheProofOutputScope;
 }>;
 type BuildCacheVariantResult = Readonly<{
@@ -104,6 +108,24 @@ type BuildCacheVariantResult = Readonly<{
   kind: "breakerFallback";
   fallback: CacheProofBreakerFallback;
 }>;
+type CacheVariantRouteBudget = Readonly<{
+  routeId: string;
+  variantCacheKeys: readonly string[];
+}>;
+type CacheVariantRouteBudgetAdmission = Readonly<{
+  didConsumeRouteVariantBudget: boolean;
+  kind: "variant";
+  routeBudget: CacheVariantRouteBudget;
+  variant: CacheVariant;
+}> | Readonly<{
+  fallback: CacheProofBreakerFallback;
+  kind: "breakerFallback";
+  routeBudget: CacheVariantRouteBudget | null;
+}>;
+type BuildCacheVariantWithRouteBudgetInput = BuildCacheVariantInput & Readonly<{
+  routeBudget: CacheVariantRouteBudget | null;
+}>;
+type BuildCacheVariantWithRouteBudgetResult = CacheVariantRouteBudgetAdmission;
 type AppRouteCacheProofGraphScopeInput = Readonly<{
   ids: AppRouteSemanticIds;
 }>;
@@ -150,21 +172,103 @@ type RenderObservationCompleteness = "complete" | "partial" | "unknown";
 type RenderCacheability = "private" | "public" | "uncacheable" | "unknown";
 type RenderRequestApiKind = "connection" | "cookies" | "draftMode" | "headers" | "params" | "searchParams";
 type RenderRequestApiStatus = "notObserved" | "observed" | "unknown";
+declare const ALL_RENDER_REQUEST_API_KINDS: readonly RenderRequestApiKind[];
 type RenderRequestApiObservation = Readonly<{
   kind: RenderRequestApiKind;
   status: RenderRequestApiStatus;
 }>;
+type CacheProofDowngradeTarget = "freshRender" | "private" | "privateUncacheable" | "public" | "publicVariant";
+type CacheProofDowngradeReason = Readonly<{
+  code: "CP_DOWNGRADE_CACHEABILITY_PRIVATE";
+  target: "private";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_CACHEABILITY_UNCACHEABLE";
+  target: "privateUncacheable";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_CACHEABILITY_UNKNOWN";
+  target: "freshRender";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_DYNAMIC_FETCH";
+  dynamicFetchCount: number;
+  target: "freshRender";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_DYNAMIC_REQUEST_API";
+  requestApi: "connection";
+  target: "freshRender";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_DRAFT_MODE";
+  requestApi: "draftMode";
+  target: "privateUncacheable";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_INCOMPLETE_OBSERVATION";
+  completeness: Exclude<RenderObservationCompleteness, "complete">;
+  target: "freshRender";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_PRIVATE_DIMENSION";
+  inputClass: "auth" | "draft" | "private" | "session";
+  source: "auth" | "cookie" | "draft-mode" | "header" | "session";
+  target: "private" | "privateUncacheable";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_PRIVATE_REQUEST_API";
+  requestApi: "cookies" | "headers";
+  target: "private";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_PUBLIC_REQUEST_API";
+  requestApi: "params" | "searchParams";
+  target: "publicVariant";
+}> | Readonly<{
+  code: "CP_DOWNGRADE_UNKNOWN_REQUEST_API";
+  requestApi: RenderRequestApiKind;
+  target: "freshRender";
+}>;
+type CacheProofDowngradeClassification = Readonly<{
+  fallback: CacheProofBreakerFallback | null;
+  isPublicCacheCandidate: boolean;
+  reasons: readonly CacheProofDowngradeReason[];
+  target: CacheProofDowngradeTarget;
+}>;
+type ClassifyRenderObservationDowngradeInput = Readonly<{
+  cacheability: RenderCacheability;
+  completeness: RenderObservationCompleteness;
+  dynamicFetches: readonly string[];
+  requestApis: readonly RenderRequestApiObservation[];
+}>;
+type ClassifyCacheVariantDimensionDowngradeInput = Pick<CacheVariantDimensionInput, "source">;
 type RenderObservation = Readonly<{
   boundaryOutcome: BoundaryOutcome;
   cacheTags: readonly string[];
   cacheability: RenderCacheability;
   completeness: RenderObservationCompleteness;
+  downgrade: CacheProofDowngradeClassification;
   dynamicFetches: readonly string[];
   output: CacheProofOutputScope;
   pathTags: readonly string[];
   requestApis: readonly RenderRequestApiObservation[];
   schemaVersion: CacheProofModelSchemaVersion;
 }>;
+type StaticLayoutReuseProof = Readonly<{
+  authorizesRuntimeReuse: false;
+  candidateOutput: StaticLayoutCacheProofOutputScope;
+  code: "CP_STATIC_LAYOUT_REUSE_PROVEN";
+  currentOutput: StaticLayoutCacheProofOutputScope;
+  fields: CacheProofTraceFields;
+  observation: RenderObservation;
+  requiredNegativeRequestApis: readonly RenderRequestApiKind[];
+  reuseClass: "static-layout";
+  variant: CacheVariant;
+}>;
+type BuildStaticLayoutReuseProofInput = Readonly<{
+  candidateObservation: RenderObservation;
+  candidateVariant: CacheVariant;
+  currentOutput: CacheProofOutputScope;
+}>;
+type BuildStaticLayoutReuseProofResult = Readonly<{
+  kind: "proof";
+  proof: StaticLayoutReuseProof;
+}> | Readonly<{
+  kind: "rejected";
+  fallback: CacheProofBreakerFallback;
+}>;
 type BuildRenderObservationInput = Readonly<{
   boundaryOutcome: BoundaryOutcome;
   cacheTags: readonly string[];
@@ -175,26 +279,41 @@ type BuildRenderObservationInput = Readonly<{
   pathTags: readonly string[];
   requestApis: readonly RenderRequestApiObservation[];
 }>;
+type BuildRenderRequestApiObservationsInput = Readonly<{
+  completeness: RenderObservationCompleteness;
+  observed: readonly RenderRequestApiKind[];
+}>;
 type DisabledCacheProofDecision = Readonly<{
   canReuse: false;
   fallback: CacheProofBreakerFallback;
   kind: "disabled";
   observation: RenderObservation;
+  staticLayoutProof?: StaticLayoutReuseProof;
   variant: CacheVariant;
 }>;
 type CreateDisabledCacheProofDecisionInput = Readonly<{
   observation: RenderObservation;
+  staticLayoutProof?: StaticLayoutReuseProof;
   variant: CacheVariant;
 }>;
 declare function createAppRouteCacheProofGraphScope(route: AppRouteCacheProofGraphScopeInput): AppRouteCacheProofGraphScope;
 declare function buildCacheVariant(input: BuildCacheVariantInput): BuildCacheVariantResult;
+declare function enforceCacheVariantRouteBudget(input: {
+  routeBudget: CacheVariantRouteBudget | null;
+  variant: CacheVariant;
+}): CacheVariantRouteBudgetAdmission;
+declare function buildCacheVariantWithRouteBudget(input: BuildCacheVariantWithRouteBudgetInput): BuildCacheVariantWithRouteBudgetResult;
 declare function buildBoundaryOutcomeCompatibility(input: {
   candidate: BoundaryOutcome;
   expected: BoundaryOutcome;
 }): BoundaryOutcomeCompatibility;
+declare function classifyCacheVariantDimensionDowngrade(input: ClassifyCacheVariantDimensionDowngradeInput): CacheProofDowngradeReason | null;
+declare function classifyRenderObservationDowngrade(input: ClassifyRenderObservationDowngradeInput): CacheProofDowngradeClassification;
+declare function buildRenderRequestApiObservations(input: BuildRenderRequestApiObservationsInput): RenderRequestApiObservation[];
 declare function buildRenderObservation(input: BuildRenderObservationInput): RenderObservation;
 declare function hasCompleteNegativeRequestApiProof(observation: RenderObservation, requiredApis: readonly RenderRequestApiKind[]): boolean;
+declare function buildStaticLayoutReuseProof(input: BuildStaticLayoutReuseProofInput): BuildStaticLayoutReuseProofResult;
 declare function createDisabledCacheProofDecision(input: CreateDisabledCacheProofDecisionInput): DisabledCacheProofDecision;
 //#endregion
-export { AppRouteCacheProofGraphScope, AppRouteCacheProofGraphScopeInput, BoundaryOutcome, BoundaryOutcomeCompatibility, BuildCacheVariantInput, BuildCacheVariantResult, BuildRenderObservationInput, CACHE_PROOF_MODEL_SCHEMA_VERSION, CacheProofBreakerFallback, CacheProofBreakerFallbackMode, CacheProofFallbackScope, CacheProofModelSchemaVersion, CacheProofOutputScope, CacheProofRejectionCode, CacheProofTraceFieldValue, CacheProofTraceFields, CacheVariant, CacheVariantBudget, CacheVariantDimension, CacheVariantDimensionInput, CacheVariantDimensionPrivacy, CacheVariantDimensionSource, CreateDisabledCacheProofDecisionInput, DEFAULT_CACHE_VARIANT_BUDGET, DisabledCacheProofDecision, RenderCacheability, RenderObservation, RenderObservationCompleteness, RenderRequestApiKind, RenderRequestApiObservation, RenderRequestApiStatus, buildBoundaryOutcomeCompatibility, buildCacheVariant, buildRenderObservation, createAppRouteCacheProofGraphScope, createDisabledCacheProofDecision, hasCompleteNegativeRequestApiProof };
+export { ALL_RENDER_REQUEST_API_KINDS, AppRouteCacheProofGraphScope, AppRouteCacheProofGraphScopeInput, BoundaryOutcome, BoundaryOutcomeCompatibility, BuildCacheVariantInput, BuildCacheVariantResult, BuildCacheVariantWithRouteBudgetInput, BuildCacheVariantWithRouteBudgetResult, BuildRenderObservationInput, BuildRenderRequestApiObservationsInput, BuildStaticLayoutReuseProofInput, BuildStaticLayoutReuseProofResult, CACHE_PROOF_MODEL_SCHEMA_VERSION, CacheProofAcceptanceCode, CacheProofBreakerFallback, CacheProofBreakerFallbackMode, CacheProofDowngradeClassification, CacheProofDowngradeReason, CacheProofDowngradeTarget, CacheProofFallbackScope, CacheProofModelSchemaVersion, CacheProofOutputScope, CacheProofRejectionCode, CacheProofTraceCode, CacheProofTraceFieldValue, CacheProofTraceFields, CacheVariant, CacheVariantBudget, CacheVariantDimension, CacheVariantDimensionInput, CacheVariantDimensionPrivacy, CacheVariantDimensionSource, CacheVariantRouteBudget, CacheVariantRouteBudgetAdmission, ClassifyCacheVariantDimensionDowngradeInput, ClassifyRenderObservationDowngradeInput, CreateDisabledCacheProofDecisionInput, DEFAULT_CACHE_VARIANT_BUDGET, DisabledCacheProofDecision, RenderCacheability, RenderObservation, RenderObservationCompleteness, RenderRequestApiKind, RenderRequestApiObservation, RenderRequestApiStatus, StaticLayoutCacheProofOutputScope, StaticLayoutReuseProof, buildBoundaryOutcomeCompatibility, buildCacheVariant, buildCacheVariantWithRouteBudget, buildRenderObservation, buildRenderRequestApiObservations, buildStaticLayoutReuseProof, classifyCacheVariantDimensionDowngrade, classifyRenderObservationDowngrade, createAppRouteCacheProofGraphScope, createDisabledCacheProofDecision, enforceCacheVariantRouteBudget, hasCompleteNegativeRequestApiProof };
 //# sourceMappingURL=cache-proof.d.ts.map