@openstax/ts-utils 1.29.0 → 1.30.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 (116) hide show
  1. package/dist/cjs/assertions/index.d.ts +7 -3
  2. package/dist/cjs/config/envConfig.d.ts +1 -1
  3. package/dist/cjs/config/index.d.ts +7 -7
  4. package/dist/cjs/config/resolveConfigValue.d.ts +2 -2
  5. package/dist/cjs/fetch/index.d.ts +16 -16
  6. package/dist/cjs/fetch/index.js +1 -1
  7. package/dist/cjs/middleware/apiErrorHandler.d.ts +3 -3
  8. package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +1 -1
  9. package/dist/cjs/middleware/index.d.ts +7 -7
  10. package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +1 -1
  11. package/dist/cjs/misc/hashValue.d.ts +2 -2
  12. package/dist/cjs/misc/helpers.d.ts +11 -11
  13. package/dist/cjs/misc/merge.d.ts +2 -2
  14. package/dist/cjs/misc/partitionSequence.d.ts +2 -2
  15. package/dist/cjs/pagination/index.d.ts +1 -1
  16. package/dist/cjs/routing/index.d.ts +30 -30
  17. package/dist/cjs/routing/index.js +18 -8
  18. package/dist/cjs/routing/validators/zod.d.ts +1 -1
  19. package/dist/cjs/routing/validators/zod.js +3 -1
  20. package/dist/cjs/services/accountsGateway/index.d.ts +17 -20
  21. package/dist/cjs/services/apiGateway/index.d.ts +10 -10
  22. package/dist/cjs/services/apiGateway/index.js +17 -7
  23. package/dist/cjs/services/authProvider/browser.d.ts +5 -7
  24. package/dist/cjs/services/authProvider/decryption.d.ts +3 -7
  25. package/dist/cjs/services/authProvider/index.d.ts +8 -8
  26. package/dist/cjs/services/authProvider/subrequest.d.ts +2 -5
  27. package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +1 -2
  28. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +4 -4
  29. package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +1 -1
  30. package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +2 -2
  31. package/dist/cjs/services/documentStore/index.d.ts +7 -7
  32. package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +7 -9
  33. package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +7 -9
  34. package/dist/cjs/services/documentStore/unversioned/file-system.js +17 -7
  35. package/dist/cjs/services/documentStore/unversioned/index.d.ts +1 -1
  36. package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +7 -9
  37. package/dist/cjs/services/documentStore/versioned/file-system.d.ts +6 -8
  38. package/dist/cjs/services/documentStore/versioned/index.d.ts +4 -4
  39. package/dist/cjs/services/exercisesGateway/index.d.ts +9 -13
  40. package/dist/cjs/services/exercisesGateway/index.js +17 -7
  41. package/dist/cjs/services/fileServer/index.d.ts +2 -3
  42. package/dist/cjs/services/fileServer/localFileServer.d.ts +2 -6
  43. package/dist/cjs/services/fileServer/s3FileServer.d.ts +2 -5
  44. package/dist/cjs/services/launchParams/signer.d.ts +4 -9
  45. package/dist/cjs/services/launchParams/verifier.d.ts +4 -7
  46. package/dist/cjs/services/launchParams/verifier.js +17 -7
  47. package/dist/cjs/services/logger/index.d.ts +2 -2
  48. package/dist/cjs/services/logger/index.js +1 -1
  49. package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +1 -1
  50. package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +34 -34
  51. package/dist/cjs/services/lrsGateway/file-system.d.ts +2 -4
  52. package/dist/cjs/services/lrsGateway/file-system.js +17 -7
  53. package/dist/cjs/services/lrsGateway/index.d.ts +29 -32
  54. package/dist/cjs/services/lrsGateway/index.js +17 -7
  55. package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +23 -23
  56. package/dist/cjs/services/postgresConnection/index.d.ts +3 -10
  57. package/dist/cjs/services/searchProvider/index.d.ts +7 -7
  58. package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +1 -1
  59. package/dist/cjs/services/searchProvider/openSearch.d.ts +3 -6
  60. package/dist/cjs/services/searchProvider/openSearch.js +7 -3
  61. package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +1 -1
  62. package/dist/cjs/types.d.ts +5 -5
  63. package/dist/esm/assertions/index.d.ts +7 -3
  64. package/dist/esm/config/envConfig.d.ts +1 -1
  65. package/dist/esm/config/index.d.ts +7 -7
  66. package/dist/esm/config/resolveConfigValue.d.ts +2 -2
  67. package/dist/esm/fetch/index.d.ts +16 -16
  68. package/dist/esm/middleware/apiErrorHandler.d.ts +3 -3
  69. package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +1 -1
  70. package/dist/esm/middleware/index.d.ts +7 -7
  71. package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +1 -1
  72. package/dist/esm/misc/hashValue.d.ts +2 -2
  73. package/dist/esm/misc/helpers.d.ts +11 -11
  74. package/dist/esm/misc/merge.d.ts +2 -2
  75. package/dist/esm/misc/partitionSequence.d.ts +2 -2
  76. package/dist/esm/pagination/index.d.ts +1 -1
  77. package/dist/esm/routing/index.d.ts +30 -30
  78. package/dist/esm/routing/validators/zod.d.ts +1 -1
  79. package/dist/esm/routing/validators/zod.js +3 -1
  80. package/dist/esm/services/accountsGateway/index.d.ts +17 -20
  81. package/dist/esm/services/apiGateway/index.d.ts +10 -10
  82. package/dist/esm/services/authProvider/browser.d.ts +5 -7
  83. package/dist/esm/services/authProvider/decryption.d.ts +3 -7
  84. package/dist/esm/services/authProvider/index.d.ts +8 -8
  85. package/dist/esm/services/authProvider/subrequest.d.ts +2 -5
  86. package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +1 -2
  87. package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +4 -4
  88. package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +2 -2
  89. package/dist/esm/services/documentStore/index.d.ts +7 -7
  90. package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +7 -9
  91. package/dist/esm/services/documentStore/unversioned/file-system.d.ts +7 -9
  92. package/dist/esm/services/documentStore/unversioned/index.d.ts +1 -1
  93. package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +7 -9
  94. package/dist/esm/services/documentStore/versioned/file-system.d.ts +6 -8
  95. package/dist/esm/services/documentStore/versioned/index.d.ts +4 -4
  96. package/dist/esm/services/exercisesGateway/index.d.ts +9 -13
  97. package/dist/esm/services/fileServer/index.d.ts +2 -3
  98. package/dist/esm/services/fileServer/localFileServer.d.ts +2 -6
  99. package/dist/esm/services/fileServer/s3FileServer.d.ts +2 -5
  100. package/dist/esm/services/launchParams/signer.d.ts +4 -9
  101. package/dist/esm/services/launchParams/verifier.d.ts +4 -7
  102. package/dist/esm/services/logger/index.d.ts +2 -2
  103. package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +1 -1
  104. package/dist/esm/services/lrsGateway/attempt-utils.d.ts +34 -34
  105. package/dist/esm/services/lrsGateway/file-system.d.ts +2 -4
  106. package/dist/esm/services/lrsGateway/index.d.ts +29 -32
  107. package/dist/esm/services/lrsGateway/xapiUtils.d.ts +23 -23
  108. package/dist/esm/services/postgresConnection/index.d.ts +3 -10
  109. package/dist/esm/services/searchProvider/index.d.ts +7 -7
  110. package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +1 -1
  111. package/dist/esm/services/searchProvider/openSearch.d.ts +3 -6
  112. package/dist/esm/services/searchProvider/openSearch.js +7 -3
  113. package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +1 -1
  114. package/dist/esm/types.d.ts +5 -5
  115. package/package.json +6 -6
  116. package/script/bin/.init-params-script.bash.swp +0 -0
