@start9labs/start-sdk 0.3.6-alpha8 → 0.3.6-beta.0

package/package/lib/store/getStore.d.ts

@@ -0,0 +1,30 @@
+import { Effects } from "../../../base/lib/Effects";
+import { PathBuilder } from "../util";
+export declare class GetStore<Store, StoreValue> {
+    readonly effects: Effects;
+    readonly path: PathBuilder<Store, StoreValue>;
+    readonly options: {
+        /** Defaults to what ever the package currently in */
+        packageId?: string | undefined;
+    };
+    constructor(effects: Effects, path: PathBuilder<Store, StoreValue>, options?: {
+        /** Defaults to what ever the package currently in */
+        packageId?: string | undefined;
+    });
+    /**
+     * Returns the value of Store at the provided path. Restart the service if the value changes
+     */
+    const(): Promise<StoreValue>;
+    /**
+     * Returns the value of Store at the provided path. Does nothing if the value changes
+     */
+    once(): Promise<StoreValue>;
+    /**
+     * Watches the value of Store at the provided path. Takes a custom callback function to run whenever the value changes
+     */
+    watch(): AsyncGenerator<Awaited<StoreValue>, void, unknown>;
+}
+export declare function getStore<Store, StoreValue>(effects: Effects, path: PathBuilder<Store, StoreValue>, options?: {
+    /** Defaults to what ever the package currently in */
+    packageId?: string | undefined;
+}): GetStore<Store, StoreValue>;

package/package/lib/store/getStore.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStore = exports.GetStore = void 0;
+const util_1 = require("../util");
+class GetStore {
+    constructor(effects, path, options = {}) {
+        this.effects = effects;
+        this.path = path;
+        this.options = options;
+    }
+    /**
+     * Returns the value of Store at the provided path. Restart the service if the value changes
+     */
+    const() {
+        return this.effects.store.get({
+            ...this.options,
+            path: (0, util_1.extractJsonPath)(this.path),
+            callback: () => this.effects.constRetry(),
+        });
+    }
+    /**
+     * Returns the value of Store at the provided path. Does nothing if the value changes
+     */
+    once() {
+        return this.effects.store.get({
+            ...this.options,
+            path: (0, util_1.extractJsonPath)(this.path),
+        });
+    }
+    /**
+     * Watches the value of Store at the provided path. Takes a custom callback function to run whenever the value changes
+     */
+    async *watch() {
+        while (true) {
+            let callback;
+            const waitForNext = new Promise((resolve) => {
+                callback = resolve;
+            });
+            yield await this.effects.store.get({
+                ...this.options,
+                path: (0, util_1.extractJsonPath)(this.path),
+                callback: () => callback(),
+            });
+            await waitForNext;
+        }
+    }
+}
+exports.GetStore = GetStore;
+function getStore(effects, path, options = {}) {
+    return new GetStore(effects, path, options);
+}
+exports.getStore = getStore;
+//# sourceMappingURL=getStore.js.map

package/package/lib/store/getStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getStore.js","sourceRoot":"","sources":["../../../../package/lib/store/getStore.ts"],"names":[],"mappings":";;;AACA,kCAAsD;AAEtD,MAAa,QAAQ;IACnB,YACW,OAAgB,EAChB,IAAoC,EACpC,UAGL,EAAE;QALG,YAAO,GAAP,OAAO,CAAS;QAChB,SAAI,GAAJ,IAAI,CAAgC;QACpC,YAAO,GAAP,OAAO,CAGV;IACL,CAAC;IAEJ;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAoB;YAC/C,GAAG,IAAI,CAAC,OAAO;YACf,IAAI,EAAE,IAAA,sBAAe,EAAC,IAAI,CAAC,IAAI,CAAC;YAChC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;SAC1C,CAAC,CAAA;IACJ,CAAC;IACD;;OAEG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAoB;YAC/C,GAAG,IAAI,CAAC,OAAO;YACf,IAAI,EAAE,IAAA,sBAAe,EAAC,IAAI,CAAC,IAAI,CAAC;SACjC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,KAAK;QACV,OAAO,IAAI,EAAE;YACX,IAAI,QAAoB,CAAA;YACxB,MAAM,WAAW,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAChD,QAAQ,GAAG,OAAO,CAAA;YACpB,CAAC,CAAC,CAAA;YACF,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAoB;gBACpD,GAAG,IAAI,CAAC,OAAO;gBACf,IAAI,EAAE,IAAA,sBAAe,EAAC,IAAI,CAAC,IAAI,CAAC;gBAChC,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE;aAC3B,CAAC,CAAA;YACF,MAAM,WAAW,CAAA;SAClB;IACH,CAAC;CACF;AA/CD,4BA+CC;AACD,SAAgB,QAAQ,CACtB,OAAgB,EAChB,IAAoC,EACpC,UAGI,EAAE;IAEN,OAAO,IAAI,QAAQ,CAAoB,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAChE,CAAC;AATD,4BASC"}

package/package/lib/store/setupExposeStore.d.ts

