@highstate/contract 0.7.2 → 0.7.4

package/src/types.ts

@@ -0,0 +1,45 @@
+import {
+  type Static,
+  type TAny,
+  type TArray,
+  type TBoolean,
+  type TLiteral,
+  type TNumber,
+  type TRecordOrObject,
+  type TString,
+  type TUnion,
+} from "@sinclair/typebox"
+
+export type ArgumentValueSchema =
+  | TString
+  | TNumber
+  | TBoolean
+  | TArray<TString>
+  | TArray<TNumber>
+  | TUnion<TLiteral[]>
+  | TRecordOrObject<TString, TAny>
+  | TArray
+
+export type ArgumentValue = Static<ArgumentValueSchema>
+
+/**
+ * The generic metadata of some contract.
+ */
+export type Meta = {
+  /**
+   * The display name of the entity which can be shown in the UI.
+   */
+  displayName?: string
+
+  /**
+   * The description of the entity which can be shown in the UI.
+   */
+  description?: string
+
+  /**
+   * The hex color of the entity which can be used in the UI.
+   *
+   * @example "#ff0000"
+   */
+  color?: string
+}

package/src/unit.ts

@@ -0,0 +1,102 @@
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+
+import type { ArgumentValue } from "./types"
+import type { InstanceInput } from "./instance"
+import { mapValues } from "remeda"
+import {
+  type ArgumentOptionsMapToStatic,
+  type Component,
+  type ComponentArgument,
+  type ComponentArgumentOptions,
+  type ComponentInputOptions,
+  type ComponentInputOptionsMapToSpecMap,
+  type ComponentInputSpec,
+  type ComponentModel,
+  type ComponentOptions,
+  defineComponent,
+  mapArgument,
+} from "./component"
+
+type UnitOptions<
+  TArgs extends Record<string, ComponentArgumentOptions>,
+  TInputs extends Record<string, ComponentInputOptions>,
+  TOutputs extends Record<string, ComponentInputOptions>,
+  TSecrets extends Record<string, ComponentArgumentOptions>,
+> = Omit<ComponentOptions<TArgs, TInputs, TOutputs>, "create"> & {
+  source: UnitSource
+
+  secrets?: TSecrets
+}
+
+export type UnitSource = {
+  package: string
+  path?: string
+  version?: string
+}
+
+export type UnitModel = ComponentModel & {
+  /**
+   * The source of the unit.
+   */
+  source: UnitSource
+
+  /**
+   * The record of the secret argument schemas.
+   */
+  secrets: Record<string, ComponentArgument>
+}
+
+export type Unit<
+  TArgs extends Record<string, ArgumentValue> = Record<string, never>,
+  TInputs extends Record<string, ComponentInputSpec> = Record<string, never>,
+  TOutputs extends Record<string, ComponentInputSpec> = Record<string, never>,
+  TSecrets extends Record<string, ArgumentValue> = Record<string, never>,
+> = Component<TArgs, TInputs, TOutputs> & {
+  __secrets: TSecrets
+
+  model: UnitModel
+}
+
+export function isUnitModel(model: ComponentModel): model is UnitModel {
+  return "source" in model
+}
+
+export function defineUnit<
+  TArgs extends Record<string, ComponentArgumentOptions> = Record<string, never>,
+  TInputs extends Record<string, ComponentInputOptions> = Record<string, never>,
+  TOutputs extends Record<string, ComponentInputOptions> = Record<string, never>,
+  TSecrets extends Record<string, ComponentArgumentOptions> = Record<string, never>,
+>(
+  options: UnitOptions<TArgs, TInputs, TOutputs, TSecrets>,
+): Unit<
+  ArgumentOptionsMapToStatic<TArgs>,
+  ComponentInputOptionsMapToSpecMap<TInputs>,
+  ComponentInputOptionsMapToSpecMap<TOutputs>,
+  ArgumentOptionsMapToStatic<TSecrets>
+> {
+  const component = defineComponent<TArgs, TInputs, TOutputs>({
+    ...options,
+
+    create({ id }) {
+      const outputs: Record<string, InstanceInput[]> = {}
+      for (const key in options.outputs ?? {}) {
+        outputs[key] = [
+          {
+            instanceId: id,
+            output: key,
+          },
+        ]
+      }
+
+      return outputs as any
+    },
+  }) as any
+
+  component.model.source = options.source ?? {}
+  component.model.secrets = mapValues(options.secrets ?? {}, mapArgument)
+
+  return component
+}

package/src/utils.ts

