@picked/cli 0.0.101-next.2 → 0.0.101-next.3

package/dist/cjs/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const e=require("../workspace-use-Cjn8sjJj.cjs");let t=require("@picked/config"),n=require("node:util"),r=require("@picked/telemetry");var i=2e3,a=null,o=0;function s(e){if((0,t.isTelemetryForcedOffByEnvironment)())return;o=Date.now();let n=(0,t.detectHostEnvironment)();a={name:`picked.cli.${e}`,traceId:(0,r.createTraceId)(),spanId:(0,r.createSpanId)(),startTimeUnixNano:(0,r.toUnixNano)(o),endTimeUnixNano:(0,r.toUnixNano)(o),attributes:{"picked.cli.command":e,"picked.env.provider":n.provider,"picked.env.ci":n.ci},status:`unset`}}function c(e){a&&(a.endTimeUnixNano=(0,r.toUnixNano)(Date.now()),a.status=e===0?`ok`:`error`)}async function l(){let e=a;if(a=null,e)try{let n=await(0,t.loadResolvedPickedConfig)();if(!n||!(0,t.isTelemetryEnabled)(n))return;let a=(0,r.createTelemetryEmitter)({resource:{"service.name":`picked-cli`},headers:{"Picked-Telemetry":`cli`}});a.record(e),await Promise.race([a.flush(),new Promise(e=>{setTimeout(e,i).unref()})])}catch{}}var u=`Usage:
+const e=require("../workspace-use-Df1AcQnn.cjs");let t=require("@picked/config"),n=require("node:util"),r=require("@picked/telemetry");var i=2e3,a=null,o=0;function s(e){if((0,t.isTelemetryForcedOffByEnvironment)())return;o=Date.now();let n=(0,t.detectHostEnvironment)();a={name:`picked.cli.${e}`,traceId:(0,r.createTraceId)(),spanId:(0,r.createSpanId)(),startTimeUnixNano:(0,r.toUnixNano)(o),endTimeUnixNano:(0,r.toUnixNano)(o),attributes:{"picked.cli.command":e,"picked.env.provider":n.provider,"picked.env.ci":n.ci},status:`unset`}}function c(e){a&&(a.endTimeUnixNano=(0,r.toUnixNano)(Date.now()),a.status=e===0?`ok`:`error`)}async function l(){let e=a;if(a=null,e)try{let n=await(0,t.loadResolvedPickedConfig)();if(!n||!(0,t.isTelemetryEnabled)(n))return;let a=(0,r.createTelemetryEmitter)({resource:{"service.name":`picked-cli`},headers:{"Picked-Telemetry":`cli`}});a.record(e),await Promise.race([a.flush(),new Promise(e=>{setTimeout(e,i).unref()})])}catch{}}var u=`Usage:
   picked login
   picked logout
   picked whoami
@@ -9,4 +9,6 @@ const e=require("../workspace-use-Cjn8sjJj.cjs");let t=require("@picked/config")
   picked use [--project <id>] [--workspace <id>] [--no-generate]
   picked workspace export --project <id> (--workspace <id> | --live) --out <dir>
   picked workspace import --project <id> --in <dir> [--name <name>] [--publish]
