@platecms/delta-client 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-client",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Utilities and functions to interact with the Delta CMS.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -18,11 +18,9 @@
     "src/**/*"
   ],
   "peerDependencies": {
-    "@platecms/delta-cast": "1.2.0",
+    "@platecms/delta-cast": "1.3.0",
     "@graphql-typed-document-node/core": "3.2.0",
     "graphql": "16.11.0",
-    "slate": "0.118.0",
-    "slate-react": "0.117.4",
     "tslib": "2.8.1",
     "class-transformer": "0.5.1",
     "reflect-metadata": "0.2.2",

package/src/__generated__/graphql.ts

@@ -20,7 +20,7 @@ export type Scalars = {
   ContentValueType: { input: any; output: any; }
   /** A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format. */
   DateTime: { input: any; output: any; }
-  /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
+  /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](https://ecma-international.org/wp-content/uploads/ECMA-404_2nd_edition_december_2017.pdf). */
   JSON: { input: any; output: any; }
   /** A string representing the PRN object. Must match '^prn(:[A-Za-z0-9-_]+){5}$'. */
   PRN: { input: any; output: any; }
@@ -87,6 +87,8 @@ export type AssetProcessedUrlsArgs = {
 export type Blueprint = {
   __typename?: 'Blueprint';
   channel: Channel;
+  /** The ID of the Channel this Blueprint belongs to. */
+  channelId?: Maybe<Scalars['String']['output']>;
   createdAt: Scalars['DateTime']['output'];
   /** The Experience Component which defines this Blueprint. */
   definedBy: ExperienceComponent;
@@ -115,6 +117,7 @@ export type BlueprintsConnection = {
 /** The filter input type for 'Blueprints'. Objects/maps are treated as AND, while arrays are treated as OR. */
 export type BlueprintsFilterInput = {
   _not?: InputMaybe<Array<BlueprintsFilterInput>>;
+  channelId?: InputMaybe<Array<StringFilter>>;
   createdAt?: InputMaybe<Array<DateFilter>>;
   isFixed?: InputMaybe<Array<BooleanFilter>>;
   name?: InputMaybe<Array<StringFilter>>;
@@ -260,15 +263,6 @@ export type BuildingBlocksFilterInput = {
   updatedAt?: InputMaybe<Array<DateFilter>>;
 };
 
-export type CasDatabaseTextMatch = {
-  __typename?: 'CasDatabaseTextMatch';
-  confidence: Scalars['Float']['output'];
-  contentValue: ContentValue;
-  endIndex: Scalars['Int']['output'];
-  extractionMethod: Scalars['String']['output'];
-  startIndex: Scalars['Int']['output'];
-};
-
 export type CasImageContentValueMatch = {
   __typename?: 'CasImageContentValueMatch';
   similarContentValue: ContentValue;
@@ -280,10 +274,20 @@ export type CasRegexSuggestion = {
   __typename?: 'CasRegexSuggestion';
   confidence: Scalars['Float']['output'];
   endIndex: Scalars['Int']['output'];
-  extractionMethod: Scalars['String']['output'];
+  method: Scalars['String']['output'];
   startIndex: Scalars['Int']['output'];
 };
 
+export type CastSuggestion = {
+  __typename?: 'CastSuggestion';
+  endIndex: Scalars['Int']['output'];
+  message: Scalars['String']['output'];
+  method: Scalars['String']['output'];
+  original: Array<Content>;
+  startIndex: Scalars['Int']['output'];
+  suggested: InterpolatedContentValue;
+};
+
 export type Channel = {
   __typename?: 'Channel';
   apiTokens: Array<ApiToken>;
@@ -335,8 +339,17 @@ export type ConnectContentValueInput = {
   contentValue: Scalars['PRN']['input'];
 };
 
+export type Content = {
+  __typename?: 'Content';
+  children?: Maybe<Array<Content>>;
+  type: Scalars['String']['output'];
+  value?: Maybe<Scalars['JSON']['output']>;
+};
+
 export type ContentExperience = {
   __typename?: 'ContentExperience';
+  /** The ID of the Channel this ContentExperience belongs to. */
+  channelId?: Maybe<Scalars['String']['output']>;
   createdAt: Scalars['DateTime']['output'];
   experienceComponent: ExperienceComponent;
   /** The issues that this Content Experience is a subject of */
@@ -383,6 +396,7 @@ export type ContentExperiencesConnection = {
 /** The filter input type for 'ContentExperiences'. Objects/maps are treated as AND, while arrays are treated as OR. */
 export type ContentExperiencesFilterInput = {
   _not?: InputMaybe<Array<ContentExperiencesFilterInput>>;
+  channelId?: InputMaybe<Array<StringFilter>>;
   createdAt?: InputMaybe<Array<DateFilter>>;
   prn?: InputMaybe<Array<PrnFilter>>;
   seoDescription?: InputMaybe<Array<StringFilter>>;
@@ -653,7 +667,8 @@ export enum ContentValueTypeNames {
   PathPart = 'PATH_PART',
   SmartText = 'SMART_TEXT',
   String = 'STRING',
-  Tag = 'TAG'
+  Tag = 'TAG',
+  Unknown = 'UNKNOWN'
 }
 
 export type ContentValuesConnection = {
@@ -761,16 +776,20 @@ export type CreateBuildingBlockFieldForBuildingBlockInput = {
 
 export type CreateBuildingBlockFieldFulfillmentForExperienceComponentInput = {
   buildingBlockField: Scalars['PRN']['input'];
-  /** The PRNs of the Content Value which this BuildingBlockFieldFulfillment is filled by. */
-  contentValue: Scalars['PRN']['input'];
+  /** The PRN of the Content Value which this BuildingBlockFieldFulfillment is filled by. */
+  contentValueToConnect?: InputMaybe<Scalars['PRN']['input']>;
+  /** Create a new Content Value for this Building Block Field Fulfillment. Exactly one of contentValue or createContentValue must be provided. */
+  contentValueToCreate?: InputMaybe<CreateContentValueInput>;
   /** The PRN of the BuildingBlockFieldFulfillment that this BuildingBlockFieldFulfillment should manually be sorted after. Null means it should be the last. */
   next?: InputMaybe<Scalars['PRN']['input']>;
 };
 
 export type CreateBuildingBlockFieldFulfillmentInput = {
   buildingBlockField: Scalars['PRN']['input'];
-  /** The PRNs of the Content Value which this BuildingBlockFieldFulfillment is filled by. */
-  contentValue: Scalars['PRN']['input'];
+  /** The PRN of the Content Value which this BuildingBlockFieldFulfillment is filled by. */
+  contentValueToConnect?: InputMaybe<Scalars['PRN']['input']>;
+  /** Create a new Content Value for this Building Block Field Fulfillment. Exactly one of contentValue or createContentValue must be provided. */
+  contentValueToCreate?: InputMaybe<CreateContentValueInput>;
   /** The PRN of the Experience Component which this Building Block Field Fulfillment fulfills.  */
   experienceComponent: Scalars['PRN']['input'];
   /** The PRN of the BuildingBlockFieldFulfillment that this BuildingBlockFieldFulfillment should manually be sorted after. Null means it should be the last. */
@@ -936,8 +955,8 @@ export type CreateExperienceComponentInput = {
   buildingBlockFieldFulfillments: Array<CreateBuildingBlockFieldFulfillmentForExperienceComponentInput>;
   /** Must be set if the Building Block has a Grid Definition. */
   grid?: InputMaybe<CreateGridInput>;
-  gridPlacement?: InputMaybe<CreateGridPlacementInput>;
-  /** Whether the Experience Component is a draft. Drafts cannot be used in Grid Placements. */
+  gridPlacement?: InputMaybe<CreateGridPlacementForExperienceComponentInput>;
+  /** Whether the Experience Component is a draft. */
   isDraft: Scalars['Boolean']['input'];
   preview?: InputMaybe<Scalars['PRN']['input']>;
 };
@@ -947,8 +966,8 @@ export type CreateGlobalExperienceComponentInput = {
   buildingBlockFieldFulfillments: Array<CreateBuildingBlockFieldFulfillmentForExperienceComponentInput>;
   /** Must be set if the Building Block has a Grid Definition. */
   grid?: InputMaybe<CreateGridInput>;
-  gridPlacement?: InputMaybe<CreateGridPlacementInput>;
-  /** Whether the Experience Component is a draft. Drafts cannot be used in Grid Placements. */
+  gridPlacement?: InputMaybe<CreateGridPlacementForExperienceComponentInput>;
+  /** Whether the Experience Component is a draft. */
   isDraft: Scalars['Boolean']['input'];
   name: Scalars['String']['input'];
   preview?: InputMaybe<Scalars['PRN']['input']>;
@@ -967,6 +986,11 @@ export type CreateGridInput = {
   rows: Scalars['Int']['input'];
 };
 
+export type CreateGridPlacementForExperienceComponentInput = {
+  grid: Scalars['PRN']['input'];
+  row: Scalars['Int']['input'];
+};
+
 export type CreateGridPlacementInput = {
   /** The PRN of the Experience Component to place in this Grid Placement. */
   experienceComponent: Scalars['PRN']['input'];
@@ -1116,7 +1140,7 @@ export type ExperienceComponent = {
   grid?: Maybe<Grid>;
   /** The Grid Placements this Experience Component is placed in. */
   gridPlacements: Array<GridPlacement>;
-  /** Whether the Experience Component is a draft. Drafts cannot be used in Grid Placements. */
+  /** Whether the Experience Component is a draft. */
   isDraft: Scalars['Boolean']['output'];
   isGlobal: Scalars['Boolean']['output'];
   /** The name of the Experience Component. Only applicable for global Experience Components. */
@@ -1320,6 +1344,13 @@ export type IntFilter = {
   _nin?: InputMaybe<Array<Scalars['Int']['input']>>;
 };
 
+export type InterpolatedContentValue = {
+  __typename?: 'InterpolatedContentValue';
+  prn: Scalars['PRN']['output'];
+  type: Scalars['String']['output'];
+  value: Scalars['CAST']['output'];
+};
+
 export type Invitation = {
   __typename?: 'Invitation';
   createdAt: Scalars['DateTime']['output'];
@@ -1552,7 +1583,6 @@ export type Mutation = {
    * Removes one or many ContentFields.
    *         Throws NotFoundException when no ContentField could be found.
    *         Throws UnprocessableContentError when attempting to remove a Content Field outside of the DEVELOPMENT stage.
-   *         Throws UnprocessableContentError when attempting to remove a Content Field that is being used by Content Values.
    *         Throws BadRequestError when attempting to remove a Content Field that is being used in the displayNameTemplate of its Content Type.
    *         Throws BadRequestError when attempting to remove a Content Field that is being used in the displayImageField of its Content Type.
    */
@@ -2334,6 +2364,8 @@ export type PathPart = {
   amountOfDescendantsWithContentExperiences: Scalars['Int']['output'];
   /** All Path Parts in a "family" (ancestors and decendents) are connected to the same Channel. This does not make sense semantically, but makes it much easier to access the Channel from any Path Part. */
   channel: Channel;
+  /** The ID of the Channel this PathPart belongs to. */
+  channelId?: Maybe<Scalars['String']['output']>;
   children: Array<PathPart>;
   contentExperience?: Maybe<ContentExperience>;
   createdAt: Scalars['DateTime']['output'];
@@ -2377,6 +2409,7 @@ export type PathPartsFilterInput = {
   amountOfChildrenWithContentExperiences?: InputMaybe<Array<IntFilter>>;
   amountOfDescendants?: InputMaybe<Array<IntFilter>>;
   amountOfDescendantsWithContentExperiences?: InputMaybe<Array<IntFilter>>;
+  channelId?: InputMaybe<Array<StringFilter>>;
   createdAt?: InputMaybe<Array<DateFilter>>;
   hasContentExperience?: InputMaybe<Array<BooleanFilter>>;
   parentId?: InputMaybe<Array<StringFilter>>;
@@ -2443,16 +2476,10 @@ export type Query = {
   buildingBlockFieldFulfillments: BuildingBlockFieldFulfillmentsConnection;
   /** Orders and paginates all BuildingBlockFields. */
   buildingBlockFields: BuildingBlockFieldsConnection;
-  /** Detect CAST matches with database reusable entries. Matches are based on plaintext. */
-  casCastMatches?: Maybe<Scalars['CAST']['output']>;
-  /** Get similar image Content Values within the database. Use similarity score based on image hashes to find potential duplicates. */
-  casFindSimilarImageContentValues: Array<CasImageContentValueMatch>;
-  /** Get similar image Content Values within the database from an asset PRN input. Use similarity score based on image hashes to find potential duplicates. */
-  casFindSimilarImageContentValuesFromAsset: Array<CasImageContentValueMatch>;
-  /** Use predefined regex patterns to detect potentially reusable content in a string. */
-  casRegexSuggestions: Array<CasRegexSuggestion>;
-  /** Detect string matches with database reusable entries. */
-  casStringMatches: Array<CasDatabaseTextMatch>;
+  /** Detect CAST matches with database reusable entries and return an array with the suggestions, Ordered by occurrence in the text. Matches are based on plaintext. */
+  castSuggestions: Array<CastSuggestion>;
+  /** Detect CAST matches with database reusable entries and return the CAST with suggestions inserted. Matches are based on plaintext. */
+  castSuggestionsInRoot?: Maybe<Scalars['CAST']['output']>;
   /** Finds one or many Channels by PRN. Throws NotFoundException when no Channel could be found. */
   channel: Array<Channel>;
   /** Orders and paginates all Channels. */
@@ -2484,6 +2511,10 @@ export type Query = {
   experienceComponent: Array<ExperienceComponent>;
   /** Orders and paginates all ExperienceComponents. */
   experienceComponents: ExperienceComponentsConnection;
+  /** Get similar image Content Values within the database. Use similarity score based on image hashes to find potential duplicates. */
+  findSimilarImageContentValues: Array<CasImageContentValueMatch>;
+  /** Get similar image Content Values within the database from an asset PRN input. Use similarity score based on image hashes to find potential duplicates. */
+  findSimilarImageContentValuesFromAsset: Array<CasImageContentValueMatch>;
   /** Finds one or many Grids by PRN. Throws NotFoundException when no Grid could be found. */
   grid: Array<Grid>;
   /** Finds one or many GridDefinitions by PRN. Throws NotFoundException when no GridDefinition could be found. */
@@ -2513,6 +2544,8 @@ export type Query = {
   /** Orders and paginates all Path Parts. */
   pathParts: PathPartsConnection;
   plateMaintainers: Array<User>;
+  /** Use predefined regex patterns to detect potentially reusable content in a string. */
+  regexSuggestions: Array<CasRegexSuggestion>;
   /** Finds all RoleAssignments for the current Subject       (e.g. the logged in user or API token) */
   roleAssignmentsForCurrentSubject: Array<RoleAssignment>;
   /** Finds all RoleAssignments for the given Organization */
@@ -2591,37 +2624,17 @@ export type QueryBuildingBlockFieldsArgs = {
 };
 
 
-export type QueryCasCastMatchesArgs = {
+export type QueryCastSuggestionsArgs = {
   config?: InputMaybe<DatabaseTextMatchConfig>;
   inputCast: Scalars['CAST']['input'];
-};
-
-
-export type QueryCasFindSimilarImageContentValuesArgs = {
-  config?: InputMaybe<DuplicateImagesDetectionConfig>;
-  contentValuePrnString: Scalars['String']['input'];
   limit?: InputMaybe<Scalars['Int']['input']>;
 };
 
 
-export type QueryCasFindSimilarImageContentValuesFromAssetArgs = {
-  assetPrnString: Scalars['String']['input'];
-  config?: InputMaybe<DuplicateImagesDetectionConfig>;
-  limit?: InputMaybe<Scalars['Int']['input']>;
-};
-
-
-export type QueryCasRegexSuggestionsArgs = {
-  config?: InputMaybe<RegexExtractionConfig>;
-  inputText: Scalars['String']['input'];
-  limit: Scalars['Int']['input'];
-};
-
-
-export type QueryCasStringMatchesArgs = {
+export type QueryCastSuggestionsInRootArgs = {
   config?: InputMaybe<DatabaseTextMatchConfig>;
-  inputText: Scalars['String']['input'];
-  limit: Scalars['Int']['input'];
+  inputCast: Scalars['CAST']['input'];
+  limit?: InputMaybe<Scalars['Int']['input']>;
 };
 
 
@@ -2638,6 +2651,7 @@ export type QueryChannelsArgs = {
 
 
 export type QueryContentExperienceArgs = {
+  autoFetchFullContentExperience?: InputMaybe<Scalars['Boolean']['input']>;
   prn: Array<Scalars['PRN']['input']>;
 };
 
@@ -2714,6 +2728,20 @@ export type QueryExperienceComponentsArgs = {
 };
 
 
+export type QueryFindSimilarImageContentValuesArgs = {
+  config?: InputMaybe<DuplicateImagesDetectionConfig>;
+  contentValuePrnString: Scalars['String']['input'];
+  limit?: InputMaybe<Scalars['Int']['input']>;
+};
+
+
+export type QueryFindSimilarImageContentValuesFromAssetArgs = {
+  assetPrnString: Scalars['String']['input'];
+  config?: InputMaybe<DuplicateImagesDetectionConfig>;
+  limit?: InputMaybe<Scalars['Int']['input']>;
+};
+
+
 export type QueryGridArgs = {
   prn: Array<Scalars['PRN']['input']>;
 };
@@ -2780,6 +2808,13 @@ export type QueryPathPartsArgs = {
 };
 
 
+export type QueryRegexSuggestionsArgs = {
+  config?: InputMaybe<RegexExtractionConfig>;
+  inputText: Scalars['String']['input'];
+  limit: Scalars['Int']['input'];
+};
+
+
 export type QueryRoleAssignmentsForOrganizationArgs = {
   subjectType?: InputMaybe<SubjectType>;
 };
@@ -2836,6 +2871,8 @@ export enum RemoveBlueprintInstanceMode {
 export type RemoveBlueprintResponse = {
   __typename?: 'RemoveBlueprintResponse';
   channel: Channel;
+  /** The ID of the Channel this Blueprint belongs to. */
+  channelId?: Maybe<Scalars['String']['output']>;
   createdAt: Scalars['DateTime']['output'];
   /** The Experience Component which defines this Blueprint. */
   definedBy: ExperienceComponent;
@@ -2863,6 +2900,8 @@ export type RemoveBuildingBlockResponse = {
 
 export type RemoveContentExperienceResponse = {
   __typename?: 'RemoveContentExperienceResponse';
+  /** The ID of the Channel this ContentExperience belongs to. */
+  channelId?: Maybe<Scalars['String']['output']>;
   createdAt: Scalars['DateTime']['output'];
   experienceComponent: ExperienceComponent;
   /** The issues that this Content Experience is a subject of */
@@ -2951,7 +2990,7 @@ export type RemoveExperienceComponentResponse = {
   grid?: Maybe<Grid>;
   /** The Grid Placements this Experience Component is placed in. */
   gridPlacements: Array<GridPlacement>;
-  /** Whether the Experience Component is a draft. Drafts cannot be used in Grid Placements. */
+  /** Whether the Experience Component is a draft. */
   isDraft: Scalars['Boolean']['output'];
   isGlobal: Scalars['Boolean']['output'];
   /** The name of the Experience Component. Only applicable for global Experience Components. */
@@ -3015,7 +3054,8 @@ export enum SeedType {
   Performance_500 = 'PERFORMANCE_500',
   Performance_1000 = 'PERFORMANCE_1000',
   Performance_2000 = 'PERFORMANCE_2000',
-  Performance_5000 = 'PERFORMANCE_5000'
+  Performance_5000 = 'PERFORMANCE_5000',
+  QaContent = 'QA_CONTENT'
 }
 
 export enum SortingDirection {
@@ -3366,7 +3406,9 @@ export type UpdateDecimalCountContentValidationRuleInput = {
 export type UpdateExperienceComponentInput = {
   /** !!!WARNING!!! If you update to a new Building Block, all existing Building Block Field Fulfillments will be removed! Content Values and Grid Placements will remain. */
   buildingBlock?: InputMaybe<Scalars['PRN']['input']>;
-  /** Whether the Experience Component is a draft. Drafts cannot be used in Grid Placements. */
+  fulfillmentsToConnect?: InputMaybe<Array<Scalars['PRN']['input']>>;
+  fulfillmentsToCreate?: InputMaybe<Array<CreateBuildingBlockFieldFulfillmentForExperienceComponentInput>>;
+  /** Whether the Experience Component is a draft. */
   isDraft?: InputMaybe<Scalars['Boolean']['input']>;
   /** The name of the Experience Component. Only applicable for global Experience Components. */
   name?: InputMaybe<Scalars['String']['input']>;

package/src/slate/index.ts

@@ -1,18 +1,5 @@
-import { BaseEditor } from "slate";
-import { ReactEditor } from "slate-react";
 import { Content, Root } from "@platecms/delta-cast";
 
-declare module "slate" {
-  interface CustomTypes {
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    Editor: BaseEditor & ReactEditor;
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    Element: DeltaElement;
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    Text: DeltaLeaf;
-  }
-}
-
 export interface DeltaLeafMarkdown {
   title?: boolean;
 }
@@ -21,7 +8,6 @@ export type DeltaElement =
   | BlockquoteElement
   | CodeElement
   | ContentValueElement
-  | ContentValueSuggestionElement
   | HeadingElement
   | LinkElement
   | ListElement
@@ -39,46 +25,51 @@ export type DeltaLeaf = DeltaLeafMarkdown & {
   highlight?: true;
 };
 
+export interface DeltaNode extends Node {
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  DeltaElement: DeltaElement;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  DeltaLeaf: DeltaLeaf;
+}
+
 export interface ParagraphElement {
   type: "paragraph";
-  children: (ContentValueElement | ContentValueSuggestionElement | DeltaLeaf | LinkElement | Suggestion)[];
+  children: (ContentValueElement | DeltaLeaf | LinkElement | Suggestion)[];
 }
+
 export interface HeadingElement {
   type: "heading";
   level: 1 | 2 | 3 | 4 | 5 | 6;
   children: DeltaLeaf[];
 }
+
 export interface ListElement {
   type: "list";
   ordered: boolean;
   children: ListItemElement[];
 }
+
 export interface ListItemElement {
   type: "listItem";
   children: DeltaLeaf[];
 }
+
 export interface BlockquoteElement {
   type: "blockquote";
   children: DeltaLeaf[];
 }
+
 export interface CodeElement {
   type: "code";
   children: DeltaLeaf[];
 }
+
 export interface ContentValueElement {
   type: "contentValue";
   prn: string;
   root: Root | undefined;
   children: DeltaLeaf[];
 }
-
-export interface ContentValueSuggestionElement {
-  type: "contentValueSuggestion";
-  prn: string;
-  root: Root | undefined;
-  children: DeltaLeaf[];
-}
-
 export interface LinkElement {
   type: "link";
   url: string;
@@ -88,13 +79,15 @@ export interface LinkElement {
 
   internal?: {
     prn: string;
-    anchor?: boolean;
+    anchor: boolean;
   };
 }
 
 export interface Suggestion {
   type: "suggestion";
-  suggested: Content[];
+  startIndex: number;
+  endIndex: number;
+  suggested: ContentValueElement;
   original: Content[];
   message: string;
   method: string;