@cratis/showrunner.usher 0.0.0-bootstrap.0

package/Errors/errorDetailsFromQueryResult.ts

@@ -0,0 +1,32 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { QueryResult } from '@cratis/arc/queries';
+import { SliceLocation as ArcSliceLocation } from '@cratis/arc/reflection';
+import { Guid } from '@cratis/fundamentals';
+import { ErrorDetails } from './ErrorDetails';
+import { messageOf } from './messageOf';
+import { parseStackTrace } from './parseStackTrace';
+import { resolveLocation } from './resolveLocation';
+
+/**
+ * Builds {@link ErrorDetails} from the result of a failed Arc query.
+ * @remarks
+ * A query result carries no correlation id, so pass the one you know, if any. The stack frames are parsed from the
+ * stack trace Arc returns, and the type is empty, because Arc does not return the .NET type.
+ * @param result The result of the failed query, a {@link QueryResult} or the result of a query hook.
+ * @param query The failing query, whose generated proxy declares where it lives.
+ * @param location Where it happened when the query's proxy declares nothing, such as the location from
+ * `useSliceContext()`.
+ * @param correlationId The correlation id of the query, when known.
+ * @returns The {@link ErrorDetails}.
+ */
+export function errorDetailsFromQueryResult(result: Pick<QueryResult<unknown>, 'exceptionMessages' | 'exceptionStackTrace' | 'validationResults'>, query?: object, location?: ArcSliceLocation, correlationId?: Guid): ErrorDetails {
+    return {
+        message: messageOf(result.exceptionMessages, '', result.validationResults),
+        type: '',
+        correlationIds: correlationId ? [correlationId] : [],
+        stackFrames: parseStackTrace(result.exceptionStackTrace),
+        location: resolveLocation(query, location)
+    };
+}

package/Errors/index.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './ErrorDetails';
+export * from './errorDetailsFromCommandResult';
+export * from './errorDetailsFromError';
+export * from './errorDetailsFromQueryResult';
+export * from './parseStackTrace';
+export * from './resolveLocation';

package/Errors/messageOf.ts

@@ -0,0 +1,24 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ValidationResult } from '@cratis/arc/validation';
+
+/**
+ * Gets the message of a failed command or query result: its exception messages, otherwise the reason it was not
+ * authorized, otherwise its validation messages, joined with new lines.
+ * @param exceptionMessages The exception messages.
+ * @param authorizationFailureReason The reason it was not authorized; empty when it was.
+ * @param validationResults The validation results.
+ * @returns The message; empty when the result carries none.
+ */
+export function messageOf(exceptionMessages: string[], authorizationFailureReason: string, validationResults: ValidationResult[]): string {
+    if (exceptionMessages.length > 0) {
+        return exceptionMessages.join('\n');
+    }
+
+    if (authorizationFailureReason) {
+        return authorizationFailureReason;
+    }
+
+    return validationResults.map(result => result.message).join('\n');
+}

package/Errors/parseStackTrace.ts

@@ -0,0 +1,62 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { StackFrame } from '../Contracts/Reporting/StackFrame';
+
+const dotNetFrame = /^\s*at\s+(.+?)(?:\s+in\s+(.+):line\s+(\d+))?\s*$/;
+const v8FrameWithMethod = /^\s*at\s+(?:async\s+)?(.+?)\s+\((.+?):(\d+)(?::\d+)?\)\s*$/;
+const v8FrameWithoutMethod = /^\s*at\s+(?:async\s+)?(.+?):(\d+)(?::\d+)?\s*$/;
+const geckoFrame = /^\s*(.*?)@(.+?):(\d+)(?::\d+)?\s*$/;
+
+/**
+ * Parses a stack trace into stack frames, top frame first.
+ * @remarks
+ * Understands the stack of a JavaScript error in Chromium, Node.js, Firefox and Safari, and the .NET stack trace Arc
+ * returns for a failing command or query (\`at Type.Method() in File.cs:line 42\`). Lines that are not frames, such
+ * as the message line or \`--- End of stack trace from previous location ---\`, are skipped. A frame without a file
+ * or line has an empty file and line 0.
+ * @param stackTrace The stack trace; nothing gives no frames.
+ * @returns The stack frames.
+ */
+export function parseStackTrace(stackTrace?: string): StackFrame[] {
+    if (!stackTrace) {
+        return [];
+    }
+
+    return stackTrace
+        .split(/\r?\n/)
+        .map(parseFrame)
+        .filter((frame): frame is StackFrame => frame !== undefined);
+}
+
+function parseFrame(line: string): StackFrame | undefined {
+    let match = v8FrameWithMethod.exec(line);
+    if (match) {
+        return frame(match[1], match[2], match[3]);
+    }
+
+    match = v8FrameWithoutMethod.exec(line);
+    if (match && !line.includes('(')) {
+        return frame('', match[1], match[2]);
+    }
+
+    match = dotNetFrame.exec(line);
+    if (match) {
+        return frame(match[1], match[2] ?? '', match[3] ?? '0');
+    }
+
+    match = geckoFrame.exec(line);
+    if (match) {
+        return frame(match[1], match[2], match[3]);
+    }
+
+    return undefined;
+}
+
+function frame(method: string, file: string, line: string): StackFrame {
+    return Object.assign(new StackFrame(), {
+        method: method.trim(),
+        file: file.trim(),
+        line: Number.parseInt(line, 10) || 0
+    });
+}

