@mfeflow/contracts 0.1.0 → 0.2.0

package/dist/feature.d.ts

@@ -21,9 +21,17 @@ export interface FeaturePrompt {
     choices?: string[];
 }
 export interface FeatureFile {
-    /** Destination, relative to the target. */
+    /**
+     * Destination, relative to the target. `{{app.name}}` and the other template values are filled
+     * in per app, so a feature can write one file for each remote.
+     */
     to: string;
     target?: FeatureTarget;
+    /**
+     * Resolve `to` from the project root instead of the target app, for a file about the app that
+     * lives elsewhere, like `packages/contracts/src/routes/{{app.name}}.ts`. First-party only.
+     */
+    atRoot?: boolean;
     when?: FeatureCondition;
     /** Source file inside a local feature folder. Remote features cannot use it. */
     from?: string;
@@ -33,6 +41,7 @@ export interface FeatureFile {
     template?: boolean;
 }
 export interface FeatureDependency {
+    /** An npm package name. `{{scope}}/contracts` is the project's own package of that name. */
     name: string;
     range: string;
     dev?: boolean;
@@ -168,6 +177,10 @@ export declare const ENV_KEY: RegExp;
 export declare const JOB_ID: RegExp;
 export declare const SCRIPT_NAME: RegExp;
 export declare const PACKAGE: RegExp;
+/** A package in the project's own scope: `{{scope}}/contracts`. */
+export declare const SCOPED_PACKAGE: RegExp;
+/** What a first-party dependency name may be, for the JSON schema. */
+export declare const DEPENDENCY_NAME: RegExp;
 export declare function validateFeatureManifest(value: unknown): Issue[];
 export declare function isFeatureManifest(value: unknown): value is FeatureManifest;
 export {};

package/dist/index.js

@@ -81,7 +81,7 @@ function isSafeRelativePath(value) {
 const MFE_NAME = /^[a-z][a-z0-9]*(?:_[a-z][a-z0-9]*)*$/;
 const ROUTE = /^\/[A-Za-z0-9/_:*.-]*$/;
 const EXPOSE = /^\.\/[A-Za-z0-9_/-]+$/;
-const EVENT_NAME = /^[a-z][a-z0-9-]*\.[a-z][a-z0-9_]*@[0-9]+$/;
+const EVENT_NAME = /^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+\.v[1-9][0-9]*$/;
 const ANALYTICS_EVENT = /^[a-z][a-z0-9]*(_[a-z0-9]+)+$/;
 function validateMfeManifest(value) {
     const c = new Checker();
@@ -114,11 +114,11 @@ function validateMfeManifest(value) {
     if (events) {
         c.stringArray(events, 'publishes', 'events', {
             pattern: EVENT_NAME,
-            hint: 'must look like "cart.item_added@1"'
+            hint: 'must look like "cart.item-added.v1"'
         });
         c.stringArray(events, 'consumes', 'events', {
             pattern: EVENT_NAME,
-            hint: 'must look like "cart.item_added@1"'
+            hint: 'must look like "cart.item-added.v1"'
         });
     }
     c.stringArray(value, 'analyticsEvents', '', {
@@ -597,6 +597,8 @@ const ENV_KEY = /^[A-Za-z_][A-Za-z0-9_]*$/;
 const JOB_ID = /^[A-Za-z_][A-Za-z0-9_-]*$/;
 const SCRIPT_NAME = /^[A-Za-z0-9:_.-]+$/;
 const PACKAGE = /^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/;
+const SCOPED_PACKAGE = /^\{\{scope\}\}\/[a-z0-9-~][a-z0-9-._~]*$/;
+const DEPENDENCY_NAME = new RegExp(`${PACKAGE.source}|${SCOPED_PACKAGE.source}`);
 function isTransformOp(op) {
     return TRANSFORM_OPS.some((name)=>name === op);
 }
@@ -825,11 +827,12 @@ function validateFeatureManifest(value) {
         c.string(f, 'content', at, {
             required: false
         });
+        if (void 0 !== f.atRoot && 'boolean' != typeof f.atRoot) c.add(`${at}.atRoot`, 'must be true or false');
         if ('string' == typeof f.from && !isSafeRelativePath(f.from)) c.add(`${at}.from`, 'must be a relative path with forward slashes and no ".."');
         if (void 0 === f.from === (void 0 === f.content)) c.add(at, 'needs exactly one of from or content');
     });
     eachObject(c, value, 'dependencies', (d, at)=>{
-        c.string(d, 'name', at, {
+        if ('string' != typeof d.name || !SCOPED_PACKAGE.test(d.name)) c.string(d, 'name', at, {
             pattern: PACKAGE,
             hint: 'must be an npm package name'
         });
@@ -1296,6 +1299,9 @@ const JSON_SCHEMAS = {
                         content: str(),
                         template: {
                             type: 'boolean'
+                        },
+                        atRoot: {
+                            type: 'boolean'
                         }
                     }, [
                         'to'
@@ -1317,7 +1323,7 @@ const JSON_SCHEMAS = {
             dependencies: {
                 type: 'array',
                 items: json_schema_item({
-                    name: str(PACKAGE),
+                    name: str(DEPENDENCY_NAME),
                     range: str(),
                     dev: {
                         type: 'boolean'

package/dist/mfe-manifest.d.ts

@@ -34,7 +34,7 @@ export interface MfeManifest {
 export declare const MFE_NAME: RegExp;
 export declare const ROUTE: RegExp;
 export declare const EXPOSE: RegExp;
-/** `<domain>.<event>@<major>`, e.g. `cart.item_added@1`. */
+/** `<domain>.<event>.v<major>`, e.g. `cart.item-added.v1`. The same pattern `@mfeflow/event-bus` checks names against. */
 export declare const EVENT_NAME: RegExp;
 /** `<domain>_<object>_<action>`, e.g. `checkout_order_completed`. */
 export declare const ANALYTICS_EVENT: RegExp;

package/package.json

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