@giveitsmaller/sdk 0.6.0 → 0.7.0

package/dist/generated/sdk_spec/errors.js

@@ -0,0 +1,473 @@
+// CODE GENERATED — DO NOT EDIT.
+// Source: compression_contracts/sdk-spec/ (see sdk-spec/README.md).
+// Regenerate with: scripts/generate.py.
+export const ERROR_CODES = Object.freeze({
+    "missing_credentials": Object.freeze({
+        code: "missing_credentials",
+        category: "config",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislMissingCredentialsError",
+        description: "gisl.create() failed the credential chain (explicit → GISL_API_KEY env → ~/.gisl/credentials profile → fail-early).",
+        metadataSchema: Object.freeze({
+            "sourcesTried": "array",
+        }),
+    }),
+    "feature_requires_auth": Object.freeze({
+        code: "feature_requires_auth",
+        category: "config",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislFeatureRequiresAuthError",
+        description: "SDK rejected an anonymous-mode call to a feature that requires authentication. Pre-flight gate; never reaches the API.",
+        metadataSchema: Object.freeze({
+            "feature": "string",
+        }),
+    }),
+    "undeclared_asset": Object.freeze({
+        code: "undeclared_asset",
+        category: "chain",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislUndeclaredAssetError",
+        description: "Merge / archive / mapEach referenced an asset handle that was not declared upstream in the chain.",
+        metadataSchema: Object.freeze({
+            "ref": "string",
+        }),
+    }),
+    "unused_asset": Object.freeze({
+        code: "unused_asset",
+        category: "chain",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislUnusedAssetError",
+        description: "A declared asset was never referenced in the chain (caller likely forgot to use it; escape via allowUnusedAssets).",
+        metadataSchema: Object.freeze({
+            "ref": "string",
+        }),
+    }),
+    "per_input_options_not_supported": Object.freeze({
+        code: "per_input_options_not_supported",
+        category: "chain",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislPerInputOptionsNotSupportedError",
+        description: "per_input_options provided on a multi-input op role that doesn't accept it (e.g. role-less branch).",
+        metadataSchema: Object.freeze({
+            "op": "string",
+            "role": "string",
+        }),
+    }),
+    "chain_cardinality_mismatch": Object.freeze({
+        code: "chain_cardinality_mismatch",
+        category: "chain",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislChainCardinalityMismatchError",
+        description: "Chain step expects a single artifact but the upstream step produces N (e.g.\n.compress() chained after convert(pdf, pages: \"1-20\")). Recovery: branch\nto a single artifact OR use .mapEach() to fan out.\n",
+        metadataSchema: Object.freeze({
+            "upstreamArtifactCount": "integer",
+            "operation": "string",
+        }),
+    }),
+    "multipart_part_invalid": Object.freeze({
+        code: "multipart_part_invalid",
+        category: "validation",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislMultipartPartError",
+        description: "SDK rejected a part configuration before upload (e.g. out-of-range part number, duplicate, missing).",
+        metadataSchema: Object.freeze({
+            "partNumber": "integer",
+            "reason": "string",
+        }),
+    }),
+    "multipart_part_count_exceeded": Object.freeze({
+        code: "multipart_part_count_exceeded",
+        category: "validation",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislMultipartPartCountError",
+        description: "Multipart presign batch / total parts exceeds S3 ceilings (10 000 total, 100 per presign request).",
+        metadataSchema: Object.freeze({
+            "partCount": "integer",
+            "ceiling": "integer",
+        }),
+    }),
+    "timeout": Object.freeze({
+        code: "timeout",
+        category: "network",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: true,
+        sdkClass: "GislTimeoutError",
+        description: "SDK-set deadline exceeded (run({maxWait}), waitForCompletion, multipart attempt timeout).",
+        metadataSchema: Object.freeze({
+            "timeoutMs": "integer",
+            "phase": "string",
+        }),
+    }),
+    "aborted": Object.freeze({
+        code: "aborted",
+        category: "network",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislAbortError",
+        description: "Caller-supplied AbortSignal triggered cancellation.",
+        metadataSchema: Object.freeze({
+            "reason": "string",
+        }),
+    }),
+    "validation_failed": Object.freeze({
+        code: "validation_failed",
+        category: "validation",
+        source: "ErrorEnvelope.error",
+        status: "wired",
+        httpStatus: 422,
+        retryable: false,
+        sdkClass: "GislValidationError",
+        description: "422 — request validation failure; emitted on the wire as `VALIDATION_FAILED` (e.g. invalid limit/offset on GET /api/v2/credits/usage). Carries `details[]`.",
+        metadataSchema: Object.freeze({
+            "details": "array",
+        }),
+    }),
+    "auth_failed": Object.freeze({
+        code: "auth_failed",
+        category: "auth",
+        source: "ErrorEnvelope.error",
+        status: "wired",
+        httpStatus: 401,
+        retryable: false,
+        sdkClass: "GislAuthError",
+        description: "401 — invalid / expired / missing API key.",
+        metadataSchema: Object.freeze({
+            "authErrorType": "string",
+        }),
+    }),
+    "feature_tier_restricted": Object.freeze({
+        code: "feature_tier_restricted",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 403,
+        retryable: false,
+        sdkClass: "GislFeatureTierRestrictedError",
+        description: "403 — feature requires a higher subscription tier than the caller's.",
+        metadataSchema: Object.freeze({
+            "feature": "string",
+            "requiredTier": "string",
+            "currentTier": "string",
+        }),
+    }),
+    "tier_restriction": Object.freeze({
+        code: "tier_restriction",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 403,
+        retryable: false,
+        sdkClass: "GislTierRestrictedError",
+        description: "403 — general tier restriction (not feature-specific). Wire emits `error_type: \"tier_restriction\"`; the SDK class name keeps the `TierRestricted` adjective form per packages/typescript/src/errors.ts.",
+        metadataSchema: Object.freeze({
+            "requiredTier": "string",
+            "currentTier": "string",
+        }),
+    }),
+    "multipart_session_ownership": Object.freeze({
+        code: "multipart_session_ownership",
+        category: "auth",
+        source: "ErrorEnvelope.error",
+        status: "wired",
+        httpStatus: 403,
+        retryable: false,
+        sdkClass: "GislMultipartSessionOwnershipError",
+        description: "403 on multipart resume — session exists but belongs to a different caller.",
+        metadataSchema: Object.freeze({
+            "uploadId": "string",
+        }),
+    }),
+    "multipart_session_auth_required": Object.freeze({
+        code: "multipart_session_auth_required",
+        category: "auth",
+        source: "ErrorEnvelope.error",
+        status: "wired",
+        httpStatus: 403,
+        retryable: false,
+        sdkClass: "GislMultipartSessionAuthRequiredError",
+        description: "403 on multipart resume — session was initiated anonymously; resume requires auth (future-flip per upstream 8LABloaz).",
+        metadataSchema: Object.freeze({
+            "uploadId": "string",
+        }),
+    }),
+    "multipart_session_not_found": Object.freeze({
+        code: "multipart_session_not_found",
+        category: "api",
+        source: "ErrorEnvelope.error",
+        status: "wired",
+        httpStatus: 404,
+        retryable: false,
+        sdkClass: "GislMultipartSessionNotFoundError",
+        description: "404 on multipart resume — upload_id unknown or expired past 48h TTL.",
+        metadataSchema: Object.freeze({
+            "uploadId": "string",
+        }),
+    }),
+    "workflow_expired": Object.freeze({
+        code: "workflow_expired",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 410,
+        retryable: false,
+        sdkClass: "GislWorkflowExpiredError",
+        description: "410 — workflow result TTL expired; outputs no longer downloadable.",
+        metadataSchema: Object.freeze({
+            "workflowId": "string",
+        }),
+    }),
+    "balance_exhausted": Object.freeze({
+        code: "balance_exhausted",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 402,
+        retryable: false,
+        sdkClass: "GislBalanceExhaustedError",
+        description: "402 — workflow create rejected because cost estimate exceeds available credits (monthly + purchased + overdraft).",
+        metadataSchema: Object.freeze({
+            "requiredCredits": "integer",
+            "availableCredits": "integer",
+            "links": "object",
+        }),
+    }),
+    "feature_not_available": Object.freeze({
+        code: "feature_not_available",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 422,
+        retryable: false,
+        sdkClass: "GislFeatureNotAvailableError",
+        description: "422 — operation type is planned but not yet implemented server-side (e.g. custom_luma before Lambda support ships).",
+        metadataSchema: Object.freeze({
+            "feature": "string",
+        }),
+    }),
+    "upload_size_exceeds_tier": Object.freeze({
+        code: "upload_size_exceeds_tier",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 422,
+        retryable: false,
+        sdkClass: "GislUploadCapExceededError",
+        description: "422 — uploaded file size exceeds the per-tier cap. Wire `error_type: \"upload_size_exceeds_tier\"`. SDK class GislUploadCapExceededError covers this + upload_duration_exceeds_tier (sibling code below).",
+        metadataSchema: Object.freeze({
+            "size": "integer",
+            "ceiling": "integer",
+        }),
+    }),
+    "upload_duration_exceeds_tier": Object.freeze({
+        code: "upload_duration_exceeds_tier",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 422,
+        retryable: false,
+        sdkClass: "GislUploadCapExceededError",
+        description: "422 — uploaded media duration exceeds the per-tier cap. Wire `error_type: \"upload_duration_exceeds_tier\"`. Shares SDK class GislUploadCapExceededError with upload_size_exceeds_tier; consumers branch on the metadata.",
+        metadataSchema: Object.freeze({
+            "duration": "integer",
+            "ceiling": "integer",
+        }),
+    }),
+    "probe_pending": Object.freeze({
+        code: "probe_pending",
+        category: "api",
+        source: "error_type",
+        status: "wired",
+        httpStatus: 422,
+        retryable: true,
+        sdkClass: "GislApiError",
+        description: "422 on workflow create — upload probing not yet complete; retry after the upload finishes probing. Wire `error_type: \"probe_pending\"`.",
+        metadataSchema: Object.freeze({
+            "jobRef": "string",
+        }),
+    }),
+    "requires_reencode": Object.freeze({
+        code: "requires_reencode",
+        category: "api",
+        source: "ErrorEnvelope.error",
+        status: "wired",
+        httpStatus: 422,
+        retryable: false,
+        sdkClass: "GislApiError",
+        description: "422 on merge — inputs are byte-stream-incompatible (different codec / resolution / etc.); merge requires re-encode rather than concat.",
+        metadataSchema: Object.freeze({
+            "reason": "string",
+        }),
+    }),
+    "invalid_options": Object.freeze({
+        code: "invalid_options",
+        category: "validation",
+        source: "ErrorEnvelope.error",
+        status: "wired",
+        httpStatus: 422,
+        retryable: false,
+        sdkClass: "GislValidationError",
+        description: "422 — operation option failed server-side validation (range, depends_on, mutex). Often surfaces preflight rejections (e.g. split.cut_points len exceeds 200-output cap).",
+        metadataSchema: Object.freeze({
+            "field": "string",
+            "reason": "string",
+        }),
+    }),
+    "invalid_combination": Object.freeze({
+        code: "invalid_combination",
+        category: "validation",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislValidationError",
+        description: "Two or more options that are mutually exclusive per contract `depends_on` / mutex were both provided.",
+        metadataSchema: Object.freeze({
+            "fields": "array",
+        }),
+    }),
+    "missing_dependency": Object.freeze({
+        code: "missing_dependency",
+        category: "validation",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislValidationError",
+        description: "An option was set but its contract `depends_on` predicate was not satisfied (e.g. quality set but mode is not lossy).",
+        metadataSchema: Object.freeze({
+            "field": "string",
+            "requires": "array",
+        }),
+    }),
+    "unsupported_value": Object.freeze({
+        code: "unsupported_value",
+        category: "validation",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislValidationError",
+        description: "A value was outside the allowed enum / range for an option.",
+        metadataSchema: Object.freeze({
+            "field": "string",
+            "value": "string",
+            "allowed": "array",
+        }),
+    }),
+    "type_mismatch": Object.freeze({
+        code: "type_mismatch",
+        category: "validation",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislValidationError",
+        description: "A value's type didn't match the schema (e.g. string where integer expected).",
+        metadataSchema: Object.freeze({
+            "field": "string",
+            "expected": "string",
+            "actual": "string",
+        }),
+    }),
+    "upload_failed": Object.freeze({
+        code: "upload_failed",
+        category: "network",
+        source: "SDK_local",
+        status: "wired",
+        httpStatus: null,
+        retryable: true,
+        sdkClass: "GislError",
+        description: "Single-shot or multipart upload failed after retry exhaustion. Distinct from auth/balance/cap errors (those are typed above).",
+        metadataSchema: Object.freeze({
+            "reason": "string",
+            "attempt": "integer",
+        }),
+    }),
+    "workflow_failed": Object.freeze({
+        code: "workflow_failed",
+        category: "api",
+        source: "OperationResponse.error_code",
+        status: "wired",
+        httpStatus: null,
+        retryable: false,
+        sdkClass: "GislApiError",
+        description: "Workflow reached terminal failure status. Per-job error codes live on jobErrors[].errorCode.",
+        metadataSchema: Object.freeze({
+            "workflowId": "string",
+            "jobErrors": "array",
+        }),
+    }),
+});
+export const ERROR_CATEGORIES = Object.freeze({
+    api: Object.freeze([
+        "feature_tier_restricted",
+        "tier_restriction",
+        "multipart_session_not_found",
+        "workflow_expired",
+        "balance_exhausted",
+        "feature_not_available",
+        "upload_size_exceeds_tier",
+        "upload_duration_exceeds_tier",
+        "probe_pending",
+        "requires_reencode",
+        "workflow_failed",
+    ]),
+    config: Object.freeze([
+        "missing_credentials",
+        "feature_requires_auth",
+    ]),
+    network: Object.freeze([
+        "timeout",
+        "aborted",
+        "upload_failed",
+    ]),
+    auth: Object.freeze([
+        "auth_failed",
+        "multipart_session_ownership",
+        "multipart_session_auth_required",
+    ]),
+    validation: Object.freeze([
+        "multipart_part_invalid",
+        "multipart_part_count_exceeded",
+        "validation_failed",
+        "invalid_options",
+        "invalid_combination",
+        "missing_dependency",
+        "unsupported_value",
+        "type_mismatch",
+    ]),
+    chain: Object.freeze([
+        "undeclared_asset",
+        "unused_asset",
+        "per_input_options_not_supported",
+        "chain_cardinality_mismatch",
+    ]),
+});

