@overkube/kube-types 0.0.0 → 0.1.4

package/dist/object.d.ts

@@ -0,0 +1,33 @@
+import type { ObjectMeta } from './gen/meta/v1.js';
+/** Any Kubernetes object: what a kind with no types of its own (a CRD) is seen as. */
+export interface KubeObject<Spec = unknown, Status = unknown> {
+    apiVersion?: string;
+    kind?: string;
+    metadata?: ObjectMeta;
+    spec?: Spec;
+    status?: Status;
+}
+/** Where a kind lives in the API: what a list or a watch of it is asked at. */
+export interface GroupVersionKind {
+    /** "" for the core group (Pods, Services, …). */
+    group: string;
+    version: string;
+    kind: string;
+}
+/** A kind as the kinds table describes it (kinds.apps.v1.Deployment). */
+export interface KindInfo extends GroupVersionKind {
+    /** apiVersion and kind: "v1/Pod", "apps/v1/Deployment"; the key of KindMap. */
+    id: string;
+    /** In the API's URLs: /apis/apps/v1/namespaces/<ns>/deployments. */
+    plural: string;
+    singular: string;
+    namespaced: boolean;
+    verbs: readonly string[];
+    shortNames?: readonly string[];
+    categories?: readonly string[];
+    /** Its subresources, as discovery lists them: "status", "scale", "log". */
+    subresources?: readonly string[];
+}
+/** The apiVersion an object of this kind carries: "v1", "apps/v1". */
+export declare function apiVersion({ group, version }: GroupVersionKind): string;
+//# sourceMappingURL=object.d.ts.map

package/dist/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,sFAAsF;AACtF,MAAM,WAAW,UAAU,CAAC,IAAI,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,+EAA+E;AAC/E,MAAM,WAAW,gBAAgB;IAC/B,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yEAAyE;AACzE,MAAM,WAAW,QAAS,SAAQ,gBAAgB;IAChD,+EAA+E;IAC/E,EAAE,EAAE,MAAM,CAAC;IACX,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B,2EAA2E;IAC3E,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAClC;AAED,sEAAsE;AACtE,wBAAgB,UAAU,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,gBAAgB,GAAG,MAAM,CAEvE"}

package/dist/object.js

@@ -0,0 +1,5 @@
+/** The apiVersion an object of this kind carries: "v1", "apps/v1". */
+export function apiVersion({ group, version }) {
+    return group ? `${group}/${version}` : version;
+}
+//# sourceMappingURL=object.js.map

package/dist/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../src/object.ts"],"names":[],"mappings":"AAkCA,sEAAsE;AACtE,MAAM,UAAU,UAAU,CAAC,EAAE,KAAK,EAAE,OAAO,EAAoB;IAC7D,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AACjD,CAAC"}

package/package.json

@@ -1,7 +1,38 @@
 {
   "name": "@overkube/kube-types",
-  "version": "0.0.0",
-  "description": "Placeholder: reserved for overkube (github.com/overweave/overkube).",
+  "version": "0.1.4",
+  "description": "Kubernetes object types for overkube and its addons, generated from a cluster's OpenAPI schemas",
   "license": "MIT",
-  "repository": { "type": "git", "url": "git+https://github.com/overweave/overkube.git" }
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/overweave/overkube.git",
+    "directory": "packages/kube-types"
+  },
+  "homepage": "https://github.com/overweave/overkube/tree/main/packages/kube-types#readme",
+  "type": "module",
+  "exports": {
+    ".": {
+      "overkube-source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "overkube-source": "./src/gen/*.ts",
+      "types": "./dist/gen/*.d.ts",
+      "default": "./dist/gen/*.js"
+    }
+  },
+  "files": [
+    "dist",
+    "NOTICE",
+    "APACHE-2.0.txt"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build && cp ../../LICENSE ."
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }