@shard-for-obsidian/lib 0.2.0

package/dist/types/ManifestTypes.d.ts

@@ -0,0 +1,98 @@
+export declare const MEDIATYPE_MANIFEST_V2 = "application/vnd.docker.distribution.manifest.v2+json";
+export declare const MEDIATYPE_MANIFEST_LIST_V2 = "application/vnd.docker.distribution.manifest.list.v2+json";
+export declare const MEDIATYPE_OCI_MANIFEST_V1 = "application/vnd.oci.image.manifest.v1+json";
+export declare const MEDIATYPE_OCI_MANIFEST_INDEX_V1 = "application/vnd.oci.image.index.v1+json";
+export declare const MEDIATYPE_OBSIDIAN_PLUGIN_CONFIG_V1 = "application/vnd.obsidianmd.plugin-manifest.v1+json";
+export declare const DEFAULT_USERAGENT: string;
+export type Manifest = ManifestV2 | ManifestV2List | ManifestOCI | ManifestOCIIndex;
+export interface ManifestV2 {
+    schemaVersion: 2;
+    mediaType: "application/vnd.docker.distribution.manifest.v2+json";
+    config: ManifestV2Descriptor;
+    layers: Array<ManifestV2Descriptor>;
+}
+export interface ManifestV2Descriptor {
+    mediaType: string;
+    size: number;
+    digest: string;
+    urls?: Array<string>;
+}
+export interface ManifestV2List {
+    schemaVersion: 2;
+    mediaType: "application/vnd.docker.distribution.manifest.list.v2+json";
+    manifests: Array<{
+        mediaType: string;
+        digest: string;
+        size: number;
+        platform: {
+            architecture: string;
+            os: string;
+            "os.version"?: string;
+            "os.features"?: string[];
+            variant?: string;
+            features?: string[];
+        };
+    }>;
+}
+export interface ManifestOCI {
+    schemaVersion: 2;
+    mediaType?: "application/vnd.oci.image.manifest.v1+json";
+    artifactType?: string;
+    config: ManifestOCIDescriptor;
+    layers: Array<ManifestOCIDescriptor>;
+    annotations?: Record<string, string>;
+}
+export interface ManifestOCIDescriptor {
+    mediaType: string;
+    size: number;
+    digest: string;
+    urls?: Array<string>;
+    annotations?: Record<string, string>;
+}
+export interface ManifestOCIIndex {
+    schemaVersion: 2;
+    mediaType?: "application/vnd.oci.image.index.v1+json";
+    manifests: Array<{
+        mediaType: string;
+        digest: string;
+        size: number;
+        platform?: {
+            architecture: string;
+            os: string;
+            "os.version"?: string;
+            "os.features"?: string[];
+            variant?: string;
+            features?: string[];
+        };
+        /** Used for OCI Image Layouts */
+        annotations?: Record<string, string>;
+    }>;
+    annotations?: Record<string, string>;
+}
+/**
+ * Obsidian plugin manifest structure
+ * Stored in OCI image config field
+ */
+export interface ObsidianManifest {
+    /** Plugin ID */
+    id: string;
+    /** Display name */
+    name: string;
+    /** Plugin version */
+    version: string;
+    /** Minimum Obsidian version required */
+    minAppVersion: string;
+    /** Plugin description */
+    description: string;
+    /** Plugin author */
+    author: string;
+    /** Author URL (optional) */
+    authorUrl?: string;
+    /** Is desktop only? (optional) */
+    isDesktopOnly?: boolean;
+    /** Funding URLs (optional) */
+    fundingUrl?: string | {
+        [key: string]: string;
+    };
+}
+//# sourceMappingURL=ManifestTypes.d.ts.map

