@oxide/turnstile.ts 0.6.7 → 0.7.0-rc.0

package/src/Api.ts

@@ -36,6 +36,8 @@ export type TypedUuidForRoleId = string
 
 export type TypedUuidForListingId = string
 
+export type TypedUuidForPoolId = string
+
 export type TypedUuidForReviewerId = string
 
 export type TypedUuidForReviewId = string
@@ -97,6 +99,10 @@ export type TurnstilePermission =
     | 'GetListingsAll'
     | 'CreateListing'
     | 'ManageListingsAll'
+    | 'GetPoolsAssigned'
+    | 'GetPoolsAll'
+    | 'CreatePool'
+    | 'ManagePoolsAll'
     | 'GetReviewersAssigned'
     | 'GetReviewersAll'
     | 'GetReviewerSelf'
@@ -206,6 +212,8 @@ export type TurnstilePermission =
     | { 'GetRoles': TypedUuidForRoleId[] }
     | { 'GetListing': TypedUuidForListingId }
     | { 'GetListings': TypedUuidForListingId[] }
+    | { 'GetPool': TypedUuidForPoolId }
+    | { 'GetPools': TypedUuidForPoolId[] }
     | { 'GetReviewer': TypedUuidForReviewerId }
     | { 'GetReviewers': TypedUuidForReviewerId[] }
     | { 'CreateReviewer': TypedUuidForUserId }
@@ -474,6 +482,15 @@ export type ApplicationStateRecord = {
     'updatedAt': Date
 }
 
+export type ListingPoolAssociation =
+    | 'first'
+    | 'early_positive'
+    | 'positive'
+
+export type PoolAction =
+    | { 'action': 'add'; 'association': ListingPoolAssociation; 'count': number }
+    | { 'action': 'triage' }
+
 export type ReviewScore =
     | 'emphatic_yes'
     | 'yes'
