viasocket-apps 0.2.0 → 0.3.0

package/README.md

@@ -88,9 +88,9 @@ const subscription = await user.subscribe(triggerVersionId, {
 import { connect } from 'viasocket-apps/browser'
 
 // embedToken comes from your backend (user.token()), signed for the signed-in user.
-// actions (optional): the rowids of the actions and triggers you use — the popup then asks only
+// actions (optional): the action_ids and trigger_ids you use — the popup then asks only
 // for their scopes; skipActionSelection goes straight to the app's consent screen.
-const { authId } = await connect({ embedToken, serviceId: 'rowbu58rc', actions: ['<action rowid>'], skipActionSelection: true })
+const { authId } = await connect({ embedToken, serviceId: 'rowbu58rc', actions: ['<action_id>'], skipActionSelection: true })
 // Send authId to your backend, which enables the app and stores the script_id.
 ```
 
@@ -108,8 +108,8 @@ const { authId } = await connect({ embedToken, serviceId: 'rowbu58rc', actions:
 | `user.listOptions(actionVersionId, { fieldKey, authId, existingFields })` | The values a field accepts, as `{ options, offset }`. Both response shapes normalised; an unreadable connection (revoked, another user's `auth_id`) throws a `ViaSocketError` with status 400 even though the API answers 200. |
 | `viasocket.runAction(scriptId, actionVersionId, inputData)` | Run one action. Returns the app's own response. |
 | `viasocket.catalog.search(key)` | The best 30 apps for what the user typed, as `{ serviceId, name, iconUrl, description }`. No token. |
-| `viasocket.catalog.list({ limit, offset, category })` | Every app, most used first, 200 a page; an empty page ends it. Drop apps whose `versions()` is empty. No token. |
-| `viasocket.catalog.versions(serviceId)` | Every published action and trigger of one app, as `{ actions, triggers }`, each with its `inputjson` schema and version id. No token. |
+| `viasocket.catalog.list({ limit, offset, category })` | Every app, most used first, 200 a page; an empty page ends it. Drop apps whose `versions()` is `null` or empty. No token. |
+| `viasocket.catalog.versions(serviceId)` | One app and every published action and trigger of it, as `{ service, actions, triggers }`. Each action has `action_id` and `action_version_id`, each trigger `trigger_id` and `trigger_version_id`, named as the calls take them: the version id for `runAction`, `listOptions` and `subscribe`; the other for `connect`, automations and the prebuilt UI. `input_schema` is the form schema. `null` for an unknown id. No token. |
 | `user.subscribe(triggerVersionId, { authId, inputData, code \| webhook, meta })` | Subscribe to an app event with a handler we run per event. Returns `{ scriptId, hookUrl, … }`. |
 | `user.updateSubscription(scriptId, { code, meta })` | Change a live subscription in place. |
 

package/dist/cjs/client.js

@@ -19,7 +19,7 @@ const DEFAULT_RUN_BASE_URL = 'https://flow.sokt.io';
 const CATALOG = {
     search: 'https://flow.sokt.io/func/scri12BSufQM',
     list: 'https://plug-service.viasocket.com/api/v1/plugins/all',
-    versions: 'https://flow.sokt.io/func/scriolZue69X'
+    versions: 'https://flow.sokt.io/func/scriK4LFg2kc'
 };
 const LIST_LIMIT_MAX = 200;
 function required(name, value) {
@@ -95,9 +95,13 @@ class ViaSocket {
             }));
         },
         /**
-         * Every published action and trigger of one app, with the schema (`inputjson`) a form is
-         * rendered from and the version id the run and subscribe calls take. Empty for an app with
-         * nothing published. Cache it per app; ids are stable and schemas change rarely.
+         * One app and every published action and trigger of it, as `{ service, actions, triggers }`.
+         * Each action carries `action_id` and `action_version_id`, each trigger `trigger_id` and
+         * `trigger_version_id` — named as the calls take them: the version id for `runAction`,
+         * `listOptions` and `subscribe`; the other for `connect`, automations and the prebuilt UI.
+         * `input_schema` is the field schema a form is rendered from. `null` for an unknown service id
+         * (the API answers 200 with an empty service); empty arrays for an app with nothing published.
+         * Cache it per app; ids are stable and schemas change rarely.
          */
         versions: async (serviceId) => {
             const { data } = await (0, http_js_1.request)({
@@ -106,8 +110,16 @@ class ViaSocket {
                 body: JSON.stringify({ service_id: required('serviceId', serviceId) }),
                 fetchImpl: this.transport
             });
-            const rows = Array.isArray(data) ? data : [];
-            return { actions: rows.filter((row) => row.type === 'action'), triggers: rows.filter((row) => row.type === 'trigger') };
+            // No `success` key, so the body arrives whole as `data`; tolerate an envelope anyway.
+            const body = (data && 'service' in data ? data : data?.data) ?? {};
+            const service = body.service;
+            if (!service?.name)
+                return null;
+            return {
+                service,
+                actions: Array.isArray(body.actions) ? body.actions : [],
+                triggers: Array.isArray(body.triggers) ? body.triggers : []
+            };
         }
     };
     /** Everything that is done for one of your end users. */

package/dist/esm/browser.d.ts

@@ -28,8 +28,9 @@ export interface ConnectOptions {
     /** The app to connect. Its service_id is shown on every app in the Apps API reference. */
     serviceId: string;
     /**
-     * The rowids of the actions and triggers this product uses (each is listed with its action in
-     * the app's document). The popup then asks only for their scopes. Omit to offer every action.
+     * The `action_id`s and `trigger_id`s this product uses (listed under each one in the app's
+     * document and in `catalog.versions()`). The popup then asks only for their scopes. Omit to
+     * offer every action. Never a version id.
      */
     actions?: string[];
     /** With `actions`: skip the action list and open the app's consent screen directly. */

package/dist/esm/client.d.ts

@@ -29,11 +29,15 @@ export declare class ViaSocket {
          */
         list: (params?: ListAppsParams) => Promise<CatalogApp[]>;
         /**
-         * Every published action and trigger of one app, with the schema (`inputjson`) a form is
-         * rendered from and the version id the run and subscribe calls take. Empty for an app with
-         * nothing published. Cache it per app; ids are stable and schemas change rarely.
+         * One app and every published action and trigger of it, as `{ service, actions, triggers }`.
+         * Each action carries `action_id` and `action_version_id`, each trigger `trigger_id` and
+         * `trigger_version_id` — named as the calls take them: the version id for `runAction`,
+         * `listOptions` and `subscribe`; the other for `connect`, automations and the prebuilt UI.
+         * `input_schema` is the field schema a form is rendered from. `null` for an unknown service id
+         * (the API answers 200 with an empty service); empty arrays for an app with nothing published.
+         * Cache it per app; ids are stable and schemas change rarely.
          */
-        versions: (serviceId: string) => Promise<CatalogVersions>;
+        versions: (serviceId: string) => Promise<CatalogVersions | null>;
     };
     /** Everything that is done for one of your end users. */
     user(uniqueIdentifier: string): UserScope;

package/dist/esm/client.js

@@ -16,7 +16,7 @@ const DEFAULT_RUN_BASE_URL = 'https://flow.sokt.io';
 const CATALOG = {
     search: 'https://flow.sokt.io/func/scri12BSufQM',
     list: 'https://plug-service.viasocket.com/api/v1/plugins/all',
-    versions: 'https://flow.sokt.io/func/scriolZue69X'
+    versions: 'https://flow.sokt.io/func/scriK4LFg2kc'
 };
 const LIST_LIMIT_MAX = 200;
 function required(name, value) {
@@ -92,9 +92,13 @@ export class ViaSocket {
             }));
         },
         /**
-         * Every published action and trigger of one app, with the schema (`inputjson`) a form is
-         * rendered from and the version id the run and subscribe calls take. Empty for an app with
-         * nothing published. Cache it per app; ids are stable and schemas change rarely.
+         * One app and every published action and trigger of it, as `{ service, actions, triggers }`.
+         * Each action carries `action_id` and `action_version_id`, each trigger `trigger_id` and
+         * `trigger_version_id` — named as the calls take them: the version id for `runAction`,
+         * `listOptions` and `subscribe`; the other for `connect`, automations and the prebuilt UI.
+         * `input_schema` is the field schema a form is rendered from. `null` for an unknown service id
+         * (the API answers 200 with an empty service); empty arrays for an app with nothing published.
+         * Cache it per app; ids are stable and schemas change rarely.
          */
         versions: async (serviceId) => {
             const { data } = await request({
@@ -103,8 +107,16 @@ export class ViaSocket {
                 body: JSON.stringify({ service_id: required('serviceId', serviceId) }),
                 fetchImpl: this.transport
             });
-            const rows = Array.isArray(data) ? data : [];
-            return { actions: rows.filter((row) => row.type === 'action'), triggers: rows.filter((row) => row.type === 'trigger') };
+            // No `success` key, so the body arrives whole as `data`; tolerate an envelope anyway.
+            const body = (data && 'service' in data ? data : data?.data) ?? {};
+            const service = body.service;
+            if (!service?.name)
+                return null;
+            return {
+                service,
+                actions: Array.isArray(body.actions) ? body.actions : [],
+                triggers: Array.isArray(body.triggers) ? body.triggers : []
+            };
         }
     };
     /** Everything that is done for one of your end users. */

package/dist/esm/index.d.ts

@@ -18,4 +18,4 @@ export { ViaSocket, UserScope } from './client.js';
 export { ViaSocketError } from './errors.js';
 export { signEmbedToken } from './token.js';
 export type { SignEmbedTokenInput } from './token.js';
-export type { CatalogApp, CatalogVersion, CatalogVersions, EnableResult, Envelope, Flow, FlowStatus, ListAppsParams, ListOptionsParams, ListOptionsResult, Option, SubscribeParams, SubscribeResult, UpdateSubscriptionParams, ViaSocketOptions } from './types.js';
+export type { CatalogApp, CatalogAction, CatalogService, CatalogTrigger, CatalogVersion, CatalogVersions, EnableResult, Envelope, Flow, FlowStatus, ListAppsParams, ListOptionsParams, ListOptionsResult, Option, SubscribeParams, SubscribeResult, UpdateSubscriptionParams, ViaSocketOptions } from './types.js';

package/dist/esm/types.d.ts

@@ -116,24 +116,60 @@ export interface ListAppsParams {
     /** One of the catalog's category names, e.g. "CRM". */
     category?: string;
 }
-/** One published action or trigger version of an app, as the catalog returns it. */
-export interface CatalogVersion {
-    /** The `action_version_id` (or trigger version id) the run and subscribe calls take. */
-    actionversionrecordid: string;
-    type: 'action' | 'trigger' | string;
+/** The app, once, at the top of `catalog.versions()`. */
+export interface CatalogService {
+    service_id: string;
+    /** The display name. The API sends `null` for an unknown id; `versions()` then returns `null` instead of a catalog. */
+    name: string;
+    description: string | null;
+    icon_url: string | null;
+    /** `Auth2.0`, `apikey`, `NoAuth`, … Informational: connect handles it. */
+    auth_type: string | null;
+    /** `false` for an app without sign-in: no connect button, and `'NoAuth'` wherever a call takes an `authId`. */
+    requires_auth: boolean;
+}
+interface CatalogEventBase {
     name: string;
     description: string;
-    /** The field schema a form is rendered from; `inputData` follows it. */
-    inputjson: Record<string, unknown>;
-    sampledata?: unknown;
-    pluginrecordid?: string;
-    iconurl?: string;
-    authtype?: string;
+    /**
+     * The field schema a form is rendered from; `inputData` follows it. A block with a `source` or
+     * `optionsGenerator` key is a picker: fill it with `listOptions`, never by running what the key holds.
+     */
+    input_schema: Record<string, unknown>;
+    /** A real response of the action, or a real event payload of the trigger. */
+    sample_output?: unknown;
+    updated_at?: string;
     [key: string]: unknown;
 }
+/** One published action, its two ids named as the calls take them. */
+export interface CatalogAction extends CatalogEventBase {
+    /**
+     * The action’s own id: what `connect`’s `actions`, an automation step’s `action_id` and the
+     * prebuilt UI’s `open: { actionId }` take. Looks like the version id and is not interchangeable with it.
+     */
+    action_id: string;
+    /** What `runAction` and `listOptions` take — and only those. */
+    action_version_id: string;
+}
+/** One published trigger, its two ids named as the calls take them. */
+export interface CatalogTrigger extends CatalogEventBase {
+    /**
+     * The trigger’s own id: what `connect`’s `actions`, an automation’s `trigger_id` and the prebuilt
+     * UI’s `open: { triggerId }` take. Looks like the version id and is not interchangeable with it.
+     */
+    trigger_id: string;
+    /** What `subscribe` and `listOptions` take — and only those. */
+    trigger_version_id: string;
+    /** Not reliable yet: the API answers `true` for every trigger. */
+    polled?: boolean | null;
+}
+/** @deprecated The catalog no longer returns rows of one shape; use `CatalogAction` and `CatalogTrigger`. */
+export type CatalogVersion = CatalogAction | CatalogTrigger;
+/** What `catalog.versions()` returns for a known app. */
 export interface CatalogVersions {
-    actions: CatalogVersion[];
-    triggers: CatalogVersion[];
+    service: CatalogService;
+    actions: CatalogAction[];
+    triggers: CatalogTrigger[];
 }
 export interface Envelope<T = unknown> {
     success: boolean;
@@ -141,3 +177,4 @@ export interface Envelope<T = unknown> {
     data: T;
     isCached?: boolean;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "viasocket-apps",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Server-side client for the viaSocket Apps API: let your users connect Slack, GitHub, Google Sheets or any of 2,300+ apps from your own product, then run actions and receive events through one API.",
   "keywords": [
     "viasocket",