@orgajs/orgx 2.0.1 → 2.2.0

package/dist/lib/core.d.ts

@@ -29,7 +29,7 @@ export type BaseProcessorOptions = {
     /**
      * Whether to compile to a whole program or a function body..
      */
-    outputFormat?: 'function-body' | 'program';
+    outputFormat?: "function-body" | "program" | undefined;
     /**
      * List of recma (esast, JavaScript) plugins.
      */

package/dist/lib/evaluate.d.ts

@@ -1,5 +1,5 @@
 /**
- * Evaluate MDX.
+ * Evaluate Org Content.
  *
  * @param {VFileCompatible} vfileCompatible
  *   MDX document to parse (`string`, `Buffer`, `vfile`, anything that can be

package/dist/lib/plugin/rehype-recma.d.ts

@@ -40,10 +40,10 @@ export type MoreOptions = {
     /**
      * - Whether to skip imports
      */
-    skipImport?: boolean;
+    skipImport?: boolean | undefined;
     /**
      * - Specify which hast properties to parse as JSX.
      */
-    parseJSX?: string[];
+    parseJSX?: string[] | undefined;
 };
 export type Options = HastToEstreeOptions & MoreOptions;

package/dist/lib/types.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="react" />
+type FunctionComponent<Props> = (props: Props) => JSX.Element | null;
+type ClassComponent<Props> = new (props: Props) => JSX.ElementClass;
+type Component<Props> = FunctionComponent<Props> | ClassComponent<Props> | keyof JSX.IntrinsicElements;
+interface NestedOrgComponents {
+    [key: string]: NestedOrgComponents | Component<any>;
+}
+export type OrgComponents = NestedOrgComponents & {
+    [Key in keyof JSX.IntrinsicElements]?: Component<JSX.IntrinsicElements[Key]>;
+} & {
+    /**
+     * If a wrapper component is defined, the org content will be wrapped inside of it.
+     */
+    wrapper?: Component<any>;
+};
+export interface OrgProps {
+    /**
+     * Which props exactly may be passed into the component depends on the contents of the org
+     * file.
+     */
+    [key: string]: unknown;
+    /**
+     * This prop may be used to customize how certain components are rendered.
+     */
+    components?: OrgComponents;
+}
+export type OrgContent = (props: OrgProps) => JSX.Element;
+export interface OrgModule {
+    /**
+     * This could be any value that is exported from the org file.
+     */
+    [key: string]: unknown;
+    /**
+     * A functional JSX component which renders the content of the org file.
+     */
+    default: OrgContent;
+}
+export {};

package/lib/evaluate.js

@@ -9,7 +9,7 @@ import { run, runSync } from './run.js'
 import { resolveEvaluateOptions } from './util/resolve-evaluate-options.js'
 
 /**
- * Evaluate MDX.
+ * Evaluate Org Content.
  *
  * @param {VFileCompatible} vfileCompatible
  *   MDX document to parse (`string`, `Buffer`, `vfile`, anything that can be

package/lib/plugin/recma-jsx-rewrite.js

@@ -564,7 +564,7 @@ function createImportProvider(providerImportSource, outputFormat) {
   const specifiers = [
     {
       type: 'ImportSpecifier',
-      imported: { type: 'Identifier', name: 'useMDXComponents' },
+      imported: { type: 'Identifier', name: 'useOrgComponents' },
       local: { type: 'Identifier', name: '_provideComponents' },
     },
   ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orgajs/orgx",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "orga compiler with jsx support",
   "author": "Xiaoxing Hu <hi@xiaoxing.dev>",
   "license": "MIT",
@@ -19,21 +19,22 @@
   "files": [
     "lib",
     "dist",
-    "index.js"
+    "index.js",
+    "types.d.ts"
   ],
   "devDependencies": {
     "@types/estree": "^1.0.1",
     "@types/estree-jsx": "^1.0.0",
-    "@types/hast": "^2.3.4",
-    "@types/node": "^20.2.1",
-    "@types/react": "^18.2.6",
+    "@types/hast": "^2.3.5",
+    "@types/node": "^20.5.7",
+    "@types/react": "^18.2.21",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "acorn": "^8.5.0",
+    "acorn": "^8.10.0",
     "acorn-jsx": "^5.3.2",
-    "astring": "^1.7.5",
+    "astring": "^1.8.6",
     "estree-util-build-jsx": "2.2.2",
     "estree-util-is-identifier-name": "2.1.0",
     "estree-util-to-js": "^1.2.0",
@@ -45,8 +46,8 @@
     "unist-util-position-from-estree": "^1.1.2",
     "unist-util-stringify-position": "^3.0.3",
     "vfile": "^5.3.7",
-    "@orgajs/reorg-parse": "^4.0.0",
-    "@orgajs/reorg-rehype": "^4.0.0"
+    "@orgajs/reorg-parse": "^4.1.1",
+    "@orgajs/reorg-rehype": "^4.1.1"
   },
   "scripts": {
     "clean": "tsc --build --clean",

package/types.d.ts

@@ -0,0 +1,5 @@
+// TODO: move this to DefinitlyTyped
+declare module '*.org' {
+  import { OrgaProps } from '@orgajs/orgx'
+  export default function OrgaContent(props: OrgaProps): JSX.Element
+}