@mintplayer/ng-spark 22.26.0 → 22.28.0

package/types/mintplayer-ng-spark-services.d.ts

@@ -62,11 +62,22 @@ export interface NewObjectOptions {
 }
 /** Where a bulk delete was started from; see {@link SparkService.deleteMany}. */
 export interface DeleteManyOptions {
-  /** The query the rows were selected in, for the server's `OnDisableActionsAsync`. */
-  queryId?: string;
+  /**
+   * The query the rows were selected in. Required (#467, D12): the server fetches the rows through it
+   * and applies its `OnDisableActionsAsync` decision; without it the call is a 400.
+   */
+  queryId: string;
   /** The sub-query's container, when deleting from a sub-query. */
   parentId?: string;
   parentType?: string;
+  /** One reason for the whole batch, recorded on every soft-deleted row (#467, D20). */
+  reason?: string;
+}
+/** A row and the version of it the caller saw (#467, D14): what a bulk delete names. */
+export interface SparkRowVersion {
+  id: string;
+  /** The row's `etag` from the query result. */
+  etag: string;
 }
 /** Context for {@link SparkService.deleteRow}. Every field is required — see `DeleteRow.cs`. */
 export interface DeleteRowOptions {
@@ -92,7 +103,11 @@ export declare class SparkService {
   private static readonly MAX_RETRY_DEPTH;
   private readonly dispatcher;
   getEntityTypes(): Promise<EntityType[]>;
-  getEntityType(id: string): Promise<EntityType>;
+  /**
+   * One entity type, shaped by the caller's attribute rights. `purpose` narrows it for one form (#264, G1/G2):
+   * `'new'` leaves out what the caller may not create and does not apply edit-only denies.
+   */
+  getEntityType(id: string, purpose?: 'new' | 'edit' | 'read'): Promise<EntityType>;
   getEntityTypeByClrType(clrType: string): Promise<EntityType | undefined>;
   getPermissions(entityTypeId: string): Promise<EntityPermissions>;
   getQueries(): Promise<SparkQuery[]>;
@@ -155,12 +170,20 @@ export declare class SparkService {
    * `parent` is the sub-query the New was started from — the same `parentId`/`parentType`/`queryId`
    * `newObject` was given. The server resolves and authorizes it again and hands it to the save hooks
    * as `PersistentObject.Parent`.
+   *
+   * Resolves to `null` when a server interceptor cancelled the create (#482: the user answered a prompt with
+   * Cancel) — the server answers 204 and nothing was created.
    */
   create(type: string, data: Partial<PersistentObject>, parent?: {
     parentId: string;
     parentType: string;
     queryId: string;
-  }): Promise<PersistentObject>;
+  }): Promise<PersistentObject | null>;
+  /**
+   * Saves an edit. `data.etag` — the etag the object was loaded with — is required (#467, D16): it is
+   * the version being edited. A 409 means the object changed since (`reason: 'changed'`) or was
+   * deleted since (`reason: 'deleted'`).
+   */
   update(type: string, id: string, data: Partial<PersistentObject>): Promise<PersistentObject>;
   /**
    * Asks the server to reshape an in-progress object after `triggeredBy`'s value changed.
@@ -199,14 +222,20 @@ export declare class SparkService {
    * of the route variables.
    */
   deleteRow(type: string, options: DeleteRowOptions): Promise<void>;
-  delete(type: string, id: string): Promise<void>;
+  /**
+   * Deletes one object. `etag` is the version being deleted — the loaded object's `etag` — and is
+   * required (#467, D14): an object changed since is a 409.
+   */
+  delete(type: string, id: string, etag: string): Promise<void>;
   /**
    * Deletes several rows of one type in one request — the default Delete action on a selection
-   * (`POST /spark/po/delete-many`, #460 D18). All or nothing: a 404 means some row is missing or not
-   * yours to delete, a 403 that the server's `OnDisableActionsAsync` withholds Delete on the query or
-   * on one of the rows, a 400 that the selection breaks the rule or the 200-row cap.
+   * (`POST /spark/po/delete-many`, #460 D18). Each row carries the `etag` its query result row had
+   * (#467, D14). All or nothing: a 404 means some row is missing or not yours to delete, a 403 that
+   * the server's `OnDisableActionsAsync` withholds Delete on the query or on one of the rows, a 409
+   * that rows changed since the list loaded (the body's `message` names them), a 400 that the
+   * selection breaks the rule or the 200-row cap.
    */
-  deleteMany(type: string, ids: string[], options?: DeleteManyOptions): Promise<void>;
+  deleteMany(type: string, items: SparkRowVersion[], options: DeleteManyOptions): Promise<void>;
   getCustomActions(objectTypeId: string): Promise<CustomActionDefinition[]>;
   /**
    * @param parent The object of THIS type the action is operating on — the detail-page invocation.

package/types/mintplayer-ng-spark-soft-delete.d.ts

@@ -17,7 +17,7 @@ export declare class SparkSoftDeleteService {
    * `POST /spark/po/purge` → 204. Requires `Purge/T` and a deleted row. Removes the document and
    * every revision of it; it cannot be undone.
    */
-  purge(type: string, id: string): Promise<void>;
+  purge(type: string, id: string, etag: string): Promise<void>;
   static ɵfac: i0.ɵɵFactoryDeclaration<SparkSoftDeleteService, never>;
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }