@depup/kubernetes-client 9.0.0-depup.0

package/lib/swagger-client.js

@@ -0,0 +1,233 @@
+'use strict'
+/* eslint-disable no-sync */
+
+/**
+ * @file Convert a Swagger specification into a kubernetes-client API client.
+ *
+ * Represent Swagger a Path Item Object [1] with chains of objects:
+ *
+ *   /api/v1/namespaces -> api.v1.namespaces
+ *
+ * Associate operations on a Path Item Object with functions:
+ *
+ *   GET /api/v1/namespaces -> api.v1.namespaces.get()
+ *
+ * Represent Path Templating [2] with function calls:
+ *
+ *   /api/v1/namespaces/{namespace}/pods -> api.v1.namespaces(namespace).pods
+ *
+ * Iterate over a Paths Object [3] to generate whole API client.
+ *
+ * [1]: https://swagger.io/specification/#pathItemObject
+ * [2]: https://swagger.io/specification/#pathTemplating
+ * [3]: https://swagger.io/specification/#pathsObject
+ */
+
+const Component = require('swagger-fluent').Component
+const deprecate = require('depd')('kubernetes-client')
+const fs = require('fs')
+const KubeConfig = require('./config')
+const path = require('path')
+const zlib = require('zlib')
+
+const getAliases = require('./alias')
+const Request = require('../backends/request')
+
+class Root extends Component {
+  _getSpec (pathname) {
+    return this.backend.http({ method: 'GET', pathname })
+      .then(res => {
+        return res.body
+      })
+  }
+
+  /**
+   * Load swagger.json from kube-apiserver.
+   * @returns {Promise} Promise
+   */
+  loadSpec () {
+    return this._getSpec('/openapi/v2')
+      .catch(() => {
+        return this._getSpec('/swagger.json')
+      })
+      .then(res => {
+        this._addSpec(res)
+        return this
+      })
+      .catch(err => {
+        throw new Error(`Failed to get /openapi/v2 and /swagger.json: ${err.message}`)
+      })
+  }
+
+  _getLogByteStream (options) {
+    return this.backend.getLogByteStream(Object.assign({
+      method: 'GET',
+      pathItemObject: this.pathItemObject,
+      pathname: this.getPath(),
+      pathnameParameters: this.getPathnameParameters()
+    }, options))
+  }
+
+  async _getWatchObjectStream (options) {
+    return this.backend.getWatchObjectStream(Object.assign({
+      method: 'GET',
+      pathItemObject: this.pathItemObject,
+      pathname: this.getPath(),
+      pathnameParameters: this.getPathnameParameters()
+    }, options))
+  }
+
+  _addEndpoint (endpoint) {
+    const component = super._addEndpoint(endpoint)
+    if (!component) return component
+
+    //
+    // Deprecate stream API.
+    //
+    if (endpoint.pathItem.get) {
+      const action = endpoint.pathItem.get['x-kubernetes-action']
+      if (action === 'watch' || action === 'watchlist') {
+        component.getStream = deprecate.function(
+          component.getStream,
+          '.getStream use .getObjectStream, see ' +
+            'https://github.com/godaddy/kubernetes-client/blob/master/merging-with-kubernetes.md')
+        component.getObjectStream = component._getWatchObjectStream
+      } else if (endpoint.name === '/api/v1/namespaces/{namespace}/pods/{name}/log') {
+        component.getStream = deprecate.function(
+          component.getStream,
+          '.getStream use .getByteStream, see ' +
+            'https://github.com/godaddy/kubernetes-client/blob/master/merging-with-kubernetes.md')
+        component.getByteStream = component._getLogByteStream
+      } else {
+        component.getStream = deprecate.function(
+          component.getStream,
+          '.getStream see https://github.com/godaddy/kubernetes-client/blob/master/merging-with-kubernetes.md')
+      }
+    }
+  }
+
+  addCustomResourceDefinition (manifest) {
+    const group = manifest.spec.group
+    const name = manifest.spec.names.plural
+    const namespace = manifest.spec.scope === 'Cluster' ? '' : '/namespaces/{namespace}'
+
+    const addSpec = (version) => {
+      const spec = { paths: {} }
+      //
+      // Make just enough of Swagger spec to generate some useful endpoints.
+      //
+      const templatePath = `/apis/${group}/${version}${namespace}/${name}/{name}`
+      spec.paths[templatePath] = ['delete', 'get', 'patch', 'put'].reduce((acc, method) => {
+        acc[method] = { operationId: `${method}Template${name}` }
+        return acc
+      }, {})
+
+      const resourcePath = `/apis/${group}/${version}${namespace}/${name}`
+      spec.paths[resourcePath] = ['get', 'post'].reduce((acc, method) => {
+        acc[method] = { operationId: `${method}${name}` }
+        return acc
+      }, {})
+      //
+      // Namespaced CRDs get a cluster-level GET endpoint.
+      // Similar to GET /api/v1/pods.
+      //
+      if (manifest.spec.scope === 'Namespaced') {
+        const clusterPath = `/apis/${group}/${version}/${name}`
+        spec.paths[clusterPath] = {
+          get: {
+            operationId: `getCluster${name}`
+          }
+        }
+      }
+
+      const watchPaths = {
+        watchCluster: `/apis/${group}/${version}/watch/${name}`,
+        watchNamespace: `/apis/${group}/${version}/watch${namespace}/${name}`,
+        watchResource: `/apis/${group}/${version}/watch${namespace}/${name}/{name}`
+      }
+      Object.keys(watchPaths).forEach(operationId => {
+        const watchPath = watchPaths[operationId]
+        spec.paths[watchPath] = {
+          get: {
+            'x-kubernetes-action': 'watch',
+            operationId: `operationId${name}`
+          }
+        }
+      })
+
+      // Add status endpoint - see https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#customresourcesubresourcestatus-v1beta1-apiextensions-k8s-io
+      if (manifest.spec.subresources && manifest.spec.subresources.status) {
+        const statusPath = `/apis/${group}/${version}${namespace}/${name}/{name}/status`
+        spec.paths[statusPath] = ['get', 'put'].reduce((acc, method) => {
+          acc[method] = { operationId: `${method}Template${name}` }
+          return acc
+        }, {})
+      }
+
+      // Add scale endpoints - see https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#customresourcesubresourcescale-v1beta1-apiextensions-k8s-io
+      if (manifest.spec.subresources && manifest.spec.subresources.scale) {
+        const statusPath = `/apis/${group}/${version}${namespace}/${name}/{name}/scale`
+        spec.paths[statusPath] = ['get', 'put'].reduce((acc, method) => {
+          acc[method] = { operationId: `${method}Template${name}` }
+          return acc
+        }, {})
+      }
+
+      this._addSpec(spec)
+    }
+
+    if (manifest.spec.version) {
+      addSpec(manifest.spec.version)
+    } else {
+      const versions = manifest.spec.versions || []
+      versions.forEach(version => addSpec(version.name))
+    }
+  }
+}
+
+class Client {
+  constructor (options) {
+    options = options || {}
+
+    if (options.config) {
+      deprecate('Client({ config }), see ' +
+                'https://github.com/godaddy/kubernetes-client/blob/master/merging-with-kubernetes.md')
+    }
+
+    let backend = options.backend
+    if (!backend) {
+      if (options.config) {
+        backend = new Request(options.config)
+      } else {
+        const kubeconfig = new KubeConfig()
+        kubeconfig.loadFromDefault()
+        backend = new Request({ kubeconfig })
+      }
+    }
+
+    let spec = options.spec
+    if (!spec && options.version) {
+      const swaggerPath = path.join(
+        __dirname,
+        'specs',
+        `swagger-${options.version}.json.gz`)
+      spec = JSON.parse(zlib.gunzipSync(fs.readFileSync(swaggerPath)))
+    }
+
+    const root = new Root({ splits: [], backend, getNames: options.getNames || getAliases })
+    if (spec) root._addSpec(spec)
+    return root
+  }
+}
+
+// eslint-disable-next-line camelcase
+class Client1_13 extends Client {
+  constructor (options) {
+    super(Object.assign({}, options, { version: '1.13' }))
+  }
+}
+
+module.exports = {
+  Client,
+  Client1_13
+}

