revamp manifest types

sdk/lib/StartSdk.ts

@@ -23,7 +23,6 @@ import {
   PackageId,
   EnsureStorePath,
   ExtractStore,
-  DaemonReturned,
   ValidIfNoStupidEscape,
 } from "./types"
 import * as patterns from "./util/patterns"
@@ -205,7 +204,8 @@ export class StartSdk<Manifest extends SDKManifest, Store> {
           | Config<any, never>,
         Type extends Record<string, any> = ExtractConfigType<ConfigType>,
       >(
-        metaData: Omit<ActionMetadata, "input"> & {
+        id: string,
+        metadata: Omit<ActionMetadata, "input"> & {
           input: Config<Type, Store> | Config<Type, never>
         },
         fn: (options: {
@@ -213,8 +213,13 @@ export class StartSdk<Manifest extends SDKManifest, Store> {
           input: Type
         }) => Promise<ActionResult>,
       ) => {
-        const { input, ...rest } = metaData
-        return createAction<Manifest, Store, ConfigType, Type>(rest, fn, input)
+        const { input, ...rest } = metadata
+        return createAction<Manifest, Store, ConfigType, Type>(
+          id,
+          rest,
+          fn,
+          input,
+        )
       },
       getSystemSmtp: <E extends Effects>(effects: E) =>
         removeConstType<E>()(new GetSystemSmtp(effects)),
@@ -236,7 +241,8 @@ export class StartSdk<Manifest extends SDKManifest, Store> {
           | Config<any, never>,
         Type extends Record<string, any> = ExtractConfigType<ConfigType>,
       >(
-        metaData: (options: {
+        id: string,
+        metadata: (options: {
           effects: Effects
         }) => MaybePromise<Omit<ActionMetadata, "input">>,
         fn: (options: {
@@ -246,7 +252,8 @@ export class StartSdk<Manifest extends SDKManifest, Store> {
         input: Config<Type, Store> | Config<Type, never>,
       ) => {
         return createAction<Manifest, Store, ConfigType, Type>(
-          metaData,
+          id,
+          metadata,
           fn,
           input,
         )

sdk/lib/actions/createAction.ts

@@ -15,7 +15,8 @@ export class CreatedAction<
   Type extends Record<string, any> = ExtractConfigType<ConfigType>,
 > {
   private constructor(
-    public readonly myMetaData: MaybeFn<
+    public readonly id: string,
+    public readonly myMetadata: MaybeFn<
       Manifest,
       Store,
       Omit<ActionMetadata, "input">
@@ -37,12 +38,14 @@ export class CreatedAction<
       | Config<any, never>,
     Type extends Record<string, any> = ExtractConfigType<ConfigType>,
   >(
-    metaData: MaybeFn<Manifest, Store, Omit<ActionMetadata, "input">>,
+    id: string,
+    metadata: MaybeFn<Manifest, Store, Omit<ActionMetadata, "input">>,
     fn: (options: { effects: Effects; input: Type }) => Promise<ActionResult>,
     inputConfig: Config<Type, Store> | Config<Type, never>,
   ) {
     return new CreatedAction<Manifest, Store, ConfigType, Type>(
-      metaData,
+      id,
+      metadata,
       fn,
       inputConfig as Config<Type, Store>,
     )
@@ -62,15 +65,15 @@ export class CreatedAction<
     })
   }
 
-  async metaData(options: { effects: Effects }) {
-    if (this.myMetaData instanceof Function)
-      return await this.myMetaData(options)
-    return this.myMetaData
+  async metadata(options: { effects: Effects }) {
+    if (this.myMetadata instanceof Function)
+      return await this.myMetadata(options)
+    return this.myMetadata
   }
 
   async ActionMetadata(options: { effects: Effects }): Promise<ActionMetadata> {
     return {
-      ...(await this.metaData(options)),
+      ...(await this.metadata(options)),
       input: await this.input.build(options),
     }
   }

sdk/lib/actions/setupActions.ts

@@ -1,6 +1,5 @@
 import { SDKManifest } from "../manifest/ManifestTypes"
 import { Effects, ExpectedExports } from "../types"
-import { once } from "../util/once"
 import { CreatedAction } from "./createAction"
 
 export function setupActions<Manifest extends SDKManifest, Store>(
@@ -9,8 +8,7 @@ export function setupActions<Manifest extends SDKManifest, Store>(
   const myActions = async (options: { effects: Effects }) => {
     const actions: Record<string, CreatedAction<Manifest, Store, any>> = {}
     for (const action of createdActions) {
-      const actionMetadata = await action.metaData(options)
-      actions[actionMetadata.id] = action
+      actions[action.id] = action
     }
     return actions
   }

sdk/lib/types.ts

@@ -163,9 +163,10 @@ export type DaemonReturned = {
 export type ActionMetadata = {
   name: string
   description: string
-  id: string
+  warning: string | null
   input: InputSpec
-  allowedStatuses: "only-running" | "only-stopped" | "any" | "disabled"
+  disabled: boolean
+  allowedStatuses: "only-running" | "only-stopped" | "any"
   /**
    * So the ordering of the actions is by alphabetical order of the group, then followed by the alphabetical of the actions
    */