@mfeflow/contracts 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -7,7 +7,7 @@ export { judgeRemoteInitial, primaryExpose, type RemoteInitialVerdict } from './
 export { injectIntoHead, registryInjection, type InjectionOptions, type RouteNeed, } from './html-injection.js';
 export { isRegistryEntry, isRegistryIndex, isRegistryIndexRemote, registryRemoteIssues, ROUTE_OVERLAP, validateRegistryEntry, validateRegistryIndex, type RegistryEntry, type RegistryIndex, type RegistryIndexRemote, } from './registry.js';
 export { isFeatureRegistryIndex, isLoopbackHttp, isPrivateHost, isRegistryProtocol, redactUrl, redactUrlsIn, registryIndexUrl, registryTemplateProblem, validateFeatureRegistryIndex, MAX_DESCRIPTION, MAX_INDEX_ITEMS, REGISTRY_ITEM_NAME, type FeatureRegistryIndex, type FeatureRegistryItem, } from './feature-registry.js';
-export { FILE_HASH, PROJECT_REPOS, REGISTRY_HOST, REGISTRY_NAMESPACE, isMfeflowProject, validateMfeflowProject, type MfeflowProject, type ProjectBudget, type ProjectRegistry, } from './project.js';
+export { ENV_KEY_NAME, FILE_HASH, PROJECT_REPOS, REGISTRY_HOST, REGISTRY_NAMESPACE, isMfeflowProject, validateMfeflowProject, type MfeflowProject, type ProjectBudget, type ProjectRegistry, } from './project.js';
 export { COST_MODEL, judgeCost, round1, splitScripts, type CostLine, type CostModel, type CostSample, type CostVerdict, } from './cost-model.js';
 export { FEATURE_CONDITION, FEATURE_NAME, isFeatureManifest, TRANSFORM_OPS, validateFeatureManifest, type AddBootStepOp, type AddEnvKeyOp, type AddImportOp, type AddRouteOp, type AddSharedOp, type AddWorkflowStepOp, type EnvValidator, type FeatureCondition, type FeatureDependency, type FeatureFile, type FeatureManifest, type FeatureMigration, type FeaturePrompt, type FeatureScript, type FeatureTarget, type Literal, type PromptValue, type TransformOp, type TransformOpName, type WorkflowStep, type WrapProviderOp, } from './feature.js';
 export { DOCS_URL, SCHEMA_ALIASES, SCHEMA_URLS, errorDocsUrl, type SchemaName } from './docs.js';

package/dist/index.js

@@ -715,6 +715,7 @@ function redactUrlsIn(text) {
 }
 const project_SEGMENT = String.raw`(?!\.\.?(?:/|$))[^/\\\u0000]+`;
 const CHECKOUT_PATH = new RegExp(`^(?:(?![A-Za-z]:)(?:\\.\\.(?:/\\.\\.)*(?:/${project_SEGMENT})*|${project_SEGMENT}(?:/${project_SEGMENT})*)|(?:/|[A-Za-z]:/)${project_SEGMENT}(?:/${project_SEGMENT})*)$`);
