quixos-protocol/src/bindings/react-platform.ts

/** One authoring contract, distributed by scaffolding and immutable codegen.
 * Web Studio checks its concrete exports against this contract during its build. */
export const reactPlatformTypes = `// Generated by the Quixos React platform contract. Do not edit.
declare module "@quixos/web-studio-react-runtime" {
  import type * as React from "react";
  export function useComponentOverlayContainer(): HTMLElement;
  export function useComponentStyleRoot(): ShadowRoot;
  export type ObjectRef<AtomId extends string> = string & {
    readonly $quixosAtom: AtomId;
  };
  export type FieldCapability = {objectId: string; interfaceRevisionId: string; getOperationId: string; watchOperationId?: string; setOperationId?: string; inputKind?: "fields" | "value"};
  export type ReadableField<T> = {readonly value?: T; readonly capability: FieldCapability};
  /** set(T) uses the resolved capability: native CRDT fields send incremental edits;
   * custom/manual setters receive semantic values. Storage provenance grants no authority. */
  export type WritableField<T> = ReadableField<T> & {readonly $writeType?: (value: T) => T; readonly writable: true; readonly capability: FieldCapability & {setOperationId: string}};
  export type LiveFieldProp<T> = ReadableField<T>;
  export type InterfaceReference<I extends string, Fields> = {readonly $quixosRef: string; readonly interfaceRevisionId: I; readonly fields: Fields};
  const conformanceView: unique symbol;
  export type ReactInterfaceContract<View> = {readonly interfaceRevisionId: string; readonly [conformanceView]: (view: View) => View};
  export function defineReactInterfaceContract<View>(interfaceRevisionId: string, interfaces: unknown): ReactInterfaceContract<View>;
  export function tryConform<View>(object: string | {readonly $quixosRef: string}, contract: ReactInterfaceContract<View>, options?: {signal?: AbortSignal}): Promise<View | undefined>;
  export type ConformanceResult<View> = {status: "loading"} | {status: "absent"} | {status: "available"; view: View} | {status: "error"; error: Error};
  export function useTryConform<View>(object: string | {readonly $quixosRef: string}, contract: ReactInterfaceContract<View>): ConformanceResult<View>;
  export type ReactComponentHostProps<Action> = {
    onAction?: (action: Action) => void;
    fallback?: React.ReactNode;
    className?: string;
    style?: React.CSSProperties;
    /** Optional extra action. The host still displays and reports errors by default. */
    extraErrorAction?: (error: Error) => void;
  };
  export type ReactComponentImplementationProps<CaminoProps, RenderProps, Action> = {
    camino: CaminoProps;
    render: RenderProps;
    dispatch: (action: Action) => void;
  };
  export const createWebStudioComponent: <
    ForObject extends ObjectRef<string>, RenderProps extends object, Action,
  >(config: { expectedAtomId: string }) => (props: {
    forObject: ForObject;
  } & RenderProps & ReactComponentHostProps<Action>) => any;
  export const invokeCapability: <Result = unknown>(
    objectId: string,
    interfaceRevisionId: string,
    operationId: string,
    value?: unknown,
    options?: {clientMutationId?: string; signal?: AbortSignal},
  ) => Promise<Result>;
  export const h: typeof React.createElement;
  export function useLiveField<T>(field: ReadableField<T>, options: {write: (value: T) => Promise<void>}): readonly [T, (value: T) => Promise<void>];
  export function useLiveField<T>(field: WritableField<T>): readonly [T, (value: T) => Promise<void>];
  export function useLiveField<T>(field: ReadableField<T>): readonly [T];
}
`;