@proveanything/smartlinks 2.0.55 → 2.0.57

package/openapi.yaml

@@ -123,7 +123,7 @@ paths:
     get:
       tags:
         - realtime
-      summary: Get an Ably token for admin real-time communication.
+      summary: (subscribe only).
       operationId: realtime_getAdminToken
       security:
         - bearerAuth: []
@@ -13960,7 +13960,7 @@ paths:
     get:
       tags:
         - realtime
-      summary: realtime.getPublicToken
+      summary: "`collection:{collectionId}:*` (subscribe; publish only for the collection's admins)."
       operationId: realtime_getPublicToken
       security: []
       parameters:
@@ -14018,6 +14018,33 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /public/realtime/publish:
+    post:
+      tags:
+        - realtime
+      summary: "One of your app's declared channels (manifest `realtime.channels`)."
+      operationId: realtime_channel
+      security: []
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                additionalProperties: true
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RealtimeScope"
   /public/tags/{tagId}:
     get:
       tags:
@@ -19618,10 +19645,15 @@ components:
           $ref: "#/components/schemas/AppManifestExecutor"
         functions:
           $ref: "#/components/schemas/AppManifestFunctions"
+        realtime:
+          type: object
+          additionalProperties: true
         data:
           $ref: "#/components/schemas/AppDataDeclaration"
         headless:
           $ref: "#/components/schemas/AppHeadlessDeclaration"
+        connector:
+          $ref: "#/components/schemas/AppConnectorDeclaration"
       required:
         - name
         - version
@@ -19629,6 +19661,268 @@ components:
         - function
         - files
         - components
+    ConnectorConnectionField:
+      type: object
+      properties:
+        name:
+          type: string
+        label:
+          type: string
+        description:
+          type: string
+        secret:
+          type: string
+        required:
+          type: boolean
+        type:
+          type: string
+          enum:
+            - text
+            - url
+            - select
+            - number
+            - boolean
+        options:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        placeholder:
+          type: string
+      required:
+        - name
+        - label
+    ConnectorPreset:
+      type: object
+      properties:
+        id:
+          type: string
+        title:
+          type: string
+        description:
+          type: string
+        direction:
+          type: string
+          enum:
+            - inbound
+            - outbound
+        entity:
+          type: string
+        flow:
+          type: object
+          additionalProperties: true
+      required:
+        - id
+        - title
+        - direction
+        - entity
+    ConnectorPanel:
+      type: object
+      properties:
+        id:
+          type: string
+        title:
+          type: string
+        component:
+          type: string
+      required:
+        - id
+        - title
+        - component
+    AppConnectorDeclaration:
+      type: object
+      properties:
+        provider:
+          type: string
+        title:
+          type: string
+        directions:
+          type: array
+          items:
+            type: string
+            enum:
+              - inbound
+              - outbound
+        entities:
+          type: array
+          items:
+            type: string
+        connection:
+          type: object
+          additionalProperties: true
+        settings:
+          type: object
+          additionalProperties: true
+        presets:
+          type: array
+          items:
+            $ref: "#/components/schemas/ConnectorPreset"
+        functions:
+          type: object
+          additionalProperties: true
+        testConnection:
+          type: string
+        describeTarget:
+          type: string
+        sample:
+          type: string
+        transform:
+          type: string
+        send:
+          type: string
+        fetch:
+          type: string
+        panels:
+          type: array
+          items:
+            $ref: "#/components/schemas/ConnectorPanel"
+        aiGuide:
+          type: string
+      required:
+        - provider
+        - directions
+        - entities
+        - functions
+    ConnectorInstallation:
+      type: object
+      properties:
+        collectionId:
+          type: string
+        appId:
+          type: string
+        flowId:
+          type: string
+        connection:
+          type: object
+          additionalProperties: true
+        settings:
+          type: object
+          additionalProperties: true
+      required:
+        - collectionId
+        - appId
+        - connection
+        - settings
+    ConnectorTestResult:
+      type: object
+      properties:
+        ok:
+          type: boolean
+        message:
+          type: string
+      required:
+        - ok
+        - message
+    ConnectorTargetField:
+      type: object
+      properties:
+        path:
+          type: string
+        label:
+          type: string
+        type:
+          type: string
+          enum:
+            - string
+            - number
+            - boolean
+            - date
+            - object
+            - array
+        required:
+          type: boolean
+        description:
+          type: string
+        enum:
+          type: array
+          items:
+            type: string
+      required:
+        - path
+    ConnectorTargetSchema:
+      type: object
+      properties:
+        fields:
+          type: array
+          items:
+            $ref: "#/components/schemas/ConnectorTargetField"
+      required:
+        - fields
+    ConnectorRecords:
+      type: object
+      properties:
+        records:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        nextCursor:
+          type: string
+      required:
+        - records
+    ConnectorTransformInput:
+      type: object
+      properties:
+        installation:
+          $ref: "#/components/schemas/ConnectorInstallation"
+        records:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        mapping:
+          type: array
+          items:
+            $ref: "#/components/schemas/FieldMapping"
+      required:
+        - installation
+        - records
+        - mapping
+    ConnectorTransformResult:
+      type: object
+      properties:
+        payloads:
+          type: array
+          items: {}
+        skipped:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+      required:
+        - payloads
+    ConnectorSendInput:
+      type: object
+      properties:
+        installation:
+          $ref: "#/components/schemas/ConnectorInstallation"
+        payloads:
+          type: array
+          items: {}
+      required:
+        - installation
+        - payloads
+    ConnectorSendResult:
+      type: object
+      properties:
+        results:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+      required:
+        - results
+    ConnectorFetchInput:
+      type: object
+      properties:
+        installation:
+          $ref: "#/components/schemas/ConnectorInstallation"
+        cursor:
+          type: string
+        limit:
+          type: number
+      required:
+        - installation
     CollectionAppWidget:
       type: object
       properties:
