@giveitsmaller/sdk 0.4.0 → 0.7.0

package/dist/ergonomic/presets/audio_compress.js

@@ -0,0 +1,45 @@
+// T4a — AudioCompressPresetOptions leaf DTO.
+//
+// Field set per ticket VhIj4S7T: audio = 4 fields
+//   (bitrate, channels, sampleRate, normalize).
+// Trim is deliberately excluded — content selection lives on the per-call
+// operation argument, not the preset cell.
+import { shippedDefaultsFor as f3ShippedDefaultsFor } from '../../generated/sdk_spec/presets.js';
+import { translateEnum } from './_translate.js';
+export class AudioCompressPresetOptions {
+    bitrate;
+    channels;
+    sampleRate;
+    normalize;
+    constructor(input) {
+        if (input.bitrate !== undefined)
+            this.bitrate = input.bitrate;
+        if (input.channels !== undefined)
+            this.channels = input.channels;
+        if (input.sampleRate !== undefined)
+            this.sampleRate = input.sampleRate;
+        if (input.normalize !== undefined)
+            this.normalize = input.normalize;
+        Object.freeze(this);
+    }
+    static from(input) {
+        return new AudioCompressPresetOptions(input);
+    }
+    static shippedDefaultsFor(level) {
+        const cell = f3ShippedDefaultsFor('audio_compress', level);
+        const input = {};
+        const mut = input;
+        // bitrate / sampleRate values in PRESETS are member-name strings like
+        // "_96" / "_44100"; translateEnum resolves them to the numeric wire
+        // value (`AudioBitrate._96 === 96`).
+        if ('bitrate' in cell)
+            mut.bitrate = translateEnum('AudioBitrate', cell.bitrate);
+        if ('channels' in cell)
+            mut.channels = cell.channels;
+        if ('sampleRate' in cell)
+            mut.sampleRate = translateEnum('AudioSampleRate', cell.sampleRate);
+        if ('normalize' in cell)
+            mut.normalize = cell.normalize;
+        return new AudioCompressPresetOptions(input);
+    }
+}

package/dist/ergonomic/presets/document_epub_compress.d.ts

@@ -0,0 +1,14 @@
+import { OptimizeFor } from '../../generated/sdk_spec/enums.js';
+export interface DocumentEpubCompressPresetOptionsInput {
+    readonly imageQuality?: number;
+    readonly fontSubsetting?: boolean;
+    readonly stripUnusedCss?: boolean;
+}
+export declare class DocumentEpubCompressPresetOptions {
+    readonly imageQuality?: number;
+    readonly fontSubsetting?: boolean;
+    readonly stripUnusedCss?: boolean;
+    private constructor();
+    static from(input: DocumentEpubCompressPresetOptionsInput): DocumentEpubCompressPresetOptions;
+    static shippedDefaultsFor(level: OptimizeFor): DocumentEpubCompressPresetOptions;
+}

package/dist/ergonomic/presets/document_epub_compress.js

@@ -0,0 +1,34 @@
+// T4a — DocumentEpubCompressPresetOptions leaf DTO.
+//
+// Field set per ticket VhIj4S7T: EPUB = 3 fields
+//   (imageQuality, fontSubsetting, stripUnusedCss). Primitives only.
+import { shippedDefaultsFor as f3ShippedDefaultsFor } from '../../generated/sdk_spec/presets.js';
+export class DocumentEpubCompressPresetOptions {
+    imageQuality;
+    fontSubsetting;
+    stripUnusedCss;
+    constructor(input) {
+        if (input.imageQuality !== undefined)
+            this.imageQuality = input.imageQuality;
+        if (input.fontSubsetting !== undefined)
+            this.fontSubsetting = input.fontSubsetting;
+        if (input.stripUnusedCss !== undefined)
+            this.stripUnusedCss = input.stripUnusedCss;
+        Object.freeze(this);
+    }
+    static from(input) {
+        return new DocumentEpubCompressPresetOptions(input);
+    }
+    static shippedDefaultsFor(level) {
+        const cell = f3ShippedDefaultsFor('document_epub_compress', level);
+        const input = {};
+        const mut = input;
+        if ('imageQuality' in cell)
+            mut.imageQuality = cell.imageQuality;
+        if ('fontSubsetting' in cell)
+            mut.fontSubsetting = cell.fontSubsetting;
+        if ('stripUnusedCss' in cell)
+            mut.stripUnusedCss = cell.stripUnusedCss;
+        return new DocumentEpubCompressPresetOptions(input);
+    }
+}

