@tscircuit/props 0.0.693 → 0.0.694

package/lib/common/part-availability.ts

@@ -0,0 +1,24 @@
+import type { SupplierName } from "./layout"
+
+export type PartAvailabilityPlatformFetch = (
+  input: Parameters<typeof fetch>[0],
+  init?: Parameters<typeof fetch>[1],
+) => ReturnType<typeof fetch>
+
+export interface FetchPartAvailabilityParams {
+  supplierName: SupplierName
+  supplierPartNumber: string
+  platformFetch?: PartAvailabilityPlatformFetch
+  signal?: AbortSignal
+}
+
+export interface PartAvailability {
+  /** Available unit count; null means availability could not be confirmed. */
+  stock: number | null
+  /** Unit price at the supplier's lowest quantity tier; null means unknown. */
+  price: number | null
+  /** ISO 4217 currency code, such as USD; null when the price is unknown. */
+  currency: string | null
+  /** ISO timestamp of this lookup, rather than a guarantee of stock freshness. */
+  checkedAt?: string
+}

package/lib/components/group.ts

@@ -34,6 +34,10 @@ import {
 import { url } from "lib/common/url"
 import type { Connections } from "lib/utility-types/connections-and-selectors"
 import type { ImplicitBreakoutPointSolverFn } from "lib/common/implicitBreakoutPointSolver"
+import type {
+  FetchPartAvailabilityParams,
+  PartAvailability,
+} from "lib/common/part-availability"
 
 export const layoutConfig = z.object({
   layoutMode: z
@@ -297,6 +301,10 @@ export interface BaseGroupProps extends CommonLayoutProps, LayoutConfig {
 }
 
 export type PartsEngine = {
+  /** Optional stock and price lookup. Return undefined for unsupported suppliers. */
+  fetchPartAvailability?: (
+    params: FetchPartAvailabilityParams,
+  ) => Promise<PartAvailability | undefined> | PartAvailability | undefined
   findPart: (params: {
     sourceComponent: AnySourceComponent
     footprinterString?: string

package/lib/index.ts

@@ -53,6 +53,7 @@ export * from "./components/resonator"
 export * from "./components/stampboard"
 export * from "./components/capacitor"
 export * from "./components/group"
+export * from "./common/part-availability"
 export * from "./components/net"
 export * from "./components/fiducial"
 export * from "./components/constrainedlayout"

package/lib/platformConfig.ts

@@ -69,6 +69,13 @@ type EsModuleImportResult = {
 export interface PlatformConfig {
   partsEngine?: PartsEngine
 
+  /**
+   * Check JLCPCB supplier stock through jlcsearch during rendering and warn when
+   * availability cannot be confirmed. Omitted or false performs no checks.
+   * Enabling this adds network requests and non-deterministic diagnostics.
+   */
+  checkAvailability?: boolean
+
   /** Optional fabricator-specific DRC provider. No checks run when omitted. */
   fabricatorEngine?: FabricatorEngine
 
@@ -275,6 +282,12 @@ export const fabricatorEngine = z.custom<FabricatorEngine>(
 
 export const platformConfig = z.object({
   partsEngine: partsEngine.optional(),
+  checkAvailability: z
+    .boolean()
+    .describe(
+      "Opt in to networked JLCPCB availability checks during rendering. Disabled by default; enabling adds non-deterministic diagnostics.",
+    )
+    .optional(),
   fabricatorEngine: fabricatorEngine.optional(),
   autorouter: autorouterProp.optional(),
   autorouterMap: z.record(z.string(), autorouterDefinition).optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/props",
-  "version": "0.0.693",
+  "version": "0.0.694",
   "description": "Props for tscircuit builtin component types",
   "main": "dist/index.js",
   "type": "module",