@donotlb/imagen-sdk 0.2.0 → 0.2.2

package/dist/client.d.ts

@@ -2,7 +2,6 @@ import type { ImagenGenerationAccepted, ImagenGenerationCancelAccepted, ImagenGe
 export interface ImagenClientOptions {
     baseUrl: string;
     serviceJwtSecret: string;
-    /** This caller's service identity (JWT `iss`). Defaults to `tutu`. */
     clientName?: string;
     fetch?: typeof fetch;
 }

package/dist/contracts.js

@@ -18,10 +18,6 @@ export const imagenGenerationRequestSchema = z.object({
         count: z.int().min(1).max(4).optional(),
     }).strict(),
     output: z.object({
-        // Opaque namespace owned by the caller. Imagen does not interpret its
-        // structure; it only normalizes it and owns the leaf filename
-        // (`${jobId}-${index}.${ext}`). Callers should treat the returned
-        // `storageKey` as a read-only opaque value.
         storageKeyPrefix: z.string().trim().min(1).max(1024),
     }).strict(),
     callback: z.object({

package/dist/image-models/registry.d.ts

@@ -1,17 +1,9 @@
 import type { AspectRatio, ImageModelId, ImageQuality, Resolution } from './types.js';
-/**
- * The provider's hard limits on an output size; size derivation honours all of
- * these. {@link ImageModelSpec.resolutionLongEdge} and {@link SizeConstraints.maxPixels}
- * together bound the worst-case (largest) pixel count of a resolution tier.
- */
 export interface SizeConstraints {
-    /** Longest edge the provider accepts, in pixels. */
     maxEdge: number;
-    /** Both edges must be a multiple of this. */
     edgeMultiple: number;
     minPixels: number;
     maxPixels: number;
-    /** Long edge / short edge must not exceed this. */
     maxAspectRatio: number;
 }
 export interface ImageModelSpec {
@@ -20,11 +12,6 @@ export interface ImageModelSpec {
     resolutions: readonly Resolution[];
     aspectRatios: readonly AspectRatio[];
     constraints: SizeConstraints;
-    /**
-     * Target long-edge (px) each resolution tier aims for before the constraints
-     * clamp it. Square/near-square 4K is pulled below 3840 by the pixel ceiling;
-     * thin ratios at 1K are pushed up by the pixel floor.
-     */
     resolutionLongEdge: Record<Resolution, number>;
 }
 export declare function getModelSpec(model: ImageModelId): ImageModelSpec;

package/dist/image-models/registry.js

@@ -1,6 +1,4 @@
 import { ASPECT_RATIOS, IMAGE_QUALITIES, RESOLUTIONS } from './types.js';
-// gpt-image-2 constraints, from OpenAI's image generation guide: max edge 3840,
-// edges multiple of 16, long:short <= 3:1, total pixels in [655_360, 8_294_400].
 const GPT_IMAGE_2 = {
     id: 'openai/gpt-image-2',
     qualities: IMAGE_QUALITIES,

package/dist/image-models/size.d.ts

@@ -3,21 +3,5 @@ export interface ResolvedSize {
     width: number;
     height: number;
 }
-/**
- * Derive the concrete pixel size to request for a (ratio, resolution) choice,
- * honouring every model constraint: the resolution tier sets a target long
- * edge, which is then clamped into the pixel floor/ceiling and rounded so both
- * edges are a valid multiple. The long edge is anchored to the tier, so the
- * canonical OpenAI sizes fall out exactly (e.g. 2K 16:9 -> 2048x1152, 4K 16:9
- * -> 3840x2160), while squarer ratios at 4K are pulled down by the 8.29MP
- * ceiling and thin ratios at 1K are pushed up by the 655K floor.
- *
- * `auto` ratio resolves to a square (1:1) at the chosen resolution: the
- * resolution selector is always honoured and the billed tier always matches the
- * pixels actually requested. (gpt-image-2's own `size: auto` would let the model
- * pick the aspect but ignore our resolution choice, so we default the aspect
- * ourselves instead.)
- */
 export declare function resolveImageSize(model: ImageModelId, aspectRatio: AspectRatio, resolution: Resolution): ResolvedSize;
-/** Format a resolved size as the provider's `WIDTHxHEIGHT` size string. */
 export declare function formatSize(size: ResolvedSize | 'auto'): string;

package/dist/image-models/size.js

@@ -2,21 +2,6 @@ import { getModelSpec } from './registry.js';
 function roundToMultiple(value, multiple) {
     return Math.max(multiple, Math.round(value / multiple) * multiple);
 }
-/**
- * Derive the concrete pixel size to request for a (ratio, resolution) choice,
- * honouring every model constraint: the resolution tier sets a target long
- * edge, which is then clamped into the pixel floor/ceiling and rounded so both
- * edges are a valid multiple. The long edge is anchored to the tier, so the
- * canonical OpenAI sizes fall out exactly (e.g. 2K 16:9 -> 2048x1152, 4K 16:9
- * -> 3840x2160), while squarer ratios at 4K are pulled down by the 8.29MP
- * ceiling and thin ratios at 1K are pushed up by the 655K floor.
- *
- * `auto` ratio resolves to a square (1:1) at the chosen resolution: the
- * resolution selector is always honoured and the billed tier always matches the
- * pixels actually requested. (gpt-image-2's own `size: auto` would let the model
- * pick the aspect but ignore our resolution choice, so we default the aspect
- * ourselves instead.)
- */
 export function resolveImageSize(model, aspectRatio, resolution) {
     const { constraints: c, resolutionLongEdge } = getModelSpec(model);
     const [rw, rh] = aspectRatio === 'auto'
@@ -26,7 +11,6 @@ export function resolveImageSize(model, aspectRatio, resolution) {
     const ratioShort = Math.min(rw, rh);
     let longEdge = resolutionLongEdge[resolution];
     let shortEdge = (longEdge * ratioShort) / ratioLong;
-    // Scale into the pixel band before rounding.
     const pixels = longEdge * shortEdge;
     if (pixels > c.maxPixels) {
         const scale = Math.sqrt(c.maxPixels / pixels);
@@ -40,7 +24,6 @@ export function resolveImageSize(model, aspectRatio, resolution) {
     }
     longEdge = roundToMultiple(Math.min(longEdge, c.maxEdge), c.edgeMultiple);
     shortEdge = roundToMultiple(shortEdge, c.edgeMultiple);
-    // Rounding can nudge past the ceiling/floor; step back into range.
     while (longEdge * shortEdge > c.maxPixels) {
         if (longEdge >= shortEdge)
             longEdge -= c.edgeMultiple;
@@ -58,7 +41,6 @@ export function resolveImageSize(model, aspectRatio, resolution) {
         ? { width: longEdge, height: shortEdge }
         : { width: shortEdge, height: longEdge };
 }
-/** Format a resolved size as the provider's `WIDTHxHEIGHT` size string. */
 export function formatSize(size) {
     return size === 'auto' ? 'auto' : `${size.width}x${size.height}`;
 }

package/dist/image-models/types.d.ts

@@ -1,13 +1,3 @@
-/**
- * Canonical image-model vocabulary for the Imagen service contract — the
- * aspect-ratio / resolution / quality unions defined exactly once and shared by
- * every consumer (the Imagen service and its SDK clients).
- *
- * `quality` is deliberately three tiers — `auto` was dropped at the product
- * layer (callers should pick a concrete tier before submitting work to Imagen).
- * A consumer's database may keep a legacy `auto` enum value for historical rows,
- * but nothing new is written with it.
- */
 export declare const IMAGE_MODEL_IDS: readonly ["openai/gpt-image-2"];
 export type ImageModelId = typeof IMAGE_MODEL_IDS[number];
 export declare const IMAGE_QUALITIES: readonly ["low", "medium", "high"];

package/dist/image-models/types.js

@@ -1,13 +1,3 @@
-/**
- * Canonical image-model vocabulary for the Imagen service contract — the
- * aspect-ratio / resolution / quality unions defined exactly once and shared by
- * every consumer (the Imagen service and its SDK clients).
- *
- * `quality` is deliberately three tiers — `auto` was dropped at the product
- * layer (callers should pick a concrete tier before submitting work to Imagen).
- * A consumer's database may keep a legacy `auto` enum value for historical rows,
- * but nothing new is written with it.
- */
 export const IMAGE_MODEL_IDS = ['openai/gpt-image-2'];
 export const IMAGE_QUALITIES = ['low', 'medium', 'high'];
 export const RESOLUTIONS = ['1k', '2k', '4k'];

package/dist/service-jwt.d.ts

@@ -1,9 +1,4 @@
 import type { JWTPayload } from 'jose';
-/**
- * Identity of the service that calls Imagen. Imagen is generic infrastructure;
- * the caller's name is configurable. `tutu` is the default because it is the
- * first consumer, but any client can set its own name via `SERVICE_CLIENT_NAME`.
- */
 export declare const DEFAULT_SERVICE_CLIENT_NAME = "tutu";
 export declare class ServiceJwtError extends Error {
     constructor(message?: string);

package/dist/service-jwt.js

@@ -1,11 +1,6 @@
 import { jwtVerify, SignJWT } from 'jose';
 const DEFAULT_MAX_TTL_SECONDS = 5 * 60;
 const CLOCK_TOLERANCE_SECONDS = 5;
-/**
- * Identity of the service that calls Imagen. Imagen is generic infrastructure;
- * the caller's name is configurable. `tutu` is the default because it is the
- * first consumer, but any client can set its own name via `SERVICE_CLIENT_NAME`.
- */
 export const DEFAULT_SERVICE_CLIENT_NAME = 'tutu';
 export class ServiceJwtError extends Error {
     constructor(message = 'Invalid service token') {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@donotlb/imagen-sdk",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "private": false,
   "exports": {
     ".": {