@stackfactor/client-api 1.1.265 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.d.ts +41 -8
  2. package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.d.ts.map +1 -1
  3. package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.js +48 -10
  4. package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.js.map +1 -1
  5. package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.d.ts +41 -8
  6. package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.d.ts.map +1 -1
  7. package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.js +48 -10
  8. package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.js.map +1 -1
  9. package/package.json +1 -1
package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.d.ts CHANGED
@@ -74,16 +74,26 @@ export declare const getConfiguration: (connectionId: string, authToken: string)
74
74
  * single-use `state` the backend minted for this attempt. This STARTS the flow.
75
75
  *
76
76
  * The connector decides WHICH scheme applies, which is why the caller asks rather
77
- * than tells. But the caller must supply `redirectUri`: the connector answers the
78
- * same way wherever the platform is running, and providers match that value by
79
- * exact string.
77
+ * than tells. But the caller must supply two things the connector cannot know:
78
+ *
79
+ * redirectUri the connector answers the same way wherever the platform is
80
+ * running, and providers match this value by exact string.
81
+ * url where the source points. This shapes the authorize request
82
+ * itself — Confluence picks its cloudId from it and SharePoint
83
+ * decides which tenant issues the token — so collect the URL from
84
+ * the user BEFORE offering to connect. Signing in first and asking
85
+ * where second risks a token for the wrong place.
86
+ *
87
+ * The url is also what the resulting credentials get tied to: saving them onto a
88
+ * source that points somewhere else is refused.
80
89
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/authentication-flow
81
90
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
82
91
  * @param {String} redirectUri Where the browser will return, e.g. `${origin}/callback`
92
+ * @param {String} url Where the source points — required
83
93
  * @param {String} authToken Authentication token
84
94
  * @returns {Promise<object>}
85
95
  */
86
- export declare const initiateAuthenticationFlow: (connectionId: string, redirectUri: string, authToken: string) => Promise<object>;
96
+ export declare const initiateAuthenticationFlow: (connectionId: string, redirectUri: string, url: string, authToken: string) => Promise<object>;
87
97
  /**
88
98
  * Finish linking an account: exchange the authorization code the provider
89
99
  * returned for the connection itself.
@@ -104,17 +114,40 @@ export declare const initiateAuthenticationFlow: (connectionId: string, redirect
104
114
  */
105
115
  export declare const completeAuthenticationFlow: (connectionId: string, code: string, state: string, authToken: string) => Promise<object>;
106
116
  /**
107
- * Ask a connector how much content the supplied credentials can reach — the
108
- * volume preview shown before a source is created.
117
+ * Ask a connector how much content the supplied credentials can reach AT A GIVEN
118
+ * LOCATION — the volume preview shown before a source is created.
119
+ *
120
+ * This doubles as the reachability check. Signing in proves the person has an
121
+ * account; it proves nothing about whether they can read the specific site or
122
+ * space they typed. Credentials that cannot see `url` answer with an error or
123
+ * with nothing, so the user finds out here rather than at the first ingestion.
124
+ *
125
+ * `url` is required, and counts come back scoped to it. Calling without one is
126
+ * not "unscoped" so much as wrong: the answer would describe everything the
127
+ * account can reach, which is rarely what is about to be ingested.
128
+ *
129
+ * CREDENTIALS ARE USUALLY NAMED, NOT SENT. After an OAuth sign-in the caller holds
130
+ * a handle rather than tokens, and for a saved source it holds nothing at all —
131
+ * the credentials are in the vault. Pass `reference` in both cases and leave
132
+ * `authentication` null; send `authentication` only for credentials typed
133
+ * straight into the form, such as an API token.
109
134
  *
110
135
  * POST rather than GET because the credentials travel in the body and must not
111
136
  * reach a URL, an access log, or browser history.
112
137
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/stats
113
138
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
114
- * @param {object} authentication Credentials, shaped by the chosen `SourceConnectorAuthentication`
139
+ * @param {object} authentication Credentials typed into the form, or null when naming stored ones via `reference`
140
+ * @param {String} url Where the source points — required, and what the count is scoped to
115
141
  * @param {String} authToken Authentication token
116
142
  * @param {object} filters Optional filters over the fields `getConfiguration` advertises
143
+ * @param {object} reference Names STORED credentials instead of sending any:
144
+ * `{ authenticationHandle }` from `completeAuthenticationFlow` for a sign-in not
145
+ * yet saved, or `{ sourceId }` for a source already saved. Both are verified
146
+ * against the caller server-side.
117
147
  * @returns {Promise<object>} A `SourceConnectorStats`
118
148
  */
