@etohq/utils 2.0.1 → 2.0.5
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/dist/analytics/index.d.ts +0 -18
- package/dist/analytics/index.d.ts.map +1 -1
- package/dist/analytics/index.js +0 -18
- package/dist/analytics/index.js.map +1 -1
- package/dist/approval/evaluate.d.ts +69 -0
- package/dist/approval/evaluate.d.ts.map +1 -0
- package/dist/approval/evaluate.js +90 -0
- package/dist/approval/evaluate.js.map +1 -0
- package/dist/approval/index.d.ts +2 -0
- package/dist/approval/index.d.ts.map +1 -0
- package/dist/{access-link → approval}/index.js +1 -10
- package/dist/approval/index.js.map +1 -0
- package/dist/bundles.d.ts +1 -1
- package/dist/bundles.d.ts.map +1 -1
- package/dist/bundles.js +2 -2
- package/dist/bundles.js.map +1 -1
- package/dist/caching/index.d.ts.map +1 -1
- package/dist/caching/index.js +3 -1
- package/dist/caching/index.js.map +1 -1
- package/dist/common/api-error.d.ts.map +1 -1
- package/dist/common/api-error.js.map +1 -1
- package/dist/common/big-number.d.ts.map +1 -1
- package/dist/common/big-number.js +1 -1
- package/dist/common/big-number.js.map +1 -1
- package/dist/common/build-regexp-if-valid.d.ts.map +1 -1
- package/dist/common/build-regexp-if-valid.js +4 -2
- package/dist/common/build-regexp-if-valid.js.map +1 -1
- package/dist/common/constants.d.ts.map +1 -1
- package/dist/common/constants.js +262 -22
- package/dist/common/constants.js.map +1 -1
- package/dist/common/create-psql-index-helper.d.ts.map +1 -1
- package/dist/common/create-psql-index-helper.js +7 -0
- package/dist/common/create-psql-index-helper.js.map +1 -1
- package/dist/common/define-config.d.ts.map +1 -1
- package/dist/common/define-config.js +2 -1
- package/dist/common/define-config.js.map +1 -1
- package/dist/common/domains.d.ts.map +1 -1
- package/dist/common/domains.js +7 -3
- package/dist/common/domains.js.map +1 -1
- package/dist/common/env-editor.js +1 -1
- package/dist/common/env-editor.js.map +1 -1
- package/dist/common/eto-container.js +1 -1
- package/dist/common/eto-container.js.map +1 -1
- package/dist/common/flatten-object-to-key-value-pairs.d.ts.map +1 -1
- package/dist/common/flatten-object-to-key-value-pairs.js +8 -4
- package/dist/common/flatten-object-to-key-value-pairs.js.map +1 -1
- package/dist/common/get-resolved-plugins.d.ts.map +1 -1
- package/dist/common/get-resolved-plugins.js.map +1 -1
- package/dist/common/get-smallest-unit.js +1 -1
- package/dist/common/get-smallest-unit.js.map +1 -1
- package/dist/common/is-email.d.ts.map +1 -1
- package/dist/common/is-email.js.map +1 -1
- package/dist/common/load-env.d.ts.map +1 -1
- package/dist/common/load-env.js +3 -1
- package/dist/common/load-env.js.map +1 -1
- package/dist/common/math.d.ts.map +1 -1
- package/dist/common/math.js +9 -7
- package/dist/common/math.js.map +1 -1
- package/dist/common/merge-plugin-modules.d.ts.map +1 -1
- package/dist/common/merge-plugin-modules.js +1 -3
- package/dist/common/merge-plugin-modules.js.map +1 -1
- package/dist/common/normalize-import-path-with-source.js +1 -1
- package/dist/common/normalize-import-path-with-source.js.map +1 -1
- package/dist/common/parse-stringify-if-necessary.js +1 -1
- package/dist/common/parse-stringify-if-necessary.js.map +1 -1
- package/dist/common/read-dir-recursive.d.ts.map +1 -1
- package/dist/common/read-dir-recursive.js +6 -1
- package/dist/common/read-dir-recursive.js.map +1 -1
- package/dist/common/reserved-slugs.d.ts.map +1 -1
- package/dist/common/reserved-slugs.js.map +1 -1
- package/dist/core-flows/events.d.ts.map +1 -1
- package/dist/core-flows/events.js.map +1 -1
- package/dist/dal/mikro-orm/db-error-mapper.js +1 -1
- package/dist/dal/mikro-orm/db-error-mapper.js.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-create-connection.d.ts.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-create-connection.js +26 -2
- package/dist/dal/mikro-orm/mikro-orm-create-connection.js.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-repository.d.ts.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-repository.js +64 -13
- package/dist/dal/mikro-orm/mikro-orm-repository.js.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-serializer-old.d.ts.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-serializer-old.js +4 -3
- package/dist/dal/mikro-orm/mikro-orm-serializer-old.js.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-serializer.d.ts.map +1 -1
- package/dist/dal/mikro-orm/mikro-orm-serializer.js +42 -21
- package/dist/dal/mikro-orm/mikro-orm-serializer.js.map +1 -1
- package/dist/dal/mikro-orm/sql-migration-generator.d.ts.map +1 -1
- package/dist/dal/mikro-orm/sql-migration-generator.js.map +1 -1
- package/dist/dal/mikro-orm/utils.d.ts.map +1 -1
- package/dist/dal/mikro-orm/utils.js +6 -3
- package/dist/dal/mikro-orm/utils.js.map +1 -1
- package/dist/dev-server/handlers/step-handler.d.ts.map +1 -1
- package/dist/dev-server/handlers/step-handler.js.map +1 -1
- package/dist/dml/entity-builder.d.ts +23 -2
- package/dist/dml/entity-builder.d.ts.map +1 -1
- package/dist/dml/entity-builder.js +29 -6
- package/dist/dml/entity-builder.js.map +1 -1
- package/dist/dml/entity.d.ts +16 -1
- package/dist/dml/entity.d.ts.map +1 -1
- package/dist/dml/entity.js +31 -2
- package/dist/dml/entity.js.map +1 -1
- package/dist/dml/errors.d.ts +12 -0
- package/dist/dml/errors.d.ts.map +1 -1
- package/dist/dml/errors.js +21 -1
- package/dist/dml/errors.js.map +1 -1
- package/dist/dml/helpers/create-graphql.js +2 -2
- package/dist/dml/helpers/create-graphql.js.map +1 -1
- package/dist/dml/helpers/create-mikro-orm-entity.d.ts.map +1 -1
- package/dist/dml/helpers/create-mikro-orm-entity.js +33 -6
- package/dist/dml/helpers/create-mikro-orm-entity.js.map +1 -1
- package/dist/dml/helpers/entity-builder/define-property.d.ts +0 -3
- package/dist/dml/helpers/entity-builder/define-property.d.ts.map +1 -1
- package/dist/dml/helpers/entity-builder/define-property.js +80 -25
- package/dist/dml/helpers/entity-builder/define-property.js.map +1 -1
- package/dist/dml/helpers/entity-builder/define-relationship.js +2 -2
- package/dist/dml/helpers/entity-builder/define-relationship.js.map +1 -1
- package/dist/dml/helpers/mikro-orm/apply-indexes.d.ts.map +1 -1
- package/dist/dml/helpers/mikro-orm/apply-indexes.js.map +1 -1
- package/dist/dml/helpers/mikro-orm/custom-type/geo-json-geometry.d.ts.map +1 -1
- package/dist/dml/helpers/mikro-orm/custom-type/geo-json-geometry.js.map +1 -1
- package/dist/dml/properties/base.d.ts +37 -0
- package/dist/dml/properties/base.d.ts.map +1 -1
- package/dist/dml/properties/base.js +55 -2
- package/dist/dml/properties/base.js.map +1 -1
- package/dist/dml/properties/computed.d.ts.map +1 -1
- package/dist/dml/properties/computed.js.map +1 -1
- package/dist/dml/properties/enum.d.ts +9 -1
- package/dist/dml/properties/enum.d.ts.map +1 -1
- package/dist/dml/properties/enum.js +3 -3
- package/dist/dml/properties/enum.js.map +1 -1
- package/dist/dml/properties/id.d.ts +7 -0
- package/dist/dml/properties/id.d.ts.map +1 -1
- package/dist/dml/properties/id.js +1 -0
- package/dist/dml/properties/id.js.map +1 -1
- package/dist/dml/properties/index.d.ts +1 -0
- package/dist/dml/properties/index.d.ts.map +1 -1
- package/dist/dml/properties/index.js +1 -0
- package/dist/dml/properties/index.js.map +1 -1
- package/dist/dml/properties/json.d.ts +4 -0
- package/dist/dml/properties/json.d.ts.map +1 -1
- package/dist/dml/properties/nullable.d.ts.map +1 -1
- package/dist/dml/properties/nullable.js.map +1 -1
- package/dist/dml/properties/primary-key.d.ts.map +1 -1
- package/dist/dml/properties/primary-key.js.map +1 -1
- package/dist/dml/properties/tsvector.d.ts +30 -0
- package/dist/dml/properties/tsvector.d.ts.map +1 -0
- package/dist/dml/properties/tsvector.js +40 -0
- package/dist/dml/properties/tsvector.js.map +1 -0
- package/dist/dml/relations/base.d.ts.map +1 -1
- package/dist/dml/relations/base.js.map +1 -1
- package/dist/dml/relations/nullable.d.ts.map +1 -1
- package/dist/dml/relations/nullable.js.map +1 -1
- package/dist/event-bus/message-aggregator.d.ts.map +1 -1
- package/dist/event-bus/message-aggregator.js +2 -1
- package/dist/event-bus/message-aggregator.js.map +1 -1
- package/dist/file/abstract-file-provider.d.ts.map +1 -1
- package/dist/file/abstract-file-provider.js.map +1 -1
- package/dist/graphql/index.d.ts +10 -1
- package/dist/graphql/index.d.ts.map +1 -1
- package/dist/graphql/index.js +17 -3
- package/dist/graphql/index.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/migrations/index.d.ts +0 -3
- package/dist/migrations/index.d.ts.map +1 -1
- package/dist/migrations/index.js +38 -3
- package/dist/migrations/index.js.map +1 -1
- package/dist/modules-sdk/build-query.js +1 -1
- package/dist/modules-sdk/build-query.js.map +1 -1
- package/dist/modules-sdk/create-pg-connection.d.ts.map +1 -1
- package/dist/modules-sdk/create-pg-connection.js +62 -0
- package/dist/modules-sdk/create-pg-connection.js.map +1 -1
- package/dist/modules-sdk/define-link.js +2 -2
- package/dist/modules-sdk/define-link.js.map +1 -1
- package/dist/modules-sdk/definition.d.ts +19 -7
- package/dist/modules-sdk/definition.d.ts.map +1 -1
- package/dist/modules-sdk/definition.js +18 -6
- package/dist/modules-sdk/definition.js.map +1 -1
- package/dist/modules-sdk/eto-internal-service.d.ts.map +1 -1
- package/dist/modules-sdk/eto-internal-service.js.map +1 -1
- package/dist/modules-sdk/eto-service.d.ts.map +1 -1
- package/dist/modules-sdk/eto-service.js +10 -5
- package/dist/modules-sdk/eto-service.js.map +1 -1
- package/dist/modules-sdk/joiner-config-builder.d.ts.map +1 -1
- package/dist/modules-sdk/joiner-config-builder.js +3 -1
- package/dist/modules-sdk/joiner-config-builder.js.map +1 -1
- package/dist/modules-sdk/load-module-database-config.d.ts.map +1 -1
- package/dist/modules-sdk/load-module-database-config.js +6 -3
- package/dist/modules-sdk/load-module-database-config.js.map +1 -1
- package/dist/modules-sdk/loaders/load-models.d.ts.map +1 -1
- package/dist/modules-sdk/loaders/load-models.js +6 -2
- package/dist/modules-sdk/loaders/load-models.js.map +1 -1
- package/dist/modules-sdk/loaders/mikro-orm-connection-loader.js +12 -0
- package/dist/modules-sdk/loaders/mikro-orm-connection-loader.js.map +1 -1
- package/dist/modules-sdk/migration-scripts/service-migration-generate.js +1 -1
- package/dist/modules-sdk/migration-scripts/service-migration-generate.js.map +1 -1
- package/dist/modules-sdk/mikro-orm-cli-config-builder.d.ts.map +1 -1
- package/dist/modules-sdk/mikro-orm-cli-config-builder.js +7 -0
- package/dist/modules-sdk/mikro-orm-cli-config-builder.js.map +1 -1
- package/dist/modules-sdk/module.d.ts +12 -1
- package/dist/modules-sdk/module.d.ts.map +1 -1
- package/dist/modules-sdk/module.js +18 -0
- package/dist/modules-sdk/module.js.map +1 -1
- package/dist/modules-sdk/modules-to-container-types.js +1 -1
- package/dist/modules-sdk/modules-to-container-types.js.map +1 -1
- package/dist/modules-sdk/spatial-query-processor.js +1 -1
- package/dist/modules-sdk/types/eto-service.d.ts.map +1 -1
- package/dist/outbox/emit.d.ts +12 -0
- package/dist/outbox/emit.d.ts.map +1 -0
- package/dist/outbox/emit.js +26 -0
- package/dist/outbox/emit.js.map +1 -0
- package/dist/outbox/index.d.ts +5 -0
- package/dist/outbox/index.d.ts.map +1 -0
- package/dist/outbox/index.js +21 -0
- package/dist/outbox/index.js.map +1 -0
- package/dist/outbox/model.d.ts +33 -0
- package/dist/outbox/model.d.ts.map +1 -0
- package/dist/outbox/model.js +35 -0
- package/dist/outbox/model.js.map +1 -0
- package/dist/outbox/relay.d.ts +16 -0
- package/dist/outbox/relay.d.ts.map +1 -0
- package/dist/outbox/relay.js +26 -0
- package/dist/outbox/relay.js.map +1 -0
- package/dist/outbox/types.d.ts +31 -0
- package/dist/outbox/types.d.ts.map +1 -0
- package/dist/outbox/types.js +3 -0
- package/dist/outbox/types.js.map +1 -0
- package/dist/permissions/ability.d.ts +4 -4
- package/dist/permissions/ability.d.ts.map +1 -1
- package/dist/permissions/ability.js +26 -16
- package/dist/permissions/ability.js.map +1 -1
- package/dist/permissions/context-builder.d.ts +1 -1
- package/dist/permissions/context-builder.d.ts.map +1 -1
- package/dist/permissions/context-builder.js +3 -3
- package/dist/permissions/context-builder.js.map +1 -1
- package/dist/schema/base-property.d.ts +25 -0
- package/dist/schema/base-property.d.ts.map +1 -0
- package/dist/schema/base-property.js +25 -0
- package/dist/schema/base-property.js.map +1 -0
- package/dist/schema/index.d.ts +2 -0
- package/dist/schema/index.d.ts.map +1 -0
- package/dist/schema/index.js +18 -0
- package/dist/schema/index.js.map +1 -0
- package/dist/search/abstract-search-provider.d.ts +345 -0
- package/dist/search/abstract-search-provider.d.ts.map +1 -0
- package/dist/search/abstract-search-provider.js +345 -0
- package/dist/search/abstract-search-provider.js.map +1 -0
- package/dist/search/define-search-index.d.ts +12 -0
- package/dist/search/define-search-index.d.ts.map +1 -0
- package/dist/search/define-search-index.js +47 -0
- package/dist/search/define-search-index.js.map +1 -0
- package/dist/search/definition-helpers.d.ts +112 -0
- package/dist/search/definition-helpers.d.ts.map +1 -0
- package/dist/search/definition-helpers.js +196 -0
- package/dist/search/definition-helpers.js.map +1 -0
- package/dist/search/document-utils.d.ts +29 -0
- package/dist/search/document-utils.d.ts.map +1 -0
- package/dist/search/document-utils.js +134 -0
- package/dist/search/document-utils.js.map +1 -0
- package/dist/search/index.d.ts +6 -4
- package/dist/search/index.d.ts.map +1 -1
- package/dist/search/index.js +6 -4
- package/dist/search/index.js.map +1 -1
- package/dist/search/model/index-builder.d.ts +61 -0
- package/dist/search/model/index-builder.d.ts.map +1 -0
- package/dist/search/model/index-builder.js +84 -0
- package/dist/search/model/index-builder.js.map +1 -0
- package/dist/search/model/index.d.ts +3 -0
- package/dist/search/model/index.d.ts.map +1 -0
- package/dist/search/model/index.js +9 -0
- package/dist/search/model/index.js.map +1 -0
- package/dist/search/model/properties/base.d.ts +52 -0
- package/dist/search/model/properties/base.d.ts.map +1 -0
- package/dist/search/model/properties/base.js +139 -0
- package/dist/search/model/properties/base.js.map +1 -0
- package/dist/search/model/properties/boolean.d.ts +8 -0
- package/dist/search/model/properties/boolean.d.ts.map +1 -0
- package/dist/search/model/properties/boolean.js +14 -0
- package/dist/search/model/properties/boolean.js.map +1 -0
- package/dist/search/model/properties/date.d.ts +8 -0
- package/dist/search/model/properties/date.d.ts.map +1 -0
- package/dist/search/model/properties/date.js +16 -0
- package/dist/search/model/properties/date.js.map +1 -0
- package/dist/search/model/properties/float.d.ts +8 -0
- package/dist/search/model/properties/float.d.ts.map +1 -0
- package/dist/search/model/properties/float.js +14 -0
- package/dist/search/model/properties/float.js.map +1 -0
- package/dist/search/model/properties/geo.d.ts +11 -0
- package/dist/search/model/properties/geo.d.ts.map +1 -0
- package/dist/search/model/properties/geo.js +14 -0
- package/dist/search/model/properties/geo.js.map +1 -0
- package/dist/search/model/properties/index.d.ts +11 -0
- package/dist/search/model/properties/index.d.ts.map +1 -0
- package/dist/search/model/properties/index.js +27 -0
- package/dist/search/model/properties/index.js.map +1 -0
- package/dist/search/model/properties/integer.d.ts +8 -0
- package/dist/search/model/properties/integer.d.ts.map +1 -0
- package/dist/search/model/properties/integer.js +14 -0
- package/dist/search/model/properties/integer.js.map +1 -0
- package/dist/search/model/properties/keyword.d.ts +8 -0
- package/dist/search/model/properties/keyword.d.ts.map +1 -0
- package/dist/search/model/properties/keyword.js +14 -0
- package/dist/search/model/properties/keyword.js.map +1 -0
- package/dist/search/model/properties/object.d.ts +12 -0
- package/dist/search/model/properties/object.d.ts.map +1 -0
- package/dist/search/model/properties/object.js +38 -0
- package/dist/search/model/properties/object.js.map +1 -0
- package/dist/search/model/properties/text.d.ts +8 -0
- package/dist/search/model/properties/text.d.ts.map +1 -0
- package/dist/search/model/properties/text.js +14 -0
- package/dist/search/model/properties/text.js.map +1 -0
- package/dist/search/model/properties/vector.d.ts +18 -0
- package/dist/search/model/properties/vector.d.ts.map +1 -0
- package/dist/search/model/properties/vector.js +51 -0
- package/dist/search/model/properties/vector.js.map +1 -0
- package/dist/search/model/search-fields-schema.d.ts +22 -0
- package/dist/search/model/search-fields-schema.d.ts.map +1 -0
- package/dist/search/model/search-fields-schema.js +70 -0
- package/dist/search/model/search-fields-schema.js.map +1 -0
- package/dist/search/search-scope.d.ts +44 -0
- package/dist/search/search-scope.d.ts.map +1 -0
- package/dist/search/search-scope.js +111 -0
- package/dist/search/search-scope.js.map +1 -0
- package/dist/{search → search-legacy}/abstract-service.d.ts +55 -18
- package/dist/search-legacy/abstract-service.d.ts.map +1 -0
- package/dist/{search → search-legacy}/abstract-service.js +59 -11
- package/dist/search-legacy/abstract-service.js.map +1 -0
- package/dist/search-legacy/index-types.d.ts.map +1 -0
- package/dist/search-legacy/index-types.js.map +1 -0
- package/dist/search-legacy/index.d.ts +6 -0
- package/dist/search-legacy/index.d.ts.map +1 -0
- package/dist/search-legacy/index.js +22 -0
- package/dist/search-legacy/index.js.map +1 -0
- package/dist/search-legacy/search-relations.d.ts.map +1 -0
- package/dist/search-legacy/search-relations.js.map +1 -0
- package/dist/search-legacy/types.d.ts +129 -0
- package/dist/search-legacy/types.d.ts.map +1 -0
- package/dist/search-legacy/types.js +10 -0
- package/dist/search-legacy/types.js.map +1 -0
- package/dist/search-legacy/variant-keys.d.ts.map +1 -0
- package/dist/search-legacy/variant-keys.js.map +1 -0
- package/dist/totals/big-number.d.ts.map +1 -1
- package/dist/totals/big-number.js +1 -1
- package/dist/totals/big-number.js.map +1 -1
- package/dist/totals/index.d.ts +1 -0
- package/dist/totals/index.d.ts.map +1 -1
- package/dist/totals/index.js +1 -0
- package/dist/totals/index.js.map +1 -1
- package/dist/totals/normalize-big-numbers.d.ts +14 -0
- package/dist/totals/normalize-big-numbers.d.ts.map +1 -0
- package/dist/totals/normalize-big-numbers.js +71 -0
- package/dist/totals/normalize-big-numbers.js.map +1 -0
- package/dist/translations/apply-translations-to-tax-lines.d.ts.map +1 -1
- package/dist/translations/apply-translations-to-tax-lines.js +1 -1
- package/dist/translations/apply-translations-to-tax-lines.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +15 -5
- package/dist/access-link/case-sensitivity.d.ts +0 -14
- package/dist/access-link/case-sensitivity.d.ts.map +0 -1
- package/dist/access-link/case-sensitivity.js +0 -57
- package/dist/access-link/case-sensitivity.js.map +0 -1
- package/dist/access-link/check-if-key-exists.d.ts +0 -7
- package/dist/access-link/check-if-key-exists.d.ts.map +0 -1
- package/dist/access-link/check-if-key-exists.js +0 -36
- package/dist/access-link/check-if-key-exists.js.map +0 -1
- package/dist/access-link/index.d.ts +0 -11
- package/dist/access-link/index.d.ts.map +0 -1
- package/dist/access-link/index.js.map +0 -1
- package/dist/access-link/key-checks.d.ts +0 -12
- package/dist/access-link/key-checks.d.ts.map +0 -1
- package/dist/access-link/key-checks.js +0 -78
- package/dist/access-link/key-checks.js.map +0 -1
- package/dist/access-link/link-resolution.d.ts +0 -26
- package/dist/access-link/link-resolution.d.ts.map +0 -1
- package/dist/access-link/link-resolution.js +0 -111
- package/dist/access-link/link-resolution.js.map +0 -1
- package/dist/access-link/link-utils.d.ts +0 -23
- package/dist/access-link/link-utils.d.ts.map +0 -1
- package/dist/access-link/link-utils.js +0 -61
- package/dist/access-link/link-utils.js.map +0 -1
- package/dist/access-link/process-key.d.ts +0 -5
- package/dist/access-link/process-key.d.ts.map +0 -1
- package/dist/access-link/process-key.js +0 -58
- package/dist/access-link/process-key.js.map +0 -1
- package/dist/access-link/process-utils.d.ts +0 -19
- package/dist/access-link/process-utils.d.ts.map +0 -1
- package/dist/access-link/process-utils.js +0 -52
- package/dist/access-link/process-utils.js.map +0 -1
- package/dist/access-link/transform-link.d.ts +0 -47
- package/dist/access-link/transform-link.d.ts.map +0 -1
- package/dist/access-link/transform-link.js +0 -25
- package/dist/access-link/transform-link.js.map +0 -1
- package/dist/access-link/url-detection.d.ts +0 -10
- package/dist/access-link/url-detection.d.ts.map +0 -1
- package/dist/access-link/url-detection.js +0 -63
- package/dist/access-link/url-detection.js.map +0 -1
- package/dist/access-link/validation-utils.d.ts +0 -23
- package/dist/access-link/validation-utils.d.ts.map +0 -1
- package/dist/access-link/validation-utils.js +0 -57
- package/dist/access-link/validation-utils.js.map +0 -1
- package/dist/analytics/detect-bot.d.ts +0 -2
- package/dist/analytics/detect-bot.d.ts.map +0 -1
- package/dist/analytics/detect-bot.js +0 -21
- package/dist/analytics/detect-bot.js.map +0 -1
- package/dist/analytics/detect-qr.d.ts +0 -2
- package/dist/analytics/detect-qr.d.ts.map +0 -1
- package/dist/analytics/detect-qr.js +0 -10
- package/dist/analytics/detect-qr.js.map +0 -1
- package/dist/analytics/get-click-event.d.ts +0 -8
- package/dist/analytics/get-click-event.d.ts.map +0 -1
- package/dist/analytics/get-click-event.js +0 -24
- package/dist/analytics/get-click-event.js.map +0 -1
- package/dist/analytics/get-geolocation.d.ts +0 -12
- package/dist/analytics/get-geolocation.d.ts.map +0 -1
- package/dist/analytics/get-geolocation.js +0 -51
- package/dist/analytics/get-geolocation.js.map +0 -1
- package/dist/analytics/get-grant-event.d.ts +0 -8
- package/dist/analytics/get-grant-event.d.ts.map +0 -1
- package/dist/analytics/get-grant-event.js +0 -24
- package/dist/analytics/get-grant-event.js.map +0 -1
- package/dist/analytics/get-import-error-logs.d.ts +0 -25
- package/dist/analytics/get-import-error-logs.d.ts.map +0 -1
- package/dist/analytics/get-import-error-logs.js +0 -23
- package/dist/analytics/get-import-error-logs.js.map +0 -1
- package/dist/analytics/get-lead-events.d.ts +0 -53
- package/dist/analytics/get-lead-events.d.ts.map +0 -1
- package/dist/analytics/get-lead-events.js +0 -17
- package/dist/analytics/get-lead-events.js.map +0 -1
- package/dist/analytics/get-webhook-events.d.ts +0 -24
- package/dist/analytics/get-webhook-events.d.ts.map +0 -1
- package/dist/analytics/get-webhook-events.js +0 -22
- package/dist/analytics/get-webhook-events.js.map +0 -1
- package/dist/analytics/log-conversion-events.d.ts +0 -25
- package/dist/analytics/log-conversion-events.d.ts.map +0 -1
- package/dist/analytics/log-conversion-events.js +0 -20
- package/dist/analytics/log-conversion-events.js.map +0 -1
- package/dist/analytics/log-import-error.d.ts +0 -23
- package/dist/analytics/log-import-error.d.ts.map +0 -1
- package/dist/analytics/log-import-error.js +0 -18
- package/dist/analytics/log-import-error.js.map +0 -1
- package/dist/analytics/parse-user-agent.d.ts +0 -13
- package/dist/analytics/parse-user-agent.d.ts.map +0 -1
- package/dist/analytics/parse-user-agent.js +0 -174
- package/dist/analytics/parse-user-agent.js.map +0 -1
- package/dist/analytics/record-approval.d.ts +0 -94
- package/dist/analytics/record-approval.d.ts.map +0 -1
- package/dist/analytics/record-approval.js +0 -32
- package/dist/analytics/record-approval.js.map +0 -1
- package/dist/analytics/record-click.d.ts +0 -32
- package/dist/analytics/record-click.d.ts.map +0 -1
- package/dist/analytics/record-click.js +0 -136
- package/dist/analytics/record-click.js.map +0 -1
- package/dist/analytics/record-lead.d.ts +0 -24
- package/dist/analytics/record-lead.d.ts.map +0 -1
- package/dist/analytics/record-lead.js +0 -72
- package/dist/analytics/record-lead.js.map +0 -1
- package/dist/analytics/record-link.d.ts +0 -158
- package/dist/analytics/record-link.d.ts.map +0 -1
- package/dist/analytics/record-link.js +0 -78
- package/dist/analytics/record-link.js.map +0 -1
- package/dist/analytics/record-sale.d.ts +0 -69
- package/dist/analytics/record-sale.d.ts.map +0 -1
- package/dist/analytics/record-sale.js +0 -35
- package/dist/analytics/record-sale.js.map +0 -1
- package/dist/analytics/record-webhook-event.d.ts +0 -44
- package/dist/analytics/record-webhook-event.d.ts.map +0 -1
- package/dist/analytics/record-webhook-event.js +0 -22
- package/dist/analytics/record-webhook-event.js.map +0 -1
- package/dist/analytics/schemas.d.ts +0 -257
- package/dist/analytics/schemas.d.ts.map +0 -1
- package/dist/analytics/schemas.js +0 -99
- package/dist/analytics/schemas.js.map +0 -1
- package/dist/analytics/tinybird-client.d.ts +0 -6
- package/dist/analytics/tinybird-client.d.ts.map +0 -1
- package/dist/analytics/tinybird-client.js +0 -11
- package/dist/analytics/tinybird-client.js.map +0 -1
- package/dist/common/fetch-with-retry.d.ts +0 -6
- package/dist/common/fetch-with-retry.d.ts.map +0 -1
- package/dist/common/fetch-with-retry.js +0 -63
- package/dist/common/fetch-with-retry.js.map +0 -1
- package/dist/common/get-identity-hash.d.ts +0 -2
- package/dist/common/get-identity-hash.d.ts.map +0 -1
- package/dist/common/get-identity-hash.js +0 -19
- package/dist/common/get-identity-hash.js.map +0 -1
- package/dist/search/abstract-service.d.ts.map +0 -1
- package/dist/search/abstract-service.js.map +0 -1
- package/dist/search/index-types.d.ts.map +0 -1
- package/dist/search/index-types.js.map +0 -1
- package/dist/search/search-relations.d.ts.map +0 -1
- package/dist/search/search-relations.js.map +0 -1
- package/dist/search/variant-keys.d.ts.map +0 -1
- package/dist/search/variant-keys.js.map +0 -1
- package/dist/zod/schemas/approvals.d.ts +0 -91
- package/dist/zod/schemas/approvals.d.ts.map +0 -1
- package/dist/zod/schemas/approvals.js +0 -38
- package/dist/zod/schemas/approvals.js.map +0 -1
- package/dist/zod/schemas/clicks.d.ts +0 -394
- package/dist/zod/schemas/clicks.d.ts.map +0 -1
- package/dist/zod/schemas/clicks.js +0 -85
- package/dist/zod/schemas/clicks.js.map +0 -1
- package/dist/zod/schemas/leads.d.ts +0 -423
- package/dist/zod/schemas/leads.d.ts.map +0 -1
- package/dist/zod/schemas/leads.js +0 -58
- package/dist/zod/schemas/leads.js.map +0 -1
- /package/dist/{search → search-legacy}/index-types.d.ts +0 -0
- /package/dist/{search → search-legacy}/index-types.js +0 -0
- /package/dist/{search → search-legacy}/search-relations.d.ts +0 -0
- /package/dist/{search → search-legacy}/search-relations.js +0 -0
- /package/dist/{search → search-legacy}/variant-keys.d.ts +0 -0
- /package/dist/{search → search-legacy}/variant-keys.js +0 -0
|
@@ -0,0 +1,345 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AbstractSearchProviderService = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* An abstract class for search providers. Extend this class to create a search
|
|
6
|
+
* provider.
|
|
7
|
+
*
|
|
8
|
+
* A search provider translates the Search Module's provider-agnostic input into
|
|
9
|
+
* the calls of a search engine, such as Meilisearch or Typesense: it creates and
|
|
10
|
+
* migrates the physical indexes, writes and deletes documents, and runs queries.
|
|
11
|
+
* The Search Module owns everything around it, including index definitions,
|
|
12
|
+
* batching, task tracking, and reindexing.
|
|
13
|
+
*
|
|
14
|
+
* ### constructor
|
|
15
|
+
*
|
|
16
|
+
* The constructor allows you to access resources from the module's container using the first parameter,
|
|
17
|
+
* and the provider's options using the second parameter.
|
|
18
|
+
*
|
|
19
|
+
* If you're creating a client with a search engine, do it in the constructor.
|
|
20
|
+
* Establishing a connection with the search engine should happen in `onApplicationStart`.
|
|
21
|
+
*
|
|
22
|
+
* #### Example
|
|
23
|
+
*
|
|
24
|
+
* ```ts
|
|
25
|
+
* import { Logger } from "@etohq/framework/types"
|
|
26
|
+
* import { AbstractSearchProviderService } from "@etohq/framework/utils"
|
|
27
|
+
*
|
|
28
|
+
* type InjectedDependencies = {
|
|
29
|
+
* logger: Logger
|
|
30
|
+
* }
|
|
31
|
+
*
|
|
32
|
+
* type Options = {
|
|
33
|
+
* host: string
|
|
34
|
+
* apiKey: string
|
|
35
|
+
* }
|
|
36
|
+
*
|
|
37
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
38
|
+
* static identifier = "my-search"
|
|
39
|
+
*
|
|
40
|
+
* protected logger_: Logger
|
|
41
|
+
* protected options_: Options
|
|
42
|
+
* // assuming you're initializing a client
|
|
43
|
+
* protected client
|
|
44
|
+
*
|
|
45
|
+
* constructor (
|
|
46
|
+
* { logger }: InjectedDependencies,
|
|
47
|
+
* options: Options
|
|
48
|
+
* ) {
|
|
49
|
+
* super()
|
|
50
|
+
*
|
|
51
|
+
* this.logger_ = logger
|
|
52
|
+
* this.options_ = options
|
|
53
|
+
*
|
|
54
|
+
* // assuming you're initializing a client
|
|
55
|
+
* this.client = new Client(options)
|
|
56
|
+
* }
|
|
57
|
+
* }
|
|
58
|
+
*
|
|
59
|
+
* export default MySearchProviderService
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* ### Handling unsupported features
|
|
63
|
+
*
|
|
64
|
+
* There's no list of features to declare. If a query asks for something your engine can't
|
|
65
|
+
* express, throw; if an index definition asks for something it can't hold, throw from
|
|
66
|
+
* `upsertIndex` so the error surfaces at startup. Returning a slightly different result is
|
|
67
|
+
* the one outcome to avoid, since callers can't tell it apart from a correct one.
|
|
68
|
+
*
|
|
69
|
+
* @privateRemarks
|
|
70
|
+
*
|
|
71
|
+
* `waitForTask` is optional and left out of this class on purpose: the Search
|
|
72
|
+
* Module treats its presence as support, so only define it if your engine
|
|
73
|
+
* applies writes asynchronously. `searchMany` has a default that runs `search`
|
|
74
|
+
* concurrently; override it to pack the queries into one engine round-trip.
|
|
75
|
+
* Refer to the `ISearchProvider` interface for their expected parameters and
|
|
76
|
+
* return values.
|
|
77
|
+
*/
|
|
78
|
+
class AbstractSearchProviderService {
|
|
79
|
+
/**
|
|
80
|
+
* @ignore
|
|
81
|
+
*/
|
|
82
|
+
get identifier() {
|
|
83
|
+
return this.constructor.identifier;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* @ignore
|
|
87
|
+
*/
|
|
88
|
+
getIdentifier() {
|
|
89
|
+
return this.constructor.identifier;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* This method runs a search against an index. The Search Module will use this method in
|
|
93
|
+
* its `search` and `searchMany` methods.
|
|
94
|
+
*
|
|
95
|
+
* The free-text query arrives as `q`, already lifted out of `filters`, and
|
|
96
|
+
* `attributes_to_retrieve` is already narrowed to the fields the index can return.
|
|
97
|
+
*
|
|
98
|
+
* Compile `input.filters` to your engine's filter syntax, and reject the
|
|
99
|
+
* operators it can't express rather than approximating them. Also, use
|
|
100
|
+
* `input.index.physical_name` as the index to query, not `input.index.name`,
|
|
101
|
+
* since the two differ under an index prefix or between versions.
|
|
102
|
+
*
|
|
103
|
+
* @param {SearchTypes.ProviderSearchQuery} _input - The query, the resolved index
|
|
104
|
+
* definition, and the attributes to return.
|
|
105
|
+
* @returns {Promise<SearchTypes.SearchResult>} The hits, any facets, and the metadata.
|
|
106
|
+
*
|
|
107
|
+
* @example
|
|
108
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
109
|
+
* // ...
|
|
110
|
+
* async search(
|
|
111
|
+
* input: SearchTypes.ProviderSearchQuery
|
|
112
|
+
* ): Promise<SearchTypes.SearchResult> {
|
|
113
|
+
* const response = await this.client.search(input.index.physical_name, {
|
|
114
|
+
* query: input.q,
|
|
115
|
+
* limit: input.pagination?.take,
|
|
116
|
+
* })
|
|
117
|
+
*
|
|
118
|
+
* return {
|
|
119
|
+
* hits: response.hits.map((hit) => ({ id: hit.id, document: hit })),
|
|
120
|
+
* metadata: {
|
|
121
|
+
* skip: input.pagination?.skip ?? 0,
|
|
122
|
+
* take: input.pagination?.take ?? 20,
|
|
123
|
+
* count: response.total,
|
|
124
|
+
* },
|
|
125
|
+
* }
|
|
126
|
+
* }
|
|
127
|
+
* }
|
|
128
|
+
*/
|
|
129
|
+
async search(_input) {
|
|
130
|
+
throw Error("search must be overridden by the child class");
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* This method runs multiple queries in a single request to the search engine.
|
|
134
|
+
* The Search Module uses it for its `searchMany` method, including the extra
|
|
135
|
+
* queries produced by disjunctive faceting.
|
|
136
|
+
*
|
|
137
|
+
* The default runs `search` concurrently. Override it to pack the queries into
|
|
138
|
+
* one engine round-trip.
|
|
139
|
+
*
|
|
140
|
+
* @param {SearchTypes.ProviderSearchQuery[]} inputs - The queries to run.
|
|
141
|
+
* @returns {Promise<SearchTypes.SearchResult[]>} A result for each query, in
|
|
142
|
+
* the same order as the queries.
|
|
143
|
+
*
|
|
144
|
+
* @example
|
|
145
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
146
|
+
* // ...
|
|
147
|
+
* async searchMany(
|
|
148
|
+
* inputs: SearchTypes.ProviderSearchQuery[]
|
|
149
|
+
* ): Promise<SearchTypes.SearchResult[]> {
|
|
150
|
+
* const { results } = await this.client.multiSearch(
|
|
151
|
+
* inputs.map((input) => ({
|
|
152
|
+
* indexUid: input.index.physical_name,
|
|
153
|
+
* query: input.q,
|
|
154
|
+
* }))
|
|
155
|
+
* )
|
|
156
|
+
*
|
|
157
|
+
* return results.map((result, i) => this.buildResult(result, inputs[i]))
|
|
158
|
+
* }
|
|
159
|
+
* }
|
|
160
|
+
*/
|
|
161
|
+
async searchMany(inputs) {
|
|
162
|
+
return await Promise.all(inputs.map((input) => this.search(input)));
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* This method brings an index in line with its definition, creating it if it doesn't
|
|
166
|
+
* exist. The Search Module calls it for every definition when migrations run.
|
|
167
|
+
*
|
|
168
|
+
* You may recreate the index if your engine can't alter a schema in place. That's safe:
|
|
169
|
+
* the module only points this at an index it's about to seed, never at one that has to
|
|
170
|
+
* keep serving reads, and never during a partial rebuild.
|
|
171
|
+
*
|
|
172
|
+
* Throw if the definition asks for something your engine can't hold, such as a
|
|
173
|
+
* facet type it doesn't support. Since migrations run before the application
|
|
174
|
+
* serves requests, the error surfaces at startup rather than as wrong results
|
|
175
|
+
* later.
|
|
176
|
+
*
|
|
177
|
+
* @param {object} _input - The index to create or update.
|
|
178
|
+
* @param {SearchTypes.ResolvedSearchIndexDefinition} _input.index - The definition,
|
|
179
|
+
* including the `physical_name` to create it under, the `primary_key` its
|
|
180
|
+
* documents are keyed by, the `fields` it holds, and its `settings`.
|
|
181
|
+
* @returns {Promise<SearchTypes.SearchTask>} The write's task.
|
|
182
|
+
*
|
|
183
|
+
* @example
|
|
184
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
185
|
+
* // ...
|
|
186
|
+
* async upsertIndex({
|
|
187
|
+
* index,
|
|
188
|
+
* }: {
|
|
189
|
+
* index: SearchTypes.ResolvedSearchIndexDefinition
|
|
190
|
+
* }): Promise<SearchTypes.SearchTask> {
|
|
191
|
+
* await this.client.createIndex(index.physical_name, {
|
|
192
|
+
* primaryKey: index.primary_key,
|
|
193
|
+
* })
|
|
194
|
+
*
|
|
195
|
+
* return { index: index.physical_name, status: "succeeded" }
|
|
196
|
+
* }
|
|
197
|
+
* }
|
|
198
|
+
*/
|
|
199
|
+
async upsertIndex(_input) {
|
|
200
|
+
throw Error("upsertIndex must be overridden by the child class");
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* This method deletes an index and everything in it. The Search Module calls it
|
|
204
|
+
* to clean up an old version of an index once a newer one has taken over.
|
|
205
|
+
*
|
|
206
|
+
* @param {object} _input - The index to delete.
|
|
207
|
+
* @param {string} _input.index - The index's physical name.
|
|
208
|
+
* @returns {Promise<SearchTypes.SearchTask>} The write's task.
|
|
209
|
+
*
|
|
210
|
+
* @example
|
|
211
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
212
|
+
* // ...
|
|
213
|
+
* async deleteIndex({
|
|
214
|
+
* index,
|
|
215
|
+
* }: {
|
|
216
|
+
* index: string
|
|
217
|
+
* }): Promise<SearchTypes.SearchTask> {
|
|
218
|
+
* await this.client.deleteIndex(index)
|
|
219
|
+
* return { index, status: "succeeded" }
|
|
220
|
+
* }
|
|
221
|
+
* }
|
|
222
|
+
*/
|
|
223
|
+
async deleteIndex(_input) {
|
|
224
|
+
throw Error("deleteIndex must be overridden by the child class");
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* This method lists the indexes you hold. The Search Module reads the document counts to
|
|
228
|
+
* spot an index that lost its data and needs reseeding.
|
|
229
|
+
*
|
|
230
|
+
* @returns {Promise<SearchTypes.SearchIndexInfo[]>} The indexes and their document counts.
|
|
231
|
+
*
|
|
232
|
+
* @example
|
|
233
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
234
|
+
* // ...
|
|
235
|
+
* async listIndexes(): Promise<SearchTypes.SearchIndexInfo[]> {
|
|
236
|
+
* const indexes = await this.client.listIndexes()
|
|
237
|
+
*
|
|
238
|
+
* return indexes.map((index) => ({
|
|
239
|
+
* name: index.uid,
|
|
240
|
+
* provider: MySearchProviderService.identifier,
|
|
241
|
+
* document_count: index.numberOfDocuments,
|
|
242
|
+
* }))
|
|
243
|
+
* }
|
|
244
|
+
* }
|
|
245
|
+
*/
|
|
246
|
+
async listIndexes() {
|
|
247
|
+
throw Error("listIndexes must be overridden by the child class");
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* This method adds documents to an index, replacing any that already exist under the same
|
|
251
|
+
* ID. The Search Module uses it both for direct writes and for seeding, where it's called
|
|
252
|
+
* once per batch.
|
|
253
|
+
*
|
|
254
|
+
* If your engine applies writes later rather than inline, return a task with an `id` and
|
|
255
|
+
* implement `waitForTask`, so the module can wait before making a new version active.
|
|
256
|
+
*
|
|
257
|
+
* Write to `input.index` but read schema information from `input.definition`:
|
|
258
|
+
* while a new version is being seeded, `input.index` is that version's
|
|
259
|
+
* physical index, whereas the definition is that of the logical index.
|
|
260
|
+
*
|
|
261
|
+
* @param {object} _input - The documents to write.
|
|
262
|
+
* @param {string} _input.index - The index's physical name. This is the index to
|
|
263
|
+
* write to.
|
|
264
|
+
* @param {SearchTypes.ResolvedSearchIndexDefinition} _input.definition - The
|
|
265
|
+
* definition of the logical index the documents belong to. Use it for schema
|
|
266
|
+
* information, such as the index's `fields` or `primary_key`.
|
|
267
|
+
* @param {SearchTypes.SearchDocument[]} _input.documents - The documents, each with an `id`.
|
|
268
|
+
* @returns {Promise<SearchTypes.SearchTask>} The write's task.
|
|
269
|
+
*
|
|
270
|
+
* @example
|
|
271
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
272
|
+
* // ...
|
|
273
|
+
* async upsertDocuments({
|
|
274
|
+
* index,
|
|
275
|
+
* definition,
|
|
276
|
+
* documents,
|
|
277
|
+
* }: {
|
|
278
|
+
* index: string
|
|
279
|
+
* definition: SearchTypes.ResolvedSearchIndexDefinition
|
|
280
|
+
* documents: SearchTypes.SearchDocument[]
|
|
281
|
+
* }): Promise<SearchTypes.SearchTask> {
|
|
282
|
+
* const task = await this.client.addDocuments(index, documents, {
|
|
283
|
+
* schema: definition.fields,
|
|
284
|
+
* })
|
|
285
|
+
* return { id: `${task.uid}`, index, status: "enqueued" }
|
|
286
|
+
* }
|
|
287
|
+
* }
|
|
288
|
+
*/
|
|
289
|
+
async upsertDocuments(_input) {
|
|
290
|
+
throw Error("upsertDocuments must be overridden by the child class");
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* This method removes every document matching the given filters.
|
|
294
|
+
*
|
|
295
|
+
* Deleting by ID isn't a special case — it arrives as a filter on the primary key, such
|
|
296
|
+
* as `{ id: ["prod_1", "prod_2"] }`. Recognize that shape and use your engine's
|
|
297
|
+
* delete-by-ID path, which is usually much faster. If your engine can't delete by
|
|
298
|
+
* arbitrary filters, either search first and delete the matching IDs, or throw.
|
|
299
|
+
*
|
|
300
|
+
* @param {SearchTypes.SearchDeleteDocumentsInput} _input - The index and the filters
|
|
301
|
+
* selecting the documents to remove.
|
|
302
|
+
* @returns {Promise<SearchTypes.SearchTask>} The write's task.
|
|
303
|
+
*
|
|
304
|
+
* @example
|
|
305
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
306
|
+
* // ...
|
|
307
|
+
* async deleteDocuments({
|
|
308
|
+
* index,
|
|
309
|
+
* filters,
|
|
310
|
+
* }: SearchTypes.SearchDeleteDocumentsInput): Promise<SearchTypes.SearchTask> {
|
|
311
|
+
* await this.client.deleteDocumentsByFilter(index, filters)
|
|
312
|
+
* return { index, status: "succeeded" }
|
|
313
|
+
* }
|
|
314
|
+
* }
|
|
315
|
+
*/
|
|
316
|
+
async deleteDocuments(_input) {
|
|
317
|
+
throw Error("deleteDocuments must be overridden by the child class");
|
|
318
|
+
}
|
|
319
|
+
/**
|
|
320
|
+
* This method removes every document from an index without deleting the index itself.
|
|
321
|
+
* The Search Module uses it to empty an index before reseeding it in place.
|
|
322
|
+
*
|
|
323
|
+
* @param {object} _input - The index to empty.
|
|
324
|
+
* @param {string} _input.index - The index's physical name.
|
|
325
|
+
* @returns {Promise<SearchTypes.SearchTask>} The write's task.
|
|
326
|
+
*
|
|
327
|
+
* @example
|
|
328
|
+
* class MySearchProviderService extends AbstractSearchProviderService {
|
|
329
|
+
* // ...
|
|
330
|
+
* async clearIndex({
|
|
331
|
+
* index,
|
|
332
|
+
* }: {
|
|
333
|
+
* index: string
|
|
334
|
+
* }): Promise<SearchTypes.SearchTask> {
|
|
335
|
+
* await this.client.deleteAllDocuments(index)
|
|
336
|
+
* return { index, status: "succeeded" }
|
|
337
|
+
* }
|
|
338
|
+
* }
|
|
339
|
+
*/
|
|
340
|
+
async clearIndex(_input) {
|
|
341
|
+
throw Error("clearIndex must be overridden by the child class");
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
exports.AbstractSearchProviderService = AbstractSearchProviderService;
|
|
345
|
+
//# sourceMappingURL=abstract-search-provider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"abstract-search-provider.js","sourceRoot":"","sources":["../../src/search/abstract-search-provider.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,MAAa,6BAA6B;IAiBxC;;OAEG;IACH,IAAI,UAAU;QACZ,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,MAAM,CACV,MAAuC;QAEvC,MAAM,KAAK,CAAC,8CAA8C,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,UAAU,CACd,MAAyC;QAEzC,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,WAAW,CAAC,MAEjB;QACC,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAA;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,WAAW,CAAC,MAEjB;QACC,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAA;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAA;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,eAAe,CAAC,MAIrB;QACC,MAAM,KAAK,CAAC,uDAAuD,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,eAAe,CACnB,MAA8C;QAE9C,MAAM,KAAK,CAAC,uDAAuD,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,UAAU,CAAC,MAAyB;QACxC,MAAM,KAAK,CAAC,kDAAkD,CAAC,CAAA;IACjE,CAAC;CACF;AAhTD,sEAgTC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { SearchTypes } from "@etohq/types";
|
|
2
|
+
/**
|
|
3
|
+
* Declares a search index. Like `defineLink`, the file registers itself on
|
|
4
|
+
* import: the application loads every file under `search/` and hands what was
|
|
5
|
+
* registered to the Search Module as its `indexes` option, so the module has one
|
|
6
|
+
* input rather than a registry and an option that can disagree.
|
|
7
|
+
*
|
|
8
|
+
* `fields` must be a schema from `search.define({ ... })`. The documents
|
|
9
|
+
* `seed` yields are type-checked against the declared fields.
|
|
10
|
+
*/
|
|
11
|
+
export declare function defineSearchIndex<Fields extends SearchTypes.SearchIndexFieldsInput>(definition: SearchTypes.SearchIndexDefinitionInput<Fields>): SearchTypes.SearchIndexDefinition;
|
|
12
|
+
//# sourceMappingURL=define-search-index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-search-index.d.ts","sourceRoot":"","sources":["../../src/search/define-search-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAQ1C;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,SAAS,WAAW,CAAC,sBAAsB,EAEjD,UAAU,EAAE,WAAW,CAAC,0BAA0B,CAAC,MAAM,CAAC,GACzD,WAAW,CAAC,qBAAqB,CAmBnC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.defineSearchIndex = defineSearchIndex;
|
|
4
|
+
const common_1 = require("../common");
|
|
5
|
+
const search_scope_1 = require("./search-scope");
|
|
6
|
+
/**
|
|
7
|
+
* Declares a search index. Like `defineLink`, the file registers itself on
|
|
8
|
+
* import: the application loads every file under `search/` and hands what was
|
|
9
|
+
* registered to the Search Module as its `indexes` option, so the module has one
|
|
10
|
+
* input rather than a registry and an option that can disagree.
|
|
11
|
+
*
|
|
12
|
+
* `fields` must be a schema from `search.define({ ... })`. The documents
|
|
13
|
+
* `seed` yields are type-checked against the declared fields.
|
|
14
|
+
*/
|
|
15
|
+
function defineSearchIndex(definition) {
|
|
16
|
+
const callerFilePath = (0, common_1.getCallerFilePath)();
|
|
17
|
+
if ((0, common_1.isFileDisabled)(callerFilePath ?? "")) {
|
|
18
|
+
return { [common_1.ETO_SKIP_FILE]: true };
|
|
19
|
+
}
|
|
20
|
+
const normalized = {
|
|
21
|
+
...definition,
|
|
22
|
+
fields: normalizeFields(definition.fields),
|
|
23
|
+
};
|
|
24
|
+
// Refused here, at the declaration, as well as when the module resolves its
|
|
25
|
+
// indexes, so a leaky scope never gets as far as booting.
|
|
26
|
+
(0, search_scope_1.validateSearchScope)(normalized);
|
|
27
|
+
global.EtoModule.setSearchIndex(normalized, callerFilePath ?? undefined);
|
|
28
|
+
return normalized;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Compiles a `search.define(...)` schema into plain SearchFieldDefinition
|
|
32
|
+
* records. Normalization happens here, at the declaration boundary, so the
|
|
33
|
+
* Search Module only ever sees plain definitions and nothing user-facing
|
|
34
|
+
* calls `toFields()`.
|
|
35
|
+
*
|
|
36
|
+
* The input type advertises `toFields()` structurally, so normalization
|
|
37
|
+
* duck-types on it rather than checking for our own class — a schema built by
|
|
38
|
+
* a duplicated copy of @etohq/utils, or any object honoring the contract,
|
|
39
|
+
* still normalizes.
|
|
40
|
+
*/
|
|
41
|
+
function normalizeFields(fields) {
|
|
42
|
+
if (typeof fields?.toFields !== "function") {
|
|
43
|
+
throw new Error("`defineSearchIndex` fields must come from `search.define({ ... })`");
|
|
44
|
+
}
|
|
45
|
+
return fields.toFields();
|
|
46
|
+
}
|
|
47
|
+
//# sourceMappingURL=define-search-index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-search-index.js","sourceRoot":"","sources":["../../src/search/define-search-index.ts"],"names":[],"mappings":";;AAiBA,8CAuBC;AAvCD,sCAIkB;AAClB,iDAAoD;AAEpD;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAG/B,UAA0D;IAE1D,MAAM,cAAc,GAAG,IAAA,0BAAiB,GAAE,CAAA;IAE1C,IAAI,IAAA,uBAAc,EAAC,cAAc,IAAI,EAAE,CAAC,EAAE,CAAC;QACzC,OAAO,EAAE,CAAC,sBAAa,CAAC,EAAE,IAAI,EAAS,CAAA;IACzC,CAAC;IAED,MAAM,UAAU,GAAsC;QACpD,GAAG,UAAU;QACb,MAAM,EAAE,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC;KAC3C,CAAA;IAED,4EAA4E;IAC5E,0DAA0D;IAC1D,IAAA,kCAAmB,EAAC,UAAU,CAAC,CAAA;IAE/B,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,cAAc,IAAI,SAAS,CAAC,CAAA;IAExE,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,eAAe,CACtB,MAA0C;IAE1C,IAAI,OAAO,MAAM,EAAE,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;IACH,CAAC;IAED,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC"}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { QueryContextType, SearchTypes } from "@etohq/types";
|
|
2
|
+
/**
|
|
3
|
+
* `seed` and `consume` implementations backed by `query.graph`.
|
|
4
|
+
*
|
|
5
|
+
* Nearly every index is a projection of an entity that already lives behind
|
|
6
|
+
* `query.graph`, so the helpers simplify catchup, soft-deletes and similar,
|
|
7
|
+
* which should be enough for most use cases.
|
|
8
|
+
*/
|
|
9
|
+
type GraphRow = Record<string, any>;
|
|
10
|
+
export type SearchConsumeEvent = Parameters<NonNullable<SearchTypes.SearchIndexDefinition["consume"]>>[0];
|
|
11
|
+
export type SearchGraphQueryContext = QueryContextType | ((context: SearchTypes.SearchIngestionContext) => QueryContextType);
|
|
12
|
+
export interface SearchGraphSourceOptions<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow> {
|
|
13
|
+
/**
|
|
14
|
+
* The `query.graph` entrypoint to read from. Defaults to the index
|
|
15
|
+
* definition's `entity`.
|
|
16
|
+
*/
|
|
17
|
+
entity?: string;
|
|
18
|
+
/**
|
|
19
|
+
* The fields to select from `query.graph`. Without a `transform` the row is
|
|
20
|
+
* indexed as-is, so this should then select exactly what the index declares.
|
|
21
|
+
*/
|
|
22
|
+
fields: string[];
|
|
23
|
+
/**
|
|
24
|
+
* The query context `query.graph` reads the rows with, e.g. the pricing
|
|
25
|
+
* context `variants.calculated_price` needs. Applied to seed, catch-up and
|
|
26
|
+
* `consume` alike.
|
|
27
|
+
*/
|
|
28
|
+
context?: SearchGraphQueryContext;
|
|
29
|
+
/**
|
|
30
|
+
* Maps a page of rows to the documents to index, e.g. `rows.map(toDocument)`.
|
|
31
|
+
* Async, and handed the whole page, so reads `query.graph` cannot make in
|
|
32
|
+
* one pass — prices in several currencies, say — cost a fixed number of
|
|
33
|
+
* queries per page. Every document must carry the row's primary key value
|
|
34
|
+
* as `id`; a row with no document is excluded, which `consume` and the
|
|
35
|
+
* catch-up pass turn into a delete so it leaves the index rather than
|
|
36
|
+
* going stale in it.
|
|
37
|
+
*
|
|
38
|
+
* Defaults to indexing the rows as-is.
|
|
39
|
+
*/
|
|
40
|
+
transform?: (rows: TRow[], context: SearchTypes.SearchIngestionContext) => SearchTypes.InferSearchDocumentType<Fields>[] | Promise<SearchTypes.InferSearchDocumentType<Fields>[]>;
|
|
41
|
+
}
|
|
42
|
+
export interface SearchGraphSeedOptions<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow> extends SearchGraphSourceOptions<Fields, TRow> {
|
|
43
|
+
/**
|
|
44
|
+
* The number of rows read from `query.graph` per page.
|
|
45
|
+
*
|
|
46
|
+
* @default 200
|
|
47
|
+
*/
|
|
48
|
+
batch_size?: number;
|
|
49
|
+
}
|
|
50
|
+
export interface SearchGraphConsumeOptions<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow> extends SearchGraphSourceOptions<Fields, TRow> {
|
|
51
|
+
/**
|
|
52
|
+
* The IDs of the documents the event affects, which are read back through
|
|
53
|
+
* `query.graph` and written to the index. May be async, e.g. to map an
|
|
54
|
+
* event about a variant or a category to the products it belongs to.
|
|
55
|
+
*
|
|
56
|
+
* Defaults to `event.data.id`, as a single ID or an array of them.
|
|
57
|
+
*/
|
|
58
|
+
resolve_ids?: (event: SearchConsumeEvent, context: SearchTypes.SearchIngestionContext) => string[] | string | undefined | Promise<string[] | string | undefined>;
|
|
59
|
+
/**
|
|
60
|
+
* Whether the event removes its documents from the index rather than
|
|
61
|
+
* updating them. A deleted row can't be read back, so it's deleted by ID
|
|
62
|
+
* without going to `query.graph`.
|
|
63
|
+
*
|
|
64
|
+
* @default an event whose name ends in `.deleted`
|
|
65
|
+
*/
|
|
66
|
+
is_delete?: (event: SearchConsumeEvent) => boolean;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Builds an index definition's `seed` from a `query.graph` query.
|
|
70
|
+
*
|
|
71
|
+
* The seed pages the entity in ascending order of the index' primary key, so
|
|
72
|
+
* the next page starts after the last row and a run interrupted halfway
|
|
73
|
+
* resumes from the context's `last_key` rather than restarting. The catch-up
|
|
74
|
+
* pass that follows a full seed reads the rows touched since it started with
|
|
75
|
+
* soft-deleted ones included, and turns those — along with any row the
|
|
76
|
+
* `transform` rejects — into deletes.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* const productFields = search.define({
|
|
80
|
+
* id: search.keyword().filterable(),
|
|
81
|
+
* title: search.text().searchable(),
|
|
82
|
+
* })
|
|
83
|
+
*
|
|
84
|
+
* export default defineSearchIndex({
|
|
85
|
+
* name: "product",
|
|
86
|
+
* entity: "product",
|
|
87
|
+
* fields: productFields,
|
|
88
|
+
* seed: graphSeed({ fields: ["id", "title"] }),
|
|
89
|
+
* })
|
|
90
|
+
*/
|
|
91
|
+
export declare function graphSeed<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow>(options: SearchGraphSeedOptions<Fields, TRow>): NonNullable<SearchTypes.SearchIndexDefinitionInput<Fields>["seed"]>;
|
|
92
|
+
/**
|
|
93
|
+
* Builds an index definition's `consume` from a `query.graph` query.
|
|
94
|
+
*
|
|
95
|
+
* The event's IDs are read back through `query.graph` and upserted. An ID the
|
|
96
|
+
* read doesn't return, or whose row the `transform` rejects, is deleted
|
|
97
|
+
* instead — which is what keeps a row that was removed, unpublished, or
|
|
98
|
+
* filtered out of the index from lingering in it.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* export default defineSearchIndex({
|
|
102
|
+
* name: "product",
|
|
103
|
+
* entity: "product",
|
|
104
|
+
* fields: productFields,
|
|
105
|
+
* events: ["product.created", "product.updated", "product.deleted"],
|
|
106
|
+
* consume: graphConsume({ fields: ["id", "title"] }),
|
|
107
|
+
* seed: graphSeed({ fields: ["id", "title"] }),
|
|
108
|
+
* })
|
|
109
|
+
*/
|
|
110
|
+
export declare function graphConsume<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow>(options: SearchGraphConsumeOptions<Fields, TRow>): NonNullable<SearchTypes.SearchIndexDefinitionInput<Fields>["consume"]>;
|
|
111
|
+
export {};
|
|
112
|
+
//# sourceMappingURL=definition-helpers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"definition-helpers.d.ts","sourceRoot":"","sources":["../../src/search/definition-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE5D;;;;;;GAMG;AAEH,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAMnC,MAAM,MAAM,kBAAkB,GAAG,UAAU,CACzC,WAAW,CAAC,WAAW,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAC1D,CAAC,CAAC,CAAC,CAAA;AAEJ,MAAM,MAAM,uBAAuB,GAC/B,gBAAgB,GAChB,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,sBAAsB,KAAK,gBAAgB,CAAC,CAAA;AAEvE,MAAM,WAAW,wBAAwB,CACvC,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAEhB;;;;OAIG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,IAAI,EAAE,EACZ,OAAO,EAAE,WAAW,CAAC,sBAAsB,KAEzC,WAAW,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,GAC7C,OAAO,CAAC,WAAW,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;CAC3D;AAED,MAAM,WAAW,sBAAsB,CACrC,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,CAChC,SAAQ,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;IAC9C;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,yBAAyB,CACxC,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,CAChC,SAAQ,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;IAC9C;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,CACZ,KAAK,EAAE,kBAAkB,EACzB,OAAO,EAAE,WAAW,CAAC,sBAAsB,KACxC,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAAC,CAAA;IAE3E;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,OAAO,CAAA;CACnD;AAuFD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,SAAS,CACvB,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAEhC,OAAO,EAAE,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,GAC5C,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAoErE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAEhC,OAAO,EAAE,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,GAC/C,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAiDxE"}
|