@serve.zone/appstore 0.2.3 → 0.3.0

package/dist_ts_client/index.js

@@ -1,3 +1,3 @@
 export * from './classes.appstoreresolver.js';
 export * from './types.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90c19jbGllbnQvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYywrQkFBK0IsQ0FBQztBQUM5QyxjQUFjLFlBQVksQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19jbGllbnQvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYywrQkFBK0IsQ0FBQztBQUM5QyxjQUFjLFlBQVksQ0FBQyJ9

package/dist_ts_client/types.d.ts

@@ -1,5 +1,6 @@
 import type * as interfaces from '@serve.zone/interfaces';
 export type TAppStoreFetch = typeof fetch;
+export type TAppStoreSourceMode = 'package' | 'remote';
 export type TAppStoreIndex = interfaces.appstore.IAppStoreIndex;
 export type TAppStoreApp = interfaces.appstore.IAppStoreApp;
 export type TAppStoreAppMeta = interfaces.appstore.IAppStoreAppMeta;
@@ -9,11 +10,23 @@ export type TAppStoreRepoManifestSource = interfaces.appstore.IAppStoreRepoManif
 export type TAppStoreResolvedSource = interfaces.appstore.IAppStoreResolvedSource;
 export type TServezoneAppStoreManifest = interfaces.appstore.IServezoneAppStoreManifest;
 export interface IAppStoreResolverOptions {
+    source?: TAppStoreSourceMode;
     baseUrl?: string;
     fetch?: TAppStoreFetch;
     resolveDockerDigests?: boolean;
     now?: () => Date;
 }
+export interface IAppStorePackageData {
+    generatedAt: string;
+    jsonFiles: Record<string, unknown>;
+    textFiles: Record<string, string>;
+}
+export interface IAppStoreSourceInfo {
+    source: TAppStoreSourceMode;
+    packageName: string;
+    packageVersion: string;
+    baseUrl?: string;
+}
 export interface IResolvedAppStoreApp {
     appStoreApp: TAppStoreApp;
     appMeta: TAppStoreAppMeta;

package/dist_ts_client/types.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90c19jbGllbnQvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19jbGllbnQvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/appstore",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "private": false,
   "description": "serve.zone App Store metadata, parser, and resolver client.",
   "type": "module",
@@ -45,8 +45,8 @@
     "cloudly"
   ],
   "scripts": {
-    "test": "tstest test/ --verbose --logfile --timeout 60",
-    "build": "tsbuild tsfolders",
+    "test": "node scripts/generate-data-module.mjs && tstest test/ --verbose --logfile --timeout 60",
+    "build": "node scripts/generate-data-module.mjs && tsbuild tsfolders",
     "buildDocs": "tsdoc"
   }
 }

package/readme.md

@@ -6,6 +6,12 @@ This repository is the curated App Store index consumed by serve.zone runtimes.
 
 For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
 
+## Install
+
+```sh
+pnpm add @serve.zone/appstore
+```
+
 ## What Is In This Repo
 
 | File or directory | Purpose |
@@ -127,7 +133,7 @@ const cloudly = await resolver.getAppMeta('cloudly');
 const config = await resolver.getAppVersionConfig('cloudly', cloudly.latestVersion);
 ```
 
-The resolver defaults to `https://code.foss.global/serve.zone/appstore/raw/branch/main` and reads `appstore.resolved.json` first, then `appstore.json`. Tests can inject a custom `fetch` implementation and base URL.
+The resolver defaults to the App Store data bundled in the published `@serve.zone/appstore` package. Tests and explicit remote consumers can inject a custom `fetch` implementation and base URL.
 
 Only include keys that are actually needed by a template. For example, `nginx` is currently just:
 
@@ -141,7 +147,7 @@ Only include keys that are actually needed by a template. For example, `nginx` i
 ## Working With Templates
 
 - Keep `appstore.json`, `apps/<app>/app.json`, and each version config in sync when adding or changing an app.
-- Prefer `source.type=repoManifest` for serve.zone-owned apps so upgrades can be controlled by merging `servezone.appstore.json` changes into the app repo's main branch.
+- Prefer package-published App Store data for runtime consumers. Use `source.type=repoManifest` only when the linked manifest is intentionally reachable from the runtime environment, or pre-resolve it before publishing an App Store package.
 - Prefer explicit environment variable descriptions because Onebox surfaces them to users during installation.
 - Use platform placeholders such as `${MARIADB_HOST}`, `${MARIADB_PORT}`, `${MARIADB_DATABASE}`, `${MARIADB_USER}`, `${MARIADB_PASSWORD}`, `${MONGODB_URI}`, `${S3_BUCKET}`, `${S3_ACCESS_KEY}`, and `${S3_SECRET_KEY}` only when the matching platform service is declared.
 - Keep template images boring and operationally safe unless there is a reason to pin a more specific upstream tag.
