@globus/sdk 3.8.1 → 3.9.0

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.
Files changed (37) hide show
  1. package/cjs/lib/core/authorization/AuthorizationManager.js +1 -1
  2. package/cjs/lib/core/authorization/AuthorizationManager.js.map +1 -1
  3. package/cjs/lib/core/info/version.d.ts +1 -1
  4. package/cjs/lib/core/info/version.js +1 -1
  5. package/cjs/lib/services/search/index.d.ts +1 -0
  6. package/cjs/lib/services/search/index.d.ts.map +1 -1
  7. package/cjs/lib/services/search/index.js +2 -1
  8. package/cjs/lib/services/search/index.js.map +1 -1
  9. package/cjs/lib/services/search/service/query.d.ts +114 -8
  10. package/cjs/lib/services/search/service/query.d.ts.map +1 -1
  11. package/cjs/lib/services/search/service/query.js.map +1 -1
  12. package/cjs/lib/services/search/service/search-index.d.ts +131 -0
  13. package/cjs/lib/services/search/service/search-index.d.ts.map +1 -0
  14. package/cjs/lib/services/search/service/search-index.js +67 -0
  15. package/cjs/lib/services/search/service/search-index.js.map +1 -0
  16. package/cjs/lib/services/search/types.d.ts +10 -0
  17. package/cjs/lib/services/search/types.d.ts.map +1 -1
  18. package/cjs/package.json +1 -1
  19. package/esm/lib/core/authorization/AuthorizationManager.js +1 -1
  20. package/esm/lib/core/authorization/AuthorizationManager.js.map +1 -1
  21. package/esm/lib/core/info/version.d.ts +1 -1
  22. package/esm/lib/core/info/version.js +1 -1
  23. package/esm/lib/services/search/index.d.ts +1 -0
  24. package/esm/lib/services/search/index.d.ts.map +1 -1
  25. package/esm/lib/services/search/index.js +1 -0
  26. package/esm/lib/services/search/index.js.map +1 -1
  27. package/esm/lib/services/search/service/query.d.ts +114 -8
  28. package/esm/lib/services/search/service/query.d.ts.map +1 -1
  29. package/esm/lib/services/search/service/query.js.map +1 -1
  30. package/esm/lib/services/search/service/search-index.d.ts +131 -0
  31. package/esm/lib/services/search/service/search-index.d.ts.map +1 -0
  32. package/esm/lib/services/search/service/search-index.js +64 -0
  33. package/esm/lib/services/search/service/search-index.js.map +1 -0
  34. package/esm/lib/services/search/types.d.ts +10 -0
  35. package/esm/lib/services/search/types.d.ts.map +1 -1
  36. package/package.json +1 -1
  37. package/umd/globus.production.js +1 -1
@@ -1,4 +1,42 @@
1
1
  import type { JSONFetchResponse } from '../../types.js';