package/Errors/resolveLocation.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { SliceLocation as ArcSliceLocation } from '@cratis/arc/reflection';
+
+/**
+ * Resolves where an error happened: the slice location of the failing command or query when its proxy declares one,
+ * otherwise the location given, otherwise {@link ArcSliceLocation.empty}.
+ * @param operation The failing command or query, if known.
+ * @param location The location the caller knows, such as the one from `useSliceContext()`.
+ * @returns The {@link ArcSliceLocation}.
+ */
+export function resolveLocation(operation?: object, location?: ArcSliceLocation): ArcSliceLocation {
+    const declared = operation ? ArcSliceLocation.of(operation) : ArcSliceLocation.empty;
+    if (!declared.isEmpty) {
+        return declared;
+    }
+
+    return location ?? ArcSliceLocation.empty;
+}

package/Identity/ShareIdentity/ShareIdentity.ts

@@ -0,0 +1,61 @@
+// 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.Identity.ShareIdentity.ShareIdentity. Time: 2026-10-26T19:31:39.8469400Z. Hash: AED64B66E1CDCA28889C3B2466EBD757C08D2AF9AE56C05872DF8F0C49EE1261
+import { Command } from '@cratis/arc/commands';
+import { ClearCommandValues, SetCommandValues, useCommand } from '@cratis/arc.react/commands';
+import { SliceLocation as ArcSliceLocation, PropertyDescriptor } from '@cratis/arc/reflection';
+import { Guid } from '@cratis/fundamentals';
+
+/**
+ * The reporter lets support know who they are on one of their issues. Who they are is taken from the signed-in identity, never from the request.
+ */
+export interface IShareIdentity {
+
+    /**
+     * The issue to share identity on.
+     */
+    issueId?: Guid;
+}
+
+
+/**
+ * The reporter lets support know who they are on one of their issues. Who they are is taken from the signed-in identity, never from the request.
+ */
+export class ShareIdentity extends Command<IShareIdentity> implements IShareIdentity {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', 'Identity', 'ShareIdentity');
+    readonly route: string = '/api/identity/share-identity';
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly propertyDescriptors: PropertyDescriptor[] = [
+        new PropertyDescriptor('issueId', Guid, false),
+    ];
+
+    #issueId!: Guid;
+
+    constructor() {
+        super(Object, false);
+    }
+
+    get requestParameters(): string[] {
+        return [
+        ];
+    }
+
+    /**
+     * The issue to share identity on.
+     */
+    get issueId(): Guid {
+        return this.#issueId;
+    }
+
+    set issueId(value: Guid) {
+        this.#issueId = value;
+        this.propertyChanged('issueId');
+    }
+
+    static use(initialValues?: IShareIdentity): [ShareIdentity, SetCommandValues<IShareIdentity>, ClearCommandValues] {
+        return useCommand<ShareIdentity, IShareIdentity>(ShareIdentity, initialValues);
+    }
+}

package/Identity/ShareIdentity/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 './ShareIdentity';

package/Identity/UserIdentity.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.Identity.UserIdentity. Time: 2026-10-26T20:48:58.8871950Z. Hash: 6FDEB6ECF78153E93401ADDA5DFA8E0CD88A42CA6173225F52070F2E7EE7306E
+import { field } from '@cratis/fundamentals';
+
+/**
+ * Who a person is at the identity provider they signed in with: the provider and the subject it issued them. A subject is unique only within its provider, so two people can have the same subject at two providers; Usher compares the pair wherever it decides whose an issue is or who acts.
+ */
+export class UserIdentity {
+
+    /**
+     * The identity provider; {@link NotSet} when the principal names none.
+     */
+    @field(String)
+    identityProvider!: string;
+
+    /**
+     * The subject the identity provider issued.
+     */
+    @field(String)
+    subject!: string;
+
+    /**
+     * Gets whether the identity names somebody: it has a subject.
+     */
+    @field(Boolean)
+    isSet!: boolean;
+}

package/Identity/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 './UserIdentity';

package/Issues/IssueKind.ts

@@ -0,0 +1,12 @@
+// 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.Issues.IssueKind. Time: 2026-10-26T18:15:51.5541920Z. Hash: 5E093A337A9E2FA5956A4B2D3ADEBDCAC852CF1D670DFB27A5BE02D0FC567B25
+/**
+ * How an issue came to be reported.
+ */
+export enum IssueKind {
+    error = 0,
+    manual = 1,
+}

package/Issues/IssueState.ts

@@ -0,0 +1,17 @@
+// 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.Issues.IssueState. Time: 2026-10-26T18:15:51.5541920Z. Hash: 12421F073F48EA7DD9049D1536BC01BA74CED8BF2CD65648DF8F000FC821CC9E
+/**
+ * The state an issue is in, as the reporter sees it.
+ */
+export enum IssueState {
+    reported = 0,
+    triaged = 1,
+    accepted = 2,
+    inProgress = 3,
+    resolved = 4,
+    wontFix = 5,
+    withdrawn = 6,
+}