@@ -491,6 +508,7 @@ export type Reviews = {
 }
 
 export type ExpandedApplicationSummary = {
+    'action': PoolAction
     'applicant': ApplicantInfo
     'application': Application
     'documents': Document[]
@@ -509,6 +527,8 @@ export type ApplicationSummariesResponse = { 'summaries': ExpandedApplicationSum
 
 export type ApplicationSummaryResponse = { 'summary': ExpandedApplicationSummary; 'users': Evaluator[] }
 
+export type AssignPool = { 'association': ListingPoolAssociation; 'listing': TypedUuidForListingId }
+
 export type AttachDocument = { 'externalId': string; 'mime'?: string }
 
 export type EmailConfig = {
@@ -557,6 +577,8 @@ export type CreateListing = { 'name': string; 'role': TypedUuidForRoleId; 'statu
 
 export type CreateMapper = { 'maxActivations'?: number; 'name': string; 'rule': Record<string, unknown> }
 
+export type CreatePool = { 'description'?: string; 'name': string; 'reviwers'?: TypedUuidForReviewerId[] }
+
 export type CreateReview = {
     'application': TypedUuidForApplicationId
     'content': string
@@ -572,9 +594,15 @@ export type CreateReview = {
  */
 export type CreateReviewAssignments = { 'reviewers': TypedUuidForReviewerId[] }
 
+/**
+ * Failures that can occur when assigning a reviewer
+ */
 export type ReviewAssignmentCreationError =
+    /** A requested object resource does not exist */
     | 'DoesNotExist'
+    /** Caller does not have access to a require object resource */
     | 'Forbidden'
+    /** Internal server error */
     | 'Internal'
 
 export type TypedUuidForReviewAssignmentId = string
@@ -593,37 +621,14 @@ export type ReviewAssignment = {
     'updatedAt': Date
 }
 
-export type TypedUuidForNotificationId = string
-
-export type NotificationMedium = 'Email'
-
-export type RenderedEmail = { 'from': string; 'html'?: string; 'name': string; 'subject': string; 'text': string }
-
-export type RecipientId =
-    | { 'Applicant': TypedUuidForApplicantId }
-    | { 'Custom': string }
-    | { 'Reviewer': TypedUuidForReviewerId }
-
-export type NotificationStatus =
-    | 'Failed'
-    | 'Pending'
-    | 'Scheduled'
-    | 'Sent'
-
-export type Notification_for_RenderedEmail = {
-    'createdAt': Date
-    'deletedAt'?: Date
-    'id': TypedUuidForNotificationId
-    'kind': string
-    'medium': NotificationMedium
-    'message'?: RenderedEmail
-    'recipient': RecipientId
-    'status': NotificationStatus
-    'updatedAt': Date
-}
-
-export type CreatedAssignment = { 'assignment': ReviewAssignment; 'notification': Notification_for_RenderedEmail }
+/**
+ * Wrapper containing the assignment object
+ */
+export type CreatedAssignment = { 'assignment': ReviewAssignment }
 
+/**
+ * Aggregate collection of results indexed by the reviewer ids that were requested to be assigned to the applcation
+ */
 export type CreateReviewAssignmentsResponse = {
     'failure': Record<string, ReviewAssignmentCreationError>
     'success': Record<string, CreatedAssignment>
@@ -722,6 +727,18 @@ export type Listing = {
     'updatedAt': Date
 }
 
+export type TypedUuidForListingPoolId = string
+
+export type ListingPool = {
+    'association': ListingPoolAssociation
+    'createdAt': Date
+    'deletedAt'?: Date
+    'id': TypedUuidForListingPoolId
+    'listingId': TypedUuidForListingId
+    'poolId': TypedUuidForPoolId
+    'updatedAt': Date
+}
+
 export type TypedUuidForMagicLinkRedirectUriId = string
 
 export type MagicLinkRedirectUri = {
@@ -783,9 +800,38 @@ export type Mapper = {
     'updatedAt': Date
 }
 
+export type NotificationMedium = 'Email'
+
+export type NotificationStatus =
+    | 'Failed'
+    | 'Pending'
+    | 'Scheduled'
+    | 'Sent'
+
+export type TypedUuidForNotificationId = string
+
+export type RenderedEmail = { 'from': string; 'html'?: string; 'name': string; 'subject': string; 'text': string }
+
+export type RecipientId =
+    | { 'Applicant': TypedUuidForApplicantId }
+    | { 'Custom': string }
+    | { 'Reviewer': TypedUuidForReviewerId }
+
+export type Notification_for_RenderedEmail = {
+    'createdAt': Date
+    'deletedAt'?: Date
+    'id': TypedUuidForNotificationId
+    'kind': string
+    'medium': NotificationMedium
+    'message'?: RenderedEmail
+    'recipient': RecipientId
+    'status': NotificationStatus
+    'updatedAt': Date
+}
+
 export type OAuthAuthzCodeExchangeBody = {
-    'clientId': TypedUuidForOAuthClientId
-    'clientSecret': SecretString
+    'clientId'?: TypedUuidForOAuthClientId
+    'clientSecret'?: SecretString
     'code': string
     'grantType': string
     'pkceVerifier'?: string
@@ -896,6 +942,17 @@ export type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferre
 
 export type OptionalTransitionBody = { 'message'?: EmailConfig }
 
+export type Pool = {
+    'createdAt': Date
+    'deletedAt'?: Date
+    'description'?: string
+    'id': TypedUuidForPoolId
+    'listings': ListingPool[]
+    'name': string
+    'reviewers': TypedUuidForReviewerId[]
+    'updatedAt': Date
+}
+
 export type RegisterApplicant = { 'email': string }
 
 export type Review = {
@@ -1035,6 +1092,10 @@ export interface ViewApplicationPathParams {
     application: TypedUuidForApplicationId
 }
 
+export interface ApplyReviewActionPathParams {
+    application: TypedUuidForApplicationId
+}
+
 export interface ListApplicationReviewAssignmentsPathParams {
     application: TypedUuidForApplicationId
 }
@@ -1063,6 +1124,10 @@ export interface GetApplicationInterviewCodePathParams {
     application: TypedUuidForApplicationId
 }
 
+export interface SimulateReviewActionPathParams {
+    application: TypedUuidForApplicationId
+}
+
 export interface SubmitApplicationPathParams {
     application: TypedUuidForApplicationId
 }
@@ -1277,6 +1342,22 @@ export interface DeleteOauthClientSecretPathParams {
     secretId: TypedUuidForOAuthSecretId
 }
 
+export interface ViewPoolPathParams {
+    pool: TypedUuidForPoolId
+}
+
+export interface UpdatePoolPathParams {
+    pool: TypedUuidForPoolId
+}
+
+export interface AssignPoolPathParams {
+    pool: TypedUuidForPoolId
+}
+
+export interface UnassignPoolPathParams {
+    assignment: TypedUuidForListingPoolId
+}
+
 export interface ListReviewsQueryParams {
     application?: TypedUuidForApplicationId
     reviewer?: TypedUuidForReviewerId
@@ -1548,6 +1629,21 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Compute the next review action to take on this application and apply the necessary changes
+         */
+        applyReviewAction: ({
+            path,
+        }: { path: ApplyReviewActionPathParams }, params: FetchParams = {}) => {
+            return this.request<ReviewAssignment[]>({
+                path: `/application/${path.application}/apply-review-action`,
+                method: 'POST',
+                ...params,
+            })
+        },
+        /**
+         * List the individual reviewers that are assigned to this application
+         */
         listApplicationReviewAssignments: ({
             path,
         }: { path: ListApplicationReviewAssignmentsPathParams }, params: FetchParams = {}) => {
@@ -1557,6 +1653,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Assign individual reviewers to this application
+         */
         createApplicationReviewAssignments: (
             {
                 path,
@@ -1609,6 +1708,18 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Simulate the selection of the next review action without performing any changes
+         */
+        simulateReviewAction: ({
+            path,
+        }: { path: SimulateReviewActionPathParams }, params: FetchParams = {}) => {
+            return this.request<PoolAction>({
+                path: `/application/${path.application}/simulate-review-action`,
+                method: 'GET',
+                ...params,
+            })
+        },
         submitApplication: ({
             path,
         }: { path: SubmitApplicationPathParams }, params: FetchParams = {}) => {
@@ -2320,6 +2431,63 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        listPools: (_: EmptyObj, params: FetchParams = {}) => {
+            return this.request<Pool[]>({
+                path: `/pool`,
+                method: 'GET',
+                ...params,
+            })
+        },
+        createPool: ({
+            body,
+        }: { body: CreatePool }, params: FetchParams = {}) => {
+            return this.request<Pool>({
+                path: `/pool`,
+                method: 'POST',
+                body,
+                ...params,
+            })
+        },
+        viewPool: ({
+            path,
+        }: { path: ViewPoolPathParams }, params: FetchParams = {}) => {
+            return this.request<Pool>({
+                path: `/pool/${path.pool}`,
+                method: 'GET',
+                ...params,
+            })
+        },
+        updatePool: ({
+            path,
+            body,
+        }: { path: UpdatePoolPathParams; body: CreatePool }, params: FetchParams = {}) => {
+            return this.request<Pool>({
+                path: `/pool/${path.pool}`,
+                method: 'POST',
+                body,
+                ...params,
+            })
+        },
+        assignPool: ({
+            path,
+            body,
+        }: { path: AssignPoolPathParams; body: AssignPool }, params: FetchParams = {}) => {
+            return this.request<Pool>({
+                path: `/pool/${path.pool}/assignment`,
+                method: 'POST',
+                body,
+                ...params,
+            })
+        },
+        unassignPool: ({
+            path,
+        }: { path: UnassignPoolPathParams }, params: FetchParams = {}) => {
+            return this.request<void>({
+                path: `/pool-assignment/${path.assignment}`,
+                method: 'DELETE',
+                ...params,
+            })
+        },
         listReviews: ({
             query = {},
         }: { query?: ListReviewsQueryParams }, params: FetchParams = {}) => {

package/src/util.ts

@@ -43,7 +43,7 @@ export const mapObj = (
 }
 
 export const parseIfDate = (k: string | undefined, v: unknown) => {
-    if (typeof v === 'string' && (k?.startsWith('time_') || k === 'timestamp' || k?.endsWith('_at') || k?.endsWith('_time'))) {
+  if (typeof v === 'string' && (k?.startsWith('time_') || k === 'timestamp' || k?.endsWith('_at') || k?.endsWith('_time'))) {
         const d = new Date(v)
         if (isNaN(d.getTime())) { return v }
         return d