package/dist/types/ManifestTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManifestTypes.d.ts","sourceRoot":"","sources":["../../src/types/ManifestTypes.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,qBAAqB,yDACsB,CAAC;AACzD,eAAO,MAAM,0BAA0B,8DACsB,CAAC;AAE9D,eAAO,MAAM,yBAAyB,+CACQ,CAAC;AAC/C,eAAO,MAAM,+BAA+B,4CACD,CAAC;AAE5C,eAAO,MAAM,mCAAmC,uDACM,CAAC;AAEvD,eAAO,MAAM,iBAAiB,EAAE,MAA0C,CAAC;AAG3E,MAAM,MAAM,QAAQ,GAChB,UAAU,GACV,cAAc,GACd,WAAW,GACX,gBAAgB,CAAC;AAGrB,MAAM,WAAW,UAAU;IACzB,aAAa,EAAE,CAAC,CAAC;IACjB,SAAS,EAAE,sDAAsD,CAAC;IAClE,MAAM,EAAE,oBAAoB,CAAC;IAC7B,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAGD,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,CAAC,CAAC;IACjB,SAAS,EAAE,2DAA2D,CAAC;IACvE,SAAS,EAAE,KAAK,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE;YACR,YAAY,EAAE,MAAM,CAAC;YACrB,EAAE,EAAE,MAAM,CAAC;YACX,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;YACzB,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;SACrB,CAAC;KACH,CAAC,CAAC;CACJ;AAGD,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,CAAC,CAAC;IACjB,SAAS,CAAC,EAAE,4CAA4C,CAAC;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,qBAAqB,CAAC;IAC9B,MAAM,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAGD,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,CAAC,CAAC;IACjB,SAAS,CAAC,EAAE,yCAAyC,CAAC;IACtD,SAAS,EAAE,KAAK,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE;YACT,YAAY,EAAE,MAAM,CAAC;YACrB,EAAE,EAAE,MAAM,CAAC;YACX,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;YACzB,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;SACrB,CAAC;QACF,iCAAiC;QACjC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACtC,CAAC,CAAC;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACjD"}

package/dist/types/ManifestTypes.js

@@ -0,0 +1,7 @@
+// Media type constants for Docker and OCI manifests
+export const MEDIATYPE_MANIFEST_V2 = "application/vnd.docker.distribution.manifest.v2+json";
+export const MEDIATYPE_MANIFEST_LIST_V2 = "application/vnd.docker.distribution.manifest.list.v2+json";
+export const MEDIATYPE_OCI_MANIFEST_V1 = "application/vnd.oci.image.manifest.v1+json";
+export const MEDIATYPE_OCI_MANIFEST_INDEX_V1 = "application/vnd.oci.image.index.v1+json";
+export const MEDIATYPE_OBSIDIAN_PLUGIN_CONFIG_V1 = "application/vnd.obsidianmd.plugin-manifest.v1+json";
+export const DEFAULT_USERAGENT = `open-obsidian-plugin-spec/0.1.0`;

package/dist/types/RegistryTypes.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Registry types for Docker/OCI registry operations
+ */
+export interface RegistryIndex {
+    name: string;
+    official: boolean;
+    scheme: "https" | "http";
+}
+export interface RegistryRepo {
+    index: RegistryIndex;
+    official: boolean;
+    remoteName: string;
+    localName: string;
+    canonicalName: string;
+}
+export interface RegistryImage extends RegistryRepo {
+    digest: string | null;
+    tag: string | null;
+    canonicalRef: string;
+}
+export interface TagList {
+    name: string;
+    tags: string[];
+    child?: string[];
+    manifest?: Record<string, {
+        imageSizeBytes: string;
+        layerId?: string;
+        mediaType: string;
+        tag: string[];
+        timeCreatedMs: string;
+        timeUploadedMs: string;
+    }>;
+}
+export interface RegistryError {
+    code?: string;
+    message: string;
+    detail?: string;
+}
+export interface DockerResponse {
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    dockerBody(): Promise<ReturnType<Uint8Array["slice"]>>;
+    dockerJson(): Promise<unknown>;
+    dockerErrors(): Promise<Array<RegistryError>>;
+    dockerThrowable(baseMsg: string): Promise<Error>;
+}
+//# sourceMappingURL=RegistryTypes.d.ts.map

package/dist/types/RegistryTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RegistryTypes.d.ts","sourceRoot":"","sources":["../../src/types/RegistryTypes.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,aAAa,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IAEf,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CACf,MAAM,EACN;QACE,cAAc,EAAE,MAAM,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,EAAE,MAAM,CAAC;KACxB,CACF,CAAC;CACH;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACvD,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/B,YAAY,IAAI,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAC9C,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;CAClD"}

package/dist/types/RegistryTypes.js

@@ -0,0 +1,4 @@
+/**
+ * Registry types for Docker/OCI registry operations
+ */
+export {};

