@shipworthy/openapi-cli 0.0.2 → 1.0.1

package/dist/commands/generate/plugins/standard-schema/plugin.d.ts

@@ -1,7 +0,0 @@
-import { Option, Path } from "effect";
-import { CliError, Command } from "effect/cli";
-export declare const dependencies: readonly [];
-export declare const standardSchema: Command.Command<"standard-schema", {
-    readonly input: URL;
-    readonly output: Option.Option<string>;
-}, {}, CliError.UserError, import("effect/Crypto").Crypto | import("effect/Stdio").Stdio | (import("effect/FileSystem").FileSystem | import("effect/http/HttpClient").HttpClient | Path.Path)>;

package/dist/commands/generate/plugins/standard-schema/plugin.js

@@ -1,44 +0,0 @@
-import { generate as transform } from "@shipworthy/openapi-generator";
-import { Clock, Effect, Option, Path, Result, Schema } from "effect";
-import { Argument, CliError, Command, Flag } from "effect/cli";
-import { asCliError, schemaSource } from "../../../input.js";
-import { publish } from "../../publish.js";
-import { fileHeader, generatorStamp } from "../../stamp.js";
-import { writeStdout } from "../typescript/plugin.js";
-export const dependencies = [];
-const specifier = "@shipworthy/openapi-standard-schema";
-const run = Effect.fn("run")(function* (flags) {
-    const output = Option.getOrUndefined(flags.output);
-    const started = yield* Clock.currentTimeMillis;
-    const decoded = Schema.decodeUnknownResult(Schema.String)(yield* transform({
-        specifier,
-        exportName: "standardSchema",
-        source: flags.input,
-    }));
-    if (Result.isFailure(decoded)) {
-        return yield* new CliError.UserError({ cause: decoded.failure });
-    }
-    const text = `${fileHeader(yield* generatorStamp(specifier, flags.input))}${decoded.success}`;
-    if (!output) {
-        yield* writeStdout(text);
-        return;
-    }
-    const path = yield* Path.Path;
-    yield* publish({
-        result: text,
-        outputPath: path.resolve(output),
-        check: false,
-        label: flags.input.href,
-        outputLabel: output,
-        started,
-    });
-}, Effect.mapError(asCliError));
-export const standardSchema = Command.make("standard-schema", {
-    input: Argument.String("input").pipe(Argument.withDescription("OpenAPI schema file or URL."), Argument.mapEffect(schemaSource)),
-    output: Flag.String("output").pipe(Flag.withAlias("o"), Flag.withDescription("Output file. Writes to stdout when omitted."), Flag.optional),
-}, run).pipe(Command.withDescription("Generate Standard Schema validators from an OpenAPI schema."), Command.withShortDescription("Generate Standard Schema validators"), Command.withExamples([
-    {
-        command: "openapi generate standard-schema ./openapi.yaml -o ./schemas.ts",
-        description: "Write Standard Schema validators",
-    },
-]));

package/dist/commands/generate/plugins/tanstack-query/plugin.d.ts

@@ -1,9 +0,0 @@
-import { Path } from "effect";
-import { CliError, Command } from "effect/cli";
-export declare const dependencies: readonly ["typescript"];
-export declare const tanstackQuery: Command.Command<"tanstack-query", {
-    readonly input: URL;
-    readonly output: string;
-    readonly name: string;
-    readonly force: boolean;
-}, {}, CliError.UserError, import("effect/Crypto").Crypto | import("effect/Stdio").Stdio | (import("effect/FileSystem").FileSystem | import("effect/http/HttpClient").HttpClient | Path.Path)>;

package/dist/commands/generate/plugins/tanstack-query/plugin.js

