@globus/sdk 4.1.0 → 4.3.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 (34) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/core/authorization/index.js +51 -7
  3. package/dist/cjs/core/authorization/index.js.map +2 -2
  4. package/dist/cjs/core/info/index.js +1 -1
  5. package/dist/cjs/core/info/index.js.map +1 -1
  6. package/dist/cjs/index.js +65 -8
  7. package/dist/cjs/index.js.map +3 -3
  8. package/dist/cjs/services/globus-connect-server/client.js +2 -2
  9. package/dist/cjs/services/globus-connect-server/client.js.map +1 -1
  10. package/dist/esm/core/authorization/AuthorizationManager.d.ts +8 -0
  11. package/dist/esm/core/authorization/AuthorizationManager.d.ts.map +1 -1
  12. package/dist/esm/core/authorization/AuthorizationManager.js +17 -6
  13. package/dist/esm/core/authorization/AuthorizationManager.js.map +1 -1
  14. package/dist/esm/core/authorization/TokenLookup.d.ts +46 -11
  15. package/dist/esm/core/authorization/TokenLookup.d.ts.map +1 -1
  16. package/dist/esm/core/authorization/TokenLookup.js +40 -0
  17. package/dist/esm/core/authorization/TokenLookup.js.map +1 -1
  18. package/dist/esm/core/info/version.d.ts +1 -1
  19. package/dist/esm/core/info/version.js +1 -1
  20. package/dist/esm/package.json +1 -1
  21. package/dist/esm/services/auth/config.js +1 -1
  22. package/dist/esm/services/auth/config.js.map +1 -1
  23. package/dist/esm/services/auth/types.d.ts +19 -0
  24. package/dist/esm/services/auth/types.d.ts.map +1 -1
  25. package/dist/esm/services/flows/service/flows.d.ts +42 -0
  26. package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
  27. package/dist/esm/services/flows/service/flows.js +12 -0
  28. package/dist/esm/services/flows/service/flows.js.map +1 -1
  29. package/dist/esm/services/search/service/search-index.d.ts +13 -7
  30. package/dist/esm/services/search/service/search-index.d.ts.map +1 -1
  31. package/dist/esm/services/search/service/search-index.js.map +1 -1
  32. package/dist/umd/globus.production.js +2 -2
  33. package/dist/umd/globus.production.js.map +3 -3
  34. package/package.json +1 -1
@@ -1,19 +1,54 @@
1
1
  import { AuthorizationManager } from './AuthorizationManager.js';
2
- import type { Token } from '../../services/auth/types.js';
2
+ import type { Token, TokenResponse } from '../../services/auth/types.js';
3
+ export type StoredToken = Token & {
4
+ /**
5
+ * Tokens stored before the introduction of the `__metadata` field will be missing this property.
6
+ * @since 4.3.0
7
+ */
8
+ __metadata?: {
9
+ /**
10
+ * The timestamp when the token was added to the storage as a number of milliseconds since the Unix epoch.
11
+ *
12
+ * **IMPORTANT**: This value might **not** represent the time when the token was created by the authorization server.
13
+ */
14
+ created: number;
15
+ /**
16
+ * The timestamp when the token will expire as a number of milliseconds since the Unix epoch, based
17
+ * on the `expires_in` value from the token response and the time when the token was stored.
18
+ */
19
+ expires: number | null;
20
+ };
21
+ };
22
+ /**
23
+ * @todo In the next major version, we should consider renaming this class to `TokenManager`,
24
+ * since it's usage has expanded beyond just looking up tokens.
25
+ */
3
26
  export declare class TokenLookup {
4
27
  #private;
5
28
  constructor(options: {
6
29
  manager: AuthorizationManager;
7
30
  });
8
- get auth(): Token | null;
9
- get transfer(): Token | null;
10
- get flows(): Token | null;
11
- get groups(): Token | null;
12
- get search(): Token | null;
13
- get timer(): Token | null;
14
- get compute(): Token | null;
15
- gcs(endpoint: string): Token | null;
16
- getByResourceServer(resourceServer: string): Token | null;
17
- getAll(): Token[];
31
+ get auth(): StoredToken | null;
32
+ get transfer(): StoredToken | null;
33
+ get flows(): StoredToken | null;
34
+ get groups(): StoredToken | null;
35
+ get search(): StoredToken | null;
36
+ get timer(): StoredToken | null;
37
+ get compute(): StoredToken | null;
38
+ gcs(endpoint: string): StoredToken | null;
39
+ getByResourceServer(resourceServer: string): StoredToken | null;
40
+ getAll(): StoredToken[];
41
+ /**
42
+ * Add a token to the storage.
43
+ */
44
+ add(token: Token | TokenResponse): void;
45
+ /**
46
+ * Determines whether or not a stored token is expired.
47
+ * @param token The token to check.
48
+ * @param augment An optional number of milliseconds to add to the current time when checking the expiration.
49
+ * @returns `true` if the token is expired, `false` if it is not expired, and `undefined` if the expiration status cannot be determined
50
+ * based on the token's metadata. This can happen if the token is missing the `__metadata` field or the `expires` field.
51
+ */
52
+ static isTokenExpired(token: StoredToken | null, augment?: number): boolean | undefined;
18
53
  }