package/Issues/index.ts

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

package/Lifecycle/ReopenIssue/ReopenIssue.ts

@@ -0,0 +1,87 @@
+// 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.Lifecycle.ReopenIssue.ReopenIssue. Time: 2026-10-26T21:13:51.1172240Z. Hash: 3A9B88B81AF2987AC016DC7A57C42A135969D27240F0FB9EC5E05166E9DECBD8
+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 { Guid } from '@cratis/fundamentals';
+
+/**
+ * The reporter reopens one of their resolved issues because the problem is not gone.
+ */
+export interface IReopenIssue {
+
+    /**
+     * The issue to reopen.
+     */
+    issueId?: Guid;
+
+    /**
+     * Why the reporter reopens it.
+     */
+    reason?: string;
+}
+
+export class ReopenIssueValidator extends CommandValidator<IReopenIssue> {
+    constructor() {
+        super();
+        this.ruleFor(c => c.reason).notEmpty().withMessage('Tell support why you reopen the issue.');
+        this.ruleFor(c => c.reason).maxLength(1000).withMessage('Keep the reason within 1000 characters.');
+    }
+}
+
+/**
+ * The reporter reopens one of their resolved issues because the problem is not gone.
+ */
+export class ReopenIssue extends Command<IReopenIssue> implements IReopenIssue {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', 'Lifecycle', 'ReopenIssue');
+    readonly route: string = '/api/lifecycle/reopen-issue';
+    readonly validation: CommandValidator = new ReopenIssueValidator();
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly propertyDescriptors: PropertyDescriptor[] = [
+        new PropertyDescriptor('issueId', Guid, false),
+        new PropertyDescriptor('reason', String, false),
+    ];
+
+    #issueId!: Guid;
+    #reason!: string;
+
+    constructor() {
+        super(Object, false);
+    }
+
+    get requestParameters(): string[] {
+        return [
+        ];
+    }
+
+    /**
+     * The issue to reopen.
+     */
+    get issueId(): Guid {
+        return this.#issueId;
+    }
+
+    set issueId(value: Guid) {
+        this.#issueId = value;
+        this.propertyChanged('issueId');
+    }
+    /**
+     * Why the reporter reopens it.
+     */
+    get reason(): string {
+        return this.#reason;
+    }
+
+    set reason(value: string) {
+        this.#reason = value;
+        this.propertyChanged('reason');
+    }
+
+    static use(initialValues?: IReopenIssue): [ReopenIssue, SetCommandValues<IReopenIssue>, ClearCommandValues] {
+        return useCommand<ReopenIssue, IReopenIssue>(ReopenIssue, initialValues);
+    }
+}

package/Lifecycle/ReopenIssue/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 './ReopenIssue';

package/Lifecycle/WithdrawIssue/WithdrawIssue.ts

@@ -0,0 +1,61 @@
+// 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.Lifecycle.WithdrawIssue.WithdrawIssue. Time: 2026-10-26T19:31:39.8469400Z. Hash: 722745425BDD6BA0C960FE515A55F7F3A36193C8FBDD541449B13B5960DE9716
+import { Command } from '@cratis/arc/commands';
+import { ClearCommandValues, SetCommandValues, useCommand } from '@cratis/arc.react/commands';
+import { SliceLocation as ArcSliceLocation, PropertyDescriptor } from '@cratis/arc/reflection';
+import { Guid } from '@cratis/fundamentals';
+
+/**
+ * The reporter withdraws one of their open issues; support no longer needs to look into it.
+ */
+export interface IWithdrawIssue {
+
+    /**
+     * The issue to withdraw.
+     */
+    issueId?: Guid;
+}
+
+
+/**
+ * The reporter withdraws one of their open issues; support no longer needs to look into it.
+ */
+export class WithdrawIssue extends Command<IWithdrawIssue> implements IWithdrawIssue {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', 'Lifecycle', 'WithdrawIssue');
+    readonly route: string = '/api/lifecycle/withdraw-issue';
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly propertyDescriptors: PropertyDescriptor[] = [
+        new PropertyDescriptor('issueId', Guid, false),
+    ];
+
+    #issueId!: Guid;
+
+    constructor() {
+        super(Object, false);
+    }
+
+    get requestParameters(): string[] {
+        return [
+        ];
+    }
+
+    /**
+     * The issue to withdraw.
+     */
+    get issueId(): Guid {
+        return this.#issueId;
+    }
+
+    set issueId(value: Guid) {
+        this.#issueId = value;
+        this.propertyChanged('issueId');
+    }
+
+    static use(initialValues?: IWithdrawIssue): [WithdrawIssue, SetCommandValues<IWithdrawIssue>, ClearCommandValues] {
+        return useCommand<WithdrawIssue, IWithdrawIssue>(WithdrawIssue, initialValues);
+    }
+}

package/Lifecycle/WithdrawIssue/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 './WithdrawIssue';