@dxos/client-services 0.1.30-next.7c60cd3 → 0.1.30

package/src/packlets/invitations/invitations.ts

@@ -1,113 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import assert from 'node:assert';
-
-import {
-  AsyncEvents,
-  CancellableObservable,
-  CancellableObservableEvents,
-  CancellableObservableProvider
-} from '@dxos/async';
-import type { Stream } from '@dxos/codec-protobuf';
-import { AuthenticationRequest, CancelInvitationRequest, Invitation } from '@dxos/protocols/proto/dxos/client/services';
-
-export const AUTHENTICATION_CODE_LENGTH = 6;
-
-export const INVITATION_TIMEOUT = 3 * 60_000; // 3 mins.
-
-// TODO(burdon): Don't close until RPC has complete (bug).
-export const ON_CLOSE_DELAY = 1000;
-
-export interface InvitationsService {
-  createInvitation(invitation: Invitation): Stream<Invitation>;
-  authenticate(request: AuthenticationRequest): Promise<void>;
-  acceptInvitation(invitation: Invitation): Stream<Invitation>;
-  cancelInvitation(request: CancelInvitationRequest): Promise<void>;
-}
-
-/**
- * Common invitation events (callbacks) for creating and accepting invitations.
- */
-// TODO(burdon): Remove optionals.
-export interface InvitationEvents extends AsyncEvents, CancellableObservableEvents {
-  onConnecting?(invitation: Invitation): void;
-  onConnected?(invitation: Invitation): void;
-  onAuthenticating?(invitation: Invitation): void;
-  onSuccess(invitation: Invitation): void; // TODO(burdon): Collides with AsyncEvents.
-}
-
-/**
- * Base class for all invitation observables and providers.
- * Observable that supports inspection of the current value.
- */
-export interface CancellableInvitationObservable extends CancellableObservable<InvitationEvents> {
-  get invitation(): Invitation | undefined;
-}
-
-// TODO(wittjosiah): Update with Observable.value.
-export class InvitationObservableProvider
-  extends CancellableObservableProvider<InvitationEvents>
-  implements CancellableInvitationObservable
-{
-  private _invitation?: Invitation;
-
-  get invitation(): Invitation | undefined {
-    return this._invitation;
-  }
-
-  setInvitation(invitation: Invitation) {
-    this._invitation = invitation;
-  }
-}
-
-/**
- * Cancelable observer that relays authentication requests.
- */
-export interface AuthenticatingInvitationObservable extends CancellableInvitationObservable {
-  authenticate(code: string): Promise<void>;
-}
-
-export interface AuthenticatingInvitationProviderActions {
-  onCancel(): Promise<void>;
-  onAuthenticate(code: string): Promise<void>;
-}
-
-export class AuthenticatingInvitationProvider
-  extends InvitationObservableProvider
-  implements AuthenticatingInvitationObservable
-{
-  // prettier-ignore
-  constructor(
-    private readonly _actions: AuthenticatingInvitationProviderActions
-  ) {
-    super(() => this._actions.onCancel());
-  }
-
-  async authenticate(authenticationCode: string): Promise<void> {
-    return this._actions.onAuthenticate(authenticationCode);
-  }
-}
-
-/**
- * Testing util to wrap non-authenticating observable with promise.
- * Don't use this in production code.
- * @deprecated
- */
-// TODO(burdon): Throw error if auth requested.
-export const wrapObservable = async (observable: CancellableInvitationObservable): Promise<Invitation> => {
-  return new Promise((resolve, reject) => {
-    const unsubscribe = observable.subscribe({
-      onSuccess: (invitation: Invitation) => {
-        assert(invitation.state === Invitation.State.SUCCESS);
-        unsubscribe();
-        resolve(invitation);
-      },
-      onError: (err: Error) => {
-        unsubscribe();
-        reject(err);
-      }
-    });
-  });
-};

package/src/packlets/invitations/space-invitations-proxy.ts

