@cratis/showrunner.notes 0.0.0-stage → 1.15.0

package/Availability/NotesAvailability.ts

@@ -0,0 +1,59 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Availability.NotesAvailability, Cratis.Showrunner.Notes.Availability.NotesAvailability. Time: 2026-11-01T11:55:12.6707473Z. Hash: 7D28D58AEA837A3CBE5F66D04986F5BD5F4F7F950F141F37B794A04B3F6A7781
+import { QueryFor, QueryResultWithState } from '@cratis/arc/queries';
+import { PerformQuery, QueryWhen, SetSorting, useQuery, useSuspenseQuery } from '@cratis/arc.react/queries';
+import { SliceLocation as ArcSliceLocation, ParameterDescriptor } from '@cratis/arc/reflection';
+import { field } from '@cratis/fundamentals';
+
+/**
+ * Gets whether Notes is switched on. It is the same answer for everyone, so it needs no sign-in: the button shows only to a signed-in user anyway, and the commands refuse everyone else.
+ */
+export class Availability extends QueryFor<NotesAvailability> {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', '', 'Availability');
+    readonly route: string = '/api/availability/availability';
+    readonly queryName: string = 'Cratis.Showrunner.Notes.Availability.NotesAvailability.Availability';
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly defaultValue: NotesAvailability = {} as NotesAvailability;
+
+    constructor() {
+        super(NotesAvailability, false);
+    }
+
+    get requiredRequestParameters(): string[] {
+        return [
+        ];
+    }
+
+    readonly parameterDescriptors: ParameterDescriptor[] = [
+    ];
+
+
+
+    static use(): [QueryResultWithState<NotesAvailability>, PerformQuery, SetSorting] {
+        return useQuery<NotesAvailability, Availability>(Availability);
+    }
+
+    static useSuspense(): [QueryResultWithState<NotesAvailability>, PerformQuery, SetSorting] {
+        return useSuspenseQuery<NotesAvailability, Availability>(Availability);
+    }
+
+    static when(condition: boolean): QueryWhen<Availability, NotesAvailability> {
+        return new QueryWhen<Availability, NotesAvailability>(Availability, condition);
+    }
+}
+
+/**
+ * Whether Notes is switched on in the application. The feedback button renders only when it is.
+ */
+export class NotesAvailability {
+
+    /**
+     * Whether the host switched Notes on.
+     */
+    @field(Boolean)
+    isEnabled!: boolean;
+}

package/Availability/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './NotesAvailability';

package/Contracts/Components/PickedComponent.ts

@@ -0,0 +1,43 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Contracts.Components.PickedComponent. Time: 2026-11-01T11:55:12.6707473Z. Hash: 1484D58438C3413660D1408770158347E122D60D2A211159F2CFD174E08DC02D
+import { field } from '@cratis/fundamentals';
+import { SliceLocation } from '../Reporting/SliceLocation';
+
+/**
+ * A component of the application the user picked on screen.
+ */
+export class PickedComponent {
+
+    /**
+     * The name of the component.
+     */
+    @field(String)
+    componentName!: string;
+
+    /**
+     * The id of the component.
+     */
+    @field(String)
+    componentId!: string;
+
+    /**
+     * The part of the component that was picked, {@link NotSet} for the component as a whole.
+     */
+    @field(String)
+    part!: string;
+
+    /**
+     * The components it sits in, nearest first; may be empty.
+     */
+    @field(String, true)
+    ancestors!: string[];
+
+    /**
+     * Where in the application the component is.
+     */
+    @field(SliceLocation)
+    location!: SliceLocation;
+}

package/Contracts/Components/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './PickedComponent';

package/Contracts/Context/NoteContext.ts

