@ifc-lite/sandbox 1.14.2 → 1.14.4

package/dist/bridge-schema.d.ts

@@ -17,6 +17,37 @@ import type { SandboxPermissions } from './types.js';
 type ArgType = 'string' | 'number' | 'dump' | 'entityRefs' | '...strings';
 /** How to marshal the return value back to QuickJS */
 type ReturnType = 'void' | 'string' | 'value';
+export type LlmTaskIntent = 'create' | 'inspect' | 'modify' | 'visualize' | 'repair' | 'export';
+export type MethodPlacementKind = 'storey-relative' | 'world' | 'wall-local' | 'explicit-placement' | 'element-target';
+export interface MethodSemanticContract {
+    /** High-level tasks where this method is especially relevant */
+    taskTags?: LlmTaskIntent[];
+    /** Expected placement frame for geometry methods */
+    placement?: MethodPlacementKind;
+    /** Required keys inside the params object */
+    requiredKeys?: string[];
+    /** Alternative required key groups, where any one group is valid */
+    anyOfKeys?: string[][];
+    /** Numeric keys that should be positive when provided as literals */
+    positiveKeys?: string[];
+    /** Point-array arity checks for literal vectors */
+    pointArity?: Record<string, number>;
+    /** Axis keys that must not collapse to the same point */
+    axisPair?: [string, string];
+    /** Keys that should never be used with this helper */
+    forbiddenKeys?: Array<{
+        key: string;
+        message: string;
+    }>;
+    /** Shared custom validator hook name for prompt/preflight/hints */
+    customValidationId?: 'slab-shape' | 'roof-shape' | 'generic-element' | 'axis-element';
+    /** Guidance for when to choose this helper */
+    useWhen?: string;
+    /** Warnings or repair hints attached to the contract */
+    cautions?: string[];
+    /** Whether repairs should inspect the loaded model first */
+    inspectFirst?: boolean;
+}
 export interface MethodSchema {
     /** Method name exposed in QuickJS (e.g., 'colorize') */
     name: string;
@@ -31,9 +62,11 @@ export interface MethodSchema {
     /** TypeScript return type for generated declarations (default: inferred from returns) */
     tsReturn?: string;
     /** Execute the SDK call and return a native JS value */
-    call: (sdk: BimContext, args: unknown[]) => unknown;
+    call: (sdk: BimContext, args: unknown[], context: BridgeCallContext) => unknown;
     /** How to marshal the return value */
     returns: ReturnType;
+    /** Shared semantic contract for prompts, validation, and repair hints */
+    llmSemantics?: MethodSemanticContract;
 }
 export interface NamespaceSchema {
     /** Namespace name on the `bim` object (e.g., 'viewer') */
@@ -45,12 +78,16 @@ export interface NamespaceSchema {
     /** Methods in this namespace */
     methods: MethodSchema[];
 }
+export interface BridgeCallContext {
+    sandboxSessionId: string;
+}
 export declare const NAMESPACE_SCHEMAS: NamespaceSchema[];
 /**
  * Build all schema-defined namespaces on the `bim` handle.
  * Skips namespaces whose permission is disabled.
  */
-export declare function buildSchemaNamespaces(vm: QuickJSContext, bimHandle: QuickJSHandle, sdk: BimContext, permissions: Required<SandboxPermissions>): void;
+export declare function buildSchemaNamespaces(vm: QuickJSContext, bimHandle: QuickJSHandle, sdk: BimContext, permissions: Required<SandboxPermissions>, context: BridgeCallContext): void;
+export declare function disposeSchemaNamespaceSession(context: BridgeCallContext): void;
 /** Recursively convert a native JS value to a QuickJS handle */
 export declare function marshalValue(vm: QuickJSContext, value: unknown): QuickJSHandle;
 export {};

package/dist/bridge-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bridge-schema.d.ts","sourceRoot":"","sources":["../src/bridge-schema.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,KAAK,EAAE,UAAU,EAAyB,MAAM,eAAe,CAAC;AAEvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AA+BrD,sDAAsD;AACtD,KAAK,OAAO,GACR,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,YAAY,CAAA;AAEhB,sDAAsD;AACtD,KAAK,UAAU,GACX,MAAM,GACN,QAAQ,GACR,OAAO,CAAA;AAEX,MAAM,WAAW,YAAY;IAC3B,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,+BAA+B;IAC/B,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,yFAAyF;IACzF,YAAY,CAAC,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;IACtC,yFAAyF;IACzF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,IAAI,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;IACpD,sCAAsC;IACtC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,2DAA2D;IAC3D,UAAU,EAAE,MAAM,kBAAkB,CAAC;IACrC,gCAAgC;IAChC,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AA4CD,eAAO,MAAM,iBAAiB,EAAE,eAAe,EAyhB9C,CAAC;AAMF;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,EAAE,EAAE,cAAc,EAClB,SAAS,EAAE,aAAa,EACxB,GAAG,EAAE,UAAU,EACf,WAAW,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACxC,IAAI,CAKN;AAkFD,gEAAgE;AAChE,wBAAgB,YAAY,CAAC,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,GAAG,aAAa,CA2B9E"}
+{"version":3,"file":"bridge-schema.d.ts","sourceRoot":"","sources":["../src/bridge-schema.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,KAAK,EAAE,UAAU,EAAyB,MAAM,eAAe,CAAC;AAEvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAuDrD,sDAAsD;AACtD,KAAK,OAAO,GACR,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,YAAY,CAAA;AAEhB,sDAAsD;AACtD,KAAK,UAAU,GACX,MAAM,GACN,QAAQ,GACR,OAAO,CAAA;AAEX,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,QAAQ,CAAC;AAEb,MAAM,MAAM,mBAAmB,GAC3B,iBAAiB,GACjB,OAAO,GACP,YAAY,GACZ,oBAAoB,GACpB,gBAAgB,CAAC;AAErB,MAAM,WAAW,sBAAsB;IACrC,gEAAgE;IAChE,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,oDAAoD;IACpD,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IACvB,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,yDAAyD;IACzD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,sDAAsD;IACtD,aAAa,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxD,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,YAAY,GAAG,YAAY,GAAG,iBAAiB,GAAG,cAAc,CAAC;IACtF,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,4DAA4D;IAC5D,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,+BAA+B;IAC/B,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,yFAAyF;IACzF,YAAY,CAAC,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;IACtC,yFAAyF;IACzF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,IAAI,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC;IAChF,sCAAsC;IACtC,OAAO,EAAE,UAAU,CAAC;IACpB,yEAAyE;IACzE,YAAY,CAAC,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,eAAe;IAC9B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,2DAA2D;IAC3D,UAAU,EAAE,MAAM,kBAAkB,CAAC;IACrC,gCAAgC;IAChC,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AA6iBD,eAAO,MAAM,iBAAiB,EAAE,eAAe,EAkxB9C,CAAC;AAMF;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,EAAE,EAAE,cAAc,EAClB,SAAS,EAAE,aAAa,EACxB,GAAG,EAAE,UAAU,EACf,WAAW,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EACzC,OAAO,EAAE,iBAAiB,GACzB,IAAI,CAKN;AA8BD,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAE9E;AAuDD,gEAAgE;AAChE,wBAAgB,YAAY,CAAC,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,GAAG,aAAa,CA2B9E"}