@crowdedkingdoms/crowdyjs 1.0.0

package/dist/domains/controlPlane.d.ts

@@ -0,0 +1,174 @@
+import type { GraphQLClient } from '../client.js';
+import { type CpEnvironmentsQuery, type CpEnvironmentQuery, type CpChangeOrdersQuery, type CpChangeOrderQuery, type CpAuditQuery, type CpSecretsQuery, type CpEnvSecretsQuery, type CpOvhCatalogSummaryQuery, type CpUsageSummaryQuery, type CpUnreleasedGameApiTagsQuery, type CpEnvironmentVersionsQuery, type OperatorUsersQuery, type SetEnvironmentDeletionProtectionMutation, type PutCpSecretMutation, type DeleteCpSecretMutation, type PutCpEnvSecretMutation, type IngestEnvironmentVersionMutation, type PublishEnvironmentReleaseFromGameApiTagMutation, type YankEnvironmentVersionMutation, type IngestEnvironmentVersionInput, type PublishEnvironmentReleaseFromGameApiTagInput } from '../generated/graphql.js';
+/**
+ * Operator (control-plane) surface — exposed as `client.operator`.
+ *
+ * Targets the **management-api**. EVERY operation here requires
+ * `users.is_operator` (super-admins implicitly have it). This is the privileged
+ * platform-operations surface (cross-org environment administration, secrets,
+ * release management) and is NOT for end users. Mutations write audit entries
+ * and several have real side effects (GitHub commits, deploy retargeting).
+ *
+ * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` without a session, `FORBIDDEN`
+ *   when the caller is not an operator.
+ */
+export declare class ControlPlaneAPI {
+    private readonly management;
+    constructor(management: GraphQLClient);
+    /**
+     * Paginated list of every environment across all orgs (1-based paging).
+     *
+     * @param opts - Optional `page` (default 1) and `pageSize` (default 50).
+     * @returns A page of operator environment rows.
+     */
+    environments(opts?: {
+        page?: number;
+        pageSize?: number;
+    }): Promise<CpEnvironmentsQuery['cpEnvironments']>;
+    /**
+     * Operator view of one environment by slug (across any org).
+     *
+     * @param slug - Environment slug.
+     * @returns The environment row, or `null` if not found.
+     */
+    environment(slug: string): Promise<CpEnvironmentQuery['cpEnvironment']>;
+    /**
+     * Paginated change orders, optionally filtered by environment.
+     *
+     * @param opts - Optional `environmentId` filter, `page`, `pageSize`.
+     * @returns A page of change-order rows.
+     */
+    changeOrders(opts?: {
+        environmentId?: string;
+        page?: number;
+        pageSize?: number;
+    }): Promise<CpChangeOrdersQuery['cpChangeOrders']>;
+    /**
+     * One change order with its tasks and steps.
+     *
+     * @param id - Change order UUID.
+     * @returns The change-order detail, or `null` if not found.
+     */
+    changeOrder(id: string): Promise<CpChangeOrderQuery['cpChangeOrder']>;
+    /**
+     * Most recent operator audit entries (newest first), optionally filtered.
+     *
+     * @param opts - Optional `environmentId` filter and `limit` (default 200).
+     * @returns The audit entries.
+     */
+    audit(opts?: {
+        environmentId?: string;
+        limit?: number;
+    }): Promise<CpAuditQuery['cpAudit']>;
+    /**
+     * Control-plane secret metadata (names/kinds only, never plaintext).
+     *
+     * @param environmentId - Optional environment UUID filter.
+     * @returns The secret metadata rows.
+     */
+    secrets(environmentId?: string): Promise<CpSecretsQuery['cpSecrets']>;
+    /**
+     * Environment-delivered secret metadata (names/kinds only, never plaintext).
+     *
+     * @param environmentId - Optional environment UUID filter.
+     * @returns The env-secret metadata rows.
+     */
+    envSecrets(environmentId?: string): Promise<CpEnvSecretsQuery['cpEnvSecrets']>;
+    /**
+     * OVH flavor catalog with provider vs. customer pricing.
+     *
+     * @param region - Optional region code filter (e.g. `'GRA11'`).
+     * @returns The catalog rows.
+     */
+    ovhCatalogSummary(region?: string): Promise<CpOvhCatalogSummaryQuery['cpOvhCatalogSummary']>;
+    /**
+     * Operator per-minute usage summary for any environment (not org-scoped).
+     *
+     * @param environmentSlug - Environment slug.
+     * @param since - Start of the window (ISO-8601 DateTime) up to now.
+     * @returns The usage summary.
+     */
+    usageSummary(environmentSlug: string, since: string): Promise<CpUsageSummaryQuery['cpUsageSummary']>;
+    /**
+     * cks-game-api git tags not yet pinned by any environment release.
+     *
+     * @returns The unreleased tags with proposed versions.
+     */
+    unreleasedGameApiTags(): Promise<CpUnreleasedGameApiTagsQuery['cpUnreleasedGameApiTags']>;
+    /**
+     * Environment release manifests merged from git + DB.
+     *
+     * @returns The version rows with latest-available and git-source flags.
+     */
+    environmentVersions(): Promise<CpEnvironmentVersionsQuery['cpEnvironmentVersions']>;
+    /**
+     * List users with operator and/or super-admin privileges.
+     *
+     * @returns The privileged users.
+     */
+    operatorUsers(): Promise<OperatorUsersQuery['operatorUsers']>;
+    /**
+     * Toggle deletion protection on an environment (blocks purge when enabled).
+     * Writes an audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param enabled - `true` to protect, `false` to unprotect.
+     * @returns `true` on success.
+     */
+    setDeletionProtection(environmentId: string, enabled: boolean): Promise<SetEnvironmentDeletionProtectionMutation['setEnvironmentDeletionProtection']>;
+    /**
+     * Create/overwrite a control-plane secret (plaintext is write-only). Writes an
+     * audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param name - Secret name/key.
+     * @param plaintext - Secret value to encrypt and store.
+     * @param kind - Optional classification tag.
+     * @returns The secret metadata row.
+     */
+    putSecret(environmentId: string, name: string, plaintext: string, kind?: string): Promise<PutCpSecretMutation['putCpSecret']>;
+    /**
+     * Delete a control-plane secret by environment + name. Writes an audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param name - Secret name/key to delete.
+     * @returns `true` when a secret was removed.
+     */
+    deleteSecret(environmentId: string, name: string): Promise<DeleteCpSecretMutation['deleteCpSecret']>;
+    /**
+     * Create/overwrite an environment-delivered secret (injected into the tenant
+     * runtime; plaintext is write-only). Writes an audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param name - Secret name/key.
+     * @param plaintext - Secret value to encrypt and store.
+     * @param kind - Optional classification tag.
+     * @returns The env-secret metadata row.
+     */
+    putEnvSecret(environmentId: string, name: string, plaintext: string, kind?: string): Promise<PutCpEnvSecretMutation['putCpEnvSecret']>;
+    /**
+     * Ingest a release manifest into the deployable catalog. Writes an audit
+     * entry.
+     *
+     * @param input - {@link IngestEnvironmentVersionInput} (version, force).
+     * @returns The ingested version row.
+     */
+    ingestEnvironmentVersion(input: IngestEnvironmentVersionInput): Promise<IngestEnvironmentVersionMutation['ingestEnvironmentVersion']>;
+    /**
+     * Cut a new environment release from a cks-game-api git tag (ingests + commits
+     * the manifest to git). SIDE EFFECT: retargets redeploy and writes to GitHub.
+     *
+     * @param input - {@link PublishEnvironmentReleaseFromGameApiTagInput}.
+     * @returns The publish result.
+     */
+    publishReleaseFromGameApiTag(input: PublishEnvironmentReleaseFromGameApiTagInput): Promise<PublishEnvironmentReleaseFromGameApiTagMutation['publishEnvironmentReleaseFromGameApiTag']>;
+    /**
+     * Yank (withdraw) an environment version so it can no longer be deployed.
+     * Existing environments are unaffected. Writes an audit entry.
+     *
+     * @param version - Environment version to yank (e.g. `'v0.1.4'`).
+     * @returns `true` on success.
+     */
+    yankEnvironmentVersion(version: string): Promise<YankEnvironmentVersionMutation['yankEnvironmentVersion']>;
+}
+//# sourceMappingURL=controlPlane.d.ts.map

