@travetto/doc 5.0.0-rc.8 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/doc",
-  "version": "5.0.0-rc.8",
+  "version": "5.0.0",
   "description": "Documentation support for the Travetto framework",
   "keywords": [
     "docs",
@@ -24,12 +24,12 @@
     "directory": "module/doc"
   },
   "dependencies": {
-    "@travetto/runtime": "^5.0.0-rc.8",
+    "@travetto/runtime": "^5.0.0",
     "@types/prismjs": "^1.26.4",
     "prismjs": "^1.29.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^5.0.0-rc.8"
+    "@travetto/cli": "^5.0.0"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/jsx.ts

@@ -1,5 +1,5 @@
 import { createElement, JSXElement, JSXComponentFunction as CompFn } from '@travetto/doc/jsx-runtime';
-import { TypedObject } from '@travetto/runtime';
+import { castTo, TypedObject } from '@travetto/runtime';
 
 import { LIB_MAPPING } from './mapping/lib-mapping';
 import { MOD_MAPPING } from './mapping/mod-mapping';
@@ -65,7 +65,7 @@ export type JSXElements = { [K in keyof C]: JSXElementByFn<K>; };
 
 export const EMPTY_ELEMENT = EMPTY;
 
-const invertedC = new Map<Function, string>(TypedObject.entries(c).map(p => [p[1], p[0]] as [CompFn, string]));
+const invertedC = new Map<Function, string>(TypedObject.entries(c).map<[Function, string]>(p => [p[1], p[0]]));
 
 export function getComponentName(fn: Function | string): string {
   if (typeof fn === 'string') {
@@ -81,7 +81,7 @@ function CodeLinker(titleOrNode: string | JSXElement, src?: string, startRe?: Re
   if (typeof titleOrNode === 'string') {
     props = { title: titleOrNode, src: src!, startRe: startRe! };
   } else if (titleOrNode.type === Code) {
-    const node = titleOrNode as unknown as JSXElementByFn<'Code'>;
+    const node: JSXElementByFn<'Code'> = castTo(titleOrNode);
     props = {
       title: node.props.title,
       src: node.props.src,
@@ -90,7 +90,7 @@ function CodeLinker(titleOrNode: string | JSXElement, src?: string, startRe?: Re
   } else {
     throw new Error(`Unsupported element type: ${titleOrNode.type}`);
   }
-  return createElement(c.CodeLink, props) as JSXElementByFn<'CodeLink'>;
+  return createElement(c.CodeLink, props);
 }
 
 export const d = {

package/src/mapping/lib-mapping.ts

@@ -82,6 +82,7 @@ export const LIB_MAPPING = {
   ImageMagick: { title: 'ImageMagick', href: 'https://imagemagick.org/index.php' },
   PngQuant: { title: 'pngquant', href: 'https://pngquant.org/' },
   JpegOptim: { title: 'Jpegoptim', href: 'https://github.com/tjko/jpegoptim' },
+  Sharp: { title: 'sharp', href: 'https://sharp.pixelplumbing.com/' },
 
   // Dbs
   MongoDB: { title: 'mongodb', href: 'https://mongodb.com' },

package/src/mapping/mod-mapping.ts

@@ -1,12 +1,4 @@
 export const MOD_MAPPING = {
-  Asset: {
-    name: '@travetto/asset', folder: '@travetto/asset', displayName: 'Asset',
-    description: 'Modular library for storing and retrieving binary assets'
-  },
-  AssetRest: {
-    name: '@travetto/asset-rest', folder: '@travetto/asset-rest', displayName: 'Asset Rest Support',
-    description: 'Provides integration between the travetto asset and rest module.'
-  },
   Auth: {
     name: '@travetto/auth', folder: '@travetto/auth', displayName: 'Authentication',
     description: 'Authentication scaffolding for the Travetto framework'
@@ -31,10 +23,6 @@ export const MOD_MAPPING = {
     name: '@travetto/auth-rest-session', folder: '@travetto/auth-rest-session', displayName: 'Rest Auth Session',
     description: 'Rest authentication session integration support for the Travetto framework'
   },
-  Base: {
-    name: '@travetto/runtime', folder: '@travetto/runtime', displayName: 'Base',
-    description: 'Environment config and common utilities for travetto applications.'
-  },
   Cache: {
     name: '@travetto/cache', folder: '@travetto/cache', displayName: 'Caching',
     description: 'Caching functionality with decorators for declarative use.'
@@ -115,10 +103,18 @@ export const MOD_MAPPING = {
     name: '@travetto/model-elasticsearch', folder: '@travetto/model-elasticsearch', displayName: 'Elasticsearch Model Source',
     description: 'Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.'
   },
+  ModelFile: {
+    name: '@travetto/model-file', folder: '@travetto/model-file', displayName: 'File Model Support',
+    description: 'File system backing for the travetto model module.'
+  },
   ModelFirestore: {
     name: '@travetto/model-firestore', folder: '@travetto/model-firestore', displayName: 'Firestore Model Support',
     description: 'Firestore backing for the travetto model module.'
   },
+  ModelMemory: {
+    name: '@travetto/model-memory', folder: '@travetto/model-memory', displayName: 'Memory Model Support',
+    description: 'Memory backing for the travetto model module.'
+  },
   ModelMongo: {
     name: '@travetto/model-mongo', folder: '@travetto/model-mongo', displayName: 'MongoDB Model Support',
     description: 'Mongo backing for the travetto model module.'
@@ -135,6 +131,10 @@ export const MOD_MAPPING = {
     name: '@travetto/model-query', folder: '@travetto/model-query', displayName: 'Data Model Querying',
     description: 'Datastore abstraction for advanced query support.'
   },
+  ModelQueryLanguage: {
+    name: '@travetto/model-query-language', folder: '@travetto/model-query-language', displayName: 'Data Model Query Language',
+    description: 'Datastore query language.'
+  },
   ModelRedis: {
     name: '@travetto/model-redis', folder: '@travetto/model-redis', displayName: 'Redis Model Support',
     description: 'Redis backing for the travetto model module.'
@@ -219,6 +219,10 @@ export const MOD_MAPPING = {
     name: '@travetto/rest-upload', folder: '@travetto/rest-upload', displayName: 'Rest Upload Support',
     description: 'Provides integration between the travetto asset and rest module.'
   },
+  Runtime: {
+    name: '@travetto/runtime', folder: '@travetto/runtime', displayName: 'Runtime',
+    description: 'Runtime for travetto applications.'
+  },
   Scaffold: {
     name: '@travetto/scaffold', folder: '@travetto/scaffold', displayName: 'App Scaffold',
     description: 'App Scaffold for the Travetto framework'

package/src/render/code-highlight.ts

@@ -1,4 +1,4 @@
-import { default as prismjs } from 'prismjs';
+import { default as prismJs } from 'prismjs';
 
 import 'prismjs/plugins/normalize-whitespace/prism-normalize-whitespace.js';
 import 'prismjs/components/prism-typescript.js';
@@ -12,20 +12,20 @@ import 'prismjs/components/prism-sql.js';
 import 'prismjs/components/prism-properties.js';
 import 'prismjs/components/prism-bash.js';
 
-prismjs.plugins.NormalizeWhitespace.setDefaults({
+prismJs.plugins.NormalizeWhitespace.setDefaults({
   'remove-trailing': true,
   'remove-indent': true,
   'left-trim': true,
   'right-trim': true
 });
 
-const nw = prismjs.plugins.NormalizeWhitespace;
+const nw = prismJs.plugins.NormalizeWhitespace;
 
 const tokenMapping: { [key: string]: string } = {
-  gt: '>',
-  lt: '<',
-  quot: '"',
-  apos: "'"
+  '&gt;': '>',
+  '&lt;': '<',
+  '&quot;': '"',
+  '&apos;': "'"
 };
 
 export function highlight(text: string, lang: string): string | undefined {
@@ -35,10 +35,10 @@ export function highlight(text: string, lang: string): string | undefined {
 
   text = text
     .replace(/&#(\d+);/g, (x, code) => String.fromCharCode(code))
-    .replace(/&([a-z][^;]*);/g, (a, k) => tokenMapping[k] || a);
+    .replace(/&[a-z][^;]*;/g, a => tokenMapping[a] || a);
 
   try {
-    return prismjs.highlight(text, prismjs.languages[lang], lang)
+    return prismJs.highlight(text, prismJs.languages[lang], lang)
       .replace(/(@\s*<span[^>]*)function("\s*>)/g, (a, pre, post) => `${pre}meta${post}`)
       .replace(/[{}]/g, a => `{{'${a}'}}`);
   } catch (err) {

package/src/render/context.ts

@@ -3,7 +3,7 @@ import path from 'node:path';
 import { createElement, JSXRuntimeTag } from '@travetto/doc/jsx-runtime';
 
 import { PackageUtil } from '@travetto/manifest';
-import { RuntimeIndex } from '@travetto/runtime';
+import { castTo, RuntimeIndex } from '@travetto/runtime';
 
 import { JSXElementByFn, c } from '../jsx';
 import { DocResolveUtil, ResolvedCode, ResolvedRef, ResolvedSnippetLink } from '../util/resolve';
@@ -125,6 +125,6 @@ export class RenderContext {
    */
   createElement<K extends keyof typeof c>(name: K, props: JSXElementByFn<K>['props']): JSXElementByFn<K> {
     // @ts-expect-error
-    return createElement(c[name], props) as JSXElementByFn<K>;
+    return castTo(createElement(c[name], props));
   }
 }

package/src/render/renderer.ts

@@ -2,7 +2,7 @@ import path from 'node:path';
 
 import { type ManifestContext, PackageUtil } from '@travetto/manifest';
 import { isJSXElement, JSXElement, JSXFragmentType } from '@travetto/doc/jsx-runtime';
-import { Runtime } from '@travetto/runtime';
+import { castTo, Runtime } from '@travetto/runtime';
 
 import { EMPTY_ELEMENT, getComponentName, JSXElementByFn, c } from '../jsx';
 import { DocumentShape, RenderProvider, RenderState } from '../types';
@@ -55,8 +55,7 @@ export class DocRenderer {
       let final: JSXElement = node;
       // Render simple element if needed
       if (typeof node.type === 'function' && node.type !== JSXFragmentType) {
-        // @ts-expect-error
-        const out = node.type(node.props);
+        const out = castTo<Function>(node.type)(node.props);
         final = out !== EMPTY_ELEMENT ? out : final;
       }