@decohere/scaffold 0.0.1-dev.100

package/types/src/webapi/postman/local-view.d.ts

@@ -0,0 +1,17 @@
+import { type Auth0Env, type PostmanCollection } from "./openapi-to-postman.js";
+/** Local View / Native Git environment (YAML). */
+export declare function buildEnvironmentYaml(name: string, auth: Auth0Env | undefined, options: {
+    callbacks: readonly string[];
+    scopes: string;
+}): string;
+/**
+ * Build Postman Local View multi-file YAML from a v2.1 collection (routes)
+ * plus hand-authored Auth0 overlay.
+ */
+export declare function buildLocalViewFilesFromCollection(collection: PostmanCollection, projectName: string, auth: Auth0Env | undefined, options: {
+    callbacks: readonly string[];
+    scopes: string;
+}): Array<{
+    filePath: string;
+    content: string;
+}>;

package/types/src/webapi/postman/openapi-to-postman.d.ts

@@ -0,0 +1,62 @@
+import type { ScaffoldOpenApiDocument } from "./hello-openapi.js";
+export type PostmanCollection = {
+    info: {
+        _postman_id?: string;
+        name: string;
+        schema: string;
+        description?: string;
+    };
+    auth?: unknown;
+    item?: PostmanItem[];
+    variable?: Array<{
+        key: string;
+        value: string;
+    }>;
+    [key: string]: unknown;
+};
+export type PostmanItem = {
+    name?: string;
+    item?: PostmanItem[];
+    request?: PostmanRequest;
+    [key: string]: unknown;
+};
+export type PostmanRequest = {
+    method?: string;
+    header?: Array<{
+        key: string;
+        value: string;
+    }>;
+    body?: {
+        mode?: string;
+        raw?: string;
+    };
+    url?: string | {
+        raw?: string;
+        host?: string[];
+        path?: string[];
+        variable?: unknown[];
+    };
+    auth?: {
+        type: string;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+};
+export type Auth0Env = {
+    auth0Domain?: string;
+    auth0Audience?: string;
+    auth0ClientId?: string;
+};
+/** Convert an OpenAPI document to a Postman Collection v2.1 via openapi-to-postmanv2. */
+export declare function openApiToPostmanCollection(document: ScaffoldOpenApiDocument): Promise<PostmanCollection>;
+/**
+ * Overlay Auth0 OAuth2 (PKCE) collection auth and fix Local View-friendly URLs.
+ * Route items come from OpenAPI; auth/env remain hand-authored.
+ */
+export declare function applyPostmanAuthOverlay(collection: PostmanCollection, projectName: string, auth: Auth0Env | undefined, options: {
+    callbacks: readonly string[];
+    scopes: string;
+    description: string;
+}): PostmanCollection;
+/** OpenAPI `{id}` → Postman `:id`, without touching `{{variables}}`. */
+export declare function openApiPathParamsToColon(url: string): string;

package/types/src/webapi/workspace-readme.d.ts

@@ -0,0 +1,18 @@
+import type { WorkspaceScaffold } from "../models/project.model.js";
+export type WorkspaceReadmeOptions = {
+    add?: boolean;
+    databaseProvider?: "none" | "postgres/typeorm";
+    authProvider?: "auth0" | "none";
+    postmanProvider?: "api" | "local" | "none";
+};
+export type WorkspaceReadmeInput = {
+    projectName: string;
+    apiNames: readonly string[];
+    hasPostgres: boolean;
+    hasAuth0: boolean;
+    hasPostman: boolean;
+};
+/** Pure renderer — keep feature sections short and copy-paste ready. */
+export declare function renderWorkspaceReadme(input: WorkspaceReadmeInput): string;
+export declare function resolveWorkspaceReadmeInput(workspace: WorkspaceScaffold, options: WorkspaceReadmeOptions): WorkspaceReadmeInput;
+export declare function writeWorkspaceReadme(workspace: WorkspaceScaffold, options: WorkspaceReadmeOptions): void;

package/types/src/webapi.action.d.ts

@@ -0,0 +1,14 @@
+import { type Action, ActionResponse } from "@decohere/nexus/cli";
+export type WebapiOptions = {
+    directory?: string;
+    d?: string;
+    name?: string | string[];
+    database?: string;
+    auth?: string;
+    postman?: string;
+    yes?: boolean;
+    install?: string;
+};
+export declare class WebapiAction implements Action<WebapiOptions> {
+    run(options: WebapiOptions): Promise<ActionResponse>;
+}

package/types/src/webapi.command.d.ts

@@ -0,0 +1,11 @@
+import { DecohereCommand } from "@decohere/nexus/cli";
+import { WebapiAction } from "./webapi.action.js";
+export declare class WebapiCommand extends DecohereCommand {
+    get actions(): (typeof WebapiAction)[];
+    constructor(name: string);
+    /**
+     * Commander passes positional args before options when `[directory]` is declared.
+     * ModuleFactory expects `(opts, cmd)` — stash the directory on the command.
+     */
+    action(fn: (...args: unknown[]) => void | Promise<void>): this;
+}