@finos/legend-application-studio 13.0.0

package/src/application/LegendStudioApplicationConfig.ts

@@ -0,0 +1,148 @@
+/**
+ * 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 {
+  createModelSchema,
+  list,
+  object,
+  optional,
+  primitive,
+} from 'serializr';
+import {
+  type PlainObject,
+  type RequestHeaders,
+  assertNonNullable,
+  guaranteeNonEmptyString,
+  SerializationFactory,
+} from '@finos/legend-shared';
+import {
+  LegendApplicationConfig,
+  type LegendApplicationConfigurationInput,
+  type LegendApplicationConfigurationData,
+} from '@finos/legend-application';
+
+export class ServiceRegistrationEnvInfo {
+  env!: string;
+  executionUrl!: string;
+  modes: string[] = [];
+  managementUrl!: string;
+
+  static readonly serialization = new SerializationFactory(
+    createModelSchema(ServiceRegistrationEnvInfo, {
+      env: primitive(),
+      executionUrl: primitive(),
+      managementUrl: primitive(),
+      modes: list(primitive()),
+    }),
+  );
+}
+
+class LegendStudioApplicationCoreOptions {
+  /**
+   * Indicates if we should keep section index and do not rewrite/flatten the paths shortened by section
+   * imports.
+   *
+   * This flag will be kept until we have full support for section index
+   * See https://github.com/finos/legend-studio/issues/1067
+   */
+  TEMPORARY__preserveSectionIndex = false;
+  /**
+   * Provides service registration environment configs.
+   *
+   * TODO: when we modularize service, we can move this config to DSL Service preset. Then, we can remove
+   * the TEMPORARY__ prefix.
+   *
+   * @modularize
+   * See https://github.com/finos/legend-studio/issues/65
+   */
+  TEMPORARY__serviceRegistrationConfig: ServiceRegistrationEnvInfo[] = [];
+
+  private static readonly serialization = new SerializationFactory(
+    createModelSchema(LegendStudioApplicationCoreOptions, {
+      TEMPORARY__preserveSectionIndex: optional(primitive()),
+      TEMPORARY__serviceRegistrationConfig: list(
+        object(ServiceRegistrationEnvInfo),
+      ),
+    }),
+  );
+
+  static create(
+    configData: PlainObject<LegendStudioApplicationCoreOptions>,
+  ): LegendStudioApplicationCoreOptions {
+    return LegendStudioApplicationCoreOptions.serialization.fromJson(
+      configData,
+    );
+  }
+}
+
+export interface LegendStudioApplicationConfigurationData
+  extends LegendApplicationConfigurationData {
+  appName: string;
+  env: string;
+  sdlc: { url: string; baseHeaders?: RequestHeaders };
+  depot: { url: string };
+  engine: { url: string; queryUrl?: string };
+}
+
+export class LegendStudioApplicationConfig extends LegendApplicationConfig {
+  readonly options = new LegendStudioApplicationCoreOptions();
+
+  readonly engineServerUrl: string;
+  readonly engineQueryServerUrl?: string | undefined;
+  readonly depotServerUrl: string;
+  readonly sdlcServerUrl: string;
+  readonly SDLCServerBaseHeaders?: RequestHeaders | undefined;
+
+  constructor(
+    input: LegendApplicationConfigurationInput<LegendStudioApplicationConfigurationData>,
+  ) {
+    super(input);
+
+    assertNonNullable(
+      input.configData.engine,
+      `Can't configure application: 'engine' field is missing`,
+    );
+    this.engineServerUrl = guaranteeNonEmptyString(
+      input.configData.engine.url,
+      `Can't configure application: 'engine.url' field is missing or empty`,
+    );
+
+    this.engineQueryServerUrl = input.configData.engine.queryUrl;
+    assertNonNullable(
+      input.configData.depot,
+      `Can't configure application: 'depot' field is missing`,
+    );
+    this.depotServerUrl = guaranteeNonEmptyString(
+      input.configData.depot.url,
+      `Can't configure application: 'depot.url' field is missing or empty`,
+    );
+
+    assertNonNullable(
+      input.configData.sdlc,
+      `Can't configure application: 'sdlc' field is missing`,
+    );
+    this.sdlcServerUrl = guaranteeNonEmptyString(
+      input.configData.sdlc.url,
+      `Can't configure application: 'sdlc.url' field is missing or empty`,
+    );
+    this.SDLCServerBaseHeaders = input.configData.sdlc.baseHeaders;
+
+    this.options = LegendStudioApplicationCoreOptions.create(
+      (input.configData.extensions?.core ??
+        {}) as PlainObject<LegendStudioApplicationCoreOptions>,
+    );
+  }
+}

