@start9labs/start-sdk 0.4.0-beta.20 → 0.4.0-beta.22

package/base/lib/interfaces/setupInterfaces.js

@@ -1,37 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupServiceInterfaces = exports.NO_INTERFACE_CHANGES = void 0;
-const util_1 = require("../util");
 exports.NO_INTERFACE_CHANGES = {};
 const setupServiceInterfaces = (fn) => {
-    const cell = {
-        updater: (async (options) => []),
-    };
-    cell.updater = (async (options) => {
-        const childEffects = options.effects.child("setupInterfaces");
-        childEffects.constRetry = (0, util_1.once)(() => {
-            cell.updater({ effects: options.effects });
-        });
+    return (async (effects) => {
         const bindings = [];
         const interfaces = [];
-        const res = await fn({
+        await fn({
             effects: {
-                ...childEffects,
+                ...effects,
                 bind: (params) => {
                     bindings.push({ id: params.id, internalPort: params.internalPort });
-                    return childEffects.bind(params);
+                    return effects.bind(params);
                 },
                 exportServiceInterface: (params) => {
                     interfaces.push(params.id);
-                    return childEffects.exportServiceInterface(params);
+                    return effects.exportServiceInterface(params);
                 },
             },
         });
-        await options.effects.clearBindings({ except: bindings });
-        await options.effects.clearServiceInterfaces({ except: interfaces });
-        return res;
+        await effects.clearBindings({ except: bindings });
+        await effects.clearServiceInterfaces({ except: interfaces });
+        return null;
     });
-    return cell.updater;
 };
 exports.setupServiceInterfaces = setupServiceInterfaces;
 //# sourceMappingURL=setupInterfaces.js.map

package/base/lib/interfaces/setupInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"setupInterfaces.js","sourceRoot":"","sources":["../../../../base/lib/interfaces/setupInterfaces.ts"],"names":[],"mappings":";;;AACA,kCAA8B;AAkBjB,QAAA,oBAAoB,GAAG,EAAoC,CAAA;AACjE,MAAM,sBAAsB,GAA2B,CAG5D,EAAgC,EAChC,EAAE;IACF,MAAM,IAAI,GAAG;QACX,OAAO,EAAE,CAAC,KAAK,EAAE,OAA+B,EAAE,EAAE,CAClD,EAAmB,CAAoC;KAC1D,CAAA;IACD,IAAI,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,OAA+B,EAAE,EAAE;QACxD,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;QAC7D,YAAY,CAAC,UAAU,GAAG,IAAA,WAAI,EAAC,GAAG,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;QAC5C,CAAC,CAAC,CAAA;QACF,MAAM,QAAQ,GAAe,EAAE,CAAA;QAC/B,MAAM,UAAU,GAA2B,EAAE,CAAA;QAC7C,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;YACnB,OAAO,EAAE;gBACP,GAAG,YAAY;gBACf,IAAI,EAAE,CAAC,MAAoB,EAAE,EAAE;oBAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;oBACnE,OAAO,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAClC,CAAC;gBACD,sBAAsB,EAAE,CAAC,MAAsC,EAAE,EAAE;oBACjE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;oBAC1B,OAAO,YAAY,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;gBACpD,CAAC;aACF;SACF,CAAC,CAAA;QACF,MAAM,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAA;QACzD,MAAM,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;QACpE,OAAO,GAAG,CAAA;IACZ,CAAC,CAAoC,CAAA;IACrC,OAAO,IAAI,CAAC,OAAO,CAAA;AACrB,CAAC,CAAA;AAlCY,QAAA,sBAAsB,0BAkClC"}
+{"version":3,"file":"setupInterfaces.js","sourceRoot":"","sources":["../../../../base/lib/interfaces/setupInterfaces.ts"],"names":[],"mappings":";;;AAgBa,QAAA,oBAAoB,GAAG,EAAoC,CAAA;AACjE,MAAM,sBAAsB,GAA2B,CAG5D,EAAgC,EAChC,EAAE;IACF,OAAO,CAAC,KAAK,EAAE,OAAkB,EAAE,EAAE;QACnC,MAAM,QAAQ,GAAe,EAAE,CAAA;QAC/B,MAAM,UAAU,GAA2B,EAAE,CAAA;QAC7C,MAAM,EAAE,CAAC;YACP,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,IAAI,EAAE,CAAC,MAAoB,EAAE,EAAE;oBAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;oBACnE,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC7B,CAAC;gBACD,sBAAsB,EAAE,CAAC,MAAsC,EAAE,EAAE;oBACjE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;oBAC1B,OAAO,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;gBAC/C,CAAC;aACF;SACF,CAAC,CAAA;QACF,MAAM,OAAO,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAA;QACjD,MAAM,OAAO,CAAC,sBAAsB,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;QAC5D,OAAO,IAAI,CAAA;IACb,CAAC,CAA4B,CAAA;AAC/B,CAAC,CAAA;AAzBY,QAAA,sBAAsB,0BAyBlC"}

package/base/lib/osBindings/MainStatus.d.ts

@@ -10,8 +10,6 @@ export type MainStatus = {
     main: "stopped";
 } | {
     main: "restarting";
-} | {
-    main: "restoring";
 } | {
     main: "stopping";
 } | {

package/base/lib/osBindings/PackageDataEntry.d.ts

@@ -8,10 +8,9 @@ import type { MainStatus } from "./MainStatus";
 import type { PackageState } from "./PackageState";
 import type { ServiceInterface } from "./ServiceInterface";
 import type { ServiceInterfaceId } from "./ServiceInterfaceId";
-import type { Version } from "./Version";
 export type PackageDataEntry = {
     stateInfo: PackageState;
-    dataVersion: Version | null;
+    dataVersion: string | null;
     status: MainStatus;
     registry: string | null;
     developerKey: string;

package/base/lib/types.d.ts

@@ -3,6 +3,7 @@ import { DependencyRequirement, NamedHealthCheckResult, Manifest, ServiceInterfa
 import { StringObject, ToKebab } from "./util";
 import { Action, Actions } from "./actions/setupActions";
 import { Effects } from "./Effects";
+import { ExtendedVersion, VersionRange } from "./exver";
 export { Effects };
 export * from "./osBindings";
 export { SDKManifest } from "./types/ManifestTypes";
@@ -27,10 +28,6 @@ export declare namespace ExpectedExports {
     type createBackup = (options: {
         effects: Effects;
     }) => Promise<unknown>;
-    /** For restoring service data that was previously backed up using the startOS UI create backup flow. Backup restores are also triggered via the startOS UI, or doing a system restore flow during setup. */
-    type restoreBackup = (options: {
-        effects: Effects;
-    }) => Promise<unknown>;
     /**
      * This is the entrypoint for the main container. Used to start up something like the service that the
      * package represents, like running a bitcoind in a bitcoind-wrapper.
@@ -39,45 +36,29 @@ export declare namespace ExpectedExports {
         effects: Effects;
         started(onTerm: () => PromiseLike<void>): PromiseLike<null>;
     }) => Promise<DaemonBuildable>;
-    /**
-     * After a shutdown, if we wanted to do any operations to clean up things, like
-     * set the action as unavailable or something.
-     */
-    type afterShutdown = (options: {
-        effects: Effects;
-    }) => Promise<unknown>;
     /**
      * Every time a service launches (both on startup, and on install) this function is called before packageInit
      * Can be used to register callbacks
      */
-    type containerInit = (options: {
-        effects: Effects;
-    }) => Promise<unknown>;
-    /**
-     * Every time a package completes an install, this function is called before the main.
-     * Can be used to do migration like things.
-     */
-    type packageInit = (options: {
+    type init = (options: {
         effects: Effects;
+        kind: "install" | "update" | "restore" | null;
     }) => Promise<unknown>;
     /** This will be ran during any time a package is uninstalled, for example during a update
      * this will be called.
      */
-    type packageUninit = (options: {
+    type uninit = (options: {
         effects: Effects;
-        nextVersion: null | string;
+        target: ExtendedVersion | VersionRange | null;
     }) => Promise<unknown>;
     type manifest = Manifest;
     type actions = Actions<Record<ActionId, Action<ActionId, any>>>;
 }
 export type ABI = {
     createBackup: ExpectedExports.createBackup;
-    restoreBackup: ExpectedExports.restoreBackup;
     main: ExpectedExports.main;
-    afterShutdown: ExpectedExports.afterShutdown;
-    containerInit: ExpectedExports.containerInit;
-    packageInit: ExpectedExports.packageInit;
-    packageUninit: ExpectedExports.packageUninit;
+    init: ExpectedExports.init;
+    uninit: ExpectedExports.uninit;
     manifest: ExpectedExports.manifest;
     actions: ExpectedExports.actions;
 };
@@ -102,8 +83,10 @@ export type SmtpValue = {
 };
 export declare class UseEntrypoint {
     readonly overridCmd?: string[] | undefined;
+    readonly USE_ENTRYPOINT = "USE_ENTRYPOINT";
     constructor(overridCmd?: string[] | undefined);
 }
+export declare function isUseEntrypoint(command: CommandType): command is UseEntrypoint;
 export type CommandType = string | [string, ...string[]] | UseEntrypoint;
 export type DaemonReturned = {
     wait(): Promise<unknown>;

package/base/lib/types.js

@@ -37,6 +37,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UseEntrypoint = exports.ExpectedExports = exports.NO_TIMEOUT = exports.SIGKILL = exports.SIGTERM = exports.inputSpecTypes = void 0;
+exports.isUseEntrypoint = isUseEntrypoint;
 exports.writable = writable;
 exports.readonly = readonly;
 exports.inputSpecTypes = __importStar(require("./actions/input/inputSpecTypes"));
@@ -51,9 +52,13 @@ var ExpectedExports;
 class UseEntrypoint {
     constructor(overridCmd) {
         this.overridCmd = overridCmd;
+        this.USE_ENTRYPOINT = "USE_ENTRYPOINT";
     }
 }
 exports.UseEntrypoint = UseEntrypoint;
+function isUseEntrypoint(command) {
+    return typeof command === "object" && "ENTRYPOINT" in command;
+}
 function writable(value) {
     return value;
 }

package/base/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../base/lib/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6MA,4BAEC;AAMD,4BAEC;AAvND,iFAAgE;AAahE,+CAA4B;AAgBf,QAAA,OAAO,GAAY,SAAS,CAAA;AAC5B,QAAA,OAAO,GAAY,SAAS,CAAA;AAC5B,QAAA,UAAU,GAAG,CAAC,CAAC,CAAA;AAI5B,IAAiB,eAAe,CAmD/B;AAnDD,WAAiB,eAAe;IAC9B,OAAO,EAAE,CAAC,CAAA;AAkDZ,CAAC,EAnDgB,eAAe,+BAAf,eAAe,QAmD/B;AAkCD,MAAa,aAAa;IACxB,YAAqB,UAAqB;QAArB,eAAU,GAAV,UAAU,CAAW;IAAG,CAAC;CAC/C;AAFD,sCAEC;AAmFD,SAAgB,QAAQ,CAAI,KAAQ;IAClC,OAAO,KAAK,CAAA;AACd,CAAC;AAMD,SAAgB,QAAQ,CAAI,KAAQ;IAClC,OAAO,KAAK,CAAA;AACd,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../base/lib/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyGA,0CAIC;AAmFD,4BAEC;AAMD,4BAEC;AA1MD,iFAAgE;AAchE,+CAA4B;AAgBf,QAAA,OAAO,GAAY,SAAS,CAAA;AAC5B,QAAA,OAAO,GAAY,SAAS,CAAA;AAC5B,QAAA,UAAU,GAAG,CAAC,CAAC,CAAA;AAI5B,IAAiB,eAAe,CAkC/B;AAlCD,WAAiB,eAAe;IAC9B,OAAO,EAAE,CAAC,CAAA;AAiCZ,CAAC,EAlCgB,eAAe,+BAAf,eAAe,QAkC/B;AA+BD,MAAa,aAAa;IAExB,YAAqB,UAAqB;QAArB,eAAU,GAAV,UAAU,CAAW;QADjC,mBAAc,GAAG,gBAAgB,CAAA;IACG,CAAC;CAC/C;AAHD,sCAGC;AACD,SAAgB,eAAe,CAC7B,OAAoB;IAEpB,OAAO,OAAO,OAAO,KAAK,QAAQ,IAAI,YAAY,IAAI,OAAO,CAAA;AAC/D,CAAC;AAmFD,SAAgB,QAAQ,CAAI,KAAQ;IAClC,OAAO,KAAK,CAAA;AACd,CAAC;AAMD,SAAgB,QAAQ,CAAI,KAAQ;IAClC,OAAO,KAAK,CAAA;AACd,CAAC"}

package/package/lib/StartSdk.d.ts

@@ -1,7 +1,7 @@
 import { Value } from "../../base/lib/actions/input/builder/value";
 import { InputSpec } from "../../base/lib/actions/input/builder/inputSpec";
 import { Variants } from "../../base/lib/actions/input/builder/variants";
-import { Action, Actions } from "../../base/lib/actions/setupActions";
+import { Action, ActionInfo, Actions } from "../../base/lib/actions/setupActions";
 import { SyncOptions, ServiceInterfaceId, PackageId, ServiceInterfaceType, Effects } from "../../base/lib/types";
 import * as patterns from "../../base/lib/util/patterns";
 import { BackupSync, Backups } from "./backup/Backups";
@@ -9,26 +9,24 @@ import { Daemon, Daemons } from "./mainFn/Daemons";
 import { HealthCheck } from "./health/HealthCheck";
 import { checkPortListening } from "./health/checkFns/checkPortListening";
 import { List } from "../../base/lib/actions/input/builder/list";
-import { InstallFn, PostInstall, PreInstall } from "./inits/setupInstall";
 import { SetupBackupsParams } from "./backup/setupBackups";
-import { UninstallFn } from "./inits/setupUninstall";
 import { changeOnFirstSuccess, cooldownTrigger } from "./trigger";
-import { UpdateServiceInterfaces } from "../../base/lib/interfaces/setupInterfaces";
 import { MultiHost, Scheme } from "../../base/lib/interfaces/Host";
 import { ServiceInterfaceBuilder } from "../../base/lib/interfaces/ServiceInterfaceBuilder";
 import { GetSystemSmtp } from "./util";
 import { nullIfEmpty } from "./util";
-import { CommandOptions, SubContainer } from "./util/SubContainer";
+import { CommandOptions, SubContainer, SubContainerOwned } from "./util/SubContainer";
 import { Mounts } from "./mainFn/Mounts";
 import * as T from "../../base/lib/types";
 import { CheckDependencies } from "../../base/lib/dependencies/dependencies";
 import { GetSslCertificate } from "./util";
-import { VersionGraph } from "./version";
+import { getDataVersion, setDataVersion } from "./version";
 import { MaybeFn } from "../../base/lib/actions/setupActions";
 import { GetInput } from "../../base/lib/actions/setupActions";
 import { Run } from "../../base/lib/actions/setupActions";
 import * as actions from "../../base/lib/actions";
-export declare const OSVersion: "0.4.0-alpha.1";
+import { setupInit, setupUninit, setupOnInstall, setupOnUpdate, setupOnInstallOrUpdate, setupOnInit } from "../../base/lib/inits";
+export declare const OSVersion: "0.4.0-alpha.3";
 type AnyNeverCond<T extends any[], Then, Else> = T extends [] ? Else : T extends [never, ...Array<any>] ? Then : T extends [any, ...infer U] ? AnyNeverCond<U, Then, Else> : never;
 export declare class StartSdk<Manifest extends T.SDKManifest> {
     readonly manifest: Manifest;
@@ -36,14 +34,16 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
     static of(): StartSdk<never>;
     withManifest<Manifest extends T.SDKManifest = never>(manifest: Manifest): StartSdk<Manifest>;
     build(isReady: AnyNeverCond<[Manifest], "Build not ready", true>): {
+        setDataVersion: typeof setDataVersion;
+        getDataVersion: typeof getDataVersion;
         action: {
             run: <Input extends Record<string, unknown>>(options: {
                 effects: T.Effects;
                 actionId: T.ActionId;
                 input?: actions.RunActionInput<Input>;
             }) => Promise<T.ActionResult | null>;
-            request: <T extends Action<T.ActionId, any>>(effects: T.Effects, packageId: T.PackageId, action: T, severity: T.ActionSeverity, options?: actions.ActionRequestOptions<T>) => Promise<null>;
-            requestOwn: <T extends Action<T.ActionId, any>>(effects: T.Effects, action: T, severity: T.ActionSeverity, options?: actions.ActionRequestOptions<T>) => Promise<null>;
+            request: <T extends ActionInfo<T.ActionId, any>>(effects: T.Effects, packageId: T.PackageId, action: T, severity: T.ActionSeverity, options?: actions.ActionRequestOptions<T>) => Promise<null>;
+            requestOwn: <T extends ActionInfo<T.ActionId, any>>(effects: T.Effects, action: T, severity: T.ActionSeverity, options?: actions.ActionRequestOptions<T>) => Promise<null>;
             clearRequest: (effects: T.Effects, ...replayIds: string[]) => Promise<null>;
         };
         checkDependencies: <DependencyId extends keyof Manifest["dependencies"] & PackageId = keyof Manifest["dependencies"] & PackageId>(effects: Effects, packageIds?: DependencyId[]) => Promise<CheckDependencies<DependencyId>>;
@@ -218,7 +218,7 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
             schemeOverride: null,
             username: null,
             path: '',
-            search: {},
+            query: {},
           })
          * ```
          */
@@ -236,7 +236,7 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
             /** (optional) appends the provided path to all URLs. */
             path: string;
             /** (optional) appends the provided query params to all URLs. */
-            search: Record<string, string>;
+            query: Record<string, string>;
             /** (optional) overrides the protocol prefix provided by the bind function.
              *
              * @example `ftp://`
@@ -310,7 +310,7 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
          */
         setupBackups: (options: SetupBackupsParams<Manifest>) => {
             createBackup: T.ExpectedExports.createBackup;
-            restoreBackup: T.ExpectedExports.restoreBackup;
+            restoreInit: import("../../base/lib/inits").InitScript;
         };
         /**
          * @description Use this function to set dependency information.
@@ -333,42 +333,62 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
          */
         setupDependencies: (fn: (options: {
             effects: T.Effects;
-        }) => Promise<T.CurrentDependenciesResult<Manifest>>) => (options: {
-            effects: T.Effects;
-        }) => Promise<null>;
-        setupInit: (versions: VersionGraph<string>, preInstall: PreInstall<Manifest>, postInstall: PostInstall<Manifest>, uninstall: import("./inits/setupUninstall").Uninstall<Manifest>, setServiceInterfaces: UpdateServiceInterfaces<any>, setDependencies: (options: {
-            effects: T.Effects;
-        }) => Promise<null | void | undefined>, actions: Actions<any>) => {
-            packageInit: T.ExpectedExports.packageInit;
-            packageUninit: T.ExpectedExports.packageUninit;
-            containerInit: T.ExpectedExports.containerInit;
-        };
+        }) => Promise<T.CurrentDependenciesResult<Manifest>>) => (effects: T.Effects) => Promise<null>;
         /**
-         * @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 every time the service initializes
+         */
+        setupOnInit: typeof setupOnInit;
+        /**
+         * @description Use this function to create an InitScript that runs only when the service is freshly installed
+         */
+        setupOnInstall: typeof setupOnInstall;
+        /**
+         * @description Use this function to create an InitScript that runs only when the service is updated
+         */
+        setupOnUpdate: typeof setupOnUpdate;
+        /**
+         * @description Use this function to create an InitScript that runs only when the service is installed or updated
+         */
+        setupOnInstallOrUpdate: typeof setupOnInstallOrUpdate;
+        /**
+         * @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(
+            restoreInit,
+            versions,
+            setDependencies,
+            setInterfaces,
+            actions,
+            postInstall,
+          )
          * ```
          */
-        setupPreInstall: (fn: InstallFn<Manifest>) => PreInstall<Manifest>;
+        setupInit: typeof 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 create a task for the user to perform.
          *
          * ```
-          const postInstall = sdk.setupPostInstall(async ({ effects }) => {
-            await sdk.action.requestOwn(effects, showSecretPhrase, 'important', {
-              reason: 'Check out your secret phrase!',
-            })
-          })
+          export const uninit = sdk.setupUninit(
+            versions,
+          )
          * ```
          */
-        setupPostInstall: (fn: InstallFn<Manifest>) => PostInstall<Manifest>;
+        setupUninit: typeof 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.
          * @param inputSpec - The inputSpec spec of this service as exported from /inputSpec/spec.
@@ -394,7 +414,7 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
                 schemeOverride: null,
                 username: null,
                 path: '',
-                search: {},
+                query: {},
               })
               // Admin UI
               const adminUi = sdk.createInterface(effects, {
@@ -406,7 +426,7 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
                 schemeOverride: null,
                 username: null,
                 path: '/admin',
-                search: {},
+                query: {},
               })
               // UI receipt
               const uiReceipt = await uiMultiOrigin.export([primaryUi, adminUi])
@@ -426,7 +446,7 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
                 schemeOverride: null,
                 username: null,
                 path: '',
-                search: {},
+                query: {},
               })
               // API receipt
               const apiReceipt = await apiMultiOrigin.export([api])
@@ -442,10 +462,6 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
             effects: Effects;
             started(onTerm: () => PromiseLike<void>): PromiseLike<null>;
         }) => Promise<Daemons<Manifest, any>>) => T.ExpectedExports.main;
-        /**
-         * Use this function to execute arbitrary logic *once*, on uninstall only. Most services will not use this.
-         */
-        setupUninstall: (fn: UninstallFn<Manifest>) => import("./inits/setupUninstall").Uninstall<Manifest>;
         trigger: {
             defaultTrigger: import("./trigger").Trigger;
             cooldownTrigger: typeof cooldownTrigger;
@@ -520,7 +536,7 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
             of(effects: Effects, image: {
                 imageId: T.ImageId & keyof Manifest["images"];
                 sharedRun?: boolean;
-            }, mounts: Mounts<Manifest> | null, name: string): Promise<SubContainer<T.SDKManifest, Effects>>;
+            }, mounts: Mounts<Manifest> | null, name: string): Promise<SubContainerOwned<Manifest, Effects>>;
             /**
              * @description Run a function with a temporary SubContainer
              * @param effects
@@ -572,10 +588,6 @@ export declare class StartSdk<Manifest extends T.SDKManifest> {
             hostnames: string[];
             algorithm?: "ecdsa" | "ed25519";
         }) => Promise<string>;
-        setDataVersion: (effects: Effects, options: {
-            version: string;
-        }) => Promise<null>;
-        getDataVersion: (effects: Effects) => Promise<string | null>;
         manifest: Manifest;
     };
 }

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");
@@ -68,10 +66,11 @@ const T = __importStar(require("../../base/lib/types"));
 const exver_1 = require("../../base/lib/exver");
 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.1");
+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;
@@ -93,8 +92,6 @@ class StartSdk {
             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),
@@ -102,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({
@@ -301,7 +300,7 @@ class StartSdk {
                 schemeOverride: null,
                 username: null,
                 path: '',
-                search: {},
+                query: {},
               })
              * ```
              */
