Merge branch 'develop'

Author: CarsonF

package.json

@@ -106,7 +106,7 @@
     "@types/cookie-parser": "^1.4.3",
     "@types/express": "^4.17.17",
     "@types/express-serve-static-core": "^4.17.35",
-    "@types/ffprobe": "^1.1.4",
+    "@types/ffprobe": "^1.1.5",
     "@types/jest": "^29.5.3",
     "@types/jsonwebtoken": "^9.0.2",
     "@types/lodash": "^4.14.197",

src/common/create-and-inject.ts

@@ -0,0 +1,18 @@
+import { ModuleRef } from '@nestjs/core';
+import { pickBy } from 'lodash';
+import { Class } from 'type-fest';
+
+/**
+ * A helper to create an instance of a class and inject dependencies.
+ */
+export async function createAndInject<T extends Class<any>>(
+  moduleRef: ModuleRef,
+  type: T,
+  ...input: ConstructorParameters<T>
+): Promise<InstanceType<T>> {
+  const injection = await moduleRef.resolve(type);
+  const injectionProps = pickBy(injection);
+  const object = new type(...input);
+  Object.assign(object, injectionProps);
+  return object;
+}

src/common/index.ts

@@ -3,6 +3,7 @@ export { Many, many, maybeMany, JsonSet, ArrayItem } from '@seedcompany/common';
 export * from './temporal';
 export * from './calculated.decorator';
 export * from './context.type';
+export * from './create-and-inject';
 export * from './data-object';
 export * from './date-filter.input';
 export { DbLabel } from './db-label.decorator';
@@ -26,6 +27,7 @@ export * from './pagination.input';
 export * from './pagination-list';
 export * from './parent-id.middleware';
 export * from './parent-types';
+export * from './poll';
 export * from './resource.dto';
 export * from './role.dto';
 export * from './secured-list';

src/common/poll.ts

@@ -0,0 +1,124 @@
+import { setOf } from '@seedcompany/common';
+
+export class PollResults<T> {
+  constructor(protected readonly data: PollData<T>) {}
+
+  /** Returns true if there were any votes */
+  get anyVotes() {
+    return this.numberOfVotes > 0;
+  }
+
+  /** Returns true if there were no votes */
+  get noVotes() {
+    return this.numberOfVotes === 0;
+  }
+
+  get numberOfVotes() {
+    return [...this.data.votes.values()].reduce((total, cur) => total + cur, 0);
+  }
+
+  get vetoed() {
+    return this.data.vetoed;
+  }
+
+  /** Returns if there was a tie for the highest votes */
+  get tie() {
+    const [highest, second] = this.sorted;
+    return highest && second ? highest[1] === second[1] : false;
+  }
+
+  /** Returns the largest minority vote (could be majority too), if there was one */
+  get plurality() {
+    const [highest, second] = this.sorted;
+    if (!highest) {
+      return undefined;
+    }
+    return highest[1] > (second?.[1] ?? 0) ? highest[0] : undefined;
+  }
+
+  /** Returns the majority vote (>50%), if there was one */
+  get majority() {
+    const [first] = this.sorted;
+    if (!first) {
+      return undefined;
+    }
+    return first[1] > this.numberOfVotes / 2 ? first[0] : undefined;
+  }
+
+  /** Returns the unanimous vote, if there was one */
+  get unanimous() {
+    const all = this.sorted;
+    return all.length === 1 ? all[0][0] : undefined;
+  }
+
+  /** Returns all votes sorted by most voted first (ties are unaccounted for) */
+  get allVotes() {
+    return setOf(this.sorted.map(([vote]) => vote));
+  }
+
+  private get sorted() {
+    return [...this.data.votes].sort((a, b) => b[1] - a[1]);
+  }
+}
+
+/**
+ * @example
+ * const poll = new Poll();
+ *
+ * poll.noVotes; // true
+ * poll.vote(true);
+ * poll.unanimous; // true
+ * poll.anyVotes; // true
+ *
+ * poll.vote(false);
+ * poll.unanimous; // undefined
+ * poll.tie; // true
+ * poll.majority; // undefined
+ * poll.plurality; // undefined
+ *
+ * poll.vote(true);
+ * poll.majority; // true
+ * poll.plurality; // true
+ */
+export class Poll<T = boolean> extends PollResults<T> implements PollVoter<T> {
+  // Get a view of this poll, with results hidden.
+  readonly voter: PollVoter<T> = this;
+  // Get a readonly view of this poll's results.
+  readonly results: PollResults<T> = this;
+
+  constructor() {
+    super(new PollData<T>());
+  }
+
+  vote(vote: T) {
+    this.data.votes.set(vote, (this.data.votes.get(vote) ?? 0) + 1);
+  }
+
+  veto() {
+    this.data.vetoed = true;
+  }
+}
+
+/**
+ * The mutations available for a poll.
+ */
+export abstract class PollVoter<T> {
+  /** Cast a vote. */
+  abstract vote(vote: T): void;
+
+  /**
+   * Veto the poll all together.
+   * Multiple vetoes are allowed and are functionally the same.
+   * Consider using this instead of throwing an exception, for when you want to
+   * "cancel" the poll / override all other votes.
+   * Exceptions are for unexpected errors, where this veto would be a logical
+   * expectation, so throwing is not the best way to handle it.
+   * This could be enhanced in future to allow a reason for the veto.
+   */
+  abstract veto(): void;
+}
+
+class PollData<T> {
+  votes = new Map<T, number>();
+  vetoed = false;
+}