@@ -1,16 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { PublicKey } from '@dxos/keys';
-
-import { AbstractInvitationsProxy } from './invitations-proxy';
-
-/**
- * Adapts invitation service observable to client/service stream.
- */
-export class SpaceInvitationsProxy extends AbstractInvitationsProxy<PublicKey> {
-  getInvitationOptions(context: PublicKey) {
-    return { spaceKey: context };
-  }
-}

package/src/packlets/services/service-definitions.ts

@@ -1,68 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-import { schema } from '@dxos/protocols';
-import {
-  DevicesService,
-  DeviceInvitationsService,
-  IdentityService,
-  NetworkService,
-  SpaceInvitationsService,
-  SpacesService,
-  SystemService
-} from '@dxos/protocols/proto/dxos/client/services';
-import { DevtoolsHost, TracingService } from '@dxos/protocols/proto/dxos/devtools/host';
-import { DataService } from '@dxos/protocols/proto/dxos/echo/service';
-import { createServiceBundle, ServiceBundle } from '@dxos/rpc';
-
-//
-// NOTE: Should contain client/proxy dependencies only.
-//
-
-export type ClientServices = {
-  SystemService: SystemService;
-
-  IdentityService: IdentityService;
-  DeviceInvitationsService: DeviceInvitationsService;
-  DevicesService: DevicesService;
-
-  SpaceInvitationsService: SpaceInvitationsService;
-  SpacesService: SpacesService;
-  DataService: DataService;
-
-  NetworkService: NetworkService;
-
-  // TODO(burdon): Deprecated.
-  DevtoolsHost: DevtoolsHost;
-  TracingService: TracingService;
-};
-
-/**
- * Provide access to client services definitions and service handler.
- */
-export interface ClientServicesProvider {
-  descriptors: ServiceBundle<ClientServices>;
-  services: Partial<ClientServices>;
-
-  open(): Promise<void>;
-  close(): Promise<void>;
-}
-
-/**
- * Services supported by host.
- */
-export const clientServiceBundle = createServiceBundle<ClientServices>({
-  SystemService: schema.getService('dxos.client.services.SystemService'),
-  IdentityService: schema.getService('dxos.client.services.IdentityService'),
-  DeviceInvitationsService: schema.getService('dxos.client.services.DeviceInvitationsService'),
-  DevicesService: schema.getService('dxos.client.services.DevicesService'),
-  SpaceInvitationsService: schema.getService('dxos.client.services.SpaceInvitationsService'),
-  SpacesService: schema.getService('dxos.client.services.SpacesService'),
-  DataService: schema.getService('dxos.echo.service.DataService'),
-  NetworkService: schema.getService('dxos.client.services.NetworkService'),
-
-  // TODO(burdon): Deprecated.
-  DevtoolsHost: schema.getService('dxos.devtools.host.DevtoolsHost'),
-  TracingService: schema.getService('dxos.devtools.host.TracingService')
-});

package/src/packlets/services/service-proxy.ts

@@ -1,54 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import { asyncTimeout } from '@dxos/async';
-import { RemoteServiceConnectionTimeout } from '@dxos/errors';
-import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
-
-import { ClientServicesProvider, ClientServices, clientServiceBundle } from './service-definitions';
-
-/**
- * Implements services that are not local to the app.
- * For example, the services can be located in Wallet Extension.
- */
-// TODO(burdon): Separate construction of port from availability of services.
-// TODO(burdon): Create `@dxos/client-proxy` package with thin-client only dependencies (for code-splitting).
-export class ClientServicesProxy implements ClientServicesProvider {
-  private readonly _proxy: ProtoRpcPeer<ClientServices>;
-
-  // prettier-ignore
-  constructor(
-    port: RpcPort,
-    // NOTE: With lower timeout the shared worker does not have enough time to start.
-    // TODO(dmaretskyi): Find better ways to detected when the worker has finished loading. It might take a while on slow connections.
-    private readonly _timeout = 30_000
-  ) {
-    this._proxy = createProtoRpcPeer({
-      requested: clientServiceBundle,
-      exposed: {},
-      handlers: {},
-      port
-    });
-  }
-
-  get proxy() {
-    return this._proxy;
-  }
-
-  get descriptors() {
-    return clientServiceBundle;
-  }
-
-  get services() {
-    return this._proxy.rpc;
-  }
-
-  async open() {
-    await asyncTimeout(this._proxy.open(), this._timeout, new RemoteServiceConnectionTimeout());
-  }
-
-  async close() {
-    await this._proxy.close();
-  }
-}

