@dxos/plugin-space 0.6.8-main.046e6cf

package/src/translations.ts

@@ -0,0 +1,92 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { SPACE_PLUGIN } from './meta';
+
+export default [
+  {
+    'en-US': {
+      [SPACE_PLUGIN]: {
+        'plugin name': 'Spaces',
+        'first run message': 'Nothing selected.',
+        'create space label': 'Create a new space',
+        'join space label': 'Join a space',
+        'empty space message': 'No documents',
+        'empty tree message': 'No spaces',
+        'unnamed space label': 'New space',
+        'closed space label': 'Closed',
+        'loading space label': 'Loading space…',
+        'lock space label': 'Lock space',
+        'unlock space label': 'Unlock space',
+        'rename space label': 'Rename space',
+        'active space label': 'Active space:',
+        'space name label': 'Space name',
+        'object name label': 'Object name',
+        'close space label': 'Close space',
+        'open space label': 'Open space',
+        'export data label': 'Export data',
+        'import data label': 'Import data',
+        'migrate space label': 'Migrate space',
+        'share space': 'Share space',
+        'save space to disk label': 'Save to disk',
+        'load space from disk label': 'Load from disk',
+        'confirm restore title': 'Overwrite files in this space?',
+        'confirm restore body': 'Restoring from a backup will overwrite the contents of any documents that match.',
+        'upload file message': 'Drag file here or click to browse',
+        'object title placeholder': 'Type a title here…',
+        'personal space label': 'Personal Space',
+        'spaces label': 'Spaces',
+        'show hidden spaces label': 'Show closed spaces',
+        'save files to directory label': 'Save files to disk',
+        'select path label': 'Select path',
+        'rename collection label': 'Rename collection',
+        'rename object label': 'Rename item',
+        'duplicate object label': 'Duplicate item',
+        'delete collection label': 'Delete collection',
+        'delete object label': 'Delete item',
+        'collection deleted label': 'Collection deleted',
+        'object deleted label': 'Item deleted',
+        'go to object label': 'Open item',
+        'found object label': 'Ready.',
+        'found object description': 'The requested object is now available.',
+        'waiting for object label': 'Loading…',
+        'waiting for object description': 'The requested object is still being synchronized.',
+        'object not found label': 'Nothing found.',
+        'object not found description':
+          'The requested object has not been found yet. Ensure there are enough peers online in the space with an updated copy.',
+        'missing object message': 'Object not available.',
+        'missing object description':
+          'The requested object has not been found yet. Ensure there are enough peers online in the space with an updated copy.',
+        'create collection label': 'Create collection',
+        'unnamed object label': 'New object',
+        'unnamed collection label': 'New collection',
+        'create object in space label': 'Add to space',
+        'create object in collection label': 'Add to collection',
+        'share space label': 'Share',
+        'space members label': 'Space members',
+        'active space members heading': 'Online ({{count}})',
+        'inactive space members heading': 'Offline ({{count}})',
+        'presence label_zero': 'No other viewers',
+        'presence label_one': '1 other viewer',
+        'presence label_other': '{{count}} other viewers',
+        'persisted locally label': 'Changes saved locally.',
+        'persisted locally message': 'All changes have been saved to disk on this device.',
+        'persistence pending label': 'Saving…',
+        'persistence error label': 'Error saving changes.',
+        'more actions label': 'More actions',
+        'invitations heading': 'Invitations',
+        'keyshortcuts label': 'Keyboard shortcuts',
+        'menu footer label': 'Details',
+        'location label': 'Located in',
+        'space limit label': 'Space Limit Reached',
+        'space limit description':
+          'This space has reached the maximum number of objects for the beta. This limit includes deleted objects currently, but those can be permanently removed with the cleanup action.',
+        'space limit close label': 'Close',
+        'remove deleted objects label': 'Cleanup',
+        'remove deleted objects alt': 'Permanently remove deleted objects to free up space.',
+        'copy link label': 'Copy link',
+      },
+    },
+  },
+];

package/src/types/collection.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Expando, ref, S, TypedObject } from '@dxos/echo-schema';
+
+export class CollectionType extends TypedObject({ typename: 'dxos.org/type/Collection', version: '0.1.0' })({
+  name: S.optional(S.String),
+  objects: S.mutable(S.Array(ref(Expando))),
+  // Key is schema typename and value is reference to a view object of the associated schema.
+  // Having collection reference the views rather than vice versa ensures that the state converges to a single view per key (i.e. type).
+  // This also leaves open a future where this key could be changed to allow for multiple stack views per section.
+  // TODO(wittjosiah): Any way to make this more type safe?
+  // TODO(wittjosiah): Should the views be separate objects or just be schemas for view data in this record?
+  views: S.mutable(S.Record(S.String, ref(Expando))),
+}) {}

package/src/types/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './collection';
+export * from './thread';
+export * from './types';

package/src/types/thread.ts

