@squidcloud/local-backend 1.0.342 → 1.0.344

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.
Files changed (107) hide show
  1. package/dist/internal-common/src/public-types/ai-agent.public-types.js +5 -1
  2. package/dist/internal-common/src/public-types/ai-agent.public-types.js.map +1 -1
  3. package/dist/internal-common/src/public-types/code-executor.public-types.js.map +1 -1
  4. package/dist/internal-common/src/public-types/communication.public-types.js.map +1 -1
  5. package/dist/internal-common/src/public-types/integration.public-types.js.map +1 -1
  6. package/dist/internal-common/src/public-types/integrations/api.public-types.js.map +1 -1
  7. package/dist/internal-common/src/public-types/metric.public-types.js.map +1 -1
  8. package/dist/internal-common/src/public-types/query.public-types.js.map +1 -1
  9. package/dist/internal-common/src/public-types/socket.public-types.js.map +1 -1
  10. package/dist/internal-common/src/public-types-backend/mutation.public-context.js.map +1 -1
  11. package/dist/internal-common/src/types/ai-agent.types.js +6 -2
  12. package/dist/internal-common/src/types/ai-agent.types.js.map +1 -1
  13. package/dist/internal-common/src/types/file.types.js +3 -0
  14. package/dist/internal-common/src/types/file.types.js.map +1 -0
  15. package/dist/internal-common/src/utils/backend-transforms.js +25 -1
  16. package/dist/internal-common/src/utils/backend-transforms.js.map +1 -1
  17. package/dist/internal-common/src/utils/tsoa-utils.js +1 -1
  18. package/dist/internal-common/src/utils/tsoa-utils.js.map +1 -1
  19. package/dist/local-backend/src/index.js +0 -1
  20. package/dist/local-backend/src/index.js.map +1 -1
  21. package/dist/local-backend/src/local-backend.module.js +0 -2
  22. package/dist/local-backend/src/local-backend.module.js.map +1 -1
  23. package/dist/local-backend/src/local-backend.service.js +3 -10
  24. package/dist/local-backend/src/local-backend.service.js.map +1 -1
  25. package/dist/tsconfig.build.tsbuildinfo +1 -1
  26. package/package.json +2 -3
  27. package/dist/internal-common/src/code-executor.types.d.ts +0 -24
  28. package/dist/internal-common/src/local-dev.types.d.ts +0 -57
  29. package/dist/internal-common/src/metric-name.d.ts +0 -3
  30. package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +0 -267
  31. package/dist/internal-common/src/public-types/api-client.public-types.d.ts +0 -5
  32. package/dist/internal-common/src/public-types/backend.public-types.d.ts +0 -8
  33. package/dist/internal-common/src/public-types/code-executor.public-types.d.ts +0 -15
  34. package/dist/internal-common/src/public-types/communication.public-types.d.ts +0 -11
  35. package/dist/internal-common/src/public-types/context.public-types.d.ts +0 -25
  36. package/dist/internal-common/src/public-types/document.public-types.d.ts +0 -22
  37. package/dist/internal-common/src/public-types/integration.public-types.d.ts +0 -20
  38. package/dist/internal-common/src/public-types/integrations/api.public-types.d.ts +0 -53
  39. package/dist/internal-common/src/public-types/metric.public-types.d.ts +0 -48
  40. package/dist/internal-common/src/public-types/openapi.public-types.d.ts +0 -6
  41. package/dist/internal-common/src/public-types/query.public-types.d.ts +0 -40
  42. package/dist/internal-common/src/public-types/scheduler.public-types.d.ts +0 -18
  43. package/dist/internal-common/src/public-types/schema.public-types.d.ts +0 -23
  44. package/dist/internal-common/src/public-types/secret.public-types.d.ts +0 -17
  45. package/dist/internal-common/src/public-types/socket.public-types.d.ts +0 -2
  46. package/dist/internal-common/src/public-types/typescript.public-types.d.ts +0 -12
  47. package/dist/internal-common/src/public-types-backend/ai-agent.public-context.d.ts +0 -11
  48. package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts +0 -20
  49. package/dist/internal-common/src/public-types-backend/application.public-types.d.ts +0 -89
  50. package/dist/internal-common/src/public-types-backend/bundle-api.public-types.d.ts +0 -81
  51. package/dist/internal-common/src/public-types-backend/bundle-data.public-types.d.ts +0 -15
  52. package/dist/internal-common/src/public-types-backend/distributed-lock.public-context.d.ts +0 -4
  53. package/dist/internal-common/src/public-types-backend/graphql.public-context.d.ts +0 -7
  54. package/dist/internal-common/src/public-types-backend/metric.public-context.d.ts +0 -5
  55. package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts +0 -62
  56. package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts +0 -18
  57. package/dist/internal-common/src/public-types-backend/query.public-context.d.ts +0 -46
  58. package/dist/internal-common/src/public-types-backend/storage.types.d.ts +0 -9
  59. package/dist/internal-common/src/public-types-backend/topic.public-context.d.ts +0 -10
  60. package/dist/internal-common/src/types/ai-agent.types.d.ts +0 -121
  61. package/dist/internal-common/src/types/api.types.d.ts +0 -34
  62. package/dist/internal-common/src/types/application.types.d.ts +0 -83
  63. package/dist/internal-common/src/types/backend-run.types.d.ts +0 -68
  64. package/dist/internal-common/src/types/bundle-data.types.d.ts +0 -92
  65. package/dist/internal-common/src/types/communication.types.d.ts +0 -13
  66. package/dist/internal-common/src/types/connector.types.d.ts +0 -11
  67. package/dist/internal-common/src/types/document.types.d.ts +0 -7
  68. package/dist/internal-common/src/types/integrations/api.types.d.ts +0 -106
  69. package/dist/internal-common/src/types/integrations/auth.types.d.ts +0 -44
  70. package/dist/internal-common/src/types/integrations/database.types.d.ts +0 -172
  71. package/dist/internal-common/src/types/integrations/observability.types.d.ts +0 -21
  72. package/dist/internal-common/src/types/integrations/queue-types.d.ts +0 -25
  73. package/dist/internal-common/src/types/integrations/schemas.d.ts +0 -108
  74. package/dist/internal-common/src/types/integrations/storage-types.d.ts +0 -42
  75. package/dist/internal-common/src/types/logger.types.d.ts +0 -21
  76. package/dist/internal-common/src/types/observability.types.d.ts +0 -64
  77. package/dist/internal-common/src/types/openapi.types.d.ts +0 -26
  78. package/dist/internal-common/src/types/query.types.d.ts +0 -41
  79. package/dist/internal-common/src/types/secret.types.d.ts +0 -60
  80. package/dist/internal-common/src/types/security.types.d.ts +0 -8
  81. package/dist/internal-common/src/types/service.types.d.ts +0 -18
  82. package/dist/internal-common/src/utils/backend-transforms.d.ts +0 -7
  83. package/dist/internal-common/src/utils/global.utils.d.ts +0 -8
  84. package/dist/internal-common/src/utils/http.d.ts +0 -1
  85. package/dist/internal-common/src/utils/metrics.types.d.ts +0 -2
  86. package/dist/internal-common/src/utils/node-utils.d.ts +0 -1
  87. package/dist/internal-common/src/utils/object.d.ts +0 -20
  88. package/dist/internal-common/src/utils/resolve.d.ts +0 -2
  89. package/dist/internal-common/src/utils/serialization.d.ts +0 -5
  90. package/dist/internal-common/src/utils/shell-runner.d.ts +0 -12
  91. package/dist/internal-common/src/utils/squid-code-bundle.utils.d.ts +0 -10
  92. package/dist/internal-common/src/utils/squid-service.utils.d.ts +0 -34
  93. package/dist/internal-common/src/utils/squid.constants.d.ts +0 -1
  94. package/dist/internal-common/src/utils/tsoa-utils.d.ts +0 -10
  95. package/dist/internal-common/src/utils.d.ts +0 -2
  96. package/dist/internal-common/src/websocket.impl.d.ts +0 -22
  97. package/dist/local-backend/src/index.d.ts +0 -7
  98. package/dist/local-backend/src/local-backend-connectors.service.d.ts +0 -6
  99. package/dist/local-backend/src/local-backend-socket.service.d.ts +0 -21
  100. package/dist/local-backend/src/local-backend.app.d.ts +0 -2
  101. package/dist/local-backend/src/local-backend.controller.d.ts +0 -9
  102. package/dist/local-backend/src/local-backend.controller.js +0 -50
  103. package/dist/local-backend/src/local-backend.controller.js.map +0 -1
  104. package/dist/local-backend/src/local-backend.module.d.ts +0 -9
  105. package/dist/local-backend/src/local-backend.service.d.ts +0 -21
  106. package/dist/local-backend/src/local-backend.types.d.ts +0 -1
  107. package/dist/local-backend/src/main.d.ts +0 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/local-backend",
