@faable/deploy-sdk 2.0.0 → 2.2.0

package/dist/api/generated-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-client.d.ts","sourceRoot":"","sources":["../../src/api/generated-client.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAI7C,KAAK,MAAM,CAAC,CAAC,SAAS,MAAM,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,SAAS;IAC9D,WAAW,EAAE;QAAE,OAAO,EAAE;YAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAAE,CAAC;CAC3D,GACG,CAAC,GACD,KAAK,CAAC;AAsBV,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,SAAS;IAC/D,UAAU,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CACjC,GACG,WAAW,CAAC,CAAC,CAAC,GACd,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE1B;;;;GAIG;AACH,8BAAsB,wBAAyB,SAAQ,SAAS;IAC9D;;;;OAIG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC;;;;;;;IAI9C;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC;;;;;;;;iBAoU8wtC,0CAAsB;;;;gBAAulB,0CAAsB;;;;;;;;;;IAhUr7uC;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM;;;;;;;;iBA2Ts76C,0CAAsB;;;;gBAAulB,0CAAsB;;;;;;;;;;IAtT7k8C;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC;;;;;;;;iBAiT0/xC,0CAAsB;;;;gBAAulB,0CAAsB;;;;;;;;;;IA5S3qzC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM;;;;IAK/B;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM;;;;;;;;IAK7B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,qBAAqB,CAAC;;;;;;;;iBAmR+/a,0CAAsB;;;;gBAA+d,0CAAsB;;;;;;;;;;IA9Q3kc;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;;;;;;;;;qBAyQmgb,0CAAsB;;;;oBAA+d,0CAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAvX5jc,CAAA;oBAA0B,CAAC;;;;;;;;;qBAuXshb,0CAAsB;;;;oBAA+d,0CAAsB;;;;;;;;;;;IArQ3kc;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC;IAKpD;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,EAAE,MAAM;;;;IAKjC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM;;;;;;;;iBA4O4ib,0CAAsB;;;;gBAA+d,0CAAsB;;;;;;;;;;IAvO3kc;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC;;;;;yBAkOijkD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA7N5mkD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM;;;;;;;;iBAwNkib,0CAAsB;;;;gBAA+d,0CAAsB;;;;;;;;;;IAnN3kc;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC;;;;;;;;iBA8Mm42C,0CAAsB;;;;gBAAulB,0CAAsB;;;;;;;;;;IAzMtj4C;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,mBAAmB,CAAC;;;;;;;;;gBAoMqpyD,0CAAsB;;;;;;;IAhM7tyD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM;;;;;;;;;gBA2L673D,0CAAsB;;;;;;;IAtL9+3D;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM;;;;;;;;;gBAiLsj1D,0CAAsB;;;;;;;IA5Kpm1D;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;;;;;;;;;;oBAuKy5gB,0CAAsB;;;;;;;;;;;;;;;;;;;;;;;;kBAvX3+gB,CAAA;oBAA0B,CAAC;;;;;;;;;;oBAuX07gB,0CAAsB;;;;;;;;IAnK1/gB;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,eAAe,CAAC;;;;;;;;;gBA8Jql+D,0CAAsB;;;;;;;IA1Jrp+D;;;;OAIG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM;;;;;;;;;gBAqJukqE,0CAAsB;;;;;;;IAhJpnqE;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM;;;;;;;;;gBA2IwnnB,0CAAsB;;;;;;;IAtIrqnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM;;;;;;;;;gBAiIi/hE,0CAAsB;;;;;;;IA5H3hiE;;;;OAIG;IACH,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;;;;;;;;;;oBAuH4knB,0CAAsB;;;;;;;;;;;;;;;;;;;;;;;;kBAvXtpnB,CAAA;oBAA0B,CAAC;;;;;;;;;;oBAuXqmnB,0CAAsB;;;;;;;;IAnHrqnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,eAAe,CAAC;;;;;;;;;gBA8G+pmE,0CAAsB;;;;;;;IAzG3umE;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC;;;;;;;;;;;IAI5C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM;;;;;;;;;;;IAKxB;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM;;;;;;;;;;;IAKrB;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC;;;;;;;;;;;IAKxD;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;kBA1TtD,CAAA;oBAA0B,CAAC;;;;;;;;;;;;;IA8T1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC;;;;;;;;;;;IAKxD;;;;OAIG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,sBAAsB,CAAC;;;;;;;;;;;;;;;IAIvD;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM;IAK/B;;;;OAIG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC;;iBAuBiptB,0CAAsB;;IAlB9utB;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC;;;;;;;;;;;;;;;IAI5C;;;;OAIG;IACH,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGb"}

package/dist/api/generated-client.js

