@milaboratories/pl-client 2.4.10 → 2.4.12

package/dist/core/unauth_client.d.ts

@@ -0,0 +1,13 @@
+import { AuthInformation, PlClientConfig } from './config';
+import { AuthAPI_ListMethods_Response, MaintenanceAPI_Ping_Response } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';
+import { LLPlClient } from './ll_client';
+/** Primarily used for initial authentication (login) */
+export declare class UnauthenticatedPlClient {
+    readonly ll: LLPlClient;
+    constructor(configOrAddress: PlClientConfig | string);
+    ping(): Promise<MaintenanceAPI_Ping_Response>;
+    authMethods(): Promise<AuthAPI_ListMethods_Response>;
+    requireAuth(): Promise<boolean>;
+    login(user: string, password: string): Promise<AuthInformation>;
+}
+//# sourceMappingURL=unauth_client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"unauth_client.d.ts","sourceRoot":"","sources":["../../src/core/unauth_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC3D,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC7B,MAAM,0DAA0D,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,wDAAwD;AACxD,qBAAa,uBAAuB;IAClC,SAAgB,EAAE,EAAE,UAAU,CAAC;gBAEnB,eAAe,EAAE,cAAc,GAAG,MAAM;IAIvC,IAAI,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAI7C,WAAW,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAIpD,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/B,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;CAkB7E"}

package/dist/helpers/pl.d.ts

@@ -0,0 +1,34 @@
+import { FutureFieldType, ResourceType } from '../core/types';
+import { AnyRef, FieldRef, PlTransaction, ResourceRef } from '../core/transaction';
+export declare const ClientRoot: ResourceType;
+export declare const StructTestResource: ResourceType;
+export declare const ValueTestResource: ResourceType;
+export declare const JsonString: ResourceType;
+export declare const JsonBool: ResourceType;
+export declare const JsonObject: ResourceType;
+export declare const JsonArray: ResourceType;
+export declare const JsonNumber: ResourceType;
+export declare const JsonNull: ResourceType;
+export declare const EphStdMap: ResourceType;
+export declare const StdMap: ResourceType;
+export declare function createPlNull(tx: PlTransaction): ResourceRef;
+export declare function createPlBool(tx: PlTransaction, val: boolean): ResourceRef;
+export declare function createPlNumber(tx: PlTransaction, val: number): ResourceRef;
+export declare function createPlString(tx: PlTransaction, val: string): ResourceRef;
+export declare function createPlArray(tx: PlTransaction, val: any[]): ResourceRef;
+export declare function createPlObject(tx: PlTransaction, val: object): ResourceRef;
+export type PlRecordEntry<Key extends string = string, Ref extends AnyRef = AnyRef> = [Key, Ref];
+export type PlRecord<Key extends string = string, Ref extends AnyRef = AnyRef> = Record<Key, Ref>;
+export declare function plEntry<Key extends string = string, Ref extends AnyRef = AnyRef>(key: Key, ref: Ref): PlRecordEntry<Key, Ref>;
+export declare function plEntries<Key extends string = string, Ref extends AnyRef = AnyRef>(record: PlRecord<Key, Ref>, fields?: Key[]): PlRecordEntry<Key, Ref>[];
+/** Helper method to build standard pl map from a set of entries */
+export declare function createPlMap(tx: PlTransaction, entries: PlRecordEntry[] | PlRecord, ephemeral: boolean, type?: ResourceType): ResourceRef;
+export declare function futureRecord<Key extends string>(tx: PlTransaction, rId: AnyRef, keys: Key[], fieldType: FutureFieldType, prefix?: string): PlRecord<Key, FieldRef>;
+/** Name of the field in block holder, that references the actual block-pack. */
+export declare const Holder: ResourceType;
+export declare const EphHolder: ResourceType;
+export declare const HolderRefField = "ref";
+export declare function wrapInHolder(tx: PlTransaction, ref: AnyRef): ResourceRef;
+export declare function wrapInEphHolder(tx: PlTransaction, ref: AnyRef): ResourceRef;
+export declare function unwrapHolder(tx: PlTransaction, ref: AnyRef): FieldRef;
+//# sourceMappingURL=pl.d.ts.map

