@coreframe/config 0.1.9 → 0.1.11

package/dist/index.d.ts

@@ -2,7 +2,8 @@ import { JsonObject, JsonValue, PrimaryWorkerContributions, PrimaryWorkerEnviron
 
 //#region src/index.d.ts
 type CoreframeConfig = {
-  /** Object storage and public asset delivery settings. */assets?: AssetsConfig; /** Database settings used by local and deployment workflows. */
+  /** Object storage and public asset delivery settings. */assets?: AssetsConfig; /** Responsive layout breakpoints in logical CSS pixels. */
+  breakpoints?: BreakpointsConfig; /** Database settings used by local and deployment workflows. */
   database?: DatabaseConfig; /** Deployment hooks, environments, checks, and release settings. */
   deploy?: DeployConfig; /** Local development settings. */
   dev?: DevConfig; /** Translation catalog and locale settings. */
@@ -11,6 +12,24 @@ type CoreframeConfig = {
   preview?: PreviewConfig; /** Worker build and runtime settings. */
   worker?: WorkerConfig;
 };
+/** Named responsive layout breakpoints shared by Panda, web, and Flutter. */
+type BreakpointsConfig = Readonly<{
+  "2xl": number;
+  lg: number;
+  md: number;
+  sm: number;
+  xl: number;
+}>;
+declare const breakpointNames: readonly ["sm", "md", "lg", "xl", "2xl"];
+declare function defineConfig(config: CoreframeConfig): CoreframeConfig;
+/** Validates and returns the project's required breakpoint contract. */
+declare function validateBreakpoints(value: unknown): BreakpointsConfig;
+/** Loads and validates the project's required breakpoint contract. */
+declare function readProjectBreakpoints({
+  cwd
+}?: {
+  cwd?: string;
+}): Promise<BreakpointsConfig>;
 type FlutterConfig = {
   /** Custom URL origin accepted for navigation into the Flutter app. */deepLink: FlutterDeepLinkConfig;
 };
@@ -98,6 +117,8 @@ type I18nConfig = {
   sourceLocale: string;
 };
 type DeployEnvironment = "staging" | "production";
+/** Active topology published by the Coreframe deployment workflow. */
+type DeployMode = "client" | "full";
 type DeployContext = {
   /** Deployment environment being released. */environment: DeployEnvironment; /** Human-readable name assigned to the release. */
   releaseName: string; /** Public URL of the deployed application. */
@@ -121,13 +142,15 @@ type StagingHostnameConfig = {
 type DeployConfig = {
   /** Hook called after all deployment work completes. */afterDeploy?: (context: DeployContext) => Promise<void> | void; /** Hook called immediately after the worker deployment completes. */
   afterWorkerDeploy?: (context: DeployContext) => Promise<void> | void; /** Per-environment deployment overrides. */
-  environments?: Partial<Record<DeployEnvironment, DeployEnvironmentConfig>>;
+  environments?: Partial<Record<DeployEnvironment, DeployEnvironmentConfig>>; /** Deployed application topology selected by the Coreframe release workflow. */
+  mode: DeployMode;
   /**
    * HTTP checks run against the application after deployment.
    *
    * @example
    *   defineConfig({
    *     deploy: {
+   *       mode: "full",
    *       smokeChecks: [
    *         { name: "home", path: "/" },
    *         {
@@ -146,6 +169,7 @@ type DeployConfig = {
    * @example
    *   defineConfig({
    *     deploy: {
+   *       mode: "full",
    *       stagingHostname: {
    *         managedLabelPrefix: "review-",
    *         parentHostname: "staging.example.com",
@@ -156,7 +180,6 @@ type DeployConfig = {
    */
   stagingHostname?: StagingHostnameConfig;
 };
-declare function defineConfig(config: CoreframeConfig): CoreframeConfig;
 declare function readProjectConfig({
   cwd
 }?: {
@@ -165,4 +188,4 @@ declare function readProjectConfig({
 declare function importProjectModule<T>(path: string, cwd?: string): Promise<T>;
 declare function importProjectDependency<T>(specifier: string, cwd?: string): Promise<T>;
 //#endregion
-export { AssetsConfig, CoreframeConfig, DatabaseConfig, DatabaseDialect, DeployConfig, DeployContext, DeployEnvironment, DeployEnvironmentConfig, DeploySmokeCheck, DevConfig, DevPlatform, FlutterConfig, FlutterDeepLinkConfig, I18nConfig, JsonObject, JsonValue, PreviewConfig, PreviewTunnelConfig, PreviewWorkerConfig, PrimaryWorkerContributions, PrimaryWorkerEnvironment, StagingHostnameConfig, WorkerConfig, WorkerDeployEnvironment, WorkerEnvironmentDeclaration, WorkerEnvironmentKind, WorkerEnvironmentVariableConfig, WranglerConfig, coreframeGeneratedWorkerVariables, coreframeLocalWorkerVariables, coreframeManagedWorkerSecrets, defineConfig, derivePrimaryWorkerConfig, importProjectDependency, importProjectModule, normalizeWorkerEnvironment, primaryWorkerConfigPath, primaryWorkerEnvironments, readProjectConfig, validateWorkerInventoryOwnership, workerBindingNames, wranglerEnvironmentNames };
+export { AssetsConfig, BreakpointsConfig, CoreframeConfig, DatabaseConfig, DatabaseDialect, DeployConfig, DeployContext, DeployEnvironment, DeployEnvironmentConfig, DeployMode, DeploySmokeCheck, DevConfig, DevPlatform, FlutterConfig, FlutterDeepLinkConfig, I18nConfig, JsonObject, JsonValue, PreviewConfig, PreviewTunnelConfig, PreviewWorkerConfig, PrimaryWorkerContributions, PrimaryWorkerEnvironment, StagingHostnameConfig, WorkerConfig, WorkerDeployEnvironment, WorkerEnvironmentDeclaration, WorkerEnvironmentKind, WorkerEnvironmentVariableConfig, WranglerConfig, breakpointNames, coreframeGeneratedWorkerVariables, coreframeLocalWorkerVariables, coreframeManagedWorkerSecrets, defineConfig, derivePrimaryWorkerConfig, importProjectDependency, importProjectModule, normalizeWorkerEnvironment, primaryWorkerConfigPath, primaryWorkerEnvironments, readProjectBreakpoints, readProjectConfig, validateBreakpoints, validateWorkerInventoryOwnership, workerBindingNames, wranglerEnvironmentNames };

package/dist/index.js

@@ -1 +1 @@
-import{fs as e,process as t}from"./environment.js";import{coreframeGeneratedWorkerVariables as n,coreframeLocalWorkerVariables as r,coreframeManagedWorkerSecrets as i,derivePrimaryWorkerConfig as a,normalizeWorkerEnvironment as o,primaryWorkerConfigPath as s,primaryWorkerEnvironments as c,validateWorkerInventoryOwnership as l,workerBindingNames as u,wranglerEnvironmentNames as d}from"./worker.js";import{resolve as f}from"node:path";import{pathToFileURL as p}from"node:url";import{resolve as m}from"import-meta-resolve";function h(e){return e}async function g({cwd:n=t.cwd()}={}){let r=f(n,`coreframe.config.ts`),i;try{i=(await e.stat(r,{bigint:!0})).mtimeNs}catch{return{}}let a=p(r);return a.searchParams.set(`modified`,i.toString()),(await import(a.href)).default??{}}async function _(e,n=t.cwd()){return await import(p(f(n,e)).href)}async function v(e,n=t.cwd()){return await import(m(e,p(f(n,`package.json`)).href))}export{n as coreframeGeneratedWorkerVariables,r as coreframeLocalWorkerVariables,i as coreframeManagedWorkerSecrets,h as defineConfig,a as derivePrimaryWorkerConfig,v as importProjectDependency,_ as importProjectModule,o as normalizeWorkerEnvironment,s as primaryWorkerConfigPath,c as primaryWorkerEnvironments,g as readProjectConfig,l as validateWorkerInventoryOwnership,u as workerBindingNames,d as wranglerEnvironmentNames};
+import{fs as e,process as t}from"./environment.js";import{coreframeGeneratedWorkerVariables as n,coreframeLocalWorkerVariables as r,coreframeManagedWorkerSecrets as i,derivePrimaryWorkerConfig as a,normalizeWorkerEnvironment as o,primaryWorkerConfigPath as s,primaryWorkerEnvironments as c,validateWorkerInventoryOwnership as l,workerBindingNames as u,wranglerEnvironmentNames as d}from"./worker.js";import{resolve as f}from"node:path";import{pathToFileURL as p}from"node:url";import{resolve as m}from"import-meta-resolve";const h=[`sm`,`md`,`lg`,`xl`,`2xl`];function g(e){return e.breakpoints!==void 0&&_(e.breakpoints),e}function _(e){if(!y(e))throw Error(`coreframe.config.ts must configure breakpoints.sm, md, lg, xl, and 2xl as positive finite numbers.`);let t=Object.keys(e).sort(),n=[...h].sort();if(t.length!==n.length||t.some((e,t)=>e!==n[t]))throw Error(`coreframe.config.ts breakpoints must contain only sm, md, lg, xl, and 2xl.`);let r=0;for(let t of h){let n=e[t];if(typeof n!=`number`||!Number.isFinite(n)||n<=0)throw Error(`coreframe.config.ts breakpoints.${t} must be a positive finite number of logical pixels.`);if(n<=r)throw Error(`coreframe.config.ts breakpoints must increase strictly from sm through 2xl; breakpoints.${t} is not greater than the preceding value.`);r=n}return e}async function v({cwd:e=t.cwd()}={}){let n=await b({cwd:e});if(n.breakpoints===void 0)throw Error(`coreframe.config.ts must configure breakpoints.sm, md, lg, xl, and 2xl as positive finite numbers.`);return _(n.breakpoints)}function y(e){return!!(e&&typeof e==`object`&&!Array.isArray(e))}async function b({cwd:n=t.cwd()}={}){let r=f(n,`coreframe.config.ts`),i;try{i=(await e.stat(r,{bigint:!0})).mtimeNs}catch{return{}}let a=p(r);return a.searchParams.set(`modified`,i.toString()),(await import(a.href)).default??{}}async function x(e,n=t.cwd()){return await import(p(f(n,e)).href)}async function S(e,n=t.cwd()){return await import(m(e,p(f(n,`package.json`)).href))}export{h as breakpointNames,n as coreframeGeneratedWorkerVariables,r as coreframeLocalWorkerVariables,i as coreframeManagedWorkerSecrets,g as defineConfig,a as derivePrimaryWorkerConfig,S as importProjectDependency,x as importProjectModule,o as normalizeWorkerEnvironment,s as primaryWorkerConfigPath,c as primaryWorkerEnvironments,v as readProjectBreakpoints,b as readProjectConfig,_ as validateBreakpoints,l as validateWorkerInventoryOwnership,u as workerBindingNames,d as wranglerEnvironmentNames};

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@coreframe/config",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Environment and project configuration utilities for Coreframe apps",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/airlock-labs/coreframe.git",
+    "url": "git+https://github.com/coreframe-js/coreframe.git",
     "directory": "node/config"
   },
   "files": [