@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
|
@@ -2,19 +2,25 @@ import {
|
|
|
2
2
|
type Block,
|
|
3
3
|
type Document,
|
|
4
4
|
type InlineBlock,
|
|
5
|
-
type
|
|
5
|
+
type Node,
|
|
6
|
+
everyNode,
|
|
6
7
|
isBlock,
|
|
8
|
+
isDocument,
|
|
7
9
|
isInlineBlock,
|
|
8
|
-
isNode,
|
|
9
10
|
} from 'datocms-structured-text-utils';
|
|
10
|
-
import type * as
|
|
11
|
-
import {
|
|
11
|
+
import type * as RawApiTypes from '../generated/RawApiTypes';
|
|
12
|
+
import type { LocalizedFieldValue } from '../utilities/fieldValue';
|
|
13
|
+
import type { StructuredTextEditorConfiguration } from './appearance/structured_text';
|
|
12
14
|
import {
|
|
13
15
|
type BlockItemInARequest,
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
16
|
+
isItemId,
|
|
17
|
+
isItemWithOptionalIdAndMeta,
|
|
18
|
+
isItemWithOptionalMeta,
|
|
17
19
|
} from './single_block';
|
|
20
|
+
import type { LengthValidator } from './validators/length';
|
|
21
|
+
import type { StructuredTextBlocksValidator } from './validators/structured_text_blocks';
|
|
22
|
+
import type { StructuredTextInlineBlocksValidator } from './validators/structured_text_inline_blocks';
|
|
23
|
+
import type { StructuredTextLinksValidator } from './validators/structured_text_links';
|
|
18
24
|
|
|
19
25
|
/**
|
|
20
26
|
* STRUCTURED TEXT TYPE SYSTEM FOR DATOCMS
|
|
@@ -25,10 +31,10 @@ import {
|
|
|
25
31
|
* The challenge we're solving:
|
|
26
32
|
* - DatoCMS structured text can contain "blocks" (embedded content items) in bloth 'block'
|
|
27
33
|
* and 'inlineBlock' nodes
|
|
28
|
-
* - By default,
|
|
34
|
+
* - By default, CMA responses contain blocks as string IDs (lightweight references)
|
|
29
35
|
* - With ?nested=true parameter though, API responses contain blocks as full item objects
|
|
30
36
|
* (which in turn can contain other blocks)
|
|
31
|
-
* - For
|
|
37
|
+
* - For CMA requests, blocks can be represented as:
|
|
32
38
|
* 1. String IDs (referencing existing items)
|
|
33
39
|
* 2. Full item objects with IDs (for updates)
|
|
34
40
|
* 3. Item objects without IDs (for creation)
|
|
@@ -50,80 +56,42 @@ import {
|
|
|
50
56
|
/**
|
|
51
57
|
* Variant of 'block' structured text node for API requests
|
|
52
58
|
*/
|
|
53
|
-
export type BlockAsRequest =
|
|
54
|
-
item: BlockItemInARequest;
|
|
55
|
-
};
|
|
59
|
+
export type BlockAsRequest = Block<BlockItemInARequest>;
|
|
56
60
|
|
|
57
61
|
/**
|
|
58
62
|
* Variant of 'inlineBlock' structured text node for API requests
|
|
59
63
|
*/
|
|
60
|
-
export type InlineBlockAsRequest =
|
|
61
|
-
item: BlockItemInARequest;
|
|
62
|
-
};
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* 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
|
|
66
|
-
*/
|
|
67
|
-
export type NodeAsRequest<T> = WithMappedChildren<
|
|
68
|
-
T,
|
|
69
|
-
DeepMapVariants<
|
|
70
|
-
T extends { children: infer C } ? C : never,
|
|
71
|
-
BlockAsRequest,
|
|
72
|
-
InlineBlockAsRequest
|
|
73
|
-
>
|
|
74
|
-
>;
|
|
64
|
+
export type InlineBlockAsRequest = InlineBlock<BlockItemInARequest>;
|
|
75
65
|
|
|
76
66
|
/**
|
|
77
67
|
* Variant of Structured Text document for API requests
|
|
78
68
|
*/
|
|
79
|
-
export type DocumentAsRequest =
|
|
80
|
-
schema: 'dast';
|
|
81
|
-
document: NodeAsRequest<Root>;
|
|
82
|
-
};
|
|
69
|
+
export type DocumentAsRequest = Document<BlockItemInARequest>;
|
|
83
70
|
|
|
84
71
|
/**
|
|
85
72
|
* =============================================================================
|
|
86
73
|
* NESTED VARIANTS - Types for API responses with ?nested=true parameter
|
|
87
74
|
* =============================================================================
|
|
88
75
|
*
|
|
89
|
-
* When using the GET /items?nested=true, the
|
|
90
|
-
* with embedded blocks fully populated as complete
|
|
76
|
+
* When using the GET /items?nested=true, the CMA returns Structured Text documents
|
|
77
|
+
* with embedded blocks fully populated as complete RawApiTypes.Item objects instead
|
|
91
78
|
* of just string IDs.
|
|
92
79
|
*/
|
|
93
80
|
|
|
94
81
|
/**
|
|
95
82
|
* Variant of 'block' structured text node for ?nested=true API responses
|
|
96
83
|
*/
|
|
97
|
-
export type BlockWithNestedBlocks =
|
|
98
|
-
item: SchemaTypes.Item;
|
|
99
|
-
};
|
|
84
|
+
export type BlockWithNestedBlocks = Block<RawApiTypes.Item>;
|
|
100
85
|
|
|
101
86
|
/**
|
|
102
87
|
* Variant of 'inlineBlock' structured text node for ?nested=true API responses
|
|
103
88
|
*/
|
|
104
|
-
export type InlineBlockWithNestedBlocks =
|
|
105
|
-
item: SchemaTypes.Item;
|
|
106
|
-
};
|
|
107
|
-
|
|
108
|
-
/**
|
|
109
|
-
* 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
|
|
110
|
-
*/
|
|
111
|
-
export type NodeWithNestedBlocks<T> = WithMappedChildren<
|
|
112
|
-
T,
|
|
113
|
-
DeepMapVariants<
|
|
114
|
-
T extends { children: infer C } ? C : never,
|
|
115
|
-
BlockWithNestedBlocks,
|
|
116
|
-
InlineBlockWithNestedBlocks
|
|
117
|
-
>
|
|
118
|
-
>;
|
|
89
|
+
export type InlineBlockWithNestedBlocks = InlineBlock<RawApiTypes.Item>;
|
|
119
90
|
|
|
120
91
|
/**
|
|
121
92
|
* Variant of Structured Text document for ?nested=true API responses
|
|
122
93
|
*/
|
|
123
|
-
export type DocumentWithNestedBlocks =
|
|
124
|
-
schema: 'dast';
|
|
125
|
-
document: NodeWithNestedBlocks<Root>;
|
|
126
|
-
};
|
|
94
|
+
export type DocumentWithNestedBlocks = Document<RawApiTypes.Item>;
|
|
127
95
|
|
|
128
96
|
/**
|
|
129
97
|
* =============================================================================
|
|
@@ -140,43 +108,17 @@ export type StructuredTextFieldValueAsRequest = DocumentAsRequest | null;
|
|
|
140
108
|
export type StructuredTextFieldValueWithNestedBlocks =
|
|
141
109
|
DocumentWithNestedBlocks | null;
|
|
142
110
|
|
|
143
|
-
/**
|
|
144
|
-
* Helper function to validate if a value has the expected structured text document structure.
|
|
145
|
-
* Checks for the presence of 'schema' and 'document' properties on a non-null object.
|
|
146
|
-
*/
|
|
147
|
-
function isValidDocumentStructure(
|
|
148
|
-
value: unknown,
|
|
149
|
-
): value is { schema: unknown; document: unknown } {
|
|
150
|
-
return (
|
|
151
|
-
typeof value === 'object' &&
|
|
152
|
-
value !== null &&
|
|
153
|
-
'schema' in value &&
|
|
154
|
-
'document' in value
|
|
155
|
-
);
|
|
156
|
-
}
|
|
157
|
-
|
|
158
111
|
/**
|
|
159
112
|
* Utility function to validate all block/inlineBlock nodes in a structured text document tree.
|
|
160
113
|
* Calls the provided callback for each block/inlineBlock node found and returns true only if all pass.
|
|
161
114
|
*/
|
|
162
|
-
function validateAllBlockNodes(
|
|
163
|
-
node:
|
|
164
|
-
callback: (
|
|
165
|
-
node:
|
|
166
|
-
| Block
|
|
167
|
-
| BlockAsRequest
|
|
168
|
-
| BlockWithNestedBlocks
|
|
169
|
-
| InlineBlock
|
|
170
|
-
| InlineBlockAsRequest
|
|
171
|
-
| InlineBlockWithNestedBlocks,
|
|
172
|
-
) => boolean,
|
|
115
|
+
function validateAllBlockNodes<T>(
|
|
116
|
+
node: Node<T>,
|
|
117
|
+
callback: (node: Block<T> | InlineBlock<T>) => boolean,
|
|
173
118
|
): boolean {
|
|
174
119
|
return everyNode(node, (currentNode) => {
|
|
175
120
|
// If this is a block or inlineBlock node, validate it with the callback
|
|
176
|
-
if (
|
|
177
|
-
isNode(currentNode) &&
|
|
178
|
-
(isBlock(currentNode) || isInlineBlock(currentNode))
|
|
179
|
-
) {
|
|
121
|
+
if (isBlock<T>(currentNode) || isInlineBlock<T>(currentNode)) {
|
|
180
122
|
return callback(currentNode);
|
|
181
123
|
}
|
|
182
124
|
// For all other node types, they're valid by default
|
|
@@ -193,7 +135,7 @@ export function isStructuredTextFieldValue(
|
|
|
193
135
|
): value is StructuredTextFieldValue {
|
|
194
136
|
if (value === null) return true;
|
|
195
137
|
|
|
196
|
-
if (!
|
|
138
|
+
if (!isDocument<unknown>(value)) {
|
|
197
139
|
return false;
|
|
198
140
|
}
|
|
199
141
|
|
|
@@ -203,6 +145,16 @@ export function isStructuredTextFieldValue(
|
|
|
203
145
|
});
|
|
204
146
|
}
|
|
205
147
|
|
|
148
|
+
export function isLocalizedStructuredTextFieldValue(
|
|
149
|
+
value: unknown,
|
|
150
|
+
): value is LocalizedFieldValue<StructuredTextFieldValue> {
|
|
151
|
+
return (
|
|
152
|
+
typeof value === 'object' &&
|
|
153
|
+
value !== null &&
|
|
154
|
+
Object.values(value).every(isStructuredTextFieldValue)
|
|
155
|
+
);
|
|
156
|
+
}
|
|
157
|
+
|
|
206
158
|
/**
|
|
207
159
|
* Type guard for structured text field values in API request format.
|
|
208
160
|
* Allows blocks as string IDs, full objects with IDs, or objects without IDs.
|
|
@@ -212,7 +164,7 @@ export function isStructuredTextFieldValueAsRequest(
|
|
|
212
164
|
): value is StructuredTextFieldValueAsRequest {
|
|
213
165
|
if (value === null) return true;
|
|
214
166
|
|
|
215
|
-
if (!
|
|
167
|
+
if (!isDocument<unknown>(value)) {
|
|
216
168
|
return false;
|
|
217
169
|
}
|
|
218
170
|
|
|
@@ -221,23 +173,33 @@ export function isStructuredTextFieldValueAsRequest(
|
|
|
221
173
|
const item = node.item;
|
|
222
174
|
|
|
223
175
|
// String ID
|
|
224
|
-
if (
|
|
176
|
+
if (isItemId(item)) return true;
|
|
225
177
|
|
|
226
178
|
// Object (either with or without ID)
|
|
227
|
-
return
|
|
179
|
+
return isItemWithOptionalIdAndMeta(item);
|
|
228
180
|
});
|
|
229
181
|
}
|
|
230
182
|
|
|
183
|
+
export function isLocalizedStructuredTextFieldValueAsRequest(
|
|
184
|
+
value: unknown,
|
|
185
|
+
): value is LocalizedFieldValue<StructuredTextFieldValueAsRequest> {
|
|
186
|
+
return (
|
|
187
|
+
typeof value === 'object' &&
|
|
188
|
+
value !== null &&
|
|
189
|
+
Object.values(value).every(isStructuredTextFieldValueAsRequest)
|
|
190
|
+
);
|
|
191
|
+
}
|
|
192
|
+
|
|
231
193
|
/**
|
|
232
194
|
* Type guard for structured text field values with nested blocks (?nested=true format).
|
|
233
|
-
* Ensures all block/inlineBlock nodes have full
|
|
195
|
+
* Ensures all block/inlineBlock nodes have full RawApiTypes.Item objects.
|
|
234
196
|
*/
|
|
235
197
|
export function isStructuredTextFieldValueWithNestedBlocks(
|
|
236
198
|
value: unknown,
|
|
237
199
|
): value is StructuredTextFieldValueWithNestedBlocks {
|
|
238
200
|
if (value === null) return true;
|
|
239
201
|
|
|
240
|
-
if (!
|
|
202
|
+
if (!isDocument<unknown>(value)) {
|
|
241
203
|
return false;
|
|
242
204
|
}
|
|
243
205
|
|
|
@@ -246,66 +208,19 @@ export function isStructuredTextFieldValueWithNestedBlocks(
|
|
|
246
208
|
const item = node.item;
|
|
247
209
|
|
|
248
210
|
// Must be a full object with ID (nested format always includes full items)
|
|
249
|
-
return
|
|
211
|
+
return isItemWithOptionalMeta(item);
|
|
250
212
|
});
|
|
251
213
|
}
|
|
252
214
|
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
*/
|
|
263
|
-
|
|
264
|
-
/**
|
|
265
|
-
* Utility type that preserves the structure of T but replaces its children with ChildrenType.
|
|
266
|
-
* If T doesn't have children, it returns T unchanged.
|
|
267
|
-
*/
|
|
268
|
-
type WithMappedChildren<T, ChildrenType> = T extends { children: any }
|
|
269
|
-
? Omit<T, 'children'> & { children: ChildrenType }
|
|
270
|
-
: T;
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* Generic transformation type that replace 'block' and 'inlineBlock' node types to their variants.
|
|
274
|
-
*/
|
|
275
|
-
type MapVariants<T, BlockVariant, InlineBlockVariant> = T extends Block
|
|
276
|
-
? BlockVariant
|
|
277
|
-
: T extends InlineBlock
|
|
278
|
-
? InlineBlockVariant
|
|
279
|
-
: T;
|
|
280
|
-
|
|
281
|
-
/**
|
|
282
|
-
* Recursively transform a Structured Text node type using the provided variants for 'block' and 'inlineBlock' nodes.
|
|
283
|
-
*
|
|
284
|
-
* This handles three cases:
|
|
285
|
-
* _ Arrays: Transform each array element recursively
|
|
286
|
-
* _ Objects with children: Transform the object itself AND recursively transform its children
|
|
287
|
-
* _ Leaf nodes: Apply the variant mapping
|
|
288
|
-
*/
|
|
289
|
-
type DeepMapVariants<T, BlockVariant, InlineBlockVariant> =
|
|
290
|
-
T extends (infer U)[]
|
|
291
|
-
? DeepMapVariants<U, BlockVariant, InlineBlockVariant>[]
|
|
292
|
-
: T extends { children: infer Children }
|
|
293
|
-
? T extends { children: any }
|
|
294
|
-
? Omit<T, 'children'> & {
|
|
295
|
-
children: DeepMapVariants<
|
|
296
|
-
Children,
|
|
297
|
-
BlockVariant,
|
|
298
|
-
InlineBlockVariant
|
|
299
|
-
>;
|
|
300
|
-
}
|
|
301
|
-
: MapVariants<T, BlockVariant, InlineBlockVariant>
|
|
302
|
-
: MapVariants<T, BlockVariant, InlineBlockVariant>;
|
|
303
|
-
|
|
304
|
-
import type { StructuredTextEditorConfiguration } from './appearance/structured_text';
|
|
305
|
-
import type { LengthValidator } from './validators/length';
|
|
306
|
-
import type { StructuredTextBlocksValidator } from './validators/structured_text_blocks';
|
|
307
|
-
import type { StructuredTextInlineBlocksValidator } from './validators/structured_text_inline_blocks';
|
|
308
|
-
import type { StructuredTextLinksValidator } from './validators/structured_text_links';
|
|
215
|
+
export function isLocalizedStructuredTextFieldValueWithNestedBlocks(
|
|
216
|
+
value: unknown,
|
|
217
|
+
): value is LocalizedFieldValue<StructuredTextFieldValueWithNestedBlocks> {
|
|
218
|
+
return (
|
|
219
|
+
typeof value === 'object' &&
|
|
220
|
+
value !== null &&
|
|
221
|
+
Object.values(value).every(isStructuredTextFieldValueWithNestedBlocks)
|
|
222
|
+
);
|
|
223
|
+
}
|
|
309
224
|
|
|
310
225
|
export type StructuredTextFieldValidators = {
|
|
311
226
|
/** Only accept references to block records of the specified block models */
|
package/src/fieldTypes/text.ts
CHANGED
|
@@ -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';
|
|
@@ -12,6 +13,16 @@ export function isTextFieldValue(value: unknown): value is TextFieldValue {
|
|
|
12
13
|
return typeof value === 'string' || value === null;
|
|
13
14
|
}
|
|
14
15
|
|
|
16
|
+
export function isLocalizedTextFieldValue(
|
|
17
|
+
value: unknown,
|
|
18
|
+
): value is LocalizedFieldValue<TextFieldValue> {
|
|
19
|
+
return (
|
|
20
|
+
typeof value === 'object' &&
|
|
21
|
+
value !== null &&
|
|
22
|
+
Object.values(value).every(isTextFieldValue)
|
|
23
|
+
);
|
|
24
|
+
}
|
|
25
|
+
|
|
15
26
|
export type TextFieldValidators = {
|
|
16
27
|
/** Value must be specified or it won't be valid */
|
|
17
28
|
required?: RequiredValidator;
|
package/src/fieldTypes/video.ts
CHANGED
|
@@ -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
|
|
|
@@ -22,6 +23,16 @@ export function isVideoFieldValue(value: unknown): value is VideoFieldValue {
|
|
|
22
23
|
);
|
|
23
24
|
}
|
|
24
25
|
|
|
26
|
+
export function isLocalizedVideoFieldValue(
|
|
27
|
+
value: unknown,
|
|
28
|
+
): value is LocalizedFieldValue<VideoFieldValue> {
|
|
29
|
+
return (
|
|
30
|
+
typeof value === 'object' &&
|
|
31
|
+
value !== null &&
|
|
32
|
+
Object.values(value).every(isVideoFieldValue)
|
|
33
|
+
);
|
|
34
|
+
}
|
|
35
|
+
|
|
25
36
|
export type VideoFieldValidators = {
|
|
26
37
|
/** Value must be specified or it won't be valid */
|
|
27
38
|
required?: RequiredValidator;
|
|
@@ -58,7 +58,7 @@ type FieldAppearanceConfig<TAppearance> = TAppearance &
|
|
|
58
58
|
Omit<RawFieldAttributes['appearance'], keyof TAppearance>;
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* Base field configuration for attributes (non-localized), extending the original
|
|
61
|
+
* Base field configuration for attributes (non-localized), extending the original RawApiTypes
|
|
62
62
|
*/
|
|
63
63
|
type NonLocalizedFieldAttributesForFieldType<
|
|
64
64
|
SourceType,
|
|
@@ -78,7 +78,7 @@ type NonLocalizedFieldAttributesForFieldType<
|
|
|
78
78
|
};
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
|
-
* Base field configuration for attributes (localized), extending the original
|
|
81
|
+
* Base field configuration for attributes (localized), extending the original RawApiTypes
|
|
82
82
|
*/
|
|
83
83
|
type LocalizedFieldAttributesForFieldType<
|
|
84
84
|
SourceType,
|
package/src/generated/Client.ts
CHANGED
|
@@ -3,7 +3,7 @@ import {
|
|
|
3
3
|
pollJobResult,
|
|
4
4
|
request,
|
|
5
5
|
} from '@datocms/rest-client-utils';
|
|
6
|
-
import type { JobResult } from './
|
|
6
|
+
import type { JobResult } from './ApiTypes';
|
|
7
7
|
import * as Resources from './resources';
|
|
8
8
|
|
|
9
9
|
export type RequestOptions = {
|
|
@@ -147,7 +147,7 @@ export class Client {
|
|
|
147
147
|
...this.config,
|
|
148
148
|
...options,
|
|
149
149
|
logFn: this.config.logFn || console.log,
|
|
150
|
-
userAgent: '@datocms/cma-client v5.1.
|
|
150
|
+
userAgent: '@datocms/cma-client v5.1.3',
|
|
151
151
|
baseUrl: this.baseUrl,
|
|
152
152
|
preCallStack: new Error().stack,
|
|
153
153
|
extraHeaders: {
|
|
@@ -58,7 +58,7 @@ type FieldAppearanceConfig<TAppearance> = TAppearance &
|
|
|
58
58
|
Omit<RawFieldAttributes['appearance'], keyof TAppearance>;
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* Base field configuration for attributes (non-localized), extending the original
|
|
61
|
+
* Base field configuration for attributes (non-localized), extending the original RawApiTypes
|
|
62
62
|
*/
|
|
63
63
|
type NonLocalizedFieldAttributesForFieldType<
|
|
64
64
|
SourceType,
|
|
@@ -78,7 +78,7 @@ type NonLocalizedFieldAttributesForFieldType<
|
|
|
78
78
|
};
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
|
-
* Base field configuration for attributes (localized), extending the original
|
|
81
|
+
* Base field configuration for attributes (localized), extending the original RawApiTypes
|
|
82
82
|
*/
|
|
83
83
|
type LocalizedFieldAttributesForFieldType<
|
|
84
84
|
SourceType,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as Utils from '@datocms/rest-client-utils';
|
|
2
2
|
import BaseResource from '../../BaseResource';
|
|
3
|
-
import type * as
|
|
4
|
-
import type * as
|
|
3
|
+
import type * as ApiTypes from '../ApiTypes';
|
|
4
|
+
import type * as RawApiTypes from '../RawApiTypes';
|
|
5
5
|
|
|
6
6
|
export default class AccessToken extends BaseResource {
|
|
7
7
|
static readonly TYPE = 'access_token' as const;
|
|
@@ -14,9 +14,9 @@ export default class AccessToken extends BaseResource {
|
|
|
14
14
|
* @throws {ApiError}
|
|
15
15
|
* @throws {TimeoutError}
|
|
16
16
|
*/
|
|
17
|
-
create(body:
|
|
17
|
+
create(body: ApiTypes.AccessTokenCreateSchema) {
|
|
18
18
|
return this.rawCreate(
|
|
19
|
-
Utils.serializeRequestBody<
|
|
19
|
+
Utils.serializeRequestBody<RawApiTypes.AccessTokenCreateSchema>(body, {
|
|
20
20
|
type: 'access_token',
|
|
21
21
|
attributes: [
|
|
22
22
|
'name',
|
|
@@ -27,7 +27,7 @@ export default class AccessToken extends BaseResource {
|
|
|
27
27
|
relationships: ['role'],
|
|
28
28
|
}),
|
|
29
29
|
).then((body) =>
|
|
30
|
-
Utils.deserializeResponseBody<
|
|
30
|
+
Utils.deserializeResponseBody<ApiTypes.AccessTokenCreateTargetSchema>(
|
|
31
31
|
body,
|
|
32
32
|
),
|
|
33
33
|
);
|
|
@@ -42,9 +42,9 @@ export default class AccessToken extends BaseResource {
|
|
|
42
42
|
* @throws {TimeoutError}
|
|
43
43
|
*/
|
|
44
44
|
rawCreate(
|
|
45
|
-
body:
|
|
46
|
-
): Promise<
|
|
47
|
-
return this.client.request<
|
|
45
|
+
body: RawApiTypes.AccessTokenCreateSchema,
|
|
46
|
+
): Promise<RawApiTypes.AccessTokenCreateTargetSchema> {
|
|
47
|
+
return this.client.request<RawApiTypes.AccessTokenCreateTargetSchema>({
|
|
48
48
|
method: 'POST',
|
|
49
49
|
url: '/access_tokens',
|
|
50
50
|
body,
|
|
@@ -60,12 +60,12 @@ export default class AccessToken extends BaseResource {
|
|
|
60
60
|
* @throws {TimeoutError}
|
|
61
61
|
*/
|
|
62
62
|
update(
|
|
63
|
-
accessTokenId: string |
|
|
64
|
-
body:
|
|
63
|
+
accessTokenId: string | ApiTypes.AccessTokenData,
|
|
64
|
+
body: ApiTypes.AccessTokenUpdateSchema,
|
|
65
65
|
) {
|
|
66
66
|
return this.rawUpdate(
|
|
67
67
|
Utils.toId(accessTokenId),
|
|
68
|
-
Utils.serializeRequestBody<
|
|
68
|
+
Utils.serializeRequestBody<RawApiTypes.AccessTokenUpdateSchema>(body, {
|
|
69
69
|
id: Utils.toId(accessTokenId),
|
|
70
70
|
type: 'access_token',
|
|
71
71
|
attributes: [
|
|
@@ -77,7 +77,7 @@ export default class AccessToken extends BaseResource {
|
|
|
77
77
|
relationships: ['role'],
|
|
78
78
|
}),
|
|
79
79
|
).then((body) =>
|
|
80
|
-
Utils.deserializeResponseBody<
|
|
80
|
+
Utils.deserializeResponseBody<ApiTypes.AccessTokenUpdateTargetSchema>(
|
|
81
81
|
body,
|
|
82
82
|
),
|
|
83
83
|
);
|
|
@@ -93,9 +93,9 @@ export default class AccessToken extends BaseResource {
|
|
|
93
93
|
*/
|
|
94
94
|
rawUpdate(
|
|
95
95
|
accessTokenId: string,
|
|
96
|
-
body:
|
|
97
|
-
): Promise<
|
|
98
|
-
return this.client.request<
|
|
96
|
+
body: RawApiTypes.AccessTokenUpdateSchema,
|
|
97
|
+
): Promise<RawApiTypes.AccessTokenUpdateTargetSchema> {
|
|
98
|
+
return this.client.request<RawApiTypes.AccessTokenUpdateTargetSchema>({
|
|
99
99
|
method: 'PUT',
|
|
100
100
|
url: `/access_tokens/${accessTokenId}`,
|
|
101
101
|
body,
|
|
@@ -112,7 +112,7 @@ export default class AccessToken extends BaseResource {
|
|
|
112
112
|
*/
|
|
113
113
|
list() {
|
|
114
114
|
return this.rawList().then((body) =>
|
|
115
|
-
Utils.deserializeResponseBody<
|
|
115
|
+
Utils.deserializeResponseBody<ApiTypes.AccessTokenInstancesTargetSchema>(
|
|
116
116
|
body,
|
|
117
117
|
),
|
|
118
118
|
);
|
|
@@ -126,8 +126,8 @@ export default class AccessToken extends BaseResource {
|
|
|
126
126
|
* @throws {ApiError}
|
|
127
127
|
* @throws {TimeoutError}
|
|
128
128
|
*/
|
|
129
|
-
rawList(): Promise<
|
|
130
|
-
return this.client.request<
|
|
129
|
+
rawList(): Promise<RawApiTypes.AccessTokenInstancesTargetSchema> {
|
|
130
|
+
return this.client.request<RawApiTypes.AccessTokenInstancesTargetSchema>({
|
|
131
131
|
method: 'GET',
|
|
132
132
|
url: '/access_tokens',
|
|
133
133
|
});
|
|
@@ -141,11 +141,9 @@ export default class AccessToken extends BaseResource {
|
|
|
141
141
|
* @throws {ApiError}
|
|
142
142
|
* @throws {TimeoutError}
|
|
143
143
|
*/
|
|
144
|
-
find(accessTokenId: string |
|
|
144
|
+
find(accessTokenId: string | ApiTypes.AccessTokenData) {
|
|
145
145
|
return this.rawFind(Utils.toId(accessTokenId)).then((body) =>
|
|
146
|
-
Utils.deserializeResponseBody<
|
|
147
|
-
body,
|
|
148
|
-
),
|
|
146
|
+
Utils.deserializeResponseBody<ApiTypes.AccessTokenSelfTargetSchema>(body),
|
|
149
147
|
);
|
|
150
148
|
}
|
|
151
149
|
|
|
@@ -159,8 +157,8 @@ export default class AccessToken extends BaseResource {
|
|
|
159
157
|
*/
|
|
160
158
|
rawFind(
|
|
161
159
|
accessTokenId: string,
|
|
162
|
-
): Promise<
|
|
163
|
-
return this.client.request<
|
|
160
|
+
): Promise<RawApiTypes.AccessTokenSelfTargetSchema> {
|
|
161
|
+
return this.client.request<RawApiTypes.AccessTokenSelfTargetSchema>({
|
|
164
162
|
method: 'GET',
|
|
165
163
|
url: `/access_tokens/${accessTokenId}`,
|
|
166
164
|
});
|
|
@@ -174,9 +172,9 @@ export default class AccessToken extends BaseResource {
|
|
|
174
172
|
* @throws {ApiError}
|
|
175
173
|
* @throws {TimeoutError}
|
|
176
174
|
*/
|
|
177
|
-
regenerateToken(accessTokenId: string |
|
|
175
|
+
regenerateToken(accessTokenId: string | ApiTypes.AccessTokenData) {
|
|
178
176
|
return this.rawRegenerateToken(Utils.toId(accessTokenId)).then((body) =>
|
|
179
|
-
Utils.deserializeResponseBody<
|
|
177
|
+
Utils.deserializeResponseBody<ApiTypes.AccessTokenRegenerateTokenTargetSchema>(
|
|
180
178
|
body,
|
|
181
179
|
),
|
|
182
180
|
);
|
|
@@ -192,8 +190,8 @@ export default class AccessToken extends BaseResource {
|
|
|
192
190
|
*/
|
|
193
191
|
rawRegenerateToken(
|
|
194
192
|
accessTokenId: string,
|
|
195
|
-
): Promise<
|
|
196
|
-
return this.client.request<
|
|
193
|
+
): Promise<RawApiTypes.AccessTokenRegenerateTokenTargetSchema> {
|
|
194
|
+
return this.client.request<RawApiTypes.AccessTokenRegenerateTokenTargetSchema>(
|
|
197
195
|
{
|
|
198
196
|
method: 'POST',
|
|
199
197
|
url: `/access_tokens/${accessTokenId}/regenerate_token`,
|
|
@@ -210,12 +208,12 @@ export default class AccessToken extends BaseResource {
|
|
|
210
208
|
* @throws {TimeoutError}
|
|
211
209
|
*/
|
|
212
210
|
destroy(
|
|
213
|
-
accessTokenId: string |
|
|
214
|
-
queryParams?:
|
|
211
|
+
accessTokenId: string | ApiTypes.AccessTokenData,
|
|
212
|
+
queryParams?: ApiTypes.AccessTokenDestroyHrefSchema,
|
|
215
213
|
) {
|
|
216
214
|
return this.rawDestroy(Utils.toId(accessTokenId), queryParams).then(
|
|
217
215
|
(body) =>
|
|
218
|
-
Utils.deserializeResponseBody<
|
|
216
|
+
Utils.deserializeResponseBody<ApiTypes.AccessTokenDestroyTargetSchema>(
|
|
219
217
|
body,
|
|
220
218
|
),
|
|
221
219
|
);
|
|
@@ -231,9 +229,9 @@ export default class AccessToken extends BaseResource {
|
|
|
231
229
|
*/
|
|
232
230
|
rawDestroy(
|
|
233
231
|
accessTokenId: string,
|
|
234
|
-
queryParams?:
|
|
235
|
-
): Promise<
|
|
236
|
-
return this.client.request<
|
|
232
|
+
queryParams?: RawApiTypes.AccessTokenDestroyHrefSchema,
|
|
233
|
+
): Promise<RawApiTypes.AccessTokenDestroyTargetSchema> {
|
|
234
|
+
return this.client.request<RawApiTypes.AccessTokenDestroyTargetSchema>({
|
|
237
235
|
method: 'DELETE',
|
|
238
236
|
url: `/access_tokens/${accessTokenId}`,
|
|
239
237
|
queryParams,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as Utils from '@datocms/rest-client-utils';
|
|
2
2
|
import BaseResource from '../../BaseResource';
|
|
3
|
-
import type * as
|
|
4
|
-
import type * as
|
|
3
|
+
import type * as ApiTypes from '../ApiTypes';
|
|
4
|
+
import type * as RawApiTypes from '../RawApiTypes';
|
|
5
5
|
|
|
6
6
|
export default class AuditLogEvent extends BaseResource {
|
|
7
7
|
static readonly TYPE = 'audit_log_event' as const;
|
|
@@ -14,15 +14,15 @@ export default class AuditLogEvent extends BaseResource {
|
|
|
14
14
|
* @throws {ApiError}
|
|
15
15
|
* @throws {TimeoutError}
|
|
16
16
|
*/
|
|
17
|
-
query(body:
|
|
17
|
+
query(body: ApiTypes.AuditLogEventQuerySchema) {
|
|
18
18
|
return this.rawQuery(
|
|
19
|
-
Utils.serializeRequestBody<
|
|
19
|
+
Utils.serializeRequestBody<RawApiTypes.AuditLogEventQuerySchema>(body, {
|
|
20
20
|
type: 'audit_log_query',
|
|
21
21
|
attributes: ['filter', 'next_token', 'detailed_log'],
|
|
22
22
|
relationships: [],
|
|
23
23
|
}),
|
|
24
24
|
).then((body) =>
|
|
25
|
-
Utils.deserializeResponseBody<
|
|
25
|
+
Utils.deserializeResponseBody<ApiTypes.AuditLogEventQueryTargetSchema>(
|
|
26
26
|
body,
|
|
27
27
|
),
|
|
28
28
|
);
|
|
@@ -37,9 +37,9 @@ export default class AuditLogEvent extends BaseResource {
|
|
|
37
37
|
* @throws {TimeoutError}
|
|
38
38
|
*/
|
|
39
39
|
rawQuery(
|
|
40
|
-
body:
|
|
41
|
-
): Promise<
|
|
42
|
-
return this.client.request<
|
|
40
|
+
body: RawApiTypes.AuditLogEventQuerySchema,
|
|
41
|
+
): Promise<RawApiTypes.AuditLogEventQueryTargetSchema> {
|
|
42
|
+
return this.client.request<RawApiTypes.AuditLogEventQueryTargetSchema>({
|
|
43
43
|
method: 'POST',
|
|
44
44
|
url: '/audit-log-events/query',
|
|
45
45
|
body,
|