@fourier-labs/harbour-contracts 0.74.0 → 0.76.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/contract-release.json +22 -22
- package/dist/gen-ts/app-integrations-declaration.d.ts +15 -1
- package/dist/gen-ts/contract-release.d.ts +6 -6
- package/dist/gen-ts/contract-release.js +6 -6
- package/dist/gen-ts/data-grant-v2.d.ts +5 -5
- package/dist/gen-ts/integration-execute-input-rules.d.ts +214 -0
- package/dist/gen-ts/integration-execute-input-rules.js +85 -0
- package/dist/gen-ts/integration-execute-request.d.ts +53 -6
- package/dist/gen-ts/integration-execute-result.d.ts +161 -1
- package/dist/gen-ts/integration-operations.d.ts +77 -0
- package/dist/gen-ts/integration-operations.js +99 -0
- package/dist/gen-ts/saas-connection.d.ts +22 -8
- package/gen-ts/app-integrations-declaration.ts +15 -1
- package/gen-ts/contract-release.ts +6 -6
- package/gen-ts/data-grant-v2.ts +15 -4
- package/gen-ts/integration-execute-input-rules.ts +86 -1
- package/gen-ts/integration-execute-request.ts +63 -5
- package/gen-ts/integration-execute-result.ts +161 -1
- package/gen-ts/integration-operations.ts +99 -0
- package/gen-ts/saas-connection.ts +32 -7
- package/package.json +1 -1
- package/schema/app-integrations-declaration.schema.json +233 -2
- package/schema/data-grant-v2.schema.json +4 -4
- package/schema/integration-execute-request.schema.json +529 -4
- package/schema/integration-execute-result.schema.json +542 -1
- package/schema/saas-connection.schema.json +35 -7
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Body of POST /_harbour/integrations/execute (app SDK), forwarded unchanged to the governance development and runtime execute routes. Exactly one declared operation against one declared resource. The identity mode is fixed by the operation for every operation but the declared-mode Slack operations (slack.channel.history, slack.message.post, slack.message.update, slack.message.delete; 0.71.0 widened history), and always enforced from an approved grant; any identity/userId/scope field is rejected by additionalProperties. A declared-mode operation runs as the app (for a post: the IT-approved per-app name from the grant, plus a "Posted by <app> on Isomorph" footer) or as the signed-in person (no name, no footer) — the same input either way — and since 0.55.0 the call names which of the app's approved modes it runs under (`mode`): required when IT approved both modes for the app (MODE_REQUIRED otherwise), optional when it approved one (that one is used), and a named mode without an approved grant is refused (MODE_NOT_GRANTED) rather than served under the other, so approval order never decides what a call does. Per-operation input bounds (0.71.0, ADR 0018): slack.channel.history {limit? 1..100, default 15, cursor?, oldest?, latest?}; slack.message.post {text 1..4000 chars, threadId?, format? plain|mrkdwn} and a required idempotencyKey retained across retries of one explicit Send; slack.message.update {messageId, text, format?}; slack.message.delete {messageId}; slack.dm.send {to 1..8 addresses, text, format?} (app mode only) with a required idempotencyKey; slack.user.lookup {email}; gmail.thread.list {limit? 1..50, default 15, q?, labelIds? default [INBOX], pageToken?}; gmail.thread.read {threadId}; gmail.message.read {messageId}; gmail.attachment.read {messageId, attachmentId}; gmail.message.send {to 1..50 addresses (to+cc+bcc <= 50 in total), cc?, bcc?, subject 1..256 chars, text 1..4000 chars, html? <= 64 KiB, attachments? 1..5 of <= 2 MiB each as base64, replyToMessageId?} and a required idempotencyKey like slack.message.post; warehouse.view.read {columns? 1..32, where? 1..16 filters, groupBy? 1..8 columns, aggregates? 1..16, orderBy? 1..8, limit? 1..1000, default 100} (0.70.0: a plain read names columns, an aggregate read names aggregates and optionally groupBy; the cross-field rules — exactly one of columns or aggregates, groupBy needs aggregates, a filter value that fits its op, orderBy naming a returned column, every named column approved — are enforced by governance, not expressible here; ADR 0017). Each operation's then-block is the one statement of its input rules: propertyNames.enum names the fields it accepts, required the ones it needs, and per-field overrides (maximum, default) narrow the shared property. Codegen derives IntegrationExecuteInputRules and validateIntegrationExecuteInput (gen-ts/integration-execute-input-rules.ts, gen-go/integration_execute_input_rules.go) from exactly these blocks, so the governance execute route, the app SDK and the kit's local check refuse the same request with the same message. Transport limits (not expressible here): request <= 16 KiB except a gmail.message.send carrying attachments (governance sizes that route for the attachment bound), total deadline 10 s.
|
|
2
|
+
* Body of POST /_harbour/integrations/execute (app SDK), forwarded unchanged to the governance development and runtime execute routes. Exactly one declared operation against one declared resource. The identity mode is fixed by the operation for every operation but the declared-mode Slack operations (slack.channel.history, slack.message.post, slack.message.update, slack.message.delete; 0.71.0 widened history), and always enforced from an approved grant; any identity/userId/scope field is rejected by additionalProperties. A declared-mode operation runs as the app (for a post: the IT-approved per-app name from the grant, plus a "Posted by <app> on Isomorph" footer) or as the signed-in person (no name, no footer) — the same input either way — and since 0.55.0 the call names which of the app's approved modes it runs under (`mode`): required when IT approved both modes for the app (MODE_REQUIRED otherwise), optional when it approved one (that one is used), and a named mode without an approved grant is refused (MODE_NOT_GRANTED) rather than served under the other, so approval order never decides what a call does. Per-operation input bounds (0.71.0, ADR 0018): slack.channel.history {limit? 1..100, default 15, cursor?, oldest?, latest?}; slack.message.post {text 1..4000 chars, threadId?, format? plain|mrkdwn} and a required idempotencyKey retained across retries of one explicit Send; slack.message.update {messageId, text, format?}; slack.message.delete {messageId}; slack.dm.send {to 1..8 addresses, text, format?} (app mode only) with a required idempotencyKey; slack.user.lookup {email}; gmail.thread.list {limit? 1..50, default 15, q?, labelIds? default [INBOX], pageToken?}; gmail.thread.read {threadId}; gmail.message.read {messageId}; gmail.attachment.read {messageId, attachmentId}; gmail.message.send {to 1..50 addresses (to+cc+bcc <= 50 in total), cc?, bcc?, subject 1..256 chars, text 1..4000 chars, html? <= 64 KiB, attachments? 1..5 of <= 2 MiB each as base64, replyToMessageId?} and a required idempotencyKey like slack.message.post; warehouse.view.read {columns? 1..32, where? 1..16 filters, groupBy? 1..8 columns, aggregates? 1..16, orderBy? 1..8, limit? 1..1000, default 100} (0.70.0: a plain read names columns, an aggregate read names aggregates and optionally groupBy; the cross-field rules — exactly one of columns or aggregates, groupBy needs aggregates, a filter value that fits its op, orderBy naming a returned column, every named column approved — are enforced by governance, not expressible here; ADR 0017). Basecamp (0.76.0, ADR 0022; every id a string of 1..20 digits, every operation user mode): basecamp.project.list {pageToken?, projectStatus? active|archived} on the fixed `account` alias; on a project alias basecamp.todolist.list {pageToken?}; basecamp.todo.list {todolistId, completed?, pageToken?}; basecamp.todo.create {todolistId, content 1..1000 (the to-do title), description? <= 16384, contentFormat? plain|html, dueOn? YYYY-MM-DD, assigneeIds? 1..20, notify?} with a required idempotencyKey; basecamp.todo.complete {todoId} (idempotent at Basecamp, so no key); basecamp.message.list {pageToken?}; basecamp.message.post {subject 1..256, content 1..65536, contentFormat?} with a required idempotencyKey; basecamp.comment.list {recordingId, pageToken?}; basecamp.comment.post {recordingId, content 1..16384, contentFormat?} with a required idempotencyKey; basecamp.campfire.post {content 1..4000, contentFormat?} with a required idempotencyKey; basecamp.people.list {pageToken?}. `pageToken` is the previous page's `nextPageToken` (a Basecamp page number as digits). Each operation's then-block is the one statement of its input rules: propertyNames.enum names the fields it accepts, required the ones it needs, and per-field overrides (maximum, default) narrow the shared property. Codegen derives IntegrationExecuteInputRules and validateIntegrationExecuteInput (gen-ts/integration-execute-input-rules.ts, gen-go/integration_execute_input_rules.go) from exactly these blocks, so the governance execute route, the app SDK and the kit's local check refuse the same request with the same message. Transport limits (not expressible here): request <= 16 KiB except a gmail.message.send carrying attachments (governance sizes that route for the attachment bound) and a basecamp.message.post (its 64 KiB body; governance allows 80 KiB there), total deadline 10 s.
|
|
3
3
|
*/
|
|
4
4
|
export type IntegrationExecuteRequest = {
|
|
5
5
|
/**
|
|
@@ -7,9 +7,9 @@ export type IntegrationExecuteRequest = {
|
|
|
7
7
|
*/
|
|
8
8
|
connection: string;
|
|
9
9
|
/**
|
|
10
|
-
* Closed operation set. Extending it is a contracts change. gmail.message.send (0.50.0) sends one email as the signed-in person: a send like slack.message.post (explicit Send, idempotencyKey, write receipt) under user identity; since 0.71.0 it may carry an HTML body and attachments. slack.message.post (0.53.0) runs in the mode the app declares: app (the company's Slack app, under the IT-approved per-app name) or user (the signed-in person, after their consent); since 0.55.0 each call names which of the approved modes it runs under. 0.71.0 (ADR 0018) adds slack.message.update and slack.message.delete (declared mode, like post), slack.dm.send (app mode: a direct message to 1..8 workspace members named by email), slack.user.lookup (app mode: email to Slack user id), gmail.thread.read (every message of one thread) and gmail.attachment.read (one attachment's bytes), and lets slack.channel.history run in app mode as well as user mode.
|
|
10
|
+
* Closed operation set. Extending it is a contracts change. 0.76.0 (ADR 0022) adds the eleven Basecamp operations, every one user mode only like gmail.*: basecamp.project.list (the projects of the company's pinned Basecamp account; its resource is the fixed `account` alias), and on one mapped project (the resource is a project alias, a key of the connection's `channels` map) basecamp.todolist.list, basecamp.todo.list, basecamp.todo.create (a receipted write: explicit action, idempotencyKey), basecamp.todo.complete (idempotent at Basecamp, no key), basecamp.message.list, basecamp.message.post, basecamp.comment.list, basecamp.comment.post, basecamp.campfire.post (the three posts are receipted writes) and basecamp.people.list. gmail.message.send (0.50.0) sends one email as the signed-in person: a send like slack.message.post (explicit Send, idempotencyKey, write receipt) under user identity; since 0.71.0 it may carry an HTML body and attachments. slack.message.post (0.53.0) runs in the mode the app declares: app (the company's Slack app, under the IT-approved per-app name) or user (the signed-in person, after their consent); since 0.55.0 each call names which of the approved modes it runs under. 0.71.0 (ADR 0018) adds slack.message.update and slack.message.delete (declared mode, like post), slack.dm.send (app mode: a direct message to 1..8 workspace members named by email), slack.user.lookup (app mode: email to Slack user id), gmail.thread.read (every message of one thread) and gmail.attachment.read (one attachment's bytes), and lets slack.channel.history run in app mode as well as user mode.
|
|
11
11
|
*/
|
|
12
|
-
operation: 'slack.channel.history' | 'slack.message.post' | 'slack.message.update' | 'slack.message.delete' | 'slack.dm.send' | 'slack.user.lookup' | 'gmail.thread.list' | 'gmail.thread.read' | 'gmail.message.read' | 'gmail.message.send' | 'gmail.attachment.read' | 'warehouse.view.read' | 'service.request';
|
|
12
|
+
operation: 'slack.channel.history' | 'slack.message.post' | 'slack.message.update' | 'slack.message.delete' | 'slack.dm.send' | 'slack.user.lookup' | 'gmail.thread.list' | 'gmail.thread.read' | 'gmail.message.read' | 'gmail.message.send' | 'gmail.attachment.read' | 'basecamp.project.list' | 'basecamp.todolist.list' | 'basecamp.todo.list' | 'basecamp.todo.create' | 'basecamp.todo.complete' | 'basecamp.message.list' | 'basecamp.message.post' | 'basecamp.comment.list' | 'basecamp.comment.post' | 'basecamp.campfire.post' | 'basecamp.people.list' | 'warehouse.view.read' | 'service.request';
|
|
13
13
|
/**
|
|
14
14
|
* Tenant-wide logical alias of a connection (governance sourceId) or of a resource under it.
|
|
15
15
|
*/
|
|
@@ -63,7 +63,7 @@ export type IntegrationExecuteRequest = {
|
|
|
63
63
|
*/
|
|
64
64
|
labelIds?: string[];
|
|
65
65
|
/**
|
|
66
|
-
* gmail.thread.list (0.71.0): the `nextPageToken` of the previous page; absent reads the first page.
|
|
66
|
+
* gmail.thread.list (0.71.0) and every basecamp.*.list operation (0.76.0): the `nextPageToken` of the previous page; absent reads the first page.
|
|
67
67
|
*/
|
|
68
68
|
pageToken?: string;
|
|
69
69
|
/**
|
|
@@ -74,7 +74,7 @@ export type IntegrationExecuteRequest = {
|
|
|
74
74
|
cc?: EmailAddressList1;
|
|
75
75
|
bcc?: EmailAddressList2;
|
|
76
76
|
/**
|
|
77
|
-
* gmail.message.send: one-line subject (no line breaks).
|
|
77
|
+
* gmail.message.send: one-line subject (no line breaks). basecamp.message.post (0.76.0): the message's title.
|
|
78
78
|
*/
|
|
79
79
|
subject?: string;
|
|
80
80
|
/**
|
|
@@ -92,6 +92,53 @@ export type IntegrationExecuteRequest = {
|
|
|
92
92
|
* @maxItems 5
|
|
93
93
|
*/
|
|
94
94
|
attachments?: EmailAttachment[];
|
|
95
|
+
/**
|
|
96
|
+
* basecamp.todo.list / basecamp.todo.create (0.76.0): the to-do list, as a basecamp.todolist.list result named it.
|
|
97
|
+
*/
|
|
98
|
+
todolistId?: string;
|
|
99
|
+
/**
|
|
100
|
+
* basecamp.todo.complete (0.76.0): the to-do, as a basecamp.todo.list or basecamp.todo.create result named it.
|
|
101
|
+
*/
|
|
102
|
+
todoId?: string;
|
|
103
|
+
/**
|
|
104
|
+
* basecamp.comment.list / basecamp.comment.post (0.76.0): the Basecamp recording commented on — a message, a to-do or any other id a basecamp.* result named.
|
|
105
|
+
*/
|
|
106
|
+
recordingId?: string;
|
|
107
|
+
/**
|
|
108
|
+
* basecamp.todo.create (0.76.0): the to-do's title, 1..1000 characters. basecamp.message.post: the body, at most 64 KiB; basecamp.comment.post: at most 16 KiB; basecamp.campfire.post: at most 4000 characters. Plain text unless `contentFormat` is html.
|
|
109
|
+
*/
|
|
110
|
+
content?: string;
|
|
111
|
+
/**
|
|
112
|
+
* basecamp.todo.create / basecamp.message.post / basecamp.comment.post / basecamp.campfire.post (0.76.0): how `content` (and a to-do's `description`) is read; plain when absent.
|
|
113
|
+
*/
|
|
114
|
+
contentFormat?: 'plain' | 'html';
|
|
115
|
+
/**
|
|
116
|
+
* basecamp.todo.create (0.76.0): the to-do's notes, at most 16 KiB, read the way `contentFormat` says.
|
|
117
|
+
*/
|
|
118
|
+
description?: string;
|
|
119
|
+
/**
|
|
120
|
+
* basecamp.todo.create (0.76.0): the due date as YYYY-MM-DD; absent leaves the to-do undated.
|
|
121
|
+
*/
|
|
122
|
+
dueOn?: string;
|
|
123
|
+
/**
|
|
124
|
+
* basecamp.todo.create (0.76.0): the people assigned, 1..20, by the ids a basecamp.people.list result named.
|
|
125
|
+
*
|
|
126
|
+
* @minItems 1
|
|
127
|
+
* @maxItems 20
|
|
128
|
+
*/
|
|
129
|
+
assigneeIds?: string[];
|
|
130
|
+
/**
|
|
131
|
+
* basecamp.todo.create (0.76.0): whether Basecamp notifies the assignees; false when absent.
|
|
132
|
+
*/
|
|
133
|
+
notify?: boolean;
|
|
134
|
+
/**
|
|
135
|
+
* basecamp.todo.list (0.76.0): true lists the completed to-dos instead of the open ones; absent lists the open ones.
|
|
136
|
+
*/
|
|
137
|
+
completed?: boolean;
|
|
138
|
+
/**
|
|
139
|
+
* basecamp.project.list (0.76.0): which projects to list; active when absent.
|
|
140
|
+
*/
|
|
141
|
+
projectStatus?: 'active' | 'archived';
|
|
95
142
|
/**
|
|
96
143
|
* warehouse.view.read, a plain read: explicit columns, or `*` alone when the app's approved resource grant allows all current and future columns. An aggregate read names aggregates instead.
|
|
97
144
|
*
|
|
@@ -143,7 +190,7 @@ export type IntegrationExecuteRequest = {
|
|
|
143
190
|
};
|
|
144
191
|
};
|
|
145
192
|
/**
|
|
146
|
-
* UUID of one explicit Send action; required for slack.message.post
|
|
193
|
+
* UUID of one explicit Send action; required for the sends (slack.message.post, slack.dm.send, gmail.message.send) and the receipted Basecamp writes (basecamp.todo.create, basecamp.message.post, basecamp.comment.post, basecamp.campfire.post; 0.76.0), refused everywhere else. The same key with the same payload and subject returns the recorded outcome for seven days.
|
|
147
194
|
*/
|
|
148
195
|
idempotencyKey?: string;
|
|
149
196
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The `data` member of a successful execute response `{data, requestId}`; the SDK unwraps `data`. Exactly one of the operation results (
|
|
2
|
+
* The `data` member of a successful execute response `{data, requestId}`; the SDK unwraps `data`. Exactly one of the operation results (twenty-four operations since 0.76.0, ADR 0018 and ADR 0022): slack.channel.history -> {messages, hasMore, nextCursor?} (plain text/IDs/time, plus the display name and emoji icon a per-app-named app post carries — authorName/authorIcon, 0.55.0 — never the provider payload; `nextCursor` when hasMore, to pass as the next read's `cursor`); slack.message.post, slack.message.update, slack.message.delete -> {messageId} (the Slack ts); slack.dm.send -> {messageId, channelId} (the ts and the DM channel it went to); slack.user.lookup -> {userId, displayName}; gmail.thread.list -> {threads, hasMore, nextPageToken?} (newest matching threads; each `messageId` is the thread's newest message, what gmail.message.read takes; `nextPageToken` when hasMore); gmail.thread.read -> {id, emails} (every message of the thread, oldest first, each shaped like a gmail.message.read result); gmail.message.read -> {id, threadId, subject, from, to, date, text, truncated, attachments?} (headers plus the plain text with html stripped, cut at 16 KiB with `truncated` set; `attachments` lists the files without their bytes, which gmail.attachment.read fetches by id); gmail.attachment.read -> {filename, mimeType, size, dataBase64}; gmail.message.send -> {messageId, threadId} (the Gmail ids of the sent message and its thread); warehouse.view.read -> {rows, truncated} (rows keyed by the selected columns, or for an aggregate read by the groupBy columns then the aggregate aliases; decimal/64-bit values as strings, dates as ISO strings; since 0.70.0 every server sends `truncated`, true when more rows matched than `limit` — the server reads limit+1 rows to know — so the rows are incomplete and must not be totalled or averaged; a server before 0.70.0 omitted it). Basecamp (0.76.0, ADR 0022; every id a string of digits, every page at most 100 items, `nextPageToken` only when hasMore, text cut at 16 KiB like Gmail): basecamp.project.list -> {projects, hasMore, nextPageToken?}; basecamp.todolist.list -> {todolists, hasMore, nextPageToken?}; basecamp.todo.list -> {todos, hasMore, nextPageToken?}; basecamp.message.list -> {boardMessages, hasMore, nextPageToken?} (`boardMessages`, not `messages`, which is the Slack history shape); basecamp.comment.list -> {comments, hasMore, nextPageToken?}; basecamp.people.list -> {people, hasMore, nextPageToken?}; basecamp.todo.create, basecamp.message.post, basecamp.comment.post, basecamp.campfire.post -> {id, appUrl} (the new recording and its Basecamp page); basecamp.todo.complete -> {id, completed} with completed always true. An unknown send outcome is never a result; it is an error with details.code SEND_OUTCOME_UNKNOWN. A whole result over 1 MiB is rejected, never cut down to fit — except a gmail.attachment.read, whose single attachment is bounded by its own 2 MiB.
|
|
3
3
|
*/
|
|
4
4
|
export type IntegrationExecuteResult = {
|
|
5
5
|
/**
|
|
@@ -75,6 +75,50 @@ export type IntegrationExecuteResult = {
|
|
|
75
75
|
rows?: {
|
|
76
76
|
[k: string]: unknown;
|
|
77
77
|
}[];
|
|
78
|
+
/**
|
|
79
|
+
* basecamp.project.list (0.76.0): one page of the pinned account's projects the signed-in person can see.
|
|
80
|
+
*
|
|
81
|
+
* @maxItems 100
|
|
82
|
+
*/
|
|
83
|
+
projects?: BasecampProject[];
|
|
84
|
+
/**
|
|
85
|
+
* basecamp.todolist.list (0.76.0): one page of the project's to-do lists.
|
|
86
|
+
*
|
|
87
|
+
* @maxItems 100
|
|
88
|
+
*/
|
|
89
|
+
todolists?: BasecampTodolist[];
|
|
90
|
+
/**
|
|
91
|
+
* basecamp.todo.list (0.76.0): one page of the list's open to-dos, or its completed ones when the read said `completed`.
|
|
92
|
+
*
|
|
93
|
+
* @maxItems 100
|
|
94
|
+
*/
|
|
95
|
+
todos?: BasecampTodo[];
|
|
96
|
+
/**
|
|
97
|
+
* basecamp.message.list (0.76.0): one page of the project's message board, newest first. Named apart from `messages`, the Slack history shape.
|
|
98
|
+
*
|
|
99
|
+
* @maxItems 100
|
|
100
|
+
*/
|
|
101
|
+
boardMessages?: BasecampMessage[];
|
|
102
|
+
/**
|
|
103
|
+
* basecamp.comment.list (0.76.0): one page of the recording's comments, oldest first.
|
|
104
|
+
*
|
|
105
|
+
* @maxItems 100
|
|
106
|
+
*/
|
|
107
|
+
comments?: BasecampComment[];
|
|
108
|
+
/**
|
|
109
|
+
* basecamp.people.list (0.76.0): one page of the people on the project.
|
|
110
|
+
*
|
|
111
|
+
* @maxItems 100
|
|
112
|
+
*/
|
|
113
|
+
people?: BasecampPerson[];
|
|
114
|
+
/**
|
|
115
|
+
* basecamp.todo.create / basecamp.message.post / basecamp.comment.post / basecamp.campfire.post (0.76.0): the Basecamp page of the new recording, for a person to open.
|
|
116
|
+
*/
|
|
117
|
+
appUrl?: string;
|
|
118
|
+
/**
|
|
119
|
+
* basecamp.todo.complete (0.76.0): always true; the to-do is complete whether this call or an earlier one completed it.
|
|
120
|
+
*/
|
|
121
|
+
completed?: boolean;
|
|
78
122
|
status?: number;
|
|
79
123
|
headers?: {
|
|
80
124
|
[k: string]: string;
|
|
@@ -132,3 +176,119 @@ export interface GmailMessage {
|
|
|
132
176
|
*/
|
|
133
177
|
attachments?: GmailAttachment[];
|
|
134
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* One Basecamp project of a basecamp.project.list result (0.76.0). `id` is what IT maps a project alias to on the connection.
|
|
181
|
+
*/
|
|
182
|
+
export interface BasecampProject {
|
|
183
|
+
/**
|
|
184
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
185
|
+
*/
|
|
186
|
+
id: string;
|
|
187
|
+
name: string;
|
|
188
|
+
description?: string;
|
|
189
|
+
appUrl: string;
|
|
190
|
+
/**
|
|
191
|
+
* @maxItems 32
|
|
192
|
+
*/
|
|
193
|
+
tools: BasecampTool[];
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* One enabled tool of a Basecamp project (0.76.0), from its dock: `name` is Basecamp's kind (todoset, message_board, chat, schedule, vault, questionnaire, inbox, kanban_board), `title` what the project calls it.
|
|
197
|
+
*/
|
|
198
|
+
export interface BasecampTool {
|
|
199
|
+
/**
|
|
200
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
201
|
+
*/
|
|
202
|
+
id: string;
|
|
203
|
+
name: string;
|
|
204
|
+
title: string;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* One to-do list of a basecamp.todolist.list result (0.76.0); `id` is what basecamp.todo.list and basecamp.todo.create take as `todolistId`.
|
|
208
|
+
*/
|
|
209
|
+
export interface BasecampTodolist {
|
|
210
|
+
/**
|
|
211
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
212
|
+
*/
|
|
213
|
+
id: string;
|
|
214
|
+
name: string;
|
|
215
|
+
description?: string;
|
|
216
|
+
/**
|
|
217
|
+
* Basecamp's `completed_ratio`, e.g. `3/10`.
|
|
218
|
+
*/
|
|
219
|
+
completedRatio: string;
|
|
220
|
+
appUrl: string;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* One to-do of a basecamp.todo.list result (0.76.0): `content` is its title, `description` its notes as plain text (empty when none), each cut at 16 KiB.
|
|
224
|
+
*/
|
|
225
|
+
export interface BasecampTodo {
|
|
226
|
+
/**
|
|
227
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
228
|
+
*/
|
|
229
|
+
id: string;
|
|
230
|
+
content: string;
|
|
231
|
+
description: string;
|
|
232
|
+
completed: boolean;
|
|
233
|
+
dueOn?: string;
|
|
234
|
+
/**
|
|
235
|
+
* @maxItems 100
|
|
236
|
+
*/
|
|
237
|
+
assignees: BasecampPersonRef[];
|
|
238
|
+
appUrl: string;
|
|
239
|
+
createdAt: string;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* A person named on a Basecamp recording (0.76.0): an author or an assignee.
|
|
243
|
+
*/
|
|
244
|
+
export interface BasecampPersonRef {
|
|
245
|
+
/**
|
|
246
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
247
|
+
*/
|
|
248
|
+
id: string;
|
|
249
|
+
name: string;
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* One message-board post of a basecamp.message.list result (0.76.0); `content` is plain text cut at 16 KiB; `id` is a recordingId for basecamp.comment.list and basecamp.comment.post.
|
|
253
|
+
*/
|
|
254
|
+
export interface BasecampMessage {
|
|
255
|
+
/**
|
|
256
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
257
|
+
*/
|
|
258
|
+
id: string;
|
|
259
|
+
subject: string;
|
|
260
|
+
content: string;
|
|
261
|
+
author: BasecampPersonRef;
|
|
262
|
+
createdAt: string;
|
|
263
|
+
appUrl: string;
|
|
264
|
+
commentsCount: number;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* One comment of a basecamp.comment.list result (0.76.0); `content` is plain text cut at 16 KiB.
|
|
268
|
+
*/
|
|
269
|
+
export interface BasecampComment {
|
|
270
|
+
/**
|
|
271
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
272
|
+
*/
|
|
273
|
+
id: string;
|
|
274
|
+
content: string;
|
|
275
|
+
author: BasecampPersonRef;
|
|
276
|
+
createdAt: string;
|
|
277
|
+
appUrl: string;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* One person of a basecamp.people.list result (0.76.0); `id` is what basecamp.todo.create takes in `assigneeIds`. `email` and `title` when Basecamp shows them.
|
|
281
|
+
*/
|
|
282
|
+
export interface BasecampPerson {
|
|
283
|
+
/**
|
|
284
|
+
* A Basecamp id (0.76.0): an account, project, to-do list, to-do, recording or person, as a string of 1..20 digits — how every basecamp.* result names one and every basecamp.* input takes one back.
|
|
285
|
+
*/
|
|
286
|
+
id: string;
|
|
287
|
+
name: string;
|
|
288
|
+
email?: string;
|
|
289
|
+
title?: string;
|
|
290
|
+
/**
|
|
291
|
+
* Whether the person is an administrator of the Basecamp account.
|
|
292
|
+
*/
|
|
293
|
+
admin: boolean;
|
|
294
|
+
}
|
|
@@ -77,6 +77,83 @@ export declare const IntegrationOperations: {
|
|
|
77
77
|
readonly declaredMode: false;
|
|
78
78
|
readonly idempotencyKey: false;
|
|
79
79
|
};
|
|
80
|
+
readonly "basecamp.project.list": {
|
|
81
|
+
readonly kind: "saas";
|
|
82
|
+
readonly identities: readonly ["user"];
|
|
83
|
+
readonly readOnly: true;
|
|
84
|
+
readonly declaredMode: false;
|
|
85
|
+
readonly idempotencyKey: false;
|
|
86
|
+
};
|
|
87
|
+
readonly "basecamp.todolist.list": {
|
|
88
|
+
readonly kind: "saas";
|
|
89
|
+
readonly identities: readonly ["user"];
|
|
90
|
+
readonly readOnly: true;
|
|
91
|
+
readonly declaredMode: false;
|
|
92
|
+
readonly idempotencyKey: false;
|
|
93
|
+
};
|
|
94
|
+
readonly "basecamp.todo.list": {
|
|
95
|
+
readonly kind: "saas";
|
|
96
|
+
readonly identities: readonly ["user"];
|
|
97
|
+
readonly readOnly: true;
|
|
98
|
+
readonly declaredMode: false;
|
|
99
|
+
readonly idempotencyKey: false;
|
|
100
|
+
};
|
|
101
|
+
readonly "basecamp.todo.create": {
|
|
102
|
+
readonly kind: "saas";
|
|
103
|
+
readonly identities: readonly ["user"];
|
|
104
|
+
readonly readOnly: false;
|
|
105
|
+
readonly declaredMode: false;
|
|
106
|
+
readonly idempotencyKey: true;
|
|
107
|
+
};
|
|
108
|
+
readonly "basecamp.todo.complete": {
|
|
109
|
+
readonly kind: "saas";
|
|
110
|
+
readonly identities: readonly ["user"];
|
|
111
|
+
readonly readOnly: false;
|
|
112
|
+
readonly declaredMode: false;
|
|
113
|
+
readonly idempotencyKey: false;
|
|
114
|
+
};
|
|
115
|
+
readonly "basecamp.message.list": {
|
|
116
|
+
readonly kind: "saas";
|
|
117
|
+
readonly identities: readonly ["user"];
|
|
118
|
+
readonly readOnly: true;
|
|
119
|
+
readonly declaredMode: false;
|
|
120
|
+
readonly idempotencyKey: false;
|
|
121
|
+
};
|
|
122
|
+
readonly "basecamp.message.post": {
|
|
123
|
+
readonly kind: "saas";
|
|
124
|
+
readonly identities: readonly ["user"];
|
|
125
|
+
readonly readOnly: false;
|
|
126
|
+
readonly declaredMode: false;
|
|
127
|
+
readonly idempotencyKey: true;
|
|
128
|
+
};
|
|
129
|
+
readonly "basecamp.comment.list": {
|
|
130
|
+
readonly kind: "saas";
|
|
131
|
+
readonly identities: readonly ["user"];
|
|
132
|
+
readonly readOnly: true;
|
|
133
|
+
readonly declaredMode: false;
|
|
134
|
+
readonly idempotencyKey: false;
|
|
135
|
+
};
|
|
136
|
+
readonly "basecamp.comment.post": {
|
|
137
|
+
readonly kind: "saas";
|
|
138
|
+
readonly identities: readonly ["user"];
|
|
139
|
+
readonly readOnly: false;
|
|
140
|
+
readonly declaredMode: false;
|
|
141
|
+
readonly idempotencyKey: true;
|
|
142
|
+
};
|
|
143
|
+
readonly "basecamp.campfire.post": {
|
|
144
|
+
readonly kind: "saas";
|
|
145
|
+
readonly identities: readonly ["user"];
|
|
146
|
+
readonly readOnly: false;
|
|
147
|
+
readonly declaredMode: false;
|
|
148
|
+
readonly idempotencyKey: true;
|
|
149
|
+
};
|
|
150
|
+
readonly "basecamp.people.list": {
|
|
151
|
+
readonly kind: "saas";
|
|
152
|
+
readonly identities: readonly ["user"];
|
|
153
|
+
readonly readOnly: true;
|
|
154
|
+
readonly declaredMode: false;
|
|
155
|
+
readonly idempotencyKey: false;
|
|
156
|
+
};
|
|
80
157
|
readonly "warehouse.view.read": {
|
|
81
158
|
readonly kind: "database";
|
|
82
159
|
readonly identities: readonly ["app"];
|
|
@@ -105,6 +105,105 @@ export const IntegrationOperations = {
|
|
|
105
105
|
"declaredMode": false,
|
|
106
106
|
"idempotencyKey": false
|
|
107
107
|
},
|
|
108
|
+
"basecamp.project.list": {
|
|
109
|
+
"kind": "saas",
|
|
110
|
+
"identities": [
|
|
111
|
+
"user"
|
|
112
|
+
],
|
|
113
|
+
"readOnly": true,
|
|
114
|
+
"declaredMode": false,
|
|
115
|
+
"idempotencyKey": false
|
|
116
|
+
},
|
|
117
|
+
"basecamp.todolist.list": {
|
|
118
|
+
"kind": "saas",
|
|
119
|
+
"identities": [
|
|
120
|
+
"user"
|
|
121
|
+
],
|
|
122
|
+
"readOnly": true,
|
|
123
|
+
"declaredMode": false,
|
|
124
|
+
"idempotencyKey": false
|
|
125
|
+
},
|
|
126
|
+
"basecamp.todo.list": {
|
|
127
|
+
"kind": "saas",
|
|
128
|
+
"identities": [
|
|
129
|
+
"user"
|
|
130
|
+
],
|
|
131
|
+
"readOnly": true,
|
|
132
|
+
"declaredMode": false,
|
|
133
|
+
"idempotencyKey": false
|
|
134
|
+
},
|
|
135
|
+
"basecamp.todo.create": {
|
|
136
|
+
"kind": "saas",
|
|
137
|
+
"identities": [
|
|
138
|
+
"user"
|
|
139
|
+
],
|
|
140
|
+
"readOnly": false,
|
|
141
|
+
"declaredMode": false,
|
|
142
|
+
"idempotencyKey": true
|
|
143
|
+
},
|
|
144
|
+
"basecamp.todo.complete": {
|
|
145
|
+
"kind": "saas",
|
|
146
|
+
"identities": [
|
|
147
|
+
"user"
|
|
148
|
+
],
|
|
149
|
+
"readOnly": false,
|
|
150
|
+
"declaredMode": false,
|
|
151
|
+
"idempotencyKey": false
|
|
152
|
+
},
|
|
153
|
+
"basecamp.message.list": {
|
|
154
|
+
"kind": "saas",
|
|
155
|
+
"identities": [
|
|
156
|
+
"user"
|
|
157
|
+
],
|
|
158
|
+
"readOnly": true,
|
|
159
|
+
"declaredMode": false,
|
|
160
|
+
"idempotencyKey": false
|
|
161
|
+
},
|
|
162
|
+
"basecamp.message.post": {
|
|
163
|
+
"kind": "saas",
|
|
164
|
+
"identities": [
|
|
165
|
+
"user"
|
|
166
|
+
],
|
|
167
|
+
"readOnly": false,
|
|
168
|
+
"declaredMode": false,
|
|
169
|
+
"idempotencyKey": true
|
|
170
|
+
},
|
|
171
|
+
"basecamp.comment.list": {
|
|
172
|
+
"kind": "saas",
|
|
173
|
+
"identities": [
|
|
174
|
+
"user"
|
|
175
|
+
],
|
|
176
|
+
"readOnly": true,
|
|
177
|
+
"declaredMode": false,
|
|
178
|
+
"idempotencyKey": false
|
|
179
|
+
},
|
|
180
|
+
"basecamp.comment.post": {
|
|
181
|
+
"kind": "saas",
|
|
182
|
+
"identities": [
|
|
183
|
+
"user"
|
|
184
|
+
],
|
|
185
|
+
"readOnly": false,
|
|
186
|
+
"declaredMode": false,
|
|
187
|
+
"idempotencyKey": true
|
|
188
|
+
},
|
|
189
|
+
"basecamp.campfire.post": {
|
|
190
|
+
"kind": "saas",
|
|
191
|
+
"identities": [
|
|
192
|
+
"user"
|
|
193
|
+
],
|
|
194
|
+
"readOnly": false,
|
|
195
|
+
"declaredMode": false,
|
|
196
|
+
"idempotencyKey": true
|
|
197
|
+
},
|
|
198
|
+
"basecamp.people.list": {
|
|
199
|
+
"kind": "saas",
|
|
200
|
+
"identities": [
|
|
201
|
+
"user"
|
|
202
|
+
],
|
|
203
|
+
"readOnly": true,
|
|
204
|
+
"declaredMode": false,
|
|
205
|
+
"idempotencyKey": false
|
|
206
|
+
},
|
|
108
207
|
"warehouse.view.read": {
|
|
109
208
|
"kind": "database",
|
|
110
209
|
"identities": [
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Slack carries an installation and a channel map; Gmail is user-consent only
|
|
2
|
+
* Slack carries an installation and a channel map; Gmail is user-consent only; Basecamp is user-consent only with an IT-pinned account and a project map in `channels`.
|
|
3
3
|
*/
|
|
4
|
-
export type SaasProvider = 'slack' | 'gmail';
|
|
4
|
+
export type SaasProvider = 'slack' | 'gmail' | 'basecamp';
|
|
5
5
|
/**
|
|
6
6
|
* DISABLED stops every app call immediately (details.code CONNECTION_DISABLED).
|
|
7
7
|
*/
|
|
@@ -23,7 +23,7 @@ export type ExternalRecipientMode = 'block' | 'allowlist' | 'allow';
|
|
|
23
23
|
*/
|
|
24
24
|
export type InstallationName = string;
|
|
25
25
|
/**
|
|
26
|
-
* Tenant-wide SaaS connection record (control table sk SAASCONN#<sourceId>, same tenant partition as database sources; alias uniqueness is enforced across both). One connection per tenant and provider: a single bot installation of the platform-owned provider app and a single logical channel map shared by every app environment (grants, requests and user consent links stay per environment). A Gmail connection has neither installation nor channels: user consent is the only step and its one resource is the fixed `inbox` alias. Contains references, never secrets: installation tokens live under their own token records. The pre-T25 per-environment shape (`clientId`, `clientSecretRef`, `environments`, `installations`) is deprecated: the control plane normalises such a stored record on read and never writes it.
|
|
26
|
+
* Tenant-wide SaaS connection record (control table sk SAASCONN#<sourceId>, same tenant partition as database sources; alias uniqueness is enforced across both). One connection per tenant and provider: a single bot installation of the platform-owned provider app and a single logical channel map shared by every app environment (grants, requests and user consent links stay per environment). A Gmail connection has neither installation nor channels: user consent is the only step and its one resource is the fixed `inbox` alias. A Basecamp connection (0.76.0, ADR 0022) has no installation either: IT pins the company's Basecamp `account` (chosen from the accounts IT's own Basecamp sign-in belongs to) and maps project aliases to project ids in `channels`; basecamp.project.list runs on the fixed `account` alias. Contains references, never secrets: installation tokens live under their own token records. The pre-T25 per-environment shape (`clientId`, `clientSecretRef`, `environments`, `installations`) is deprecated: the control plane normalises such a stored record on read and never writes it.
|
|
27
27
|
*/
|
|
28
28
|
export interface SaasConnection {
|
|
29
29
|
schema: 'harbour.saas-connection/1.0';
|
|
@@ -41,22 +41,23 @@ export interface SaasConnection {
|
|
|
41
41
|
*/
|
|
42
42
|
version: number;
|
|
43
43
|
installation?: SaasInstallation;
|
|
44
|
+
account?: BasecampAccount;
|
|
44
45
|
/**
|
|
45
|
-
* Logical
|
|
46
|
+
* Logical alias → provider resource id: a Slack channel id or a Basecamp project id. Always empty for Gmail.
|
|
46
47
|
*/
|
|
47
48
|
channels: {
|
|
48
49
|
/**
|
|
49
|
-
*
|
|
50
|
+
* A Slack channel id (public, non-archived) or a Basecamp project id (digits).
|
|
50
51
|
*/
|
|
51
52
|
[k: string]: string;
|
|
52
53
|
};
|
|
53
54
|
/**
|
|
54
|
-
* Operations IT allows apps to request on this connection: the provider's own SaaS operations (Slack: slack.channel.history, slack.message.post, slack.message.update, slack.message.delete, slack.dm.send, slack.user.lookup; Gmail: gmail.thread.list, gmail.thread.read, gmail.message.read, gmail.message.send, gmail.attachment.read). Never warehouse.view.read.
|
|
55
|
+
* Operations IT allows apps to request on this connection: the provider's own SaaS operations (Slack: slack.channel.history, slack.message.post, slack.message.update, slack.message.delete, slack.dm.send, slack.user.lookup; Gmail: gmail.thread.list, gmail.thread.read, gmail.message.read, gmail.message.send, gmail.attachment.read; Basecamp (0.76.0): basecamp.project.list, basecamp.todolist.list, basecamp.todo.list, basecamp.todo.create, basecamp.todo.complete, basecamp.message.list, basecamp.message.post, basecamp.comment.list, basecamp.comment.post, basecamp.campfire.post, basecamp.people.list). Never warehouse.view.read.
|
|
55
56
|
*
|
|
56
57
|
* @minItems 1
|
|
57
|
-
* @maxItems
|
|
58
|
+
* @maxItems 22
|
|
58
59
|
*/
|
|
59
|
-
operations: ('slack.channel.history' | 'slack.message.post' | 'slack.message.update' | 'slack.message.delete' | 'slack.dm.send' | 'slack.user.lookup' | 'gmail.thread.list' | 'gmail.thread.read' | 'gmail.message.read' | 'gmail.message.send' | 'gmail.attachment.read' | 'warehouse.view.read' | 'service.request')[];
|
|
60
|
+
operations: ('slack.channel.history' | 'slack.message.post' | 'slack.message.update' | 'slack.message.delete' | 'slack.dm.send' | 'slack.user.lookup' | 'gmail.thread.list' | 'gmail.thread.read' | 'gmail.message.read' | 'gmail.message.send' | 'gmail.attachment.read' | 'basecamp.project.list' | 'basecamp.todolist.list' | 'basecamp.todo.list' | 'basecamp.todo.create' | 'basecamp.todo.complete' | 'basecamp.message.list' | 'basecamp.message.post' | 'basecamp.comment.list' | 'basecamp.comment.post' | 'basecamp.campfire.post' | 'basecamp.people.list' | 'warehouse.view.read' | 'service.request')[];
|
|
60
61
|
developmentPreapproval: DevelopmentPreapproval;
|
|
61
62
|
oauthClient?: SaasOauthClient;
|
|
62
63
|
userModeApproval?: UserModeApproval;
|
|
@@ -120,6 +121,19 @@ export interface SaasInstallation {
|
|
|
120
121
|
*/
|
|
121
122
|
botName?: string;
|
|
122
123
|
}
|
|
124
|
+
/**
|
|
125
|
+
* The pinned Basecamp account (0.76.0, Basecamp only): the one account, among those IT's own Basecamp sign-in belongs to, that every user token on this connection must also belong to and that every project id in `channels` lives in. Absent until IT chooses it; governance refuses every basecamp.* call until then.
|
|
126
|
+
*/
|
|
127
|
+
export interface BasecampAccount {
|
|
128
|
+
/**
|
|
129
|
+
* The Basecamp account id, the first path segment of the API base URL.
|
|
130
|
+
*/
|
|
131
|
+
id: string;
|
|
132
|
+
/**
|
|
133
|
+
* The account's name as Basecamp shows it, for IT to recognise.
|
|
134
|
+
*/
|
|
135
|
+
name: string;
|
|
136
|
+
}
|
|
123
137
|
export interface DevelopmentPreapproval {
|
|
124
138
|
/**
|
|
125
139
|
* Auto-approve development requests within the allowlist.
|
|
@@ -16,6 +16,17 @@ export type DeclaredConnection = {
|
|
|
16
16
|
'gmail.message.read'?: UserModeChannelOperation;
|
|
17
17
|
'gmail.message.send'?: UserModeChannelOperation;
|
|
18
18
|
'gmail.attachment.read'?: UserModeChannelOperation;
|
|
19
|
+
'basecamp.project.list'?: UserModeChannelOperation;
|
|
20
|
+
'basecamp.todolist.list'?: UserModeChannelOperation;
|
|
21
|
+
'basecamp.todo.list'?: UserModeChannelOperation;
|
|
22
|
+
'basecamp.todo.create'?: UserModeChannelOperation;
|
|
23
|
+
'basecamp.todo.complete'?: UserModeChannelOperation;
|
|
24
|
+
'basecamp.message.list'?: UserModeChannelOperation;
|
|
25
|
+
'basecamp.message.post'?: UserModeChannelOperation;
|
|
26
|
+
'basecamp.comment.list'?: UserModeChannelOperation;
|
|
27
|
+
'basecamp.comment.post'?: UserModeChannelOperation;
|
|
28
|
+
'basecamp.campfire.post'?: UserModeChannelOperation;
|
|
29
|
+
'basecamp.people.list'?: UserModeChannelOperation;
|
|
19
30
|
'warehouse.view.read'?: AppModeViewOperation;
|
|
20
31
|
'service.request'?: ServiceOperation;
|
|
21
32
|
};
|
|
@@ -40,7 +51,7 @@ export type ResourceNames = IntegrationAlias[];
|
|
|
40
51
|
export type ColumnName = string;
|
|
41
52
|
|
|
42
53
|
/**
|
|
43
|
-
* Committed `.isomorph/integrations.json`: the app's declared use of tenant-wide integration connections. Keys are logical connection aliases (the governance sourceId); resources are logical names (Slack channel alias, warehouse view name), never IDs, tokens or URLs. The operation set is closed (
|
|
54
|
+
* Committed `.isomorph/integrations.json`: the app's declared use of tenant-wide integration connections. Keys are logical connection aliases (the governance sourceId); resources are logical names (Slack channel alias, warehouse view name), never IDs, tokens or URLs. The operation set is closed (twenty-four operations since 0.76.0, ADR 0018 and ADR 0022). Each operation carries a fixed identity mode — slack.dm.send=app, slack.user.lookup=app, every gmail.* operation=user, every basecamp.* operation=user, warehouse.view.read=app, service.request=app — except the declared-mode Slack operations (slack.message.post, and since 0.71.0 slack.channel.history, slack.message.update and slack.message.delete), whose mode the app DECLARES: `app` acts as the company's Slack app (the one audited bot identity; a post goes out under the IT-approved per-app display name when the connection declares `presentation`), `user` acts as the signed-in person after their own consent (reads what they can read, edits what they wrote). The declared mode is the one the app requests access for; an app may hold approved grants for both modes after two requests, and each declared-mode call names which approved mode it runs under (`mode` on the execute request, 0.55.0) — a mode IT did not approve is refused, never swapped for the other. A `saas` connection may declare only the Slack, Gmail and Basecamp operations and a `database` connection only warehouse.view.read; `presentation` is a `saas` connection's optional per-app display name and icon for app-mode Slack posts, shown to IT at approval time and applied only from the approved grant. Gmail is user-mode only (reads, one send); its single resource is the fixed `inbox` alias. Basecamp (0.76.0, ADR 0022) is user-mode only too: basecamp.project.list runs on the fixed `account` alias (the company's pinned Basecamp account) and every other basecamp.* operation on a project alias IT mapped in the connection's `channels` map, so Basecamp itself refuses an id outside that project. slack.dm.send and slack.user.lookup address people by email rather than a channel, so their single resource is the fixed `workspace` alias (the connection's installed workspace), the way Gmail's is `inbox`. This file also owns the shared IntegrationOperation / IntegrationIdentityMode / IntegrationEnvironment / IntegrationConnectionKind / IntegrationPresentation definitions referenced by the other integration schemas.
|
|
44
55
|
*/
|
|
45
56
|
export interface AppIntegrationsDeclaration {
|
|
46
57
|
schema: 'isomorph.app-integrations/2.0';
|
|
@@ -75,6 +86,9 @@ export interface AppModeChannelOperation {
|
|
|
75
86
|
identity: 'app';
|
|
76
87
|
resources: ResourceNames;
|
|
77
88
|
}
|
|
89
|
+
/**
|
|
90
|
+
* Every gmail.* operation (resource: the fixed `inbox` alias) and, since 0.76.0, every basecamp.* operation (resource: a project alias from the connection's `channels` map, or the fixed `account` alias for basecamp.project.list): user mode only — the app acts as the signed-in person after their own consent.
|
|
91
|
+
*/
|
|
78
92
|
export interface UserModeChannelOperation {
|
|
79
93
|
identity: 'user';
|
|
80
94
|
resources: ResourceNames;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// Code generated by tools/gen/gen.mjs from schema/*.json. DO NOT EDIT.
|
|
3
3
|
|
|
4
|
-
export const ContractRepositoryVersion = "0.
|
|
5
|
-
export const ContractPublishVersion = "0.
|
|
6
|
-
export const ContractPublishTag = "v0.
|
|
7
|
-
export const ContractSchemasDigest = "sha256:
|
|
4
|
+
export const ContractRepositoryVersion = "0.76.0.0" as const;
|
|
5
|
+
export const ContractPublishVersion = "0.76.0" as const;
|
|
6
|
+
export const ContractPublishTag = "v0.76.0" as const;
|
|
7
|
+
export const ContractSchemasDigest = "sha256:20ed0df1c63b7aec22d74c3582b1e6c5d36a974005bfe656f03f8f746b371fa7" as const;
|
|
8
8
|
export const ContractAiFixturesDigest = "sha256:edac31c92e146ca1c40130f2fb5649db82e24b8cd1ac758153b90612052fddb6" as const;
|
|
9
|
-
export const ContractGeneratedGoDigest = "sha256:
|
|
10
|
-
export const ContractGeneratedTypeScriptDigest = "sha256:
|
|
9
|
+
export const ContractGeneratedGoDigest = "sha256:db5f27b48a5e6b3706ac0173ebe37ec26deed375be46646b592da35a3aebcce4" as const;
|
|
10
|
+
export const ContractGeneratedTypeScriptDigest = "sha256:9467bd533c557df0b263789b8585f0201abd9f536506ec28400e245be18dae42" as const;
|