@financial-times/custom-code-component 2.0.1-beta.13 → 2.0.1-beta.14

package/src/events.ts

@@ -1,16 +1,16 @@
 import { ComponentPath } from "./path";
 
-export class CCCConnectedEvent extends Event {
-  static eventType = "ccc:connected";
-
+export class CCCEvent extends Event {
   component: ComponentPath;
   source?: string;
+  static eventType = "ccc:event";
 
   constructor(
+    eventType: string = CCCEvent.eventType,
     detail: { component: ComponentPath; source?: string },
     opts?: EventInit
   ) {
-    super(CCCConnectedEvent.eventType, {
+    super(eventType, {
       bubbles: true,
       cancelable: false,
       composed: true,
@@ -20,3 +20,45 @@ export class CCCConnectedEvent extends Event {
     this.source = detail.source;
   }
 }
+
+export class CCCConnectedEvent extends CCCEvent {
+  static eventType = "ccc:connected";
+
+  constructor(
+    detail: { component: ComponentPath; source?: string },
+    opts?: EventInit
+  ) {
+    super(CCCConnectedEvent.eventType, detail, opts);
+  }
+}
+
+export class CCCReadyEvent extends CCCEvent {
+  static eventType = "ccc:ready";
+
+  constructor(
+    detail: { component: ComponentPath; source?: string },
+    opts?: EventInit
+  ) {
+    super(CCCReadyEvent.eventType, detail, opts);
+  }
+}
+
+export class CCCViewportEvent extends CCCEvent {
+  static eventType = "ccc:viewport";
+  intersecting = false;
+  entry?: IntersectionObserverEntry;
+
+  constructor(
+    detail: {
+      component: ComponentPath;
+      source?: string;
+      intersecting: boolean;
+      entry?: IntersectionObserverEntry;
+    },
+    opts?: EventInit
+  ) {
+    super(CCCViewportEvent.eventType, detail, opts);
+    this.intersecting = detail.intersecting;
+    this.entry = detail.entry;
+  }
+}

package/src/path.ts

@@ -12,7 +12,7 @@ export class ComponentPath {
   name: string;
   versionRange: string;
 
-  constructor(path: ComponentPathType | string) {
+  constructor(path?: ComponentPathType | string) {
     const { org, repo, name, versionRange } = isValidComponentPathObject(path)
       ? path
       : ComponentPath.fromString(path);
@@ -36,12 +36,18 @@ export class ComponentPath {
     return `${this.org}/${this.repo}@${this.versionRange}/${this.name}`;
   }
 
+  get isValid(): boolean {
+    return [this.org, this.repo, this.name].every(
+      (value) => value !== "unknown"
+    );
+  }
+
   toString(): string {
     return this.path;
   }
 
-  static fromString(path: string | null, v?: string | null): ComponentPath {
-    if (!path) throw new CCCError("No path specified");
+  static fromString(p?: string | null, v?: string | null): ComponentPath {
+    const path = p ?? "unknown/unknown/unknown";
 
     const [name, repo, org] = path
       .replace(/@[^\/]+/, "")