3
- "version": "1.0.342",
3
+ "version": "1.0.344",
4
4
  "description": "",
5
5
  "main": "dist/local-backend/src/index.js",
6
6
  "types": "dist/local-backend/src/index.d.ts",
@@ -15,14 +15,13 @@
15
15
  "license": "UNLICENSED",
16
16
  "scripts": {
17
17
  "build": "nest build && cpy openapi-template.hbs dist/local-backend",
18
- "check-public-types": "tsc -p tsconfig.types.json",
19
18
  "start": "nest start",
20
19
  "start:dev": "nest start --watch",
21
20
  "start:debug": "nest start --debug --watch",
22
21
  "start:prod": "node dist/main",
23
22
  "lint": "eslint",
24
23
  "publish:public": "npm run build && npm publish --access public",
25
- "test:e2e": "cd e2e && node -r tsconfig-paths/register -r ts-node/register local-backend-e2e-test.ts"
24
+ "test:e2e": "node -r tsconfig-paths/register -r ts-node/register ./e2e/local-backend-e2e-test.ts"
26
25
  },
27
26
  "engines": {
28
27
  "node": ">=20.0.0"
@@ -1,24 +0,0 @@
1
- import { ExecuteFunctionAnnotationType, RunConfiguration, RunSecrets } from './types/backend-run.types';
2
- import { Auth, RunContext } from './public-types/context.public-types';
3
- import { ServiceFunctionName } from './public-types/backend.public-types';
4
- export type SingleExecuteFunctionRequest = {
5
- functionName: ServiceFunctionName;
6
- params: Array<any>;
7
- };
8
- export interface Base64EncodedFile {
9
- name: string;
10
- base64Content: string;
11
- mimeType: string;
12
- size: number;
13
- fieldName: string;
14
- encoding?: string;
15
- }
16
- export interface BatchRunConfigurationRequest {
17
- configuration: RunConfiguration;
18
- context: RunContext;
19
- auth: Auth | undefined;
20
- requests: Array<SingleExecuteFunctionRequest>;
21
- base64Files?: Array<Base64EncodedFile>;
22
- secrets: RunSecrets;
23
- executeFunctionAnnotationType: ExecuteFunctionAnnotationType;
24
- }
@@ -1,57 +0,0 @@
1
- import { BatchRunConfigurationRequest } from './code-executor.types';
2
- import { LocalBackendData } from './types/bundle-data.types';
3
- import { AppRunConfiguration, RunSecrets } from './types/backend-run.types';
4
- import { LogLevel } from './types/logger.types';
5
- export type MessageFromDeveloperType = 'bundleData' | 'response';
6
- interface BaseMessageFromDeveloper {
7
- type: MessageFromDeveloperType;
8
- payload?: unknown;
9
- requestId: string;
10
- }
11
- export type MessageFromDeveloper = ResponseMessageFromDeveloper | BundleDataMessageFromDeveloper;
12
- export interface ResponseMessageFromDeveloper extends BaseMessageFromDeveloper {
13
- type: 'response';
14
- payload: any;
15
- }
16
- export interface BundleDataMessageFromDeveloper extends BaseMessageFromDeveloper {
17
- type: 'bundleData';
18
- payload: LocalBackendData;
19
- }
20
- export type MessageToDeveloperType = 'executeFunction' | 'localBackendData' | 'logMessage';
21
- interface BaseMessageToDeveloper {
22
- type: MessageToDeveloperType;
23
- payload: unknown;
24
- requestId: string;
25
- }
26
- export type MessageToDeveloper = ExecuteFunctionMessageToDeveloper | LocalBackendDataMessageToDeveloper | LogMessageToDeveloper;
27
- export interface ExecuteFunctionMessageToDeveloper extends BaseMessageToDeveloper {
28
- type: 'executeFunction';
29
- payload: BatchRunConfigurationRequest;
30
- }
31
- export interface LocalBackendDataMessageToDeveloper extends BaseMessageToDeveloper {
32
- type: 'localBackendData';
33
- payload: {
34
- secrets: RunSecrets;
35
- appConfig: AppRunConfiguration;
36
- };
37
- }
38
- export interface LogMessageToDeveloper extends BaseMessageToDeveloper {
39
- type: 'logMessage';
40
- payload: LogRequest;
41
- }
42
- export declare enum LogType {
43
- ALL = "ALL",
44
- QUERY = "QUERY",
45
- MUTATION = "MUTATION",
46
- AI = "AI",
47
- API = "API",
48
- ERROR = "ERROR"
49
- }
50
- export interface LogRequest {
51
- tag: string;
52
- type: LogType;
53
- timestamp: number;
54
- level: LogLevel;
55
- message: string;
56
- }
57
- export {};
@@ -1,3 +0,0 @@
1
- export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_built_in_db_size", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_acquireLock_count", "squid_releaseLock_count", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time"];
2
- export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
3
- export declare const SQUID_METRIC_NAME_PREFIX = "squid_";
@@ -1,267 +0,0 @@
1
- import { AiAgentId, AiContextId, IntegrationId } from './communication.public-types';
2
- import { IntegrationType } from './integration.public-types';
3
- import { FunctionName, FunctionNameWithContext } from './backend.public-types';
4
- export declare const OPENAI_O1_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini"];
5
- export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini", "o3-mini"];
6
- export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3-mini"];
7
- export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-1.5-pro", "gemini-2.0-flash"];
8
- export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-5-haiku-latest", "claude-3-5-sonnet-latest"];
9
- export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3-mini", "claude-3-5-haiku-latest", "claude-3-5-sonnet-latest", "gemini-1.5-pro", "gemini-2.0-flash"];
10
- export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
11
- export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
12
- export declare const OPENAI_IMAGE_MODEL_NAMES: readonly ["dall-e-3"];
13
- export declare const OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
14
- export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
15
- export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "tts-1", "tts-1-hd"];
16
- export declare const STABLE_DIFFUSION_MODEL_NAMES: readonly ["stable-diffusion-core"];
17
- export declare const FLUX_MODEL_NAMES: readonly ["flux-pro-1.1"];
18
- export declare const AI_IMAGE_MODEL_NAMES: readonly ["dall-e-3", "stable-diffusion-core", "flux-pro-1.1"];
19
- export declare const AI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
20
- export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
21
- export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aac", "flac", "wav", "pcm"];
22
- export type AiChatModelName = (typeof AI_CHAT_MODEL_NAMES)[number];
23
- export type AiEmbeddingsModelName = (typeof AI_EMBEDDINGS_MODEL_NAMES)[number];
24
- export type OpenAiChatModelName = (typeof OPENAI_CHAT_MODEL_NAMES)[number];
25
- export type OpenAiReasoningChatModelName = (typeof OPENAI_REASONING_CHAT_MODEL_NAMES)[number];
26
- export type GeminiChatModelName = (typeof GEMINI_CHAT_MODEL_NAMES)[number];
27
- export type AnthropicChatModelName = (typeof ANTHROPIC_CHAT_MODEL_NAMES)[number];
28
- export type AiImageModelName = (typeof AI_IMAGE_MODEL_NAMES)[number];
29
- export type AiAudioTranscriptionModelName = (typeof AI_AUDIO_TRANSCRIPTION_MODEL_NAMES)[number];
30
- export type AiAudioCreateSpeechModelName = (typeof OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES)[number];
31
- export type AiAudioModelName = (typeof OPENAI_AUDIO_MODEL_NAMES)[number];
32
- export type OpenAiImageModelName = (typeof OPENAI_IMAGE_MODEL_NAMES)[number];
33
- export type OpenAiAudioTranscriptionModelName = (typeof OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES)[number];
34
- export type OpenAiAudioCreateSpeechModelName = (typeof OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES)[number];
35
- export type OpenAiCreateSpeechFormat = (typeof OPEN_AI_CREATE_SPEECH_FORMATS)[number];
36
- export type StableDiffusionModelName = (typeof STABLE_DIFFUSION_MODEL_NAMES)[number];
37
- export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
38
- export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions | FluxOptions;
39
- export type AiAudioTranscribeOptions = WhisperOptions;
40
- export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
41
- export interface BaseAiGenerateImageOptions {
42
- modelName: AiImageModelName;
43
- }
44
- export interface BaseAiAudioTranscribeOptions {
45
- modelName: AiAudioTranscriptionModelName;
46
- }
47
- export interface BaseAiAudioCreateSpeechOptions {
48
- modelName: AiAudioCreateSpeechModelName;
49
- }
50
- export interface DallEOptions extends BaseAiGenerateImageOptions {
51
- modelName: 'dall-e-3';
52
- quality?: 'hd' | 'standard';
53
- size?: '1024x1024' | '1792x1024' | '1024x1792';
54
- numberOfImagesToGenerate?: 1;
55
- }
56
- export interface WhisperOptions extends BaseAiAudioTranscribeOptions {
57
- modelName: 'whisper-1';
58
- responseFormat?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
59
- temperature?: number;
60
- prompt?: string;
61
- }
62
- export interface OpenAiCreateSpeechOptions extends BaseAiAudioCreateSpeechOptions {
63
- modelName: OpenAiAudioCreateSpeechModelName;
64
- voice?: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
65
- responseFormat?: OpenAiCreateSpeechFormat;
66
- speed?: number;
67
- }
68
- export interface FluxOptions extends BaseAiGenerateImageOptions {
69
- modelName: 'flux-pro-1.1';
70
- width?: number;
71
- height?: number;
72
- prompt_upsampling?: boolean;
73
- seed?: number;
74
- safety_tolerance?: number;
75
- }
76
- export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
77
- modelName: 'stable-diffusion-core';
78
- aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '4:5' | '5:4' | '9:16' | '9:21';
79
- negativePrompt?: string;
80
- seed?: number;
81
- stylePreset?: 'analog-film' | 'anime' | 'cinematic' | 'comic-book' | 'digital-art' | 'enhance' | 'fantasy-art' | 'isometric' | 'line-art' | 'low-poly' | 'modeling-compound' | 'neon-punk' | 'origami' | 'photographic' | 'pixel-art' | 'tile-texture';
82
- outputFormat?: 'jpeg' | 'png' | 'webp';
83
- }
84
- export type ApiKeySource = 'user' | 'system';
85
- export type AiAgentResponseFormat = 'text' | 'json_object';
86
- export type AiFileUrlType = 'image';
87
- export interface AiFileUrl {
88
- type: AiFileUrlType;
89
- url: string;
90
- }
91
- export interface AiConnectedIntegrationMetadata {
92
- integrationId: IntegrationId;
93
- integrationType: IntegrationType;
94
- description?: string;
95
- instructions?: string;
96
- }
97
- export interface AiConnectedAgentMetadata {
98
- agentId: AiAgentId;
99
- description: string;
100
- }
101
- export interface AiChatPromptQuotas {
102
- maxAiCallStackSize: number;
103
- }
104
- export interface BaseAiAgentChatOptions {
105
- maxTokens?: number;
106
- chatId?: string;
107
- disableHistory?: boolean;
108
- disableContext?: boolean;
109
- includeReference?: boolean;
110
- responseFormat?: AiAgentResponseFormat;
111
- smoothTyping?: boolean;
112
- agentContext?: Record<string, unknown>;
113
- functions?: Array<FunctionName | FunctionNameWithContext>;
114
- instructions?: string;
115
- contextMetadataFilter?: AiContextMetadataFilter;
116
- voiceOptions?: AiAudioCreateSpeechOptions;
117
- connectedAgents?: Array<AiConnectedAgentMetadata>;
118
- connectedIntegrations?: Array<AiConnectedIntegrationMetadata>;
119
- quotas?: AiChatPromptQuotas;
120
- includeMetadata?: boolean;
121
- temperature?: number;
122
- guardrails?: GuardrailsOptions;
123
- model?: AiChatModelName;
124
- }
125
- export interface GeminiChatOptions extends BaseAiAgentChatOptions {
126
- model?: GeminiChatModelName;
127
- groundingWithWebSearch?: boolean;
128
- }
129
- export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
130
- model?: OpenAiChatModelName;
131
- fileUrls?: Array<AiFileUrl>;
132
- }
133
- export type OpenAiReasoningEffort = 'low' | 'medium' | 'high';
134
- export interface OpenAiReasoningChatOptions extends OpenAiChatOptions {
135
- model?: OpenAiReasoningChatModelName;
136
- reasoningEffort?: OpenAiReasoningEffort;
137
- }
138
- export interface AnthropicChatOptions extends BaseAiAgentChatOptions {
139
- model?: AnthropicChatModelName;
140
- }
141
- export type AiSessionOptions = Partial<{
142
- traceId: string;
143
- clientId: string;
144
- agentId: string;
145
- }>;
146
- export type AiAgentChatOptions<T extends AiChatModelName | undefined = undefined> = T extends undefined ? BaseAiAgentChatOptions | GeminiChatOptions | OpenAiReasoningChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiReasoningChatModelName ? OpenAiReasoningChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : never;
147
- export type AllAiAgentChatOptions = {
148
- [K in keyof BaseAiAgentChatOptions | keyof GeminiChatOptions | keyof OpenAiReasoningChatOptions | keyof OpenAiChatOptions | keyof AnthropicChatOptions]?: (K extends keyof BaseAiAgentChatOptions ? BaseAiAgentChatOptions[K] : never) | (K extends keyof GeminiChatOptions ? GeminiChatOptions[K] : never) | (K extends keyof OpenAiReasoningChatOptions ? OpenAiReasoningChatOptions[K] : never) | (K extends keyof OpenAiChatOptions ? OpenAiChatOptions[K] : never) | (K extends keyof AnthropicChatOptions ? AnthropicChatOptions[K] : never);
149
- };
150
- export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
151
- id: AiAgentId;
152
- createdAt: Date;
153
- updatedAt: Date;
154
- description?: string;
155
- isPublic?: boolean;
156
- auditLog?: boolean;
157
- options: AiAgentChatOptions<T>;
158
- }
159
- export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options'> & {
160
- options?: AiAgentChatOptions;
161
- };
162
- export interface AiObserveStatusOptions {
163
- chatId?: string;
164
- }
165
- export interface AiStatusMessage {
166
- agentId: string;
167
- chatId?: string;
168
- title: string;
169
- tags?: Record<string, any>;
170
- }
171
- export interface AiSearchOptions {
172
- prompt: string;
173
- contextMetadataFilter?: AiContextMetadataFilter;
174
- limit?: number;
175
- }
176
- export interface AiSearchResultChunk {
177
- data: string;
178
- metadata?: AiContextMetadata;
179
- score: number;
180
- }
181
- export interface AiAgentContext {
182
- id: AiContextId;
183
- createdAt: Date;
184
- updatedAt: Date;
185
- agentId: AiAgentId;
186
- type: AiContextType;
187
- title: string;
188
- text: string;
189
- preview: boolean;
190
- sizeBytes: number;
191
- metadata: AiContextMetadata;
192
- }
193
- export type AgentContextRequest = TextContextRequest | FileContextRequest;
194
- interface BaseContextRequest {
195
- contextId: string;
196
- type: AiContextType;
197
- metadata?: AiContextMetadata;
198
- }
199
- export type AiContextType = 'text' | 'file';
200
- export interface TextContextRequest extends BaseContextRequest {
201
- type: 'text';
202
- title: string;
203
- text: string;
204
- }
205
- export interface FileContextRequest extends BaseContextRequest {
206
- type: 'file';
207
- extractImages?: boolean;
208
- minImageWidth?: number;
209
- minImageHeight?: number;
210
- fullPageAsImage?: boolean;
211
- extractionModel?: AiChatModelName;
212
- password?: string;
213
- }
214
- export type AiContextMetadataValue = number | string | boolean | undefined;
215
- export type AiContextMetadataValueArray = AiContextMetadataValue[];
216
- interface AiContextMetadataEqFilter {
217
- $eq: AiContextMetadataValue;
218
- }
219
- interface AiContextMetadataNeFilter {
220
- $ne: AiContextMetadataValue;
221
- }
222
- interface AiContextMetadataGtFilter {
223
- $gt: number;
224
- }
225
- interface AiContextMetadataGteFilter {
226
- $gte: number;
227
- }
228
- interface AiContextMetadataLtFilter {
229
- $lt: number;
230
- }
231
- interface AiContextMetadataLteFilter {
232
- $lte: number;
233
- }
234
- interface AiContextMetadataInFilter {
235
- $in: AiContextMetadataValueArray;
236
- }
237
- interface AiContextMetadataNinFilter {
238
- $nin: AiContextMetadataValueArray;
239
- }
240
- interface AiContextMetadataExistsFilter {
241
- $exists: boolean;
242
- }
243
- export type AiContextMetadataSimpleFilter = AiContextMetadataEqFilter | AiContextMetadataNeFilter | AiContextMetadataGtFilter | AiContextMetadataGteFilter | AiContextMetadataLtFilter | AiContextMetadataLteFilter | AiContextMetadataInFilter | AiContextMetadataNinFilter | AiContextMetadataExistsFilter;
244
- export interface AiContextMetadataFieldFilter {
245
- [field: string]: AiContextMetadataSimpleFilter | AiContextMetadataValue;
246
- }
247
- export interface AiContextMetadataAndFilter {
248
- $and: AiContextMetadataFilter[];
249
- }
250
- export interface AiContextMetadataOrFilter {
251
- $or: AiContextMetadataFilter[];
252
- }
253
- export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMetadataAndFilter | AiContextMetadataOrFilter;
254
- export type AiContextMetadata = Record<string, AiContextMetadataValue>;
255
- export type GuardrailKeysType = 'disableProfanity' | 'offTopicAnswers' | 'professionalTone' | 'disablePii';
256
- export type GuardrailsOptions = {
257
- disableProfanity?: boolean;
258
- offTopicAnswers?: boolean;
259
- professionalTone?: boolean;
260
- disablePii?: boolean;
261
- custom?: string;
262
- };
263
- export interface AiTranscribeAndAskResponse {
264
- responseString: string;
265
- transcribedPrompt: string;
266
- }
267
- export {};
@@ -1,5 +0,0 @@
1
- export interface ApiOptions {
2
- headers?: Record<string, string | number | boolean>;
3
- queryParams?: Record<string, string | number | boolean>;
4
- pathParams?: Record<string, string | number | boolean>;
5
- }
@@ -1,8 +0,0 @@
1
- export type TopicName = string;
2
- export type ServiceName = string;
3
- export type FunctionName = string;
4
- export interface FunctionNameWithContext {
5
- name: FunctionName;
6
- context: Record<string, unknown>;
7
- }
8
- export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;
@@ -1,15 +0,0 @@
1
- export type PlaceholderParamType = 'fileArray' | 'file';
2
- export interface BasePlaceholderParam {
3
- type: PlaceholderParamType;
4
- __squid_placeholder__: true;
5
- }
6
- export interface FileArrayPlaceholderParam extends BasePlaceholderParam {
7
- type: 'fileArray';
8
- fileIndexes: Array<number>;
9
- }
10
- export interface FilePlaceholderParam extends BasePlaceholderParam {
11
- type: 'file';
12
- fileIndex: number;
13
- }
14
- export type PlaceholderParam = FileArrayPlaceholderParam | FilePlaceholderParam;
15
- export declare function isPlaceholderParam(param: unknown): param is PlaceholderParam;
@@ -1,11 +0,0 @@
1
- export type AppId = string;
2
- export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
3
- export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
4
- export type SquidDeveloperId = string;
5
- export type IntegrationId = string;
6
- export type ClientId = string;
7
- export type SquidDocId = string;
8
- export type ClientRequestId = string;
9
- export type AiAgentId = string;
10
- export declare const BUILT_IN_AGENT_ID = "built_in_agent";
11
- export type AiContextId = string;
@@ -1,25 +0,0 @@
1
- import { AppId, ClientId } from './communication.public-types';
2
- export type AuthType = 'Bearer' | 'ApiKey';
3
- export interface AuthWithBearer {
4
- type: 'Bearer';
5
- userId: string;
6
- expiration: number;
7
- attributes: Record<string, any>;
8
- jwt?: string;
9
- }
10
- export interface AuthWithApiKey {
11
- type: 'ApiKey';
12
- apiKey: string;
13
- }
14
- export type Auth = AuthWithBearer | AuthWithApiKey;
15
- export interface AuthToken {
16
- type: AuthType;
17
- token: string;
18
- integrationId?: string;
19
- }
20
- export interface RunContext {
21
- appId: AppId;
22
- clientId?: ClientId;
23
- sourceIp?: string;
24
- headers?: Record<string, any>;
25
- }
@@ -1,22 +0,0 @@
1
- import { IntegrationId } from './communication.public-types';
2
- export type PrimitiveFieldType = string | number | boolean | null | Date;
3
- export type FieldType = PrimitiveFieldType | Array<FieldType> | {
4
- [key: string]: FieldType;
5
- };
6
- export type FieldName<T = any> = string & keyof T;
7
- export type DocId = string;
8
- export type DocIdObj = Record<FieldName, any>;
9
- export type DocIdOrDocIdObj = DocId | DocIdObj;
10
- export type CollectionName = string;
11
- export type DocumentData = Record<FieldName, any | undefined>;
12
- export type DocTimestamp = number;
13
- export interface SquidDocument {
14
- __docId__: DocId;
15
- __ts__: DocTimestamp;
16
- [fieldName: string]: FieldType | undefined;
17
- }
18
- export interface SquidDocIdObj {
19
- collectionName: CollectionName;
20
- docId: DocId;
21
- integrationId: IntegrationId;
22
- }
@@ -1,20 +0,0 @@
1
- import { IntegrationId } from './communication.public-types';
2
- export declare const AI_AGENTS_INTEGRATION_ID = "ai_agents";
3
- export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elastic_enterprise_search", "elastic_observability", "elastic_search", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack"];
4
- export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "mysql", "oracledb", "postgres", "sap_hana", "snowflake"];
5
- export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "descope", "firebase_auth"];
6
- export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];
7
- export declare const HTTP_INTEGRATION_TYPES: readonly ["api", "confluence"];
8
- export type IntegrationType = (typeof INTEGRATION_TYPES)[number];
9
- export declare const INTEGRATION_SCHEMA_TYPES: readonly ["data", "api", "graphql"];
10
- export type IntegrationSchemaType = (typeof INTEGRATION_SCHEMA_TYPES)[number];
11
- export declare const BUILT_IN_DB_INTEGRATION_ID: IntegrationId;
12
- export declare const BUILT_IN_QUEUE_INTEGRATION_ID: IntegrationId;
13
- export declare const BUILT_IN_STORAGE_INTEGRATION_ID: IntegrationId;
14
- export interface IntegrationInfo<ConfigurationType = Record<string, any> | undefined> {
15
- id: IntegrationId;
16
- type: IntegrationType;
17
- creationDate?: Date;
18
- updateDate?: Date;
19
- configuration: ConfigurationType;
20
- }
@@ -1,53 +0,0 @@
1
- import { FieldName } from '../document.public-types';
2
- export type HttpMethod = 'post' | 'get' | 'delete' | 'patch' | 'put';
3
- export type ApiEndpointId = string;
4
- export type ApiParameterLocation = 'query' | 'body' | 'header' | 'path';
5
- export type ApiResponseParameterLocation = 'header' | 'body';
6
- export type ApiInjectionParameterLocation = 'header' | 'query';
7
- export type FieldPath = string;
8
- export type IntegrationApiEndpoints = Record<ApiEndpointId, ApiEndpoint>;
9
- export interface ApiRequestField {
10
- location: ApiParameterLocation;
11
- description?: string;
12
- required?: boolean;
13
- }
14
- export interface CallApiOptions {
15
- nativeResponse?: boolean;
16
- originOverride?: string;
17
- }
18
- export interface NativeApiCallResponse<BodyType = unknown> {
19
- body: BodyType;
20
- headers: Record<string, string>;
21
- status: number;
22
- }
23
- export interface ApiResponseField {
24
- location: ApiResponseParameterLocation;
25
- path?: FieldPath;
26
- description?: string;
27
- }
28
- export declare const API_INJECTION_FIELD_TYPES: readonly ["secret", "regular"];
29
- export type ApiInjectionFieldType = (typeof API_INJECTION_FIELD_TYPES)[number];
30
- export interface ApiInjectionField {
31
- value: string;
32
- type: ApiInjectionFieldType;
33
- location: ApiInjectionParameterLocation;
34
- }
35
- export interface GraphQLConnectionOptions {
36
- baseUrl: string;
37
- injectionSchema?: ApiInjectionSchema;
38
- }
39
- export type ApiInjectionSchema = Record<FieldName, ApiInjectionField>;
40
- export interface OpenApiDiscoveryOptions {
41
- openApiSpecUrl: string;
42
- }
43
- export interface ApiEndpoint {
44
- relativePath: string;
45
- method: HttpMethod;
46
- requestSchema?: Record<FieldName, ApiRequestField>;
47
- responseSchema?: Record<FieldPath, ApiResponseField>;
48
- injectionSchema?: ApiInjectionSchema;
49
- tags?: Array<string>;
50
- description?: string;
51
- bodyMimeType?: string;
52
- isRequestBodyRequired?: boolean;
53
- }
@@ -1,48 +0,0 @@
1
- export declare const SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time"];
2
- export type SquidMetricName = (typeof SQUID_METRIC_NAMES)[number];
3
- export declare const METRIC_FUNCTIONS: readonly ["sum", "max", "min", "average", "median", "p95", "p99", "count"];
4
- export type MetricFunction = (typeof METRIC_FUNCTIONS)[number];
5
- export declare const METRIC_DOMAIN: readonly ["user", "squid"];
6
- export type MetricDomain = (typeof METRIC_DOMAIN)[number];
7
- export declare const METRIC_INTERVAL_ALIGNMENT: readonly ["align-by-start-time", "align-by-end-time"];
8
- export type MetricIntervalAlignment = (typeof METRIC_INTERVAL_ALIGNMENT)[number];
9
- export interface QueryMetricsRequestCommon {
10
- domain: MetricDomain;
11
- periodStartSeconds: number;
12
- periodEndSeconds: number;
13
- pointIntervalSeconds?: number;
14
- pointIntervalAlignment?: MetricIntervalAlignment;
15
- fn: MetricFunction | Array<MetricFunction>;
16
- fillValue?: number | null;
17
- tagFilter?: Record<string, string>;
18
- tagDomains?: Record<string, string[]>;
19
- groupByTags?: string[];
20
- orderByTags?: string[];
21
- noDataBehavior?: 'return-no-result-groups' | 'return-result-group-with-default-values';
22
- }
23
- export interface QueryUserMetricsRequest<NameType extends string = string> extends QueryMetricsRequestCommon {
24
- domain: 'user';
25
- name: NameType;
26
- }
27
- export interface QuerySquidMetricsRequest<NameType extends SquidMetricName = SquidMetricName> extends QueryMetricsRequestCommon {
28
- domain: 'squid';
29
- name: NameType;
30
- }
31
- export type QueryMetricsRequest<NameType extends string = string> = QuerySquidMetricsRequest<NameType extends SquidMetricName ? NameType : SquidMetricName> | QueryUserMetricsRequest<NameType>;
32
- export type QueryMetricsResultPoint = [number, ...(number | null)[]];
33
- export interface QueryMetricsResultGroup {
34
- tagValues: string[];
35
- points: Array<QueryMetricsResultPoint>;
36
- }
37
- export interface QueryMetricsResponseCommon {
38
- resultGroups: Array<QueryMetricsResultGroup>;
39
- }
40
- export interface QueryUserMetricsResponse<NameType extends string = string> extends QueryMetricsResponseCommon {
41
- domain: 'user';
42
- metricName: NameType;
43
- }
44
- export interface QuerySquidMetricsResponse<NameType extends SquidMetricName> extends QueryMetricsResponseCommon {
45
- domain: 'squid';
46
- metricName: NameType;
47
- }
48
- export type QueryMetricsResponse<NameType extends string = string> = Required<QuerySquidMetricsResponse<NameType extends SquidMetricName ? NameType : SquidMetricName> | QueryUserMetricsResponse<NameType>>;
@@ -1,6 +0,0 @@
1
- export interface OpenApiResponse {
2
- headers: Record<string, any>;
3
- body: any;
4
- statusCode: number;
5
- __isOpenApiResponse__: true;
6
- }
@@ -1,40 +0,0 @@
1
- import { CollectionName, DocumentData, FieldName } from './document.public-types';
2
- import { Paths } from './typescript.public-types';
3
- export type Alias = string;
4
- export interface JoinCondition {
5
- leftAlias: Alias;
6
- left: FieldName;
7
- right: FieldName;
8
- isInner: boolean;
9
- }
10
- export type Condition<Doc extends DocumentData = any> = SimpleCondition<Doc> | CompositeCondition<Doc>;
11
- export type Conditions<Doc extends DocumentData = any> = Array<Condition<Doc>>;
12
- export interface SimpleCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>, MyOperator = Operator> {
13
- fieldName: F;
14
- operator: MyOperator;
15
- value: any;
16
- }
17
- export interface CompositeCondition<Doc extends DocumentData = any> {
18
- fields: Array<SimpleCondition<Doc, Paths<Doc>, CompositeConditionOperator>>;
19
- }
20
- type CompositeConditionOperator = '>=' | '<=' | '>' | '<';
21
- export declare const ARRAY_OPERATORS: readonly ["in", "not in", "array_includes_some", "array_includes_all", "array_not_includes"];
22
- export declare const ALL_OPERATORS: readonly ["in", "not in", "array_includes_some", "array_includes_all", "array_not_includes", "==", "!=", ">=", "<=", ">", "<", "like", "not like", "like_cs", "not like_cs"];
23
- export type Operator = (typeof ALL_OPERATORS)[number];
24
- export interface FieldSort<Doc> {
25
- fieldName: FieldName<Doc>;
26
- asc: boolean;
27
- }
28
- export interface Query<Doc extends DocumentData = any> {
29
- collectionName: CollectionName;
30
- integrationId: string;
31
- conditions: Conditions<Doc>;
32
- sortOrder: Array<FieldSort<Doc>>;
33
- limit: number;
34
- limitBy?: {
35
- limit: number;
36
- fields: Array<FieldName<Doc>>;
37
- reverseSort: boolean;
38
- };
39
- }
40
- export {};