@wix/origami-transforms 0.1.24 → 0.1.25

package/dist/companionRegistrations.d.ts

@@ -8,11 +8,11 @@ export function readCompanionRegistrations(files: Iterable<readonly [string, str
  * @typedef {object} CompanionModule
  * @property {CompanionRegistration} registration
  * @property {CompanionImport} import How a page imports it: a component as its entry exports it, a context provider
- *   as the entry's default export.
+ *   as the entry's default export. A page imports a function library's functions by name instead.
  */
 /**
  * Every `@site/site-code/<name>` a page can import, by its `companionApp` name. A provider's hook is imported from
- * the provider's module.
+ * the provider's module, and a library's functions from the library's.
  * @param {ReadonlyMap<string, CompanionRegistration>} registrations
  * @returns {Map<string, CompanionModule>}
  */
@@ -28,7 +28,7 @@ export type CompanionModule = {
     registration: CompanionRegistration;
     /**
      * How a page imports it: a component as its entry exports it, a context provider
-     * as the entry's default export.
+     * as the entry's default export. A page imports a function library's functions by name instead.
      */
     import: CompanionImport;
 };
@@ -69,4 +69,16 @@ export type CompanionContextRegistration = {
      */
     hook: string;
 };
-export type CompanionRegistration = CompanionComponentRegistration | CompanionContextRegistration;
+export type CompanionFunctionLibraryRegistration = {
+    kind: "functionLibrary";
+    /**
+     * The registration's file.
+     */
+    path: string;
+    /**
+     * `resources.client.url`, relative to the companion app's `src`, as for a provider. Each
+     * function is a named export of the module.
+     */
+    source: string;
+};
+export type CompanionRegistration = CompanionComponentRegistration | CompanionContextRegistration | CompanionFunctionLibraryRegistration;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/origami-transforms",
-  "version": "0.1.24",
+  "version": "0.1.25",
   "description": "Babel and PostCSS checks and transforms for Wix origami page files.",
   "main": "./src/index.js",
   "files": [
@@ -69,5 +69,5 @@
   },
   "type": "module",
   "types": "./dist/index.d.ts",
-  "falconPackageHash": "398f6cf44892edee778a3cce4a42b93f61f9ffbea23beb4703826cf8"
+  "falconPackageHash": "db3ec4aae3575547cf339696d8292fb79c71ee28b5c2fd4bc94a032c"
 }

package/src/companionRegistrations.js

@@ -1,4 +1,4 @@
-// A companion app's `editorReactComponent` and `contextProvider` registrations, read the same way by the export
+// A companion app's `editorReactComponent`, `contextProvider` and `functionLibrary` registrations, read the same way by the export
 // (from the exported files) and by import-site (from disk), both in origami-site-generator.
 import { existsSync, readFileSync, readdirSync } from 'node:fs'
 import { posix } from 'node:path'
@@ -21,7 +21,17 @@ import * as t from '@babel/types'
  *   The module's default export is the provider.
  * @property {string} hook `resources.contextSpecifier.hook`, the module's named export that reads the context.
  */
-/** @typedef {CompanionComponentRegistration | CompanionContextRegistration} CompanionRegistration */
+/**
+ * @typedef {object} CompanionFunctionLibraryRegistration
+ * @property {'functionLibrary'} kind
+ * @property {string} path The registration's file.
+ * @property {string} source `resources.client.url`, relative to the companion app's `src`, as for a provider. Each
+ *   function is a named export of the module.
+ */
+/**
+ * @typedef {CompanionComponentRegistration | CompanionContextRegistration | CompanionFunctionLibraryRegistration}
+ *   CompanionRegistration
+ */
 
 /** @param {string} path */
 export const isExtensionFile = path => /\.extension\.[cm]?[jt]sx?$/.test(path)
@@ -37,13 +47,19 @@ export function readCompanionRegistrations(files) {
     for (const [path, source] of files) {
         const ast = parse(source, { sourceType: 'module', plugins: ['jsx', 'typescript'] })
         t.traverseFast(ast, node => {
-            if (!t.isCallExpression(node) || !t.isMemberExpression(node.callee)) return
-            const isComponent = t.isIdentifier(node.callee.property, { name: 'editorReactComponent' })
-            if (!isComponent && !t.isIdentifier(node.callee.property, { name: 'contextProvider' })) return
+            if (!t.isCallExpression(node) || !t.isMemberExpression(node.callee) || !t.isIdentifier(node.callee.property))
+                return
+            const kind = node.callee.property.name
+            if (!['editorReactComponent', 'contextProvider', 'functionLibrary'].includes(kind)) return
             const config = node.arguments[0]
             const type = property(config, 'type')
             const resources = property(config, 'resources')
-            const registration = isComponent ? component(ast, path, resources) : contextProvider(path, resources)
+            const registration =
+                kind === 'editorReactComponent'
+                    ? component(ast, path, resources)
+                    : kind === 'contextProvider'
+                      ? contextProvider(path, resources)
+                      : functionLibrary(path, resources)
             if (!t.isStringLiteral(type)) throw new Error(`Unsupported component registration: ${path}`)
             if (!/^companionApp\.[^.]+$/.test(type.value))
                 throw new Error(`Unsupported companion component namespace: ${type.value}`)
@@ -93,6 +109,16 @@ const contextProvider = (path, resources) => {
     return { kind: 'contextProvider', source: url.value, hook: hook.value }
 }
 
+/**
+ * @param {string} path @param {t.Expression | undefined} resources
+ * @returns {Omit<CompanionFunctionLibraryRegistration, 'path'>}
+ */
+const functionLibrary = (path, resources) => {
+    const url = property(property(resources, 'client'), 'url')
+    if (!t.isStringLiteral(url)) throw new Error(`Unsupported function library registration: ${path}`)
+    return { kind: 'functionLibrary', source: url.value }
+}
+
 /**
  * The file a relative import in `from` points at, without its query, before `findFile` fills in its extension.
  * @param {string} from @param {string} specifier
@@ -135,12 +161,12 @@ export const findFile = (target, exists) => candidates(target).find(exists)
  * @typedef {object} CompanionModule
  * @property {CompanionRegistration} registration
  * @property {CompanionImport} import How a page imports it: a component as its entry exports it, a context provider
- *   as the entry's default export.
+ *   as the entry's default export. A page imports a function library's functions by name instead.
  */
 
 /**
  * Every `@site/site-code/<name>` a page can import, by its `companionApp` name. A provider's hook is imported from
- * the provider's module.
+ * the provider's module, and a library's functions from the library's.
  * @param {ReadonlyMap<string, CompanionRegistration>} registrations
  * @returns {Map<string, CompanionModule>}
  */