package/dist/domains/controlPlane.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controlPlane.d.ts","sourceRoot":"","sources":["../../src/domains/controlPlane.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAoBL,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EACvB,KAAK,wCAAwC,EAC7C,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,gCAAgC,EACrC,KAAK,+CAA+C,EACpD,KAAK,8BAA8B,EACnC,KAAK,6BAA6B,EAClC,KAAK,4CAA4C,EAClD,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,aAAa;IAEtD;;;;;OAKG;IACG,YAAY,CAChB,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAC9C,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAQjD;;;;;OAKG;IACG,WAAW,CACf,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAK/C;;;;;OAKG;IACG,YAAY,CAChB,IAAI,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GACtE,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IASjD;;;;;OAKG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAK/C;;;;;OAKG;IACG,KAAK,CACT,IAAI,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GACpD,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAQnC;;;;;OAKG;IACG,OAAO,CACX,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAOvC;;;;;OAKG;IACG,UAAU,CACd,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAO7C;;;;;OAKG;IACG,iBAAiB,CACrB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC;IAO3D;;;;;;OAMG;IACG,YAAY,CAChB,eAAe,EAAE,MAAM,EACvB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAQjD;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CACpC,4BAA4B,CAAC,yBAAyB,CAAC,CACxD;IAQD;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAClC,0BAA0B,CAAC,uBAAuB,CAAC,CACpD;IAQD;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAKnE;;;;;;;OAOG;IACG,qBAAqB,CACzB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO,GACf,OAAO,CACR,wCAAwC,CAAC,kCAAkC,CAAC,CAC7E;IAQD;;;;;;;;;OASG;IACG,SAAS,CACb,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAU9C;;;;;;OAMG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IAQpD;;;;;;;;;OASG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IAUpD;;;;;;OAMG;IACG,wBAAwB,CAC5B,KAAK,EAAE,6BAA6B,GACnC,OAAO,CAAC,gCAAgC,CAAC,0BAA0B,CAAC,CAAC;IAQxE;;;;;;OAMG;IACG,4BAA4B,CAChC,KAAK,EAAE,4CAA4C,GAClD,OAAO,CACR,+CAA+C,CAAC,yCAAyC,CAAC,CAC3F;IAQD;;;;;;OAMG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,8BAA8B,CAAC,wBAAwB,CAAC,CAAC;CAOrE"}

