@squidcloud/jira-client 1.0.505 → 1.0.507

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.
@@ -422,23 +422,62 @@ export interface IntegrationModelSpec {
422
422
  */
423
423
  export type AiChatModelSelection = AiChatModelName | IntegrationModelSpec;
424
424
  /**
425
- * Lets a routing model pick which of several vendor models answers an `ask` or `chat` request. The routing model
426
- * sees the question, the agent's instructions and a card per candidate (price, tier, reasoning,
427
- * context window) and names the one that should answer; that model then serves the request.
425
+ * How demanding a routing model rated a question: `simple` goes to the first step of the routing ladder, `complex`
426
+ * to the last, `moderate` to the middle one.
427
+ * @category AI
428
+ */
429
+ export type AiModelRoutingLevel = 'simple' | 'moderate' | 'complex';
430
+ /**
431
+ * Lets a routing model pick which model of a ladder answers an `ask` or `chat` request. The routing model rates
432
+ * how demanding the question is, given the agent's instructions, and the ladder step for that rating serves it.
428
433
  * @category AI
429
434
  */
430
435
  export interface AiModelRoutingOptions {
431
- /** The vendor models the routing model chooses from; at least two, no duplicates. */
432
- models: VendorAiChatModelName[];
433
- /** The vendor model that makes the choice. */
436
+ /**
437
+ * The ladder, cheapest first: two or three distinct steps, each a vendor model name or a model with its own effort.
438
+ * Omitted, the platform's fast, medium and capable chat models form the ladder, at low, default and high effort.
439
+ */
440
+ models?: Array<VendorAiChatModelName | AiModelRoutingStep>;
441
+ /** The vendor model that rates the question. */
434
442
  routingModel: VendorAiChatModelName;
435
443
  /**
436
- * How to choose, in plain language: the routing model follows it over its default rule, which
437
- * takes the cheapest candidate that can answer well. Up to 2000 characters. The routing model
438
- * sees each candidate's price, context window and benchmark measurements, so an instruction can
439
- * refer to them ("never pay more than $0.01 per answer", "prefer the model measured on coding").
444
+ * How to rate questions, in plain language: replaces the default rule, which takes the lower of two
445
+ * levels a question sits between. Up to 2000 characters.
446
+ */
447
+ instructions?: string;
448
+ }
449
+ /**
450
+ * One step of a routing ladder. A bare model name in the ladder runs at the request's or agent's effort, else the
451
+ * model's default.
452
+ * @category AI
453
+ */
454
+ export interface AiModelRoutingStep {
455
+ /** The vendor model of the step. */
456
+ model: VendorAiChatModelName;
457
+ /**
458
+ * The effort the step runs at, resolved to a level the model accepts. Overrides the request's and agent's effort.
440
459
  */
460
+ reasoningEffort?: AiReasoningEffort;
461
+ }
462
+ /**
463
+ * Gives the answering model a tool that consults a stronger model mid-turn. The turn stays on its own model, so its
464
+ * prompt cache survives, and the advisor gets only what the answering model passes it.
465
+ * @category AI
466
+ */
467
+ export interface AiAdvisorOptions {
468
+ /** The model that gives the advice. */
469
+ model: AiChatModelSelection;
470
+ /** The effort the advisor runs at. A vendor model runs at the nearest level it accepts. */
471
+ reasoningEffort?: AiReasoningEffort;
472
+ /** Added to the advisor's prompt, to steer what it answers and how. */
441
473
  instructions?: string;
474
+ /** Consultations allowed per turn, 1 to 10. Defaults to 3. */
475
+ maxConsultations?: number;
476
+ /**
477
+ * Lets the advisor call the turn's functions, including ones with side effects, and pays for its tool loop.
478
+ * Defaults to false: the advisor sees only what the answering model passes it.
479
+ */
480
+ shareFunctions?: boolean;
442
481
  }
443
482
  /**
444
483
  * The model of an `ask` or `chat` request: a concrete model, or a set of models a routing model chooses from.
@@ -465,16 +504,18 @@ export type AiChatRequestOptions = Omit<AllAiAgentChatOptions, 'model'> & {
465
504
  * @category AI
466
505
  */
467
506
  export interface AiModelRoutingResult {
468
- /** The model the routing model chose and the request was sent to. A `backupModel` may still have served it. */
469
- model: VendorAiChatModelName;
507
+ /** The ladder model the request was sent to. A `backupModel` may still have served it. */
508
+ model: AiChatModelName;
470
509
  /**
471
- * The reasoning effort the chosen model ran at: the routing model's own pick, or the request's or
472
- * agent's effort resolved to a level the model accepts when one was set. Undefined is the model's default.
510
+ * The reasoning effort the chosen model ran at, resolved to a level the model accepts: the step's own effort,
511
+ * else the request's or agent's, else the platform ladder step's. Undefined is the model's default.
473
512
  */
474
513
  reasoningEffort?: AiReasoningEffort;
475
- /** The model that made the choice. */
514
+ /** The model that rated the question. */
476
515
  routingModel: VendorAiChatModelName;
477
- /** The routing model's one-line justification of the choice. */
516
+ /** How demanding the routing model rated the question. */
517
+ level: AiModelRoutingLevel;
518
+ /** The routing model's one-line justification of the rating. */
478
519
  reason: string;
479
520
  /** Input tokens the routing call consumed. */
480
521
  inputTokens: number;
@@ -608,6 +649,8 @@ export interface BaseAiChatOptions {
608
649
  contextMetadataFilterForKnowledgeBase?: Record<AiKnowledgeBaseId, AiContextMetadataFilter>;
609
650
  /** The options to use for the response in voice. */
610
651
  voiceOptions?: AiAudioCreateSpeechOptions;
652
+ /** A stronger model the answering model can consult mid-turn. Overrides the stored value. */
653
+ advisor?: AiAdvisorOptions;
611
654
  /** List of connected AI agents can be called by the current agent. Overrides the stored value. */
612
655
  connectedAgents?: Array<AiConnectedAgentMetadata>;
613
656
  /** List of connected AI agents can be called by the current agent. Overrides the stored value. */
@@ -1488,6 +1531,11 @@ export type AiSessionContext = {
1488
1531
  * takes precedence over it.
1489
1532
  */
1490
1533
  timeoutMs?: number;
1534
+ /**
1535
+ * The root request's `metricAnnotations`. Nested AI operations (e.g. AI-query stages spawned by a tool
1536
+ * call) report their model usage under them, so it adds up with the agent's own.
1537
+ */
1538
+ metricAnnotations?: Record<string, string>;
1491
1539
  };
1492
1540
  /**
1493
1541
  * API request to delete an AI agent
@@ -46,7 +46,7 @@ export declare const AI_CODE_INTERPRETER_PROVIDER_TYPES: readonly ["openai", "an
46
46
  * Public OpenAI chat model names (active models only).
47
47
  * @category AI
48
48
  */
49
- export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol"];
49
+ export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra"];
50
50
  /**
51
51
  * Public Gemini chat model names (active models only).
52
52
  * @category AI
@@ -61,12 +61,12 @@ export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4.6", "grok-4-1-fast
61
61
  * Public Anthropic chat model names (active models only).
62
62
  * @category AI
63
63
  */
64
- export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5", "claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5"];
64
+ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5"];
65
65
  /**
66
66
  * The supported AI model names.
67
67
  * @category AI
68
68
  */
69
- export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "claude-fable-5", "claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-argon", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
69
+ export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra", "claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-argon", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
70
70
  /** Checks if the given model name is a global AI chat model name. */
71
71
  export declare function isVendorAiChatModelName(modelName: unknown): modelName is VendorAiChatModelName;
72
72
  /**
@@ -357,7 +357,7 @@ export interface AiKnowledgeBaseChatOptions {
357
357
  includeReference?: boolean;
358
358
  /** Include metadata in the context */
359
359
  includeMetadata?: boolean;
360
- /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
360
+ /** Which provider's reranker to use for reranking the context. Defaults to the deployment's default reranker. */
361
361
  rerankProvider?: AiRerankProvider;
362
362
  /**
363
363
  * Minimum reranker relevance score a chunk must reach to stay once at least 10 chunks are already kept.
@@ -682,7 +682,7 @@ export interface AiKnowledgeBaseFileContextRequest extends BaseAiKnowledgeBaseCo
682
682
  * Whether Squid discards the downloadable original once the file is extracted; the extracted text and
683
683
  * images are stored either way. Defaults to false: the original is kept so the user can download it and
684
684
  * Squid can reprocess it. Without it, `querySpreadsheetsWithAi` cannot open a workbook context and a
685
- * reupsert of the context fails, on the sync and the bulk lane alike.
685
+ * reupsert of the context fails, on the sync and the bulk path alike.
686
686
  */
687
687
  discardOriginalFile?: boolean;
688
688
  }
@@ -705,7 +705,7 @@ export declare const BULK_INGESTION_MAX_MULTIPART_FILE_BYTES: number;
705
705
  */
706
706
  export declare const MAX_UPLOAD_FILE_BYTES: number;
707
707
  /**
708
- * Largest OneNote section (`.one`) a knowledge base ingests, on either lane. A section carries its attachments,
708
+ * Largest OneNote section (`.one`) a knowledge base ingests, on either path. A section carries its attachments,
709
709
  * each indexed as a context of its own, so it may exceed {@link MAX_UPLOAD_FILE_BYTES}.
710
710
  * @category AI
711
711
  */
@@ -745,7 +745,7 @@ export interface AiKnowledgeBaseSearchOptions {
745
745
  prompt: string;
746
746
  /** The maximum number of results to return */
747
747
  limit?: number;
748
- /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
748
+ /** Which provider's reranker to use for reranking the context. Defaults to the deployment's default reranker. */
749
749
  rerankProvider?: AiRerankProvider;
750
750
  /**
751
751
  * Minimum reranker relevance score a chunk must reach to stay once at least 10 chunks are already kept.
@@ -1969,8 +1969,8 @@ export interface BulkIngestionContext {
1969
1969
  */
1970
1970
  stagedObjectKey?: string;
1971
1971
  /**
1972
- * The preferred method for extracting data from a file context; mirrors the sync lane's field of the
1973
- * same name, so a caller's choice survives whichever lane a deployment routes the upload through.
1972
+ * The preferred method for extracting data from a file context; mirrors the sync path's field of the
1973
+ * same name, so a caller's choice survives whichever path a deployment routes the upload through.
1974
1974
  */
1975
1975
  preferredExtractionMethod?: DocumentExtractionMethod;
1976
1976
  /**
@@ -2007,7 +2007,7 @@ export interface BulkIngestionContext {
2007
2007
  scopes?: Array<string>;
2008
2008
  }
2009
2009
  /**
2010
- * Request structure for staging contexts through bulk ingestion: a durable, asynchronous lane that
2010
+ * Request structure for staging contexts through bulk ingestion: a durable, asynchronous path that
2011
2011
  * processes contexts through provider batch APIs rather than inline, for high-volume ingestion. Poll
2012
2012
  * {@link BulkIngestionJobStatusResponse} with the returned job id for progress.
2013
2013
  * @category AI
@@ -2063,7 +2063,7 @@ export interface BulkIngestionUpsertContextsResponse {
2063
2063
  * an existing context or accepted earlier in this same call. Absent when nothing was rejected.
2064
2064
  *
2065
2065
  * Same shape and `errorCode: 'DUPLICATE_CONTENT'` the synchronous `upsertContexts` returns, so a caller
2066
- * handles a duplicate identically on both lanes. These contexts are NOT part of the job: they are not
2066
+ * handles a duplicate identically on both paths. These contexts are NOT part of the job: they are not
2067
2067
  * extracted, not staged, and never appear in its per-file statuses.
2068
2068
  *
2069
2069
  * Covers TEXT contexts and MULTIPART file contexts (their bytes are in hand at staging). A file staged
@@ -2197,8 +2197,8 @@ export interface AiKnowledgeBaseFileStatusInfo {
2197
2197
  errorMessage?: string;
2198
2198
  /**
2199
2199
  * Present only when `status` is `'failed'`: the machine-readable failure class, when known. A bulk
2200
- * lane failure reports {@link BulkIngestionFileErrorCode}; a synchronous `upsertContexts` failure
2201
- * reports {@link UpsertContextErrorCode} — the two lanes use distinct, mostly-overlapping codes.
2200
+ * path failure reports {@link BulkIngestionFileErrorCode}; a synchronous `upsertContexts` failure
2201
+ * reports {@link UpsertContextErrorCode} — the two paths use distinct, mostly-overlapping codes.
2202
2202
  */
2203
2203
  errorCode?: BulkIngestionFileErrorCode | UpsertContextErrorCode;
2204
2204
  /** When this status was last recorded; absent when `status` is `'no_record'`. */
@@ -2272,7 +2272,7 @@ export interface BulkIngestionStagingRefusal {
2272
2272
  }
2273
2273
  /**
2274
2274
  * One provider batch created for a bulk-ingestion job, so a caller can tell a job waiting on a
2275
- * submitted provider batch (healthy — the designed cost/latency tradeoff of the batch lane, with
2275
+ * submitted provider batch (healthy — the designed cost/latency tradeoff of the batch route, with
2276
2276
  * turnaround up to 24 hours) from a job that is actually stuck, and see since when.
2277
2277
  * @category AI
2278
2278
  */
@@ -2,6 +2,7 @@ import { AiAgentMemoryOptions, AiChatOptions, AiFileUrl, AiSessionContext } from
2
2
  import { AiChatModelName } from './ai-common.public-types';
3
3
  import { ApiOptions } from './api-client.public-types';
4
4
  import { AiAgentId, IntegrationId } from './communication.public-types';
5
+ import { JobId } from './job.public-types';
5
6
  import { PartialBy } from './typescript.public-types';
6
7
  /** A single output column descriptor in a raw query result file. */
7
8
  export interface AiQueryResultFieldSchema {
@@ -43,6 +44,23 @@ export interface AiQueryOptions {
43
44
  generateQueriesOnly?: boolean;
44
45
  /** Optional AI validation of generated queries. Can be used independently or with generateQueriesOnly. */
45
46
  validateWithAiOptions?: AiQueryValidateWithAiOptions;
47
+ /**
48
+ * The agent ask this query runs for. When set, the query's model usage is reported on the AI chat usage
49
+ * metrics under that ask's tags, so it adds up with the agent's own usage.
50
+ */
51
+ usageAttribution?: AiUsageAttribution;
52
+ }
53
+ /**
54
+ * Identifies the agent ask that AI usage is reported under.
55
+ * @category AI
56
+ */
57
+ export interface AiUsageAttribution {
58
+ /** Job ID of the ask, reported as the `aiJobId` metric tag. */
59
+ jobId: JobId;
60
+ /** ID of the agent that ran the ask, reported as the `aiProfile` metric tag. */
61
+ agentId: AiAgentId;
62
+ /** Metric annotations of the ask, reported as `annotation.<key>` metric tags. */
63
+ metricAnnotations?: Record<string, string>;
46
64
  }
47
65
  /**
48
66
  * Options of a single AI query call: the query options plus a credential the client sends as a request header.
@@ -4,7 +4,7 @@
4
4
  * 'CONNECTOR_PACKAGES_TO_EXCLUDE_FROM_AUTO_SYNC' in ConnectorsService (console-backend).
5
5
  * @category Platform
6
6
  */
7
- export declare const CONNECTOR_IDS: readonly ["bitbucket", "confluence", "connect_companion", "cotomi", "elevenlabs", "openai_voice", "essentials", "freshdesk", "generic_site_ingester", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "outlook", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "twilio", "zendesk"];
7
+ export declare const CONNECTOR_IDS: readonly ["bitbucket", "confluence", "connect_companion", "cotomi", "databricks_genie", "elevenlabs", "openai_voice", "essentials", "freshdesk", "generic_site_ingester", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "outlook", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "twilio", "zendesk"];
8
8
  /**
9
9
  * Unique connector package name.
10
10
  * @category Platform
@@ -300,7 +300,7 @@ export interface ExtractDataFromDocumentResponse {
300
300
  documentMetadata?: DocumentMetadata;
301
301
  /**
302
302
  * Structural information about the sheets when the document is a parseable spreadsheet
303
- * (best-effort). Presence marks the document for the spreadsheet summary-embedding lane.
303
+ * (best-effort). Presence marks the document for spreadsheet summary ingestion.
304
304
  */
305
305
  spreadsheet?: SpreadsheetDocumentInfo;
306
306
  }
@@ -1,10 +1,10 @@
1
1
  import { IntegrationId } from './communication.public-types';
2
2
  /** List of all integration types supported by Squid. */
3
- export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "twilio", "elevenlabs", "openai_voice", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "bedrock_embedding", "sharepoint", "vertex"];
3
+ export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "databricks_genie", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "salesforce_db", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "twilio", "elevenlabs", "openai_voice", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "bedrock_embedding", "sharepoint", "vertex"];
4
4
  /**
5
5
  * @category Database
6
6
  */
7
- export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "dynamodb", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "snowflake", "elasticsearch", "legend"];
7
+ export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "dynamodb", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "snowflake", "elasticsearch", "legend", "salesforce_db"];
8
8
  /**
9
9
  * @category Auth
10
10
  */
