@contentful/field-editor-reference 4.6.10 → 5.0.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.0.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-reference@4.6.10...@contentful/field-editor-reference@5.0.0) (2022-08-18)
+
+### Features
+
+- moving new entity store in [TOL-282] ([#1214](https://github.com/contentful/field-editors/issues/1214)) ([2ad4f64](https://github.com/contentful/field-editors/commit/2ad4f643296dbf48802410382a9a055de18a15de))
+
+### BREAKING CHANGES
+
+- useEntities is no longer export from the reference editor package. Use useEntity or useEntityLoader instead
+
+Co-authored-by: Ahmed T. Ali <ah.tajelsir@gmail.com>
+
 ## [4.6.10](https://github.com/contentful/field-editors/compare/@contentful/field-editor-reference@4.6.9...@contentful/field-editor-reference@4.6.10) (2022-08-09)
 
 ### Bug Fixes

package/dist/assets/WrappedAssetCard/AssetCardActions.d.ts

@@ -2,7 +2,7 @@
 import { File } from '../../types';
 export declare function renderAssetInfo(props: {
     entityFile: File;
-}): ("" | JSX.Element)[];
+}): any[];
 export declare function renderActions(props: {
     onEdit?: () => void;
     onRemove?: () => void;

package/dist/common/EntityStore.d.ts

@@ -1,12 +1,62 @@
-import * as React from 'react';
-import { BaseExtensionSDK, ContentType, Resource, Space } from '../types';
+import React from 'react';
+import { BaseExtensionSDK } from '@contentful/app-sdk';
+import { Asset, ContentType, Entry, Resource, ResourceType, Space, ScheduledAction } from '../types';
 export declare type ResourceInfo<R extends Resource = Resource> = {
     resource: R;
     defaultLocaleCode: string;
     contentType: ContentType;
     space: Space;
 };
-declare const EntityProvider: React.FC<{
+declare type EntityStoreProps = {
     sdk: BaseExtensionSDK;
-}>, useEntities: any;
-export { EntityProvider, useEntities };
+    queryConcurrency?: number;
+};
+declare type GetOptions = {
+    priority?: number;
+};
+declare type GetEntityOptions = GetOptions & {
+    spaceId?: string;
+    environmentId?: string;
+};
+declare type UseEntityOptions = GetEntityOptions & {
+    enabled?: boolean;
+};
+declare type QueryEntityResult<E> = Promise<E>;
+declare type GetResourceOptions = GetOptions;
+declare type QueryResourceResult<R extends Resource = Resource> = QueryEntityResult<ResourceInfo<R>>;
+declare type UseResourceOptions = GetResourceOptions & {
+    enabled?: boolean;
+};
+declare type UseEntityResult<E> = {
+    status: 'idle';
+    data: never;
+} | {
+    status: 'loading';
+    data: never;
+} | {
+    status: 'error';
+    data: never;
+} | {
+    status: 'success';
+    data: E;
+};
+declare type FetchableEntityType = 'Entry' | 'Asset';
+declare type FetchableEntity = Entry | Asset;
+export declare class UnsupportedError extends Error {
+    isUnsupportedError: boolean;
+    constructor(message: string);
+}
+export declare function isUnsupportedError(value: unknown): value is UnsupportedError;
+declare const useEntityLoader: () => {
+    getResource: <R extends Resource = Resource>(resourceType: ResourceType, urn: string, options?: GetOptions | undefined) => QueryResourceResult<R>;
+    getEntity: <E extends FetchableEntity>(entityType: FetchableEntityType, entityId: string, options?: GetEntityOptions | undefined) => QueryEntityResult<E>;
+    getEntityScheduledActions: (entityType: FetchableEntityType, entityId: string, options?: GetEntityOptions | undefined) => QueryEntityResult<ScheduledAction[]>;
+};
+export declare function useEntity<E extends FetchableEntity>(entityType: FetchableEntityType, entityId: string, options?: UseEntityOptions): UseEntityResult<E>;
+export declare function useResource(resourceType: ResourceType, urn: string, options?: UseResourceOptions): {
+    status: "loading" | "error" | "success";
+    data: ResourceInfo<Resource> | undefined;
+    error: unknown;
+};
+declare function EntityProvider({ children, ...props }: React.PropsWithChildren<EntityStoreProps>): JSX.Element;
+export { EntityProvider, useEntityLoader };

package/dist/common/ReferenceEditor.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { FieldConnector } from '@contentful/field-editor-shared';
-import { Action, ActionLabels, FieldExtensionSDK, ViewType } from '../types';
 import type { LinkActionsProps } from '../components';
+import { Action, ActionLabels, FieldExtensionSDK, ViewType } from '../types';
 import { CustomCardRenderer, RenderCustomMissingEntityCard } from './customCardTypes';
 export interface ReferenceEditorProps {
     /**

package/dist/common/useAccessApi.d.ts

@@ -9,7 +9,7 @@ export declare function useAccessApi(accessApi: AccessAPI & Partial<ExtendedAcce
         <T = Object>(action: CrudAction, entity: T | "ContentType" | import("@contentful/app-sdk").ContentType | "Asset" | "Entry"): Promise<boolean>;
         <T_1 = Object>(action: PublishableAction, entity: T_1 | "ContentType" | import("@contentful/app-sdk").ContentType | "Asset" | "Entry"): Promise<boolean>;
         <T_2 = Object>(action: ArchiveableAction, entity: T_2 | "Asset" | "Entry"): Promise<boolean>;
-        (action: "update", entity: import("@contentful/app-sdk").Entry<Record<string, any>> | import("@contentful/app-sdk").Task | import("@contentful/app-sdk").Asset, patch: import("@contentful/app-sdk").JSONPatchItem[]): Promise<boolean>;
+        (action: "update", entity: import("@contentful/app-sdk").Entry<import("contentful-management").KeyValueMap> | import("@contentful/app-sdk").Task | import("@contentful/app-sdk").Asset, patch: import("@contentful/app-sdk").JSONPatchItem[]): Promise<boolean>;
     };
     canPerformActionOnEntryOfType: (action: EntryAction, contentTypeId: string) => Promise<boolean>;
 };

package/dist/components/LinkActions/helpers.d.ts

@@ -8,7 +8,7 @@ export declare function createEntity(props: {
     entity?: undefined;
     slide?: undefined;
 } | {
-    entity: Entry<Entry<Record<string, any>>> | undefined;
+    entity: Entry<Entry<import("contentful-management").KeyValueMap>> | undefined;
     slide: import("@contentful/app-sdk/dist/types/navigator.types").NavigatorSlideInfo | undefined;
 } | {
     entity: Asset | undefined;
@@ -18,9 +18,9 @@ export declare function selectSingleEntity(props: {
     sdk: FieldExtensionSDK;
     entityType: ContentEntityType;
     editorPermissions: EditorPermissions;
-}): Promise<Entry<Record<string, any>> | null>;
+}): Promise<Entry<import("contentful-management").KeyValueMap> | null>;
 export declare function selectMultipleEntities(props: {
     sdk: FieldExtensionSDK;
     entityType: ContentEntityType;
     editorPermissions: EditorPermissions;
-}): Promise<Entry<Record<string, any>>[] | null>;
+}): Promise<Entry<import("contentful-management").KeyValueMap>[] | null>;