package/dist/helpers/pl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pl.d.ts","sourceRoot":"","sources":["../../src/helpers/pl.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAS,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAM1F,eAAO,MAAM,UAAU,cAAwB,CAAC;AAEhD,eAAO,MAAM,kBAAkB,cAAwB,CAAC;AACxD,eAAO,MAAM,iBAAiB,cAAuB,CAAC;AAEtD,eAAO,MAAM,UAAU,cAAyB,CAAC;AACjD,eAAO,MAAM,QAAQ,cAAuB,CAAC;AAC7C,eAAO,MAAM,UAAU,cAAyB,CAAC;AACjD,eAAO,MAAM,SAAS,cAAwB,CAAC;AAC/C,eAAO,MAAM,UAAU,cAAyB,CAAC;AACjD,eAAO,MAAM,QAAQ,cAAuB,CAAC;AAE7C,eAAO,MAAM,SAAS,EAAE,YAAmC,CAAC;AAC5D,eAAO,MAAM,MAAM,EAAE,YAAgC,CAAC;AAMtD,wBAAgB,YAAY,CAAC,EAAE,EAAE,aAAa,GAAG,WAAW,CAE3D;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,OAAO,GAAG,WAAW,CAEzE;AAED,wBAAgB,cAAc,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAE1E;AAED,wBAAgB,cAAc,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAE1E;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,WAAW,CAExE;AAED,wBAAgB,cAAc,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAE1E;AAMD,MAAM,MAAM,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAEjG,MAAM,MAAM,QAAQ,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAElG,wBAAgB,OAAO,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,MAAM,GAAG,MAAM,EAC9E,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,GAAG,GACP,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAEzB;AAED,wBAAgB,SAAS,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,MAAM,GAAG,MAAM,EAChF,MAAM,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,EAC1B,MAAM,CAAC,EAAE,GAAG,EAAE,GACb,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAI3B;AAED,mEAAmE;AACnE,wBAAgB,WAAW,CACzB,EAAE,EAAE,aAAa,EACjB,OAAO,EAAE,aAAa,EAAE,GAAG,QAAQ,EACnC,SAAS,EAAE,OAAO,EAClB,IAAI,CAAC,EAAE,YAAY,GAClB,WAAW,CAUb;AAED,wBAAgB,YAAY,CAAC,GAAG,SAAS,MAAM,EAC7C,EAAE,EAAE,aAAa,EACjB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,GAAG,EAAE,EACX,SAAS,EAAE,eAAe,EAC1B,MAAM,GAAE,MAAW,GAClB,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAIzB;AAMD,gFAAgF;AAChF,eAAO,MAAM,MAAM,cAAS,CAAC;AAC7B,eAAO,MAAM,SAAS,cAAY,CAAC;AACnC,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC,wBAAgB,YAAY,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAMxE;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAM3E;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,CAErE"}

package/dist/helpers/poll.d.ts

@@ -0,0 +1,39 @@
+import { PlClient } from '../core/client';
+import { RetryOptions } from '@milaboratories/ts-helpers';
+import { FieldData, FieldType, ResourceData, ResourceId } from '../core/types';
+import { PlTransaction } from '../core/transaction';
+/** This error tells state assertion mechanism that required state is not yet ready */
+export declare class ContinuePolling extends Error {
+}
+export type PollFieldTraverseOps = {
+    expectedType?: FieldType;
+    /** Fail if error present along with the value, if value not present,
+     * but error do, exception will be thrown anyway. */
+    failOnError: boolean;
+    /** Traverse only if field report its value as final. */
+    onlyFinal: boolean;
+};
+export declare class PollResourceAccessor {
+    readonly tx: PollTxAccessor;
+    readonly data: ResourceData;
+    readonly path: string[];
+    constructor(tx: PollTxAccessor, data: ResourceData, path: string[]);
+    final(): PollResourceAccessor;
+    requireNoError(): Promise<PollResourceAccessor>;
+    getFieldData(name: string, expectedType?: FieldType): FieldData;
+    get(name: string, ops?: Partial<PollFieldTraverseOps>): Promise<PollResourceAccessor>;
+    getMulti(ops: Partial<PollFieldTraverseOps>, ...names: string[]): Promise<PollResourceAccessor[]>;
+    getMultiObj<Key extends string>(ops: Partial<PollFieldTraverseOps>, ...names: Key[]): Promise<Record<Key, PollResourceAccessor>>;
+    getAllFinal(ops?: Partial<PollFieldTraverseOps>): Promise<Record<string, PollResourceAccessor>>;
+    getKValue(key: string): Promise<string>;
+    getKValueObj<T>(key: string): Promise<T>;
+}
+export declare class PollTxAccessor {
+    readonly tx: PlTransaction;
+    constructor(tx: PlTransaction);
+    get(rid: ResourceId, failOnError?: boolean, path?: string[]): Promise<PollResourceAccessor>;
+    throwError(error: ResourceId, path?: string[]): Promise<never>;
+}
+export declare const DefaultPollingRetryOptions: RetryOptions;
+export declare function poll<T>(cl: PlClient, cb: (tx: PollTxAccessor) => Promise<T>, retryOptions?: RetryOptions, txName?: string): Promise<T>;
+//# sourceMappingURL=poll.d.ts.map

