@better-giving/endowment 1.0.29 → 1.0.31

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.
@@ -26,8 +26,8 @@ export declare const cloudsearchEndow: import("valibot").ObjectSchema<{
26
26
  }, undefined>;
27
27
  export declare const cloudSearchEndowFields: import("valibot").PicklistSchema<["name", "tagline", "card_img", "hq_country", "active_in_countries", "sdgs", "published", "fund_opt_in", "target", "id", "env", "registration_number", "endow_designation", "claimed", "kyc_donors_only", "contributions_total", "contributions_count"], undefined>;
28
28
  export declare const endowsQueryParams: import("valibot").ObjectSchema<{
29
- readonly query: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>;
30
- readonly page: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TransformAction<string, number>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>;
29
+ readonly query: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, never>;
30
+ readonly page: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TransformAction<string, number>, import("valibot").IntegerAction<number, undefined>, import("valibot").MinValueAction<number, 1, undefined>]>, never>;
31
31
  readonly endow_designation: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").FilterItemsAction<string[]>]>, import("valibot").ArraySchema<import("valibot").PicklistSchema<readonly ["Charity", "Religious Organization", "University", "Hospital", "Other"], undefined>, undefined>]>, never>;
32
32
  readonly sdgs: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").FilterItemsAction<string[]>]>, import("valibot").MapItemsAction<string[], number>, import("valibot").ArraySchema<import("valibot").PicklistSchema<readonly [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], undefined>, undefined>]>, never>;
33
33
  readonly kyc_only: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").FilterItemsAction<string[]>]>, import("valibot").MapItemsAction<string[], boolean>, import("valibot").ArraySchema<import("valibot").BooleanSchema<undefined>, undefined>]>, never>;
@@ -36,8 +36,12 @@ export declare const endowsQueryParams: import("valibot").ObjectSchema<{
36
36
  readonly countries: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").FilterItemsAction<string[]>]>, import("valibot").ArraySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, undefined>]>, never>;
37
37
  readonly fields: import("valibot").OptionalSchema<import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").LazySchema<import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]> | import("valibot").SchemaWithPipe<[import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").TrimAction]>, import("valibot").RegexAction<string, "invalid csv">]>>, import("valibot").TransformAction<string, string[]>, import("valibot").FilterItemsAction<string[]>]>, import("valibot").ArraySchema<import("valibot").PicklistSchema<["name", "tagline", "card_img", "hq_country", "active_in_countries", "sdgs", "published", "fund_opt_in", "target", "id", "env", "registration_number", "endow_designation", "claimed", "kyc_donors_only", "contributions_total", "contributions_count"], undefined>, undefined>]>, never>;
38
38
  }, undefined>;
39
+ export interface CloudsearchEndowsQueryParamsObj extends InferInput<typeof endowsQueryParams> {
40
+ }
39
41
  export interface CloudsearchEndowsQueryParams extends InferInput<typeof endowsQueryParams> {
40
42
  }
43
+ export interface CloudsearchEndowsQueryParamsParsed extends InferOutput<typeof endowsQueryParams> {
44
+ }
41
45
  export interface CloudsearchEndow extends InferOutput<typeof cloudsearchEndow> {
42
46
  }
43
47
  export type DocId = `${Environment}-${number}`;
@@ -29,8 +29,8 @@ export const cloudsearchEndow = object({
29
29
  });
30
30
  export const cloudSearchEndowFields = keyof(cloudsearchEndow);
31
31
  export const endowsQueryParams = object({
32
- query: str,
33
- page: pipe(string(), transform((x) => +x), integer(), minValue(1)),
32
+ query: optional(str),
33
+ page: optional(pipe(string(), transform((x) => +x), integer(), minValue(1))),
34
34
  endow_designation: optional(pipe(csvStrs, array(orgDesignation))),
35
35
  sdgs: optional(pipe(csvStrs, mapItems((x) => +x), array(unSdgNum))),
36
36
  kyc_only: optional(boolCsv),
package/dist/index.d.mts CHANGED
@@ -2,7 +2,7 @@ import type { CloudsearchEndow as EndowItem } from "./cloudsearch.mjs";
2
2
  import type { Media } from "./db.mjs";
3
3
  import type { Milestone, Program as ProgramShape } from "./schema.mjs";
4
4
  export type { Allocation, DonateMethodId, EndowDesignation, Endowment as Endow, EndowFields, EndowQueryParams, EndowUpdate, Environment, Increment, MediaQueryParams, MediaQueryParamsObj, MediaType, MediaUpdate, Milestone, MilestoneUpdate, NewMilestone, NewProgram, ProgramUpdate, SocialMediaURLs, UnSdgNum, } from "./schema.mjs";
5
- export type { CloudsearchEndow as EndowItem, CloudsearchEndowsQueryParams as EndowsQueryParams, } from "./cloudsearch.mjs";
5
+ export type { CloudsearchEndow as EndowItem, CloudsearchEndowsQueryParams as EndowsQueryParams, CloudsearchEndowsQueryParamsParsed as EndowsQueryParamsParsed, } from "./cloudsearch.mjs";
6
6
  /** client responsible on T depending on keys projected */
7
7
  export interface EndowsPage<T extends keyof EndowItem = keyof EndowItem> {
8
8
  items: Pick<EndowItem, T>[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@better-giving/endowment",
3
- "version": "1.0.29",
3
+ "version": "1.0.31",
4
4
  "peerDependencies": {
5
5
  "@better-giving/schemas": "1.0.1",
6
6
  "@better-giving/types": "1.0.1",
@@ -59,12 +59,14 @@ export const cloudsearchEndow = object({
59
59
  export const cloudSearchEndowFields = keyof(cloudsearchEndow);
60
60
 
61
61
  export const endowsQueryParams = object({
62
- query: str,
63
- page: pipe(
64
- string(),
65
- transform((x) => +x),
66
- integer(),
67
- minValue(1)
62
+ query: optional(str),
63
+ page: optional(
64
+ pipe(
65
+ string(),
66
+ transform((x) => +x),
67
+ integer(),
68
+ minValue(1)
69
+ )
68
70
  ),
69
71
  endow_designation: optional(pipe(csvStrs, array(orgDesignation))),
70
72
  sdgs: optional(
@@ -81,9 +83,15 @@ export const endowsQueryParams = object({
81
83
  fields: optional(pipe(csvStrs, array(cloudSearchEndowFields))),
82
84
  });
83
85
 
86
+ export interface CloudsearchEndowsQueryParamsObj
87
+ extends InferInput<typeof endowsQueryParams> {}
88
+
84
89
  export interface CloudsearchEndowsQueryParams
85
90
  extends InferInput<typeof endowsQueryParams> {}
86
91
 
92
+ export interface CloudsearchEndowsQueryParamsParsed
93
+ extends InferOutput<typeof endowsQueryParams> {}
94
+
87
95
  export interface CloudsearchEndow
88
96
  extends InferOutput<typeof cloudsearchEndow> {}
89
97
 
package/src/index.mts CHANGED
@@ -26,6 +26,7 @@ export type {
26
26
  export type {
27
27
  CloudsearchEndow as EndowItem,
28
28
  CloudsearchEndowsQueryParams as EndowsQueryParams,
29
+ CloudsearchEndowsQueryParamsParsed as EndowsQueryParamsParsed,
29
30
  } from "./cloudsearch.mjs";
30
31
 
31
32
  /** client responsible on T depending on keys projected */