@finos/legend-application-data-cube 0.1.0

package/src/application/LegendDataCubeApplicationConfig.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) 2020-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 {
+  LegendApplicationConfig,
+  type LegendApplicationConfigurationData,
+  type LegendApplicationConfigurationInput,
+} from '@finos/legend-application';
+import {
+  assertNonNullable,
+  guaranteeNonEmptyString,
+} from '@finos/legend-shared';
+
+export interface LegendDataCubeApplicationConfigurationData
+  extends LegendApplicationConfigurationData {
+  depot: {
+    url: string;
+  };
+  engine: { url: string; queryUrl: string };
+}
+
+export class LegendDataCubeApplicationConfig extends LegendApplicationConfig {
+  readonly engineServerUrl: string;
+  readonly depotServerUrl: string;
+  readonly engineQueryServerUrl: string;
+
+  constructor(
+    input: LegendApplicationConfigurationInput<LegendDataCubeApplicationConfigurationData>,
+  ) {
+    super(input);
+
+    // engine
+    assertNonNullable(
+      input.configData.engine,
+      `Can't configure application: 'engine' field is missing`,
+    );
+    this.engineServerUrl = LegendApplicationConfig.resolveAbsoluteUrl(
+      guaranteeNonEmptyString(
+        input.configData.engine.url,
+        `Can't configure application: 'engine.url' field is missing or empty`,
+      ),
+    );
+    this.engineQueryServerUrl = LegendApplicationConfig.resolveAbsoluteUrl(
+      input.configData.engine.queryUrl,
+    );
+    // depot
+    assertNonNullable(
+      input.configData.depot,
+      `Can't configure application: 'depot' field is missing`,
+    );
+    this.depotServerUrl = LegendApplicationConfig.resolveAbsoluteUrl(
+      guaranteeNonEmptyString(
+        input.configData.depot.url,
+        `Can't configure application: 'depot.url' field is missing or empty`,
+      ),
+    );
+  }
+  getDefaultApplicationStorageKey(): string {
+    return 'legend-data-cube';
+  }
+}

package/src/application/LegendDataCubeApplicationPlugin.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2020-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 { LegendApplicationPlugin } from '@finos/legend-application';
+import { type LegendDataCubePluginManager } from './LegendDataCubePluginManager.js';
+
+export class LegendDataCubeApplicationPlugin extends LegendApplicationPlugin {
+  /**
+   * This helps to better type-check for this empty abtract type
+   * See https://github.com/finos/legend-studio/blob/master/docs/technical/typescript-usage.md#understand-typescript-structual-type-system
+   */
+  private readonly _$nominalTypeBrand!: 'LegendDataCubeApplicationPlugin';
+
+  install(pluginManager: LegendDataCubePluginManager): void {
+    pluginManager.registerApplicationPlugin(this);
+  }
+}

package/src/application/LegendDataCubePluginManager.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2020-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 { LegendApplicationPluginManager } from '@finos/legend-application';
+import { type LegendDataCubeApplicationPlugin } from './LegendDataCubeApplicationPlugin.js';
+import type {
+  GraphManagerPluginManager,
+  PureGraphManagerPlugin,
+  PureGraphPlugin,
+  PureProtocolProcessorPlugin,
+} from '@finos/legend-graph';
+
+export class LegendDataCubePluginManager
+  extends LegendApplicationPluginManager<LegendDataCubeApplicationPlugin>
+  implements GraphManagerPluginManager
+{
+  private pureProtocolProcessorPlugins: PureProtocolProcessorPlugin[] = [];
+  private pureGraphManagerPlugins: PureGraphManagerPlugin[] = [];
+  private pureGraphPlugins: PureGraphPlugin[] = [];
+
+  private constructor() {
+    super();
+  }
+  registerPureProtocolProcessorPlugin(
+    plugin: PureProtocolProcessorPlugin,
+  ): void {
+    this.pureProtocolProcessorPlugins.push(plugin);
+  }
+
+  registerPureGraphManagerPlugin(plugin: PureGraphManagerPlugin): void {
+    this.pureGraphManagerPlugins.push(plugin);
+  }
+
+  registerPureGraphPlugin(plugin: PureGraphPlugin): void {
+    this.pureGraphPlugins.push(plugin);
+  }
+
+  getPureGraphManagerPlugins(): PureGraphManagerPlugin[] {
+    return [...this.pureGraphManagerPlugins];
+  }
+
+  getPureProtocolProcessorPlugins(): PureProtocolProcessorPlugin[] {
+    return [...this.pureProtocolProcessorPlugins];
+  }
+
+  getPureGraphPlugins(): PureGraphPlugin[] {
+    return [...this.pureGraphPlugins];
+  }
+
+  static create(): LegendDataCubePluginManager {
+    return new LegendDataCubePluginManager();
+  }
+}

