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

.github/workflows/deno-ci.yaml

@@ -13,9 +13,9 @@ jobs:
     strategy:
       matrix:
         deno-version:
-        - v1.28
-        - v1.32
-        - v1.36
+        - v1.41
+        - v1.43
+        - v1.45
         - canary
       fail-fast: false # run each branch to completion
 
@@ -51,3 +51,20 @@ jobs:
 
     - name: Test
       run: time deno test
+
+  audit-lib:
+    runs-on: ubuntu-latest
+    name: Audit ./lib
+
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v4
+
+    - name: Use Deno v1
+      uses: denoland/setup-deno@v1
+      with:
+        deno-version: v1
+
+    - name: Check publish rules
+      working-directory: lib
+      run: ../with-jsr-deps.sh deno publish --dry-run --allow-dirty

.github/workflows/jsr-publish-lib.yaml

@@ -0,0 +1,25 @@
+name: Publish
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - lib/jsr.json
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    name: Publish ./lib
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+    - uses: denoland/setup-deno@v1
+
+    - uses: actions/checkout@v4
+
+    - name: Publish to JSR
+      working-directory: lib
+      run: ../with-jsr-deps.sh deno publish --allow-dirty

generation/codegen-mod.ts

@@ -37,10 +37,10 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
   chunks.push(`  }\n`);
 
   if (hasNamespaced) {
-    chunks.push(`  namespace(name: string) {`);
+    chunks.push(`  namespace(name: string): ${api.friendlyName}NamespacedApi {`);
     chunks.push(`    return new ${api.friendlyName}NamespacedApi(this.#client, name);`);
     chunks.push(`  }`);
-    chunks.push(`  myNamespace() {`);
+    chunks.push(`  myNamespace(): ${api.friendlyName}NamespacedApi {`);
     chunks.push(`    if (!this.#client.defaultNamespace) throw new Error("No current namespace is set");`);
     chunks.push(`    return new ${api.friendlyName}NamespacedApi(this.#client, this.#client.defaultNamespace);`);
     chunks.push(`  }\n`);
@@ -126,13 +126,13 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
       const funcName = `proxy${middleName}Request`;
 
       args.push([{name: 'opts', in: 'path'}, {type: 'special', name: 'ProxyOptions'}]);
-      const baseSignature = `${funcName}(${writeSig(args, false, '  ')}`.replace('(name:', `(${nameArgName}:`);
+      const baseSignature = `${funcName}(${writeSig(args, false, '    ')}`.replace('name:', `${nameArgName}:`);
 
-      chunks.push(`  ${baseSignature} & {expectStream: true; expectJson: true}): Promise<ReadableStream<c.JSONValue>>;`);
-      chunks.push(`  ${baseSignature} & {expectStream: true}): Promise<ReadableStream<Uint8Array>>;`);
-      chunks.push(`  ${baseSignature} & {expectJson: true}): Promise<c.JSONValue>;`);
-      chunks.push(`  ${baseSignature}): Promise<Uint8Array>;`);
-      chunks.push(`  async ${baseSignature}): Promise<unknown> {`);
+      chunks.push(`  ${baseSignature} & {expectStream: true; expectJson: true},\n  ): Promise<ReadableStream<c.JSONValue>>;`);
+      chunks.push(`  ${baseSignature} & {expectStream: true},\n  ): Promise<ReadableStream<Uint8Array>>;`);
+      chunks.push(`  ${baseSignature} & {expectJson: true},\n  ): Promise<c.JSONValue>;`);
+      chunks.push(`  ${baseSignature},\n  ): Promise<Uint8Array>;`);
+      chunks.push(`  async ${baseSignature},\n  ): Promise<unknown> {`);
       chunks.push(`    if (opts.path && !opts.path.startsWith('/')) throw new Error("Proxy path cannot be relative");`);
       chunks.push(`    const name = (opts.port != null) ? \`\${${nameArgName}}:\${opts.port}\` : ${nameArgName};`);
       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):
     //   return AcmeCertManagerIoV1.toOrder(resp);
     // }
 
-    chunks.push(`  async ${funcName}(${writeSig(args, opts, '  ')}) {`);
     const isWatch = op.operationName.startsWith('watch');
     const isStream = op.operationName.startsWith('stream');
 