@@ -174,7 +180,7 @@ Use of these trademarks must comply with Task Venture Capital GmbH's Trademark G
 
 ### Company Information
 
-Task Venture Capital GmbH
+Task Venture Capital GmbH<br>
 Registered at District Court Bremen HRB 35230 HB, Germany
 
 For any legal inquiries or further information, please contact us via email at hello@task.vc.

package/ts_client/classes.appstoreresolver.ts

@@ -1,6 +1,9 @@
 import type * as interfaces from '@serve.zone/interfaces';
+import packageJson from '../package.json' with { type: 'json' };
+import { appStorePackageData } from './data.generated.js';
 import type {
   IAppStoreResolverOptions,
+  IAppStoreSourceInfo,
   IParsedDockerImageReference,
   IResolvedAppStoreApp,
   TAppStoreApp,
@@ -8,25 +11,44 @@ import type {
   TAppStoreIndex,
   TAppStoreRepoManifestSource,
   TAppStoreResolvedSource,
+  TAppStoreSourceMode,
   TAppStoreVersionConfig,
   TServezoneAppStoreManifest,
 } from './types.js';
 
+export const appStorePackageMetadata = {
+  name: packageJson.name,
+  version: packageJson.version,
+};
+
+export const appStoreDefaultRemoteBaseUrl = 'https://code.foss.global/serve.zone/appstore/raw/branch/main';
+
 export class AppStoreResolver {
   public readonly baseUrl: string;
   private readonly fetchRef: typeof fetch;
+  private readonly source: TAppStoreSourceMode;
   private readonly resolveDockerDigests: boolean;
   private readonly now: () => Date;
   private appStoreCache: TAppStoreIndex | null = null;
   private sourceAppCache = new Map<string, IResolvedAppStoreApp>();
 
   constructor(optionsArg: IAppStoreResolverOptions = {}) {
-    this.baseUrl = optionsArg.baseUrl || 'https://code.foss.global/serve.zone/appstore/raw/branch/main';
+    this.source = optionsArg.source || (optionsArg.baseUrl || optionsArg.fetch ? 'remote' : 'package');
+    this.baseUrl = optionsArg.baseUrl || appStoreDefaultRemoteBaseUrl;
     this.fetchRef = optionsArg.fetch || fetch;
     this.resolveDockerDigests = optionsArg.resolveDockerDigests ?? true;
     this.now = optionsArg.now || (() => new Date());
   }
 
+  public getSourceInfo(): IAppStoreSourceInfo {
+    return {
+      source: this.source,
+      packageName: appStorePackageMetadata.name,
+      packageVersion: appStorePackageMetadata.version,
+      ...(this.source === 'remote' ? { baseUrl: this.baseUrl } : {}),
+    };
+  }
+
   public async getAppStoreIndex(): Promise<TAppStoreIndex> {
     if (this.appStoreCache) {
       return this.appStoreCache;
@@ -400,6 +422,14 @@ export class AppStoreResolver {
   }
 
   private async fetchJson(pathArg: string): Promise<unknown> {
+    if (this.source === 'package') {
+      const value = appStorePackageData.jsonFiles[pathArg];
+      if (value === undefined) {
+        throw new Error(`Packaged App Store file not found: ${pathArg}`);
+      }
+      return structuredClone(value);
+    }
+
     const url = `${this.baseUrl}/${pathArg}`;
     const response = await this.fetchRef(url);
     if (!response.ok) {
@@ -408,6 +438,25 @@ export class AppStoreResolver {
     return response.json();
   }
 
+  public async fetchText(pathArg: string): Promise<string> {
+    if (this.source === 'package') {
+      if (pathArg in appStorePackageData.textFiles) {
+        return appStorePackageData.textFiles[pathArg];
+      }
+      if (pathArg in appStorePackageData.jsonFiles) {
+        return JSON.stringify(appStorePackageData.jsonFiles[pathArg]);
+      }
+      throw new Error(`Packaged App Store file not found: ${pathArg}`);
+    }
+
+    const url = `${this.baseUrl}/${pathArg}`;
+    const response = await this.fetchRef(url);
+    if (!response.ok) {
+      throw new Error(`HTTP ${response.status} for ${url}`);
+    }
+    return response.text();
+  }
+
   private async fetchTextFromUrl(urlArg: string): Promise<string> {
     const response = await this.fetchRef(urlArg);
     if (!response.ok) {