package/dist/domains/controlPlane.js

@@ -0,0 +1,252 @@
+import { CpEnvironmentsDocument, CpEnvironmentDocument, CpChangeOrdersDocument, CpChangeOrderDocument, CpAuditDocument, CpSecretsDocument, CpEnvSecretsDocument, CpOvhCatalogSummaryDocument, CpUsageSummaryDocument, CpUnreleasedGameApiTagsDocument, CpEnvironmentVersionsDocument, OperatorUsersDocument, SetEnvironmentDeletionProtectionDocument, PutCpSecretDocument, DeleteCpSecretDocument, PutCpEnvSecretDocument, IngestEnvironmentVersionDocument, PublishEnvironmentReleaseFromGameApiTagDocument, YankEnvironmentVersionDocument, } from '../generated/graphql.js';
+/**
+ * Operator (control-plane) surface — exposed as `client.operator`.
+ *
+ * Targets the **management-api**. EVERY operation here requires
+ * `users.is_operator` (super-admins implicitly have it). This is the privileged
+ * platform-operations surface (cross-org environment administration, secrets,
+ * release management) and is NOT for end users. Mutations write audit entries
+ * and several have real side effects (GitHub commits, deploy retargeting).
+ *
+ * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` without a session, `FORBIDDEN`
+ *   when the caller is not an operator.
+ */
+export class ControlPlaneAPI {
+    constructor(management) {
+        this.management = management;
+    }
+    /**
+     * Paginated list of every environment across all orgs (1-based paging).
+     *
+     * @param opts - Optional `page` (default 1) and `pageSize` (default 50).
+     * @returns A page of operator environment rows.
+     */
+    async environments(opts = {}) {
+        const data = await this.management.request(CpEnvironmentsDocument, {
+            page: opts.page,
+            pageSize: opts.pageSize,
+        });
+        return data.cpEnvironments;
+    }
+    /**
+     * Operator view of one environment by slug (across any org).
+     *
+     * @param slug - Environment slug.
+     * @returns The environment row, or `null` if not found.
+     */
+    async environment(slug) {
+        const data = await this.management.request(CpEnvironmentDocument, { slug });
+        return data.cpEnvironment;
+    }
+    /**
+     * Paginated change orders, optionally filtered by environment.
+     *
+     * @param opts - Optional `environmentId` filter, `page`, `pageSize`.
+     * @returns A page of change-order rows.
+     */
+    async changeOrders(opts = {}) {
+        const data = await this.management.request(CpChangeOrdersDocument, {
+            environmentId: opts.environmentId,
+            page: opts.page,
+            pageSize: opts.pageSize,
+        });
+        return data.cpChangeOrders;
+    }
+    /**
+     * One change order with its tasks and steps.
+     *
+     * @param id - Change order UUID.
+     * @returns The change-order detail, or `null` if not found.
+     */
+    async changeOrder(id) {
+        const data = await this.management.request(CpChangeOrderDocument, { id });
+        return data.cpChangeOrder;
+    }
+    /**
+     * Most recent operator audit entries (newest first), optionally filtered.
+     *
+     * @param opts - Optional `environmentId` filter and `limit` (default 200).
+     * @returns The audit entries.
+     */
+    async audit(opts = {}) {
+        const data = await this.management.request(CpAuditDocument, {
+            environmentId: opts.environmentId,
+            limit: opts.limit,
+        });
+        return data.cpAudit;
+    }
+    /**
+     * Control-plane secret metadata (names/kinds only, never plaintext).
+     *
+     * @param environmentId - Optional environment UUID filter.
+     * @returns The secret metadata rows.
+     */
+    async secrets(environmentId) {
+        const data = await this.management.request(CpSecretsDocument, {
+            environmentId,
+        });
+        return data.cpSecrets;
+    }
+    /**
+     * Environment-delivered secret metadata (names/kinds only, never plaintext).
+     *
+     * @param environmentId - Optional environment UUID filter.
+     * @returns The env-secret metadata rows.
+     */
+    async envSecrets(environmentId) {
+        const data = await this.management.request(CpEnvSecretsDocument, {
+            environmentId,
+        });
+        return data.cpEnvSecrets;
+    }
+    /**
+     * OVH flavor catalog with provider vs. customer pricing.
+     *
+     * @param region - Optional region code filter (e.g. `'GRA11'`).
+     * @returns The catalog rows.
+     */
+    async ovhCatalogSummary(region) {
+        const data = await this.management.request(CpOvhCatalogSummaryDocument, {
+            region,
+        });
+        return data.cpOvhCatalogSummary;
+    }
+    /**
+     * Operator per-minute usage summary for any environment (not org-scoped).
+     *
+     * @param environmentSlug - Environment slug.
+     * @param since - Start of the window (ISO-8601 DateTime) up to now.
+     * @returns The usage summary.
+     */
+    async usageSummary(environmentSlug, since) {
+        const data = await this.management.request(CpUsageSummaryDocument, {
+            environmentSlug,
+            since,
+        });
+        return data.cpUsageSummary;
+    }
+    /**
+     * cks-game-api git tags not yet pinned by any environment release.
+     *
+     * @returns The unreleased tags with proposed versions.
+     */
+    async unreleasedGameApiTags() {
+        const data = await this.management.request(CpUnreleasedGameApiTagsDocument, {});
+        return data.cpUnreleasedGameApiTags;
+    }
+    /**
+     * Environment release manifests merged from git + DB.
+     *
+     * @returns The version rows with latest-available and git-source flags.
+     */
+    async environmentVersions() {
+        const data = await this.management.request(CpEnvironmentVersionsDocument, {});
+        return data.cpEnvironmentVersions;
+    }
+    /**
+     * List users with operator and/or super-admin privileges.
+     *
+     * @returns The privileged users.
+     */
+    async operatorUsers() {
+        const data = await this.management.request(OperatorUsersDocument, {});
+        return data.operatorUsers;
+    }
+    /**
+     * Toggle deletion protection on an environment (blocks purge when enabled).
+     * Writes an audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param enabled - `true` to protect, `false` to unprotect.
+     * @returns `true` on success.
+     */
+    async setDeletionProtection(environmentId, enabled) {
+        const data = await this.management.request(SetEnvironmentDeletionProtectionDocument, { environmentId, enabled });
+        return data.setEnvironmentDeletionProtection;
+    }
+    /**
+     * Create/overwrite a control-plane secret (plaintext is write-only). Writes an
+     * audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param name - Secret name/key.
+     * @param plaintext - Secret value to encrypt and store.
+     * @param kind - Optional classification tag.
+     * @returns The secret metadata row.
+     */
+    async putSecret(environmentId, name, plaintext, kind) {
+        const data = await this.management.request(PutCpSecretDocument, {
+            environmentId,
+            name,
+            plaintext,
+            kind,
+        });
+        return data.putCpSecret;
+    }
+    /**
+     * Delete a control-plane secret by environment + name. Writes an audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param name - Secret name/key to delete.
+     * @returns `true` when a secret was removed.
+     */
+    async deleteSecret(environmentId, name) {
+        const data = await this.management.request(DeleteCpSecretDocument, {
+            environmentId,
+            name,
+        });
+        return data.deleteCpSecret;
+    }
+    /**
+     * Create/overwrite an environment-delivered secret (injected into the tenant
+     * runtime; plaintext is write-only). Writes an audit entry.
+     *
+     * @param environmentId - Environment UUID.
+     * @param name - Secret name/key.
+     * @param plaintext - Secret value to encrypt and store.
+     * @param kind - Optional classification tag.
+     * @returns The env-secret metadata row.
+     */
+    async putEnvSecret(environmentId, name, plaintext, kind) {
+        const data = await this.management.request(PutCpEnvSecretDocument, {
+            environmentId,
+            name,
+            plaintext,
+            kind,
+        });
+        return data.putCpEnvSecret;
+    }
+    /**
+     * Ingest a release manifest into the deployable catalog. Writes an audit
+     * entry.
+     *
+     * @param input - {@link IngestEnvironmentVersionInput} (version, force).
+     * @returns The ingested version row.
+     */
+    async ingestEnvironmentVersion(input) {
+        const data = await this.management.request(IngestEnvironmentVersionDocument, { input });
+        return data.ingestEnvironmentVersion;
+    }
+    /**
+     * Cut a new environment release from a cks-game-api git tag (ingests + commits
+     * the manifest to git). SIDE EFFECT: retargets redeploy and writes to GitHub.
+     *
+     * @param input - {@link PublishEnvironmentReleaseFromGameApiTagInput}.
+     * @returns The publish result.
+     */
+    async publishReleaseFromGameApiTag(input) {
+        const data = await this.management.request(PublishEnvironmentReleaseFromGameApiTagDocument, { input });
+        return data.publishEnvironmentReleaseFromGameApiTag;
+    }
+    /**
+     * Yank (withdraw) an environment version so it can no longer be deployed.
+     * Existing environments are unaffected. Writes an audit entry.
+     *
+     * @param version - Environment version to yank (e.g. `'v0.1.4'`).
+     * @returns `true` on success.
+     */
+    async yankEnvironmentVersion(version) {
+        const data = await this.management.request(YankEnvironmentVersionDocument, { version });
+        return data.yankEnvironmentVersion;
+    }
+}

