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

package/cjs/lib/test/output.sdk.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { VersionGraph } from "../version/VersionGraph";
 export type Manifest = any;
 export declare const sdk: {
     checkDependencies: <DependencyId extends string = string>(effects: import("../types").Effects, packageIds?: DependencyId[] | undefined) => Promise<import("../dependencies/dependencies").CheckDependencies<DependencyId>>;
@@ -78,8 +79,6 @@ export declare const sdk: {
     }) => Promise<import("../types").ActionResult>) => import("../actions/createAction").CreatedAction<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -140,7 +139,6 @@ export declare const sdk: {
         id: string;
         description: string;
         hasPrimary: boolean;
-        disabled: boolean;
         type: import("../StartSdk").ServiceInterfaceType;
         username: string | null;
         path: string;
@@ -165,8 +163,6 @@ export declare const sdk: {
     }> | import("../config/builder").Config<Type_1, never>) => import("../actions/createAction").CreatedAction<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -238,8 +234,6 @@ export declare const sdk: {
     setupBackups: (...args: import("../backup/setupBackups").SetupBackupsParams<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -281,8 +275,6 @@ export declare const sdk: {
     }>, Type_2 extends Record<string, any> = import("../config/builder/config").ExtractConfigType<ConfigType_2>>(spec: ConfigType_2, write: import("../config/setupConfig").Save<Type_2>, read: import("../config/setupConfig").Read<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -324,8 +316,6 @@ export declare const sdk: {
     setupConfigRead: <ConfigSpec extends import("../config/builder").Config<Record<string, any>, any> | import("../config/builder").Config<Record<string, never>, never>>(_configSpec: ConfigSpec, fn: import("../config/setupConfig").Read<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -363,8 +353,6 @@ export declare const sdk: {
     }, ConfigSpec>) => import("../config/setupConfig").Read<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -409,8 +397,6 @@ export declare const sdk: {
         [x: string]: import("../dependencies/DependencyConfig").DependencyConfig<{
             id: "testOutput";
             title: string;
-            version: "1.0:0";
-            releaseNotes: string;
             license: string;
             replaces: never[];
             wrapperRepo: string;
@@ -449,8 +435,6 @@ export declare const sdk: {
         "remote-test": import("../dependencies/DependencyConfig").DependencyConfig<{
             id: "testOutput";
             title: string;
-            version: "1.0:0";
-            releaseNotes: string;
             license: string;
             replaces: never[];
             wrapperRepo: string;
@@ -500,50 +484,9 @@ export declare const sdk: {
         effects: import("../types").Effects;
         input: Input_1;
     }) => Promise<import("../config/setupConfig").DependenciesReceipt>;
-    setupInit: (migrations: import("../inits/migrations/setupMigrations").Migrations<{
+    setupInit: (versions: VersionGraph<string>, install: import("../inits/setupInstall").Install<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
-        license: string;
-        replaces: never[];
-        wrapperRepo: string;
-        upstreamRepo: string;
-        supportSite: string;
-        marketingSite: string;
-        donationUrl: null;
-        description: {
-            short: string;
-            long: string;
-        };
-        containers: {};
-        images: {};
-        volumes: never[];
-        assets: never[];
-        alerts: {
-            install: null;
-            update: null;
-            uninstall: null;
-            restore: null;
-            start: null;
-            stop: null;
-        };
-        dependencies: {
-            "remote-test": {
-                description: string;
-                optional: false;
-                s9pk: string;
-            };
-        };
-    } & import("../osBindings").Manifest, {
-        storeRoot: {
-            storeLeaf: "value";
-        };
-    }>, install: import("../inits/setupInstall").Install<{
-        id: "testOutput";
-        title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -581,8 +524,6 @@ export declare const sdk: {
     }>, uninstall: import("../inits/setupUninstall").Uninstall<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -620,8 +561,6 @@ export declare const sdk: {
     }>, setInterfaces: import("../interfaces/setupInterfaces").SetInterfaces<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -666,8 +605,6 @@ export declare const sdk: {
     setupInstall: (fn: import("../inits/setupInstall").InstallFn<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -705,8 +642,6 @@ export declare const sdk: {
     }>) => import("../inits/setupInstall").Install<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -749,8 +684,6 @@ export declare const sdk: {
     }>, fn: import("../interfaces/setupInterfaces").SetInterfaces<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -788,8 +721,6 @@ export declare const sdk: {
     }, ConfigInput, Output>) => import("../interfaces/setupInterfaces").SetInterfaces<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -831,8 +762,6 @@ export declare const sdk: {
     }) => Promise<import("..").Daemons<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -864,93 +793,12 @@ export declare const sdk: {
             };
         };
     } & import("../osBindings").Manifest, any>>) => import("../types").ExpectedExports.main;
-    setupMigrations: <Migrations extends import("../inits/migrations/Migration").Migration<{
-        id: "testOutput";
-        title: string;
-        version: "1.0:0";
-        releaseNotes: string;
-        license: string;
-        replaces: never[];
-        wrapperRepo: string;
-        upstreamRepo: string;
-        supportSite: string;
-        marketingSite: string;
-        donationUrl: null;
-        description: {
-            short: string;
-            long: string;
-        };
-        containers: {};
-        images: {};
-        volumes: never[];
-        assets: never[];
-        alerts: {
-            install: null;
-            update: null;
-            uninstall: null;
-            restore: null;
-            start: null;
-            stop: null;
-        };
-        dependencies: {
-            "remote-test": {
-                description: string;
-                optional: false;
-                s9pk: string;
-            };
-        };
-    } & import("../osBindings").Manifest, {
-        storeRoot: {
-            storeLeaf: "value";
-        };
-    }, any>[]>(...migrations: import("../inits/migrations/setupMigrations").EnsureUniqueId<Migrations, Migrations, never>) => import("../inits/migrations/setupMigrations").Migrations<{
-        id: "testOutput";
-        title: string;
-        version: "1.0:0";
-        releaseNotes: string;
-        license: string;
-        replaces: never[];
-        wrapperRepo: string;
-        upstreamRepo: string;
-        supportSite: string;
-        marketingSite: string;
-        donationUrl: null;
-        description: {
-            short: string;
-            long: string;
-        };
-        containers: {};
-        images: {};
-        volumes: never[];
-        assets: never[];
-        alerts: {
-            install: null;
-            update: null;
-            uninstall: null;
-            restore: null;
-            start: null;
-            stop: null;
-        };
-        dependencies: {
-            "remote-test": {
-                description: string;
-                optional: false;
-                s9pk: string;
-            };
-        };
-    } & import("../osBindings").Manifest, {
-        storeRoot: {
-            storeLeaf: "value";
-        };
-    }>;
     setupProperties: (fn: (options: {
         effects: import("../types").Effects;
     }) => Promise<import("../types").SdkPropertiesReturn>) => import("../types").ExpectedExports.properties;
     setupUninstall: (fn: import("../inits/setupUninstall").UninstallFn<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -988,8 +836,6 @@ export declare const sdk: {
     }>) => import("../inits/setupUninstall").Uninstall<{
         id: "testOutput";
         title: string;
-        version: "1.0:0";
-        releaseNotes: string;
         license: string;
         replaces: never[];
         wrapperRepo: string;
@@ -1038,8 +884,6 @@ export declare const sdk: {
         of(): import("../mainFn/Mounts").Mounts<{
             id: "testOutput";
             title: string;
-            version: "1.0:0";
-            releaseNotes: string;
             license: string;
             replaces: never[];
             wrapperRepo: string;
@@ -1076,8 +920,6 @@ export declare const sdk: {
         volumes: (...volumeNames: never[]) => import("../backup/Backups").Backups<{
             id: "testOutput";
             title: string;
-            version: "1.0:0";
-            releaseNotes: string;
             license: string;
             replaces: never[];
             wrapperRepo: string;
@@ -1135,8 +977,6 @@ export declare const sdk: {
         }): import("..").Daemons<{
             id: "testOutput";
             title: string;
-            version: "1.0:0";
-            releaseNotes: string;
             license: string;
             replaces: never[];
             wrapperRepo: string;
@@ -1185,8 +1025,6 @@ export declare const sdk: {
         }): import("../dependencies/DependencyConfig").DependencyConfig<{
             id: "testOutput";
             title: string;
-            version: "1.0:0";
-            releaseNotes: string;
             license: string;
             replaces: never[];
             wrapperRepo: string;
@@ -1272,56 +1110,6 @@ export declare const sdk: {
             };
         }>;
     };
-    Migration: {
-        of: <Version extends string>(options: {
-            version: Version & import("../exver").ValidateExVer<Version>;
-            up: (opts: {
-                effects: import("../types").Effects;
-            }) => Promise<void>;
-            down: (opts: {
-                effects: import("../types").Effects;
-            }) => Promise<void>;
-        }) => import("../inits/migrations/Migration").Migration<{
-            id: "testOutput";
-            title: string;
-            version: "1.0:0";
-            releaseNotes: string;
-            license: string;
-            replaces: never[];
-            wrapperRepo: string;
-            upstreamRepo: string;
-            supportSite: string;
-            marketingSite: string;
-            donationUrl: null;
-            description: {
-                short: string;
-                long: string;
-            };
-            containers: {};
-            images: {};
-            volumes: never[];
-            assets: never[];
-            alerts: {
-                install: null;
-                update: null;
-                uninstall: null;
-                restore: null;
-                start: null;
-                stop: null;
-            };
-            dependencies: {
-                "remote-test": {
-                    description: string;
-                    optional: false;
-                    s9pk: string;
-                };
-            };
-        } & import("../osBindings").Manifest, {
-            storeRoot: {
-                storeLeaf: "value";
-            };
-        }, Version>;
-    };
     StorePath: import("../store/PathBuilder").PathBuilder<{
         storeRoot: {
             storeLeaf: "value";

package/cjs/lib/test/output.sdk.js

@@ -3,12 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sdk = void 0;
 const StartSdk_1 = require("../StartSdk");
 const setupManifest_1 = require("../manifest/setupManifest");
+const VersionInfo_1 = require("../version/VersionInfo");
+const VersionGraph_1 = require("../version/VersionGraph");
 exports.sdk = StartSdk_1.StartSdk.of()
-    .withManifest((0, setupManifest_1.setupManifest)({
+    .withManifest((0, setupManifest_1.setupManifest)(VersionGraph_1.VersionGraph.of(VersionInfo_1.VersionInfo.of({
+    version: "1.0.0:0",
+    releaseNotes: "",
+    migrations: {},
+})
+    .satisfies("#other:1.0.0:0")
+    .satisfies("#other:2.0.0:0")), {
     id: "testOutput",
     title: "",
-    version: "1.0:0",
-    releaseNotes: "",
     license: "",
     replaces: [],
     wrapperRepo: "",

package/cjs/lib/test/output.sdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"output.sdk.js","sourceRoot":"","sources":["../../../../lib/test/output.sdk.ts"],"names":[],"mappings":";;;AAAA,0CAAsC;AACtC,6DAAyD;AAG5C,QAAA,GAAG,GAAG,mBAAQ,CAAC,EAAE,EAAE;KAC7B,YAAY,CACX,IAAA,6BAAa,EAAC;IACZ,EAAE,EAAE,YAAY;IAChB,KAAK,EAAE,EAAE;IACT,OAAO,EAAE,OAAO;IAChB,YAAY,EAAE,EAAE;IAChB,OAAO,EAAE,EAAE;IACX,QAAQ,EAAE,EAAE;IACZ,WAAW,EAAE,EAAE;IACf,YAAY,EAAE,EAAE;IAChB,WAAW,EAAE,EAAE;IACf,aAAa,EAAE,EAAE;IACjB,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE;QACX,KAAK,EAAE,EAAE;QACT,IAAI,EAAE,EAAE;KACT;IACD,UAAU,EAAE,EAAE;IACd,MAAM,EAAE,EAAE;IACV,OAAO,EAAE,EAAE;IACX,MAAM,EAAE,EAAE;IACV,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,IAAI;KACX;IACD,YAAY,EAAE;QACZ,aAAa,EAAE;YACb,WAAW,EAAE,EAAE;YACf,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,sCAAsC;SAC7C;KACF;CACF,CAAC,CACH;KACA,SAAS,EAAyC;KAClD,KAAK,CAAC,IAAI,CAAC,CAAA"}
+{"version":3,"file":"output.sdk.js","sourceRoot":"","sources":["../../../../lib/test/output.sdk.ts"],"names":[],"mappings":";;;AAAA,0CAAsC;AACtC,6DAAyD;AACzD,wDAAoD;AACpD,0DAAsD;AAGzC,QAAA,GAAG,GAAG,mBAAQ,CAAC,EAAE,EAAE;KAC7B,YAAY,CACX,IAAA,6BAAa,EACX,2BAAY,CAAC,EAAE,CACb,yBAAW,CAAC,EAAE,CAAC;IACb,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,EAAE;IAChB,UAAU,EAAE,EAAE;CACf,CAAC;KACC,SAAS,CAAC,gBAAgB,CAAC;KAC3B,SAAS,CAAC,gBAAgB,CAAC,CAC/B,EACD;IACE,EAAE,EAAE,YAAY;IAChB,KAAK,EAAE,EAAE;IACT,OAAO,EAAE,EAAE;IACX,QAAQ,EAAE,EAAE;IACZ,WAAW,EAAE,EAAE;IACf,YAAY,EAAE,EAAE;IAChB,WAAW,EAAE,EAAE;IACf,aAAa,EAAE,EAAE;IACjB,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE;QACX,KAAK,EAAE,EAAE;QACT,IAAI,EAAE,EAAE;KACT;IACD,UAAU,EAAE,EAAE;IACd,MAAM,EAAE,EAAE;IACV,OAAO,EAAE,EAAE;IACX,MAAM,EAAE,EAAE;IACV,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,IAAI;KACX;IACD,YAAY,EAAE;QACZ,aAAa,EAAE;YACb,WAAW,EAAE,EAAE;YACf,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,sCAAsC;SAC7C;KACF;CACF,CACF,CACF;KACA,SAAS,EAAyC;KAClD,KAAK,CAAC,IAAI,CAAC,CAAA"}

package/cjs/lib/test/startosTypeValidation.test.js

@@ -16,6 +16,8 @@ describe("startosTypeValidation ", () => {
             restart: undefined,
             shutdown: undefined,
             setConfigured: {},
+            setDataVersion: {},
+            getDataVersion: undefined,
             setHealth: {},
             exposeForDependents: {},
             getSslCertificate: {},

package/cjs/lib/test/startosTypeValidation.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"startosTypeValidation.test.js","sourceRoot":"","sources":["../../../../lib/test/startosTypeValidation.test.ts"],"names":[],"mappings":";;AAyBA,SAAS,YAAY,CAAe,EAAgB,IAAG,CAAC;AAIxD,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACrC,MAAM,SAAS,GAAQ,EAAE,CAAA;QACzB,YAAY,CAIT;YACD,aAAa,EAAE,EAAmB;YAClC,oBAAoB,EAAE,EAAgC;YACtD,qBAAqB,EAAE,EAAiC;YACxD,aAAa,EAAE,SAAS;YACxB,oBAAoB,EAAE,SAAS;YAC/B,IAAI,EAAE,EAAgB;YACtB,WAAW,EAAE,EAAqC;YAClD,aAAa,EAAE,EAAyB;YACxC,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,SAAS;YACnB,aAAa,EAAE,EAAmB;YAClC,SAAS,EAAE,EAAe;YAC1B,mBAAmB,EAAE,EAA+B;YACpD,iBAAiB,EAAE,EAA2C;YAC9D,SAAS,EAAE,EAAqB;YAChC,mBAAmB,EAAE,EAA6C;YAClE,eAAe,EAAE,EAA2B;YAC5C,KAAK,EAAE,EAAW;YAClB,aAAa,EAAE,EAAuC;YACtD,cAAc,EAAE,SAAS;YACzB,qBAAqB,EAAE,EAAiC;YACxD,sBAAsB,EAAE,SAAS;YACjC,sBAAsB,EAAE,EAAkC;YAC1D,aAAa,EAAE,EAAuC;YACtD,qBAAqB,EAAE,EAA+C;YACtE,YAAY,EAAE,EAAwB;YACtC,YAAY,EAAE,SAAS;YACvB,KAAK,EAAE,EAAiB;YACxB,iBAAiB,EAAE,EAA4B;YAC/C,eAAe,EAAE,SAAS;YAC1B,aAAa,EAAE,EAAmB;SACnC,CAAC,CAAA;QACF,YAAY,CACV,SAA0B,CAC3B,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"startosTypeValidation.test.js","sourceRoot":"","sources":["../../../../lib/test/startosTypeValidation.test.ts"],"names":[],"mappings":";;AA0BA,SAAS,YAAY,CAAe,EAAgB,IAAG,CAAC;AAIxD,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACrC,MAAM,SAAS,GAAQ,EAAE,CAAA;QACzB,YAAY,CAIT;YACD,aAAa,EAAE,EAAmB;YAClC,oBAAoB,EAAE,EAAgC;YACtD,qBAAqB,EAAE,EAAiC;YACxD,aAAa,EAAE,SAAS;YACxB,oBAAoB,EAAE,SAAS;YAC/B,IAAI,EAAE,EAAgB;YACtB,WAAW,EAAE,EAAqC;YAClD,aAAa,EAAE,EAAyB;YACxC,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,SAAS;YACnB,aAAa,EAAE,EAAmB;YAClC,cAAc,EAAE,EAA0B;YAC1C,cAAc,EAAE,SAAS;YACzB,SAAS,EAAE,EAAe;YAC1B,mBAAmB,EAAE,EAA+B;YACpD,iBAAiB,EAAE,EAA2C;YAC9D,SAAS,EAAE,EAAqB;YAChC,mBAAmB,EAAE,EAA6C;YAClE,eAAe,EAAE,EAA2B;YAC5C,KAAK,EAAE,EAAW;YAClB,aAAa,EAAE,EAAuC;YACtD,cAAc,EAAE,SAAS;YACzB,qBAAqB,EAAE,EAAiC;YACxD,sBAAsB,EAAE,SAAS;YACjC,sBAAsB,EAAE,EAAkC;YAC1D,aAAa,EAAE,EAAuC;YACtD,qBAAqB,EAAE,EAA+C;YACtE,YAAY,EAAE,EAAwB;YACtC,YAAY,EAAE,SAAS;YACvB,KAAK,EAAE,EAAiB;YACxB,iBAAiB,EAAE,EAA4B;YAC/C,eAAe,EAAE,SAAS;YAC1B,aAAa,EAAE,EAAmB;SACnC,CAAC,CAAA;QACF,YAAY,CACV,SAA0B,CAC3B,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/cjs/lib/types.d.ts

@@ -78,7 +78,6 @@ export declare namespace ExpectedExports {
      */
     type init = (options: {
         effects: Effects;
-        previousVersion: null | string;
     }) => Promise<unknown>;
     /** This will be ran during any time a package is uninstalled, for example during a update
      * this will be called.
@@ -215,15 +214,15 @@ export type SdkPropertiesValue = {
     description?: string;
 } | {
     type: "string";
-    /** Value  */
+    /** The value to display to the user */
     value: string;
     /** A human readable description or explanation of the value */
     description?: string;
-    /** (string/number only) Whether or not to mask the value, for example, when displaying a password */
+    /** Whether or not to mask the value, for example, when displaying a password */
     masked: boolean;
-    /** (string/number only) Whether or not to include a button for copying the value to clipboard */
+    /** Whether or not to include a button for copying the value to clipboard */
     copyable?: boolean;
-    /** (string/number only) Whether or not to include a button for displaying the value as a QR code */
+    /** Whether or not to include a button for displaying the value as a QR code */
     qr?: boolean;
 };
 export type SdkPropertiesReturn = {
@@ -237,15 +236,15 @@ export type PropertiesValue = {
     description: string | null;
 } | {
     type: "string";
-    /** Value  */
+    /** The value to display to the user */
     value: string;
     /** A human readable description or explanation of the value */
     description: string | null;
-    /** (string/number only) Whether or not to mask the value, for example, when displaying a password */
+    /** Whether or not to mask the value, for example, when displaying a password */
     masked: boolean;
-    /** (string/number only) Whether or not to include a button for copying the value to clipboard */
+    /** Whether or not to include a button for copying the value to clipboard */
     copyable: boolean | null;
-    /** (string/number only) Whether or not to include a button for displaying the value as a QR code */
+    /** Whether or not to include a button for displaying the value as a QR code */
     qr: boolean | null;
 };
 export type PropertiesReturn = {
@@ -382,6 +381,12 @@ export type Effects = {
             value: ExtractStore;
         }): Promise<void>;
     };
+    /** sets the version that this service's data has been migrated to */
+    setDataVersion(options: {
+        version: string;
+    }): Promise<void>;
+    /** returns the version that this service's data has been migrated to */
+    getDataVersion(): Promise<string | null>;
     /** Returns globally configured SMTP settings, if they exist */
     getSystemSmtp(options: {
         callback?: () => void;
@@ -416,12 +421,11 @@ export type MigrationRes = {
     configured: boolean;
 };
 export type ActionResult = {
+    version: "0";
     message: string;
-    value: null | {
-        value: string;
-        copyable: boolean;
-        qr: boolean;
-    };
+    value: string | null;
+    copyable: boolean;
+    qr: boolean;
 };
 export type SetResult = {
     dependsOn: DependsOn;

package/cjs/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAmD;AA2BnD,+CAA4B;AAU5B,IAAiB,eAAe,CAyF/B;AAzFD,WAAiB,eAAe;IAC9B,OAAO,EAAE,CAAC,CAAA;AAwFZ,CAAC,EAzFgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAyF/B"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAmD;AA2BnD,+CAA4B;AAU5B,IAAiB,eAAe,CAsF/B;AAtFD,WAAiB,eAAe;IAC9B,OAAO,EAAE,CAAC,CAAA;AAqFZ,CAAC,EAtFgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAsF/B"}

package/cjs/lib/util/Overlay.d.ts

@@ -5,11 +5,35 @@ import * as T from "../types";
 import * as cp from "child_process";
 import { Buffer } from "node:buffer";
 export declare const execFile: typeof cp.execFile.__promisify__;
-export declare class Overlay {
+type ExecResults = {
+    exitCode: number | null;
+    exitSignal: NodeJS.Signals | null;
+    stdout: string | Buffer;
+    stderr: string | Buffer;
+};
+/**
+ * This is the type that is going to describe what an overlay could do. The main point of the
+ * overlay is to have commands that run in a chrooted environment. This is useful for running
+ * commands in a containerized environment. But, I wanted the destroy to sometimes be doable, for example the
+ * case where the overlay isn't owned by the process, the overlay shouldn't be destroyed.
+ */
+export interface ExecSpawnable {
+    get destroy(): undefined | (() => Promise<void>);
+    exec(command: string[], options?: CommandOptions, timeoutMs?: number | null): Promise<ExecResults>;
+    spawn(command: string[], options?: CommandOptions): Promise<cp.ChildProcessWithoutNullStreams>;
+}
+/**
+ * Want to limit what we can do in a container, so we want to launch a container with a specific image and the mounts.
+ *
+ * Implements:
+ * @see {@link ExecSpawnable}
+ */
+export declare class Overlay implements ExecSpawnable {
     readonly effects: T.Effects;
     readonly imageId: T.ImageId;
     readonly rootfs: string;
     readonly guid: T.Guid;
+    private destroyed;
     private constructor();
     static of(effects: T.Effects, image: {
         id: T.ImageId;
@@ -23,7 +47,7 @@ export declare class Overlay {
         path: string;
     }[], fn: (overlay: Overlay) => Promise<T>): Promise<T>;
     mount(options: MountOptions, path: string): Promise<Overlay>;
-    destroy(): Promise<void>;
+    get destroy(): () => Promise<void>;
     exec(command: string[], options?: CommandOptions, timeoutMs?: number | null): Promise<{
         exitCode: number | null;
         exitSignal: NodeJS.Signals | null;
@@ -32,6 +56,18 @@ export declare class Overlay {
     }>;
     spawn(command: string[], options?: CommandOptions): Promise<cp.ChildProcessWithoutNullStreams>;
 }
+/**
+ * Take an overlay but remove the ability to add the mounts and the destroy function.
+ * Lets other functions, like health checks, to not destroy the parents.
+ *
+ */
+export declare class NonDestroyableOverlay implements ExecSpawnable {
+    private overlay;
+    constructor(overlay: ExecSpawnable);
+    get destroy(): undefined;
+    exec(command: string[], options?: CommandOptions, timeoutMs?: number | null): Promise<ExecResults>;
+    spawn(command: string[], options?: CommandOptions): Promise<cp.ChildProcessWithoutNullStreams>;
+}
 export type CommandOptions = {
     env?: {
         [variable: string]: string;
@@ -62,3 +98,4 @@ export type MountOptionsBackup = {
     type: "backup";
     subpath: string | null;
 };
+export {};

package/cjs/lib/util/Overlay.js

@@ -23,19 +23,26 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Overlay = exports.execFile = void 0;
+exports.NonDestroyableOverlay = exports.Overlay = exports.execFile = void 0;
 const fs = __importStar(require("fs/promises"));
 const cp = __importStar(require("child_process"));
 const util_1 = require("util");
 const node_buffer_1 = require("node:buffer");
 exports.execFile = (0, util_1.promisify)(cp.execFile);
 const WORKDIR = (imageId) => `/media/startos/images/${imageId}/`;
+/**
+ * Want to limit what we can do in a container, so we want to launch a container with a specific image and the mounts.
+ *
+ * Implements:
+ * @see {@link ExecSpawnable}
+ */
 class Overlay {
     constructor(effects, imageId, rootfs, guid) {
         this.effects = effects;
         this.imageId = imageId;
         this.rootfs = rootfs;
         this.guid = guid;
+        this.destroyed = false;
     }
     static async of(effects, image) {
         const { id, sharedRun } = image;
@@ -81,7 +88,7 @@ class Overlay {
             const from = `/media/startos/volumes/${options.id}${subpath}`;
             await fs.mkdir(from, { recursive: true });
             await fs.mkdir(path, { recursive: true });
-            await await (0, exports.execFile)("mount", ["--bind", from, path]);
+            await (0, exports.execFile)("mount", ["--bind", from, path]);
         }
         else if (options.type === "assets") {
             const subpath = options.subpath
@@ -113,10 +120,15 @@ class Overlay {
         }
         return this;
     }
-    async destroy() {
-        const imageId = this.imageId;
-        const guid = this.guid;
-        await this.effects.destroyOverlayedImage({ guid });
+    get destroy() {
+        return async () => {
+            if (this.destroyed)
+                return;
+            this.destroyed = true;
+            const imageId = this.imageId;
+            const guid = this.guid;
+            await this.effects.destroyOverlayedImage({ guid });
+        };
     }
     async exec(command, options, timeoutMs = 30000) {
         const imageMeta = await fs
@@ -203,4 +215,24 @@ class Overlay {
     }
 }
 exports.Overlay = Overlay;
+/**
+ * Take an overlay but remove the ability to add the mounts and the destroy function.
+ * Lets other functions, like health checks, to not destroy the parents.
+ *
+ */
+class NonDestroyableOverlay {
+    constructor(overlay) {
+        this.overlay = overlay;
+    }
+    get destroy() {
+        return undefined;
+    }
+    exec(command, options, timeoutMs) {
+        return this.overlay.exec(command, options, timeoutMs);
+    }
+    spawn(command, options) {
+        return this.overlay.spawn(command, options);
+    }
+}
+exports.NonDestroyableOverlay = NonDestroyableOverlay;
 //# sourceMappingURL=Overlay.js.map