@datocms/cma-client 5.2.0-alpha.1 → 5.2.0-alpha.3

package/src/generated/resources/BuildTrigger.ts

@@ -87,6 +87,7 @@ export default class BuildTrigger extends BaseResource {
           'webhook_token',
           'adapter',
           'indexing_enabled',
+          'enabled',
           'frontend_url',
           'autotrigger_on_scheduled_publications',
           'adapter_settings',
@@ -139,6 +140,7 @@ export default class BuildTrigger extends BaseResource {
           'name',
           'adapter',
           'indexing_enabled',
+          'enabled',
           'frontend_url',
           'autotrigger_on_scheduled_publications',
           'adapter_settings',

package/src/generated/resources/Field.ts

@@ -147,14 +147,12 @@ export default class Field extends BaseResource {
   }
 
   /**
-   * List referenced fields
+   * List fields referencing a model/block
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
-   *
-   * @deprecated This API call is to be considered private and might change without notice
    */
   referencing(itemTypeId: string | ApiTypes.ItemTypeData) {
     return this.rawReferencing(Utils.toId(itemTypeId)).then((body) =>
@@ -165,14 +163,12 @@ export default class Field extends BaseResource {
   }
 
   /**
-   * List referenced fields
+   * List fields referencing a model/block
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
-   *
-   * @deprecated This API call is to be considered private and might change without notice
    */
   rawReferencing(
     itemTypeId: string,

package/src/generated/resources/ItemType.ts

@@ -272,6 +272,39 @@ export default class ItemType extends BaseResource {
     });
   }
 
+  /**
+   * List models referencing another model/block
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/referencing
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  referencing(itemTypeId: string | ApiTypes.ItemTypeData) {
+    return this.rawReferencing(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.ItemTypeReferencingTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List models referencing another model/block
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/referencing
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawReferencing(
+    itemTypeId: string,
+  ): Promise<RawApiTypes.ItemTypeReferencingTargetSchema> {
+    return this.client.request<RawApiTypes.ItemTypeReferencingTargetSchema>({
+      method: 'GET',
+      url: `/item-types/${itemTypeId}/referencing`,
+    });
+  }
+
   /**
    * Reorders a set of fields and fieldsets within the model
    *

package/src/generated/resources/ItemVersion.ts

@@ -141,8 +141,11 @@ export default class ItemVersion extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  find(itemVersionId: string | ApiTypes.ItemVersionData) {
-    return this.rawFind(Utils.toId(itemVersionId)).then((body) =>
+  find(
+    itemVersionId: string | ApiTypes.ItemVersionData,
+    queryParams?: ApiTypes.ItemVersionSelfHrefSchema,
+  ) {
+    return this.rawFind(Utils.toId(itemVersionId), queryParams).then((body) =>
       Utils.deserializeResponseBody<ApiTypes.ItemVersionSelfTargetSchema>(body),
     );
   }
@@ -157,10 +160,12 @@ export default class ItemVersion extends BaseResource {
    */
   rawFind(
     itemVersionId: string,
+    queryParams?: RawApiTypes.ItemVersionSelfHrefSchema,
   ): Promise<RawApiTypes.ItemVersionSelfTargetSchema> {
     return this.client.request<RawApiTypes.ItemVersionSelfTargetSchema>({
       method: 'GET',
       url: `/versions/${itemVersionId}`,
+      queryParams,
     });
   }
 }

package/src/generated/resources/Role.ts

@@ -29,6 +29,7 @@ export default class Role extends BaseResource {
           'environments_access',
           'can_manage_users',
           'can_manage_shared_filters',
+          'can_manage_site_search_sources',
           'can_manage_upload_collections',
           'can_manage_build_triggers',
           'can_manage_webhooks',
@@ -39,12 +40,15 @@ export default class Role extends BaseResource {
           'can_manage_access_tokens',
           'can_perform_site_search',
           'can_access_build_events_log',
+          'can_access_site_search_source_events_log',
           'positive_item_type_permissions',
           'negative_item_type_permissions',
           'positive_upload_permissions',
           'negative_upload_permissions',
           'positive_build_trigger_permissions',
           'negative_build_trigger_permissions',
+          'positive_site_search_source_permissions',
+          'negative_site_search_source_permissions',
         ],
         relationships: ['inherits_permissions_from'],
       }),
@@ -96,6 +100,7 @@ export default class Role extends BaseResource {
           'environments_access',
           'can_manage_users',
           'can_manage_shared_filters',
+          'can_manage_site_search_sources',
           'can_manage_upload_collections',
           'can_manage_build_triggers',
           'can_manage_webhooks',
@@ -106,12 +111,15 @@ export default class Role extends BaseResource {
           'can_manage_access_tokens',
           'can_perform_site_search',
           'can_access_build_events_log',
+          'can_access_site_search_source_events_log',
           'positive_item_type_permissions',
           'negative_item_type_permissions',
           'positive_upload_permissions',
           'negative_upload_permissions',
           'positive_build_trigger_permissions',
           'negative_build_trigger_permissions',
+          'positive_site_search_source_permissions',
+          'negative_site_search_source_permissions',
         ],
         relationships: ['inherits_permissions_from'],
       }),