@@ -1,42 +0,0 @@
-import { generate as transform } from "@shipworthy/openapi-generator";
-import { Clock, Effect, Path, Result, Schema } from "effect";
-import { Argument, CliError, Command, Flag } from "effect/cli";
-import { asCliError, schemaSource } from "../../../input.js";
-import { ensureDependencies } from "../../ensure.js";
-import { force } from "../../force.js";
-import { ClientName, pascalCase, writeGenerated } from "../../files.js";
-import { fileHeader, generatorStamp } from "../../stamp.js";
-export const dependencies = ["typescript"];
-const specifier = "@shipworthy/openapi-tanstack-query/generator";
-const run = Effect.fn("run")(function* (flags) {
-    const started = yield* Clock.currentTimeMillis;
-    const path = yield* Path.Path;
-    yield* ensureDependencies(dependencies, {
-        source: flags.input,
-        directory: path.resolve(flags.output, flags.name),
-        started,
-        force: flags.force,
-    });
-    const decoded = Schema.decodeUnknownResult(Schema.String)(yield* transform({
-        specifier,
-        exportName: "tanstackQuery",
-        source: flags.input,
-        pluginOptions: { prefix: pascalCase(flags.name), name: flags.name },
-    }));
-    if (Result.isFailure(decoded)) {
-        return yield* new CliError.UserError({ cause: decoded.failure });
-    }
-    const header = fileHeader(yield* generatorStamp(specifier, flags.input));
-    yield* writeGenerated(flags.output, flags.name, { "client.ts": `${header}${decoded.success}` });
-}, Effect.mapError(asCliError));
-export const tanstackQuery = Command.make("tanstack-query", {
-    input: Argument.String("input").pipe(Argument.withDescription("OpenAPI schema file or URL."), Argument.mapEffect(schemaSource)),
-    output: Flag.String("output").pipe(Flag.withAlias("o"), Flag.withDescription("Directory that will contain <name>/client.ts.")),
-    name: Flag.String("name").pipe(Flag.withDescription("Client name. Used as the output directory and the generated function prefix."), Flag.withSchema(ClientName)),
-    force,
-}, run).pipe(Command.withDescription("Generate TanStack Query utils from an OpenAPI schema."), Command.withShortDescription("Generate TanStack Query utils"), Command.withExamples([
-    {
-        command: "openapi generate tanstack-query ./openapi.yaml -o ./src/generated --name hotels",
-        description: "Write hotels/client.ts",
-    },
-]));

package/dist/commands/generate/plugins/typescript/plugin.d.ts

@@ -1,32 +0,0 @@
-import { Effect, Option, Path, Stdio } from "effect";
-import { CliError, Command } from "effect/cli";
-import { type TypeFlags } from "./flags.ts";
-export declare const dependencies: readonly [];
-export declare const typescriptSpecifier = "@shipworthy/openapi-typescript";
-export declare const writeStdout: (text: string) => Effect.Effect<void, import("effect/PlatformError").PlatformError, Stdio.Stdio>;
-export declare const renderTypescript: (options: {
-    readonly source: URL | string;
-    readonly generator: {
-        readonly name: string;
-        readonly stamp: string;
-    };
-    readonly outputPath?: string;
-    readonly flags: TypeFlags;
-    readonly check: boolean;
-    readonly label: string;
-    readonly outputLabel: string;
-    readonly started: number;
-}) => Effect.Effect<void, import("effect/PlatformError").BadArgument | import("effect/PlatformError").PlatformError | import("effect/Schema").SchemaError | CliError.UserError | import("@shipworthy/openapi-generator").GenerateError, Stdio.Stdio | (import("effect/FileSystem").FileSystem | import("effect/http/HttpClient").HttpClient | Path.Path)>;
-export declare const typescript: Command.Command<"typescript", {
-    readonly enum: boolean;
-    readonly enumValues: boolean;
-    readonly conditionalEnums: boolean;
-    readonly dedupeEnums: boolean;
-    readonly exportType: boolean;
-    readonly arrayLength: boolean;
-    readonly rootTypes: boolean;
-    readonly readWriteMarkers: boolean;
-    readonly input: Option.Option<URL>;
-    readonly output: Option.Option<string>;
-    readonly check: boolean;
-}, {}, CliError.UserError, import("effect/Crypto").Crypto | Stdio.Stdio | (import("effect/FileSystem").FileSystem | import("effect/http/HttpClient").HttpClient | Path.Path)>;

package/dist/commands/generate/plugins/typescript/plugin.js