@@ -376,33 +375,61 @@ class StartSdk {
              * ```
              */
             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 every time the service initializes
+             */
+            setupOnInit: inits_1.setupOnInit,
+            /**
+             * @description Use this function to create an InitScript that runs only when the service is freshly installed
+             */
+            setupOnInstall: inits_1.setupOnInstall,
+            /**
+             * @description Use this function to create an InitScript that runs only when the service is updated
+             */
+            setupOnUpdate: inits_1.setupOnUpdate,
+            /**
+             * @description Use this function to create an InitScript that runs only when the service is installed or updated
+             */
+            setupOnInstallOrUpdate: inits_1.setupOnInstallOrUpdate,
+            /**
+             * @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(
+                restoreInit,
+                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 create a task for the user to perform.
              *
              * ```
-              const postInstall = sdk.setupPostInstall(async ({ effects }) => {
-                await sdk.action.requestOwn(effects, showSecretPhrase, 'important', {
-                  reason: 'Check out your secret phrase!',
-                })
-              })
+              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.
              * @param inputSpec - The inputSpec spec of this service as exported from /inputSpec/spec.
@@ -428,7 +455,7 @@ class StartSdk {
                     schemeOverride: null,
                     username: null,
                     path: '',
-                    search: {},
+                    query: {},
                   })
                   // Admin UI
                   const adminUi = sdk.createInterface(effects, {
@@ -440,7 +467,7 @@ class StartSdk {
                     schemeOverride: null,
                     username: null,
                     path: '/admin',
-                    search: {},
+                    query: {},
                   })
                   // UI receipt
                   const uiReceipt = await uiMultiOrigin.export([primaryUi, adminUi])
@@ -460,7 +487,7 @@ class StartSdk {
                     schemeOverride: null,
                     username: null,
                     path: '',
-                    search: {},
+                    query: {},
                   })
                   // API receipt
                   const apiReceipt = await apiMultiOrigin.export([api])