@@ -0,0 +1,315 @@
+// AUTO-GENERATED by scripts/gen-client.mjs — do not edit by hand.
+// Regenerated from the OpenAPI spec on every build (npm run gentypes).
+// Source of truth: the deploy API's operationIds + security.
+import { FaableApi } from "@faable/sdk-base";
+import { requireId } from "../helpers.js";
+/**
+ * Auto-generated deploy-API methods, one per secured operation in the OpenAPI
+ * spec. `DeployApi` extends this and adds the constructor, custom-logic
+ * helpers, and deprecated aliases.
+ */
+export class GeneratedFaableDeployApi extends FaableApi {
+    /**
+     * `GET /app/checkname` — operationId: `app/checkname`
+     *
+     * Check if an app name is availiable
+     */
+    appCheckname(params) {
+        return this.fetcher.request({ method: "GET", url: `/app/checkname`, params });
+    }
+    /**
+     * `POST /app` — operationId: `app/create`
+     *
+     * Create App
+     */
+    appCreate(data) {
+        return this.fetcher.post(`/app`, data);
+    }
+    /**
+     * `DELETE /app/{id}` — operationId: `app/delete`
+     *
+     * Delete App
+     */
+    appDelete(id) {
+        requireId("id", id);
+        return this.fetcher.delete(`/app/${id}`);
+    }
+    /**
+     * `GET /app/{id}` — operationId: `app/get`
+     *
+     * Get App
+     */
+    appGet(id, params) {
+        requireId("id", id);
+        return this.fetcher.request({ method: "GET", url: `/app/${id}`, params });
+    }
+    /**
+     * `GET /app/{id}/deploy-workflow` — operationId: `app/get_deploy_workflow`
+     *
+     * Get deploy workflow status
+     */
+    appGetDeployWorkflow(id) {
+        requireId("id", id);
+        return this.fetcher.get(`/app/${id}/deploy-workflow`);
+    }
+    /**
+     * `GET /app/{app_id}/registry` — operationId: `app/get_registry`
+     *
+     * Get app registry
+     */
+    appGetRegistry(app_id) {
+        requireId("app_id", app_id);
+        return this.fetcher.get(`/app/${app_id}/registry`);
+    }
+    /**
+     * `POST /app/{id}/link-repository` — operationId: `app/link_repository`
+     *
+     * Link a GitHub repository to an app
+     */
+    appLinkRepository(id, data) {
+        requireId("id", id);
+        return this.fetcher.post(`/app/${id}/link-repository`, data);
+    }
+    /**
+     * `GET /app` — operationId: `app/list`
+     *
+     * List Apps
+     */
+    appList(params) {
+        return this.paginator({ url: `/app`, params });
+    }
+    /**
+     * `GET /app/{app_id}/logs` — operationId: `app/logs`
+     *
+     * Get app logs
+     */
+    appLogs(app_id, params) {
+        requireId("app_id", app_id);
+        return this.fetcher.request({ method: "GET", url: `/app/${app_id}/logs`, params });
+    }
+    /**
+     * `POST /app/{id}/deploy-workflow` — operationId: `app/setup_deploy_workflow`
+     *
+     * Set up deploy workflow
+     */
+    appSetupDeployWorkflow(id) {
+        requireId("id", id);
+        return this.fetcher.post(`/app/${id}/deploy-workflow`, {});
+    }
+    /**
+     * `GET /app/slug/{slug}` — operationId: `app/slug`
+     *
+     * Get App by unique slug
+     */
+    appSlug(slug) {
+        requireId("slug", slug);
+        return this.fetcher.get(`/app/slug/${slug}`);
+    }
+    /**
+     * `GET /app/{app_id}/traffic` — operationId: `app/traffic`
+     *
+     * Get App Traffic
+     */
+    appTraffic(app_id, params) {
+        requireId("app_id", app_id);
+        return this.fetcher.request({ method: "GET", url: `/app/${app_id}/traffic`, params });
+    }
+    /**
+     * `POST /app/{id}/unlink-repository` — operationId: `app/unlink_repository`
+     *
+     * Unlink the GitHub repository from an app
+     */
+    appUnlinkRepository(id) {
+        requireId("id", id);
+        return this.fetcher.post(`/app/${id}/unlink-repository`, {});
+    }
+    /**
+     * `POST /app/{id}` — operationId: `app/update`
+     *
+     * Update App
+     */
+    appUpdate(id, data) {
+        requireId("id", id);
+        return this.fetcher.post(`/app/${id}`, data);
+    }
+    /**
+     * `POST /deployment` — operationId: `deployment/create`
+     *
+     * Create Deployment
+     */
+    deploymentCreate(data) {
+        return this.fetcher.post(`/deployment`, data);
+    }
+    /**
+     * `DELETE /deployment/{id}` — operationId: `deployment/delete`
+     *
+     * Delete Deployment
+     */
+    deploymentDelete(id) {
+        requireId("id", id);
+        return this.fetcher.delete(`/deployment/${id}`);
+    }
+    /**
+     * `GET /deployment/{id}` — operationId: `deployment/get`
+     *
+     * Get Deployment
+     */
+    deploymentGet(id) {
+        requireId("id", id);
+        return this.fetcher.get(`/deployment/${id}`);
+    }
+    /**
+     * `GET /deployment` — operationId: `deployment/list`
+     *
+     * List Deployments
+     */
+    deploymentList(params) {
+        return this.paginator({ url: `/deployment`, params });
+    }
+    /**
+     * `POST /domain` — operationId: `domain/create`
+     *
+     * Create Domain
+     */
+    domainCreate(data) {
+        return this.fetcher.post(`/domain`, data);
+    }
+    /**
+     * `DELETE /domain/{id}` — operationId: `domain/delete`
+     *
+     * Delete Domain
+     */
+    domainDelete(id) {
+        requireId("id", id);
+        return this.fetcher.delete(`/domain/${id}`);
+    }
+    /**
+     * `GET /domain/fqdn/{fqdn}` — operationId: `domain/fqdn`
+     *
+     * Get domain by FQDN
+     */
+    domainFqdn(fqdn) {
+        requireId("fqdn", fqdn);
+        return this.fetcher.get(`/domain/fqdn/${fqdn}`);
+    }
+    /**
+     * `GET /domain/{id}` — operationId: `domain/get`
+     *
+     * Get Domain
+     */
+    domainGet(id) {
+        requireId("id", id);
+        return this.fetcher.get(`/domain/${id}`);
+    }
+    /**
+     * `GET /domain` — operationId: `domain/list`
+     *
+     * List Domains
+     */
+    domainList(params) {
+        return this.paginator({ url: `/domain`, params });
+    }
+    /**
+     * `POST /domain/{id}` — operationId: `domain/update`
+     *
+     * Update Domain
+     */
+    domainUpdate(id, data) {
+        requireId("id", id);
+        return this.fetcher.post(`/domain/${id}`, data);
+    }
+    /**
+     * `POST /project` — operationId: `project/create`
+     *
+     * Create Project
+     */
+    projectCreate(data) {
+        return this.fetcher.post(`/project`, data);
+    }
+    /**
+     * `DELETE /project/{id}` — operationId: `project/delete`
+     *
+     * Delete Project
+     */
+    projectDelete(id) {
+        requireId("id", id);
+        return this.fetcher.delete(`/project/${id}`);
+    }
+    /**
+     * `GET /project/{id}` — operationId: `project/get`
+     *
+     * Get Project
+     */
+    projectGet(id) {
+        requireId("id", id);
+        return this.fetcher.get(`/project/${id}`);
+    }
+    /**
+     * `POST /project/{id}/invite` — operationId: `project/invite`
+     *
+     * Invite collaborators to project
+     */
+    projectInvite(id, data) {
+        requireId("id", id);
+        return this.fetcher.post(`/project/${id}/invite`, data);
+    }
+    /**
+     * `GET /project` — operationId: `project/list`
+     *
+     * List Projects
+     */
+    projectList(params) {
+        return this.paginator({ url: `/project`, params });
+    }
+    /**
+     * `POST /project/{id}` — operationId: `project/update`
+     *
+     * Update Project
+     */
+    projectUpdate(id, data) {
+        requireId("id", id);
+        return this.fetcher.post(`/project/${id}`, data);
+    }
+    /**
+     * `POST /secret/createbatch` — operationId: `secrets/create_batch`
+     *
+     * Create secrets in batch
+     */
+    secretsCreateBatch(data) {
+        return this.fetcher.post(`/secret/createbatch`, data);
+    }
+    /**
+     * `DELETE /secret/{secret_id}` — operationId: `secrets/delete`
+     *
+     * Delete a secret
+     */
+    secretsDelete(secret_id) {
+        requireId("secret_id", secret_id);
+        return this.fetcher.delete(`/secret/${secret_id}`);
+    }
+    /**
+     * `GET /secret/{context_id}` — operationId: `secrets/list_app`
+     *
+     * List all secrets assigned to an App or Profile contexts
+     */
+    secretsListApp(context_id, params) {
+        requireId("context_id", context_id);
+        return this.fetcher.request({ method: "GET", url: `/secret/${context_id}`, params });
+    }
+    /**
+     * `POST /secret` — operationId: `secrets/upsert`
+     *
+     * Upsert a secret
+     */
+    secretsUpsert(data) {
+        return this.fetcher.post(`/secret`, data);
+    }
+    /**
+     * `GET /usage/summary` — operationId: `usage/summary`
+     *
+     * Get team usage summary for the current billing period
+     */
+    usageSummary() {
+        return this.fetcher.get(`/usage/summary`);
+    }
+}

package/dist/api/types.d.ts

@@ -1390,6 +1390,8 @@ export interface components {
             default_branch: string;
             /** @description Id of the Faable GitHub App installation that grants access */
             installation_id: number;
+            /** @description Repository description from GitHub */
+            description?: string;
             permissions?: {
                 admin: boolean;
                 push: boolean;