@fern-api/generator-cli 0.1.8 → 0.3.0

package/dist/api.d.cts

@@ -0,0 +1,586 @@
+import fs from 'fs';
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * A unique identifier for a feature (e.g. OPTIONALS). This is typed as a freeform string
+ * to allow for arbitrary features, but callers are expected to use the StructuredFeatureId
+ * string representation whenever possible.
+ */
+type FeatureId = string | StructuredFeatureId;
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Unique identifiers for features that can be demonstrated with snippets.
+ */
+type StructuredFeatureId = "AUTHENTICATION" | "ERRORS" | "USAGE" | "PAGINATION" | "RETRIES" | "REQUEST_OPTIONS" | "STREAMING" | "TIMEOUTS" | "CUSTOM_CLIENT" | "CONTRIBUTING";
+declare const StructuredFeatureId: {
+    readonly Authentication: "AUTHENTICATION";
+    readonly Errors: "ERRORS";
+    readonly Usage: "USAGE";
+    readonly Pagination: "PAGINATION";
+    readonly Retries: "RETRIES";
+    readonly RequestOptions: "REQUEST_OPTIONS";
+    readonly Streaming: "STREAMING";
+    readonly Timeouts: "TIMEOUTS";
+    readonly CustomClient: "CUSTOM_CLIENT";
+    readonly Contributing: "CONTRIBUTING";
+    readonly _visit: <R>(value: StructuredFeatureId, visitor: StructuredFeatureId.Visitor<R>) => R;
+};
+declare namespace StructuredFeatureId {
+    interface Visitor<R> {
+        authentication: () => R;
+        errors: () => R;
+        usage: () => R;
+        pagination: () => R;
+        retries: () => R;
+        requestOptions: () => R;
+        streaming: () => R;
+        timeouts: () => R;
+        customClient: () => R;
+        contributing: () => R;
+        _other: () => R;
+    }
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * A specification for a feature supported by a generator. This includes the
+ * feature's ID, a description, and any additional information that should be
+ * included in the README.md.
+ */
+interface FeatureSpec {
+    id: FeatureId;
+    description?: string;
+    addendum?: string;
+    advanced?: boolean;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The configuration used to interact with a GitHub repository.
+ */
+interface GitHubConfig {
+    /** The directory from which to read the contents of the GitHub repository. */
+    sourceDirectory: string;
+    /** The URI of the GitHub repository. */
+    uri: string;
+    /** The token used to access the GitHub repository. */
+    token: string;
+    /** The branch to use when interacting with the GitHub repository. */
+    branch?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * The configuration used to generate a README.md file.
+ * The information described here is a combination of user-defined information
+ * (i.e. specified in the generators.yml), and dynamically generated information
+ * that comes from each generator (i.e. features, requirements, and more).
+ */
+interface ReadmeConfig {
+    /** If specified, the original README.md will be fetched from this remote (if it exists). */
+    remote?: Remote;
+    language: LanguageInfo;
+    organization: string;
+    apiName?: string;
+    bannerLink?: string;
+    introduction?: string;
+    apiReferenceLink?: string;
+    referenceMarkdownPath?: string;
+    requirements?: string[];
+    disabledFeatures?: FeatureId[];
+    whiteLabel?: boolean;
+    customSections?: CustomSection[];
+    /**
+     * Specifies the list of features supported by a specific generator.
+     * The features are rendered in the order they're specified.
+     */
+    features?: ReadmeFeature[];
+    /** Controls whether usage examples show only required parameters (minimal) or all parameters (comprehensive). Defaults to comprehensive. */
+    exampleStyle?: ExampleStyle;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface CustomSection {
+    name: string;
+    language: Language;
+    content: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * The remote where the README.md is hosted.
+ */
+type Remote = Remote.Github;
+declare namespace Remote {
+    interface Github extends GithubRemote, _Utils {
+        type: "github";
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: Remote._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        github: (value: GithubRemote) => _Result;
+        _other: (value: {
+            type: string;
+        }) => _Result;
+    }
+}
+declare const Remote: {
+    readonly github: (value: GithubRemote) => Remote.Github;
+    readonly _visit: <_Result>(value: Remote, visitor: Remote._Visitor<_Result>) => _Result;
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface GithubRemote {
+    /** A full repo url (i.e. https://github.com/fern-api/fern) */
+    repoUrl: string;
+    /** The token used to clone the GitHub repository. */
+    installationToken: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * A single feature supported by a generator (e.g. PAGINATION).
+ */
+interface ReadmeFeature extends FeatureSpec {
+    snippets?: string[];
+    /**
+     * If true, the feature block should be rendered even if we don't receive a snippet for it.
+     * This is useful for features that are always supported, but might not require a snippet
+     * to explain.
+     */
+    snippetsAreOptional: boolean;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * The language and its associated publish information (if any).
+ * This is used to generate badges, the installation guide, and determine what language to
+ * use when surrounding the snippets in a code block.
+ */
+type LanguageInfo = LanguageInfo.Typescript | LanguageInfo.Python | LanguageInfo.Go | LanguageInfo.Java | LanguageInfo.Ruby | LanguageInfo.Csharp | LanguageInfo.Php | LanguageInfo.Rust | LanguageInfo.Swift;
+declare namespace LanguageInfo {
+    interface Typescript extends TypescriptInfo, _Utils {
+        type: "typescript";
+    }
+    interface Python extends PythonInfo, _Utils {
+        type: "python";
+    }
+    interface Go extends GoInfo, _Utils {
+        type: "go";
+    }
+    interface Java extends JavaInfo, _Utils {
+        type: "java";
+    }
+    interface Ruby extends RubyInfo, _Utils {
+        type: "ruby";
+    }
+    interface Csharp extends CsharpInfo, _Utils {
+        type: "csharp";
+    }
+    interface Php extends PhpInfo, _Utils {
+        type: "php";
+    }
+    interface Rust extends RustInfo, _Utils {
+        type: "rust";
+    }
+    interface Swift extends SwiftInfo, _Utils {
+        type: "swift";
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: LanguageInfo._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        typescript: (value: TypescriptInfo) => _Result;
+        python: (value: PythonInfo) => _Result;
+        go: (value: GoInfo) => _Result;
+        java: (value: JavaInfo) => _Result;
+        ruby: (value: RubyInfo) => _Result;
+        csharp: (value: CsharpInfo) => _Result;
+        php: (value: PhpInfo) => _Result;
+        rust: (value: RustInfo) => _Result;
+        swift: (value: SwiftInfo) => _Result;
+        _other: (value: {
+            type: string;
+        }) => _Result;
+    }
+}
+declare const LanguageInfo: {
+    readonly typescript: (value: TypescriptInfo) => LanguageInfo.Typescript;
+    readonly python: (value: PythonInfo) => LanguageInfo.Python;
+    readonly go: (value: GoInfo) => LanguageInfo.Go;
+    readonly java: (value: JavaInfo) => LanguageInfo.Java;
+    readonly ruby: (value: RubyInfo) => LanguageInfo.Ruby;
+    readonly csharp: (value: CsharpInfo) => LanguageInfo.Csharp;
+    readonly php: (value: PhpInfo) => LanguageInfo.Php;
+    readonly rust: (value: RustInfo) => LanguageInfo.Rust;
+    readonly swift: (value: SwiftInfo) => LanguageInfo.Swift;
+    readonly _visit: <_Result>(value: LanguageInfo, visitor: LanguageInfo._Visitor<_Result>) => _Result;
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface TypescriptInfo {
+    publishInfo?: NpmPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface PythonInfo {
+    publishInfo?: PypiPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface GoInfo {
+    publishInfo?: GoPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface JavaInfo {
+    publishInfo?: MavenPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface RubyInfo {
+    publishInfo?: RubyGemsPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface CsharpInfo {
+    publishInfo?: NugetPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface PhpInfo {
+    publishInfo?: ComposerPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface RustInfo {
+    publishInfo?: CargoPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface SwiftInfo {
+    publishInfo?: SwiftPackageManagerPublishInfo;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ComposerPublishInfo {
+    packageName: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface NpmPublishInfo {
+    packageName: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface PypiPublishInfo {
+    packageName: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface GoPublishInfo {
+    owner: string;
+    repo: string;
+    version: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface MavenPublishInfo {
+    artifact: string;
+    group: string;
+    version: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface RubyGemsPublishInfo {
+    packageName: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface NugetPublishInfo {
+    packageName: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface CargoPublishInfo {
+    packageName: string;
+    version: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface SwiftPackageManagerPublishInfo {
+    gitUrl: string;
+    minVersion: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Controls the verbosity of usage examples in README generation
+ */
+type ExampleStyle = "minimal" | "comprehensive";
+declare const ExampleStyle: {
+    readonly Minimal: "minimal";
+    readonly Comprehensive: "comprehensive";
+    readonly _visit: <R>(value: ExampleStyle, visitor: ExampleStyle.Visitor<R>) => R;
+};
+declare namespace ExampleStyle {
+    interface Visitor<R> {
+        minimal: () => R;
+        comprehensive: () => R;
+        _other: () => R;
+    }
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * The information to include within the `reference.md` file generated by the CLI.
+ * The information here should really be all defined by the generator, and not user provided.
+ * We intentionally keep this a bit flexible in the event SDKs structure their package/module
+ * references in a unique way for the same API.
+ */
+interface ReferenceConfig {
+    rootSection?: RootPackageReferenceSection;
+    sections: ReferenceSection[];
+    /** Similar to in README generation, the language property is used to determine the language to use when generating code blocks in markdown. */
+    language: Language;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface RootPackageReferenceSection {
+    description?: string;
+    endpoints: EndpointReference[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface ReferenceSection {
+    title: string;
+    description?: string;
+    endpoints: EndpointReference[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface EndpointReference {
+    /**
+     * The title is a code snippet that is shown when the endpoint's reference is collapsed.
+     * For example, `client.subpackage.method({ ...params }) -> ReturnValue`.
+     */
+    title: MethodInvocationSnippet;
+    description?: string;
+    /**
+     * A "full" snippet, showing all the parameters, with a full example.
+     * ```typescript
+     * await client.subpackage.method({
+     *     expiresIn: 300,
+     * });
+     * ```
+     */
+    snippet: string;
+    parameters: ParameterReference[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * The method invocation snippet is one which appears when the endpoint's reference is collapsed.
+ * It is meant to give a high-level overview of the endpoint -- e.g. the method name and it's return value.
+ * The snippet itself should be a list of concatable content, which the CLI will handle hyperlinking. Note that this
+ * will essentially just be a "".join(snippetParts), so you must handle making sure the right `.`, etc. are in the parts.
+ * Note this is a separate object to make it easier to add additional properties down the road, for example if
+ * we wanted to be specific about what portion of the snippet we hyperlink, etc.
+ */
+interface MethodInvocationSnippet {
+    snippetParts: LinkedText[];
+    returnValue?: LinkedText;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface LinkedText {
+    text: string;
+    location?: RelativeLocation;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface ParameterReference {
+    name: string;
+    description?: string;
+    location?: RelativeLocation;
+    type: string;
+    required: boolean;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface RelativeLocation {
+    /**
+     * A relative location is a path to a file or directory relative to the root of the repository.
+     * This is used to specify a link for a type or a function that the `reference.md` can point users to.
+     */
+    path: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type Language = "JAVA" | "PYTHON" | "GO" | "RUBY" | "CSHARP" | "TYPESCRIPT" | "PHP" | "RUST" | "SWIFT";
+declare const Language: {
+    readonly Java: "JAVA";
+    readonly Python: "PYTHON";
+    readonly Go: "GO";
+    readonly Ruby: "RUBY";
+    readonly Csharp: "CSHARP";
+    readonly Typescript: "TYPESCRIPT";
+    readonly Php: "PHP";
+    readonly Rust: "RUST";
+    readonly Swift: "SWIFT";
+    readonly _visit: <R>(value: Language, visitor: Language.Visitor<R>) => R;
+};
+declare namespace Language {
+    interface Visitor<R> {
+        java: () => R;
+        python: () => R;
+        go: () => R;
+        ruby: () => R;
+        csharp: () => R;
+        typescript: () => R;
+        php: () => R;
+        rust: () => R;
+        swift: () => R;
+        _other: () => R;
+    }
+}
+
+interface GenerateReadmeToStreamParams {
+    originalReadmeContent?: string;
+    readmeConfig: ReadmeConfig;
+    outputStream: fs.WriteStream | NodeJS.Process["stdout"];
+}
+declare function generateReadmeToStream(params: GenerateReadmeToStreamParams): Promise<void>;
+interface GenerateReadmeParams {
+    originalReadmeContent?: string;
+    readmeConfig: ReadmeConfig;
+}
+declare function generateReadme(params: GenerateReadmeParams): Promise<string>;
+
+interface GenerateReferenceToStreamParams {
+    referenceConfig: ReferenceConfig;
+    outputStream: fs.WriteStream | NodeJS.Process["stdout"];
+}
+declare function generateReferenceToStream(params: GenerateReferenceToStreamParams): Promise<void>;
+interface GenerateReferenceParams {
+    referenceConfig: ReferenceConfig;
+}
+declare function generateReference(params: GenerateReferenceParams): Promise<string>;
+
+interface GithubPrParams {
+    githubConfig: GitHubConfig;
+}
+declare function githubPr(params: GithubPrParams): Promise<void>;
+
+interface GithubPushParams {
+    githubConfig: GitHubConfig;
+}
+declare function githubPush(params: GithubPushParams): Promise<void>;
+
+interface GithubReleaseParams {
+    githubConfig: GitHubConfig;
+}
+declare function githubRelease(params: GithubReleaseParams): Promise<void>;
+
+export { type GenerateReadmeParams, type GenerateReadmeToStreamParams, type GenerateReferenceParams, type GenerateReferenceToStreamParams, type GithubPrParams, type GithubPushParams, type GithubReleaseParams, generateReadme, generateReadmeToStream, generateReference, generateReferenceToStream, githubPr, githubPush, githubRelease };