@jahia/javascript-modules-library 0.0.1

package/types/core/server/components/render/HydrateInBrowser.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Will render the given React component server side and hydrate it in the browser to make it dynamic.
+ * Be careful, the component will not have access to the '@jahia/javascript-modules-library' library from the browser.
+ *
+ * @param {object} params The React component.
+ * @param {object} params.child The React component.
+ * @param {object} [params.props] The React component props, this props will be serialized/deserialized to be usable server and client side. The serialization and deserialization is done using JSON.stringify server side and JSON.parse in the browser. Please make sure that the props are serializable.
+ * @returns {JSX.Element} The component to be hydrated in the browser
+ */
+export function HydrateInBrowser({ child: Child, props }: {
+    child: object;
+    props?: object;
+}): JSX.Element;

package/types/core/server/components/render/Render.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Render a content node
+ * @param {object} props the properties for the render
+ * @param {object} [props.content] the content node to render
+ * @param {object} [props.node] the node to render
+ * @param {string} [props.path] the path to render
+ * @param {boolean} [props.editable] if the content should be editable
+ * @param {string} [props.advanceRenderingConfig] specifies if we should render a node or simply include a view. Acceptable values are : none, INCLUDE or OPTION
+ * @param {string} [props.templateType] the template type to use (html, json, ...)
+ * @param {string} [props.view] the name of the view variant to use
+ * @param {object} [props.parameters] the parameters to pass to the view
+ * @returns {JSX.Element} the rendered output of the view for the specified content
+ */
+export function Render({ content, node, path, editable, advanceRenderingConfig, templateType, view, parameters }: {
+    content?: object;
+    node?: object;
+    path?: string;
+    editable?: boolean;
+    advanceRenderingConfig?: string;
+    templateType?: string;
+    view?: string;
+    parameters?: object;
+}): JSX.Element;

package/types/core/server/components/render/RenderInBrowser.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Will render the given React component in the browser.
+ * Be careful, the component will not have access to the '@jahia/javascript-modules-library' library from the browser.
+ *
+ * @param {object} params The React component.
+ * @param {object} params.child The React component.
+ * @param {object} [params.props] The React component props, this props will be serialized/deserialized to be usable server and client side. The serialization and deserialization is done using JSON.stringify server side and JSON.parse in the browser. Please make sure that the props are serializable.
+ * @returns {JSX.Element} The component to be rendered in the browser
+ * */
+export function RenderInBrowser({ child: Child, props }: {
+    child: object;
+    props?: object;
+}): JSX.Element;

package/types/core/server/components/render/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Render";
+export * from "./HydrateInBrowser";
+export * from "./RenderInBrowser";

package/types/core/server/components/render/internal/InBrowser.d.ts

@@ -0,0 +1,8 @@
+export default InBrowser;
+declare function InBrowser({ child: Child, props, dataKey, preRender }: {
+    child: any;
+    props: any;
+    dataKey: any;
+    preRender: any;
+}): React.JSX.Element;
+import React from "react";

