Updates to artifact to conform to service structs

utils/build-validate-quickstart-artifact.ts

@@ -8,8 +8,8 @@ import Alert from "./lib/Alert";
 import Dashboard, { DashboardConfig } from "./lib/Dashboard";
 import Ajv, { type ErrorObject } from 'ajv';
 import { QuickstartConfig, QuickstartConfigAlert } from './types/QuickstartConfig';
-import { DataSourceConfig } from './types/DataSourceConfig';
 import { passedProcessArguments } from './lib/helpers';
+import { ArtifactDataSourceConfig } from './types/Artifact';
 
 type ArtifactSchema = Record<string, unknown>;
 
@@ -21,7 +21,7 @@ type InvalidItem = {
 
 type ArtifactComponents = {
   quickstarts: QuickstartConfig[],
-  dataSources: DataSourceConfig[],
+  dataSources: ArtifactDataSourceConfig[],
   alerts: QuickstartConfigAlert[][],
   dashboards: DashboardConfig[]
 }
@@ -38,10 +38,10 @@ const getSchema = (filepath: string): ArtifactSchema => {
 
 // NOTE: we could run these in parallel to speed up the script
 export const getArtifactComponents = (): ArtifactComponents => {
-  const quickstarts = Quickstart.getAll().map((quickstart) => quickstart.config);
+  const quickstarts = Quickstart.getAll().map((quickstart) => quickstart.transformForArtifact());
   console.log(`[*] Found ${quickstarts.length} quickstarts`);
 
-  const dataSources = DataSource.getAll().map((dataSource) => dataSource.config);
+  const dataSources = DataSource.getAll().map((dataSource) => dataSource.transformForArtifact());
   console.log(`[*] Found ${dataSources.length} dataSources`);
 
   const alerts = Alert.getAll().map((alert) => alert.config);
@@ -51,14 +51,15 @@ export const getArtifactComponents = (): ArtifactComponents => {
   console.log(`[*] Found ${dashboards.length} dashboards`);
 
   return {
+    // @ts-ignore
     quickstarts,
     dataSources,
     alerts,
     dashboards
   }
 };
 
-export const getDataSourceIds = (filepath: string, communityDataSources: DataSourceConfig[]): string[] => {
+export const getDataSourceIds = (filepath: string, communityDataSources: ArtifactComponents['dataSources']): string[] => {
   const coreDataSourceIds = yaml.load(
     fs.readFileSync(filepath).toString('utf8')
   ) as string[];

utils/lib/DataSource.ts

@@ -17,6 +17,7 @@ import type {
   DataSourceInstallDirectiveInput,
   DataSourceMutationVariable,
 } from '../types/DataSourceMutationVariable';
+import { ArtifactInstall, ArtifactInstallDirective } from '../types/Artifact';
 
 export interface DataSourceMutationResponse {
   dataSource: {
@@ -73,6 +74,29 @@ class DataSource extends Component<DataSourceConfig, string> {
     return this._getYamlConfigContent();
   }
 
+  public transformForArtifact() {
+    const { keywords, description, categoryTerms, icon, ...rest } = this.config;
+
+    return {
+      ...rest,
+      iconUrl: this._getIconUrl(),
+      install: this._parseInstallsForArtifact(),
+      categoryTerms: categoryTerms ? categoryTerms.map((t) => t.trim()) : [],
+      keywords: keywords ? keywords.map((k) => k.trim()) : [],
+      description: description && description.trim(),
+    };
+  }
+
+  private _parseInstallsForArtifact() {
+    const { install } = this.config;
+
+    return {
+      primary: this._parseInstallDirectiveForArtifact(install.primary),
+      fallback:
+        install.fallback && this._parseInstallDirectiveForArtifact(install.fallback),
+    };
+  }
+
   /**
    * Get the variables for the **Quickstart** mutation.
    *
@@ -189,6 +213,33 @@ class DataSource extends Component<DataSourceConfig, string> {
     return directive;
   }
 
+  /**
+   * Helper method that returns the directive, based on its type.
+   */
+  private _parseInstallDirectiveForArtifact(
+    directive: DataSourceConfigInstallDirective
+  ): ArtifactInstall {
+    if ('link' in directive) {
+      const { url } = directive.link;
+
+      return {
+        url: url?.trim() ?? '',
+      };
+    }
+
+    if ('nerdlet' in directive) {
+      const { nerdletId, nerdletState, requiresAccount } = directive.nerdlet;
+
+      return {
+        nerdletId: nerdletId?.trim() ?? '',
+        nerdletState: nerdletState,
+        requiresAccount: requiresAccount,
+      };
+    }
+
+    return directive;
+  }
+
   static isDataSource(x: DataSource | undefined): x is DataSource {
     return x !== undefined;
   }

utils/lib/Quickstart.ts

@@ -198,6 +198,20 @@ class Quickstart {
     };
   }
 
+  public transformForArtifact(): QuickstartConfig | { authors: { name: string }[] } {
+    const config = {
+      ...this.config,
+      // @ts-ignore
+      displayName: this.config.title,
+      icon: this._constructIconUrl(this.config.icon),
+      authors: this.config.authors.map((author) => ({ name: author })),
+    }
+
+    // @ts-ignore
+    delete config.title;
+    return config;
+  }
+
   public async submitMutation(dryRun = true) {
     logger.info(`Submitting mutation for ${this.identifier}`, { dryRun });
     const { data, errors } = await fetchNRGraphqlResults<