@apicircle/core 1.0.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -204,9 +204,9 @@ interface BuiltRequest {
204
204
  }
205
205
  /**
206
206
  * Resolves an attachment slotId to a Blob (with filename for form-data).
207
- * The host (UI layer) reads this from its IndexedDB attachments store.
208
- * Returns null when the attachment is missing composeBody treats missing
209
- * attachments as empty fields rather than throwing.
207
+ * The host reads this from IndexedDB; the CLI reads it from its filesystem
208
+ * cache. A null return means "not downloaded" and becomes a hard execution
209
+ * failure.
210
210
  */
211
211
  type AttachmentResolver = (slotId: string) => Promise<{
212
212
  blob: Blob;
@@ -1412,7 +1412,7 @@ interface GraphQLField {
1412
1412
  declare function parseGraphqlSchema(source: string, kind: 'sdl' | 'introspection'): GraphQLSchemaInfo;
1413
1413
 
1414
1414
  type DiffStatus = 'unchanged' | 'local-only' | 'remote-only' | 'both-equal' | 'conflict';
1415
- type EntityBucket = 'request' | 'folder' | 'environment' | 'linkedWorkspace' | 'mockServer' | 'executionPlan' | 'secretKey' | 'globalSchema' | 'globalGraphql' | 'linkedRequestOverride' | 'linkedEnvOverride' | 'releasePerLink' | 'tree' | 'environmentsActive' | 'environmentsPriority' | 'releaseSelf' | 'secretCrypto';
1415
+ type EntityBucket = 'request' | 'folder' | 'environment' | 'linkedWorkspace' | 'mockServer' | 'executionPlan' | 'secretKey' | 'globalSchema' | 'globalGraphql' | 'globalFile' | 'linkedRequestOverride' | 'linkedEnvOverride' | 'releasePerLink' | 'tree' | 'environmentsActive' | 'environmentsPriority' | 'releaseSelf' | 'secretCrypto';
1416
1416
  interface DiffEntry {
1417
1417
  bucket: EntityBucket;
1418
1418
  /** Entity id within the bucket. Empty string for singleton buckets. */
@@ -1616,6 +1616,8 @@ interface RunPlanOptions {
1616
1616
  signal?: AbortSignal;
1617
1617
  /** Per-request hard timeout in ms. `null` disables. Defaults to executeRequest's 30s. */
1618
1618
  timeoutMs?: number | null;
1619
+ /** Resolver for local and linked attachment bytes used by file/binary bodies. */
1620
+ resolveAttachment?: AttachmentResolver;
1619
1621
  /** Plaintext secret values keyed by `secretKeyId`, for encrypted env vars. */
1620
1622
  secretsById?: Record<string, string>;
1621
1623
  /** Identity of whoever launched the run. Defaults to {@link ANONYMOUS_ACTOR}. */
package/dist/index.d.ts CHANGED
@@ -204,9 +204,9 @@ interface BuiltRequest {
204
204
  }
205
205
  /**
206
206
  * Resolves an attachment slotId to a Blob (with filename for form-data).
207
- * The host (UI layer) reads this from its IndexedDB attachments store.
208
- * Returns null when the attachment is missing composeBody treats missing
209
- * attachments as empty fields rather than throwing.
207
+ * The host reads this from IndexedDB; the CLI reads it from its filesystem
208
+ * cache. A null return means "not downloaded" and becomes a hard execution
209
+ * failure.
210
210
  */
211
211
  type AttachmentResolver = (slotId: string) => Promise<{
212
212
  blob: Blob;
@@ -1412,7 +1412,7 @@ interface GraphQLField {
1412
1412
  declare function parseGraphqlSchema(source: string, kind: 'sdl' | 'introspection'): GraphQLSchemaInfo;
1413
1413
 
1414
1414
  type DiffStatus = 'unchanged' | 'local-only' | 'remote-only' | 'both-equal' | 'conflict';
1415
- type EntityBucket = 'request' | 'folder' | 'environment' | 'linkedWorkspace' | 'mockServer' | 'executionPlan' | 'secretKey' | 'globalSchema' | 'globalGraphql' | 'linkedRequestOverride' | 'linkedEnvOverride' | 'releasePerLink' | 'tree' | 'environmentsActive' | 'environmentsPriority' | 'releaseSelf' | 'secretCrypto';
1415
+ type EntityBucket = 'request' | 'folder' | 'environment' | 'linkedWorkspace' | 'mockServer' | 'executionPlan' | 'secretKey' | 'globalSchema' | 'globalGraphql' | 'globalFile' | 'linkedRequestOverride' | 'linkedEnvOverride' | 'releasePerLink' | 'tree' | 'environmentsActive' | 'environmentsPriority' | 'releaseSelf' | 'secretCrypto';
1416
1416
  interface DiffEntry {
1417
1417
  bucket: EntityBucket;
1418
1418
  /** Entity id within the bucket. Empty string for singleton buckets. */
@@ -1616,6 +1616,8 @@ interface RunPlanOptions {
1616
1616
  signal?: AbortSignal;
1617
1617
  /** Per-request hard timeout in ms. `null` disables. Defaults to executeRequest's 30s. */
1618
1618
  timeoutMs?: number | null;
1619
+ /** Resolver for local and linked attachment bytes used by file/binary bodies. */
1620
+ resolveAttachment?: AttachmentResolver;
1619
1621
  /** Plaintext secret values keyed by `secretKeyId`, for encrypted env vars. */
1620
1622
  secretsById?: Record<string, string>;
1621
1623
  /** Identity of whoever launched the run. Defaults to {@link ANONYMOUS_ACTOR}. */