@proveanything/smartlinks 2.0.63 → 2.0.64
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/docs/API_SUMMARY.md +3 -1
- package/dist/docs/connectors.md +1 -1
- package/dist/docs/server-functions.md +1 -0
- package/dist/openapi.yaml +10 -0
- package/dist/types/appManifest.d.ts +11 -0
- package/docs/API_SUMMARY.md +3 -1
- package/docs/connectors.md +1 -1
- package/docs/server-functions.md +1 -0
- package/openapi.yaml +10 -0
- package/package.json +1 -1
package/dist/docs/API_SUMMARY.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Smartlinks API Summary
|
|
2
2
|
|
|
3
|
-
Version: 2.0.
|
|
3
|
+
Version: 2.0.64 | Generated: 2026-10-14T09:37:13.261Z
|
|
4
4
|
|
|
5
5
|
This is a concise summary of all available API functions and types.
|
|
6
6
|
|
|
@@ -3095,6 +3095,8 @@ interface ConnectorShapeResult {
|
|
|
3095
3095
|
interface ConnectorSerializeInput {
|
|
3096
3096
|
installation: ConnectorInstallation
|
|
3097
3097
|
documents: Array<Record<string, unknown>>
|
|
3098
|
+
entities?: Array<{ id: string | null; name?: string | null; deleted?: boolean }>
|
|
3099
|
+
targetOptions?: Record<string, Record<string, unknown>>
|
|
3098
3100
|
eventType?: string
|
|
3099
3101
|
}
|
|
3100
3102
|
```
|
package/dist/docs/connectors.md
CHANGED
|
@@ -110,7 +110,7 @@ declare the provider's hosts (`network:<host>`) and the secrets it reads (`secre
|
|
|
110
110
|
| `sample` | Mapper, AI assist, dry run | `{ installation, limit }` | `ConnectorRecords` `{ records }`: real provider records |
|
|
111
111
|
| `fetch` | Every inbound run | `ConnectorFetchInput` `{ installation, cursor, limit }` | `ConnectorRecords` `{ records, nextCursor }`: one page per call |
|
|
112
112
|
| `shape` | Every inbound run (and sample dry runs) | `ConnectorShapeInput` `{ installation, records }` | `ConnectorShapeResult` `{ documents, skipped }`: one provider-neutral document per record, same order; `null` skips one |
|
|
113
|
-
| `serialize` | Every outbound run | `ConnectorSerializeInput` `{ installation, documents, eventType? }`: documents core mapped to `describeTarget` paths; a deletion arrives as `{ id, _deleted: true }` | `ConnectorSerializeResult` `{ payloads, skipped }`: one provider payload per document, same order; `null` skips one |
|
|
113
|
+
| `serialize` | Every outbound run | `ConnectorSerializeInput` `{ installation, documents, entities, targetOptions, eventType? }`: documents core mapped to `describeTarget` paths; `entities` = the SmartLinks record each came from (id, name); `targetOptions` = per-field options the mapping carries (e.g. locale, unit); a deletion arrives as `{ id, _deleted: true }` | `ConnectorSerializeResult` `{ payloads, skipped }`: one provider payload per document, same order; `null` skips one |
|
|
114
114
|
| `send` | Every outbound run | `ConnectorSendInput` `{ installation, payloads }` | `ConnectorSendResult` `{ results: [{ index, ok, status, error, externalId }] }` |
|
|
115
115
|
|
|
116
116
|
**How a run flows:**
|
|
@@ -167,6 +167,7 @@ Declare the minimum you need.
|
|
|
167
167
|
| `sl:<resource>:read` / `sl:<resource>:write` | SDK access to that resource, e.g. `sl:products:read`, `sl:records:write`, `sl:attestations:write`, `sl:contacts:write`. |
|
|
168
168
|
| `network` | `ctx.fetch` to any host. |
|
|
169
169
|
| `network:<host>` | `ctx.fetch` to that host only (repeat for several). Prefer this over blanket `network`. |
|
|
170
|
+
| `network:*.<domain>` | `ctx.fetch` to any subdomain of `<domain>` (not `<domain>` itself), for a customer's own endpoint at a provider, e.g. `network:*.servicebus.windows.net`. `<domain>` needs at least two labels (`*.com` is not honoured). |
|
|
170
171
|
| `secrets:<name>` | `ctx.secrets.get('<name>')` for that one secret (see [Secrets](#secrets--api-keys-per-collection)). |
|
|
171
172
|
|
|
172
173
|
If you don't declare `network`, `ctx.fetch` is absent. Reading a secret you didn't declare with
|
package/dist/openapi.yaml
CHANGED
|
@@ -20172,6 +20172,16 @@ components:
|
|
|
20172
20172
|
items:
|
|
20173
20173
|
type: object
|
|
20174
20174
|
additionalProperties: true
|
|
20175
|
+
entities:
|
|
20176
|
+
type: array
|
|
20177
|
+
items:
|
|
20178
|
+
type: object
|
|
20179
|
+
additionalProperties: true
|
|
20180
|
+
targetOptions:
|
|
20181
|
+
type: object
|
|
20182
|
+
additionalProperties:
|
|
20183
|
+
type: object
|
|
20184
|
+
additionalProperties: true
|
|
20175
20185
|
eventType:
|
|
20176
20186
|
type: string
|
|
20177
20187
|
required:
|
|
@@ -1010,6 +1010,17 @@ export interface ConnectorShapeResult {
|
|
|
1010
1010
|
export interface ConnectorSerializeInput {
|
|
1011
1011
|
installation: ConnectorInstallation;
|
|
1012
1012
|
documents: Array<Record<string, unknown>>;
|
|
1013
|
+
/** The SmartLinks record each document came from (same order): its id and name, e.g. for an envelope's own id. */
|
|
1014
|
+
entities?: Array<{
|
|
1015
|
+
id: string | null;
|
|
1016
|
+
name?: string | null;
|
|
1017
|
+
deleted?: boolean;
|
|
1018
|
+
}>;
|
|
1019
|
+
/**
|
|
1020
|
+
* Options the flow's mapping carries per target field (keyed by target path), beyond the mapping
|
|
1021
|
+
* itself — e.g. { "brand": { "locale": "en-GB", "uom": "kg" } }. Data for the wire format, not mapping logic.
|
|
1022
|
+
*/
|
|
1023
|
+
targetOptions?: Record<string, Record<string, unknown>>;
|
|
1013
1024
|
/** The event that triggered the run, e.g. 'product.updated' (absent for manual / scheduled runs). */
|
|
1014
1025
|
eventType?: string;
|
|
1015
1026
|
}
|
package/docs/API_SUMMARY.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Smartlinks API Summary
|
|
2
2
|
|
|
3
|
-
Version: 2.0.
|
|
3
|
+
Version: 2.0.64 | Generated: 2026-10-14T09:37:13.261Z
|
|
4
4
|
|
|
5
5
|
This is a concise summary of all available API functions and types.
|
|
6
6
|
|
|
@@ -3095,6 +3095,8 @@ interface ConnectorShapeResult {
|
|
|
3095
3095
|
interface ConnectorSerializeInput {
|
|
3096
3096
|
installation: ConnectorInstallation
|
|
3097
3097
|
documents: Array<Record<string, unknown>>
|
|
3098
|
+
entities?: Array<{ id: string | null; name?: string | null; deleted?: boolean }>
|
|
3099
|
+
targetOptions?: Record<string, Record<string, unknown>>
|
|
3098
3100
|
eventType?: string
|
|
3099
3101
|
}
|
|
3100
3102
|
```
|
package/docs/connectors.md
CHANGED
|
@@ -110,7 +110,7 @@ declare the provider's hosts (`network:<host>`) and the secrets it reads (`secre
|
|
|
110
110
|
| `sample` | Mapper, AI assist, dry run | `{ installation, limit }` | `ConnectorRecords` `{ records }`: real provider records |
|
|
111
111
|
| `fetch` | Every inbound run | `ConnectorFetchInput` `{ installation, cursor, limit }` | `ConnectorRecords` `{ records, nextCursor }`: one page per call |
|
|
112
112
|
| `shape` | Every inbound run (and sample dry runs) | `ConnectorShapeInput` `{ installation, records }` | `ConnectorShapeResult` `{ documents, skipped }`: one provider-neutral document per record, same order; `null` skips one |
|
|
113
|
-
| `serialize` | Every outbound run | `ConnectorSerializeInput` `{ installation, documents, eventType? }`: documents core mapped to `describeTarget` paths; a deletion arrives as `{ id, _deleted: true }` | `ConnectorSerializeResult` `{ payloads, skipped }`: one provider payload per document, same order; `null` skips one |
|
|
113
|
+
| `serialize` | Every outbound run | `ConnectorSerializeInput` `{ installation, documents, entities, targetOptions, eventType? }`: documents core mapped to `describeTarget` paths; `entities` = the SmartLinks record each came from (id, name); `targetOptions` = per-field options the mapping carries (e.g. locale, unit); a deletion arrives as `{ id, _deleted: true }` | `ConnectorSerializeResult` `{ payloads, skipped }`: one provider payload per document, same order; `null` skips one |
|
|
114
114
|
| `send` | Every outbound run | `ConnectorSendInput` `{ installation, payloads }` | `ConnectorSendResult` `{ results: [{ index, ok, status, error, externalId }] }` |
|
|
115
115
|
|
|
116
116
|
**How a run flows:**
|
package/docs/server-functions.md
CHANGED
|
@@ -167,6 +167,7 @@ Declare the minimum you need.
|
|
|
167
167
|
| `sl:<resource>:read` / `sl:<resource>:write` | SDK access to that resource, e.g. `sl:products:read`, `sl:records:write`, `sl:attestations:write`, `sl:contacts:write`. |
|
|
168
168
|
| `network` | `ctx.fetch` to any host. |
|
|
169
169
|
| `network:<host>` | `ctx.fetch` to that host only (repeat for several). Prefer this over blanket `network`. |
|
|
170
|
+
| `network:*.<domain>` | `ctx.fetch` to any subdomain of `<domain>` (not `<domain>` itself), for a customer's own endpoint at a provider, e.g. `network:*.servicebus.windows.net`. `<domain>` needs at least two labels (`*.com` is not honoured). |
|
|
170
171
|
| `secrets:<name>` | `ctx.secrets.get('<name>')` for that one secret (see [Secrets](#secrets--api-keys-per-collection)). |
|
|
171
172
|
|
|
172
173
|
If you don't declare `network`, `ctx.fetch` is absent. Reading a secret you didn't declare with
|
package/openapi.yaml
CHANGED
|
@@ -20172,6 +20172,16 @@ components:
|
|
|
20172
20172
|
items:
|
|
20173
20173
|
type: object
|
|
20174
20174
|
additionalProperties: true
|
|
20175
|
+
entities:
|
|
20176
|
+
type: array
|
|
20177
|
+
items:
|
|
20178
|
+
type: object
|
|
20179
|
+
additionalProperties: true
|
|
20180
|
+
targetOptions:
|
|
20181
|
+
type: object
|
|
20182
|
+
additionalProperties:
|
|
20183
|
+
type: object
|
|
20184
|
+
additionalProperties: true
|
|
20175
20185
|
eventType:
|
|
20176
20186
|
type: string
|
|
20177
20187
|
required:
|