adjacent-core 0.1.0

package/dist/metadata.d.ts

@@ -0,0 +1,54 @@
+import type { AdjacentConfig } from "./config.js";
+export interface ResolvedMetadata {
+    readonly appleWebApp: {
+        readonly capable: true;
+        readonly statusBarStyle: "default";
+        readonly title: string;
+    };
+    readonly description?: string;
+    readonly icons: {
+        readonly apple: {
+            readonly sizes: "180x180";
+            readonly type: "image/png";
+            readonly url: string;
+        }[];
+        readonly icon: {
+            readonly sizes?: "96x96";
+            readonly type: "image/png" | "image/svg+xml";
+            readonly url: string;
+        }[];
+        readonly shortcut: string;
+    };
+    readonly manifest: "/manifest.webmanifest";
+    /**
+     * A template rather than a string, so a page exporting `title: "Settings"`
+     * reads as "Settings · App" instead of losing the application's name. A page
+     * that exports none falls back to `default`.
+     */
+    readonly title: {
+        readonly default: string;
+        readonly template: string;
+    };
+}
+export interface ThemeColorDescriptor {
+    readonly color: string;
+    readonly media: string;
+}
+export interface ResolvedViewport {
+    /**
+     * Android shrinks the layout viewport for the software keyboard, which lets
+     * the shell's grid re-run instead of leaving fixed chrome underneath it.
+     */
+    readonly interactiveWidget: "resizes-content";
+    /**
+     * One colour, or one per colour scheme. A document may carry several
+     * `theme-color` values as long as each says which scheme it is for, and the
+     * browser takes the first that matches.
+     */
+    readonly themeColor: string | ThemeColorDescriptor[];
+    /** Safe-area insets report zero until the viewport covers the display cutout. */
+    readonly viewportFit: "cover";
+}
+export declare function resolveMetadata(config: AdjacentConfig): ResolvedMetadata;
+export declare function resolveViewport(config: AdjacentConfig): ResolvedViewport;
+//# sourceMappingURL=metadata.d.ts.map

package/dist/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,WAAW,EAAE;QACpB,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;QACvB,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC;QACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE;QACd,QAAQ,CAAC,KAAK,EAAE;YAAE,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;YAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;YAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAClG,QAAQ,CAAC,IAAI,EAAE;YAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;YAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,eAAe,CAAC;YAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAClH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAC;IAC3C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;CACzE;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC9C;;;;OAIG;IAGH,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,oBAAoB,EAAE,CAAC;IACrD,iFAAiF;IACjF,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC/B;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,gBAAgB,CAmBxE;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,gBAAgB,CAgBxE"}

package/dist/metadata.js

@@ -0,0 +1,37 @@
+export function resolveMetadata(config) {
+    return {
+        appleWebApp: {
+            capable: true,
+            statusBarStyle: "default",
+            title: config.app.shortName ?? config.app.name,
+        },
+        description: config.app.description,
+        icons: {
+            apple: [{ sizes: "180x180", type: "image/png", url: "/apple-touch-icon.png" }],
+            icon: [
+                { sizes: "96x96", type: "image/png", url: "/favicon-96x96.png" },
+                { type: "image/svg+xml", url: "/favicon.svg" },
+            ],
+            shortcut: "/favicon.ico",
+        },
+        manifest: "/manifest.webmanifest",
+        title: { default: config.app.name, template: `%s · ${config.app.name}` },
+    };
+}
+export function resolveViewport(config) {
+    const light = config.appearance?.themeColor ?? "#ffffff";
+    const dark = config.appearance?.themeColorDark;
+    return {
+        interactiveWidget: "resizes-content",
+        // A bare string while there is one colour, because a single unconditional
+        // `theme-color` is what every browser has always understood.
+        themeColor: dark
+            ? [
+                { color: light, media: "(prefers-color-scheme: light)" },
+                { color: dark, media: "(prefers-color-scheme: dark)" },
+            ]
+            : light,
+        viewportFit: "cover",
+    };
+}
+//# sourceMappingURL=metadata.js.map

