api 4.4.0 → 5.0.0-beta.0

package/src/cli/codegen/language.ts

@@ -0,0 +1,47 @@
+import type Oas from 'oas';
+import type Storage from '../storage';
+import { PACKAGE_NAME, PACKAGE_VERSION } from '../../packageInfo';
+
+export interface InstallerOptions {
+  /**
+   * Will initiate a dry run install process. Used for simulating installations within a unit test.
+   */
+  dryRun?: boolean;
+
+  /**
+   * Used for stubbing out the logger that we use within the installation process so it can be
+   * easily introspected without having to mock out `console.*`.
+   */
+  logger?: (msg: string) => void;
+}
+
+export default abstract class CodeGeneratorLanguage {
+  spec: Oas;
+
+  specPath: string;
+
+  identifier: string;
+
+  userAgent: string;
+
+  requiredPackages: Record<string, { reason: string; url: string }>;
+
+  constructor(spec: Oas, specPath: string, identifier: string) {
+    this.spec = spec;
+    this.specPath = specPath;
+
+    // User agents should be contextual to the spec in question and the version of `api` that was
+    // used to generate the SDK. For example, this'll look like `petstore/1.0.0 (api/4.2.0)` for
+    // a `petstore` spec installed on api@4.2.0.
+    const info = spec.getDefinition().info;
+    this.userAgent = `${identifier}/${info.version} (${PACKAGE_NAME}/${PACKAGE_VERSION})`;
+  }
+
+  abstract generator(): Promise<Record<string, string>>;
+
+  abstract installer(storage: Storage, opts?: InstallerOptions): Promise<void>;
+
+  hasRequiredPackages() {
+    return Boolean(Object.keys(this.requiredPackages));
+  }
+}