@@ -1,7 +1,7 @@
1
1
  import postgres, { Sql } from 'postgres';
2
2
  import { ConfigProviderForConfig } from '../../config';
3
3
  import type { Logger } from '../logger';
4
- declare type Config = {
4
+ type Config = {
5
5
  host: string;
6
6
  readHost: string;
7
7
  port: string;
@@ -12,14 +12,7 @@ declare type Config = {
12
12
  interface Initializer<C> {
13
13
  configSpace?: C;
14
14
  }
15
- export declare const postgresConnection: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
16
- host: import("../../config").ConfigValueProvider<string>;
17
- readHost: import("../../config").ConfigValueProvider<string>;
18
- port: import("../../config").ConfigValueProvider<string>;
19
- database: import("../../config").ConfigValueProvider<string>;
20
- username: import("../../config").ConfigValueProvider<string>;
21
- password: import("../../config").ConfigValueProvider<string>;
22
- }; }) => (services: {
15
+ export declare const postgresConnection: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => (services: {
23
16
  logger: Logger;
24
17
  }) => {
25
18
  db: () => Promise<postgres.Sql<{}>>;
@@ -27,7 +20,7 @@ export declare const postgresConnection: <C extends string = "local">(initialize
27
20
  migrate: (migrations: Migration[]) => Promise<void>;
28
21
  down: () => Promise<void[]>;
29
22
  };
30
- export declare type PostgresConnection = ReturnType<ReturnType<ReturnType<typeof postgresConnection>>>;
23
+ export type PostgresConnection = ReturnType<ReturnType<ReturnType<typeof postgresConnection>>>;
31
24
  export interface Migration {
32
25
  name: string;
33
26
  up: (db: Sql) => Promise<void>;
@@ -1,5 +1,5 @@
1
- export declare type FieldType = string | string[] | number | boolean;
2
- export declare type ESFilter = {
1
+ export type FieldType = string | string[] | number | boolean;
2
+ export type ESFilter = {
3
3
  terms: Record<string, FieldType>;
4
4
  } | {
5
5
  term: Record<string, FieldType>;
@@ -15,18 +15,18 @@ export declare type ESFilter = {
15
15
  } | {
16
16
  bool: BoolFilter;
17
17
  };
18
- export declare type Filter = {
18
+ export type Filter = {
19
19
  key: string;
20
20
  value: FieldType;
21
21
  } | ESFilter;
22
- export declare type BoolFilter = {
22
+ export type BoolFilter = {
23
23
  must?: Filter[];
24
24
  must_not?: Filter[];
25
25
  should?: Filter[];
26
26
  filter?: Filter[];
27
27
  minimum_should_match?: number;
28
28
  };
29
- declare type Field = {
29
+ type Field = {
30
30
  key: string;
31
31
  type?: 'text';
32
32
  weight: number;
@@ -41,7 +41,7 @@ export interface IndexOptions<T> {
41
41
  body: T;
42
42
  id: string;
43
43
  }
44
- export declare type FieldMapping = {
44
+ export type FieldMapping = {
45
45
  type: 'keyword' | 'text' | 'boolean';
46
46
  } | {
47
47
  type: 'date';
@@ -50,7 +50,7 @@ export declare type FieldMapping = {
50
50
  type?: 'nested' | 'object';
51
51
  properties: Record<string, FieldMapping>;
52
52
  };
53
- export declare type FieldMappings = Record<string, FieldMapping>;
53
+ export type FieldMappings = Record<string, FieldMapping>;
54
54
  export interface SearchOptions {
55
55
  page?: number;
56
56
  query: string | undefined;
@@ -1,5 +1,5 @@
1
1
  import { FieldMappings, IndexOptions, SearchOptions } from '.';
2
- export declare type Config<T> = {
2
+ export type Config<T> = {
3
3
  mappings: FieldMappings;
4
4
  store: {
5
5
  loadAllDocumentsTheBadWay: () => Promise<T[]>;
@@ -1,21 +1,18 @@
1
1
  import { ConfigProviderForConfig } from '../../config';
2
2
  import { FieldMappings, IndexOptions, SearchOptions } from '.';
3
- export declare type Config = {
3
+ export type Config = {
4
4
  node: string;
5
5
  region: string;
6
6
  };
7
7
  export interface Initializer<C> {
8
8
  configSpace?: C;
9
9
  }
10
- export declare type IndexConfig = {
10
+ export type IndexConfig = {
11
11
  name: string;
12
12
  mappings: FieldMappings;
13
13
  pageSize?: number;
14
14
  };
15
- export declare const openSearchService: <C extends string = "deployed">(initializer?: Initializer<C>) => (configProvider: { [key in C]: {
16
- node: import("../../config").ConfigValueProvider<string>;
17
- region: import("../../config").ConfigValueProvider<string>;
18
- }; }) => <T>(indexConfig: IndexConfig) => {
15
+ export declare const openSearchService: <C extends string = "deployed">(initializer?: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => <T>(indexConfig: IndexConfig) => {
19
16
  ensureIndexCreated: () => Promise<void>;
20
17
  deleteIndexIfExists: () => Promise<void>;
21
18
  index: (params: IndexOptions<T>) => Promise<void>;
@@ -26,9 +26,13 @@ const openSearchService = (initializer = {}) => (configProvider) => {
26
26
  region: await (0, config_1.resolveConfigValue)(config.region),
27
27
  service: 'es',
28
28
  }),
29
- maxRetries: 3,
30
- requestTimeout: 3000,
31
- pingTimeout: 1000,
29
+ maxRetries: 4, // default is 3
30
+ requestTimeout: 5000, // default is 30000
31
+ pingTimeout: 2000, // default is 30000
32
+ sniffOnConnectionFault: true,
33
+ sniffOnStart: true,
34
+ resurrectStrategy: 'ping',
35
+ agent: { keepAlive: false },
32
36
  node: await (0, config_1.resolveConfigValue)(config.node),
33
37
  }));
34
38
  return (indexConfig) => {