119
- export declare const getStats: (connectionId: string, authentication: object, authToken: string, filters?: object | null) => Promise<object>;
149
+ export declare const getStats: (connectionId: string, authentication: object | null, url: string, authToken: string, filters?: object | null, reference?: {
150
+ authenticationHandle?: string | null;
151
+ sourceId?: string | null;
152
+ } | null) => Promise<object>;
120
153
  //# sourceMappingURL=knowledgeBaseSourceConnectors.d.ts.map
package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"knowledgeBaseSourceConnectors.d.ts","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":"AAsBA,2FAA2F;AAC3F,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,iEAAiE;IACjE,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,2DAA2D;AAC3D,MAAM,WAAW,6BAA6B;IAC5C,2EAA2E;IAC3E,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,kCAAkC,EAAE,CAAC;CAC9C;AAED,qEAAqE;AACrE,MAAM,WAAW,6BAA6B;IAC5C,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,6BAA6B,EAAE,CAAC;CAC5C;AAED,qEAAqE;AACrE,MAAM,WAAW,4BAA4B;IAC3C,eAAe,EAAE,6BAA6B,EAAE,CAAC;IACjD,OAAO,EAAE,qBAAqB,EAAE,CAAC;CAClC;AAED,gEAAgE;AAChE,MAAM,WAAW,0BAA0B;IACzC,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+EAA+E;AAC/E,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,0BAA0B,EAAE,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,EACpB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,aAAa,MAAM,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GACnB,cAAc,MAAM,EACpB,gBAAgB,MAAM,EACtB,WAAW,MAAM,EACjB,UAAS,MAAM,GAAG,IAAW,KAC5B,OAAO,CAAC,MAAM,CAehB,CAAC"}
1
+ {"version":3,"file":"knowledgeBaseSourceConnectors.d.ts","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":"AAsBA,2FAA2F;AAC3F,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,iEAAiE;IACjE,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,2DAA2D;AAC3D,MAAM,WAAW,6BAA6B;IAC5C,2EAA2E;IAC3E,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,kCAAkC,EAAE,CAAC;CAC9C;AAED,qEAAqE;AACrE,MAAM,WAAW,6BAA6B;IAC5C,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,6BAA6B,EAAE,CAAC;CAC5C;AAED,qEAAqE;AACrE,MAAM,WAAW,4BAA4B;IAC3C,eAAe,EAAE,6BAA6B,EAAE,CAAC;IACjD,OAAO,EAAE,qBAAqB,EAAE,CAAC;CAClC;AAED,gEAAgE;AAChE,MAAM,WAAW,0BAA0B;IACzC,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+EAA+E;AAC/E,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,0BAA0B,EAAE,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,EACpB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,aAAa,MAAM,EACnB,KAAK,MAAM,EACX,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,QAAQ,GACnB,cAAc,MAAM,EACpB,gBAAgB,MAAM,GAAG,IAAI,EAC7B,KAAK,MAAM,EACX,WAAW,MAAM,EACjB,UAAS,MAAM,GAAG,IAAW,EAC7B,YAAW;IACT,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,GAAG,IAAW,KACd,OAAO,CAAC,MAAM,CAuBhB,CAAC"}
package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.js CHANGED
@@ -30,18 +30,28 @@ exports.getConfiguration = getConfiguration;
30
30
  * single-use `state` the backend minted for this attempt. This STARTS the flow.
31
31
  *
32
32
  * The connector decides WHICH scheme applies, which is why the caller asks rather
33
- * than tells. But the caller must supply `redirectUri`: the connector answers the
34
- * same way wherever the platform is running, and providers match that value by
35
- * exact string.
33
+ * than tells. But the caller must supply two things the connector cannot know:
34
+ *
35
+ * redirectUri the connector answers the same way wherever the platform is
36
+ * running, and providers match this value by exact string.
37
+ * url where the source points. This shapes the authorize request
38
+ * itself — Confluence picks its cloudId from it and SharePoint
39
+ * decides which tenant issues the token — so collect the URL from
40
+ * the user BEFORE offering to connect. Signing in first and asking
41
+ * where second risks a token for the wrong place.
42
+ *
43
+ * The url is also what the resulting credentials get tied to: saving them onto a
44
+ * source that points somewhere else is refused.
36
45
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/authentication-flow
37
46
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
38
47
  * @param {String} redirectUri Where the browser will return, e.g. `${origin}/callback`
