fix build

well-known-components · Mar 18, 2024 · 77d50c2 · 77d50c2
1 parent 2128912
commit 77d50c2
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 11 deletions.
diff --git a/etc/interfaces.api.md b/etc/interfaces.api.md
@@ -25,7 +25,11 @@ export namespace IBaseComponent {
 
 // @public
 export interface IBaseComponent {
+    [START_COMPONENT]?: (startOptions: IBaseComponent.ComponentStartOptions) => Promise<void>;
+    [STOP_COMPONENT]?: () => Promise<void>;
+    // @deprecated
     start?: (startOptions: IBaseComponent.ComponentStartOptions) => Promise<void>;
+    // @deprecated
     stop?: () => Promise<void>;
 }
 
@@ -394,6 +398,12 @@ export type RequestOptions = fetch_2.RequestInit & {
 type Response_2 = fetch_2.Response;
 export { Response_2 as Response }
 
+// @public
+export const START_COMPONENT: unique symbol;
+
+// @public
+export const STOP_COMPONENT: unique symbol;
+
 // @public (undocumented)
 export type Trace = Pick<TraceContext, "traceId" | "version" | "parentId" | "traceFlags">;
 
@@ -414,10 +424,10 @@ export type TraceState = Required<Pick<TraceContext, "traceState">>["traceState"
 
 // Warnings were encountered during analysis:
 //
-// src/components/fetcher.ts:27:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Request" which is marked as @alpha
-// src/components/fetcher.ts:27:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Response" which is marked as @alpha
-// src/components/fetcher.ts:28:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Request" which is marked as @alpha
-// src/components/fetcher.ts:28:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Response" which is marked as @alpha
+// src/components/fetcher.ts:27:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Request_2" which is marked as @alpha
+// src/components/fetcher.ts:27:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Response_2" which is marked as @alpha
+// src/components/fetcher.ts:28:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Request_2" which is marked as @alpha
+// src/components/fetcher.ts:28:3 - (ae-incompatible-release-tags) The symbol "fetch" is marked as @public, but its signature references "Response_2" which is marked as @alpha
 
 // (No @packageDocumentation comment for this package)
 

diff --git a/src/components/base-component.ts b/src/components/base-component.ts
@@ -1,5 +1,13 @@
-export const START_COMPONENT = Symbol.for("wkc:START_COMPONENT");
-export const STOP_COMPONENT = Symbol.for("wkc:STOP_COMPONENT");
+/**
+ * @public
+ * Symbol to start a component, used by Lifecycle
+ */
+export const START_COMPONENT = Symbol.for("wkc:START_COMPONENT")
+/**
+ * @public
+ * Symbol to stop a component, used by Lifecycle
+ */
+export const STOP_COMPONENT = Symbol.for("wkc:STOP_COMPONENT")
 
 /**
  * @public
@@ -29,12 +37,12 @@ export namespace IBaseComponent {
 export interface IBaseComponent {
   /**
    * starts the component, i.e. it connects the database or binds the port in a listener server
-   * @deprecated Use import { START_COMPONENT } from '@well-known-components/interfaces'
+   * @deprecated - Use import \{ START_COMPONENT \} from '\@well-known-components/interfaces'
    */
   start?: (startOptions: IBaseComponent.ComponentStartOptions) => Promise<void>
   /**
    * finishes pending work and/or releases all the resources (connections, bound ports, open file descriptors)
-   * @deprecated Use import { STOP_COMPONENT } from '@well-known-components/interfaces'
+   * @deprecated - Use import \{ STOP_COMPONENT \} from '\@well-known-components/interfaces'
    */
   stop?: () => Promise<void>
 
@@ -60,5 +68,5 @@ export type IAdapterHandler<Context, ReturnType> = (context: Context) => Promise
  */
 export type IMiddlewareAdapterHandler<Context, ReturnType> = (
   context: Context,
-  next: () => Promise<ReturnType>
+  next: () => Promise<ReturnType>,
 ) => Promise<ReturnType>
diff --git a/src/utils/lifecycle.ts b/src/utils/lifecycle.ts
@@ -1,4 +1,4 @@
-import { IBaseComponent, STOP_COMPONENT } from "../components/base-component"
+import { IBaseComponent, STOP_COMPONENT, START_COMPONENT } from "../components/base-component"
 
 function stopAllComponents(components: Record<string, IBaseComponent>) {
   const pending: PromiseLike<any>[] = []
@@ -70,7 +70,7 @@ async function startComponentsLifecycle(components: Record<string, IBaseComponen
       )
     }
     if (!component) throw new Error("Null or empty components are not allowed: " + c)
-    var startFn: IBaseComponent[START_COMPONENT] = undefined
+    var startFn: IBaseComponent[typeof START_COMPONENT] = undefined
 
     if (typeof component[START_COMPONENT] == "function") {
       startFn = component[START_COMPONENT].bind(component)