@datocms/cma-client 5.1.1 → 5.1.3
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/dist/cjs/fieldTypes/boolean.js +7 -1
- package/dist/cjs/fieldTypes/boolean.js.map +1 -1
- package/dist/cjs/fieldTypes/color.js +7 -1
- package/dist/cjs/fieldTypes/color.js.map +1 -1
- package/dist/cjs/fieldTypes/date.js +7 -1
- package/dist/cjs/fieldTypes/date.js.map +1 -1
- package/dist/cjs/fieldTypes/date_time.js +7 -1
- package/dist/cjs/fieldTypes/date_time.js.map +1 -1
- package/dist/cjs/fieldTypes/file.js +7 -1
- package/dist/cjs/fieldTypes/file.js.map +1 -1
- package/dist/cjs/fieldTypes/float.js +7 -1
- package/dist/cjs/fieldTypes/float.js.map +1 -1
- package/dist/cjs/fieldTypes/gallery.js +7 -1
- package/dist/cjs/fieldTypes/gallery.js.map +1 -1
- package/dist/cjs/fieldTypes/integer.js +7 -1
- package/dist/cjs/fieldTypes/integer.js.map +1 -1
- package/dist/cjs/fieldTypes/json.js +7 -1
- package/dist/cjs/fieldTypes/json.js.map +1 -1
- package/dist/cjs/fieldTypes/lat_lon.js +7 -1
- package/dist/cjs/fieldTypes/lat_lon.js.map +1 -1
- package/dist/cjs/fieldTypes/link.js +7 -1
- package/dist/cjs/fieldTypes/link.js.map +1 -1
- package/dist/cjs/fieldTypes/links.js +7 -1
- package/dist/cjs/fieldTypes/links.js.map +1 -1
- package/dist/cjs/fieldTypes/rich_text.js +23 -5
- package/dist/cjs/fieldTypes/rich_text.js.map +1 -1
- package/dist/cjs/fieldTypes/seo.js +7 -1
- package/dist/cjs/fieldTypes/seo.js.map +1 -1
- package/dist/cjs/fieldTypes/single_block.js +37 -17
- package/dist/cjs/fieldTypes/single_block.js.map +1 -1
- package/dist/cjs/fieldTypes/slug.js +8 -2
- package/dist/cjs/fieldTypes/slug.js.map +1 -1
- package/dist/cjs/fieldTypes/string.js +7 -1
- package/dist/cjs/fieldTypes/string.js.map +1 -1
- package/dist/cjs/fieldTypes/structured_text.js +28 -22
- package/dist/cjs/fieldTypes/structured_text.js.map +1 -1
- package/dist/cjs/fieldTypes/text.js +7 -1
- package/dist/cjs/fieldTypes/text.js.map +1 -1
- package/dist/cjs/fieldTypes/video.js +7 -1
- package/dist/cjs/fieldTypes/video.js.map +1 -1
- package/dist/cjs/generated/{SchemaTypes.js → ApiTypes.js} +1 -1
- package/dist/cjs/generated/ApiTypes.js.map +1 -0
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/{SimpleSchemaTypes.js → RawApiTypes.js} +1 -1
- package/dist/cjs/generated/RawApiTypes.js.map +1 -0
- package/dist/cjs/generated/resources/AccessToken.js.map +1 -1
- package/dist/cjs/generated/resources/AuditLogEvent.js.map +1 -1
- package/dist/cjs/generated/resources/BuildEvent.js.map +1 -1
- package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/cjs/generated/resources/EditingSession.js.map +1 -1
- package/dist/cjs/generated/resources/EmojiSuggestions.js.map +1 -1
- package/dist/cjs/generated/resources/Environment.js.map +1 -1
- package/dist/cjs/generated/resources/Field.js.map +1 -1
- package/dist/cjs/generated/resources/Fieldset.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/ItemType.js.map +1 -1
- package/dist/cjs/generated/resources/ItemTypeFilter.js.map +1 -1
- package/dist/cjs/generated/resources/ItemVersion.js.map +1 -1
- package/dist/cjs/generated/resources/JobResult.js.map +1 -1
- package/dist/cjs/generated/resources/MaintenanceMode.js.map +1 -1
- package/dist/cjs/generated/resources/MenuItem.js.map +1 -1
- package/dist/cjs/generated/resources/Plugin.js.map +1 -1
- package/dist/cjs/generated/resources/PublicInfo.js.map +1 -1
- package/dist/cjs/generated/resources/Role.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/cjs/generated/resources/SchemaMenuItem.js.map +1 -1
- package/dist/cjs/generated/resources/SearchResult.js.map +1 -1
- package/dist/cjs/generated/resources/Session.js.map +1 -1
- package/dist/cjs/generated/resources/Site.js.map +1 -1
- package/dist/cjs/generated/resources/SiteInvitation.js.map +1 -1
- package/dist/cjs/generated/resources/SsoGroup.js.map +1 -1
- package/dist/cjs/generated/resources/SsoSettings.js.map +1 -1
- package/dist/cjs/generated/resources/SsoUser.js.map +1 -1
- package/dist/cjs/generated/resources/SubscriptionLimit.js.map +1 -1
- package/dist/cjs/generated/resources/Upload.js.map +1 -1
- package/dist/cjs/generated/resources/UploadCollection.js.map +1 -1
- package/dist/cjs/generated/resources/UploadFilter.js.map +1 -1
- package/dist/cjs/generated/resources/UploadRequest.js.map +1 -1
- package/dist/cjs/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/cjs/generated/resources/UploadTag.js.map +1 -1
- package/dist/cjs/generated/resources/UploadTrack.js.map +1 -1
- package/dist/cjs/generated/resources/UsageCounter.js.map +1 -1
- package/dist/cjs/generated/resources/User.js.map +1 -1
- package/dist/cjs/generated/resources/Webhook.js.map +1 -1
- package/dist/cjs/generated/resources/WebhookCall.js.map +1 -1
- package/dist/cjs/generated/resources/WhiteLabelSettings.js.map +1 -1
- package/dist/cjs/generated/resources/Workflow.js.map +1 -1
- package/dist/cjs/index.js +3 -5
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/resources/Role.js.map +1 -1
- package/dist/cjs/utilities/blocks.js +7 -7
- package/dist/cjs/utilities/blocks.js.map +1 -1
- package/dist/cjs/utilities/buildBlockRecord.js.map +1 -1
- package/dist/cjs/utilities/{fieldValueLocalization.js → fieldValue.js} +52 -52
- package/dist/cjs/utilities/fieldValue.js.map +1 -0
- package/dist/cjs/utilities/fieldsContainingReferences.js.map +1 -1
- package/dist/cjs/utilities/recursiveBlocks.js +18 -19
- package/dist/cjs/utilities/recursiveBlocks.js.map +1 -1
- package/dist/cjs/utilities/schemaRepository.js.map +1 -1
- package/dist/esm/fieldTypes/boolean.d.ts +2 -0
- package/dist/esm/fieldTypes/boolean.js +5 -0
- package/dist/esm/fieldTypes/boolean.js.map +1 -1
- package/dist/esm/fieldTypes/color.d.ts +2 -0
- package/dist/esm/fieldTypes/color.js +5 -0
- package/dist/esm/fieldTypes/color.js.map +1 -1
- package/dist/esm/fieldTypes/date.d.ts +2 -0
- package/dist/esm/fieldTypes/date.js +5 -0
- package/dist/esm/fieldTypes/date.js.map +1 -1
- package/dist/esm/fieldTypes/date_time.d.ts +2 -0
- package/dist/esm/fieldTypes/date_time.js +5 -0
- package/dist/esm/fieldTypes/date_time.js.map +1 -1
- package/dist/esm/fieldTypes/file.d.ts +2 -0
- package/dist/esm/fieldTypes/file.js +5 -0
- package/dist/esm/fieldTypes/file.js.map +1 -1
- package/dist/esm/fieldTypes/float.d.ts +2 -0
- package/dist/esm/fieldTypes/float.js +5 -0
- package/dist/esm/fieldTypes/float.js.map +1 -1
- package/dist/esm/fieldTypes/gallery.d.ts +2 -0
- package/dist/esm/fieldTypes/gallery.js +5 -0
- package/dist/esm/fieldTypes/gallery.js.map +1 -1
- package/dist/esm/fieldTypes/integer.d.ts +2 -0
- package/dist/esm/fieldTypes/integer.js +5 -0
- package/dist/esm/fieldTypes/integer.js.map +1 -1
- package/dist/esm/fieldTypes/json.d.ts +2 -0
- package/dist/esm/fieldTypes/json.js +5 -0
- package/dist/esm/fieldTypes/json.js.map +1 -1
- package/dist/esm/fieldTypes/lat_lon.d.ts +2 -0
- package/dist/esm/fieldTypes/lat_lon.js +5 -0
- package/dist/esm/fieldTypes/lat_lon.js.map +1 -1
- package/dist/esm/fieldTypes/link.d.ts +2 -0
- package/dist/esm/fieldTypes/link.js +5 -0
- package/dist/esm/fieldTypes/link.js.map +1 -1
- package/dist/esm/fieldTypes/links.d.ts +2 -0
- package/dist/esm/fieldTypes/links.js +5 -0
- package/dist/esm/fieldTypes/links.js.map +1 -1
- package/dist/esm/fieldTypes/rich_text.d.ts +13 -9
- package/dist/esm/fieldTypes/rich_text.js +20 -5
- package/dist/esm/fieldTypes/rich_text.js.map +1 -1
- package/dist/esm/fieldTypes/seo.d.ts +2 -0
- package/dist/esm/fieldTypes/seo.js +5 -0
- package/dist/esm/fieldTypes/seo.js.map +1 -1
- package/dist/esm/fieldTypes/single_block.d.ts +33 -23
- package/dist/esm/fieldTypes/single_block.js +30 -13
- package/dist/esm/fieldTypes/single_block.js.map +1 -1
- package/dist/esm/fieldTypes/slug.d.ts +2 -0
- package/dist/esm/fieldTypes/slug.js +6 -1
- package/dist/esm/fieldTypes/slug.js.map +1 -1
- package/dist/esm/fieldTypes/string.d.ts +2 -0
- package/dist/esm/fieldTypes/string.js +5 -0
- package/dist/esm/fieldTypes/string.js.map +1 -1
- package/dist/esm/fieldTypes/structured_text.d.ts +22 -83
- package/dist/esm/fieldTypes/structured_text.js +25 -22
- package/dist/esm/fieldTypes/structured_text.js.map +1 -1
- package/dist/esm/fieldTypes/text.d.ts +2 -0
- package/dist/esm/fieldTypes/text.js +5 -0
- package/dist/esm/fieldTypes/text.js.map +1 -1
- package/dist/esm/fieldTypes/video.d.ts +2 -0
- package/dist/esm/fieldTypes/video.js +5 -0
- package/dist/esm/fieldTypes/video.js.map +1 -1
- package/dist/esm/generated/{SimpleSchemaTypes.d.ts → ApiTypes.d.ts} +2 -2
- package/dist/esm/generated/ApiTypes.js +2 -0
- package/dist/esm/generated/ApiTypes.js.map +1 -0
- package/dist/esm/generated/Client.d.ts +1 -1
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/{SchemaTypes.d.ts → RawApiTypes.d.ts} +2 -2
- package/dist/esm/generated/RawApiTypes.js +2 -0
- package/dist/esm/generated/RawApiTypes.js.map +1 -0
- package/dist/esm/generated/resources/AccessToken.d.ts +14 -14
- package/dist/esm/generated/resources/AccessToken.js.map +1 -1
- package/dist/esm/generated/resources/AuditLogEvent.d.ts +4 -4
- package/dist/esm/generated/resources/AuditLogEvent.js.map +1 -1
- package/dist/esm/generated/resources/BuildEvent.d.ts +8 -8
- package/dist/esm/generated/resources/BuildEvent.js.map +1 -1
- package/dist/esm/generated/resources/BuildTrigger.d.ts +16 -16
- package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/esm/generated/resources/DailyUsage.d.ts +4 -4
- package/dist/esm/generated/resources/EditingSession.d.ts +7 -7
- package/dist/esm/generated/resources/EditingSession.js.map +1 -1
- package/dist/esm/generated/resources/EmojiSuggestions.d.ts +4 -4
- package/dist/esm/generated/resources/EmojiSuggestions.js.map +1 -1
- package/dist/esm/generated/resources/Environment.d.ts +14 -14
- package/dist/esm/generated/resources/Environment.js.map +1 -1
- package/dist/esm/generated/resources/Field.d.ts +713 -713
- package/dist/esm/generated/resources/Field.js.map +1 -1
- package/dist/esm/generated/resources/Fieldset.d.ts +12 -12
- package/dist/esm/generated/resources/Fieldset.js.map +1 -1
- package/dist/esm/generated/resources/Item.d.ts +36 -36
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/ItemType.d.ts +15 -15
- package/dist/esm/generated/resources/ItemType.js.map +1 -1
- package/dist/esm/generated/resources/ItemTypeFilter.d.ts +12 -12
- package/dist/esm/generated/resources/ItemTypeFilter.js.map +1 -1
- package/dist/esm/generated/resources/ItemVersion.d.ts +10 -10
- package/dist/esm/generated/resources/ItemVersion.js.map +1 -1
- package/dist/esm/generated/resources/JobResult.d.ts +4 -4
- package/dist/esm/generated/resources/JobResult.js.map +1 -1
- package/dist/esm/generated/resources/MaintenanceMode.d.ts +8 -8
- package/dist/esm/generated/resources/MaintenanceMode.js.map +1 -1
- package/dist/esm/generated/resources/MenuItem.d.ts +14 -14
- package/dist/esm/generated/resources/MenuItem.js.map +1 -1
- package/dist/esm/generated/resources/Plugin.d.ts +14 -14
- package/dist/esm/generated/resources/Plugin.js.map +1 -1
- package/dist/esm/generated/resources/PublicInfo.d.ts +4 -4
- package/dist/esm/generated/resources/PublicInfo.js.map +1 -1
- package/dist/esm/generated/resources/Role.d.ts +14 -14
- package/dist/esm/generated/resources/Role.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledPublication.d.ts +6 -6
- package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.d.ts +6 -6
- package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/esm/generated/resources/SchemaMenuItem.d.ts +14 -14
- package/dist/esm/generated/resources/SchemaMenuItem.js.map +1 -1
- package/dist/esm/generated/resources/SearchResult.d.ts +6 -6
- package/dist/esm/generated/resources/SearchResult.js.map +1 -1
- package/dist/esm/generated/resources/Session.d.ts +4 -4
- package/dist/esm/generated/resources/Session.js.map +1 -1
- package/dist/esm/generated/resources/Site.d.ts +24 -24
- package/dist/esm/generated/resources/Site.js.map +1 -1
- package/dist/esm/generated/resources/SiteInvitation.d.ts +14 -14
- package/dist/esm/generated/resources/SiteInvitation.js.map +1 -1
- package/dist/esm/generated/resources/SsoGroup.d.ts +10 -10
- package/dist/esm/generated/resources/SsoGroup.js.map +1 -1
- package/dist/esm/generated/resources/SsoSettings.d.ts +8 -8
- package/dist/esm/generated/resources/SsoSettings.js.map +1 -1
- package/dist/esm/generated/resources/SsoUser.d.ts +10 -10
- package/dist/esm/generated/resources/SsoUser.js.map +1 -1
- package/dist/esm/generated/resources/SubscriptionFeature.d.ts +4 -4
- package/dist/esm/generated/resources/SubscriptionLimit.d.ts +6 -6
- package/dist/esm/generated/resources/SubscriptionLimit.js.map +1 -1
- package/dist/esm/generated/resources/Upload.d.ts +22 -22
- package/dist/esm/generated/resources/Upload.js.map +1 -1
- package/dist/esm/generated/resources/UploadCollection.d.ts +14 -14
- package/dist/esm/generated/resources/UploadCollection.js.map +1 -1
- package/dist/esm/generated/resources/UploadFilter.d.ts +12 -12
- package/dist/esm/generated/resources/UploadFilter.js.map +1 -1
- package/dist/esm/generated/resources/UploadRequest.d.ts +4 -4
- package/dist/esm/generated/resources/UploadRequest.js.map +1 -1
- package/dist/esm/generated/resources/UploadSmartTag.d.ts +6 -6
- package/dist/esm/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/esm/generated/resources/UploadTag.d.ts +8 -8
- package/dist/esm/generated/resources/UploadTag.js.map +1 -1
- package/dist/esm/generated/resources/UploadTrack.d.ts +10 -10
- package/dist/esm/generated/resources/UploadTrack.js.map +1 -1
- package/dist/esm/generated/resources/UsageCounter.d.ts +4 -4
- package/dist/esm/generated/resources/UsageCounter.js.map +1 -1
- package/dist/esm/generated/resources/User.d.ts +12 -12
- package/dist/esm/generated/resources/User.js.map +1 -1
- package/dist/esm/generated/resources/Webhook.d.ts +12 -12
- package/dist/esm/generated/resources/Webhook.js.map +1 -1
- package/dist/esm/generated/resources/WebhookCall.d.ts +9 -9
- package/dist/esm/generated/resources/WebhookCall.js.map +1 -1
- package/dist/esm/generated/resources/WhiteLabelSettings.d.ts +6 -6
- package/dist/esm/generated/resources/WhiteLabelSettings.js.map +1 -1
- package/dist/esm/generated/resources/Workflow.d.ts +11 -11
- package/dist/esm/generated/resources/Workflow.js.map +1 -1
- package/dist/esm/index.d.ts +6 -4
- package/dist/esm/index.js +2 -4
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/resources/Role.d.ts +4 -4
- package/dist/esm/resources/Role.js.map +1 -1
- package/dist/esm/utilities/blocks.d.ts +17 -17
- package/dist/esm/utilities/blocks.js +3 -3
- package/dist/esm/utilities/blocks.js.map +1 -1
- package/dist/esm/utilities/buildBlockRecord.d.ts +5 -5
- package/dist/esm/utilities/buildBlockRecord.js.map +1 -1
- package/dist/{types/utilities/fieldValueLocalization.d.ts → esm/utilities/fieldValue.d.ts} +30 -29
- package/dist/esm/utilities/{fieldValueLocalization.js → fieldValue.js} +39 -39
- package/dist/esm/utilities/fieldValue.js.map +1 -0
- package/dist/esm/utilities/fieldsContainingReferences.d.ts +4 -4
- package/dist/esm/utilities/fieldsContainingReferences.js.map +1 -1
- package/dist/esm/utilities/recursiveBlocks.d.ts +13 -10
- package/dist/esm/utilities/recursiveBlocks.js +19 -20
- package/dist/esm/utilities/recursiveBlocks.js.map +1 -1
- package/dist/esm/utilities/schemaRepository.d.ts +29 -26
- package/dist/esm/utilities/schemaRepository.js.map +1 -1
- package/dist/types/fieldTypes/boolean.d.ts +2 -0
- package/dist/types/fieldTypes/color.d.ts +2 -0
- package/dist/types/fieldTypes/date.d.ts +2 -0
- package/dist/types/fieldTypes/date_time.d.ts +2 -0
- package/dist/types/fieldTypes/file.d.ts +2 -0
- package/dist/types/fieldTypes/float.d.ts +2 -0
- package/dist/types/fieldTypes/gallery.d.ts +2 -0
- package/dist/types/fieldTypes/integer.d.ts +2 -0
- package/dist/types/fieldTypes/json.d.ts +2 -0
- package/dist/types/fieldTypes/lat_lon.d.ts +2 -0
- package/dist/types/fieldTypes/link.d.ts +2 -0
- package/dist/types/fieldTypes/links.d.ts +2 -0
- package/dist/types/fieldTypes/rich_text.d.ts +13 -9
- package/dist/types/fieldTypes/seo.d.ts +2 -0
- package/dist/types/fieldTypes/single_block.d.ts +33 -23
- package/dist/types/fieldTypes/slug.d.ts +2 -0
- package/dist/types/fieldTypes/string.d.ts +2 -0
- package/dist/types/fieldTypes/structured_text.d.ts +22 -83
- package/dist/types/fieldTypes/text.d.ts +2 -0
- package/dist/types/fieldTypes/video.d.ts +2 -0
- package/dist/types/generated/{SimpleSchemaTypes.d.ts → ApiTypes.d.ts} +2 -2
- package/dist/types/generated/Client.d.ts +1 -1
- package/dist/types/generated/{SchemaTypes.d.ts → RawApiTypes.d.ts} +2 -2
- package/dist/types/generated/resources/AccessToken.d.ts +14 -14
- package/dist/types/generated/resources/AuditLogEvent.d.ts +4 -4
- package/dist/types/generated/resources/BuildEvent.d.ts +8 -8
- package/dist/types/generated/resources/BuildTrigger.d.ts +16 -16
- package/dist/types/generated/resources/DailyUsage.d.ts +4 -4
- package/dist/types/generated/resources/EditingSession.d.ts +7 -7
- package/dist/types/generated/resources/EmojiSuggestions.d.ts +4 -4
- package/dist/types/generated/resources/Environment.d.ts +14 -14
- package/dist/types/generated/resources/Field.d.ts +713 -713
- package/dist/types/generated/resources/Fieldset.d.ts +12 -12
- package/dist/types/generated/resources/Item.d.ts +36 -36
- package/dist/types/generated/resources/ItemType.d.ts +15 -15
- package/dist/types/generated/resources/ItemTypeFilter.d.ts +12 -12
- package/dist/types/generated/resources/ItemVersion.d.ts +10 -10
- package/dist/types/generated/resources/JobResult.d.ts +4 -4
- package/dist/types/generated/resources/MaintenanceMode.d.ts +8 -8
- package/dist/types/generated/resources/MenuItem.d.ts +14 -14
- package/dist/types/generated/resources/Plugin.d.ts +14 -14
- package/dist/types/generated/resources/PublicInfo.d.ts +4 -4
- package/dist/types/generated/resources/Role.d.ts +14 -14
- package/dist/types/generated/resources/ScheduledPublication.d.ts +6 -6
- package/dist/types/generated/resources/ScheduledUnpublishing.d.ts +6 -6
- package/dist/types/generated/resources/SchemaMenuItem.d.ts +14 -14
- package/dist/types/generated/resources/SearchResult.d.ts +6 -6
- package/dist/types/generated/resources/Session.d.ts +4 -4
- package/dist/types/generated/resources/Site.d.ts +24 -24
- package/dist/types/generated/resources/SiteInvitation.d.ts +14 -14
- package/dist/types/generated/resources/SsoGroup.d.ts +10 -10
- package/dist/types/generated/resources/SsoSettings.d.ts +8 -8
- package/dist/types/generated/resources/SsoUser.d.ts +10 -10
- package/dist/types/generated/resources/SubscriptionFeature.d.ts +4 -4
- package/dist/types/generated/resources/SubscriptionLimit.d.ts +6 -6
- package/dist/types/generated/resources/Upload.d.ts +22 -22
- package/dist/types/generated/resources/UploadCollection.d.ts +14 -14
- package/dist/types/generated/resources/UploadFilter.d.ts +12 -12
- package/dist/types/generated/resources/UploadRequest.d.ts +4 -4
- package/dist/types/generated/resources/UploadSmartTag.d.ts +6 -6
- package/dist/types/generated/resources/UploadTag.d.ts +8 -8
- package/dist/types/generated/resources/UploadTrack.d.ts +10 -10
- package/dist/types/generated/resources/UsageCounter.d.ts +4 -4
- package/dist/types/generated/resources/User.d.ts +12 -12
- package/dist/types/generated/resources/Webhook.d.ts +12 -12
- package/dist/types/generated/resources/WebhookCall.d.ts +9 -9
- package/dist/types/generated/resources/WhiteLabelSettings.d.ts +6 -6
- package/dist/types/generated/resources/Workflow.d.ts +11 -11
- package/dist/types/index.d.ts +6 -4
- package/dist/types/resources/Role.d.ts +4 -4
- package/dist/types/utilities/blocks.d.ts +17 -17
- package/dist/types/utilities/buildBlockRecord.d.ts +5 -5
- package/dist/{esm/utilities/fieldValueLocalization.d.ts → types/utilities/fieldValue.d.ts} +30 -29
- package/dist/types/utilities/fieldsContainingReferences.d.ts +4 -4
- package/dist/types/utilities/recursiveBlocks.d.ts +13 -10
- package/dist/types/utilities/schemaRepository.d.ts +29 -26
- package/package.json +5 -5
- package/src/fieldTypes/boolean.ts +11 -0
- package/src/fieldTypes/color.ts +11 -0
- package/src/fieldTypes/date.ts +11 -0
- package/src/fieldTypes/date_time.ts +11 -0
- package/src/fieldTypes/file.ts +11 -0
- package/src/fieldTypes/float.ts +11 -0
- package/src/fieldTypes/gallery.ts +11 -0
- package/src/fieldTypes/integer.ts +11 -0
- package/src/fieldTypes/json.ts +11 -0
- package/src/fieldTypes/lat_lon.ts +11 -0
- package/src/fieldTypes/link.ts +11 -0
- package/src/fieldTypes/links.ts +11 -0
- package/src/fieldTypes/rich_text.ts +45 -15
- package/src/fieldTypes/seo.ts +11 -0
- package/src/fieldTypes/single_block.ts +76 -30
- package/src/fieldTypes/slug.ts +12 -1
- package/src/fieldTypes/string.ts +11 -0
- package/src/fieldTypes/structured_text.ts +63 -148
- package/src/fieldTypes/text.ts +11 -0
- package/src/fieldTypes/video.ts +11 -0
- package/src/generated/{SimpleSchemaTypes.ts → ApiTypes.ts} +2 -2
- package/src/generated/Client.ts +2 -2
- package/src/generated/{SchemaTypes.ts → RawApiTypes.ts} +2 -2
- package/src/generated/resources/AccessToken.ts +32 -34
- package/src/generated/resources/AuditLogEvent.ts +8 -8
- package/src/generated/resources/BuildEvent.ts +16 -18
- package/src/generated/resources/BuildTrigger.ts +30 -30
- package/src/generated/resources/DailyUsage.ts +5 -5
- package/src/generated/resources/EditingSession.ts +12 -12
- package/src/generated/resources/EmojiSuggestions.ts +7 -7
- package/src/generated/resources/Environment.ts +33 -39
- package/src/generated/resources/Field.ts +40 -54
- package/src/generated/resources/Fieldset.ts +28 -36
- package/src/generated/resources/Item.ts +99 -126
- package/src/generated/resources/ItemType.ts +37 -45
- package/src/generated/resources/ItemTypeFilter.ts +26 -26
- package/src/generated/resources/ItemVersion.ts +22 -26
- package/src/generated/resources/JobResult.ts +6 -8
- package/src/generated/resources/MaintenanceMode.ts +13 -13
- package/src/generated/resources/MenuItem.ts +34 -44
- package/src/generated/resources/Plugin.ts +30 -42
- package/src/generated/resources/PublicInfo.ts +5 -7
- package/src/generated/resources/Role.ts +29 -44
- package/src/generated/resources/ScheduledPublication.ts +13 -13
- package/src/generated/resources/ScheduledUnpublishing.ts +13 -13
- package/src/generated/resources/SchemaMenuItem.ts +34 -34
- package/src/generated/resources/SearchResult.ts +12 -12
- package/src/generated/resources/Session.ts +8 -10
- package/src/generated/resources/Site.ts +43 -47
- package/src/generated/resources/SiteInvitation.ts +30 -30
- package/src/generated/resources/SsoGroup.ts +20 -24
- package/src/generated/resources/SsoSettings.ts +14 -16
- package/src/generated/resources/SsoUser.ts +18 -22
- package/src/generated/resources/SubscriptionFeature.ts +5 -5
- package/src/generated/resources/SubscriptionLimit.ts +9 -9
- package/src/generated/resources/Upload.ts +57 -73
- package/src/generated/resources/UploadCollection.ts +34 -34
- package/src/generated/resources/UploadFilter.ts +26 -26
- package/src/generated/resources/UploadRequest.ts +8 -8
- package/src/generated/resources/UploadSmartTag.ts +12 -12
- package/src/generated/resources/UploadTag.ts +18 -20
- package/src/generated/resources/UploadTrack.ts +25 -29
- package/src/generated/resources/UsageCounter.ts +8 -8
- package/src/generated/resources/User.ts +28 -39
- package/src/generated/resources/Webhook.ts +26 -34
- package/src/generated/resources/WebhookCall.ts +17 -19
- package/src/generated/resources/WhiteLabelSettings.ts +11 -11
- package/src/generated/resources/Workflow.ts +23 -29
- package/src/index.ts +8 -4
- package/src/resources/Role.ts +6 -6
- package/src/utilities/blocks.ts +30 -30
- package/src/utilities/buildBlockRecord.ts +4 -4
- package/src/utilities/{fieldValueLocalization.ts → fieldValue.ts} +59 -74
- package/src/utilities/fieldsContainingReferences.ts +4 -4
- package/src/utilities/recursiveBlocks.ts +47 -44
- package/src/utilities/schemaRepository.ts +53 -56
- package/dist/cjs/generated/SchemaTypes.js.map +0 -1
- package/dist/cjs/generated/SimpleSchemaTypes.js.map +0 -1
- package/dist/cjs/utilities/fieldValueLocalization.js.map +0 -1
- package/dist/cjs/utilities/structuredText.js +0 -371
- package/dist/cjs/utilities/structuredText.js.map +0 -1
- package/dist/esm/generated/SchemaTypes.js +0 -2
- package/dist/esm/generated/SchemaTypes.js.map +0 -1
- package/dist/esm/generated/SimpleSchemaTypes.js +0 -2
- package/dist/esm/generated/SimpleSchemaTypes.js.map +0 -1
- package/dist/esm/utilities/fieldValueLocalization.js.map +0 -1
- package/dist/esm/utilities/structuredText.d.ts +0 -177
- package/dist/esm/utilities/structuredText.js +0 -354
- package/dist/esm/utilities/structuredText.js.map +0 -1
- package/dist/types/utilities/structuredText.d.ts +0 -177
- package/src/utilities/structuredText.ts +0 -590
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemaRepository.js","sourceRoot":"","sources":["../../../src/utilities/schemaRepository.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;
|
|
1
|
+
{"version":3,"file":"schemaRepository.js","sourceRoot":"","sources":["../../../src/utilities/schemaRepository.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAoBrE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAW3B;;;OAGG;IACH,YAAY,MAAqB;QAbzB,qBAAgB,GAA2C,IAAI,CAAC;QAChE,sBAAiB,GAAsC,IAAI,GAAG,EAAE,CAAC;QACjE,kBAAa,GAAsC,IAAI,GAAG,EAAE,CAAC;QAC7D,qBAAgB,GAAqC,IAAI,GAAG,EAAE,CAAC;QAC/D,wBAAmB,GAAwC,IAAI,GAAG,EAAE,CAAC;QACrE,mBAAc,GAAyC,IAAI,CAAC;QAC5D,gBAAW,GAAoC,IAAI,GAAG,EAAE,CAAC;QACzD,yBAAoB,GAAoC,IAAI,GAAG,EAAE,CAAC;QAOxE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACW,aAAa;;YACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC1B,IAAI,CAAC,gBAAgB,GAAG,CAAC,GAAS,EAAE;oBAClC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;oBAElE,2BAA2B;oBAC3B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;wBAChC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;wBAClE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;qBAC/C;oBAED,OAAO,SAAS,CAAC;gBACnB,CAAC,CAAA,CAAC,EAAE,CAAC;aACN;YAED,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC/B,CAAC;KAAA;IAED;;;OAGG;IACG,eAAe;;YACnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAClD,OAAO,uBAAuB,CAAsB;gBAClD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,kBAAkB;;YACtB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;;OAGG;IACG,YAAY;;YAChB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;YAC/C,OAAO,uBAAuB,CAAsB;gBAClD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,eAAe;;YACnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChE,CAAC;KAAA;IAED;;;OAGG;IACG,iBAAiB;;YACrB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACpD,OAAO,uBAAuB,CAAsB;gBAClD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,oBAAoB;;YACxB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC/D,CAAC;KAAA;IAED;;;;;OAKG;IACG,mBAAmB,CAAC,MAAc;;YACtC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;YAC5D,OAAO,uBAAuB,CAAoB;gBAChD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,sBAAsB,CAAC,MAAc;;YACzC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpD,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,aAAa,CAAC,CAAC;aACjE;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAED;;;;;OAKG;IACG,eAAe,CAAC,EAAU;;YAC9B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACpD,OAAO,uBAAuB,CAAoB;gBAChD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,kBAAkB,CAAC,EAAU;;YACjC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5C,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,sBAAsB,EAAE,aAAa,CAAC,CAAC;aACxD;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAED;;;;;OAKG;IACG,iBAAiB,CACrB,QAAkD;;YAElD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAC/C,QAAgC,CACjC,CAAC;YACF,OAAO,uBAAuB,CAAmB;gBAC/C,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,oBAAoB,CACxB,QAA8B;;YAE9B,6CAA6C;YAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC5D,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;YAED,6BAA6B;YAC7B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;YAE/C,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;IAED;;;;;OAKG;IACG,oBAAoB,CACxB,QAAkD;;YAElD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAClD,QAAgC,CACjC,CAAC;YACF,OAAO,uBAAuB,CAAsB;gBAClD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,uBAAuB,CAC3B,QAA8B;;YAE9B,gDAAgD;YAChD,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAClE,IAAI,eAAe,EAAE;gBACnB,OAAO,eAAe,CAAC;aACxB;YAED,gCAAgC;YAChC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAC7D,QAAQ,CAAC,EAAE,CACZ,CAAC;YACF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YAErD,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;;;OAIG;IACW,WAAW;;YACvB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,IAAI,CAAC,cAAc,GAAG,CAAC,GAAS,EAAE;oBAChC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBAE9D,2BAA2B;oBAC3B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;wBAC5B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;wBACxC,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE;4BAClC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAC3B,MAAM,CAAC,UAAU,CAAC,YAAY,EAC9B,MAAM,CACP,CAAC;yBACH;qBACF;oBAED,OAAO,OAAO,CAAC;gBACjB,CAAC,CAAA,CAAC,EAAE,CAAC;aACN;YAED,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;KAAA;IAED;;;OAGG;IACG,aAAa;;YACjB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAChD,OAAO,uBAAuB,CAAoB;gBAChD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,gBAAgB;;YACpB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;OAKG;IACG,aAAa,CAAC,EAAU;;YAC5B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;YAClD,OAAO,uBAAuB,CAAkB;gBAC9C,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,gBAAgB,CAAC,EAAU;;YAC/B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;aACrD;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;IAED;;;;;OAKG;IACG,sBAAsB,CAAC,WAAmB;;YAC9C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;YACpE,OAAO,uBAAuB,CAAkB;gBAC9C,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,yBAAyB,CAC7B,WAAmB;;YAEnB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,aAAa,CAAC,CAAC;aACxE;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF"}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { BooleanEditorConfiguration } from './appearance/boolean';
|
|
2
3
|
import type { BooleanRadioGroupEditorConfiguration } from './appearance/boolean_radio_group';
|
|
3
4
|
export type BooleanFieldValue = boolean | null;
|
|
4
5
|
export declare function isBooleanFieldValue(value: unknown): value is BooleanFieldValue;
|
|
6
|
+
export declare function isLocalizedBooleanFieldValue(value: unknown): value is LocalizedFieldValue<BooleanFieldValue>;
|
|
5
7
|
export type BooleanFieldValidators = Record<string, never>;
|
|
6
8
|
export type BooleanFieldAppearance = {
|
|
7
9
|
editor: 'boolean';
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { ColorPickerEditorConfiguration } from './appearance/color_picker';
|
|
2
3
|
import type { RequiredValidator } from './validators/required';
|
|
3
4
|
export type ColorFieldValue = {
|
|
@@ -7,6 +8,7 @@ export type ColorFieldValue = {
|
|
|
7
8
|
alpha: number;
|
|
8
9
|
} | null;
|
|
9
10
|
export declare function isColorFieldValue(value: unknown): value is ColorFieldValue;
|
|
11
|
+
export declare function isLocalizedColorFieldValue(value: unknown): value is LocalizedFieldValue<ColorFieldValue>;
|
|
10
12
|
export type ColorFieldValidators = {
|
|
11
13
|
/** Value must be specified or it won't be valid */
|
|
12
14
|
required?: RequiredValidator;
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { DatePickerEditorConfiguration } from './appearance/date_picker';
|
|
2
3
|
import type { DateRangeValidator } from './validators/date_range';
|
|
3
4
|
import type { RequiredValidator } from './validators/required';
|
|
4
5
|
export type DateFieldValue = string | null;
|
|
5
6
|
export declare function isDateFieldValue(value: unknown): value is DateFieldValue;
|
|
7
|
+
export declare function isLocalizedDateFieldValue(value: unknown): value is LocalizedFieldValue<DateFieldValue>;
|
|
6
8
|
export type DateFieldValidators = {
|
|
7
9
|
/** Value must be specified or it won't be valid */
|
|
8
10
|
required?: RequiredValidator;
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { DateTimePickerEditorConfiguration } from './appearance/date_time_picker';
|
|
2
3
|
import type { DateTimeRangeValidator } from './validators/date_time_range';
|
|
3
4
|
import type { RequiredValidator } from './validators/required';
|
|
4
5
|
export type DateTimeFieldValue = string | null;
|
|
5
6
|
export declare function isDateTimeFieldValue(value: unknown): value is DateTimeFieldValue;
|
|
7
|
+
export declare function isLocalizedDateTimeFieldValue(value: unknown): value is LocalizedFieldValue<DateTimeFieldValue>;
|
|
6
8
|
export type DateTimeFieldValidators = {
|
|
7
9
|
/** Value must be specified or it won't be valid */
|
|
8
10
|
required?: RequiredValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { FileEditorConfiguration } from './appearance/file';
|
|
2
3
|
import type { ExtensionValidator } from './validators/extension';
|
|
3
4
|
import type { FileSizeValidator } from './validators/file_size';
|
|
@@ -16,6 +17,7 @@ export type FileFieldValue = {
|
|
|
16
17
|
} | null;
|
|
17
18
|
} | null;
|
|
18
19
|
export declare function isFileFieldValue(value: unknown): value is FileFieldValue;
|
|
20
|
+
export declare function isLocalizedFileFieldValue(value: unknown): value is LocalizedFieldValue<FileFieldValue>;
|
|
19
21
|
export type FileFieldValidators = {
|
|
20
22
|
/** Value must be specified or it won't be valid */
|
|
21
23
|
required?: RequiredValidator;
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { FloatEditorConfiguration } from './appearance/float';
|
|
2
3
|
import type { NumberRangeValidator } from './validators/number_range';
|
|
3
4
|
import type { RequiredValidator } from './validators/required';
|
|
4
5
|
export type FloatFieldValue = number | null;
|
|
5
6
|
export declare function isFloatFieldValue(value: unknown): value is FloatFieldValue;
|
|
7
|
+
export declare function isLocalizedFloatFieldValue(value: unknown): value is LocalizedFieldValue<FloatFieldValue>;
|
|
6
8
|
export type FloatFieldValidators = {
|
|
7
9
|
/** Value must be specified or it won't be valid */
|
|
8
10
|
required?: RequiredValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { GalleryEditorConfiguration } from './appearance/gallery';
|
|
2
3
|
import type { ExtensionValidator } from './validators/extension';
|
|
3
4
|
import type { FileSizeValidator } from './validators/file_size';
|
|
@@ -16,6 +17,7 @@ export type GalleryFieldValue = Array<{
|
|
|
16
17
|
} | null;
|
|
17
18
|
}> | null;
|
|
18
19
|
export declare function isGalleryFieldValue(value: unknown): value is GalleryFieldValue;
|
|
20
|
+
export declare function isLocalizedGalleryFieldValue(value: unknown): value is LocalizedFieldValue<GalleryFieldValue>;
|
|
19
21
|
export type GalleryFieldValidators = {
|
|
20
22
|
/** Only accept a number of items within the specified range */
|
|
21
23
|
size?: SizeValidator;
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { IntegerEditorConfiguration } from './appearance/integer';
|
|
2
3
|
import type { NumberRangeValidator } from './validators/number_range';
|
|
3
4
|
import type { RequiredValidator } from './validators/required';
|
|
4
5
|
export type IntegerFieldValue = number | null;
|
|
5
6
|
export declare function isIntegerFieldValue(value: unknown): value is IntegerFieldValue;
|
|
7
|
+
export declare function isLocalizedIntegerFieldValue(value: unknown): value is LocalizedFieldValue<IntegerFieldValue>;
|
|
6
8
|
export type IntegerFieldValidators = {
|
|
7
9
|
/** Value must be specified or it won't be valid */
|
|
8
10
|
required?: RequiredValidator;
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { JsonEditorConfiguration } from './appearance/json';
|
|
2
3
|
import type { StringCheckboxGroupEditorConfiguration } from './appearance/string_checkbox_group';
|
|
3
4
|
import type { StringMultiSelectEditorConfiguration } from './appearance/string_multi_select';
|
|
4
5
|
import type { RequiredValidator } from './validators/required';
|
|
5
6
|
export type JsonFieldValue = string | null;
|
|
6
7
|
export declare function isJsonFieldValue(value: unknown): value is JsonFieldValue;
|
|
8
|
+
export declare function isLocalizedJsonFieldValue(value: unknown): value is LocalizedFieldValue<JsonFieldValue>;
|
|
7
9
|
export type JsonFieldValidators = {
|
|
8
10
|
/** Value must be specified or it won't be valid */
|
|
9
11
|
required?: RequiredValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { MapEditorConfiguration } from './appearance/map';
|
|
2
3
|
import type { RequiredValidator } from './validators/required';
|
|
3
4
|
export type LocationFieldValue = {
|
|
@@ -5,6 +6,7 @@ export type LocationFieldValue = {
|
|
|
5
6
|
longitude: number;
|
|
6
7
|
} | null;
|
|
7
8
|
export declare function isLocationFieldValue(value: unknown): value is LocationFieldValue;
|
|
9
|
+
export declare function isLocalizedLocationFieldValue(value: unknown): value is LocalizedFieldValue<LocationFieldValue>;
|
|
8
10
|
export type LocationFieldValidators = {
|
|
9
11
|
/** Value must be specified or it won't be valid */
|
|
10
12
|
required?: RequiredValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { LinkEmbedEditorConfiguration } from './appearance/link_embed';
|
|
2
3
|
import type { LinkSelectEditorConfiguration } from './appearance/link_select';
|
|
3
4
|
import type { ItemItemTypeValidator } from './validators/item_item_type';
|
|
@@ -5,6 +6,7 @@ import type { RequiredValidator } from './validators/required';
|
|
|
5
6
|
import type { UniqueValidator } from './validators/unique';
|
|
6
7
|
export type LinkFieldValue = string | null;
|
|
7
8
|
export declare function isLinkFieldValue(value: unknown): value is LinkFieldValue;
|
|
9
|
+
export declare function isLocalizedLinkFieldValue(value: unknown): value is LocalizedFieldValue<LinkFieldValue>;
|
|
8
10
|
export type LinkFieldValidators = {
|
|
9
11
|
/** Only accept references to records of the specified models */
|
|
10
12
|
item_item_type: ItemItemTypeValidator;
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { LinksEmbedEditorConfiguration } from './appearance/links_embed';
|
|
2
3
|
import type { LinksSelectEditorConfiguration } from './appearance/links_select';
|
|
3
4
|
import type { ItemsItemTypeValidator } from './validators/items_item_type';
|
|
4
5
|
import type { SizeValidator } from './validators/size';
|
|
5
6
|
export type LinksFieldValue = string[] | null;
|
|
6
7
|
export declare function isLinksFieldValue(value: unknown): value is LinksFieldValue;
|
|
8
|
+
export declare function isLocalizedLinksFieldValue(value: unknown): value is LocalizedFieldValue<LinksFieldValue>;
|
|
7
9
|
export type LinksFieldValidators = {
|
|
8
10
|
/** Only accept references to records of the specified models */
|
|
9
11
|
items_item_type: ItemsItemTypeValidator;
|
|
@@ -1,5 +1,9 @@
|
|
|
1
|
-
import type * as
|
|
1
|
+
import type * as RawApiTypes from '../generated/RawApiTypes';
|
|
2
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
3
|
+
import type { RichTextEditorConfiguration } from './appearance/rich_text';
|
|
2
4
|
import { type BlockItemInARequest } from './single_block';
|
|
5
|
+
import type { RichTextBlocksValidator } from './validators/rich_text_blocks';
|
|
6
|
+
import type { SizeValidator } from './validators/size';
|
|
3
7
|
/**
|
|
4
8
|
* MODULAR CONTENT FIELD TYPE SYSTEM FOR DATOCMS
|
|
5
9
|
*
|
|
@@ -43,8 +47,8 @@ export type RichTextFieldValue = string[] | null;
|
|
|
43
47
|
/**
|
|
44
48
|
* Modular Content field value for API requests - allows flexible block representations:
|
|
45
49
|
* - string: Just the block ID (most common case)
|
|
46
|
-
* -
|
|
47
|
-
* - Omit<
|
|
50
|
+
* - RawApiTypes.Item: Full block object with ID (for updates)
|
|
51
|
+
* - Omit<RawApiTypes.Item, 'id'>: Block object without ID (for creation)
|
|
48
52
|
*/
|
|
49
53
|
export type RichTextFieldValueAsRequest = BlockItemInARequest[] | null;
|
|
50
54
|
/**
|
|
@@ -53,13 +57,13 @@ export type RichTextFieldValueAsRequest = BlockItemInARequest[] | null;
|
|
|
53
57
|
* =============================================================================
|
|
54
58
|
*
|
|
55
59
|
* When using the ?nested=true query parameter, the API returns Modular Content data
|
|
56
|
-
* with embedded blocks fully populated as complete
|
|
60
|
+
* with embedded blocks fully populated as complete RawApiTypes.Item objects instead
|
|
57
61
|
* of just string IDs. This provides type safety for working with fully resolved data.
|
|
58
62
|
*/
|
|
59
63
|
/**
|
|
60
64
|
* Modular Content field value with nested blocks - array of fully populated block objects
|
|
61
65
|
*/
|
|
62
|
-
export type RichTextFieldValueWithNestedBlocks =
|
|
66
|
+
export type RichTextFieldValueWithNestedBlocks = RawApiTypes.Item[] | null;
|
|
63
67
|
/**
|
|
64
68
|
* =============================================================================
|
|
65
69
|
* TYPE GUARDS - Runtime validation functions
|
|
@@ -70,19 +74,19 @@ export type RichTextFieldValueWithNestedBlocks = SchemaTypes.Item[] | null;
|
|
|
70
74
|
* Checks for array structure and ensures all blocks are string references.
|
|
71
75
|
*/
|
|
72
76
|
export declare function isRichTextFieldValue(value: unknown): value is RichTextFieldValue;
|
|
77
|
+
export declare function isLocalizedRichTextFieldValue(value: unknown): value is LocalizedFieldValue<RichTextFieldValue>;
|
|
73
78
|
/**
|
|
74
79
|
* Type guard for Modular Content field values in API request format.
|
|
75
80
|
* Allows blocks as string IDs, full objects with IDs, or objects without IDs.
|
|
76
81
|
*/
|
|
77
82
|
export declare function isRichTextFieldValueAsRequest(value: unknown): value is RichTextFieldValueAsRequest;
|
|
83
|
+
export declare function isLocalizedRichTextFieldValueAsRequest(value: unknown): value is LocalizedFieldValue<RichTextFieldValueAsRequest>;
|
|
78
84
|
/**
|
|
79
85
|
* Type guard for Modular Content field values with nested blocks (?nested=true format).
|
|
80
|
-
* Ensures all blocks are full
|
|
86
|
+
* Ensures all blocks are full RawApiTypes.Item objects with complete data.
|
|
81
87
|
*/
|
|
82
88
|
export declare function isRichTextFieldValueWithNestedBlocks(value: unknown): value is RichTextFieldValueWithNestedBlocks;
|
|
83
|
-
|
|
84
|
-
import type { RichTextBlocksValidator } from './validators/rich_text_blocks';
|
|
85
|
-
import type { SizeValidator } from './validators/size';
|
|
89
|
+
export declare function isLocalizedRichTextFieldValueWithNestedBlocks(value: unknown): value is LocalizedFieldValue<RichTextFieldValueWithNestedBlocks>;
|
|
86
90
|
export type RichTextFieldValidators = {
|
|
87
91
|
/** Only accept references to block records of the specified block models */
|
|
88
92
|
rich_text_blocks: RichTextBlocksValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { SeoEditorConfiguration } from './appearance/seo';
|
|
2
3
|
import type { DescriptionLengthValidator } from './validators/description_length';
|
|
3
4
|
import type { FileSizeValidator } from './validators/file_size';
|
|
@@ -13,6 +14,7 @@ export type SeoFieldValue = {
|
|
|
13
14
|
no_index?: boolean;
|
|
14
15
|
} | null;
|
|
15
16
|
export declare function isSeoFieldValue(value: unknown): value is SeoFieldValue;
|
|
17
|
+
export declare function isLocalizedSeoFieldValue(value: unknown): value is LocalizedFieldValue<SeoFieldValue>;
|
|
16
18
|
export type SeoFieldValidators = {
|
|
17
19
|
/** SEO field has to specify one or more properties, or it won't be valid */
|
|
18
20
|
required_seo_fields?: RequiredSeoFieldsValidator;
|
|
@@ -1,4 +1,9 @@
|
|
|
1
|
-
import type * as
|
|
1
|
+
import type * as RawApiTypes from '../generated/RawApiTypes';
|
|
2
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
3
|
+
import type { FramedSingleBlockEditorConfiguration } from './appearance/framed_single_block';
|
|
4
|
+
import type { FramelessSingleBlockEditorConfiguration } from './appearance/frameless_single_block';
|
|
5
|
+
import type { RequiredValidator } from './validators/required';
|
|
6
|
+
import type { SingleBlockBlocksValidator } from './validators/single_block_blocks';
|
|
2
7
|
/**
|
|
3
8
|
* SINGLE BLOCK FIELD TYPE SYSTEM FOR DATOCMS
|
|
4
9
|
*
|
|
@@ -39,20 +44,26 @@ export type SingleBlockFieldValue = string | null;
|
|
|
39
44
|
* - Include full block object for updates
|
|
40
45
|
* - Omit ID for new blocks being created
|
|
41
46
|
*/
|
|
47
|
+
/** Represents an existing block in a CMA request */
|
|
48
|
+
export type UnchangedBlockInARequest = string;
|
|
49
|
+
/** Represents a block we want to update in a CMA request */
|
|
50
|
+
export type UpdatedBlockInARequest = OptionalFields<RawApiTypes.Item, 'meta'>;
|
|
51
|
+
/** Represents a new block to create in a CMA request */
|
|
52
|
+
export type NewBlockInARequest = OptionalFields<RawApiTypes.Item, 'id' | 'meta'>;
|
|
42
53
|
/**
|
|
43
54
|
* Union type representing the different ways a block can be specified in API requests:
|
|
44
|
-
* - string: Just the block ID (
|
|
45
|
-
* - Full block object with ID (
|
|
46
|
-
* - Block object without ID (
|
|
55
|
+
* - string: Just the block ID (to keep existing blocks unchanged)
|
|
56
|
+
* - Full block object with ID (to update an existing block)
|
|
57
|
+
* - Block object without ID (to create a new block)
|
|
47
58
|
*
|
|
48
59
|
* Also, 'meta' can always be omitted
|
|
49
60
|
*/
|
|
50
|
-
export type BlockItemInARequest =
|
|
61
|
+
export type BlockItemInARequest = UnchangedBlockInARequest | UpdatedBlockInARequest | NewBlockInARequest;
|
|
51
62
|
/**
|
|
52
63
|
* Single Block field value for API requests - allows flexible block representations:
|
|
53
|
-
* - string: Just the block ID (
|
|
54
|
-
* -
|
|
55
|
-
* -
|
|
64
|
+
* - string: Just the block ID (to keep existing blocks unchanged)
|
|
65
|
+
* - Full block object with ID (to update an existing block)
|
|
66
|
+
* - Block object without ID (to create a new block)
|
|
56
67
|
*/
|
|
57
68
|
export type SingleBlockFieldValueAsRequest = BlockItemInARequest | null;
|
|
58
69
|
/**
|
|
@@ -61,13 +72,13 @@ export type SingleBlockFieldValueAsRequest = BlockItemInARequest | null;
|
|
|
61
72
|
* =============================================================================
|
|
62
73
|
*
|
|
63
74
|
* When using the ?nested=true query parameter, the API returns Single Block data
|
|
64
|
-
* with embedded block fully populated as complete
|
|
75
|
+
* with embedded block fully populated as complete RawApiTypes.Item object instead
|
|
65
76
|
* of just string ID. This provides type safety for working with fully resolved data.
|
|
66
77
|
*/
|
|
67
78
|
/**
|
|
68
79
|
* Single Block field value with nested block - fully populated block object
|
|
69
80
|
*/
|
|
70
|
-
export type SingleBlockFieldValueWithNestedBlocks =
|
|
81
|
+
export type SingleBlockFieldValueWithNestedBlocks = RawApiTypes.Item | null;
|
|
71
82
|
/**
|
|
72
83
|
* =============================================================================
|
|
73
84
|
* SHARED UTILITY FUNCTIONS
|
|
@@ -75,19 +86,19 @@ export type SingleBlockFieldValueWithNestedBlocks = SchemaTypes.Item | null;
|
|
|
75
86
|
* These functions are used internally and can be imported by other modules
|
|
76
87
|
*/
|
|
77
88
|
/**
|
|
78
|
-
* Validates if a
|
|
89
|
+
* Validates if the input is a valid item (either block or record) ID
|
|
79
90
|
*/
|
|
80
|
-
export declare function
|
|
81
|
-
export type ItemWithOptionalIdAndMeta = OptionalFields<
|
|
91
|
+
export declare function isItemId(input: unknown): input is string;
|
|
92
|
+
export type ItemWithOptionalIdAndMeta = OptionalFields<RawApiTypes.Item, 'id' | 'meta'>;
|
|
82
93
|
/**
|
|
83
|
-
* Validates if
|
|
94
|
+
* Validates if the input is a RawApiTypes.Item object (with optional `id` and `meta`)
|
|
84
95
|
*/
|
|
85
|
-
export declare function
|
|
86
|
-
export type ItemWithOptionalMeta = OptionalFields<
|
|
96
|
+
export declare function isItemWithOptionalIdAndMeta(block: unknown): block is ItemWithOptionalIdAndMeta;
|
|
97
|
+
export type ItemWithOptionalMeta = OptionalFields<RawApiTypes.Item, 'meta'>;
|
|
87
98
|
/**
|
|
88
|
-
* Validates if
|
|
99
|
+
* Validates if the input is a a complete RawApiTypes.Item object with optional `meta`
|
|
89
100
|
*/
|
|
90
|
-
export declare function
|
|
101
|
+
export declare function isItemWithOptionalMeta(block: unknown): block is ItemWithOptionalMeta;
|
|
91
102
|
/**
|
|
92
103
|
* =============================================================================
|
|
93
104
|
* TYPE GUARDS - Runtime validation functions
|
|
@@ -98,20 +109,19 @@ export declare function isBlockObjectWithId(block: unknown): block is ItemWithOp
|
|
|
98
109
|
* Checks for string structure and ensures block is a string reference.
|
|
99
110
|
*/
|
|
100
111
|
export declare function isSingleBlockFieldValue(value: unknown): value is SingleBlockFieldValue;
|
|
112
|
+
export declare function isLocalizedSingleBlockFieldValue(value: unknown): value is LocalizedFieldValue<SingleBlockFieldValue>;
|
|
101
113
|
/**
|
|
102
114
|
* Type guard for Single Block field values in API request format.
|
|
103
115
|
* Allows block as string ID, full object with ID, or object without ID.
|
|
104
116
|
*/
|
|
105
117
|
export declare function isSingleBlockFieldValueAsRequest(value: unknown): value is SingleBlockFieldValueAsRequest;
|
|
118
|
+
export declare function isLocalizedSingleBlockFieldValueAsRequest(value: unknown): value is LocalizedFieldValue<SingleBlockFieldValueAsRequest>;
|
|
106
119
|
/**
|
|
107
120
|
* Type guard for Single Block field values with nested blocks (?nested=true format).
|
|
108
|
-
* Ensures block is a full
|
|
121
|
+
* Ensures block is a full RawApiTypes.Item object with complete data.
|
|
109
122
|
*/
|
|
110
123
|
export declare function isSingleBlockFieldValueWithNestedBlocks(value: unknown): value is SingleBlockFieldValueWithNestedBlocks;
|
|
111
|
-
|
|
112
|
-
import type { FramelessSingleBlockEditorConfiguration } from './appearance/frameless_single_block';
|
|
113
|
-
import type { RequiredValidator } from './validators/required';
|
|
114
|
-
import type { SingleBlockBlocksValidator } from './validators/single_block_blocks';
|
|
124
|
+
export declare function isLocalizedSingleBlockFieldValueWithNestedBlocks(value: unknown): value is LocalizedFieldValue<SingleBlockFieldValueWithNestedBlocks>;
|
|
115
125
|
export type SingleBlockFieldValidators = {
|
|
116
126
|
/** Only accept references to block records of the specified block models */
|
|
117
127
|
single_block_blocks: SingleBlockBlocksValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { SlugEditorConfiguration } from './appearance/slug';
|
|
2
3
|
import type { LengthValidator } from './validators/length';
|
|
3
4
|
import type { RequiredValidator } from './validators/required';
|
|
@@ -5,6 +6,7 @@ import type { SlugFormatValidator } from './validators/slug_format';
|
|
|
5
6
|
import type { SlugTitleFieldValidator } from './validators/slug_title_field';
|
|
6
7
|
export type SlugFieldValue = string | null;
|
|
7
8
|
export declare function isSlugFieldValue(value: unknown): value is SlugFieldValue;
|
|
9
|
+
export declare function isLocalizedSlugFieldValue(value: unknown): value is LocalizedFieldValue<SlugFieldValue>;
|
|
8
10
|
export type SlugFieldValidators = {
|
|
9
11
|
/** Value must be specified or it won't be valid */
|
|
10
12
|
required?: RequiredValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { SingleLineEditorConfiguration } from './appearance/single_line';
|
|
2
3
|
import type { StringRadioGroupEditorConfiguration } from './appearance/string_radio_group';
|
|
3
4
|
import type { StringSelectEditorConfiguration } from './appearance/string_select';
|
|
@@ -8,6 +9,7 @@ import type { RequiredValidator } from './validators/required';
|
|
|
8
9
|
import type { UniqueValidator } from './validators/unique';
|
|
9
10
|
export type StringFieldValue = string | null;
|
|
10
11
|
export declare function isStringFieldValue(value: unknown): value is StringFieldValue;
|
|
12
|
+
export declare function isLocalizedStringFieldValue(value: unknown): value is LocalizedFieldValue<StringFieldValue>;
|
|
11
13
|
export type StringFieldValidators = {
|
|
12
14
|
/** Value must be specified or it won't be valid */
|
|
13
15
|
required?: RequiredValidator;
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import { type Block, type Document, type InlineBlock
|
|
2
|
-
import type * as
|
|
1
|
+
import { type Block, type Document, type InlineBlock } from 'datocms-structured-text-utils';
|
|
2
|
+
import type * as RawApiTypes from '../generated/RawApiTypes';
|
|
3
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
4
|
+
import type { StructuredTextEditorConfiguration } from './appearance/structured_text';
|
|
3
5
|
import { type BlockItemInARequest } from './single_block';
|
|
6
|
+
import type { LengthValidator } from './validators/length';
|
|
7
|
+
import type { StructuredTextBlocksValidator } from './validators/structured_text_blocks';
|
|
8
|
+
import type { StructuredTextInlineBlocksValidator } from './validators/structured_text_inline_blocks';
|
|
9
|
+
import type { StructuredTextLinksValidator } from './validators/structured_text_links';
|
|
4
10
|
/**
|
|
5
11
|
* STRUCTURED TEXT TYPE SYSTEM FOR DATOCMS
|
|
6
12
|
*
|
|
@@ -10,10 +16,10 @@ import { type BlockItemInARequest } from './single_block';
|
|
|
10
16
|
* The challenge we're solving:
|
|
11
17
|
* - DatoCMS structured text can contain "blocks" (embedded content items) in bloth 'block'
|
|
12
18
|
* and 'inlineBlock' nodes
|
|
13
|
-
* - By default,
|
|
19
|
+
* - By default, CMA responses contain blocks as string IDs (lightweight references)
|
|
14
20
|
* - With ?nested=true parameter though, API responses contain blocks as full item objects
|
|
15
21
|
* (which in turn can contain other blocks)
|
|
16
|
-
* - For
|
|
22
|
+
* - For CMA requests, blocks can be represented as:
|
|
17
23
|
* 1. String IDs (referencing existing items)
|
|
18
24
|
* 2. Full item objects with IDs (for updates)
|
|
19
25
|
* 3. Item objects without IDs (for creation)
|
|
@@ -33,62 +39,36 @@ import { type BlockItemInARequest } from './single_block';
|
|
|
33
39
|
/**
|
|
34
40
|
* Variant of 'block' structured text node for API requests
|
|
35
41
|
*/
|
|
36
|
-
export type BlockAsRequest =
|
|
37
|
-
item: BlockItemInARequest;
|
|
38
|
-
};
|
|
42
|
+
export type BlockAsRequest = Block<BlockItemInARequest>;
|
|
39
43
|
/**
|
|
40
44
|
* Variant of 'inlineBlock' structured text node for API requests
|
|
41
45
|
*/
|
|
42
|
-
export type InlineBlockAsRequest =
|
|
43
|
-
item: BlockItemInARequest;
|
|
44
|
-
};
|
|
45
|
-
/**
|
|
46
|
-
* Generic type to transform a node that might be containing a 'block' or 'inlineBlock' as a (deeply nested) children to its variant for API requests
|
|
47
|
-
*/
|
|
48
|
-
export type NodeAsRequest<T> = WithMappedChildren<T, DeepMapVariants<T extends {
|
|
49
|
-
children: infer C;
|
|
50
|
-
} ? C : never, BlockAsRequest, InlineBlockAsRequest>>;
|
|
46
|
+
export type InlineBlockAsRequest = InlineBlock<BlockItemInARequest>;
|
|
51
47
|
/**
|
|
52
48
|
* Variant of Structured Text document for API requests
|
|
53
49
|
*/
|
|
54
|
-
export type DocumentAsRequest =
|
|
55
|
-
schema: 'dast';
|
|
56
|
-
document: NodeAsRequest<Root>;
|
|
57
|
-
};
|
|
50
|
+
export type DocumentAsRequest = Document<BlockItemInARequest>;
|
|
58
51
|
/**
|
|
59
52
|
* =============================================================================
|
|
60
53
|
* NESTED VARIANTS - Types for API responses with ?nested=true parameter
|
|
61
54
|
* =============================================================================
|
|
62
55
|
*
|
|
63
|
-
* When using the GET /items?nested=true, the
|
|
64
|
-
* with embedded blocks fully populated as complete
|
|
56
|
+
* When using the GET /items?nested=true, the CMA returns Structured Text documents
|
|
57
|
+
* with embedded blocks fully populated as complete RawApiTypes.Item objects instead
|
|
65
58
|
* of just string IDs.
|
|
66
59
|
*/
|
|
67
60
|
/**
|
|
68
61
|
* Variant of 'block' structured text node for ?nested=true API responses
|
|
69
62
|
*/
|
|
70
|
-
export type BlockWithNestedBlocks =
|
|
71
|
-
item: SchemaTypes.Item;
|
|
72
|
-
};
|
|
63
|
+
export type BlockWithNestedBlocks = Block<RawApiTypes.Item>;
|
|
73
64
|
/**
|
|
74
65
|
* Variant of 'inlineBlock' structured text node for ?nested=true API responses
|
|
75
66
|
*/
|
|
76
|
-
export type InlineBlockWithNestedBlocks =
|
|
77
|
-
item: SchemaTypes.Item;
|
|
78
|
-
};
|
|
79
|
-
/**
|
|
80
|
-
* Generic type to transform a node that might be containing a 'block' or 'inlineBlock' as a (deeply nested) children to it's variant for ?nested=true API responses
|
|
81
|
-
*/
|
|
82
|
-
export type NodeWithNestedBlocks<T> = WithMappedChildren<T, DeepMapVariants<T extends {
|
|
83
|
-
children: infer C;
|
|
84
|
-
} ? C : never, BlockWithNestedBlocks, InlineBlockWithNestedBlocks>>;
|
|
67
|
+
export type InlineBlockWithNestedBlocks = InlineBlock<RawApiTypes.Item>;
|
|
85
68
|
/**
|
|
86
69
|
* Variant of Structured Text document for ?nested=true API responses
|
|
87
70
|
*/
|
|
88
|
-
export type DocumentWithNestedBlocks =
|
|
89
|
-
schema: 'dast';
|
|
90
|
-
document: NodeWithNestedBlocks<Root>;
|
|
91
|
-
};
|
|
71
|
+
export type DocumentWithNestedBlocks = Document<RawApiTypes.Item>;
|
|
92
72
|
/**
|
|
93
73
|
* =============================================================================
|
|
94
74
|
* MAIN APPLICATION TYPES
|
|
@@ -106,59 +86,19 @@ export type StructuredTextFieldValueWithNestedBlocks = DocumentWithNestedBlocks
|
|
|
106
86
|
* Checks for the expected structure and ensures all block/inlineBlock nodes have string IDs.
|
|
107
87
|
*/
|
|
108
88
|
export declare function isStructuredTextFieldValue(value: unknown): value is StructuredTextFieldValue;
|
|
89
|
+
export declare function isLocalizedStructuredTextFieldValue(value: unknown): value is LocalizedFieldValue<StructuredTextFieldValue>;
|
|
109
90
|
/**
|
|
110
91
|
* Type guard for structured text field values in API request format.
|
|
111
92
|
* Allows blocks as string IDs, full objects with IDs, or objects without IDs.
|
|
112
93
|
*/
|
|
113
94
|
export declare function isStructuredTextFieldValueAsRequest(value: unknown): value is StructuredTextFieldValueAsRequest;
|
|
95
|
+
export declare function isLocalizedStructuredTextFieldValueAsRequest(value: unknown): value is LocalizedFieldValue<StructuredTextFieldValueAsRequest>;
|
|
114
96
|
/**
|
|
115
97
|
* Type guard for structured text field values with nested blocks (?nested=true format).
|
|
116
|
-
* Ensures all block/inlineBlock nodes have full
|
|
98
|
+
* Ensures all block/inlineBlock nodes have full RawApiTypes.Item objects.
|
|
117
99
|
*/
|
|
118
100
|
export declare function isStructuredTextFieldValueWithNestedBlocks(value: unknown): value is StructuredTextFieldValueWithNestedBlocks;
|
|
119
|
-
|
|
120
|
-
* =============================================================================
|
|
121
|
-
* SHARED TRANSFORMATION UTILITIES
|
|
122
|
-
* =============================================================================
|
|
123
|
-
*
|
|
124
|
-
* These utility types provide the machinery for automatically transforming
|
|
125
|
-
* structured text types between their different variants. The goal is to
|
|
126
|
-
* recursively walk through complex nested structures and apply the appropriate
|
|
127
|
-
* transformations to Block and InlineBlock nodes while preserving all other types.
|
|
128
|
-
*/
|
|
129
|
-
/**
|
|
130
|
-
* Utility type that preserves the structure of T but replaces its children with ChildrenType.
|
|
131
|
-
* If T doesn't have children, it returns T unchanged.
|
|
132
|
-
*/
|
|
133
|
-
type WithMappedChildren<T, ChildrenType> = T extends {
|
|
134
|
-
children: any;
|
|
135
|
-
} ? Omit<T, 'children'> & {
|
|
136
|
-
children: ChildrenType;
|
|
137
|
-
} : T;
|
|
138
|
-
/**
|
|
139
|
-
* Generic transformation type that replace 'block' and 'inlineBlock' node types to their variants.
|
|
140
|
-
*/
|
|
141
|
-
type MapVariants<T, BlockVariant, InlineBlockVariant> = T extends Block ? BlockVariant : T extends InlineBlock ? InlineBlockVariant : T;
|
|
142
|
-
/**
|
|
143
|
-
* Recursively transform a Structured Text node type using the provided variants for 'block' and 'inlineBlock' nodes.
|
|
144
|
-
*
|
|
145
|
-
* This handles three cases:
|
|
146
|
-
* _ Arrays: Transform each array element recursively
|
|
147
|
-
* _ Objects with children: Transform the object itself AND recursively transform its children
|
|
148
|
-
* _ Leaf nodes: Apply the variant mapping
|
|
149
|
-
*/
|
|
150
|
-
type DeepMapVariants<T, BlockVariant, InlineBlockVariant> = T extends (infer U)[] ? DeepMapVariants<U, BlockVariant, InlineBlockVariant>[] : T extends {
|
|
151
|
-
children: infer Children;
|
|
152
|
-
} ? T extends {
|
|
153
|
-
children: any;
|
|
154
|
-
} ? Omit<T, 'children'> & {
|
|
155
|
-
children: DeepMapVariants<Children, BlockVariant, InlineBlockVariant>;
|
|
156
|
-
} : MapVariants<T, BlockVariant, InlineBlockVariant> : MapVariants<T, BlockVariant, InlineBlockVariant>;
|
|
157
|
-
import type { StructuredTextEditorConfiguration } from './appearance/structured_text';
|
|
158
|
-
import type { LengthValidator } from './validators/length';
|
|
159
|
-
import type { StructuredTextBlocksValidator } from './validators/structured_text_blocks';
|
|
160
|
-
import type { StructuredTextInlineBlocksValidator } from './validators/structured_text_inline_blocks';
|
|
161
|
-
import type { StructuredTextLinksValidator } from './validators/structured_text_links';
|
|
101
|
+
export declare function isLocalizedStructuredTextFieldValueWithNestedBlocks(value: unknown): value is LocalizedFieldValue<StructuredTextFieldValueWithNestedBlocks>;
|
|
162
102
|
export type StructuredTextFieldValidators = {
|
|
163
103
|
/** Only accept references to block records of the specified block models */
|
|
164
104
|
structured_text_blocks: StructuredTextBlocksValidator;
|
|
@@ -178,4 +118,3 @@ export type StructuredTextFieldAppearance = {
|
|
|
178
118
|
/** Plugin configuration */
|
|
179
119
|
parameters: Record<string, unknown>;
|
|
180
120
|
};
|
|
181
|
-
export {};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { MarkdownEditorConfiguration } from './appearance/markdown';
|
|
2
3
|
import type { TextareaEditorConfiguration } from './appearance/textarea';
|
|
3
4
|
import type { WysiwygEditorConfiguration } from './appearance/wysiwyg';
|
|
@@ -7,6 +8,7 @@ import type { RequiredValidator } from './validators/required';
|
|
|
7
8
|
import type { SanitizationValidator } from './validators/sanitization';
|
|
8
9
|
export type TextFieldValue = string | null;
|
|
9
10
|
export declare function isTextFieldValue(value: unknown): value is TextFieldValue;
|
|
11
|
+
export declare function isLocalizedTextFieldValue(value: unknown): value is LocalizedFieldValue<TextFieldValue>;
|
|
10
12
|
export type TextFieldValidators = {
|
|
11
13
|
/** Value must be specified or it won't be valid */
|
|
12
14
|
required?: RequiredValidator;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
1
2
|
import type { VideoEditorConfiguration } from './appearance/video';
|
|
2
3
|
import type { RequiredValidator } from './validators/required';
|
|
3
4
|
export type VideoFieldValue = {
|
|
@@ -10,6 +11,7 @@ export type VideoFieldValue = {
|
|
|
10
11
|
title: string;
|
|
11
12
|
} | null;
|
|
12
13
|
export declare function isVideoFieldValue(value: unknown): value is VideoFieldValue;
|
|
14
|
+
export declare function isLocalizedVideoFieldValue(value: unknown): value is LocalizedFieldValue<VideoFieldValue>;
|
|
13
15
|
export type VideoFieldValidators = {
|
|
14
16
|
/** Value must be specified or it won't be valid */
|
|
15
17
|
required?: RequiredValidator;
|
|
@@ -4,7 +4,7 @@ import type { BooleanFieldAppearance, BooleanFieldValidators, BooleanFieldValue,
|
|
|
4
4
|
*/
|
|
5
5
|
type FieldAppearanceConfig<TAppearance> = TAppearance & Omit<RawFieldAttributes['appearance'], keyof TAppearance>;
|
|
6
6
|
/**
|
|
7
|
-
* Base field configuration for attributes (non-localized), extending the original
|
|
7
|
+
* Base field configuration for attributes (non-localized), extending the original RawApiTypes
|
|
8
8
|
*/
|
|
9
9
|
type NonLocalizedFieldAttributesForFieldType<SourceType, FieldType extends RawFieldAttributes['field_type'], FieldValue, FieldValidators, FieldAppearance> = Omit<SourceType, 'field_type' | 'default_value' | 'validators' | 'appearance' | 'localized'> & {
|
|
10
10
|
field_type: FieldType;
|
|
@@ -14,7 +14,7 @@ type NonLocalizedFieldAttributesForFieldType<SourceType, FieldType extends RawFi
|
|
|
14
14
|
appearance: FieldAppearanceConfig<FieldAppearance>;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
|
-
* Base field configuration for attributes (localized), extending the original
|
|
17
|
+
* Base field configuration for attributes (localized), extending the original RawApiTypes
|
|
18
18
|
*/
|
|
19
19
|
type LocalizedFieldAttributesForFieldType<SourceType, FieldType extends RawFieldAttributes['field_type'], FieldValue, FieldValidators, FieldAppearance> = Omit<SourceType, 'field_type' | 'default_value' | 'validators' | 'appearance' | 'localized'> & {
|
|
20
20
|
field_type: FieldType;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type LogLevel, request } from '@datocms/rest-client-utils';
|
|
2
|
-
import type { JobResult } from './
|
|
2
|
+
import type { JobResult } from './ApiTypes';
|
|
3
3
|
import * as Resources from './resources';
|
|
4
4
|
export type RequestOptions = {
|
|
5
5
|
method: 'GET' | 'PUT' | 'POST' | 'DELETE';
|