@dxos/plugin-space 0.8.4-main.84f28bd → 0.8.4-main.9735255

package/dist/lib/node-esm/chunk-7KMYUWSR.mjs

@@ -0,0 +1,773 @@
+import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  SPACE_TYPE,
+  SpaceOperation
+} from "./chunk-MPL6NHQX.mjs";
+import {
+  meta
+} from "./chunk-SL4BJSUG.mjs";
+
+// src/util.tsx
+import * as Effect from "effect/Effect";
+import { Common } from "@dxos/app-framework";
+import { SpaceState, isSpace } from "@dxos/client/echo";
+import { Filter, Obj, Query, Ref, Type } from "@dxos/echo";
+import { invariant } from "@dxos/invariant";
+import { Migrations } from "@dxos/migrations";
+import { Operation } from "@dxos/operation";
+import { Graph, Node } from "@dxos/plugin-graph";
+import { ATTENDABLE_PATH_SEPARATOR } from "@dxos/react-ui-attention/types";
+import { Collection, Expando } from "@dxos/schema";
+import { createFilename } from "@dxos/util";
+var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-space/src/util.tsx";
+var SPACES = `${meta.id}-spaces`;
+var COMPOSER_SPACE_LOCK = `${meta.id}/lock`;
+var SHARED = "shared-spaces";
+var getSpaceDisplayName = (space, { personal, namesCache = {} } = {}) => {
+  return space.state.get() === SpaceState.SPACE_READY && (space.properties.name?.length ?? 0) > 0 ? space.properties.name : namesCache[space.id] ? namesCache[space.id] : personal ? [
+    "personal space label",
+    {
+      ns: meta.id
+    }
+  ] : [
+    "unnamed space label",
+    {
+      ns: meta.id
+    }
+  ];
+};
+var getCollectionGraphNodePartials = ({ collection, db, resolve }) => {
+  return {
+    acceptPersistenceClass: /* @__PURE__ */ new Set([
+      "echo"
+    ]),
+    acceptPersistenceKey: /* @__PURE__ */ new Set([
+      db.spaceId
+    ]),
+    role: "branch",
+    onTransferStart: (child, index) => {
+      Obj.change(collection, (c) => {
+        if (!c.objects.find((object) => object.target === child.data)) {
+          if (typeof index !== "undefined") {
+            c.objects.splice(index, 0, Ref.make(child.data));
+          } else {
+            c.objects.push(Ref.make(child.data));
+          }
+        }
+      });
+    },
+    onTransferEnd: (child, destination) => {
+      Obj.change(collection, (c) => {
+        const index = c.objects.findIndex((object) => object.target === child.data);
+        if (index > -1) {
+          c.objects.splice(index, 1);
+        }
+      });
+    },
+    onCopy: async (child, index) => {
+      const newObject = await cloneObject(child.data, resolve, db);
+      db.add(newObject);
+      Obj.change(collection, (c) => {
+        if (typeof index !== "undefined") {
+          c.objects.splice(index, 0, Ref.make(newObject));
+        } else {
+          c.objects.push(Ref.make(newObject));
+        }
+      });
+    }
+  };
+};
+var getSystemCollectionNodePartials = ({ collection, db, resolve }) => {
+  const metadata = resolve(collection.key);
+  return {
+    label: [
+      "typename label",
+      {
+        ns: collection.key,
+        count: 2
+      }
+    ],
+    icon: metadata.icon,
+    iconHue: metadata.iconHue,
+    acceptPersistenceClass: /* @__PURE__ */ new Set([
+      "echo"
+    ]),
+    acceptPersistenceKey: /* @__PURE__ */ new Set([
+      db.spaceId
+    ]),
+    role: "branch"
+  };
+};
+var getSchemaGraphNodePartials = () => {
+  return {
+    role: "branch",
+    canDrop: () => false
+  };
+};
+var checkPendingMigration = (space) => {
+  return space.state.get() === SpaceState.SPACE_REQUIRES_MIGRATION || space.state.get() === SpaceState.SPACE_READY && !!Migrations.versionProperty && space.properties[Migrations.versionProperty] !== Migrations.targetVersion;
+};
+var constructSpaceNode = ({ space, navigable = false, personal, namesCache, resolve, graph, spacesOrder }) => {
+  const hasPendingMigration = checkPendingMigration(space);
+  const collection = space.state.get() === SpaceState.SPACE_READY && space.properties[Collection.Collection.typename]?.target;
+  const partials = space.state.get() === SpaceState.SPACE_READY && Obj.instanceOf(Collection.Collection, collection) ? getCollectionGraphNodePartials({
+    collection,
+    db: space.db,
+    resolve
+  }) : {};
+  const onRearrange = graph && spacesOrder ? (nextOrder) => {
+    Graph.sortEdges(graph, Node.RootId, "outbound", nextOrder.map(({ id }) => id));
+    Obj.change(spacesOrder, (mutableOrder) => {
+      mutableOrder.order = nextOrder.map(({ id }) => id);
+    });
+  } : void 0;
+  return {
+    id: space.id,
+    type: SPACE_TYPE,
+    cacheable: [
+      "label",
+      "icon",
+      "role"
+    ],
+    data: space,
+    properties: {
+      ...partials,
+      label: getSpaceDisplayName(space, {
+        personal,
+        namesCache
+      }),
+      description: space.state.get() === SpaceState.SPACE_READY && space.properties.description,
+      hue: space.state.get() === SpaceState.SPACE_READY && space.properties.hue,
+      icon: space.state.get() === SpaceState.SPACE_READY && space.properties.icon ? `ph--${space.properties.icon}--regular` : void 0,
+      iconHue: space.state.get() === SpaceState.SPACE_READY && space.properties.iconHue,
+      disabled: !navigable || space.state.get() !== SpaceState.SPACE_READY || hasPendingMigration,
+      disposition: "workspace",
+      testId: "spacePlugin.space",
+      onRearrange,
+      canDrop: (source) => {
+        return Obj.isObject(source.item.data) || isSpace(source.item.data);
+      }
+    },
+    nodes: [
+      {
+        id: `settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
+        type: `${meta.id}/settings`,
+        data: null,
+        properties: {
+          label: [
+            "settings panel label",
+            {
+              ns: meta.id
+            }
+          ],
+          icon: "ph--faders--regular",
+          disposition: "alternate-tree"
+        },
+        nodes: [
+          {
+            id: `properties-settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
+            type: `${meta.id}/properties`,
+            data: `${meta.id}/properties`,
+            properties: {
+              label: [
+                "space settings properties label",
+                {
+                  ns: meta.id
+                }
+              ],
+              icon: "ph--sliders--regular",
+              position: "hoist",
+              testId: "spacePlugin.general"
+            }
+          },
+          {
+            id: `members-settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
+            type: `${meta.id}/members`,
+            data: `${meta.id}/members`,
+            properties: {
+              label: [
+                "members panel label",
+                {
+                  ns: meta.id
+                }
+              ],
+              icon: "ph--users--regular",
+              position: "hoist",
+              testId: "spacePlugin.members"
+            }
+          },
+          {
+            id: `schema-settings${ATTENDABLE_PATH_SEPARATOR}${space.id}`,
+            type: `${meta.id}/schema`,
+            data: `${meta.id}/schema`,
+            properties: {
+              label: [
+                "space settings schema label",
+                {
+                  ns: meta.id
+                }
+              ],
+              icon: "ph--shapes--regular",
+              testId: "spacePlugin.schema"
+            }
+          }
+        ]
+      }
+    ]
+  };
+};
+var constructSpaceActions = ({ space, personal, migrating }) => {
+  const state = space.state.get();
+  const hasPendingMigration = checkPendingMigration(space);
+  const getId = (id) => `${id}/${space.id}`;
+  const actions = [];
+  if (hasPendingMigration) {
+    actions.push({
+      id: getId(SpaceOperation.Migrate.meta.key),
+      type: Node.ActionGroupType,
+      data: () => Operation.invoke(SpaceOperation.Migrate, {
+        space
+      }),
+      properties: {
+        label: [
+          "migrate space label",
+          {
+            ns: meta.id
+          }
+        ],
+        icon: "ph--database--regular",
+        disposition: "list-item-primary",
+        disabled: migrating || Migrations.running(space)
+      }
+    });
+  }
+  if (state === SpaceState.SPACE_READY && !hasPendingMigration) {
+    actions.push({
+      id: getId(SpaceOperation.OpenCreateObject.meta.key),
+      type: Node.ActionType,
+      data: () => Operation.invoke(SpaceOperation.OpenCreateObject, {
+        target: space.db
+      }),
+      properties: {
+        label: [
+          "create object in space label",
+          {
+            ns: meta.id
+          }
+        ],
+        icon: "ph--plus--regular",
+        disposition: "item",
+        testId: "spacePlugin.createObject"
+      }
+    }, {
+      id: getId(SpaceOperation.Rename.meta.key),
+      type: Node.ActionType,
+      data: (params) => Operation.invoke(SpaceOperation.Rename, {
+        space,
+        caller: params?.caller
+      }),
+      properties: {
+        label: [
+          "rename space label",
+          {
+            ns: meta.id
+          }
+        ],
+        icon: "ph--pencil-simple-line--regular",
+        keyBinding: {
+          macos: "shift+F6",
+          windows: "shift+F6"
+        }
+      }
+    });
+  }
+  return actions;
+};
+var createStaticSchemaNode = ({ schema, space }) => {
+  return {
+    id: `${space.id}/${Type.getTypename(schema)}`,
+    type: `${meta.id}/static-schema`,
+    data: schema,
+    properties: {
+      label: [
+        "typename label",
+        {
+          ns: Type.getTypename(schema),
+          count: 2,
+          default: Type.getTypename(schema)
+        }
+      ],
+      icon: "ph--database--regular",
+      iconHue: "green",
+      role: "branch",
+      selectable: false,
+      canDrop: () => false,
+      space
+    }
+  };
+};
+var createStaticSchemaActions = ({ schema, space, deletable }) => {
+  const getId = (id) => `${space.id}/${Type.getTypename(schema)}/${id}`;
+  const actions = [
+    {
+      id: getId(SpaceOperation.AddObject.meta.key),
+      type: Node.ActionType,
+      data: () => Operation.invoke(SpaceOperation.OpenCreateObject, {
+        target: space.db,
+        views: true,
+        initialFormValues: {
+          typename: Type.getTypename(schema)
+        }
+      }),
+      properties: {
+        label: [
+          "add view to schema label",
+          {
+            ns: meta.id
+          }
+        ],
+        icon: "ph--plus--regular",
+        disposition: "list-item-primary",
+        testId: "spacePlugin.addViewToSchema"
+      }
+    },
+    {
+      id: getId(SpaceOperation.RenameObject.meta.key),
+      type: Node.ActionType,
+      data: () => Effect.fail(new Error("Not implemented")),
+      properties: {
+        label: [
+          "rename object label",
+          {
+            ns: Type.getTypename(Type.PersistentType)
+          }
+        ],
+        icon: "ph--pencil-simple-line--regular",
+        disabled: true,
+        disposition: "list-item",
+        testId: "spacePlugin.renameObject"
+      }
+    },
+    {
+      id: getId(SpaceOperation.RemoveObjects.meta.key),
+      type: Node.ActionType,
+      data: () => Effect.sync(() => {
+        const index = space.properties.staticRecords.findIndex((typename) => typename === Type.getTypename(schema));
+        if (index > -1) {
+          Obj.change(space.properties, (p) => {
+            p.staticRecords.splice(index, 1);
+          });
+        }
+      }),
+      properties: {
+        label: [
+          "delete object label",
+          {
+            ns: Type.getTypename(Type.PersistentType)
+          }
+        ],
+        icon: "ph--trash--regular",
+        disposition: "list-item",
+        disabled: !deletable,
+        testId: "spacePlugin.deleteObject"
+      }
+    },
+    {
+      id: getId(SpaceOperation.Snapshot.meta.key),
+      type: Node.ActionType,
+      data: Effect.fnUntraced(function* () {
+        const result = yield* Operation.invoke(SpaceOperation.Snapshot, {
+          db: space.db,
+          query: Query.select(Filter.type(schema)).ast
+        });
+        if (result.snapshot) {
+          yield* Effect.tryPromise(() => downloadBlob(result.snapshot, createFilename({
+            parts: [
+              space.id,
+              Type.getTypename(schema)
+            ],
+            ext: "json"
+          })));
+        }
+      }),
+      properties: {
+        label: [
+          "snapshot by schema label",
+          {
+            ns: meta.id
+          }
+        ],
+        icon: "ph--camera--regular",
+        disposition: "list-item"
+      }
+    }
+  ];
+  return actions;
+};
+var createObjectNode = ({ db, object, disposition, droppable = true, navigable = false, managedCollectionChild = false, resolve, parentCollection }) => {
+  const type = Obj.getTypename(object);
+  if (!type) {
+    return null;
+  }
+  const metadata = resolve(type);
+  const partials = Obj.instanceOf(Collection.Collection, object) ? getCollectionGraphNodePartials({
+    collection: object,
+    db,
+    resolve
+  }) : Obj.instanceOf(Collection.Managed, object) ? getSystemCollectionNodePartials({
+    collection: object,
+    db,
+    resolve
+  }) : Obj.instanceOf(Type.PersistentType, object) ? getSchemaGraphNodePartials() : metadata.graphProps;
+  const label = object.name || Obj.getLabel(object) || // TODO(wittjosiah): Remove metadata labels.
+  metadata.label?.(object) || [
+    "object name placeholder",
+    {
+      ns: type,
+      default: "New item"
+    }
+  ];
+  const selectable = !Obj.instanceOf(Type.PersistentType, object) && !Obj.instanceOf(Collection.Managed, object) && !Obj.instanceOf(Collection.Collection, object) || navigable && Obj.instanceOf(Collection.Collection, object);
+  return {
+    id: Obj.getDXN(object).toString(),
+    type,
+    cacheable: [
+      "label",
+      "icon",
+      "role"
+    ],
+    data: object,
+    properties: {
+      label,
+      icon: metadata.icon ?? "ph--placeholder--regular",
+      iconHue: metadata.iconHue,
+      disposition,
+      testId: "spacePlugin.object",
+      persistenceClass: "echo",
+      persistenceKey: db.spaceId,
+      selectable,
+      managedCollectionChild,
+      onRearrange: parentCollection ? (nextOrder) => {
+        Obj.change(parentCollection, (c) => {
+          c.objects = nextOrder.filter(Obj.isObject).map(Ref.make);
+        });
+      } : void 0,
+      blockInstruction: (source, instruction) => {
+        if (source.item.properties.managedCollectionChild) {
+          return true;
+        }
+        if (Obj.instanceOf(Collection.Managed, object)) {
+          return !instruction.type.startsWith("reorder");
+        }
+        return managedCollectionChild;
+      },
+      canDrop: (source) => {
+        return droppable && Node.isGraphNode(source.item) && Obj.isObject(source.item.data);
+      },
+      ...partials
+    }
+  };
+};
+var constructObjectActions = ({ object, graph, resolve, capabilities, deletable = true, navigable = false }) => {
+  const db = Obj.getDatabase(object);
+  invariant(db, "Database not found", {
+    F: __dxlog_file,
+    L: 544,
+    S: void 0,
+    A: [
+      "db",
+      "'Database not found'"
+    ]
+  });
+  const typename = Obj.getTypename(object);
+  invariant(typename, "Object has no typename", {
+    F: __dxlog_file,
+    L: 546,
+    S: void 0,
+    A: [
+      "typename",
+      "'Object has no typename'"
+    ]
+  });
+  const getId = (id) => `${id}/${Obj.getDXN(object).toString()}`;
+  const managedCollection = Obj.instanceOf(Collection.Managed, object) ? object : void 0;
+  const metadata = managedCollection ? resolve(managedCollection.key) : {};
+  const createObject = metadata.createObject;
+  const inputSchema = metadata.inputSchema;
+  const actions = [
+    ...Obj.instanceOf(Collection.Collection, object) ? [
+      {
+        id: getId(SpaceOperation.OpenCreateObject.meta.key),
+        type: Node.ActionType,
+        data: () => Operation.invoke(SpaceOperation.OpenCreateObject, {
+          target: object
+        }),
+        properties: {
+          label: [
+            "create object in collection label",
+            {
+              ns: meta.id
+            }
+          ],
+          icon: "ph--plus--regular",
+          disposition: "list-item-primary",
+          testId: "spacePlugin.createObject"
+        }
+      }
+    ] : [],
+    ...Obj.instanceOf(Type.PersistentType, object) ? [
+      {
+        id: getId(SpaceOperation.AddObject.meta.key),
+        type: Node.ActionType,
+        data: () => Operation.invoke(SpaceOperation.OpenCreateObject, {
+          target: db,
+          views: true,
+          initialFormValues: {
+            typename: object.typename
+          }
+        }),
+        properties: {
+          label: [
+            "add view to schema label",
+            {
+              ns: meta.id
+            }
+          ],
+          icon: "ph--plus--regular",
+          disposition: "list-item-primary",
+          testId: "spacePlugin.addViewToSchema"
+        }
+      },
+      {
+        id: getId(SpaceOperation.Snapshot.meta.key),
+        type: Node.ActionType,
+        data: Effect.fnUntraced(function* () {
+          const result = yield* Operation.invoke(SpaceOperation.Snapshot, {
+            db,
+            query: Query.select(Filter.type(Type.toEffectSchema(object.jsonSchema))).ast
+          });
+          if (result.snapshot) {
+            yield* Effect.promise(() => downloadBlob(result.snapshot, createFilename({
+              parts: [
+                db.spaceId,
+                object.typename
+              ],
+              ext: "json"
+            })));
+          }
+        }),
+        properties: {
+          label: [
+            "snapshot by schema label",
+            {
+              ns: meta.id
+            }
+          ],
+          icon: "ph--camera--regular",
+          disposition: "list-item"
+        }
+      }
+    ] : [],
+    ...createObject ? [
+      {
+        id: getId(SpaceOperation.OpenCreateObject.meta.key),
+        type: Node.ActionType,
+        data: Effect.fnUntraced(function* () {
+          if (inputSchema) {
+            yield* Operation.invoke(SpaceOperation.OpenCreateObject, {
+              target: db,
+              typename: managedCollection ? managedCollection.key : void 0
+            });
+          } else {
+            const createdObject = yield* createObject({}, {
+              db,
+              capabilities
+            });
+            const addResult = yield* Operation.invoke(SpaceOperation.AddObject, {
+              target: db,
+              hidden: true,
+              object: createdObject
+            });
+            if (addResult.id) {
+              yield* Operation.invoke(Common.LayoutOperation.Open, {
+                subject: [
+                  addResult.id
+                ]
+              });
+            }
+          }
+        }),
+        properties: {
+          label: [
+            "create object in system collection label",
+            {
+              ns: meta.id
+            }
+          ],
+          icon: "ph--plus--regular",
+          disposition: "list-item-primary",
+          testId: "spacePlugin.createObject"
+        }
+      }
+    ] : [],
+    ...managedCollection ? [] : [
+      {
+        id: getId(SpaceOperation.RenameObject.meta.key),
+        type: Node.ActionType,
+        data: (params) => Operation.invoke(SpaceOperation.RenameObject, {
+          object,
+          caller: params?.caller
+        }),
+        properties: {
+          label: [
+            "rename object label",
+            {
+              ns: typename
+            }
+          ],
+          icon: "ph--pencil-simple-line--regular",
+          disposition: "list-item",
+          // TODO(wittjosiah): Not working.
+          // keyBinding: {
+          //   macos: 'shift+F6',
+          // },
+          testId: "spacePlugin.renameObject"
+        }
+      },
+      {
+        id: getId(SpaceOperation.RemoveObjects.meta.key),
+        type: Node.ActionType,
+        data: Effect.fnUntraced(function* () {
+          const collection = Graph.getConnections(graph, Obj.getDXN(object).toString(), "inbound").find((node) => Obj.instanceOf(Collection.Collection, node.data))?.data;
+          yield* Operation.invoke(SpaceOperation.RemoveObjects, {
+            objects: [
+              object
+            ],
+            target: collection
+          });
+        }),
+        properties: {
+          label: [
+            "delete object label",
+            {
+              ns: typename
+            }
+          ],
+          icon: "ph--trash--regular",
+          disposition: "list-item",
+          disabled: !deletable,
+          // TODO(wittjosiah): This is a browser shortcut.
+          // keyBinding: object instanceof CollectionType ? undefined : 'shift+meta+Backspace',
+          testId: "spacePlugin.deleteObject"
+        }
+      }
+    ],
+    ...navigable || !Obj.instanceOf(Collection.Collection, object) && !Obj.instanceOf(Collection.Managed, object) && !Obj.instanceOf(Type.PersistentType, object) ? [
+      {
+        id: getId("copy-link"),
+        type: Node.ActionType,
+        data: () => Effect.promise(async () => {
+          const url = `${window.location.origin}/${db.spaceId}/${Obj.getDXN(object).toString()}`;
+          await navigator.clipboard.writeText(url);
+        }),
+        properties: {
+          label: [
+            "copy link label",
+            {
+              ns: meta.id
+            }
+          ],
+          icon: "ph--link--regular",
+          disposition: "list-item",
+          testId: "spacePlugin.copyLink"
+        }
+      }
+    ] : [],
+    // TODO(wittjosiah): Factor out and apply to all nodes.
+    {
+      id: getId(Common.LayoutOperation.Expose.meta.key),
+      type: Node.ActionType,
+      data: () => Operation.invoke(Common.LayoutOperation.Expose, {
+        subject: Obj.getDXN(object).toString()
+      }),
+      properties: {
+        label: [
+          "expose object label",
+          {
+            ns: meta.id
+          }
+        ],
+        icon: "ph--eye--regular",
+        disposition: "heading-list-item",
+        testId: "spacePlugin.exposeObject"
+      }
+    }
+  ];
+  return actions;
+};
+var downloadBlob = async (blob, filename) => {
+  const url = URL.createObjectURL(blob);
+  const a = document.createElement("a");
+  a.href = url;
+  a.download = filename;
+  document.body.appendChild(a);
+  a.click();
+  document.body.removeChild(a);
+  URL.revokeObjectURL(url);
+};
+var getNestedObjects = async (object, resolve) => {
+  const type = Obj.getTypename(object);
+  if (!type) {
+    return [];
+  }
+  const metadata = resolve(type);
+  const loadReferences = metadata?.loadReferences;
+  if (typeof loadReferences !== "function") {
+    return [];
+  }
+  const objects = await loadReferences(object);
+  const nested = await Promise.all(objects.map((object2) => getNestedObjects(object2, resolve)));
+  return [
+    ...objects,
+    ...nested.flat()
+  ];
+};
+var cloneObject = async (object, resolve, newDb) => {
+  const schema = Obj.getSchema(object);
+  const typename = schema ? Type.getTypename(schema) ?? Expando.Expando.typename : Expando.Expando.typename;
+  const metadata = resolve(typename);
+  const serializer = metadata.serializer;
+  invariant(serializer, `No serializer for type: ${typename}`, {
+    F: __dxlog_file,
+    L: 776,
+    S: void 0,
+    A: [
+      "serializer",
+      "`No serializer for type: ${typename}`"
+    ]
+  });
+  const content = await serializer.serialize({
+    object
+  });
+  return serializer.deserialize({
+    content,
+    db: newDb,
+    newId: true
+  });
+};
+
+export {
+  SPACES,
+  COMPOSER_SPACE_LOCK,
+  SHARED,
+  getSpaceDisplayName,
+  constructSpaceNode,
+  constructSpaceActions,
+  createStaticSchemaNode,
+  createStaticSchemaActions,
+  createObjectNode,
+  constructObjectActions,
+  getNestedObjects,
+  cloneObject
+};
+//# sourceMappingURL=chunk-7KMYUWSR.mjs.map