package/dist/types/RequestTypes.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Request/Response types for HTTP operations
+ */
+/** An alias for Uint8Array<ArrayBuffer> for Typescript 5.7 */
+export type ByteArray = ReturnType<Uint8Array["slice"]>;
+/** Obsidian's requestUrl parameter type */
+export interface RequestUrlParam {
+    url: string;
+    method?: string;
+    contentType?: string;
+    body?: string | ArrayBuffer;
+    headers?: Record<string, string>;
+    throw?: boolean;
+}
+/** Obsidian's requestUrl response type */
+export interface RequestUrlResponse {
+    status: number;
+    headers: Record<string, string>;
+    arrayBuffer: ArrayBuffer;
+    json: unknown;
+    text: string;
+}
+//# sourceMappingURL=RequestTypes.d.ts.map

package/dist/types/RequestTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestTypes.d.ts","sourceRoot":"","sources":["../../src/types/RequestTypes.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,8DAA8D;AAC9D,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AAExD,2CAA2C;AAC3C,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,WAAW,EAAE,WAAW,CAAC;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/types/RequestTypes.js

@@ -0,0 +1,4 @@
+/**
+ * Request/Response types for HTTP operations
+ */
+export {};

package/dist/utils/DigestUtils.d.ts

@@ -0,0 +1,9 @@
+export declare function encodeHex(data: ArrayBuffer): string;
+/**
+ * Calculate the 'Docker-Content-Digest' header for the given manifest.
+ *
+ * @returns {Promise<String>} The docker digest string.
+ * @throws {InvalidContentError} if there is a problem parsing the manifest.
+ */
+export declare function digestFromManifestStr(manifestStr: string): Promise<string>;
+//# sourceMappingURL=DigestUtils.d.ts.map

package/dist/utils/DigestUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DigestUtils.d.ts","sourceRoot":"","sources":["../../src/utils/DigestUtils.ts"],"names":[],"mappings":"AAEA,wBAAgB,SAAS,CAAC,IAAI,EAAE,WAAW,UAI1C;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,CAmBjB"}

package/dist/utils/DigestUtils.js

@@ -0,0 +1,26 @@
+export function encodeHex(data) {
+    return [...new Uint8Array(data)]
+        .map((x) => x.toString(16).padStart(2, "0"))
+        .join("");
+}
+/**
+ * Calculate the 'Docker-Content-Digest' header for the given manifest.
+ *
+ * @returns {Promise<String>} The docker digest string.
+ * @throws {InvalidContentError} if there is a problem parsing the manifest.
+ */
+export async function digestFromManifestStr(manifestStr) {
+    let manifest;
+    try {
+        manifest = JSON.parse(manifestStr);
+    }
+    catch (thrown) {
+        const err = thrown;
+        throw new Error(`could not parse manifest: ${err.message}\n${manifestStr}`);
+    }
+    if (manifest.schemaVersion === 1) {
+        throw new Error(`schemaVersion 1 is not supported by /x/docker_registry_client.`);
+    }
+    const hash = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(manifestStr));
+    return `sha256:${encodeHex(hash)}`;
+}

package/dist/utils/ValidationUtils.d.ts

@@ -0,0 +1,2 @@
+export declare function splitIntoTwo(str: string, sep: string): [string] | [string, string];
+//# sourceMappingURL=ValidationUtils.d.ts.map

package/dist/utils/ValidationUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationUtils.d.ts","sourceRoot":"","sources":["../../src/utils/ValidationUtils.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAC1B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAK7B"}

package/dist/utils/ValidationUtils.js

@@ -0,0 +1,6 @@
+export function splitIntoTwo(str, sep) {
+    const slashIdx = str.indexOf(sep);
+    return slashIdx == -1
+        ? [str]
+        : [str.slice(0, slashIdx), str.slice(slashIdx + 1)];
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@shard-for-obsidian/lib",
+  "version": "0.2.0",
+  "type": "module",
+  "description": "Core library for Shard plugin management",
+  "author": "Andrew Gillis",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/shard-for-obsidian/shard.git",
+    "directory": "packages/shard-lib"
+  },
+  "homepage": "https://github.com/shard-for-obsidian/shard#readme",
+  "bugs": "https://github.com/shard-for-obsidian/shard/issues",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/**/__tests__"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "node esbuild.config.mjs && tsc",
+    "clean": "rimraf dist",
+    "ts-check": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui"
+  },
+  "keywords": [
+    "shard",
+    "lib",
+    "oci",
+    "registry",
+    "ghcr",
+    "container-registry"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@vitest/ui": "^4.0.18",
+    "vitest": "^4.0.18"
+  }
+}