@shard-for-obsidian/lib 0.2.3 → 0.3.0

package/dist/oci/tags.js

@@ -0,0 +1,134 @@
+import { parseRepoAndRef } from "../parsing/RepoParser.js";
+/**
+ * Platform-agnostic base64 encoding for Basic Auth.
+ */
+function encodeBasicAuth(username, password) {
+    const credentials = `${username}:${password}`;
+    // Use TextEncoder + btoa for browser compatibility
+    if (typeof Buffer !== "undefined") {
+        // Node.js environment
+        return Buffer.from(credentials).toString("base64");
+    }
+    else {
+        // Browser environment
+        return btoa(credentials);
+    }
+}
+/**
+ * Parse WWW-Authenticate header to extract auth challenge.
+ */
+function parseAuthChallenge(header) {
+    // Format: Bearer realm="...",service="...",scope="..."
+    const realmMatch = /realm="([^"]+)"/.exec(header);
+    const serviceMatch = /service="([^"]+)"/.exec(header);
+    const scopeMatch = /scope="([^"]+)"/.exec(header);
+    if (!realmMatch || !serviceMatch || !scopeMatch) {
+        return null;
+    }
+    return {
+        realm: realmMatch[1],
+        service: serviceMatch[1],
+        scope: scopeMatch[1],
+    };
+}
+/**
+ * Exchange GitHub token for OCI registry token.
+ */
+async function getRegistryToken(challenge, adapter, githubToken) {
+    const url = `${challenge.realm}?service=${challenge.service}&scope=${challenge.scope}`;
+    const headers = {
+        Accept: "application/json",
+    };
+    // For GHCR, we need to use Basic auth with the GitHub token
+    // Username can be anything, password is the token
+    if (githubToken) {
+        const basicAuth = encodeBasicAuth("token", githubToken);
+        headers.Authorization = `Basic ${basicAuth}`;
+    }
+    try {
+        const response = await adapter.fetch(url, { headers });
+        if (!response.ok) {
+            return null;
+        }
+        const data = (await response.json());
+        return data.token || null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Query all available tags from an OCI registry.
+ */
+export async function queryOciTags(opts) {
+    const { registryUrl, adapter, token } = opts;
+    const ref = parseRepoAndRef(registryUrl);
+    // OCI Distribution API: GET /v2/<name>/tags/list
+    const url = `https://${ref.index.name}/v2/${ref.remoteName}/tags/list`;
+    const headers = {
+        Accept: "application/json",
+    };
+    // Try initial request
+    let response = await adapter.fetch(url, { headers });
+    // If 401, try to exchange token and retry
+    if (response.status === 401 && token) {
+        const wwwAuth = response.headers.get("www-authenticate");
+        if (wwwAuth) {
+            const challenge = parseAuthChallenge(wwwAuth);
+            if (challenge) {
+                const registryToken = await getRegistryToken(challenge, adapter, token);
+                if (registryToken) {
+                    headers.Authorization = `Bearer ${registryToken}`;
+                    response = await adapter.fetch(url, { headers });
+                }
+            }
+        }
+    }
+    if (!response.ok) {
+        throw new Error(`Failed to query OCI tags: ${response.status} ${response.statusText}`);
+    }
+    const data = (await response.json());
+    return data.tags || [];
+}
+/**
+ * Query metadata for a specific tag.
+ */
+export async function queryTagMetadata(opts) {
+    const { registryUrl, tag, adapter, token } = opts;
+    const ref = parseRepoAndRef(registryUrl);
+    // OCI Distribution API: GET /v2/<name>/manifests/<tag>
+    const url = `https://${ref.index.name}/v2/${ref.remoteName}/manifests/${tag}`;
+    const headers = {
+        Accept: "application/vnd.oci.image.manifest.v1+json",
+    };
+    // Try initial request
+    let response = await adapter.fetch(url, { headers });
+    // If 401, try to exchange token and retry
+    if (response.status === 401 && token) {
+        const wwwAuth = response.headers.get("www-authenticate");
+        if (wwwAuth) {
+            const challenge = parseAuthChallenge(wwwAuth);
+            if (challenge) {
+                const registryToken = await getRegistryToken(challenge, adapter, token);
+                if (registryToken) {
+                    headers.Authorization = `Bearer ${registryToken}`;
+                    response = await adapter.fetch(url, { headers });
+                }
+            }
+        }
+    }
+    if (!response.ok) {
+        throw new Error(`Failed to query tag metadata: ${response.status} ${response.statusText}`);
+    }
+    const manifest = (await response.json());
+    // Extract metadata
+    const publishedAt = manifest.created || new Date().toISOString();
+    const layerSizes = manifest.layers?.map((l) => l.size) || [];
+    const size = layerSizes.reduce((sum, s) => sum + s, 0);
+    const annotations = manifest.annotations || {};
+    return {
+        publishedAt,
+        size,
+        annotations,
+    };
+}

package/dist/schemas/annotations.d.ts

@@ -0,0 +1,78 @@
+import { z } from "zod";
+/**
+ * OCI manifest annotations for Obsidian plugins
+ * Uses full annotation keys as they appear in OCI manifests
+ */
+export declare const PluginAnnotationsSchema: z.ZodObject<{
+    /** Plugin ID */
+    "vnd.obsidianmd.plugin.id": z.ZodString;
+    /** Display name */
+    "vnd.obsidianmd.plugin.name": z.ZodString;
+    /** Plugin version */
+    "vnd.obsidianmd.plugin.version": z.ZodString;
+    /** Plugin description */
+    "vnd.obsidianmd.plugin.description": z.ZodString;
+    /** Plugin author */
+    "vnd.obsidianmd.plugin.author": z.ZodString;
+    /** VCS source URL (e.g., git+https://github.com/owner/repo.git) */
+    "vnd.obsidianmd.plugin.source": z.ZodString;
+    /** Publication timestamp (ISO 8601) */
+    "vnd.obsidianmd.plugin.published-at": z.ZodString;
+    /** Plugin introduction from community-plugins.json (required) */
+    "vnd.obsidianmd.plugin.introduction": z.ZodString;
+    /** Funding URL - string or JSON-serialized object (optional) */
+    "vnd.obsidianmd.plugin.funding-url": z.ZodOptional<z.ZodString>;
+    /** Is desktop only - string representation of boolean (required) */
+    "vnd.obsidianmd.plugin.is-desktop-only": z.ZodString;
+    /** Indicates plugin was converted from legacy format */
+    "vnd.obsidianmd.plugin.converted": z.ZodOptional<z.ZodString>;
+    /** Author URL */
+    "vnd.obsidianmd.plugin.author-url": z.ZodOptional<z.ZodString>;
+    /** Minimum Obsidian version required (required) */
+    "vnd.obsidianmd.plugin.min-app-version": z.ZodString;
+    /** OCI image source repository URL */
+    "org.opencontainers.image.source": z.ZodString;
+    /** OCI standard: Plugin title */
+    "org.opencontainers.image.title": z.ZodString;
+    /** OCI standard: Creation timestamp (RFC 3339) */
+    "org.opencontainers.image.created": z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    "org.opencontainers.image.title": string;
+    "vnd.obsidianmd.plugin.id": string;
+    "vnd.obsidianmd.plugin.name": string;
+    "vnd.obsidianmd.plugin.version": string;
+    "vnd.obsidianmd.plugin.description": string;
+    "vnd.obsidianmd.plugin.author": string;
+    "vnd.obsidianmd.plugin.source": string;
+    "vnd.obsidianmd.plugin.published-at": string;
+    "vnd.obsidianmd.plugin.introduction": string;
+    "vnd.obsidianmd.plugin.is-desktop-only": string;
+    "vnd.obsidianmd.plugin.min-app-version": string;
+    "org.opencontainers.image.source": string;
+    "org.opencontainers.image.created": string;
+    "vnd.obsidianmd.plugin.funding-url"?: string | undefined;
+    "vnd.obsidianmd.plugin.converted"?: string | undefined;
+    "vnd.obsidianmd.plugin.author-url"?: string | undefined;
+}, {
+    "org.opencontainers.image.title": string;
+    "vnd.obsidianmd.plugin.id": string;
+    "vnd.obsidianmd.plugin.name": string;
+    "vnd.obsidianmd.plugin.version": string;
+    "vnd.obsidianmd.plugin.description": string;
+    "vnd.obsidianmd.plugin.author": string;
+    "vnd.obsidianmd.plugin.source": string;
+    "vnd.obsidianmd.plugin.published-at": string;
+    "vnd.obsidianmd.plugin.introduction": string;
+    "vnd.obsidianmd.plugin.is-desktop-only": string;
+    "vnd.obsidianmd.plugin.min-app-version": string;
+    "org.opencontainers.image.source": string;
+    "org.opencontainers.image.created": string;
+    "vnd.obsidianmd.plugin.funding-url"?: string | undefined;
+    "vnd.obsidianmd.plugin.converted"?: string | undefined;
+    "vnd.obsidianmd.plugin.author-url"?: string | undefined;
+}>;
+/**
+ * Inferred TypeScript type from schema
+ */
+export type PluginAnnotations = z.infer<typeof PluginAnnotationsSchema>;
+//# sourceMappingURL=annotations.d.ts.map

package/dist/schemas/annotations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../src/schemas/annotations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,uBAAuB;IAClC,gBAAgB;;IAEhB,mBAAmB;;IAEnB,qBAAqB;;IAErB,yBAAyB;;IAEzB,oBAAoB;;IAEpB,mEAAmE;;IAEnE,uCAAuC;;IAEvC,iEAAiE;;IAEjE,gEAAgE;;IAEhE,oEAAoE;;IAEpE,wDAAwD;;IAExD,iBAAiB;;IAEjB,mDAAmD;;IAEnD,sCAAsC;;IAEtC,iCAAiC;;IAEjC,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAElD,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/schemas/annotations.js

@@ -0,0 +1,39 @@
+import { z } from "zod";
+/**
+ * OCI manifest annotations for Obsidian plugins
+ * Uses full annotation keys as they appear in OCI manifests
+ */
+export const PluginAnnotationsSchema = z.object({
+    /** Plugin ID */
+    "vnd.obsidianmd.plugin.id": z.string(),
+    /** Display name */
+    "vnd.obsidianmd.plugin.name": z.string(),
+    /** Plugin version */
+    "vnd.obsidianmd.plugin.version": z.string(),
+    /** Plugin description */
+    "vnd.obsidianmd.plugin.description": z.string(),
+    /** Plugin author */
+    "vnd.obsidianmd.plugin.author": z.string(),
+    /** VCS source URL (e.g., git+https://github.com/owner/repo.git) */
+    "vnd.obsidianmd.plugin.source": z.string().regex(/^git\+https:\/\//),
+    /** Publication timestamp (ISO 8601) */
+    "vnd.obsidianmd.plugin.published-at": z.string().datetime(),
+    /** Plugin introduction from community-plugins.json (required) */
+    "vnd.obsidianmd.plugin.introduction": z.string(),
+    /** Funding URL - string or JSON-serialized object (optional) */
+    "vnd.obsidianmd.plugin.funding-url": z.string().optional(),
+    /** Is desktop only - string representation of boolean (required) */
+    "vnd.obsidianmd.plugin.is-desktop-only": z.string(),
+    /** Indicates plugin was converted from legacy format */
+    "vnd.obsidianmd.plugin.converted": z.string().optional(),
+    /** Author URL */
+    "vnd.obsidianmd.plugin.author-url": z.string().url().optional(),
+    /** Minimum Obsidian version required (required) */
+    "vnd.obsidianmd.plugin.min-app-version": z.string(),
+    /** OCI image source repository URL */
+    "org.opencontainers.image.source": z.string().url(),
+    /** OCI standard: Plugin title */
+    "org.opencontainers.image.title": z.string(),
+    /** OCI standard: Creation timestamp (RFC 3339) */
+    "org.opencontainers.image.created": z.string().datetime(),
+});

package/dist/schemas/index.d.ts

@@ -0,0 +1,5 @@
+export { ObsidianManifestSchema, type ObsidianManifest } from "./manifest.js";
+export { PluginAnnotationsSchema, type PluginAnnotations, } from "./annotations.js";
+export { PluginVersionSchema, MarketplacePluginSchema, MarketplaceIndexSchema, CachedMarketplaceDataSchema, type PluginVersion, type MarketplacePlugin, type MarketplaceIndex, type CachedMarketplaceData, } from "./marketplace.js";
+export { repoToVcsUrl, vcsUrlToGitHubUrl, manifestToAnnotations, manifestToAnnotationsLegacy, annotationsToMarketplacePlugin, type CommunityPluginMetadata, } from "./transforms.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/schemas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE9E,OAAO,EACL,uBAAuB,EACvB,KAAK,iBAAiB,GACvB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,sBAAsB,EACtB,2BAA2B,EAC3B,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,GAC3B,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,KAAK,uBAAuB,GAC7B,MAAM,iBAAiB,CAAC"}

package/dist/schemas/index.js

@@ -0,0 +1,6 @@
+// Schemas
+export { ObsidianManifestSchema } from "./manifest.js";
+export { PluginAnnotationsSchema, } from "./annotations.js";
+export { PluginVersionSchema, MarketplacePluginSchema, MarketplaceIndexSchema, CachedMarketplaceDataSchema, } from "./marketplace.js";
+// Transform utilities
+export { repoToVcsUrl, vcsUrlToGitHubUrl, manifestToAnnotations, manifestToAnnotationsLegacy, annotationsToMarketplacePlugin, } from "./transforms.js";

package/dist/schemas/manifest.d.ts

@@ -0,0 +1,50 @@
+import { z } from "zod";
+/**
+ * Obsidian plugin manifest schema
+ * Based on official Obsidian manifest.json structure
+ */
+export declare const ObsidianManifestSchema: z.ZodObject<{
+    /** Plugin ID */
+    id: z.ZodString;
+    /** Display name */
+    name: z.ZodString;
+    /** Plugin version */
+    version: z.ZodString;
+    /** Minimum Obsidian version required (required) */
+    minAppVersion: z.ZodString;
+    /** Plugin description */
+    description: z.ZodString;
+    /** Plugin author */
+    author: z.ZodString;
+    /** Author URL (optional) */
+    authorUrl: z.ZodOptional<z.ZodString>;
+    /** Is desktop only? (optional) */
+    isDesktopOnly: z.ZodOptional<z.ZodBoolean>;
+    /** Funding URLs (optional) */
+    fundingUrl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    version: string;
+    minAppVersion: string;
+    description: string;
+    author: string;
+    authorUrl?: string | undefined;
+    isDesktopOnly?: boolean | undefined;
+    fundingUrl?: string | Record<string, string> | undefined;
+}, {
+    id: string;
+    name: string;
+    version: string;
+    minAppVersion: string;
+    description: string;
+    author: string;
+    authorUrl?: string | undefined;
+    isDesktopOnly?: boolean | undefined;
+    fundingUrl?: string | Record<string, string> | undefined;
+}>;
+/**
+ * Inferred TypeScript type from schema
+ */
+export type ObsidianManifest = z.infer<typeof ObsidianManifestSchema>;
+//# sourceMappingURL=manifest.d.ts.map

package/dist/schemas/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/schemas/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,sBAAsB;IACjC,gBAAgB;;IAEhB,mBAAmB;;IAEnB,qBAAqB;;IAErB,mDAAmD;;IAEnD,yBAAyB;;IAEzB,oBAAoB;;IAEpB,4BAA4B;;IAE5B,kCAAkC;;IAElC,8BAA8B;;;;;;;;;;;;;;;;;;;;;;EAE9B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}

package/dist/schemas/manifest.js

@@ -0,0 +1,25 @@
+import { z } from "zod";
+/**
+ * Obsidian plugin manifest schema
+ * Based on official Obsidian manifest.json structure
+ */
+export const ObsidianManifestSchema = z.object({
+    /** Plugin ID */
+    id: z.string(),
+    /** Display name */
+    name: z.string(),
+    /** Plugin version */
+    version: z.string(),
+    /** Minimum Obsidian version required (required) */
+    minAppVersion: z.string(),
+    /** Plugin description */
+    description: z.string(),
+    /** Plugin author */
+    author: z.string(),
+    /** Author URL (optional) */
+    authorUrl: z.string().url().optional(),
+    /** Is desktop only? (optional) */
+    isDesktopOnly: z.boolean().optional(),
+    /** Funding URLs (optional) */
+    fundingUrl: z.union([z.string().url(), z.record(z.string())]).optional(),
+});