piral-core - npm Package Compare versions

Comparing version 0.6.0-pre.536 to 0.6.0-pre.537

lib/components/portal.d.ts

 import * as React from 'react';
 import { RecallProps } from 'react-arbiter';
-export interface PortalProps {
-    children(content: React.ReactNode): React.ReactElement<any>;
-}
+import { PortalProps } from '../types';
 export declare const Portal: React.FC<PortalProps & RecallProps>;
 export default Portal;

lib/components/withApi.d.ts

 import * as React from 'react';
-import { AnyComponent, PiralApi } from '../types';
+import { AnyComponent } from '../types';
 export interface ApiForward<TApi> {
-    piral: PiralApi<TApi>;
+    piral: TApi;
 }
-export declare function withApi<TApi, TProps>(component: AnyComponent<TProps & ApiForward<TApi>>, piral: PiralApi<TApi>): React.ComponentType<TProps>;
+export declare function withApi<TApi, TProps>(component: AnyComponent<TProps & ApiForward<TApi>>, piral: TApi): React.ComponentType<TProps>;

lib/components/withApi.js

@@ -10,4 +10,3 @@ "use strict";
         onError(error) {
-            const { name } = (piral && piral.meta) || { name: '' };
-            console.error(name, error);
+            console.error(piral, error);
         },