+const ENV_KEY_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
 const FILE_HASH = /^sha256-[0-9a-f]{64}$/;
 const REGISTRY_NAMESPACE = /^@[a-z0-9][a-z0-9-]*$/;
 function isCheckoutPath(value) {
@@ -821,6 +822,12 @@ function validateMfeflowProject(value) {
         if (!isSafeRelativePath(file)) c.add(at, 'must be a relative path with forward slashes');
         if ('string' != typeof hash || !FILE_HASH.test(hash)) c.add(at, 'must be a hash like "sha256-<64 hex characters>"');
     }
+    const envKeys = c.object(value, 'envKeys', '', false);
+    if (envKeys) for (const [file, keys] of Object.entries(envKeys)){
+        const at = `envKeys.${file}`;
+        if (!isSafeRelativePath(file)) c.add(at, 'must be a relative path with forward slashes');
+        if (!Array.isArray(keys) || keys.some((key)=>'string' != typeof key || !ENV_KEY_NAME.test(key))) c.add(at, 'must be a list of key names like "API_ORIGIN"');
+    }
     const registries = c.object(value, 'registries', '', false);
     if (registries) for (const [ns, url] of Object.entries(registries)){
         const at = `registries.${ns}`;
@@ -1524,6 +1531,11 @@ const JSON_SCHEMAS = {
                 propertyNames: relativePath,
                 additionalProperties: str(FILE_HASH)
             },
+            envKeys: {
+                type: 'object',
+                propertyNames: relativePath,
+                additionalProperties: json_schema_strings(ENV_KEY_NAME)
+            },
             registries: {
                 type: 'object',
                 propertyNames: {
@@ -1773,4 +1785,4 @@ const JSON_SCHEMAS = {
     })
 };
 export { EXPOSE, ROUTE, isRegistryIndexRemote, registryRemoteIssues } from "./entry.js";
-export { ANALYTICS_EVENT, COST_MODEL, DOCS_URL, EVENT_NAME, FEATURE_CONDITION, FEATURE_NAME, FILE_HASH, JSON_SCHEMAS, MAX_DESCRIPTION, MAX_INDEX_ITEMS, MFE_NAME, PROJECT_REPOS, REGISTRY_HOST, REGISTRY_ITEM_NAME, REGISTRY_NAMESPACE, ROUTE_OVERLAP, SCHEMA_ALIASES, SCHEMA_URLS, TRANSFORM_OPS, assetsFromManifest, errorDocsUrl, injectIntoHead, isFeatureManifest, isFeatureRegistryIndex, isLoopbackHttp, isMfeManifest, isMfeflowProject, isPortableRelativePath, isPrivateHost, isRegistryEntry, isRegistryIndex, isRegistryProtocol, isSafeRelativePath, judgeCost, judgeRemoteInitial, primaryExpose, redactUrl, redactUrlsIn, registryIndexUrl, registryInjection, registryTemplateProblem, remoteDistFiles, round1, routesOverlap, splitScripts, validateFeatureManifest, validateFeatureRegistryIndex, validateMfeManifest, validateMfeflowProject, validateRegistryEntry, validateRegistryIndex };
+export { ANALYTICS_EVENT, COST_MODEL, DOCS_URL, ENV_KEY_NAME, EVENT_NAME, FEATURE_CONDITION, FEATURE_NAME, FILE_HASH, JSON_SCHEMAS, MAX_DESCRIPTION, MAX_INDEX_ITEMS, MFE_NAME, PROJECT_REPOS, REGISTRY_HOST, REGISTRY_ITEM_NAME, REGISTRY_NAMESPACE, ROUTE_OVERLAP, SCHEMA_ALIASES, SCHEMA_URLS, TRANSFORM_OPS, assetsFromManifest, errorDocsUrl, injectIntoHead, isFeatureManifest, isFeatureRegistryIndex, isLoopbackHttp, isMfeManifest, isMfeflowProject, isPortableRelativePath, isPrivateHost, isRegistryEntry, isRegistryIndex, isRegistryProtocol, isSafeRelativePath, judgeCost, judgeRemoteInitial, primaryExpose, redactUrl, redactUrlsIn, registryIndexUrl, registryInjection, registryTemplateProblem, remoteDistFiles, round1, routesOverlap, splitScripts, validateFeatureManifest, validateFeatureRegistryIndex, validateMfeManifest, validateMfeflowProject, validateRegistryEntry, validateRegistryIndex };

package/dist/project.d.ts

@@ -29,6 +29,11 @@ export interface MfeflowProject {
      * While the new version is that one, the file stays quiet; when it changes, the file is raised again.
      */
     kept?: Record<string, string>;
+    /**
+     * Keys `mfeflow add env-key` wrote, by the file it wrote them in. `upgrade` asks before a new
+     * template changes the value of one of them. Absent in projects made before this was recorded.
+     */
+    envKeys?: Record<string, string[]>;
     /** Third-party feature registries: `{ "@someone": "https://…/{name}.json" }`, https only (plain http for loopback hosts). `@mfeflow` is reserved. */
     registries?: Record<string, string>;
     /** Built mfeflow checkout, relative to the project root, that `@mfeflow/*` dependencies link to. Set by `--local` only. */
@@ -56,6 +61,8 @@ export interface ProjectBudget {
 }
 /** The regex form of `isCheckoutPath`, for JSON Schema. */
 export declare const CHECKOUT_PATH: RegExp;
+/** An env key name, as `mfeflow add env-key` accepts it. */
+export declare const ENV_KEY_NAME: RegExp;
 export declare const FILE_HASH: RegExp;
 export declare const REGISTRY_NAMESPACE: RegExp;
 /** A relative path with forward slashes whose only `..` segments come first, so it may leave the project. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mfeflow/contracts",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Types, validators and JSON Schemas for mfeflow: mfeflow.app.json ownership manifests, mfeflow.json project state, and the remote registry (entries and index).",
   "keywords": [
     "micro-frontend",