@invoiceleaf/integration-sdk 2.1.0 → 2.2.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/types/manifest.d.ts
CHANGED
|
@@ -94,6 +94,11 @@ export interface ExternalAuthConfig {
|
|
|
94
94
|
scopes: string[];
|
|
95
95
|
pkceRequired?: boolean;
|
|
96
96
|
};
|
|
97
|
+
/**
|
|
98
|
+
* Credentials for the platform-side client (the registered OAuth app) for this
|
|
99
|
+
* provider. Omitted when every installation brings its own credentials instead.
|
|
100
|
+
*/
|
|
101
|
+
appCredentials?: AppCredentialsConfig;
|
|
97
102
|
/** API key configuration */
|
|
98
103
|
apiKey?: {
|
|
99
104
|
/** HTTP header the key is sent in, when the host injects it automatically.
|
|
@@ -113,6 +118,50 @@ export interface ExternalAuthConfig {
|
|
|
113
118
|
};
|
|
114
119
|
}
|
|
115
120
|
/** One field of a multi-field `api_key` credential (see {@link ExternalAuthConfig}). */
|
|
121
|
+
/**
|
|
122
|
+
* One input in the app-registration form an administrator fills in when the
|
|
123
|
+
* platform's own client for a provider is set up. See {@link AppCredentialsConfig}.
|
|
124
|
+
*/
|
|
125
|
+
export interface AuthAppField {
|
|
126
|
+
/** Stable key the value is stored under (e.g. "clientId"). */
|
|
127
|
+
key: string;
|
|
128
|
+
/** Human label shown in the admin form. */
|
|
129
|
+
label: string;
|
|
130
|
+
/** Render as a masked input and encrypt at rest. Defaults to false. */
|
|
131
|
+
secret?: boolean;
|
|
132
|
+
/** Whether the field must be filled in. Defaults to true. */
|
|
133
|
+
required?: boolean;
|
|
134
|
+
/** Optional placeholder shown in the empty input. */
|
|
135
|
+
placeholder?: string;
|
|
136
|
+
/** Optional helper text shown under the field. */
|
|
137
|
+
description?: string;
|
|
138
|
+
/** Value used when the field is left untouched. */
|
|
139
|
+
default?: string;
|
|
140
|
+
/** When present, the field renders as a select limited to these values. */
|
|
141
|
+
options?: AuthAppFieldOption[];
|
|
142
|
+
}
|
|
143
|
+
/** One choice in an {@link AuthAppField} rendered as a select. */
|
|
144
|
+
export interface AuthAppFieldOption {
|
|
145
|
+
value: string;
|
|
146
|
+
label: string;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Credentials for the client the platform registers with the provider - the OAuth
|
|
150
|
+
* app behind the "Connect" button - as opposed to the per-installation tokens each
|
|
151
|
+
* user obtains through it.
|
|
152
|
+
*
|
|
153
|
+
* Declaring them here lets the admin registration form be rendered from the manifest
|
|
154
|
+
* rather than hard-coding one form per integration, and lets the host resolve the
|
|
155
|
+
* client id and secret without a per-provider environment variable.
|
|
156
|
+
*/
|
|
157
|
+
export interface AppCredentialsConfig {
|
|
158
|
+
/** Where an administrator registers the app and obtains these values. */
|
|
159
|
+
registrationUrl?: string;
|
|
160
|
+
/** Guidance shown above the form. */
|
|
161
|
+
instructions?: string;
|
|
162
|
+
/** Fields to collect, in display order. */
|
|
163
|
+
fields: AuthAppField[];
|
|
164
|
+
}
|
|
116
165
|
export interface ApiKeyField {
|
|
117
166
|
/** Stable key used in the stored JSON object (e.g. "tid"). */
|
|
118
167
|
key: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/types/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,EAAE,EAAE,MAAM,CAAC;IAEX,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,4CAA4C;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,yBAAyB;IACzB,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,qFAAqF;IACrF,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC;IAExC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEnC,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,2CAA2C;IAC3C,UAAU,EAAE,cAAc,EAAE,CAAC;IAE7B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,qDAAqD;IACrD,YAAY,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAEpC,0BAA0B;IAC1B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAE9B,yBAAyB;IACzB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAE5B,kEAAkE;IAClE,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAErC,sBAAsB;IACtB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IAEzB,gCAAgC;IAChC,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE7B,gCAAgC;IAChC,YAAY,CAAC,EAAE,UAAU,CAAC;IAE1B,uBAAuB;IACvB,EAAE,CAAC,EAAE,aAAa,CAAC;IAEnB,sBAAsB;IACtB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,uCAAuC;IACvC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,eAAe,GACf,KAAK,GACL,QAAQ,GACR,cAAc,GACd,SAAS,GACT,KAAK,GACL,OAAO,CAAC;AAEZ,MAAM,MAAM,cAAc,GACtB,WAAW,GACX,WAAW,GACX,YAAY,GACZ,MAAM,GACN,SAAS,GACT,QAAQ,GACR,iBAAiB,GACjB,UAAU,CAAC;AAEf,MAAM,WAAW,kBAAkB;IACjC,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IAEjB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,gBAAgB;IAChB,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAExC,2BAA2B;IAC3B,KAAK,CAAC,EAAE;QACN,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF,4BAA4B;IAC5B,MAAM,CAAC,EAAE;QACP;;4DAEoD;QACpD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;;;;;WAMG;QACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;KACxB,CAAC;CACH;AAED,wFAAwF;AACxF,MAAM,WAAW,WAAW;IAC1B,8DAA8D;IAC9D,GAAG,EAAE,MAAM,CAAC;IACZ,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,mCAAmC;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
|
|
1
|
+
{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/types/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,EAAE,EAAE,MAAM,CAAC;IAEX,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,4CAA4C;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,yBAAyB;IACzB,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,qFAAqF;IACrF,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC;IAExC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEnC,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,2CAA2C;IAC3C,UAAU,EAAE,cAAc,EAAE,CAAC;IAE7B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,qDAAqD;IACrD,YAAY,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAEpC,0BAA0B;IAC1B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAE9B,yBAAyB;IACzB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAE5B,kEAAkE;IAClE,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAErC,sBAAsB;IACtB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IAEzB,gCAAgC;IAChC,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE7B,gCAAgC;IAChC,YAAY,CAAC,EAAE,UAAU,CAAC;IAE1B,uBAAuB;IACvB,EAAE,CAAC,EAAE,aAAa,CAAC;IAEnB,sBAAsB;IACtB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,uCAAuC;IACvC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,eAAe,GACf,KAAK,GACL,QAAQ,GACR,cAAc,GACd,SAAS,GACT,KAAK,GACL,OAAO,CAAC;AAEZ,MAAM,MAAM,cAAc,GACtB,WAAW,GACX,WAAW,GACX,YAAY,GACZ,MAAM,GACN,SAAS,GACT,QAAQ,GACR,iBAAiB,GACjB,UAAU,CAAC;AAEf,MAAM,WAAW,kBAAkB;IACjC,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IAEjB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,gBAAgB;IAChB,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAExC,2BAA2B;IAC3B,KAAK,CAAC,EAAE;QACN,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC,4BAA4B;IAC5B,MAAM,CAAC,EAAE;QACP;;4DAEoD;QACpD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;;;;;WAMG;QACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;KACxB,CAAC;CACH;AAED,wFAAwF;AACxF;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,GAAG,EAAE,MAAM,CAAC;IACZ,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED,kEAAkE;AAClE,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACnC,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qCAAqC;IACrC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,8DAA8D;IAC9D,GAAG,EAAE,MAAM,CAAC;IACZ,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,mCAAmC;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
|