package/dist/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AA8CA,MAAM,UAAU,eAAe,CAAC,MAAsB;IACpD,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,IAAI;YACb,cAAc,EAAE,SAAS;YACzB,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI;SAC/C;QACD,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW;QACnC,KAAK,EAAE;YACL,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,uBAAuB,EAAE,CAAC;YAC9E,IAAI,EAAE;gBACJ,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,oBAAoB,EAAE;gBAChE,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,EAAE;aAC/C;YACD,QAAQ,EAAE,cAAc;SACzB;QACD,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE;KACzE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAsB;IACpD,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,EAAE,UAAU,IAAI,SAAS,CAAC;IACzD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC;IAE/C,OAAO;QACL,iBAAiB,EAAE,iBAAiB;QACpC,0EAA0E;QAC1E,6DAA6D;QAC7D,UAAU,EAAE,IAAI;YACd,CAAC,CAAC;gBACE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,+BAA+B,EAAE;gBACxD,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,8BAA8B,EAAE;aACvD;YACH,CAAC,CAAC,KAAK;QACT,WAAW,EAAE,OAAO;KACrB,CAAC;AACJ,CAAC"}

package/dist/worker-protocol.d.ts

@@ -0,0 +1,22 @@
+export declare const WORKER_COMMAND: {
+    readonly activateUpdate: "ADJACENT_ACTIVATE_UPDATE";
+    readonly clearCache: "ADJACENT_CLEAR_CACHE";
+    readonly revalidate: "ADJACENT_REVALIDATE";
+};
+export type AdjacentCacheTarget = "all" | "assets" | "pages";
+export type AdjacentWorkerCommand = {
+    readonly type: typeof WORKER_COMMAND.activateUpdate;
+} | {
+    readonly target: AdjacentCacheTarget;
+    readonly type: typeof WORKER_COMMAND.clearCache;
+} | {
+    readonly type: typeof WORKER_COMMAND.revalidate;
+    readonly urls: readonly string[];
+};
+export type AdjacentWorkerResponse = {
+    readonly ok: true;
+} | {
+    readonly error: string;
+    readonly ok: false;
+};
+//# sourceMappingURL=worker-protocol.d.ts.map

package/dist/worker-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-protocol.d.ts","sourceRoot":"","sources":["../src/worker-protocol.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;CAIjB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE7D,MAAM,MAAM,qBAAqB,GAC7B;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,cAAc,CAAC,cAAc,CAAA;CAAE,GACvD;IACE,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,OAAO,cAAc,CAAC,UAAU,CAAC;CACjD,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,OAAO,cAAc,CAAC,UAAU,CAAC;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CAClC,CAAC;AAEN,MAAM,MAAM,sBAAsB,GAC9B;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAA;CAAE,GACrB;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAA;CAAE,CAAC"}

package/dist/worker-protocol.js

@@ -0,0 +1,6 @@
+export const WORKER_COMMAND = {
+    activateUpdate: "ADJACENT_ACTIVATE_UPDATE",
+    clearCache: "ADJACENT_CLEAR_CACHE",
+    revalidate: "ADJACENT_REVALIDATE",
+};
+//# sourceMappingURL=worker-protocol.js.map

package/dist/worker-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-protocol.js","sourceRoot":"","sources":["../src/worker-protocol.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,cAAc,EAAE,0BAA0B;IAC1C,UAAU,EAAE,sBAAsB;IAClC,UAAU,EAAE,qBAAqB;CACzB,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "adjacent-core",
+  "version": "0.1.0",
+  "description": "Configuration contract, web app manifest, and metadata primitives for Adjacent.",
+  "keywords": [
+    "pwa",
+    "progressive-web-app",
+    "manifest",
+    "nextjs",
+    "adjacent"
+  ],
+  "license": "MIT",
+  "author": "Eric Kweyunga",
+  "homepage": "https://github.com/erickweyunga/adjacent-framework/blob/main/docs/configuration.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/erickweyunga/adjacent-framework.git",
+    "directory": "packages/adjacent-core"
+  },
+  "bugs": {
+    "url": "https://github.com/erickweyunga/adjacent-framework/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20.9.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "zod": "^4.1.5"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.13",
+    "typescript": "^5"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false
+}