package/dist/ergonomic/presets/document_odf_compress.d.ts

@@ -0,0 +1,14 @@
+import { OptimizeFor } from '../../generated/sdk_spec/enums.js';
+export interface DocumentOdfCompressPresetOptionsInput {
+    readonly imageQuality?: number;
+    readonly stripMetadata?: boolean;
+    readonly stripUnusedStyles?: boolean;
+}
+export declare class DocumentOdfCompressPresetOptions {
+    readonly imageQuality?: number;
+    readonly stripMetadata?: boolean;
+    readonly stripUnusedStyles?: boolean;
+    private constructor();
+    static from(input: DocumentOdfCompressPresetOptionsInput): DocumentOdfCompressPresetOptions;
+    static shippedDefaultsFor(level: OptimizeFor): DocumentOdfCompressPresetOptions;
+}

package/dist/ergonomic/presets/document_odf_compress.js

@@ -0,0 +1,34 @@
+// T4a — DocumentOdfCompressPresetOptions leaf DTO.
+//
+// Field set per ticket VhIj4S7T: ODF = 3 fields
+//   (imageQuality, stripMetadata, stripUnusedStyles). Primitives only.
+import { shippedDefaultsFor as f3ShippedDefaultsFor } from '../../generated/sdk_spec/presets.js';
+export class DocumentOdfCompressPresetOptions {
+    imageQuality;
+    stripMetadata;
+    stripUnusedStyles;
+    constructor(input) {
+        if (input.imageQuality !== undefined)
+            this.imageQuality = input.imageQuality;
+        if (input.stripMetadata !== undefined)
+            this.stripMetadata = input.stripMetadata;
+        if (input.stripUnusedStyles !== undefined)
+            this.stripUnusedStyles = input.stripUnusedStyles;
+        Object.freeze(this);
+    }
+    static from(input) {
+        return new DocumentOdfCompressPresetOptions(input);
+    }
+    static shippedDefaultsFor(level) {
+        const cell = f3ShippedDefaultsFor('document_odf_compress', level);
+        const input = {};
+        const mut = input;
+        if ('imageQuality' in cell)
+            mut.imageQuality = cell.imageQuality;
+        if ('stripMetadata' in cell)
+            mut.stripMetadata = cell.stripMetadata;
+        if ('stripUnusedStyles' in cell)
+            mut.stripUnusedStyles = cell.stripUnusedStyles;
+        return new DocumentOdfCompressPresetOptions(input);
+    }
+}

package/dist/ergonomic/presets/document_office_compress.d.ts

@@ -0,0 +1,16 @@
+import { OptimizeFor } from '../../generated/sdk_spec/enums.js';
+export interface DocumentOfficeCompressPresetOptionsInput {
+    readonly imageQuality?: number;
+    readonly stripMacros?: boolean;
+    readonly stripHiddenData?: boolean;
+    readonly stripUnusedFonts?: boolean;
+}
+export declare class DocumentOfficeCompressPresetOptions {
+    readonly imageQuality?: number;
+    readonly stripMacros?: boolean;
+    readonly stripHiddenData?: boolean;
+    readonly stripUnusedFonts?: boolean;
+    private constructor();
+    static from(input: DocumentOfficeCompressPresetOptionsInput): DocumentOfficeCompressPresetOptions;
+    static shippedDefaultsFor(level: OptimizeFor): DocumentOfficeCompressPresetOptions;
+}

package/dist/ergonomic/presets/document_office_compress.js