package/dist/helpers/poll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poll.d.ts","sourceRoot":"","sources":["../../src/helpers/poll.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAIL,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,SAAS,EACT,SAAS,EAGT,YAAY,EACZ,UAAU,EAEX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,sFAAsF;AACtF,qBAAa,eAAgB,SAAQ,KAAK;CAAG;AAE7C,MAAM,MAAM,oBAAoB,GAAG;IACjC,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;wDACoD;IACpD,WAAW,EAAE,OAAO,CAAC;IACrB,wDAAwD;IACxD,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAOF,qBAAa,oBAAoB;aAEb,EAAE,EAAE,cAAc;aAClB,IAAI,EAAE,YAAY;aAClB,IAAI,EAAE,MAAM,EAAE;gBAFd,EAAE,EAAE,cAAc,EAClB,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EAAE;IAGzB,KAAK,IAAI,oBAAoB;IAKvB,cAAc,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAOrD,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,SAAS,GAAG,SAAS;IAoBzD,GAAG,CACd,IAAI,EAAE,MAAM,EACZ,GAAG,GAAE,OAAO,CAAC,oBAAoB,CAAM,GACtC,OAAO,CAAC,oBAAoB,CAAC;IAanB,QAAQ,CACnB,GAAG,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAClC,GAAG,KAAK,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAIrB,WAAW,CAAC,GAAG,SAAS,MAAM,EACzC,GAAG,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAClC,GAAG,KAAK,EAAE,GAAG,EAAE,GACd,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAMhC,WAAW,CACtB,GAAG,GAAE,OAAO,CAAC,oBAAoB,CAAM,GACtC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IASnC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAMvC,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;CAGtD;AAED,qBAAa,cAAc;aACG,EAAE,EAAE,aAAa;gBAAjB,EAAE,EAAE,aAAa;IAEhC,GAAG,CACd,GAAG,EAAE,UAAU,EACf,WAAW,GAAE,OAAc,EAC3B,IAAI,GAAE,MAAM,EAAO,GAClB,OAAO,CAAC,oBAAoB,CAAC;IAO1B,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,KAAK,CAAC;CAKzE;AAED,eAAO,MAAM,0BAA0B,EAAE,YAMxC,CAAC;AAEF,wBAAsB,IAAI,CAAC,CAAC,EAC1B,EAAE,EAAE,QAAQ,EACZ,EAAE,EAAE,CAAC,EAAE,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,EACtC,YAAY,GAAE,YAAyC,EACvD,MAAM,GAAE,MAAkB,GACzB,OAAO,CAAC,CAAC,CAAC,CAcZ"}

package/dist/helpers/rich_resource_types.d.ts

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

package/dist/helpers/rich_resource_types.d.ts.map

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

package/dist/helpers/smart_accessors.d.ts

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

package/dist/helpers/smart_accessors.d.ts.map

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

package/dist/helpers/state_helpers.d.ts

@@ -0,0 +1,3 @@
+import { FieldData } from '../core/types';
+export declare function fieldResolved(data: Pick<FieldData, 'value' | 'error'>): boolean;
+//# sourceMappingURL=state_helpers.d.ts.map

package/dist/helpers/state_helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state_helpers.d.ts","sourceRoot":"","sources":["../../src/helpers/state_helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAuB,MAAM,eAAe,CAAC;AAE/D,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,WAErE"}

package/dist/helpers/tx_helpers.d.ts

@@ -0,0 +1,9 @@
+import { PlTransaction } from '../core/transaction';
+import { FieldData, OptionalResourceId } from '../core/types';
+export interface ValErr {
+    valueId: OptionalResourceId;
+    errorId: OptionalResourceId;
+    error?: string;
+}
+export declare function valErr(tx: PlTransaction, f: FieldData): Promise<ValErr>;
+//# sourceMappingURL=tx_helpers.d.ts.map

package/dist/helpers/tx_helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx_helpers.d.ts","sourceRoot":"","sources":["../../src/helpers/tx_helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAuB,MAAM,eAAe,CAAC;AAGnF,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,OAAO,EAAE,kBAAkB,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAsB,MAAM,CAAC,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAa7E"}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export * from './core/types';
+export * as Pl from './helpers/pl';
+export * from './core/config';
+export * from './core/client';
+export * from './core/driver';
+export * from './core/transaction';
+export * from './core/errors';
+export * from './core/default_client';
+export * from './core/unauth_client';
+export * from './core/auth';
+export * from './helpers/tx_helpers';
+export * from './helpers/poll';
+export * as TestHelpers from './test/test_config';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,cAAc,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAE/B,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAC"}