Skip to content

Commit 3c127fc

Browse files
authored
Set up jsr publication of client lib (#13)
* Start preparing jsr publication of client lib * Remove internal import from deps.ts * Update more imports for file renamings * Add deps.ts file for JSR * Add jsr.json to git * Update code generation for JSR slowtypes rules Generally, all public functions shall have explicit return types. * Remaining slowtypes issues in lib * Wrap API function parameters over multiple lines * Shorten function signature for watch APIs * Restore customized param name for proxy APIs * Try passing typecheck on Deno 1.41 * Update release notes
1 parent 47558c3 commit 3c127fc

File tree

66 files changed

+4213
-1208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+4213
-1208
lines changed

.github/workflows/deno-ci.yaml

+20-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ jobs:
1313
strategy:
1414
matrix:
1515
deno-version:
16-
- v1.28
17-
- v1.32
18-
- v1.36
16+
- v1.41
17+
- v1.43
18+
- v1.45
1919
- canary
2020
fail-fast: false # run each branch to completion
2121

@@ -51,3 +51,20 @@ jobs:
5151

5252
- name: Test
5353
run: time deno test
54+
55+
audit-lib:
56+
runs-on: ubuntu-latest
57+
name: Audit ./lib
58+
59+
steps:
60+
- name: Checkout source
61+
uses: actions/checkout@v4
62+
63+
- name: Use Deno v1
64+
uses: denoland/setup-deno@v1
65+
with:
66+
deno-version: v1
67+
68+
- name: Check publish rules
69+
working-directory: lib
70+
run: ../with-jsr-deps.sh deno publish --dry-run --allow-dirty
+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Publish
2+
on:
3+
push:
4+
branches:
5+
- main
6+
paths:
7+
- lib/jsr.json
8+
9+
jobs:
10+
publish:
11+
runs-on: ubuntu-latest
12+
name: Publish ./lib
13+
14+
permissions:
15+
contents: read
16+
id-token: write
17+
18+
steps:
19+
- uses: denoland/setup-deno@v1
20+
21+
- uses: actions/checkout@v4
22+
23+
- name: Publish to JSR
24+
working-directory: lib
25+
run: ../with-jsr-deps.sh deno publish --allow-dirty

.gitignore

-1
This file was deleted.

generation/codegen-mod.ts

+48-11
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
3737
chunks.push(` }\n`);
3838

3939
if (hasNamespaced) {
40-
chunks.push(` namespace(name: string) {`);
40+
chunks.push(` namespace(name: string): ${api.friendlyName}NamespacedApi {`);
4141
chunks.push(` return new ${api.friendlyName}NamespacedApi(this.#client, name);`);
4242
chunks.push(` }`);
43-
chunks.push(` myNamespace() {`);
43+
chunks.push(` myNamespace(): ${api.friendlyName}NamespacedApi {`);
4444
chunks.push(` if (!this.#client.defaultNamespace) throw new Error("No current namespace is set");`);
4545
chunks.push(` return new ${api.friendlyName}NamespacedApi(this.#client, this.#client.defaultNamespace);`);
4646
chunks.push(` }\n`);
@@ -126,13 +126,13 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
126126
const funcName = `proxy${middleName}Request`;
127127

128128
args.push([{name: 'opts', in: 'path'}, {type: 'special', name: 'ProxyOptions'}]);
129-
const baseSignature = `${funcName}(${writeSig(args, false, ' ')}`.replace('(name:', `(${nameArgName}:`);
129+
const baseSignature = `${funcName}(${writeSig(args, false, ' ')}`.replace('name:', `${nameArgName}:`);
130130

131-
chunks.push(` ${baseSignature} & {expectStream: true; expectJson: true}): Promise<ReadableStream<c.JSONValue>>;`);
132-
chunks.push(` ${baseSignature} & {expectStream: true}): Promise<ReadableStream<Uint8Array>>;`);
133-
chunks.push(` ${baseSignature} & {expectJson: true}): Promise<c.JSONValue>;`);
134-
chunks.push(` ${baseSignature}): Promise<Uint8Array>;`);
135-
chunks.push(` async ${baseSignature}): Promise<unknown> {`);
131+
chunks.push(` ${baseSignature} & {expectStream: true; expectJson: true},\n ): Promise<ReadableStream<c.JSONValue>>;`);
132+
chunks.push(` ${baseSignature} & {expectStream: true},\n ): Promise<ReadableStream<Uint8Array>>;`);
133+
chunks.push(` ${baseSignature} & {expectJson: true},\n ): Promise<c.JSONValue>;`);
134+
chunks.push(` ${baseSignature},\n ): Promise<Uint8Array>;`);
135+
chunks.push(` async ${baseSignature},\n ): Promise<unknown> {`);
136136
chunks.push(` if (opts.path && !opts.path.startsWith('/')) throw new Error("Proxy path cannot be relative");`);
137137
chunks.push(` const name = (opts.port != null) ? \`\${${nameArgName}}:\${opts.port}\` : ${nameArgName};`);
138138
chunks.push(` const path = \`\${this.#root}${JSON.stringify(opPath).slice(1,-1).replace(/{/g, '${')}\${opts.path || ''}\`;`);
@@ -185,10 +185,47 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
185185
// return AcmeCertManagerIoV1.toOrder(resp);
186186
// }
187187

188-
chunks.push(` async ${funcName}(${writeSig(args, opts, ' ')}) {`);
189188
const isWatch = op.operationName.startsWith('watch');
190189
const isStream = op.operationName.startsWith('stream');
191190

191+
let returnSig = 'unknown';
192+
if (expectsTunnel) {
193+
returnSig = `tunnels.${expectsTunnel}`;
194+
} else if (isStream) {
195+
if (accept === 'text/plain') {
196+
returnSig = 'ReadableStream<string>';
197+
} else {
198+
returnSig = 'ReadableStream<Uint8Array>';
199+
}
200+
} else if (accept === 'text/plain') {
201+
returnSig = 'string';
202+
} else if (outShape) {
203+
let shape = outShape;
204+
// QUIRK: individual deletes can either return a Status or the 'lastExisting' resource
205+
// More details further down in this file
206+
if (shape.type === 'foreign' &&
207+
shape.api.apiGroup === 'meta' &&
208+
shape.name === 'Status' &&
209+
op.method === 'delete') {
210+
shape = api.shapes.shapes.get(op.operationName.replace(/^delete/, ''))!;
211+
}
212+
213+
if (shape.type === 'foreign') {
214+
returnSig = `${shape.api.friendlyName}.${shape.name}`;
215+
} else if (shape.reference) {
216+
returnSig = `${api.friendlyName}.${shape.reference}`;
217+
} else throw new Error(`TODO: weird output shape on ${op.operationId}`);
218+
219+
if (op["x-kubernetes-action"] == 'delete') {
220+
returnSig += ` | MetaV1.Status`;
221+
}
222+
if (isWatch) {
223+
returnSig = `c.WatchEventStream<${returnSig.slice(0, -4)}>`;
224+
}
225+
}
226+
227+
chunks.push(` async ${funcName}(${writeSig(args, opts, ' ')},\n ): Promise<${returnSig}> {`);
228+
192229
const allOptKeys = opts.map(x => x[0].name).sort().join(',');
193230
const knownOptShape = knownOpts[allOptKeys];
194231
if (!knownOptShape) {
@@ -342,7 +379,7 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
342379
}
343380

344381
function writeSig(args: [OpenAPI2RequestParameter, ApiShape][], opts: [OpenAPI2RequestParameter, ApiShape][] | false, indent=''): string {
345-
let sigs = new Array<string>();
382+
const sigs = new Array<string>();
346383
for (const arg of args) {
347384
sigs.push(`${arg[0].name}: ${writeType(arg[1])}`);
348385
}
@@ -367,7 +404,7 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
367404
sigs.push(`opts: {\n${lines.join('\n')}\n}${allAreOpt ? ' = {}' : ''}`);
368405
}
369406
}
370-
return sigs.join(', ').replace(/\n/g, '\n'+indent);
407+
return `\n${indent}` + sigs.join(',\n').replace(/\n/g, '\n'+indent);
371408
}
372409