package/dist/domains/environments.d.ts

@@ -0,0 +1,155 @@
+import type { GraphQLClient } from '../client.js';
+import { type OrgEnvironmentsQuery, type OrgEnvironmentQuery, type EnvironmentVersionsQuery, type EnvironmentForwardVersionsQuery, type EnvironmentDatacentersQuery, type EnvironmentFlavorsQuery, type EnvironmentQuoteQuery, type CreateEnvironmentMutation, type DestroyEnvironmentMutation, type PurgeEnvironmentMutation, type ResumeEnvironmentMutation, type UpdateEnvironmentScalingMutation, type UpdateEnvironmentBillingTiersMutation, type RedeployEnvironmentMutation, type RestartEnvironmentServicesMutation, type LinkAppToEnvironmentMutation, type EnvironmentQuoteInput, type CreateEnvironmentInput, type DestroyEnvironmentInput, type PurgeEnvironmentInput, type ResumeEnvironmentInput, type UpdateEnvironmentScalingInput, type UpdateEnvironmentBillingTiersInput, type RedeployEnvironmentInput, type RestartEnvironmentServicesInput, type LinkAppToEnvironmentInput } from '../generated/graphql.js';
+/**
+ * Dedicated customer environments — exposed as `client.environments` (and
+ * grouped under `client.admin`).
+ *
+ * Targets the **management-api**. Reads require the `view_environments` org
+ * permission ({@link quote} requires `view_billing`); the deploy/scale/destroy
+ * mutations require `manage_environments`. Lifecycle mutations are asynchronous:
+ * they return a {@link CksEnvironmentChangeOrder} you poll via {@link get} until
+ * its `status` is `succeeded`/`failed`. `BigInt` ids are decimal strings; `since`
+ * args are ISO-8601 `DateTime` strings.
+ *
+ * WARNING: {@link create}, {@link destroy}, {@link purge}, and
+ * {@link redeploy} provision or tear down real cloud resources (and reserve
+ * wallet funds). Drive them only against a sandbox org in tests.
+ *
+ * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` / `FORBIDDEN` / `SCOPE_MISSING`
+ *   per the permission notes above.
+ */
+export declare class EnvironmentsAPI {
+    private readonly management;
+    constructor(management: GraphQLClient);
+    /**
+     * List every environment owned by an org (any lifecycle state). Summary rows
+     * only — use {@link get} for full detail. Requires `view_environments`.
+     *
+     * @param orgId - Numeric org id.
+     * @returns The org's environments.
+     */
+    list(orgId: string): Promise<OrgEnvironmentsQuery['orgEnvironments']>;
+    /**
+     * Full detail for one environment (components, change orders, outputs).
+     * Requires `view_environments`.
+     *
+     * @param orgId - Numeric org id.
+     * @param slug - Environment slug.
+     * @returns The {@link CksEnvironmentDetail}, or `null` if not found.
+     */
+    get(orgId: string, slug: string): Promise<OrgEnvironmentQuery['orgEnvironment']>;
+    /**
+     * Catalog of deployable environment release versions (newest first). Any
+     * authenticated caller.
+     *
+     * @returns The available environment versions.
+     */
+    versions(): Promise<EnvironmentVersionsQuery['environmentVersions']>;
+    /**
+     * Versions a specific environment may upgrade to (forward-only). Requires
+     * `view_environments`.
+     *
+     * @param orgId - Numeric org id.
+     * @param slug - Environment slug.
+     * @returns The upgrade-target versions.
+     */
+    forwardVersions(orgId: string, slug: string): Promise<EnvironmentForwardVersionsQuery['environmentForwardVersions']>;
+    /**
+     * OVH datacenters with at least one customer-selectable flavor. Requires an
+     * authenticated caller.
+     *
+     * @returns The selectable datacenters.
+     */
+    datacenters(): Promise<EnvironmentDatacentersQuery['environmentDatacenters']>;
+    /**
+     * Customer-selectable instance flavors (with pricing) in a datacenter.
+     *
+     * @param datacenter - Datacenter/region code from {@link datacenters}.
+     * @returns The available flavors.
+     */
+    flavors(datacenter: string): Promise<EnvironmentFlavorsQuery['environmentFlavors']>;
+    /**
+     * Price a proposed environment selection and check the wallet can cover it.
+     * Read-only (provisions nothing). Requires `view_billing`.
+     *
+     * @param input - {@link EnvironmentQuoteInput}: org, datacenter, flavors,
+     *   server counts.
+     * @returns The {@link CksEnvironmentQuote} including the `canCreate` gate.
+     */
+    quote(input: EnvironmentQuoteInput): Promise<EnvironmentQuoteQuery['environmentQuote']>;
+    /**
+     * Provision a new dedicated environment. Requires `manage_environments`.
+     * Reserves wallet funds and starts cloud provisioning — poll {@link get}.
+     *
+     * @param input - {@link CreateEnvironmentInput}.
+     * @returns The new environment's detail with its initial change order.
+     */
+    create(input: CreateEnvironmentInput): Promise<CreateEnvironmentMutation['createEnvironment']>;
+    /**
+     * Tear down an environment's runtime (keeps the record). Requires
+     * `manage_environments`.
+     *
+     * @param input - {@link DestroyEnvironmentInput}.
+     * @returns The destroy {@link CksEnvironmentChangeOrder}.
+     */
+    destroy(input: DestroyEnvironmentInput): Promise<DestroyEnvironmentMutation['destroyEnvironment']>;
+    /**
+     * Permanently purge a destroyed environment's record. Requires
+     * `manage_environments`. Irreversible.
+     *
+     * @param input - {@link PurgeEnvironmentInput}.
+     * @returns `true` on success.
+     */
+    purge(input: PurgeEnvironmentInput): Promise<PurgeEnvironmentMutation['purgeEnvironment']>;
+    /**
+     * Resume a suspended (non-payment) environment after funding the wallet.
+     * Requires `manage_environments`.
+     *
+     * @param input - {@link ResumeEnvironmentInput}.
+     * @returns The resume {@link CksEnvironmentChangeOrder}.
+     */
+    resume(input: ResumeEnvironmentInput): Promise<ResumeEnvironmentMutation['resumeEnvironment']>;
+    /**
+     * Change min/max server counts (autoscaling bounds). Requires
+     * `manage_environments`.
+     *
+     * @param input - {@link UpdateEnvironmentScalingInput}.
+     * @returns The scaling {@link CksEnvironmentChangeOrder}.
+     */
+    updateScaling(input: UpdateEnvironmentScalingInput): Promise<UpdateEnvironmentScalingMutation['updateEnvironmentScaling']>;
+    /**
+     * Set an environment's Buddy / GraphQL / Postgres capacity billing-tier
+     * levels (from {@link BillingAPI.buddyTiers} / {@link BillingAPI.graphqlTiers}
+     * / {@link BillingAPI.postgresTiers}). Requires `manage_environments`.
+     *
+     * @param input - {@link UpdateEnvironmentBillingTiersInput} (org, slug, and
+     *   the per-resource tier levels to set).
+     * @returns The updated {@link CksEnvironment}.
+     */
+    updateBillingTiers(input: UpdateEnvironmentBillingTiersInput): Promise<UpdateEnvironmentBillingTiersMutation['updateEnvironmentBillingTiers']>;
+    /**
+     * Deploy a (forward-only) environment release version. Requires
+     * `manage_environments`.
+     *
+     * @param input - {@link RedeployEnvironmentInput} (target version).
+     * @returns The deploy {@link CksEnvironmentChangeOrder}.
+     */
+    redeploy(input: RedeployEnvironmentInput): Promise<RedeployEnvironmentMutation['redeployEnvironment']>;
+    /**
+     * Restart an environment's services without redeploying. Requires
+     * `manage_environments`.
+     *
+     * @param input - {@link RestartEnvironmentServicesInput}.
+     * @returns The restart {@link CksEnvironmentChangeOrder}.
+     */
+    restartServices(input: RestartEnvironmentServicesInput): Promise<RestartEnvironmentServicesMutation['restartEnvironmentServices']>;
+    /**
+     * Link an app to an environment so its runtime is served there. Requires
+     * `manage_environments`.
+     *
+     * @param input - {@link LinkAppToEnvironmentInput}.
+     * @returns The updated {@link App} (with its new routing fields).
+     */
+    linkApp(input: LinkAppToEnvironmentInput): Promise<LinkAppToEnvironmentMutation['linkAppToEnvironment']>;
+}
+//# sourceMappingURL=environments.d.ts.map

