@platecms/delta-client 0.6.0 → 0.8.0

package/src/slate/index.ts

@@ -0,0 +1,84 @@
+import { BaseEditor } from "slate";
+import { ReactEditor } from "slate-react";
+import { 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;
+}
+
+export type DeltaElement =
+  | BlockquoteElement
+  | CodeElement
+  | ContentValueElement
+  | HeadingElement
+  | LinkElement
+  | ListElement
+  | ListItemElement
+  | ParagraphElement;
+
+export type DeltaLeaf = DeltaLeafMarkdown & {
+  text: string;
+  bold?: true;
+  italic?: true;
+  underline?: true;
+  strikethrough?: true;
+  inlineCode?: true;
+  highlight?: true;
+};
+
+export interface ParagraphElement {
+  type: "paragraph";
+  children: (ContentValueElement | DeltaLeaf | LinkElement)[];
+}
+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 LinkElement {
+  type: "link";
+  url: string;
+  children: DeltaLeaf[];
+
+  target?: "_parent" | "_top" | "blank" | "self";
+
+  internal?: {
+    prn: string;
+    anchor?: boolean;
+  };
+}

package/src/utils/{index.d.ts → index.ts}

@@ -1,6 +1,7 @@
 export * from "./lib/connectors/WindowConnector";
 export * from "./lib/events/ConnectorEvents";
+
 export type Draft<T> = T & {
-    isDraft: boolean;
-    uuid: string;
+  isDraft: boolean;
+  uuid: string;
 };

package/src/utils/lib/connectors/BaseConnector.ts

@@ -0,0 +1,26 @@
+import { EventEmitter } from "../events/EventEmitter";
+import { ConnectorEventOption } from "../events/ConnectorEvents";
+
+export abstract class BaseConnector extends EventEmitter<{
+  message: [args: ConnectorEventOption];
+  connected: [];
+  disconnected: [];
+  statusChanged: [status: "connected" | "connecting" | "disconnected" | "idle"];
+}> {
+  protected status: "connected" | "connecting" | "disconnected" | "idle" = "idle";
+
+  public abstract connectorName: string;
+
+  protected constructor(protected id: string) {
+    super();
+  }
+
+  public updateStatus(status: "connected" | "connecting" | "disconnected" | "idle"): void {
+    this.status = status;
+    this.emit("statusChanged", status);
+  }
+
+  public abstract send(event: ConnectorEventOption): void;
+
+  public abstract connect(): void;
+}

package/src/utils/lib/connectors/WindowConnector.ts

@@ -0,0 +1,70 @@
+import { BaseConnector } from "./BaseConnector";
+import { ConnectorEventOption } from "../events/ConnectorEvents";
+
+/*
+ * WindowConnector provides the lowest level of communication between the client and the host.
+ * It uses the window.postMessage API to send and receive messages making it completely dependent on the window API.
+ * This connector can be used when the client and host are in the same window context, such as in an iframe or a popup window.
+ */
+export class WindowConnector extends BaseConnector {
+  public connectorName = "window";
+
+  public constructor(
+    id: string,
+    private readonly receiveOn: Window,
+    private readonly sendOn: Window,
+  ) {
+    super(id);
+
+    this.receiveOn.addEventListener("message", (event: MessageEvent) => {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      if (event.data.type === "offer") {
+        this.updateStatus("connecting");
+        this.sendOn.postMessage({ type: "answer", payload: null }, "*");
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      } else if (event.data.type === "answer") {
+        this.updateStatus("connected");
+        this.sendOn.postMessage({ type: "connected", payload: null }, "*");
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      } else if (event.data.type === "connected") {
+        this.updateStatus("connected");
+      } else if (this.status === "connected") {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        if (event.data.payload !== null) {
+          try {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            const data = JSON.parse(event.data.payload as string);
+            this.emit("message", {
+              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+              type: event.data.type,
+              payload: data,
+            });
+          } catch (error) {
+            //TODO: Handle error
+          }
+        }
+      }
+    });
+  }
+
+  public send(event: ConnectorEventOption): void {
+    this.sendOn.postMessage(
+      {
+        type: event.type,
+        payload: JSON.stringify(event.payload),
+      },
+      "*",
+    );
+  }
+
+  public connect(): void {
+    this.updateStatus("connecting");
+    this.sendOn.postMessage(
+      {
+        type: "offer",
+        payload: null,
+      },
+      "*",
+    );
+  }
+}