package/src/application/LegendStudioPluginManager.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 {
+  CorePureGraphManagerPlugin,
+  type GraphManagerPluginManager,
+  type PureGraphManagerPlugin,
+  type PureGraphPlugin,
+  type PureProtocolProcessorPlugin,
+} from '@finos/legend-graph';
+import { Core_LegendStudioApplicationPlugin } from '../components/Core_LegendStudioApplicationPlugin.js';
+import type { LegendStudioApplicationPlugin } from '../stores/LegendStudioApplicationPlugin.js';
+
+export class LegendStudioPluginManager
+  extends LegendApplicationPluginManager<LegendStudioApplicationPlugin>
+  implements GraphManagerPluginManager
+{
+  private pureProtocolProcessorPlugins: PureProtocolProcessorPlugin[] = [];
+  private pureGraphManagerPlugins: PureGraphManagerPlugin[] = [];
+  private pureGraphPlugins: PureGraphPlugin[] = [];
+
+  private constructor() {
+    super();
+  }
+
+  static create(): LegendStudioPluginManager {
+    return new LegendStudioPluginManager();
+  }
+
+  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];
+  }
+
+  override getHiddenPluginNames(): string[] {
+    return [
+      Core_LegendStudioApplicationPlugin.NAME,
+      CorePureGraphManagerPlugin.NAME,
+    ];
+  }
+}

package/src/components/Core_LegendStudioApplicationPlugin.tsx