@@ -0,0 +1,58 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Contracts.Context.NoteContext. Time: 2026-11-01T11:55:12.6707473Z. Hash: 61C44AE2973F0F83AD9805D4F944BBF66B38C5927BCB9C7C3178B7B02E06AEBD
+import { field } from '@cratis/fundamentals';
+import { Guid } from '@cratis/fundamentals';
+import { NoteDialog } from './NoteDialog';
+import { NoteScreen } from './NoteScreen';
+import { SliceLocation } from '../Reporting/SliceLocation';
+
+/**
+ * What the user was looking at when they gave a note.
+ */
+export class NoteContext {
+
+    /**
+     * Where in the application the user was: the module, feature and slice Arc resolves for what is on screen.
+     */
+    @field(SliceLocation)
+    location!: SliceLocation;
+
+    /**
+     * Every slice active on the screen; may be empty.
+     */
+    @field(SliceLocation, true)
+    activeSlices!: SliceLocation[];
+
+    /**
+     * The screen.
+     */
+    @field(NoteScreen)
+    screen!: NoteScreen;
+
+    /**
+     * The route.
+     */
+    @field(String)
+    route!: string;
+
+    /**
+     * The open dialog, {@link NoDialog} when none was open.
+     */
+    @field(NoteDialog)
+    dialog!: NoteDialog;
+
+    /**
+     * Identifiers of model elements, supplied by the host and keyed by what they identify; may be empty.
+     */
+    @field(Object)
+    modelReferences!: Record<string, string>;
+
+    /**
+     * The correlation id of the command or query that ran last in the user's view, when there is one.
+     */
+    @field(Guid)
+    correlationId!: Guid;
+}

package/Contracts/Context/NoteDialog.ts

@@ -0,0 +1,25 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Contracts.Context.NoteDialog. Time: 2026-11-01T11:55:12.6707473Z. Hash: 9140B1D933F084E2FC5D240013C56A3D3078A8CE41E4C61A5A4C0141FC797623
+import { field } from '@cratis/fundamentals';
+import { SliceLocation } from '../Reporting/SliceLocation';
+
+/**
+ * The dialog that was open when the user gave a note.
+ */
+export class NoteDialog {
+
+    /**
+     * The title of the dialog.
+     */
+    @field(String)
+    dialogTitle!: string;
+
+    /**
+     * Where in the application the dialog belongs, as Arc resolves it.
+     */
+    @field(SliceLocation)
+    location!: SliceLocation;
+}

package/Contracts/Context/NoteScreen.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Contracts.Context.NoteScreen. Time: 2026-11-01T11:55:12.6707473Z. Hash: 5864932E6D5109B38EFB7E94156AD2AD1170E53EDD900F02C64FCAAB71D19EAA
+import { field } from '@cratis/fundamentals';
+
+/**
+ * The screen the user was on when they gave a note.
+ */
+export class NoteScreen {
+
+    /**
+     * The id of the screen.
+     */
+    @field(String)
+    screenId!: string;
+
+    /**
+     * The name of the screen.
+     */
+    @field(String)
+    screenName!: string;
+
+    /**
+     * The path of the screen.
+     */
+    @field(String)
+    screenPath!: string;
+}

package/Contracts/Context/index.ts

@@ -0,0 +1,6 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './NoteContext';
+export * from './NoteDialog';
+export * from './NoteScreen';

package/Contracts/Giving/NoteKind.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Contracts.Giving.NoteKind. Time: 2026-11-01T11:55:12.6707473Z. Hash: 15D6EB3573A54ADE49BD4014FDE1173E8F4F5B91DCA9BE625F2CEEB23A430007
+/**
+ * What kind of feedback a note is.
+ */
+export enum NoteKind {
+    problem = 0,
+    suggestion = 1,
+    question = 2,
+    praise = 3,
+}

package/Contracts/Giving/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './NoteKind';

package/Contracts/Reporting/SliceLocation.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Usher.Contracts.Reporting.SliceLocation. Time: 2026-11-01T11:55:12.6707473Z. Hash: 43F1EEEB0FFCB772AA0F2633DFF9FAC94AADE89AB1858F453B61A86B87327956
+import { field } from '@cratis/fundamentals';
+
+/**
+ * Where in the application an issue happened, as the module, feature and slice Arc resolves - on the backend from the executing command or query, in the frontend from the component hierarchy. A part Arc cannot resolve is `NotSet`, never absent.
+ */
+export class SliceLocation {
+
+    /**
+     * The module.
+     */
+    @field(String)
+    module!: string;
+
+    /**
+     * The feature within the module.
+     */
+    @field(String)
+    feature!: string;
+
+    /**
+     * The slice within the feature.
+     */
+    @field(String)
+    slice!: string;
+}

package/Contracts/Reporting/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './SliceLocation';

package/Giving/GiveNoteOnComponent/GiveNoteOnComponent.ts