@@ -0,0 +1,40 @@
+// T4a — DocumentOfficeCompressPresetOptions leaf DTO.
+//
+// Field set per ticket VhIj4S7T: office = 4 fields
+//   (imageQuality, stripMacros, stripHiddenData, stripUnusedFonts).
+// All primitive values — no enum translation needed.
+import { shippedDefaultsFor as f3ShippedDefaultsFor } from '../../generated/sdk_spec/presets.js';
+export class DocumentOfficeCompressPresetOptions {
+    imageQuality;
+    stripMacros;
+    stripHiddenData;
+    stripUnusedFonts;
+    constructor(input) {
+        if (input.imageQuality !== undefined)
+            this.imageQuality = input.imageQuality;
+        if (input.stripMacros !== undefined)
+            this.stripMacros = input.stripMacros;
+        if (input.stripHiddenData !== undefined)
+            this.stripHiddenData = input.stripHiddenData;
+        if (input.stripUnusedFonts !== undefined)
+            this.stripUnusedFonts = input.stripUnusedFonts;
+        Object.freeze(this);
+    }
+    static from(input) {
+        return new DocumentOfficeCompressPresetOptions(input);
+    }
+    static shippedDefaultsFor(level) {
+        const cell = f3ShippedDefaultsFor('document_office_compress', level);
+        const input = {};
+        const mut = input;
+        if ('imageQuality' in cell)
+            mut.imageQuality = cell.imageQuality;
+        if ('stripMacros' in cell)
+            mut.stripMacros = cell.stripMacros;
+        if ('stripHiddenData' in cell)
+            mut.stripHiddenData = cell.stripHiddenData;
+        if ('stripUnusedFonts' in cell)
+            mut.stripUnusedFonts = cell.stripUnusedFonts;
+        return new DocumentOfficeCompressPresetOptions(input);
+    }
+}

package/dist/ergonomic/presets/document_pdf_compress.d.ts

@@ -0,0 +1,14 @@
+import { PdfProfile, PdfColorspace, OptimizeFor } from '../../generated/sdk_spec/enums.js';
+export interface DocumentPdfCompressPresetOptionsInput {
+    readonly profile?: PdfProfile;
+    readonly colorspace?: PdfColorspace;
+    readonly flattenForms?: boolean;
+}
+export declare class DocumentPdfCompressPresetOptions {
+    readonly profile?: PdfProfile;
+    readonly colorspace?: PdfColorspace;
+    readonly flattenForms?: boolean;
+    private constructor();
+    static from(input: DocumentPdfCompressPresetOptionsInput): DocumentPdfCompressPresetOptions;
+    static shippedDefaultsFor(level: OptimizeFor): DocumentPdfCompressPresetOptions;
+}

package/dist/ergonomic/presets/document_pdf_compress.js

@@ -0,0 +1,35 @@
+// T4a — DocumentPdfCompressPresetOptions leaf DTO.
+//
+// Field set per ticket VhIj4S7T: PDF = 3 fields (profile, colorspace, flattenForms).
+// Deliberately excluded: `pages` (per-call content selection).
+import { shippedDefaultsFor as f3ShippedDefaultsFor } from '../../generated/sdk_spec/presets.js';
+import { translateEnum } from './_translate.js';
+export class DocumentPdfCompressPresetOptions {
+    profile;
+    colorspace;
+    flattenForms;
+    constructor(input) {
+        if (input.profile !== undefined)
+            this.profile = input.profile;
+        if (input.colorspace !== undefined)
+            this.colorspace = input.colorspace;
+        if (input.flattenForms !== undefined)
+            this.flattenForms = input.flattenForms;
+        Object.freeze(this);
+    }
+    static from(input) {
+        return new DocumentPdfCompressPresetOptions(input);
+    }
+    static shippedDefaultsFor(level) {
+        const cell = f3ShippedDefaultsFor('document_pdf_compress', level);
+        const input = {};
+        const mut = input;
+        if ('profile' in cell)
+            mut.profile = translateEnum('PdfProfile', cell.profile);
+        if ('colorspace' in cell)
+            mut.colorspace = translateEnum('PdfColorspace', cell.colorspace);
+        if ('flattenForms' in cell)
+            mut.flattenForms = cell.flattenForms;
+        return new DocumentPdfCompressPresetOptions(input);
+    }
+}

package/dist/ergonomic/presets/image_compress.d.ts