@@ -14,0 +13,0 @@ renderChild(child) {

lib/createInstance.d.ts

@@ -1,52 +0,3 @@
-import * as React from 'react';
-import { ArbiterModule, DependencyGetter } from 'react-arbiter';
-import { PortalProps } from './components';
-import { PiralApi, EventEmitter, Extend, PiletRequester, GlobalState, NestedPartial } from './types';
-declare global {
-    interface NodeModule {
-        hot?: {
-            accept(errHandler?: (err: any) => void): void;
-            dispose(callback: (data: any) => void): void;
-        };
-    }
-}
-export interface PiralPiletConfiguration<TApi> {
-    requestPilets?: PiletRequester;
-    /**
-     * Determines the modules, which are available already from the start 🚀.
-     * The given modules are all already evaluated.
-     * This can be used for customization or for debugging purposes.
-     */
-    availablePilets?: Array<ArbiterModule<PiralApi<TApi>>>;
-    /**
-     * Optionally provides a function to extend the API creator with some additional
-     * functionality.
-     */
-    extendApi?: Extend<TApi>;
-}
-export interface PiralStateConfiguration<TState extends GlobalState = GlobalState, TActions extends {} = {}> {
-    /**
-     * Function to get the dependencies for a given module.
-     */
-    getDependencies?: DependencyGetter;
-    /**
-     * Determines that pilets are loaded asynchronously, essentially showing the
-     * app right away without waiting for the pilets to load and evaluate.
-     */
-    async?: boolean;
-    /**
-     * Optionally, sets up the initial state of the application.
-     */
-    state?: NestedPartial<TState>;
-    /**
-     * Optionally, sets additional actions to be included.
-     */
-    actions?: TActions;
-}
-export declare type PiralConfiguration<TApi, TState extends GlobalState = GlobalState, TActions extends {} = {}> = PiralPiletConfiguration<TApi> & PiralStateConfiguration<TState, TActions>;
+import { GlobalState, PiralConfiguration, PiralInstance } from './types';
 /**
- * The PiralInstance component, which is a React functional component combined with an event emitter.
- */
-export declare type PiralInstance = React.FC<PortalProps> & EventEmitter;
-/**
  * Creates a new PiralInstance component, which can be used for
@@ -53,0 +4,0 @@ * bootstrapping the application easily.

lib/helpers.d.ts

@@ -1,7 +0,17 @@
-import { Append, Extend, GlobalStateOptions, NestedPartial, GlobalState } from './types';
+import { AvailableDependencies } from 'react-arbiter';
+import { Append, Extend, GlobalStateOptions, NestedPartial, GlobalState, UnionToIntersection, ValuesOf, PiralCoreApi } from './types';
 /**
+ * Creates a dependency getter that sets the shared dependencies explicitly.
+ * Overrides the potentially set shared dependencies from the Piral CLI, but
+ * keeps all global dependencies such as react, react-dom, ...
+ * @param dependencies The shared dependencies to declare.
+ */
+export declare function setSharedDependencies(sharedDependencies: AvailableDependencies): () => {
+    [x: string]: any;
+};
+/**
  * Creates an API extender from the given array of API declarations.
  * @param apis The APIs to use as source.
  */
-export declare function extendApis<TApi>(apis: Array<Append<TApi>>): Extend<TApi>;
+export declare function extendApis<T extends Array<Append>>(apis: T): Extend<PiralCoreApi<UnionToIntersection<ReturnType<ValuesOf<T>>>> & UnionToIntersection<ReturnType<ValuesOf<T>>>>;
 /**
@@ -8,0 +18,0 @@ * Sets up the initial state from the given options.

lib/helpers.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const modules_1 = require("./modules");
 const utils_1 = require("./utils");
 const default_1 = require("./components/default");
 /**
+ * Creates a dependency getter that sets the shared dependencies explicitly.
+ * Overrides the potentially set shared dependencies from the Piral CLI, but
+ * keeps all global dependencies such as react, react-dom, ...
+ * @param dependencies The shared dependencies to declare.
+ */
+function setSharedDependencies(sharedDependencies) {
+    const dependencies = Object.assign({}, modules_1.globalDependencies, sharedDependencies);
+    return () => dependencies;
+}
+exports.setSharedDependencies = setSharedDependencies;
+/**
  * Creates an API extender from the given array of API declarations.
@@ -10,9 +22,5 @@ * @param apis The APIs to use as source.
 function extendApis(apis) {
-    return (init, target) => {
-        let api = init;
-        for (const createApi of apis) {
-            api = Object.assign({}, createApi(api, target), api);
-        }
-        return api;
-    };
+    return (init, target) => apis
+        .map(createApi => createApi(init, target))
+        .reduce((prev, curr) => (Object.assign({}, curr, prev)), init);
 }
@@ -19,0 +27,0 @@ exports.extendApis = extendApis;

lib/modules/api.d.ts

 import { ArbiterModuleMetadata } from 'react-arbiter';
-import { PiralApi, PiralContainer } from '../types';
-export declare function createApi<TApi>(target: ArbiterModuleMetadata, { events, context, extendApi }: PiralContainer<TApi>): PiralApi<TApi>;
+import { PiralContainer } from '../types';
+export declare function createApi<TApi>(target: ArbiterModuleMetadata, { events, context, extendApi }: PiralContainer<TApi>): TApi;

lib/modules/dependencies.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const sharedDependencies = (process.env.SHARED_DEPENDENCIES || '').split(',').reduce((depMap, dependency) => {
-    if (dependency) {
-        depMap[dependency] = require(dependency);
+const react_arbiter_1 = require("react-arbiter");
+const sharedDependencies = {};
+if (process.env.SHARED_DEPENDENCIES) {
+    const fillDependencies = require('piral-cli/lib/shared-dependencies');
+    if (react_arbiter_1.isfunc(fillDependencies)) {
+        fillDependencies(sharedDependencies);
     }
-    return depMap;
-}, {});
+}
 exports.globalDependencies = {
     react: require('react'),
+    'react-dom': require('react-dom'),
     'react-router': require('react-router'),
@@ -15,2 +18,4 @@ 'react-router-dom': require('react-router-dom'),
     'path-to-regexp': require('path-to-regexp'),
+    '@libre/atom': require('@libre/atom'),
+    '@dbeining/react-atom': require('@dbeining/react-atom'),
 };
@@ -17,0 +22,0 @@ function getLocalDependencies() {

lib/types/api.d.ts

@@ -38,9 +38,5 @@ import { ReactNode, ComponentType } from 'react';
 /**
- * Alias for an extensible Pilet API given from piral-core.
- */
-export declare type PiralApi<TExtraApi = {}> = PiralCoreApi<TExtraApi> & TExtraApi;
-/**
  * Defines the Pilet API from piral-core.
  */
-export interface PiralCoreApi<TExtraApi> extends EventEmitter {
+export interface PiralCoreApi<TApi = {}> extends EventEmitter {
     /**
@@ -106,3 +102,3 @@ * Gets the metadata of the current pilet.
      */
-    registerModalX<TOpts>(name: string, render: ForeignComponent<ModalComponentProps<PiralApi<TExtraApi>, TOpts>>, defaults?: TOpts): void;
+    registerModalX<TOpts>(name: string, render: ForeignComponent<ModalComponentProps<TApi, TOpts>>, defaults?: TOpts): void;
     /**
@@ -115,3 +111,3 @@ * Registers a modal dialog using a React component.
      */
-    registerModal<TOpts>(name: string, Component: ComponentType<ModalComponentProps<PiralApi<TExtraApi>, TOpts>>, defaults?: TOpts): void;
+    registerModal<TOpts>(name: string, Component: ComponentType<ModalComponentProps<TApi, TOpts>>, defaults?: TOpts): void;
     /**
@@ -129,3 +125,3 @@ * Unregisters a modal by its name.
      */
-    registerPageX(route: string, render: ForeignComponent<PageComponentProps<PiralApi<TExtraApi>>>): void;
+    registerPageX(route: string, render: ForeignComponent<PageComponentProps<TApi>>): void;
     /**
@@ -138,3 +134,3 @@ * Registers a route for React component.
      */
-    registerPage(route: string, Component: ComponentType<PageComponentProps<PiralApi<TExtraApi>>>): void;
+    registerPage(route: string, Component: ComponentType<PageComponentProps<TApi>>): void;
     /**
@@ -152,3 +148,3 @@ * Unregisters the page identified by the given route.
      */
-    registerTileX(name: string, render: ForeignComponent<TileComponentProps<PiralApi<TExtraApi>>>, preferences?: TilePreferences): void;
+    registerTileX(name: string, render: ForeignComponent<TileComponentProps<TApi>>, preferences?: TilePreferences): void;
     /**
@@ -161,3 +157,3 @@ * Registers a tile for React components.
      */
-    registerTile(name: string, Component: ComponentType<TileComponentProps<PiralApi<TExtraApi>>>, preferences?: TilePreferences): void;
+    registerTile(name: string, Component: ComponentType<TileComponentProps<TApi>>, preferences?: TilePreferences): void;
     /**
@@ -176,3 +172,3 @@ * Unregisters a tile known by the given name.
      */
-    registerExtensionX<T>(name: string, render: ForeignComponent<ExtensionComponentProps<PiralApi<TExtraApi>, T>>, defaults?: T): void;
+    registerExtensionX<T>(name: string, render: ForeignComponent<ExtensionComponentProps<TApi, T>>, defaults?: T): void;
     /**
@@ -185,3 +181,3 @@ * Registers an extension component with a React component.
      */
-    registerExtension<T>(name: string, Component: ComponentType<ExtensionComponentProps<PiralApi<TExtraApi>, T>>, defaults?: T): void;
+    registerExtension<T>(name: string, Component: ComponentType<ExtensionComponentProps<TApi, T>>, defaults?: T): void;
     /**
@@ -193,3 +189,3 @@ * Unregisters a global extension component.
      */
-    unregisterExtension<T>(name: string, hook: AnyComponent<ExtensionComponentProps<PiralApi<TExtraApi>, T>>): void;
+    unregisterExtension<T>(name: string, hook: AnyComponent<ExtensionComponentProps<TApi, T>>): void;
     /**
@@ -202,3 +198,3 @@ * Registers a menu item for general components.
      */
-    registerMenuX(name: string, render: ForeignComponent<MenuComponentProps<PiralApi<TExtraApi>>>, settings?: MenuSettings): void;
+    registerMenuX(name: string, render: ForeignComponent<MenuComponentProps<TApi>>, settings?: MenuSettings): void;
     /**
@@ -211,3 +207,3 @@ * Registers a menu item for React components.
      */
-    registerMenu(name: string, Component: ComponentType<MenuComponentProps<PiralApi<TExtraApi>>>, settings?: MenuSettings): void;
+    registerMenu(name: string, Component: ComponentType<MenuComponentProps<TApi>>, settings?: MenuSettings): void;
     /**
@@ -226,3 +222,3 @@ * Unregisters a menu item known by the given name.
      */
-    registerSearchProvider(name: string, provider: SearchProvider<PiralApi<TExtraApi>>, settings?: SearchSettings): void;
+    registerSearchProvider(name: string, provider: SearchProvider<TApi>, settings?: SearchSettings): void;
     /**
@@ -229,0 +225,0 @@ * Unregisters a search provider known by the given name.

lib/types/index.d.ts

 export * from './api';
+export * from './common';
 export * from './components';
+export * from './config';
 export * from './connector';
@@ -9,2 +11,3 @@ export * from './container';
 export * from './form';
+export * from './instance';
 export * from './layout';
@@ -11,0 +14,0 @@ export * from './menu';

lib/types/plugin.d.ts

 import { ArbiterModuleMetadata } from 'react-arbiter';
-import { PiralApi, PiralCoreApi } from './api';
+import { PiralCoreApi } from './api';
 import { EventEmitter } from './utils';
@@ -20,5 +20,5 @@ import { GlobalStateContext, GlobalState } from './state';
      */
-    (api: PiralCoreApi<TApi>, target: ArbiterModuleMetadata): PiralApi<TApi>;
+    (api: PiralCoreApi<TApi>, target: ArbiterModuleMetadata): TApi;
 }
-export interface Append<TApi> {
+export interface Append {
     /**
@@ -30,3 +30,3 @@ * Appends a custom set of functionality to be used by modules.
      */
-    (api: PiralCoreApi<TApi>, target: ArbiterModuleMetadata): Partial<PiralApi<TApi>>;
+    (api: PiralCoreApi<any>, target: ArbiterModuleMetadata): any;
 }
@@ -33,0 +33,0 @@ export interface PiletRequester {

package.json

 {
   "name": "piral-core",
-  "version": "0.6.0-pre.536",
+  "version": "0.6.0-pre.537",
   "description": "The core library for creating a Piral instance.",
@@ -53,3 +53,3 @@ "keywords": [
   },
-  "gitHead": "8931b3afae7086d16aba280bdbb1ac8c89181549"
+  "gitHead": "f963bd3655c69b88a3ad84192aa8b3e5ae6006d4"
 }

src/modules/api.ts

@@ -7,3 +7,2 @@ import { ArbiterModuleMetadata, wrapElement, isfunc } from 'react-arbiter';
   AnyComponent,
-  PiralApi,
   TileComponentProps,
@@ -31,5 +30,5 @@ ExtensionComponentProps,
   context: GlobalStateContext,
-  api: PiralApi<TApi>,
+  api: TApi,
   route: string,
-  arg: AnyComponent<PageComponentProps<PiralApi<TApi>>>,
+  arg: AnyComponent<PageComponentProps<TApi>>,
 ) {
@@ -43,5 +42,5 @@ context.registerPage(route, {
   context: GlobalStateContext,
-  api: PiralApi<TApi>,
+  api: TApi,
   id: string,
-  arg: AnyComponent<TileComponentProps<PiralApi<TApi>>>,
+  arg: AnyComponent<TileComponentProps<TApi>>,
   preferences: TilePreferences = {},
@@ -57,5 +56,5 @@ ) {
   context: GlobalStateContext,
-  api: PiralApi<TApi>,
+  api: TApi,
   name: string,
-  arg: AnyComponent<ExtensionComponentProps<PiralApi<TApi>, T>>,
+  arg: AnyComponent<ExtensionComponentProps<TApi, T>>,
   defaults?: T,
@@ -72,5 +71,5 @@ ) {
   context: GlobalStateContext,
-  api: PiralApi<TApi>,
+  api: TApi,
   id: string,
-  arg: AnyComponent<MenuComponentProps<PiralApi<TApi>>>,
+  arg: AnyComponent<MenuComponentProps<TApi>>,
   settings: MenuSettings = {},
@@ -88,5 +87,5 @@ ) {
   context: GlobalStateContext,
-  api: PiralApi<TApi>,
+  api: TApi,
   id: string,
-  arg: AnyComponent<ModalComponentProps<PiralApi<TApi>, TOpts>>,
+  arg: AnyComponent<ModalComponentProps<TApi, TOpts>>,
   defaults?: TOpts,
@@ -103,3 +102,3 @@ ) {
   { events, context, extendApi }: PiralContainer<TApi>,
-): PiralApi<TApi> {
+): TApi {
   let feeds = 0;
@@ -106,0 +105,0 @@ const prefix = target.name;

src/modules/dependencies.ts

@@ -1,16 +0,16 @@
-import { AvailableDependencies } from 'react-arbiter';
+import { AvailableDependencies, isfunc } from 'react-arbiter';
 
-const sharedDependencies = (process.env.SHARED_DEPENDENCIES || '').split(',').reduce(
-  (depMap, dependency) => {
-    if (dependency) {
-      depMap[dependency] = require(dependency);
-    }
+const sharedDependencies: AvailableDependencies = {};
 
-    return depMap;
-  },
-  {} as AvailableDependencies,
-);
+if (process.env.SHARED_DEPENDENCIES) {
+  const fillDependencies = require('piral-cli/lib/shared-dependencies');
 
+  if (isfunc(fillDependencies)) {
+    fillDependencies(sharedDependencies);
+  }
+}
+
 export const globalDependencies: AvailableDependencies = {
   react: require('react'),
+  'react-dom': require('react-dom'),
   'react-router': require('react-router'),
@@ -20,2 +20,4 @@ 'react-router-dom': require('react-router-dom'),
   'path-to-regexp': require('path-to-regexp'),
+  '@libre/atom': require('@libre/atom'),
+  '@dbeining/react-atom': require('@dbeining/react-atom'),
 };
@@ -22,0 +24,0 @@

src/types/api.ts

@@ -48,10 +48,5 @@ import { ReactNode, ComponentType } from 'react';
 /**
- * Alias for an extensible Pilet API given from piral-core.
- */
-export type PiralApi<TExtraApi = {}> = PiralCoreApi<TExtraApi> & TExtraApi;
-
-/**
  * Defines the Pilet API from piral-core.
  */
-export interface PiralCoreApi<TExtraApi> extends EventEmitter {
+export interface PiralCoreApi<TApi = {}> extends EventEmitter {
   /**
@@ -121,3 +116,3 @@ * Gets the metadata of the current pilet.
     name: string,
-    render: ForeignComponent<ModalComponentProps<PiralApi<TExtraApi>, TOpts>>,
+    render: ForeignComponent<ModalComponentProps<TApi, TOpts>>,
     defaults?: TOpts,
@@ -134,3 +129,3 @@ ): void;
     name: string,
-    Component: ComponentType<ModalComponentProps<PiralApi<TExtraApi>, TOpts>>,
+    Component: ComponentType<ModalComponentProps<TApi, TOpts>>,
     defaults?: TOpts,
@@ -150,3 +145,3 @@ ): void;
    */
-  registerPageX(route: string, render: ForeignComponent<PageComponentProps<PiralApi<TExtraApi>>>): void;
+  registerPageX(route: string, render: ForeignComponent<PageComponentProps<TApi>>): void;
   /**
@@ -159,3 +154,3 @@ * Registers a route for React component.
    */
-  registerPage(route: string, Component: ComponentType<PageComponentProps<PiralApi<TExtraApi>>>): void;
+  registerPage(route: string, Component: ComponentType<PageComponentProps<TApi>>): void;
   /**
@@ -173,7 +168,3 @@ * Unregisters the page identified by the given route.
    */
-  registerTileX(
-    name: string,
-    render: ForeignComponent<TileComponentProps<PiralApi<TExtraApi>>>,
-    preferences?: TilePreferences,
-  ): void;
+  registerTileX(name: string, render: ForeignComponent<TileComponentProps<TApi>>, preferences?: TilePreferences): void;
   /**
@@ -186,7 +177,3 @@ * Registers a tile for React components.
    */
-  registerTile(
-    name: string,
-    Component: ComponentType<TileComponentProps<PiralApi<TExtraApi>>>,
-    preferences?: TilePreferences,
-  ): void;
+  registerTile(name: string, Component: ComponentType<TileComponentProps<TApi>>, preferences?: TilePreferences): void;
   /**
@@ -205,7 +192,3 @@ * Unregisters a tile known by the given name.
    */
-  registerExtensionX<T>(
-    name: string,
-    render: ForeignComponent<ExtensionComponentProps<PiralApi<TExtraApi>, T>>,
-    defaults?: T,
-  ): void;
+  registerExtensionX<T>(name: string, render: ForeignComponent<ExtensionComponentProps<TApi, T>>, defaults?: T): void;
   /**
@@ -218,7 +201,3 @@ * Registers an extension component with a React component.
    */
-  registerExtension<T>(
-    name: string,
-    Component: ComponentType<ExtensionComponentProps<PiralApi<TExtraApi>, T>>,
-    defaults?: T,
-  ): void;
+  registerExtension<T>(name: string, Component: ComponentType<ExtensionComponentProps<TApi, T>>, defaults?: T): void;
   /**
@@ -230,3 +209,3 @@ * Unregisters a global extension component.
    */
-  unregisterExtension<T>(name: string, hook: AnyComponent<ExtensionComponentProps<PiralApi<TExtraApi>, T>>): void;
+  unregisterExtension<T>(name: string, hook: AnyComponent<ExtensionComponentProps<TApi, T>>): void;
   /**
@@ -239,7 +218,3 @@ * Registers a menu item for general components.
    */
-  registerMenuX(
-    name: string,
-    render: ForeignComponent<MenuComponentProps<PiralApi<TExtraApi>>>,
-    settings?: MenuSettings,
-  ): void;
+  registerMenuX(name: string, render: ForeignComponent<MenuComponentProps<TApi>>, settings?: MenuSettings): void;
   /**
@@ -252,7 +227,3 @@ * Registers a menu item for React components.
    */
-  registerMenu(
-    name: string,
-    Component: ComponentType<MenuComponentProps<PiralApi<TExtraApi>>>,
-    settings?: MenuSettings,
-  ): void;
+  registerMenu(name: string, Component: ComponentType<MenuComponentProps<TApi>>, settings?: MenuSettings): void;
   /**
@@ -271,3 +242,3 @@ * Unregisters a menu item known by the given name.
    */
-  registerSearchProvider(name: string, provider: SearchProvider<PiralApi<TExtraApi>>, settings?: SearchSettings): void;
+  registerSearchProvider(name: string, provider: SearchProvider<TApi>, settings?: SearchSettings): void;
   /**
@@ -274,0 +245,0 @@ * Unregisters a search provider known by the given name.

src/types/index.ts

 export * from './api';
+export * from './common';
 export * from './components';
+export * from './config';
 export * from './connector';
@@ -9,2 +11,3 @@ export * from './container';
 export * from './form';
+export * from './instance';
 export * from './layout';
@@ -11,0 +14,0 @@ export * from './menu';

src/types/plugin.ts

 import { ArbiterModuleMetadata } from 'react-arbiter';
-import { PiralApi, PiralCoreApi } from './api';
+import { PiralCoreApi } from './api';
 import { EventEmitter } from './utils';
@@ -22,6 +22,6 @@ import { GlobalStateContext, GlobalState } from './state';
    */
-  (api: PiralCoreApi<TApi>, target: ArbiterModuleMetadata): PiralApi<TApi>;
+  (api: PiralCoreApi<TApi>, target: ArbiterModuleMetadata): TApi;
 }
 
-export interface Append<TApi> {
+export interface Append {
   /**
@@ -33,3 +33,3 @@ * Appends a custom set of functionality to be used by modules.
    */
-  (api: PiralCoreApi<TApi>, target: ArbiterModuleMetadata): Partial<PiralApi<TApi>>;
+  (api: PiralCoreApi<any>, target: ArbiterModuleMetadata): any;
 }
@@ -36,0 +36,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

441287

increased by0.54%

Number of package files

378

increased by3.28%

Lines of code

11210

increased by0.26%

Number of low supply chain risk alerts

8

decreased by-11.11%

No dependency changes