oc-server 2.0.6 → 2.1.1

package/dist/Server.d.ts

@@ -1,4 +1,4 @@
-import { Prettify, DataContext, DataProvider, ToPrettyJson } from './types';
+import { Prettify, DataContext, DataProvider, ToPrettyJson, IsAnyOrUnknown } from './types';
 export type ServerContext<E = {
     name: string;
 }, P = any, S = any> = Omit<DataContext<any, E, P, S>, 'params' | 'action' | 'setEmptyResponse'>;
@@ -46,7 +46,7 @@ interface ServerOptions<S extends boolean> {
 }
 export declare class Server<E = {
     name: string;
-}, P = unknown, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any, Streaming extends boolean = false> {
+}, P = unknown, A extends Record<string, AnyAction> = {}, InitialInput = unknown, InitialOutput = unknown, MiddlewareInput = any, MiddlewareOutput = any, Streaming extends boolean = false> {
     private readonly _options;
     private _parameters;
     private _middleware;
@@ -74,7 +74,7 @@ export type RegisteredServer = Register extends {
     server: infer TServer extends AnyServer;
 } ? TServer : AnyServer;
 export type GetMiddlewareInput<TServer extends AnyServer> = TServer extends HandledServer<any, any, any, any, any, infer I> ? I : any;
-type GetInitialData<TServer extends AnyServer> = TServer extends HandledServer<any, any, any, any, infer O, any, any, infer Streaming> ? Streaming extends true ? Exclude<O, undefined | null> : Exclude<ToPrettyJson<O>, undefined | null> : any;
+type GetInitialData<TServer extends AnyServer> = TServer extends HandledServer<any, any, any, any, infer O, any, any, infer Streaming> ? IsAnyOrUnknown<O> extends never ? Streaming extends true ? Exclude<O, undefined | null> : Exclude<ToPrettyJson<O>, undefined | null> : unknown : unknown;
 type GetHandlerParameters<TServer extends AnyServer> = TServer extends HandledServer<any, any, any, infer I, any, any, any, any> ? I : any;
 export type HandlerParameters = GetHandlerParameters<RegisteredServer>;
 export type InitialData = GetInitialData<RegisteredServer>;

package/dist/cli/cli.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cli = void 0;
+exports.cli = cli;
 const node_path_1 = __importDefault(require("node:path"));
 const node_util_1 = require("node:util");
 const oc_1 = require("./oc");
@@ -64,4 +64,3 @@ function cli() {
         (0, server_1.createServer)({ template, port });
     }
 }
-exports.cli = cli;

package/dist/cli/get-mocked-plugins.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getMockedPlugins;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const readJsonSync = (path) => JSON.parse(fs_1.default.readFileSync(path, 'utf-8'));
@@ -76,4 +77,3 @@ function getMockedPlugins(componentsDir) {
     plugins = plugins.concat(registerDynamicMocks(ocJsonLocation, content.mocks.plugins.dynamic ?? {}));
     return plugins;
 }
-exports.default = getMockedPlugins;

package/dist/cli/oc.d.ts

@@ -1,14 +1,14 @@
-/// <reference types="node" />
 import { FastifyRequest } from 'fastify';
 import { PluginMock } from './get-mocked-plugins';
