@finos/legend-cube-builder 0.0.3 → 0.0.5

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeConnectionExplorer.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { V1_EngineServerClient } from '@finos/legend-graph';
+import type { TracerService } from '@finos/legend-shared';
+import type { CubeConnectionDescription, CubeConnectionDraft, CubeConnectionExplorer, CubeDirectConnection, CubeExploredTable } from '../../../CubeConnectionExplorer.js';
+import type { CubeEngineClientSettings } from '../../../CubeEngineClientSettings.js';
+import type { V1_CubeEngineConfig } from './V1_LegendCubeEngine.js';
+/**
+ * The Legend implementation of the connection explorer (PLAN §6.8): the
+ * engine's schema exploration, with its own client. Connections are checked
+ * first, so one Cube can't use never reaches the engine
+ */
+export declare class V1_LegendCubeConnectionExplorer implements CubeConnectionExplorer {
+    readonly client: V1_EngineServerClient;
+    constructor(config: V1_CubeEngineConfig, tracerService: TracerService, clientSettings?: CubeEngineClientSettings);
+    buildConnection(draft: CubeConnectionDraft): CubeDirectConnection;
+    describeConnection(connection: CubeDirectConnection): CubeConnectionDescription;
+    listSchemas(connection: CubeDirectConnection): Promise<readonly string[]>;
+    listTables(connection: CubeDirectConnection, schema: string): Promise<readonly CubeExploredTable[]>;
+    private explore;
+}
+//# sourceMappingURL=V1_LegendCubeConnectionExplorer.d.ts.map

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeConnectionExplorer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"V1_LegendCubeConnectionExplorer.d.ts","sourceRoot":"","sources":["../../../../../src/graph-manager/protocol/pure/v1/V1_LegendCubeConnectionExplorer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAe,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACvE,OAAO,KAAK,EACV,yBAAyB,EACzB,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EAEpB,iBAAiB,EAClB,MAAM,oCAAoC,CAAC;AAc5C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AACrF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAKpE;;;;GAIG;AACH,qBAAa,+BAAgC,YAAW,sBAAsB;IAC5E,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;gBAGrC,MAAM,EAAE,mBAAmB,EAC3B,aAAa,EAAE,aAAa,EAC5B,cAAc,CAAC,EAAE,wBAAwB;IAO3C,eAAe,CAAC,KAAK,EAAE,mBAAmB,GAAG,oBAAoB;IAIjE,kBAAkB,CAChB,UAAU,EAAE,oBAAoB,GAC/B,yBAAyB;IAUtB,WAAW,CACf,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAAC,SAAS,MAAM,EAAE,CAAC;IAMvB,UAAU,CACd,UAAU,EAAE,oBAAoB,EAChC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,SAAS,iBAAiB,EAAE,CAAC;YAO1B,OAAO;CAwBtB"}

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeConnectionExplorer.js

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { V1_EngineServerClient } from '@finos/legend-graph';
+import { CubeEngineError, CubeEngineErrorKind } from '../../../CubeEngine.js';
+import { V1_buildCubeDirectConnection, V1_checkCubeDirectConnection, V1_summarizeCubeDirectConnection, } from './V1_CubeDirectConnection.js';
+import { V1_buildCubeSchemaExplorationInput, V1_readExploredSchemaNames, V1_readExploredTables, V1_toCubeExplorationError, } from './V1_CubeSchemaExploration.js';
+/** Where the engine puts the Database it reads for the picker: never saved */
+const EXPLORED_DATABASE = { package: 'cube::explored', name: 'Database' };
+/**
+ * The Legend implementation of the connection explorer (PLAN §6.8): the
+ * engine's schema exploration, with its own client. Connections are checked
+ * first, so one Cube can't use never reaches the engine
+ */
+export class V1_LegendCubeConnectionExplorer {
+    client;
+    constructor(config, tracerService, clientSettings) {
+        this.client = new V1_EngineServerClient(config);
+        this.client.setTracerService(tracerService);
+        clientSettings?.register(this.client);
+    }
+    buildConnection(draft) {
+        return V1_buildCubeDirectConnection(draft);
+    }
+    describeConnection(connection) {
+        const problems = V1_checkCubeDirectConnection(connection);
+        return problems.length
+            ? { supported: false, problems }
+            : {
+                supported: true,
+                summary: V1_summarizeCubeDirectConnection(connection),
+            };
+    }
+    async listSchemas(connection) {
+        return V1_readExploredSchemaNames(await this.explore(connection, { kind: 'schemas' }));
+    }
+    async listTables(connection, schema) {
+        return V1_readExploredTables(await this.explore(connection, { kind: 'tables', schema }), schema);
+    }
+    async explore(connection, scope) {
+        const problems = V1_checkCubeDirectConnection(connection);
+        if (problems.length) {
+            throw new CubeEngineError(CubeEngineErrorKind.COMPILE, problems.join('\n'));
+        }
+        try {
+            return await this.client.buildDatabase(V1_buildCubeSchemaExplorationInput(connection, connection.databaseType, EXPLORED_DATABASE, scope));
+        }
+        catch (error) {
+            throw V1_toCubeExplorationError(error, CubeEngineErrorKind.COMPILE);
+        }
+    }
+}
+//# sourceMappingURL=V1_LegendCubeConnectionExplorer.js.map

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeConnectionExplorer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"V1_LegendCubeConnectionExplorer.js","sourceRoot":"","sources":["../../../../../src/graph-manager/protocol/pure/v1/V1_LegendCubeConnectionExplorer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAU5D,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,gCAAgC,GACjC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,kCAAkC,EAClC,0BAA0B,EAC1B,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,+BAA+B,CAAC;AAIvC,8EAA8E;AAC9E,MAAM,iBAAiB,GAAG,EAAE,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAE1E;;;;GAIG;AACH,MAAM,OAAO,+BAA+B;IACjC,MAAM,CAAwB;IAEvC,YACE,MAA2B,EAC3B,aAA4B,EAC5B,cAAyC;QAEzC,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC5C,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,eAAe,CAAC,KAA0B;QACxC,OAAO,4BAA4B,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,kBAAkB,CAChB,UAAgC;QAEhC,MAAM,QAAQ,GAAG,4BAA4B,CAAC,UAAU,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC,MAAM;YACpB,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;YAChC,CAAC,CAAC;gBACE,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,gCAAgC,CAAC,UAAU,CAAC;aACtD,CAAC;IACR,CAAC;IAED,KAAK,CAAC,WAAW,CACf,UAAgC;QAEhC,OAAO,0BAA0B,CAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CACpD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CACd,UAAgC,EAChC,MAAc;QAEd,OAAO,qBAAqB,CAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAC1D,MAAM,CACP,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,UAAgC,EAChC,KAA8B;QAE9B,MAAM,QAAQ,GAAG,4BAA4B,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,eAAe,CACvB,mBAAmB,CAAC,OAAO,EAC3B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CACpB,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CACpC,kCAAkC,CAChC,UAAU,EACV,UAAU,CAAC,YAAsC,EACjD,iBAAiB,EACjB,KAAK,CACN,CACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,yBAAyB,CAAC,KAAK,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;CACF"}

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeDataProductCatalog.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { Schema } from '@finos/legend-cube';
+import { type DepotServerClient } from '@finos/legend-server-depot';
+import type { LakehouseContractServerClient } from '@finos/legend-server-lakehouse';
+import { type MarketplaceServerClient } from '@finos/legend-server-marketplace';
+import { type CubeDataProductProject, CubeDataProductEnvironmentType } from '../../../CubeDataProduct.js';
+import { CubeAccessPointGroupAccess, type CubeAccessPointLocation, type CubeDataProductCatalog, type CubeMarketplaceLinkTarget, CubeDataProductCandidate, type CubeDataProductDescription } from '../../../CubeDataProductCatalog.js';
+import { CubeEngineError, type NodeId } from '../../../CubeEngine.js';
+import { type V1_CubeEnterpriseStereotype } from './V1_CubeDataProductArtifact.js';
+export declare const V1_CUBE_DATA_PRODUCT_LIST_ERROR: {
+    readonly UNREADABLE_PAGE: "The lakehouse's answer isn't a page of data products";
+    readonly NO_CURSOR: "The lakehouse said more data products follow, but not where the next page starts";
+    readonly REPEATED_CURSOR: "The lakehouse sent the same page of data products twice";
+    readonly TOO_MANY_PAGES: "The lakehouse's data product list runs past 50 pages";
+};
+export declare const V1_CUBE_DATA_PRODUCT_SEARCH_ERROR: {
+    readonly UNREADABLE_PAGE: "The marketplace's answer isn't a page of search results";
+};
+/** What a host can add to the catalog: each part turns on what it serves */
+export interface V1_CubeDataProductCatalogOptions {
+    /** The marketplace's search API; with it, searches run there */
+    readonly marketplaceServerClient?: MarketplaceServerClient | undefined;
+    /** Builds a product's marketplace page, as the host's marketplace names it */
+    readonly marketplaceLink?: ((target: CubeMarketplaceLinkTarget) => string | undefined) | undefined;
+    /** The viewer, whose contracts give their access to each group */
+    readonly getCurrentUser?: (() => string) | undefined;
+    /** The stereotype the host's marketplace marks groups open to everyone with */
+    readonly enterpriseStereotype?: V1_CubeEnterpriseStereotype | undefined;
+}
+export declare class V1_LegendCubeDataProductCatalog implements CubeDataProductCatalog {
+    readonly environmentTypes: CubeDataProductEnvironmentType[];
+    private readonly contractServerClient;
+    private readonly depotServerClient;
+    private readonly getAccessToken;
+    private readonly options;
+    /** Each class's list, read once per page visit */
+    private readonly lists;
+    /** Each product's description, by its project, version and path */
+    private readonly descriptions;
+    /** The search answers whose page leaves out matches */
+    private readonly cutShortAnswers;
+    constructor(contractServerClient: LakehouseContractServerClient, depotServerClient: DepotServerClient, getAccessToken: () => string | undefined, options?: V1_CubeDataProductCatalogOptions);
+    get searchesOnServer(): boolean;
+    get searchLimit(): number | undefined;
+    isCutShort(answer: readonly CubeDataProductCandidate[]): boolean;
+    /**
+     * The class's lite rows, page by page along the lakehouse's cursor. Stops
+     * with an error on a page that isn't one, on a missing or repeated cursor,
+     * or past the page cap, and between pages once the search is dropped.
+     */
+    private readLiteRows;
+    /**
+     * The class's list, read once per page visit. A list whose search is
+     * dropped while it pages is forgotten at once, so the next search reads it
+     * again rather than waiting on the stopped one.
+     */
+    private listOf;
+    /** The class's list, along its pages; a stopped one fails with why it was stopped */
+    private readList;
+    /**
+     * The products the marketplace matches, in its order: the first page of a
+     * full text search in the class. A failed search fails; it never falls
+     * back to the lakehouse's list
+     */
+    private searchMarketplace;
+    search(search: {
+        text: string;
+        environmentType: CubeDataProductEnvironmentType;
+    }, signal?: AbortSignal): Promise<readonly CubeDataProductCandidate[]>;
+    /** The product's deployed artifact: the generation file at its path */
+    private readArtifact;
+    /** The product's definition at the deployed version */
+    private readDefinition;
+    describe(candidate: CubeDataProductCandidate): Promise<CubeDataProductDescription>;
+    resolveSchemas(project: CubeDataProductProject, sources: ReadonlyMap<NodeId, CubeAccessPointLocation>, options?: {
+        readonly fresh?: boolean | undefined;
+    }): Promise<Map<NodeId, Schema | CubeEngineError>>;
+    /** The product's page in the host's marketplace, as the host builds it; none without one */
+    getMarketplaceLink(target: CubeMarketplaceLinkTarget): string | undefined;
+    /**
+     * The viewer's access to each of the product's groups, as the marketplace
+     * shows it, from the viewer's contracts, read afresh each time: a group
+     * marked open to everyone needs none; otherwise the contract for that
+     * group of this deployment furthest along approval. A group with no
+     * contract has no access only when the host marks open groups, since it
+     * might be one otherwise
+     */
+    getAccess(candidate: CubeDataProductCandidate, signal?: AbortSignal): Promise<ReadonlyMap<string, CubeAccessPointGroupAccess>>;
+}
+//# sourceMappingURL=V1_LegendCubeDataProductCatalog.d.ts.map

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeDataProductCatalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"V1_LegendCubeDataProductCatalog.d.ts","sourceRoot":"","sources":["../../../../../src/graph-manager/protocol/pure/v1/V1_LegendCubeDataProductCatalog.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAWjD,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AACpF,OAAO,EACL,KAAK,uBAAuB,EAK7B,MAAM,kCAAkC,CAAC;AAI1C,OAAO,EACL,KAAK,sBAAsB,EAC3B,8BAA8B,EAC/B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,0BAA0B,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,wBAAwB,EACxB,KAAK,0BAA0B,EAChC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,eAAe,EAEf,KAAK,MAAM,EACZ,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,KAAK,2BAA2B,EAGjC,MAAM,iCAAiC,CAAC;AA2BzC,eAAO,MAAM,+BAA+B;;;;;CAMlC,CAAC;AAEX,eAAO,MAAM,iCAAiC;;CAEpC,CAAC;AAyKX,4EAA4E;AAC5E,MAAM,WAAW,gCAAgC;IAC/C,gEAAgE;IAChE,QAAQ,CAAC,uBAAuB,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IACvE,8EAA8E;IAC9E,QAAQ,CAAC,eAAe,CAAC,EACrB,CAAC,CAAC,MAAM,EAAE,yBAAyB,KAAK,MAAM,GAAG,SAAS,CAAC,GAC3D,SAAS,CAAC;IACd,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS,CAAC;IACrD,+EAA+E;IAC/E,QAAQ,CAAC,oBAAoB,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;CACzE;AAED,qBAAa,+BAAgC,YAAW,sBAAsB;IAC5E,QAAQ,CAAC,gBAAgB,mCAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAgC;IACrE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IACtD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA2B;IAC1D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmC;IAC3D,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAGlB;IACJ,mEAAmE;IACnE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAGzB;IACJ,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAE5B;gBAGF,oBAAoB,EAAE,6BAA6B,EACnD,iBAAiB,EAAE,iBAAiB,EACpC,cAAc,EAAE,MAAM,MAAM,GAAG,SAAS,EACxC,OAAO,GAAE,gCAAqC;IAQhD,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,UAAU,CAAC,MAAM,EAAE,SAAS,wBAAwB,EAAE,GAAG,OAAO;IAIhE;;;;OAIG;YACW,YAAY;IAgD1B;;;;OAIG;IACH,OAAO,CAAC,MAAM;IA0Bd,qFAAqF;YACvE,QAAQ;IAmBtB;;;;OAIG;YACW,iBAAiB;IAuDzB,MAAM,CACV,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,8BAA8B,CAAC;KACjD,EACD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,SAAS,wBAAwB,EAAE,CAAC;IAkB/C,uEAAuE;YACzD,YAAY;IAyB1B,uDAAuD;YACzC,cAAc;IAY5B,QAAQ,CACN,SAAS,EAAE,wBAAwB,GAClC,OAAO,CAAC,0BAA0B,CAAC;IAiChC,cAAc,CAClB,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,uBAAuB,CAAC,EACrD,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GACjD,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC;IA2DjD,4FAA4F;IAC5F,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,MAAM,GAAG,SAAS;IAIzE;;;;;;;OAOG;IACG,SAAS,CACb,SAAS,EAAE,wBAAwB,EACnC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;CA0E5D"}