@@ -0,0 +1,43 @@
+import { ImageMode, ImageFit, ImageMetadataPolicy, IccProfilePolicy, ImageFormat, OptimizeFor } from '../../generated/sdk_spec/enums.js';
+export interface ImageCompressPresetOptionsInput {
+    readonly mode?: ImageMode;
+    readonly quality?: number;
+    readonly width?: number;
+    readonly height?: number;
+    readonly fit?: ImageFit;
+    readonly metadata?: ImageMetadataPolicy;
+    readonly iccProfile?: IccProfilePolicy;
+    readonly autoOrient?: boolean;
+    readonly progressive?: boolean;
+    readonly outputFormat?: ImageFormat;
+}
+export declare class ImageCompressPresetOptions {
+    readonly mode?: ImageMode;
+    readonly quality?: number;
+    readonly width?: number;
+    readonly height?: number;
+    readonly fit?: ImageFit;
+    readonly metadata?: ImageMetadataPolicy;
+    readonly iccProfile?: IccProfilePolicy;
+    readonly autoOrient?: boolean;
+    readonly progressive?: boolean;
+    readonly outputFormat?: ImageFormat;
+    private constructor();
+    /**
+     * Construct a leaf DTO from a sparse caller-supplied delta. Fields the
+     * caller omits stay undefined on the instance — they are NOT filled
+     * from shipped defaults here (the resolver in T4b merges layers).
+     */
+    static from(input: ImageCompressPresetOptionsInput): ImageCompressPresetOptions;
+    /**
+     * Return the SDK shipped defaults for the (image, compress) cell at
+     * the given level. Reads the F3 PRESETS matrix and translates member
+     * names to wire backing values.
+     *
+     * Note for OptimizeFor.Quality: the F3 PRESETS cell deliberately
+     * omits `quality` because the contract has `depends_on: { mode: lossy }`
+     * on the quality field — under `mode: Lossless` the API ignores
+     * `quality`, so shipping a default would mislead callers.
+     */
+    static shippedDefaultsFor(level: OptimizeFor): ImageCompressPresetOptions;
+}

package/dist/ergonomic/presets/image_compress.js

@@ -0,0 +1,95 @@
+// T4a — ImageCompressPresetOptions leaf DTO.
+//
+// Sparse delta over the wire `CompressImageOptions` surface. Every field
+// is optional + readonly; an unset field means "fall through to the next
+// layer" (shipped defaults / user delta / per-call override). Mapped via
+// the ergonomic enum types from `../../generated/sdk_spec/enums.ts`, whose
+// values ARE the wire backing values — so the leaf DTO is wire-compatible
+// once the resolver (T4b) snake_cases the property names.
+//
+// Field set per ticket VhIj4S7T (codex r3 lock): image = 10 fields
+//   (mode, quality, width, height, fit, metadata, iccProfile, autoOrient,
+//    progressive, outputFormat).
+// Trim / per-call knobs are deliberately excluded — they belong on the
+// per-call argument shape, not the preset cell.
+import { shippedDefaultsFor as f3ShippedDefaultsFor } from '../../generated/sdk_spec/presets.js';
+import { translateEnum } from './_translate.js';
+export class ImageCompressPresetOptions {
+    mode;
+    quality;
+    width;
+    height;
+    fit;
+    metadata;
+    iccProfile;
+    autoOrient;
+    progressive;
+    outputFormat;
+    constructor(input) {
+        if (input.mode !== undefined)
+            this.mode = input.mode;
+        if (input.quality !== undefined)
+            this.quality = input.quality;
+        if (input.width !== undefined)
+            this.width = input.width;
+        if (input.height !== undefined)
+            this.height = input.height;
+        if (input.fit !== undefined)
+            this.fit = input.fit;
+        if (input.metadata !== undefined)
+            this.metadata = input.metadata;
+        if (input.iccProfile !== undefined)
+            this.iccProfile = input.iccProfile;
+        if (input.autoOrient !== undefined)
+            this.autoOrient = input.autoOrient;
+        if (input.progressive !== undefined)
+            this.progressive = input.progressive;
+        if (input.outputFormat !== undefined)
+            this.outputFormat = input.outputFormat;
+        Object.freeze(this);
+    }
+    /**
+     * Construct a leaf DTO from a sparse caller-supplied delta. Fields the
+     * caller omits stay undefined on the instance — they are NOT filled
+     * from shipped defaults here (the resolver in T4b merges layers).
+     */
+    static from(input) {
+        return new ImageCompressPresetOptions(input);
+    }
+    /**
+     * Return the SDK shipped defaults for the (image, compress) cell at
+     * the given level. Reads the F3 PRESETS matrix and translates member
+     * names to wire backing values.
+     *
+     * Note for OptimizeFor.Quality: the F3 PRESETS cell deliberately
+     * omits `quality` because the contract has `depends_on: { mode: lossy }`
+     * on the quality field — under `mode: Lossless` the API ignores
+     * `quality`, so shipping a default would mislead callers.
+     */
+    static shippedDefaultsFor(level) {
+        const cell = f3ShippedDefaultsFor('image_compress', level);
+        const input = {};
+        const mut = input;
+        if ('mode' in cell)
+            mut.mode = translateEnum('ImageMode', cell.mode);
+        if ('quality' in cell)
+            mut.quality = cell.quality;
+        if ('width' in cell)
+            mut.width = cell.width;
+        if ('height' in cell)
+            mut.height = cell.height;
+        if ('fit' in cell)
+            mut.fit = translateEnum('ImageFit', cell.fit);
+        if ('metadata' in cell)
+            mut.metadata = translateEnum('ImageMetadataPolicy', cell.metadata);
+        if ('iccProfile' in cell)
+            mut.iccProfile = translateEnum('IccProfilePolicy', cell.iccProfile);
+        if ('autoOrient' in cell)
+            mut.autoOrient = cell.autoOrient;
+        if ('progressive' in cell)
+            mut.progressive = cell.progressive;
+        if ('outputFormat' in cell)
+            mut.outputFormat = translateEnum('ImageFormat', cell.outputFormat);
+        return new ImageCompressPresetOptions(input);
+    }
+}

