@start9labs/start-sdk 0.4.0-beta.9 → 1.0.0

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

@@ -1,18 +1,83 @@
-import { DataUrl, DependencyMetadata, Manifest, MerkleArchiveCommitment, PackageId } from "../osBindings";
-import { MerkleArchive } from "./merkleArchive";
+import { DataUrl, Manifest, MerkleArchiveCommitment, PackageId } from '../osBindings';
+import { MerkleArchive } from './merkleArchive';
+/**
+ * Compares two `Uint8Array` instances byte-by-byte for equality.
+ *
+ * @returns `true` if both arrays have the same length and identical bytes
+ */
 export declare function compare(a: Uint8Array, b: Uint8Array): boolean;
+/**
+ * Represents a parsed `.s9pk` package archive — the binary distribution format for StartOS services.
+ *
+ * An `S9pk` wraps a verified {@link Manifest}, a {@link MerkleArchive} containing the package's
+ * assets (icon, license, dependency metadata), and the total archive size in bytes.
+ *
+ * @example
+ * ```ts
+ * const s9pk = await S9pk.deserialize(file, null)
+ * console.log(s9pk.manifest.id)    // e.g. "bitcoind"
+ * console.log(s9pk.size)           // archive size in bytes
+ * const icon = await s9pk.icon()   // base64 data URL
+ * const license = await s9pk.license()
+ * ```
+ */
 export declare class S9pk {
+    /** The parsed package manifest containing metadata, dependencies, and interface definitions. */
     readonly manifest: Manifest;
+    /** The Merkle-verified archive containing the package's files. */
     readonly archive: MerkleArchive;
+    /** The total size of the archive in bytes. */
     readonly size: number;
     private constructor();
+    /**
+     * Deserializes an `S9pk` from a `Blob` (e.g. a `File` from a browser file input).
+     *
+     * Validates the magic bytes and version header, then parses the Merkle archive structure.
+     * If a `commitment` is provided, the archive is cryptographically verified against it.
+     *
+     * @param source - The raw `.s9pk` file as a `Blob`
+     * @param commitment - An optional Merkle commitment to verify the archive against, or `null` to skip verification
+     * @returns A fully parsed `S9pk` instance
+     * @throws If the magic bytes are invalid or the archive fails verification
+     */
     static deserialize(source: Blob, commitment: MerkleArchiveCommitment | null): Promise<S9pk>;
+    /**
+     * Extracts the package icon from the archive and returns it as a base64-encoded data URL.
+     *
+     * Looks for a file named `icon.*` with an image MIME type (e.g. `icon.png`, `icon.svg`).
+     *
+     * @returns A data URL string like `"data:image/png;base64,..."` suitable for use in `<img src>`.
+     * @throws If no icon file is found in the archive
+     */
     icon(): Promise<DataUrl>;
+    /**
+     * Returns the metadata (e.g. `{ title }`) for a specific dependency by its package ID.
+     *
+     * @param id - The dependency's package identifier (e.g. `"bitcoind"`)
+     * @returns The dependency metadata object, or `null` if the dependency is not present in the archive
+     */
     dependencyMetadataFor(id: PackageId): Promise<{
         title: string;
     } | null>;
+    /**
+     * Returns the icon for a specific dependency as a base64 data URL.
+     *
+     * @param id - The dependency's package identifier
+     * @returns A data URL string, or `null` if the dependency or its icon is not present
+     */
     dependencyIconFor(id: PackageId): Promise<string | null>;
-    dependencyMetadata(): Promise<Record<PackageId, DependencyMetadata>>;
-    instructions(): Promise<string>;
+    /**
+     * Returns a merged record of all dependency metadata (title, icon, description, optional flag)
+     * for every dependency declared in the manifest.
+     *
+     * @returns A record keyed by package ID, each containing `{ title, icon, description, optional }`
+     */
+    dependencyMetadata(): Promise<any>;
+    /**
+     * Reads and returns the `LICENSE.md` file from the archive as a UTF-8 string.
+     *
+     * @returns The full license text
+     * @throws If `LICENSE.md` is not found in the archive
+     */
     license(): Promise<string>;
 }

package/base/lib/s9pk/index.js

@@ -6,10 +6,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.S9pk = void 0;
 exports.compare = compare;
 const merkleArchive_1 = require("./merkleArchive");
-const mime_types_1 = __importDefault(require("mime-types"));
+const mime_1 = __importDefault(require("mime"));
 const directoryContents_1 = require("./merkleArchive/directoryContents");
 const fileContents_1 = require("./merkleArchive/fileContents");
 const magicAndVersion = new Uint8Array([59, 59, 2]);
