Refactor/actions (#2733)

* store, properties, manifest * interfaces * init and backups * fix init and backups * file models * more versions * dependencies * config except dynamic types * clean up config * remove disabled from non-dynamic vaues * actions * standardize example code block formats * wip: actions refactor Co-authored-by: Jade <Blu-J@users.noreply.github.com> * commit types * fix types * update types * update action request type * update apis * add description to actionrequest * clean up imports * revert package json * chore: Remove the recursive to the index * chore: Remove the other thing I was testing * flatten action requests * update container runtime with new config paradigm * new actions strategy * seems to be working * misc backend fixes * fix fe bugs * only show breakages if breakages * only show success modal if result * don't panic on failed removal * hide config from actions page * polyfill autoconfig * use metadata strategy for actions instead of prev * misc fixes * chore: split the sdk into 2 libs (#2736) * follow sideload progress (#2718) * follow sideload progress * small bugfix * shareReplay with no refcount false * don't wrap sideload progress in RPCResult * dont present toast --------- Co-authored-by: Aiden McClelland <me@drbonez.dev> * chore: Add the initial of the creation of the two sdk * chore: Add in the baseDist * chore: Add in the baseDist * chore: Get the web and the runtime-container running * chore: Remove the empty file * chore: Fix it so the container-runtime works --------- Co-authored-by: Matt Hill <MattDHill@users.noreply.github.com> Co-authored-by: Aiden McClelland <me@drbonez.dev> * misc fixes * update todos * minor clean up * fix link script * update node version in CI test * fix node version syntax in ci build * wip: fixing callbacks * fix sdk makefile dependencies * add support for const outside of main * update apis * don't panic! * Chore: Capture weird case on rpc, and log that * fix procedure id issue * pass input value for dep auto config * handle disabled and warning for actions * chore: Fix for link not having node_modules * sdk fixes * fix build * fix build * fix build --------- Co-authored-by: Matt Hill <mattnine@protonmail.com> Co-authored-by: Jade <Blu-J@users.noreply.github.com> Co-authored-by: J H <dragondef@gmail.com> Co-authored-by: Jade <2364004+Blu-J@users.noreply.github.com> Co-authored-by: Matt Hill <MattDHill@users.noreply.github.com>
2026-03-30 20:14:49 +00:00 · 2024-09-25 16:12:52 -06:00
parent eec5cf6b65
commit db0695126f
469 changed files with 16218 additions and 10485 deletions
--- a/sdk/base/lib/actions/input/builder/inputSpec.ts
+++ b/sdk/base/lib/actions/input/builder/inputSpec.ts
@@ -0,0 +1,137 @@
+import { ValueSpec } from "../inputSpecTypes"
+import { Value } from "./value"
+import { _ } from "../../../util"
+import { Effects } from "../../../Effects"
+import { Parser, object } from "ts-matches"
+
+export type LazyBuildOptions<Store> = {
+  effects: Effects
+}
+export type LazyBuild<Store, ExpectedOut> = (
+  options: LazyBuildOptions<Store>,
+) => Promise<ExpectedOut> | ExpectedOut
+
+// prettier-ignore
+export type ExtractInputSpecType<A extends Record<string, any> | InputSpec<Record<string, any>, any> | InputSpec<Record<string, any>, never>> = 
+  A extends InputSpec<infer B, any> | InputSpec<infer B, never> ? B :
+  A
+
+export type InputSpecOf<A extends Record<string, any>, Store = never> = {
+  [K in keyof A]: Value<A[K], Store>
+}
+
+export type MaybeLazyValues<A> = LazyBuild<any, A> | A
+/**
+ * InputSpecs are the specs that are used by the os input specification form for this service.
+ * Here is an example of a simple input specification
+  ```ts
+    const smallInputSpec = InputSpec.of({
+      test: Value.boolean({
+        name: "Test",
+        description: "This is the description for the test",
+        warning: null,
+        default: false,
+      }),
+    });
+  ```
+
+  The idea of an inputSpec is that now the form is going to ask for
+  Test: [ ] and the value is going to be checked as a boolean.
+  There are more complex values like selects, lists, and objects. See {@link Value}
+
+  Also, there is the ability to get a validator/parser from this inputSpec spec.
+  ```ts
+  const matchSmallInputSpec = smallInputSpec.validator();
+  type SmallInputSpec = typeof matchSmallInputSpec._TYPE;
+  ```
+
+  Here is an example of a more complex input specification which came from an input specification for a service
+  that works with bitcoin, like c-lightning.
+  ```ts
+
+    export const hostname = Value.string({
+  name: "Hostname",
+  default: null,
+  description: "Domain or IP address of bitcoin peer",
+  warning: null,
+  required: true,
+  masked: false,
+  placeholder: null,
+  pattern:
+    "(^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)|(^[a-z2-7]{16}\\.onion$)|(^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$))",
+  patternDescription:
+    "Must be either a domain name, or an IPv4 or IPv6 address. Do not include protocol scheme (eg 'http://') or port.",
+});
+export const port = Value.number({
+  name: "Port",
+  default: null,
+  description: "Port that peer is listening on for inbound p2p connections",
+  warning: null,
+  required: false,
+  range: "[0,65535]",
+  integral: true,
+  units: null,
+  placeholder: null,
+});
+export const addNodesSpec = InputSpec.of({ hostname: hostname, port: port });
+
+  ```
+ */
+export class InputSpec<Type extends Record<string, any>, Store = never> {
+  private constructor(
+    private readonly spec: {
+      [K in keyof Type]: Value<Type[K], Store> | Value<Type[K], never>
+    },
+    public validator: Parser<unknown, Type>,
+  ) {}
+  async build(options: LazyBuildOptions<Store>) {
+    const answer = {} as {
+      [K in keyof Type]: ValueSpec
+    }
+    for (const k in this.spec) {
+      answer[k] = await this.spec[k].build(options as any)
+    }
+    return answer
+  }
+
+  static of<
+    Spec extends Record<string, Value<any, Store> | Value<any, never>>,
+    Store = never,
+  >(spec: Spec) {
+    const validatorObj = {} as {
+      [K in keyof Spec]: Parser<unknown, any>
+    }
+    for (const key in spec) {
+      validatorObj[key] = spec[key].validator
+    }
+    const validator = object(validatorObj)
+    return new InputSpec<
+      {
+        [K in keyof Spec]: Spec[K] extends
+          | Value<infer T, Store>
+          | Value<infer T, never>
+          ? T
+          : never
+      },
+      Store
+    >(spec, validator as any)
+  }
+
+  /**
+   * Use this during the times that the input needs a more specific type.
+   * Used in types that the value/ variant/ list/ inputSpec is constructed somewhere else.
+  ```ts
+  const a = InputSpec.text({
+    name: "a",
+    required: false,
+  })
+
+  return InputSpec.of<Store>()({
+    myValue: a.withStore(),
+  })
+  ```
+   */
+  withStore<NewStore extends Store extends never ? any : Store>() {
+    return this as any as InputSpec<Type, NewStore>
+  }
+}