@start9labs/start-sdk 0.3.6-alpha5 → 0.3.6-alpha7

package/cjs/lib/config/configTypes.d.ts

@@ -3,43 +3,72 @@ export type ValueType = "text" | "textarea" | "number" | "color" | "datetime" |
 export type ValueSpec = ValueSpecOf<ValueType>;
 /** core spec types. These types provide the metadata for performing validations */
 export type ValueSpecOf<T extends ValueType> = T extends "text" ? ValueSpecText : T extends "textarea" ? ValueSpecTextarea : T extends "number" ? ValueSpecNumber : T extends "color" ? ValueSpecColor : T extends "datetime" ? ValueSpecDatetime : T extends "toggle" ? ValueSpecToggle : T extends "select" ? ValueSpecSelect : T extends "multiselect" ? ValueSpecMultiselect : T extends "list" ? ValueSpecList : T extends "object" ? ValueSpecObject : T extends "file" ? ValueSpecFile : T extends "union" ? ValueSpecUnion : never;
-export interface ValueSpecText extends ListValueSpecText, WithStandalone {
+export type ValueSpecText = {
+    name: string;
+    description: string | null;
+    warning: string | null;
+    type: "text";
+    patterns: Pattern[];
+    minLength: number | null;
+    maxLength: number | null;
+    masked: boolean;
+    inputmode: "text" | "email" | "tel" | "url";
+    placeholder: string | null;
     required: boolean;
     default: DefaultString | null;
     disabled: false | string;
     generate: null | RandomString;
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecTextarea extends WithStandalone {
+};
+export type ValueSpecTextarea = {
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "textarea";
     placeholder: string | null;
     minLength: number | null;
     maxLength: number | null;
     required: boolean;
     disabled: false | string;
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
+};
 export type FilePath = {
     filePath: string;
 };
-export interface ValueSpecNumber extends ListValueSpecNumber, WithStandalone {
+export type ValueSpecNumber = {
+    type: "number";
+    min: number | null;
+    max: number | null;
+    integer: boolean;
+    step: number | null;
+    units: string | null;
+    placeholder: string | null;
+    name: string;
+    description: string | null;
+    warning: string | null;
     required: boolean;
     default: number | null;
     disabled: false | string;
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecColor extends WithStandalone {
+};
+export type ValueSpecColor = {
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "color";
     required: boolean;
     default: string | null;
     disabled: false | string;
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecDatetime extends WithStandalone {
+};
+export type ValueSpecDatetime = {
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "datetime";
     required: boolean;
     inputmode: "date" | "time" | "datetime-local";
@@ -47,10 +76,14 @@ export interface ValueSpecDatetime extends WithStandalone {
     max: string | null;
     default: string | null;
     disabled: false | string;
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecSelect extends SelectBase, WithStandalone {
+};
+export type ValueSpecSelect = {
+    values: Record<string, string>;
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "select";
     required: boolean;
     default: string | null;
@@ -60,10 +93,14 @@ export interface ValueSpecSelect extends SelectBase, WithStandalone {
      *           string[] means that the options are disabled
      */
     disabled: false | string | string[];
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecMultiselect extends SelectBase, WithStandalone {
+};
+export type ValueSpecMultiselect = {
+    values: Record<string, string>;
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "multiselect";
     minLength: number | null;
     maxLength: number | null;
@@ -74,17 +111,23 @@ export interface ValueSpecMultiselect extends SelectBase, WithStandalone {
      */
     disabled: false | string | string[];
     default: string[];
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecToggle extends WithStandalone {
+};
+export type ValueSpecToggle = {
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "toggle";
     default: boolean | null;
     disabled: false | string;
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecUnion extends WithStandalone {
+};
+export type ValueSpecUnion = {
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "union";
     variants: Record<string, {
         name: string;
@@ -98,44 +141,45 @@ export interface ValueSpecUnion extends WithStandalone {
     disabled: false | string | string[];
     required: boolean;
     default: string | null;
-    /** Immutable means it can only be configed at the first config then never again */
+    /** Immutable means it can only be configured at the first config then never again */
     immutable: boolean;
-}
-export interface ValueSpecFile extends WithStandalone {
+};
+export type ValueSpecFile = {
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "file";
     extensions: string[];
     required: boolean;
-}
-export interface ValueSpecObject extends WithStandalone {
-    type: "object";
-    spec: InputSpec;
-}
-export interface WithStandalone {
+};
+export type ValueSpecObject = {
     name: string;
     description: string | null;
     warning: string | null;
-}
-export interface SelectBase {
-    values: Record<string, string>;
-}
-export type ListValueSpecType = "text" | "number" | "object";
+    type: "object";
+    spec: InputSpec;
+};
+export type ListValueSpecType = "text" | "object";
 /** represents a spec for the values of a list */
-export type ListValueSpecOf<T extends ListValueSpecType> = T extends "text" ? ListValueSpecText : T extends "number" ? ListValueSpecNumber : T extends "object" ? ListValueSpecObject : never;
+export type ListValueSpecOf<T extends ListValueSpecType> = T extends "text" ? ListValueSpecText : T extends "object" ? ListValueSpecObject : never;
 /** represents a spec for a list */
 export type ValueSpecList = ValueSpecListOf<ListValueSpecType>;
-export interface ValueSpecListOf<T extends ListValueSpecType> extends WithStandalone {
+export type ValueSpecListOf<T extends ListValueSpecType> = {
+    name: string;
+    description: string | null;
+    warning: string | null;
     type: "list";
     spec: ListValueSpecOf<T>;
     minLength: number | null;
     maxLength: number | null;
     disabled: false | string;
-    default: string[] | number[] | DefaultString[] | Record<string, unknown>[] | readonly string[] | readonly number[] | readonly DefaultString[] | readonly Record<string, unknown>[];
-}
-export interface Pattern {
+    default: string[] | DefaultString[] | Record<string, unknown>[] | readonly string[] | readonly DefaultString[] | readonly Record<string, unknown>[];
+};
+export type Pattern = {
     regex: string;
     description: string;
-}
-export interface ListValueSpecText {
+};
+export type ListValueSpecText = {
     type: "text";
     patterns: Pattern[];
     minLength: number | null;
@@ -144,17 +188,8 @@ export interface ListValueSpecText {
     generate: null | RandomString;
     inputmode: "text" | "email" | "tel" | "url";
     placeholder: string | null;
-}
-export interface ListValueSpecNumber {
-    type: "number";
-    min: number | null;
-    max: number | null;
-    integer: boolean;
-    step: number | null;
-    units: string | null;
-    placeholder: string | null;
-}
-export interface ListValueSpecObject {
+};
+export type ListValueSpecObject = {
     type: "object";
     /** this is a mapped type of the config object at this level, replacing the object's values with specs on those values */
     spec: InputSpec;
@@ -162,7 +197,7 @@ export interface ListValueSpecObject {
     uniqueBy: UniqueBy;
     /** this should be a handlebars template which can make use of the entire config which corresponds to 'spec' */
     displayAs: string | null;
-}
+};
 export type UniqueBy = null | string | {
     any: readonly UniqueBy[] | UniqueBy[];
 } | {
@@ -176,7 +211,3 @@ export type RandomString = {
 export declare function isValueSpecListOf<S extends ListValueSpecType>(t: ValueSpec, s: S): t is ValueSpecListOf<S> & {
     spec: ListValueSpecOf<S>;
 };
-export declare const unionSelectKey: "unionSelectKey";
-export type UnionSelectKey = typeof unionSelectKey;
-export declare const unionValueKey: "unionValueKey";
-export type UnionValueKey = typeof unionValueKey;

package/cjs/lib/config/configTypes.js

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unionValueKey = exports.unionSelectKey = exports.isValueSpecListOf = void 0;
+exports.isValueSpecListOf = void 0;
 // sometimes the type checker needs just a little bit of help
 function isValueSpecListOf(t, s) {
     return "spec" in t && t.spec.type === s;
 }
 exports.isValueSpecListOf = isValueSpecListOf;
-exports.unionSelectKey = "unionSelectKey";
-exports.unionValueKey = "unionValueKey";
 //# sourceMappingURL=configTypes.js.map

package/cjs/lib/config/configTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"configTypes.js","sourceRoot":"","sources":["../../../../lib/config/configTypes.ts"],"names":[],"mappings":";;;AA6OA,6DAA6D;AAC7D,SAAgB,iBAAiB,CAC/B,CAAY,EACZ,CAAI;IAEJ,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAA;AACzC,CAAC;AALD,8CAKC;AACY,QAAA,cAAc,GAAG,gBAAyB,CAAA;AAG1C,QAAA,aAAa,GAAG,eAAwB,CAAA"}
+{"version":3,"file":"configTypes.js","sourceRoot":"","sources":["../../../../lib/config/configTypes.ts"],"names":[],"mappings":";;;AAyQA,6DAA6D;AAC7D,SAAgB,iBAAiB,CAC/B,CAAY,EACZ,CAAI;IAEJ,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAA;AACzC,CAAC;AALD,8CAKC"}

package/cjs/lib/config/setupConfig.d.ts

@@ -1,5 +1,4 @@
-import { Effects, ExpectedExports } from "../types";
-import { SDKManifest } from "../manifest/ManifestTypes";
+import * as T from "../types";
 import { Config, ExtractConfigType } from "./builder/config";
 import { InterfacesReceipt as InterfacesReceipt } from "../interfaces/setupInterfaces";
 declare const dependencyProof: unique symbol;
@@ -7,15 +6,15 @@ export type DependenciesReceipt = void & {
     [dependencyProof]: never;
 };
 export type Save<A extends Record<string, any> | Config<Record<string, any>, any> | Config<Record<string, never>, never>> = (options: {
-    effects: Effects;
+    effects: T.Effects;
     input: ExtractConfigType<A> & Record<string, any>;
 }) => Promise<{
     dependenciesReceipt: DependenciesReceipt;
     interfacesReceipt: InterfacesReceipt;
     restart: boolean;
 }>;
-export type Read<Manifest extends SDKManifest, Store, A extends Record<string, any> | Config<Record<string, any>, any> | Config<Record<string, any>, never>> = (options: {
-    effects: Effects;
+export type Read<Manifest extends T.Manifest, Store, A extends Record<string, any> | Config<Record<string, any>, any> | Config<Record<string, any>, never>> = (options: {
+    effects: T.Effects;
 }) => Promise<void | (ExtractConfigType<A> & Record<string, any>)>;
 /**
  * We want to setup a config export with a get and set, this
@@ -24,8 +23,8 @@ export type Read<Manifest extends SDKManifest, Store, A extends Record<string, a
  * @param options
  * @returns
  */
-export declare function setupConfig<Store, ConfigType extends Record<string, any> | Config<any, any> | Config<any, never>, Manifest extends SDKManifest, Type extends Record<string, any> = ExtractConfigType<ConfigType>>(spec: Config<Type, Store> | Config<Type, never>, write: Save<Type>, read: Read<Manifest, Store, Type>): {
-    setConfig: ExpectedExports.setConfig;
-    getConfig: ExpectedExports.getConfig;
+export declare function setupConfig<Store, ConfigType extends Record<string, any> | Config<any, any> | Config<any, never>, Manifest extends T.Manifest, Type extends Record<string, any> = ExtractConfigType<ConfigType>>(spec: Config<Type, Store> | Config<Type, never>, write: Save<Type>, read: Read<Manifest, Store, Type>): {
+    setConfig: T.ExpectedExports.setConfig;
+    getConfig: T.ExpectedExports.getConfig;
 };
 export default setupConfig;

package/cjs/lib/config/setupConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"setupConfig.js","sourceRoot":"","sources":["../../../../lib/config/setupConfig.ts"],"names":[],"mappings":";;;;;;AAIA,sEAA6C;AA+B7C;;;;;;GAMG;AACH,SAAgB,WAAW,CASzB,IAA+C,EAC/C,KAAiB,EACjB,IAAiC;IAEjC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;IAChC,OAAO;QACL,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;YACvC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC1B,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC1D,OAAO,EAAE,KAAK,EAAE,kCAAkC,EAAE,CAAA;aACrD;YACD,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;YAC7B,MAAM,OAAO,CAAC,sBAAsB,EAAE,CAAA;YACtC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,KAAK,CAAC;gBAC9B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAQ;gBAC/C,OAAO;aACR,CAAC,CAAA;YACF,IAAI,OAAO,EAAE;gBACX,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;aACxB;QACH,CAAC,CAA8B;QAC/B,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;YAChC,MAAM,WAAW,GAAG,IAAA,qBAAW,EAAC,CAAC,MAAM,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAA;YAClE,OAAO;gBACL,IAAI,EAAE,MAAM,IAAI,CAAC,KAAK,CAAC;oBACrB,OAAO;iBACR,CAAC;gBACF,MAAM,EAAE,WAAW;aACpB,CAAA;QACH,CAAC,CAA8B;KAChC,CAAA;AACH,CAAC;AAxCD,kCAwCC;AAED,kBAAe,WAAW,CAAA"}
+{"version":3,"file":"setupConfig.js","sourceRoot":"","sources":["../../../../lib/config/setupConfig.ts"],"names":[],"mappings":";;;;;;AAIA,sEAA6C;AA+B7C;;;;;;GAMG;AACH,SAAgB,WAAW,CASzB,IAA+C,EAC/C,KAAiB,EACjB,IAAiC;IAEjC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;IAChC,OAAO;QACL,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;YACvC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC1B,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC1D,OAAO,EAAE,KAAK,EAAE,kCAAkC,EAAE,CAAA;aACrD;YACD,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;YAC7B,MAAM,OAAO,CAAC,sBAAsB,EAAE,CAAA;YACtC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,KAAK,CAAC;gBAC9B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAQ;gBAC/C,OAAO;aACR,CAAC,CAAA;YACF,IAAI,OAAO,EAAE;gBACX,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;aACxB;QACH,CAAC,CAAgC;QACjC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;YAChC,MAAM,WAAW,GAAG,IAAA,qBAAW,EAAC,CAAC,MAAM,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAA;YAClE,OAAO;gBACL,IAAI,EAAE,MAAM,IAAI,CAAC,KAAK,CAAC;oBACrB,OAAO;iBACR,CAAC;gBACF,MAAM,EAAE,WAAW;aACpB,CAAA;QACH,CAAC,CAAgC;KAClC,CAAA;AACH,CAAC;AAxCD,kCAwCC;AAED,kBAAe,WAAW,CAAA"}

package/cjs/lib/dependencies/DependencyConfig.d.ts

@@ -1,25 +1,24 @@
-import { DeepPartial, Effects } from "../types";
-import { SDKManifest } from "../manifest/ManifestTypes";
+import * as T from "../types";
 export type Update<QueryResults, RemoteConfig> = (options: {
     remoteConfig: RemoteConfig;
     queryResults: QueryResults;
 }) => Promise<RemoteConfig>;
-export declare class DependencyConfig<Manifest extends SDKManifest, Store, Input extends Record<string, any>, RemoteConfig extends Record<string, any>> {
+export declare class DependencyConfig<Manifest extends T.Manifest, Store, Input extends Record<string, any>, RemoteConfig extends Record<string, any>> {
     readonly dependencyConfig: (options: {
-        effects: Effects;
+        effects: T.Effects;
         localConfig: Input;
-    }) => Promise<void | DeepPartial<RemoteConfig>>;
-    readonly update: Update<void | DeepPartial<RemoteConfig>, RemoteConfig>;
+    }) => Promise<void | T.DeepPartial<RemoteConfig>>;
+    readonly update: Update<void | T.DeepPartial<RemoteConfig>, RemoteConfig>;
     static defaultUpdate: (options: {
         queryResults: unknown;
         remoteConfig: unknown;
     }) => Promise<unknown>;
     constructor(dependencyConfig: (options: {
-        effects: Effects;
+        effects: T.Effects;
         localConfig: Input;
-    }) => Promise<void | DeepPartial<RemoteConfig>>, update?: Update<void | DeepPartial<RemoteConfig>, RemoteConfig>);
+    }) => Promise<void | T.DeepPartial<RemoteConfig>>, update?: Update<void | T.DeepPartial<RemoteConfig>, RemoteConfig>);
     query(options: {
-        effects: Effects;
+        effects: T.Effects;
         localConfig: unknown;
-    }): Promise<void | DeepPartial<RemoteConfig>>;
+    }): Promise<void | T.DeepPartial<RemoteConfig>>;
 }

package/cjs/lib/dependencies/DependencyConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"DependencyConfig.js","sourceRoot":"","sources":["../../../../lib/dependencies/DependencyConfig.ts"],"names":[],"mappings":";;;;AAMA,iDAA6C;AAQ7C,MAAa,gBAAgB;IAY3B,YACW,gBAGsC,EACtC,SAGL,gBAAgB,CAAC,aAAoB;QAPhC,qBAAgB,GAAhB,gBAAgB,CAGsB;QACtC,WAAM,GAAN,MAAM,CAG0B;IACxC,CAAC;IAEJ,KAAK,CAAC,KAAK,CAAC,OAAmD;QAC7D,OAAO,IAAI,CAAC,gBAAgB,CAAC;YAC3B,WAAW,EAAE,OAAO,CAAC,WAAoB;YACzC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC;;;AAtBM,8BAAa,GAAG,KAAK,EAAE,OAG7B,EAAoB,EAAE;IACrB,OAAO,IAAA,qBAAS,EAAC,EAAE,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC,CAAA;AACxE,CAAC,AALmB,CAKnB;AAXU,4CAAgB"}
+{"version":3,"file":"DependencyConfig.js","sourceRoot":"","sources":["../../../../lib/dependencies/DependencyConfig.ts"],"names":[],"mappings":";;;;AAEA,iDAA6C;AAO7C,MAAa,gBAAgB;IAY3B,YACW,gBAGwC,EACxC,SAGL,gBAAgB,CAAC,aAAoB;QAPhC,qBAAgB,GAAhB,gBAAgB,CAGwB;QACxC,WAAM,GAAN,MAAM,CAG0B;IACxC,CAAC;IAEJ,KAAK,CAAC,KAAK,CAAC,OAAqD;QAC/D,OAAO,IAAI,CAAC,gBAAgB,CAAC;YAC3B,WAAW,EAAE,OAAO,CAAC,WAAoB;YACzC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC;;;AAtBM,8BAAa,GAAG,KAAK,EAAE,OAG7B,EAAoB,EAAE;IACrB,OAAO,IAAA,qBAAS,EAAC,EAAE,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC,CAAA;AACxE,CAAC,AALmB,CAKnB;AAXU,4CAAgB"}

package/cjs/lib/dependencies/dependencies.d.ts

@@ -1,14 +1,16 @@
-import { Effects, SetHealth, CheckDependencyResult } from "../types";
-export type CheckAllDependencies = {
-    notRunning: () => Promise<CheckDependencyResult[]>;
-    notInstalled: () => Promise<CheckDependencyResult[]>;
-    healthErrors: () => Promise<{
-        [id: string]: SetHealth[];
-    }>;
-    throwIfNotRunning: () => Promise<void>;
-    throwIfNotValid: () => Promise<undefined>;
-    throwIfNotInstalled: () => Promise<void>;
-    throwIfError: () => Promise<void>;
-    isValid: () => Promise<boolean>;
+import { Effects, PackageId, HealthCheckId } from "../types";
+export type CheckDependencies<DependencyId extends PackageId = PackageId> = {
+    installedSatisfied: (packageId: DependencyId) => boolean;
+    installedVersionSatisfied: (packageId: DependencyId) => boolean;
+    runningSatisfied: (packageId: DependencyId) => boolean;
+    configSatisfied: (packageId: DependencyId) => boolean;
+    healthCheckSatisfied: (packageId: DependencyId, healthCheckId: HealthCheckId) => boolean;
+    satisfied: () => boolean;
+    throwIfInstalledNotSatisfied: (packageId: DependencyId) => void;
+    throwIfInstalledVersionNotSatisfied: (packageId: DependencyId) => void;
+    throwIfRunningNotSatisfied: (packageId: DependencyId) => void;
+    throwIfConfigNotSatisfied: (packageId: DependencyId) => void;
+    throwIfHealthNotSatisfied: (packageId: DependencyId, healthCheckId?: HealthCheckId) => void;
+    throwIfNotSatisfied: (packageId?: DependencyId) => void;
 };
-export declare function checkAllDependencies(effects: Effects): CheckAllDependencies;
+export declare function checkDependencies<DependencyId extends PackageId = PackageId>(effects: Effects, packageIds?: DependencyId[]): Promise<CheckDependencies<DependencyId>>;

package/cjs/lib/dependencies/dependencies.js

@@ -1,84 +1,138 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkAllDependencies = void 0;
-function checkAllDependencies(effects) {
-    const dependenciesPromise = effects.getDependencies();
-    const resultsPromise = dependenciesPromise.then((dependencies) => effects.checkDependencies({
-        packageIds: dependencies.map((dep) => dep.id),
-    }));
-    const dependenciesByIdPromise = dependenciesPromise.then((d) => d.reduce((acc, dep) => {
-        acc[dep.id] = dep;
-        return acc;
-    }, {}));
-    const healthErrors = async () => {
-        const results = await resultsPromise;
-        const dependenciesById = await dependenciesByIdPromise;
-        const answer = {};
-        for (const result of results) {
-            const dependency = dependenciesById[result.packageId];
-            if (!dependency)
-                continue;
-            if (dependency.kind !== "running")
-                continue;
-            const healthChecks = result.healthChecks
-                .filter((x) => dependency.healthChecks.includes(x.id))
-                .filter((x) => !!x.message);
-            if (healthChecks.length === 0)
-                continue;
-            answer[result.packageId] = healthChecks;
+exports.checkDependencies = void 0;
+const exver_1 = require("../exver");
+async function checkDependencies(effects, packageIds) {
+    let [dependencies, results] = await Promise.all([
+        effects.getDependencies(),
+        effects.checkDependencies({
+            packageIds,
+        }),
+    ]);
+    if (packageIds) {
+        dependencies = dependencies.filter((d) => packageIds.includes(d.id));
+    }
+    const find = (packageId) => {
+        const dependencyRequirement = dependencies.find((d) => d.id === packageId);
+        const dependencyResult = results.find((d) => d.packageId === packageId);
+        if (!dependencyRequirement || !dependencyResult) {
+            throw new Error(`Unknown DependencyId ${packageId}`);
         }
-        return answer;
+        return { requirement: dependencyRequirement, result: dependencyResult };
     };
-    const notInstalled = () => resultsPromise.then((x) => x.filter((x) => !x.isInstalled));
-    const notRunning = async () => {
-        const results = await resultsPromise;
-        const dependenciesById = await dependenciesByIdPromise;
-        return results.filter((x) => {
-            const dependency = dependenciesById[x.packageId];
-            if (!dependency)
-                return false;
-            if (dependency.kind !== "running")
-                return false;
-            return !x.isRunning;
-        });
+    const installedSatisfied = (packageId) => !!find(packageId).result.installedVersion;
+    const installedVersionSatisfied = (packageId) => {
+        const dep = find(packageId);
+        return (!!dep.result.installedVersion &&
+            exver_1.ExtendedVersion.parse(dep.result.installedVersion).satisfies(exver_1.VersionRange.parse(dep.requirement.versionRange)));
     };
-    const entries = (x) => Object.entries(x);
-    const first = (x) => x[0];
-    const sinkVoid = (x) => void 0;
-    const throwIfError = () => healthErrors()
-        .then(entries)
-        .then(first)
-        .then((x) => {
-        if (!x)
-            return;
-        const [id, healthChecks] = x;
-        if (healthChecks.length > 0)
-            throw `Package ${id} has the following errors: ${healthChecks.map((x) => x.message).join(", ")}`;
-    });
-    const throwIfNotRunning = () => notRunning().then((results) => {
-        if (results[0])
-            throw new Error(`Package ${results[0].packageId} is not running`);
-    });
-    const throwIfNotInstalled = () => notInstalled().then((results) => {
-        if (results[0])
-            throw new Error(`Package ${results[0].packageId} is not installed`);
-    });
-    const throwIfNotValid = async () => Promise.all([
-        throwIfNotRunning(),
-        throwIfNotInstalled(),
-        throwIfError(),
-    ]).then(sinkVoid);
-    const isValid = () => throwIfNotValid().then(() => true, () => false);
+    const runningSatisfied = (packageId) => {
+        const dep = find(packageId);
+        return dep.requirement.kind !== "running" || dep.result.isRunning;
+    };
+    const configSatisfied = (packageId) => find(packageId).result.configSatisfied;
+    const healthCheckSatisfied = (packageId, healthCheckId) => {
+        const dep = find(packageId);
+        if (healthCheckId &&
+            (dep.requirement.kind !== "running" ||
+                !dep.requirement.healthChecks.includes(healthCheckId))) {
+            throw new Error(`Unknown HealthCheckId ${healthCheckId}`);
+        }
+        const errors = Object.entries(dep.result.healthChecks)
+            .filter(([id, _]) => (healthCheckId ? id === healthCheckId : true))
+            .filter(([_, res]) => res.result !== "success");
+        return errors.length === 0;
+    };
+    const pkgSatisfied = (packageId) => installedSatisfied(packageId) &&
+        installedVersionSatisfied(packageId) &&
+        runningSatisfied(packageId) &&
+        configSatisfied(packageId) &&
+        healthCheckSatisfied(packageId);
+    const satisfied = (packageId) => packageId
+        ? pkgSatisfied(packageId)
+        : dependencies.every((d) => pkgSatisfied(d.id));
+    const throwIfInstalledNotSatisfied = (packageId) => {
+        const dep = find(packageId);
+        if (!dep.result.installedVersion) {
+            throw new Error(`${dep.result.title || packageId} is not installed`);
+        }
+    };
+    const throwIfInstalledVersionNotSatisfied = (packageId) => {
+        const dep = find(packageId);
+        if (!dep.result.installedVersion) {
+            throw new Error(`${dep.result.title || packageId} is not installed`);
+        }
+        if (![dep.result.installedVersion, ...dep.result.satisfies].find((v) => exver_1.ExtendedVersion.parse(v).satisfies(exver_1.VersionRange.parse(dep.requirement.versionRange)))) {
+            throw new Error(`Installed version ${dep.result.installedVersion} of ${dep.result.title || packageId} does not match expected version range ${dep.requirement.versionRange}`);
+        }
+    };
+    const throwIfRunningNotSatisfied = (packageId) => {
+        const dep = find(packageId);
+        if (dep.requirement.kind === "running" && !dep.result.isRunning) {
+            throw new Error(`${dep.result.title || packageId} is not running`);
+        }
+    };
+    const throwIfConfigNotSatisfied = (packageId) => {
+        const dep = find(packageId);
+        if (!dep.result.configSatisfied) {
+            throw new Error(`${dep.result.title || packageId}'s configuration does not satisfy requirements`);
+        }
+    };
+    const throwIfHealthNotSatisfied = (packageId, healthCheckId) => {
+        const dep = find(packageId);
+        if (healthCheckId &&
+            (dep.requirement.kind !== "running" ||
+                !dep.requirement.healthChecks.includes(healthCheckId))) {
+            throw new Error(`Unknown HealthCheckId ${healthCheckId}`);
+        }
+        const errors = Object.entries(dep.result.healthChecks)
+            .filter(([id, _]) => (healthCheckId ? id === healthCheckId : true))
+            .filter(([_, res]) => res.result !== "success");
+        if (errors.length) {
+            throw new Error(errors
+                .map(([_, e]) => `Health Check ${e.name} of ${dep.result.title || packageId} failed with status ${e.result}${e.message ? `: ${e.message}` : ""}`)
+                .join("; "));
+        }
+    };
+    const throwIfPkgNotSatisfied = (packageId) => {
+        throwIfInstalledNotSatisfied(packageId);
+        throwIfInstalledVersionNotSatisfied(packageId);
+        throwIfRunningNotSatisfied(packageId);
+        throwIfConfigNotSatisfied(packageId);
+        throwIfHealthNotSatisfied(packageId);
+    };
+    const throwIfNotSatisfied = (packageId) => packageId
+        ? throwIfPkgNotSatisfied(packageId)
+        : (() => {
+            const err = dependencies.flatMap((d) => {
+                try {
+                    throwIfPkgNotSatisfied(d.id);
+                }
+                catch (e) {
+                    if (e instanceof Error)
+                        return [e.message];
+                    throw e;
+                }
+                return [];
+            });
+            if (err.length) {
+                throw new Error(err.join("; "));
+            }
+        })();
     return {
-        notRunning,
-        notInstalled,
-        healthErrors,
-        throwIfNotRunning,
-        throwIfNotValid,
-        throwIfNotInstalled,
-        throwIfError,
-        isValid,
+        installedSatisfied,
+        installedVersionSatisfied,
+        runningSatisfied,
+        configSatisfied,
+        healthCheckSatisfied,
+        satisfied,
+        throwIfInstalledNotSatisfied,
+        throwIfInstalledVersionNotSatisfied,
+        throwIfRunningNotSatisfied,
+        throwIfConfigNotSatisfied,
+        throwIfHealthNotSatisfied,
+        throwIfNotSatisfied,
     };
 }
-exports.checkAllDependencies = checkAllDependencies;
+exports.checkDependencies = checkDependencies;
 //# sourceMappingURL=dependencies.js.map