@@ -1,84 +0,0 @@
-import { generate as transform } from "@shipworthy/openapi-generator";
-import { Clock, Console, Effect, Option, Path, Stdio, Stream } from "effect";
-import { Argument, CliError, Command, Flag } from "effect/cli";
-import { asCliError, schemaSource } from "../../../input.js";
-import { version } from "../../../../version.js";
-import { publish } from "../../publish.js";
-import { fileHeader, generatorStamp } from "../../stamp.js";
-import { pluginOptions, typeFlags } from "./flags.js";
-export const dependencies = [];
-export const typescriptSpecifier = "@shipworthy/openapi-typescript";
-const typescriptModule = Effect.fn("typescriptModule")(function* () {
-    return yield* Effect.tryPromise({
-        try: () => import("@shipworthy/openapi-typescript"),
-        catch: (cause) => new CliError.UserError({ cause }),
-    });
-});
-const readStdin = Effect.fn("readStdin")(function* () {
-    const stdio = yield* Stdio.Stdio;
-    return yield* stdio.stdin.pipe(Stream.decodeText(), Stream.mkString);
-});
-export const writeStdout = Effect.fn("writeStdout")(function* (text) {
-    const stdio = yield* Stdio.Stdio;
-    yield* Stream.run(Stream.make(text), stdio.stdout({ endOnDone: false }));
-});
-export const renderTypescript = Effect.fn("renderTypescript")(function* (options) {
-    if (options.outputPath)
-        yield* Console.info(`openapi generate typescript ${yield* version}`);
-    const nodes = yield* transform({
-        specifier: typescriptSpecifier,
-        exportName: "typescript",
-        source: options.source,
-        pluginOptions: pluginOptions({ ...options.flags, silent: options.outputPath === undefined }),
-    });
-    const types = yield* typescriptModule();
-    // Print each top-level declaration on its own so a blank line separates them.
-    const body = nodes.map((node) => types.astToString([node])).join("\n");
-    const printed = yield* Effect.tryPromise({
-        try: () => types.formatTypeScript(`${fileHeader(options.generator)}${body}`),
-        catch: (cause) => new CliError.UserError({ cause }),
-    });
-    if (!options.outputPath) {
-        yield* writeStdout(printed);
-        return;
-    }
-    yield* publish({
-        result: printed,
-        outputPath: options.outputPath,
-        check: options.check,
-        label: options.label,
-        outputLabel: options.outputLabel,
-        started: options.started,
-    });
-});
-const run = Effect.fn("run")(function* (flags) {
-    const output = Option.getOrUndefined(flags.output);
-    const input = Option.getOrUndefined(flags.input);
-    const started = yield* Clock.currentTimeMillis;
-    const path = yield* Path.Path;
-    const source = input ?? (yield* readStdin());
-    yield* renderTypescript({
-        source,
-        generator: yield* generatorStamp(typescriptSpecifier, source),
-        outputPath: output === undefined ? undefined : path.resolve(output),
-        flags,
-        check: flags.check,
-        label: input?.href ?? "stdin",
-        outputLabel: output ?? "stdout",
-        started,
-    });
-}, Effect.mapError(asCliError));
-export const typescript = Command.make("typescript", {
-    input: Argument.String("input").pipe(Argument.withDescription("OpenAPI schema file or URL. Omit to read stdin."), Argument.optional, Argument.mapEffect((input) => Option.match(input, {
-        onNone: () => Effect.succeed(Option.none()),
-        onSome: (value) => Effect.asSome(schemaSource(value)),
-    }))),
-    output: Flag.String("output").pipe(Flag.withAlias("o"), Flag.withDescription("Output file. Writes to stdout when omitted."), Flag.optional),
-    check: Flag.Boolean("check").pipe(Flag.withDescription("Check that the generated types are up-to-date."), Flag.withDefault(false)),
-    ...typeFlags,
-}, run).pipe(Command.withDescription("Convert an OpenAPI schema to TypeScript."), Command.withShortDescription("Generate TypeScript types"), Command.withExamples([
-    {
-        command: "openapi generate typescript ./openapi.yaml -o ./schema.ts",
-        description: "Write TypeScript types for a local schema",
-    },
-]));

package/dist/commands/generate/plugins/zod/plugin.d.ts

@@ -1,8 +0,0 @@
-import { Path } from "effect";
-import { CliError, Command } from "effect/cli";
-export declare const dependencies: readonly ["typescript"];
-export declare const zod: Command.Command<"zod", {
-    readonly input: URL;
-    readonly output: string;
-    readonly force: boolean;
-}, {}, CliError.UserError, import("effect/Crypto").Crypto | import("effect/Stdio").Stdio | (import("effect/FileSystem").FileSystem | import("effect/http/HttpClient").HttpClient | Path.Path)>;