-  picked generate types [--check]`;async function d(){let{positionals:t,values:r}=(0,n.parseArgs)({allowPositionals:!0,options:{check:{type:`boolean`,default:!1},project:{type:`string`},workspace:{type:`string`},json:{type:`boolean`,default:!1},generate:{type:`boolean`,default:!0},"no-generate":{type:`boolean`,default:!1},live:{type:`boolean`,default:!1},out:{type:`string`},in:{type:`string`},name:{type:`string`},publish:{type:`boolean`,default:!1}}}),[i,a]=t,o=r.generate&&!r[`no-generate`];if(i===`login`){s(`login`),process.exitCode=await e.c({});return}if(i===`logout`){s(`logout`),process.exitCode=await e.s();return}if(i===`whoami`){s(`whoami`),process.exitCode=await e.a();return}if(i===`status`){s(`status`),process.exitCode=await e.o({});return}if(i===`workspace`&&(a===`list`||a===`ls`)){s(`workspace list`),process.exitCode=await e.n({json:r.json});return}if(i===`workspace`&&a===`use`||i===`use`){s(`workspace use`),process.exitCode=await e.t({project:r.project,workspace:r.workspace,generate:o});return}if(i===`workspace`&&a===`export`){s(`workspace export`),process.exitCode=await e.i({project:r.project,workspace:r.workspace,live:r.live,out:r.out});return}if(i===`workspace`&&a===`import`){s(`workspace import`),process.exitCode=await e.r({project:r.project,in:r.in,name:r.name,publish:r.publish});return}if(i===`generate`&&a===`types`){s(`generate types`),process.exitCode=await e.l({check:r.check});return}s(`unknown`),console.error(u),process.exitCode=1}function f(e){let t=2,n=()=>{--t,t<=0&&process.exit(e)};setTimeout(()=>{process.exit(e)},2e3).unref(),process.stdout.write(``,n),process.stderr.write(``,n)}d().then(async()=>{let e=typeof process.exitCode==`number`?process.exitCode:0;c(e),await l(),f(e)}).catch(e=>{let t=e instanceof Error?e.message:String(e);console.error(t),c(1),l().finally(()=>{f(1)})});
+  picked generate types [--check]
+  picked docs list [words] [--type <type>] [--json]
+  picked docs read <path>`,d=new Map([[`login`,()=>e.c({})],[`logout`,()=>e.s()],[`whoami`,()=>e.a()],[`status`,()=>e.o({})]]);async function f(){let{positionals:t,values:r}=(0,n.parseArgs)({allowPositionals:!0,options:{check:{type:`boolean`,default:!1},project:{type:`string`},workspace:{type:`string`},json:{type:`boolean`,default:!1},generate:{type:`boolean`,default:!0},"no-generate":{type:`boolean`,default:!1},live:{type:`boolean`,default:!1},out:{type:`string`},in:{type:`string`},name:{type:`string`},publish:{type:`boolean`,default:!1},type:{type:`string`}}}),[i,a]=t,o=r.generate&&!r[`no-generate`],c=i===void 0?void 0:d.get(i);if(i!==void 0&&c){s(i),process.exitCode=await c();return}if(i===`workspace`&&(a===`list`||a===`ls`)){s(`workspace list`),process.exitCode=await e.n({json:r.json});return}if(i===`workspace`&&a===`use`||i===`use`){s(`workspace use`),process.exitCode=await e.t({project:r.project,workspace:r.workspace,generate:o});return}if(i===`workspace`&&a===`export`){s(`workspace export`),process.exitCode=await e.i({project:r.project,workspace:r.workspace,live:r.live,out:r.out});return}if(i===`workspace`&&a===`import`){s(`workspace import`),process.exitCode=await e.r({project:r.project,in:r.in,name:r.name,publish:r.publish});return}if(i===`docs`){s(e.u(a)),process.exitCode=await e.d({args:t.slice(1),type:r.type,json:r.json});return}if(i===`generate`&&a===`types`){s(`generate types`),process.exitCode=await e.l({check:r.check});return}s(`unknown`),console.error(u),process.exitCode=1}function p(e){let t=2,n=()=>{--t,t<=0&&process.exit(e)};setTimeout(()=>{process.exit(e)},2e3).unref(),process.stdout.write(``,n),process.stderr.write(``,n)}f().then(async()=>{let e=typeof process.exitCode==`number`?process.exitCode:0;c(e),await l(),p(e)}).catch(e=>{let t=e instanceof Error?e.message:String(e);console.error(t),c(1),l().finally(()=>{p(1)})});

package/dist/cjs/index.js

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("../workspace-use-Cjn8sjJj.cjs");exports.runGenerateTypes=e.l,exports.runLogin=e.c,exports.runLogout=e.s,exports.runStatus=e.o,exports.runWhoami=e.a,exports.runWorkspaceExport=e.i,exports.runWorkspaceImport=e.r,exports.runWorkspaceList=e.n,exports.runWorkspaceUse=e.t;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("../workspace-use-Df1AcQnn.cjs");exports.runDocs=e.d,exports.runDocsList=e.f,exports.runDocsRead=e.p,exports.runGenerateTypes=e.l,exports.runLogin=e.c,exports.runLogout=e.s,exports.runStatus=e.o,exports.runWhoami=e.a,exports.runWorkspaceExport=e.i,exports.runWorkspaceImport=e.r,exports.runWorkspaceList=e.n,exports.runWorkspaceUse=e.t;

package/dist/esm/cli.js

@@ -1,20 +1,20 @@
 #!/usr/bin/env node