package/src/components/DataCubeEditor.tsx

@@ -0,0 +1,93 @@
+/**
+ * Copyright (c) 2020-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 { observer } from 'mobx-react-lite';
+import { QuestionIcon } from '@finos/legend-art';
+import { useLegendDataCubeBaseStore } from './LegendDataCubeFrameworkProvider.js';
+import { DataCubeSourceEditor } from './source/DataCubeSourceEditor.js';
+import { useEffect } from 'react';
+import { DataCube } from '@finos/legend-data-cube';
+
+export const DataCubeEditor = observer(() => {
+  const dataCubeStore = useLegendDataCubeBaseStore();
+  const sourceSelector = dataCubeStore.sourceSelector;
+
+  useEffect(() => {
+    dataCubeStore.context.initialize();
+  }, [dataCubeStore]);
+  return (
+    <>
+      <div className="h-full w-full bg-white">
+        <div className="bg-sky-900">
+          <div className="mx-auto max-w-full px-2 sm:px-6 lg:px-8">
+            <div className="relative flex h-12 items-center justify-between">
+              <div className="flex flex-1 items-center justify-center sm:items-stretch sm:justify-start">
+                <div className="flex flex-shrink-0 items-center">
+                  <div className="text-gray-300">Legend Data Cube</div>
+                </div>
+              </div>
+              <div className="md:block">
+                <div className="ml-4 flex items-center md:ml-6">
+                  <button
+                    type="button"
+                    className="relative rounded-full bg-sky-900 p-1 text-gray-400 hover:text-white focus:outline-none focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-800"
+                  >
+                    <QuestionIcon />
+                  </button>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+        {dataCubeStore.cubeViewer ? (
+          <>
+            <div className="h-[calc(100%_-_30px)]">
+              <div className="h-12 w-full bg-gray-200"></div>
+              <div className="h-[calc(100%_-_30px)]">
+                <DataCube engine={dataCubeStore.cubeViewer.engine} />
+              </div>
+            </div>
+          </>
+        ) : (
+          <>
+            <div
+              onClick={() => sourceSelector.openModal()}
+              className="bg-white shadow"
+            >
+              <div className="mx-auto h-40 px-4 py-6 sm:px-6 lg:px-8">
+                <div className="group flex w-full flex-col items-center justify-center rounded-md border-2 border-dashed border-slate-300 py-3 text-base font-medium leading-6 text-slate-900 hover:cursor-pointer hover:border-solid hover:border-blue-500 hover:bg-white hover:text-blue-500">
+                  <svg
+                    className="mb-1 text-slate-400 group-hover:text-blue-500"
+                    width="20"
+                    height="20"
+                    fill="currentColor"
+                    aria-hidden="true"
+                  >
+                    <path d="M10 5a1 1 0 0 1 1 1v3h3a1 1 0 1 1 0 2h-3v3a1 1 0 1 1-2 0v-3H6a1 1 0 1 1 0-2h3V6a1 1 0 0 1 1-1Z" />
+                  </svg>
+                  Add Source
+                </div>
+              </div>
+            </div>
+          </>
+        )}
+      </div>
+      {sourceSelector.open && (
+        <DataCubeSourceEditor sourceBuilder={sourceSelector} />
+      )}
+    </>
+  );
+});

package/src/components/LegendDataCubeFrameworkProvider.tsx

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) 2020-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 { createContext, useContext } from 'react';
+import { useLocalObservable } from 'mobx-react-lite';
+import { guaranteeNonNullable } from '@finos/legend-shared';
+import {
+  type ApplicationStore,
+  useApplicationStore,
+  ApplicationFrameworkProvider,
+} from '@finos/legend-application';
+import type { LegendDataCubeApplicationConfig } from '../application/LegendDataCubeApplicationConfig.js';
+import type { LegendDataCubePluginManager } from '../application/LegendDataCubePluginManager.js';
+import { LegendDataCubeStore } from '../stores/LegendDataCubeEditorStore.js';
+
+export const useLegendDataCubeApplicationStore = (): ApplicationStore<
+  LegendDataCubeApplicationConfig,
+  LegendDataCubePluginManager
+> =>
+  useApplicationStore<
+    LegendDataCubeApplicationConfig,
+    LegendDataCubePluginManager
+  >();
+
+const LegendDataCubeBaseStoreContext = createContext<
+  LegendDataCubeStore | undefined
+>(undefined);
+
+const LegendDataCubeBaseStoreProvider: React.FC<{
+  children: React.ReactNode;
+}> = ({ children }) => {
+  const applicationStore = useLegendDataCubeApplicationStore();
+  const store = useLocalObservable(
+    () => new LegendDataCubeStore(applicationStore),
+  );
+  return (
+    <LegendDataCubeBaseStoreContext.Provider value={store}>
+      {children}
+    </LegendDataCubeBaseStoreContext.Provider>
+  );
+};
+
+export const useLegendDataCubeBaseStore = (): LegendDataCubeStore =>
+  guaranteeNonNullable(
+    useContext(LegendDataCubeBaseStoreContext),
+    `Can't find Legend Data Cube base store in context`,
+  );
+
+export const LegendDataCubeFrameworkProvider: React.FC<{
+  children: React.ReactNode;
+}> = ({ children }) => (
+  <ApplicationFrameworkProvider>
+    <LegendDataCubeBaseStoreProvider>
+      {children}
+    </LegendDataCubeBaseStoreProvider>
+  </ApplicationFrameworkProvider>
+);

package/src/components/LegendDataCubeWebApplication.tsx

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2020-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 { BrowserEnvironmentProvider } from '@finos/legend-application';
+import { Route, Routes } from '@finos/legend-application/browser';
+import { LegendDataCubeFrameworkProvider } from './LegendDataCubeFrameworkProvider.js';
+import { observer } from 'mobx-react-lite';
+import { DataCubeEditor } from './DataCubeEditor.js';
+
+const LegendDataCubeWebApplicationRouter = observer(() => {
+  return (
+    <div className="app">
+      <Routes>
+        <Route path="*" element={<DataCubeEditor />} />
+      </Routes>
+    </div>
+  );
+});
+
+export const LegendDataCubeWebApplication = observer(
+  (props: { baseUrl: string }) => {
+    const { baseUrl } = props;
+
+    return (
+      <BrowserEnvironmentProvider baseUrl={baseUrl}>
+        <LegendDataCubeFrameworkProvider>
+          <LegendDataCubeWebApplicationRouter />
+        </LegendDataCubeFrameworkProvider>
+      </BrowserEnvironmentProvider>
+    );
+  },
+);

package/src/components/source/DataCubeSourceEditor.tsx

@@ -0,0 +1,133 @@
+/**
+ * Copyright (c) 2020-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 { observer } from 'mobx-react-lite';
+import { type LegendDataCubeSourceBuilder } from '../../stores/source/LegendDataCubeSourceBuilder.js';
+import { DataCubeSourceType } from '../../stores/source/CubeInputSourceLoader.js';
+import {
+  Dialog,
+  Modal,
+  PanelLoadingIndicator,
+  TimesIcon,
+  cn,
+} from '@finos/legend-art';
+import { SavedQuerySourceEditor } from './SavedQuerySourceEditor.js';
+import { SavedQueryInputSourceState } from '../../stores/source/SavedQueryInputSourceState.js';
+import { useLegendDataCubeBaseStore } from '../LegendDataCubeFrameworkProvider.js';
+import { flowResult } from 'mobx';
+import type { CubeInputSource } from '../../stores/source/CubeInputSource.js';
+import type { DataCubeEngine } from '@finos/legend-data-cube';
+
+export const DataCubeSourceEditor = observer(
+  (props: { sourceBuilder: LegendDataCubeSourceBuilder }) => {
+    const { sourceBuilder } = props;
+    const store = useLegendDataCubeBaseStore();
+    const sourceState = sourceBuilder.sourceState;
+    const tabs = Object.values(DataCubeSourceType);
+    const selectedTab = sourceState.label;
+    const closeModal = (): void => sourceBuilder.close();
+
+    return (
+      <Dialog
+        open={sourceBuilder.open}
+        onClose={closeModal}
+        classes={{
+          root: 'query-loader__dialog',
+          container: 'query-loader__dialog__container',
+        }}
+        PaperProps={{
+          classes: { root: 'query-loader__dialog__body' },
+        }}
+      >
+        <Modal
+          darkMode={false}
+          className="modal query-loader__dialog__body__content"
+        >
+          <div className="flex h-20 cursor-default items-center justify-between border-b border-l-0 border-r-0 border-t-0 border-solid border-slate-300 p-5">
+            <div className="flex items-center">
+              <div className="flex items-center text-xl font-bold">
+                Data Cube Source
+              </div>
+            </div>
+            <div className="flex items-center">
+              <button
+                className="mr-1 flex h-3 w-3 items-center justify-center"
+                tabIndex={-1}
+                onClick={close}
+              >
+                <TimesIcon className="text-xl text-slate-400 hover:text-slate-800" />
+              </button>
+            </div>
+          </div>
+          <div className="relative h-[calc(100%_-_100px)] p-5">
+            <PanelLoadingIndicator
+              isLoading={Boolean(sourceState.buildCubeEngineState.isInProgress)}
+            />
+
+            <div className="h-15 flex overflow-y-hidden border-b border-l-0 border-r-0 border-t-0 border-solid border-slate-300 px-2 pb-1 pt-2 hover:font-light">
+              {tabs.map((tab) => (
+                <button
+                  key={tab}
+                  onClick={() => sourceBuilder.changeSource(tab)}
+                  className={cn(
+                    'flex h-6 items-center justify-center whitespace-nowrap pl-2 text-sm hover:font-bold focus:z-10',
+                    {
+                      'border-b-2 border-l-0 border-r-0 border-t-0 border-solid border-sky-800':
+                        tab === selectedTab,
+                    },
+                  )}
+                >
+                  {tab}
+                </button>
+              ))}
+            </div>
+            <div className="h-[calc(100%_-_35px)] w-full overflow-auto border border-neutral-300 bg-white">
+              <div className="theme__legacy-light">
+                {sourceState instanceof SavedQueryInputSourceState && (
+                  <SavedQuerySourceEditor
+                    savedQueryInputSourceState={sourceState}
+                  />
+                )}
+              </div>
+            </div>
+          </div>
+          <div className="flex h-20 items-center justify-end border-b-0 border-l-0 border-r-0 border-t border-solid border-slate-300 p-2 px-2">
+            <button
+              className="ml-2 h-10 w-20 rounded border border-neutral-400 bg-neutral-300 bg-sky-700 px-2 text-white hover:brightness-95 disabled:cursor-not-allowed disabled:border-neutral-300 disabled:bg-gray-200 disabled:text-white disabled:hover:brightness-100"
+              disabled={!sourceState.isValid}
+              onClick={() => {
+                flowResult(
+                  sourceBuilder.inputSource(
+                    (source: CubeInputSource, engine: DataCubeEngine) =>
+                      store.initializeView(source, engine),
+                  ),
+                ).catch(store.context.applicationStore.alertUnhandledError);
+              }}
+            >
+              Open
+            </button>
+            <button
+              className="ml-2 h-10 w-20 rounded border border-neutral-400 bg-gray-500 px-2 text-white hover:brightness-95"
+              onClick={() => sourceBuilder.close()}
+            >
+              Close
+            </button>
+          </div>
+        </Modal>
+      </Dialog>
+    );
+  },
+);

package/src/components/source/SavedQuerySourceEditor.tsx

@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) 2020-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 { observer } from 'mobx-react-lite';
+import { QueryLoader } from '@finos/legend-query-builder';
+import type { SavedQueryInputSourceState } from '../../stores/source/SavedQueryInputSourceState.js';
+import { generateGAVCoordinates } from '@finos/legend-storage';
+
+export const SavedQuerySourceEditor = observer(
+  (props: { savedQueryInputSourceState: SavedQueryInputSourceState }) => {
+    const { savedQueryInputSourceState } = props;
+    const savedQuery = savedQueryInputSourceState.query;
+
+    return (
+      <div>
+        {savedQuery ? (
+          <div className="p-3">
+            <div className="text-l font-bold">Saved Query</div>
+            <div className="">
+              <div className="flex pt-px">
+                <div className="font-bold">Name:</div>
+                <div>{savedQuery.name}</div>
+              </div>
+              <div className="flex pt-px">
+                <div className="font-bold">Project:</div>
+                <div>
+                  {generateGAVCoordinates(
+                    savedQuery.groupId,
+                    savedQuery.artifactId,
+                    savedQuery.versionId,
+                  )}
+                </div>
+              </div>
+              <div className="flex pt-px">
+                <div className="font-bold">Owner:</div>
+                <div>{savedQuery.owner}</div>
+              </div>
+            </div>
+          </div>
+        ) : (
+          <QueryLoader
+            queryLoaderState={savedQueryInputSourceState.queryLoaderState}
+            loadActionLabel={'Open'}
+          />
+        )}
+      </div>
+    );
+  },
+);

package/src/index.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2020-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.
+ */
+
+export * from './application/LegendDataCube.js';
+export * from './application/LegendDataCubeApplicationConfig.js';
+export * from './application/LegendDataCubePluginManager.js';