@crowdedkingdoms/crowdyjs 12.2.0 → 13.0.0

package/dist/domains/environments.js

@@ -1,238 +0,0 @@
-import { OrgEnvironmentsDocument, OrgEnvironmentDocument, EnvironmentVersionsDocument, EnvironmentForwardVersionsDocument, EnvironmentDatacentersDocument, EnvironmentFlavorsDocument, EnvironmentQuoteDocument, CreateEnvironmentDocument, DestroyEnvironmentDocument, PurgeEnvironmentDocument, ResumeEnvironmentDocument, UpdateEnvironmentScalingDocument, UpdateEnvironmentBillingTiersDocument, RedeployEnvironmentDocument, EnvironmentRedeployPlanDocument, RestartEnvironmentServicesDocument, LinkAppToEnvironmentDocument, } 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 class EnvironmentsAPI {
-    constructor(management) {
-        this.management = management;
-    }
-    /**
-     * 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.
-     */
-    async list(orgId) {
-        const data = await this.management.request(OrgEnvironmentsDocument, {
-            orgId,
-        });
-        return data.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.
-     */
-    async get(orgId, slug) {
-        const data = await this.management.request(OrgEnvironmentDocument, {
-            orgId,
-            slug,
-        });
-        return data.orgEnvironment;
-    }
-    /**
-     * Catalog of deployable environment release versions (newest first). Any
-     * authenticated caller.
-     *
-     * @returns The available environment versions.
-     */
-    async versions() {
-        const data = await this.management.request(EnvironmentVersionsDocument, {});
-        return data.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.
-     */
-    async forwardVersions(orgId, slug) {
-        const data = await this.management.request(EnvironmentForwardVersionsDocument, { orgId, slug });
-        return data.environmentForwardVersions;
-    }
-    /**
-     * OVH datacenters with at least one customer-selectable flavor. Requires an
-     * authenticated caller.
-     *
-     * @returns The selectable datacenters.
-     */
-    async datacenters() {
-        const data = await this.management.request(EnvironmentDatacentersDocument, {});
-        return data.environmentDatacenters;
-    }
-    /**
-     * Customer-selectable instance flavors (with pricing) in a datacenter.
-     *
-     * @param datacenter - Datacenter/region code from {@link datacenters}.
-     * @returns The available flavors.
-     */
-    async flavors(datacenter) {
-        const data = await this.management.request(EnvironmentFlavorsDocument, {
-            datacenter,
-        });
-        return data.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.
-     */
-    async quote(input) {
-        const data = await this.management.request(EnvironmentQuoteDocument, {
-            input,
-        });
-        return data.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.
-     */
-    async create(input) {
-        const data = await this.management.request(CreateEnvironmentDocument, {
-            input,
-        });
-        return data.createEnvironment;
-    }
-    /**
-     * Tear down an environment's runtime (keeps the record). Requires
-     * `manage_environments`.
-     *
-     * @param input - {@link DestroyEnvironmentInput}.
-     * @returns The destroy {@link CksEnvironmentChangeOrder}.
-     */
-    async destroy(input) {
-        const data = await this.management.request(DestroyEnvironmentDocument, {
-            input,
-        });
-        return data.destroyEnvironment;
-    }
-    /**
-     * Permanently purge a destroyed environment's record. Requires
-     * `manage_environments`. Irreversible.
-     *
-     * @param input - {@link PurgeEnvironmentInput}.
-     * @returns `true` on success.
-     */
-    async purge(input) {
-        const data = await this.management.request(PurgeEnvironmentDocument, {
-            input,
-        });
-        return data.purgeEnvironment;
-    }
-    /**
-     * Resume a suspended (non-payment) environment after funding the wallet.
-     * Requires `manage_environments`.
-     *
-     * @param input - {@link ResumeEnvironmentInput}.
-     * @returns The resume {@link CksEnvironmentChangeOrder}.
-     */
-    async resume(input) {
-        const data = await this.management.request(ResumeEnvironmentDocument, {
-            input,
-        });
-        return data.resumeEnvironment;
-    }
-    /**
-     * Change min/max server counts (autoscaling bounds). Requires
-     * `manage_environments`.
-     *
-     * @param input - {@link UpdateEnvironmentScalingInput}.
-     * @returns The scaling {@link CksEnvironmentChangeOrder}.
-     */
-    async updateScaling(input) {
-        const data = await this.management.request(UpdateEnvironmentScalingDocument, { input });
-        return data.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}.
-     */
-    async updateBillingTiers(input) {
-        const data = await this.management.request(UpdateEnvironmentBillingTiersDocument, { input });
-        return data.updateEnvironmentBillingTiers;
-    }
-    /**
-     * DRY RUN of {@link redeploy}: what moving the environment to a target
-     * release version would do — component version diffs (game-api, Buddy),
-     * whether game-DB schema DDL applies or is skipped, and the pipeline
-     * tasks/steps that would run — without creating a change order or touching
-     * any VM. Anything that would make the real mutation fail is returned in
-     * `blockers`. Read-only; requires `view_environments`.
-     *
-     * @param input - {@link RedeployEnvironmentInput} (same shape as redeploy).
-     * @returns The plan preview.
-     */
-    async redeployPlan(input) {
-        const data = await this.management.request(EnvironmentRedeployPlanDocument, { input });
-        return data.environmentRedeployPlan;
-    }
-    /**
-     * Deploy a (forward-only) environment release version. Requires
-     * `manage_environments`. Preview first with {@link redeployPlan}.
-     *
-     * @param input - {@link RedeployEnvironmentInput} (target version).
-     * @returns The deploy {@link CksEnvironmentChangeOrder}.
-     */
-    async redeploy(input) {
-        const data = await this.management.request(RedeployEnvironmentDocument, {
-            input,
-        });
-        return data.redeployEnvironment;
-    }
-    /**
-     * Restart an environment's services without redeploying. Requires
-     * `manage_environments`.
-     *
-     * @param input - {@link RestartEnvironmentServicesInput}.
-     * @returns The restart {@link CksEnvironmentChangeOrder}.
-     */
-    async restartServices(input) {
-        const data = await this.management.request(RestartEnvironmentServicesDocument, { input });
-        return data.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).
-     */
-    async linkApp(input) {
-        const data = await this.management.request(LinkAppToEnvironmentDocument, {
-            input,
-        });
-        return data.linkAppToEnvironment;
-    }
-}