@@ -0,0 +1,68 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Expando, ref, S, TypedObject } from '@dxos/echo-schema';
+
+// TODO(wittjosiah): These types were placed here rather than in @dxos/plugin-thread
+//   in order to avoid a circular dependency between threads and other objects that use threads.
+
+// TODO(wittjosiah): Factor out to halo?
+export class ContactType extends TypedObject({ typename: 'dxos.org/type/Contact', version: '0.1.0' })({
+  name: S.optional(S.String),
+  identifiers: S.mutable(
+    S.Array(
+      S.Struct({
+        type: S.String,
+        value: S.String,
+      }),
+    ),
+  ),
+}) {}
+
+export const ActorSchema = S.mutable(
+  S.Struct({
+    contact: S.optional(ref(ContactType)),
+    // TODO(wittjosiah): Should the below fields just be the contact schema?
+    //  i.e. it should either be a reference to an existing contact or an inline contact schema.
+    identityKey: S.optional(S.String),
+    // TODO(burdon): Generalize to handle/identifier?
+    email: S.optional(S.String),
+    name: S.optional(S.String),
+  }),
+);
+
+export type ActorType = S.Schema.Type<typeof ActorSchema>;
+
+export class MessageType extends TypedObject({ typename: 'dxos.org/type/Message', version: '0.1.0' })({
+  /** ISO date string when the message was sent. */
+  timestamp: S.String,
+  /** Identity of the message sender. */
+  sender: ActorSchema,
+  /** Text content of the message. */
+  text: S.String,
+  /** Non-text content sent with a message (e.g. files, polls, etc.) */
+  parts: S.optional(S.mutable(S.Array(ref(Expando)))),
+  /** Custom properties for specific message types (e.g. email subject or cc fields). */
+  properties: S.optional(S.mutable(S.Record(S.String, S.Any))),
+  // TODO(wittjosiah): Add read status:
+  //  - Read receipts need to be per space member.
+  //  - Read receipts don't need to be added to schema until they being implemented.
+  /** Context of the application when message was created. */
+  // TODO(burdon): Evolve "attention object" to be current UX state? E.g., of Deck?
+  context: S.optional(ref(Expando)),
+}) {}
+
+export const ThreadStatus = S.Union(S.Literal('staged'), S.Literal('active'), S.Literal('resolved'));
+
+export class ThreadType extends TypedObject({ typename: 'dxos.org/type/Thread', version: '0.1.0' })({
+  name: S.optional(S.String),
+  anchor: S.optional(S.String),
+  status: S.optional(ThreadStatus),
+  messages: S.mutable(S.Array(ref(MessageType))),
+}) {}
+
+export class ChannelType extends TypedObject({ typename: 'dxos.org/type/Channel', version: '0.1.0' })({
+  name: S.optional(S.String),
+  threads: S.mutable(S.Array(ref(ThreadType))),
+}) {}

package/src/types/types.ts

@@ -0,0 +1,81 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import type {
+  GraphBuilderProvides,
+  GraphSerializerProvides,
+  IntentResolverProvides,
+  MetadataRecordsProvides,
+  SettingsProvides,
+  SurfaceProvides,
+  TranslationsProvides,
+} from '@dxos/app-framework';
+import { type Expando } from '@dxos/echo-schema';
+import { type SchemaProvides } from '@dxos/plugin-client';
+import { type PublicKey } from '@dxos/react-client';
+import { type ComplexMap } from '@dxos/util';
+
+export const SPACE_DIRECTORY_HANDLE = 'dxos.org/plugin/space/directory';
+
+export type ObjectViewerProps = {
+  lastSeen: number;
+  currentlyAttended: boolean;
+};
+
+export type ObjectId = string;
+
+export type PluginState = {
+  /**
+   * Which objects are currently being viewed by which peers.
+   */
+  viewersByObject: Record<ObjectId, ComplexMap<PublicKey, ObjectViewerProps>>;
+
+  /**
+   * Which peers are currently viewing which objects.
+   */
+  viewersByIdentity: ComplexMap<PublicKey, Set<ObjectId>>;
+
+  /**
+   * Object that was linked to directly but not found and is being awaited.
+   */
+  awaiting: string | undefined;
+
+  /**
+   * Cached space names, used when spaces are closed or loading.
+   */
+  spaceNames: Record<string, string>;
+
+  /**
+   * Which spaces have an SDK migration running currently.
+   */
+  // TODO(wittjosiah): Factor out to sdk. Migration running should probably be a space state.
+  sdkMigrationRunning: Record<string, boolean>;
+};
+
+export type SpaceSettingsProps = { showHidden?: boolean };
+
+export type SpacePluginProvides = SurfaceProvides &
+  IntentResolverProvides &
+  GraphBuilderProvides &
+  GraphSerializerProvides &
+  MetadataRecordsProvides &
+  SettingsProvides<SpaceSettingsProps> &
+  TranslationsProvides &
+  SchemaProvides & {
+    space: Readonly<PluginState>;
+  };
+
+// TODO(wittjosiah): Reconcile with graph export serializers.
+
+export type SerializerMap = Record<string, TypedObjectSerializer>;
+
+export interface TypedObjectSerializer<T extends Expando = Expando> {
+  serialize(params: { object: T }): Promise<string>;
+
+  /**
+   * @param params.content
+   * @param params.newId Generate new ID for deserialized object.
+   */
+  deserialize(params: { content: string; newId?: boolean }): Promise<T>;
+}