19
54
  //# sourceMappingURL=TokenLookup.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"TokenLookup.d.ts","sourceRoot":"","sources":["../../../../src/core/authorization/TokenLookup.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAgB1D,qBAAa,WAAW;;gBAGV,OAAO,EAAE;QAAE,OAAO,EAAE,oBAAoB,CAAA;KAAE;IAatD,IAAI,IAAI,IAAI,KAAK,GAAG,IAAI,CAEvB;IAED,IAAI,QAAQ,IAAI,KAAK,GAAG,IAAI,CAE3B;IAED,IAAI,KAAK,IAAI,KAAK,GAAG,IAAI,CAExB;IAED,IAAI,MAAM,IAAI,KAAK,GAAG,IAAI,CAEzB;IAED,IAAI,MAAM,IAAI,KAAK,GAAG,IAAI,CAEzB;IAED,IAAI,KAAK,IAAI,KAAK,GAAG,IAAI,CAExB;IAED,IAAI,OAAO,IAAI,KAAK,GAAG,IAAI,CAE1B;IAED,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IAInC,mBAAmB,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IAIzD,MAAM,IAAI,KAAK,EAAE;CAWlB"}
1
+ {"version":3,"file":"TokenLookup.d.ts","sourceRoot":"","sources":["../../../../src/core/authorization/TokenLookup.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAEzE,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE;QACX;;;;WAIG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB,CAAC;CACH,CAAC;AAgBF;;;GAGG;AACH,qBAAa,WAAW;;gBAGV,OAAO,EAAE;QAAE,OAAO,EAAE,oBAAoB,CAAA;KAAE;IAatD,IAAI,IAAI,IAAI,WAAW,GAAG,IAAI,CAE7B;IAED,IAAI,QAAQ,IAAI,WAAW,GAAG,IAAI,CAEjC;IAED,IAAI,KAAK,IAAI,WAAW,GAAG,IAAI,CAE9B;IAED,IAAI,MAAM,IAAI,WAAW,GAAG,IAAI,CAE/B;IAED,IAAI,MAAM,IAAI,WAAW,GAAG,IAAI,CAE/B;IAED,IAAI,KAAK,IAAI,WAAW,GAAG,IAAI,CAE9B;IAED,IAAI,OAAO,IAAI,WAAW,GAAG,IAAI,CAEhC;IAED,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IAIzC,mBAAmB,CAAC,cAAc,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IAI/D,MAAM,IAAI,WAAW,EAAE;IAYvB;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,aAAa;IAoBhC;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,EAAE,OAAO,GAAE,MAAU,GAAG,OAAO,GAAG,SAAS;CAQ3F"}
@@ -27,6 +27,10 @@ function getTokenFromStorage(key) {
27
27
  }
28
28
  return token;
29
29
  }
30
+ /**
31
+ * @todo In the next major version, we should consider renaming this class to `TokenManager`,
32
+ * since it's usage has expanded beyond just looking up tokens.
33
+ */
30
34
  export class TokenLookup {
31
35
  constructor(options) {
32
36
  _TokenLookup_instances.add(this);
@@ -71,6 +75,42 @@ export class TokenLookup {
71
75
  }, []);
72
76
  return entries.filter(isToken);
73
77
  }
