massage module structure + typedoc (#43)

* Nest models under sdk subpackage
* Move porcelain up to root level
* ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.252.0
* typedoc: add favicon
* typedoc: reorder links (top-right)


Signed-off-by: Stephan Renatus <stephan@styra.com>
Co-authored-by: Chris Hendrix <chendrix@styra.com>
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>

Author: 3 people

.genignore

@@ -1,5 +1,4 @@
 LICENSE
 /src/helpers
-/src/porcelain
 /src/index.ts
 /.eslintrc.js

.gitignore

@@ -1,11 +1,13 @@
+/sdk/models/errors
 /models
 /models/errors
 /types
 /lib
 /sdk
 /hooks
 /index.*
+/opaclient.*
 /cjs
 /node_modules
 /.tsbuildinfo
-/porcelain
+/output

.npmignore

@@ -8,3 +8,4 @@
 /cjs
 /.github
 /.speakeasy
+/.typedoc

.speakeasy/gen.lock

@@ -3,10 +3,10 @@ id: 2f8b2839-3001-46b4-b5e0-cec0aad583ed
 management:
   docChecksum: 2401c7030f847f72ab31c8f75de58a66
   docVersion: 0.2.0
-  speakeasyVersion: 1.250.0
-  generationVersion: 2.304.1
-  releaseVersion: 0.2.5
-  configChecksum: 3718ba08271d1d35549f6862040a1f7a
+  speakeasyVersion: 1.252.0
+  generationVersion: 2.306.0
+  releaseVersion: 0.2.6
+  configChecksum: 8c20639be93c10198d3995021b1a1f6c
   repoURL: https://github.com/StyraInc/opa-typescript.git
   installationURL: https://github.com/StyraInc/opa-typescript
   published: true
@@ -34,55 +34,55 @@ generatedFiles:
   - src/lib/security.ts
   - src/lib/url.ts
   - src/sdk/index.ts
-  - src/models/errors/sdkerror.ts
-  - src/models/errors/sdkvalidationerror.ts
+  - src/sdk/models/errors/sdkerror.ts
+  - src/sdk/models/errors/sdkvalidationerror.ts
   - src/types/blobs.ts
   - src/types/index.ts
   - src/types/operations.ts
   - src/types/rfcdate.ts
   - tsconfig.json
-  - src/models/operations/executepolicy.ts
-  - src/models/operations/executepolicywithinput.ts
-  - src/models/operations/health.ts
-  - src/models/components/successfulpolicyevaluation.ts
-  - src/models/components/provenance.ts
-  - src/models/components/result.ts
-  - src/models/components/httpmetadata.ts
-  - src/models/components/explain.ts
-  - src/models/components/gzipacceptencoding.ts
-  - src/models/components/input.ts
-  - src/models/components/gzipcontentencoding.ts
-  - src/models/components/healthyserver.ts
-  - src/models/errors/clienterror.ts
-  - src/models/errors/servererror.ts
-  - src/models/errors/unhealthyserver.ts
-  - src/models/errors/index.ts
-  - src/models/operations/index.ts
-  - src/models/components/index.ts
-  - docs/models/operations/executepolicyrequest.md
-  - docs/models/operations/executepolicyresponse.md
-  - docs/models/operations/executepolicywithinputrequestbody.md
-  - docs/models/operations/executepolicywithinputrequest.md
-  - docs/models/operations/executepolicywithinputresponse.md
-  - docs/models/operations/healthrequest.md
-  - docs/models/operations/healthresponse.md
-  - docs/models/components/successfulpolicyevaluation.md
-  - docs/models/components/revision.md
-  - docs/models/components/provenance.md
-  - docs/models/components/result.md
-  - docs/models/components/httpmetadata.md
-  - docs/models/components/explain.md
-  - docs/models/components/gzipacceptencoding.md
-  - docs/models/components/input.md
-  - docs/models/components/gzipcontentencoding.md
-  - docs/models/components/healthyserver.md
-  - docs/models/errors/location.md
-  - docs/models/errors/errors.md
-  - docs/models/errors/clienterror.md
-  - docs/models/errors/servererrorlocation.md
-  - docs/models/errors/servererrorerrors.md
-  - docs/models/errors/servererror.md
-  - docs/models/errors/unhealthyserver.md
+  - src/sdk/models/operations/executepolicy.ts
+  - src/sdk/models/operations/executepolicywithinput.ts
+  - src/sdk/models/operations/health.ts
+  - src/sdk/models/components/successfulpolicyevaluation.ts
+  - src/sdk/models/components/provenance.ts
+  - src/sdk/models/components/result.ts
+  - src/sdk/models/components/httpmetadata.ts
+  - src/sdk/models/components/explain.ts
+  - src/sdk/models/components/gzipacceptencoding.ts
+  - src/sdk/models/components/input.ts
+  - src/sdk/models/components/gzipcontentencoding.ts
+  - src/sdk/models/components/healthyserver.ts
+  - src/sdk/models/errors/clienterror.ts
+  - src/sdk/models/errors/servererror.ts
+  - src/sdk/models/errors/unhealthyserver.ts
+  - src/sdk/models/errors/index.ts
+  - src/sdk/models/operations/index.ts
+  - src/sdk/models/components/index.ts
+  - docs/sdk/models/operations/executepolicyrequest.md
+  - docs/sdk/models/operations/executepolicyresponse.md
+  - docs/sdk/models/operations/executepolicywithinputrequestbody.md
+  - docs/sdk/models/operations/executepolicywithinputrequest.md
+  - docs/sdk/models/operations/executepolicywithinputresponse.md
+  - docs/sdk/models/operations/healthrequest.md
+  - docs/sdk/models/operations/healthresponse.md
+  - docs/sdk/models/components/successfulpolicyevaluation.md
+  - docs/sdk/models/components/revision.md
+  - docs/sdk/models/components/provenance.md
+  - docs/sdk/models/components/result.md
+  - docs/sdk/models/components/httpmetadata.md
+  - docs/sdk/models/components/explain.md
+  - docs/sdk/models/components/gzipacceptencoding.md
+  - docs/sdk/models/components/input.md
+  - docs/sdk/models/components/gzipcontentencoding.md
+  - docs/sdk/models/components/healthyserver.md
+  - docs/sdk/models/errors/location.md
+  - docs/sdk/models/errors/errors.md
+  - docs/sdk/models/errors/clienterror.md
+  - docs/sdk/models/errors/servererrorlocation.md
+  - docs/sdk/models/errors/servererrorerrors.md
+  - docs/sdk/models/errors/servererror.md
+  - docs/sdk/models/errors/unhealthyserver.md
   - docs/sdks/opaapiclient/README.md
   - USAGE.md
   - .gitattributes

.speakeasy/gen.yaml

@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 typescript:
-  version: 0.2.5
+  version: 0.2.6
   additionalDependencies:
     dependencies: {}
     devDependencies:
@@ -21,6 +21,7 @@ typescript:
       testcontainers: ^10.7.2
       ts-node: ^10.9.2
       typedoc: ^0.25.13
+      typedoc-plugin-extras: ^3.0.0
       typedoc-plugin-replace-text: ^3.3.0
     peerDependencies: {}
   author: Styra
@@ -30,11 +31,11 @@ typescript:
   imports:
     option: openapi
     paths:
-      callbacks: models/callbacks
-      errors: models/errors
-      operations: models/operations
-      shared: models/components
-      webhooks: models/webhooks
+      callbacks: sdk/models/callbacks
+      errors: sdk/models/errors
+      operations: sdk/models/operations
+      shared: sdk/models/components
+      webhooks: sdk/models/webhooks
   inputModelSuffix: input
   maxMethodParams: 4
   outputModelSuffix: output

.typedoc/favicon.ico

@@ -259,10 +259,10 @@ Please refer to [the repository's README.md](https://github.com/StyraInc/opa-typ
 ```typescript
 import { OpaApiClient } from "@styra/opa";
 
-async function run() {
-    const sdk = new OpaApiClient();
+const opaApiClient = new OpaApiClient();
 
-    const result = await sdk.executePolicyWithInput({
+async function run() {
+    const result = await opaApiClient.executePolicyWithInput({
         path: "app/rbac",
         requestBody: {
             input: {
@@ -309,14 +309,14 @@ Validation errors can also occur when either method arguments or data returned f
 
 ```typescript
 import { OpaApiClient } from "@styra/opa";
-import * as errors from "@styra/opa/models/errors";
+import * as errors from "@styra/opa/sdk/models/errors";
 
-async function run() {
-    const sdk = new OpaApiClient();
+const opaApiClient = new OpaApiClient();
 
+async function run() {
     let result;
     try {
-        result = await sdk.executePolicy({
+        result = await opaApiClient.executePolicy({
             path: "app/rbac",
         });
     } catch (err) {
@@ -365,12 +365,12 @@ You can override the default server globally by passing a server index to the `s
 ```typescript
 import { OpaApiClient } from "@styra/opa";
 
-async function run() {
-    const sdk = new OpaApiClient({
-        serverIdx: 0,
-    });
+const opaApiClient = new OpaApiClient({
+    serverIdx: 0,
+});
 
-    const result = await sdk.executePolicy({
+async function run() {
+    const result = await opaApiClient.executePolicy({
         path: "app/rbac",
     });
 
@@ -390,12 +390,12 @@ The default server can also be overridden globally by passing a URL to the `serv
 ```typescript
 import { OpaApiClient } from "@styra/opa";
 
-async function run() {
-    const sdk = new OpaApiClient({
-        serverURL: "http://localhost:8181",
-    });
+const opaApiClient = new OpaApiClient({
+    serverURL: "http://localhost:8181",
+});
 
-    const result = await sdk.executePolicy({
+async function run() {
+    const result = await opaApiClient.executePolicy({
         path: "app/rbac",
     });
 

README.md

@@ -88,4 +88,14 @@ Based on:
 ### Generated
 - [typescript v0.2.5] .
 ### Releases
-- [NPM v0.2.5] https://www.npmjs.com/package/@styra/opa/v/0.2.5 - .
+- [NPM v0.2.5] https://www.npmjs.com/package/@styra/opa/v/0.2.5 - .
+
+## 2024-04-12 19:27:59
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.252.0 (2.306.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.6] .
+### Releases
+- [NPM v0.2.6] https://www.npmjs.com/package/@styra/opa/v/0.2.6 - .

RELEASES.md

@@ -2,10 +2,10 @@
 ```typescript
 import { OpaApiClient } from "@styra/opa";
 
-async function run() {
-    const sdk = new OpaApiClient();
+const opaApiClient = new OpaApiClient();
 
-    const result = await sdk.executePolicyWithInput({
+async function run() {
+    const result = await opaApiClient.executePolicyWithInput({
         path: "app/rbac",
         requestBody: {
             input: {