@apicircle/shared 1.0.2 → 1.0.4

package/dist/index.d.cts

@@ -347,6 +347,7 @@ interface WorkspaceSynced {
     globalAssets: {
         schemas: Record<string, GlobalSchema>;
         graphql: Record<string, GlobalGraphQL>;
+        files?: Record<string, GlobalFileAsset>;
     };
     mockServers: Record<string, MockServer>;
     /**
@@ -485,6 +486,18 @@ interface GlobalGraphQL {
     createdAt: string;
     updatedAt: string;
 }
+interface GlobalFileAsset {
+    id: string;
+    name: string;
+    description?: string;
+    slotId: string;
+    filename: string;
+    size: number;
+    mimeType: string;
+    sha256?: string;
+    createdAt: string;
+    updatedAt: string;
+}
 type RequestAuth = {
     type: 'none';
 } | {
@@ -640,6 +653,7 @@ type FormDataRow = {
     kind: 'file';
     key: string;
     slotId: string | null;
+    globalFileAssetId?: string | null;
     filename?: string;
     size?: number;
     mimeType?: string;
@@ -648,11 +662,33 @@ type FormDataRow = {
 };
 interface AttachmentRef {
     slotId: string | null;
+    globalFileAssetId?: string | null;
     filename?: string;
     size?: number;
     mimeType?: string;
     sha256?: string;
 }
+interface LocalAttachmentCacheEntry {
+    slotId: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    sha256?: string;
+    /**
+     * Local-only path or storage URI where this device can read the bytes for
+     * execution. Browser builds use an IndexedDB URI; CLI runs use an absolute
+     * filesystem path under `.apicircle/attachments/`.
+     */
+    localPath: string;
+    storage: 'indexeddb' | 'filesystem';
+    source: 'workspace' | 'linked-workspace';
+    linkedWorkspaceId?: string;
+    requiredBy: Array<{
+        requestId: string;
+        requestName: string;
+    }>;
+    downloadedAt: string;
+}
 interface Assertion {
     id: string;
     kind: 'status' | 'header' | 'json-path' | 'duration';
@@ -813,6 +849,13 @@ interface WorkspaceLocal {
     retiredBranch: RetiredBranch | null;
     sync: SyncSnapshot;
     linkedCollections: Record<string, LinkedSnapshot>;
+    /**
+     * Local-only attachment cache metadata. The bytes themselves live outside
+     * workspace.json (IndexedDB in the web app, `.apicircle/attachments` for
+     * the CLI). This tells execution where the bytes are available locally and
+     * which request(s) require each file.
+     */
+    attachmentCache?: Record<string, LocalAttachmentCacheEntry>;
     globalContext: Record<string, string>;
     mockRuntime: MockRuntime;
     ui: {
@@ -920,6 +963,13 @@ interface LinkedSnapshot {
     ref: string;
     collections: WorkspaceSynced['collections'];
     environments: WorkspaceSynced['environments'];
+    /**
+     * Source workspace assets referenced by linked requests
+     * (`bodySchemaId` / `graphqlSchemaId`). Cached locally with the linked
+     * collections so linked editors and execution can resolve schema refs
+     * without copying assets into the consumer's synced workspace.
+     */
+    globalAssets?: WorkspaceSynced['globalAssets'];
     /**
      * The source workspace's secret-key registry, cached so the link card
      * can render slot labels (not just raw ids). Optional — older
@@ -1242,4 +1292,4 @@ interface McpError {
 /** Helper: full enumeration of tool names — useful for the docs / config UIs. */
 declare const MCP_TOOL_NAMES: ReadonlyArray<McpToolName>;
 
-export { type Assertion, type AttachmentRef, type AwsSigV4Auth, type BodyType, type ConnectedRepo, type ContextExtraction, DEFAULT_WORKSPACE_NAME, type DigestAuth, type EnvPriorityRef, type Environment, type EnvironmentVariable, type EnvironmentVariableOverride, type ExecutionPlan, FONT_SIZE_PERCENT_DEFAULT, FONT_SIZE_PERCENT_MAX, FONT_SIZE_PERCENT_MIN, FONT_SIZE_PERCENT_STEP, type Folder, type FolderNode, type FontFamilyId, type FormDataRow, type GitHubSession, type GlobalGraphQL, type GlobalSchema, type HawkAuth, type HttpMethod, type JwtBearerAuth, type LinkedSnapshot, type LinkedWorkspace, MCP_TOOL_NAMES, type McpError, type McpToolName, type MockConditionClause, type MockConditionOp, type MockConditionScope, type MockEndpoint, type MockMultiplierSource, type MockMultiplierSourceKind, type MockParamDef, type MockRequestSchema, type MockResponseBody, type MockResponseBodyType, type MockResponseConfig, type MockResponseMultiplier, type MockResponseRule, type MockRuntime, type MockRuntimeEntry, type MockServer, type MockServerSource, type MockValidationKind, type MockValidationRule, type NtlmAuth, type OAuth2AuthCodeAuth, type OAuth2ClientCredentialsAuth, type OAuth2DeviceAuth, type OAuth2ImplicitAuth, type OAuth2PasswordAuth, type OAuth2PkceAuth, type OAuth2TokenState, type PanelId, type PlanRun, REQUEST_AUTH_TYPES, RUN_BODY_PREVIEW_LIMIT, type ReleaseHistory, type ReleaseVersion, type Request, type RequestAuth, type RequestAuthType, type RequestBody, type RequestOverride, type RequestOverridePatch, type RequestRun, type RetiredBranch, type SecretCryptoMeta, type SecretEntry, type SecretIndex, type SecretKeyMeta, type SecretUsage, type SyncSnapshot, type ThemeId, type ValidationResult, type WorkingBranch, type WorkspaceLocal, type WorkspaceSnapshot, type WorkspaceSnapshotLedger, type WorkspaceSnapshotTrigger, type WorkspaceSynced, coerceMockResponseBodyTypeForStatus, defaultAuthFor, envPriorityDisplayName, envPriorityKey, envPriorityRefEqual, formatBytes, generateId, getAllowedMockResponseBodyTypes, makeDefaultMockResponse, makeDefaultMockResponseBody, makeDefaultRequestSchema, normalizeAuth, parseEnvPriorityKey, safeExternalHref, utf8ByteLength, validateAwsRegion, validateEnvVarName, validateHttpHeaderName, validateJsonPath, validateJsonString, validateMockPath, validatePRTitle, validatePlanName, validatePositiveDuration, validateRegex, validateUrl };
+export { type Assertion, type AttachmentRef, type AwsSigV4Auth, type BodyType, type ConnectedRepo, type ContextExtraction, DEFAULT_WORKSPACE_NAME, type DigestAuth, type EnvPriorityRef, type Environment, type EnvironmentVariable, type EnvironmentVariableOverride, type ExecutionPlan, FONT_SIZE_PERCENT_DEFAULT, FONT_SIZE_PERCENT_MAX, FONT_SIZE_PERCENT_MIN, FONT_SIZE_PERCENT_STEP, type Folder, type FolderNode, type FontFamilyId, type FormDataRow, type GitHubSession, type GlobalFileAsset, type GlobalGraphQL, type GlobalSchema, type HawkAuth, type HttpMethod, type JwtBearerAuth, type LinkedSnapshot, type LinkedWorkspace, type LocalAttachmentCacheEntry, MCP_TOOL_NAMES, type McpError, type McpToolName, type MockConditionClause, type MockConditionOp, type MockConditionScope, type MockEndpoint, type MockMultiplierSource, type MockMultiplierSourceKind, type MockParamDef, type MockRequestSchema, type MockResponseBody, type MockResponseBodyType, type MockResponseConfig, type MockResponseMultiplier, type MockResponseRule, type MockRuntime, type MockRuntimeEntry, type MockServer, type MockServerSource, type MockValidationKind, type MockValidationRule, type NtlmAuth, type OAuth2AuthCodeAuth, type OAuth2ClientCredentialsAuth, type OAuth2DeviceAuth, type OAuth2ImplicitAuth, type OAuth2PasswordAuth, type OAuth2PkceAuth, type OAuth2TokenState, type PanelId, type PlanRun, REQUEST_AUTH_TYPES, RUN_BODY_PREVIEW_LIMIT, type ReleaseHistory, type ReleaseVersion, type Request, type RequestAuth, type RequestAuthType, type RequestBody, type RequestOverride, type RequestOverridePatch, type RequestRun, type RetiredBranch, type SecretCryptoMeta, type SecretEntry, type SecretIndex, type SecretKeyMeta, type SecretUsage, type SyncSnapshot, type ThemeId, type ValidationResult, type WorkingBranch, type WorkspaceLocal, type WorkspaceSnapshot, type WorkspaceSnapshotLedger, type WorkspaceSnapshotTrigger, type WorkspaceSynced, coerceMockResponseBodyTypeForStatus, defaultAuthFor, envPriorityDisplayName, envPriorityKey, envPriorityRefEqual, formatBytes, generateId, getAllowedMockResponseBodyTypes, makeDefaultMockResponse, makeDefaultMockResponseBody, makeDefaultRequestSchema, normalizeAuth, parseEnvPriorityKey, safeExternalHref, utf8ByteLength, validateAwsRegion, validateEnvVarName, validateHttpHeaderName, validateJsonPath, validateJsonString, validateMockPath, validatePRTitle, validatePlanName, validatePositiveDuration, validateRegex, validateUrl };

package/dist/index.d.ts

@@ -347,6 +347,7 @@ interface WorkspaceSynced {
     globalAssets: {
         schemas: Record<string, GlobalSchema>;
         graphql: Record<string, GlobalGraphQL>;
+        files?: Record<string, GlobalFileAsset>;
     };
     mockServers: Record<string, MockServer>;
     /**
@@ -485,6 +486,18 @@ interface GlobalGraphQL {
     createdAt: string;
     updatedAt: string;
 }
+interface GlobalFileAsset {
+    id: string;
+    name: string;
+    description?: string;
+    slotId: string;
+    filename: string;
+    size: number;
+    mimeType: string;
+    sha256?: string;
+    createdAt: string;
+    updatedAt: string;
+}
 type RequestAuth = {
     type: 'none';
 } | {
@@ -640,6 +653,7 @@ type FormDataRow = {
     kind: 'file';
     key: string;
     slotId: string | null;
+    globalFileAssetId?: string | null;
     filename?: string;
     size?: number;
     mimeType?: string;
@@ -648,11 +662,33 @@ type FormDataRow = {
 };
 interface AttachmentRef {
     slotId: string | null;
+    globalFileAssetId?: string | null;
     filename?: string;
     size?: number;
     mimeType?: string;
     sha256?: string;
 }
+interface LocalAttachmentCacheEntry {
+    slotId: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    sha256?: string;
+    /**
+     * Local-only path or storage URI where this device can read the bytes for
+     * execution. Browser builds use an IndexedDB URI; CLI runs use an absolute
+     * filesystem path under `.apicircle/attachments/`.
+     */
+    localPath: string;
+    storage: 'indexeddb' | 'filesystem';
+    source: 'workspace' | 'linked-workspace';
+    linkedWorkspaceId?: string;
+    requiredBy: Array<{
+        requestId: string;
+        requestName: string;
+    }>;
+    downloadedAt: string;
+}
 interface Assertion {
     id: string;
     kind: 'status' | 'header' | 'json-path' | 'duration';
@@ -813,6 +849,13 @@ interface WorkspaceLocal {
     retiredBranch: RetiredBranch | null;
     sync: SyncSnapshot;
     linkedCollections: Record<string, LinkedSnapshot>;
+    /**
+     * Local-only attachment cache metadata. The bytes themselves live outside
+     * workspace.json (IndexedDB in the web app, `.apicircle/attachments` for
+     * the CLI). This tells execution where the bytes are available locally and
+     * which request(s) require each file.
+     */
+    attachmentCache?: Record<string, LocalAttachmentCacheEntry>;
     globalContext: Record<string, string>;
     mockRuntime: MockRuntime;
     ui: {
@@ -920,6 +963,13 @@ interface LinkedSnapshot {
     ref: string;
     collections: WorkspaceSynced['collections'];
     environments: WorkspaceSynced['environments'];
+    /**
+     * Source workspace assets referenced by linked requests
+     * (`bodySchemaId` / `graphqlSchemaId`). Cached locally with the linked
+     * collections so linked editors and execution can resolve schema refs
+     * without copying assets into the consumer's synced workspace.
+     */
+    globalAssets?: WorkspaceSynced['globalAssets'];
     /**
      * The source workspace's secret-key registry, cached so the link card
      * can render slot labels (not just raw ids). Optional — older
@@ -1242,4 +1292,4 @@ interface McpError {
 /** Helper: full enumeration of tool names — useful for the docs / config UIs. */
 declare const MCP_TOOL_NAMES: ReadonlyArray<McpToolName>;
 
-export { type Assertion, type AttachmentRef, type AwsSigV4Auth, type BodyType, type ConnectedRepo, type ContextExtraction, DEFAULT_WORKSPACE_NAME, type DigestAuth, type EnvPriorityRef, type Environment, type EnvironmentVariable, type EnvironmentVariableOverride, type ExecutionPlan, FONT_SIZE_PERCENT_DEFAULT, FONT_SIZE_PERCENT_MAX, FONT_SIZE_PERCENT_MIN, FONT_SIZE_PERCENT_STEP, type Folder, type FolderNode, type FontFamilyId, type FormDataRow, type GitHubSession, type GlobalGraphQL, type GlobalSchema, type HawkAuth, type HttpMethod, type JwtBearerAuth, type LinkedSnapshot, type LinkedWorkspace, MCP_TOOL_NAMES, type McpError, type McpToolName, type MockConditionClause, type MockConditionOp, type MockConditionScope, type MockEndpoint, type MockMultiplierSource, type MockMultiplierSourceKind, type MockParamDef, type MockRequestSchema, type MockResponseBody, type MockResponseBodyType, type MockResponseConfig, type MockResponseMultiplier, type MockResponseRule, type MockRuntime, type MockRuntimeEntry, type MockServer, type MockServerSource, type MockValidationKind, type MockValidationRule, type NtlmAuth, type OAuth2AuthCodeAuth, type OAuth2ClientCredentialsAuth, type OAuth2DeviceAuth, type OAuth2ImplicitAuth, type OAuth2PasswordAuth, type OAuth2PkceAuth, type OAuth2TokenState, type PanelId, type PlanRun, REQUEST_AUTH_TYPES, RUN_BODY_PREVIEW_LIMIT, type ReleaseHistory, type ReleaseVersion, type Request, type RequestAuth, type RequestAuthType, type RequestBody, type RequestOverride, type RequestOverridePatch, type RequestRun, type RetiredBranch, type SecretCryptoMeta, type SecretEntry, type SecretIndex, type SecretKeyMeta, type SecretUsage, type SyncSnapshot, type ThemeId, type ValidationResult, type WorkingBranch, type WorkspaceLocal, type WorkspaceSnapshot, type WorkspaceSnapshotLedger, type WorkspaceSnapshotTrigger, type WorkspaceSynced, coerceMockResponseBodyTypeForStatus, defaultAuthFor, envPriorityDisplayName, envPriorityKey, envPriorityRefEqual, formatBytes, generateId, getAllowedMockResponseBodyTypes, makeDefaultMockResponse, makeDefaultMockResponseBody, makeDefaultRequestSchema, normalizeAuth, parseEnvPriorityKey, safeExternalHref, utf8ByteLength, validateAwsRegion, validateEnvVarName, validateHttpHeaderName, validateJsonPath, validateJsonString, validateMockPath, validatePRTitle, validatePlanName, validatePositiveDuration, validateRegex, validateUrl };
+export { type Assertion, type AttachmentRef, type AwsSigV4Auth, type BodyType, type ConnectedRepo, type ContextExtraction, DEFAULT_WORKSPACE_NAME, type DigestAuth, type EnvPriorityRef, type Environment, type EnvironmentVariable, type EnvironmentVariableOverride, type ExecutionPlan, FONT_SIZE_PERCENT_DEFAULT, FONT_SIZE_PERCENT_MAX, FONT_SIZE_PERCENT_MIN, FONT_SIZE_PERCENT_STEP, type Folder, type FolderNode, type FontFamilyId, type FormDataRow, type GitHubSession, type GlobalFileAsset, type GlobalGraphQL, type GlobalSchema, type HawkAuth, type HttpMethod, type JwtBearerAuth, type LinkedSnapshot, type LinkedWorkspace, type LocalAttachmentCacheEntry, MCP_TOOL_NAMES, type McpError, type McpToolName, type MockConditionClause, type MockConditionOp, type MockConditionScope, type MockEndpoint, type MockMultiplierSource, type MockMultiplierSourceKind, type MockParamDef, type MockRequestSchema, type MockResponseBody, type MockResponseBodyType, type MockResponseConfig, type MockResponseMultiplier, type MockResponseRule, type MockRuntime, type MockRuntimeEntry, type MockServer, type MockServerSource, type MockValidationKind, type MockValidationRule, type NtlmAuth, type OAuth2AuthCodeAuth, type OAuth2ClientCredentialsAuth, type OAuth2DeviceAuth, type OAuth2ImplicitAuth, type OAuth2PasswordAuth, type OAuth2PkceAuth, type OAuth2TokenState, type PanelId, type PlanRun, REQUEST_AUTH_TYPES, RUN_BODY_PREVIEW_LIMIT, type ReleaseHistory, type ReleaseVersion, type Request, type RequestAuth, type RequestAuthType, type RequestBody, type RequestOverride, type RequestOverridePatch, type RequestRun, type RetiredBranch, type SecretCryptoMeta, type SecretEntry, type SecretIndex, type SecretKeyMeta, type SecretUsage, type SyncSnapshot, type ThemeId, type ValidationResult, type WorkingBranch, type WorkspaceLocal, type WorkspaceSnapshot, type WorkspaceSnapshotLedger, type WorkspaceSnapshotTrigger, type WorkspaceSynced, coerceMockResponseBodyTypeForStatus, defaultAuthFor, envPriorityDisplayName, envPriorityKey, envPriorityRefEqual, formatBytes, generateId, getAllowedMockResponseBodyTypes, makeDefaultMockResponse, makeDefaultMockResponseBody, makeDefaultRequestSchema, normalizeAuth, parseEnvPriorityKey, safeExternalHref, utf8ByteLength, validateAwsRegion, validateEnvVarName, validateHttpHeaderName, validateJsonPath, validateJsonString, validateMockPath, validatePRTitle, validatePlanName, validatePositiveDuration, validateRegex, validateUrl };