@larc-iu/plaid-client 0.2.0-alpha.32 → 0.2.0-alpha.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larc-iu/plaid-client",
-  "version": "0.2.0-alpha.32",
+  "version": "0.2.0-alpha.34",
   "description": "JavaScript client for the Plaid annotation API",
   "type": "module",
   "repository": {

package/src/apiDocuments.d.ts

@@ -421,8 +421,8 @@ export function textsApi(client: import("./client.js").PlaidClient): {
         tokenizeLayer?: string;
     }) => Promise<Created>;
     /**
-     * Update a text's body. A diff is computed and token indices are updated
-     * so that tokens remain intact. Alternatively, `body` can be a list of
+     * Update a text's body. The change is read as the character diff of the
+     * two bodies, by the rules edits follow. Alternatively, `body` can be a list of
      * edit directives (code-point indices, applied in order):
      *   {type: 'delete', index, value: count}
      *   {type: 'insert', index, value: string}

package/src/apiDocuments.js

@@ -484,8 +484,8 @@ export function textsApi(client) {
         }),
       }),
     /**
-     * Update a text's body. A diff is computed and token indices are updated
-     * so that tokens remain intact. Alternatively, `body` can be a list of
+     * Update a text's body. The change is read as the character diff of the
+     * two bodies, by the rules edits follow. Alternatively, `body` can be a list of
      * edit directives (code-point indices, applied in order):
      *   {type: 'delete', index, value: count}
      *   {type: 'insert', index, value: string}

package/src/apiVocab.d.ts

@@ -162,12 +162,17 @@ export function vocabLayersApi(client: import("./client.js").PlaidClient): {
      */
     update: (id: string, name: string, auditMessage?: string) => Promise<VocabLayer>;
     /**
-     * Delete a vocab layer.
+     * Delete a vocab layer. With `onlyInProject`, refused (409) when any
+     * other project links it, including projects the caller cannot read.
      * @param {string} id - The resource ID
      * @param {string} [auditMessage] - Audit message for this write
+     * @param {object} [opts]
+     * @param {string} [opts.onlyInProject] - The one project allowed to link it
      * @returns {Promise<void>}
      */
-    delete: (id: string, auditMessage?: string) => Promise<void>;
+    delete: (id: string, auditMessage?: string, { onlyInProject }?: {
+        onlyInProject?: string;
+    }) => Promise<void>;
     /**
      * Get the audit log of a vocabulary: every change to it or to its
      * entries, folded into entries as the document log is. Links are not

package/src/apiVocab.js

@@ -181,13 +181,19 @@ export function vocabLayersApi(client) {
         body: bodyOf({ name }),
       }),
     /**
-     * Delete a vocab layer.
+     * Delete a vocab layer. With `onlyInProject`, refused (409) when any
+     * other project links it, including projects the caller cannot read.
      * @param {string} id - The resource ID
      * @param {string} [auditMessage] - Audit message for this write
+     * @param {object} [opts]
+     * @param {string} [opts.onlyInProject] - The one project allowed to link it
      * @returns {Promise<void>}
      */