+/**
+ * Compares two `Uint8Array` instances byte-by-byte for equality.
+ *
+ * @returns `true` if both arrays have the same length and identical bytes
+ */
 function compare(a, b) {
     if (a.length !== b.length)
         return false;
@@ -19,58 +24,116 @@ function compare(a, b) {
     }
     return true;
 }
+/**
+ * Represents a parsed `.s9pk` package archive — the binary distribution format for StartOS services.
+ *
+ * An `S9pk` wraps a verified {@link Manifest}, a {@link MerkleArchive} containing the package's
+ * assets (icon, license, dependency metadata), and the total archive size in bytes.
+ *
+ * @example
+ * ```ts
+ * const s9pk = await S9pk.deserialize(file, null)
+ * console.log(s9pk.manifest.id)    // e.g. "bitcoind"
+ * console.log(s9pk.size)           // archive size in bytes
+ * const icon = await s9pk.icon()   // base64 data URL
+ * const license = await s9pk.license()
+ * ```
+ */
 class S9pk {
-    constructor(manifest, archive, size) {
+    constructor(
+    /** The parsed package manifest containing metadata, dependencies, and interface definitions. */
+    manifest, 
+    /** The Merkle-verified archive containing the package's files. */
+    archive, 
+    /** The total size of the archive in bytes. */
+    size) {
         this.manifest = manifest;
         this.archive = archive;
         this.size = size;
     }
+    /**
+     * Deserializes an `S9pk` from a `Blob` (e.g. a `File` from a browser file input).
+     *
+     * Validates the magic bytes and version header, then parses the Merkle archive structure.
+     * If a `commitment` is provided, the archive is cryptographically verified against it.
+     *
+     * @param source - The raw `.s9pk` file as a `Blob`
+     * @param commitment - An optional Merkle commitment to verify the archive against, or `null` to skip verification
+     * @returns A fully parsed `S9pk` instance
+     * @throws If the magic bytes are invalid or the archive fails verification
+     */
     static async deserialize(source, commitment) {
         const header = new merkleArchive_1.ArrayBufferReader(await source
             .slice(0, magicAndVersion.length + merkleArchive_1.MerkleArchive.headerSize)
             .arrayBuffer());
         const magicVersion = new Uint8Array(header.next(magicAndVersion.length));
         if (!compare(magicVersion, magicAndVersion)) {
-            throw new Error("Invalid Magic or Unexpected Version");
+            throw new Error('Invalid Magic or Unexpected Version');
         }
-        const archive = await merkleArchive_1.MerkleArchive.deserialize(source, "s9pk", header, commitment);
+        const archive = await merkleArchive_1.MerkleArchive.deserialize(source, 's9pk', header, commitment);
         const manifest = JSON.parse(new TextDecoder().decode(await archive.contents
-            .getPath(["manifest.json"])
+            .getPath(['manifest.json'])
             ?.verifiedFileContents()));
         return new S9pk(manifest, archive, source.size);
     }
+    /**
+     * Extracts the package icon from the archive and returns it as a base64-encoded data URL.
+     *
+     * Looks for a file named `icon.*` with an image MIME type (e.g. `icon.png`, `icon.svg`).
+     *
+     * @returns A data URL string like `"data:image/png;base64,..."` suitable for use in `<img src>`.
+     * @throws If no icon file is found in the archive
+     */
     async icon() {
-        const iconName = Object.keys(this.archive.contents.contents).find((name) => name.startsWith("icon.") &&
-            (mime_types_1.default.contentType(name) || null)?.startsWith("image/"));
+        const iconName = Object.keys(this.archive.contents.contents).find((name) => name.startsWith('icon.') && mime_1.default.getType(name)?.startsWith('image/'));
         if (!iconName) {
-            throw new Error("no icon found in archive");
+            throw new Error('no icon found in archive');
         }
-        return (`data:${mime_types_1.default.contentType(iconName)};base64,` +
-            Buffer.from(await this.archive.contents.getPath([iconName]).verifiedFileContents()).toString("base64"));
+        return (`data:${mime_1.default.getType(iconName)};base64,` +
+            Buffer.from(await this.archive.contents.getPath([iconName]).verifiedFileContents()).toString('base64'));
     }
+    /**
+     * Returns the metadata (e.g. `{ title }`) for a specific dependency by its package ID.
+     *
+     * @param id - The dependency's package identifier (e.g. `"bitcoind"`)
+     * @returns The dependency metadata object, or `null` if the dependency is not present in the archive
+     */
     async dependencyMetadataFor(id) {
         const entry = this.archive.contents.getPath([
-            "dependencies",
+            'dependencies',
             id,
-            "metadata.json",
+            'metadata.json',
         ]);
         if (!entry)
             return null;
         return JSON.parse(new TextDecoder().decode(await entry.verifiedFileContents()));
     }
+    /**
+     * Returns the icon for a specific dependency as a base64 data URL.
+     *
+     * @param id - The dependency's package identifier
+     * @returns A data URL string, or `null` if the dependency or its icon is not present
+     */
     async dependencyIconFor(id) {
-        const dir = this.archive.contents.getPath(["dependencies", id]);
+        const dir = this.archive.contents.getPath(['dependencies', id]);
         if (!dir || !(dir.contents instanceof directoryContents_1.DirectoryContents))
             return null;
-        const iconName = Object.keys(dir.contents.contents).find((name) => name.startsWith("icon.") &&
-            (mime_types_1.default.contentType(name) || null)?.startsWith("image/"));
+        const iconName = Object.keys(dir.contents.contents).find((name) => name.startsWith('icon.') && mime_1.default.getType(name)?.startsWith('image/'));
         if (!iconName)
             return null;
-        return (`data:${mime_types_1.default.contentType(iconName)};base64,` +
-            Buffer.from(await dir.contents.getPath([iconName]).verifiedFileContents()).toString("base64"));
+        return (`data:${mime_1.default.getType(iconName)};base64,` +
+            Buffer.from(await dir.contents.getPath([iconName]).verifiedFileContents()).toString('base64'));
     }
+    /**
+     * Returns a merged record of all dependency metadata (title, icon, description, optional flag)
+     * for every dependency declared in the manifest.
+     *
+     * @returns A record keyed by package ID, each containing `{ title, icon, description, optional }`
+     */
     async dependencyMetadata() {
-        return Object.fromEntries(await Promise.all(Object.entries(this.manifest.dependencies).map(async ([id, info]) => [
+        return Object.fromEntries(await Promise.all(Object.entries(this.manifest.dependencies)
+            .filter(([_, info]) => !!info)
+            .map(async ([id, info]) => [
             id,
             {
                 ...(await this.dependencyMetadataFor(id)),
@@ -80,16 +143,16 @@ class S9pk {
             },
         ])));
     }
-    async instructions() {
-        const file = this.archive.contents.getPath(["instructions.md"]);
-        if (!file || !(file.contents instanceof fileContents_1.FileContents))
-            throw new Error("instructions.md not found in archive");
-        return new TextDecoder().decode(await file.verifiedFileContents());
-    }
+    /**
+     * Reads and returns the `LICENSE.md` file from the archive as a UTF-8 string.
+     *
+     * @returns The full license text
+     * @throws If `LICENSE.md` is not found in the archive
+     */
     async license() {
-        const file = this.archive.contents.getPath(["LICENSE.md"]);
+        const file = this.archive.contents.getPath(['LICENSE.md']);
         if (!file || !(file.contents instanceof fileContents_1.FileContents))
-            throw new Error("instructions.md not found in archive");
+            throw new Error('license.md not found in archive');
         return new TextDecoder().decode(await file.verifiedFileContents());
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../base/lib/s9pk/index.ts"],"names":[],"mappings":";;;;;;AAcA,0BAMC;AAbD,mDAAkE;AAClE,4DAA6B;AAC7B,yEAAqE;AACrE,+DAA2D;AAE3D,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;AAEnD,SAAgB,OAAO,CAAC,CAAa,EAAE,CAAa;IAClD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;IACjC,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAa,IAAI;IACf,YACW,QAAkB,EAClB,OAAsB,EACtB,IAAY;QAFZ,aAAQ,GAAR,QAAQ,CAAU;QAClB,YAAO,GAAP,OAAO,CAAe;QACtB,SAAI,GAAJ,IAAI,CAAQ;IACpB,CAAC;IACJ,MAAM,CAAC,KAAK,CAAC,WAAW,CACtB,MAAY,EACZ,UAA0C;QAE1C,MAAM,MAAM,GAAG,IAAI,iCAAiB,CAClC,MAAM,MAAM;aACT,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,MAAM,GAAG,6BAAa,CAAC,UAAU,CAAC;aAC3D,WAAW,EAAE,CACjB,CAAA;QACD,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAA;QACxE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,6BAAa,CAAC,WAAW,CAC7C,MAAM,EACN,MAAM,EACN,MAAM,EACN,UAAU,CACX,CAAA;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,IAAI,WAAW,EAAE,CAAC,MAAM,CACtB,MAAM,OAAO,CAAC,QAAQ;aACnB,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC;YAC3B,EAAE,oBAAoB,EAAE,CAC3B,CACF,CAAA;QAED,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC;IACD,KAAK,CAAC,IAAI;QACR,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC/D,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACxB,CAAC,oBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CACzD,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QACD,OAAO,CACL,QAAQ,oBAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU;YAC5C,MAAM,CAAC,IAAI,CACT,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAE,CAAC,oBAAoB,EAAE,CACxE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACrB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,EAAa;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC1C,cAAc;YACd,EAAE;YACF,eAAe;SAChB,CAAC,CAAA;QACF,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAA;QACvB,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,oBAAoB,EAAE,CAAC,CACxC,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAa;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,CAAA;QAC/D,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,YAAY,qCAAiB,CAAC;YAAE,OAAO,IAAI,CAAA;QACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CACtD,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACxB,CAAC,oBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CACzD,CAAA;QACD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;QAC1B,OAAO,CACL,QAAQ,oBAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU;YAC5C,MAAM,CAAC,IAAI,CACT,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAE,CAAC,oBAAoB,EAAE,CAC/D,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACrB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;YACnE,EAAE;YACF;gBACE,GAAG,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;gBACzC,IAAI,EAAE,MAAM,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACtC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB;SACF,CAAC,CACH,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAA;QAC/D,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,YAAY,2BAAY,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAA;IACpE,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QAC1D,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,YAAY,2BAAY,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAA;IACpE,CAAC;CACF;AAhHD,oBAgHC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../base/lib/s9pk/index.ts"],"names":[],"mappings":";;;;;;AAmBA,0BAMC;AAlBD,mDAAkE;AAClE,gDAAuB;AACvB,yEAAqE;AACrE,+DAA2D;AAE3D,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;AAEnD;;;;GAIG;AACH,SAAgB,OAAO,CAAC,CAAa,EAAE,CAAa;IAClD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;IACjC,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,IAAI;IACf;IACE,gGAAgG;IACvF,QAAkB;IAC3B,kEAAkE;IACzD,OAAsB;IAC/B,8CAA8C;IACrC,IAAY;QAJZ,aAAQ,GAAR,QAAQ,CAAU;QAElB,YAAO,GAAP,OAAO,CAAe;QAEtB,SAAI,GAAJ,IAAI,CAAQ;IACpB,CAAC;IACJ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CACtB,MAAY,EACZ,UAA0C;QAE1C,MAAM,MAAM,GAAG,IAAI,iCAAiB,CAClC,MAAM,MAAM;aACT,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,MAAM,GAAG,6BAAa,CAAC,UAAU,CAAC;aAC3D,WAAW,EAAE,CACjB,CAAA;QACD,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAA;QACxE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,6BAAa,CAAC,WAAW,CAC7C,MAAM,EACN,MAAM,EACN,MAAM,EACN,UAAU,CACX,CAAA;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,IAAI,WAAW,EAAE,CAAC,MAAM,CACtB,MAAM,OAAO,CAAC,QAAQ;aACnB,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC;YAC3B,EAAE,oBAAoB,EAAE,CAC3B,CACF,CAAA;QAED,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC/D,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CACvE,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QACD,OAAO,CACL,QAAQ,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU;YACxC,MAAM,CAAC,IAAI,CACT,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAE,CAAC,oBAAoB,EAAE,CACxE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACrB,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CAAC,EAAa;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC1C,cAAc;YACd,EAAE;YACF,eAAe;SAChB,CAAC,CAAA;QACF,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAA;QACvB,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,oBAAoB,EAAE,CAAC,CACxC,CAAA;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CAAC,EAAa;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,CAAA;QAC/D,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,YAAY,qCAAiB,CAAC;YAAE,OAAO,IAAI,CAAA;QACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CACtD,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CACvE,CAAA;QACD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;QAC1B,OAAO,CACL,QAAQ,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU;YACxC,MAAM,CAAC,IAAI,CACT,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAE,CAAC,oBAAoB,EAAE,CAC/D,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACrB,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB;QACtB,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;aACvC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;aAC7B,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;YACzB,EAAE;YACF;gBACE,GAAG,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;gBACzC,IAAI,EAAE,MAAM,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACtC,WAAW,EAAE,IAAK,CAAC,WAAW;gBAC9B,QAAQ,EAAE,IAAK,CAAC,QAAQ;aACzB;SACF,CAAC,CACL,CACF,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QAC1D,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,YAAY,2BAAY,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAA;IACpE,CAAC;CACF;AAvJD,oBAuJC"}

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

@@ -1,4 +1,4 @@
-import { ArrayBufferReader, Entry } from ".";
+import { ArrayBufferReader, Entry } from '.';
 export declare class DirectoryContents {
     readonly contents: {
         [name: string]: Entry;

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,32 +20,31 @@ 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/`
      */
     readonly donationUrl: string | null;
+    /**
+     * URL where users can find instructions on how to use the service
+     */
+    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
@@ -90,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
@@ -122,40 +121,58 @@ 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;
+    /**
+     * @description Enable OS plugins
+     */
+    readonly plugins?: T.PluginId[];
 };
 type ArchOptions = {
-    0: ["x86_64", "aarch64"];
-    1: ["aarch64", "x86_64"];
-    2: ["x86_64"];
-    3: ["aarch64"];
+    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 {};