package/src/generated/resources/SiteSearchSource.ts

@@ -0,0 +1,267 @@
+import * as Utils from '@datocms/rest-client-utils';
+import BaseResource from '../../BaseResource';
+import type * as ApiTypes from '../ApiTypes';
+import type * as RawApiTypes from '../RawApiTypes';
+
+export default class SiteSearchSource extends BaseResource {
+  static readonly TYPE = 'site_search_source' as const;
+
+  /**
+   * List all site search sources for a site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all site search sources for a site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawList(): Promise<RawApiTypes.SiteSearchSourceInstancesTargetSchema> {
+    return this.client.request<RawApiTypes.SiteSearchSourceInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: '/site-search-sources',
+      },
+    );
+  }
+
+  /**
+   * Retrieve a site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  find(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData) {
+    return this.rawFind(Utils.toId(siteSearchSourceId)).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawFind(
+    siteSearchSourceId: string,
+  ): Promise<RawApiTypes.SiteSearchSourceSelfTargetSchema> {
+    return this.client.request<RawApiTypes.SiteSearchSourceSelfTargetSchema>({
+      method: 'GET',
+      url: `/site-search-sources/${siteSearchSourceId}`,
+    });
+  }
+
+  /**
+   * Create site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  create(body: ApiTypes.SiteSearchSourceCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<RawApiTypes.SiteSearchSourceCreateSchema>(
+        body,
+        {
+          type: 'site_search_source',
+          attributes: [
+            'name',
+            'enabled',
+            'build_trigger_indexing_enabled',
+            'frontend_url',
+            'user_agent_suffix',
+          ],
+          relationships: ['build_triggers'],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawCreate(
+    body: RawApiTypes.SiteSearchSourceCreateSchema,
+  ): Promise<RawApiTypes.SiteSearchSourceCreateTargetSchema> {
+    return this.client.request<RawApiTypes.SiteSearchSourceCreateTargetSchema>({
+      method: 'POST',
+      url: '/site-search-sources',
+      body,
+    });
+  }
+
+  /**
+   * Update site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  update(
+    siteSearchSourceId: string | ApiTypes.SiteSearchSourceData,
+    body: ApiTypes.SiteSearchSourceUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(siteSearchSourceId),
+      Utils.serializeRequestBody<RawApiTypes.SiteSearchSourceUpdateSchema>(
+        body,
+        {
+          id: Utils.toId(siteSearchSourceId),
+          type: 'site_search_source',
+          attributes: [
+            'name',
+            'enabled',
+            'build_trigger_indexing_enabled',
+            'frontend_url',
+            'user_agent_suffix',
+          ],
+          relationships: ['build_triggers'],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawUpdate(
+    siteSearchSourceId: string,
+    body: RawApiTypes.SiteSearchSourceUpdateSchema,
+  ): Promise<RawApiTypes.SiteSearchSourceUpdateTargetSchema> {
+    return this.client.request<RawApiTypes.SiteSearchSourceUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/site-search-sources/${siteSearchSourceId}`,
+      body,
+    });
+  }
+
+  /**
+   * Trigger a site search indexing
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  trigger(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData) {
+    return this.rawTrigger(Utils.toId(siteSearchSourceId));
+  }
+
+  /**
+   * Trigger a site search indexing
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawTrigger(siteSearchSourceId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'POST',
+      url: `/site-search-sources/${siteSearchSourceId}/trigger`,
+    });
+  }
+
+  /**
+   * Abort a site search spidering and mark it as failed
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  abort(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData) {
+    return this.rawAbort(Utils.toId(siteSearchSourceId));
+  }
+
+  /**
+   * Abort a site search spidering and mark it as failed
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawAbort(siteSearchSourceId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'DELETE',
+      url: `/site-search-sources/${siteSearchSourceId}/abort`,
+    });
+  }
+
+  /**
+   * Delete a site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  destroy(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData) {
+    return this.rawDestroy(Utils.toId(siteSearchSourceId)).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a site search source
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawDestroy(
+    siteSearchSourceId: string,
+  ): Promise<RawApiTypes.SiteSearchSourceDestroyTargetSchema> {
+    return this.client.request<RawApiTypes.SiteSearchSourceDestroyTargetSchema>(
+      {
+        method: 'DELETE',
+        url: `/site-search-sources/${siteSearchSourceId}`,
+      },
+    );
+  }
+}

package/src/generated/resources/SiteSearchSourceEvent.ts

@@ -0,0 +1,134 @@
+import * as Utils from '@datocms/rest-client-utils';
+import BaseResource from '../../BaseResource';
+import type * as ApiTypes from '../ApiTypes';
+import type * as RawApiTypes from '../RawApiTypes';
+
+export default class SiteSearchSourceEvent extends BaseResource {
+  static readonly TYPE = 'site_search_source_event' as const;
+
+  /**
+   * List all site search indexing events
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  list(queryParams?: ApiTypes.SiteSearchSourceEventInstancesHrefSchema) {
+    return this.rawList(queryParams).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceEventInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all site search indexing events
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawList(
+    queryParams?: RawApiTypes.SiteSearchSourceEventInstancesHrefSchema,
+  ): Promise<RawApiTypes.SiteSearchSourceEventInstancesTargetSchema> {
+    return this.client.request<RawApiTypes.SiteSearchSourceEventInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: '/site-search-source-events',
+        queryParams,
+      },
+    );
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  async *listPagedIterator(
+    queryParams?: Utils.OmitFromKnownKeys<
+      ApiTypes.SiteSearchSourceEventInstancesHrefSchema,
+      'page'
+    >,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        ApiTypes.SiteSearchSourceEventInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by rawList()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawListPagedIterator(
+    queryParams?: Utils.OmitFromKnownKeys<
+      RawApiTypes.SiteSearchSourceEventInstancesHrefSchema,
+      'page'
+    >,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    Utils.warnOnPageQueryParam(queryParams);
+
+    return Utils.rawPageIterator<
+      RawApiTypes.SiteSearchSourceEventInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 30,
+        maxLimit: 500,
+      },
+      (page: RawApiTypes.SiteSearchSourceEventInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
+
+  /**
+   * Retrieve a site search indexing event
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  find(siteSearchSourceEventId: string | ApiTypes.SiteSearchSourceEventData) {
+    return this.rawFind(Utils.toId(siteSearchSourceEventId)).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceEventSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a site search indexing event
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawFind(
+    siteSearchSourceEventId: string,
+  ): Promise<RawApiTypes.SiteSearchSourceEventSelfTargetSchema> {
+    return this.client.request<RawApiTypes.SiteSearchSourceEventSelfTargetSchema>(
+      {
+        method: 'GET',
+        url: `/site-search-source-events/${siteSearchSourceEventId}`,
+      },
+    );
+  }
+}

package/src/generated/resources/UploadRequest.ts

@@ -19,7 +19,7 @@ export default class UploadRequest extends BaseResource {
       Utils.serializeRequestBody<RawApiTypes.UploadRequestCreateSchema>(body, {
         type: 'upload_request',
         attributes: ['filename'],
-        relationships: ['upload_collection'],
+        relationships: [],
       }),
     ).then((body) =>
       Utils.deserializeResponseBody<ApiTypes.UploadRequestCreateTargetSchema>(

package/src/generated/resources/index.ts

@@ -15,6 +15,7 @@ export { default as JobResult } from './JobResult';
 export { default as SubscriptionLimit } from './SubscriptionLimit';
 export { default as SubscriptionFeature } from './SubscriptionFeature';
 export { default as BuildEvent } from './BuildEvent';
+export { default as SiteSearchSourceEvent } from './SiteSearchSourceEvent';
 export { default as Item } from './Item';
 export { default as ItemVersion } from './ItemVersion';
 export { default as Upload } from './Upload';
@@ -28,6 +29,7 @@ export { default as MaintenanceMode } from './MaintenanceMode';
 export { default as Webhook } from './Webhook';
 export { default as WebhookCall } from './WebhookCall';
 export { default as BuildTrigger } from './BuildTrigger';
+export { default as SiteSearchSource } from './SiteSearchSource';
 export { default as ItemTypeFilter } from './ItemTypeFilter';
 export { default as UploadFilter } from './UploadFilter';
 export { default as SiteInvitation } from './SiteInvitation';

package/src/utilities/buildBlockRecord.ts

@@ -9,10 +9,9 @@ import type {
 
 type NoInfer<T> = [T][T extends any ? 0 : never];
 
-type UpdateOrCreateBlockRecordSchema<
+type CreateBlockRecordSchema<
   D extends ItemTypeDefinition = ItemTypeDefinition,
 > = {
-  id?: ApiTypes.ItemIdentity;
   type?: ApiTypes.ItemType1;
   item_type: ApiTypes.ItemTypeData<D>;
   meta?: ApiTypes.ItemUpdateSchema['meta'];
@@ -20,10 +19,23 @@ type UpdateOrCreateBlockRecordSchema<
   __itemTypeId?: D['itemTypeId'];
 } & ToItemAttributesInRequest<D>;
 
+type UpdateBlockRecordSchema<
+  D extends ItemTypeDefinition = ItemTypeDefinition,
+> = {
+  id: ApiTypes.ItemIdentity;
+  type?: ApiTypes.ItemType1;
+  item_type?: ApiTypes.ItemTypeData<D>;
+  meta?: ApiTypes.ItemUpdateSchema['meta'];
+  creator?: ApiTypes.ItemUpdateSchema['creator'];
+  __itemTypeId?: D['itemTypeId'];
+} & ToItemAttributesInRequest<D>;
+
 export function buildBlockRecord<
   D extends ItemTypeDefinition = ItemTypeDefinition,
 >(
-  body: UpdateOrCreateBlockRecordSchema<NoInfer<D>>,
+  body:
+    | CreateBlockRecordSchema<NoInfer<D>>
+    | UpdateBlockRecordSchema<NoInfer<D>>,
 ): NewBlockInRequest<NoInfer<D>> {
   return Utils.serializeRequestBody<{
     data: NewBlockInRequest<NoInfer<D>>;

package/src/utilities/duplicateBlockRecord.ts

@@ -42,9 +42,14 @@ export async function duplicateBlockRecord<
             );
           }
 
-          const { id, meta, ...blockWithoutIdAndMeta } = block;
+          if ('id' in block) {
+            const { id, meta, ...blockWithoutIdAndMeta } = block;
 
-          return blockWithoutIdAndMeta as NewBlockInRequest;
+            return blockWithoutIdAndMeta as NewBlockInRequest;
+          }
+
+          const { meta, ...blockWithoutMeta } = block;
+          return blockWithoutMeta as NewBlockInRequest;
         },
       );
   }

package/dist/cjs/fieldTypes/validators/sanitization.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sanitization.js","sourceRoot":"","sources":["../../../../src/fieldTypes/validators/sanitization.ts"],"names":[],"mappings":""}

package/dist/esm/fieldTypes/validators/sanitization.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=sanitization.js.map

package/dist/esm/fieldTypes/validators/sanitization.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sanitization.js","sourceRoot":"","sources":["../../../../src/fieldTypes/validators/sanitization.ts"],"names":[],"mappings":""}