@shipeasy/openapi 1.5.0 → 2.1.0

package/dist/resources/configs.d.ts

@@ -1,681 +0,0 @@
-import { z } from 'zod';
-import { configCreateSchema, configUpdateSchema, configDraftUpsertSchema, configPublishSchema } from '../schemas/configs.js';
-import { PageQuery, Page } from '../schemas/pagination.js';
-import { Transport } from '../transport.js';
-
-/** Use input types so callers can omit fields the server defaults. */
-type ConfigCreateInput = z.input<typeof configCreateSchema>;
-type ConfigUpdateInput = z.input<typeof configUpdateSchema>;
-type ConfigDraftUpsertInput = z.input<typeof configDraftUpsertSchema>;
-type ConfigPublishInput = z.input<typeof configPublishSchema>;
-interface Config {
-    id: string;
-    name: string;
-    description?: string | null;
-    schema: Record<string, unknown>;
-    values?: Record<string, unknown>;
-    drafts?: Record<string, unknown>;
-    updatedAt: string;
-}
-interface ConfigActivityEntry {
-    id: string;
-    action: string;
-    env?: string | null;
-    actor?: string | null;
-    payload?: unknown;
-    createdAt: string;
-}
-interface ConfigsClient {
-    list(opts?: Partial<PageQuery>): Promise<Page<Config>>;
-    listAll(): Promise<Config[]>;
-    get(id: string): Promise<Config>;
-    resolve(idOrName: string): Promise<Config>;
-    create(input: ConfigCreateInput): Promise<Config>;
-    update(id: string, input: ConfigUpdateInput): Promise<Config>;
-    delete(id: string): Promise<{
-        ok: true;
-    }>;
-    /** Save a draft value for the given env (PUT /:id/drafts). */
-    saveDraft(id: string, input: ConfigDraftUpsertInput): Promise<unknown>;
-    /** Discard a draft for the given env (DELETE /:id/drafts with body). */
-    discardDraft(id: string, input: ConfigPublishInput): Promise<unknown>;
-    /** Publish a previously saved draft (POST /:id/publish). */
-    publish(id: string, input: ConfigPublishInput): Promise<unknown>;
-    activity(id: string, limit?: number): Promise<ConfigActivityEntry[]>;
-}
-declare function configsClient(t: Transport): ConfigsClient;
-declare const configsResource: {
-    readonly name: "configs";
-    readonly basePath: "/api/admin/configs";
-    readonly describeOne: "config";
-    readonly describeMany: "configs";
-    readonly tag: {
-        readonly name: "Configs";
-        readonly description: string;
-    };
-    readonly schemas: {
-        readonly create: z.ZodObject<{
-            name: z.ZodString;
-            description: z.ZodOptional<z.ZodString>;
-            folder: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-            value: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnknown, z.ZodRecord<z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>, z.ZodUnknown>]>>;
-        }, z.core.$strip>;
-        readonly update: z.ZodObject<{
-            schema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-            value: z.ZodOptional<z.ZodUnknown>;
-            folder: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        }, z.core.$strip>;
-        readonly saveDraft: z.ZodObject<{
-            env: z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>;
-            value: z.ZodUnknown;
-        }, z.core.$strip>;
-        readonly publish: z.ZodObject<{
-            env: z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>;
-        }, z.core.$strip>;
-    };
-    readonly actions: readonly [{
-        readonly name: "publish";
-        readonly description: "Publish a config draft for an env";
-    }, {
-        readonly name: "saveDraft";
-        readonly description: "Save a draft value for an env";
-    }, {
-        readonly name: "discardDraft";
-        readonly description: "Discard a draft for an env";
-    }];
-    readonly endpoints: readonly [{
-        readonly operationId: "listConfigs";
-        readonly method: "GET";
-        readonly path: "";
-        readonly summary: "List dynamic configs";
-        readonly description: "Returns a single page of configs ordered by `updated_at desc, id desc`. Each row includes the latest published `version` per env and any active drafts.";
-        readonly response: z.ZodObject<{
-            data: z.ZodArray<z.ZodObject<{
-                id: z.ZodString;
-                name: z.ZodString;
-                description: z.ZodNullable<z.ZodString>;
-                schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-                updatedAt: z.ZodString;
-                envs: z.ZodRecord<z.ZodEnum<{
-                    dev: "dev";
-                    staging: "staging";
-                    prod: "prod";
-                }>, z.ZodObject<{
-                    version: z.ZodNumber;
-                    publishedAt: z.ZodString;
-                    publishedBy: z.ZodString;
-                }, z.core.$strip>>;
-                drafts: z.ZodRecord<z.ZodEnum<{
-                    dev: "dev";
-                    staging: "staging";
-                    prod: "prod";
-                }>, z.ZodObject<{
-                    updatedAt: z.ZodString;
-                    authorEmail: z.ZodString;
-                    baseVersion: z.ZodNumber;
-                }, z.core.$strip>>;
-                values: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-                    dev: "dev";
-                    staging: "staging";
-                    prod: "prod";
-                }>, z.ZodUnknown>>;
-                draftValues: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-                    dev: "dev";
-                    staging: "staging";
-                    prod: "prod";
-                }>, z.ZodUnknown>>;
-            }, z.core.$strip>>;
-            next_cursor: z.ZodNullable<z.ZodString>;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly response: {
-                readonly data: readonly [{
-                    id: string;
-                    name: string;
-                    description: string;
-                    schema: {
-                        type: string;
-                        properties: {
-                            tiers: {
-                                type: string;
-                                items: {
-                                    type: string;
-                                };
-                            };
-                        };
-                        required: string[];
-                    };
-                    updatedAt: string;
-                    envs: {
-                        dev: {
-                            version: number;
-                            publishedAt: string;
-                            publishedBy: string;
-                        };
-                        stage: {
-                            version: number;
-                            publishedAt: string;
-                            publishedBy: string;
-                        };
-                        prod: {
-                            version: number;
-                            publishedAt: string;
-                            publishedBy: string;
-                        };
-                    };
-                    drafts: {
-                        dev: {
-                            updatedAt: string;
-                            authorEmail: string;
-                            baseVersion: number;
-                        };
-                    };
-                }];
-                readonly next_cursor: null;
-            };
-        };
-        readonly useCase: "Snapshot every config in the project — e.g. CI check that asserts no env is stuck on a stale default or that every config has a published value on prod.";
-    }, {
-        readonly operationId: "getConfig";
-        readonly method: "GET";
-        readonly path: "/{id}";
-        readonly summary: "Get one config";
-        readonly description: "Returns config metadata plus the latest published values per env and any active draft values. Use this to fetch the JSON the editor renders.";
-        readonly pathParams: {
-            readonly id: "Stable opaque config id (`cfg_…`) or the config's `name`.";
-        };
-        readonly response: z.ZodObject<{
-            id: z.ZodString;
-            name: z.ZodString;
-            description: z.ZodNullable<z.ZodString>;
-            schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-            updatedAt: z.ZodString;
-            envs: z.ZodRecord<z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>, z.ZodObject<{
-                version: z.ZodNumber;
-                publishedAt: z.ZodString;
-                publishedBy: z.ZodString;
-            }, z.core.$strip>>;
-            drafts: z.ZodRecord<z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>, z.ZodObject<{
-                updatedAt: z.ZodString;
-                authorEmail: z.ZodString;
-                baseVersion: z.ZodNumber;
-            }, z.core.$strip>>;
-            values: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>, z.ZodUnknown>>;
-            draftValues: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>, z.ZodUnknown>>;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly response: {
-                readonly values: {
-                    readonly dev: {
-                        readonly tiers: readonly [{
-                            readonly name: "free";
-                        }, {
-                            readonly name: "pro";
-                        }];
-                    };
-                    readonly stage: {
-                        readonly tiers: readonly [{
-                            readonly name: "free";
-                        }, {
-                            readonly name: "pro";
-                        }];
-                    };
-                    readonly prod: {
-                        readonly tiers: readonly [{
-                            readonly name: "free";
-                        }, {
-                            readonly name: "pro";
-                        }];
-                    };
-                };
-                readonly draftValues: {
-                    readonly dev: {
-                        readonly tiers: readonly [{
-                            readonly name: "free";
-                        }, {
-                            readonly name: "pro";
-                        }, {
-                            readonly name: "enterprise";
-                        }];
-                    };
-                };
-                readonly id: string;
-                readonly name: string;
-                readonly description: string;
-                readonly schema: {
-                    type: string;
-                    properties: {
-                        tiers: {
-                            type: string;
-                            items: {
-                                type: string;
-                            };
-                        };
-                    };
-                    required: string[];
-                };
-                readonly updatedAt: string;
-                readonly envs: {
-                    dev: {
-                        version: number;
-                        publishedAt: string;
-                        publishedBy: string;
-                    };
-                    stage: {
-                        version: number;
-                        publishedAt: string;
-                        publishedBy: string;
-                    };
-                    prod: {
-                        version: number;
-                        publishedAt: string;
-                        publishedBy: string;
-                    };
-                };
-                readonly drafts: {
-                    dev: {
-                        updatedAt: string;
-                        authorEmail: string;
-                        baseVersion: number;
-                    };
-                };
-            };
-        };
-        readonly useCase: "Fetch one config's current published values and any in-flight drafts.";
-    }, {
-        readonly operationId: "createConfig";
-        readonly method: "POST";
-        readonly path: "";
-        readonly summary: "Create a dynamic config";
-        readonly description: string;
-        readonly successStatus: 201;
-        readonly request: z.ZodObject<{
-            name: z.ZodString;
-            description: z.ZodOptional<z.ZodString>;
-            folder: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-            value: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnknown, z.ZodRecord<z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>, z.ZodUnknown>]>>;
-        }, z.core.$strip>;
-        readonly response: z.ZodObject<{
-            id: z.ZodString;
-            name: z.ZodString;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly requestExamples: {
-                readonly minimal: {
-                    readonly summary: "Minimal — name + schema";
-                    readonly description: "Smallest valid body. Initial value defaults to `{}` on every env.";
-                    readonly value: {
-                        readonly name: "pricing.tiers";
-                        readonly schema: {
-                            readonly type: "object";
-                            readonly properties: {
-                                readonly tiers: {
-                                    readonly type: "array";
-                                };
-                            };
-                            readonly required: readonly ["tiers"];
-                        };
-                    };
-                };
-                readonly seededValue: {
-                    readonly summary: "Seeded — schema + initial value";
-                    readonly description: "Seed the same JSON object on every env at version 1.";
-                    readonly value: {
-                        readonly name: "pricing.tiers";
-                        readonly description: "Pricing tier definitions consumed by checkout.";
-                        readonly schema: {
-                            readonly type: "object";
-                            readonly properties: {
-                                readonly tiers: {
-                                    readonly type: "array";
-                                };
-                            };
-                            readonly required: readonly ["tiers"];
-                        };
-                        readonly value: {
-                            readonly tiers: readonly [{
-                                readonly name: "free";
-                            }, {
-                                readonly name: "pro";
-                            }];
-                        };
-                    };
-                };
-                readonly perEnvSeed: {
-                    readonly summary: "Per-env seed";
-                    readonly description: "Pass a `{ env: value }` map to seed different initial values per env.";
-                    readonly value: {
-                        readonly name: "pricing.tiers";
-                        readonly schema: {
-                            readonly type: "object";
-                            readonly properties: {
-                                readonly tiers: {
-                                    readonly type: "array";
-                                };
-                            };
-                            readonly required: readonly ["tiers"];
-                        };
-                        readonly value: {
-                            readonly dev: {
-                                readonly tiers: readonly [{
-                                    readonly name: "free";
-                                }, {
-                                    readonly name: "pro";
-                                }, {
-                                    readonly name: "enterprise";
-                                }];
-                            };
-                            readonly stage: {
-                                readonly tiers: readonly [{
-                                    readonly name: "free";
-                                }, {
-                                    readonly name: "pro";
-                                }];
-                            };
-                            readonly prod: {
-                                readonly tiers: readonly [{
-                                    readonly name: "free";
-                                }, {
-                                    readonly name: "pro";
-                                }];
-                            };
-                        };
-                    };
-                };
-            };
-            readonly response: {
-                readonly id: "cfg_01j7wae5h6j7k8l9m0n1p2q3r4";
-                readonly name: "pricing.tiers";
-            };
-        };
-        readonly useCase: string;
-    }, {
-        readonly operationId: "updateConfig";
-        readonly method: "PATCH";
-        readonly path: "/{id}";
-        readonly summary: "Update a dynamic config";
-        readonly description: string;
-        readonly pathParams: {
-            readonly id: "Stable opaque config id.";
-        };
-        readonly request: z.ZodObject<{
-            schema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-            value: z.ZodOptional<z.ZodUnknown>;
-            folder: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        }, z.core.$strip>;
-        readonly response: z.ZodObject<{
-            id: z.ZodString;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly requestExamples: {
-                readonly flatValue: {
-                    readonly summary: "Flat value — republish on every env";
-                    readonly description: "Sets the same JSON object as a new version on dev/stage/prod.";
-                    readonly value: {
-                        readonly value: {
-                            readonly tiers: readonly [{
-                                readonly name: "free";
-                            }, {
-                                readonly name: "pro";
-                            }];
-                        };
-                    };
-                };
-                readonly schemaOnly: {
-                    readonly summary: "Schema-only update";
-                    readonly description: "Replaces the schema. Existing values must still validate or the update fails.";
-                    readonly value: {
-                        readonly schema: {
-                            readonly type: "object";
-                            readonly properties: {
-                                readonly tiers: {
-                                    readonly type: "array";
-                                };
-                                readonly trial_days: {
-                                    readonly type: "integer";
-                                };
-                            };
-                            readonly required: readonly ["tiers"];
-                        };
-                    };
-                };
-            };
-            readonly response: {
-                readonly id: "cfg_01j7wae5h6j7k8l9m0n1p2q3r4";
-            };
-        };
-        readonly useCase: string;
-    }, {
-        readonly operationId: "deleteConfig";
-        readonly method: "DELETE";
-        readonly path: "/{id}";
-        readonly summary: "Delete a dynamic config";
-        readonly description: "Soft-deletes the config and rebuilds the project's flags KV blob.";
-        readonly pathParams: {
-            readonly id: "Stable opaque config id.";
-        };
-        readonly response: z.ZodObject<{
-            ok: z.ZodLiteral<true>;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly response: {
-                readonly ok: true;
-            };
-        };
-        readonly useCase: "Tear down a config after its consumers have stopped reading it.";
-    }, {
-        readonly operationId: "saveConfigDraft";
-        readonly method: "PUT";
-        readonly path: "/{id}/drafts";
-        readonly summary: "Save a draft value";
-        readonly description: string;
-        readonly pathParams: {
-            readonly id: "Stable opaque config id.";
-        };
-        readonly request: z.ZodObject<{
-            env: z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>;
-            value: z.ZodUnknown;
-        }, z.core.$strip>;
-        readonly response: z.ZodObject<{
-            id: z.ZodString;
-            env: z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>;
-            baseVersion: z.ZodNumber;
-            updatedAt: z.ZodString;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly requestExamples: {
-                readonly stageDev: {
-                    readonly summary: "Stage a dev draft";
-                    readonly description: "Stages a new value on dev without touching stage/prod.";
-                    readonly value: {
-                        readonly env: "dev";
-                        readonly value: {
-                            readonly tiers: readonly [{
-                                readonly name: "free";
-                            }, {
-                                readonly name: "pro";
-                            }, {
-                                readonly name: "enterprise";
-                            }];
-                        };
-                    };
-                };
-            };
-            readonly response: {
-                readonly id: "cfg_01j7wae5h6j7k8l9m0n1p2q3r4";
-                readonly env: "dev";
-                readonly baseVersion: 5;
-                readonly updatedAt: "2026-05-10T09:31:00.000Z";
-            };
-        };
-        readonly useCase: "Iterate on a config value on dev without affecting prod — preview in staging, then publish.";
-    }, {
-        readonly operationId: "discardConfigDraft";
-        readonly method: "DELETE";
-        readonly path: "/{id}/drafts";
-        readonly summary: "Discard a draft";
-        readonly description: "Drops the in-flight draft on one env. Published values are unaffected.";
-        readonly pathParams: {
-            readonly id: "Stable opaque config id.";
-        };
-        readonly request: z.ZodObject<{
-            env: z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>;
-        }, z.core.$strip>;
-        readonly response: z.ZodObject<{
-            ok: z.ZodLiteral<true>;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly requestExamples: {
-                readonly discardDev: {
-                    readonly summary: "Discard the dev draft";
-                    readonly description: "Drops the staged dev draft without publishing.";
-                    readonly value: {
-                        readonly env: "dev";
-                    };
-                };
-            };
-            readonly response: {
-                readonly ok: true;
-            };
-        };
-        readonly useCase: "Abandon an in-progress draft after deciding not to ship it.";
-    }, {
-        readonly operationId: "publishConfigDraft";
-        readonly method: "POST";
-        readonly path: "/{id}/publish";
-        readonly summary: "Publish a draft";
-        readonly description: string;
-        readonly pathParams: {
-            readonly id: "Stable opaque config id.";
-        };
-        readonly request: z.ZodObject<{
-            env: z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>;
-        }, z.core.$strip>;
-        readonly response: z.ZodObject<{
-            id: z.ZodString;
-            env: z.ZodEnum<{
-                dev: "dev";
-                staging: "staging";
-                prod: "prod";
-            }>;
-            version: z.ZodNumber;
-        }, z.core.$strip>;
-        readonly examples: {
-            readonly requestExamples: {
-                readonly publishDev: {
-                    readonly summary: "Publish the dev draft";
-                    readonly description: "Promotes the dev draft to a new published version on dev.";
-                    readonly value: {
-                        readonly env: "dev";
-                    };
-                };
-                readonly publishProd: {
-                    readonly summary: "Publish to prod";
-                    readonly description: "Promotes the prod draft after staging signed off.";
-                    readonly value: {
-                        readonly env: "prod";
-                    };
-                };
-            };
-            readonly response: {
-                readonly id: "cfg_01j7wae5h6j7k8l9m0n1p2q3r4";
-                readonly env: "dev";
-                readonly version: 6;
-            };
-        };
-        readonly useCase: "Ship a staged change once you've validated it on a lower env.";
-    }, {
-        readonly operationId: "listConfigActivity";
-        readonly method: "GET";
-        readonly path: "/{id}/activity";
-        readonly summary: "List config activity";
-        readonly description: "Returns recent audit rows for one config (create, update, draft.save, publish, delete) ordered newest first. Use the `limit` query parameter to cap the result (1–100, default 20).";
-        readonly pathParams: {
-            readonly id: "Stable opaque config id.";
-        };
-        readonly queryParams: {
-            readonly limit: {
-                readonly schema: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-                readonly description: "Max rows to return (1–100). Defaults to 20.";
-            };
-        };
-        readonly response: z.ZodArray<z.ZodObject<{
-            id: z.ZodString;
-            action: z.ZodString;
-            actorEmail: z.ZodString;
-            actorType: z.ZodEnum<{
-                user: "user";
-                cli: "cli";
-                system: "system";
-            }>;
-            payload: z.ZodNullable<z.ZodUnknown>;
-            createdAt: z.ZodString;
-        }, z.core.$strip>>;
-        readonly examples: {
-            readonly response: readonly [{
-                readonly id: "act_01j7waf01a2b3c4d5e6f7g8h9i";
-                readonly action: "config.publish";
-                readonly actorEmail: "ana@example.com";
-                readonly actorType: "user";
-                readonly payload: {
-                    readonly env: "dev";
-                    readonly version: 6;
-                };
-                readonly createdAt: "2026-05-10T09:31:42.000Z";
-            }];
-        };
-        readonly useCase: "Render the activity panel in the config editor or drive a slack notification on publish events.";
-    }];
-};
-
-export { type Config, type ConfigActivityEntry, type ConfigCreateInput, type ConfigDraftUpsertInput, type ConfigPublishInput, type ConfigUpdateInput, type ConfigsClient, configsClient, configsResource };