package/package.json

@@ -0,0 +1,119 @@
+{
+  "name": "@depup/kubernetes-client",
+  "version": "9.0.0-depup.0",
+  "description": "[DepUp] Simplified Kubernetes API client.",
+  "main": "lib/index.js",
+  "types": "./typings/index.d.ts",
+  "scripts": {
+    "coverage": "nyc mocha 'lib/**/*.test.js'",
+    "docs": "node scripts/docs.js --builtins",
+    "typings": "node scripts/typings.js --spec lib/specs/swagger-1.13.json.gz --output typings/index.d.ts",
+    "lint": "standard --fix",
+    "release": "standard-version --tag-prefix=''",
+    "test": "standard && mocha 'lib/**/*.test.js' 'backends/**/*.test.js' && npm run test-typings && npm run test-generated",
+    "test-10": "standard && mocha 'lib/**/*.test.js' 'backends/**/*.test.js' && npm run test-typings",
+    "test-generated": "scripts/test-generated.sh",
+    "test-integration": "integration/run-mocha.sh integration/test --timeout 30000",
+    "test-typings": "tsc --project ./typings"
+  },
+  "repository": "godaddy/kubernetes-client",
+  "keywords": [
+    "depup",
+    "dependency-bumped",
+    "updated-deps",
+    "kubernetes-client",
+    "kubernetes",
+    "kubectl",
+    "containers"
+  ],
+  "author": "GoDaddy Operating Company, LLC",
+  "license": "MIT",
+  "engines": {
+    "node": ">=10.13.0"
+  },
+  "files": [
+    "backends",
+    "lib",
+    "typings",
+    "changes.json",
+    "README.md"
+  ],
+  "dependencies": {
+    "@kubernetes/client-node": "^1.4.0",
+    "camelcase": "^9.0.0",
+    "deepmerge": "^4.3.1",
+    "depd": "^2.0.0",
+    "js-yaml": "^4.1.1",
+    "json-stream": "^1.0.0",
+    "openid-client": "^6.8.2",
+    "pump": "^3.0.4",
+    "qs": "^6.15.0",
+    "request": "^2.88.2",
+    "swagger-fluent": "^5.0.3",
+    "url-join": "^5.0.0",
+    "ws": "^8.19.0"
+  },
+  "devDependencies": {
+    "@types/node": "13.13.4",
+    "chai": "4.2.0",
+    "mocha": "7.1.2",
+    "mustache": "4.0.1",
+    "nock": "12.0.3",
+    "nyc": "15.0.1",
+    "sinon": "9.0.2",
+    "standard": "14.3.3",
+    "standard-version": "7.1.0",
+    "typescript": "3.8.3",
+    "yargs": "15.3.1"
+  },
+  "nyc": {
+    "check-coverage": true,
+    "lines": 80,
+    "functions": 70
+  },
+  "depup": {
+    "changes": {
+      "@kubernetes/client-node": {
+        "from": "0.10.2",
+        "to": "^1.4.0"
+      },
+      "camelcase": {
+        "from": "^6.0.0",
+        "to": "^9.0.0"
+      },
+      "deepmerge": {
+        "from": "^4.2.2",
+        "to": "^4.3.1"
+      },
+      "js-yaml": {
+        "from": "^3.13.1",
+        "to": "^4.1.1"
+      },
+      "openid-client": {
+        "from": "^3.14.0",
+        "to": "^6.8.2"
+      },
+      "pump": {
+        "from": "^3.0.0",
+        "to": "^3.0.4"
+      },
+      "qs": {
+        "from": "^6.9.0",
+        "to": "^6.15.0"
+      },
+      "url-join": {
+        "from": "^4.0.1",
+        "to": "^5.0.0"
+      },
+      "ws": {
+        "from": "^7.2.3",
+        "to": "^8.19.0"
+      }
+    },
+    "depsUpdated": 9,
+    "originalPackage": "kubernetes-client",
+    "originalVersion": "9.0.0",
+    "processedAt": "2026-03-17T22:56:52.656Z",
+    "smokeTest": "passed"
+  }
+}