@platforma-sdk/model 1.58.3 → 1.58.9

package/dist/render/accessor.d.ts

@@ -1,125 +1,120 @@
-import type { AnyLogHandle, ImportProgress, LocalBlobHandleAndSize, PColumn, PObject, RemoteBlobHandleAndSize, FolderURL, ArchiveFormat, ProgressLogWithInfo, RangeBytes } from "@milaboratories/pl-model-common";
-import { FutureRef } from "./future";
-import type { AccessorHandle } from "./internal";
-import type { CommonFieldTraverseOps, FieldTraversalStep, ResourceType } from "./traversal_ops";
-export declare function ifDef<T, R>(value: T | undefined, cb: (value: T) => R): R | undefined;
+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";
+
+//#region src/render/accessor.d.ts
+declare function ifDef<T, R>(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;
+  /**
+   * 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<FieldTraversalStep, "errorIfFieldNotSet"> & {
-            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<FieldTraversalStep, "errorIfFieldNotSet"> & {
-            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<FieldTraversalStep, "errorIfFieldNotSet"> & {
-            errorIfFieldNotAssigned: true;
-        }
-    ]): TreeNodeAccessor;
-    /** If field type assertion is not specified for the step, default is Input. */
-    resolveInput(...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined;
-    resolveAny(...steps: [
-        Omit<FieldTraversalStep, "errorIfFieldNotSet"> & {
-            errorIfFieldNotAssigned: true;
-        }
-    ]): TreeNodeAccessor;
-    resolveAny(...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<T>(key: string): T;
-    getDataBase64(): string | undefined;
-    getDataAsString(): string | undefined;
-    getDataAsJson<T>(): T;
-    /**
-     *
-     */
-    getPColumns(errorOnUnknownField?: boolean, prefix?: string): PColumn<TreeNodeAccessor>[] | undefined;
-    /**
-     *
-     */
-    parsePObjectCollection(errorOnUnknownField?: boolean, prefix?: string): Record<string, PObject<TreeNodeAccessor>> | undefined;
-    getFileContentAsBase64(range?: RangeBytes): FutureRef<string | undefined>;
-    getFileContentAsString(range?: RangeBytes): FutureRef<string | undefined>;
-    getFileContentAsJson<T>(range?: RangeBytes): FutureRef<T | undefined>;
-    /**
-     * @deprecated use getFileContentAsBase64
-     */
-    getBlobContentAsBase64(): FutureRef<string | undefined>;
-    /**
-     * @deprecated use getFileContentAsString
-     */
-    getBlobContentAsString(): FutureRef<string | undefined>;
-    /**
-     * @returns downloaded file handle
-     */
-    getFileHandle(): FutureRef<LocalBlobHandleAndSize | undefined>;
-    /**
-     * @deprecated use getFileHandle
-     */
-    getDownloadedBlobHandle(): FutureRef<LocalBlobHandleAndSize | undefined>;
-    /**
-     * @returns downloaded file handle
-     */
-    getRemoteFileHandle(): FutureRef<RemoteBlobHandleAndSize | undefined>;
-    /**
-     * @deprecated use getRemoteFileHandle
-     */
-    getOnDemandBlobHandle(): FutureRef<RemoteBlobHandleAndSize | undefined>;
-    /**
-     * @returns the url to the extracted folder
-     */
-    extractArchiveAndGetURL(format: ArchiveFormat): FutureRef<FolderURL | undefined>;
-    getImportProgress(): FutureRef<ImportProgress>;
-    getLastLogs(nLines: number): FutureRef<string | undefined>;
-    getProgressLog(patternToSearch: string): FutureRef<string | undefined>;
-    getProgressLogWithInfo(patternToSearch: string): FutureRef<ProgressLogWithInfo | undefined>;
-    getLogHandle(): FutureRef<AnyLogHandle | undefined>;
-    allFieldsResolved(fieldType?: "Input" | "Output"): boolean;
-    mapFields<T>(_mapping: (name: string, value: TreeNodeAccessor) => T, _ops: FieldMapOps & {
-        skipUnresolved: true;
-    }): T[] | undefined;
-    mapFields<T>(_mapping: (name: string, value: TreeNodeAccessor | undefined) => T, _ops?: FieldMapOps): T[] | undefined;
+declare class TreeNodeAccessor {
+  readonly handle: AccessorHandle;
+  readonly resolvePath: string[];
+  constructor(handle: AccessorHandle, resolvePath: string[]);
+  /** Shortcut for {@link resolveInput} */
+  resolve(...steps: [Omit<FieldTraversalStep, "errorIfFieldNotSet"> & {
+    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<FieldTraversalStep, "errorIfFieldNotSet"> & {
+    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<FieldTraversalStep, "errorIfFieldNotSet"> & {
+    errorIfFieldNotAssigned: true;
+  }]): TreeNodeAccessor;
+  /** If field type assertion is not specified for the step, default is Input. */
+  resolveInput(...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined;
+  resolveAny(...steps: [Omit<FieldTraversalStep, "errorIfFieldNotSet"> & {
+    errorIfFieldNotAssigned: true;
+  }]): TreeNodeAccessor;
+  resolveAny(...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<T>(key: string): T;
+  getDataBase64(): string | undefined;
+  getDataAsString(): string | undefined;
+  getDataAsJson<T>(): T;
+  /**
+   *
+   */
+  getPColumns(errorOnUnknownField?: boolean, prefix?: string): PColumn<TreeNodeAccessor>[] | undefined;
+  /**
+   *
+   */
+  parsePObjectCollection(errorOnUnknownField?: boolean, prefix?: string): Record<string, PObject<TreeNodeAccessor>> | undefined;
+  getFileContentAsBase64(range?: RangeBytes): FutureRef<string | undefined>;
+  getFileContentAsString(range?: RangeBytes): FutureRef<string | undefined>;
+  getFileContentAsJson<T>(range?: RangeBytes): FutureRef<T | undefined>;
+  /**
+   * @deprecated use getFileContentAsBase64
+   */
+  getBlobContentAsBase64(): FutureRef<string | undefined>;
+  /**
+   * @deprecated use getFileContentAsString
+   */
+  getBlobContentAsString(): FutureRef<string | undefined>;
+  /**
+   * @returns downloaded file handle
+   */
+  getFileHandle(): FutureRef<LocalBlobHandleAndSize | undefined>;
+  /**
+   * @deprecated use getFileHandle
+   */
+  getDownloadedBlobHandle(): FutureRef<LocalBlobHandleAndSize | undefined>;
+  /**
+   * @returns downloaded file handle
+   */
+  getRemoteFileHandle(): FutureRef<RemoteBlobHandleAndSize | undefined>;
+  /**
+   * @deprecated use getRemoteFileHandle
+   */
+  getOnDemandBlobHandle(): FutureRef<RemoteBlobHandleAndSize | undefined>;
+  /**
+   * @returns the url to the extracted folder
+   */
+  extractArchiveAndGetURL(format: ArchiveFormat): FutureRef<FolderURL | undefined>;
+  getImportProgress(): FutureRef<ImportProgress>;
+  getLastLogs(nLines: number): FutureRef<string | undefined>;
+  getProgressLog(patternToSearch: string): FutureRef<string | undefined>;
+  getProgressLogWithInfo(patternToSearch: string): FutureRef<ProgressLogWithInfo | undefined>;
+  getLogHandle(): FutureRef<AnyLogHandle | undefined>;
+  allFieldsResolved(fieldType?: "Input" | "Output"): boolean;
+  mapFields<T>(_mapping: (name: string, value: TreeNodeAccessor) => T, _ops: FieldMapOps & {
+    skipUnresolved: true;
+  }): T[] | undefined;
+  mapFields<T>(_mapping: (name: string, value: TreeNodeAccessor | undefined) => T, _ops?: FieldMapOps): T[] | undefined;
 }
-export {};
+//#endregion
+export { TreeNodeAccessor, ifDef };
 //# sourceMappingURL=accessor.d.ts.map