@@ -43,6 +43,11 @@ export interface ResolveJobRequest {
43
43
  /** The error message, present when status is 'failed'. */
44
44
  error?: string;
45
45
  }
46
+ /** Represents a request to cancel a running server-executed job. */
47
+ export interface CancelJobRequest {
48
+ /** The unique identifier of the job to cancel. */
49
+ jobId: JobId;
50
+ }
46
51
  /**
47
52
  * Represents a keep-alive request signalling that the client still owns the listed active jobs.
48
53
  */
@@ -72,8 +77,9 @@ export interface AsyncJob<T = any> {
72
77
  * - 'in_progress': The job is currently being processed.
73
78
  * - 'completed': The job has finished successfully.
74
79
  * - 'failed': The job has failed.
80
+ * - 'cancelled': The job was stopped by a cancel request.
75
81
  */
76
- status: 'in_progress' | 'completed' | 'failed';
82
+ status: 'in_progress' | 'completed' | 'failed' | 'cancelled';
77
83
  /**
78
84
  * The result of the job, if available.
79
85
  * This is of type `T` and is optional.
@@ -89,7 +95,14 @@ export interface AsyncJob<T = any> {
89
95
  * failure kind (e.g. `'AI_PROVIDER_ERROR'`) without parsing {@link error}.
90
96
  */
91
97
  errorType?: string;
98
+ /**
99
+ * Whether the job can be stopped with a cancel request. Providers that do not honor the abort
100
+ * signal keep running until their current call ends, so cancellation is not always immediate.
101
+ */
102
+ cancellable?: boolean;
92
103
  }
