@flowatlas/markers 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Annotations for the few places static analysis cannot reach.
+ *
+ * Every marker is a no-op at run time: it exists so that the extractor can read
+ * it out of the source, and it must never change how the annotated code
+ * behaves. That is also why this package has no dependencies at all and does
+ * not use metadata reflection.
+ *
+ * Reach for a marker only where analysis is genuinely blind, such as a channel
+ * name that comes from configuration or a target URL built at run time.
+ * Annotating what can be derived produces documentation that rots.
+ */
+/** A decorator that does nothing, in either the standard or the legacy form. */
+export type MarkerDecorator = (...args: unknown[]) => void;
+export declare const MARKER_NAMES: readonly ['Emits', 'Consumes', 'CallsService', 'FlowEntry', 'ContractIgnore'];
+export type MarkerName = (typeof MARKER_NAMES)[number];
+export declare const isMarkerName: (value: string) => value is MarkerName;
+/**
+ * This method publishes to `channel`.
+ *
+ * For a channel name the analyser cannot follow, typically one read from
+ * configuration.
+ */
+export declare const Emits: (channel: string) => MarkerDecorator;
+/** This method receives from `channel`. */
+export declare const Consumes: (channel: string) => MarkerDecorator;
+/**
+ * This method calls another service.
+ *
+ * `route` is the method and path of the target, e.g. `POST /invoices`. For URLs
+ * assembled at run time.
+ */
+export declare const CallsService: (service: string, route: string) => MarkerDecorator;
+/** Names the flow this entry point starts, for reporting. */
+export declare const FlowEntry: (name: string) => MarkerDecorator;
+/** Contract drift here is intentional; report it, do not fail on it. */
+export declare const ContractIgnore: () => MarkerDecorator;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,gFAAgF;AAChF,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;AAI3D,eAAO,MAAM,YAAY,YACvB,OAAO,EACP,UAAU,EACV,cAAc,EACd,WAAW,EACX,gBAAgB,CACR,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,eAAO,MAAM,YAAY,UAAW,MAAM,KAAG,KAAK,IAAI,UACD,CAAC;AAEtD;;;;;GAKG;AACH,eAAO,MAAM,KAAK,YAAa,MAAM,KAAG,eAAuB,CAAC;AAEhE,2CAA2C;AAC3C,eAAO,MAAM,QAAQ,YAAa,MAAM,KAAG,eAAuB,CAAC;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,YAAY,YAAa,MAAM,SAAS,MAAM,KAAG,eAAuB,CAAC;AAEtF,6DAA6D;AAC7D,eAAO,MAAM,SAAS,SAAU,MAAM,KAAG,eAAuB,CAAC;AAEjE,wEAAwE;AACxE,eAAO,MAAM,cAAc,QAAO,eAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,42 @@
+/**
+ * Annotations for the few places static analysis cannot reach.
+ *
+ * Every marker is a no-op at run time: it exists so that the extractor can read
+ * it out of the source, and it must never change how the annotated code
+ * behaves. That is also why this package has no dependencies at all and does
+ * not use metadata reflection.
+ *
+ * Reach for a marker only where analysis is genuinely blind, such as a channel
+ * name that comes from configuration or a target URL built at run time.
+ * Annotating what can be derived produces documentation that rots.
+ */
+const noop = () => undefined;
+export const MARKER_NAMES = [
+    'Emits',
+    'Consumes',
+    'CallsService',
+    'FlowEntry',
+    'ContractIgnore',
+];
+export const isMarkerName = (value) => MARKER_NAMES.includes(value);
+/**
+ * This method publishes to `channel`.
+ *
+ * For a channel name the analyser cannot follow, typically one read from
+ * configuration.
+ */
+export const Emits = (channel) => noop;
+/** This method receives from `channel`. */
+export const Consumes = (channel) => noop;
+/**
+ * This method calls another service.
+ *
+ * `route` is the method and path of the target, e.g. `POST /invoices`. For URLs
+ * assembled at run time.
+ */
+export const CallsService = (service, route) => noop;
+/** Names the flow this entry point starts, for reporting. */
+export const FlowEntry = (name) => noop;
+/** Contract drift here is intentional; report it, do not fail on it. */
+export const ContractIgnore = () => noop;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAKH,MAAM,IAAI,GAAoB,GAAG,EAAE,CAAC,SAAS,CAAC;AAE9C,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO;IACP,UAAU;IACV,cAAc;IACd,WAAW;IACX,gBAAgB;CACR,CAAC;AAIX,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAa,EAAuB,EAAE,CAChE,YAAkC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,OAAe,EAAmB,EAAE,CAAC,IAAI,CAAC;AAEhE,2CAA2C;AAC3C,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,OAAe,EAAmB,EAAE,CAAC,IAAI,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAe,EAAE,KAAa,EAAmB,EAAE,CAAC,IAAI,CAAC;AAEtF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAY,EAAmB,EAAE,CAAC,IAAI,CAAC;AAEjE,wEAAwE;AACxE,MAAM,CAAC,MAAM,cAAc,GAAG,GAAoB,EAAE,CAAC,IAAI,CAAC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@flowatlas/markers",
+  "version": "0.1.0",
+  "description": "Annotations that tell flowatlas what static reading cannot work out.",
+  "license": "MIT",
+  "author": {
+    "name": "Ruslan Panevschi",
+    "url": "https://github.com/Panevschi-Ruslan"
+  },
+  "homepage": "https://github.com/Panevschi-Ruslan/flowatlas#readme",
+  "bugs": {
+    "url": "https://github.com/Panevschi-Ruslan/flowatlas/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Panevschi-Ruslan/flowatlas.git",
+    "directory": "packages/markers"
+  },
+  "keywords": [
+    "monorepo",
+    "polyrepo",
+    "static-analysis",
+    "dependency-graph",
+    "typescript",
+    "nestjs",
+    "angular",
+    "mcp",
+    "architecture"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "vitest run --passWithNoTests"
+  }
+}