package/dist/commands/generate/plugins/zod/plugin.js

@@ -1,48 +0,0 @@
-import { generate as transform } from "@shipworthy/openapi-generator";
-import { Clock, Effect, Path, Result, Schema } from "effect";
-import { Argument, CliError, Command, Flag } from "effect/cli";
-import { asCliError, schemaSource } from "../../../input.js";
-import { ensureDependencies } from "../../ensure.js";
-import { force } from "../../force.js";
-import { publish } from "../../publish.js";
-import { fileHeader, generatorStamp } from "../../stamp.js";
-export const dependencies = ["typescript"];
-const specifier = "@shipworthy/openapi-zod";
-const run = Effect.fn("run")(function* (flags) {
-    const started = yield* Clock.currentTimeMillis;
-    const path = yield* Path.Path;
-    const outputPath = path.resolve(flags.output);
-    yield* ensureDependencies(dependencies, {
-        source: flags.input,
-        directory: path.dirname(outputPath),
-        started,
-        force: flags.force,
-    });
-    const decoded = Schema.decodeUnknownResult(Schema.String)(yield* transform({
-        specifier,
-        exportName: "zod",
-        source: flags.input,
-    }));
-    if (Result.isFailure(decoded)) {
-        return yield* new CliError.UserError({ cause: decoded.failure });
-    }
-    const header = fileHeader(yield* generatorStamp(specifier, flags.input));
-    yield* publish({
-        result: `${header}${decoded.success}`,
-        outputPath,
-        check: false,
-        label: flags.input.href,
-        outputLabel: flags.output,
-        started,
-    });
-}, Effect.mapError(asCliError));
-export const zod = Command.make("zod", {
-    input: Argument.String("input").pipe(Argument.withDescription("OpenAPI schema file or URL."), Argument.mapEffect(schemaSource)),
-    output: Flag.String("output").pipe(Flag.withAlias("o"), Flag.withDescription("Output file. types.ts is written next to it.")),
-    force,
-}, run).pipe(Command.withDescription("Generate Zod validators from an OpenAPI schema."), Command.withShortDescription("Generate Zod validators"), Command.withExamples([
-    {
-        command: "openapi generate zod ./openapi.yaml -o ./src/generated/hotels/zod-schema.ts",
-        description: "Write hotels/zod-schema.ts and hotels/types.ts",
-    },
-]));

package/dist/commands/generate/publish.d.ts

@@ -1,11 +0,0 @@
-import { Effect, FileSystem, Path } from "effect";
-import { CliError } from "effect/cli";
-export declare function formatTime(t: number): string;
-export declare const publish: (options: {
-    readonly result: string;
-    readonly outputPath: string;
-    readonly check: boolean;
-    readonly label: string;
-    readonly outputLabel: string;
-    readonly started: number;
-}) => Effect.Effect<undefined, import("effect/PlatformError").PlatformError | CliError.UserError, FileSystem.FileSystem | Path.Path>;

package/dist/commands/generate/publish.js

@@ -1,23 +0,0 @@
-import { Clock, Console, Effect, FileSystem, Path } from "effect";
-import { CliError } from "effect/cli";
-export function formatTime(t) {
-    if (t < 1000)
-        return `${Math.round(10 * t) / 10}ms`;
-    if (t < 60000)
-        return `${Math.round(t / 100) / 10}s`;
-    return `${Math.round(t / 6000) / 10}m`;
-}
-export const publish = Effect.fn("publish")(function* (options) {
-    const fs = yield* FileSystem.FileSystem;
-    const path = yield* Path.Path;
-    if (options.check) {
-        const previous = yield* fs.readFileString(options.outputPath);
-        if (previous === options.result)
-            return;
-        return yield* new CliError.UserError({ cause: "Generated types are not up-to-date!" });
-    }
-    yield* fs.makeDirectory(path.dirname(options.outputPath), { recursive: true });
-    yield* fs.writeFileString(options.outputPath, options.result);
-    const elapsed = (yield* Clock.currentTimeMillis) - options.started;
-    yield* Console.log(`${options.label} → ${options.outputLabel} [${formatTime(elapsed)}]`);
-});