@dxos/app-framework 0.3.9-main.cea1d3b → 0.3.9-main.ee9a520

package/src/plugins/SurfacePlugin/helpers.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+/**
+ * Checks if the given data is an object and not null.
+ *
+ * Useful inside surface component resolvers as a type guard.
+ *
+ * @example
+ * ```ts
+ *  const old =
+ *    data.content &&
+ *      typeof data.content === 'object' &&
+ *      'id' in data.content &&
+ *      typeof data.content.id === 'string';
+ *
+ *  // becomes
+ *  const new = isObject(data.content) && typeof data.content.id === 'string';
+ * ```
+ */
+export const isObject = (data: unknown): data is { [key: string]: unknown } => !!data && typeof data === 'object';

package/src/plugins/SurfacePlugin/index.ts

@@ -2,6 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './helpers';
 export * from './provides';
 
 export * from './ErrorBoundary';

package/src/plugins/common/graph.ts

@@ -10,7 +10,7 @@ import type { Plugin } from '../PluginHost';
 /**
  * Provides for a plugin that exposes the application graph.
  */
-export type GraphPluginProvides = {
+export type GraphProvides = {
   graph: Graph;
 };
 
@@ -24,7 +24,7 @@ export type GraphBuilderProvides = {
  * Type guard for graph plugins.
  */
 export const parseGraphPlugin = (plugin: Plugin) =>
-  (plugin.provides as any).graph?.root ? (plugin as Plugin<GraphPluginProvides>) : undefined;
+  (plugin.provides as any).graph?.root ? (plugin as Plugin<GraphProvides>) : undefined;
 
 /**
  * Type guard for graph builder plugins.

package/dist/lib/node/chunk-YDKX45O3.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/plugins/SurfacePlugin/provides.ts", "../../../src/plugins/SurfacePlugin/SurfaceRootContext.tsx", "../../../src/plugins/SurfacePlugin/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type SurfaceComponent, type SurfaceRootContext } from './SurfaceRootContext';\nimport { type Plugin } from '../PluginHost';\n\nexport type SurfaceProvides = {\n  surface: {\n    /**\n     * Used by the `Surface` resolver to find a component to render.\n     */\n    component: SurfaceComponent;\n  };\n};\n\nexport type SurfacePluginProvides = {\n  surface: SurfaceRootContext;\n};\n\nexport const parseRootSurfacePlugin = (plugin?: Plugin) =>\n  (plugin?.provides as any)?.surface?.components ? (plugin as Plugin<SurfacePluginProvides>) : undefined;\n\nexport const parseSurfacePlugin = (plugin?: Plugin) =>\n  (plugin?.provides as any)?.surface?.component ? (plugin as Plugin<SurfaceProvides>) : undefined;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { createContext, useContext, type Context, type Provider, type ReactNode, type ForwardedRef } from 'react';\n\nimport { type SurfaceProps } from './Surface';\n\n// TODO(wittjosiah): Factor out.\ntype WithRequiredProperty<Type, Key extends keyof Type> = Type & {\n  [Property in Key]-?: Type[Property];\n};\n\ntype SurfaceComponentProps = WithRequiredProperty<SurfaceProps, 'data'>;\n\n/**\n * Function which resolves a Surface.\n *\n * If a null value is returned, the rendering is deferred to other plugins.\n */\nexport type SurfaceComponent = (props: SurfaceComponentProps, forwardedRef: ForwardedRef<HTMLElement>) => ReactNode;\n\nexport type SurfaceRootContext = {\n  components: Record<string, SurfaceComponent>;\n};\n\nconst SurfaceRootContext: Context<SurfaceRootContext> = createContext<SurfaceRootContext>({ components: {} });\n\nexport const useSurface = () => useContext(SurfaceRootContext);\n\nexport const SurfaceProvider: Provider<SurfaceRootContext> = SurfaceRootContext.Provider;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nconst SurfaceMeta = {\n  id: 'dxos.org/plugin/surface',\n};\n\nexport default SurfaceMeta;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;ACIA,mBAA0G;ADgBnG,IAAMA,yBAAyB,CAACC,WACpCA,QAAQC,UAAkBC,SAASC,aAAcH,SAA2CI;AAExF,IAAMC,qBAAqB,CAACL,WAChCA,QAAQC,UAAkBC,SAASI,YAAaN,SAAqCI;ACExF,IAAMG,qBAAkDC,gDAAkC;EAAEL,YAAY,CAAC;AAAE,CAAA;AAEpG,IAAMM,aAAa,UAAMC,yBAAWH,kBAAAA;AAEpC,IAAMI,kBAAgDJ,mBAAmBK;AC1BhF,IAAMC,cAAc;EAClBC,IAAI;AACN;AAEA,IAAA,eAAeD;",
-  "names": ["parseRootSurfacePlugin", "plugin", "provides", "surface", "components", "undefined", "parseSurfacePlugin", "component", "SurfaceRootContext", "createContext", "useSurface", "useContext", "SurfaceProvider", "Provider", "SurfaceMeta", "id"]
-}