104
+ /** The {@link JobError.errorType} of an error thrown for a job stopped by a cancel request. */
105
+ export declare const JOB_CANCELLED_ERROR_TYPE = "JOB_CANCELLED";
93
106
  /**
94
107
  * An `Error` carrying a machine-readable {@link errorType}, thrown by `JobClient.awaitJob` when a
95
108
  * failed job's {@link AsyncJob.errorType} is set. Lets a caller branch on the failure kind (e.g.
@@ -1,41 +1,40 @@
1
- import { JSONSchema } from 'json-schema-typed';
2
- type ConvertDeep<T extends JSONSchema> = Exclude<T, boolean> & {
3
- properties?: Record<string, ConvertDeep<JSONSchema>>;
4
- patternProperties?: Record<string, ConvertDeep<JSONSchema>>;
5
- nullable?: boolean;
6
- /**
7
- * The default value will be applied (default to 'empty'):
8
- * 'always' - no matter what the client sent, both on update and insert. In case of readOnly - applies only on insert.
9
- * 'empty' - only if the value of the field is empty (undefined)
10
- * 'updateOrEmpty' - no matter what the client sent, updating the record will use the default value
11
- */
12
- applyDefaultValueOn?: 'always' | 'empty' | 'updateOrEmpty';
1
+ /** The `default` of a field that has the server write the time of the mutation into it. */
2
+ export declare const SERVER_TIMESTAMP_DEFAULT = "__SQUID_SERVER_TIMESTAMP__";
3
+ /**
4
+ * Describes one stored field. A schema says what a collection holds, for Squid and for the AI working
5
+ * with it; it places no rule on a write.
6
+ */
7
+ export interface PropertySchema {
8
+ /** The JSON type of the value, such as `string`, `integer` or `object`. */
9
+ type?: string | Array<string>;
10
+ /** What the field holds, in words. */
11
+ description?: string;
12
+ /** The fields of a nested object. */
13
+ properties?: Record<string, PropertySchema>;
14
+ /** The values of a nested object whose keys are not known up front, by key pattern. */
15
+ patternProperties?: Record<string, PropertySchema>;
16
+ /** The element of an array. */
17
+ items?: PropertySchema;
18
+ /** The nested fields the database holds a value for in every row. */
19
+ required?: Array<string>;
20
+ /** Whether the value is a date. */
13
21
  isDate?: boolean;
22
+ /** Whether the value is JSON. */
14
23
  isJSON?: boolean;
24
+ /** Has the server write the time of the mutation into the field. */
25
+ default?: typeof SERVER_TIMESTAMP_DEFAULT;
15
26
  /**
16
- * Applies to the top level schema, a record in a nested object, or a regular property.
17
- * Basically, whether this property can participate in an insert mutation.
27
+ * When `default` applies (default to 'empty'):
28
+ * 'always' - no matter what the client sent, both on update and insert.
29
+ * 'empty' - only if the value of the field is empty (undefined).
30
+ * 'updateOrEmpty' - no matter what the client sent, updating the record uses the default value.
18
31
  */
19
- insertable?: boolean;
20
- /** Applies to the top level schema or a record in a nested object. */
21
- deletable?: boolean;
22
- };
23
- /** Extended JSON schema for a single property, supporting nested structures and Squid-specific metadata. */
24
- export type PropertySchema = ConvertDeep<JSONSchema>;
25
- /** Extended JSON schema for a top-level property, including database-related metadata. */
26
- export type TopLevelPropertySchema = PropertySchema & {
32
+ applyDefaultValueOn?: 'always' | 'empty' | 'updateOrEmpty';
33
+ }
34
+ /** A field at the top level of a collection, including database-related metadata. */
35
+ export interface TopLevelPropertySchema extends PropertySchema {
27
36
  /** Marks the property as a primary key. */
28
37
  primaryKey?: boolean;
29
- /**
30
- * Whether the property is computed based on other properties or some formula.
31
- * If true, readonly also needs to be true and this field should not be part of an insert statement.
32
- */
33
- isComputed?: boolean;
34
- /**
35
- * Whether the default value generated by the database. CURRENT_DATE is something generated by the database vs
36
- * 'Hello' which is a constant.
37
- */
38
- isDefaultComputed?: boolean;
39
38
  /**
40
39
  * The database data type that is represented by this property. This is often different from the actual property
41
40
  * type, with is a Javascript primitive. For example, for a SMALLINT the dataType would be 'smallint', but the type
@@ -46,7 +45,7 @@ export type TopLevelPropertySchema = PropertySchema & {
46
45
  * This indicates that although the field exists on the db, it should be ignored by squid.
47
46
  */
48
47
  hidden?: boolean;
49
- };
48
+ }
50
49
  /**
51
50
  * Milestoning kind on a Legend/PURE class. Drives `.all()` arity and the date
52
51
  * arguments required when navigating to the class's properties:
@@ -58,20 +57,18 @@ export type TopLevelPropertySchema = PropertySchema & {
58
57
  */
