@proveanything/smartlinks 1.17.5 → 2.0.0-alpha.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.
- package/dist/api/integrations.d.ts +7 -1
- package/dist/api/integrations.js +9 -0
- package/dist/docs/API_SUMMARY.md +87 -300
- package/dist/docs/deploying-apps.md +193 -0
- package/dist/docs/server-functions.md +306 -0
- package/dist/openapi.yaml +171 -0
- package/dist/testing/index.d.ts +64 -0
- package/dist/testing/index.js +145 -0
- package/dist/types/appManifest.d.ts +114 -0
- package/dist/types/integrations.d.ts +8 -0
- package/docs/API_SUMMARY.md +87 -300
- package/docs/deploying-apps.md +193 -0
- package/docs/server-functions.md +306 -0
- package/openapi.yaml +171 -0
- package/package.json +7 -2
package/openapi.yaml
CHANGED
|
@@ -38,6 +38,7 @@ tags:
|
|
|
38
38
|
- name: crate
|
|
39
39
|
- name: facets
|
|
40
40
|
- name: form
|
|
41
|
+
- name: integrations
|
|
41
42
|
- name: interactions
|
|
42
43
|
- name: jobs
|
|
43
44
|
- name: journeys
|
|
@@ -4164,6 +4165,33 @@ paths:
|
|
|
4164
4165
|
description: Unauthorized
|
|
4165
4166
|
404:
|
|
4166
4167
|
description: Not found
|
|
4168
|
+
/admin/collection/{collectionId}/integrations/record-types:
|
|
4169
|
+
get:
|
|
4170
|
+
tags:
|
|
4171
|
+
- integrations
|
|
4172
|
+
summary: Discover the app-record types present in a collection + which app owns each (introspected), for picking a sub-record source/trigger.
|
|
4173
|
+
operationId: integrations_listRecordTypes
|
|
4174
|
+
security:
|
|
4175
|
+
- bearerAuth: []
|
|
4176
|
+
parameters:
|
|
4177
|
+
- name: collectionId
|
|
4178
|
+
in: path
|
|
4179
|
+
required: true
|
|
4180
|
+
schema:
|
|
4181
|
+
type: string
|
|
4182
|
+
responses:
|
|
4183
|
+
200:
|
|
4184
|
+
description: Success
|
|
4185
|
+
content:
|
|
4186
|
+
application/json:
|
|
4187
|
+
schema:
|
|
4188
|
+
$ref: "#/components/schemas/RecordTypesResponse"
|
|
4189
|
+
400:
|
|
4190
|
+
description: Bad request
|
|
4191
|
+
401:
|
|
4192
|
+
description: Unauthorized
|
|
4193
|
+
404:
|
|
4194
|
+
description: Not found
|
|
4167
4195
|
/admin/collection/{collectionId}/interactions:
|
|
4168
4196
|
get:
|
|
4169
4197
|
tags:
|
|
@@ -17215,6 +17243,109 @@ components:
|
|
|
17215
17243
|
required:
|
|
17216
17244
|
- files
|
|
17217
17245
|
- function
|
|
17246
|
+
AppFunctionTrigger:
|
|
17247
|
+
type: object
|
|
17248
|
+
properties:
|
|
17249
|
+
type:
|
|
17250
|
+
$ref: "#/components/schemas/AppFunctionTriggerType"
|
|
17251
|
+
eventTypes:
|
|
17252
|
+
type: array
|
|
17253
|
+
items:
|
|
17254
|
+
type: string
|
|
17255
|
+
schedule:
|
|
17256
|
+
type: string
|
|
17257
|
+
route:
|
|
17258
|
+
type: string
|
|
17259
|
+
methods:
|
|
17260
|
+
type: array
|
|
17261
|
+
items:
|
|
17262
|
+
type: string
|
|
17263
|
+
enum:
|
|
17264
|
+
- GET
|
|
17265
|
+
- POST
|
|
17266
|
+
- PUT
|
|
17267
|
+
- PATCH
|
|
17268
|
+
- DELETE
|
|
17269
|
+
required:
|
|
17270
|
+
- type
|
|
17271
|
+
AppFunctionDef:
|
|
17272
|
+
type: object
|
|
17273
|
+
properties:
|
|
17274
|
+
name:
|
|
17275
|
+
type: string
|
|
17276
|
+
description:
|
|
17277
|
+
type: string
|
|
17278
|
+
trigger:
|
|
17279
|
+
$ref: "#/components/schemas/AppFunctionTrigger"
|
|
17280
|
+
visibility:
|
|
17281
|
+
$ref: "#/components/schemas/AppFunctionVisibility"
|
|
17282
|
+
authority:
|
|
17283
|
+
$ref: "#/components/schemas/AppFunctionAuthority"
|
|
17284
|
+
elevated:
|
|
17285
|
+
type: boolean
|
|
17286
|
+
capabilities:
|
|
17287
|
+
type: array
|
|
17288
|
+
items:
|
|
17289
|
+
type: string
|
|
17290
|
+
apiVersion:
|
|
17291
|
+
type: string
|
|
17292
|
+
handler:
|
|
17293
|
+
type: string
|
|
17294
|
+
required:
|
|
17295
|
+
- name
|
|
17296
|
+
- trigger
|
|
17297
|
+
AppManifestFunctions:
|
|
17298
|
+
type: object
|
|
17299
|
+
properties:
|
|
17300
|
+
files:
|
|
17301
|
+
$ref: "#/components/schemas/AppManifestFiles"
|
|
17302
|
+
definitions:
|
|
17303
|
+
type: array
|
|
17304
|
+
items:
|
|
17305
|
+
$ref: "#/components/schemas/AppFunctionDef"
|
|
17306
|
+
required:
|
|
17307
|
+
- files
|
|
17308
|
+
- definitions
|
|
17309
|
+
ServerFunctionCaller:
|
|
17310
|
+
type: object
|
|
17311
|
+
properties:
|
|
17312
|
+
userId:
|
|
17313
|
+
type: string
|
|
17314
|
+
anonymous:
|
|
17315
|
+
type: boolean
|
|
17316
|
+
origin:
|
|
17317
|
+
type: string
|
|
17318
|
+
ip:
|
|
17319
|
+
type: string
|
|
17320
|
+
via:
|
|
17321
|
+
$ref: "#/components/schemas/AppFunctionTriggerType"
|
|
17322
|
+
required:
|
|
17323
|
+
- userId
|
|
17324
|
+
- anonymous
|
|
17325
|
+
- via
|
|
17326
|
+
ServerFunctionContext:
|
|
17327
|
+
type: object
|
|
17328
|
+
properties:
|
|
17329
|
+
collectionId:
|
|
17330
|
+
type: string
|
|
17331
|
+
appId:
|
|
17332
|
+
type: string
|
|
17333
|
+
sl: {}
|
|
17334
|
+
secrets:
|
|
17335
|
+
type: object
|
|
17336
|
+
additionalProperties: true
|
|
17337
|
+
caller:
|
|
17338
|
+
$ref: "#/components/schemas/ServerFunctionCaller"
|
|
17339
|
+
fetch:
|
|
17340
|
+
type: object
|
|
17341
|
+
additionalProperties: true
|
|
17342
|
+
required:
|
|
17343
|
+
- collectionId
|
|
17344
|
+
- appId
|
|
17345
|
+
- sl
|
|
17346
|
+
- secrets
|
|
17347
|
+
- caller
|
|
17348
|
+
- fetch
|
|
17218
17349
|
AppAdminConfig:
|
|
17219
17350
|
type: object
|
|
17220
17351
|
properties:
|
|
@@ -17357,6 +17488,8 @@ components:
|
|
|
17357
17488
|
$ref: "#/components/schemas/DeepLinkEntry"
|
|
17358
17489
|
executor:
|
|
17359
17490
|
$ref: "#/components/schemas/AppManifestExecutor"
|
|
17491
|
+
functions:
|
|
17492
|
+
$ref: "#/components/schemas/AppManifestFunctions"
|
|
17360
17493
|
required:
|
|
17361
17494
|
- name
|
|
17362
17495
|
- version
|
|
@@ -17397,6 +17530,22 @@ components:
|
|
|
17397
17530
|
properties:
|
|
17398
17531
|
force:
|
|
17399
17532
|
type: boolean
|
|
17533
|
+
AppFunctionTriggerType:
|
|
17534
|
+
type: string
|
|
17535
|
+
enum:
|
|
17536
|
+
- http
|
|
17537
|
+
- event
|
|
17538
|
+
- cron
|
|
17539
|
+
AppFunctionVisibility:
|
|
17540
|
+
type: string
|
|
17541
|
+
enum:
|
|
17542
|
+
- admin
|
|
17543
|
+
- public
|
|
17544
|
+
AppFunctionAuthority:
|
|
17545
|
+
type: string
|
|
17546
|
+
enum:
|
|
17547
|
+
- caller
|
|
17548
|
+
- collection
|
|
17400
17549
|
PaginatedResponse:
|
|
17401
17550
|
type: object
|
|
17402
17551
|
properties:
|
|
@@ -23429,6 +23578,28 @@ components:
|
|
|
23429
23578
|
properties:
|
|
23430
23579
|
purpose:
|
|
23431
23580
|
type: string
|
|
23581
|
+
RecordTypeInfo:
|
|
23582
|
+
type: object
|
|
23583
|
+
properties:
|
|
23584
|
+
appId:
|
|
23585
|
+
type: string
|
|
23586
|
+
recordType:
|
|
23587
|
+
type: string
|
|
23588
|
+
count:
|
|
23589
|
+
type: number
|
|
23590
|
+
required:
|
|
23591
|
+
- appId
|
|
23592
|
+
- recordType
|
|
23593
|
+
- count
|
|
23594
|
+
RecordTypesResponse:
|
|
23595
|
+
type: object
|
|
23596
|
+
properties:
|
|
23597
|
+
recordTypes:
|
|
23598
|
+
type: array
|
|
23599
|
+
items:
|
|
23600
|
+
$ref: "#/components/schemas/RecordTypeInfo"
|
|
23601
|
+
required:
|
|
23602
|
+
- recordTypes
|
|
23432
23603
|
RunFlowResult:
|
|
23433
23604
|
type: object
|
|
23434
23605
|
additionalProperties: true
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@proveanything/smartlinks",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.0-alpha.1",
|
|
4
4
|
"description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -8,6 +8,10 @@
|
|
|
8
8
|
".": {
|
|
9
9
|
"types": "./dist/index.d.ts",
|
|
10
10
|
"default": "./dist/index.js"
|
|
11
|
+
},
|
|
12
|
+
"./testing": {
|
|
13
|
+
"types": "./dist/testing/index.d.ts",
|
|
14
|
+
"default": "./dist/testing/index.js"
|
|
11
15
|
}
|
|
12
16
|
},
|
|
13
17
|
"files": [
|
|
@@ -37,7 +41,8 @@
|
|
|
37
41
|
"author": "Glenn Shoosmith",
|
|
38
42
|
"license": "MIT",
|
|
39
43
|
"publishConfig": {
|
|
40
|
-
"access": "public"
|
|
44
|
+
"access": "public",
|
|
45
|
+
"tag": "next"
|
|
41
46
|
},
|
|
42
47
|
"dependencies": {
|
|
43
48
|
"cross-fetch": "^3.1.5"
|