memorysync-sdk 1.3.0 → 1.4.0

package/dist/index.d.mts

@@ -64,8 +64,20 @@ declare class SlackNamespace extends Namespace {
     availableChannels(connectionId: string, query?: Json): Promise<Json>;
     /** Channels currently selected for syncing. */
     channels(connectionId: string): Promise<Json>;
-    /** Select channels for syncing. */
-    addChannels(connectionId: string, channelIds: string[]): Promise<Json>;
+    /**
+     * Select channels for syncing.
+     *
+     * Accepts bare channel ids, which is the common case, or objects carrying the
+     * name and type across so the server does not have to look them up again:
+     *
+     * ```ts
+     * await client.connections.slack.addChannels("c1", ["C0123", "C0456"]);
+     * await client.connections.slack.addChannels("c1", [
+     *   { id: "C0123", name: "support", is_private: false },
+     * ]);
+     * ```
+     */
+    addChannels(connectionId: string, channels: Array<string | Json>): Promise<Json>;
     /** Stop syncing one channel. */
     removeChannel(connectionId: string, channelId: string): Promise<Json>;
     /**
@@ -100,15 +112,38 @@ declare class S3Namespace extends Namespace {
     availablePrefixes(connectionId: string, query?: Json): Promise<Json>;
     /** Prefixes currently selected for syncing. */
     prefixes(connectionId: string): Promise<Json>;
-    /** Select prefixes for syncing. */
-    addPrefixes(connectionId: string, prefixes: string[]): Promise<Json>;
     /**
-     * Stop syncing the given prefixes.
+     * Select prefixes for syncing.
+     *
+     * Accepts bare prefixes, or objects carrying `bucket` and `label`:
+     *
+     * ```ts
+     * await client.connections.s3.addPrefixes("c1", ["handbook/", "policies/"]);
+     * await client.connections.s3.addPrefixes("c1", [
+     *   { prefix: "handbook/", label: "Handbook" },
+     * ]);
+     * ```
+     *
+     * An empty string means the bucket root. The bucket defaults to the one the
+     * connection's credentials were validated against, and the API rejects any
+     * other bucket rather than indexing one nobody proved access to.
+     */
+    addPrefixes(connectionId: string, prefixes: Array<string | Json>): Promise<Json>;
+    /**
+     * Revoke one prefix approval, optionally purging what it produced.
+     *
+     * The prefix travels as a query parameter, not in the body and not as a path
+     * segment: prefixes contain slashes, which a path segment cannot carry
+     * unambiguously, and this endpoint reads no body at all.
      *
-     * The prefixes travel in the body rather than the path because they contain
-     * slashes, which is why this DELETE carries one.
+     * Pass `purge: true` to also delete the memories already derived from the
+     * prefix. The default leaves them in place, so revoking an approval does not
+     * silently destroy knowledge.
      */
-    removePrefixes(connectionId: string, prefixes: string[]): Promise<Json>;
+    removePrefix(connectionId: string, prefix?: string, options?: {
+        bucket?: string;
+        purge?: boolean;
+    }): Promise<Json>;
     /** Keys and patterns this connection will never sync. */
     exclusionPolicy(connectionId: string): Promise<Json>;
     /** Replace this connection's additions to the exclusion policy. */
@@ -134,8 +169,14 @@ declare class GranolaNamespace extends Namespace {
     identities(connectionId: string): Promise<Json>;
     /** Map a participant to a MemorySync end user. */
     linkIdentity(connectionId: string, body: Json): Promise<Json>;
-    /** Move an existing mapping to a different end user. */
-    relinkIdentity(connectionId: string, body: Json): Promise<Json>;
+    /**
+     * Re-run identity matching for this connection.
+     *
+     * Takes no arguments: the route reads no body and re-matches the whole roster.
+     * `body` is kept optional only so a forward-compatible field can be passed
+     * once the route grows one.
+     */
+    relinkIdentity(connectionId: string, body?: Json): Promise<Json>;
     /** Effective Granola settings for this connection. */
     settings(connectionId: string): Promise<Json>;
     /** Update Granola settings for this connection. */
@@ -171,6 +212,12 @@ declare class ConnectionsNamespace extends Namespace {
     /** One connection, including its status and last sync. */
     get(connectionId: string): Promise<Json>;
     /** Connect a provider that authenticates with an API key or bot token. */
+    /**
+     * Connect a provider that authenticates with an API key or bot token.
+     *
+     * The wire field is `provider_id`; the argument is named `provider` because
+     * that is what the rest of this namespace calls it.
+     */
     createWithApiKey(provider: string, apiKey: string, body?: Json): Promise<Json>;
     /** Connect a provider that needs a credential bundle, such as S3 keys. */
     createWithCredentials(provider: string, credentials: Json, body?: Json): Promise<Json>;

package/dist/index.d.ts

@@ -64,8 +64,20 @@ declare class SlackNamespace extends Namespace {
     availableChannels(connectionId: string, query?: Json): Promise<Json>;
     /** Channels currently selected for syncing. */
     channels(connectionId: string): Promise<Json>;
-    /** Select channels for syncing. */
-    addChannels(connectionId: string, channelIds: string[]): Promise<Json>;
+    /**
+     * Select channels for syncing.
+     *
+     * Accepts bare channel ids, which is the common case, or objects carrying the
+     * name and type across so the server does not have to look them up again:
+     *
+     * ```ts
+     * await client.connections.slack.addChannels("c1", ["C0123", "C0456"]);
+     * await client.connections.slack.addChannels("c1", [
+     *   { id: "C0123", name: "support", is_private: false },
+     * ]);
+     * ```
+     */
+    addChannels(connectionId: string, channels: Array<string | Json>): Promise<Json>;
     /** Stop syncing one channel. */
     removeChannel(connectionId: string, channelId: string): Promise<Json>;
     /**
@@ -100,15 +112,38 @@ declare class S3Namespace extends Namespace {
     availablePrefixes(connectionId: string, query?: Json): Promise<Json>;
     /** Prefixes currently selected for syncing. */
     prefixes(connectionId: string): Promise<Json>;
-    /** Select prefixes for syncing. */
-    addPrefixes(connectionId: string, prefixes: string[]): Promise<Json>;
     /**
-     * Stop syncing the given prefixes.
+     * Select prefixes for syncing.
+     *
+     * Accepts bare prefixes, or objects carrying `bucket` and `label`:
+     *
+     * ```ts
+     * await client.connections.s3.addPrefixes("c1", ["handbook/", "policies/"]);
+     * await client.connections.s3.addPrefixes("c1", [
+     *   { prefix: "handbook/", label: "Handbook" },
+     * ]);
+     * ```
+     *
+     * An empty string means the bucket root. The bucket defaults to the one the
+     * connection's credentials were validated against, and the API rejects any
+     * other bucket rather than indexing one nobody proved access to.
+     */
+    addPrefixes(connectionId: string, prefixes: Array<string | Json>): Promise<Json>;
+    /**
+     * Revoke one prefix approval, optionally purging what it produced.
+     *
+     * The prefix travels as a query parameter, not in the body and not as a path
+     * segment: prefixes contain slashes, which a path segment cannot carry
+     * unambiguously, and this endpoint reads no body at all.
      *
-     * The prefixes travel in the body rather than the path because they contain
-     * slashes, which is why this DELETE carries one.
+     * Pass `purge: true` to also delete the memories already derived from the
+     * prefix. The default leaves them in place, so revoking an approval does not
+     * silently destroy knowledge.
      */
-    removePrefixes(connectionId: string, prefixes: string[]): Promise<Json>;
+    removePrefix(connectionId: string, prefix?: string, options?: {
+        bucket?: string;
+        purge?: boolean;
+    }): Promise<Json>;
     /** Keys and patterns this connection will never sync. */
     exclusionPolicy(connectionId: string): Promise<Json>;
     /** Replace this connection's additions to the exclusion policy. */
@@ -134,8 +169,14 @@ declare class GranolaNamespace extends Namespace {
     identities(connectionId: string): Promise<Json>;
     /** Map a participant to a MemorySync end user. */
     linkIdentity(connectionId: string, body: Json): Promise<Json>;
-    /** Move an existing mapping to a different end user. */
-    relinkIdentity(connectionId: string, body: Json): Promise<Json>;
+    /**
+     * Re-run identity matching for this connection.
+     *
+     * Takes no arguments: the route reads no body and re-matches the whole roster.
+     * `body` is kept optional only so a forward-compatible field can be passed
+     * once the route grows one.
+     */
+    relinkIdentity(connectionId: string, body?: Json): Promise<Json>;
     /** Effective Granola settings for this connection. */
     settings(connectionId: string): Promise<Json>;
     /** Update Granola settings for this connection. */
@@ -171,6 +212,12 @@ declare class ConnectionsNamespace extends Namespace {
     /** One connection, including its status and last sync. */
     get(connectionId: string): Promise<Json>;
     /** Connect a provider that authenticates with an API key or bot token. */
+    /**
+     * Connect a provider that authenticates with an API key or bot token.
+     *
+     * The wire field is `provider_id`; the argument is named `provider` because
+     * that is what the rest of this namespace calls it.
+     */
     createWithApiKey(provider: string, apiKey: string, body?: Json): Promise<Json>;
     /** Connect a provider that needs a credential bundle, such as S3 keys. */
     createWithCredentials(provider: string, credentials: Json, body?: Json): Promise<Json>;

package/dist/index.js

@@ -90,6 +90,9 @@ var V1 = "/api/v1/integrations";
 function seg(value) {
   return encodeURIComponent(String(value));
 }
+function asItem(value, key) {
+  return typeof value === "string" ? { [key]: value } : value;
+}
 var Namespace = class {
   constructor(request) {
     this.req = request;
@@ -109,10 +112,22 @@ var SlackNamespace = class extends Namespace {
   channels(connectionId) {
     return this.req("GET", `${V2}/connections/${seg(connectionId)}/slack/channels`);
   }
-  /** Select channels for syncing. */
-  addChannels(connectionId, channelIds) {
+  /**
+   * Select channels for syncing.
+   *
+   * Accepts bare channel ids, which is the common case, or objects carrying the
+   * name and type across so the server does not have to look them up again:
+   *
+   * ```ts
+   * await client.connections.slack.addChannels("c1", ["C0123", "C0456"]);
+   * await client.connections.slack.addChannels("c1", [
+   *   { id: "C0123", name: "support", is_private: false },
+   * ]);
+   * ```
+   */
+  addChannels(connectionId, channels) {
     return this.req("POST", `${V2}/connections/${seg(connectionId)}/slack/channels`, {
-      body: { channel_ids: channelIds }
+      body: { channels: channels.map((c) => asItem(c, "id")) }
     });
   }
   /** Stop syncing one channel. */
@@ -179,22 +194,42 @@ var S3Namespace = class extends Namespace {
   prefixes(connectionId) {
     return this.req("GET", `${V2}/connections/${seg(connectionId)}/s3/prefixes`);
   }
-  /** Select prefixes for syncing. */
+  /**
+   * Select prefixes for syncing.
+   *
+   * Accepts bare prefixes, or objects carrying `bucket` and `label`:
+   *
+   * ```ts
+   * await client.connections.s3.addPrefixes("c1", ["handbook/", "policies/"]);
+   * await client.connections.s3.addPrefixes("c1", [
+   *   { prefix: "handbook/", label: "Handbook" },
+   * ]);
+   * ```
+   *
+   * An empty string means the bucket root. The bucket defaults to the one the
+   * connection's credentials were validated against, and the API rejects any
+   * other bucket rather than indexing one nobody proved access to.
+   */
   addPrefixes(connectionId, prefixes) {
     return this.req("POST", `${V2}/connections/${seg(connectionId)}/s3/prefixes`, {
-      body: { prefixes }
+      body: { prefixes: prefixes.map((p) => asItem(p, "prefix")) }
     });
   }
   /**
-   * Stop syncing the given prefixes.
+   * Revoke one prefix approval, optionally purging what it produced.
    *
-   * The prefixes travel in the body rather than the path because they contain
-   * slashes, which is why this DELETE carries one.
+   * The prefix travels as a query parameter, not in the body and not as a path
+   * segment: prefixes contain slashes, which a path segment cannot carry
+   * unambiguously, and this endpoint reads no body at all.
+   *
+   * Pass `purge: true` to also delete the memories already derived from the
+   * prefix. The default leaves them in place, so revoking an approval does not
+   * silently destroy knowledge.
    */
-  removePrefixes(connectionId, prefixes) {
-    return this.req("DELETE", `${V2}/connections/${seg(connectionId)}/s3/prefixes`, {
-      body: { prefixes }
-    });
+  removePrefix(connectionId, prefix = "", options = {}) {
+    const query = { prefix, purge: options.purge ?? false };
+    if (options.bucket !== void 0) query.bucket = options.bucket;
+    return this.req("DELETE", `${V2}/connections/${seg(connectionId)}/s3/prefixes`, { query });
   }
   /** Keys and patterns this connection will never sync. */
   exclusionPolicy(connectionId) {
@@ -249,9 +284,18 @@ var GranolaNamespace = class extends Namespace {
   linkIdentity(connectionId, body) {
     return this.req("POST", `${V2}/connections/${seg(connectionId)}/granola/identities/link`, { body });
   }
-  /** Move an existing mapping to a different end user. */
-  relinkIdentity(connectionId, body) {
-    return this.req("POST", `${V2}/connections/${seg(connectionId)}/granola/identities/relink`, { body });
+  /**
+   * Re-run identity matching for this connection.
+   *
+   * Takes no arguments: the route reads no body and re-matches the whole roster.
+   * `body` is kept optional only so a forward-compatible field can be passed
+   * once the route grows one.
+   */
+  relinkIdentity(connectionId, body = {}) {
+    const hasFields = Object.keys(body).length > 0;
+    return this.req("POST", `${V2}/connections/${seg(connectionId)}/granola/identities/relink`, {
+      body: hasFields ? body : void 0
+    });
   }
   /** Effective Granola settings for this connection. */
   settings(connectionId) {
@@ -272,7 +316,9 @@ var ConnectionOAuthNamespace = class extends Namespace {
    * back — not your backend. Poll {@link status} to find out how it went.
    */
   initiate(provider, body = {}) {
-    return this.req("POST", `${V2}/oauth/initiate`, { body: { provider, ...body } });
+    return this.req("POST", `${V2}/oauth/initiate`, {
+      body: { provider_id: provider, ...body }
+    });
   }
   /** Where an in-flight OAuth connection got to. */
   status(query) {
@@ -297,15 +343,21 @@ var ConnectionsNamespace = class extends Namespace {
     return this.req("GET", `${V2}/connections/${seg(connectionId)}`);
   }
   /** Connect a provider that authenticates with an API key or bot token. */
+  /**
+   * Connect a provider that authenticates with an API key or bot token.
+   *
+   * The wire field is `provider_id`; the argument is named `provider` because
+   * that is what the rest of this namespace calls it.
+   */
   createWithApiKey(provider, apiKey, body = {}) {
     return this.req("POST", `${V2}/connections/api-key`, {
-      body: { provider, api_key: apiKey, ...body }
+      body: { provider_id: provider, api_key: apiKey, ...body }
     });
   }
   /** Connect a provider that needs a credential bundle, such as S3 keys. */
   createWithCredentials(provider, credentials, body = {}) {
     return this.req("POST", `${V2}/connections/credentials`, {
-      body: { provider, credentials, ...body }
+      body: { provider_id: provider, credentials, ...body }
     });
   }
   /** Change a connection's name, schedule or settings. */
@@ -524,7 +576,7 @@ var IntegrationsNamespace = class extends Namespace {
 };
 
 // src/control-plane.ts
-var SDK_VERSION = "1.1.1";
+var SDK_VERSION = "1.4.0";
 function safeJson(text) {
   try {
     return JSON.parse(text);
@@ -950,7 +1002,7 @@ var ControlPlaneClient = class {
 };
 
 // src/index.ts
-var SDK_VERSION2 = "1.3.0";
+var SDK_VERSION2 = "1.4.0";
 function camelToSnakeKey(key) {
   return key.replace(/([A-Z])/g, "_$1").toLowerCase();
 }