2
+ import { ResultFormatVersion } from '../types.js';
3
+ /**
4
+ * @see https://docs.globus.org/api/search/reference/post_query/#gmetaresult
5
+ */
6
+ export type GMetaResult = {
7
+ subject: string;
8
+ entries: {
9
+ entry_id: string;
10
+ content: Record<string, unknown>;
11
+ matched_principal_sets: string[];
12
+ }[];
13
+ };
14
+ /**
15
+ * @see https://docs.globus.org/api/search/reference/post_query/#gfacetresult
16
+ */
17
+ export type GFacetResult = {
18
+ name: string;
19
+ value?: string;
20
+ buckets?: GBucket[];
21
+ };
22
+ /**
23
+ * @see https://docs.globus.org/api/search/reference/post_query/#gbucket
24
+ */
25
+ export type GBucket = {
26
+ value: string | GFilter;
27
+ count: number;
28
+ };
29
+ /**
30
+ * @see https://docs.globus.org/api/search/reference/post_query/#gsearchresult
31
+ */
32
+ export type GSearchResult = {
33
+ gmeta: GMetaResult;
34
+ facet_result?: GFacetResult[];
35
+ offset: number;
36
+ count: number;
37
+ total: number;
38
+ has_next_page: boolean;
39
+ };
2
40
  /**
3
41
  * @param index_id The UUID of the index to query.
4
42
  *
@@ -20,7 +58,7 @@ export declare const get: (index_id: string, options?: ({
20
58
  } & {
21
59
  query?: import("../../types.js").BaseServiceMethodOptions["query"];
22
60
  headers?: import("../../types.js").BaseServiceMethodOptions["headers"];
23
- }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<Response>;
61
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<GSearchResult>>;
24
62
  /**
25
63
  * @param index_id The UUID of the index to query.
26
64
  *
@@ -36,15 +74,83 @@ export declare const post: (index_id: string, options: ({
36
74
  limit?: number;
37
75
  advanced?: boolean;
38
76
  bypass_visible_to?: boolean;
39
- result_format_version?: Globus.Search.ResultFormatVersion;
40
- filter_principal_sets?: Array<string>;
41
- filters?: Array<Globus.Search.GFilter>;
42
- facets?: Array<Globus.Search.GFacet>;
43
- boosts?: Array<Globus.Search.GBoost>;
44
- sort?: Array<Globus.Search.GSort>;
77
+ result_format_version?: ResultFormatVersion;
78
+ filter_principal_sets?: string[];
79
+ filters?: GFilter[];
80
+ facets?: GFacet[];
81
+ boosts?: GBoost[];
82
+ sort?: GSort[];
45
83
  };
46
84
  } & {
47
85
  query?: import("../../types.js").BaseServiceMethodOptions["query"];
48
86
  headers?: import("../../types.js").BaseServiceMethodOptions["headers"];
49
- }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<Globus.Search.GSearchResult>>;
87
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<GSearchResult>>;
88
+ /**
89
+ * @see https://docs.globus.org/api/search/reference/post_query/#gfilter
90
+ */
91
+ export type GFilter = GFilterMatch | GFilterRange | GFilterExists | GFilterNot;
92
+ type GFilterTypeMatch = 'match_any' | 'match_all';
93
+ type GFilterTypeRange = 'range';
94
+ type GFilterMatch = {
95
+ type: GFilterTypeMatch;
96
+ field_name: string;
97
+ values: Array<string>;
98
+ };
99
+ type GFilterRange = {
100
+ type: GFilterTypeRange;
101
+ field_name: string;
102
+ values: Array<{
103
+ from: string;
104
+ to: string;
105
+ }>;
106
+ };
107
+ type GFilterExists = {
108
+ type: 'exists';
109
+ field_name: string;
110
+ };
111
+ type GFilterNot = {
112
+ type: 'not';
113
+ filter: GFilter;
114
+ };
115
+ type HistogramRange = {
116
+ low: number | string;
117
+ high: number | string;
118
+ };
119
+ /**
120
+ * @see https://docs.globus.org/api/search/reference/post_query/#gfacet
121
+ */
122
+ export type GFacet = {
123
+ name: string;
124
+ field_name: string;
125
+ } & ({
126
+ type: 'terms';
127
+ } | {
128
+ type: 'sum' | 'avg';
129
+ missing?: number;
130
+ } | {
131
+ type: 'date_histogram';
132
+ date_interval: DateInterval;
133
+ histogram_range?: HistogramRange;
134
+ } | {
135
+ type: 'numeric_histogram';
136
+ size: string;
137
+ interval: number;
138
+ histogram_range: HistogramRange;
139
+ });
140
+ type DateInterval = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
141
+ /**
142
+ * @see https://docs.globus.org/api/search/reference/post_query/#gboost
143
+ */
144
+ export type GBoost = {
145
+ field_name: string;
146
+ factor: number;
147
+ };
148
+ /**
149
+ * @see https://docs.globus.org/api/search/reference/post_query/#gsort
150
+ */
151
+ export type GSort = {
152
+ field_name: string;
153
+ order: 'asc' | 'desc';
154
+ };
155
+ export {};
50
156
  //# sourceMappingURL=query.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/services/search/service/query.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAgC,MAAM,gBAAgB,CAAC;AAItF;;;;GAIG;AACH,eAAO,MAAM,GAAG;IAaZ;;OAEG;YACK;QACN,CAAC,EAAE,MAAM,CAAC;QACV,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAC9B,KAAK,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAC5B,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QACrC,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC;;;;kGAEJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,IAAI;IAkBb;;OAEG;aACM;QACP,CAAC,EAAE,MAAM,CAAC;QACV,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC;QAC1D,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KACnC;;;;iFA7BF,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CA+BxD,CAAC"}
