@common-grants/core 0.2.0-alpha.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -1
- package/lib/api.tsp +64 -45
- package/lib/core/fields/address.tsp +2 -0
- package/lib/core/fields/email.tsp +1 -0
- package/lib/core/fields/file.tsp +1 -0
- package/lib/core/fields/name.tsp +1 -0
- package/lib/core/fields/pcs.tsp +7 -0
- package/lib/core/models/applicant-type.tsp +98 -0
- package/lib/core/models/application.tsp +49 -18
- package/lib/core/models/competition.tsp +19 -10
- package/lib/core/models/form-response.tsp +41 -10
- package/lib/core/models/form.tsp +4 -1
- package/lib/core/models/index.tsp +1 -0
- package/lib/core/models/mapping.tsp +50 -55
- package/lib/core/models/opportunity/base.tsp +15 -0
- package/lib/core/models/opportunity/status.tsp +8 -3
- package/lib/core/models/organization.tsp +2 -0
- package/lib/core/models/person.tsp +1 -0
- package/lib/core/models/proposal.tsp +5 -0
- package/lib/core/responses/error.tsp +12 -0
- package/lib/core/routes/applications.tsp +13 -9
- package/lib/core/routes/competitions.tsp +11 -7
- package/lib/core/routes/form-responses.tsp +6 -6
- package/lib/core/routes/forms.tsp +38 -0
- package/lib/core/routes/index.tsp +1 -0
- package/lib/core/routes/opportunities.tsp +14 -6
- package/lib/core/types.tsp +5 -0
- package/package.json +1 -1
|
@@ -8,6 +8,7 @@ namespace CommonGrants.Routes;
|
|
|
8
8
|
// Expose the contents of the Http and Rest namespaces
|
|
9
9
|
// these include the decorators @route, @get, etc.
|
|
10
10
|
using TypeSpec.Http;
|
|
11
|
+
using TypeSpec.Versioning;
|
|
11
12
|
|
|
12
13
|
/** A re-usable interface for an Opportunities router
|
|
13
14
|
*
|
|
@@ -52,7 +53,7 @@ interface Opportunities {
|
|
|
52
53
|
): Responses.Paginated<T>;
|
|
53
54
|
|
|
54
55
|
// ##############################
|
|
55
|
-
// View an opportunity
|
|
56
|
+
// View an opportunity (v0.1.0)
|
|
56
57
|
// ##############################
|
|
57
58
|
|
|
58
59
|
/** `GET /opportunities/<id>` View opportunity details
|
|
@@ -60,12 +61,19 @@ interface Opportunities {
|
|
|
60
61
|
* @template T Type of the response model.
|
|
61
62
|
* Must be an extension of Schemas.OpportunityBase. Default is Schemas.OpportunityBase.
|
|
62
63
|
*/
|
|
63
|
-
@summary("View opportunity")
|
|
64
|
-
@doc("View
|
|
64
|
+
@summary("View opportunity details")
|
|
65
|
+
@doc("View details about an opportunity.")
|
|
65
66
|
@get
|
|
66
|
-
read<T extends Models.OpportunityBase = Models.
|
|
67
|
+
read<T extends Models.OpportunityBase = Models.OpportunityDetails>(
|
|
67
68
|
/** The ID of the opportunity to view */
|
|
68
|
-
@path
|
|
69
|
+
@path
|
|
70
|
+
@removed(Versions.v0_2)
|
|
71
|
+
id: Types.uuid,
|
|
72
|
+
|
|
73
|
+
/** The ID of the opportunity to view */
|
|
74
|
+
@path
|
|
75
|
+
@added(Versions.v0_2)
|
|
76
|
+
oppId: Types.uuid,
|
|
69
77
|
): Responses.Ok<T> | Responses.NotFound;
|
|
70
78
|
|
|
71
79
|
// ###############################
|
|
@@ -78,7 +86,7 @@ interface Opportunities {
|
|
|
78
86
|
* Must be an extension of Schemas.OpportunityBase. Default is Schemas.OpportunityBase.
|
|
79
87
|
*/
|
|
80
88
|
@summary("Search opportunities")
|
|
81
|
-
@doc("Search for opportunities based on the provided filters")
|
|
89
|
+
@doc("Search for opportunities based on the provided filters.")
|
|
82
90
|
@post
|
|
83
91
|
@route("/search")
|
|
84
92
|
search<T extends Models.OpportunityBase = Models.OpportunityBase>(
|
package/lib/core/types.tsp
CHANGED
|
@@ -33,22 +33,26 @@ scalar uuid extends string;
|
|
|
33
33
|
/** An email address */
|
|
34
34
|
@example("test@example.com")
|
|
35
35
|
@format("email")
|
|
36
|
+
@Versioning.added(CommonGrants.Versions.v0_2)
|
|
36
37
|
scalar email extends string;
|
|
37
38
|
|
|
38
39
|
/** An Employer Identification Number (EIN) issued by the IRS */
|
|
39
40
|
@example("12-3456789")
|
|
40
41
|
@pattern("^[0-9]{2}-[0-9]{7}$")
|
|
42
|
+
@Versioning.added(CommonGrants.Versions.v0_2)
|
|
41
43
|
scalar employerTaxId extends string;
|
|
42
44
|
|
|
43
45
|
/** A Unique Entity Identifier (UEI) issued by SAM.gov */
|
|
44
46
|
@example("12ABC34DEF56")
|
|
45
47
|
@pattern("^[A-z0-9]{12}$")
|
|
48
|
+
@Versioning.added(CommonGrants.Versions.v0_2)
|
|
46
49
|
scalar samUEI extends string;
|
|
47
50
|
|
|
48
51
|
/** A Data Universal Numbering System (DUNS) number */
|
|
49
52
|
@example("123456789")
|
|
50
53
|
@example("12-345-6789")
|
|
51
54
|
@example("123456789-1234")
|
|
55
|
+
@Versioning.added(CommonGrants.Versions.v0_2)
|
|
52
56
|
scalar duns extends string;
|
|
53
57
|
|
|
54
58
|
// ########################################
|
|
@@ -80,4 +84,5 @@ scalar isoDate extends plainDate;
|
|
|
80
84
|
/** A calendar year */
|
|
81
85
|
@example("2025")
|
|
82
86
|
@pattern("^[0-9]{4}$")
|
|
87
|
+
@Versioning.added(CommonGrants.Versions.v0_2)
|
|
83
88
|
scalar calendarYear extends string;
|