move packages up a dir, kill packages directory

oxidecomputer · May 4, 2024 · 91bbb7e · 91bbb7e
1 parent 0ecd8aa
commit 91bbb7e
Show file tree

Hide file tree

Showing 37 changed files with 20 additions and 17 deletions.
diff --git a/.github/workflows/update-api-spec.yml b/.github/workflows/update-api-spec.yml
@@ -18,7 +18,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: "18"
-      - working-directory: "./packages/openapi-gen-ts"
+      - working-directory: "./oxide-openapi-gen-ts"
         run: 'npm install'
       - run: ./tools/gen.sh
       - uses: EndBug/add-and-commit@v9

diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -19,16 +19,16 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: "18"
-      - working-directory: "./packages/openapi-gen-ts"
+      - working-directory: "./oxide-openapi-gen-ts"
         run: npm install
       - name: Generate client
         run: "./tools/gen.sh"
       - name: Typecheck
-        working-directory: "./packages/openapi-gen-ts"
+        working-directory: "./oxide-openapi-gen-ts"
         run: npm run tsc
       - name: Lint
-        working-directory: "./packages/openapi-gen-ts"
+        working-directory: "./oxide-openapi-gen-ts"
         run: npm run lint
       - name: Test
-        working-directory: "./packages/openapi-gen-ts"
+        working-directory: "./oxide-openapi-gen-ts"
         run: npm test run
diff --git a/README.md b/README.md
@@ -9,12 +9,12 @@ any other specs and is unlikely to handle them well.
 
 |Package| Description|
 |---|---|
-| [`@oxide/openapi-gen-ts`](./packages/openapi-gen-ts) | TypeScript OpenAPI client generator |
-| [`@oxide/api`](./packages/api) | The client generated for the Omicron commit specified in `OMICRON_VERSION` |
+| [`@oxide/openapi-gen-ts`](./oxide-openapi-gen-ts) | TypeScript OpenAPI client generator |
+| [`@oxide/api`](./oxide-api) | The client generated for the Omicron commit specified in `OMICRON_VERSION` |
 
 ## Using the API client
 
-See the [README](./package/api/README.md) for the `@oxide/api` package.
+See the [README](./oxide-api/README.md) for the `@oxide/api` package.
 
 ## Contributing
 

diff --git a/packages/api/README.md → oxide-api/README.md b/packages/api/README.md → oxide-api/README.md
@@ -41,14 +41,17 @@ const result = await api.methods.projectList({})
 
 if (result.type === "success") {
   console.log(result.data.items.map((p) => p.name))
-} else if (result.type === "error") {
-  console.log(result.data.errorCode)
-  console.log(result.data.message)
-} else { // result.type === client_error
-  console.log(result.error)
 }
 ```
 
+## How does it all work?
+
+### Methods
+
+### Request bodies
+
+### Responses: `ApiResult<T>`
+
 ## Other stuff in the package
 
 Most likely nobody but us wants this, and we should take it out of the npm package.

diff --git a/packages/api/package-lock.json → oxide-api/package-lock.json b/packages/api/package-lock.json → oxide-api/package-lock.json
diff --git a/packages/api/package.json → oxide-api/package.json b/packages/api/package.json → oxide-api/package.json
diff --git a/packages/api/src/Api.ts → oxide-api/src/Api.ts b/packages/api/src/Api.ts → oxide-api/src/Api.ts
diff --git a/packages/api/src/http-client.ts → oxide-api/src/http-client.ts b/packages/api/src/http-client.ts → oxide-api/src/http-client.ts
diff --git a/packages/api/src/msw-handlers.ts → oxide-api/src/msw-handlers.ts b/packages/api/src/msw-handlers.ts → oxide-api/src/msw-handlers.ts
diff --git a/packages/api/src/type-test.ts → oxide-api/src/type-test.ts b/packages/api/src/type-test.ts → oxide-api/src/type-test.ts
diff --git a/packages/api/src/util.ts → oxide-api/src/util.ts b/packages/api/src/util.ts → oxide-api/src/util.ts
diff --git a/packages/api/src/validate.ts → oxide-api/src/validate.ts b/packages/api/src/validate.ts → oxide-api/src/validate.ts
diff --git a/packages/api/tsconfig.json → oxide-api/tsconfig.json b/packages/api/tsconfig.json → oxide-api/tsconfig.json
diff --git a/packages/openapi-gen-ts/.eslintrc.cjs → oxide-openapi-gen-ts/.eslintrc.cjs b/packages/openapi-gen-ts/.eslintrc.cjs → oxide-openapi-gen-ts/.eslintrc.cjs
diff --git a/packages/openapi-gen-ts/README.md → oxide-openapi-gen-ts/README.md b/packages/openapi-gen-ts/README.md → oxide-openapi-gen-ts/README.md
@@ -40,7 +40,7 @@ one, so writing one was easier than existing generators made it look.
 ./tools/gen.sh
 ```
 