src/common/variant.dto.ts

@@ -72,22 +72,29 @@ export type VariantOf<TResourceStatic extends ResourceShape<any>> =
  */
 export const VariantInputField = <
   Res extends ResourceShape<any> & { Variants: readonly Variant[] },
+  Many extends undefined | true = undefined,
 >(
   resource: Res,
   options: Omit<FieldOptions, 'defaultValue'> & {
-    defaultValue?: Variant<VariantOf<Res>> | VariantOf<Res>;
+    many?: Many;
+    defaultValue?: Many extends true
+      ? ReadonlyArray<Variant<VariantOf<Res>> | VariantOf<Res>>
+      : Variant<VariantOf<Res>> | VariantOf<Res>;
   } = {},
 ) => {
-  const { defaultValue, ...rest } = options;
+  const { many, defaultValue, ...rest } = options;
 
   // Resolve default to variant object
-  const defaultVariant =
-    typeof defaultValue === 'string'
-      ? resource.Variants.find((v) => v.key === options.defaultValue)
-      : defaultValue;
+  const resolveVariant = (value: Variant<VariantOf<Res>> | VariantOf<Res>) =>
+    typeof value === 'string'
+      ? resource.Variants.find((v) => v.key === value)
+      : value;
+  const defaultVariant = many
+    ? (defaultValue as any[])?.map(resolveVariant)
+    : resolveVariant(defaultValue as VariantOf<Res>);
 
   return applyDecorators(
-    Field(() => IDType, {
+    Field(() => (many ? [IDType] : IDType), {
       // Don't put default value in schema as we are trying to keep specific
       // values out of schema, so they can be more dynamic.
       nullable: !!defaultValue,
@@ -97,11 +104,15 @@ export const VariantInputField = <
       if (value == null) {
         return defaultVariant;
       }
-      return resource.Variants.find((v) => v.key === value) ?? value;
+      if (many && Array.isArray(value)) {
+        return value.map(resolveVariant);
+      }
+      return resolveVariant(value);
     }),
     IsIn(resource.Variants, {
       message: ({ value }) =>
         `Variant with key "${String(value)}" was not found`,
+      each: many,
     }),
   );
 };

src/components/authorization/policies/by-feature/progress-report-media-owner.policy.ts

@@ -0,0 +1,4 @@
+import { owner, Policy } from '../util';
+
+@Policy('all', (r) => r.ProgressReportMedia.when(owner).edit.delete)
+export class ProgressReportMediaOwnerPolicy {}

src/components/authorization/policies/by-role/consultant-manager.policy.ts

@@ -46,6 +46,7 @@ import { member, Policy, Role, sensMediumOrLower, sensOnlyLow } from '../util';
     r.ProgressReportCommunityStory,
     r.ProgressReportHighlight,
     r.ProgressReportTeamNews,
+    r.ProgressReportMedia,
     r.ProgressReportVarianceExplanation,
     r.StepProgress,
   ].map((it) => it.whenAny(member, sensMediumOrLower).read),

src/components/authorization/policies/by-role/consultant.policy.ts

@@ -17,6 +17,7 @@ import { member, Policy, Role } from '../util';
     r.ProgressReportCommunityStory,
     r.ProgressReportHighlight,
     r.ProgressReportTeamNews,
+    r.ProgressReportMedia,
     r.ProgressReportVarianceExplanation,
     r.StepProgress,
   ].map((it) => it.when(member).read),

src/components/authorization/policies/by-role/field-partner.policy.ts

@@ -24,6 +24,7 @@ import { member, Policy, Role, variant } from '../util';
       p.responses.whenAll(member, variant('draft')).edit,
     ]),
   ]),
+  r.ProgressReportMedia.whenAll(member, variant('draft')).create.edit,
   r.ProgressReportWorkflowEvent.transitions(
     'Start',
     'In Progress -> In Review',

src/components/authorization/policies/by-role/marketing.policy.ts

@@ -27,6 +27,7 @@ import {
       p.responses.read.when(variant('published')).edit,
     ]),
   ]),
+  r.ProgressReportMedia.read.when(variant('published')).create.edit,
   r.ProgressReportVarianceExplanation.read.specifically((p) => p.comments.none),
   r.ProgressReportWorkflowEvent.read.transitions('Publish').execute,
   r.Project.read