@dxos/plugin-space 0.6.14-main.f49f251 → 0.6.14-staging.54a8bab

package/src/components/{SaveStatus.tsx → SyncStatus/save-tracker.ts}

@@ -2,36 +2,12 @@
 // Copyright 2024 DXOS.org
 //
 
-import React, { useEffect, useState } from 'react';
-
 import { type UnsubscribeCallback } from '@dxos/async';
 import { type Client } from '@dxos/client';
 import { type Space, type SpaceId } from '@dxos/client/echo';
 import { Context } from '@dxos/context';
-import { StatusBar } from '@dxos/plugin-status-bar';
-import { useClient } from '@dxos/react-client';
-import { Icon, useTranslation } from '@dxos/react-ui';
-
-import { SPACE_PLUGIN } from '../meta';
-
-export const SaveStatus = () => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const client = useClient();
-  const [state, setState] = useState<'saved' | 'saving'>('saved');
-  useEffect(() => {
-    return createClientSaveTracker(client, (state) => {
-      setState(state);
-    });
-  }, []);
-
-  return (
-    <StatusBar.Item title={state === 'saving' ? t('saving label') : t('saved label')}>
-      <Icon icon={state === 'saving' ? 'ph--arrows-clockwise--regular' : 'ph--check-circle--regular'} size={4} />
-    </StatusBar.Item>
-  );
-};
 
-const createClientSaveTracker = (client: Client, cb: (state: 'saved' | 'saving') => void) => {
+export const createClientSaveTracker = (client: Client, cb: (state: 'saved' | 'saving') => void) => {
   const unsubscribeCallbacks: Record<SpaceId, UnsubscribeCallback> = {};
   const state: Record<SpaceId, 'saved' | 'saving'> = {};
 

package/src/components/SyncStatus/status.ts

@@ -0,0 +1,44 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export type Status = 'saving locally' | 'downloading' | 'uploading' | 'offline persisted' | 'remote synced';
+
+export const getStatus = ({
+  offline,
+  saved,
+  needsToUpload,
+  needsToDownload,
+}: {
+  offline: Boolean;
+  saved: Boolean;
+  needsToUpload: Boolean;
+  needsToDownload: Boolean;
+}): Status => {
+  if (!saved) {
+    return 'saving locally';
+  } else if (!offline && needsToDownload) {
+    return 'downloading';
+  } else if (!offline && needsToUpload) {
+    return 'uploading';
+  } else if (offline && !needsToUpload && !needsToDownload) {
+    return 'offline persisted';
+  } else {
+    return 'remote synced';
+  }
+};
+
+export const getIcon = (status: Status) => {
+  switch (status) {
+    case 'saving locally':
+      return 'ph--download--regular';
+    case 'downloading':
+      return 'ph--cloud-arrow-down--regular';
+    case 'uploading':
+      return 'ph--cloud-arrow-up--regular';
+    case 'offline persisted':
+      return 'ph--check-circle--regular';
+    case 'remote synced':
+      return 'ph--cloud-check--regular';
+  }
+};

package/src/components/index.ts

@@ -7,7 +7,6 @@ export * from './CollectionMain';
 export * from './CollectionSection';
 export * from './DefaultObjectSettings';
 export * from './MenuFooter';
-export * from './MissingObject';
 export * from './PersistenceStatus';
 export * from './PopoverRenameObject';
 export * from './PopoverRenameSpace';
@@ -16,5 +15,4 @@ export * from './SpaceMain';
 export * from './SpacePresence';
 export * from './SpaceSettings';
 export * from './SpaceSettingsPanel';
-export * from './SaveStatus';
 export * from './SyncStatus';

package/src/translations.ts

@@ -94,6 +94,12 @@ export default [
         'name placeholder': 'Name',
         'unnamed object settings label': 'Settings',
         'edge replication label': 'Enable EDGE Replication',
+        'saving locally label': 'Writing to disk',
+        'downloading label': 'Replicating from peers',
+        'uploading label': 'Replicating to peers',
+        'offline persisted label': 'Saved to disk (offline)',
+        'remote synced label': 'Synced with peers',
+        'open settings panel label': 'Show Settings',
       },
     },
   },