59
58
  export type MilestoningKind = 'business-temporal' | 'processing-temporal' | 'bitemporal';
60
59
  /** Schema for a full collection, allowing partial property definitions with extended metadata. */
61
- export type CollectionSchema = Omit<ConvertDeep<JSONSchema>, 'properties'> & {
60
+ export interface CollectionSchema extends Omit<PropertySchema, 'properties'> {
61
+ /** The fields of the collection. */
62
62
  properties?: Record<string, TopLevelPropertySchema>;
63
63
  /** Legend/PURE only: milestoning stereotype on the class, if any. */
64
64
  milestoning?: MilestoningKind;
65
- };
65
+ }
66
66
  /**
67
67
  * API-boundary view of {@link CollectionSchema} for use in OpenAPI-exposed
68
- * controllers. Decouples the public REST surface from `json-schema-typed`'s
69
- * recursive generic, which tsoa's type resolver cannot walk.
68
+ * controllers.
70
69
  *
71
70
  * The on-the-wire payload is the same as {@link CollectionSchema} — this type
72
- * just describes it as an opaque JSON object for the generated OpenAPI spec
73
- * (which is also what tsoa 5.x emitted for {@link CollectionSchema}: a bare
74
- * `object` with no properties).
71
+ * just describes it as an opaque JSON object for the generated OpenAPI spec.
75
72
  */
