@monkeyplus/flow 3.7.4 → 4.0.0-beta.1

package/package.json

@@ -1,33 +1,47 @@
 {
   "name": "@monkeyplus/flow",
-  "version": "3.7.4",
+  "version": "4.0.0-beta.1",
   "description": "Utils hapi",
   "author": "Andres Navarrete",
   "license": "MIT",
-  "main": "dist/index",
-  "types": "dist/index",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist/",
     "types/"
   ],
-  "scripts": {
-    "build:ts": "tsc -p tsconfig.build.json",
-    "watch": "tsc -p tsconfig.build.json -w",
-    "test": "jest",
-    "prepublishOnly": "pnpm build:ts"
-  },
-  "devDependencies": {
-    "@types/fs-extra": "^9.0.12",
-    "@types/ramda": "^0.27.44"
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
   },
   "dependencies": {
     "@hapi/boom": "9.x.x",
     "@hapi/hoek": "9.x.x",
-    "@monkeyplus/flow-core": "^3.5.1",
-    "chalk": "^4.1.2",
+    "chalk": "^5.0.0",
     "consola": "^2.15.3",
     "fs-extra": "^10.0.0",
-    "ramda": "^0.27.1"
+    "ramda": "^0.28.0"
   },
-  "gitHead": "ab2b610e6c6744bee7c5dabaa4e250ad580ede1a"
-}
+  "devDependencies": {
+    "@types/fs-extra": "^9.0.13",
+    "@types/hapi__hapi": "^20.0.10",
+    "@types/ramda": "^0.27.64"
+  },
+  "peerDependencies": {
+    "@hapi/hapi": "^20.x"
+  },
+  "gitHead": "1d5387b9c77909019f36d360a0ac53ddaa40e4af",
+  "scripts": {
+    "build": "unbuild",
+    "dev": "pnpm stub && pnpm types",
+    "stub": "unbuild --stub",
+    "types": "tsup ./src/index.ts --dts-only --external types && esno ../../scripts/replace",
+    "lint": "eslint --ext .js,.ts .",
+    "fix": "eslint --fix --ext .ts .",
+    "start": "esno src/index.ts",
+    "test": "vitest"
+  }
+}

package/types/core.d.ts

@@ -0,0 +1,143 @@
+
+export interface ImageBase {
+  name: string
+  alt: string
+  title: string
+}
+export interface ImageSeo {
+  src: string
+  alt: string
+  title: string
+  name: string
+}
+export type DictionaryImages =
+  Record<string, ImageBase>;
+export type DictionaryImagesSeo = Record<string, ImageSeo>;
+
+export type LevelPage =
+| string
+| { default: string; locales: Record<string, string> };
+
+type Context<CTX = Record<string, any>> = CTX;
+
+export interface CtxBuildGlobal {
+  locale: string
+  pages: Map<string, PageInfo>
+  images: DictionaryImagesSeo
+}
+
+export interface CtxBuildLocal extends CtxBuildGlobal {
+  globals: Context
+  name: string
+  defaultLocal: string
+  originName: string
+}
+
+export type RunContext<CTX = any, C = any> = (
+  ctx: CTX
+) => Context<C> | Promise<Context<C>>;
+
+export type Bundle =
+| string
+| { name: string; namespace: string }
+| { name: string; namespace: string }[];
+export interface OptionsLocalPage {
+// url: string;
+  view?: {
+    template: string
+    bundle?: Bundle
+    /**
+   * Custom component
+   */
+    [key: string]: unknown
+  }
+  seo?: Record<string, any>
+  context?: RunContext
+}
+
+export interface OptionsPage<L = OptionsLocalPage> {
+  name: string
+  view: {
+    template: string
+    bundle?: Bundle
+    /**
+   * Custom component
+   */
+    [key: string]: unknown
+  }
+  level?: LevelPage
+  context?: RunContext
+  locales?: Record<string, L>
+}
+
+/**
+* Page metadata
+*/
+export interface BlogInfo {
+  date?: string
+  authors?: {
+    name: string
+    [key: string]: any
+  }[]
+}
+
+export interface PageInfo {
+/**
+ * Nombre de la pagina incluido prefijo y locale
+ */
+  name: string
+  language: string
+  /**
+ * Nombre original de la pagina
+ */
+  localeName: string
+  /**
+ * Locale
+ */
+  locale: string
+  level: string
+  redirect?: string
+  blogInfo?: BlogInfo
+  urlObject: {
+    publicPath: string
+    level: string
+    path: string
+    url: string
+    static: string
+  }
+  view: {
+    template: string
+    bundle?: Bundle
+    [key: string]: any
+  }
+  seo: Record<string, any>
+  runLocalContext?: RunContext
+  runSharedContext?: RunContext
+}
+
+/**
+*
+*/
+export interface LocalesUrl {
+  locale: string
+  url: string
+  seo?: Record<string, any>
+}
+interface DefaultLocale {
+  language: string
+  ubication: string
+  publicPath?: string
+}
+export interface LevelOptions {
+  prefixName?: string
+  level?: LevelPage
+  date?: string
+}
+
+export type RunDefinePages = (options: DefaultLocale) => (
+  extraOptions?: LevelOptions
+) => {
+  name: string
+  pages: (locales: LocalesUrl[]) => PageInfo[]
+};
+export type DefinePages = (options: OptionsPage) => RunDefinePages;

