piral-core 1.0.0-pre.2296 → 1.0.1-beta.5640

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 - 2021 smapiot
+Copyright (c) 2019 - 2023 smapiot
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,12 @@
-[![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io)
+[![Piral Logo](https://github.com/smapiot/piral/raw/main/docs/assets/logo.png)](https://piral.io)
 
-# [Piral Core](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/piral-core.svg?style=flat)](https://www.npmjs.com/package/piral-core) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io) [![Gitter Chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/piral-io/community)
+# [Piral Core](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/piral-core.svg?style=flat)](https://www.npmjs.com/package/piral-core) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io) [![Gitter Chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/piral-io/community)
 
 This is the core library that is required for any Piral instance. Plugins and pre-made layouts or templates build upon this layer. While `piral-core` is certainly opinionated the library tries to keep most options as flexible as possible.
 
 ## Documentation
 
-For details on the provided API check out the [documentation at the Piral website](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/master/docs).
+For details on the provided API check out the [documentation at the Piral website](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/main/docs).
 
 ## Getting Started
 
@@ -18,6 +18,14 @@ npm i piral-core
 
 **Remark**: This package already includes TypeScript declarations. No need to install other packages.
 
+You'll also need to install React and React Router, if that did not happen already:
+
+```sh
+npm i react@^18 react-dom@^18 react-router@^6 react-router-dom@^6
+```
+
+The `piral-core` package is compatible with `react@>=16.8.0`, `react-dom@>=16.8.0`, `react-router@>=5.0.0`, and `react-router-dom@>=5.0.0`.
+
 Now you can create a new Piral instance in your code:
 
 ```jsx
@@ -30,7 +38,7 @@ const App = createInstance({
 
 **Remark**: For all available API options make sure to check out the [documentation](https://docs.piral.io).
 
-**Note**: The feed above should only be used for demonstration purposes. Either set up your own feed (more information at [piral.cloud](https://www.piral.cloud)) or your own API / mechanism to serve the modules.
+**Note**: The feed above should only be used for demonstration purposes. Either set up your own feed (more information at [piral.cloud](https://www.piral.cloud)) or your own API/mechanism to serve the modules.
 
 Finally, you can render this Piral instance by using the `render` function from `react-dom`:
 

package/app.codegen

@@ -0,0 +1,36 @@
+const cg = require('./dist/codegen');
+
+function getConfig(root) {
+  try {
+    return require(`${root}/piral.json`);
+  } catch {
+    return {};
+  }
+}
+
+module.exports = function () {
+  const exports = [];
+  const imports = [];
+  const root = process.cwd();
+  const cfg = getConfig(root);
+  const debug = typeof cfg.debugTools === 'boolean' ? cfg.debugTools : !!process.env.DEBUG_PIRAL;
+  const opts = {
+    root,
+    cat: process.env.NODE_ENV === 'test' ? 'src' : '_',
+    appName: process.env.BUILD_PCKG_NAME || '',
+    externals: (process.env.SHARED_DEPENDENCIES || '').split(',').filter(Boolean),
+    publicPath: process.env.PIRAL_PUBLIC_PATH || '/',
+    debug: debug && (cfg.debugSettings || {}),
+    emulator: !!process.env.DEBUG_PILET,
+  };
+
+  cg.createDependencies(imports, exports, opts);
+  cg.createDefaultState(imports, exports, opts);
+  cg.createDebugHandler(imports, exports, opts);
+  cg.createRouteHandler(imports, exports, opts);
+
+  return `
+    ${imports.join('\n')}
+    ${exports.join('\n')}
+  `;
+};

package/app.codegen.d.ts

@@ -0,0 +1,29 @@
+import type { LoadPiletsOptions } from 'piral-base';
+import type { DebuggerExtensionOptions } from 'piral-debug-utils';
+import type { ComponentType } from 'react';
+import type { RouteComponentProps } from 'react-router';
+import type { AppPath, GlobalState, GlobalStateContext, NavigationApi } from './src/types';
+
+export const publicPath: string;
+
+export function createNavigation(): NavigationApi;
+
+export function createDefaultState(): GlobalState;
+
+export function createRedirect(to: string): ComponentType<RouteComponentProps>;
+
+export function fillDependencies(deps: Record<string, any>): void;
+
+export function useRouteFilter(paths: Array<AppPath>): Array<AppPath>;
+
+export function integrateDebugger(
+  context: GlobalStateContext,
+  options: LoadPiletsOptions,
+  debug?: DebuggerExtensionOptions,
+): void;
+
+export function integrateEmulator(
+  context: GlobalStateContext,
+  options: LoadPiletsOptions,
+  debug?: DebuggerExtensionOptions,
+): void;