76
73
  export interface CollectionSchemaApi {
77
74
  /** JSON Schema `type` keyword (e.g. "object"). */
@@ -82,7 +79,6 @@ export interface CollectionSchemaApi {
82
79
  required?: string[];
83
80
  /** Human-readable description of the collection. */
84
81
  description?: string;
85
- /** Additional JSON Schema / Squid-specific fields are preserved as-is. */
82
+ /** Additional fields are preserved as-is. */
86
83
  [key: string]: unknown;
87
84
  }
88
- export {};
@@ -1,9 +1,9 @@
1
1
  import { IntegrationId } from '../public-types/communication.public-types';
2
2
  /**
3
- * Represents the type of native query request, either relational, elastic or MongoDB.
3
+ * Represents the type of native query request: relational, MongoDB, Elasticsearch, Pure or Salesforce SOQL.
4
4
  * @category Database
5
5
  */
6
- export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure';
6
+ export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure' | 'soql';
7
7
  /**
8
8
  * Base fields shared by all native query contexts.
9
9
  * @category Database
@@ -69,7 +69,19 @@ export interface PureNativeQueryContext extends BaseNativeQueryContext {
69
69
  params: Record<string, any>;
70
70
  }
71
71
  /**
72
- * Union type representing either a relational or MongoDB native query context.
72
+ * Context for executing a Salesforce SOQL query.
73
73
  * @category Database
74
74
  */
75
- export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext;
75
+ export interface SoqlNativeQueryContext extends BaseNativeQueryContext {
76
+ /** Specifies that the query is a Salesforce SOQL query. */
77
+ type: 'soql';
78
+ /** SOQL query string to be executed, with `${name}` placeholders for the parameters. */
79
+ query: string;
80
+ /** Parameters to be bound into the query. */
81
+ params: Record<string, any>;
82
+ }
83
+ /**
84
+ * Union type representing any of the supported native query contexts.
85
+ * @category Database
86
+ */
87
+ export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext | SoqlNativeQueryContext;
@@ -13,6 +13,11 @@ export interface ConnectorPackageMetadata {
13
13
  }
14
14
  /** A file inside a connector package that contains package metadata. */
15
15
  export declare const CONNECTOR_METADATA_JSON_FILE = "connector-metadata.json";
16
+ /**
17
+ * Connectors published with an empty `integrationTypes` list: they are selected by matching
18
+ * their connector ID to an integration type, so the CLI emits no types and core accepts none.
19
+ */
20
+ export declare const CONNECTORS_MATCHED_BY_ID: ReadonlyArray<ConnectorId>;
16
21
  /** Per application app connectors. */
17
22
  export interface ApplicationAppConnectors {
18
23
  appConnectors: Array<ConnectorId>;
@@ -75,3 +80,12 @@ export interface ConnectorSyncFailedItemsPage {
75
80
  /** Pass as the next page's `afterId` to continue. Undefined when this is the last page. */
76
81
  nextAfterId?: string;
77
82
  }
83
+ /**
84
+ * Starts the built-in database collections a connector owns, which schema discovery hides.
85
+ * Never change it: stored connector data lives under names built from it.
86
+ */
87
+ export declare const CONNECTOR_COLLECTION_PREFIX = "__squid_";
88
+ /** Returns the name of a built-in database collection owned by a connector of the given type. */
89
+ export declare function buildConnectorCollectionName(integrationType: IntegrationType, collectionName: string): string;
90
+ /** Returns whether a built-in database collection is owned by a connector. */
91
+ export declare function isConnectorCollectionName(collectionName: string): boolean;
@@ -1,6 +1,6 @@
1
1
  import { IntegrationType } from '../../public-types/integration.public-types';
2
2
  export { isIntegrationDisabled } from '../../public-types/integration.public-types';
3
- /** Returns whether an integration of [type] runs a query with a caller-supplied access token. */
3
+ /** Returns whether an integration of [type] accepts a per-request access token. */
4
4
  export declare function supportsPerRequestAccessToken(type: IntegrationType): boolean;
5
- /** Narrows a config to the integration types that accept a caller-supplied access token. */
6
- export declare function isPerRequestAccessTokenIntegration(integration: IntegrationConfig): integration is IntegrationConfigTypes[(typeof PER_REQUEST_ACCESS_TOKEN_INTEGRATION_TYPES)[number]];
5
+ /** Narrows a database configuration to the driver that accepts per-request access tokens. */
6
+ export declare function isPerRequestAccessTokenIntegration(integration: IntegrationConfig): integration is IntegrationConfigTypes['databricks'];
@@ -1,4 +1,13 @@
1
1
  import { KbVersionRules } from '../../ai/kb-version-rules';
2
+ /** Controls delegated, request-time Microsoft 365 retrieval. */
3
+ export interface MicrosoftGraphLiveConfiguration {
4
+ /** Live mode requires a signed-in user and disables indexing and background sync. */
5
+ mode?: 'indexed' | 'live';
6
+ /** Audience of the incoming Entra access token; defaults to the application client ID. */
7
+ delegatedAudience?: string;
8
+ /** SharePoint site, library, or folder URLs allowed for live search and reads. */
9
+ liveSearchRootUrls?: string[];
10
+ }
2
11
  /** How the SharePoint connector groups versions of one document (`Deck v01 … v05, vF`). */
3
12
  export interface SharePointVersioningConfiguration {
4
13
  /**
@@ -1,20 +1,17 @@
1
1
  import { Condition, DocIdCondition, SimpleCondition } from '../public-types/query.public-types';
2
+ /** Longest LIKE pattern a query may carry, in characters: Core refuses a longer one at intake. */
3
+ export declare const MAX_LIKE_PATTERN_LENGTH = 4096;
4
+ /**
5
+ * Splits a LIKE pattern into tokens with the executor's escape rules: \% , \_ and \\ stand for the literal character
6
+ * and keep their backslash, so they never compare equal to the wildcard tokens. A run of % is one token.
7
+ */
8
+ export declare function tokenizeLikePattern(pattern: string): string[];
2
9
  /**
3
10
  * Whether a LIKE pattern has a backslash before anything but `%`, `_` or another backslash, which is not
4
- * a valid escape. Executors disagree on what it matches: PostgreSQL reads `\d` as `d`, while Mongo and
5
- * the local matcher pass it to a regex as a digit.
11
+ * a valid escape. Executors disagree on what it matches: PostgreSQL reads `\d` as `d`, Mongo passes it to
12
+ * a regex as a digit and the local matcher reads a backslash followed by `d`.
6
13
  */
7
14
  export declare function hasInvalidLikeEscape(pattern: string): boolean;
8
- /**
9
- * Generates the regex pattern, handling special characters as follows:
10
- * - `_` is replaced with a `.`
11
- * - `%` is replaced with `[\s\S]*`.
12
- * - The above characters can be escaped with \, eg. `\_` is replaced with `_` and `\%` with `%`.
13
- * - All special characters in regex (-, /, \, ^, $, *, +, ?, ., (, ), |, [, ], {, }) get escaped with \
14
- *
15
- * Exported for testing purposes.
16
- * */
17
- export declare function replaceSpecialCharacters(input: string): string;
18
15
  /** Returns true if the condition is a 'SimpleCondition' or false otherwise. */
19
16
  export declare function isSimpleCondition(condition: Condition): condition is SimpleCondition;
20
17
  /** Returns true if the condition is a 'DocIdCondition' or false otherwise. */
@@ -13,8 +13,6 @@ export declare function isDateObject(value: unknown): value is Date;
13
13
  /** Sets a value by path, as own properties of the objects on it. Does not support array indexes. */
14
14
  export declare function setInPath(obj: object, path: string, value: unknown, delimiter?: string): void;
15
15
  export declare function deleteInPath(obj: object, path: string, delimiter?: string): void;
16
- export declare function replaceKeyInMap<K, T>(map: Map<K, T | undefined>, a: K, b: K): void;
17
- export declare function replaceKeyInRecord<K extends keyof any, T>(record: Record<K, T>, a: K, b: K): void;
18
16
  export declare function isNil(obj: unknown): obj is null | undefined;
19
17
  export declare function isEqual(a: unknown, b: unknown): boolean;
20
18
  export declare function isEmpty(a: unknown): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/jira-client",
3
- "version": "1.0.505",
3
+ "version": "1.0.507",
4
4
  "description": "Squid Jira Client - SDK for interacting with the Jira connector",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/jira-client/src/index.d.ts",
@@ -22,8 +22,7 @@
22
22
  "author": "",
23
23
  "license": "ISC",
24
24
  "dependencies": {
25
- "assertic": "^1.3.0",
26
- "@squidcloud/client": "^1.0.505"
25
+ "@squidcloud/client": "^1.0.507"
27
26
  },
28
27
  "engines": {
29
28
  "node": ">=20.0.0"