package/dist/generated/sdk_spec/index.d.ts

@@ -0,0 +1,4 @@
+export * from './presets.js';
+export * from './enums.js';
+export * from './errors.js';
+export * from './version.js';

package/dist/generated/sdk_spec/index.js

@@ -0,0 +1,7 @@
+// CODE GENERATED — DO NOT EDIT.
+// Source: compression_contracts/sdk-spec/ (see sdk-spec/README.md).
+// Regenerate with: scripts/generate.py.
+export * from './presets.js';
+export * from './enums.js';
+export * from './errors.js';
+export * from './version.js';

package/dist/generated/sdk_spec/presets.d.ts

@@ -0,0 +1,6 @@
+export type PresetLevel = 'Size' | 'Balanced' | 'Quality';
+export type PresetCell = Readonly<Record<string, string | number | boolean>>;
+export type PresetMatrix = Readonly<Record<string, Readonly<Record<PresetLevel, PresetCell>>>>;
+export declare const PRESETS: PresetMatrix;
+/** Lookup the shipped preset cell for (mediaOp, level). Throws on unknown keys. */
+export declare function shippedDefaultsFor(mediaOp: string, level: PresetLevel): PresetCell;

package/dist/generated/sdk_spec/presets.js

@@ -0,0 +1,157 @@
+// CODE GENERATED — DO NOT EDIT.
+// Source: compression_contracts/sdk-spec/ (see sdk-spec/README.md).
+// Regenerate with: scripts/generate.py.
+export const PRESETS = Object.freeze({
+    "image_compress": Object.freeze({
+        Size: Object.freeze({
+            "mode": "Lossy",
+            "quality": 65,
+            "metadata": "All",
+            "iccProfile": "Strip",
+            "autoOrient": true,
+            "progressive": true,
+            "outputFormat": "Smallest",
+        }),
+        Balanced: Object.freeze({
+            "mode": "Auto",
+            "quality": 80,
+            "metadata": "Sensitive",
+            "iccProfile": "Preserve",
+            "autoOrient": true,
+            "progressive": true,
+            "outputFormat": "Auto",
+        }),
+        Quality: Object.freeze({
+            "mode": "Lossless",
+            "metadata": "None",
+            "iccProfile": "Preserve",
+            "autoOrient": true,
+            "progressive": true,
+            "outputFormat": "Original",
+        }),
+    }),
+    "audio_compress": Object.freeze({
+        Size: Object.freeze({
+            "bitrate": "_96",
+            "sampleRate": "_44100",
+            "normalize": true,
+        }),
+        Balanced: Object.freeze({
+            "bitrate": "_192",
+            "sampleRate": "_44100",
+            "normalize": true,
+        }),
+        Quality: Object.freeze({
+            "bitrate": "_320",
+            "sampleRate": "_48000",
+            "normalize": false,
+        }),
+    }),
+    "video_compress": Object.freeze({
+        Size: Object.freeze({
+            "codec": "H265",
+            "crf": 30,
+            "preset": "Slow",
+            "faststart": true,
+            "audioCodec": "Aac",
+            "audioBitrate": "_96",
+        }),
+        Balanced: Object.freeze({
+            "codec": "H264",
+            "crf": 23,
+            "preset": "Medium",
+            "faststart": true,
+            "audioCodec": "Aac",
+            "audioBitrate": "_128",
+        }),
+        Quality: Object.freeze({
+            "codec": "H264",
+            "crf": 18,
+            "preset": "Slow",
+            "faststart": true,
+            "audioCodec": "Aac",
+            "audioBitrate": "_192",
+        }),
+    }),
+    "document_pdf_compress": Object.freeze({
+        Size: Object.freeze({
+            "profile": "Max",
+            "colorspace": "Grayscale",
+            "flattenForms": false,
+        }),
+        Balanced: Object.freeze({
+            "profile": "Web",
+            "colorspace": "Unchanged",
+            "flattenForms": false,
+        }),
+        Quality: Object.freeze({
+            "profile": "Archive",
+            "colorspace": "Unchanged",
+            "flattenForms": false,
+        }),
+    }),
+    "document_office_compress": Object.freeze({
+        Size: Object.freeze({
+            "imageQuality": 60,
+            "stripMacros": true,
+            "stripHiddenData": true,
+            "stripUnusedFonts": true,
+        }),
+        Balanced: Object.freeze({
+            "imageQuality": 80,
+            "stripMacros": true,
+            "stripHiddenData": false,
+            "stripUnusedFonts": false,
+        }),
+        Quality: Object.freeze({
+            "imageQuality": 92,
+            "stripMacros": false,
+            "stripHiddenData": false,
+            "stripUnusedFonts": false,
+        }),
+    }),
+    "document_odf_compress": Object.freeze({
+        Size: Object.freeze({
+            "imageQuality": 60,
+            "stripMetadata": true,
+            "stripUnusedStyles": true,
+        }),
+        Balanced: Object.freeze({
+            "imageQuality": 80,
+            "stripMetadata": true,
+            "stripUnusedStyles": false,
+        }),
+        Quality: Object.freeze({
+            "imageQuality": 92,
+            "stripMetadata": false,
+            "stripUnusedStyles": false,
+        }),
+    }),
+    "document_epub_compress": Object.freeze({
+        Size: Object.freeze({
+            "imageQuality": 60,
+            "fontSubsetting": true,
+            "stripUnusedCss": true,
+        }),
+        Balanced: Object.freeze({
+            "imageQuality": 80,
+            "fontSubsetting": true,
+            "stripUnusedCss": false,
+        }),
+        Quality: Object.freeze({
+            "imageQuality": 92,
+            "fontSubsetting": false,
+            "stripUnusedCss": false,
+        }),
+    }),
+});
+/** Lookup the shipped preset cell for (mediaOp, level). Throws on unknown keys. */
+export function shippedDefaultsFor(mediaOp, level) {
+    const group = PRESETS[mediaOp];
+    if (!group)
+        throw new Error(`Unknown preset mediaOp: ${mediaOp}`);
+    const cell = group[level];
+    if (!cell)
+        throw new Error(`Unknown preset level for ${mediaOp}: ${level}`);
+    return cell;
+}

package/dist/generated/sdk_spec/version.d.ts

@@ -0,0 +1,3 @@
+export declare const SDK_SPEC_VERSION: "1.1.0";
+export declare const PRESET_VERSION: "1.0";
+export declare const PRESET_CONFIG_HASH: "sha256:35aeb0b6b86edd9814ace5b75cfeef8a7b1432ecb8e4d5ee8b38d9187a0b45eb";

package/dist/generated/sdk_spec/version.js

@@ -0,0 +1,6 @@
+// CODE GENERATED — DO NOT EDIT.
+// Source: compression_contracts/sdk-spec/ (see sdk-spec/README.md).
+// Regenerate with: scripts/generate.py.
+export const SDK_SPEC_VERSION = "1.1.0";
+export const PRESET_VERSION = "1.0";
+export const PRESET_CONFIG_HASH = "sha256:35aeb0b6b86edd9814ace5b75cfeef8a7b1432ecb8e4d5ee8b38d9187a0b45eb";