package/types/core/server/framework/defineJahiaComponent.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @typedef {Object} JahiaComponent
+ * @property {string} [id] - The ID of the component (autogenerated but can be overridden)
+ * @property {string} name - The name of the component.
+ * @property {string} [displayName] - The display name of the component (in jahia's UI), optional.
+ * @property {"template"|"view"} componentType - The type of the component.
+ * @property {string} nodeType - The content node type the component applies to.
+ * @property {Record<string, string>} [properties] - Properties to add on the component, optional.
+ */
+/**
+ * Using this function provides autocomplete on the jahiaComponent properties.
+ * @param {JahiaComponent} jahiaComponent - An object containing the Jahia component to define.
+ * @returns {JahiaComponent} The jahiaComponent object.
+ */
+export function defineJahiaComponent(jahiaComponent: JahiaComponent): JahiaComponent;
+export type JahiaComponent = {
+    /**
+     * - The ID of the component (autogenerated but can be overridden)
+     */
+    id?: string;
+    /**
+     * - The name of the component.
+     */
+    name: string;
+    /**
+     * - The display name of the component (in jahia's UI), optional.
+     */
+    displayName?: string;
+    /**
+     * - The type of the component.
+     */
+    componentType: "template" | "view";
+    /**
+     * - The content node type the component applies to.
+     */
+    nodeType: string;
+    /**
+     * - Properties to add on the component, optional.
+     */
+    properties?: Record<string, string>;
+};

package/types/core/server/framework/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./register";
+export * from "./defineJahiaComponent";

package/types/core/server/framework/register.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Registers Jahia components into the global registry as views
+ * @param {object} jahiaComponents an object containing the jahia components to register
+ * @returns {void}
+ * TODO We will probably want to revisit this function once we handle global component registration in ticket https://jira.jahia.org/browse/BACKLOG-22400
+ */
+export function registerJahiaComponents(jahiaComponents: object): void;

package/types/core/server/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./useGQLQuery";
+export * from "./useJCRQuery";
+export * from "./useServerContext";
+export * from "./useUrlBuilder";

package/types/core/server/hooks/useGQLQuery.d.ts

@@ -0,0 +1,5 @@
+export function useGQLQuery({ query, variables, operationName }: {
+    query: string;
+    variables: object;
+    operationName: string;
+}): object;

package/types/core/server/hooks/useJCRQuery.d.ts

@@ -0,0 +1,3 @@
+export function useJCRQuery({ query }: {
+    query: string;
+}): object;

package/types/core/server/hooks/useServerContext.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns the current server context
+ * @returns {import('@jahia/javascript-modules-library').ServerContext} the server context
+ */
+export function useServerContext(): import('@jahia/javascript-modules-library').ServerContext;
+export function ServerContextProvider({ renderContext, currentResource, currentNode, mainNode, bundleKey, children }: {
+    renderContext: any;
+    currentResource: any;
+    currentNode: any;
+    mainNode: any;
+    bundleKey: any;
+    children: any;
+}): React.JSX.Element;
+import React from "react";

package/types/core/server/hooks/useUrlBuilder.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @typedef {Object} UrlBuilderType
+ * @property {function({assetPath: string, moduleName?: string, parameters?: object}): string} buildStaticUrl
+ * @property {function({nodePath: string, extension?: string, language?:string, mode?:string, parameters?: object}): string} buildNodeUrl
+ * @property {function({nodePath: string, extension?: string, language?:string, mode?:string, parameters?: object}): string} buildHtmlFragmentUrl
+ */
+/**
+ * @returns {UrlBuilderType}
+ */
+export function useUrlBuilder(): UrlBuilderType;
+export type UrlBuilderType = {
+    buildStaticUrl: (arg0: {
+        assetPath: string;
+        moduleName?: string;
+        parameters?: object;
+    }) => string;
+    buildNodeUrl: (arg0: {
+        nodePath: string;
+        extension?: string;
+        language?: string;
+        mode?: string;
+        parameters?: object;
+    }) => string;
+    buildHtmlFragmentUrl: (arg0: {
+        nodePath: string;
+        extension?: string;
+        language?: string;
+        mode?: string;
+        parameters?: object;
+    }) => string;
+};

package/types/core/server/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./components";
+export * from "./framework";
+export * from "./hooks";
+export * from "./utils";

package/types/core/server/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./jcr";
+export * from "./urlBuilder";

package/types/core/server/utils/jcr/getChildNodes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns an array of child nodes of a given node.
+ * @param {import("org.jahia.services.content").JCRNodeWrapper} node - The node to get the child nodes from.
+ * @param {number} limit the maximum number of nodes to return (-1 to return all nodes, but be careful with this as it can be very slow and memory consuming, it's better to use a reasonable limit and use pagination if needed)
+ * @param {number} [offset=0] the offset to start from
+ * @param {function} [filter] - A function to filter the nodes to be returned.
+ * @returns {import("org.jahia.services.content").JCRNodeWrapper[]} An array of child nodes.
+ */
+export function getChildNodes(node: import("org.jahia.services.content").JCRNodeWrapper, limit: number, offset?: number, filter?: Function): import("org.jahia.services.content").JCRNodeWrapper[];

package/types/core/server/utils/jcr/getNodeFromPathOrId.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Returns a node from a path or identifier
+ * @param {object} props - The properties object containing either the node identifier or the node path.
+ * @param {string} [props.identifier] - The node identifier.
+ * @param {string} [props.path] - The node path.
+ * @param {import("org.jahia.services.content").JCRSessionWrapper} session - The JCR session.
+ * @returns {import("org.jahia.services.content").JCRNodeWrapper} The node.
+ */
+export function getNodeFromPathOrId(props: {
+    identifier?: string;
+    path?: string;
+}, session: import("org.jahia.services.content").JCRSessionWrapper): import("org.jahia.services.content").JCRNodeWrapper;

package/types/core/server/utils/jcr/getNodeProps.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Extracts the properties from a node
+ * @param {import("org.jahia.services.content").JCRNodeWrapper} node the node on which to extract the properties
+ * @param {Array} props the name of the properties to extract
+ * @returns {Object} an object containing the property values
+ */
+export function getNodeProps(node: import("org.jahia.services.content").JCRNodeWrapper, props: any[]): any;

package/types/core/server/utils/jcr/getNodesByJCRQuery.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Execute a JCR SQL2 query and return the result as an array of nodes
+ * @param {import("org.jahia.services.content").JCRSessionWrapper} session the JCR session to use
+ * @param {string} query the JCR SQL2 query to execute
+ * @param {number} limit the maximum number of nodes to return (-1 to return all nodes, but be careful with this as it can be very slow and memory consuming, it's better to use a reasonable limit and use pagination if needed)
+ * @param {number} [offset=0] the offset to start from
+ * @returns {import('org.jahia.services.content').JCRNodeWrapper[]} an array containing the nodes returned by the query
+ */
+export function getNodesByJCRQuery(session: import("org.jahia.services.content").JCRSessionWrapper, query: string, limit: number, offset?: number): import('org.jahia.services.content').JCRNodeWrapper[];

package/types/core/server/utils/jcr/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./getChildNodes";
+export * from "./getNodeFromPathOrId";
+export * from "./getNodeProps";
+export * from "./getNodesByJCRQuery";

package/types/core/server/utils/urlBuilder/index.d.ts

@@ -0,0 +1 @@
+export * from "./urlBuilder";

package/types/core/server/utils/urlBuilder/urlBuilder.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Initialize the registry with default url builders
+ * @returns {void}
+ */
+export function initUrlBuilder(): void;
+/**
+ * Provide URL generation for contents/files
+ * If parameters are not valid, or if a node couldn't be found, it will log an warning and return '#'
+ * @param {object} props props used to build the URL
+ * @param {string} [props.value] the value to use to build the URL
+ * @param {string} [props.path] the path of the resource to build the URL for
+ * @param {object} [props.parameters] the parameters to append to the URL
+ * @param {string} [props.mode] the mode to use to build the URL
+ * @param {string} [props.language] the language to use to build the URL
+ * @param {string} [props.extension] the extension to use to build the URL
+ * @param {import('org.jahia.services.render').RenderContext} renderContext the current renderContext
+ * @param {import('org.jahia.services.render').Resource} currentResource the current resource
+ * @returns {string} the final URL
+ */
+export function buildUrl(props: {
+    value?: string;
+    path?: string;
+    parameters?: object;
+    mode?: string;
+    language?: string;
+    extension?: string;
+}, renderContext: import('org.jahia.services.render').RenderContext, currentResource: import('org.jahia.services.render').Resource): string;

package/types/globals.d.ts

@@ -0,0 +1,11 @@
+import {Bundle} from 'org.osgi.framework';
+
+/**
+ * The global declarations, where top-level objects are exposed to server-side scripts
+ */
+declare global {
+    /**
+     * Exposed only during the server-side initial script registration process, not available during rendering
+     */
+    export const bundle : Bundle;
+}

package/types/index.d.ts

@@ -0,0 +1,19 @@
+export * from "./core";
+export * from "./nav";
+export * from './globals';
+export * from './java.io';
+export * from './java.net';
+export * from './java.security';
+export * from './java.util';
+export * from './javax.jcr';
+export * from './javax.servlet';
+export * from './javax.servlet.http';
+export * from './org.jahia.modules.npm.modules.engine.js.server';
+export * from './org.jahia.services.content';
+export * from './org.jahia.services.content.decorator';
+export * from './org.jahia.services.query';
+export * from './org.jahia.services.render';
+export * from './org.jahia.services.usermanager';
+export * from './org.osgi.framework';
+export * from './server';
+export * from './servercontext';