@pawabase/client 0.0.0-stage → 0.1.3
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.
- package/README.md +313 -2
- package/dist/cjs/admin.d.ts +187 -0
- package/dist/cjs/admin.d.ts.map +1 -0
- package/dist/cjs/admin.js +235 -0
- package/dist/cjs/admin.js.map +1 -0
- package/dist/cjs/auth.d.ts +448 -0
- package/dist/cjs/auth.d.ts.map +1 -0
- package/dist/cjs/auth.js +1016 -0
- package/dist/cjs/auth.js.map +1 -0
- package/dist/cjs/client.d.ts +103 -0
- package/dist/cjs/client.d.ts.map +1 -0
- package/dist/cjs/client.js +144 -0
- package/dist/cjs/client.js.map +1 -0
- package/dist/cjs/data.d.ts +220 -0
- package/dist/cjs/data.d.ts.map +1 -0
- package/dist/cjs/data.js +490 -0
- package/dist/cjs/data.js.map +1 -0
- package/dist/cjs/errors.d.ts +167 -0
- package/dist/cjs/errors.d.ts.map +1 -0
- package/dist/cjs/errors.js +316 -0
- package/dist/cjs/errors.js.map +1 -0
- package/dist/cjs/files.d.ts +80 -0
- package/dist/cjs/files.d.ts.map +1 -0
- package/dist/cjs/files.js +167 -0
- package/dist/cjs/files.js.map +1 -0
- package/dist/cjs/functions.d.ts +66 -0
- package/dist/cjs/functions.d.ts.map +1 -0
- package/dist/cjs/functions.js +109 -0
- package/dist/cjs/functions.js.map +1 -0
- package/dist/cjs/http.d.ts +101 -0
- package/dist/cjs/http.d.ts.map +1 -0
- package/dist/cjs/http.js +249 -0
- package/dist/cjs/http.js.map +1 -0
- package/dist/cjs/index.d.ts +22 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +45 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/manage/access.d.ts +136 -0
- package/dist/cjs/manage/access.d.ts.map +1 -0
- package/dist/cjs/manage/access.js +162 -0
- package/dist/cjs/manage/access.js.map +1 -0
- package/dist/cjs/manage/automation.d.ts +106 -0
- package/dist/cjs/manage/automation.d.ts.map +1 -0
- package/dist/cjs/manage/automation.js +144 -0
- package/dist/cjs/manage/automation.js.map +1 -0
- package/dist/cjs/manage/base.d.ts +52 -0
- package/dist/cjs/manage/base.d.ts.map +1 -0
- package/dist/cjs/manage/base.js +69 -0
- package/dist/cjs/manage/base.js.map +1 -0
- package/dist/cjs/manage/data.d.ts +100 -0
- package/dist/cjs/manage/data.d.ts.map +1 -0
- package/dist/cjs/manage/data.js +141 -0
- package/dist/cjs/manage/data.js.map +1 -0
- package/dist/cjs/manage/files.d.ts +45 -0
- package/dist/cjs/manage/files.d.ts.map +1 -0
- package/dist/cjs/manage/files.js +73 -0
- package/dist/cjs/manage/files.js.map +1 -0
- package/dist/cjs/manage/functions.d.ts +48 -0
- package/dist/cjs/manage/functions.d.ts.map +1 -0
- package/dist/cjs/manage/functions.js +61 -0
- package/dist/cjs/manage/functions.js.map +1 -0
- package/dist/cjs/manage/index.d.ts +76 -0
- package/dist/cjs/manage/index.d.ts.map +1 -0
- package/dist/cjs/manage/index.js +134 -0
- package/dist/cjs/manage/index.js.map +1 -0
- package/dist/cjs/manage/lifecycle.d.ts +128 -0
- package/dist/cjs/manage/lifecycle.d.ts.map +1 -0
- package/dist/cjs/manage/lifecycle.js +167 -0
- package/dist/cjs/manage/lifecycle.js.map +1 -0
- package/dist/cjs/manage/mail.d.ts +16 -0
- package/dist/cjs/manage/mail.d.ts.map +1 -0
- package/dist/cjs/manage/mail.js +24 -0
- package/dist/cjs/manage/mail.js.map +1 -0
- package/dist/cjs/manage/observe.d.ts +149 -0
- package/dist/cjs/manage/observe.d.ts.map +1 -0
- package/dist/cjs/manage/observe.js +168 -0
- package/dist/cjs/manage/observe.js.map +1 -0
- package/dist/cjs/manage/realtime.d.ts +52 -0
- package/dist/cjs/manage/realtime.d.ts.map +1 -0
- package/dist/cjs/manage/realtime.js +71 -0
- package/dist/cjs/manage/realtime.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/realtime.d.ts +207 -0
- package/dist/cjs/realtime.d.ts.map +1 -0
- package/dist/cjs/realtime.js +704 -0
- package/dist/cjs/realtime.js.map +1 -0
- package/dist/cjs/session-store.d.ts +16 -0
- package/dist/cjs/session-store.d.ts.map +1 -0
- package/dist/cjs/session-store.js +37 -0
- package/dist/cjs/session-store.js.map +1 -0
- package/dist/cjs/typegen.d.ts +26 -0
- package/dist/cjs/typegen.d.ts.map +1 -0
- package/dist/cjs/typegen.js +167 -0
- package/dist/cjs/typegen.js.map +1 -0
- package/dist/cjs/types.d.ts +178 -0
- package/dist/cjs/types.d.ts.map +1 -0
- package/dist/cjs/types.js +4 -0
- package/dist/cjs/types.js.map +1 -0
- package/dist/cjs/util.d.ts +27 -0
- package/dist/cjs/util.d.ts.map +1 -0
- package/dist/cjs/util.js +115 -0
- package/dist/cjs/util.js.map +1 -0
- package/dist/cjs/version.d.ts +2 -0
- package/dist/cjs/version.d.ts.map +1 -0
- package/dist/cjs/version.js +5 -0
- package/dist/cjs/version.js.map +1 -0
- package/dist/esm/admin.d.ts +187 -0
- package/dist/esm/admin.d.ts.map +1 -0
- package/dist/esm/admin.js +222 -0
- package/dist/esm/admin.js.map +1 -0
- package/dist/esm/auth.d.ts +448 -0
- package/dist/esm/auth.d.ts.map +1 -0
- package/dist/esm/auth.js +1012 -0
- package/dist/esm/auth.js.map +1 -0
- package/dist/esm/cli/gen-types.d.ts +2 -0
- package/dist/esm/cli/gen-types.d.ts.map +1 -0
- package/dist/esm/cli/gen-types.js +100 -0
- package/dist/esm/cli/gen-types.js.map +1 -0
- package/dist/esm/client.d.ts +103 -0
- package/dist/esm/client.d.ts.map +1 -0
- package/dist/esm/client.js +139 -0
- package/dist/esm/client.js.map +1 -0
- package/dist/esm/data.d.ts +220 -0
- package/dist/esm/data.d.ts.map +1 -0
- package/dist/esm/data.js +485 -0
- package/dist/esm/data.js.map +1 -0
- package/dist/esm/errors.d.ts +167 -0
- package/dist/esm/errors.d.ts.map +1 -0
- package/dist/esm/errors.js +293 -0
- package/dist/esm/errors.js.map +1 -0
- package/dist/esm/files.d.ts +80 -0
- package/dist/esm/files.d.ts.map +1 -0
- package/dist/esm/files.js +162 -0
- package/dist/esm/files.js.map +1 -0
- package/dist/esm/functions.d.ts +66 -0
- package/dist/esm/functions.d.ts.map +1 -0
- package/dist/esm/functions.js +103 -0
- package/dist/esm/functions.js.map +1 -0
- package/dist/esm/http.d.ts +101 -0
- package/dist/esm/http.d.ts.map +1 -0
- package/dist/esm/http.js +245 -0
- package/dist/esm/http.js.map +1 -0
- package/dist/esm/index.d.ts +22 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +12 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/manage/access.d.ts +136 -0
- package/dist/esm/manage/access.d.ts.map +1 -0
- package/dist/esm/manage/access.js +155 -0
- package/dist/esm/manage/access.js.map +1 -0
- package/dist/esm/manage/automation.d.ts +106 -0
- package/dist/esm/manage/automation.d.ts.map +1 -0
- package/dist/esm/manage/automation.js +134 -0
- package/dist/esm/manage/automation.js.map +1 -0
- package/dist/esm/manage/base.d.ts +52 -0
- package/dist/esm/manage/base.d.ts.map +1 -0
- package/dist/esm/manage/base.js +63 -0
- package/dist/esm/manage/base.js.map +1 -0
- package/dist/esm/manage/data.d.ts +100 -0
- package/dist/esm/manage/data.d.ts.map +1 -0
- package/dist/esm/manage/data.js +130 -0
- package/dist/esm/manage/data.js.map +1 -0
- package/dist/esm/manage/files.d.ts +45 -0
- package/dist/esm/manage/files.d.ts.map +1 -0
- package/dist/esm/manage/files.js +68 -0
- package/dist/esm/manage/files.js.map +1 -0
- package/dist/esm/manage/functions.d.ts +48 -0
- package/dist/esm/manage/functions.d.ts.map +1 -0
- package/dist/esm/manage/functions.js +57 -0
- package/dist/esm/manage/functions.js.map +1 -0
- package/dist/esm/manage/index.d.ts +76 -0
- package/dist/esm/manage/index.d.ts.map +1 -0
- package/dist/esm/manage/index.js +115 -0
- package/dist/esm/manage/index.js.map +1 -0
- package/dist/esm/manage/lifecycle.d.ts +128 -0
- package/dist/esm/manage/lifecycle.d.ts.map +1 -0
- package/dist/esm/manage/lifecycle.js +161 -0
- package/dist/esm/manage/lifecycle.js.map +1 -0
- package/dist/esm/manage/mail.d.ts +16 -0
- package/dist/esm/manage/mail.d.ts.map +1 -0
- package/dist/esm/manage/mail.js +19 -0
- package/dist/esm/manage/mail.js.map +1 -0
- package/dist/esm/manage/observe.d.ts +149 -0
- package/dist/esm/manage/observe.d.ts.map +1 -0
- package/dist/esm/manage/observe.js +161 -0
- package/dist/esm/manage/observe.js.map +1 -0
- package/dist/esm/manage/realtime.d.ts +52 -0
- package/dist/esm/manage/realtime.d.ts.map +1 -0
- package/dist/esm/manage/realtime.js +66 -0
- package/dist/esm/manage/realtime.js.map +1 -0
- package/dist/esm/package.json +1 -0
- package/dist/esm/realtime.d.ts +207 -0
- package/dist/esm/realtime.d.ts.map +1 -0
- package/dist/esm/realtime.js +699 -0
- package/dist/esm/realtime.js.map +1 -0
- package/dist/esm/session-store.d.ts +16 -0
- package/dist/esm/session-store.d.ts.map +1 -0
- package/dist/esm/session-store.js +32 -0
- package/dist/esm/session-store.js.map +1 -0
- package/dist/esm/typegen.d.ts +26 -0
- package/dist/esm/typegen.d.ts.map +1 -0
- package/dist/esm/typegen.js +163 -0
- package/dist/esm/typegen.js.map +1 -0
- package/dist/esm/types.d.ts +178 -0
- package/dist/esm/types.d.ts.map +1 -0
- package/dist/esm/types.js +3 -0
- package/dist/esm/types.js.map +1 -0
- package/dist/esm/util.d.ts +27 -0
- package/dist/esm/util.d.ts.map +1 -0
- package/dist/esm/util.js +102 -0
- package/dist/esm/util.js.map +1 -0
- package/dist/esm/version.d.ts +2 -0
- package/dist/esm/version.d.ts.map +1 -0
- package/dist/esm/version.js +2 -0
- package/dist/esm/version.js.map +1 -0
- package/package.json +92 -4
- package/src/admin.ts +311 -0
- package/src/auth.ts +1180 -0
- package/src/cli/gen-types.ts +105 -0
- package/src/client.ts +189 -0
- package/src/data.ts +576 -0
- package/src/errors.ts +330 -0
- package/src/files.ts +208 -0
- package/src/functions.ts +131 -0
- package/src/http.ts +354 -0
- package/src/index.ts +56 -0
- package/src/manage/access.ts +206 -0
- package/src/manage/automation.ts +162 -0
- package/src/manage/base.ts +83 -0
- package/src/manage/data.ts +159 -0
- package/src/manage/files.ts +79 -0
- package/src/manage/functions.ts +69 -0
- package/src/manage/index.ts +132 -0
- package/src/manage/lifecycle.ts +208 -0
- package/src/manage/mail.ts +22 -0
- package/src/manage/observe.ts +226 -0
- package/src/manage/realtime.ts +95 -0
- package/src/realtime.ts +765 -0
- package/src/session-store.ts +36 -0
- package/src/typegen.ts +192 -0
- package/src/types.ts +195 -0
- package/src/util.ts +114 -0
- package/src/version.ts +1 -0
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { Definitions, Service, type Api } from "./base.js";
|
|
2
|
+
/**
|
|
3
|
+
* Storage administration: buckets, the objects in them, temporary share links and signed URLs. (Reading and writing files as
|
|
4
|
+
* your app does is `client.storage`; this is the operator's view and works with a secret key regardless of policies.)
|
|
5
|
+
*/
|
|
6
|
+
export declare class Buckets extends Definitions {
|
|
7
|
+
protected readonly kind = "buckets";
|
|
8
|
+
/** One page of the bucket's objects: `{ files, prefixes, cursor }`. */
|
|
9
|
+
objects(bucket: string, options?: {
|
|
10
|
+
prefix?: string;
|
|
11
|
+
cursor?: string;
|
|
12
|
+
limit?: number;
|
|
13
|
+
}): Promise<Api>;
|
|
14
|
+
/** One object's details and a way to read it. */
|
|
15
|
+
object(bucket: string, key: string): Promise<Api>;
|
|
16
|
+
putObject(bucket: string, key: string, content: Blob | ArrayBuffer | Uint8Array | string, contentType?: string): Promise<Api>;
|
|
17
|
+
deleteObject(bucket: string, key: string): Promise<Api>;
|
|
18
|
+
/** Rename or move an object inside the bucket. */
|
|
19
|
+
moveObject(bucket: string, source: string, target: string): Promise<Api>;
|
|
20
|
+
/** A temporary signed link to one object (`GET` to read, `PUT` to upload). */
|
|
21
|
+
sign(bucket: string, key: string, options?: {
|
|
22
|
+
method?: "GET" | "PUT";
|
|
23
|
+
expiresIn?: number;
|
|
24
|
+
contentType?: string;
|
|
25
|
+
maxBytes?: number;
|
|
26
|
+
}): Promise<Api>;
|
|
27
|
+
shares(bucket: string): Promise<Api>;
|
|
28
|
+
/** A link to one object for people with no account. `permissions`: `view`, `download`, `both`. The URL is in the answer. */
|
|
29
|
+
createShare(bucket: string, key: string, options?: {
|
|
30
|
+
expiresIn?: number;
|
|
31
|
+
permissions?: "view" | "download" | "both";
|
|
32
|
+
label?: string;
|
|
33
|
+
}): Promise<Api>;
|
|
34
|
+
revokeShare(bucket: string, shareId: string): Promise<Api>;
|
|
35
|
+
}
|
|
36
|
+
/** The environment's response cache. */
|
|
37
|
+
export declare class Cache extends Service {
|
|
38
|
+
stats(): Promise<Api>;
|
|
39
|
+
/** Drop cached responses by tag (`resource:posts`) or for whole resources. */
|
|
40
|
+
invalidate(options?: {
|
|
41
|
+
tags?: string[];
|
|
42
|
+
resources?: string[];
|
|
43
|
+
}): Promise<Api>;
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=files.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/manage/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhE;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC,mBAA4B,IAAI,aAAa;IAE7C,uEAAuE;IACvE,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzG,iDAAiD;IACjD,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjD,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,MAAM,EAAE,WAAW,SAA6B,GAAG,OAAO,CAAC,GAAG,CAAC;IAUjJ,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvD,kDAAkD;IAClD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxE,8EAA8E;IAC9E,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAUtJ,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpC,4HAA4H;IAC5H,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IASxJ,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG3D;AAED,wCAAwC;AACxC,qBAAa,KAAM,SAAQ,OAAO;IAChC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC;IAIrB,8EAA8E;IAC9E,UAAU,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAGlF"}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { Definitions, Service, seg } from "./base.js";
|
|
2
|
+
/**
|
|
3
|
+
* Storage administration: buckets, the objects in them, temporary share links and signed URLs. (Reading and writing files as
|
|
4
|
+
* your app does is `client.storage`; this is the operator's view and works with a secret key regardless of policies.)
|
|
5
|
+
*/
|
|
6
|
+
export class Buckets extends Definitions {
|
|
7
|
+
kind = "buckets";
|
|
8
|
+
/** One page of the bucket's objects: `{ files, prefixes, cursor }`. */
|
|
9
|
+
objects(bucket, options = {}) {
|
|
10
|
+
return this.get(seg(this.kind, bucket, "objects"), options);
|
|
11
|
+
}
|
|
12
|
+
/** One object's details and a way to read it. */
|
|
13
|
+
object(bucket, key) {
|
|
14
|
+
return this.get(seg(this.kind, bucket, "object"), { key });
|
|
15
|
+
}
|
|
16
|
+
putObject(bucket, key, content, contentType = "application/octet-stream") {
|
|
17
|
+
return this.http.request({
|
|
18
|
+
method: "PUT",
|
|
19
|
+
path: this.path(seg(this.kind, bucket, "object")),
|
|
20
|
+
query: { key },
|
|
21
|
+
body: content,
|
|
22
|
+
headers: { "content-type": contentType },
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
deleteObject(bucket, key) {
|
|
26
|
+
return this.del(seg(this.kind, bucket, "objects", key));
|
|
27
|
+
}
|
|
28
|
+
/** Rename or move an object inside the bucket. */
|
|
29
|
+
moveObject(bucket, source, target) {
|
|
30
|
+
return this.post(seg(this.kind, bucket, "object", "move"), { source, target });
|
|
31
|
+
}
|
|
32
|
+
/** A temporary signed link to one object (`GET` to read, `PUT` to upload). */
|
|
33
|
+
sign(bucket, key, options = {}) {
|
|
34
|
+
return this.post(seg(this.kind, bucket, "sign"), {
|
|
35
|
+
key,
|
|
36
|
+
method: options.method ?? "GET",
|
|
37
|
+
expires_in: options.expiresIn ?? 300,
|
|
38
|
+
content_type: options.contentType,
|
|
39
|
+
max_bytes: options.maxBytes,
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
shares(bucket) {
|
|
43
|
+
return this.get(seg(this.kind, bucket, "shares"));
|
|
44
|
+
}
|
|
45
|
+
/** A link to one object for people with no account. `permissions`: `view`, `download`, `both`. The URL is in the answer. */
|
|
46
|
+
createShare(bucket, key, options = {}) {
|
|
47
|
+
return this.post(seg(this.kind, bucket, "shares"), {
|
|
48
|
+
key,
|
|
49
|
+
expires_in: options.expiresIn ?? 3600,
|
|
50
|
+
permissions: options.permissions ?? "both",
|
|
51
|
+
label: options.label ?? "",
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
revokeShare(bucket, shareId) {
|
|
55
|
+
return this.del(seg(this.kind, bucket, "shares", shareId));
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
/** The environment's response cache. */
|
|
59
|
+
export class Cache extends Service {
|
|
60
|
+
stats() {
|
|
61
|
+
return this.get("/cache");
|
|
62
|
+
}
|
|
63
|
+
/** Drop cached responses by tag (`resource:posts`) or for whole resources. */
|
|
64
|
+
invalidate(options = {}) {
|
|
65
|
+
return this.post("/cache/invalidate", { tags: options.tags ?? [], resources: options.resources ?? [] });
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
//# sourceMappingURL=files.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/manage/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAY,MAAM,WAAW,CAAC;AAEhE;;;GAGG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACV,IAAI,GAAG,SAAS,CAAC;IAE7C,uEAAuE;IACvE,OAAO,CAAC,MAAc,EAAE,UAAgE,EAAE;QACxF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,iDAAiD;IACjD,MAAM,CAAC,MAAc,EAAE,GAAW;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,SAAS,CAAC,MAAc,EAAE,GAAW,EAAE,OAAiD,EAAE,WAAW,GAAG,0BAA0B;QAChI,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YACjD,KAAK,EAAE,EAAE,GAAG,EAAE;YACd,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE;SACzC,CAAC,CAAC;IACL,CAAC;IAED,YAAY,CAAC,MAAc,EAAE,GAAW;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,kDAAkD;IAClD,UAAU,CAAC,MAAc,EAAE,MAAc,EAAE,MAAc;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,8EAA8E;IAC9E,IAAI,CAAC,MAAc,EAAE,GAAW,EAAE,UAAmG,EAAE;QACrI,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;YAC/C,GAAG;YACH,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;YAC/B,UAAU,EAAE,OAAO,CAAC,SAAS,IAAI,GAAG;YACpC,YAAY,EAAE,OAAO,CAAC,WAAW;YACjC,SAAS,EAAE,OAAO,CAAC,QAAQ;SAC5B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAc;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,4HAA4H;IAC5H,WAAW,CAAC,MAAc,EAAE,GAAW,EAAE,UAA8F,EAAE;QACvI,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE;YACjD,GAAG;YACH,UAAU,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI;YACrC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,MAAM;YAC1C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,WAAW,CAAC,MAAc,EAAE,OAAe;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7D,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,OAAO,KAAM,SAAQ,OAAO;IAChC,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,8EAA8E;IAC9E,UAAU,CAAC,UAAqD,EAAE;QAChE,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC,CAAC;IAC1G,CAAC;CACF"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { Service, type Api, type Body } from "./base.js";
|
|
2
|
+
/** Deployed functions (Python or TypeScript; a project's functions are one language). */
|
|
3
|
+
export declare class Functions extends Service {
|
|
4
|
+
/** Functions visible to the environment (and `branch`), each saying whether it came from a branch, a deployment or mounted code. */
|
|
5
|
+
list(options?: {
|
|
6
|
+
branch?: string;
|
|
7
|
+
}): Promise<Api>;
|
|
8
|
+
/** Run a function now as an operator (or `asUser`), bypassing its HTTP policy: `{ status, result | error }`. */
|
|
9
|
+
run(name: string, input?: unknown, options?: {
|
|
10
|
+
branch?: string;
|
|
11
|
+
asUser?: Body;
|
|
12
|
+
}): Promise<Api>;
|
|
13
|
+
/** Upload a base64 `.tar.gz` bundle (`functions/*.py` or `functions/*.ts`) and activate it. The `pawabase deploy` command builds the bundle. */
|
|
14
|
+
deploy(archive: string, options?: {
|
|
15
|
+
branch?: string;
|
|
16
|
+
manifest?: Body;
|
|
17
|
+
runtime?: string;
|
|
18
|
+
limits?: Body;
|
|
19
|
+
}): Promise<Api>;
|
|
20
|
+
deployments(options?: {
|
|
21
|
+
branch?: string;
|
|
22
|
+
limit?: number;
|
|
23
|
+
}): Promise<Api>;
|
|
24
|
+
deployment(deploymentId: string): Promise<Api>;
|
|
25
|
+
/** Make an earlier deployment the active one again (a rollback). */
|
|
26
|
+
activate(deploymentId: string): Promise<Api>;
|
|
27
|
+
removeDeployment(deploymentId: string): Promise<Api>;
|
|
28
|
+
branches(): Promise<Api>;
|
|
29
|
+
/** Delete the functions deployed on `branch`. The environment's own are untouched. */
|
|
30
|
+
removeBranch(branch: string): Promise<Api>;
|
|
31
|
+
runs(options?: {
|
|
32
|
+
function?: string;
|
|
33
|
+
branch?: string;
|
|
34
|
+
status?: string;
|
|
35
|
+
after?: string;
|
|
36
|
+
limit?: number;
|
|
37
|
+
}): Promise<Api>;
|
|
38
|
+
/** One run with its input, output, error and logs. */
|
|
39
|
+
runDetail(runId: string): Promise<Api>;
|
|
40
|
+
/** The files of the live deployment. */
|
|
41
|
+
source(options?: {
|
|
42
|
+
branch?: string;
|
|
43
|
+
}): Promise<Api>;
|
|
44
|
+
sourceFile(path: string, options?: {
|
|
45
|
+
branch?: string;
|
|
46
|
+
}): Promise<Api>;
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=functions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../../src/manage/functions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAE9D,yFAAyF;AACzF,qBAAa,SAAU,SAAQ,OAAO;IACpC,oIAAoI;IACpI,IAAI,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrD,gHAAgH;IAChH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlG,gJAAgJ;IAChJ,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAU1H,WAAW,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5E,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C,oEAAoE;IACpE,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5C,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpD,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxB,sFAAsF;IACtF,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1C,IAAI,CAAC,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzH,sDAAsD;IACtD,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAItC,wCAAwC;IACxC,MAAM,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvD,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAG1E"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { Service, seg } from "./base.js";
|
|
2
|
+
/** Deployed functions (Python or TypeScript; a project's functions are one language). */
|
|
3
|
+
export class Functions extends Service {
|
|
4
|
+
/** Functions visible to the environment (and `branch`), each saying whether it came from a branch, a deployment or mounted code. */
|
|
5
|
+
list(options = {}) {
|
|
6
|
+
return this.get("/functions", options);
|
|
7
|
+
}
|
|
8
|
+
/** Run a function now as an operator (or `asUser`), bypassing its HTTP policy: `{ status, result | error }`. */
|
|
9
|
+
run(name, input, options = {}) {
|
|
10
|
+
return this.post(seg("functions", name, "invoke"), { input, branch: options.branch ?? null, as_user: options.asUser ?? null });
|
|
11
|
+
}
|
|
12
|
+
/** Upload a base64 `.tar.gz` bundle (`functions/*.py` or `functions/*.ts`) and activate it. The `pawabase deploy` command builds the bundle. */
|
|
13
|
+
deploy(archive, options = {}) {
|
|
14
|
+
return this.post("/function-deployments", {
|
|
15
|
+
archive,
|
|
16
|
+
branch: options.branch ?? "main",
|
|
17
|
+
manifest: options.manifest ?? {},
|
|
18
|
+
runtime: options.runtime ?? "python3.11",
|
|
19
|
+
limits: options.limits ?? {},
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
deployments(options = {}) {
|
|
23
|
+
return this.get("/function-deployments", { limit: 50, ...options });
|
|
24
|
+
}
|
|
25
|
+
deployment(deploymentId) {
|
|
26
|
+
return this.get(seg("function-deployments", deploymentId));
|
|
27
|
+
}
|
|
28
|
+
/** Make an earlier deployment the active one again (a rollback). */
|
|
29
|
+
activate(deploymentId) {
|
|
30
|
+
return this.post(seg("function-deployments", deploymentId, "activate"));
|
|
31
|
+
}
|
|
32
|
+
removeDeployment(deploymentId) {
|
|
33
|
+
return this.del(seg("function-deployments", deploymentId));
|
|
34
|
+
}
|
|
35
|
+
branches() {
|
|
36
|
+
return this.get("/function-branches");
|
|
37
|
+
}
|
|
38
|
+
/** Delete the functions deployed on `branch`. The environment's own are untouched. */
|
|
39
|
+
removeBranch(branch) {
|
|
40
|
+
return this.del(seg("function-branches", branch));
|
|
41
|
+
}
|
|
42
|
+
runs(options = {}) {
|
|
43
|
+
return this.get("/function-runs", { limit: 50, ...options });
|
|
44
|
+
}
|
|
45
|
+
/** One run with its input, output, error and logs. */
|
|
46
|
+
runDetail(runId) {
|
|
47
|
+
return this.get(seg("function-runs", runId));
|
|
48
|
+
}
|
|
49
|
+
/** The files of the live deployment. */
|
|
50
|
+
source(options = {}) {
|
|
51
|
+
return this.get("/function-source", options);
|
|
52
|
+
}
|
|
53
|
+
sourceFile(path, options = {}) {
|
|
54
|
+
return this.get("/function-source/file", { path, ...options });
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=functions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../src/manage/functions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAuB,MAAM,WAAW,CAAC;AAE9D,yFAAyF;AACzF,MAAM,OAAO,SAAU,SAAQ,OAAO;IACpC,oIAAoI;IACpI,IAAI,CAAC,UAA+B,EAAE;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,gHAAgH;IAChH,GAAG,CAAC,IAAY,EAAE,KAAe,EAAE,UAA8C,EAAE;QACjF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC;IACjI,CAAC;IAED,gJAAgJ;IAChJ,MAAM,CAAC,OAAe,EAAE,UAAiF,EAAE;QACzG,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE;YACxC,OAAO;YACP,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,MAAM;YAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;YAChC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY;YACxC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,CAAC,CAAC;IACL,CAAC;IAED,WAAW,CAAC,UAA+C,EAAE;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,UAAU,CAAC,YAAoB;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,oEAAoE;IACpE,QAAQ,CAAC,YAAoB;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,gBAAgB,CAAC,YAAoB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAED,sFAAsF;IACtF,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,CAAC,UAAmG,EAAE;QACxG,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,sDAAsD;IACtD,SAAS,CAAC,KAAa;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,wCAAwC;IACxC,MAAM,CAAC,UAA+B,EAAE;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,UAAU,CAAC,IAAY,EAAE,UAA+B,EAAE;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The management plane of one environment, with that environment's secret key (`pb_sk_…`).
|
|
3
|
+
*
|
|
4
|
+
* ```ts
|
|
5
|
+
* import { createClient } from "@pawabase/client";
|
|
6
|
+
* import { manage } from "@pawabase/client/manage";
|
|
7
|
+
*
|
|
8
|
+
* const pawabase = createClient({ url, apiKey: "pb_sk_…", environment: "production" });
|
|
9
|
+
* const m = manage(pawabase);
|
|
10
|
+
* await m.secrets.set("STRIPE_KEY", "sk_live_…");
|
|
11
|
+
* await manage(pawabase, "staging").flows.list(); // the same API for another environment the key may manage
|
|
12
|
+
* ```
|
|
13
|
+
*/
|
|
14
|
+
import type { PawabaseClient } from "../client.js";
|
|
15
|
+
import { Domains, Firewall, Keys, Secrets } from "./access.js";
|
|
16
|
+
import { Events, Flows, InboundHooks, Jobs, Schedules, Subscriptions, Webhooks } from "./automation.js";
|
|
17
|
+
import { Database, Policies, Resources, Routes, Runtime, Schema, Schemas, Transformers } from "./data.js";
|
|
18
|
+
import { Buckets, Cache } from "./files.js";
|
|
19
|
+
import { Functions } from "./functions.js";
|
|
20
|
+
import { Backups, Environments, Releases } from "./lifecycle.js";
|
|
21
|
+
import { Mail, MailTemplates } from "./mail.js";
|
|
22
|
+
import { Alarms, Health, Observability, StatusPage } from "./observe.js";
|
|
23
|
+
import { Dashboards, RealtimeChannels } from "./realtime.js";
|
|
24
|
+
export declare class Manage {
|
|
25
|
+
private readonly client;
|
|
26
|
+
readonly environment: string;
|
|
27
|
+
readonly resources: Resources;
|
|
28
|
+
readonly schema: Schema;
|
|
29
|
+
readonly policies: Policies;
|
|
30
|
+
readonly schemas: Schemas;
|
|
31
|
+
readonly transformers: Transformers;
|
|
32
|
+
readonly routes: Routes;
|
|
33
|
+
readonly database: Database;
|
|
34
|
+
readonly runtime: Runtime;
|
|
35
|
+
readonly flows: Flows;
|
|
36
|
+
readonly schedules: Schedules;
|
|
37
|
+
readonly subscriptions: Subscriptions;
|
|
38
|
+
readonly events: Events;
|
|
39
|
+
readonly webhooks: Webhooks;
|
|
40
|
+
readonly inboundHooks: InboundHooks;
|
|
41
|
+
readonly jobs: Jobs;
|
|
42
|
+
readonly functions: Functions;
|
|
43
|
+
readonly buckets: Buckets;
|
|
44
|
+
readonly cache: Cache;
|
|
45
|
+
readonly mail: Mail;
|
|
46
|
+
readonly mailTemplates: MailTemplates;
|
|
47
|
+
readonly realtimeChannels: RealtimeChannels;
|
|
48
|
+
readonly dashboards: Dashboards;
|
|
49
|
+
readonly keys: Keys;
|
|
50
|
+
readonly secrets: Secrets;
|
|
51
|
+
readonly domains: Domains;
|
|
52
|
+
readonly firewall: Firewall;
|
|
53
|
+
readonly observability: Observability;
|
|
54
|
+
readonly alarms: Alarms;
|
|
55
|
+
readonly statusPage: StatusPage;
|
|
56
|
+
readonly health: Health;
|
|
57
|
+
readonly environments: Environments;
|
|
58
|
+
readonly releases: Releases;
|
|
59
|
+
readonly backups: Backups;
|
|
60
|
+
constructor(client: PawabaseClient<any>, environment: string);
|
|
61
|
+
/** The same services for another environment the key may manage. */
|
|
62
|
+
withEnvironment(name: string): Manage;
|
|
63
|
+
}
|
|
64
|
+
/** The management plane of the client's environment (or `environment`). Needs a secret key. */
|
|
65
|
+
export declare function manage(client: PawabaseClient<any>, environment?: string): Manage;
|
|
66
|
+
export * from "./access.js";
|
|
67
|
+
export * from "./automation.js";
|
|
68
|
+
export * from "./base.js";
|
|
69
|
+
export * from "./data.js";
|
|
70
|
+
export * from "./files.js";
|
|
71
|
+
export * from "./functions.js";
|
|
72
|
+
export * from "./lifecycle.js";
|
|
73
|
+
export * from "./mail.js";
|
|
74
|
+
export * from "./observe.js";
|
|
75
|
+
export * from "./realtime.js";
|
|
76
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/manage/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAGnD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACxG,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC1G,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE7D,qBAAa,MAAM;IA2Cf,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM;IA1C9B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAEtC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAC5C,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAGP,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC,EACnC,WAAW,EAAE,MAAM;IAsC9B,oEAAoE;IACpE,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAGtC;AAED,+FAA+F;AAC/F,wBAAgB,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAKhF;AAED,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { ConfigError } from "../errors.js";
|
|
2
|
+
import { isSecretKey } from "../util.js";
|
|
3
|
+
import { Domains, Firewall, Keys, Secrets } from "./access.js";
|
|
4
|
+
import { Events, Flows, InboundHooks, Jobs, Schedules, Subscriptions, Webhooks } from "./automation.js";
|
|
5
|
+
import { Database, Policies, Resources, Routes, Runtime, Schema, Schemas, Transformers } from "./data.js";
|
|
6
|
+
import { Buckets, Cache } from "./files.js";
|
|
7
|
+
import { Functions } from "./functions.js";
|
|
8
|
+
import { Backups, Environments, Releases } from "./lifecycle.js";
|
|
9
|
+
import { Mail, MailTemplates } from "./mail.js";
|
|
10
|
+
import { Alarms, Health, Observability, StatusPage } from "./observe.js";
|
|
11
|
+
import { Dashboards, RealtimeChannels } from "./realtime.js";
|
|
12
|
+
export class Manage {
|
|
13
|
+
client;
|
|
14
|
+
environment;
|
|
15
|
+
// data
|
|
16
|
+
resources;
|
|
17
|
+
schema;
|
|
18
|
+
policies;
|
|
19
|
+
schemas;
|
|
20
|
+
transformers;
|
|
21
|
+
routes;
|
|
22
|
+
database;
|
|
23
|
+
runtime;
|
|
24
|
+
// automation
|
|
25
|
+
flows;
|
|
26
|
+
schedules;
|
|
27
|
+
subscriptions;
|
|
28
|
+
events;
|
|
29
|
+
webhooks;
|
|
30
|
+
inboundHooks;
|
|
31
|
+
jobs;
|
|
32
|
+
functions;
|
|
33
|
+
// files and mail
|
|
34
|
+
buckets;
|
|
35
|
+
cache;
|
|
36
|
+
mail;
|
|
37
|
+
mailTemplates;
|
|
38
|
+
// realtime and dashboards
|
|
39
|
+
realtimeChannels;
|
|
40
|
+
dashboards;
|
|
41
|
+
// access
|
|
42
|
+
keys;
|
|
43
|
+
secrets;
|
|
44
|
+
domains;
|
|
45
|
+
firewall;
|
|
46
|
+
// observe
|
|
47
|
+
observability;
|
|
48
|
+
alarms;
|
|
49
|
+
statusPage;
|
|
50
|
+
health;
|
|
51
|
+
// lifecycle
|
|
52
|
+
environments;
|
|
53
|
+
releases;
|
|
54
|
+
backups;
|
|
55
|
+
constructor(client, environment) {
|
|
56
|
+
this.client = client;
|
|
57
|
+
this.environment = environment;
|
|
58
|
+
const http = client.http;
|
|
59
|
+
this.resources = new Resources(http, environment);
|
|
60
|
+
this.schema = new Schema(http, environment);
|
|
61
|
+
this.policies = new Policies(http, environment);
|
|
62
|
+
this.schemas = new Schemas(http, environment);
|
|
63
|
+
this.transformers = new Transformers(http, environment);
|
|
64
|
+
this.routes = new Routes(http, environment);
|
|
65
|
+
this.database = new Database(http, environment);
|
|
66
|
+
this.runtime = new Runtime(http, environment);
|
|
67
|
+
this.flows = new Flows(http, environment);
|
|
68
|
+
this.schedules = new Schedules(http, environment);
|
|
69
|
+
this.subscriptions = new Subscriptions(http, environment);
|
|
70
|
+
this.events = new Events(http, environment);
|
|
71
|
+
this.webhooks = new Webhooks(http, environment);
|
|
72
|
+
this.inboundHooks = new InboundHooks(http, environment);
|
|
73
|
+
this.jobs = new Jobs(http, environment);
|
|
74
|
+
this.functions = new Functions(http, environment);
|
|
75
|
+
this.buckets = new Buckets(http, environment);
|
|
76
|
+
this.cache = new Cache(http, environment);
|
|
77
|
+
this.mail = new Mail(http, environment);
|
|
78
|
+
this.mailTemplates = new MailTemplates(http, environment);
|
|
79
|
+
this.realtimeChannels = new RealtimeChannels(http, environment);
|
|
80
|
+
this.dashboards = new Dashboards(http, environment);
|
|
81
|
+
this.keys = new Keys(http, environment);
|
|
82
|
+
this.secrets = new Secrets(http, environment);
|
|
83
|
+
this.domains = new Domains(http, environment);
|
|
84
|
+
this.firewall = new Firewall(http, environment);
|
|
85
|
+
this.observability = new Observability(http, environment);
|
|
86
|
+
this.alarms = new Alarms(http, environment);
|
|
87
|
+
this.statusPage = new StatusPage(http, environment);
|
|
88
|
+
this.health = new Health(http, environment);
|
|
89
|
+
this.environments = new Environments(http, environment);
|
|
90
|
+
this.releases = new Releases(http, environment);
|
|
91
|
+
this.backups = new Backups(http, environment);
|
|
92
|
+
}
|
|
93
|
+
/** The same services for another environment the key may manage. */
|
|
94
|
+
withEnvironment(name) {
|
|
95
|
+
return new Manage(this.client, name);
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
/** The management plane of the client's environment (or `environment`). Needs a secret key. */
|
|
99
|
+
export function manage(client, environment) {
|
|
100
|
+
if (!isSecretKey(client.options.apiKey)) {
|
|
101
|
+
throw new ConfigError("The management plane needs a secret key (pb_sk_…).");
|
|
102
|
+
}
|
|
103
|
+
return new Manage(client, environment ?? client.options.environment ?? "development");
|
|
104
|
+
}
|
|
105
|
+
export * from "./access.js";
|
|
106
|
+
export * from "./automation.js";
|
|
107
|
+
export * from "./base.js";
|
|
108
|
+
export * from "./data.js";
|
|
109
|
+
export * from "./files.js";
|
|
110
|
+
export * from "./functions.js";
|
|
111
|
+
export * from "./lifecycle.js";
|
|
112
|
+
export * from "./mail.js";
|
|
113
|
+
export * from "./observe.js";
|
|
114
|
+
export * from "./realtime.js";
|
|
115
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/manage/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACxG,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC1G,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE7D,MAAM,OAAO,MAAM;IA2CE;IACR;IA3CX,OAAO;IACE,SAAS,CAAY;IACrB,MAAM,CAAS;IACf,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,YAAY,CAAe;IAC3B,MAAM,CAAS;IACf,QAAQ,CAAW;IACnB,OAAO,CAAU;IAC1B,aAAa;IACJ,KAAK,CAAQ;IACb,SAAS,CAAY;IACrB,aAAa,CAAgB;IAC7B,MAAM,CAAS;IACf,QAAQ,CAAW;IACnB,YAAY,CAAe;IAC3B,IAAI,CAAO;IACX,SAAS,CAAY;IAC9B,iBAAiB;IACR,OAAO,CAAU;IACjB,KAAK,CAAQ;IACb,IAAI,CAAO;IACX,aAAa,CAAgB;IACtC,0BAA0B;IACjB,gBAAgB,CAAmB;IACnC,UAAU,CAAa;IAChC,SAAS;IACA,IAAI,CAAO;IACX,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,QAAQ,CAAW;IAC5B,UAAU;IACD,aAAa,CAAgB;IAC7B,MAAM,CAAS;IACf,UAAU,CAAa;IACvB,MAAM,CAAS;IACxB,YAAY;IACH,YAAY,CAAe;IAC3B,QAAQ,CAAW;IACnB,OAAO,CAAU;IAE1B,YACmB,MAA2B,EACnC,WAAmB;QADX,WAAM,GAAN,MAAM,CAAqB;QACnC,gBAAW,GAAX,WAAW,CAAQ;QAE5B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5C,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;IAED,oEAAoE;IACpE,eAAe,CAAC,IAAY;QAC1B,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;CACF;AAED,+FAA+F;AAC/F,MAAM,UAAU,MAAM,CAAC,MAA2B,EAAE,WAAoB;IACtE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,WAAW,CAAC,oDAAoD,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,IAAI,aAAa,CAAC,CAAC;AACxF,CAAC;AAED,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { Service, type Api, type Body } from "./base.js";
|
|
2
|
+
type When = Date | string;
|
|
3
|
+
/** The project's environments (`development`, `production`, previews…). Most calls here are not scoped to the client's environment. */
|
|
4
|
+
export declare class Environments extends Service {
|
|
5
|
+
list(): Promise<Api>;
|
|
6
|
+
/** A new environment, optionally with another's definitions copied in. */
|
|
7
|
+
create(name: string, options?: {
|
|
8
|
+
copyFrom?: string;
|
|
9
|
+
}): Promise<Api>;
|
|
10
|
+
getOne(name?: string): Promise<Api>;
|
|
11
|
+
/** Change an environment's infrastructure, sign-in settings or settings; each is merged in. */
|
|
12
|
+
update(name: string, changes: {
|
|
13
|
+
infra?: Body;
|
|
14
|
+
auth?: Body;
|
|
15
|
+
settings?: Body;
|
|
16
|
+
isDefault?: boolean;
|
|
17
|
+
}): Promise<Api>;
|
|
18
|
+
deleteEnvironment(name: string): Promise<Api>;
|
|
19
|
+
/** A short-lived copy for a branch or pull request (`ref`: lowercase letters, digits and hyphens); it expires by itself. */
|
|
20
|
+
createPreview(ref: string, options?: {
|
|
21
|
+
name?: string;
|
|
22
|
+
expiresInHours?: number;
|
|
23
|
+
infra?: Body;
|
|
24
|
+
auth?: Body;
|
|
25
|
+
settings?: Body;
|
|
26
|
+
}): Promise<Api>;
|
|
27
|
+
deletePreview(preview: string): Promise<Api>;
|
|
28
|
+
/** Copy this environment's definitions (never secrets or keys) to `to`. `include` limits the kinds (`flows`, `policies`, `resources`…). */
|
|
29
|
+
promote(to: string, options?: {
|
|
30
|
+
include?: string[];
|
|
31
|
+
}): Promise<Api>;
|
|
32
|
+
/** Export definitions, roles and settings as a document another project can apply. */
|
|
33
|
+
blueprint(): Promise<Api>;
|
|
34
|
+
/** Build new environments from a blueprint; each must not exist yet. */
|
|
35
|
+
applyBlueprint(blueprint: Body, environments?: string[]): Promise<Api>;
|
|
36
|
+
/** Re-read the deployed function code now. */
|
|
37
|
+
reloadCode(): Promise<Api>;
|
|
38
|
+
}
|
|
39
|
+
/** Feature branches of the definitions, immutable revisions, API versions and releases. */
|
|
40
|
+
export declare class Releases extends Service {
|
|
41
|
+
branches(): Promise<Api>;
|
|
42
|
+
createBranch(name: string, options?: {
|
|
43
|
+
fromBranch?: string;
|
|
44
|
+
fromRevision?: string;
|
|
45
|
+
protected?: boolean;
|
|
46
|
+
}): Promise<Api>;
|
|
47
|
+
/** The branch's definitions as they stand now. */
|
|
48
|
+
draft(branch: string): Promise<Api>;
|
|
49
|
+
merge(branch: string, options?: {
|
|
50
|
+
target?: string;
|
|
51
|
+
force?: boolean;
|
|
52
|
+
}): Promise<Api>;
|
|
53
|
+
revisions(): Promise<Api>;
|
|
54
|
+
revision(revisionId: string): Promise<Api>;
|
|
55
|
+
/** Freeze the branch's draft as a revision. */
|
|
56
|
+
commit(branch: string, message?: string): Promise<Api>;
|
|
57
|
+
apiVersions(): Promise<Api>;
|
|
58
|
+
createApiVersion(name: string, options?: {
|
|
59
|
+
isDefault?: boolean;
|
|
60
|
+
}): Promise<Api>;
|
|
61
|
+
/** `status`: draft, active, deprecated, sunset, disabled. */
|
|
62
|
+
updateApiVersion(name: string, changes: {
|
|
63
|
+
status?: string;
|
|
64
|
+
isDefault?: boolean;
|
|
65
|
+
sunsetAt?: When;
|
|
66
|
+
}): Promise<Api>;
|
|
67
|
+
rollbackApiVersion(name: string): Promise<Api>;
|
|
68
|
+
releases(): Promise<Api>;
|
|
69
|
+
/** Make a revision the live definitions of an API version. */
|
|
70
|
+
release(revisionId: string, apiVersion: string, name: string, options?: {
|
|
71
|
+
notes?: string;
|
|
72
|
+
allowBreaking?: boolean;
|
|
73
|
+
}): Promise<Api>;
|
|
74
|
+
activate(releaseId: string): Promise<Api>;
|
|
75
|
+
deployments(): Promise<Api>;
|
|
76
|
+
}
|
|
77
|
+
export interface RestoreOptions {
|
|
78
|
+
/** Parts to restore: `definitions`, `settings`, `users`, `data`. Default: every part the file holds. */
|
|
79
|
+
include?: string[];
|
|
80
|
+
/** `merge` adds and updates; `replace` first removes what the chosen parts hold and needs `confirm`. */
|
|
81
|
+
strategy?: "merge" | "replace";
|
|
82
|
+
dryRun?: boolean;
|
|
83
|
+
/** For `replace`: the environment's name, typed out. */
|
|
84
|
+
confirm?: string;
|
|
85
|
+
}
|
|
86
|
+
/** Whole-environment backups you download, stored snapshots, and restores. */
|
|
87
|
+
export declare class Backups extends Service {
|
|
88
|
+
/** A backup document: `definitions`, `settings`, `users` and, with `data`, rows (up to `maxRows` per table). */
|
|
89
|
+
download(options?: {
|
|
90
|
+
include?: string[];
|
|
91
|
+
data?: boolean;
|
|
92
|
+
maxRows?: number;
|
|
93
|
+
}): Promise<Api>;
|
|
94
|
+
/** Put a downloaded backup back. */
|
|
95
|
+
restore(backup: Body, options?: RestoreOptions): Promise<Api>;
|
|
96
|
+
/** Automatic snapshots: `frequency` hourly, daily (at `hour` UTC) or weekly (on `weekday`, 0 = Monday); older ones are pruned past `keepLast` and `keepDays`. */
|
|
97
|
+
setSchedule(options?: {
|
|
98
|
+
enabled?: boolean;
|
|
99
|
+
frequency?: "hourly" | "daily" | "weekly";
|
|
100
|
+
hour?: number;
|
|
101
|
+
weekday?: number;
|
|
102
|
+
keepLast?: number;
|
|
103
|
+
keepDays?: number;
|
|
104
|
+
include?: string[];
|
|
105
|
+
}): Promise<Api>;
|
|
106
|
+
snapshots(): Promise<Api>;
|
|
107
|
+
/** Take a snapshot now and keep it. */
|
|
108
|
+
snapshot(name?: string, options?: {
|
|
109
|
+
note?: string;
|
|
110
|
+
include?: string[];
|
|
111
|
+
}): Promise<Api>;
|
|
112
|
+
/** Rename it, annotate it, or pin it so pruning keeps it. */
|
|
113
|
+
updateSnapshot(snapshotId: string, changes: {
|
|
114
|
+
name?: string;
|
|
115
|
+
note?: string;
|
|
116
|
+
pinned?: boolean;
|
|
117
|
+
}): Promise<Api>;
|
|
118
|
+
removeSnapshot(snapshotId: string): Promise<Api>;
|
|
119
|
+
downloadSnapshot(snapshotId: string): Promise<Api>;
|
|
120
|
+
/** Check the stored snapshot is intact. */
|
|
121
|
+
verifySnapshot(snapshotId: string): Promise<Api>;
|
|
122
|
+
/** Restore a snapshot; a snapshot of the current state is taken first unless `safetySnapshot` is `false`. */
|
|
123
|
+
restoreSnapshot(snapshotId: string, options?: RestoreOptions & {
|
|
124
|
+
safetySnapshot?: boolean;
|
|
125
|
+
}): Promise<Api>;
|
|
126
|
+
}
|
|
127
|
+
export {};
|
|
128
|
+
//# sourceMappingURL=lifecycle.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lifecycle.d.ts","sourceRoot":"","sources":["../../../src/manage/lifecycle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAE9D,KAAK,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAG1B,uIAAuI;AACvI,qBAAa,YAAa,SAAQ,OAAO;IACvC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,0EAA0E;IAC1E,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvE,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAInC,+FAA+F;IAC/F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAMhH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7C,4HAA4H;IAC5H,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAW9I,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5C,2IAA2I;IAC3I,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvE,sFAAsF;IACtF,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;IAIzB,wEAAwE;IACxE,cAAc,CAAC,SAAS,EAAE,IAAI,EAAE,YAAY,GAAE,MAAM,EAAkC,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrG,8CAA8C;IAC9C,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;CAG3B;AAED,2FAA2F;AAC3F,qBAAa,QAAS,SAAQ,OAAO;IACnC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3H,kDAAkD;IAClD,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAInC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvF,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;IAIzB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1C,+CAA+C;IAC/C,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,SAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlD,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAI3B,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAInF,6DAA6D;IAC7D,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxB,8DAA8D;IAC9D,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAItI,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;CAG5B;AAED,MAAM,WAAW,cAAc;IAC7B,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,wGAAwG;IACxG,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,8EAA8E;AAC9E,qBAAa,OAAQ,SAAQ,OAAO;IAClC,gHAAgH;IAChH,QAAQ,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9F,oCAAoC;IACpC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjE,iKAAiK;IACjK,WAAW,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpM,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;IAIzB,uCAAuC;IACvC,QAAQ,CAAC,IAAI,SAAK,EAAE,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAItF,6DAA6D;IAC7D,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7G,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhD,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlD,2CAA2C;IAC3C,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhD,6GAA6G;IAC7G,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,cAAc,GAAG;QAAE,cAAc,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAS/G"}
|