@coldtea/pr-lens-schema 0.1.0

package/dist/manifest.js

@@ -0,0 +1,60 @@
+import { z } from "zod";
+import { Id, Lens, MAX_RENDER_ASSETS, SchemaVersionField, Sha, Theme } from "./primitives.js";
+/**
+ * GitHub serves comment images through a proxy that caches aggressively, so
+ * every asset is addressed by the hash of its own bytes and a new render is a
+ * new URL rather than an updated one.
+ */
+export const RenderAsset = z
+    .strictObject({
+    id: Id,
+    lens: Lens,
+    theme: Theme.describe("Half of a <picture> pair."),
+    view: Id.optional().describe("Drill-down view this asset renders, when it is not the root."),
+    mediaType: z.literal("image/svg+xml"),
+    contentHash: z
+        .string()
+        .regex(/^[0-9a-f]{16,64}$/, "must be lowercase hex")
+        .describe("Hash of the asset bytes; the identity of this render."),
+    bytes: z.int().min(1),
+    width: z.int().min(1),
+    height: z.int().min(1),
+    animated: z.boolean().default(false).describe("Contains SMIL animation."),
+    url: z.url().optional().describe("Where the asset is published, once it has been uploaded."),
+    path: z
+        .string()
+        .min(1)
+        .max(1024)
+        .optional()
+        .describe("Local path, for surfaces that write files instead of uploading."),
+})
+    .refine((asset) => asset.url !== undefined || asset.path !== undefined, {
+    message: "an asset needs a url or a path",
+    path: ["url"],
+})
+    .meta({ anyOf: [{ required: ["url"] }, { required: ["path"] }] })
+    .describe("One rendered SVG.");
+/** What a render produced: the inventory the comment composer builds from. */
+export const RenderManifest = z
+    .strictObject({
+    schemaVersion: SchemaVersionField,
+    kind: z.literal("render-manifest"),
+    generatedAt: z.iso.datetime().optional(),
+    graph: z
+        .strictObject({
+        id: Id.optional(),
+        headSha: Sha.optional(),
+        contentHash: z
+            .string()
+            .regex(/^[0-9a-f]{16,64}$/, "must be lowercase hex")
+            .describe("Hash of the graph document this render came from."),
+    })
+        .describe("The document that was rendered."),
+    renderer: z.strictObject({
+        name: z.string().min(1).max(64),
+        version: z.string().min(1).max(32),
+    }),
+    assets: z.array(RenderAsset).min(1).max(MAX_RENDER_ASSETS),
+})
+    .describe("A PR Lens render manifest.");
+//# sourceMappingURL=manifest.js.map

package/dist/manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE9F;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,YAAY,CAAC;IACZ,EAAE,EAAE,EAAE;IACN,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IAClD,IAAI,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8DAA8D,CAAC;IAC5F,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;IACrC,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,KAAK,CAAC,mBAAmB,EAAE,uBAAuB,CAAC;SACnD,QAAQ,CAAC,uDAAuD,CAAC;IACpE,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IACzE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0DAA0D,CAAC;IAC5F,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,IAAI,CAAC;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,iEAAiE,CAAC;CAC/E,CAAC;KACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE;IACtE,OAAO,EAAE,gCAAgC;IACzC,IAAI,EAAE,CAAC,KAAK,CAAC;CACd,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;KAChE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAGjC,8EAA8E;AAC9E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,YAAY,CAAC;IACZ,aAAa,EAAE,kBAAkB;IACjC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAClC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACxC,KAAK,EAAE,CAAC;SACL,YAAY,CAAC;QACZ,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE;QACjB,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE;QACvB,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,KAAK,CAAC,mBAAmB,EAAE,uBAAuB,CAAC;aACnD,QAAQ,CAAC,mDAAmD,CAAC;KACjE,CAAC;SACD,QAAQ,CAAC,iCAAiC,CAAC;IAC9C,QAAQ,EAAE,CAAC,CAAC,YAAY,CAAC;QACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;KACnC,CAAC;IACF,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC;CAC3D,CAAC;KACD,QAAQ,CAAC,4BAA4B,CAAC,CAAC"}