+    let returnSig = 'unknown';
+    if (expectsTunnel) {
+      returnSig = `tunnels.${expectsTunnel}`;
+    } else if (isStream) {
+      if (accept === 'text/plain') {
+        returnSig = 'ReadableStream<string>';
+      } else {
+        returnSig = 'ReadableStream<Uint8Array>';
+      }
+    } else if (accept === 'text/plain') {
+      returnSig = 'string';
+    } else if (outShape) {
+      let shape = outShape;
+      // QUIRK: individual deletes can either return a Status or the 'lastExisting' resource
+      // More details further down in this file
+      if (shape.type === 'foreign' &&
+          shape.api.apiGroup === 'meta' &&
+          shape.name === 'Status' &&
+          op.method === 'delete') {
+        shape = api.shapes.shapes.get(op.operationName.replace(/^delete/, ''))!;
+      }
+
+      if (shape.type === 'foreign') {
+        returnSig = `${shape.api.friendlyName}.${shape.name}`;
+      } else if (shape.reference) {
+        returnSig = `${api.friendlyName}.${shape.reference}`;
+      } else throw new Error(`TODO: weird output shape on ${op.operationId}`);
+
+      if (op["x-kubernetes-action"] == 'delete') {
+        returnSig += ` | MetaV1.Status`;
+      }
+      if (isWatch) {
+        returnSig = `c.WatchEventStream<${returnSig.slice(0, -4)}>`;
+      }
+    }
+
+    chunks.push(`  async ${funcName}(${writeSig(args, opts, '    ')},\n  ): Promise<${returnSig}> {`);
+
     const allOptKeys = opts.map(x => x[0].name).sort().join(',');
     const knownOptShape = knownOpts[allOptKeys];
     if (!knownOptShape) {
@@ -342,7 +379,7 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
   }
 
   function writeSig(args: [OpenAPI2RequestParameter, ApiShape][], opts: [OpenAPI2RequestParameter, ApiShape][] | false, indent=''): string {
-    let sigs = new Array<string>();
+    const sigs = new Array<string>();
     for (const arg of args) {
       sigs.push(`${arg[0].name}: ${writeType(arg[1])}`);
     }
@@ -367,7 +404,7 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi):
         sigs.push(`opts: {\n${lines.join('\n')}\n}${allAreOpt ? ' = {}' : ''}`);
       }
     }
-    return sigs.join(', ').replace(/\n/g, '\n'+indent);
+    return `\n${indent}` + sigs.join(',\n').replace(/\n/g, '\n'+indent);
   }
 
 }

generation/codegen-structs.ts

@@ -243,7 +243,7 @@ export function generateStructsTypescript(surface: SurfaceMap, apiS: SurfaceApi)
           const extraStruct = extraStructs.shift();
           if (!extraStruct) break;
 
-          chunks.push(`export function to${extraStruct.name}(input: c.JSONValue) {`);
+          chunks.push(`function to${extraStruct.name}(input: c.JSONValue) {`);
           chunks.push(`  const obj = c.checkObj(input);`);
           chunks.push(`  return {`);
           for (const [field, inner] of extraStruct.struct.fields) {

lib/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lib/README.md

@@ -6,7 +6,7 @@
 
 Generated, typed interfaces to make every possible Kubernetes API request and work with richer data structures.
 
-Actual request transports implemented in `/x/kubernetes_client`.
+The actual request transports are implemented in `/x/kubernetes_client`.
 
 ## Usage
 
@@ -32,6 +32,11 @@ see `/x/kubernetes_client` for more information.
 
 ## Changelog
 
+* `v0.5.1` on `2024-09-18`:
+  * Updating `/x/kubernetes_client` API contract to `v0.7.3`.
+  * Add [JSR publication](https://jsr.io/@cloudydeno/kubernetes-apis) of the module.
+  * Exposed API surface has been adjusted to satisfy JSR "slow types" checks. Shouldn't affect most code.
+
 * `v0.5.0` on `2023-08-19`:
   * Updating `/x/kubernetes_client` API contract to `v0.7.0`.
   * Actually implement PodExec, PodAttach, PodPortForward APIs with a new tunnel implementation.