@milaboratories/pl-client 2.4.10 → 2.4.11

package/dist/core/auth.d.ts

@@ -0,0 +1,6 @@
+import { AuthInformation } from './config';
+/** Returns a timestamp when current authorization information should be refreshed.
+ * Compare the value with Date.now(). */
+export declare function inferAuthRefreshTime(info: AuthInformation, maxRefreshSeconds: number): number | undefined;
+export declare function expirationFromAuthInformation(authInfo: AuthInformation): number | undefined;
+//# sourceMappingURL=auth.d.ts.map

package/dist/core/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/core/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;wCACwC;AACxC,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,eAAe,EACrB,iBAAiB,EAAE,MAAM,GACxB,MAAM,GAAG,SAAS,CAYpB;AAED,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,GAAG,SAAS,CAI3F"}

package/dist/core/client.d.ts

@@ -0,0 +1,50 @@
+import { AuthOps, PlClientConfig, PlConnectionStatusListener } from './config';
+import { PlCallOps } from './ll_client';
+import { PlTransaction } from './transaction';
+import { ResourceId } from './types';
+import { RetryOptions } from '@milaboratories/ts-helpers';
+import { PlDriver, PlDriverDefinition } from './driver';
+import { MaintenanceAPI_Ping_Response } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';
+import { Dispatcher } from 'undici';
+export type TxOps = PlCallOps & {
+    sync?: boolean;
+    retryOptions?: RetryOptions;
+};
+/** Client to access core PL API. */
+export declare class PlClient {
+    private readonly ll;
+    private readonly drivers;
+    /** Artificial delay introduced after write transactions completion, to
+     * somewhat throttle the load on pl. Delay introduced after sync, if requested. */
+    private readonly txDelay;
+    /** Last resort measure to solve complicated race conditions in pl. */
+    private readonly forceSync;
+    /** Last resort measure to solve complicated race conditions in pl. */
+    private readonly defaultRetryOptions;
+    /** Stores client root (this abstraction is intended for future implementation of the security model)*/
+    private _clientRoot;
+    private _serverInfo;
+    private constructor();
+    ping(): Promise<MaintenanceAPI_Ping_Response>;
+    get conf(): PlClientConfig;
+    get httpDispatcher(): Dispatcher;
+    private get initialized();
+    private checkInitialized;
+    get clientRoot(): ResourceId;
+    get serverInfo(): MaintenanceAPI_Ping_Response;
+    /** Currently implements custom logic to emulate future behaviour with single root. */
+    init(): Promise<void>;
+    /** Returns true if field existed */
+    deleteAlternativeRoot(alternativeRootName: string): Promise<boolean>;
+    private _withTx;
+    private withTx;
+    withWriteTx<T>(name: string, body: (tx: PlTransaction) => Promise<T>, ops?: Partial<TxOps>): Promise<T>;
+    withReadTx<T>(name: string, body: (tx: PlTransaction) => Promise<T>, ops?: Partial<TxOps>): Promise<T>;
+    getDriver<Drv extends PlDriver>(definition: PlDriverDefinition<Drv>): Drv;
+    /** Closes underlying transport */
+    close(): void;
+    static init(configOrAddress: PlClientConfig | string, auth: AuthOps, ops?: {
+        statusListener?: PlConnectionStatusListener;
+    }): Promise<PlClient>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/core/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/core/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAkB,aAAa,EAAwC,MAAM,eAAe,CAAC;AAEpG,OAAO,EAKL,UAAU,EACX,MAAM,SAAS,CAAC;AAEjB,OAAO,EAIL,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,0DAA0D,CAAC;AAExG,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,MAAM,KAAK,GAAG,SAAS,GAAG;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAYF,oCAAoC;AACpC,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAa;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+B;IAEvD;sFACkF;IAClF,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC,sEAAsE;IACtE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IAEpC,sEAAsE;IACtE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAe;IAEnD,uGAAuG;IACvG,OAAO,CAAC,WAAW,CAAsC;IAEzD,OAAO,CAAC,WAAW,CAAuD;IAE1E,OAAO;IAmCM,IAAI,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAI1D,IAAW,IAAI,IAAI,cAAc,CAEhC;IAED,IAAW,cAAc,IAAI,UAAU,CAEtC;IAED,OAAO,KAAK,WAAW,GAEtB;IAED,OAAO,CAAC,gBAAgB;IAIxB,IAAW,UAAU,IAAI,UAAU,CAGlC;IAED,IAAW,UAAU,IAAI,4BAA4B,CAGpD;IAED,sFAAsF;IACzE,IAAI;IA8CjB,oCAAoC;IACvB,qBAAqB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;YAgBnE,OAAO;YAgEP,MAAM;IAUP,WAAW,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EAAE,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,EACvC,GAAG,GAAE,OAAO,CAAC,KAAK,CAAM,GACvB,OAAO,CAAC,CAAC,CAAC;IAIA,UAAU,CAAC,CAAC,EACvB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EAAE,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,EACvC,GAAG,GAAE,OAAO,CAAC,KAAK,CAAM,GACvB,OAAO,CAAC,CAAC,CAAC;IAIN,SAAS,CAAC,GAAG,SAAS,QAAQ,EAAE,UAAU,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAAG,GAAG;IAQhF,kCAAkC;IAC3B,KAAK;WAIQ,IAAI,CACtB,eAAe,EAAE,cAAc,GAAG,MAAM,EACxC,IAAI,EAAE,OAAO,EACb,GAAG,GAAE;QACH,cAAc,CAAC,EAAE,0BAA0B,CAAC;KACxC;CAMT"}

package/dist/core/config.d.ts

@@ -0,0 +1,91 @@
+/** Base configuration structure for PL client */
+export interface PlClientConfig {
+    /** Port and host of remote pl server */
+    hostAndPort: string;
+    /** If set, client will expose a nested object under a field with name `alternative_root_${alternativeRoot}` as a
+     * client root. */
+    alternativeRoot?: string;
+    /** If true, client will establish tls connection to the server, using default
+     * CA of node instance. */
+    ssl: boolean;
+    /** Default timeout in milliseconds for unary calls, like ping and login. */
+    defaultRequestTimeout: number;
+    /** Default timeout in milliseconds for transaction, should be adjusted for
+     * long round-trip connections. */
+    defaultTransactionTimeout: number;
+    /** Controls what TTL will be requested from the server, when new JWT token
+     * is requested. */
+    authTTLSeconds: number;
+    /** If token is older than this time, it will be refreshed regardless of its
+     * expiration time. */
+    authMaxRefreshSeconds: number;
+    /** Proxy server URL to use for pl connection. */
+    grpcProxy?: string;
+    /** Proxy server URL to use for http connections of pl drivers, like file
+     * downloading. */
+    httpProxy?: string;
+    /** Username extracted from pl URL. Ignored by {@link PlClient}, picked up by {@link defaultPlClient}. */
+    user?: string;
+    /** Password extracted from pl URL. Ignored by {@link PlClient}, picked up by {@link defaultPlClient}. */
+    password?: string;
+    /** Artificial delay introduced after write transactions completion, to
+     * somewhat throttle the load on pl. Delay introduced after sync, if requested. */
+    txDelay: number;
+    /** Last resort measure to solve complicated race conditions in pl. */
+    forceSync: boolean;
+    /**
+     * What type of backoff strategy to use in transaction retries
+     * (pl uses optimistic transaction model with regular retries in write transactions)
+     * */
+    retryBackoffAlgorithm: 'exponential' | 'linear';
+    /** Maximal number of attempts in */
+    retryMaxAttempts: number;
+    /** Delay after first failed attempt, in ms. */
+    retryInitialDelay: number;
+    /** Each time delay will be multiplied by this number (1.5 means plus on 50% each attempt) */
+    retryExponentialBackoffMultiplier: number;
+    /** [used only for ] This value will be added to the delay from the previous step, in ms */
+    retryLinearBackoffStep: number;
+    /** Value from 0 to 1, determine level of randomness to introduce to the backoff delays sequence. (0 meaning no randomness) */
+    retryJitter: number;
+}
+export declare const DEFAULT_REQUEST_TIMEOUT = 1000;
+export declare const DEFAULT_TX_TIMEOUT = 10000;
+export declare const DEFAULT_TOKEN_TTL_SECONDS: number;
+export declare const DEFAULT_AUTH_MAX_REFRESH: number;
+export declare const DEFAULT_RETRY_BACKOFF_ALGORITHM = "exponential";
+export declare const DEFAULT_RETRY_MAX_ATTEMPTS = 10;
+export declare const DEFAULT_RETRY_INITIAL_DELAY = 4;
+export declare const DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER = 2;
+export declare const DEFAULT_RETRY_LINEAR_BACKOFF_STEP = 50;
+export declare const DEFAULT_RETRY_JITTER = 0.3;
+type PlConfigOverrides = Partial<Pick<PlClientConfig, 'ssl' | 'defaultRequestTimeout' | 'defaultTransactionTimeout' | 'httpProxy' | 'grpcProxy'>>;
+/** Parses pl url and creates a config object that can be passed to
+ * {@link PlClient} of {@link UnauthenticatedPlClient}. */
+export declare function plAddressToConfig(address: string, overrides?: PlConfigOverrides): PlClientConfig;
+/**
+ * Authorization data / JWT Token.
+ * Absent JWT Token tells the client to connect as anonymous user.
+ * */
+export interface AuthInformation {
+    /** Absent token means anonymous access */
+    jwtToken?: string;
+}
+export declare const AnonymousAuthInformation: AuthInformation;
+/** Authorization related settings to pass to {@link PlClient}. */
+export interface AuthOps {
+    /** Initial authorization information */
+    authInformation: AuthInformation;
+    /** Will be executed after successful authorization information refresh */
+    readonly onUpdate?: (newInfo: AuthInformation) => void;
+    /** Will be executed if auth-related error happens during normal client operation */
+    readonly onAuthError?: () => void;
+    /** Will be executed if error encountered during token update */
+    readonly onUpdateError?: (error: unknown) => void;
+}
+/** Connection status. */
+export type PlConnectionStatus = 'OK' | 'Disconnected' | 'Unauthenticated';
+/** Listener that will be called each time connection status changes. */
+export type PlConnectionStatusListener = (status: PlConnectionStatus) => void;
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/core/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/core/config.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;IAEpB;sBACkB;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;8BAC0B;IAI1B,GAAG,EAAE,OAAO,CAAC;IAEb,4EAA4E;IAC5E,qBAAqB,EAAE,MAAM,CAAC;IAC9B;sCACkC;IAClC,yBAAyB,EAAE,MAAM,CAAC;IAElC;uBACmB;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB;0BACsB;IACtB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;sBACkB;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,yGAAyG;IACzG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yGAAyG;IACzG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;sFACkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAEhB,sEAAsE;IACtE,SAAS,EAAE,OAAO,CAAC;IAMnB;;;SAGK;IACL,qBAAqB,EAAE,aAAa,GAAG,QAAQ,CAAC;IAChD,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,+CAA+C;IAC/C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,6FAA6F;IAC7F,iCAAiC,EAAE,MAAM,CAAC;IAC1C,2FAA2F;IAC3F,sBAAsB,EAAE,MAAM,CAAC;IAC/B,8HAA8H;IAC9H,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,eAAO,MAAM,uBAAuB,OAAO,CAAC;AAC5C,eAAO,MAAM,kBAAkB,QAAS,CAAC;AACzC,eAAO,MAAM,yBAAyB,QAAoB,CAAC;AAC3D,eAAO,MAAM,wBAAwB,QAAoB,CAAC;AAE1D,eAAO,MAAM,+BAA+B,gBAAgB,CAAC;AAC7D,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAC7C,eAAO,MAAM,2BAA2B,IAAI,CAAC;AAC7C,eAAO,MAAM,4CAA4C,IAAI,CAAC;AAC9D,eAAO,MAAM,iCAAiC,KAAK,CAAC;AACpD,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC,KAAK,iBAAiB,GAAG,OAAO,CAC9B,IAAI,CACF,cAAc,EACd,KAAK,GAAG,uBAAuB,GAAG,2BAA2B,GAAG,WAAW,GAAG,WAAW,CAC1F,CACF,CAAC;AASF;0DAC0D;AAC1D,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,iBAAsB,GAChC,cAAc,CAoEhB;AAED;;;KAGK;AACL,MAAM,WAAW,eAAe;IAC9B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,wBAAwB,EAAE,eAAoB,CAAC;AAE5D,kEAAkE;AAClE,MAAM,WAAW,OAAO;IACtB,wCAAwC;IACxC,eAAe,EAAE,eAAe,CAAC;IACjC,0EAA0E;IAC1E,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;IACvD,oFAAoF;IACpF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IAClC,gEAAgE;IAChE,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACnD;AAED,yBAAyB;AACzB,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAE3E,wEAAwE;AACxE,MAAM,MAAM,0BAA0B,GAAG,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC"}

package/dist/core/default_client.d.ts

@@ -0,0 +1,11 @@
+import { PlClientConfig } from './config';
+import { PlClient } from './client';
+type FileConfigOverrideFields = 'grpcProxy' | 'httpProxy' | 'user' | 'password' | 'alternativeRoot' | 'defaultTransactionTimeout' | 'defaultRequestTimeout' | 'authTTLSeconds' | 'authMaxRefreshSeconds';
+type PlConfigFile = {
+    address: string;
+} & Partial<Pick<PlClientConfig, FileConfigOverrideFields>>;
+export declare function tryGetFileConfig(): [PlConfigFile, string] | undefined;
+/** Uses default algorithm to construct a pl client from the environment */
+export declare function defaultPlClient(): Promise<PlClient>;
+export {};
+//# sourceMappingURL=default_client.d.ts.map

package/dist/core/default_client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default_client.d.ts","sourceRoot":"","sources":["../../src/core/default_client.ts"],"names":[],"mappings":"AACA,OAAO,EAAsC,cAAc,EAAE,MAAM,UAAU,CAAC;AAO9E,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAiBpC,KAAK,wBAAwB,GACzB,WAAW,GACX,WAAW,GACX,MAAM,GACN,UAAU,GACV,iBAAiB,GACjB,2BAA2B,GAC3B,uBAAuB,GACvB,gBAAgB,GAChB,uBAAuB,CAAC;AAa5B,KAAK,YAAY,GAAG;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC,CAAC;AAS5D,wBAAgB,gBAAgB,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,SAAS,CAQrE;AAyBD,2EAA2E;AAC3E,wBAAsB,eAAe,IAAI,OAAO,CAAC,QAAQ,CAAC,CAoEzD"}

package/dist/core/driver.d.ts

@@ -0,0 +1,18 @@
+import { PlClient } from './client';
+import { GrpcTransport } from '@protobuf-ts/grpc-transport';
+import { RpcOptions } from '@protobuf-ts/runtime-rpc';
+import { Dispatcher } from 'undici';
+import { ResourceType } from './types';
+/** Drivers must implement this interface */
+export interface PlDriver {
+    close(): void;
+}
+/** Definition to use driver via {@link PlClient} */
+export interface PlDriverDefinition<Drv extends PlDriver> {
+    /** Used as key to only once instantiate specific drivers */
+    readonly name: string;
+    /** Initialization routine, will be executed only once for each driver in a specific client */
+    init(pl: PlClient, grpcTransport: GrpcTransport, httpDispatcher: Dispatcher): Drv;
+}
+export declare function addRTypeToMetadata(rType: ResourceType, options?: RpcOptions): RpcOptions;
+//# sourceMappingURL=driver.d.ts.map

package/dist/core/driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../src/core/driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,4CAA4C;AAC5C,MAAM,WAAW,QAAQ;IACvB,KAAK,IAAI,IAAI,CAAC;CACf;AAED,oDAAoD;AACpD,MAAM,WAAW,kBAAkB,CAAC,GAAG,SAAS,QAAQ;IACtD,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,8FAA8F;IAC9F,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,GAAG,GAAG,CAAC;CACnF;AAKD,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,UAAU,cAM3E"}

package/dist/core/errors.d.ts

@@ -0,0 +1,25 @@
+import { Status } from '../proto/github.com/googleapis/googleapis/google/rpc/status';
+export declare function isConnectionProblem(err: unknown, nested?: boolean): boolean;
+export declare function isUnauthenticated(err: unknown, nested?: boolean): boolean;
+export declare function isTimeoutOrCancelError(err: unknown, nested?: boolean): boolean;
+export declare const PlErrorCodeNotFound = 5;
+export declare class PlError extends Error {
+    readonly status: Status;
+    constructor(status: Status);
+}
+export declare function throwPlNotFoundError(message: string): never;
+export declare class RecoverablePlError extends PlError {
+    constructor(status: Status);
+}
+export declare class UnrecoverablePlError extends PlError {
+    constructor(status: Status);
+}
+export declare function isNotFoundError(err: unknown, nested?: boolean): boolean;
+export declare class UnauthenticatedError extends Error {
+    constructor(message: string);
+}
+export declare class DisconnectedError extends Error {
+    constructor(message: string);
+}
+export declare function rethrowMeaningfulError(error: any, wrapIfUnknown?: boolean): never;
+//# sourceMappingURL=errors.d.ts.map

package/dist/core/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6DAA6D,CAAC;AAGrF,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAOlF;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAOhF;AAED,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAYrF;AAED,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC,qBAAa,OAAQ,SAAQ,KAAK;aACJ,MAAM,EAAE,MAAM;gBAAd,MAAM,EAAE,MAAM;CAG3C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;AAED,qBAAa,kBAAmB,SAAQ,OAAO;gBACjC,MAAM,EAAE,MAAM;CAG3B;AAED,qBAAa,oBAAqB,SAAQ,OAAO;gBACnC,MAAM,EAAE,MAAM;CAG3B;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAI9E;AAED,qBAAa,oBAAqB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,iBAAkB,SAAQ,KAAK;gBAC9B,OAAO,EAAE,MAAM;CAG5B;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE,aAAa,GAAE,OAAe,GAAG,KAAK,CAMxF"}

package/dist/core/http.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=http.d.ts.map

package/dist/core/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/core/http.ts"],"names":[],"mappings":""}

package/dist/core/ll_client.d.ts

@@ -0,0 +1,50 @@
+import { PlatformClient } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api.client';
+import { AuthOps, PlClientConfig, PlConnectionStatus, PlConnectionStatusListener } from './config';
+import { GrpcTransport } from '@protobuf-ts/grpc-transport';
+import { LLPlTransaction } from './ll_transaction';
+import { Dispatcher } from 'undici';
+export interface PlCallOps {
+    timeout?: number;
+    abortSignal?: AbortSignal;
+}
+/** Abstract out low level networking and authorization details */
+export declare class LLPlClient {
+    readonly conf: PlClientConfig;
+    /** Initial authorization information */
+    private authInformation?;
+    /** Will be executed by the client when it is required */
+    private readonly onAuthUpdate?;
+    /** Will be executed if auth-related error happens during normal client operation */
+    private readonly onAuthError?;
+    /** Will be executed by the client when it is required */
+    private readonly onAuthRefreshProblem?;
+    /** Threshold after which auth info refresh is required */
+    private refreshTimestamp?;
+    private _status;
+    private readonly statusListener?;
+    readonly grpcTransport: GrpcTransport;
+    readonly grpcPl: PlatformClient;
+    readonly httpDispatcher: Dispatcher;
+    constructor(configOrAddress: PlClientConfig | string, ops?: {
+        auth?: AuthOps;
+        statusListener?: PlConnectionStatusListener;
+    });
+    /** Returns true if client is authenticated. Even with anonymous auth information
+     * connection is considered authenticated. Unauthenticated clients are used for
+     * login and similar tasks, see {@link UnauthenticatedPlClient}. */
+    get authenticated(): boolean;
+    /** null means anonymous connection */
+    get authUser(): string | null;
+    private updateStatus;
+    get status(): PlConnectionStatus;
+    private authRefreshInProgress;
+    private refreshAuthInformationIfNeeded;
+    /** Detects certain errors and update client status accordingly */
+    private createErrorInterceptor;
+    /** Injects authentication information if needed */
+    private createAuthInterceptor;
+    createTx(ops?: PlCallOps): LLPlTransaction;
+    /** Closes underlying transport */
+    close(): void;
+}
+//# sourceMappingURL=ll_client.d.ts.map

package/dist/core/ll_client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ll_client.d.ts","sourceRoot":"","sources":["../../src/core/ll_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iEAAiE,CAAC;AAOjG,OAAO,EAEL,OAAO,EAEP,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAe,aAAa,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,EAAS,UAAU,EAAc,MAAM,QAAQ,CAAC;AAGvD,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,kEAAkE;AAClE,qBAAa,UAAU;IACrB,SAAgB,IAAI,EAAE,cAAc,CAAC;IAErC,wCAAwC;IACxC,OAAO,CAAC,eAAe,CAAC,CAAkB;IAC1C,yDAAyD;IACzD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAqC;IACnE,oFAAoF;IACpF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAa;IAC1C,yDAAyD;IACzD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAA2B;IACjE,0DAA0D;IAC1D,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAElC,OAAO,CAAC,OAAO,CAA4B;IAC3C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAA6B;IAE7D,SAAgB,aAAa,EAAE,aAAa,CAAC;IAC7C,SAAgB,MAAM,EAAE,cAAc,CAAC;IAEvC,SAAgB,cAAc,EAAE,UAAU,CAAC;gBAGzC,eAAe,EAAE,cAAc,GAAG,MAAM,EACxC,GAAG,GAAE;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,cAAc,CAAC,EAAE,0BAA0B,CAAC;KACxC;IAoDR;;uEAEmE;IACnE,IAAW,aAAa,IAAI,OAAO,CAElC;IAED,sCAAsC;IACtC,IAAW,QAAQ,IAAI,MAAM,GAAG,IAAI,CAKnC;IAED,OAAO,CAAC,YAAY;IAUpB,IAAW,MAAM,IAAI,kBAAkB,CAEtC;IAED,OAAO,CAAC,qBAAqB,CAAkB;IAE/C,OAAO,CAAC,8BAA8B;IAiCtC,kEAAkE;IAClE,OAAO,CAAC,sBAAsB;IAoB9B,mDAAmD;IACnD,OAAO,CAAC,qBAAqB;IAgB7B,QAAQ,CAAC,GAAG,GAAE,SAAc,GAAG,eAAe;IAe9C,kCAAkC;IAC3B,KAAK;CAGb"}

package/dist/core/ll_transaction.d.ts

@@ -0,0 +1,55 @@
+import { TxAPI_ClientMessage, TxAPI_ServerMessage } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';
+import { DuplexStreamingCall } from '@protobuf-ts/runtime-rpc';
+export type ClientMessageRequest = TxAPI_ClientMessage['request'];
+export type ServerMessageResponse = TxAPI_ServerMessage['response'];
+type TxStream = DuplexStreamingCall<TxAPI_ClientMessage, TxAPI_ServerMessage>;
+export type OneOfKind<T extends {
+    oneofKind: unknown;
+}, Kind extends T['oneofKind']> = Extract<T, {
+    oneofKind: Kind;
+}>;
+export declare class RethrowError extends Error {
+    readonly rethrowLambda: () => never;
+    constructor(rethrowLambda: () => never);
+}
+export declare class LLPlTransaction {
+    /** Bidirectional channel through which transaction communicates with the server */
+    private readonly stream;
+    /** Used to abort ongoing transaction stream */
+    private readonly abortController;
+    /** Counter of sent requests, used to calculate which future response will correspond to this request.
+     * Incremented on each sent request. */
+    private requestIdxCounter;
+    /** Queue from which incoming message processor takes handlers to which pass incoming messages */
+    private readonly responseHandlerQueue;
+    /** Each new resource, created by the transaction, is assigned with virtual (local) resource id, to make it possible
+     * to populate its fields without awaiting actual resource id. This counter tracks those ids on client side, the
+     * same way it is tracked on the server, so client can synchronously return such ids to the user. */
+    private localResourceIdCounter;
+    /** Switches to true, when this transaction closes due to normal or exceptional conditions. Prevents any new messages
+     * to be sent to the stream. */
+    private closed;
+    /** Whether the outgoing stream was already closed. */
+    private completed;
+    /** If this transaction was terminated due to error, this is a generator to create new errors if corresponding response is required. */
+    private errorFactory?;
+    /** Timestamp when transaction was opened */
+    private readonly openTimestamp;
+    private readonly incomingProcessorResult;
+    constructor(streamFactory: (abortSignal: AbortSignal) => TxStream);
+    private assignErrorFactoryIfNotSet;
+    private incomingEventProcessor;
+    /** Executed after termination of incoming message processor */
+    private close;
+    /** Forcefully close the transaction, terminate all connections and reject all pending requests */
+    abort(cause?: Error): void;
+    /** Await incoming message loop termination and throw any leftover errors if it was unsuccessful */
+    await(): Promise<void>;
+    send<Kind extends ClientMessageRequest['oneofKind']>(r: OneOfKind<ClientMessageRequest, Kind>, expectMultiResponse: false): Promise<OneOfKind<ServerMessageResponse, Kind>>;
+    send<Kind extends ClientMessageRequest['oneofKind']>(r: OneOfKind<ClientMessageRequest, Kind>, expectMultiResponse: true): Promise<OneOfKind<ServerMessageResponse, Kind>[]>;
+    private _completed;
+    /** Safe to call multiple times */
+    complete(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ll_transaction.d.ts.map

package/dist/core/ll_transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ll_transaction.d.ts","sourceRoot":"","sources":["../../src/core/ll_transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,0DAA0D,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAU/D,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAElE,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;AAEpE,KAAK,QAAQ,GAAG,mBAAmB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;AAE9E,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,EAAE,IAAI,SAAS,CAAC,CAAC,WAAW,CAAC,IAAI,OAAO,CAC5F,CAAC,EACD;IAAE,SAAS,EAAE,IAAI,CAAA;CAAE,CACpB,CAAC;AAuCF,qBAAa,YAAa,SAAQ,KAAK;aACT,aAAa,EAAE,MAAM,KAAK;gBAA1B,aAAa,EAAE,MAAM,KAAK;CAGvD;AAED,qBAAa,eAAe;IAC1B,mFAAmF;IACnF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAElC,+CAA+C;IAC/C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyB;IAEzD;2CACuC;IACvC,OAAO,CAAC,iBAAiB,CAAK;IAE9B,iGAAiG;IACjG,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAoC;IAEzE;;wGAEoG;IACpG,OAAO,CAAC,sBAAsB,CAAM;IAEpC;mCAC+B;IAC/B,OAAO,CAAC,MAAM,CAAS;IACvB,sDAAsD;IACtD,OAAO,CAAC,SAAS,CAAS;IAE1B,uIAAuI;IACvI,OAAO,CAAC,YAAY,CAAC,CAAc;IAEnC,4CAA4C;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAc;IAE5C,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAgC;gBAE5D,aAAa,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,QAAQ;IAOjE,OAAO,CAAC,0BAA0B;YAUpB,sBAAsB;IAiIpC,+DAA+D;YACjD,KAAK;IAkBnB,kGAAkG;IAC3F,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK;IAO1B,mGAAmG;IACtF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAUtB,IAAI,CAAC,IAAI,SAAS,oBAAoB,CAAC,WAAW,CAAC,EAC9D,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAAE,IAAI,CAAC,EACxC,mBAAmB,EAAE,KAAK,GACzB,OAAO,CAAC,SAAS,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,IAAI,SAAS,oBAAoB,CAAC,WAAW,CAAC,EAC9D,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAAE,IAAI,CAAC,EACxC,mBAAmB,EAAE,IAAI,GACxB,OAAO,CAAC,SAAS,CAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE,CAAC;IAgCpD,OAAO,CAAC,UAAU,CAAS;IAE3B,kCAAkC;IACrB,QAAQ;CAKtB"}

package/dist/core/transaction.d.ts

@@ -0,0 +1,152 @@
+import { AnyResourceId, LocalResourceId, OptionalResourceId, BasicResourceData, FieldData, FieldType, ResourceData, ResourceId, ResourceType, FutureFieldType } from './types';
+import { LLPlTransaction } from './ll_transaction';
+/** Reference to resource, used only within transaction */
+export interface ResourceRef {
+    /** Global resource id of newly created resources, become available only
+     * after response for the corresponding creation request is received. */
+    readonly globalId: Promise<ResourceId>;
+    /** Transaction-local resource id is assigned right after resource creation
+     * request is sent, and can be used right away */
+    readonly localId: LocalResourceId;
+}
+/** Key-Value pair from resource-attached KV storage */
+export interface KeyValue {
+    key: string;
+    value: Uint8Array;
+}
+/** Key-Value pair from resource-attached KV storage */
+export interface KeyValueString {
+    key: string;
+    value: string;
+}
+interface _FieldId<RId> {
+    /** Parent resource id */
+    resourceId: RId;
+    /** Field name */
+    fieldName: string;
+}
+export type FieldId = _FieldId<ResourceId>;
+export type FieldRef = _FieldId<ResourceRef>;
+export type LocalFieldId = _FieldId<LocalResourceId>;
+export type AnyFieldId = FieldId | LocalFieldId;
+export type AnyResourceRef = ResourceRef | ResourceId;
+export type AnyFieldRef = _FieldId<AnyResourceRef>;
+export type AnyRef = AnyResourceRef | AnyFieldRef;
+export declare function isField(ref: AnyRef): ref is AnyFieldRef;
+export declare function isResource(ref: AnyRef): ref is AnyResourceRef;
+export declare function isFieldRef(ref: AnyFieldRef): ref is FieldRef;
+export declare function isResourceRef(ref: AnyResourceRef): ref is ResourceRef;
+export declare function toFieldId(ref: AnyFieldRef): AnyFieldId;
+export declare function toGlobalFieldId(ref: AnyFieldRef): Promise<FieldId>;
+export declare function toResourceId(ref: AnyResourceRef): AnyResourceId;
+export declare function toGlobalResourceId(ref: AnyResourceRef): Promise<ResourceId>;
+export declare function field(resourceId: AnyResourceRef, fieldName: string): AnyFieldRef;
+/** If transaction commit failed due to write conflicts */
+export declare class TxCommitConflict extends Error {
+}
+/**
+ * Each platform transaction has 3 stages:
+ *   - initialization (txOpen message -> txInfo response)
+ *   - communication (create resources, fields, references and so on)
+ *   - finalization (txCommit or txDiscard message)
+ *
+ * This class encapsulates finalization stage and provides ready-to-communication transaction object.
+ * */
+export declare class PlTransaction {
+    private readonly ll;
+    readonly name: string;
+    readonly writable: boolean;
+    private readonly _clientRoot;
+    private readonly globalTxId;
+    private readonly localTxId;
+    private localResourceIdCounter;
+    /** Store logical tx open / closed state to prevent invalid sequence of requests.
+     * True means output stream was completed.
+     * Contract: there must be no async operations between setting this field to true and sending complete signal to stream.*/
+    private _completed;
+    /** Void operation futures are placed into this pool, and corresponding method return immediately.
+     * This is done to save number of round-trips. Next operation producing result will also await those
+     * pending ops, to throw any pending errors. */
+    private pendingVoidOps;
+    constructor(ll: LLPlTransaction, name: string, writable: boolean, _clientRoot: OptionalResourceId);
+    private drainAndAwaitPendingOps;
+    private sendSingleAndParse;
+    private sendMultiAndParse;
+    private sendVoidSync;
+    /** Requests sent with this method should never produce recoverable errors */
+    private sendVoidAsync;
+    private checkTxOpen;
+    get completed(): boolean;
+    /** Commit & closes transaction. {@link TxCommitConflict} is thrown on
+     * commit conflicts. */
+    commit(): Promise<void>;
+    discard(): Promise<void>;
+    get clientRoot(): ResourceId;
+    createSingleton(name: string, type: ResourceType, errorIfExists?: boolean): ResourceRef;
+    getSingleton(name: string, loadFields: true): Promise<ResourceData>;
+    getSingleton(name: string, loadFields: false): Promise<BasicResourceData>;
+    private createResource;
+    createRoot(type: ResourceType): ResourceRef;
+    createStruct(type: ResourceType, data?: Uint8Array | string): ResourceRef;
+    createEphemeral(type: ResourceType, data?: Uint8Array | string): ResourceRef;
+    createValue(type: ResourceType, data: Uint8Array | string, errorIfExists?: boolean): ResourceRef;
+    setResourceName(name: string, rId: AnyResourceRef): void;
+    deleteResourceName(name: string): void;
+    getResourceByName(name: string): Promise<ResourceId>;
+    checkResourceNameExists(name: string): Promise<boolean>;
+    removeResource(rId: ResourceId): void;
+    resourceExists(rId: ResourceId): Promise<boolean>;
+    getResourceData(rId: AnyResourceRef, loadFields: true): Promise<ResourceData>;
+    getResourceData(rId: AnyResourceRef, loadFields: false): Promise<BasicResourceData>;
+    getResourceData(rId: AnyResourceRef, loadFields: boolean): Promise<BasicResourceData | ResourceData>;
+    getResourceDataIfExists(rId: AnyResourceRef, loadFields: true): Promise<ResourceData | undefined>;
+    getResourceDataIfExists(rId: AnyResourceRef, loadFields: false): Promise<BasicResourceData | undefined>;
+    getResourceDataIfExists(rId: AnyResourceRef, loadFields: boolean): Promise<BasicResourceData | ResourceData | undefined>;
+    /**
+     * Inform platform that resource will not get any new input fields.
+     * This is required, when client creates resource without schema and wants
+     * controller to start calculations.
+     * Most controllers will not start calculations even when all inputs
+     * have their values, if inputs list is not locked.
+     */
+    lockInputs(rId: AnyResourceRef): void;
+    /**
+     * Inform platform that resource will not get any new output fields.
+     * This is required for resource to pass deduplication.
+     */
+    lockOutputs(rId: AnyResourceRef): void;
+    lock(rID: AnyResourceRef): void;
+    createField(fId: AnyFieldRef, fieldType: FieldType, value?: AnyRef): void;
+    fieldExists(fId: AnyFieldRef): Promise<boolean>;
+    setField(fId: AnyFieldRef, ref: AnyRef): void;
+    setFieldError(fId: AnyFieldRef, ref: AnyResourceRef): void;
+    getField(fId: AnyFieldRef): Promise<FieldData>;
+    getFieldIfExists(fId: AnyFieldRef): Promise<FieldData | undefined>;
+    resetField(fId: AnyFieldRef): void;
+    removeField(fId: AnyFieldRef): void;
+    listKeyValues(rId: AnyResourceRef): Promise<KeyValue[]>;
+    listKeyValuesString(rId: AnyResourceRef): Promise<KeyValueString[]>;
+    listKeyValuesIfResourceExists(rId: AnyResourceRef): Promise<KeyValue[] | undefined>;
+    listKeyValuesStringIfResourceExists(rId: AnyResourceRef): Promise<KeyValueString[] | undefined>;
+    setKValue(rId: AnyResourceRef, key: string, value: Uint8Array | string): void;
+    deleteKValue(rId: AnyResourceRef, key: string): void;
+    getKValue(rId: AnyResourceRef, key: string): Promise<Uint8Array>;
+    getKValueString(rId: AnyResourceRef, key: string): Promise<string>;
+    getKValueJson<T>(rId: AnyResourceRef, key: string): Promise<T>;
+    getKValueIfExists(rId: AnyResourceRef, key: string): Promise<Uint8Array | undefined>;
+    getKValueStringIfExists(rId: AnyResourceRef, key: string): Promise<string | undefined>;
+    getKValueJsonIfExists<T>(rId: AnyResourceRef, key: string): Promise<T | undefined>;
+    /** Resolves existing or create first level resource from */
+    getFutureFieldValue(rId: AnyRef, fieldName: string, fieldType: FutureFieldType): FieldRef;
+    getGlobalTxId(): Promise<bigint>;
+    /** Closes output event stream */
+    complete(): Promise<void>;
+    /** Await incoming message loop termination and throw
+     * any leftover errors if it was unsuccessful */
+    await(): Promise<void>;
+    private nextLocalResourceId;
+    private static localTxIdCounter;
+    private static nextLocalTxId;
+}
+export {};
+//# sourceMappingURL=transaction.d.ts.map

package/dist/core/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/core/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAGb,eAAe,EAEf,kBAAkB,EAClB,iBAAiB,EACjB,SAAS,EACT,SAAS,EACT,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,eAAe,EAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAEL,eAAe,EAGhB,MAAM,kBAAkB,CAAC;AAQ1B,0DAA0D;AAC1D,MAAM,WAAW,WAAW;IAC1B;4EACwE;IACxE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC;qDACiD;IACjD,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;CACnC;AAED,uDAAuD;AACvD,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,UAAU,CAAC;CACnB;AAED,uDAAuD;AACvD,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,QAAQ,CAAC,GAAG;IACpB,yBAAyB;IACzB,UAAU,EAAE,GAAG,CAAC;IAChB,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC3C,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC7C,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC;AACrD,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,YAAY,CAAC;AAEhD,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,UAAU,CAAC;AACtD,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;AACnD,MAAM,MAAM,MAAM,GAAG,cAAc,GAAG,WAAW,CAAC;AAElD,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,WAAW,CAEvD;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,cAAc,CAI7D;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,QAAQ,CAE5D;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,cAAc,GAAG,GAAG,IAAI,WAAW,CAErE;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,CAGtD;AAED,wBAAsB,eAAe,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAIxE;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,cAAc,GAAG,aAAa,CAG/D;AAED,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAGjF;AAED,wBAAgB,KAAK,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,WAAW,CAEhF;AAED,0DAA0D;AAC1D,qBAAa,gBAAiB,SAAQ,KAAK;CAAG;AAW9C;;;;;;;KAOK;AACL,qBAAa,aAAa;IAiBtB,OAAO,CAAC,QAAQ,CAAC,EAAE;aACH,IAAI,EAAE,MAAM;aACZ,QAAQ,EAAE,OAAO;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAnB9B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkB;IAC7C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyC;IAEnE,OAAO,CAAC,sBAAsB,CAAK;IAEnC;;8HAE0H;IAC1H,OAAO,CAAC,UAAU,CAAS;IAE3B;;mDAE+C;IAC/C,OAAO,CAAC,cAAc,CAAuB;gBAG1B,EAAE,EAAE,eAAe,EACpB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,OAAO,EAChB,WAAW,EAAE,kBAAkB;YAiBpC,uBAAuB;YAUvB,kBAAkB;YAalB,iBAAiB;YAajB,YAAY;IAM1B,6EAA6E;IAC7E,OAAO,CAAC,aAAa;IAMrB,OAAO,CAAC,WAAW;IAInB,IAAW,SAAS,YAEnB;IAED;2BACuB;IACV,MAAM;IAkCN,OAAO;IAuBpB,IAAW,UAAU,IAAI,UAAU,CAElC;IAMM,eAAe,CACpB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,EAClB,aAAa,GAAE,OAAe,GAC7B,WAAW;IAmBD,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IACnE,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAiBtF,OAAO,CAAC,cAAc;IAYf,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,WAAW;IAQ3C,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,WAAW;IAezE,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,WAAW;IAe5E,WAAW,CAChB,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,UAAU,GAAG,MAAM,EACzB,aAAa,GAAE,OAAe,GAC7B,WAAW;IAgBP,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAOxD,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIhC,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAOpD,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI;IAI/B,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAOjD,eAAe,CAAC,GAAG,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAC7E,eAAe,CAAC,GAAG,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,GAAG,OAAO,CAAC,iBAAiB,CAAC;IACnF,eAAe,CAC1B,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE,OAAO,GAClB,OAAO,CAAC,iBAAiB,GAAG,YAAY,CAAC;IAc/B,uBAAuB,CAClC,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE,IAAI,GACf,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IACvB,uBAAuB,CAClC,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE,KAAK,GAChB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAC5B,uBAAuB,CAClC,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE,OAAO,GAClB,OAAO,CAAC,iBAAiB,GAAG,YAAY,GAAG,SAAS,CAAC;IAQxD;;;;;;OAMG;IACI,UAAU,CAAC,GAAG,EAAE,cAAc,GAAG,IAAI;IAO5C;;;OAGG;IACI,WAAW,CAAC,GAAG,EAAE,cAAc,GAAG,IAAI;IAOtC,IAAI,CAAC,GAAG,EAAE,cAAc,GAAG,IAAI;IAS/B,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAQnE,WAAW,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAUrD,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAsB7C,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAOpD,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IAO9C,gBAAgB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAIxE,UAAU,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAIlC,WAAW,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAQ7B,aAAa,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUvD,mBAAmB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAOnE,6BAA6B,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC;IAInF,mCAAmC,CAC9C,GAAG,EAAE,cAAc,GAClB,OAAO,CAAC,cAAc,EAAE,GAAG,SAAS,CAAC;IAIjC,SAAS,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI;IAW7E,YAAY,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAU9C,SAAS,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAUhE,eAAe,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlE,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI9D,iBAAiB,CAC5B,GAAG,EAAE,cAAc,EACnB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAWrB,uBAAuB,CAClC,GAAG,EAAE,cAAc,EACnB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAKjB,qBAAqB,CAAC,CAAC,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAe/F,4DAA4D;IACrD,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,GAAG,QAAQ;IAWnF,aAAa;IAI1B,iCAAiC;IACpB,QAAQ;IAQrB;oDACgD;IACnC,KAAK;IAQlB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAK;IAEpC,OAAO,CAAC,MAAM,CAAC,aAAa;CAK7B"}

package/dist/core/type_conversion.d.ts

@@ -0,0 +1,8 @@
+import { Field, Resource } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api_types';
+import { FieldType as GrpcFieldType } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/base_types';
+import { FieldData, FieldType, ResourceData } from './types';
+/** Throws "native" pl not found error, if resource is marked as deleted. */
+export declare function protoToResource(proto: Resource): ResourceData;
+export declare function protoToField(proto: Field): FieldData;
+export declare function fieldTypeToProto(type: FieldType): GrpcFieldType;
+//# sourceMappingURL=type_conversion.d.ts.map

package/dist/core/type_conversion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type_conversion.d.ts","sourceRoot":"","sources":["../../src/core/type_conversion.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EAEL,QAAQ,EAET,MAAM,gEAAgE,CAAC;AACxE,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,iEAAiE,CAAC;AAC7G,OAAO,EACL,SAAS,EAIT,SAAS,EACT,YAAY,EAGb,MAAM,SAAS,CAAC;AAUjB,4EAA4E;AAC5E,wBAAgB,eAAe,CAAC,KAAK,EAAE,QAAQ,GAAG,YAAY,CAe7D;AAkBD,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,CASpD;AAkCD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,aAAa,CAiB/D"}

package/dist/core/types.d.ts

@@ -0,0 +1,77 @@
+declare const __resource_id_type__: unique symbol;
+type BrandResourceId<B> = bigint & {
+    [__resource_id_type__]: B;
+};
+/** Global resource id */
+export type ResourceId = BrandResourceId<'global'>;
+/** Null resource id */
+export type NullResourceId = BrandResourceId<'null'>;
+/** Local resource id */
+export type LocalResourceId = BrandResourceId<'local'>;
+/** Any non-null resource id */
+export type AnyResourceId = ResourceId | LocalResourceId;
+/** Any resource id */
+export type OptionalResourceId = NullResourceId | ResourceId;
+/** All possible resource flavours */
+export type OptionalAnyResourceId = NullResourceId | ResourceId | LocalResourceId;
+export declare const NullResourceId: NullResourceId;
+export declare function isNullResourceId(resourceId: bigint): resourceId is NullResourceId;
+export declare function isNotNullResourceId(resourceId: OptionalResourceId): resourceId is ResourceId;
+export declare function ensureResourceIdNotNull(resourceId: OptionalResourceId): ResourceId;
+export declare function isAnyResourceId(resourceId: bigint): resourceId is AnyResourceId;
+export type ResourceKind = 'Structural' | 'Value';
+export type FieldType = 'Input' | 'Output' | 'Service' | 'OTW' | 'Dynamic' | 'MTW';
+export type FutureFieldType = 'Output' | 'Input' | 'Service';
+export type FieldStatus = 'Empty' | 'Assigned' | 'Resolved';
+export interface ResourceType {
+    readonly name: string;
+    readonly version: string;
+}
+export declare function resourceType(name: string, version: string): ResourceType;
+export declare function resourceTypeToString(rt: ResourceType): string;
+export declare function resourceTypesEqual(type1: ResourceType, type2: ResourceType): boolean;
+/** Readonly fields here marks properties of resource that can't change according to pl's state machine. */
+export interface BasicResourceData {
+    readonly id: ResourceId;
+    readonly originalResourceId: OptionalResourceId;
+    readonly kind: ResourceKind;
+    readonly type: ResourceType;
+    readonly data?: Uint8Array;
+    readonly error: OptionalResourceId;
+    readonly inputsLocked: boolean;
+    readonly outputsLocked: boolean;
+    readonly resourceReady: boolean;
+    /** This value is derived from resource state by the server and can be used as
+     * a robust criteria to determine resource is in final state. */
+    readonly final: boolean;
+}
+export declare const jsonToData: (data: unknown) => Buffer;
+export declare const resDataToJson: (res: ResourceData) => any;
+export interface ResourceData extends BasicResourceData {
+    fields: FieldData[];
+}
+export declare function getField(r: ResourceData, name: string): FieldData;
+export interface FieldData {
+    name: string;
+    type: FieldType;
+    status: FieldStatus;
+    value: OptionalResourceId;
+    error: OptionalResourceId;
+    /** True if value the fields points to is in final state. */
+    valueIsFinal: boolean;
+}
+export declare const MaxLocalId = 16777215;
+export declare const MaxTxId = 4294967295;
+export declare function isRootResourceId(id: bigint): boolean;
+export declare function isLocalResourceId(id: bigint): id is LocalResourceId;
+export declare function createLocalResourceId(isRoot: boolean, localCounterValue: number, localTxId: number): LocalResourceId;
+export declare function createGlobalResourceId(isRoot: boolean, unmaskedId: bigint): ResourceId;
+export declare function extractTxId(localResourceId: LocalResourceId): number;
+export declare function checkLocalityOfResourceId(resourceId: AnyResourceId, expectedTxId: number): void;
+export declare function resourceIdToString(resourceId: OptionalAnyResourceId): string;
+export declare function resourceIdFromString(str: string): OptionalAnyResourceId | undefined;
+/** Converts bigint to global resource id */
+export declare function bigintToResourceId(resourceId: bigint): ResourceId;
+export declare function stringifyWithResourceId(object: unknown | undefined): string;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/core/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,oBAAoB,EAAE,OAAO,MAAM,CAAC;AAClD,KAAK,eAAe,CAAC,CAAC,IAAI,MAAM,GAAG;IAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC;AAEjE,yBAAyB;AACzB,MAAM,MAAM,UAAU,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;AAEnD,uBAAuB;AACvB,MAAM,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAErD,wBAAwB;AACxB,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;AAEvD,+BAA+B;AAC/B,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,eAAe,CAAC;AAEzD,sBAAsB;AACtB,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,UAAU,CAAC;AAE7D,qCAAqC;AACrC,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG,UAAU,GAAG,eAAe,CAAC;AAElF,eAAO,MAAM,cAAc,EAAS,cAAc,CAAC;AAEnD,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,IAAI,cAAc,CAEjF;AAED,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,kBAAkB,GAAG,UAAU,IAAI,UAAU,CAE5F;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,GAAG,UAAU,CAGlF;AAED,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,IAAI,aAAa,CAE/E;AAID,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,OAAO,CAAC;AAElD,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC;AAEnF,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE7D,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;AAE5D,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAExE;AAED,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM,CAE7D;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAEpF;AAED,2GAA2G;AAC3G,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAEhD,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAE5B,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;IAE3B,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IAEnC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAEhC;oEACgE;IAChE,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED,eAAO,MAAM,UAAU,SAAU,OAAO,WAAsC,CAAC;AAE/E,eAAO,MAAM,aAAa,QAAS,YAAY,QAA8C,CAAC;AAE9F,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAEjE;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,WAAW,CAAC;IACpB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,KAAK,EAAE,kBAAkB,CAAC;IAE1B,4DAA4D;IAC5D,YAAY,EAAE,OAAO,CAAC;CACvB;AAcD,eAAO,MAAM,UAAU,WAAW,CAAC;AACnC,eAAO,MAAM,OAAO,aAAa,CAAC;AAQlC,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,WAE1C;AAED,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,EAAE,IAAI,eAAe,CAEnE;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,OAAO,EACf,iBAAiB,EAAE,MAAM,EACzB,SAAS,EAAE,MAAM,GAChB,eAAe,CAYjB;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,UAAU,CAEtF;AAED,wBAAgB,WAAW,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAEpE;AAED,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAM/F;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,qBAAqB,GAAG,MAAM,CAiB5E;AAKD,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAQnF;AAED,4CAA4C;AAC5C,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAKjE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAI3E"}