package/src/utils/lib/events/ConnectorEvents.ts

@@ -0,0 +1,89 @@
+import { BuildingBlock, ExperienceComponent } from "../../../__generated__/graphql";
+
+export enum ConnectorEventType {
+  ROOT_EXPERIENCE_COMPONENT_SEND = "root-experience-component-send",
+  ROOT_EXPERIENCE_COMPONENT_REQUIRED = "root-experience-component-required",
+
+  ROOT_EXPERIENCE_COMPONENT_SET_MODE = "root-experience-component-set-mode",
+
+  BLUEPRINT_OVERLAY_OPEN = "blueprint-overlay-open",
+
+  EXPERIENCE_COMPONENT_EDIT = "experience-component-edit",
+  EXPERIENCE_COMPONENT_REMOVE = "experience-component-remove",
+  EXPERIENCE_COMPONENT_CREATE = "experience-component-create",
+
+  GRID_PLACEMENT_UP = "grid-placement-up",
+  GRID_PLACEMENT_DOWN = "grid-placement-down",
+
+  MOUSE_UP = "mouse-up",
+  MOUSE_MOVE = "mouse-move",
+  DRAG_START = "drag-start",
+  DRAG_END = "drag-end",
+
+  NEGOTIATE_BUILDING_BLOCKS = "negotiate-building-blocks",
+  SNAPSHOT_GENERATE = "snapshot-generate",
+  SNAPSHOT_GENERATED = "snapshot-generated",
+}
+
+export interface ConnectorEvent<T> {
+  type: ConnectorEventType;
+  payload: T;
+}
+
+//expose event types to ensure cross project type safety
+export type RootExperienceComponentSendEvent = ConnectorEvent<ExperienceComponent>;
+export type RootExperienceComponentRequiredEvent = ConnectorEvent<null>;
+export type RootExperienceComponentSetModeEvent = ConnectorEvent<{
+  prn?: string;
+  uuid?: string;
+  mode: "drag" | "edit" | "preview";
+  type?: "blueprint" | "experience";
+}>;
+
+export type ExperienceComponentCreateEvent = ConnectorEvent<{ index: number }>;
+export type ExperienceComponentEditEvent = ConnectorEvent<{
+  prn?: string;
+  uuid?: string;
+}>;
+
+export type ExperienceComponentRemoveEvent = ConnectorEvent<{
+  prn?: string;
+  uuid?: string;
+}>;
+
+export type GridPlacementUpEvent = ConnectorEvent<{
+  prn?: string;
+  uuid?: string;
+}>;
+export type GridPlacementDownEvent = ConnectorEvent<{
+  prn?: string;
+  uuid?: string;
+}>;
+
+export type MouseUpEvent = ConnectorEvent<null>;
+export type MouseMoveEvent = ConnectorEvent<{ x: number; y: number }>;
+export type DragStartEvent = ConnectorEvent<BuildingBlock>;
+export type DragEndEvent = ConnectorEvent<null>;
+
+export type NegotiateBuildingBlocksEvent = ConnectorEvent<Record<string, string>>;
+export type SnapshotGenerateEvent = ConnectorEvent<null>;
+export type SnapshotGeneratedEvent = ConnectorEvent<string>;
+
+export type ConnectorEventOption =
+  | DragEndEvent
+  | DragStartEvent
+  | ExperienceComponentCreateEvent
+  | ExperienceComponentEditEvent
+  | ExperienceComponentRemoveEvent
+  | GridPlacementDownEvent
+  | GridPlacementUpEvent
+  | MouseMoveEvent
+  | MouseUpEvent
+  | NegotiateBuildingBlocksEvent
+  | RootExperienceComponentRequiredEvent
+  | RootExperienceComponentSendEvent
+  | RootExperienceComponentSetModeEvent
+  | SnapshotGeneratedEvent
+  | SnapshotGenerateEvent;
+
+export default {};

