@faable/deploy-sdk 1.0.0

package/.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: Release
+"on":
+  push:
+    branches:
+      - main
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm ci
+      - run: npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,20 @@
+# Faable Deploy SDK
+
+<p align="center">
+  <a href="https://faable.com">
+    <h1 align="center">Faable Deploy SDK</h1>
+  </a>
+  <p align="center">Faable Deploy management and API Client</p>
+</p>
+
+<p align="center">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/@faable/deploy-sdk">
+    <img alt="" src="https://img.shields.io/npm/v/@faable/deploy-sdk.svg?style=for-the-badge&labelColor=000000">
+  </a>
+</p>
+
+## Install
+
+```bash
+ npm install @faable/deploy-sdk
+```

package/ava.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  extensions: {
+    ts: "module",
+  },
+  require: ["dotenv/config"],
+  nodeArguments: ["--import=@septh/ts-run"],
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@faable/deploy-sdk",
+  "version": "1.0.0",
+  "author": "Marc Pomar <marc@faable.com>",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "axios": "^1.7.7",
+    "jwt-decode": "^4.0.0"
+  },
+  "devDependencies": {
+    "@septh/ts-run": "^1.3.0",
+    "@types/node": "^22.5.5",
+    "ava": "^6.1.3",
+    "dotenv": "^16.4.5",
+    "openapi-typescript": "^7.4.0",
+    "rimraf": "^6.0.1",
+    "semantic-release": "^24.1.1",
+    "tsimp": "^2.0.11",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2"
+  },
+  "scripts": {
+    "generate-types": "openapi-typescript https://api.faable.com/docs/json -o src/api/types.d.ts",
+    "prebuild": "rimraf dist",
+    "build": "tsc",
+    "test": "ava",
+    "release": "semantic-release"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/github",
+      [
+        "@semantic-release/npm"
+      ]
+    ]
+  }
+}

package/src/FaableDeployApi.test.ts

@@ -0,0 +1,13 @@
+import test from "ava";
+import { faableapi } from "./FaableDeployApi.js";
+import { createApikeyAuth } from "./auth/apikey.js";
+
+test("instance", async (t) => {
+  const auth = createApikeyAuth();
+  const api = faableapi({
+    auth,
+  });
+  const app = await api.getApp("app_64f312b7347d780011861a0f");
+  console.log(app);
+  t.pass();
+});

package/src/FaableDeployApi.ts

@@ -0,0 +1,40 @@
+import { Deployment, App } from "./api/api-types.js";
+import { buildPaginator, Paginator, Page } from "./helpers/paginator.js";
+import { fetcher_axios } from "./fetcher/fetcher_axios.js";
+import { Fetcher, FetcherCreateParams } from "./fetcher/Fetcher.js";
+
+type ApiParams = {
+  fetcher?: FetcherCreateParams;
+  auth?: FetcherCreateParams;
+};
+
+export class FaableDeployApi {
+  private fetcher: Fetcher;
+  private paginator: Paginator;
+
+  constructor(params: ApiParams = {}) {
+    this.fetcher = fetcher_axios({
+      baseURL: "https://api.faable.com",
+      ...params.fetcher,
+      ...params.auth,
+    });
+    this.paginator = buildPaginator(this.fetcher);
+  }
+
+  getDeployment(id: string) {
+    return this.fetcher.get<Deployment>(`/deployment/${id}`);
+  }
+  getApp(id: string) {
+    return this.fetcher.get<App>(`/app/${id}`);
+  }
+  listApps() {
+    return this.paginator({ url: "/app" });
+  }
+  updateStatus<T>(id: string, data: T) {
+    return this.fetcher.post(`/status/${id}`, data);
+  }
+}
+
+export const faableapi = (params: ApiParams = {}) => {
+  return new FaableDeployApi(params);
+};

package/src/api/api-types.ts

@@ -0,0 +1,32 @@
+import { components } from "./types.js";
+
+export type App = components["schemas"]["App"];
+export type AppStatus = components["schemas"]["AppStatus"];
+export type AppRuntime = components["schemas"]["AppRuntime"];
+export type AppRuntimeStrategy = components["schemas"]["AppRuntimeStrategy"];
+export type Deployment = components["schemas"]["Deployment"];
+export type DeploymentStatus = components["schemas"]["DeploymentStatus"];
+export type Secret = components["schemas"]["Secret"];
+export type Domain = components["schemas"]["Domain"];
+
+export type Volume = components["schemas"]["Volume"];
+
+export type EventSecretsCreateBatchEvent =
+  components["schemas"]["Event_secret.create_batch"];
+export type EventDeploymentCreated =
+  components["schemas"]["Event_deployment.created"];
+export type EventAppDelete = components["schemas"]["Event_app.delete"];
+export type EventAppCreate = components["schemas"]["Event_app.create"];
+export type EventAppUpdate = components["schemas"]["Event_app.update"];
+
+export type EventDomainCreate = components["schemas"]["Event_domain.create"];
+export type EventDomainUpdate = components["schemas"]["Event_domain.update"];
+
+export type EventVolumeCreate = components["schemas"]["Event_volume.create"];
+export type EventVolumeDelete = components["schemas"]["Event_volume.delete"];
+
+export type EventSecretsUpdated =
+  components["schemas"]["Event_secret.create_batch"];
+
+export type EventDeploymentStatusUpdate =
+  components["schemas"]["Event_deployment.update_status"];