Collaborative Container Lifecycle Toolkit

Build a small module that wraps the package's lifecycle helpers to create a new collaborative document, attach it, open an existing one, and resume pending work from a serialized snapshot.

Capabilities

Create and attach a new document

• Creating a new document with id notes returns a resolved URL containing notes and yields an attached, connected container @test
• Supplying an initial serialized state seeds the new container before it is attached @test

Load an existing document

• Loading a previously attached document URL produces a connected container ready for reads and writes @test

Resume from pending state

• Rehydrating from serialized pending local state reuses the provided document URL and connects with pending work preserved @test

Implementation

@generates

API

export interface LoaderServices {
  urlResolver: unknown;
  documentServiceFactory: unknown;
  codeLoader: unknown;
  options?: Record<string, unknown>;
  logger?: unknown;
}

export interface CreateRequest extends LoaderServices {
  documentId: string;
  initialState?: string;
}

export interface LoadRequest extends LoaderServices {
  documentUrl: string;
}

export interface ResumeRequest extends LoaderServices {
  documentUrl: string;
  pendingLocalState: string;
}

export interface LoadedContainer {
  container: unknown;
  resolvedUrl: string;
}

export function createAndAttach(request: CreateRequest): Promise<LoadedContainer>;
export function loadExisting(request: LoadRequest): Promise<LoadedContainer>;
export function resumeFromPending(request: ResumeRequest): Promise<LoadedContainer>;

Dependencies { .dependencies }

@fluidframework/container-loader { .dependency }

Provides loader and container lifecycle helpers (creation, loading, and pending-state rehydration).