Skip to content

feat(odsp-client): Expose container.uploadBlob #25808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −0
Open

feat(odsp-client): Expose container.uploadBlob #25808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/service-clients/odsp-client/api-report/odsp-client.alpha.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export type IOdspAudience = IServiceAudience<OdspMember>;
// @beta
export interface IOdspFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IFluidContainer<TContainerSchema> {
attach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;
uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
}

// @beta
Expand Down
1 change: 1 addition & 0 deletions packages/service-clients/odsp-client/api-report/odsp-client.beta.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export type IOdspAudience = IServiceAudience<OdspMember>;
// @beta
export interface IOdspFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IFluidContainer<TContainerSchema> {
attach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;
uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
}

// @beta
Expand Down
7 changes: 7 additions & 0 deletions packages/service-clients/odsp-client/src/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import type {
IConfigProviderBase,
IFluidHandle,
ITelemetryBaseLogger,
} from "@fluidframework/core-interfaces";
import type {
Expand Down Expand Up @@ -97,6 +98,12 @@ export interface IOdspFluidContainer<
* @returns A promise which resolves when the attach is complete, with the string identifier of the container.
*/
attach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;

/**
* Upload a blob of data.
* @param blob - The blob to upload to the ODSP service.
*/
uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/service-clients/odsp-client/src/odspClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import type { ContainerAttachProps, ContainerSchema } from "@fluidframework/flui
import {
createDOProviderContainerRuntimeFactory,
createFluidContainer,
isInternalFluidContainer,
} from "@fluidframework/fluid-static/internal";
import {
OdspDocumentServiceFactory,
Expand Down Expand Up @@ -155,6 +156,9 @@ export class OdspClient {
const fluidContainer = await createFluidContainer<T>({
container,
});
if (!isInternalFluidContainer(fluidContainer)) {
throw new Error("Fluid container is not internal");
}
const services = await this.getContainerServices(container);
return { container: fluidContainer, services };
}
Expand Down Expand Up @@ -227,6 +231,9 @@ export class OdspClient {
return resolvedUrl.itemId;
};
const fluidContainer = await createFluidContainer<T>({ container });
if (!isInternalFluidContainer(fluidContainer)) {
throw new Error("Fluid container is not internal");
}
fluidContainer.attach = attach;
return fluidContainer;
}
Expand Down
Loading