@start9labs/start-sdk 0.4.0-beta.47 → 0.4.0-beta.49

package/base/lib/s9pk/merkleArchive/directoryContents.js

@@ -13,7 +13,7 @@ class DirectoryContents {
         const position = header.nextU64();
         const size = header.nextU64();
         if (size > maxSize) {
-            throw new Error("size is greater than signed");
+            throw new Error('size is greater than signed');
         }
         const tocReader = new _1.ArrayBufferReader(await source
             .slice(Number(position), Number(position + size))
@@ -27,7 +27,7 @@ class DirectoryContents {
         }
         const res = new DirectoryContents(entries);
         if (!(0, __1.compare)(res.sighash(), sighash)) {
-            throw new Error("hash sum does not match");
+            throw new Error('hash sum does not match');
         }
         return res;
     }

package/base/lib/s9pk/merkleArchive/fileContents.d.ts

@@ -1,4 +1,4 @@
-import { ArrayBufferReader } from ".";
+import { ArrayBufferReader } from '.';
 export declare class FileContents {
     readonly contents: Blob;
     private constructor();

package/base/lib/s9pk/merkleArchive/fileContents.js

@@ -14,7 +14,7 @@ class FileContents {
     async verified(hash) {
         const res = await this.contents.arrayBuffer();
         if (!(0, __1.compare)(hash, (0, blake3_1.blake3)(new Uint8Array(res)))) {
-            throw new Error("hash sum mismatch");
+            throw new Error('hash sum mismatch');
         }
         return res;
     }

package/base/lib/s9pk/merkleArchive/index.d.ts

@@ -1,6 +1,6 @@
-import { MerkleArchiveCommitment } from "../../osBindings";
-import { DirectoryContents } from "./directoryContents";
-import { FileContents } from "./fileContents";
+import { MerkleArchiveCommitment } from '../../osBindings';
+import { DirectoryContents } from './directoryContents';
+import { FileContents } from './fileContents';
 export type Signer = {
     pubkey: Uint8Array;
     signature: Uint8Array;

package/base/lib/s9pk/merkleArchive/index.js

@@ -27,7 +27,7 @@ class ArrayBufferReader {
         }
         const res = p.decode();
         if (res === null) {
-            throw new Error("Reached EOF");
+            throw new Error('Reached EOF');
         }
         return res;
     }
@@ -52,18 +52,18 @@ class MerkleArchive {
             context: new TextEncoder().encode(context),
             zip215: true,
         })) {
-            throw new Error("signature verification failed");
+            throw new Error('signature verification failed');
         }
         if (commitment) {
-            if (!(0, __1.compare)(sighash, new Uint8Array(Buffer.from(commitment.rootSighash, "base64").buffer))) {
-                throw new Error("merkle root mismatch");
+            if (!(0, __1.compare)(sighash, new Uint8Array(Buffer.from(commitment.rootSighash, 'base64').buffer))) {
+                throw new Error('merkle root mismatch');
             }
             if (maxSize > commitment.rootMaxsize) {
-                throw new Error("root directory max size too large");
+                throw new Error('root directory max size too large');
             }
         }
         else if (maxSize > 1024 * 1024) {
-            throw new Error("root directory max size over 1MiB, cancelling download in case of DOS attack");
+            throw new Error('root directory max size over 1MiB, cancelling download in case of DOS attack');
         }
         const contents = await directoryContents_1.DirectoryContents.deserialize(source, header, sighash, maxSize);
         return new MerkleArchive({
@@ -94,10 +94,10 @@ class Entry {
     }
     async verifiedFileContents() {
         if (!this.contents) {
-            throw new Error("file is missing from archive");
+            throw new Error('file is missing from archive');
         }
         if (!(this.contents instanceof fileContents_1.FileContents)) {
-            throw new Error("is not a regular file");
+            throw new Error('is not a regular file');
         }
         return this.contents.verified(this.hash);
     }

package/base/lib/s9pk/merkleArchive/varint.js

@@ -13,7 +13,7 @@ class VarIntProcessor {
     }
     push(b) {
         if (this.i >= maxSize) {
-            throw new Error("Unterminated varint");
+            throw new Error('Unterminated varint');
         }
         this.buf[this.i] = b;
         this.i += 1;

package/base/lib/types/ManifestTypes.d.ts

@@ -1,5 +1,5 @@
-import { T } from "..";
-import { ImageId, ImageSource } from "../types";
+import { T } from '..';
+import { ImageId, ImageSource } from '../types';
 export type SDKManifest = {
     /**
      * The package identifier used by StartOS. This must be unique amongst all other known packages.
@@ -20,22 +20,17 @@ export type SDKManifest = {
      * URL of the StartOS package repository
      * @example `https://github.com/Start9Labs/nextcloud-startos`
      */
-    readonly wrapperRepo: string;
+    readonly packageRepo: string;
     /**
      * URL of the upstream service repository
      * @example `https://github.com/nextcloud/docker`
      */
     readonly upstreamRepo: string;
-    /**
-     * URL where users can get help using the upstream service
-     * @example `https://github.com/nextcloud/docker/issues`
-     */
-    readonly supportSite: string;
     /**
      * URL where users can learn more about the upstream service
      * @example `https://nextcloud.com`
      */
-    readonly marketingSite: string;
+    readonly marketingUrl: string;
     /**
      * (optional) URL where users can donate to the upstream project
      * @example `https://nextcloud.com/contribute/`
@@ -44,12 +39,12 @@ export type SDKManifest = {
     /**
      * URL where users can find instructions on how to use the service
      */
-    readonly docsUrl: string;
+    readonly docsUrls: string[];
     readonly description: {
         /** Short description to display on the marketplace list page. Max length 80 chars. */
-        readonly short: string;
+        readonly short: T.LocaleString;
         /** Long description to display on the marketplace details page for this service. Max length 500 chars. */
-        readonly long: string;
+        readonly long: T.LocaleString;
     };
     /**
      * override the StartOS version this package was made for
@@ -94,17 +89,17 @@ export type SDKManifest = {
     readonly volumes: string[];
     readonly alerts?: {
         /** An warning alert requiring user confirmation before proceeding with initial installation of this service. */
-        readonly install?: string | null;
+        readonly install?: T.LocaleString | null;
         /** An warning alert requiring user confirmation before updating this service. */
-        readonly update?: string | null;
+        readonly update?: T.LocaleString | null;
         /** An warning alert requiring user confirmation before uninstalling this service. */
-        readonly uninstall?: string | null;
+        readonly uninstall?: T.LocaleString | null;
         /** An warning alert requiring user confirmation before restoring this service from backup. */
-        readonly restore?: string | null;
+        readonly restore?: T.LocaleString | null;
         /** An warning alert requiring user confirmation before starting this service. */
-        readonly start?: string | null;
+        readonly start?: T.LocaleString | null;
         /** An warning alert requiring user confirmation before stopping this service. */
-        readonly stop?: string | null;
+        readonly stop?: T.LocaleString | null;
     };
     /**
      * @description A mapping of service dependencies to be displayed to users when viewing the Marketplace
@@ -126,51 +121,54 @@ export type SDKManifest = {
     /**
      * @description (optional) A set of hardware requirements for this service. If the user's machine
      *   does not meet these requirements, they will not be able to install this service.
-     * @property {object[]} devices - TODO Aiden confirm type on the left. List of required devices (displays or processors).
+     * @property {object[]} devices - List of required devices (display or processor).
+     *    `pattern` refers to a regular expression that at least one device of the specified class must match
+     *    `patternDescription` is what will be displayed to the user about what kind of device is required
      * @property {number} ram - Minimum RAM requirement (in megabytes MB)
-     * @property {string[]} arch - List of supported arches
      * @example
      * ```
-      TODO Aiden verify below and provide examples for devices
       hardwareRequirements: {
         devices: [
-          { class: 'display', value: '' },
-          { class: 'processor', value: '' },
+          { class: 'display', pattern: 'CometLake', patternDescription: 'A CometLake (10th generation) Intel Integrated GPU' },
+          { class: 'processor', pattern: 'i[3579]-10[0-9]{3}U CPU', patternDescription: 'A 10th Generation Intel i-Series processor' },
         ],
         ram: 8192,
-        arch: ['x86-64'],
       },
      * ```
      */
     readonly hardwareRequirements?: {
         readonly device?: T.DeviceFilter[];
         readonly ram?: number | null;
-        readonly arch?: string[] | null;
     };
+    /**
+     * @description Enable access to hardware acceleration devices (such as /dev/dri, or /dev/nvidia*)
+     */
+    readonly hardwareAcceleration?: boolean;
 };
 type ArchOptions = {
-    0: ["x86_64", "aarch64", "riscv64"];
-    1: ["aarch64", "x86_64", "riscv64"];
-    2: ["x86_64", "riscv64", "aarch64"];
-    3: ["aarch64", "riscv64", "x86_64"];
-    4: ["riscv64", "x86_64", "aarch64"];
-    5: ["riscv64", "aarch64", "x86_64"];
-    6: ["x86_64", "aarch64"];
-    7: ["aarch64", "x86_64"];
-    8: ["x86_64", "riscv64"];
-    9: ["aarch64", "riscv64"];
-    10: ["riscv64", "aarch64"];
-    11: ["riscv64", "x86_64"];
-    12: ["x86_64"];
-    13: ["aarch64"];
-    14: ["riscv64"];
+    0: ['x86_64', 'aarch64', 'riscv64'];
+    1: ['aarch64', 'x86_64', 'riscv64'];
+    2: ['x86_64', 'riscv64', 'aarch64'];
+    3: ['aarch64', 'riscv64', 'x86_64'];
+    4: ['riscv64', 'x86_64', 'aarch64'];
+    5: ['riscv64', 'aarch64', 'x86_64'];
+    6: ['x86_64', 'aarch64'];
+    7: ['aarch64', 'x86_64'];
+    8: ['x86_64', 'riscv64'];
+    9: ['aarch64', 'riscv64'];
+    10: ['riscv64', 'aarch64'];
+    11: ['riscv64', 'x86_64'];
+    12: ['x86_64'];
+    13: ['aarch64'];
+    14: ['riscv64'];
 };
 export type SDKImageInputSpec = {
     [A in keyof ArchOptions]: {
-        source: Exclude<ImageSource, "packed">;
+        source: Exclude<ImageSource, 'packed'>;
         arch?: ArchOptions[A];
         emulateMissingAs?: ArchOptions[A][number] | null;
+        nvidiaContainer?: boolean;
     };
 }[keyof ArchOptions];
-export type ManifestDependency = T.Manifest["dependencies"][string];
+export type ManifestDependency = T.Manifest['dependencies'][string];
 export {};

package/base/lib/types.d.ts

@@ -1,19 +1,19 @@
-export * as inputSpecTypes from "./actions/input/inputSpecTypes";
-import { DependencyRequirement, NamedHealthCheckResult, Manifest, ServiceInterface, ActionId } from "./osBindings";
-import { StringObject, ToKebab } from "./util";
-import { Action, Actions } from "./actions/setupActions";
-import { Effects } from "./Effects";
-import { ExtendedVersion, VersionRange } from "./exver";
+export * as inputSpecTypes from './actions/input/inputSpecTypes';
+import { DependencyRequirement, NamedHealthCheckResult, Manifest, ServiceInterface, ActionId } from './osBindings';
+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";
-export { RequiredDependenciesOf as RequiredDependencies, OptionalDependenciesOf as OptionalDependencies, CurrentDependenciesResult, } from "./dependencies/setupDependencies";
+export * from './osBindings';
+export { SDKManifest } from './types/ManifestTypes';
+export { RequiredDependenciesOf as RequiredDependencies, OptionalDependenciesOf as OptionalDependencies, CurrentDependenciesResult, } from './dependencies/setupDependencies';
 export type DaemonBuildable = {
     build(): Promise<{
         term(): Promise<void>;
     }>;
 };
-export type ServiceInterfaceType = "ui" | "p2p" | "api";
+export type ServiceInterfaceType = 'ui' | 'p2p' | 'api';
 export type Signals = NodeJS.Signals;
 export declare const SIGTERM: Signals;
 export declare const SIGKILL: Signals;
@@ -41,7 +41,7 @@ export declare namespace ExpectedExports {
      */
     type init = (options: {
         effects: Effects;
-        kind: "install" | "update" | "restore" | null;
+        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.
@@ -72,7 +72,7 @@ export type Daemon = {
     term(): Promise<null>;
     [DaemonProof]: never;
 };
-export type HealthStatus = NamedHealthCheckResult["result"];
+export type HealthStatus = NamedHealthCheckResult['result'];
 export type SmtpValue = {
     server: string;
     port: number;
@@ -132,7 +132,7 @@ export type SetResult = {
 };
 export type PackageId = string;
 export type Message = string;
-export type DependencyKind = "running" | "exists";
+export type DependencyKind = 'running' | 'exists';
 export type DependsOn = {
     [packageId: string]: string[] | readonly string[];
 };

package/base/lib/types.js

@@ -42,8 +42,8 @@ exports.writable = writable;
 exports.readonly = readonly;
 exports.inputSpecTypes = __importStar(require("./actions/input/inputSpecTypes"));
 __exportStar(require("./osBindings"), exports);
-exports.SIGTERM = "SIGTERM";
-exports.SIGKILL = "SIGKILL";
+exports.SIGTERM = 'SIGTERM';
+exports.SIGKILL = 'SIGKILL';
 exports.NO_TIMEOUT = -1;
 var ExpectedExports;
 (function (ExpectedExports) {
@@ -52,12 +52,12 @@ var ExpectedExports;
 class UseEntrypoint {
     constructor(overridCmd) {
         this.overridCmd = overridCmd;
-        this.USE_ENTRYPOINT = "USE_ENTRYPOINT";
+        this.USE_ENTRYPOINT = 'USE_ENTRYPOINT';
     }
 }
 exports.UseEntrypoint = UseEntrypoint;
 function isUseEntrypoint(command) {
-    return typeof command === "object" && "USE_ENTRYPOINT" in command;
+    return typeof command === 'object' && 'USE_ENTRYPOINT' in command;
 }
 function writable(value) {
     return value;

package/base/lib/util/Drop.js

@@ -2,7 +2,7 @@
 var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DropGenerator = exports.DropPromise = exports.Drop = void 0;
-const dropId = Symbol("id");
+const dropId = Symbol('id');
 class Drop {
     constructor() {
         this.dropId = Drop.idCtr++;
@@ -12,7 +12,7 @@ class Drop {
         Drop.registry.register(this.dropRef, this.dropId, this.dropRef);
         return new Proxy(this, {
             set(target, prop, value) {
-                if (prop === "dropRef" || prop == "dropId")
+                if (prop === 'dropRef' || prop == 'dropId')
                     return false;
                 target[prop] = value;
                 weak[prop] = value;
@@ -54,7 +54,7 @@ Drop.idCtr = 0;
 class DropPromise {
     constructor(promise, dropFnOrRef) {
         this.promise = promise;
-        this[_a] = "DropPromise";
+        this[_a] = 'DropPromise';
         if (dropFnOrRef && dropId in dropFnOrRef) {
             this.dropId = dropFnOrRef[dropId];
             this.dropRef = dropFnOrRef;

package/base/lib/util/GetSystemSmtp.d.ts

@@ -1,5 +1,5 @@
-import { Effects } from "../Effects";
-import * as T from "../types";
+import { Effects } from '../Effects';
+import * as T from '../types';
 export declare class GetSystemSmtp {
     readonly effects: Effects;
     constructor(effects: Effects);

package/base/lib/util/GetSystemSmtp.js

@@ -26,7 +26,7 @@ class GetSystemSmtp {
         this.effects.onLeaveContext(() => {
             resolveCell.resolve();
         });
-        abort?.addEventListener("abort", () => resolveCell.resolve());
+        abort?.addEventListener('abort', () => resolveCell.resolve());
         while (this.effects.isInContext && !abort?.aborted) {
             let callback = () => { };
             const waitForNext = new Promise((resolve) => {
@@ -38,14 +38,14 @@ class GetSystemSmtp {
             });
             await waitForNext;
         }
-        return new Promise((_, rej) => rej(new Error("aborted")));
+        return new Promise((_, rej) => rej(new Error('aborted')));
     }
     /**
      * Watches the system SMTP credentials. Returns an async iterator that yields whenever the value changes
      */
     watch(abort) {
         const ctrl = new AbortController();
-        abort?.addEventListener("abort", () => ctrl.abort());
+        abort?.addEventListener('abort', () => ctrl.abort());
         return Drop_1.DropGenerator.of(this.watchGen(ctrl.signal), () => ctrl.abort());
     }
     /**
@@ -64,12 +64,12 @@ class GetSystemSmtp {
                     }
                 }
                 catch (e) {
-                    console.error("callback function threw an error @ GetSystemSmtp.onChange", e);
+                    console.error('callback function threw an error @ GetSystemSmtp.onChange', e);
                 }
             }
         })()
             .catch((e) => callback(null, e))
-            .catch((e) => console.error("callback function threw an error @ GetSystemSmtp.onChange", e));
+            .catch((e) => console.error('callback function threw an error @ GetSystemSmtp.onChange', e));
     }
     /**
      * Watches the system SMTP credentials. Returns when the predicate is true

package/base/lib/util/asError.js

@@ -5,7 +5,7 @@ const asError = (e) => {
     if (e instanceof Error) {
         return new Error(e);
     }
-    if (typeof e === "string") {
+    if (typeof e === 'string') {
         return new Error(`${e}`);
     }
     return new Error(`${JSON.stringify(e)}`);

package/base/lib/util/deepMerge.js

@@ -27,7 +27,7 @@ function partialDiff(prev, next) {
             return;
         }
     }
-    else if (typeof prev === "object" && typeof next === "object") {
+    else if (typeof prev === 'object' && typeof next === 'object') {
         if (prev === null || next === null)
             return { diff: next };
         const res = { diff: {} };
@@ -55,11 +55,11 @@ function partialDiff(prev, next) {
 }
 function deepMerge(...args) {
     const lastItem = args[args.length - 1];
-    if (typeof lastItem !== "object" || !lastItem)
+    if (typeof lastItem !== 'object' || !lastItem)
         return lastItem;
     if (Array.isArray(lastItem))
         return deepMergeList(...args.filter((x) => Array.isArray(x)));
-    return deepMergeObject(...args.filter((x) => typeof x === "object" && x && !Array.isArray(x)));
+    return deepMergeObject(...args.filter((x) => typeof x === 'object' && x && !Array.isArray(x)));
 }
 function deepMergeList(...args) {
     const res = [];

package/base/lib/util/getDefaultString.d.ts

@@ -1,2 +1,2 @@
-import { DefaultString } from "../actions/input/inputSpecTypes";
+import { DefaultString } from '../actions/input/inputSpecTypes';
 export declare function getDefaultString(defaultSpec: DefaultString): string;

package/base/lib/util/getDefaultString.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultString = getDefaultString;
 const getRandomString_1 = require("./getRandomString");
 function getDefaultString(defaultSpec) {
-    if (typeof defaultSpec === "string") {
+    if (typeof defaultSpec === 'string') {
         return defaultSpec;
     }
     else {

package/base/lib/util/getRandomCharInSet.js

@@ -11,7 +11,7 @@ function getRandomCharInSet(charset) {
         }
         charIdx -= range.len;
     }
-    throw new Error("unreachable");
+    throw new Error('unreachable');
 }
 function stringToCharSet(charset) {
     let set = { ranges: [], len: 0 };
@@ -20,10 +20,10 @@ function stringToCharSet(charset) {
     let in_range = false;
     for (let char of charset) {
         switch (char) {
-            case ",":
+            case ',':
                 if (start !== null && end !== null) {
                     if (start.charCodeAt(0) > end.charCodeAt(0)) {
-                        throw new Error("start > end of charset");
+                        throw new Error('start > end of charset');
                     }
                     const len = end.charCodeAt(0) - start.charCodeAt(0) + 1;
                     set.ranges.push({
@@ -42,24 +42,24 @@ function stringToCharSet(charset) {
                     start = null;
                 }
                 else if (start !== null && in_range) {
-                    end = ",";
+                    end = ',';
                 }
                 else if (start === null && end === null && !in_range) {
-                    start = ",";
+                    start = ',';
                 }
                 else {
                     throw new Error('unexpected ","');
                 }
                 break;
-            case "-":
+            case '-':
                 if (start === null) {
-                    start = "-";
+                    start = '-';
                 }
                 else if (!in_range) {
                     in_range = true;
                 }
                 else if (in_range && end === null) {
-                    end = "-";
+                    end = '-';
                 }
                 else {
                     throw new Error('unexpected "-"');
@@ -79,7 +79,7 @@ function stringToCharSet(charset) {
     }
     if (start !== null && end !== null) {
         if (start.charCodeAt(0) > end.charCodeAt(0)) {
-            throw new Error("start > end of charset");
+            throw new Error('start > end of charset');
         }
         const len = end.charCodeAt(0) - start.charCodeAt(0) + 1;
         set.ranges.push({

package/base/lib/util/getRandomString.d.ts

@@ -1,2 +1,2 @@
-import { RandomString } from "../actions/input/inputSpecTypes";
+import { RandomString } from '../actions/input/inputSpecTypes';
 export declare function getRandomString(generator: RandomString): string;

package/base/lib/util/getRandomString.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRandomString = getRandomString;
 const getRandomCharInSet_1 = require("./getRandomCharInSet");
 function getRandomString(generator) {
-    let s = "";
+    let s = '';
     for (let i = 0; i < generator.len; i++) {
         s = s + (0, getRandomCharInSet_1.getRandomCharInSet)(generator.charset);
     }