@faable/deploy-sdk 1.0.4 → 1.0.5

package/dist/FaableDeployApi.d.ts

@@ -1,12 +1,5 @@
-import { Page } from "./helpers/paginator.js";
-import { FetcherCreateParams } from "./fetcher/Fetcher.js";
-type ApiParams = {
-    fetcher?: FetcherCreateParams;
-    auth?: FetcherCreateParams;
-};
-export declare class FaableDeployApi {
-    private fetcher;
-    private paginator;
+import { ApiParams, FaableApi } from "./api/FaableApi.js";
+export declare class DeployApi extends FaableApi {
     constructor(params?: ApiParams);
     getDeployment(id: string): Promise<{
         id: string;
@@ -47,14 +40,12 @@ export declare class FaableDeployApi {
     }>;
     listApps(): {
         all: () => Promise<unknown[]>;
-        first: () => Promise<Page<unknown>>;
+        first: () => Promise<import("./helpers/paginator.js").Page<unknown>>;
         pass: (params?: {
             cursor?: string;
             pageSize?: string;
-        }) => Promise<Page<unknown>>;
+        }) => Promise<import("./helpers/paginator.js").Page<unknown>>;
     };
     updateStatus<T>(id: string, data: T): Promise<unknown>;
 }
-export declare const faableapi: (params?: ApiParams) => FaableDeployApi;
-export {};
 //# sourceMappingURL=FaableDeployApi.d.ts.map