-    delete: (id, auditMessage) =>
-      client._request("DELETE", `/api/v1/vocab-layers/${id}`, { auditMessage }),
+    delete: (id, auditMessage, { onlyInProject } = {}) =>
+      client._request("DELETE", `/api/v1/vocab-layers/${id}`, {
+        auditMessage,
+        ...(onlyInProject ? { queryParams: { "only-in-project": onlyInProject } } : {}),
+      }),
     /**
      * Get the audit log of a vocabulary: every change to it or to its
      * entries, folded into entries as the document log is. Links are not

package/src/client.d.ts

@@ -155,7 +155,8 @@ export class PlaidClient {
      *   the UI; defaults to the local part of the email (signup only)
      * @param {string} credentials.password - Desired password (min 8 characters)
      * @param {object} [options]
-     * @returns {Promise<{client: PlaidClient, userId: string, kind: string}>}
+     * @returns {Promise<{client: PlaidClient, userId: string, kind: string, projectId?: string}>}
+     *   `projectId` names the project a signup invite joined.
      */
     static redeemInvite(baseUrl: string, code: string, { email, password, displayName }?: {
         email?: string;
@@ -165,6 +166,7 @@ export class PlaidClient {
         client: PlaidClient;
         userId: string;
         kind: string;
+        projectId?: string;
     }>;
     /**
      * Authenticate and return a new client instance with token. This is the
@@ -636,7 +638,9 @@ export class PlaidClient {
             id?: string;
         }) => Promise<import("./apiVocab.js").Created>;
         update: (id: string, name: string, auditMessage?: string) => Promise<import("./apiVocab.js").VocabLayer>;
-        delete: (id: string, auditMessage?: string) => Promise<void>;
+        delete: (id: string, auditMessage?: string, { onlyInProject }?: {
+            onlyInProject?: string;
+        }) => Promise<void>;
         audit: (id: string, startTime?: string, endTime?: string, opTypes?: string[] | string, itemId?: string, kinds?: string[] | string) => Promise<import("./apiVocab.js").AuditEntry[]>;
         auditPage: (id: string, { startTime, endTime, opTypes, kinds, order, limit, cursor, opsLimit, entryId, itemId }?: {
             startTime?: string;

package/src/client.js

@@ -687,7 +687,8 @@ class PlaidClient {
    *   the UI; defaults to the local part of the email (signup only)
    * @param {string} credentials.password - Desired password (min 8 characters)
    * @param {object} [options]
-   * @returns {Promise<{client: PlaidClient, userId: string, kind: string}>}
+   * @returns {Promise<{client: PlaidClient, userId: string, kind: string, projectId?: string}>}
+   *   `projectId` names the project a signup invite joined.
    */
   static async redeemInvite(
     baseUrl,
@@ -715,6 +716,7 @@ class PlaidClient {
       ),
       userId: data.userId,
       kind: data.kind,
+      projectId: data.projectId,
     };
   }
 

package/src/services.d.ts

@@ -107,6 +107,7 @@ export function reportRequestEvent(client: any, projectId: string, requestId: st
  * @typedef {CancelScope & {
  *   requestId: string,
  *   requesterId: string | null,
+ *   projectId: string,
  *   progress(percent: number, message: string, extra?: Record<string, any>): void,
  *   complete(data: any): void,
  *   stopped(data?: any): void,
@@ -287,6 +288,7 @@ export type CancelScope = {
 export type ResponseHelper = CancelScope & {
     requestId: string;
     requesterId: string | null;
+    projectId: string;
     progress(percent: number, message: string, extra?: Record<string, any>): void;
     complete(data: any): void;
     stopped(data?: any): void;

package/src/services.js

@@ -240,6 +240,7 @@ const PERMANENT_STATUSES = new Set([400, 401, 403, 404, 405, 422]);
  * @typedef {CancelScope & {
  *   requestId: string,
  *   requesterId: string | null,
+ *   projectId: string,
  *   progress(percent: number, message: string, extra?: Record<string, any>): void,
  *   complete(data: any): void,
  *   stopped(data?: any): void,
@@ -371,15 +372,18 @@ export function serve(client, projectId, serviceInfo, onServiceRequest, extras =
     // service (extras `delegation: true`) also gets a short-lived token for the
     // requesting user (`delegatedToken`) and the projects that token reaches
     // (`delegatedProjects`, the request's own first), as the Python client
-    // hands them over.
+    // hands them over. `projectId` is the project of this channel, the one
+    // core checked the requester may write: it replaces any the body names,
+    // so a service acts in no other project.
     const requesterId = payload.requesterId || null;
     const extra = {
       ...(requesterId ? { requesterId } : {}),
       ...(payload.delegatedToken ? { delegatedToken: payload.delegatedToken } : {}),
       ...(payload.delegatedProjects ? { delegatedProjects: payload.delegatedProjects } : {}),
+      projectId,
     };
     const data =
-      Object.keys(extra).length && payload.data && typeof payload.data === 'object' && !Array.isArray(payload.data)
+      payload.data && typeof payload.data === 'object' && !Array.isArray(payload.data)
         ? { ...payload.data, ...extra }
         : payload.data;
 
@@ -387,6 +391,8 @@ export function serve(client, projectId, serviceInfo, onServiceRequest, extras =
     const responseHelper = {
       requestId,
       requesterId,
+      // The project of the channel the request came through, the only one it may act in.
+      projectId,
       // True once the requester asked for the request to stop.
       get cancelled() {
         return scope.cancelled;