@@ -0,0 +1,146 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Giving.GiveNoteOnComponent.GiveNoteOnComponent. Time: 2026-11-01T11:55:12.6707473Z. Hash: A44F5BE208BFB2B1A5C292EA13726509BA682B5935BC2C6C19AC7C32CBB5911D
+import { Command, CommandValidator } from '@cratis/arc/commands';
+import { ClearCommandValues, SetCommandValues, useCommand } from '@cratis/arc.react/commands';
+import { SliceLocation as ArcSliceLocation, PropertyDescriptor } from '@cratis/arc/reflection';
+import { PickedComponent } from '../../Contracts/Components/PickedComponent';
+import { NoteContext } from '../../Contracts/Context/NoteContext';
+import { NoteKind } from '../../Contracts/Giving/NoteKind';
+import { Guid } from '@cratis/fundamentals';
+
+/**
+ * The user picked a component and wrote text about it. The property changes they suggested in the same picking session share its note id. Who gives it is taken from the signed-in identity, never from the request.
+ */
+export interface IGiveNoteOnComponent {
+
+    /**
+     * The component the user picked.
+     */
+    component?: PickedComponent;
+
+    /**
+     * What the user is looking at.
+     */
+    context?: NoteContext;
+
+    /**
+     * What kind of feedback it is.
+     */
+    kind?: NoteKind;
+
+    /**
+     * The id of the note: new, or the one the picking session's property changes were suggested on.
+     */
+    noteId?: Guid;
+
+    /**
+     * What the user writes.
+     */
+    text?: string;
+}
+
+export class GiveNoteOnComponentValidator extends CommandValidator<IGiveNoteOnComponent> {
+    constructor() {
+        super();
+        this.ruleFor(c => c.component).notNull().withMessage('Pick a component.');
+        this.ruleFor(c => c.context).notNull().withMessage('A note needs to know what you were looking at.');
+        this.ruleFor(c => c.text).notEmpty().withMessage('Write your note.');
+        this.ruleFor(c => c.text).maxLength(4000).withMessage('Keep the note within 4000 characters.');
+    }
+}
+
+/**
+ * The user picked a component and wrote text about it. The property changes they suggested in the same picking session share its note id. Who gives it is taken from the signed-in identity, never from the request.
+ */
+export class GiveNoteOnComponent extends Command<IGiveNoteOnComponent> implements IGiveNoteOnComponent {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', 'Giving', 'GiveNoteOnComponent');
+    readonly route: string = '/api/giving/give-note-on-component';
+    readonly validation: CommandValidator = new GiveNoteOnComponentValidator();
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly propertyDescriptors: PropertyDescriptor[] = [
+        new PropertyDescriptor('component', PickedComponent, false),
+        new PropertyDescriptor('context', NoteContext, false),
+        new PropertyDescriptor('kind', Number, false),
+        new PropertyDescriptor('noteId', Guid, false),
+        new PropertyDescriptor('text', String, false),
+    ];
+
+    #component!: PickedComponent;
+    #context!: NoteContext;
+    #kind!: NoteKind;
+    #noteId!: Guid;
+    #text!: string;
+
+    constructor() {
+        super(Object, false);
+    }
+
+    get requestParameters(): string[] {
+        return [
+        ];
+    }
+
+    /**
+     * The component the user picked.
+     */
+    get component(): PickedComponent {
+        return this.#component;
+    }
+
+    set component(value: PickedComponent) {
+        this.#component = value;
+        this.propertyChanged('component');
+    }
+    /**
+     * What the user is looking at.
+     */
+    get context(): NoteContext {
+        return this.#context;
+    }
+
+    set context(value: NoteContext) {
+        this.#context = value;
+        this.propertyChanged('context');
+    }
+    /**
+     * What kind of feedback it is.
+     */
+    get kind(): NoteKind {
+        return this.#kind;
+    }
+
+    set kind(value: NoteKind) {
+        this.#kind = value;
+        this.propertyChanged('kind');
+    }
+    /**
+     * The id of the note: new, or the one the picking session's property changes were suggested on.
+     */
+    get noteId(): Guid {
+        return this.#noteId;
+    }
+
+    set noteId(value: Guid) {
+        this.#noteId = value;
+        this.propertyChanged('noteId');
+    }
+    /**
+     * What the user writes.
+     */
+    get text(): string {
+        return this.#text;
+    }
+
+    set text(value: string) {
+        this.#text = value;
+        this.propertyChanged('text');
+    }
+
+    static use(initialValues?: IGiveNoteOnComponent): [GiveNoteOnComponent, SetCommandValues<IGiveNoteOnComponent>, ClearCommandValues] {
+        return useCommand<GiveNoteOnComponent, IGiveNoteOnComponent>(GiveNoteOnComponent, initialValues);
+    }
+}