@@ -0,0 +1,16 @@
+import { ExposedStorePaths } from "../../../base/lib/types";
+import { PathBuilder } from "../../../base/lib/util/PathBuilder";
+/**
+ * @description Use this function to determine which Store values to expose and make available to other services running on StartOS. Store values not exposed here will be kept private. Use the type safe pathBuilder to traverse your Store's structure.
+ * @example
+ * In this example, we expose the hypothetical Store values "adminPassword" and "nameLastUpdatedAt".
+ *
+ * ```
+  export const exposedStore = setupExposeStore<Store>((pathBuilder) => [
+    pathBuilder.adminPassword
+    pathBuilder.nameLastUpdatedAt,
+  ])
+ * ```
+ */
+export declare const setupExposeStore: <Store extends Record<string, any>>(fn: (pathBuilder: PathBuilder<Store>) => PathBuilder<Store, any>[]) => ExposedStorePaths;
+export { ExposedStorePaths };

package/package/lib/store/setupExposeStore.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupExposeStore = void 0;
+const PathBuilder_1 = require("../../../base/lib/util/PathBuilder");
+/**
+ * @description Use this function to determine which Store values to expose and make available to other services running on StartOS. Store values not exposed here will be kept private. Use the type safe pathBuilder to traverse your Store's structure.
+ * @example
+ * In this example, we expose the hypothetical Store values "adminPassword" and "nameLastUpdatedAt".
+ *
+ * ```
+  export const exposedStore = setupExposeStore<Store>((pathBuilder) => [
+    pathBuilder.adminPassword
+    pathBuilder.nameLastUpdatedAt,
+  ])
+ * ```
+ */
+const setupExposeStore = (fn) => {
+    return fn((0, PathBuilder_1.pathBuilder)()).map((x) => (0, PathBuilder_1.extractJsonPath)(x));
+};
+exports.setupExposeStore = setupExposeStore;
+//# sourceMappingURL=setupExposeStore.js.map

package/package/lib/store/setupExposeStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupExposeStore.js","sourceRoot":"","sources":["../../../../package/lib/store/setupExposeStore.ts"],"names":[],"mappings":";;;AACA,oEAI2C;AAE3C;;;;;;;;;;;GAWG;AACI,MAAM,gBAAgB,GAAG,CAC9B,EAAkE,EAClE,EAAE;IACF,OAAO,EAAE,CAAC,IAAA,yBAAW,GAAS,CAAC,CAAC,GAAG,CACjC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,6BAAe,EAAC,CAAC,CAAW,CACf,CAAA;AACxB,CAAC,CAAA;AANY,QAAA,gBAAgB,oBAM5B"}

package/package/lib/test/health.readyCheck.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.readyCheck.test.js","sourceRoot":"","sources":["../../../../package/lib/test/health.readyCheck.test.ts"],"names":[],"mappings":";;AAAA,8EAAuE;AAEvE,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,IAAI,KAAK,GAAG;;;;;;;GAOb,CAAA;QAEC,MAAM,CAAC,IAAA,oCAAe,EAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC7C,MAAM,CAAC,IAAA,oCAAe,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/package/lib/test/host.test.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ServiceInterfaceBuilder_1 = require("../../../base/lib/interfaces/ServiceInterfaceBuilder");
+const output_sdk_1 = require("../test/output.sdk");
+describe("host", () => {
+    test("Testing that the types work", () => {
+        async function test(effects) {
+            const foo = output_sdk_1.sdk.host.multi(effects, "foo");
+            const fooOrigin = await foo.bindPort(80, {
+                protocol: "http",
+                preferredExternalPort: 80,
+            });
+            const fooInterface = new ServiceInterfaceBuilder_1.ServiceInterfaceBuilder({
+                effects,
+                name: "Foo",
+                id: "foo",
+                description: "A Foo",
+                hasPrimary: false,
+                type: "ui",
+                username: "bar",
+                path: "/baz",
+                search: { qux: "yes" },
+                schemeOverride: null,
+                masked: false,
+            });
+            await fooOrigin.export([fooInterface]);
+        }
+    });
+});
+//# sourceMappingURL=host.test.js.map

package/package/lib/test/host.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.test.js","sourceRoot":"","sources":["../../../../package/lib/test/host.test.ts"],"names":[],"mappings":";;AAAA,kGAA8F;AAE9F,mDAAwC;AAExC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACvC,KAAK,UAAU,IAAI,CAAC,OAAgB;YAClC,MAAM,GAAG,GAAG,gBAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YAC1C,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE;gBACvC,QAAQ,EAAE,MAAe;gBACzB,qBAAqB,EAAE,EAAE;aAC1B,CAAC,CAAA;YACF,MAAM,YAAY,GAAG,IAAI,iDAAuB,CAAC;gBAC/C,OAAO;gBACP,IAAI,EAAE,KAAK;gBACX,EAAE,EAAE,KAAK;gBACT,WAAW,EAAE,OAAO;gBACpB,UAAU,EAAE,KAAK;gBACjB,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,KAAK;gBACf,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;gBACtB,cAAc,EAAE,IAAI;gBACpB,MAAM,EAAE,KAAK;aACd,CAAC,CAAA;YAEF,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QACxC,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}