@@ -473,10 +500,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,
@@ -542,7 +565,7 @@ class StartSdk {
                  * @param name - a name to use to refer to the subcontainer for debugging purposes
                  */
                 of(effects, image, mounts, name) {
-                    return SubContainer_1.SubContainer.of(effects, image, mounts, name);
+                    return SubContainer_1.SubContainerOwned.of(effects, image, mounts, name);
                 },
                 /**
                  * @description Run a function with a temporary SubContainer
@@ -552,7 +575,7 @@ class StartSdk {
                  * @param name - a name to use to refer to the ephemeral subcontainer for debugging purposes
                  */
                 withTemp(effects, image, mounts, name, fn) {
-                    return SubContainer_1.SubContainer.withTemp(effects, image, mounts, name, fn);
+                    return SubContainer_1.SubContainerOwned.withTemp(effects, image, mounts, name, fn);
                 },
             },
             List: list_1.List,
@@ -564,7 +587,7 @@ class StartSdk {
 exports.StartSdk = StartSdk;
 async function runCommand(effects, image, command, options, name) {
     let commands;
-    if (command instanceof T.UseEntrypoint) {
+    if (T.isUseEntrypoint(command)) {
         const imageMeta = await fs
             .readFile(`/media/startos/images/${image.imageId}.json`, {
             encoding: "utf8",
@@ -576,7 +599,7 @@ async function runCommand(effects, image, command, options, name) {
     }
     else
         commands = (0, util_4.splitCommand)(command);
-    return SubContainer_1.SubContainer.withTemp(effects, image, options.mounts, name ||
+    return SubContainer_1.SubContainerOwned.withTemp(effects, image, options.mounts, name ||
         commands
             .map((c) => {
             if (c.includes(" ")) {