package/types/flow.d.ts

@@ -1,51 +1,52 @@
-import {
-  OptionsPage,
-  OptionsLocalPage,
-  BlogInfo,
-  LevelOptions,
-  PageInfo
-} from '@monkeyplus/flow-core';
-import { Bundle } from '@monkeyplus/flow-core/types/pages';
-import {
-  RouteOptions,
-  ServerRoute,
+import type {
   Request,
-  ResponseToolkit,
   RequestRoute,
-  ServerRealm
+  ResponseToolkit,
+  RouteOptions,
+  Server,
+  ServerRealm,
+  ServerRoute,
 } from '@hapi/hapi';
-import {
+import type {
+  BlogInfo,
+  Bundle,
+  LevelOptions,
+  OptionsLocalPage,
+  OptionsPage,
+  PageInfo,
+} from './core';
+import type {
+  FlowEngines,
+  FlowExtensions,
   FlowPluginExtension,
   FlowPluginGlobal,
   FlowPluginLocal,
   FlowPluginUtils,
-  FlowExtensions,
-  FlowEngines,
-  FlowStatePlugins
+  FlowStatePlugins,
 } from './interfaces';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface FlowOptionPlugins {}
 export interface FlowOptions {
-  relativeTo: string;
-  outputDir?: string;
-  routeOptions?: RouteOptions;
-  dirTemplates?: string;
-  plugins: FlowOptionPlugins;
-  engines?: ('eta' | 'nunjucks')[];
+  relativeTo: string
+  outputDir?: string
+  routeOptions?: RouteOptions
+  dirTemplates?: string
+  plugins: FlowOptionPlugins
+  engines?: ('eta' | 'nunjucks')[]
 }
 
 export interface GenerateFolder {
-  prefix: string;
-  relativeTo: string;
-  dirs: string[];
-  override?: Record<string, string>;
-  type?: string;
+  prefix: string
+  relativeTo: string
+  dirs: string[]
+  override?: Record<string, string>
+  type?: string
 }
 export namespace Extension {
   export interface RouteContext {
-    pageInfo: PageInfo;
-    route: RequestRoute;
+    pageInfo: PageInfo
+    route: RequestRoute
   }
   export type RouteMethod<T = any> = (
     context: RouteContext,
@@ -54,19 +55,19 @@ export namespace Extension {
 
   export type InitMethod = () => Promise<void>;
   export interface Extension {
-    state: any;
-    initMethod?: InitMethod;
-    routeMethod?: RouteMethod;
+    state: any
+    initMethod?: InitMethod
+    routeMethod?: RouteMethod
   }
 }
 export namespace Flow {
   interface Page {
-    url: string;
-    locale: string;
-    localeName: string;
-    name: string;
-    context?: any;
-    dynamicSlug?: string;
+    url: string
+    locale: string
+    localeName: string
+    name: string
+    context?: any
+    dynamicSlug?: string
   }
   export type StaticPages = Record<string, Page>;
   export type Routes = Record<string, ServerRoute>;
@@ -74,159 +75,159 @@ export namespace Flow {
   export type Truncates = Record<string, string>;
   export type DynamicContent = Record<string, { path: string; page: PageInfo }>;
   export type DynamicPages = Record<string, () => Promise<StaticPages>>;
-  export type Pages = {
-    statics: StaticPages;
-    redirects: Redirects;
-    dynamics: DynamicPages;
-    all: StaticPages;
-  };
+  export interface Pages {
+    statics: StaticPages
+    redirects: Redirects
+    dynamics: DynamicPages
+    all: StaticPages
+  }
 
   export interface PluginState {
-    local: FlowPluginLocal;
-    global: FlowPluginGlobal;
-    utils: FlowPluginUtils;
-    extensions: FlowPluginExtension;
+    local: FlowPluginLocal
+    global: FlowPluginGlobal
+    utils: FlowPluginUtils
+    extensions: FlowPluginExtension
     context: Record<
-      string,
-      {
-        assign: 'global' | 'local' | 'seo';
-        method: any;
-      }
-    >;
+    string,
+    {
+      assign: 'global' | 'local' | 'seo'
+      method: any
+    }
+    >
   }
   export interface Helpers {
-    addRedirect: (key: string, urlPath: string) => void;
-    addUrl: (key: string, url: Url) => undefined;
+    addRedirect: (key: string, urlPath: string) => void
+    // addUrl: (key: string, url: Url) => undefined
   }
   export interface AppState {
-    routes: Routes;
+    routes: Routes
     // redirects: Redirects;
     // urls: Urls;
-    pages: Pages;
-    truncates: Truncates;
-    extensions: Record<string, Extension.Extension>;
+    pages: Pages
+    truncates: Truncates
+    extensions: Record<string, Extension.Extension>
     // dynamicPages: DynamicPages;
     generate: {
-      folders: Record<string, GenerateFolder>;
-      staticFolders: Record<string, boolean>;
-      beforePackage: Record<string, () => Promise<unknown>>;
-      postGenerate: Record<string, () => Promise<any>>;
-    };
-    engines: FlowEngines;
-    plugins: FlowStatePlugins;
+      folders: Record<string, GenerateFolder>
+      staticFolders: Record<string, boolean>
+      beforePackage: Record<string, () => Promise<unknown>>
+      postGenerate: Record<string, () => Promise<any>>
+    }
+    engines: FlowEngines
+    plugins: FlowStatePlugins
   }
   export interface Configs extends FlowOptions {
-    relativeTo: string;
-    locales: string[];
-    defaultUbication: string;
-    defaultLanguage: string;
-    publicPath: string;
-    locale: string;
-    url: string;
-    engines: ('eta' | 'nunjucks')[];
+    relativeTo: string
+    locales: string[]
+    defaultUbication: string
+    defaultLanguage: string
+    publicPath: string
+    locale: string
+    url: string
+    engines: ('eta' | 'nunjucks')[]
     // redirects: {};
   }
   export interface GenerateOptions {
-    assets?: GenerateFolder[];
-    ommitAssets?: string[];
+    assets?: GenerateFolder[]
+    ommitAssets?: string[]
     /**
      * Solo aplicable para compilaciones
      */
-    virtualGenerate?: boolean;
+    virtualGenerate?: boolean
   }
 
   export interface Decorate {
-    prepagePackage: () => Promise<unknown>;
-    serverInfo: () => void;
-    init: (proxy?: boolean) => Promise<void>;
+    prepagePackage: () => Promise<unknown>
+    serverInfo: () => void
+    init: (proxy?: boolean) => Promise<void>
     addPage: (
       page: RunDefinePage | OptionsHapiPage,
       dynamic?: OptionsDynamicPages
-    ) => Promise<void>;
+    ) => Promise<void>
     // getPath: (...path: string[]) => string;
-    runGenerate: (options?: GenerateOptions) => Promise<void>;
+    runGenerate: (options?: GenerateOptions) => Promise<void>
     assignPluginOptions: <R = any>(
       realm: ServerRealm,
       options: any,
       defaults?: any,
       context?: any
-    ) => R;
+    ) => R
   }
   export interface HandlerOptions {
-    name: string;
-    locale?: string;
+    name: string
+    locale?: string
     view: {
-      template: string;
-      bundle?: Bundle;
-      [key: string]: any;
-    };
-    context?: RunContextHapi;
-    content?: string;
+      template: string
+      bundle?: Bundle
+      [key: string]: any
+    }
+    context?: RunContextHapi
+    content?: string
   }
 }
 
 export interface OptionsHapiLocalPage extends OptionsLocalPage {
-  url: string;
-  blogInfo?: BlogInfo;
-  options?: RouteOptions;
-  rules?: Record<string, unknown>;
-  dynamic?: OptionDynamicLocalePages;
+  url: string
+  blogInfo?: BlogInfo
+  options?: RouteOptions
+  rules?: Record<string, unknown>
+  dynamic?: OptionDynamicLocalePages
 
-  context?: RunContextHapi;
-  vhost?: string | string[];
+  context?: RunContextHapi
+  vhost?: string | string[]
 }
 export interface ContextHandler {
-  req: Request;
-  h: ResponseToolkit;
+  req: Request
+  h: ResponseToolkit
   page: {
-    level: string;
-    name: string;
-    locale: string;
-    template: string;
-    bundle: Bundle;
-    publicPath: string;
-    path: string;
-    dynamicSlug: string;
-  };
-  seo: Record<string, any>;
+    level: string
+    name: string
+    locale: string
+    template: string
+    bundle: Bundle
+    publicPath: string
+    path: string
+    dynamicSlug: string
+  }
+  seo: Record<string, any>
   /**
    * Si la genoracion de paginas es dinamica este es el contenido
    */
-  global: FlowPluginGlobal;
-  extensions: FlowPluginExtension;
-  utils: FlowPluginUtils;
+  global: FlowPluginGlobal
+  extensions: FlowPluginExtension
+  utils: FlowPluginUtils
 }
 
 export type RunContextHapi = (ctx: ContextHandler) => Promise<any>;
 
 export interface OptionsHapiPage extends OptionsPage {
-  options?: RouteOptions;
-  context?: RunContextHapi;
+  options?: RouteOptions
+  context?: RunContextHapi
 
-  locales: Record<string, OptionsHapiLocalPage>;
-  rules?: Record<string, unknown>;
-  vhost?: string | string[];
-  extensions?: FlowExtensions;
+  locales: Record<string, OptionsHapiLocalPage>
+  rules?: Record<string, unknown>
+  vhost?: string | string[]
+  extensions?: FlowExtensions
 }
 export interface OptionDynamicLocalePages {
-  //Si existe la propiedad contexta asignar a esta propiedad
-  assign?: string;
+  // Si existe la propiedad contexta asignar a esta propiedad
+  assign?: string
   pages: (ctx: {
-    server: Server;
-    route: RequestRoute;
-    locale: string;
-  }) => Promise<Omit<Flow.Page, 'locale' | 'localeName'>[]>;
+    server: Server
+    route: RequestRoute
+    locale: string
+  }) => Promise<Omit<Flow.Page, 'locale' | 'localeName'>[]>
 }
 export interface OptionsDynamicPages {
   // prefix?: (route: RequestRoute) => string | Promise<string>;
-  assign?: string;
+  assign?: string
   pages: (ctx: {
-    server: Server;
-    route: RequestRoute;
-  }) => Promise<Flow.StaticPages>;
+    server: Server
+    route: RequestRoute
+  }) => Promise<Flow.StaticPages>
 }
 export interface ExtraPageOptions {
-  dynamic?: OptionsDynamicPages;
+  dynamic?: OptionsDynamicPages
 }
 // import {} from '..'
 export type RunDefinePage = (configs: Flow.Configs) => ServerRoute[];

