@medalsocial/sdk 1.1.6 → 1.2.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.
- package/README.md +21 -0
- package/dist/openapi/medal-social.openapi.json +3431 -0
- package/dist/pilot/index.d.mts +2 -1
- package/dist/pilot/index.d.ts +2 -1
- package/dist/src/index.d.mts +2 -0
- package/dist/src/index.d.ts +2 -0
- package/dist/src/index.js +7 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/index.mjs +7 -0
- package/dist/src/index.mjs.map +1 -1
- package/dist/src/openapi.generated.d.mts +1855 -0
- package/dist/src/openapi.generated.d.ts +1855 -0
- package/dist/src/openapi.generated.js +19 -0
- package/dist/src/openapi.generated.js.map +1 -0
- package/dist/src/openapi.generated.mjs +1 -0
- package/dist/src/openapi.generated.mjs.map +1 -0
- package/openapi/README.md +15 -0
- package/openapi/medal-social.openapi.yaml +1910 -0
- package/package.json +20 -3
package/README.md
CHANGED
|
@@ -290,6 +290,27 @@ do {
|
|
|
290
290
|
} while (cursor);
|
|
291
291
|
```
|
|
292
292
|
|
|
293
|
+
## OpenAPI 3.1
|
|
294
|
+
|
|
295
|
+
The SDK publishes a validated OpenAPI 3.1 contract for the API surface covered by the typed client.
|
|
296
|
+
|
|
297
|
+
```ts
|
|
298
|
+
import type { OpenApiComponents, OpenApiOperations, OpenApiPaths } from '@medalsocial/sdk';
|
|
299
|
+
import type { paths } from '@medalsocial/sdk/openapi-types';
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
Package artifacts:
|
|
303
|
+
|
|
304
|
+
- `@medalsocial/sdk/openapi.yaml` - source OpenAPI 3.1 YAML document
|
|
305
|
+
- `@medalsocial/sdk/openapi.json` - bundled JSON document generated during build
|
|
306
|
+
- `@medalsocial/sdk/openapi-types` - generated TypeScript contract types
|
|
307
|
+
|
|
308
|
+
Validate the contract locally:
|
|
309
|
+
|
|
310
|
+
```bash
|
|
311
|
+
pnpm openapi:check
|
|
312
|
+
```
|
|
313
|
+
|
|
293
314
|
## Runtime Support
|
|
294
315
|
|
|
295
316
|
Node.js 18+ and modern browsers. Uses native `fetch` — no polyfills required.
|