@faable/deploy-sdk 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/FaableDeployApi.d.ts +8 -3
  2. package/dist/FaableDeployApi.d.ts.map +1 -1
  3. package/dist/FaableDeployApi.js +12 -4
  4. package/package.json +1 -1
package/dist/FaableDeployApi.d.ts CHANGED
@@ -59,10 +59,15 @@ export declare class DeployApi extends FaableApi {
59
59
  }>;
60
60
  /**
61
61
  * List apps, optionally filtered with a FaableQL `query` (e.g.
62
- * `"active:true"` to fetch only enabled apps server-side). The query is
63
- * threaded into every page request by the paginator.
62
+ * `"active:true"` to fetch only enabled apps server-side) and/or expanding
63
+ * nested refs (e.g. `{ expand: "status.deployment" }` to inline the active
64
+ * Deployment object on each app — lets a caller avoid a per-app
65
+ * `getApp(?expand=)` round-trip). Both are threaded into every page request
66
+ * by the paginator.
64
67
  */
65
- listApps(query?: string): {
68
+ listApps(query?: string, opts?: {
69
+ expand?: string;
70
+ }): {
66
71
  all: () => Promise<{
67
72
  id: string;
68
73
  team: string;
package/dist/FaableDeployApi.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"FaableDeployApi.d.ts","sourceRoot":"","sources":["../src/FaableDeployApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAKV,UAAU,EACX,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,eAAe;IAC9B,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,cAAc,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;IACzD,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,SAAU,SAAQ,SAAS;gBAC1B,MAAM,CAAC,EAAE,SAAS;IAO9B,aAAa,CAAC,EAAE,EAAE,MAAM;;;;;;;;;gBAuD09tB,0CAAsB;;;;;;;IApDxguB,MAAM,CAAC,EAAE,EAAE,MAAM;;;;;;;;iBAoD6joB,0CAAsB;;;;gBAA+d,0CAAsB;;;;;;;;;;IAjDzlpB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM;;;;;;;;;qBA4CujoB,0CAAsB;;;;oBAA+d,0CAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAzEzhpB,CAAC;oBACnD,CAAC;;;;;;;;;qBAwE+joB,0CAAsB;;;;oBAA+d,0CAAsB;;;;;;;;;;;IAtCzlpB,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAGnC,WAAW,CAAC,EAAE,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAtC0C,CAAC;oBACnD,CAAC;;;;;;;;;;;;;;;;;IAwCf,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAzCqD,CAAC;oBACnD,CAAC;;;;;;;;;;;;;;;;IA2Cf;;;;;;;OAOG;IACH,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM;;;;;;;;;;oBAqBo9tB,0CAAsB;;;;;;;;;;;;;;;;;;;;;;;;kBAzEx8tB,CAAC;oBACnD,CAAC;;;;;;;;;;oBAwEm+tB,0CAAsB;;;;;;;;IAfxguB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,eAAoB;CActD"}
1
+ {"version":3,"file":"FaableDeployApi.d.ts","sourceRoot":"","sources":["../src/FaableDeployApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAKV,UAAU,EACX,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,eAAe;IAC9B,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,cAAc,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;IACzD,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,SAAU,SAAQ,SAAS;gBAC1B,MAAM,CAAC,EAAE,SAAS;IAO9B,aAAa,CAAC,EAAE,EAAE,MAAM;;;;;;;;;gBA6D2mtB,0CAAsB;;;;;;;IA1DzptB,MAAM,CAAC,EAAE,EAAE,MAAM;;;;;;;;iBA0D8snB,0CAAsB;;;;gBAA+d,0CAAsB;;;;;;;;;;IAvD1uoB;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;qBA+C4qnB,0CAAsB;;;;oBAA+d,0CAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA/E1qoB,CAAC;oBACnD,CAAC;;;;;;;;;qBA8EgtnB,0CAAsB;;;;oBAA+d,0CAAsB;;;;;;;;;;;IAtC1uoB,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAGnC,WAAW,CAAC,EAAE,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA5C0C,CAAC;oBACnD,CAAC;;;;;;;;;;;;;;;;;IA8Cf,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA/CqD,CAAC;oBACnD,CAAC;;;;;;;;;;;;;;;;IAiDf;;;;;;;OAOG;IACH,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM;;;;;;;;;;oBAqBqmtB,0CAAsB;;;;;;;;;;;;;;;;;;;;;;;;kBA/EzltB,CAAC;oBACnD,CAAC;;;;;;;;;;oBA8EontB,0CAAsB;;;;;;;;IAfzptB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,eAAoB;CActD"}
package/dist/FaableDeployApi.js CHANGED
@@ -14,13 +14,21 @@ export class DeployApi extends FaableApi {
14
14
  }
15
15
  /**
16
16
  * List apps, optionally filtered with a FaableQL `query` (e.g.
17
- * `"active:true"` to fetch only enabled apps server-side). The query is
18
- * threaded into every page request by the paginator.
17
+ * `"active:true"` to fetch only enabled apps server-side) and/or expanding
18
+ * nested refs (e.g. `{ expand: "status.deployment" }` to inline the active
19
+ * Deployment object on each app — lets a caller avoid a per-app
20
+ * `getApp(?expand=)` round-trip). Both are threaded into every page request
21
+ * by the paginator.
19
22
  */
20
- listApps(query) {
23
+ listApps(query, opts) {
24
+ const params = {};
25
+ if (query)
26
+ params.query = query;
27
+ if (opts?.expand)
28
+ params.expand = opts.expand;
21
29
  return this.paginator({
22
30
  url: "/app",
23
- ...(query ? { params: { query } } : {}),
31
+ ...(Object.keys(params).length ? { params } : {}),
24
32
  });
25
33
  }
26
34
  updateStatus(id, data) {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@faable/deploy-sdk",
3
3
  "description": "Codebase for SDK building",
4
- "version": "1.8.0",
4
+ "version": "1.9.0",
5
5
  "author": "Marc Pomar <marc@faable.com>",
6
6
  "main": "dist/index.js",
7
7
  "types": "dist/index.d.ts",