@docslurp/contrib-astro 0.0.0-stage → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/DocSlurpSearch.astro +15 -0
- package/LICENSE +21 -0
- package/LICENSES/Apache-2.0.txt +201 -0
- package/NOTICE +12 -0
- package/README.md +64 -2
- package/build.mjs +27 -0
- package/index-docs.mjs +148 -0
- package/package.json +37 -3
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
/**
|
|
3
|
+
* Browser key only: restrict it to this site's origin and the search scope.
|
|
4
|
+
* workspaceId takes a slug, UUID or "default" (the key organization's default
|
|
5
|
+
* workspace) and defaults to "default"; apiUrl defaults to https://docslurp.io.
|
|
6
|
+
*/
|
|
7
|
+
interface Props { clientKey: string; workspaceId?: string; apiUrl?: string; placeholder?: string; }
|
|
8
|
+
const { clientKey, workspaceId = 'default', apiUrl = 'https://docslurp.io', placeholder = 'Search documents…' } = Astro.props;
|
|
9
|
+
---
|
|
10
|
+
<docslurp-search-box api-url={apiUrl} workspace-id={workspaceId} client-key={clientKey} placeholder={placeholder}></docslurp-search-box>
|
|
11
|
+
<noscript><p>Enable JavaScript to search the document collection.</p></noscript>
|
|
12
|
+
<script>
|
|
13
|
+
import { defineDocSlurpSearch } from '@docslurp/sdk/widget';
|
|
14
|
+
defineDocSlurpSearch();
|
|
15
|
+
</script>
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025-2026 DocSlurp, Inc. and contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Support. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 DocSlurp, Inc.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
DocSlurp
|
|
2
|
+
Copyright 2025-2026 DocSlurp, Inc. and contributors
|
|
3
|
+
|
|
4
|
+
Earlier versions were distributed under the Apache License, Version 2.0.
|
|
5
|
+
Existing license grants remain in effect for those versions. Retain applicable
|
|
6
|
+
upstream copyright, patent, license and attribution notices when redistributing
|
|
7
|
+
code from those versions. The accompanying Apache-2.0 text preserves the
|
|
8
|
+
previous repository notice and supplies the future license for SSPL versions.
|
|
9
|
+
|
|
10
|
+
Third-party components retain their own licenses. DocSlurp's license does not
|
|
11
|
+
relicense dependencies, models, fonts, assets or separately licensed files.
|
|
12
|
+
See THIRD_PARTY_NOTICES.md in the repository for the compatibility review.
|
package/README.md
CHANGED
|
@@ -1,3 +1,65 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @docslurp/contrib-astro
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[Package docs](https://docslurp.io/docs/packages/contrib-astro) · [GitHub](https://github.com/DocSlurp/docslurp-oss/tree/main/packages/contrib-astro) · [npm](https://www.npmjs.com/package/@docslurp/contrib-astro)
|
|
4
|
+
|
|
5
|
+
Add cited DocSlurp search to an Astro site with one component. It renders a small framework-free widget, so it needs no React hydration.
|
|
6
|
+
|
|
7
|
+
```astro
|
|
8
|
+
---
|
|
9
|
+
import DocSlurpSearch from "@docslurp/contrib-astro";
|
|
10
|
+
---
|
|
11
|
+
<!-- PUBLIC_DOCSLURP_CLIENT_KEY holds a browser key, safe to ship in page HTML. -->
|
|
12
|
+
<DocSlurpSearch clientKey={import.meta.env.PUBLIC_DOCSLURP_CLIENT_KEY} />
|
|
13
|
+
<!-- To search a named workspace: <DocSlurpSearch clientKey={...} workspaceId="product-manuals" /> -->
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
| Prop | Default | Notes |
|
|
17
|
+
| --- | --- | --- |
|
|
18
|
+
| `clientKey` | Required | A browser key: search-only and restricted to your allowed websites. Server keys are refused in the browser. |
|
|
19
|
+
| `workspaceId` | `default` | A workspace slug (such as `product-manuals`), UUID or `default`, the key organization's default workspace. See [Workspaces](https://docslurp.io/docs/http#workspaces). |
|
|
20
|
+
| `apiUrl` | `https://docslurp.io` | The service origin. |
|
|
21
|
+
| `placeholder` | `Search documents…` | Search box placeholder. |
|
|
22
|
+
|
|
23
|
+
Use a browser key for public content. The same component is also exported as `@docslurp/sdk/astro`. For setup steps, see the [Astro guide](https://docslurp.io/docs/search-integrations/astro).
|
|
24
|
+
|
|
25
|
+
## Index your rendered Astro docs at build time
|
|
26
|
+
|
|
27
|
+
`@docslurp/contrib-astro/build` is an optional build integration for sites that use the **Astro Node standalone adapter**. After the build, it:
|
|
28
|
+
|
|
29
|
+
1. Renders the routes you list on a temporary local server.
|
|
30
|
+
2. Keeps each page's `<main>` content, including headings and code, and drops scripts, styles, navigation, asides and search controls.
|
|
31
|
+
3. Uploads the pages to DocSlurp, using each canonical page URL so a rebuild replaces the previous version instead of adding a duplicate. A content-based idempotency key makes retrying an identical submission safe.
|
|
32
|
+
4. Waits up to ten minutes for the run to finish.
|
|
33
|
+
|
|
34
|
+
Your server key is used only during the build. It never ends up in the generated files or public configuration.
|
|
35
|
+
|
|
36
|
+
```js
|
|
37
|
+
// astro.config.mjs (output: 'server' with the @astrojs/node standalone adapter)
|
|
38
|
+
import docslurpDocsIndex from '@docslurp/contrib-astro/build';
|
|
39
|
+
|
|
40
|
+
integrations: [docslurpDocsIndex({
|
|
41
|
+
routes: ['/docs', '/docs/getting-started'], // List every public page to index.
|
|
42
|
+
site: 'https://docs.example.com', // Origin used for canonical page URLs.
|
|
43
|
+
apiUrl: 'https://docslurp.io',
|
|
44
|
+
apiKey: process.env.DOCSLURP_API_KEY, // Server key with the ingest scope.
|
|
45
|
+
workspaceName: 'Product documentation',
|
|
46
|
+
// To add to an existing workspace instead: workspaceId: 'existing-workspace-slug',
|
|
47
|
+
})]
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Without `apiKey`, the build still writes `.docslurp/docs-index.json` and skips the upload. With a key, any indexing failure fails the build. A successful upload writes `docslurp-docs-search.json` to the client output with the workspace ID, so your search component can find it. Use `renderEnv` to pass environment variables that only the page renderer needs.
|
|
51
|
+
|
|
52
|
+
Pages are indexed as text: the upload asks for `{ visionFallback: false, preserveImages: false, summarize: true }`, so rendered HTML skips page images and vision and gets per-page summaries. Pass `pipeline` with other pipeline overrides to change that.
|
|
53
|
+
|
|
54
|
+
To index a site after it deploys (for example when the build has no API key), crawl the live pages instead:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
DOCSLURP_API_KEY=... DOCSLURP_DOCS_WORKSPACE_ID=<workspace id> \
|
|
58
|
+
node node_modules/@docslurp/contrib-astro/index-docs.mjs --site https://docs.example.com --routes routes.json --output .docslurp/docs-index.json
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
`--routes` is a file or URL with a JSON array of paths. Only those paths on the site's own origin are fetched, and redirects are refused. Elements marked `data-search-exclude` (repeated boilerplate) are left out of the index.
|
|
62
|
+
|
|
63
|
+
This integration does not render protected pages, discover dynamic routes, delete documents for removed pages, or support other Astro adapters, so list your public documentation routes explicitly. Keep public documentation in its own organization, and use keys from that organization for both indexing and search.
|
|
64
|
+
|
|
65
|
+
For how DocSlurp indexes its own website, see [Dogfood docs search](https://github.com/DocSlurp/docslurp-oss/blob/main/docs/docs-search.md).
|
package/build.mjs
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { spawn } from 'node:child_process';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
|
|
4
|
+
/** Index rendered Astro Node standalone pages through DocSlurp's public API. */
|
|
5
|
+
export default function docslurpDocsIndex({ routes, apiKey, apiUrl = 'https://docslurp.io', workspaceId, workspaceName = 'DocSlurp documentation', site = 'https://docslurp.io', renderEnv = {}, pipeline }) {
|
|
6
|
+
let root;
|
|
7
|
+
return {
|
|
8
|
+
name: '@docslurp/contrib-astro/docs-index',
|
|
9
|
+
hooks: {
|
|
10
|
+
'astro:config:done': ({ config }) => { root = config.root; },
|
|
11
|
+
'astro:build:done': async ({ dir, logger }) => {
|
|
12
|
+
const entry = new URL('../server/entry.mjs', dir);
|
|
13
|
+
const output = new URL('.docslurp/docs-index.json', root);
|
|
14
|
+
// Isolate server imports and startup state from Astro's build process.
|
|
15
|
+
await new Promise((resolve, reject) => {
|
|
16
|
+
const child = spawn(process.execPath, [fileURLToPath(new URL('./index-docs.mjs', import.meta.url)), '--entry', fileURLToPath(entry), '--output', fileURLToPath(output), '--public-config', fileURLToPath(new URL('docslurp-docs-search.json', dir))], {
|
|
17
|
+
cwd: fileURLToPath(root), stdio: 'inherit',
|
|
18
|
+
env: { ...process.env, ...renderEnv, ASTRO_NODE_AUTOSTART: 'disabled', DOCSLURP_API_KEY: apiKey ?? '', DOCSLURP_DOCS_INDEX_OPTIONS: JSON.stringify({ routes, apiUrl, workspaceId, workspaceName, site, ...(pipeline ? { pipeline } : {}) }) },
|
|
19
|
+
});
|
|
20
|
+
child.on('error', reject);
|
|
21
|
+
child.on('exit', code => code === 0 ? resolve() : reject(new Error(`DocSlurp docs indexing exited with ${code}`)));
|
|
22
|
+
});
|
|
23
|
+
logger.info(apiKey ? 'Docs submitted to DocSlurp; indexing completed.' : 'Docs corpus built. No DOCSLURP_API_KEY: remote indexing skipped.');
|
|
24
|
+
},
|
|
25
|
+
},
|
|
26
|
+
};
|
|
27
|
+
}
|
package/index-docs.mjs
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import { createServer } from 'node:http';
|
|
2
|
+
import { createHash } from 'node:crypto';
|
|
3
|
+
import { mkdir, readFile, writeFile } from 'node:fs/promises';
|
|
4
|
+
import { dirname } from 'node:path';
|
|
5
|
+
import { pathToFileURL } from 'node:url';
|
|
6
|
+
|
|
7
|
+
export function docFilename(path) { return `docslurp-docs-${Buffer.from(path).toString('base64url')}.html`; }
|
|
8
|
+
/**
|
|
9
|
+
* Cloudflare Email Obfuscation rewrites addresses with a random key on every
|
|
10
|
+
* request, so a crawled page differed each time (forcing a re-index) and the
|
|
11
|
+
* index held "[email protected]". Decode them back to the address.
|
|
12
|
+
*/
|
|
13
|
+
export function decodeCloudflareEmails(html) {
|
|
14
|
+
const decode = (hex) => {
|
|
15
|
+
if (!/^(?:[0-9a-f]{2})+$/i.test(hex)) return null;
|
|
16
|
+
const key = parseInt(hex.slice(0, 2), 16);
|
|
17
|
+
let out = '';
|
|
18
|
+
for (let i = 2; i < hex.length; i += 2) out += String.fromCharCode(parseInt(hex.slice(i, i + 2), 16) ^ key);
|
|
19
|
+
return out.replace(/[<>&"]/g, (c) => ({ '<': '<', '>': '>', '&': '&', '"': '"' })[c]);
|
|
20
|
+
};
|
|
21
|
+
return html
|
|
22
|
+
.replace(/<a\b[^>]*\bdata-cfemail="([0-9a-f]+)"[^>]*>[\s\S]*?<\/a>/gi, (match, hex) => decode(hex) ?? match)
|
|
23
|
+
.replace(/<span\b[^>]*\bdata-cfemail="([0-9a-f]+)"[^>]*>[\s\S]*?<\/span>/gi, (match, hex) => decode(hex) ?? match)
|
|
24
|
+
.replace(/href="\/cdn-cgi\/l\/email-protection#([0-9a-f]+)"/gi, (match, hex) => { const email = decode(hex); return email ? `href="mailto:${email}"` : match; });
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export function extractDoc(html) {
|
|
28
|
+
html = decodeCloudflareEmails(html);
|
|
29
|
+
const main = html.match(/<main\b[^>]*>([\s\S]*?)<\/main>/i)?.[1];
|
|
30
|
+
if (!main) throw new Error('Docs page has no main content');
|
|
31
|
+
// `data-search-exclude` marks boilerplate repeated across pages (step numbers, agent handoffs).
|
|
32
|
+
const content = main.replace(/<(script|style|nav|aside)\b[^>]*>[\s\S]*?<\/\1>/gi, '').replace(/<([a-z][a-z0-9-]*)\b[^>]*\bdata-search-exclude\b[^>]*>[\s\S]*?<\/\1>/gi, '').replace(/<docslurp-docs-search\b[^>]*>[\s\S]*?<\/docslurp-docs-search>/gi, '');
|
|
33
|
+
const title = html.match(/<title[^>]*>([\s\S]*?)<\/title>/i)?.[1] ?? 'Documentation';
|
|
34
|
+
return { title, html: `<!doctype html><html><head><meta charset="utf-8"><title>${title}</title></head><body><main>${content}</main></body></html>` };
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
const DOCS_ROUTE = /^\/docs(?:\/[a-z0-9-]+)*$/;
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Crawl a deployed site's docs routes (for indexing after a deploy, when the
|
|
41
|
+
* build had no API key). Only the given routes on the site's own origin are
|
|
42
|
+
* fetched; redirects are refused so a page can't pull in another host.
|
|
43
|
+
*/
|
|
44
|
+
export async function crawlDocs({ site, routes }, fetchImpl = fetch) {
|
|
45
|
+
const origin = new URL(site).origin;
|
|
46
|
+
const corpus = [];
|
|
47
|
+
for (const path of [...new Set(routes)].sort()) {
|
|
48
|
+
if (!DOCS_ROUTE.test(path)) throw new Error(`Invalid docs route: ${path}`);
|
|
49
|
+
const response = await fetchImpl(`${origin}${path}`, { redirect: 'manual', headers: { Accept: 'text/html' }, signal: AbortSignal.timeout(30_000) });
|
|
50
|
+
if (response.status !== 200) throw new Error(`Fetch ${path}: HTTP ${response.status}`);
|
|
51
|
+
corpus.push({ path, filename: docFilename(path), canonicalId: `${origin}${path}`, ...extractDoc(await response.text()) });
|
|
52
|
+
}
|
|
53
|
+
return corpus;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Rendered HTML docs need text, not page images or vision rescue: faster,
|
|
58
|
+
* cheaper, fewer moving parts. Per-page summaries help search and chat.
|
|
59
|
+
*/
|
|
60
|
+
export const DEFAULT_DOCS_PIPELINE = Object.freeze({ visionFallback: false, preserveImages: false, summarize: true });
|
|
61
|
+
|
|
62
|
+
export async function indexDocs(corpus, { apiUrl, workspaceId, workspaceName, pipeline = DEFAULT_DOCS_PIPELINE }, apiKey, fetchImpl = fetch) {
|
|
63
|
+
const base = apiUrl.replace(/\/$/, '');
|
|
64
|
+
const request = async (path, init = {}) => {
|
|
65
|
+
const response = await fetchImpl(`${base}${path}`, { ...init, headers: { ...init.headers, Authorization: `Bearer ${apiKey}` }, signal: AbortSignal.timeout(60_000) });
|
|
66
|
+
if (!response.ok) throw new Error(`DocSlurp ${path}: HTTP ${response.status}`);
|
|
67
|
+
return response.json();
|
|
68
|
+
};
|
|
69
|
+
let target = workspaceId;
|
|
70
|
+
if (!target) {
|
|
71
|
+
const { workspaces } = await request('/v1/workspaces');
|
|
72
|
+
const matches = workspaces.filter(w => w.name === workspaceName);
|
|
73
|
+
if (matches.length > 1) throw new Error('Multiple docs workspaces: set DOCSLURP_DOCS_WORKSPACE_ID');
|
|
74
|
+
target = matches[0]?.id;
|
|
75
|
+
}
|
|
76
|
+
const form = new FormData();
|
|
77
|
+
const canonicalIds = [];
|
|
78
|
+
for (const doc of corpus) {
|
|
79
|
+
form.append('files', new Blob([doc.html], { type: 'text/html' }), doc.filename);
|
|
80
|
+
canonicalIds.push(doc.canonicalId);
|
|
81
|
+
}
|
|
82
|
+
form.set('canonicalIds', JSON.stringify(canonicalIds));
|
|
83
|
+
if (pipeline) form.set('pipeline', JSON.stringify(pipeline));
|
|
84
|
+
if (target) form.set('workspaceId', target);
|
|
85
|
+
else { form.set('newWorkspace', 'true'); form.set('workspaceName', workspaceName); }
|
|
86
|
+
const hash = createHash('sha256').update(JSON.stringify({ target: target ?? workspaceName, corpus, pipeline: pipeline ?? null })).digest('hex');
|
|
87
|
+
const result = await request('/v1/ingest/bulk', { method: 'POST', headers: { 'Idempotency-Key': `docs-${hash}` }, body: form });
|
|
88
|
+
const deadline = Date.now() + 10 * 60_000;
|
|
89
|
+
while (Date.now() < deadline) {
|
|
90
|
+
const { run } = await request(`/v1/runs/${encodeURIComponent(result.run.id)}/progress`);
|
|
91
|
+
if (run.status === 'completed') return { workspaceId: result.workspace.id, runId: run.id };
|
|
92
|
+
if (['failed', 'cancelled'].includes(run.status)) throw new Error(`Docs ingestion ${run.status}`);
|
|
93
|
+
await new Promise(resolve => setTimeout(resolve, 2000));
|
|
94
|
+
}
|
|
95
|
+
throw new Error('Docs indexing timed out after 10 minutes; inspect the run before retrying');
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
async function main() {
|
|
99
|
+
const args = process.argv.slice(2);
|
|
100
|
+
const value = name => args[args.indexOf(name) + 1];
|
|
101
|
+
const options = { apiUrl: process.env.DOCSLURP_URL ?? 'https://docslurp.io', workspaceId: process.env.DOCSLURP_DOCS_WORKSPACE_ID || process.env.PUBLIC_DOCSLURP_DOCS_WORKSPACE_ID || undefined, workspaceName: 'DocSlurp documentation', ...(process.env.DOCSLURP_DOCS_PIPELINE ? { pipeline: JSON.parse(process.env.DOCSLURP_DOCS_PIPELINE) } : {}), ...JSON.parse(process.env.DOCSLURP_DOCS_INDEX_OPTIONS ?? '{}') };
|
|
102
|
+
const output = value('--output');
|
|
103
|
+
let corpus;
|
|
104
|
+
if (args.includes('--entry')) {
|
|
105
|
+
const { handler } = await import(pathToFileURL(value('--entry')).href);
|
|
106
|
+
const server = createServer(handler);
|
|
107
|
+
await new Promise(resolve => server.listen(0, '127.0.0.1', resolve));
|
|
108
|
+
try {
|
|
109
|
+
corpus = [];
|
|
110
|
+
for (const path of [...new Set(options.routes)].sort()) {
|
|
111
|
+
if (!DOCS_ROUTE.test(path)) throw new Error(`Invalid docs route: ${path}`);
|
|
112
|
+
const response = await fetch(`http://127.0.0.1:${server.address().port}${path}`, { headers: { Host: new URL(options.site).host, 'X-Forwarded-Host': new URL(options.site).host, 'X-Forwarded-Proto': 'https' }, signal: AbortSignal.timeout(30_000) });
|
|
113
|
+
if (!response.ok) throw new Error(`Render ${path}: HTTP ${response.status}`);
|
|
114
|
+
corpus.push({ path, filename: docFilename(path), canonicalId: `${options.site}${path}`, ...extractDoc(await response.text()) });
|
|
115
|
+
}
|
|
116
|
+
} finally {
|
|
117
|
+
server.closeAllConnections();
|
|
118
|
+
await new Promise(resolve => server.close(resolve));
|
|
119
|
+
}
|
|
120
|
+
await mkdir(dirname(output), { recursive: true });
|
|
121
|
+
await writeFile(output, JSON.stringify(corpus, null, 2));
|
|
122
|
+
console.log(`[docs-index] Rendered ${corpus.length} pages`);
|
|
123
|
+
} else if (args.includes('--site')) {
|
|
124
|
+
// Deployed site: routes from --routes (URL or file with a JSON array), else the options.
|
|
125
|
+
const source = args.includes('--routes') ? value('--routes') : null;
|
|
126
|
+
const routes = source
|
|
127
|
+
? JSON.parse(/^https?:/.test(source) ? await (await fetch(source, { signal: AbortSignal.timeout(30_000) })).text() : await readFile(source, 'utf8'))
|
|
128
|
+
: options.routes;
|
|
129
|
+
if (!Array.isArray(routes) || !routes.length) throw new Error('No docs routes to crawl');
|
|
130
|
+
corpus = await crawlDocs({ site: value('--site'), routes });
|
|
131
|
+
if (output) { await mkdir(dirname(output), { recursive: true }); await writeFile(output, JSON.stringify(corpus, null, 2)); }
|
|
132
|
+
console.log(`[docs-index] Crawled ${corpus.length} pages from ${new URL(value('--site')).origin}`);
|
|
133
|
+
} else corpus = JSON.parse(await readFile(output, 'utf8'));
|
|
134
|
+
if (!corpus.length) throw new Error('Empty docs corpus');
|
|
135
|
+
const key = process.env.DOCSLURP_API_KEY?.trim();
|
|
136
|
+
if (key) {
|
|
137
|
+
const indexed = await indexDocs(corpus, options, key);
|
|
138
|
+
console.log('[docs-index]', indexed);
|
|
139
|
+
if (args.includes('--public-config')) await writeFile(value('--public-config'), JSON.stringify({ workspaceId: indexed.workspaceId }));
|
|
140
|
+
}
|
|
141
|
+
else {
|
|
142
|
+
console.log('[docs-index] No API key; remote indexing skipped');
|
|
143
|
+
if (args.includes('--public-config')) await writeFile(value('--public-config'), JSON.stringify({ workspaceId: options.workspaceId ?? null }));
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
|
|
147
|
+
main().then(() => process.exit(0)).catch(error => { console.error(error.message); process.exit(1); });
|
|
148
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,40 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docslurp/contrib-astro",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"description": "Astro search component for DocSlurp cited search, with a framework-free browser widget.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"homepage": "https://docslurp.io/docs/packages/contrib-astro",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/DocSlurp/docslurp-oss.git",
|
|
10
|
+
"directory": "packages/contrib-astro"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/DocSlurp/docslurp-oss/issues"
|
|
14
|
+
},
|
|
15
|
+
"type": "module",
|
|
16
|
+
"exports": {
|
|
17
|
+
".": "./DocSlurpSearch.astro",
|
|
18
|
+
"./build": "./build.mjs"
|
|
19
|
+
},
|
|
20
|
+
"files": [
|
|
21
|
+
"DocSlurpSearch.astro",
|
|
22
|
+
"README.md",
|
|
23
|
+
"LICENSE",
|
|
24
|
+
"NOTICE",
|
|
25
|
+
"LICENSES",
|
|
26
|
+
"build.mjs",
|
|
27
|
+
"index-docs.mjs"
|
|
28
|
+
],
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@docslurp/sdk": "^0.3.0"
|
|
31
|
+
},
|
|
32
|
+
"publishConfig": {
|
|
33
|
+
"access": "public"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"build": "pnpm --filter @docslurp/sdk build",
|
|
37
|
+
"typecheck": "pnpm --filter @docslurp/sdk typecheck",
|
|
38
|
+
"test": "node --test index-docs.test.mjs"
|
|
39
|
+
}
|
|
6
40
|
}
|