package/src/utils/lib/events/EventEmitter.ts

@@ -0,0 +1,19 @@
+type Listener<T extends unknown[]> = (...args: T) => void;
+
+export class EventEmitter<TEventMap extends Record<string, unknown[]>> {
+  private eventListeners: { [K in keyof TEventMap]?: Set<Listener<TEventMap[K]>> } = {};
+
+  public on<T extends keyof TEventMap>(eventName: T, listener: Listener<TEventMap[T]>): void {
+    const listeners = this.eventListeners[eventName] || new Set();
+    listeners.add(listener);
+    this.eventListeners[eventName] = listeners;
+  }
+
+  public emit<T extends keyof TEventMap>(eventName: T, ...args: TEventMap[T]): void {
+    const listeners = this.eventListeners[eventName] || new Set();
+
+    for (const listener of listeners) {
+      listener(...args);
+    }
+  }
+}

package/src/__generated__/fragment-masking.d.ts

@@ -1,19 +0,0 @@
-import { ResultOf, DocumentTypeDecoration, TypedDocumentNode } from '@graphql-typed-document-node/core';
-import { Incremental } from './graphql';
-export type FragmentType<TDocumentType extends DocumentTypeDecoration<any, any>> = TDocumentType extends DocumentTypeDecoration<infer TType, any> ? [TType] extends [{
-    ' $fragmentName'?: infer TKey;
-}] ? TKey extends string ? {
-    ' $fragmentRefs'?: {
-        [key in TKey]: TType;
-    };
-} : never : never : never;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>>): TType;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | undefined): TType | undefined;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null): TType | null;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null | undefined): TType | null | undefined;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>>): Array<TType>;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined): Array<TType> | null | undefined;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>): ReadonlyArray<TType>;
-export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined): ReadonlyArray<TType> | null | undefined;
-export declare function makeFragmentData<F extends DocumentTypeDecoration<any, any>, FT extends ResultOf<F>>(data: FT, _fragment: F): FragmentType<F>;
-export declare function isFragmentReady<TQuery, TFrag>(queryNode: DocumentTypeDecoration<TQuery, any>, fragmentNode: TypedDocumentNode<TFrag>, data: FragmentType<TypedDocumentNode<Incremental<TFrag>, any>> | null | undefined): data is FragmentType<typeof fragmentNode>;

package/src/__generated__/fragment-masking.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFragment = useFragment;
-exports.makeFragmentData = makeFragmentData;
-exports.isFragmentReady = isFragmentReady;
-function useFragment(_documentNode, fragmentType) {
-    return fragmentType;
-}
-function makeFragmentData(data, _fragment) {
-    return data;
-}
-function isFragmentReady(queryNode, fragmentNode, data) {
-    const deferredFields = queryNode.__meta__
-        ?.deferredFields;
-    if (!deferredFields)
-        return true;
-    const fragDef = fragmentNode.definitions[0];
-    const fragName = fragDef?.name?.value;
-    const fields = (fragName && deferredFields[fragName]) || [];
-    return fields.length > 0 && fields.every(field => data && field in data);
-}
-//# sourceMappingURL=fragment-masking.js.map

package/src/__generated__/fragment-masking.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fragment-masking.js","sourceRoot":"","sources":["../../../../../../packages/delta-client/src/__generated__/fragment-masking.ts"],"names":[],"mappings":";;AAyDA,kCAKC;AAGD,4CAKC;AACD,0CAeC;AA7BD,SAAgB,WAAW,CACzB,aAAiD,EACjD,YAA6M;IAE7M,OAAO,YAAmB,CAAC;AAC7B,CAAC;AAGD,SAAgB,gBAAgB,CAG9B,IAAQ,EAAE,SAAY;IACtB,OAAO,IAAuB,CAAC;AACjC,CAAC;AACD,SAAgB,eAAe,CAC7B,SAA8C,EAC9C,YAAsC,EACtC,IAAiF;IAEjF,MAAM,cAAc,GAAI,SAAgF,CAAC,QAAQ;QAC/G,EAAE,cAAc,CAAC;IAEnB,IAAI,CAAC,cAAc;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC,CAAuC,CAAC;IAClF,MAAM,QAAQ,GAAG,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC;IAEtC,MAAM,MAAM,GAAG,CAAC,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5D,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC;AAC3E,CAAC"}