package/dist/FaableDeployApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FaableDeployApi.d.ts","sourceRoot":"","sources":["../src/FaableDeployApi.ts"],"names":[],"mappings":"AACA,OAAO,EAA6B,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAEzE,OAAO,EAAW,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEpE,KAAK,SAAS,GAAG;IACf,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B,CAAC;AAEF,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,SAAS,CAAY;gBAEjB,MAAM,GAAE,SAAc;IASlC,aAAa,CAAC,EAAE,EAAE,MAAM;;;;gBAiBmx1B,8CAAsB;;;;IAdj01B,MAAM,CAAC,EAAE,EAAE,MAAM;;;;;gBAc6smB,CAAC;;;;sBAA6I,CAAC;;;;;;;;;iBAAyU,8CAAsB;;;;;;;;gBAAyf,8CAAsB;;;IAX3toB,QAAQ;;;;;;;;IAGR,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;CAGpC;AAED,eAAO,MAAM,SAAS,YAAY,SAAS,oBAE1C,CAAC"}
+{"version":3,"file":"FaableDeployApi.d.ts","sourceRoot":"","sources":["../src/FaableDeployApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE1D,qBAAa,SAAU,SAAQ,SAAS;gBAC1B,MAAM,CAAC,EAAE,SAAS;IAO9B,aAAa,CAAC,EAAE,EAAE,MAAM;;;;gBAauv2B,8CAAsB;;;;IAVry2B,MAAM,CAAC,EAAE,EAAE,MAAM;;;;;gBAUirnB,CAAC;;;;sBAA6I,CAAC;;;;;;;;;iBAAyU,8CAAsB;;;;;;;;gBAAyf,8CAAsB;;;IAP/rpB,QAAQ;;;;;;;;IAGR,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;CAGpC"}

package/dist/FaableDeployApi.js

@@ -1,15 +1,10 @@
-import { buildPaginator } from "./helpers/paginator.js";
-import { fetcher_axios } from "./fetcher/fetcher_axios.js";
-export class FaableDeployApi {
-    fetcher;
-    paginator;
-    constructor(params = {}) {
-        this.fetcher = fetcher_axios({
+import { FaableApi } from "./api/FaableApi.js";
+export class DeployApi extends FaableApi {
+    constructor(params) {
+        super({
+            ...params,
             baseURL: "https://api.faable.com",
-            ...params.fetcher,
-            ...params.auth,
         });
-        this.paginator = buildPaginator(this.fetcher);
     }
     getDeployment(id) {
         return this.fetcher.get(`/deployment/${id}`);
@@ -24,6 +19,3 @@ export class FaableDeployApi {
         return this.fetcher.post(`/status/${id}`, data);
     }
 }
-export const faableapi = (params = {}) => {
-    return new FaableDeployApi(params);
-};

package/dist/api/FaableApi.d.ts

@@ -0,0 +1,16 @@
+import { AuthInterface } from "../core-types/AuthInterface.js";
+import { Fetcher, FetcherCreateParams } from "../fetcher/Fetcher.js";
+import { Paginator } from "../helpers/paginator.js";
+export type ApiParams = {
+    baseURL?: string;
+    fetcher?: FetcherCreateParams;
+    auth?: AuthInterface<any, any>;
+    debug?: boolean;
+};
+export declare abstract class FaableApi {
+    protected fetcher: Fetcher;
+    protected paginator: Paginator;
+    constructor(params?: ApiParams);
+    static create<T extends abstract new (...args: any) => any>(this: T, params?: ApiParams): InstanceType<T>;
+}
+//# sourceMappingURL=FaableApi.d.ts.map

package/dist/api/FaableApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FaableApi.d.ts","sourceRoot":"","sources":["../../src/api/FaableApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAErE,OAAO,EAAkB,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpE,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,IAAI,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,8BAAsB,SAAS;IAC7B,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;gBAEnB,MAAM,GAAE,SAAc;IAKlC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EACxD,IAAI,EAAE,CAAC,EACP,MAAM,GAAE,SAAc,GACrB,YAAY,CAAC,CAAC,CAAC;CAInB"}

package/dist/api/FaableApi.js

@@ -0,0 +1,14 @@
+import { fetcher_axios } from "../fetcher/fetcher_axios.js";
+import { buildPaginator } from "../helpers/paginator.js";
+export class FaableApi {
+    fetcher;
+    paginator;
+    constructor(params = {}) {
+        this.fetcher = fetcher_axios(params);
+        this.paginator = buildPaginator(this.fetcher);
+    }
+    static create(params = {}) {
+        let Cns = this;
+        return new Cns(params);
+    }
+}

package/dist/auth/apikey.d.ts

@@ -1,3 +1,4 @@
-import { FetcherCreateParams } from "../fetcher/Fetcher.js";
-export declare const createApikeyAuth: (apikey?: string) => FetcherCreateParams;
+import { StrategyInterface } from "../core-types/StrategyInterface.js";
+export type ApikeyAuthParams = Partial<[apikey: string]>;
+export declare const createApikeyAuth: StrategyInterface<ApikeyAuthParams, any, any>;
 //# sourceMappingURL=apikey.d.ts.map

package/dist/auth/apikey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apikey.d.ts","sourceRoot":"","sources":["../../src/auth/apikey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,eAAO,MAAM,gBAAgB,YACnB,MAAM,KACb,mBAMF,CAAC"}
+{"version":3,"file":"apikey.d.ts","sourceRoot":"","sources":["../../src/auth/apikey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAGvE,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEzD,eAAO,MAAM,gBAAgB,EAAE,iBAAiB,CAAC,gBAAgB,EAAE,GAAG,EAAE,GAAG,CAoB1E,CAAC"}

package/dist/auth/apikey.js

@@ -1,7 +1,17 @@
-export const createApikeyAuth = (apikey = process.env.FAABLE_APIKEY || "") => {
-    return {
-        headers: {
-            authorization: `basic ${btoa(`${apikey}:${apikey}`)}`,
-        },
+const APIKEY_ENV_NAME = "FAABLE_APIKEY";
+export const createApikeyAuth = (apikey) => {
+    // Default to environment variable
+    apikey = apikey || process.env[APIKEY_ENV_NAME];
+    if (!apikey) {
+        throw new Error(`[@faable/deploy-sdk] No apikey passed to createApikeyAuth. Pass an apikey or use ${APIKEY_ENV_NAME} environment variable`);
+    }
+    const auth = async () => {
+        return {
+            headers: {
+                authorization: `basic ${btoa(`${apikey}:${apikey}`)}`,
+            },
+        };
     };
+    return Object.assign(auth, { hook: auth });
 };
+let m = createApikeyAuth();

package/dist/core-types/AuthInterface.d.ts

@@ -0,0 +1,5 @@
+export interface AuthInterface<AuthOptions extends any[], Authentication extends any> {
+    (...args: AuthOptions): Promise<Authentication>;
+    hook: (...args: AuthOptions) => Promise<Authentication>;
+}
+//# sourceMappingURL=AuthInterface.d.ts.map

package/dist/core-types/AuthInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthInterface.d.ts","sourceRoot":"","sources":["../../src/core-types/AuthInterface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa,CAC5B,WAAW,SAAS,GAAG,EAAE,EACzB,cAAc,SAAS,GAAG;IAE1B,CAAC,GAAG,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAChD,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CACzD"}

package/dist/core-types/AuthInterface.js

@@ -0,0 +1 @@
+export {};

package/dist/core-types/StrategyInterface.d.ts

@@ -0,0 +1,5 @@
+import type { AuthInterface } from "./AuthInterface.js";
+export interface StrategyInterface<StrategyOptions extends any[], AuthOptions extends any[], Authentication extends object> {
+    (...args: StrategyOptions): AuthInterface<AuthOptions, Authentication>;
+}
+//# sourceMappingURL=StrategyInterface.d.ts.map

package/dist/core-types/StrategyInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StrategyInterface.d.ts","sourceRoot":"","sources":["../../src/core-types/StrategyInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,MAAM,WAAW,iBAAiB,CAChC,eAAe,SAAS,GAAG,EAAE,EAC7B,WAAW,SAAS,GAAG,EAAE,EACzB,cAAc,SAAS,MAAM;IAE7B,CAAC,GAAG,IAAI,EAAE,eAAe,GAAG,aAAa,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;CACxE"}

package/dist/core-types/StrategyInterface.js

@@ -0,0 +1 @@
+export {};

package/dist/fetcher/Fetcher.d.ts

@@ -8,7 +8,6 @@ export type Headers = {
     authorization?: string;
 };
 export type FetcherCreateParams = {
-    baseURL?: string;
     headers?: Headers;
 };
 export type Fetcher = {

package/dist/fetcher/Fetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Fetcher.d.ts","sourceRoot":"","sources":["../../src/fetcher/Fetcher.ts"],"names":[],"mappings":"AAAA,KAAK,MAAM,GACP,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,GACT,SAAS,GACT,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,GACR,QAAQ,CAAC;AACb,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACpC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAChD,OAAO,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACzD,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9D,CAAC"}
+{"version":3,"file":"Fetcher.d.ts","sourceRoot":"","sources":["../../src/fetcher/Fetcher.ts"],"names":[],"mappings":"AAAA,KAAK,MAAM,GACP,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,GACT,SAAS,GACT,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,GACR,QAAQ,CAAC;AACb,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACpC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAChD,OAAO,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACzD,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9D,CAAC"}

package/dist/fetcher/fetcher_axios.d.ts

@@ -1,3 +1,4 @@
-import { Fetcher, FetcherCreateParams } from "./Fetcher.js";
-export declare const fetcher_axios: (params?: FetcherCreateParams) => Fetcher;
+import { Fetcher } from "./Fetcher.js";
+import { ApiParams } from "../api/FaableApi.js";
+export declare const fetcher_axios: (params?: ApiParams) => Fetcher;
 //# sourceMappingURL=fetcher_axios.d.ts.map

package/dist/fetcher/fetcher_axios.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetcher_axios.d.ts","sourceRoot":"","sources":["../../src/fetcher/fetcher_axios.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAS5D,eAAO,MAAM,aAAa,YAAY,mBAAmB,KAAQ,OAqChE,CAAC"}
+{"version":3,"file":"fetcher_axios.d.ts","sourceRoot":"","sources":["../../src/fetcher/fetcher_axios.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAShD,eAAO,MAAM,aAAa,YAAY,SAAS,KAAQ,OAiDtD,CAAC"}

package/dist/fetcher/fetcher_axios.js

@@ -5,10 +5,20 @@ const handleErrorInterceptor = async (e) => {
     throw new FaableApiError(`FaableApiError: ${data?.message} (status=${e.response?.status}, url=${e.response?.config.url})`);
 };
 export const fetcher_axios = (params = {}) => {
-    const instance = axios.create(params);
+    const instance = axios.create({
+        baseURL: params.baseURL,
+        ...(params.fetcher || {}),
+    });
+    instance.interceptors.request.use(async (req) => {
+        const auth_data = params.auth && (await params.auth.hook());
+        req.headers = auth_data?.headers;
+        return req;
+    });
     // Add base interceptor
     instance.interceptors.response.use((res) => {
-        //console.log(`Request ${res.config.url}`);
+        if (params.debug) {
+            console.log(`[${res.status} ${res.statusText}] ${res.config.url}`);
+        }
         return res;
     }, handleErrorInterceptor);
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faable/deploy-sdk",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "author": "Marc Pomar <marc@faable.com>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,11 +11,13 @@
   },
   "dependencies": {
     "axios": "^1.7.7",
-    "jwt-decode": "^4.0.0"
+    "jwt-decode": "^4.0.0",
+    "ramda": "^0.30.1"
   },
   "devDependencies": {
     "@septh/ts-run": "^1.3.0",
     "@types/node": "^22.5.5",
+    "@types/ramda": "^0.30.2",
     "ava": "^6.1.3",
     "dotenv": "^16.4.5",
     "openapi-typescript": "^7.4.0",