1
+ {"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/services/search/service/query.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAgC,MAAM,gBAAgB,CAAC;AAGtF,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;KAClC,EAAE,CAAC;CACL,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,WAAW,CAAC;IACnB,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,GAAG;IAiBZ;;OAEG;YACK;QACN,CAAC,EAAE,MAAM,CAAC;QACV,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAC9B,KAAK,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAC5B,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QACrC,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC;;;;iFAxBF,OAAO,CAAC,iBAAiB,CAAC,aAAa,CAAC,CA0B1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,IAAI;IAkBb;;OAEG;aACM;QACP,CAAC,EAAE,MAAM,CAAC;QACV,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,qBAAqB,CAAC,EAAE,mBAAmB,CAAC;QAC5C,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;QACjC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC;KAChB;;;;iFA7BF,OAAO,CAAC,iBAAiB,CAAC,aAAa,CAAC,CA+B1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,UAAU,CAAC;AAE/E,KAAK,gBAAgB,GAAG,WAAW,GAAG,WAAW,CAAC;AAClD,KAAK,gBAAgB,GAAG,OAAO,CAAC;AAEhC,KAAK,YAAY,GAAG;IAClB,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB,CAAC;AACF,KAAK,YAAY,GAAG;IAClB,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7C,CAAC;AACF,KAAK,aAAa,GAAG;IACnB,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AACF,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,KAAK,cAAc,GAAG;IAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,CACA;IACE,IAAI,EAAE,OAAO,CAAC;CACf,GACD;IACE,IAAI,EAAE,KAAK,GAAG,KAAK,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,aAAa,EAAE,YAAY,CAAC;IAC5B,eAAe,CAAC,EAAE,cAAc,CAAC;CAClC,GACD;IACE,IAAI,EAAE,mBAAmB,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,cAAc,CAAC;CACjC,CACJ,CAAC;AAEF,KAAK,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjG;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;CACvB,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"query.js","sourceRoot":"","sources":["../../../../../../src/lib/services/search/service/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAI/D,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;GAIG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,UAAU,QAAQ,EAAE,OAAQ,EAAE,UAAW;IAC1D,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,MAAM;QACpB,IAAI,EAAE,aAAa,QAAQ,SAAS;KACrC,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAgBC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,UAClB,QAAQ,EACR,OAAO,EACP,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,MAAM;QACpB,IAAI,EAAE,aAAa,QAAQ,SAAS;QACpC,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAoBC,CAAC"}
1
+ {"version":3,"file":"query.js","sourceRoot":"","sources":["../../../../../../src/lib/services/search/service/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAI/D,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AA4C1C;;;;GAIG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,UACjB,QAAQ,EACR,OAAQ,EACR,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,MAAM;QACpB,IAAI,EAAE,aAAa,QAAQ,SAAS;KACrC,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAgBC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,UAClB,QAAQ,EACR,OAAO,EACP,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,MAAM;QACpB,IAAI,EAAE,aAAa,QAAQ,SAAS;QACpC,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAoBC,CAAC"}
@@ -0,0 +1,131 @@
1
+ import type { JSONFetchResponse } from '../../types.js';
2
+ /**
3
+ * @see https://docs.globus.org/api/search/reference/index_list/#indexwithpermissions
4
+ */
5
+ type IndexWithPermissions = {
6
+ permissions: string[];
7
+ display_name: string;
8
+ id: string;
9
+ description: string;
10
+ creation_date: string;
11
+ is_trial: boolean;
12
+ subscription_id: string;
13
+ max_size_in_mb: number;
14
+ size_in_mb: number;
15
+ num_subjects: number;
16
+ num_entries: number;
17
+ };
18
+ type GSearchIndex = {
19
+ display_name: string;
20
+ id: string;
21
+ description: string;
22
+ creation_date: string;
23
+ is_trial: boolean;
24
+ subscription_id: string;
25
+ max_size_in_mb: number;
26
+ size_in_mb: number;
27
+ num_subjects: number;
28
+ num_entries: number;
29
+ };
30
+ /**
31
+ * @see https://docs.globus.org/api/search/reference/index_show/
32
+ */
33
+ export declare const get: (index_id: string, options?: {
34
+ query?: import("../../types.js").BaseServiceMethodOptions["query"];
35
+ headers?: import("../../types.js").BaseServiceMethodOptions["headers"];
36
+ } | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<GSearchIndex>>;
37
+ /**
38
+ * @see https://docs.globus.org/api/search/reference/index_list/
39
+ */
40
+ export declare const getAll: (options?: import("../../types.js").BaseServiceMethodOptions | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<IndexWithPermissions[]>>;
41
+ type IndexCreate = {
42
+ display_name: string;
43
+ description: string;
44
+ };
45
+ /**
46
+ * @see https://docs.globus.org/api/search/reference/index_create/
47
+ */
48
+ export declare const create: (options: ({
49
+ payload: IndexCreate;
50
+ } & import("../../types.js").BaseServiceMethodOptions) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<GSearchIndex>>;
51
+ type IndexDeleteResponse = {
52
+ index_id: string;
53
+ acknowledged: boolean;
54
+ };
55
+ /**
56
+ * @see https://docs.globus.org/api/search/reference/index_delete/
57
+ */
58
+ export declare const remove: (index_id: string, options?: ({
59
+ query?: never;
60
+ payload?: never;
61
+ } & {
62
+ query?: import("../../types.js").BaseServiceMethodOptions["query"];
63
+ headers?: import("../../types.js").BaseServiceMethodOptions["headers"];
64
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<IndexDeleteResponse>>;
65
+ type IndexReopenResponse = {
66
+ index_id: string;
67
+ acknowledged: boolean;
68
+ };
69
+ /**
70
+ * @see https://docs.globus.org/api/search/reference/index_reopen/
71
+ */
72
+ export declare const reopen: (index_id: string, options?: ({
73
+ query?: never;
74
+ payload?: never;
75
+ } & {
76
+ query?: import("../../types.js").BaseServiceMethodOptions["query"];
77
+ headers?: import("../../types.js").BaseServiceMethodOptions["headers"];
78
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<IndexReopenResponse>>;
79
+ type IngestResponse = {
80
+ task_id: string;
81
+ as_identity: string;
82
+ success: boolean;
83
+ num_documents_ingested: number;
84
+ };
85
+ /**
86
+ * A mapping from field names (dotted) to the types for those fields. Currently only supports `geo_point` and `geo_shape` as types.
87
+ */
88
+ type FieldMapping = Record<string, 'geo_point' | 'geo_shape' | string>;
89
+ /**
90
+ * A `GIngest` document is a wrapper around a {@link GMetaList} or {@link GMetaEntry} which supplies attributes relevant to the ingest and indexing of metadata into the Globus Search service.
91
+ * @see https://docs.globus.org/api/search/reference/ingest/#gingest
92
+ */
93
+ type GIngest = {
94
+ ingest_type: string;
95
+ ingest_data: Record<string, unknown>;
96
+ field_mapping?: FieldMapping;
97
+ } | {
98
+ ingest_type: 'GMetaList';
99
+ ingest_data: GMetaList;
100
+ field_mapping?: FieldMapping;
101
+ } | {
102
+ ingest_type: 'GMetaEntry';
103
+ ingest_data: GMetaEntry;
104
+ field_mapping?: FieldMapping;
105
+ };
106
+ /**
107
+ * A GMetaList is a collection of {@link GMetaEntry} documents.
108
+ * @see https://docs.globus.org/api/search/reference/ingest/#gmetalist
109
+ */
110
+ type GMetaList = {
111
+ gmeta: GMetaEntry[];
112
+ };
113
+ /**
114
+ * A GMetaEntry is a single block of data pertaining to a given subject.
115
+ * @see https://docs.globus.org/api/search/reference/ingest/#gmetaentry
116
+ */
117
+ type GMetaEntry = {
118
+ id?: string;
119
+ subject: string;
120
+ visible_to: 'public' | 'all_authenticated_users' | string;
121
+ principal_sets: Record<string, unknown>;
122
+ content: Record<string, unknown>;
123
+ };
124
+ export declare const ingest: (index_id: string, options?: ({
125
+ payload: GIngest;
126
+ } & {
127
+ query?: import("../../types.js").BaseServiceMethodOptions["query"];
128
+ headers?: import("../../types.js").BaseServiceMethodOptions["headers"];
129
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<IngestResponse>>;
130
+ export {};
131
+ //# sourceMappingURL=search-index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search-index.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/services/search/service/search-index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iBAAiB,EAGlB,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,KAAK,oBAAoB,GAAG;IAC1B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,YAAY,GAAG;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG;;;gFAIb,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAUU,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,MAAM,6IAGhB,OAAO,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,CAAC,CAUvB,CAAC;AAE9B,KAAK,WAAW,GAAG;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;aAYR,WAAW;qIAZiC,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAa5F,CAAC;AAEH,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;YAkBP,KAAK;cACH,KAAK;;;;iFAfhB,OAAO,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAiBhD,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;YAkBP,KAAK;cACH,KAAK;;;;iFAfhB,OAAO,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAiBhD,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC,CAAC;AAEvE;;;GAGG;AACH,KAAK,OAAO,GACR;IACE,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B,GACD;IACE,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B,GACD;IACE,WAAW,EAAE,YAAY,CAAC;IAC1B,WAAW,EAAE,UAAU,CAAC;IACxB,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B,CAAC;AAEN;;;GAGG;AACH,KAAK,SAAS,GAAG;IACf,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,KAAK,UAAU,GAAG;IAChB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,QAAQ,GAAG,yBAAyB,GAAG,MAAM,CAAC;IAC1D,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,CAAC;AAEF,eAAO,MAAM,MAAM;aAkBN,OAAO;;;;iFAdjB,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAgB3C,CAAC"}
@@ -0,0 +1,64 @@
1
+ import { HTTP_METHODS, serviceRequest } from '../../shared.js';
2
+ import { ID, SCOPES } from '../config.js';
3
+ /**
4
+ * @see https://docs.globus.org/api/search/reference/index_show/
5
+ */
6
+ export const get = function (index_id, options, sdkOptions) {
7
+ return serviceRequest({
8
+ service: ID,
9
+ // scope: SCOPES.ALL,
10
+ path: `/v1/index/${index_id}`,
11
+ }, options, sdkOptions);
12
+ };
13
+ /**
14
+ * @see https://docs.globus.org/api/search/reference/index_list/
15
+ */
16
+ export const getAll = function (options, sdkOptions) {
17
+ return serviceRequest({
18
+ service: ID,
19
+ scope: SCOPES.ALL,
20
+ path: `/v1/index_list`,
21
+ }, options, sdkOptions);
22
+ };
23
+ /**
24
+ * @see https://docs.globus.org/api/search/reference/index_create/
25
+ */
26
+ export const create = function (options, sdkOptions) {
27
+ return serviceRequest({
28
+ service: ID,
29
+ scope: SCOPES.ALL,
30
+ path: `/v1/index`,
31
+ method: HTTP_METHODS.POST,
32
+ }, options, sdkOptions);
33
+ };
34
+ /**
35
+ * @see https://docs.globus.org/api/search/reference/index_delete/
36
+ */
37
+ export const remove = function (index_id, options, sdkOptions) {
38
+ return serviceRequest({
39
+ service: ID,
40
+ scope: SCOPES.ALL,
41
+ path: `/v1/index/${index_id}`,
42
+ method: HTTP_METHODS.DELETE,
43
+ }, options, sdkOptions);
44
+ };
45
+ /**
46
+ * @see https://docs.globus.org/api/search/reference/index_reopen/
47
+ */
48
+ export const reopen = function (index_id, options, sdkOptions) {
49
+ return serviceRequest({
50
+ service: ID,
51
+ scope: SCOPES.ALL,
52
+ path: `/v1/index/${index_id}/reopen`,
53
+ method: HTTP_METHODS.POST,
54
+ }, options, sdkOptions);
55
+ };
56
+ export const ingest = function (index_id, options, sdkOptions) {
57
+ return serviceRequest({
58
+ service: ID,
59
+ scope: SCOPES.ALL,
60
+ path: `/v1/index/${index_id}/ingest`,
61
+ method: HTTP_METHODS.POST,
62
+ }, options, sdkOptions);
63
+ };
64
+ //# sourceMappingURL=search-index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search-index.js","sourceRoot":"","sources":["../../../../../../src/lib/services/search/service/search-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAsC1C;;GAEG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,UACjB,QAAQ,EACR,OAAQ,EACR,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,qBAAqB;QACrB,IAAI,EAAE,aAAa,QAAQ,EAAE;KAC9B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAAoD,CAAC;AAErD;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UACpB,OAAQ,EACR,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,GAAG;QACjB,IAAI,EAAE,gBAAgB;KACvB,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAA6B,CAAC;AAO9B;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,OAAO,EAAE,UAAW;IAClD,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,GAAG;QACjB,IAAI,EAAE,WAAW;QACjB,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAEE,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UACpB,QAAQ,EACR,OAAQ,EACR,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,GAAG;QACjB,IAAI,EAAE,aAAa,QAAQ,EAAE;QAC7B,MAAM,EAAE,YAAY,CAAC,MAAM;KAC5B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UACpB,QAAQ,EACR,OAAQ,EACR,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,GAAG;QACjB,IAAI,EAAE,aAAa,QAAQ,SAAS;QACpC,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAuDF,MAAM,CAAC,MAAM,MAAM,GAAG,UACpB,QAAQ,EACR,OAAQ,EACR,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,GAAG;QACjB,IAAI,EAAE,aAAa,QAAQ,SAAS;QACpC,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAKC,CAAC"}
@@ -1,2 +1,12 @@
1
1
  export type ResultFormatVersion = '2019-08-27' | '2017-09-01';
2
+ /**
3
+ * @see https://docs.globus.org/api/search/errors/
4
+ */
5
+ export type GError = {
6
+ message: string;
7
+ code: string;
8
+ request_id: string;
9
+ status: number;
10
+ error_data?: Record<string, unknown> | GError[];
11
+ };
2
12
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/lib/services/search/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,YAAY,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/lib/services/search/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,YAAY,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAAC;CACjD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@globus/sdk",
3
- "version": "3.8.1",
3
+ "version": "3.9.0",
4
4
  "private": false,
5
5
  "description": "The Globus SDK for JavaScript",
6
6
  "main": "cjs/index.js",