@kosdev-code/kos-asset-manager 0.0.1-next.30 → 0.0.1-next.31

package/README.md

@@ -275,6 +275,38 @@ branching on an optional asset without the warning `wrapAsset` logs.
 A key resolves in the contexts named at the provider, first match winning,
 unless it names one: `other.app.id:brand/logo-primary`.
 
+## Loading data in a model
+
+Json is declared like any other asset, which makes it fetchable by key:
+
+```ts
+import { loadAsset } from '@kosdev-code/kos-asset-manager';
+
+@kosModel({ modelTypeId: MODEL_TYPE })
+export class MenuModelImpl {
+  async load(): Promise<void> {
+    const menu = await loadAsset<MenuDto>('config/menu');
+    if (!menu) return;
+    this.reconcile(menu.items);
+  }
+}
+```
+
+Data usually has to be parsed and normalised into a model's own shape
+anyway, so this is deliberately a plain async call rather than something a
+component reads. The point is the key: the file can be renamed, moved, or
+moved into a different kab without the model changing.
+
+Undefined comes back when the key isn't declared, the fetch fails, or the
+content isn't valid json, each logged with the key — so a model handles it
+the way it already handles a service returning nothing. `loadAssetText(key)`
+is the same without the parse.
+
+Json files are declared and keyed like anything else, but they don't count
+as media when `kos-assets init` works out where a project keeps its media —
+a manifest sitting beside a folder of images is what marks the images as the
+media, not the whole folder.
+
 ## Selecting sets
 
 Sets of assets are selected rather than named, so adding a file to a folder

package/bin/lib/declare-assets.mjs

@@ -45,6 +45,21 @@ const TYPES = {
   '.webm': 'video/webm',
   '.webp': 'image/webp',
   '.woff2': 'font/woff2',
+  '.json': 'application/json',
+};
+
+/**
+ * Data assets are declared like any other, but they are not what makes a
+ * directory a project's media directory -- a brandset keeps its manifest
+ * beside its images, and it is the manifest sitting there that tells you the
+ * images are the media rather than the whole folder. So layout detection
+ * looks past them.
+ */
+const DATA_TYPES = new Set(['.json']);
+
+const isMedia = (name) => {
+  const ext = name.slice(name.lastIndexOf('.')).toLowerCase();
+  return Boolean(TYPES[ext]) && !DATA_TYPES.has(ext);
 };
 
 /**
@@ -280,8 +295,7 @@ const scanMedia = (dir, prefix = '') =>
     if (item.name.startsWith('.') || SKIP_DIRS.has(item.name)) return [];
     const rel = prefix ? `${prefix}/${item.name}` : item.name;
     if (item.isDirectory()) return scanMedia(join(dir, item.name), rel);
-    const ext = item.name.slice(item.name.lastIndexOf('.')).toLowerCase();
-    return TYPES[ext] ? [rel] : [];
+    return isMedia(item.name) ? [rel] : [];
   });
 
 /** The deepest directory every one of these paths sits under. */
@@ -319,7 +333,7 @@ const climbToMedia = (projectRoot, dir) => {
     const onlyMedia = entries.every((item) =>
       item.isDirectory()
         ? holdsMedia(resolve(projectRoot, ...parent, item.name))
-        : TYPES[item.name.slice(item.name.lastIndexOf('.')).toLowerCase()]
+        : isMedia(item.name)
     );
     if (!onlyMedia) {
       break;
@@ -524,6 +538,8 @@ export {
   SOURCE_DIR,
   ASSETS_ROOT,
   TYPES,
+  DATA_TYPES,
+  isMedia,
   mediaSource,
   mediaRoot,
   scanMedia,

package/index.d.ts

@@ -5,6 +5,7 @@ export { registerAssetModels } from './registration';
 export { contextNames } from './runtime/assets';
 export { KosAssetProvider, KosAssetContext, useAssetManager, useKosAssetContext, } from './runtime/asset-provider';
 export { resolveAsset, wrapAsset, hasAsset, listAssets } from './runtime/resolve';
+export { loadAsset, loadAssetText } from './runtime/data';
 export { preloadAssets, preloadDeclared, releaseAssets, } from './runtime/preload';
 export type { AssetSelector, PreloadOptions, PreloadProgress, ResolvedAsset, } from './runtime/types';
 //# sourceMappingURL=index.d.ts.map