package/Giving/GiveNoteOnComponent/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './GiveNoteOnComponent';

package/Giving/GiveNoteOnContext/GiveNoteOnContext.ts

@@ -0,0 +1,126 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.Notes.Giving.GiveNoteOnContext.GiveNoteOnContext. Time: 2026-11-01T11:55:12.6707473Z. Hash: E16E92B294B3749B22A6EE3710E363A25997107CB34220EBC09AF9CE22B3EB6A
+import { Command, CommandValidator } from '@cratis/arc/commands';
+import { ClearCommandValues, SetCommandValues, useCommand } from '@cratis/arc.react/commands';
+import { SliceLocation as ArcSliceLocation, PropertyDescriptor } from '@cratis/arc/reflection';
+import { NoteContext } from '../../Contracts/Context/NoteContext';
+import { NoteKind } from '../../Contracts/Giving/NoteKind';
+import { Guid } from '@cratis/fundamentals';
+
+/**
+ * The user gives feedback about what is on screen now: the default action of the feedback button. Who gives it is taken from the signed-in identity, never from the request.
+ */
+export interface IGiveNoteOnContext {
+
+    /**
+     * What the user is looking at.
+     */
+    context?: NoteContext;
+
+    /**
+     * What kind of feedback it is.
+     */
+    kind?: NoteKind;
+
+    /**
+     * The id of the new note, chosen by the caller so a retried command does not give a second note.
+     */
+    noteId?: Guid;
+
+    /**
+     * What the user writes.
+     */
+    text?: string;
+}
+
+export class GiveNoteOnContextValidator extends CommandValidator<IGiveNoteOnContext> {
+    constructor() {
+        super();
+        this.ruleFor(c => c.context).notNull().withMessage('A note needs to know what you were looking at.');
+        this.ruleFor(c => c.text).notEmpty().withMessage('Write your note.');
+        this.ruleFor(c => c.text).maxLength(4000).withMessage('Keep the note within 4000 characters.');
+    }
+}
+
+/**
+ * The user gives feedback about what is on screen now: the default action of the feedback button. Who gives it is taken from the signed-in identity, never from the request.
+ */
+export class GiveNoteOnContext extends Command<IGiveNoteOnContext> implements IGiveNoteOnContext {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', 'Giving', 'GiveNoteOnContext');
+    readonly route: string = '/api/giving/give-note-on-context';
+    readonly validation: CommandValidator = new GiveNoteOnContextValidator();
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly propertyDescriptors: PropertyDescriptor[] = [
+        new PropertyDescriptor('context', NoteContext, false),
+        new PropertyDescriptor('kind', Number, false),
+        new PropertyDescriptor('noteId', Guid, false),
+        new PropertyDescriptor('text', String, false),
+    ];
+
+    #context!: NoteContext;
+    #kind!: NoteKind;
+    #noteId!: Guid;
+    #text!: string;
+
+    constructor() {
+        super(Object, false);
+    }
+
+    get requestParameters(): string[] {
+        return [
+        ];
+    }
+
+    /**
+     * What the user is looking at.
+     */
+    get context(): NoteContext {
+        return this.#context;
+    }
+
+    set context(value: NoteContext) {
+        this.#context = value;
+        this.propertyChanged('context');
+    }
+    /**
+     * What kind of feedback it is.
+     */
+    get kind(): NoteKind {
+        return this.#kind;
+    }
+
+    set kind(value: NoteKind) {
+        this.#kind = value;
+        this.propertyChanged('kind');
+    }
+    /**
+     * The id of the new note, chosen by the caller so a retried command does not give a second note.
+     */
+    get noteId(): Guid {
+        return this.#noteId;
+    }
+
+    set noteId(value: Guid) {
+        this.#noteId = value;
+        this.propertyChanged('noteId');
+    }
+    /**
+     * What the user writes.
+     */
+    get text(): string {
+        return this.#text;
+    }
+
+    set text(value: string) {
+        this.#text = value;
+        this.propertyChanged('text');
+    }
+
+    static use(initialValues?: IGiveNoteOnContext): [GiveNoteOnContext, SetCommandValues<IGiveNoteOnContext>, ClearCommandValues] {
+        return useCommand<GiveNoteOnContext, IGiveNoteOnContext>(GiveNoteOnContext, initialValues);
+    }
+}

package/Giving/GiveNoteOnContext/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './GiveNoteOnContext';