@salesforce/b2c-cli 1.21.0 → 1.21.1
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/commands/docs/search.d.ts +5 -0
- package/dist/commands/docs/search.js +22 -4
- package/dist/commands/docs/search.js.map +1 -1
- package/oclif.manifest.json +9456 -9446
- package/package.json +2 -2
|
@@ -5,7 +5,11 @@ interface SearchDocsResponse {
|
|
|
5
5
|
query?: string;
|
|
6
6
|
category?: string;
|
|
7
7
|
workspace?: ProjectType[];
|
|
8
|
+
total: number;
|
|
9
|
+
offset: number;
|
|
8
10
|
results: SearchResult[];
|
|
11
|
+
truncated?: boolean;
|
|
12
|
+
nextOffset?: number;
|
|
9
13
|
}
|
|
10
14
|
interface ListDocsResponse {
|
|
11
15
|
entries: DocEntry[];
|
|
@@ -21,6 +25,7 @@ export default class DocsSearch extends BaseCommand<typeof DocsSearch> {
|
|
|
21
25
|
columns: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
22
26
|
extended: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
23
27
|
limit: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
|
|
28
|
+
offset: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
|
|
24
29
|
list: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
25
30
|
category: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
26
31
|
topics: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
@@ -73,6 +73,7 @@ export default class DocsSearch extends BaseCommand {
|
|
|
73
73
|
'<%= config.bin %> <%= command.id %> "passwordless login" --category commerce-api',
|
|
74
74
|
'<%= config.bin %> <%= command.id %> "storefront next getting started" --category sfnext',
|
|
75
75
|
'<%= config.bin %> <%= command.id %> status --limit 5',
|
|
76
|
+
'<%= config.bin %> <%= command.id %> "passwordless login" --limit 5 --offset 5',
|
|
76
77
|
'<%= config.bin %> <%= command.id %> --list --category tooling',
|
|
77
78
|
];
|
|
78
79
|
static flags = {
|
|
@@ -82,6 +83,12 @@ export default class DocsSearch extends BaseCommand {
|
|
|
82
83
|
description: 'Maximum number of results to display',
|
|
83
84
|
default: 20,
|
|
84
85
|
}),
|
|
86
|
+
offset: Flags.integer({
|
|
87
|
+
char: 'o',
|
|
88
|
+
description: 'Number of ranked results to skip (for pagination)',
|
|
89
|
+
default: 0,
|
|
90
|
+
min: 0,
|
|
91
|
+
}),
|
|
85
92
|
list: Flags.boolean({
|
|
86
93
|
description: 'List all available documentation entries',
|
|
87
94
|
default: false,
|
|
@@ -113,7 +120,9 @@ export default class DocsSearch extends BaseCommand {
|
|
|
113
120
|
};
|
|
114
121
|
async run() {
|
|
115
122
|
const { query } = this.args;
|
|
116
|
-
const { limit, list, category } = this.flags;
|
|
123
|
+
const { limit, list, category, offset } = this.flags;
|
|
124
|
+
const resultLimit = limit ?? 20;
|
|
125
|
+
const resultOffset = offset ?? 0;
|
|
117
126
|
// Allowlist that bounds the whole corpus. Precedence: --topics /
|
|
118
127
|
// SFCC_DOCS_TOPICS flag first, else the resolved config's `docsCategories`
|
|
119
128
|
// (dw.json `docs-categories`, SFCC_DOCS_CATEGORIES, package.json).
|
|
@@ -154,17 +163,25 @@ export default class DocsSearch extends BaseCommand {
|
|
|
154
163
|
}
|
|
155
164
|
// Workspace awareness is on by default for search (unset -> auto-detect).
|
|
156
165
|
const workspace = await this.resolveWorkspace(this.flags.workspace);
|
|
157
|
-
|
|
158
|
-
|
|
166
|
+
// searchDocs returns top-N hits. Retrieve the complete ranked set so the
|
|
167
|
+
// CLI can expose total count and offset-based pagination.
|
|
168
|
+
const ranked = this.operations.searchDocs(query, {
|
|
169
|
+
limit: Number.MAX_SAFE_INTEGER,
|
|
159
170
|
category: category,
|
|
160
171
|
workspace,
|
|
161
172
|
enabledCategories,
|
|
162
173
|
});
|
|
174
|
+
const results = ranked.slice(resultOffset, resultOffset + resultLimit);
|
|
175
|
+
const end = resultOffset + results.length;
|
|
176
|
+
const truncated = end < ranked.length;
|
|
163
177
|
const response = {
|
|
164
178
|
query,
|
|
165
179
|
...(category && { category }),
|
|
166
180
|
...(workspace && { workspace }),
|
|
181
|
+
total: ranked.length,
|
|
182
|
+
offset: resultOffset,
|
|
167
183
|
results,
|
|
184
|
+
...(truncated && { truncated: true, nextOffset: end }),
|
|
168
185
|
};
|
|
169
186
|
if (this.jsonEnabled()) {
|
|
170
187
|
return response;
|
|
@@ -174,8 +191,9 @@ export default class DocsSearch extends BaseCommand {
|
|
|
174
191
|
return response;
|
|
175
192
|
}
|
|
176
193
|
tableRenderer.render(results, selectColumns(this.flags, tableRenderer, DEFAULT_COLUMNS, this.warn.bind(this)));
|
|
177
|
-
this.log(t('commands.docs.search.resultCount', '
|
|
194
|
+
this.log(t('commands.docs.search.resultCount', 'Showing {{count}} of {{total}} matches for "{{query}}"', {
|
|
178
195
|
count: results.length,
|
|
196
|
+
total: ranked.length,
|
|
179
197
|
query,
|
|
180
198
|
}));
|
|
181
199
|
return response;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/commands/docs/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAC,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,WAAW,EACX,aAAa,EACb,cAAc,EACd,aAAa,GAEd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,UAAU,EACV,QAAQ,EACR,sBAAsB,EACtB,wBAAwB,EACxB,cAAc,GAIf,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAC,mBAAmB,EAAE,aAAa,EAAmB,MAAM,uCAAuC,CAAC;AAC3G,OAAO,EAAC,CAAC,EAAC,MAAM,qBAAqB,CAAC;AACtC,OAAO,EAAC,oBAAoB,EAAC,MAAM,+BAA+B,CAAC;
|
|
1
|
+
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/commands/docs/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAC,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,WAAW,EACX,aAAa,EACb,cAAc,EACd,aAAa,GAEd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,UAAU,EACV,QAAQ,EACR,sBAAsB,EACtB,wBAAwB,EACxB,cAAc,GAIf,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAC,mBAAmB,EAAE,aAAa,EAAmB,MAAM,uCAAuC,CAAC;AAC3G,OAAO,EAAC,CAAC,EAAC,MAAM,qBAAqB,CAAC;AACtC,OAAO,EAAC,oBAAoB,EAAC,MAAM,+BAA+B,CAAC;AAiBnE;;;;;;GAMG;AACH,MAAM,qBAAqB,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,aAAa,CAAU,CAAC;AAEzE;;;GAGG;AACH,MAAM,gBAAgB,GAA2B,cAAc,CAAC;AAEhE,MAAM,OAAO,GAA4C;IACvD,EAAE,EAAE;QACF,MAAM,EAAE,IAAI;QACZ,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;KACvB;IACD,KAAK,EAAE;QACL,MAAM,EAAE,OAAO;QACf,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK;KAC1B;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,UAAU;QAClB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE;KACnC;IACD,OAAO,EAAE;QACP,MAAM,EAAE,SAAS;QACjB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE;KACrD;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,UAAU;QAClB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;KAChD;IACD,GAAG,EAAE;QACH,MAAM,EAAE,KAAK;QACb,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE;KAC9B;IACD,SAAS,EAAE;QACT,MAAM,EAAE,YAAY;QACpB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE;KACpC;IACD,KAAK,EAAE;QACL,MAAM,EAAE,OAAO;QACf,uEAAuE;QACvE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;KAC/B;CACF,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAE7D,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;AAEjD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAA8B;IACpE,MAAM,CAAC,IAAI,GAAG;QACZ,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,mFAAmF;YAChG,QAAQ,EAAE,KAAK;SAChB,CAAC;KACH,CAAC;IAEF,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,kCAAkC,EAAE,mCAAmC,CAAC,CAAC;IAEhG,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE7B,MAAM,CAAC,QAAQ,GAAG;QAChB,gDAAgD;QAChD,kFAAkF;QAClF,yFAAyF;QACzF,sDAAsD;QACtD,+EAA+E;QAC/E,+DAA+D;KAChE,CAAC;IAEF,MAAM,CAAC,KAAK,GAAG;QACb,GAAG,WAAW,CAAC,SAAS;QACxB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC;YACpB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,mDAAmD;YAChE,OAAO,EAAE,CAAC;YACV,GAAG,EAAE,CAAC;SACP,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC;YAClB,WAAW,EAAE,0CAA0C;YACvD,OAAO,EAAE,KAAK;SACf,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,8CAA8C;YAC3D,OAAO,EAAE,CAAC,GAAG,gBAAgB,CAAC;SAC/B,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,mGAAmG;gBACnG,uGAAuG;YACzG,GAAG,EAAE,kBAAkB;SACxB,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,4EAA4E;YAC5E,uEAAuE;YACvE,gEAAgE;YAChE,WAAW,EACT,oCAAoC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,iCAAiC;gBACpG,oGAAoG;SACvG,CAAC;QACF,iFAAiF;QACjF,GAAG,cAAc,CAAC,OAAO,EAAE,EAAC,WAAW,EAAE,KAAK,EAAC,CAAC;KACjD,CAAC;IAEQ,UAAU,GAAG;QACrB,mBAAmB;QACnB,QAAQ;QACR,UAAU;KACX,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,KAAK,EAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,MAAM,EAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACnD,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE,CAAC;QAChC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,CAAC;QACjC,iEAAiE;QACjE,2EAA2E;QAC3E,mEAAmE;QACnE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC;QACpF,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE,CAC1E,IAAI,CAAC,IAAI,CACP,CAAC,CAAC,oCAAoC,EAAE,qDAAqD,EAAE;YAC7F,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;SAC3B,CAAC,CACH,CACF,CAAC;QAEF,YAAY;QACZ,IAAI,IAAI,EAAE,CAAC;YACT,0EAA0E;YAC1E,0EAA0E;YAC1E,sEAAsE;YACtE,MAAM,aAAa,GACjB,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK;gBACpD,CAAC,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;gBACnD,CAAC,CAAC,SAAS,CAAC;YAChB,MAAM,UAAU,GACb,QAAoC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC/G,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBACvB,OAAO,EAAC,OAAO,EAAC,CAAC;YACnB,CAAC;YAED,gDAAgD;YAChD,MAAM,OAAO,GAAmB,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACtD,KAAK;gBACL,KAAK,EAAE,CAAC;aACT,CAAC,CAAC,CAAC;YAEJ,MAAM,WAAW,GAA4C;gBAC3D,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;aACrB,CAAC;YAEF,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;YAE5E,IAAI,CAAC,GAAG,CACN,CAAC,CAAC,iCAAiC,EAAE,2CAA2C,EAAE,EAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAC,CAAC,CAC3G,CAAC;YAEF,OAAO,EAAC,OAAO,EAAC,CAAC;QACnB,CAAC;QAED,6BAA6B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,CACR,CAAC,CAAC,oCAAoC,EAAE,8DAA8D,CAAC,CACxG,CAAC;QACJ,CAAC;QAED,0EAA0E;QAC1E,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEpE,yEAAyE;QACzE,0DAA0D;QAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE;YAC/C,KAAK,EAAE,MAAM,CAAC,gBAAgB;YAC9B,QAAQ,EAAE,QAAmC;YAC7C,SAAS;YACT,iBAAiB;SAClB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,GAAG,WAAW,CAAC,CAAC;QACvE,MAAM,GAAG,GAAG,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;QAC1C,MAAM,SAAS,GAAG,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;QAEtC,MAAM,QAAQ,GAAuB;YACnC,KAAK;YACL,GAAG,CAAC,QAAQ,IAAI,EAAC,QAAQ,EAAC,CAAC;YAC3B,GAAG,CAAC,SAAS,IAAI,EAAC,SAAS,EAAC,CAAC;YAC7B,KAAK,EAAE,MAAM,CAAC,MAAM;YACpB,MAAM,EAAE,YAAY;YACpB,OAAO;YACP,GAAG,CAAC,SAAS,IAAI,EAAC,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAC,CAAC;SACrD,CAAC;QAEF,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,gCAAgC,EAAE,4CAA4C,EAAE,EAAC,KAAK,EAAC,CAAC,CAAC,CAAC;YACtG,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE/G,IAAI,CAAC,GAAG,CACN,CAAC,CAAC,kCAAkC,EAAE,wDAAwD,EAAE;YAC9F,KAAK,EAAE,OAAO,CAAC,MAAM;YACrB,KAAK,EAAE,MAAM,CAAC,MAAM;YACpB,KAAK;SACN,CAAC,CACH,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,KAAyB;QAChD,OAAO,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7G,CAAC"}
|