@start9labs/start-sdk 0.4.0-beta.2 → 0.4.0-beta.21

package/package/lib/StartSdk.js

@@ -47,9 +47,7 @@ const HealthCheck_1 = require("./health/HealthCheck");
 const checkPortListening_1 = require("./health/checkFns/checkPortListening");
 const checkFns_1 = require("./health/checkFns");
 const list_1 = require("../../base/lib/actions/input/builder/list");
-const setupInstall_1 = require("./inits/setupInstall");
 const setupBackups_1 = require("./backup/setupBackups");
-const setupUninstall_1 = require("./inits/setupUninstall");
 const mainFn_1 = require("./mainFn");
 const defaultTrigger_1 = require("./trigger/defaultTrigger");
 const trigger_1 = require("./trigger");
@@ -60,20 +58,19 @@ const ServiceInterfaceBuilder_1 = require("../../base/lib/interfaces/ServiceInte
 const util_1 = require("./util");
 const util_2 = require("./util");
 const util_3 = require("./util");
-const getStore_1 = require("./store/getStore");
 const SubContainer_1 = require("./util/SubContainer");
 const util_4 = require("./util");
 const Mounts_1 = require("./mainFn/Mounts");
 const setupDependencies_1 = require("../../base/lib/dependencies/setupDependencies");
 const T = __importStar(require("../../base/lib/types"));
 const exver_1 = require("../../base/lib/exver");
-const PathBuilder_1 = require("../../base/lib/util/PathBuilder");
 const dependencies_1 = require("../../base/lib/dependencies/dependencies");
 const util_5 = require("./util");
+const version_1 = require("./version");
 const actions = __importStar(require("../../base/lib/actions"));
-const setupInit_1 = require("./inits/setupInit");
 const fs = __importStar(require("node:fs/promises"));
-exports.OSVersion = (0, exver_1.testTypeVersion)("0.4.0-alpha.0");
+const inits_1 = require("../../base/lib/inits");
+exports.OSVersion = (0, exver_1.testTypeVersion)("0.4.0-alpha.3");
 class StartSdk {
     constructor(manifest) {
         this.manifest = manifest;
@@ -84,9 +81,6 @@ class StartSdk {
     withManifest(manifest) {
         return new StartSdk(manifest);
     }
-    withStore() {
-        return new StartSdk(this.manifest);
-    }
     build(isReady) {
         const startSdkEffectWrapper = {
             restart: (effects, ...args) => effects.restart(...args),
@@ -94,13 +88,10 @@ class StartSdk {
             checkDependencies: (effects, ...args) => effects.checkDependencies(...args),
             mount: (effects, ...args) => effects.mount(...args),
             getInstalledPackages: (effects, ...args) => effects.getInstalledPackages(...args),
-            exposeForDependents: (effects, ...args) => effects.exposeForDependents(...args),
             getServicePortForward: (effects, ...args) => effects.getServicePortForward(...args),
             clearBindings: (effects, ...args) => effects.clearBindings(...args),
             getOsIp: (effects, ...args) => effects.getOsIp(...args),
             getSslKey: (effects, ...args) => effects.getSslKey(...args),
-            setDataVersion: (effects, ...args) => effects.setDataVersion(...args),
-            getDataVersion: (effects, ...args) => effects.getDataVersion(...args),
             shutdown: (effects, ...args) => effects.shutdown(...args),
             getDependencies: (effects, ...args) => effects.getDependencies(...args),
             getStatus: (effects, ...args) => effects.getStatus(...args),
@@ -108,6 +99,8 @@ class StartSdk {
         return {
             manifest: this.manifest,
             ...startSdkEffectWrapper,
+            setDataVersion: version_1.setDataVersion,
+            getDataVersion: version_1.getDataVersion,
             action: {
                 run: actions.runAction,
                 request: (effects, packageId, action, severity, options) => actions.requestAction({
@@ -137,10 +130,15 @@ class StartSdk {
             },
             getContainerIp: (effects, options = {}) => {
                 async function* watch() {
-                    while (true) {
+                    const resolveCell = { resolve: () => { } };
+                    effects.onLeaveContext(() => {
+                        resolveCell.resolve();
+                    });
+                    while (effects.isInContext) {
                         let callback = () => { };
                         const waitForNext = new Promise((resolve) => {
                             callback = resolve;
+                            resolveCell.resolve = resolve;
                         });
                         yield await effects.getContainerIp({ ...options, callback });
                         await waitForNext;
@@ -171,28 +169,11 @@ class StartSdk {
                     },
                 };
             },
-            store: {
-                get: (effects, packageId, path) => (0, getStore_1.getStore)(effects, path, {
-                    packageId,
-                }),
-                getOwn: (effects, path) => (0, getStore_1.getStore)(effects, path),
-                setOwn: (effects, path, value) => effects.store.set({
-                    value,
-                    path: (0, PathBuilder_1.extractJsonPath)(path),
-                }),
-            },
             MultiHost: {
                 of: (effects, id) => new Host_1.MultiHost({ id, effects }),
             },
             nullIfEmpty: util_2.nullIfEmpty,
             useEntrypoint: (overrideCmd) => new T.UseEntrypoint(overrideCmd),
-            runCommand: async (effects, image, command, options, 
-            /**
-             * A name to use to refer to the ephemeral subcontainer for debugging purposes
-             */
-            name) => {
-                return runCommand(effects, image, command, options, name);
-            },
             /**
              * @description Use this class to create an Action. By convention, each Action should receive its own file.
              *
@@ -265,6 +246,7 @@ class StartSdk {
                  * In this example, we create an action that returns a secret phrase for the user to see.
                  *
                  * ```
+                  import { store } from '../file-models/store.json'
                   import { sdk } from '../sdk'
         
                   export const showSecretPhrase = sdk.Action.withoutInput(
@@ -289,9 +271,7 @@ class StartSdk {
                         'Below is your secret phrase. Use it to gain access to extraordinary places',
                       result: {
                         type: 'single',
-                        value: await sdk.store
-                          .getOwn(effects, sdk.StorePath.secretPhrase)
-                          .const(),
+                        value: (await store.read.once())?.secretPhrase,
                         copyable: true,
                         qr: true,
                         masked: true,
@@ -378,11 +358,11 @@ class StartSdk {
             /**
              * @description Use this function to set dependency information.
              * @example
-             * In this example, we create a perpetual dependency on Hello World >=1.0.0:0, where Hello World must be running and passing its "primary" health check.
+             * In this example, we create a dependency on Hello World >=1.0.0:0, where Hello World must be running and passing its "primary" health check.
              *
              * ```
               export const setDependencies = sdk.setupDependencies(
-                async ({ effects, input }) => {
+                async ({ effects }) => {
                   return {
                     'hello-world': {
                       kind: 'running',
@@ -393,66 +373,61 @@ class StartSdk {
                 },
               )
              * ```
-             * @example
-             * In this example, we create a conditional dependency on Hello World based on a hypothetical "needsWorld" boolean in our Store.
-             * Using .const() ensures that if the "needsWorld" boolean changes, setupDependencies will re-run.
-             *
-             * ```
-              export const setDependencies = sdk.setupDependencies(
-                async ({ effects }) => {
-                  if (sdk.store.getOwn(sdk.StorePath.needsWorld).const()) {
-                    return {
-                      'hello-world': {
-                        kind: 'running',
-                        versionRange: '>=1.0.0',
-                        healthChecks: ['primary'],
-                      },
-                    }
-                  }
-                  return {}
-                },
-              )
-             * ```
              */
             setupDependencies: (setupDependencies_1.setupDependencies),
-            setupInit: (setupInit_1.setupInit),
             /**
-             * @description Use this function to execute arbitrary logic *once*, on initial install *before* interfaces, actions, and dependencies are updated.
+             * @description Use this function to create an InitScript that runs only when the service is freshly installed
+             */
+            setupPostInstall: inits_1.setupPostInstall,
+            /**
+             * @description Use this function to create an InitScript that runs only when the service is updated
+             */
+            setupPostUpdate: inits_1.setupPostUpdate,
+            /**
+             * @description Use this function to create an InitScript that runs only when the service is installed or updated
+             */
+            setupPostInstallOrUpdate: inits_1.setupPostInstallOrUpdate,
+            /**
+             * @description Use this function to setup what happens when the service initializes.
+             *
+             *    This happens when the server boots, or a service is installed, updated, or restored
+             *
+             *    Not every init script does something on every initialization. For example, versions only does something on install or update
+             *
+             *    These scripts are run in the order they are supplied
              * @example
-             * In the this example, we initialize a config file
              *
              * ```
-              const preInstall = sdk.setupPreInstall(async ({ effects }) => {
-                await configFile.write(effects, { name: 'World' })
-              })
+              export const init = sdk.setupInit(
+                backups,
+                versions,
+                setDependencies,
+                setInterfaces,
+                actions,
+                postInstall,
+              )
              * ```
              */
-            setupPreInstall: (fn) => setupInstall_1.PreInstall.of(fn),
+            setupInit: inits_1.setupInit,
             /**
-             * @description Use this function to execute arbitrary logic *once*, on initial install *after* interfaces, actions, and dependencies are updated.
+             * @description Use this function to setup what happens when the service uninitializes.
+             *
+             *    This happens when the server shuts down, or a service is uninstalled or updated
+             *
+             *    Not every uninit script does something on every uninitialization. For example, versions only does something on uninstall or update
+             *
+             *    These scripts are run in the order they are supplied
              * @example
-             * In the this example, we bootstrap our Store with a random, 16-char admin password.
              *
              * ```
-              const postInstall = sdk.setupPostInstall(async ({ effects }) => {
-                await sdk.store.setOwn(
-                  effects,
-                  sdk.StorePath.adminPassword,
-                  utils.getDefaultString({
-                    charset: 'a-z,A-Z,1-9,!,@,$,%,&,',
-                    len: 16,
-                  }),
-                )
-              })
+              export const uninit = sdk.setupUninit(
+                versions,
+              )
              * ```
              */
-            setupPostInstall: (fn) => setupInstall_1.PostInstall.of(fn),
+            setupUninit: inits_1.setupUninit,
             /**
              * @description Use this function to determine how this service will be hosted and served. The function executes on service install, service update, and inputSpec save.
-             *
-             *   "input" will be of type `Input` for inputSpec save. It will be `null` for install and update.
-             *
-             *   To learn about creating multi-hosts and interfaces, check out the {@link https://docs.start9.com/packaging-guide/learn/interfaces documentation}.
              * @param inputSpec - The inputSpec spec of this service as exported from /inputSpec/spec.
              * @param fn - an async function that returns an array of interface receipts. The function always has access to `effects`; it has access to `input` only after inputSpec save, otherwise `input` will be null.
              * @example
@@ -460,8 +435,7 @@ class StartSdk {
              *
              * ```
               export const setInterfaces = sdk.setupInterfaces(
-                inputSpecSpec,
-                async ({ effects, input }) => {
+                async ({ effects }) => {
                   // ** UI multi-host **
                   const uiMulti = sdk.MultiHost.of(effects, 'ui-multi')
                   const uiMultiOrigin = await uiMulti.bindPort(80, {
@@ -522,10 +496,6 @@ class StartSdk {
              */
             setupInterfaces: setupInterfaces_1.setupServiceInterfaces,
             setupMain: (fn) => (0, mainFn_1.setupMain)(fn),
-            /**
-             * Use this function to execute arbitrary logic *once*, on uninstall only. Most services will not use this.
-             */
-            setupUninstall: (fn) => (0, setupUninstall_1.setupUninstall)(fn),
             trigger: {
                 defaultTrigger: defaultTrigger_1.defaultTrigger,
                 cooldownTrigger: trigger_1.cooldownTrigger,
@@ -572,340 +542,41 @@ class StartSdk {
                  */
                 of: (spec) => inputSpec_1.InputSpec.of(spec),
             },
+            Daemon: {
+                get of() {
+                    return Daemons_1.Daemon.of();
+                },
+            },
             Daemons: {
                 of(effects, started, healthChecks) {
                     return Daemons_1.Daemons.of({ effects, started, healthChecks });
                 },
             },
             SubContainer: {
-                of(effects, image, name) {
-                    return SubContainer_1.SubContainer.of(effects, image, name);
-                },
-                with(effects, image, mounts, name, fn) {
-                    return SubContainer_1.SubContainer.with(effects, image, mounts, name, fn);
-                },
-            },
-            List: {
-                /**
-                 * @description Create a list of text inputs.
-                 * @param a - attributes of the list itself.
-                 * @param aSpec - attributes describing each member of the list.
-                 */
-                text: list_1.List.text,
-                /**
-                 * @description Create a list of objects.
-                 * @param a - attributes of the list itself.
-                 * @param aSpec - attributes describing each member of the list.
-                 */
-                obj: (a, aSpec) => list_1.List.obj(a, aSpec),
-                /**
-                 * @description Create a list of dynamic text inputs.
-                 * @param a - attributes of the list itself.
-                 * @param aSpec - attributes describing each member of the list.
-                 */
-                dynamicText: (list_1.List.dynamicText),
-            },
-            StorePath: (0, PathBuilder_1.pathBuilder)(),
-            Value: {
-                /**
-                 * @description Displays a boolean toggle to enable/disable
-                 * @example
-                 * ```
-                  toggleExample: Value.toggle({
-                    // required
-                    name: 'Toggle Example',
-                    default: true,
-                 
-                    // optional
-                    description: null,
-                    warning: null,
-                    immutable: false,
-                  }),
-                 * ```
-                 */
-                toggle: value_1.Value.toggle,
-                /**
-                 * @description Displays a text input field
-                 * @example
-                 * ```
-                  textExample: Value.text({
-                    // required
-                    name: 'Text Example',
-                    required: false,
-                    default: null,
-                 
-                    // optional
-                    description: null,
-                    placeholder: null,
-                    warning: null,
-                    generate: null,
-                    inputmode: 'text',
-                    masked: false,
-                    minLength: null,
-                    maxLength: null,
-                    patterns: [],
-                    immutable: false,
-                  }),
-                 * ```
-                 */
-                text: value_1.Value.text,
-                /**
-                 * @description Displays a large textarea field for long form entry.
-                 * @example
-                 * ```
-                  textareaExample: Value.textarea({
-                    // required
-                    name: 'Textarea Example',
-                    required: false,
-                    default: null,
-                 
-                    // optional
-                    description: null,
-                    placeholder: null,
-                    warning: null,
-                    minLength: null,
-                    maxLength: null,
-                    immutable: false,
-                  }),
-                 * ```
-                 */
-                textarea: value_1.Value.textarea,
-                /**
-                 * @description Displays a number input field
-                 * @example
-                 * ```
-                  numberExample: Value.number({
-                    // required
-                    name: 'Number Example',
-                    required: false,
-                    default: null,
-                    integer: true,
-                 
-                    // optional
-                    description: null,
-                    placeholder: null,
-                    warning: null,
-                    min: null,
-                    max: null,
-                    immutable: false,
-                    step: null,
-                    units: null,
-                  }),
-                 * ```
-                 */
-                number: value_1.Value.number,
-                /**
-                 * @description Displays a browser-native color selector.
-                 * @example
-                 * ```
-                  colorExample: Value.color({
-                    // required
-                    name: 'Color Example',
-                    required: false,
-                    default: null,
-                 
-                    // optional
-                    description: null,
-                    warning: null,
-                    immutable: false,
-                  }),
-                 * ```
-                 */
-                color: value_1.Value.color,
-                /**
-                 * @description Displays a browser-native date/time selector.
-                 * @example
-                 * ```
-                  datetimeExample: Value.datetime({
-                    // required
-                    name: 'Datetime Example',
-                    required: false,
-                    default: null,
-                 
-                    // optional
-                    description: null,
-                    warning: null,
-                    immutable: false,
-                    inputmode: 'datetime-local',
-                    min: null,
-                    max: null,
-                  }),
-                 * ```
-                 */
-                datetime: value_1.Value.datetime,
-                /**
-                 * @description Displays a select modal with radio buttons, allowing for a single selection.
-                 * @example
-                 * ```
-                  selectExample: Value.select({
-                    // required
-                    name: 'Select Example',
-                    default: 'radio1',
-                    values: {
-                      radio1: 'Radio 1',
-                      radio2: 'Radio 2',
-                    },
-                 
-                    // optional
-                    description: null,
-                    warning: null,
-                    immutable: false,
-                    disabled: false,
-                  }),
-                 * ```
-                 */
-                select: value_1.Value.select,
-                /**
-                 * @description Displays a select modal with checkboxes, allowing for multiple selections.
-                 * @example
-                 * ```
-                  multiselectExample: Value.multiselect({
-                    // required
-                    name: 'Multiselect Example',
-                    values: {
-                      option1: 'Option 1',
-                      option2: 'Option 2',
-                    },
-                    default: [],
-                 
-                    // optional
-                    description: null,
-                    warning: null,
-                    immutable: false,
-                    disabled: false,
-                    minlength: null,
-                    maxLength: null,
-                  }),
-                 * ```
-                 */
-                multiselect: value_1.Value.multiselect,
-                /**
-                 * @description Display a collapsable grouping of additional fields, a "sub form". The second value is the inputSpec spec for the sub form.
-                 * @example
-                 * ```
-                  objectExample: Value.object(
-                    {
-                      // required
-                      name: 'Object Example',
-                 
-                      // optional
-                      description: null,
-                      warning: null,
-                    },
-                    InputSpec.of({}),
-                  ),
-                 * ```
-                 */
-                object: value_1.Value.object,
                 /**
-                 * @description Displays a dropdown, allowing for a single selection. Depending on the selection, a different object ("sub form") is presented.
-                 * @example
-                 * ```
-                  unionExample: Value.union(
-                    {
-                      // required
-                      name: 'Union Example',
-                      default: 'option1',
-                 
-                      // optional
-                      description: null,
-                      warning: null,
-                      disabled: false,
-                      immutable: false,
-                    },
-                    Variants.of({
-                      option1: {
-                        name: 'Option 1',
-                        spec: InputSpec.of({}),
-                      },
-                      option2: {
-                        name: 'Option 2',
-                        spec: InputSpec.of({}),
-                      },
-                    }),
-                  ),
-                 * ```
+                 * @description Create a new SubContainer
+                 * @param effects
+                 * @param image - what container image to use
+                 * @param mounts - what to mount to the subcontainer
+                 * @param name - a name to use to refer to the subcontainer for debugging purposes
                  */
-                union: value_1.Value.union,
+                of(effects, image, mounts, name) {
+                    return SubContainer_1.SubContainerOwned.of(effects, image, mounts, name);
+                },
                 /**
-                 * @description Presents an interface to add/remove/edit items in a list.
-                 * @example
-                 * In this example, we create a list of text inputs.
-                 *
-                 * ```
-                  listExampleText: Value.list(
-                    List.text(
-                      {
-                        // required
-                        name: 'Text List',
-        
-                        // optional
-                        description: null,
-                        warning: null,
-                        default: [],
-                        minLength: null,
-                        maxLength: null,
-                      },
-                      {
-                        // required
-                        patterns: [],
-        
-                        // optional
-                        placeholder: null,
-                        generate: null,
-                        inputmode: 'url',
-                        masked: false,
-                        minLength: null,
-                        maxLength: null,
-                      },
-                    ),
-                  ),
-                 * ```
-                 * @example
-                 * In this example, we create a list of objects.
-                 *
-                 * ```
-                  listExampleObject: Value.list(
-                    List.obj(
-                      {
-                        // required
-                        name: 'Object List',
-        
-                        // optional
-                        description: null,
-                        warning: null,
-                        default: [],
-                        minLength: null,
-                        maxLength: null,
-                      },
-                      {
-                        // required
-                        spec: InputSpec.of({}),
-        
-                        // optional
-                        displayAs: null,
-                        uniqueBy: null,
-                      },
-                    ),
-                  ),
-                 * ```
+                 * @description Run a function with a temporary SubContainer
+                 * @param effects
+                 * @param image - what container image to use
+                 * @param mounts - what to mount to the subcontainer
+                 * @param name - a name to use to refer to the ephemeral subcontainer for debugging purposes
                  */
-                list: value_1.Value.list,
-                hidden: value_1.Value.hidden,
-                dynamicToggle: (value_1.Value.dynamicToggle),
-                dynamicText: (value_1.Value.dynamicText),
-                dynamicTextarea: (value_1.Value.dynamicTextarea),
-                dynamicNumber: (value_1.Value.dynamicNumber),
-                dynamicColor: (value_1.Value.dynamicColor),
-                dynamicDatetime: (value_1.Value.dynamicDatetime),
-                dynamicSelect: (value_1.Value.dynamicSelect),
-                dynamicMultiselect: (value_1.Value.dynamicMultiselect),
-                filteredUnion: (getDisabledFn, a, aVariants) => value_1.Value.filteredUnion(getDisabledFn, a, aVariants),
-                dynamicUnion: (getA, aVariants) => value_1.Value.dynamicUnion(getA, aVariants),
-            },
-            Variants: {
-                of: (a) => variants_1.Variants.of(a),
+                withTemp(effects, image, mounts, name, fn) {
+                    return SubContainer_1.SubContainerOwned.withTemp(effects, image, mounts, name, fn);
+                },
             },
+            List: list_1.List,
+            Value: value_1.Value,
+            Variants: variants_1.Variants,
         };
     }
 }
@@ -920,11 +591,11 @@ async function runCommand(effects, image, command, options, name) {
             .catch(() => "{}")
             .then(JSON.parse);
         commands = imageMeta.entrypoint ?? [];
-        commands.concat(...(command.overridCmd ?? imageMeta.cmd ?? []));
+        commands = commands.concat(...(command.overridCmd ?? imageMeta.cmd ?? []));
     }
     else
         commands = (0, util_4.splitCommand)(command);
-    return SubContainer_1.SubContainer.with(effects, image, options.mounts.build(), name ||
+    return SubContainer_1.SubContainerOwned.withTemp(effects, image, options.mounts, name ||
         commands
             .map((c) => {
             if (c.includes(" ")) {