78
+ /**
79
+ * Add a token to the storage.
80
+ */
81
+ add(token) {
82
+ var _a;
83
+ const created = Date.now();
84
+ const expires = created + token.expires_in * 1000;
85
+ getStorage().set(`${__classPrivateFieldGet(this, _TokenLookup_manager, "f").storageKeyPrefix}${token.resource_server}`, Object.assign(Object.assign({}, token), {
86
+ /**
87
+ * Add metadata to the token to track when it was created and when it expires.
88
+ */
89
+ __metadata: {
90
+ created,
91
+ expires,
92
+ } }));
93
+ if ('other_tokens' in token) {
94
+ (_a = token.other_tokens) === null || _a === void 0 ? void 0 : _a.forEach((t) => {
95
+ this.add(t);
96
+ });
97
+ }
98
+ }
99
+ /**
100
+ * Determines whether or not a stored token is expired.
101
+ * @param token The token to check.
102
+ * @param augment An optional number of milliseconds to add to the current time when checking the expiration.
103
+ * @returns `true` if the token is expired, `false` if it is not expired, and `undefined` if the expiration status cannot be determined
104
+ * based on the token's metadata. This can happen if the token is missing the `__metadata` field or the `expires` field.
105
+ */
106
+ static isTokenExpired(token, augment = 0) {
107
+ /* eslint-disable no-underscore-dangle */
108
+ if (!token || !token.__metadata || typeof token.__metadata.expires !== 'number') {
109
+ return undefined;
110
+ }
111
+ return Date.now() + augment >= token.__metadata.expires;
112
+ /* eslint-enable no-underscore-dangle */
113
+ }
74
114
  }