package/src/__generated__/gql.d.ts

@@ -1,12 +0,0 @@
-import * as types from './graphql';
-import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
-type Documents = {
-    "query tag($prn: [PRN!]!) {\n  tag(prn: $prn) {\n    ...tagFragment\n  }\n}": typeof types.TagDocument;
-    "fragment tagFragment on Tag {\n  _id: prn\n  prn\n  name\n  path\n  color\n  visibility\n  forceVisibilityOnDescendants\n  stage\n  amountOfChildren\n  amountOfContentExperiences\n  amountOfContentItems\n  hasForcedVisibility\n  nestingLevel\n  createdAt\n  updatedAt\n}": typeof types.TagFragmentFragmentDoc;
-};
-declare const documents: Documents;
-export declare function graphql(source: string): unknown;
-export declare function graphql(source: "query tag($prn: [PRN!]!) {\n  tag(prn: $prn) {\n    ...tagFragment\n  }\n}"): (typeof documents)["query tag($prn: [PRN!]!) {\n  tag(prn: $prn) {\n    ...tagFragment\n  }\n}"];
-export declare function graphql(source: "fragment tagFragment on Tag {\n  _id: prn\n  prn\n  name\n  path\n  color\n  visibility\n  forceVisibilityOnDescendants\n  stage\n  amountOfChildren\n  amountOfContentExperiences\n  amountOfContentItems\n  hasForcedVisibility\n  nestingLevel\n  createdAt\n  updatedAt\n}"): (typeof documents)["fragment tagFragment on Tag {\n  _id: prn\n  prn\n  name\n  path\n  color\n  visibility\n  forceVisibilityOnDescendants\n  stage\n  amountOfChildren\n  amountOfContentExperiences\n  amountOfContentItems\n  hasForcedVisibility\n  nestingLevel\n  createdAt\n  updatedAt\n}"];
-export type DocumentType<TDocumentNode extends DocumentNode<any, any>> = TDocumentNode extends DocumentNode<infer TType, any> ? TType : never;
-export {};

package/src/__generated__/gql.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.graphql = graphql;
-const tslib_1 = require("tslib");
-const types = tslib_1.__importStar(require("./graphql"));
-const documents = {
-    "query tag($prn: [PRN!]!) {\n  tag(prn: $prn) {\n    ...tagFragment\n  }\n}": types.TagDocument,
-    "fragment tagFragment on Tag {\n  _id: prn\n  prn\n  name\n  path\n  color\n  visibility\n  forceVisibilityOnDescendants\n  stage\n  amountOfChildren\n  amountOfContentExperiences\n  amountOfContentItems\n  hasForcedVisibility\n  nestingLevel\n  createdAt\n  updatedAt\n}": types.TagFragmentFragmentDoc,
-};
-function graphql(source) {
-    return documents[source] ?? {};
-}
-//# sourceMappingURL=gql.js.map

package/src/__generated__/gql.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"gql.js","sourceRoot":"","sources":["../../../../../../packages/delta-client/src/__generated__/gql.ts"],"names":[],"mappings":";;AA+CA,0BAEC;;AAhDD,yDAAmC;AAkBnC,MAAM,SAAS,GAAc;IACzB,4EAA4E,EAAE,KAAK,CAAC,WAAW;IAC/F,gRAAgR,EAAE,KAAK,CAAC,sBAAsB;CACjT,CAAC;AAyBF,SAAgB,OAAO,CAAC,MAAc;IACpC,OAAQ,SAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;AAC1C,CAAC"}