@plotday/twister 0.58.0 → 0.60.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/dist/connector.d.ts +42 -2
- package/dist/connector.d.ts.map +1 -1
- package/dist/connector.js +39 -0
- package/dist/connector.js.map +1 -1
- package/dist/docs/assets/hierarchy.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/classes/index.Connector.html +56 -26
- package/dist/docs/classes/index.FileNotFoundError.html +1 -1
- package/dist/docs/classes/index.Files.html +1 -1
- package/dist/docs/classes/index.Imap.html +1 -1
- package/dist/docs/classes/index.Options.html +1 -1
- package/dist/docs/classes/index.Smtp.html +1 -1
- package/dist/docs/classes/tools_ai.AI.html +1 -1
- package/dist/docs/classes/tools_callbacks.Callbacks.html +1 -1
- package/dist/docs/classes/tools_integrations.Integrations.html +1 -1
- package/dist/docs/classes/tools_network.Network.html +1 -1
- package/dist/docs/classes/tools_plot.Plot.html +1 -1
- package/dist/docs/classes/tools_store.Store.html +1 -1
- package/dist/docs/classes/tools_tasks.Tasks.html +1 -1
- package/dist/docs/classes/tools_twists.Twists.html +1 -1
- package/dist/docs/enums/plot.ActorType.html +4 -4
- package/dist/docs/hierarchy.html +1 -1
- package/dist/docs/types/index.ScopeConfig.html +2 -4
- package/dist/docs/types/plot.Actor.html +5 -5
- package/dist/docs/types/plot.Contact.html +4 -4
- package/dist/docs/types/plot.ContentType.html +1 -1
- package/dist/docs/types/plot.Link.html +17 -17
- package/dist/docs/types/plot.LinkUpdate.html +1 -1
- package/dist/docs/types/plot.NewActor.html +1 -1
- package/dist/docs/types/plot.NewContact.html +1 -1
- package/dist/docs/types/plot.NewLink.html +1 -1
- package/dist/docs/types/plot.NewLinkWithNotes.html +1 -1
- package/dist/docs/types/plot.NewNote.html +1 -1
- package/dist/docs/types/plot.Note.html +4 -1
- package/dist/docs/types/plot.NoteUpdate.html +1 -1
- package/dist/docs/types/plot.PlanOperation.html +1 -1
- package/dist/facets.d.ts +17 -1
- package/dist/facets.d.ts.map +1 -1
- package/dist/llm-docs/connector.d.ts +1 -1
- package/dist/llm-docs/connector.d.ts.map +1 -1
- package/dist/llm-docs/connector.js +1 -1
- package/dist/llm-docs/connector.js.map +1 -1
- package/dist/llm-docs/facets.d.ts +1 -1
- package/dist/llm-docs/facets.d.ts.map +1 -1
- package/dist/llm-docs/facets.js +1 -1
- package/dist/llm-docs/facets.js.map +1 -1
- package/dist/llm-docs/plot.d.ts +1 -1
- package/dist/llm-docs/plot.d.ts.map +1 -1
- package/dist/llm-docs/plot.js +1 -1
- package/dist/llm-docs/plot.js.map +1 -1
- package/dist/plot.d.ts +7 -1
- package/dist/plot.d.ts.map +1 -1
- package/dist/plot.js.map +1 -1
- package/package.json +1 -1
- package/src/connector.ts +42 -2
- package/src/facets.ts +21 -1
- package/src/llm-docs/connector.ts +1 -1
- package/src/llm-docs/facets.ts +1 -1
- package/src/llm-docs/plot.ts +1 -1
- package/src/plot.ts +7 -1
package/dist/connector.d.ts
CHANGED
|
@@ -188,8 +188,6 @@ export type OptionalScopeGroup = {
|
|
|
188
188
|
*/
|
|
189
189
|
export type ScopeConfig = {
|
|
190
190
|
required: string[];
|
|
191
|
-
/** Friendly bullets describing what the always-on (required) access does. */
|
|
192
|
-
description?: string[];
|
|
193
191
|
optional?: OptionalScopeGroup[];
|
|
194
192
|
};
|
|
195
193
|
/**
|
|
@@ -248,6 +246,14 @@ export declare abstract class Connector<TSelf> extends Twist<TSelf> {
|
|
|
248
246
|
/** OAuth scopes to request for this connector — a flat list (all required), or
|
|
249
247
|
* a {@link ScopeConfig} declaring required + optional scope groups. */
|
|
250
248
|
readonly scopes?: string[] | ScopeConfig;
|
|
249
|
+
/**
|
|
250
|
+
* Plain-language bullets describing what access connecting this service
|
|
251
|
+
* grants the user — shown on the connect screen regardless of auth mechanism
|
|
252
|
+
* (OAuth, API key, or hosted). For OAuth connectors it also previews what the
|
|
253
|
+
* provider's consent screen will request. These are justifications for what
|
|
254
|
+
* Plot accesses, not a one-to-one mapping of scope strings.
|
|
255
|
+
*/
|
|
256
|
+
readonly access?: string[];
|
|
251
257
|
/**
|
|
252
258
|
* When true, one credential is shared across all users in the workspace,
|
|
253
259
|
* entered once by the installer. When false (default), each user provides
|
|
@@ -275,6 +281,40 @@ export declare abstract class Connector<TSelf> extends Twist<TSelf> {
|
|
|
275
281
|
* The UI will show channel config inline instead of a channel list.
|
|
276
282
|
*/
|
|
277
283
|
readonly singleChannel?: boolean;
|
|
284
|
+
/**
|
|
285
|
+
* The user-facing noun for this connector's channels — what each
|
|
286
|
+
* {@link Channel} returned by {@link getChannels} actually represents in the
|
|
287
|
+
* external service. Many connectors map "channels" onto a domain concept
|
|
288
|
+
* (folders, projects, calendars, labels, spaces, repositories, …), so the
|
|
289
|
+
* generic word "channel" reads as jargon. Set this and the UI substitutes it
|
|
290
|
+
* everywhere it would otherwise say "channel(s)" — e.g. the per-connection
|
|
291
|
+
* toggle becomes "Sync new folders" / "When a new folder is added, …".
|
|
292
|
+
*
|
|
293
|
+
* Provide lowercase nouns (the UI capitalizes where needed):
|
|
294
|
+
* `{ singular: "folder", plural: "folders" }`. Defaults to
|
|
295
|
+
* `{ singular: "channel", plural: "channels" }` when omitted.
|
|
296
|
+
*/
|
|
297
|
+
readonly channelNoun?: {
|
|
298
|
+
singular: string;
|
|
299
|
+
plural: string;
|
|
300
|
+
};
|
|
301
|
+
/**
|
|
302
|
+
* Whether the per-connection "Sync new channels" preference starts ON for
|
|
303
|
+
* newly added connections of this connector. Defaults to `false` (opt-in).
|
|
304
|
+
*
|
|
305
|
+
* Set `true` for connectors that select **all** of their channels by default
|
|
306
|
+
* (i.e. {@link getChannels} returns no channels marked
|
|
307
|
+
* `enabledByDefault: false`). If syncing every channel is the intended
|
|
308
|
+
* default, then channels discovered later should also sync automatically.
|
|
309
|
+
* Leave `false`/omitted for selective connectors that exclude some channels
|
|
310
|
+
* by default (e.g. Gmail syncs only Inbox/Sent, Google Calendar only
|
|
311
|
+
* owner calendars) — for those, a newly discovered channel is just as
|
|
312
|
+
* uncertain and should wait for the user to opt in.
|
|
313
|
+
*
|
|
314
|
+
* Only affects the **default** for new connections; the user's explicit
|
|
315
|
+
* toggle always wins, and existing connections keep their stored preference.
|
|
316
|
+
*/
|
|
317
|
+
readonly autoEnableNewChannelsByDefault?: boolean;
|
|
278
318
|
/**
|
|
279
319
|
* Registry of link types this connector creates (e.g., issue, event, message).
|
|
280
320
|
* Used for display in the UI (icons, labels, statuses).
|
package/dist/connector.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connector.d.ts","sourceRoot":"","sources":["../src/connector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,gBAAgB,EAAE,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,IAAI,EAAE,MAAM,QAAQ,CAAC;AACrI,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,WAAW,EACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB;IACxB,EAAE,EAAE,IAAI,CAAC;IACT,uCAAuC;IACvC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,8HAA8H;IAC9H,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,EAAE,CAAC;IAClB;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACjC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iDAAiD;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,
|
|
1
|
+
{"version":3,"file":"connector.d.ts","sourceRoot":"","sources":["../src/connector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,gBAAgB,EAAE,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,IAAI,EAAE,MAAM,QAAQ,CAAC;AACrI,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,WAAW,EACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB;IACxB,EAAE,EAAE,IAAI,CAAC;IACT,uCAAuC;IACvC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,8HAA8H;IAC9H,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,EAAE,CAAC;IAClB;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACjC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iDAAiD;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACjC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,8BAAsB,SAAS,CAAC,KAAK,CAAE,SAAQ,KAAK,CAAC,KAAK,CAAC;IACzD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,QAAQ;IAInC,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IAEjC;4EACwE;IACxE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IAEzC;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAI3B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAI5B;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAE5D;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAElD;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAEtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAErD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAIxC;;;;;;;;;;;;;OAaG;IAEH,cAAc,CACZ,IAAI,EAAE,aAAa,GAAG,IAAI,EAC1B,KAAK,EAAE,SAAS,GAAG,IAAI,GACtB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAMzB;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,CAClB,IAAI,EAAE,aAAa,GAAG,IAAI,EAC1B,KAAK,EAAE,SAAS,GAAG,IAAI,GACtB,OAAO,CAAC,OAAO,EAAE,CAAC;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAEjF;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D;;;;;;OAMG;IAEH,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC;;;;;;;;;;;;;;;;;;;;OAoBG;IAEH,YAAY,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAItE;;;;;;;;;;;;;;;OAeG;IAEH,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAAC;IAIvF;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACtB,GAAG,EAAE,MAAM,GACV,OAAO,CACN;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GACvB;QAAE,IAAI,EAAE,cAAc,GAAG,UAAU,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAC7E;IAMD;;;;;;;;;;;;;;OAcG;IAEH,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAI9E;;;;;;;;OAQG;IAEH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IAEH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,OAAO,EAAE;QACP,KAAK,EAAE,KAAK,CAAC;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC,CAAC;QACxD,OAAO,EAAE,KAAK,CAAC;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC,CAAC;QAC1D,OAAO,EAAE,KAAK,CAAC;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC,CAAC;KAC9E,GACA,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;OAUG;IAEH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlG;;;;;;;;;OASG;IAEH,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,qBAAqB,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAInJ;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEH,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7G;;;;;;;;;;;;OAYG;IAEH,QAAQ,CAAC,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,aAAa,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAG1E;AAED,2CAA2C;AAC3C,OAAO,EAAE,SAAS,IAAI,MAAM,EAAE,CAAC"}
|
package/dist/connector.js
CHANGED
|
@@ -56,6 +56,14 @@ export class Connector extends Twist {
|
|
|
56
56
|
/** OAuth scopes to request for this connector — a flat list (all required), or
|
|
57
57
|
* a {@link ScopeConfig} declaring required + optional scope groups. */
|
|
58
58
|
scopes;
|
|
59
|
+
/**
|
|
60
|
+
* Plain-language bullets describing what access connecting this service
|
|
61
|
+
* grants the user — shown on the connect screen regardless of auth mechanism
|
|
62
|
+
* (OAuth, API key, or hosted). For OAuth connectors it also previews what the
|
|
63
|
+
* provider's consent screen will request. These are justifications for what
|
|
64
|
+
* Plot accesses, not a one-to-one mapping of scope strings.
|
|
65
|
+
*/
|
|
66
|
+
access;
|
|
59
67
|
// ---- Auth model ----
|
|
60
68
|
/**
|
|
61
69
|
* When true, one credential is shared across all users in the workspace,
|
|
@@ -85,6 +93,37 @@ export class Connector extends Twist {
|
|
|
85
93
|
* The UI will show channel config inline instead of a channel list.
|
|
86
94
|
*/
|
|
87
95
|
singleChannel;
|
|
96
|
+
/**
|
|
97
|
+
* The user-facing noun for this connector's channels — what each
|
|
98
|
+
* {@link Channel} returned by {@link getChannels} actually represents in the
|
|
99
|
+
* external service. Many connectors map "channels" onto a domain concept
|
|
100
|
+
* (folders, projects, calendars, labels, spaces, repositories, …), so the
|
|
101
|
+
* generic word "channel" reads as jargon. Set this and the UI substitutes it
|
|
102
|
+
* everywhere it would otherwise say "channel(s)" — e.g. the per-connection
|
|
103
|
+
* toggle becomes "Sync new folders" / "When a new folder is added, …".
|
|
104
|
+
*
|
|
105
|
+
* Provide lowercase nouns (the UI capitalizes where needed):
|
|
106
|
+
* `{ singular: "folder", plural: "folders" }`. Defaults to
|
|
107
|
+
* `{ singular: "channel", plural: "channels" }` when omitted.
|
|
108
|
+
*/
|
|
109
|
+
channelNoun;
|
|
110
|
+
/**
|
|
111
|
+
* Whether the per-connection "Sync new channels" preference starts ON for
|
|
112
|
+
* newly added connections of this connector. Defaults to `false` (opt-in).
|
|
113
|
+
*
|
|
114
|
+
* Set `true` for connectors that select **all** of their channels by default
|
|
115
|
+
* (i.e. {@link getChannels} returns no channels marked
|
|
116
|
+
* `enabledByDefault: false`). If syncing every channel is the intended
|
|
117
|
+
* default, then channels discovered later should also sync automatically.
|
|
118
|
+
* Leave `false`/omitted for selective connectors that exclude some channels
|
|
119
|
+
* by default (e.g. Gmail syncs only Inbox/Sent, Google Calendar only
|
|
120
|
+
* owner calendars) — for those, a newly discovered channel is just as
|
|
121
|
+
* uncertain and should wait for the user to opt in.
|
|
122
|
+
*
|
|
123
|
+
* Only affects the **default** for new connections; the user's explicit
|
|
124
|
+
* toggle always wins, and existing connections keep their stored preference.
|
|
125
|
+
*/
|
|
126
|
+
autoEnableNewChannelsByDefault;
|
|
88
127
|
/**
|
|
89
128
|
* Registry of link types this connector creates (e.g., issue, event, message).
|
|
90
129
|
* Used for display in the UI (icons, labels, statuses).
|
package/dist/connector.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connector.js","sourceRoot":"","sources":["../src/connector.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"connector.js","sourceRoot":"","sources":["../src/connector.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AA8LhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,OAAgB,SAAiB,SAAQ,KAAY;IACzD;;;OAGG;IACH,MAAM,CAAU,WAAW,GAAG,IAAI,CAAC;IAEnC,+DAA+D;IAE/D,4DAA4D;IACnD,QAAQ,CAAgB;IAEjC;4EACwE;IAC/D,MAAM,CAA0B;IAEzC;;;;;;OAMG;IACM,MAAM,CAAY;IAE3B,uBAAuB;IAEvB;;;;;;;;;;OAUG;IACM,MAAM,CAAW;IAE1B;;;;;;;OAOG;IACM,SAAS,CAAU;IAE5B,8BAA8B;IAE9B;;;;OAIG;IACM,aAAa,CAAW;IAEjC;;;;;;;;;;;;OAYG;IACM,WAAW,CAAwC;IAE5D;;;;;;;;;;;;;;;OAeG;IACM,8BAA8B,CAAW;IAElD;;;OAGG;IACM,SAAS,CAAoB;IAEtC;;;;;;;;OAQG;IACM,oBAAoB,CAAwB;IAErD;;;;;;OAMG;IACH,MAAM,CAAU,aAAa,CAAW;IAExC,yEAAyE;IAEzE;;;;;;;;;;;;;OAaG;IACH,6DAA6D;IAC7D,cAAc,CACZ,IAA0B,EAC1B,KAAuB;QAEvB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAoFD,wDAAwD;IAExD;;;;;;OAMG;IACH,6DAA6D;IAC7D,aAAa,CAAC,IAAU;QACtB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,6DAA6D;IAC7D,YAAY,CAAC,KAAsB;QACjC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,6DAA6D;IAC7D,aAAa,CAAC,IAAU,EAAE,MAAc;QACtC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,kBAAkB,CACtB,GAAW;QAKX,MAAM,IAAI,KAAK,CACb,0CAA0C,IAAI,CAAC,WAAW,CAAC,IAAI,SAAS,GAAG,GAAG,CAC/E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,6DAA6D;IAC7D,aAAa,CAAC,IAAU,EAAE,MAAc;QACtC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;OAQG;IACH,6DAA6D;IAC7D,YAAY,CAAC,MAAc,EAAE,KAAY,EAAE,MAAe;QACxD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,sDAAsD;IACtD,iBAAiB,CACf,MAAc,EACd,OAIC;QAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IACD,qDAAqD;IAErD;;;;;;;;;;OAUG;IACH,6DAA6D;IAC7D,YAAY,CAAC,MAAc,EAAE,KAAY,EAAE,IAAa,EAAE,OAAwB;QAChF,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACH,6DAA6D;IAC7D,wBAAwB,CAAC,MAAc,EAAE,UAAkB,EAAE,SAAkB,EAAE,MAAoC,EAAE,KAAY;QACjI,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,6DAA6D;IAC7D,qBAAqB,CAAC,IAAU,EAAE,MAAc,EAAE,KAAY,EAAE,KAAa,EAAE,KAAc;QAC3F,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,uBAAuB;IAEvB;;;;;;;;;;;;OAYG;IACH,2EAA2E;IAC3E,QAAQ,CAAC,OAAgD;QACvD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;;AAGH,2CAA2C;AAC3C,OAAO,EAAE,SAAS,IAAI,MAAM,EAAE,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
window.hierarchyData = "
|
|
1
|
+
window.hierarchyData = "eJyVk01LxDAQhv/LnMfY6Wfa2yIIvaiw3kSkdqOWzSZLE1lB9r9LUpWsh0289NA+8z6T6eQTZq2tge6Bco5EjwizeJFitJNWBrpPIHJPNewEdHB/mIwFhO2kNtC5EnifJXQwysEYYS6tA5jH2JvdScDlE3RgzebC1V0sLxDGt0luZqG8vKXHIwLlPLD191rLszatJfPUv2QFYVVkWNUZNlWNvM6wrVqkrCAkqmok4iVSnRdITV4iNbxF4mXhWyxOBpLSYUKDR4SqyP5O2sSizZMfuFkmbhIkdShZ9XHBMLFVHw9uqjoIvhqkfB7GbcIBxh+U/RbFbfzkGL2y4nUelpWNCqeAZmFpXNtWbaC9Efag523cqBaQfRfEPW4TA9Gd1OcvnbfspbbMoQn5dPK31lbPIi4wDmMeTlHwMlznwaQsg3UY83CCIm/DKV1ppcRo9XxOM6mN+GC/aIKkzotAcj1JcfYci8BjCeFNHg6p3w37eLajUqJ5uKvrnU2IdlRCNC/DkdzuoxdvSf8GY4Lj8QsFIR2c"
|