373410
}

generation/codegen-structs.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ export function generateStructsTypescript(surface: SurfaceMap, apiS: SurfaceApi)
243243
const extraStruct = extraStructs.shift();
244244
if (!extraStruct) break;
245245

246-
chunks.push(`export function to${extraStruct.name}(input: c.JSONValue) {`);
246+
chunks.push(`function to${extraStruct.name}(input: c.JSONValue) {`);
247247
chunks.push(` const obj = c.checkObj(input);`);
248248
chunks.push(` return {`);
249249
for (const [field, inner] of extraStruct.struct.fields) {

lib/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

lib/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Generated, typed interfaces to make every possible Kubernetes API request and work with richer data structures.
88

9-
Actual request transports implemented in `/x/kubernetes_client`.
9+
The actual request transports are implemented in `/x/kubernetes_client`.
1010

1111
## Usage
1212

@@ -32,6 +32,11 @@ see `/x/kubernetes_client` for more information.
3232

3333
## Changelog
3434

35+
* `v0.5.1` on `2024-09-18`:
36+
* Updating `/x/kubernetes_client` API contract to `v0.7.3`.
37+
* Add [JSR publication](https://jsr.io/@cloudydeno/kubernetes-apis) of the module.
38+
* Exposed API surface has been adjusted to satisfy JSR "slow types" checks. Shouldn't affect most code.
39+
3540
* `v0.5.0` on `2023-08-19`:
3641
* Updating `/x/kubernetes_client` API contract to `v0.7.0`.
3742
* Actually implement PodExec, PodAttach, PodPortForward APIs with a new tunnel implementation.

0 commit comments

Comments
 (0)