@heavybit/ecommerce-contracts 0.3.22 → 0.3.23
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/cjs/internal/search.js +25 -1
- package/dist/cjs/internal/search.js.map +1 -1
- package/dist/esm/internal/search.js +24 -0
- package/dist/esm/internal/search.js.map +1 -1
- package/dist/types/internal/search.d.ts +56 -0
- package/dist/types/internal/search.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.searchDocumentPageSchema = exports.searchDocumentLookupSchema = exports.searchDocumentSchema = exports.MAX_SEARCH_DOCUMENT_PAGE = void 0;
|
|
3
|
+
exports.searchResultSchema = exports.searchQuerySchema = exports.MAX_SEARCH_CATEGORIES = exports.MAX_SEARCH_PAGE = exports.SEARCH_SORTS = exports.searchDocumentPageSchema = exports.searchDocumentLookupSchema = exports.searchDocumentSchema = exports.MAX_SEARCH_DOCUMENT_PAGE = void 0;
|
|
4
4
|
/**
|
|
5
5
|
* Internal answers catalog-service gives search-service so it can build and rebuild its index (Prompt 26.1): one product
|
|
6
6
|
* as a flat search document, and pages of them. Only sellable products of active shops are ever returned.
|
|
@@ -29,4 +29,28 @@ exports.searchDocumentSchema = shared_lib_1.z.object({
|
|
|
29
29
|
exports.searchDocumentLookupSchema = shared_lib_1.z.object({ document: exports.searchDocumentSchema.nullable() }).passthrough();
|
|
30
30
|
/** Envelope `data` of `GET /api/v1/internal/search-documents?companyId=&cursor=&limit=`: a page and the cursor of the next one. */
|
|
31
31
|
exports.searchDocumentPageSchema = shared_lib_1.z.object({ items: shared_lib_1.z.array(exports.searchDocumentSchema), nextCursor: shared_lib_1.z.string().nullable() }).passthrough();
|
|
32
|
+
/** Sorts the engine can apply (Prompt 26.2). `relevance` is the engine's own ranking. */
|
|
33
|
+
exports.SEARCH_SORTS = ['relevance', 'price_asc', 'price_desc', 'newest', 'rating'];
|
|
34
|
+
/** Most ids one `GET /internal/search` page returns. */
|
|
35
|
+
exports.MAX_SEARCH_PAGE = 100;
|
|
36
|
+
/** Most category ids one search can filter on (the chosen category plus its children). */
|
|
37
|
+
exports.MAX_SEARCH_CATEGORIES = 100;
|
|
38
|
+
/**
|
|
39
|
+
* Query of `GET /api/v1/internal/search` (caller: catalog-service). Always scoped to one shop (`companyId`, TEN-8).
|
|
40
|
+
* `categoryIds` is a comma-separated list of ULIDs; prices are minor units (KES cents, campaign-aware, CR-26-01).
|
|
41
|
+
*/
|
|
42
|
+
exports.searchQuerySchema = shared_lib_1.z.object({
|
|
43
|
+
companyId: shared_lib_1.idSchema,
|
|
44
|
+
q: shared_lib_1.z.string().trim().min(1).max(200),
|
|
45
|
+
categoryIds: shared_lib_1.z.string().max(exports.MAX_SEARCH_CATEGORIES * 27).optional().transform((v) => (v ? v.split(',').filter(Boolean) : undefined))
|
|
46
|
+
.pipe(shared_lib_1.z.array(shared_lib_1.idSchema).max(exports.MAX_SEARCH_CATEGORIES).optional()),
|
|
47
|
+
minPriceCents: shared_lib_1.z.coerce.number().int().nonnegative().optional(),
|
|
48
|
+
maxPriceCents: shared_lib_1.z.coerce.number().int().nonnegative().optional(),
|
|
49
|
+
inStock: shared_lib_1.z.enum(['true', 'false']).optional().transform((v) => (v === undefined ? undefined : v === 'true')),
|
|
50
|
+
sort: shared_lib_1.z.enum(exports.SEARCH_SORTS).default('relevance'),
|
|
51
|
+
offset: shared_lib_1.z.coerce.number().int().min(0).max(10_000).default(0),
|
|
52
|
+
limit: shared_lib_1.z.coerce.number().int().min(1).max(exports.MAX_SEARCH_PAGE).default(24),
|
|
53
|
+
}).strict();
|
|
54
|
+
/** Envelope `data` of `GET /api/v1/internal/search`: product ids in result order and the engine's total hit count. Catalog hydrates the cards. */
|
|
55
|
+
exports.searchResultSchema = shared_lib_1.z.object({ ids: shared_lib_1.z.array(shared_lib_1.idSchema), total: shared_lib_1.z.number().int().nonnegative() }).passthrough();
|
|
32
56
|
//# sourceMappingURL=search.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/internal/search.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,qDAAmD;AAEnD,yEAAyE;AAC5D,QAAA,wBAAwB,GAAG,GAAG,CAAC;AAE5C;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,cAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,qBAAQ;IACZ,SAAS,EAAE,qBAAQ;IACnB,IAAI,EAAE,cAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,cAAC,CAAC,KAAK,CAAC,qBAAQ,CAAC;IAC9B,KAAK,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,OAAO,EAAE,cAAC,CAAC,OAAO,EAAE;IACpB,MAAM,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,SAAS,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;CACjD,CAAC,CAAC,WAAW,EAAE,CAAC;AAEjB,kMAAkM;AACrL,QAAA,0BAA0B,GAAG,cAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,4BAAoB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAEhH,mIAAmI;AACtH,QAAA,wBAAwB,GAAG,cAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,cAAC,CAAC,KAAK,CAAC,4BAAoB,CAAC,EAAE,UAAU,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/internal/search.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,qDAAmD;AAEnD,yEAAyE;AAC5D,QAAA,wBAAwB,GAAG,GAAG,CAAC;AAE5C;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,cAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,qBAAQ;IACZ,SAAS,EAAE,qBAAQ;IACnB,IAAI,EAAE,cAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,cAAC,CAAC,KAAK,CAAC,qBAAQ,CAAC;IAC9B,KAAK,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,OAAO,EAAE,cAAC,CAAC,OAAO,EAAE;IACpB,MAAM,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,SAAS,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;CACjD,CAAC,CAAC,WAAW,EAAE,CAAC;AAEjB,kMAAkM;AACrL,QAAA,0BAA0B,GAAG,cAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,4BAAoB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAEhH,mIAAmI;AACtH,QAAA,wBAAwB,GAAG,cAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,cAAC,CAAC,KAAK,CAAC,4BAAoB,CAAC,EAAE,UAAU,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAS5I,yFAAyF;AAC5E,QAAA,YAAY,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAC;AAElG,wDAAwD;AAC3C,QAAA,eAAe,GAAG,GAAG,CAAC;AAEnC,0FAA0F;AAC7E,QAAA,qBAAqB,GAAG,GAAG,CAAC;AAEzC;;;GAGG;AACU,QAAA,iBAAiB,GAAG,cAAC,CAAC,MAAM,CAAC;IACxC,SAAS,EAAE,qBAAQ;IACnB,CAAC,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACpC,WAAW,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,6BAAqB,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;SAChI,IAAI,CAAC,cAAC,CAAC,KAAK,CAAC,qBAAQ,CAAC,CAAC,GAAG,CAAC,6BAAqB,CAAC,CAAC,QAAQ,EAAE,CAAC;IAChE,aAAa,EAAE,cAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/D,aAAa,EAAE,cAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/D,OAAO,EAAE,cAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;IAC5G,IAAI,EAAE,cAAC,CAAC,IAAI,CAAC,oBAAY,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC/C,MAAM,EAAE,cAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7D,KAAK,EAAE,cAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,uBAAe,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACvE,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,kJAAkJ;AACrI,QAAA,kBAAkB,GAAG,cAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,cAAC,CAAC,KAAK,CAAC,qBAAQ,CAAC,EAAE,KAAK,EAAE,cAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC"}
|
|
@@ -26,4 +26,28 @@ export const searchDocumentSchema = z.object({
|
|
|
26
26
|
export const searchDocumentLookupSchema = z.object({ document: searchDocumentSchema.nullable() }).passthrough();
|
|
27
27
|
/** Envelope `data` of `GET /api/v1/internal/search-documents?companyId=&cursor=&limit=`: a page and the cursor of the next one. */
|
|
28
28
|
export const searchDocumentPageSchema = z.object({ items: z.array(searchDocumentSchema), nextCursor: z.string().nullable() }).passthrough();
|
|
29
|
+
/** Sorts the engine can apply (Prompt 26.2). `relevance` is the engine's own ranking. */
|
|
30
|
+
export const SEARCH_SORTS = ['relevance', 'price_asc', 'price_desc', 'newest', 'rating'];
|
|
31
|
+
/** Most ids one `GET /internal/search` page returns. */
|
|
32
|
+
export const MAX_SEARCH_PAGE = 100;
|
|
33
|
+
/** Most category ids one search can filter on (the chosen category plus its children). */
|
|
34
|
+
export const MAX_SEARCH_CATEGORIES = 100;
|
|
35
|
+
/**
|
|
36
|
+
* Query of `GET /api/v1/internal/search` (caller: catalog-service). Always scoped to one shop (`companyId`, TEN-8).
|
|
37
|
+
* `categoryIds` is a comma-separated list of ULIDs; prices are minor units (KES cents, campaign-aware, CR-26-01).
|
|
38
|
+
*/
|
|
39
|
+
export const searchQuerySchema = z.object({
|
|
40
|
+
companyId: idSchema,
|
|
41
|
+
q: z.string().trim().min(1).max(200),
|
|
42
|
+
categoryIds: z.string().max(MAX_SEARCH_CATEGORIES * 27).optional().transform((v) => (v ? v.split(',').filter(Boolean) : undefined))
|
|
43
|
+
.pipe(z.array(idSchema).max(MAX_SEARCH_CATEGORIES).optional()),
|
|
44
|
+
minPriceCents: z.coerce.number().int().nonnegative().optional(),
|
|
45
|
+
maxPriceCents: z.coerce.number().int().nonnegative().optional(),
|
|
46
|
+
inStock: z.enum(['true', 'false']).optional().transform((v) => (v === undefined ? undefined : v === 'true')),
|
|
47
|
+
sort: z.enum(SEARCH_SORTS).default('relevance'),
|
|
48
|
+
offset: z.coerce.number().int().min(0).max(10_000).default(0),
|
|
49
|
+
limit: z.coerce.number().int().min(1).max(MAX_SEARCH_PAGE).default(24),
|
|
50
|
+
}).strict();
|
|
51
|
+
/** Envelope `data` of `GET /api/v1/internal/search`: product ids in result order and the engine's total hit count. Catalog hydrates the cards. */
|
|
52
|
+
export const searchResultSchema = z.object({ ids: z.array(idSchema), total: z.number().int().nonnegative() }).passthrough();
|
|
29
53
|
//# sourceMappingURL=search.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/internal/search.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAEnD,yEAAyE;AACzE,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAE5C;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,QAAQ;IACZ,SAAS,EAAE,QAAQ;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;CACjD,CAAC,CAAC,WAAW,EAAE,CAAC;AAEjB,kMAAkM;AAClM,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,oBAAoB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAEhH,mIAAmI;AACnI,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/internal/search.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAEnD,yEAAyE;AACzE,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAE5C;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,QAAQ;IACZ,SAAS,EAAE,QAAQ;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;CACjD,CAAC,CAAC,WAAW,EAAE,CAAC;AAEjB,kMAAkM;AAClM,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,oBAAoB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAEhH,mIAAmI;AACnI,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAS5I,yFAAyF;AACzF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAC;AAElG,wDAAwD;AACxD,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAC;AAEnC,0FAA0F;AAC1F,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,SAAS,EAAE,QAAQ;IACnB,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACpC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;SAChI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE,CAAC;IAChE,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/D,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/D,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;IAC5G,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC/C,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7D,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACvE,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,kJAAkJ;AAClJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC"}
|
|
@@ -267,4 +267,60 @@ export type SearchDocument = z.infer<typeof searchDocumentSchema>;
|
|
|
267
267
|
export type SearchDocumentLookup = z.infer<typeof searchDocumentLookupSchema>;
|
|
268
268
|
/** Answer of the page read. */
|
|
269
269
|
export type SearchDocumentPage = z.infer<typeof searchDocumentPageSchema>;
|
|
270
|
+
/** Sorts the engine can apply (Prompt 26.2). `relevance` is the engine's own ranking. */
|
|
271
|
+
export declare const SEARCH_SORTS: readonly ["relevance", "price_asc", "price_desc", "newest", "rating"];
|
|
272
|
+
/** Most ids one `GET /internal/search` page returns. */
|
|
273
|
+
export declare const MAX_SEARCH_PAGE = 100;
|
|
274
|
+
/** Most category ids one search can filter on (the chosen category plus its children). */
|
|
275
|
+
export declare const MAX_SEARCH_CATEGORIES = 100;
|
|
276
|
+
/**
|
|
277
|
+
* Query of `GET /api/v1/internal/search` (caller: catalog-service). Always scoped to one shop (`companyId`, TEN-8).
|
|
278
|
+
* `categoryIds` is a comma-separated list of ULIDs; prices are minor units (KES cents, campaign-aware, CR-26-01).
|
|
279
|
+
*/
|
|
280
|
+
export declare const searchQuerySchema: z.ZodObject<{
|
|
281
|
+
companyId: z.ZodString;
|
|
282
|
+
q: z.ZodString;
|
|
283
|
+
categoryIds: z.ZodPipeline<z.ZodEffects<z.ZodOptional<z.ZodString>, string[] | undefined, string | undefined>, z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
284
|
+
minPriceCents: z.ZodOptional<z.ZodNumber>;
|
|
285
|
+
maxPriceCents: z.ZodOptional<z.ZodNumber>;
|
|
286
|
+
inStock: z.ZodEffects<z.ZodOptional<z.ZodEnum<["true", "false"]>>, boolean | undefined, "true" | "false" | undefined>;
|
|
287
|
+
sort: z.ZodDefault<z.ZodEnum<["relevance", "price_asc", "price_desc", "newest", "rating"]>>;
|
|
288
|
+
offset: z.ZodDefault<z.ZodNumber>;
|
|
289
|
+
limit: z.ZodDefault<z.ZodNumber>;
|
|
290
|
+
}, "strict", z.ZodTypeAny, {
|
|
291
|
+
sort: "rating" | "relevance" | "price_asc" | "price_desc" | "newest";
|
|
292
|
+
offset: number;
|
|
293
|
+
companyId: string;
|
|
294
|
+
q: string;
|
|
295
|
+
limit: number;
|
|
296
|
+
categoryIds?: string[] | undefined;
|
|
297
|
+
inStock?: boolean | undefined;
|
|
298
|
+
minPriceCents?: number | undefined;
|
|
299
|
+
maxPriceCents?: number | undefined;
|
|
300
|
+
}, {
|
|
301
|
+
companyId: string;
|
|
302
|
+
q: string;
|
|
303
|
+
sort?: "rating" | "relevance" | "price_asc" | "price_desc" | "newest" | undefined;
|
|
304
|
+
offset?: number | undefined;
|
|
305
|
+
categoryIds?: string | undefined;
|
|
306
|
+
inStock?: "true" | "false" | undefined;
|
|
307
|
+
minPriceCents?: number | undefined;
|
|
308
|
+
maxPriceCents?: number | undefined;
|
|
309
|
+
limit?: number | undefined;
|
|
310
|
+
}>;
|
|
311
|
+
/** Envelope `data` of `GET /api/v1/internal/search`: product ids in result order and the engine's total hit count. Catalog hydrates the cards. */
|
|
312
|
+
export declare const searchResultSchema: z.ZodObject<{
|
|
313
|
+
ids: z.ZodArray<z.ZodString, "many">;
|
|
314
|
+
total: z.ZodNumber;
|
|
315
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
316
|
+
ids: z.ZodArray<z.ZodString, "many">;
|
|
317
|
+
total: z.ZodNumber;
|
|
318
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
319
|
+
ids: z.ZodArray<z.ZodString, "many">;
|
|
320
|
+
total: z.ZodNumber;
|
|
321
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
322
|
+
/** Parsed search query. */
|
|
323
|
+
export type SearchQuery = z.output<typeof searchQuerySchema>;
|
|
324
|
+
/** Answer of the search. */
|
|
325
|
+
export type SearchResult = z.infer<typeof searchResultSchema>;
|
|
270
326
|
//# sourceMappingURL=search.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/internal/search.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAY,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAEnD,yEAAyE;AACzE,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAWjB,CAAC;AAEjB,kMAAkM;AAClM,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAAwE,CAAC;AAEhH,mIAAmI;AACnI,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAAsG,CAAC;AAE5I,6BAA6B;AAC7B,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,2CAA2C;AAC3C,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,+BAA+B;AAC/B,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/internal/search.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAY,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAEnD,yEAAyE;AACzE,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAWjB,CAAC;AAEjB,kMAAkM;AAClM,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAAwE,CAAC;AAEhH,mIAAmI;AACnI,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAAsG,CAAC;AAE5I,6BAA6B;AAC7B,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,2CAA2C;AAC3C,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,+BAA+B;AAC/B,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,yFAAyF;AACzF,eAAO,MAAM,YAAY,uEAAwE,CAAC;AAElG,wDAAwD;AACxD,eAAO,MAAM,eAAe,MAAM,CAAC;AAEnC,0FAA0F;AAC1F,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWnB,CAAC;AAEZ,kJAAkJ;AAClJ,eAAO,MAAM,kBAAkB;;;;;;;;;gCAA4F,CAAC;AAE5H,2BAA2B;AAC3B,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC7D,4BAA4B;AAC5B,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@heavybit/ecommerce-contracts",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.23",
|
|
4
4
|
"description": "The e-commerce app's shared contracts: app settings, identity and scope bindings, step-up scopes, event catalogue and v1 payload schemas. Built on @heavybit/shared-lib; no business logic.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|