@@ -0,0 +1,89 @@
+export type EntityMap<T> = Record<string, T> & {
+  default?: T
+}
+
+export type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+export type RequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+
+// TODO: refactor this shit
+
+type PickUndefinedKeys<T extends Record<string, unknown>> = T extends Record<string, never>
+  ? never
+  : Exclude<
+      {
+        [K in keyof T]: undefined extends T[K] ? K : never
+      }[keyof T],
+      undefined
+    >
+
+type AllOptionalKeys<T extends Record<string, unknown>> = T extends Record<string, never>
+  ? never
+  : Exclude<
+      {
+        [K in keyof T]: undefined extends T[K] ? K : never
+      }[keyof T],
+      undefined
+    >
+
+type HasRequired<T extends Record<string, unknown>> = T extends Record<string, never>
+  ? false
+  : [keyof T] extends [AllOptionalKeys<T>]
+  ? false
+  : true
+
+type PickRecordsWithAnyRequired<T extends Record<string, Record<string, unknown>>> =
+  T extends Record<string, never>
+    ? never
+    : Exclude<
+        {
+          [K in keyof T]: HasRequired<T[K]> extends true ? K : never
+        }[keyof T],
+        undefined
+      >
+
+export type OptionalEmptyRecords<T extends Record<string, Record<string, unknown>>> = {
+  [K in Exclude<keyof T, PickRecordsWithAnyRequired<T>>]?: OptionalUndefinedFields<T[K]>
+} & {
+  [K in PickRecordsWithAnyRequired<T>]: OptionalUndefinedFields<T[K]>
+}
+
+export type OptionalUndefinedFields<T extends Record<string, unknown>> = {
+  [K in PickUndefinedKeys<T>]?: T[K]
+} & {
+  [K in Exclude<keyof T, PickUndefinedKeys<T>>]: T[K]
+}
+
+/**
+ * Formats a multiline string and trims the indentation.
+ *
+ * @param str The string to trim.
+ * @returns The trimmed string.
+ */
+export function text(array: TemplateStringsArray, ...values: unknown[]): string {
+  const str = array.reduce(
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    (result, part, i) => result + part + (values[i] ? String(values[i]) : ""),
+    "",
+  )
+
+  return trimIndentation(str)
+}
+
+/**
+ * Removes the indentation from a multiline string.
+ *
+ * @param text The text to trim.
+ * @returns The trimmed text.
+ */
+export function trimIndentation(text: string): string {
+  const lines = text.split("\n")
+  const indent = lines
+    .filter(line => line.trim() !== "")
+    .map(line => line.match(/^\s*/)?.[0].length ?? 0)
+    .reduce((min, indent) => Math.min(min, indent), Infinity)
+
+  return lines
+    .map(line => line.slice(indent))
+    .join("\n")
+    .trim()
+}

package/dist/index.d.ts