75
115
  _TokenLookup_manager = new WeakMap(), _TokenLookup_instances = new WeakSet(), _TokenLookup_getClientStorageEntry = function _TokenLookup_getClientStorageEntry(identifier) {
76
116
  return getTokenFromStorage(`${__classPrivateFieldGet(this, _TokenLookup_manager, "f").storageKeyPrefix}${identifier}`);
@@ -1 +1 @@
1
- {"version":3,"file":"TokenLookup.js","sourceRoot":"","sources":["../../../../src/core/authorization/TokenLookup.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAgB,MAAM,cAAc,CAAC;AAKtD,SAAS,mBAAmB,CAAC,GAAW;IACtC,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC;IAC5C,IAAI,KAAK,GAAiB,IAAI,CAAC;IAC/B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,KAAK,GAAG,MAAM,CAAC;QACjB,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,QAAQ;IACV,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,OAAO,WAAW;IAGtB,YAAY,OAA0C;;QAFtD,uCAA+B;QAG7B,uBAAA,IAAI,wBAAY,OAAO,CAAC,OAAO,MAAA,CAAC;IAClC,CAAC;IAWD,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,mBAAmB,CAAC,cAAsB;QACxC,OAAO,uBAAA,IAAI,kEAAuB,MAA3B,IAAI,EAAwB,cAAc,CAAC,CAAC;IACrD,CAAC;IAED,MAAM;QACJ,MAAM,OAAO,GAAG,UAAU,EAAE;aACzB,IAAI,EAAE;aACN,MAAM,CAAC,CAAC,GAAqB,EAAE,GAAG,EAAE,EAAE;YACrC,IAAI,GAAG,CAAC,UAAU,CAAC,uBAAA,IAAI,4BAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACnD,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;YACrC,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CACF;+JAxDwB,UAAkB;IACvC,OAAO,mBAAmB,CAAC,GAAG,uBAAA,IAAI,4BAAS,CAAC,gBAAgB,GAAG,UAAU,EAAE,CAAC,CAAC;AAC/E,CAAC,6EAEmB,OAAgB;;IAClC,MAAM,cAAc,GAAG,MAAA,MAAM,CAAC,gBAAgB,0CAAG,OAAO,CAAC,CAAC;IAC1D,OAAO,uBAAA,IAAI,kEAAuB,MAA3B,IAAI,EAAwB,cAAc,CAAC,CAAC;AACrD,CAAC"}
1
+ {"version":3,"file":"TokenLookup.js","sourceRoot":"","sources":["../../../../src/core/authorization/TokenLookup.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAgB,MAAM,cAAc,CAAC;AAyBtD,SAAS,mBAAmB,CAAC,GAAW;IACtC,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC;IAC5C,IAAI,KAAK,GAAuB,IAAI,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,KAAK,GAAG,MAAM,CAAC;QACjB,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,QAAQ;IACV,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,WAAW;IAGtB,YAAY,OAA0C;;QAFtD,uCAA+B;QAG7B,uBAAA,IAAI,wBAAY,OAAO,CAAC,OAAO,MAAA,CAAC;IAClC,CAAC;IAWD,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,+DAAoB,MAAxB,IAAI,EAAqB,QAAQ,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,mBAAmB,CAAC,cAAsB;QACxC,OAAO,uBAAA,IAAI,kEAAuB,MAA3B,IAAI,EAAwB,cAAc,CAAC,CAAC;IACrD,CAAC;IAED,MAAM;QACJ,MAAM,OAAO,GAAG,UAAU,EAAE;aACzB,IAAI,EAAE;aACN,MAAM,CAAC,CAAC,GAA2B,EAAE,GAAG,EAAE,EAAE;YAC3C,IAAI,GAAG,CAAC,UAAU,CAAC,uBAAA,IAAI,4BAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACnD,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;YACrC,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,KAA4B;;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;QAClD,UAAU,EAAE,CAAC,GAAG,CAAC,GAAG,uBAAA,IAAI,4BAAS,CAAC,gBAAgB,GAAG,KAAK,CAAC,eAAe,EAAE,kCACvE,KAAK;YACR;;eAEG;YACH,UAAU,EAAE;gBACV,OAAO;gBACP,OAAO;aACR,IACD,CAAC;QACH,IAAI,cAAc,IAAI,KAAK,EAAE,CAAC;YAC5B,MAAA,KAAK,CAAC,YAAY,0CAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBAChC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,KAAyB,EAAE,UAAkB,CAAC;QAClE,yCAAyC;QACzC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChF,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;QACxD,wCAAwC;IAC1C,CAAC;CACF;+JA/FwB,UAAkB;IACvC,OAAO,mBAAmB,CAAC,GAAG,uBAAA,IAAI,4BAAS,CAAC,gBAAgB,GAAG,UAAU,EAAE,CAAC,CAAC;AAC/E,CAAC,6EAEmB,OAAgB;;IAClC,MAAM,cAAc,GAAG,MAAA,MAAM,CAAC,gBAAgB,0CAAG,OAAO,CAAC,CAAC;IAC1D,OAAO,uBAAA,IAAI,kEAAuB,MAA3B,IAAI,EAAwB,cAAc,CAAC,CAAC;AACrD,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "4.0.0";
1
+ export declare const VERSION = "4.3.0";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1,4 +1,4 @@
1
1
  // x-release-please-start-version
2
- export const VERSION = '4.0.0';
2
+ export const VERSION = '4.3.0';
3
3
  // x-release-please-end
4
4
  //# sourceMappingURL=version.js.map
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "type": "module",
3
- "version": "4.1.0"
3
+ "version": "4.3.0"
4
4
  }
@@ -19,7 +19,7 @@ export const SCOPES = {
19
19
  export const RESOURCE_SERVERS = {
20
20
  [ID]: 'auth.globus.org',
21
21
  [TRANSFER]: 'transfer.api.globus.org',
22
- [FLOWS]: 'flows.api.globus.org',
22
+ [FLOWS]: 'flows.globus.org',
23
23
  [GROUPS]: 'groups.api.globus.org',
24
24
  [SEARCH]: 'search.api.globus.org',
25
25
  [TIMER]: '524230d7-ea86-4a52-8312-86065a9e0417',
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../src/services/auth/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,EAAE,IAAI,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,EAAE,IAAI,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,EAAE,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAIrD,MAAM,CAAC,MAAM,EAAE,GAAG,MAAe,CAAC;AAClC,MAAM,CAAC,MAAM,KAAK,GAAyC;IACzD,WAAW,EAAE,gCAAgC;IAC7C,OAAO,EAAE,4BAA4B;IACrC,UAAU,EAAE,iBAAiB;IAC7B,IAAI,EAAE,yBAAyB;IAC/B,OAAO,EAAE,4BAA4B;IACrC,OAAO,EAAE,yBAAyB;CACnC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,eAAe,EAAE,uDAAuD;CACzE,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,CAAC,EAAE,CAAC,EAAE,iBAAiB;IACvB,CAAC,QAAQ,CAAC,EAAE,yBAAyB;IACrC,CAAC,KAAK,CAAC,EAAE,sBAAsB;IAC/B,CAAC,MAAM,CAAC,EAAE,uBAAuB;IACjC,CAAC,MAAM,CAAC,EAAE,uBAAuB;IACjC,CAAC,KAAK,CAAC,EAAE,sCAAsC;IAC/C,CAAC,OAAO,CAAC,EAAE,eAAe;CAC3B,CAAC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../src/services/auth/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,EAAE,IAAI,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,EAAE,IAAI,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,EAAE,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAIrD,MAAM,CAAC,MAAM,EAAE,GAAG,MAAe,CAAC;AAClC,MAAM,CAAC,MAAM,KAAK,GAAyC;IACzD,WAAW,EAAE,gCAAgC;IAC7C,OAAO,EAAE,4BAA4B;IACrC,UAAU,EAAE,iBAAiB;IAC7B,IAAI,EAAE,yBAAyB;IAC/B,OAAO,EAAE,4BAA4B;IACrC,OAAO,EAAE,yBAAyB;CACnC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,eAAe,EAAE,uDAAuD;CACzE,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,CAAC,EAAE,CAAC,EAAE,iBAAiB;IACvB,CAAC,QAAQ,CAAC,EAAE,yBAAyB;IACrC,CAAC,KAAK,CAAC,EAAE,kBAAkB;IAC3B,CAAC,MAAM,CAAC,EAAE,uBAAuB;IACjC,CAAC,MAAM,CAAC,EAAE,uBAAuB;IACjC,CAAC,KAAK,CAAC,EAAE,sCAAsC;IAC/C,CAAC,OAAO,CAAC,EAAE,eAAe;CAC3B,CAAC"}
@@ -1,13 +1,32 @@
1
1
  import type { JwtPayload } from 'jwt-decode';
2
2
  export type Token = {
3
+ /**
4
+ * @see https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.12
5
+ */
3
6
  access_token: string;
7
+ /**
8
+ * @see https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.4
9
+ */
4
10
  scope: string;
11
+ /**
12
+ * The lifetime in seconds of the access token.
13
+ * @see https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.14
14
+ */
5
15
  expires_in: number;
16
+ /**
17
+ * @see https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.13
18
+ */
6
19
  token_type: string;
7
20
  resource_server: string;
21
+ /**
22
+ * @see https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.17
23
+ */
8
24
  refresh_token?: string;
9
25
  };
10
26
  export type TokenWithRefresh = Token & {
27
+ /**
28
+ * @see https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.17
29
+ */
11
30
  refresh_token: string;
12
31
  };
13
32
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/services/auth/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,MAAM,KAAK,GAAG;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC;CACxB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,GAC/E,eAAe,GAAG;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;CAClC,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/services/auth/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG;IACrC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC;CACxB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,GAC/E,eAAe,GAAG;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;CAClC,CAAC"}
@@ -1,3 +1,4 @@
1
+ import type { JSONFetchResponse } from '../../types.js';
1
2
  /**
2
3
  * @see https://globusonline.github.io/globus-flows/#tag/Flows/paths/~1flows/get
3
4
  */
@@ -37,4 +38,45 @@ export declare const run: (flow_id: string, options?: ({
37
38
  query?: import("../../types.js").BaseServiceMethodOptions["query"];
38
39
  headers?: import("../../types.js").BaseServiceMethodOptions["headers"];
39
40
  }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<Response>;
41
+ type ValidateSuccessResponse = {
42
+ scopes: Record<string, any>;
43
+ };
44
+ /**
45
+ * An error that was generated during validation that includes the location of the error.
46
+ */
47
+ export type ValidationLocationError = {
48
+ /**
49
+ * The location of the error represents the path to the property that caused the error.
50
+ */
51
+ loc: string[];
52
+ msg: string;
53
+ type: string;
54
+ };
55
+ type ValidateErrorResponse = {
56
+ error: {
57
+ code: string;
58
+ /**
59
+ * When `detail` is a string, it is a general error message and cannot be mapped to a specific location
60
+ * in the provided payload.
61
+ */
62
+ detail: string | ValidationLocationError[];
63
+ /**
64
+ * `message` being available is dependent on the error code.
65
+ */
66
+ message?: string;
67
+ };
68
+ debug_id: string;
69
+ };
70
+ /**
71
+ * Validate a flow definition and its schema.
72
+ * @see https://globusonline.github.io/globus-flows/#tag/Flows/paths/~1flows~1validate/post
73
+ */
74
+ export declare const validate: (options: ({
75
+ query?: never;
76
+ payload: {
77
+ definition: Record<string, any>;
78
+ input_schema?: Record<string, any>;
79
+ };
80
+ } & import("../../types.js").BaseServiceMethodOptions) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<ValidateSuccessResponse | ValidateErrorResponse>>;
81
+ export {};
40
82
  //# sourceMappingURL=flows.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"flows.d.ts","sourceRoot":"","sources":["../../../../../src/services/flows/service/flows.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,MAAM;YAWT,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;cACpB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;sJAChC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,GAAG;;;kGAUqD,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,MAAM;YAcP,KAAK;cACH,KAAK;;;;kGAElB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,GAAG;YAcJ,KAAK;aACJ;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB;;;;kGAEJ,CAAC"}
1
+ {"version":3,"file":"flows.d.ts","sourceRoot":"","sources":["../../../../../src/services/flows/service/flows.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,iBAAiB,EAGlB,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,MAAM;YAWT,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;cACpB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;sJAChC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,GAAG;;;kGAUqD,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,MAAM;YAcP,KAAK;cACH,KAAK;;;;kGAElB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,GAAG;YAcJ,KAAK;aACJ;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB;;;;kGAEJ,CAAC;AAEF,KAAK,uBAAuB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,MAAM,EAAE,MAAM,GAAG,uBAAuB,EAAE,CAAC;QAC3C;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ;YAeX,KAAK;aACJ;QACP,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACpC;qIAhBA,OAAO,CAAC,iBAAiB,CAAC,uBAAuB,GAAG,qBAAqB,CAAC,CAiB3E,CAAC"}
@@ -43,4 +43,16 @@ export const run = function (flow_id, options, sdkOptions) {
43
43
  method: HTTP_METHODS.POST,
44
44
  }, options, sdkOptions);
45
45
  };
46
+ /**
47
+ * Validate a flow definition and its schema.
48
+ * @see https://globusonline.github.io/globus-flows/#tag/Flows/paths/~1flows~1validate/post
49
+ */
50
+ export const validate = function (options, sdkOptions) {
51
+ return serviceRequest({
52
+ service: ID,
53
+ scope: SCOPES.MANAGE_FLOWS,
54
+ path: `/flows/validate`,
55
+ method: HTTP_METHODS.POST,
56
+ }, options, sdkOptions);
57
+ };
46
58
  //# sourceMappingURL=flows.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"flows.js","sourceRoot":"","sources":["../../../../../src/services/flows/service/flows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAG3E;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,OAAQ,EAAE,UAAW;IACnD,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,UAAU;QACxB,IAAI,EAAE,QAAQ;KACf,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAGE,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,UAAU,OAAO,EAAE,OAAQ,EAAE,UAAW;IACzD,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,UAAU;QACxB,IAAI,EAAE,UAAU,OAAO,EAAE;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAAqE,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,OAAO,EAAE,OAAQ,EAAE,UAAW;IAC5D,OAAO,cAAc,CACnB;QACE,KAAK,EAAE,MAAM,CAAC,YAAY;QAC1B,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,UAAU,OAAO,EAAE;QACzB,MAAM,EAAE,YAAY,CAAC,MAAM;KAC5B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,UAAU,OAAO,EAAE,OAAQ,EAAE,UAAW;IACzD,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,UAAU;QACxB,IAAI,EAAE,UAAU,OAAO,MAAM;QAC7B,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAUC,CAAC"}
1
+ {"version":3,"file":"flows.js","sourceRoot":"","sources":["../../../../../src/services/flows/service/flows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAO3E;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,OAAQ,EAAE,UAAW;IACnD,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,UAAU;QACxB,IAAI,EAAE,QAAQ;KACf,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAGE,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,UAAU,OAAO,EAAE,OAAQ,EAAE,UAAW;IACzD,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,UAAU;QACxB,IAAI,EAAE,UAAU,OAAO,EAAE;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAAqE,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,OAAO,EAAE,OAAQ,EAAE,UAAW;IAC5D,OAAO,cAAc,CACnB;QACE,KAAK,EAAE,MAAM,CAAC,YAAY;QAC1B,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,UAAU,OAAO,EAAE;QACzB,MAAM,EAAE,YAAY,CAAC,MAAM;KAC5B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,UAAU,OAAO,EAAE,OAAQ,EAAE,UAAW;IACzD,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,UAAU;QACxB,IAAI,EAAE,UAAU,OAAO,MAAM;QAC7B,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAUC,CAAC;AAkCF;;;GAGG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,UACtB,OAAO,EACP,UAAW;IAEX,OAAO,cAAc,CACnB;QACE,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,MAAM,CAAC,YAAY;QAC1B,IAAI,EAAE,iBAAiB;QACvB,MAAM,EAAE,YAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAME,CAAC"}
@@ -2,20 +2,20 @@ import type { JSONFetchResponse } from '../../types.js';
2
2
  /**
3
3
  * @see https://docs.globus.org/api/search/reference/index_list/#indexwithpermissions
4
4
  */
5
- type IndexWithPermissions = {
5
+ export type IndexWithPermissions = {
6
6
  permissions: string[];
7
7
  display_name: string;
8
8
  id: string;
9
9
  description: string;
10
10
  creation_date: string;
11
11
  is_trial: boolean;
12
- subscription_id: string;
12
+ subscription_id: string | null;
13
13
  max_size_in_mb: number;
14
14
  size_in_mb: number;
15
15
  num_subjects: number;
16
16
  num_entries: number;
17
17
  };
18
- type GSearchIndex = {
18
+ export type GSearchIndex = {
19
19
  display_name: string;
20
20
  id: string;
21
21
  description: string;
@@ -27,6 +27,12 @@ type GSearchIndex = {
27
27
  num_subjects: number;
28
28
  num_entries: number;
29
29
  };
30
+ /**
31
+ * @see https://docs.globus.org/api/search/reference/index_list/#indexlist
32
+ */
33
+ export type IndexList = {
34
+ index_list: IndexWithPermissions[];
35
+ };
30
36
  /**
31
37
  * @see https://docs.globus.org/api/search/reference/index_show/
32
38
  */
@@ -37,7 +43,7 @@ export declare const get: (index_id: string, options?: {
37
43
  /**
38
44
  * @see https://docs.globus.org/api/search/reference/index_list/
39
45
  */
40
- export declare const getAll: (options?: import("../../types.js").BaseServiceMethodOptions | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<IndexWithPermissions[]>>;
46
+ export declare const getAll: (options?: import("../../types.js").BaseServiceMethodOptions | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<IndexList>>;
41
47
  type IndexCreate = {
42
48
  display_name: string;
43
49
  description: string;
@@ -90,7 +96,7 @@ type FieldMapping = Record<string, 'geo_point' | 'geo_shape' | string>;
90
96
  * 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
97
  * @see https://docs.globus.org/api/search/reference/ingest/#gingest
92
98
  */
93
- type GIngest = {
99
+ export type GIngest = {
94
100
  ingest_type: string;
95
101
  ingest_data: Record<string, unknown>;
96
102
  field_mapping?: FieldMapping;
@@ -107,14 +113,14 @@ type GIngest = {
107
113
  * A GMetaList is a collection of {@link GMetaEntry} documents.
108
114
  * @see https://docs.globus.org/api/search/reference/ingest/#gmetalist
109
115
  */
110
- type GMetaList = {
116
+ export type GMetaList = {
111
117
  gmeta: GMetaEntry[];
112
118
  };
113
119
  /**
114
120
  * A GMetaEntry is a single block of data pertaining to a given subject.
115
121
  * @see https://docs.globus.org/api/search/reference/ingest/#gmetaentry
116
122
  */
117
- type GMetaEntry = {
123
+ export type GMetaEntry = {
118
124
  id?: string;
119
125
  subject: string;
120
126
  visible_to: 'public' | 'all_authenticated_users' | string;
@@ -1 +1 @@
1
- {"version":3,"file":"search-index.d.ts","sourceRoot":"","sources":["../../../../../src/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"}
1
+ {"version":3,"file":"search-index.d.ts","sourceRoot":"","sources":["../../../../../src/services/search/service/search-index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iBAAiB,EAGlB,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,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,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,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,MAAM,MAAM,SAAS,GAAG;IACtB,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG;;;gFAIb,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAUU,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,MAAM,6IAAqC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAU/D,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,MAAM,MAAM,OAAO,GACf;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,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,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"}
@@ -1 +1 @@
1
- {"version":3,"file":"search-index.js","sourceRoot":"","sources":["../../../../../src/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
+ {"version":3,"file":"search-index.js","sourceRoot":"","sources":["../../../../../src/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;AA6C1C;;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,UAAU,OAAQ,EAAE,UAAW;IACnD,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"}