package/src/packlets/vault/services.ts

@@ -1,42 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { schema } from '@dxos/protocols';
-import type { IframeService, AppService, ShellService, WorkerService } from '@dxos/protocols/proto/dxos/iframe';
-import type { BridgeService } from '@dxos/protocols/proto/dxos/mesh/bridge';
-import { ServiceBundle } from '@dxos/rpc';
-
-export type IframeServiceBundle = {
-  IframeService: IframeService;
-  BridgeService: BridgeService;
-};
-
-export const iframeServiceBundle: ServiceBundle<IframeServiceBundle> = {
-  IframeService: schema.getService('dxos.iframe.IframeService'),
-  BridgeService: schema.getService('dxos.mesh.bridge.BridgeService')
-};
-
-export type WorkerServiceBundle = {
-  WorkerService: WorkerService;
-};
-
-export const workerServiceBundle: ServiceBundle<WorkerServiceBundle> = {
-  WorkerService: schema.getService('dxos.iframe.WorkerService')
-};
-
-export type AppServiceBundle = {
-  AppService: AppService;
-};
-
-export const appServiceBundle: ServiceBundle<AppServiceBundle> = {
-  AppService: schema.getService('dxos.iframe.AppService')
-};
-
-export type ShellServiceBundle = {
-  ShellService: ShellService;
-};
-
-export const shellServiceBundle: ServiceBundle<ShellServiceBundle> = {
-  ShellService: schema.getService('dxos.iframe.ShellService')
-};

package/src/packlets/vault/shell-controller.ts

@@ -1,56 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { Event } from '@dxos/async';
-import { log } from '@dxos/log';
-import { AppContextRequest, LayoutRequest, ShellDisplay, ShellLayout } from '@dxos/protocols/proto/dxos/iframe';
-import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
-
-import { appServiceBundle, shellServiceBundle, ShellServiceBundle } from './services';
-
-/**
- * Provide access to the shell via RPC connection.
- */
-export class ShellController {
-  readonly contextUpdate = new Event<AppContextRequest>();
-  private _shellRpc?: ProtoRpcPeer<ShellServiceBundle>;
-  private _display = ShellDisplay.NONE;
-
-  constructor(private readonly _port: RpcPort) {}
-
-  get display() {
-    return this._display;
-  }
-
-  async setLayout(layout: ShellLayout, options: Omit<LayoutRequest, 'layout'> = {}) {
-    log('set layout', { layout, ...options });
-    this._display = ShellDisplay.FULLSCREEN;
-    this.contextUpdate.emit({ display: this._display });
-    await this._shellRpc?.rpc.ShellService.setLayout({ layout, ...options });
-  }
-
-  async open() {
-    this._shellRpc = createProtoRpcPeer({
-      requested: shellServiceBundle,
-      exposed: appServiceBundle,
-      handlers: {
-        AppService: {
-          setContext: async (request) => {
-            log('set context', request);
-            this._display = request.display;
-            this.contextUpdate.emit(request);
-          }
-        }
-      },
-      port: this._port
-    });
-
-    await this._shellRpc.open();
-  }
-
-  async close() {
-    await this._shellRpc?.close();
-    this._shellRpc = undefined;
-  }
-}