@frontera-sdk/cli 0.1.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.
- package/LICENSE +202 -0
- package/README.md +65 -0
- package/package.json +47 -0
- package/src/api/apps-api.ts +165 -0
- package/src/api/automation-api.ts +140 -0
- package/src/api/platform-api.ts +193 -0
- package/src/api/registry-api.ts +43 -0
- package/src/args.ts +108 -0
- package/src/commands/agent/compose.ts +155 -0
- package/src/commands/agent/index-commands.ts +348 -0
- package/src/commands/agent/resolve.ts +58 -0
- package/src/commands/app/add.ts +78 -0
- package/src/commands/app/deploy.ts +105 -0
- package/src/commands/app/init.ts +53 -0
- package/src/commands/app/list.ts +51 -0
- package/src/commands/app/promote.ts +31 -0
- package/src/commands/app/pull.ts +145 -0
- package/src/commands/app/save.ts +36 -0
- package/src/commands/app/shared.ts +25 -0
- package/src/commands/app/versions.ts +38 -0
- package/src/commands/automation/index-commands.ts +325 -0
- package/src/commands/blueprint/get.ts +160 -0
- package/src/commands/blueprint/list.ts +48 -0
- package/src/commands/blueprint/reserved.ts +40 -0
- package/src/commands/completion.ts +293 -0
- package/src/commands/init.ts +33 -0
- package/src/commands/knowledge/index-commands.ts +140 -0
- package/src/commands/login.ts +103 -0
- package/src/commands/plugin/index-commands.ts +112 -0
- package/src/commands/registry.ts +405 -0
- package/src/commands/skill/index-commands.ts +140 -0
- package/src/commands/types.ts +76 -0
- package/src/config.ts +142 -0
- package/src/context.ts +67 -0
- package/src/errors.ts +30 -0
- package/src/exit.ts +98 -0
- package/src/flag-help.ts +70 -0
- package/src/harness.ts +162 -0
- package/src/heal.ts +418 -0
- package/src/help.ts +128 -0
- package/src/main.ts +204 -0
- package/src/manifest.ts +80 -0
- package/src/output.ts +65 -0
- package/src/pack.ts +18 -0
- package/src/packaging.ts +116 -0
- package/src/project.ts +151 -0
- package/src/prompt.ts +48 -0
- package/src/registry.ts +62 -0
- package/src/secrets.ts +69 -0
- package/src/table.ts +47 -0
- package/src/tar.ts +73 -0
- package/src/template.ts +566 -0
- package/src/vendor/sdk-sources.json +25 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Sebati
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# @frontera-sdk/cli
|
|
2
|
+
|
|
3
|
+
`frontera` — scaffold, pull, save and deploy Frontera apps and automations.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
bunx @frontera-sdk/cli --help
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
frontera login
|
|
11
|
+
frontera app init shipments-console
|
|
12
|
+
cd shipments-console && bun install && bun run dev
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Then open **`/dev-host.html`**, not `/`. An app served straight from Vite never
|
|
16
|
+
mounts: the handshake refuses a parent that is not the platform, and renders a
|
|
17
|
+
panel saying so. The dev host frames the app and plays the host side of the
|
|
18
|
+
bridge, so it mounts and reads real data.
|
|
19
|
+
|
|
20
|
+
## The commands
|
|
21
|
+
|
|
22
|
+
`frontera <noun> <verb>`. Note that `frontera init` (prepare an existing
|
|
23
|
+
project) and `frontera app init` (scaffold a new app) are different commands.
|
|
24
|
+
|
|
25
|
+
| | |
|
|
26
|
+
|---|---|
|
|
27
|
+
| `frontera app init <name>` | scaffold a new app |
|
|
28
|
+
| `frontera app pull <slug>` | fetch an existing app's source |
|
|
29
|
+
| `frontera app save` | package the working tree to storage |
|
|
30
|
+
| `frontera app deploy` | build output → an immutable version |
|
|
31
|
+
| `frontera app list` / `versions` | what exists, what is live |
|
|
32
|
+
| `frontera blueprint list` / `get` | what data an app can read |
|
|
33
|
+
|
|
34
|
+
`frontera help --json` returns the whole table as data.
|
|
35
|
+
|
|
36
|
+
## Exit codes are a contract
|
|
37
|
+
|
|
38
|
+
`0` success · `1` transient · `2` usage · `3` conflict · `4` auth. Branch on
|
|
39
|
+
them rather than on message text.
|
|
40
|
+
|
|
41
|
+
## Scaffolded apps carry the SDK
|
|
42
|
+
|
|
43
|
+
`frontera app init` writes `@frontera-sdk/core` and `@frontera-sdk/blueprint` into
|
|
44
|
+
`src/frontera/` and resolves the `@frontera-sdk/…` specifiers with tsconfig paths
|
|
45
|
+
and a matching Vite alias, so a new app installs with nothing but public npm.
|
|
46
|
+
`frontera app pull` repairs a tree that predates that — including one whose
|
|
47
|
+
dependencies point at paths on the machine that published it.
|
|
48
|
+
|
|
49
|
+
## It runs on Bun, not Node
|
|
50
|
+
|
|
51
|
+
`bin` points at `src/main.ts` and the package ships TypeScript source, so:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
bunx --bun @frontera-sdk/cli app init # works
|
|
55
|
+
npm i -g @frontera-sdk/cli && frontera # does NOT — Node cannot run the .ts entry
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
`engines.bun` says so in the manifest. Publishing source rather than a bundle is
|
|
59
|
+
deliberate — every consumer is Bun or a bundler, and a build step would emit
|
|
60
|
+
output the consumer immediately re-transpiles — but it does mean a global
|
|
61
|
+
`npm i -g` is not a supported install.
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
Apache-2.0. See [LICENSE](./LICENSE).
|
package/package.json
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@frontera-sdk/cli",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "The frontera CLI — scaffold, pull, save and deploy Frontera apps and automations.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"frontera",
|
|
7
|
+
"cli"
|
|
8
|
+
],
|
|
9
|
+
"license": "Apache-2.0",
|
|
10
|
+
"type": "module",
|
|
11
|
+
"files": [
|
|
12
|
+
"src",
|
|
13
|
+
"!src/__tests__",
|
|
14
|
+
"!src/**/*.test.ts",
|
|
15
|
+
"README.md",
|
|
16
|
+
"LICENSE"
|
|
17
|
+
],
|
|
18
|
+
"publishConfig": {
|
|
19
|
+
"access": "public"
|
|
20
|
+
},
|
|
21
|
+
"bin": {
|
|
22
|
+
"frontera": "./src/main.ts"
|
|
23
|
+
},
|
|
24
|
+
"engines": {
|
|
25
|
+
"bun": ">=1.2.0"
|
|
26
|
+
},
|
|
27
|
+
"exports": {
|
|
28
|
+
"./packaging": {
|
|
29
|
+
"types": "./src/packaging.ts",
|
|
30
|
+
"import": "./src/packaging.ts"
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"test": "bun test",
|
|
35
|
+
"typecheck": "bunx tsc --noEmit",
|
|
36
|
+
"sync:sdk": "bun run scripts/sync-sdk.ts",
|
|
37
|
+
"build:release": "bun run scripts/build-release.ts"
|
|
38
|
+
},
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"@frontera-sdk/automation": "0.1.0",
|
|
41
|
+
"@frontera-sdk/core": "0.1.0"
|
|
42
|
+
},
|
|
43
|
+
"devDependencies": {
|
|
44
|
+
"@types/bun": "latest",
|
|
45
|
+
"typescript": "^5.9.3"
|
|
46
|
+
}
|
|
47
|
+
}
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
import { FronteraClient } from '@frontera-sdk/core/client'
|
|
2
|
+
import { FronteraError } from '@frontera-sdk/core/errors'
|
|
3
|
+
|
|
4
|
+
export interface AppVersionSummary {
|
|
5
|
+
version: string
|
|
6
|
+
parentVersion: string | null
|
|
7
|
+
contentDigest: string
|
|
8
|
+
fileCount: number
|
|
9
|
+
totalBytes: number
|
|
10
|
+
uploadedBy: string
|
|
11
|
+
createdAt: string
|
|
12
|
+
deployed: boolean
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Version-endpoint wrapper.
|
|
17
|
+
*
|
|
18
|
+
* Multipart bodies are built here rather than in `@frontera-sdk/core`, whose
|
|
19
|
+
* transport is JSON-only on purpose — uploads are a CLI concern, and pushing
|
|
20
|
+
* `FormData` handling into the shared transport would complicate every other
|
|
21
|
+
* consumer for one caller.
|
|
22
|
+
*/
|
|
23
|
+
export class AppsApi {
|
|
24
|
+
private readonly client: FronteraClient
|
|
25
|
+
|
|
26
|
+
constructor(apiBaseUrl: string, token: string) {
|
|
27
|
+
this.client = new FronteraClient({
|
|
28
|
+
apiBaseUrl,
|
|
29
|
+
credential: { kind: 'apiKey', key: token },
|
|
30
|
+
})
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
private get base() {
|
|
34
|
+
return this.client.config.apiBaseUrl
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
private authHeader(): Record<string, string> {
|
|
38
|
+
const c = this.client.config.credential
|
|
39
|
+
return { authorization: `Bearer ${c.kind === 'apiKey' ? c.key : c.token}` }
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
private async multipart<T>(path: string, form: FormData, method = 'POST'): Promise<T> {
|
|
43
|
+
const res = await fetch(`${this.base}${path}`, {
|
|
44
|
+
method,
|
|
45
|
+
headers: this.authHeader(),
|
|
46
|
+
body: form,
|
|
47
|
+
})
|
|
48
|
+
const text = await res.text()
|
|
49
|
+
let parsed: unknown = null
|
|
50
|
+
try {
|
|
51
|
+
parsed = text ? JSON.parse(text) : null
|
|
52
|
+
} catch {
|
|
53
|
+
parsed = text
|
|
54
|
+
}
|
|
55
|
+
if (!res.ok) {
|
|
56
|
+
const body = parsed as { code?: string; message?: string } | null
|
|
57
|
+
throw new FronteraError(body?.message ?? `request failed with ${res.status}`, {
|
|
58
|
+
code: body?.code ?? 'INTERNAL_ERROR',
|
|
59
|
+
status: res.status,
|
|
60
|
+
details: parsed,
|
|
61
|
+
})
|
|
62
|
+
}
|
|
63
|
+
const envelope = parsed as { data?: T } | null
|
|
64
|
+
return (envelope && 'data' in envelope ? envelope.data : parsed) as T
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* Resolve (or create) the app this project deploys to.
|
|
69
|
+
*
|
|
70
|
+
* `appId` wins when the project has one. A slug can be renamed in the
|
|
71
|
+
* platform, and matching on it alone would quietly create a second app
|
|
72
|
+
* rather than updating this one.
|
|
73
|
+
*/
|
|
74
|
+
async ensureApp(
|
|
75
|
+
slug: string,
|
|
76
|
+
displayName: string,
|
|
77
|
+
appId?: string | null,
|
|
78
|
+
): Promise<{ id: string; slug: string; created: boolean }> {
|
|
79
|
+
return this.client.request<{ id: string; slug: string; created: boolean }>('/v1/platform-apps/ensure', {
|
|
80
|
+
method: 'POST',
|
|
81
|
+
body: appId ? { slug, displayName, appId } : { slug, displayName },
|
|
82
|
+
})
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Find an existing app by slug or id — never creating one.
|
|
87
|
+
*
|
|
88
|
+
* `pull` used `ensureApp`, so a typo or a slug the platform had since
|
|
89
|
+
* renamed produced a brand new empty app instead of an error.
|
|
90
|
+
*/
|
|
91
|
+
resolveApp(slugOrId: string): Promise<{ id: string; slug: string; displayName: string }> {
|
|
92
|
+
return this.client.request<{ id: string; slug: string; displayName: string }>(
|
|
93
|
+
`/v1/platform-apps/resolve/${encodeURIComponent(slugOrId)}`,
|
|
94
|
+
)
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
listVersions(appId: string): Promise<AppVersionSummary[]> {
|
|
98
|
+
return this.client.request<AppVersionSummary[]>(`/v1/platform-apps/${appId}/versions`)
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
publish(appId: string, args: {
|
|
102
|
+
version: string
|
|
103
|
+
parentVersion?: string | null
|
|
104
|
+
dist: Uint8Array
|
|
105
|
+
source: Uint8Array
|
|
106
|
+
manifest?: unknown
|
|
107
|
+
promote: boolean
|
|
108
|
+
}) {
|
|
109
|
+
const form = new FormData()
|
|
110
|
+
form.set('version', args.version)
|
|
111
|
+
if (args.parentVersion) form.set('parentVersion', args.parentVersion)
|
|
112
|
+
form.set('dist', new Blob([args.dist], { type: 'application/gzip' }), 'dist.tgz')
|
|
113
|
+
form.set('source', new Blob([args.source], { type: 'application/gzip' }), 'src.tgz')
|
|
114
|
+
if (args.manifest) form.set('manifest', JSON.stringify(args.manifest))
|
|
115
|
+
form.set('promote', args.promote ? 'true' : 'false')
|
|
116
|
+
return this.multipart<{ version: string; promoted: boolean; fileCount: number; totalBytes: number }>(
|
|
117
|
+
`/v1/platform-apps/${appId}/versions`,
|
|
118
|
+
form,
|
|
119
|
+
)
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
async downloadSource(appId: string, version: string): Promise<Uint8Array> {
|
|
123
|
+
const res = await fetch(`${this.base}/v1/platform-apps/${appId}/versions/${version}/source`, {
|
|
124
|
+
headers: this.authHeader(),
|
|
125
|
+
})
|
|
126
|
+
if (!res.ok) {
|
|
127
|
+
throw new FronteraError(`could not download source for ${version}`, {
|
|
128
|
+
code: 'NOT_FOUND',
|
|
129
|
+
status: res.status,
|
|
130
|
+
})
|
|
131
|
+
}
|
|
132
|
+
return new Uint8Array(await res.arrayBuffer())
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
async downloadDraft(appId: string): Promise<{ bytes: Uint8Array; parentVersion: string | null }> {
|
|
136
|
+
const res = await fetch(`${this.base}/v1/platform-apps/${appId}/draft`, {
|
|
137
|
+
headers: this.authHeader(),
|
|
138
|
+
})
|
|
139
|
+
if (!res.ok) {
|
|
140
|
+
throw new FronteraError('no draft saved for this app', { code: 'NOT_FOUND', status: res.status })
|
|
141
|
+
}
|
|
142
|
+
return {
|
|
143
|
+
bytes: new Uint8Array(await res.arrayBuffer()),
|
|
144
|
+
parentVersion: res.headers.get('x-frontera-parent-version') || null,
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
saveDraft(appId: string, source: Uint8Array, parentVersion?: string | null) {
|
|
149
|
+
const form = new FormData()
|
|
150
|
+
form.set('source', new Blob([source], { type: 'application/gzip' }), 'src.tgz')
|
|
151
|
+
if (parentVersion) form.set('parentVersion', parentVersion)
|
|
152
|
+
return this.multipart<{ fileCount: number; totalBytes: number }>(
|
|
153
|
+
`/v1/platform-apps/${appId}/draft`,
|
|
154
|
+
form,
|
|
155
|
+
'PUT',
|
|
156
|
+
)
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
deploy(appId: string, version: string) {
|
|
160
|
+
return this.client.request<{ deployedVersion: string }>(`/v1/platform-apps/${appId}/deploy`, {
|
|
161
|
+
method: 'POST',
|
|
162
|
+
body: { version },
|
|
163
|
+
})
|
|
164
|
+
}
|
|
165
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { FronteraClient } from '@frontera-sdk/core/client'
|
|
2
|
+
import { FronteraError } from '@frontera-sdk/core/errors'
|
|
3
|
+
|
|
4
|
+
/** A row of `GET /v1/automations/` — the shell, not any one version of it. */
|
|
5
|
+
export interface AutomationSummary {
|
|
6
|
+
id: string
|
|
7
|
+
slug: string
|
|
8
|
+
description: string | null
|
|
9
|
+
enabled: boolean
|
|
10
|
+
/** Null until the first promote: deployed but nothing carries the trigger. */
|
|
11
|
+
liveVersionId: string | null
|
|
12
|
+
createdAt: string
|
|
13
|
+
updatedAt: string
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export interface AutomationVersionSummary {
|
|
17
|
+
id: string
|
|
18
|
+
version: number
|
|
19
|
+
contentDigest: string
|
|
20
|
+
manifest: unknown
|
|
21
|
+
totalBytes: number
|
|
22
|
+
uploadedBy: string
|
|
23
|
+
retiredAt: string | null
|
|
24
|
+
createdAt: string
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface AutomationDeployResult {
|
|
28
|
+
automationId: string
|
|
29
|
+
versionId: string
|
|
30
|
+
version: number
|
|
31
|
+
digest: string
|
|
32
|
+
promoted: boolean
|
|
33
|
+
/**
|
|
34
|
+
* When a runner last fetched the registry, or null if one never has.
|
|
35
|
+
*
|
|
36
|
+
* Optional because an older service will not send it — and an ABSENT field
|
|
37
|
+
* must not read as "no runner", which would print a false warning against
|
|
38
|
+
* every environment running a service from before this change.
|
|
39
|
+
*/
|
|
40
|
+
runnerLastSeenAt?: string | null
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Client for the automation routes.
|
|
45
|
+
*
|
|
46
|
+
* Reads and flag writes go through `FronteraClient`, whose transport unwraps
|
|
47
|
+
* the service envelope and raises a `FronteraError` carrying the service's
|
|
48
|
+
* code — which is what `exitCodeFor` maps to an exit code, so a 404 exits 2 and
|
|
49
|
+
* a 401 exits 4 rather than everything collapsing to 1.
|
|
50
|
+
*
|
|
51
|
+
* `deploy` cannot: the transport is JSON-only on purpose, and a bundle is
|
|
52
|
+
* multipart. It is built here for the same reason `AppsApi` builds its own —
|
|
53
|
+
* uploads are a CLI concern, and pushing `FormData` into the shared transport
|
|
54
|
+
* would complicate every other consumer for one caller.
|
|
55
|
+
*/
|
|
56
|
+
export class AutomationApi {
|
|
57
|
+
private readonly client: FronteraClient
|
|
58
|
+
|
|
59
|
+
constructor(apiBaseUrl: string, token: string) {
|
|
60
|
+
this.client = new FronteraClient({
|
|
61
|
+
apiBaseUrl,
|
|
62
|
+
credential: { kind: 'apiKey', key: token },
|
|
63
|
+
})
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
list(): Promise<AutomationSummary[]> {
|
|
67
|
+
return this.client.request<AutomationSummary[]>('/v1/automations/')
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
versions(slug: string): Promise<AutomationVersionSummary[]> {
|
|
71
|
+
return this.client.request<AutomationVersionSummary[]>(
|
|
72
|
+
`/v1/automations/${encodeURIComponent(slug)}/versions`,
|
|
73
|
+
)
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
promote(slug: string, version: number): Promise<{ slug: string; version: number }> {
|
|
77
|
+
return this.client.request<{ slug: string; version: number }>(
|
|
78
|
+
`/v1/automations/${encodeURIComponent(slug)}/promote/${version}`,
|
|
79
|
+
{ method: 'POST' },
|
|
80
|
+
)
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
setEnabled(slug: string, enabled: boolean): Promise<{ slug: string; enabled: boolean }> {
|
|
84
|
+
return this.client.request<{ slug: string; enabled: boolean }>(
|
|
85
|
+
`/v1/automations/${encodeURIComponent(slug)}/enabled`,
|
|
86
|
+
{ method: 'POST', body: { enabled } },
|
|
87
|
+
)
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Upload a built bundle as the next version.
|
|
92
|
+
*
|
|
93
|
+
* The manifest travels as JSON text. Elysia's multipart parser deserializes a
|
|
94
|
+
* field whose value parses as JSON, so the handler receives an object either
|
|
95
|
+
* way — its schema is `t.Unknown()` for exactly that reason — and sending the
|
|
96
|
+
* string keeps this end honest about what a form field is.
|
|
97
|
+
*/
|
|
98
|
+
async deploy(
|
|
99
|
+
slug: string,
|
|
100
|
+
args: { manifest: unknown; bundle: Uint8Array; promote: boolean },
|
|
101
|
+
): Promise<AutomationDeployResult> {
|
|
102
|
+
const form = new FormData()
|
|
103
|
+
form.set('manifest', JSON.stringify(args.manifest))
|
|
104
|
+
form.set('bundle', new Blob([args.bundle], { type: 'application/javascript' }), 'bundle.js')
|
|
105
|
+
// The service promotes unless the field is the literal "false".
|
|
106
|
+
form.set('promote', args.promote ? 'true' : 'false')
|
|
107
|
+
|
|
108
|
+
const credential = this.client.config.credential
|
|
109
|
+
const res = await fetch(
|
|
110
|
+
`${this.client.config.apiBaseUrl}/v1/automations/${encodeURIComponent(slug)}/versions`,
|
|
111
|
+
{
|
|
112
|
+
method: 'POST',
|
|
113
|
+
headers: {
|
|
114
|
+
authorization: `Bearer ${credential.kind === 'apiKey' ? credential.key : credential.token}`,
|
|
115
|
+
},
|
|
116
|
+
body: form,
|
|
117
|
+
},
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
const text = await res.text()
|
|
121
|
+
let parsed: unknown = null
|
|
122
|
+
try {
|
|
123
|
+
parsed = text ? JSON.parse(text) : null
|
|
124
|
+
} catch {
|
|
125
|
+
parsed = text
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
if (!res.ok) {
|
|
129
|
+
const body = parsed as { code?: string; message?: string } | null
|
|
130
|
+
throw new FronteraError(body?.message ?? `request failed with ${res.status}`, {
|
|
131
|
+
code: body?.code ?? 'INTERNAL_ERROR',
|
|
132
|
+
status: res.status,
|
|
133
|
+
details: parsed,
|
|
134
|
+
})
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
const envelope = parsed as { data?: AutomationDeployResult } | null
|
|
138
|
+
return (envelope && 'data' in envelope ? envelope.data : parsed) as AutomationDeployResult
|
|
139
|
+
}
|
|
140
|
+
}
|