@@ -0,0 +1,92 @@
+/**
+ * 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 {
+  collectContextualDocumnetationEntries,
+  type ContextualDocumentationEntry,
+} from '@finos/legend-application';
+import packageJson from '../../package.json';
+import { LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY } from '../stores/LegendStudioApplicationNavigationContext.js';
+import {
+  CORE_CONTEXTUAL_DOCUMENTATION_CONFIG,
+  LEGEND_STUDIO_DOCUMENTATION_KEY,
+} from '../stores/LegendStudioDocumentation.js';
+import { LegendStudioApplicationPlugin } from '../stores/LegendStudioApplicationPlugin.js';
+
+export class Core_LegendStudioApplicationPlugin extends LegendStudioApplicationPlugin {
+  static NAME = packageJson.extensions.applicationStudioPlugin;
+
+  constructor() {
+    super(Core_LegendStudioApplicationPlugin.NAME, packageJson.version);
+  }
+
+  override getExtraRequiredDocumentationKeys(): string[] {
+    return [
+      // grammar parsers
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_PURE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_MAPPING,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_RUNTIME,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_RELATIONAL,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_SERVICE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_GENERATION_SPECIFICATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_FILE_GENERATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_DATA,
+      // grammar elements
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_CLASS,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_PROFILE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_ENUMERATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_MEASURE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_ASSOCIATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_FUNCTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_MAPPING,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_DATABASE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_SERVICE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_RUNTIME,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_GENERATION_SPECIFICATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_ELEMENT_FILE_GENERATION_SPECIFICATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_DATA_ELEMENT,
+      // grammar elements
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_JSON_MODEL_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_XML_MODEL_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_MODEL_CHAIN_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_RELATIONAL_DATABASE_CONNECTION,
+    ];
+  }
+
+  override getExtraContextualDocumentationEntries(): ContextualDocumentationEntry[] {
+    return collectContextualDocumnetationEntries(
+      CORE_CONTEXTUAL_DOCUMENTATION_CONFIG,
+    );
+  }
+
+  override getExtraAccessEventLoggingApplicationContextKeys(): string[] {
+    return [
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.TEXT_MODE_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.MODEL_LOADER,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.CLASS_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.PROFILE_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.ENUMERATION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.ASSOCIATION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.FUNCTION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.MAPPING_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.RUNTIME_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.CONNECTION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.SERVICE_EDITOR,
+    ];
+  }
+}

package/src/components/DSLExternalFormat_CodeSnippets.ts

@@ -0,0 +1,78 @@
+/**
+ * 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 const BASIC_BINDING_SNIPPET = `Binding \${1:model::NewBinding}
+{
+  schemaSet: \${2:model::SomeSchemaSet};
+  schemaId: \${3:testSchemaId};
+  contentType: \${4:'application/json'};
+  modelIncludes: [
+    \${5:model::SomeClass}
+  ];
+}`;
+
+export const BASIC_SCHEMASET_SNIPPET = `SchemaSet \${1:model::NewSchemaSet}
+{
+  format: \${2:};
+  schemas: [
+    {
+      id: \${3:};
+      location: '\${4:}';
+      content: '\${5:}';
+    }
+  ];
+}`;
+
+export const SCHEMASET_WITH_JSON_SCHEMA_SNIPPET = `SchemaSet \${1:model::NewSchemaSet}
+{
+  format: JSON;
+  schemas: [
+    {
+      id: \${2:testId};
+      location: '\${3:example.json}';
+      // example of JSON content
+      // content: '{\\n "\\$schema": "http://json-schema.org/draft-07/schema#",\\n  "type": "object",\\n  "properties": {\\n    "stringField": {\\n      "type": "string"\\n    },\\n    "floatField": {\\n      "type": "number"\\n    },\\n    "decimalField": {\\n      "type": "number"\\n    },\\n    "integerField": {\\n      "type": "integer"\\n    },\\n    "dateField": {\\n      "type": "string",\\n      "format": "date-time"\\n    },\\n    "dateTimeField": {\\n      "type": "string",\\n      "format": "date-time"\\n    },\\n    "strictDateField": {\\n      "type": "string",\\n      "format": "date"\\n    },\\n    "booleanField": {\\n      "type": "boolean"\\n    }\\n  },\\n  "required": [\\n    "stringField",\\n    "floatField",\\n    "decimalField",\\n    "integerField",\\n    "dateField",\\n    "dateTimeField",\\n    "strictDateField",\\n    "booleanField"\\n  ]\\n}';
+      content: '\${4:}';
+    }
+  ];
+}`;
+
+export const SCHEMASET_WITH_XML_SCHEMA_SNIPPET = `SchemaSet \${1:model::NewSchemaSet}
+{
+  format: XSD;
+  schemas: [
+    {
+      id: \${2:testId};
+      location: '\${3:example.xsd}';
+      // example of XSD content
+      // content: '<?xml version=\\'1.0\\'?>\\n<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">\\n    <xs:complexType name="Rectangle">\\n        <xs:sequence>\\n            <xs:element name="height" type="xs:int" minOccurs="1" maxOccurs="unbounded">\\n                <xs:annotation>\\n                    <xs:documentation xml:lang="en">One of two dimensions of a rectangle</xs:documentation>\\n                </xs:annotation>\\n            </xs:element>\\n            <xs:element name="width" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>\\n        </xs:sequence>\\n    </xs:complexType>\\n</xs:schema>\\n';
+      content: '\${4:}';
+    }
+  ];
+}`;
+
+export const SCHEMASET_WITH_FLAT_DATA_SCHEMA_SNIPPET = `SchemaSet \${1:model::NewSchemaSet}
+{
+  format: FlatData;
+  schemas: [
+    {
+      id: \${2:testId};
+      // example of flat-data content
+      // content: 'section data: DelimitedWithHeadings\\n{\\n  scope.untilEof;\\n  delimiter: \\',\\';\\n\\n  Record\\n  {\\n    FULL_NAME: STRING;\\n    NICK_NAME: STRING;\\n  }\\n}';
+      content: '\${3:}';
+    }
+  ];
+}`;