@@ -1,326 +0,0 @@
-import { Static, TString, TNumber, TBoolean, TArray, TUnion, TLiteral, TRecordOrObject, TAny, TSchema, TAnySchema, TOptional, TObject } from '@sinclair/typebox';
-export { Static, Type } from '@sinclair/typebox';
-
-declare const InstanceType: unique symbol;
-type InstanceInput<TType extends string = string> = {
-    [InstanceType]?: TType;
-    instanceId: string;
-    output: string;
-};
-type HubInput = {
-    hubId: string;
-};
-type Position = {
-    x: number;
-    y: number;
-};
-type InstanceModel = {
-    /**
-     * The id of the instance unique within the project.
-     *
-     * The format is `${instanceType}:${instanceName}`.
-     */
-    id: string;
-    /**
-     * The type of the instance.
-     */
-    type: string;
-    /**
-     * The name of the instance.
-     *
-     * Must be unique within instances of the same type in the project.
-     */
-    name: string;
-    /**
-     * The static arguments passed to the instance.
-     */
-    args?: Record<string, unknown>;
-    /**
-     * The direct instances passed as inputs to the instance.
-     */
-    inputs?: Record<string, InstanceInput[]>;
-    /**
-     * The inputs passed to the instance from the hubs.
-     *
-     * Only for designer-first instances.
-     */
-    hubInputs?: Record<string, HubInput[]>;
-    /**
-     * The inputs injected to the instance from the hubs.
-     *
-     * While `hubInputs` allows to pass hubs to distinct inputs,
-     * `injectionInputs` allows to pass hubs to the instance as a whole filling all inputs with matching types.
-     *
-     * Only for designer-first instances.
-     */
-    injectionInputs?: HubInput[];
-    /**
-     * The position of the instance on the canvas.
-     *
-     * Only for designer-first instances.
-     */
-    position?: Position;
-    /**
-     * The id of the parent instance.
-     *
-     * Only for child instances of the composite instances.
-     */
-    parentId?: string;
-    /**
-     * The direct instance inputs which instance returns as outputs.
-     *
-     * Only for computed composite instances.
-     */
-    outputs?: Record<string, InstanceInput[]>;
-};
-/**
- * Formats the instance id from the instance type and instance name.
- *
- * @param instanceType The type of the instance.
- * @param instanceName The name of the instance.
- *
- * @returns The formatted instance id.
- */
-declare function getInstanceId(instanceType: string, instanceName: string): string;
-/**
- * Parses the instance id into the instance type and instance name.
- *
- * @param instanceId The instance id to parse.
- *
- * @returns The instance type and instance name.
- */
-declare function parseInstanceId(instanceId: string): [instanceType: string, instanceName: string];
-
-type CompositeInstance = {
-    instance: InstanceModel;
-    children: InstanceModel[];
-};
-declare function resetEvaluation(): void;
-declare function getInstances(): readonly InstanceModel[];
-declare function getCompositeInstances(): readonly CompositeInstance[];
-
-type ArgumentValueSchema = TString | TNumber | TBoolean | TArray<TString> | TArray<TNumber> | TUnion<TLiteral[]> | TRecordOrObject<TString, TAny> | TArray;
-type ArgumentValue = Static<ArgumentValueSchema>;
-/**
- * The generic metadata of some contract.
- */
-type Meta = {
-    /**
-     * The display name of the entity which can be shown in the UI.
-     */
-    displayName?: string;
-    /**
-     * The description of the entity which can be shown in the UI.
-     */
-    description?: string;
-    /**
-     * The hex color of the entity which can be used in the UI.
-     *
-     * @example "#ff0000"
-     */
-    color?: string;
-};
-
-type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-type RequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-type ListRequiredKeys<T extends Record<string, unknown>> = T extends Record<string, never> ? never : {
-    [K in keyof T]-?: undefined extends T[K] ? never : K;
-}[keyof T];
-type PickOptionalRecords<T extends Record<string, Record<string, unknown>>> = {
-    [K in keyof T]: ListRequiredKeys<T[K]> extends never ? K : never;
-}[keyof T];
-type PickRequiredRecords<T extends Record<string, Record<string, unknown>>> = {
-    [K in keyof T]: ListRequiredKeys<T[K]> extends never ? never : K;
-}[keyof T];
-type OptionalEmptyRecords<T extends Record<string, Record<string, unknown>>> = {
-    [K in PickOptionalRecords<T>]?: T[K];
-} & {
-    [K in PickRequiredRecords<T>]: T[K];
-};
-type PickUndefinedKeys<T extends Record<string, unknown>> = {
-    [K in keyof T]: undefined extends T[K] ? K : never;
-}[keyof T];
-type OptionalUndefinedFields<T extends Record<string, unknown>> = {
-    [K in PickUndefinedKeys<T>]?: T[K];
-} & {
-    [K in Exclude<keyof T, PickUndefinedKeys<T>>]: T[K];
-};
-/**
- * Formats a multiline string and trims the indentation.
- *
- * @param str The string to trim.
- * @returns The trimmed string.
- */
-declare function text(array: TemplateStringsArray, ...values: unknown[]): string;
-/**
- * Removes the indentation from a multiline string.
- *
- * @param text The text to trim.
- * @returns The trimmed text.
- */
-declare function trimIndentation(text: string): string;
-
-/**
- * The entity is some abstract object which can be passed from one component to another through their inputs and outputs.
- * Every entity must have a type.
- * Every component inputs and outputs will reference such types and only entities of the same type can be passed.
- */
-type Entity<TType extends string = string, TEntitySchema extends TSchema = TSchema> = {
-    /**
-     * The static type of the entity.
-     */
-    type: TType;
-    /**
-     * The JSON schema of the entity value.
-     */
-    schema: TEntitySchema;
-    /**
-     * The extra metadata of the entity.
-     */
-    meta: Meta;
-};
-type EntityOptions<TType extends string, TSchema extends TAnySchema> = PartialKeys<Entity<TType, TSchema>, "meta">;
-declare function defineEntity<TType extends string, TSchema extends TAnySchema>(options: EntityOptions<TType, TSchema>): Entity<TType, TSchema>;
-declare function isEntity(value: unknown): value is Entity;
-
-type ComponentArgument = {
-    schema: ArgumentValueSchema;
-    required: boolean;
-    meta: Meta;
-};
-type ComponentArgumentFullOptions = Meta & {
-    schema: ArgumentValueSchema;
-    required?: boolean;
-};
-type ComponentArgumentOptions = ArgumentValueSchema | ComponentArgumentFullOptions;
-type ComponentArgumentOptionsToSchema<T extends ComponentArgumentOptions> = T extends TSchema ? T : T["required"] extends false ? TOptional<T["schema"]> : T["schema"];
-type ComponentArgumentMapToValue<T extends Record<string, ComponentArgumentOptions>> = {
-    [K in keyof T]: Static<ComponentArgumentOptionsToSchema<T[K]>>;
-};
-type ComponentInput = {
-    type: string;
-    required: boolean;
-    multiple: boolean;
-    meta: Meta;
-};
-type ComponentInputFullOptions = Meta & {
-    entity: Entity;
-    required?: boolean;
-    multiple?: boolean;
-};
-type ComponentInputOptions = Entity | ComponentInputFullOptions;
-type ComponentInputOptionsToOutputRef<T extends ComponentInputOptions> = T extends Entity ? InstanceInput<T["type"]> : T extends ComponentInputFullOptions ? T["required"] extends false ? T["multiple"] extends true ? InstanceInput<T["entity"]["type"]>[] | undefined : InstanceInput<T["entity"]["type"]> | undefined : T["multiple"] extends true ? InstanceInput<T["entity"]["type"]>[] : InstanceInput<T["entity"]["type"]> : never;
-type ComponentInputSpec = [entity: Entity, required: boolean, multiple: boolean];
-type ComponentInputOptionsToSpec<T extends ComponentInputOptions> = T extends Entity ? [T, true, false] : T extends ComponentInputFullOptions ? T["required"] extends false ? T["multiple"] extends true ? [T["entity"], false, true] : [T["entity"], false, false] : T["multiple"] extends true ? [T["entity"], true, true] : [T["entity"], true, false] : never;
-type ComponentInputOptionsMapToSpecMap<T extends Record<string, ComponentInputOptions>> = T extends Record<string, never> ? Record<string, never> : {
-    [K in keyof T]: ComponentInputOptionsToSpec<T[K]>;
-};
-type ComponentInputMapToValue<T extends Record<string, ComponentInputOptions>> = OptionalUndefinedFields<{
-    [K in keyof T]: ComponentInputOptionsToOutputRef<T[K]>;
-}>;
-type ComponentInputMapToReturnType<T extends Record<string, ComponentInputOptions>> = T extends Record<string, never> ? void : ComponentInputMapToValue<T>;
-type ComponentParams<TArgs extends Record<string, ComponentArgumentOptions>, TInputs extends Record<string, ComponentInputOptions>> = {
-    id: string;
-    name: string;
-    args: ComponentArgumentMapToValue<TArgs>;
-    inputs: ComponentInputMapToValue<TInputs>;
-};
-type InputComponentParams<TArgs extends Record<string, ArgumentValue>, TInputs extends Record<string, unknown>> = {
-    name: string;
-} & OptionalEmptyRecords<{
-    args: TArgs;
-    inputs: TInputs;
-}>;
-type ComponentOptions<TArgs extends Record<string, ComponentArgumentOptions>, TInputs extends Record<string, ComponentInputOptions>, TOutputs extends Record<string, ComponentInputOptions>> = {
-    type: string;
-    meta?: ComponentMeta;
-    args?: TArgs;
-    inputs?: TInputs;
-    outputs?: TOutputs;
-    create: (params: ComponentParams<TArgs, TInputs>) => ComponentInputMapToReturnType<TOutputs>;
-};
-type ComponentMeta = Meta & {
-    primaryIcon?: string;
-    primaryIconColor?: string;
-    secondaryIcon?: string;
-    secondaryIconColor?: string;
-    category?: string;
-    defaultNamePrefix?: string;
-};
-type ComponentModel = {
-    /**
-     * The type of the component.
-     */
-    type: string;
-    /**
-     * The record of the argument schemas.
-     */
-    args: Record<string, ComponentArgument>;
-    /**
-     * The record of the input schemas.
-     */
-    inputs: Record<string, ComponentInput>;
-    /**
-     * The record of the output schemas.
-     */
-    outputs: Record<string, ComponentInput>;
-    /**
-     * The extra metadata of the component.
-     */
-    meta: ComponentMeta;
-};
-type InputSpecToOutputRef<T extends ComponentInputSpec> = T[1] extends true ? T[2] extends true ? InstanceInput<T[0]["type"]>[] : InstanceInput<T[0]["type"]> : T[2] extends true ? InstanceInput<T[0]["type"]>[] | undefined : InstanceInput<T[0]["type"]> | undefined;
-type OutputRefMap<TInputs extends Record<string, ComponentInputSpec>> = TInputs extends Record<string, [string, never, never]> ? Record<string, never> : {
-    [K in keyof TInputs]: InputSpecToOutputRef<TInputs[K]>;
-};
-type Component<TArgs extends Record<string, ArgumentValue> = Record<string, never>, TInputs extends Record<string, ComponentInputSpec> = Record<string, never>, TOutputs extends Record<string, ComponentInputSpec> = Record<string, never>> = {
-    /**
-     * The non-generic model of the component.
-     */
-    model: ComponentModel;
-    /**
-     * The entities used in the inputs or outputs of the component.
-     */
-    entities: Map<string, Entity>;
-    /**
-     * Creates the component at the evaluation time.
-     */
-    (context: InputComponentParams<TArgs, OutputRefMap<TInputs>>): OutputRefMap<TOutputs>;
-};
-type ArgumentOptionsMapToStatic<T extends Record<string, ComponentArgumentOptions>> = T extends Record<string, never> ? Record<string, never> : Static<TObject<{
-    [K in keyof T]: ComponentArgumentOptionsToSchema<T[K]>;
-}>>;
-declare function defineComponent<TArgs extends Record<string, ComponentArgumentOptions> = Record<string, never>, TInputs extends Record<string, ComponentInputOptions> = Record<string, never>, TOutputs extends Record<string, ComponentInputOptions> = Record<string, never>>(options: ComponentOptions<TArgs, TInputs, TOutputs>): Component<ArgumentOptionsMapToStatic<TArgs>, ComponentInputOptionsMapToSpecMap<TInputs>, ComponentInputOptionsMapToSpecMap<TOutputs>>;
-declare function isComponent(value: unknown): value is Component;
-
-type UnitOptions<TArgs extends Record<string, ComponentArgumentOptions>, TInputs extends Record<string, ComponentInputOptions>, TOutputs extends Record<string, ComponentInputOptions>, TSecrets extends Record<string, ComponentArgumentOptions>> = Omit<ComponentOptions<TArgs, TInputs, TOutputs>, "create"> & {
-    source?: UnitSource;
-    secrets?: TSecrets;
-};
-type UnitSource = {
-    type: "npm";
-    package: string;
-    path?: string;
-    version?: string;
-} | {
-    type: "local";
-    path?: string;
-};
-type UnitModel = ComponentModel & {
-    /**
-     * The source of the unit.
-     */
-    source?: UnitSource;
-    /**
-     * The record of the secret argument schemas.
-     */
-    secrets: Record<string, ComponentArgument>;
-};
-type Unit<TArgs extends Record<string, ArgumentValue> = Record<string, never>, TInputs extends Record<string, ComponentInputSpec> = Record<string, never>, TOutputs extends Record<string, ComponentInputSpec> = Record<string, never>, TSecrets extends Record<string, ArgumentValue> = Record<string, never>> = Component<TArgs, TInputs, TOutputs> & {
-    __secrets: TSecrets;
-    model: UnitModel;
-};
-declare function isUnitModel(model: ComponentModel): model is UnitModel;
-declare function defineUnit<TArgs extends Record<string, ComponentArgumentOptions> = Record<string, never>, TInputs extends Record<string, ComponentInputOptions> = Record<string, never>, TOutputs extends Record<string, ComponentInputOptions> = Record<string, never>, TSecrets extends Record<string, ComponentArgumentOptions> = Record<string, never>>(options: UnitOptions<TArgs, TInputs, TOutputs, TSecrets>): Unit<ArgumentOptionsMapToStatic<TArgs>, ComponentInputOptionsMapToSpecMap<TInputs>, ComponentInputOptionsMapToSpecMap<TOutputs>, ArgumentOptionsMapToStatic<TSecrets>>;
-
-export { type ArgumentValue, type ArgumentValueSchema, type Component, type ComponentArgument, type ComponentInput, type ComponentInputSpec, type ComponentMeta, type ComponentModel, type CompositeInstance, type Entity, type HubInput, type InstanceInput, type InstanceModel, type PartialKeys, type Position, type RequiredKeys, type Unit, type UnitModel, type UnitSource, defineComponent, defineEntity, defineUnit, getCompositeInstances, getInstanceId, getInstances, isComponent, isEntity, isUnitModel, parseInstanceId, resetEvaluation, text, trimIndentation };