import { CommonFieldTraverseOps, FieldTraversalStep, ResourceType } from "./traversal_ops.js"; import { AccessorHandle } from "./internal.js"; import { FutureRef } from "./future.js"; import { AnyLogHandle, ArchiveFormat, FolderURL, ImportProgress, LocalBlobHandleAndSize, PColumn, PObject, ProgressLogWithInfo, RangeBytes, RemoteBlobHandleAndSize } from "@milaboratories/pl-model-common"; export declare function ifDef(value: T | undefined, cb: (value: T) => R): R | undefined; type FieldMapOps = { /** * Type of fields to iterate over. * (default 'Input') * */ readonly fieldType?: "Input" | "Output" | "Dynamic"; /** * If not locked, `undefined` value will be returned. Do nothing if mapping `Dynamic` fields. * (default true) * */ readonly requireLocked?: boolean; /** * Will skip unresolved fields. * (default false) * */ readonly skipUnresolved?: boolean; }; /** Represent resource tree node accessor */ export declare class TreeNodeAccessor { readonly handle: AccessorHandle; readonly resolvePath: string[]; constructor(handle: AccessorHandle, resolvePath: string[]); /** Shortcut for {@link resolveInput} */ resolve(...steps: [Omit & { errorIfFieldNotAssigned: true; }]): TreeNodeAccessor; /** Shortcut for {@link resolveInput} */ resolve(...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined; /** If field type assertion is not specified for the step, default is Output. */ resolveOutput(...steps: [Omit & { errorIfFieldNotAssigned: true; }]): TreeNodeAccessor; /** If field type assertion is not specified for the step, default is Output. */ resolveOutput(...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined; /** If field type assertion is not specified for the step, default is Input. */ resolveInput(...steps: [Omit & { errorIfFieldNotAssigned: true; }]): TreeNodeAccessor; /** If field type assertion is not specified for the step, default is Input. */ resolveInput(...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined; traverse(...steps: [Omit & { errorIfFieldNotAssigned: true; }]): TreeNodeAccessor; traverse(...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined; resolveWithCommon(commonOptions: CommonFieldTraverseOps, ...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined; get resourceType(): ResourceType; getInputsLocked(): boolean; getOutputsLocked(): boolean; getIsReadyOrError(): boolean; getIsFinal(): boolean; getError(): TreeNodeAccessor | undefined; listInputFields(): string[]; listOutputFields(): string[]; listDynamicFields(): string[]; getKeyValueBase64(key: string): string | undefined; getKeyValueAsString(key: string): string | undefined; getKeyValueAsJson(key: string): T; hasData(): boolean; getDataBase64(): string | undefined; getDataAsString(): string | undefined; getDataAsJson(): T; /** * Like {@link getDataAsJson}, but does not throw while the resource is still * computing. Three states: * * - **Not ready** → returns `undefined` (loading). * - **Errored** → throws the resource's error. * - **Ready** → returns the parsed content. * * Prefer this over {@link getDataAsJson} in reactive output lambdas: a field * that resolves before its resource is ready (routine on remote backends) * makes {@link getDataAsJson} throw "Resource has no content." mid-calculation, * flashing a transient "Some outputs have errors" banner that clears when the * resource finishes (MILAB-6318). */ getDataAsJsonOrUndefined(): T | undefined; getFileContentAsBase64(range?: RangeBytes): FutureRef; getFileContentAsString(range?: RangeBytes): FutureRef; getFileContentAsJson(range?: RangeBytes): FutureRef; /** @deprecated */ getPColumns(errorOnUnknownField?: boolean, prefix?: string): PColumn[] | undefined; /** @deprecated */ parsePObjectCollection(errorOnUnknownField?: boolean, prefix?: string): Record> | undefined; /** * @deprecated use getFileContentAsBase64 */ getBlobContentAsBase64(): FutureRef; /** * @deprecated use getFileContentAsString */ getBlobContentAsString(): FutureRef; /** * @returns downloaded file handle */ getFileHandle(): FutureRef; /** * @deprecated use getFileHandle */ getDownloadedBlobHandle(): FutureRef; /** * @returns downloaded file handle */ getRemoteFileHandle(): FutureRef; /** * @deprecated use getRemoteFileHandle */ getOnDemandBlobHandle(): FutureRef; /** * @returns the url to the extracted folder */ extractArchiveAndGetURL(format: ArchiveFormat): FutureRef; getImportProgress(): FutureRef; getLastLogs(nLines: number): FutureRef; getProgressLog(patternToSearch: string): FutureRef; getProgressLogWithInfo(patternToSearch: string): FutureRef; getLogHandle(): FutureRef; allFieldsResolved(fieldType?: "Input" | "Output"): boolean; mapFields(_mapping: (name: string, value: TreeNodeAccessor) => T, _ops: FieldMapOps & { skipUnresolved: true; }): T[] | undefined; mapFields(_mapping: (name: string, value: TreeNodeAccessor | undefined) => T, _ops?: FieldMapOps): T[] | undefined; } export {}; //# sourceMappingURL=accessor.d.ts.map