package/src/types/types.ts

@@ -14,6 +14,7 @@ import type {
 } from '@dxos/app-framework';
 import { type Expando } from '@dxos/echo-schema';
 import { type SchemaProvides } from '@dxos/plugin-client';
+import { type PanelProvides } from '@dxos/plugin-deck/types';
 import { type PublicKey } from '@dxos/react-client';
 import { type Space } from '@dxos/react-client/echo';
 import { type Label } from '@dxos/react-ui';
@@ -87,7 +88,8 @@ export type SpacePluginProvides = SurfaceProvides &
   MetadataRecordsProvides &
   SettingsProvides<SpaceSettingsProps> &
   TranslationsProvides &
-  SchemaProvides & {
+  SchemaProvides &
+  PanelProvides & {
     space: Readonly<PluginState>;
   };
 

package/dist/types/src/components/MissingObject.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-export declare const MissingObject: ({ id }: {
-    id: string;
-}) => React.JSX.Element;
-//# sourceMappingURL=MissingObject.d.ts.map

package/dist/types/src/components/MissingObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MissingObject.d.ts","sourceRoot":"","sources":["../../../../src/components/MissingObject.tsx"],"names":[],"mappings":"AAIA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAUnD,eAAO,MAAM,aAAa,WAAY;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,sBAuCnD,CAAC"}

package/dist/types/src/components/SaveStatus.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-export declare const SaveStatus: () => React.JSX.Element;
-//# sourceMappingURL=SaveStatus.d.ts.map

package/dist/types/src/components/SaveStatus.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SaveStatus.d.ts","sourceRoot":"","sources":["../../../../src/components/SaveStatus.tsx"],"names":[],"mappings":"AAIA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAYnD,eAAO,MAAM,UAAU,yBAetB,CAAC"}

package/dist/types/src/components/SyncStatus/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/components/SyncStatus/types.ts"],"names":[],"mappings":"AAMA,OAAO,EAAc,KAAK,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAKlF,MAAM,MAAM,QAAQ,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAExD,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AAErE,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;AAE/D,eAAO,MAAM,wBAAwB,QAAO,aAM1C,CAAC;AAEH,eAAO,MAAM,cAAc,YAAa,iBAAiB,KAAG,aAS3D,CAAC;AAKF;;GAEG;AACH,eAAO,MAAM,YAAY,QAAO,iBAkC/B,CAAC"}

package/src/components/MissingObject.tsx

@@ -1,54 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { useEffect, useState } from 'react';
-
-import { parseIntentPlugin, useResolvePlugin } from '@dxos/app-framework';
-import { Status, useTranslation } from '@dxos/react-ui';
-import { baseSurface, descriptionText, mx } from '@dxos/react-ui-theme';
-
-import { SpaceAction, SPACE_PLUGIN } from '../meta';
-
-const WAIT_FOR_OBJECT_TIMEOUT = 1_000;
-
-export const MissingObject = ({ id }: { id: string }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const [waiting, setWaiting] = useState(false);
-  const intentPlugin = useResolvePlugin(parseIntentPlugin);
-
-  useEffect(() => {
-    if (!intentPlugin) {
-      return;
-    }
-
-    const timeout = setTimeout(async () => {
-      setWaiting(true);
-      await intentPlugin.provides.intent.dispatch({
-        plugin: SPACE_PLUGIN,
-        action: SpaceAction.WAIT_FOR_OBJECT,
-        data: { id },
-      });
-    }, WAIT_FOR_OBJECT_TIMEOUT);
-
-    return () => clearTimeout(timeout);
-  }, [intentPlugin, id]);
-
-  return (
-    <div role='none' className={mx(baseSurface, 'min-bs-screen is-full flex items-center justify-center p-8')}>
-      {waiting ? (
-        <p
-          role='alert'
-          className={mx(
-            descriptionText,
-            'border border-dashed border-neutral-400/50 rounded-lg flex items-center justify-center p-8 font-normal text-lg',
-          )}
-        >
-          {t('missing object message')}
-        </p>
-      ) : (
-        <Status indeterminate aria-label='Initializing' />
-      )}
-    </div>
-  );
-};