@dxos/protocols 0.8.4-main.28f8d3d → 0.8.4-main.2c6827d

package/src/queue.ts

@@ -2,6 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
+import type { SpaceId } from '@dxos/keys';
+
 import type { ObjectId } from './types.js';
 
 export type QueueCursor = string & { __QueueCursor: never };
@@ -31,3 +33,19 @@ export type QueryResult = {
    */
   prevCursor: QueueCursor | null;
 };
+
+/**
+ * Position of an object in the queue that it is in.
+ */
+export const KEY_QUEUE_POSITION = 'dxos.org/key/queue-position';
+
+/**
+ * Service for managing queues.
+ */
+export interface QueueService {
+  queryQueue(subspaceTag: string, spaceId: SpaceId, query: QueueQuery): Promise<QueryResult>;
+
+  insertIntoQueue(subspaceTag: string, spaceId: SpaceId, queueId: ObjectId, objects: unknown[]): Promise<void>;
+
+  deleteFromQueue(subspaceTag: string, spaceId: SpaceId, queueId: ObjectId, objectIds: ObjectId[]): Promise<void>;
+}