change src layout to export protobufs

fishjam-dev · Apr 24, 2024 · 5f20b54 · 5f20b54
1 parent 7bf1896
commit 5f20b54
Show file tree

Hide file tree

Showing 15 changed files with 28 additions and 25 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -30,8 +30,5 @@ jobs:
       - name: Check typing
         run: npm run build:check
 
-      # TODO: uncomment once '[warning] RequestArgs, defined in ./src/base.ts, is referenced by
-      #       HealthApiAxiosParamCreator.HealthApiAxiosParamCreator.__type.healthcheck.__type.__type but not included
-      #       in the documentation.' warning gets resolved
-      # - name: Check docs
-      #   run: npm run docs:check
+      - name: Check docs
+        run: npm run docs
diff --git a/codegen/openapi.sh b/codegen/openapi.sh
@@ -19,4 +19,4 @@ cd $ROOTDIR \
 && npx openapi-generator-cli generate \
   -i https://raw.githubusercontent.com/jellyfish-dev/jellyfish/$1/openapi.yaml \
   -g typescript-axios \
-  -o src
+  -o src/openapi
diff --git a/package.json b/package.json
@@ -23,15 +23,15 @@
     "dist"
   ],
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./server-notifications": "./dist/protos/jellyfish/server_notifications.js"
   },
   "scripts": {
     "build": "tsc",
     "build:check": "tsc --noEmit",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "docs": "typedoc src",
-    "docs:check": "typedoc src --treatWarningsAsErrors",
     "gen:proto": "sh codegen/protobuf.sh",
     "gen:api": "sh codegen/openapi.sh"
   },

diff --git a/src/index.ts b/src/index.ts
@@ -1,18 +1,5 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Jellyfish Media Server
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 0.4.2
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-export * from "./api";
-export * from "./configuration";
+export * from "./openapi";
 
+// HACK (?): We want to export server notifications as a sub-package, but still be accessible
+// from the parent package's documentation.
+export type * from "./protos/jellyfish/server_notifications";
diff --git a/src/.gitignore → src/openapi/.gitignore b/src/.gitignore → src/openapi/.gitignore
diff --git a/src/.npmignore → src/openapi/.npmignore b/src/.npmignore → src/openapi/.npmignore
diff --git a/src/.openapi-generator-ignore → src/openapi/.openapi-generator-ignore b/src/.openapi-generator-ignore → src/openapi/.openapi-generator-ignore
diff --git a/src/.openapi-generator/FILES → src/openapi/.openapi-generator/FILES b/src/.openapi-generator/FILES → src/openapi/.openapi-generator/FILES
@@ -1,5 +1,6 @@
 .gitignore
 .npmignore
+.openapi-generator-ignore
 api.ts
 base.ts
 common.ts

diff --git a/src/.openapi-generator/VERSION → src/openapi/.openapi-generator/VERSION b/src/.openapi-generator/VERSION → src/openapi/.openapi-generator/VERSION
diff --git a/src/api.ts → src/openapi/api.ts b/src/api.ts → src/openapi/api.ts
diff --git a/src/base.ts → src/openapi/base.ts b/src/base.ts → src/openapi/base.ts
diff --git a/src/common.ts → src/openapi/common.ts b/src/common.ts → src/openapi/common.ts
diff --git a/src/configuration.ts → src/openapi/configuration.ts b/src/configuration.ts → src/openapi/configuration.ts
diff --git a/src/git_push.sh → src/openapi/git_push.sh b/src/git_push.sh → src/openapi/git_push.sh
diff --git a/src/openapi/index.ts b/src/openapi/index.ts
@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Jellyfish Media Server
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.4.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+