@dxos/plugin-template 0.8.4-main.fd6878d → 0.8.4-main.fffef41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/plugin-template",
-  "version": "0.8.4-main.fd6878d",
+  "version": "0.8.4-main.fffef41",
   "description": "Template for new plugin",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -34,34 +34,35 @@
   ],
   "dependencies": {
     "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
-    "effect": "3.17.7",
-    "@dxos/app-framework": "0.8.4-main.fd6878d",
-    "@dxos/async": "0.8.4-main.fd6878d",
-    "@dxos/echo": "0.8.4-main.fd6878d",
-    "@dxos/echo-schema": "0.8.4-main.fd6878d",
-    "@dxos/plugin-client": "0.8.4-main.fd6878d",
-    "@dxos/plugin-graph": "0.8.4-main.fd6878d",
-    "@dxos/plugin-space": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-stack": "0.8.4-main.fd6878d",
-    "@dxos/react-client": "0.8.4-main.fd6878d"
+    "@preact/signals-core": "^1.12.1",
+    "@radix-ui/react-context": "1.1.1",
+    "effect": "3.18.3",
+    "@dxos/app-framework": "0.8.4-main.fffef41",
+    "@dxos/async": "0.8.4-main.fffef41",
+    "@dxos/plugin-client": "0.8.4-main.fffef41",
+    "@dxos/plugin-graph": "0.8.4-main.fffef41",
+    "@dxos/echo": "0.8.4-main.fffef41",
+    "@dxos/plugin-space": "0.8.4-main.fffef41",
+    "@dxos/react-client": "0.8.4-main.fffef41",
+    "@dxos/react-ui-stack": "0.8.4-main.fffef41",
+    "@dxos/util": "0.8.4-main.fffef41"
   },
   "devDependencies": {
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/react-ui": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-theme": "0.8.4-main.fd6878d",
-    "@dxos/storybook-utils": "0.8.4-main.fd6878d"
+    "@types/react": "~19.2.2",
+    "@types/react-dom": "~19.2.2",
+    "react": "~19.2.0",
+    "react-dom": "~19.2.0",
+    "vite": "7.1.9",
+    "@dxos/react-ui": "0.8.4-main.fffef41",
+    "@dxos/storybook-utils": "0.8.4-main.fffef41",
+    "@dxos/react-ui-theme": "0.8.4-main.fffef41"
   },
   "peerDependencies": {
     "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-theme": "0.8.4-main.fd6878d"
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "@dxos/react-ui": "0.8.4-main.fffef41",
+    "@dxos/react-ui-theme": "0.8.4-main.fffef41"
   },
   "publishConfig": {
     "access": "public"

package/src/TemplatePlugin.tsx

@@ -12,49 +12,49 @@ import { meta } from './meta';
 import { translations } from './translations';
 import { Template } from './types';
 
-export const TemplatePlugin = () =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${meta.id}/module/metadata`,
-      activatesOn: Events.SetupMetadata,
-      activate: () =>
-        contributes(Capabilities.Metadata, {
-          id: Template.Data.typename,
-          metadata: {
-            icon: 'ph--asterisk--regular',
-          },
+export const TemplatePlugin = definePlugin(meta, () => [
+  defineModule({
+    id: `${meta.id}/module/translations`,
+    activatesOn: Events.SetupTranslations,
+    activate: () => contributes(Capabilities.Translations, translations),
+  }),
+  defineModule({
+    id: `${meta.id}/module/metadata`,
+    activatesOn: Events.SetupMetadata,
+    activate: () =>
+      contributes(Capabilities.Metadata, {
+        id: Template.Data.typename,
+        metadata: {
+          icon: 'ph--asterisk--regular',
+          iconHue: 'sky',
+        },
+      }),
+  }),
+  defineModule({
+    id: `${meta.id}/module/object-form`,
+    activatesOn: ClientEvents.SetupSchema,
+    activate: () =>
+      contributes(
+        SpaceCapabilities.ObjectForm,
+        defineObjectForm({
+          objectSchema: Template.Data,
+          getIntent: () => createIntent(Template.Create),
         }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/object-form`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () =>
-        contributes(
-          SpaceCapabilities.ObjectForm,
-          defineObjectForm({
-            objectSchema: Template.Data,
-            getIntent: () => createIntent(Template.Create),
-          }),
-        ),
-    }),
-    defineModule({
-      id: `${meta.id}/module/schema`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () => contributes(ClientCapabilities.Schema, [Template.Data]),
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
-      activate: ReactSurface,
-    }),
-    defineModule({
-      id: `${meta.id}/module/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: IntentResolver,
-    }),
-  ]);
+      ),
+  }),
+  defineModule({
+    id: `${meta.id}/module/schema`,
+    activatesOn: ClientEvents.SetupSchema,
+    activate: () => contributes(ClientCapabilities.Schema, [Template.Data]),
+  }),
+  defineModule({
+    id: `${meta.id}/module/react-surface`,
+    activatesOn: Events.SetupReactSurface,
+    activate: ReactSurface,
+  }),
+  defineModule({
+    id: `${meta.id}/module/intent-resolver`,
+    activatesOn: Events.SetupIntentResolver,
+    activate: IntentResolver,
+  }),
+]);

package/src/components/Example/Example.stories.tsx

@@ -0,0 +1,32 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { Example, type ExampleRootProps } from './Example';
+
+const DefaultStory = (props: ExampleRootProps) => {
+  return <Example.Root {...props} />;
+};
+
+const meta = {
+  title: 'ui/react-ui-core/Example',
+  component: Example.Root,
+  render: DefaultStory,
+  decorators: [withTheme, withLayout({ container: 'column' })],
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};

package/src/components/Example/Example.tsx

@@ -0,0 +1,54 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { createContext } from '@radix-ui/react-context';
+import React, { type PropsWithChildren } from 'react';
+
+import { type ThemedClassName } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
+
+//
+// Context
+//
+
+type ExampleContextValue = {};
+
+const [ExampleContextProvider, useExampleContext] = createContext<ExampleContextValue>('Example');
+
+//
+// Root
+//
+
+type ExampleRootProps = PropsWithChildren<{}>;
+
+const ExampleRoot = ({ children }: ExampleRootProps) => {
+  return <ExampleContextProvider>{children}</ExampleContextProvider>;
+};
+
+ExampleRoot.displayName = 'Example.Root';
+
+//
+// Content
+//
+
+type ExampleContentProps = ThemedClassName<{}>;
+
+const ExampleContent = ({ classNames }: ExampleContentProps) => {
+  const context = useExampleContext(ExampleContent.displayName);
+  return <div className={mx(classNames)}>{JSON.stringify(context)}</div>;
+};
+
+ExampleContent.displayName = 'Example.Content';
+
+//
+// Example
+// https://www.radix-ui.com/primitives/docs/guides/composition
+//
+
+export const Example = {
+  Root: ExampleRoot,
+  Content: ExampleContent,
+};
+
+export type { ExampleRootProps, ExampleContentProps };

package/src/components/Example/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './Example';

package/src/components/TemplateContainer.tsx

@@ -4,15 +4,14 @@
 
 import React from 'react';
 
-import { type Obj } from '@dxos/echo';
-import { fullyQualifiedId } from '@dxos/react-client/echo';
+import { Obj } from '@dxos/echo';
 import { StackItem } from '@dxos/react-ui-stack';
 
 export const TemplateContainer = ({ object }: { object: Obj.Any; role: string }) => {
   return (
     <StackItem.Content>
       <pre className='m-4 p-2 ring'>
-        <span>{fullyQualifiedId(object)}</span>
+        <span>{Obj.getDXN(object).toString()}</span>
       </pre>
     </StackItem.Content>
   );

package/src/components/index.ts

@@ -2,4 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './Example';
 export * from './TemplateContainer';

package/src/meta.ts

@@ -3,10 +3,16 @@
 //
 
 import { type PluginMeta } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
 export const meta: PluginMeta = {
   id: 'dxos.org/plugin/template',
   name: 'Template',
+  description: trim`
+    Create reusable templates for documents, tables, and other objects.
+    Define structured patterns that can be quickly instantiated with pre-configured content and settings.
+  `,
   icon: 'ph--asterisk--regular',
+  iconHue: 'sky',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-template',
 };

package/src/types/schema.ts

@@ -2,10 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 import { Obj } from '@dxos/echo';
-import { TypedObject } from '@dxos/echo-schema';
+import { TypedObject } from '@dxos/echo/internal';
 import { ReactiveObjectSchema } from '@dxos/react-client/echo';
 
 import { meta } from '../meta';

package/dist/lib/browser/chunk-LT6IO5CC.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/schema.ts", "../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Schema } from 'effect';\n\nimport { Obj } from '@dxos/echo';\nimport { TypedObject } from '@dxos/echo-schema';\nimport { ReactiveObjectSchema } from '@dxos/react-client/echo';\n\nimport { meta } from '../meta';\n\nexport namespace Template {\n  export class Create extends Schema.TaggedClass<Create>()(`${meta.id}/action/create`, {\n    input: Schema.Struct({\n      name: Schema.optional(Schema.String),\n    }),\n    output: Schema.Struct({\n      object: ReactiveObjectSchema,\n    }),\n  }) {}\n\n  export class Data extends TypedObject({\n    typename: 'dxos.org/type/Data',\n    version: '0.1.0',\n  })({\n    name: Schema.optional(Schema.String),\n  }) {}\n\n  export const make = (props: Partial<Data>) => Obj.make(Data, props);\n}\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const meta: PluginMeta = {\n  id: 'dxos.org/plugin/template',\n  name: 'Template',\n  icon: 'ph--asterisk--regular',\n  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-template',\n};\n"],
-  "mappings": ";AAIA,SAASA,cAAc;AAEvB,SAASC,WAAW;AACpB,SAASC,mBAAmB;AAC5B,SAASC,4BAA4B;;;ACF9B,IAAMC,OAAmB;EAC9BC,IAAI;EACJC,MAAM;EACNC,MAAM;EACNC,QAAQ;AACV;;;UDCiBC,WAAAA;EACR,MAAMC,eAAeC,OAAOC,YAAW,EAAW,GAAGC,KAAKC,EAAE,kBAAkB;IACnFC,OAAOJ,OAAOK,OAAO;MACnBC,MAAMN,OAAOO,SAASP,OAAOQ,MAAM;IACrC,CAAA;IACAC,QAAQT,OAAOK,OAAO;MACpBK,QAAQC;IACV,CAAA;EACF,CAAA,EAAA;EAAI;YAPSZ,SAAAA;EASN,MAAMa,aAAaC,YAAY;IACpCC,UAAU;IACVC,SAAS;EACX,CAAA,EAAG;IACDT,MAAMN,OAAOO,SAASP,OAAOQ,MAAM;EACrC,CAAA,EAAA;EAAI;YALSI,OAAAA;YAOAI,OAAO,CAACC,UAAyBC,IAAIF,KAAKJ,MAAMK,KAAAA;AAC/D,GAlBiBnB,aAAAA,WAAAA,CAAAA,EAAAA;;",
-  "names": ["Schema", "Obj", "TypedObject", "ReactiveObjectSchema", "meta", "id", "name", "icon", "source", "Template", "Create", "Schema", "TaggedClass", "meta", "id", "input", "Struct", "name", "optional", "String", "output", "object", "ReactiveObjectSchema", "Data", "TypedObject", "typename", "version", "make", "props", "Obj"]
-}

package/dist/lib/browser/react-surface-NRU2N7BS.mjs

@@ -1,40 +0,0 @@
-import {
-  Template,
-  meta
-} from "./chunk-LT6IO5CC.mjs";
-
-// src/capabilities/react-surface.tsx
-import React2 from "react";
-import { Capabilities, contributes, createSurface } from "@dxos/app-framework";
-import { Obj } from "@dxos/echo";
-
-// src/components/TemplateContainer.tsx
-import { useSignals as _useSignals } from "@preact-signals/safe-react/tracking";
-import React from "react";
-import { fullyQualifiedId } from "@dxos/react-client/echo";
-import { StackItem } from "@dxos/react-ui-stack";
-var TemplateContainer = ({ object }) => {
-  var _effect = _useSignals();
-  try {
-    return /* @__PURE__ */ React.createElement(StackItem.Content, null, /* @__PURE__ */ React.createElement("pre", {
-      className: "m-4 p-2 ring"
-    }, /* @__PURE__ */ React.createElement("span", null, fullyQualifiedId(object))));
-  } finally {
-    _effect.f();
-  }
-};
-
-// src/capabilities/react-surface.tsx
-var react_surface_default = () => contributes(Capabilities.ReactSurface, createSurface({
-  id: meta.id,
-  role: "article",
-  filter: (data) => Obj.instanceOf(Template.Data, data.subject),
-  component: ({ data, role }) => /* @__PURE__ */ React2.createElement(TemplateContainer, {
-    role,
-    object: data.subject
-  })
-}));
-export {
-  react_surface_default as default
-};
-//# sourceMappingURL=react-surface-NRU2N7BS.mjs.map

package/dist/lib/browser/react-surface-NRU2N7BS.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/react-surface.tsx", "../../../src/components/TemplateContainer.tsx"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Capabilities, contributes, createSurface } from '@dxos/app-framework';\nimport { Obj } from '@dxos/echo';\n\nimport { TemplateContainer } from '../components';\nimport { meta } from '../meta';\nimport { Template } from '../types';\n\nexport default () =>\n  contributes(\n    Capabilities.ReactSurface,\n    createSurface({\n      id: meta.id,\n      role: 'article',\n      filter: (data): data is { subject: Obj.Any } => Obj.instanceOf(Template.Data, data.subject),\n      component: ({ data, role }) => <TemplateContainer role={role} object={data.subject} />,\n    }),\n  );\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type Obj } from '@dxos/echo';\nimport { fullyQualifiedId } from '@dxos/react-client/echo';\nimport { StackItem } from '@dxos/react-ui-stack';\n\nexport const TemplateContainer = ({ object }: { object: Obj.Any; role: string }) => {\n  return (\n    <StackItem.Content>\n      <pre className='m-4 p-2 ring'>\n        <span>{fullyQualifiedId(object)}</span>\n      </pre>\n    </StackItem.Content>\n  );\n};\n"],
-  "mappings": ";;;;;;AAIA,OAAOA,YAAW;AAElB,SAASC,cAAcC,aAAaC,qBAAqB;AACzD,SAASC,WAAW;;;;ACHpB,OAAOC,WAAW;AAGlB,SAASC,wBAAwB;AACjC,SAASC,iBAAiB;AAEnB,IAAMC,oBAAoB,CAAC,EAAEC,OAAM,MAAqC;;;AAC7E,WACE,sBAAA,cAACC,UAAUC,SAAO,MAChB,sBAAA,cAACC,OAAAA;MAAIC,WAAU;OACb,sBAAA,cAACC,QAAAA,MAAMC,iBAAiBN,MAAAA,CAAAA,CAAAA,CAAAA;;;;AAIhC;;;ADLA,IAAA,wBAAe,MACbO,YACEC,aAAaC,cACbC,cAAc;EACZC,IAAIC,KAAKD;EACTE,MAAM;EACNC,QAAQ,CAACC,SAAuCC,IAAIC,WAAWC,SAASC,MAAMJ,KAAKK,OAAO;EAC1FC,WAAW,CAAC,EAAEN,MAAMF,KAAI,MAAO,gBAAAS,OAAA,cAACC,mBAAAA;IAAkBV;IAAYW,QAAQT,KAAKK;;AAC7E,CAAA,CAAA;",
-  "names": ["React", "Capabilities", "contributes", "createSurface", "Obj", "React", "fullyQualifiedId", "StackItem", "TemplateContainer", "object", "StackItem", "Content", "pre", "className", "span", "fullyQualifiedId", "contributes", "Capabilities", "ReactSurface", "createSurface", "id", "meta", "role", "filter", "data", "Obj", "instanceOf", "Template", "Data", "subject", "component", "React", "TemplateContainer", "object"]
-}