@@ -25883,6 +26177,18 @@ components:
             type: string
         auth:
           $ref: "#/components/schemas/FlowConnectionAuth"
+    FlowConnectorRef:
+      type: object
+      properties:
+        appId:
+          type: string
+        preset:
+          type: string
+        settings:
+          type: object
+          additionalProperties: true
+      required:
+        - appId
     IntegrationFlowConfig:
       type: object
       properties:
@@ -25892,6 +26198,8 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/FieldMapping"
+        connector:
+          $ref: "#/components/schemas/FlowConnectorRef"
     IntegrationFlow:
       type: object
       properties:
@@ -26024,6 +26332,12 @@ components:
           type: number
         failed:
           type: number
+        created:
+          type: number
+        updated:
+          type: number
+        skipped:
+          type: number
         status:
           $ref: "#/components/schemas/RunStatus"
         runId:
@@ -26032,9 +26346,47 @@ components:
         - flowId
         - direction
         - records
-        - sent
         - failed
         - status
+    InstalledConnector:
+      type: object
+      properties:
+        appId:
+          type: string
+        name:
+          type: string
+        channel:
+          type: string
+        version:
+          type: string
+        connector:
+          type: object
+          additionalProperties: true
+        installation:
+          type: object
+          additionalProperties: true
+        secrets:
+          type: object
+          additionalProperties:
+            type: object
+            additionalProperties: true
+      required:
+        - appId
+        - name
+        - channel
+        - version
+        - connector
+        - installation
+        - secrets
+    SaveConnectorInstallationInput:
+      type: object
+      properties:
+        connection:
+          type: object
+          additionalProperties: true
+        settings:
+          type: object
+          additionalProperties: true
     CapturedRequest:
       type: object
       properties:
@@ -26376,6 +26728,13 @@ components:
         - none
     UpdateFlowInput:
       $ref: "#/components/schemas/CreateFlowInput"
+    ConnectorConsoleStep:
+      type: string
+      enum:
+        - testConnection
+        - describeTarget
+        - sample
+        - transform
     RunTrigger:
       type: string
       enum:
