apiuikit 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/README.md +27 -1
  2. package/dist/apiuikit.cjs.js +1 -1
  3. package/dist/apiuikit.css +1 -1
  4. package/dist/apiuikit.es.js +20 -19
  5. package/dist/components/ChannelAddress.d.ts +9 -1
  6. package/dist/components/ErrorBoundary.d.ts +26 -0
  7. package/dist/components/Navigation/spineTicks.d.ts +28 -0
  8. package/dist/components/Navigation/tests/spineTicks.test.d.ts +1 -0
  9. package/dist/components/tests/ChannelAddress.test.d.ts +1 -0
  10. package/dist/components/tests/ErrorBoundary.test.d.ts +1 -0
  11. package/dist/containers/AsyncAPI/AsyncAPI.d.ts +6 -0
  12. package/dist/containers/AsyncAPI/AsyncAPIRenderer.d.ts +7 -1
  13. package/dist/containers/AsyncAPI/tests/AsyncAPIErrorBoundary.test.d.ts +1 -0
  14. package/dist/containers/OpenAPI/OpenAPI.d.ts +6 -0
  15. package/dist/containers/OpenAPI/OpenAPIRenderer.d.ts +7 -1
  16. package/dist/containers/OpenAPI/tests/OpenAPIErrorBoundary.test.d.ts +1 -0
  17. package/dist/containers/Path/tests/Paths.test.d.ts +1 -0
  18. package/dist/helpers/codeSamples.d.ts +6 -2
  19. package/dist/{index-C278WDNb.cjs → index-B5IBIM-V.cjs} +1 -1
  20. package/dist/{index-PtAFPDfk.js → index-BqogUhNO.js} +5056 -4896
  21. package/dist/{index-C4I0xC5G.js → index-DM2MTkYV.js} +1 -1
  22. package/dist/{index-ArzwV232.cjs → index-EeGvEXPN.cjs} +1 -1
  23. package/dist/{index-Bh4OKjMA.js → index-iXpNcBcP.js} +1 -1
  24. package/dist/index-mYBY1Eu8.cjs +177 -0
  25. package/dist/index.d.ts +2 -0
  26. package/dist/{protoToJsonSchema-AciPTlBK.cjs → protoToJsonSchema-BNZrP3Fa.cjs} +1 -1
  27. package/dist/{protoToJsonSchema-D1lojrO3.js → protoToJsonSchema-CcEvAEt4.js} +1 -1
  28. package/dist/{protobufSchemaParser-7SgmMhQd.cjs → protobufSchemaParser-7sU6XBEb.cjs} +1 -1
  29. package/dist/{protobufSchemaParser-BohWo_pY.js → protobufSchemaParser-BaWs_7UI.js} +2 -2
  30. package/package.json +6 -2
  31. package/dist/index-DuW5iShy.cjs +0 -177
package/dist/helpers/codeSamples.d.ts CHANGED
@@ -1,7 +1,11 @@
1
1
  import { availableTargets } from '@readme/httpsnippet';
2
2
  import { HttpMethod, OpenAPIParameterData, OpenAPIRequestBodyData, OpenAPISecuritySchemeData, OpenAPIServerData } from '../types/openapi';
3
- export declare const DEFAULT_CODE_SAMPLE_TARGET = "shell";
4
- export declare const DEFAULT_CODE_SAMPLE_CLIENT = "curl";
3
+ /** The dropdown opens on httpsnippet's "agent" target: a plain-text prompt
4
+ * describing the request, meant to be pasted into an AI assistant rather than
5
+ * run. It's language-agnostic, so it's the one option that's useful to every
6
+ * reader regardless of what they're building in. */
7
+ export declare const DEFAULT_CODE_SAMPLE_TARGET = "agent";
8
+ export declare const DEFAULT_CODE_SAMPLE_CLIENT = "prompt";
5
9
  export type AvailableCodeSampleTarget = ReturnType<typeof availableTargets>[number];
6
10
  /** Every target/client @readme/httpsnippet knows how to generate (curl,
7
11
  * fetch, axios, Python requests, Go, Rust, ...), grouped by target — this is