package/dist/domains/environments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environments.d.ts","sourceRoot":"","sources":["../../src/domains/environments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAiBL,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,gCAAgC,EACrC,KAAK,qCAAqC,EAC1C,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,EACvC,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,6BAA6B,EAClC,KAAK,kCAAkC,EACvC,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC/B,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,aAAa;IAEtD;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAO3E;;;;;;;OAOG;IACG,GAAG,CACP,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAQjD;;;;;OAKG;IACG,QAAQ,IAAI,OAAO,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC;IAK1E;;;;;;;OAOG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,+BAA+B,CAAC,4BAA4B,CAAC,CAAC;IAQzE;;;;;OAKG;IACG,WAAW,IAAI,OAAO,CAC1B,2BAA2B,CAAC,wBAAwB,CAAC,CACtD;IAQD;;;;;OAKG;IACG,OAAO,CACX,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IAOzD;;;;;;;OAOG;IACG,KAAK,CACT,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAOrD;;;;;;OAMG;IACG,MAAM,CACV,KAAK,EAAE,sBAAsB,GAC5B,OAAO,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;IAO1D;;;;;;OAMG;IACG,OAAO,CACX,KAAK,EAAE,uBAAuB,GAC7B,OAAO,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,CAAC;IAO5D;;;;;;OAMG;IACG,KAAK,CACT,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;IAOxD;;;;;;OAMG;IACG,MAAM,CACV,KAAK,EAAE,sBAAsB,GAC5B,OAAO,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;IAO1D;;;;;;OAMG;IACG,aAAa,CACjB,KAAK,EAAE,6BAA6B,GACnC,OAAO,CAAC,gCAAgC,CAAC,0BAA0B,CAAC,CAAC;IAQxE;;;;;;;;OAQG;IACG,kBAAkB,CACtB,KAAK,EAAE,kCAAkC,GACxC,OAAO,CACR,qCAAqC,CAAC,+BAA+B,CAAC,CACvE;IAQD;;;;;;OAMG;IACG,QAAQ,CACZ,KAAK,EAAE,wBAAwB,GAC9B,OAAO,CAAC,2BAA2B,CAAC,qBAAqB,CAAC,CAAC;IAO9D;;;;;;OAMG;IACG,eAAe,CACnB,KAAK,EAAE,+BAA+B,GACrC,OAAO,CACR,kCAAkC,CAAC,4BAA4B,CAAC,CACjE;IAQD;;;;;;OAMG;IACG,OAAO,CACX,KAAK,EAAE,yBAAyB,GAC/B,OAAO,CAAC,4BAA4B,CAAC,sBAAsB,CAAC,CAAC;CAMjE"}