package/dist/ergonomic/presets/index.d.ts

@@ -0,0 +1,77 @@
+import { OptimizeFor } from '../../generated/sdk_spec/enums.js';
+import { ImageCompressPresetOptions, type ImageCompressPresetOptionsInput } from './image_compress.js';
+import { AudioCompressPresetOptions, type AudioCompressPresetOptionsInput } from './audio_compress.js';
+import { VideoCompressPresetOptions, type VideoCompressPresetOptionsInput } from './video_compress.js';
+import { DocumentPdfCompressPresetOptions, type DocumentPdfCompressPresetOptionsInput } from './document_pdf_compress.js';
+import { DocumentOfficeCompressPresetOptions, type DocumentOfficeCompressPresetOptionsInput } from './document_office_compress.js';
+import { DocumentOdfCompressPresetOptions, type DocumentOdfCompressPresetOptionsInput } from './document_odf_compress.js';
+import { DocumentEpubCompressPresetOptions, type DocumentEpubCompressPresetOptionsInput } from './document_epub_compress.js';
+export { ImageCompressPresetOptions, type ImageCompressPresetOptionsInput, } from './image_compress.js';
+export { AudioCompressPresetOptions, type AudioCompressPresetOptionsInput, } from './audio_compress.js';
+export { VideoCompressPresetOptions, type VideoCompressPresetOptionsInput, } from './video_compress.js';
+export { DocumentPdfCompressPresetOptions, type DocumentPdfCompressPresetOptionsInput, } from './document_pdf_compress.js';
+export { DocumentOfficeCompressPresetOptions, type DocumentOfficeCompressPresetOptionsInput, } from './document_office_compress.js';
+export { DocumentOdfCompressPresetOptions, type DocumentOdfCompressPresetOptionsInput, } from './document_odf_compress.js';
+export { DocumentEpubCompressPresetOptions, type DocumentEpubCompressPresetOptionsInput, } from './document_epub_compress.js';
+export { OptimizeFor, ImageMode, ImageFit, ImageMetadataPolicy, IccProfilePolicy, ImageFormat, VideoCodec, VideoPreset, VideoFit, AudioBitrate, AudioCodec, AudioSampleRate, PdfProfile, PdfColorspace, } from '../../generated/sdk_spec/enums.js';
+/** Supported media×op pairs for preset cells in T4a. Compress-only. */
+export type PresetMedia = 'image' | 'audio' | 'video' | 'document_pdf' | 'document_office' | 'document_odf' | 'document_epub';
+export type PresetOp = 'compress';
+/**
+ * Union of leaf-DTO types the resolver will see from `cellFor()`.
+ * Discriminated by which `media` the caller passes — the type system
+ * narrows the return automatically via the overload set below.
+ */
+export type AnyPresetOptions = ImageCompressPresetOptions | AudioCompressPresetOptions | VideoCompressPresetOptions | DocumentPdfCompressPresetOptions | DocumentOfficeCompressPresetOptions | DocumentOdfCompressPresetOptions | DocumentEpubCompressPresetOptions;
+export declare class PresetDefaults {
+    private readonly cells;
+    private constructor();
+    /** Empty builder — entry point for `presetDefaults()`. @internal */
+    static _empty(): PresetDefaults;
+    /**
+     * Deep-merge two {@link PresetDefaults} into a new instance (T4c —
+     * `ULAlOP6j`). Used by `withPresetDefaults` to stack scoped derives:
+     * `client.withPresetDefaults(a).withPresetDefaults(b)` produces a
+     * scoped layer equivalent to `merge(a, b)` — `b`'s per-cell fields
+     * override `a`'s where defined; `a`'s fields fill gaps.
+     *
+     * Per-cell semantics (codex r2 #5 — scalar-leaf merge):
+     * - If a `(cellKey, level)` entry is present in EITHER only, take it
+     *   verbatim.
+     * - If present in both, merge the per-cell `*Input` shapes via
+     *   `Object.assign({}, parentInput, childInput)` and re-construct
+     *   the leaf DTO. Every cell-DTO field is a scalar (primitive,
+     *   enum-string, or `string | number` for `targetSize`) — shallow
+     *   merge gives the correct field-wise override.
+     *
+     * Parent and child instances are unaffected.
+     */
+    static merge(parent: PresetDefaults, child: PresetDefaults): PresetDefaults;
+    /** Register a (level, delta) on the image-compress cell. Immutable. */
+    imageCompress(level: OptimizeFor, input?: ImageCompressPresetOptionsInput): PresetDefaults;
+    /** Register a (level, delta) on the audio-compress cell. Immutable. */
+    audioCompress(level: OptimizeFor, input?: AudioCompressPresetOptionsInput): PresetDefaults;
+    /** Register a (level, delta) on the video-compress cell. Immutable. */
+    videoCompress(level: OptimizeFor, input?: VideoCompressPresetOptionsInput): PresetDefaults;
+    /** Register a (level, delta) on the document-pdf-compress cell. Immutable. */
+    pdfCompress(level: OptimizeFor, input?: DocumentPdfCompressPresetOptionsInput): PresetDefaults;
+    /** Register a (level, delta) on the document-office-compress cell. Immutable. */
+    officeCompress(level: OptimizeFor, input?: DocumentOfficeCompressPresetOptionsInput): PresetDefaults;
+    /** Register a (level, delta) on the document-odf-compress cell. Immutable. */
+    odfCompress(level: OptimizeFor, input?: DocumentOdfCompressPresetOptionsInput): PresetDefaults;
+    /** Register a (level, delta) on the document-epub-compress cell. Immutable. */
+    epubCompress(level: OptimizeFor, input?: DocumentEpubCompressPresetOptionsInput): PresetDefaults;
+    /** @internal */ cellFor(media: 'image', op: 'compress', level: OptimizeFor): ImageCompressPresetOptions | undefined;
+    /** @internal */ cellFor(media: 'audio', op: 'compress', level: OptimizeFor): AudioCompressPresetOptions | undefined;
+    /** @internal */ cellFor(media: 'video', op: 'compress', level: OptimizeFor): VideoCompressPresetOptions | undefined;
+    /** @internal */ cellFor(media: 'document_pdf', op: 'compress', level: OptimizeFor): DocumentPdfCompressPresetOptions | undefined;
+    /** @internal */ cellFor(media: 'document_office', op: 'compress', level: OptimizeFor): DocumentOfficeCompressPresetOptions | undefined;
+    /** @internal */ cellFor(media: 'document_odf', op: 'compress', level: OptimizeFor): DocumentOdfCompressPresetOptions | undefined;
+    /** @internal */ cellFor(media: 'document_epub', op: 'compress', level: OptimizeFor): DocumentEpubCompressPresetOptions | undefined;
+}
+/**
+ * Construct an empty {@link PresetDefaults} builder. Chain per-cell
+ * methods to register layered defaults; the resolver in T4b consumes
+ * the result via `cellFor(...)`.
+ */
+export declare function presetDefaults(): PresetDefaults;