[Issue #319] Prepare @common-grants/core minor release

.changeset/hot-pets-marry.md

@@ -0,0 +1,13 @@
+---
+"@common-grants/cli": minor
+---
+
+Supports checking APIs against the v0.3.0 CommonGrants OpenAPI spec.
+
+Enables CLI users to check against the v0.3.0 CommonGrants OpenAPI spec. This will be the new default version when running `cg check spec`
+
+Users can still validate against previous versions of the CommonGrants OpenAPI spec by specifying the `--protocol-version` flag. For example:
+
+```bash
+cg check spec openapi.yaml --protocol-version 0.2.0
+```

.changeset/moody-shoes-lay.md

@@ -0,0 +1,10 @@
+---
+"@common-grants/core": minor
+---
+
+Adds models and routes for application reviews.
+
+- Adds new OpenAPI tag for "Application reviews"
+- Adds new route `POST /common-grants/applications/search/` and a set of supporting models
+- Changes `NumberComparisonFilter.operator` type to `ComparisonOperators | EquivalenceOperators` so that we can filter using `eq` and `neq` in addition to `ge`, `gte`, etc.
+- Adds explicit `@Versioning.added()` decorator to all schemas, so that the version in which a schema was added is explicitly defined, rather than defaulting to v0.1.0

lib/changelog-emitter/package.json

@@ -14,12 +14,11 @@
     }
   },
   "peerDependencies": {
-    "@typespec/compiler": "^1.0.0",
-    "@typespec/versioning": ">=0.70.0"
+    "@typespec/compiler": "catalog:",
+    "@typespec/versioning": "catalog:"
   },
   "devDependencies": {
-    "@types/node": "latest",
-    "@typespec/compiler": "^1.5.0",
+    "@types/node": "catalog:",
     "@typespec/prettier-plugin-typespec": "^1.5.0",
     "eslint": "^9.15.0",
     "@eslint/js": "^9.15.0",

lib/cli/lib/openapi/openapi.0.1.0.yaml

@@ -13,7 +13,9 @@ tags:
   - name: Competitions
     description: Endpoints related to competitions, which are distinct application processes for the same funding opportunity
   - name: Applications
-    description: Endpoints related to applications for a given competition
+    description: Endpoints related to submitting applications for a given competition
+  - name: Application Reviews
+    description: Endpoints related to reviewing applications for a given competition
   - name: Forms
     description: Endpoints related to forms
   - name: required
@@ -819,7 +821,7 @@ components:
       description: Key dates and events in the opportunity's timeline, such as when the opportunity is posted and closes
       example:
         postDate:
-          name: Application posted date
+          name: Opportunity posted date
           eventType: singleDate
           date: '2024-01-15'
           description: Opportunity is posted publicly

lib/cli/lib/openapi/openapi.0.2.0.yaml

@@ -13,7 +13,9 @@ tags:
   - name: Competitions
     description: Endpoints related to competitions, which are distinct application processes for the same funding opportunity
   - name: Applications
-    description: Endpoints related to applications for a given competition
+    description: Endpoints related to submitting applications for a given competition
+  - name: Application Reviews
+    description: Endpoints related to reviewing applications for a given competition
   - name: Forms
     description: Endpoints related to forms
   - name: required
@@ -1161,6 +1163,40 @@ components:
         submittedAt: null
         createdAt: '2021-01-01T00:00:00Z'
         lastModifiedAt: '2021-01-01T00:00:00Z'
+        customFields:
+          attachments:
+            name: attachments
+            fieldType: object
+            value:
+              contacts:
+                downloadUrl: https://example.com/file.pdf
+                name: example.pdf
+                description: A PDF file with instructions
+                sizeInBytes: 1000
+                mimeType: application/pdf
+                createdAt: '2025-01-01T17:01:01'
+                lastModifiedAt: '2025-01-02T17:30:00'
+              budget:
+                downloadUrl: https://example.com/excel.xlsx
+                name: excel.xlsx
+                description: The excel file for the application
+                sizeInBytes: 1000
+                mimeType: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+                createdAt: '2025-01-01T17:01:01'
+                lastModifiedAt: '2025-01-02T17:30:00'
+            description: The attachments for the application
+          applicationZipFile:
+            name: applicationZipFile
+            fieldType: object
+            value:
+              downloadUrl: https://example.com/application.zip
+              name: application.zip
+              description: The zip file for the application
+              sizeInBytes: 50000
+              mimeType: application/zip
+              createdAt: '2025-01-01T17:01:01'
+              lastModifiedAt: '2025-01-02T17:30:00'
+            description: The zip file for the application
     CommonGrants.Models.CompetitionBase:
       type: object
       required:
@@ -1311,6 +1347,8 @@ components:
                   field: emails.primary
                 phone:
                   field: phones.primary
+              createdAt: '2025-01-01T17:01:01'
+              lastModifiedAt: '2025-01-02T17:30:00'
             formB:
               id: b7c1e2f4-8a3d-4e2a-9c5b-1f2e3d4c5b6a
               name: Form A
@@ -1365,6 +1403,8 @@ components:
                   field: emails.primary
                 phone:
                   field: phones.primary
+              createdAt: '2025-01-01T17:01:01'
+              lastModifiedAt: '2025-01-02T17:30:00'
           validation:
             required:
               - formA
@@ -1442,6 +1482,8 @@ components:
                 field: emails.primary
               phone:
                 field: phones.primary
+            createdAt: '2025-01-01T17:01:01'
+            lastModifiedAt: '2025-01-02T17:30:00'
           formB:
             id: b7c1e2f4-8a3d-4e2a-9c5b-1f2e3d4c5b6a
             name: Form A
@@ -1496,6 +1538,8 @@ components:
                 field: emails.primary
               phone:
                 field: phones.primary
+            createdAt: '2025-01-01T17:01:01'
+            lastModifiedAt: '2025-01-02T17:30:00'
         validation:
           required:
             - formA
@@ -1547,6 +1591,7 @@ components:
           additionalProperties:
             $ref: '#/components/schemas/CommonGrants.Fields.Event'
           description: The date the competition was created
+      description: Key dates in the competition's timeline.
       example:
         openDate:
           name: Open Date
@@ -1567,6 +1612,8 @@ components:
       required:
         - id
         - name
+        - createdAt
+        - lastModifiedAt
       properties:
         id:
           allOf:
@@ -1606,6 +1653,16 @@ components:
           additionalProperties:
             $ref: '#/components/schemas/CommonGrants.Fields.CustomField'
           description: Custom attributes about the form itself, not custom fields within the form.
+        createdAt:
+          type: string
+          format: date-time
+          description: The timestamp (in UTC) at which the record was created.
+          readOnly: true
+        lastModifiedAt:
+          type: string
+          format: date-time
+          description: The timestamp (in UTC) at which the record was last modified.
+          readOnly: true
       description: A form for collecting data from a user.
       example:
         id: b7c1e2f4-8a3d-4e2a-9c5b-1f2e3d4c5b6a
@@ -1661,6 +1718,8 @@ components:
             field: emails.primary
           phone:
             field: phones.primary
+        createdAt: '2025-01-01T17:01:01'
+        lastModifiedAt: '2025-01-02T17:30:00'
     CommonGrants.Models.FormJsonSchema:
       type: object
       additionalProperties: {}
@@ -2124,7 +2183,7 @@ components:
       description: Key dates and events in the opportunity's timeline, such as when the opportunity is posted and closes
       example:
         postDate:
-          name: Application posted date
+          name: Opportunity posted date
           eventType: singleDate
           date: '2024-01-15'
           description: Opportunity is posted publicly