@idelio/contracts 0.1.0-beta.0 → 0.1.0-beta.1
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/CHANGELOG.md +43 -0
- package/dist/brands.d.ts +1 -0
- package/dist/error-catalog.d.ts +628 -0
- package/dist/error-catalog.js +618 -0
- package/dist/events.d.ts +1 -4
- package/dist/events.js +0 -3
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/webhooks.d.ts +73 -12
- package/dist/webhooks.js +48 -0
- package/openapi/openapi.yaml +360 -129
- package/package.json +3 -2
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to `@idelio/contracts` are recorded here. The format
|
|
4
|
+
follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the
|
|
5
|
+
package follows [Semantic Versioning](https://semver.org/). While it is in
|
|
6
|
+
beta (`0.1.0-beta.*`), a release may still change or remove an export.
|
|
7
|
+
|
|
8
|
+
## [0.1.0-beta.1] - 2026-09-28
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- `webhookEventDataSchemas`: one zod schema per webhook event type, for a
|
|
13
|
+
fully typed `data` once a delivery's envelope is parsed.
|
|
14
|
+
- `webhookDeliverySchema` and `WebhookDelivery`, the shape of an endpoint's
|
|
15
|
+
delivery history (`GET /v1/webhook-endpoints/{id}/deliveries`).
|
|
16
|
+
- `disabled_reason` (`"failures"`, `"manual"` or `null`) and
|
|
17
|
+
`consecutive_failures` on `WebhookEndpoint`.
|
|
18
|
+
- `errorCatalog`, with the `ErrorCode` and `ErrorCatalogEntry` types: every
|
|
19
|
+
API error `code` and what it means, for matching on errors.
|
|
20
|
+
- `CreateBrandRequestInput`, the input-side type of `CreateBrandRequest`,
|
|
21
|
+
where fields with defaults are optional.
|
|
22
|
+
|
|
23
|
+
### Changed
|
|
24
|
+
|
|
25
|
+
- `requiredAssetKinds` (and `defaultLockedAssetKinds`, now the same list)
|
|
26
|
+
holds the five kinds every brand includes: `logo`, `logo_alternative`,
|
|
27
|
+
`logo_wordmark`, `color_palette` and `font_pairing`. A create request
|
|
28
|
+
missing one fails with `required_assets_missing` instead of
|
|
29
|
+
`logo_required`.
|
|
30
|
+
|
|
31
|
+
### Removed
|
|
32
|
+
|
|
33
|
+
- `brand.updated`, `credits.settled` and `subscription.changed` from
|
|
34
|
+
`webhookEventTypes`. They were never delivered; the five that are
|
|
35
|
+
delivered are `brand.completed`, `asset.ready`, `asset.regenerated`,
|
|
36
|
+
`job.failed` and `credits.low`.
|
|
37
|
+
|
|
38
|
+
## [0.1.0-beta.0] - 2026-09-27
|
|
39
|
+
|
|
40
|
+
First prerelease.
|
|
41
|
+
|
|
42
|
+
[0.1.0-beta.1]: https://www.npmjs.com/package/@idelio/contracts/v/0.1.0-beta.1
|
|
43
|
+
[0.1.0-beta.0]: https://www.npmjs.com/package/@idelio/contracts/v/0.1.0-beta.0
|
package/dist/brands.d.ts
CHANGED
|
@@ -224,6 +224,7 @@ export declare const brandSchema: z.ZodObject<{
|
|
|
224
224
|
export type Brand = z.infer<typeof brandSchema>;
|
|
225
225
|
export type BrandPreview = z.infer<typeof brandPreviewSchema>;
|
|
226
226
|
export type CreateBrandRequest = z.infer<typeof createBrandRequestSchema>;
|
|
227
|
+
export type CreateBrandRequestInput = z.input<typeof createBrandRequestSchema>;
|
|
227
228
|
export type AssetKind = (typeof assetKinds)[number];
|
|
228
229
|
export type TeamTier = (typeof teamTiers)[number];
|
|
229
230
|
export declare const customImageFormats: readonly ["square_1_1", "portrait_4_5", "story_9_16", "landscape_16_9", "wide_21_9", "photo_3_2", "poster_2_3", "standard_4_3", "auto", "instagram_post", "story", "linkedin_post", "ad_banner", "custom"];
|