@living-architecture/riviere-schema-published-language 0.9.0

package/dist/published-language/schema.d.ts

@@ -0,0 +1,185 @@
+/** @riviere-role published-language-data-structure */
+export interface SourceLocation {
+    repository: string;
+    filePath: string;
+    lineNumber?: number;
+    columnNumber?: number;
+    endLineNumber?: number;
+    methodName?: string;
+    url?: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface OperationParameter {
+    name: string;
+    type: string;
+    description?: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface OperationSignature {
+    parameters?: OperationParameter[];
+    returnType?: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface OperationBehavior {
+    reads?: string[];
+    validates?: string[];
+    modifies?: string[];
+    emits?: string[];
+}
+/** @riviere-role published-language-data-structure */
+export interface StateTransition {
+    from: string;
+    to: string;
+    trigger?: string;
+}
+/** @riviere-role published-language-union */
+export type ComponentType = 'UI' | 'API' | 'UseCase' | 'DomainOp' | 'Event' | 'EventHandler' | 'Custom';
+interface ComponentBase {
+    id: string;
+    name: string;
+    domain: string;
+    module: string;
+    description?: string;
+    sourceLocation: SourceLocation;
+}
+/** @riviere-role published-language-data-structure */
+export interface UIComponent extends ComponentBase {
+    type: 'UI';
+    route: string;
+}
+/** @riviere-role published-language-union */
+export type ApiType = 'REST' | 'GraphQL' | 'other';
+/** @riviere-role published-language-union */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+/** @riviere-role published-language-data-structure */
+export interface APIComponent extends ComponentBase {
+    type: 'API';
+    apiType: ApiType;
+    httpMethod?: HttpMethod;
+    path?: string;
+    operationName?: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface UseCaseComponent extends ComponentBase {
+    type: 'UseCase';
+}
+/** @riviere-role published-language-data-structure */
+export interface DomainOpComponent extends ComponentBase {
+    type: 'DomainOp';
+    operationName: string;
+    entity?: string;
+    signature?: OperationSignature;
+    behavior?: OperationBehavior;
+    stateChanges?: StateTransition[];
+    businessRules?: string[];
+}
+/** Metadata field name on EventComponent holding the event's canonical name. */
+/** @riviere-role published-language-field-name */
+export declare const EVENT_NAME_FIELD: "eventName";
+/** Metadata field name on EventHandlerComponent holding the list of subscribed event names. */
+/** @riviere-role published-language-field-name */
+export declare const SUBSCRIBED_EVENTS_FIELD: "subscribedEvents";
+/** @riviere-role published-language-data-structure */
+export interface EventComponent extends ComponentBase {
+    type: 'Event';
+    eventName: string;
+    eventSchema?: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface EventHandlerComponent extends ComponentBase {
+    type: 'EventHandler';
+    subscribedEvents: string[];
+}
+/** @riviere-role published-language-data-structure */
+export interface CustomComponent extends ComponentBase {
+    type: 'Custom';
+    customTypeName: string;
+    [key: string]: unknown;
+}
+/** @riviere-role published-language-union */
+export type Component = UIComponent | APIComponent | UseCaseComponent | DomainOpComponent | EventComponent | EventHandlerComponent | CustomComponent;
+/** @riviere-role published-language-union */
+export type LinkType = 'sync' | 'async';
+/** @riviere-role published-language-data-structure */
+export interface PayloadDefinition {
+    type?: string;
+    schema?: Record<string, unknown>;
+}
+/** @riviere-role published-language-data-structure */
+export interface Link {
+    id?: string;
+    source: string;
+    target: string;
+    type?: LinkType;
+    relationshipType?: string;
+    condition?: string;
+    payload?: PayloadDefinition;
+    sourceLocation?: SourceLocation;
+}
+/** @riviere-role published-language-data-structure */
+export interface ExternalTarget {
+    name: string;
+    route?: string;
+    domain?: string;
+    repository?: string;
+    url?: string;
+    [key: string]: string | undefined;
+}
+/** @riviere-role published-language-data-structure */
+export interface ExternalLink {
+    id?: string;
+    source: string;
+    target: ExternalTarget;
+    type?: LinkType;
+    description?: string;
+    sourceLocation?: SourceLocation;
+}
+/** @riviere-role published-language-union */
+export type SystemType = 'domain' | 'bff' | 'ui' | 'external-service' | 'other';
+/** @riviere-role published-language-data-structure */
+export interface DomainMetadata {
+    description: string;
+    systemType: SystemType;
+}
+/** @riviere-role published-language-data-structure */
+export interface CustomPropertyDefinition {
+    type: CustomPropertyTypeName;
+    description?: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface CustomTypeDefinition {
+    description?: string;
+    requiredProperties?: Record<string, CustomPropertyDefinition>;
+    optionalProperties?: Record<string, CustomPropertyDefinition>;
+}
+/** @riviere-role published-language-data-structure */
+export interface RelationshipTypeDefinition {
+    description: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface SourceInfo {
+    repository: string;
+    commit?: string;
+    extractedAt?: string;
+}
+/** @riviere-role published-language-data-structure */
+export interface GraphMetadata {
+    name?: string;
+    description?: string;
+    generated?: string;
+    sources?: SourceInfo[];
+    domains: Record<string, DomainMetadata>;
+    customTypes?: Record<string, CustomTypeDefinition>;
+    relationshipTypes?: Record<string, RelationshipTypeDefinition>;
+}
+/** @riviere-role published-language-schema */
+export interface RiviereGraph {
+    version: string;
+    metadata: GraphMetadata;
+    components: Component[];
+    links: Link[];
+    externalLinks?: ExternalLink[];
+}
+import type { CustomPropertyTypeName } from './custom-property-type';
+export {};
+//# sourceMappingURL=schema.d.ts.map

package/dist/published-language/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/published-language/schema.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,sDAAsD;AACtD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,sDAAsD;AACtD,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAA;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,sDAAsD;AACtD,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,6CAA6C;AAC7C,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,KAAK,GACL,SAAS,GACT,UAAU,GACV,OAAO,GACP,cAAc,GACd,QAAQ,CAAA;AAEZ,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;CAC/B;AAED,sDAAsD;AACtD,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAED,6CAA6C;AAC7C,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;AAClD,6CAA6C;AAC7C,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;AAEzF,sDAAsD;AACtD,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,IAAI,EAAE,KAAK,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,sDAAsD;AACtD,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,sDAAsD;AACtD,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,IAAI,EAAE,UAAU,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,YAAY,CAAC,EAAE,eAAe,EAAE,CAAA;IAChC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB;AAED,gFAAgF;AAChF,kDAAkD;AAClD,eAAO,MAAM,gBAAgB,EAAG,WAAoB,CAAA;AAEpD,+FAA+F;AAC/F,kDAAkD;AAClD,eAAO,MAAM,uBAAuB,EAAG,kBAA2B,CAAA;AAElE,sDAAsD;AACtD,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,sDAAsD;AACtD,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,IAAI,EAAE,cAAc,CAAA;IACpB,gBAAgB,EAAE,MAAM,EAAE,CAAA;CAC3B;AAED,sDAAsD;AACtD,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,IAAI,EAAE,QAAQ,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,6CAA6C;AAC7C,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,YAAY,GACZ,gBAAgB,GAChB,iBAAiB,GACjB,cAAc,GACd,qBAAqB,GACrB,eAAe,CAAA;AAEnB,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAA;AAEvC,sDAAsD;AACtD,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED,sDAAsD;AACtD,MAAM,WAAW,IAAI;IACnB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,QAAQ,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,iBAAiB,CAAA;IAC3B,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAClC;AAED,sDAAsD;AACtD,MAAM,WAAW,YAAY;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,cAAc,CAAA;IACtB,IAAI,CAAC,EAAE,QAAQ,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,6CAA6C;AAC7C,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,KAAK,GAAG,IAAI,GAAG,kBAAkB,GAAG,OAAO,CAAA;AAE/E,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,sDAAsD;AACtD,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,sBAAsB,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,sDAAsD;AACtD,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAA;IAC7D,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAA;CAC9D;AAED,sDAAsD;AACtD,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,sDAAsD;AACtD,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,sDAAsD;AACtD,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAA;IACtB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;IAClD,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;CAC/D;AAED,8CAA8C;AAC9C,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,aAAa,CAAA;IACvB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;CAC/B;AACD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/published-language/schema.js

@@ -0,0 +1,7 @@
+// src/published-language/schema.ts
+var EVENT_NAME_FIELD = "eventName";
+var SUBSCRIBED_EVENTS_FIELD = "subscribedEvents";
+export {
+  EVENT_NAME_FIELD,
+  SUBSCRIBED_EVENTS_FIELD
+};

package/dist/published-language/validation.d.ts

@@ -0,0 +1,10 @@
+import type { RiviereGraph } from './schema';
+/** @riviere-role published-language-parser */
+export declare function parseRiviereGraph(value: unknown): {
+    success: true;
+    graph: RiviereGraph;
+} | {
+    success: false;
+    issues: string[];
+};
+//# sourceMappingURL=validation.d.ts.map

package/dist/published-language/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/published-language/validation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAQ5C,8CAA8C;AAC9C,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,GACb;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAU/E"}