-import { a as e, c as t, i as n, l as r, n as i, o as a, r as o, s, t as c } from "../workspace-use-CnR5FkxR.js";
-import { detectHostEnvironment as l, isTelemetryEnabled as u, isTelemetryForcedOffByEnvironment as d, loadResolvedPickedConfig as f } from "@picked/config";
-import { parseArgs as p } from "node:util";
-import { createSpanId as m, createTelemetryEmitter as h, createTraceId as g, toUnixNano as _ } from "@picked/telemetry";
+import { a as e, c as t, d as n, i as r, l as i, n as a, o, r as s, s as c, t as l, u } from "../workspace-use-CXcLlf_z.js";
+import { detectHostEnvironment as d, isTelemetryEnabled as f, isTelemetryForcedOffByEnvironment as p, loadResolvedPickedConfig as m } from "@picked/config";
+import { parseArgs as h } from "node:util";
+import { createSpanId as g, createTelemetryEmitter as _, createTraceId as v, toUnixNano as y } from "@picked/telemetry";
 //#region src/telemetry.ts
-var v = 2e3, y = null, b = 0;
-function x(e) {
-	if (d()) return;
-	b = Date.now();
-	let t = l();
-	y = {
+var b = 2e3, x = null, S = 0;
+function C(e) {
+	if (p()) return;
+	S = Date.now();
+	let t = d();
+	x = {
 		name: `picked.cli.${e}`,
-		traceId: g(),
-		spanId: m(),
-		startTimeUnixNano: _(b),
-		endTimeUnixNano: _(b),
+		traceId: v(),
+		spanId: g(),
+		startTimeUnixNano: y(S),
+		endTimeUnixNano: y(S),
 		attributes: {
 			"picked.cli.command": e,
 			"picked.env.provider": t.provider,
@@ -23,28 +23,33 @@ function x(e) {
 		status: "unset"
 	};
 }
-function S(e) {
-	y && (y.endTimeUnixNano = _(Date.now()), y.status = e === 0 ? "ok" : "error");
+function w(e) {
+	x && (x.endTimeUnixNano = y(Date.now()), x.status = e === 0 ? "ok" : "error");
 }
-async function C() {
-	let e = y;
-	if (y = null, e) try {
-		let t = await f();
-		if (!t || !u(t)) return;
-		let n = h({
+async function T() {
+	let e = x;
+	if (x = null, e) try {
+		let t = await m();
+		if (!t || !f(t)) return;
+		let n = _({
 			resource: { "service.name": "picked-cli" },
 			headers: { "Picked-Telemetry": "cli" }
 		});
 		n.record(e), await Promise.race([n.flush(), new Promise((e) => {
-			setTimeout(e, v).unref();
+			setTimeout(e, b).unref();
 		})]);
 	} catch {}
 }
 //#endregion
 //#region src/cli.ts
-var w = "Usage:\n  picked login\n  picked logout\n  picked whoami\n  picked status\n  picked workspace list [--json]\n  picked workspace use [--project <id>] [--workspace <id>] [--no-generate]\n  picked use [--project <id>] [--workspace <id>] [--no-generate]\n  picked workspace export --project <id> (--workspace <id> | --live) --out <dir>\n  picked workspace import --project <id> --in <dir> [--name <name>] [--publish]\n  picked generate types [--check]";
-async function T() {
-	let { positionals: l, values: u } = p({
+var E = "Usage:\n  picked login\n  picked logout\n  picked whoami\n  picked status\n  picked workspace list [--json]\n  picked workspace use [--project <id>] [--workspace <id>] [--no-generate]\n  picked use [--project <id>] [--workspace <id>] [--no-generate]\n  picked workspace export --project <id> (--workspace <id> | --live) --out <dir>\n  picked workspace import --project <id> --in <dir> [--name <name>] [--publish]\n  picked generate types [--check]\n  picked docs list [words] [--type <type>] [--json]\n  picked docs read <path>", D = /* @__PURE__ */ new Map([
+	["login", () => t({})],
+	["logout", () => c()],
+	["whoami", () => e()],
+	["status", () => o({})]
+]);
+async function O() {
+	let { positionals: e, values: t } = h({
 		allowPositionals: !0,
 		options: {
 			check: {
@@ -75,62 +80,59 @@ async function T() {
 			publish: {
 				type: "boolean",
 				default: !1
-			}
+			},
+			type: { type: "string" }
 		}
-	}), [d, f] = l, m = u.generate && !u["no-generate"];
-	if (d === "login") {
-		x("login"), process.exitCode = await t({});
-		return;
-	}
-	if (d === "logout") {
-		x("logout"), process.exitCode = await s();
-		return;
-	}
-	if (d === "whoami") {
-		x("whoami"), process.exitCode = await e();
+	}), [o, c] = e, d = t.generate && !t["no-generate"], f = o === void 0 ? void 0 : D.get(o);
+	if (o !== void 0 && f) {
+		C(o), process.exitCode = await f();
 		return;
 	}
-	if (d === "status") {
-		x("status"), process.exitCode = await a({});
+	if (o === "workspace" && (c === "list" || c === "ls")) {
+		C("workspace list"), process.exitCode = await a({ json: t.json });
 		return;
 	}
-	if (d === "workspace" && (f === "list" || f === "ls")) {
-		x("workspace list"), process.exitCode = await i({ json: u.json });
+	if (o === "workspace" && c === "use" || o === "use") {
+		C("workspace use"), process.exitCode = await l({
+			project: t.project,
+			workspace: t.workspace,
+			generate: d
+		});
 		return;
 	}
-	if (d === "workspace" && f === "use" || d === "use") {
-		x("workspace use"), process.exitCode = await c({
-			project: u.project,
-			workspace: u.workspace,
-			generate: m
+	if (o === "workspace" && c === "export") {
+		C("workspace export"), process.exitCode = await r({
+			project: t.project,
+			workspace: t.workspace,
+			live: t.live,
+			out: t.out
 		});
 		return;
 	}
-	if (d === "workspace" && f === "export") {
-		x("workspace export"), process.exitCode = await n({
-			project: u.project,
-			workspace: u.workspace,
-			live: u.live,
-			out: u.out
+	if (o === "workspace" && c === "import") {
+		C("workspace import"), process.exitCode = await s({
+			project: t.project,
+			in: t.in,
+			name: t.name,
+			publish: t.publish
 		});
 		return;
 	}
-	if (d === "workspace" && f === "import") {
-		x("workspace import"), process.exitCode = await o({
-			project: u.project,
-			in: u.in,
-			name: u.name,
-			publish: u.publish
+	if (o === "docs") {
+		C(u(c)), process.exitCode = await n({
+			args: e.slice(1),
+			type: t.type,
+			json: t.json
 		});
 		return;
 	}
-	if (d === "generate" && f === "types") {
-		x("generate types"), process.exitCode = await r({ check: u.check });
+	if (o === "generate" && c === "types") {
+		C("generate types"), process.exitCode = await i({ check: t.check });
 		return;
 	}
-	x("unknown"), console.error(w), process.exitCode = 1;
+	C("unknown"), console.error(E), process.exitCode = 1;
 }
-function E(e) {
+function k(e) {
 	let t = 2, n = () => {
 		--t, t <= 0 && process.exit(e);
 	};
@@ -138,13 +140,13 @@ function E(e) {
 		process.exit(e);
 	}, 2e3).unref(), process.stdout.write("", n), process.stderr.write("", n);
 }
-T().then(async () => {
+O().then(async () => {
 	let e = typeof process.exitCode == "number" ? process.exitCode : 0;
-	S(e), await C(), E(e);
+	w(e), await T(), k(e);
 }).catch((e) => {
 	let t = e instanceof Error ? e.message : String(e);
-	console.error(t), S(1), C().finally(() => {
-		E(1);
+	console.error(t), w(1), T().finally(() => {
+		k(1);
 	});
 });
 //#endregion

package/dist/esm/index.js

@@ -1,2 +1,2 @@
-import { a as e, c as t, i as n, l as r, n as i, o as a, r as o, s, t as c } from "../workspace-use-CnR5FkxR.js";
-export { r as runGenerateTypes, t as runLogin, s as runLogout, a as runStatus, e as runWhoami, n as runWorkspaceExport, o as runWorkspaceImport, i as runWorkspaceList, c as runWorkspaceUse };
+import { a as e, c as t, d as n, f as r, i, l as a, n as o, o as s, p as c, r as l, s as u, t as d } from "../workspace-use-CXcLlf_z.js";
+export { n as runDocs, r as runDocsList, c as runDocsRead, a as runGenerateTypes, t as runLogin, u as runLogout, s as runStatus, e as runWhoami, i as runWorkspaceExport, l as runWorkspaceImport, o as runWorkspaceList, d as runWorkspaceUse };

package/dist/types/commands/docs.d.ts

@@ -0,0 +1,65 @@
+/** @file `picked docs list` and `picked docs read` command implementations. */
+import { type DocsSource } from '../lib/docs';
+/**
+ * Runs `picked docs list`: prints the path and title of each documentation page, one per
+ * line, or every field as JSON.
+ *
+ * @param {object} options - Command options.
+ * @param {string} [options.query] - Words that each listed page must hold.
+ * @param {string} [options.type] - Content type to keep: `tutorial`, `how-to`, `reference` or `explanation`.
+ * @param {boolean} [options.json] - Print the pages as a JSON array.
+ * @param {DocsSource} [options.source] - Where to read pages; defaults to the installed `picked` docs.
+ * @returns {Promise<number>} Process exit code: 1 when no page matches.
+ * @example
+ * await runDocsList({ query: 'feature flag' })
+ */
+export declare function runDocsList(options: {
+    query?: string;
+    type?: string;
+    json?: boolean;
+    source?: DocsSource;
+}): Promise<number>;
+/**
+ * Runs `picked docs read <page>`: prints one page as Markdown, under a comment that names its
+ * URL. The page can be a site path, a docs URL, or a bundled file path.
+ *
+ * @param {object} options - Command options.
+ * @param {string | undefined} options.page - The page to read.
+ * @param {DocsSource} [options.source] - Where to read pages; defaults to the installed `picked` docs.
+ * @returns {Promise<number>} Process exit code: 1 when the page does not exist.
+ * @example
+ * await runDocsRead({ page: '/how-to/install-the-sdk' })
+ */
+export declare function runDocsRead(options: {
+    page: string | undefined;
+    source?: DocsSource;
+}): Promise<number>;
+/**
+ * Names a `picked docs` invocation for telemetry.
+ *
+ * @param {string | undefined} subcommand - The word after `picked docs`.
+ * @returns {string} `docs list` or `docs read`.
+ * @example
+ * docsCommandName('read') // 'docs read'
+ */
+export declare function docsCommandName(subcommand: string | undefined): string;
+/**
+ * Runs `picked docs`. `picked docs`, `picked docs list [words]` and `picked docs ls` list pages;
+ * `picked docs read <path>` and `picked docs <path>` read one.
+ *
+ * @param {object} options - Command options.
+ * @param {string[]} options.args - The words after `picked docs`.
+ * @param {string} [options.type] - Content type to keep when listing.
+ * @param {boolean} [options.json] - Print a listing as JSON.
+ * @param {DocsSource} [options.source] - Where to read pages; defaults to the installed `picked` docs.
+ * @returns {Promise<number>} Process exit code.
+ * @example
+ * await runDocs({ args: ['read', '/how-to/install-the-sdk'] })
+ */
+export declare function runDocs(options: {
+    args: string[];
+    type?: string;
+    json?: boolean;
+    source?: DocsSource;
+}): Promise<number>;
+//# sourceMappingURL=docs.d.ts.map

package/dist/types/commands/docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../../src/commands/docs.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,OAAO,EAML,KAAK,UAAU,EAChB,MAAM,aAAa,CAAA;AAIpB;;;;;;;;;;;;GAYG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB,GAAG,OAAO,CAAC,MAAM,CAAC,CA8BlB;AA6BD;;;;;;;;;;GAUG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE;IACzC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB,GAAG,OAAO,CAAC,MAAM,CAAC,CA8BlB;AAcD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAEtE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,OAAO,CAAC,OAAO,EAAE;IACrC,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB,GAAG,OAAO,CAAC,MAAM,CAAC,CAYlB"}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 /** @file Public exports for `\@picked/cli`. */
+export { runDocs, runDocsList, runDocsRead } from './commands/docs';
 export { runGenerateTypes } from './commands/generate-types';
 export { runLogin } from './commands/login';
 export { runLogout } from './commands/logout';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA"}

package/dist/types/lib/docs.d.ts

@@ -0,0 +1,94 @@
+/** Origin of the published documentation site. */
+export declare const DOCS_SITE = "https://docs.picked.app";
+/** One documentation page, addressed by its site path. */
+export interface DocPage {
+    /** Site path without extension, e.g. `/how-to/build-a-flow`; `/` for the home page. */
+    path: string;
+    /** Page title, from its first `#` heading. */
+    title: string;
+    /** Diátaxis content type: `tutorial`, `how-to`, `reference` or `explanation`. */
+    type?: string;
+    /** The page's first paragraph. */
+    description?: string;
+    /** Absolute path of the bundled Markdown file; local pages only. */
+    file?: string;
+}
+/** Where `picked docs` reads pages from. */
+export interface DocsSource {
+    /** Where the pages come from: a directory, or the index URL. */
+    location: string;
+    /** Lists every page, in path order. */
+    list: () => Promise<DocPage[]>;
+    /** Reads one page's Markdown without frontmatter; `undefined` when no page has that path. */
+    read: (path: string) => Promise<string | undefined>;
+}
+/**
+ * Turns any way of naming a page into its site path: a path with or without its leading
+ * slash, a docs URL with or without an anchor, or a bundled file path.
+ *
+ * @param {string} input - The page as the caller named it.
+ * @returns {string} The site path, e.g. `/reference/sdk/steps`.
+ * @example
+ * normalizeDocPath('node_modules/picked/docs/reference/sdk/steps.md') // '/reference/sdk/steps'
+ */
+export declare function normalizeDocPath(input: string): string;
+/**
+ * Reads pages from a directory laid out like `docs/public-docs/docs/pages`, which is how
+ * `picked` bundles them.
+ *
+ * @param {string} dir - The docs directory, e.g. `node_modules/picked/docs`.
+ * @returns {DocsSource} The source.
+ * @example
+ * const pages = await createLocalDocsSource('node_modules/picked/docs').list()
+ */
+export declare function createLocalDocsSource(dir: string): DocsSource;
+/**
+ * Reads pages from the index the docs site publishes, for a project without `picked`
+ * installed.
+ *
+ * @param {typeof fetch} [fetchImpl] - The fetch to use.
+ * @returns {DocsSource} The source. Its methods throw when the index cannot be fetched.
+ * @example
+ * const body = await createRemoteDocsSource().read('/reference/tools/cli')
+ */
+export declare function createRemoteDocsSource(fetchImpl?: typeof fetch): DocsSource;
+/**
+ * Finds the docs bundled in the `picked` package, in order: `PICKED_DOCS_DIR`, the `picked`
+ * package whose bin runs this command, then the `picked` package installed in `cwd`.
+ *
+ * @param {object} options - Where to look.
+ * @param {string} options.cwd - The working directory.
+ * @param {string | undefined} options.bin - The script that started the process (`process.argv[1]`).
+ * @param {Record<string, string | undefined>} options.env - The environment.
+ * @returns {string | undefined} The docs directory, or `undefined` when none is installed.
+ * @example
+ * findLocalDocsDir({ cwd: process.cwd(), bin: process.argv[1], env: process.env })
+ */
+export declare function findLocalDocsDir(options: {
+    cwd: string;
+    bin: string | undefined;
+    env: Record<string, string | undefined>;
+}): string | undefined;
+/**
+ * The docs bundled in `picked` when they are installed, otherwise the published index.
+ *
+ * @param {object} [options] - Where to look; defaults to the running process.
+ * @param {string} [options.cwd] - The working directory.
+ * @returns {DocsSource} The source to read.
+ * @example
+ * const source = resolveDocsSource()
+ */
+export declare function resolveDocsSource(options?: {
+    cwd?: string;
+}): DocsSource;
+/**
+ * Keeps the pages whose path, title or description holds every word of `query`.
+ *
+ * @param {DocPage[]} pages - The pages to search.
+ * @param {string} query - Words to look for, in any case.
+ * @returns {DocPage[]} The matching pages, in their original order.
+ * @example
+ * searchDocPages(pages, 'feature flag')
+ */
+export declare function searchDocPages(pages: DocPage[], query: string): DocPage[];
+//# sourceMappingURL=docs.d.ts.map

package/dist/types/lib/docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../../src/lib/docs.ts"],"names":[],"mappings":"AAKA,kDAAkD;AAClD,eAAO,MAAM,SAAS,4BAA4B,CAAA;AAElD,0DAA0D;AAC1D,MAAM,WAAW,OAAO;IACtB,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAA;IACZ,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAA;IACb,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,4CAA4C;AAC5C,MAAM,WAAW,UAAU;IACzB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,uCAAuC;IACvC,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAC9B,6FAA6F;IAC7F,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CACpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAUtD;AAwDD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CA+B7D;AAmCD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,GAAE,OAAO,KAAa,GAAG,UAAU,CA6BlF;AA2BD;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IACxC,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;IACvB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CACxC,GAAG,MAAM,GAAG,SAAS,CAqBrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,UAAU,CAOxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,CASzE"}