package/types/index.d.ts

@@ -12,7 +12,7 @@ export {
   ContextHandler,
   OptionsDynamicPages,
   OptionDynamicLocalePages,
-  ExtraPageOptions
+  ExtraPageOptions,
 } from './flow';
 export {
   FlowExtensions,
@@ -26,7 +26,7 @@ export {
   FlowContextPage,
   FlowEngines,
   FlowStatePlugins,
-  FlowServerMethods
+  FlowServerMethods,
 } from './interfaces';
 export type GenerateOptions =
   | boolean

package/types/interfaces.d.ts

@@ -1,13 +1,13 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
-import { Request, ResponseToolkit } from '@hapi/hapi';
-import { Flow } from './flow';
+import type { Request, ResponseToolkit } from '@hapi/hapi';
+import type { Flow } from './flow';
 export interface FlowExtensions {}
 export interface FlowPluginExtension {}
-export interface FlowPluginUtils {}
+// export interface FlowPluginUtils {}
 
 export interface FlowPluginUtils {
-  getLocalUrl: (name: string) => string;
-  getUrl: (locale: string, name: string) => string;
+  getLocalUrl: (name: string) => string
+  getUrl: (locale: string, name: string) => string
 }
 
 export interface FlowPluginLocal {}
@@ -18,26 +18,26 @@ export interface FlowPluginGlobal {}
  */
 
 export interface FlowContextSeo {
-  title: string;
-  description: string;
-  keywords: string;
-  url: string;
-  pageUrl: string;
+  title: string
+  description: string
+  keywords: string
+  url: string
+  pageUrl: string
 }
 export interface FlowContextPage {
-  publicPath: string;
-  path: string;
-  name: string;
-  locale: string;
-  level: string;
-  template: string;
-  bundle: string;
-  language: string;
+  publicPath: string
+  path: string
+  name: string
+  locale: string
+  level: string
+  template: string
+  bundle: string
+  language: string
 }
 
 export interface FlowContextView {
-  bundle: string;
-  template: string;
+  bundle: string
+  template: string
 }
 // export interface FlowContextGlobal {}
 
@@ -48,14 +48,14 @@ export namespace Contexts {
   export interface View extends FlowContextView {}
   export interface Global extends FlowPluginGlobal {}
   export interface Hapi {
-    req: Request;
-    h: ResponseToolkit;
+    req: Request
+    h: ResponseToolkit
   }
 }
 
 export interface FlowEngines {}
 export interface FlowStatePlugins {}
 export interface FlowServerMethods {
-  pages: () => Promise<Flow.StaticPages>;
-  getUrl: (locale: string, name: string) => string;
+  pages: () => Promise<Flow.StaticPages>
+  getUrl: (locale: string, name: string) => string
 }

package/dist/config.d.ts

@@ -1,15 +0,0 @@
-declare const pkg: any;
-export declare const logger: import("consola").Consola;
-export declare const dependencies: {
-    '@hapi/vision': string;
-};
-export { pkg };
-/**
-export const FULL_NAME_PLUGIN = `@monkeyplus/flow`;
-
-export const DEPENDENCIES = {
-  // '@hapi/vision': '6.x.x',
-};
-/**
- *
- */