48
+ * @param {String} url Where the source points — required
39
49
  * @param {String} authToken Authentication token
40
50
  * @returns {Promise<object>}
41
51
  */
42
- const initiateAuthenticationFlow = (connectionId, redirectUri, authToken) => {
52
+ const initiateAuthenticationFlow = (connectionId, redirectUri, url, authToken) => {
43
53
  return new Promise((resolve, reject) => {
44
- const request = axiosClient_js_1.client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/authentication-flow`, { redirectUri }, { headers: { authorization: authToken } });
54
+ const request = axiosClient_js_1.client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/authentication-flow`, { redirectUri, url }, { headers: { authorization: authToken } });
45
55
  request
46
56
  .then((response) => {
47
57
  resolve(response.data);
@@ -84,21 +94,49 @@ const completeAuthenticationFlow = (connectionId, code, state, authToken) => {
84
94
  };
85
95
  exports.completeAuthenticationFlow = completeAuthenticationFlow;
86
96
  /**
87
- * Ask a connector how much content the supplied credentials can reach — the
88
- * volume preview shown before a source is created.
97
+ * Ask a connector how much content the supplied credentials can reach AT A GIVEN
98
+ * LOCATION — the volume preview shown before a source is created.
99
+ *
100
+ * This doubles as the reachability check. Signing in proves the person has an
101
+ * account; it proves nothing about whether they can read the specific site or
102
+ * space they typed. Credentials that cannot see `url` answer with an error or
103
+ * with nothing, so the user finds out here rather than at the first ingestion.
104
+ *
105
+ * `url` is required, and counts come back scoped to it. Calling without one is
106
+ * not "unscoped" so much as wrong: the answer would describe everything the
107
+ * account can reach, which is rarely what is about to be ingested.
108
+ *
109
+ * CREDENTIALS ARE USUALLY NAMED, NOT SENT. After an OAuth sign-in the caller holds
110
+ * a handle rather than tokens, and for a saved source it holds nothing at all —
111
+ * the credentials are in the vault. Pass `reference` in both cases and leave
112
+ * `authentication` null; send `authentication` only for credentials typed
113
+ * straight into the form, such as an API token.
89
114
  *
90
115
  * POST rather than GET because the credentials travel in the body and must not
91
116
  * reach a URL, an access log, or browser history.
92
117
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/stats
93
118
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
94
- * @param {object} authentication Credentials, shaped by the chosen `SourceConnectorAuthentication`
119
+ * @param {object} authentication Credentials typed into the form, or null when naming stored ones via `reference`
120
+ * @param {String} url Where the source points — required, and what the count is scoped to
95
121
  * @param {String} authToken Authentication token
96
122
  * @param {object} filters Optional filters over the fields `getConfiguration` advertises
123
+ * @param {object} reference Names STORED credentials instead of sending any:
124
+ * `{ authenticationHandle }` from `completeAuthenticationFlow` for a sign-in not
125
+ * yet saved, or `{ sourceId }` for a source already saved. Both are verified
126
+ * against the caller server-side.
97
127
  * @returns {Promise<object>} A `SourceConnectorStats`
98
128
  */
99
- const getStats = (connectionId, authentication, authToken, filters = null) => {
129
+ const getStats = (connectionId, authentication, url, authToken, filters = null, reference = null) => {
100
130
  return new Promise((resolve, reject) => {
101
- const request = axiosClient_js_1.client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/stats`, { authentication, ...(filters ? { filters } : {}) }, { headers: { authorization: authToken } });
131
+ const request = axiosClient_js_1.client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/stats`, {
132
+ ...(authentication ? { authentication } : {}),
133
+ url,
134
+ ...(filters ? { filters } : {}),
135
+ ...(reference?.authenticationHandle
136
+ ? { authenticationHandle: reference.authenticationHandle }
137
+ : {}),
138
+ ...(reference?.sourceId ? { sourceId: reference.sourceId } : {}),
139
+ }, { headers: { authorization: authToken } });
102
140
  request
103
141
  .then((response) => {
104
142
  resolve(response.data);
package/dist/cjs/lib/integrations/knowledgeBaseSourceConnectors.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"knowledgeBaseSourceConnectors.js","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":";;;AACA,sDAA2C;AAwF3C;;;;;;;;GAQG;AACI,MAAM,gBAAgB,GAAG,CAC9B,YAAoB,EACpB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CACxB,gDAAgD,YAAY,gBAAgB,EAC5E,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAjBW,QAAA,gBAAgB,oBAiB3B;AAEF;;;;;;;;;;;;;;GAcG;AACI,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,WAAmB,EACnB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,sBAAsB,EAClF,EAAE,WAAW,EAAE,EACf,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,0BAA0B,8BAmBrC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACI,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,IAAY,EACZ,KAAa,EACb,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,+BAA+B,EAC3F,EAAE,IAAI,EAAE,KAAK,EAAE,EACf,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,0BAA0B,8BAoBrC;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,QAAQ,GAAG,CACtB,YAAoB,EACpB,cAAsB,EACtB,SAAiB,EACjB,UAAyB,IAAI,EACZ,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,QAAQ,EACpE,EAAE,cAAc,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EACnD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,QAAQ,YAoBnB"}
1
+ {"version":3,"file":"knowledgeBaseSourceConnectors.js","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":";;;AACA,sDAA2C;AAwF3C;;;;;;;;GAQG;AACI,MAAM,gBAAgB,GAAG,CAC9B,YAAoB,EACpB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CACxB,gDAAgD,YAAY,gBAAgB,EAC5E,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAjBW,QAAA,gBAAgB,oBAiB3B;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,WAAmB,EACnB,GAAW,EACX,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,sBAAsB,EAClF,EAAE,WAAW,EAAE,GAAG,EAAE,EACpB,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,0BAA0B,8BAoBrC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACI,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,IAAY,EACZ,KAAa,EACb,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,+BAA+B,EAC3F,EAAE,IAAI,EAAE,KAAK,EAAE,EACf,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,0BAA0B,8BAoBrC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACI,MAAM,QAAQ,GAAG,CACtB,YAAoB,EACpB,cAA6B,EAC7B,GAAW,EACX,SAAiB,EACjB,UAAyB,IAAI,EAC7B,YAGW,IAAI,EACE,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,QAAQ,EACpE;YACE,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,GAAG;YACH,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,GAAG,CAAC,SAAS,EAAE,oBAAoB;gBACjC,CAAC,CAAC,EAAE,oBAAoB,EAAE,SAAS,CAAC,oBAAoB,EAAE;gBAC1D,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjE,EACD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAjCW,QAAA,QAAQ,YAiCnB"}
package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.d.ts CHANGED
@@ -74,16 +74,26 @@ export declare const getConfiguration: (connectionId: string, authToken: string)
74
74
  * single-use `state` the backend minted for this attempt. This STARTS the flow.
75
75
  *
76
76
  * The connector decides WHICH scheme applies, which is why the caller asks rather
77
- * than tells. But the caller must supply `redirectUri`: the connector answers the
78
- * same way wherever the platform is running, and providers match that value by
79
- * exact string.
77
+ * than tells. But the caller must supply two things the connector cannot know:
78
+ *
79
+ * redirectUri the connector answers the same way wherever the platform is
80
+ * running, and providers match this value by exact string.
81
+ * url where the source points. This shapes the authorize request
82
+ * itself — Confluence picks its cloudId from it and SharePoint
83
+ * decides which tenant issues the token — so collect the URL from
84
+ * the user BEFORE offering to connect. Signing in first and asking
85
+ * where second risks a token for the wrong place.
86
+ *
87
+ * The url is also what the resulting credentials get tied to: saving them onto a
88
+ * source that points somewhere else is refused.
80
89
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/authentication-flow
81
90
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
82
91
  * @param {String} redirectUri Where the browser will return, e.g. `${origin}/callback`
92
+ * @param {String} url Where the source points — required
83
93
  * @param {String} authToken Authentication token
84
94
  * @returns {Promise<object>}
85
95
  */
86
- export declare const initiateAuthenticationFlow: (connectionId: string, redirectUri: string, authToken: string) => Promise<object>;
96
+ export declare const initiateAuthenticationFlow: (connectionId: string, redirectUri: string, url: string, authToken: string) => Promise<object>;
87
97
  /**
88
98
  * Finish linking an account: exchange the authorization code the provider
89
99
  * returned for the connection itself.
@@ -104,17 +114,40 @@ export declare const initiateAuthenticationFlow: (connectionId: string, redirect
104
114
  */
105
115
  export declare const completeAuthenticationFlow: (connectionId: string, code: string, state: string, authToken: string) => Promise<object>;
106
116
  /**
107
- * Ask a connector how much content the supplied credentials can reach — the
108
- * volume preview shown before a source is created.
117
+ * Ask a connector how much content the supplied credentials can reach AT A GIVEN
118
+ * LOCATION — the volume preview shown before a source is created.
119
+ *
120
+ * This doubles as the reachability check. Signing in proves the person has an
121
+ * account; it proves nothing about whether they can read the specific site or
122
+ * space they typed. Credentials that cannot see `url` answer with an error or
123
+ * with nothing, so the user finds out here rather than at the first ingestion.
124
+ *
125
+ * `url` is required, and counts come back scoped to it. Calling without one is
126
+ * not "unscoped" so much as wrong: the answer would describe everything the
127
+ * account can reach, which is rarely what is about to be ingested.
128
+ *
129
+ * CREDENTIALS ARE USUALLY NAMED, NOT SENT. After an OAuth sign-in the caller holds
130
+ * a handle rather than tokens, and for a saved source it holds nothing at all —
131
+ * the credentials are in the vault. Pass `reference` in both cases and leave
132
+ * `authentication` null; send `authentication` only for credentials typed
133
+ * straight into the form, such as an API token.
109
134
  *
110
135
  * POST rather than GET because the credentials travel in the body and must not
111
136
  * reach a URL, an access log, or browser history.
112
137
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/stats
113
138
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
114
- * @param {object} authentication Credentials, shaped by the chosen `SourceConnectorAuthentication`
139
+ * @param {object} authentication Credentials typed into the form, or null when naming stored ones via `reference`
140
+ * @param {String} url Where the source points — required, and what the count is scoped to
115
141
  * @param {String} authToken Authentication token
116
142
  * @param {object} filters Optional filters over the fields `getConfiguration` advertises
143
+ * @param {object} reference Names STORED credentials instead of sending any:
144
+ * `{ authenticationHandle }` from `completeAuthenticationFlow` for a sign-in not
145
+ * yet saved, or `{ sourceId }` for a source already saved. Both are verified
146
+ * against the caller server-side.
117
147
  * @returns {Promise<object>} A `SourceConnectorStats`
118
148
  */
119
- export declare const getStats: (connectionId: string, authentication: object, authToken: string, filters?: object | null) => Promise<object>;
149
+ export declare const getStats: (connectionId: string, authentication: object | null, url: string, authToken: string, filters?: object | null, reference?: {
150
+ authenticationHandle?: string | null;
151
+ sourceId?: string | null;
152
+ } | null) => Promise<object>;
120
153
  //# sourceMappingURL=knowledgeBaseSourceConnectors.d.ts.map
package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"knowledgeBaseSourceConnectors.d.ts","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":"AAsBA,2FAA2F;AAC3F,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,iEAAiE;IACjE,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,2DAA2D;AAC3D,MAAM,WAAW,6BAA6B;IAC5C,2EAA2E;IAC3E,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,kCAAkC,EAAE,CAAC;CAC9C;AAED,qEAAqE;AACrE,MAAM,WAAW,6BAA6B;IAC5C,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,6BAA6B,EAAE,CAAC;CAC5C;AAED,qEAAqE;AACrE,MAAM,WAAW,4BAA4B;IAC3C,eAAe,EAAE,6BAA6B,EAAE,CAAC;IACjD,OAAO,EAAE,qBAAqB,EAAE,CAAC;CAClC;AAED,gEAAgE;AAChE,MAAM,WAAW,0BAA0B;IACzC,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+EAA+E;AAC/E,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,0BAA0B,EAAE,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,EACpB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,aAAa,MAAM,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GACnB,cAAc,MAAM,EACpB,gBAAgB,MAAM,EACtB,WAAW,MAAM,EACjB,UAAS,MAAM,GAAG,IAAW,KAC5B,OAAO,CAAC,MAAM,CAehB,CAAC"}
1
+ {"version":3,"file":"knowledgeBaseSourceConnectors.d.ts","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":"AAsBA,2FAA2F;AAC3F,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,iEAAiE;IACjE,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,2DAA2D;AAC3D,MAAM,WAAW,6BAA6B;IAC5C,2EAA2E;IAC3E,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,kCAAkC,EAAE,CAAC;CAC9C;AAED,qEAAqE;AACrE,MAAM,WAAW,6BAA6B;IAC5C,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,6BAA6B,EAAE,CAAC;CAC5C;AAED,qEAAqE;AACrE,MAAM,WAAW,4BAA4B;IAC3C,eAAe,EAAE,6BAA6B,EAAE,CAAC;IACjD,OAAO,EAAE,qBAAqB,EAAE,CAAC;CAClC;AAED,gEAAgE;AAChE,MAAM,WAAW,0BAA0B;IACzC,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+EAA+E;AAC/E,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,0BAA0B,EAAE,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,EACpB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,aAAa,MAAM,EACnB,KAAK,MAAM,EACX,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,MAAM,EACpB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,QAAQ,GACnB,cAAc,MAAM,EACpB,gBAAgB,MAAM,GAAG,IAAI,EAC7B,KAAK,MAAM,EACX,WAAW,MAAM,EACjB,UAAS,MAAM,GAAG,IAAW,EAC7B,YAAW;IACT,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,GAAG,IAAW,KACd,OAAO,CAAC,MAAM,CAuBhB,CAAC"}
package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.js CHANGED
@@ -26,18 +26,28 @@ export const getConfiguration = (connectionId, authToken) => {
26
26
  * single-use `state` the backend minted for this attempt. This STARTS the flow.
27
27
  *
28
28
  * The connector decides WHICH scheme applies, which is why the caller asks rather
29
- * than tells. But the caller must supply `redirectUri`: the connector answers the
30
- * same way wherever the platform is running, and providers match that value by
31
- * exact string.
29
+ * than tells. But the caller must supply two things the connector cannot know:
30
+ *
31
+ * redirectUri the connector answers the same way wherever the platform is
32
+ * running, and providers match this value by exact string.
33
+ * url where the source points. This shapes the authorize request
34
+ * itself — Confluence picks its cloudId from it and SharePoint
35
+ * decides which tenant issues the token — so collect the URL from
36
+ * the user BEFORE offering to connect. Signing in first and asking
37
+ * where second risks a token for the wrong place.
38
+ *
39
+ * The url is also what the resulting credentials get tied to: saving them onto a
40
+ * source that points somewhere else is refused.
32
41
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/authentication-flow
33
42
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
34
43
  * @param {String} redirectUri Where the browser will return, e.g. `${origin}/callback`
44
+ * @param {String} url Where the source points — required
35
45
  * @param {String} authToken Authentication token
36
46
  * @returns {Promise<object>}
37
47
  */
38
- export const initiateAuthenticationFlow = (connectionId, redirectUri, authToken) => {
48
+ export const initiateAuthenticationFlow = (connectionId, redirectUri, url, authToken) => {
39
49
  return new Promise((resolve, reject) => {
40
- const request = client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/authentication-flow`, { redirectUri }, { headers: { authorization: authToken } });
50
+ const request = client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/authentication-flow`, { redirectUri, url }, { headers: { authorization: authToken } });
41
51
  request
42
52
  .then((response) => {
43
53
  resolve(response.data);
@@ -78,21 +88,49 @@ export const completeAuthenticationFlow = (connectionId, code, state, authToken)
78
88
  });
79
89
  };
80
90
  /**
81
- * Ask a connector how much content the supplied credentials can reach — the
82
- * volume preview shown before a source is created.
91
+ * Ask a connector how much content the supplied credentials can reach AT A GIVEN
92
+ * LOCATION — the volume preview shown before a source is created.
93
+ *
94
+ * This doubles as the reachability check. Signing in proves the person has an
95
+ * account; it proves nothing about whether they can read the specific site or
96
+ * space they typed. Credentials that cannot see `url` answer with an error or
97
+ * with nothing, so the user finds out here rather than at the first ingestion.
98
+ *
99
+ * `url` is required, and counts come back scoped to it. Calling without one is
100
+ * not "unscoped" so much as wrong: the answer would describe everything the
101
+ * account can reach, which is rarely what is about to be ingested.
102
+ *
103
+ * CREDENTIALS ARE USUALLY NAMED, NOT SENT. After an OAuth sign-in the caller holds
104
+ * a handle rather than tokens, and for a saved source it holds nothing at all —
105
+ * the credentials are in the vault. Pass `reference` in both cases and leave
106
+ * `authentication` null; send `authentication` only for credentials typed
107
+ * straight into the form, such as an API token.
83
108
  *
84
109
  * POST rather than GET because the credentials travel in the body and must not
85
110
  * reach a URL, an access log, or browser history.
86
111
  * POST /api/v1/exceed/knowledgebasesourceconnectors/:id/stats
87
112
  * @param {String} connectionId The connection id (an `integrationId` from `knowledgeBase.listSourceConnectors`)
88
- * @param {object} authentication Credentials, shaped by the chosen `SourceConnectorAuthentication`
113
+ * @param {object} authentication Credentials typed into the form, or null when naming stored ones via `reference`
114
+ * @param {String} url Where the source points — required, and what the count is scoped to
89
115
  * @param {String} authToken Authentication token
90
116
  * @param {object} filters Optional filters over the fields `getConfiguration` advertises
117
+ * @param {object} reference Names STORED credentials instead of sending any:
118
+ * `{ authenticationHandle }` from `completeAuthenticationFlow` for a sign-in not
119
+ * yet saved, or `{ sourceId }` for a source already saved. Both are verified
120
+ * against the caller server-side.
91
121
  * @returns {Promise<object>} A `SourceConnectorStats`
92
122
  */
93
- export const getStats = (connectionId, authentication, authToken, filters = null) => {
123
+ export const getStats = (connectionId, authentication, url, authToken, filters = null, reference = null) => {
94
124
  return new Promise((resolve, reject) => {
95
- const request = client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/stats`, { authentication, ...(filters ? { filters } : {}) }, { headers: { authorization: authToken } });
125
+ const request = client.post(`/api/v1/exceed/knowledgebasesourceconnectors/${connectionId}/stats`, {
126
+ ...(authentication ? { authentication } : {}),
127
+ url,
128
+ ...(filters ? { filters } : {}),
129
+ ...(reference?.authenticationHandle
130
+ ? { authenticationHandle: reference.authenticationHandle }
131
+ : {}),
132
+ ...(reference?.sourceId ? { sourceId: reference.sourceId } : {}),
133
+ }, { headers: { authorization: authToken } });
96
134
  request
97
135
  .then((response) => {
98
136
  resolve(response.data);
package/dist/esm/lib/integrations/knowledgeBaseSourceConnectors.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"knowledgeBaseSourceConnectors.js","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAwF3C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,YAAoB,EACpB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,gDAAgD,YAAY,gBAAgB,EAC5E,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,WAAmB,EACnB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,sBAAsB,EAClF,EAAE,WAAW,EAAE,EACf,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,IAAY,EACZ,KAAa,EACb,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,+BAA+B,EAC3F,EAAE,IAAI,EAAE,KAAK,EAAE,EACf,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,YAAoB,EACpB,cAAsB,EACtB,SAAiB,EACjB,UAAyB,IAAI,EACZ,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,QAAQ,EACpE,EAAE,cAAc,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EACnD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
1
+ {"version":3,"file":"knowledgeBaseSourceConnectors.js","sourceRoot":"","sources":["../../../../src/lib/integrations/knowledgeBaseSourceConnectors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAwF3C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,YAAoB,EACpB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,gDAAgD,YAAY,gBAAgB,EAC5E,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,WAAmB,EACnB,GAAW,EACX,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,sBAAsB,EAClF,EAAE,WAAW,EAAE,GAAG,EAAE,EACpB,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,YAAoB,EACpB,IAAY,EACZ,KAAa,EACb,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,+BAA+B,EAC3F,EAAE,IAAI,EAAE,KAAK,EAAE,EACf,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,YAAoB,EACpB,cAA6B,EAC7B,GAAW,EACX,SAAiB,EACjB,UAAyB,IAAI,EAC7B,YAGW,IAAI,EACE,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,gDAAgD,YAAY,QAAQ,EACpE;YACE,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,GAAG;YACH,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,GAAG,CAAC,SAAS,EAAE,oBAAoB;gBACjC,CAAC,CAAC,EAAE,oBAAoB,EAAE,SAAS,CAAC,oBAAoB,EAAE;gBAC1D,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjE,EACD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stackfactor/client-api",
3
- "version": "1.1.265",
3
+ "version": "1.2.1",
4
4
  "description": "Node.js library for the StackFactor API",
5
5
  "publishConfig": {
6
6
  "access": "public"