+interface Parameters {
+    mandatory: boolean;
+    example: string | number | boolean;
+}
 interface Package {
     name: string;
     version: string;
     oc?: {
-        parameters?: Record<string, {
-            mandatory: boolean;
-            example: string | number | boolean;
-        }>;
+        parameters?: Record<string, Parameters>;
         files: {
             data?: string;
             template?: {
@@ -18,10 +18,10 @@ interface Package {
         };
     };
 }
+export declare function getDefaultParams(parameters: Record<string, Parameters>): {};
 export declare function parsePkg(pkg: Package): {
     name: string;
     version: string;
-    defaultParams: {};
     serverEntry: string | undefined;
     appEntry: string;
     templateType: string;

package/dist/cli/oc.js

@@ -1,19 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getContext = exports.parsePkg = void 0;
-function parsePkg(pkg) {
-    const serverEntry = pkg.oc?.files?.data;
-    let appEntry = pkg.oc?.files?.template?.src || '';
-    if (!appEntry) {
-        throw new Error('Missing an entry on your package.json under oc.files.template.src');
-    }
-    if (!appEntry.startsWith('/')) {
-        appEntry = `/${appEntry}`;
-    }
+exports.getDefaultParams = getDefaultParams;
+exports.parsePkg = parsePkg;
+exports.getContext = getContext;
+function getDefaultParams(parameters) {
     const defaultParams = (() => {
         let params = {};
-        if (pkg.oc?.parameters) {
-            params = Object.fromEntries(Object.entries(pkg.oc.parameters || {})
+        if (parameters) {
+            params = Object.fromEntries(Object.entries(parameters || {})
                 .filter(([, param]) => {
                 return !!param.mandatory && 'example' in param;
             })
@@ -21,6 +15,17 @@ function parsePkg(pkg) {
         }
         return params;
     })();
+    return defaultParams;
+}
+function parsePkg(pkg) {
+    const serverEntry = pkg.oc?.files?.data;
+    let appEntry = pkg.oc?.files?.template?.src || '';
+    if (!appEntry) {
+        throw new Error('Missing an entry on your package.json under oc.files.template.src');
+    }
+    if (!appEntry.startsWith('/')) {
+        appEntry = `/${appEntry}`;
+    }
     const templateType = pkg.oc?.files?.template?.type;
     if (!templateType) {
         throw new Error('Missing an entry on your package.json under oc.files.template.type');
@@ -28,13 +33,11 @@ function parsePkg(pkg) {
     return {
         name: pkg.name,
         version: pkg.version,
-        defaultParams,
         serverEntry,
         appEntry,
         templateType,
     };
 }
-exports.parsePkg = parsePkg;
 function getContext(plugins, req, params, action) {
     const responseHeaders = {};
     const context = {
@@ -66,4 +69,3 @@ function getContext(plugins, req, params, action) {
     };
     return { context, responseHeaders };
 }
-exports.getContext = getContext;

package/dist/cli/server.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createServer = void 0;
+exports.createServer = createServer;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const node_vm_1 = __importDefault(require("node:vm"));
@@ -17,10 +17,14 @@ const oc_1 = require("./oc");
 const get_mocked_plugins_1 = __importDefault(require("./get-mocked-plugins"));
 const promisify = (fn) => (...args) => new Promise((resolve, reject) => fn(...args, (err, data) => (err ? reject(err) : resolve(data))));
 const pk = require(node_path_1.default.join(process.cwd(), 'package.json'));
-const { name, version, appEntry, serverEntry, defaultParams } = (0, oc_1.parsePkg)(pk);
+const { name, version, appEntry, serverEntry } = (0, oc_1.parsePkg)(pk);
 function getDataProvider() {
     if (!serverEntry) {
-        return async (context) => ({ ...(context.params ?? {}) });
+        return {
+            dataProvider: async (context) => ({
+                ...(context.params ?? {}),
+            }),
+        };
     }
     const result = esbuild_1.default.buildSync({
         entryPoints: [serverEntry],
@@ -32,10 +36,14 @@ function getDataProvider() {
     const backend = node_vm_1.default.runInNewContext(code, {
         ...globalThis,
         exports: {},
+        console,
         module: { exports: {} },
     });
     const dataProvider = backend.data || backend.server.getData();
-    return promisify(dataProvider);
+    return {
+        dataProvider: promisify(dataProvider),
+        parametersSchema: backend.server?._parameters,
+    };
 }
 function getBaseTemplate(appBlock) {
     const baseTemplate = `
@@ -90,11 +98,12 @@ async function createServer({ template, port, }) {
     const { dev: clientJs } = oc_client_browser_1.default.compileSync();
     const app = (0, fastify_1.default)({ logger: false });
     await app.register(express_1.default);
-    const dataProvider = getDataProvider();
+    const { dataProvider, parametersSchema } = getDataProvider();
     const plugins = (0, get_mocked_plugins_1.default)(node_path_1.default.join(process.cwd(), '..'));
     for (const plugin of plugins) {
         plugin.register.register(null, null, () => { });
     }
+    const defaultParams = (0, oc_1.getDefaultParams)(pk.oc?.parameters ?? parametersSchema);
     const vite = await (0, vite_1.createServer)({
         server: { middlewareMode: true },
         plugins: [(0, cssModulesPlugin_1.default)(), template.plugin?.()].filter(Boolean),
@@ -161,4 +170,3 @@ async function createServer({ template, port, }) {
     await app.listen({ port: port });
     console.log(`Listening on: http://localhost:${port}`);
 }
-exports.createServer = createServer;

package/dist/serverClient.d.ts

@@ -1,11 +1,11 @@
 import { AnyServer, RegisteredServer, Action, GetMiddlewareInput } from './Server';
-import { IsAny, Prettify, ToPrettyJson } from './types';
+import { IsAnyOrUnknown, Prettify, ToPrettyJson } from './types';
 type InferInput<R> = R extends Action<infer I, any, any, any, any> ? I : any;
 type InferOutput<R> = R extends Action<any, infer O, any, any, any> ? ToPrettyJson<O> : never;
 type IsEmptyObject<T> = keyof T extends never ? true : false;
 type ServerClient<TServer extends AnyServer> = {
-    readonly [Property in keyof TServer['actions']]: (...args: IsEmptyObject<Prettify<InferInput<TServer['actions'][Property]> & (IsAny<GetMiddlewareInput<TServer>> extends never ? GetMiddlewareInput<TServer> : {})>> extends true ? [] : [
-        Prettify<InferInput<TServer['actions'][Property]> & (IsAny<GetMiddlewareInput<TServer>> extends never ? GetMiddlewareInput<TServer> : {})>
+    readonly [Property in keyof TServer['actions']]: (...args: IsEmptyObject<Prettify<InferInput<TServer['actions'][Property]> & (IsAnyOrUnknown<GetMiddlewareInput<TServer>> extends never ? GetMiddlewareInput<TServer> : {})>> extends true ? [] : [
+        Prettify<InferInput<TServer['actions'][Property]> & (IsAnyOrUnknown<GetMiddlewareInput<TServer>> extends never ? GetMiddlewareInput<TServer> : {})>
     ]) => Promise<InferOutput<TServer['actions'][Property]>>;
 };
 export declare const serverClient: ServerClient<RegisteredServer>;

package/dist/types.d.ts

@@ -46,6 +46,6 @@ export type DataContext<T = any, E = Env, P = any, S = unknown> = {
 } : {});
 type Callback<D, E = Error> = (error: E | null, data?: D) => void;
 export type DataProvider<Parameters = any, Return = any, Environment = Env> = (context: DataContext<Parameters, Environment>, callback: Callback<Return>) => void;
-type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
-export type IsAny<T> = IfAny<T, true, never>;
+type IfUnknown<T, Y, N> = [unknown] extends [T] ? [T] extends [unknown] ? Exclude<unknown, T> extends never ? Y : N : N : N;
+export type IsAnyOrUnknown<T> = IfUnknown<T, true, never>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oc-server",
-  "version": "2.0.6",
+  "version": "2.1.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",