@@ -29830,6 +30189,79 @@ components:
         - nonce
         - mac
         - clientId
+    RealtimeScope:
+      type: object
+      properties:
+        collectionId:
+          type: string
+        appId:
+          type: string
+      required:
+        - collectionId
+    RealtimeMessage:
+      type: object
+      properties:
+        channel:
+          type: string
+        event:
+          type: string
+        data: {}
+        at:
+          type: number
+      required:
+        - channel
+        - event
+        - data
+    RealtimeChangeEvent:
+      type: object
+      properties:
+        type:
+          type: string
+        id:
+          type: string
+        appId:
+          type: string
+        recordType:
+          type: string
+        productId:
+          type: string
+        proofId:
+          type: string
+        status:
+          type: string
+        at:
+          type: number
+      required:
+        - type
+        - at
+    RealtimeChangeFilter:
+      type: object
+      properties:
+        type:
+          type: string
+        id:
+          type: string
+        appId:
+          type: string
+        recordType:
+          type: string
+        productId:
+          type: string
+        proofId:
+          type: string
+    RealtimeChannelDeclaration:
+      type: object
+      properties:
+        name:
+          type: string
+        subscribe:
+          type: object
+          additionalProperties: true
+        publish:
+          type: object
+          additionalProperties: true
+      required:
+        - name
     RealtimeChannelPattern:
       type: string
     ResearchFetchRequest:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "2.0.55",
+  "version": "2.0.57",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "type": "module",
   "main": "dist/index.js",

package/scripts/doctor.mjs

@@ -313,6 +313,31 @@ if (meta.respectsHostTheme) {
   if (embeds && !handRolled.length && !blocked.size) console.log(`${GREEN}✓${RESET} embedded widgets ${DIM}— ${embeds} via the host's EmbeddedWidget${RESET}`);
 }
 
+// ---- realtime: SL.realtime, never a provider library or key in the app ---------------------------
+// SmartLinks Realtime (docs/realtime.md) hands out the stream and checks every publish; an app that talks
+// to the provider directly bypasses the channel rules (and a provider key in a bundle is a key for all).
+{
+  const EXT = /\.(tsx|ts|jsx|js)$/;
+  const SKIP = new Set(['node_modules', 'dist', '.git', 'public']);
+  const hitsRt = [];
+  (function walkRt(dir) {
+    let entries = [];
+    try { entries = readdirSync(dir, { withFileTypes: true }); } catch { return; }
+    for (const e of entries) {
+      if (e.isDirectory()) { if (!SKIP.has(e.name)) walkRt(join(dir, e.name)); }
+      else if (EXT.test(e.name)) {
+        const f = join(dir, e.name);
+        const text = readFileSync(f, 'utf8');
+        if (/from\s+['"]ably(\/[^'"]*)?['"]|require\(\s*['"]ably['"]\s*\)|ABLY_(API_)?KEY/.test(text)) hitsRt.push(f.startsWith(appDir) ? f.slice(appDir.length + 1) : f);
+      }
+    }
+  })(existsSync(join(appDir, 'src')) ? join(appDir, 'src') : appDir);
+  if (hitsRt.length) {
+    console.log(`${YELLOW}⚠${RESET} realtime — talks to the realtime provider directly in ${hitsRt.slice(0, 3).join(', ')}`);
+    warnings.push(`${hitsRt.join(', ')} use${hitsRt.length === 1 ? 's' : ''} the realtime provider (Ably) directly. Use SL.realtime instead — declare channels in the manifest (realtime.channels) and use realtime.channel() / onChange() (docs/realtime.md); never put a provider key in an app.`);
+  }
+}
+
 // ---- package.json scripts point at files that exist ------------------------------------------
 // An upgrade that copies a script LINE but not the script FILE breaks every build at that step
 // (e.g. `postbuild: node scripts/smartlinks-deploy.mjs` with no scripts/smartlinks-deploy.mjs).