-The TypeScript client code will be written to `packages/api/src`.
+The TypeScript client code will be written to `oxide-api/src`.
 
 ## Publishing to npm
 

diff --git a/packages/openapi-gen-ts/package-lock.json → oxide-openapi-gen-ts/package-lock.json b/packages/openapi-gen-ts/package-lock.json → oxide-openapi-gen-ts/package-lock.json
diff --git a/packages/openapi-gen-ts/package.json → oxide-openapi-gen-ts/package.json b/packages/openapi-gen-ts/package.json → oxide-openapi-gen-ts/package.json
@@ -34,7 +34,7 @@
   "scripts": {
     "build": "tsup-node && mkdir -p dist/static/ && cp src/client/static/util.ts dist/static/ && cp src/client/static/http-client.ts dist/static/",
     "lint": "eslint .",
-    "pretest": "../../tools/gen.sh",
+    "pretest": "../tools/gen.sh",
     "test": "vitest",
     "test:ui": "vitest --ui",
     "tsc": "tsc"

diff --git a/packages/openapi-gen-ts/src/client/api.ts → oxide-openapi-gen-ts/src/client/api.ts b/packages/openapi-gen-ts/src/client/api.ts → oxide-openapi-gen-ts/src/client/api.ts
diff --git a/packages/openapi-gen-ts/src/client/base.ts → oxide-openapi-gen-ts/src/client/base.ts b/packages/openapi-gen-ts/src/client/base.ts → oxide-openapi-gen-ts/src/client/base.ts
diff --git a/...openapi-gen-ts/src/client/msw-handlers.ts → ...openapi-gen-ts/src/client/msw-handlers.ts b/...openapi-gen-ts/src/client/msw-handlers.ts → ...openapi-gen-ts/src/client/msw-handlers.ts
diff --git a/...penapi-gen-ts/src/client/static/README.md → ...penapi-gen-ts/src/client/static/README.md b/...penapi-gen-ts/src/client/static/README.md → ...penapi-gen-ts/src/client/static/README.md
diff --git a/...-ts/src/client/static/http-client.test.ts → ...-ts/src/client/static/http-client.test.ts b/...-ts/src/client/static/http-client.test.ts → ...-ts/src/client/static/http-client.test.ts
diff --git a/...i-gen-ts/src/client/static/http-client.ts → ...i-gen-ts/src/client/static/http-client.ts b/...i-gen-ts/src/client/static/http-client.ts → ...i-gen-ts/src/client/static/http-client.ts
diff --git a/...api-gen-ts/src/client/static/util.test.ts → ...api-gen-ts/src/client/static/util.test.ts b/...api-gen-ts/src/client/static/util.test.ts → ...api-gen-ts/src/client/static/util.test.ts
diff --git a/.../openapi-gen-ts/src/client/static/util.ts → ...-openapi-gen-ts/src/client/static/util.ts b/.../openapi-gen-ts/src/client/static/util.ts → ...-openapi-gen-ts/src/client/static/util.ts
diff --git a/...s/openapi-gen-ts/src/client/type-tests.ts → ...e-openapi-gen-ts/src/client/type-tests.ts b/...s/openapi-gen-ts/src/client/type-tests.ts → ...e-openapi-gen-ts/src/client/type-tests.ts
diff --git a/...penapi-gen-ts/src/client/zodValidators.ts → ...penapi-gen-ts/src/client/zodValidators.ts b/...penapi-gen-ts/src/client/zodValidators.ts → ...penapi-gen-ts/src/client/zodValidators.ts
diff --git a/packages/openapi-gen-ts/src/index.ts → oxide-openapi-gen-ts/src/index.ts b/packages/openapi-gen-ts/src/index.ts → oxide-openapi-gen-ts/src/index.ts
diff --git a/packages/openapi-gen-ts/src/io.ts → oxide-openapi-gen-ts/src/io.ts b/packages/openapi-gen-ts/src/io.ts → oxide-openapi-gen-ts/src/io.ts
diff --git a/packages/openapi-gen-ts/src/schema/base.ts → oxide-openapi-gen-ts/src/schema/base.ts b/packages/openapi-gen-ts/src/schema/base.ts → oxide-openapi-gen-ts/src/schema/base.ts
diff --git a/packages/openapi-gen-ts/src/schema/types.ts → oxide-openapi-gen-ts/src/schema/types.ts b/packages/openapi-gen-ts/src/schema/types.ts → oxide-openapi-gen-ts/src/schema/types.ts
diff --git a/...ges/openapi-gen-ts/src/schema/zod.test.ts → oxide-openapi-gen-ts/src/schema/zod.test.ts b/...ges/openapi-gen-ts/src/schema/zod.test.ts → oxide-openapi-gen-ts/src/schema/zod.test.ts
diff --git a/packages/openapi-gen-ts/src/schema/zod.ts → oxide-openapi-gen-ts/src/schema/zod.ts b/packages/openapi-gen-ts/src/schema/zod.ts → oxide-openapi-gen-ts/src/schema/zod.ts
diff --git a/packages/openapi-gen-ts/src/util.test.ts → oxide-openapi-gen-ts/src/util.test.ts b/packages/openapi-gen-ts/src/util.test.ts → oxide-openapi-gen-ts/src/util.test.ts
diff --git a/packages/openapi-gen-ts/src/util.ts → oxide-openapi-gen-ts/src/util.ts b/packages/openapi-gen-ts/src/util.ts → oxide-openapi-gen-ts/src/util.ts
diff --git a/packages/openapi-gen-ts/tsconfig.json → oxide-openapi-gen-ts/tsconfig.json b/packages/openapi-gen-ts/tsconfig.json → oxide-openapi-gen-ts/tsconfig.json
diff --git a/tools/gen.sh b/tools/gen.sh
@@ -11,13 +11,13 @@ set -o pipefail
 
 ROOT_DIR="$(dirname "$0")/.."
 OMICRON_SHA=$(cat "$ROOT_DIR/OMICRON_VERSION")
-DEST_DIR="$ROOT_DIR/packages/api/src"
+DEST_DIR="$ROOT_DIR/oxide-api/src"
 
 SPEC_URL="https://raw.githubusercontent.com/oxidecomputer/omicron/$OMICRON_SHA/openapi/nexus.json"
 SPEC_FILE="./spec.json"
 
 # TODO: we could get rid of this DL if a test didn't rely on it
 curl --fail "$SPEC_URL" -o $SPEC_FILE
 
-npx tsx "$ROOT_DIR/packages/openapi-gen-ts/src/index.ts" $SPEC_FILE $DEST_DIR
+npx tsx "$ROOT_DIR/oxide-openapi-gen-ts/src/index.ts" $SPEC_FILE $DEST_DIR
 npx prettier --write --log-level error "$DEST_DIR"